Rename struct lib_ring_buffer_ctx to struct lttng_kernel_ring_buffer_ctx
[lttng-modules.git] / include / lttng / events.h
1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
2 *
3 * lttng/events.h
4 *
5 * Holds LTTng per-session event registry.
6 *
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 */
9
10 #ifndef _LTTNG_EVENTS_H
11 #define _LTTNG_EVENTS_H
12
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>
25
26 #define lttng_is_signed_type(type) (((type) -1) < (type) 1)
27
28 struct lttng_channel;
29 struct lttng_session;
30 struct lttng_metadata_cache;
31 struct lttng_kernel_ring_buffer_ctx;
32 struct perf_event;
33 struct perf_event_attr;
34 struct lib_ring_buffer_config;
35
36 /* Type description */
37
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,
47 };
48
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,
54 };
55
56 enum channel_type {
57 PER_CPU_CHANNEL,
58 METADATA_CHANNEL,
59 };
60
61 struct lttng_kernel_enum_value {
62 unsigned long long value;
63 unsigned int signedness:1;
64 };
65
66 struct lttng_kernel_enum_entry {
67 struct lttng_kernel_enum_value start, end; /* start and end are inclusive */
68 const char *string;
69 struct {
70 unsigned int is_auto:1;
71 } options;
72 };
73
74 /*
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.
77 */
78 struct lttng_kernel_type_common {
79 enum lttng_kernel_type type;
80 };
81
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,
87 reverse_byte_order:1;
88 unsigned int base; /* 2, 8, 10, 16, for pretty print */
89 };
90
91 struct lttng_kernel_type_string {
92 struct lttng_kernel_type_common parent;
93 enum lttng_kernel_string_encoding encoding;
94 };
95
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;
100 };
101
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;
108 };
109
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;
116 };
117
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;
123 };
124
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;
131 };
132
133 struct lttng_kernel_enum_desc {
134 const char *name;
135 const struct lttng_kernel_enum_entry **entries;
136 unsigned int nr_entries;
137 };
138
139 /* Event field description */
140
141 struct lttng_kernel_event_field {
142 const char *name;
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 */
147 };
148
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, { \
151 .parent = { \
152 .type = lttng_kernel_type_integer, \
153 }, \
154 .size = (_size), \
155 .alignment = (_alignment), \
156 .signedness = (_signedness), \
157 .reverse_byte_order = (_byte_order) != __BYTE_ORDER, \
158 .base = (_base), \
159 }))
160
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), \
165 _byte_order, \
166 _base)
167
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, { \
170 .parent = { \
171 .type = lttng_kernel_type_enum, \
172 }, \
173 .desc = (_desc), \
174 .container_type = (_container_type), \
175 }))
176
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, { \
179 .parent = { \
180 .type = lttng_kernel_type_array, \
181 }, \
182 .length = (_length), \
183 .alignment = (_alignment), \
184 .encoding = lttng_kernel_string_encoding_##_encoding, \
185 .elem_type = (_elem_type), \
186 }))
187
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), \
192 __BYTE_ORDER, 10), \
193 0, UTF8)
194
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, { \
197 .parent = { \
198 .type = lttng_kernel_type_sequence, \
199 }, \
200 .length_name = (_length_name), \
201 .alignment = (_alignment), \
202 .encoding = lttng_kernel_string_encoding_##_encoding, \
203 .elem_type = (_elem_type), \
204 }))
205
206 #define lttng_kernel_static_type_string(_encoding) \
207 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_string, { \
208 .parent = { \
209 .type = lttng_kernel_type_string, \
210 }, \
211 .encoding = lttng_kernel_string_encoding_##_encoding, \
212 }))
213
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, { \
216 .parent = { \
217 .type = lttng_kernel_type_struct, \
218 }, \
219 .nr_fields = (_nr_fields), \
220 .fields = _fields, \
221 .alignment = (_alignment), \
222 }))
223
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, { \
226 .parent = { \
227 .type = lttng_kernel_type_variant, \
228 }, \
229 .tag_name = (_tag_name), \
230 .choices = _choices, \
231 .nr_choices = (_nr_choices), \
232 .alignment = (_alignment), \
233 }))
234
235 #define lttng_kernel_static_event_field(_name, _type, _nowrite, _user, _nofilter) \
236 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field, { \
237 .name = (_name), \
238 .type = (_type), \
239 .nowrite = (_nowrite), \
240 .user = (_user), \
241 .nofilter = (_nofilter), \
242 })
243
244 #define lttng_kernel_static_event_field_array(_fields...) \
245 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field *, \
246 _fields \
247 )
248
249 #define lttng_kernel_static_enum_entry_value(_string, _value) \
250 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
251 .start = { \
252 .signedness = lttng_is_signed_type(__typeof__(_value)), \
253 .value = lttng_is_signed_type(__typeof__(_value)) ? \
254 (long long) (_value) : (_value), \
255 }, \
256 .end = { \
257 .signedness = lttng_is_signed_type(__typeof__(_value)), \
258 .value = lttng_is_signed_type(__typeof__(_value)) ? \
259 (long long) (_value) : (_value), \
260 }, \
261 .string = (_string), \
262 }),
263
264 #define lttng_kernel_static_enum_entry_range(_string, _range_start, _range_end) \
265 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
266 .start = { \
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), \
270 }, \
271 .end = { \
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), \
275 }, \
276 .string = (_string), \
277 }),
278
279 #define lttng_kernel_static_enum_entry_auto(_string) \
280 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
281 .start = { \
282 .signedness = -1, \
283 .value = -1, \
284 }, \
285 .end = { \
286 .signedness = -1, \
287 .value = -1, \
288 }, \
289 .string = (_string), \
290 .options = { \
291 .is_auto = 1, \
292 } \
293 }),
294
295 struct lttng_kernel_probe_ctx {
296 struct lttng_kernel_event_common *event;
297 uint8_t interruptible;
298 };
299
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;
308 };
309
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 */
317 };
318
319 /*
320 * Result of the run_filter() callback.
321 */
322 enum lttng_kernel_event_filter_result {
323 LTTNG_KERNEL_EVENT_FILTER_ACCEPT = 0,
324 LTTNG_KERNEL_EVENT_FILTER_REJECT = 1,
325 };
326
327 struct lttng_kernel_event_common_private;
328
329 enum lttng_kernel_event_type {
330 LTTNG_KERNEL_EVENT_TYPE_RECORDER = 0,
331 LTTNG_KERNEL_EVENT_TYPE_NOTIFIER = 1,
332 };
333
334 struct lttng_kernel_event_common {
335 struct lttng_kernel_event_common_private *priv; /* Private event interface */
336
337 enum lttng_kernel_event_type type;
338 /* Get child with container_of(). */
339
340 int enabled;
341 int eval_filter; /* Need to evaluate filters */
342 int (*run_filter)(const struct lttng_kernel_event_common *event,
343 const char *stack_data,
344 struct lttng_kernel_probe_ctx *probe_ctx,
345 void *filter_ctx);
346 };
347
348 struct lttng_kernel_event_recorder_private;
349
350 struct lttng_kernel_event_recorder {
351 struct lttng_kernel_event_common parent;
352 struct lttng_kernel_event_recorder_private *priv; /* Private event record interface */
353
354 struct lttng_channel *chan;
355 };
356
357 struct lttng_kernel_notification_ctx {
358 int eval_capture; /* Capture evaluation available. */
359 };
360
361 struct lttng_kernel_event_notifier_private;
362
363 struct lttng_kernel_event_notifier {
364 struct lttng_kernel_event_common parent;
365 struct lttng_kernel_event_notifier_private *priv; /* Private event notifier interface */
366
367 int eval_capture; /* Need to evaluate capture */
368 void (*notification_send)(struct lttng_kernel_event_notifier *event_notifier,
369 const char *stack_data,
370 struct lttng_kernel_probe_ctx *probe_ctx,
371 struct lttng_kernel_notification_ctx *notif_ctx);
372 };
373
374 struct lttng_kernel_channel_buffer_ops {
375 struct lttng_kernel_channel_buffer_ops_private *priv; /* Private channel buffer ops interface. */
376
377 int (*event_reserve)(struct lttng_kernel_ring_buffer_ctx *ctx);
378 void (*event_commit)(struct lttng_kernel_ring_buffer_ctx *ctx);
379 void (*event_write)(struct lttng_kernel_ring_buffer_ctx *ctx, const void *src,
380 size_t len);
381 void (*event_write_from_user)(struct lttng_kernel_ring_buffer_ctx *ctx,
382 const void *src, size_t len);
383 void (*event_memset)(struct lttng_kernel_ring_buffer_ctx *ctx,
384 int c, size_t len);
385 void (*event_strcpy)(struct lttng_kernel_ring_buffer_ctx *ctx, const char *src,
386 size_t len);
387 void (*event_strcpy_from_user)(struct lttng_kernel_ring_buffer_ctx *ctx,
388 const char __user *src, size_t len);
389 };
390
391 struct lttng_counter_ops {
392 struct lib_counter *(*counter_create)(size_t nr_dimensions,
393 const size_t *max_nr_elem, /* for each dimension */
394 int64_t global_sum_step);
395 void (*counter_destroy)(struct lib_counter *counter);
396 int (*counter_add)(struct lib_counter *counter, const size_t *dimension_indexes,
397 int64_t v);
398 /*
399 * counter_read reads a specific cpu's counter if @cpu >= 0, or
400 * the global aggregation counter if @cpu == -1.
401 */
402 int (*counter_read)(struct lib_counter *counter, const size_t *dimension_indexes, int cpu,
403 int64_t *value, bool *overflow, bool *underflow);
404 /*
405 * counter_aggregate returns the total sum of all per-cpu counters and
406 * the global aggregation counter.
407 */
408 int (*counter_aggregate)(struct lib_counter *counter, const size_t *dimension_indexes,
409 int64_t *value, bool *overflow, bool *underflow);
410 int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
411 };
412
413 struct lttng_transport {
414 char *name;
415 struct module *owner;
416 struct list_head node;
417 struct lttng_kernel_channel_buffer_ops ops;
418 };
419
420 struct lttng_counter_transport {
421 char *name;
422 struct module *owner;
423 struct list_head node;
424 struct lttng_counter_ops ops;
425 };
426
427 struct lttng_syscall_filter;
428
429 #define LTTNG_EVENT_HT_BITS 12
430 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
431
432 struct lttng_event_ht {
433 struct hlist_head table[LTTNG_EVENT_HT_SIZE];
434 };
435
436 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
437 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
438
439 struct lttng_event_notifier_ht {
440 struct hlist_head table[LTTNG_EVENT_NOTIFIER_HT_SIZE];
441 };
442
443 struct lttng_channel {
444 unsigned int id;
445 struct channel *chan; /* Channel buffers */
446 int enabled;
447 struct lttng_kernel_ctx *ctx;
448 /* Event ID management */
449 struct lttng_session *session;
450 struct file *file; /* File associated to channel */
451 unsigned int free_event_id; /* Next event ID to allocate */
452 struct list_head list; /* Channel list */
453 struct lttng_kernel_channel_buffer_ops *ops;
454 struct lttng_transport *transport;
455 struct hlist_head *sc_table; /* for syscall tracing */
456 struct hlist_head *compat_sc_table;
457 struct hlist_head *sc_exit_table; /* for syscall exit tracing */
458 struct hlist_head *compat_sc_exit_table;
459 struct hlist_head sc_unknown; /* for unknown syscalls */
460 struct hlist_head sc_compat_unknown;
461 struct hlist_head sc_exit_unknown;
462 struct hlist_head compat_sc_exit_unknown;
463 struct lttng_syscall_filter *sc_filter;
464 int header_type; /* 0: unset, 1: compact, 2: large */
465 enum channel_type channel_type;
466 int syscall_all_entry;
467 int syscall_all_exit;
468 unsigned int metadata_dumped:1,
469 sys_enter_registered:1,
470 sys_exit_registered:1,
471 tstate:1; /* Transient enable state */
472 };
473
474 struct lttng_metadata_stream {
475 void *priv; /* Ring buffer private data */
476 struct lttng_metadata_cache *metadata_cache;
477 unsigned int metadata_in; /* Bytes read from the cache */
478 unsigned int metadata_out; /* Bytes consumed from stream */
479 int finalized; /* Has channel been finalized */
480 wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
481 struct list_head list; /* Stream list */
482 struct lttng_transport *transport;
483 uint64_t version; /* Current version of the metadata cache */
484 bool coherent; /* Stream in a coherent state */
485 };
486
487 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
488
489 struct lttng_dynamic_len_stack {
490 size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
491 size_t offset;
492 };
493
494 DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
495
496 /*
497 * struct lttng_id_tracker declared in header due to deferencing of *v
498 * in RCU_INITIALIZER(v).
499 */
500 #define LTTNG_ID_HASH_BITS 6
501 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
502
503 enum tracker_type {
504 TRACKER_PID,
505 TRACKER_VPID,
506 TRACKER_UID,
507 TRACKER_VUID,
508 TRACKER_GID,
509 TRACKER_VGID,
510
511 TRACKER_UNKNOWN,
512 };
513
514 struct lttng_id_tracker_rcu {
515 struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
516 };
517
518 struct lttng_id_tracker {
519 struct lttng_session *session;
520 enum tracker_type tracker_type;
521 struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
522 };
523
524 struct lttng_id_hash_node {
525 struct hlist_node hlist;
526 int id;
527 };
528
529 struct lttng_session {
530 int active; /* Is trace session active ? */
531 int been_active; /* Has trace session been active ? */
532 struct file *file; /* File associated to session */
533 struct list_head chan; /* Channel list head */
534 struct list_head events; /* Event list head */
535 struct list_head list; /* Session list */
536 unsigned int free_chan_id; /* Next chan ID to allocate */
537 uuid_le uuid; /* Trace session unique ID */
538 struct lttng_metadata_cache *metadata_cache;
539 struct lttng_id_tracker pid_tracker;
540 struct lttng_id_tracker vpid_tracker;
541 struct lttng_id_tracker uid_tracker;
542 struct lttng_id_tracker vuid_tracker;
543 struct lttng_id_tracker gid_tracker;
544 struct lttng_id_tracker vgid_tracker;
545 unsigned int metadata_dumped:1,
546 tstate:1; /* Transient enable state */
547 /* List of event enablers */
548 struct list_head enablers_head;
549 /* Hash table of events */
550 struct lttng_event_ht events_ht;
551 char name[LTTNG_KERNEL_ABI_SESSION_NAME_LEN];
552 char creation_time[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN];
553 };
554
555 struct lttng_counter {
556 struct file *file; /* File associated to counter. */
557 struct file *owner;
558 struct lttng_counter_transport *transport;
559 struct lib_counter *counter;
560 struct lttng_counter_ops *ops;
561 };
562
563 struct lttng_event_notifier_group {
564 struct file *file; /* File associated to event notifier group */
565 struct file *notif_file; /* File used to expose notifications to userspace. */
566 struct list_head node; /* event notifier group list */
567 struct list_head enablers_head; /* List of enablers */
568 struct list_head event_notifiers_head; /* List of event notifier */
569 struct lttng_event_notifier_ht event_notifiers_ht; /* Hash table of event notifiers */
570 struct lttng_kernel_channel_buffer_ops *ops;
571 struct lttng_transport *transport;
572 struct channel *chan; /* Ring buffer channel for event notifier group. */
573 struct lib_ring_buffer *buf; /* Ring buffer for event notifier group. */
574 wait_queue_head_t read_wait;
575 struct irq_work wakeup_pending; /* Pending wakeup irq work. */
576 struct lttng_kernel_event_notifier *sc_unknown; /* for unknown syscalls */
577 struct lttng_kernel_event_notifier *sc_compat_unknown;
578
579 struct lttng_syscall_filter *sc_filter;
580
581 struct hlist_head *event_notifier_syscall_dispatch;
582 struct hlist_head *event_notifier_compat_syscall_dispatch;
583 struct hlist_head *event_notifier_exit_syscall_dispatch;
584 struct hlist_head *event_notifier_exit_compat_syscall_dispatch;
585
586 struct hlist_head event_notifier_unknown_syscall_dispatch;
587 struct hlist_head event_notifier_compat_unknown_syscall_dispatch;
588 struct hlist_head event_notifier_exit_unknown_syscall_dispatch;
589 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch;
590
591 int syscall_all_entry;
592 int syscall_all_exit;
593
594 unsigned int sys_enter_registered:1, sys_exit_registered:1;
595
596 struct lttng_counter *error_counter;
597 size_t error_counter_len;
598 };
599
600 int lttng_kernel_probe_register(struct lttng_kernel_probe_desc *desc);
601 void lttng_kernel_probe_unregister(struct lttng_kernel_probe_desc *desc);
602
603 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
604
605 #endif /* _LTTNG_EVENTS_H */
This page took 0.041834 seconds and 4 git commands to generate.