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
15 #include <urcu/list.h>
16 #include <urcu/uatomic.h>
18 #include <common/buffer-view.hpp>
19 #include <common/common.hpp>
20 #include <common/compat/string.hpp>
21 #include <common/defaults.hpp>
22 #include <common/dynamic-buffer.hpp>
23 #include <common/kernel-ctl/kernel-ctl.hpp>
24 #include <common/payload-view.hpp>
25 #include <common/payload.hpp>
26 #include <common/relayd/relayd.hpp>
27 #include <common/sessiond-comm/sessiond-comm.hpp>
28 #include <common/string-utils/string-utils.hpp>
29 #include <common/trace-chunk.hpp>
30 #include <common/utils.hpp>
31 #include <lttng/action/action-internal.hpp>
32 #include <lttng/action/action.h>
33 #include <lttng/channel-internal.hpp>
34 #include <lttng/channel.h>
35 #include <lttng/condition/condition-internal.hpp>
36 #include <lttng/condition/condition.h>
37 #include <lttng/condition/event-rule-matches-internal.hpp>
38 #include <lttng/condition/event-rule-matches.h>
39 #include <lttng/error-query-internal.hpp>
40 #include <lttng/event-internal.hpp>
41 #include <lttng/event-rule/event-rule-internal.hpp>
42 #include <lttng/event-rule/event-rule.h>
43 #include <lttng/location-internal.hpp>
44 #include <lttng/lttng-error.h>
45 #include <lttng/rotate-internal.hpp>
46 #include <lttng/session-descriptor-internal.hpp>
47 #include <lttng/session-internal.hpp>
48 #include <lttng/tracker.h>
49 #include <lttng/trigger/trigger-internal.hpp>
50 #include <lttng/userspace-probe-internal.hpp>
52 #include "agent-thread.hpp"
54 #include "buffer-registry.hpp"
55 #include "channel.hpp"
57 #include "consumer.hpp"
58 #include "event-notifier-error-accounting.hpp"
60 #include "health-sessiond.hpp"
61 #include "kernel-consumer.hpp"
63 #include "lttng-sessiond.hpp"
64 #include "lttng-syscall.hpp"
65 #include "notification-thread-commands.hpp"
66 #include "notification-thread.hpp"
68 #include "rotation-thread.hpp"
69 #include "session.hpp"
71 #include "tracker.hpp"
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
= {
104 .data
= destroy_completion_handler
.shm_path
110 * Used to keep a unique index for each relayd socket created where this value
111 * is associated with streams on the consumer so it can match the right relayd
112 * to send to. It must be accessed with the relayd_net_seq_idx_lock
115 pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
116 uint64_t relayd_net_seq_idx
;
119 static struct cmd_completion_handler
*current_completion_handler
;
120 static int validate_ust_event_name(const char *);
121 static int cmd_enable_event_internal(struct ltt_session
*session
,
122 const struct lttng_domain
*domain
,
123 char *channel_name
, struct lttng_event
*event
,
124 char *filter_expression
,
125 struct lttng_bytecode
*filter
,
126 struct lttng_event_exclusion
*exclusion
,
128 static enum lttng_error_code
cmd_enable_channel_internal(
129 struct ltt_session
*session
,
130 const struct lttng_domain
*domain
,
131 const struct lttng_channel
*_attr
,
135 * Create a session path used by list_lttng_sessions for the case that the
136 * session consumer is on the network.
138 static int build_network_session_path(char *dst
, size_t size
,
139 struct ltt_session
*session
)
141 int ret
, kdata_port
, udata_port
;
142 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
143 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
145 LTTNG_ASSERT(session
);
148 memset(tmp_urls
, 0, sizeof(tmp_urls
));
149 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
151 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
153 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
154 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
155 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
158 if (session
->ust_session
&& session
->ust_session
->consumer
) {
159 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
160 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
163 if (uuri
== NULL
&& kuri
== NULL
) {
164 uri
= &session
->consumer
->dst
.net
.control
;
165 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
166 } else if (kuri
&& uuri
) {
167 ret
= uri_compare(kuri
, uuri
);
171 /* Build uuri URL string */
172 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
179 } else if (kuri
&& uuri
== NULL
) {
181 } else if (uuri
&& kuri
== NULL
) {
185 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
191 * Do we have a UST url set. If yes, this means we have both kernel and UST
194 if (*tmp_uurl
!= '\0') {
195 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
196 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
199 if (kuri
|| (!kuri
&& !uuri
)) {
202 /* No kernel URI, use the UST port. */
205 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
213 * Get run-time attributes if the session has been started (discarded events,
216 static int get_kernel_runtime_stats(struct ltt_session
*session
,
217 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
218 uint64_t *lost_packets
)
222 if (!session
->has_been_started
) {
224 *discarded_events
= 0;
229 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
230 session
->kernel_session
->consumer
,
236 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
237 session
->kernel_session
->consumer
,
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
, uint64_t *discarded_events
,
253 uint64_t *lost_packets
)
256 struct ltt_ust_session
*usess
;
258 if (!discarded_events
|| !lost_packets
) {
263 usess
= session
->ust_session
;
264 LTTNG_ASSERT(discarded_events
);
265 LTTNG_ASSERT(lost_packets
);
267 if (!usess
|| !session
->has_been_started
) {
268 *discarded_events
= 0;
274 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
275 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
276 &usess
->buffer_reg_uid_list
,
277 usess
->consumer
, uchan
->id
,
278 uchan
->attr
.overwrite
,
281 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
282 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
283 uchan
, usess
->consumer
,
284 uchan
->attr
.overwrite
,
290 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
291 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
293 ERR("Unsupported buffer type");
304 * Create a list of agent domain events.
306 * Return number of events in list on success or else a negative value.
308 static enum lttng_error_code
list_lttng_agent_events(
309 struct agent
*agt
, struct lttng_payload
*reply_payload
,
310 unsigned int *nb_events
)
312 enum lttng_error_code ret_code
;
314 unsigned int local_nb_events
= 0;
315 struct agent_event
*event
;
316 struct lttng_ht_iter iter
;
317 unsigned long agent_event_count
;
320 assert(reply_payload
);
322 DBG3("Listing agent events");
325 agent_event_count
= lttng_ht_get_count(agt
->events
);
326 if (agent_event_count
== 0) {
331 if (agent_event_count
> UINT_MAX
) {
332 ret_code
= LTTNG_ERR_OVERFLOW
;
336 local_nb_events
= (unsigned int) agent_event_count
;
338 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
339 struct lttng_event
*tmp_event
= lttng_event_create();
342 ret_code
= LTTNG_ERR_NOMEM
;
346 if (lttng_strncpy(tmp_event
->name
, event
->name
, sizeof(tmp_event
->name
))) {
347 lttng_event_destroy(tmp_event
);
348 ret_code
= LTTNG_ERR_FATAL
;
352 tmp_event
->name
[sizeof(tmp_event
->name
) - 1] = '\0';
353 tmp_event
->enabled
= !!event
->enabled_count
;
354 tmp_event
->loglevel
= event
->loglevel_value
;
355 tmp_event
->loglevel_type
= event
->loglevel_type
;
357 ret
= lttng_event_serialize(tmp_event
, 0, NULL
,
358 event
->filter_expression
, 0, NULL
, reply_payload
);
359 lttng_event_destroy(tmp_event
);
361 ret_code
= LTTNG_ERR_FATAL
;
368 *nb_events
= local_nb_events
;
375 * Create a list of ust global domain events.
377 static enum lttng_error_code
list_lttng_ust_global_events(char *channel_name
,
378 struct ltt_ust_domain_global
*ust_global
,
379 struct lttng_payload
*reply_payload
,
380 unsigned int *nb_events
)
382 enum lttng_error_code ret_code
;
384 struct lttng_ht_iter iter
;
385 struct lttng_ht_node_str
*node
;
386 struct ltt_ust_channel
*uchan
;
387 struct ltt_ust_event
*uevent
;
388 unsigned long channel_event_count
;
389 unsigned int local_nb_events
= 0;
391 assert(reply_payload
);
394 DBG("Listing UST global events for channel %s", channel_name
);
398 lttng_ht_lookup(ust_global
->channels
, (void *) channel_name
, &iter
);
399 node
= lttng_ht_iter_get_node_str(&iter
);
401 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
405 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
407 channel_event_count
= lttng_ht_get_count(uchan
->events
);
408 if (channel_event_count
== 0) {
414 if (channel_event_count
> UINT_MAX
) {
415 ret_code
= LTTNG_ERR_OVERFLOW
;
419 local_nb_events
= (unsigned int) channel_event_count
;
421 DBG3("Listing UST global %d events", *nb_events
);
423 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
424 struct lttng_event
*tmp_event
= NULL
;
426 if (uevent
->internal
) {
427 /* This event should remain hidden from clients */
432 tmp_event
= lttng_event_create();
434 ret_code
= LTTNG_ERR_NOMEM
;
438 if (lttng_strncpy(tmp_event
->name
, uevent
->attr
.name
,
439 LTTNG_SYMBOL_NAME_LEN
)) {
440 ret_code
= LTTNG_ERR_FATAL
;
441 lttng_event_destroy(tmp_event
);
445 tmp_event
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
446 tmp_event
->enabled
= uevent
->enabled
;
448 switch (uevent
->attr
.instrumentation
) {
449 case LTTNG_UST_ABI_TRACEPOINT
:
450 tmp_event
->type
= LTTNG_EVENT_TRACEPOINT
;
452 case LTTNG_UST_ABI_PROBE
:
453 tmp_event
->type
= LTTNG_EVENT_PROBE
;
455 case LTTNG_UST_ABI_FUNCTION
:
456 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
460 tmp_event
->loglevel
= uevent
->attr
.loglevel
;
461 switch (uevent
->attr
.loglevel_type
) {
462 case LTTNG_UST_ABI_LOGLEVEL_ALL
:
463 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
465 case LTTNG_UST_ABI_LOGLEVEL_RANGE
:
466 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
468 case LTTNG_UST_ABI_LOGLEVEL_SINGLE
:
469 tmp_event
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
472 if (uevent
->filter
) {
473 tmp_event
->filter
= 1;
475 if (uevent
->exclusion
) {
476 tmp_event
->exclusion
= 1;
480 * We do not care about the filter bytecode and the fd from the
481 * userspace_probe_location.
483 ret
= lttng_event_serialize(tmp_event
, uevent
->exclusion
? uevent
->exclusion
->count
: 0,
484 uevent
->exclusion
? (char **) uevent
->exclusion
->names
: NULL
,
485 uevent
->filter_expression
, 0, NULL
, reply_payload
);
486 lttng_event_destroy(tmp_event
);
488 ret_code
= LTTNG_ERR_FATAL
;
494 /* nb_events is already set at this point. */
496 *nb_events
= local_nb_events
;
503 * Fill lttng_event array of all kernel events in the channel.
505 static enum lttng_error_code
list_lttng_kernel_events(char *channel_name
,
506 struct ltt_kernel_session
*kernel_session
,
507 struct lttng_payload
*reply_payload
,
508 unsigned int *nb_events
)
510 enum lttng_error_code ret_code
;
512 struct ltt_kernel_event
*event
;
513 struct ltt_kernel_channel
*kchan
;
515 assert(reply_payload
);
517 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
519 ret_code
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
523 *nb_events
= kchan
->event_count
;
525 DBG("Listing events for channel %s", kchan
->channel
->name
);
527 if (*nb_events
== 0) {
532 /* Kernel channels */
533 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
534 struct lttng_event
*tmp_event
= lttng_event_create();
537 ret_code
= LTTNG_ERR_NOMEM
;
541 if (lttng_strncpy(tmp_event
->name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
)) {
542 lttng_event_destroy(tmp_event
);
543 ret_code
= LTTNG_ERR_FATAL
;
548 tmp_event
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
549 tmp_event
->enabled
= event
->enabled
;
550 tmp_event
->filter
= (unsigned char) !!event
->filter_expression
;
552 switch (event
->event
->instrumentation
) {
553 case LTTNG_KERNEL_ABI_TRACEPOINT
:
554 tmp_event
->type
= LTTNG_EVENT_TRACEPOINT
;
556 case LTTNG_KERNEL_ABI_KRETPROBE
:
557 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
558 memcpy(&tmp_event
->attr
.probe
, &event
->event
->u
.kprobe
,
559 sizeof(struct lttng_kernel_abi_kprobe
));
561 case LTTNG_KERNEL_ABI_KPROBE
:
562 tmp_event
->type
= LTTNG_EVENT_PROBE
;
563 memcpy(&tmp_event
->attr
.probe
, &event
->event
->u
.kprobe
,
564 sizeof(struct lttng_kernel_abi_kprobe
));
566 case LTTNG_KERNEL_ABI_UPROBE
:
567 tmp_event
->type
= LTTNG_EVENT_USERSPACE_PROBE
;
569 case LTTNG_KERNEL_ABI_FUNCTION
:
570 tmp_event
->type
= LTTNG_EVENT_FUNCTION
;
571 memcpy(&(tmp_event
->attr
.ftrace
), &event
->event
->u
.ftrace
,
572 sizeof(struct lttng_kernel_abi_function
));
574 case LTTNG_KERNEL_ABI_NOOP
:
575 tmp_event
->type
= LTTNG_EVENT_NOOP
;
577 case LTTNG_KERNEL_ABI_SYSCALL
:
578 tmp_event
->type
= LTTNG_EVENT_SYSCALL
;
580 case LTTNG_KERNEL_ABI_ALL
:
587 if (event
->userspace_probe_location
) {
588 struct lttng_userspace_probe_location
*location_copy
=
589 lttng_userspace_probe_location_copy(
590 event
->userspace_probe_location
);
592 if (!location_copy
) {
593 lttng_event_destroy(tmp_event
);
594 ret_code
= LTTNG_ERR_NOMEM
;
598 ret
= lttng_event_set_userspace_probe_location(
599 tmp_event
, location_copy
);
601 lttng_event_destroy(tmp_event
);
602 lttng_userspace_probe_location_destroy(
604 ret_code
= LTTNG_ERR_INVALID
;
609 ret
= lttng_event_serialize(tmp_event
, 0, NULL
,
610 event
->filter_expression
, 0, NULL
, reply_payload
);
611 lttng_event_destroy(tmp_event
);
613 ret_code
= LTTNG_ERR_FATAL
;
624 * Add URI so the consumer output object. Set the correct path depending on the
625 * domain adding the default trace directory.
627 static enum lttng_error_code
add_uri_to_consumer(
628 const struct ltt_session
*session
,
629 struct consumer_output
*consumer
,
630 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
633 enum lttng_error_code ret_code
= LTTNG_OK
;
637 if (consumer
== NULL
) {
638 DBG("No consumer detected. Don't add URI. Stopping.");
639 ret_code
= LTTNG_ERR_NO_CONSUMER
;
644 case LTTNG_DOMAIN_KERNEL
:
645 ret
= lttng_strncpy(consumer
->domain_subdir
,
646 DEFAULT_KERNEL_TRACE_DIR
,
647 sizeof(consumer
->domain_subdir
));
649 case LTTNG_DOMAIN_UST
:
650 ret
= lttng_strncpy(consumer
->domain_subdir
,
651 DEFAULT_UST_TRACE_DIR
,
652 sizeof(consumer
->domain_subdir
));
656 * This case is possible is we try to add the URI to the global
657 * tracing session consumer object which in this case there is
660 memset(consumer
->domain_subdir
, 0,
661 sizeof(consumer
->domain_subdir
));
665 ERR("Failed to initialize consumer output domain subdirectory");
666 ret_code
= LTTNG_ERR_FATAL
;
670 switch (uri
->dtype
) {
673 DBG2("Setting network URI to consumer");
675 if (consumer
->type
== CONSUMER_DST_NET
) {
676 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
677 consumer
->dst
.net
.control_isset
) ||
678 (uri
->stype
== LTTNG_STREAM_DATA
&&
679 consumer
->dst
.net
.data_isset
)) {
680 ret_code
= LTTNG_ERR_URL_EXIST
;
684 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
687 /* Set URI into consumer output object */
688 ret
= consumer_set_network_uri(session
, consumer
, uri
);
690 ret_code
= (lttng_error_code
) -ret
;
692 } else if (ret
== 1) {
694 * URI was the same in the consumer so we do not append the subdir
695 * again so to not duplicate output dir.
702 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
703 ret_code
= LTTNG_ERR_INVALID
;
706 DBG2("Setting trace directory path from URI to %s",
708 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
710 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
712 sizeof(consumer
->dst
.session_root_path
));
714 ret_code
= LTTNG_ERR_FATAL
;
717 consumer
->type
= CONSUMER_DST_LOCAL
;
727 * Init tracing by creating trace directory and sending fds kernel consumer.
729 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
732 struct lttng_ht_iter iter
;
733 struct consumer_socket
*socket
;
735 LTTNG_ASSERT(session
);
739 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
740 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
742 pthread_mutex_lock(socket
->lock
);
743 ret
= kernel_consumer_send_session(socket
, session
);
744 pthread_mutex_unlock(socket
->lock
);
746 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
758 * Create a socket to the relayd using the URI.
760 * On success, the relayd_sock pointer is set to the created socket.
761 * Else, it remains untouched and an LTTng error code is returned.
763 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
764 struct lttcomm_relayd_sock
**relayd_sock
,
765 struct consumer_output
*consumer
)
768 enum lttng_error_code status
= LTTNG_OK
;
769 struct lttcomm_relayd_sock
*rsock
;
771 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
772 RELAYD_VERSION_COMM_MINOR
);
774 status
= LTTNG_ERR_FATAL
;
779 * Connect to relayd so we can proceed with a session creation. This call
780 * can possibly block for an arbitrary amount of time to set the health
781 * state to be in poll execution.
784 ret
= relayd_connect(rsock
);
787 ERR("Unable to reach lttng-relayd");
788 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
792 /* Create socket for control stream. */
793 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
794 uint64_t result_flags
;
796 DBG3("Creating relayd stream socket from URI");
798 /* Check relayd version */
799 ret
= relayd_version_check(rsock
);
800 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
801 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
803 } else if (ret
< 0) {
804 ERR("Unable to reach lttng-relayd");
805 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
808 consumer
->relay_major_version
= rsock
->major
;
809 consumer
->relay_minor_version
= rsock
->minor
;
810 ret
= relayd_get_configuration(rsock
, 0,
813 ERR("Unable to get relayd configuration");
814 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
817 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
818 consumer
->relay_allows_clear
= true;
820 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
821 DBG3("Creating relayd data socket from URI");
823 /* Command is not valid */
824 ERR("Relayd invalid stream type: %d", uri
->stype
);
825 status
= LTTNG_ERR_INVALID
;
829 *relayd_sock
= rsock
;
834 /* The returned value is not useful since we are on an error path. */
835 (void) relayd_close(rsock
);
843 * Connect to the relayd using URI and send the socket to the right consumer.
845 * The consumer socket lock must be held by the caller.
847 * Returns LTTNG_OK on success or an LTTng error code on failure.
849 static enum lttng_error_code
send_consumer_relayd_socket(
850 unsigned int session_id
,
851 struct lttng_uri
*relayd_uri
,
852 struct consumer_output
*consumer
,
853 struct consumer_socket
*consumer_sock
,
854 const char *session_name
, const char *hostname
,
855 const char *base_path
, int session_live_timer
,
856 const uint64_t *current_chunk_id
,
857 time_t session_creation_time
,
858 bool session_name_contains_creation_time
)
861 struct lttcomm_relayd_sock
*rsock
= NULL
;
862 enum lttng_error_code status
;
864 /* Connect to relayd and make version check if uri is the control. */
865 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
866 if (status
!= LTTNG_OK
) {
867 goto relayd_comm_error
;
871 /* Set the network sequence index if not set. */
872 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
873 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
875 * Increment net_seq_idx because we are about to transfer the
876 * new relayd socket to the consumer.
877 * Assign unique key so the consumer can match streams.
879 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
880 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
883 /* Send relayd socket to consumer. */
884 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
885 relayd_uri
->stype
, session_id
,
886 session_name
, hostname
, base_path
,
887 session_live_timer
, current_chunk_id
,
888 session_creation_time
, session_name_contains_creation_time
);
890 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
894 /* Flag that the corresponding socket was sent. */
895 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
896 consumer_sock
->control_sock_sent
= 1;
897 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
898 consumer_sock
->data_sock_sent
= 1;
902 * Close socket which was dup on the consumer side. The session daemon does
903 * NOT keep track of the relayd socket(s) once transfer to the consumer.
907 if (status
!= LTTNG_OK
) {
909 * The consumer output for this session should not be used anymore
910 * since the relayd connection failed thus making any tracing or/and
911 * streaming not usable.
913 consumer
->enabled
= 0;
915 (void) relayd_close(rsock
);
923 * Send both relayd sockets to a specific consumer and domain. This is a
924 * helper function to facilitate sending the information to the consumer for a
927 * The consumer socket lock must be held by the caller.
929 * Returns LTTNG_OK, or an LTTng error code on failure.
931 static enum lttng_error_code
send_consumer_relayd_sockets(
932 unsigned int session_id
, struct consumer_output
*consumer
,
933 struct consumer_socket
*sock
, const char *session_name
,
934 const char *hostname
, const char *base_path
, int session_live_timer
,
935 const uint64_t *current_chunk_id
, time_t session_creation_time
,
936 bool session_name_contains_creation_time
)
938 enum lttng_error_code status
= LTTNG_OK
;
940 LTTNG_ASSERT(consumer
);
943 /* Sending control relayd socket. */
944 if (!sock
->control_sock_sent
) {
945 status
= send_consumer_relayd_socket(session_id
,
946 &consumer
->dst
.net
.control
, consumer
, sock
,
947 session_name
, hostname
, base_path
, session_live_timer
,
948 current_chunk_id
, session_creation_time
,
949 session_name_contains_creation_time
);
950 if (status
!= LTTNG_OK
) {
955 /* Sending data relayd socket. */
956 if (!sock
->data_sock_sent
) {
957 status
= send_consumer_relayd_socket(session_id
,
958 &consumer
->dst
.net
.data
, consumer
, sock
,
959 session_name
, hostname
, base_path
, session_live_timer
,
960 current_chunk_id
, session_creation_time
,
961 session_name_contains_creation_time
);
962 if (status
!= LTTNG_OK
) {
972 * Setup relayd connections for a tracing session. First creates the socket to
973 * the relayd and send them to the right domain consumer. Consumer type MUST be
976 int cmd_setup_relayd(struct ltt_session
*session
)
979 struct ltt_ust_session
*usess
;
980 struct ltt_kernel_session
*ksess
;
981 struct consumer_socket
*socket
;
982 struct lttng_ht_iter iter
;
983 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
985 LTTNG_ASSERT(session
);
987 usess
= session
->ust_session
;
988 ksess
= session
->kernel_session
;
990 DBG("Setting relayd for session %s", session
->name
);
993 if (session
->current_trace_chunk
) {
994 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
995 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
997 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
998 current_chunk_id
.is_set
= true;
1000 ERR("Failed to get current trace chunk id");
1001 ret
= LTTNG_ERR_UNK
;
1006 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1007 && usess
->consumer
->enabled
) {
1008 /* For each consumer socket, send relayd sockets */
1009 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1010 socket
, node
.node
) {
1011 pthread_mutex_lock(socket
->lock
);
1012 ret
= send_consumer_relayd_sockets(session
->id
,
1013 usess
->consumer
, socket
,
1014 session
->name
, session
->hostname
,
1016 session
->live_timer
,
1017 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1018 session
->creation_time
,
1019 session
->name_contains_creation_time
);
1020 pthread_mutex_unlock(socket
->lock
);
1021 if (ret
!= LTTNG_OK
) {
1024 /* Session is now ready for network streaming. */
1025 session
->net_handle
= 1;
1027 session
->consumer
->relay_major_version
=
1028 usess
->consumer
->relay_major_version
;
1029 session
->consumer
->relay_minor_version
=
1030 usess
->consumer
->relay_minor_version
;
1031 session
->consumer
->relay_allows_clear
=
1032 usess
->consumer
->relay_allows_clear
;
1035 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1036 && ksess
->consumer
->enabled
) {
1037 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1038 socket
, node
.node
) {
1039 pthread_mutex_lock(socket
->lock
);
1040 ret
= send_consumer_relayd_sockets(session
->id
,
1041 ksess
->consumer
, socket
,
1042 session
->name
, session
->hostname
,
1044 session
->live_timer
,
1045 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1046 session
->creation_time
,
1047 session
->name_contains_creation_time
);
1048 pthread_mutex_unlock(socket
->lock
);
1049 if (ret
!= LTTNG_OK
) {
1052 /* Session is now ready for network streaming. */
1053 session
->net_handle
= 1;
1055 session
->consumer
->relay_major_version
=
1056 ksess
->consumer
->relay_major_version
;
1057 session
->consumer
->relay_minor_version
=
1058 ksess
->consumer
->relay_minor_version
;
1059 session
->consumer
->relay_allows_clear
=
1060 ksess
->consumer
->relay_allows_clear
;
1069 * Start a kernel session by opening all necessary streams.
1071 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1074 struct ltt_kernel_channel
*kchan
;
1076 /* Open kernel metadata */
1077 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1078 ret
= kernel_open_metadata(ksess
);
1080 ret
= LTTNG_ERR_KERN_META_FAIL
;
1085 /* Open kernel metadata stream */
1086 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1087 ret
= kernel_open_metadata_stream(ksess
);
1089 ERR("Kernel create metadata stream failed");
1090 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1095 /* For each channel */
1096 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1097 if (kchan
->stream_count
== 0) {
1098 ret
= kernel_open_channel_stream(kchan
);
1100 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1103 /* Update the stream global counter */
1104 ksess
->stream_count_global
+= ret
;
1108 /* Setup kernel consumer socket and send fds to it */
1109 ret
= init_kernel_tracing(ksess
);
1111 ret
= LTTNG_ERR_KERN_START_FAIL
;
1115 /* This start the kernel tracing */
1116 ret
= kernel_start_session(ksess
);
1118 ret
= LTTNG_ERR_KERN_START_FAIL
;
1122 /* Quiescent wait after starting trace */
1123 kernel_wait_quiescent();
1133 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1135 struct ltt_kernel_channel
*kchan
;
1136 bool error_occurred
= false;
1139 if (!ksess
|| !ksess
->active
) {
1142 DBG("Stopping kernel tracing");
1144 ret
= kernel_stop_session(ksess
);
1146 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1150 kernel_wait_quiescent();
1152 /* Flush metadata after stopping (if exists) */
1153 if (ksess
->metadata_stream_fd
>= 0) {
1154 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1156 ERR("Kernel metadata flush failed");
1157 error_occurred
= true;
1161 /* Flush all buffers after stopping */
1162 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1163 ret
= kernel_flush_buffer(kchan
);
1165 ERR("Kernel flush buffer error");
1166 error_occurred
= true;
1171 if (error_occurred
) {
1172 ret
= LTTNG_ERR_UNK
;
1181 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1183 int cmd_disable_channel(struct ltt_session
*session
,
1184 enum lttng_domain_type domain
, char *channel_name
)
1187 struct ltt_ust_session
*usess
;
1189 usess
= session
->ust_session
;
1194 case LTTNG_DOMAIN_KERNEL
:
1196 ret
= channel_kernel_disable(session
->kernel_session
,
1198 if (ret
!= LTTNG_OK
) {
1202 kernel_wait_quiescent();
1205 case LTTNG_DOMAIN_UST
:
1207 struct ltt_ust_channel
*uchan
;
1208 struct lttng_ht
*chan_ht
;
1210 chan_ht
= usess
->domain_global
.channels
;
1212 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1213 if (uchan
== NULL
) {
1214 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1218 ret
= channel_ust_disable(usess
, uchan
);
1219 if (ret
!= LTTNG_OK
) {
1225 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1237 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1239 * The wpipe arguments is used as a notifier for the kernel thread.
1241 int cmd_enable_channel(struct command_ctx
*cmd_ctx
, int sock
, int wpipe
)
1245 ssize_t sock_recv_len
;
1246 struct lttng_channel
*channel
= NULL
;
1247 struct lttng_buffer_view view
;
1248 struct lttng_dynamic_buffer channel_buffer
;
1249 const struct lttng_domain command_domain
= cmd_ctx
->lsm
.domain
;
1251 lttng_dynamic_buffer_init(&channel_buffer
);
1252 channel_len
= (size_t) cmd_ctx
->lsm
.u
.channel
.length
;
1253 ret
= lttng_dynamic_buffer_set_size(&channel_buffer
, channel_len
);
1255 ret
= LTTNG_ERR_NOMEM
;
1259 sock_recv_len
= lttcomm_recv_unix_sock(sock
, channel_buffer
.data
,
1261 if (sock_recv_len
< 0 || sock_recv_len
!= channel_len
) {
1262 ERR("Failed to receive \"enable channel\" command payload");
1263 ret
= LTTNG_ERR_INVALID
;
1267 view
= lttng_buffer_view_from_dynamic_buffer(&channel_buffer
, 0, channel_len
);
1268 if (!lttng_buffer_view_is_valid(&view
)) {
1269 ret
= LTTNG_ERR_INVALID
;
1273 if (lttng_channel_create_from_buffer(&view
, &channel
) != channel_len
) {
1274 ERR("Invalid channel payload received in \"enable channel\" command");
1275 ret
= LTTNG_ERR_INVALID
;
1279 ret
= cmd_enable_channel_internal(
1280 cmd_ctx
->session
, &command_domain
, channel
, wpipe
);
1283 lttng_dynamic_buffer_reset(&channel_buffer
);
1284 lttng_channel_destroy(channel
);
1288 static enum lttng_error_code
cmd_enable_channel_internal(
1289 struct ltt_session
*session
,
1290 const struct lttng_domain
*domain
,
1291 const struct lttng_channel
*_attr
,
1294 enum lttng_error_code ret_code
;
1295 struct ltt_ust_session
*usess
= session
->ust_session
;
1296 struct lttng_ht
*chan_ht
;
1298 struct lttng_channel
*attr
= NULL
;
1300 LTTNG_ASSERT(session
);
1301 LTTNG_ASSERT(_attr
);
1302 LTTNG_ASSERT(domain
);
1304 attr
= lttng_channel_copy(_attr
);
1306 ret_code
= LTTNG_ERR_NOMEM
;
1310 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1312 /* Validate channel name */
1313 if (attr
->name
[0] == '.' ||
1314 memchr(attr
->name
, '/', len
) != NULL
) {
1315 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1319 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1324 * If the session is a live session, remove the switch timer, the
1325 * live timer does the same thing but sends also synchronisation
1326 * beacons for inactive streams.
1328 if (session
->live_timer
> 0) {
1329 attr
->attr
.live_timer_interval
= session
->live_timer
;
1330 attr
->attr
.switch_timer_interval
= 0;
1333 /* Check for feature support */
1334 switch (domain
->type
) {
1335 case LTTNG_DOMAIN_KERNEL
:
1337 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1338 /* Sampling position of buffer is not supported */
1339 WARN("Kernel tracer does not support buffer monitoring. "
1340 "Setting the monitor interval timer to 0 "
1341 "(disabled) for channel '%s' of session '%s'",
1342 attr
->name
, session
->name
);
1343 lttng_channel_set_monitor_timer_interval(attr
, 0);
1347 case LTTNG_DOMAIN_UST
:
1349 case LTTNG_DOMAIN_JUL
:
1350 case LTTNG_DOMAIN_LOG4J
:
1351 case LTTNG_DOMAIN_PYTHON
:
1352 if (!agent_tracing_is_enabled()) {
1353 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1354 ret_code
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1359 ret_code
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1363 switch (domain
->type
) {
1364 case LTTNG_DOMAIN_KERNEL
:
1366 struct ltt_kernel_channel
*kchan
;
1368 kchan
= trace_kernel_get_channel_by_name(
1369 attr
->name
, session
->kernel_session
);
1370 if (kchan
== NULL
) {
1372 * Don't try to create a channel if the session has been started at
1373 * some point in time before. The tracer does not allow it.
1375 if (session
->has_been_started
) {
1376 ret_code
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1380 if (session
->snapshot
.nb_output
> 0 ||
1381 session
->snapshot_mode
) {
1382 /* Enforce mmap output for snapshot sessions. */
1383 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
1385 ret_code
= channel_kernel_create(
1386 session
->kernel_session
, attr
, wpipe
);
1387 if (attr
->name
[0] != '\0') {
1388 session
->kernel_session
->has_non_default_channel
= 1;
1391 ret_code
= channel_kernel_enable(session
->kernel_session
, kchan
);
1394 if (ret_code
!= LTTNG_OK
) {
1398 kernel_wait_quiescent();
1401 case LTTNG_DOMAIN_UST
:
1402 case LTTNG_DOMAIN_JUL
:
1403 case LTTNG_DOMAIN_LOG4J
:
1404 case LTTNG_DOMAIN_PYTHON
:
1406 struct ltt_ust_channel
*uchan
;
1411 * Current agent implementation limitations force us to allow
1412 * only one channel at once in "agent" subdomains. Each
1413 * subdomain has a default channel name which must be strictly
1416 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1417 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1418 LTTNG_SYMBOL_NAME_LEN
)) {
1419 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1422 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1423 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1424 LTTNG_SYMBOL_NAME_LEN
)) {
1425 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1428 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1429 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1430 LTTNG_SYMBOL_NAME_LEN
)) {
1431 ret_code
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1436 chan_ht
= usess
->domain_global
.channels
;
1438 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1439 if (uchan
== NULL
) {
1441 * Don't try to create a channel if the session has been started at
1442 * some point in time before. The tracer does not allow it.
1444 if (session
->has_been_started
) {
1445 ret_code
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1449 ret_code
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1450 if (attr
->name
[0] != '\0') {
1451 usess
->has_non_default_channel
= 1;
1454 ret_code
= channel_ust_enable(usess
, uchan
);
1459 ret_code
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1463 if (ret_code
== LTTNG_OK
&& attr
->attr
.output
!= LTTNG_EVENT_MMAP
) {
1464 session
->has_non_mmap_channel
= true;
1469 lttng_channel_destroy(attr
);
1473 enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(
1474 struct ltt_session
*session
,
1475 enum lttng_domain_type domain
,
1476 enum lttng_process_attr process_attr
,
1477 enum lttng_tracking_policy
*policy
)
1479 enum lttng_error_code ret_code
= LTTNG_OK
;
1480 const struct process_attr_tracker
*tracker
;
1483 case LTTNG_DOMAIN_KERNEL
:
1484 if (!session
->kernel_session
) {
1485 ret_code
= LTTNG_ERR_INVALID
;
1488 tracker
= kernel_get_process_attr_tracker(
1489 session
->kernel_session
, process_attr
);
1491 case LTTNG_DOMAIN_UST
:
1492 if (!session
->ust_session
) {
1493 ret_code
= LTTNG_ERR_INVALID
;
1496 tracker
= trace_ust_get_process_attr_tracker(
1497 session
->ust_session
, process_attr
);
1500 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1504 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1506 ret_code
= LTTNG_ERR_INVALID
;
1512 enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(
1513 struct ltt_session
*session
,
1514 enum lttng_domain_type domain
,
1515 enum lttng_process_attr process_attr
,
1516 enum lttng_tracking_policy policy
)
1518 enum lttng_error_code ret_code
= LTTNG_OK
;
1521 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1522 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1523 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1526 ret_code
= LTTNG_ERR_INVALID
;
1531 case LTTNG_DOMAIN_KERNEL
:
1532 if (!session
->kernel_session
) {
1533 ret_code
= LTTNG_ERR_INVALID
;
1536 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1537 session
->kernel_session
, process_attr
, policy
);
1539 case LTTNG_DOMAIN_UST
:
1540 if (!session
->ust_session
) {
1541 ret_code
= LTTNG_ERR_INVALID
;
1544 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1545 session
->ust_session
, process_attr
, policy
);
1548 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1555 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(
1556 struct ltt_session
*session
,
1557 enum lttng_domain_type domain
,
1558 enum lttng_process_attr process_attr
,
1559 const struct process_attr_value
*value
)
1561 enum lttng_error_code ret_code
= LTTNG_OK
;
1564 case LTTNG_DOMAIN_KERNEL
:
1565 if (!session
->kernel_session
) {
1566 ret_code
= LTTNG_ERR_INVALID
;
1569 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1570 session
->kernel_session
, process_attr
, value
);
1572 case LTTNG_DOMAIN_UST
:
1573 if (!session
->ust_session
) {
1574 ret_code
= LTTNG_ERR_INVALID
;
1577 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1578 session
->ust_session
, process_attr
, value
);
1581 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1588 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(
1589 struct ltt_session
*session
,
1590 enum lttng_domain_type domain
,
1591 enum lttng_process_attr process_attr
,
1592 const struct process_attr_value
*value
)
1594 enum lttng_error_code ret_code
= LTTNG_OK
;
1597 case LTTNG_DOMAIN_KERNEL
:
1598 if (!session
->kernel_session
) {
1599 ret_code
= LTTNG_ERR_INVALID
;
1602 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1603 session
->kernel_session
, process_attr
, value
);
1605 case LTTNG_DOMAIN_UST
:
1606 if (!session
->ust_session
) {
1607 ret_code
= LTTNG_ERR_INVALID
;
1610 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1611 session
->ust_session
, process_attr
, value
);
1614 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1621 enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(
1622 struct ltt_session
*session
,
1623 enum lttng_domain_type domain
,
1624 enum lttng_process_attr process_attr
,
1625 struct lttng_process_attr_values
**values
)
1627 enum lttng_error_code ret_code
= LTTNG_OK
;
1628 const struct process_attr_tracker
*tracker
;
1629 enum process_attr_tracker_status status
;
1632 case LTTNG_DOMAIN_KERNEL
:
1633 if (!session
->kernel_session
) {
1634 ret_code
= LTTNG_ERR_INVALID
;
1637 tracker
= kernel_get_process_attr_tracker(
1638 session
->kernel_session
, process_attr
);
1640 case LTTNG_DOMAIN_UST
:
1641 if (!session
->ust_session
) {
1642 ret_code
= LTTNG_ERR_INVALID
;
1645 tracker
= trace_ust_get_process_attr_tracker(
1646 session
->ust_session
, process_attr
);
1649 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1654 ret_code
= LTTNG_ERR_INVALID
;
1658 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1660 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1661 ret_code
= LTTNG_OK
;
1663 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1664 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1666 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1667 ret_code
= LTTNG_ERR_NOMEM
;
1670 ret_code
= LTTNG_ERR_UNK
;
1679 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1681 int cmd_disable_event(struct command_ctx
*cmd_ctx
,
1682 struct lttng_event
*event
,
1683 char *filter_expression
,
1684 struct lttng_bytecode
*bytecode
,
1685 struct lttng_event_exclusion
*exclusion
)
1688 const char *event_name
;
1689 const struct ltt_session
*session
= cmd_ctx
->session
;
1690 const char *channel_name
= cmd_ctx
->lsm
.u
.disable
.channel_name
;
1691 const enum lttng_domain_type domain
= cmd_ctx
->lsm
.domain
.type
;
1693 DBG("Disable event command for event \'%s\'", event
->name
);
1696 * Filter and exclusions are simply not handled by the
1697 * disable event command at this time.
1701 (void) filter_expression
;
1704 /* Ignore the presence of filter or exclusion for the event */
1706 event
->exclusion
= 0;
1708 event_name
= event
->name
;
1710 /* Error out on unhandled search criteria */
1711 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1712 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1713 ret
= LTTNG_ERR_UNK
;
1720 case LTTNG_DOMAIN_KERNEL
:
1722 struct ltt_kernel_channel
*kchan
;
1723 struct ltt_kernel_session
*ksess
;
1725 ksess
= session
->kernel_session
;
1728 * If a non-default channel has been created in the
1729 * session, explicitely require that -c chan_name needs
1732 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1733 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1737 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1738 if (kchan
== NULL
) {
1739 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1743 switch (event
->type
) {
1744 case LTTNG_EVENT_ALL
:
1745 case LTTNG_EVENT_TRACEPOINT
:
1746 case LTTNG_EVENT_SYSCALL
:
1747 case LTTNG_EVENT_PROBE
:
1748 case LTTNG_EVENT_FUNCTION
:
1749 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1750 if (event_name
[0] == '\0') {
1751 ret
= event_kernel_disable_event(kchan
,
1754 ret
= event_kernel_disable_event(kchan
,
1755 event_name
, event
->type
);
1757 if (ret
!= LTTNG_OK
) {
1762 ret
= LTTNG_ERR_UNK
;
1766 kernel_wait_quiescent();
1769 case LTTNG_DOMAIN_UST
:
1771 struct ltt_ust_channel
*uchan
;
1772 struct ltt_ust_session
*usess
;
1774 usess
= session
->ust_session
;
1776 if (validate_ust_event_name(event_name
)) {
1777 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1782 * If a non-default channel has been created in the
1783 * session, explicitly require that -c chan_name needs
1786 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1787 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1791 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1793 if (uchan
== NULL
) {
1794 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1798 switch (event
->type
) {
1799 case LTTNG_EVENT_ALL
:
1801 * An empty event name means that everything
1802 * should be disabled.
1804 if (event
->name
[0] == '\0') {
1805 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1807 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1810 if (ret
!= LTTNG_OK
) {
1815 ret
= LTTNG_ERR_UNK
;
1819 DBG3("Disable UST event %s in channel %s completed", event_name
,
1823 case LTTNG_DOMAIN_LOG4J
:
1824 case LTTNG_DOMAIN_JUL
:
1825 case LTTNG_DOMAIN_PYTHON
:
1828 struct ltt_ust_session
*usess
= session
->ust_session
;
1830 LTTNG_ASSERT(usess
);
1832 switch (event
->type
) {
1833 case LTTNG_EVENT_ALL
:
1836 ret
= LTTNG_ERR_UNK
;
1840 agt
= trace_ust_find_agent(usess
, domain
);
1842 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1846 * An empty event name means that everything
1847 * should be disabled.
1849 if (event
->name
[0] == '\0') {
1850 ret
= event_agent_disable_all(usess
, agt
);
1852 ret
= event_agent_disable(usess
, agt
, event_name
);
1854 if (ret
!= LTTNG_OK
) {
1861 ret
= LTTNG_ERR_UND
;
1872 free(filter_expression
);
1877 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1879 int cmd_add_context(struct command_ctx
*cmd_ctx
,
1880 const struct lttng_event_context
*event_context
, int kwpipe
)
1882 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1883 const enum lttng_domain_type domain
= cmd_ctx
->lsm
.domain
.type
;
1884 const struct ltt_session
*session
= cmd_ctx
->session
;
1885 const char *channel_name
= cmd_ctx
->lsm
.u
.context
.channel_name
;
1888 * Don't try to add a context if the session has been started at
1889 * some point in time before. The tracer does not allow it and would
1890 * result in a corrupted trace.
1892 if (cmd_ctx
->session
->has_been_started
) {
1893 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1898 case LTTNG_DOMAIN_KERNEL
:
1899 LTTNG_ASSERT(session
->kernel_session
);
1901 if (session
->kernel_session
->channel_count
== 0) {
1902 /* Create default channel */
1903 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1904 if (ret
!= LTTNG_OK
) {
1907 chan_kern_created
= 1;
1909 /* Add kernel context to kernel tracer */
1910 ret
= context_kernel_add(session
->kernel_session
,
1911 event_context
, channel_name
);
1912 if (ret
!= LTTNG_OK
) {
1916 case LTTNG_DOMAIN_JUL
:
1917 case LTTNG_DOMAIN_LOG4J
:
1920 * Validate channel name.
1921 * If no channel name is given and the domain is JUL or LOG4J,
1922 * set it to the appropriate domain-specific channel name. If
1923 * a name is provided but does not match the expexted channel
1924 * name, return an error.
1926 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1927 strcmp(channel_name
,
1928 DEFAULT_JUL_CHANNEL_NAME
)) {
1929 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1931 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1932 strcmp(channel_name
,
1933 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1934 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1939 case LTTNG_DOMAIN_UST
:
1941 struct ltt_ust_session
*usess
= session
->ust_session
;
1942 unsigned int chan_count
;
1944 LTTNG_ASSERT(usess
);
1946 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1947 if (chan_count
== 0) {
1948 struct lttng_channel
*attr
;
1949 /* Create default channel */
1950 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1952 ret
= LTTNG_ERR_FATAL
;
1956 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1957 if (ret
!= LTTNG_OK
) {
1961 channel_attr_destroy(attr
);
1962 chan_ust_created
= 1;
1965 ret
= context_ust_add(usess
, domain
, event_context
,
1967 if (ret
!= LTTNG_OK
) {
1973 ret
= LTTNG_ERR_UND
;
1981 if (chan_kern_created
) {
1982 struct ltt_kernel_channel
*kchan
=
1983 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1984 session
->kernel_session
);
1985 /* Created previously, this should NOT fail. */
1986 LTTNG_ASSERT(kchan
);
1987 kernel_destroy_channel(kchan
);
1990 if (chan_ust_created
) {
1991 struct ltt_ust_channel
*uchan
=
1992 trace_ust_find_channel_by_name(
1993 session
->ust_session
->domain_global
.channels
,
1994 DEFAULT_CHANNEL_NAME
);
1995 /* Created previously, this should NOT fail. */
1996 LTTNG_ASSERT(uchan
);
1997 /* Remove from the channel list of the session. */
1998 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2000 trace_ust_destroy_channel(uchan
);
2006 static inline bool name_starts_with(const char *name
, const char *prefix
)
2008 const size_t max_cmp_len
= std::min(strlen(prefix
), (size_t) LTTNG_SYMBOL_NAME_LEN
);
2010 return !strncmp(name
, prefix
, max_cmp_len
);
2013 /* Perform userspace-specific event name validation */
2014 static int validate_ust_event_name(const char *name
)
2024 * Check name against all internal UST event component namespaces used
2027 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2028 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2029 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2038 * Internal version of cmd_enable_event() with a supplemental
2039 * "internal_event" flag which is used to enable internal events which should
2040 * be hidden from clients. Such events are used in the agent implementation to
2041 * enable the events through which all "agent" events are funeled.
2043 static int _cmd_enable_event(struct ltt_session
*session
,
2044 const struct lttng_domain
*domain
,
2045 char *channel_name
, struct lttng_event
*event
,
2046 char *filter_expression
,
2047 struct lttng_bytecode
*filter
,
2048 struct lttng_event_exclusion
*exclusion
,
2049 int wpipe
, bool internal_event
)
2051 int ret
= 0, channel_created
= 0;
2052 struct lttng_channel
*attr
= NULL
;
2054 LTTNG_ASSERT(session
);
2055 LTTNG_ASSERT(event
);
2056 LTTNG_ASSERT(channel_name
);
2058 /* If we have a filter, we must have its filter expression */
2059 LTTNG_ASSERT(!(!!filter_expression
^ !!filter
));
2061 /* Normalize event name as a globbing pattern */
2062 strutils_normalize_star_glob_pattern(event
->name
);
2064 /* Normalize exclusion names as globbing patterns */
2068 for (i
= 0; i
< exclusion
->count
; i
++) {
2069 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2071 strutils_normalize_star_glob_pattern(name
);
2075 DBG("Enable event command for event \'%s\'", event
->name
);
2079 switch (domain
->type
) {
2080 case LTTNG_DOMAIN_KERNEL
:
2082 struct ltt_kernel_channel
*kchan
;
2085 * If a non-default channel has been created in the
2086 * session, explicitely require that -c chan_name needs
2089 if (session
->kernel_session
->has_non_default_channel
2090 && channel_name
[0] == '\0') {
2091 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2095 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2096 session
->kernel_session
);
2097 if (kchan
== NULL
) {
2098 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2099 LTTNG_BUFFER_GLOBAL
);
2101 ret
= LTTNG_ERR_FATAL
;
2104 if (lttng_strncpy(attr
->name
, channel_name
,
2105 sizeof(attr
->name
))) {
2106 ret
= LTTNG_ERR_INVALID
;
2110 ret
= cmd_enable_channel_internal(
2111 session
, domain
, attr
, wpipe
);
2112 if (ret
!= LTTNG_OK
) {
2115 channel_created
= 1;
2118 /* Get the newly created kernel channel pointer */
2119 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2120 session
->kernel_session
);
2121 if (kchan
== NULL
) {
2122 /* This sould not happen... */
2123 ret
= LTTNG_ERR_FATAL
;
2127 switch (event
->type
) {
2128 case LTTNG_EVENT_ALL
:
2130 char *filter_expression_a
= NULL
;
2131 struct lttng_bytecode
*filter_a
= NULL
;
2134 * We need to duplicate filter_expression and filter,
2135 * because ownership is passed to first enable
2138 if (filter_expression
) {
2139 filter_expression_a
= strdup(filter_expression
);
2140 if (!filter_expression_a
) {
2141 ret
= LTTNG_ERR_FATAL
;
2146 filter_a
= zmalloc
<lttng_bytecode
>(sizeof(*filter_a
) + filter
->len
);
2148 free(filter_expression_a
);
2149 ret
= LTTNG_ERR_FATAL
;
2152 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2154 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2155 ret
= event_kernel_enable_event(kchan
, event
,
2156 filter_expression
, filter
);
2157 /* We have passed ownership */
2158 filter_expression
= NULL
;
2160 if (ret
!= LTTNG_OK
) {
2161 if (channel_created
) {
2162 /* Let's not leak a useless channel. */
2163 kernel_destroy_channel(kchan
);
2165 free(filter_expression_a
);
2169 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2170 ret
= event_kernel_enable_event(kchan
, event
,
2171 filter_expression_a
, filter_a
);
2172 /* We have passed ownership */
2173 filter_expression_a
= NULL
;
2175 if (ret
!= LTTNG_OK
) {
2180 case LTTNG_EVENT_PROBE
:
2181 case LTTNG_EVENT_USERSPACE_PROBE
:
2182 case LTTNG_EVENT_FUNCTION
:
2183 case LTTNG_EVENT_FUNCTION_ENTRY
:
2184 case LTTNG_EVENT_TRACEPOINT
:
2185 ret
= event_kernel_enable_event(kchan
, event
,
2186 filter_expression
, filter
);
2187 /* We have passed ownership */
2188 filter_expression
= NULL
;
2190 if (ret
!= LTTNG_OK
) {
2191 if (channel_created
) {
2192 /* Let's not leak a useless channel. */
2193 kernel_destroy_channel(kchan
);
2198 case LTTNG_EVENT_SYSCALL
:
2199 ret
= event_kernel_enable_event(kchan
, event
,
2200 filter_expression
, filter
);
2201 /* We have passed ownership */
2202 filter_expression
= NULL
;
2204 if (ret
!= LTTNG_OK
) {
2209 ret
= LTTNG_ERR_UNK
;
2213 kernel_wait_quiescent();
2216 case LTTNG_DOMAIN_UST
:
2218 struct ltt_ust_channel
*uchan
;
2219 struct ltt_ust_session
*usess
= session
->ust_session
;
2221 LTTNG_ASSERT(usess
);
2224 * If a non-default channel has been created in the
2225 * session, explicitely require that -c chan_name needs
2228 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2229 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2233 /* Get channel from global UST domain */
2234 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2236 if (uchan
== NULL
) {
2237 /* Create default channel */
2238 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2239 usess
->buffer_type
);
2241 ret
= LTTNG_ERR_FATAL
;
2244 if (lttng_strncpy(attr
->name
, channel_name
,
2245 sizeof(attr
->name
))) {
2246 ret
= LTTNG_ERR_INVALID
;
2250 ret
= cmd_enable_channel_internal(
2251 session
, domain
, attr
, wpipe
);
2252 if (ret
!= LTTNG_OK
) {
2256 /* Get the newly created channel reference back */
2257 uchan
= trace_ust_find_channel_by_name(
2258 usess
->domain_global
.channels
, channel_name
);
2259 LTTNG_ASSERT(uchan
);
2262 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2264 * Don't allow users to add UST events to channels which
2265 * are assigned to a userspace subdomain (JUL, Log4J,
2268 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2272 if (!internal_event
) {
2274 * Ensure the event name is not reserved for internal
2277 ret
= validate_ust_event_name(event
->name
);
2279 WARN("Userspace event name %s failed validation.",
2281 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2286 /* At this point, the session and channel exist on the tracer */
2287 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2288 filter_expression
, filter
, exclusion
,
2290 /* We have passed ownership */
2291 filter_expression
= NULL
;
2294 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2295 goto already_enabled
;
2296 } else if (ret
!= LTTNG_OK
) {
2301 case LTTNG_DOMAIN_LOG4J
:
2302 case LTTNG_DOMAIN_JUL
:
2303 case LTTNG_DOMAIN_PYTHON
:
2305 const char *default_event_name
, *default_chan_name
;
2307 struct lttng_event uevent
;
2308 struct lttng_domain tmp_dom
;
2309 struct ltt_ust_session
*usess
= session
->ust_session
;
2311 LTTNG_ASSERT(usess
);
2313 if (!agent_tracing_is_enabled()) {
2314 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2315 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2319 agt
= trace_ust_find_agent(usess
, domain
->type
);
2321 agt
= agent_create(domain
->type
);
2323 ret
= LTTNG_ERR_NOMEM
;
2326 agent_add(agt
, usess
->agents
);
2329 /* Create the default tracepoint. */
2330 memset(&uevent
, 0, sizeof(uevent
));
2331 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2332 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2333 default_event_name
= event_get_default_agent_ust_name(
2335 if (!default_event_name
) {
2336 ret
= LTTNG_ERR_FATAL
;
2339 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2340 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2343 * The domain type is changed because we are about to enable the
2344 * default channel and event for the JUL domain that are hardcoded.
2345 * This happens in the UST domain.
2347 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2348 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2350 switch (domain
->type
) {
2351 case LTTNG_DOMAIN_LOG4J
:
2352 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2354 case LTTNG_DOMAIN_JUL
:
2355 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2357 case LTTNG_DOMAIN_PYTHON
:
2358 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2361 /* The switch/case we are in makes this impossible */
2366 char *filter_expression_copy
= NULL
;
2367 struct lttng_bytecode
*filter_copy
= NULL
;
2370 const size_t filter_size
= sizeof(
2371 struct lttng_bytecode
)
2374 filter_copy
= zmalloc
<lttng_bytecode
>(filter_size
);
2376 ret
= LTTNG_ERR_NOMEM
;
2379 memcpy(filter_copy
, filter
, filter_size
);
2381 filter_expression_copy
=
2382 strdup(filter_expression
);
2383 if (!filter_expression
) {
2384 ret
= LTTNG_ERR_NOMEM
;
2387 if (!filter_expression_copy
|| !filter_copy
) {
2388 free(filter_expression_copy
);
2394 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2395 (char *) default_chan_name
,
2396 &uevent
, filter_expression_copy
,
2397 filter_copy
, NULL
, wpipe
);
2400 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2401 goto already_enabled
;
2402 } else if (ret
!= LTTNG_OK
) {
2406 /* The wild card * means that everything should be enabled. */
2407 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2408 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2411 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2415 filter_expression
= NULL
;
2416 if (ret
!= LTTNG_OK
) {
2423 ret
= LTTNG_ERR_UND
;
2431 free(filter_expression
);
2434 channel_attr_destroy(attr
);
2440 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2441 * We own filter, exclusion, and filter_expression.
2443 int cmd_enable_event(struct command_ctx
*cmd_ctx
,
2444 struct lttng_event
*event
,
2445 char *filter_expression
,
2446 struct lttng_event_exclusion
*exclusion
,
2447 struct lttng_bytecode
*bytecode
,
2452 * Copied to ensure proper alignment since 'lsm' is a packed structure.
2454 const lttng_domain command_domain
= cmd_ctx
->lsm
.domain
;
2457 * The ownership of the following parameters is transferred to
2458 * _cmd_enable_event:
2460 * - filter_expression,
2464 ret
= _cmd_enable_event(cmd_ctx
->session
,
2466 cmd_ctx
->lsm
.u
.enable
.channel_name
, event
,
2467 filter_expression
, bytecode
, exclusion
, wpipe
, false);
2468 filter_expression
= NULL
;
2475 * Enable an event which is internal to LTTng. An internal should
2476 * never be made visible to clients and are immune to checks such as
2479 static int cmd_enable_event_internal(struct ltt_session
*session
,
2480 const struct lttng_domain
*domain
,
2481 char *channel_name
, struct lttng_event
*event
,
2482 char *filter_expression
,
2483 struct lttng_bytecode
*filter
,
2484 struct lttng_event_exclusion
*exclusion
,
2487 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2488 filter_expression
, filter
, exclusion
, wpipe
, true);
2492 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2494 enum lttng_error_code
cmd_list_tracepoints(enum lttng_domain_type domain
,
2495 struct lttng_payload
*reply_payload
)
2497 enum lttng_error_code ret_code
;
2499 ssize_t i
, nb_events
= 0;
2500 struct lttng_event
*events
= NULL
;
2501 struct lttcomm_list_command_header reply_command_header
= {};
2502 size_t reply_command_header_offset
;
2504 assert(reply_payload
);
2506 /* Reserve space for command reply header. */
2507 reply_command_header_offset
= reply_payload
->buffer
.size
;
2508 ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
2509 reply_command_header_offset
+
2510 sizeof(struct lttcomm_list_command_header
));
2512 ret_code
= LTTNG_ERR_NOMEM
;
2517 case LTTNG_DOMAIN_KERNEL
:
2518 nb_events
= kernel_list_events(&events
);
2519 if (nb_events
< 0) {
2520 ret_code
= LTTNG_ERR_KERN_LIST_FAIL
;
2524 case LTTNG_DOMAIN_UST
:
2525 nb_events
= ust_app_list_events(&events
);
2526 if (nb_events
< 0) {
2527 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2531 case LTTNG_DOMAIN_LOG4J
:
2532 case LTTNG_DOMAIN_JUL
:
2533 case LTTNG_DOMAIN_PYTHON
:
2534 nb_events
= agent_list_events(&events
, domain
);
2535 if (nb_events
< 0) {
2536 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2541 ret_code
= LTTNG_ERR_UND
;
2545 for (i
= 0; i
< nb_events
; i
++) {
2546 ret
= lttng_event_serialize(&events
[i
], 0, NULL
, NULL
, 0, NULL
,
2549 ret_code
= LTTNG_ERR_NOMEM
;
2554 if (nb_events
> UINT32_MAX
) {
2555 ERR("Tracepoint count would overflow the tracepoint listing command's reply");
2556 ret_code
= LTTNG_ERR_OVERFLOW
;
2560 /* Update command reply header. */
2561 reply_command_header
.count
= (uint32_t) nb_events
;
2562 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
2563 sizeof(reply_command_header
));
2565 ret_code
= LTTNG_OK
;
2572 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2574 enum lttng_error_code
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2575 struct lttng_payload
*reply
)
2577 enum lttng_error_code ret_code
;
2579 unsigned int i
, nb_fields
;
2580 struct lttng_event_field
*fields
= NULL
;
2581 struct lttcomm_list_command_header reply_command_header
= {};
2582 size_t reply_command_header_offset
;
2586 /* Reserve space for command reply header. */
2587 reply_command_header_offset
= reply
->buffer
.size
;
2588 ret
= lttng_dynamic_buffer_set_size(&reply
->buffer
,
2589 reply_command_header_offset
+
2590 sizeof(struct lttcomm_list_command_header
));
2592 ret_code
= LTTNG_ERR_NOMEM
;
2597 case LTTNG_DOMAIN_UST
:
2598 ret
= ust_app_list_event_fields(&fields
);
2600 ret_code
= LTTNG_ERR_UST_LIST_FAIL
;
2605 case LTTNG_DOMAIN_KERNEL
:
2606 default: /* fall-through */
2607 ret_code
= LTTNG_ERR_UND
;
2613 for (i
= 0; i
< nb_fields
; i
++) {
2614 ret
= lttng_event_field_serialize(&fields
[i
], reply
);
2616 ret_code
= LTTNG_ERR_NOMEM
;
2621 if (nb_fields
> UINT32_MAX
) {
2622 ERR("Tracepoint field count would overflow the tracepoint field listing command's reply");
2623 ret_code
= LTTNG_ERR_OVERFLOW
;
2627 /* Update command reply header. */
2628 reply_command_header
.count
= (uint32_t) nb_fields
;
2630 memcpy(reply
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
2631 sizeof(reply_command_header
));
2633 ret_code
= LTTNG_OK
;
2640 enum lttng_error_code
cmd_list_syscalls(
2641 struct lttng_payload
*reply_payload
)
2643 enum lttng_error_code ret_code
;
2644 ssize_t nb_events
, i
;
2646 struct lttng_event
*events
= NULL
;
2647 struct lttcomm_list_command_header reply_command_header
= {};
2648 size_t reply_command_header_offset
;
2650 assert(reply_payload
);
2652 /* Reserve space for command reply header. */
2653 reply_command_header_offset
= reply_payload
->buffer
.size
;
2654 ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
2655 reply_command_header_offset
+
2656 sizeof(struct lttcomm_list_command_header
));
2658 ret_code
= LTTNG_ERR_NOMEM
;
2662 nb_events
= syscall_table_list(&events
);
2663 if (nb_events
< 0) {
2664 ret_code
= (enum lttng_error_code
) -nb_events
;
2668 for (i
= 0; i
< nb_events
; i
++) {
2669 ret
= lttng_event_serialize(&events
[i
], 0, NULL
, NULL
, 0, NULL
,
2672 ret_code
= LTTNG_ERR_NOMEM
;
2677 if (nb_events
> UINT32_MAX
) {
2678 ERR("Syscall count would overflow the syscall listing command's reply");
2679 ret_code
= LTTNG_ERR_OVERFLOW
;
2683 /* Update command reply header. */
2684 reply_command_header
.count
= (uint32_t) nb_events
;
2685 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
2686 sizeof(reply_command_header
));
2688 ret_code
= LTTNG_OK
;
2695 * Command LTTNG_START_TRACE processed by the client thread.
2697 * Called with session mutex held.
2699 int cmd_start_trace(struct ltt_session
*session
)
2701 enum lttng_error_code ret
;
2702 unsigned long nb_chan
= 0;
2703 struct ltt_kernel_session
*ksession
;
2704 struct ltt_ust_session
*usess
;
2705 const bool session_rotated_after_last_stop
=
2706 session
->rotated_after_last_stop
;
2707 const bool session_cleared_after_last_stop
=
2708 session
->cleared_after_last_stop
;
2710 LTTNG_ASSERT(session
);
2712 /* Ease our life a bit ;) */
2713 ksession
= session
->kernel_session
;
2714 usess
= session
->ust_session
;
2716 /* Is the session already started? */
2717 if (session
->active
) {
2718 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2719 /* Perform nothing */
2723 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2724 !session
->current_trace_chunk
) {
2726 * A rotation was launched while the session was stopped and
2727 * it has not been completed yet. It is not possible to start
2728 * the session since starting the session here would require a
2729 * rotation from "NULL" to a new trace chunk. That rotation
2730 * would overlap with the ongoing rotation, which is not
2733 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2735 ret
= LTTNG_ERR_ROTATION_PENDING
;
2740 * Starting a session without channel is useless since after that it's not
2741 * possible to enable channel thus inform the client.
2743 if (usess
&& usess
->domain_global
.channels
) {
2744 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2747 nb_chan
+= ksession
->channel_count
;
2750 ret
= LTTNG_ERR_NO_CHANNEL
;
2754 session
->active
= true;
2755 session
->rotated_after_last_stop
= false;
2756 session
->cleared_after_last_stop
= false;
2757 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2758 if (!session
->has_been_started
) {
2759 struct lttng_trace_chunk
*trace_chunk
;
2761 DBG("Creating initial trace chunk of session \"%s\"",
2763 trace_chunk
= session_create_new_trace_chunk(
2764 session
, NULL
, NULL
, NULL
);
2766 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2769 LTTNG_ASSERT(!session
->current_trace_chunk
);
2770 ret
= (lttng_error_code
) session_set_trace_chunk(session
, trace_chunk
,
2772 lttng_trace_chunk_put(trace_chunk
);
2774 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2778 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2781 * Rotate existing streams into the new chunk.
2782 * This is a "quiet" rotation has no client has
2783 * explicitly requested this operation.
2785 * There is also no need to wait for the rotation
2786 * to complete as it will happen immediately. No data
2787 * was produced as the session was stopped, so the
2788 * rotation should happen on reception of the command.
2790 ret
= (lttng_error_code
) cmd_rotate_session(session
, NULL
, true,
2791 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2792 if (ret
!= LTTNG_OK
) {
2798 /* Kernel tracing */
2799 if (ksession
!= NULL
) {
2800 DBG("Start kernel tracing session %s", session
->name
);
2801 ret
= (lttng_error_code
) start_kernel_session(ksession
);
2802 if (ret
!= LTTNG_OK
) {
2807 /* Flag session that trace should start automatically */
2809 int int_ret
= ust_app_start_trace_all(usess
);
2812 ret
= LTTNG_ERR_UST_START_FAIL
;
2818 * Open a packet in every stream of the session to ensure that viewers
2819 * can correctly identify the boundaries of the periods during which
2820 * tracing was active for this session.
2822 ret
= session_open_packets(session
);
2823 if (ret
!= LTTNG_OK
) {
2828 * Clear the flag that indicates that a rotation was done while the
2829 * session was stopped.
2831 session
->rotated_after_last_stop
= false;
2833 if (session
->rotate_timer_period
&& !session
->rotation_schedule_timer_enabled
) {
2834 int int_ret
= timer_session_rotation_schedule_timer_start(
2835 session
, session
->rotate_timer_period
);
2838 ERR("Failed to enable rotate timer");
2839 ret
= LTTNG_ERR_UNK
;
2847 if (ret
== LTTNG_OK
) {
2848 /* Flag this after a successful start. */
2849 session
->has_been_started
= true;
2851 session
->active
= false;
2852 /* Restore initial state on error. */
2853 session
->rotated_after_last_stop
=
2854 session_rotated_after_last_stop
;
2855 session
->cleared_after_last_stop
=
2856 session_cleared_after_last_stop
;
2863 * Command LTTNG_STOP_TRACE processed by the client thread.
2865 int cmd_stop_trace(struct ltt_session
*session
)
2868 struct ltt_kernel_session
*ksession
;
2869 struct ltt_ust_session
*usess
;
2871 LTTNG_ASSERT(session
);
2873 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2875 ksession
= session
->kernel_session
;
2876 usess
= session
->ust_session
;
2878 /* Session is not active. Skip everything and inform the client. */
2879 if (!session
->active
) {
2880 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2884 ret
= stop_kernel_session(ksession
);
2885 if (ret
!= LTTNG_OK
) {
2889 if (usess
&& usess
->active
) {
2890 ret
= ust_app_stop_trace_all(usess
);
2892 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2897 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2899 /* Flag inactive after a successful stop. */
2900 session
->active
= 0;
2908 * Set the base_path of the session only if subdir of a control uris is set.
2909 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2911 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2913 struct lttng_uri
*uris
)
2918 for (i
= 0; i
< nb_uri
; i
++) {
2919 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2920 uris
[i
].subdir
[0] == '\0') {
2921 /* Not interested in these URIs */
2925 if (session
->base_path
!= NULL
) {
2926 free(session
->base_path
);
2927 session
->base_path
= NULL
;
2930 /* Set session base_path */
2931 session
->base_path
= strdup(uris
[i
].subdir
);
2932 if (!session
->base_path
) {
2933 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2934 uris
[i
].subdir
, session
->name
);
2935 ret
= LTTNG_ERR_NOMEM
;
2938 DBG2("Setting base path \"%s\" for session \"%s\"",
2939 session
->base_path
, session
->name
);
2947 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2949 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2950 struct lttng_uri
*uris
)
2953 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2954 struct ltt_ust_session
*usess
= session
->ust_session
;
2956 LTTNG_ASSERT(session
);
2958 LTTNG_ASSERT(nb_uri
> 0);
2960 /* Can't set consumer URI if the session is active. */
2961 if (session
->active
) {
2962 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2967 * Set the session base path if any. This is done inside
2968 * cmd_set_consumer_uri to preserve backward compatibility of the
2969 * previous session creation api vs the session descriptor api.
2971 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2972 if (ret
!= LTTNG_OK
) {
2976 /* Set the "global" consumer URIs */
2977 for (i
= 0; i
< nb_uri
; i
++) {
2978 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2980 if (ret
!= LTTNG_OK
) {
2985 /* Set UST session URIs */
2986 if (session
->ust_session
) {
2987 for (i
= 0; i
< nb_uri
; i
++) {
2988 ret
= add_uri_to_consumer(session
,
2989 session
->ust_session
->consumer
,
2990 &uris
[i
], LTTNG_DOMAIN_UST
);
2991 if (ret
!= LTTNG_OK
) {
2997 /* Set kernel session URIs */
2998 if (session
->kernel_session
) {
2999 for (i
= 0; i
< nb_uri
; i
++) {
3000 ret
= add_uri_to_consumer(session
,
3001 session
->kernel_session
->consumer
,
3002 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
3003 if (ret
!= LTTNG_OK
) {
3010 * Make sure to set the session in output mode after we set URI since a
3011 * session can be created without URL (thus flagged in no output mode).
3013 session
->output_traces
= 1;
3015 ksess
->output_traces
= 1;
3019 usess
->output_traces
= 1;
3030 enum lttng_error_code
set_session_output_from_descriptor(
3031 struct ltt_session
*session
,
3032 const struct lttng_session_descriptor
*descriptor
)
3035 enum lttng_error_code ret_code
= LTTNG_OK
;
3036 enum lttng_session_descriptor_type session_type
=
3037 lttng_session_descriptor_get_type(descriptor
);
3038 enum lttng_session_descriptor_output_type output_type
=
3039 lttng_session_descriptor_get_output_type(descriptor
);
3040 struct lttng_uri uris
[2] = {};
3041 size_t uri_count
= 0;
3043 switch (output_type
) {
3044 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
3046 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
3047 lttng_session_descriptor_get_local_output_uri(descriptor
,
3051 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3052 lttng_session_descriptor_get_network_output_uris(descriptor
,
3053 &uris
[0], &uris
[1]);
3057 ret_code
= LTTNG_ERR_INVALID
;
3061 switch (session_type
) {
3062 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3064 struct snapshot_output
*new_output
= NULL
;
3066 new_output
= snapshot_output_alloc();
3068 ret_code
= LTTNG_ERR_NOMEM
;
3072 ret
= snapshot_output_init_with_uri(session
,
3073 DEFAULT_SNAPSHOT_MAX_SIZE
,
3074 NULL
, uris
, uri_count
, session
->consumer
,
3075 new_output
, &session
->snapshot
);
3077 ret_code
= (ret
== -ENOMEM
) ?
3078 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3079 snapshot_output_destroy(new_output
);
3082 snapshot_add_output(&session
->snapshot
, new_output
);
3085 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3086 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3088 ret_code
= (lttng_error_code
) cmd_set_consumer_uri(session
, uri_count
, uris
);
3092 ret_code
= LTTNG_ERR_INVALID
;
3100 enum lttng_error_code
cmd_create_session_from_descriptor(
3101 struct lttng_session_descriptor
*descriptor
,
3102 const lttng_sock_cred
*creds
,
3103 const char *home_path
)
3106 enum lttng_error_code ret_code
;
3107 const char *session_name
;
3108 struct ltt_session
*new_session
= NULL
;
3109 enum lttng_session_descriptor_status descriptor_status
;
3111 session_lock_list();
3113 if (*home_path
!= '/') {
3114 ERR("Home path provided by client is not absolute");
3115 ret_code
= LTTNG_ERR_INVALID
;
3120 descriptor_status
= lttng_session_descriptor_get_session_name(
3121 descriptor
, &session_name
);
3122 switch (descriptor_status
) {
3123 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3125 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3126 session_name
= NULL
;
3129 ret_code
= LTTNG_ERR_INVALID
;
3133 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3135 if (ret_code
!= LTTNG_OK
) {
3139 ret_code
= notification_thread_command_add_session(the_notification_thread_handle
,
3140 new_session
->id
, new_session
->name
, new_session
->uid
, new_session
->gid
);
3141 if (ret_code
!= LTTNG_OK
) {
3145 /* Announce the session's destruction to the notification thread when it is destroyed. */
3146 ret
= session_add_destroy_notifier(
3148 [](const struct ltt_session
*session
,
3149 void *user_data
__attribute__((unused
))) {
3150 (void) notification_thread_command_remove_session(
3151 the_notification_thread_handle
, session
->id
);
3155 PERROR("Failed to add notification thread command to session's destroy notifiers: session name = %s",
3157 ret
= LTTNG_ERR_NOMEM
;
3161 if (!session_name
) {
3162 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3165 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3170 if (!lttng_session_descriptor_is_output_destination_initialized(
3173 * Only include the session's creation time in the output
3174 * destination if the name of the session itself was
3175 * not auto-generated.
3177 ret_code
= lttng_session_descriptor_set_default_output(
3179 session_name
? &new_session
->creation_time
: NULL
,
3181 if (ret_code
!= LTTNG_OK
) {
3185 new_session
->has_user_specified_directory
=
3186 lttng_session_descriptor_has_output_directory(
3190 switch (lttng_session_descriptor_get_type(descriptor
)) {
3191 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3192 new_session
->snapshot_mode
= 1;
3194 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3195 new_session
->live_timer
=
3196 lttng_session_descriptor_live_get_timer_interval(
3203 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3204 if (ret_code
!= LTTNG_OK
) {
3207 new_session
->consumer
->enabled
= 1;
3208 ret_code
= LTTNG_OK
;
3210 /* Release reference provided by the session_create function. */
3211 session_put(new_session
);
3212 if (ret_code
!= LTTNG_OK
&& new_session
) {
3213 /* Release the global reference on error. */
3214 session_destroy(new_session
);
3216 session_unlock_list();
3220 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3221 struct lttng_session_descriptor
**return_descriptor
)
3224 size_t payload_size
;
3225 struct lttng_dynamic_buffer payload
;
3226 struct lttng_buffer_view home_dir_view
;
3227 struct lttng_buffer_view session_descriptor_view
;
3228 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3229 enum lttng_error_code ret_code
;
3231 lttng_dynamic_buffer_init(&payload
);
3232 if (cmd_ctx
->lsm
.u
.create_session
.home_dir_size
>=
3234 ret_code
= LTTNG_ERR_INVALID
;
3237 if (cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
>
3238 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3239 ret_code
= LTTNG_ERR_INVALID
;
3243 payload_size
= cmd_ctx
->lsm
.u
.create_session
.home_dir_size
+
3244 cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
;
3245 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3247 ret_code
= LTTNG_ERR_NOMEM
;
3251 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3253 ERR("Reception of session descriptor failed, aborting.");
3254 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3258 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3261 cmd_ctx
->lsm
.u
.create_session
.home_dir_size
);
3262 if (cmd_ctx
->lsm
.u
.create_session
.home_dir_size
> 0 &&
3263 !lttng_buffer_view_is_valid(&home_dir_view
)) {
3264 ERR("Invalid payload in \"create session\" command: buffer too short to contain home directory");
3265 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3269 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3271 cmd_ctx
->lsm
.u
.create_session
.home_dir_size
,
3272 cmd_ctx
->lsm
.u
.create_session
.session_descriptor_size
);
3273 if (!lttng_buffer_view_is_valid(&session_descriptor_view
)) {
3274 ERR("Invalid payload in \"create session\" command: buffer too short to contain session descriptor");
3275 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3279 ret
= lttng_session_descriptor_create_from_buffer(
3280 &session_descriptor_view
, &session_descriptor
);
3282 ERR("Failed to create session descriptor from payload of \"create session\" command");
3283 ret_code
= LTTNG_ERR_INVALID
;
3288 * Sets the descriptor's auto-generated properties (name, output) if
3291 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3293 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3294 if (ret_code
!= LTTNG_OK
) {
3298 ret_code
= LTTNG_OK
;
3299 *return_descriptor
= session_descriptor
;
3300 session_descriptor
= NULL
;
3302 lttng_dynamic_buffer_reset(&payload
);
3303 lttng_session_descriptor_destroy(session_descriptor
);
3308 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3309 void *_reply_context
)
3313 const struct cmd_destroy_session_reply_context
*reply_context
=
3314 (cmd_destroy_session_reply_context
*) _reply_context
;
3315 struct lttng_dynamic_buffer payload
;
3316 struct lttcomm_session_destroy_command_header cmd_header
;
3317 struct lttng_trace_archive_location
*location
= NULL
;
3318 struct lttcomm_lttng_msg llm
= {
3319 .cmd_type
= LTTNG_DESTROY_SESSION
,
3320 .ret_code
= reply_context
->destruction_status
,
3323 sizeof(struct lttcomm_session_destroy_command_header
),
3327 size_t payload_size_before_location
;
3329 lttng_dynamic_buffer_init(&payload
);
3331 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3333 ERR("Failed to append session destruction message");
3337 cmd_header
.rotation_state
=
3338 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3339 session
->rotation_state
:
3340 LTTNG_ROTATION_STATE_NO_ROTATION
);
3341 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3342 sizeof(cmd_header
));
3344 ERR("Failed to append session destruction command header");
3348 if (!reply_context
->implicit_rotation_on_destroy
) {
3349 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3353 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3354 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3359 location
= session_get_trace_archive_location(session
);
3361 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3366 payload_size_before_location
= payload
.size
;
3367 comm_ret
= lttng_trace_archive_location_serialize(location
,
3369 lttng_trace_archive_location_put(location
);
3371 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3375 /* Update the message to indicate the location's length. */
3376 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3377 payload
.size
- payload_size_before_location
;
3379 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3380 payload
.data
, payload
.size
);
3381 if (comm_ret
!= (ssize_t
) payload
.size
) {
3382 ERR("Failed to send result of the destruction of session \"%s\" to client",
3386 ret
= close(reply_context
->reply_sock_fd
);
3388 PERROR("Failed to close client socket in deferred session destroy reply");
3390 lttng_dynamic_buffer_reset(&payload
);
3391 free(_reply_context
);
3395 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3397 * Called with session lock held.
3399 int cmd_destroy_session(struct ltt_session
*session
,
3400 struct notification_thread_handle
*notification_thread_handle
,
3404 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3405 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3408 reply_context
= zmalloc
<cmd_destroy_session_reply_context
>();
3409 if (!reply_context
) {
3410 ret
= LTTNG_ERR_NOMEM
;
3414 reply_context
->reply_sock_fd
= *sock_fd
;
3418 LTTNG_ASSERT(session
);
3420 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3422 if (session
->active
) {
3423 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3425 ret
= cmd_stop_trace(session
);
3426 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3427 /* Carry on with the destruction of the session. */
3428 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3429 session
->name
, lttng_strerror(-ret
));
3430 destruction_last_error
= (lttng_error_code
) ret
;
3434 if (session
->rotation_schedule_timer_enabled
) {
3435 if (timer_session_rotation_schedule_timer_stop(
3437 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3439 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3443 if (session
->rotate_size
) {
3444 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3445 session
->rotate_size
= 0;
3448 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3450 * Perform a last rotation on destruction if rotations have
3451 * occurred during the session's lifetime.
3453 ret
= cmd_rotate_session(session
, NULL
, false,
3454 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3455 if (ret
!= LTTNG_OK
) {
3456 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3457 session
->name
, lttng_strerror(-ret
));
3458 destruction_last_error
= (lttng_error_code
) -ret
;
3460 if (reply_context
) {
3461 reply_context
->implicit_rotation_on_destroy
= true;
3463 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3465 * The user has not triggered a session rotation. However, to
3466 * ensure all data has been consumed, the session is rotated
3467 * to a 'null' trace chunk before it is destroyed.
3469 * This is a "quiet" rotation meaning that no notification is
3470 * emitted and no renaming of the current trace chunk takes
3473 ret
= cmd_rotate_session(session
, NULL
, true,
3474 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3476 * Rotation operations may not be supported by the kernel
3477 * tracer. Hence, do not consider this implicit rotation as
3478 * a session destruction error. The library has already stopped
3479 * the session and waited for pending data; there is nothing
3480 * left to do but complete the destruction of the session.
3482 if (ret
!= LTTNG_OK
&&
3483 ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3484 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3485 session
->name
, lttng_strerror(ret
));
3486 destruction_last_error
= (lttng_error_code
) -ret
;
3490 if (session
->shm_path
[0]) {
3492 * When a session is created with an explicit shm_path,
3493 * the consumer daemon will create its shared memory files
3494 * at that location and will *not* unlink them. This is normal
3495 * as the intention of that feature is to make it possible
3496 * to retrieve the content of those files should a crash occur.
3498 * To ensure the content of those files can be used, the
3499 * sessiond daemon will replicate the content of the metadata
3500 * cache in a metadata file.
3502 * On clean-up, it is expected that the consumer daemon will
3503 * unlink the shared memory files and that the session daemon
3504 * will unlink the metadata file. Then, the session's directory
3505 * in the shm path can be removed.
3507 * Unfortunately, a flaw in the design of the sessiond's and
3508 * consumerd's tear down of channels makes it impossible to
3509 * determine when the sessiond _and_ the consumerd have both
3510 * destroyed their representation of a channel. For one, the
3511 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3512 * callbacks in both daemons.
3514 * However, it is also impossible for the sessiond to know when
3515 * the consumer daemon is done destroying its channel(s) since
3516 * it occurs as a reaction to the closing of the channel's file
3517 * descriptor. There is no resulting communication initiated
3518 * from the consumerd to the sessiond to confirm that the
3519 * operation is completed (and was successful).
3521 * Until this is all fixed, the session daemon checks for the
3522 * removal of the session's shm path which makes it possible
3523 * to safely advertise a session as having been destroyed.
3525 * Prior to this fix, it was not possible to reliably save
3526 * a session making use of the --shm-path option, destroy it,
3527 * and load it again. This is because the creation of the
3528 * session would fail upon seeing the session's shm path
3529 * already in existence.
3531 * Note that none of the error paths in the check for the
3532 * directory's existence return an error. This is normal
3533 * as there isn't much that can be done. The session will
3534 * be destroyed properly, except that we can't offer the
3535 * guarantee that the same session can be re-created.
3537 current_completion_handler
= &destroy_completion_handler
.handler
;
3538 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3540 sizeof(destroy_completion_handler
.shm_path
));
3545 * The session is destroyed. However, note that the command context
3546 * still holds a reference to the session, thus delaying its destruction
3547 * _at least_ up to the point when that reference is released.
3549 session_destroy(session
);
3550 if (reply_context
) {
3551 reply_context
->destruction_status
= destruction_last_error
;
3552 ret
= session_add_destroy_notifier(session
,
3553 cmd_destroy_session_reply
,
3554 (void *) reply_context
);
3556 ret
= LTTNG_ERR_FATAL
;
3568 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3570 int cmd_register_consumer(struct ltt_session
*session
,
3571 enum lttng_domain_type domain
, const char *sock_path
,
3572 struct consumer_data
*cdata
)
3575 struct consumer_socket
*socket
= NULL
;
3577 LTTNG_ASSERT(session
);
3578 LTTNG_ASSERT(cdata
);
3579 LTTNG_ASSERT(sock_path
);
3582 case LTTNG_DOMAIN_KERNEL
:
3584 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3586 LTTNG_ASSERT(ksess
);
3588 /* Can't register a consumer if there is already one */
3589 if (ksess
->consumer_fds_sent
!= 0) {
3590 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3594 sock
= lttcomm_connect_unix_sock(sock_path
);
3596 ret
= LTTNG_ERR_CONNECT_FAIL
;
3599 cdata
->cmd_sock
= sock
;
3601 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3602 if (socket
== NULL
) {
3605 PERROR("close register consumer");
3607 cdata
->cmd_sock
= -1;
3608 ret
= LTTNG_ERR_FATAL
;
3612 socket
->lock
= zmalloc
<pthread_mutex_t
>();
3613 if (socket
->lock
== NULL
) {
3614 PERROR("zmalloc pthread mutex");
3615 ret
= LTTNG_ERR_FATAL
;
3619 pthread_mutex_init(socket
->lock
, NULL
);
3620 socket
->registered
= 1;
3623 consumer_add_socket(socket
, ksess
->consumer
);
3626 pthread_mutex_lock(&cdata
->pid_mutex
);
3628 pthread_mutex_unlock(&cdata
->pid_mutex
);
3633 /* TODO: Userspace tracing */
3634 ret
= LTTNG_ERR_UND
;
3642 consumer_destroy_socket(socket
);
3648 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3650 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3651 struct lttng_domain
**domains
)
3656 struct lttng_ht_iter iter
;
3658 if (session
->kernel_session
!= NULL
) {
3659 DBG3("Listing domains found kernel domain");
3663 if (session
->ust_session
!= NULL
) {
3664 DBG3("Listing domains found UST global domain");
3668 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3670 if (agt
->being_used
) {
3681 *domains
= calloc
<lttng_domain
>(nb_dom
);
3682 if (*domains
== NULL
) {
3683 ret
= LTTNG_ERR_FATAL
;
3687 if (session
->kernel_session
!= NULL
) {
3688 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3690 /* Kernel session buffer type is always GLOBAL */
3691 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3696 if (session
->ust_session
!= NULL
) {
3697 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3698 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3702 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3704 if (agt
->being_used
) {
3705 (*domains
)[index
].type
= agt
->domain
;
3706 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3716 /* Return negative value to differentiate return code */
3722 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3724 enum lttng_error_code
cmd_list_channels(enum lttng_domain_type domain
,
3725 struct ltt_session
*session
,
3726 struct lttng_payload
*payload
)
3730 struct lttcomm_list_command_header cmd_header
= {};
3731 size_t cmd_header_offset
;
3732 enum lttng_error_code ret_code
;
3737 DBG("Listing channels for session %s", session
->name
);
3739 cmd_header_offset
= payload
->buffer
.size
;
3741 /* Reserve space for command reply header. */
3742 ret
= lttng_dynamic_buffer_set_size(&payload
->buffer
,
3743 cmd_header_offset
+ sizeof(cmd_header
));
3745 ret_code
= LTTNG_ERR_NOMEM
;
3750 case LTTNG_DOMAIN_KERNEL
:
3752 /* Kernel channels */
3753 struct ltt_kernel_channel
*kchan
;
3754 if (session
->kernel_session
!= NULL
) {
3755 cds_list_for_each_entry(kchan
,
3756 &session
->kernel_session
->channel_list
.head
, list
) {
3757 uint64_t discarded_events
, lost_packets
;
3758 struct lttng_channel_extended
*extended
;
3760 extended
= (struct lttng_channel_extended
*)
3761 kchan
->channel
->attr
.extended
.ptr
;
3763 ret
= get_kernel_runtime_stats(session
, kchan
,
3764 &discarded_events
, &lost_packets
);
3766 ret_code
= LTTNG_ERR_UNK
;
3771 * Update the discarded_events and lost_packets
3772 * count for the channel
3774 extended
->discarded_events
= discarded_events
;
3775 extended
->lost_packets
= lost_packets
;
3777 ret
= lttng_channel_serialize(
3778 kchan
->channel
, &payload
->buffer
);
3780 ERR("Failed to serialize lttng_channel: channel name = '%s'",
3781 kchan
->channel
->name
);
3782 ret_code
= LTTNG_ERR_UNK
;
3791 case LTTNG_DOMAIN_UST
:
3793 struct lttng_ht_iter iter
;
3794 struct ltt_ust_channel
*uchan
;
3797 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
3798 &iter
.iter
, uchan
, node
.node
) {
3799 uint64_t discarded_events
= 0, lost_packets
= 0;
3800 struct lttng_channel
*channel
= NULL
;
3801 struct lttng_channel_extended
*extended
;
3803 channel
= trace_ust_channel_to_lttng_channel(uchan
);
3805 ret_code
= LTTNG_ERR_NOMEM
;
3809 extended
= (struct lttng_channel_extended
*)
3810 channel
->attr
.extended
.ptr
;
3812 ret
= get_ust_runtime_stats(session
, uchan
,
3813 &discarded_events
, &lost_packets
);
3815 lttng_channel_destroy(channel
);
3816 ret_code
= LTTNG_ERR_UNK
;
3820 extended
->discarded_events
= discarded_events
;
3821 extended
->lost_packets
= lost_packets
;
3823 ret
= lttng_channel_serialize(
3824 channel
, &payload
->buffer
);
3826 ERR("Failed to serialize lttng_channel: channel name = '%s'",
3828 lttng_channel_destroy(channel
);
3829 ret_code
= LTTNG_ERR_UNK
;
3833 lttng_channel_destroy(channel
);
3843 if (i
> UINT32_MAX
) {
3844 ERR("Channel count would overflow the channel listing command's reply");
3845 ret_code
= LTTNG_ERR_OVERFLOW
;
3849 /* Update command reply header. */
3850 cmd_header
.count
= (uint32_t) i
;
3851 memcpy(payload
->buffer
.data
+ cmd_header_offset
, &cmd_header
,
3852 sizeof(cmd_header
));
3853 ret_code
= LTTNG_OK
;
3860 * Command LTTNG_LIST_EVENTS processed by the client thread.
3862 enum lttng_error_code
cmd_list_events(enum lttng_domain_type domain
,
3863 struct ltt_session
*session
,
3865 struct lttng_payload
*reply_payload
)
3867 int buffer_resize_ret
;
3868 enum lttng_error_code ret_code
= LTTNG_OK
;
3869 struct lttcomm_list_command_header reply_command_header
= {};
3870 size_t reply_command_header_offset
;
3871 unsigned int nb_events
= 0;
3873 assert(reply_payload
);
3875 /* Reserve space for command reply header. */
3876 reply_command_header_offset
= reply_payload
->buffer
.size
;
3877 buffer_resize_ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
3878 reply_command_header_offset
+
3879 sizeof(struct lttcomm_list_command_header
));
3880 if (buffer_resize_ret
) {
3881 ret_code
= LTTNG_ERR_NOMEM
;
3886 case LTTNG_DOMAIN_KERNEL
:
3887 if (session
->kernel_session
!= NULL
) {
3888 ret_code
= list_lttng_kernel_events(channel_name
,
3889 session
->kernel_session
, reply_payload
, &nb_events
);
3893 case LTTNG_DOMAIN_UST
:
3895 if (session
->ust_session
!= NULL
) {
3896 ret_code
= list_lttng_ust_global_events(channel_name
,
3897 &session
->ust_session
->domain_global
,
3898 reply_payload
, &nb_events
);
3903 case LTTNG_DOMAIN_LOG4J
:
3904 case LTTNG_DOMAIN_JUL
:
3905 case LTTNG_DOMAIN_PYTHON
:
3906 if (session
->ust_session
) {
3907 struct lttng_ht_iter iter
;
3911 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3912 &iter
.iter
, agt
, node
.node
) {
3913 if (agt
->domain
== domain
) {
3914 ret_code
= list_lttng_agent_events(
3915 agt
, reply_payload
, &nb_events
);
3924 ret_code
= LTTNG_ERR_UND
;
3928 if (nb_events
> UINT32_MAX
) {
3929 ret_code
= LTTNG_ERR_OVERFLOW
;
3933 /* Update command reply header. */
3934 reply_command_header
.count
= (uint32_t) nb_events
;
3935 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
3936 sizeof(reply_command_header
));
3943 * Using the session list, filled a lttng_session array to send back to the
3944 * client for session listing.
3946 * The session list lock MUST be acquired before calling this function. Use
3947 * session_lock_list() and session_unlock_list().
3949 enum lttng_error_code
cmd_list_lttng_sessions(
3950 struct lttng_payload
*reply_payload
, uid_t uid
, gid_t gid
)
3952 int buffer_resize_ret
;
3953 enum lttng_error_code ret_code
= LTTNG_OK
;
3954 struct lttcomm_list_command_header reply_command_header
= {};
3955 size_t reply_command_header_offset
;
3956 struct ltt_session
*session
;
3957 struct ltt_session_list
*list
= session_get_list();
3961 assert(reply_payload
);
3963 /* Reserve space for command reply header. */
3964 reply_command_header_offset
= reply_payload
->buffer
.size
;
3965 buffer_resize_ret
= lttng_dynamic_buffer_set_size(&reply_payload
->buffer
,
3966 reply_command_header_offset
+ sizeof(struct lttcomm_list_command_header
));
3967 if (buffer_resize_ret
) {
3968 ret_code
= LTTNG_ERR_NOMEM
;
3972 DBG("Getting all available session for UID %d GID %d",
3975 cds_list_for_each_entry(session
, &list
->head
, list
) {
3976 struct lttng_session tmp_session
= {};
3977 struct lttng_session_extended tmp_extended
= {};
3979 tmp_session
.extended
.ptr
= &tmp_extended
;
3981 if (!session_get(session
)) {
3985 * Only list the sessions the user can control.
3987 if (!session_access_ok(session
, uid
) ||
3988 session
->destroyed
) {
3989 session_put(session
);
3993 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3994 struct ltt_ust_session
*usess
= session
->ust_session
;
3996 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3997 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3998 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3999 ret
= build_network_session_path(
4000 tmp_session
.path
, sizeof(tmp_session
.path
), session
);
4002 ret
= snprintf(tmp_session
.path
, sizeof(tmp_session
.path
), "%s",
4003 session
->consumer
->dst
.session_root_path
);
4006 PERROR("snprintf session path");
4007 session_put(session
);
4011 strncpy(tmp_session
.name
, session
->name
, NAME_MAX
);
4012 tmp_session
.name
[NAME_MAX
- 1] = '\0';
4013 tmp_session
.enabled
= session
->active
;
4014 tmp_session
.snapshot_mode
= session
->snapshot_mode
;
4015 tmp_session
.live_timer_interval
= session
->live_timer
;
4016 LTTNG_OPTIONAL_SET(&tmp_extended
.creation_time
, (uint64_t) session
->creation_time
);
4017 ret
= lttng_session_serialize(&tmp_session
, reply_payload
);
4019 ret_code
= LTTNG_ERR_FATAL
;
4023 session_put(session
);
4026 if (i
> UINT32_MAX
) {
4027 ret_code
= LTTNG_ERR_OVERFLOW
;
4031 /* Update command reply header. */
4032 reply_command_header
.count
= (uint32_t) i
;
4033 memcpy(reply_payload
->buffer
.data
+ reply_command_header_offset
, &reply_command_header
,
4034 sizeof(reply_command_header
));
4035 ret_code
= LTTNG_OK
;
4041 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
4042 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
4044 int cmd_data_pending(struct ltt_session
*session
)
4047 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4048 struct ltt_ust_session
*usess
= session
->ust_session
;
4050 LTTNG_ASSERT(session
);
4052 DBG("Data pending for session %s", session
->name
);
4054 /* Session MUST be stopped to ask for data availability. */
4055 if (session
->active
) {
4056 ret
= LTTNG_ERR_SESSION_STARTED
;
4060 * If stopped, just make sure we've started before else the above call
4061 * will always send that there is data pending.
4063 * The consumer assumes that when the data pending command is received,
4064 * the trace has been started before or else no output data is written
4065 * by the streams which is a condition for data pending. So, this is
4066 * *VERY* important that we don't ask the consumer before a start
4069 if (!session
->has_been_started
) {
4075 /* A rotation is still pending, we have to wait. */
4076 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
4077 DBG("Rotate still pending for session %s", session
->name
);
4082 if (ksess
&& ksess
->consumer
) {
4083 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
4085 /* Data is still being extracted for the kernel. */
4090 if (usess
&& usess
->consumer
) {
4091 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
4093 /* Data is still being extracted for the kernel. */
4098 /* Data is ready to be read by a viewer */
4106 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
4108 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4110 int cmd_snapshot_add_output(struct ltt_session
*session
,
4111 const struct lttng_snapshot_output
*output
, uint32_t *id
)
4114 struct snapshot_output
*new_output
;
4116 LTTNG_ASSERT(session
);
4117 LTTNG_ASSERT(output
);
4119 DBG("Cmd snapshot add output for session %s", session
->name
);
4122 * Can't create an output if the session is not set in no-output mode.
4124 if (session
->output_traces
) {
4125 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4129 if (session
->has_non_mmap_channel
) {
4130 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
4134 /* Only one output is allowed until we have the "tee" feature. */
4135 if (session
->snapshot
.nb_output
== 1) {
4136 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
4140 new_output
= snapshot_output_alloc();
4142 ret
= LTTNG_ERR_NOMEM
;
4146 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
4147 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
4148 &session
->snapshot
);
4150 if (ret
== -ENOMEM
) {
4151 ret
= LTTNG_ERR_NOMEM
;
4153 ret
= LTTNG_ERR_INVALID
;
4159 snapshot_add_output(&session
->snapshot
, new_output
);
4161 *id
= new_output
->id
;
4168 snapshot_output_destroy(new_output
);
4174 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
4176 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4178 int cmd_snapshot_del_output(struct ltt_session
*session
,
4179 const struct lttng_snapshot_output
*output
)
4182 struct snapshot_output
*sout
= NULL
;
4184 LTTNG_ASSERT(session
);
4185 LTTNG_ASSERT(output
);
4190 * Permission denied to create an output if the session is not
4191 * set in no output mode.
4193 if (session
->output_traces
) {
4194 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4199 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
4201 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4202 } else if (*output
->name
!= '\0') {
4203 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
4205 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4208 ret
= LTTNG_ERR_INVALID
;
4212 snapshot_delete_output(&session
->snapshot
, sout
);
4213 snapshot_output_destroy(sout
);
4222 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4224 * If no output is available, outputs is untouched and 0 is returned.
4226 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4228 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4229 struct lttng_snapshot_output
**outputs
)
4232 struct lttng_snapshot_output
*list
= NULL
;
4233 struct lttng_ht_iter iter
;
4234 struct snapshot_output
*output
;
4236 LTTNG_ASSERT(session
);
4237 LTTNG_ASSERT(outputs
);
4239 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4242 * Permission denied to create an output if the session is not
4243 * set in no output mode.
4245 if (session
->output_traces
) {
4246 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4250 if (session
->snapshot
.nb_output
== 0) {
4255 list
= calloc
<lttng_snapshot_output
>(session
->snapshot
.nb_output
);
4257 ret
= -LTTNG_ERR_NOMEM
;
4261 /* Copy list from session to the new list object. */
4263 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4264 output
, node
.node
) {
4265 LTTNG_ASSERT(output
->consumer
);
4266 list
[idx
].id
= output
->id
;
4267 list
[idx
].max_size
= output
->max_size
;
4268 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4269 sizeof(list
[idx
].name
))) {
4270 ret
= -LTTNG_ERR_INVALID
;
4273 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4274 if (lttng_strncpy(list
[idx
].ctrl_url
,
4275 output
->consumer
->dst
.session_root_path
,
4276 sizeof(list
[idx
].ctrl_url
))) {
4277 ret
= -LTTNG_ERR_INVALID
;
4282 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4283 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4285 ret
= -LTTNG_ERR_NOMEM
;
4290 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4291 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4293 ret
= -LTTNG_ERR_NOMEM
;
4302 ret
= session
->snapshot
.nb_output
;
4311 * Check if we can regenerate the metadata for this session.
4312 * Only kernel, UST per-uid and non-live sessions are supported.
4314 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4317 int check_regenerate_metadata_support(struct ltt_session
*session
)
4321 LTTNG_ASSERT(session
);
4323 if (session
->live_timer
!= 0) {
4324 ret
= LTTNG_ERR_LIVE_SESSION
;
4327 if (!session
->active
) {
4328 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4331 if (session
->ust_session
) {
4332 switch (session
->ust_session
->buffer_type
) {
4333 case LTTNG_BUFFER_PER_UID
:
4335 case LTTNG_BUFFER_PER_PID
:
4336 ret
= LTTNG_ERR_PER_PID_SESSION
;
4340 ret
= LTTNG_ERR_UNK
;
4344 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4345 session
->consumer
->relay_minor_version
< 8) {
4346 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4356 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4358 * Ask the consumer to truncate the existing metadata file(s) and
4359 * then regenerate the metadata. Live and per-pid sessions are not
4360 * supported and return an error.
4362 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4364 int cmd_regenerate_metadata(struct ltt_session
*session
)
4368 LTTNG_ASSERT(session
);
4370 ret
= check_regenerate_metadata_support(session
);
4375 if (session
->kernel_session
) {
4376 ret
= kernctl_session_regenerate_metadata(
4377 session
->kernel_session
->fd
);
4379 ERR("Failed to regenerate the kernel metadata");
4384 if (session
->ust_session
) {
4385 ret
= trace_ust_regenerate_metadata(session
->ust_session
);
4387 ERR("Failed to regenerate the UST metadata");
4391 DBG("Cmd metadata regenerate for session %s", session
->name
);
4399 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4401 * Ask the tracer to regenerate a new statedump.
4403 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4405 int cmd_regenerate_statedump(struct ltt_session
*session
)
4409 LTTNG_ASSERT(session
);
4411 if (!session
->active
) {
4412 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4416 if (session
->kernel_session
) {
4417 ret
= kernctl_session_regenerate_statedump(
4418 session
->kernel_session
->fd
);
4420 * Currently, the statedump in kernel can only fail if out
4424 if (ret
== -ENOMEM
) {
4425 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4427 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4429 ERR("Failed to regenerate the kernel statedump");
4434 if (session
->ust_session
) {
4435 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4437 * Currently, the statedump in UST always returns 0.
4440 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4441 ERR("Failed to regenerate the UST statedump");
4445 DBG("Cmd regenerate statedump for session %s", session
->name
);
4453 enum lttng_error_code
synchronize_tracer_notifier_register(
4454 struct notification_thread_handle
*notification_thread
,
4455 struct lttng_trigger
*trigger
, const struct lttng_credentials
*cmd_creds
)
4457 enum lttng_error_code ret_code
;
4458 const struct lttng_condition
*condition
=
4459 lttng_trigger_get_const_condition(trigger
);
4460 const char *trigger_name
;
4461 uid_t trigger_owner
;
4462 enum lttng_trigger_status trigger_status
;
4463 const enum lttng_domain_type trigger_domain
=
4464 lttng_trigger_get_underlying_domain_type_restriction(
4467 trigger_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner
);
4468 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4470 LTTNG_ASSERT(condition
);
4471 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
4472 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
4474 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4475 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4476 trigger_name
: "(anonymous)";
4478 session_lock_list();
4479 switch (trigger_domain
) {
4480 case LTTNG_DOMAIN_KERNEL
:
4482 ret_code
= kernel_register_event_notifier(trigger
, cmd_creds
);
4483 if (ret_code
!= LTTNG_OK
) {
4484 enum lttng_error_code notif_thread_unregister_ret
;
4486 notif_thread_unregister_ret
=
4487 notification_thread_command_unregister_trigger(
4488 notification_thread
, trigger
);
4490 if (notif_thread_unregister_ret
!= LTTNG_OK
) {
4491 /* Return the original error code. */
4492 ERR("Failed to unregister trigger from notification thread during error recovery: trigger name = '%s', trigger owner uid = %d, error code = %d",
4494 (int) trigger_owner
,
4500 case LTTNG_DOMAIN_UST
:
4501 ust_app_global_update_all_event_notifier_rules();
4503 case LTTNG_DOMAIN_JUL
:
4504 case LTTNG_DOMAIN_LOG4J
:
4505 case LTTNG_DOMAIN_PYTHON
:
4507 /* Agent domains. */
4508 struct agent
*agt
= agent_find_by_event_notifier_domain(
4512 agt
= agent_create(trigger_domain
);
4514 ret_code
= LTTNG_ERR_NOMEM
;
4515 goto end_unlock_session_list
;
4518 agent_add(agt
, the_trigger_agents_ht_by_domain
);
4521 ret_code
= (lttng_error_code
) trigger_agent_enable(trigger
, agt
);
4522 if (ret_code
!= LTTNG_OK
) {
4523 goto end_unlock_session_list
;
4528 case LTTNG_DOMAIN_NONE
:
4533 ret_code
= LTTNG_OK
;
4534 end_unlock_session_list
:
4535 session_unlock_list();
4539 enum lttng_error_code
cmd_register_trigger(const struct lttng_credentials
*cmd_creds
,
4540 struct lttng_trigger
*trigger
,
4541 bool is_trigger_anonymous
,
4542 struct notification_thread_handle
*notification_thread
,
4543 struct lttng_trigger
**return_trigger
)
4545 enum lttng_error_code ret_code
;
4546 const char *trigger_name
;
4547 uid_t trigger_owner
;
4548 enum lttng_trigger_status trigger_status
;
4550 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4551 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4552 trigger_name
: "(anonymous)";
4554 trigger_status
= lttng_trigger_get_owner_uid(
4555 trigger
, &trigger_owner
);
4556 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4558 DBG("Running register trigger command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4559 trigger_name
, (int) trigger_owner
,
4560 (int) lttng_credentials_get_uid(cmd_creds
));
4563 * Validate the trigger credentials against the command credentials.
4564 * Only the root user can register a trigger with non-matching
4567 if (!lttng_credentials_is_equal_uid(
4568 lttng_trigger_get_credentials(trigger
),
4570 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4571 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4572 trigger_name
, (int) trigger_owner
,
4573 (int) lttng_credentials_get_uid(cmd_creds
));
4574 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4580 * The bytecode generation also serves as a validation step for the
4581 * bytecode expressions.
4583 ret_code
= lttng_trigger_generate_bytecode(trigger
, cmd_creds
);
4584 if (ret_code
!= LTTNG_OK
) {
4585 ERR("Failed to generate bytecode of trigger: trigger name = '%s', trigger owner uid = %d, error code = %d",
4586 trigger_name
, (int) trigger_owner
, ret_code
);
4591 * A reference to the trigger is acquired by the notification thread.
4592 * It is safe to return the same trigger to the caller since it the
4593 * other user holds a reference.
4595 * The trigger is modified during the execution of the
4596 * "register trigger" command. However, by the time the command returns,
4597 * it is safe to use without any locking as its properties are
4600 ret_code
= notification_thread_command_register_trigger(
4601 notification_thread
, trigger
, is_trigger_anonymous
);
4602 if (ret_code
!= LTTNG_OK
) {
4603 DBG("Failed to register trigger to notification thread: trigger name = '%s', trigger owner uid = %d, error code = %d",
4604 trigger_name
, (int) trigger_owner
, ret_code
);
4608 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4609 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4610 trigger_name
: "(anonymous)";
4613 * Synchronize tracers if the trigger adds an event notifier.
4615 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
4616 ret_code
= synchronize_tracer_notifier_register(notification_thread
,
4617 trigger
, cmd_creds
);
4618 if (ret_code
!= LTTNG_OK
) {
4619 ERR("Error registering tracer notifier: %s",
4620 lttng_strerror(-ret_code
));
4626 * Return an updated trigger to the client.
4628 * Since a modified version of the same trigger is returned, acquire a
4629 * reference to the trigger so the caller doesn't have to care if those
4630 * are distinct instances or not.
4632 if (ret_code
== LTTNG_OK
) {
4633 lttng_trigger_get(trigger
);
4634 *return_trigger
= trigger
;
4635 /* Ownership of trigger was transferred to caller. */
4643 enum lttng_error_code
synchronize_tracer_notifier_unregister(
4644 const struct lttng_trigger
*trigger
)
4646 enum lttng_error_code ret_code
;
4647 const struct lttng_condition
*condition
=
4648 lttng_trigger_get_const_condition(trigger
);
4649 const enum lttng_domain_type trigger_domain
=
4650 lttng_trigger_get_underlying_domain_type_restriction(
4653 LTTNG_ASSERT(condition
);
4654 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
4655 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
4657 session_lock_list();
4658 switch (trigger_domain
) {
4659 case LTTNG_DOMAIN_KERNEL
:
4660 ret_code
= kernel_unregister_event_notifier(trigger
);
4661 if (ret_code
!= LTTNG_OK
) {
4662 goto end_unlock_session_list
;
4666 case LTTNG_DOMAIN_UST
:
4667 ust_app_global_update_all_event_notifier_rules();
4669 case LTTNG_DOMAIN_JUL
:
4670 case LTTNG_DOMAIN_LOG4J
:
4671 case LTTNG_DOMAIN_PYTHON
:
4673 /* Agent domains. */
4674 struct agent
*agt
= agent_find_by_event_notifier_domain(
4678 * This trigger was never registered in the first place. Calling
4679 * this function under those circumstances is an internal error.
4682 ret_code
= (lttng_error_code
) trigger_agent_disable(trigger
, agt
);
4683 if (ret_code
!= LTTNG_OK
) {
4684 goto end_unlock_session_list
;
4689 case LTTNG_DOMAIN_NONE
:
4694 ret_code
= LTTNG_OK
;
4696 end_unlock_session_list
:
4697 session_unlock_list();
4701 enum lttng_error_code
cmd_unregister_trigger(const struct lttng_credentials
*cmd_creds
,
4702 const struct lttng_trigger
*trigger
,
4703 struct notification_thread_handle
*notification_thread
)
4705 enum lttng_error_code ret_code
;
4706 const char *trigger_name
;
4707 uid_t trigger_owner
;
4708 enum lttng_trigger_status trigger_status
;
4709 struct lttng_trigger
*sessiond_trigger
= NULL
;
4711 trigger_status
= lttng_trigger_get_name(trigger
, &trigger_name
);
4712 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
? trigger_name
: "(anonymous)";
4713 trigger_status
= lttng_trigger_get_owner_uid(trigger
, &trigger_owner
);
4714 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4716 DBG("Running unregister trigger command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4717 trigger_name
, (int) trigger_owner
,
4718 (int) lttng_credentials_get_uid(cmd_creds
));
4721 * Validate the trigger credentials against the command credentials.
4722 * Only the root user can unregister a trigger with non-matching
4725 if (!lttng_credentials_is_equal_uid(
4726 lttng_trigger_get_credentials(trigger
),
4728 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4729 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4730 trigger_name
, (int) trigger_owner
,
4731 (int) lttng_credentials_get_uid(cmd_creds
));
4732 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4737 /* Fetch the sessiond side trigger object. */
4738 ret_code
= notification_thread_command_get_trigger(
4739 notification_thread
, trigger
, &sessiond_trigger
);
4740 if (ret_code
!= LTTNG_OK
) {
4741 DBG("Failed to get trigger from notification thread during unregister: trigger name = '%s', trigger owner uid = %d, error code = %d",
4742 trigger_name
, (int) trigger_owner
, ret_code
);
4746 LTTNG_ASSERT(sessiond_trigger
);
4749 * From this point on, no matter what, consider the trigger
4752 * We set the unregistered state of the sessiond side trigger object in
4753 * the client thread since we want to minimize the possibility of the
4754 * notification thread being stalled due to a long execution of an
4755 * action that required the trigger lock.
4757 lttng_trigger_set_as_unregistered(sessiond_trigger
);
4759 ret_code
= notification_thread_command_unregister_trigger(notification_thread
,
4761 if (ret_code
!= LTTNG_OK
) {
4762 DBG("Failed to unregister trigger from notification thread: trigger name = '%s', trigger owner uid = %d, error code = %d",
4763 trigger_name
, (int) trigger_owner
, ret_code
);
4768 * Synchronize tracers if the trigger removes an event notifier.
4769 * Do this even if the trigger unregistration failed to at least stop
4770 * the tracers from producing notifications associated with this
4773 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
4774 ret_code
= synchronize_tracer_notifier_unregister(trigger
);
4775 if (ret_code
!= LTTNG_OK
) {
4776 ERR("Error unregistering trigger to tracer.");
4783 lttng_trigger_put(sessiond_trigger
);
4787 enum lttng_error_code
cmd_list_triggers(struct command_ctx
*cmd_ctx
,
4788 struct notification_thread_handle
*notification_thread
,
4789 struct lttng_triggers
**return_triggers
)
4792 enum lttng_error_code ret_code
;
4793 struct lttng_triggers
*triggers
= NULL
;
4795 /* Get the set of triggers from the notification thread. */
4796 ret_code
= notification_thread_command_list_triggers(
4797 notification_thread
, cmd_ctx
->creds
.uid
, &triggers
);
4798 if (ret_code
!= LTTNG_OK
) {
4802 ret
= lttng_triggers_remove_hidden_triggers(triggers
);
4804 ret_code
= LTTNG_ERR_UNK
;
4808 *return_triggers
= triggers
;
4810 ret_code
= LTTNG_OK
;
4812 lttng_triggers_destroy(triggers
);
4816 enum lttng_error_code
cmd_execute_error_query(const struct lttng_credentials
*cmd_creds
,
4817 const struct lttng_error_query
*query
,
4818 struct lttng_error_query_results
**_results
,
4819 struct notification_thread_handle
*notification_thread
)
4821 enum lttng_error_code ret_code
;
4822 const struct lttng_trigger
*query_target_trigger
;
4823 const struct lttng_action
*query_target_action
= NULL
;
4824 struct lttng_trigger
*matching_trigger
= NULL
;
4825 const char *trigger_name
;
4826 uid_t trigger_owner
;
4827 enum lttng_trigger_status trigger_status
;
4828 struct lttng_error_query_results
*results
= NULL
;
4830 switch (lttng_error_query_get_target_type(query
)) {
4831 case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER
:
4832 query_target_trigger
= lttng_error_query_trigger_borrow_target(query
);
4834 case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION
:
4835 query_target_trigger
=
4836 lttng_error_query_condition_borrow_target(query
);
4838 case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
:
4839 query_target_trigger
= lttng_error_query_action_borrow_trigger_target(
4846 LTTNG_ASSERT(query_target_trigger
);
4848 ret_code
= notification_thread_command_get_trigger(notification_thread
,
4849 query_target_trigger
, &matching_trigger
);
4850 if (ret_code
!= LTTNG_OK
) {
4854 /* No longer needed. */
4855 query_target_trigger
= NULL
;
4857 if (lttng_error_query_get_target_type(query
) ==
4858 LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
) {
4859 /* Get the sessiond-side version of the target action. */
4860 query_target_action
=
4861 lttng_error_query_action_borrow_action_target(
4862 query
, matching_trigger
);
4865 trigger_status
= lttng_trigger_get_name(matching_trigger
, &trigger_name
);
4866 trigger_name
= trigger_status
== LTTNG_TRIGGER_STATUS_OK
?
4867 trigger_name
: "(anonymous)";
4868 trigger_status
= lttng_trigger_get_owner_uid(matching_trigger
,
4870 LTTNG_ASSERT(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4872 results
= lttng_error_query_results_create();
4874 ret_code
= LTTNG_ERR_NOMEM
;
4878 DBG("Running \"execute error query\" command: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4879 trigger_name
, (int) trigger_owner
,
4880 (int) lttng_credentials_get_uid(cmd_creds
));
4883 * Validate the trigger credentials against the command credentials.
4884 * Only the root user can target a trigger with non-matching
4887 if (!lttng_credentials_is_equal_uid(
4888 lttng_trigger_get_credentials(matching_trigger
),
4890 if (lttng_credentials_get_uid(cmd_creds
) != 0) {
4891 ERR("Trigger credentials do not match the command credentials: trigger name = '%s', trigger owner uid = %d, command creds uid = %d",
4892 trigger_name
, (int) trigger_owner
,
4893 (int) lttng_credentials_get_uid(cmd_creds
));
4894 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
4899 switch (lttng_error_query_get_target_type(query
)) {
4900 case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER
:
4901 trigger_status
= lttng_trigger_add_error_results(
4902 matching_trigger
, results
);
4904 switch (trigger_status
) {
4905 case LTTNG_TRIGGER_STATUS_OK
:
4908 ret_code
= LTTNG_ERR_UNK
;
4913 case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION
:
4915 trigger_status
= lttng_trigger_condition_add_error_results(
4916 matching_trigger
, results
);
4918 switch (trigger_status
) {
4919 case LTTNG_TRIGGER_STATUS_OK
:
4922 ret_code
= LTTNG_ERR_UNK
;
4928 case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION
:
4930 const enum lttng_action_status action_status
=
4931 lttng_action_add_error_query_results(
4932 query_target_action
, results
);
4934 switch (action_status
) {
4935 case LTTNG_ACTION_STATUS_OK
:
4938 ret_code
= LTTNG_ERR_UNK
;
4949 *_results
= results
;
4951 ret_code
= LTTNG_OK
;
4953 lttng_trigger_put(matching_trigger
);
4954 lttng_error_query_results_destroy(results
);
4959 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4960 * snapshot output is *not* set with a remote destination.
4962 * Return LTTNG_OK on success or a LTTNG_ERR code.
4964 static enum lttng_error_code
set_relayd_for_snapshot(
4965 struct consumer_output
*output
,
4966 const struct ltt_session
*session
)
4968 enum lttng_error_code status
= LTTNG_OK
;
4969 struct lttng_ht_iter iter
;
4970 struct consumer_socket
*socket
;
4971 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4972 const char *base_path
;
4974 LTTNG_ASSERT(output
);
4975 LTTNG_ASSERT(session
);
4977 DBG2("Set relayd object from snapshot output");
4979 if (session
->current_trace_chunk
) {
4980 enum lttng_trace_chunk_status chunk_status
=
4981 lttng_trace_chunk_get_id(
4982 session
->current_trace_chunk
,
4983 ¤t_chunk_id
.value
);
4985 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4986 current_chunk_id
.is_set
= true;
4988 ERR("Failed to get current trace chunk id");
4989 status
= LTTNG_ERR_UNK
;
4994 /* Ignore if snapshot consumer output is not network. */
4995 if (output
->type
!= CONSUMER_DST_NET
) {
5000 * The snapshot record URI base path overrides the session
5003 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
5004 base_path
= output
->dst
.net
.control
.subdir
;
5006 base_path
= session
->base_path
;
5010 * For each consumer socket, create and send the relayd object of the
5014 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
5015 socket
, node
.node
) {
5016 pthread_mutex_lock(socket
->lock
);
5017 status
= send_consumer_relayd_sockets(session
->id
,
5019 session
->name
, session
->hostname
,
5021 session
->live_timer
,
5022 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
5023 session
->creation_time
,
5024 session
->name_contains_creation_time
);
5025 pthread_mutex_unlock(socket
->lock
);
5026 if (status
!= LTTNG_OK
) {
5038 * Record a kernel snapshot.
5040 * Return LTTNG_OK on success or a LTTNG_ERR code.
5042 static enum lttng_error_code
record_kernel_snapshot(
5043 struct ltt_kernel_session
*ksess
,
5044 const struct consumer_output
*output
,
5045 const struct ltt_session
*session
,
5046 uint64_t nb_packets_per_stream
)
5048 enum lttng_error_code status
;
5050 LTTNG_ASSERT(ksess
);
5051 LTTNG_ASSERT(output
);
5052 LTTNG_ASSERT(session
);
5054 status
= kernel_snapshot_record(
5055 ksess
, output
, nb_packets_per_stream
);
5060 * Record a UST snapshot.
5062 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
5064 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
5065 const struct consumer_output
*output
,
5066 const struct ltt_session
*session
,
5067 uint64_t nb_packets_per_stream
)
5069 enum lttng_error_code status
;
5071 LTTNG_ASSERT(usess
);
5072 LTTNG_ASSERT(output
);
5073 LTTNG_ASSERT(session
);
5075 status
= ust_app_snapshot_record(
5076 usess
, output
, nb_packets_per_stream
);
5081 uint64_t get_session_size_one_more_packet_per_stream(
5082 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
5084 uint64_t tot_size
= 0;
5086 if (session
->kernel_session
) {
5087 struct ltt_kernel_channel
*chan
;
5088 const struct ltt_kernel_session
*ksess
=
5089 session
->kernel_session
;
5091 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
5092 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
5094 * Don't take channel into account if we
5095 * already grab all its packets.
5099 tot_size
+= chan
->channel
->attr
.subbuf_size
5100 * chan
->stream_count
;
5104 if (session
->ust_session
) {
5105 const struct ltt_ust_session
*usess
= session
->ust_session
;
5107 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
5115 * Calculate the number of packets we can grab from each stream that
5116 * fits within the overall snapshot max size.
5118 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
5119 * the number of packets per stream.
5121 * TODO: this approach is not perfect: we consider the worse case
5122 * (packet filling the sub-buffers) as an upper bound, but we could do
5123 * better if we do this calculation while we actually grab the packet
5124 * content: we would know how much padding we don't actually store into
5127 * This algorithm is currently bounded by the number of packets per
5130 * Since we call this algorithm before actually grabbing the data, it's
5131 * an approximation: for instance, applications could appear/disappear
5132 * in between this call and actually grabbing data.
5135 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
5139 uint64_t cur_nb_packets
= 0;
5142 return 0; /* Infinite */
5145 size_left
= max_size
;
5147 uint64_t one_more_packet_tot_size
;
5149 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
5150 session
, cur_nb_packets
);
5151 if (!one_more_packet_tot_size
) {
5152 /* We are already grabbing all packets. */
5155 size_left
-= one_more_packet_tot_size
;
5156 if (size_left
< 0) {
5161 if (!cur_nb_packets
&& size_left
!= max_size
) {
5162 /* Not enough room to grab one packet of each stream, error. */
5165 return cur_nb_packets
;
5169 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
5170 const struct snapshot_output
*snapshot_output
)
5172 int64_t nb_packets_per_stream
;
5173 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
5175 enum lttng_error_code ret_code
= LTTNG_OK
;
5176 struct lttng_trace_chunk
*snapshot_trace_chunk
;
5177 struct consumer_output
*original_ust_consumer_output
= NULL
;
5178 struct consumer_output
*original_kernel_consumer_output
= NULL
;
5179 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
5180 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
5182 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
5184 snapshot_output
->name
,
5185 snapshot_output
->datetime
,
5186 snapshot_output
->nb_snapshot
);
5187 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
5188 ERR("Failed to format snapshot name");
5189 ret_code
= LTTNG_ERR_INVALID
;
5192 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
5193 snapshot_output
->name
, session
->name
,
5194 snapshot_chunk_name
);
5195 if (!session
->kernel_session
&& !session
->ust_session
) {
5196 ERR("Failed to record snapshot as no channels exist");
5197 ret_code
= LTTNG_ERR_NO_CHANNEL
;
5201 if (session
->kernel_session
) {
5202 original_kernel_consumer_output
=
5203 session
->kernel_session
->consumer
;
5204 snapshot_kernel_consumer_output
=
5205 consumer_copy_output(snapshot_output
->consumer
);
5206 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
5207 snapshot_chunk_name
);
5209 /* Copy the original domain subdir. */
5210 strcpy(snapshot_kernel_consumer_output
->domain_subdir
,
5211 original_kernel_consumer_output
->domain_subdir
);
5213 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
5214 original_kernel_consumer_output
);
5216 ERR("Failed to copy consumer sockets from snapshot output configuration");
5217 ret_code
= LTTNG_ERR_NOMEM
;
5220 ret_code
= set_relayd_for_snapshot(
5221 snapshot_kernel_consumer_output
, session
);
5222 if (ret_code
!= LTTNG_OK
) {
5223 ERR("Failed to setup relay daemon for kernel tracer snapshot");
5226 session
->kernel_session
->consumer
=
5227 snapshot_kernel_consumer_output
;
5229 if (session
->ust_session
) {
5230 original_ust_consumer_output
= session
->ust_session
->consumer
;
5231 snapshot_ust_consumer_output
=
5232 consumer_copy_output(snapshot_output
->consumer
);
5233 strcpy(snapshot_ust_consumer_output
->chunk_path
,
5234 snapshot_chunk_name
);
5236 /* Copy the original domain subdir. */
5237 strcpy(snapshot_ust_consumer_output
->domain_subdir
,
5238 original_ust_consumer_output
->domain_subdir
);
5240 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
5241 original_ust_consumer_output
);
5243 ERR("Failed to copy consumer sockets from snapshot output configuration");
5244 ret_code
= LTTNG_ERR_NOMEM
;
5247 ret_code
= set_relayd_for_snapshot(
5248 snapshot_ust_consumer_output
, session
);
5249 if (ret_code
!= LTTNG_OK
) {
5250 ERR("Failed to setup relay daemon for userspace tracer snapshot");
5253 session
->ust_session
->consumer
=
5254 snapshot_ust_consumer_output
;
5257 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
5258 snapshot_kernel_consumer_output
?:
5259 snapshot_ust_consumer_output
,
5260 consumer_output_get_base_path(
5261 snapshot_output
->consumer
),
5262 snapshot_chunk_name
);
5263 if (!snapshot_trace_chunk
) {
5264 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
5266 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
5269 LTTNG_ASSERT(!session
->current_trace_chunk
);
5270 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
5271 lttng_trace_chunk_put(snapshot_trace_chunk
);
5272 snapshot_trace_chunk
= NULL
;
5274 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
5276 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5280 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
5281 snapshot_output
->max_size
);
5282 if (nb_packets_per_stream
< 0) {
5283 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
5284 goto error_close_trace_chunk
;
5287 if (session
->kernel_session
) {
5288 ret_code
= record_kernel_snapshot(session
->kernel_session
,
5289 snapshot_kernel_consumer_output
, session
,
5290 nb_packets_per_stream
);
5291 if (ret_code
!= LTTNG_OK
) {
5292 goto error_close_trace_chunk
;
5296 if (session
->ust_session
) {
5297 ret_code
= record_ust_snapshot(session
->ust_session
,
5298 snapshot_ust_consumer_output
, session
,
5299 nb_packets_per_stream
);
5300 if (ret_code
!= LTTNG_OK
) {
5301 goto error_close_trace_chunk
;
5305 error_close_trace_chunk
:
5306 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
5307 ERR("Failed to release the current trace chunk of session \"%s\"",
5309 ret_code
= LTTNG_ERR_UNK
;
5312 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
5313 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
5315 * Don't goto end; make sure the chunk is closed for the session
5316 * to allow future snapshots.
5318 ERR("Failed to close snapshot trace chunk of session \"%s\"",
5320 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5323 lttng_trace_chunk_put(snapshot_trace_chunk
);
5324 snapshot_trace_chunk
= NULL
;
5326 if (original_ust_consumer_output
) {
5327 session
->ust_session
->consumer
= original_ust_consumer_output
;
5329 if (original_kernel_consumer_output
) {
5330 session
->kernel_session
->consumer
=
5331 original_kernel_consumer_output
;
5333 consumer_output_put(snapshot_ust_consumer_output
);
5334 consumer_output_put(snapshot_kernel_consumer_output
);
5339 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
5341 * The wait parameter is ignored so this call always wait for the snapshot to
5342 * complete before returning.
5344 * Return LTTNG_OK on success or else a LTTNG_ERR code.
5346 int cmd_snapshot_record(struct ltt_session
*session
,
5347 const struct lttng_snapshot_output
*output
,
5348 int wait
__attribute__((unused
)))
5350 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5352 unsigned int snapshot_success
= 0;
5354 struct snapshot_output
*tmp_output
= NULL
;
5356 LTTNG_ASSERT(session
);
5357 LTTNG_ASSERT(output
);
5359 DBG("Cmd snapshot record for session %s", session
->name
);
5361 /* Get the datetime for the snapshot output directory. */
5362 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
5365 cmd_ret
= LTTNG_ERR_INVALID
;
5370 * Permission denied to create an output if the session is not
5371 * set in no output mode.
5373 if (session
->output_traces
) {
5374 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
5378 /* The session needs to be started at least once. */
5379 if (!session
->has_been_started
) {
5380 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5384 /* Use temporary output for the session. */
5385 if (*output
->ctrl_url
!= '\0') {
5386 tmp_output
= snapshot_output_alloc();
5388 cmd_ret
= LTTNG_ERR_NOMEM
;
5392 ret
= snapshot_output_init(session
, output
->max_size
,
5394 output
->ctrl_url
, output
->data_url
,
5398 if (ret
== -ENOMEM
) {
5399 cmd_ret
= LTTNG_ERR_NOMEM
;
5401 cmd_ret
= LTTNG_ERR_INVALID
;
5405 /* Use the global session count for the temporary snapshot. */
5406 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
5408 /* Use the global datetime */
5409 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
5410 cmd_ret
= snapshot_record(session
, tmp_output
);
5411 if (cmd_ret
!= LTTNG_OK
) {
5414 snapshot_success
= 1;
5416 struct snapshot_output
*sout
;
5417 struct lttng_ht_iter iter
;
5420 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
5421 &iter
.iter
, sout
, node
.node
) {
5422 struct snapshot_output output_copy
;
5425 * Make a local copy of the output and override output
5426 * parameters with those provided as part of the
5429 memcpy(&output_copy
, sout
, sizeof(output_copy
));
5431 if (output
->max_size
!= (uint64_t) -1ULL) {
5432 output_copy
.max_size
= output
->max_size
;
5435 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
5436 memcpy(output_copy
.datetime
, datetime
,
5439 /* Use temporary name. */
5440 if (*output
->name
!= '\0') {
5441 if (lttng_strncpy(output_copy
.name
,
5443 sizeof(output_copy
.name
))) {
5444 cmd_ret
= LTTNG_ERR_INVALID
;
5450 cmd_ret
= snapshot_record(session
, &output_copy
);
5451 if (cmd_ret
!= LTTNG_OK
) {
5455 snapshot_success
= 1;
5460 if (snapshot_success
) {
5461 session
->snapshot
.nb_snapshot
++;
5463 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
5468 snapshot_output_destroy(tmp_output
);
5474 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
5476 int cmd_set_session_shm_path(struct ltt_session
*session
,
5477 const char *shm_path
)
5480 LTTNG_ASSERT(session
);
5483 * Can only set shm path before session is started.
5485 if (session
->has_been_started
) {
5486 return LTTNG_ERR_SESSION_STARTED
;
5489 strncpy(session
->shm_path
, shm_path
,
5490 sizeof(session
->shm_path
));
5491 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
5497 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
5499 * Ask the consumer to rotate the session output directory.
5500 * The session lock must be held.
5502 * Returns LTTNG_OK on success or else a negative LTTng error code.
5504 int cmd_rotate_session(struct ltt_session
*session
,
5505 struct lttng_rotate_session_return
*rotate_return
,
5506 bool quiet_rotation
,
5507 enum lttng_trace_chunk_command_type command
)
5510 uint64_t ongoing_rotation_chunk_id
;
5511 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5512 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
5513 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
5514 enum lttng_trace_chunk_status chunk_status
;
5515 bool failed_to_rotate
= false;
5516 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
5518 LTTNG_ASSERT(session
);
5520 if (!session
->has_been_started
) {
5521 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5526 * Explicit rotation is not supported for live sessions.
5527 * However, live sessions can perform a quiet rotation on
5529 * Rotation is not supported for snapshot traces (no output).
5531 if ((!quiet_rotation
&& session
->live_timer
) ||
5532 !session
->output_traces
) {
5533 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5537 /* Unsupported feature in lttng-relayd before 2.11. */
5538 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5539 (session
->consumer
->relay_major_version
== 2 &&
5540 session
->consumer
->relay_minor_version
< 11)) {
5541 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5545 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5546 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5547 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5551 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5552 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5554 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5559 * After a stop, we only allow one rotation to occur, the other ones are
5560 * useless until a new start.
5562 if (session
->rotated_after_last_stop
) {
5563 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5565 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5570 * After a stop followed by a clear, disallow following rotations a they would
5571 * generate empty chunks.
5573 if (session
->cleared_after_last_stop
) {
5574 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5576 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5580 if (session
->active
) {
5581 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
5583 if (!new_trace_chunk
) {
5584 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5590 * The current trace chunk becomes the chunk being archived.
5592 * After this point, "chunk_being_archived" must absolutely
5593 * be closed on the consumer(s), otherwise it will never be
5594 * cleaned-up, which will result in a leak.
5596 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5597 &chunk_being_archived
);
5599 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5603 if (session
->kernel_session
) {
5604 cmd_ret
= kernel_rotate_session(session
);
5605 if (cmd_ret
!= LTTNG_OK
) {
5606 failed_to_rotate
= true;
5607 rotation_fail_code
= cmd_ret
;
5610 if (session
->ust_session
) {
5611 cmd_ret
= ust_app_rotate_session(session
);
5612 if (cmd_ret
!= LTTNG_OK
) {
5613 failed_to_rotate
= true;
5614 rotation_fail_code
= cmd_ret
;
5618 if (!session
->active
) {
5619 session
->rotated_after_last_stop
= true;
5622 if (!chunk_being_archived
) {
5623 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5625 if (failed_to_rotate
) {
5626 cmd_ret
= rotation_fail_code
;
5633 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5634 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5635 &ongoing_rotation_chunk_id
);
5636 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5638 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5639 command
, session
->last_chunk_path
);
5641 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5645 if (failed_to_rotate
) {
5646 cmd_ret
= rotation_fail_code
;
5650 session
->quiet_rotation
= quiet_rotation
;
5651 ret
= timer_session_rotation_pending_check_start(session
,
5652 DEFAULT_ROTATE_PENDING_TIMER
);
5654 cmd_ret
= LTTNG_ERR_UNK
;
5658 if (rotate_return
) {
5659 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5662 session
->chunk_being_archived
= chunk_being_archived
;
5663 chunk_being_archived
= NULL
;
5664 if (!quiet_rotation
) {
5665 ret
= notification_thread_command_session_rotation_ongoing(
5666 the_notification_thread_handle
, session
->id
,
5667 ongoing_rotation_chunk_id
);
5668 if (ret
!= LTTNG_OK
) {
5669 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5671 cmd_ret
= (lttng_error_code
) ret
;
5675 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5676 session
->name
, ongoing_rotation_chunk_id
);
5678 lttng_trace_chunk_put(new_trace_chunk
);
5679 lttng_trace_chunk_put(chunk_being_archived
);
5680 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5683 if (session_reset_rotation_state(session
,
5684 LTTNG_ROTATION_STATE_ERROR
)) {
5685 ERR("Failed to reset rotation state of session \"%s\"",
5692 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5694 * Check if the session has finished its rotation.
5696 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5698 int cmd_rotate_get_info(struct ltt_session
*session
,
5699 struct lttng_rotation_get_info_return
*info_return
,
5700 uint64_t rotation_id
)
5702 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5703 enum lttng_rotation_state rotation_state
;
5705 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5706 session
->most_recent_chunk_id
.value
);
5708 if (session
->chunk_being_archived
) {
5709 enum lttng_trace_chunk_status chunk_status
;
5712 chunk_status
= lttng_trace_chunk_get_id(
5713 session
->chunk_being_archived
,
5715 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5717 rotation_state
= rotation_id
== chunk_id
?
5718 LTTNG_ROTATION_STATE_ONGOING
:
5719 LTTNG_ROTATION_STATE_EXPIRED
;
5721 if (session
->last_archived_chunk_id
.is_set
&&
5722 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5723 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5725 rotation_state
= session
->rotation_state
;
5729 switch (rotation_state
) {
5730 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5731 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5734 case LTTNG_ROTATION_STATE_EXPIRED
:
5735 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5736 rotation_id
, session
->name
);
5738 case LTTNG_ROTATION_STATE_ONGOING
:
5739 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5740 rotation_id
, session
->name
);
5742 case LTTNG_ROTATION_STATE_COMPLETED
:
5746 char *current_tracing_path_reply
;
5747 size_t current_tracing_path_reply_len
;
5749 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5750 rotation_id
, session
->name
);
5752 switch (session_get_consumer_destination_type(session
)) {
5753 case CONSUMER_DST_LOCAL
:
5754 current_tracing_path_reply
=
5755 info_return
->location
.local
.absolute_path
;
5756 current_tracing_path_reply_len
=
5757 sizeof(info_return
->location
.local
.absolute_path
);
5758 info_return
->location_type
=
5759 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5760 fmt_ret
= asprintf(&chunk_path
,
5761 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5762 session_get_base_path(session
),
5763 session
->last_archived_chunk_name
);
5764 if (fmt_ret
== -1) {
5765 PERROR("Failed to format the path of the last archived trace chunk");
5766 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5767 cmd_ret
= LTTNG_ERR_UNK
;
5771 case CONSUMER_DST_NET
:
5773 uint16_t ctrl_port
, data_port
;
5775 current_tracing_path_reply
=
5776 info_return
->location
.relay
.relative_path
;
5777 current_tracing_path_reply_len
=
5778 sizeof(info_return
->location
.relay
.relative_path
);
5779 /* Currently the only supported relay protocol. */
5780 info_return
->location
.relay
.protocol
=
5781 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5783 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5784 session_get_net_consumer_hostname(session
),
5785 sizeof(info_return
->location
.relay
.host
));
5787 ERR("Failed to copy host name to rotate_get_info reply");
5788 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5789 cmd_ret
= LTTNG_ERR_SET_URL
;
5793 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5794 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5795 info_return
->location
.relay
.ports
.data
= data_port
;
5796 info_return
->location_type
=
5797 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5798 chunk_path
= strdup(session
->last_chunk_path
);
5800 ERR("Failed to allocate the path of the last archived trace chunk");
5801 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5802 cmd_ret
= LTTNG_ERR_UNK
;
5811 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5812 chunk_path
, current_tracing_path_reply_len
);
5815 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5816 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5817 cmd_ret
= LTTNG_ERR_UNK
;
5823 case LTTNG_ROTATION_STATE_ERROR
:
5824 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5825 rotation_id
, session
->name
);
5833 info_return
->status
= (int32_t) rotation_state
;
5838 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5840 * Configure the automatic rotation parameters.
5841 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5842 * 'activate' to false means deactivate the rotation schedule and validate that
5843 * 'new_value' has the same value as the currently active value.
5845 * Return LTTNG_OK on success or else a positive LTTNG_ERR code.
5847 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5848 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5850 struct notification_thread_handle
*notification_thread_handle
)
5853 uint64_t *parameter_value
;
5855 LTTNG_ASSERT(session
);
5857 DBG("Cmd rotate set schedule session %s", session
->name
);
5859 if (session
->live_timer
|| !session
->output_traces
) {
5860 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5861 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5865 switch (schedule_type
) {
5866 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5867 parameter_value
= &session
->rotate_size
;
5869 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5870 parameter_value
= &session
->rotate_timer_period
;
5871 if (new_value
>= UINT_MAX
) {
5872 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5873 new_value
, UINT_MAX
);
5874 ret
= LTTNG_ERR_INVALID
;
5879 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5880 ret
= LTTNG_ERR_INVALID
;
5884 /* Improper use of the API. */
5885 if (new_value
== -1ULL) {
5886 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5887 ret
= LTTNG_ERR_INVALID
;
5892 * As indicated in struct ltt_session's comments, a value of == 0 means
5893 * this schedule rotation type is not in use.
5895 * Reject the command if we were asked to activate a schedule that was
5898 if (activate
&& *parameter_value
!= 0) {
5899 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5900 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5905 * Reject the command if we were asked to deactivate a schedule that was
5908 if (!activate
&& *parameter_value
== 0) {
5909 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5910 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5915 * Reject the command if we were asked to deactivate a schedule that
5918 if (!activate
&& *parameter_value
!= new_value
) {
5919 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5920 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5924 *parameter_value
= activate
? new_value
: 0;
5926 switch (schedule_type
) {
5927 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5928 if (activate
&& session
->active
) {
5930 * Only start the timer if the session is active,
5931 * otherwise it will be started when the session starts.
5933 ret
= timer_session_rotation_schedule_timer_start(
5934 session
, new_value
);
5936 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5937 ret
= LTTNG_ERR_UNK
;
5941 ret
= timer_session_rotation_schedule_timer_stop(
5944 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5945 ret
= LTTNG_ERR_UNK
;
5950 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5952 ret
= subscribe_session_consumed_size_rotation(session
,
5953 new_value
, notification_thread_handle
);
5955 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5956 ret
= LTTNG_ERR_UNK
;
5960 ret
= unsubscribe_session_consumed_size_rotation(session
,
5961 notification_thread_handle
);
5963 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5964 ret
= LTTNG_ERR_UNK
;
5971 /* Would have been caught before. */
5983 /* Wait for a given path to be removed before continuing. */
5984 static enum lttng_error_code
wait_on_path(void *path_data
)
5986 const char *shm_path
= (const char *) path_data
;
5988 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5994 ret
= stat(shm_path
, &st
);
5996 if (errno
!= ENOENT
) {
5997 PERROR("stat() returned an error while checking for the existence of the shm path");
5999 DBG("shm path no longer exists, completing the destruction of session");
6003 if (!S_ISDIR(st
.st_mode
)) {
6004 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
6009 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
6015 * Returns a pointer to a handler to run on completion of a command.
6016 * Returns NULL if no handler has to be run for the last command executed.
6018 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
6020 struct cmd_completion_handler
*handler
= current_completion_handler
;
6022 current_completion_handler
= NULL
;
6027 * Init command subsystem.
6032 * Set network sequence index to 1 for streams to match a relayd
6033 * socket on the consumer side.
6035 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
6036 relayd_net_seq_idx
= 1;
6037 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
6039 DBG("Command subsystem initialized");