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 struct lttng_filter_bytecode_node
{
236 struct list_head node
;
237 struct lttng_enabler
*enabler
;
239 * struct lttng_kernel_filter_bytecode has var. sized array, must be
242 struct lttng_kernel_filter_bytecode bc
;
246 * Filter return value masks.
248 enum lttng_filter_ret
{
249 LTTNG_FILTER_DISCARD
= 0,
250 LTTNG_FILTER_RECORD_FLAG
= (1ULL << 0),
251 /* Other bits are kept for future use. */
254 struct lttng_bytecode_runtime
{
255 /* Associated bytecode */
256 struct lttng_filter_bytecode_node
*bc
;
257 uint64_t (*filter
)(void *filter_data
, struct lttng_probe_ctx
*lttng_probe_ctx
,
258 const char *filter_stack_data
);
260 struct list_head node
; /* list of bytecode runtime in event */
261 struct lttng_ctx
*ctx
;
265 * Objects in a linked-list of enablers, owned by an event.
267 struct lttng_enabler_ref
{
268 struct list_head node
; /* enabler ref list */
269 struct lttng_enabler
*ref
; /* backward ref */
272 struct lttng_uprobe_handler
{
274 struct lttng_event
*event
;
275 struct lttng_event_notifier
*event_notifier
;
278 struct uprobe_consumer up_consumer
;
279 struct list_head node
;
282 struct lttng_kprobe
{
287 struct lttng_uprobe
{
289 struct list_head head
;
292 enum lttng_syscall_entryexit
{
297 enum lttng_syscall_abi
{
298 LTTNG_SYSCALL_ABI_NATIVE
,
299 LTTNG_SYSCALL_ABI_COMPAT
,
303 * lttng_event structure is referred to by the tracing fast path. It must be
307 enum lttng_event_type evtype
; /* First field. */
309 struct lttng_channel
*chan
;
311 const struct lttng_event_desc
*desc
;
313 struct lttng_ctx
*ctx
;
314 enum lttng_kernel_instrumentation instrumentation
;
316 struct lttng_kprobe kprobe
;
318 struct lttng_krp
*lttng_krp
;
321 struct lttng_uprobe uprobe
;
323 enum lttng_syscall_entryexit entryexit
;
324 enum lttng_syscall_abi abi
;
327 struct list_head list
; /* Event list in session */
328 unsigned int metadata_dumped
:1;
330 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
331 struct list_head enablers_ref_head
;
332 struct hlist_node hlist
; /* session ht of events */
333 int registered
; /* has reg'd tracepoint probe */
334 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
335 struct list_head bytecode_runtime_head
;
336 int has_enablers_without_bytecode
;
339 // FIXME: Really similar to lttng_event above. Could those be merged ?
340 struct lttng_event_notifier
{
341 enum lttng_event_type evtype
; /* First field. */
344 int registered
; /* has reg'd tracepoint probe */
345 const struct lttng_event_desc
*desc
;
347 struct list_head list
; /* event_notifier list in event_notifier group */
349 enum lttng_kernel_instrumentation instrumentation
;
351 struct lttng_kprobe kprobe
;
352 struct lttng_uprobe uprobe
;
354 enum lttng_syscall_entryexit entryexit
;
355 enum lttng_syscall_abi abi
;
356 struct hlist_node node
; /* chain registered syscall event_notifier */
357 unsigned int syscall_id
;
362 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
363 struct list_head enablers_ref_head
;
364 struct hlist_node hlist
; /* session ht of event_notifiers */
365 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
366 struct list_head bytecode_runtime_head
;
367 int has_enablers_without_bytecode
;
369 void (*send_notification
)(struct lttng_event_notifier
*event_notifier
);
370 struct lttng_event_notifier_group
*group
; /* Weak ref */
373 enum lttng_enabler_format_type
{
374 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
375 LTTNG_ENABLER_FORMAT_NAME
,
379 * Enabler field, within whatever object is enabling an event. Target of
380 * backward reference.
382 struct lttng_enabler
{
383 enum lttng_event_type evtype
; /* First field. */
385 enum lttng_enabler_format_type format_type
;
387 /* head list of struct lttng_ust_filter_bytecode_node */
388 struct list_head filter_bytecode_head
;
390 struct lttng_kernel_event event_param
;
391 unsigned int enabled
:1;
393 uint64_t user_token
; /* User-provided token. */
396 struct lttng_event_enabler
{
397 struct lttng_enabler base
;
398 struct list_head node
; /* per-session list of enablers */
399 struct lttng_channel
*chan
;
401 * Unused, but kept around to make it explicit that the tracer can do
404 struct lttng_ctx
*ctx
;
407 struct lttng_event_notifier_enabler
{
408 struct lttng_enabler base
;
409 struct list_head node
; /* List of event_notifier enablers */
410 struct lttng_event_notifier_group
*group
;
414 struct lttng_enabler
*lttng_event_enabler_as_enabler(
415 struct lttng_event_enabler
*event_enabler
)
417 return &event_enabler
->base
;
421 struct lttng_enabler
*lttng_event_notifier_enabler_as_enabler(
422 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
424 return &event_notifier_enabler
->base
;
427 struct lttng_channel_ops
{
428 struct channel
*(*channel_create
)(const char *name
,
431 size_t subbuf_size
, size_t num_subbuf
,
432 unsigned int switch_timer_interval
,
433 unsigned int read_timer_interval
);
434 void (*channel_destroy
)(struct channel
*chan
);
435 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
436 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
437 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
438 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
440 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
441 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
443 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
444 const void *src
, size_t len
);
445 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
447 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
449 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
450 const char __user
*src
, size_t len
);
452 * packet_avail_size returns the available size in the current
453 * packet. Note that the size returned is only a hint, since it
454 * may change due to concurrent writes.
456 size_t (*packet_avail_size
)(struct channel
*chan
);
457 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
458 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
459 int (*is_finalized
)(struct channel
*chan
);
460 int (*is_disabled
)(struct channel
*chan
);
461 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
462 struct lib_ring_buffer
*bufb
,
463 uint64_t *timestamp_begin
);
464 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
465 struct lib_ring_buffer
*bufb
,
466 uint64_t *timestamp_end
);
467 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
468 struct lib_ring_buffer
*bufb
,
469 uint64_t *events_discarded
);
470 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
471 struct lib_ring_buffer
*bufb
,
472 uint64_t *content_size
);
473 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
474 struct lib_ring_buffer
*bufb
,
475 uint64_t *packet_size
);
476 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
477 struct lib_ring_buffer
*bufb
,
478 uint64_t *stream_id
);
479 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
480 struct lib_ring_buffer
*bufb
,
482 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
483 struct lib_ring_buffer
*bufb
,
485 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
486 struct lib_ring_buffer
*bufb
,
490 struct lttng_transport
{
492 struct module
*owner
;
493 struct list_head node
;
494 struct lttng_channel_ops ops
;
497 struct lttng_syscall_filter
;
499 #define LTTNG_EVENT_HT_BITS 12
500 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
502 struct lttng_event_ht
{
503 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
506 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
507 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
509 struct lttng_event_notifier_ht
{
510 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
513 struct lttng_channel
{
515 struct channel
*chan
; /* Channel buffers */
517 struct lttng_ctx
*ctx
;
518 /* Event ID management */
519 struct lttng_session
*session
;
520 struct file
*file
; /* File associated to channel */
521 unsigned int free_event_id
; /* Next event ID to allocate */
522 struct list_head list
; /* Channel list */
523 struct lttng_channel_ops
*ops
;
524 struct lttng_transport
*transport
;
525 struct lttng_event
**sc_table
; /* for syscall tracing */
526 struct lttng_event
**compat_sc_table
;
527 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
528 struct lttng_event
**compat_sc_exit_table
;
529 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
530 struct lttng_event
*sc_compat_unknown
;
531 struct lttng_event
*sc_exit_unknown
;
532 struct lttng_event
*compat_sc_exit_unknown
;
533 struct lttng_syscall_filter
*sc_filter
;
534 int header_type
; /* 0: unset, 1: compact, 2: large */
535 enum channel_type channel_type
;
537 unsigned int metadata_dumped
:1,
538 sys_enter_registered
:1,
539 sys_exit_registered
:1,
540 tstate
:1; /* Transient enable state */
543 struct lttng_metadata_stream
{
544 void *priv
; /* Ring buffer private data */
545 struct lttng_metadata_cache
*metadata_cache
;
546 unsigned int metadata_in
; /* Bytes read from the cache */
547 unsigned int metadata_out
; /* Bytes consumed from stream */
548 int finalized
; /* Has channel been finalized */
549 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
550 struct list_head list
; /* Stream list */
551 struct lttng_transport
*transport
;
552 uint64_t version
; /* Current version of the metadata cache */
553 bool coherent
; /* Stream in a coherent state */
556 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
558 struct lttng_dynamic_len_stack
{
559 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
563 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
566 * struct lttng_id_tracker declared in header due to deferencing of *v
567 * in RCU_INITIALIZER(v).
569 #define LTTNG_ID_HASH_BITS 6
570 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
583 struct lttng_id_tracker_rcu
{
584 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
587 struct lttng_id_tracker
{
588 struct lttng_session
*session
;
589 enum tracker_type tracker_type
;
590 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
593 struct lttng_id_hash_node
{
594 struct hlist_node hlist
;
598 struct lttng_session
{
599 int active
; /* Is trace session active ? */
600 int been_active
; /* Has trace session been active ? */
601 struct file
*file
; /* File associated to session */
602 struct list_head chan
; /* Channel list head */
603 struct list_head events
; /* Event list head */
604 struct list_head list
; /* Session list */
605 unsigned int free_chan_id
; /* Next chan ID to allocate */
606 uuid_le uuid
; /* Trace session unique ID */
607 struct lttng_metadata_cache
*metadata_cache
;
608 struct lttng_id_tracker pid_tracker
;
609 struct lttng_id_tracker vpid_tracker
;
610 struct lttng_id_tracker uid_tracker
;
611 struct lttng_id_tracker vuid_tracker
;
612 struct lttng_id_tracker gid_tracker
;
613 struct lttng_id_tracker vgid_tracker
;
614 unsigned int metadata_dumped
:1,
615 tstate
:1; /* Transient enable state */
616 /* List of event enablers */
617 struct list_head enablers_head
;
618 /* Hash table of events */
619 struct lttng_event_ht events_ht
;
620 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
621 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
624 struct lttng_event_notifier_group
{
625 struct file
*file
; /* File associated to event notifier group */
626 struct file
*notif_file
; /* File used to expose notifications to userspace. */
627 struct list_head node
; /* event notifier group list */
628 struct list_head enablers_head
; /* List of enablers */
629 struct list_head event_notifiers_head
; /* List of event notifier */
630 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
631 struct lttng_ctx
*ctx
; /* Contexts for filters. */
632 struct lttng_channel_ops
*ops
;
633 struct lttng_transport
*transport
;
634 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
635 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
636 wait_queue_head_t read_wait
;
637 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
638 struct lttng_event_notifier
*sc_unknown
; /* for unknown syscalls */
639 struct lttng_event_notifier
*sc_compat_unknown
;
641 struct lttng_syscall_filter
*sc_filter
;
643 struct hlist_head
*event_notifier_syscall_dispatch
;
644 struct hlist_head
*event_notifier_compat_syscall_dispatch
;
645 struct hlist_head
*event_notifier_exit_syscall_dispatch
;
646 struct hlist_head
*event_notifier_exit_compat_syscall_dispatch
;
648 struct hlist_head event_notifier_unknown_syscall_dispatch
;
649 struct hlist_head event_notifier_compat_unknown_syscall_dispatch
;
650 struct hlist_head event_notifier_exit_unknown_syscall_dispatch
;
651 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch
;
653 int syscall_all_entry
;
654 int syscall_all_exit
;
656 unsigned int sys_enter_registered
:1, sys_exit_registered
:1;
658 struct lttng_counter
*error_counter
;
659 size_t error_counter_len
;
662 struct lttng_metadata_cache
{
663 char *data
; /* Metadata cache */
664 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
665 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
666 atomic_t producing
; /* Metadata being produced (incomplete) */
667 struct kref refcount
; /* Metadata cache usage */
668 struct list_head metadata_stream
; /* Metadata stream list */
669 uuid_le uuid
; /* Trace session unique ID (copy) */
670 struct mutex lock
; /* Produce/consume lock */
671 uint64_t version
; /* Current version of the metadata */
674 void lttng_lock_sessions(void);
675 void lttng_unlock_sessions(void);
677 struct list_head
*lttng_get_probe_list_head(void);
679 struct lttng_event_enabler
*lttng_event_enabler_create(
680 enum lttng_enabler_format_type format_type
,
681 struct lttng_kernel_event
*event_param
,
682 struct lttng_channel
*chan
);
684 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
685 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
686 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
687 struct lttng_event_notifier_group
*event_notifier_group
,
688 enum lttng_enabler_format_type format_type
,
689 struct lttng_kernel_event_notifier
*event_notifier_param
);
691 int lttng_event_notifier_enabler_enable(
692 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
693 int lttng_event_notifier_enabler_disable(
694 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
695 int lttng_fix_pending_events(void);
696 int lttng_fix_pending_event_notifiers(void);
697 int lttng_session_active(void);
698 bool lttng_event_notifier_active(void);
700 struct lttng_session
*lttng_session_create(void);
701 int lttng_session_enable(struct lttng_session
*session
);
702 int lttng_session_disable(struct lttng_session
*session
);
703 void lttng_session_destroy(struct lttng_session
*session
);
704 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
705 int lttng_session_statedump(struct lttng_session
*session
);
706 void metadata_cache_destroy(struct kref
*kref
);
708 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
709 void lttng_event_notifier_group_destroy(
710 struct lttng_event_notifier_group
*event_notifier_group
);
712 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
713 const char *transport_name
,
715 size_t subbuf_size
, size_t num_subbuf
,
716 unsigned int switch_timer_interval
,
717 unsigned int read_timer_interval
,
718 enum channel_type channel_type
);
719 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
720 int overwrite
, void *buf_addr
,
721 size_t subbuf_size
, size_t num_subbuf
,
722 unsigned int switch_timer_interval
,
723 unsigned int read_timer_interval
);
725 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
726 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
727 struct lttng_kernel_event
*event_param
,
729 const struct lttng_event_desc
*event_desc
,
730 enum lttng_kernel_instrumentation itype
);
731 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
732 struct lttng_kernel_event
*event_param
,
734 const struct lttng_event_desc
*event_desc
,
735 enum lttng_kernel_instrumentation itype
);
736 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
737 struct lttng_kernel_old_event
*old_event_param
,
739 const struct lttng_event_desc
*internal_desc
);
741 struct lttng_event_notifier
*lttng_event_notifier_create(
742 const struct lttng_event_desc
*event_notifier_desc
,
744 struct lttng_event_notifier_group
*event_notifier_group
,
745 struct lttng_kernel_event_notifier
*event_notifier_param
,
747 enum lttng_kernel_instrumentation itype
);
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
);
756 int lttng_channel_enable(struct lttng_channel
*channel
);
757 int lttng_channel_disable(struct lttng_channel
*channel
);
758 int lttng_event_enable(struct lttng_event
*event
);
759 int lttng_event_disable(struct lttng_event
*event
);
761 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
);
762 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
);
764 void lttng_transport_register(struct lttng_transport
*transport
);
765 void lttng_transport_unregister(struct lttng_transport
*transport
);
767 void synchronize_trace(void);
768 int lttng_abi_init(void);
769 int lttng_abi_compat_old_init(void);
770 void lttng_abi_exit(void);
771 void lttng_abi_compat_old_exit(void);
773 int lttng_probe_register(struct lttng_probe_desc
*desc
);
774 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
775 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
776 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
777 int lttng_probes_init(void);
778 void lttng_probes_exit(void);
780 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
781 struct channel
*chan
, bool *coherent
);
783 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
784 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
785 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
786 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
787 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
788 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
790 int lttng_session_track_id(struct lttng_session
*session
,
791 enum tracker_type tracker_type
, int id
);
792 int lttng_session_untrack_id(struct lttng_session
*session
,
793 enum tracker_type tracker_type
, int id
);
795 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
796 enum tracker_type tracker_type
);
798 void lttng_clock_ref(void);
799 void lttng_clock_unref(void);
801 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
802 struct lttng_enabler
*enabler
);
804 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
805 int lttng_syscalls_register_event(struct lttng_channel
*chan
, void *filter
);
806 int lttng_syscalls_unregister_event(struct lttng_channel
*chan
);
807 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
808 int lttng_syscall_filter_enable_event(
809 struct lttng_channel
*chan
,
810 struct lttng_event
*event
);
811 int lttng_syscall_filter_disable_event(
812 struct lttng_channel
*chan
,
813 struct lttng_event
*event
);
815 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
816 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
818 int lttng_syscalls_register_event_notifier(
819 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
821 int lttng_syscals_create_matching_event_notifiers(
822 struct lttng_event_notifier_enabler
*event_notifier_enabler
, void *filter
);
823 int lttng_syscalls_unregister_event_notifier(struct lttng_event_notifier_group
*group
);
824 int lttng_syscall_filter_enable_event_notifier(struct lttng_event_notifier
*event_notifier
);
825 int lttng_syscall_filter_disable_event_notifier(struct lttng_event_notifier
*event_notifier
);
827 static inline int lttng_syscalls_register_event(
828 struct lttng_channel
*chan
, void *filter
)
833 static inline int lttng_syscalls_unregister_event(struct lttng_channel
*chan
)
838 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
843 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
844 struct lttng_event
*event
);
849 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
850 struct lttng_event
*event
);
855 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
856 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
861 static inline int lttng_syscalls_register_event_notifier(
862 struct lttng_event_notifier_group
*group
, void *filter
)
867 static inline int lttng_syscalls_unregister_event_notifier(
868 struct lttng_event_notifier_group
*group
)
873 static inline int lttng_syscall_filter_enable_event_notifier(
874 struct lttng_event_notifier_group
*group
,
880 static inline int lttng_syscall_filter_disable_event_notifier(
881 struct lttng_event_notifier_group
*group
,
889 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
890 int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler
*event_enabler
,
891 struct lttng_kernel_filter_bytecode __user
*bytecode
);
892 int lttng_event_notifier_enabler_attach_bytecode(
893 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
894 struct lttng_kernel_filter_bytecode __user
*bytecode
);
896 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
897 struct lttng_ctx
*ctx
,
898 struct list_head
*bytecode_runtime_head
,
899 struct lttng_enabler
*enabler
);
901 int lttng_probes_init(void);
903 extern struct lttng_ctx
*lttng_static_ctx
;
905 int lttng_context_init(void);
906 void lttng_context_exit(void);
907 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
908 ssize_t
lttng_append_context_index(struct lttng_ctx
**ctx_p
);
909 struct lttng_ctx_field
*lttng_get_context_field_from_index(struct lttng_ctx
*ctx
,
911 void lttng_context_update(struct lttng_ctx
*ctx
);
912 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
913 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
914 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
915 struct lttng_ctx_field
*field
);
916 void lttng_remove_context_field_index(struct lttng_ctx
**ctx_p
, size_t index
);
917 void lttng_destroy_context(struct lttng_ctx
*ctx
);
918 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
919 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
920 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
921 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
922 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
923 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
924 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
925 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
926 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
927 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
928 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
929 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
930 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
931 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
932 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
935 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
940 #ifdef CONFIG_PREEMPT_RT_FULL
941 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
944 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
950 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
952 #if defined(CONFIG_CGROUPS) && \
953 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
954 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
955 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
958 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
964 #if defined(CONFIG_IPC_NS) && \
965 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
966 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
969 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
975 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
976 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
977 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
980 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
986 #if defined(CONFIG_NET_NS) && \
987 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
988 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
991 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
997 #if defined(CONFIG_PID_NS) && \
998 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
999 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
1002 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
1008 #if defined(CONFIG_USER_NS) && \
1009 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1010 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
1013 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
1019 #if defined(CONFIG_UTS_NS) && \
1020 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
1021 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
1024 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
1030 #if defined(CONFIG_TIME_NS) && \
1031 (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
1032 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
);
1035 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
)
1041 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
1042 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
1043 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
1044 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
1045 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
1046 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
1047 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
1048 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
1049 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
1050 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
1051 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
1052 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
1054 #if defined(CONFIG_PERF_EVENTS)
1055 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1058 struct lttng_ctx
**ctx
);
1059 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1060 struct lttng_cpuhp_node
*node
);
1061 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1062 struct lttng_cpuhp_node
*node
);
1065 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1068 struct lttng_ctx
**ctx
)
1073 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1074 struct lttng_cpuhp_node
*node
)
1079 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1080 struct lttng_cpuhp_node
*node
)
1086 int lttng_logger_init(void);
1087 void lttng_logger_exit(void);
1089 extern int lttng_statedump_start(struct lttng_session
*session
);
1091 #ifdef CONFIG_KPROBES
1092 int lttng_kprobes_register_event(const char *name
,
1093 const char *symbol_name
,
1096 struct lttng_event
*event
);
1097 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1098 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1099 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1102 struct lttng_event_notifier
*event_notifier
);
1103 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1104 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1107 int lttng_kprobes_register_event(const char *name
,
1108 const char *symbol_name
,
1111 struct lttng_event
*event
)
1117 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1122 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1127 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1130 struct lttng_event_notifier
*event_notifier
)
1136 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1141 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1146 int lttng_event_add_callsite(struct lttng_event
*event
,
1147 struct lttng_kernel_event_callsite
*callsite
);
1149 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1150 struct lttng_kernel_event_callsite
*callsite
);
1152 #ifdef CONFIG_UPROBES
1153 int lttng_uprobes_register_event(const char *name
,
1154 int fd
, struct lttng_event
*event
);
1155 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1156 struct lttng_kernel_event_callsite
*callsite
);
1157 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1158 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1159 int lttng_uprobes_register_event_notifier(const char *name
,
1160 int fd
, struct lttng_event_notifier
*event_notifier
);
1161 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1162 struct lttng_kernel_event_callsite
*callsite
);
1163 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1164 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1167 int lttng_uprobes_register_event(const char *name
,
1168 int fd
, struct lttng_event
*event
)
1174 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1175 struct lttng_kernel_event_callsite
*callsite
)
1181 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1186 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1191 int lttng_uprobes_register_event_notifier(const char *name
,
1192 int fd
, struct lttng_event_notifier
*event_notifier
)
1198 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1199 struct lttng_kernel_event_callsite
*callsite
)
1205 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1210 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1215 #ifdef CONFIG_KRETPROBES
1216 int lttng_kretprobes_register(const char *name
,
1217 const char *symbol_name
,
1220 struct lttng_event
*event_entry
,
1221 struct lttng_event
*event_exit
);
1222 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1223 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1224 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1228 int lttng_kretprobes_register(const char *name
,
1229 const char *symbol_name
,
1232 struct lttng_event
*event_entry
,
1233 struct lttng_event
*event_exit
)
1239 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1244 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1249 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1256 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1258 extern const struct file_operations lttng_tracepoint_list_fops
;
1259 extern const struct file_operations lttng_syscall_list_fops
;
1261 #define TRACEPOINT_HAS_DATA_ARG
1263 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1265 if (type
->atype
!= atype_integer
)
1267 switch (type
->u
.integer
.size
) {
1268 case 8: /* Fall-through. */
1269 case 16: /* Fall-through. */
1270 case 32: /* Fall-through. */
1279 #endif /* _LTTNG_EVENTS_H */