struct lttng_channel;
struct lttng_session;
struct lttng_ust_lib_ring_buffer_ctx;
-struct lttng_event_field;
-struct lttng_event_notifier;
+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;
- void (*event_notifier_callback)(void);
- } 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. */
struct lttng_ust_bytecode_runtime_private;
/*
- * This structure is used in the probes. More specifically, the
- * `interpreter_funcs` and `node` fields are explicity used in the
- * probes. When modifying this structure we must not change the layout
- * of these two fields as it is considered ABI.
+ * 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_bytecode_runtime {
- struct lttng_ust_bytecode_runtime_private *priv;
+struct lttng_ust_bytecode_runtime {
+ uint32_t struct_size; /* Size of this structure. */
+ struct lttng_ust_bytecode_runtime_private *priv;
/* Associated bytecode */
union {
uint64_t (*filter)(void *interpreter_data,
struct lttng_interpreter_output *interpreter_output);
} interpreter_funcs;
struct cds_list_head node; /* list of bytecode runtime in event */
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
/*
* removed.
*/
-struct lttng_ust_event_private;
+struct lttng_ust_event_common_private;
-struct lttng_event {
- uint32_t struct_size; /* Size of this structure. */
- struct lttng_ust_event_private *priv; /* Private event interface */
+enum lttng_ust_event_type {
+ LTTNG_UST_EVENT_TYPE_RECORDER = 0,
+ LTTNG_UST_EVENT_TYPE_NOTIFIER = 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
+ * 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
+ * parent. Inheritance of those public structures is done by composition
+ * to ensure both parent and child structures can be extended.
+ *
+ * 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_common {
+ uint32_t struct_size; /* Size of this structure. */
+ struct lttng_ust_event_common_private *priv; /* Private event interface */
+
+ enum lttng_ust_event_type type;
+ void *child; /* Pointer to child, for inheritance by aggregation. */
- unsigned int id;
int enabled;
int has_enablers_without_bytecode;
- /* list of struct lttng_bytecode_runtime, sorted by seqnum */
+ /* list of struct lttng_ust_bytecode_runtime, sorted by seqnum */
struct cds_list_head filter_bytecode_runtime_head;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
+};
+
+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
+ * extensible.
+ *
+ * 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_recorder {
+ uint32_t struct_size; /* Size of this structure. */
+ 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_ctx *ctx;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
-struct lttng_event_notifier {
- uint64_t user_token;
- uint64_t error_counter_index;
- int enabled;
- int registered; /* has reg'd tracepoint probe */
- size_t num_captures; /* Needed to allocate the msgpack array. */
- void (*notification_send)(struct lttng_event_notifier *event_notifier,
+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
+ * extensible.
+ *
+ * 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_notifier {
+ uint32_t struct_size; /* Size of this structure. */
+
+ 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 filter_bytecode_runtime_head;
struct cds_list_head capture_bytecode_runtime_head;
- int has_enablers_without_bytecode;
- struct cds_list_head enablers_ref_head;
- const struct lttng_event_desc *desc;
- struct cds_hlist_node hlist; /* hashtable of event_notifiers */
- struct cds_list_head node; /* event_notifier list in session */
- struct lttng_event_notifier_group *group; /* weak ref */
-};
-struct lttng_enum {
- const struct lttng_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 */
- uint64_t id; /* Enumeration ID in sessiond */
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
struct channel;
* 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_ops {
+struct lttng_ust_channel_ops {
+ uint32_t struct_size;
+
struct lttng_channel *(*channel_create)(const char *name,
void *buf_addr,
size_t subbuf_size, size_t num_subbuf,
int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
const char *src, size_t len);
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
/*
struct lttng_session *session;
int objd; /* Object associated to channel */
struct cds_list_head node; /* Channel list in session */
- const struct lttng_channel_ops *ops;
+ const 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_chan_type type;
+ enum lttng_ust_abi_chan_type type;
unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
int tstate:1; /* Transient enable state */
};
-struct lttng_counter_dimension;
-
-struct lttng_counter_ops {
- struct lib_counter *(*counter_create)(size_t nr_dimensions,
- const struct lttng_counter_dimension *dimensions,
- int64_t global_sum_step,
- int global_counter_fd,
- int nr_counter_cpu_fds,
- const int *counter_cpu_fds,
- bool is_daemon);
- void (*counter_destroy)(struct lib_counter *counter);
- int (*counter_add)(struct lib_counter *counter,
- const size_t *dimension_indexes, int64_t v);
- int (*counter_read)(struct lib_counter *counter,
- const size_t *dimension_indexes, int cpu,
- int64_t *value, bool *overflow, bool *underflow);
- int (*counter_aggregate)(struct lib_counter *counter,
- const size_t *dimension_indexes, int64_t *value,
- bool *overflow, bool *underflow);
- int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
-};
+/*
+ * 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_stack_ctx {
+ uint32_t struct_size; /* Size of this structure */
-#define LTTNG_UST_STACK_CTX_PADDING 32
-struct lttng_stack_ctx {
- struct lttng_event *event;
+ struct lttng_ust_event_recorder *event_recorder;
struct lttng_ctx *chan_ctx; /* RCU dereferenced. */
struct lttng_ctx *event_ctx; /* RCU dereferenced. */
- char padding[LTTNG_UST_STACK_CTX_PADDING];
-};
-
-#define LTTNG_UST_EVENT_HT_BITS 12
-#define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
-struct lttng_ust_event_ht {
- struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
-};
-
-#define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12
-#define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
-struct lttng_ust_event_notifier_ht {
- struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE];
-};
-
-#define LTTNG_UST_ENUM_HT_BITS 12
-#define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS)
-
-struct lttng_ust_enum_ht {
- struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
struct lttng_ust_session_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_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.
+ * Applications that change their procname and need the new value to be
+ * reflected in the procname event context have to call this function to clear
+ * the internally cached value. This should not be called from a signal
+ * handler.
*/
-void lttng_context_procname_reset(void);
+void lttng_ust_context_procname_reset(void);
struct lttng_transport *lttng_transport_find(const char *name);
projects / lttng-ust.git / blobdiff