2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * Holds LTTng per-session event registry.
9 #ifndef _LTTNG_UST_EVENTS_H
10 #define _LTTNG_UST_EVENTS_H
12 #include <urcu/list.h>
13 #include <urcu/hlist.h>
16 #include <lttng/ust-abi.h>
17 #include <lttng/ust-tracer.h>
18 #include <lttng/ust-endian.h>
25 #error "LTTNG_PACKED should be defined"
32 #define LTTNG_UST_UUID_LEN 16
35 * Tracepoint provider version. Compatibility based on the major number.
36 * Older tracepoint providers can always register to newer lttng-ust
37 * library, but the opposite is rejected: a newer tracepoint provider is
38 * rejected by an older lttng-ust library.
40 #define LTTNG_UST_PROVIDER_MAJOR 2
41 #define LTTNG_UST_PROVIDER_MINOR 0
45 struct lttng_ust_lib_ring_buffer_ctx
;
46 struct lttng_ust_context_app
;
47 struct lttng_event_field
;
48 struct lttng_event_notifier
;
49 struct lttng_event_notifier_group
;
52 * Data structures used by tracepoint event declarations, and by the
53 * tracer. Those structures have padding for future extension.
56 /* Type description */
58 /* Update the astract_types name table in lttng-types.c along with this enum */
59 enum lttng_abstract_types
{
61 atype_enum
, /* legacy */
62 atype_array
, /* legacy */
63 atype_sequence
, /* legacy */
67 atype_struct
, /* legacy */
70 atype_sequence_nestable
,
71 atype_struct_nestable
,
75 /* Update the string_encodings name table in lttng-types.c along with this enum */
76 enum lttng_string_encodings
{
77 lttng_encode_none
= 0,
78 lttng_encode_UTF8
= 1,
79 lttng_encode_ASCII
= 2,
83 struct lttng_enum_value
{
84 unsigned long long value
;
85 unsigned int signedness
:1;
88 enum lttng_enum_entry_options
{
89 LTTNG_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
92 #define LTTNG_UST_ENUM_ENTRY_PADDING 16
93 struct lttng_enum_entry
{
94 struct lttng_enum_value start
, end
; /* start and end are inclusive */
100 char padding
[LTTNG_UST_ENUM_ENTRY_PADDING
];
104 #define __type_integer(_type, _byte_order, _base, _encoding) \
106 .atype = atype_integer, \
111 .size = sizeof(_type) * CHAR_BIT, \
112 .alignment = lttng_alignof(_type) * CHAR_BIT, \
113 .signedness = lttng_is_signed_type(_type), \
114 .reverse_byte_order = _byte_order != BYTE_ORDER, \
116 .encoding = lttng_encode_##_encoding, \
121 #define LTTNG_UST_INTEGER_TYPE_PADDING 24
122 struct lttng_integer_type
{
123 unsigned int size
; /* in bits */
124 unsigned short alignment
; /* in bits */
125 unsigned int signedness
:1;
126 unsigned int reverse_byte_order
:1;
127 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
128 enum lttng_string_encodings encoding
;
129 char padding
[LTTNG_UST_INTEGER_TYPE_PADDING
];
133 * Only float and double are supported. long double is not supported at
136 #define _float_mant_dig(_type) \
137 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
138 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
141 #define __type_float(_type) \
143 .atype = atype_float, \
148 .exp_dig = sizeof(_type) * CHAR_BIT \
149 - _float_mant_dig(_type), \
150 .mant_dig = _float_mant_dig(_type), \
151 .alignment = lttng_alignof(_type) * CHAR_BIT, \
152 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
157 #define LTTNG_UST_FLOAT_TYPE_PADDING 24
158 struct lttng_float_type
{
159 unsigned int exp_dig
; /* exponent digits, in bits */
160 unsigned int mant_dig
; /* mantissa digits, in bits */
161 unsigned short alignment
; /* in bits */
162 unsigned int reverse_byte_order
:1;
163 char padding
[LTTNG_UST_FLOAT_TYPE_PADDING
];
167 #define LTTNG_UST_BASIC_TYPE_PADDING 128
168 union _lttng_basic_type
{
169 struct lttng_integer_type integer
; /* legacy */
171 const struct lttng_enum_desc
*desc
; /* Enumeration mapping */
172 struct lttng_integer_type container_type
;
173 } enumeration
; /* legacy */
175 enum lttng_string_encodings encoding
;
176 } string
; /* legacy */
177 struct lttng_float_type _float
; /* legacy */
178 char padding
[LTTNG_UST_BASIC_TYPE_PADDING
];
182 struct lttng_basic_type
{
183 enum lttng_abstract_types atype
;
185 union _lttng_basic_type basic
;
189 #define LTTNG_UST_TYPE_PADDING 128
191 enum lttng_abstract_types atype
;
193 /* provider ABI 2.0 */
194 struct lttng_integer_type integer
;
195 struct lttng_float_type _float
;
197 enum lttng_string_encodings encoding
;
200 const struct lttng_enum_desc
*desc
; /* Enumeration mapping */
201 struct lttng_type
*container_type
;
204 const struct lttng_type
*elem_type
;
205 unsigned int length
; /* Num. elems. */
206 unsigned int alignment
;
209 const char *length_name
; /* Length field name. */
210 const struct lttng_type
*elem_type
;
211 unsigned int alignment
; /* Alignment before elements. */
214 unsigned int nr_fields
;
215 const struct lttng_event_field
*fields
; /* Array of fields. */
216 unsigned int alignment
;
220 /* legacy provider ABI 1.0 */
221 union _lttng_basic_type basic
; /* legacy */
223 struct lttng_basic_type elem_type
;
224 unsigned int length
; /* Num. elems. */
225 } array
; /* legacy */
227 struct lttng_basic_type length_type
;
228 struct lttng_basic_type elem_type
;
229 } sequence
; /* legacy */
231 unsigned int nr_fields
;
232 struct lttng_event_field
*fields
; /* Array of fields. */
233 } _struct
; /* legacy */
235 char padding
[LTTNG_UST_TYPE_PADDING
];
239 #define LTTNG_UST_ENUM_TYPE_PADDING 24
240 struct lttng_enum_desc
{
242 const struct lttng_enum_entry
*entries
;
243 unsigned int nr_entries
;
244 char padding
[LTTNG_UST_ENUM_TYPE_PADDING
];
248 * Event field description
250 * IMPORTANT: this structure is part of the ABI between the probe and
251 * UST. Fields need to be only added at the end, never reordered, never
255 #define LTTNG_UST_EVENT_FIELD_PADDING 28
256 struct lttng_event_field
{
258 struct lttng_type type
;
259 unsigned int nowrite
; /* do not write into trace */
262 unsigned int nofilter
:1; /* do not consider for filter */
264 char padding
[LTTNG_UST_EVENT_FIELD_PADDING
];
268 enum lttng_ust_dynamic_type
{
269 LTTNG_UST_DYNAMIC_TYPE_NONE
,
270 LTTNG_UST_DYNAMIC_TYPE_S8
,
271 LTTNG_UST_DYNAMIC_TYPE_S16
,
272 LTTNG_UST_DYNAMIC_TYPE_S32
,
273 LTTNG_UST_DYNAMIC_TYPE_S64
,
274 LTTNG_UST_DYNAMIC_TYPE_U8
,
275 LTTNG_UST_DYNAMIC_TYPE_U16
,
276 LTTNG_UST_DYNAMIC_TYPE_U32
,
277 LTTNG_UST_DYNAMIC_TYPE_U64
,
278 LTTNG_UST_DYNAMIC_TYPE_FLOAT
,
279 LTTNG_UST_DYNAMIC_TYPE_DOUBLE
,
280 LTTNG_UST_DYNAMIC_TYPE_STRING
,
281 _NR_LTTNG_UST_DYNAMIC_TYPES
,
284 struct lttng_ctx_value
{
285 enum lttng_ust_dynamic_type sel
;
294 struct lttng_perf_counter_field
;
296 #define LTTNG_UST_CTX_FIELD_PADDING 40
297 struct lttng_ctx_field
{
298 struct lttng_event_field event_field
;
299 size_t (*get_size
)(struct lttng_ctx_field
*field
, size_t offset
);
300 void (*record
)(struct lttng_ctx_field
*field
,
301 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
302 struct lttng_channel
*chan
);
303 void (*get_value
)(struct lttng_ctx_field
*field
,
304 struct lttng_ctx_value
*value
);
306 struct lttng_perf_counter_field
*perf_counter
;
307 char padding
[LTTNG_UST_CTX_FIELD_PADDING
];
309 void (*destroy
)(struct lttng_ctx_field
*field
);
310 char *field_name
; /* Has ownership, dynamically allocated. */
313 #define LTTNG_UST_CTX_PADDING 20
315 struct lttng_ctx_field
*fields
;
316 unsigned int nr_fields
;
317 unsigned int allocated_fields
;
318 unsigned int largest_align
;
319 char padding
[LTTNG_UST_CTX_PADDING
];
322 #define LTTNG_UST_EVENT_DESC_PADDING 40
323 struct lttng_event_desc
{
325 void (*probe_callback
)(void);
326 const struct lttng_event_ctx
*ctx
; /* context */
327 const struct lttng_event_field
*fields
; /* event payload */
328 unsigned int nr_fields
;
329 const int **loglevel
;
330 const char *signature
; /* Argument types/names received */
333 const char **model_emf_uri
;
334 void (*event_notifier_callback
)(void);
336 char padding
[LTTNG_UST_EVENT_DESC_PADDING
];
340 #define LTTNG_UST_PROBE_DESC_PADDING 12
341 struct lttng_probe_desc
{
342 const char *provider
;
343 const struct lttng_event_desc
**event_desc
;
344 unsigned int nr_events
;
345 struct cds_list_head head
; /* chain registered probes */
346 struct cds_list_head lazy_init_head
;
347 int lazy
; /* lazy registration */
350 char padding
[LTTNG_UST_PROBE_DESC_PADDING
];
353 /* Data structures used by the tracer. */
355 struct tp_list_entry
{
356 struct lttng_ust_tracepoint_iter tp
;
357 struct cds_list_head head
;
360 struct lttng_ust_tracepoint_list
{
361 struct tp_list_entry
*iter
;
362 struct cds_list_head head
;
365 struct tp_field_list_entry
{
366 struct lttng_ust_field_iter field
;
367 struct cds_list_head head
;
370 struct lttng_ust_field_list
{
371 struct tp_field_list_entry
*iter
;
372 struct cds_list_head head
;
375 struct ust_pending_probe
;
379 * Bytecode interpreter return value masks.
381 enum lttng_bytecode_interpreter_ret
{
382 LTTNG_INTERPRETER_DISCARD
= 0,
383 LTTNG_INTERPRETER_RECORD_FLAG
= (1ULL << 0),
384 /* Other bits are kept for future use. */
387 struct lttng_interpreter_output
;
390 * This structure is used in the probes. More specifically, the `filter` and
391 * `node` fields are explicity used in the probes. When modifying this
392 * structure we must not change the layout of these two fields as it is
395 struct lttng_bytecode_runtime
{
396 /* Associated bytecode */
397 struct lttng_ust_bytecode_node
*bc
;
399 uint64_t (*filter
)(void *interpreter_data
,
400 const char *interpreter_stack_data
);
401 uint64_t (*capture
)(void *interpreter_data
,
402 const char *interpreter_stack_data
,
403 struct lttng_interpreter_output
*interpreter_output
);
406 struct cds_list_head node
; /* list of bytecode runtime in event */
408 * Pointer to a URCU-protected pointer owned by an `struct
409 * lttng_session`or `struct lttng_event_notifier_group`.
411 struct lttng_ctx
**pctx
;
415 * Objects in a linked-list of enablers, owned by an event or event_notifier.
416 * This is used because an event (or a event_notifier) can be enabled by more
417 * than one enabler and we want a quick way to iterate over all enablers of an
420 * For example, event rules "my_app:a*" and "my_app:ab*" will both match the
421 * event with the name "my_app:abc".
423 struct lttng_enabler_ref
{
424 struct cds_list_head node
; /* enabler ref list */
425 struct lttng_enabler
*ref
; /* backward ref */
429 * lttng_event structure is referred to by the tracing fast path. It
430 * must be kept small.
432 * IMPORTANT: this structure is part of the ABI between the probe and
433 * UST. Fields need to be only added at the end, never reordered, never
438 struct lttng_channel
*chan
;
440 const struct lttng_event_desc
*desc
;
441 struct lttng_ctx
*ctx
;
442 enum lttng_ust_instrumentation instrumentation
;
443 struct cds_list_head node
; /* Event list in session */
445 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
446 struct cds_list_head filter_bytecode_runtime_head
;
447 int has_enablers_without_bytecode
;
448 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
449 struct cds_list_head enablers_ref_head
;
450 struct cds_hlist_node hlist
; /* session ht of events */
451 int registered
; /* has reg'd tracepoint probe */
454 struct lttng_event_notifier
{
456 uint64_t error_counter_index
;
458 int registered
; /* has reg'd tracepoint probe */
459 size_t num_captures
; /* Needed to allocate the msgpack array. */
460 void (*notification_send
)(struct lttng_event_notifier
*event_notifier
,
461 const char *stack_data
);
462 struct cds_list_head filter_bytecode_runtime_head
;
463 struct cds_list_head capture_bytecode_runtime_head
;
464 int has_enablers_without_bytecode
;
465 struct cds_list_head enablers_ref_head
;
466 const struct lttng_event_desc
*desc
;
467 struct cds_hlist_node hlist
; /* hashtable of event_notifiers */
468 struct cds_list_head node
; /* event_notifier list in session */
469 struct lttng_event_notifier_group
*group
; /* weak ref */
473 const struct lttng_enum_desc
*desc
;
474 struct lttng_session
*session
;
475 struct cds_list_head node
; /* Enum list in session */
476 struct cds_hlist_node hlist
; /* Session ht of enums */
477 uint64_t id
; /* Enumeration ID in sessiond */
481 struct lttng_ust_shm_handle
;
484 * IMPORTANT: this structure is part of the ABI between the probe and
485 * UST. Fields need to be only added at the end, never reordered, never
488 struct lttng_channel_ops
{
489 struct lttng_channel
*(*channel_create
)(const char *name
,
491 size_t subbuf_size
, size_t num_subbuf
,
492 unsigned int switch_timer_interval
,
493 unsigned int read_timer_interval
,
496 const int *stream_fds
, int nr_stream_fds
,
497 int64_t blocking_timeout
);
498 void (*channel_destroy
)(struct lttng_channel
*chan
);
499 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
501 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
502 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
503 const void *src
, size_t len
);
505 * packet_avail_size returns the available size in the current
506 * packet. Note that the size returned is only a hint, since it
507 * may change due to concurrent writes.
509 size_t (*packet_avail_size
)(struct channel
*chan
,
510 struct lttng_ust_shm_handle
*handle
);
511 int (*is_finalized
)(struct channel
*chan
);
512 int (*is_disabled
)(struct channel
*chan
);
513 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
514 void (*event_strcpy
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
515 const char *src
, size_t len
);
519 * IMPORTANT: this structure is part of the ABI between the probe and
520 * UST. Fields need to be only added at the end, never reordered, never
523 struct lttng_channel
{
525 * The pointers located in this private data are NOT safe to be
526 * dereferenced by the consumer. The only operations the
527 * consumer process is designed to be allowed to do is to read
528 * and perform subbuffer flush.
530 struct channel
*chan
; /* Channel buffers */
532 struct lttng_ctx
*ctx
;
533 /* Event ID management */
534 struct lttng_session
*session
;
535 int objd
; /* Object associated to channel */
536 struct cds_list_head node
; /* Channel list in session */
537 const struct lttng_channel_ops
*ops
;
538 int header_type
; /* 0: unset, 1: compact, 2: large */
539 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
543 enum lttng_ust_chan_type type
;
544 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
545 int tstate
:1; /* Transient enable state */
548 #define LTTNG_COUNTER_DIMENSION_MAX 8
550 struct lttng_counter_dimension
{
552 uint64_t underflow_index
;
553 uint64_t overflow_index
;
554 uint8_t has_underflow
;
555 uint8_t has_overflow
;
558 struct lttng_counter_ops
{
559 struct lib_counter
*(*counter_create
)(size_t nr_dimensions
,
560 const struct lttng_counter_dimension
*dimensions
,
561 int64_t global_sum_step
,
562 int global_counter_fd
,
563 int nr_counter_cpu_fds
,
564 const int *counter_cpu_fds
,
566 void (*counter_destroy
)(struct lib_counter
*counter
);
567 int (*counter_add
)(struct lib_counter
*counter
,
568 const size_t *dimension_indexes
, int64_t v
);
569 int (*counter_read
)(struct lib_counter
*counter
,
570 const size_t *dimension_indexes
, int cpu
,
571 int64_t *value
, bool *overflow
, bool *underflow
);
572 int (*counter_aggregate
)(struct lib_counter
*counter
,
573 const size_t *dimension_indexes
, int64_t *value
,
574 bool *overflow
, bool *underflow
);
575 int (*counter_clear
)(struct lib_counter
*counter
, const size_t *dimension_indexes
);
578 #define LTTNG_UST_STACK_CTX_PADDING 32
579 struct lttng_stack_ctx
{
580 struct lttng_event
*event
;
581 struct lttng_ctx
*chan_ctx
; /* RCU dereferenced. */
582 struct lttng_ctx
*event_ctx
; /* RCU dereferenced. */
583 char padding
[LTTNG_UST_STACK_CTX_PADDING
];
586 #define LTTNG_UST_EVENT_HT_BITS 12
587 #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
589 struct lttng_ust_event_ht
{
590 struct cds_hlist_head table
[LTTNG_UST_EVENT_HT_SIZE
];
593 #define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12
594 #define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
595 struct lttng_ust_event_notifier_ht
{
596 struct cds_hlist_head table
[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE
];
599 #define LTTNG_UST_ENUM_HT_BITS 12
600 #define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS)
602 struct lttng_ust_enum_ht
{
603 struct cds_hlist_head table
[LTTNG_UST_ENUM_HT_SIZE
];
607 * IMPORTANT: this structure is part of the ABI between the probe and
608 * UST. Fields need to be only added at the end, never reordered, never
611 struct lttng_session
{
612 int active
; /* Is trace session active ? */
613 int been_active
; /* Been active ? */
614 int objd
; /* Object associated */
615 struct cds_list_head chan_head
; /* Channel list head */
616 struct cds_list_head events_head
; /* list of events */
617 struct cds_list_head node
; /* Session list */
620 /* List of enablers */
621 struct cds_list_head enablers_head
;
622 struct lttng_ust_event_ht events_ht
; /* ht of events */
623 void *owner
; /* object owner */
624 int tstate
:1; /* Transient enable state */
627 int statedump_pending
:1;
630 struct lttng_ust_enum_ht enums_ht
; /* ht of enumerations */
631 struct cds_list_head enums_head
;
632 struct lttng_ctx
*ctx
; /* contexts for filters. */
635 struct lttng_counter
{
637 struct lttng_event_notifier_group
*event_notifier_group
; /* owner */
638 struct lttng_counter_transport
*transport
;
639 struct lib_counter
*counter
;
640 struct lttng_counter_ops
*ops
;
643 struct lttng_event_notifier_group
{
647 struct cds_list_head node
; /* Event notifier group handle list */
648 struct cds_list_head enablers_head
;
649 struct cds_list_head event_notifiers_head
; /* list of event_notifiers */
650 struct lttng_ust_event_notifier_ht event_notifiers_ht
; /* hashtable of event_notifiers */
651 struct lttng_ctx
*ctx
; /* contexts for filters. */
653 struct lttng_counter
*error_counter
;
654 size_t error_counter_len
;
657 struct lttng_transport
{
659 struct cds_list_head node
;
660 struct lttng_channel_ops ops
;
661 const struct lttng_ust_lib_ring_buffer_config
*client_config
;
664 struct lttng_counter_transport
{
666 struct cds_list_head node
;
667 struct lttng_counter_ops ops
;
668 const struct lib_counter_config
*client_config
;
671 struct lttng_session
*lttng_session_create(void);
672 int lttng_session_enable(struct lttng_session
*session
);
673 int lttng_session_disable(struct lttng_session
*session
);
674 int lttng_session_statedump(struct lttng_session
*session
);
675 void lttng_session_destroy(struct lttng_session
*session
);
677 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
678 const char *transport_name
,
680 size_t subbuf_size
, size_t num_subbuf
,
681 unsigned int switch_timer_interval
,
682 unsigned int read_timer_interval
,
683 int **shm_fd
, int **wait_fd
,
684 uint64_t **memory_map_size
,
685 struct lttng_channel
*chan_priv_init
);
687 int lttng_channel_enable(struct lttng_channel
*channel
);
688 int lttng_channel_disable(struct lttng_channel
*channel
);
690 void lttng_transport_register(struct lttng_transport
*transport
);
691 void lttng_transport_unregister(struct lttng_transport
*transport
);
693 int lttng_probe_register(struct lttng_probe_desc
*desc
);
694 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
695 void lttng_probe_provider_unregister_events(struct lttng_probe_desc
*desc
);
696 int lttng_fix_pending_events(void);
697 int lttng_probes_init(void);
698 void lttng_probes_exit(void);
701 * Can be used by applications that change their procname to clear the ust cached value.
703 void lttng_context_procname_reset(void);
705 struct lttng_transport
*lttng_transport_find(const char *name
);
707 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list
*list
);
708 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list
*list
);
709 struct lttng_ust_tracepoint_iter
*
710 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list
*list
);
711 int lttng_probes_get_field_list(struct lttng_ust_field_list
*list
);
712 void lttng_probes_prune_field_list(struct lttng_ust_field_list
*list
);
713 struct lttng_ust_field_iter
*
714 lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list
*list
);
716 void lttng_free_event_filter_runtime(struct lttng_event
*event
);
718 struct cds_list_head
*lttng_get_probe_list_head(void);
719 int lttng_session_active(void);
721 typedef int (*t_statedump_func_ptr
)(struct lttng_session
*session
);
722 void lttng_handle_pending_statedump(void *owner
);
723 struct cds_list_head
*_lttng_get_sessions(void);
725 struct lttng_enum
*lttng_ust_enum_get_from_desc(struct lttng_session
*session
,
726 const struct lttng_enum_desc
*enum_desc
);
728 void lttng_ust_dl_update(void *ip
);
734 #endif /* _LTTNG_UST_EVENTS_H */