7226a27bed53162d63c4187b140db7a484562b64
[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 <linux/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)) < 0)
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 abstract_types {
39 atype_integer,
40 atype_string,
41 atype_enum_nestable,
42 atype_array_nestable,
43 atype_sequence_nestable,
44 atype_struct_nestable,
45 atype_variant_nestable,
46 NR_ABSTRACT_TYPES,
47 };
48
49 enum lttng_string_encodings {
50 lttng_encode_none = 0,
51 lttng_encode_UTF8 = 1,
52 lttng_encode_ASCII = 2,
53 NR_STRING_ENCODINGS,
54 };
55
56 enum channel_type {
57 PER_CPU_CHANNEL,
58 METADATA_CHANNEL,
59 };
60
61 struct lttng_enum_value {
62 unsigned long long value;
63 unsigned int signedness:1;
64 };
65
66 struct lttng_enum_entry {
67 struct lttng_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 #define __type_integer(_type, _size, _alignment, _signedness, \
75 _byte_order, _base, _encoding) \
76 { \
77 .atype = atype_integer, \
78 .u.integer = \
79 { \
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, \
84 .base = _base, \
85 .encoding = lttng_encode_##_encoding, \
86 }, \
87 } \
88
89 struct lttng_integer_type {
90 unsigned int size; /* in bits */
91 unsigned short alignment; /* in bits */
92 unsigned int signedness:1,
93 reverse_byte_order:1;
94 unsigned int base; /* 2, 8, 10, 16, for pretty print */
95 enum lttng_string_encodings encoding;
96 };
97
98 struct lttng_type {
99 enum abstract_types atype;
100 union {
101 struct lttng_integer_type integer;
102 struct {
103 enum lttng_string_encodings encoding;
104 } string;
105 struct {
106 const struct lttng_enum_desc *desc; /* Enumeration mapping */
107 const struct lttng_type *container_type;
108 } enum_nestable;
109 struct {
110 const struct lttng_type *elem_type;
111 unsigned int length; /* Num. elems. */
112 unsigned int alignment;
113 } array_nestable;
114 struct {
115 const char *length_name; /* Length field name. */
116 const struct lttng_type *elem_type;
117 unsigned int alignment; /* Alignment before elements. */
118 } sequence_nestable;
119 struct {
120 unsigned int nr_fields;
121 const struct lttng_event_field *fields; /* Array of fields. */
122 unsigned int alignment;
123 } struct_nestable;
124 struct {
125 const char *tag_name;
126 const struct lttng_event_field *choices; /* Array of fields. */
127 unsigned int nr_choices;
128 unsigned int alignment;
129 } variant_nestable;
130 } u;
131 };
132
133 struct lttng_enum_desc {
134 const char *name;
135 const struct lttng_enum_entry *entries;
136 unsigned int nr_entries;
137 };
138
139 /* Event field description */
140
141 struct lttng_event_field {
142 const char *name;
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 */
147 };
148
149 union lttng_ctx_value {
150 int64_t s64;
151 const char *str;
152 double d;
153 };
154
155 /*
156 * We need to keep this perf counter field separately from struct
157 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
158 */
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;
163 #else
164 struct notifier_block nb;
165 int hp_enable;
166 #endif
167 struct perf_event_attr *attr;
168 struct perf_event **e; /* per-cpu array */
169 };
170
171 struct lttng_probe_ctx {
172 struct lttng_event *event;
173 struct lttng_event_notifier *event_notifier; // Not sure if we will ever need it.
174 uint8_t interruptible;
175 };
176
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);
189 union {
190 struct lttng_perf_counter_field *perf_counter;
191 } u;
192 void (*destroy)(struct lttng_ctx_field *field);
193 /*
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.
197 */
198 void *priv;
199 };
200
201 struct lttng_ctx {
202 struct lttng_ctx_field *fields;
203 unsigned int nr_fields;
204 unsigned int allocated_fields;
205 size_t largest_align; /* in bytes */
206 };
207
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 *event_notifier_callback;
217 };
218
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 */
226 };
227
228 struct lttng_krp; /* Kretprobe handling */
229
230 enum lttng_event_type {
231 LTTNG_TYPE_EVENT = 0,
232 LTTNG_TYPE_ENABLER = 1,
233 };
234
235 struct lttng_filter_bytecode_node {
236 struct list_head node;
237 struct lttng_enabler *enabler;
238 /*
239 * struct lttng_kernel_filter_bytecode has var. sized array, must be
240 * last field.
241 */
242 struct lttng_kernel_filter_bytecode bc;
243 };
244
245 /*
246 * Filter return value masks.
247 */
248 enum lttng_filter_ret {
249 LTTNG_FILTER_DISCARD = 0,
250 LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
251 /* Other bits are kept for future use. */
252 };
253
254 struct lttng_bytecode_runtime {
255 /* Associated bytecode */
256 struct lttng_filter_bytecode_node *bc;
257 uint64_t (*filter)(void *filter_data, struct lttng_probe_ctx *lttng_probe_ctx,
258 const char *filter_stack_data);
259 int link_failed;
260 struct list_head node; /* list of bytecode runtime in event */
261 struct lttng_ctx *ctx;
262 };
263
264 /*
265 * Objects in a linked-list of enablers, owned by an event.
266 */
267 struct lttng_enabler_ref {
268 struct list_head node; /* enabler ref list */
269 struct lttng_enabler *ref; /* backward ref */
270 };
271
272 struct lttng_uprobe_handler {
273 union {
274 struct lttng_event *event;
275 struct lttng_event_notifier *event_notifier;
276 } u;
277 loff_t offset;
278 struct uprobe_consumer up_consumer;
279 struct list_head node;
280 };
281
282 struct lttng_kprobe {
283 struct kprobe kp;
284 char *symbol_name;
285 };
286
287 struct lttng_uprobe {
288 struct inode *inode;
289 struct list_head head;
290 };
291
292 enum lttng_syscall_entryexit {
293 LTTNG_SYSCALL_ENTRY,
294 LTTNG_SYSCALL_EXIT,
295 };
296
297 enum lttng_syscall_abi {
298 LTTNG_SYSCALL_ABI_NATIVE,
299 LTTNG_SYSCALL_ABI_COMPAT,
300 };
301
302 /*
303 * lttng_event structure is referred to by the tracing fast path. It must be
304 * kept small.
305 */
306 struct lttng_event {
307 enum lttng_event_type evtype; /* First field. */
308 unsigned int id;
309 struct lttng_channel *chan;
310 int enabled;
311 const struct lttng_event_desc *desc;
312 void *filter;
313 struct lttng_ctx *ctx;
314 enum lttng_kernel_instrumentation instrumentation;
315 union {
316 struct lttng_kprobe kprobe;
317 struct {
318 struct lttng_krp *lttng_krp;
319 char *symbol_name;
320 } kretprobe;
321 struct lttng_uprobe uprobe;
322 struct {
323 enum lttng_syscall_entryexit entryexit;
324 enum lttng_syscall_abi abi;
325 } syscall;
326 } u;
327 struct list_head list; /* Event list in session */
328 unsigned int metadata_dumped:1;
329
330 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
331 struct list_head enablers_ref_head;
332 struct hlist_node hlist; /* session ht of events */
333 int registered; /* has reg'd tracepoint probe */
334 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
335 struct list_head bytecode_runtime_head;
336 int has_enablers_without_bytecode;
337 };
338
339 // FIXME: Really similar to lttng_event above. Could those be merged ?
340 struct lttng_event_notifier {
341 enum lttng_event_type evtype; /* First field. */
342 uint64_t user_token;
343 int enabled;
344 int registered; /* has reg'd tracepoint probe */
345 const struct lttng_event_desc *desc;
346 void *filter;
347 struct list_head list; /* event_notifier list in event_notifier group */
348
349 enum lttng_kernel_instrumentation instrumentation;
350 union {
351 struct lttng_kprobe kprobe;
352 struct lttng_uprobe uprobe;
353 } u;
354
355 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
356 struct list_head enablers_ref_head;
357 struct hlist_node hlist; /* session ht of event_notifiers */
358 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
359 struct list_head bytecode_runtime_head;
360 int has_enablers_without_bytecode;
361
362 void (*send_notification)(struct lttng_event_notifier *event_notifier);
363 struct lttng_event_notifier_group *group; /* Weak ref */
364 };
365
366 enum lttng_enabler_format_type {
367 LTTNG_ENABLER_FORMAT_STAR_GLOB,
368 LTTNG_ENABLER_FORMAT_NAME,
369 };
370
371 /*
372 * Enabler field, within whatever object is enabling an event. Target of
373 * backward reference.
374 */
375 struct lttng_enabler {
376 enum lttng_event_type evtype; /* First field. */
377
378 enum lttng_enabler_format_type format_type;
379
380 /* head list of struct lttng_ust_filter_bytecode_node */
381 struct list_head filter_bytecode_head;
382
383 struct lttng_kernel_event event_param;
384 unsigned int enabled:1;
385
386 uint64_t user_token; /* User-provided token. */
387 };
388
389 struct lttng_event_enabler {
390 struct lttng_enabler base;
391 struct list_head node; /* per-session list of enablers */
392 struct lttng_channel *chan;
393 /*
394 * Unused, but kept around to make it explicit that the tracer can do
395 * it.
396 */
397 struct lttng_ctx *ctx;
398 };
399
400 struct lttng_event_notifier_enabler {
401 struct lttng_enabler base;
402 struct list_head node; /* List of event_notifier enablers */
403 struct lttng_event_notifier_group *group;
404 };
405
406 static inline
407 struct lttng_enabler *lttng_event_enabler_as_enabler(
408 struct lttng_event_enabler *event_enabler)
409 {
410 return &event_enabler->base;
411 }
412
413 static inline
414 struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
415 struct lttng_event_notifier_enabler *event_notifier_enabler)
416 {
417 return &event_notifier_enabler->base;
418 }
419
420 struct lttng_channel_ops {
421 struct channel *(*channel_create)(const char *name,
422 void *priv,
423 void *buf_addr,
424 size_t subbuf_size, size_t num_subbuf,
425 unsigned int switch_timer_interval,
426 unsigned int read_timer_interval);
427 void (*channel_destroy)(struct channel *chan);
428 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
429 int (*buffer_has_read_closed_stream)(struct channel *chan);
430 void (*buffer_read_close)(struct lib_ring_buffer *buf);
431 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
432 uint32_t event_id);
433 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
434 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
435 size_t len);
436 void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
437 const void *src, size_t len);
438 void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
439 int c, size_t len);
440 void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
441 size_t len);
442 void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
443 const char __user *src, size_t len);
444 /*
445 * packet_avail_size returns the available size in the current
446 * packet. Note that the size returned is only a hint, since it
447 * may change due to concurrent writes.
448 */
449 size_t (*packet_avail_size)(struct channel *chan);
450 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
451 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
452 int (*is_finalized)(struct channel *chan);
453 int (*is_disabled)(struct channel *chan);
454 int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
455 struct lib_ring_buffer *bufb,
456 uint64_t *timestamp_begin);
457 int (*timestamp_end) (const struct lib_ring_buffer_config *config,
458 struct lib_ring_buffer *bufb,
459 uint64_t *timestamp_end);
460 int (*events_discarded) (const struct lib_ring_buffer_config *config,
461 struct lib_ring_buffer *bufb,
462 uint64_t *events_discarded);
463 int (*content_size) (const struct lib_ring_buffer_config *config,
464 struct lib_ring_buffer *bufb,
465 uint64_t *content_size);
466 int (*packet_size) (const struct lib_ring_buffer_config *config,
467 struct lib_ring_buffer *bufb,
468 uint64_t *packet_size);
469 int (*stream_id) (const struct lib_ring_buffer_config *config,
470 struct lib_ring_buffer *bufb,
471 uint64_t *stream_id);
472 int (*current_timestamp) (const struct lib_ring_buffer_config *config,
473 struct lib_ring_buffer *bufb,
474 uint64_t *ts);
475 int (*sequence_number) (const struct lib_ring_buffer_config *config,
476 struct lib_ring_buffer *bufb,
477 uint64_t *seq);
478 int (*instance_id) (const struct lib_ring_buffer_config *config,
479 struct lib_ring_buffer *bufb,
480 uint64_t *id);
481 };
482
483 struct lttng_transport {
484 char *name;
485 struct module *owner;
486 struct list_head node;
487 struct lttng_channel_ops ops;
488 };
489
490 struct lttng_syscall_filter;
491
492 #define LTTNG_EVENT_HT_BITS 12
493 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
494
495 struct lttng_event_ht {
496 struct hlist_head table[LTTNG_EVENT_HT_SIZE];
497 };
498
499 #define LTTNG_EVENT_NOTIFIER_HT_BITS 12
500 #define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
501
502 struct lttng_event_notifier_ht {
503 struct hlist_head table[LTTNG_EVENT_NOTIFIER_HT_SIZE];
504 };
505
506 struct lttng_channel {
507 unsigned int id;
508 struct channel *chan; /* Channel buffers */
509 int enabled;
510 struct lttng_ctx *ctx;
511 /* Event ID management */
512 struct lttng_session *session;
513 struct file *file; /* File associated to channel */
514 unsigned int free_event_id; /* Next event ID to allocate */
515 struct list_head list; /* Channel list */
516 struct lttng_channel_ops *ops;
517 struct lttng_transport *transport;
518 struct lttng_event **sc_table; /* for syscall tracing */
519 struct lttng_event **compat_sc_table;
520 struct lttng_event **sc_exit_table; /* for syscall exit tracing */
521 struct lttng_event **compat_sc_exit_table;
522 struct lttng_event *sc_unknown; /* for unknown syscalls */
523 struct lttng_event *sc_compat_unknown;
524 struct lttng_event *sc_exit_unknown;
525 struct lttng_event *compat_sc_exit_unknown;
526 struct lttng_syscall_filter *sc_filter;
527 int header_type; /* 0: unset, 1: compact, 2: large */
528 enum channel_type channel_type;
529 int syscall_all;
530 unsigned int metadata_dumped:1,
531 sys_enter_registered:1,
532 sys_exit_registered:1,
533 tstate:1; /* Transient enable state */
534 };
535
536 struct lttng_metadata_stream {
537 void *priv; /* Ring buffer private data */
538 struct lttng_metadata_cache *metadata_cache;
539 unsigned int metadata_in; /* Bytes read from the cache */
540 unsigned int metadata_out; /* Bytes consumed from stream */
541 int finalized; /* Has channel been finalized */
542 wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
543 struct list_head list; /* Stream list */
544 struct lttng_transport *transport;
545 uint64_t version; /* Current version of the metadata cache */
546 bool coherent; /* Stream in a coherent state */
547 };
548
549 #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
550
551 struct lttng_dynamic_len_stack {
552 size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
553 size_t offset;
554 };
555
556 DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
557
558 /*
559 * struct lttng_id_tracker declared in header due to deferencing of *v
560 * in RCU_INITIALIZER(v).
561 */
562 #define LTTNG_ID_HASH_BITS 6
563 #define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
564
565 enum tracker_type {
566 TRACKER_PID,
567 TRACKER_VPID,
568 TRACKER_UID,
569 TRACKER_VUID,
570 TRACKER_GID,
571 TRACKER_VGID,
572
573 TRACKER_UNKNOWN,
574 };
575
576 struct lttng_id_tracker_rcu {
577 struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
578 };
579
580 struct lttng_id_tracker {
581 struct lttng_session *session;
582 enum tracker_type tracker_type;
583 struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
584 };
585
586 struct lttng_id_hash_node {
587 struct hlist_node hlist;
588 int id;
589 };
590
591 struct lttng_session {
592 int active; /* Is trace session active ? */
593 int been_active; /* Has trace session been active ? */
594 struct file *file; /* File associated to session */
595 struct list_head chan; /* Channel list head */
596 struct list_head events; /* Event list head */
597 struct list_head list; /* Session list */
598 unsigned int free_chan_id; /* Next chan ID to allocate */
599 uuid_le uuid; /* Trace session unique ID */
600 struct lttng_metadata_cache *metadata_cache;
601 struct lttng_id_tracker pid_tracker;
602 struct lttng_id_tracker vpid_tracker;
603 struct lttng_id_tracker uid_tracker;
604 struct lttng_id_tracker vuid_tracker;
605 struct lttng_id_tracker gid_tracker;
606 struct lttng_id_tracker vgid_tracker;
607 unsigned int metadata_dumped:1,
608 tstate:1; /* Transient enable state */
609 /* List of event enablers */
610 struct list_head enablers_head;
611 /* Hash table of events */
612 struct lttng_event_ht events_ht;
613 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
614 char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
615 };
616
617 struct lttng_event_notifier_group {
618 struct file *file; /* File associated to event notifier group */
619 struct file *notif_file; /* File used to expose notifications to userspace. */
620 struct list_head node; /* event notifier group list */
621 struct list_head enablers_head; /* List of enablers */
622 struct list_head event_notifiers_head; /* List of event notifier */
623 struct lttng_event_notifier_ht event_notifiers_ht; /* Hash table of event notifiers */
624 struct lttng_ctx *ctx; /* Contexts for filters. */
625 struct lttng_channel_ops *ops;
626 struct lttng_transport *transport;
627 struct channel *chan; /* Ring buffer channel for event notifier group. */
628 struct lib_ring_buffer *buf; /* Ring buffer for event notifier group. */
629 wait_queue_head_t read_wait;
630 struct irq_work wakeup_pending; /* Pending wakeup irq work. */
631 };
632
633 struct lttng_metadata_cache {
634 char *data; /* Metadata cache */
635 unsigned int cache_alloc; /* Metadata allocated size (bytes) */
636 unsigned int metadata_written; /* Number of bytes written in metadata cache */
637 atomic_t producing; /* Metadata being produced (incomplete) */
638 struct kref refcount; /* Metadata cache usage */
639 struct list_head metadata_stream; /* Metadata stream list */
640 uuid_le uuid; /* Trace session unique ID (copy) */
641 struct mutex lock; /* Produce/consume lock */
642 uint64_t version; /* Current version of the metadata */
643 };
644
645 void lttng_lock_sessions(void);
646 void lttng_unlock_sessions(void);
647
648 struct list_head *lttng_get_probe_list_head(void);
649
650 struct lttng_event_enabler *lttng_event_enabler_create(
651 enum lttng_enabler_format_type format_type,
652 struct lttng_kernel_event *event_param,
653 struct lttng_channel *chan);
654
655 int lttng_event_enabler_enable(struct lttng_event_enabler *event_enabler);
656 int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler);
657 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
658 struct lttng_event_notifier_group *event_notifier_group,
659 enum lttng_enabler_format_type format_type,
660 struct lttng_kernel_event_notifier *event_notifier_param);
661
662 int lttng_event_notifier_enabler_enable(
663 struct lttng_event_notifier_enabler *event_notifier_enabler);
664 int lttng_event_notifier_enabler_disable(
665 struct lttng_event_notifier_enabler *event_notifier_enabler);
666 int lttng_fix_pending_events(void);
667 int lttng_fix_pending_event_notifiers(void);
668 int lttng_session_active(void);
669 bool lttng_event_notifier_active(void);
670
671 struct lttng_session *lttng_session_create(void);
672 int lttng_session_enable(struct lttng_session *session);
673 int lttng_session_disable(struct lttng_session *session);
674 void lttng_session_destroy(struct lttng_session *session);
675 int lttng_session_metadata_regenerate(struct lttng_session *session);
676 int lttng_session_statedump(struct lttng_session *session);
677 void metadata_cache_destroy(struct kref *kref);
678
679 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
680 void lttng_event_notifier_group_destroy(
681 struct lttng_event_notifier_group *event_notifier_group);
682
683 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
684 const char *transport_name,
685 void *buf_addr,
686 size_t subbuf_size, size_t num_subbuf,
687 unsigned int switch_timer_interval,
688 unsigned int read_timer_interval,
689 enum channel_type channel_type);
690 struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
691 int overwrite, void *buf_addr,
692 size_t subbuf_size, size_t num_subbuf,
693 unsigned int switch_timer_interval,
694 unsigned int read_timer_interval);
695
696 void lttng_metadata_channel_destroy(struct lttng_channel *chan);
697 struct lttng_event *lttng_event_create(struct lttng_channel *chan,
698 struct lttng_kernel_event *event_param,
699 void *filter,
700 const struct lttng_event_desc *event_desc,
701 enum lttng_kernel_instrumentation itype);
702 struct lttng_event *_lttng_event_create(struct lttng_channel *chan,
703 struct lttng_kernel_event *event_param,
704 void *filter,
705 const struct lttng_event_desc *event_desc,
706 enum lttng_kernel_instrumentation itype);
707 struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
708 struct lttng_kernel_old_event *old_event_param,
709 void *filter,
710 const struct lttng_event_desc *internal_desc);
711
712 struct lttng_event_notifier *lttng_event_notifier_create(
713 const struct lttng_event_desc *event_notifier_desc,
714 uint64_t id,
715 struct lttng_event_notifier_group *event_notifier_group,
716 struct lttng_kernel_event_notifier *event_notifier_param,
717 void *filter,
718 enum lttng_kernel_instrumentation itype);
719 struct lttng_event_notifier *_lttng_event_notifier_create(
720 const struct lttng_event_desc *event_notifier_desc,
721 uint64_t id,
722 struct lttng_event_notifier_group *event_notifier_group,
723 struct lttng_kernel_event_notifier *event_notifier_param,
724 void *filter,
725 enum lttng_kernel_instrumentation itype);
726
727 int lttng_channel_enable(struct lttng_channel *channel);
728 int lttng_channel_disable(struct lttng_channel *channel);
729 int lttng_event_enable(struct lttng_event *event);
730 int lttng_event_disable(struct lttng_event *event);
731
732 int lttng_event_notifier_enable(struct lttng_event_notifier *event_notifier);
733 int lttng_event_notifier_disable(struct lttng_event_notifier *event_notifier);
734
735 void lttng_transport_register(struct lttng_transport *transport);
736 void lttng_transport_unregister(struct lttng_transport *transport);
737
738 void synchronize_trace(void);
739 int lttng_abi_init(void);
740 int lttng_abi_compat_old_init(void);
741 void lttng_abi_exit(void);
742 void lttng_abi_compat_old_exit(void);
743
744 int lttng_probe_register(struct lttng_probe_desc *desc);
745 void lttng_probe_unregister(struct lttng_probe_desc *desc);
746 const struct lttng_event_desc *lttng_event_desc_get(const char *name);
747 void lttng_event_desc_put(const struct lttng_event_desc *desc);
748 int lttng_probes_init(void);
749 void lttng_probes_exit(void);
750
751 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
752 struct channel *chan, bool *coherent);
753
754 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
755 int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
756 void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
757 bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
758 int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
759 int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
760
761 int lttng_session_track_id(struct lttng_session *session,
762 enum tracker_type tracker_type, int id);
763 int lttng_session_untrack_id(struct lttng_session *session,
764 enum tracker_type tracker_type, int id);
765
766 int lttng_session_list_tracker_ids(struct lttng_session *session,
767 enum tracker_type tracker_type);
768
769 void lttng_clock_ref(void);
770 void lttng_clock_unref(void);
771
772 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
773 int lttng_syscalls_register_event(struct lttng_channel *chan, void *filter);
774 int lttng_syscalls_unregister_event(struct lttng_channel *chan);
775 int lttng_syscalls_destroy_event(struct lttng_channel *chan);
776 int lttng_syscall_filter_enable_event(struct lttng_channel *chan,
777 struct lttng_event *event);
778 int lttng_syscall_filter_disable_event(struct lttng_channel *chan,
779 struct lttng_event *event);
780 long lttng_channel_syscall_mask(struct lttng_channel *channel,
781 struct lttng_kernel_syscall_mask __user *usyscall_mask);
782
783 #else
784 static inline int lttng_syscalls_register_event(
785 struct lttng_channel *chan, void *filter)
786 {
787 return -ENOSYS;
788 }
789
790 static inline int lttng_syscalls_unregister_event(struct lttng_channel *chan)
791 {
792 return 0;
793 }
794
795 static inline int lttng_syscalls_destroy(struct lttng_channel *chan)
796 {
797 return 0;
798 }
799
800 static inline int lttng_syscall_filter_enable_event(struct lttng_channel *chan,
801 struct lttng_event *event);
802 {
803 return -ENOSYS;
804 }
805
806 static inline int lttng_syscall_filter_disable_event(struct lttng_channel *chan,
807 struct lttng_event *event);
808 {
809 return -ENOSYS;
810 }
811
812 static inline long lttng_channel_syscall_mask(struct lttng_channel *channel,
813 struct lttng_kernel_syscall_mask __user *usyscall_mask)
814 {
815 return -ENOSYS;
816 }
817
818 #endif
819
820 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
821 int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler *event_enabler,
822 struct lttng_kernel_filter_bytecode __user *bytecode);
823 int lttng_event_notifier_enabler_attach_bytecode(
824 struct lttng_event_notifier_enabler *event_notifier_enabler,
825 struct lttng_kernel_filter_bytecode __user *bytecode);
826
827 void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
828 struct lttng_ctx *ctx,
829 struct list_head *bytecode_runtime_head,
830 struct lttng_enabler *enabler);
831
832 int lttng_probes_init(void);
833
834 extern struct lttng_ctx *lttng_static_ctx;
835
836 int lttng_context_init(void);
837 void lttng_context_exit(void);
838 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
839 ssize_t lttng_append_context_index(struct lttng_ctx **ctx_p);
840 struct lttng_ctx_field *lttng_get_context_field_from_index(struct lttng_ctx *ctx,
841 size_t index);
842 void lttng_context_update(struct lttng_ctx *ctx);
843 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
844 int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
845 void lttng_remove_context_field(struct lttng_ctx **ctx,
846 struct lttng_ctx_field *field);
847 void lttng_remove_context_field_index(struct lttng_ctx **ctx_p, size_t index);
848 void lttng_destroy_context(struct lttng_ctx *ctx);
849 int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
850 int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
851 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
852 int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
853 int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
854 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
855 int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
856 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
857 int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
858 int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
859 int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
860 int lttng_add_interruptible_to_ctx(struct lttng_ctx **ctx);
861 int lttng_add_need_reschedule_to_ctx(struct lttng_ctx **ctx);
862 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
863 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx);
864 #else
865 static inline
866 int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx)
867 {
868 return -ENOSYS;
869 }
870 #endif
871 #ifdef CONFIG_PREEMPT_RT_FULL
872 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx);
873 #else
874 static inline
875 int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx)
876 {
877 return -ENOSYS;
878 }
879 #endif
880
881 int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type);
882
883 #if defined(CONFIG_CGROUPS) && \
884 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
885 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
886 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
887 #else
888 static inline
889 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx)
890 {
891 return -ENOSYS;
892 }
893 #endif
894
895 #if defined(CONFIG_IPC_NS) && \
896 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
897 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
898 #else
899 static inline
900 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx)
901 {
902 return -ENOSYS;
903 }
904 #endif
905
906 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
907 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
908 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
909 #else
910 static inline
911 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx)
912 {
913 return -ENOSYS;
914 }
915 #endif
916
917 #if defined(CONFIG_NET_NS) && \
918 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
919 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
920 #else
921 static inline
922 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx)
923 {
924 return -ENOSYS;
925 }
926 #endif
927
928 #if defined(CONFIG_PID_NS) && \
929 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
930 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
931 #else
932 static inline
933 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx)
934 {
935 return -ENOSYS;
936 }
937 #endif
938
939 #if defined(CONFIG_USER_NS) && \
940 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
941 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
942 #else
943 static inline
944 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx)
945 {
946 return -ENOSYS;
947 }
948 #endif
949
950 #if defined(CONFIG_UTS_NS) && \
951 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
952 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
953 #else
954 static inline
955 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx)
956 {
957 return -ENOSYS;
958 }
959 #endif
960
961 #if defined(CONFIG_TIME_NS) && \
962 (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
963 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx);
964 #else
965 static inline
966 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx)
967 {
968 return -ENOSYS;
969 }
970 #endif
971
972 int lttng_add_uid_to_ctx(struct lttng_ctx **ctx);
973 int lttng_add_euid_to_ctx(struct lttng_ctx **ctx);
974 int lttng_add_suid_to_ctx(struct lttng_ctx **ctx);
975 int lttng_add_gid_to_ctx(struct lttng_ctx **ctx);
976 int lttng_add_egid_to_ctx(struct lttng_ctx **ctx);
977 int lttng_add_sgid_to_ctx(struct lttng_ctx **ctx);
978 int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
979 int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
980 int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
981 int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
982 int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
983 int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
984
985 #if defined(CONFIG_PERF_EVENTS)
986 int lttng_add_perf_counter_to_ctx(uint32_t type,
987 uint64_t config,
988 const char *name,
989 struct lttng_ctx **ctx);
990 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
991 struct lttng_cpuhp_node *node);
992 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
993 struct lttng_cpuhp_node *node);
994 #else
995 static inline
996 int lttng_add_perf_counter_to_ctx(uint32_t type,
997 uint64_t config,
998 const char *name,
999 struct lttng_ctx **ctx)
1000 {
1001 return -ENOSYS;
1002 }
1003 static inline
1004 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
1005 struct lttng_cpuhp_node *node)
1006 {
1007 return 0;
1008 }
1009 static inline
1010 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
1011 struct lttng_cpuhp_node *node)
1012 {
1013 return 0;
1014 }
1015 #endif
1016
1017 int lttng_logger_init(void);
1018 void lttng_logger_exit(void);
1019
1020 extern int lttng_statedump_start(struct lttng_session *session);
1021
1022 #ifdef CONFIG_KPROBES
1023 int lttng_kprobes_register_event(const char *name,
1024 const char *symbol_name,
1025 uint64_t offset,
1026 uint64_t addr,
1027 struct lttng_event *event);
1028 void lttng_kprobes_unregister_event(struct lttng_event *event);
1029 void lttng_kprobes_destroy_event_private(struct lttng_event *event);
1030 int lttng_kprobes_register_event_notifier(const char *symbol_name,
1031 uint64_t offset,
1032 uint64_t addr,
1033 struct lttng_event_notifier *event_notifier);
1034 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier);
1035 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier);
1036 #else
1037 static inline
1038 int lttng_kprobes_register_event(const char *name,
1039 const char *symbol_name,
1040 uint64_t offset,
1041 uint64_t addr,
1042 struct lttng_event *event)
1043 {
1044 return -ENOSYS;
1045 }
1046
1047 static inline
1048 void lttng_kprobes_unregister_event(struct lttng_event *event)
1049 {
1050 }
1051
1052 static inline
1053 void lttng_kprobes_destroy_event_private(struct lttng_event *event)
1054 {
1055 }
1056
1057 static inline
1058 int lttng_kprobes_register_event_notifier(const char *symbol_name,
1059 uint64_t offset,
1060 uint64_t addr,
1061 struct lttng_event_notifier *event_notifier)
1062 {
1063 return -ENOSYS;
1064 }
1065
1066 static inline
1067 void lttng_kprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier)
1068 {
1069 }
1070
1071 static inline
1072 void lttng_kprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier)
1073 {
1074 }
1075 #endif
1076
1077 int lttng_event_add_callsite(struct lttng_event *event,
1078 struct lttng_kernel_event_callsite *callsite);
1079
1080 int lttng_event_notifier_add_callsite(struct lttng_event_notifier *event_notifier,
1081 struct lttng_kernel_event_callsite *callsite);
1082
1083 #ifdef CONFIG_UPROBES
1084 int lttng_uprobes_register_event(const char *name,
1085 int fd, struct lttng_event *event);
1086 int lttng_uprobes_event_add_callsite(struct lttng_event *event,
1087 struct lttng_kernel_event_callsite *callsite);
1088 void lttng_uprobes_unregister_event(struct lttng_event *event);
1089 void lttng_uprobes_destroy_event_private(struct lttng_event *event);
1090 int lttng_uprobes_register_event_notifier(const char *name,
1091 int fd, struct lttng_event_notifier *event_notifier);
1092 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier *event_notifier,
1093 struct lttng_kernel_event_callsite *callsite);
1094 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier);
1095 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier);
1096 #else
1097 static inline
1098 int lttng_uprobes_register_event(const char *name,
1099 int fd, struct lttng_event *event)
1100 {
1101 return -ENOSYS;
1102 }
1103
1104 static inline
1105 int lttng_uprobes_event_add_callsite(struct lttng_event *event,
1106 struct lttng_kernel_event_callsite *callsite)
1107 {
1108 return -ENOSYS;
1109 }
1110
1111 static inline
1112 void lttng_uprobes_unregister_event(struct lttng_event *event)
1113 {
1114 }
1115
1116 static inline
1117 void lttng_uprobes_destroy_event_private(struct lttng_event *event)
1118 {
1119 }
1120
1121 static inline
1122 int lttng_uprobes_register_event_notifier(const char *name,
1123 int fd, struct lttng_event_notifier *event_notifier)
1124 {
1125 return -ENOSYS;
1126 }
1127
1128 static inline
1129 int lttng_uprobes_event_notifier_add_callsite(struct lttng_event_notifier *event_notifier,
1130 struct lttng_kernel_event_callsite *callsite)
1131 {
1132 return -ENOSYS;
1133 }
1134
1135 static inline
1136 void lttng_uprobes_unregister_event_notifier(struct lttng_event_notifier *event_notifier)
1137 {
1138 }
1139
1140 static inline
1141 void lttng_uprobes_destroy_event_notifier_private(struct lttng_event_notifier *event_notifier)
1142 {
1143 }
1144 #endif
1145
1146 #ifdef CONFIG_KRETPROBES
1147 int lttng_kretprobes_register(const char *name,
1148 const char *symbol_name,
1149 uint64_t offset,
1150 uint64_t addr,
1151 struct lttng_event *event_entry,
1152 struct lttng_event *event_exit);
1153 void lttng_kretprobes_unregister(struct lttng_event *event);
1154 void lttng_kretprobes_destroy_private(struct lttng_event *event);
1155 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1156 int enable);
1157 #else
1158 static inline
1159 int lttng_kretprobes_register(const char *name,
1160 const char *symbol_name,
1161 uint64_t offset,
1162 uint64_t addr,
1163 struct lttng_event *event_entry,
1164 struct lttng_event *event_exit)
1165 {
1166 return -ENOSYS;
1167 }
1168
1169 static inline
1170 void lttng_kretprobes_unregister(struct lttng_event *event)
1171 {
1172 }
1173
1174 static inline
1175 void lttng_kretprobes_destroy_private(struct lttng_event *event)
1176 {
1177 }
1178
1179 static inline
1180 int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1181 int enable)
1182 {
1183 return -ENOSYS;
1184 }
1185 #endif
1186
1187 int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
1188
1189 extern const struct file_operations lttng_tracepoint_list_fops;
1190 extern const struct file_operations lttng_syscall_list_fops;
1191
1192 #define TRACEPOINT_HAS_DATA_ARG
1193
1194 static inline bool lttng_is_bytewise_integer(const struct lttng_type *type)
1195 {
1196 if (type->atype != atype_integer)
1197 return false;
1198 switch (type->u.integer.size) {
1199 case 8: /* Fall-through. */
1200 case 16: /* Fall-through. */
1201 case 32: /* Fall-through. */
1202 case 64:
1203 break;
1204 default:
1205 return false;
1206 }
1207 return true;
1208 }
1209
1210 #endif /* _LTTNG_EVENTS_H */
This page took 0.055809 seconds and 3 git commands to generate.