1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
5 * Holds LTTng per-session event registry.
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 #ifndef _LTTNG_EVENTS_H
11 #define _LTTNG_EVENTS_H
13 #include <lttng/kernel-version.h>
14 #include <linux/list.h>
15 #include <linux/kprobes.h>
16 #include <linux/kref.h>
17 #include <linux/uuid.h>
18 #include <linux/irq_work.h>
19 #include <wrapper/uprobes.h>
20 #include <lttng/cpuhotplug.h>
21 #include <lttng/tracer.h>
22 #include <lttng/abi.h>
23 #include <lttng/abi-old.h>
24 #include <lttng/endian.h>
26 #define lttng_is_signed_type(type) (((type)(-1)) < 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 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
161 struct lttng_cpuhp_node cpuhp_prepare
;
162 struct lttng_cpuhp_node cpuhp_online
;
164 struct notifier_block nb
;
167 struct perf_event_attr
*attr
;
168 struct perf_event
**e
; /* per-cpu array */
171 struct lttng_probe_ctx
{
172 struct lttng_event
*event
;
173 struct lttng_event_notifier
*event_notifier
; // Not sure if we will ever need it.
174 uint8_t interruptible
;
177 struct lttng_ctx_field
{
178 struct lttng_event_field event_field
;
179 size_t (*get_size
)(size_t offset
);
180 size_t (*get_size_arg
)(size_t offset
, struct lttng_ctx_field
*field
,
181 struct lib_ring_buffer_ctx
*ctx
,
182 struct lttng_channel
*chan
);
183 void (*record
)(struct lttng_ctx_field
*field
,
184 struct lib_ring_buffer_ctx
*ctx
,
185 struct lttng_channel
*chan
);
186 void (*get_value
)(struct lttng_ctx_field
*field
,
187 struct lttng_probe_ctx
*lttng_probe_ctx
,
188 union lttng_ctx_value
*value
);
190 struct lttng_perf_counter_field
*perf_counter
;
192 void (*destroy
)(struct lttng_ctx_field
*field
);
194 * Private data to keep state between get_size and record.
195 * User must perform its own synchronization to protect against
196 * concurrent and reentrant contexts.
202 struct lttng_ctx_field
*fields
;
203 unsigned int nr_fields
;
204 unsigned int allocated_fields
;
205 size_t largest_align
; /* in bytes */
208 struct lttng_event_desc
{
209 const char *name
; /* lttng-modules name */
210 const char *kname
; /* Linux kernel name (tracepoints) */
211 void *probe_callback
;
212 const struct lttng_event_ctx
*ctx
; /* context */
213 const struct lttng_event_field
*fields
; /* event payload */
214 unsigned int nr_fields
;
215 struct module
*owner
;
216 void *event_notifier_callback
;
219 struct lttng_probe_desc
{
220 const char *provider
;
221 const struct lttng_event_desc
**event_desc
;
222 unsigned int nr_events
;
223 struct list_head head
; /* chain registered probes */
224 struct list_head lazy_init_head
;
225 int lazy
; /* lazy registration */
228 struct lttng_krp
; /* Kretprobe handling */
230 enum lttng_event_type
{
231 LTTNG_TYPE_EVENT
= 0,
232 LTTNG_TYPE_ENABLER
= 1,
235 enum lttng_bytecode_node_type
{
236 LTTNG_BYTECODE_NODE_TYPE_FILTER
,
237 LTTNG_BYTECODE_NODE_TYPE_CAPTURE
,
240 struct lttng_bytecode_node
{
241 enum lttng_bytecode_node_type type
;
242 struct list_head node
;
243 struct lttng_enabler
*enabler
;
246 uint32_t reloc_offset
;
253 * Bytecode interpreter return value masks.
255 enum lttng_bytecode_interpreter_ret
{
256 LTTNG_INTERPRETER_DISCARD
= 0,
257 LTTNG_INTERPRETER_RECORD_FLAG
= (1ULL << 0),
258 /* Other bits are kept for future use. */
261 struct lttng_interpreter_output
;
263 struct lttng_bytecode_runtime
{
264 /* Associated bytecode */
265 struct lttng_bytecode_node
*bc
;
267 uint64_t (*filter
)(void *filter_data
,
268 struct lttng_probe_ctx
*lttng_probe_ctx
,
269 const char *filter_stack_data
);
270 uint64_t (*capture
)(void *filter_data
,
271 struct lttng_probe_ctx
*lttng_probe_ctx
,
272 const char *capture_stack_data
,
273 struct lttng_interpreter_output
*output
);
276 struct list_head node
; /* list of bytecode runtime in event */
277 struct lttng_ctx
*ctx
;
281 * Objects in a linked-list of enablers, owned by an event.
283 struct lttng_enabler_ref
{
284 struct list_head node
; /* enabler ref list */
285 struct lttng_enabler
*ref
; /* backward ref */
288 struct lttng_uprobe_handler
{
290 struct lttng_event
*event
;
291 struct lttng_event_notifier
*event_notifier
;
294 struct uprobe_consumer up_consumer
;
295 struct list_head node
;
298 struct lttng_kprobe
{
303 struct lttng_uprobe
{
305 struct list_head head
;
308 enum lttng_syscall_entryexit
{
313 enum lttng_syscall_abi
{
314 LTTNG_SYSCALL_ABI_NATIVE
,
315 LTTNG_SYSCALL_ABI_COMPAT
,
319 * lttng_event structure is referred to by the tracing fast path. It must be
323 enum lttng_event_type evtype
; /* First field. */
325 struct lttng_channel
*chan
;
327 const struct lttng_event_desc
*desc
;
329 struct lttng_ctx
*ctx
;
330 enum lttng_kernel_instrumentation instrumentation
;
332 struct lttng_kprobe kprobe
;
334 struct lttng_krp
*lttng_krp
;
337 struct lttng_uprobe uprobe
;
339 enum lttng_syscall_entryexit entryexit
;
340 enum lttng_syscall_abi abi
;
341 struct hlist_node node
; /* chain registered syscall event */
344 struct list_head list
; /* Event list in session */
345 unsigned int metadata_dumped
:1;
347 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
348 struct list_head enablers_ref_head
;
349 struct hlist_node hlist
; /* session ht of events */
350 int registered
; /* has reg'd tracepoint probe */
351 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
352 struct list_head filter_bytecode_runtime_head
;
353 int has_enablers_without_bytecode
;
356 // FIXME: Really similar to lttng_event above. Could those be merged ?
357 struct lttng_event_notifier
{
358 enum lttng_event_type evtype
; /* First field. */
360 uint64_t error_counter_index
;
362 int registered
; /* has reg'd tracepoint probe */
363 const struct lttng_event_desc
*desc
;
365 struct list_head list
; /* event_notifier list in event_notifier group */
367 enum lttng_kernel_instrumentation instrumentation
;
369 struct lttng_kprobe kprobe
;
370 struct lttng_uprobe uprobe
;
372 enum lttng_syscall_entryexit entryexit
;
373 enum lttng_syscall_abi abi
;
374 struct hlist_node node
; /* chain registered syscall event_notifier */
375 unsigned int syscall_id
;
380 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
381 struct list_head enablers_ref_head
;
382 struct hlist_node hlist
; /* session ht of event_notifiers */
383 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
384 struct list_head filter_bytecode_runtime_head
;
386 struct list_head capture_bytecode_runtime_head
;
387 int has_enablers_without_bytecode
;
389 void (*send_notification
)(struct lttng_event_notifier
*event_notifier
,
390 struct lttng_probe_ctx
*lttng_probe_ctx
,
391 const char *interpreter_stack_data
);
392 struct lttng_event_notifier_group
*group
; /* Weak ref */
395 enum lttng_enabler_format_type
{
396 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
397 LTTNG_ENABLER_FORMAT_NAME
,
401 * Enabler field, within whatever object is enabling an event. Target of
402 * backward reference.
404 struct lttng_enabler
{
405 enum lttng_event_type evtype
; /* First field. */
407 enum lttng_enabler_format_type format_type
;
409 /* head list of struct lttng_bytecode_node */
410 struct list_head filter_bytecode_head
;
412 struct lttng_kernel_event event_param
;
413 unsigned int enabled
:1;
415 uint64_t user_token
; /* User-provided token. */
418 struct lttng_event_enabler
{
419 struct lttng_enabler base
;
420 struct list_head node
; /* per-session list of enablers */
421 struct lttng_channel
*chan
;
423 * Unused, but kept around to make it explicit that the tracer can do
426 struct lttng_ctx
*ctx
;
429 struct lttng_event_notifier_enabler
{
430 struct lttng_enabler base
;
431 uint64_t error_counter_index
;
432 struct list_head node
; /* List of event_notifier enablers */
433 struct lttng_event_notifier_group
*group
;
435 /* head list of struct lttng_bytecode_node */
436 struct list_head capture_bytecode_head
;
437 uint64_t num_captures
;
442 struct lttng_enabler
*lttng_event_enabler_as_enabler(
443 struct lttng_event_enabler
*event_enabler
)
445 return &event_enabler
->base
;
449 struct lttng_enabler
*lttng_event_notifier_enabler_as_enabler(
450 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
452 return &event_notifier_enabler
->base
;
455 struct lttng_channel_ops
{
456 struct channel
*(*channel_create
)(const char *name
,
459 size_t subbuf_size
, size_t num_subbuf
,
460 unsigned int switch_timer_interval
,
461 unsigned int read_timer_interval
);
462 void (*channel_destroy
)(struct channel
*chan
);
463 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
464 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
465 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
466 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
468 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
469 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
471 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
472 const void *src
, size_t len
);
473 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
475 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
477 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
478 const char __user
*src
, size_t len
);
480 * packet_avail_size returns the available size in the current
481 * packet. Note that the size returned is only a hint, since it
482 * may change due to concurrent writes.
484 size_t (*packet_avail_size
)(struct channel
*chan
);
485 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
486 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
487 int (*is_finalized
)(struct channel
*chan
);
488 int (*is_disabled
)(struct channel
*chan
);
489 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
490 struct lib_ring_buffer
*bufb
,
491 uint64_t *timestamp_begin
);
492 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
493 struct lib_ring_buffer
*bufb
,
494 uint64_t *timestamp_end
);
495 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
496 struct lib_ring_buffer
*bufb
,
497 uint64_t *events_discarded
);
498 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
499 struct lib_ring_buffer
*bufb
,
500 uint64_t *content_size
);
501 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
502 struct lib_ring_buffer
*bufb
,
503 uint64_t *packet_size
);
504 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
505 struct lib_ring_buffer
*bufb
,
506 uint64_t *stream_id
);
507 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
508 struct lib_ring_buffer
*bufb
,
510 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
511 struct lib_ring_buffer
*bufb
,
513 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
514 struct lib_ring_buffer
*bufb
,
518 struct lttng_counter_ops
{
519 struct lib_counter
*(*counter_create
)(size_t nr_dimensions
,
520 const size_t *max_nr_elem
, /* for each dimension */
521 int64_t global_sum_step
);
522 void (*counter_destroy
)(struct lib_counter
*counter
);
523 int (*counter_add
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
526 * counter_read reads a specific cpu's counter if @cpu >= 0, or
527 * the global aggregation counter if @cpu == -1.
529 int (*counter_read
)(struct lib_counter
*counter
, const size_t *dimension_indexes
, int cpu
,
530 int64_t *value
, bool *overflow
, bool *underflow
);
532 * counter_aggregate returns the total sum of all per-cpu counters and
533 * the global aggregation counter.
535 int (*counter_aggregate
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
536 int64_t *value
, bool *overflow
, bool *underflow
);
537 int (*counter_clear
)(struct lib_counter
*counter
, const size_t *dimension_indexes
);
540 struct lttng_transport
{
542 struct module
*owner
;
543 struct list_head node
;
544 struct lttng_channel_ops ops
;
547 struct lttng_counter_transport
{
549 struct module
*owner
;
550 struct list_head node
;
551 struct lttng_counter_ops ops
;
554 struct lttng_syscall_filter
;
556 #define LTTNG_EVENT_HT_BITS 12
557 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
559 struct lttng_event_ht
{
560 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
563 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
564 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
566 struct lttng_event_notifier_ht
{
567 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
570 struct lttng_channel
{
572 struct channel
*chan
; /* Channel buffers */
574 struct lttng_ctx
*ctx
;
575 /* Event ID management */
576 struct lttng_session
*session
;
577 struct file
*file
; /* File associated to channel */
578 unsigned int free_event_id
; /* Next event ID to allocate */
579 struct list_head list
; /* Channel list */
580 struct lttng_channel_ops
*ops
;
581 struct lttng_transport
*transport
;
582 struct hlist_head
*sc_table
; /* for syscall tracing */
583 struct hlist_head
*compat_sc_table
;
584 struct hlist_head
*sc_exit_table
; /* for syscall exit tracing */
585 struct hlist_head
*compat_sc_exit_table
;
586 struct hlist_head sc_unknown
; /* for unknown syscalls */
587 struct hlist_head sc_compat_unknown
;
588 struct hlist_head sc_exit_unknown
;
589 struct hlist_head compat_sc_exit_unknown
;
590 struct lttng_syscall_filter
*sc_filter
;
591 int header_type
; /* 0: unset, 1: compact, 2: large */
592 enum channel_type channel_type
;
593 int syscall_all_entry
;
594 int syscall_all_exit
;
595 unsigned int metadata_dumped
:1,
596 sys_enter_registered
:1,
597 sys_exit_registered
:1,
598 tstate
:1; /* Transient enable state */
601 struct lttng_metadata_stream
{
602 void *priv
; /* Ring buffer private data */
603 struct lttng_metadata_cache
*metadata_cache
;
604 unsigned int metadata_in
; /* Bytes read from the cache */
605 unsigned int metadata_out
; /* Bytes consumed from stream */
606 int finalized
; /* Has channel been finalized */
607 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
608 struct list_head list
; /* Stream list */
609 struct lttng_transport
*transport
;
610 uint64_t version
; /* Current version of the metadata cache */
611 bool coherent
; /* Stream in a coherent state */
614 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
616 struct lttng_dynamic_len_stack
{
617 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
621 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
624 * struct lttng_id_tracker declared in header due to deferencing of *v
625 * in RCU_INITIALIZER(v).
627 #define LTTNG_ID_HASH_BITS 6
628 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
641 struct lttng_id_tracker_rcu
{
642 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
645 struct lttng_id_tracker
{
646 struct lttng_session
*session
;
647 enum tracker_type tracker_type
;
648 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
651 struct lttng_id_hash_node
{
652 struct hlist_node hlist
;
656 struct lttng_session
{
657 int active
; /* Is trace session active ? */
658 int been_active
; /* Has trace session been active ? */
659 struct file
*file
; /* File associated to session */
660 struct list_head chan
; /* Channel list head */
661 struct list_head events
; /* Event list head */
662 struct list_head list
; /* Session list */
663 unsigned int free_chan_id
; /* Next chan ID to allocate */
664 uuid_le uuid
; /* Trace session unique ID */
665 struct lttng_metadata_cache
*metadata_cache
;
666 struct lttng_id_tracker pid_tracker
;
667 struct lttng_id_tracker vpid_tracker
;
668 struct lttng_id_tracker uid_tracker
;
669 struct lttng_id_tracker vuid_tracker
;
670 struct lttng_id_tracker gid_tracker
;
671 struct lttng_id_tracker vgid_tracker
;
672 unsigned int metadata_dumped
:1,
673 tstate
:1; /* Transient enable state */
674 /* List of event enablers */
675 struct list_head enablers_head
;
676 /* Hash table of events */
677 struct lttng_event_ht events_ht
;
678 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
679 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
682 struct lttng_counter
{
683 struct file
*file
; /* File associated to counter. */
685 struct lttng_counter_transport
*transport
;
686 struct lib_counter
*counter
;
687 struct lttng_counter_ops
*ops
;
690 struct lttng_event_notifier_group
{
691 struct file
*file
; /* File associated to event notifier group */
692 struct file
*notif_file
; /* File used to expose notifications to userspace. */
693 struct list_head node
; /* event notifier group list */
694 struct list_head enablers_head
; /* List of enablers */
695 struct list_head event_notifiers_head
; /* List of event notifier */
696 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
697 struct lttng_ctx
*ctx
; /* Contexts for filters. */
698 struct lttng_channel_ops
*ops
;
699 struct lttng_transport
*transport
;
700 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
701 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
702 wait_queue_head_t read_wait
;
703 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
704 struct lttng_event_notifier
*sc_unknown
; /* for unknown syscalls */
705 struct lttng_event_notifier
*sc_compat_unknown
;
707 struct lttng_syscall_filter
*sc_filter
;
709 struct hlist_head
*event_notifier_syscall_dispatch
;
710 struct hlist_head
*event_notifier_compat_syscall_dispatch
;
711 struct hlist_head
*event_notifier_exit_syscall_dispatch
;
712 struct hlist_head
*event_notifier_exit_compat_syscall_dispatch
;
714 struct hlist_head event_notifier_unknown_syscall_dispatch
;
715 struct hlist_head event_notifier_compat_unknown_syscall_dispatch
;
716 struct hlist_head event_notifier_exit_unknown_syscall_dispatch
;
717 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch
;
719 int syscall_all_entry
;
720 int syscall_all_exit
;
722 unsigned int sys_enter_registered
:1, sys_exit_registered
:1;
724 struct lttng_counter
*error_counter
;
725 size_t error_counter_len
;
728 struct lttng_metadata_cache
{
729 char *data
; /* Metadata cache */
730 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
731 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
732 atomic_t producing
; /* Metadata being produced (incomplete) */
733 struct kref refcount
; /* Metadata cache usage */
734 struct list_head metadata_stream
; /* Metadata stream list */
735 uuid_le uuid
; /* Trace session unique ID (copy) */
736 struct mutex lock
; /* Produce/consume lock */
737 uint64_t version
; /* Current version of the metadata */
740 void lttng_lock_sessions(void);
741 void lttng_unlock_sessions(void);
743 struct list_head
*lttng_get_probe_list_head(void);
745 struct lttng_event_enabler
*lttng_event_enabler_create(
746 enum lttng_enabler_format_type format_type
,
747 struct lttng_kernel_event
*event_param
,
748 struct lttng_channel
*chan
);
750 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
751 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
752 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
753 struct lttng_event_notifier_group
*event_notifier_group
,
754 enum lttng_enabler_format_type format_type
,
755 struct lttng_kernel_event_notifier
*event_notifier_param
);
757 int lttng_event_notifier_enabler_enable(
758 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
759 int lttng_event_notifier_enabler_disable(
760 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
761 int lttng_fix_pending_events(void);
762 int lttng_fix_pending_event_notifiers(void);
763 int lttng_session_active(void);
764 bool lttng_event_notifier_active(void);
766 struct lttng_session
*lttng_session_create(void);
767 int lttng_session_enable(struct lttng_session
*session
);
768 int lttng_session_disable(struct lttng_session
*session
);
769 void lttng_session_destroy(struct lttng_session
*session
);
770 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
771 int lttng_session_statedump(struct lttng_session
*session
);
772 void metadata_cache_destroy(struct kref
*kref
);
774 struct lttng_counter
*lttng_kernel_counter_create(
775 const char *counter_transport_name
, size_t number_dimensions
,
776 const size_t *dimensions_sizes
);
777 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
778 const size_t *dimension_indexes
, int32_t cpu
,
779 int64_t *val
, bool *overflow
, bool *underflow
);
780 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
781 const size_t *dimension_indexes
, int64_t *val
,
782 bool *overflow
, bool *underflow
);
783 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
784 const size_t *dimension_indexes
);
787 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
788 int lttng_event_notifier_group_create_error_counter(
789 struct file
*event_notifier_group_file
,
790 const struct lttng_kernel_counter_conf
*error_counter_conf
);
791 void lttng_event_notifier_group_destroy(
792 struct lttng_event_notifier_group
*event_notifier_group
);
794 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
795 const char *transport_name
,
797 size_t subbuf_size
, size_t num_subbuf
,
798 unsigned int switch_timer_interval
,
799 unsigned int read_timer_interval
,
800 enum channel_type channel_type
);
801 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
802 int overwrite
, void *buf_addr
,
803 size_t subbuf_size
, size_t num_subbuf
,
804 unsigned int switch_timer_interval
,
805 unsigned int read_timer_interval
);
807 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
808 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
809 struct lttng_kernel_event
*event_param
,
811 const struct lttng_event_desc
*event_desc
,
812 enum lttng_kernel_instrumentation itype
);
813 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
814 struct lttng_kernel_event
*event_param
,
816 const struct lttng_event_desc
*event_desc
,
817 enum lttng_kernel_instrumentation itype
);
818 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
819 struct lttng_kernel_old_event
*old_event_param
,
821 const struct lttng_event_desc
*internal_desc
);
823 struct lttng_event_notifier
*lttng_event_notifier_create(
824 const struct lttng_event_desc
*event_notifier_desc
,
826 uint64_t error_counter_idx
,
827 struct lttng_event_notifier_group
*event_notifier_group
,
828 struct lttng_kernel_event_notifier
*event_notifier_param
,
830 enum lttng_kernel_instrumentation itype
);
831 struct lttng_event_notifier
*_lttng_event_notifier_create(
832 const struct lttng_event_desc
*event_notifier_desc
,
834 uint64_t error_counter_idx
,
835 struct lttng_event_notifier_group
*event_notifier_group
,
836 struct lttng_kernel_event_notifier
*event_notifier_param
,
838 enum lttng_kernel_instrumentation itype
);
840 int lttng_channel_enable(struct lttng_channel
*channel
);
841 int lttng_channel_disable(struct lttng_channel
*channel
);
842 int lttng_event_enable(struct lttng_event
*event
);
843 int lttng_event_disable(struct lttng_event
*event
);
845 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
);
846 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
);
848 void lttng_transport_register(struct lttng_transport
*transport
);
849 void lttng_transport_unregister(struct lttng_transport
*transport
);
851 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
);
852 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
);
854 void synchronize_trace(void);
855 int lttng_abi_init(void);
856 int lttng_abi_compat_old_init(void);
857 void lttng_abi_exit(void);
858 void lttng_abi_compat_old_exit(void);
860 int lttng_probe_register(struct lttng_probe_desc
*desc
);
861 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
862 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
863 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
864 int lttng_probes_init(void);
865 void lttng_probes_exit(void);
867 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
868 struct channel
*chan
, bool *coherent
);
870 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
871 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
872 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
873 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
874 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
875 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
877 int lttng_session_track_id(struct lttng_session
*session
,
878 enum tracker_type tracker_type
, int id
);
879 int lttng_session_untrack_id(struct lttng_session
*session
,
880 enum tracker_type tracker_type
, int id
);
882 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
883 enum tracker_type tracker_type
);
885 void lttng_clock_ref(void);
886 void lttng_clock_unref(void);
888 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
889 struct lttng_enabler
*enabler
);
891 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
892 int lttng_syscalls_register_event(struct lttng_event_enabler
*event_enabler
, void *filter
);
893 int lttng_syscalls_unregister_channel(struct lttng_channel
*chan
);
894 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
895 int lttng_syscall_filter_enable_event(
896 struct lttng_channel
*chan
,
897 struct lttng_event
*event
);
898 int lttng_syscall_filter_disable_event(
899 struct lttng_channel
*chan
,
900 struct lttng_event
*event
);
902 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
903 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
905 int lttng_syscalls_register_event_notifier(
906 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
908 int lttng_syscals_create_matching_event_notifiers(
909 struct lttng_event_notifier_enabler
*event_notifier_enabler
, void *filter
);
910 int lttng_syscalls_unregister_event_notifier_group(struct lttng_event_notifier_group
*group
);
911 int lttng_syscall_filter_enable_event_notifier(struct lttng_event_notifier
*event_notifier
);
912 int lttng_syscall_filter_disable_event_notifier(struct lttng_event_notifier
*event_notifier
);
914 static inline int lttng_syscalls_register_event(
915 struct lttng_event_enabler
*event_enabler
, void *filter
)
920 static inline int lttng_syscalls_unregister_channel(struct lttng_channel
*chan
)
925 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
930 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
931 struct lttng_event
*event
);
936 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
937 struct lttng_event
*event
);
942 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
943 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
948 static inline int lttng_syscalls_register_event_notifier(
949 struct lttng_event_notifier_group
*group
, void *filter
)
954 static inline int lttng_syscalls_unregister_event_notifier_group(
955 struct lttng_event_notifier_group
*group
)
960 static inline int lttng_syscall_filter_enable_event_notifier(
961 struct lttng_event_notifier_group
*group
,
967 static inline int lttng_syscall_filter_disable_event_notifier(
968 struct lttng_event_notifier_group
*group
,
976 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
977 struct lttng_kernel_filter_bytecode __user
*bytecode
);
978 int lttng_event_notifier_enabler_attach_filter_bytecode(
979 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
980 struct lttng_kernel_filter_bytecode __user
*bytecode
);
981 int lttng_event_notifier_enabler_attach_capture_bytecode(
982 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
983 struct lttng_kernel_capture_bytecode __user
*bytecode
);
985 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
986 struct lttng_ctx
*ctx
,
987 struct list_head
*instance_bytecode_runtime_head
,
988 struct list_head
*enabler_bytecode_runtime_head
);
990 int lttng_probes_init(void);
992 extern struct lttng_ctx
*lttng_static_ctx
;
994 int lttng_context_init(void);
995 void lttng_context_exit(void);
996 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
997 ssize_t
lttng_append_context_index(struct lttng_ctx
**ctx_p
);
998 struct lttng_ctx_field
*lttng_get_context_field_from_index(struct lttng_ctx
*ctx
,
1000 void lttng_context_update(struct lttng_ctx
*ctx
);
1001 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
1002 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
1003 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
1004 struct lttng_ctx_field
*field
);
1005 void lttng_remove_context_field_index(struct lttng_ctx
**ctx_p
, size_t index
);
1006 void lttng_destroy_context(struct lttng_ctx
*ctx
);
1007 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
1008 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
1009 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
1010 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
1011 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
1012 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
1013 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
1014 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
1015 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
1016 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
1017 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
1018 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
1019 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
1020 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
1021 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
1024 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
1029 #ifdef CONFIG_PREEMPT_RT_FULL
1030 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
1033 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
1039 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
1041 #if defined(CONFIG_CGROUPS) && \
1042 ((LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,6,0)) || \
1043 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
1044 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
1047 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
1053 #if defined(CONFIG_IPC_NS) && \
1054 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1055 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
1058 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
1064 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
1065 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1066 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
1069 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
1075 #if defined(CONFIG_NET_NS) && \
1076 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1077 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
1080 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
1086 #if defined(CONFIG_PID_NS) && \
1087 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1088 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
1091 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
1097 #if defined(CONFIG_USER_NS) && \
1098 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1099 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
1102 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
1108 #if defined(CONFIG_UTS_NS) && \
1109 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
1110 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
1113 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
1119 #if defined(CONFIG_TIME_NS) && \
1120 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,6,0))
1121 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
);
1124 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
)
1130 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
1131 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
1132 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
1133 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
1134 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
1135 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
1136 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
1137 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
1138 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
1139 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
1140 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
1141 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
1143 #if defined(CONFIG_PERF_EVENTS)
1144 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1147 struct lttng_ctx
**ctx
);
1148 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1149 struct lttng_cpuhp_node
*node
);
1150 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1151 struct lttng_cpuhp_node
*node
);
1154 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1157 struct lttng_ctx
**ctx
)
1162 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1163 struct lttng_cpuhp_node
*node
)
1168 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1169 struct lttng_cpuhp_node
*node
)
1175 int lttng_logger_init(void);
1176 void lttng_logger_exit(void);
1178 extern int lttng_statedump_start(struct lttng_session
*session
);
1180 #ifdef CONFIG_KPROBES
1181 int lttng_kprobes_register_event(const char *name
,
1182 const char *symbol_name
,
1185 struct lttng_event
*event
);
1186 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1187 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1188 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1191 struct lttng_event_notifier
*event_notifier
);
1192 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1193 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1196 int lttng_kprobes_register_event(const char *name
,
1197 const char *symbol_name
,
1200 struct lttng_event
*event
)
1206 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1211 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1216 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1219 struct lttng_event_notifier
*event_notifier
)
1225 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1230 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1235 int lttng_event_add_callsite(struct lttng_event
*event
,
1236 struct lttng_kernel_event_callsite
*callsite
);
1238 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1239 struct lttng_kernel_event_callsite
*callsite
);
1241 #ifdef CONFIG_UPROBES
1242 int lttng_uprobes_register_event(const char *name
,
1243 int fd
, struct lttng_event
*event
);
1244 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1245 struct lttng_kernel_event_callsite
*callsite
);
1246 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1247 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1248 int lttng_uprobes_register_event_notifier(const char *name
,
1249 int fd
, struct lttng_event_notifier
*event_notifier
);
1250 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1251 struct lttng_kernel_event_callsite
*callsite
);
1252 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1253 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1256 int lttng_uprobes_register_event(const char *name
,
1257 int fd
, struct lttng_event
*event
)
1263 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1264 struct lttng_kernel_event_callsite
*callsite
)
1270 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1275 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1280 int lttng_uprobes_register_event_notifier(const char *name
,
1281 int fd
, struct lttng_event_notifier
*event_notifier
)
1287 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1288 struct lttng_kernel_event_callsite
*callsite
)
1294 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1299 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1304 #ifdef CONFIG_KRETPROBES
1305 int lttng_kretprobes_register(const char *name
,
1306 const char *symbol_name
,
1309 struct lttng_event
*event_entry
,
1310 struct lttng_event
*event_exit
);
1311 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1312 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1313 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1317 int lttng_kretprobes_register(const char *name
,
1318 const char *symbol_name
,
1321 struct lttng_event
*event_entry
,
1322 struct lttng_event
*event_exit
)
1328 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1333 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1338 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1345 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1347 extern const struct file_operations lttng_tracepoint_list_fops
;
1348 extern const struct file_operations lttng_syscall_list_fops
;
1350 #define TRACEPOINT_HAS_DATA_ARG
1352 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1354 if (type
->atype
!= atype_integer
)
1356 switch (type
->u
.integer
.size
) {
1357 case 8: /* Fall-through. */
1358 case 16: /* Fall-through. */
1359 case 32: /* Fall-through. */
1368 #endif /* _LTTNG_EVENTS_H */