1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
5 * Holds LTTng per-session event registry.
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 #ifndef _LTTNG_EVENTS_H
11 #define _LTTNG_EVENTS_H
13 #include <linux/irq_work.h>
14 #include <linux/version.h>
15 #include <linux/list.h>
16 #include <linux/kprobes.h>
17 #include <linux/kref.h>
18 #include <linux/uuid.h>
19 #include <wrapper/uprobes.h>
20 #include <lttng/cpuhotplug.h>
21 #include <lttng/tracer.h>
22 #include <lttng/abi.h>
23 #include <lttng/abi-old.h>
24 #include <lttng/endian.h>
26 #define lttng_is_signed_type(type) (((type)(-1)) < 0)
30 struct lttng_metadata_cache
;
31 struct lib_ring_buffer_ctx
;
33 struct perf_event_attr
;
34 struct lib_ring_buffer_config
;
36 /* Type description */
43 atype_sequence_nestable
,
44 atype_struct_nestable
,
45 atype_variant_nestable
,
49 enum lttng_string_encodings
{
50 lttng_encode_none
= 0,
51 lttng_encode_UTF8
= 1,
52 lttng_encode_ASCII
= 2,
61 struct lttng_enum_value
{
62 unsigned long long value
;
63 unsigned int signedness
:1;
66 struct lttng_enum_entry
{
67 struct lttng_enum_value start
, end
; /* start and end are inclusive */
70 unsigned int is_auto
:1;
74 #define __type_integer(_type, _size, _alignment, _signedness, \
75 _byte_order, _base, _encoding) \
77 .atype = atype_integer, \
80 .size = (_size) ? : sizeof(_type) * CHAR_BIT, \
81 .alignment = (_alignment) ? : lttng_alignof(_type) * CHAR_BIT, \
82 .signedness = (_signedness) >= 0 ? (_signedness) : lttng_is_signed_type(_type), \
83 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
85 .encoding = lttng_encode_##_encoding, \
89 struct lttng_integer_type {
90 unsigned int size
; /* in bits */
91 unsigned short alignment
; /* in bits */
92 unsigned int signedness
:1,
94 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
95 enum lttng_string_encodings encoding
;
99 enum abstract_types atype
;
101 struct lttng_integer_type integer
;
103 enum lttng_string_encodings encoding
;
106 const struct lttng_enum_desc
*desc
; /* Enumeration mapping */
107 const struct lttng_type
*container_type
;
110 const struct lttng_type
*elem_type
;
111 unsigned int length
; /* Num. elems. */
112 unsigned int alignment
;
115 const char *length_name
; /* Length field name. */
116 const struct lttng_type
*elem_type
;
117 unsigned int alignment
; /* Alignment before elements. */
120 unsigned int nr_fields
;
121 const struct lttng_event_field
*fields
; /* Array of fields. */
122 unsigned int alignment
;
125 const char *tag_name
;
126 const struct lttng_event_field
*choices
; /* Array of fields. */
127 unsigned int nr_choices
;
128 unsigned int alignment
;
133 struct lttng_enum_desc
{
135 const struct lttng_enum_entry
*entries
;
136 unsigned int nr_entries
;
139 /* Event field description */
141 struct lttng_event_field
{
143 struct lttng_type type
;
144 unsigned int nowrite
:1, /* do not write into trace */
145 user
:1, /* fetch from user-space */
146 nofilter
:1; /* do not consider for filter */
149 union lttng_ctx_value
{
156 * We need to keep this perf counter field separately from struct
157 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
159 struct lttng_perf_counter_field
{
160 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
161 struct lttng_cpuhp_node cpuhp_prepare
;
162 struct lttng_cpuhp_node cpuhp_online
;
164 struct notifier_block nb
;
167 struct perf_event_attr
*attr
;
168 struct perf_event
**e
; /* per-cpu array */
171 struct lttng_probe_ctx
{
172 struct lttng_event
*event
;
173 struct lttng_trigger
*trigger
; // Not sure if we will ever need it.
174 uint8_t interruptible
;
177 struct lttng_ctx_field
{
178 struct lttng_event_field event_field
;
179 size_t (*get_size
)(size_t offset
);
180 size_t (*get_size_arg
)(size_t offset
, struct lttng_ctx_field
*field
,
181 struct lib_ring_buffer_ctx
*ctx
,
182 struct lttng_channel
*chan
);
183 void (*record
)(struct lttng_ctx_field
*field
,
184 struct lib_ring_buffer_ctx
*ctx
,
185 struct lttng_channel
*chan
);
186 void (*get_value
)(struct lttng_ctx_field
*field
,
187 struct lttng_probe_ctx
*lttng_probe_ctx
,
188 union lttng_ctx_value
*value
);
190 struct lttng_perf_counter_field
*perf_counter
;
192 void (*destroy
)(struct lttng_ctx_field
*field
);
194 * Private data to keep state between get_size and record.
195 * User must perform its own synchronization to protect against
196 * concurrent and reentrant contexts.
202 struct lttng_ctx_field
*fields
;
203 unsigned int nr_fields
;
204 unsigned int allocated_fields
;
205 size_t largest_align
; /* in bytes */
208 struct lttng_event_desc
{
209 const char *name
; /* lttng-modules name */
210 const char *kname
; /* Linux kernel name (tracepoints) */
211 void *probe_callback
;
212 const struct lttng_event_ctx
*ctx
; /* context */
213 const struct lttng_event_field
*fields
; /* event payload */
214 unsigned int nr_fields
;
215 struct module
*owner
;
216 void *trigger_callback
;
219 struct lttng_probe_desc
{
220 const char *provider
;
221 const struct lttng_event_desc
**event_desc
;
222 unsigned int nr_events
;
223 struct list_head head
; /* chain registered probes */
224 struct list_head lazy_init_head
;
225 int lazy
; /* lazy registration */
228 struct lttng_krp
; /* Kretprobe handling */
230 enum lttng_event_type
{
231 LTTNG_TYPE_EVENT
= 0,
232 LTTNG_TYPE_ENABLER
= 1,
235 enum lttng_bytecode_node_type
{
236 LTTNG_BYTECODE_NODE_TYPE_FILTER
,
237 LTTNG_BYTECODE_NODE_TYPE_CAPTURE
,
240 struct lttng_bytecode_node
{
241 enum lttng_bytecode_node_type type
;
242 struct list_head node
;
243 struct lttng_enabler
*enabler
;
246 uint32_t reloc_offset
;
253 * Bytecode interpreter return value masks.
255 enum lttng_bytecode_interpreter_ret
{
256 LTTNG_INTERPRETER_DISCARD
= 0,
257 LTTNG_INTERPRETER_RECORD_FLAG
= (1ULL << 0),
258 /* Other bits are kept for future use. */
261 struct lttng_interpreter_output
;
263 struct lttng_bytecode_runtime
{
264 /* Associated bytecode */
265 struct lttng_bytecode_node
*bc
;
267 uint64_t (*filter
)(void *filter_data
,
268 struct lttng_probe_ctx
*lttng_probe_ctx
,
269 const char *filter_stack_data
);
270 uint64_t (*capture
)(void *filter_data
,
271 struct lttng_probe_ctx
*lttng_probe_ctx
,
272 const char *capture_stack_data
,
273 struct lttng_interpreter_output
*output
);
276 struct list_head node
; /* list of bytecode runtime in event */
277 struct lttng_ctx
*ctx
;
281 * Objects in a linked-list of enablers, owned by an event.
283 struct lttng_enabler_ref
{
284 struct list_head node
; /* enabler ref list */
285 struct lttng_enabler
*ref
; /* backward ref */
288 struct lttng_uprobe_handler
{
290 struct lttng_event
*event
;
291 struct lttng_trigger
*trigger
;
294 struct uprobe_consumer up_consumer
;
295 struct list_head node
;
298 struct lttng_kprobe
{
303 struct lttng_uprobe
{
305 struct list_head head
;
308 struct lttng_syscall
{
309 struct list_head node
; /* chain registered syscall trigger */
310 unsigned int syscall_id
;
315 * lttng_event structure is referred to by the tracing fast path. It must be
319 enum lttng_event_type evtype
; /* First field. */
321 struct lttng_channel
*chan
;
323 const struct lttng_event_desc
*desc
;
325 struct lttng_ctx
*ctx
;
326 enum lttng_kernel_instrumentation instrumentation
;
328 struct lttng_kprobe kprobe
;
330 struct lttng_krp
*lttng_krp
;
333 struct lttng_uprobe uprobe
;
335 struct list_head list
; /* Event list in session */
336 unsigned int metadata_dumped
:1;
338 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
339 struct list_head enablers_ref_head
;
340 struct hlist_node hlist
; /* session ht of events */
341 int registered
; /* has reg'd tracepoint probe */
342 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
343 struct list_head filter_bytecode_runtime_head
;
344 int has_enablers_without_bytecode
;
347 // FIXME: Really similar to lttng_event above. Could those be merged ?
348 struct lttng_trigger
{
349 enum lttng_event_type evtype
; /* First field. */
352 int registered
; /* has reg'd tracepoint probe */
353 const struct lttng_event_desc
*desc
;
355 struct list_head list
; /* Trigger list in trigger group */
357 enum lttng_kernel_instrumentation instrumentation
;
359 struct lttng_kprobe kprobe
;
360 struct lttng_uprobe uprobe
;
361 struct lttng_syscall syscall
;
364 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
365 struct list_head enablers_ref_head
;
366 struct hlist_node hlist
; /* session ht of triggers */
367 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
368 struct list_head filter_bytecode_runtime_head
;
370 struct list_head capture_bytecode_runtime_head
;
371 int has_enablers_without_bytecode
;
373 void (*send_notification
)(struct lttng_trigger
*trigger
,
374 struct lttng_probe_ctx
*lttng_probe_ctx
,
375 const char *interpreter_stack_data
);
376 struct lttng_trigger_group
*group
; /* Weak ref */
379 enum lttng_enabler_format_type
{
380 LTTNG_ENABLER_FORMAT_STAR_GLOB
,
381 LTTNG_ENABLER_FORMAT_NAME
,
385 * Enabler field, within whatever object is enabling an event. Target of
386 * backward reference.
388 struct lttng_enabler
{
389 enum lttng_event_type evtype
; /* First field. */
391 enum lttng_enabler_format_type format_type
;
393 /* head list of struct lttng_ust_filter_bytecode_node */
394 struct list_head filter_bytecode_head
;
396 struct lttng_kernel_event event_param
;
397 unsigned int enabled
:1;
400 struct lttng_event_enabler
{
401 struct lttng_enabler base
;
402 struct list_head node
; /* per-session list of enablers */
403 struct lttng_channel
*chan
;
405 * Unused, but kept around to make it explicit that the tracer can do
408 struct lttng_ctx
*ctx
;
411 struct lttng_trigger_enabler
{
412 struct lttng_enabler base
;
414 struct list_head node
; /* List of trigger enablers */
415 struct lttng_trigger_group
*group
;
417 /* head list of struct lttng_ust_filter_bytecode_node */
418 struct list_head capture_bytecode_head
;
419 uint64_t num_captures
;
424 struct lttng_enabler
*lttng_event_enabler_as_enabler(
425 struct lttng_event_enabler
*event_enabler
)
427 return &event_enabler
->base
;
431 struct lttng_enabler
*lttng_trigger_enabler_as_enabler(
432 struct lttng_trigger_enabler
*trigger_enabler
)
434 return &trigger_enabler
->base
;
437 struct lttng_channel_ops
{
438 struct channel
*(*channel_create
)(const char *name
,
441 size_t subbuf_size
, size_t num_subbuf
,
442 unsigned int switch_timer_interval
,
443 unsigned int read_timer_interval
);
444 void (*channel_destroy
)(struct channel
*chan
);
445 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
446 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
447 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
448 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
450 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
451 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
453 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
454 const void *src
, size_t len
);
455 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
457 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
459 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
460 const char __user
*src
, size_t len
);
462 * packet_avail_size returns the available size in the current
463 * packet. Note that the size returned is only a hint, since it
464 * may change due to concurrent writes.
466 size_t (*packet_avail_size
)(struct channel
*chan
);
467 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
468 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
469 int (*is_finalized
)(struct channel
*chan
);
470 int (*is_disabled
)(struct channel
*chan
);
471 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
472 struct lib_ring_buffer
*bufb
,
473 uint64_t *timestamp_begin
);
474 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
475 struct lib_ring_buffer
*bufb
,
476 uint64_t *timestamp_end
);
477 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
478 struct lib_ring_buffer
*bufb
,
479 uint64_t *events_discarded
);
480 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
481 struct lib_ring_buffer
*bufb
,
482 uint64_t *content_size
);
483 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
484 struct lib_ring_buffer
*bufb
,
485 uint64_t *packet_size
);
486 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
487 struct lib_ring_buffer
*bufb
,
488 uint64_t *stream_id
);
489 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
490 struct lib_ring_buffer
*bufb
,
492 int (*sequence_number
) (const struct lib_ring_buffer_config
*config
,
493 struct lib_ring_buffer
*bufb
,
495 int (*instance_id
) (const struct lib_ring_buffer_config
*config
,
496 struct lib_ring_buffer
*bufb
,
500 struct lttng_transport
{
502 struct module
*owner
;
503 struct list_head node
;
504 struct lttng_channel_ops ops
;
507 struct lttng_syscall_filter
;
509 #define LTTNG_EVENT_HT_BITS 12
510 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
512 struct lttng_event_ht
{
513 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
516 #define LTTNG_TRIGGER_HT_BITS 12
517 #define LTTNG_TRIGGER_HT_SIZE (1U << LTTNG_TRIGGER_HT_BITS)
519 struct lttng_trigger_ht
{
520 struct hlist_head table
[LTTNG_TRIGGER_HT_SIZE
];
523 struct lttng_channel
{
525 struct channel
*chan
; /* Channel buffers */
527 struct lttng_ctx
*ctx
;
528 /* Event ID management */
529 struct lttng_session
*session
;
530 struct file
*file
; /* File associated to channel */
531 unsigned int free_event_id
; /* Next event ID to allocate */
532 struct list_head list
; /* Channel list */
533 struct lttng_channel_ops
*ops
;
534 struct lttng_transport
*transport
;
535 struct lttng_event
**sc_table
; /* for syscall tracing */
536 struct lttng_event
**compat_sc_table
;
537 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
538 struct lttng_event
**compat_sc_exit_table
;
539 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
540 struct lttng_event
*sc_compat_unknown
;
541 struct lttng_event
*sc_exit_unknown
;
542 struct lttng_event
*compat_sc_exit_unknown
;
543 struct lttng_syscall_filter
*sc_filter
;
544 int header_type
; /* 0: unset, 1: compact, 2: large */
545 enum channel_type channel_type
;
546 unsigned int metadata_dumped
:1,
547 sys_enter_registered
:1,
548 sys_exit_registered
:1,
550 tstate
:1; /* Transient enable state */
553 struct lttng_metadata_stream
{
554 void *priv
; /* Ring buffer private data */
555 struct lttng_metadata_cache
*metadata_cache
;
556 unsigned int metadata_in
; /* Bytes read from the cache */
557 unsigned int metadata_out
; /* Bytes consumed from stream */
558 int finalized
; /* Has channel been finalized */
559 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
560 struct list_head list
; /* Stream list */
561 struct lttng_transport
*transport
;
562 uint64_t version
; /* Current version of the metadata cache */
563 bool coherent
; /* Stream in a coherent state */
566 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
568 struct lttng_dynamic_len_stack
{
569 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
573 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
576 * struct lttng_id_tracker declared in header due to deferencing of *v
577 * in RCU_INITIALIZER(v).
579 #define LTTNG_ID_HASH_BITS 6
580 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
593 struct lttng_id_tracker_rcu
{
594 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
597 struct lttng_id_tracker
{
598 struct lttng_session
*session
;
599 enum tracker_type tracker_type
;
600 struct lttng_id_tracker_rcu
*p
; /* RCU dereferenced. */
603 struct lttng_id_hash_node
{
604 struct hlist_node hlist
;
608 struct lttng_session
{
609 int active
; /* Is trace session active ? */
610 int been_active
; /* Has trace session been active ? */
611 struct file
*file
; /* File associated to session */
612 struct list_head chan
; /* Channel list head */
613 struct list_head events
; /* Event list head */
614 struct list_head list
; /* Session list */
615 unsigned int free_chan_id
; /* Next chan ID to allocate */
616 uuid_le uuid
; /* Trace session unique ID */
617 struct lttng_metadata_cache
*metadata_cache
;
618 struct lttng_id_tracker pid_tracker
;
619 struct lttng_id_tracker vpid_tracker
;
620 struct lttng_id_tracker uid_tracker
;
621 struct lttng_id_tracker vuid_tracker
;
622 struct lttng_id_tracker gid_tracker
;
623 struct lttng_id_tracker vgid_tracker
;
624 unsigned int metadata_dumped
:1,
625 tstate
:1; /* Transient enable state */
626 /* List of event enablers */
627 struct list_head enablers_head
;
628 /* Hash table of events */
629 struct lttng_event_ht events_ht
;
630 char name
[LTTNG_KERNEL_SESSION_NAME_LEN
];
631 char creation_time
[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN
];
634 struct lttng_trigger_group
{
635 struct file
*file
; /* File associated to trigger group */
636 struct file
*notif_file
; /* File used to expose notifications to userspace. */
637 struct list_head node
; /* Trigger group list */
638 struct list_head enablers_head
; /* List of enablers */
639 struct list_head triggers_head
; /* List of triggers */
640 struct lttng_trigger_ht triggers_ht
; /* Hash table of triggers */
641 struct lttng_ctx
*ctx
; /* Contexts for filters. */
642 struct lttng_channel_ops
*ops
;
643 struct lttng_transport
*transport
;
644 struct channel
*chan
; /* Ring buffer channel for trigger group. */
645 struct lib_ring_buffer
*buf
; /* Ring buffer for trigger group. */
646 wait_queue_head_t read_wait
;
647 struct irq_work wakeup_pending
; /* Pending wakeup irq work. */
649 struct list_head
*trigger_syscall_dispatch
;
650 struct list_head
*trigger_compat_syscall_dispatch
;
652 unsigned int syscall_all
:1,
653 sys_enter_registered
:1;
656 struct lttng_metadata_cache
{
657 char *data
; /* Metadata cache */
658 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
659 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
660 int producing
; /* Metadata being produced (incomplete) */
661 struct kref refcount
; /* Metadata cache usage */
662 struct list_head metadata_stream
; /* Metadata stream list */
663 uuid_le uuid
; /* Trace session unique ID (copy) */
664 struct mutex lock
; /* Produce/consume lock */
665 uint64_t version
; /* Current version of the metadata */
668 void lttng_lock_sessions(void);
669 void lttng_unlock_sessions(void);
671 struct list_head
*lttng_get_probe_list_head(void);
673 struct lttng_event_enabler
*lttng_event_enabler_create(
674 enum lttng_enabler_format_type format_type
,
675 struct lttng_kernel_event
*event_param
,
676 struct lttng_channel
*chan
);
678 int lttng_event_enabler_enable(struct lttng_event_enabler
*event_enabler
);
679 int lttng_event_enabler_disable(struct lttng_event_enabler
*event_enabler
);
680 struct lttng_trigger_enabler
*lttng_trigger_enabler_create(
681 struct lttng_trigger_group
*trigger_group
,
682 enum lttng_enabler_format_type format_type
,
683 struct lttng_kernel_trigger
*trigger_param
);
685 int lttng_trigger_enabler_enable(struct lttng_trigger_enabler
*trigger_enabler
);
686 int lttng_trigger_enabler_disable(struct lttng_trigger_enabler
*trigger_enabler
);
687 int lttng_fix_pending_events(void);
688 int lttng_fix_pending_triggers(void);
689 int lttng_session_active(void);
690 bool lttng_trigger_active(void);
692 struct lttng_session
*lttng_session_create(void);
693 int lttng_session_enable(struct lttng_session
*session
);
694 int lttng_session_disable(struct lttng_session
*session
);
695 void lttng_session_destroy(struct lttng_session
*session
);
696 int lttng_session_metadata_regenerate(struct lttng_session
*session
);
697 int lttng_session_statedump(struct lttng_session
*session
);
698 void metadata_cache_destroy(struct kref
*kref
);
700 struct lttng_trigger_group
*lttng_trigger_group_create(void);
701 void lttng_trigger_group_destroy(struct lttng_trigger_group
*trigger_group
);
703 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
704 const char *transport_name
,
706 size_t subbuf_size
, size_t num_subbuf
,
707 unsigned int switch_timer_interval
,
708 unsigned int read_timer_interval
,
709 enum channel_type channel_type
);
710 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
711 int overwrite
, void *buf_addr
,
712 size_t subbuf_size
, size_t num_subbuf
,
713 unsigned int switch_timer_interval
,
714 unsigned int read_timer_interval
);
716 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
717 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
718 struct lttng_kernel_event
*event_param
,
720 const struct lttng_event_desc
*event_desc
,
721 enum lttng_kernel_instrumentation itype
);
722 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
723 struct lttng_kernel_event
*event_param
,
725 const struct lttng_event_desc
*event_desc
,
726 enum lttng_kernel_instrumentation itype
);
727 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
728 struct lttng_kernel_old_event
*old_event_param
,
730 const struct lttng_event_desc
*internal_desc
);
732 struct lttng_trigger
*lttng_trigger_create(
733 const struct lttng_event_desc
*trigger_desc
,
735 struct lttng_trigger_group
*trigger_group
,
736 struct lttng_kernel_trigger
*trigger_param
,
738 enum lttng_kernel_instrumentation itype
);
739 struct lttng_trigger
*_lttng_trigger_create(
740 const struct lttng_event_desc
*trigger_desc
,
742 struct lttng_trigger_group
*trigger_group
,
743 struct lttng_kernel_trigger
*trigger_param
,
745 enum lttng_kernel_instrumentation itype
);
747 int lttng_channel_enable(struct lttng_channel
*channel
);
748 int lttng_channel_disable(struct lttng_channel
*channel
);
749 int lttng_event_enable(struct lttng_event
*event
);
750 int lttng_event_disable(struct lttng_event
*event
);
752 int lttng_trigger_enable(struct lttng_trigger
*trigger
);
753 int lttng_trigger_disable(struct lttng_trigger
*trigger
);
755 void lttng_transport_register(struct lttng_transport
*transport
);
756 void lttng_transport_unregister(struct lttng_transport
*transport
);
758 void synchronize_trace(void);
759 int lttng_abi_init(void);
760 int lttng_abi_compat_old_init(void);
761 void lttng_abi_exit(void);
762 void lttng_abi_compat_old_exit(void);
764 int lttng_probe_register(struct lttng_probe_desc
*desc
);
765 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
766 const struct lttng_event_desc
*lttng_event_desc_get(const char *name
);
767 void lttng_event_desc_put(const struct lttng_event_desc
*desc
);
768 int lttng_probes_init(void);
769 void lttng_probes_exit(void);
771 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
772 struct channel
*chan
, bool *coherent
);
774 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node
*node
);
775 int lttng_id_tracker_empty_set(struct lttng_id_tracker
*lf
);
776 void lttng_id_tracker_destroy(struct lttng_id_tracker
*lf
, bool rcu
);
777 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu
*p
, int id
);
778 int lttng_id_tracker_add(struct lttng_id_tracker
*lf
, int id
);
779 int lttng_id_tracker_del(struct lttng_id_tracker
*lf
, int id
);
781 int lttng_session_track_id(struct lttng_session
*session
,
782 enum tracker_type tracker_type
, int id
);
783 int lttng_session_untrack_id(struct lttng_session
*session
,
784 enum tracker_type tracker_type
, int id
);
786 int lttng_session_list_tracker_ids(struct lttng_session
*session
,
787 enum tracker_type tracker_type
);
789 void lttng_clock_ref(void);
790 void lttng_clock_unref(void);
792 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
793 struct lttng_enabler
*enabler
);
795 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
796 int lttng_syscalls_register_event(struct lttng_channel
*chan
, void *filter
);
797 int lttng_syscalls_unregister_event(struct lttng_channel
*chan
);
798 int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
800 int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
802 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
803 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
805 int lttng_syscalls_register_trigger(struct lttng_trigger_enabler
*trigger_enabler
, void *filter
);
806 int lttng_syscals_create_matching_triggers(struct lttng_trigger_enabler
*trigger_enabler
, void *filter
);
807 int lttng_syscalls_unregister_trigger(struct lttng_trigger_group
*group
);
808 int lttng_syscall_filter_enable_trigger(struct lttng_trigger
*trigger
);
809 int lttng_syscall_filter_disable_trigger(struct lttng_trigger
*trigger
);
811 static inline int lttng_syscalls_register_event(
812 struct lttng_channel
*chan
, void *filter
)
817 static inline int lttng_syscalls_unregister_event(struct lttng_channel
*chan
)
822 static inline int lttng_syscall_filter_enable_event(struct lttng_channel
*chan
,
828 static inline int lttng_syscall_filter_disable_event(struct lttng_channel
*chan
,
834 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
835 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
840 static inline int lttng_syscalls_register_trigger(
841 struct lttng_trigger_group
*group
, void *filter
)
846 static inline int lttng_syscalls_unregister_trigger(struct lttng_trigger_group
*group
)
851 static inline int lttng_syscall_filter_enable_trigger(struct lttng_trigger_group
*group
,
857 static inline int lttng_syscall_filter_disable_trigger(struct lttng_trigger_group
*group
,
865 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler
*event_enabler
,
866 struct lttng_kernel_filter_bytecode __user
*bytecode
);
867 int lttng_trigger_enabler_attach_filter_bytecode(struct lttng_trigger_enabler
*trigger_enabler
,
868 struct lttng_kernel_filter_bytecode __user
*bytecode
);
869 int lttng_trigger_enabler_attach_capture_bytecode(
870 struct lttng_trigger_enabler
*trigger_enabler
,
871 struct lttng_kernel_capture_bytecode __user
*bytecode
);
873 void lttng_enabler_link_bytecode(const struct lttng_event_desc
*event_desc
,
874 struct lttng_ctx
*ctx
,
875 struct list_head
*instance_bytecode_runtime_head
,
876 struct list_head
*enabler_bytecode_runtime_head
);
878 int lttng_probes_init(void);
880 extern struct lttng_ctx
*lttng_static_ctx
;
882 int lttng_context_init(void);
883 void lttng_context_exit(void);
884 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
885 void lttng_context_update(struct lttng_ctx
*ctx
);
886 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
887 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
888 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
889 struct lttng_ctx_field
*field
);
890 void lttng_destroy_context(struct lttng_ctx
*ctx
);
891 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
892 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
893 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
894 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
895 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
896 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
897 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
898 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
899 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
900 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
901 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
902 int lttng_add_interruptible_to_ctx(struct lttng_ctx
**ctx
);
903 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx
**ctx
);
904 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
905 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
);
908 int lttng_add_preemptible_to_ctx(struct lttng_ctx
**ctx
)
913 #ifdef CONFIG_PREEMPT_RT_FULL
914 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
);
917 int lttng_add_migratable_to_ctx(struct lttng_ctx
**ctx
)
923 int lttng_add_callstack_to_ctx(struct lttng_ctx
**ctx
, int type
);
925 #if defined(CONFIG_CGROUPS) && \
926 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
927 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
928 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
);
931 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx
**ctx
)
937 #if defined(CONFIG_IPC_NS) && \
938 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
939 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
);
942 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx
**ctx
)
948 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
949 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
950 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
);
953 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx
**ctx
)
959 #if defined(CONFIG_NET_NS) && \
960 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
961 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
);
964 int lttng_add_net_ns_to_ctx(struct lttng_ctx
**ctx
)
970 #if defined(CONFIG_PID_NS) && \
971 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
972 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
);
975 int lttng_add_pid_ns_to_ctx(struct lttng_ctx
**ctx
)
981 #if defined(CONFIG_USER_NS) && \
982 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
983 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
);
986 int lttng_add_user_ns_to_ctx(struct lttng_ctx
**ctx
)
992 #if defined(CONFIG_UTS_NS) && \
993 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
994 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
);
997 int lttng_add_uts_ns_to_ctx(struct lttng_ctx
**ctx
)
1003 int lttng_add_uid_to_ctx(struct lttng_ctx
**ctx
);
1004 int lttng_add_euid_to_ctx(struct lttng_ctx
**ctx
);
1005 int lttng_add_suid_to_ctx(struct lttng_ctx
**ctx
);
1006 int lttng_add_gid_to_ctx(struct lttng_ctx
**ctx
);
1007 int lttng_add_egid_to_ctx(struct lttng_ctx
**ctx
);
1008 int lttng_add_sgid_to_ctx(struct lttng_ctx
**ctx
);
1009 int lttng_add_vuid_to_ctx(struct lttng_ctx
**ctx
);
1010 int lttng_add_veuid_to_ctx(struct lttng_ctx
**ctx
);
1011 int lttng_add_vsuid_to_ctx(struct lttng_ctx
**ctx
);
1012 int lttng_add_vgid_to_ctx(struct lttng_ctx
**ctx
);
1013 int lttng_add_vegid_to_ctx(struct lttng_ctx
**ctx
);
1014 int lttng_add_vsgid_to_ctx(struct lttng_ctx
**ctx
);
1016 #if defined(CONFIG_PERF_EVENTS)
1017 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1020 struct lttng_ctx
**ctx
);
1021 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1022 struct lttng_cpuhp_node
*node
);
1023 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1024 struct lttng_cpuhp_node
*node
);
1027 int lttng_add_perf_counter_to_ctx(uint32_t type
,
1030 struct lttng_ctx
**ctx
)
1035 int lttng_cpuhp_perf_counter_online(unsigned int cpu
,
1036 struct lttng_cpuhp_node
*node
)
1041 int lttng_cpuhp_perf_counter_dead(unsigned int cpu
,
1042 struct lttng_cpuhp_node
*node
)
1048 int lttng_logger_init(void);
1049 void lttng_logger_exit(void);
1051 extern int lttng_statedump_start(struct lttng_session
*session
);
1053 #ifdef CONFIG_KPROBES
1054 int lttng_kprobes_register_event(const char *name
,
1055 const char *symbol_name
,
1058 struct lttng_event
*event
);
1059 void lttng_kprobes_unregister_event(struct lttng_event
*event
);
1060 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
);
1061 int lttng_kprobes_register_trigger(const char *symbol_name
,
1064 struct lttng_trigger
*trigger
);
1065 void lttng_kprobes_unregister_trigger(struct lttng_trigger
*trigger
);
1066 void lttng_kprobes_destroy_trigger_private(struct lttng_trigger
*trigger
);
1069 int lttng_kprobes_register_event(const char *name
,
1070 const char *symbol_name
,
1073 struct lttng_event
*event
)
1079 void lttng_kprobes_unregister_event(struct lttng_event
*event
)
1084 void lttng_kprobes_destroy_event_private(struct lttng_event
*event
)
1089 int lttng_kprobes_register_trigger(const char *symbol_name
,
1092 struct lttng_trigger
*trigger
)
1098 void lttng_kprobes_unregister_trigger(struct lttng_trigger
*trigger
)
1103 void lttng_kprobes_destroy_trigger_private(struct lttng_trigger
*trigger
)
1108 int lttng_event_add_callsite(struct lttng_event
*event
,
1109 struct lttng_kernel_event_callsite
*callsite
);
1111 int lttng_trigger_add_callsite(struct lttng_trigger
*trigger
,
1112 struct lttng_kernel_event_callsite
*callsite
);
1114 #ifdef CONFIG_UPROBES
1115 int lttng_uprobes_register_event(const char *name
,
1116 int fd
, struct lttng_event
*event
);
1117 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1118 struct lttng_kernel_event_callsite
*callsite
);
1119 void lttng_uprobes_unregister_event(struct lttng_event
*event
);
1120 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
);
1121 int lttng_uprobes_register_trigger(const char *name
,
1122 int fd
, struct lttng_trigger
*trigger
);
1123 int lttng_uprobes_trigger_add_callsite(struct lttng_trigger
*trigger
,
1124 struct lttng_kernel_event_callsite
*callsite
);
1125 void lttng_uprobes_unregister_trigger(struct lttng_trigger
*trigger
);
1126 void lttng_uprobes_destroy_trigger_private(struct lttng_trigger
*trigger
);
1129 int lttng_uprobes_register_event(const char *name
,
1130 int fd
, struct lttng_event
*event
)
1136 int lttng_uprobes_event_add_callsite(struct lttng_event
*event
,
1137 struct lttng_kernel_event_callsite
*callsite
)
1143 void lttng_uprobes_unregister_event(struct lttng_event
*event
)
1148 void lttng_uprobes_destroy_event_private(struct lttng_event
*event
)
1153 int lttng_uprobes_register_trigger(const char *name
,
1154 int fd
, struct lttng_trigger
*trigger
)
1160 int lttng_uprobes_trigger_add_callsite(struct lttng_trigger
*trigger
,
1161 struct lttng_kernel_event_callsite
*callsite
)
1167 void lttng_uprobes_unregister_trigger(struct lttng_trigger
*trigger
)
1172 void lttng_uprobes_destroy_trigger_private(struct lttng_trigger
*trigger
)
1177 #ifdef CONFIG_KRETPROBES
1178 int lttng_kretprobes_register(const char *name
,
1179 const char *symbol_name
,
1182 struct lttng_event
*event_entry
,
1183 struct lttng_event
*event_exit
);
1184 void lttng_kretprobes_unregister(struct lttng_event
*event
);
1185 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
1186 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1190 int lttng_kretprobes_register(const char *name
,
1191 const char *symbol_name
,
1194 struct lttng_event
*event_entry
,
1195 struct lttng_event
*event_exit
)
1201 void lttng_kretprobes_unregister(struct lttng_event
*event
)
1206 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
1211 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
1218 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
1220 extern const struct file_operations lttng_tracepoint_list_fops
;
1221 extern const struct file_operations lttng_syscall_list_fops
;
1223 #define TRACEPOINT_HAS_DATA_ARG
1225 static inline bool lttng_is_bytewise_integer(const struct lttng_type
*type
)
1227 if (type
->atype
!= atype_integer
)
1229 switch (type
->u
.integer
.size
) {
1230 case 8: /* Fall-through. */
1231 case 16: /* Fall-through. */
1232 case 32: /* Fall-through. */
1241 #endif /* _LTTNG_EVENTS_H */