X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=164c82c4c8288617702a56edc5eec30ba341b6aa;hb=891d6b550bf16672b0c3a7b35362f231d6e10fc1;hp=fefb8585536c6173e1d624954f58a8fba89421e9;hpb=db56acaff475812dfd774a52b3d54eae5c115315;p=lttng-ust.git diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h index fefb8585..164c82c4 100644 --- a/include/lttng/ust-events.h +++ b/include/lttng/ust-events.h @@ -1,36 +1,18 @@ -#ifndef _LTTNG_UST_EVENTS_H -#define _LTTNG_UST_EVENTS_H - /* - * lttng/ust-events.h + * SPDX-License-Identifier: MIT * - * Copyright 2010-2012 (c) - Mathieu Desnoyers + * Copyright (C) 2010-2012 Mathieu Desnoyers * * Holds LTTng per-session event registry. - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. */ +#ifndef _LTTNG_UST_EVENTS_H +#define _LTTNG_UST_EVENTS_H + #include #include +#include #include -#include #include #include #include @@ -55,45 +37,32 @@ extern "C" { * library, but the opposite is rejected: a newer tracepoint provider is * rejected by an older lttng-ust library. */ -#define LTTNG_UST_PROVIDER_MAJOR 1 +#define LTTNG_UST_PROVIDER_MAJOR 2 #define LTTNG_UST_PROVIDER_MINOR 0 struct lttng_channel; struct lttng_session; struct lttng_ust_lib_ring_buffer_ctx; -struct lttng_ust_context_app; -struct lttng_event_field; +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. */ -/* - * LTTng client type enumeration. Used by the consumer to map the - * callbacks from its own address space. - */ -enum lttng_client_types { - LTTNG_CLIENT_METADATA = 0, - LTTNG_CLIENT_DISCARD = 1, - LTTNG_CLIENT_OVERWRITE = 2, - LTTNG_CLIENT_DISCARD_RT = 3, - LTTNG_CLIENT_OVERWRITE_RT = 4, - LTTNG_NR_CLIENT_TYPES, -}; - /* Type description */ /* Update the astract_types name table in lttng-types.c along with this enum */ enum lttng_abstract_types { atype_integer, - atype_enum, - atype_array, - atype_sequence, atype_string, atype_float, atype_dynamic, - atype_struct, + atype_enum_nestable, + atype_array_nestable, + atype_sequence_nestable, + atype_struct_nestable, NR_ABSTRACT_TYPES, }; @@ -114,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) \ @@ -131,17 +110,14 @@ struct lttng_enum_entry { .atype = atype_integer, \ .u = \ { \ - .basic = \ + .integer = \ { \ - .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, \ - } \ + .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, \ } \ }, \ } \ @@ -171,18 +147,15 @@ struct lttng_integer_type { .atype = atype_float, \ .u = \ { \ - .basic = \ + ._float = \ { \ - ._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, \ - } \ + .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 @@ -194,54 +167,60 @@ struct lttng_float_type { char padding[LTTNG_UST_FLOAT_TYPE_PADDING]; }; -#define LTTNG_UST_BASIC_TYPE_PADDING 128 -union _lttng_basic_type { - struct lttng_integer_type integer; - struct { - const struct lttng_enum_desc *desc; /* Enumeration mapping */ - struct lttng_integer_type container_type; - } enumeration; - struct { - enum lttng_string_encodings encoding; - } string; - struct lttng_float_type _float; - char padding[LTTNG_UST_BASIC_TYPE_PADDING]; -}; - -struct lttng_basic_type { - enum lttng_abstract_types atype; - union { - union _lttng_basic_type basic; - } u; -}; - #define LTTNG_UST_TYPE_PADDING 128 struct lttng_type { enum lttng_abstract_types atype; union { - union _lttng_basic_type basic; + /* provider ABI 2.0 */ + struct lttng_integer_type integer; + struct lttng_float_type _float; + struct { + enum lttng_string_encodings encoding; + } string; struct { - struct lttng_basic_type elem_type; - unsigned int length; /* num. elems. */ - } array; + const struct lttng_ust_enum_desc *desc; /* Enumeration mapping */ + struct lttng_type *container_type; + } enum_nestable; struct { - struct lttng_basic_type length_type; - struct lttng_basic_type elem_type; - } sequence; + const struct lttng_type *elem_type; + unsigned int length; /* Num. elems. */ + unsigned int alignment; + } array_nestable; struct { - uint32_t nr_fields; - struct lttng_event_field *fields; /* Array of fields. */ - } _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; }; -#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. */ }; /* @@ -250,14 +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 */ - char padding[LTTNG_UST_EVENT_FIELD_PADDING]; + 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 { @@ -280,6 +266,7 @@ struct lttng_ctx_value { enum lttng_ust_dynamic_type sel; union { int64_t s64; + uint64_t u64; const char *str; double d; } u; @@ -289,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, @@ -313,165 +300,191 @@ 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. */ -enum lttng_enabler_type { - LTTNG_ENABLER_STAR_GLOB, - LTTNG_ENABLER_EVENT, -}; - /* - * Enabler field, within whatever object is enabling an event. Target of - * backward reference. + * Bytecode interpreter return value masks. */ -struct lttng_enabler { - enum lttng_enabler_type type; - - /* head list of struct lttng_ust_filter_bytecode_node */ - struct cds_list_head filter_bytecode_head; - /* head list of struct lttng_ust_excluder_node */ - struct cds_list_head excluder_head; - struct cds_list_head node; /* per-session list of enablers */ - - struct lttng_ust_event event_param; - struct lttng_channel *chan; - struct lttng_ctx *ctx; - unsigned int enabled:1; +enum lttng_bytecode_interpreter_ret { + LTTNG_INTERPRETER_DISCARD = 0, + LTTNG_INTERPRETER_RECORD_FLAG = (1ULL << 0), + /* Other bits are kept for future use. */ }; -struct tp_list_entry { - struct lttng_ust_tracepoint_iter tp; - struct cds_list_head head; -}; +struct lttng_interpreter_output; +struct lttng_ust_bytecode_runtime_private; -struct lttng_ust_tracepoint_list { - struct tp_list_entry *iter; - struct cds_list_head head; -}; +/* + * 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. + */ +struct lttng_bytecode_runtime { + struct lttng_ust_bytecode_runtime_private *priv; -struct tp_field_list_entry { - struct lttng_ust_field_iter field; - struct cds_list_head head; + /* 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 */ }; -struct lttng_ust_field_list { - struct tp_field_list_entry *iter; - struct cds_list_head head; -}; +/* + * 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 ust_pending_probe; -struct lttng_event; +struct lttng_ust_event_common_private; -struct lttng_ust_filter_bytecode_node { - struct cds_list_head node; - struct lttng_enabler *enabler; - /* - * struct lttng_ust_filter_bytecode has var. sized array, must - * be last field. - */ - struct lttng_ust_filter_bytecode bc; +enum lttng_ust_event_type { + LTTNG_UST_EVENT_TYPE_RECORDER = 0, + LTTNG_UST_EVENT_TYPE_NOTIFIER = 1, }; -struct lttng_ust_excluder_node { - struct cds_list_head node; - struct lttng_enabler *enabler; - /* - * struct lttng_ust_event_exclusion had variable sized array, - * must be last field. - */ - struct lttng_ust_event_exclusion excluder; -}; /* - * Filter return value masks. + * 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. */ -enum lttng_filter_ret { - LTTNG_FILTER_DISCARD = 0, - LTTNG_FILTER_RECORD_FLAG = (1ULL << 0), - /* Other bits are kept for future use. */ -}; +struct lttng_ust_event_common { + uint32_t struct_size; /* Size of this structure. */ + struct lttng_ust_event_common_private *priv; /* Private event interface */ -struct lttng_bytecode_runtime { - /* Associated bytecode */ - struct lttng_ust_filter_bytecode_node *bc; - uint64_t (*filter)(void *filter_data, const char *filter_stack_data); - int link_failed; - struct cds_list_head node; /* list of bytecode runtime in event */ - struct lttng_session *session; - struct lttng_event *event; -}; + enum lttng_ust_event_type type; + void *child; /* Pointer to child, for inheritance by aggregation. */ -/* - * Objects in a linked-list of enablers, owned by an event. - */ -struct lttng_enabler_ref { - struct cds_list_head node; /* enabler ref list */ - struct lttng_enabler *ref; /* backward ref */ + 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; + /* - * 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 { - /* LTTng-UST 2.0 starts here */ +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; - int enabled; - const struct lttng_event_desc *desc; - void *_deprecated1; struct lttng_ctx *ctx; - enum lttng_ust_instrumentation instrumentation; - struct cds_list_head node; /* Event list in session */ - struct cds_list_head _deprecated2; - void *_deprecated3; - unsigned int _deprecated4:1; - /* LTTng-UST 2.1 starts here */ - /* list of struct lttng_bytecode_runtime, sorted by seqnum */ - struct cds_list_head 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 */ + /* 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; /* 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 { - 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 */ @@ -497,11 +510,6 @@ struct lttng_channel_ops { const int *stream_fds, int nr_stream_fds, int64_t blocking_timeout); void (*channel_destroy)(struct lttng_channel *chan); - union { - void *_deprecated1; - unsigned long has_strcpy:1; /* ABI has strcpy */ - } u; - void *_deprecated2; 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); @@ -514,8 +522,6 @@ struct lttng_channel_ops { */ size_t (*packet_avail_size)(struct channel *chan, struct lttng_ust_shm_handle *handle); - //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan); - //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan); int (*is_finalized)(struct channel *chan); int (*is_disabled)(struct channel *chan); int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle); @@ -541,24 +547,43 @@ struct lttng_channel { /* Event ID management */ struct lttng_session *session; int objd; /* Object associated to channel */ - unsigned int _deprecated1; - unsigned int _deprecated2; 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 */ - unsigned int _deprecated3:1; /* 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); +}; + #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]; @@ -571,6 +596,12 @@ 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) @@ -578,176 +609,39 @@ struct lttng_ust_enum_ht { struct cds_hlist_head table[LTTNG_UST_ENUM_HT_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 ? */ - int been_active; /* Been active ? */ - int objd; /* Object associated */ - void *_deprecated1; - struct cds_list_head chan_head; /* Channel list head */ - struct cds_list_head events_head; /* list of events */ - struct cds_list_head _deprecated2; - struct cds_list_head node; /* Session list */ - int _deprecated3; - unsigned int _deprecated4:1; - - /* 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_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_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); - -struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type, - struct lttng_ust_event *event_param, - struct lttng_channel *chan); -int lttng_enabler_enable(struct lttng_enabler *enabler); -int lttng_enabler_disable(struct lttng_enabler *enabler); -int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler, - struct lttng_ust_filter_bytecode_node *bytecode); -int lttng_enabler_attach_context(struct lttng_enabler *enabler, - struct lttng_ust_context *ctx); -int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler, - struct lttng_ust_excluder_node *excluder); - -int lttng_attach_context(struct lttng_ust_context *context_param, - union ust_args *uargs, - struct lttng_ctx **ctx, struct lttng_session *session); -int lttng_session_context_init(struct lttng_ctx **ctx); - -void lttng_transport_register(struct lttng_transport *transport); -void lttng_transport_unregister(struct lttng_transport *transport); - -void synchronize_trace(void); - -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); -int lttng_find_context(struct lttng_ctx *ctx, const char *name); -int lttng_get_context_index(struct lttng_ctx *ctx, const char *name); -struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p); -void lttng_context_update(struct lttng_ctx *ctx); -void lttng_remove_context_field(struct lttng_ctx **ctx_p, - struct lttng_ctx_field *field); -void lttng_destroy_context(struct lttng_ctx *ctx); -int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx); -int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx); -int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx); -int lttng_add_procname_to_ctx(struct lttng_ctx **ctx); -int lttng_add_ip_to_ctx(struct lttng_ctx **ctx); -int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx); -int lttng_add_dyntest_to_ctx(struct lttng_ctx **ctx); -void lttng_context_vtid_reset(void); -void lttng_context_vpid_reset(void); -void lttng_context_procname_reset(void); +int lttng_ust_probe_register(struct lttng_ust_probe_desc *desc); +void lttng_ust_probe_unregister(struct lttng_ust_probe_desc *desc); -#ifdef LTTNG_UST_HAVE_PERF_EVENT -int lttng_add_perf_counter_to_ctx(uint32_t type, - uint64_t config, - const char *name, - struct lttng_ctx **ctx); -int lttng_perf_counter_init(void); -void lttng_perf_counter_exit(void); -#else /* #ifdef LTTNG_UST_HAVE_PERF_EVENT */ -static inline -int lttng_add_perf_counter_to_ctx(uint32_t type, - uint64_t config, - const char *name, - struct lttng_ctx **ctx) -{ - return -ENOSYS; -} -static inline -int lttng_perf_counter_init(void) -{ - return 0; -} -static inline -void lttng_perf_counter_exit(void) -{ -} -#endif /* #else #ifdef LTTNG_UST_HAVE_PERF_EVENT */ - -extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata; -extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_discard; -extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite; +/* + * Can be used by applications that change their procname to clear the ust cached value. + */ +void lttng_context_procname_reset(void); struct lttng_transport *lttng_transport_find(const char *name); -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_filter_event_link_bytecode(struct lttng_event *event); -void lttng_enabler_event_link_bytecode(struct lttng_event *event, - struct lttng_enabler *enabler); -void lttng_free_event_filter_runtime(struct lttng_event *event); -void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime); - -struct cds_list_head *lttng_get_probe_list_head(void); int lttng_session_active(void); -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); - -struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session, - const struct lttng_enum_desc *enum_desc); - void lttng_ust_dl_update(void *ip); -void lttng_ust_fixup_fd_tracker_tls(void); - -/* For backward compatibility. Leave those exported symbols in place. */ -extern struct lttng_ctx *lttng_static_ctx; -void lttng_context_init(void); -void lttng_context_exit(void); #ifdef __cplusplus }