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)
28 struct lttng_kernel_channel_buffer
;
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
,
52 struct lttng_kernel_enum_value
{
53 unsigned long long value
;
54 unsigned int signedness
:1;
57 struct lttng_kernel_enum_entry
{
58 struct lttng_kernel_enum_value start
, end
; /* start and end are inclusive */
61 unsigned int is_auto
:1;
66 * struct lttng_kernel_type_common is fixed-size. Its children inherits
67 * from it by embedding struct lttng_kernel_type_common as its first field.
69 struct lttng_kernel_type_common
{
70 enum lttng_kernel_type type
;
73 struct lttng_kernel_type_integer
{
74 struct lttng_kernel_type_common parent
;
75 unsigned int size
; /* in bits */
76 unsigned short alignment
; /* in bits */
77 unsigned int signedness
:1,
79 user
:1; /* fetch from user-space */
80 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
83 struct lttng_kernel_type_string
{
84 struct lttng_kernel_type_common parent
;
85 enum lttng_kernel_string_encoding encoding
;
86 unsigned int user
:1; /* fetch from user-space */
89 struct lttng_kernel_type_enum
{
90 struct lttng_kernel_type_common parent
;
91 const struct lttng_kernel_enum_desc
*desc
; /* Enumeration mapping */
92 const struct lttng_kernel_type_common
*container_type
;
95 struct lttng_kernel_type_array
{
96 struct lttng_kernel_type_common parent
;
97 const struct lttng_kernel_type_common
*elem_type
;
98 unsigned int length
; /* Num. elems. */
99 unsigned int alignment
; /* Alignment in bytes before elements. */
100 enum lttng_kernel_string_encoding encoding
;
103 struct lttng_kernel_type_sequence
{
104 struct lttng_kernel_type_common parent
;
105 const char *length_name
; /* Length field name. If NULL, use previous field. */
106 const struct lttng_kernel_type_common
*elem_type
;
107 unsigned int alignment
; /* Alignment in bytes before elements. */
108 enum lttng_kernel_string_encoding encoding
;
111 struct lttng_kernel_type_struct
{
112 struct lttng_kernel_type_common parent
;
113 unsigned int nr_fields
;
114 const struct lttng_kernel_event_field
* const *fields
; /* Array of pointers to fields. */
115 unsigned int alignment
; /* Alignment in bits */
118 struct lttng_kernel_type_variant
{
119 struct lttng_kernel_type_common parent
;
120 const char *tag_name
; /* Tag field name. If NULL, use previous field. */
121 const struct lttng_kernel_event_field
* const *choices
; /* Array of pointers to fields. */
122 unsigned int nr_choices
;
123 unsigned int alignment
; /* Alignment in bytes */
126 struct lttng_kernel_enum_desc
{
128 const struct lttng_kernel_enum_entry
* const *entries
;
129 unsigned int nr_entries
;
130 const struct lttng_kernel_probe_desc
*probe_desc
;
133 /* Event field description */
135 struct lttng_kernel_event_field
{
137 const struct lttng_kernel_type_common
*type
;
138 unsigned int nowrite
:1, /* do not write into trace */
139 nofilter
:1; /* do not consider for filter */
143 #define PARAMS(args...) args
146 #define _lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, _user, _base) \
147 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_integer, { \
149 .type = lttng_kernel_type_integer, \
152 .alignment = (_alignment), \
153 .signedness = (_signedness), \
154 .reverse_byte_order = (_byte_order) != __BYTE_ORDER, \
159 #define lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, _base) \
160 _lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, 0, _base)
162 #define lttng_kernel_static_type_user_integer(_size, _alignment, _signedness, _byte_order, _base) \
163 _lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, 1, _base)
165 #define _lttng_kernel_static_type_integer_from_type(_type, _byte_order, _user, _base) \
166 _lttng_kernel_static_type_integer(sizeof(_type) * CHAR_BIT, \
167 lttng_alignof(_type) * CHAR_BIT, \
168 lttng_is_signed_type(_type), \
169 _byte_order, _user, _base)
171 #define lttng_kernel_static_type_integer_from_type(_type, _byte_order, _base) \
172 _lttng_kernel_static_type_integer_from_type(_type, _byte_order, 0, _base)
174 #define lttng_kernel_static_type_user_integer_from_type(_type, _byte_order, _base) \
175 _lttng_kernel_static_type_integer_from_type(_type, _byte_order, 1, _base)
177 #define lttng_kernel_static_type_enum(_desc, _container_type) \
178 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_enum, { \
180 .type = lttng_kernel_type_enum, \
183 .container_type = (_container_type), \
186 #define lttng_kernel_static_type_array(_length, _elem_type, _alignment, _encoding) \
187 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_array, { \
189 .type = lttng_kernel_type_array, \
191 .length = (_length), \
192 .alignment = (_alignment), \
193 .encoding = lttng_kernel_string_encoding_##_encoding, \
194 .elem_type = (_elem_type), \
197 #define lttng_kernel_static_type_array_text(_length) \
198 lttng_kernel_static_type_array(_length, \
199 lttng_kernel_static_type_integer(sizeof(char) * CHAR_BIT, \
200 lttng_alignof(char) * CHAR_BIT, lttng_is_signed_type(char), \
204 #define lttng_kernel_static_type_sequence(_length_name, _elem_type, _alignment, _encoding) \
205 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_sequence, { \
207 .type = lttng_kernel_type_sequence, \
209 .length_name = (_length_name), \
210 .alignment = (_alignment), \
211 .encoding = lttng_kernel_string_encoding_##_encoding, \
212 .elem_type = (_elem_type), \
215 #define lttng_kernel_static_type_string(_encoding, _user) \
216 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_string, { \
218 .type = lttng_kernel_type_string, \
220 .encoding = lttng_kernel_string_encoding_##_encoding, \
224 #define lttng_kernel_static_type_struct_init(_nr_fields, _fields, _alignment) \
227 .type = lttng_kernel_type_struct, \
229 .nr_fields = (_nr_fields), \
231 .alignment = (_alignment), \
234 #define lttng_kernel_static_type_struct(_nr_fields, _fields, _alignment) \
235 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_struct, \
236 lttng_kernel_static_type_struct_init(_nr_fields, PARAMS(_fields), _alignment) \
239 #define lttng_kernel_static_type_variant(_nr_choices, _choices, _tag_name, _alignment) \
240 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_variant, { \
242 .type = lttng_kernel_type_variant, \
244 .tag_name = (_tag_name), \
245 .choices = _choices, \
246 .nr_choices = (_nr_choices), \
247 .alignment = (_alignment), \
250 #define lttng_kernel_static_event_field(_name, _type, _nowrite, _nofilter) \
251 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field, { \
254 .nowrite = (_nowrite), \
255 .nofilter = (_nofilter), \
258 #define lttng_kernel_static_event_field_array(_fields...) \
259 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field *, \
263 #define lttng_kernel_static_enum_entry_value(_string, _value) \
264 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
266 .signedness = lttng_is_signed_type(__typeof__(_value)), \
267 .value = lttng_is_signed_type(__typeof__(_value)) ? \
268 (long long) (_value) : (_value), \
271 .signedness = lttng_is_signed_type(__typeof__(_value)), \
272 .value = lttng_is_signed_type(__typeof__(_value)) ? \
273 (long long) (_value) : (_value), \
275 .string = (_string), \
278 #define lttng_kernel_static_enum_entry_range(_string, _range_start, _range_end) \
279 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
281 .signedness = lttng_is_signed_type(__typeof__(_range_start)), \
282 .value = lttng_is_signed_type(__typeof__(_range_start)) ? \
283 (long long) (_range_start) : (_range_start), \
286 .signedness = lttng_is_signed_type(__typeof__(_range_end)), \
287 .value = lttng_is_signed_type(__typeof__(_range_end)) ? \
288 (long long) (_range_end) : (_range_end), \
290 .string = (_string), \
293 #define lttng_kernel_static_enum_entry_auto(_string) \
294 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
303 .string = (_string), \
309 struct lttng_kernel_probe_ctx
{
310 struct lttng_kernel_event_common
*event
;
311 uint8_t interruptible
;
314 struct lttng_kernel_tracepoint_class
{
315 void (*probe_callback
)(void);
316 const struct lttng_kernel_event_field
* const *fields
; /* event payload */
317 unsigned int nr_fields
;
318 const struct lttng_kernel_probe_desc
*probe_desc
;
321 struct lttng_kernel_event_desc
{
322 const char *event_name
; /* lttng-modules name */
323 const char *event_kname
; /* Linux kernel name (tracepoints) */
324 const struct lttng_kernel_probe_desc
*probe_desc
;
325 const struct lttng_kernel_tracepoint_class
*tp_class
;
326 struct module
*owner
;
329 struct lttng_kernel_probe_desc
{
330 const char *provider_name
;
331 const struct lttng_kernel_event_desc
* const *event_desc
;
332 unsigned int nr_events
;
333 struct list_head head
; /* chain registered probes */
334 struct list_head lazy_init_head
;
335 int lazy
; /* lazy registration */
339 * Result of the run_filter() callback.
341 enum lttng_kernel_event_filter_result
{
342 LTTNG_KERNEL_EVENT_FILTER_ACCEPT
= 0,
343 LTTNG_KERNEL_EVENT_FILTER_REJECT
= 1,
346 struct lttng_kernel_event_common_private
;
348 enum lttng_kernel_event_type
{
349 LTTNG_KERNEL_EVENT_TYPE_RECORDER
= 0,
350 LTTNG_KERNEL_EVENT_TYPE_NOTIFIER
= 1,
353 struct lttng_kernel_event_common
{
354 struct lttng_kernel_event_common_private
*priv
; /* Private event interface */
356 enum lttng_kernel_event_type type
;
357 /* Get child with container_of(). */
360 int eval_filter
; /* Need to evaluate filters */
361 int (*run_filter
)(const struct lttng_kernel_event_common
*event
,
362 const char *stack_data
,
363 struct lttng_kernel_probe_ctx
*probe_ctx
,
367 struct lttng_kernel_event_recorder_private
;
369 struct lttng_kernel_event_recorder
{
370 struct lttng_kernel_event_common parent
;
371 struct lttng_kernel_event_recorder_private
*priv
; /* Private event record interface */
373 struct lttng_kernel_channel_buffer
*chan
;
376 struct lttng_kernel_notification_ctx
{
377 int eval_capture
; /* Capture evaluation available. */
380 struct lttng_kernel_event_notifier_private
;
382 struct lttng_kernel_event_notifier
{
383 struct lttng_kernel_event_common parent
;
384 struct lttng_kernel_event_notifier_private
*priv
; /* Private event notifier interface */
386 int eval_capture
; /* Need to evaluate capture */
387 void (*notification_send
)(struct lttng_kernel_event_notifier
*event_notifier
,
388 const char *stack_data
,
389 struct lttng_kernel_probe_ctx
*probe_ctx
,
390 struct lttng_kernel_notification_ctx
*notif_ctx
);
393 struct lttng_kernel_channel_buffer_ops
{
394 struct lttng_kernel_channel_buffer_ops_private
*priv
; /* Private channel buffer ops interface. */
396 int (*event_reserve
)(struct lttng_kernel_ring_buffer_ctx
*ctx
);
397 void (*event_commit
)(struct lttng_kernel_ring_buffer_ctx
*ctx
);
398 void (*event_write
)(struct lttng_kernel_ring_buffer_ctx
*ctx
, const void *src
,
399 size_t len
, size_t alignment
);
400 void (*event_write_from_user
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
401 const void *src
, size_t len
, size_t alignment
);
402 void (*event_memset
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
404 void (*event_strcpy
)(struct lttng_kernel_ring_buffer_ctx
*ctx
, const char *src
,
406 void (*event_strcpy_from_user
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
407 const char __user
*src
, size_t len
);
408 void (*event_pstrcpy_pad
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
409 const char *src
, size_t len
);
410 void (*event_pstrcpy_pad_from_user
)(struct lttng_kernel_ring_buffer_ctx
*ctx
,
411 const char __user
*src
, size_t len
);
412 void (*lost_event_too_big
)(struct lttng_kernel_channel_buffer
*lttng_channel
);
415 enum lttng_kernel_channel_type
{
416 LTTNG_KERNEL_CHANNEL_TYPE_BUFFER
= 0,
419 struct lttng_kernel_channel_common_private
;
421 /* Use container_of() to get child. */
422 struct lttng_kernel_channel_common
{
423 struct lttng_kernel_channel_common_private
*priv
; /* Private channel interface. */
425 enum lttng_kernel_channel_type type
;
428 struct lttng_kernel_session
*session
;
431 struct lttng_kernel_channel_buffer_private
;
433 struct lttng_kernel_channel_buffer
{
434 struct lttng_kernel_channel_common parent
;
435 struct lttng_kernel_channel_buffer_private
*priv
;
437 struct lttng_kernel_channel_buffer_ops
*ops
;
440 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
442 struct lttng_dynamic_len_stack
{
443 size_t stack
[LTTNG_DYNAMIC_LEN_STACK_SIZE
];
447 DECLARE_PER_CPU(struct lttng_dynamic_len_stack
, lttng_dynamic_len_stack
);
450 * struct lttng_kernel_id_tracker declared in header due to deferencing of *v
451 * in RCU_INITIALIZER(v).
453 #define LTTNG_ID_HASH_BITS 6
454 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
456 struct lttng_kernel_id_tracker_rcu
{
457 struct hlist_head id_hash
[LTTNG_ID_TABLE_SIZE
];
460 struct lttng_kernel_id_tracker
{
461 struct lttng_kernel_id_tracker_private
*priv
; /* Private API */
463 struct lttng_kernel_id_tracker_rcu
*p
; /* RCU dereferenced. */
466 struct lttng_kernel_session_private
;
468 struct lttng_kernel_session
{
469 struct lttng_kernel_session_private
*priv
; /* Private session interface */
471 int active
; /* Is trace session active ? */
473 struct lttng_kernel_id_tracker pid_tracker
;
474 struct lttng_kernel_id_tracker vpid_tracker
;
475 struct lttng_kernel_id_tracker uid_tracker
;
476 struct lttng_kernel_id_tracker vuid_tracker
;
477 struct lttng_kernel_id_tracker gid_tracker
;
478 struct lttng_kernel_id_tracker vgid_tracker
;
481 int lttng_kernel_probe_register(struct lttng_kernel_probe_desc
*desc
);
482 void lttng_kernel_probe_unregister(struct lttng_kernel_probe_desc
*desc
);
484 bool lttng_id_tracker_lookup(struct lttng_kernel_id_tracker_rcu
*p
, int id
);
486 #endif /* _LTTNG_EVENTS_H */