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)
29 struct lttng_kernel_session
;
30 struct lttng_kernel_ring_buffer_ctx
;
32 /* Type description */
34 enum lttng_kernel_type
{
35 lttng_kernel_type_integer
,
36 lttng_kernel_type_string
,
37 lttng_kernel_type_enum
,
38 lttng_kernel_type_array
,
39 lttng_kernel_type_sequence
,
40 lttng_kernel_type_struct
,
41 lttng_kernel_type_variant
,
42 NR_LTTNG_KERNEL_TYPES
,
45 enum lttng_kernel_string_encoding
{
46 lttng_kernel_string_encoding_none
= 0,
47 lttng_kernel_string_encoding_UTF8
= 1,
48 lttng_kernel_string_encoding_ASCII
= 2,
49 NR_LTTNG_KERNEL_STRING_ENCODING
,
57 struct lttng_kernel_enum_value
{
58 unsigned long long value
;
59 unsigned int signedness
:1;
62 struct lttng_kernel_enum_entry
{
63 struct lttng_kernel_enum_value start
, end
; /* start and end are inclusive */
66 unsigned int is_auto
:1;
71 * struct lttng_kernel_type_common is fixed-size. Its children inherits
72 * from it by embedding struct lttng_kernel_type_common as its first field.
74 struct lttng_kernel_type_common
{
75 enum lttng_kernel_type type
;
78 struct lttng_kernel_type_integer
{
79 struct lttng_kernel_type_common parent
;
80 unsigned int size
; /* in bits */
81 unsigned short alignment
; /* in bits */
82 unsigned int signedness
:1,
84 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
87 struct lttng_kernel_type_string
{
88 struct lttng_kernel_type_common parent
;
89 enum lttng_kernel_string_encoding encoding
;
92 struct lttng_kernel_type_enum
{
93 struct lttng_kernel_type_common parent
;
94 const struct lttng_kernel_enum_desc
*desc
; /* Enumeration mapping */
95 const struct lttng_kernel_type_common
*container_type
;
98 struct lttng_kernel_type_array
{
99 struct lttng_kernel_type_common parent
;
100 const struct lttng_kernel_type_common
*elem_type
;
101 unsigned int length
; /* Num. elems. */
102 unsigned int alignment
;
103 enum lttng_kernel_string_encoding encoding
;
106 struct lttng_kernel_type_sequence
{
107 struct lttng_kernel_type_common parent
;
108 const char *length_name
; /* Length field name. If NULL, use previous field. */
109 const struct lttng_kernel_type_common
*elem_type
;
110 unsigned int alignment
; /* Alignment before elements. */
111 enum lttng_kernel_string_encoding encoding
;
114 struct lttng_kernel_type_struct
{
115 struct lttng_kernel_type_common parent
;
116 unsigned int nr_fields
;
117 const struct lttng_kernel_event_field
**fields
; /* Array of pointers to fields. */
118 unsigned int alignment
;
121 struct lttng_kernel_type_variant
{
122 struct lttng_kernel_type_common parent
;
123 const char *tag_name
; /* Tag field name. If NULL, use previous field. */
124 const struct lttng_kernel_event_field
**choices
; /* Array of pointers to fields. */
125 unsigned int nr_choices
;
126 unsigned int alignment
;
129 struct lttng_kernel_enum_desc
{
131 const struct lttng_kernel_enum_entry
**entries
;
132 unsigned int nr_entries
;
135 /* Event field description */
137 struct lttng_kernel_event_field
{
139 const struct lttng_kernel_type_common
*type
;
140 unsigned int nowrite
:1, /* do not write into trace */
141 user
:1, /* fetch from user-space */
142 nofilter
:1; /* do not consider for filter */
146 #define PARAMS(args...) args
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_init(_nr_fields, _fields, _alignment) \
217 .type = lttng_kernel_type_struct, \
219 .nr_fields = (_nr_fields), \
221 .alignment = (_alignment), \
224 #define lttng_kernel_static_type_struct(_nr_fields, _fields, _alignment) \
225 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_struct, \
226 lttng_kernel_static_type_struct_init(_nr_fields, PARAMS(_fields), _alignment) \
229 #define lttng_kernel_static_type_variant(_nr_choices, _choices, _tag_name, _alignment) \
230 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_variant, { \
232 .type = lttng_kernel_type_variant, \
234 .tag_name = (_tag_name), \
235 .choices = _choices, \
236 .nr_choices = (_nr_choices), \
237 .alignment = (_alignment), \
240 #define lttng_kernel_static_event_field(_name, _type, _nowrite, _user, _nofilter) \
241 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field, { \
244 .nowrite = (_nowrite), \
246 .nofilter = (_nofilter), \
249 #define lttng_kernel_static_event_field_array(_fields...) \
250 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field *, \
254 #define lttng_kernel_static_enum_entry_value(_string, _value) \
255 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
257 .signedness = lttng_is_signed_type(__typeof__(_value)), \
258 .value = lttng_is_signed_type(__typeof__(_value)) ? \
259 (long long) (_value) : (_value), \
262 .signedness = lttng_is_signed_type(__typeof__(_value)), \
263 .value = lttng_is_signed_type(__typeof__(_value)) ? \
264 (long long) (_value) : (_value), \
266 .string = (_string), \
269 #define lttng_kernel_static_enum_entry_range(_string, _range_start, _range_end) \
270 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
272 .signedness = lttng_is_signed_type(__typeof__(_range_start)), \
273 .value = lttng_is_signed_type(__typeof__(_range_start)) ? \
274 (long long) (_range_start) : (_range_start), \
277 .signedness = lttng_is_signed_type(__typeof__(_range_end)), \
278 .value = lttng_is_signed_type(__typeof__(_range_end)) ? \
279 (long long) (_range_end) : (_range_end), \
281 .string = (_string), \
284 #define lttng_kernel_static_enum_entry_auto(_string) \
285 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
294 .string = (_string), \
300 struct lttng_kernel_probe_ctx
{
301 struct lttng_kernel_event_common
*event
;
302 uint8_t interruptible
;
305 struct lttng_kernel_event_desc
{
306 const char *event_name
; /* lttng-modules name */
307 const char *event_kname
; /* Linux kernel name (tracepoints) */
308 const struct lttng_kernel_probe_desc
*probe_desc
;
309 void (*probe_callback
)(void);
310 const struct lttng_kernel_event_field
**fields
; /* event payload */
311 unsigned int nr_fields
;
312 struct module
*owner
;
315 struct lttng_kernel_probe_desc
{
316 const char *provider_name
;
317 const struct lttng_kernel_event_desc
**event_desc
;
318 unsigned int nr_events
;
319 struct list_head head
; /* chain registered probes */
320 struct list_head lazy_init_head
;
321 int lazy
; /* lazy registration */
325 * Result of the run_filter() callback.
327 enum lttng_kernel_event_filter_result
{
328 LTTNG_KERNEL_EVENT_FILTER_ACCEPT
= 0,
329 LTTNG_KERNEL_EVENT_FILTER_REJECT
= 1,
332 struct lttng_kernel_event_common_private
;
334 enum lttng_kernel_event_type
{
335 LTTNG_KERNEL_EVENT_TYPE_RECORDER
= 0,
336 LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
= 1,
339 struct lttng_kernel_event_common
{
340 struct lttng_kernel_event_common_private
*priv
; /* Private event interface */
342 enum lttng_kernel_event_type type
;
343 /* Get child with container_of(). */
346 int eval_filter
; /* Need to evaluate filters */
347 int (*run_filter
)(const struct lttng_kernel_event_common
*event
,
348 const char *stack_data
,
349 struct lttng_kernel_probe_ctx
*probe_ctx
,
353 struct lttng_kernel_event_recorder_private
;
355 struct lttng_kernel_event_recorder
{
356 struct lttng_kernel_event_common parent
;
357 struct lttng_kernel_event_recorder_private
*priv
; /* Private event record interface */
359 struct lttng_channel
*chan
;
362 struct lttng_kernel_notification_ctx
{
363 int eval_capture
; /* Capture evaluation available. */
366 struct lttng_kernel_event_notifier_private
;
368 struct lttng_kernel_event_notifier
{
369 struct lttng_kernel_event_common parent
;
370 struct lttng_kernel_event_notifier_private
*priv
; /* Private event notifier interface */
372 int eval_capture
; /* Need to evaluate capture */
373 void (*notification_send
)(struct lttng_kernel_event_notifier
*event_notifier
,
374 const char *stack_data
,
375 struct lttng_kernel_probe_ctx
*probe_ctx
,
376 struct lttng_kernel_notification_ctx
*notif_ctx
);
379 struct lttng_kernel_channel_buffer_ops
{
380 struct lttng_kernel_channel_buffer_ops_private
*priv
; /* Private channel buffer ops interface. */
382 int (*event_reserve
)(struct lttng_kernel_ring_buffer_ctx
*ctx
);
383 void (*event_commit
)(struct lttng_kernel_ring_buffer_ctx
*ctx
);
384 void (*event_write
)(struct lttng_kernel_ring_buffer_ctx
*ctx
, const void *src
,
386 void (*event_write_from_user
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
387 const void *src
, size_t len
);
388 void (*event_memset
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
390 void (*event_strcpy
)(struct lttng_kernel_ring_buffer_ctx
*ctx
, const char *src
,
392 void (*event_strcpy_from_user
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
393 const char __user
*src
, size_t len
);
396 struct lttng_channel
{
398 struct channel
*chan
; /* Channel buffers */
400 struct lttng_kernel_ctx
*ctx
;
401 /* Event ID management */
402 struct lttng_kernel_session
*session
;
403 struct file
*file
; /* File associated to channel */
404 unsigned int free_event_id
; /* Next event ID to allocate */
405 struct list_head list
; /* Channel list */
406 struct lttng_kernel_channel_buffer_ops
*ops
;
407 struct lttng_transport
*transport
;
408 struct hlist_head
*sc_table
; /* for syscall tracing */
409 struct hlist_head
*compat_sc_table
;
410 struct hlist_head
*sc_exit_table
; /* for syscall exit tracing */
411 struct hlist_head
*compat_sc_exit_table
;
412 struct hlist_head sc_unknown
; /* for unknown syscalls */
413 struct hlist_head sc_compat_unknown
;
414 struct hlist_head sc_exit_unknown
;
415 struct hlist_head compat_sc_exit_unknown
;
416 struct lttng_syscall_filter
*sc_filter
;
417 int header_type
; /* 0: unset, 1: compact, 2: large */
418 enum channel_type channel_type
;
419 int syscall_all_entry
;
420 int syscall_all_exit
;
421 unsigned int metadata_dumped
:1,
422 sys_enter_registered
:1,
423 sys_exit_registered
:1,
424 tstate
:1; /* Transient enable state */
427 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
429 struct lttng_dynamic_len_stack
{
430 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
434 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
437 * struct lttng_kernel_id_tracker declared in header due to deferencing of *v
438 * in RCU_INITIALIZER(v).
440 #define LTTNG_ID_HASH_BITS 6
441 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
443 struct lttng_kernel_id_tracker_rcu
{
444 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
447 struct lttng_kernel_id_tracker
{
448 struct lttng_kernel_id_tracker_private
*priv
; /* Private API */
450 struct lttng_kernel_id_tracker_rcu
*p
; /* RCU dereferenced. */
453 struct lttng_kernel_session_private
;
455 struct lttng_kernel_session
{
456 struct lttng_kernel_session_private
*priv
; /* Private session interface */
458 int active
; /* Is trace session active ? */
460 struct lttng_kernel_id_tracker pid_tracker
;
461 struct lttng_kernel_id_tracker vpid_tracker
;
462 struct lttng_kernel_id_tracker uid_tracker
;
463 struct lttng_kernel_id_tracker vuid_tracker
;
464 struct lttng_kernel_id_tracker gid_tracker
;
465 struct lttng_kernel_id_tracker vgid_tracker
;
468 int lttng_kernel_probe_register(struct lttng_kernel_probe_desc
*desc
);
469 void lttng_kernel_probe_unregister(struct lttng_kernel_probe_desc
*desc
);
471 bool lttng_id_tracker_lookup(struct lttng_kernel_id_tracker_rcu
*p
, int id
);
473 #endif /* _LTTNG_EVENTS_H */