X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=6a918f4d2b98a9b1bf6f34d3cb2887c94f8a8a95;hb=2e7160d2113f6f0c5af599963a59ebaab0751320;hp=9d6568573d77ab523bff7d5fd3af03a0cd0da4fc;hpb=871ad31c32e253edbd2f85f40ffd77dc3315efad;p=lttng-ust.git diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h index 9d656857..6a918f4d 100644 --- a/include/lttng/ust-events.h +++ b/include/lttng/ust-events.h @@ -9,8 +9,6 @@ #ifndef _LTTNG_UST_EVENTS_H #define _LTTNG_UST_EVENTS_H -#include -#include #include #include #include @@ -20,10 +18,7 @@ #include #include #include - -#ifndef LTTNG_PACKED -#error "LTTNG_PACKED should be defined" -#endif +#include #ifdef __cplusplus extern "C" { @@ -36,211 +31,208 @@ 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_session; -struct lttng_ust_lib_ring_buffer_ctx; -struct lttng_event_field; -struct lttng_event_notifier; -struct lttng_event_notifier_group; +struct lttng_ust_channel_buffer; +struct lttng_ust_session; +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 - * tracer. Those structures have padding for future extension. + * tracer. */ /* Type description */ -/* Update the astract_types name table in lttng-types.c along with this enum */ -enum lttng_abstract_types { - atype_integer, - atype_enum, /* legacy */ - atype_array, /* legacy */ - atype_sequence, /* legacy */ - atype_string, - atype_float, - atype_dynamic, - atype_struct, /* legacy */ - atype_enum_nestable, - atype_array_nestable, - atype_sequence_nestable, - atype_struct_nestable, - NR_ABSTRACT_TYPES, +enum lttng_ust_type { + lttng_ust_type_integer, + lttng_ust_type_string, + lttng_ust_type_float, + lttng_ust_type_dynamic, + lttng_ust_type_enum, + lttng_ust_type_array, + lttng_ust_type_sequence, + lttng_ust_type_struct, + NR_LTTNG_UST_TYPE, }; -/* Update the string_encodings name table in lttng-types.c along with this enum */ -enum lttng_string_encodings { - lttng_encode_none = 0, - lttng_encode_UTF8 = 1, - lttng_encode_ASCII = 2, - NR_STRING_ENCODINGS, +enum lttng_ust_string_encoding { + lttng_ust_string_encoding_none = 0, + lttng_ust_string_encoding_UTF8 = 1, + lttng_ust_string_encoding_ASCII = 2, + 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, }; -#define LTTNG_UST_ENUM_ENTRY_PADDING 16 -struct lttng_enum_entry { - struct lttng_enum_value start, end; /* start and end are inclusive */ +/* + * 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_ust_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. */ +}; + +/* + * struct lttng_ust_type_common is fixed-size. Its children inherits + * from it by embedding struct lttng_ust_type_common as its first field. + */ +struct lttng_ust_type_common { + enum lttng_ust_type type; }; -#define __type_integer(_type, _byte_order, _base, _encoding) \ - { \ - .atype = atype_integer, \ - .u = \ - { \ - .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, \ - .base = _base, \ - .encoding = lttng_encode_##_encoding, \ - } \ - }, \ - } \ - -#define LTTNG_UST_INTEGER_TYPE_PADDING 24 -struct lttng_integer_type { +struct lttng_ust_type_integer { + struct lttng_ust_type_common parent; + uint32_t struct_size; unsigned int size; /* in bits */ unsigned short alignment; /* in bits */ unsigned int signedness:1; unsigned int reverse_byte_order:1; unsigned int base; /* 2, 8, 10, 16, for pretty print */ - enum lttng_string_encodings encoding; - char padding[LTTNG_UST_INTEGER_TYPE_PADDING]; +}; + +#define lttng_ust_type_integer_define(_type, _byte_order, _base) \ + ((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_ust_rb_alignof(_type) * CHAR_BIT, \ + .signedness = lttng_ust_is_signed_type(_type), \ + .reverse_byte_order = _byte_order != LTTNG_UST_BYTE_ORDER, \ + .base = _base, \ + })) + +struct lttng_ust_type_float { + struct lttng_ust_type_common parent; + uint32_t struct_size; + unsigned int exp_dig; /* exponent digits, in bits */ + unsigned int mant_dig; /* mantissa digits, in bits */ + unsigned short alignment; /* in bits */ + unsigned int reverse_byte_order:1; }; /* * 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 __type_float(_type) \ - { \ - .atype = atype_float, \ - .u = \ - { \ - ._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, \ - } \ - } \ - } \ - -#define LTTNG_UST_FLOAT_TYPE_PADDING 24 -struct lttng_float_type { - unsigned int exp_dig; /* exponent digits, in bits */ - unsigned int mant_dig; /* mantissa digits, in bits */ - unsigned short alignment; /* in bits */ - unsigned int reverse_byte_order:1; - char padding[LTTNG_UST_FLOAT_TYPE_PADDING]; +#define lttng_ust_type_float_define(_type) \ + ((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 \ + - 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_string { + struct lttng_ust_type_common parent; + uint32_t struct_size; + enum lttng_ust_string_encoding encoding; +}; + +struct lttng_ust_type_enum { + struct lttng_ust_type_common parent; + uint32_t struct_size; + const struct lttng_ust_enum_desc *desc; /* Enumeration mapping */ + const struct lttng_ust_type_common *container_type; }; -/* legacy */ -#define LTTNG_UST_BASIC_TYPE_PADDING 128 -union _lttng_basic_type { - struct lttng_integer_type integer; /* legacy */ - struct { - const struct lttng_enum_desc *desc; /* Enumeration mapping */ - struct lttng_integer_type container_type; - } enumeration; /* legacy */ - struct { - enum lttng_string_encodings encoding; - } string; /* legacy */ - struct lttng_float_type _float; /* legacy */ - char padding[LTTNG_UST_BASIC_TYPE_PADDING]; +/* + * 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; + 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; }; -/* legacy */ -struct lttng_basic_type { - enum lttng_abstract_types atype; - union { - union _lttng_basic_type basic; - } u; +struct lttng_ust_type_sequence { + struct lttng_ust_type_common parent; + uint32_t struct_size; + 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; }; -#define LTTNG_UST_TYPE_PADDING 128 -struct lttng_type { - enum lttng_abstract_types atype; - union { - /* provider ABI 2.0 */ - struct lttng_integer_type integer; - struct lttng_float_type _float; - struct { - enum lttng_string_encodings encoding; - } string; - struct { - const struct lttng_enum_desc *desc; /* Enumeration mapping */ - struct lttng_type *container_type; - } enum_nestable; - struct { - const struct lttng_type *elem_type; - unsigned int length; /* Num. elems. */ - unsigned int alignment; - } array_nestable; - struct { - const char *length_name; /* Length field name. */ - const struct lttng_type *elem_type; - unsigned int alignment; /* Alignment before elements. */ - } sequence_nestable; - struct { - unsigned int nr_fields; - const struct lttng_event_field *fields; /* Array of fields. */ - unsigned int alignment; - } struct_nestable; - - union { - /* legacy provider ABI 1.0 */ - union _lttng_basic_type basic; /* legacy */ - struct { - struct lttng_basic_type elem_type; - unsigned int length; /* Num. elems. */ - } array; /* legacy */ - struct { - struct lttng_basic_type length_type; - struct lttng_basic_type elem_type; - } sequence; /* legacy */ - struct { - unsigned int nr_fields; - struct lttng_event_field *fields; /* Array of fields. */ - } _struct; /* legacy */ - } legacy; - char padding[LTTNG_UST_TYPE_PADDING]; - } u; +struct lttng_ust_type_struct { + struct lttng_ust_type_common parent; + uint32_t struct_size; + unsigned int nr_fields; + const struct lttng_ust_event_field * const *fields; /* Array of pointers to fields. */ + unsigned int alignment; /* Minimum alignment for this type. */ }; -#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 * const *entries; unsigned int nr_entries; - char padding[LTTNG_UST_ENUM_TYPE_PADDING]; + const struct lttng_ust_probe_desc *probe_desc; + + /* End of base ABI. Fields below should be used after checking struct_size. */ }; /* @@ -249,482 +241,376 @@ 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; -}; + const struct lttng_ust_type_common *type; + unsigned int nowrite:1, /* do not write into trace */ + nofilter:1; /* do not consider for filter */ -enum lttng_ust_dynamic_type { - LTTNG_UST_DYNAMIC_TYPE_NONE, - LTTNG_UST_DYNAMIC_TYPE_S8, - LTTNG_UST_DYNAMIC_TYPE_S16, - LTTNG_UST_DYNAMIC_TYPE_S32, - LTTNG_UST_DYNAMIC_TYPE_S64, - LTTNG_UST_DYNAMIC_TYPE_U8, - LTTNG_UST_DYNAMIC_TYPE_U16, - LTTNG_UST_DYNAMIC_TYPE_U32, - LTTNG_UST_DYNAMIC_TYPE_U64, - LTTNG_UST_DYNAMIC_TYPE_FLOAT, - LTTNG_UST_DYNAMIC_TYPE_DOUBLE, - LTTNG_UST_DYNAMIC_TYPE_STRING, - _NR_LTTNG_UST_DYNAMIC_TYPES, + /* End of base ABI. Fields below should be used after checking struct_size. */ }; -struct lttng_ctx_value { - enum lttng_ust_dynamic_type sel; - union { - int64_t s64; - uint64_t u64; - const char *str; - double d; - } u; -}; +/* + * 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_perf_counter_field; - -#define LTTNG_UST_CTX_FIELD_PADDING 40 -struct lttng_ctx_field { - struct lttng_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, - struct lttng_channel *chan); - void (*get_value)(struct lttng_ctx_field *field, - struct lttng_ctx_value *value); - union { - struct lttng_perf_counter_field *perf_counter; - char padding[LTTNG_UST_CTX_FIELD_PADDING]; - } u; - void (*destroy)(struct lttng_ctx_field *field); - char *field_name; /* Has ownership, dynamically allocated. */ -}; +struct lttng_ust_tracepoint_class { + uint32_t struct_size; -#define LTTNG_UST_CTX_PADDING 20 -struct lttng_ctx { - struct lttng_ctx_field *fields; - unsigned int nr_fields; - unsigned int allocated_fields; - unsigned int largest_align; - char padding[LTTNG_UST_CTX_PADDING]; + 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. */ }; -#define LTTNG_UST_EVENT_DESC_PADDING 40 -struct lttng_event_desc { - 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; +/* + * 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 *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 */ - union { - struct { - const char **model_emf_uri; - void (*event_notifier_callback)(void); - } ext; - char padding[LTTNG_UST_EVENT_DESC_PADDING]; - } u; + 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 { - const char *provider; - const struct lttng_event_desc **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_probe_desc { + uint32_t struct_size; /* Size of this structure. */ + + 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; - 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 tp_list_entry { - struct lttng_ust_tracepoint_iter tp; - struct cds_list_head head; -}; - -struct lttng_ust_tracepoint_list { - struct tp_list_entry *iter; - struct cds_list_head head; -}; +/* + * 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. + * + * The probe_ctx is not const because it may be extended to add future + * fields which could be modified by callbacks. + */ +struct lttng_ust_probe_ctx { + uint32_t struct_size; /* Size of this structure. */ -struct tp_field_list_entry { - struct lttng_ust_field_iter field; - struct cds_list_head head; -}; + void *ip; /* caller ip address */ -struct lttng_ust_field_list { - struct tp_field_list_entry *iter; - struct cds_list_head head; + /* End of base ABI. Fields below should be used after checking struct_size. */ }; -struct ust_pending_probe; -struct lttng_event; - /* - * Bytecode interpreter return value masks. + * lttng_event structure is referred to by the tracing fast path. It + * must be kept small. + * + * 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. */ -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_event_common_private; + +enum lttng_ust_event_type { + LTTNG_UST_EVENT_TYPE_RECORDER = 0, + LTTNG_UST_EVENT_TYPE_NOTIFIER = 1, +}; /* - * This structure is used in the probes. More specifically, the `filter` 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. + * Result of the run_filter() callback. */ -struct lttng_bytecode_runtime { - /* Associated bytecode */ - struct lttng_ust_bytecode_node *bc; - 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; - int link_failed; - struct cds_list_head node; /* list of bytecode runtime in event */ - /* - * Pointer to a URCU-protected pointer owned by an `struct - * lttng_session`or `struct lttng_event_notifier_group`. - */ - struct lttng_ctx **pctx; +enum lttng_ust_event_filter_result { + LTTNG_UST_EVENT_FILTER_ACCEPT = 0, + LTTNG_UST_EVENT_FILTER_REJECT = 1, }; /* - * Objects in a linked-list of enablers, owned by an event or event_notifier. - * This is used because an event (or a event_notifier) can be enabled by more - * than one enabler and we want a quick way to iterate over all enablers of an - * object. + * 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. * - * For example, event rules "my_app:a*" and "my_app:ab*" will both match the - * event with the name "my_app:abc". + * 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_enabler_ref { - struct cds_list_head node; /* enabler ref list */ - struct lttng_enabler *ref; /* backward ref */ +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 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_recorder_private; + /* - * lttng_event structure is referred to by the tracing fast path. It - * must be kept small. - * * 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_event { - unsigned int id; - struct lttng_channel *chan; - int enabled; - const struct lttng_event_desc *desc; - struct lttng_ctx *ctx; - enum lttng_ust_instrumentation instrumentation; - struct cds_list_head node; /* Event list in session */ - - /* list of struct lttng_bytecode_runtime, sorted by seqnum */ - struct cds_list_head filter_bytecode_runtime_head; - int has_enablers_without_bytecode; - /* Backward references: list of lttng_enabler_ref (ref to enablers) */ - struct cds_list_head enablers_ref_head; - struct cds_hlist_node hlist; /* session ht of events */ - int registered; /* has reg'd tracepoint probe */ -}; +struct lttng_ust_event_recorder { + uint32_t struct_size; /* Size of this structure. */ -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, - 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_ust_event_common *parent; /* Inheritance by aggregation. */ + struct lttng_ust_event_recorder_private *priv; /* Private event record interface */ + + struct lttng_ust_channel_buffer *chan; + + /* End of base ABI. Fields below should be used after checking struct_size. */ }; -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 */ +/* + * 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 channel; -struct lttng_ust_shm_handle; +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_channel_ops { - struct lttng_channel *(*channel_create)(const char *name, - void *buf_addr, - size_t subbuf_size, size_t num_subbuf, - unsigned int switch_timer_interval, - unsigned int read_timer_interval, - unsigned char *uuid, - uint32_t chan_id, - const int *stream_fds, int nr_stream_fds, - int64_t blocking_timeout); - void (*channel_destroy)(struct lttng_channel *chan); - 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); - /* - * packet_avail_size returns the available size in the current - * packet. Note that the size returned is only a hint, since it - * may change due to concurrent writes. - */ - size_t (*packet_avail_size)(struct channel *chan, - struct lttng_ust_shm_handle *handle); - int (*is_finalized)(struct channel *chan); - int (*is_disabled)(struct channel *chan); - 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); +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 */ + + 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_ring_buffer_channel; +struct lttng_ust_channel_buffer_ops_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 channel *chan; /* Channel buffers */ - int enabled; - struct lttng_ctx *ctx; - /* Event ID management */ - 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; - 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; - unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ - int tstate:1; /* Transient enable state */ -}; +struct lttng_ust_channel_buffer_ops { + uint32_t struct_size; -#define LTTNG_COUNTER_DIMENSION_MAX 8 + struct lttng_ust_channel_buffer_ops_private *priv; /* Private channel buffer ops interface */ -struct lttng_counter_dimension { - uint64_t size; - uint64_t underflow_index; - uint64_t overflow_index; - uint8_t has_underflow; - uint8_t has_overflow; -}; + 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); -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); + /* End of base ABI. Fields below should be used after checking struct_size. */ }; -#define LTTNG_UST_STACK_CTX_PADDING 32 -struct lttng_stack_ctx { - struct lttng_event *event; - struct lttng_ctx *chan_ctx; /* RCU dereferenced. */ - struct lttng_ctx *event_ctx; /* RCU dereferenced. */ - char padding[LTTNG_UST_STACK_CTX_PADDING]; +enum lttng_ust_channel_type { + LTTNG_UST_CHANNEL_TYPE_BUFFER = 0, }; -#define LTTNG_UST_EVENT_HT_BITS 12 -#define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS) +struct lttng_ust_channel_common_private; -struct lttng_ust_event_ht { - struct cds_hlist_head table[LTTNG_UST_EVENT_HT_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_channel_common { + uint32_t struct_size; /* Size of this structure. */ -#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]; -}; + struct lttng_ust_channel_common_private *priv; /* Private channel interface */ -#define LTTNG_UST_ENUM_HT_BITS 12 -#define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS) + enum lttng_ust_channel_type type; + void *child; /* Pointer to child, for inheritance by aggregation. */ -struct lttng_ust_enum_ht { - struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE]; + int enabled; + struct lttng_ust_session *session; + + /* 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_session { - int active; /* Is trace session active ? */ - int been_active; /* Been active ? */ - int objd; /* Object associated */ - struct cds_list_head chan_head; /* Channel list head */ - struct cds_list_head events_head; /* list of events */ - struct cds_list_head node; /* Session list */ - - /* New UST 2.1 */ - /* List of enablers */ - struct cds_list_head enablers_head; - struct lttng_ust_event_ht events_ht; /* ht of events */ - void *owner; /* object owner */ - int tstate:1; /* Transient enable state */ - - /* New UST 2.4 */ - int statedump_pending:1; - - /* New UST 2.8 */ - struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */ - struct cds_list_head enums_head; - struct lttng_ctx *ctx; /* contexts for filters. */ -}; +struct lttng_ust_channel_buffer { + uint32_t struct_size; /* Size of this structure. */ -struct lttng_counter { - int objd; - struct lttng_event_notifier_group *event_notifier_group; /* owner */ - struct lttng_counter_transport *transport; - struct lib_counter *counter; - struct lttng_counter_ops *ops; -}; + struct lttng_ust_channel_common *parent; /* Inheritance by aggregation. */ + struct lttng_ust_channel_buffer_private *priv; /* Private channel buffer interface */ -struct lttng_event_notifier_group { - int objd; - void *owner; - int notification_fd; - struct cds_list_head node; /* Event notifier group handle list */ - struct cds_list_head enablers_head; - struct cds_list_head event_notifiers_head; /* list of event_notifiers */ - struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */ - struct lttng_ctx *ctx; /* contexts for filters. */ - - struct lttng_counter *error_counter; - size_t error_counter_len; -}; + struct lttng_ust_channel_buffer_ops *ops; -struct lttng_transport { - char *name; - struct cds_list_head node; - struct lttng_channel_ops ops; - const struct lttng_ust_lib_ring_buffer_config *client_config; + /* End of base ABI. Fields below should be used after checking struct_size. */ }; -struct lttng_counter_transport { - char *name; - struct cds_list_head node; - struct lttng_counter_ops ops; - const struct lib_counter_config *client_config; +/* + * 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 */ + + struct lttng_ust_event_recorder *event_recorder; + + /* End of base ABI. Fields below should be used after checking struct_size. */ }; -struct lttng_session *lttng_session_create(void); -int lttng_session_enable(struct lttng_session *session); -int lttng_session_disable(struct lttng_session *session); -int lttng_session_statedump(struct lttng_session *session); -void lttng_session_destroy(struct lttng_session *session); - -struct lttng_channel *lttng_channel_create(struct lttng_session *session, - const char *transport_name, - void *buf_addr, - size_t subbuf_size, size_t num_subbuf, - unsigned int switch_timer_interval, - unsigned int read_timer_interval, - int **shm_fd, int **wait_fd, - uint64_t **memory_map_size, - struct lttng_channel *chan_priv_init); - -int lttng_channel_enable(struct lttng_channel *channel); -int lttng_channel_disable(struct lttng_channel *channel); - -void lttng_transport_register(struct lttng_transport *transport); -void lttng_transport_unregister(struct lttng_transport *transport); - -int lttng_probe_register(struct lttng_probe_desc *desc); -void lttng_probe_unregister(struct lttng_probe_desc *desc); -void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc); -int lttng_fix_pending_events(void); -int lttng_probes_init(void); -void lttng_probes_exit(void); +struct lttng_ust_session_private; /* - * Can be used by applications that change their procname to clear the ust cached value. + * 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. */ -void lttng_context_procname_reset(void); +struct lttng_ust_session { + uint32_t struct_size; /* Size of this structure */ -struct lttng_transport *lttng_transport_find(const char *name); + struct lttng_ust_session_private *priv; /* Private session interface */ -int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list); -void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list); -struct lttng_ust_tracepoint_iter * - lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list); -int lttng_probes_get_field_list(struct lttng_ust_field_list *list); -void lttng_probes_prune_field_list(struct lttng_ust_field_list *list); -struct lttng_ust_field_iter * - lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list); - -void lttng_free_event_filter_runtime(struct lttng_event *event); + int active; /* Is trace session active ? */ -struct cds_list_head *lttng_get_probe_list_head(void); -int lttng_session_active(void); + /* End of base ABI. Fields below should be used after checking struct_size. */ +}; -typedef int (*t_statedump_func_ptr)(struct lttng_session *session); -void lttng_handle_pending_statedump(void *owner); -struct cds_list_head *_lttng_get_sessions(void); +/* + * 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); -struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session, - const struct lttng_enum_desc *enum_desc); +void lttng_ust_probe_unregister(struct lttng_ust_registered_probe *reg_probe); -void lttng_ust_dl_update(void *ip); +/* + * 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_ust_context_procname_reset(void); #ifdef __cplusplus }