X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=4a7d67f26d8914c88bffc3e2c29ad6909776149c;hb=7dd08bec735b428479201f9f84d59c78deabdf57;hp=f6d765282ab8951e967d6cc2fecb0dcb045a86cd;hpb=7a7849896a95db678d916ccb7c5d91371828e3f8;p=lttng-ust.git diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h index f6d76528..4a7d67f2 100644 --- a/include/lttng/ust-events.h +++ b/include/lttng/ust-events.h @@ -1,28 +1,43 @@ -#ifndef _UST_LTTNG_EVENTS_H -#define _UST_LTTNG_EVENTS_H +#ifndef _LTTNG_UST_EVENTS_H +#define _LTTNG_UST_EVENTS_H /* - * ust/lttng-events.h + * lttng/ust-events.h * - * Copyright 2010 (c) - Mathieu Desnoyers + * Copyright 2010-2012 (c) - Mathieu Desnoyers * * Holds LTTng per-session event registry. * - * Dual LGPL v2.1/GPL v2 license. + * 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. */ #include -#include +#include #include #include #include -#include +#include #include -struct ltt_channel; -struct ltt_session; +#define LTTNG_UST_UUID_LEN 16 + +struct lttng_channel; +struct lttng_session; struct lttng_ust_lib_ring_buffer_ctx; +/* + * 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. @@ -37,7 +52,7 @@ enum lttng_client_types { /* Type description */ /* Update the astract_types name table in lttng-types.c along with this enum */ -enum abstract_types { +enum lttng_abstract_types { atype_integer, atype_enum, atype_array, @@ -55,9 +70,11 @@ enum lttng_string_encodings { NR_STRING_ENCODINGS, }; +#define LTTNG_UST_ENUM_ENTRY_PADDING 16 struct lttng_enum_entry { unsigned long long start, end; /* start and end are inclusive */ const char *string; + char padding[LTTNG_UST_ENUM_ENTRY_PADDING]; }; #define __type_integer(_type, _byte_order, _base, _encoding) \ @@ -68,12 +85,13 @@ struct lttng_enum_entry { .size = sizeof(_type) * CHAR_BIT, \ .alignment = lttng_alignof(_type) * CHAR_BIT, \ .signedness = lttng_is_signed_type(_type), \ - .reverse_byte_order = _byte_order != __BYTE_ORDER, \ + .reverse_byte_order = _byte_order != BYTE_ORDER, \ .base = _base, \ .encoding = lttng_encode_##_encoding, \ }, \ } \ +#define LTTNG_UST_INTEGER_TYPE_PADDING 24 struct lttng_integer_type { unsigned int size; /* in bits */ unsigned short alignment; /* in bits */ @@ -81,6 +99,7 @@ struct lttng_integer_type { 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]; }; /* @@ -101,17 +120,20 @@ struct lttng_integer_type { - _float_mant_dig(_type), \ .mant_dig = _float_mant_dig(_type), \ .alignment = lttng_alignof(_type) * CHAR_BIT, \ - .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \ + .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_BASIC_TYPE_PADDING 128 union _lttng_basic_type { struct lttng_integer_type integer; struct { @@ -121,17 +143,19 @@ union _lttng_basic_type { enum lttng_string_encodings encoding; } string; struct lttng_float_type _float; + char padding[LTTNG_UST_BASIC_TYPE_PADDING]; }; struct lttng_basic_type { - enum abstract_types atype; + enum lttng_abstract_types atype; union { union _lttng_basic_type basic; } u; }; +#define LTTNG_UST_TYPE_PADDING 128 struct lttng_type { - enum abstract_types atype; + enum lttng_abstract_types atype; union { union _lttng_basic_type basic; struct { @@ -142,92 +166,204 @@ struct lttng_type { struct lttng_basic_type length_type; struct lttng_basic_type elem_type; } sequence; + char padding[LTTNG_UST_TYPE_PADDING]; } u; }; +#define LTTNG_UST_ENUM_TYPE_PADDING 24 struct lttng_enum { const char *name; struct lttng_type container_type; const struct lttng_enum_entry *entries; unsigned int len; + char padding[LTTNG_UST_ENUM_TYPE_PADDING]; }; -/* Event field description */ +/* + * Event field 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. + */ +#define LTTNG_UST_EVENT_FIELD_PADDING 28 struct lttng_event_field { const char *name; struct lttng_type type; + unsigned int nowrite; /* do not write into trace */ + char padding[LTTNG_UST_EVENT_FIELD_PADDING]; }; +#define LTTNG_UST_CTX_FIELD_PADDING 40 struct lttng_ctx_field { struct lttng_event_field event_field; size_t (*get_size)(size_t offset); void (*record)(struct lttng_ctx_field *field, struct lttng_ust_lib_ring_buffer_ctx *ctx, - struct ltt_channel *chan); + struct lttng_channel *chan); union { + char padding[LTTNG_UST_CTX_FIELD_PADDING]; } u; void (*destroy)(struct lttng_ctx_field *field); }; +#define LTTNG_UST_CTX_PADDING 24 struct lttng_ctx { struct lttng_ctx_field *fields; unsigned int nr_fields; unsigned int allocated_fields; + char padding[LTTNG_UST_CTX_PADDING]; }; +#define LTTNG_UST_EVENT_DESC_PADDING 40 struct lttng_event_desc { const char *name; - void *probe_callback; + void (*probe_callback)(void); const struct lttng_event_ctx *ctx; /* context */ const struct lttng_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; }; +#define LTTNG_UST_PROBE_DESC_PADDING 40 struct lttng_probe_desc { - const struct lttng_event_desc *event_desc; + const char *provider; + const struct lttng_event_desc **event_desc; unsigned int nr_events; struct cds_list_head head; /* chain registered probes */ + char padding[LTTNG_UST_PROBE_DESC_PADDING]; +}; + +/* Data structures used by the tracer. */ + +/* + * Entry describing a per-session active wildcard, along with the event + * attribute and channel information configuring the events that need to + * be enabled. + */ +struct session_wildcard { + struct lttng_channel *chan; + struct lttng_ctx *ctx; /* TODO */ + struct lttng_ust_event event_param; + struct cds_list_head events; /* list of events enabled */ + struct cds_list_head list; /* per-session list of wildcards */ + struct cds_list_head session_list; /* node of session wildcard list */ + struct wildcard_entry *entry; + /* list of struct lttng_ust_filter_bytecode_node */ + struct cds_list_head filter_bytecode; + unsigned int enabled:1; +}; + +/* + * Entry describing an active wildcard (per name) for all sessions. + */ +struct wildcard_entry { + /* node of global wildcards list */ + struct cds_list_head list; + /* head of session list to which this wildcard apply */ + struct cds_list_head session_list; + enum lttng_ust_loglevel_type loglevel_type; + /* list of struct lttng_ust_filter_bytecode_node */ + struct cds_list_head filter_bytecode; + int loglevel; + char name[0]; +}; + +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; +}; + +struct tp_field_list_entry { + struct lttng_ust_field_iter field; + struct cds_list_head head; +}; + +struct lttng_ust_field_list { + struct tp_field_list_entry *iter; + struct cds_list_head head; }; struct ust_pending_probe; +struct lttng_event; + +struct lttng_ust_filter_bytecode_node { + struct cds_list_head node; + struct lttng_ust_filter_bytecode bc; +}; + +struct lttng_bytecode_runtime { + /* Associated bytecode */ + struct lttng_ust_filter_bytecode_node *bc; + int (*filter)(void *filter_data, const char *filter_stack_data); + struct cds_list_head node; +}; /* - * ltt_event structure is referred to by the tracing fast path. It must be - * kept small. + * 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 ltt_event { +struct lttng_event { + /* LTTng-UST 2.0 starts here */ unsigned int id; - struct ltt_channel *chan; + struct lttng_channel *chan; int enabled; const struct lttng_event_desc *desc; - void *filter; + void *filter_unused; struct lttng_ctx *ctx; enum lttng_ust_instrumentation instrumentation; union { } u; struct cds_list_head list; /* Event list */ + struct cds_list_head wildcard_list; /* Event list for wildcard */ struct ust_pending_probe *pending_probe; - int metadata_dumped:1; + unsigned int metadata_dumped:1; + /* LTTng-UST 2.1 starts here */ + /* list of struct lttng_ust_filter_bytecode_node */ + struct cds_list_head filter_bytecode; + /* list of struct lttng_bytecode_runtime */ + struct cds_list_head bytecode_runtime; }; struct channel; struct lttng_ust_shm_handle; -struct ltt_channel_ops { - struct ltt_channel *(*channel_create)(const char *name, - struct ltt_channel *ltt_chan, +/* + * 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_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, - int *shm_fd, int *wait_fd, - uint64_t *memory_map_size); - void (*channel_destroy)(struct ltt_channel *ltt_chan); + int **shm_fd, int **wait_fd, + uint64_t **memory_map_size, + struct lttng_channel *chan_priv_init); + void (*channel_destroy)(struct lttng_channel *lttng_chan); struct lttng_ust_lib_ring_buffer *(*buffer_read_open)(struct channel *chan, struct lttng_ust_shm_handle *handle, - int *shm_fd, int *wait_fd, - uint64_t *memory_map_size); + int **shm_fd, int **wait_fd, + uint64_t **memory_map_size); void (*buffer_read_close)(struct lttng_ust_lib_ring_buffer *buf, struct lttng_ust_shm_handle *handle); int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx, @@ -249,84 +385,106 @@ struct ltt_channel_ops { int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle); }; -struct ltt_channel { - unsigned int id; +/* + * 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_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 ltt_session *session; + struct lttng_session *session; int objd; /* Object associated to channel */ unsigned int free_event_id; /* Next event ID to allocate */ unsigned int used_event_id; /* Max allocated event IDs */ struct cds_list_head list; /* Channel list */ - struct ltt_channel_ops *ops; + struct lttng_channel_ops *ops; int header_type; /* 0: unset, 1: compact, 2: large */ struct lttng_ust_shm_handle *handle; /* shared-memory handle */ - int metadata_dumped:1; + unsigned int metadata_dumped:1; + + /* Channel ID, available for consumer too */ + unsigned int id; + /* Copy of session UUID for consumer (availability through shm) */ + unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ }; -struct ltt_session { +/* + * 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_session { int active; /* Is trace session active ? */ int been_active; /* Has trace session been active ? */ int objd; /* Object associated to session */ - struct ltt_channel *metadata; /* Metadata channel */ + struct lttng_channel *metadata; /* Metadata channel */ struct cds_list_head chan; /* Channel list head */ struct cds_list_head events; /* Event list head */ + struct cds_list_head wildcards; /* Wildcard list head */ struct cds_list_head list; /* Session list */ unsigned int free_chan_id; /* Next chan ID to allocate */ - uuid_t uuid; /* Trace session unique ID */ - int metadata_dumped:1; + unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ + unsigned int metadata_dumped:1; }; -struct ltt_transport { +struct lttng_transport { char *name; struct cds_list_head node; - struct ltt_channel_ops ops; + struct lttng_channel_ops ops; }; -struct ltt_session *ltt_session_create(void); -int ltt_session_enable(struct ltt_session *session); -int ltt_session_disable(struct ltt_session *session); -void ltt_session_destroy(struct ltt_session *session); +struct lttng_session *lttng_session_create(void); +int lttng_session_enable(struct lttng_session *session); +int lttng_session_disable(struct lttng_session *session); +void lttng_session_destroy(struct lttng_session *session); -struct ltt_channel *ltt_channel_create(struct ltt_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 ltt_channel *ltt_global_channel_create(struct ltt_session *session, + int **shm_fd, int **wait_fd, + uint64_t **memory_map_size, + struct lttng_channel *chan_priv_init); +struct lttng_channel *lttng_global_channel_create(struct lttng_session *session, int overwrite, 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); + int **shm_fd, int **wait_fd, + uint64_t **memory_map_size); -struct ltt_event *ltt_event_create(struct ltt_channel *chan, - struct lttng_ust_event *event_param, - void *filter); +int lttng_event_create(struct lttng_channel *chan, + struct lttng_ust_event *event_param, + struct lttng_event **event); -int ltt_channel_enable(struct ltt_channel *channel); -int ltt_channel_disable(struct ltt_channel *channel); -int ltt_event_enable(struct ltt_event *event); -int ltt_event_disable(struct ltt_event *event); +int lttng_channel_enable(struct lttng_channel *channel); +int lttng_channel_disable(struct lttng_channel *channel); +int lttng_event_enable(struct lttng_event *event); +int lttng_event_disable(struct lttng_event *event); -void ltt_transport_register(struct ltt_transport *transport); -void ltt_transport_unregister(struct ltt_transport *transport); +void lttng_transport_register(struct lttng_transport *transport); +void lttng_transport_unregister(struct lttng_transport *transport); void synchronize_trace(void); -int ltt_probe_register(struct lttng_probe_desc *desc); -void ltt_probe_unregister(struct lttng_probe_desc *desc); +int lttng_probe_register(struct lttng_probe_desc *desc); +void lttng_probe_unregister(struct lttng_probe_desc *desc); int pending_probe_fix_events(const struct lttng_event_desc *desc); -const struct lttng_event_desc *ltt_event_get(const char *name); -void ltt_event_put(const struct lttng_event_desc *desc); -int ltt_probes_init(void); -void ltt_probes_exit(void); +const struct lttng_event_desc *lttng_event_get(const char *name); +void lttng_event_put(const struct lttng_event_desc *desc); +int lttng_probes_init(void); +void lttng_probes_exit(void); int lttng_find_context(struct lttng_ctx *ctx, const char *name); struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p); void lttng_remove_context_field(struct lttng_ctx **ctx_p, @@ -339,11 +497,41 @@ int lttng_add_procname_to_ctx(struct lttng_ctx **ctx); void lttng_context_vtid_reset(void); void lttng_context_vpid_reset(void); -const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata; -const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard; -const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite; - -struct cds_list_head ltt_transport_list; -struct ltt_transport *ltt_transport_find(const char *name); - -#endif /* _UST_LTTNG_EVENTS_H */ +extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata; +extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard; +extern const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite; + +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); + +int lttng_wildcard_enable(struct session_wildcard *wildcard); +int lttng_wildcard_disable(struct session_wildcard *wildcard); +int lttng_wildcard_create(struct lttng_channel *chan, + struct lttng_ust_event *event_param, + struct session_wildcard **sl); +int lttng_loglevel_match(const struct lttng_event_desc *desc, + enum lttng_ust_loglevel_type req_type, + int req_loglevel); +void lttng_probes_create_wildcard_events(struct wildcard_entry *entry, + struct session_wildcard *wildcard); +int lttng_filter_event_attach_bytecode(struct lttng_event *event, + struct lttng_ust_filter_bytecode_node *filter); +int lttng_filter_wildcard_attach_bytecode(struct session_wildcard *wildcard, + struct lttng_ust_filter_bytecode_node *filter); +void lttng_filter_event_link_bytecode(struct lttng_event *event); +void lttng_filter_event_link_wildcard_bytecode(struct lttng_event *event, + struct session_wildcard *wildcard); +void lttng_filter_wildcard_link_bytecode(struct session_wildcard *wildcard); +void lttng_free_event_filter_bytecode(struct lttng_event *event); +void lttng_free_wildcard_filter_bytecode(struct session_wildcard *wildcard); +void lttng_free_event_filter_runtime(struct lttng_event *event); + +#endif /* _LTTNG_UST_EVENTS_H */