X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=b687934d67b889fa6ec40e58447aa1c8a94865d6;hb=3b8bedd809f1a5b56da5fc101a90b44263b0f473;hp=809c056d660662b5ac537e6798811a85c939e940;hpb=cbba5e044240cd4e5b90b1a312cb1cd692e027ea;p=lttng-ust.git diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h index 809c056d..b687934d 100644 --- a/include/lttng/ust-events.h +++ b/include/lttng/ust-events.h @@ -20,10 +20,7 @@ #include #include #include - -#ifndef LTTNG_PACKED -#error "LTTNG_PACKED should be defined" -#endif +#include #ifdef __cplusplus extern "C" { @@ -40,47 +37,44 @@ extern "C" { #define LTTNG_UST_PROVIDER_MAJOR 2 #define LTTNG_UST_PROVIDER_MINOR 0 -struct lttng_channel; -struct lttng_session; +struct lttng_ust_channel_buffer; +struct lttng_ust_session; struct lttng_ust_lib_ring_buffer_ctx; struct lttng_ust_event_field; -struct lttng_event_notifier_group; /* * 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_string, - atype_float, - atype_dynamic, - 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, }; /* @@ -98,107 +92,113 @@ enum lttng_enum_entry_options { struct lttng_ust_enum_entry { uint32_t struct_size; - struct lttng_enum_value start, end; /* start and end are inclusive */ + struct lttng_ust_enum_value start, end; /* start and end are inclusive */ const char *string; unsigned int options; /* End of base ABI. Fields below should be used after checking struct_size. */ }; -#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_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; +}; + +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_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_alignof(_type) * CHAR_BIT, \ + .signedness = lttng_ust_is_signed_type(_type), \ + .reverse_byte_order = _byte_order != 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_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_alignof(_type) * CHAR_BIT, \ + .reverse_byte_order = BYTE_ORDER != 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; + struct lttng_ust_enum_desc *desc; /* Enumeration mapping */ + struct lttng_ust_type_common *container_type; }; -#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_ust_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_ust_event_field **fields; /* Array of pointers to fields. */ - unsigned int alignment; - } struct_nestable; - - char padding[LTTNG_UST_TYPE_PADDING]; - } u; +struct lttng_ust_type_array { + struct lttng_ust_type_common parent; + uint32_t struct_size; + struct lttng_ust_type_common *elem_type; + unsigned int length; /* Num. elems. */ + unsigned int alignment; + enum lttng_ust_string_encoding encoding; +}; + +struct lttng_ust_type_sequence { + struct lttng_ust_type_common parent; + uint32_t struct_size; + const char *length_name; /* Length field name. */ + struct lttng_ust_type_common *elem_type; + unsigned int alignment; /* Alignment before elements. */ + enum lttng_ust_string_encoding encoding; +}; + +struct lttng_ust_type_struct { + struct lttng_ust_type_common parent; + uint32_t struct_size; + unsigned int nr_fields; + struct lttng_ust_event_field **fields; /* Array of pointers to fields. */ + unsigned int alignment; }; /* @@ -217,7 +217,7 @@ struct lttng_ust_enum_desc { uint32_t struct_size; const char *name; - const struct lttng_ust_enum_entry **entries; + struct lttng_ust_enum_entry **entries; unsigned int nr_entries; /* End of base ABI. Fields below should be used after checking struct_size. */ @@ -239,66 +239,13 @@ struct lttng_ust_event_field { uint32_t struct_size; const char *name; - struct lttng_type type; + struct lttng_ust_type_common *type; 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 { - 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, -}; - -struct lttng_ctx_value { - enum lttng_ust_dynamic_type sel; - union { - int64_t s64; - uint64_t u64; - const char *str; - double d; - } u; -}; - -struct lttng_perf_counter_field; - -#define LTTNG_UST_CTX_FIELD_PADDING 40 -struct lttng_ctx_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, - 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. */ -}; - -#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]; -}; /* * IMPORTANT: this structure is part of the ABI between the probe and @@ -311,10 +258,12 @@ struct lttng_ctx { */ struct lttng_ust_event_desc { uint32_t struct_size; /* Size of this structure. */ - const char *name; + + const char *event_name; + struct lttng_ust_probe_desc *probe_desc; void (*probe_callback)(void); - const struct lttng_event_ctx *ctx; /* context */ - const struct lttng_ust_event_field **fields; /* event payload */ + struct lttng_event_ctx *ctx; /* context */ + struct lttng_ust_event_field **fields; /* event payload */ unsigned int nr_fields; const int **loglevel; const char *signature; /* Argument types/names received */ @@ -335,8 +284,8 @@ struct lttng_ust_event_desc { struct lttng_ust_probe_desc { uint32_t struct_size; /* Size of this structure. */ - const char *provider; - const struct lttng_ust_event_desc **event_desc; + const char *provider_name; + 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; @@ -349,44 +298,6 @@ struct lttng_ust_probe_desc { /* Data structures used by the tracer. */ -/* - * Bytecode interpreter return value masks. - */ -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_bytecode_runtime_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_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, - const char *interpreter_stack_data); - uint64_t (*capture)(void *interpreter_data, - const char *interpreter_stack_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. */ -}; - /* * lttng_event structure is referred to by the tracing fast path. It * must be kept small. @@ -396,6 +307,7 @@ struct lttng_ust_bytecode_runtime { * removed. */ +struct lttng_ust_ctx; struct lttng_ust_event_common_private; enum lttng_ust_event_type { @@ -403,6 +315,14 @@ enum lttng_ust_event_type { LTTNG_UST_EVENT_TYPE_NOTIFIER = 1, }; +/* + * Result of the run_filter() callback. + */ +enum lttng_ust_event_filter_result { + LTTNG_UST_EVENT_FILTER_ACCEPT = 0, + LTTNG_UST_EVENT_FILTER_REJECT = 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 @@ -420,15 +340,17 @@ enum lttng_ust_event_type { */ 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_ust_bytecode_runtime, sorted by seqnum */ - struct cds_list_head filter_bytecode_runtime_head; + int eval_filter; /* Need to evaluate filters */ + int (*run_filter)(struct lttng_ust_event_common *event, + const char *stack_data, + void *filter_ctx); /* End of base ABI. Fields below should be used after checking struct_size. */ }; @@ -451,12 +373,28 @@ struct lttng_ust_event_recorder_private; */ 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; + struct lttng_ust_channel_buffer *chan; + + /* 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. + */ +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. */ }; @@ -483,15 +421,16 @@ struct lttng_ust_event_notifier { 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)(struct lttng_ust_event_notifier *event_notifier, - const char *stack_data); - struct cds_list_head capture_bytecode_runtime_head; + const char *stack_data, + struct lttng_ust_notification_ctx *notif_ctx); /* End of base ABI. Fields below should be used after checking struct_size. */ }; -struct channel; -struct lttng_ust_shm_handle; +struct lttng_ust_lib_ring_buffer_channel; +struct lttng_ust_channel_buffer_ops_private; /* * IMPORTANT: this structure is part of the ABI between the probe and @@ -502,68 +441,73 @@ struct lttng_ust_shm_handle; * structure. It should be queried before using additional fields added * at the end of the structure. */ -struct lttng_ust_channel_ops { +struct lttng_ust_channel_buffer_ops { uint32_t struct_size; - 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); + struct lttng_ust_channel_buffer_ops_private *priv; /* Private channel buffer ops interface */ + 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); + void (*event_pstrcpy_pad)(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. */ }; +enum lttng_ust_channel_type { + LTTNG_UST_CHANNEL_TYPE_BUFFER = 0, +}; + +struct lttng_ust_channel_common_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 */ +struct lttng_ust_channel_common { + uint32_t struct_size; /* Size of this structure. */ + + struct lttng_ust_channel_common_private *priv; /* Private channel interface */ + + enum lttng_ust_channel_type type; + void *child; /* Pointer to child, for inheritance by aggregation. */ + 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_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_abi_chan_type type; - unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ - int tstate:1; /* Transient enable state */ + 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_ust_channel_buffer { + uint32_t struct_size; /* Size of this structure. */ + + struct lttng_ust_channel_common *parent; /* Inheritance by aggregation. */ + struct lttng_ust_channel_buffer_private *priv; /* Private channel buffer interface */ + + struct lttng_ust_channel_buffer_ops *ops; + + /* End of base ABI. Fields below should be used after checking struct_size. */ }; /* @@ -579,8 +523,6 @@ struct lttng_ust_stack_ctx { uint32_t struct_size; /* Size of this structure */ struct lttng_ust_event_recorder *event_recorder; - struct lttng_ctx *chan_ctx; /* RCU dereferenced. */ - struct lttng_ctx *event_ctx; /* RCU dereferenced. */ /* End of base ABI. Fields below should be used after checking struct_size. */ }; @@ -596,8 +538,9 @@ struct lttng_ust_session_private; * structure. It should be queried before using additional fields added * at the end of the structure. */ -struct lttng_session { +struct lttng_ust_session { uint32_t struct_size; /* Size of this structure */ + struct lttng_ust_session_private *priv; /* Private session interface */ int active; /* Is trace session active ? */