#ifndef _LTTNG_UST_CTL_H
#define _LTTNG_UST_CTL_H
-#include <lttng/ust-abi.h>
-#include <sys/types.h>
#include <limits.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <sys/types.h>
+
+#include <lttng/ust-abi.h>
+
+#ifndef LTTNG_PACKED
+#error "LTTNG_PACKED should be defined"
+#endif
#ifndef LTTNG_UST_UUID_LEN
#define LTTNG_UST_UUID_LEN 16
enum lttng_ust_output output; /* splice, mmap */
uint32_t chan_id; /* channel ID */
unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
+ int64_t blocking_timeout; /* Blocking timeout (usec) */
} LTTNG_PACKED;
/*
* API used by sessiond.
*/
+struct lttng_ust_context_attr {
+ enum lttng_ust_context_type ctx;
+ union {
+ struct lttng_ust_perf_counter_ctx perf_counter;
+ struct {
+ char *provider_name;
+ char *ctx_name;
+ } app_ctx;
+ } u;
+};
+
/*
* Error values: all the following functions return:
* >= 0: Success (LTTNG_UST_OK)
int ustctl_create_event(int sock, struct lttng_ust_event *ev,
struct lttng_ust_object_data *channel_data,
struct lttng_ust_object_data **event_data);
-int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
+int ustctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
struct lttng_ust_object_data *obj_data,
struct lttng_ust_object_data **context_data);
int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
int ustctl_start_session(int sock, int handle);
int ustctl_stop_session(int sock, int handle);
+/*
+ * ustctl_create_event notifier_group creates a event notifier group. It
+ * establishes the connection with the application by providing a file
+ * descriptor of the pipe to be used by the application when a event notifier
+ * of that group is fired. It returns a handle to be used when creating event
+ * notifier in that group.
+ */
+int ustctl_create_event_notifier_group(int sock, int pipe_fd,
+ struct lttng_ust_object_data **event_notifier_group);
+
+/*
+ * ustctl_create_event notifier creates a event notifier in a event notifier
+ * group giving a event notifier description and a event notifier group handle.
+ * It returns a event notifier handle to be used when enabling the event
+ * notifier, attaching filter, attaching exclusion, and disabling the event
+ * notifier.
+ */
+int ustctl_create_event_notifier(int sock,
+ struct lttng_ust_event_notifier *event_notifier,
+ struct lttng_ust_object_data *event_notifier_group,
+ struct lttng_ust_object_data **event_notifier_data);
+
/*
* ustctl_tracepoint_list returns a tracepoint list handle, or negative
* error value.
/* snapshot */
int ustctl_snapshot(struct ustctl_consumer_stream *stream);
+int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream *stream);
int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
unsigned long *pos);
int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
int producer_active);
+void ustctl_clear_buffer(struct ustctl_consumer_stream *stream);
/* index */
+
+/*
+ * Getters which need to be used on the current packet (between get/put
+ * or get_next/put_next.
+ */
+
int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
uint64_t *timestamp_begin);
int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
uint64_t *content_size);
int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
uint64_t *packet_size);
+int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream,
+ uint64_t *seq);
+
+/*
+ * Getter returning state invariant for the stream, which can be used
+ * without "get" operation.
+ */
+
int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
uint64_t *stream_id);
+int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
+ uint64_t *id);
+
+/*
+ * Getter returning the current timestamp as perceived from the
+ * tracer.
+ */
int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
uint64_t *ts);
/* returns whether UST has perf counters support. */
int ustctl_has_perf_counters(void);
+/* Regenerate the statedump. */
+int ustctl_regenerate_statedump(int sock, int handle);
+
/* event registry management */
enum ustctl_socket_type {
enum ustctl_abstract_types {
ustctl_atype_integer,
- ustctl_atype_enum,
- ustctl_atype_array,
- ustctl_atype_sequence,
+ ustctl_atype_enum, /* legacy */
+ ustctl_atype_array, /* legacy */
+ ustctl_atype_sequence, /* legacy */
ustctl_atype_string,
ustctl_atype_float,
+ ustctl_atype_variant, /* legacy */
+ ustctl_atype_struct, /* legacy */
+ ustctl_atype_enum_nestable,
+ ustctl_atype_array_nestable,
+ ustctl_atype_sequence_nestable,
+ ustctl_atype_struct_nestable,
+ ustctl_atype_variant_nestable,
NR_USTCTL_ABSTRACT_TYPES,
};
uint32_t signedness;
uint32_t reverse_byte_order;
uint32_t base; /* 2, 8, 10, 16, for pretty print */
- enum ustctl_string_encodings encoding;
+ int32_t encoding; /* enum ustctl_string_encodings */
uint16_t alignment; /* in bits */
char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
} LTTNG_PACKED;
char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
} LTTNG_PACKED;
+#define USTCTL_UST_ENUM_VALUE_PADDING 15
+struct ustctl_enum_value {
+ uint64_t value;
+ uint8_t signedness;
+ char padding[USTCTL_UST_ENUM_VALUE_PADDING];
+} LTTNG_PACKED;
+
+enum ustctl_ust_enum_entry_options {
+ USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
+};
+
#define USTCTL_UST_ENUM_ENTRY_PADDING 32
struct ustctl_enum_entry {
- uint64_t start, end; /* start and end are inclusive */
+ struct ustctl_enum_value start, end; /* start and end are inclusive */
char string[LTTNG_UST_SYM_NAME_LEN];
- char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
-};
+ union {
+ struct {
+ uint32_t options;
+ } LTTNG_PACKED extra;
+ char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
+ } u;
+} LTTNG_PACKED;
+/* legacy */
#define USTCTL_UST_BASIC_TYPE_PADDING 296
union _ustctl_basic_type {
struct ustctl_integer_type integer;
uint64_t id; /* enum ID in sessiond. */
} enumeration;
struct {
- enum ustctl_string_encodings encoding;
+ int32_t encoding; /* enum ustctl_string_encodings */
} string;
struct ustctl_float_type _float;
char padding[USTCTL_UST_BASIC_TYPE_PADDING];
} LTTNG_PACKED;
+/* legacy */
struct ustctl_basic_type {
enum ustctl_abstract_types atype;
union {
} u;
} LTTNG_PACKED;
-#define USTCTL_UST_TYPE_PADDING 128
+/*
+ * Padding is derived from largest member: u.legacy.sequence which
+ * contains two basic types, each with USTCTL_UST_BASIC_TYPE_PADDING.
+ */
+#define USTCTL_UST_TYPE_PADDING (2 * USTCTL_UST_BASIC_TYPE_PADDING)
struct ustctl_type {
enum ustctl_abstract_types atype;
union {
- union _ustctl_basic_type basic;
+ struct ustctl_integer_type integer;
+ struct ustctl_float_type _float;
+ struct {
+ int32_t encoding; /* enum ustctl_string_encodings */
+ } string;
+ struct {
+ char name[LTTNG_UST_SYM_NAME_LEN];
+ uint64_t id; /* enum ID in sessiond. */
+ /* container_type follows after this struct ustctl_field. */
+ } enum_nestable;
struct {
- struct ustctl_basic_type elem_type;
uint32_t length; /* num. elems. */
- } array;
+ uint32_t alignment;
+ /* elem_type follows after this struct ustctl_field. */
+ } array_nestable;
+ struct {
+ char length_name[LTTNG_UST_SYM_NAME_LEN];
+ uint32_t alignment; /* Alignment before elements. */
+ /* elem_type follows after the length_type. */
+ } sequence_nestable;
+ struct {
+ uint32_t nr_fields;
+ uint32_t alignment;
+ /* Followed by nr_fields struct ustctl_field. */
+ } struct_nestable;
struct {
- struct ustctl_basic_type length_type;
- struct ustctl_basic_type elem_type;
- } sequence;
+ uint32_t nr_choices;
+ char tag_name[LTTNG_UST_SYM_NAME_LEN];
+ uint32_t alignment;
+ /* Followed by nr_choices struct ustctl_field. */
+ } variant_nestable;
+
+ /* Legacy ABI */
+ union {
+ union _ustctl_basic_type basic;
+ struct {
+ struct ustctl_basic_type elem_type;
+ uint32_t length; /* num. elems. */
+ } array;
+ struct {
+ struct ustctl_basic_type length_type;
+ struct ustctl_basic_type elem_type;
+ } sequence;
+ struct {
+ uint32_t nr_fields;
+ /* Followed by nr_fields struct ustctl_field. */
+ } _struct;
+ struct {
+ uint32_t nr_choices;
+ char tag_name[LTTNG_UST_SYM_NAME_LEN];
+ /* Followed by nr_choices struct ustctl_field. */
+ } variant;
+ } legacy;
char padding[USTCTL_UST_TYPE_PADDING];
} u;
} LTTNG_PACKED;