1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
5 * Holds LTTng per-session event registry.
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 #ifndef _LTTNG_EVENTS_H
11 #define _LTTNG_EVENTS_H
13 #include <lttng/kernel-version.h>
14 #include <linux/list.h>
15 #include <linux/kprobes.h>
16 #include <linux/kref.h>
17 #include <linux/uuid.h>
18 #include <linux/irq_work.h>
19 #include <wrapper/uprobes.h>
20 #include <lttng/cpuhotplug.h>
21 #include <lttng/tracer.h>
22 #include <lttng/abi.h>
23 #include <lttng/abi-old.h>
24 #include <lttng/endian.h>
26 #define lttng_is_signed_type(type) (((type) -1) < (type) 1)
30 struct lttng_metadata_cache
;
31 struct lib_ring_buffer_ctx
;
33 struct perf_event_attr
;
34 struct lib_ring_buffer_config
;
36 /* Type description */
43 atype_sequence_nestable
,
44 atype_struct_nestable
,
45 atype_variant_nestable
,
49 enum lttng_string_encodings
{
50 lttng_encode_none
= 0,
51 lttng_encode_UTF8
= 1,
52 lttng_encode_ASCII
= 2,
61 struct lttng_enum_value
{
62 unsigned long long value
;
63 unsigned int signedness
:1;
66 struct lttng_enum_entry
{
67 struct lttng_enum_value start
, end
; /* start and end are inclusive */
70 unsigned int is_auto
:1;
74 #define __type_integer(_type, _size, _alignment, _signedness, \
75 _byte_order, _base, _encoding) \
77 .atype = atype_integer, \
80 .size = (_size) ? : sizeof(_type) * CHAR_BIT, \
81 .alignment = (_alignment) ? : lttng_alignof(_type) * CHAR_BIT, \
82 .signedness = (_signedness) >= 0 ? (_signedness) : lttng_is_signed_type(_type), \
83 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
85 .encoding = lttng_encode_##_encoding, \
89 struct lttng_integer_type {
90 unsigned int size
; /* in bits */
91 unsigned short alignment
; /* in bits */
92 unsigned int signedness
:1,
94 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
95 enum lttng_string_encodings encoding
;
99 enum abstract_types atype
;
101 struct lttng_integer_type integer
;
103 enum lttng_string_encodings encoding
;
106 const struct lttng_enum_desc
*desc
; /* Enumeration mapping */
107 const struct lttng_type
*container_type
;
110 const struct lttng_type
*elem_type
;
111 unsigned int length
; /* Num. elems. */
112 unsigned int alignment
;
115 const char *length_name
; /* Length field name. */
116 const struct lttng_type
*elem_type
;
117 unsigned int alignment
; /* Alignment before elements. */
120 unsigned int nr_fields
;
121 const struct lttng_event_field
*fields
; /* Array of fields. */
122 unsigned int alignment
;
125 const char *tag_name
;
126 const struct lttng_event_field
*choices
; /* Array of fields. */
127 unsigned int nr_choices
;
128 unsigned int alignment
;
133 struct lttng_enum_desc
{
135 const struct lttng_enum_entry
*entries
;
136 unsigned int nr_entries
;
139 /* Event field description */
141 struct lttng_event_field
{
143 struct lttng_type type
;
144 unsigned int nowrite
:1, /* do not write into trace */
145 user
:1, /* fetch from user-space */
146 nofilter
:1; /* do not consider for filter */
149 union lttng_ctx_value
{
156 * We need to keep this perf counter field separately from struct
157 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
159 struct lttng_perf_counter_field
{
160 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
161 struct lttng_cpuhp_node cpuhp_prepare
;
162 struct lttng_cpuhp_node cpuhp_online
;
164 struct notifier_block nb
;
167 struct perf_event_attr
*attr
;
168 struct perf_event
**e
; /* per-cpu array */
171 struct lttng_probe_ctx
{
172 struct lttng_event
*event
;
173 struct lttng_event_notifier
*event_notifier
; // Not sure if we will ever need it.
174 uint8_t interruptible
;
177 struct lttng_ctx_field
{
178 struct lttng_event_field event_field
;
179 size_t (*get_size
)(size_t offset
);
180 size_t (*get_size_arg
)(size_t offset
, struct lttng_ctx_field
*field
,
181 struct lib_ring_buffer_ctx
*ctx
,
182 struct lttng_channel
*chan
);
183 void (*record
)(struct lttng_ctx_field
*field
,
184 struct lib_ring_buffer_ctx
*ctx
,
185 struct lttng_channel
*chan
);
186 void (*get_value
)(struct lttng_ctx_field
*field
,
187 struct lttng_probe_ctx
*lttng_probe_ctx
,
188 union lttng_ctx_value
*value
);
190 struct lttng_perf_counter_field
*perf_counter
;
192 void (*destroy
)(struct lttng_ctx_field
*field
);
194 * Private data to keep state between get_size and record.
195 * User must perform its own synchronization to protect against
196 * concurrent and reentrant contexts.
202 struct lttng_ctx_field
*fields
;
203 unsigned int nr_fields
;
204 unsigned int allocated_fields
;
205 size_t largest_align
; /* in bytes */
208 struct lttng_event_desc
{
209 const char *name
; /* lttng-modules name */
210 const char *kname
; /* Linux kernel name (tracepoints) */
211 void *probe_callback
;
212 const struct lttng_event_ctx
*ctx
; /* context */
213 const struct lttng_event_field
*fields
; /* event payload */
214 unsigned int nr_fields
;
215 struct module
*owner
;
216 void *event_notifier_callback
;
219 struct lttng_probe_desc
{
220 const char *provider
;
221 const struct lttng_event_desc
**event_desc
;
222 unsigned int nr_events
;
223 struct list_head head
; /* chain registered probes */
224 struct list_head lazy_init_head
;
225 int lazy
; /* lazy registration */
228 struct lttng_krp
; /* Kretprobe handling */
230 enum lttng_event_type
{
231 LTTNG_TYPE_EVENT
= 0,
232 LTTNG_TYPE_ENABLER
= 1,
235 enum lttng_bytecode_node_type
{
236 LTTNG_BYTECODE_NODE_TYPE_FILTER
,
237 LTTNG_BYTECODE_NODE_TYPE_CAPTURE
,
240 struct lttng_bytecode_node
{
241 enum lttng_bytecode_node_type type
;
242 struct list_head node
;
243 struct lttng_enabler
*enabler
;
246 uint32_t reloc_offset
;
253 * Bytecode interpreter return value masks.
255 enum lttng_bytecode_interpreter_ret
{
256 LTTNG_INTERPRETER_DISCARD
= 0,
257 LTTNG_INTERPRETER_RECORD_FLAG
= (1ULL << 0),
258 /* Other bits are kept for future use. */
261 struct lttng_interpreter_output
;
263 struct lttng_bytecode_runtime
{
264 /* Associated bytecode */
265 struct lttng_bytecode_node
*bc
;
267 uint64_t (*filter
)(void *filter_data
,
268 struct lttng_probe_ctx
*lttng_probe_ctx
,
269 const char *filter_stack_data
);
270 uint64_t (*capture
)(void *filter_data
,
271 struct lttng_probe_ctx
*lttng_probe_ctx
,
272 const char *capture_stack_data
,
273 struct lttng_interpreter_output
*output
);
276 struct list_head node
; /* list of bytecode runtime in event */
277 struct lttng_ctx
*ctx
;
281 * Objects in a linked-list of enablers, owned by an event.
283 struct lttng_enabler_ref
{
284 struct list_head node
; /* enabler ref list */
285 struct lttng_enabler
*ref
; /* backward ref */
288 struct lttng_uprobe_handler
{
290 struct lttng_event
*event
;
291 struct lttng_event_notifier
*event_notifier
;
294 struct uprobe_consumer up_consumer
;
295 struct list_head node
;
298 struct lttng_kprobe
{
303 struct lttng_uprobe
{
305 struct list_head head
;
308 enum lttng_syscall_entryexit
{
313 enum lttng_syscall_abi
{
314 LTTNG_SYSCALL_ABI_NATIVE
,
315 LTTNG_SYSCALL_ABI_COMPAT
,
319 * lttng_event structure is referred to by the tracing fast path. It must be
323 enum lttng_event_type evtype
; /* First field. */
325 struct lttng_channel
*chan
;
327 const struct lttng_event_desc
*desc
;
329 struct lttng_ctx
*ctx
;
330 enum lttng_kernel_instrumentation instrumentation
;
332 struct lttng_kprobe kprobe
;
334 struct lttng_krp
*lttng_krp
;
337 struct lttng_uprobe uprobe
;
339 enum lttng_syscall_entryexit entryexit
;
340 enum lttng_syscall_abi abi
;
341 struct hlist_node node
; /* chain registered syscall event */
344 struct list_head list
; /* Event list in session */
345 unsigned int metadata_dumped
:1;
347 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
348 struct list_head enablers_ref_head
;
349 struct hlist_node hlist
; /* session ht of events */
350 int registered
; /* has reg'd tracepoint probe */
351 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
352 struct list_head filter_bytecode_runtime_head
;
353 int has_enablers_without_bytecode
;
356 struct lttng_kernel_notifier_ctx
{
360 // FIXME: Really similar to lttng_event above. Could those be merged ?
361 struct lttng_event_notifier
{
362 enum lttng_event_type evtype
; /* First field. */
364 uint64_t error_counter_index
;
366 int registered
; /* has reg'd tracepoint probe */
367 const struct lttng_event_desc
*desc
;
369 struct list_head list
; /* event_notifier list in event_notifier group */
371 enum lttng_kernel_instrumentation instrumentation
;
373 struct lttng_kprobe kprobe
;
374 struct lttng_uprobe uprobe
;
376 enum lttng_syscall_entryexit entryexit
;
377 enum lttng_syscall_abi abi
;
378 struct hlist_node node
; /* chain registered syscall event_notifier */
379 unsigned int syscall_id
;
384 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
385 struct list_head enablers_ref_head
;
386 struct hlist_node hlist
; /* session ht of event_notifiers */
387 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
388 struct list_head filter_bytecode_runtime_head
;
390 struct list_head capture_bytecode_runtime_head
;
391 int has_enablers_without_bytecode
;
392 int eval_capture
; /* Should evaluate capture */
394 void (*send_notification
)(struct lttng_event_notifier
*event_notifier
,
395 struct lttng_probe_ctx
*lttng_probe_ctx
,
396 const char *interpreter_stack_data
,
397 struct lttng_kernel_notifier_ctx
*notif_ctx
);
398 struct lttng_event_notifier_group
*group
; /* Weak ref */
401 enum lttng_enabler_format_type
{
402 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
403 LTTNG_ENABLER_FORMAT_NAME
,
407 * Enabler field, within whatever object is enabling an event. Target of
408 * backward reference.
410 struct lttng_enabler
{
411 enum lttng_event_type evtype
; /* First field. */
413 enum lttng_enabler_format_type format_type
;
415 /* head list of struct lttng_bytecode_node */
416 struct list_head filter_bytecode_head
;
418 struct lttng_kernel_event event_param
;
419 unsigned int enabled
:1;
421 uint64_t user_token
; /* User-provided token. */
424 struct lttng_event_enabler
{
425 struct lttng_enabler base
;
426 struct list_head node
; /* per-session list of enablers */
427 struct lttng_channel
*chan
;
429 * Unused, but kept around to make it explicit that the tracer can do
432 struct lttng_ctx
*ctx
;
435 struct lttng_event_notifier_enabler
{
436 struct lttng_enabler base
;
437 uint64_t error_counter_index
;
438 struct list_head node
; /* List of event_notifier enablers */
439 struct lttng_event_notifier_group
*group
;
441 /* head list of struct lttng_bytecode_node */
442 struct list_head capture_bytecode_head
;
443 uint64_t num_captures
;
448 struct lttng_enabler
*lttng_event_enabler_as_enabler(
449 struct lttng_event_enabler
*event_enabler
)
451 return &event_enabler
->base
;
455 struct lttng_enabler
*lttng_event_notifier_enabler_as_enabler(
456 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
458 return &event_notifier_enabler
->base
;
461 struct lttng_channel_ops
{
462 struct channel
*(*channel_create
)(const char *name
,
465 size_t subbuf_size
, size_t num_subbuf
,
466 unsigned int switch_timer_interval
,
467 unsigned int read_timer_interval
);
468 void (*channel_destroy
)(struct channel
*chan
);
469 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
470 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
471 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
472 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
474 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
475 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
477 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
478 const void *src
, size_t len
);
479 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
481 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
483 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
484 const char __user
*src
, size_t len
);
486 * packet_avail_size returns the available size in the current
487 * packet. Note that the size returned is only a hint, since it
488 * may change due to concurrent writes.
490 size_t (*packet_avail_size
)(struct channel
*chan
);
491 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
492 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
493 int (*is_finalized
)(struct channel
*chan
);
494 int (*is_disabled
)(struct channel
*chan
);
495 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
496 struct lib_ring_buffer
*bufb
,
497 uint64_t *timestamp_begin
);
498 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
499 struct lib_ring_buffer
*bufb
,
500 uint64_t *timestamp_end
);
501 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
502 struct lib_ring_buffer
*bufb
,
503 uint64_t *events_discarded
);
504 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
505 struct lib_ring_buffer
*bufb
,
506 uint64_t *content_size
);
507 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
508 struct lib_ring_buffer
*bufb
,
509 uint64_t *packet_size
);
510 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
511 struct lib_ring_buffer
*bufb
,
512 uint64_t *stream_id
);
513 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
514 struct lib_ring_buffer
*bufb
,
516 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
517 struct lib_ring_buffer
*bufb
,
519 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
520 struct lib_ring_buffer
*bufb
,
524 struct lttng_counter_ops
{
525 struct lib_counter
*(*counter_create
)(size_t nr_dimensions
,
526 const size_t *max_nr_elem
, /* for each dimension */
527 int64_t global_sum_step
);
528 void (*counter_destroy
)(struct lib_counter
*counter
);
529 int (*counter_add
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
532 * counter_read reads a specific cpu's counter if @cpu >= 0, or
533 * the global aggregation counter if @cpu == -1.
535 int (*counter_read
)(struct lib_counter
*counter
, const size_t *dimension_indexes
, int cpu
,
536 int64_t *value
, bool *overflow
, bool *underflow
);
538 * counter_aggregate returns the total sum of all per-cpu counters and
539 * the global aggregation counter.
541 int (*counter_aggregate
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
542 int64_t *value
, bool *overflow
, bool *underflow
);
543 int (*counter_clear
)(struct lib_counter
*counter
, const size_t *dimension_indexes
);
546 struct lttng_transport
{
548 struct module
*owner
;
549 struct list_head node
;
550 struct lttng_channel_ops ops
;
553 struct lttng_counter_transport
{
555 struct module
*owner
;
556 struct list_head node
;
557 struct lttng_counter_ops ops
;
560 struct lttng_syscall_filter
;
562 #define LTTNG_EVENT_HT_BITS 12
563 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
565 struct lttng_event_ht
{
566 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
569 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
570 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
572 struct lttng_event_notifier_ht
{
573 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
576 struct lttng_channel
{
578 struct channel
*chan
; /* Channel buffers */
580 struct lttng_ctx
*ctx
;
581 /* Event ID management */
582 struct lttng_session
*session
;
583 struct file
*file
; /* File associated to channel */
584 unsigned int free_event_id
; /* Next event ID to allocate */
585 struct list_head list
; /* Channel list */
586 struct lttng_channel_ops
*ops
;
587 struct lttng_transport
*transport
;
588 struct hlist_head
*sc_table
; /* for syscall tracing */
589 struct hlist_head
*compat_sc_table
;
590 struct hlist_head
*sc_exit_table
; /* for syscall exit tracing */
591 struct hlist_head
*compat_sc_exit_table
;
592 struct hlist_head sc_unknown
; /* for unknown syscalls */
593 struct hlist_head sc_compat_unknown
;
594 struct hlist_head sc_exit_unknown
;
595 struct hlist_head compat_sc_exit_unknown
;
596 struct lttng_syscall_filter
*sc_filter
;
597 int header_type
; /* 0: unset, 1: compact, 2: large */
598 enum channel_type channel_type
;
599 int syscall_all_entry
;
600 int syscall_all_exit
;
601 unsigned int metadata_dumped
:1,
602 sys_enter_registered
:1,
603 sys_exit_registered
:1,
604 tstate
:1; /* Transient enable state */
607 struct lttng_metadata_stream
{
608 void *priv
; /* Ring buffer private data */
609 struct lttng_metadata_cache
*metadata_cache
;
610 unsigned int metadata_in
; /* Bytes read from the cache */
611 unsigned int metadata_out
; /* Bytes consumed from stream */
612 int finalized
; /* Has channel been finalized */
613 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
614 struct list_head list
; /* Stream list */
615 struct lttng_transport
*transport
;
616 uint64_t version
; /* Current version of the metadata cache */
617 bool coherent
; /* Stream in a coherent state */
620 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
622 struct lttng_dynamic_len_stack
{
623 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
627 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
630 * struct lttng_id_tracker declared in header due to deferencing of *v
631 * in RCU_INITIALIZER(v).
633 #define LTTNG_ID_HASH_BITS 6
634 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
647 struct lttng_id_tracker_rcu
{
648 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
651 struct lttng_id_tracker
{
652 struct lttng_session
*session
;
653 enum tracker_type tracker_type
;
654 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
657 struct lttng_id_hash_node
{
658 struct hlist_node hlist
;
662 struct lttng_session
{
663 int active
; /* Is trace session active ? */
664 int been_active
; /* Has trace session been active ? */
665 struct file
*file
; /* File associated to session */
666 struct list_head chan
; /* Channel list head */
667 struct list_head events
; /* Event list head */
668 struct list_head list
; /* Session list */
669 unsigned int free_chan_id
; /* Next chan ID to allocate */
670 uuid_le uuid
; /* Trace session unique ID */
671 struct lttng_metadata_cache
*metadata_cache
;
672 struct lttng_id_tracker pid_tracker
;
673 struct lttng_id_tracker vpid_tracker
;
674 struct lttng_id_tracker uid_tracker
;
675 struct lttng_id_tracker vuid_tracker
;
676 struct lttng_id_tracker gid_tracker
;
677 struct lttng_id_tracker vgid_tracker
;
678 unsigned int metadata_dumped
:1,
679 tstate
:1; /* Transient enable state */
680 /* List of event enablers */
681 struct list_head enablers_head
;
682 /* Hash table of events */
683 struct lttng_event_ht events_ht
;
684 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
685 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
688 struct lttng_counter
{
689 struct file
*file
; /* File associated to counter. */
691 struct lttng_counter_transport
*transport
;
692 struct lib_counter
*counter
;
693 struct lttng_counter_ops
*ops
;
696 struct lttng_event_notifier_group
{
697 struct file
*file
; /* File associated to event notifier group */
698 struct file
*notif_file
; /* File used to expose notifications to userspace. */
699 struct list_head node
; /* event notifier group list */
700 struct list_head enablers_head
; /* List of enablers */
701 struct list_head event_notifiers_head
; /* List of event notifier */
702 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
703 struct lttng_ctx
*ctx
; /* Contexts for filters. */
704 struct lttng_channel_ops
*ops
;
705 struct lttng_transport
*transport
;
706 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
707 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
708 wait_queue_head_t read_wait
;
709 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
710 struct lttng_event_notifier
*sc_unknown
; /* for unknown syscalls */
711 struct lttng_event_notifier
*sc_compat_unknown
;
713 struct lttng_syscall_filter
*sc_filter
;
715 struct hlist_head
*event_notifier_syscall_dispatch
;
716 struct hlist_head
*event_notifier_compat_syscall_dispatch
;
717 struct hlist_head
*event_notifier_exit_syscall_dispatch
;
718 struct hlist_head
*event_notifier_exit_compat_syscall_dispatch
;
720 struct hlist_head event_notifier_unknown_syscall_dispatch
;
721 struct hlist_head event_notifier_compat_unknown_syscall_dispatch
;
722 struct hlist_head event_notifier_exit_unknown_syscall_dispatch
;
723 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch
;
725 int syscall_all_entry
;
726 int syscall_all_exit
;
728 unsigned int sys_enter_registered
:1, sys_exit_registered
:1;
730 struct lttng_counter
*error_counter
;
731 size_t error_counter_len
;
734 struct lttng_metadata_cache
{
735 char *data
; /* Metadata cache */
736 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
737 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
738 atomic_t producing
; /* Metadata being produced (incomplete) */
739 struct kref refcount
; /* Metadata cache usage */
740 struct list_head metadata_stream
; /* Metadata stream list */
741 uuid_le uuid
; /* Trace session unique ID (copy) */
742 struct mutex lock
; /* Produce/consume lock */
743 uint64_t version
; /* Current version of the metadata */
746 void lttng_lock_sessions(void);
747 void lttng_unlock_sessions(void);
749 struct list_head
*lttng_get_probe_list_head(void);
751 struct lttng_event_enabler
*lttng_event_enabler_create(
752 enum lttng_enabler_format_type format_type
,
753 struct lttng_kernel_event
*event_param
,
754 struct lttng_channel
*chan
);
756 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
757 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
758 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
759 struct lttng_event_notifier_group
*event_notifier_group
,
760 enum lttng_enabler_format_type format_type
,
761 struct lttng_kernel_event_notifier
*event_notifier_param
);
763 int lttng_event_notifier_enabler_enable(
764 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
765 int lttng_event_notifier_enabler_disable(
766 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
767 int lttng_fix_pending_events(void);
768 int lttng_fix_pending_event_notifiers(void);
769 int lttng_session_active(void);
770 bool lttng_event_notifier_active(void);
772 struct lttng_session
*lttng_session_create(void);
773 int lttng_session_enable(struct lttng_session
*session
);
774 int lttng_session_disable(struct lttng_session
*session
);
775 void lttng_session_destroy(struct lttng_session
*session
);
776 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
777 int lttng_session_statedump(struct lttng_session
*session
);
778 void metadata_cache_destroy(struct kref
*kref
);
780 struct lttng_counter
*lttng_kernel_counter_create(
781 const char *counter_transport_name
, size_t number_dimensions
,
782 const size_t *dimensions_sizes
);
783 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
784 const size_t *dimension_indexes
, int32_t cpu
,
785 int64_t *val
, bool *overflow
, bool *underflow
);
786 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
787 const size_t *dimension_indexes
, int64_t *val
,
788 bool *overflow
, bool *underflow
);
789 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
790 const size_t *dimension_indexes
);
793 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
794 int lttng_event_notifier_group_create_error_counter(
795 struct file
*event_notifier_group_file
,
796 const struct lttng_kernel_counter_conf
*error_counter_conf
);
797 void lttng_event_notifier_group_destroy(
798 struct lttng_event_notifier_group
*event_notifier_group
);
800 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
801 const char *transport_name
,
803 size_t subbuf_size
, size_t num_subbuf
,
804 unsigned int switch_timer_interval
,
805 unsigned int read_timer_interval
,
806 enum channel_type channel_type
);
807 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
808 int overwrite
, void *buf_addr
,
809 size_t subbuf_size
, size_t num_subbuf
,
810 unsigned int switch_timer_interval
,
811 unsigned int read_timer_interval
);
813 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
814 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
815 struct lttng_kernel_event
*event_param
,
817 const struct lttng_event_desc
*event_desc
,
818 enum lttng_kernel_instrumentation itype
);
819 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
820 struct lttng_kernel_event
*event_param
,
822 const struct lttng_event_desc
*event_desc
,
823 enum lttng_kernel_instrumentation itype
);
824 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
825 struct lttng_kernel_old_event
*old_event_param
,
827 const struct lttng_event_desc
*internal_desc
);
829 struct lttng_event_notifier
*lttng_event_notifier_create(
830 const struct lttng_event_desc
*event_notifier_desc
,
832 uint64_t error_counter_idx
,
833 struct lttng_event_notifier_group
*event_notifier_group
,
834 struct lttng_kernel_event_notifier
*event_notifier_param
,
836 enum lttng_kernel_instrumentation itype
);
837 struct lttng_event_notifier
*_lttng_event_notifier_create(
838 const struct lttng_event_desc
*event_notifier_desc
,
840 uint64_t error_counter_idx
,
841 struct lttng_event_notifier_group
*event_notifier_group
,
842 struct lttng_kernel_event_notifier
*event_notifier_param
,
844 enum lttng_kernel_instrumentation itype
);
846 int lttng_channel_enable(struct lttng_channel
*channel
);
847 int lttng_channel_disable(struct lttng_channel
*channel
);
848 int lttng_event_enable(struct lttng_event
*event
);
849 int lttng_event_disable(struct lttng_event
*event
);
851 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
);
852 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
);
854 void lttng_transport_register(struct lttng_transport
*transport
);
855 void lttng_transport_unregister(struct lttng_transport
*transport
);
857 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
);
858 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
);
860 void synchronize_trace(void);
861 int lttng_abi_init(void);
862 int lttng_abi_compat_old_init(void);
863 void lttng_abi_exit(void);
864 void lttng_abi_compat_old_exit(void);
866 int lttng_probe_register(struct lttng_probe_desc
*desc
);
867 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
868 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
869 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
870 int lttng_probes_init(void);
871 void lttng_probes_exit(void);
873 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
874 struct channel
*chan
, bool *coherent
);
876 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
877 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
878 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
879 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
880 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
881 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
883 int lttng_session_track_id(struct lttng_session
*session
,
884 enum tracker_type tracker_type
, int id
);
885 int lttng_session_untrack_id(struct lttng_session
*session
,
886 enum tracker_type tracker_type
, int id
);
888 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
889 enum tracker_type tracker_type
);
891 void lttng_clock_ref(void);
892 void lttng_clock_unref(void);
894 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
895 struct lttng_enabler
*enabler
);
897 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
898 int lttng_syscalls_register_event(struct lttng_event_enabler
*event_enabler
, void *filter
);
899 int lttng_syscalls_unregister_channel(struct lttng_channel
*chan
);
900 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
901 int lttng_syscall_filter_enable_event(
902 struct lttng_channel
*chan
,
903 struct lttng_event
*event
);
904 int lttng_syscall_filter_disable_event(
905 struct lttng_channel
*chan
,
906 struct lttng_event
*event
);
908 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
909 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
911 int lttng_syscalls_register_event_notifier(
912 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
914 int lttng_syscals_create_matching_event_notifiers(
915 struct lttng_event_notifier_enabler
*event_notifier_enabler
, void *filter
);
916 int lttng_syscalls_unregister_event_notifier_group(struct lttng_event_notifier_group
*group
);
917 int lttng_syscall_filter_enable_event_notifier(struct lttng_event_notifier
*event_notifier
);
918 int lttng_syscall_filter_disable_event_notifier(struct lttng_event_notifier
*event_notifier
);
920 static inline int lttng_syscalls_register_event(
921 struct lttng_event_enabler
*event_enabler
, void *filter
)
926 static inline int lttng_syscalls_unregister_channel(struct lttng_channel
*chan
)
931 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
936 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
937 struct lttng_event
*event
);
942 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
943 struct lttng_event
*event
);
948 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
949 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
954 static inline int lttng_syscalls_register_event_notifier(
955 struct lttng_event_notifier_group
*group
, void *filter
)
960 static inline int lttng_syscalls_unregister_event_notifier_group(
961 struct lttng_event_notifier_group
*group
)
966 static inline int lttng_syscall_filter_enable_event_notifier(
967 struct lttng_event_notifier_group
*group
,
973 static inline int lttng_syscall_filter_disable_event_notifier(
974 struct lttng_event_notifier_group
*group
,
982 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
983 struct lttng_kernel_filter_bytecode __user
*bytecode
);
984 int lttng_event_notifier_enabler_attach_filter_bytecode(
985 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
986 struct lttng_kernel_filter_bytecode __user
*bytecode
);
987 int lttng_event_notifier_enabler_attach_capture_bytecode(
988 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
989 struct lttng_kernel_capture_bytecode __user
*bytecode
);
991 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
992 struct lttng_ctx
*ctx
,
993 struct list_head
*instance_bytecode_runtime_head
,
994 struct list_head
*enabler_bytecode_runtime_head
);
995 void lttng_free_event_filter_runtime(struct lttng_event
*event
);
996 void lttng_free_event_notifier_filter_runtime(struct lttng_event_notifier
*event_notifier
);
998 int lttng_probes_init(void);
1000 extern struct lttng_ctx
*lttng_static_ctx
;
1002 int lttng_context_init(void);
1003 void lttng_context_exit(void);
1004 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
1005 ssize_t
lttng_append_context_index(struct lttng_ctx
**ctx_p
);
1006 struct lttng_ctx_field
*lttng_get_context_field_from_index(struct lttng_ctx
*ctx
,
1008 void lttng_context_update(struct lttng_ctx
*ctx
);
1009 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
1010 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
1011 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
1012 struct lttng_ctx_field
*field
);
1013 void lttng_remove_context_field_index(struct lttng_ctx
**ctx_p
, size_t index
);
1014 void lttng_destroy_context(struct lttng_ctx
*ctx
);
1015 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
1016 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
1017 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
1018 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
1019 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
1020 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
1021 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
1022 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
1023 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
1024 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
1025 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
1026 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
1027 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
1028 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
1029 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
1032 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
1037 #ifdef CONFIG_PREEMPT_RT_FULL
1038 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
1041 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
1047 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
1049 #if defined(CONFIG_CGROUPS) && \
1050 ((LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,6,0)) || \
1051 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
1052 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
1055 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
1061 #if defined(CONFIG_IPC_NS) && \
1062 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1063 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
1066 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
1072 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
1073 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1074 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
1077 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
1083 #if defined(CONFIG_NET_NS) && \
1084 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1085 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
1088 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
1094 #if defined(CONFIG_PID_NS) && \
1095 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1096 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
1099 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
1105 #if defined(CONFIG_USER_NS) && \
1106 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1107 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
1110 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
1116 #if defined(CONFIG_UTS_NS) && \
1117 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1118 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
1121 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
1127 #if defined(CONFIG_TIME_NS) && \
1128 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,6,0))
1129 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
);
1132 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
)
1138 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
1139 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
1140 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
1141 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
1142 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
1143 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
1144 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
1145 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
1146 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
1147 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
1148 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
1149 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
1151 #if defined(CONFIG_PERF_EVENTS)
1152 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1155 struct lttng_ctx
**ctx
);
1156 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1157 struct lttng_cpuhp_node
*node
);
1158 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1159 struct lttng_cpuhp_node
*node
);
1162 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1165 struct lttng_ctx
**ctx
)
1170 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1171 struct lttng_cpuhp_node
*node
)
1176 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1177 struct lttng_cpuhp_node
*node
)
1183 int lttng_logger_init(void);
1184 void lttng_logger_exit(void);
1186 extern int lttng_statedump_start(struct lttng_session
*session
);
1188 #ifdef CONFIG_KPROBES
1189 int lttng_kprobes_register_event(const char *name
,
1190 const char *symbol_name
,
1193 struct lttng_event
*event
);
1194 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1195 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1196 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1199 struct lttng_event_notifier
*event_notifier
);
1200 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1201 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1204 int lttng_kprobes_register_event(const char *name
,
1205 const char *symbol_name
,
1208 struct lttng_event
*event
)
1214 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1219 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1224 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1227 struct lttng_event_notifier
*event_notifier
)
1233 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1238 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1243 int lttng_event_add_callsite(struct lttng_event
*event
,
1244 struct lttng_kernel_event_callsite
*callsite
);
1246 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1247 struct lttng_kernel_event_callsite
*callsite
);
1249 #ifdef CONFIG_UPROBES
1250 int lttng_uprobes_register_event(const char *name
,
1251 int fd
, struct lttng_event
*event
);
1252 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1253 struct lttng_kernel_event_callsite
*callsite
);
1254 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1255 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1256 int lttng_uprobes_register_event_notifier(const char *name
,
1257 int fd
, struct lttng_event_notifier
*event_notifier
);
1258 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1259 struct lttng_kernel_event_callsite
*callsite
);
1260 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1261 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1264 int lttng_uprobes_register_event(const char *name
,
1265 int fd
, struct lttng_event
*event
)
1271 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1272 struct lttng_kernel_event_callsite
*callsite
)
1278 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1283 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1288 int lttng_uprobes_register_event_notifier(const char *name
,
1289 int fd
, struct lttng_event_notifier
*event_notifier
)
1295 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1296 struct lttng_kernel_event_callsite
*callsite
)
1302 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1307 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1312 #ifdef CONFIG_KRETPROBES
1313 int lttng_kretprobes_register(const char *name
,
1314 const char *symbol_name
,
1317 struct lttng_event
*event_entry
,
1318 struct lttng_event
*event_exit
);
1319 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1320 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1321 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1325 int lttng_kretprobes_register(const char *name
,
1326 const char *symbol_name
,
1329 struct lttng_event
*event_entry
,
1330 struct lttng_event
*event_exit
)
1336 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1341 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1346 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1353 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1355 extern const struct file_operations lttng_tracepoint_list_fops
;
1356 extern const struct file_operations lttng_syscall_list_fops
;
1358 #define TRACEPOINT_HAS_DATA_ARG
1360 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1362 if (type
->atype
!= atype_integer
)
1364 switch (type
->u
.integer
.size
) {
1365 case 8: /* Fall-through. */
1366 case 16: /* Fall-through. */
1367 case 32: /* Fall-through. */
1376 #endif /* _LTTNG_EVENTS_H */