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_event_field
;
47 struct lttng_event_notifier_group
;
50 * Data structures used by tracepoint event declarations, and by the
51 * tracer. Those structures have padding for future extension.
54 /* Type description */
56 /* Update the astract_types name table in lttng-types.c along with this enum */
57 enum lttng_abstract_types
{
64 atype_sequence_nestable
,
65 atype_struct_nestable
,
69 /* Update the string_encodings name table in lttng-types.c along with this enum */
70 enum lttng_string_encodings
{
71 lttng_encode_none
= 0,
72 lttng_encode_UTF8
= 1,
73 lttng_encode_ASCII
= 2,
77 struct lttng_enum_value
{
78 unsigned long long value
;
79 unsigned int signedness
:1;
82 enum lttng_enum_entry_options
{
83 LTTNG_ENUM_ENTRY_OPTION_IS_AUTO
= 1U << 0,
86 #define LTTNG_UST_ENUM_ENTRY_PADDING 16
87 struct lttng_enum_entry
{
88 struct lttng_enum_value start
, end
; /* start and end are inclusive */
94 char padding
[LTTNG_UST_ENUM_ENTRY_PADDING
];
98 #define __type_integer(_type, _byte_order, _base, _encoding) \
100 .atype = atype_integer, \
105 .size = sizeof(_type) * CHAR_BIT, \
106 .alignment = lttng_alignof(_type) * CHAR_BIT, \
107 .signedness = lttng_is_signed_type(_type), \
108 .reverse_byte_order = _byte_order != BYTE_ORDER, \
110 .encoding = lttng_encode_##_encoding, \
115 #define LTTNG_UST_INTEGER_TYPE_PADDING 24
116 struct lttng_integer_type
{
117 unsigned int size
; /* in bits */
118 unsigned short alignment
; /* in bits */
119 unsigned int signedness
:1;
120 unsigned int reverse_byte_order
:1;
121 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
122 enum lttng_string_encodings encoding
;
123 char padding
[LTTNG_UST_INTEGER_TYPE_PADDING
];
127 * Only float and double are supported. long double is not supported at
130 #define _float_mant_dig(_type) \
131 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
132 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
135 #define __type_float(_type) \
137 .atype = atype_float, \
142 .exp_dig = sizeof(_type) * CHAR_BIT \
143 - _float_mant_dig(_type), \
144 .mant_dig = _float_mant_dig(_type), \
145 .alignment = lttng_alignof(_type) * CHAR_BIT, \
146 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
151 #define LTTNG_UST_FLOAT_TYPE_PADDING 24
152 struct lttng_float_type
{
153 unsigned int exp_dig
; /* exponent digits, in bits */
154 unsigned int mant_dig
; /* mantissa digits, in bits */
155 unsigned short alignment
; /* in bits */
156 unsigned int reverse_byte_order
:1;
157 char padding
[LTTNG_UST_FLOAT_TYPE_PADDING
];
160 #define LTTNG_UST_TYPE_PADDING 128
162 enum lttng_abstract_types atype
;
164 /* provider ABI 2.0 */
165 struct lttng_integer_type integer
;
166 struct lttng_float_type _float
;
168 enum lttng_string_encodings encoding
;
171 const struct lttng_enum_desc
*desc
; /* Enumeration mapping */
172 struct lttng_type
*container_type
;
175 const struct lttng_type
*elem_type
;
176 unsigned int length
; /* Num. elems. */
177 unsigned int alignment
;
180 const char *length_name
; /* Length field name. */
181 const struct lttng_type
*elem_type
;
182 unsigned int alignment
; /* Alignment before elements. */
185 unsigned int nr_fields
;
186 const struct lttng_ust_event_field
**fields
; /* Array of pointers to fields. */
187 unsigned int alignment
;
190 char padding
[LTTNG_UST_TYPE_PADDING
];
194 #define LTTNG_UST_ENUM_TYPE_PADDING 24
195 struct lttng_enum_desc
{
197 const struct lttng_enum_entry
*entries
;
198 unsigned int nr_entries
;
199 char padding
[LTTNG_UST_ENUM_TYPE_PADDING
];
203 * Event field description
205 * IMPORTANT: this structure is part of the ABI between the probe and
206 * UST. Fields need to be only added at the end, never reordered, never
209 * The field @struct_size should be used to determine the size of the
210 * structure. It should be queried before using additional fields added
211 * at the end of the structure.
214 struct lttng_ust_event_field
{
215 uint32_t struct_size
;
218 struct lttng_type type
;
219 unsigned int nowrite
:1, /* do not write into trace */
220 nofilter
:1; /* do not consider for filter */
222 /* End of base ABI. Fields below should be used after checking struct_size. */
225 enum lttng_ust_dynamic_type
{
226 LTTNG_UST_DYNAMIC_TYPE_NONE
,
227 LTTNG_UST_DYNAMIC_TYPE_S8
,
228 LTTNG_UST_DYNAMIC_TYPE_S16
,
229 LTTNG_UST_DYNAMIC_TYPE_S32
,
230 LTTNG_UST_DYNAMIC_TYPE_S64
,
231 LTTNG_UST_DYNAMIC_TYPE_U8
,
232 LTTNG_UST_DYNAMIC_TYPE_U16
,
233 LTTNG_UST_DYNAMIC_TYPE_U32
,
234 LTTNG_UST_DYNAMIC_TYPE_U64
,
235 LTTNG_UST_DYNAMIC_TYPE_FLOAT
,
236 LTTNG_UST_DYNAMIC_TYPE_DOUBLE
,
237 LTTNG_UST_DYNAMIC_TYPE_STRING
,
238 _NR_LTTNG_UST_DYNAMIC_TYPES
,
241 struct lttng_ctx_value
{
242 enum lttng_ust_dynamic_type sel
;
251 struct lttng_perf_counter_field
;
253 #define LTTNG_UST_CTX_FIELD_PADDING 40
254 struct lttng_ctx_field
{
255 struct lttng_ust_event_field event_field
;
256 size_t (*get_size
)(struct lttng_ctx_field
*field
, size_t offset
);
257 void (*record
)(struct lttng_ctx_field
*field
,
258 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
259 struct lttng_channel
*chan
);
260 void (*get_value
)(struct lttng_ctx_field
*field
,
261 struct lttng_ctx_value
*value
);
263 struct lttng_perf_counter_field
*perf_counter
;
264 char padding
[LTTNG_UST_CTX_FIELD_PADDING
];
266 void (*destroy
)(struct lttng_ctx_field
*field
);
267 char *field_name
; /* Has ownership, dynamically allocated. */
270 #define LTTNG_UST_CTX_PADDING 20
272 struct lttng_ctx_field
*fields
;
273 unsigned int nr_fields
;
274 unsigned int allocated_fields
;
275 unsigned int largest_align
;
276 char padding
[LTTNG_UST_CTX_PADDING
];
280 * IMPORTANT: this structure is part of the ABI between the probe and
281 * UST. Fields need to be only added at the end, never reordered, never
284 * The field @struct_size should be used to determine the size of the
285 * structure. It should be queried before using additional fields added
286 * at the end of the structure.
288 struct lttng_ust_event_desc
{
289 uint32_t struct_size
; /* Size of this structure. */
291 void (*probe_callback
)(void);
292 const struct lttng_event_ctx
*ctx
; /* context */
293 const struct lttng_ust_event_field
**fields
; /* event payload */
294 unsigned int nr_fields
;
295 const int **loglevel
;
296 const char *signature
; /* Argument types/names received */
297 const char **model_emf_uri
;
299 /* End of base ABI. Fields below should be used after checking struct_size. */
303 * IMPORTANT: this structure is part of the ABI between the probe and
304 * UST. Fields need to be only added at the end, never reordered, never
307 * The field @struct_size should be used to determine the size of the
308 * structure. It should be queried before using additional fields added
309 * at the end of the structure.
311 struct lttng_ust_probe_desc
{
312 uint32_t struct_size
; /* Size of this structure. */
314 const char *provider
;
315 const struct lttng_ust_event_desc
**event_desc
;
316 unsigned int nr_events
;
317 struct cds_list_head head
; /* chain registered probes */
318 struct cds_list_head lazy_init_head
;
319 int lazy
; /* lazy registration */
323 /* End of base ABI. Fields below should be used after checking struct_size. */
326 /* Data structures used by the tracer. */
329 * Bytecode interpreter return value masks.
331 enum lttng_bytecode_interpreter_ret
{
332 LTTNG_INTERPRETER_DISCARD
= 0,
333 LTTNG_INTERPRETER_RECORD_FLAG
= (1ULL << 0),
334 /* Other bits are kept for future use. */
337 struct lttng_interpreter_output
;
338 struct lttng_ust_bytecode_runtime_private
;
341 * This structure is used in the probes. More specifically, the
342 * `interpreter_funcs` and `node` fields are explicity used in the
343 * probes. When modifying this structure we must not change the layout
344 * of these two fields as it is considered ABI.
346 struct lttng_bytecode_runtime
{
347 struct lttng_ust_bytecode_runtime_private
*priv
;
349 /* Associated bytecode */
351 uint64_t (*filter
)(void *interpreter_data
,
352 const char *interpreter_stack_data
);
353 uint64_t (*capture
)(void *interpreter_data
,
354 const char *interpreter_stack_data
,
355 struct lttng_interpreter_output
*interpreter_output
);
357 struct cds_list_head node
; /* list of bytecode runtime in event */
361 * lttng_event structure is referred to by the tracing fast path. It
362 * must be kept small.
364 * IMPORTANT: this structure is part of the ABI between the probe and
365 * UST. Fields need to be only added at the end, never reordered, never
369 struct lttng_ust_event_common_private
;
371 enum lttng_ust_event_type
{
372 LTTNG_UST_EVENT_TYPE_RECORDER
= 0,
373 LTTNG_UST_EVENT_TYPE_NOTIFIER
= 1,
377 * IMPORTANT: this structure is part of the ABI between the probe and
378 * UST. Fields need to be only added at the end, never reordered, never
381 * struct lttng_ust_event_common is the common ancestor of the various
382 * public event actions. Inheritance is done by composition: The parent
383 * has a pointer to its child, and the child has a pointer to its
384 * parent. Inheritance of those public structures is done by composition
385 * to ensure both parent and child structures can be extended.
387 * The field @struct_size should be used to determine the size of the
388 * structure. It should be queried before using additional fields added
389 * at the end of the structure.
391 struct lttng_ust_event_common
{
392 uint32_t struct_size
; /* Size of this structure. */
393 struct lttng_ust_event_common_private
*priv
; /* Private event interface */
395 enum lttng_ust_event_type type
;
396 void *child
; /* Pointer to child, for inheritance by aggregation. */
399 int has_enablers_without_bytecode
;
400 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
401 struct cds_list_head filter_bytecode_runtime_head
;
403 /* End of base ABI. Fields below should be used after checking struct_size. */
406 struct lttng_ust_event_recorder_private
;
409 * IMPORTANT: this structure is part of the ABI between the probe and
410 * UST. Fields need to be only added at the end, never reordered, never
413 * struct lttng_ust_event_recorder is the action for recording events
414 * into a ring buffer. It inherits from struct lttng_ust_event_common
415 * by composition to ensure both parent and child structure are
418 * The field @struct_size should be used to determine the size of the
419 * structure. It should be queried before using additional fields added
420 * at the end of the structure.
422 struct lttng_ust_event_recorder
{
423 uint32_t struct_size
; /* Size of this structure. */
424 struct lttng_ust_event_common
*parent
; /* Inheritance by aggregation. */
425 struct lttng_ust_event_recorder_private
*priv
; /* Private event record interface */
428 struct lttng_channel
*chan
;
429 struct lttng_ctx
*ctx
;
431 /* End of base ABI. Fields below should be used after checking struct_size. */
434 struct lttng_ust_event_notifier_private
;
437 * IMPORTANT: this structure is part of the ABI between the probe and
438 * UST. Fields need to be only added at the end, never reordered, never
441 * struct lttng_ust_event_notifier is the action for sending
442 * notifications. It inherits from struct lttng_ust_event_common
443 * by composition to ensure both parent and child structure are
446 * The field @struct_size should be used to determine the size of the
447 * structure. It should be queried before using additional fields added
448 * at the end of the structure.
450 struct lttng_ust_event_notifier
{
451 uint32_t struct_size
; /* Size of this structure. */
452 struct lttng_ust_event_common
*parent
; /* Inheritance by aggregation. */
453 struct lttng_ust_event_notifier_private
*priv
; /* Private event notifier interface */
455 void (*notification_send
)(struct lttng_ust_event_notifier
*event_notifier
,
456 const char *stack_data
);
457 struct cds_list_head capture_bytecode_runtime_head
;
459 /* End of base ABI. Fields below should be used after checking struct_size. */
463 const struct lttng_enum_desc
*desc
;
464 struct lttng_session
*session
;
465 struct cds_list_head node
; /* Enum list in session */
466 struct cds_hlist_node hlist
; /* Session ht of enums */
467 uint64_t id
; /* Enumeration ID in sessiond */
471 struct lttng_ust_shm_handle
;
474 * IMPORTANT: this structure is part of the ABI between the probe and
475 * UST. Fields need to be only added at the end, never reordered, never
478 struct lttng_channel_ops
{
479 struct lttng_channel
*(*channel_create
)(const char *name
,
481 size_t subbuf_size
, size_t num_subbuf
,
482 unsigned int switch_timer_interval
,
483 unsigned int read_timer_interval
,
486 const int *stream_fds
, int nr_stream_fds
,
487 int64_t blocking_timeout
);
488 void (*channel_destroy
)(struct lttng_channel
*chan
);
489 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
491 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
492 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
493 const void *src
, size_t len
);
495 * packet_avail_size returns the available size in the current
496 * packet. Note that the size returned is only a hint, since it
497 * may change due to concurrent writes.
499 size_t (*packet_avail_size
)(struct channel
*chan
,
500 struct lttng_ust_shm_handle
*handle
);
501 int (*is_finalized
)(struct channel
*chan
);
502 int (*is_disabled
)(struct channel
*chan
);
503 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
504 void (*event_strcpy
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
505 const char *src
, size_t len
);
509 * IMPORTANT: this structure is part of the ABI between the probe and
510 * UST. Fields need to be only added at the end, never reordered, never
513 struct lttng_channel
{
515 * The pointers located in this private data are NOT safe to be
516 * dereferenced by the consumer. The only operations the
517 * consumer process is designed to be allowed to do is to read
518 * and perform subbuffer flush.
520 struct channel
*chan
; /* Channel buffers */
522 struct lttng_ctx
*ctx
;
523 /* Event ID management */
524 struct lttng_session
*session
;
525 int objd
; /* Object associated to channel */
526 struct cds_list_head node
; /* Channel list in session */
527 const struct lttng_channel_ops
*ops
;
528 int header_type
; /* 0: unset, 1: compact, 2: large */
529 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
533 enum lttng_ust_abi_chan_type type
;
534 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
535 int tstate
:1; /* Transient enable state */
538 struct lttng_counter_dimension
;
540 struct lttng_counter_ops
{
541 struct lib_counter
*(*counter_create
)(size_t nr_dimensions
,
542 const struct lttng_counter_dimension
*dimensions
,
543 int64_t global_sum_step
,
544 int global_counter_fd
,
545 int nr_counter_cpu_fds
,
546 const int *counter_cpu_fds
,
548 void (*counter_destroy
)(struct lib_counter
*counter
);
549 int (*counter_add
)(struct lib_counter
*counter
,
550 const size_t *dimension_indexes
, int64_t v
);
551 int (*counter_read
)(struct lib_counter
*counter
,
552 const size_t *dimension_indexes
, int cpu
,
553 int64_t *value
, bool *overflow
, bool *underflow
);
554 int (*counter_aggregate
)(struct lib_counter
*counter
,
555 const size_t *dimension_indexes
, int64_t *value
,
556 bool *overflow
, bool *underflow
);
557 int (*counter_clear
)(struct lib_counter
*counter
, const size_t *dimension_indexes
);
560 #define LTTNG_UST_STACK_CTX_PADDING 32
561 struct lttng_stack_ctx
{
562 struct lttng_ust_event_recorder
*event_recorder
;
563 struct lttng_ctx
*chan_ctx
; /* RCU dereferenced. */
564 struct lttng_ctx
*event_ctx
; /* RCU dereferenced. */
565 char padding
[LTTNG_UST_STACK_CTX_PADDING
];
568 #define LTTNG_UST_EVENT_HT_BITS 12
569 #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
571 struct lttng_ust_event_ht
{
572 struct cds_hlist_head table
[LTTNG_UST_EVENT_HT_SIZE
];
575 #define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12
576 #define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
577 struct lttng_ust_event_notifier_ht
{
578 struct cds_hlist_head table
[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE
];
581 #define LTTNG_UST_ENUM_HT_BITS 12
582 #define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS)
584 struct lttng_ust_enum_ht
{
585 struct cds_hlist_head table
[LTTNG_UST_ENUM_HT_SIZE
];
588 struct lttng_ust_session_private
;
591 * IMPORTANT: this structure is part of the ABI between the probe and
592 * UST. Fields need to be only added at the end, never reordered, never
595 * The field @struct_size should be used to determine the size of the
596 * structure. It should be queried before using additional fields added
597 * at the end of the structure.
599 struct lttng_session
{
600 uint32_t struct_size
; /* Size of this structure */
601 struct lttng_ust_session_private
*priv
; /* Private session interface */
603 int active
; /* Is trace session active ? */
605 /* End of base ABI. Fields below should be used after checking struct_size. */
608 int lttng_ust_probe_register(struct lttng_ust_probe_desc
*desc
);
609 void lttng_ust_probe_unregister(struct lttng_ust_probe_desc
*desc
);
612 * Can be used by applications that change their procname to clear the ust cached value.
614 void lttng_context_procname_reset(void);
616 struct lttng_transport
*lttng_transport_find(const char *name
);
618 int lttng_session_active(void);
620 void lttng_ust_dl_update(void *ip
);
626 #endif /* _LTTNG_UST_EVENTS_H */