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
9 #include "bin/lttng-sessiond/tracker.h"
10 #include "lttng/lttng-error.h"
11 #include "lttng/tracker.h"
15 #include <urcu/list.h>
16 #include <urcu/uatomic.h>
20 #include <common/defaults.h>
21 #include <common/common.h>
22 #include <common/sessiond-comm/sessiond-comm.h>
23 #include <common/relayd/relayd.h>
24 #include <common/utils.h>
25 #include <common/compat/string.h>
26 #include <common/kernel-ctl/kernel-ctl.h>
27 #include <common/dynamic-buffer.h>
28 #include <common/buffer-view.h>
29 #include <common/trace-chunk.h>
30 #include <lttng/location-internal.h>
31 #include <lttng/trigger/trigger-internal.h>
32 #include <lttng/condition/condition.h>
33 #include <lttng/action/action.h>
34 #include <lttng/channel.h>
35 #include <lttng/channel-internal.h>
36 #include <lttng/rotate-internal.h>
37 #include <lttng/location-internal.h>
38 #include <lttng/session-internal.h>
39 #include <lttng/userspace-probe-internal.h>
40 #include <lttng/session-descriptor-internal.h>
41 #include <common/string-utils/string-utils.h>
46 #include "health-sessiond.h"
48 #include "kernel-consumer.h"
49 #include "lttng-sessiond.h"
51 #include "lttng-syscall.h"
53 #include "buffer-registry.h"
54 #include "notification-thread.h"
55 #include "notification-thread-commands.h"
57 #include "rotation-thread.h"
59 #include "agent-thread.h"
63 /* Sleep for 100ms between each check for the shm path's deletion. */
64 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
66 struct cmd_destroy_session_reply_context
{
68 bool implicit_rotation_on_destroy
;
70 * Indicates whether or not an error occurred while launching the
71 * destruction of a session.
73 enum lttng_error_code destruction_status
;
76 static enum lttng_error_code
wait_on_path(void *path
);
79 * Command completion handler that is used by the destroy command
80 * when a session that has a non-default shm_path is being destroyed.
82 * See comment in cmd_destroy_session() for the rationale.
84 static struct destroy_completion_handler
{
85 struct cmd_completion_handler handler
;
86 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
87 } destroy_completion_handler
= {
90 .data
= destroy_completion_handler
.shm_path
95 static struct cmd_completion_handler
*current_completion_handler
;
98 * Used to keep a unique index for each relayd socket created where this value
99 * is associated with streams on the consumer so it can match the right relayd
100 * to send to. It must be accessed with the relayd_net_seq_idx_lock
103 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
104 static uint64_t relayd_net_seq_idx
;
106 static int validate_ust_event_name(const char *);
107 static int cmd_enable_event_internal(struct ltt_session
*session
,
108 const struct lttng_domain
*domain
,
109 char *channel_name
, struct lttng_event
*event
,
110 char *filter_expression
,
111 struct lttng_filter_bytecode
*filter
,
112 struct lttng_event_exclusion
*exclusion
,
116 * Create a session path used by list_lttng_sessions for the case that the
117 * session consumer is on the network.
119 static int build_network_session_path(char *dst
, size_t size
,
120 struct ltt_session
*session
)
122 int ret
, kdata_port
, udata_port
;
123 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
124 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
129 memset(tmp_urls
, 0, sizeof(tmp_urls
));
130 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
132 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
134 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
135 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
136 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
139 if (session
->ust_session
&& session
->ust_session
->consumer
) {
140 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
141 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
144 if (uuri
== NULL
&& kuri
== NULL
) {
145 uri
= &session
->consumer
->dst
.net
.control
;
146 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
147 } else if (kuri
&& uuri
) {
148 ret
= uri_compare(kuri
, uuri
);
152 /* Build uuri URL string */
153 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
160 } else if (kuri
&& uuri
== NULL
) {
162 } else if (uuri
&& kuri
== NULL
) {
166 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
172 * Do we have a UST url set. If yes, this means we have both kernel and UST
175 if (*tmp_uurl
!= '\0') {
176 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
177 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
180 if (kuri
|| (!kuri
&& !uuri
)) {
183 /* No kernel URI, use the UST port. */
186 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
194 * Get run-time attributes if the session has been started (discarded events,
197 static int get_kernel_runtime_stats(struct ltt_session
*session
,
198 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
199 uint64_t *lost_packets
)
203 if (!session
->has_been_started
) {
205 *discarded_events
= 0;
210 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
211 session
->kernel_session
->consumer
,
217 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
218 session
->kernel_session
->consumer
,
229 * Get run-time attributes if the session has been started (discarded events,
232 static int get_ust_runtime_stats(struct ltt_session
*session
,
233 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
234 uint64_t *lost_packets
)
237 struct ltt_ust_session
*usess
;
239 if (!discarded_events
|| !lost_packets
) {
244 usess
= session
->ust_session
;
245 assert(discarded_events
);
246 assert(lost_packets
);
248 if (!usess
|| !session
->has_been_started
) {
249 *discarded_events
= 0;
255 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
256 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
257 &usess
->buffer_reg_uid_list
,
258 usess
->consumer
, uchan
->id
,
259 uchan
->attr
.overwrite
,
262 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
263 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
264 uchan
, usess
->consumer
,
265 uchan
->attr
.overwrite
,
271 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
272 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
274 ERR("Unsupported buffer type");
285 * Fill lttng_channel array of all channels.
287 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
288 struct ltt_session
*session
, struct lttng_channel
*channels
,
289 struct lttng_channel_extended
*chan_exts
)
292 struct ltt_kernel_channel
*kchan
;
294 DBG("Listing channels for session %s", session
->name
);
297 case LTTNG_DOMAIN_KERNEL
:
298 /* Kernel channels */
299 if (session
->kernel_session
!= NULL
) {
300 cds_list_for_each_entry(kchan
,
301 &session
->kernel_session
->channel_list
.head
, list
) {
302 uint64_t discarded_events
, lost_packets
;
303 struct lttng_channel_extended
*extended
;
305 extended
= (struct lttng_channel_extended
*)
306 kchan
->channel
->attr
.extended
.ptr
;
308 ret
= get_kernel_runtime_stats(session
, kchan
,
309 &discarded_events
, &lost_packets
);
313 /* Copy lttng_channel struct to array */
314 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
315 channels
[i
].enabled
= kchan
->enabled
;
316 chan_exts
[i
].discarded_events
=
318 chan_exts
[i
].lost_packets
= lost_packets
;
319 chan_exts
[i
].monitor_timer_interval
=
320 extended
->monitor_timer_interval
;
321 chan_exts
[i
].blocking_timeout
= 0;
326 case LTTNG_DOMAIN_UST
:
328 struct lttng_ht_iter iter
;
329 struct ltt_ust_channel
*uchan
;
332 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
333 &iter
.iter
, uchan
, node
.node
) {
334 uint64_t discarded_events
= 0, lost_packets
= 0;
336 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
337 LTTNG_SYMBOL_NAME_LEN
)) {
340 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
341 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
342 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
343 channels
[i
].attr
.switch_timer_interval
=
344 uchan
->attr
.switch_timer_interval
;
345 channels
[i
].attr
.read_timer_interval
=
346 uchan
->attr
.read_timer_interval
;
347 channels
[i
].enabled
= uchan
->enabled
;
348 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
349 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
352 * Map enum lttng_ust_output to enum lttng_event_output.
354 switch (uchan
->attr
.output
) {
356 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
360 * LTTNG_UST_MMAP is the only supported UST
367 chan_exts
[i
].monitor_timer_interval
=
368 uchan
->monitor_timer_interval
;
369 chan_exts
[i
].blocking_timeout
=
370 uchan
->attr
.u
.s
.blocking_timeout
;
372 ret
= get_ust_runtime_stats(session
, uchan
,
373 &discarded_events
, &lost_packets
);
377 chan_exts
[i
].discarded_events
= discarded_events
;
378 chan_exts
[i
].lost_packets
= lost_packets
;
390 return -LTTNG_ERR_FATAL
;
396 static int increment_extended_len(const char *filter_expression
,
397 struct lttng_event_exclusion
*exclusion
,
398 const struct lttng_userspace_probe_location
*probe_location
,
399 size_t *extended_len
)
403 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
405 if (filter_expression
) {
406 *extended_len
+= strlen(filter_expression
) + 1;
410 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
413 if (probe_location
) {
414 ret
= lttng_userspace_probe_location_serialize(probe_location
,
419 *extended_len
+= ret
;
426 static int append_extended_info(const char *filter_expression
,
427 struct lttng_event_exclusion
*exclusion
,
428 struct lttng_userspace_probe_location
*probe_location
,
432 size_t filter_len
= 0;
433 size_t nb_exclusions
= 0;
434 size_t userspace_probe_location_len
= 0;
435 struct lttng_dynamic_buffer location_buffer
;
436 struct lttcomm_event_extended_header extended_header
;
438 if (filter_expression
) {
439 filter_len
= strlen(filter_expression
) + 1;
443 nb_exclusions
= exclusion
->count
;
446 if (probe_location
) {
447 lttng_dynamic_buffer_init(&location_buffer
);
448 ret
= lttng_userspace_probe_location_serialize(probe_location
,
449 &location_buffer
, NULL
);
454 userspace_probe_location_len
= location_buffer
.size
;
457 /* Set header fields */
458 extended_header
.filter_len
= filter_len
;
459 extended_header
.nb_exclusions
= nb_exclusions
;
460 extended_header
.userspace_probe_location_len
= userspace_probe_location_len
;
463 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
464 *extended_at
+= sizeof(extended_header
);
466 /* Copy filter string */
467 if (filter_expression
) {
468 memcpy(*extended_at
, filter_expression
, filter_len
);
469 *extended_at
+= filter_len
;
472 /* Copy exclusion names */
474 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
476 memcpy(*extended_at
, &exclusion
->names
, len
);
480 if (probe_location
) {
481 memcpy(*extended_at
, location_buffer
.data
, location_buffer
.size
);
482 *extended_at
+= location_buffer
.size
;
483 lttng_dynamic_buffer_reset(&location_buffer
);
491 * Create a list of agent domain events.
493 * Return number of events in list on success or else a negative value.
495 static int list_lttng_agent_events(struct agent
*agt
,
496 struct lttng_event
**events
, size_t *total_size
)
499 unsigned int nb_event
= 0;
500 struct agent_event
*event
;
501 struct lttng_event
*tmp_events
= NULL
;
502 struct lttng_ht_iter iter
;
503 size_t extended_len
= 0;
509 DBG3("Listing agent events");
512 nb_event
= lttng_ht_get_count(agt
->events
);
520 /* Compute required extended infos size */
521 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
524 * This is only valid because the commands which add events are
525 * processed in the same thread as the listing.
528 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
529 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
532 DBG("Error computing the length of extended info message");
533 ret
= -LTTNG_ERR_FATAL
;
539 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
540 tmp_events
= zmalloc(*total_size
);
542 PERROR("zmalloc agent events session");
543 ret
= -LTTNG_ERR_FATAL
;
547 extended_at
= ((uint8_t *) tmp_events
) +
548 nb_event
* sizeof(struct lttng_event
);
551 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
552 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
553 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
554 tmp_events
[i
].enabled
= event
->enabled
;
555 tmp_events
[i
].loglevel
= event
->loglevel_value
;
556 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
559 /* Append extended info */
560 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
563 DBG("Error appending extended info message");
564 ret
= -LTTNG_ERR_FATAL
;
569 *events
= tmp_events
;
571 assert(nb_event
== i
);
582 * Create a list of ust global domain events.
584 static int list_lttng_ust_global_events(char *channel_name
,
585 struct ltt_ust_domain_global
*ust_global
,
586 struct lttng_event
**events
, size_t *total_size
)
589 unsigned int nb_event
= 0;
590 struct lttng_ht_iter iter
;
591 struct lttng_ht_node_str
*node
;
592 struct ltt_ust_channel
*uchan
;
593 struct ltt_ust_event
*uevent
;
594 struct lttng_event
*tmp
;
595 size_t extended_len
= 0;
598 DBG("Listing UST global events for channel %s", channel_name
);
602 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
603 node
= lttng_ht_iter_get_node_str(&iter
);
605 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
609 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
611 nb_event
= lttng_ht_get_count(uchan
->events
);
618 DBG3("Listing UST global %d events", nb_event
);
620 /* Compute required extended infos size */
621 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
622 if (uevent
->internal
) {
627 ret
= increment_extended_len(uevent
->filter_expression
,
628 uevent
->exclusion
, NULL
, &extended_len
);
630 DBG("Error computing the length of extended info message");
631 ret
= -LTTNG_ERR_FATAL
;
636 /* All events are internal, skip. */
642 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
643 tmp
= zmalloc(*total_size
);
645 ret
= -LTTNG_ERR_FATAL
;
649 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
651 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
652 if (uevent
->internal
) {
653 /* This event should remain hidden from clients */
656 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
657 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
658 tmp
[i
].enabled
= uevent
->enabled
;
660 switch (uevent
->attr
.instrumentation
) {
661 case LTTNG_UST_TRACEPOINT
:
662 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
664 case LTTNG_UST_PROBE
:
665 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
667 case LTTNG_UST_FUNCTION
:
668 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
672 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
673 switch (uevent
->attr
.loglevel_type
) {
674 case LTTNG_UST_LOGLEVEL_ALL
:
675 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
677 case LTTNG_UST_LOGLEVEL_RANGE
:
678 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
680 case LTTNG_UST_LOGLEVEL_SINGLE
:
681 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
684 if (uevent
->filter
) {
687 if (uevent
->exclusion
) {
688 tmp
[i
].exclusion
= 1;
692 /* Append extended info */
693 ret
= append_extended_info(uevent
->filter_expression
,
694 uevent
->exclusion
, NULL
, &extended_at
);
696 DBG("Error appending extended info message");
697 ret
= -LTTNG_ERR_FATAL
;
710 * Fill lttng_event array of all kernel events in the channel.
712 static int list_lttng_kernel_events(char *channel_name
,
713 struct ltt_kernel_session
*kernel_session
,
714 struct lttng_event
**events
, size_t *total_size
)
717 unsigned int nb_event
;
718 struct ltt_kernel_event
*event
;
719 struct ltt_kernel_channel
*kchan
;
720 size_t extended_len
= 0;
723 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
725 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
729 nb_event
= kchan
->event_count
;
731 DBG("Listing events for channel %s", kchan
->channel
->name
);
739 /* Compute required extended infos size */
740 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
741 ret
= increment_extended_len(event
->filter_expression
, NULL
,
742 event
->userspace_probe_location
,
745 DBG("Error computing the length of extended info message");
746 ret
= -LTTNG_ERR_FATAL
;
751 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
752 *events
= zmalloc(*total_size
);
753 if (*events
== NULL
) {
754 ret
= -LTTNG_ERR_FATAL
;
758 extended_at
= ((void *) *events
) +
759 nb_event
* sizeof(struct lttng_event
);
761 /* Kernel channels */
762 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
763 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
764 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
765 (*events
)[i
].enabled
= event
->enabled
;
766 (*events
)[i
].filter
=
767 (unsigned char) !!event
->filter_expression
;
769 switch (event
->event
->instrumentation
) {
770 case LTTNG_KERNEL_TRACEPOINT
:
771 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
773 case LTTNG_KERNEL_KRETPROBE
:
774 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
775 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
776 sizeof(struct lttng_kernel_kprobe
));
778 case LTTNG_KERNEL_KPROBE
:
779 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
780 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
781 sizeof(struct lttng_kernel_kprobe
));
783 case LTTNG_KERNEL_UPROBE
:
784 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
786 case LTTNG_KERNEL_FUNCTION
:
787 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
788 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
789 sizeof(struct lttng_kernel_function
));
791 case LTTNG_KERNEL_NOOP
:
792 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
794 case LTTNG_KERNEL_SYSCALL
:
795 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
797 case LTTNG_KERNEL_ALL
:
805 /* Append extended info */
806 ret
= append_extended_info(event
->filter_expression
, NULL
,
807 event
->userspace_probe_location
, &extended_at
);
809 DBG("Error appending extended info message");
810 ret
= -LTTNG_ERR_FATAL
;
823 * Add URI so the consumer output object. Set the correct path depending on the
824 * domain adding the default trace directory.
826 static enum lttng_error_code
add_uri_to_consumer(
827 const struct ltt_session
*session
,
828 struct consumer_output
*consumer
,
829 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
832 enum lttng_error_code ret_code
= LTTNG_OK
;
836 if (consumer
== NULL
) {
837 DBG("No consumer detected. Don't add URI. Stopping.");
838 ret_code
= LTTNG_ERR_NO_CONSUMER
;
843 case LTTNG_DOMAIN_KERNEL
:
844 ret
= lttng_strncpy(consumer
->domain_subdir
,
845 DEFAULT_KERNEL_TRACE_DIR
,
846 sizeof(consumer
->domain_subdir
));
848 case LTTNG_DOMAIN_UST
:
849 ret
= lttng_strncpy(consumer
->domain_subdir
,
850 DEFAULT_UST_TRACE_DIR
,
851 sizeof(consumer
->domain_subdir
));
855 * This case is possible is we try to add the URI to the global
856 * tracing session consumer object which in this case there is
859 memset(consumer
->domain_subdir
, 0,
860 sizeof(consumer
->domain_subdir
));
864 ERR("Failed to initialize consumer output domain subdirectory");
865 ret_code
= LTTNG_ERR_FATAL
;
869 switch (uri
->dtype
) {
872 DBG2("Setting network URI to consumer");
874 if (consumer
->type
== CONSUMER_DST_NET
) {
875 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
876 consumer
->dst
.net
.control_isset
) ||
877 (uri
->stype
== LTTNG_STREAM_DATA
&&
878 consumer
->dst
.net
.data_isset
)) {
879 ret_code
= LTTNG_ERR_URL_EXIST
;
883 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
886 /* Set URI into consumer output object */
887 ret
= consumer_set_network_uri(session
, consumer
, uri
);
891 } else if (ret
== 1) {
893 * URI was the same in the consumer so we do not append the subdir
894 * again so to not duplicate output dir.
901 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
902 ret_code
= LTTNG_ERR_INVALID
;
905 DBG2("Setting trace directory path from URI to %s",
907 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
909 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
911 sizeof(consumer
->dst
.session_root_path
));
913 ret_code
= LTTNG_ERR_FATAL
;
916 consumer
->type
= CONSUMER_DST_LOCAL
;
926 * Init tracing by creating trace directory and sending fds kernel consumer.
928 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
931 struct lttng_ht_iter iter
;
932 struct consumer_socket
*socket
;
938 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
939 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
941 pthread_mutex_lock(socket
->lock
);
942 ret
= kernel_consumer_send_session(socket
, session
);
943 pthread_mutex_unlock(socket
->lock
);
945 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
957 * Create a socket to the relayd using the URI.
959 * On success, the relayd_sock pointer is set to the created socket.
960 * Else, it remains untouched and an LTTng error code is returned.
962 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
963 struct lttcomm_relayd_sock
**relayd_sock
,
964 struct consumer_output
*consumer
)
967 enum lttng_error_code status
= LTTNG_OK
;
968 struct lttcomm_relayd_sock
*rsock
;
970 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
971 RELAYD_VERSION_COMM_MINOR
);
973 status
= LTTNG_ERR_FATAL
;
978 * Connect to relayd so we can proceed with a session creation. This call
979 * can possibly block for an arbitrary amount of time to set the health
980 * state to be in poll execution.
983 ret
= relayd_connect(rsock
);
986 ERR("Unable to reach lttng-relayd");
987 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
991 /* Create socket for control stream. */
992 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
993 uint64_t result_flags
;
995 DBG3("Creating relayd stream socket from URI");
997 /* Check relayd version */
998 ret
= relayd_version_check(rsock
);
999 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
1000 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
1002 } else if (ret
< 0) {
1003 ERR("Unable to reach lttng-relayd");
1004 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1007 consumer
->relay_major_version
= rsock
->major
;
1008 consumer
->relay_minor_version
= rsock
->minor
;
1009 ret
= relayd_get_configuration(rsock
, 0,
1012 ERR("Unable to get relayd configuration");
1013 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1016 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
1017 consumer
->relay_allows_clear
= true;
1019 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1020 DBG3("Creating relayd data socket from URI");
1022 /* Command is not valid */
1023 ERR("Relayd invalid stream type: %d", uri
->stype
);
1024 status
= LTTNG_ERR_INVALID
;
1028 *relayd_sock
= rsock
;
1033 /* The returned value is not useful since we are on an error path. */
1034 (void) relayd_close(rsock
);
1042 * Connect to the relayd using URI and send the socket to the right consumer.
1044 * The consumer socket lock must be held by the caller.
1046 * Returns LTTNG_OK on success or an LTTng error code on failure.
1048 static enum lttng_error_code
send_consumer_relayd_socket(
1049 unsigned int session_id
,
1050 struct lttng_uri
*relayd_uri
,
1051 struct consumer_output
*consumer
,
1052 struct consumer_socket
*consumer_sock
,
1053 const char *session_name
, const char *hostname
,
1054 const char *base_path
, int session_live_timer
,
1055 const uint64_t *current_chunk_id
,
1056 time_t session_creation_time
,
1057 bool session_name_contains_creation_time
)
1060 struct lttcomm_relayd_sock
*rsock
= NULL
;
1061 enum lttng_error_code status
;
1063 /* Connect to relayd and make version check if uri is the control. */
1064 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1065 if (status
!= LTTNG_OK
) {
1066 goto relayd_comm_error
;
1070 /* Set the network sequence index if not set. */
1071 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1072 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1074 * Increment net_seq_idx because we are about to transfer the
1075 * new relayd socket to the consumer.
1076 * Assign unique key so the consumer can match streams.
1078 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1079 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1082 /* Send relayd socket to consumer. */
1083 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1084 relayd_uri
->stype
, session_id
,
1085 session_name
, hostname
, base_path
,
1086 session_live_timer
, current_chunk_id
,
1087 session_creation_time
, session_name_contains_creation_time
);
1089 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1093 /* Flag that the corresponding socket was sent. */
1094 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1095 consumer_sock
->control_sock_sent
= 1;
1096 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1097 consumer_sock
->data_sock_sent
= 1;
1101 * Close socket which was dup on the consumer side. The session daemon does
1102 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1106 if (status
!= LTTNG_OK
) {
1108 * The consumer output for this session should not be used anymore
1109 * since the relayd connection failed thus making any tracing or/and
1110 * streaming not usable.
1112 consumer
->enabled
= 0;
1114 (void) relayd_close(rsock
);
1122 * Send both relayd sockets to a specific consumer and domain. This is a
1123 * helper function to facilitate sending the information to the consumer for a
1126 * The consumer socket lock must be held by the caller.
1128 * Returns LTTNG_OK, or an LTTng error code on failure.
1130 static enum lttng_error_code
send_consumer_relayd_sockets(
1131 enum lttng_domain_type domain
,
1132 unsigned int session_id
, struct consumer_output
*consumer
,
1133 struct consumer_socket
*sock
, const char *session_name
,
1134 const char *hostname
, const char *base_path
, int session_live_timer
,
1135 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1136 bool session_name_contains_creation_time
)
1138 enum lttng_error_code status
= LTTNG_OK
;
1143 /* Sending control relayd socket. */
1144 if (!sock
->control_sock_sent
) {
1145 status
= send_consumer_relayd_socket(session_id
,
1146 &consumer
->dst
.net
.control
, consumer
, sock
,
1147 session_name
, hostname
, base_path
, session_live_timer
,
1148 current_chunk_id
, session_creation_time
,
1149 session_name_contains_creation_time
);
1150 if (status
!= LTTNG_OK
) {
1155 /* Sending data relayd socket. */
1156 if (!sock
->data_sock_sent
) {
1157 status
= send_consumer_relayd_socket(session_id
,
1158 &consumer
->dst
.net
.data
, consumer
, sock
,
1159 session_name
, hostname
, base_path
, session_live_timer
,
1160 current_chunk_id
, session_creation_time
,
1161 session_name_contains_creation_time
);
1162 if (status
!= LTTNG_OK
) {
1172 * Setup relayd connections for a tracing session. First creates the socket to
1173 * the relayd and send them to the right domain consumer. Consumer type MUST be
1176 int cmd_setup_relayd(struct ltt_session
*session
)
1179 struct ltt_ust_session
*usess
;
1180 struct ltt_kernel_session
*ksess
;
1181 struct consumer_socket
*socket
;
1182 struct lttng_ht_iter iter
;
1183 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1187 usess
= session
->ust_session
;
1188 ksess
= session
->kernel_session
;
1190 DBG("Setting relayd for session %s", session
->name
);
1193 if (session
->current_trace_chunk
) {
1194 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1195 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1197 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1198 current_chunk_id
.is_set
= true;
1200 ERR("Failed to get current trace chunk id");
1201 ret
= LTTNG_ERR_UNK
;
1206 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1207 && usess
->consumer
->enabled
) {
1208 /* For each consumer socket, send relayd sockets */
1209 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1210 socket
, node
.node
) {
1211 pthread_mutex_lock(socket
->lock
);
1212 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1213 usess
->consumer
, socket
,
1214 session
->name
, session
->hostname
,
1216 session
->live_timer
,
1217 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1218 session
->creation_time
,
1219 session
->name_contains_creation_time
);
1220 pthread_mutex_unlock(socket
->lock
);
1221 if (ret
!= LTTNG_OK
) {
1224 /* Session is now ready for network streaming. */
1225 session
->net_handle
= 1;
1227 session
->consumer
->relay_major_version
=
1228 usess
->consumer
->relay_major_version
;
1229 session
->consumer
->relay_minor_version
=
1230 usess
->consumer
->relay_minor_version
;
1231 session
->consumer
->relay_allows_clear
=
1232 usess
->consumer
->relay_allows_clear
;
1235 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1236 && ksess
->consumer
->enabled
) {
1237 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1238 socket
, node
.node
) {
1239 pthread_mutex_lock(socket
->lock
);
1240 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1241 ksess
->consumer
, socket
,
1242 session
->name
, session
->hostname
,
1244 session
->live_timer
,
1245 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1246 session
->creation_time
,
1247 session
->name_contains_creation_time
);
1248 pthread_mutex_unlock(socket
->lock
);
1249 if (ret
!= LTTNG_OK
) {
1252 /* Session is now ready for network streaming. */
1253 session
->net_handle
= 1;
1255 session
->consumer
->relay_major_version
=
1256 ksess
->consumer
->relay_major_version
;
1257 session
->consumer
->relay_minor_version
=
1258 ksess
->consumer
->relay_minor_version
;
1259 session
->consumer
->relay_allows_clear
=
1260 ksess
->consumer
->relay_allows_clear
;
1269 * Start a kernel session by opening all necessary streams.
1271 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1274 struct ltt_kernel_channel
*kchan
;
1276 /* Open kernel metadata */
1277 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1278 ret
= kernel_open_metadata(ksess
);
1280 ret
= LTTNG_ERR_KERN_META_FAIL
;
1285 /* Open kernel metadata stream */
1286 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1287 ret
= kernel_open_metadata_stream(ksess
);
1289 ERR("Kernel create metadata stream failed");
1290 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1295 /* For each channel */
1296 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1297 if (kchan
->stream_count
== 0) {
1298 ret
= kernel_open_channel_stream(kchan
);
1300 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1303 /* Update the stream global counter */
1304 ksess
->stream_count_global
+= ret
;
1308 /* Setup kernel consumer socket and send fds to it */
1309 ret
= init_kernel_tracing(ksess
);
1311 ret
= LTTNG_ERR_KERN_START_FAIL
;
1315 /* This start the kernel tracing */
1316 ret
= kernel_start_session(ksess
);
1318 ret
= LTTNG_ERR_KERN_START_FAIL
;
1322 /* Quiescent wait after starting trace */
1323 kernel_wait_quiescent();
1333 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1335 struct ltt_kernel_channel
*kchan
;
1336 bool error_occurred
= false;
1339 if (!ksess
|| !ksess
->active
) {
1342 DBG("Stopping kernel tracing");
1344 ret
= kernel_stop_session(ksess
);
1346 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1350 kernel_wait_quiescent();
1352 /* Flush metadata after stopping (if exists) */
1353 if (ksess
->metadata_stream_fd
>= 0) {
1354 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1356 ERR("Kernel metadata flush failed");
1357 error_occurred
= true;
1361 /* Flush all buffers after stopping */
1362 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1363 ret
= kernel_flush_buffer(kchan
);
1365 ERR("Kernel flush buffer error");
1366 error_occurred
= true;
1371 if (error_occurred
) {
1372 ret
= LTTNG_ERR_UNK
;
1381 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1383 int cmd_disable_channel(struct ltt_session
*session
,
1384 enum lttng_domain_type domain
, char *channel_name
)
1387 struct ltt_ust_session
*usess
;
1389 usess
= session
->ust_session
;
1394 case LTTNG_DOMAIN_KERNEL
:
1396 ret
= channel_kernel_disable(session
->kernel_session
,
1398 if (ret
!= LTTNG_OK
) {
1402 kernel_wait_quiescent();
1405 case LTTNG_DOMAIN_UST
:
1407 struct ltt_ust_channel
*uchan
;
1408 struct lttng_ht
*chan_ht
;
1410 chan_ht
= usess
->domain_global
.channels
;
1412 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1413 if (uchan
== NULL
) {
1414 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1418 ret
= channel_ust_disable(usess
, uchan
);
1419 if (ret
!= LTTNG_OK
) {
1425 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1437 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1439 * The wpipe arguments is used as a notifier for the kernel thread.
1441 int cmd_enable_channel(struct ltt_session
*session
,
1442 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1445 struct ltt_ust_session
*usess
= session
->ust_session
;
1446 struct lttng_ht
*chan_ht
;
1448 struct lttng_channel attr
;
1455 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1457 /* Validate channel name */
1458 if (attr
.name
[0] == '.' ||
1459 memchr(attr
.name
, '/', len
) != NULL
) {
1460 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1464 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1469 * Don't try to enable a channel if the session has been started at
1470 * some point in time before. The tracer does not allow it.
1472 if (session
->has_been_started
) {
1473 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1478 * If the session is a live session, remove the switch timer, the
1479 * live timer does the same thing but sends also synchronisation
1480 * beacons for inactive streams.
1482 if (session
->live_timer
> 0) {
1483 attr
.attr
.live_timer_interval
= session
->live_timer
;
1484 attr
.attr
.switch_timer_interval
= 0;
1487 /* Check for feature support */
1488 switch (domain
->type
) {
1489 case LTTNG_DOMAIN_KERNEL
:
1491 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1492 /* Sampling position of buffer is not supported */
1493 WARN("Kernel tracer does not support buffer monitoring. "
1494 "Setting the monitor interval timer to 0 "
1495 "(disabled) for channel '%s' of session '%s'",
1496 attr
.name
, session
->name
);
1497 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1501 case LTTNG_DOMAIN_UST
:
1503 case LTTNG_DOMAIN_JUL
:
1504 case LTTNG_DOMAIN_LOG4J
:
1505 case LTTNG_DOMAIN_PYTHON
:
1506 if (!agent_tracing_is_enabled()) {
1507 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1508 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1513 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1517 switch (domain
->type
) {
1518 case LTTNG_DOMAIN_KERNEL
:
1520 struct ltt_kernel_channel
*kchan
;
1522 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1523 session
->kernel_session
);
1524 if (kchan
== NULL
) {
1525 if (session
->snapshot
.nb_output
> 0 ||
1526 session
->snapshot_mode
) {
1527 /* Enforce mmap output for snapshot sessions. */
1528 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1530 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1531 if (attr
.name
[0] != '\0') {
1532 session
->kernel_session
->has_non_default_channel
= 1;
1535 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1538 if (ret
!= LTTNG_OK
) {
1542 kernel_wait_quiescent();
1545 case LTTNG_DOMAIN_UST
:
1546 case LTTNG_DOMAIN_JUL
:
1547 case LTTNG_DOMAIN_LOG4J
:
1548 case LTTNG_DOMAIN_PYTHON
:
1550 struct ltt_ust_channel
*uchan
;
1555 * Current agent implementation limitations force us to allow
1556 * only one channel at once in "agent" subdomains. Each
1557 * subdomain has a default channel name which must be strictly
1560 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1561 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1562 LTTNG_SYMBOL_NAME_LEN
)) {
1563 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1566 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1567 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1568 LTTNG_SYMBOL_NAME_LEN
)) {
1569 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1572 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1573 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1574 LTTNG_SYMBOL_NAME_LEN
)) {
1575 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1580 chan_ht
= usess
->domain_global
.channels
;
1582 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1583 if (uchan
== NULL
) {
1584 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1585 if (attr
.name
[0] != '\0') {
1586 usess
->has_non_default_channel
= 1;
1589 ret
= channel_ust_enable(usess
, uchan
);
1594 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1598 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1599 session
->has_non_mmap_channel
= true;
1607 enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(
1608 struct ltt_session
*session
,
1609 enum lttng_domain_type domain
,
1610 enum lttng_process_attr process_attr
,
1611 enum lttng_tracking_policy
*policy
)
1613 enum lttng_error_code ret_code
= LTTNG_OK
;
1614 const struct process_attr_tracker
*tracker
;
1617 case LTTNG_DOMAIN_KERNEL
:
1618 if (!session
->kernel_session
) {
1619 ret_code
= LTTNG_ERR_INVALID
;
1622 tracker
= kernel_get_process_attr_tracker(
1623 session
->kernel_session
, process_attr
);
1625 case LTTNG_DOMAIN_UST
:
1626 if (!session
->ust_session
) {
1627 ret_code
= LTTNG_ERR_INVALID
;
1630 tracker
= trace_ust_get_process_attr_tracker(
1631 session
->ust_session
, process_attr
);
1634 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1638 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1640 ret_code
= LTTNG_ERR_INVALID
;
1646 enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(
1647 struct ltt_session
*session
,
1648 enum lttng_domain_type domain
,
1649 enum lttng_process_attr process_attr
,
1650 enum lttng_tracking_policy policy
)
1652 enum lttng_error_code ret_code
= LTTNG_OK
;
1655 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1656 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1657 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1660 ret_code
= LTTNG_ERR_INVALID
;
1665 case LTTNG_DOMAIN_KERNEL
:
1666 if (!session
->kernel_session
) {
1667 ret_code
= LTTNG_ERR_INVALID
;
1670 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1671 session
->kernel_session
, process_attr
, policy
);
1673 case LTTNG_DOMAIN_UST
:
1674 if (!session
->ust_session
) {
1675 ret_code
= LTTNG_ERR_INVALID
;
1678 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1679 session
->ust_session
, process_attr
, policy
);
1682 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1689 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(
1690 struct ltt_session
*session
,
1691 enum lttng_domain_type domain
,
1692 enum lttng_process_attr process_attr
,
1693 const struct process_attr_value
*value
)
1695 enum lttng_error_code ret_code
= LTTNG_OK
;
1698 case LTTNG_DOMAIN_KERNEL
:
1699 if (!session
->kernel_session
) {
1700 ret_code
= LTTNG_ERR_INVALID
;
1703 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1704 session
->kernel_session
, process_attr
, value
);
1706 case LTTNG_DOMAIN_UST
:
1707 if (!session
->ust_session
) {
1708 ret_code
= LTTNG_ERR_INVALID
;
1711 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1712 session
->ust_session
, process_attr
, value
);
1715 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1722 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(
1723 struct ltt_session
*session
,
1724 enum lttng_domain_type domain
,
1725 enum lttng_process_attr process_attr
,
1726 const struct process_attr_value
*value
)
1728 enum lttng_error_code ret_code
= LTTNG_OK
;
1731 case LTTNG_DOMAIN_KERNEL
:
1732 if (!session
->kernel_session
) {
1733 ret_code
= LTTNG_ERR_INVALID
;
1736 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1737 session
->kernel_session
, process_attr
, value
);
1739 case LTTNG_DOMAIN_UST
:
1740 if (!session
->ust_session
) {
1741 ret_code
= LTTNG_ERR_INVALID
;
1744 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1745 session
->ust_session
, process_attr
, value
);
1748 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1755 enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(
1756 struct ltt_session
*session
,
1757 enum lttng_domain_type domain
,
1758 enum lttng_process_attr process_attr
,
1759 struct lttng_process_attr_values
**values
)
1761 enum lttng_error_code ret_code
= LTTNG_OK
;
1762 const struct process_attr_tracker
*tracker
;
1763 enum process_attr_tracker_status status
;
1766 case LTTNG_DOMAIN_KERNEL
:
1767 if (!session
->kernel_session
) {
1768 ret_code
= LTTNG_ERR_INVALID
;
1771 tracker
= kernel_get_process_attr_tracker(
1772 session
->kernel_session
, process_attr
);
1774 case LTTNG_DOMAIN_UST
:
1775 if (!session
->ust_session
) {
1776 ret_code
= LTTNG_ERR_INVALID
;
1779 tracker
= trace_ust_get_process_attr_tracker(
1780 session
->ust_session
, process_attr
);
1783 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1788 ret_code
= LTTNG_ERR_INVALID
;
1792 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1794 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1795 ret_code
= LTTNG_OK
;
1797 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1798 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1800 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1801 ret_code
= LTTNG_ERR_NOMEM
;
1804 ret_code
= LTTNG_ERR_UNK
;
1813 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1815 int cmd_disable_event(struct ltt_session
*session
,
1816 enum lttng_domain_type domain
, const char *channel_name
,
1817 const struct lttng_event
*event
)
1820 const char *event_name
;
1822 DBG("Disable event command for event \'%s\'", event
->name
);
1824 event_name
= event
->name
;
1826 /* Error out on unhandled search criteria */
1827 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1828 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1829 ret
= LTTNG_ERR_UNK
;
1836 case LTTNG_DOMAIN_KERNEL
:
1838 struct ltt_kernel_channel
*kchan
;
1839 struct ltt_kernel_session
*ksess
;
1841 ksess
= session
->kernel_session
;
1844 * If a non-default channel has been created in the
1845 * session, explicitely require that -c chan_name needs
1848 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1849 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1853 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1854 if (kchan
== NULL
) {
1855 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1859 switch (event
->type
) {
1860 case LTTNG_EVENT_ALL
:
1861 case LTTNG_EVENT_TRACEPOINT
:
1862 case LTTNG_EVENT_SYSCALL
:
1863 case LTTNG_EVENT_PROBE
:
1864 case LTTNG_EVENT_FUNCTION
:
1865 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1866 if (event_name
[0] == '\0') {
1867 ret
= event_kernel_disable_event(kchan
,
1870 ret
= event_kernel_disable_event(kchan
,
1871 event_name
, event
->type
);
1873 if (ret
!= LTTNG_OK
) {
1878 ret
= LTTNG_ERR_UNK
;
1882 kernel_wait_quiescent();
1885 case LTTNG_DOMAIN_UST
:
1887 struct ltt_ust_channel
*uchan
;
1888 struct ltt_ust_session
*usess
;
1890 usess
= session
->ust_session
;
1892 if (validate_ust_event_name(event_name
)) {
1893 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1898 * If a non-default channel has been created in the
1899 * session, explicitly require that -c chan_name needs
1902 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1903 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1907 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1909 if (uchan
== NULL
) {
1910 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1914 switch (event
->type
) {
1915 case LTTNG_EVENT_ALL
:
1917 * An empty event name means that everything
1918 * should be disabled.
1920 if (event
->name
[0] == '\0') {
1921 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1923 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1926 if (ret
!= LTTNG_OK
) {
1931 ret
= LTTNG_ERR_UNK
;
1935 DBG3("Disable UST event %s in channel %s completed", event_name
,
1939 case LTTNG_DOMAIN_LOG4J
:
1940 case LTTNG_DOMAIN_JUL
:
1941 case LTTNG_DOMAIN_PYTHON
:
1944 struct ltt_ust_session
*usess
= session
->ust_session
;
1948 switch (event
->type
) {
1949 case LTTNG_EVENT_ALL
:
1952 ret
= LTTNG_ERR_UNK
;
1956 agt
= trace_ust_find_agent(usess
, domain
);
1958 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1962 * An empty event name means that everything
1963 * should be disabled.
1965 if (event
->name
[0] == '\0') {
1966 ret
= event_agent_disable_all(usess
, agt
);
1968 ret
= event_agent_disable(usess
, agt
, event_name
);
1970 if (ret
!= LTTNG_OK
) {
1977 ret
= LTTNG_ERR_UND
;
1990 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1992 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1993 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1995 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1996 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1999 * Don't try to add a context if the session has been started at
2000 * some point in time before. The tracer does not allow it and would
2001 * result in a corrupted trace.
2003 if (session
->has_been_started
) {
2004 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2008 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
2009 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
2010 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
2014 case LTTNG_DOMAIN_KERNEL
:
2015 assert(session
->kernel_session
);
2017 if (session
->kernel_session
->channel_count
== 0) {
2018 /* Create default channel */
2019 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
2020 if (ret
!= LTTNG_OK
) {
2023 chan_kern_created
= 1;
2025 /* Add kernel context to kernel tracer */
2026 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
2027 if (ret
!= LTTNG_OK
) {
2031 case LTTNG_DOMAIN_JUL
:
2032 case LTTNG_DOMAIN_LOG4J
:
2035 * Validate channel name.
2036 * If no channel name is given and the domain is JUL or LOG4J,
2037 * set it to the appropriate domain-specific channel name. If
2038 * a name is provided but does not match the expexted channel
2039 * name, return an error.
2041 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
2042 strcmp(channel_name
,
2043 DEFAULT_JUL_CHANNEL_NAME
)) {
2044 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2046 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
2047 strcmp(channel_name
,
2048 DEFAULT_LOG4J_CHANNEL_NAME
)) {
2049 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2052 /* break is _not_ missing here. */
2054 case LTTNG_DOMAIN_UST
:
2056 struct ltt_ust_session
*usess
= session
->ust_session
;
2057 unsigned int chan_count
;
2061 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
2062 if (chan_count
== 0) {
2063 struct lttng_channel
*attr
;
2064 /* Create default channel */
2065 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
2067 ret
= LTTNG_ERR_FATAL
;
2071 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
2072 if (ret
!= LTTNG_OK
) {
2076 channel_attr_destroy(attr
);
2077 chan_ust_created
= 1;
2080 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
2081 free(app_ctx_provider_name
);
2083 app_ctx_name
= NULL
;
2084 app_ctx_provider_name
= NULL
;
2085 if (ret
!= LTTNG_OK
) {
2091 ret
= LTTNG_ERR_UND
;
2099 if (chan_kern_created
) {
2100 struct ltt_kernel_channel
*kchan
=
2101 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
2102 session
->kernel_session
);
2103 /* Created previously, this should NOT fail. */
2105 kernel_destroy_channel(kchan
);
2108 if (chan_ust_created
) {
2109 struct ltt_ust_channel
*uchan
=
2110 trace_ust_find_channel_by_name(
2111 session
->ust_session
->domain_global
.channels
,
2112 DEFAULT_CHANNEL_NAME
);
2113 /* Created previously, this should NOT fail. */
2115 /* Remove from the channel list of the session. */
2116 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2118 trace_ust_destroy_channel(uchan
);
2121 free(app_ctx_provider_name
);
2126 static inline bool name_starts_with(const char *name
, const char *prefix
)
2128 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2130 return !strncmp(name
, prefix
, max_cmp_len
);
2133 /* Perform userspace-specific event name validation */
2134 static int validate_ust_event_name(const char *name
)
2144 * Check name against all internal UST event component namespaces used
2147 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2148 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2149 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2158 * Internal version of cmd_enable_event() with a supplemental
2159 * "internal_event" flag which is used to enable internal events which should
2160 * be hidden from clients. Such events are used in the agent implementation to
2161 * enable the events through which all "agent" events are funeled.
2163 static int _cmd_enable_event(struct ltt_session
*session
,
2164 const struct lttng_domain
*domain
,
2165 char *channel_name
, struct lttng_event
*event
,
2166 char *filter_expression
,
2167 struct lttng_filter_bytecode
*filter
,
2168 struct lttng_event_exclusion
*exclusion
,
2169 int wpipe
, bool internal_event
)
2171 int ret
= 0, channel_created
= 0;
2172 struct lttng_channel
*attr
= NULL
;
2176 assert(channel_name
);
2178 /* If we have a filter, we must have its filter expression */
2179 assert(!(!!filter_expression
^ !!filter
));
2181 /* Normalize event name as a globbing pattern */
2182 strutils_normalize_star_glob_pattern(event
->name
);
2184 /* Normalize exclusion names as globbing patterns */
2188 for (i
= 0; i
< exclusion
->count
; i
++) {
2189 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2191 strutils_normalize_star_glob_pattern(name
);
2195 DBG("Enable event command for event \'%s\'", event
->name
);
2199 switch (domain
->type
) {
2200 case LTTNG_DOMAIN_KERNEL
:
2202 struct ltt_kernel_channel
*kchan
;
2205 * If a non-default channel has been created in the
2206 * session, explicitely require that -c chan_name needs
2209 if (session
->kernel_session
->has_non_default_channel
2210 && channel_name
[0] == '\0') {
2211 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2215 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2216 session
->kernel_session
);
2217 if (kchan
== NULL
) {
2218 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2219 LTTNG_BUFFER_GLOBAL
);
2221 ret
= LTTNG_ERR_FATAL
;
2224 if (lttng_strncpy(attr
->name
, channel_name
,
2225 sizeof(attr
->name
))) {
2226 ret
= LTTNG_ERR_INVALID
;
2230 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2231 if (ret
!= LTTNG_OK
) {
2234 channel_created
= 1;
2237 /* Get the newly created kernel channel pointer */
2238 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2239 session
->kernel_session
);
2240 if (kchan
== NULL
) {
2241 /* This sould not happen... */
2242 ret
= LTTNG_ERR_FATAL
;
2246 switch (event
->type
) {
2247 case LTTNG_EVENT_ALL
:
2249 char *filter_expression_a
= NULL
;
2250 struct lttng_filter_bytecode
*filter_a
= NULL
;
2253 * We need to duplicate filter_expression and filter,
2254 * because ownership is passed to first enable
2257 if (filter_expression
) {
2258 filter_expression_a
= strdup(filter_expression
);
2259 if (!filter_expression_a
) {
2260 ret
= LTTNG_ERR_FATAL
;
2265 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2267 free(filter_expression_a
);
2268 ret
= LTTNG_ERR_FATAL
;
2271 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2273 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2274 ret
= event_kernel_enable_event(kchan
, event
,
2275 filter_expression
, filter
);
2276 /* We have passed ownership */
2277 filter_expression
= NULL
;
2279 if (ret
!= LTTNG_OK
) {
2280 if (channel_created
) {
2281 /* Let's not leak a useless channel. */
2282 kernel_destroy_channel(kchan
);
2284 free(filter_expression_a
);
2288 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2289 ret
= event_kernel_enable_event(kchan
, event
,
2290 filter_expression_a
, filter_a
);
2291 /* We have passed ownership */
2292 filter_expression_a
= NULL
;
2294 if (ret
!= LTTNG_OK
) {
2299 case LTTNG_EVENT_PROBE
:
2300 case LTTNG_EVENT_USERSPACE_PROBE
:
2301 case LTTNG_EVENT_FUNCTION
:
2302 case LTTNG_EVENT_FUNCTION_ENTRY
:
2303 case LTTNG_EVENT_TRACEPOINT
:
2304 ret
= event_kernel_enable_event(kchan
, event
,
2305 filter_expression
, filter
);
2306 /* We have passed ownership */
2307 filter_expression
= NULL
;
2309 if (ret
!= LTTNG_OK
) {
2310 if (channel_created
) {
2311 /* Let's not leak a useless channel. */
2312 kernel_destroy_channel(kchan
);
2317 case LTTNG_EVENT_SYSCALL
:
2318 ret
= event_kernel_enable_event(kchan
, event
,
2319 filter_expression
, filter
);
2320 /* We have passed ownership */
2321 filter_expression
= NULL
;
2323 if (ret
!= LTTNG_OK
) {
2328 ret
= LTTNG_ERR_UNK
;
2332 kernel_wait_quiescent();
2335 case LTTNG_DOMAIN_UST
:
2337 struct ltt_ust_channel
*uchan
;
2338 struct ltt_ust_session
*usess
= session
->ust_session
;
2343 * If a non-default channel has been created in the
2344 * session, explicitely require that -c chan_name needs
2347 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2348 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2352 /* Get channel from global UST domain */
2353 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2355 if (uchan
== NULL
) {
2356 /* Create default channel */
2357 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2358 usess
->buffer_type
);
2360 ret
= LTTNG_ERR_FATAL
;
2363 if (lttng_strncpy(attr
->name
, channel_name
,
2364 sizeof(attr
->name
))) {
2365 ret
= LTTNG_ERR_INVALID
;
2369 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2370 if (ret
!= LTTNG_OK
) {
2374 /* Get the newly created channel reference back */
2375 uchan
= trace_ust_find_channel_by_name(
2376 usess
->domain_global
.channels
, channel_name
);
2380 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2382 * Don't allow users to add UST events to channels which
2383 * are assigned to a userspace subdomain (JUL, Log4J,
2386 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2390 if (!internal_event
) {
2392 * Ensure the event name is not reserved for internal
2395 ret
= validate_ust_event_name(event
->name
);
2397 WARN("Userspace event name %s failed validation.",
2399 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2404 /* At this point, the session and channel exist on the tracer */
2405 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2406 filter_expression
, filter
, exclusion
,
2408 /* We have passed ownership */
2409 filter_expression
= NULL
;
2412 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2413 goto already_enabled
;
2414 } else if (ret
!= LTTNG_OK
) {
2419 case LTTNG_DOMAIN_LOG4J
:
2420 case LTTNG_DOMAIN_JUL
:
2421 case LTTNG_DOMAIN_PYTHON
:
2423 const char *default_event_name
, *default_chan_name
;
2425 struct lttng_event uevent
;
2426 struct lttng_domain tmp_dom
;
2427 struct ltt_ust_session
*usess
= session
->ust_session
;
2431 if (!agent_tracing_is_enabled()) {
2432 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2433 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2437 agt
= trace_ust_find_agent(usess
, domain
->type
);
2439 agt
= agent_create(domain
->type
);
2441 ret
= LTTNG_ERR_NOMEM
;
2444 agent_add(agt
, usess
->agents
);
2447 /* Create the default tracepoint. */
2448 memset(&uevent
, 0, sizeof(uevent
));
2449 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2450 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2451 default_event_name
= event_get_default_agent_ust_name(
2453 if (!default_event_name
) {
2454 ret
= LTTNG_ERR_FATAL
;
2457 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2458 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2461 * The domain type is changed because we are about to enable the
2462 * default channel and event for the JUL domain that are hardcoded.
2463 * This happens in the UST domain.
2465 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2466 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2468 switch (domain
->type
) {
2469 case LTTNG_DOMAIN_LOG4J
:
2470 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2472 case LTTNG_DOMAIN_JUL
:
2473 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2475 case LTTNG_DOMAIN_PYTHON
:
2476 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2479 /* The switch/case we are in makes this impossible */
2484 char *filter_expression_copy
= NULL
;
2485 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2488 const size_t filter_size
= sizeof(
2489 struct lttng_filter_bytecode
)
2492 filter_copy
= zmalloc(filter_size
);
2494 ret
= LTTNG_ERR_NOMEM
;
2497 memcpy(filter_copy
, filter
, filter_size
);
2499 filter_expression_copy
=
2500 strdup(filter_expression
);
2501 if (!filter_expression
) {
2502 ret
= LTTNG_ERR_NOMEM
;
2505 if (!filter_expression_copy
|| !filter_copy
) {
2506 free(filter_expression_copy
);
2512 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2513 (char *) default_chan_name
,
2514 &uevent
, filter_expression_copy
,
2515 filter_copy
, NULL
, wpipe
);
2518 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2519 goto already_enabled
;
2520 } else if (ret
!= LTTNG_OK
) {
2524 /* The wild card * means that everything should be enabled. */
2525 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2526 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2529 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2533 filter_expression
= NULL
;
2534 if (ret
!= LTTNG_OK
) {
2541 ret
= LTTNG_ERR_UND
;
2549 free(filter_expression
);
2552 channel_attr_destroy(attr
);
2558 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2559 * We own filter, exclusion, and filter_expression.
2561 int cmd_enable_event(struct ltt_session
*session
,
2562 const struct lttng_domain
*domain
,
2563 char *channel_name
, struct lttng_event
*event
,
2564 char *filter_expression
,
2565 struct lttng_filter_bytecode
*filter
,
2566 struct lttng_event_exclusion
*exclusion
,
2569 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2570 filter_expression
, filter
, exclusion
, wpipe
, false);
2574 * Enable an event which is internal to LTTng. An internal should
2575 * never be made visible to clients and are immune to checks such as
2578 static int cmd_enable_event_internal(struct ltt_session
*session
,
2579 const struct lttng_domain
*domain
,
2580 char *channel_name
, struct lttng_event
*event
,
2581 char *filter_expression
,
2582 struct lttng_filter_bytecode
*filter
,
2583 struct lttng_event_exclusion
*exclusion
,
2586 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2587 filter_expression
, filter
, exclusion
, wpipe
, true);
2591 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2593 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2594 struct lttng_event
**events
)
2597 ssize_t nb_events
= 0;
2600 case LTTNG_DOMAIN_KERNEL
:
2601 nb_events
= kernel_list_events(events
);
2602 if (nb_events
< 0) {
2603 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2607 case LTTNG_DOMAIN_UST
:
2608 nb_events
= ust_app_list_events(events
);
2609 if (nb_events
< 0) {
2610 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2614 case LTTNG_DOMAIN_LOG4J
:
2615 case LTTNG_DOMAIN_JUL
:
2616 case LTTNG_DOMAIN_PYTHON
:
2617 nb_events
= agent_list_events(events
, domain
);
2618 if (nb_events
< 0) {
2619 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2624 ret
= LTTNG_ERR_UND
;
2631 /* Return negative value to differentiate return code */
2636 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2638 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2639 struct lttng_event_field
**fields
)
2642 ssize_t nb_fields
= 0;
2645 case LTTNG_DOMAIN_UST
:
2646 nb_fields
= ust_app_list_event_fields(fields
);
2647 if (nb_fields
< 0) {
2648 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2652 case LTTNG_DOMAIN_KERNEL
:
2653 default: /* fall-through */
2654 ret
= LTTNG_ERR_UND
;
2661 /* Return negative value to differentiate return code */
2665 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2667 return syscall_table_list(events
);
2671 * Command LTTNG_START_TRACE processed by the client thread.
2673 * Called with session mutex held.
2675 int cmd_start_trace(struct ltt_session
*session
)
2677 enum lttng_error_code ret
;
2678 unsigned long nb_chan
= 0;
2679 struct ltt_kernel_session
*ksession
;
2680 struct ltt_ust_session
*usess
;
2681 const bool session_rotated_after_last_stop
=
2682 session
->rotated_after_last_stop
;
2683 const bool session_cleared_after_last_stop
=
2684 session
->cleared_after_last_stop
;
2688 /* Ease our life a bit ;) */
2689 ksession
= session
->kernel_session
;
2690 usess
= session
->ust_session
;
2692 /* Is the session already started? */
2693 if (session
->active
) {
2694 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2695 /* Perform nothing */
2699 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2700 !session
->current_trace_chunk
) {
2702 * A rotation was launched while the session was stopped and
2703 * it has not been completed yet. It is not possible to start
2704 * the session since starting the session here would require a
2705 * rotation from "NULL" to a new trace chunk. That rotation
2706 * would overlap with the ongoing rotation, which is not
2709 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2711 ret
= LTTNG_ERR_ROTATION_PENDING
;
2716 * Starting a session without channel is useless since after that it's not
2717 * possible to enable channel thus inform the client.
2719 if (usess
&& usess
->domain_global
.channels
) {
2720 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2723 nb_chan
+= ksession
->channel_count
;
2726 ret
= LTTNG_ERR_NO_CHANNEL
;
2730 session
->active
= 1;
2731 session
->rotated_after_last_stop
= false;
2732 session
->cleared_after_last_stop
= false;
2733 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2734 if (!session
->has_been_started
) {
2735 struct lttng_trace_chunk
*trace_chunk
;
2737 DBG("Creating initial trace chunk of session \"%s\"",
2739 trace_chunk
= session_create_new_trace_chunk(
2740 session
, NULL
, NULL
, NULL
);
2742 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2745 assert(!session
->current_trace_chunk
);
2746 ret
= session_set_trace_chunk(session
, trace_chunk
,
2748 lttng_trace_chunk_put(trace_chunk
);
2750 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2754 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2757 * Rotate existing streams into the new chunk.
2758 * This is a "quiet" rotation has no client has
2759 * explicitly requested this operation.
2761 * There is also no need to wait for the rotation
2762 * to complete as it will happen immediately. No data
2763 * was produced as the session was stopped, so the
2764 * rotation should happen on reception of the command.
2766 ret
= cmd_rotate_session(session
, NULL
, true,
2767 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2768 if (ret
!= LTTNG_OK
) {
2774 /* Kernel tracing */
2775 if (ksession
!= NULL
) {
2776 DBG("Start kernel tracing session %s", session
->name
);
2777 ret
= start_kernel_session(ksession
);
2778 if (ret
!= LTTNG_OK
) {
2783 /* Flag session that trace should start automatically */
2785 int int_ret
= ust_app_start_trace_all(usess
);
2788 ret
= LTTNG_ERR_UST_START_FAIL
;
2794 * Open a packet in every stream of the session to ensure that viewers
2795 * can correctly identify the boundaries of the periods during which
2796 * tracing was active for this session.
2798 ret
= session_open_packets(session
);
2799 if (ret
!= LTTNG_OK
) {
2804 * Clear the flag that indicates that a rotation was done while the
2805 * session was stopped.
2807 session
->rotated_after_last_stop
= false;
2809 if (session
->rotate_timer_period
) {
2810 int int_ret
= timer_session_rotation_schedule_timer_start(
2811 session
, session
->rotate_timer_period
);
2814 ERR("Failed to enable rotate timer");
2815 ret
= LTTNG_ERR_UNK
;
2823 if (ret
== LTTNG_OK
) {
2824 /* Flag this after a successful start. */
2825 session
->has_been_started
|= 1;
2827 session
->active
= 0;
2828 /* Restore initial state on error. */
2829 session
->rotated_after_last_stop
=
2830 session_rotated_after_last_stop
;
2831 session
->cleared_after_last_stop
=
2832 session_cleared_after_last_stop
;
2839 * Command LTTNG_STOP_TRACE processed by the client thread.
2841 int cmd_stop_trace(struct ltt_session
*session
)
2844 struct ltt_kernel_session
*ksession
;
2845 struct ltt_ust_session
*usess
;
2849 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2851 ksession
= session
->kernel_session
;
2852 usess
= session
->ust_session
;
2854 /* Session is not active. Skip everythong and inform the client. */
2855 if (!session
->active
) {
2856 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2860 ret
= stop_kernel_session(ksession
);
2861 if (ret
!= LTTNG_OK
) {
2865 if (usess
&& usess
->active
) {
2866 ret
= ust_app_stop_trace_all(usess
);
2868 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2873 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2875 /* Flag inactive after a successful stop. */
2876 session
->active
= 0;
2884 * Set the base_path of the session only if subdir of a control uris is set.
2885 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2887 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2889 struct lttng_uri
*uris
)
2894 for (i
= 0; i
< nb_uri
; i
++) {
2895 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2896 uris
[i
].subdir
[0] == '\0') {
2897 /* Not interested in these URIs */
2901 if (session
->base_path
!= NULL
) {
2902 free(session
->base_path
);
2903 session
->base_path
= NULL
;
2906 /* Set session base_path */
2907 session
->base_path
= strdup(uris
[i
].subdir
);
2908 if (!session
->base_path
) {
2909 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2910 uris
[i
].subdir
, session
->name
);
2911 ret
= LTTNG_ERR_NOMEM
;
2914 DBG2("Setting base path \"%s\" for session \"%s\"",
2915 session
->base_path
, session
->name
);
2923 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2925 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2926 struct lttng_uri
*uris
)
2929 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2930 struct ltt_ust_session
*usess
= session
->ust_session
;
2936 /* Can't set consumer URI if the session is active. */
2937 if (session
->active
) {
2938 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2943 * Set the session base path if any. This is done inside
2944 * cmd_set_consumer_uri to preserve backward compatibility of the
2945 * previous session creation api vs the session descriptor api.
2947 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2948 if (ret
!= LTTNG_OK
) {
2952 /* Set the "global" consumer URIs */
2953 for (i
= 0; i
< nb_uri
; i
++) {
2954 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2956 if (ret
!= LTTNG_OK
) {
2961 /* Set UST session URIs */
2962 if (session
->ust_session
) {
2963 for (i
= 0; i
< nb_uri
; i
++) {
2964 ret
= add_uri_to_consumer(session
,
2965 session
->ust_session
->consumer
,
2966 &uris
[i
], LTTNG_DOMAIN_UST
);
2967 if (ret
!= LTTNG_OK
) {
2973 /* Set kernel session URIs */
2974 if (session
->kernel_session
) {
2975 for (i
= 0; i
< nb_uri
; i
++) {
2976 ret
= add_uri_to_consumer(session
,
2977 session
->kernel_session
->consumer
,
2978 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2979 if (ret
!= LTTNG_OK
) {
2986 * Make sure to set the session in output mode after we set URI since a
2987 * session can be created without URL (thus flagged in no output mode).
2989 session
->output_traces
= 1;
2991 ksess
->output_traces
= 1;
2995 usess
->output_traces
= 1;
3006 enum lttng_error_code
set_session_output_from_descriptor(
3007 struct ltt_session
*session
,
3008 const struct lttng_session_descriptor
*descriptor
)
3011 enum lttng_error_code ret_code
= LTTNG_OK
;
3012 enum lttng_session_descriptor_type session_type
=
3013 lttng_session_descriptor_get_type(descriptor
);
3014 enum lttng_session_descriptor_output_type output_type
=
3015 lttng_session_descriptor_get_output_type(descriptor
);
3016 struct lttng_uri uris
[2] = {};
3017 size_t uri_count
= 0;
3019 switch (output_type
) {
3020 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
3022 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
3023 lttng_session_descriptor_get_local_output_uri(descriptor
,
3027 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3028 lttng_session_descriptor_get_network_output_uris(descriptor
,
3029 &uris
[0], &uris
[1]);
3033 ret_code
= LTTNG_ERR_INVALID
;
3037 switch (session_type
) {
3038 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3040 struct snapshot_output
*new_output
= NULL
;
3042 new_output
= snapshot_output_alloc();
3044 ret_code
= LTTNG_ERR_NOMEM
;
3048 ret
= snapshot_output_init_with_uri(session
,
3049 DEFAULT_SNAPSHOT_MAX_SIZE
,
3050 NULL
, uris
, uri_count
, session
->consumer
,
3051 new_output
, &session
->snapshot
);
3053 ret_code
= (ret
== -ENOMEM
) ?
3054 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3055 snapshot_output_destroy(new_output
);
3058 snapshot_add_output(&session
->snapshot
, new_output
);
3061 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3062 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3064 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3068 ret_code
= LTTNG_ERR_INVALID
;
3076 enum lttng_error_code
cmd_create_session_from_descriptor(
3077 struct lttng_session_descriptor
*descriptor
,
3078 const lttng_sock_cred
*creds
,
3079 const char *home_path
)
3082 enum lttng_error_code ret_code
;
3083 const char *session_name
;
3084 struct ltt_session
*new_session
= NULL
;
3085 enum lttng_session_descriptor_status descriptor_status
;
3087 session_lock_list();
3089 if (*home_path
!= '/') {
3090 ERR("Home path provided by client is not absolute");
3091 ret_code
= LTTNG_ERR_INVALID
;
3096 descriptor_status
= lttng_session_descriptor_get_session_name(
3097 descriptor
, &session_name
);
3098 switch (descriptor_status
) {
3099 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3101 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3102 session_name
= NULL
;
3105 ret_code
= LTTNG_ERR_INVALID
;
3109 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3111 if (ret_code
!= LTTNG_OK
) {
3115 if (!session_name
) {
3116 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3119 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3124 if (!lttng_session_descriptor_is_output_destination_initialized(
3127 * Only include the session's creation time in the output
3128 * destination if the name of the session itself was
3129 * not auto-generated.
3131 ret_code
= lttng_session_descriptor_set_default_output(
3133 session_name
? &new_session
->creation_time
: NULL
,
3135 if (ret_code
!= LTTNG_OK
) {
3139 new_session
->has_user_specified_directory
=
3140 lttng_session_descriptor_has_output_directory(
3144 switch (lttng_session_descriptor_get_type(descriptor
)) {
3145 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3146 new_session
->snapshot_mode
= 1;
3148 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3149 new_session
->live_timer
=
3150 lttng_session_descriptor_live_get_timer_interval(
3157 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3158 if (ret_code
!= LTTNG_OK
) {
3161 new_session
->consumer
->enabled
= 1;
3162 ret_code
= LTTNG_OK
;
3164 /* Release reference provided by the session_create function. */
3165 session_put(new_session
);
3166 if (ret_code
!= LTTNG_OK
&& new_session
) {
3167 /* Release the global reference on error. */
3168 session_destroy(new_session
);
3170 session_unlock_list();
3174 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3175 struct lttng_session_descriptor
**return_descriptor
)
3178 size_t payload_size
;
3179 struct lttng_dynamic_buffer payload
;
3180 struct lttng_buffer_view home_dir_view
;
3181 struct lttng_buffer_view session_descriptor_view
;
3182 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3183 enum lttng_error_code ret_code
;
3185 lttng_dynamic_buffer_init(&payload
);
3186 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3188 ret_code
= LTTNG_ERR_INVALID
;
3191 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3192 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3193 ret_code
= LTTNG_ERR_INVALID
;
3197 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3198 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3199 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3201 ret_code
= LTTNG_ERR_NOMEM
;
3205 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3207 ERR("Reception of session descriptor failed, aborting.");
3208 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3212 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3215 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3216 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3218 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3219 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3221 ret
= lttng_session_descriptor_create_from_buffer(
3222 &session_descriptor_view
, &session_descriptor
);
3224 ERR("Failed to create session descriptor from payload of \"create session\" command");
3225 ret_code
= LTTNG_ERR_INVALID
;
3230 * Sets the descriptor's auto-generated properties (name, output) if
3233 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3235 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3236 if (ret_code
!= LTTNG_OK
) {
3240 ret_code
= LTTNG_OK
;
3241 *return_descriptor
= session_descriptor
;
3242 session_descriptor
= NULL
;
3244 lttng_dynamic_buffer_reset(&payload
);
3245 lttng_session_descriptor_destroy(session_descriptor
);
3250 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3251 void *_reply_context
)
3255 const struct cmd_destroy_session_reply_context
*reply_context
=
3257 struct lttng_dynamic_buffer payload
;
3258 struct lttcomm_session_destroy_command_header cmd_header
;
3259 struct lttng_trace_archive_location
*location
= NULL
;
3260 struct lttcomm_lttng_msg llm
= {
3261 .cmd_type
= LTTNG_DESTROY_SESSION
,
3262 .ret_code
= reply_context
->destruction_status
,
3265 sizeof(struct lttcomm_session_destroy_command_header
),
3268 size_t payload_size_before_location
;
3270 lttng_dynamic_buffer_init(&payload
);
3272 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3274 ERR("Failed to append session destruction message");
3278 cmd_header
.rotation_state
=
3279 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3280 session
->rotation_state
:
3281 LTTNG_ROTATION_STATE_NO_ROTATION
);
3282 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3283 sizeof(cmd_header
));
3285 ERR("Failed to append session destruction command header");
3289 if (!reply_context
->implicit_rotation_on_destroy
) {
3290 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3294 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3295 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3300 location
= session_get_trace_archive_location(session
);
3302 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3307 payload_size_before_location
= payload
.size
;
3308 comm_ret
= lttng_trace_archive_location_serialize(location
,
3311 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3315 /* Update the message to indicate the location's length. */
3316 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3317 payload
.size
- payload_size_before_location
;
3319 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3320 payload
.data
, payload
.size
);
3321 if (comm_ret
!= (ssize_t
) payload
.size
) {
3322 ERR("Failed to send result of the destruction of session \"%s\" to client",
3326 ret
= close(reply_context
->reply_sock_fd
);
3328 PERROR("Failed to close client socket in deferred session destroy reply");
3330 lttng_dynamic_buffer_reset(&payload
);
3331 free(_reply_context
);
3335 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3337 * Called with session lock held.
3339 int cmd_destroy_session(struct ltt_session
*session
,
3340 struct notification_thread_handle
*notification_thread_handle
,
3344 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3345 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3348 reply_context
= zmalloc(sizeof(*reply_context
));
3349 if (!reply_context
) {
3350 ret
= LTTNG_ERR_NOMEM
;
3353 reply_context
->reply_sock_fd
= *sock_fd
;
3359 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3361 if (session
->active
) {
3362 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3364 ret
= cmd_stop_trace(session
);
3365 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3366 /* Carry on with the destruction of the session. */
3367 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3368 session
->name
, lttng_strerror(-ret
));
3369 destruction_last_error
= ret
;
3373 if (session
->rotation_schedule_timer_enabled
) {
3374 if (timer_session_rotation_schedule_timer_stop(
3376 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3378 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3382 if (session
->rotate_size
) {
3383 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3384 session
->rotate_size
= 0;
3387 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3389 * Perform a last rotation on destruction if rotations have
3390 * occurred during the session's lifetime.
3392 ret
= cmd_rotate_session(session
, NULL
, false,
3393 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3394 if (ret
!= LTTNG_OK
) {
3395 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3396 session
->name
, lttng_strerror(-ret
));
3397 destruction_last_error
= -ret
;
3399 if (reply_context
) {
3400 reply_context
->implicit_rotation_on_destroy
= true;
3402 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3404 * The user has not triggered a session rotation. However, to
3405 * ensure all data has been consumed, the session is rotated
3406 * to a 'null' trace chunk before it is destroyed.
3408 * This is a "quiet" rotation meaning that no notification is
3409 * emitted and no renaming of the current trace chunk takes
3412 ret
= cmd_rotate_session(session
, NULL
, true,
3413 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3415 * Rotation operations may not be supported by the kernel
3416 * tracer. Hence, do not consider this implicit rotation as
3417 * a session destruction error. The library has already stopped
3418 * the session and waited for pending data; there is nothing
3419 * left to do but complete the destruction of the session.
3421 if (ret
!= LTTNG_OK
&&
3422 ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3423 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3424 session
->name
, lttng_strerror(ret
));
3425 destruction_last_error
= -ret
;
3429 if (session
->shm_path
[0]) {
3431 * When a session is created with an explicit shm_path,
3432 * the consumer daemon will create its shared memory files
3433 * at that location and will *not* unlink them. This is normal
3434 * as the intention of that feature is to make it possible
3435 * to retrieve the content of those files should a crash occur.
3437 * To ensure the content of those files can be used, the
3438 * sessiond daemon will replicate the content of the metadata
3439 * cache in a metadata file.
3441 * On clean-up, it is expected that the consumer daemon will
3442 * unlink the shared memory files and that the session daemon
3443 * will unlink the metadata file. Then, the session's directory
3444 * in the shm path can be removed.
3446 * Unfortunately, a flaw in the design of the sessiond's and
3447 * consumerd's tear down of channels makes it impossible to
3448 * determine when the sessiond _and_ the consumerd have both
3449 * destroyed their representation of a channel. For one, the
3450 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3451 * callbacks in both daemons.
3453 * However, it is also impossible for the sessiond to know when
3454 * the consumer daemon is done destroying its channel(s) since
3455 * it occurs as a reaction to the closing of the channel's file
3456 * descriptor. There is no resulting communication initiated
3457 * from the consumerd to the sessiond to confirm that the
3458 * operation is completed (and was successful).
3460 * Until this is all fixed, the session daemon checks for the
3461 * removal of the session's shm path which makes it possible
3462 * to safely advertise a session as having been destroyed.
3464 * Prior to this fix, it was not possible to reliably save
3465 * a session making use of the --shm-path option, destroy it,
3466 * and load it again. This is because the creation of the
3467 * session would fail upon seeing the session's shm path
3468 * already in existence.
3470 * Note that none of the error paths in the check for the
3471 * directory's existence return an error. This is normal
3472 * as there isn't much that can be done. The session will
3473 * be destroyed properly, except that we can't offer the
3474 * guarantee that the same session can be re-created.
3476 current_completion_handler
= &destroy_completion_handler
.handler
;
3477 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3479 sizeof(destroy_completion_handler
.shm_path
));
3484 * The session is destroyed. However, note that the command context
3485 * still holds a reference to the session, thus delaying its destruction
3486 * _at least_ up to the point when that reference is released.
3488 session_destroy(session
);
3489 if (reply_context
) {
3490 reply_context
->destruction_status
= destruction_last_error
;
3491 ret
= session_add_destroy_notifier(session
,
3492 cmd_destroy_session_reply
,
3493 (void *) reply_context
);
3495 ret
= LTTNG_ERR_FATAL
;
3507 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3509 int cmd_register_consumer(struct ltt_session
*session
,
3510 enum lttng_domain_type domain
, const char *sock_path
,
3511 struct consumer_data
*cdata
)
3514 struct consumer_socket
*socket
= NULL
;
3521 case LTTNG_DOMAIN_KERNEL
:
3523 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3527 /* Can't register a consumer if there is already one */
3528 if (ksess
->consumer_fds_sent
!= 0) {
3529 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3533 sock
= lttcomm_connect_unix_sock(sock_path
);
3535 ret
= LTTNG_ERR_CONNECT_FAIL
;
3538 cdata
->cmd_sock
= sock
;
3540 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3541 if (socket
== NULL
) {
3544 PERROR("close register consumer");
3546 cdata
->cmd_sock
= -1;
3547 ret
= LTTNG_ERR_FATAL
;
3551 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3552 if (socket
->lock
== NULL
) {
3553 PERROR("zmalloc pthread mutex");
3554 ret
= LTTNG_ERR_FATAL
;
3557 pthread_mutex_init(socket
->lock
, NULL
);
3558 socket
->registered
= 1;
3561 consumer_add_socket(socket
, ksess
->consumer
);
3564 pthread_mutex_lock(&cdata
->pid_mutex
);
3566 pthread_mutex_unlock(&cdata
->pid_mutex
);
3571 /* TODO: Userspace tracing */
3572 ret
= LTTNG_ERR_UND
;
3580 consumer_destroy_socket(socket
);
3586 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3588 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3589 struct lttng_domain
**domains
)
3594 struct lttng_ht_iter iter
;
3596 if (session
->kernel_session
!= NULL
) {
3597 DBG3("Listing domains found kernel domain");
3601 if (session
->ust_session
!= NULL
) {
3602 DBG3("Listing domains found UST global domain");
3606 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3608 if (agt
->being_used
) {
3619 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3620 if (*domains
== NULL
) {
3621 ret
= LTTNG_ERR_FATAL
;
3625 if (session
->kernel_session
!= NULL
) {
3626 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3628 /* Kernel session buffer type is always GLOBAL */
3629 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3634 if (session
->ust_session
!= NULL
) {
3635 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3636 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3640 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3642 if (agt
->being_used
) {
3643 (*domains
)[index
].type
= agt
->domain
;
3644 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3654 /* Return negative value to differentiate return code */
3660 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3662 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3663 struct ltt_session
*session
, struct lttng_channel
**channels
)
3665 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3668 case LTTNG_DOMAIN_KERNEL
:
3669 if (session
->kernel_session
!= NULL
) {
3670 nb_chan
= session
->kernel_session
->channel_count
;
3672 DBG3("Number of kernel channels %zd", nb_chan
);
3674 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3678 case LTTNG_DOMAIN_UST
:
3679 if (session
->ust_session
!= NULL
) {
3681 nb_chan
= lttng_ht_get_count(
3682 session
->ust_session
->domain_global
.channels
);
3685 DBG3("Number of UST global channels %zd", nb_chan
);
3687 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3692 ret
= -LTTNG_ERR_UND
;
3697 const size_t channel_size
= sizeof(struct lttng_channel
) +
3698 sizeof(struct lttng_channel_extended
);
3699 struct lttng_channel_extended
*channel_exts
;
3701 payload_size
= nb_chan
* channel_size
;
3702 *channels
= zmalloc(payload_size
);
3703 if (*channels
== NULL
) {
3704 ret
= -LTTNG_ERR_FATAL
;
3708 channel_exts
= ((void *) *channels
) +
3709 (nb_chan
* sizeof(struct lttng_channel
));
3710 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3711 if (ret
!= LTTNG_OK
) {
3726 * Command LTTNG_LIST_EVENTS processed by the client thread.
3728 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3729 struct ltt_session
*session
, char *channel_name
,
3730 struct lttng_event
**events
, size_t *total_size
)
3733 ssize_t nb_event
= 0;
3736 case LTTNG_DOMAIN_KERNEL
:
3737 if (session
->kernel_session
!= NULL
) {
3738 nb_event
= list_lttng_kernel_events(channel_name
,
3739 session
->kernel_session
, events
,
3743 case LTTNG_DOMAIN_UST
:
3745 if (session
->ust_session
!= NULL
) {
3746 nb_event
= list_lttng_ust_global_events(channel_name
,
3747 &session
->ust_session
->domain_global
, events
,
3752 case LTTNG_DOMAIN_LOG4J
:
3753 case LTTNG_DOMAIN_JUL
:
3754 case LTTNG_DOMAIN_PYTHON
:
3755 if (session
->ust_session
) {
3756 struct lttng_ht_iter iter
;
3760 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3761 &iter
.iter
, agt
, node
.node
) {
3762 if (agt
->domain
== domain
) {
3763 nb_event
= list_lttng_agent_events(
3773 ret
= LTTNG_ERR_UND
;
3780 /* Return negative value to differentiate return code */
3785 * Using the session list, filled a lttng_session array to send back to the
3786 * client for session listing.
3788 * The session list lock MUST be acquired before calling this function. Use
3789 * session_lock_list() and session_unlock_list().
3791 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3792 size_t session_count
, uid_t uid
, gid_t gid
)
3796 struct ltt_session
*session
;
3797 struct ltt_session_list
*list
= session_get_list();
3798 struct lttng_session_extended
*extended
=
3799 (typeof(extended
)) (&sessions
[session_count
]);
3801 DBG("Getting all available session for UID %d GID %d",
3804 * Iterate over session list and append data after the control struct in
3807 cds_list_for_each_entry(session
, &list
->head
, list
) {
3808 if (!session_get(session
)) {
3812 * Only list the sessions the user can control.
3814 if (!session_access_ok(session
, uid
, gid
) ||
3815 session
->destroyed
) {
3816 session_put(session
);
3820 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3821 struct ltt_ust_session
*usess
= session
->ust_session
;
3823 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3824 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3825 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3826 ret
= build_network_session_path(sessions
[i
].path
,
3827 sizeof(sessions
[i
].path
), session
);
3829 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3830 session
->consumer
->dst
.session_root_path
);
3833 PERROR("snprintf session path");
3834 session_put(session
);
3838 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3839 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3840 sessions
[i
].enabled
= session
->active
;
3841 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3842 sessions
[i
].live_timer_interval
= session
->live_timer
;
3843 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3844 extended
[i
].creation_time
.is_set
= 1;
3846 session_put(session
);
3851 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3852 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3854 int cmd_data_pending(struct ltt_session
*session
)
3857 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3858 struct ltt_ust_session
*usess
= session
->ust_session
;
3862 DBG("Data pending for session %s", session
->name
);
3864 /* Session MUST be stopped to ask for data availability. */
3865 if (session
->active
) {
3866 ret
= LTTNG_ERR_SESSION_STARTED
;
3870 * If stopped, just make sure we've started before else the above call
3871 * will always send that there is data pending.
3873 * The consumer assumes that when the data pending command is received,
3874 * the trace has been started before or else no output data is written
3875 * by the streams which is a condition for data pending. So, this is
3876 * *VERY* important that we don't ask the consumer before a start
3879 if (!session
->has_been_started
) {
3885 /* A rotation is still pending, we have to wait. */
3886 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3887 DBG("Rotate still pending for session %s", session
->name
);
3892 if (ksess
&& ksess
->consumer
) {
3893 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3895 /* Data is still being extracted for the kernel. */
3900 if (usess
&& usess
->consumer
) {
3901 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3903 /* Data is still being extracted for the kernel. */
3908 /* Data is ready to be read by a viewer */
3916 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3918 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3920 int cmd_snapshot_add_output(struct ltt_session
*session
,
3921 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3924 struct snapshot_output
*new_output
;
3929 DBG("Cmd snapshot add output for session %s", session
->name
);
3932 * Can't create an output if the session is not set in no-output mode.
3934 if (session
->output_traces
) {
3935 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3939 if (session
->has_non_mmap_channel
) {
3940 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3944 /* Only one output is allowed until we have the "tee" feature. */
3945 if (session
->snapshot
.nb_output
== 1) {
3946 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3950 new_output
= snapshot_output_alloc();
3952 ret
= LTTNG_ERR_NOMEM
;
3956 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3957 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3958 &session
->snapshot
);
3960 if (ret
== -ENOMEM
) {
3961 ret
= LTTNG_ERR_NOMEM
;
3963 ret
= LTTNG_ERR_INVALID
;
3969 snapshot_add_output(&session
->snapshot
, new_output
);
3971 *id
= new_output
->id
;
3978 snapshot_output_destroy(new_output
);
3984 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3986 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3988 int cmd_snapshot_del_output(struct ltt_session
*session
,
3989 const struct lttng_snapshot_output
*output
)
3992 struct snapshot_output
*sout
= NULL
;
4000 * Permission denied to create an output if the session is not
4001 * set in no output mode.
4003 if (session
->output_traces
) {
4004 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4009 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
4011 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4012 } else if (*output
->name
!= '\0') {
4013 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
4015 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4018 ret
= LTTNG_ERR_INVALID
;
4022 snapshot_delete_output(&session
->snapshot
, sout
);
4023 snapshot_output_destroy(sout
);
4032 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4034 * If no output is available, outputs is untouched and 0 is returned.
4036 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4038 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4039 struct lttng_snapshot_output
**outputs
)
4042 struct lttng_snapshot_output
*list
= NULL
;
4043 struct lttng_ht_iter iter
;
4044 struct snapshot_output
*output
;
4049 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4052 * Permission denied to create an output if the session is not
4053 * set in no output mode.
4055 if (session
->output_traces
) {
4056 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4060 if (session
->snapshot
.nb_output
== 0) {
4065 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4067 ret
= -LTTNG_ERR_NOMEM
;
4071 /* Copy list from session to the new list object. */
4073 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4074 output
, node
.node
) {
4075 assert(output
->consumer
);
4076 list
[idx
].id
= output
->id
;
4077 list
[idx
].max_size
= output
->max_size
;
4078 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4079 sizeof(list
[idx
].name
))) {
4080 ret
= -LTTNG_ERR_INVALID
;
4083 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4084 if (lttng_strncpy(list
[idx
].ctrl_url
,
4085 output
->consumer
->dst
.session_root_path
,
4086 sizeof(list
[idx
].ctrl_url
))) {
4087 ret
= -LTTNG_ERR_INVALID
;
4092 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4093 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4095 ret
= -LTTNG_ERR_NOMEM
;
4100 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4101 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4103 ret
= -LTTNG_ERR_NOMEM
;
4112 ret
= session
->snapshot
.nb_output
;
4121 * Check if we can regenerate the metadata for this session.
4122 * Only kernel, UST per-uid and non-live sessions are supported.
4124 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4127 int check_regenerate_metadata_support(struct ltt_session
*session
)
4133 if (session
->live_timer
!= 0) {
4134 ret
= LTTNG_ERR_LIVE_SESSION
;
4137 if (!session
->active
) {
4138 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4141 if (session
->ust_session
) {
4142 switch (session
->ust_session
->buffer_type
) {
4143 case LTTNG_BUFFER_PER_UID
:
4145 case LTTNG_BUFFER_PER_PID
:
4146 ret
= LTTNG_ERR_PER_PID_SESSION
;
4150 ret
= LTTNG_ERR_UNK
;
4154 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4155 session
->consumer
->relay_minor_version
< 8) {
4156 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4166 int clear_metadata_file(int fd
)
4171 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4172 if (lseek_ret
< 0) {
4178 ret
= ftruncate(fd
, 0);
4180 PERROR("ftruncate");
4189 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4192 struct buffer_reg_uid
*uid_reg
= NULL
;
4193 struct buffer_reg_session
*session_reg
= NULL
;
4196 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4197 struct ust_registry_session
*registry
;
4198 struct ust_registry_channel
*chan
;
4199 struct lttng_ht_iter iter_chan
;
4201 session_reg
= uid_reg
->registry
;
4202 registry
= session_reg
->reg
.ust
;
4204 pthread_mutex_lock(®istry
->lock
);
4205 registry
->metadata_len_sent
= 0;
4206 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4207 registry
->metadata_len
= 0;
4208 registry
->metadata_version
++;
4209 if (registry
->metadata_fd
> 0) {
4210 /* Clear the metadata file's content. */
4211 ret
= clear_metadata_file(registry
->metadata_fd
);
4213 pthread_mutex_unlock(®istry
->lock
);
4218 ret
= ust_metadata_session_statedump(registry
, NULL
,
4219 registry
->major
, registry
->minor
);
4221 pthread_mutex_unlock(®istry
->lock
);
4222 ERR("Failed to generate session metadata (err = %d)",
4226 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4228 struct ust_registry_event
*event
;
4229 struct lttng_ht_iter iter_event
;
4231 ret
= ust_metadata_channel_statedump(registry
, chan
);
4233 pthread_mutex_unlock(®istry
->lock
);
4234 ERR("Failed to generate channel metadata "
4238 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4240 ret
= ust_metadata_event_statedump(registry
,
4243 pthread_mutex_unlock(®istry
->lock
);
4244 ERR("Failed to generate event metadata "
4250 pthread_mutex_unlock(®istry
->lock
);
4259 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4261 * Ask the consumer to truncate the existing metadata file(s) and
4262 * then regenerate the metadata. Live and per-pid sessions are not
4263 * supported and return an error.
4265 * Return 0 on success or else a LTTNG_ERR code.
4267 int cmd_regenerate_metadata(struct ltt_session
*session
)
4273 ret
= check_regenerate_metadata_support(session
);
4278 if (session
->kernel_session
) {
4279 ret
= kernctl_session_regenerate_metadata(
4280 session
->kernel_session
->fd
);
4282 ERR("Failed to regenerate the kernel metadata");
4287 if (session
->ust_session
) {
4288 ret
= ust_regenerate_metadata(session
->ust_session
);
4290 ERR("Failed to regenerate the UST metadata");
4294 DBG("Cmd metadata regenerate for session %s", session
->name
);
4302 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4304 * Ask the tracer to regenerate a new statedump.
4306 * Return 0 on success or else a LTTNG_ERR code.
4308 int cmd_regenerate_statedump(struct ltt_session
*session
)
4314 if (!session
->active
) {
4315 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4319 if (session
->kernel_session
) {
4320 ret
= kernctl_session_regenerate_statedump(
4321 session
->kernel_session
->fd
);
4323 * Currently, the statedump in kernel can only fail if out
4327 if (ret
== -ENOMEM
) {
4328 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4330 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4332 ERR("Failed to regenerate the kernel statedump");
4337 if (session
->ust_session
) {
4338 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4340 * Currently, the statedump in UST always returns 0.
4343 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4344 ERR("Failed to regenerate the UST statedump");
4348 DBG("Cmd regenerate statedump for session %s", session
->name
);
4355 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4356 struct notification_thread_handle
*notification_thread
)
4360 ssize_t sock_recv_len
;
4361 struct lttng_trigger
*trigger
= NULL
;
4362 struct lttng_buffer_view view
;
4363 struct lttng_dynamic_buffer trigger_buffer
;
4365 lttng_dynamic_buffer_init(&trigger_buffer
);
4366 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4367 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4369 ret
= LTTNG_ERR_NOMEM
;
4373 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4375 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4376 ERR("Failed to receive \"register trigger\" command payload");
4377 /* TODO: should this be a new error enum ? */
4378 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4382 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4383 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4385 ERR("Invalid trigger payload received in \"register trigger\" command");
4386 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4390 ret
= notification_thread_command_register_trigger(notification_thread
,
4392 /* Ownership of trigger was transferred. */
4395 lttng_trigger_destroy(trigger
);
4396 lttng_dynamic_buffer_reset(&trigger_buffer
);
4400 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4401 struct notification_thread_handle
*notification_thread
)
4405 ssize_t sock_recv_len
;
4406 struct lttng_trigger
*trigger
= NULL
;
4407 struct lttng_buffer_view view
;
4408 struct lttng_dynamic_buffer trigger_buffer
;
4410 lttng_dynamic_buffer_init(&trigger_buffer
);
4411 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4412 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4414 ret
= LTTNG_ERR_NOMEM
;
4418 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4420 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4421 ERR("Failed to receive \"unregister trigger\" command payload");
4422 /* TODO: should this be a new error enum ? */
4423 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4427 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4428 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4430 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4431 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4435 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4438 lttng_trigger_destroy(trigger
);
4439 lttng_dynamic_buffer_reset(&trigger_buffer
);
4444 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4445 * snapshot output is *not* set with a remote destination.
4447 * Return LTTNG_OK on success or a LTTNG_ERR code.
4449 static enum lttng_error_code
set_relayd_for_snapshot(
4450 struct consumer_output
*output
,
4451 const struct ltt_session
*session
)
4453 enum lttng_error_code status
= LTTNG_OK
;
4454 struct lttng_ht_iter iter
;
4455 struct consumer_socket
*socket
;
4456 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4457 const char *base_path
;
4462 DBG2("Set relayd object from snapshot output");
4464 if (session
->current_trace_chunk
) {
4465 enum lttng_trace_chunk_status chunk_status
=
4466 lttng_trace_chunk_get_id(
4467 session
->current_trace_chunk
,
4468 ¤t_chunk_id
.value
);
4470 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4471 current_chunk_id
.is_set
= true;
4473 ERR("Failed to get current trace chunk id");
4474 status
= LTTNG_ERR_UNK
;
4479 /* Ignore if snapshot consumer output is not network. */
4480 if (output
->type
!= CONSUMER_DST_NET
) {
4485 * The snapshot record URI base path overrides the session
4488 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4489 base_path
= output
->dst
.net
.control
.subdir
;
4491 base_path
= session
->base_path
;
4495 * For each consumer socket, create and send the relayd object of the
4499 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4500 socket
, node
.node
) {
4501 pthread_mutex_lock(socket
->lock
);
4502 status
= send_consumer_relayd_sockets(0, session
->id
,
4504 session
->name
, session
->hostname
,
4506 session
->live_timer
,
4507 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4508 session
->creation_time
,
4509 session
->name_contains_creation_time
);
4510 pthread_mutex_unlock(socket
->lock
);
4511 if (status
!= LTTNG_OK
) {
4523 * Record a kernel snapshot.
4525 * Return LTTNG_OK on success or a LTTNG_ERR code.
4527 static enum lttng_error_code
record_kernel_snapshot(
4528 struct ltt_kernel_session
*ksess
,
4529 const struct consumer_output
*output
,
4530 const struct ltt_session
*session
,
4531 int wait
, uint64_t nb_packets_per_stream
)
4533 enum lttng_error_code status
;
4539 status
= kernel_snapshot_record(
4540 ksess
, output
, wait
, nb_packets_per_stream
);
4545 * Record a UST snapshot.
4547 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4549 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4550 const struct consumer_output
*output
,
4551 const struct ltt_session
*session
,
4552 int wait
, uint64_t nb_packets_per_stream
)
4554 enum lttng_error_code status
;
4560 status
= ust_app_snapshot_record(
4561 usess
, output
, wait
, nb_packets_per_stream
);
4566 uint64_t get_session_size_one_more_packet_per_stream(
4567 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4569 uint64_t tot_size
= 0;
4571 if (session
->kernel_session
) {
4572 struct ltt_kernel_channel
*chan
;
4573 const struct ltt_kernel_session
*ksess
=
4574 session
->kernel_session
;
4576 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4577 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4579 * Don't take channel into account if we
4580 * already grab all its packets.
4584 tot_size
+= chan
->channel
->attr
.subbuf_size
4585 * chan
->stream_count
;
4589 if (session
->ust_session
) {
4590 const struct ltt_ust_session
*usess
= session
->ust_session
;
4592 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4600 * Calculate the number of packets we can grab from each stream that
4601 * fits within the overall snapshot max size.
4603 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4604 * the number of packets per stream.
4606 * TODO: this approach is not perfect: we consider the worse case
4607 * (packet filling the sub-buffers) as an upper bound, but we could do
4608 * better if we do this calculation while we actually grab the packet
4609 * content: we would know how much padding we don't actually store into
4612 * This algorithm is currently bounded by the number of packets per
4615 * Since we call this algorithm before actually grabbing the data, it's
4616 * an approximation: for instance, applications could appear/disappear
4617 * in between this call and actually grabbing data.
4620 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4624 uint64_t cur_nb_packets
= 0;
4627 return 0; /* Infinite */
4630 size_left
= max_size
;
4632 uint64_t one_more_packet_tot_size
;
4634 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4635 session
, cur_nb_packets
);
4636 if (!one_more_packet_tot_size
) {
4637 /* We are already grabbing all packets. */
4640 size_left
-= one_more_packet_tot_size
;
4641 if (size_left
< 0) {
4646 if (!cur_nb_packets
&& size_left
!= max_size
) {
4647 /* Not enough room to grab one packet of each stream, error. */
4650 return cur_nb_packets
;
4654 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4655 const struct snapshot_output
*snapshot_output
, int wait
)
4657 int64_t nb_packets_per_stream
;
4658 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4660 enum lttng_error_code ret_code
= LTTNG_OK
;
4661 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4662 struct consumer_output
*original_ust_consumer_output
= NULL
;
4663 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4664 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4665 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4667 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4669 snapshot_output
->name
,
4670 snapshot_output
->datetime
,
4671 snapshot_output
->nb_snapshot
);
4672 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4673 ERR("Failed to format snapshot name");
4674 ret_code
= LTTNG_ERR_INVALID
;
4677 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4678 snapshot_output
->name
, session
->name
,
4679 snapshot_chunk_name
);
4680 if (!session
->kernel_session
&& !session
->ust_session
) {
4681 ERR("Failed to record snapshot as no channels exist");
4682 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4686 if (session
->kernel_session
) {
4687 original_kernel_consumer_output
=
4688 session
->kernel_session
->consumer
;
4689 snapshot_kernel_consumer_output
=
4690 consumer_copy_output(snapshot_output
->consumer
);
4691 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4692 snapshot_chunk_name
);
4693 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4694 original_kernel_consumer_output
);
4696 ERR("Failed to copy consumer sockets from snapshot output configuration");
4697 ret_code
= LTTNG_ERR_NOMEM
;
4700 ret_code
= set_relayd_for_snapshot(
4701 snapshot_kernel_consumer_output
, session
);
4702 if (ret_code
!= LTTNG_OK
) {
4703 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4706 session
->kernel_session
->consumer
=
4707 snapshot_kernel_consumer_output
;
4709 if (session
->ust_session
) {
4710 original_ust_consumer_output
= session
->ust_session
->consumer
;
4711 snapshot_ust_consumer_output
=
4712 consumer_copy_output(snapshot_output
->consumer
);
4713 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4714 snapshot_chunk_name
);
4715 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4716 original_ust_consumer_output
);
4718 ERR("Failed to copy consumer sockets from snapshot output configuration");
4719 ret_code
= LTTNG_ERR_NOMEM
;
4722 ret_code
= set_relayd_for_snapshot(
4723 snapshot_ust_consumer_output
, session
);
4724 if (ret_code
!= LTTNG_OK
) {
4725 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4728 session
->ust_session
->consumer
=
4729 snapshot_ust_consumer_output
;
4732 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4733 snapshot_kernel_consumer_output
?:
4734 snapshot_ust_consumer_output
,
4735 consumer_output_get_base_path(
4736 snapshot_output
->consumer
),
4737 snapshot_chunk_name
);
4738 if (!snapshot_trace_chunk
) {
4739 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4741 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4744 assert(!session
->current_trace_chunk
);
4745 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4746 lttng_trace_chunk_put(snapshot_trace_chunk
);
4747 snapshot_trace_chunk
= NULL
;
4749 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4751 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4755 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4756 snapshot_output
->max_size
);
4757 if (nb_packets_per_stream
< 0) {
4758 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4759 goto error_close_trace_chunk
;
4762 if (session
->kernel_session
) {
4763 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4764 snapshot_kernel_consumer_output
, session
,
4765 wait
, nb_packets_per_stream
);
4766 if (ret_code
!= LTTNG_OK
) {
4767 goto error_close_trace_chunk
;
4771 if (session
->ust_session
) {
4772 ret_code
= record_ust_snapshot(session
->ust_session
,
4773 snapshot_ust_consumer_output
, session
,
4774 wait
, nb_packets_per_stream
);
4775 if (ret_code
!= LTTNG_OK
) {
4776 goto error_close_trace_chunk
;
4780 error_close_trace_chunk
:
4781 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
4782 ERR("Failed to release the current trace chunk of session \"%s\"",
4784 ret_code
= LTTNG_ERR_UNK
;
4787 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
4788 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
4790 * Don't goto end; make sure the chunk is closed for the session
4791 * to allow future snapshots.
4793 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4795 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4798 if (original_ust_consumer_output
) {
4799 session
->ust_session
->consumer
= original_ust_consumer_output
;
4801 if (original_kernel_consumer_output
) {
4802 session
->kernel_session
->consumer
=
4803 original_kernel_consumer_output
;
4805 consumer_output_put(snapshot_ust_consumer_output
);
4806 consumer_output_put(snapshot_kernel_consumer_output
);
4811 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4813 * The wait parameter is ignored so this call always wait for the snapshot to
4814 * complete before returning.
4816 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4818 int cmd_snapshot_record(struct ltt_session
*session
,
4819 const struct lttng_snapshot_output
*output
, int wait
)
4821 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4823 unsigned int snapshot_success
= 0;
4825 struct snapshot_output
*tmp_output
= NULL
;
4830 DBG("Cmd snapshot record for session %s", session
->name
);
4832 /* Get the datetime for the snapshot output directory. */
4833 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4836 cmd_ret
= LTTNG_ERR_INVALID
;
4841 * Permission denied to create an output if the session is not
4842 * set in no output mode.
4844 if (session
->output_traces
) {
4845 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4849 /* The session needs to be started at least once. */
4850 if (!session
->has_been_started
) {
4851 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4855 /* Use temporary output for the session. */
4856 if (*output
->ctrl_url
!= '\0') {
4857 tmp_output
= snapshot_output_alloc();
4859 cmd_ret
= LTTNG_ERR_NOMEM
;
4863 ret
= snapshot_output_init(session
, output
->max_size
,
4865 output
->ctrl_url
, output
->data_url
,
4869 if (ret
== -ENOMEM
) {
4870 cmd_ret
= LTTNG_ERR_NOMEM
;
4872 cmd_ret
= LTTNG_ERR_INVALID
;
4876 /* Use the global session count for the temporary snapshot. */
4877 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4879 /* Use the global datetime */
4880 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4881 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4882 if (cmd_ret
!= LTTNG_OK
) {
4885 snapshot_success
= 1;
4887 struct snapshot_output
*sout
;
4888 struct lttng_ht_iter iter
;
4891 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4892 &iter
.iter
, sout
, node
.node
) {
4893 struct snapshot_output output_copy
;
4896 * Make a local copy of the output and override output
4897 * parameters with those provided as part of the
4900 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4902 if (output
->max_size
!= (uint64_t) -1ULL) {
4903 output_copy
.max_size
= output
->max_size
;
4906 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4907 memcpy(output_copy
.datetime
, datetime
,
4910 /* Use temporary name. */
4911 if (*output
->name
!= '\0') {
4912 if (lttng_strncpy(output_copy
.name
,
4914 sizeof(output_copy
.name
))) {
4915 cmd_ret
= LTTNG_ERR_INVALID
;
4921 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4922 if (cmd_ret
!= LTTNG_OK
) {
4926 snapshot_success
= 1;
4931 if (snapshot_success
) {
4932 session
->snapshot
.nb_snapshot
++;
4934 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4939 snapshot_output_destroy(tmp_output
);
4945 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4947 int cmd_set_session_shm_path(struct ltt_session
*session
,
4948 const char *shm_path
)
4954 * Can only set shm path before session is started.
4956 if (session
->has_been_started
) {
4957 return LTTNG_ERR_SESSION_STARTED
;
4960 strncpy(session
->shm_path
, shm_path
,
4961 sizeof(session
->shm_path
));
4962 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4968 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4970 * Ask the consumer to rotate the session output directory.
4971 * The session lock must be held.
4973 * Returns LTTNG_OK on success or else a negative LTTng error code.
4975 int cmd_rotate_session(struct ltt_session
*session
,
4976 struct lttng_rotate_session_return
*rotate_return
,
4977 bool quiet_rotation
,
4978 enum lttng_trace_chunk_command_type command
)
4981 uint64_t ongoing_rotation_chunk_id
;
4982 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4983 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4984 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4985 enum lttng_trace_chunk_status chunk_status
;
4986 bool failed_to_rotate
= false;
4987 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4991 if (!session
->has_been_started
) {
4992 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4997 * Explicit rotation is not supported for live sessions.
4998 * However, live sessions can perform a quiet rotation on
5000 * Rotation is not supported for snapshot traces (no output).
5002 if ((!quiet_rotation
&& session
->live_timer
) ||
5003 !session
->output_traces
) {
5004 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5008 /* Unsupported feature in lttng-relayd before 2.11. */
5009 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5010 (session
->consumer
->relay_major_version
== 2 &&
5011 session
->consumer
->relay_minor_version
< 11)) {
5012 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5016 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5017 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5018 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5022 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5023 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5025 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5030 * After a stop, we only allow one rotation to occur, the other ones are
5031 * useless until a new start.
5033 if (session
->rotated_after_last_stop
) {
5034 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5036 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5041 * After a stop followed by a clear, disallow following rotations a they would
5042 * generate empty chunks.
5044 if (session
->cleared_after_last_stop
) {
5045 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5047 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5051 if (session
->active
) {
5052 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
5054 if (!new_trace_chunk
) {
5055 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5061 * The current trace chunk becomes the chunk being archived.
5063 * After this point, "chunk_being_archived" must absolutely
5064 * be closed on the consumer(s), otherwise it will never be
5065 * cleaned-up, which will result in a leak.
5067 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5068 &chunk_being_archived
);
5070 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5074 if (session
->kernel_session
) {
5075 cmd_ret
= kernel_rotate_session(session
);
5076 if (cmd_ret
!= LTTNG_OK
) {
5077 failed_to_rotate
= true;
5078 rotation_fail_code
= cmd_ret
;
5081 if (session
->ust_session
) {
5082 cmd_ret
= ust_app_rotate_session(session
);
5083 if (cmd_ret
!= LTTNG_OK
) {
5084 failed_to_rotate
= true;
5085 rotation_fail_code
= cmd_ret
;
5089 if (!session
->active
) {
5090 session
->rotated_after_last_stop
= true;
5093 if (!chunk_being_archived
) {
5094 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5096 if (failed_to_rotate
) {
5097 cmd_ret
= rotation_fail_code
;
5104 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5105 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5106 &ongoing_rotation_chunk_id
);
5107 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5109 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5110 command
, session
->last_chunk_path
);
5112 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5116 if (failed_to_rotate
) {
5117 cmd_ret
= rotation_fail_code
;
5121 session
->quiet_rotation
= quiet_rotation
;
5122 ret
= timer_session_rotation_pending_check_start(session
,
5123 DEFAULT_ROTATE_PENDING_TIMER
);
5125 cmd_ret
= LTTNG_ERR_UNK
;
5129 if (rotate_return
) {
5130 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5133 session
->chunk_being_archived
= chunk_being_archived
;
5134 chunk_being_archived
= NULL
;
5135 if (!quiet_rotation
) {
5136 ret
= notification_thread_command_session_rotation_ongoing(
5137 notification_thread_handle
,
5138 session
->name
, session
->uid
, session
->gid
,
5139 ongoing_rotation_chunk_id
);
5140 if (ret
!= LTTNG_OK
) {
5141 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5147 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5148 session
->name
, ongoing_rotation_chunk_id
);
5150 lttng_trace_chunk_put(new_trace_chunk
);
5151 lttng_trace_chunk_put(chunk_being_archived
);
5152 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5155 if (session_reset_rotation_state(session
,
5156 LTTNG_ROTATION_STATE_ERROR
)) {
5157 ERR("Failed to reset rotation state of session \"%s\"",
5164 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5166 * Check if the session has finished its rotation.
5168 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5170 int cmd_rotate_get_info(struct ltt_session
*session
,
5171 struct lttng_rotation_get_info_return
*info_return
,
5172 uint64_t rotation_id
)
5174 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5175 enum lttng_rotation_state rotation_state
;
5177 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5178 session
->most_recent_chunk_id
.value
);
5180 if (session
->chunk_being_archived
) {
5181 enum lttng_trace_chunk_status chunk_status
;
5184 chunk_status
= lttng_trace_chunk_get_id(
5185 session
->chunk_being_archived
,
5187 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5189 rotation_state
= rotation_id
== chunk_id
?
5190 LTTNG_ROTATION_STATE_ONGOING
:
5191 LTTNG_ROTATION_STATE_EXPIRED
;
5193 if (session
->last_archived_chunk_id
.is_set
&&
5194 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5195 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5197 rotation_state
= session
->rotation_state
;
5201 switch (rotation_state
) {
5202 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5203 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5206 case LTTNG_ROTATION_STATE_EXPIRED
:
5207 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5208 rotation_id
, session
->name
);
5210 case LTTNG_ROTATION_STATE_ONGOING
:
5211 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5212 rotation_id
, session
->name
);
5214 case LTTNG_ROTATION_STATE_COMPLETED
:
5218 char *current_tracing_path_reply
;
5219 size_t current_tracing_path_reply_len
;
5221 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5222 rotation_id
, session
->name
);
5224 switch (session_get_consumer_destination_type(session
)) {
5225 case CONSUMER_DST_LOCAL
:
5226 current_tracing_path_reply
=
5227 info_return
->location
.local
.absolute_path
;
5228 current_tracing_path_reply_len
=
5229 sizeof(info_return
->location
.local
.absolute_path
);
5230 info_return
->location_type
=
5231 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5232 fmt_ret
= asprintf(&chunk_path
,
5233 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5234 session_get_base_path(session
),
5235 session
->last_archived_chunk_name
);
5236 if (fmt_ret
== -1) {
5237 PERROR("Failed to format the path of the last archived trace chunk");
5238 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5239 cmd_ret
= LTTNG_ERR_UNK
;
5243 case CONSUMER_DST_NET
:
5245 uint16_t ctrl_port
, data_port
;
5247 current_tracing_path_reply
=
5248 info_return
->location
.relay
.relative_path
;
5249 current_tracing_path_reply_len
=
5250 sizeof(info_return
->location
.relay
.relative_path
);
5251 /* Currently the only supported relay protocol. */
5252 info_return
->location
.relay
.protocol
=
5253 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5255 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5256 session_get_net_consumer_hostname(session
),
5257 sizeof(info_return
->location
.relay
.host
));
5259 ERR("Failed to copy host name to rotate_get_info reply");
5260 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5261 cmd_ret
= LTTNG_ERR_SET_URL
;
5265 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5266 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5267 info_return
->location
.relay
.ports
.data
= data_port
;
5268 info_return
->location_type
=
5269 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5270 chunk_path
= strdup(session
->last_chunk_path
);
5272 ERR("Failed to allocate the path of the last archived trace chunk");
5273 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5274 cmd_ret
= LTTNG_ERR_UNK
;
5283 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5284 chunk_path
, current_tracing_path_reply_len
);
5287 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5288 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5289 cmd_ret
= LTTNG_ERR_UNK
;
5295 case LTTNG_ROTATION_STATE_ERROR
:
5296 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5297 rotation_id
, session
->name
);
5305 info_return
->status
= (int32_t) rotation_state
;
5310 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5312 * Configure the automatic rotation parameters.
5313 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5314 * 'activate' to false means deactivate the rotation schedule and validate that
5315 * 'new_value' has the same value as the currently active value.
5317 * Return 0 on success or else a positive LTTNG_ERR code.
5319 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5320 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5322 struct notification_thread_handle
*notification_thread_handle
)
5325 uint64_t *parameter_value
;
5329 DBG("Cmd rotate set schedule session %s", session
->name
);
5331 if (session
->live_timer
|| !session
->output_traces
) {
5332 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5333 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5337 switch (schedule_type
) {
5338 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5339 parameter_value
= &session
->rotate_size
;
5341 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5342 parameter_value
= &session
->rotate_timer_period
;
5343 if (new_value
>= UINT_MAX
) {
5344 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5345 new_value
, UINT_MAX
);
5346 ret
= LTTNG_ERR_INVALID
;
5351 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5352 ret
= LTTNG_ERR_INVALID
;
5356 /* Improper use of the API. */
5357 if (new_value
== -1ULL) {
5358 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5359 ret
= LTTNG_ERR_INVALID
;
5364 * As indicated in struct ltt_session's comments, a value of == 0 means
5365 * this schedule rotation type is not in use.
5367 * Reject the command if we were asked to activate a schedule that was
5370 if (activate
&& *parameter_value
!= 0) {
5371 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5372 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5377 * Reject the command if we were asked to deactivate a schedule that was
5380 if (!activate
&& *parameter_value
== 0) {
5381 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5382 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5387 * Reject the command if we were asked to deactivate a schedule that
5390 if (!activate
&& *parameter_value
!= new_value
) {
5391 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5392 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5396 *parameter_value
= activate
? new_value
: 0;
5398 switch (schedule_type
) {
5399 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5400 if (activate
&& session
->active
) {
5402 * Only start the timer if the session is active,
5403 * otherwise it will be started when the session starts.
5405 ret
= timer_session_rotation_schedule_timer_start(
5406 session
, new_value
);
5408 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5409 ret
= LTTNG_ERR_UNK
;
5413 ret
= timer_session_rotation_schedule_timer_stop(
5416 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5417 ret
= LTTNG_ERR_UNK
;
5422 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5424 ret
= subscribe_session_consumed_size_rotation(session
,
5425 new_value
, notification_thread_handle
);
5427 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5428 ret
= LTTNG_ERR_UNK
;
5432 ret
= unsubscribe_session_consumed_size_rotation(session
,
5433 notification_thread_handle
);
5435 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5436 ret
= LTTNG_ERR_UNK
;
5443 /* Would have been caught before. */
5455 /* Wait for a given path to be removed before continuing. */
5456 static enum lttng_error_code
wait_on_path(void *path_data
)
5458 const char *shm_path
= path_data
;
5460 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5466 ret
= stat(shm_path
, &st
);
5468 if (errno
!= ENOENT
) {
5469 PERROR("stat() returned an error while checking for the existence of the shm path");
5471 DBG("shm path no longer exists, completing the destruction of session");
5475 if (!S_ISDIR(st
.st_mode
)) {
5476 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5481 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5487 * Returns a pointer to a handler to run on completion of a command.
5488 * Returns NULL if no handler has to be run for the last command executed.
5490 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5492 struct cmd_completion_handler
*handler
= current_completion_handler
;
5494 current_completion_handler
= NULL
;
5499 * Init command subsystem.
5504 * Set network sequence index to 1 for streams to match a relayd
5505 * socket on the consumer side.
5507 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5508 relayd_net_seq_idx
= 1;
5509 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5511 DBG("Command subsystem initialized");