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/irq_work.h>
14 #include <linux/version.h>
15 #include <linux/list.h>
16 #include <linux/kprobes.h>
17 #include <linux/kref.h>
18 #include <linux/uuid.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
;
324 enum lttng_syscall_entryexit entryexit
;
325 enum lttng_syscall_abi abi
;
328 struct list_head list
; /* Event list in session */
329 unsigned int metadata_dumped
:1;
331 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
332 struct list_head enablers_ref_head
;
333 struct hlist_node hlist
; /* session ht of events */
334 int registered
; /* has reg'd tracepoint probe */
335 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
336 struct list_head bytecode_runtime_head
;
337 int has_enablers_without_bytecode
;
340 // FIXME: Really similar to lttng_event above. Could those be merged ?
341 struct lttng_event_notifier
{
342 enum lttng_event_type evtype
; /* First field. */
345 int registered
; /* has reg'd tracepoint probe */
346 const struct lttng_event_desc
*desc
;
348 struct list_head list
; /* event_notifier list in event_notifier group */
350 enum lttng_kernel_instrumentation instrumentation
;
352 struct lttng_kprobe kprobe
;
353 struct lttng_uprobe uprobe
;
356 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
357 struct list_head enablers_ref_head
;
358 struct hlist_node hlist
; /* session ht of event_notifiers */
359 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
360 struct list_head bytecode_runtime_head
;
361 int has_enablers_without_bytecode
;
363 void (*send_notification
)(struct lttng_event_notifier
*event_notifier
);
364 struct lttng_event_notifier_group
*group
; /* Weak ref */
367 enum lttng_enabler_format_type
{
368 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
369 LTTNG_ENABLER_FORMAT_NAME
,
373 * Enabler field, within whatever object is enabling an event. Target of
374 * backward reference.
376 struct lttng_enabler
{
377 enum lttng_event_type evtype
; /* First field. */
379 enum lttng_enabler_format_type format_type
;
381 /* head list of struct lttng_ust_filter_bytecode_node */
382 struct list_head filter_bytecode_head
;
384 struct lttng_kernel_event event_param
;
385 unsigned int enabled
:1;
387 uint64_t user_token
; /* User-provided token. */
390 struct lttng_event_enabler
{
391 struct lttng_enabler base
;
392 struct list_head node
; /* per-session list of enablers */
393 struct lttng_channel
*chan
;
395 * Unused, but kept around to make it explicit that the tracer can do
398 struct lttng_ctx
*ctx
;
401 struct lttng_event_notifier_enabler
{
402 struct lttng_enabler base
;
403 struct list_head node
; /* List of event_notifier enablers */
404 struct lttng_event_notifier_group
*group
;
408 struct lttng_enabler
*lttng_event_enabler_as_enabler(
409 struct lttng_event_enabler
*event_enabler
)
411 return &event_enabler
->base
;
415 struct lttng_enabler
*lttng_event_notifier_enabler_as_enabler(
416 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
418 return &event_notifier_enabler
->base
;
421 struct lttng_channel_ops
{
422 struct channel
*(*channel_create
)(const char *name
,
425 size_t subbuf_size
, size_t num_subbuf
,
426 unsigned int switch_timer_interval
,
427 unsigned int read_timer_interval
);
428 void (*channel_destroy
)(struct channel
*chan
);
429 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
430 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
431 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
432 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
434 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
435 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
437 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
438 const void *src
, size_t len
);
439 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
441 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
443 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
444 const char __user
*src
, size_t len
);
446 * packet_avail_size returns the available size in the current
447 * packet. Note that the size returned is only a hint, since it
448 * may change due to concurrent writes.
450 size_t (*packet_avail_size
)(struct channel
*chan
);
451 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
452 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
453 int (*is_finalized
)(struct channel
*chan
);
454 int (*is_disabled
)(struct channel
*chan
);
455 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
456 struct lib_ring_buffer
*bufb
,
457 uint64_t *timestamp_begin
);
458 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
459 struct lib_ring_buffer
*bufb
,
460 uint64_t *timestamp_end
);
461 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
462 struct lib_ring_buffer
*bufb
,
463 uint64_t *events_discarded
);
464 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
465 struct lib_ring_buffer
*bufb
,
466 uint64_t *content_size
);
467 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
468 struct lib_ring_buffer
*bufb
,
469 uint64_t *packet_size
);
470 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
471 struct lib_ring_buffer
*bufb
,
472 uint64_t *stream_id
);
473 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
474 struct lib_ring_buffer
*bufb
,
476 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
477 struct lib_ring_buffer
*bufb
,
479 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
480 struct lib_ring_buffer
*bufb
,
484 struct lttng_transport
{
486 struct module
*owner
;
487 struct list_head node
;
488 struct lttng_channel_ops ops
;
491 struct lttng_syscall_filter
;
493 #define LTTNG_EVENT_HT_BITS 12
494 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
496 struct lttng_event_ht
{
497 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
500 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
501 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
503 struct lttng_event_notifier_ht
{
504 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
507 struct lttng_channel
{
509 struct channel
*chan
; /* Channel buffers */
511 struct lttng_ctx
*ctx
;
512 /* Event ID management */
513 struct lttng_session
*session
;
514 struct file
*file
; /* File associated to channel */
515 unsigned int free_event_id
; /* Next event ID to allocate */
516 struct list_head list
; /* Channel list */
517 struct lttng_channel_ops
*ops
;
518 struct lttng_transport
*transport
;
519 struct lttng_event
**sc_table
; /* for syscall tracing */
520 struct lttng_event
**compat_sc_table
;
521 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
522 struct lttng_event
**compat_sc_exit_table
;
523 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
524 struct lttng_event
*sc_compat_unknown
;
525 struct lttng_event
*sc_exit_unknown
;
526 struct lttng_event
*compat_sc_exit_unknown
;
527 struct lttng_syscall_filter
*sc_filter
;
528 int header_type
; /* 0: unset, 1: compact, 2: large */
529 enum channel_type channel_type
;
531 unsigned int metadata_dumped
:1,
532 sys_enter_registered
:1,
533 sys_exit_registered
:1,
534 tstate
:1; /* Transient enable state */
537 struct lttng_metadata_stream
{
538 void *priv
; /* Ring buffer private data */
539 struct lttng_metadata_cache
*metadata_cache
;
540 unsigned int metadata_in
; /* Bytes read from the cache */
541 unsigned int metadata_out
; /* Bytes consumed from stream */
542 int finalized
; /* Has channel been finalized */
543 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
544 struct list_head list
; /* Stream list */
545 struct lttng_transport
*transport
;
546 uint64_t version
; /* Current version of the metadata cache */
547 bool coherent
; /* Stream in a coherent state */
550 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
552 struct lttng_dynamic_len_stack
{
553 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
557 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
560 * struct lttng_id_tracker declared in header due to deferencing of *v
561 * in RCU_INITIALIZER(v).
563 #define LTTNG_ID_HASH_BITS 6
564 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
577 struct lttng_id_tracker_rcu
{
578 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
581 struct lttng_id_tracker
{
582 struct lttng_session
*session
;
583 enum tracker_type tracker_type
;
584 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
587 struct lttng_id_hash_node
{
588 struct hlist_node hlist
;
592 struct lttng_session
{
593 int active
; /* Is trace session active ? */
594 int been_active
; /* Has trace session been active ? */
595 struct file
*file
; /* File associated to session */
596 struct list_head chan
; /* Channel list head */
597 struct list_head events
; /* Event list head */
598 struct list_head list
; /* Session list */
599 unsigned int free_chan_id
; /* Next chan ID to allocate */
600 uuid_le uuid
; /* Trace session unique ID */
601 struct lttng_metadata_cache
*metadata_cache
;
602 struct lttng_id_tracker pid_tracker
;
603 struct lttng_id_tracker vpid_tracker
;
604 struct lttng_id_tracker uid_tracker
;
605 struct lttng_id_tracker vuid_tracker
;
606 struct lttng_id_tracker gid_tracker
;
607 struct lttng_id_tracker vgid_tracker
;
608 unsigned int metadata_dumped
:1,
609 tstate
:1; /* Transient enable state */
610 /* List of event enablers */
611 struct list_head enablers_head
;
612 /* Hash table of events */
613 struct lttng_event_ht events_ht
;
614 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
615 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
618 struct lttng_event_notifier_group
{
619 struct file
*file
; /* File associated to event notifier group */
620 struct file
*notif_file
; /* File used to expose notifications to userspace. */
621 struct list_head node
; /* event notifier group list */
622 struct list_head enablers_head
; /* List of enablers */
623 struct list_head event_notifiers_head
; /* List of event notifier */
624 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
625 struct lttng_ctx
*ctx
; /* Contexts for filters. */
626 struct lttng_channel_ops
*ops
;
627 struct lttng_transport
*transport
;
628 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
629 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
630 wait_queue_head_t read_wait
;
631 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
634 struct lttng_metadata_cache
{
635 char *data
; /* Metadata cache */
636 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
637 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
638 atomic_t producing
; /* Metadata being produced (incomplete) */
639 struct kref refcount
; /* Metadata cache usage */
640 struct list_head metadata_stream
; /* Metadata stream list */
641 uuid_le uuid
; /* Trace session unique ID (copy) */
642 struct mutex lock
; /* Produce/consume lock */
643 uint64_t version
; /* Current version of the metadata */
646 void lttng_lock_sessions(void);
647 void lttng_unlock_sessions(void);
649 struct list_head
*lttng_get_probe_list_head(void);
651 struct lttng_event_enabler
*lttng_event_enabler_create(
652 enum lttng_enabler_format_type format_type
,
653 struct lttng_kernel_event
*event_param
,
654 struct lttng_channel
*chan
);
656 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
657 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
658 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
659 struct lttng_event_notifier_group
*event_notifier_group
,
660 enum lttng_enabler_format_type format_type
,
661 struct lttng_kernel_event_notifier
*event_notifier_param
);
663 int lttng_event_notifier_enabler_enable(
664 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
665 int lttng_event_notifier_enabler_disable(
666 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
667 int lttng_fix_pending_events(void);
668 int lttng_fix_pending_event_notifiers(void);
669 int lttng_session_active(void);
670 bool lttng_event_notifier_active(void);
672 struct lttng_session
*lttng_session_create(void);
673 int lttng_session_enable(struct lttng_session
*session
);
674 int lttng_session_disable(struct lttng_session
*session
);
675 void lttng_session_destroy(struct lttng_session
*session
);
676 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
677 int lttng_session_statedump(struct lttng_session
*session
);
678 void metadata_cache_destroy(struct kref
*kref
);
680 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
681 void lttng_event_notifier_group_destroy(
682 struct lttng_event_notifier_group
*event_notifier_group
);
684 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
685 const char *transport_name
,
687 size_t subbuf_size
, size_t num_subbuf
,
688 unsigned int switch_timer_interval
,
689 unsigned int read_timer_interval
,
690 enum channel_type channel_type
);
691 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
692 int overwrite
, void *buf_addr
,
693 size_t subbuf_size
, size_t num_subbuf
,
694 unsigned int switch_timer_interval
,
695 unsigned int read_timer_interval
);
697 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
698 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
699 struct lttng_kernel_event
*event_param
,
701 const struct lttng_event_desc
*event_desc
,
702 enum lttng_kernel_instrumentation itype
);
703 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
704 struct lttng_kernel_event
*event_param
,
706 const struct lttng_event_desc
*event_desc
,
707 enum lttng_kernel_instrumentation itype
);
708 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
709 struct lttng_kernel_old_event
*old_event_param
,
711 const struct lttng_event_desc
*internal_desc
);
713 struct lttng_event_notifier
*lttng_event_notifier_create(
714 const struct lttng_event_desc
*event_notifier_desc
,
716 struct lttng_event_notifier_group
*event_notifier_group
,
717 struct lttng_kernel_event_notifier
*event_notifier_param
,
719 enum lttng_kernel_instrumentation itype
);
720 struct lttng_event_notifier
*_lttng_event_notifier_create(
721 const struct lttng_event_desc
*event_notifier_desc
,
723 struct lttng_event_notifier_group
*event_notifier_group
,
724 struct lttng_kernel_event_notifier
*event_notifier_param
,
726 enum lttng_kernel_instrumentation itype
);
728 int lttng_channel_enable(struct lttng_channel
*channel
);
729 int lttng_channel_disable(struct lttng_channel
*channel
);
730 int lttng_event_enable(struct lttng_event
*event
);
731 int lttng_event_disable(struct lttng_event
*event
);
733 int lttng_event_notifier_enable(struct lttng_event_notifier
*event_notifier
);
734 int lttng_event_notifier_disable(struct lttng_event_notifier
*event_notifier
);
736 void lttng_transport_register(struct lttng_transport
*transport
);
737 void lttng_transport_unregister(struct lttng_transport
*transport
);
739 void synchronize_trace(void);
740 int lttng_abi_init(void);
741 int lttng_abi_compat_old_init(void);
742 void lttng_abi_exit(void);
743 void lttng_abi_compat_old_exit(void);
745 int lttng_probe_register(struct lttng_probe_desc
*desc
);
746 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
747 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
748 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
749 int lttng_probes_init(void);
750 void lttng_probes_exit(void);
752 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
753 struct channel
*chan
, bool *coherent
);
755 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
756 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
757 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
758 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
759 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
760 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
762 int lttng_session_track_id(struct lttng_session
*session
,
763 enum tracker_type tracker_type
, int id
);
764 int lttng_session_untrack_id(struct lttng_session
*session
,
765 enum tracker_type tracker_type
, int id
);
767 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
768 enum tracker_type tracker_type
);
770 void lttng_clock_ref(void);
771 void lttng_clock_unref(void);
773 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
774 int lttng_syscalls_register_event(struct lttng_channel
*chan
, void *filter
);
775 int lttng_syscalls_unregister_event(struct lttng_channel
*chan
);
776 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
777 int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
778 struct lttng_event
*event
);
779 int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
780 struct lttng_event
*event
);
781 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
782 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
785 static inline int lttng_syscalls_register_event(
786 struct lttng_channel
*chan
, void *filter
)
791 static inline int lttng_syscalls_unregister_event(struct lttng_channel
*chan
)
796 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
801 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
802 struct lttng_event
*event
);
807 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
808 struct lttng_event
*event
);
813 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
814 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
821 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
822 int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler
*event_enabler
,
823 struct lttng_kernel_filter_bytecode __user
*bytecode
);
824 int lttng_event_notifier_enabler_attach_bytecode(
825 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
826 struct lttng_kernel_filter_bytecode __user
*bytecode
);
828 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
829 struct lttng_ctx
*ctx
,
830 struct list_head
*bytecode_runtime_head
,
831 struct lttng_enabler
*enabler
);
833 int lttng_probes_init(void);
835 extern struct lttng_ctx
*lttng_static_ctx
;
837 int lttng_context_init(void);
838 void lttng_context_exit(void);
839 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
840 ssize_t
lttng_append_context_index(struct lttng_ctx
**ctx_p
);
841 struct lttng_ctx_field
*lttng_get_context_field_from_index(struct lttng_ctx
*ctx
,
843 void lttng_context_update(struct lttng_ctx
*ctx
);
844 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
845 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
846 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
847 struct lttng_ctx_field
*field
);
848 void lttng_remove_context_field_index(struct lttng_ctx
**ctx_p
, size_t index
);
849 void lttng_destroy_context(struct lttng_ctx
*ctx
);
850 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
851 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
852 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
853 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
854 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
855 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
856 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
857 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
858 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
859 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
860 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
861 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
862 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
863 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
864 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
867 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
872 #ifdef CONFIG_PREEMPT_RT_FULL
873 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
876 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
882 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
884 #if defined(CONFIG_CGROUPS) && \
885 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
886 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
887 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
890 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
896 #if defined(CONFIG_IPC_NS) && \
897 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
898 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
901 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
907 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
908 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
909 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
912 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
918 #if defined(CONFIG_NET_NS) && \
919 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
920 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
923 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
929 #if defined(CONFIG_PID_NS) && \
930 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
931 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
934 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
940 #if defined(CONFIG_USER_NS) && \
941 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
942 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
945 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
951 #if defined(CONFIG_UTS_NS) && \
952 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
953 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
956 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
962 #if defined(CONFIG_TIME_NS) && \
963 (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
964 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
);
967 int lttng_add_time_ns_to_ctx(struct lttng_ctx
**ctx
)
973 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
974 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
975 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
976 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
977 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
978 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
979 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
980 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
981 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
982 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
983 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
984 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
986 #if defined(CONFIG_PERF_EVENTS)
987 int lttng_add_perf_counter_to_ctx(uint32_t type
,
990 struct lttng_ctx
**ctx
);
991 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
992 struct lttng_cpuhp_node
*node
);
993 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
994 struct lttng_cpuhp_node
*node
);
997 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1000 struct lttng_ctx
**ctx
)
1005 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1006 struct lttng_cpuhp_node
*node
)
1011 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1012 struct lttng_cpuhp_node
*node
)
1018 int lttng_logger_init(void);
1019 void lttng_logger_exit(void);
1021 extern int lttng_statedump_start(struct lttng_session
*session
);
1023 #ifdef CONFIG_KPROBES
1024 int lttng_kprobes_register_event(const char *name
,
1025 const char *symbol_name
,
1028 struct lttng_event
*event
);
1029 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1030 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1031 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1034 struct lttng_event_notifier
*event_notifier
);
1035 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1036 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1039 int lttng_kprobes_register_event(const char *name
,
1040 const char *symbol_name
,
1043 struct lttng_event
*event
)
1049 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1054 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1059 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1062 struct lttng_event_notifier
*event_notifier
)
1068 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1073 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1078 int lttng_event_add_callsite(struct lttng_event
*event
,
1079 struct lttng_kernel_event_callsite
*callsite
);
1081 int lttng_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1082 struct lttng_kernel_event_callsite
*callsite
);
1084 #ifdef CONFIG_UPROBES
1085 int lttng_uprobes_register_event(const char *name
,
1086 int fd
, struct lttng_event
*event
);
1087 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1088 struct lttng_kernel_event_callsite
*callsite
);
1089 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1090 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1091 int lttng_uprobes_register_event_notifier(const char *name
,
1092 int fd
, struct lttng_event_notifier
*event_notifier
);
1093 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1094 struct lttng_kernel_event_callsite
*callsite
);
1095 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
);
1096 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
);
1099 int lttng_uprobes_register_event(const char *name
,
1100 int fd
, struct lttng_event
*event
)
1106 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1107 struct lttng_kernel_event_callsite
*callsite
)
1113 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1118 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1123 int lttng_uprobes_register_event_notifier(const char *name
,
1124 int fd
, struct lttng_event_notifier
*event_notifier
)
1130 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier
*event_notifier
,
1131 struct lttng_kernel_event_callsite
*callsite
)
1137 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier
*event_notifier
)
1142 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier
*event_notifier
)
1147 #ifdef CONFIG_KRETPROBES
1148 int lttng_kretprobes_register(const char *name
,
1149 const char *symbol_name
,
1152 struct lttng_event
*event_entry
,
1153 struct lttng_event
*event_exit
);
1154 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1155 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1156 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1160 int lttng_kretprobes_register(const char *name
,
1161 const char *symbol_name
,
1164 struct lttng_event
*event_entry
,
1165 struct lttng_event
*event_exit
)
1171 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1176 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1181 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1188 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1190 extern const struct file_operations lttng_tracepoint_list_fops
;
1191 extern const struct file_operations lttng_syscall_list_fops
;
1193 #define TRACEPOINT_HAS_DATA_ARG
1195 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1197 if (type
->atype
!= atype_integer
)
1199 switch (type
->u
.integer
.size
) {
1200 case 8: /* Fall-through. */
1201 case 16: /* Fall-through. */
1202 case 32: /* Fall-through. */
1211 #endif /* _LTTNG_EVENTS_H */