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
);
519 /* Compute required extended infos size */
520 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
523 * This is only valid because the commands which add events are
524 * processed in the same thread as the listing.
526 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
527 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
530 DBG("Error computing the length of extended info message");
531 ret
= -LTTNG_ERR_FATAL
;
536 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
537 tmp_events
= zmalloc(*total_size
);
539 PERROR("zmalloc agent events session");
540 ret
= -LTTNG_ERR_FATAL
;
544 extended_at
= ((uint8_t *) tmp_events
) +
545 nb_event
* sizeof(struct lttng_event
);
547 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
548 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
549 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
550 tmp_events
[i
].enabled
= event
->enabled
;
551 tmp_events
[i
].loglevel
= event
->loglevel_value
;
552 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
555 /* Append extended info */
556 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
559 DBG("Error appending extended info message");
560 ret
= -LTTNG_ERR_FATAL
;
565 *events
= tmp_events
;
567 assert(nb_event
== i
);
578 * Create a list of ust global domain events.
580 static int list_lttng_ust_global_events(char *channel_name
,
581 struct ltt_ust_domain_global
*ust_global
,
582 struct lttng_event
**events
, size_t *total_size
)
585 unsigned int nb_event
= 0;
586 struct lttng_ht_iter iter
;
587 struct lttng_ht_node_str
*node
;
588 struct ltt_ust_channel
*uchan
;
589 struct ltt_ust_event
*uevent
;
590 struct lttng_event
*tmp
;
591 size_t extended_len
= 0;
594 DBG("Listing UST global events for channel %s", channel_name
);
598 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
599 node
= lttng_ht_iter_get_node_str(&iter
);
601 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
605 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
607 nb_event
= lttng_ht_get_count(uchan
->events
);
614 DBG3("Listing UST global %d events", nb_event
);
616 /* Compute required extended infos size */
617 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
618 if (uevent
->internal
) {
623 ret
= increment_extended_len(uevent
->filter_expression
,
624 uevent
->exclusion
, NULL
, &extended_len
);
626 DBG("Error computing the length of extended info message");
627 ret
= -LTTNG_ERR_FATAL
;
632 /* All events are internal, skip. */
638 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
639 tmp
= zmalloc(*total_size
);
641 ret
= -LTTNG_ERR_FATAL
;
645 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
647 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
648 if (uevent
->internal
) {
649 /* This event should remain hidden from clients */
652 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
653 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
654 tmp
[i
].enabled
= uevent
->enabled
;
656 switch (uevent
->attr
.instrumentation
) {
657 case LTTNG_UST_TRACEPOINT
:
658 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
660 case LTTNG_UST_PROBE
:
661 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
663 case LTTNG_UST_FUNCTION
:
664 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
668 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
669 switch (uevent
->attr
.loglevel_type
) {
670 case LTTNG_UST_LOGLEVEL_ALL
:
671 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
673 case LTTNG_UST_LOGLEVEL_RANGE
:
674 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
676 case LTTNG_UST_LOGLEVEL_SINGLE
:
677 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
680 if (uevent
->filter
) {
683 if (uevent
->exclusion
) {
684 tmp
[i
].exclusion
= 1;
688 /* Append extended info */
689 ret
= append_extended_info(uevent
->filter_expression
,
690 uevent
->exclusion
, NULL
, &extended_at
);
692 DBG("Error appending extended info message");
693 ret
= -LTTNG_ERR_FATAL
;
706 * Fill lttng_event array of all kernel events in the channel.
708 static int list_lttng_kernel_events(char *channel_name
,
709 struct ltt_kernel_session
*kernel_session
,
710 struct lttng_event
**events
, size_t *total_size
)
713 unsigned int nb_event
;
714 struct ltt_kernel_event
*event
;
715 struct ltt_kernel_channel
*kchan
;
716 size_t extended_len
= 0;
719 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
721 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
725 nb_event
= kchan
->event_count
;
727 DBG("Listing events for channel %s", kchan
->channel
->name
);
735 /* Compute required extended infos size */
736 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
737 ret
= increment_extended_len(event
->filter_expression
, NULL
,
738 event
->userspace_probe_location
,
741 DBG("Error computing the length of extended info message");
742 ret
= -LTTNG_ERR_FATAL
;
747 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
748 *events
= zmalloc(*total_size
);
749 if (*events
== NULL
) {
750 ret
= -LTTNG_ERR_FATAL
;
754 extended_at
= ((void *) *events
) +
755 nb_event
* sizeof(struct lttng_event
);
757 /* Kernel channels */
758 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
759 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
760 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
761 (*events
)[i
].enabled
= event
->enabled
;
762 (*events
)[i
].filter
=
763 (unsigned char) !!event
->filter_expression
;
765 switch (event
->event
->instrumentation
) {
766 case LTTNG_KERNEL_TRACEPOINT
:
767 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
769 case LTTNG_KERNEL_KRETPROBE
:
770 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
771 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
772 sizeof(struct lttng_kernel_kprobe
));
774 case LTTNG_KERNEL_KPROBE
:
775 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
776 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
777 sizeof(struct lttng_kernel_kprobe
));
779 case LTTNG_KERNEL_UPROBE
:
780 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
782 case LTTNG_KERNEL_FUNCTION
:
783 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
784 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
785 sizeof(struct lttng_kernel_function
));
787 case LTTNG_KERNEL_NOOP
:
788 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
790 case LTTNG_KERNEL_SYSCALL
:
791 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
793 case LTTNG_KERNEL_ALL
:
801 /* Append extended info */
802 ret
= append_extended_info(event
->filter_expression
, NULL
,
803 event
->userspace_probe_location
, &extended_at
);
805 DBG("Error appending extended info message");
806 ret
= -LTTNG_ERR_FATAL
;
819 * Add URI so the consumer output object. Set the correct path depending on the
820 * domain adding the default trace directory.
822 static enum lttng_error_code
add_uri_to_consumer(
823 const struct ltt_session
*session
,
824 struct consumer_output
*consumer
,
825 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
828 enum lttng_error_code ret_code
= LTTNG_OK
;
832 if (consumer
== NULL
) {
833 DBG("No consumer detected. Don't add URI. Stopping.");
834 ret_code
= LTTNG_ERR_NO_CONSUMER
;
839 case LTTNG_DOMAIN_KERNEL
:
840 ret
= lttng_strncpy(consumer
->domain_subdir
,
841 DEFAULT_KERNEL_TRACE_DIR
,
842 sizeof(consumer
->domain_subdir
));
844 case LTTNG_DOMAIN_UST
:
845 ret
= lttng_strncpy(consumer
->domain_subdir
,
846 DEFAULT_UST_TRACE_DIR
,
847 sizeof(consumer
->domain_subdir
));
851 * This case is possible is we try to add the URI to the global
852 * tracing session consumer object which in this case there is
855 memset(consumer
->domain_subdir
, 0,
856 sizeof(consumer
->domain_subdir
));
860 ERR("Failed to initialize consumer output domain subdirectory");
861 ret_code
= LTTNG_ERR_FATAL
;
865 switch (uri
->dtype
) {
868 DBG2("Setting network URI to consumer");
870 if (consumer
->type
== CONSUMER_DST_NET
) {
871 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
872 consumer
->dst
.net
.control_isset
) ||
873 (uri
->stype
== LTTNG_STREAM_DATA
&&
874 consumer
->dst
.net
.data_isset
)) {
875 ret_code
= LTTNG_ERR_URL_EXIST
;
879 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
882 /* Set URI into consumer output object */
883 ret
= consumer_set_network_uri(session
, consumer
, uri
);
887 } else if (ret
== 1) {
889 * URI was the same in the consumer so we do not append the subdir
890 * again so to not duplicate output dir.
897 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
898 ret_code
= LTTNG_ERR_INVALID
;
901 DBG2("Setting trace directory path from URI to %s",
903 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
905 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
907 sizeof(consumer
->dst
.session_root_path
));
909 ret_code
= LTTNG_ERR_FATAL
;
912 consumer
->type
= CONSUMER_DST_LOCAL
;
922 * Init tracing by creating trace directory and sending fds kernel consumer.
924 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
927 struct lttng_ht_iter iter
;
928 struct consumer_socket
*socket
;
934 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
935 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
937 pthread_mutex_lock(socket
->lock
);
938 ret
= kernel_consumer_send_session(socket
, session
);
939 pthread_mutex_unlock(socket
->lock
);
941 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
953 * Create a socket to the relayd using the URI.
955 * On success, the relayd_sock pointer is set to the created socket.
956 * Else, it remains untouched and an LTTng error code is returned.
958 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
959 struct lttcomm_relayd_sock
**relayd_sock
,
960 struct consumer_output
*consumer
)
963 enum lttng_error_code status
= LTTNG_OK
;
964 struct lttcomm_relayd_sock
*rsock
;
966 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
967 RELAYD_VERSION_COMM_MINOR
);
969 status
= LTTNG_ERR_FATAL
;
974 * Connect to relayd so we can proceed with a session creation. This call
975 * can possibly block for an arbitrary amount of time to set the health
976 * state to be in poll execution.
979 ret
= relayd_connect(rsock
);
982 ERR("Unable to reach lttng-relayd");
983 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
987 /* Create socket for control stream. */
988 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
989 uint64_t result_flags
;
991 DBG3("Creating relayd stream socket from URI");
993 /* Check relayd version */
994 ret
= relayd_version_check(rsock
);
995 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
996 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
998 } else if (ret
< 0) {
999 ERR("Unable to reach lttng-relayd");
1000 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1003 consumer
->relay_major_version
= rsock
->major
;
1004 consumer
->relay_minor_version
= rsock
->minor
;
1005 ret
= relayd_get_configuration(rsock
, 0,
1008 ERR("Unable to get relayd configuration");
1009 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1012 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
1013 consumer
->relay_allows_clear
= true;
1015 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1016 DBG3("Creating relayd data socket from URI");
1018 /* Command is not valid */
1019 ERR("Relayd invalid stream type: %d", uri
->stype
);
1020 status
= LTTNG_ERR_INVALID
;
1024 *relayd_sock
= rsock
;
1029 /* The returned value is not useful since we are on an error path. */
1030 (void) relayd_close(rsock
);
1038 * Connect to the relayd using URI and send the socket to the right consumer.
1040 * The consumer socket lock must be held by the caller.
1042 * Returns LTTNG_OK on success or an LTTng error code on failure.
1044 static enum lttng_error_code
send_consumer_relayd_socket(
1045 unsigned int session_id
,
1046 struct lttng_uri
*relayd_uri
,
1047 struct consumer_output
*consumer
,
1048 struct consumer_socket
*consumer_sock
,
1049 const char *session_name
, const char *hostname
,
1050 const char *base_path
, int session_live_timer
,
1051 const uint64_t *current_chunk_id
,
1052 time_t session_creation_time
,
1053 bool session_name_contains_creation_time
)
1056 struct lttcomm_relayd_sock
*rsock
= NULL
;
1057 enum lttng_error_code status
;
1059 /* Connect to relayd and make version check if uri is the control. */
1060 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1061 if (status
!= LTTNG_OK
) {
1062 goto relayd_comm_error
;
1066 /* Set the network sequence index if not set. */
1067 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1068 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1070 * Increment net_seq_idx because we are about to transfer the
1071 * new relayd socket to the consumer.
1072 * Assign unique key so the consumer can match streams.
1074 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1075 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1078 /* Send relayd socket to consumer. */
1079 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1080 relayd_uri
->stype
, session_id
,
1081 session_name
, hostname
, base_path
,
1082 session_live_timer
, current_chunk_id
,
1083 session_creation_time
, session_name_contains_creation_time
);
1085 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1089 /* Flag that the corresponding socket was sent. */
1090 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1091 consumer_sock
->control_sock_sent
= 1;
1092 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1093 consumer_sock
->data_sock_sent
= 1;
1097 * Close socket which was dup on the consumer side. The session daemon does
1098 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1102 if (status
!= LTTNG_OK
) {
1104 * The consumer output for this session should not be used anymore
1105 * since the relayd connection failed thus making any tracing or/and
1106 * streaming not usable.
1108 consumer
->enabled
= 0;
1110 (void) relayd_close(rsock
);
1118 * Send both relayd sockets to a specific consumer and domain. This is a
1119 * helper function to facilitate sending the information to the consumer for a
1122 * The consumer socket lock must be held by the caller.
1124 * Returns LTTNG_OK, or an LTTng error code on failure.
1126 static enum lttng_error_code
send_consumer_relayd_sockets(
1127 enum lttng_domain_type domain
,
1128 unsigned int session_id
, struct consumer_output
*consumer
,
1129 struct consumer_socket
*sock
, const char *session_name
,
1130 const char *hostname
, const char *base_path
, int session_live_timer
,
1131 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1132 bool session_name_contains_creation_time
)
1134 enum lttng_error_code status
= LTTNG_OK
;
1139 /* Sending control relayd socket. */
1140 if (!sock
->control_sock_sent
) {
1141 status
= send_consumer_relayd_socket(session_id
,
1142 &consumer
->dst
.net
.control
, consumer
, sock
,
1143 session_name
, hostname
, base_path
, session_live_timer
,
1144 current_chunk_id
, session_creation_time
,
1145 session_name_contains_creation_time
);
1146 if (status
!= LTTNG_OK
) {
1151 /* Sending data relayd socket. */
1152 if (!sock
->data_sock_sent
) {
1153 status
= send_consumer_relayd_socket(session_id
,
1154 &consumer
->dst
.net
.data
, consumer
, sock
,
1155 session_name
, hostname
, base_path
, session_live_timer
,
1156 current_chunk_id
, session_creation_time
,
1157 session_name_contains_creation_time
);
1158 if (status
!= LTTNG_OK
) {
1168 * Setup relayd connections for a tracing session. First creates the socket to
1169 * the relayd and send them to the right domain consumer. Consumer type MUST be
1172 int cmd_setup_relayd(struct ltt_session
*session
)
1175 struct ltt_ust_session
*usess
;
1176 struct ltt_kernel_session
*ksess
;
1177 struct consumer_socket
*socket
;
1178 struct lttng_ht_iter iter
;
1179 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1183 usess
= session
->ust_session
;
1184 ksess
= session
->kernel_session
;
1186 DBG("Setting relayd for session %s", session
->name
);
1189 if (session
->current_trace_chunk
) {
1190 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1191 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1193 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1194 current_chunk_id
.is_set
= true;
1196 ERR("Failed to get current trace chunk id");
1197 ret
= LTTNG_ERR_UNK
;
1202 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1203 && usess
->consumer
->enabled
) {
1204 /* For each consumer socket, send relayd sockets */
1205 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1206 socket
, node
.node
) {
1207 pthread_mutex_lock(socket
->lock
);
1208 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1209 usess
->consumer
, socket
,
1210 session
->name
, session
->hostname
,
1212 session
->live_timer
,
1213 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1214 session
->creation_time
,
1215 session
->name_contains_creation_time
);
1216 pthread_mutex_unlock(socket
->lock
);
1217 if (ret
!= LTTNG_OK
) {
1220 /* Session is now ready for network streaming. */
1221 session
->net_handle
= 1;
1223 session
->consumer
->relay_major_version
=
1224 usess
->consumer
->relay_major_version
;
1225 session
->consumer
->relay_minor_version
=
1226 usess
->consumer
->relay_minor_version
;
1227 session
->consumer
->relay_allows_clear
=
1228 usess
->consumer
->relay_allows_clear
;
1231 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1232 && ksess
->consumer
->enabled
) {
1233 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1234 socket
, node
.node
) {
1235 pthread_mutex_lock(socket
->lock
);
1236 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1237 ksess
->consumer
, socket
,
1238 session
->name
, session
->hostname
,
1240 session
->live_timer
,
1241 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1242 session
->creation_time
,
1243 session
->name_contains_creation_time
);
1244 pthread_mutex_unlock(socket
->lock
);
1245 if (ret
!= LTTNG_OK
) {
1248 /* Session is now ready for network streaming. */
1249 session
->net_handle
= 1;
1251 session
->consumer
->relay_major_version
=
1252 ksess
->consumer
->relay_major_version
;
1253 session
->consumer
->relay_minor_version
=
1254 ksess
->consumer
->relay_minor_version
;
1255 session
->consumer
->relay_allows_clear
=
1256 ksess
->consumer
->relay_allows_clear
;
1265 * Start a kernel session by opening all necessary streams.
1267 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1270 struct ltt_kernel_channel
*kchan
;
1272 /* Open kernel metadata */
1273 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1274 ret
= kernel_open_metadata(ksess
);
1276 ret
= LTTNG_ERR_KERN_META_FAIL
;
1281 /* Open kernel metadata stream */
1282 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1283 ret
= kernel_open_metadata_stream(ksess
);
1285 ERR("Kernel create metadata stream failed");
1286 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1291 /* For each channel */
1292 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1293 if (kchan
->stream_count
== 0) {
1294 ret
= kernel_open_channel_stream(kchan
);
1296 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1299 /* Update the stream global counter */
1300 ksess
->stream_count_global
+= ret
;
1304 /* Setup kernel consumer socket and send fds to it */
1305 ret
= init_kernel_tracing(ksess
);
1307 ret
= LTTNG_ERR_KERN_START_FAIL
;
1311 /* This start the kernel tracing */
1312 ret
= kernel_start_session(ksess
);
1314 ret
= LTTNG_ERR_KERN_START_FAIL
;
1318 /* Quiescent wait after starting trace */
1319 kernel_wait_quiescent();
1329 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1331 struct ltt_kernel_channel
*kchan
;
1332 bool error_occurred
= false;
1335 if (!ksess
|| !ksess
->active
) {
1338 DBG("Stopping kernel tracing");
1340 ret
= kernel_stop_session(ksess
);
1342 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1346 kernel_wait_quiescent();
1348 /* Flush metadata after stopping (if exists) */
1349 if (ksess
->metadata_stream_fd
>= 0) {
1350 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1352 ERR("Kernel metadata flush failed");
1353 error_occurred
= true;
1357 /* Flush all buffers after stopping */
1358 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1359 ret
= kernel_flush_buffer(kchan
);
1361 ERR("Kernel flush buffer error");
1362 error_occurred
= true;
1367 if (error_occurred
) {
1368 ret
= LTTNG_ERR_UNK
;
1377 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1379 int cmd_disable_channel(struct ltt_session
*session
,
1380 enum lttng_domain_type domain
, char *channel_name
)
1383 struct ltt_ust_session
*usess
;
1385 usess
= session
->ust_session
;
1390 case LTTNG_DOMAIN_KERNEL
:
1392 ret
= channel_kernel_disable(session
->kernel_session
,
1394 if (ret
!= LTTNG_OK
) {
1398 kernel_wait_quiescent();
1401 case LTTNG_DOMAIN_UST
:
1403 struct ltt_ust_channel
*uchan
;
1404 struct lttng_ht
*chan_ht
;
1406 chan_ht
= usess
->domain_global
.channels
;
1408 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1409 if (uchan
== NULL
) {
1410 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1414 ret
= channel_ust_disable(usess
, uchan
);
1415 if (ret
!= LTTNG_OK
) {
1421 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1433 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1435 * The wpipe arguments is used as a notifier for the kernel thread.
1437 int cmd_enable_channel(struct ltt_session
*session
,
1438 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1441 struct ltt_ust_session
*usess
= session
->ust_session
;
1442 struct lttng_ht
*chan_ht
;
1444 struct lttng_channel attr
;
1451 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1453 /* Validate channel name */
1454 if (attr
.name
[0] == '.' ||
1455 memchr(attr
.name
, '/', len
) != NULL
) {
1456 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1460 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1465 * If the session is a live session, remove the switch timer, the
1466 * live timer does the same thing but sends also synchronisation
1467 * beacons for inactive streams.
1469 if (session
->live_timer
> 0) {
1470 attr
.attr
.live_timer_interval
= session
->live_timer
;
1471 attr
.attr
.switch_timer_interval
= 0;
1474 /* Check for feature support */
1475 switch (domain
->type
) {
1476 case LTTNG_DOMAIN_KERNEL
:
1478 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1479 /* Sampling position of buffer is not supported */
1480 WARN("Kernel tracer does not support buffer monitoring. "
1481 "Setting the monitor interval timer to 0 "
1482 "(disabled) for channel '%s' of session '%s'",
1483 attr
.name
, session
->name
);
1484 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1488 case LTTNG_DOMAIN_UST
:
1490 case LTTNG_DOMAIN_JUL
:
1491 case LTTNG_DOMAIN_LOG4J
:
1492 case LTTNG_DOMAIN_PYTHON
:
1493 if (!agent_tracing_is_enabled()) {
1494 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1495 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1500 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1504 switch (domain
->type
) {
1505 case LTTNG_DOMAIN_KERNEL
:
1507 struct ltt_kernel_channel
*kchan
;
1509 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1510 session
->kernel_session
);
1511 if (kchan
== NULL
) {
1513 * Don't try to create a channel if the session has been started at
1514 * some point in time before. The tracer does not allow it.
1516 if (session
->has_been_started
) {
1517 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1521 if (session
->snapshot
.nb_output
> 0 ||
1522 session
->snapshot_mode
) {
1523 /* Enforce mmap output for snapshot sessions. */
1524 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1526 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1527 if (attr
.name
[0] != '\0') {
1528 session
->kernel_session
->has_non_default_channel
= 1;
1531 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1534 if (ret
!= LTTNG_OK
) {
1538 kernel_wait_quiescent();
1541 case LTTNG_DOMAIN_UST
:
1542 case LTTNG_DOMAIN_JUL
:
1543 case LTTNG_DOMAIN_LOG4J
:
1544 case LTTNG_DOMAIN_PYTHON
:
1546 struct ltt_ust_channel
*uchan
;
1551 * Current agent implementation limitations force us to allow
1552 * only one channel at once in "agent" subdomains. Each
1553 * subdomain has a default channel name which must be strictly
1556 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1557 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1558 LTTNG_SYMBOL_NAME_LEN
)) {
1559 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1562 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1563 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1564 LTTNG_SYMBOL_NAME_LEN
)) {
1565 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1568 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1569 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1570 LTTNG_SYMBOL_NAME_LEN
)) {
1571 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1576 chan_ht
= usess
->domain_global
.channels
;
1578 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1579 if (uchan
== NULL
) {
1581 * Don't try to create a channel if the session has been started at
1582 * some point in time before. The tracer does not allow it.
1584 if (session
->has_been_started
) {
1585 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1589 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1590 if (attr
.name
[0] != '\0') {
1591 usess
->has_non_default_channel
= 1;
1594 ret
= channel_ust_enable(usess
, uchan
);
1599 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1603 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1604 session
->has_non_mmap_channel
= true;
1612 enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(
1613 struct ltt_session
*session
,
1614 enum lttng_domain_type domain
,
1615 enum lttng_process_attr process_attr
,
1616 enum lttng_tracking_policy
*policy
)
1618 enum lttng_error_code ret_code
= LTTNG_OK
;
1619 const struct process_attr_tracker
*tracker
;
1622 case LTTNG_DOMAIN_KERNEL
:
1623 if (!session
->kernel_session
) {
1624 ret_code
= LTTNG_ERR_INVALID
;
1627 tracker
= kernel_get_process_attr_tracker(
1628 session
->kernel_session
, process_attr
);
1630 case LTTNG_DOMAIN_UST
:
1631 if (!session
->ust_session
) {
1632 ret_code
= LTTNG_ERR_INVALID
;
1635 tracker
= trace_ust_get_process_attr_tracker(
1636 session
->ust_session
, process_attr
);
1639 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1643 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1645 ret_code
= LTTNG_ERR_INVALID
;
1651 enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(
1652 struct ltt_session
*session
,
1653 enum lttng_domain_type domain
,
1654 enum lttng_process_attr process_attr
,
1655 enum lttng_tracking_policy policy
)
1657 enum lttng_error_code ret_code
= LTTNG_OK
;
1660 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1661 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1662 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1665 ret_code
= LTTNG_ERR_INVALID
;
1670 case LTTNG_DOMAIN_KERNEL
:
1671 if (!session
->kernel_session
) {
1672 ret_code
= LTTNG_ERR_INVALID
;
1675 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1676 session
->kernel_session
, process_attr
, policy
);
1678 case LTTNG_DOMAIN_UST
:
1679 if (!session
->ust_session
) {
1680 ret_code
= LTTNG_ERR_INVALID
;
1683 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1684 session
->ust_session
, process_attr
, policy
);
1687 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1694 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(
1695 struct ltt_session
*session
,
1696 enum lttng_domain_type domain
,
1697 enum lttng_process_attr process_attr
,
1698 const struct process_attr_value
*value
)
1700 enum lttng_error_code ret_code
= LTTNG_OK
;
1703 case LTTNG_DOMAIN_KERNEL
:
1704 if (!session
->kernel_session
) {
1705 ret_code
= LTTNG_ERR_INVALID
;
1708 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1709 session
->kernel_session
, process_attr
, value
);
1711 case LTTNG_DOMAIN_UST
:
1712 if (!session
->ust_session
) {
1713 ret_code
= LTTNG_ERR_INVALID
;
1716 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1717 session
->ust_session
, process_attr
, value
);
1720 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1727 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(
1728 struct ltt_session
*session
,
1729 enum lttng_domain_type domain
,
1730 enum lttng_process_attr process_attr
,
1731 const struct process_attr_value
*value
)
1733 enum lttng_error_code ret_code
= LTTNG_OK
;
1736 case LTTNG_DOMAIN_KERNEL
:
1737 if (!session
->kernel_session
) {
1738 ret_code
= LTTNG_ERR_INVALID
;
1741 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1742 session
->kernel_session
, process_attr
, value
);
1744 case LTTNG_DOMAIN_UST
:
1745 if (!session
->ust_session
) {
1746 ret_code
= LTTNG_ERR_INVALID
;
1749 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1750 session
->ust_session
, process_attr
, value
);
1753 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1760 enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(
1761 struct ltt_session
*session
,
1762 enum lttng_domain_type domain
,
1763 enum lttng_process_attr process_attr
,
1764 struct lttng_process_attr_values
**values
)
1766 enum lttng_error_code ret_code
= LTTNG_OK
;
1767 const struct process_attr_tracker
*tracker
;
1768 enum process_attr_tracker_status status
;
1771 case LTTNG_DOMAIN_KERNEL
:
1772 if (!session
->kernel_session
) {
1773 ret_code
= LTTNG_ERR_INVALID
;
1776 tracker
= kernel_get_process_attr_tracker(
1777 session
->kernel_session
, process_attr
);
1779 case LTTNG_DOMAIN_UST
:
1780 if (!session
->ust_session
) {
1781 ret_code
= LTTNG_ERR_INVALID
;
1784 tracker
= trace_ust_get_process_attr_tracker(
1785 session
->ust_session
, process_attr
);
1788 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1793 ret_code
= LTTNG_ERR_INVALID
;
1797 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1799 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1800 ret_code
= LTTNG_OK
;
1802 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1803 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1805 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1806 ret_code
= LTTNG_ERR_NOMEM
;
1809 ret_code
= LTTNG_ERR_UNK
;
1818 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1820 int cmd_disable_event(struct ltt_session
*session
,
1821 enum lttng_domain_type domain
, const char *channel_name
,
1822 const struct lttng_event
*event
)
1825 const char *event_name
;
1827 DBG("Disable event command for event \'%s\'", event
->name
);
1829 event_name
= event
->name
;
1831 /* Error out on unhandled search criteria */
1832 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1833 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1834 ret
= LTTNG_ERR_UNK
;
1841 case LTTNG_DOMAIN_KERNEL
:
1843 struct ltt_kernel_channel
*kchan
;
1844 struct ltt_kernel_session
*ksess
;
1846 ksess
= session
->kernel_session
;
1849 * If a non-default channel has been created in the
1850 * session, explicitely require that -c chan_name needs
1853 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1854 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1858 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1859 if (kchan
== NULL
) {
1860 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1864 switch (event
->type
) {
1865 case LTTNG_EVENT_ALL
:
1866 case LTTNG_EVENT_TRACEPOINT
:
1867 case LTTNG_EVENT_SYSCALL
:
1868 case LTTNG_EVENT_PROBE
:
1869 case LTTNG_EVENT_FUNCTION
:
1870 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1871 if (event_name
[0] == '\0') {
1872 ret
= event_kernel_disable_event(kchan
,
1875 ret
= event_kernel_disable_event(kchan
,
1876 event_name
, event
->type
);
1878 if (ret
!= LTTNG_OK
) {
1883 ret
= LTTNG_ERR_UNK
;
1887 kernel_wait_quiescent();
1890 case LTTNG_DOMAIN_UST
:
1892 struct ltt_ust_channel
*uchan
;
1893 struct ltt_ust_session
*usess
;
1895 usess
= session
->ust_session
;
1897 if (validate_ust_event_name(event_name
)) {
1898 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1903 * If a non-default channel has been created in the
1904 * session, explicitly require that -c chan_name needs
1907 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1908 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1912 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1914 if (uchan
== NULL
) {
1915 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1919 switch (event
->type
) {
1920 case LTTNG_EVENT_ALL
:
1922 * An empty event name means that everything
1923 * should be disabled.
1925 if (event
->name
[0] == '\0') {
1926 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1928 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1931 if (ret
!= LTTNG_OK
) {
1936 ret
= LTTNG_ERR_UNK
;
1940 DBG3("Disable UST event %s in channel %s completed", event_name
,
1944 case LTTNG_DOMAIN_LOG4J
:
1945 case LTTNG_DOMAIN_JUL
:
1946 case LTTNG_DOMAIN_PYTHON
:
1949 struct ltt_ust_session
*usess
= session
->ust_session
;
1953 switch (event
->type
) {
1954 case LTTNG_EVENT_ALL
:
1957 ret
= LTTNG_ERR_UNK
;
1961 agt
= trace_ust_find_agent(usess
, domain
);
1963 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1967 * An empty event name means that everything
1968 * should be disabled.
1970 if (event
->name
[0] == '\0') {
1971 ret
= event_agent_disable_all(usess
, agt
);
1973 ret
= event_agent_disable(usess
, agt
, event_name
);
1975 if (ret
!= LTTNG_OK
) {
1982 ret
= LTTNG_ERR_UND
;
1995 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1997 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1998 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
2000 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
2001 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
2004 * Don't try to add a context if the session has been started at
2005 * some point in time before. The tracer does not allow it and would
2006 * result in a corrupted trace.
2008 if (session
->has_been_started
) {
2009 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2013 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
2014 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
2015 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
2019 case LTTNG_DOMAIN_KERNEL
:
2020 assert(session
->kernel_session
);
2022 if (session
->kernel_session
->channel_count
== 0) {
2023 /* Create default channel */
2024 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
2025 if (ret
!= LTTNG_OK
) {
2028 chan_kern_created
= 1;
2030 /* Add kernel context to kernel tracer */
2031 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
2032 if (ret
!= LTTNG_OK
) {
2036 case LTTNG_DOMAIN_JUL
:
2037 case LTTNG_DOMAIN_LOG4J
:
2040 * Validate channel name.
2041 * If no channel name is given and the domain is JUL or LOG4J,
2042 * set it to the appropriate domain-specific channel name. If
2043 * a name is provided but does not match the expexted channel
2044 * name, return an error.
2046 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
2047 strcmp(channel_name
,
2048 DEFAULT_JUL_CHANNEL_NAME
)) {
2049 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2051 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
2052 strcmp(channel_name
,
2053 DEFAULT_LOG4J_CHANNEL_NAME
)) {
2054 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2057 /* break is _not_ missing here. */
2059 case LTTNG_DOMAIN_UST
:
2061 struct ltt_ust_session
*usess
= session
->ust_session
;
2062 unsigned int chan_count
;
2066 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
2067 if (chan_count
== 0) {
2068 struct lttng_channel
*attr
;
2069 /* Create default channel */
2070 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
2072 ret
= LTTNG_ERR_FATAL
;
2076 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
2077 if (ret
!= LTTNG_OK
) {
2081 channel_attr_destroy(attr
);
2082 chan_ust_created
= 1;
2085 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
2086 free(app_ctx_provider_name
);
2088 app_ctx_name
= NULL
;
2089 app_ctx_provider_name
= NULL
;
2090 if (ret
!= LTTNG_OK
) {
2096 ret
= LTTNG_ERR_UND
;
2104 if (chan_kern_created
) {
2105 struct ltt_kernel_channel
*kchan
=
2106 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
2107 session
->kernel_session
);
2108 /* Created previously, this should NOT fail. */
2110 kernel_destroy_channel(kchan
);
2113 if (chan_ust_created
) {
2114 struct ltt_ust_channel
*uchan
=
2115 trace_ust_find_channel_by_name(
2116 session
->ust_session
->domain_global
.channels
,
2117 DEFAULT_CHANNEL_NAME
);
2118 /* Created previously, this should NOT fail. */
2120 /* Remove from the channel list of the session. */
2121 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2123 trace_ust_destroy_channel(uchan
);
2126 free(app_ctx_provider_name
);
2131 static inline bool name_starts_with(const char *name
, const char *prefix
)
2133 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2135 return !strncmp(name
, prefix
, max_cmp_len
);
2138 /* Perform userspace-specific event name validation */
2139 static int validate_ust_event_name(const char *name
)
2149 * Check name against all internal UST event component namespaces used
2152 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2153 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2154 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2163 * Internal version of cmd_enable_event() with a supplemental
2164 * "internal_event" flag which is used to enable internal events which should
2165 * be hidden from clients. Such events are used in the agent implementation to
2166 * enable the events through which all "agent" events are funeled.
2168 static int _cmd_enable_event(struct ltt_session
*session
,
2169 const struct lttng_domain
*domain
,
2170 char *channel_name
, struct lttng_event
*event
,
2171 char *filter_expression
,
2172 struct lttng_filter_bytecode
*filter
,
2173 struct lttng_event_exclusion
*exclusion
,
2174 int wpipe
, bool internal_event
)
2176 int ret
= 0, channel_created
= 0;
2177 struct lttng_channel
*attr
= NULL
;
2181 assert(channel_name
);
2183 /* If we have a filter, we must have its filter expression */
2184 assert(!(!!filter_expression
^ !!filter
));
2186 /* Normalize event name as a globbing pattern */
2187 strutils_normalize_star_glob_pattern(event
->name
);
2189 /* Normalize exclusion names as globbing patterns */
2193 for (i
= 0; i
< exclusion
->count
; i
++) {
2194 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2196 strutils_normalize_star_glob_pattern(name
);
2200 DBG("Enable event command for event \'%s\'", event
->name
);
2204 switch (domain
->type
) {
2205 case LTTNG_DOMAIN_KERNEL
:
2207 struct ltt_kernel_channel
*kchan
;
2210 * If a non-default channel has been created in the
2211 * session, explicitely require that -c chan_name needs
2214 if (session
->kernel_session
->has_non_default_channel
2215 && channel_name
[0] == '\0') {
2216 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2220 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2221 session
->kernel_session
);
2222 if (kchan
== NULL
) {
2223 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2224 LTTNG_BUFFER_GLOBAL
);
2226 ret
= LTTNG_ERR_FATAL
;
2229 if (lttng_strncpy(attr
->name
, channel_name
,
2230 sizeof(attr
->name
))) {
2231 ret
= LTTNG_ERR_INVALID
;
2235 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2236 if (ret
!= LTTNG_OK
) {
2239 channel_created
= 1;
2242 /* Get the newly created kernel channel pointer */
2243 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2244 session
->kernel_session
);
2245 if (kchan
== NULL
) {
2246 /* This sould not happen... */
2247 ret
= LTTNG_ERR_FATAL
;
2251 switch (event
->type
) {
2252 case LTTNG_EVENT_ALL
:
2254 char *filter_expression_a
= NULL
;
2255 struct lttng_filter_bytecode
*filter_a
= NULL
;
2258 * We need to duplicate filter_expression and filter,
2259 * because ownership is passed to first enable
2262 if (filter_expression
) {
2263 filter_expression_a
= strdup(filter_expression
);
2264 if (!filter_expression_a
) {
2265 ret
= LTTNG_ERR_FATAL
;
2270 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2272 free(filter_expression_a
);
2273 ret
= LTTNG_ERR_FATAL
;
2276 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2278 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2279 ret
= event_kernel_enable_event(kchan
, event
,
2280 filter_expression
, filter
);
2281 /* We have passed ownership */
2282 filter_expression
= NULL
;
2284 if (ret
!= LTTNG_OK
) {
2285 if (channel_created
) {
2286 /* Let's not leak a useless channel. */
2287 kernel_destroy_channel(kchan
);
2289 free(filter_expression_a
);
2293 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2294 ret
= event_kernel_enable_event(kchan
, event
,
2295 filter_expression_a
, filter_a
);
2296 /* We have passed ownership */
2297 filter_expression_a
= NULL
;
2299 if (ret
!= LTTNG_OK
) {
2304 case LTTNG_EVENT_PROBE
:
2305 case LTTNG_EVENT_USERSPACE_PROBE
:
2306 case LTTNG_EVENT_FUNCTION
:
2307 case LTTNG_EVENT_FUNCTION_ENTRY
:
2308 case LTTNG_EVENT_TRACEPOINT
:
2309 ret
= event_kernel_enable_event(kchan
, event
,
2310 filter_expression
, filter
);
2311 /* We have passed ownership */
2312 filter_expression
= NULL
;
2314 if (ret
!= LTTNG_OK
) {
2315 if (channel_created
) {
2316 /* Let's not leak a useless channel. */
2317 kernel_destroy_channel(kchan
);
2322 case LTTNG_EVENT_SYSCALL
:
2323 ret
= event_kernel_enable_event(kchan
, event
,
2324 filter_expression
, filter
);
2325 /* We have passed ownership */
2326 filter_expression
= NULL
;
2328 if (ret
!= LTTNG_OK
) {
2333 ret
= LTTNG_ERR_UNK
;
2337 kernel_wait_quiescent();
2340 case LTTNG_DOMAIN_UST
:
2342 struct ltt_ust_channel
*uchan
;
2343 struct ltt_ust_session
*usess
= session
->ust_session
;
2348 * If a non-default channel has been created in the
2349 * session, explicitely require that -c chan_name needs
2352 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2353 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2357 /* Get channel from global UST domain */
2358 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2360 if (uchan
== NULL
) {
2361 /* Create default channel */
2362 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2363 usess
->buffer_type
);
2365 ret
= LTTNG_ERR_FATAL
;
2368 if (lttng_strncpy(attr
->name
, channel_name
,
2369 sizeof(attr
->name
))) {
2370 ret
= LTTNG_ERR_INVALID
;
2374 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2375 if (ret
!= LTTNG_OK
) {
2379 /* Get the newly created channel reference back */
2380 uchan
= trace_ust_find_channel_by_name(
2381 usess
->domain_global
.channels
, channel_name
);
2385 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2387 * Don't allow users to add UST events to channels which
2388 * are assigned to a userspace subdomain (JUL, Log4J,
2391 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2395 if (!internal_event
) {
2397 * Ensure the event name is not reserved for internal
2400 ret
= validate_ust_event_name(event
->name
);
2402 WARN("Userspace event name %s failed validation.",
2404 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2409 /* At this point, the session and channel exist on the tracer */
2410 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2411 filter_expression
, filter
, exclusion
,
2413 /* We have passed ownership */
2414 filter_expression
= NULL
;
2417 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2418 goto already_enabled
;
2419 } else if (ret
!= LTTNG_OK
) {
2424 case LTTNG_DOMAIN_LOG4J
:
2425 case LTTNG_DOMAIN_JUL
:
2426 case LTTNG_DOMAIN_PYTHON
:
2428 const char *default_event_name
, *default_chan_name
;
2430 struct lttng_event uevent
;
2431 struct lttng_domain tmp_dom
;
2432 struct ltt_ust_session
*usess
= session
->ust_session
;
2436 if (!agent_tracing_is_enabled()) {
2437 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2438 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2442 agt
= trace_ust_find_agent(usess
, domain
->type
);
2444 agt
= agent_create(domain
->type
);
2446 ret
= LTTNG_ERR_NOMEM
;
2449 agent_add(agt
, usess
->agents
);
2452 /* Create the default tracepoint. */
2453 memset(&uevent
, 0, sizeof(uevent
));
2454 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2455 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2456 default_event_name
= event_get_default_agent_ust_name(
2458 if (!default_event_name
) {
2459 ret
= LTTNG_ERR_FATAL
;
2462 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2463 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2466 * The domain type is changed because we are about to enable the
2467 * default channel and event for the JUL domain that are hardcoded.
2468 * This happens in the UST domain.
2470 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2471 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2473 switch (domain
->type
) {
2474 case LTTNG_DOMAIN_LOG4J
:
2475 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2477 case LTTNG_DOMAIN_JUL
:
2478 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2480 case LTTNG_DOMAIN_PYTHON
:
2481 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2484 /* The switch/case we are in makes this impossible */
2489 char *filter_expression_copy
= NULL
;
2490 struct lttng_filter_bytecode
*filter_copy
= NULL
;
2493 const size_t filter_size
= sizeof(
2494 struct lttng_filter_bytecode
)
2497 filter_copy
= zmalloc(filter_size
);
2499 ret
= LTTNG_ERR_NOMEM
;
2502 memcpy(filter_copy
, filter
, filter_size
);
2504 filter_expression_copy
=
2505 strdup(filter_expression
);
2506 if (!filter_expression
) {
2507 ret
= LTTNG_ERR_NOMEM
;
2510 if (!filter_expression_copy
|| !filter_copy
) {
2511 free(filter_expression_copy
);
2517 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2518 (char *) default_chan_name
,
2519 &uevent
, filter_expression_copy
,
2520 filter_copy
, NULL
, wpipe
);
2523 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2524 goto already_enabled
;
2525 } else if (ret
!= LTTNG_OK
) {
2529 /* The wild card * means that everything should be enabled. */
2530 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2531 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2534 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2538 filter_expression
= NULL
;
2539 if (ret
!= LTTNG_OK
) {
2546 ret
= LTTNG_ERR_UND
;
2554 free(filter_expression
);
2557 channel_attr_destroy(attr
);
2563 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2564 * We own filter, exclusion, and filter_expression.
2566 int cmd_enable_event(struct ltt_session
*session
,
2567 const struct lttng_domain
*domain
,
2568 char *channel_name
, struct lttng_event
*event
,
2569 char *filter_expression
,
2570 struct lttng_filter_bytecode
*filter
,
2571 struct lttng_event_exclusion
*exclusion
,
2574 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2575 filter_expression
, filter
, exclusion
, wpipe
, false);
2579 * Enable an event which is internal to LTTng. An internal should
2580 * never be made visible to clients and are immune to checks such as
2583 static int cmd_enable_event_internal(struct ltt_session
*session
,
2584 const struct lttng_domain
*domain
,
2585 char *channel_name
, struct lttng_event
*event
,
2586 char *filter_expression
,
2587 struct lttng_filter_bytecode
*filter
,
2588 struct lttng_event_exclusion
*exclusion
,
2591 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2592 filter_expression
, filter
, exclusion
, wpipe
, true);
2596 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2598 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2599 struct lttng_event
**events
)
2602 ssize_t nb_events
= 0;
2605 case LTTNG_DOMAIN_KERNEL
:
2606 nb_events
= kernel_list_events(events
);
2607 if (nb_events
< 0) {
2608 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2612 case LTTNG_DOMAIN_UST
:
2613 nb_events
= ust_app_list_events(events
);
2614 if (nb_events
< 0) {
2615 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2619 case LTTNG_DOMAIN_LOG4J
:
2620 case LTTNG_DOMAIN_JUL
:
2621 case LTTNG_DOMAIN_PYTHON
:
2622 nb_events
= agent_list_events(events
, domain
);
2623 if (nb_events
< 0) {
2624 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2629 ret
= LTTNG_ERR_UND
;
2636 /* Return negative value to differentiate return code */
2641 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2643 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2644 struct lttng_event_field
**fields
)
2647 ssize_t nb_fields
= 0;
2650 case LTTNG_DOMAIN_UST
:
2651 nb_fields
= ust_app_list_event_fields(fields
);
2652 if (nb_fields
< 0) {
2653 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2657 case LTTNG_DOMAIN_KERNEL
:
2658 default: /* fall-through */
2659 ret
= LTTNG_ERR_UND
;
2666 /* Return negative value to differentiate return code */
2670 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2672 return syscall_table_list(events
);
2676 * Command LTTNG_START_TRACE processed by the client thread.
2678 * Called with session mutex held.
2680 int cmd_start_trace(struct ltt_session
*session
)
2682 enum lttng_error_code ret
;
2683 unsigned long nb_chan
= 0;
2684 struct ltt_kernel_session
*ksession
;
2685 struct ltt_ust_session
*usess
;
2686 const bool session_rotated_after_last_stop
=
2687 session
->rotated_after_last_stop
;
2688 const bool session_cleared_after_last_stop
=
2689 session
->cleared_after_last_stop
;
2693 /* Ease our life a bit ;) */
2694 ksession
= session
->kernel_session
;
2695 usess
= session
->ust_session
;
2697 /* Is the session already started? */
2698 if (session
->active
) {
2699 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2700 /* Perform nothing */
2704 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2705 !session
->current_trace_chunk
) {
2707 * A rotation was launched while the session was stopped and
2708 * it has not been completed yet. It is not possible to start
2709 * the session since starting the session here would require a
2710 * rotation from "NULL" to a new trace chunk. That rotation
2711 * would overlap with the ongoing rotation, which is not
2714 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2716 ret
= LTTNG_ERR_ROTATION_PENDING
;
2721 * Starting a session without channel is useless since after that it's not
2722 * possible to enable channel thus inform the client.
2724 if (usess
&& usess
->domain_global
.channels
) {
2725 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2728 nb_chan
+= ksession
->channel_count
;
2731 ret
= LTTNG_ERR_NO_CHANNEL
;
2735 session
->active
= 1;
2736 session
->rotated_after_last_stop
= false;
2737 session
->cleared_after_last_stop
= false;
2738 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2739 if (!session
->has_been_started
) {
2740 struct lttng_trace_chunk
*trace_chunk
;
2742 DBG("Creating initial trace chunk of session \"%s\"",
2744 trace_chunk
= session_create_new_trace_chunk(
2745 session
, NULL
, NULL
, NULL
);
2747 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2750 assert(!session
->current_trace_chunk
);
2751 ret
= session_set_trace_chunk(session
, trace_chunk
,
2753 lttng_trace_chunk_put(trace_chunk
);
2755 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2759 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2762 * Rotate existing streams into the new chunk.
2763 * This is a "quiet" rotation has no client has
2764 * explicitly requested this operation.
2766 * There is also no need to wait for the rotation
2767 * to complete as it will happen immediately. No data
2768 * was produced as the session was stopped, so the
2769 * rotation should happen on reception of the command.
2771 ret
= cmd_rotate_session(session
, NULL
, true,
2772 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2773 if (ret
!= LTTNG_OK
) {
2779 /* Kernel tracing */
2780 if (ksession
!= NULL
) {
2781 DBG("Start kernel tracing session %s", session
->name
);
2782 ret
= start_kernel_session(ksession
);
2783 if (ret
!= LTTNG_OK
) {
2788 /* Flag session that trace should start automatically */
2790 int int_ret
= ust_app_start_trace_all(usess
);
2793 ret
= LTTNG_ERR_UST_START_FAIL
;
2799 * Open a packet in every stream of the session to ensure that viewers
2800 * can correctly identify the boundaries of the periods during which
2801 * tracing was active for this session.
2803 ret
= session_open_packets(session
);
2804 if (ret
!= LTTNG_OK
) {
2809 * Clear the flag that indicates that a rotation was done while the
2810 * session was stopped.
2812 session
->rotated_after_last_stop
= false;
2814 if (session
->rotate_timer_period
) {
2815 int int_ret
= timer_session_rotation_schedule_timer_start(
2816 session
, session
->rotate_timer_period
);
2819 ERR("Failed to enable rotate timer");
2820 ret
= LTTNG_ERR_UNK
;
2828 if (ret
== LTTNG_OK
) {
2829 /* Flag this after a successful start. */
2830 session
->has_been_started
|= 1;
2832 session
->active
= 0;
2833 /* Restore initial state on error. */
2834 session
->rotated_after_last_stop
=
2835 session_rotated_after_last_stop
;
2836 session
->cleared_after_last_stop
=
2837 session_cleared_after_last_stop
;
2844 * Command LTTNG_STOP_TRACE processed by the client thread.
2846 int cmd_stop_trace(struct ltt_session
*session
)
2849 struct ltt_kernel_session
*ksession
;
2850 struct ltt_ust_session
*usess
;
2854 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2856 ksession
= session
->kernel_session
;
2857 usess
= session
->ust_session
;
2859 /* Session is not active. Skip everythong and inform the client. */
2860 if (!session
->active
) {
2861 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2865 ret
= stop_kernel_session(ksession
);
2866 if (ret
!= LTTNG_OK
) {
2870 if (usess
&& usess
->active
) {
2871 ret
= ust_app_stop_trace_all(usess
);
2873 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2878 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2880 /* Flag inactive after a successful stop. */
2881 session
->active
= 0;
2889 * Set the base_path of the session only if subdir of a control uris is set.
2890 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2892 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2894 struct lttng_uri
*uris
)
2899 for (i
= 0; i
< nb_uri
; i
++) {
2900 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2901 uris
[i
].subdir
[0] == '\0') {
2902 /* Not interested in these URIs */
2906 if (session
->base_path
!= NULL
) {
2907 free(session
->base_path
);
2908 session
->base_path
= NULL
;
2911 /* Set session base_path */
2912 session
->base_path
= strdup(uris
[i
].subdir
);
2913 if (!session
->base_path
) {
2914 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2915 uris
[i
].subdir
, session
->name
);
2916 ret
= LTTNG_ERR_NOMEM
;
2919 DBG2("Setting base path \"%s\" for session \"%s\"",
2920 session
->base_path
, session
->name
);
2928 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2930 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2931 struct lttng_uri
*uris
)
2934 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2935 struct ltt_ust_session
*usess
= session
->ust_session
;
2941 /* Can't set consumer URI if the session is active. */
2942 if (session
->active
) {
2943 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2948 * Set the session base path if any. This is done inside
2949 * cmd_set_consumer_uri to preserve backward compatibility of the
2950 * previous session creation api vs the session descriptor api.
2952 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2953 if (ret
!= LTTNG_OK
) {
2957 /* Set the "global" consumer URIs */
2958 for (i
= 0; i
< nb_uri
; i
++) {
2959 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2961 if (ret
!= LTTNG_OK
) {
2966 /* Set UST session URIs */
2967 if (session
->ust_session
) {
2968 for (i
= 0; i
< nb_uri
; i
++) {
2969 ret
= add_uri_to_consumer(session
,
2970 session
->ust_session
->consumer
,
2971 &uris
[i
], LTTNG_DOMAIN_UST
);
2972 if (ret
!= LTTNG_OK
) {
2978 /* Set kernel session URIs */
2979 if (session
->kernel_session
) {
2980 for (i
= 0; i
< nb_uri
; i
++) {
2981 ret
= add_uri_to_consumer(session
,
2982 session
->kernel_session
->consumer
,
2983 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2984 if (ret
!= LTTNG_OK
) {
2991 * Make sure to set the session in output mode after we set URI since a
2992 * session can be created without URL (thus flagged in no output mode).
2994 session
->output_traces
= 1;
2996 ksess
->output_traces
= 1;
3000 usess
->output_traces
= 1;
3011 enum lttng_error_code
set_session_output_from_descriptor(
3012 struct ltt_session
*session
,
3013 const struct lttng_session_descriptor
*descriptor
)
3016 enum lttng_error_code ret_code
= LTTNG_OK
;
3017 enum lttng_session_descriptor_type session_type
=
3018 lttng_session_descriptor_get_type(descriptor
);
3019 enum lttng_session_descriptor_output_type output_type
=
3020 lttng_session_descriptor_get_output_type(descriptor
);
3021 struct lttng_uri uris
[2] = {};
3022 size_t uri_count
= 0;
3024 switch (output_type
) {
3025 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
3027 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
3028 lttng_session_descriptor_get_local_output_uri(descriptor
,
3032 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3033 lttng_session_descriptor_get_network_output_uris(descriptor
,
3034 &uris
[0], &uris
[1]);
3038 ret_code
= LTTNG_ERR_INVALID
;
3042 switch (session_type
) {
3043 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3045 struct snapshot_output
*new_output
= NULL
;
3047 new_output
= snapshot_output_alloc();
3049 ret_code
= LTTNG_ERR_NOMEM
;
3053 ret
= snapshot_output_init_with_uri(session
,
3054 DEFAULT_SNAPSHOT_MAX_SIZE
,
3055 NULL
, uris
, uri_count
, session
->consumer
,
3056 new_output
, &session
->snapshot
);
3058 ret_code
= (ret
== -ENOMEM
) ?
3059 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3060 snapshot_output_destroy(new_output
);
3063 snapshot_add_output(&session
->snapshot
, new_output
);
3066 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3067 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3069 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3073 ret_code
= LTTNG_ERR_INVALID
;
3081 enum lttng_error_code
cmd_create_session_from_descriptor(
3082 struct lttng_session_descriptor
*descriptor
,
3083 const lttng_sock_cred
*creds
,
3084 const char *home_path
)
3087 enum lttng_error_code ret_code
;
3088 const char *session_name
;
3089 struct ltt_session
*new_session
= NULL
;
3090 enum lttng_session_descriptor_status descriptor_status
;
3092 session_lock_list();
3094 if (*home_path
!= '/') {
3095 ERR("Home path provided by client is not absolute");
3096 ret_code
= LTTNG_ERR_INVALID
;
3101 descriptor_status
= lttng_session_descriptor_get_session_name(
3102 descriptor
, &session_name
);
3103 switch (descriptor_status
) {
3104 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3106 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3107 session_name
= NULL
;
3110 ret_code
= LTTNG_ERR_INVALID
;
3114 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3116 if (ret_code
!= LTTNG_OK
) {
3120 if (!session_name
) {
3121 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3124 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3129 if (!lttng_session_descriptor_is_output_destination_initialized(
3132 * Only include the session's creation time in the output
3133 * destination if the name of the session itself was
3134 * not auto-generated.
3136 ret_code
= lttng_session_descriptor_set_default_output(
3138 session_name
? &new_session
->creation_time
: NULL
,
3140 if (ret_code
!= LTTNG_OK
) {
3144 new_session
->has_user_specified_directory
=
3145 lttng_session_descriptor_has_output_directory(
3149 switch (lttng_session_descriptor_get_type(descriptor
)) {
3150 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3151 new_session
->snapshot_mode
= 1;
3153 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3154 new_session
->live_timer
=
3155 lttng_session_descriptor_live_get_timer_interval(
3162 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3163 if (ret_code
!= LTTNG_OK
) {
3166 new_session
->consumer
->enabled
= 1;
3167 ret_code
= LTTNG_OK
;
3169 /* Release reference provided by the session_create function. */
3170 session_put(new_session
);
3171 if (ret_code
!= LTTNG_OK
&& new_session
) {
3172 /* Release the global reference on error. */
3173 session_destroy(new_session
);
3175 session_unlock_list();
3179 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3180 struct lttng_session_descriptor
**return_descriptor
)
3183 size_t payload_size
;
3184 struct lttng_dynamic_buffer payload
;
3185 struct lttng_buffer_view home_dir_view
;
3186 struct lttng_buffer_view session_descriptor_view
;
3187 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3188 enum lttng_error_code ret_code
;
3190 lttng_dynamic_buffer_init(&payload
);
3191 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3193 ret_code
= LTTNG_ERR_INVALID
;
3196 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3197 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3198 ret_code
= LTTNG_ERR_INVALID
;
3202 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3203 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3204 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3206 ret_code
= LTTNG_ERR_NOMEM
;
3210 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3212 ERR("Reception of session descriptor failed, aborting.");
3213 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3217 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3220 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3221 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3223 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3224 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3226 ret
= lttng_session_descriptor_create_from_buffer(
3227 &session_descriptor_view
, &session_descriptor
);
3229 ERR("Failed to create session descriptor from payload of \"create session\" command");
3230 ret_code
= LTTNG_ERR_INVALID
;
3235 * Sets the descriptor's auto-generated properties (name, output) if
3238 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3240 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3241 if (ret_code
!= LTTNG_OK
) {
3245 ret_code
= LTTNG_OK
;
3246 *return_descriptor
= session_descriptor
;
3247 session_descriptor
= NULL
;
3249 lttng_dynamic_buffer_reset(&payload
);
3250 lttng_session_descriptor_destroy(session_descriptor
);
3255 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3256 void *_reply_context
)
3260 const struct cmd_destroy_session_reply_context
*reply_context
=
3262 struct lttng_dynamic_buffer payload
;
3263 struct lttcomm_session_destroy_command_header cmd_header
;
3264 struct lttng_trace_archive_location
*location
= NULL
;
3265 struct lttcomm_lttng_msg llm
= {
3266 .cmd_type
= LTTNG_DESTROY_SESSION
,
3267 .ret_code
= reply_context
->destruction_status
,
3270 sizeof(struct lttcomm_session_destroy_command_header
),
3273 size_t payload_size_before_location
;
3275 lttng_dynamic_buffer_init(&payload
);
3277 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3279 ERR("Failed to append session destruction message");
3283 cmd_header
.rotation_state
=
3284 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3285 session
->rotation_state
:
3286 LTTNG_ROTATION_STATE_NO_ROTATION
);
3287 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3288 sizeof(cmd_header
));
3290 ERR("Failed to append session destruction command header");
3294 if (!reply_context
->implicit_rotation_on_destroy
) {
3295 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3299 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3300 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3305 location
= session_get_trace_archive_location(session
);
3307 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3312 payload_size_before_location
= payload
.size
;
3313 comm_ret
= lttng_trace_archive_location_serialize(location
,
3315 lttng_trace_archive_location_put(location
);
3317 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3321 /* Update the message to indicate the location's length. */
3322 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3323 payload
.size
- payload_size_before_location
;
3325 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3326 payload
.data
, payload
.size
);
3327 if (comm_ret
!= (ssize_t
) payload
.size
) {
3328 ERR("Failed to send result of the destruction of session \"%s\" to client",
3332 ret
= close(reply_context
->reply_sock_fd
);
3334 PERROR("Failed to close client socket in deferred session destroy reply");
3336 lttng_dynamic_buffer_reset(&payload
);
3337 free(_reply_context
);
3341 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3343 * Called with session lock held.
3345 int cmd_destroy_session(struct ltt_session
*session
,
3346 struct notification_thread_handle
*notification_thread_handle
,
3350 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3351 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3354 reply_context
= zmalloc(sizeof(*reply_context
));
3355 if (!reply_context
) {
3356 ret
= LTTNG_ERR_NOMEM
;
3359 reply_context
->reply_sock_fd
= *sock_fd
;
3365 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3367 if (session
->active
) {
3368 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3370 ret
= cmd_stop_trace(session
);
3371 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3372 /* Carry on with the destruction of the session. */
3373 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3374 session
->name
, lttng_strerror(-ret
));
3375 destruction_last_error
= ret
;
3379 if (session
->rotation_schedule_timer_enabled
) {
3380 if (timer_session_rotation_schedule_timer_stop(
3382 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3384 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3388 if (session
->rotate_size
) {
3389 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3390 session
->rotate_size
= 0;
3393 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3395 * Perform a last rotation on destruction if rotations have
3396 * occurred during the session's lifetime.
3398 ret
= cmd_rotate_session(session
, NULL
, false,
3399 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3400 if (ret
!= LTTNG_OK
) {
3401 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3402 session
->name
, lttng_strerror(-ret
));
3403 destruction_last_error
= -ret
;
3405 if (reply_context
) {
3406 reply_context
->implicit_rotation_on_destroy
= true;
3408 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3410 * The user has not triggered a session rotation. However, to
3411 * ensure all data has been consumed, the session is rotated
3412 * to a 'null' trace chunk before it is destroyed.
3414 * This is a "quiet" rotation meaning that no notification is
3415 * emitted and no renaming of the current trace chunk takes
3418 ret
= cmd_rotate_session(session
, NULL
, true,
3419 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3421 * Rotation operations may not be supported by the kernel
3422 * tracer. Hence, do not consider this implicit rotation as
3423 * a session destruction error. The library has already stopped
3424 * the session and waited for pending data; there is nothing
3425 * left to do but complete the destruction of the session.
3427 if (ret
!= LTTNG_OK
&&
3428 ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3429 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3430 session
->name
, lttng_strerror(ret
));
3431 destruction_last_error
= -ret
;
3435 if (session
->shm_path
[0]) {
3437 * When a session is created with an explicit shm_path,
3438 * the consumer daemon will create its shared memory files
3439 * at that location and will *not* unlink them. This is normal
3440 * as the intention of that feature is to make it possible
3441 * to retrieve the content of those files should a crash occur.
3443 * To ensure the content of those files can be used, the
3444 * sessiond daemon will replicate the content of the metadata
3445 * cache in a metadata file.
3447 * On clean-up, it is expected that the consumer daemon will
3448 * unlink the shared memory files and that the session daemon
3449 * will unlink the metadata file. Then, the session's directory
3450 * in the shm path can be removed.
3452 * Unfortunately, a flaw in the design of the sessiond's and
3453 * consumerd's tear down of channels makes it impossible to
3454 * determine when the sessiond _and_ the consumerd have both
3455 * destroyed their representation of a channel. For one, the
3456 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3457 * callbacks in both daemons.
3459 * However, it is also impossible for the sessiond to know when
3460 * the consumer daemon is done destroying its channel(s) since
3461 * it occurs as a reaction to the closing of the channel's file
3462 * descriptor. There is no resulting communication initiated
3463 * from the consumerd to the sessiond to confirm that the
3464 * operation is completed (and was successful).
3466 * Until this is all fixed, the session daemon checks for the
3467 * removal of the session's shm path which makes it possible
3468 * to safely advertise a session as having been destroyed.
3470 * Prior to this fix, it was not possible to reliably save
3471 * a session making use of the --shm-path option, destroy it,
3472 * and load it again. This is because the creation of the
3473 * session would fail upon seeing the session's shm path
3474 * already in existence.
3476 * Note that none of the error paths in the check for the
3477 * directory's existence return an error. This is normal
3478 * as there isn't much that can be done. The session will
3479 * be destroyed properly, except that we can't offer the
3480 * guarantee that the same session can be re-created.
3482 current_completion_handler
= &destroy_completion_handler
.handler
;
3483 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3485 sizeof(destroy_completion_handler
.shm_path
));
3490 * The session is destroyed. However, note that the command context
3491 * still holds a reference to the session, thus delaying its destruction
3492 * _at least_ up to the point when that reference is released.
3494 session_destroy(session
);
3495 if (reply_context
) {
3496 reply_context
->destruction_status
= destruction_last_error
;
3497 ret
= session_add_destroy_notifier(session
,
3498 cmd_destroy_session_reply
,
3499 (void *) reply_context
);
3501 ret
= LTTNG_ERR_FATAL
;
3513 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3515 int cmd_register_consumer(struct ltt_session
*session
,
3516 enum lttng_domain_type domain
, const char *sock_path
,
3517 struct consumer_data
*cdata
)
3520 struct consumer_socket
*socket
= NULL
;
3527 case LTTNG_DOMAIN_KERNEL
:
3529 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3533 /* Can't register a consumer if there is already one */
3534 if (ksess
->consumer_fds_sent
!= 0) {
3535 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3539 sock
= lttcomm_connect_unix_sock(sock_path
);
3541 ret
= LTTNG_ERR_CONNECT_FAIL
;
3544 cdata
->cmd_sock
= sock
;
3546 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3547 if (socket
== NULL
) {
3550 PERROR("close register consumer");
3552 cdata
->cmd_sock
= -1;
3553 ret
= LTTNG_ERR_FATAL
;
3557 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3558 if (socket
->lock
== NULL
) {
3559 PERROR("zmalloc pthread mutex");
3560 ret
= LTTNG_ERR_FATAL
;
3563 pthread_mutex_init(socket
->lock
, NULL
);
3564 socket
->registered
= 1;
3567 consumer_add_socket(socket
, ksess
->consumer
);
3570 pthread_mutex_lock(&cdata
->pid_mutex
);
3572 pthread_mutex_unlock(&cdata
->pid_mutex
);
3577 /* TODO: Userspace tracing */
3578 ret
= LTTNG_ERR_UND
;
3586 consumer_destroy_socket(socket
);
3592 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3594 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3595 struct lttng_domain
**domains
)
3600 struct lttng_ht_iter iter
;
3602 if (session
->kernel_session
!= NULL
) {
3603 DBG3("Listing domains found kernel domain");
3607 if (session
->ust_session
!= NULL
) {
3608 DBG3("Listing domains found UST global domain");
3612 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3614 if (agt
->being_used
) {
3625 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3626 if (*domains
== NULL
) {
3627 ret
= LTTNG_ERR_FATAL
;
3631 if (session
->kernel_session
!= NULL
) {
3632 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3634 /* Kernel session buffer type is always GLOBAL */
3635 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3640 if (session
->ust_session
!= NULL
) {
3641 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3642 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3646 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3648 if (agt
->being_used
) {
3649 (*domains
)[index
].type
= agt
->domain
;
3650 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3660 /* Return negative value to differentiate return code */
3666 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3668 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3669 struct ltt_session
*session
, struct lttng_channel
**channels
)
3671 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3674 case LTTNG_DOMAIN_KERNEL
:
3675 if (session
->kernel_session
!= NULL
) {
3676 nb_chan
= session
->kernel_session
->channel_count
;
3678 DBG3("Number of kernel channels %zd", nb_chan
);
3680 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3684 case LTTNG_DOMAIN_UST
:
3685 if (session
->ust_session
!= NULL
) {
3687 nb_chan
= lttng_ht_get_count(
3688 session
->ust_session
->domain_global
.channels
);
3691 DBG3("Number of UST global channels %zd", nb_chan
);
3693 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3698 ret
= -LTTNG_ERR_UND
;
3703 const size_t channel_size
= sizeof(struct lttng_channel
) +
3704 sizeof(struct lttng_channel_extended
);
3705 struct lttng_channel_extended
*channel_exts
;
3707 payload_size
= nb_chan
* channel_size
;
3708 *channels
= zmalloc(payload_size
);
3709 if (*channels
== NULL
) {
3710 ret
= -LTTNG_ERR_FATAL
;
3714 channel_exts
= ((void *) *channels
) +
3715 (nb_chan
* sizeof(struct lttng_channel
));
3716 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3717 if (ret
!= LTTNG_OK
) {
3732 * Command LTTNG_LIST_EVENTS processed by the client thread.
3734 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3735 struct ltt_session
*session
, char *channel_name
,
3736 struct lttng_event
**events
, size_t *total_size
)
3739 ssize_t nb_event
= 0;
3742 case LTTNG_DOMAIN_KERNEL
:
3743 if (session
->kernel_session
!= NULL
) {
3744 nb_event
= list_lttng_kernel_events(channel_name
,
3745 session
->kernel_session
, events
,
3749 case LTTNG_DOMAIN_UST
:
3751 if (session
->ust_session
!= NULL
) {
3752 nb_event
= list_lttng_ust_global_events(channel_name
,
3753 &session
->ust_session
->domain_global
, events
,
3758 case LTTNG_DOMAIN_LOG4J
:
3759 case LTTNG_DOMAIN_JUL
:
3760 case LTTNG_DOMAIN_PYTHON
:
3761 if (session
->ust_session
) {
3762 struct lttng_ht_iter iter
;
3766 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3767 &iter
.iter
, agt
, node
.node
) {
3768 if (agt
->domain
== domain
) {
3769 nb_event
= list_lttng_agent_events(
3779 ret
= LTTNG_ERR_UND
;
3786 /* Return negative value to differentiate return code */
3791 * Using the session list, filled a lttng_session array to send back to the
3792 * client for session listing.
3794 * The session list lock MUST be acquired before calling this function. Use
3795 * session_lock_list() and session_unlock_list().
3797 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3798 size_t session_count
, uid_t uid
, gid_t gid
)
3802 struct ltt_session
*session
;
3803 struct ltt_session_list
*list
= session_get_list();
3804 struct lttng_session_extended
*extended
=
3805 (typeof(extended
)) (&sessions
[session_count
]);
3807 DBG("Getting all available session for UID %d GID %d",
3810 * Iterate over session list and append data after the control struct in
3813 cds_list_for_each_entry(session
, &list
->head
, list
) {
3814 if (!session_get(session
)) {
3818 * Only list the sessions the user can control.
3820 if (!session_access_ok(session
, uid
, gid
) ||
3821 session
->destroyed
) {
3822 session_put(session
);
3826 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3827 struct ltt_ust_session
*usess
= session
->ust_session
;
3829 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3830 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3831 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3832 ret
= build_network_session_path(sessions
[i
].path
,
3833 sizeof(sessions
[i
].path
), session
);
3835 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3836 session
->consumer
->dst
.session_root_path
);
3839 PERROR("snprintf session path");
3840 session_put(session
);
3844 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3845 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3846 sessions
[i
].enabled
= session
->active
;
3847 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3848 sessions
[i
].live_timer_interval
= session
->live_timer
;
3849 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3850 extended
[i
].creation_time
.is_set
= 1;
3852 session_put(session
);
3857 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3858 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3860 int cmd_data_pending(struct ltt_session
*session
)
3863 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3864 struct ltt_ust_session
*usess
= session
->ust_session
;
3868 DBG("Data pending for session %s", session
->name
);
3870 /* Session MUST be stopped to ask for data availability. */
3871 if (session
->active
) {
3872 ret
= LTTNG_ERR_SESSION_STARTED
;
3876 * If stopped, just make sure we've started before else the above call
3877 * will always send that there is data pending.
3879 * The consumer assumes that when the data pending command is received,
3880 * the trace has been started before or else no output data is written
3881 * by the streams which is a condition for data pending. So, this is
3882 * *VERY* important that we don't ask the consumer before a start
3885 if (!session
->has_been_started
) {
3891 /* A rotation is still pending, we have to wait. */
3892 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3893 DBG("Rotate still pending for session %s", session
->name
);
3898 if (ksess
&& ksess
->consumer
) {
3899 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3901 /* Data is still being extracted for the kernel. */
3906 if (usess
&& usess
->consumer
) {
3907 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3909 /* Data is still being extracted for the kernel. */
3914 /* Data is ready to be read by a viewer */
3922 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3924 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3926 int cmd_snapshot_add_output(struct ltt_session
*session
,
3927 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3930 struct snapshot_output
*new_output
;
3935 DBG("Cmd snapshot add output for session %s", session
->name
);
3938 * Can't create an output if the session is not set in no-output mode.
3940 if (session
->output_traces
) {
3941 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3945 if (session
->has_non_mmap_channel
) {
3946 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3950 /* Only one output is allowed until we have the "tee" feature. */
3951 if (session
->snapshot
.nb_output
== 1) {
3952 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3956 new_output
= snapshot_output_alloc();
3958 ret
= LTTNG_ERR_NOMEM
;
3962 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3963 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3964 &session
->snapshot
);
3966 if (ret
== -ENOMEM
) {
3967 ret
= LTTNG_ERR_NOMEM
;
3969 ret
= LTTNG_ERR_INVALID
;
3975 snapshot_add_output(&session
->snapshot
, new_output
);
3977 *id
= new_output
->id
;
3984 snapshot_output_destroy(new_output
);
3990 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3992 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3994 int cmd_snapshot_del_output(struct ltt_session
*session
,
3995 const struct lttng_snapshot_output
*output
)
3998 struct snapshot_output
*sout
= NULL
;
4006 * Permission denied to create an output if the session is not
4007 * set in no output mode.
4009 if (session
->output_traces
) {
4010 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4015 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
4017 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4018 } else if (*output
->name
!= '\0') {
4019 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
4021 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4024 ret
= LTTNG_ERR_INVALID
;
4028 snapshot_delete_output(&session
->snapshot
, sout
);
4029 snapshot_output_destroy(sout
);
4038 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4040 * If no output is available, outputs is untouched and 0 is returned.
4042 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4044 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4045 struct lttng_snapshot_output
**outputs
)
4048 struct lttng_snapshot_output
*list
= NULL
;
4049 struct lttng_ht_iter iter
;
4050 struct snapshot_output
*output
;
4055 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4058 * Permission denied to create an output if the session is not
4059 * set in no output mode.
4061 if (session
->output_traces
) {
4062 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4066 if (session
->snapshot
.nb_output
== 0) {
4071 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4073 ret
= -LTTNG_ERR_NOMEM
;
4077 /* Copy list from session to the new list object. */
4079 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4080 output
, node
.node
) {
4081 assert(output
->consumer
);
4082 list
[idx
].id
= output
->id
;
4083 list
[idx
].max_size
= output
->max_size
;
4084 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4085 sizeof(list
[idx
].name
))) {
4086 ret
= -LTTNG_ERR_INVALID
;
4089 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4090 if (lttng_strncpy(list
[idx
].ctrl_url
,
4091 output
->consumer
->dst
.session_root_path
,
4092 sizeof(list
[idx
].ctrl_url
))) {
4093 ret
= -LTTNG_ERR_INVALID
;
4098 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4099 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4101 ret
= -LTTNG_ERR_NOMEM
;
4106 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4107 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4109 ret
= -LTTNG_ERR_NOMEM
;
4118 ret
= session
->snapshot
.nb_output
;
4127 * Check if we can regenerate the metadata for this session.
4128 * Only kernel, UST per-uid and non-live sessions are supported.
4130 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4133 int check_regenerate_metadata_support(struct ltt_session
*session
)
4139 if (session
->live_timer
!= 0) {
4140 ret
= LTTNG_ERR_LIVE_SESSION
;
4143 if (!session
->active
) {
4144 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4147 if (session
->ust_session
) {
4148 switch (session
->ust_session
->buffer_type
) {
4149 case LTTNG_BUFFER_PER_UID
:
4151 case LTTNG_BUFFER_PER_PID
:
4152 ret
= LTTNG_ERR_PER_PID_SESSION
;
4156 ret
= LTTNG_ERR_UNK
;
4160 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4161 session
->consumer
->relay_minor_version
< 8) {
4162 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4172 int clear_metadata_file(int fd
)
4177 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4178 if (lseek_ret
< 0) {
4184 ret
= ftruncate(fd
, 0);
4186 PERROR("ftruncate");
4195 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4198 struct buffer_reg_uid
*uid_reg
= NULL
;
4199 struct buffer_reg_session
*session_reg
= NULL
;
4202 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4203 struct ust_registry_session
*registry
;
4204 struct ust_registry_channel
*chan
;
4205 struct lttng_ht_iter iter_chan
;
4207 session_reg
= uid_reg
->registry
;
4208 registry
= session_reg
->reg
.ust
;
4210 pthread_mutex_lock(®istry
->lock
);
4211 registry
->metadata_len_sent
= 0;
4212 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4213 registry
->metadata_len
= 0;
4214 registry
->metadata_version
++;
4215 if (registry
->metadata_fd
> 0) {
4216 /* Clear the metadata file's content. */
4217 ret
= clear_metadata_file(registry
->metadata_fd
);
4219 pthread_mutex_unlock(®istry
->lock
);
4224 ret
= ust_metadata_session_statedump(registry
, NULL
,
4225 registry
->major
, registry
->minor
);
4227 pthread_mutex_unlock(®istry
->lock
);
4228 ERR("Failed to generate session metadata (err = %d)",
4232 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4234 struct ust_registry_event
*event
;
4235 struct lttng_ht_iter iter_event
;
4237 ret
= ust_metadata_channel_statedump(registry
, chan
);
4239 pthread_mutex_unlock(®istry
->lock
);
4240 ERR("Failed to generate channel metadata "
4244 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4246 ret
= ust_metadata_event_statedump(registry
,
4249 pthread_mutex_unlock(®istry
->lock
);
4250 ERR("Failed to generate event metadata "
4256 pthread_mutex_unlock(®istry
->lock
);
4265 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4267 * Ask the consumer to truncate the existing metadata file(s) and
4268 * then regenerate the metadata. Live and per-pid sessions are not
4269 * supported and return an error.
4271 * Return 0 on success or else a LTTNG_ERR code.
4273 int cmd_regenerate_metadata(struct ltt_session
*session
)
4279 ret
= check_regenerate_metadata_support(session
);
4284 if (session
->kernel_session
) {
4285 ret
= kernctl_session_regenerate_metadata(
4286 session
->kernel_session
->fd
);
4288 ERR("Failed to regenerate the kernel metadata");
4293 if (session
->ust_session
) {
4294 ret
= ust_regenerate_metadata(session
->ust_session
);
4296 ERR("Failed to regenerate the UST metadata");
4300 DBG("Cmd metadata regenerate for session %s", session
->name
);
4308 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4310 * Ask the tracer to regenerate a new statedump.
4312 * Return 0 on success or else a LTTNG_ERR code.
4314 int cmd_regenerate_statedump(struct ltt_session
*session
)
4320 if (!session
->active
) {
4321 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4325 if (session
->kernel_session
) {
4326 ret
= kernctl_session_regenerate_statedump(
4327 session
->kernel_session
->fd
);
4329 * Currently, the statedump in kernel can only fail if out
4333 if (ret
== -ENOMEM
) {
4334 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4336 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4338 ERR("Failed to regenerate the kernel statedump");
4343 if (session
->ust_session
) {
4344 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4346 * Currently, the statedump in UST always returns 0.
4349 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4350 ERR("Failed to regenerate the UST statedump");
4354 DBG("Cmd regenerate statedump for session %s", session
->name
);
4361 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4362 struct notification_thread_handle
*notification_thread
)
4366 ssize_t sock_recv_len
;
4367 struct lttng_trigger
*trigger
= NULL
;
4368 struct lttng_buffer_view view
;
4369 struct lttng_dynamic_buffer trigger_buffer
;
4371 lttng_dynamic_buffer_init(&trigger_buffer
);
4372 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4373 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4375 ret
= LTTNG_ERR_NOMEM
;
4379 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4381 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4382 ERR("Failed to receive \"register trigger\" command payload");
4383 /* TODO: should this be a new error enum ? */
4384 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4388 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4389 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4391 ERR("Invalid trigger payload received in \"register trigger\" command");
4392 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4396 ret
= notification_thread_command_register_trigger(notification_thread
,
4398 /* Ownership of trigger was transferred. */
4401 lttng_trigger_destroy(trigger
);
4402 lttng_dynamic_buffer_reset(&trigger_buffer
);
4406 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4407 struct notification_thread_handle
*notification_thread
)
4411 ssize_t sock_recv_len
;
4412 struct lttng_trigger
*trigger
= NULL
;
4413 struct lttng_buffer_view view
;
4414 struct lttng_dynamic_buffer trigger_buffer
;
4416 lttng_dynamic_buffer_init(&trigger_buffer
);
4417 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4418 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4420 ret
= LTTNG_ERR_NOMEM
;
4424 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4426 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4427 ERR("Failed to receive \"unregister trigger\" command payload");
4428 /* TODO: should this be a new error enum ? */
4429 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4433 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4434 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4436 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4437 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4441 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4444 lttng_trigger_destroy(trigger
);
4445 lttng_dynamic_buffer_reset(&trigger_buffer
);
4450 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4451 * snapshot output is *not* set with a remote destination.
4453 * Return LTTNG_OK on success or a LTTNG_ERR code.
4455 static enum lttng_error_code
set_relayd_for_snapshot(
4456 struct consumer_output
*output
,
4457 const struct ltt_session
*session
)
4459 enum lttng_error_code status
= LTTNG_OK
;
4460 struct lttng_ht_iter iter
;
4461 struct consumer_socket
*socket
;
4462 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4463 const char *base_path
;
4468 DBG2("Set relayd object from snapshot output");
4470 if (session
->current_trace_chunk
) {
4471 enum lttng_trace_chunk_status chunk_status
=
4472 lttng_trace_chunk_get_id(
4473 session
->current_trace_chunk
,
4474 ¤t_chunk_id
.value
);
4476 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4477 current_chunk_id
.is_set
= true;
4479 ERR("Failed to get current trace chunk id");
4480 status
= LTTNG_ERR_UNK
;
4485 /* Ignore if snapshot consumer output is not network. */
4486 if (output
->type
!= CONSUMER_DST_NET
) {
4491 * The snapshot record URI base path overrides the session
4494 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4495 base_path
= output
->dst
.net
.control
.subdir
;
4497 base_path
= session
->base_path
;
4501 * For each consumer socket, create and send the relayd object of the
4505 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4506 socket
, node
.node
) {
4507 pthread_mutex_lock(socket
->lock
);
4508 status
= send_consumer_relayd_sockets(0, session
->id
,
4510 session
->name
, session
->hostname
,
4512 session
->live_timer
,
4513 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4514 session
->creation_time
,
4515 session
->name_contains_creation_time
);
4516 pthread_mutex_unlock(socket
->lock
);
4517 if (status
!= LTTNG_OK
) {
4529 * Record a kernel snapshot.
4531 * Return LTTNG_OK on success or a LTTNG_ERR code.
4533 static enum lttng_error_code
record_kernel_snapshot(
4534 struct ltt_kernel_session
*ksess
,
4535 const struct consumer_output
*output
,
4536 const struct ltt_session
*session
,
4537 int wait
, uint64_t nb_packets_per_stream
)
4539 enum lttng_error_code status
;
4545 status
= kernel_snapshot_record(
4546 ksess
, output
, wait
, nb_packets_per_stream
);
4551 * Record a UST snapshot.
4553 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4555 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4556 const struct consumer_output
*output
,
4557 const struct ltt_session
*session
,
4558 int wait
, uint64_t nb_packets_per_stream
)
4560 enum lttng_error_code status
;
4566 status
= ust_app_snapshot_record(
4567 usess
, output
, wait
, nb_packets_per_stream
);
4572 uint64_t get_session_size_one_more_packet_per_stream(
4573 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4575 uint64_t tot_size
= 0;
4577 if (session
->kernel_session
) {
4578 struct ltt_kernel_channel
*chan
;
4579 const struct ltt_kernel_session
*ksess
=
4580 session
->kernel_session
;
4582 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4583 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4585 * Don't take channel into account if we
4586 * already grab all its packets.
4590 tot_size
+= chan
->channel
->attr
.subbuf_size
4591 * chan
->stream_count
;
4595 if (session
->ust_session
) {
4596 const struct ltt_ust_session
*usess
= session
->ust_session
;
4598 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4606 * Calculate the number of packets we can grab from each stream that
4607 * fits within the overall snapshot max size.
4609 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4610 * the number of packets per stream.
4612 * TODO: this approach is not perfect: we consider the worse case
4613 * (packet filling the sub-buffers) as an upper bound, but we could do
4614 * better if we do this calculation while we actually grab the packet
4615 * content: we would know how much padding we don't actually store into
4618 * This algorithm is currently bounded by the number of packets per
4621 * Since we call this algorithm before actually grabbing the data, it's
4622 * an approximation: for instance, applications could appear/disappear
4623 * in between this call and actually grabbing data.
4626 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4630 uint64_t cur_nb_packets
= 0;
4633 return 0; /* Infinite */
4636 size_left
= max_size
;
4638 uint64_t one_more_packet_tot_size
;
4640 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4641 session
, cur_nb_packets
);
4642 if (!one_more_packet_tot_size
) {
4643 /* We are already grabbing all packets. */
4646 size_left
-= one_more_packet_tot_size
;
4647 if (size_left
< 0) {
4652 if (!cur_nb_packets
&& size_left
!= max_size
) {
4653 /* Not enough room to grab one packet of each stream, error. */
4656 return cur_nb_packets
;
4660 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4661 const struct snapshot_output
*snapshot_output
, int wait
)
4663 int64_t nb_packets_per_stream
;
4664 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4666 enum lttng_error_code ret_code
= LTTNG_OK
;
4667 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4668 struct consumer_output
*original_ust_consumer_output
= NULL
;
4669 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4670 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4671 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4673 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4675 snapshot_output
->name
,
4676 snapshot_output
->datetime
,
4677 snapshot_output
->nb_snapshot
);
4678 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4679 ERR("Failed to format snapshot name");
4680 ret_code
= LTTNG_ERR_INVALID
;
4683 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4684 snapshot_output
->name
, session
->name
,
4685 snapshot_chunk_name
);
4686 if (!session
->kernel_session
&& !session
->ust_session
) {
4687 ERR("Failed to record snapshot as no channels exist");
4688 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4692 if (session
->kernel_session
) {
4693 original_kernel_consumer_output
=
4694 session
->kernel_session
->consumer
;
4695 snapshot_kernel_consumer_output
=
4696 consumer_copy_output(snapshot_output
->consumer
);
4697 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4698 snapshot_chunk_name
);
4700 /* Copy the original domain subdir. */
4701 strcpy(snapshot_kernel_consumer_output
->domain_subdir
,
4702 original_kernel_consumer_output
->domain_subdir
);
4704 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4705 original_kernel_consumer_output
);
4707 ERR("Failed to copy consumer sockets from snapshot output configuration");
4708 ret_code
= LTTNG_ERR_NOMEM
;
4711 ret_code
= set_relayd_for_snapshot(
4712 snapshot_kernel_consumer_output
, session
);
4713 if (ret_code
!= LTTNG_OK
) {
4714 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4717 session
->kernel_session
->consumer
=
4718 snapshot_kernel_consumer_output
;
4720 if (session
->ust_session
) {
4721 original_ust_consumer_output
= session
->ust_session
->consumer
;
4722 snapshot_ust_consumer_output
=
4723 consumer_copy_output(snapshot_output
->consumer
);
4724 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4725 snapshot_chunk_name
);
4727 /* Copy the original domain subdir. */
4728 strcpy(snapshot_ust_consumer_output
->domain_subdir
,
4729 original_ust_consumer_output
->domain_subdir
);
4731 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4732 original_ust_consumer_output
);
4734 ERR("Failed to copy consumer sockets from snapshot output configuration");
4735 ret_code
= LTTNG_ERR_NOMEM
;
4738 ret_code
= set_relayd_for_snapshot(
4739 snapshot_ust_consumer_output
, session
);
4740 if (ret_code
!= LTTNG_OK
) {
4741 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4744 session
->ust_session
->consumer
=
4745 snapshot_ust_consumer_output
;
4748 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4749 snapshot_kernel_consumer_output
?:
4750 snapshot_ust_consumer_output
,
4751 consumer_output_get_base_path(
4752 snapshot_output
->consumer
),
4753 snapshot_chunk_name
);
4754 if (!snapshot_trace_chunk
) {
4755 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
4757 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
4760 assert(!session
->current_trace_chunk
);
4761 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
4762 lttng_trace_chunk_put(snapshot_trace_chunk
);
4763 snapshot_trace_chunk
= NULL
;
4765 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
4767 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
4771 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
4772 snapshot_output
->max_size
);
4773 if (nb_packets_per_stream
< 0) {
4774 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
4775 goto error_close_trace_chunk
;
4778 if (session
->kernel_session
) {
4779 ret_code
= record_kernel_snapshot(session
->kernel_session
,
4780 snapshot_kernel_consumer_output
, session
,
4781 wait
, nb_packets_per_stream
);
4782 if (ret_code
!= LTTNG_OK
) {
4783 goto error_close_trace_chunk
;
4787 if (session
->ust_session
) {
4788 ret_code
= record_ust_snapshot(session
->ust_session
,
4789 snapshot_ust_consumer_output
, session
,
4790 wait
, nb_packets_per_stream
);
4791 if (ret_code
!= LTTNG_OK
) {
4792 goto error_close_trace_chunk
;
4796 error_close_trace_chunk
:
4797 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
4798 ERR("Failed to release the current trace chunk of session \"%s\"",
4800 ret_code
= LTTNG_ERR_UNK
;
4803 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
4804 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
4806 * Don't goto end; make sure the chunk is closed for the session
4807 * to allow future snapshots.
4809 ERR("Failed to close snapshot trace chunk of session \"%s\"",
4811 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
4814 lttng_trace_chunk_put(snapshot_trace_chunk
);
4815 snapshot_trace_chunk
= NULL
;
4817 if (original_ust_consumer_output
) {
4818 session
->ust_session
->consumer
= original_ust_consumer_output
;
4820 if (original_kernel_consumer_output
) {
4821 session
->kernel_session
->consumer
=
4822 original_kernel_consumer_output
;
4824 consumer_output_put(snapshot_ust_consumer_output
);
4825 consumer_output_put(snapshot_kernel_consumer_output
);
4830 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
4832 * The wait parameter is ignored so this call always wait for the snapshot to
4833 * complete before returning.
4835 * Return LTTNG_OK on success or else a LTTNG_ERR code.
4837 int cmd_snapshot_record(struct ltt_session
*session
,
4838 const struct lttng_snapshot_output
*output
, int wait
)
4840 enum lttng_error_code cmd_ret
= LTTNG_OK
;
4842 unsigned int snapshot_success
= 0;
4844 struct snapshot_output
*tmp_output
= NULL
;
4849 DBG("Cmd snapshot record for session %s", session
->name
);
4851 /* Get the datetime for the snapshot output directory. */
4852 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
4855 cmd_ret
= LTTNG_ERR_INVALID
;
4860 * Permission denied to create an output if the session is not
4861 * set in no output mode.
4863 if (session
->output_traces
) {
4864 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4868 /* The session needs to be started at least once. */
4869 if (!session
->has_been_started
) {
4870 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
4874 /* Use temporary output for the session. */
4875 if (*output
->ctrl_url
!= '\0') {
4876 tmp_output
= snapshot_output_alloc();
4878 cmd_ret
= LTTNG_ERR_NOMEM
;
4882 ret
= snapshot_output_init(session
, output
->max_size
,
4884 output
->ctrl_url
, output
->data_url
,
4888 if (ret
== -ENOMEM
) {
4889 cmd_ret
= LTTNG_ERR_NOMEM
;
4891 cmd_ret
= LTTNG_ERR_INVALID
;
4895 /* Use the global session count for the temporary snapshot. */
4896 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
4898 /* Use the global datetime */
4899 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
4900 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
4901 if (cmd_ret
!= LTTNG_OK
) {
4904 snapshot_success
= 1;
4906 struct snapshot_output
*sout
;
4907 struct lttng_ht_iter iter
;
4910 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
4911 &iter
.iter
, sout
, node
.node
) {
4912 struct snapshot_output output_copy
;
4915 * Make a local copy of the output and override output
4916 * parameters with those provided as part of the
4919 memcpy(&output_copy
, sout
, sizeof(output_copy
));
4921 if (output
->max_size
!= (uint64_t) -1ULL) {
4922 output_copy
.max_size
= output
->max_size
;
4925 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
4926 memcpy(output_copy
.datetime
, datetime
,
4929 /* Use temporary name. */
4930 if (*output
->name
!= '\0') {
4931 if (lttng_strncpy(output_copy
.name
,
4933 sizeof(output_copy
.name
))) {
4934 cmd_ret
= LTTNG_ERR_INVALID
;
4940 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
4941 if (cmd_ret
!= LTTNG_OK
) {
4945 snapshot_success
= 1;
4950 if (snapshot_success
) {
4951 session
->snapshot
.nb_snapshot
++;
4953 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
4958 snapshot_output_destroy(tmp_output
);
4964 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4966 int cmd_set_session_shm_path(struct ltt_session
*session
,
4967 const char *shm_path
)
4973 * Can only set shm path before session is started.
4975 if (session
->has_been_started
) {
4976 return LTTNG_ERR_SESSION_STARTED
;
4979 strncpy(session
->shm_path
, shm_path
,
4980 sizeof(session
->shm_path
));
4981 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
4987 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4989 * Ask the consumer to rotate the session output directory.
4990 * The session lock must be held.
4992 * Returns LTTNG_OK on success or else a negative LTTng error code.
4994 int cmd_rotate_session(struct ltt_session
*session
,
4995 struct lttng_rotate_session_return
*rotate_return
,
4996 bool quiet_rotation
,
4997 enum lttng_trace_chunk_command_type command
)
5000 uint64_t ongoing_rotation_chunk_id
;
5001 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5002 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
5003 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
5004 enum lttng_trace_chunk_status chunk_status
;
5005 bool failed_to_rotate
= false;
5006 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
5010 if (!session
->has_been_started
) {
5011 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5016 * Explicit rotation is not supported for live sessions.
5017 * However, live sessions can perform a quiet rotation on
5019 * Rotation is not supported for snapshot traces (no output).
5021 if ((!quiet_rotation
&& session
->live_timer
) ||
5022 !session
->output_traces
) {
5023 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5027 /* Unsupported feature in lttng-relayd before 2.11. */
5028 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5029 (session
->consumer
->relay_major_version
== 2 &&
5030 session
->consumer
->relay_minor_version
< 11)) {
5031 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5035 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5036 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5037 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5041 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5042 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5044 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5049 * After a stop, we only allow one rotation to occur, the other ones are
5050 * useless until a new start.
5052 if (session
->rotated_after_last_stop
) {
5053 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5055 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5060 * After a stop followed by a clear, disallow following rotations a they would
5061 * generate empty chunks.
5063 if (session
->cleared_after_last_stop
) {
5064 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5066 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5070 if (session
->active
) {
5071 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
5073 if (!new_trace_chunk
) {
5074 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5080 * The current trace chunk becomes the chunk being archived.
5082 * After this point, "chunk_being_archived" must absolutely
5083 * be closed on the consumer(s), otherwise it will never be
5084 * cleaned-up, which will result in a leak.
5086 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5087 &chunk_being_archived
);
5089 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5093 if (session
->kernel_session
) {
5094 cmd_ret
= kernel_rotate_session(session
);
5095 if (cmd_ret
!= LTTNG_OK
) {
5096 failed_to_rotate
= true;
5097 rotation_fail_code
= cmd_ret
;
5100 if (session
->ust_session
) {
5101 cmd_ret
= ust_app_rotate_session(session
);
5102 if (cmd_ret
!= LTTNG_OK
) {
5103 failed_to_rotate
= true;
5104 rotation_fail_code
= cmd_ret
;
5108 if (!session
->active
) {
5109 session
->rotated_after_last_stop
= true;
5112 if (!chunk_being_archived
) {
5113 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5115 if (failed_to_rotate
) {
5116 cmd_ret
= rotation_fail_code
;
5123 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5124 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5125 &ongoing_rotation_chunk_id
);
5126 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5128 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5129 command
, session
->last_chunk_path
);
5131 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5135 if (failed_to_rotate
) {
5136 cmd_ret
= rotation_fail_code
;
5140 session
->quiet_rotation
= quiet_rotation
;
5141 ret
= timer_session_rotation_pending_check_start(session
,
5142 DEFAULT_ROTATE_PENDING_TIMER
);
5144 cmd_ret
= LTTNG_ERR_UNK
;
5148 if (rotate_return
) {
5149 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5152 session
->chunk_being_archived
= chunk_being_archived
;
5153 chunk_being_archived
= NULL
;
5154 if (!quiet_rotation
) {
5155 ret
= notification_thread_command_session_rotation_ongoing(
5156 notification_thread_handle
,
5157 session
->name
, session
->uid
, session
->gid
,
5158 ongoing_rotation_chunk_id
);
5159 if (ret
!= LTTNG_OK
) {
5160 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5166 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5167 session
->name
, ongoing_rotation_chunk_id
);
5169 lttng_trace_chunk_put(new_trace_chunk
);
5170 lttng_trace_chunk_put(chunk_being_archived
);
5171 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5174 if (session_reset_rotation_state(session
,
5175 LTTNG_ROTATION_STATE_ERROR
)) {
5176 ERR("Failed to reset rotation state of session \"%s\"",
5183 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5185 * Check if the session has finished its rotation.
5187 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5189 int cmd_rotate_get_info(struct ltt_session
*session
,
5190 struct lttng_rotation_get_info_return
*info_return
,
5191 uint64_t rotation_id
)
5193 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5194 enum lttng_rotation_state rotation_state
;
5196 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5197 session
->most_recent_chunk_id
.value
);
5199 if (session
->chunk_being_archived
) {
5200 enum lttng_trace_chunk_status chunk_status
;
5203 chunk_status
= lttng_trace_chunk_get_id(
5204 session
->chunk_being_archived
,
5206 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5208 rotation_state
= rotation_id
== chunk_id
?
5209 LTTNG_ROTATION_STATE_ONGOING
:
5210 LTTNG_ROTATION_STATE_EXPIRED
;
5212 if (session
->last_archived_chunk_id
.is_set
&&
5213 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5214 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5216 rotation_state
= session
->rotation_state
;
5220 switch (rotation_state
) {
5221 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5222 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5225 case LTTNG_ROTATION_STATE_EXPIRED
:
5226 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5227 rotation_id
, session
->name
);
5229 case LTTNG_ROTATION_STATE_ONGOING
:
5230 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5231 rotation_id
, session
->name
);
5233 case LTTNG_ROTATION_STATE_COMPLETED
:
5237 char *current_tracing_path_reply
;
5238 size_t current_tracing_path_reply_len
;
5240 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5241 rotation_id
, session
->name
);
5243 switch (session_get_consumer_destination_type(session
)) {
5244 case CONSUMER_DST_LOCAL
:
5245 current_tracing_path_reply
=
5246 info_return
->location
.local
.absolute_path
;
5247 current_tracing_path_reply_len
=
5248 sizeof(info_return
->location
.local
.absolute_path
);
5249 info_return
->location_type
=
5250 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5251 fmt_ret
= asprintf(&chunk_path
,
5252 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5253 session_get_base_path(session
),
5254 session
->last_archived_chunk_name
);
5255 if (fmt_ret
== -1) {
5256 PERROR("Failed to format the path of the last archived trace chunk");
5257 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5258 cmd_ret
= LTTNG_ERR_UNK
;
5262 case CONSUMER_DST_NET
:
5264 uint16_t ctrl_port
, data_port
;
5266 current_tracing_path_reply
=
5267 info_return
->location
.relay
.relative_path
;
5268 current_tracing_path_reply_len
=
5269 sizeof(info_return
->location
.relay
.relative_path
);
5270 /* Currently the only supported relay protocol. */
5271 info_return
->location
.relay
.protocol
=
5272 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5274 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5275 session_get_net_consumer_hostname(session
),
5276 sizeof(info_return
->location
.relay
.host
));
5278 ERR("Failed to copy host name to rotate_get_info reply");
5279 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5280 cmd_ret
= LTTNG_ERR_SET_URL
;
5284 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5285 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5286 info_return
->location
.relay
.ports
.data
= data_port
;
5287 info_return
->location_type
=
5288 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5289 chunk_path
= strdup(session
->last_chunk_path
);
5291 ERR("Failed to allocate the path of the last archived trace chunk");
5292 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5293 cmd_ret
= LTTNG_ERR_UNK
;
5302 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5303 chunk_path
, current_tracing_path_reply_len
);
5306 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5307 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5308 cmd_ret
= LTTNG_ERR_UNK
;
5314 case LTTNG_ROTATION_STATE_ERROR
:
5315 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5316 rotation_id
, session
->name
);
5324 info_return
->status
= (int32_t) rotation_state
;
5329 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5331 * Configure the automatic rotation parameters.
5332 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5333 * 'activate' to false means deactivate the rotation schedule and validate that
5334 * 'new_value' has the same value as the currently active value.
5336 * Return 0 on success or else a positive LTTNG_ERR code.
5338 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5339 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5341 struct notification_thread_handle
*notification_thread_handle
)
5344 uint64_t *parameter_value
;
5348 DBG("Cmd rotate set schedule session %s", session
->name
);
5350 if (session
->live_timer
|| !session
->output_traces
) {
5351 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5352 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5356 switch (schedule_type
) {
5357 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5358 parameter_value
= &session
->rotate_size
;
5360 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5361 parameter_value
= &session
->rotate_timer_period
;
5362 if (new_value
>= UINT_MAX
) {
5363 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5364 new_value
, UINT_MAX
);
5365 ret
= LTTNG_ERR_INVALID
;
5370 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5371 ret
= LTTNG_ERR_INVALID
;
5375 /* Improper use of the API. */
5376 if (new_value
== -1ULL) {
5377 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5378 ret
= LTTNG_ERR_INVALID
;
5383 * As indicated in struct ltt_session's comments, a value of == 0 means
5384 * this schedule rotation type is not in use.
5386 * Reject the command if we were asked to activate a schedule that was
5389 if (activate
&& *parameter_value
!= 0) {
5390 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5391 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5396 * Reject the command if we were asked to deactivate a schedule that was
5399 if (!activate
&& *parameter_value
== 0) {
5400 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5401 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5406 * Reject the command if we were asked to deactivate a schedule that
5409 if (!activate
&& *parameter_value
!= new_value
) {
5410 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5411 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5415 *parameter_value
= activate
? new_value
: 0;
5417 switch (schedule_type
) {
5418 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5419 if (activate
&& session
->active
) {
5421 * Only start the timer if the session is active,
5422 * otherwise it will be started when the session starts.
5424 ret
= timer_session_rotation_schedule_timer_start(
5425 session
, new_value
);
5427 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5428 ret
= LTTNG_ERR_UNK
;
5432 ret
= timer_session_rotation_schedule_timer_stop(
5435 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5436 ret
= LTTNG_ERR_UNK
;
5441 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5443 ret
= subscribe_session_consumed_size_rotation(session
,
5444 new_value
, notification_thread_handle
);
5446 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5447 ret
= LTTNG_ERR_UNK
;
5451 ret
= unsubscribe_session_consumed_size_rotation(session
,
5452 notification_thread_handle
);
5454 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5455 ret
= LTTNG_ERR_UNK
;
5462 /* Would have been caught before. */
5474 /* Wait for a given path to be removed before continuing. */
5475 static enum lttng_error_code
wait_on_path(void *path_data
)
5477 const char *shm_path
= path_data
;
5479 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5485 ret
= stat(shm_path
, &st
);
5487 if (errno
!= ENOENT
) {
5488 PERROR("stat() returned an error while checking for the existence of the shm path");
5490 DBG("shm path no longer exists, completing the destruction of session");
5494 if (!S_ISDIR(st
.st_mode
)) {
5495 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5500 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5506 * Returns a pointer to a handler to run on completion of a command.
5507 * Returns NULL if no handler has to be run for the last command executed.
5509 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5511 struct cmd_completion_handler
*handler
= current_completion_handler
;
5513 current_completion_handler
= NULL
;
5518 * Init command subsystem.
5523 * Set network sequence index to 1 for streams to match a relayd
5524 * socket on the consumer side.
5526 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5527 relayd_net_seq_idx
= 1;
5528 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5530 DBG("Command subsystem initialized");