X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=d070a3cc1128d7909b9eec222498a8e551608a6c;hb=49926dbd13cfcb46f6947b7e99bc2999c06dc743;hp=f7915d7d530ae566fc2b7953ebb9c99ddfa5de71;hpb=93cfd247467ce0816d502eb713fb14926d5b57fa;p=lttng-ust.git diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h index f7915d7d..d070a3cc 100644 --- a/include/lttng/ust-events.h +++ b/include/lttng/ust-events.h @@ -43,7 +43,7 @@ extern "C" { 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; /* @@ -83,16 +83,26 @@ enum lttng_enum_entry_options { 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) \ @@ -168,7 +178,7 @@ struct lttng_type { 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 { @@ -183,7 +193,7 @@ struct lttng_type { } 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; @@ -191,12 +201,26 @@ struct lttng_type { } 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. */ }; /* @@ -205,19 +229,21 @@ struct lttng_enum_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. */ -#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 { @@ -250,7 +276,7 @@ struct lttng_perf_counter_field; #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, @@ -274,34 +300,51 @@ struct lttng_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. */ @@ -355,6 +398,10 @@ enum lttng_ust_event_type { }; /* + * 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 @@ -383,6 +430,10 @@ struct lttng_ust_event_common { 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 @@ -407,6 +458,10 @@ struct lttng_ust_event_recorder { 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 @@ -429,7 +484,7 @@ struct lttng_ust_event_notifier { }; 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 */ @@ -443,8 +498,14 @@ struct lttng_ust_shm_handle; * 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, @@ -472,6 +533,8 @@ struct lttng_channel_ops { 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. */ }; /* @@ -493,7 +556,7 @@ struct lttng_channel { 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 */ @@ -560,16 +623,22 @@ 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.