1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
5 * Holds LTTng per-session event registry.
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 #ifndef _LTTNG_EVENTS_H
11 #define _LTTNG_EVENTS_H
13 #include <lttng/kernel-version.h>
14 #include <linux/list.h>
15 #include <linux/kprobes.h>
16 #include <linux/kref.h>
17 #include <linux/uuid.h>
18 #include <linux/irq_work.h>
19 #include <wrapper/uprobes.h>
20 #include <lttng/cpuhotplug.h>
21 #include <lttng/tracer.h>
22 #include <lttng/abi.h>
23 #include <lttng/abi-old.h>
24 #include <lttng/endian.h>
26 #define lttng_is_signed_type(type) (((type) -1) < (type) 1)
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 */
38 enum lttng_kernel_type
{
39 lttng_kernel_type_integer
,
40 lttng_kernel_type_string
,
41 lttng_kernel_type_enum
,
42 lttng_kernel_type_array
,
43 lttng_kernel_type_sequence
,
44 lttng_kernel_type_struct
,
45 lttng_kernel_type_variant
,
46 NR_LTTNG_KERNEL_TYPES
,
49 enum lttng_kernel_string_encoding
{
50 lttng_kernel_string_encoding_none
= 0,
51 lttng_kernel_string_encoding_UTF8
= 1,
52 lttng_kernel_string_encoding_ASCII
= 2,
53 NR_LTTNG_KERNEL_STRING_ENCODING
,
61 struct lttng_kernel_enum_value
{
62 unsigned long long value
;
63 unsigned int signedness
:1;
66 struct lttng_kernel_enum_entry
{
67 struct lttng_kernel_enum_value start
, end
; /* start and end are inclusive */
70 unsigned int is_auto
:1;
75 * struct lttng_kernel_type_common is fixed-size. Its children inherits
76 * from it by embedding struct lttng_kernel_type_common as its first field.
78 struct lttng_kernel_type_common
{
79 enum lttng_kernel_type type
;
82 struct lttng_kernel_type_integer
{
83 struct lttng_kernel_type_common parent
;
84 unsigned int size
; /* in bits */
85 unsigned short alignment
; /* in bits */
86 unsigned int signedness
:1,
88 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
91 struct lttng_kernel_type_string
{
92 struct lttng_kernel_type_common parent
;
93 enum lttng_kernel_string_encoding encoding
;
96 struct lttng_kernel_type_enum
{
97 struct lttng_kernel_type_common parent
;
98 const struct lttng_kernel_enum_desc
*desc
; /* Enumeration mapping */
99 const struct lttng_kernel_type_common
*container_type
;
102 struct lttng_kernel_type_array
{
103 struct lttng_kernel_type_common parent
;
104 const struct lttng_kernel_type_common
*elem_type
;
105 unsigned int length
; /* Num. elems. */
106 unsigned int alignment
;
107 enum lttng_kernel_string_encoding encoding
;
110 struct lttng_kernel_type_sequence
{
111 struct lttng_kernel_type_common parent
;
112 const char *length_name
; /* Length field name. If NULL, use previous field. */
113 const struct lttng_kernel_type_common
*elem_type
;
114 unsigned int alignment
; /* Alignment before elements. */
115 enum lttng_kernel_string_encoding encoding
;
118 struct lttng_kernel_type_struct
{
119 struct lttng_kernel_type_common parent
;
120 unsigned int nr_fields
;
121 const struct lttng_kernel_event_field
**fields
; /* Array of pointers to fields. */
122 unsigned int alignment
;
125 struct lttng_kernel_type_variant
{
126 struct lttng_kernel_type_common parent
;
127 const char *tag_name
; /* Tag field name. If NULL, use previous field. */
128 const struct lttng_kernel_event_field
**choices
; /* Array of pointers to fields. */
129 unsigned int nr_choices
;
130 unsigned int alignment
;
133 struct lttng_kernel_enum_desc
{
135 const struct lttng_kernel_enum_entry
**entries
;
136 unsigned int nr_entries
;
139 /* Event field description */
141 struct lttng_kernel_event_field
{
143 const struct lttng_kernel_type_common
*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 #define lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, _base) \
150 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_integer, { \
152 .type = lttng_kernel_type_integer, \
155 .alignment = (_alignment), \
156 .signedness = (_signedness), \
157 .reverse_byte_order = (_byte_order) != __BYTE_ORDER, \
161 #define lttng_kernel_static_type_integer_from_type(_type, _byte_order, _base) \
162 lttng_kernel_static_type_integer(sizeof(_type) * CHAR_BIT, \
163 lttng_alignof(_type) * CHAR_BIT, \
164 lttng_is_signed_type(_type), \
168 #define lttng_kernel_static_type_enum(_desc, _container_type) \
169 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_enum, { \
171 .type = lttng_kernel_type_enum, \
174 .container_type = (_container_type), \
177 #define lttng_kernel_static_type_array(_length, _elem_type, _alignment, _encoding) \
178 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_array, { \
180 .type = lttng_kernel_type_array, \
182 .length = (_length), \
183 .alignment = (_alignment), \
184 .encoding = lttng_kernel_string_encoding_##_encoding, \
185 .elem_type = (_elem_type), \
188 #define lttng_kernel_static_type_array_text(_length) \
189 lttng_kernel_static_type_array(_length, \
190 lttng_kernel_static_type_integer(sizeof(char) * CHAR_BIT, \
191 lttng_alignof(char) * CHAR_BIT, lttng_is_signed_type(char), \
195 #define lttng_kernel_static_type_sequence(_length_name, _elem_type, _alignment, _encoding) \
196 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_sequence, { \
198 .type = lttng_kernel_type_sequence, \
200 .length_name = (_length_name), \
201 .alignment = (_alignment), \
202 .encoding = lttng_kernel_string_encoding_##_encoding, \
203 .elem_type = (_elem_type), \
206 #define lttng_kernel_static_type_string(_encoding) \
207 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_string, { \
209 .type = lttng_kernel_type_string, \
211 .encoding = lttng_kernel_string_encoding_##_encoding, \
214 #define lttng_kernel_static_type_struct(_nr_fields, _fields, _alignment) \
215 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_struct, { \
217 .type = lttng_kernel_type_struct, \
219 .nr_fields = (_nr_fields), \
221 .alignment = (_alignment), \
224 #define lttng_kernel_static_type_variant(_nr_choices, _choices, _tag_name, _alignment) \
225 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_variant, { \
227 .type = lttng_kernel_type_variant, \
229 .tag_name = (_tag_name), \
230 .choices = _choices, \
231 .nr_choices = (_nr_choices), \
232 .alignment = (_alignment), \
235 #define lttng_kernel_static_event_field(_name, _type, _nowrite, _user, _nofilter) \
236 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field, { \
239 .nowrite = (_nowrite), \
241 .nofilter = (_nofilter), \
244 #define lttng_kernel_static_event_field_array(_fields...) \
245 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field *, \
249 #define lttng_kernel_static_enum_entry_value(_string, _value) \
250 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
252 .signedness = lttng_is_signed_type(__typeof__(_value)), \
253 .value = lttng_is_signed_type(__typeof__(_value)) ? \
254 (long long) (_value) : (_value), \
257 .signedness = lttng_is_signed_type(__typeof__(_value)), \
258 .value = lttng_is_signed_type(__typeof__(_value)) ? \
259 (long long) (_value) : (_value), \
261 .string = (_string), \
264 #define lttng_kernel_static_enum_entry_range(_string, _range_start, _range_end) \
265 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
267 .signedness = lttng_is_signed_type(__typeof__(_range_start)), \
268 .value = lttng_is_signed_type(__typeof__(_range_start)) ? \
269 (long long) (_range_start) : (_range_start), \
272 .signedness = lttng_is_signed_type(__typeof__(_range_end)), \
273 .value = lttng_is_signed_type(__typeof__(_range_end)) ? \
274 (long long) (_range_end) : (_range_end), \
276 .string = (_string), \
279 #define lttng_kernel_static_enum_entry_auto(_string) \
280 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
289 .string = (_string), \
295 struct lttng_kernel_probe_ctx
{
296 struct lttng_kernel_event_common
*event
;
297 uint8_t interruptible
;
300 struct lttng_kernel_event_desc
{
301 const char *event_name
; /* lttng-modules name */
302 const char *event_kname
; /* Linux kernel name (tracepoints) */
303 const struct lttng_kernel_probe_desc
*probe_desc
;
304 void (*probe_callback
)(void);
305 const struct lttng_kernel_event_field
**fields
; /* event payload */
306 unsigned int nr_fields
;
307 struct module
*owner
;
310 struct lttng_kernel_probe_desc
{
311 const char *provider_name
;
312 const struct lttng_kernel_event_desc
**event_desc
;
313 unsigned int nr_events
;
314 struct list_head head
; /* chain registered probes */
315 struct list_head lazy_init_head
;
316 int lazy
; /* lazy registration */
319 struct lttng_krp
; /* Kretprobe handling */
321 enum lttng_kernel_bytecode_type
{
322 LTTNG_KERNEL_BYTECODE_TYPE_FILTER
,
323 LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE
,
326 struct lttng_kernel_bytecode_node
{
327 enum lttng_kernel_bytecode_type type
;
328 struct list_head node
;
329 struct lttng_enabler
*enabler
;
332 uint32_t reloc_offset
;
338 struct lttng_interpreter_output
;
340 struct lttng_kernel_bytecode_runtime
{
341 /* Associated bytecode */
342 enum lttng_kernel_bytecode_type type
;
343 struct lttng_kernel_bytecode_node
*bc
;
344 int (*interpreter_func
)(struct lttng_kernel_bytecode_runtime
*kernel_bytecode
,
345 const char *interpreter_stack_data
,
346 struct lttng_kernel_probe_ctx
*lttng_probe_ctx
,
349 struct list_head node
; /* list of bytecode runtime in event */
350 struct lttng_kernel_ctx
*ctx
;
354 * Objects in a linked-list of enablers, owned by an event.
356 struct lttng_enabler_ref
{
357 struct list_head node
; /* enabler ref list */
358 struct lttng_enabler
*ref
; /* backward ref */
361 struct lttng_uprobe_handler
{
362 struct lttng_kernel_event_common
*event
;
364 struct uprobe_consumer up_consumer
;
365 struct list_head node
;
368 struct lttng_kprobe
{
373 struct lttng_uprobe
{
375 struct list_head head
;
378 enum lttng_syscall_entryexit
{
383 enum lttng_syscall_abi
{
384 LTTNG_SYSCALL_ABI_NATIVE
,
385 LTTNG_SYSCALL_ABI_COMPAT
,
389 * Result of the run_filter() callback.
391 enum lttng_kernel_event_filter_result
{
392 LTTNG_KERNEL_EVENT_FILTER_ACCEPT
= 0,
393 LTTNG_KERNEL_EVENT_FILTER_REJECT
= 1,
396 struct lttng_kernel_event_common_private
;
398 enum lttng_kernel_event_type
{
399 LTTNG_KERNEL_EVENT_TYPE_RECORDER
= 0,
400 LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
= 1,
403 struct lttng_kernel_event_common
{
404 struct lttng_kernel_event_common_private
*priv
; /* Private event interface */
406 enum lttng_kernel_event_type type
;
407 /* Get child with container_of(). */
410 int eval_filter
; /* Need to evaluate filters */
411 int (*run_filter
)(const struct lttng_kernel_event_common
*event
,
412 const char *stack_data
,
413 struct lttng_kernel_probe_ctx
*probe_ctx
,
417 struct lttng_kernel_event_recorder_private
;
419 struct lttng_kernel_event_recorder
{
420 struct lttng_kernel_event_common parent
;
421 struct lttng_kernel_event_recorder_private
*priv
; /* Private event record interface */
423 struct lttng_channel
*chan
;
426 struct lttng_kernel_notification_ctx
{
427 int eval_capture
; /* Capture evaluation available. */
430 struct lttng_kernel_event_notifier_private
;
432 struct lttng_kernel_event_notifier
{
433 struct lttng_kernel_event_common parent
;
434 struct lttng_kernel_event_notifier_private
*priv
; /* Private event notifier interface */
436 int eval_capture
; /* Need to evaluate capture */
437 void (*notification_send
)(struct lttng_kernel_event_notifier
*event_notifier
,
438 const char *stack_data
,
439 struct lttng_kernel_probe_ctx
*probe_ctx
,
440 struct lttng_kernel_notification_ctx
*notif_ctx
);
443 enum lttng_enabler_format_type
{
444 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
445 LTTNG_ENABLER_FORMAT_NAME
,
448 struct lttng_channel_ops
{
449 struct channel
*(*channel_create
)(const char *name
,
452 size_t subbuf_size
, size_t num_subbuf
,
453 unsigned int switch_timer_interval
,
454 unsigned int read_timer_interval
);
455 void (*channel_destroy
)(struct channel
*chan
);
456 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
457 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
458 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
459 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
);
460 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
461 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
463 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
464 const void *src
, size_t len
);
465 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
467 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
469 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
470 const char __user
*src
, size_t len
);
472 * packet_avail_size returns the available size in the current
473 * packet. Note that the size returned is only a hint, since it
474 * may change due to concurrent writes.
476 size_t (*packet_avail_size
)(struct channel
*chan
);
477 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
478 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
479 int (*is_finalized
)(struct channel
*chan
);
480 int (*is_disabled
)(struct channel
*chan
);
481 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
482 struct lib_ring_buffer
*bufb
,
483 uint64_t *timestamp_begin
);
484 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
485 struct lib_ring_buffer
*bufb
,
486 uint64_t *timestamp_end
);
487 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
488 struct lib_ring_buffer
*bufb
,
489 uint64_t *events_discarded
);
490 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
491 struct lib_ring_buffer
*bufb
,
492 uint64_t *content_size
);
493 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
494 struct lib_ring_buffer
*bufb
,
495 uint64_t *packet_size
);
496 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
497 struct lib_ring_buffer
*bufb
,
498 uint64_t *stream_id
);
499 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
500 struct lib_ring_buffer
*bufb
,
502 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
503 struct lib_ring_buffer
*bufb
,
505 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
506 struct lib_ring_buffer
*bufb
,
510 struct lttng_counter_ops
{
511 struct lib_counter
*(*counter_create
)(size_t nr_dimensions
,
512 const size_t *max_nr_elem
, /* for each dimension */
513 int64_t global_sum_step
);
514 void (*counter_destroy
)(struct lib_counter
*counter
);
515 int (*counter_add
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
518 * counter_read reads a specific cpu's counter if @cpu >= 0, or
519 * the global aggregation counter if @cpu == -1.
521 int (*counter_read
)(struct lib_counter
*counter
, const size_t *dimension_indexes
, int cpu
,
522 int64_t *value
, bool *overflow
, bool *underflow
);
524 * counter_aggregate returns the total sum of all per-cpu counters and
525 * the global aggregation counter.
527 int (*counter_aggregate
)(struct lib_counter
*counter
, const size_t *dimension_indexes
,
528 int64_t *value
, bool *overflow
, bool *underflow
);
529 int (*counter_clear
)(struct lib_counter
*counter
, const size_t *dimension_indexes
);
532 struct lttng_transport
{
534 struct module
*owner
;
535 struct list_head node
;
536 struct lttng_channel_ops ops
;
539 struct lttng_counter_transport
{
541 struct module
*owner
;
542 struct list_head node
;
543 struct lttng_counter_ops ops
;
546 struct lttng_syscall_filter
;
548 #define LTTNG_EVENT_HT_BITS 12
549 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
551 struct lttng_event_ht
{
552 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
555 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
556 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
558 struct lttng_event_notifier_ht
{
559 struct hlist_head table
[LTTNG_EVENT_NOTIFIER_HT_SIZE
];
562 struct lttng_channel
{
564 struct channel
*chan
; /* Channel buffers */
566 struct lttng_kernel_ctx
*ctx
;
567 /* Event ID management */
568 struct lttng_session
*session
;
569 struct file
*file
; /* File associated to channel */
570 unsigned int free_event_id
; /* Next event ID to allocate */
571 struct list_head list
; /* Channel list */
572 struct lttng_channel_ops
*ops
;
573 struct lttng_transport
*transport
;
574 struct hlist_head
*sc_table
; /* for syscall tracing */
575 struct hlist_head
*compat_sc_table
;
576 struct hlist_head
*sc_exit_table
; /* for syscall exit tracing */
577 struct hlist_head
*compat_sc_exit_table
;
578 struct hlist_head sc_unknown
; /* for unknown syscalls */
579 struct hlist_head sc_compat_unknown
;
580 struct hlist_head sc_exit_unknown
;
581 struct hlist_head compat_sc_exit_unknown
;
582 struct lttng_syscall_filter
*sc_filter
;
583 int header_type
; /* 0: unset, 1: compact, 2: large */
584 enum channel_type channel_type
;
585 int syscall_all_entry
;
586 int syscall_all_exit
;
587 unsigned int metadata_dumped
:1,
588 sys_enter_registered
:1,
589 sys_exit_registered
:1,
590 tstate
:1; /* Transient enable state */
593 struct lttng_metadata_stream
{
594 void *priv
; /* Ring buffer private data */
595 struct lttng_metadata_cache
*metadata_cache
;
596 unsigned int metadata_in
; /* Bytes read from the cache */
597 unsigned int metadata_out
; /* Bytes consumed from stream */
598 int finalized
; /* Has channel been finalized */
599 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
600 struct list_head list
; /* Stream list */
601 struct lttng_transport
*transport
;
602 uint64_t version
; /* Current version of the metadata cache */
603 bool coherent
; /* Stream in a coherent state */
606 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
608 struct lttng_dynamic_len_stack
{
609 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
613 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
616 * struct lttng_id_tracker declared in header due to deferencing of *v
617 * in RCU_INITIALIZER(v).
619 #define LTTNG_ID_HASH_BITS 6
620 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
633 struct lttng_id_tracker_rcu
{
634 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
637 struct lttng_id_tracker
{
638 struct lttng_session
*session
;
639 enum tracker_type tracker_type
;
640 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
643 struct lttng_id_hash_node
{
644 struct hlist_node hlist
;
648 struct lttng_session
{
649 int active
; /* Is trace session active ? */
650 int been_active
; /* Has trace session been active ? */
651 struct file
*file
; /* File associated to session */
652 struct list_head chan
; /* Channel list head */
653 struct list_head events
; /* Event list head */
654 struct list_head list
; /* Session list */
655 unsigned int free_chan_id
; /* Next chan ID to allocate */
656 uuid_le uuid
; /* Trace session unique ID */
657 struct lttng_metadata_cache
*metadata_cache
;
658 struct lttng_id_tracker pid_tracker
;
659 struct lttng_id_tracker vpid_tracker
;
660 struct lttng_id_tracker uid_tracker
;
661 struct lttng_id_tracker vuid_tracker
;
662 struct lttng_id_tracker gid_tracker
;
663 struct lttng_id_tracker vgid_tracker
;
664 unsigned int metadata_dumped
:1,
665 tstate
:1; /* Transient enable state */
666 /* List of event enablers */
667 struct list_head enablers_head
;
668 /* Hash table of events */
669 struct lttng_event_ht events_ht
;
670 char name
[LTTNG_KERNEL_ABI_SESSION_NAME_LEN
];
671 char creation_time
[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN
];
674 struct lttng_counter
{
675 struct file
*file
; /* File associated to counter. */
677 struct lttng_counter_transport
*transport
;
678 struct lib_counter
*counter
;
679 struct lttng_counter_ops
*ops
;
682 struct lttng_event_notifier_group
{
683 struct file
*file
; /* File associated to event notifier group */
684 struct file
*notif_file
; /* File used to expose notifications to userspace. */
685 struct list_head node
; /* event notifier group list */
686 struct list_head enablers_head
; /* List of enablers */
687 struct list_head event_notifiers_head
; /* List of event notifier */
688 struct lttng_event_notifier_ht event_notifiers_ht
; /* Hash table of event notifiers */
689 struct lttng_channel_ops
*ops
;
690 struct lttng_transport
*transport
;
691 struct channel
*chan
; /* Ring buffer channel for event notifier group. */
692 struct lib_ring_buffer
*buf
; /* Ring buffer for event notifier group. */
693 wait_queue_head_t read_wait
;
694 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
695 struct lttng_kernel_event_notifier
*sc_unknown
; /* for unknown syscalls */
696 struct lttng_kernel_event_notifier
*sc_compat_unknown
;
698 struct lttng_syscall_filter
*sc_filter
;
700 struct hlist_head
*event_notifier_syscall_dispatch
;
701 struct hlist_head
*event_notifier_compat_syscall_dispatch
;
702 struct hlist_head
*event_notifier_exit_syscall_dispatch
;
703 struct hlist_head
*event_notifier_exit_compat_syscall_dispatch
;
705 struct hlist_head event_notifier_unknown_syscall_dispatch
;
706 struct hlist_head event_notifier_compat_unknown_syscall_dispatch
;
707 struct hlist_head event_notifier_exit_unknown_syscall_dispatch
;
708 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch
;
710 int syscall_all_entry
;
711 int syscall_all_exit
;
713 unsigned int sys_enter_registered
:1, sys_exit_registered
:1;
715 struct lttng_counter
*error_counter
;
716 size_t error_counter_len
;
719 struct lttng_metadata_cache
{
720 char *data
; /* Metadata cache */
721 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
722 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
723 atomic_t producing
; /* Metadata being produced (incomplete) */
724 struct kref refcount
; /* Metadata cache usage */
725 struct list_head metadata_stream
; /* Metadata stream list */
726 uuid_le uuid
; /* Trace session unique ID (copy) */
727 struct mutex lock
; /* Produce/consume lock */
728 uint64_t version
; /* Current version of the metadata */
731 void lttng_lock_sessions(void);
732 void lttng_unlock_sessions(void);
734 struct list_head
*lttng_get_probe_list_head(void);
736 struct lttng_event_enabler
*lttng_event_enabler_create(
737 enum lttng_enabler_format_type format_type
,
738 struct lttng_kernel_abi_event
*event_param
,
739 struct lttng_channel
*chan
);
741 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
742 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
743 struct lttng_event_notifier_enabler
*lttng_event_notifier_enabler_create(
744 struct lttng_event_notifier_group
*event_notifier_group
,
745 enum lttng_enabler_format_type format_type
,
746 struct lttng_kernel_abi_event_notifier
*event_notifier_param
);
748 int lttng_event_notifier_enabler_enable(
749 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
750 int lttng_event_notifier_enabler_disable(
751 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
752 int lttng_fix_pending_events(void);
753 int lttng_fix_pending_event_notifiers(void);
754 int lttng_session_active(void);
755 bool lttng_event_notifier_active(void);
757 struct lttng_session
*lttng_session_create(void);
758 int lttng_session_enable(struct lttng_session
*session
);
759 int lttng_session_disable(struct lttng_session
*session
);
760 void lttng_session_destroy(struct lttng_session
*session
);
761 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
762 int lttng_session_statedump(struct lttng_session
*session
);
763 void metadata_cache_destroy(struct kref
*kref
);
765 struct lttng_counter
*lttng_kernel_counter_create(
766 const char *counter_transport_name
, size_t number_dimensions
,
767 const size_t *dimensions_sizes
);
768 int lttng_kernel_counter_read(struct lttng_counter
*counter
,
769 const size_t *dimension_indexes
, int32_t cpu
,
770 int64_t *val
, bool *overflow
, bool *underflow
);
771 int lttng_kernel_counter_aggregate(struct lttng_counter
*counter
,
772 const size_t *dimension_indexes
, int64_t *val
,
773 bool *overflow
, bool *underflow
);
774 int lttng_kernel_counter_clear(struct lttng_counter
*counter
,
775 const size_t *dimension_indexes
);
778 struct lttng_event_notifier_group
*lttng_event_notifier_group_create(void);
779 int lttng_event_notifier_group_create_error_counter(
780 struct file
*event_notifier_group_file
,
781 const struct lttng_kernel_abi_counter_conf
*error_counter_conf
);
782 void lttng_event_notifier_group_destroy(
783 struct lttng_event_notifier_group
*event_notifier_group
);
785 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
786 const char *transport_name
,
788 size_t subbuf_size
, size_t num_subbuf
,
789 unsigned int switch_timer_interval
,
790 unsigned int read_timer_interval
,
791 enum channel_type channel_type
);
792 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
793 int overwrite
, void *buf_addr
,
794 size_t subbuf_size
, size_t num_subbuf
,
795 unsigned int switch_timer_interval
,
796 unsigned int read_timer_interval
);
798 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
799 struct lttng_kernel_event_recorder
*lttng_kernel_event_recorder_create(struct lttng_channel
*chan
,
800 struct lttng_kernel_abi_event
*event_param
,
801 const struct lttng_kernel_event_desc
*event_desc
,
802 enum lttng_kernel_abi_instrumentation itype
);
803 struct lttng_kernel_event_recorder
*_lttng_kernel_event_recorder_create(struct lttng_channel
*chan
,
804 struct lttng_kernel_abi_event
*event_param
,
805 const struct lttng_kernel_event_desc
*event_desc
,
806 enum lttng_kernel_abi_instrumentation itype
);
807 struct lttng_kernel_event_recorder
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
808 struct lttng_kernel_abi_old_event
*old_event_param
,
809 const struct lttng_kernel_event_desc
*internal_desc
);
811 struct lttng_kernel_event_notifier
*lttng_event_notifier_create(
812 const struct lttng_kernel_event_desc
*event_notifier_desc
,
814 uint64_t error_counter_idx
,
815 struct lttng_event_notifier_group
*event_notifier_group
,
816 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
817 enum lttng_kernel_abi_instrumentation itype
);
818 struct lttng_kernel_event_notifier
*_lttng_event_notifier_create(
819 const struct lttng_kernel_event_desc
*event_notifier_desc
,
821 uint64_t error_counter_idx
,
822 struct lttng_event_notifier_group
*event_notifier_group
,
823 struct lttng_kernel_abi_event_notifier
*event_notifier_param
,
824 enum lttng_kernel_abi_instrumentation itype
);
826 int lttng_channel_enable(struct lttng_channel
*channel
);
827 int lttng_channel_disable(struct lttng_channel
*channel
);
828 int lttng_event_enable(struct lttng_kernel_event_common
*event
);
829 int lttng_event_disable(struct lttng_kernel_event_common
*event
);
831 void lttng_transport_register(struct lttng_transport
*transport
);
832 void lttng_transport_unregister(struct lttng_transport
*transport
);
834 void lttng_counter_transport_register(struct lttng_counter_transport
*transport
);
835 void lttng_counter_transport_unregister(struct lttng_counter_transport
*transport
);
837 void synchronize_trace(void);
838 int lttng_abi_init(void);
839 int lttng_abi_compat_old_init(void);
840 void lttng_abi_exit(void);
841 void lttng_abi_compat_old_exit(void);
843 int lttng_probe_register(struct lttng_kernel_probe_desc
*desc
);
844 void lttng_probe_unregister(struct lttng_kernel_probe_desc
*desc
);
845 const struct lttng_kernel_event_desc
*lttng_event_desc_get(const char *name
);
846 void lttng_event_desc_put(const struct lttng_kernel_event_desc
*desc
);
847 int lttng_probes_init(void);
848 void lttng_probes_exit(void);
850 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
851 struct channel
*chan
, bool *coherent
);
853 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
854 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
855 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
856 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
857 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
858 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
860 int lttng_session_track_id(struct lttng_session
*session
,
861 enum tracker_type tracker_type
, int id
);
862 int lttng_session_untrack_id(struct lttng_session
*session
,
863 enum tracker_type tracker_type
, int id
);
865 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
866 enum tracker_type tracker_type
);
868 void lttng_clock_ref(void);
869 void lttng_clock_unref(void);
871 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc
*desc
,
872 struct lttng_enabler
*enabler
);
874 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
875 int lttng_syscalls_register_event(struct lttng_event_enabler
*event_enabler
);
876 int lttng_syscalls_unregister_channel(struct lttng_channel
*chan
);
877 int lttng_syscalls_destroy_event(struct lttng_channel
*chan
);
878 int lttng_syscall_filter_enable_event(
879 struct lttng_channel
*chan
,
880 struct lttng_kernel_event_recorder
*event
);
881 int lttng_syscall_filter_disable_event(
882 struct lttng_channel
*chan
,
883 struct lttng_kernel_event_recorder
*event
);
885 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
886 struct lttng_kernel_abi_syscall_mask __user
*usyscall_mask
);
888 int lttng_syscalls_register_event_notifier(
889 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
890 int lttng_syscalls_create_matching_event_notifiers(
891 struct lttng_event_notifier_enabler
*event_notifier_enabler
);
892 int lttng_syscalls_unregister_event_notifier_group(struct lttng_event_notifier_group
*group
);
893 int lttng_syscall_filter_enable_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
894 int lttng_syscall_filter_disable_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
896 static inline int lttng_syscalls_register_event(
897 struct lttng_event_enabler
*event_enabler
)
902 static inline int lttng_syscalls_unregister_channel(struct lttng_channel
*chan
)
907 static inline int lttng_syscalls_destroy(struct lttng_channel
*chan
)
912 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
913 struct lttng_kernel_event_recorder
*event
);
918 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
919 struct lttng_kernel_event_recorder
*event
);
924 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
925 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
930 static inline int lttng_syscalls_register_event_notifier(
931 struct lttng_event_notifier_group
*group
)
936 static inline int lttng_syscalls_unregister_event_notifier_group(
937 struct lttng_event_notifier_group
*group
)
942 static inline int lttng_syscall_filter_enable_event_notifier(
943 struct lttng_event_notifier_group
*group
,
949 static inline int lttng_syscall_filter_disable_event_notifier(
950 struct lttng_event_notifier_group
*group
,
958 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
959 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
);
960 int lttng_event_notifier_enabler_attach_filter_bytecode(
961 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
962 struct lttng_kernel_abi_filter_bytecode __user
*bytecode
);
963 int lttng_event_notifier_enabler_attach_capture_bytecode(
964 struct lttng_event_notifier_enabler
*event_notifier_enabler
,
965 struct lttng_kernel_abi_capture_bytecode __user
*bytecode
);
967 void lttng_enabler_link_bytecode(const struct lttng_kernel_event_desc
*event_desc
,
968 struct lttng_kernel_ctx
*ctx
,
969 struct list_head
*instance_bytecode_runtime_head
,
970 struct list_head
*enabler_bytecode_runtime_head
);
971 void lttng_free_event_filter_runtime(struct lttng_kernel_event_common
*event
);
973 int lttng_probes_init(void);
975 int lttng_logger_init(void);
976 void lttng_logger_exit(void);
978 extern int lttng_statedump_start(struct lttng_session
*session
);
980 #ifdef CONFIG_KPROBES
981 int lttng_kprobes_register_event(const char *name
,
982 const char *symbol_name
,
985 struct lttng_kernel_event_recorder
*event
);
986 void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder
*event
);
987 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
);
988 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
991 struct lttng_kernel_event_notifier
*event_notifier
);
992 void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
993 void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
);
996 int lttng_kprobes_register_event(const char *name
,
997 const char *symbol_name
,
1000 struct lttng_kernel_event_recorder
*event
)
1006 void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder
*event
)
1011 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
)
1016 int lttng_kprobes_register_event_notifier(const char *symbol_name
,
1019 struct lttng_kernel_event_notifier
*event_notifier
)
1025 void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
1030 void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
)
1035 int lttng_event_add_callsite(struct lttng_kernel_event_common
*event
,
1036 struct lttng_kernel_abi_event_callsite __user
*callsite
);
1038 #ifdef CONFIG_UPROBES
1039 int lttng_uprobes_register_event(const char *name
,
1040 int fd
, struct lttng_kernel_event_recorder
*event
);
1041 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common
*event
,
1042 struct lttng_kernel_abi_event_callsite __user
*callsite
);
1043 void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder
*event
);
1044 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
);
1045 int lttng_uprobes_register_event_notifier(const char *name
,
1046 int fd
, struct lttng_kernel_event_notifier
*event_notifier
);
1047 void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
);
1048 void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
);
1051 int lttng_uprobes_register_event(const char *name
,
1052 int fd
, struct lttng_kernel_event_recorder
*event
)
1058 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common
*event
,
1059 struct lttng_kernel_abi_event_callsite __user
*callsite
)
1065 void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder
*event
)
1070 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder
*event
)
1075 int lttng_uprobes_register_event_notifier(const char *name
,
1076 int fd
, struct lttng_kernel_event_notifier
*event_notifier
)
1082 void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier
*event_notifier
)
1087 void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier
*event_notifier
)
1092 #ifdef CONFIG_KRETPROBES
1093 int lttng_kretprobes_register(const char *name
,
1094 const char *symbol_name
,
1097 struct lttng_kernel_event_recorder
*event_entry
,
1098 struct lttng_kernel_event_recorder
*event_exit
);
1099 void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder
*event
);
1100 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder
*event
);
1101 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common
*event
,
1105 int lttng_kretprobes_register(const char *name
,
1106 const char *symbol_name
,
1109 struct lttng_kernel_event_recorder
*event_entry
,
1110 struct lttng_kernel_event_recorder
*event_exit
)
1116 void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder
*event
)
1121 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder
*event
)
1126 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common
*event
,
1133 int lttng_calibrate(struct lttng_kernel_abi_calibrate
*calibrate
);
1135 extern const struct file_operations lttng_tracepoint_list_fops
;
1136 extern const struct file_operations lttng_syscall_list_fops
;
1138 #define TRACEPOINT_HAS_DATA_ARG
1140 #endif /* _LTTNG_EVENTS_H */