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 */
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. */
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. */
+
int enabled;
int has_enablers_without_bytecode;
/* list of struct lttng_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;
+ 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_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;
+ 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;
+
+ /* End of base ABI. Fields below should be used after checking struct_size. */
};
struct lttng_enum {
* 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.
projects / lttng-ust.git / blobdiff