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 * Filter return value masks.
254 enum lttng_filter_ret
{
255 LTTNG_FILTER_DISCARD
= 0,
256 LTTNG_FILTER_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
;
263 uint64_t (*filter
)(void *filter_data
,
264 struct lttng_probe_ctx
*lttng_probe_ctx
,
265 const char *filter_stack_data
);
267 struct list_head node
; /* list of bytecode runtime in event */
268 struct lttng_ctx
*ctx
;
272 * Objects in a linked-list of enablers, owned by an event.
274 struct lttng_enabler_ref
{
275 struct list_head node
; /* enabler ref list */
276 struct lttng_enabler
*ref
; /* backward ref */
279 struct lttng_uprobe_handler
{
281 struct lttng_event
*event
;
282 struct lttng_event_notifier
*event_notifier
;
285 struct uprobe_consumer up_consumer
;
286 struct list_head node
;
289 struct lttng_kprobe
{
294 struct lttng_uprobe
{
296 struct list_head head
;
299 enum lttng_syscall_entryexit
{
304 enum lttng_syscall_abi
{
305 LTTNG_SYSCALL_ABI_NATIVE
,
306 LTTNG_SYSCALL_ABI_COMPAT
,
310 * lttng_event structure is referred to by the tracing fast path. It must be
314 enum lttng_event_type evtype
; /* First field. */
316 struct lttng_channel
*chan
;
318 const struct lttng_event_desc
*desc
;
320 struct lttng_ctx
*ctx
;
321 enum lttng_kernel_instrumentation instrumentation
;
323 struct lttng_kprobe kprobe
;
325 struct lttng_krp
*lttng_krp
;
328 struct lttng_uprobe uprobe
;
330 enum lttng_syscall_entryexit entryexit
;
331 enum lttng_syscall_abi abi
;
334 struct list_head list
; /* Event list in session */
335 unsigned int metadata_dumped
:1;
337 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
338 struct list_head enablers_ref_head
;
339 struct hlist_node hlist
; /* session ht of events */
340 int registered
; /* has reg'd tracepoint probe */
341 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
342 struct list_head filter_bytecode_runtime_head
;
343 int has_enablers_without_bytecode
;
346 // FIXME: Really similar to lttng_event above. Could those be merged ?
347 struct lttng_event_notifier
{
348 enum lttng_event_type evtype
; /* First field. */
351 int registered
; /* has reg'd tracepoint probe */
352 const struct lttng_event_desc
*desc
;
354 struct list_head list
; /* event_notifier list in event_notifier group */
356 enum lttng_kernel_instrumentation instrumentation
;
358 struct lttng_kprobe kprobe
;
359 struct lttng_uprobe uprobe
;
361 enum lttng_syscall_entryexit entryexit
;
362 enum lttng_syscall_abi abi
;
363 struct hlist_node node
; /* chain registered syscall event_notifier */
364 unsigned int syscall_id
;
369 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
370 struct list_head enablers_ref_head
;
371 struct hlist_node hlist
; /* session ht of event_notifiers */
372 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
373 struct list_head filter_bytecode_runtime_head
;
374 int has_enablers_without_bytecode
;
376 void (*send_notification
)(struct lttng_event_notifier
*event_notifier
);
377 struct lttng_event_notifier_group
*group
; /* Weak ref */
380 enum lttng_enabler_format_type
{
381 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
382 LTTNG_ENABLER_FORMAT_NAME
,
386 * Enabler field, within whatever object is enabling an event. Target of
387 * backward reference.
389 struct lttng_enabler
{
390 enum lttng_event_type evtype
; /* First field. */
392 enum lttng_enabler_format_type format_type
;
394 /* head list of struct lttng_ust_filter_bytecode_node */
395 struct list_head filter_bytecode_head
;
397 struct lttng_kernel_event event_param
;
398 unsigned int enabled
:1;
400 uint64_t user_token
; /* User-provided token. */
403 struct lttng_event_enabler
{
404 struct lttng_enabler base
;
405 struct list_head node
; /* per-session list of enablers */
406 struct lttng_channel
*chan
;
408 * Unused, but kept around to make it explicit that the tracer can do
411 struct lttng_ctx
*ctx
;
414 struct lttng_event_notifier_enabler
{
415 struct lttng_enabler base
;
416 struct list_head node
; /* List of event_notifier enablers */
417 struct lttng_event_notifier_group
*group
;
421 struct lttng_enabler
*lttng_event_enabler_as_enabler(
422 struct lttng_event_enabler
*event_enabler
)
424 return &event_enabler
->base
;
428 struct lttng_enabler
*lttng_event_notifier_enabler_as_enabler(
429 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
431 return &event_notifier_enabler
->base
;
434 struct lttng_channel_ops
{
435 struct channel
*(*channel_create
)(const char *name
,
438 size_t subbuf_size
, size_t num_subbuf
,
439 unsigned int switch_timer_interval
,
440 unsigned int read_timer_interval
);
441 void (*channel_destroy
)(struct channel
*chan
);
442 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
443 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
444 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
445 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
447 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
448 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
450 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
451 const void *src
, size_t len
);
452 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
454 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
456 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
457 const char __user
*src
, size_t len
);
459 * packet_avail_size returns the available size in the current
460 * packet. Note that the size returned is only a hint, since it
461 * may change due to concurrent writes.
463 size_t (*packet_avail_size
)(struct channel
*chan
);
464 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
465 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
466 int (*is_finalized
)(struct channel
*chan
);
467 int (*is_disabled
)(struct channel
*chan
);
468 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
469 struct lib_ring_buffer
*bufb
,
470 uint64_t *timestamp_begin
);
471 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
472 struct lib_ring_buffer
*bufb
,
473 uint64_t *timestamp_end
);
474 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
475 struct lib_ring_buffer
*bufb
,
476 uint64_t *events_discarded
);
477 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
478 struct lib_ring_buffer
*bufb
,
479 uint64_t *content_size
);
480 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
481 struct lib_ring_buffer
*bufb
,
482 uint64_t *packet_size
);
483 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
484 struct lib_ring_buffer
*bufb
,
485 uint64_t *stream_id
);
486 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
487 struct lib_ring_buffer
*bufb
,
489 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
490 struct lib_ring_buffer
*bufb
,
492 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
493 struct lib_ring_buffer
*bufb
,
497 struct lttng_transport
{
499 struct module
*owner
;
500 struct list_head node
;
501 struct lttng_channel_ops ops
;
504 struct lttng_syscall_filter
;
506 #define LTTNG_EVENT_HT_BITS 12
507 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
509 struct lttng_event_ht
{
510 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
513 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
514 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
516 struct lttng_event_notifier_ht
{
517 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
520 struct lttng_channel
{
522 struct channel
*chan
; /* Channel buffers */
524 struct lttng_ctx
*ctx
;
525 /* Event ID management */
526 struct lttng_session
*session
;
527 struct file
*file
; /* File associated to channel */
528 unsigned int free_event_id
; /* Next event ID to allocate */
529 struct list_head list
; /* Channel list */
530 struct lttng_channel_ops
*ops
;
531 struct lttng_transport
*transport
;
532 struct lttng_event
**sc_table
; /* for syscall tracing */
533 struct lttng_event
**compat_sc_table
;
534 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
535 struct lttng_event
**compat_sc_exit_table
;
536 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
537 struct lttng_event
*sc_compat_unknown
;
538 struct lttng_event
*sc_exit_unknown
;
539 struct lttng_event
*compat_sc_exit_unknown
;
540 struct lttng_syscall_filter
*sc_filter
;
541 int header_type
; /* 0: unset, 1: compact, 2: large */
542 enum channel_type channel_type
;
544 unsigned int metadata_dumped
:1,
545 sys_enter_registered
:1,
546 sys_exit_registered
:1,
547 tstate
:1; /* Transient enable state */
550 struct lttng_metadata_stream
{
551 void *priv
; /* Ring buffer private data */
552 struct lttng_metadata_cache
*metadata_cache
;
553 unsigned int metadata_in
; /* Bytes read from the cache */
554 unsigned int metadata_out
; /* Bytes consumed from stream */
555 int finalized
; /* Has channel been finalized */
556 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
557 struct list_head list
; /* Stream list */
558 struct lttng_transport
*transport
;
559 uint64_t version
; /* Current version of the metadata cache */
560 bool coherent
; /* Stream in a coherent state */
563 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
565 struct lttng_dynamic_len_stack
{
566 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
570 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
573 * struct lttng_id_tracker declared in header due to deferencing of *v
574 * in RCU_INITIALIZER(v).
576 #define LTTNG_ID_HASH_BITS 6
577 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
590 struct lttng_id_tracker_rcu
{
591 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
594 struct lttng_id_tracker
{
595 struct lttng_session
*session
;
596 enum tracker_type tracker_type
;
597 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
600 struct lttng_id_hash_node
{
601 struct hlist_node hlist
;
605 struct lttng_session
{
606 int active
; /* Is trace session active ? */
607 int been_active
; /* Has trace session been active ? */
608 struct file
*file
; /* File associated to session */
609 struct list_head chan
; /* Channel list head */
610 struct list_head events
; /* Event list head */
611 struct list_head list
; /* Session list */
612 unsigned int free_chan_id
; /* Next chan ID to allocate */
613 uuid_le uuid
; /* Trace session unique ID */
614 struct lttng_metadata_cache
*metadata_cache
;
615 struct lttng_id_tracker pid_tracker
;
616 struct lttng_id_tracker vpid_tracker
;
617 struct lttng_id_tracker uid_tracker
;
618 struct lttng_id_tracker vuid_tracker
;
619 struct lttng_id_tracker gid_tracker
;
620 struct lttng_id_tracker vgid_tracker
;
621 unsigned int metadata_dumped
:1,
622 tstate
:1; /* Transient enable state */
623 /* List of event enablers */
624 struct list_head enablers_head
;
625 /* Hash table of events */
626 struct lttng_event_ht events_ht
;
627 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
628 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
631 struct lttng_event_notifier_group
{
632 struct file
*file
; /* File associated to event notifier group */
633 struct file
*notif_file
; /* File used to expose notifications to userspace. */
634 struct list_head node
; /* event notifier group list */
635 struct list_head enablers_head
; /* List of enablers */
636 struct list_head event_notifiers_head
; /* List of event notifier */
637 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
638 struct lttng_ctx
*ctx
; /* Contexts for filters. */
639 struct lttng_channel_ops
*ops
;
640 struct lttng_transport
*transport
;
641 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
642 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
643 wait_queue_head_t read_wait
;
644 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
645 struct lttng_event_notifier
*sc_unknown
; /* for unknown syscalls */
646 struct lttng_event_notifier
*sc_compat_unknown
;
648 struct lttng_syscall_filter
*sc_filter
;
650 struct hlist_head
*event_notifier_syscall_dispatch
;
651 struct hlist_head
*event_notifier_compat_syscall_dispatch
;
652 struct hlist_head
*event_notifier_exit_syscall_dispatch
;
653 struct hlist_head
*event_notifier_exit_compat_syscall_dispatch
;
655 struct hlist_head event_notifier_unknown_syscall_dispatch
;
656 struct hlist_head event_notifier_compat_unknown_syscall_dispatch
;
657 struct hlist_head event_notifier_exit_unknown_syscall_dispatch
;
658 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch
;
660 int syscall_all_entry
;
661 int syscall_all_exit
;
663 unsigned int sys_enter_registered
:1, sys_exit_registered
:1;
665 struct lttng_counter
*error_counter
;
666 size_t error_counter_len
;
669 struct lttng_metadata_cache
{
670 char *data
; /* Metadata cache */
671 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
672 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
673 atomic_t producing
; /* Metadata being produced (incomplete) */
674 struct kref refcount
; /* Metadata cache usage */
675 struct list_head metadata_stream
; /* Metadata stream list */
676 uuid_le uuid
; /* Trace session unique ID (copy) */
677 struct mutex lock
; /* Produce/consume lock */
678 uint64_t version
; /* Current version of the metadata */
681 void lttng_lock_sessions(void);
682 void lttng_unlock_sessions(void);
684 struct list_head
*lttng_get_probe_list_head(void);
686 struct lttng_event_enabler
*lttng_event_enabler_create(
687 enum lttng_enabler_format_type format_type
,
688 struct lttng_kernel_event
*event_param
,
689 struct lttng_channel
*chan
);
691 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
692 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
693 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
694 struct lttng_event_notifier_group
*event_notifier_group
,
695 enum lttng_enabler_format_type format_type
,
696 struct lttng_kernel_event_notifier
*event_notifier_param
);
698 int lttng_event_notifier_enabler_enable(
699 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
700 int lttng_event_notifier_enabler_disable(
701 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
702 int lttng_fix_pending_events(void);
703 int lttng_fix_pending_event_notifiers(void);
704 int lttng_session_active(void);
705 bool lttng_event_notifier_active(void);
707 struct lttng_session
*lttng_session_create(void);
708 int lttng_session_enable(struct lttng_session
*session
);
709 int lttng_session_disable(struct lttng_session
*session
);
710 void lttng_session_destroy(struct lttng_session
*session
);
711 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
712 int lttng_session_statedump(struct lttng_session
*session
);
713 void metadata_cache_destroy(struct kref
*kref
);
715 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
716 void lttng_event_notifier_group_destroy(
717 struct lttng_event_notifier_group
*event_notifier_group
);
719 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
720 const char *transport_name
,
722 size_t subbuf_size
, size_t num_subbuf
,
723 unsigned int switch_timer_interval
,
724 unsigned int read_timer_interval
,
725 enum channel_type channel_type
);
726 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
727 int overwrite
, void *buf_addr
,
728 size_t subbuf_size
, size_t num_subbuf
,
729 unsigned int switch_timer_interval
,
730 unsigned int read_timer_interval
);
732 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
733 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
734 struct lttng_kernel_event
*event_param
,
736 const struct lttng_event_desc
*event_desc
,
737 enum lttng_kernel_instrumentation itype
);
738 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
739 struct lttng_kernel_event
*event_param
,
741 const struct lttng_event_desc
*event_desc
,
742 enum lttng_kernel_instrumentation itype
);
743 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
744 struct lttng_kernel_old_event
*old_event_param
,
746 const struct lttng_event_desc
*internal_desc
);
748 struct lttng_event_notifier
*lttng_event_notifier_create(
749 const struct lttng_event_desc
*event_notifier_desc
,
751 struct lttng_event_notifier_group
*event_notifier_group
,
752 struct lttng_kernel_event_notifier
*event_notifier_param
,
754 enum lttng_kernel_instrumentation itype
);
755 struct lttng_event_notifier
*_lttng_event_notifier_create(
756 const struct lttng_event_desc
*event_notifier_desc
,
758 struct lttng_event_notifier_group
*event_notifier_group
,
759 struct lttng_kernel_event_notifier
*event_notifier_param
,
761 enum lttng_kernel_instrumentation itype
);
763 int lttng_channel_enable(struct lttng_channel
*channel
);
764 int lttng_channel_disable(struct lttng_channel
*channel
);
765 int lttng_event_enable(struct lttng_event
*event
);
766 int lttng_event_disable(struct lttng_event
*event
);
768 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
);
769 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
);
771 void lttng_transport_register(struct lttng_transport
*transport
);
772 void lttng_transport_unregister(struct lttng_transport
*transport
);
774 void synchronize_trace(void);
775 int lttng_abi_init(void);
776 int lttng_abi_compat_old_init(void);
777 void lttng_abi_exit(void);
778 void lttng_abi_compat_old_exit(void);
780 int lttng_probe_register(struct lttng_probe_desc
*desc
);
781 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
782 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
783 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
784 int lttng_probes_init(void);
785 void lttng_probes_exit(void);
787 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
788 struct channel
*chan
, bool *coherent
);
790 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
791 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
792 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
793 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
794 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
795 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
797 int lttng_session_track_id(struct lttng_session
*session
,
798 enum tracker_type tracker_type
, int id
);
799 int lttng_session_untrack_id(struct lttng_session
*session
,
800 enum tracker_type tracker_type
, int id
);
802 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
803 enum tracker_type tracker_type
);
805 void lttng_clock_ref(void);
806 void lttng_clock_unref(void);
808 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
809 struct lttng_enabler
*enabler
);
811 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
812 int lttng_syscalls_register_event(struct lttng_channel
*chan
, void *filter
);
813 int lttng_syscalls_unregister_event(struct lttng_channel
*chan
);
814 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
815 int lttng_syscall_filter_enable_event(
816 struct lttng_channel
*chan
,
817 struct lttng_event
*event
);
818 int lttng_syscall_filter_disable_event(
819 struct lttng_channel
*chan
,
820 struct lttng_event
*event
);
822 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
823 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
825 int lttng_syscalls_register_event_notifier(
826 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
828 int lttng_syscals_create_matching_event_notifiers(
829 struct lttng_event_notifier_enabler
*event_notifier_enabler
, void *filter
);
830 int lttng_syscalls_unregister_event_notifier(struct lttng_event_notifier_group
*group
);
831 int lttng_syscall_filter_enable_event_notifier(struct lttng_event_notifier
*event_notifier
);
832 int lttng_syscall_filter_disable_event_notifier(struct lttng_event_notifier
*event_notifier
);
834 static inline int lttng_syscalls_register_event(
835 struct lttng_channel
*chan
, void *filter
)
840 static inline int lttng_syscalls_unregister_event(struct lttng_channel
*chan
)
845 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
850 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
851 struct lttng_event
*event
);
856 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
857 struct lttng_event
*event
);
862 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
863 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
868 static inline int lttng_syscalls_register_event_notifier(
869 struct lttng_event_notifier_group
*group
, void *filter
)
874 static inline int lttng_syscalls_unregister_event_notifier(
875 struct lttng_event_notifier_group
*group
)
880 static inline int lttng_syscall_filter_enable_event_notifier(
881 struct lttng_event_notifier_group
*group
,
887 static inline int lttng_syscall_filter_disable_event_notifier(
888 struct lttng_event_notifier_group
*group
,
896 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
897 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
898 struct lttng_kernel_filter_bytecode __user
*bytecode
);
899 int lttng_event_notifier_enabler_attach_filter_bytecode(
900 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
901 struct lttng_kernel_filter_bytecode __user
*bytecode
);
903 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
904 struct lttng_ctx
*ctx
,
905 struct list_head
*bytecode_runtime_head
,
906 struct lttng_enabler
*enabler
);
908 int lttng_probes_init(void);
910 extern struct lttng_ctx
*lttng_static_ctx
;
912 int lttng_context_init(void);
913 void lttng_context_exit(void);
914 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
915 ssize_t
lttng_append_context_index(struct lttng_ctx
**ctx_p
);
916 struct lttng_ctx_field
*lttng_get_context_field_from_index(struct lttng_ctx
*ctx
,
918 void lttng_context_update(struct lttng_ctx
*ctx
);
919 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
920 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
921 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
922 struct lttng_ctx_field
*field
);
923 void lttng_remove_context_field_index(struct lttng_ctx
**ctx_p
, size_t index
);
924 void lttng_destroy_context(struct lttng_ctx
*ctx
);
925 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
926 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
927 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
928 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
929 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
930 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
931 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
932 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
933 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
934 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
935 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
936 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
937 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
938 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
939 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
942 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
947 #ifdef CONFIG_PREEMPT_RT_FULL
948 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
951 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
957 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
959 #if defined(CONFIG_CGROUPS) && \
960 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
961 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
962 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
965 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
971 #if defined(CONFIG_IPC_NS) && \
972 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
973 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
976 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
982 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
983 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
984 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
987 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
993 #if defined(CONFIG_NET_NS) && \
994 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
995 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
998 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
1004 #if defined(CONFIG_PID_NS) && \
1005 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1006 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
1009 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
1015 #if defined(CONFIG_USER_NS) && \
1016 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1017 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
1020 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
1026 #if defined(CONFIG_UTS_NS) && \
1027 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1028 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
1031 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
1037 #if defined(CONFIG_TIME_NS) && \
1038 (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
1039 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
);
1042 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
)
1048 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
1049 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
1050 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
1051 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
1052 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
1053 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
1054 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
1055 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
1056 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
1057 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
1058 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
1059 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
1061 #if defined(CONFIG_PERF_EVENTS)
1062 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1065 struct lttng_ctx
**ctx
);
1066 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1067 struct lttng_cpuhp_node
*node
);
1068 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1069 struct lttng_cpuhp_node
*node
);
1072 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1075 struct lttng_ctx
**ctx
)
1080 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1081 struct lttng_cpuhp_node
*node
)
1086 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1087 struct lttng_cpuhp_node
*node
)
1093 int lttng_logger_init(void);
1094 void lttng_logger_exit(void);
1096 extern int lttng_statedump_start(struct lttng_session
*session
);
1098 #ifdef CONFIG_KPROBES
1099 int lttng_kprobes_register_event(const char *name
,
1100 const char *symbol_name
,
1103 struct lttng_event
*event
);
1104 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1105 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1106 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1109 struct lttng_event_notifier
*event_notifier
);
1110 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1111 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1114 int lttng_kprobes_register_event(const char *name
,
1115 const char *symbol_name
,
1118 struct lttng_event
*event
)
1124 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1129 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1134 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1137 struct lttng_event_notifier
*event_notifier
)
1143 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1148 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1153 int lttng_event_add_callsite(struct lttng_event
*event
,
1154 struct lttng_kernel_event_callsite
*callsite
);
1156 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1157 struct lttng_kernel_event_callsite
*callsite
);
1159 #ifdef CONFIG_UPROBES
1160 int lttng_uprobes_register_event(const char *name
,
1161 int fd
, struct lttng_event
*event
);
1162 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1163 struct lttng_kernel_event_callsite
*callsite
);
1164 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1165 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1166 int lttng_uprobes_register_event_notifier(const char *name
,
1167 int fd
, struct lttng_event_notifier
*event_notifier
);
1168 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1169 struct lttng_kernel_event_callsite
*callsite
);
1170 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1171 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1174 int lttng_uprobes_register_event(const char *name
,
1175 int fd
, struct lttng_event
*event
)
1181 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1182 struct lttng_kernel_event_callsite
*callsite
)
1188 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1193 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1198 int lttng_uprobes_register_event_notifier(const char *name
,
1199 int fd
, struct lttng_event_notifier
*event_notifier
)
1205 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1206 struct lttng_kernel_event_callsite
*callsite
)
1212 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1217 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1222 #ifdef CONFIG_KRETPROBES
1223 int lttng_kretprobes_register(const char *name
,
1224 const char *symbol_name
,
1227 struct lttng_event
*event_entry
,
1228 struct lttng_event
*event_exit
);
1229 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1230 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1231 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1235 int lttng_kretprobes_register(const char *name
,
1236 const char *symbol_name
,
1239 struct lttng_event
*event_entry
,
1240 struct lttng_event
*event_exit
)
1246 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1251 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1256 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1263 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1265 extern const struct file_operations lttng_tracepoint_list_fops
;
1266 extern const struct file_operations lttng_syscall_list_fops
;
1268 #define TRACEPOINT_HAS_DATA_ARG
1270 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1272 if (type
->atype
!= atype_integer
)
1274 switch (type
->u
.integer
.size
) {
1275 case 8: /* Fall-through. */
1276 case 16: /* Fall-through. */
1277 case 32: /* Fall-through. */
1286 #endif /* _LTTNG_EVENTS_H */