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 <linux/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)) < 0)
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 (LINUX_VERSION_CODE >= 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
,
239 struct lttng_bytecode_node
{
240 enum lttng_bytecode_node_type type
;
241 struct list_head node
;
242 struct lttng_enabler
*enabler
;
245 uint32_t reloc_offset
;
252 * Bytecode interpreter return value masks.
254 enum lttng_bytecode_interpreter_ret
{
255 LTTNG_INTERPRETER_DISCARD
= 0,
256 LTTNG_INTERPRETER_RECORD_FLAG
= (1ULL << 0),
257 /* Other bits are kept for future use. */
260 struct lttng_bytecode_runtime
{
261 /* Associated bytecode */
262 struct lttng_bytecode_node
*bc
;
264 uint64_t (*filter
)(void *filter_data
,
265 struct lttng_probe_ctx
*lttng_probe_ctx
,
266 const char *filter_stack_data
);
269 struct list_head node
; /* list of bytecode runtime in event */
270 struct lttng_ctx
*ctx
;
274 * Objects in a linked-list of enablers, owned by an event.
276 struct lttng_enabler_ref
{
277 struct list_head node
; /* enabler ref list */
278 struct lttng_enabler
*ref
; /* backward ref */
281 struct lttng_uprobe_handler
{
283 struct lttng_event
*event
;
284 struct lttng_event_notifier
*event_notifier
;
287 struct uprobe_consumer up_consumer
;
288 struct list_head node
;
291 struct lttng_kprobe
{
296 struct lttng_uprobe
{
298 struct list_head head
;
301 enum lttng_syscall_entryexit
{
306 enum lttng_syscall_abi
{
307 LTTNG_SYSCALL_ABI_NATIVE
,
308 LTTNG_SYSCALL_ABI_COMPAT
,
312 * lttng_event structure is referred to by the tracing fast path. It must be
316 enum lttng_event_type evtype
; /* First field. */
318 struct lttng_channel
*chan
;
320 const struct lttng_event_desc
*desc
;
322 struct lttng_ctx
*ctx
;
323 enum lttng_kernel_instrumentation instrumentation
;
325 struct lttng_kprobe kprobe
;
327 struct lttng_krp
*lttng_krp
;
330 struct lttng_uprobe uprobe
;
332 enum lttng_syscall_entryexit entryexit
;
333 enum lttng_syscall_abi abi
;
336 struct list_head list
; /* Event list in session */
337 unsigned int metadata_dumped
:1;
339 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
340 struct list_head enablers_ref_head
;
341 struct hlist_node hlist
; /* session ht of events */
342 int registered
; /* has reg'd tracepoint probe */
343 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
344 struct list_head filter_bytecode_runtime_head
;
345 int has_enablers_without_bytecode
;
348 // FIXME: Really similar to lttng_event above. Could those be merged ?
349 struct lttng_event_notifier
{
350 enum lttng_event_type evtype
; /* First field. */
353 int registered
; /* has reg'd tracepoint probe */
354 const struct lttng_event_desc
*desc
;
356 struct list_head list
; /* event_notifier list in event_notifier group */
358 enum lttng_kernel_instrumentation instrumentation
;
360 struct lttng_kprobe kprobe
;
361 struct lttng_uprobe uprobe
;
363 enum lttng_syscall_entryexit entryexit
;
364 enum lttng_syscall_abi abi
;
365 struct hlist_node node
; /* chain registered syscall event_notifier */
366 unsigned int syscall_id
;
371 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
372 struct list_head enablers_ref_head
;
373 struct hlist_node hlist
; /* session ht of event_notifiers */
374 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
375 struct list_head filter_bytecode_runtime_head
;
376 int has_enablers_without_bytecode
;
378 void (*send_notification
)(struct lttng_event_notifier
*event_notifier
);
379 struct lttng_event_notifier_group
*group
; /* Weak ref */
382 enum lttng_enabler_format_type
{
383 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
384 LTTNG_ENABLER_FORMAT_NAME
,
388 * Enabler field, within whatever object is enabling an event. Target of
389 * backward reference.
391 struct lttng_enabler
{
392 enum lttng_event_type evtype
; /* First field. */
394 enum lttng_enabler_format_type format_type
;
396 /* head list of struct lttng_ust_filter_bytecode_node */
397 struct list_head filter_bytecode_head
;
399 struct lttng_kernel_event event_param
;
400 unsigned int enabled
:1;
402 uint64_t user_token
; /* User-provided token. */
405 struct lttng_event_enabler
{
406 struct lttng_enabler base
;
407 struct list_head node
; /* per-session list of enablers */
408 struct lttng_channel
*chan
;
410 * Unused, but kept around to make it explicit that the tracer can do
413 struct lttng_ctx
*ctx
;
416 struct lttng_event_notifier_enabler
{
417 struct lttng_enabler base
;
418 struct list_head node
; /* List of event_notifier enablers */
419 struct lttng_event_notifier_group
*group
;
423 struct lttng_enabler
*lttng_event_enabler_as_enabler(
424 struct lttng_event_enabler
*event_enabler
)
426 return &event_enabler
->base
;
430 struct lttng_enabler
*lttng_event_notifier_enabler_as_enabler(
431 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
433 return &event_notifier_enabler
->base
;
436 struct lttng_channel_ops
{
437 struct channel
*(*channel_create
)(const char *name
,
440 size_t subbuf_size
, size_t num_subbuf
,
441 unsigned int switch_timer_interval
,
442 unsigned int read_timer_interval
);
443 void (*channel_destroy
)(struct channel
*chan
);
444 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
445 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
446 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
447 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
449 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
450 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
452 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
453 const void *src
, size_t len
);
454 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
456 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
458 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
459 const char __user
*src
, size_t len
);
461 * packet_avail_size returns the available size in the current
462 * packet. Note that the size returned is only a hint, since it
463 * may change due to concurrent writes.
465 size_t (*packet_avail_size
)(struct channel
*chan
);
466 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
467 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
468 int (*is_finalized
)(struct channel
*chan
);
469 int (*is_disabled
)(struct channel
*chan
);
470 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
471 struct lib_ring_buffer
*bufb
,
472 uint64_t *timestamp_begin
);
473 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
474 struct lib_ring_buffer
*bufb
,
475 uint64_t *timestamp_end
);
476 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
477 struct lib_ring_buffer
*bufb
,
478 uint64_t *events_discarded
);
479 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
480 struct lib_ring_buffer
*bufb
,
481 uint64_t *content_size
);
482 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
483 struct lib_ring_buffer
*bufb
,
484 uint64_t *packet_size
);
485 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
486 struct lib_ring_buffer
*bufb
,
487 uint64_t *stream_id
);
488 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
489 struct lib_ring_buffer
*bufb
,
491 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
492 struct lib_ring_buffer
*bufb
,
494 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
495 struct lib_ring_buffer
*bufb
,
499 struct lttng_transport
{
501 struct module
*owner
;
502 struct list_head node
;
503 struct lttng_channel_ops ops
;
506 struct lttng_syscall_filter
;
508 #define LTTNG_EVENT_HT_BITS 12
509 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
511 struct lttng_event_ht
{
512 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
515 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
516 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
518 struct lttng_event_notifier_ht
{
519 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
522 struct lttng_channel
{
524 struct channel
*chan
; /* Channel buffers */
526 struct lttng_ctx
*ctx
;
527 /* Event ID management */
528 struct lttng_session
*session
;
529 struct file
*file
; /* File associated to channel */
530 unsigned int free_event_id
; /* Next event ID to allocate */
531 struct list_head list
; /* Channel list */
532 struct lttng_channel_ops
*ops
;
533 struct lttng_transport
*transport
;
534 struct lttng_event
**sc_table
; /* for syscall tracing */
535 struct lttng_event
**compat_sc_table
;
536 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
537 struct lttng_event
**compat_sc_exit_table
;
538 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
539 struct lttng_event
*sc_compat_unknown
;
540 struct lttng_event
*sc_exit_unknown
;
541 struct lttng_event
*compat_sc_exit_unknown
;
542 struct lttng_syscall_filter
*sc_filter
;
543 int header_type
; /* 0: unset, 1: compact, 2: large */
544 enum channel_type channel_type
;
546 unsigned int metadata_dumped
:1,
547 sys_enter_registered
:1,
548 sys_exit_registered
:1,
549 tstate
:1; /* Transient enable state */
552 struct lttng_metadata_stream
{
553 void *priv
; /* Ring buffer private data */
554 struct lttng_metadata_cache
*metadata_cache
;
555 unsigned int metadata_in
; /* Bytes read from the cache */
556 unsigned int metadata_out
; /* Bytes consumed from stream */
557 int finalized
; /* Has channel been finalized */
558 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
559 struct list_head list
; /* Stream list */
560 struct lttng_transport
*transport
;
561 uint64_t version
; /* Current version of the metadata cache */
562 bool coherent
; /* Stream in a coherent state */
565 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
567 struct lttng_dynamic_len_stack
{
568 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
572 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
575 * struct lttng_id_tracker declared in header due to deferencing of *v
576 * in RCU_INITIALIZER(v).
578 #define LTTNG_ID_HASH_BITS 6
579 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
592 struct lttng_id_tracker_rcu
{
593 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
596 struct lttng_id_tracker
{
597 struct lttng_session
*session
;
598 enum tracker_type tracker_type
;
599 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
602 struct lttng_id_hash_node
{
603 struct hlist_node hlist
;
607 struct lttng_session
{
608 int active
; /* Is trace session active ? */
609 int been_active
; /* Has trace session been active ? */
610 struct file
*file
; /* File associated to session */
611 struct list_head chan
; /* Channel list head */
612 struct list_head events
; /* Event list head */
613 struct list_head list
; /* Session list */
614 unsigned int free_chan_id
; /* Next chan ID to allocate */
615 uuid_le uuid
; /* Trace session unique ID */
616 struct lttng_metadata_cache
*metadata_cache
;
617 struct lttng_id_tracker pid_tracker
;
618 struct lttng_id_tracker vpid_tracker
;
619 struct lttng_id_tracker uid_tracker
;
620 struct lttng_id_tracker vuid_tracker
;
621 struct lttng_id_tracker gid_tracker
;
622 struct lttng_id_tracker vgid_tracker
;
623 unsigned int metadata_dumped
:1,
624 tstate
:1; /* Transient enable state */
625 /* List of event enablers */
626 struct list_head enablers_head
;
627 /* Hash table of events */
628 struct lttng_event_ht events_ht
;
629 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
630 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
633 struct lttng_event_notifier_group
{
634 struct file
*file
; /* File associated to event notifier group */
635 struct file
*notif_file
; /* File used to expose notifications to userspace. */
636 struct list_head node
; /* event notifier group list */
637 struct list_head enablers_head
; /* List of enablers */
638 struct list_head event_notifiers_head
; /* List of event notifier */
639 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
640 struct lttng_ctx
*ctx
; /* Contexts for filters. */
641 struct lttng_channel_ops
*ops
;
642 struct lttng_transport
*transport
;
643 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
644 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
645 wait_queue_head_t read_wait
;
646 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
647 struct lttng_event_notifier
*sc_unknown
; /* for unknown syscalls */
648 struct lttng_event_notifier
*sc_compat_unknown
;
650 struct lttng_syscall_filter
*sc_filter
;
652 struct hlist_head
*event_notifier_syscall_dispatch
;
653 struct hlist_head
*event_notifier_compat_syscall_dispatch
;
654 struct hlist_head
*event_notifier_exit_syscall_dispatch
;
655 struct hlist_head
*event_notifier_exit_compat_syscall_dispatch
;
657 struct hlist_head event_notifier_unknown_syscall_dispatch
;
658 struct hlist_head event_notifier_compat_unknown_syscall_dispatch
;
659 struct hlist_head event_notifier_exit_unknown_syscall_dispatch
;
660 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch
;
662 int syscall_all_entry
;
663 int syscall_all_exit
;
665 unsigned int sys_enter_registered
:1, sys_exit_registered
:1;
667 struct lttng_counter
*error_counter
;
668 size_t error_counter_len
;
671 struct lttng_metadata_cache
{
672 char *data
; /* Metadata cache */
673 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
674 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
675 atomic_t producing
; /* Metadata being produced (incomplete) */
676 struct kref refcount
; /* Metadata cache usage */
677 struct list_head metadata_stream
; /* Metadata stream list */
678 uuid_le uuid
; /* Trace session unique ID (copy) */
679 struct mutex lock
; /* Produce/consume lock */
680 uint64_t version
; /* Current version of the metadata */
683 void lttng_lock_sessions(void);
684 void lttng_unlock_sessions(void);
686 struct list_head
*lttng_get_probe_list_head(void);
688 struct lttng_event_enabler
*lttng_event_enabler_create(
689 enum lttng_enabler_format_type format_type
,
690 struct lttng_kernel_event
*event_param
,
691 struct lttng_channel
*chan
);
693 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
694 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
695 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
696 struct lttng_event_notifier_group
*event_notifier_group
,
697 enum lttng_enabler_format_type format_type
,
698 struct lttng_kernel_event_notifier
*event_notifier_param
);
700 int lttng_event_notifier_enabler_enable(
701 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
702 int lttng_event_notifier_enabler_disable(
703 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
704 int lttng_fix_pending_events(void);
705 int lttng_fix_pending_event_notifiers(void);
706 int lttng_session_active(void);
707 bool lttng_event_notifier_active(void);
709 struct lttng_session
*lttng_session_create(void);
710 int lttng_session_enable(struct lttng_session
*session
);
711 int lttng_session_disable(struct lttng_session
*session
);
712 void lttng_session_destroy(struct lttng_session
*session
);
713 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
714 int lttng_session_statedump(struct lttng_session
*session
);
715 void metadata_cache_destroy(struct kref
*kref
);
717 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
718 void lttng_event_notifier_group_destroy(
719 struct lttng_event_notifier_group
*event_notifier_group
);
721 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
722 const char *transport_name
,
724 size_t subbuf_size
, size_t num_subbuf
,
725 unsigned int switch_timer_interval
,
726 unsigned int read_timer_interval
,
727 enum channel_type channel_type
);
728 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
729 int overwrite
, void *buf_addr
,
730 size_t subbuf_size
, size_t num_subbuf
,
731 unsigned int switch_timer_interval
,
732 unsigned int read_timer_interval
);
734 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
735 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
736 struct lttng_kernel_event
*event_param
,
738 const struct lttng_event_desc
*event_desc
,
739 enum lttng_kernel_instrumentation itype
);
740 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
741 struct lttng_kernel_event
*event_param
,
743 const struct lttng_event_desc
*event_desc
,
744 enum lttng_kernel_instrumentation itype
);
745 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
746 struct lttng_kernel_old_event
*old_event_param
,
748 const struct lttng_event_desc
*internal_desc
);
750 struct lttng_event_notifier
*lttng_event_notifier_create(
751 const struct lttng_event_desc
*event_notifier_desc
,
753 struct lttng_event_notifier_group
*event_notifier_group
,
754 struct lttng_kernel_event_notifier
*event_notifier_param
,
756 enum lttng_kernel_instrumentation itype
);
757 struct lttng_event_notifier
*_lttng_event_notifier_create(
758 const struct lttng_event_desc
*event_notifier_desc
,
760 struct lttng_event_notifier_group
*event_notifier_group
,
761 struct lttng_kernel_event_notifier
*event_notifier_param
,
763 enum lttng_kernel_instrumentation itype
);
765 int lttng_channel_enable(struct lttng_channel
*channel
);
766 int lttng_channel_disable(struct lttng_channel
*channel
);
767 int lttng_event_enable(struct lttng_event
*event
);
768 int lttng_event_disable(struct lttng_event
*event
);
770 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
);
771 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
);
773 void lttng_transport_register(struct lttng_transport
*transport
);
774 void lttng_transport_unregister(struct lttng_transport
*transport
);
776 void synchronize_trace(void);
777 int lttng_abi_init(void);
778 int lttng_abi_compat_old_init(void);
779 void lttng_abi_exit(void);
780 void lttng_abi_compat_old_exit(void);
782 int lttng_probe_register(struct lttng_probe_desc
*desc
);
783 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
784 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
785 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
786 int lttng_probes_init(void);
787 void lttng_probes_exit(void);
789 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
790 struct channel
*chan
, bool *coherent
);
792 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
793 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
794 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
795 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
796 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
797 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
799 int lttng_session_track_id(struct lttng_session
*session
,
800 enum tracker_type tracker_type
, int id
);
801 int lttng_session_untrack_id(struct lttng_session
*session
,
802 enum tracker_type tracker_type
, int id
);
804 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
805 enum tracker_type tracker_type
);
807 void lttng_clock_ref(void);
808 void lttng_clock_unref(void);
810 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
811 struct lttng_enabler
*enabler
);
813 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
814 int lttng_syscalls_register_event(struct lttng_channel
*chan
, void *filter
);
815 int lttng_syscalls_unregister_event(struct lttng_channel
*chan
);
816 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
817 int lttng_syscall_filter_enable_event(
818 struct lttng_channel
*chan
,
819 struct lttng_event
*event
);
820 int lttng_syscall_filter_disable_event(
821 struct lttng_channel
*chan
,
822 struct lttng_event
*event
);
824 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
825 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
827 int lttng_syscalls_register_event_notifier(
828 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
830 int lttng_syscals_create_matching_event_notifiers(
831 struct lttng_event_notifier_enabler
*event_notifier_enabler
, void *filter
);
832 int lttng_syscalls_unregister_event_notifier(struct lttng_event_notifier_group
*group
);
833 int lttng_syscall_filter_enable_event_notifier(struct lttng_event_notifier
*event_notifier
);
834 int lttng_syscall_filter_disable_event_notifier(struct lttng_event_notifier
*event_notifier
);
836 static inline int lttng_syscalls_register_event(
837 struct lttng_channel
*chan
, void *filter
)
842 static inline int lttng_syscalls_unregister_event(struct lttng_channel
*chan
)
847 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
852 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
853 struct lttng_event
*event
);
858 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
859 struct lttng_event
*event
);
864 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
865 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
870 static inline int lttng_syscalls_register_event_notifier(
871 struct lttng_event_notifier_group
*group
, void *filter
)
876 static inline int lttng_syscalls_unregister_event_notifier(
877 struct lttng_event_notifier_group
*group
)
882 static inline int lttng_syscall_filter_enable_event_notifier(
883 struct lttng_event_notifier_group
*group
,
889 static inline int lttng_syscall_filter_disable_event_notifier(
890 struct lttng_event_notifier_group
*group
,
898 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
899 struct lttng_kernel_filter_bytecode __user
*bytecode
);
900 int lttng_event_notifier_enabler_attach_filter_bytecode(
901 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
902 struct lttng_kernel_filter_bytecode __user
*bytecode
);
904 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
905 struct lttng_ctx
*ctx
,
906 struct list_head
*instance_bytecode_runtime_head
,
907 struct list_head
*enabler_bytecode_runtime_head
);
909 int lttng_probes_init(void);
911 extern struct lttng_ctx
*lttng_static_ctx
;
913 int lttng_context_init(void);
914 void lttng_context_exit(void);
915 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
916 ssize_t
lttng_append_context_index(struct lttng_ctx
**ctx_p
);
917 struct lttng_ctx_field
*lttng_get_context_field_from_index(struct lttng_ctx
*ctx
,
919 void lttng_context_update(struct lttng_ctx
*ctx
);
920 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
921 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
922 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
923 struct lttng_ctx_field
*field
);
924 void lttng_remove_context_field_index(struct lttng_ctx
**ctx_p
, size_t index
);
925 void lttng_destroy_context(struct lttng_ctx
*ctx
);
926 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
927 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
928 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
929 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
930 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
931 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
932 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
933 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
934 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
935 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
936 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
937 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
938 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
939 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
940 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
943 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
948 #ifdef CONFIG_PREEMPT_RT_FULL
949 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
952 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
958 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
960 #if defined(CONFIG_CGROUPS) && \
961 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
962 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
963 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
966 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
972 #if defined(CONFIG_IPC_NS) && \
973 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
974 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
977 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
983 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
984 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
985 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
988 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
994 #if defined(CONFIG_NET_NS) && \
995 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
996 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
999 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
1005 #if defined(CONFIG_PID_NS) && \
1006 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1007 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
1010 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
1016 #if defined(CONFIG_USER_NS) && \
1017 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1018 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
1021 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
1027 #if defined(CONFIG_UTS_NS) && \
1028 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1029 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
1032 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
1038 #if defined(CONFIG_TIME_NS) && \
1039 (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
1040 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
);
1043 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
)
1049 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
1050 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
1051 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
1052 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
1053 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
1054 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
1055 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
1056 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
1057 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
1058 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
1059 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
1060 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
1062 #if defined(CONFIG_PERF_EVENTS)
1063 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1066 struct lttng_ctx
**ctx
);
1067 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1068 struct lttng_cpuhp_node
*node
);
1069 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1070 struct lttng_cpuhp_node
*node
);
1073 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1076 struct lttng_ctx
**ctx
)
1081 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1082 struct lttng_cpuhp_node
*node
)
1087 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1088 struct lttng_cpuhp_node
*node
)
1094 int lttng_logger_init(void);
1095 void lttng_logger_exit(void);
1097 extern int lttng_statedump_start(struct lttng_session
*session
);
1099 #ifdef CONFIG_KPROBES
1100 int lttng_kprobes_register_event(const char *name
,
1101 const char *symbol_name
,
1104 struct lttng_event
*event
);
1105 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1106 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1107 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1110 struct lttng_event_notifier
*event_notifier
);
1111 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1112 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1115 int lttng_kprobes_register_event(const char *name
,
1116 const char *symbol_name
,
1119 struct lttng_event
*event
)
1125 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1130 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1135 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1138 struct lttng_event_notifier
*event_notifier
)
1144 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1149 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1154 int lttng_event_add_callsite(struct lttng_event
*event
,
1155 struct lttng_kernel_event_callsite
*callsite
);
1157 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1158 struct lttng_kernel_event_callsite
*callsite
);
1160 #ifdef CONFIG_UPROBES
1161 int lttng_uprobes_register_event(const char *name
,
1162 int fd
, struct lttng_event
*event
);
1163 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1164 struct lttng_kernel_event_callsite
*callsite
);
1165 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1166 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1167 int lttng_uprobes_register_event_notifier(const char *name
,
1168 int fd
, struct lttng_event_notifier
*event_notifier
);
1169 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1170 struct lttng_kernel_event_callsite
*callsite
);
1171 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1172 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1175 int lttng_uprobes_register_event(const char *name
,
1176 int fd
, struct lttng_event
*event
)
1182 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1183 struct lttng_kernel_event_callsite
*callsite
)
1189 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1194 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1199 int lttng_uprobes_register_event_notifier(const char *name
,
1200 int fd
, struct lttng_event_notifier
*event_notifier
)
1206 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1207 struct lttng_kernel_event_callsite
*callsite
)
1213 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1218 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1223 #ifdef CONFIG_KRETPROBES
1224 int lttng_kretprobes_register(const char *name
,
1225 const char *symbol_name
,
1228 struct lttng_event
*event_entry
,
1229 struct lttng_event
*event_exit
);
1230 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1231 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1232 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1236 int lttng_kretprobes_register(const char *name
,
1237 const char *symbol_name
,
1240 struct lttng_event
*event_entry
,
1241 struct lttng_event
*event_exit
)
1247 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1252 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1257 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1264 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1266 extern const struct file_operations lttng_tracepoint_list_fops
;
1267 extern const struct file_operations lttng_syscall_list_fops
;
1269 #define TRACEPOINT_HAS_DATA_ARG
1271 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1273 if (type
->atype
!= atype_integer
)
1275 switch (type
->u
.integer
.size
) {
1276 case 8: /* Fall-through. */
1277 case 16: /* Fall-through. */
1278 case 32: /* Fall-through. */
1287 #endif /* _LTTNG_EVENTS_H */