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
;
80 enum lttng_kernel_abi_instrumentation instrumentation
;
81 /* Selected by instrumentation */
83 struct lttng_kprobe kprobe
;
84 struct lttng_uprobe uprobe
;
86 struct lttng_krp
*lttng_krp
;
90 enum lttng_syscall_entryexit entryexit
;
91 enum lttng_syscall_abi abi
;
92 struct hlist_node node
; /* chain registered syscall event_notifier */
93 unsigned int syscall_id
;
98 struct lttng_kernel_event_recorder_private
{
99 struct lttng_kernel_event_common_private parent
;
101 struct lttng_kernel_event_recorder
*pub
; /* Public event interface */
102 struct list_head node
; /* Event recorder list */
103 struct hlist_node hlist
; /* Hash table of event recorders */
104 struct lttng_kernel_ctx
*ctx
;
106 unsigned int metadata_dumped
:1;
109 struct lttng_kernel_event_notifier_private
{
110 struct lttng_kernel_event_common_private parent
;
112 struct lttng_kernel_event_notifier
*pub
; /* Public event notifier interface */
113 struct lttng_event_notifier_group
*group
; /* weak ref */
114 size_t num_captures
; /* Needed to allocate the msgpack array. */
115 uint64_t error_counter_index
;
116 struct list_head node
; /* Event notifier list */
117 struct hlist_node hlist
; /* Hash table of event notifiers */
118 struct list_head capture_bytecode_runtime_head
;
122 struct lttng_kernel_syscall_table
{
123 unsigned int sys_enter_registered
:1,
124 sys_exit_registered
:1;
126 struct hlist_head
*syscall_dispatch
; /* for syscall tracing */
127 struct hlist_head
*compat_syscall_dispatch
;
128 struct hlist_head
*syscall_exit_dispatch
; /* for syscall exit tracing */
129 struct hlist_head
*compat_syscall_exit_dispatch
;
132 * Combining all unknown syscall events works as long as they
133 * are only matched by "all" syscalls enablers, but will require
134 * a design change when we allow matching by syscall number, for
135 * instance by allocating sc_tables accomodating NR_syscalls
138 struct hlist_head unknown_syscall_dispatch
; /* for unknown syscalls */
139 struct hlist_head compat_unknown_syscall_dispatch
;
140 struct hlist_head unknown_syscall_exit_dispatch
;
141 struct hlist_head compat_unknown_syscall_exit_dispatch
;
143 struct lttng_syscall_filter
*sc_filter
;
144 int syscall_all_entry
;
145 int syscall_all_exit
;
148 struct lttng_kernel_channel_common_private
{
149 struct lttng_kernel_channel_common
*pub
;
151 struct file
*file
; /* File associated to channel */
152 unsigned int tstate
:1; /* Transient enable state */
154 struct lttng_kernel_syscall_table syscall_table
;
157 struct lttng_kernel_channel_buffer_private
{
158 struct lttng_kernel_channel_common_private parent
;
160 struct lttng_kernel_channel_buffer
*pub
;
162 unsigned int id
; /* Channel ID */
163 unsigned int free_event_id
; /* Next event ID to allocate */
164 int header_type
; /* 0: unset, 1: compact, 2: large */
166 enum channel_type channel_type
;
167 struct lttng_kernel_ctx
*ctx
;
168 struct lttng_kernel_ring_buffer_channel
*rb_chan
; /* Ring buffer channel */
169 unsigned int metadata_dumped
:1;
170 struct list_head node
; /* Channel list in session */
171 struct lttng_transport
*transport
;
174 enum lttng_kernel_bytecode_interpreter_ret
{
175 LTTNG_KERNEL_BYTECODE_INTERPRETER_ERROR
= -1,
176 LTTNG_KERNEL_BYTECODE_INTERPRETER_OK
= 0,
179 enum lttng_kernel_bytecode_filter_result
{
180 LTTNG_KERNEL_BYTECODE_FILTER_ACCEPT
= 0,
181 LTTNG_KERNEL_BYTECODE_FILTER_REJECT
= 1,
184 struct lttng_kernel_bytecode_filter_ctx
{
185 enum lttng_kernel_bytecode_filter_result result
;
188 struct lttng_interpreter_output
;
190 enum lttng_kernel_bytecode_type
{
191 LTTNG_KERNEL_BYTECODE_TYPE_FILTER
,
192 LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE
,
195 enum lttng_kernel_event_enabler_type
{
196 LTTNG_EVENT_ENABLER_TYPE_RECORDER
,
197 LTTNG_EVENT_ENABLER_TYPE_NOTIFIER
,
200 struct lttng_kernel_bytecode_node
{
201 enum lttng_kernel_bytecode_type type
;
202 struct list_head node
;
203 struct lttng_event_enabler_common
*enabler
;
206 uint32_t reloc_offset
;
212 struct lttng_kernel_bytecode_runtime
{
213 /* Associated bytecode */
214 enum lttng_kernel_bytecode_type type
;
215 struct lttng_kernel_bytecode_node
*bc
;
216 int (*interpreter_func
)(struct lttng_kernel_bytecode_runtime
*kernel_bytecode
,
217 const char *interpreter_stack_data
,
218 struct lttng_kernel_probe_ctx
*lttng_probe_ctx
,
221 struct list_head node
; /* list of bytecode runtime in event */
222 struct lttng_kernel_ctx
*ctx
;
226 * Enabler field, within whatever object is enabling an event. Target of
227 * backward reference.
229 struct lttng_event_enabler_common
{
230 enum lttng_kernel_event_enabler_type enabler_type
;
231 enum lttng_enabler_format_type format_type
;
233 /* head list of struct lttng_kernel_bytecode_node */
234 struct list_head filter_bytecode_head
;
236 struct lttng_kernel_abi_event event_param
;
237 unsigned int enabled
:1;
239 uint64_t user_token
; /* User-provided token. */
242 struct lttng_event_recorder_enabler
{
243 struct lttng_event_enabler_common parent
;
244 struct list_head node
; /* per-session list of enablers */
245 bool published
; /* published in per-session list. */
246 struct lttng_kernel_channel_buffer
*chan
;
249 struct lttng_event_notifier_enabler
{
250 struct lttng_event_enabler_common parent
;
251 uint64_t error_counter_index
;
252 struct list_head node
; /* List of event_notifier enablers */
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_NOTIFIER_HT_BITS 12
414 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
416 struct lttng_event_notifier_ht
{
417 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_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_notifier_ht event_notifiers_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 #define LTTNG_EVENT_HT_BITS 12
455 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
457 struct lttng_event_ht
{
458 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
461 struct lttng_kernel_session_private
{
462 struct lttng_kernel_session
*pub
; /* Public session interface */
464 int been_active
; /* Has trace session been active ? */
465 struct file
*file
; /* File associated to session */
466 struct list_head chan
; /* Channel list head */
467 struct list_head events
; /* Event list head */
468 struct list_head list
; /* Session list */
469 unsigned int free_chan_id
; /* Next chan ID to allocate */
470 uuid_le uuid
; /* Trace session unique ID */
471 struct lttng_metadata_cache
*metadata_cache
;
472 unsigned int metadata_dumped
:1,
473 tstate
:1; /* Transient enable state */
474 /* List of event enablers */
475 struct list_head enablers_head
;
476 /* Hash table of events */
477 struct lttng_event_ht events_ht
;
478 char name
[LTTNG_KERNEL_ABI_SESSION_NAME_LEN
];
479 char creation_time
[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN
];
482 struct lttng_id_hash_node
{
483 struct hlist_node hlist
;
498 struct lttng_kernel_id_tracker_private
{
499 struct lttng_kernel_id_tracker
*pub
; /* Public interface */
501 struct lttng_kernel_session
*session
;
502 enum tracker_type tracker_type
;
505 extern struct lttng_kernel_ctx
*lttng_static_ctx
;
508 const struct lttng_kernel_type_integer
*lttng_kernel_get_type_integer(const struct lttng_kernel_type_common
*type
)
510 if (type
->type
!= lttng_kernel_type_integer
)
512 return container_of(type
, const struct lttng_kernel_type_integer
, parent
);
516 const struct lttng_kernel_type_string
*lttng_kernel_get_type_string(const struct lttng_kernel_type_common
*type
)
518 if (type
->type
!= lttng_kernel_type_string
)
520 return container_of(type
, const struct lttng_kernel_type_string
, parent
);
524 const struct lttng_kernel_type_enum
*lttng_kernel_get_type_enum(const struct lttng_kernel_type_common
*type
)
526 if (type
->type
!= lttng_kernel_type_enum
)
528 return container_of(type
, const struct lttng_kernel_type_enum
, parent
);
532 const struct lttng_kernel_type_array
*lttng_kernel_get_type_array(const struct lttng_kernel_type_common
*type
)
534 if (type
->type
!= lttng_kernel_type_array
)
536 return container_of(type
, const struct lttng_kernel_type_array
, parent
);
540 const struct lttng_kernel_type_sequence
*lttng_kernel_get_type_sequence(const struct lttng_kernel_type_common
*type
)
542 if (type
->type
!= lttng_kernel_type_sequence
)
544 return container_of(type
, const struct lttng_kernel_type_sequence
, parent
);
548 const struct lttng_kernel_type_struct
*lttng_kernel_get_type_struct(const struct lttng_kernel_type_common
*type
)
550 if (type
->type
!= lttng_kernel_type_struct
)
552 return container_of(type
, const struct lttng_kernel_type_struct
, parent
);
556 const struct lttng_kernel_type_variant
*lttng_kernel_get_type_variant(const struct lttng_kernel_type_common
*type
)
558 if (type
->type
!= lttng_kernel_type_variant
)
560 return container_of(type
, const struct lttng_kernel_type_variant
, parent
);
563 static inline bool lttng_kernel_type_is_bytewise_integer(const struct lttng_kernel_type_common
*type
)
565 const struct lttng_kernel_type_integer
*type_integer
= lttng_kernel_get_type_integer(type
);
569 switch (type_integer
->size
) {
584 int lttng_kernel_interpret_event_filter(const struct lttng_kernel_event_common
*event
,
585 const char *interpreter_stack_data
,
586 struct lttng_kernel_probe_ctx
*probe_ctx
,
587 void *event_filter_ctx
);
590 struct lttng_event_enabler_common
*lttng_event_recorder_enabler_as_enabler(
591 struct lttng_event_recorder_enabler
*event_recorder_enabler
)
593 return &event_recorder_enabler
->parent
;
597 struct lttng_event_enabler_common
*lttng_event_notifier_enabler_as_enabler(
598 struct lttng_event_notifier_enabler
*event_notifier_enabler
)
600 return &event_notifier_enabler
->parent
;
603 int lttng_context_init(void);
604 void lttng_context_exit(void);
605 int lttng_kernel_context_append(struct lttng_kernel_ctx
**ctx_p
,
606 const struct lttng_kernel_ctx_field
*f
);
607 void lttng_kernel_context_remove_last(struct lttng_kernel_ctx
**ctx_p
);
608 struct lttng_kernel_ctx_field
*lttng_kernel_get_context_field_from_index(struct lttng_kernel_ctx
*ctx
,
610 int lttng_kernel_find_context(struct lttng_kernel_ctx
*ctx
, const char *name
);
611 int lttng_kernel_get_context_index(struct lttng_kernel_ctx
*ctx
, const char *name
);
612 void lttng_kernel_destroy_context(struct lttng_kernel_ctx
*ctx
);
613 int lttng_add_pid_to_ctx(struct lttng_kernel_ctx
**ctx
);
614 int lttng_add_cpu_id_to_ctx(struct lttng_kernel_ctx
**ctx
);
615 int lttng_add_procname_to_ctx(struct lttng_kernel_ctx
**ctx
);
616 int lttng_add_prio_to_ctx(struct lttng_kernel_ctx
**ctx
);
617 int lttng_add_nice_to_ctx(struct lttng_kernel_ctx
**ctx
);
618 int lttng_add_vpid_to_ctx(struct lttng_kernel_ctx
**ctx
);
619 int lttng_add_tid_to_ctx(struct lttng_kernel_ctx
**ctx
);
620 int lttng_add_vtid_to_ctx(struct lttng_kernel_ctx
**ctx
);
621 int lttng_add_ppid_to_ctx(struct lttng_kernel_ctx
**ctx
);
622 int lttng_add_vppid_to_ctx(struct lttng_kernel_ctx
**ctx
);
623 int lttng_add_hostname_to_ctx(struct lttng_kernel_ctx
**ctx
);
624 int lttng_add_interruptible_to_ctx(struct lttng_kernel_ctx
**ctx
);
625 int lttng_add_need_reschedule_to_ctx(struct lttng_kernel_ctx
**ctx
);
626 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
627 int lttng_add_preemptible_to_ctx(struct lttng_kernel_ctx
**ctx
);
630 int lttng_add_preemptible_to_ctx(struct lttng_kernel_ctx
**ctx
)
635 #ifdef CONFIG_PREEMPT_RT_FULL
636 int lttng_add_migratable_to_ctx(struct lttng_kernel_ctx
**ctx
);
639 int lttng_add_migratable_to_ctx(struct lttng_kernel_ctx
**ctx
)
645 int lttng_add_callstack_to_ctx(struct lttng_kernel_ctx
**ctx
, int type
);
647 #if defined(CONFIG_CGROUPS) && \
648 ((LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,6,0)) || \
649 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
650 int lttng_add_cgroup_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
653 int lttng_add_cgroup_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
659 #if defined(CONFIG_IPC_NS) && \
660 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
661 int lttng_add_ipc_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
664 int lttng_add_ipc_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
670 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
671 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
672 int lttng_add_mnt_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
675 int lttng_add_mnt_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
681 #if defined(CONFIG_NET_NS) && \
682 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
683 int lttng_add_net_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
686 int lttng_add_net_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
692 #if defined(CONFIG_PID_NS) && \
693 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
694 int lttng_add_pid_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
697 int lttng_add_pid_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
703 #if defined(CONFIG_USER_NS) && \
704 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
705 int lttng_add_user_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
708 int lttng_add_user_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
714 #if defined(CONFIG_UTS_NS) && \
715 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
716 int lttng_add_uts_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
719 int lttng_add_uts_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
725 #if defined(CONFIG_TIME_NS) && \
726 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,6,0) || \
727 LTTNG_RHEL_KERNEL_RANGE(4,18,0,305,0,0, 4,19,0,0,0,0))
728 int lttng_add_time_ns_to_ctx(struct lttng_kernel_ctx
**ctx
);
731 int lttng_add_time_ns_to_ctx(struct lttng_kernel_ctx
**ctx
)
737 int lttng_add_uid_to_ctx(struct lttng_kernel_ctx
**ctx
);
738 int lttng_add_euid_to_ctx(struct lttng_kernel_ctx
**ctx
);
739 int lttng_add_suid_to_ctx(struct lttng_kernel_ctx
**ctx
);
740 int lttng_add_gid_to_ctx(struct lttng_kernel_ctx
**ctx
);
741 int lttng_add_egid_to_ctx(struct lttng_kernel_ctx
**ctx
);
742 int lttng_add_sgid_to_ctx(struct lttng_kernel_ctx
**ctx
);
743 int lttng_add_vuid_to_ctx(struct lttng_kernel_ctx
**ctx
);
744 int lttng_add_veuid_to_ctx(struct lttng_kernel_ctx
**ctx
);
745 int lttng_add_vsuid_to_ctx(struct lttng_kernel_ctx
**ctx
);
746 int lttng_add_vgid_to_ctx(struct lttng_kernel_ctx
**ctx
);
747 int lttng_add_vegid_to_ctx(struct lttng_kernel_ctx
**ctx
);
748 int lttng_add_vsgid_to_ctx(struct lttng_kernel_ctx
**ctx
);
750 #if defined(CONFIG_PERF_EVENTS)
751 int lttng_add_perf_counter_to_ctx(uint32_t type
,
754 struct lttng_kernel_ctx
**ctx
);
755 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
756 struct lttng_cpuhp_node
*node
);
757 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
758 struct lttng_cpuhp_node
*node
);
761 int lttng_add_perf_counter_to_ctx(uint32_t type
,
764 struct lttng_kernel_ctx
**ctx
)
769 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
770 struct lttng_cpuhp_node
*node
)
775 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
776 struct lttng_cpuhp_node
*node
)
782 struct lttng_event_recorder_enabler
*lttng_event_recorder_enabler_create(
783 enum lttng_enabler_format_type format_type
,
784 struct lttng_kernel_abi_event
*event_param
,
785 struct lttng_kernel_channel_buffer
*chan
);
786 void lttng_event_enabler_session_add(struct lttng_kernel_session
*session
,
787 struct lttng_event_recorder_enabler
*event_enabler
);
789 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
790 struct lttng_event_notifier_group
*event_notifier_group
,
791 enum lttng_enabler_format_type format_type
,
792 struct lttng_kernel_abi_event_notifier
*event_notifier_param
);
793 int lttng_event_notifier_enabler_attach_capture_bytecode(
794 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
795 struct lttng_kernel_abi_capture_bytecode __user
*bytecode
);
797 int lttng_event_enabler_enable(struct lttng_event_enabler_common
*event_enabler
);
798 int lttng_event_enabler_disable(struct lttng_event_enabler_common
*event_enabler
);
799 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler_common
*event_enabler
,
800 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
);
801 void lttng_event_enabler_destroy(struct lttng_event_enabler_common
*event_enabler
);
803 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc
*desc
,
804 struct lttng_event_enabler_common
*enabler
);
806 void lttng_enabler_link_bytecode(const struct lttng_kernel_event_desc
*event_desc
,
807 struct lttng_kernel_ctx
*ctx
,
808 struct list_head
*instance_bytecode_runtime_head
,
809 struct list_head
*enabler_bytecode_runtime_head
);
811 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
812 int lttng_syscalls_register_event(struct lttng_event_recorder_enabler
*event_enabler
);
813 int lttng_syscalls_unregister_channel(struct lttng_kernel_channel_buffer
*chan
);
814 int lttng_syscalls_destroy_channel(struct lttng_kernel_channel_buffer
*chan
);
815 int lttng_syscall_filter_enable_event_recorder(struct lttng_kernel_event_recorder
*event_recorder
);
816 int lttng_syscall_filter_disable_event_recorder(struct lttng_kernel_event_recorder
*event_recorder
);
818 long lttng_channel_syscall_mask(struct lttng_kernel_channel_buffer
*channel
,
819 struct lttng_kernel_abi_syscall_mask __user
*usyscall_mask
);
821 int lttng_syscalls_register_event_notifier(
822 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
823 int lttng_syscalls_create_matching_event_notifiers(
824 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
825 int lttng_syscalls_unregister_event_notifier_group(struct lttng_event_notifier_group
*group
);
826 int lttng_syscall_filter_enable_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
827 int lttng_syscall_filter_disable_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
829 static inline int lttng_syscalls_register_event(
830 struct lttng_event_recorder_enabler
*event_enabler
)
835 static inline int lttng_syscalls_unregister_channel(struct lttng_kernel_channel_buffer
*chan
)
840 static inline int lttng_syscalls_destroy(struct lttng_kernel_channel_buffer
*chan
)
845 static inline int lttng_syscall_filter_enable_event_recorder(struct lttng_kernel_event_recorder
*event_recorder
)
850 static inline int lttng_syscall_filter_disable_event_recorder(struct lttng_kernel_event_recorder
*event_recorder
)
855 static inline long lttng_channel_syscall_mask(struct lttng_kernel_channel_buffer
*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
)
867 static inline int lttng_syscalls_unregister_event_notifier_group(
868 struct lttng_event_notifier_group
*group
)
873 static inline int lttng_syscall_filter_enable_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
878 static inline int lttng_syscall_filter_disable_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
885 #ifdef CONFIG_KPROBES
886 int lttng_kprobes_register_event(const char *name
,
887 const char *symbol_name
,
890 struct lttng_kernel_event_recorder
*event
);
891 void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder
*event
);
892 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
);
893 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
896 struct lttng_kernel_event_notifier
*event_notifier
);
897 void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
898 void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
);
901 int lttng_kprobes_register_event(const char *name
,
902 const char *symbol_name
,
905 struct lttng_kernel_event_recorder
*event
)
911 void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder
*event
)
916 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
)
921 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
924 struct lttng_kernel_event_notifier
*event_notifier
)
930 void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
935 void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
)
940 int lttng_event_add_callsite(struct lttng_kernel_event_common
*event
,
941 struct lttng_kernel_abi_event_callsite __user
*callsite
);
943 #ifdef CONFIG_UPROBES
944 int lttng_uprobes_register_event(const char *name
,
945 int fd
, struct lttng_kernel_event_recorder
*event
);
946 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common
*event
,
947 struct lttng_kernel_abi_event_callsite __user
*callsite
);
948 void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder
*event
);
949 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
);
950 int lttng_uprobes_register_event_notifier(const char *name
,
951 int fd
, struct lttng_kernel_event_notifier
*event_notifier
);
952 void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
953 void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
);
956 int lttng_uprobes_register_event(const char *name
,
957 int fd
, struct lttng_kernel_event_recorder
*event
)
963 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common
*event
,
964 struct lttng_kernel_abi_event_callsite __user
*callsite
)
970 void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder
*event
)
975 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
)
980 int lttng_uprobes_register_event_notifier(const char *name
,
981 int fd
, struct lttng_kernel_event_notifier
*event_notifier
)
987 void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
992 void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
)
997 #ifdef CONFIG_KRETPROBES
998 int lttng_kretprobes_register(const char *name
,
999 const char *symbol_name
,
1002 struct lttng_kernel_event_recorder
*event_entry
,
1003 struct lttng_kernel_event_recorder
*event_exit
);
1004 void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder
*event
);
1005 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder
*event
);
1006 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common
*event
,
1010 int lttng_kretprobes_register(const char *name
,
1011 const char *symbol_name
,
1014 struct lttng_kernel_event_recorder
*event_entry
,
1015 struct lttng_kernel_event_recorder
*event_exit
)
1021 void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder
*event
)
1026 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder
*event
)
1031 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common
*event
,
1038 void lttng_lock_sessions(void);
1039 void lttng_unlock_sessions(void);
1041 struct list_head
*lttng_get_probe_list_head(void);
1043 int lttng_fix_pending_events(void);
1044 int lttng_fix_pending_event_notifiers(void);
1045 int lttng_session_active(void);
1046 bool lttng_event_notifier_active(void);
1048 struct lttng_kernel_session
*lttng_session_create(void);
1049 int lttng_session_enable(struct lttng_kernel_session
*session
);
1050 int lttng_session_disable(struct lttng_kernel_session
*session
);
1051 void lttng_session_destroy(struct lttng_kernel_session
*session
);
1052 int lttng_session_metadata_regenerate(struct lttng_kernel_session
*session
);
1053 int lttng_session_statedump(struct lttng_kernel_session
*session
);
1054 void metadata_cache_destroy(struct kref
*kref
);
1056 struct lttng_counter
*lttng_kernel_counter_create(
1057 const char *counter_transport_name
, size_t number_dimensions
,
1058 const size_t *dimensions_sizes
);
1059 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
1060 const size_t *dimension_indexes
, int32_t cpu
,
1061 int64_t *val
, bool *overflow
, bool *underflow
);
1062 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
1063 const size_t *dimension_indexes
, int64_t *val
,
1064 bool *overflow
, bool *underflow
);
1065 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
1066 const size_t *dimension_indexes
);
1067 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
1068 int lttng_event_notifier_group_create_error_counter(
1069 struct file
*event_notifier_group_file
,
1070 const struct lttng_kernel_abi_counter_conf
*error_counter_conf
);
1071 void lttng_event_notifier_group_destroy(
1072 struct lttng_event_notifier_group
*event_notifier_group
);
1074 struct lttng_kernel_channel_buffer
*lttng_channel_buffer_create(struct lttng_kernel_session
*session
,
1075 const char *transport_name
,
1077 size_t subbuf_size
, size_t num_subbuf
,
1078 unsigned int switch_timer_interval
,
1079 unsigned int read_timer_interval
,
1080 enum channel_type channel_type
);
1081 struct lttng_kernel_channel_buffer
*lttng_global_channel_create(struct lttng_kernel_session
*session
,
1082 int overwrite
, void *buf_addr
,
1083 size_t subbuf_size
, size_t num_subbuf
,
1084 unsigned int switch_timer_interval
,
1085 unsigned int read_timer_interval
);
1087 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer
*chan
);
1088 struct lttng_kernel_event_recorder
*lttng_kernel_event_recorder_create(struct lttng_event_recorder_enabler
*event_enabler
,
1089 const struct lttng_kernel_event_desc
*event_desc
);
1090 struct lttng_kernel_event_recorder
*_lttng_kernel_event_recorder_create(struct lttng_event_recorder_enabler
*event_enabler
,
1091 const struct lttng_kernel_event_desc
*event_desc
);
1092 struct lttng_kernel_event_recorder
*lttng_event_compat_old_create(struct lttng_kernel_channel_buffer
*chan
,
1093 struct lttng_kernel_abi_old_event
*old_event_param
,
1094 const struct lttng_kernel_event_desc
*internal_desc
);
1096 struct lttng_kernel_event_notifier
*lttng_event_notifier_create(
1097 const struct lttng_kernel_event_desc
*event_notifier_desc
,
1099 uint64_t error_counter_idx
,
1100 struct lttng_event_notifier_group
*event_notifier_group
,
1101 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1102 enum lttng_kernel_abi_instrumentation itype
);
1103 struct lttng_kernel_event_notifier
*_lttng_event_notifier_create(
1104 const struct lttng_kernel_event_desc
*event_notifier_desc
,
1106 uint64_t error_counter_idx
,
1107 struct lttng_event_notifier_group
*event_notifier_group
,
1108 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
1109 enum lttng_kernel_abi_instrumentation itype
);
1111 int lttng_channel_enable(struct lttng_kernel_channel_common
*channel
);
1112 int lttng_channel_disable(struct lttng_kernel_channel_common
*channel
);
1113 int lttng_event_enable(struct lttng_kernel_event_common
*event
);
1114 int lttng_event_disable(struct lttng_kernel_event_common
*event
);
1116 void lttng_transport_register(struct lttng_transport
*transport
);
1117 void lttng_transport_unregister(struct lttng_transport
*transport
);
1119 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
);
1120 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
);
1122 void synchronize_trace(void);
1123 int lttng_abi_init(void);
1124 int lttng_abi_compat_old_init(void);
1125 void lttng_abi_exit(void);
1126 void lttng_abi_compat_old_exit(void);
1128 const struct lttng_kernel_event_desc
*lttng_event_desc_get(const char *name
);
1129 void lttng_event_desc_put(const struct lttng_kernel_event_desc
*desc
);
1130 int lttng_probes_init(void);
1131 void lttng_probes_exit(void);
1133 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
1134 struct lttng_kernel_ring_buffer_channel
*chan
, bool *coherent
);
1136 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
1137 int lttng_id_tracker_empty_set(struct lttng_kernel_id_tracker
*lf
);
1138 int lttng_id_tracker_init(struct lttng_kernel_id_tracker
*lf
,
1139 struct lttng_kernel_session
*session
,
1140 enum tracker_type type
);
1141 void lttng_id_tracker_fini(struct lttng_kernel_id_tracker
*lf
);
1142 void lttng_id_tracker_destroy(struct lttng_kernel_id_tracker
*lf
, bool rcu
);
1143 int lttng_id_tracker_add(struct lttng_kernel_id_tracker
*lf
, int id
);
1144 int lttng_id_tracker_del(struct lttng_kernel_id_tracker
*lf
, int id
);
1146 int lttng_session_track_id(struct lttng_kernel_session
*session
,
1147 enum tracker_type tracker_type
, int id
);
1148 int lttng_session_untrack_id(struct lttng_kernel_session
*session
,
1149 enum tracker_type tracker_type
, int id
);
1151 int lttng_session_list_tracker_ids(struct lttng_kernel_session
*session
,
1152 enum tracker_type tracker_type
);
1154 void lttng_clock_ref(void);
1155 void lttng_clock_unref(void);
1157 void lttng_free_event_filter_runtime(struct lttng_kernel_event_common
*event
);
1159 int lttng_probes_init(void);
1161 int lttng_logger_init(void);
1162 void lttng_logger_exit(void);
1164 extern int lttng_statedump_start(struct lttng_kernel_session
*session
);
1166 int lttng_calibrate(struct lttng_kernel_abi_calibrate
*calibrate
);
1168 extern const struct file_operations lttng_tracepoint_list_fops
;
1169 extern const struct file_operations lttng_syscall_list_fops
;
1171 #define lttng_kernel_static_ctx_field(_event_field, _get_size, _record, _get_value, _destroy, _priv) \
1172 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_ctx_field, { \
1173 .event_field = (_event_field), \
1174 .get_size = (_get_size), \
1175 .record = (_record), \
1176 .get_value = (_get_value), \
1177 .destroy = (_destroy), \
1181 #endif /* _LTTNG_EVENTS_INTERNAL_H */