struct lttng_channel;
struct lttng_session;
struct lttng_ust_lib_ring_buffer_ctx;
-struct lttng_event_field;
+struct lttng_ust_event_field;
struct lttng_event_notifier_group;
/*
LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
};
-#define LTTNG_UST_ENUM_ENTRY_PADDING 16
-struct lttng_enum_entry {
+/*
+ * Enumeration entry 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_enum_entry {
+ uint32_t struct_size;
+
struct lttng_enum_value start, end; /* start and end are inclusive */
const char *string;
- union {
- struct {
- unsigned int options;
- } LTTNG_PACKED extra;
- char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
- } u;
+ unsigned int options;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
#define __type_integer(_type, _byte_order, _base, _encoding) \
enum lttng_string_encodings encoding;
} string;
struct {
- const struct lttng_enum_desc *desc; /* Enumeration mapping */
+ const struct lttng_ust_enum_desc *desc; /* Enumeration mapping */
struct lttng_type *container_type;
} enum_nestable;
struct {
} sequence_nestable;
struct {
unsigned int nr_fields;
- const struct lttng_event_field *fields; /* Array of fields. */
+ const struct lttng_ust_event_field **fields; /* Array of pointers to fields. */
unsigned int alignment;
} struct_nestable;
} u;
};
-#define LTTNG_UST_ENUM_TYPE_PADDING 24
-struct lttng_enum_desc {
+/*
+ * Enumeration 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_enum_desc {
+ uint32_t struct_size;
+
const char *name;
- const struct lttng_enum_entry *entries;
+ const struct lttng_ust_enum_entry **entries;
unsigned int nr_entries;
- char padding[LTTNG_UST_ENUM_TYPE_PADDING];
+
+ /* 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.
*/
-#define LTTNG_UST_EVENT_FIELD_PADDING 28
-struct lttng_event_field {
+struct lttng_ust_event_field {
+ uint32_t struct_size;
+
const char *name;
struct lttng_type type;
- unsigned int nowrite; /* do not write into trace */
- union {
- struct {
- unsigned int nofilter:1; /* do not consider for filter */
- } ext;
- char padding[LTTNG_UST_EVENT_FIELD_PADDING];
- } u;
+ 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. */
};
enum lttng_ust_dynamic_type {
#define LTTNG_UST_CTX_FIELD_PADDING 40
struct lttng_ctx_field {
- struct lttng_event_field event_field;
+ struct lttng_ust_event_field event_field;
size_t (*get_size)(struct lttng_ctx_field *field, size_t offset);
void (*record)(struct lttng_ctx_field *field,
struct lttng_ust_lib_ring_buffer_ctx *ctx,
char padding[LTTNG_UST_CTX_PADDING];
};
-#define LTTNG_UST_EVENT_DESC_PADDING 40
-struct lttng_event_desc {
+/*
+ * 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_event_desc {
+ uint32_t struct_size; /* Size of this structure. */
const char *name;
void (*probe_callback)(void);
const struct lttng_event_ctx *ctx; /* context */
- const struct lttng_event_field *fields; /* event payload */
+ const struct lttng_ust_event_field **fields; /* event payload */
unsigned int nr_fields;
const int **loglevel;
- const char *signature; /* Argument types/names received */
- union {
- struct {
- const char **model_emf_uri;
- } ext;
- char padding[LTTNG_UST_EVENT_DESC_PADDING];
- } u;
+ 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. */
};
-#define LTTNG_UST_PROBE_DESC_PADDING 12
-struct lttng_probe_desc {
+/*
+ * 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_probe_desc {
+ uint32_t struct_size; /* Size of this structure. */
+
const char *provider;
- const struct lttng_event_desc **event_desc;
+ const struct lttng_ust_event_desc **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;
- char padding[LTTNG_UST_PROBE_DESC_PADDING];
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
/* Data structures used by the tracer. */
};
/*
+ * 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.
+ *
* struct lttng_ust_event_common is the common ancestor of the various
* public event actions. Inheritance is done by composition: The parent
* has a pointer to its child, and the child has a pointer to its
struct lttng_ust_event_recorder_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.
+ *
* struct lttng_ust_event_recorder is the action for recording events
* into a ring buffer. It inherits from struct lttng_ust_event_common
* by composition to ensure both parent and child structure are
struct lttng_ust_event_notifier_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.
+ *
* struct lttng_ust_event_notifier is the action for sending
* notifications. It inherits from struct lttng_ust_event_common
* by composition to ensure both parent and child structure are
};
struct lttng_enum {
- const struct lttng_enum_desc *desc;
+ const struct lttng_ust_enum_desc *desc;
struct lttng_session *session;
struct cds_list_head node; /* Enum list in session */
struct cds_hlist_node hlist; /* Session ht of enums */
* 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_session {
uint32_t struct_size; /* Size of this structure */
struct lttng_ust_session_private *priv; /* Private session interface */
int active; /* Is trace session active ? */
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-int lttng_probe_register(struct lttng_probe_desc *desc);
-void lttng_probe_unregister(struct lttng_probe_desc *desc);
+int lttng_ust_probe_register(struct lttng_ust_probe_desc *desc);
+void lttng_ust_probe_unregister(struct lttng_ust_probe_desc *desc);
/*
* Can be used by applications that change their procname to clear the ust cached value.