Move bytecode structures to internal header
[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 lib_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 struct lttng_krp; /* Kretprobe handling */
320
321 /*
322 * Objects in a linked-list of enablers, owned by an event.
323 */
324 struct lttng_enabler_ref {
325 struct list_head node; /* enabler ref list */
326 struct lttng_enabler *ref; /* backward ref */
327 };
328
329 struct lttng_uprobe_handler {
330 struct lttng_kernel_event_common *event;
331 loff_t offset;
332 struct uprobe_consumer up_consumer;
333 struct list_head node;
334 };
335
336 struct lttng_kprobe {
337 struct kprobe kp;
338 char *symbol_name;
339 };
340
341 struct lttng_uprobe {
342 struct inode *inode;
343 struct list_head head;
344 };
345
346 enum lttng_syscall_entryexit {
347 LTTNG_SYSCALL_ENTRY,
348 LTTNG_SYSCALL_EXIT,
349 };
350
351 enum lttng_syscall_abi {
352 LTTNG_SYSCALL_ABI_NATIVE,
353 LTTNG_SYSCALL_ABI_COMPAT,
354 };
355
356 /*
357 * Result of the run_filter() callback.
358 */
359 enum lttng_kernel_event_filter_result {
360 LTTNG_KERNEL_EVENT_FILTER_ACCEPT = 0,
361 LTTNG_KERNEL_EVENT_FILTER_REJECT = 1,
362 };
363
364 struct lttng_kernel_event_common_private;
365
366 enum lttng_kernel_event_type {
367 LTTNG_KERNEL_EVENT_TYPE_RECORDER = 0,
368 LTTNG_KERNEL_EVENT_TYPE_NOTIFIER = 1,
369 };
370
371 struct lttng_kernel_event_common {
372 struct lttng_kernel_event_common_private *priv; /* Private event interface */
373
374 enum lttng_kernel_event_type type;
375 /* Get child with container_of(). */
376
377 int enabled;
378 int eval_filter; /* Need to evaluate filters */
379 int (*run_filter)(const struct lttng_kernel_event_common *event,
380 const char *stack_data,
381 struct lttng_kernel_probe_ctx *probe_ctx,
382 void *filter_ctx);
383 };
384
385 struct lttng_kernel_event_recorder_private;
386
387 struct lttng_kernel_event_recorder {
388 struct lttng_kernel_event_common parent;
389 struct lttng_kernel_event_recorder_private *priv; /* Private event record interface */
390
391 struct lttng_channel *chan;
392 };
393
394 struct lttng_kernel_notification_ctx {
395 int eval_capture; /* Capture evaluation available. */
396 };
397
398 struct lttng_kernel_event_notifier_private;
399
400 struct lttng_kernel_event_notifier {
401 struct lttng_kernel_event_common parent;
402 struct lttng_kernel_event_notifier_private *priv; /* Private event notifier interface */
403
404 int eval_capture; /* Need to evaluate capture */
405 void (*notification_send)(struct lttng_kernel_event_notifier *event_notifier,
406 const char *stack_data,
407 struct lttng_kernel_probe_ctx *probe_ctx,
408 struct lttng_kernel_notification_ctx *notif_ctx);
409 };
410
411 enum lttng_enabler_format_type {
412 LTTNG_ENABLER_FORMAT_STAR_GLOB,
413 LTTNG_ENABLER_FORMAT_NAME,
414 };
415
416 struct lttng_channel_ops {
417 struct channel *(*channel_create)(const char *name,
418 void *priv,
419 void *buf_addr,
420 size_t subbuf_size, size_t num_subbuf,
421 unsigned int switch_timer_interval,
422 unsigned int read_timer_interval);
423 void (*channel_destroy)(struct channel *chan);
424 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
425 int (*buffer_has_read_closed_stream)(struct channel *chan);
426 void (*buffer_read_close)(struct lib_ring_buffer *buf);
427 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx);
428 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
429 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
430 size_t len);
431 void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
432 const void *src, size_t len);
433 void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
434 int c, size_t len);
435 void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
436 size_t len);
437 void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
438 const char __user *src, size_t len);
439 /*
440 * packet_avail_size returns the available size in the current
441 * packet. Note that the size returned is only a hint, since it
442 * may change due to concurrent writes.
443 */
444 size_t (*packet_avail_size)(struct channel *chan);
445 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
446 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
447 int (*is_finalized)(struct channel *chan);
448 int (*is_disabled)(struct channel *chan);
449 int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
450 struct lib_ring_buffer *bufb,
451 uint64_t *timestamp_begin);
452 int (*timestamp_end) (const struct lib_ring_buffer_config *config,
453 struct lib_ring_buffer *bufb,
454 uint64_t *timestamp_end);
455 int (*events_discarded) (const struct lib_ring_buffer_config *config,
456 struct lib_ring_buffer *bufb,
457 uint64_t *events_discarded);
458 int (*content_size) (const struct lib_ring_buffer_config *config,
459 struct lib_ring_buffer *bufb,
460 uint64_t *content_size);
461 int (*packet_size) (const struct lib_ring_buffer_config *config,
462 struct lib_ring_buffer *bufb,
463 uint64_t *packet_size);
464 int (*stream_id) (const struct lib_ring_buffer_config *config,
465 struct lib_ring_buffer *bufb,
466 uint64_t *stream_id);
467 int (*current_timestamp) (const struct lib_ring_buffer_config *config,
468 struct lib_ring_buffer *bufb,
469 uint64_t *ts);
470 int (*sequence_number) (const struct lib_ring_buffer_config *config,
471 struct lib_ring_buffer *bufb,
472 uint64_t *seq);
473 int (*instance_id) (const struct lib_ring_buffer_config *config,
474 struct lib_ring_buffer *bufb,
475 uint64_t *id);
476 };
477
478 struct lttng_counter_ops {
479 struct lib_counter *(*counter_create)(size_t nr_dimensions,
480 const size_t *max_nr_elem, /* for each dimension */
481 int64_t global_sum_step);
482 void (*counter_destroy)(struct lib_counter *counter);
483 int (*counter_add)(struct lib_counter *counter, const size_t *dimension_indexes,
484 int64_t v);
485 /*
486 * counter_read reads a specific cpu's counter if @cpu >= 0, or
487 * the global aggregation counter if @cpu == -1.
488 */
489 int (*counter_read)(struct lib_counter *counter, const size_t *dimension_indexes, int cpu,
490 int64_t *value, bool *overflow, bool *underflow);
491 /*
492 * counter_aggregate returns the total sum of all per-cpu counters and
493 * the global aggregation counter.
494 */
495 int (*counter_aggregate)(struct lib_counter *counter, const size_t *dimension_indexes,
496 int64_t *value, bool *overflow, bool *underflow);
497 int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
498 };
499
500 struct lttng_transport {
501 char *name;
502 struct module *owner;
503 struct list_head node;
504 struct lttng_channel_ops ops;
505 };
506
507 struct lttng_counter_transport {
508 char *name;
509 struct module *owner;
510 struct list_head node;
511 struct lttng_counter_ops ops;
512 };
513
514 struct lttng_syscall_filter;
515
516 #define LTTNG_EVENT_HT_BITS 12
517 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
518
519 struct lttng_event_ht {
520 struct hlist_head table[LTTNG_EVENT_HT_SIZE];
521 };
522
523 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
524 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
525
526 struct lttng_event_notifier_ht {
527 struct hlist_head table[LTTNG_EVENT_NOTIFIER_HT_SIZE];
528 };
529
530 struct lttng_channel {
531 unsigned int id;
532 struct channel *chan; /* Channel buffers */
533 int enabled;
534 struct lttng_kernel_ctx *ctx;
535 /* Event ID management */
536 struct lttng_session *session;
537 struct file *file; /* File associated to channel */
538 unsigned int free_event_id; /* Next event ID to allocate */
539 struct list_head list; /* Channel list */
540 struct lttng_channel_ops *ops;
541 struct lttng_transport *transport;
542 struct hlist_head *sc_table; /* for syscall tracing */
543 struct hlist_head *compat_sc_table;
544 struct hlist_head *sc_exit_table; /* for syscall exit tracing */
545 struct hlist_head *compat_sc_exit_table;
546 struct hlist_head sc_unknown; /* for unknown syscalls */
547 struct hlist_head sc_compat_unknown;
548 struct hlist_head sc_exit_unknown;
549 struct hlist_head compat_sc_exit_unknown;
550 struct lttng_syscall_filter *sc_filter;
551 int header_type; /* 0: unset, 1: compact, 2: large */
552 enum channel_type channel_type;
553 int syscall_all_entry;
554 int syscall_all_exit;
555 unsigned int metadata_dumped:1,
556 sys_enter_registered:1,
557 sys_exit_registered:1,
558 tstate:1; /* Transient enable state */
559 };
560
561 struct lttng_metadata_stream {
562 void *priv; /* Ring buffer private data */
563 struct lttng_metadata_cache *metadata_cache;
564 unsigned int metadata_in; /* Bytes read from the cache */
565 unsigned int metadata_out; /* Bytes consumed from stream */
566 int finalized; /* Has channel been finalized */
567 wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
568 struct list_head list; /* Stream list */
569 struct lttng_transport *transport;
570 uint64_t version; /* Current version of the metadata cache */
571 bool coherent; /* Stream in a coherent state */
572 };
573
574 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
575
576 struct lttng_dynamic_len_stack {
577 size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
578 size_t offset;
579 };
580
581 DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
582
583 /*
584 * struct lttng_id_tracker declared in header due to deferencing of *v
585 * in RCU_INITIALIZER(v).
586 */
587 #define LTTNG_ID_HASH_BITS 6
588 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
589
590 enum tracker_type {
591 TRACKER_PID,
592 TRACKER_VPID,
593 TRACKER_UID,
594 TRACKER_VUID,
595 TRACKER_GID,
596 TRACKER_VGID,
597
598 TRACKER_UNKNOWN,
599 };
600
601 struct lttng_id_tracker_rcu {
602 struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
603 };
604
605 struct lttng_id_tracker {
606 struct lttng_session *session;
607 enum tracker_type tracker_type;
608 struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
609 };
610
611 struct lttng_id_hash_node {
612 struct hlist_node hlist;
613 int id;
614 };
615
616 struct lttng_session {
617 int active; /* Is trace session active ? */
618 int been_active; /* Has trace session been active ? */
619 struct file *file; /* File associated to session */
620 struct list_head chan; /* Channel list head */
621 struct list_head events; /* Event list head */
622 struct list_head list; /* Session list */
623 unsigned int free_chan_id; /* Next chan ID to allocate */
624 uuid_le uuid; /* Trace session unique ID */
625 struct lttng_metadata_cache *metadata_cache;
626 struct lttng_id_tracker pid_tracker;
627 struct lttng_id_tracker vpid_tracker;
628 struct lttng_id_tracker uid_tracker;
629 struct lttng_id_tracker vuid_tracker;
630 struct lttng_id_tracker gid_tracker;
631 struct lttng_id_tracker vgid_tracker;
632 unsigned int metadata_dumped:1,
633 tstate:1; /* Transient enable state */
634 /* List of event enablers */
635 struct list_head enablers_head;
636 /* Hash table of events */
637 struct lttng_event_ht events_ht;
638 char name[LTTNG_KERNEL_ABI_SESSION_NAME_LEN];
639 char creation_time[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN];
640 };
641
642 struct lttng_counter {
643 struct file *file; /* File associated to counter. */
644 struct file *owner;
645 struct lttng_counter_transport *transport;
646 struct lib_counter *counter;
647 struct lttng_counter_ops *ops;
648 };
649
650 struct lttng_event_notifier_group {
651 struct file *file; /* File associated to event notifier group */
652 struct file *notif_file; /* File used to expose notifications to userspace. */
653 struct list_head node; /* event notifier group list */
654 struct list_head enablers_head; /* List of enablers */
655 struct list_head event_notifiers_head; /* List of event notifier */
656 struct lttng_event_notifier_ht event_notifiers_ht; /* Hash table of event notifiers */
657 struct lttng_channel_ops *ops;
658 struct lttng_transport *transport;
659 struct channel *chan; /* Ring buffer channel for event notifier group. */
660 struct lib_ring_buffer *buf; /* Ring buffer for event notifier group. */
661 wait_queue_head_t read_wait;
662 struct irq_work wakeup_pending; /* Pending wakeup irq work. */
663 struct lttng_kernel_event_notifier *sc_unknown; /* for unknown syscalls */
664 struct lttng_kernel_event_notifier *sc_compat_unknown;
665
666 struct lttng_syscall_filter *sc_filter;
667
668 struct hlist_head *event_notifier_syscall_dispatch;
669 struct hlist_head *event_notifier_compat_syscall_dispatch;
670 struct hlist_head *event_notifier_exit_syscall_dispatch;
671 struct hlist_head *event_notifier_exit_compat_syscall_dispatch;
672
673 struct hlist_head event_notifier_unknown_syscall_dispatch;
674 struct hlist_head event_notifier_compat_unknown_syscall_dispatch;
675 struct hlist_head event_notifier_exit_unknown_syscall_dispatch;
676 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch;
677
678 int syscall_all_entry;
679 int syscall_all_exit;
680
681 unsigned int sys_enter_registered:1, sys_exit_registered:1;
682
683 struct lttng_counter *error_counter;
684 size_t error_counter_len;
685 };
686
687 struct lttng_metadata_cache {
688 char *data; /* Metadata cache */
689 unsigned int cache_alloc; /* Metadata allocated size (bytes) */
690 unsigned int metadata_written; /* Number of bytes written in metadata cache */
691 atomic_t producing; /* Metadata being produced (incomplete) */
692 struct kref refcount; /* Metadata cache usage */
693 struct list_head metadata_stream; /* Metadata stream list */
694 uuid_le uuid; /* Trace session unique ID (copy) */
695 struct mutex lock; /* Produce/consume lock */
696 uint64_t version; /* Current version of the metadata */
697 };
698
699 void lttng_lock_sessions(void);
700 void lttng_unlock_sessions(void);
701
702 struct list_head *lttng_get_probe_list_head(void);
703
704 struct lttng_event_enabler *lttng_event_enabler_create(
705 enum lttng_enabler_format_type format_type,
706 struct lttng_kernel_abi_event *event_param,
707 struct lttng_channel *chan);
708
709 int lttng_event_enabler_enable(struct lttng_event_enabler *event_enabler);
710 int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler);
711 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
712 struct lttng_event_notifier_group *event_notifier_group,
713 enum lttng_enabler_format_type format_type,
714 struct lttng_kernel_abi_event_notifier *event_notifier_param);
715
716 int lttng_event_notifier_enabler_enable(
717 struct lttng_event_notifier_enabler *event_notifier_enabler);
718 int lttng_event_notifier_enabler_disable(
719 struct lttng_event_notifier_enabler *event_notifier_enabler);
720 int lttng_fix_pending_events(void);
721 int lttng_fix_pending_event_notifiers(void);
722 int lttng_session_active(void);
723 bool lttng_event_notifier_active(void);
724
725 struct lttng_session *lttng_session_create(void);
726 int lttng_session_enable(struct lttng_session *session);
727 int lttng_session_disable(struct lttng_session *session);
728 void lttng_session_destroy(struct lttng_session *session);
729 int lttng_session_metadata_regenerate(struct lttng_session *session);
730 int lttng_session_statedump(struct lttng_session *session);
731 void metadata_cache_destroy(struct kref *kref);
732
733 struct lttng_counter *lttng_kernel_counter_create(
734 const char *counter_transport_name, size_t number_dimensions,
735 const size_t *dimensions_sizes);
736 int lttng_kernel_counter_read(struct lttng_counter *counter,
737 const size_t *dimension_indexes, int32_t cpu,
738 int64_t *val, bool *overflow, bool *underflow);
739 int lttng_kernel_counter_aggregate(struct lttng_counter *counter,
740 const size_t *dimension_indexes, int64_t *val,
741 bool *overflow, bool *underflow);
742 int lttng_kernel_counter_clear(struct lttng_counter *counter,
743 const size_t *dimension_indexes);
744
745
746 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
747 int lttng_event_notifier_group_create_error_counter(
748 struct file *event_notifier_group_file,
749 const struct lttng_kernel_abi_counter_conf *error_counter_conf);
750 void lttng_event_notifier_group_destroy(
751 struct lttng_event_notifier_group *event_notifier_group);
752
753 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
754 const char *transport_name,
755 void *buf_addr,
756 size_t subbuf_size, size_t num_subbuf,
757 unsigned int switch_timer_interval,
758 unsigned int read_timer_interval,
759 enum channel_type channel_type);
760 struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
761 int overwrite, void *buf_addr,
762 size_t subbuf_size, size_t num_subbuf,
763 unsigned int switch_timer_interval,
764 unsigned int read_timer_interval);
765
766 void lttng_metadata_channel_destroy(struct lttng_channel *chan);
767 struct lttng_kernel_event_recorder *lttng_kernel_event_recorder_create(struct lttng_channel *chan,
768 struct lttng_kernel_abi_event *event_param,
769 const struct lttng_kernel_event_desc *event_desc,
770 enum lttng_kernel_abi_instrumentation itype);
771 struct lttng_kernel_event_recorder *_lttng_kernel_event_recorder_create(struct lttng_channel *chan,
772 struct lttng_kernel_abi_event *event_param,
773 const struct lttng_kernel_event_desc *event_desc,
774 enum lttng_kernel_abi_instrumentation itype);
775 struct lttng_kernel_event_recorder *lttng_event_compat_old_create(struct lttng_channel *chan,
776 struct lttng_kernel_abi_old_event *old_event_param,
777 const struct lttng_kernel_event_desc *internal_desc);
778
779 struct lttng_kernel_event_notifier *lttng_event_notifier_create(
780 const struct lttng_kernel_event_desc *event_notifier_desc,
781 uint64_t id,
782 uint64_t error_counter_idx,
783 struct lttng_event_notifier_group *event_notifier_group,
784 struct lttng_kernel_abi_event_notifier *event_notifier_param,
785 enum lttng_kernel_abi_instrumentation itype);
786 struct lttng_kernel_event_notifier *_lttng_event_notifier_create(
787 const struct lttng_kernel_event_desc *event_notifier_desc,
788 uint64_t id,
789 uint64_t error_counter_idx,
790 struct lttng_event_notifier_group *event_notifier_group,
791 struct lttng_kernel_abi_event_notifier *event_notifier_param,
792 enum lttng_kernel_abi_instrumentation itype);
793
794 int lttng_channel_enable(struct lttng_channel *channel);
795 int lttng_channel_disable(struct lttng_channel *channel);
796 int lttng_event_enable(struct lttng_kernel_event_common *event);
797 int lttng_event_disable(struct lttng_kernel_event_common *event);
798
799 void lttng_transport_register(struct lttng_transport *transport);
800 void lttng_transport_unregister(struct lttng_transport *transport);
801
802 void lttng_counter_transport_register(struct lttng_counter_transport *transport);
803 void lttng_counter_transport_unregister(struct lttng_counter_transport *transport);
804
805 void synchronize_trace(void);
806 int lttng_abi_init(void);
807 int lttng_abi_compat_old_init(void);
808 void lttng_abi_exit(void);
809 void lttng_abi_compat_old_exit(void);
810
811 int lttng_probe_register(struct lttng_kernel_probe_desc *desc);
812 void lttng_probe_unregister(struct lttng_kernel_probe_desc *desc);
813 const struct lttng_kernel_event_desc *lttng_event_desc_get(const char *name);
814 void lttng_event_desc_put(const struct lttng_kernel_event_desc *desc);
815 int lttng_probes_init(void);
816 void lttng_probes_exit(void);
817
818 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
819 struct channel *chan, bool *coherent);
820
821 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
822 int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
823 void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
824 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
825 int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
826 int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
827
828 int lttng_session_track_id(struct lttng_session *session,
829 enum tracker_type tracker_type, int id);
830 int lttng_session_untrack_id(struct lttng_session *session,
831 enum tracker_type tracker_type, int id);
832
833 int lttng_session_list_tracker_ids(struct lttng_session *session,
834 enum tracker_type tracker_type);
835
836 void lttng_clock_ref(void);
837 void lttng_clock_unref(void);
838
839 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc *desc,
840 struct lttng_enabler *enabler);
841
842 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
843 int lttng_syscalls_register_event(struct lttng_event_enabler *event_enabler);
844 int lttng_syscalls_unregister_channel(struct lttng_channel *chan);
845 int lttng_syscalls_destroy_event(struct lttng_channel *chan);
846 int lttng_syscall_filter_enable_event(
847 struct lttng_channel *chan,
848 struct lttng_kernel_event_recorder *event);
849 int lttng_syscall_filter_disable_event(
850 struct lttng_channel *chan,
851 struct lttng_kernel_event_recorder *event);
852
853 long lttng_channel_syscall_mask(struct lttng_channel *channel,
854 struct lttng_kernel_abi_syscall_mask __user *usyscall_mask);
855
856 int lttng_syscalls_register_event_notifier(
857 struct lttng_event_notifier_enabler *event_notifier_enabler);
858 int lttng_syscalls_create_matching_event_notifiers(
859 struct lttng_event_notifier_enabler *event_notifier_enabler);
860 int lttng_syscalls_unregister_event_notifier_group(struct lttng_event_notifier_group *group);
861 int lttng_syscall_filter_enable_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
862 int lttng_syscall_filter_disable_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
863 #else
864 static inline int lttng_syscalls_register_event(
865 struct lttng_event_enabler *event_enabler)
866 {
867 return -ENOSYS;
868 }
869
870 static inline int lttng_syscalls_unregister_channel(struct lttng_channel *chan)
871 {
872 return 0;
873 }
874
875 static inline int lttng_syscalls_destroy(struct lttng_channel *chan)
876 {
877 return 0;
878 }
879
880 static inline int lttng_syscall_filter_enable_event(struct lttng_channel *chan,
881 struct lttng_kernel_event_recorder *event);
882 {
883 return -ENOSYS;
884 }
885
886 static inline int lttng_syscall_filter_disable_event(struct lttng_channel *chan,
887 struct lttng_kernel_event_recorder *event);
888 {
889 return -ENOSYS;
890 }
891
892 static inline long lttng_channel_syscall_mask(struct lttng_channel *channel,
893 struct lttng_kernel_syscall_mask __user *usyscall_mask)
894 {
895 return -ENOSYS;
896 }
897
898 static inline int lttng_syscalls_register_event_notifier(
899 struct lttng_event_notifier_group *group)
900 {
901 return -ENOSYS;
902 }
903
904 static inline int lttng_syscalls_unregister_event_notifier_group(
905 struct lttng_event_notifier_group *group)
906 {
907 return 0;
908 }
909
910 static inline int lttng_syscall_filter_enable_event_notifier(
911 struct lttng_event_notifier_group *group,
912 const char *name)
913 {
914 return -ENOSYS;
915 }
916
917 static inline int lttng_syscall_filter_disable_event_notifier(
918 struct lttng_event_notifier_group *group,
919 const char *name)
920 {
921 return -ENOSYS;
922 }
923
924 #endif
925
926 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler *event_enabler,
927 struct lttng_kernel_abi_filter_bytecode __user *bytecode);
928 int lttng_event_notifier_enabler_attach_filter_bytecode(
929 struct lttng_event_notifier_enabler *event_notifier_enabler,
930 struct lttng_kernel_abi_filter_bytecode __user *bytecode);
931 int lttng_event_notifier_enabler_attach_capture_bytecode(
932 struct lttng_event_notifier_enabler *event_notifier_enabler,
933 struct lttng_kernel_abi_capture_bytecode __user *bytecode);
934
935 void lttng_enabler_link_bytecode(const struct lttng_kernel_event_desc *event_desc,
936 struct lttng_kernel_ctx *ctx,
937 struct list_head *instance_bytecode_runtime_head,
938 struct list_head *enabler_bytecode_runtime_head);
939 void lttng_free_event_filter_runtime(struct lttng_kernel_event_common *event);
940
941 int lttng_probes_init(void);
942
943 int lttng_logger_init(void);
944 void lttng_logger_exit(void);
945
946 extern int lttng_statedump_start(struct lttng_session *session);
947
948 #ifdef CONFIG_KPROBES
949 int lttng_kprobes_register_event(const char *name,
950 const char *symbol_name,
951 uint64_t offset,
952 uint64_t addr,
953 struct lttng_kernel_event_recorder *event);
954 void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder *event);
955 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder *event);
956 int lttng_kprobes_register_event_notifier(const char *symbol_name,
957 uint64_t offset,
958 uint64_t addr,
959 struct lttng_kernel_event_notifier *event_notifier);
960 void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
961 void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier);
962 #else
963 static inline
964 int lttng_kprobes_register_event(const char *name,
965 const char *symbol_name,
966 uint64_t offset,
967 uint64_t addr,
968 struct lttng_kernel_event_recorder *event)
969 {
970 return -ENOSYS;
971 }
972
973 static inline
974 void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder *event)
975 {
976 }
977
978 static inline
979 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder *event)
980 {
981 }
982
983 static inline
984 int lttng_kprobes_register_event_notifier(const char *symbol_name,
985 uint64_t offset,
986 uint64_t addr,
987 struct lttng_kernel_event_notifier *event_notifier)
988 {
989 return -ENOSYS;
990 }
991
992 static inline
993 void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier)
994 {
995 }
996
997 static inline
998 void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier)
999 {
1000 }
1001 #endif
1002
1003 int lttng_event_add_callsite(struct lttng_kernel_event_common *event,
1004 struct lttng_kernel_abi_event_callsite __user *callsite);
1005
1006 #ifdef CONFIG_UPROBES
1007 int lttng_uprobes_register_event(const char *name,
1008 int fd, struct lttng_kernel_event_recorder *event);
1009 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
1010 struct lttng_kernel_abi_event_callsite __user *callsite);
1011 void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder *event);
1012 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder *event);
1013 int lttng_uprobes_register_event_notifier(const char *name,
1014 int fd, struct lttng_kernel_event_notifier *event_notifier);
1015 void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
1016 void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier);
1017 #else
1018 static inline
1019 int lttng_uprobes_register_event(const char *name,
1020 int fd, struct lttng_kernel_event_recorder *event)
1021 {
1022 return -ENOSYS;
1023 }
1024
1025 static inline
1026 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
1027 struct lttng_kernel_abi_event_callsite __user *callsite)
1028 {
1029 return -ENOSYS;
1030 }
1031
1032 static inline
1033 void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder *event)
1034 {
1035 }
1036
1037 static inline
1038 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder *event)
1039 {
1040 }
1041
1042 static inline
1043 int lttng_uprobes_register_event_notifier(const char *name,
1044 int fd, struct lttng_kernel_event_notifier *event_notifier)
1045 {
1046 return -ENOSYS;
1047 }
1048
1049 static inline
1050 void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier)
1051 {
1052 }
1053
1054 static inline
1055 void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier)
1056 {
1057 }
1058 #endif
1059
1060 #ifdef CONFIG_KRETPROBES
1061 int lttng_kretprobes_register(const char *name,
1062 const char *symbol_name,
1063 uint64_t offset,
1064 uint64_t addr,
1065 struct lttng_kernel_event_recorder *event_entry,
1066 struct lttng_kernel_event_recorder *event_exit);
1067 void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder *event);
1068 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder *event);
1069 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common *event,
1070 int enable);
1071 #else
1072 static inline
1073 int lttng_kretprobes_register(const char *name,
1074 const char *symbol_name,
1075 uint64_t offset,
1076 uint64_t addr,
1077 struct lttng_kernel_event_recorder *event_entry,
1078 struct lttng_kernel_event_recorder *event_exit)
1079 {
1080 return -ENOSYS;
1081 }
1082
1083 static inline
1084 void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder *event)
1085 {
1086 }
1087
1088 static inline
1089 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder *event)
1090 {
1091 }
1092
1093 static inline
1094 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common *event,
1095 int enable)
1096 {
1097 return -ENOSYS;
1098 }
1099 #endif
1100
1101 int lttng_calibrate(struct lttng_kernel_abi_calibrate *calibrate);
1102
1103 extern const struct file_operations lttng_tracepoint_list_fops;
1104 extern const struct file_operations lttng_syscall_list_fops;
1105
1106 #define TRACEPOINT_HAS_DATA_ARG
1107
1108 #endif /* _LTTNG_EVENTS_H */
This page took 0.09018 seconds and 4 git commands to generate.