1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
3 * lttng/events-internal.h
5 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 #ifndef _LTTNG_EVENTS_INTERNAL_H
9 #define _LTTNG_EVENTS_INTERNAL_H
11 #include <wrapper/compiler_attributes.h>
13 #include <lttng/events.h>
15 struct lttng_syscall_filter
;
16 struct lttng_metadata_cache
;
18 struct perf_event_attr
;
19 struct lttng_kernel_ring_buffer_config
;
21 enum lttng_enabler_format_type
{
22 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
23 LTTNG_ENABLER_FORMAT_NAME
,
32 * Objects in a linked-list of enablers, owned by an event.
34 struct lttng_enabler_ref
{
35 struct list_head node
; /* enabler ref list */
36 struct lttng_event_enabler_common
*ref
; /* backward ref */
39 struct lttng_krp
; /* Kretprobe handling */
41 struct lttng_uprobe_handler
{
42 struct lttng_kernel_event_common
*event
;
44 struct uprobe_consumer up_consumer
;
45 struct list_head node
;
55 struct list_head head
;
58 enum lttng_syscall_entryexit
{
63 enum lttng_syscall_abi
{
64 LTTNG_SYSCALL_ABI_NATIVE
,
65 LTTNG_SYSCALL_ABI_COMPAT
,
68 struct lttng_kernel_event_common_private
{
69 struct lttng_kernel_event_common
*pub
; /* Public event interface */
71 const struct lttng_kernel_event_desc
*desc
;
72 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
73 struct list_head enablers_ref_head
;
74 int registered
; /* has reg'd tracepoint probe */
77 int has_enablers_without_filter_bytecode
;
78 /* list of struct lttng_kernel_bytecode_runtime, sorted by seqnum */
79 struct list_head filter_bytecode_runtime_head
;
81 struct hlist_node hlist_node
; /* node in events hash table */
82 struct list_head node
; /* node in event list */
84 enum lttng_kernel_abi_instrumentation instrumentation
;
85 /* Selected by instrumentation */
87 struct lttng_kprobe kprobe
;
88 struct lttng_uprobe uprobe
;
90 struct lttng_krp
*lttng_krp
;
94 enum lttng_syscall_entryexit entryexit
;
95 enum lttng_syscall_abi abi
;
96 struct hlist_node node
; /* chain registered syscall event_notifier */
97 unsigned int syscall_id
;
102 struct lttng_kernel_event_recorder_private
{
103 struct lttng_kernel_event_common_private parent
;
105 struct lttng_kernel_event_recorder
*pub
; /* Public event interface */
106 struct lttng_kernel_ctx
*ctx
;
108 unsigned int metadata_dumped
:1;
111 struct lttng_kernel_event_notifier_private
{
112 struct lttng_kernel_event_common_private parent
;
114 struct lttng_kernel_event_notifier
*pub
; /* Public event notifier interface */
115 struct lttng_event_notifier_group
*group
; /* weak ref */
116 size_t num_captures
; /* Needed to allocate the msgpack array. */
117 uint64_t error_counter_index
;
118 struct list_head capture_bytecode_runtime_head
;
121 struct lttng_kernel_syscall_table
{
122 unsigned int sys_enter_registered
:1,
123 sys_exit_registered
:1;
125 struct hlist_head
*syscall_dispatch
; /* for syscall tracing */
126 struct hlist_head
*compat_syscall_dispatch
;
127 struct hlist_head
*syscall_exit_dispatch
; /* for syscall exit tracing */
128 struct hlist_head
*compat_syscall_exit_dispatch
;
131 * Combining all unknown syscall events works as long as they
132 * are only matched by "all" syscalls enablers, but will require
133 * a design change when we allow matching by syscall number, for
134 * instance by allocating sc_tables accomodating NR_syscalls
137 struct hlist_head unknown_syscall_dispatch
; /* for unknown syscalls */
138 struct hlist_head compat_unknown_syscall_dispatch
;
139 struct hlist_head unknown_syscall_exit_dispatch
;
140 struct hlist_head compat_unknown_syscall_exit_dispatch
;
142 struct lttng_syscall_filter
*sc_filter
;
143 int syscall_all_entry
;
144 int syscall_all_exit
;
147 struct lttng_kernel_channel_common_private
{
148 struct lttng_kernel_channel_common
*pub
;
150 struct file
*file
; /* File associated to channel */
151 unsigned int tstate
:1; /* Transient enable state */
153 struct lttng_kernel_syscall_table syscall_table
;
156 struct lttng_kernel_channel_buffer_private
{
157 struct lttng_kernel_channel_common_private parent
;
159 struct lttng_kernel_channel_buffer
*pub
;
161 unsigned int id
; /* Channel ID */
162 unsigned int free_event_id
; /* Next event ID to allocate */
163 int header_type
; /* 0: unset, 1: compact, 2: large */
165 enum channel_type channel_type
;
166 struct lttng_kernel_ctx
*ctx
;
167 struct lttng_kernel_ring_buffer_channel
*rb_chan
; /* Ring buffer channel */
168 unsigned int metadata_dumped
:1;
169 struct list_head node
; /* Channel list in session */
170 struct lttng_transport
*transport
;
173 enum lttng_kernel_bytecode_interpreter_ret
{
174 LTTNG_KERNEL_BYTECODE_INTERPRETER_ERROR
= -1,
175 LTTNG_KERNEL_BYTECODE_INTERPRETER_OK
= 0,
178 enum lttng_kernel_bytecode_filter_result
{
179 LTTNG_KERNEL_BYTECODE_FILTER_ACCEPT
= 0,
180 LTTNG_KERNEL_BYTECODE_FILTER_REJECT
= 1,
183 struct lttng_kernel_bytecode_filter_ctx
{
184 enum lttng_kernel_bytecode_filter_result result
;
187 struct lttng_interpreter_output
;
189 enum lttng_kernel_bytecode_type
{
190 LTTNG_KERNEL_BYTECODE_TYPE_FILTER
,
191 LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE
,
194 enum lttng_kernel_event_enabler_type
{
195 LTTNG_EVENT_ENABLER_TYPE_RECORDER
,
196 LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
,
199 struct lttng_kernel_bytecode_node
{
200 enum lttng_kernel_bytecode_type type
;
201 struct list_head node
;
202 struct lttng_event_enabler_common
*enabler
;
205 uint32_t reloc_offset
;
211 struct lttng_kernel_bytecode_runtime
{
212 /* Associated bytecode */
213 enum lttng_kernel_bytecode_type type
;
214 struct lttng_kernel_bytecode_node
*bc
;
215 int (*interpreter_func
)(struct lttng_kernel_bytecode_runtime
*kernel_bytecode
,
216 const char *interpreter_stack_data
,
217 struct lttng_kernel_probe_ctx
*lttng_probe_ctx
,
220 struct list_head node
; /* list of bytecode runtime in event */
221 struct lttng_kernel_ctx
*ctx
;
225 * Enabler field, within whatever object is enabling an event. Target of
226 * backward reference.
228 struct lttng_event_enabler_common
{
229 enum lttng_kernel_event_enabler_type enabler_type
;
230 enum lttng_enabler_format_type format_type
;
232 /* head list of struct lttng_kernel_bytecode_node */
233 struct list_head filter_bytecode_head
;
235 struct lttng_kernel_abi_event event_param
;
236 unsigned int enabled
:1;
238 uint64_t user_token
; /* User-provided token. */
241 struct lttng_event_recorder_enabler
{
242 struct lttng_event_enabler_common parent
;
243 struct list_head node
; /* per-session list of enablers */
244 bool published
; /* published in per-session list. */
245 struct lttng_kernel_channel_buffer
*chan
;
248 struct lttng_event_notifier_enabler
{
249 struct lttng_event_enabler_common parent
;
250 uint64_t error_counter_index
;
251 struct list_head node
; /* List of event_notifier enablers */
252 bool published
; /* published in group list. */
253 struct lttng_event_notifier_group
*group
;
255 /* head list of struct lttng_kernel_bytecode_node */
256 struct list_head capture_bytecode_head
;
257 uint64_t num_captures
;
260 struct lttng_ctx_value
{
269 * We need to keep this perf counter field separately from struct
270 * lttng_kernel_ctx_field because cpu hotplug needs fixed-location addresses.
272 struct lttng_perf_counter_field
{
273 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
274 struct lttng_cpuhp_node cpuhp_prepare
;
275 struct lttng_cpuhp_node cpuhp_online
;
277 struct notifier_block nb
;
280 struct perf_event_attr
*attr
;
281 struct perf_event
**e
; /* per-cpu array */
283 struct lttng_kernel_event_field
*event_field
;
286 struct lttng_kernel_ctx_field
{
287 const struct lttng_kernel_event_field
*event_field
;
288 size_t (*get_size
)(void *priv
, struct lttng_kernel_probe_ctx
*probe_ctx
,
290 void (*record
)(void *priv
, struct lttng_kernel_probe_ctx
*probe_ctx
,
291 struct lttng_kernel_ring_buffer_ctx
*ctx
,
292 struct lttng_kernel_channel_buffer
*chan
);
293 void (*get_value
)(void *priv
, struct lttng_kernel_probe_ctx
*probe_ctx
,
294 struct lttng_ctx_value
*value
);
295 void (*destroy
)(void *priv
);
299 struct lttng_kernel_ctx
{
300 struct lttng_kernel_ctx_field
*fields
;
301 unsigned int nr_fields
;
302 unsigned int allocated_fields
;
303 size_t largest_align
; /* in bytes */
306 struct lttng_metadata_cache
{
307 char *data
; /* Metadata cache */
308 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
309 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
310 atomic_t producing
; /* Metadata being produced (incomplete) */
311 struct kref refcount
; /* Metadata cache usage */
312 struct list_head metadata_stream
; /* Metadata stream list */
313 uuid_le uuid
; /* Trace session unique ID (copy) */
314 struct mutex lock
; /* Produce/consume lock */
315 uint64_t version
; /* Current version of the metadata */
318 struct lttng_metadata_stream
{
319 void *priv
; /* Ring buffer private data */
320 struct lttng_metadata_cache
*metadata_cache
;
321 unsigned int metadata_in
; /* Bytes read from the cache */
322 unsigned int metadata_out
; /* Bytes consumed from stream */
323 int finalized
; /* Has channel been finalized */
324 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
325 struct list_head list
; /* Stream list */
326 struct lttng_transport
*transport
;
327 uint64_t version
; /* Current version of the metadata cache */
328 bool coherent
; /* Stream in a coherent state */
331 struct lttng_kernel_channel_buffer_ops_private
{
332 struct lttng_kernel_channel_buffer_ops
*pub
; /* Public channel buffer ops interface */
334 struct lttng_kernel_ring_buffer_channel
*(*channel_create
)(const char *name
,
337 size_t subbuf_size
, size_t num_subbuf
,
338 unsigned int switch_timer_interval
,
339 unsigned int read_timer_interval
);
340 void (*channel_destroy
)(struct lttng_kernel_ring_buffer_channel
*chan
);
341 struct lttng_kernel_ring_buffer
*(*buffer_read_open
)(struct lttng_kernel_ring_buffer_channel
*chan
);
342 int (*buffer_has_read_closed_stream
)(struct lttng_kernel_ring_buffer_channel
*chan
);
343 void (*buffer_read_close
)(struct lttng_kernel_ring_buffer
*buf
);
345 * packet_avail_size returns the available size in the current
346 * packet. Note that the size returned is only a hint, since it
347 * may change due to concurrent writes.
349 size_t (*packet_avail_size
)(struct lttng_kernel_ring_buffer_channel
*chan
);
350 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct lttng_kernel_ring_buffer_channel
*chan
, int cpu
);
351 wait_queue_head_t
*(*get_hp_wait_queue
)(struct lttng_kernel_ring_buffer_channel
*chan
);
352 int (*is_finalized
)(struct lttng_kernel_ring_buffer_channel
*chan
);
353 int (*is_disabled
)(struct lttng_kernel_ring_buffer_channel
*chan
);
354 int (*timestamp_begin
) (const struct lttng_kernel_ring_buffer_config
*config
,
355 struct lttng_kernel_ring_buffer
*bufb
,
356 uint64_t *timestamp_begin
);
357 int (*timestamp_end
) (const struct lttng_kernel_ring_buffer_config
*config
,
358 struct lttng_kernel_ring_buffer
*bufb
,
359 uint64_t *timestamp_end
);
360 int (*events_discarded
) (const struct lttng_kernel_ring_buffer_config
*config
,
361 struct lttng_kernel_ring_buffer
*bufb
,
362 uint64_t *events_discarded
);
363 int (*content_size
) (const struct lttng_kernel_ring_buffer_config
*config
,
364 struct lttng_kernel_ring_buffer
*bufb
,
365 uint64_t *content_size
);
366 int (*packet_size
) (const struct lttng_kernel_ring_buffer_config
*config
,
367 struct lttng_kernel_ring_buffer
*bufb
,
368 uint64_t *packet_size
);
369 int (*stream_id
) (const struct lttng_kernel_ring_buffer_config
*config
,
370 struct lttng_kernel_ring_buffer
*bufb
,
371 uint64_t *stream_id
);
372 int (*current_timestamp
) (const struct lttng_kernel_ring_buffer_config
*config
,
373 struct lttng_kernel_ring_buffer
*bufb
,
375 int (*sequence_number
) (const struct lttng_kernel_ring_buffer_config
*config
,
376 struct lttng_kernel_ring_buffer
*bufb
,
378 int (*instance_id
) (const struct lttng_kernel_ring_buffer_config
*config
,
379 struct lttng_kernel_ring_buffer
*bufb
,
383 struct lttng_counter_ops
{
384 struct lib_counter
*(*counter_create
)(size_t nr_dimensions
,
385 const size_t *max_nr_elem
, /* for each dimension */
386 int64_t global_sum_step
);
387 void (*counter_destroy
)(struct lib_counter
*counter
);
388 int (*counter_add
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
391 * counter_read reads a specific cpu's counter if @cpu >= 0, or
392 * the global aggregation counter if @cpu == -1.
394 int (*counter_read
)(struct lib_counter
*counter
, const size_t *dimension_indexes
, int cpu
,
395 int64_t *value
, bool *overflow
, bool *underflow
);
397 * counter_aggregate returns the total sum of all per-cpu counters and
398 * the global aggregation counter.
400 int (*counter_aggregate
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
401 int64_t *value
, bool *overflow
, bool *underflow
);
402 int (*counter_clear
)(struct lib_counter
*counter
, const size_t *dimension_indexes
);
405 struct lttng_counter
{
406 struct file
*file
; /* File associated to counter. */
408 struct lttng_counter_transport
*transport
;
409 struct lib_counter
*counter
;
410 struct lttng_counter_ops
*ops
;
413 #define LTTNG_EVENT_HT_BITS 12
414 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
416 struct lttng_event_ht
{
417 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
420 struct lttng_event_notifier_group
{
421 struct file
*file
; /* File associated to event notifier group */
422 struct file
*notif_file
; /* File used to expose notifications to userspace. */
423 struct list_head node
; /* event notifier group list */
424 struct list_head enablers_head
; /* List of enablers */
425 struct list_head event_notifiers_head
; /* List of event notifier */
426 struct lttng_event_ht events_ht
; /* Hash table of event notifiers */
427 struct lttng_kernel_channel_buffer_ops
*ops
;
428 struct lttng_transport
*transport
;
429 struct lttng_kernel_ring_buffer_channel
*chan
; /* Ring buffer channel for event notifier group. */
430 struct lttng_kernel_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
431 wait_queue_head_t read_wait
;
432 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
434 struct lttng_kernel_syscall_table syscall_table
;
436 struct lttng_counter
*error_counter
;
437 size_t error_counter_len
;
440 struct lttng_transport
{
442 struct module
*owner
;
443 struct list_head node
;
444 struct lttng_kernel_channel_buffer_ops ops
;
447 struct lttng_counter_transport
{
449 struct module
*owner
;
450 struct list_head node
;
451 struct lttng_counter_ops ops
;
454 struct lttng_kernel_session_private
{
455 struct lttng_kernel_session
*pub
; /* Public session interface */
457 int been_active
; /* Has trace session been active ? */
458 struct file
*file
; /* File associated to session */
459 struct list_head chan
; /* Channel list head */
460 struct list_head events
; /* Event list head */
461 struct list_head list
; /* Session list */
462 unsigned int free_chan_id
; /* Next chan ID to allocate */
463 uuid_le uuid
; /* Trace session unique ID */
464 struct lttng_metadata_cache
*metadata_cache
;
465 unsigned int metadata_dumped
:1,
466 tstate
:1; /* Transient enable state */
467 /* List of event enablers */
468 struct list_head enablers_head
;
469 /* Hash table of events */
470 struct lttng_event_ht events_ht
;
471 char name
[LTTNG_KERNEL_ABI_SESSION_NAME_LEN
];
472 char creation_time
[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN
];
475 struct lttng_id_hash_node
{
476 struct hlist_node hlist
;
491 struct lttng_kernel_id_tracker_private
{
492 struct lttng_kernel_id_tracker
*pub
; /* Public interface */
494 struct lttng_kernel_session
*session
;
495 enum tracker_type tracker_type
;
498 extern struct lttng_kernel_ctx
*lttng_static_ctx
;
501 const struct lttng_kernel_type_integer
*lttng_kernel_get_type_integer(const struct lttng_kernel_type_common
*type
)
503 if (type
->type
!= lttng_kernel_type_integer
)
505 return container_of(type
, const struct lttng_kernel_type_integer
, parent
);
509 const struct lttng_kernel_type_string
*lttng_kernel_get_type_string(const struct lttng_kernel_type_common
*type
)
511 if (type
->type
!= lttng_kernel_type_string
)
513 return container_of(type
, const struct lttng_kernel_type_string
, parent
);
517 const struct lttng_kernel_type_enum
*lttng_kernel_get_type_enum(const struct lttng_kernel_type_common
*type
)
519 if (type
->type
!= lttng_kernel_type_enum
)
521 return container_of(type
, const struct lttng_kernel_type_enum
, parent
);
525 const struct lttng_kernel_type_array
*lttng_kernel_get_type_array(const struct lttng_kernel_type_common
*type
)
527 if (type
->type
!= lttng_kernel_type_array
)
529 return container_of(type
, const struct lttng_kernel_type_array
, parent
);
533 const struct lttng_kernel_type_sequence
*lttng_kernel_get_type_sequence(const struct lttng_kernel_type_common
*type
)
535 if (type
->type
!= lttng_kernel_type_sequence
)
537 return container_of(type
, const struct lttng_kernel_type_sequence
, parent
);
541 const struct lttng_kernel_type_struct
*lttng_kernel_get_type_struct(const struct lttng_kernel_type_common
*type
)
543 if (type
->type
!= lttng_kernel_type_struct
)
545 return container_of(type
, const struct lttng_kernel_type_struct
, parent
);
549 const struct lttng_kernel_type_variant
*lttng_kernel_get_type_variant(const struct lttng_kernel_type_common
*type
)
551 if (type
->type
!= lttng_kernel_type_variant
)
553 return container_of(type
, const struct lttng_kernel_type_variant
, parent
);
556 static inline bool lttng_kernel_type_is_bytewise_integer(const struct lttng_kernel_type_common
*type
)
558 const struct lttng_kernel_type_integer
*type_integer
= lttng_kernel_get_type_integer(type
);
562 switch (type_integer
->size
) {
577 int lttng_kernel_interpret_event_filter(const struct lttng_kernel_event_common
*event
,
578 const char *interpreter_stack_data
,
579 struct lttng_kernel_probe_ctx
*probe_ctx
,
580 void *event_filter_ctx
);
583 struct lttng_event_enabler_common
*lttng_event_recorder_enabler_as_enabler(
584 struct lttng_event_recorder_enabler
*event_recorder_enabler
)
586 return &event_recorder_enabler
->parent
;
590 struct lttng_event_enabler_common
*lttng_event_notifier_enabler_as_enabler(
591 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
593 return &event_notifier_enabler
->parent
;
597 struct lttng_event_ht
*lttng_get_event_ht_from_enabler(struct lttng_event_enabler_common
*event_enabler
)
599 switch (event_enabler
->enabler_type
) {
600 case LTTNG_EVENT_ENABLER_TYPE_RECORDER
:
602 struct lttng_event_recorder_enabler
*event_recorder_enabler
=
603 container_of(event_enabler
, struct lttng_event_recorder_enabler
, parent
);
604 return &event_recorder_enabler
->chan
->parent
.session
->priv
->events_ht
;
606 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
:
608 struct lttng_event_notifier_enabler
*event_notifier_enabler
=
609 container_of(event_enabler
, struct lttng_event_notifier_enabler
, parent
);
610 return &event_notifier_enabler
->group
->events_ht
;
617 int lttng_context_init(void);
618 void lttng_context_exit(void);
619 int lttng_kernel_context_append(struct lttng_kernel_ctx
**ctx_p
,
620 const struct lttng_kernel_ctx_field
*f
);
621 void lttng_kernel_context_remove_last(struct lttng_kernel_ctx
**ctx_p
);
622 struct lttng_kernel_ctx_field
*lttng_kernel_get_context_field_from_index(struct lttng_kernel_ctx
*ctx
,
624 int lttng_kernel_find_context(struct lttng_kernel_ctx
*ctx
, const char *name
);
625 int lttng_kernel_get_context_index(struct lttng_kernel_ctx
*ctx
, const char *name
);
626 void lttng_kernel_destroy_context(struct lttng_kernel_ctx
*ctx
);
627 int lttng_add_pid_to_ctx(struct lttng_kernel_ctx
**ctx
);
628 int lttng_add_cpu_id_to_ctx(struct lttng_kernel_ctx
**ctx
);
629 int lttng_add_procname_to_ctx(struct lttng_kernel_ctx
**ctx
);
630 int lttng_add_prio_to_ctx(struct lttng_kernel_ctx
**ctx
);
631 int lttng_add_nice_to_ctx(struct lttng_kernel_ctx
**ctx
);
632 int lttng_add_vpid_to_ctx(struct lttng_kernel_ctx
**ctx
);
633 int lttng_add_tid_to_ctx(struct lttng_kernel_ctx
**ctx
);
634 int lttng_add_vtid_to_ctx(struct lttng_kernel_ctx
**ctx
);
635 int lttng_add_ppid_to_ctx(struct lttng_kernel_ctx
**ctx
);
636 int lttng_add_vppid_to_ctx(struct lttng_kernel_ctx
**ctx
);
637 int lttng_add_hostname_to_ctx(struct lttng_kernel_ctx
**ctx
);
638 int lttng_add_interruptible_to_ctx(struct lttng_kernel_ctx
**ctx
);
639 int lttng_add_need_reschedule_to_ctx(struct lttng_kernel_ctx
**ctx
);
640 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
641 int lttng_add_preemptible_to_ctx(struct lttng_kernel_ctx
**ctx
);
644 int lttng_add_preemptible_to_ctx(struct lttng_kernel_ctx
**ctx
)
649 #ifdef CONFIG_PREEMPT_RT_FULL
650 int lttng_add_migratable_to_ctx(struct lttng_kernel_ctx
**ctx
);
653 int lttng_add_migratable_to_ctx(struct lttng_kernel_ctx
**ctx
)
659 int lttng_add_callstack_to_ctx(struct lttng_kernel_ctx
**ctx
, int type
);
661 #if defined(CONFIG_CGROUPS) && \
662 ((LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,6,0)) || \
663 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
664 int lttng_add_cgroup_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
667 int lttng_add_cgroup_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
673 #if defined(CONFIG_IPC_NS) && \
674 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
675 int lttng_add_ipc_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
678 int lttng_add_ipc_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
684 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
685 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
686 int lttng_add_mnt_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
689 int lttng_add_mnt_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
695 #if defined(CONFIG_NET_NS) && \
696 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
697 int lttng_add_net_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
700 int lttng_add_net_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
706 #if defined(CONFIG_PID_NS) && \
707 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
708 int lttng_add_pid_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
711 int lttng_add_pid_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
717 #if defined(CONFIG_USER_NS) && \
718 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
719 int lttng_add_user_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
722 int lttng_add_user_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
728 #if defined(CONFIG_UTS_NS) && \
729 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
730 int lttng_add_uts_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
733 int lttng_add_uts_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
739 #if defined(CONFIG_TIME_NS) && \
740 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,6,0) || \
741 LTTNG_RHEL_KERNEL_RANGE(4,18,0,305,0,0, 4,19,0,0,0,0))
742 int lttng_add_time_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
745 int lttng_add_time_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
751 int lttng_add_uid_to_ctx(struct lttng_kernel_ctx
**ctx
);
752 int lttng_add_euid_to_ctx(struct lttng_kernel_ctx
**ctx
);
753 int lttng_add_suid_to_ctx(struct lttng_kernel_ctx
**ctx
);
754 int lttng_add_gid_to_ctx(struct lttng_kernel_ctx
**ctx
);
755 int lttng_add_egid_to_ctx(struct lttng_kernel_ctx
**ctx
);
756 int lttng_add_sgid_to_ctx(struct lttng_kernel_ctx
**ctx
);
757 int lttng_add_vuid_to_ctx(struct lttng_kernel_ctx
**ctx
);
758 int lttng_add_veuid_to_ctx(struct lttng_kernel_ctx
**ctx
);
759 int lttng_add_vsuid_to_ctx(struct lttng_kernel_ctx
**ctx
);
760 int lttng_add_vgid_to_ctx(struct lttng_kernel_ctx
**ctx
);
761 int lttng_add_vegid_to_ctx(struct lttng_kernel_ctx
**ctx
);
762 int lttng_add_vsgid_to_ctx(struct lttng_kernel_ctx
**ctx
);
764 #if defined(CONFIG_PERF_EVENTS)
765 int lttng_add_perf_counter_to_ctx(uint32_t type
,
768 struct lttng_kernel_ctx
**ctx
);
769 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
770 struct lttng_cpuhp_node
*node
);
771 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
772 struct lttng_cpuhp_node
*node
);
775 int lttng_add_perf_counter_to_ctx(uint32_t type
,
778 struct lttng_kernel_ctx
**ctx
)
783 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
784 struct lttng_cpuhp_node
*node
)
789 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
790 struct lttng_cpuhp_node
*node
)
796 struct lttng_event_recorder_enabler
*lttng_event_recorder_enabler_create(
797 enum lttng_enabler_format_type format_type
,
798 struct lttng_kernel_abi_event
*event_param
,
799 struct lttng_kernel_channel_buffer
*chan
);
800 void lttng_event_enabler_session_add(struct lttng_kernel_session
*session
,
801 struct lttng_event_recorder_enabler
*event_enabler
);
803 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
804 enum lttng_enabler_format_type format_type
,
805 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
806 struct lttng_event_notifier_group
*event_notifier_group
);
807 void lttng_event_notifier_enabler_group_add(struct lttng_event_notifier_group
*event_notifier_group
,
808 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
809 int lttng_event_notifier_enabler_attach_capture_bytecode(
810 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
811 struct lttng_kernel_abi_capture_bytecode __user
*bytecode
);
813 int lttng_event_enabler_enable(struct lttng_event_enabler_common
*event_enabler
);
814 int lttng_event_enabler_disable(struct lttng_event_enabler_common
*event_enabler
);
815 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler_common
*event_enabler
,
816 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
);
817 void lttng_event_enabler_destroy(struct lttng_event_enabler_common
*event_enabler
);
819 bool lttng_desc_match_enabler(const struct lttng_kernel_event_desc
*desc
,
820 struct lttng_event_enabler_common
*enabler
);
821 bool lttng_event_enabler_match_event(struct lttng_event_enabler_common
*event_enabler
,
822 struct lttng_kernel_event_common
*event
);
823 bool lttng_event_enabler_desc_match_event(struct lttng_event_enabler_common
*event_enabler
,
824 const struct lttng_kernel_event_desc
*desc
,
825 struct lttng_kernel_event_common
*event
);
827 void lttng_enabler_link_bytecode(const struct lttng_kernel_event_desc
*event_desc
,
828 struct lttng_kernel_ctx
*ctx
,
829 struct list_head
*instance_bytecode_runtime_head
,
830 struct list_head
*enabler_bytecode_runtime_head
);
832 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
833 int lttng_syscalls_register_event(struct lttng_event_enabler_common
*event_enabler
);
834 int lttng_syscall_filter_enable_event(struct lttng_kernel_event_common
*event
);
835 int lttng_syscall_filter_disable_event(struct lttng_kernel_event_common
*event
);
837 int lttng_syscalls_unregister_syscall_table(struct lttng_kernel_syscall_table
*syscall_table
);
838 int lttng_syscalls_destroy_syscall_table(struct lttng_kernel_syscall_table
*syscall_table
);
840 long lttng_syscall_table_get_active_mask(struct lttng_kernel_syscall_table
*syscall_table
,
841 struct lttng_kernel_abi_syscall_mask __user
*usyscall_mask
);
843 static inline int lttng_syscalls_register_event(struct lttng_event_enabler_common
*event_enabler
)
848 static inline int lttng_syscall_filter_enable_event(struct lttng_kernel_event_common
*event
)
853 static inline int lttng_syscall_filter_disable_event(struct lttng_kernel_event_common
*event
)
858 static inline int lttng_syscalls_unregister_syscall_table(struct lttng_kernel_syscall_table
*syscall_table
)
863 static inline int lttng_syscalls_destroy_syscall_table(struct lttng_kernel_syscall_table
*syscall_table
)
868 static inline long lttng_syscall_table_get_active_mask(struct lttng_kernel_syscall_table
*syscall_table
,
869 struct lttng_kernel_abi_syscall_mask __user
*usyscall_mask
)
874 static inline int lttng_syscalls_create_matching_event_notifiers(struct lttng_event_notifier_enabler
*event_notifier_enabler
)
881 #ifdef CONFIG_KPROBES
882 int lttng_kprobes_register_event(const char *name
,
883 const char *symbol_name
,
886 struct lttng_kernel_event_common
*event
);
887 void lttng_kprobes_unregister_event(struct lttng_kernel_event_common
*event
);
888 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_common
*event
);
891 int lttng_kprobes_register_event(const char *name
,
892 const char *symbol_name
,
895 struct lttng_kernel_event_common
*event
)
901 void lttng_kprobes_unregister_event(struct lttng_kernel_event_common
*event
)
906 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_common
*event
)
911 int lttng_event_add_callsite(struct lttng_kernel_event_common
*event
,
912 struct lttng_kernel_abi_event_callsite __user
*callsite
);
914 #ifdef CONFIG_UPROBES
915 int lttng_uprobes_register_event(const char *name
,
916 int fd
, struct lttng_kernel_event_common
*event
);
917 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common
*event
,
918 struct lttng_kernel_abi_event_callsite __user
*callsite
);
919 void lttng_uprobes_unregister_event(struct lttng_kernel_event_common
*event
);
920 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_common
*event
);
923 int lttng_uprobes_register_event(const char *name
,
924 int fd
, struct lttng_kernel_event_common
*event
)
930 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common
*event
,
931 struct lttng_kernel_abi_event_callsite __user
*callsite
)
937 void lttng_uprobes_unregister_event(struct lttng_kernel_event_common
*event
)
942 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_common
*event
)
947 #ifdef CONFIG_KRETPROBES
948 int lttng_kretprobes_register(const char *name
,
949 const char *symbol_name
,
952 struct lttng_kernel_event_common
*event_entry
,
953 struct lttng_kernel_event_common
*event_exit
);
954 void lttng_kretprobes_unregister(struct lttng_kernel_event_common
*event
);
955 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_common
*event
);
956 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common
*event
,
960 int lttng_kretprobes_register(const char *name
,
961 const char *symbol_name
,
964 struct lttng_kernel_event_common
*event_entry
,
965 struct lttng_kernel_event_common
*event_exit
)
971 void lttng_kretprobes_unregister(struct lttng_kernel_event_common
*event
)
976 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_common
*event
)
981 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common
*event
,
988 void lttng_lock_sessions(void);
989 void lttng_unlock_sessions(void);
991 struct list_head
*lttng_get_probe_list_head(void);
993 int lttng_fix_pending_events(void);
994 int lttng_fix_pending_event_notifiers(void);
995 int lttng_session_active(void);
996 bool lttng_event_notifier_active(void);
998 struct lttng_kernel_session
*lttng_session_create(void);
999 int lttng_session_enable(struct lttng_kernel_session
*session
);
1000 int lttng_session_disable(struct lttng_kernel_session
*session
);
1001 void lttng_session_destroy(struct lttng_kernel_session
*session
);
1002 int lttng_session_metadata_regenerate(struct lttng_kernel_session
*session
);
1003 int lttng_session_statedump(struct lttng_kernel_session
*session
);
1004 void metadata_cache_destroy(struct kref
*kref
);
1006 struct lttng_counter
*lttng_kernel_counter_create(
1007 const char *counter_transport_name
, size_t number_dimensions
,
1008 const size_t *dimensions_sizes
);
1009 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
1010 const size_t *dimension_indexes
, int32_t cpu
,
1011 int64_t *val
, bool *overflow
, bool *underflow
);
1012 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
1013 const size_t *dimension_indexes
, int64_t *val
,
1014 bool *overflow
, bool *underflow
);
1015 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
1016 const size_t *dimension_indexes
);
1017 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
1018 int lttng_event_notifier_group_create_error_counter(
1019 struct file
*event_notifier_group_file
,
1020 const struct lttng_kernel_abi_counter_conf
*error_counter_conf
);
1021 void lttng_event_notifier_group_destroy(
1022 struct lttng_event_notifier_group
*event_notifier_group
);
1024 struct lttng_kernel_channel_buffer
*lttng_channel_buffer_create(struct lttng_kernel_session
*session
,
1025 const char *transport_name
,
1027 size_t subbuf_size
, size_t num_subbuf
,
1028 unsigned int switch_timer_interval
,
1029 unsigned int read_timer_interval
,
1030 enum channel_type channel_type
);
1031 struct lttng_kernel_channel_buffer
*lttng_global_channel_create(struct lttng_kernel_session
*session
,
1032 int overwrite
, void *buf_addr
,
1033 size_t subbuf_size
, size_t num_subbuf
,
1034 unsigned int switch_timer_interval
,
1035 unsigned int read_timer_interval
);
1037 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer
*chan
);
1038 struct lttng_kernel_event_common
*_lttng_kernel_event_create(struct lttng_event_enabler_common
*event_enabler
,
1039 const struct lttng_kernel_event_desc
*event_desc
);
1040 struct lttng_kernel_event_common
*lttng_kernel_event_create(struct lttng_event_enabler_common
*event_enabler
,
1041 const struct lttng_kernel_event_desc
*event_desc
);
1043 int lttng_channel_enable(struct lttng_kernel_channel_common
*channel
);
1044 int lttng_channel_disable(struct lttng_kernel_channel_common
*channel
);
1045 int lttng_event_enable(struct lttng_kernel_event_common
*event
);
1046 int lttng_event_disable(struct lttng_kernel_event_common
*event
);
1048 void lttng_transport_register(struct lttng_transport
*transport
);
1049 void lttng_transport_unregister(struct lttng_transport
*transport
);
1051 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
);
1052 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
);
1054 void synchronize_trace(void);
1055 int lttng_abi_init(void);
1056 int lttng_abi_compat_old_init(void);
1057 void lttng_abi_exit(void);
1058 void lttng_abi_compat_old_exit(void);
1060 const struct lttng_kernel_event_desc
*lttng_event_desc_get(const char *name
);
1061 void lttng_event_desc_put(const struct lttng_kernel_event_desc
*desc
);
1062 int lttng_probes_init(void);
1063 void lttng_probes_exit(void);
1065 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
1066 struct lttng_kernel_ring_buffer_channel
*chan
, bool *coherent
);
1068 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
1069 int lttng_id_tracker_empty_set(struct lttng_kernel_id_tracker
*lf
);
1070 int lttng_id_tracker_init(struct lttng_kernel_id_tracker
*lf
,
1071 struct lttng_kernel_session
*session
,
1072 enum tracker_type type
);
1073 void lttng_id_tracker_fini(struct lttng_kernel_id_tracker
*lf
);
1074 void lttng_id_tracker_destroy(struct lttng_kernel_id_tracker
*lf
, bool rcu
);
1075 int lttng_id_tracker_add(struct lttng_kernel_id_tracker
*lf
, int id
);
1076 int lttng_id_tracker_del(struct lttng_kernel_id_tracker
*lf
, int id
);
1078 int lttng_session_track_id(struct lttng_kernel_session
*session
,
1079 enum tracker_type tracker_type
, int id
);
1080 int lttng_session_untrack_id(struct lttng_kernel_session
*session
,
1081 enum tracker_type tracker_type
, int id
);
1083 int lttng_session_list_tracker_ids(struct lttng_kernel_session
*session
,
1084 enum tracker_type tracker_type
);
1086 void lttng_clock_ref(void);
1087 void lttng_clock_unref(void);
1089 void lttng_free_event_filter_runtime(struct lttng_kernel_event_common
*event
);
1091 int lttng_probes_init(void);
1093 int lttng_logger_init(void);
1094 void lttng_logger_exit(void);
1096 extern int lttng_statedump_start(struct lttng_kernel_session
*session
);
1098 int lttng_calibrate(struct lttng_kernel_abi_calibrate
*calibrate
);
1100 extern const struct file_operations lttng_tracepoint_list_fops
;
1101 extern const struct file_operations lttng_syscall_list_fops
;
1103 #define lttng_kernel_static_ctx_field(_event_field, _get_size, _record, _get_value, _destroy, _priv) \
1104 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_ctx_field, { \
1105 .event_field = (_event_field), \
1106 .get_size = (_get_size), \
1107 .record = (_record), \
1108 .get_value = (_get_value), \
1109 .destroy = (_destroy), \
1113 #endif /* _LTTNG_EVENTS_INTERNAL_H */