+// SPDX-FileCopyrightText: 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+//
+// SPDX-License-Identifier: MIT
+
/*
- * SPDX-License-Identifier: MIT
- *
- * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
* Holds LTTng per-session event registry.
*/
#ifndef _LTTNG_UST_EVENTS_H
#define _LTTNG_UST_EVENTS_H
-#include <urcu/list.h>
-#include <urcu/hlist.h>
#include <stddef.h>
#include <stdint.h>
#include <lttng/ust-abi.h>
#include <errno.h>
#include <urcu/ref.h>
#include <pthread.h>
-
-#ifndef LTTNG_PACKED
-#error "LTTNG_PACKED should be defined"
-#endif
+#include <limits.h>
#ifdef __cplusplus
extern "C" {
* Older tracepoint providers can always register to newer lttng-ust
* library, but the opposite is rejected: a newer tracepoint provider is
* rejected by an older lttng-ust library.
+ *
+ * LTTNG_UST_PROVIDER_MAJOR_OLDEST_COMPATIBLE is the floor value of
+ * oldest provider major version currently allowed, typically increased
+ * when LTTng-UST has an ABI-breaking soname bump.
*/
-#define LTTNG_UST_PROVIDER_MAJOR 2
+#define LTTNG_UST_PROVIDER_MAJOR 3
+#define LTTNG_UST_PROVIDER_MAJOR_OLDEST_COMPATIBLE 3
#define LTTNG_UST_PROVIDER_MINOR 0
-struct lttng_channel;
+struct lttng_ust_channel_buffer;
struct lttng_ust_session;
-struct lttng_ust_lib_ring_buffer_ctx;
+struct lttng_ust_ring_buffer_ctx;
struct lttng_ust_event_field;
+struct lttng_ust_registered_probe;
/*
* Data structures used by tracepoint event declarations, and by the
NR_LTTNG_UST_STRING_ENCODING,
};
-struct lttng_enum_value {
+struct lttng_ust_enum_value {
unsigned long long value;
unsigned int signedness:1;
};
-enum lttng_enum_entry_options {
- LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
+enum lttng_ust_enum_entry_option {
+ LTTNG_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
};
/*
struct lttng_ust_enum_entry {
uint32_t struct_size;
- struct lttng_enum_value start, end; /* start and end are inclusive */
+ struct lttng_ust_enum_value start, end; /* start and end are inclusive */
const char *string;
unsigned int options;
};
#define lttng_ust_type_integer_define(_type, _byte_order, _base) \
- ((struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(struct lttng_ust_type_integer, { \
+ ((struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(struct lttng_ust_type_integer, { \
.parent = { \
.type = lttng_ust_type_integer, \
}, \
.struct_size = sizeof(struct lttng_ust_type_integer), \
.size = sizeof(_type) * CHAR_BIT, \
- .alignment = lttng_alignof(_type) * CHAR_BIT, \
- .signedness = lttng_is_signed_type(_type), \
- .reverse_byte_order = _byte_order != BYTE_ORDER, \
+ .alignment = lttng_ust_rb_alignof(_type) * CHAR_BIT, \
+ .signedness = lttng_ust_is_signed_type(_type), \
+ .reverse_byte_order = _byte_order != LTTNG_UST_BYTE_ORDER, \
.base = _base, \
}))
* Only float and double are supported. long double is not supported at
* the moment.
*/
-#define _float_mant_dig(_type) \
+#define lttng_ust_float_mant_dig(_type) \
(sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
: (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
: 0))
#define lttng_ust_type_float_define(_type) \
- ((struct lttng_ust_type_common *) __LTTNG_COMPOUND_LITERAL(struct lttng_ust_type_float, { \
+ ((struct lttng_ust_type_common *) LTTNG_UST_COMPOUND_LITERAL(struct lttng_ust_type_float, { \
.parent = { \
.type = lttng_ust_type_float, \
}, \
.struct_size = sizeof(struct lttng_ust_type_float), \
.exp_dig = sizeof(_type) * CHAR_BIT \
- - _float_mant_dig(_type), \
- .mant_dig = _float_mant_dig(_type), \
- .alignment = lttng_alignof(_type) * CHAR_BIT, \
- .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
+ - lttng_ust_float_mant_dig(_type), \
+ .mant_dig = lttng_ust_float_mant_dig(_type), \
+ .alignment = lttng_ust_rb_alignof(_type) * CHAR_BIT, \
+ .reverse_byte_order = LTTNG_UST_BYTE_ORDER != LTTNG_UST_FLOAT_WORD_ORDER, \
}))
struct lttng_ust_type_enum {
struct lttng_ust_type_common parent;
uint32_t struct_size;
- struct lttng_ust_enum_desc *desc; /* Enumeration mapping */
- struct lttng_ust_type_common *container_type;
+ const struct lttng_ust_enum_desc *desc; /* Enumeration mapping */
+ const struct lttng_ust_type_common *container_type;
};
+/*
+ * The alignment field in structure, array, and sequence types is a
+ * minimum alignment requirement. The actual alignment of a type may be
+ * larger than this explicit alignment value if its nested types have a
+ * larger alignment.
+ */
+
struct lttng_ust_type_array {
struct lttng_ust_type_common parent;
uint32_t struct_size;
- struct lttng_ust_type_common *elem_type;
- unsigned int length; /* Num. elems. */
- unsigned int alignment;
+ const struct lttng_ust_type_common *elem_type;
+ unsigned int length; /* Num. elems. */
+ unsigned int alignment; /* Minimum alignment for this type. */
enum lttng_ust_string_encoding encoding;
};
struct lttng_ust_type_sequence {
struct lttng_ust_type_common parent;
uint32_t struct_size;
- const char *length_name; /* Length field name. */
- struct lttng_ust_type_common *elem_type;
- unsigned int alignment; /* Alignment before elements. */
+ const char *length_name; /* Length field name. If NULL, use previous field. */
+ const struct lttng_ust_type_common *elem_type;
+ unsigned int alignment; /* Minimum alignment before elements. */
enum lttng_ust_string_encoding encoding;
};
struct lttng_ust_type_common parent;
uint32_t struct_size;
unsigned int nr_fields;
- struct lttng_ust_event_field **fields; /* Array of pointers to fields. */
- unsigned int alignment;
+ const struct lttng_ust_event_field * const *fields; /* Array of pointers to fields. */
+ unsigned int alignment; /* Minimum alignment for this type. */
};
/*
uint32_t struct_size;
const char *name;
- struct lttng_ust_enum_entry **entries;
+ const struct lttng_ust_enum_entry * const *entries;
unsigned int nr_entries;
+ const struct lttng_ust_probe_desc *probe_desc;
/* End of base ABI. Fields below should be used after checking struct_size. */
};
uint32_t struct_size;
const char *name;
- struct lttng_ust_type_common *type;
+ const struct lttng_ust_type_common *type;
unsigned int nowrite:1, /* do not write into trace */
nofilter:1; /* do not consider for filter */
/* End of base ABI. Fields below should be used after checking struct_size. */
};
+/*
+ * Tracepoint class description
+ *
+ * IMPORTANT: this structure is part of the ABI between the probe and
+ * UST. Fields need to be only added at the end, never reordered, never
+ * removed.
+ *
+ * The field @struct_size should be used to determine the size of the
+ * structure. It should be queried before using additional fields added
+ * at the end of the structure.
+ */
+
+struct lttng_ust_tracepoint_class {
+ uint32_t struct_size;
+
+ const struct lttng_ust_event_field * const *fields;
+ size_t nr_fields;
+ void (*probe_callback)(void);
+ const char *signature; /* Argument types/names received */
+ const struct lttng_ust_probe_desc *probe_desc;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
+};
/*
* IMPORTANT: this structure is part of the ABI between the probe and
* at the end of the structure.
*/
struct lttng_ust_event_desc {
- uint32_t struct_size; /* Size of this structure. */
+ uint32_t struct_size; /* Size of this structure. */
- const char *name;
- void (*probe_callback)(void);
- struct lttng_event_ctx *ctx; /* context */
- struct lttng_ust_event_field **fields; /* event payload */
- unsigned int nr_fields;
+ const char *event_name;
+ const struct lttng_ust_probe_desc *probe_desc;
+ const struct lttng_ust_tracepoint_class *tp_class;
const int **loglevel;
- const char *signature; /* Argument types/names received */
const char **model_emf_uri;
/* End of base ABI. Fields below should be used after checking struct_size. */
struct lttng_ust_probe_desc {
uint32_t struct_size; /* Size of this structure. */
- const char *provider;
- struct lttng_ust_event_desc **event_desc;
+ const char *provider_name;
+ const struct lttng_ust_event_desc * const *event_desc;
unsigned int nr_events;
- struct cds_list_head head; /* chain registered probes */
- struct cds_list_head lazy_init_head;
- int lazy; /* lazy registration */
uint32_t major;
uint32_t minor;
/* Data structures used by the tracer. */
-/*
- * Bytecode interpreter return value masks.
- */
-enum lttng_bytecode_interpreter_ret {
- LTTNG_INTERPRETER_DISCARD = 0,
- LTTNG_INTERPRETER_RECORD_FLAG = (1ULL << 0),
- /* Other bits are kept for future use. */
-};
-
-struct lttng_interpreter_output;
-struct lttng_ust_bytecode_runtime_private;
-
/*
* IMPORTANT: this structure is part of the ABI between the probe and
* UST. Fields need to be only added at the end, never reordered, never
* The field @struct_size should be used to determine the size of the
* structure. It should be queried before using additional fields added
* at the end of the structure.
+ *
+ * The probe_ctx is not const because it may be extended to add future
+ * fields which could be modified by callbacks.
*/
-struct lttng_ust_bytecode_runtime {
+struct lttng_ust_probe_ctx {
uint32_t struct_size; /* Size of this structure. */
- struct lttng_ust_bytecode_runtime_private *priv;
- /* Associated bytecode */
- union {
- uint64_t (*filter)(void *interpreter_data,
- const char *interpreter_stack_data);
- uint64_t (*capture)(void *interpreter_data,
- const char *interpreter_stack_data,
- struct lttng_interpreter_output *interpreter_output);
- } interpreter_funcs;
- struct cds_list_head node; /* list of bytecode runtime in event */
+ void *ip; /* caller ip address */
/* End of base ABI. Fields below should be used after checking struct_size. */
};
* removed.
*/
-struct lttng_ust_ctx;
struct lttng_ust_event_common_private;
enum lttng_ust_event_type {
LTTNG_UST_EVENT_TYPE_NOTIFIER = 1,
};
+/*
+ * Result of the run_filter() callback.
+ */
+enum lttng_ust_event_filter_result {
+ LTTNG_UST_EVENT_FILTER_ACCEPT = 0,
+ LTTNG_UST_EVENT_FILTER_REJECT = 1,
+};
+
/*
* IMPORTANT: this structure is part of the ABI between the probe and
* UST. Fields need to be only added at the end, never reordered, never
void *child; /* Pointer to child, for inheritance by aggregation. */
int enabled;
- int has_enablers_without_bytecode;
- /* list of struct lttng_ust_bytecode_runtime, sorted by seqnum */
- struct cds_list_head filter_bytecode_runtime_head;
+ int eval_filter; /* Need to evaluate filters */
+ int (*run_filter)(const struct lttng_ust_event_common *event,
+ const char *stack_data,
+ struct lttng_ust_probe_ctx *probe_ctx,
+ void *filter_ctx);
/* End of base ABI. Fields below should be used after checking struct_size. */
};
struct lttng_ust_event_common *parent; /* Inheritance by aggregation. */
struct lttng_ust_event_recorder_private *priv; /* Private event record interface */
- unsigned int id;
- struct lttng_channel *chan;
- struct lttng_ust_ctx *ctx;
+ struct lttng_ust_channel_buffer *chan;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
+};
+/*
+ * IMPORTANT: this structure is part of the ABI between the probe and
+ * UST. Fields need to be only added at the end, never reordered, never
+ * removed.
+ *
+ * The field @struct_size should be used to determine the size of the
+ * structure. It should be queried before using additional fields added
+ * at the end of the structure.
+ */
+struct lttng_ust_notification_ctx {
+ uint32_t struct_size; /* Size of this structure. */
+ int eval_capture; /* Capture evaluation available. */
/* End of base ABI. Fields below should be used after checking struct_size. */
};
struct lttng_ust_event_common *parent; /* Inheritance by aggregation. */
struct lttng_ust_event_notifier_private *priv; /* Private event notifier interface */
- void (*notification_send)(struct lttng_ust_event_notifier *event_notifier,
- const char *stack_data);
- struct cds_list_head capture_bytecode_runtime_head;
+ int eval_capture; /* Need to evaluate capture */
+ void (*notification_send)(const struct lttng_ust_event_notifier *event_notifier,
+ const char *stack_data,
+ struct lttng_ust_probe_ctx *probe_ctx,
+ struct lttng_ust_notification_ctx *notif_ctx);
/* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct lttng_ust_lib_ring_buffer_channel;
-struct lttng_ust_shm_handle;
-struct lttng_ust_channel_ops_private;
+struct lttng_ust_ring_buffer_channel;
+struct lttng_ust_channel_buffer_ops_private;
/*
* IMPORTANT: this structure is part of the ABI between the probe and
* structure. It should be queried before using additional fields added
* at the end of the structure.
*/
-struct lttng_ust_channel_ops {
+struct lttng_ust_channel_buffer_ops {
uint32_t struct_size;
- struct lttng_ust_channel_ops_private *priv; /* Private channel ops interface */
+ struct lttng_ust_channel_buffer_ops_private *priv; /* Private channel buffer ops interface */
- int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
- uint32_t event_id);
- void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
- void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
- const void *src, size_t len);
- void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
+ int (*event_reserve)(struct lttng_ust_ring_buffer_ctx *ctx);
+ void (*event_commit)(struct lttng_ust_ring_buffer_ctx *ctx);
+ void (*event_write)(struct lttng_ust_ring_buffer_ctx *ctx,
+ const void *src, size_t len, size_t alignment);
+ void (*event_strcpy)(struct lttng_ust_ring_buffer_ctx *ctx,
+ const char *src, size_t len);
+ void (*event_pstrcpy_pad)(struct lttng_ust_ring_buffer_ctx *ctx,
const char *src, size_t len);
/* End of base ABI. Fields below should be used after checking struct_size. */
};
+enum lttng_ust_channel_type {
+ LTTNG_UST_CHANNEL_TYPE_BUFFER = 0,
+};
+
+struct lttng_ust_channel_common_private;
+
/*
* IMPORTANT: this structure is part of the ABI between the probe and
* UST. Fields need to be only added at the end, never reordered, never
* removed.
+ *
+ * The field @struct_size should be used to determine the size of the
+ * structure. It should be queried before using additional fields added
+ * at the end of the structure.
*/
-struct lttng_channel {
- /*
- * The pointers located in this private data are NOT safe to be
- * dereferenced by the consumer. The only operations the
- * consumer process is designed to be allowed to do is to read
- * and perform subbuffer flush.
- */
- struct lttng_ust_lib_ring_buffer_channel *chan; /* Channel buffers */
+struct lttng_ust_channel_common {
+ uint32_t struct_size; /* Size of this structure. */
+
+ struct lttng_ust_channel_common_private *priv; /* Private channel interface */
+
+ enum lttng_ust_channel_type type;
+ void *child; /* Pointer to child, for inheritance by aggregation. */
+
int enabled;
- struct lttng_ust_ctx *ctx;
- /* Event ID management */
struct lttng_ust_session *session;
- int objd; /* Object associated to channel */
- struct cds_list_head node; /* Channel list in session */
- struct lttng_ust_channel_ops *ops;
- int header_type; /* 0: unset, 1: compact, 2: large */
- struct lttng_ust_shm_handle *handle; /* shared-memory handle */
-
- /* Channel ID */
- unsigned int id;
- enum lttng_ust_abi_chan_type type;
- unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
- int tstate:1; /* Transient enable state */
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
+};
+
+struct lttng_ust_channel_buffer_private;
+
+/*
+ * IMPORTANT: this structure is part of the ABI between the probe and
+ * UST. Fields need to be only added at the end, never reordered, never
+ * removed.
+ *
+ * The field @struct_size should be used to determine the size of the
+ * structure. It should be queried before using additional fields added
+ * at the end of the structure.
+ */
+struct lttng_ust_channel_buffer {
+ uint32_t struct_size; /* Size of this structure. */
+
+ struct lttng_ust_channel_common *parent; /* Inheritance by aggregation. */
+ struct lttng_ust_channel_buffer_private *priv; /* Private channel buffer interface */
+
+ struct lttng_ust_channel_buffer_ops *ops;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
/*
uint32_t struct_size; /* Size of this structure */
struct lttng_ust_event_recorder *event_recorder;
- struct lttng_ust_ctx *chan_ctx; /* RCU dereferenced. */
- struct lttng_ust_ctx *event_ctx; /* RCU dereferenced. */
/* End of base ABI. Fields below should be used after checking struct_size. */
};
/* End of base ABI. Fields below should be used after checking struct_size. */
};
-int lttng_ust_probe_register(struct lttng_ust_probe_desc *desc);
-void lttng_ust_probe_unregister(struct lttng_ust_probe_desc *desc);
+/*
+ * On successful registration of a probe, a pointer to an opaque
+ * structure is returned. This pointer should be passed to
+ * lttng_ust_probe_unregister for unregistration.
+ * lttng_ust_probe_register returns NULL on error.
+ */
+struct lttng_ust_registered_probe *lttng_ust_probe_register(const struct lttng_ust_probe_desc *desc);
+
+void lttng_ust_probe_unregister(struct lttng_ust_registered_probe *reg_probe);
/*
* Applications that change their procname and need the new value to be
projects / lttng-ust.git / blobdiff