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
;
819 /* Negate the error code to differentiate the size from an error */
824 * Add URI so the consumer output object. Set the correct path depending on the
825 * domain adding the default trace directory.
827 static enum lttng_error_code
add_uri_to_consumer(
828 const struct ltt_session
*session
,
829 struct consumer_output
*consumer
,
830 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
833 enum lttng_error_code ret_code
= LTTNG_OK
;
837 if (consumer
== NULL
) {
838 DBG("No consumer detected. Don't add URI. Stopping.");
839 ret_code
= LTTNG_ERR_NO_CONSUMER
;
844 case LTTNG_DOMAIN_KERNEL
:
845 ret
= lttng_strncpy(consumer
->domain_subdir
,
846 DEFAULT_KERNEL_TRACE_DIR
,
847 sizeof(consumer
->domain_subdir
));
849 case LTTNG_DOMAIN_UST
:
850 ret
= lttng_strncpy(consumer
->domain_subdir
,
851 DEFAULT_UST_TRACE_DIR
,
852 sizeof(consumer
->domain_subdir
));
856 * This case is possible is we try to add the URI to the global
857 * tracing session consumer object which in this case there is
860 memset(consumer
->domain_subdir
, 0,
861 sizeof(consumer
->domain_subdir
));
865 ERR("Failed to initialize consumer output domain subdirectory");
866 ret_code
= LTTNG_ERR_FATAL
;
870 switch (uri
->dtype
) {
873 DBG2("Setting network URI to consumer");
875 if (consumer
->type
== CONSUMER_DST_NET
) {
876 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
877 consumer
->dst
.net
.control_isset
) ||
878 (uri
->stype
== LTTNG_STREAM_DATA
&&
879 consumer
->dst
.net
.data_isset
)) {
880 ret_code
= LTTNG_ERR_URL_EXIST
;
884 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
887 /* Set URI into consumer output object */
888 ret
= consumer_set_network_uri(session
, consumer
, uri
);
892 } else if (ret
== 1) {
894 * URI was the same in the consumer so we do not append the subdir
895 * again so to not duplicate output dir.
902 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
903 ret_code
= LTTNG_ERR_INVALID
;
906 DBG2("Setting trace directory path from URI to %s",
908 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
910 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
912 sizeof(consumer
->dst
.session_root_path
));
914 ret_code
= LTTNG_ERR_FATAL
;
917 consumer
->type
= CONSUMER_DST_LOCAL
;
927 * Init tracing by creating trace directory and sending fds kernel consumer.
929 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
932 struct lttng_ht_iter iter
;
933 struct consumer_socket
*socket
;
939 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
940 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
942 pthread_mutex_lock(socket
->lock
);
943 ret
= kernel_consumer_send_session(socket
, session
);
944 pthread_mutex_unlock(socket
->lock
);
946 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
958 * Create a socket to the relayd using the URI.
960 * On success, the relayd_sock pointer is set to the created socket.
961 * Else, it remains untouched and an LTTng error code is returned.
963 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
964 struct lttcomm_relayd_sock
**relayd_sock
,
965 struct consumer_output
*consumer
)
968 enum lttng_error_code status
= LTTNG_OK
;
969 struct lttcomm_relayd_sock
*rsock
;
971 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
972 RELAYD_VERSION_COMM_MINOR
);
974 status
= LTTNG_ERR_FATAL
;
979 * Connect to relayd so we can proceed with a session creation. This call
980 * can possibly block for an arbitrary amount of time to set the health
981 * state to be in poll execution.
984 ret
= relayd_connect(rsock
);
987 ERR("Unable to reach lttng-relayd");
988 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
992 /* Create socket for control stream. */
993 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
994 uint64_t result_flags
;
996 DBG3("Creating relayd stream socket from URI");
998 /* Check relayd version */
999 ret
= relayd_version_check(rsock
);
1000 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
1001 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
1003 } else if (ret
< 0) {
1004 ERR("Unable to reach lttng-relayd");
1005 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1008 consumer
->relay_major_version
= rsock
->major
;
1009 consumer
->relay_minor_version
= rsock
->minor
;
1010 ret
= relayd_get_configuration(rsock
, 0,
1013 ERR("Unable to get relayd configuration");
1014 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1017 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
1018 consumer
->relay_allows_clear
= true;
1020 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1021 DBG3("Creating relayd data socket from URI");
1023 /* Command is not valid */
1024 ERR("Relayd invalid stream type: %d", uri
->stype
);
1025 status
= LTTNG_ERR_INVALID
;
1029 *relayd_sock
= rsock
;
1034 /* The returned value is not useful since we are on an error path. */
1035 (void) relayd_close(rsock
);
1043 * Connect to the relayd using URI and send the socket to the right consumer.
1045 * The consumer socket lock must be held by the caller.
1047 * Returns LTTNG_OK on success or an LTTng error code on failure.
1049 static enum lttng_error_code
send_consumer_relayd_socket(
1050 unsigned int session_id
,
1051 struct lttng_uri
*relayd_uri
,
1052 struct consumer_output
*consumer
,
1053 struct consumer_socket
*consumer_sock
,
1054 const char *session_name
, const char *hostname
,
1055 const char *base_path
, int session_live_timer
,
1056 const uint64_t *current_chunk_id
,
1057 time_t session_creation_time
,
1058 bool session_name_contains_creation_time
)
1061 struct lttcomm_relayd_sock
*rsock
= NULL
;
1062 enum lttng_error_code status
;
1064 /* Connect to relayd and make version check if uri is the control. */
1065 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1066 if (status
!= LTTNG_OK
) {
1067 goto relayd_comm_error
;
1071 /* Set the network sequence index if not set. */
1072 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1073 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1075 * Increment net_seq_idx because we are about to transfer the
1076 * new relayd socket to the consumer.
1077 * Assign unique key so the consumer can match streams.
1079 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1080 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1083 /* Send relayd socket to consumer. */
1084 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1085 relayd_uri
->stype
, session_id
,
1086 session_name
, hostname
, base_path
,
1087 session_live_timer
, current_chunk_id
,
1088 session_creation_time
, session_name_contains_creation_time
);
1090 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1094 /* Flag that the corresponding socket was sent. */
1095 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1096 consumer_sock
->control_sock_sent
= 1;
1097 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1098 consumer_sock
->data_sock_sent
= 1;
1102 * Close socket which was dup on the consumer side. The session daemon does
1103 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1107 if (status
!= LTTNG_OK
) {
1109 * The consumer output for this session should not be used anymore
1110 * since the relayd connection failed thus making any tracing or/and
1111 * streaming not usable.
1113 consumer
->enabled
= 0;
1115 (void) relayd_close(rsock
);
1123 * Send both relayd sockets to a specific consumer and domain. This is a
1124 * helper function to facilitate sending the information to the consumer for a
1127 * The consumer socket lock must be held by the caller.
1129 * Returns LTTNG_OK, or an LTTng error code on failure.
1131 static enum lttng_error_code
send_consumer_relayd_sockets(
1132 enum lttng_domain_type domain
,
1133 unsigned int session_id
, struct consumer_output
*consumer
,
1134 struct consumer_socket
*sock
, const char *session_name
,
1135 const char *hostname
, const char *base_path
, int session_live_timer
,
1136 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1137 bool session_name_contains_creation_time
)
1139 enum lttng_error_code status
= LTTNG_OK
;
1144 /* Sending control relayd socket. */
1145 if (!sock
->control_sock_sent
) {
1146 status
= send_consumer_relayd_socket(session_id
,
1147 &consumer
->dst
.net
.control
, consumer
, sock
,
1148 session_name
, hostname
, base_path
, session_live_timer
,
1149 current_chunk_id
, session_creation_time
,
1150 session_name_contains_creation_time
);
1151 if (status
!= LTTNG_OK
) {
1156 /* Sending data relayd socket. */
1157 if (!sock
->data_sock_sent
) {
1158 status
= send_consumer_relayd_socket(session_id
,
1159 &consumer
->dst
.net
.data
, consumer
, sock
,
1160 session_name
, hostname
, base_path
, session_live_timer
,
1161 current_chunk_id
, session_creation_time
,
1162 session_name_contains_creation_time
);
1163 if (status
!= LTTNG_OK
) {
1173 * Setup relayd connections for a tracing session. First creates the socket to
1174 * the relayd and send them to the right domain consumer. Consumer type MUST be
1177 int cmd_setup_relayd(struct ltt_session
*session
)
1180 struct ltt_ust_session
*usess
;
1181 struct ltt_kernel_session
*ksess
;
1182 struct consumer_socket
*socket
;
1183 struct lttng_ht_iter iter
;
1184 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1188 usess
= session
->ust_session
;
1189 ksess
= session
->kernel_session
;
1191 DBG("Setting relayd for session %s", session
->name
);
1194 if (session
->current_trace_chunk
) {
1195 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1196 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1198 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1199 current_chunk_id
.is_set
= true;
1201 ERR("Failed to get current trace chunk id");
1202 ret
= LTTNG_ERR_UNK
;
1207 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1208 && usess
->consumer
->enabled
) {
1209 /* For each consumer socket, send relayd sockets */
1210 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1211 socket
, node
.node
) {
1212 pthread_mutex_lock(socket
->lock
);
1213 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1214 usess
->consumer
, socket
,
1215 session
->name
, session
->hostname
,
1217 session
->live_timer
,
1218 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1219 session
->creation_time
,
1220 session
->name_contains_creation_time
);
1221 pthread_mutex_unlock(socket
->lock
);
1222 if (ret
!= LTTNG_OK
) {
1225 /* Session is now ready for network streaming. */
1226 session
->net_handle
= 1;
1228 session
->consumer
->relay_major_version
=
1229 usess
->consumer
->relay_major_version
;
1230 session
->consumer
->relay_minor_version
=
1231 usess
->consumer
->relay_minor_version
;
1232 session
->consumer
->relay_allows_clear
=
1233 usess
->consumer
->relay_allows_clear
;
1236 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1237 && ksess
->consumer
->enabled
) {
1238 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1239 socket
, node
.node
) {
1240 pthread_mutex_lock(socket
->lock
);
1241 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1242 ksess
->consumer
, socket
,
1243 session
->name
, session
->hostname
,
1245 session
->live_timer
,
1246 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1247 session
->creation_time
,
1248 session
->name_contains_creation_time
);
1249 pthread_mutex_unlock(socket
->lock
);
1250 if (ret
!= LTTNG_OK
) {
1253 /* Session is now ready for network streaming. */
1254 session
->net_handle
= 1;
1256 session
->consumer
->relay_major_version
=
1257 ksess
->consumer
->relay_major_version
;
1258 session
->consumer
->relay_minor_version
=
1259 ksess
->consumer
->relay_minor_version
;
1260 session
->consumer
->relay_allows_clear
=
1261 ksess
->consumer
->relay_allows_clear
;
1270 * Start a kernel session by opening all necessary streams.
1272 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1275 struct ltt_kernel_channel
*kchan
;
1277 /* Open kernel metadata */
1278 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1279 ret
= kernel_open_metadata(ksess
);
1281 ret
= LTTNG_ERR_KERN_META_FAIL
;
1286 /* Open kernel metadata stream */
1287 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1288 ret
= kernel_open_metadata_stream(ksess
);
1290 ERR("Kernel create metadata stream failed");
1291 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1296 /* For each channel */
1297 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1298 if (kchan
->stream_count
== 0) {
1299 ret
= kernel_open_channel_stream(kchan
);
1301 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1304 /* Update the stream global counter */
1305 ksess
->stream_count_global
+= ret
;
1309 /* Setup kernel consumer socket and send fds to it */
1310 ret
= init_kernel_tracing(ksess
);
1312 ret
= LTTNG_ERR_KERN_START_FAIL
;
1316 /* This start the kernel tracing */
1317 ret
= kernel_start_session(ksess
);
1319 ret
= LTTNG_ERR_KERN_START_FAIL
;
1323 /* Quiescent wait after starting trace */
1324 kernel_wait_quiescent();
1334 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1336 struct ltt_kernel_channel
*kchan
;
1337 bool error_occurred
= false;
1340 if (!ksess
|| !ksess
->active
) {
1343 DBG("Stopping kernel tracing");
1345 ret
= kernel_stop_session(ksess
);
1347 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1351 kernel_wait_quiescent();
1353 /* Flush metadata after stopping (if exists) */
1354 if (ksess
->metadata_stream_fd
>= 0) {
1355 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1357 ERR("Kernel metadata flush failed");
1358 error_occurred
= true;
1362 /* Flush all buffers after stopping */
1363 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1364 ret
= kernel_flush_buffer(kchan
);
1366 ERR("Kernel flush buffer error");
1367 error_occurred
= true;
1372 if (error_occurred
) {
1373 ret
= LTTNG_ERR_UNK
;
1382 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1384 int cmd_disable_channel(struct ltt_session
*session
,
1385 enum lttng_domain_type domain
, char *channel_name
)
1388 struct ltt_ust_session
*usess
;
1390 usess
= session
->ust_session
;
1395 case LTTNG_DOMAIN_KERNEL
:
1397 ret
= channel_kernel_disable(session
->kernel_session
,
1399 if (ret
!= LTTNG_OK
) {
1403 kernel_wait_quiescent();
1406 case LTTNG_DOMAIN_UST
:
1408 struct ltt_ust_channel
*uchan
;
1409 struct lttng_ht
*chan_ht
;
1411 chan_ht
= usess
->domain_global
.channels
;
1413 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1414 if (uchan
== NULL
) {
1415 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1419 ret
= channel_ust_disable(usess
, uchan
);
1420 if (ret
!= LTTNG_OK
) {
1426 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1438 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1440 * The wpipe arguments is used as a notifier for the kernel thread.
1442 int cmd_enable_channel(struct ltt_session
*session
,
1443 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1446 struct ltt_ust_session
*usess
= session
->ust_session
;
1447 struct lttng_ht
*chan_ht
;
1449 struct lttng_channel attr
;
1456 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1458 /* Validate channel name */
1459 if (attr
.name
[0] == '.' ||
1460 memchr(attr
.name
, '/', len
) != NULL
) {
1461 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1465 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1470 * Don't try to enable a channel if the session has been started at
1471 * some point in time before. The tracer does not allow it.
1473 if (session
->has_been_started
) {
1474 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1479 * If the session is a live session, remove the switch timer, the
1480 * live timer does the same thing but sends also synchronisation
1481 * beacons for inactive streams.
1483 if (session
->live_timer
> 0) {
1484 attr
.attr
.live_timer_interval
= session
->live_timer
;
1485 attr
.attr
.switch_timer_interval
= 0;
1488 /* Check for feature support */
1489 switch (domain
->type
) {
1490 case LTTNG_DOMAIN_KERNEL
:
1492 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1493 /* Sampling position of buffer is not supported */
1494 WARN("Kernel tracer does not support buffer monitoring. "
1495 "Setting the monitor interval timer to 0 "
1496 "(disabled) for channel '%s' of session '%s'",
1497 attr
.name
, session
->name
);
1498 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1502 case LTTNG_DOMAIN_UST
:
1504 case LTTNG_DOMAIN_JUL
:
1505 case LTTNG_DOMAIN_LOG4J
:
1506 case LTTNG_DOMAIN_PYTHON
:
1507 if (!agent_tracing_is_enabled()) {
1508 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1509 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1514 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1518 switch (domain
->type
) {
1519 case LTTNG_DOMAIN_KERNEL
:
1521 struct ltt_kernel_channel
*kchan
;
1523 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1524 session
->kernel_session
);
1525 if (kchan
== NULL
) {
1526 if (session
->snapshot
.nb_output
> 0 ||
1527 session
->snapshot_mode
) {
1528 /* Enforce mmap output for snapshot sessions. */
1529 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1531 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1532 if (attr
.name
[0] != '\0') {
1533 session
->kernel_session
->has_non_default_channel
= 1;
1536 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1539 if (ret
!= LTTNG_OK
) {
1543 kernel_wait_quiescent();
1546 case LTTNG_DOMAIN_UST
:
1547 case LTTNG_DOMAIN_JUL
:
1548 case LTTNG_DOMAIN_LOG4J
:
1549 case LTTNG_DOMAIN_PYTHON
:
1551 struct ltt_ust_channel
*uchan
;
1556 * Current agent implementation limitations force us to allow
1557 * only one channel at once in "agent" subdomains. Each
1558 * subdomain has a default channel name which must be strictly
1561 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1562 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1563 LTTNG_SYMBOL_NAME_LEN
)) {
1564 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1567 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1568 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1569 LTTNG_SYMBOL_NAME_LEN
)) {
1570 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1573 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1574 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1575 LTTNG_SYMBOL_NAME_LEN
)) {
1576 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1581 chan_ht
= usess
->domain_global
.channels
;
1583 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1584 if (uchan
== NULL
) {
1585 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1586 if (attr
.name
[0] != '\0') {
1587 usess
->has_non_default_channel
= 1;
1590 ret
= channel_ust_enable(usess
, uchan
);
1595 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1599 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1600 session
->has_non_mmap_channel
= true;
1608 enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(
1609 struct ltt_session
*session
,
1610 enum lttng_domain_type domain
,
1611 enum lttng_process_attr process_attr
,
1612 enum lttng_tracking_policy
*policy
)
1614 enum lttng_error_code ret_code
= LTTNG_OK
;
1615 const struct process_attr_tracker
*tracker
;
1618 case LTTNG_DOMAIN_KERNEL
:
1619 if (!session
->kernel_session
) {
1620 ret_code
= LTTNG_ERR_INVALID
;
1623 tracker
= kernel_get_process_attr_tracker(
1624 session
->kernel_session
, process_attr
);
1626 case LTTNG_DOMAIN_UST
:
1627 if (!session
->ust_session
) {
1628 ret_code
= LTTNG_ERR_INVALID
;
1631 tracker
= trace_ust_get_process_attr_tracker(
1632 session
->ust_session
, process_attr
);
1635 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1639 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1641 ret_code
= LTTNG_ERR_INVALID
;
1647 enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(
1648 struct ltt_session
*session
,
1649 enum lttng_domain_type domain
,
1650 enum lttng_process_attr process_attr
,
1651 enum lttng_tracking_policy policy
)
1653 enum lttng_error_code ret_code
= LTTNG_OK
;
1656 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1657 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1658 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1661 ret_code
= LTTNG_ERR_INVALID
;
1666 case LTTNG_DOMAIN_KERNEL
:
1667 if (!session
->kernel_session
) {
1668 ret_code
= LTTNG_ERR_INVALID
;
1671 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1672 session
->kernel_session
, process_attr
, policy
);
1674 case LTTNG_DOMAIN_UST
:
1675 if (!session
->ust_session
) {
1676 ret_code
= LTTNG_ERR_INVALID
;
1679 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1680 session
->ust_session
, process_attr
, policy
);
1683 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1690 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(
1691 struct ltt_session
*session
,
1692 enum lttng_domain_type domain
,
1693 enum lttng_process_attr process_attr
,
1694 const struct process_attr_value
*value
)
1696 enum lttng_error_code ret_code
= LTTNG_OK
;
1699 case LTTNG_DOMAIN_KERNEL
:
1700 if (!session
->kernel_session
) {
1701 ret_code
= LTTNG_ERR_INVALID
;
1704 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1705 session
->kernel_session
, process_attr
, value
);
1707 case LTTNG_DOMAIN_UST
:
1708 if (!session
->ust_session
) {
1709 ret_code
= LTTNG_ERR_INVALID
;
1712 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1713 session
->ust_session
, process_attr
, value
);
1716 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1723 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(
1724 struct ltt_session
*session
,
1725 enum lttng_domain_type domain
,
1726 enum lttng_process_attr process_attr
,
1727 const struct process_attr_value
*value
)
1729 enum lttng_error_code ret_code
= LTTNG_OK
;
1732 case LTTNG_DOMAIN_KERNEL
:
1733 if (!session
->kernel_session
) {
1734 ret_code
= LTTNG_ERR_INVALID
;
1737 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1738 session
->kernel_session
, process_attr
, value
);
1740 case LTTNG_DOMAIN_UST
:
1741 if (!session
->ust_session
) {
1742 ret_code
= LTTNG_ERR_INVALID
;
1745 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1746 session
->ust_session
, process_attr
, value
);
1749 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1756 enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(
1757 struct ltt_session
*session
,
1758 enum lttng_domain_type domain
,
1759 enum lttng_process_attr process_attr
,
1760 struct lttng_process_attr_values
**values
)
1762 enum lttng_error_code ret_code
= LTTNG_OK
;
1763 const struct process_attr_tracker
*tracker
;
1764 enum process_attr_tracker_status status
;
1767 case LTTNG_DOMAIN_KERNEL
:
1768 if (!session
->kernel_session
) {
1769 ret_code
= LTTNG_ERR_INVALID
;
1772 tracker
= kernel_get_process_attr_tracker(
1773 session
->kernel_session
, process_attr
);
1775 case LTTNG_DOMAIN_UST
:
1776 if (!session
->ust_session
) {
1777 ret_code
= LTTNG_ERR_INVALID
;
1780 tracker
= trace_ust_get_process_attr_tracker(
1781 session
->ust_session
, process_attr
);
1784 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1789 ret_code
= LTTNG_ERR_INVALID
;
1793 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1795 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1796 ret_code
= LTTNG_OK
;
1798 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1799 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1801 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1802 ret_code
= LTTNG_ERR_NOMEM
;
1805 ret_code
= LTTNG_ERR_UNK
;
1814 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1816 int cmd_disable_event(struct ltt_session
*session
,
1817 enum lttng_domain_type domain
, const char *channel_name
,
1818 const struct lttng_event
*event
)
1821 const char *event_name
;
1823 DBG("Disable event command for event \'%s\'", event
->name
);
1825 event_name
= event
->name
;
1827 /* Error out on unhandled search criteria */
1828 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1829 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1830 ret
= LTTNG_ERR_UNK
;
1837 case LTTNG_DOMAIN_KERNEL
:
1839 struct ltt_kernel_channel
*kchan
;
1840 struct ltt_kernel_session
*ksess
;
1842 ksess
= session
->kernel_session
;
1845 * If a non-default channel has been created in the
1846 * session, explicitely require that -c chan_name needs
1849 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1850 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1854 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1855 if (kchan
== NULL
) {
1856 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1860 switch (event
->type
) {
1861 case LTTNG_EVENT_ALL
:
1862 case LTTNG_EVENT_TRACEPOINT
:
1863 case LTTNG_EVENT_SYSCALL
:
1864 case LTTNG_EVENT_PROBE
:
1865 case LTTNG_EVENT_FUNCTION
:
1866 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1867 if (event_name
[0] == '\0') {
1868 ret
= event_kernel_disable_event(kchan
,
1871 ret
= event_kernel_disable_event(kchan
,
1872 event_name
, event
->type
);
1874 if (ret
!= LTTNG_OK
) {
1879 ret
= LTTNG_ERR_UNK
;
1883 kernel_wait_quiescent();
1886 case LTTNG_DOMAIN_UST
:
1888 struct ltt_ust_channel
*uchan
;
1889 struct ltt_ust_session
*usess
;
1891 usess
= session
->ust_session
;
1893 if (validate_ust_event_name(event_name
)) {
1894 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1899 * If a non-default channel has been created in the
1900 * session, explicitly require that -c chan_name needs
1903 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1904 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1908 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1910 if (uchan
== NULL
) {
1911 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1915 switch (event
->type
) {
1916 case LTTNG_EVENT_ALL
:
1918 * An empty event name means that everything
1919 * should be disabled.
1921 if (event
->name
[0] == '\0') {
1922 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1924 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1927 if (ret
!= LTTNG_OK
) {
1932 ret
= LTTNG_ERR_UNK
;
1936 DBG3("Disable UST event %s in channel %s completed", event_name
,
1940 case LTTNG_DOMAIN_LOG4J
:
1941 case LTTNG_DOMAIN_JUL
:
1942 case LTTNG_DOMAIN_PYTHON
:
1945 struct ltt_ust_session
*usess
= session
->ust_session
;
1949 switch (event
->type
) {
1950 case LTTNG_EVENT_ALL
:
1953 ret
= LTTNG_ERR_UNK
;
1957 agt
= trace_ust_find_agent(usess
, domain
);
1959 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1963 * An empty event name means that everything
1964 * should be disabled.
1966 if (event
->name
[0] == '\0') {
1967 ret
= event_agent_disable_all(usess
, agt
);
1969 ret
= event_agent_disable(usess
, agt
, event_name
);
1971 if (ret
!= LTTNG_OK
) {
1978 ret
= LTTNG_ERR_UND
;
1991 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1993 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1994 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
1996 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1997 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
2000 * Don't try to add a context if the session has been started at
2001 * some point in time before. The tracer does not allow it and would
2002 * result in a corrupted trace.
2004 if (session
->has_been_started
) {
2005 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2009 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
2010 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
2011 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
2015 case LTTNG_DOMAIN_KERNEL
:
2016 assert(session
->kernel_session
);
2018 if (session
->kernel_session
->channel_count
== 0) {
2019 /* Create default channel */
2020 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
2021 if (ret
!= LTTNG_OK
) {
2024 chan_kern_created
= 1;
2026 /* Add kernel context to kernel tracer */
2027 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
2028 if (ret
!= LTTNG_OK
) {
2032 case LTTNG_DOMAIN_JUL
:
2033 case LTTNG_DOMAIN_LOG4J
:
2036 * Validate channel name.
2037 * If no channel name is given and the domain is JUL or LOG4J,
2038 * set it to the appropriate domain-specific channel name. If
2039 * a name is provided but does not match the expexted channel
2040 * name, return an error.
2042 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
2043 strcmp(channel_name
,
2044 DEFAULT_JUL_CHANNEL_NAME
)) {
2045 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2047 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
2048 strcmp(channel_name
,
2049 DEFAULT_LOG4J_CHANNEL_NAME
)) {
2050 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2053 /* break is _not_ missing here. */
2055 case LTTNG_DOMAIN_UST
:
2057 struct ltt_ust_session
*usess
= session
->ust_session
;
2058 unsigned int chan_count
;
2062 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
2063 if (chan_count
== 0) {
2064 struct lttng_channel
*attr
;
2065 /* Create default channel */
2066 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
2068 ret
= LTTNG_ERR_FATAL
;
2072 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
2073 if (ret
!= LTTNG_OK
) {
2077 channel_attr_destroy(attr
);
2078 chan_ust_created
= 1;
2081 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
2082 free(app_ctx_provider_name
);
2084 app_ctx_name
= NULL
;
2085 app_ctx_provider_name
= NULL
;
2086 if (ret
!= LTTNG_OK
) {
2092 ret
= LTTNG_ERR_UND
;
2100 if (chan_kern_created
) {
2101 struct ltt_kernel_channel
*kchan
=
2102 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
2103 session
->kernel_session
);
2104 /* Created previously, this should NOT fail. */
2106 kernel_destroy_channel(kchan
);
2109 if (chan_ust_created
) {
2110 struct ltt_ust_channel
*uchan
=
2111 trace_ust_find_channel_by_name(
2112 session
->ust_session
->domain_global
.channels
,
2113 DEFAULT_CHANNEL_NAME
);
2114 /* Created previously, this should NOT fail. */
2116 /* Remove from the channel list of the session. */
2117 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2119 trace_ust_destroy_channel(uchan
);
2122 free(app_ctx_provider_name
);
2127 static inline bool name_starts_with(const char *name
, const char *prefix
)
2129 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2131 return !strncmp(name
, prefix
, max_cmp_len
);
2134 /* Perform userspace-specific event name validation */
2135 static int validate_ust_event_name(const char *name
)
2145 * Check name against all internal UST event component namespaces used
2148 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2149 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2150 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2159 * Internal version of cmd_enable_event() with a supplemental
2160 * "internal_event" flag which is used to enable internal events which should
2161 * be hidden from clients. Such events are used in the agent implementation to
2162 * enable the events through which all "agent" events are funeled.
2164 static int _cmd_enable_event(struct ltt_session
*session
,
2165 const struct lttng_domain
*domain
,
2166 char *channel_name
, struct lttng_event
*event
,
2167 char *filter_expression
,
2168 struct lttng_filter_bytecode
*filter
,
2169 struct lttng_event_exclusion
*exclusion
,
2170 int wpipe
, bool internal_event
)
2172 int ret
= 0, channel_created
= 0;
2173 struct lttng_channel
*attr
= NULL
;
2177 assert(channel_name
);
2179 /* If we have a filter, we must have its filter expression */
2180 assert(!(!!filter_expression
^ !!filter
));
2182 /* Normalize event name as a globbing pattern */
2183 strutils_normalize_star_glob_pattern(event
->name
);
2185 /* Normalize exclusion names as globbing patterns */
2189 for (i
= 0; i
< exclusion
->count
; i
++) {
2190 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2192 strutils_normalize_star_glob_pattern(name
);
2196 DBG("Enable event command for event \'%s\'", event
->name
);
2200 switch (domain
->type
) {
2201 case LTTNG_DOMAIN_KERNEL
:
2203 struct ltt_kernel_channel
*kchan
;
2206 * If a non-default channel has been created in the
2207 * session, explicitely require that -c chan_name needs
2210 if (session
->kernel_session
->has_non_default_channel
2211 && channel_name
[0] == '\0') {
2212 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2216 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2217 session
->kernel_session
);
2218 if (kchan
== NULL
) {
2219 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2220 LTTNG_BUFFER_GLOBAL
);
2222 ret
= LTTNG_ERR_FATAL
;
2225 if (lttng_strncpy(attr
->name
, channel_name
,
2226 sizeof(attr
->name
))) {
2227 ret
= LTTNG_ERR_INVALID
;
2231 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2232 if (ret
!= LTTNG_OK
) {
2235 channel_created
= 1;
2238 /* Get the newly created kernel channel pointer */
2239 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2240 session
->kernel_session
);
2241 if (kchan
== NULL
) {
2242 /* This sould not happen... */
2243 ret
= LTTNG_ERR_FATAL
;
2247 switch (event
->type
) {
2248 case LTTNG_EVENT_ALL
:
2250 char *filter_expression_a
= NULL
;
2251 struct lttng_filter_bytecode
*filter_a
= NULL
;
2254 * We need to duplicate filter_expression and filter,
2255 * because ownership is passed to first enable
2258 if (filter_expression
) {
2259 filter_expression_a
= strdup(filter_expression
);
2260 if (!filter_expression_a
) {
2261 ret
= LTTNG_ERR_FATAL
;
2266 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2268 free(filter_expression_a
);
2269 ret
= LTTNG_ERR_FATAL
;
2272 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2274 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2275 ret
= event_kernel_enable_event(kchan
, event
,
2276 filter_expression
, filter
);
2277 /* We have passed ownership */
2278 filter_expression
= NULL
;
2280 if (ret
!= LTTNG_OK
) {
2281 if (channel_created
) {
2282 /* Let's not leak a useless channel. */
2283 kernel_destroy_channel(kchan
);
2285 free(filter_expression_a
);
2289 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2290 ret
= event_kernel_enable_event(kchan
, event
,
2291 filter_expression_a
, filter_a
);
2292 /* We have passed ownership */
2293 filter_expression_a
= NULL
;
2295 if (ret
!= LTTNG_OK
) {
2300 case LTTNG_EVENT_PROBE
:
2301 case LTTNG_EVENT_USERSPACE_PROBE
:
2302 case LTTNG_EVENT_FUNCTION
:
2303 case LTTNG_EVENT_FUNCTION_ENTRY
:
2304 case LTTNG_EVENT_TRACEPOINT
:
2305 ret
= event_kernel_enable_event(kchan
, event
,
2306 filter_expression
, filter
);
2307 /* We have passed ownership */
2308 filter_expression
= NULL
;
2310 if (ret
!= LTTNG_OK
) {
2311 if (channel_created
) {
2312 /* Let's not leak a useless channel. */
2313 kernel_destroy_channel(kchan
);
2318 case LTTNG_EVENT_SYSCALL
:
2319 ret
= event_kernel_enable_event(kchan
, event
,
2320 filter_expression
, filter
);
2321 /* We have passed ownership */
2322 filter_expression
= NULL
;
2324 if (ret
!= LTTNG_OK
) {
2329 ret
= LTTNG_ERR_UNK
;
2333 kernel_wait_quiescent();
2336 case LTTNG_DOMAIN_UST
:
2338 struct ltt_ust_channel
*uchan
;
2339 struct ltt_ust_session
*usess
= session
->ust_session
;
2344 * If a non-default channel has been created in the
2345 * session, explicitely require that -c chan_name needs
2348 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2349 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2353 /* Get channel from global UST domain */
2354 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2356 if (uchan
== NULL
) {
2357 /* Create default channel */
2358 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2359 usess
->buffer_type
);
2361 ret
= LTTNG_ERR_FATAL
;
2364 if (lttng_strncpy(attr
->name
, channel_name
,
2365 sizeof(attr
->name
))) {
2366 ret
= LTTNG_ERR_INVALID
;
2370 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2371 if (ret
!= LTTNG_OK
) {
2375 /* Get the newly created channel reference back */
2376 uchan
= trace_ust_find_channel_by_name(
2377 usess
->domain_global
.channels
, channel_name
);
2381 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2383 * Don't allow users to add UST events to channels which
2384 * are assigned to a userspace subdomain (JUL, Log4J,
2387 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2391 if (!internal_event
) {
2393 * Ensure the event name is not reserved for internal
2396 ret
= validate_ust_event_name(event
->name
);
2398 WARN("Userspace event name %s failed validation.",
2400 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2405 /* At this point, the session and channel exist on the tracer */
2406 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2407 filter_expression
, filter
, exclusion
,
2409 /* We have passed ownership */
2410 filter_expression
= NULL
;
2413 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2414 goto already_enabled
;
2415 } else if (ret
!= LTTNG_OK
) {
2420 case LTTNG_DOMAIN_LOG4J
:
2421 case LTTNG_DOMAIN_JUL
:
2422 case LTTNG_DOMAIN_PYTHON
:
2424 const char *default_event_name
, *default_chan_name
;
2426 struct lttng_event uevent
;
2427 struct lttng_domain tmp_dom
;
2428 struct ltt_ust_session
*usess
= session
->ust_session
;
2432 if (!agent_tracing_is_enabled()) {
2433 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2434 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2438 agt
= trace_ust_find_agent(usess
, domain
->type
);
2440 agt
= agent_create(domain
->type
);
2442 ret
= LTTNG_ERR_NOMEM
;
2445 agent_add(agt
, usess
->agents
);
2448 /* Create the default tracepoint. */
2449 memset(&uevent
, 0, sizeof(uevent
));
2450 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2451 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2452 default_event_name
= event_get_default_agent_ust_name(
2454 if (!default_event_name
) {
2455 ret
= LTTNG_ERR_FATAL
;
2458 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2459 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2462 * The domain type is changed because we are about to enable the
2463 * default channel and event for the JUL domain that are hardcoded.
2464 * This happens in the UST domain.
2466 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2467 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2469 switch (domain
->type
) {
2470 case LTTNG_DOMAIN_LOG4J
:
2471 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2473 case LTTNG_DOMAIN_JUL
:
2474 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2476 case LTTNG_DOMAIN_PYTHON
:
2477 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2480 /* The switch/case we are in makes this impossible */
2485 char *filter_expression_copy
= NULL
;
2486 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2489 const size_t filter_size
= sizeof(
2490 struct lttng_filter_bytecode
)
2493 filter_copy
= zmalloc(filter_size
);
2495 ret
= LTTNG_ERR_NOMEM
;
2498 memcpy(filter_copy
, filter
, filter_size
);
2500 filter_expression_copy
=
2501 strdup(filter_expression
);
2502 if (!filter_expression
) {
2503 ret
= LTTNG_ERR_NOMEM
;
2506 if (!filter_expression_copy
|| !filter_copy
) {
2507 free(filter_expression_copy
);
2513 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2514 (char *) default_chan_name
,
2515 &uevent
, filter_expression_copy
,
2516 filter_copy
, NULL
, wpipe
);
2519 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2520 goto already_enabled
;
2521 } else if (ret
!= LTTNG_OK
) {
2525 /* The wild card * means that everything should be enabled. */
2526 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2527 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2530 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2534 filter_expression
= NULL
;
2535 if (ret
!= LTTNG_OK
) {
2542 ret
= LTTNG_ERR_UND
;
2550 free(filter_expression
);
2553 channel_attr_destroy(attr
);
2559 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2560 * We own filter, exclusion, and filter_expression.
2562 int cmd_enable_event(struct ltt_session
*session
,
2563 const struct lttng_domain
*domain
,
2564 char *channel_name
, struct lttng_event
*event
,
2565 char *filter_expression
,
2566 struct lttng_filter_bytecode
*filter
,
2567 struct lttng_event_exclusion
*exclusion
,
2570 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2571 filter_expression
, filter
, exclusion
, wpipe
, false);
2575 * Enable an event which is internal to LTTng. An internal should
2576 * never be made visible to clients and are immune to checks such as
2579 static int cmd_enable_event_internal(struct ltt_session
*session
,
2580 const struct lttng_domain
*domain
,
2581 char *channel_name
, struct lttng_event
*event
,
2582 char *filter_expression
,
2583 struct lttng_filter_bytecode
*filter
,
2584 struct lttng_event_exclusion
*exclusion
,
2587 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2588 filter_expression
, filter
, exclusion
, wpipe
, true);
2592 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2594 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2595 struct lttng_event
**events
)
2598 ssize_t nb_events
= 0;
2601 case LTTNG_DOMAIN_KERNEL
:
2602 nb_events
= kernel_list_events(events
);
2603 if (nb_events
< 0) {
2604 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2608 case LTTNG_DOMAIN_UST
:
2609 nb_events
= ust_app_list_events(events
);
2610 if (nb_events
< 0) {
2611 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2615 case LTTNG_DOMAIN_LOG4J
:
2616 case LTTNG_DOMAIN_JUL
:
2617 case LTTNG_DOMAIN_PYTHON
:
2618 nb_events
= agent_list_events(events
, domain
);
2619 if (nb_events
< 0) {
2620 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2625 ret
= LTTNG_ERR_UND
;
2632 /* Return negative value to differentiate return code */
2637 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2639 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2640 struct lttng_event_field
**fields
)
2643 ssize_t nb_fields
= 0;
2646 case LTTNG_DOMAIN_UST
:
2647 nb_fields
= ust_app_list_event_fields(fields
);
2648 if (nb_fields
< 0) {
2649 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2653 case LTTNG_DOMAIN_KERNEL
:
2654 default: /* fall-through */
2655 ret
= LTTNG_ERR_UND
;
2662 /* Return negative value to differentiate return code */
2666 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2668 return syscall_table_list(events
);
2672 * Command LTTNG_START_TRACE processed by the client thread.
2674 * Called with session mutex held.
2676 int cmd_start_trace(struct ltt_session
*session
)
2678 enum lttng_error_code ret
;
2679 unsigned long nb_chan
= 0;
2680 struct ltt_kernel_session
*ksession
;
2681 struct ltt_ust_session
*usess
;
2682 const bool session_rotated_after_last_stop
=
2683 session
->rotated_after_last_stop
;
2684 const bool session_cleared_after_last_stop
=
2685 session
->cleared_after_last_stop
;
2689 /* Ease our life a bit ;) */
2690 ksession
= session
->kernel_session
;
2691 usess
= session
->ust_session
;
2693 /* Is the session already started? */
2694 if (session
->active
) {
2695 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2696 /* Perform nothing */
2700 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2701 !session
->current_trace_chunk
) {
2703 * A rotation was launched while the session was stopped and
2704 * it has not been completed yet. It is not possible to start
2705 * the session since starting the session here would require a
2706 * rotation from "NULL" to a new trace chunk. That rotation
2707 * would overlap with the ongoing rotation, which is not
2710 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2712 ret
= LTTNG_ERR_ROTATION_PENDING
;
2717 * Starting a session without channel is useless since after that it's not
2718 * possible to enable channel thus inform the client.
2720 if (usess
&& usess
->domain_global
.channels
) {
2721 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2724 nb_chan
+= ksession
->channel_count
;
2727 ret
= LTTNG_ERR_NO_CHANNEL
;
2731 session
->active
= 1;
2732 session
->rotated_after_last_stop
= false;
2733 session
->cleared_after_last_stop
= false;
2734 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2735 if (!session
->has_been_started
) {
2736 struct lttng_trace_chunk
*trace_chunk
;
2738 DBG("Creating initial trace chunk of session \"%s\"",
2740 trace_chunk
= session_create_new_trace_chunk(
2741 session
, NULL
, NULL
, NULL
);
2743 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2746 assert(!session
->current_trace_chunk
);
2747 ret
= session_set_trace_chunk(session
, trace_chunk
,
2749 lttng_trace_chunk_put(trace_chunk
);
2751 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2755 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2758 * Rotate existing streams into the new chunk.
2759 * This is a "quiet" rotation has no client has
2760 * explicitly requested this operation.
2762 * There is also no need to wait for the rotation
2763 * to complete as it will happen immediately. No data
2764 * was produced as the session was stopped, so the
2765 * rotation should happen on reception of the command.
2767 ret
= cmd_rotate_session(session
, NULL
, true,
2768 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2769 if (ret
!= LTTNG_OK
) {
2775 /* Kernel tracing */
2776 if (ksession
!= NULL
) {
2777 DBG("Start kernel tracing session %s", session
->name
);
2778 ret
= start_kernel_session(ksession
);
2779 if (ret
!= LTTNG_OK
) {
2784 /* Flag session that trace should start automatically */
2786 int int_ret
= ust_app_start_trace_all(usess
);
2789 ret
= LTTNG_ERR_UST_START_FAIL
;
2795 * Open a packet in every stream of the session to ensure that viewers
2796 * can correctly identify the boundaries of the periods during which
2797 * tracing was active for this session.
2799 ret
= session_open_packets(session
);
2800 if (ret
!= LTTNG_OK
) {
2805 * Clear the flag that indicates that a rotation was done while the
2806 * session was stopped.
2808 session
->rotated_after_last_stop
= false;
2810 if (session
->rotate_timer_period
) {
2811 int int_ret
= timer_session_rotation_schedule_timer_start(
2812 session
, session
->rotate_timer_period
);
2815 ERR("Failed to enable rotate timer");
2816 ret
= LTTNG_ERR_UNK
;
2824 if (ret
== LTTNG_OK
) {
2825 /* Flag this after a successful start. */
2826 session
->has_been_started
|= 1;
2828 session
->active
= 0;
2829 /* Restore initial state on error. */
2830 session
->rotated_after_last_stop
=
2831 session_rotated_after_last_stop
;
2832 session
->cleared_after_last_stop
=
2833 session_cleared_after_last_stop
;
2840 * Command LTTNG_STOP_TRACE processed by the client thread.
2842 int cmd_stop_trace(struct ltt_session
*session
)
2845 struct ltt_kernel_session
*ksession
;
2846 struct ltt_ust_session
*usess
;
2850 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2852 ksession
= session
->kernel_session
;
2853 usess
= session
->ust_session
;
2855 /* Session is not active. Skip everythong and inform the client. */
2856 if (!session
->active
) {
2857 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2861 ret
= stop_kernel_session(ksession
);
2862 if (ret
!= LTTNG_OK
) {
2866 if (usess
&& usess
->active
) {
2867 ret
= ust_app_stop_trace_all(usess
);
2869 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2874 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2876 /* Flag inactive after a successful stop. */
2877 session
->active
= 0;
2885 * Set the base_path of the session only if subdir of a control uris is set.
2886 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2888 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2890 struct lttng_uri
*uris
)
2895 for (i
= 0; i
< nb_uri
; i
++) {
2896 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2897 uris
[i
].subdir
[0] == '\0') {
2898 /* Not interested in these URIs */
2902 if (session
->base_path
!= NULL
) {
2903 free(session
->base_path
);
2904 session
->base_path
= NULL
;
2907 /* Set session base_path */
2908 session
->base_path
= strdup(uris
[i
].subdir
);
2909 if (!session
->base_path
) {
2910 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2911 uris
[i
].subdir
, session
->name
);
2912 ret
= LTTNG_ERR_NOMEM
;
2915 DBG2("Setting base path \"%s\" for session \"%s\"",
2916 session
->base_path
, session
->name
);
2924 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2926 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2927 struct lttng_uri
*uris
)
2930 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2931 struct ltt_ust_session
*usess
= session
->ust_session
;
2937 /* Can't set consumer URI if the session is active. */
2938 if (session
->active
) {
2939 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2944 * Set the session base path if any. This is done inside
2945 * cmd_set_consumer_uri to preserve backward compatibility of the
2946 * previous session creation api vs the session descriptor api.
2948 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2949 if (ret
!= LTTNG_OK
) {
2953 /* Set the "global" consumer URIs */
2954 for (i
= 0; i
< nb_uri
; i
++) {
2955 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2957 if (ret
!= LTTNG_OK
) {
2962 /* Set UST session URIs */
2963 if (session
->ust_session
) {
2964 for (i
= 0; i
< nb_uri
; i
++) {
2965 ret
= add_uri_to_consumer(session
,
2966 session
->ust_session
->consumer
,
2967 &uris
[i
], LTTNG_DOMAIN_UST
);
2968 if (ret
!= LTTNG_OK
) {
2974 /* Set kernel session URIs */
2975 if (session
->kernel_session
) {
2976 for (i
= 0; i
< nb_uri
; i
++) {
2977 ret
= add_uri_to_consumer(session
,
2978 session
->kernel_session
->consumer
,
2979 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2980 if (ret
!= LTTNG_OK
) {
2987 * Make sure to set the session in output mode after we set URI since a
2988 * session can be created without URL (thus flagged in no output mode).
2990 session
->output_traces
= 1;
2992 ksess
->output_traces
= 1;
2996 usess
->output_traces
= 1;
3007 enum lttng_error_code
set_session_output_from_descriptor(
3008 struct ltt_session
*session
,
3009 const struct lttng_session_descriptor
*descriptor
)
3012 enum lttng_error_code ret_code
= LTTNG_OK
;
3013 enum lttng_session_descriptor_type session_type
=
3014 lttng_session_descriptor_get_type(descriptor
);
3015 enum lttng_session_descriptor_output_type output_type
=
3016 lttng_session_descriptor_get_output_type(descriptor
);
3017 struct lttng_uri uris
[2] = {};
3018 size_t uri_count
= 0;
3020 switch (output_type
) {
3021 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
3023 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
3024 lttng_session_descriptor_get_local_output_uri(descriptor
,
3028 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3029 lttng_session_descriptor_get_network_output_uris(descriptor
,
3030 &uris
[0], &uris
[1]);
3034 ret_code
= LTTNG_ERR_INVALID
;
3038 switch (session_type
) {
3039 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3041 struct snapshot_output
*new_output
= NULL
;
3043 new_output
= snapshot_output_alloc();
3045 ret_code
= LTTNG_ERR_NOMEM
;
3049 ret
= snapshot_output_init_with_uri(session
,
3050 DEFAULT_SNAPSHOT_MAX_SIZE
,
3051 NULL
, uris
, uri_count
, session
->consumer
,
3052 new_output
, &session
->snapshot
);
3054 ret_code
= (ret
== -ENOMEM
) ?
3055 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3056 snapshot_output_destroy(new_output
);
3059 snapshot_add_output(&session
->snapshot
, new_output
);
3062 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3063 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3065 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3069 ret_code
= LTTNG_ERR_INVALID
;
3077 enum lttng_error_code
cmd_create_session_from_descriptor(
3078 struct lttng_session_descriptor
*descriptor
,
3079 const lttng_sock_cred
*creds
,
3080 const char *home_path
)
3083 enum lttng_error_code ret_code
;
3084 const char *session_name
;
3085 struct ltt_session
*new_session
= NULL
;
3086 enum lttng_session_descriptor_status descriptor_status
;
3088 session_lock_list();
3090 if (*home_path
!= '/') {
3091 ERR("Home path provided by client is not absolute");
3092 ret_code
= LTTNG_ERR_INVALID
;
3097 descriptor_status
= lttng_session_descriptor_get_session_name(
3098 descriptor
, &session_name
);
3099 switch (descriptor_status
) {
3100 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3102 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3103 session_name
= NULL
;
3106 ret_code
= LTTNG_ERR_INVALID
;
3110 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3112 if (ret_code
!= LTTNG_OK
) {
3116 if (!session_name
) {
3117 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3120 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3125 if (!lttng_session_descriptor_is_output_destination_initialized(
3128 * Only include the session's creation time in the output
3129 * destination if the name of the session itself was
3130 * not auto-generated.
3132 ret_code
= lttng_session_descriptor_set_default_output(
3134 session_name
? &new_session
->creation_time
: NULL
,
3136 if (ret_code
!= LTTNG_OK
) {
3140 new_session
->has_user_specified_directory
=
3141 lttng_session_descriptor_has_output_directory(
3145 switch (lttng_session_descriptor_get_type(descriptor
)) {
3146 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3147 new_session
->snapshot_mode
= 1;
3149 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3150 new_session
->live_timer
=
3151 lttng_session_descriptor_live_get_timer_interval(
3158 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3159 if (ret_code
!= LTTNG_OK
) {
3162 new_session
->consumer
->enabled
= 1;
3163 ret_code
= LTTNG_OK
;
3165 /* Release reference provided by the session_create function. */
3166 session_put(new_session
);
3167 if (ret_code
!= LTTNG_OK
&& new_session
) {
3168 /* Release the global reference on error. */
3169 session_destroy(new_session
);
3171 session_unlock_list();
3175 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3176 struct lttng_session_descriptor
**return_descriptor
)
3179 size_t payload_size
;
3180 struct lttng_dynamic_buffer payload
;
3181 struct lttng_buffer_view home_dir_view
;
3182 struct lttng_buffer_view session_descriptor_view
;
3183 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3184 enum lttng_error_code ret_code
;
3186 lttng_dynamic_buffer_init(&payload
);
3187 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3189 ret_code
= LTTNG_ERR_INVALID
;
3192 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3193 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3194 ret_code
= LTTNG_ERR_INVALID
;
3198 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3199 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3200 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3202 ret_code
= LTTNG_ERR_NOMEM
;
3206 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3208 ERR("Reception of session descriptor failed, aborting.");
3209 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3213 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3216 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3217 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3219 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3220 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3222 ret
= lttng_session_descriptor_create_from_buffer(
3223 &session_descriptor_view
, &session_descriptor
);
3225 ERR("Failed to create session descriptor from payload of \"create session\" command");
3226 ret_code
= LTTNG_ERR_INVALID
;
3231 * Sets the descriptor's auto-generated properties (name, output) if
3234 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3236 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3237 if (ret_code
!= LTTNG_OK
) {
3241 ret_code
= LTTNG_OK
;
3242 *return_descriptor
= session_descriptor
;
3243 session_descriptor
= NULL
;
3245 lttng_dynamic_buffer_reset(&payload
);
3246 lttng_session_descriptor_destroy(session_descriptor
);
3251 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3252 void *_reply_context
)
3256 const struct cmd_destroy_session_reply_context
*reply_context
=
3258 struct lttng_dynamic_buffer payload
;
3259 struct lttcomm_session_destroy_command_header cmd_header
;
3260 struct lttng_trace_archive_location
*location
= NULL
;
3261 struct lttcomm_lttng_msg llm
= {
3262 .cmd_type
= LTTNG_DESTROY_SESSION
,
3263 .ret_code
= reply_context
->destruction_status
,
3266 sizeof(struct lttcomm_session_destroy_command_header
),
3269 size_t payload_size_before_location
;
3271 lttng_dynamic_buffer_init(&payload
);
3273 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3275 ERR("Failed to append session destruction message");
3279 cmd_header
.rotation_state
=
3280 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3281 session
->rotation_state
:
3282 LTTNG_ROTATION_STATE_NO_ROTATION
);
3283 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3284 sizeof(cmd_header
));
3286 ERR("Failed to append session destruction command header");
3290 if (!reply_context
->implicit_rotation_on_destroy
) {
3291 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3295 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3296 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3301 location
= session_get_trace_archive_location(session
);
3303 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3308 payload_size_before_location
= payload
.size
;
3309 comm_ret
= lttng_trace_archive_location_serialize(location
,
3312 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3316 /* Update the message to indicate the location's length. */
3317 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3318 payload
.size
- payload_size_before_location
;
3320 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3321 payload
.data
, payload
.size
);
3322 if (comm_ret
!= (ssize_t
) payload
.size
) {
3323 ERR("Failed to send result of the destruction of session \"%s\" to client",
3327 ret
= close(reply_context
->reply_sock_fd
);
3329 PERROR("Failed to close client socket in deferred session destroy reply");
3331 lttng_dynamic_buffer_reset(&payload
);
3332 free(_reply_context
);
3336 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3338 * Called with session lock held.
3340 int cmd_destroy_session(struct ltt_session
*session
,
3341 struct notification_thread_handle
*notification_thread_handle
,
3345 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3346 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3349 reply_context
= zmalloc(sizeof(*reply_context
));
3350 if (!reply_context
) {
3351 ret
= LTTNG_ERR_NOMEM
;
3354 reply_context
->reply_sock_fd
= *sock_fd
;
3360 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3362 if (session
->active
) {
3363 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3365 ret
= cmd_stop_trace(session
);
3366 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3367 /* Carry on with the destruction of the session. */
3368 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3369 session
->name
, lttng_strerror(-ret
));
3370 destruction_last_error
= ret
;
3374 if (session
->rotation_schedule_timer_enabled
) {
3375 if (timer_session_rotation_schedule_timer_stop(
3377 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3379 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3383 if (session
->rotate_size
) {
3384 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3385 session
->rotate_size
= 0;
3388 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3390 * Perform a last rotation on destruction if rotations have
3391 * occurred during the session's lifetime.
3393 ret
= cmd_rotate_session(session
, NULL
, false,
3394 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3395 if (ret
!= LTTNG_OK
) {
3396 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3397 session
->name
, lttng_strerror(-ret
));
3398 destruction_last_error
= -ret
;
3400 if (reply_context
) {
3401 reply_context
->implicit_rotation_on_destroy
= true;
3403 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3405 * The user has not triggered a session rotation. However, to
3406 * ensure all data has been consumed, the session is rotated
3407 * to a 'null' trace chunk before it is destroyed.
3409 * This is a "quiet" rotation meaning that no notification is
3410 * emitted and no renaming of the current trace chunk takes
3413 ret
= cmd_rotate_session(session
, NULL
, true,
3414 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3416 * Rotation operations may not be supported by the kernel
3417 * tracer. Hence, do not consider this implicit rotation as
3418 * a session destruction error. The library has already stopped
3419 * the session and waited for pending data; there is nothing
3420 * left to do but complete the destruction of the session.
3422 if (ret
!= LTTNG_OK
&&
3423 ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3424 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3425 session
->name
, lttng_strerror(ret
));
3426 destruction_last_error
= -ret
;
3430 if (session
->shm_path
[0]) {
3432 * When a session is created with an explicit shm_path,
3433 * the consumer daemon will create its shared memory files
3434 * at that location and will *not* unlink them. This is normal
3435 * as the intention of that feature is to make it possible
3436 * to retrieve the content of those files should a crash occur.
3438 * To ensure the content of those files can be used, the
3439 * sessiond daemon will replicate the content of the metadata
3440 * cache in a metadata file.
3442 * On clean-up, it is expected that the consumer daemon will
3443 * unlink the shared memory files and that the session daemon
3444 * will unlink the metadata file. Then, the session's directory
3445 * in the shm path can be removed.
3447 * Unfortunately, a flaw in the design of the sessiond's and
3448 * consumerd's tear down of channels makes it impossible to
3449 * determine when the sessiond _and_ the consumerd have both
3450 * destroyed their representation of a channel. For one, the
3451 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3452 * callbacks in both daemons.
3454 * However, it is also impossible for the sessiond to know when
3455 * the consumer daemon is done destroying its channel(s) since
3456 * it occurs as a reaction to the closing of the channel's file
3457 * descriptor. There is no resulting communication initiated
3458 * from the consumerd to the sessiond to confirm that the
3459 * operation is completed (and was successful).
3461 * Until this is all fixed, the session daemon checks for the
3462 * removal of the session's shm path which makes it possible
3463 * to safely advertise a session as having been destroyed.
3465 * Prior to this fix, it was not possible to reliably save
3466 * a session making use of the --shm-path option, destroy it,
3467 * and load it again. This is because the creation of the
3468 * session would fail upon seeing the session's shm path
3469 * already in existence.
3471 * Note that none of the error paths in the check for the
3472 * directory's existence return an error. This is normal
3473 * as there isn't much that can be done. The session will
3474 * be destroyed properly, except that we can't offer the
3475 * guarantee that the same session can be re-created.
3477 current_completion_handler
= &destroy_completion_handler
.handler
;
3478 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3480 sizeof(destroy_completion_handler
.shm_path
));
3485 * The session is destroyed. However, note that the command context
3486 * still holds a reference to the session, thus delaying its destruction
3487 * _at least_ up to the point when that reference is released.
3489 session_destroy(session
);
3490 if (reply_context
) {
3491 reply_context
->destruction_status
= destruction_last_error
;
3492 ret
= session_add_destroy_notifier(session
,
3493 cmd_destroy_session_reply
,
3494 (void *) reply_context
);
3496 ret
= LTTNG_ERR_FATAL
;
3508 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3510 int cmd_register_consumer(struct ltt_session
*session
,
3511 enum lttng_domain_type domain
, const char *sock_path
,
3512 struct consumer_data
*cdata
)
3515 struct consumer_socket
*socket
= NULL
;
3522 case LTTNG_DOMAIN_KERNEL
:
3524 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3528 /* Can't register a consumer if there is already one */
3529 if (ksess
->consumer_fds_sent
!= 0) {
3530 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3534 sock
= lttcomm_connect_unix_sock(sock_path
);
3536 ret
= LTTNG_ERR_CONNECT_FAIL
;
3539 cdata
->cmd_sock
= sock
;
3541 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3542 if (socket
== NULL
) {
3545 PERROR("close register consumer");
3547 cdata
->cmd_sock
= -1;
3548 ret
= LTTNG_ERR_FATAL
;
3552 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3553 if (socket
->lock
== NULL
) {
3554 PERROR("zmalloc pthread mutex");
3555 ret
= LTTNG_ERR_FATAL
;
3558 pthread_mutex_init(socket
->lock
, NULL
);
3559 socket
->registered
= 1;
3562 consumer_add_socket(socket
, ksess
->consumer
);
3565 pthread_mutex_lock(&cdata
->pid_mutex
);
3567 pthread_mutex_unlock(&cdata
->pid_mutex
);
3572 /* TODO: Userspace tracing */
3573 ret
= LTTNG_ERR_UND
;
3581 consumer_destroy_socket(socket
);
3587 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3589 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3590 struct lttng_domain
**domains
)
3595 struct lttng_ht_iter iter
;
3597 if (session
->kernel_session
!= NULL
) {
3598 DBG3("Listing domains found kernel domain");
3602 if (session
->ust_session
!= NULL
) {
3603 DBG3("Listing domains found UST global domain");
3607 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3609 if (agt
->being_used
) {
3620 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3621 if (*domains
== NULL
) {
3622 ret
= LTTNG_ERR_FATAL
;
3626 if (session
->kernel_session
!= NULL
) {
3627 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3629 /* Kernel session buffer type is always GLOBAL */
3630 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3635 if (session
->ust_session
!= NULL
) {
3636 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3637 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3641 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3643 if (agt
->being_used
) {
3644 (*domains
)[index
].type
= agt
->domain
;
3645 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3655 /* Return negative value to differentiate return code */
3661 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3663 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3664 struct ltt_session
*session
, struct lttng_channel
**channels
)
3666 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3669 case LTTNG_DOMAIN_KERNEL
:
3670 if (session
->kernel_session
!= NULL
) {
3671 nb_chan
= session
->kernel_session
->channel_count
;
3673 DBG3("Number of kernel channels %zd", nb_chan
);
3675 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3679 case LTTNG_DOMAIN_UST
:
3680 if (session
->ust_session
!= NULL
) {
3682 nb_chan
= lttng_ht_get_count(
3683 session
->ust_session
->domain_global
.channels
);
3686 DBG3("Number of UST global channels %zd", nb_chan
);
3688 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3693 ret
= -LTTNG_ERR_UND
;
3698 const size_t channel_size
= sizeof(struct lttng_channel
) +
3699 sizeof(struct lttng_channel_extended
);
3700 struct lttng_channel_extended
*channel_exts
;
3702 payload_size
= nb_chan
* channel_size
;
3703 *channels
= zmalloc(payload_size
);
3704 if (*channels
== NULL
) {
3705 ret
= -LTTNG_ERR_FATAL
;
3709 channel_exts
= ((void *) *channels
) +
3710 (nb_chan
* sizeof(struct lttng_channel
));
3711 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3712 if (ret
!= LTTNG_OK
) {
3727 * Command LTTNG_LIST_EVENTS processed by the client thread.
3729 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3730 struct ltt_session
*session
, char *channel_name
,
3731 struct lttng_event
**events
, size_t *total_size
)
3734 ssize_t nb_event
= 0;
3737 case LTTNG_DOMAIN_KERNEL
:
3738 if (session
->kernel_session
!= NULL
) {
3739 nb_event
= list_lttng_kernel_events(channel_name
,
3740 session
->kernel_session
, events
,
3744 case LTTNG_DOMAIN_UST
:
3746 if (session
->ust_session
!= NULL
) {
3747 nb_event
= list_lttng_ust_global_events(channel_name
,
3748 &session
->ust_session
->domain_global
, events
,
3753 case LTTNG_DOMAIN_LOG4J
:
3754 case LTTNG_DOMAIN_JUL
:
3755 case LTTNG_DOMAIN_PYTHON
:
3756 if (session
->ust_session
) {
3757 struct lttng_ht_iter iter
;
3761 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3762 &iter
.iter
, agt
, node
.node
) {
3763 if (agt
->domain
== domain
) {
3764 nb_event
= list_lttng_agent_events(
3774 ret
= LTTNG_ERR_UND
;
3781 /* Return negative value to differentiate return code */
3786 * Using the session list, filled a lttng_session array to send back to the
3787 * client for session listing.
3789 * The session list lock MUST be acquired before calling this function. Use
3790 * session_lock_list() and session_unlock_list().
3792 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3793 size_t session_count
, uid_t uid
, gid_t gid
)
3797 struct ltt_session
*session
;
3798 struct ltt_session_list
*list
= session_get_list();
3799 struct lttng_session_extended
*extended
=
3800 (typeof(extended
)) (&sessions
[session_count
]);
3802 DBG("Getting all available session for UID %d GID %d",
3805 * Iterate over session list and append data after the control struct in
3808 cds_list_for_each_entry(session
, &list
->head
, list
) {
3809 if (!session_get(session
)) {
3813 * Only list the sessions the user can control.
3815 if (!session_access_ok(session
, uid
, gid
) ||
3816 session
->destroyed
) {
3817 session_put(session
);
3821 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3822 struct ltt_ust_session
*usess
= session
->ust_session
;
3824 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3825 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3826 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3827 ret
= build_network_session_path(sessions
[i
].path
,
3828 sizeof(sessions
[i
].path
), session
);
3830 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3831 session
->consumer
->dst
.session_root_path
);
3834 PERROR("snprintf session path");
3835 session_put(session
);
3839 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3840 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3841 sessions
[i
].enabled
= session
->active
;
3842 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3843 sessions
[i
].live_timer_interval
= session
->live_timer
;
3844 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3845 extended
[i
].creation_time
.is_set
= 1;
3847 session_put(session
);
3852 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3853 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3855 int cmd_data_pending(struct ltt_session
*session
)
3858 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3859 struct ltt_ust_session
*usess
= session
->ust_session
;
3863 DBG("Data pending for session %s", session
->name
);
3865 /* Session MUST be stopped to ask for data availability. */
3866 if (session
->active
) {
3867 ret
= LTTNG_ERR_SESSION_STARTED
;
3871 * If stopped, just make sure we've started before else the above call
3872 * will always send that there is data pending.
3874 * The consumer assumes that when the data pending command is received,
3875 * the trace has been started before or else no output data is written
3876 * by the streams which is a condition for data pending. So, this is
3877 * *VERY* important that we don't ask the consumer before a start
3880 if (!session
->has_been_started
) {
3886 /* A rotation is still pending, we have to wait. */
3887 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3888 DBG("Rotate still pending for session %s", session
->name
);
3893 if (ksess
&& ksess
->consumer
) {
3894 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3896 /* Data is still being extracted for the kernel. */
3901 if (usess
&& usess
->consumer
) {
3902 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3904 /* Data is still being extracted for the kernel. */
3909 /* Data is ready to be read by a viewer */
3917 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3919 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3921 int cmd_snapshot_add_output(struct ltt_session
*session
,
3922 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3925 struct snapshot_output
*new_output
;
3930 DBG("Cmd snapshot add output for session %s", session
->name
);
3933 * Can't create an output if the session is not set in no-output mode.
3935 if (session
->output_traces
) {
3936 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3940 if (session
->has_non_mmap_channel
) {
3941 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3945 /* Only one output is allowed until we have the "tee" feature. */
3946 if (session
->snapshot
.nb_output
== 1) {
3947 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3951 new_output
= snapshot_output_alloc();
3953 ret
= LTTNG_ERR_NOMEM
;
3957 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3958 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3959 &session
->snapshot
);
3961 if (ret
== -ENOMEM
) {
3962 ret
= LTTNG_ERR_NOMEM
;
3964 ret
= LTTNG_ERR_INVALID
;
3970 snapshot_add_output(&session
->snapshot
, new_output
);
3972 *id
= new_output
->id
;
3979 snapshot_output_destroy(new_output
);
3985 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3987 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3989 int cmd_snapshot_del_output(struct ltt_session
*session
,
3990 const struct lttng_snapshot_output
*output
)
3993 struct snapshot_output
*sout
= NULL
;
4001 * Permission denied to create an output if the session is not
4002 * set in no output mode.
4004 if (session
->output_traces
) {
4005 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4010 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
4012 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4013 } else if (*output
->name
!= '\0') {
4014 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
4016 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4019 ret
= LTTNG_ERR_INVALID
;
4023 snapshot_delete_output(&session
->snapshot
, sout
);
4024 snapshot_output_destroy(sout
);
4033 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4035 * If no output is available, outputs is untouched and 0 is returned.
4037 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4039 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4040 struct lttng_snapshot_output
**outputs
)
4043 struct lttng_snapshot_output
*list
= NULL
;
4044 struct lttng_ht_iter iter
;
4045 struct snapshot_output
*output
;
4050 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4053 * Permission denied to create an output if the session is not
4054 * set in no output mode.
4056 if (session
->output_traces
) {
4057 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4061 if (session
->snapshot
.nb_output
== 0) {
4066 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4068 ret
= -LTTNG_ERR_NOMEM
;
4072 /* Copy list from session to the new list object. */
4074 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4075 output
, node
.node
) {
4076 assert(output
->consumer
);
4077 list
[idx
].id
= output
->id
;
4078 list
[idx
].max_size
= output
->max_size
;
4079 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4080 sizeof(list
[idx
].name
))) {
4081 ret
= -LTTNG_ERR_INVALID
;
4084 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4085 if (lttng_strncpy(list
[idx
].ctrl_url
,
4086 output
->consumer
->dst
.session_root_path
,
4087 sizeof(list
[idx
].ctrl_url
))) {
4088 ret
= -LTTNG_ERR_INVALID
;
4093 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4094 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4096 ret
= -LTTNG_ERR_NOMEM
;
4101 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4102 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4104 ret
= -LTTNG_ERR_NOMEM
;
4113 ret
= session
->snapshot
.nb_output
;
4122 * Check if we can regenerate the metadata for this session.
4123 * Only kernel, UST per-uid and non-live sessions are supported.
4125 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4128 int check_regenerate_metadata_support(struct ltt_session
*session
)
4134 if (session
->live_timer
!= 0) {
4135 ret
= LTTNG_ERR_LIVE_SESSION
;
4138 if (!session
->active
) {
4139 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4142 if (session
->ust_session
) {
4143 switch (session
->ust_session
->buffer_type
) {
4144 case LTTNG_BUFFER_PER_UID
:
4146 case LTTNG_BUFFER_PER_PID
:
4147 ret
= LTTNG_ERR_PER_PID_SESSION
;
4151 ret
= LTTNG_ERR_UNK
;
4155 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4156 session
->consumer
->relay_minor_version
< 8) {
4157 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4167 int clear_metadata_file(int fd
)
4172 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4173 if (lseek_ret
< 0) {
4179 ret
= ftruncate(fd
, 0);
4181 PERROR("ftruncate");
4190 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4193 struct buffer_reg_uid
*uid_reg
= NULL
;
4194 struct buffer_reg_session
*session_reg
= NULL
;
4197 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4198 struct ust_registry_session
*registry
;
4199 struct ust_registry_channel
*chan
;
4200 struct lttng_ht_iter iter_chan
;
4202 session_reg
= uid_reg
->registry
;
4203 registry
= session_reg
->reg
.ust
;
4205 pthread_mutex_lock(®istry
->lock
);
4206 registry
->metadata_len_sent
= 0;
4207 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4208 registry
->metadata_len
= 0;
4209 registry
->metadata_version
++;
4210 if (registry
->metadata_fd
> 0) {
4211 /* Clear the metadata file's content. */
4212 ret
= clear_metadata_file(registry
->metadata_fd
);
4214 pthread_mutex_unlock(®istry
->lock
);
4219 ret
= ust_metadata_session_statedump(registry
, NULL
,
4220 registry
->major
, registry
->minor
);
4222 pthread_mutex_unlock(®istry
->lock
);
4223 ERR("Failed to generate session metadata (err = %d)",
4227 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4229 struct ust_registry_event
*event
;
4230 struct lttng_ht_iter iter_event
;
4232 ret
= ust_metadata_channel_statedump(registry
, chan
);
4234 pthread_mutex_unlock(®istry
->lock
);
4235 ERR("Failed to generate channel metadata "
4239 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4241 ret
= ust_metadata_event_statedump(registry
,
4244 pthread_mutex_unlock(®istry
->lock
);
4245 ERR("Failed to generate event metadata "
4251 pthread_mutex_unlock(®istry
->lock
);
4260 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4262 * Ask the consumer to truncate the existing metadata file(s) and
4263 * then regenerate the metadata. Live and per-pid sessions are not
4264 * supported and return an error.
4266 * Return 0 on success or else a LTTNG_ERR code.
4268 int cmd_regenerate_metadata(struct ltt_session
*session
)
4274 ret
= check_regenerate_metadata_support(session
);
4279 if (session
->kernel_session
) {
4280 ret
= kernctl_session_regenerate_metadata(
4281 session
->kernel_session
->fd
);
4283 ERR("Failed to regenerate the kernel metadata");
4288 if (session
->ust_session
) {
4289 ret
= ust_regenerate_metadata(session
->ust_session
);
4291 ERR("Failed to regenerate the UST metadata");
4295 DBG("Cmd metadata regenerate for session %s", session
->name
);
4303 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4305 * Ask the tracer to regenerate a new statedump.
4307 * Return 0 on success or else a LTTNG_ERR code.
4309 int cmd_regenerate_statedump(struct ltt_session
*session
)
4315 if (!session
->active
) {
4316 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4320 if (session
->kernel_session
) {
4321 ret
= kernctl_session_regenerate_statedump(
4322 session
->kernel_session
->fd
);
4324 * Currently, the statedump in kernel can only fail if out
4328 if (ret
== -ENOMEM
) {
4329 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4331 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4333 ERR("Failed to regenerate the kernel statedump");
4338 if (session
->ust_session
) {
4339 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4341 * Currently, the statedump in UST always returns 0.
4344 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4345 ERR("Failed to regenerate the UST statedump");
4349 DBG("Cmd regenerate statedump for session %s", session
->name
);
4356 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4357 struct notification_thread_handle
*notification_thread
)
4361 ssize_t sock_recv_len
;
4362 struct lttng_trigger
*trigger
= NULL
;
4363 struct lttng_buffer_view view
;
4364 struct lttng_dynamic_buffer trigger_buffer
;
4366 lttng_dynamic_buffer_init(&trigger_buffer
);
4367 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4368 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4370 ret
= LTTNG_ERR_NOMEM
;
4374 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4376 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4377 ERR("Failed to receive \"register trigger\" command payload");
4378 /* TODO: should this be a new error enum ? */
4379 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4383 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4384 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4386 ERR("Invalid trigger payload received in \"register trigger\" command");
4387 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4391 ret
= notification_thread_command_register_trigger(notification_thread
,
4393 /* Ownership of trigger was transferred. */
4396 lttng_trigger_destroy(trigger
);
4397 lttng_dynamic_buffer_reset(&trigger_buffer
);
4401 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4402 struct notification_thread_handle
*notification_thread
)
4406 ssize_t sock_recv_len
;
4407 struct lttng_trigger
*trigger
= NULL
;
4408 struct lttng_buffer_view view
;
4409 struct lttng_dynamic_buffer trigger_buffer
;
4411 lttng_dynamic_buffer_init(&trigger_buffer
);
4412 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4413 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4415 ret
= LTTNG_ERR_NOMEM
;
4419 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4421 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4422 ERR("Failed to receive \"unregister trigger\" command payload");
4423 /* TODO: should this be a new error enum ? */
4424 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4428 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4429 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4431 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4432 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4436 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4439 lttng_trigger_destroy(trigger
);
4440 lttng_dynamic_buffer_reset(&trigger_buffer
);
4445 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4446 * snapshot output is *not* set with a remote destination.
4448 * Return LTTNG_OK on success or a LTTNG_ERR code.
4450 static enum lttng_error_code
set_relayd_for_snapshot(
4451 struct consumer_output
*output
,
4452 const struct ltt_session
*session
)
4454 enum lttng_error_code status
= LTTNG_OK
;
4455 struct lttng_ht_iter iter
;
4456 struct consumer_socket
*socket
;
4457 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4458 const char *base_path
;
4463 DBG2("Set relayd object from snapshot output");
4465 if (session
->current_trace_chunk
) {
4466 enum lttng_trace_chunk_status chunk_status
=
4467 lttng_trace_chunk_get_id(
4468 session
->current_trace_chunk
,
4469 ¤t_chunk_id
.value
);
4471 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4472 current_chunk_id
.is_set
= true;
4474 ERR("Failed to get current trace chunk id");
4475 status
= LTTNG_ERR_UNK
;
4480 /* Ignore if snapshot consumer output is not network. */
4481 if (output
->type
!= CONSUMER_DST_NET
) {
4486 * The snapshot record URI base path overrides the session
4489 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4490 base_path
= output
->dst
.net
.control
.subdir
;
4492 base_path
= session
->base_path
;
4496 * For each consumer socket, create and send the relayd object of the
4500 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4501 socket
, node
.node
) {
4502 pthread_mutex_lock(socket
->lock
);
4503 status
= send_consumer_relayd_sockets(0, session
->id
,
4505 session
->name
, session
->hostname
,
4507 session
->live_timer
,
4508 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4509 session
->creation_time
,
4510 session
->name_contains_creation_time
);
4511 pthread_mutex_unlock(socket
->lock
);
4512 if (status
!= LTTNG_OK
) {
4524 * Record a kernel snapshot.
4526 * Return LTTNG_OK on success or a LTTNG_ERR code.
4528 static enum lttng_error_code
record_kernel_snapshot(
4529 struct ltt_kernel_session
*ksess
,
4530 const struct consumer_output
*output
,
4531 const struct ltt_session
*session
,
4532 int wait
, uint64_t nb_packets_per_stream
)
4534 enum lttng_error_code status
;
4540 status
= kernel_snapshot_record(
4541 ksess
, output
, wait
, nb_packets_per_stream
);
4546 * Record a UST snapshot.
4548 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4550 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4551 const struct consumer_output
*output
,
4552 const struct ltt_session
*session
,
4553 int wait
, uint64_t nb_packets_per_stream
)
4555 enum lttng_error_code status
;
4561 status
= ust_app_snapshot_record(
4562 usess
, output
, wait
, nb_packets_per_stream
);
4567 uint64_t get_session_size_one_more_packet_per_stream(
4568 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4570 uint64_t tot_size
= 0;
4572 if (session
->kernel_session
) {
4573 struct ltt_kernel_channel
*chan
;
4574 const struct ltt_kernel_session
*ksess
=
4575 session
->kernel_session
;
4577 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4578 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4580 * Don't take channel into account if we
4581 * already grab all its packets.
4585 tot_size
+= chan
->channel
->attr
.subbuf_size
4586 * chan
->stream_count
;
4590 if (session
->ust_session
) {
4591 const struct ltt_ust_session
*usess
= session
->ust_session
;
4593 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4601 * Calculate the number of packets we can grab from each stream that
4602 * fits within the overall snapshot max size.
4604 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4605 * the number of packets per stream.
4607 * TODO: this approach is not perfect: we consider the worse case
4608 * (packet filling the sub-buffers) as an upper bound, but we could do
4609 * better if we do this calculation while we actually grab the packet
4610 * content: we would know how much padding we don't actually store into
4613 * This algorithm is currently bounded by the number of packets per
4616 * Since we call this algorithm before actually grabbing the data, it's
4617 * an approximation: for instance, applications could appear/disappear
4618 * in between this call and actually grabbing data.
4621 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4625 uint64_t cur_nb_packets
= 0;
4628 return 0; /* Infinite */
4631 size_left
= max_size
;
4633 uint64_t one_more_packet_tot_size
;
4635 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4636 session
, cur_nb_packets
);
4637 if (!one_more_packet_tot_size
) {
4638 /* We are already grabbing all packets. */
4641 size_left
-= one_more_packet_tot_size
;
4642 if (size_left
< 0) {
4647 if (!cur_nb_packets
&& size_left
!= max_size
) {
4648 /* Not enough room to grab one packet of each stream, error. */
4651 return cur_nb_packets
;
4655 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4656 const struct snapshot_output
*snapshot_output
, int wait
)
4658 int64_t nb_packets_per_stream
;
4659 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4661 enum lttng_error_code ret_code
= LTTNG_OK
;
4662 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4663 struct consumer_output
*original_ust_consumer_output
= NULL
;
4664 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4665 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4666 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4668 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4670 snapshot_output
->name
,
4671 snapshot_output
->datetime
,
4672 snapshot_output
->nb_snapshot
);
4673 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4674 ERR("Failed to format snapshot name");
4675 ret_code
= LTTNG_ERR_INVALID
;
4678 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4679 snapshot_output
->name
, session
->name
,
4680 snapshot_chunk_name
);
4681 if (!session
->kernel_session
&& !session
->ust_session
) {
4682 ERR("Failed to record snapshot as no channels exist");
4683 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4687 if (session
->kernel_session
) {
4688 original_kernel_consumer_output
=
4689 session
->kernel_session
->consumer
;
4690 snapshot_kernel_consumer_output
=
4691 consumer_copy_output(snapshot_output
->consumer
);
4692 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4693 snapshot_chunk_name
);
4694 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4695 original_kernel_consumer_output
);
4697 ERR("Failed to copy consumer sockets from snapshot output configuration");
4698 ret_code
= LTTNG_ERR_NOMEM
;
4701 ret_code
= set_relayd_for_snapshot(
4702 snapshot_kernel_consumer_output
, session
);
4703 if (ret_code
!= LTTNG_OK
) {
4704 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4707 session
->kernel_session
->consumer
=
4708 snapshot_kernel_consumer_output
;
4710 if (session
->ust_session
) {
4711 original_ust_consumer_output
= session
->ust_session
->consumer
;
4712 snapshot_ust_consumer_output
=
4713 consumer_copy_output(snapshot_output
->consumer
);
4714 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4715 snapshot_chunk_name
);
4716 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4717 original_ust_consumer_output
);
4719 ERR("Failed to copy consumer sockets from snapshot output configuration");
4720 ret_code
= LTTNG_ERR_NOMEM
;
4723 ret_code
= set_relayd_for_snapshot(
4724 snapshot_ust_consumer_output
, session
);
4725 if (ret_code
!= LTTNG_OK
) {
4726 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4729 session
->ust_session
->consumer
=
4730 snapshot_ust_consumer_output
;
4733 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4734 snapshot_kernel_consumer_output
?:
4735 snapshot_ust_consumer_output
,
4736 consumer_output_get_base_path(
4737 snapshot_output
->consumer
),
4738 snapshot_chunk_name
);
4739 if (!snapshot_trace_chunk
) {
4740 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4742 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4745 assert(!session
->current_trace_chunk
);
4746 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4747 lttng_trace_chunk_put(snapshot_trace_chunk
);
4748 snapshot_trace_chunk
= NULL
;
4750 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4752 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4756 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4757 snapshot_output
->max_size
);
4758 if (nb_packets_per_stream
< 0) {
4759 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4760 goto error_close_trace_chunk
;
4763 if (session
->kernel_session
) {
4764 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4765 snapshot_kernel_consumer_output
, session
,
4766 wait
, nb_packets_per_stream
);
4767 if (ret_code
!= LTTNG_OK
) {
4768 goto error_close_trace_chunk
;
4772 if (session
->ust_session
) {
4773 ret_code
= record_ust_snapshot(session
->ust_session
,
4774 snapshot_ust_consumer_output
, session
,
4775 wait
, nb_packets_per_stream
);
4776 if (ret_code
!= LTTNG_OK
) {
4777 goto error_close_trace_chunk
;
4781 error_close_trace_chunk
:
4782 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
4783 ERR("Failed to release the current trace chunk of session \"%s\"",
4785 ret_code
= LTTNG_ERR_UNK
;
4788 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
4789 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
4791 * Don't goto end; make sure the chunk is closed for the session
4792 * to allow future snapshots.
4794 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4796 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4799 if (original_ust_consumer_output
) {
4800 session
->ust_session
->consumer
= original_ust_consumer_output
;
4802 if (original_kernel_consumer_output
) {
4803 session
->kernel_session
->consumer
=
4804 original_kernel_consumer_output
;
4806 consumer_output_put(snapshot_ust_consumer_output
);
4807 consumer_output_put(snapshot_kernel_consumer_output
);
4812 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4814 * The wait parameter is ignored so this call always wait for the snapshot to
4815 * complete before returning.
4817 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4819 int cmd_snapshot_record(struct ltt_session
*session
,
4820 const struct lttng_snapshot_output
*output
, int wait
)
4822 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4824 unsigned int snapshot_success
= 0;
4826 struct snapshot_output
*tmp_output
= NULL
;
4831 DBG("Cmd snapshot record for session %s", session
->name
);
4833 /* Get the datetime for the snapshot output directory. */
4834 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4837 cmd_ret
= LTTNG_ERR_INVALID
;
4842 * Permission denied to create an output if the session is not
4843 * set in no output mode.
4845 if (session
->output_traces
) {
4846 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4850 /* The session needs to be started at least once. */
4851 if (!session
->has_been_started
) {
4852 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4856 /* Use temporary output for the session. */
4857 if (*output
->ctrl_url
!= '\0') {
4858 tmp_output
= snapshot_output_alloc();
4860 cmd_ret
= LTTNG_ERR_NOMEM
;
4864 ret
= snapshot_output_init(session
, output
->max_size
,
4866 output
->ctrl_url
, output
->data_url
,
4870 if (ret
== -ENOMEM
) {
4871 cmd_ret
= LTTNG_ERR_NOMEM
;
4873 cmd_ret
= LTTNG_ERR_INVALID
;
4877 /* Use the global session count for the temporary snapshot. */
4878 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4880 /* Use the global datetime */
4881 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4882 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4883 if (cmd_ret
!= LTTNG_OK
) {
4886 snapshot_success
= 1;
4888 struct snapshot_output
*sout
;
4889 struct lttng_ht_iter iter
;
4892 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4893 &iter
.iter
, sout
, node
.node
) {
4894 struct snapshot_output output_copy
;
4897 * Make a local copy of the output and override output
4898 * parameters with those provided as part of the
4901 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4903 if (output
->max_size
!= (uint64_t) -1ULL) {
4904 output_copy
.max_size
= output
->max_size
;
4907 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4908 memcpy(output_copy
.datetime
, datetime
,
4911 /* Use temporary name. */
4912 if (*output
->name
!= '\0') {
4913 if (lttng_strncpy(output_copy
.name
,
4915 sizeof(output_copy
.name
))) {
4916 cmd_ret
= LTTNG_ERR_INVALID
;
4922 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4923 if (cmd_ret
!= LTTNG_OK
) {
4927 snapshot_success
= 1;
4932 if (snapshot_success
) {
4933 session
->snapshot
.nb_snapshot
++;
4935 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4940 snapshot_output_destroy(tmp_output
);
4946 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4948 int cmd_set_session_shm_path(struct ltt_session
*session
,
4949 const char *shm_path
)
4955 * Can only set shm path before session is started.
4957 if (session
->has_been_started
) {
4958 return LTTNG_ERR_SESSION_STARTED
;
4961 strncpy(session
->shm_path
, shm_path
,
4962 sizeof(session
->shm_path
));
4963 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4969 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4971 * Ask the consumer to rotate the session output directory.
4972 * The session lock must be held.
4974 * Returns LTTNG_OK on success or else a negative LTTng error code.
4976 int cmd_rotate_session(struct ltt_session
*session
,
4977 struct lttng_rotate_session_return
*rotate_return
,
4978 bool quiet_rotation
,
4979 enum lttng_trace_chunk_command_type command
)
4982 uint64_t ongoing_rotation_chunk_id
;
4983 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4984 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
4985 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
4986 enum lttng_trace_chunk_status chunk_status
;
4987 bool failed_to_rotate
= false;
4988 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
4992 if (!session
->has_been_started
) {
4993 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4998 * Explicit rotation is not supported for live sessions.
4999 * However, live sessions can perform a quiet rotation on
5001 * Rotation is not supported for snapshot traces (no output).
5003 if ((!quiet_rotation
&& session
->live_timer
) ||
5004 !session
->output_traces
) {
5005 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5009 /* Unsupported feature in lttng-relayd before 2.11. */
5010 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5011 (session
->consumer
->relay_major_version
== 2 &&
5012 session
->consumer
->relay_minor_version
< 11)) {
5013 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5017 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5018 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5019 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5023 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5024 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5026 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5031 * After a stop, we only allow one rotation to occur, the other ones are
5032 * useless until a new start.
5034 if (session
->rotated_after_last_stop
) {
5035 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5037 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5042 * After a stop followed by a clear, disallow following rotations a they would
5043 * generate empty chunks.
5045 if (session
->cleared_after_last_stop
) {
5046 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5048 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5052 if (session
->active
) {
5053 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
5055 if (!new_trace_chunk
) {
5056 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5062 * The current trace chunk becomes the chunk being archived.
5064 * After this point, "chunk_being_archived" must absolutely
5065 * be closed on the consumer(s), otherwise it will never be
5066 * cleaned-up, which will result in a leak.
5068 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5069 &chunk_being_archived
);
5071 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5075 if (session
->kernel_session
) {
5076 cmd_ret
= kernel_rotate_session(session
);
5077 if (cmd_ret
!= LTTNG_OK
) {
5078 failed_to_rotate
= true;
5079 rotation_fail_code
= cmd_ret
;
5082 if (session
->ust_session
) {
5083 cmd_ret
= ust_app_rotate_session(session
);
5084 if (cmd_ret
!= LTTNG_OK
) {
5085 failed_to_rotate
= true;
5086 rotation_fail_code
= cmd_ret
;
5090 if (!session
->active
) {
5091 session
->rotated_after_last_stop
= true;
5094 if (!chunk_being_archived
) {
5095 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5097 if (failed_to_rotate
) {
5098 cmd_ret
= rotation_fail_code
;
5105 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5106 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5107 &ongoing_rotation_chunk_id
);
5108 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5110 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5111 command
, session
->last_chunk_path
);
5113 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5117 if (failed_to_rotate
) {
5118 cmd_ret
= rotation_fail_code
;
5122 session
->quiet_rotation
= quiet_rotation
;
5123 ret
= timer_session_rotation_pending_check_start(session
,
5124 DEFAULT_ROTATE_PENDING_TIMER
);
5126 cmd_ret
= LTTNG_ERR_UNK
;
5130 if (rotate_return
) {
5131 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5134 session
->chunk_being_archived
= chunk_being_archived
;
5135 chunk_being_archived
= NULL
;
5136 if (!quiet_rotation
) {
5137 ret
= notification_thread_command_session_rotation_ongoing(
5138 notification_thread_handle
,
5139 session
->name
, session
->uid
, session
->gid
,
5140 ongoing_rotation_chunk_id
);
5141 if (ret
!= LTTNG_OK
) {
5142 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5148 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5149 session
->name
, ongoing_rotation_chunk_id
);
5151 lttng_trace_chunk_put(new_trace_chunk
);
5152 lttng_trace_chunk_put(chunk_being_archived
);
5153 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5156 if (session_reset_rotation_state(session
,
5157 LTTNG_ROTATION_STATE_ERROR
)) {
5158 ERR("Failed to reset rotation state of session \"%s\"",
5165 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5167 * Check if the session has finished its rotation.
5169 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5171 int cmd_rotate_get_info(struct ltt_session
*session
,
5172 struct lttng_rotation_get_info_return
*info_return
,
5173 uint64_t rotation_id
)
5175 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5176 enum lttng_rotation_state rotation_state
;
5178 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5179 session
->most_recent_chunk_id
.value
);
5181 if (session
->chunk_being_archived
) {
5182 enum lttng_trace_chunk_status chunk_status
;
5185 chunk_status
= lttng_trace_chunk_get_id(
5186 session
->chunk_being_archived
,
5188 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5190 rotation_state
= rotation_id
== chunk_id
?
5191 LTTNG_ROTATION_STATE_ONGOING
:
5192 LTTNG_ROTATION_STATE_EXPIRED
;
5194 if (session
->last_archived_chunk_id
.is_set
&&
5195 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5196 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5198 rotation_state
= session
->rotation_state
;
5202 switch (rotation_state
) {
5203 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5204 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5207 case LTTNG_ROTATION_STATE_EXPIRED
:
5208 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5209 rotation_id
, session
->name
);
5211 case LTTNG_ROTATION_STATE_ONGOING
:
5212 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5213 rotation_id
, session
->name
);
5215 case LTTNG_ROTATION_STATE_COMPLETED
:
5219 char *current_tracing_path_reply
;
5220 size_t current_tracing_path_reply_len
;
5222 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5223 rotation_id
, session
->name
);
5225 switch (session_get_consumer_destination_type(session
)) {
5226 case CONSUMER_DST_LOCAL
:
5227 current_tracing_path_reply
=
5228 info_return
->location
.local
.absolute_path
;
5229 current_tracing_path_reply_len
=
5230 sizeof(info_return
->location
.local
.absolute_path
);
5231 info_return
->location_type
=
5232 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5233 fmt_ret
= asprintf(&chunk_path
,
5234 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5235 session_get_base_path(session
),
5236 session
->last_archived_chunk_name
);
5237 if (fmt_ret
== -1) {
5238 PERROR("Failed to format the path of the last archived trace chunk");
5239 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5240 cmd_ret
= LTTNG_ERR_UNK
;
5244 case CONSUMER_DST_NET
:
5246 uint16_t ctrl_port
, data_port
;
5248 current_tracing_path_reply
=
5249 info_return
->location
.relay
.relative_path
;
5250 current_tracing_path_reply_len
=
5251 sizeof(info_return
->location
.relay
.relative_path
);
5252 /* Currently the only supported relay protocol. */
5253 info_return
->location
.relay
.protocol
=
5254 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5256 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5257 session_get_net_consumer_hostname(session
),
5258 sizeof(info_return
->location
.relay
.host
));
5260 ERR("Failed to copy host name to rotate_get_info reply");
5261 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5262 cmd_ret
= LTTNG_ERR_SET_URL
;
5266 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5267 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5268 info_return
->location
.relay
.ports
.data
= data_port
;
5269 info_return
->location_type
=
5270 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5271 chunk_path
= strdup(session
->last_chunk_path
);
5273 ERR("Failed to allocate the path of the last archived trace chunk");
5274 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5275 cmd_ret
= LTTNG_ERR_UNK
;
5284 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5285 chunk_path
, current_tracing_path_reply_len
);
5288 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5289 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5290 cmd_ret
= LTTNG_ERR_UNK
;
5296 case LTTNG_ROTATION_STATE_ERROR
:
5297 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5298 rotation_id
, session
->name
);
5306 info_return
->status
= (int32_t) rotation_state
;
5311 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5313 * Configure the automatic rotation parameters.
5314 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5315 * 'activate' to false means deactivate the rotation schedule and validate that
5316 * 'new_value' has the same value as the currently active value.
5318 * Return 0 on success or else a positive LTTNG_ERR code.
5320 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5321 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5323 struct notification_thread_handle
*notification_thread_handle
)
5326 uint64_t *parameter_value
;
5330 DBG("Cmd rotate set schedule session %s", session
->name
);
5332 if (session
->live_timer
|| !session
->output_traces
) {
5333 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5334 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5338 switch (schedule_type
) {
5339 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5340 parameter_value
= &session
->rotate_size
;
5342 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5343 parameter_value
= &session
->rotate_timer_period
;
5344 if (new_value
>= UINT_MAX
) {
5345 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5346 new_value
, UINT_MAX
);
5347 ret
= LTTNG_ERR_INVALID
;
5352 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5353 ret
= LTTNG_ERR_INVALID
;
5357 /* Improper use of the API. */
5358 if (new_value
== -1ULL) {
5359 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5360 ret
= LTTNG_ERR_INVALID
;
5365 * As indicated in struct ltt_session's comments, a value of == 0 means
5366 * this schedule rotation type is not in use.
5368 * Reject the command if we were asked to activate a schedule that was
5371 if (activate
&& *parameter_value
!= 0) {
5372 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5373 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5378 * Reject the command if we were asked to deactivate a schedule that was
5381 if (!activate
&& *parameter_value
== 0) {
5382 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5383 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5388 * Reject the command if we were asked to deactivate a schedule that
5391 if (!activate
&& *parameter_value
!= new_value
) {
5392 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5393 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5397 *parameter_value
= activate
? new_value
: 0;
5399 switch (schedule_type
) {
5400 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5401 if (activate
&& session
->active
) {
5403 * Only start the timer if the session is active,
5404 * otherwise it will be started when the session starts.
5406 ret
= timer_session_rotation_schedule_timer_start(
5407 session
, new_value
);
5409 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5410 ret
= LTTNG_ERR_UNK
;
5414 ret
= timer_session_rotation_schedule_timer_stop(
5417 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5418 ret
= LTTNG_ERR_UNK
;
5423 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5425 ret
= subscribe_session_consumed_size_rotation(session
,
5426 new_value
, notification_thread_handle
);
5428 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5429 ret
= LTTNG_ERR_UNK
;
5433 ret
= unsubscribe_session_consumed_size_rotation(session
,
5434 notification_thread_handle
);
5436 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5437 ret
= LTTNG_ERR_UNK
;
5444 /* Would have been caught before. */
5456 /* Wait for a given path to be removed before continuing. */
5457 static enum lttng_error_code
wait_on_path(void *path_data
)
5459 const char *shm_path
= path_data
;
5461 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5467 ret
= stat(shm_path
, &st
);
5469 if (errno
!= ENOENT
) {
5470 PERROR("stat() returned an error while checking for the existence of the shm path");
5472 DBG("shm path no longer exists, completing the destruction of session");
5476 if (!S_ISDIR(st
.st_mode
)) {
5477 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5482 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5488 * Returns a pointer to a handler to run on completion of a command.
5489 * Returns NULL if no handler has to be run for the last command executed.
5491 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5493 struct cmd_completion_handler
*handler
= current_completion_handler
;
5495 current_completion_handler
= NULL
;
5500 * Init command subsystem.
5505 * Set network sequence index to 1 for streams to match a relayd
5506 * socket on the consumer side.
5508 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5509 relayd_net_seq_idx
= 1;
5510 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5512 DBG("Command subsystem initialized");