X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=d87abbf539b2cf0ebfc1f64fa0ff7307c4435ead;hb=refs%2Fheads%2Fsow-2020-0002-rev2;hp=3fee93c435038acf3150759aa7d5c964bd38e448;hpb=cefef7a70a723c31ab6a0746c7611f145337dabe;p=deliverable%2Flttng-ust.git diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h index 3fee93c4..d87abbf5 100644 --- a/include/lttng/ust-events.h +++ b/include/lttng/ust-events.h @@ -1,32 +1,14 @@ -#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 @@ -56,7 +38,7 @@ 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 2 +#define LTTNG_UST_PROVIDER_MAJOR 3 #define LTTNG_UST_PROVIDER_MINOR 0 struct lttng_channel; @@ -64,6 +46,8 @@ struct lttng_session; struct lttng_ust_lib_ring_buffer_ctx; struct lttng_ust_context_app; struct lttng_event_field; +struct lttng_event_notifier; +struct lttng_event_notifier_group; /* * Data structures used by tracepoint event declarations, and by the @@ -315,6 +299,7 @@ struct lttng_ctx_value { enum lttng_ust_dynamic_type sel; union { int64_t s64; + uint64_t u64; const char *str; double d; } u; @@ -351,7 +336,7 @@ struct lttng_ctx { #define LTTNG_UST_EVENT_DESC_PADDING 40 struct lttng_event_desc { const char *name; - void (*probe_callback)(void); + void (*probe_callback)(void); /* store-event and count-event probe */ const struct lttng_event_ctx *ctx; /* context */ const struct lttng_event_field *fields; /* event payload */ unsigned int nr_fields; @@ -360,6 +345,7 @@ struct lttng_event_desc { union { struct { const char **model_emf_uri; + void (*event_notifier_callback)(void); } ext; char padding[LTTNG_UST_EVENT_DESC_PADDING]; } u; @@ -380,32 +366,9 @@ struct lttng_probe_desc { /* 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. - */ -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; - /* - * Unused, but kept around to make it explicit that the tracer can do - * it. - */ - struct lttng_ctx *ctx; - unsigned int enabled:1; +enum lttng_enabler_format_type { + LTTNG_ENABLER_FORMAT_STAR_GLOB, + LTTNG_ENABLER_FORMAT_EVENT, }; struct tp_list_entry { @@ -431,34 +394,17 @@ struct lttng_ust_field_list { struct ust_pending_probe; struct lttng_event; -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; -}; - -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. + * Bytecode interpreter return value masks. */ -enum lttng_filter_ret { - LTTNG_FILTER_DISCARD = 0, - LTTNG_FILTER_RECORD_FLAG = (1ULL << 0), +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; + /* * This structure is used in the probes. More specifically, the `filter` and * `node` fields are explicity used in the probes. When modifying this @@ -467,21 +413,68 @@ enum lttng_filter_ret { */ struct lttng_bytecode_runtime { /* Associated bytecode */ - struct lttng_ust_filter_bytecode_node *bc; - uint64_t (*filter)(void *filter_data, const char *filter_stack_data); + 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 */ - struct lttng_session *session; + /* + * Pointer to a URCU-protected pointer owned by an `struct + * lttng_session`or `struct lttng_event_notifier_group`. + */ + struct lttng_ctx **pctx; }; /* - * Objects in a linked-list of enablers, owned by an event. + * 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. + * + * For example, event rules "my_app:a*" and "my_app:ab*" will both match the + * event with the name "my_app:abc". */ struct lttng_enabler_ref { struct cds_list_head node; /* enabler ref list */ struct lttng_enabler *ref; /* backward ref */ }; +enum lttng_event_container_type { + LTTNG_EVENT_CONTAINER_CHANNEL, + LTTNG_EVENT_CONTAINER_COUNTER, +}; + +enum lttng_key_token_type { + LTTNG_KEY_TOKEN_STRING = 0, + LTTNG_KEY_TOKEN_EVENT_NAME = 1, + LTTNG_KEY_TOKEN_PROVIDER_NAME = 2, +}; + +#define LTTNG_KEY_TOKEN_STRING_LEN_MAX LTTNG_UST_KEY_TOKEN_STRING_LEN_MAX +struct lttng_key_token { + enum lttng_key_token_type type; + union { + char string[LTTNG_KEY_TOKEN_STRING_LEN_MAX]; + } arg; +}; + +#define LTTNG_NR_KEY_TOKEN LTTNG_UST_NR_KEY_TOKEN +struct lttng_counter_key_dimension { + size_t nr_key_tokens; + struct lttng_key_token key_tokens[LTTNG_UST_NR_KEY_TOKEN]; +}; + +#define LTTNG_COUNTER_DIMENSION_MAX LTTNG_UST_COUNTER_DIMENSION_MAX +struct lttng_counter_key { + size_t nr_dimensions; + struct lttng_counter_key_dimension key_dimensions[LTTNG_COUNTER_DIMENSION_MAX]; +}; + /* * lttng_event structure is referred to by the tracing fast path. It * must be kept small. @@ -491,27 +484,50 @@ struct lttng_enabler_ref { * removed. */ struct lttng_event { - /* LTTng-UST 2.0 starts here */ unsigned int id; - struct lttng_channel *chan; + struct lttng_channel *chan; /* for backward compatibility */ 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; + 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 */ + struct cds_hlist_node name_hlist; /* session ht of events, per event name */ + int registered; /* has reg'd tracepoint probe */ + + /* LTTng-UST 2.14 starts here */ + uint64_t counter_index; /* counter index */ + struct lttng_event_container *container; + struct cds_hlist_node key_hlist; /* session ht of events, per key */ + char key[LTTNG_KEY_TOKEN_STRING_LEN_MAX]; + /* + * For non-coalesce-hit event containers, each events is + * associated with a single event enabler token. + */ + uint64_t user_token; +}; + +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_enum { @@ -541,18 +557,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; - /* - * has_strcpy is needed by probe providers version 1.0 to - * dynamically detect whether the LTTng-UST tracepoint - * provider ABI implements event_strcpy. Starting from - * probe providers version 2.0, the check is not needed, - * but backward compatibility is provided for older versions. - */ - 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); @@ -565,8 +569,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); @@ -574,6 +576,20 @@ struct lttng_channel_ops { const char *src, size_t len); }; +/* + * This structure is ABI with the tracepoint probes, and must preserve + * backward compatibility. Fields can only be added at the end, and + * never removed nor reordered. + */ +struct lttng_event_container { + enum lttng_event_container_type type; + int objd; + struct lttng_session *session; /* Session containing the container */ + int enabled; + unsigned int tstate:1; /* Transient enable state */ + bool coalesce_hits; +}; + /* * 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 @@ -587,24 +603,43 @@ struct lttng_channel { * and perform subbuffer flush. */ struct channel *chan; /* Channel buffers */ - int enabled; + int enabled; /* For backward compatibility */ struct lttng_ctx *ctx; /* Event ID management */ - struct lttng_session *session; + struct lttng_session *session; /* For backward compatibility */ 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; unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ - int tstate:1; /* Transient enable state */ + int _deprecated:1; + + struct lttng_event_container parent; +}; + +struct lttng_counter_ops { + struct lib_counter *(*counter_create)(size_t nr_dimensions, + const size_t *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 @@ -622,6 +657,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) @@ -638,18 +679,15 @@ struct lttng_session { 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 */ + /* hash table of events, indexed by name */ + struct lttng_ust_event_ht events_name_ht; void *owner; /* object owner */ int tstate:1; /* Transient enable state */ @@ -660,6 +698,38 @@ struct lttng_session { struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */ struct cds_list_head enums_head; struct lttng_ctx *ctx; /* contexts for filters. */ + + /* New UST 2.14 */ + struct cds_list_head counters; /* Counters list */ + /* hash table of events, indexed by key */ + struct lttng_ust_event_ht events_key_ht; +}; + +struct lttng_counter { + struct lttng_event_container parent; + union { + struct lttng_event_notifier_group *event_notifier_group; + struct lttng_session *session; + } owner; + struct lttng_counter_transport *transport; + struct lib_counter *counter; + struct lttng_counter_ops *ops; + struct cds_list_head node; /* Counter list (in session) */ + size_t free_index; /* Next index to allocate */ +}; + +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_transport { @@ -669,46 +739,30 @@ struct lttng_transport { const struct lttng_ust_lib_ring_buffer_config *client_config; }; +struct lttng_counter_transport { + char *name; + struct cds_list_head node; + struct lttng_counter_ops ops; + const struct lib_counter_config *client_config; +}; + 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_event_container_enable(struct lttng_event_container *container); +int lttng_event_container_disable(struct lttng_event_container *container); 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); +void lttng_counter_transport_register(struct lttng_counter_transport *transport); +void lttng_counter_transport_unregister(struct lttng_counter_transport *transport); int lttng_probe_register(struct lttng_probe_desc *desc); void lttng_probe_unregister(struct lttng_probe_desc *desc); @@ -735,7 +789,6 @@ int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx); int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx); int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx); int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx); -int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx); int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx); int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx); int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx); @@ -752,7 +805,6 @@ void lttng_context_ipc_ns_reset(void); void lttng_context_mnt_ns_reset(void); void lttng_context_net_ns_reset(void); void lttng_context_pid_ns_reset(void); -void lttng_context_time_ns_reset(void); void lttng_context_user_ns_reset(void); void lttng_context_uts_ns_reset(void); void lttng_context_vuid_reset(void); @@ -804,10 +856,7 @@ 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_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); @@ -822,11 +871,33 @@ struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session, 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); -void lttng_filter_event_link_bytecode(struct lttng_event *event); +static inline +struct lttng_event_container *lttng_channel_get_event_container(struct lttng_channel *channel) +{ + return &channel->parent; +} + +static inline +struct lttng_event_container *lttng_counter_get_event_container(struct lttng_counter *counter) +{ + return &counter->parent; +} + +static inline +struct lttng_channel *lttng_event_container_get_channel(struct lttng_event_container *container) +{ + if (container->type != LTTNG_EVENT_CONTAINER_CHANNEL) + return NULL; + return caa_container_of(container, struct lttng_channel, parent); +} + +static inline +struct lttng_counter *lttng_event_container_get_counter(struct lttng_event_container *container) +{ + if (container->type != LTTNG_EVENT_CONTAINER_COUNTER) + return NULL; + return caa_container_of(container, struct lttng_counter, parent); +} #ifdef __cplusplus }