2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
10 #include "agent-thread.hpp"
12 #include "buffer-registry.hpp"
13 #include "channel.hpp"
15 #include "consumer.hpp"
16 #include "event-notifier-error-accounting.hpp"
18 #include "health-sessiond.hpp"
19 #include "kernel-consumer.hpp"
21 #include "lttng-sessiond.hpp"
22 #include "lttng-syscall.hpp"
23 #include "notification-thread-commands.hpp"
24 #include "notification-thread.hpp"
25 #include "rotation-thread.hpp"
26 #include "session.hpp"
28 #include "tracker.hpp"
31 #include <common/buffer-view.hpp>
32 #include <common/common.hpp>
33 #include <common/compat/string.hpp>
34 #include <common/defaults.hpp>
35 #include <common/dynamic-buffer.hpp>
36 #include <common/kernel-ctl/kernel-ctl.hpp>
37 #include <common/payload-view.hpp>
38 #include <common/payload.hpp>
39 #include <common/relayd/relayd.hpp>
40 #include <common/sessiond-comm/sessiond-comm.hpp>
41 #include <common/string-utils/string-utils.hpp>
42 #include <common/trace-chunk.hpp>
43 #include <common/urcu.hpp>
44 #include <common/utils.hpp>
46 #include <lttng/action/action-internal.hpp>
47 #include <lttng/action/action.h>
48 #include <lttng/channel-internal.hpp>
49 #include <lttng/channel.h>
50 #include <lttng/condition/condition-internal.hpp>
51 #include <lttng/condition/condition.h>
52 #include <lttng/condition/event-rule-matches-internal.hpp>
53 #include <lttng/condition/event-rule-matches.h>
54 #include <lttng/error-query-internal.hpp>
55 #include <lttng/event-internal.hpp>
56 #include <lttng/event-rule/event-rule-internal.hpp>
57 #include <lttng/event-rule/event-rule.h>
58 #include <lttng/location-internal.hpp>
59 #include <lttng/lttng-error.h>
60 #include <lttng/rotate-internal.hpp>
61 #include <lttng/session-descriptor-internal.hpp>
62 #include <lttng/session-internal.hpp>
63 #include <lttng/tracker.h>
64 #include <lttng/trigger/trigger-internal.hpp>
65 #include <lttng/userspace-probe-internal.hpp>
71 #include <urcu/list.h>
72 #include <urcu/uatomic.h>
74 /* Sleep for 100ms between each check for the shm path's deletion. */
75 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
77 namespace lsu
= lttng::sessiond::ust
;
79 static enum lttng_error_code
wait_on_path(void *path
);
82 struct cmd_destroy_session_reply_context
{
84 bool implicit_rotation_on_destroy
;
86 * Indicates whether or not an error occurred while launching the
87 * destruction of a session.
89 enum lttng_error_code destruction_status
;
93 * Command completion handler that is used by the destroy command
94 * when a session that has a non-default shm_path is being destroyed.
96 * See comment in cmd_destroy_session() for the rationale.
98 struct destroy_completion_handler
{
99 struct cmd_completion_handler handler
;
100 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
101 } destroy_completion_handler
= {
102 .handler
= { .run
= wait_on_path
, .data
= destroy_completion_handler
.shm_path
},
107 * Used to keep a unique index for each relayd socket created where this value
108 * is associated with streams on the consumer so it can match the right relayd
109 * to send to. It must be accessed with the relayd_net_seq_idx_lock
112 pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
113 uint64_t relayd_net_seq_idx
;
116 static struct cmd_completion_handler
*current_completion_handler
;
117 static int validate_ust_event_name(const char *);
118 static int cmd_enable_event_internal(struct ltt_session
*session
,
119 const struct lttng_domain
*domain
,
121 struct lttng_event
*event
,
122 char *filter_expression
,
123 struct lttng_bytecode
*filter
,
124 struct lttng_event_exclusion
*exclusion
,
126 static enum lttng_error_code
cmd_enable_channel_internal(struct ltt_session
*session
,
127 const struct lttng_domain
*domain
,
128 const struct lttng_channel
*_attr
,
132 * Create a session path used by list_lttng_sessions for the case that the
133 * session consumer is on the network.
135 static int build_network_session_path(char *dst
, size_t size
, struct ltt_session
*session
)
137 int ret
, kdata_port
, udata_port
;
138 struct lttng_uri
*kuri
= nullptr, *uuri
= nullptr, *uri
= nullptr;
139 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
141 LTTNG_ASSERT(session
);
144 memset(tmp_urls
, 0, sizeof(tmp_urls
));
145 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
147 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
149 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
150 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
151 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
154 if (session
->ust_session
&& session
->ust_session
->consumer
) {
155 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
156 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
159 if (uuri
== nullptr && kuri
== nullptr) {
160 uri
= &session
->consumer
->dst
.net
.control
;
161 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
162 } else if (kuri
&& uuri
) {
163 ret
= uri_compare(kuri
, uuri
);
167 /* Build uuri URL string */
168 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
175 } else if (kuri
&& uuri
== nullptr) {
177 } else if (uuri
&& kuri
== nullptr) {
181 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
187 * Do we have a UST url set. If yes, this means we have both kernel and UST
190 if (*tmp_uurl
!= '\0') {
193 "[K]: %s [data: %d] -- [U]: %s [data: %d]",
200 if (kuri
|| (!kuri
&& !uuri
)) {
203 /* No kernel URI, use the UST port. */
206 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
214 * Get run-time attributes if the session has been started (discarded events,
217 static int get_kernel_runtime_stats(struct ltt_session
*session
,
218 struct ltt_kernel_channel
*kchan
,
219 uint64_t *discarded_events
,
220 uint64_t *lost_packets
)
224 if (!session
->has_been_started
) {
226 *discarded_events
= 0;
231 ret
= consumer_get_discarded_events(
232 session
->id
, kchan
->key
, session
->kernel_session
->consumer
, discarded_events
);
237 ret
= consumer_get_lost_packets(
238 session
->id
, kchan
->key
, session
->kernel_session
->consumer
, lost_packets
);
248 * Get run-time attributes if the session has been started (discarded events,
251 static int get_ust_runtime_stats(struct ltt_session
*session
,
252 struct ltt_ust_channel
*uchan
,
253 uint64_t *discarded_events
,
254 uint64_t *lost_packets
)
257 struct ltt_ust_session
*usess
;
259 if (!discarded_events
|| !lost_packets
) {
264 usess
= session
->ust_session
;
265 LTTNG_ASSERT(discarded_events
);
266 LTTNG_ASSERT(lost_packets
);
268 if (!usess
|| !session
->has_been_started
) {
269 *discarded_events
= 0;
275 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
276 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
277 &usess
->buffer_reg_uid_list
,
280 uchan
->attr
.overwrite
,
283 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
284 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
287 uchan
->attr
.overwrite
,
293 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
294 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
296 ERR("Unsupported buffer type");
307 * Create a list of agent domain events.
309 * Return number of events in list on success or else a negative value.
311 static enum lttng_error_code
list_lttng_agent_events(struct agent
*agt
,
312 struct lttng_payload
*reply_payload
,
313 unsigned int *nb_events
)
315 enum lttng_error_code ret_code
;
317 unsigned int local_nb_events
= 0;
318 struct agent_event
*event
;
319 struct lttng_ht_iter iter
;
320 unsigned long agent_event_count
;
323 assert(reply_payload
);
325 DBG3("Listing agent events");
327 agent_event_count
= lttng_ht_get_count(agt
->events
);
328 if (agent_event_count
== 0) {
333 if (agent_event_count
> UINT_MAX
) {
334 ret_code
= LTTNG_ERR_OVERFLOW
;
338 local_nb_events
= (unsigned int) agent_event_count
;
341 lttng::urcu::read_lock_guard read_lock
;
343 cds_lfht_for_each_entry (agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
344 struct lttng_event
*tmp_event
= lttng_event_create();
347 ret_code
= LTTNG_ERR_NOMEM
;
351 if (lttng_strncpy(tmp_event
->name
, event
->name
, sizeof(tmp_event
->name
))) {
352 lttng_event_destroy(tmp_event
);
353 ret_code
= LTTNG_ERR_FATAL
;
357 tmp_event
->name
[sizeof(tmp_event
->name
) - 1] = '\0';
358 tmp_event
->enabled
= !!event
->enabled_count
;
359 tmp_event
->loglevel
= event
->loglevel_value
;
360 tmp_event
->loglevel_type
= event
->loglevel_type
;
362 ret
= lttng_event_serialize(tmp_event
,
365 event
->filter_expression
,
369 lttng_event_destroy(tmp_event
);
371 ret_code
= LTTNG_ERR_FATAL
;
378 *nb_events
= local_nb_events
;
384 * Create a list of ust global domain events.
386 static enum lttng_error_code
list_lttng_ust_global_events(char *channel_name
,
387 struct ltt_ust_domain_global
*ust_global
,
388 struct lttng_payload
*reply_payload
,
389 unsigned int *nb_events
)
391 enum lttng_error_code ret_code
;
393 struct lttng_ht_iter iter
;
394 struct lttng_ht_node_str
*node
;
395 struct ltt_ust_channel
*uchan
;
396 struct ltt_ust_event
*uevent
;
397 unsigned long channel_event_count
;
398 unsigned int local_nb_events
= 0;
400 assert(reply_payload
);
403 DBG("Listing UST global events for channel %s", channel_name
);
405 lttng::urcu::read_lock_guard read_lock
;
407 lttng_ht_lookup(ust_global
->channels
, (void *) channel_name
, &iter
);
408 node
= lttng_ht_iter_get_node_str(&iter
);
409 if (node
== nullptr) {
410 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
414 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
416 channel_event_count
= lttng_ht_get_count(uchan
->events
);
417 if (channel_event_count
== 0) {
423 if (channel_event_count
> UINT_MAX
) {
424 ret_code
= LTTNG_ERR_OVERFLOW
;
428 local_nb_events
= (unsigned int) channel_event_count
;
430 DBG3("Listing UST global %d events", *nb_events
);
432 cds_lfht_for_each_entry (uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
433 struct lttng_event
*tmp_event
= nullptr;
435 if (uevent
->internal
) {
436 /* This event should remain hidden from clients */
441 tmp_event
= lttng_event_create();
443 ret_code
= LTTNG_ERR_NOMEM
;
447 if (lttng_strncpy(tmp_event
->name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
)) {
448 ret_code
= LTTNG_ERR_FATAL
;
449 lttng_event_destroy(tmp_event
);
453 tmp_event
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
454 tmp_event
->enabled
= uevent
->enabled
;
456 switch (uevent
->attr
.instrumentation
) {
457 case LTTNG_UST_ABI_TRACEPOINT
:
458 tmp_event
->type
= LTTNG_EVENT_TRACEPOINT
;
460 case LTTNG_UST_ABI_PROBE
:
461 tmp_event
->type
= LTTNG_EVENT_PROBE
;
463 case LTTNG_UST_ABI_FUNCTION
:
464 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
468 tmp_event
->loglevel
= uevent
->attr
.loglevel
;
469 switch (uevent
->attr
.loglevel_type
) {
470 case LTTNG_UST_ABI_LOGLEVEL_ALL
:
471 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
473 case LTTNG_UST_ABI_LOGLEVEL_RANGE
:
474 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
476 case LTTNG_UST_ABI_LOGLEVEL_SINGLE
:
477 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
480 if (uevent
->filter
) {
481 tmp_event
->filter
= 1;
483 if (uevent
->exclusion
) {
484 tmp_event
->exclusion
= 1;
487 std::vector
<const char *> exclusion_names
;
488 if (uevent
->exclusion
) {
489 for (int i
= 0; i
< uevent
->exclusion
->count
; i
++) {
490 exclusion_names
.emplace_back(
491 LTTNG_EVENT_EXCLUSION_NAME_AT(uevent
->exclusion
, i
));
496 * We do not care about the filter bytecode and the fd from the
497 * userspace_probe_location.
499 ret
= lttng_event_serialize(tmp_event
,
500 exclusion_names
.size(),
501 exclusion_names
.size() ? exclusion_names
.data() :
503 uevent
->filter_expression
,
507 lttng_event_destroy(tmp_event
);
509 ret_code
= LTTNG_ERR_FATAL
;
515 /* nb_events is already set at this point. */
517 *nb_events
= local_nb_events
;
523 * Fill lttng_event array of all kernel events in the channel.
525 static enum lttng_error_code
list_lttng_kernel_events(char *channel_name
,
526 struct ltt_kernel_session
*kernel_session
,
527 struct lttng_payload
*reply_payload
,
528 unsigned int *nb_events
)
530 enum lttng_error_code ret_code
;
532 struct ltt_kernel_event
*event
;
533 struct ltt_kernel_channel
*kchan
;
535 assert(reply_payload
);
537 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
538 if (kchan
== nullptr) {
539 ret_code
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
543 *nb_events
= kchan
->event_count
;
545 DBG("Listing events for channel %s", kchan
->channel
->name
);
547 if (*nb_events
== 0) {
552 /* Kernel channels */
553 cds_list_for_each_entry (event
, &kchan
->events_list
.head
, list
) {
554 struct lttng_event
*tmp_event
= lttng_event_create();
557 ret_code
= LTTNG_ERR_NOMEM
;
561 if (lttng_strncpy(tmp_event
->name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
)) {
562 lttng_event_destroy(tmp_event
);
563 ret_code
= LTTNG_ERR_FATAL
;
567 tmp_event
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
568 tmp_event
->enabled
= event
->enabled
;
569 tmp_event
->filter
= (unsigned char) !!event
->filter_expression
;
571 switch (event
->event
->instrumentation
) {
572 case LTTNG_KERNEL_ABI_TRACEPOINT
:
573 tmp_event
->type
= LTTNG_EVENT_TRACEPOINT
;
575 case LTTNG_KERNEL_ABI_KRETPROBE
:
576 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
577 memcpy(&tmp_event
->attr
.probe
,
578 &event
->event
->u
.kprobe
,
579 sizeof(struct lttng_kernel_abi_kprobe
));
581 case LTTNG_KERNEL_ABI_KPROBE
:
582 tmp_event
->type
= LTTNG_EVENT_PROBE
;
583 memcpy(&tmp_event
->attr
.probe
,
584 &event
->event
->u
.kprobe
,
585 sizeof(struct lttng_kernel_abi_kprobe
));
587 case LTTNG_KERNEL_ABI_UPROBE
:
588 tmp_event
->type
= LTTNG_EVENT_USERSPACE_PROBE
;
590 case LTTNG_KERNEL_ABI_FUNCTION
:
591 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
592 memcpy(&(tmp_event
->attr
.ftrace
),
593 &event
->event
->u
.ftrace
,
594 sizeof(struct lttng_kernel_abi_function
));
596 case LTTNG_KERNEL_ABI_NOOP
:
597 tmp_event
->type
= LTTNG_EVENT_NOOP
;
599 case LTTNG_KERNEL_ABI_SYSCALL
:
600 tmp_event
->type
= LTTNG_EVENT_SYSCALL
;
602 case LTTNG_KERNEL_ABI_ALL
:
609 if (event
->userspace_probe_location
) {
610 struct lttng_userspace_probe_location
*location_copy
=
611 lttng_userspace_probe_location_copy(
612 event
->userspace_probe_location
);
614 if (!location_copy
) {
615 lttng_event_destroy(tmp_event
);
616 ret_code
= LTTNG_ERR_NOMEM
;
620 ret
= lttng_event_set_userspace_probe_location(tmp_event
, location_copy
);
622 lttng_event_destroy(tmp_event
);
623 lttng_userspace_probe_location_destroy(location_copy
);
624 ret_code
= LTTNG_ERR_INVALID
;
629 ret
= lttng_event_serialize(
630 tmp_event
, 0, nullptr, event
->filter_expression
, 0, nullptr, reply_payload
);
631 lttng_event_destroy(tmp_event
);
633 ret_code
= LTTNG_ERR_FATAL
;
644 * Add URI so the consumer output object. Set the correct path depending on the
645 * domain adding the default trace directory.
647 static enum lttng_error_code
add_uri_to_consumer(const struct ltt_session
*session
,
648 struct consumer_output
*consumer
,
649 struct lttng_uri
*uri
,
650 enum lttng_domain_type domain
)
653 enum lttng_error_code ret_code
= LTTNG_OK
;
657 if (consumer
== nullptr) {
658 DBG("No consumer detected. Don't add URI. Stopping.");
659 ret_code
= LTTNG_ERR_NO_CONSUMER
;
664 case LTTNG_DOMAIN_KERNEL
:
665 ret
= lttng_strncpy(consumer
->domain_subdir
,
666 DEFAULT_KERNEL_TRACE_DIR
,
667 sizeof(consumer
->domain_subdir
));
669 case LTTNG_DOMAIN_UST
:
670 ret
= lttng_strncpy(consumer
->domain_subdir
,
671 DEFAULT_UST_TRACE_DIR
,
672 sizeof(consumer
->domain_subdir
));
676 * This case is possible is we try to add the URI to the global
677 * tracing session consumer object which in this case there is
680 memset(consumer
->domain_subdir
, 0, sizeof(consumer
->domain_subdir
));
684 ERR("Failed to initialize consumer output domain subdirectory");
685 ret_code
= LTTNG_ERR_FATAL
;
689 switch (uri
->dtype
) {
692 DBG2("Setting network URI to consumer");
694 if (consumer
->type
== CONSUMER_DST_NET
) {
695 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
696 consumer
->dst
.net
.control_isset
) ||
697 (uri
->stype
== LTTNG_STREAM_DATA
&& consumer
->dst
.net
.data_isset
)) {
698 ret_code
= LTTNG_ERR_URL_EXIST
;
702 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
705 /* Set URI into consumer output object */
706 ret
= consumer_set_network_uri(session
, consumer
, uri
);
708 ret_code
= (lttng_error_code
) -ret
;
710 } else if (ret
== 1) {
712 * URI was the same in the consumer so we do not append the subdir
713 * again so to not duplicate output dir.
720 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
721 ret_code
= LTTNG_ERR_INVALID
;
724 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
725 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
727 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
729 sizeof(consumer
->dst
.session_root_path
));
731 ret_code
= LTTNG_ERR_FATAL
;
734 consumer
->type
= CONSUMER_DST_LOCAL
;
744 * Init tracing by creating trace directory and sending fds kernel consumer.
746 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
749 struct lttng_ht_iter iter
;
750 struct consumer_socket
*socket
;
752 LTTNG_ASSERT(session
);
754 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= nullptr) {
755 lttng::urcu::read_lock_guard read_lock
;
757 cds_lfht_for_each_entry (
758 session
->consumer
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
759 pthread_mutex_lock(socket
->lock
);
760 ret
= kernel_consumer_send_session(socket
, session
);
761 pthread_mutex_unlock(socket
->lock
);
763 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
774 * Create a socket to the relayd using the URI.
776 * On success, the relayd_sock pointer is set to the created socket.
777 * Else, it remains untouched and an LTTng error code is returned.
779 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
780 struct lttcomm_relayd_sock
**relayd_sock
,
781 struct consumer_output
*consumer
)
784 enum lttng_error_code status
= LTTNG_OK
;
785 struct lttcomm_relayd_sock
*rsock
;
787 rsock
= lttcomm_alloc_relayd_sock(
788 uri
, RELAYD_VERSION_COMM_MAJOR
, RELAYD_VERSION_COMM_MINOR
);
790 status
= LTTNG_ERR_FATAL
;
795 * Connect to relayd so we can proceed with a session creation. This call
796 * can possibly block for an arbitrary amount of time to set the health
797 * state to be in poll execution.
800 ret
= relayd_connect(rsock
);
803 ERR("Unable to reach lttng-relayd");
804 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
808 /* Create socket for control stream. */
809 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
810 uint64_t result_flags
;
812 DBG3("Creating relayd stream socket from URI");
814 /* Check relayd version */
815 ret
= relayd_version_check(rsock
);
816 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
817 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
819 } else if (ret
< 0) {
820 ERR("Unable to reach lttng-relayd");
821 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
824 consumer
->relay_major_version
= rsock
->major
;
825 consumer
->relay_minor_version
= rsock
->minor
;
826 ret
= relayd_get_configuration(rsock
, 0, &result_flags
);
828 ERR("Unable to get relayd configuration");
829 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
832 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
833 consumer
->relay_allows_clear
= true;
835 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
836 DBG3("Creating relayd data socket from URI");
838 /* Command is not valid */
839 ERR("Relayd invalid stream type: %d", uri
->stype
);
840 status
= LTTNG_ERR_INVALID
;
844 *relayd_sock
= rsock
;
849 /* The returned value is not useful since we are on an error path. */
850 (void) relayd_close(rsock
);
858 * Connect to the relayd using URI and send the socket to the right consumer.
860 * The consumer socket lock must be held by the caller.
862 * Returns LTTNG_OK on success or an LTTng error code on failure.
864 static enum lttng_error_code
send_consumer_relayd_socket(unsigned int session_id
,
865 struct lttng_uri
*relayd_uri
,
866 struct consumer_output
*consumer
,
867 struct consumer_socket
*consumer_sock
,
868 const char *session_name
,
869 const char *hostname
,
870 const char *base_path
,
871 int session_live_timer
,
872 const uint64_t *current_chunk_id
,
873 time_t session_creation_time
,
874 bool session_name_contains_creation_time
)
877 struct lttcomm_relayd_sock
*rsock
= nullptr;
878 enum lttng_error_code status
;
880 /* Connect to relayd and make version check if uri is the control. */
881 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
882 if (status
!= LTTNG_OK
) {
883 goto relayd_comm_error
;
887 /* Set the network sequence index if not set. */
888 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
889 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
891 * Increment net_seq_idx because we are about to transfer the
892 * new relayd socket to the consumer.
893 * Assign unique key so the consumer can match streams.
895 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
896 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
899 /* Send relayd socket to consumer. */
900 ret
= consumer_send_relayd_socket(consumer_sock
,
910 session_creation_time
,
911 session_name_contains_creation_time
);
913 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
917 /* Flag that the corresponding socket was sent. */
918 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
919 consumer_sock
->control_sock_sent
= 1;
920 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
921 consumer_sock
->data_sock_sent
= 1;
925 * Close socket which was dup on the consumer side. The session daemon does
926 * NOT keep track of the relayd socket(s) once transfer to the consumer.
930 if (status
!= LTTNG_OK
) {
932 * The consumer output for this session should not be used anymore
933 * since the relayd connection failed thus making any tracing or/and
934 * streaming not usable.
936 consumer
->enabled
= false;
938 (void) relayd_close(rsock
);
946 * Send both relayd sockets to a specific consumer and domain. This is a
947 * helper function to facilitate sending the information to the consumer for a
950 * The consumer socket lock must be held by the caller.
952 * Returns LTTNG_OK, or an LTTng error code on failure.
954 static enum lttng_error_code
send_consumer_relayd_sockets(unsigned int session_id
,
955 struct consumer_output
*consumer
,
956 struct consumer_socket
*sock
,
957 const char *session_name
,
958 const char *hostname
,
959 const char *base_path
,
960 int session_live_timer
,
961 const uint64_t *current_chunk_id
,
962 time_t session_creation_time
,
963 bool session_name_contains_creation_time
)
965 enum lttng_error_code status
= LTTNG_OK
;
967 LTTNG_ASSERT(consumer
);
970 /* Sending control relayd socket. */
971 if (!sock
->control_sock_sent
) {
972 status
= send_consumer_relayd_socket(session_id
,
973 &consumer
->dst
.net
.control
,
981 session_creation_time
,
982 session_name_contains_creation_time
);
983 if (status
!= LTTNG_OK
) {
988 /* Sending data relayd socket. */
989 if (!sock
->data_sock_sent
) {
990 status
= send_consumer_relayd_socket(session_id
,
991 &consumer
->dst
.net
.data
,
999 session_creation_time
,
1000 session_name_contains_creation_time
);
1001 if (status
!= LTTNG_OK
) {
1011 * Setup relayd connections for a tracing session. First creates the socket to
1012 * the relayd and send them to the right domain consumer. Consumer type MUST be
1015 int cmd_setup_relayd(struct ltt_session
*session
)
1018 struct ltt_ust_session
*usess
;
1019 struct ltt_kernel_session
*ksess
;
1020 struct consumer_socket
*socket
;
1021 struct lttng_ht_iter iter
;
1022 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1024 LTTNG_ASSERT(session
);
1026 usess
= session
->ust_session
;
1027 ksess
= session
->kernel_session
;
1029 DBG("Setting relayd for session %s", session
->name
);
1031 if (session
->current_trace_chunk
) {
1032 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1033 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1035 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1036 current_chunk_id
.is_set
= true;
1038 ERR("Failed to get current trace chunk id");
1039 ret
= LTTNG_ERR_UNK
;
1044 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
&&
1045 usess
->consumer
->enabled
) {
1046 /* For each consumer socket, send relayd sockets */
1047 lttng::urcu::read_lock_guard read_lock
;
1049 cds_lfht_for_each_entry (
1050 usess
->consumer
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
1051 pthread_mutex_lock(socket
->lock
);
1052 ret
= send_consumer_relayd_sockets(
1059 session
->live_timer
,
1060 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: nullptr,
1061 session
->creation_time
,
1062 session
->name_contains_creation_time
);
1063 pthread_mutex_unlock(socket
->lock
);
1064 if (ret
!= LTTNG_OK
) {
1067 /* Session is now ready for network streaming. */
1068 session
->net_handle
= 1;
1071 session
->consumer
->relay_major_version
= usess
->consumer
->relay_major_version
;
1072 session
->consumer
->relay_minor_version
= usess
->consumer
->relay_minor_version
;
1073 session
->consumer
->relay_allows_clear
= usess
->consumer
->relay_allows_clear
;
1076 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
&&
1077 ksess
->consumer
->enabled
) {
1078 lttng::urcu::read_lock_guard read_lock
;
1080 cds_lfht_for_each_entry (
1081 ksess
->consumer
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
1082 pthread_mutex_lock(socket
->lock
);
1083 ret
= send_consumer_relayd_sockets(
1090 session
->live_timer
,
1091 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: nullptr,
1092 session
->creation_time
,
1093 session
->name_contains_creation_time
);
1094 pthread_mutex_unlock(socket
->lock
);
1095 if (ret
!= LTTNG_OK
) {
1098 /* Session is now ready for network streaming. */
1099 session
->net_handle
= 1;
1102 session
->consumer
->relay_major_version
= ksess
->consumer
->relay_major_version
;
1103 session
->consumer
->relay_minor_version
= ksess
->consumer
->relay_minor_version
;
1104 session
->consumer
->relay_allows_clear
= ksess
->consumer
->relay_allows_clear
;
1112 * Start a kernel session by opening all necessary streams.
1114 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1117 struct ltt_kernel_channel
*kchan
;
1119 /* Open kernel metadata */
1120 if (ksess
->metadata
== nullptr && ksess
->output_traces
) {
1121 ret
= kernel_open_metadata(ksess
);
1123 ret
= LTTNG_ERR_KERN_META_FAIL
;
1128 /* Open kernel metadata stream */
1129 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1130 ret
= kernel_open_metadata_stream(ksess
);
1132 ERR("Kernel create metadata stream failed");
1133 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1138 /* For each channel */
1139 cds_list_for_each_entry (kchan
, &ksess
->channel_list
.head
, list
) {
1140 if (kchan
->stream_count
== 0) {
1141 ret
= kernel_open_channel_stream(kchan
);
1143 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1146 /* Update the stream global counter */
1147 ksess
->stream_count_global
+= ret
;
1151 /* Setup kernel consumer socket and send fds to it */
1152 ret
= init_kernel_tracing(ksess
);
1154 ret
= LTTNG_ERR_KERN_START_FAIL
;
1158 /* This start the kernel tracing */
1159 ret
= kernel_start_session(ksess
);
1161 ret
= LTTNG_ERR_KERN_START_FAIL
;
1165 /* Quiescent wait after starting trace */
1166 kernel_wait_quiescent();
1168 ksess
->active
= true;
1176 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1178 struct ltt_kernel_channel
*kchan
;
1179 bool error_occurred
= false;
1182 if (!ksess
|| !ksess
->active
) {
1185 DBG("Stopping kernel tracing");
1187 ret
= kernel_stop_session(ksess
);
1189 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1193 kernel_wait_quiescent();
1195 /* Flush metadata after stopping (if exists) */
1196 if (ksess
->metadata_stream_fd
>= 0) {
1197 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1199 ERR("Kernel metadata flush failed");
1200 error_occurred
= true;
1204 /* Flush all buffers after stopping */
1205 cds_list_for_each_entry (kchan
, &ksess
->channel_list
.head
, list
) {
1206 ret
= kernel_flush_buffer(kchan
);
1208 ERR("Kernel flush buffer error");
1209 error_occurred
= true;
1213 ksess
->active
= false;
1214 if (error_occurred
) {
1215 ret
= LTTNG_ERR_UNK
;
1224 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1226 int cmd_disable_channel(struct ltt_session
*session
,
1227 enum lttng_domain_type domain
,
1231 struct ltt_ust_session
*usess
;
1233 usess
= session
->ust_session
;
1235 lttng::urcu::read_lock_guard read_lock
;
1238 case LTTNG_DOMAIN_KERNEL
:
1240 ret
= channel_kernel_disable(session
->kernel_session
, channel_name
);
1241 if (ret
!= LTTNG_OK
) {
1245 kernel_wait_quiescent();
1248 case LTTNG_DOMAIN_UST
:
1250 struct ltt_ust_channel
*uchan
;
1251 struct lttng_ht
*chan_ht
;
1253 chan_ht
= usess
->domain_global
.channels
;
1255 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1256 if (uchan
== nullptr) {
1257 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1261 ret
= channel_ust_disable(usess
, uchan
);
1262 if (ret
!= LTTNG_OK
) {
1268 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1279 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1281 * The wpipe arguments is used as a notifier for the kernel thread.
1283 int cmd_enable_channel(struct command_ctx
*cmd_ctx
, int sock
, int wpipe
)
1287 ssize_t sock_recv_len
;
1288 struct lttng_channel
*channel
= nullptr;
1289 struct lttng_buffer_view view
;
1290 struct lttng_dynamic_buffer channel_buffer
;
1291 const struct lttng_domain command_domain
= cmd_ctx
->lsm
.domain
;
1293 lttng_dynamic_buffer_init(&channel_buffer
);
1294 channel_len
= (size_t) cmd_ctx
->lsm
.u
.channel
.length
;
1295 ret
= lttng_dynamic_buffer_set_size(&channel_buffer
, channel_len
);
1297 ret
= LTTNG_ERR_NOMEM
;
1301 sock_recv_len
= lttcomm_recv_unix_sock(sock
, channel_buffer
.data
, channel_len
);
1302 if (sock_recv_len
< 0 || sock_recv_len
!= channel_len
) {
1303 ERR("Failed to receive \"enable channel\" command payload");
1304 ret
= LTTNG_ERR_INVALID
;
1308 view
= lttng_buffer_view_from_dynamic_buffer(&channel_buffer
, 0, channel_len
);
1309 if (!lttng_buffer_view_is_valid(&view
)) {
1310 ret
= LTTNG_ERR_INVALID
;
1314 if (lttng_channel_create_from_buffer(&view
, &channel
) != channel_len
) {
1315 ERR("Invalid channel payload received in \"enable channel\" command");
1316 ret
= LTTNG_ERR_INVALID
;
1320 ret
= cmd_enable_channel_internal(cmd_ctx
->session
, &command_domain
, channel
, wpipe
);
1323 lttng_dynamic_buffer_reset(&channel_buffer
);
1324 lttng_channel_destroy(channel
);
1328 static enum lttng_error_code
cmd_enable_channel_internal(struct ltt_session
*session
,
1329 const struct lttng_domain
*domain
,
1330 const struct lttng_channel
*_attr
,
1333 enum lttng_error_code ret_code
;
1334 struct ltt_ust_session
*usess
= session
->ust_session
;
1335 struct lttng_ht
*chan_ht
;
1337 struct lttng_channel
*attr
= nullptr;
1339 LTTNG_ASSERT(session
);
1340 LTTNG_ASSERT(_attr
);
1341 LTTNG_ASSERT(domain
);
1343 lttng::urcu::read_lock_guard read_lock
;
1345 attr
= lttng_channel_copy(_attr
);
1347 ret_code
= LTTNG_ERR_NOMEM
;
1351 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1353 /* Validate channel name */
1354 if (attr
->name
[0] == '.' || memchr(attr
->name
, '/', len
) != nullptr) {
1355 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1359 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1362 * If the session is a live session, remove the switch timer, the
1363 * live timer does the same thing but sends also synchronisation
1364 * beacons for inactive streams.
1366 if (session
->live_timer
> 0) {
1367 attr
->attr
.live_timer_interval
= session
->live_timer
;
1368 attr
->attr
.switch_timer_interval
= 0;
1371 /* Check for feature support */
1372 switch (domain
->type
) {
1373 case LTTNG_DOMAIN_KERNEL
:
1375 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1376 /* Sampling position of buffer is not supported */
1377 WARN("Kernel tracer does not support buffer monitoring. "
1378 "Setting the monitor interval timer to 0 "
1379 "(disabled) for channel '%s' of session '%s'",
1382 lttng_channel_set_monitor_timer_interval(attr
, 0);
1386 case LTTNG_DOMAIN_UST
:
1388 case LTTNG_DOMAIN_JUL
:
1389 case LTTNG_DOMAIN_LOG4J
:
1390 case LTTNG_DOMAIN_PYTHON
:
1391 if (!agent_tracing_is_enabled()) {
1392 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1393 ret_code
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1398 ret_code
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1402 switch (domain
->type
) {
1403 case LTTNG_DOMAIN_KERNEL
:
1405 struct ltt_kernel_channel
*kchan
;
1407 kchan
= trace_kernel_get_channel_by_name(attr
->name
, session
->kernel_session
);
1408 if (kchan
== nullptr) {
1410 * Don't try to create a channel if the session has been started at
1411 * some point in time before. The tracer does not allow it.
1413 if (session
->has_been_started
) {
1414 ret_code
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1418 if (session
->snapshot
.nb_output
> 0 || session
->snapshot_mode
) {
1419 /* Enforce mmap output for snapshot sessions. */
1420 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
1422 ret_code
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1423 if (attr
->name
[0] != '\0') {
1424 session
->kernel_session
->has_non_default_channel
= 1;
1427 ret_code
= channel_kernel_enable(session
->kernel_session
, kchan
);
1430 if (ret_code
!= LTTNG_OK
) {
1434 kernel_wait_quiescent();
1437 case LTTNG_DOMAIN_UST
:
1438 case LTTNG_DOMAIN_JUL
:
1439 case LTTNG_DOMAIN_LOG4J
:
1440 case LTTNG_DOMAIN_PYTHON
:
1442 struct ltt_ust_channel
*uchan
;
1447 * Current agent implementation limitations force us to allow
1448 * only one channel at once in "agent" subdomains. Each
1449 * subdomain has a default channel name which must be strictly
1452 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1453 if (strncmp(attr
->name
,
1454 DEFAULT_JUL_CHANNEL_NAME
,
1455 LTTNG_SYMBOL_NAME_LEN
- 1) != 0) {
1456 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1459 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1460 if (strncmp(attr
->name
,
1461 DEFAULT_LOG4J_CHANNEL_NAME
,
1462 LTTNG_SYMBOL_NAME_LEN
- 1) != 0) {
1463 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1466 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1467 if (strncmp(attr
->name
,
1468 DEFAULT_PYTHON_CHANNEL_NAME
,
1469 LTTNG_SYMBOL_NAME_LEN
- 1) != 0) {
1470 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1475 chan_ht
= usess
->domain_global
.channels
;
1477 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1478 if (uchan
== nullptr) {
1480 * Don't try to create a channel if the session has been started at
1481 * some point in time before. The tracer does not allow it.
1483 if (session
->has_been_started
) {
1484 ret_code
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1488 ret_code
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1489 if (attr
->name
[0] != '\0') {
1490 usess
->has_non_default_channel
= 1;
1493 ret_code
= channel_ust_enable(usess
, uchan
);
1498 ret_code
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1502 if (ret_code
== LTTNG_OK
&& attr
->attr
.output
!= LTTNG_EVENT_MMAP
) {
1503 session
->has_non_mmap_channel
= true;
1507 lttng_channel_destroy(attr
);
1511 enum lttng_error_code
1512 cmd_process_attr_tracker_get_tracking_policy(struct ltt_session
*session
,
1513 enum lttng_domain_type domain
,
1514 enum lttng_process_attr process_attr
,
1515 enum lttng_tracking_policy
*policy
)
1517 enum lttng_error_code ret_code
= LTTNG_OK
;
1518 const struct process_attr_tracker
*tracker
;
1521 case LTTNG_DOMAIN_KERNEL
:
1522 if (!session
->kernel_session
) {
1523 ret_code
= LTTNG_ERR_INVALID
;
1526 tracker
= kernel_get_process_attr_tracker(session
->kernel_session
, process_attr
);
1528 case LTTNG_DOMAIN_UST
:
1529 if (!session
->ust_session
) {
1530 ret_code
= LTTNG_ERR_INVALID
;
1533 tracker
= trace_ust_get_process_attr_tracker(session
->ust_session
, process_attr
);
1536 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1540 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1542 ret_code
= LTTNG_ERR_INVALID
;
1548 enum lttng_error_code
1549 cmd_process_attr_tracker_set_tracking_policy(struct ltt_session
*session
,
1550 enum lttng_domain_type domain
,
1551 enum lttng_process_attr process_attr
,
1552 enum lttng_tracking_policy policy
)
1554 enum lttng_error_code ret_code
= LTTNG_OK
;
1557 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1558 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1559 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1562 ret_code
= LTTNG_ERR_INVALID
;
1567 case LTTNG_DOMAIN_KERNEL
:
1568 if (!session
->kernel_session
) {
1569 ret_code
= LTTNG_ERR_INVALID
;
1572 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1573 session
->kernel_session
, process_attr
, policy
);
1575 case LTTNG_DOMAIN_UST
:
1576 if (!session
->ust_session
) {
1577 ret_code
= LTTNG_ERR_INVALID
;
1580 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1581 session
->ust_session
, process_attr
, policy
);
1584 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1591 enum lttng_error_code
1592 cmd_process_attr_tracker_inclusion_set_add_value(struct ltt_session
*session
,
1593 enum lttng_domain_type domain
,
1594 enum lttng_process_attr process_attr
,
1595 const struct process_attr_value
*value
)
1597 enum lttng_error_code ret_code
= LTTNG_OK
;
1600 case LTTNG_DOMAIN_KERNEL
:
1601 if (!session
->kernel_session
) {
1602 ret_code
= LTTNG_ERR_INVALID
;
1605 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1606 session
->kernel_session
, process_attr
, value
);
1608 case LTTNG_DOMAIN_UST
:
1609 if (!session
->ust_session
) {
1610 ret_code
= LTTNG_ERR_INVALID
;
1613 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1614 session
->ust_session
, process_attr
, value
);
1617 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1624 enum lttng_error_code
1625 cmd_process_attr_tracker_inclusion_set_remove_value(struct ltt_session
*session
,
1626 enum lttng_domain_type domain
,
1627 enum lttng_process_attr process_attr
,
1628 const struct process_attr_value
*value
)
1630 enum lttng_error_code ret_code
= LTTNG_OK
;
1633 case LTTNG_DOMAIN_KERNEL
:
1634 if (!session
->kernel_session
) {
1635 ret_code
= LTTNG_ERR_INVALID
;
1638 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1639 session
->kernel_session
, process_attr
, value
);
1641 case LTTNG_DOMAIN_UST
:
1642 if (!session
->ust_session
) {
1643 ret_code
= LTTNG_ERR_INVALID
;
1646 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1647 session
->ust_session
, process_attr
, value
);
1650 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1657 enum lttng_error_code
1658 cmd_process_attr_tracker_get_inclusion_set(struct ltt_session
*session
,
1659 enum lttng_domain_type domain
,
1660 enum lttng_process_attr process_attr
,
1661 struct lttng_process_attr_values
**values
)
1663 enum lttng_error_code ret_code
= LTTNG_OK
;
1664 const struct process_attr_tracker
*tracker
;
1665 enum process_attr_tracker_status status
;
1668 case LTTNG_DOMAIN_KERNEL
:
1669 if (!session
->kernel_session
) {
1670 ret_code
= LTTNG_ERR_INVALID
;
1673 tracker
= kernel_get_process_attr_tracker(session
->kernel_session
, process_attr
);
1675 case LTTNG_DOMAIN_UST
:
1676 if (!session
->ust_session
) {
1677 ret_code
= LTTNG_ERR_INVALID
;
1680 tracker
= trace_ust_get_process_attr_tracker(session
->ust_session
, process_attr
);
1683 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1688 ret_code
= LTTNG_ERR_INVALID
;
1692 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1694 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1695 ret_code
= LTTNG_OK
;
1697 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1698 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1700 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1701 ret_code
= LTTNG_ERR_NOMEM
;
1704 ret_code
= LTTNG_ERR_UNK
;
1713 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1715 int cmd_disable_event(struct command_ctx
*cmd_ctx
,
1716 struct lttng_event
*event
,
1717 char *filter_expression
,
1718 struct lttng_bytecode
*bytecode
,
1719 struct lttng_event_exclusion
*exclusion
)
1722 const char *event_name
;
1723 const struct ltt_session
*session
= cmd_ctx
->session
;
1724 const char *channel_name
= cmd_ctx
->lsm
.u
.disable
.channel_name
;
1725 const enum lttng_domain_type domain
= cmd_ctx
->lsm
.domain
.type
;
1727 DBG("Disable event command for event \'%s\'", event
->name
);
1730 * Filter and exclusions are simply not handled by the
1731 * disable event command at this time.
1735 (void) filter_expression
;
1738 /* Ignore the presence of filter or exclusion for the event */
1740 event
->exclusion
= 0;
1742 event_name
= event
->name
;
1744 lttng::urcu::read_lock_guard read_lock
;
1746 /* Error out on unhandled search criteria */
1747 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
|| event
->pid
||
1748 event
->filter
|| event
->exclusion
) {
1749 ret
= LTTNG_ERR_UNK
;
1754 case LTTNG_DOMAIN_KERNEL
:
1756 struct ltt_kernel_channel
*kchan
;
1757 struct ltt_kernel_session
*ksess
;
1759 ksess
= session
->kernel_session
;
1762 * If a non-default channel has been created in the
1763 * session, explicitely require that -c chan_name needs
1766 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1767 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1771 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1772 if (kchan
== nullptr) {
1773 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1777 switch (event
->type
) {
1778 case LTTNG_EVENT_ALL
:
1779 case LTTNG_EVENT_TRACEPOINT
:
1780 case LTTNG_EVENT_SYSCALL
:
1781 case LTTNG_EVENT_PROBE
:
1782 case LTTNG_EVENT_FUNCTION
:
1783 case LTTNG_EVENT_FUNCTION_ENTRY
: /* fall-through */
1784 if (event_name
[0] == '\0') {
1785 ret
= event_kernel_disable_event(kchan
, nullptr, event
->type
);
1787 ret
= event_kernel_disable_event(kchan
, event_name
, event
->type
);
1789 if (ret
!= LTTNG_OK
) {
1794 ret
= LTTNG_ERR_UNK
;
1798 kernel_wait_quiescent();
1801 case LTTNG_DOMAIN_UST
:
1803 struct ltt_ust_channel
*uchan
;
1804 struct ltt_ust_session
*usess
;
1806 usess
= session
->ust_session
;
1808 if (validate_ust_event_name(event_name
)) {
1809 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1814 * If a non-default channel has been created in the
1815 * session, explicitly require that -c chan_name needs
1818 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1819 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1823 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
, channel_name
);
1824 if (uchan
== nullptr) {
1825 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1829 switch (event
->type
) {
1830 case LTTNG_EVENT_ALL
:
1832 * An empty event name means that everything
1833 * should be disabled.
1835 if (event
->name
[0] == '\0') {
1836 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1838 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1840 if (ret
!= LTTNG_OK
) {
1845 ret
= LTTNG_ERR_UNK
;
1849 DBG3("Disable UST event %s in channel %s completed", event_name
, channel_name
);
1852 case LTTNG_DOMAIN_LOG4J
:
1853 case LTTNG_DOMAIN_JUL
:
1854 case LTTNG_DOMAIN_PYTHON
:
1857 struct ltt_ust_session
*usess
= session
->ust_session
;
1859 LTTNG_ASSERT(usess
);
1861 switch (event
->type
) {
1862 case LTTNG_EVENT_ALL
:
1865 ret
= LTTNG_ERR_UNK
;
1869 agt
= trace_ust_find_agent(usess
, domain
);
1871 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1875 * An empty event name means that everything
1876 * should be disabled.
1878 if (event
->name
[0] == '\0') {
1879 ret
= event_agent_disable_all(usess
, agt
);
1881 ret
= event_agent_disable(usess
, agt
, event_name
);
1883 if (ret
!= LTTNG_OK
) {
1890 ret
= LTTNG_ERR_UND
;
1900 free(filter_expression
);
1905 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1907 int cmd_add_context(struct command_ctx
*cmd_ctx
,
1908 const struct lttng_event_context
*event_context
,
1911 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1912 const enum lttng_domain_type domain
= cmd_ctx
->lsm
.domain
.type
;
1913 const struct ltt_session
*session
= cmd_ctx
->session
;
1914 const char *channel_name
= cmd_ctx
->lsm
.u
.context
.channel_name
;
1917 * Don't try to add a context if the session has been started at
1918 * some point in time before. The tracer does not allow it and would
1919 * result in a corrupted trace.
1921 if (cmd_ctx
->session
->has_been_started
) {
1922 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1927 case LTTNG_DOMAIN_KERNEL
:
1928 LTTNG_ASSERT(session
->kernel_session
);
1930 if (session
->kernel_session
->channel_count
== 0) {
1931 /* Create default channel */
1932 ret
= channel_kernel_create(session
->kernel_session
, nullptr, kwpipe
);
1933 if (ret
!= LTTNG_OK
) {
1936 chan_kern_created
= 1;
1938 /* Add kernel context to kernel tracer */
1939 ret
= context_kernel_add(session
->kernel_session
, event_context
, channel_name
);
1940 if (ret
!= LTTNG_OK
) {
1944 case LTTNG_DOMAIN_JUL
:
1945 case LTTNG_DOMAIN_LOG4J
:
1948 * Validate channel name.
1949 * If no channel name is given and the domain is JUL or LOG4J,
1950 * set it to the appropriate domain-specific channel name. If
1951 * a name is provided but does not match the expexted channel
1952 * name, return an error.
1954 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1955 strcmp(channel_name
, DEFAULT_JUL_CHANNEL_NAME
) != 0) {
1956 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1958 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1959 strcmp(channel_name
, DEFAULT_LOG4J_CHANNEL_NAME
) != 0) {
1960 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1965 case LTTNG_DOMAIN_UST
:
1967 struct ltt_ust_session
*usess
= session
->ust_session
;
1968 unsigned int chan_count
;
1970 LTTNG_ASSERT(usess
);
1972 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1973 if (chan_count
== 0) {
1974 struct lttng_channel
*attr
;
1975 /* Create default channel */
1976 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1977 if (attr
== nullptr) {
1978 ret
= LTTNG_ERR_FATAL
;
1982 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1983 if (ret
!= LTTNG_OK
) {
1987 channel_attr_destroy(attr
);
1988 chan_ust_created
= 1;
1991 ret
= context_ust_add(usess
, domain
, event_context
, channel_name
);
1992 if (ret
!= LTTNG_OK
) {
1998 ret
= LTTNG_ERR_UND
;
2006 if (chan_kern_created
) {
2007 struct ltt_kernel_channel
*kchan
= trace_kernel_get_channel_by_name(
2008 DEFAULT_CHANNEL_NAME
, session
->kernel_session
);
2009 /* Created previously, this should NOT fail. */
2010 LTTNG_ASSERT(kchan
);
2011 kernel_destroy_channel(kchan
);
2014 if (chan_ust_created
) {
2015 struct ltt_ust_channel
*uchan
= trace_ust_find_channel_by_name(
2016 session
->ust_session
->domain_global
.channels
, DEFAULT_CHANNEL_NAME
);
2017 /* Created previously, this should NOT fail. */
2018 LTTNG_ASSERT(uchan
);
2019 /* Remove from the channel list of the session. */
2020 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
, uchan
);
2021 trace_ust_destroy_channel(uchan
);
2027 static inline bool name_starts_with(const char *name
, const char *prefix
)
2029 const size_t max_cmp_len
= std::min(strlen(prefix
), (size_t) LTTNG_SYMBOL_NAME_LEN
);
2031 return !strncmp(name
, prefix
, max_cmp_len
);
2034 /* Perform userspace-specific event name validation */
2035 static int validate_ust_event_name(const char *name
)
2045 * Check name against all internal UST event component namespaces used
2048 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2049 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2050 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2059 * Internal version of cmd_enable_event() with a supplemental
2060 * "internal_event" flag which is used to enable internal events which should
2061 * be hidden from clients. Such events are used in the agent implementation to
2062 * enable the events through which all "agent" events are funeled.
2064 static int _cmd_enable_event(struct ltt_session
*session
,
2065 const struct lttng_domain
*domain
,
2067 struct lttng_event
*event
,
2068 char *filter_expression
,
2069 struct lttng_bytecode
*filter
,
2070 struct lttng_event_exclusion
*exclusion
,
2072 bool internal_event
)
2074 int ret
= 0, channel_created
= 0;
2075 struct lttng_channel
*attr
= nullptr;
2077 LTTNG_ASSERT(session
);
2078 LTTNG_ASSERT(event
);
2079 LTTNG_ASSERT(channel_name
);
2081 /* If we have a filter, we must have its filter expression */
2082 LTTNG_ASSERT(!(!!filter_expression
^ !!filter
));
2084 /* Normalize event name as a globbing pattern */
2085 strutils_normalize_star_glob_pattern(event
->name
);
2087 /* Normalize exclusion names as globbing patterns */
2091 for (i
= 0; i
< exclusion
->count
; i
++) {
2092 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2094 strutils_normalize_star_glob_pattern(name
);
2098 /* Normalize loglevel value to simplify comparisons. */
2099 if (event
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_ALL
) {
2100 /* Ignore the user-specified value; it has no meaning. */
2101 event
->loglevel
= -1;
2104 DBG("Enable event command for event \'%s\'", event
->name
);
2106 lttng::urcu::read_lock_guard read_lock
;
2108 switch (domain
->type
) {
2109 case LTTNG_DOMAIN_KERNEL
:
2111 struct ltt_kernel_channel
*kchan
;
2114 * If a non-default channel has been created in the
2115 * session, explicitely require that -c chan_name needs
2118 if (session
->kernel_session
->has_non_default_channel
&& channel_name
[0] == '\0') {
2119 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2123 kchan
= trace_kernel_get_channel_by_name(channel_name
, session
->kernel_session
);
2124 if (kchan
== nullptr) {
2125 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
, LTTNG_BUFFER_GLOBAL
);
2126 if (attr
== nullptr) {
2127 ret
= LTTNG_ERR_FATAL
;
2130 if (lttng_strncpy(attr
->name
, channel_name
, sizeof(attr
->name
))) {
2131 ret
= LTTNG_ERR_INVALID
;
2135 ret
= cmd_enable_channel_internal(session
, domain
, attr
, wpipe
);
2136 if (ret
!= LTTNG_OK
) {
2139 channel_created
= 1;
2142 /* Get the newly created kernel channel pointer */
2143 kchan
= trace_kernel_get_channel_by_name(channel_name
, session
->kernel_session
);
2144 if (kchan
== nullptr) {
2145 /* This sould not happen... */
2146 ret
= LTTNG_ERR_FATAL
;
2150 switch (event
->type
) {
2151 case LTTNG_EVENT_ALL
:
2153 char *filter_expression_a
= nullptr;
2154 struct lttng_bytecode
*filter_a
= nullptr;
2157 * We need to duplicate filter_expression and filter,
2158 * because ownership is passed to first enable
2161 if (filter_expression
) {
2162 filter_expression_a
= strdup(filter_expression
);
2163 if (!filter_expression_a
) {
2164 ret
= LTTNG_ERR_FATAL
;
2169 filter_a
= zmalloc
<lttng_bytecode
>(sizeof(*filter_a
) + filter
->len
);
2171 free(filter_expression_a
);
2172 ret
= LTTNG_ERR_FATAL
;
2175 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2177 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2178 ret
= event_kernel_enable_event(kchan
, event
, filter_expression
, filter
);
2179 /* We have passed ownership */
2180 filter_expression
= nullptr;
2182 if (ret
!= LTTNG_OK
) {
2183 if (channel_created
) {
2184 /* Let's not leak a useless channel. */
2185 kernel_destroy_channel(kchan
);
2187 free(filter_expression_a
);
2191 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2192 ret
= event_kernel_enable_event(
2193 kchan
, event
, filter_expression_a
, filter_a
);
2194 /* We have passed ownership */
2195 filter_expression_a
= nullptr;
2197 if (ret
!= LTTNG_OK
) {
2202 case LTTNG_EVENT_PROBE
:
2203 case LTTNG_EVENT_USERSPACE_PROBE
:
2204 case LTTNG_EVENT_FUNCTION
:
2205 case LTTNG_EVENT_FUNCTION_ENTRY
:
2206 case LTTNG_EVENT_TRACEPOINT
:
2207 ret
= event_kernel_enable_event(kchan
, event
, filter_expression
, filter
);
2208 /* We have passed ownership */
2209 filter_expression
= nullptr;
2211 if (ret
!= LTTNG_OK
) {
2212 if (channel_created
) {
2213 /* Let's not leak a useless channel. */
2214 kernel_destroy_channel(kchan
);
2219 case LTTNG_EVENT_SYSCALL
:
2220 ret
= event_kernel_enable_event(kchan
, event
, filter_expression
, filter
);
2221 /* We have passed ownership */
2222 filter_expression
= nullptr;
2224 if (ret
!= LTTNG_OK
) {
2229 ret
= LTTNG_ERR_UNK
;
2233 kernel_wait_quiescent();
2236 case LTTNG_DOMAIN_UST
:
2238 struct ltt_ust_channel
*uchan
;
2239 struct ltt_ust_session
*usess
= session
->ust_session
;
2241 LTTNG_ASSERT(usess
);
2244 * If a non-default channel has been created in the
2245 * session, explicitely require that -c chan_name needs
2248 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2249 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2253 /* Get channel from global UST domain */
2254 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
, channel_name
);
2255 if (uchan
== nullptr) {
2256 /* Create default channel */
2257 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
, usess
->buffer_type
);
2258 if (attr
== nullptr) {
2259 ret
= LTTNG_ERR_FATAL
;
2262 if (lttng_strncpy(attr
->name
, channel_name
, sizeof(attr
->name
))) {
2263 ret
= LTTNG_ERR_INVALID
;
2267 ret
= cmd_enable_channel_internal(session
, domain
, attr
, wpipe
);
2268 if (ret
!= LTTNG_OK
) {
2272 /* Get the newly created channel reference back */
2273 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2275 LTTNG_ASSERT(uchan
);
2278 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2280 * Don't allow users to add UST events to channels which
2281 * are assigned to a userspace subdomain (JUL, Log4J,
2284 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2288 if (!internal_event
) {
2290 * Ensure the event name is not reserved for internal
2293 ret
= validate_ust_event_name(event
->name
);
2295 WARN("Userspace event name %s failed validation.", event
->name
);
2296 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2301 /* At this point, the session and channel exist on the tracer */
2302 ret
= event_ust_enable_tracepoint(
2303 usess
, uchan
, event
, filter_expression
, filter
, exclusion
, internal_event
);
2304 /* We have passed ownership */
2305 filter_expression
= nullptr;
2307 exclusion
= nullptr;
2308 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2309 goto already_enabled
;
2310 } else if (ret
!= LTTNG_OK
) {
2315 case LTTNG_DOMAIN_LOG4J
:
2316 case LTTNG_DOMAIN_JUL
:
2317 case LTTNG_DOMAIN_PYTHON
:
2319 const char *default_event_name
, *default_chan_name
;
2321 struct lttng_event uevent
;
2322 struct lttng_domain tmp_dom
;
2323 struct ltt_ust_session
*usess
= session
->ust_session
;
2325 LTTNG_ASSERT(usess
);
2327 if (!agent_tracing_is_enabled()) {
2328 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2329 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2333 agt
= trace_ust_find_agent(usess
, domain
->type
);
2335 agt
= agent_create(domain
->type
);
2337 ret
= LTTNG_ERR_NOMEM
;
2340 agent_add(agt
, usess
->agents
);
2343 /* Create the default tracepoint. */
2344 memset(&uevent
, 0, sizeof(uevent
));
2345 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2346 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2347 uevent
.loglevel
= -1;
2348 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
2349 if (!default_event_name
) {
2350 ret
= LTTNG_ERR_FATAL
;
2353 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2354 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2357 * The domain type is changed because we are about to enable the
2358 * default channel and event for the JUL domain that are hardcoded.
2359 * This happens in the UST domain.
2361 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2362 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2364 switch (domain
->type
) {
2365 case LTTNG_DOMAIN_LOG4J
:
2366 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2368 case LTTNG_DOMAIN_JUL
:
2369 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2371 case LTTNG_DOMAIN_PYTHON
:
2372 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2375 /* The switch/case we are in makes this impossible */
2380 char *filter_expression_copy
= nullptr;
2381 struct lttng_bytecode
*filter_copy
= nullptr;
2384 const size_t filter_size
=
2385 sizeof(struct lttng_bytecode
) + filter
->len
;
2387 filter_copy
= zmalloc
<lttng_bytecode
>(filter_size
);
2389 ret
= LTTNG_ERR_NOMEM
;
2392 memcpy(filter_copy
, filter
, filter_size
);
2394 filter_expression_copy
= strdup(filter_expression
);
2395 if (!filter_expression
) {
2396 ret
= LTTNG_ERR_NOMEM
;
2399 if (!filter_expression_copy
|| !filter_copy
) {
2400 free(filter_expression_copy
);
2406 ret
= cmd_enable_event_internal(session
,
2408 (char *) default_chan_name
,
2410 filter_expression_copy
,
2416 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2417 goto already_enabled
;
2418 } else if (ret
!= LTTNG_OK
) {
2422 /* The wild card * means that everything should be enabled. */
2423 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2424 ret
= event_agent_enable_all(usess
, agt
, event
, filter
, filter_expression
);
2426 ret
= event_agent_enable(usess
, agt
, event
, filter
, filter_expression
);
2429 filter_expression
= nullptr;
2430 if (ret
!= LTTNG_OK
) {
2437 ret
= LTTNG_ERR_UND
;
2445 free(filter_expression
);
2448 channel_attr_destroy(attr
);
2453 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2454 * We own filter, exclusion, and filter_expression.
2456 int cmd_enable_event(struct command_ctx
*cmd_ctx
,
2457 struct lttng_event
*event
,
2458 char *filter_expression
,
2459 struct lttng_event_exclusion
*exclusion
,
2460 struct lttng_bytecode
*bytecode
,
2465 * Copied to ensure proper alignment since 'lsm' is a packed structure.
2467 const lttng_domain command_domain
= cmd_ctx
->lsm
.domain
;
2470 * The ownership of the following parameters is transferred to
2471 * _cmd_enable_event:
2473 * - filter_expression,
2477 ret
= _cmd_enable_event(cmd_ctx
->session
,
2479 cmd_ctx
->lsm
.u
.enable
.channel_name
,
2486 filter_expression
= nullptr;
2488 exclusion
= nullptr;
2493 * Enable an event which is internal to LTTng. An internal should
2494 * never be made visible to clients and are immune to checks such as
2497 static int cmd_enable_event_internal(struct ltt_session
*session
,
2498 const struct lttng_domain
*domain
,
2500 struct lttng_event
*event
,
2501 char *filter_expression
,
2502 struct lttng_bytecode
*filter
,
2503 struct lttng_event_exclusion
*exclusion
,
2506 return _cmd_enable_event(session
,
2518 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2520 enum lttng_error_code
cmd_list_tracepoints(enum lttng_domain_type domain
,
2521 struct lttng_payload
*reply_payload
)
2523 enum lttng_error_code ret_code
;
2525 ssize_t i
, nb_events
= 0;
2526 struct lttng_event
*events
= nullptr;
2527 struct lttcomm_list_command_header reply_command_header
= {};
2528 size_t reply_command_header_offset
;
2530 assert(reply_payload
);
2532 /* Reserve space for command reply header. */
2533 reply_command_header_offset
= reply_payload
->buffer
.size
;
2534 ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
2535 reply_command_header_offset
+
2536 sizeof(struct lttcomm_list_command_header
));
2538 ret_code
= LTTNG_ERR_NOMEM
;
2543 case LTTNG_DOMAIN_KERNEL
:
2544 nb_events
= kernel_list_events(&events
);
2545 if (nb_events
< 0) {
2546 ret_code
= LTTNG_ERR_KERN_LIST_FAIL
;
2550 case LTTNG_DOMAIN_UST
:
2551 nb_events
= ust_app_list_events(&events
);
2552 if (nb_events
< 0) {
2553 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2557 case LTTNG_DOMAIN_LOG4J
:
2558 case LTTNG_DOMAIN_JUL
:
2559 case LTTNG_DOMAIN_PYTHON
:
2560 nb_events
= agent_list_events(&events
, domain
);
2561 if (nb_events
< 0) {
2562 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2567 ret_code
= LTTNG_ERR_UND
;
2571 for (i
= 0; i
< nb_events
; i
++) {
2572 ret
= lttng_event_serialize(
2573 &events
[i
], 0, nullptr, nullptr, 0, nullptr, reply_payload
);
2575 ret_code
= LTTNG_ERR_NOMEM
;
2580 if (nb_events
> UINT32_MAX
) {
2581 ERR("Tracepoint count would overflow the tracepoint listing command's reply");
2582 ret_code
= LTTNG_ERR_OVERFLOW
;
2586 /* Update command reply header. */
2587 reply_command_header
.count
= (uint32_t) nb_events
;
2588 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
,
2589 &reply_command_header
,
2590 sizeof(reply_command_header
));
2592 ret_code
= LTTNG_OK
;
2599 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2601 enum lttng_error_code
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2602 struct lttng_payload
*reply
)
2604 enum lttng_error_code ret_code
;
2606 unsigned int i
, nb_fields
;
2607 struct lttng_event_field
*fields
= nullptr;
2608 struct lttcomm_list_command_header reply_command_header
= {};
2609 size_t reply_command_header_offset
;
2613 /* Reserve space for command reply header. */
2614 reply_command_header_offset
= reply
->buffer
.size
;
2615 ret
= lttng_dynamic_buffer_set_size(&reply
->buffer
,
2616 reply_command_header_offset
+
2617 sizeof(struct lttcomm_list_command_header
));
2619 ret_code
= LTTNG_ERR_NOMEM
;
2624 case LTTNG_DOMAIN_UST
:
2625 ret
= ust_app_list_event_fields(&fields
);
2627 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2632 case LTTNG_DOMAIN_KERNEL
:
2633 default: /* fall-through */
2634 ret_code
= LTTNG_ERR_UND
;
2640 for (i
= 0; i
< nb_fields
; i
++) {
2641 ret
= lttng_event_field_serialize(&fields
[i
], reply
);
2643 ret_code
= LTTNG_ERR_NOMEM
;
2648 if (nb_fields
> UINT32_MAX
) {
2649 ERR("Tracepoint field count would overflow the tracepoint field listing command's reply");
2650 ret_code
= LTTNG_ERR_OVERFLOW
;
2654 /* Update command reply header. */
2655 reply_command_header
.count
= (uint32_t) nb_fields
;
2657 memcpy(reply
->buffer
.data
+ reply_command_header_offset
,
2658 &reply_command_header
,
2659 sizeof(reply_command_header
));
2661 ret_code
= LTTNG_OK
;
2668 enum lttng_error_code
cmd_list_syscalls(struct lttng_payload
*reply_payload
)
2670 enum lttng_error_code ret_code
;
2671 ssize_t nb_events
, i
;
2673 struct lttng_event
*events
= nullptr;
2674 struct lttcomm_list_command_header reply_command_header
= {};
2675 size_t reply_command_header_offset
;
2677 assert(reply_payload
);
2679 /* Reserve space for command reply header. */
2680 reply_command_header_offset
= reply_payload
->buffer
.size
;
2681 ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
2682 reply_command_header_offset
+
2683 sizeof(struct lttcomm_list_command_header
));
2685 ret_code
= LTTNG_ERR_NOMEM
;
2689 nb_events
= syscall_table_list(&events
);
2690 if (nb_events
< 0) {
2691 ret_code
= (enum lttng_error_code
) - nb_events
;
2695 for (i
= 0; i
< nb_events
; i
++) {
2696 ret
= lttng_event_serialize(
2697 &events
[i
], 0, nullptr, nullptr, 0, nullptr, reply_payload
);
2699 ret_code
= LTTNG_ERR_NOMEM
;
2704 if (nb_events
> UINT32_MAX
) {
2705 ERR("Syscall count would overflow the syscall listing command's reply");
2706 ret_code
= LTTNG_ERR_OVERFLOW
;
2710 /* Update command reply header. */
2711 reply_command_header
.count
= (uint32_t) nb_events
;
2712 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
,
2713 &reply_command_header
,
2714 sizeof(reply_command_header
));
2716 ret_code
= LTTNG_OK
;
2723 * Command LTTNG_START_TRACE processed by the client thread.
2725 * Called with session mutex held.
2727 int cmd_start_trace(struct ltt_session
*session
)
2729 enum lttng_error_code ret
;
2730 unsigned long nb_chan
= 0;
2731 struct ltt_kernel_session
*ksession
;
2732 struct ltt_ust_session
*usess
;
2733 const bool session_rotated_after_last_stop
= session
->rotated_after_last_stop
;
2734 const bool session_cleared_after_last_stop
= session
->cleared_after_last_stop
;
2736 LTTNG_ASSERT(session
);
2738 /* Ease our life a bit ;) */
2739 ksession
= session
->kernel_session
;
2740 usess
= session
->ust_session
;
2742 /* Is the session already started? */
2743 if (session
->active
) {
2744 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2745 /* Perform nothing */
2749 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2750 !session
->current_trace_chunk
) {
2752 * A rotation was launched while the session was stopped and
2753 * it has not been completed yet. It is not possible to start
2754 * the session since starting the session here would require a
2755 * rotation from "NULL" to a new trace chunk. That rotation
2756 * would overlap with the ongoing rotation, which is not
2759 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2761 ret
= LTTNG_ERR_ROTATION_PENDING
;
2766 * Starting a session without channel is useless since after that it's not
2767 * possible to enable channel thus inform the client.
2769 if (usess
&& usess
->domain_global
.channels
) {
2770 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2773 nb_chan
+= ksession
->channel_count
;
2776 ret
= LTTNG_ERR_NO_CHANNEL
;
2780 session
->active
= true;
2781 session
->rotated_after_last_stop
= false;
2782 session
->cleared_after_last_stop
= false;
2783 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2784 if (!session
->has_been_started
) {
2785 struct lttng_trace_chunk
*trace_chunk
;
2787 DBG("Creating initial trace chunk of session \"%s\"", session
->name
);
2789 session_create_new_trace_chunk(session
, nullptr, nullptr, nullptr);
2791 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2794 LTTNG_ASSERT(!session
->current_trace_chunk
);
2795 ret
= (lttng_error_code
) session_set_trace_chunk(
2796 session
, trace_chunk
, nullptr);
2797 lttng_trace_chunk_put(trace_chunk
);
2799 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2803 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2806 * Rotate existing streams into the new chunk.
2807 * This is a "quiet" rotation has no client has
2808 * explicitly requested this operation.
2810 * There is also no need to wait for the rotation
2811 * to complete as it will happen immediately. No data
2812 * was produced as the session was stopped, so the
2813 * rotation should happen on reception of the command.
2815 ret
= (lttng_error_code
) cmd_rotate_session(
2816 session
, nullptr, true, LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2817 if (ret
!= LTTNG_OK
) {
2823 /* Kernel tracing */
2824 if (ksession
!= nullptr) {
2825 DBG("Start kernel tracing session %s", session
->name
);
2826 ret
= (lttng_error_code
) start_kernel_session(ksession
);
2827 if (ret
!= LTTNG_OK
) {
2832 /* Flag session that trace should start automatically */
2834 int int_ret
= ust_app_start_trace_all(usess
);
2837 ret
= LTTNG_ERR_UST_START_FAIL
;
2843 * Open a packet in every stream of the session to ensure that viewers
2844 * can correctly identify the boundaries of the periods during which
2845 * tracing was active for this session.
2847 ret
= session_open_packets(session
);
2848 if (ret
!= LTTNG_OK
) {
2853 * Clear the flag that indicates that a rotation was done while the
2854 * session was stopped.
2856 session
->rotated_after_last_stop
= false;
2858 if (session
->rotate_timer_period
&& !session
->rotation_schedule_timer_enabled
) {
2859 int int_ret
= timer_session_rotation_schedule_timer_start(
2860 session
, session
->rotate_timer_period
);
2863 ERR("Failed to enable rotate timer");
2864 ret
= LTTNG_ERR_UNK
;
2872 if (ret
== LTTNG_OK
) {
2873 /* Flag this after a successful start. */
2874 session
->has_been_started
= true;
2876 session
->active
= false;
2877 /* Restore initial state on error. */
2878 session
->rotated_after_last_stop
= session_rotated_after_last_stop
;
2879 session
->cleared_after_last_stop
= session_cleared_after_last_stop
;
2886 * Command LTTNG_STOP_TRACE processed by the client thread.
2888 int cmd_stop_trace(struct ltt_session
*session
)
2891 struct ltt_kernel_session
*ksession
;
2892 struct ltt_ust_session
*usess
;
2894 LTTNG_ASSERT(session
);
2896 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2898 ksession
= session
->kernel_session
;
2899 usess
= session
->ust_session
;
2901 /* Session is not active. Skip everything and inform the client. */
2902 if (!session
->active
) {
2903 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2907 ret
= stop_kernel_session(ksession
);
2908 if (ret
!= LTTNG_OK
) {
2912 if (usess
&& usess
->active
) {
2913 ret
= ust_app_stop_trace_all(usess
);
2915 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2920 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2921 /* Flag inactive after a successful stop. */
2922 session
->active
= false;
2930 * Set the base_path of the session only if subdir of a control uris is set.
2931 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2934 set_session_base_path_from_uris(struct ltt_session
*session
, size_t nb_uri
, struct lttng_uri
*uris
)
2939 for (i
= 0; i
< nb_uri
; i
++) {
2940 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
|| uris
[i
].subdir
[0] == '\0') {
2941 /* Not interested in these URIs */
2945 if (session
->base_path
!= nullptr) {
2946 free(session
->base_path
);
2947 session
->base_path
= nullptr;
2950 /* Set session base_path */
2951 session
->base_path
= strdup(uris
[i
].subdir
);
2952 if (!session
->base_path
) {
2953 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2956 ret
= LTTNG_ERR_NOMEM
;
2959 DBG2("Setting base path \"%s\" for session \"%s\"",
2969 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2971 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
, struct lttng_uri
*uris
)
2974 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2975 struct ltt_ust_session
*usess
= session
->ust_session
;
2977 LTTNG_ASSERT(session
);
2979 LTTNG_ASSERT(nb_uri
> 0);
2981 /* Can't set consumer URI if the session is active. */
2982 if (session
->active
) {
2983 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2988 * Set the session base path if any. This is done inside
2989 * cmd_set_consumer_uri to preserve backward compatibility of the
2990 * previous session creation api vs the session descriptor api.
2992 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2993 if (ret
!= LTTNG_OK
) {
2997 /* Set the "global" consumer URIs */
2998 for (i
= 0; i
< nb_uri
; i
++) {
2999 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
], LTTNG_DOMAIN_NONE
);
3000 if (ret
!= LTTNG_OK
) {
3005 /* Set UST session URIs */
3006 if (session
->ust_session
) {
3007 for (i
= 0; i
< nb_uri
; i
++) {
3008 ret
= add_uri_to_consumer(session
,
3009 session
->ust_session
->consumer
,
3012 if (ret
!= LTTNG_OK
) {
3018 /* Set kernel session URIs */
3019 if (session
->kernel_session
) {
3020 for (i
= 0; i
< nb_uri
; i
++) {
3021 ret
= add_uri_to_consumer(session
,
3022 session
->kernel_session
->consumer
,
3024 LTTNG_DOMAIN_KERNEL
);
3025 if (ret
!= LTTNG_OK
) {
3032 * Make sure to set the session in output mode after we set URI since a
3033 * session can be created without URL (thus flagged in no output mode).
3035 session
->output_traces
= 1;
3037 ksess
->output_traces
= 1;
3041 usess
->output_traces
= 1;
3051 static enum lttng_error_code
3052 set_session_output_from_descriptor(struct ltt_session
*session
,
3053 const struct lttng_session_descriptor
*descriptor
)
3056 enum lttng_error_code ret_code
= LTTNG_OK
;
3057 enum lttng_session_descriptor_type session_type
=
3058 lttng_session_descriptor_get_type(descriptor
);
3059 enum lttng_session_descriptor_output_type output_type
=
3060 lttng_session_descriptor_get_output_type(descriptor
);
3061 struct lttng_uri uris
[2] = {};
3062 size_t uri_count
= 0;
3064 switch (output_type
) {
3065 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
3067 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
3068 lttng_session_descriptor_get_local_output_uri(descriptor
, &uris
[0]);
3071 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3072 lttng_session_descriptor_get_network_output_uris(descriptor
, &uris
[0], &uris
[1]);
3076 ret_code
= LTTNG_ERR_INVALID
;
3080 switch (session_type
) {
3081 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3083 struct snapshot_output
*new_output
= nullptr;
3085 new_output
= snapshot_output_alloc();
3087 ret_code
= LTTNG_ERR_NOMEM
;
3091 ret
= snapshot_output_init_with_uri(session
,
3092 DEFAULT_SNAPSHOT_MAX_SIZE
,
3098 &session
->snapshot
);
3100 ret_code
= (ret
== -ENOMEM
) ? LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3101 snapshot_output_destroy(new_output
);
3104 snapshot_add_output(&session
->snapshot
, new_output
);
3107 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3108 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3110 ret_code
= (lttng_error_code
) cmd_set_consumer_uri(session
, uri_count
, uris
);
3114 ret_code
= LTTNG_ERR_INVALID
;
3121 static enum lttng_error_code
3122 cmd_create_session_from_descriptor(struct lttng_session_descriptor
*descriptor
,
3123 const lttng_sock_cred
*creds
,
3124 const char *home_path
)
3127 enum lttng_error_code ret_code
;
3128 const char *session_name
;
3129 struct ltt_session
*new_session
= nullptr;
3130 enum lttng_session_descriptor_status descriptor_status
;
3132 session_lock_list();
3134 if (*home_path
!= '/') {
3135 ERR("Home path provided by client is not absolute");
3136 ret_code
= LTTNG_ERR_INVALID
;
3141 descriptor_status
= lttng_session_descriptor_get_session_name(descriptor
, &session_name
);
3142 switch (descriptor_status
) {
3143 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3145 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3146 session_name
= nullptr;
3149 ret_code
= LTTNG_ERR_INVALID
;
3153 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
, &new_session
);
3154 if (ret_code
!= LTTNG_OK
) {
3158 ret_code
= notification_thread_command_add_session(the_notification_thread_handle
,
3163 if (ret_code
!= LTTNG_OK
) {
3167 /* Announce the session's destruction to the notification thread when it is destroyed. */
3168 ret
= session_add_destroy_notifier(
3170 [](const struct ltt_session
*session
, void *user_data
__attribute__((unused
))) {
3171 (void) notification_thread_command_remove_session(
3172 the_notification_thread_handle
, session
->id
);
3176 PERROR("Failed to add notification thread command to session's destroy notifiers: session name = %s",
3178 ret
= LTTNG_ERR_NOMEM
;
3182 if (!session_name
) {
3183 ret
= lttng_session_descriptor_set_session_name(descriptor
, new_session
->name
);
3185 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3190 if (!lttng_session_descriptor_is_output_destination_initialized(descriptor
)) {
3192 * Only include the session's creation time in the output
3193 * destination if the name of the session itself was
3194 * not auto-generated.
3196 ret_code
= lttng_session_descriptor_set_default_output(
3198 session_name
? &new_session
->creation_time
: nullptr,
3200 if (ret_code
!= LTTNG_OK
) {
3204 new_session
->has_user_specified_directory
=
3205 lttng_session_descriptor_has_output_directory(descriptor
);
3208 switch (lttng_session_descriptor_get_type(descriptor
)) {
3209 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3210 new_session
->snapshot_mode
= 1;
3212 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3213 new_session
->live_timer
=
3214 lttng_session_descriptor_live_get_timer_interval(descriptor
);
3220 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3221 if (ret_code
!= LTTNG_OK
) {
3224 new_session
->consumer
->enabled
= true;
3225 ret_code
= LTTNG_OK
;
3227 /* Release reference provided by the session_create function. */
3228 session_put(new_session
);
3229 if (ret_code
!= LTTNG_OK
&& new_session
) {
3230 /* Release the global reference on error. */
3231 session_destroy(new_session
);
3233 session_unlock_list();
3237 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
,
3239 struct lttng_session_descriptor
**return_descriptor
)
3242 size_t payload_size
;
3243 struct lttng_dynamic_buffer payload
;
3244 struct lttng_buffer_view home_dir_view
;
3245 struct lttng_buffer_view session_descriptor_view
;
3246 struct lttng_session_descriptor
*session_descriptor
= nullptr;
3247 enum lttng_error_code ret_code
;
3249 lttng_dynamic_buffer_init(&payload
);
3250 if (cmd_ctx
->lsm
.u
.create_session
.home_dir_size
>= LTTNG_PATH_MAX
) {
3251 ret_code
= LTTNG_ERR_INVALID
;
3254 if (cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
>
3255 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3256 ret_code
= LTTNG_ERR_INVALID
;
3260 payload_size
= cmd_ctx
->lsm
.u
.create_session
.home_dir_size
+
3261 cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
;
3262 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3264 ret_code
= LTTNG_ERR_NOMEM
;
3268 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3270 ERR("Reception of session descriptor failed, aborting.");
3271 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3275 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3276 &payload
, 0, cmd_ctx
->lsm
.u
.create_session
.home_dir_size
);
3277 if (cmd_ctx
->lsm
.u
.create_session
.home_dir_size
> 0 &&
3278 !lttng_buffer_view_is_valid(&home_dir_view
)) {
3279 ERR("Invalid payload in \"create session\" command: buffer too short to contain home directory");
3280 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3284 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3286 cmd_ctx
->lsm
.u
.create_session
.home_dir_size
,
3287 cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
);
3288 if (!lttng_buffer_view_is_valid(&session_descriptor_view
)) {
3289 ERR("Invalid payload in \"create session\" command: buffer too short to contain session descriptor");
3290 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3294 ret
= lttng_session_descriptor_create_from_buffer(&session_descriptor_view
,
3295 &session_descriptor
);
3297 ERR("Failed to create session descriptor from payload of \"create session\" command");
3298 ret_code
= LTTNG_ERR_INVALID
;
3303 * Sets the descriptor's auto-generated properties (name, output) if
3306 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3308 home_dir_view
.size
? home_dir_view
.data
:
3310 if (ret_code
!= LTTNG_OK
) {
3314 ret_code
= LTTNG_OK
;
3315 *return_descriptor
= session_descriptor
;
3316 session_descriptor
= nullptr;
3318 lttng_dynamic_buffer_reset(&payload
);
3319 lttng_session_descriptor_destroy(session_descriptor
);
3323 static void cmd_destroy_session_reply(const struct ltt_session
*session
, void *_reply_context
)
3327 const struct cmd_destroy_session_reply_context
*reply_context
=
3328 (cmd_destroy_session_reply_context
*) _reply_context
;
3329 struct lttng_dynamic_buffer payload
;
3330 struct lttcomm_session_destroy_command_header cmd_header
;
3331 struct lttng_trace_archive_location
*location
= nullptr;
3332 struct lttcomm_lttng_msg llm
= {
3333 .cmd_type
= LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
,
3334 .ret_code
= reply_context
->destruction_status
,
3336 .cmd_header_size
= sizeof(struct lttcomm_session_destroy_command_header
),
3340 size_t payload_size_before_location
;
3342 lttng_dynamic_buffer_init(&payload
);
3344 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3346 ERR("Failed to append session destruction message");
3350 cmd_header
.rotation_state
= (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3351 session
->rotation_state
:
3352 LTTNG_ROTATION_STATE_NO_ROTATION
);
3353 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
, sizeof(cmd_header
));
3355 ERR("Failed to append session destruction command header");
3359 if (!reply_context
->implicit_rotation_on_destroy
) {
3360 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3364 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3365 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3370 location
= session_get_trace_archive_location(session
);
3372 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3377 payload_size_before_location
= payload
.size
;
3378 comm_ret
= lttng_trace_archive_location_serialize(location
, &payload
);
3379 lttng_trace_archive_location_put(location
);
3381 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3385 /* Update the message to indicate the location's length. */
3386 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3387 payload
.size
- payload_size_before_location
;
3389 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
, payload
.data
, payload
.size
);
3390 if (comm_ret
!= (ssize_t
) payload
.size
) {
3391 ERR("Failed to send result of the destruction of session \"%s\" to client",
3395 ret
= close(reply_context
->reply_sock_fd
);
3397 PERROR("Failed to close client socket in deferred session destroy reply");
3399 lttng_dynamic_buffer_reset(&payload
);
3400 free(_reply_context
);
3404 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3406 * Called with session lock held.
3408 int cmd_destroy_session(struct ltt_session
*session
, int *sock_fd
)
3411 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3412 struct cmd_destroy_session_reply_context
*reply_context
= nullptr;
3415 reply_context
= zmalloc
<cmd_destroy_session_reply_context
>();
3416 if (!reply_context
) {
3417 ret
= LTTNG_ERR_NOMEM
;
3421 reply_context
->reply_sock_fd
= *sock_fd
;
3425 LTTNG_ASSERT(session
);
3427 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
, session
->id
);
3428 if (session
->active
) {
3429 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3431 ret
= cmd_stop_trace(session
);
3432 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3433 /* Carry on with the destruction of the session. */
3434 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3436 lttng_strerror(-ret
));
3437 destruction_last_error
= (lttng_error_code
) ret
;
3441 if (session
->rotation_schedule_timer_enabled
) {
3442 if (timer_session_rotation_schedule_timer_stop(session
)) {
3443 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3445 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3449 if (session
->rotate_size
) {
3451 the_rotation_thread_handle
->unsubscribe_session_consumed_size_rotation(
3453 } catch (const std::exception
& e
) {
3454 /* Continue the destruction of the session anyway. */
3455 ERR("Failed to unsubscribe rotation thread notification channel from consumed size condition during session destruction: %s",
3459 session
->rotate_size
= 0;
3462 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3464 * Perform a last rotation on destruction if rotations have
3465 * occurred during the session's lifetime.
3467 ret
= cmd_rotate_session(
3468 session
, nullptr, false, LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3469 if (ret
!= LTTNG_OK
) {
3470 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3472 lttng_strerror(-ret
));
3473 destruction_last_error
= (lttng_error_code
) -ret
;
3475 if (reply_context
) {
3476 reply_context
->implicit_rotation_on_destroy
= true;
3478 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3480 * The user has not triggered a session rotation. However, to
3481 * ensure all data has been consumed, the session is rotated
3482 * to a 'null' trace chunk before it is destroyed.
3484 * This is a "quiet" rotation meaning that no notification is
3485 * emitted and no renaming of the current trace chunk takes
3488 ret
= cmd_rotate_session(
3489 session
, nullptr, true, LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3491 * Rotation operations may not be supported by the kernel
3492 * tracer. Hence, do not consider this implicit rotation as
3493 * a session destruction error. The library has already stopped
3494 * the session and waited for pending data; there is nothing
3495 * left to do but complete the destruction of the session.
3497 if (ret
!= LTTNG_OK
&& ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3498 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3500 lttng_strerror(ret
));
3501 destruction_last_error
= (lttng_error_code
) -ret
;
3505 if (session
->shm_path
[0]) {
3507 * When a session is created with an explicit shm_path,
3508 * the consumer daemon will create its shared memory files
3509 * at that location and will *not* unlink them. This is normal
3510 * as the intention of that feature is to make it possible
3511 * to retrieve the content of those files should a crash occur.
3513 * To ensure the content of those files can be used, the
3514 * sessiond daemon will replicate the content of the metadata
3515 * cache in a metadata file.
3517 * On clean-up, it is expected that the consumer daemon will
3518 * unlink the shared memory files and that the session daemon
3519 * will unlink the metadata file. Then, the session's directory
3520 * in the shm path can be removed.
3522 * Unfortunately, a flaw in the design of the sessiond's and
3523 * consumerd's tear down of channels makes it impossible to
3524 * determine when the sessiond _and_ the consumerd have both
3525 * destroyed their representation of a channel. For one, the
3526 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3527 * callbacks in both daemons.
3529 * However, it is also impossible for the sessiond to know when
3530 * the consumer daemon is done destroying its channel(s) since
3531 * it occurs as a reaction to the closing of the channel's file
3532 * descriptor. There is no resulting communication initiated
3533 * from the consumerd to the sessiond to confirm that the
3534 * operation is completed (and was successful).
3536 * Until this is all fixed, the session daemon checks for the
3537 * removal of the session's shm path which makes it possible
3538 * to safely advertise a session as having been destroyed.
3540 * Prior to this fix, it was not possible to reliably save
3541 * a session making use of the --shm-path option, destroy it,
3542 * and load it again. This is because the creation of the
3543 * session would fail upon seeing the session's shm path
3544 * already in existence.
3546 * Note that none of the error paths in the check for the
3547 * directory's existence return an error. This is normal
3548 * as there isn't much that can be done. The session will
3549 * be destroyed properly, except that we can't offer the
3550 * guarantee that the same session can be re-created.
3552 current_completion_handler
= &destroy_completion_handler
.handler
;
3553 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3555 sizeof(destroy_completion_handler
.shm_path
));
3560 * The session is destroyed. However, note that the command context
3561 * still holds a reference to the session, thus delaying its destruction
3562 * _at least_ up to the point when that reference is released.
3564 session_destroy(session
);
3565 if (reply_context
) {
3566 reply_context
->destruction_status
= destruction_last_error
;
3567 ret
= session_add_destroy_notifier(
3568 session
, cmd_destroy_session_reply
, (void *) reply_context
);
3570 ret
= LTTNG_ERR_FATAL
;
3582 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3584 int cmd_register_consumer(struct ltt_session
*session
,
3585 enum lttng_domain_type domain
,
3586 const char *sock_path
,
3587 struct consumer_data
*cdata
)
3590 struct consumer_socket
*socket
= nullptr;
3592 LTTNG_ASSERT(session
);
3593 LTTNG_ASSERT(cdata
);
3594 LTTNG_ASSERT(sock_path
);
3597 case LTTNG_DOMAIN_KERNEL
:
3599 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3601 LTTNG_ASSERT(ksess
);
3603 /* Can't register a consumer if there is already one */
3604 if (ksess
->consumer_fds_sent
!= 0) {
3605 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3609 sock
= lttcomm_connect_unix_sock(sock_path
);
3611 ret
= LTTNG_ERR_CONNECT_FAIL
;
3614 cdata
->cmd_sock
= sock
;
3616 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3617 if (socket
== nullptr) {
3620 PERROR("close register consumer");
3622 cdata
->cmd_sock
= -1;
3623 ret
= LTTNG_ERR_FATAL
;
3627 socket
->lock
= zmalloc
<pthread_mutex_t
>();
3628 if (socket
->lock
== nullptr) {
3629 PERROR("zmalloc pthread mutex");
3630 ret
= LTTNG_ERR_FATAL
;
3634 pthread_mutex_init(socket
->lock
, nullptr);
3635 socket
->registered
= 1;
3637 lttng::urcu::read_lock_guard read_lock
;
3638 consumer_add_socket(socket
, ksess
->consumer
);
3640 pthread_mutex_lock(&cdata
->pid_mutex
);
3642 pthread_mutex_unlock(&cdata
->pid_mutex
);
3647 /* TODO: Userspace tracing */
3648 ret
= LTTNG_ERR_UND
;
3656 consumer_destroy_socket(socket
);
3662 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3664 ssize_t
cmd_list_domains(struct ltt_session
*session
, struct lttng_domain
**domains
)
3669 struct lttng_ht_iter iter
;
3671 if (session
->kernel_session
!= nullptr) {
3672 DBG3("Listing domains found kernel domain");
3676 if (session
->ust_session
!= nullptr) {
3677 DBG3("Listing domains found UST global domain");
3680 lttng::urcu::read_lock_guard read_lock
;
3682 cds_lfht_for_each_entry (
3683 session
->ust_session
->agents
->ht
, &iter
.iter
, agt
, node
.node
) {
3684 if (agt
->being_used
) {
3694 *domains
= calloc
<lttng_domain
>(nb_dom
);
3695 if (*domains
== nullptr) {
3696 ret
= LTTNG_ERR_FATAL
;
3700 if (session
->kernel_session
!= nullptr) {
3701 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3703 /* Kernel session buffer type is always GLOBAL */
3704 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3709 if (session
->ust_session
!= nullptr) {
3710 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3711 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3715 lttng::urcu::read_lock_guard read_lock
;
3717 cds_lfht_for_each_entry (
3718 session
->ust_session
->agents
->ht
, &iter
.iter
, agt
, node
.node
) {
3719 if (agt
->being_used
) {
3720 (*domains
)[index
].type
= agt
->domain
;
3721 (*domains
)[index
].buf_type
=
3722 session
->ust_session
->buffer_type
;
3732 /* Return negative value to differentiate return code */
3737 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3739 enum lttng_error_code
cmd_list_channels(enum lttng_domain_type domain
,
3740 struct ltt_session
*session
,
3741 struct lttng_payload
*payload
)
3745 struct lttcomm_list_command_header cmd_header
= {};
3746 size_t cmd_header_offset
;
3747 enum lttng_error_code ret_code
;
3752 DBG("Listing channels for session %s", session
->name
);
3754 cmd_header_offset
= payload
->buffer
.size
;
3756 /* Reserve space for command reply header. */
3757 ret
= lttng_dynamic_buffer_set_size(&payload
->buffer
,
3758 cmd_header_offset
+ sizeof(cmd_header
));
3760 ret_code
= LTTNG_ERR_NOMEM
;
3765 case LTTNG_DOMAIN_KERNEL
:
3767 /* Kernel channels */
3768 struct ltt_kernel_channel
*kchan
;
3769 if (session
->kernel_session
!= nullptr) {
3770 cds_list_for_each_entry (
3771 kchan
, &session
->kernel_session
->channel_list
.head
, list
) {
3772 uint64_t discarded_events
, lost_packets
;
3773 struct lttng_channel_extended
*extended
;
3775 extended
= (struct lttng_channel_extended
*)
3776 kchan
->channel
->attr
.extended
.ptr
;
3778 ret
= get_kernel_runtime_stats(
3779 session
, kchan
, &discarded_events
, &lost_packets
);
3781 ret_code
= LTTNG_ERR_UNK
;
3786 * Update the discarded_events and lost_packets
3787 * count for the channel
3789 extended
->discarded_events
= discarded_events
;
3790 extended
->lost_packets
= lost_packets
;
3792 ret
= lttng_channel_serialize(kchan
->channel
, &payload
->buffer
);
3794 ERR("Failed to serialize lttng_channel: channel name = '%s'",
3795 kchan
->channel
->name
);
3796 ret_code
= LTTNG_ERR_UNK
;
3805 case LTTNG_DOMAIN_UST
:
3807 struct lttng_ht_iter iter
;
3808 struct ltt_ust_channel
*uchan
;
3811 lttng::urcu::read_lock_guard read_lock
;
3813 cds_lfht_for_each_entry (session
->ust_session
->domain_global
.channels
->ht
,
3817 uint64_t discarded_events
= 0, lost_packets
= 0;
3818 struct lttng_channel
*channel
= nullptr;
3819 struct lttng_channel_extended
*extended
;
3821 channel
= trace_ust_channel_to_lttng_channel(uchan
);
3823 ret_code
= LTTNG_ERR_NOMEM
;
3827 extended
= (struct lttng_channel_extended
*)
3828 channel
->attr
.extended
.ptr
;
3830 ret
= get_ust_runtime_stats(
3831 session
, uchan
, &discarded_events
, &lost_packets
);
3833 lttng_channel_destroy(channel
);
3834 ret_code
= LTTNG_ERR_UNK
;
3838 extended
->discarded_events
= discarded_events
;
3839 extended
->lost_packets
= lost_packets
;
3841 ret
= lttng_channel_serialize(channel
, &payload
->buffer
);
3843 ERR("Failed to serialize lttng_channel: channel name = '%s'",
3845 lttng_channel_destroy(channel
);
3846 ret_code
= LTTNG_ERR_UNK
;
3850 lttng_channel_destroy(channel
);
3861 if (i
> UINT32_MAX
) {
3862 ERR("Channel count would overflow the channel listing command's reply");
3863 ret_code
= LTTNG_ERR_OVERFLOW
;
3867 /* Update command reply header. */
3868 cmd_header
.count
= (uint32_t) i
;
3869 memcpy(payload
->buffer
.data
+ cmd_header_offset
, &cmd_header
, sizeof(cmd_header
));
3870 ret_code
= LTTNG_OK
;
3877 * Command LTTNG_LIST_EVENTS processed by the client thread.
3879 enum lttng_error_code
cmd_list_events(enum lttng_domain_type domain
,
3880 struct ltt_session
*session
,
3882 struct lttng_payload
*reply_payload
)
3884 int buffer_resize_ret
;
3885 enum lttng_error_code ret_code
= LTTNG_OK
;
3886 struct lttcomm_list_command_header reply_command_header
= {};
3887 size_t reply_command_header_offset
;
3888 unsigned int nb_events
= 0;
3890 assert(reply_payload
);
3892 /* Reserve space for command reply header. */
3893 reply_command_header_offset
= reply_payload
->buffer
.size
;
3894 buffer_resize_ret
= lttng_dynamic_buffer_set_size(
3895 &reply_payload
->buffer
,
3896 reply_command_header_offset
+ sizeof(struct lttcomm_list_command_header
));
3897 if (buffer_resize_ret
) {
3898 ret_code
= LTTNG_ERR_NOMEM
;
3903 case LTTNG_DOMAIN_KERNEL
:
3904 if (session
->kernel_session
!= nullptr) {
3905 ret_code
= list_lttng_kernel_events(
3906 channel_name
, session
->kernel_session
, reply_payload
, &nb_events
);
3910 case LTTNG_DOMAIN_UST
:
3912 if (session
->ust_session
!= nullptr) {
3914 list_lttng_ust_global_events(channel_name
,
3915 &session
->ust_session
->domain_global
,
3922 case LTTNG_DOMAIN_LOG4J
:
3923 case LTTNG_DOMAIN_JUL
:
3924 case LTTNG_DOMAIN_PYTHON
:
3925 if (session
->ust_session
) {
3926 struct lttng_ht_iter iter
;
3929 lttng::urcu::read_lock_guard read_lock
;
3931 cds_lfht_for_each_entry (
3932 session
->ust_session
->agents
->ht
, &iter
.iter
, agt
, node
.node
) {
3933 if (agt
->domain
== domain
) {
3934 ret_code
= list_lttng_agent_events(
3935 agt
, reply_payload
, &nb_events
);
3942 ret_code
= LTTNG_ERR_UND
;
3946 if (nb_events
> UINT32_MAX
) {
3947 ret_code
= LTTNG_ERR_OVERFLOW
;
3951 /* Update command reply header. */
3952 reply_command_header
.count
= (uint32_t) nb_events
;
3953 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
,
3954 &reply_command_header
,
3955 sizeof(reply_command_header
));
3962 * Using the session list, filled a lttng_session array to send back to the
3963 * client for session listing.
3965 * The session list lock MUST be acquired before calling this function. Use
3966 * session_lock_list() and session_unlock_list().
3968 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3969 size_t session_count
,
3975 struct ltt_session
*session
;
3976 struct ltt_session_list
*list
= session_get_list();
3977 struct lttng_session_extended
*extended
= (typeof(extended
)) (&sessions
[session_count
]);
3979 DBG("Getting all available session for UID %d GID %d", uid
, gid
);
3981 * Iterate over session list and append data after the control struct in
3984 cds_list_for_each_entry (session
, &list
->head
, list
) {
3985 if (!session_get(session
)) {
3989 * Only list the sessions the user can control.
3991 if (!session_access_ok(session
, uid
) || session
->destroyed
) {
3992 session_put(session
);
3996 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3997 struct ltt_ust_session
*usess
= session
->ust_session
;
3999 if (session
->consumer
->type
== CONSUMER_DST_NET
||
4000 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
4001 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
4002 ret
= build_network_session_path(
4003 sessions
[i
].path
, sizeof(sessions
[i
].path
), session
);
4005 ret
= snprintf(sessions
[i
].path
,
4006 sizeof(sessions
[i
].path
),
4008 session
->consumer
->dst
.session_root_path
);
4011 PERROR("snprintf session path");
4012 session_put(session
);
4016 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
4017 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
4018 sessions
[i
].enabled
= session
->active
;
4019 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
4020 sessions
[i
].live_timer_interval
= session
->live_timer
;
4021 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
4022 extended
[i
].creation_time
.is_set
= 1;
4024 session_put(session
);
4029 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
4030 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
4032 int cmd_data_pending(struct ltt_session
*session
)
4035 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4036 struct ltt_ust_session
*usess
= session
->ust_session
;
4038 LTTNG_ASSERT(session
);
4040 DBG("Data pending for session %s", session
->name
);
4042 /* Session MUST be stopped to ask for data availability. */
4043 if (session
->active
) {
4044 ret
= LTTNG_ERR_SESSION_STARTED
;
4048 * If stopped, just make sure we've started before else the above call
4049 * will always send that there is data pending.
4051 * The consumer assumes that when the data pending command is received,
4052 * the trace has been started before or else no output data is written
4053 * by the streams which is a condition for data pending. So, this is
4054 * *VERY* important that we don't ask the consumer before a start
4057 if (!session
->has_been_started
) {
4063 /* A rotation is still pending, we have to wait. */
4064 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4065 DBG("Rotate still pending for session %s", session
->name
);
4070 if (ksess
&& ksess
->consumer
) {
4071 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
4073 /* Data is still being extracted for the kernel. */
4078 if (usess
&& usess
->consumer
) {
4079 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
4081 /* Data is still being extracted for the kernel. */
4086 /* Data is ready to be read by a viewer */
4094 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
4096 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4098 int cmd_snapshot_add_output(struct ltt_session
*session
,
4099 const struct lttng_snapshot_output
*output
,
4103 struct snapshot_output
*new_output
;
4105 LTTNG_ASSERT(session
);
4106 LTTNG_ASSERT(output
);
4108 DBG("Cmd snapshot add output for session %s", session
->name
);
4111 * Can't create an output if the session is not set in no-output mode.
4113 if (session
->output_traces
) {
4114 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4118 if (session
->has_non_mmap_channel
) {
4119 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
4123 /* Only one output is allowed until we have the "tee" feature. */
4124 if (session
->snapshot
.nb_output
== 1) {
4125 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
4129 new_output
= snapshot_output_alloc();
4131 ret
= LTTNG_ERR_NOMEM
;
4135 ret
= snapshot_output_init(session
,
4142 &session
->snapshot
);
4144 if (ret
== -ENOMEM
) {
4145 ret
= LTTNG_ERR_NOMEM
;
4147 ret
= LTTNG_ERR_INVALID
;
4152 snapshot_add_output(&session
->snapshot
, new_output
);
4154 *id
= new_output
->id
;
4160 snapshot_output_destroy(new_output
);
4166 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
4168 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4170 int cmd_snapshot_del_output(struct ltt_session
*session
, const struct lttng_snapshot_output
*output
)
4173 struct snapshot_output
*sout
= nullptr;
4175 LTTNG_ASSERT(session
);
4176 LTTNG_ASSERT(output
);
4178 lttng::urcu::read_lock_guard read_lock
;
4181 * Permission denied to create an output if the session is not
4182 * set in no output mode.
4184 if (session
->output_traces
) {
4185 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4190 DBG("Cmd snapshot del output id %" PRIu32
" for session %s",
4193 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4194 } else if (*output
->name
!= '\0') {
4195 DBG("Cmd snapshot del output name %s for session %s", output
->name
, session
->name
);
4196 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4199 ret
= LTTNG_ERR_INVALID
;
4203 snapshot_delete_output(&session
->snapshot
, sout
);
4204 snapshot_output_destroy(sout
);
4212 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4214 * If no output is available, outputs is untouched and 0 is returned.
4216 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4218 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4219 struct lttng_snapshot_output
**outputs
)
4222 struct lttng_snapshot_output
*list
= nullptr;
4223 struct lttng_ht_iter iter
;
4224 struct snapshot_output
*output
;
4226 LTTNG_ASSERT(session
);
4227 LTTNG_ASSERT(outputs
);
4229 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4232 * Permission denied to create an output if the session is not
4233 * set in no output mode.
4235 if (session
->output_traces
) {
4236 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4240 if (session
->snapshot
.nb_output
== 0) {
4245 list
= calloc
<lttng_snapshot_output
>(session
->snapshot
.nb_output
);
4247 ret
= -LTTNG_ERR_NOMEM
;
4251 /* Copy list from session to the new list object. */
4253 lttng::urcu::read_lock_guard read_lock
;
4255 cds_lfht_for_each_entry (
4256 session
->snapshot
.output_ht
->ht
, &iter
.iter
, output
, node
.node
) {
4257 LTTNG_ASSERT(output
->consumer
);
4258 list
[idx
].id
= output
->id
;
4259 list
[idx
].max_size
= output
->max_size
;
4260 if (lttng_strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
))) {
4261 ret
= -LTTNG_ERR_INVALID
;
4265 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4266 if (lttng_strncpy(list
[idx
].ctrl_url
,
4267 output
->consumer
->dst
.session_root_path
,
4268 sizeof(list
[idx
].ctrl_url
))) {
4269 ret
= -LTTNG_ERR_INVALID
;
4274 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4276 sizeof(list
[idx
].ctrl_url
));
4278 ret
= -LTTNG_ERR_NOMEM
;
4283 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4285 sizeof(list
[idx
].data_url
));
4287 ret
= -LTTNG_ERR_NOMEM
;
4298 ret
= session
->snapshot
.nb_output
;
4306 * Check if we can regenerate the metadata for this session.
4307 * Only kernel, UST per-uid and non-live sessions are supported.
4309 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4311 static int check_regenerate_metadata_support(struct ltt_session
*session
)
4315 LTTNG_ASSERT(session
);
4317 if (session
->live_timer
!= 0) {
4318 ret
= LTTNG_ERR_LIVE_SESSION
;
4321 if (!session
->active
) {
4322 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4325 if (session
->ust_session
) {
4326 switch (session
->ust_session
->buffer_type
) {
4327 case LTTNG_BUFFER_PER_UID
:
4329 case LTTNG_BUFFER_PER_PID
:
4330 ret
= LTTNG_ERR_PER_PID_SESSION
;
4334 ret
= LTTNG_ERR_UNK
;
4338 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4339 session
->consumer
->relay_minor_version
< 8) {
4340 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4350 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4352 * Ask the consumer to truncate the existing metadata file(s) and
4353 * then regenerate the metadata. Live and per-pid sessions are not
4354 * supported and return an error.
4356 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4358 int cmd_regenerate_metadata(struct ltt_session
*session
)
4362 LTTNG_ASSERT(session
);
4364 ret
= check_regenerate_metadata_support(session
);
4369 if (session
->kernel_session
) {
4370 ret
= kernctl_session_regenerate_metadata(session
->kernel_session
->fd
);
4372 ERR("Failed to regenerate the kernel metadata");
4377 if (session
->ust_session
) {
4378 ret
= trace_ust_regenerate_metadata(session
->ust_session
);
4380 ERR("Failed to regenerate the UST metadata");
4384 DBG("Cmd metadata regenerate for session %s", session
->name
);
4392 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4394 * Ask the tracer to regenerate a new statedump.
4396 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4398 int cmd_regenerate_statedump(struct ltt_session
*session
)
4402 LTTNG_ASSERT(session
);
4404 if (!session
->active
) {
4405 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4409 if (session
->kernel_session
) {
4410 ret
= kernctl_session_regenerate_statedump(session
->kernel_session
->fd
);
4412 * Currently, the statedump in kernel can only fail if out
4416 if (ret
== -ENOMEM
) {
4417 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4419 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4421 ERR("Failed to regenerate the kernel statedump");
4426 if (session
->ust_session
) {
4427 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4429 * Currently, the statedump in UST always returns 0.
4432 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4433 ERR("Failed to regenerate the UST statedump");
4437 DBG("Cmd regenerate statedump for session %s", session
->name
);
4444 static enum lttng_error_code
4445 synchronize_tracer_notifier_register(struct notification_thread_handle
*notification_thread
,
4446 struct lttng_trigger
*trigger
,
4447 const struct lttng_credentials
*cmd_creds
)
4449 enum lttng_error_code ret_code
;
4450 const struct lttng_condition
*condition
= lttng_trigger_get_const_condition(trigger
);
4451 const char *trigger_name
;
4452 uid_t trigger_owner
;
4453 enum lttng_trigger_status trigger_status
;
4454 const enum lttng_domain_type trigger_domain
=
4455 lttng_trigger_get_underlying_domain_type_restriction(trigger
);
4457 trigger_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner
);
4458 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4460 LTTNG_ASSERT(condition
);
4461 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
4462 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
4464 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4465 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
? trigger_name
: "(anonymous)";
4467 session_lock_list();
4468 switch (trigger_domain
) {
4469 case LTTNG_DOMAIN_KERNEL
:
4471 ret_code
= kernel_register_event_notifier(trigger
, cmd_creds
);
4472 if (ret_code
!= LTTNG_OK
) {
4473 enum lttng_error_code notif_thread_unregister_ret
;
4475 notif_thread_unregister_ret
=
4476 notification_thread_command_unregister_trigger(notification_thread
,
4479 if (notif_thread_unregister_ret
!= LTTNG_OK
) {
4480 /* Return the original error code. */
4481 ERR("Failed to unregister trigger from notification thread during error recovery: trigger name = '%s', trigger owner uid = %d, error code = %d",
4483 (int) trigger_owner
,
4487 goto end_unlock_session_list
;
4491 case LTTNG_DOMAIN_UST
:
4492 ust_app_global_update_all_event_notifier_rules();
4494 case LTTNG_DOMAIN_JUL
:
4495 case LTTNG_DOMAIN_LOG4J
:
4496 case LTTNG_DOMAIN_PYTHON
:
4498 /* Agent domains. */
4499 struct agent
*agt
= agent_find_by_event_notifier_domain(trigger_domain
);
4502 agt
= agent_create(trigger_domain
);
4504 ret_code
= LTTNG_ERR_NOMEM
;
4505 goto end_unlock_session_list
;
4508 agent_add(agt
, the_trigger_agents_ht_by_domain
);
4511 ret_code
= (lttng_error_code
) trigger_agent_enable(trigger
, agt
);
4512 if (ret_code
!= LTTNG_OK
) {
4513 goto end_unlock_session_list
;
4518 case LTTNG_DOMAIN_NONE
:
4523 ret_code
= LTTNG_OK
;
4524 end_unlock_session_list
:
4525 session_unlock_list();
4529 enum lttng_error_code
cmd_register_trigger(const struct lttng_credentials
*cmd_creds
,
4530 struct lttng_trigger
*trigger
,
4531 bool is_trigger_anonymous
,
4532 struct notification_thread_handle
*notification_thread
,
4533 struct lttng_trigger
**return_trigger
)
4535 enum lttng_error_code ret_code
;
4536 const char *trigger_name
;
4537 uid_t trigger_owner
;
4538 enum lttng_trigger_status trigger_status
;
4540 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4541 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
? trigger_name
: "(anonymous)";
4543 trigger_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner
);
4544 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4546 DBG("Running register trigger command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4548 (int) trigger_owner
,
4549 (int) lttng_credentials_get_uid(cmd_creds
));
4552 * Validate the trigger credentials against the command credentials.
4553 * Only the root user can register a trigger with non-matching
4556 if (!lttng_credentials_is_equal_uid(lttng_trigger_get_credentials(trigger
), cmd_creds
)) {
4557 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4558 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4560 (int) trigger_owner
,
4561 (int) lttng_credentials_get_uid(cmd_creds
));
4562 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4568 * The bytecode generation also serves as a validation step for the
4569 * bytecode expressions.
4571 ret_code
= lttng_trigger_generate_bytecode(trigger
, cmd_creds
);
4572 if (ret_code
!= LTTNG_OK
) {
4573 ERR("Failed to generate bytecode of trigger: trigger name = '%s', trigger owner uid = %d, error code = %d",
4575 (int) trigger_owner
,
4581 * A reference to the trigger is acquired by the notification thread.
4582 * It is safe to return the same trigger to the caller since it the
4583 * other user holds a reference.
4585 * The trigger is modified during the execution of the
4586 * "register trigger" command. However, by the time the command returns,
4587 * it is safe to use without any locking as its properties are
4590 ret_code
= notification_thread_command_register_trigger(
4591 notification_thread
, trigger
, is_trigger_anonymous
);
4592 if (ret_code
!= LTTNG_OK
) {
4593 DBG("Failed to register trigger to notification thread: trigger name = '%s', trigger owner uid = %d, error code = %d",
4595 (int) trigger_owner
,
4600 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4601 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
? trigger_name
: "(anonymous)";
4604 * Synchronize tracers if the trigger adds an event notifier.
4606 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
4607 ret_code
= synchronize_tracer_notifier_register(
4608 notification_thread
, trigger
, cmd_creds
);
4609 if (ret_code
!= LTTNG_OK
) {
4610 ERR("Error registering tracer notifier: %s", lttng_strerror(-ret_code
));
4616 * Return an updated trigger to the client.
4618 * Since a modified version of the same trigger is returned, acquire a
4619 * reference to the trigger so the caller doesn't have to care if those
4620 * are distinct instances or not.
4622 if (ret_code
== LTTNG_OK
) {
4623 lttng_trigger_get(trigger
);
4624 *return_trigger
= trigger
;
4625 /* Ownership of trigger was transferred to caller. */
4632 static enum lttng_error_code
4633 synchronize_tracer_notifier_unregister(const struct lttng_trigger
*trigger
)
4635 enum lttng_error_code ret_code
;
4636 const struct lttng_condition
*condition
= lttng_trigger_get_const_condition(trigger
);
4637 const enum lttng_domain_type trigger_domain
=
4638 lttng_trigger_get_underlying_domain_type_restriction(trigger
);
4640 LTTNG_ASSERT(condition
);
4641 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
4642 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
4644 session_lock_list();
4645 switch (trigger_domain
) {
4646 case LTTNG_DOMAIN_KERNEL
:
4647 ret_code
= kernel_unregister_event_notifier(trigger
);
4648 if (ret_code
!= LTTNG_OK
) {
4649 goto end_unlock_session_list
;
4653 case LTTNG_DOMAIN_UST
:
4654 ust_app_global_update_all_event_notifier_rules();
4656 case LTTNG_DOMAIN_JUL
:
4657 case LTTNG_DOMAIN_LOG4J
:
4658 case LTTNG_DOMAIN_PYTHON
:
4660 /* Agent domains. */
4661 struct agent
*agt
= agent_find_by_event_notifier_domain(trigger_domain
);
4664 * This trigger was never registered in the first place. Calling
4665 * this function under those circumstances is an internal error.
4668 ret_code
= (lttng_error_code
) trigger_agent_disable(trigger
, agt
);
4669 if (ret_code
!= LTTNG_OK
) {
4670 goto end_unlock_session_list
;
4675 case LTTNG_DOMAIN_NONE
:
4680 ret_code
= LTTNG_OK
;
4682 end_unlock_session_list
:
4683 session_unlock_list();
4687 enum lttng_error_code
cmd_unregister_trigger(const struct lttng_credentials
*cmd_creds
,
4688 const struct lttng_trigger
*trigger
,
4689 struct notification_thread_handle
*notification_thread
)
4691 enum lttng_error_code ret_code
;
4692 const char *trigger_name
;
4693 uid_t trigger_owner
;
4694 enum lttng_trigger_status trigger_status
;
4695 struct lttng_trigger
*sessiond_trigger
= nullptr;
4697 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4698 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
? trigger_name
: "(anonymous)";
4699 trigger_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner
);
4700 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4702 DBG("Running unregister trigger command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4704 (int) trigger_owner
,
4705 (int) lttng_credentials_get_uid(cmd_creds
));
4708 * Validate the trigger credentials against the command credentials.
4709 * Only the root user can unregister a trigger with non-matching
4712 if (!lttng_credentials_is_equal_uid(lttng_trigger_get_credentials(trigger
), cmd_creds
)) {
4713 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4714 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4716 (int) trigger_owner
,
4717 (int) lttng_credentials_get_uid(cmd_creds
));
4718 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4723 /* Fetch the sessiond side trigger object. */
4724 ret_code
= notification_thread_command_get_trigger(
4725 notification_thread
, trigger
, &sessiond_trigger
);
4726 if (ret_code
!= LTTNG_OK
) {
4727 DBG("Failed to get trigger from notification thread during unregister: trigger name = '%s', trigger owner uid = %d, error code = %d",
4729 (int) trigger_owner
,
4734 LTTNG_ASSERT(sessiond_trigger
);
4737 * From this point on, no matter what, consider the trigger
4740 * We set the unregistered state of the sessiond side trigger object in
4741 * the client thread since we want to minimize the possibility of the
4742 * notification thread being stalled due to a long execution of an
4743 * action that required the trigger lock.
4745 lttng_trigger_set_as_unregistered(sessiond_trigger
);
4747 ret_code
= notification_thread_command_unregister_trigger(notification_thread
, trigger
);
4748 if (ret_code
!= LTTNG_OK
) {
4749 DBG("Failed to unregister trigger from notification thread: trigger name = '%s', trigger owner uid = %d, error code = %d",
4751 (int) trigger_owner
,
4757 * Synchronize tracers if the trigger removes an event notifier.
4758 * Do this even if the trigger unregistration failed to at least stop
4759 * the tracers from producing notifications associated with this
4762 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
4763 ret_code
= synchronize_tracer_notifier_unregister(trigger
);
4764 if (ret_code
!= LTTNG_OK
) {
4765 ERR("Error unregistering trigger to tracer.");
4771 lttng_trigger_put(sessiond_trigger
);
4775 enum lttng_error_code
cmd_list_triggers(struct command_ctx
*cmd_ctx
,
4776 struct notification_thread_handle
*notification_thread
,
4777 struct lttng_triggers
**return_triggers
)
4780 enum lttng_error_code ret_code
;
4781 struct lttng_triggers
*triggers
= nullptr;
4783 /* Get the set of triggers from the notification thread. */
4784 ret_code
= notification_thread_command_list_triggers(
4785 notification_thread
, cmd_ctx
->creds
.uid
, &triggers
);
4786 if (ret_code
!= LTTNG_OK
) {
4790 ret
= lttng_triggers_remove_hidden_triggers(triggers
);
4792 ret_code
= LTTNG_ERR_UNK
;
4796 *return_triggers
= triggers
;
4798 ret_code
= LTTNG_OK
;
4800 lttng_triggers_destroy(triggers
);
4804 enum lttng_error_code
4805 cmd_execute_error_query(const struct lttng_credentials
*cmd_creds
,
4806 const struct lttng_error_query
*query
,
4807 struct lttng_error_query_results
**_results
,
4808 struct notification_thread_handle
*notification_thread
)
4810 enum lttng_error_code ret_code
;
4811 const struct lttng_trigger
*query_target_trigger
;
4812 const struct lttng_action
*query_target_action
= nullptr;
4813 struct lttng_trigger
*matching_trigger
= nullptr;
4814 const char *trigger_name
;
4815 uid_t trigger_owner
;
4816 enum lttng_trigger_status trigger_status
;
4817 struct lttng_error_query_results
*results
= nullptr;
4819 switch (lttng_error_query_get_target_type(query
)) {
4820 case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER
:
4821 query_target_trigger
= lttng_error_query_trigger_borrow_target(query
);
4823 case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION
:
4824 query_target_trigger
= lttng_error_query_condition_borrow_target(query
);
4826 case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
:
4827 query_target_trigger
= lttng_error_query_action_borrow_trigger_target(query
);
4833 LTTNG_ASSERT(query_target_trigger
);
4835 ret_code
= notification_thread_command_get_trigger(
4836 notification_thread
, query_target_trigger
, &matching_trigger
);
4837 if (ret_code
!= LTTNG_OK
) {
4841 /* No longer needed. */
4842 query_target_trigger
= nullptr;
4844 if (lttng_error_query_get_target_type(query
) == LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
) {
4845 /* Get the sessiond-side version of the target action. */
4846 query_target_action
=
4847 lttng_error_query_action_borrow_action_target(query
, matching_trigger
);
4850 trigger_status
= lttng_trigger_get_name(matching_trigger
, &trigger_name
);
4851 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
? trigger_name
: "(anonymous)";
4852 trigger_status
= lttng_trigger_get_owner_uid(matching_trigger
, &trigger_owner
);
4853 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4855 results
= lttng_error_query_results_create();
4857 ret_code
= LTTNG_ERR_NOMEM
;
4861 DBG("Running \"execute error query\" command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4863 (int) trigger_owner
,
4864 (int) lttng_credentials_get_uid(cmd_creds
));
4867 * Validate the trigger credentials against the command credentials.
4868 * Only the root user can target a trigger with non-matching
4871 if (!lttng_credentials_is_equal_uid(lttng_trigger_get_credentials(matching_trigger
),
4873 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4874 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4876 (int) trigger_owner
,
4877 (int) lttng_credentials_get_uid(cmd_creds
));
4878 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4883 switch (lttng_error_query_get_target_type(query
)) {
4884 case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER
:
4885 trigger_status
= lttng_trigger_add_error_results(matching_trigger
, results
);
4887 switch (trigger_status
) {
4888 case LTTNG_TRIGGER_STATUS_OK
:
4891 ret_code
= LTTNG_ERR_UNK
;
4896 case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION
:
4899 lttng_trigger_condition_add_error_results(matching_trigger
, results
);
4901 switch (trigger_status
) {
4902 case LTTNG_TRIGGER_STATUS_OK
:
4905 ret_code
= LTTNG_ERR_UNK
;
4911 case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
:
4913 const enum lttng_action_status action_status
=
4914 lttng_action_add_error_query_results(query_target_action
, results
);
4916 switch (action_status
) {
4917 case LTTNG_ACTION_STATUS_OK
:
4920 ret_code
= LTTNG_ERR_UNK
;
4931 *_results
= results
;
4933 ret_code
= LTTNG_OK
;
4935 lttng_trigger_put(matching_trigger
);
4936 lttng_error_query_results_destroy(results
);
4941 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4942 * snapshot output is *not* set with a remote destination.
4944 * Return LTTNG_OK on success or a LTTNG_ERR code.
4946 static enum lttng_error_code
set_relayd_for_snapshot(struct consumer_output
*output
,
4947 const struct ltt_session
*session
)
4949 enum lttng_error_code status
= LTTNG_OK
;
4950 struct lttng_ht_iter iter
;
4951 struct consumer_socket
*socket
;
4952 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4953 const char *base_path
;
4955 LTTNG_ASSERT(output
);
4956 LTTNG_ASSERT(session
);
4958 DBG2("Set relayd object from snapshot output");
4960 if (session
->current_trace_chunk
) {
4961 enum lttng_trace_chunk_status chunk_status
= lttng_trace_chunk_get_id(
4962 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
4964 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4965 current_chunk_id
.is_set
= true;
4967 ERR("Failed to get current trace chunk id");
4968 status
= LTTNG_ERR_UNK
;
4973 /* Ignore if snapshot consumer output is not network. */
4974 if (output
->type
!= CONSUMER_DST_NET
) {
4979 * The snapshot record URI base path overrides the session
4982 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4983 base_path
= output
->dst
.net
.control
.subdir
;
4985 base_path
= session
->base_path
;
4989 * For each consumer socket, create and send the relayd object of the
4993 lttng::urcu::read_lock_guard read_lock
;
4995 cds_lfht_for_each_entry (output
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
4996 pthread_mutex_lock(socket
->lock
);
4997 status
= send_consumer_relayd_sockets(
5004 session
->live_timer
,
5005 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: nullptr,
5006 session
->creation_time
,
5007 session
->name_contains_creation_time
);
5008 pthread_mutex_unlock(socket
->lock
);
5009 if (status
!= LTTNG_OK
) {
5020 * Record a kernel snapshot.
5022 * Return LTTNG_OK on success or a LTTNG_ERR code.
5024 static enum lttng_error_code
record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
5025 const struct consumer_output
*output
,
5026 const struct ltt_session
*session
,
5027 uint64_t nb_packets_per_stream
)
5029 enum lttng_error_code status
;
5031 LTTNG_ASSERT(ksess
);
5032 LTTNG_ASSERT(output
);
5033 LTTNG_ASSERT(session
);
5035 status
= kernel_snapshot_record(ksess
, output
, nb_packets_per_stream
);
5040 * Record a UST snapshot.
5042 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
5044 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
5045 const struct consumer_output
*output
,
5046 const struct ltt_session
*session
,
5047 uint64_t nb_packets_per_stream
)
5049 enum lttng_error_code status
;
5051 LTTNG_ASSERT(usess
);
5052 LTTNG_ASSERT(output
);
5053 LTTNG_ASSERT(session
);
5055 status
= ust_app_snapshot_record(usess
, output
, nb_packets_per_stream
);
5059 static uint64_t get_session_size_one_more_packet_per_stream(const struct ltt_session
*session
,
5060 uint64_t cur_nr_packets
)
5062 uint64_t tot_size
= 0;
5064 if (session
->kernel_session
) {
5065 struct ltt_kernel_channel
*chan
;
5066 const struct ltt_kernel_session
*ksess
= session
->kernel_session
;
5068 cds_list_for_each_entry (chan
, &ksess
->channel_list
.head
, list
) {
5069 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
5071 * Don't take channel into account if we
5072 * already grab all its packets.
5076 tot_size
+= chan
->channel
->attr
.subbuf_size
* chan
->stream_count
;
5080 if (session
->ust_session
) {
5081 const struct ltt_ust_session
*usess
= session
->ust_session
;
5083 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
, cur_nr_packets
);
5090 * Calculate the number of packets we can grab from each stream that
5091 * fits within the overall snapshot max size.
5093 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
5094 * the number of packets per stream.
5096 * TODO: this approach is not perfect: we consider the worse case
5097 * (packet filling the sub-buffers) as an upper bound, but we could do
5098 * better if we do this calculation while we actually grab the packet
5099 * content: we would know how much padding we don't actually store into
5102 * This algorithm is currently bounded by the number of packets per
5105 * Since we call this algorithm before actually grabbing the data, it's
5106 * an approximation: for instance, applications could appear/disappear
5107 * in between this call and actually grabbing data.
5109 static int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
5113 uint64_t cur_nb_packets
= 0;
5116 return 0; /* Infinite */
5119 size_left
= max_size
;
5121 uint64_t one_more_packet_tot_size
;
5123 one_more_packet_tot_size
=
5124 get_session_size_one_more_packet_per_stream(session
, cur_nb_packets
);
5125 if (!one_more_packet_tot_size
) {
5126 /* We are already grabbing all packets. */
5129 size_left
-= one_more_packet_tot_size
;
5130 if (size_left
< 0) {
5135 if (!cur_nb_packets
&& size_left
!= max_size
) {
5136 /* Not enough room to grab one packet of each stream, error. */
5139 return cur_nb_packets
;
5142 static enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
5143 const struct snapshot_output
*snapshot_output
)
5145 int64_t nb_packets_per_stream
;
5146 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
5148 enum lttng_error_code ret_code
= LTTNG_OK
;
5149 struct lttng_trace_chunk
*snapshot_trace_chunk
;
5150 struct consumer_output
*original_ust_consumer_output
= nullptr;
5151 struct consumer_output
*original_kernel_consumer_output
= nullptr;
5152 struct consumer_output
*snapshot_ust_consumer_output
= nullptr;
5153 struct consumer_output
*snapshot_kernel_consumer_output
= nullptr;
5155 ret
= snprintf(snapshot_chunk_name
,
5156 sizeof(snapshot_chunk_name
),
5158 snapshot_output
->name
,
5159 snapshot_output
->datetime
,
5160 snapshot_output
->nb_snapshot
);
5161 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
5162 ERR("Failed to format snapshot name");
5163 ret_code
= LTTNG_ERR_INVALID
;
5166 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
5167 snapshot_output
->name
,
5169 snapshot_chunk_name
);
5170 if (!session
->kernel_session
&& !session
->ust_session
) {
5171 ERR("Failed to record snapshot as no channels exist");
5172 ret_code
= LTTNG_ERR_NO_CHANNEL
;
5176 if (session
->kernel_session
) {
5177 original_kernel_consumer_output
= session
->kernel_session
->consumer
;
5178 snapshot_kernel_consumer_output
= consumer_copy_output(snapshot_output
->consumer
);
5179 strcpy(snapshot_kernel_consumer_output
->chunk_path
, snapshot_chunk_name
);
5181 /* Copy the original domain subdir. */
5182 strcpy(snapshot_kernel_consumer_output
->domain_subdir
,
5183 original_kernel_consumer_output
->domain_subdir
);
5185 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
5186 original_kernel_consumer_output
);
5188 ERR("Failed to copy consumer sockets from snapshot output configuration");
5189 ret_code
= LTTNG_ERR_NOMEM
;
5192 ret_code
= set_relayd_for_snapshot(snapshot_kernel_consumer_output
, session
);
5193 if (ret_code
!= LTTNG_OK
) {
5194 ERR("Failed to setup relay daemon for kernel tracer snapshot");
5197 session
->kernel_session
->consumer
= snapshot_kernel_consumer_output
;
5199 if (session
->ust_session
) {
5200 original_ust_consumer_output
= session
->ust_session
->consumer
;
5201 snapshot_ust_consumer_output
= consumer_copy_output(snapshot_output
->consumer
);
5202 strcpy(snapshot_ust_consumer_output
->chunk_path
, snapshot_chunk_name
);
5204 /* Copy the original domain subdir. */
5205 strcpy(snapshot_ust_consumer_output
->domain_subdir
,
5206 original_ust_consumer_output
->domain_subdir
);
5208 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
5209 original_ust_consumer_output
);
5211 ERR("Failed to copy consumer sockets from snapshot output configuration");
5212 ret_code
= LTTNG_ERR_NOMEM
;
5215 ret_code
= set_relayd_for_snapshot(snapshot_ust_consumer_output
, session
);
5216 if (ret_code
!= LTTNG_OK
) {
5217 ERR("Failed to setup relay daemon for userspace tracer snapshot");
5220 session
->ust_session
->consumer
= snapshot_ust_consumer_output
;
5223 snapshot_trace_chunk
= session_create_new_trace_chunk(
5225 snapshot_kernel_consumer_output
?: snapshot_ust_consumer_output
,
5226 consumer_output_get_base_path(snapshot_output
->consumer
),
5227 snapshot_chunk_name
);
5228 if (!snapshot_trace_chunk
) {
5229 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
5231 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
5234 LTTNG_ASSERT(!session
->current_trace_chunk
);
5235 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, nullptr);
5236 lttng_trace_chunk_put(snapshot_trace_chunk
);
5237 snapshot_trace_chunk
= nullptr;
5239 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
5241 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5245 nb_packets_per_stream
=
5246 get_session_nb_packets_per_stream(session
, snapshot_output
->max_size
);
5247 if (nb_packets_per_stream
< 0) {
5248 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
5249 goto error_close_trace_chunk
;
5252 if (session
->kernel_session
) {
5253 ret_code
= record_kernel_snapshot(session
->kernel_session
,
5254 snapshot_kernel_consumer_output
,
5256 nb_packets_per_stream
);
5257 if (ret_code
!= LTTNG_OK
) {
5258 goto error_close_trace_chunk
;
5262 if (session
->ust_session
) {
5263 ret_code
= record_ust_snapshot(session
->ust_session
,
5264 snapshot_ust_consumer_output
,
5266 nb_packets_per_stream
);
5267 if (ret_code
!= LTTNG_OK
) {
5268 goto error_close_trace_chunk
;
5272 error_close_trace_chunk
:
5273 if (session_set_trace_chunk(session
, nullptr, &snapshot_trace_chunk
)) {
5274 ERR("Failed to release the current trace chunk of session \"%s\"", session
->name
);
5275 ret_code
= LTTNG_ERR_UNK
;
5278 if (session_close_trace_chunk(session
,
5279 snapshot_trace_chunk
,
5280 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
,
5283 * Don't goto end; make sure the chunk is closed for the session
5284 * to allow future snapshots.
5286 ERR("Failed to close snapshot trace chunk of session \"%s\"", session
->name
);
5287 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5290 lttng_trace_chunk_put(snapshot_trace_chunk
);
5291 snapshot_trace_chunk
= nullptr;
5293 if (original_ust_consumer_output
) {
5294 session
->ust_session
->consumer
= original_ust_consumer_output
;
5296 if (original_kernel_consumer_output
) {
5297 session
->kernel_session
->consumer
= original_kernel_consumer_output
;
5299 consumer_output_put(snapshot_ust_consumer_output
);
5300 consumer_output_put(snapshot_kernel_consumer_output
);
5305 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
5307 * The wait parameter is ignored so this call always wait for the snapshot to
5308 * complete before returning.
5310 * Return LTTNG_OK on success or else a LTTNG_ERR code.
5312 int cmd_snapshot_record(struct ltt_session
*session
,
5313 const struct lttng_snapshot_output
*output
,
5314 int wait
__attribute__((unused
)))
5316 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5318 unsigned int snapshot_success
= 0;
5320 struct snapshot_output
*tmp_output
= nullptr;
5322 LTTNG_ASSERT(session
);
5323 LTTNG_ASSERT(output
);
5325 DBG("Cmd snapshot record for session %s", session
->name
);
5327 /* Get the datetime for the snapshot output directory. */
5328 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
, sizeof(datetime
));
5330 cmd_ret
= LTTNG_ERR_INVALID
;
5335 * Permission denied to create an output if the session is not
5336 * set in no output mode.
5338 if (session
->output_traces
) {
5339 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
5343 /* The session needs to be started at least once. */
5344 if (!session
->has_been_started
) {
5345 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5349 /* Use temporary output for the session. */
5350 if (*output
->ctrl_url
!= '\0') {
5351 tmp_output
= snapshot_output_alloc();
5353 cmd_ret
= LTTNG_ERR_NOMEM
;
5357 ret
= snapshot_output_init(session
,
5366 if (ret
== -ENOMEM
) {
5367 cmd_ret
= LTTNG_ERR_NOMEM
;
5369 cmd_ret
= LTTNG_ERR_INVALID
;
5373 /* Use the global session count for the temporary snapshot. */
5374 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
5376 /* Use the global datetime */
5377 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
5378 cmd_ret
= snapshot_record(session
, tmp_output
);
5379 if (cmd_ret
!= LTTNG_OK
) {
5382 snapshot_success
= 1;
5384 struct snapshot_output
*sout
;
5385 struct lttng_ht_iter iter
;
5387 lttng::urcu::read_lock_guard read_lock
;
5389 cds_lfht_for_each_entry (
5390 session
->snapshot
.output_ht
->ht
, &iter
.iter
, sout
, node
.node
) {
5391 struct snapshot_output output_copy
;
5394 * Make a local copy of the output and override output
5395 * parameters with those provided as part of the
5398 memcpy(&output_copy
, sout
, sizeof(output_copy
));
5400 if (output
->max_size
!= (uint64_t) -1ULL) {
5401 output_copy
.max_size
= output
->max_size
;
5404 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
5405 memcpy(output_copy
.datetime
, datetime
, sizeof(datetime
));
5407 /* Use temporary name. */
5408 if (*output
->name
!= '\0') {
5409 if (lttng_strncpy(output_copy
.name
,
5411 sizeof(output_copy
.name
))) {
5412 cmd_ret
= LTTNG_ERR_INVALID
;
5417 cmd_ret
= snapshot_record(session
, &output_copy
);
5418 if (cmd_ret
!= LTTNG_OK
) {
5422 snapshot_success
= 1;
5426 if (snapshot_success
) {
5427 session
->snapshot
.nb_snapshot
++;
5429 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
5434 snapshot_output_destroy(tmp_output
);
5441 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
5443 int cmd_set_session_shm_path(struct ltt_session
*session
, const char *shm_path
)
5446 LTTNG_ASSERT(session
);
5449 * Can only set shm path before session is started.
5451 if (session
->has_been_started
) {
5452 return LTTNG_ERR_SESSION_STARTED
;
5455 strncpy(session
->shm_path
, shm_path
, sizeof(session
->shm_path
));
5456 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
5462 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
5464 * Ask the consumer to rotate the session output directory.
5465 * The session lock must be held.
5467 * Returns LTTNG_OK on success or else a negative LTTng error code.
5469 int cmd_rotate_session(struct ltt_session
*session
,
5470 struct lttng_rotate_session_return
*rotate_return
,
5471 bool quiet_rotation
,
5472 enum lttng_trace_chunk_command_type command
)
5475 uint64_t ongoing_rotation_chunk_id
;
5476 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5477 struct lttng_trace_chunk
*chunk_being_archived
= nullptr;
5478 struct lttng_trace_chunk
*new_trace_chunk
= nullptr;
5479 enum lttng_trace_chunk_status chunk_status
;
5480 bool failed_to_rotate
= false;
5481 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
5483 LTTNG_ASSERT(session
);
5485 if (!session
->has_been_started
) {
5486 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5491 * Explicit rotation is not supported for live sessions.
5492 * However, live sessions can perform a quiet rotation on
5494 * Rotation is not supported for snapshot traces (no output).
5496 if ((!quiet_rotation
&& session
->live_timer
) || !session
->output_traces
) {
5497 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5501 /* Unsupported feature in lttng-relayd before 2.11. */
5502 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5503 (session
->consumer
->relay_major_version
== 2 &&
5504 session
->consumer
->relay_minor_version
< 11)) {
5505 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5509 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5510 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5511 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5515 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5516 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5518 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5523 * After a stop, we only allow one rotation to occur, the other ones are
5524 * useless until a new start.
5526 if (session
->rotated_after_last_stop
) {
5527 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5529 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5534 * After a stop followed by a clear, disallow following rotations a they would
5535 * generate empty chunks.
5537 if (session
->cleared_after_last_stop
) {
5538 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5540 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5544 if (session
->active
) {
5546 session_create_new_trace_chunk(session
, nullptr, nullptr, nullptr);
5547 if (!new_trace_chunk
) {
5548 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5554 * The current trace chunk becomes the chunk being archived.
5556 * After this point, "chunk_being_archived" must absolutely
5557 * be closed on the consumer(s), otherwise it will never be
5558 * cleaned-up, which will result in a leak.
5560 ret
= session_set_trace_chunk(session
, new_trace_chunk
, &chunk_being_archived
);
5562 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5566 if (session
->kernel_session
) {
5567 cmd_ret
= kernel_rotate_session(session
);
5568 if (cmd_ret
!= LTTNG_OK
) {
5569 failed_to_rotate
= true;
5570 rotation_fail_code
= cmd_ret
;
5573 if (session
->ust_session
) {
5574 cmd_ret
= ust_app_rotate_session(session
);
5575 if (cmd_ret
!= LTTNG_OK
) {
5576 failed_to_rotate
= true;
5577 rotation_fail_code
= cmd_ret
;
5581 if (!session
->active
) {
5582 session
->rotated_after_last_stop
= true;
5585 if (!chunk_being_archived
) {
5586 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5588 if (failed_to_rotate
) {
5589 cmd_ret
= rotation_fail_code
;
5596 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5597 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
, &ongoing_rotation_chunk_id
);
5598 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5600 ret
= session_close_trace_chunk(
5601 session
, chunk_being_archived
, command
, session
->last_chunk_path
);
5603 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5607 if (failed_to_rotate
) {
5608 cmd_ret
= rotation_fail_code
;
5612 session
->quiet_rotation
= quiet_rotation
;
5613 ret
= timer_session_rotation_pending_check_start(session
, DEFAULT_ROTATE_PENDING_TIMER
);
5615 cmd_ret
= LTTNG_ERR_UNK
;
5619 if (rotate_return
) {
5620 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5623 session
->chunk_being_archived
= chunk_being_archived
;
5624 chunk_being_archived
= nullptr;
5625 if (!quiet_rotation
) {
5626 ret
= notification_thread_command_session_rotation_ongoing(
5627 the_notification_thread_handle
, session
->id
, ongoing_rotation_chunk_id
);
5628 if (ret
!= LTTNG_OK
) {
5629 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5631 cmd_ret
= (lttng_error_code
) ret
;
5635 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5637 ongoing_rotation_chunk_id
);
5639 lttng_trace_chunk_put(new_trace_chunk
);
5640 lttng_trace_chunk_put(chunk_being_archived
);
5641 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5644 if (session_reset_rotation_state(*session
, LTTNG_ROTATION_STATE_ERROR
)) {
5645 ERR("Failed to reset rotation state of session \"%s\"", session
->name
);
5651 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5653 * Check if the session has finished its rotation.
5655 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5657 int cmd_rotate_get_info(struct ltt_session
*session
,
5658 struct lttng_rotation_get_info_return
*info_return
,
5659 uint64_t rotation_id
)
5661 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5662 enum lttng_rotation_state rotation_state
;
5664 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
,
5666 session
->most_recent_chunk_id
.value
);
5668 if (session
->chunk_being_archived
) {
5669 enum lttng_trace_chunk_status chunk_status
;
5672 chunk_status
= lttng_trace_chunk_get_id(session
->chunk_being_archived
, &chunk_id
);
5673 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5675 rotation_state
= rotation_id
== chunk_id
? LTTNG_ROTATION_STATE_ONGOING
:
5676 LTTNG_ROTATION_STATE_EXPIRED
;
5678 if (session
->last_archived_chunk_id
.is_set
&&
5679 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5680 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5682 rotation_state
= session
->rotation_state
;
5686 switch (rotation_state
) {
5687 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5688 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5691 case LTTNG_ROTATION_STATE_EXPIRED
:
5692 DBG("Reporting that the rotation state of rotation id %" PRIu64
5693 " of session \"%s\" has expired",
5697 case LTTNG_ROTATION_STATE_ONGOING
:
5698 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5702 case LTTNG_ROTATION_STATE_COMPLETED
:
5706 char *current_tracing_path_reply
;
5707 size_t current_tracing_path_reply_len
;
5709 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5713 switch (session_get_consumer_destination_type(session
)) {
5714 case CONSUMER_DST_LOCAL
:
5715 current_tracing_path_reply
= info_return
->location
.local
.absolute_path
;
5716 current_tracing_path_reply_len
=
5717 sizeof(info_return
->location
.local
.absolute_path
);
5718 info_return
->location_type
=
5719 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5720 fmt_ret
= asprintf(&chunk_path
,
5721 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5722 session_get_base_path(session
),
5723 session
->last_archived_chunk_name
);
5724 if (fmt_ret
== -1) {
5725 PERROR("Failed to format the path of the last archived trace chunk");
5726 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5727 cmd_ret
= LTTNG_ERR_UNK
;
5731 case CONSUMER_DST_NET
:
5733 uint16_t ctrl_port
, data_port
;
5735 current_tracing_path_reply
= info_return
->location
.relay
.relative_path
;
5736 current_tracing_path_reply_len
=
5737 sizeof(info_return
->location
.relay
.relative_path
);
5738 /* Currently the only supported relay protocol. */
5739 info_return
->location
.relay
.protocol
=
5740 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5742 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5743 session_get_net_consumer_hostname(session
),
5744 sizeof(info_return
->location
.relay
.host
));
5746 ERR("Failed to copy host name to rotate_get_info reply");
5747 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5748 cmd_ret
= LTTNG_ERR_SET_URL
;
5752 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5753 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5754 info_return
->location
.relay
.ports
.data
= data_port
;
5755 info_return
->location_type
=
5756 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5757 chunk_path
= strdup(session
->last_chunk_path
);
5759 ERR("Failed to allocate the path of the last archived trace chunk");
5760 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5761 cmd_ret
= LTTNG_ERR_UNK
;
5770 fmt_ret
= lttng_strncpy(
5771 current_tracing_path_reply
, chunk_path
, current_tracing_path_reply_len
);
5774 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5775 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5776 cmd_ret
= LTTNG_ERR_UNK
;
5782 case LTTNG_ROTATION_STATE_ERROR
:
5783 DBG("Reporting that an error occurred during rotation %" PRIu64
5784 " of session \"%s\"",
5794 info_return
->status
= (int32_t) rotation_state
;
5799 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5801 * Configure the automatic rotation parameters.
5802 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5803 * 'activate' to false means deactivate the rotation schedule and validate that
5804 * 'new_value' has the same value as the currently active value.
5806 * Return LTTNG_OK on success or else a positive LTTNG_ERR code.
5808 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5810 enum lttng_rotation_schedule_type schedule_type
,
5814 uint64_t *parameter_value
;
5816 LTTNG_ASSERT(session
);
5818 DBG("Cmd rotate set schedule session %s", session
->name
);
5820 if (session
->live_timer
|| !session
->output_traces
) {
5821 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5822 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5826 switch (schedule_type
) {
5827 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5828 parameter_value
= &session
->rotate_size
;
5830 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5831 parameter_value
= &session
->rotate_timer_period
;
5832 if (new_value
>= UINT_MAX
) {
5833 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
5837 ret
= LTTNG_ERR_INVALID
;
5842 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5843 ret
= LTTNG_ERR_INVALID
;
5847 /* Improper use of the API. */
5848 if (new_value
== -1ULL) {
5849 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5850 ret
= LTTNG_ERR_INVALID
;
5855 * As indicated in struct ltt_session's comments, a value of == 0 means
5856 * this schedule rotation type is not in use.
5858 * Reject the command if we were asked to activate a schedule that was
5861 if (activate
&& *parameter_value
!= 0) {
5862 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5863 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5868 * Reject the command if we were asked to deactivate a schedule that was
5871 if (!activate
&& *parameter_value
== 0) {
5872 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5873 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5878 * Reject the command if we were asked to deactivate a schedule that
5881 if (!activate
&& *parameter_value
!= new_value
) {
5882 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5883 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5887 *parameter_value
= activate
? new_value
: 0;
5889 switch (schedule_type
) {
5890 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5891 if (activate
&& session
->active
) {
5893 * Only start the timer if the session is active,
5894 * otherwise it will be started when the session starts.
5896 ret
= timer_session_rotation_schedule_timer_start(session
, new_value
);
5898 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5899 ret
= LTTNG_ERR_UNK
;
5903 ret
= timer_session_rotation_schedule_timer_stop(session
);
5905 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5906 ret
= LTTNG_ERR_UNK
;
5911 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5914 the_rotation_thread_handle
->subscribe_session_consumed_size_rotation(
5915 *session
, new_value
);
5916 } catch (const std::exception
& e
) {
5917 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command: %s",
5919 ret
= LTTNG_ERR_UNK
;
5924 the_rotation_thread_handle
5925 ->unsubscribe_session_consumed_size_rotation(*session
);
5926 } catch (const std::exception
& e
) {
5927 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command: %s",
5929 ret
= LTTNG_ERR_UNK
;
5935 /* Would have been caught before. */
5947 /* Wait for a given path to be removed before continuing. */
5948 static enum lttng_error_code
wait_on_path(void *path_data
)
5950 const char *shm_path
= (const char *) path_data
;
5952 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5958 ret
= stat(shm_path
, &st
);
5960 if (errno
!= ENOENT
) {
5961 PERROR("stat() returned an error while checking for the existence of the shm path");
5963 DBG("shm path no longer exists, completing the destruction of session");
5967 if (!S_ISDIR(st
.st_mode
)) {
5968 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5973 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5979 * Returns a pointer to a handler to run on completion of a command.
5980 * Returns NULL if no handler has to be run for the last command executed.
5982 const struct cmd_completion_handler
*cmd_pop_completion_handler()
5984 struct cmd_completion_handler
*handler
= current_completion_handler
;
5986 current_completion_handler
= nullptr;
5991 * Init command subsystem.
5996 * Set network sequence index to 1 for streams to match a relayd
5997 * socket on the consumer side.
5999 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
6000 relayd_net_seq_idx
= 1;
6001 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
6003 DBG("Command subsystem initialized");