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,
87 * Enumeration entry description
89 * IMPORTANT: this structure is part of the ABI between the probe and
90 * UST. Fields need to be only added at the end, never reordered, never
93 * The field @struct_size should be used to determine the size of the
94 * structure. It should be queried before using additional fields added
95 * at the end of the structure.
98 struct lttng_ust_enum_entry
{
101 struct lttng_enum_value start
, end
; /* start and end are inclusive */
103 unsigned int options
;
105 /* End of base ABI. Fields below should be used after checking struct_size. */
108 #define __type_integer(_type, _byte_order, _base, _encoding) \
110 .atype = atype_integer, \
115 .size = sizeof(_type) * CHAR_BIT, \
116 .alignment = lttng_alignof(_type) * CHAR_BIT, \
117 .signedness = lttng_is_signed_type(_type), \
118 .reverse_byte_order = _byte_order != BYTE_ORDER, \
120 .encoding = lttng_encode_##_encoding, \
125 #define LTTNG_UST_INTEGER_TYPE_PADDING 24
126 struct lttng_integer_type
{
127 unsigned int size
; /* in bits */
128 unsigned short alignment
; /* in bits */
129 unsigned int signedness
:1;
130 unsigned int reverse_byte_order
:1;
131 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
132 enum lttng_string_encodings encoding
;
133 char padding
[LTTNG_UST_INTEGER_TYPE_PADDING
];
137 * Only float and double are supported. long double is not supported at
140 #define _float_mant_dig(_type) \
141 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
142 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
145 #define __type_float(_type) \
147 .atype = atype_float, \
152 .exp_dig = sizeof(_type) * CHAR_BIT \
153 - _float_mant_dig(_type), \
154 .mant_dig = _float_mant_dig(_type), \
155 .alignment = lttng_alignof(_type) * CHAR_BIT, \
156 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
161 #define LTTNG_UST_FLOAT_TYPE_PADDING 24
162 struct lttng_float_type
{
163 unsigned int exp_dig
; /* exponent digits, in bits */
164 unsigned int mant_dig
; /* mantissa digits, in bits */
165 unsigned short alignment
; /* in bits */
166 unsigned int reverse_byte_order
:1;
167 char padding
[LTTNG_UST_FLOAT_TYPE_PADDING
];
170 #define LTTNG_UST_TYPE_PADDING 128
172 enum lttng_abstract_types atype
;
174 /* provider ABI 2.0 */
175 struct lttng_integer_type integer
;
176 struct lttng_float_type _float
;
178 enum lttng_string_encodings encoding
;
181 const struct lttng_ust_enum_desc
*desc
; /* Enumeration mapping */
182 struct lttng_type
*container_type
;
185 const struct lttng_type
*elem_type
;
186 unsigned int length
; /* Num. elems. */
187 unsigned int alignment
;
190 const char *length_name
; /* Length field name. */
191 const struct lttng_type
*elem_type
;
192 unsigned int alignment
; /* Alignment before elements. */
195 unsigned int nr_fields
;
196 const struct lttng_ust_event_field
**fields
; /* Array of pointers to fields. */
197 unsigned int alignment
;
200 char padding
[LTTNG_UST_TYPE_PADDING
];
205 * Enumeration description
207 * IMPORTANT: this structure is part of the ABI between the probe and
208 * UST. Fields need to be only added at the end, never reordered, never
211 * The field @struct_size should be used to determine the size of the
212 * structure. It should be queried before using additional fields added
213 * at the end of the structure.
216 struct lttng_ust_enum_desc
{
217 uint32_t struct_size
;
220 const struct lttng_ust_enum_entry
**entries
;
221 unsigned int nr_entries
;
223 /* End of base ABI. Fields below should be used after checking struct_size. */
227 * Event field description
229 * IMPORTANT: this structure is part of the ABI between the probe and
230 * UST. Fields need to be only added at the end, never reordered, never
233 * The field @struct_size should be used to determine the size of the
234 * structure. It should be queried before using additional fields added
235 * at the end of the structure.
238 struct lttng_ust_event_field
{
239 uint32_t struct_size
;
242 struct lttng_type type
;
243 unsigned int nowrite
:1, /* do not write into trace */
244 nofilter
:1; /* do not consider for filter */
246 /* End of base ABI. Fields below should be used after checking struct_size. */
249 enum lttng_ust_dynamic_type
{
250 LTTNG_UST_DYNAMIC_TYPE_NONE
,
251 LTTNG_UST_DYNAMIC_TYPE_S8
,
252 LTTNG_UST_DYNAMIC_TYPE_S16
,
253 LTTNG_UST_DYNAMIC_TYPE_S32
,
254 LTTNG_UST_DYNAMIC_TYPE_S64
,
255 LTTNG_UST_DYNAMIC_TYPE_U8
,
256 LTTNG_UST_DYNAMIC_TYPE_U16
,
257 LTTNG_UST_DYNAMIC_TYPE_U32
,
258 LTTNG_UST_DYNAMIC_TYPE_U64
,
259 LTTNG_UST_DYNAMIC_TYPE_FLOAT
,
260 LTTNG_UST_DYNAMIC_TYPE_DOUBLE
,
261 LTTNG_UST_DYNAMIC_TYPE_STRING
,
262 _NR_LTTNG_UST_DYNAMIC_TYPES
,
265 struct lttng_ctx_value
{
266 enum lttng_ust_dynamic_type sel
;
275 struct lttng_perf_counter_field
;
277 #define LTTNG_UST_CTX_FIELD_PADDING 40
278 struct lttng_ctx_field
{
279 struct lttng_ust_event_field event_field
;
280 size_t (*get_size
)(struct lttng_ctx_field
*field
, size_t offset
);
281 void (*record
)(struct lttng_ctx_field
*field
,
282 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
283 struct lttng_channel
*chan
);
284 void (*get_value
)(struct lttng_ctx_field
*field
,
285 struct lttng_ctx_value
*value
);
287 struct lttng_perf_counter_field
*perf_counter
;
288 char padding
[LTTNG_UST_CTX_FIELD_PADDING
];
290 void (*destroy
)(struct lttng_ctx_field
*field
);
291 char *field_name
; /* Has ownership, dynamically allocated. */
294 #define LTTNG_UST_CTX_PADDING 20
296 struct lttng_ctx_field
*fields
;
297 unsigned int nr_fields
;
298 unsigned int allocated_fields
;
299 unsigned int largest_align
;
300 char padding
[LTTNG_UST_CTX_PADDING
];
304 * IMPORTANT: this structure is part of the ABI between the probe and
305 * UST. Fields need to be only added at the end, never reordered, never
308 * The field @struct_size should be used to determine the size of the
309 * structure. It should be queried before using additional fields added
310 * at the end of the structure.
312 struct lttng_ust_event_desc
{
313 uint32_t struct_size
; /* Size of this structure. */
315 void (*probe_callback
)(void);
316 const struct lttng_event_ctx
*ctx
; /* context */
317 const struct lttng_ust_event_field
**fields
; /* event payload */
318 unsigned int nr_fields
;
319 const int **loglevel
;
320 const char *signature
; /* Argument types/names received */
321 const char **model_emf_uri
;
323 /* End of base ABI. Fields below should be used after checking struct_size. */
327 * IMPORTANT: this structure is part of the ABI between the probe and
328 * UST. Fields need to be only added at the end, never reordered, never
331 * The field @struct_size should be used to determine the size of the
332 * structure. It should be queried before using additional fields added
333 * at the end of the structure.
335 struct lttng_ust_probe_desc
{
336 uint32_t struct_size
; /* Size of this structure. */
338 const char *provider
;
339 const struct lttng_ust_event_desc
**event_desc
;
340 unsigned int nr_events
;
341 struct cds_list_head head
; /* chain registered probes */
342 struct cds_list_head lazy_init_head
;
343 int lazy
; /* lazy registration */
347 /* End of base ABI. Fields below should be used after checking struct_size. */
350 /* Data structures used by the tracer. */
353 * Bytecode interpreter return value masks.
355 enum lttng_bytecode_interpreter_ret
{
356 LTTNG_INTERPRETER_DISCARD
= 0,
357 LTTNG_INTERPRETER_RECORD_FLAG
= (1ULL << 0),
358 /* Other bits are kept for future use. */
361 struct lttng_interpreter_output
;
362 struct lttng_ust_bytecode_runtime_private
;
365 * This structure is used in the probes. More specifically, the
366 * `interpreter_funcs` and `node` fields are explicity used in the
367 * probes. When modifying this structure we must not change the layout
368 * of these two fields as it is considered ABI.
370 struct lttng_bytecode_runtime
{
371 struct lttng_ust_bytecode_runtime_private
*priv
;
373 /* Associated bytecode */
375 uint64_t (*filter
)(void *interpreter_data
,
376 const char *interpreter_stack_data
);
377 uint64_t (*capture
)(void *interpreter_data
,
378 const char *interpreter_stack_data
,
379 struct lttng_interpreter_output
*interpreter_output
);
381 struct cds_list_head node
; /* list of bytecode runtime in event */
385 * lttng_event structure is referred to by the tracing fast path. It
386 * must be kept small.
388 * IMPORTANT: this structure is part of the ABI between the probe and
389 * UST. Fields need to be only added at the end, never reordered, never
393 struct lttng_ust_event_common_private
;
395 enum lttng_ust_event_type
{
396 LTTNG_UST_EVENT_TYPE_RECORDER
= 0,
397 LTTNG_UST_EVENT_TYPE_NOTIFIER
= 1,
401 * IMPORTANT: this structure is part of the ABI between the probe and
402 * UST. Fields need to be only added at the end, never reordered, never
405 * struct lttng_ust_event_common is the common ancestor of the various
406 * public event actions. Inheritance is done by composition: The parent
407 * has a pointer to its child, and the child has a pointer to its
408 * parent. Inheritance of those public structures is done by composition
409 * to ensure both parent and child structures can be extended.
411 * The field @struct_size should be used to determine the size of the
412 * structure. It should be queried before using additional fields added
413 * at the end of the structure.
415 struct lttng_ust_event_common
{
416 uint32_t struct_size
; /* Size of this structure. */
417 struct lttng_ust_event_common_private
*priv
; /* Private event interface */
419 enum lttng_ust_event_type type
;
420 void *child
; /* Pointer to child, for inheritance by aggregation. */
423 int has_enablers_without_bytecode
;
424 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
425 struct cds_list_head filter_bytecode_runtime_head
;
427 /* End of base ABI. Fields below should be used after checking struct_size. */
430 struct lttng_ust_event_recorder_private
;
433 * IMPORTANT: this structure is part of the ABI between the probe and
434 * UST. Fields need to be only added at the end, never reordered, never
437 * struct lttng_ust_event_recorder is the action for recording events
438 * into a ring buffer. It inherits from struct lttng_ust_event_common
439 * by composition to ensure both parent and child structure are
442 * The field @struct_size should be used to determine the size of the
443 * structure. It should be queried before using additional fields added
444 * at the end of the structure.
446 struct lttng_ust_event_recorder
{
447 uint32_t struct_size
; /* Size of this structure. */
448 struct lttng_ust_event_common
*parent
; /* Inheritance by aggregation. */
449 struct lttng_ust_event_recorder_private
*priv
; /* Private event record interface */
452 struct lttng_channel
*chan
;
453 struct lttng_ctx
*ctx
;
455 /* End of base ABI. Fields below should be used after checking struct_size. */
458 struct lttng_ust_event_notifier_private
;
461 * IMPORTANT: this structure is part of the ABI between the probe and
462 * UST. Fields need to be only added at the end, never reordered, never
465 * struct lttng_ust_event_notifier is the action for sending
466 * notifications. It inherits from struct lttng_ust_event_common
467 * by composition to ensure both parent and child structure are
470 * The field @struct_size should be used to determine the size of the
471 * structure. It should be queried before using additional fields added
472 * at the end of the structure.
474 struct lttng_ust_event_notifier
{
475 uint32_t struct_size
; /* Size of this structure. */
476 struct lttng_ust_event_common
*parent
; /* Inheritance by aggregation. */
477 struct lttng_ust_event_notifier_private
*priv
; /* Private event notifier interface */
479 void (*notification_send
)(struct lttng_ust_event_notifier
*event_notifier
,
480 const char *stack_data
);
481 struct cds_list_head capture_bytecode_runtime_head
;
483 /* End of base ABI. Fields below should be used after checking struct_size. */
487 struct lttng_ust_shm_handle
;
490 * IMPORTANT: this structure is part of the ABI between the probe and
491 * UST. Fields need to be only added at the end, never reordered, never
494 * The field @struct_size should be used to determine the size of the
495 * structure. It should be queried before using additional fields added
496 * at the end of the structure.
498 struct lttng_ust_channel_ops
{
499 uint32_t struct_size
;
501 struct lttng_channel
*(*channel_create
)(const char *name
,
503 size_t subbuf_size
, size_t num_subbuf
,
504 unsigned int switch_timer_interval
,
505 unsigned int read_timer_interval
,
508 const int *stream_fds
, int nr_stream_fds
,
509 int64_t blocking_timeout
);
510 void (*channel_destroy
)(struct lttng_channel
*chan
);
511 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
513 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
514 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
515 const void *src
, size_t len
);
517 * packet_avail_size returns the available size in the current
518 * packet. Note that the size returned is only a hint, since it
519 * may change due to concurrent writes.
521 size_t (*packet_avail_size
)(struct channel
*chan
,
522 struct lttng_ust_shm_handle
*handle
);
523 int (*is_finalized
)(struct channel
*chan
);
524 int (*is_disabled
)(struct channel
*chan
);
525 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
526 void (*event_strcpy
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
527 const char *src
, size_t len
);
529 /* End of base ABI. Fields below should be used after checking struct_size. */
533 * IMPORTANT: this structure is part of the ABI between the probe and
534 * UST. Fields need to be only added at the end, never reordered, never
537 struct lttng_channel
{
539 * The pointers located in this private data are NOT safe to be
540 * dereferenced by the consumer. The only operations the
541 * consumer process is designed to be allowed to do is to read
542 * and perform subbuffer flush.
544 struct channel
*chan
; /* Channel buffers */
546 struct lttng_ctx
*ctx
;
547 /* Event ID management */
548 struct lttng_session
*session
;
549 int objd
; /* Object associated to channel */
550 struct cds_list_head node
; /* Channel list in session */
551 const struct lttng_ust_channel_ops
*ops
;
552 int header_type
; /* 0: unset, 1: compact, 2: large */
553 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
557 enum lttng_ust_abi_chan_type type
;
558 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
559 int tstate
:1; /* Transient enable state */
562 struct lttng_counter_dimension
;
564 struct lttng_counter_ops
{
565 struct lib_counter
*(*counter_create
)(size_t nr_dimensions
,
566 const struct lttng_counter_dimension
*dimensions
,
567 int64_t global_sum_step
,
568 int global_counter_fd
,
569 int nr_counter_cpu_fds
,
570 const int *counter_cpu_fds
,
572 void (*counter_destroy
)(struct lib_counter
*counter
);
573 int (*counter_add
)(struct lib_counter
*counter
,
574 const size_t *dimension_indexes
, int64_t v
);
575 int (*counter_read
)(struct lib_counter
*counter
,
576 const size_t *dimension_indexes
, int cpu
,
577 int64_t *value
, bool *overflow
, bool *underflow
);
578 int (*counter_aggregate
)(struct lib_counter
*counter
,
579 const size_t *dimension_indexes
, int64_t *value
,
580 bool *overflow
, bool *underflow
);
581 int (*counter_clear
)(struct lib_counter
*counter
, const size_t *dimension_indexes
);
584 #define LTTNG_UST_STACK_CTX_PADDING 32
585 struct lttng_stack_ctx
{
586 struct lttng_ust_event_recorder
*event_recorder
;
587 struct lttng_ctx
*chan_ctx
; /* RCU dereferenced. */
588 struct lttng_ctx
*event_ctx
; /* RCU dereferenced. */
589 char padding
[LTTNG_UST_STACK_CTX_PADDING
];
592 #define LTTNG_UST_EVENT_HT_BITS 12
593 #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
595 struct lttng_ust_event_ht
{
596 struct cds_hlist_head table
[LTTNG_UST_EVENT_HT_SIZE
];
599 #define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12
600 #define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
601 struct lttng_ust_event_notifier_ht
{
602 struct cds_hlist_head table
[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE
];
605 #define LTTNG_UST_ENUM_HT_BITS 12
606 #define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS)
608 struct lttng_ust_enum_ht
{
609 struct cds_hlist_head table
[LTTNG_UST_ENUM_HT_SIZE
];
612 struct lttng_ust_session_private
;
615 * IMPORTANT: this structure is part of the ABI between the probe and
616 * UST. Fields need to be only added at the end, never reordered, never
619 * The field @struct_size should be used to determine the size of the
620 * structure. It should be queried before using additional fields added
621 * at the end of the structure.
623 struct lttng_session
{
624 uint32_t struct_size
; /* Size of this structure */
625 struct lttng_ust_session_private
*priv
; /* Private session interface */
627 int active
; /* Is trace session active ? */
629 /* End of base ABI. Fields below should be used after checking struct_size. */
632 int lttng_ust_probe_register(struct lttng_ust_probe_desc
*desc
);
633 void lttng_ust_probe_unregister(struct lttng_ust_probe_desc
*desc
);
636 * Can be used by applications that change their procname to clear the ust cached value.
638 void lttng_context_procname_reset(void);
640 struct lttng_transport
*lttng_transport_find(const char *name
);
642 int lttng_session_active(void);
644 void lttng_ust_dl_update(void *ip
);
650 #endif /* _LTTNG_UST_EVENTS_H */