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
,
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
;
343 struct list_head list
; /* Event list in session */
344 unsigned int metadata_dumped
:1;
346 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
347 struct list_head enablers_ref_head
;
348 struct hlist_node hlist
; /* session ht of events */
349 int registered
; /* has reg'd tracepoint probe */
350 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
351 struct list_head filter_bytecode_runtime_head
;
352 int has_enablers_without_bytecode
;
355 // FIXME: Really similar to lttng_event above. Could those be merged ?
356 struct lttng_event_notifier
{
357 enum lttng_event_type evtype
; /* First field. */
360 int registered
; /* has reg'd tracepoint probe */
361 const struct lttng_event_desc
*desc
;
363 struct list_head list
; /* event_notifier list in event_notifier group */
365 enum lttng_kernel_instrumentation instrumentation
;
367 struct lttng_kprobe kprobe
;
368 struct lttng_uprobe uprobe
;
370 enum lttng_syscall_entryexit entryexit
;
371 enum lttng_syscall_abi abi
;
372 struct hlist_node node
; /* chain registered syscall event_notifier */
373 unsigned int syscall_id
;
378 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
379 struct list_head enablers_ref_head
;
380 struct hlist_node hlist
; /* session ht of event_notifiers */
381 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
382 struct list_head filter_bytecode_runtime_head
;
384 struct list_head capture_bytecode_runtime_head
;
385 int has_enablers_without_bytecode
;
387 void (*send_notification
)(struct lttng_event_notifier
*event_notifier
,
388 struct lttng_probe_ctx
*lttng_probe_ctx
,
389 const char *interpreter_stack_data
);
390 struct lttng_event_notifier_group
*group
; /* Weak ref */
393 enum lttng_enabler_format_type
{
394 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
395 LTTNG_ENABLER_FORMAT_NAME
,
399 * Enabler field, within whatever object is enabling an event. Target of
400 * backward reference.
402 struct lttng_enabler
{
403 enum lttng_event_type evtype
; /* First field. */
405 enum lttng_enabler_format_type format_type
;
407 /* head list of struct lttng_bytecode_node */
408 struct list_head filter_bytecode_head
;
410 struct lttng_kernel_event event_param
;
411 unsigned int enabled
:1;
413 uint64_t user_token
; /* User-provided token. */
416 struct lttng_event_enabler
{
417 struct lttng_enabler base
;
418 struct list_head node
; /* per-session list of enablers */
419 struct lttng_channel
*chan
;
421 * Unused, but kept around to make it explicit that the tracer can do
424 struct lttng_ctx
*ctx
;
427 struct lttng_event_notifier_enabler
{
428 struct lttng_enabler base
;
429 struct list_head node
; /* List of event_notifier enablers */
430 struct lttng_event_notifier_group
*group
;
432 /* head list of struct lttng_bytecode_node */
433 struct list_head capture_bytecode_head
;
434 uint64_t num_captures
;
439 struct lttng_enabler
*lttng_event_enabler_as_enabler(
440 struct lttng_event_enabler
*event_enabler
)
442 return &event_enabler
->base
;
446 struct lttng_enabler
*lttng_event_notifier_enabler_as_enabler(
447 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
449 return &event_notifier_enabler
->base
;
452 struct lttng_channel_ops
{
453 struct channel
*(*channel_create
)(const char *name
,
456 size_t subbuf_size
, size_t num_subbuf
,
457 unsigned int switch_timer_interval
,
458 unsigned int read_timer_interval
);
459 void (*channel_destroy
)(struct channel
*chan
);
460 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
461 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
462 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
463 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
465 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
466 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
468 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
469 const void *src
, size_t len
);
470 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
472 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
474 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
475 const char __user
*src
, size_t len
);
477 * packet_avail_size returns the available size in the current
478 * packet. Note that the size returned is only a hint, since it
479 * may change due to concurrent writes.
481 size_t (*packet_avail_size
)(struct channel
*chan
);
482 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
483 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
484 int (*is_finalized
)(struct channel
*chan
);
485 int (*is_disabled
)(struct channel
*chan
);
486 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
487 struct lib_ring_buffer
*bufb
,
488 uint64_t *timestamp_begin
);
489 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
490 struct lib_ring_buffer
*bufb
,
491 uint64_t *timestamp_end
);
492 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
493 struct lib_ring_buffer
*bufb
,
494 uint64_t *events_discarded
);
495 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
496 struct lib_ring_buffer
*bufb
,
497 uint64_t *content_size
);
498 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
499 struct lib_ring_buffer
*bufb
,
500 uint64_t *packet_size
);
501 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
502 struct lib_ring_buffer
*bufb
,
503 uint64_t *stream_id
);
504 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
505 struct lib_ring_buffer
*bufb
,
507 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
508 struct lib_ring_buffer
*bufb
,
510 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
511 struct lib_ring_buffer
*bufb
,
515 struct lttng_transport
{
517 struct module
*owner
;
518 struct list_head node
;
519 struct lttng_channel_ops ops
;
522 struct lttng_syscall_filter
;
524 #define LTTNG_EVENT_HT_BITS 12
525 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
527 struct lttng_event_ht
{
528 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
531 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
532 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
534 struct lttng_event_notifier_ht
{
535 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
538 struct lttng_channel
{
540 struct channel
*chan
; /* Channel buffers */
542 struct lttng_ctx
*ctx
;
543 /* Event ID management */
544 struct lttng_session
*session
;
545 struct file
*file
; /* File associated to channel */
546 unsigned int free_event_id
; /* Next event ID to allocate */
547 struct list_head list
; /* Channel list */
548 struct lttng_channel_ops
*ops
;
549 struct lttng_transport
*transport
;
550 struct lttng_event
**sc_table
; /* for syscall tracing */
551 struct lttng_event
**compat_sc_table
;
552 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
553 struct lttng_event
**compat_sc_exit_table
;
554 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
555 struct lttng_event
*sc_compat_unknown
;
556 struct lttng_event
*sc_exit_unknown
;
557 struct lttng_event
*compat_sc_exit_unknown
;
558 struct lttng_syscall_filter
*sc_filter
;
559 int header_type
; /* 0: unset, 1: compact, 2: large */
560 enum channel_type channel_type
;
562 unsigned int metadata_dumped
:1,
563 sys_enter_registered
:1,
564 sys_exit_registered
:1,
565 tstate
:1; /* Transient enable state */
568 struct lttng_metadata_stream
{
569 void *priv
; /* Ring buffer private data */
570 struct lttng_metadata_cache
*metadata_cache
;
571 unsigned int metadata_in
; /* Bytes read from the cache */
572 unsigned int metadata_out
; /* Bytes consumed from stream */
573 int finalized
; /* Has channel been finalized */
574 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
575 struct list_head list
; /* Stream list */
576 struct lttng_transport
*transport
;
577 uint64_t version
; /* Current version of the metadata cache */
578 bool coherent
; /* Stream in a coherent state */
581 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
583 struct lttng_dynamic_len_stack
{
584 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
588 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
591 * struct lttng_id_tracker declared in header due to deferencing of *v
592 * in RCU_INITIALIZER(v).
594 #define LTTNG_ID_HASH_BITS 6
595 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
608 struct lttng_id_tracker_rcu
{
609 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
612 struct lttng_id_tracker
{
613 struct lttng_session
*session
;
614 enum tracker_type tracker_type
;
615 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
618 struct lttng_id_hash_node
{
619 struct hlist_node hlist
;
623 struct lttng_session
{
624 int active
; /* Is trace session active ? */
625 int been_active
; /* Has trace session been active ? */
626 struct file
*file
; /* File associated to session */
627 struct list_head chan
; /* Channel list head */
628 struct list_head events
; /* Event list head */
629 struct list_head list
; /* Session list */
630 unsigned int free_chan_id
; /* Next chan ID to allocate */
631 uuid_le uuid
; /* Trace session unique ID */
632 struct lttng_metadata_cache
*metadata_cache
;
633 struct lttng_id_tracker pid_tracker
;
634 struct lttng_id_tracker vpid_tracker
;
635 struct lttng_id_tracker uid_tracker
;
636 struct lttng_id_tracker vuid_tracker
;
637 struct lttng_id_tracker gid_tracker
;
638 struct lttng_id_tracker vgid_tracker
;
639 unsigned int metadata_dumped
:1,
640 tstate
:1; /* Transient enable state */
641 /* List of event enablers */
642 struct list_head enablers_head
;
643 /* Hash table of events */
644 struct lttng_event_ht events_ht
;
645 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
646 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
649 struct lttng_event_notifier_group
{
650 struct file
*file
; /* File associated to event notifier group */
651 struct file
*notif_file
; /* File used to expose notifications to userspace. */
652 struct list_head node
; /* event notifier group list */
653 struct list_head enablers_head
; /* List of enablers */
654 struct list_head event_notifiers_head
; /* List of event notifier */
655 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
656 struct lttng_ctx
*ctx
; /* Contexts for filters. */
657 struct lttng_channel_ops
*ops
;
658 struct lttng_transport
*transport
;
659 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
660 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
661 wait_queue_head_t read_wait
;
662 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
663 struct lttng_event_notifier
*sc_unknown
; /* for unknown syscalls */
664 struct lttng_event_notifier
*sc_compat_unknown
;
666 struct lttng_syscall_filter
*sc_filter
;
668 struct hlist_head
*event_notifier_syscall_dispatch
;
669 struct hlist_head
*event_notifier_compat_syscall_dispatch
;
670 struct hlist_head
*event_notifier_exit_syscall_dispatch
;
671 struct hlist_head
*event_notifier_exit_compat_syscall_dispatch
;
673 struct hlist_head event_notifier_unknown_syscall_dispatch
;
674 struct hlist_head event_notifier_compat_unknown_syscall_dispatch
;
675 struct hlist_head event_notifier_exit_unknown_syscall_dispatch
;
676 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch
;
678 int syscall_all_entry
;
679 int syscall_all_exit
;
681 unsigned int sys_enter_registered
:1, sys_exit_registered
:1;
683 struct lttng_counter
*error_counter
;
684 size_t error_counter_len
;
687 struct lttng_metadata_cache
{
688 char *data
; /* Metadata cache */
689 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
690 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
691 atomic_t producing
; /* Metadata being produced (incomplete) */
692 struct kref refcount
; /* Metadata cache usage */
693 struct list_head metadata_stream
; /* Metadata stream list */
694 uuid_le uuid
; /* Trace session unique ID (copy) */
695 struct mutex lock
; /* Produce/consume lock */
696 uint64_t version
; /* Current version of the metadata */
699 void lttng_lock_sessions(void);
700 void lttng_unlock_sessions(void);
702 struct list_head
*lttng_get_probe_list_head(void);
704 struct lttng_event_enabler
*lttng_event_enabler_create(
705 enum lttng_enabler_format_type format_type
,
706 struct lttng_kernel_event
*event_param
,
707 struct lttng_channel
*chan
);
709 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
710 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
711 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
712 struct lttng_event_notifier_group
*event_notifier_group
,
713 enum lttng_enabler_format_type format_type
,
714 struct lttng_kernel_event_notifier
*event_notifier_param
);
716 int lttng_event_notifier_enabler_enable(
717 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
718 int lttng_event_notifier_enabler_disable(
719 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
720 int lttng_fix_pending_events(void);
721 int lttng_fix_pending_event_notifiers(void);
722 int lttng_session_active(void);
723 bool lttng_event_notifier_active(void);
725 struct lttng_session
*lttng_session_create(void);
726 int lttng_session_enable(struct lttng_session
*session
);
727 int lttng_session_disable(struct lttng_session
*session
);
728 void lttng_session_destroy(struct lttng_session
*session
);
729 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
730 int lttng_session_statedump(struct lttng_session
*session
);
731 void metadata_cache_destroy(struct kref
*kref
);
733 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
734 void lttng_event_notifier_group_destroy(
735 struct lttng_event_notifier_group
*event_notifier_group
);
737 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
738 const char *transport_name
,
740 size_t subbuf_size
, size_t num_subbuf
,
741 unsigned int switch_timer_interval
,
742 unsigned int read_timer_interval
,
743 enum channel_type channel_type
);
744 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
745 int overwrite
, void *buf_addr
,
746 size_t subbuf_size
, size_t num_subbuf
,
747 unsigned int switch_timer_interval
,
748 unsigned int read_timer_interval
);
750 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
751 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
752 struct lttng_kernel_event
*event_param
,
754 const struct lttng_event_desc
*event_desc
,
755 enum lttng_kernel_instrumentation itype
);
756 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
757 struct lttng_kernel_event
*event_param
,
759 const struct lttng_event_desc
*event_desc
,
760 enum lttng_kernel_instrumentation itype
);
761 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
762 struct lttng_kernel_old_event
*old_event_param
,
764 const struct lttng_event_desc
*internal_desc
);
766 struct lttng_event_notifier
*lttng_event_notifier_create(
767 const struct lttng_event_desc
*event_notifier_desc
,
769 struct lttng_event_notifier_group
*event_notifier_group
,
770 struct lttng_kernel_event_notifier
*event_notifier_param
,
772 enum lttng_kernel_instrumentation itype
);
773 struct lttng_event_notifier
*_lttng_event_notifier_create(
774 const struct lttng_event_desc
*event_notifier_desc
,
776 struct lttng_event_notifier_group
*event_notifier_group
,
777 struct lttng_kernel_event_notifier
*event_notifier_param
,
779 enum lttng_kernel_instrumentation itype
);
781 int lttng_channel_enable(struct lttng_channel
*channel
);
782 int lttng_channel_disable(struct lttng_channel
*channel
);
783 int lttng_event_enable(struct lttng_event
*event
);
784 int lttng_event_disable(struct lttng_event
*event
);
786 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
);
787 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
);
789 void lttng_transport_register(struct lttng_transport
*transport
);
790 void lttng_transport_unregister(struct lttng_transport
*transport
);
792 void synchronize_trace(void);
793 int lttng_abi_init(void);
794 int lttng_abi_compat_old_init(void);
795 void lttng_abi_exit(void);
796 void lttng_abi_compat_old_exit(void);
798 int lttng_probe_register(struct lttng_probe_desc
*desc
);
799 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
800 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
801 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
802 int lttng_probes_init(void);
803 void lttng_probes_exit(void);
805 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
806 struct channel
*chan
, bool *coherent
);
808 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
809 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
810 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
811 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
812 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
813 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
815 int lttng_session_track_id(struct lttng_session
*session
,
816 enum tracker_type tracker_type
, int id
);
817 int lttng_session_untrack_id(struct lttng_session
*session
,
818 enum tracker_type tracker_type
, int id
);
820 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
821 enum tracker_type tracker_type
);
823 void lttng_clock_ref(void);
824 void lttng_clock_unref(void);
826 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
827 struct lttng_enabler
*enabler
);
829 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
830 int lttng_syscalls_register_event(struct lttng_channel
*chan
, void *filter
);
831 int lttng_syscalls_unregister_event(struct lttng_channel
*chan
);
832 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
833 int lttng_syscall_filter_enable_event(
834 struct lttng_channel
*chan
,
835 struct lttng_event
*event
);
836 int lttng_syscall_filter_disable_event(
837 struct lttng_channel
*chan
,
838 struct lttng_event
*event
);
840 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
841 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
843 int lttng_syscalls_register_event_notifier(
844 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
846 int lttng_syscals_create_matching_event_notifiers(
847 struct lttng_event_notifier_enabler
*event_notifier_enabler
, void *filter
);
848 int lttng_syscalls_unregister_event_notifier(struct lttng_event_notifier_group
*group
);
849 int lttng_syscall_filter_enable_event_notifier(struct lttng_event_notifier
*event_notifier
);
850 int lttng_syscall_filter_disable_event_notifier(struct lttng_event_notifier
*event_notifier
);
852 static inline int lttng_syscalls_register_event(
853 struct lttng_channel
*chan
, void *filter
)
858 static inline int lttng_syscalls_unregister_event(struct lttng_channel
*chan
)
863 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
868 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
869 struct lttng_event
*event
);
874 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
875 struct lttng_event
*event
);
880 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
881 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
886 static inline int lttng_syscalls_register_event_notifier(
887 struct lttng_event_notifier_group
*group
, void *filter
)
892 static inline int lttng_syscalls_unregister_event_notifier(
893 struct lttng_event_notifier_group
*group
)
898 static inline int lttng_syscall_filter_enable_event_notifier(
899 struct lttng_event_notifier_group
*group
,
905 static inline int lttng_syscall_filter_disable_event_notifier(
906 struct lttng_event_notifier_group
*group
,
914 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
915 struct lttng_kernel_filter_bytecode __user
*bytecode
);
916 int lttng_event_notifier_enabler_attach_filter_bytecode(
917 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
918 struct lttng_kernel_filter_bytecode __user
*bytecode
);
919 int lttng_event_notifier_enabler_attach_capture_bytecode(
920 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
921 struct lttng_kernel_capture_bytecode __user
*bytecode
);
923 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
924 struct lttng_ctx
*ctx
,
925 struct list_head
*instance_bytecode_runtime_head
,
926 struct list_head
*enabler_bytecode_runtime_head
);
928 int lttng_probes_init(void);
930 extern struct lttng_ctx
*lttng_static_ctx
;
932 int lttng_context_init(void);
933 void lttng_context_exit(void);
934 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
935 ssize_t
lttng_append_context_index(struct lttng_ctx
**ctx_p
);
936 struct lttng_ctx_field
*lttng_get_context_field_from_index(struct lttng_ctx
*ctx
,
938 void lttng_context_update(struct lttng_ctx
*ctx
);
939 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
940 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
941 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
942 struct lttng_ctx_field
*field
);
943 void lttng_remove_context_field_index(struct lttng_ctx
**ctx_p
, size_t index
);
944 void lttng_destroy_context(struct lttng_ctx
*ctx
);
945 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
946 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
947 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
948 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
949 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
950 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
951 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
952 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
953 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
954 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
955 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
956 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
957 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
958 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
959 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
962 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
967 #ifdef CONFIG_PREEMPT_RT_FULL
968 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
971 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
977 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
979 #if defined(CONFIG_CGROUPS) && \
980 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
981 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
982 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
985 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
991 #if defined(CONFIG_IPC_NS) && \
992 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
993 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
996 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
1002 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
1003 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1004 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
1007 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
1013 #if defined(CONFIG_NET_NS) && \
1014 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1015 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
1018 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
1024 #if defined(CONFIG_PID_NS) && \
1025 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1026 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
1029 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
1035 #if defined(CONFIG_USER_NS) && \
1036 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1037 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
1040 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
1046 #if defined(CONFIG_UTS_NS) && \
1047 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1048 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
1051 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
1057 #if defined(CONFIG_TIME_NS) && \
1058 (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
1059 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
);
1062 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
)
1068 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
1069 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
1070 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
1071 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
1072 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
1073 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
1074 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
1075 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
1076 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
1077 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
1078 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
1079 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
1081 #if defined(CONFIG_PERF_EVENTS)
1082 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1085 struct lttng_ctx
**ctx
);
1086 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1087 struct lttng_cpuhp_node
*node
);
1088 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1089 struct lttng_cpuhp_node
*node
);
1092 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1095 struct lttng_ctx
**ctx
)
1100 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1101 struct lttng_cpuhp_node
*node
)
1106 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1107 struct lttng_cpuhp_node
*node
)
1113 int lttng_logger_init(void);
1114 void lttng_logger_exit(void);
1116 extern int lttng_statedump_start(struct lttng_session
*session
);
1118 #ifdef CONFIG_KPROBES
1119 int lttng_kprobes_register_event(const char *name
,
1120 const char *symbol_name
,
1123 struct lttng_event
*event
);
1124 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1125 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1126 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1129 struct lttng_event_notifier
*event_notifier
);
1130 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1131 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1134 int lttng_kprobes_register_event(const char *name
,
1135 const char *symbol_name
,
1138 struct lttng_event
*event
)
1144 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1149 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1154 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1157 struct lttng_event_notifier
*event_notifier
)
1163 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1168 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1173 int lttng_event_add_callsite(struct lttng_event
*event
,
1174 struct lttng_kernel_event_callsite
*callsite
);
1176 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1177 struct lttng_kernel_event_callsite
*callsite
);
1179 #ifdef CONFIG_UPROBES
1180 int lttng_uprobes_register_event(const char *name
,
1181 int fd
, struct lttng_event
*event
);
1182 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1183 struct lttng_kernel_event_callsite
*callsite
);
1184 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1185 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1186 int lttng_uprobes_register_event_notifier(const char *name
,
1187 int fd
, struct lttng_event_notifier
*event_notifier
);
1188 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1189 struct lttng_kernel_event_callsite
*callsite
);
1190 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1191 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1194 int lttng_uprobes_register_event(const char *name
,
1195 int fd
, struct lttng_event
*event
)
1201 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1202 struct lttng_kernel_event_callsite
*callsite
)
1208 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1213 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1218 int lttng_uprobes_register_event_notifier(const char *name
,
1219 int fd
, struct lttng_event_notifier
*event_notifier
)
1225 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1226 struct lttng_kernel_event_callsite
*callsite
)
1232 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1237 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1242 #ifdef CONFIG_KRETPROBES
1243 int lttng_kretprobes_register(const char *name
,
1244 const char *symbol_name
,
1247 struct lttng_event
*event_entry
,
1248 struct lttng_event
*event_exit
);
1249 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1250 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1251 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1255 int lttng_kretprobes_register(const char *name
,
1256 const char *symbol_name
,
1259 struct lttng_event
*event_entry
,
1260 struct lttng_event
*event_exit
)
1266 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1271 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1276 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1283 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1285 extern const struct file_operations lttng_tracepoint_list_fops
;
1286 extern const struct file_operations lttng_syscall_list_fops
;
1288 #define TRACEPOINT_HAS_DATA_ARG
1290 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1292 if (type
->atype
!= atype_integer
)
1294 switch (type
->u
.integer
.size
) {
1295 case 8: /* Fall-through. */
1296 case 16: /* Fall-through. */
1297 case 32: /* Fall-through. */
1306 #endif /* _LTTNG_EVENTS_H */