Refactoring: combine event hash tables common code
[lttng-modules.git] / include / lttng / events-internal.h
1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
2 *
3 * lttng/events-internal.h
4 *
5 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 */
7
8 #ifndef _LTTNG_EVENTS_INTERNAL_H
9 #define _LTTNG_EVENTS_INTERNAL_H
10
11 #include <wrapper/compiler_attributes.h>
12
13 #include <lttng/events.h>
14
15 struct lttng_syscall_filter;
16 struct lttng_metadata_cache;
17 struct perf_event;
18 struct perf_event_attr;
19 struct lttng_kernel_ring_buffer_config;
20
21 enum lttng_enabler_format_type {
22 LTTNG_ENABLER_FORMAT_STAR_GLOB,
23 LTTNG_ENABLER_FORMAT_NAME,
24 };
25
26 enum channel_type {
27 PER_CPU_CHANNEL,
28 METADATA_CHANNEL,
29 };
30
31 /*
32 * Objects in a linked-list of enablers, owned by an event.
33 */
34 struct lttng_enabler_ref {
35 struct list_head node; /* enabler ref list */
36 struct lttng_event_enabler_common *ref; /* backward ref */
37 };
38
39 struct lttng_krp; /* Kretprobe handling */
40
41 struct lttng_uprobe_handler {
42 struct lttng_kernel_event_common *event;
43 loff_t offset;
44 struct uprobe_consumer up_consumer;
45 struct list_head node;
46 };
47
48 struct lttng_kprobe {
49 struct kprobe kp;
50 char *symbol_name;
51 };
52
53 struct lttng_uprobe {
54 struct inode *inode;
55 struct list_head head;
56 };
57
58 enum lttng_syscall_entryexit {
59 LTTNG_SYSCALL_ENTRY,
60 LTTNG_SYSCALL_EXIT,
61 };
62
63 enum lttng_syscall_abi {
64 LTTNG_SYSCALL_ABI_NATIVE,
65 LTTNG_SYSCALL_ABI_COMPAT,
66 };
67
68 struct lttng_kernel_event_common_private {
69 struct lttng_kernel_event_common *pub; /* Public event interface */
70
71 const struct lttng_kernel_event_desc *desc;
72 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
73 struct list_head enablers_ref_head;
74 int registered; /* has reg'd tracepoint probe */
75 uint64_t user_token;
76
77 int has_enablers_without_filter_bytecode;
78 /* list of struct lttng_kernel_bytecode_runtime, sorted by seqnum */
79 struct list_head filter_bytecode_runtime_head;
80 enum lttng_kernel_abi_instrumentation instrumentation;
81 /* Selected by instrumentation */
82 union {
83 struct lttng_kprobe kprobe;
84 struct lttng_uprobe uprobe;
85 struct {
86 struct lttng_krp *lttng_krp;
87 char *symbol_name;
88 } kretprobe;
89 struct {
90 enum lttng_syscall_entryexit entryexit;
91 enum lttng_syscall_abi abi;
92 struct hlist_node node; /* chain registered syscall event_notifier */
93 unsigned int syscall_id;
94 } syscall;
95 } u;
96 };
97
98 struct lttng_kernel_event_recorder_private {
99 struct lttng_kernel_event_common_private parent;
100
101 struct lttng_kernel_event_recorder *pub; /* Public event interface */
102 struct list_head node; /* Event recorder list */
103 struct hlist_node hlist; /* Hash table of event recorders */
104 struct lttng_kernel_ctx *ctx;
105 unsigned int id;
106 unsigned int metadata_dumped:1;
107 };
108
109 struct lttng_kernel_event_notifier_private {
110 struct lttng_kernel_event_common_private parent;
111
112 struct lttng_kernel_event_notifier *pub; /* Public event notifier interface */
113 struct lttng_event_notifier_group *group; /* weak ref */
114 size_t num_captures; /* Needed to allocate the msgpack array. */
115 uint64_t error_counter_index;
116 struct list_head node; /* Event notifier list */
117 struct hlist_node hlist; /* Hash table of event notifiers */
118 struct list_head capture_bytecode_runtime_head;
119
120 };
121
122 struct lttng_kernel_syscall_table {
123 unsigned int sys_enter_registered:1,
124 sys_exit_registered:1;
125
126 struct hlist_head *syscall_dispatch; /* for syscall tracing */
127 struct hlist_head *compat_syscall_dispatch;
128 struct hlist_head *syscall_exit_dispatch; /* for syscall exit tracing */
129 struct hlist_head *compat_syscall_exit_dispatch;
130
131 /*
132 * Combining all unknown syscall events works as long as they
133 * are only matched by "all" syscalls enablers, but will require
134 * a design change when we allow matching by syscall number, for
135 * instance by allocating sc_tables accomodating NR_syscalls
136 * entries.
137 */
138 struct hlist_head unknown_syscall_dispatch; /* for unknown syscalls */
139 struct hlist_head compat_unknown_syscall_dispatch;
140 struct hlist_head unknown_syscall_exit_dispatch;
141 struct hlist_head compat_unknown_syscall_exit_dispatch;
142
143 struct lttng_syscall_filter *sc_filter;
144 int syscall_all_entry;
145 int syscall_all_exit;
146 };
147
148 struct lttng_kernel_channel_common_private {
149 struct lttng_kernel_channel_common *pub;
150
151 struct file *file; /* File associated to channel */
152 unsigned int tstate:1; /* Transient enable state */
153
154 struct lttng_kernel_syscall_table syscall_table;
155 };
156
157 struct lttng_kernel_channel_buffer_private {
158 struct lttng_kernel_channel_common_private parent;
159
160 struct lttng_kernel_channel_buffer *pub;
161
162 unsigned int id; /* Channel ID */
163 unsigned int free_event_id; /* Next event ID to allocate */
164 int header_type; /* 0: unset, 1: compact, 2: large */
165
166 enum channel_type channel_type;
167 struct lttng_kernel_ctx *ctx;
168 struct lttng_kernel_ring_buffer_channel *rb_chan; /* Ring buffer channel */
169 unsigned int metadata_dumped:1;
170 struct list_head node; /* Channel list in session */
171 struct lttng_transport *transport;
172 };
173
174 enum lttng_kernel_bytecode_interpreter_ret {
175 LTTNG_KERNEL_BYTECODE_INTERPRETER_ERROR = -1,
176 LTTNG_KERNEL_BYTECODE_INTERPRETER_OK = 0,
177 };
178
179 enum lttng_kernel_bytecode_filter_result {
180 LTTNG_KERNEL_BYTECODE_FILTER_ACCEPT = 0,
181 LTTNG_KERNEL_BYTECODE_FILTER_REJECT = 1,
182 };
183
184 struct lttng_kernel_bytecode_filter_ctx {
185 enum lttng_kernel_bytecode_filter_result result;
186 };
187
188 struct lttng_interpreter_output;
189
190 enum lttng_kernel_bytecode_type {
191 LTTNG_KERNEL_BYTECODE_TYPE_FILTER,
192 LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE,
193 };
194
195 enum lttng_kernel_event_enabler_type {
196 LTTNG_EVENT_ENABLER_TYPE_RECORDER,
197 LTTNG_EVENT_ENABLER_TYPE_NOTIFIER,
198 };
199
200 struct lttng_kernel_bytecode_node {
201 enum lttng_kernel_bytecode_type type;
202 struct list_head node;
203 struct lttng_event_enabler_common *enabler;
204 struct {
205 uint32_t len;
206 uint32_t reloc_offset;
207 uint64_t seqnum;
208 char data[];
209 } bc;
210 };
211
212 struct lttng_kernel_bytecode_runtime {
213 /* Associated bytecode */
214 enum lttng_kernel_bytecode_type type;
215 struct lttng_kernel_bytecode_node *bc;
216 int (*interpreter_func)(struct lttng_kernel_bytecode_runtime *kernel_bytecode,
217 const char *interpreter_stack_data,
218 struct lttng_kernel_probe_ctx *lttng_probe_ctx,
219 void *caller_ctx);
220 int link_failed;
221 struct list_head node; /* list of bytecode runtime in event */
222 struct lttng_kernel_ctx *ctx;
223 };
224
225 /*
226 * Enabler field, within whatever object is enabling an event. Target of
227 * backward reference.
228 */
229 struct lttng_event_enabler_common {
230 enum lttng_kernel_event_enabler_type enabler_type;
231 enum lttng_enabler_format_type format_type;
232
233 /* head list of struct lttng_kernel_bytecode_node */
234 struct list_head filter_bytecode_head;
235
236 struct lttng_kernel_abi_event event_param;
237 unsigned int enabled:1;
238
239 uint64_t user_token; /* User-provided token. */
240 };
241
242 struct lttng_event_recorder_enabler {
243 struct lttng_event_enabler_common parent;
244 struct list_head node; /* per-session list of enablers */
245 bool published; /* published in per-session list. */
246 struct lttng_kernel_channel_buffer *chan;
247 };
248
249 struct lttng_event_notifier_enabler {
250 struct lttng_event_enabler_common parent;
251 uint64_t error_counter_index;
252 struct list_head node; /* List of event_notifier enablers */
253 struct lttng_event_notifier_group *group;
254
255 /* head list of struct lttng_kernel_bytecode_node */
256 struct list_head capture_bytecode_head;
257 uint64_t num_captures;
258 };
259
260 struct lttng_ctx_value {
261 union {
262 int64_t s64;
263 const char *str;
264 double d;
265 } u;
266 };
267
268 /*
269 * We need to keep this perf counter field separately from struct
270 * lttng_kernel_ctx_field because cpu hotplug needs fixed-location addresses.
271 */
272 struct lttng_perf_counter_field {
273 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
274 struct lttng_cpuhp_node cpuhp_prepare;
275 struct lttng_cpuhp_node cpuhp_online;
276 #else
277 struct notifier_block nb;
278 int hp_enable;
279 #endif
280 struct perf_event_attr *attr;
281 struct perf_event **e; /* per-cpu array */
282 char *name;
283 struct lttng_kernel_event_field *event_field;
284 };
285
286 struct lttng_kernel_ctx_field {
287 const struct lttng_kernel_event_field *event_field;
288 size_t (*get_size)(void *priv, struct lttng_kernel_probe_ctx *probe_ctx,
289 size_t offset);
290 void (*record)(void *priv, struct lttng_kernel_probe_ctx *probe_ctx,
291 struct lttng_kernel_ring_buffer_ctx *ctx,
292 struct lttng_kernel_channel_buffer *chan);
293 void (*get_value)(void *priv, struct lttng_kernel_probe_ctx *probe_ctx,
294 struct lttng_ctx_value *value);
295 void (*destroy)(void *priv);
296 void *priv;
297 };
298
299 struct lttng_kernel_ctx {
300 struct lttng_kernel_ctx_field *fields;
301 unsigned int nr_fields;
302 unsigned int allocated_fields;
303 size_t largest_align; /* in bytes */
304 };
305
306 struct lttng_metadata_cache {
307 char *data; /* Metadata cache */
308 unsigned int cache_alloc; /* Metadata allocated size (bytes) */
309 unsigned int metadata_written; /* Number of bytes written in metadata cache */
310 atomic_t producing; /* Metadata being produced (incomplete) */
311 struct kref refcount; /* Metadata cache usage */
312 struct list_head metadata_stream; /* Metadata stream list */
313 uuid_le uuid; /* Trace session unique ID (copy) */
314 struct mutex lock; /* Produce/consume lock */
315 uint64_t version; /* Current version of the metadata */
316 };
317
318 struct lttng_metadata_stream {
319 void *priv; /* Ring buffer private data */
320 struct lttng_metadata_cache *metadata_cache;
321 unsigned int metadata_in; /* Bytes read from the cache */
322 unsigned int metadata_out; /* Bytes consumed from stream */
323 int finalized; /* Has channel been finalized */
324 wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
325 struct list_head list; /* Stream list */
326 struct lttng_transport *transport;
327 uint64_t version; /* Current version of the metadata cache */
328 bool coherent; /* Stream in a coherent state */
329 };
330
331 struct lttng_kernel_channel_buffer_ops_private {
332 struct lttng_kernel_channel_buffer_ops *pub; /* Public channel buffer ops interface */
333
334 struct lttng_kernel_ring_buffer_channel *(*channel_create)(const char *name,
335 void *priv,
336 void *buf_addr,
337 size_t subbuf_size, size_t num_subbuf,
338 unsigned int switch_timer_interval,
339 unsigned int read_timer_interval);
340 void (*channel_destroy)(struct lttng_kernel_ring_buffer_channel *chan);
341 struct lttng_kernel_ring_buffer *(*buffer_read_open)(struct lttng_kernel_ring_buffer_channel *chan);
342 int (*buffer_has_read_closed_stream)(struct lttng_kernel_ring_buffer_channel *chan);
343 void (*buffer_read_close)(struct lttng_kernel_ring_buffer *buf);
344 /*
345 * packet_avail_size returns the available size in the current
346 * packet. Note that the size returned is only a hint, since it
347 * may change due to concurrent writes.
348 */
349 size_t (*packet_avail_size)(struct lttng_kernel_ring_buffer_channel *chan);
350 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct lttng_kernel_ring_buffer_channel *chan, int cpu);
351 wait_queue_head_t *(*get_hp_wait_queue)(struct lttng_kernel_ring_buffer_channel *chan);
352 int (*is_finalized)(struct lttng_kernel_ring_buffer_channel *chan);
353 int (*is_disabled)(struct lttng_kernel_ring_buffer_channel *chan);
354 int (*timestamp_begin) (const struct lttng_kernel_ring_buffer_config *config,
355 struct lttng_kernel_ring_buffer *bufb,
356 uint64_t *timestamp_begin);
357 int (*timestamp_end) (const struct lttng_kernel_ring_buffer_config *config,
358 struct lttng_kernel_ring_buffer *bufb,
359 uint64_t *timestamp_end);
360 int (*events_discarded) (const struct lttng_kernel_ring_buffer_config *config,
361 struct lttng_kernel_ring_buffer *bufb,
362 uint64_t *events_discarded);
363 int (*content_size) (const struct lttng_kernel_ring_buffer_config *config,
364 struct lttng_kernel_ring_buffer *bufb,
365 uint64_t *content_size);
366 int (*packet_size) (const struct lttng_kernel_ring_buffer_config *config,
367 struct lttng_kernel_ring_buffer *bufb,
368 uint64_t *packet_size);
369 int (*stream_id) (const struct lttng_kernel_ring_buffer_config *config,
370 struct lttng_kernel_ring_buffer *bufb,
371 uint64_t *stream_id);
372 int (*current_timestamp) (const struct lttng_kernel_ring_buffer_config *config,
373 struct lttng_kernel_ring_buffer *bufb,
374 uint64_t *ts);
375 int (*sequence_number) (const struct lttng_kernel_ring_buffer_config *config,
376 struct lttng_kernel_ring_buffer *bufb,
377 uint64_t *seq);
378 int (*instance_id) (const struct lttng_kernel_ring_buffer_config *config,
379 struct lttng_kernel_ring_buffer *bufb,
380 uint64_t *id);
381 };
382
383 struct lttng_counter_ops {
384 struct lib_counter *(*counter_create)(size_t nr_dimensions,
385 const size_t *max_nr_elem, /* for each dimension */
386 int64_t global_sum_step);
387 void (*counter_destroy)(struct lib_counter *counter);
388 int (*counter_add)(struct lib_counter *counter, const size_t *dimension_indexes,
389 int64_t v);
390 /*
391 * counter_read reads a specific cpu's counter if @cpu >= 0, or
392 * the global aggregation counter if @cpu == -1.
393 */
394 int (*counter_read)(struct lib_counter *counter, const size_t *dimension_indexes, int cpu,
395 int64_t *value, bool *overflow, bool *underflow);
396 /*
397 * counter_aggregate returns the total sum of all per-cpu counters and
398 * the global aggregation counter.
399 */
400 int (*counter_aggregate)(struct lib_counter *counter, const size_t *dimension_indexes,
401 int64_t *value, bool *overflow, bool *underflow);
402 int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
403 };
404
405 struct lttng_counter {
406 struct file *file; /* File associated to counter. */
407 struct file *owner;
408 struct lttng_counter_transport *transport;
409 struct lib_counter *counter;
410 struct lttng_counter_ops *ops;
411 };
412
413 #define LTTNG_EVENT_HT_BITS 12
414 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
415
416 struct lttng_event_ht {
417 struct hlist_head table[LTTNG_EVENT_HT_SIZE];
418 };
419
420 struct lttng_event_notifier_group {
421 struct file *file; /* File associated to event notifier group */
422 struct file *notif_file; /* File used to expose notifications to userspace. */
423 struct list_head node; /* event notifier group list */
424 struct list_head enablers_head; /* List of enablers */
425 struct list_head event_notifiers_head; /* List of event notifier */
426 struct lttng_event_ht events_ht; /* Hash table of event notifiers */
427 struct lttng_kernel_channel_buffer_ops *ops;
428 struct lttng_transport *transport;
429 struct lttng_kernel_ring_buffer_channel *chan; /* Ring buffer channel for event notifier group. */
430 struct lttng_kernel_ring_buffer *buf; /* Ring buffer for event notifier group. */
431 wait_queue_head_t read_wait;
432 struct irq_work wakeup_pending; /* Pending wakeup irq work. */
433
434 struct lttng_kernel_syscall_table syscall_table;
435
436 struct lttng_counter *error_counter;
437 size_t error_counter_len;
438 };
439
440 struct lttng_transport {
441 char *name;
442 struct module *owner;
443 struct list_head node;
444 struct lttng_kernel_channel_buffer_ops ops;
445 };
446
447 struct lttng_counter_transport {
448 char *name;
449 struct module *owner;
450 struct list_head node;
451 struct lttng_counter_ops ops;
452 };
453
454 struct lttng_kernel_session_private {
455 struct lttng_kernel_session *pub; /* Public session interface */
456
457 int been_active; /* Has trace session been active ? */
458 struct file *file; /* File associated to session */
459 struct list_head chan; /* Channel list head */
460 struct list_head events; /* Event list head */
461 struct list_head list; /* Session list */
462 unsigned int free_chan_id; /* Next chan ID to allocate */
463 uuid_le uuid; /* Trace session unique ID */
464 struct lttng_metadata_cache *metadata_cache;
465 unsigned int metadata_dumped:1,
466 tstate:1; /* Transient enable state */
467 /* List of event enablers */
468 struct list_head enablers_head;
469 /* Hash table of events */
470 struct lttng_event_ht events_ht;
471 char name[LTTNG_KERNEL_ABI_SESSION_NAME_LEN];
472 char creation_time[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN];
473 };
474
475 struct lttng_id_hash_node {
476 struct hlist_node hlist;
477 int id;
478 };
479
480 enum tracker_type {
481 TRACKER_PID,
482 TRACKER_VPID,
483 TRACKER_UID,
484 TRACKER_VUID,
485 TRACKER_GID,
486 TRACKER_VGID,
487
488 TRACKER_UNKNOWN,
489 };
490
491 struct lttng_kernel_id_tracker_private {
492 struct lttng_kernel_id_tracker *pub; /* Public interface */
493
494 struct lttng_kernel_session *session;
495 enum tracker_type tracker_type;
496 };
497
498 extern struct lttng_kernel_ctx *lttng_static_ctx;
499
500 static inline
501 const struct lttng_kernel_type_integer *lttng_kernel_get_type_integer(const struct lttng_kernel_type_common *type)
502 {
503 if (type->type != lttng_kernel_type_integer)
504 return NULL;
505 return container_of(type, const struct lttng_kernel_type_integer, parent);
506 }
507
508 static inline
509 const struct lttng_kernel_type_string *lttng_kernel_get_type_string(const struct lttng_kernel_type_common *type)
510 {
511 if (type->type != lttng_kernel_type_string)
512 return NULL;
513 return container_of(type, const struct lttng_kernel_type_string, parent);
514 }
515
516 static inline
517 const struct lttng_kernel_type_enum *lttng_kernel_get_type_enum(const struct lttng_kernel_type_common *type)
518 {
519 if (type->type != lttng_kernel_type_enum)
520 return NULL;
521 return container_of(type, const struct lttng_kernel_type_enum, parent);
522 }
523
524 static inline
525 const struct lttng_kernel_type_array *lttng_kernel_get_type_array(const struct lttng_kernel_type_common *type)
526 {
527 if (type->type != lttng_kernel_type_array)
528 return NULL;
529 return container_of(type, const struct lttng_kernel_type_array, parent);
530 }
531
532 static inline
533 const struct lttng_kernel_type_sequence *lttng_kernel_get_type_sequence(const struct lttng_kernel_type_common *type)
534 {
535 if (type->type != lttng_kernel_type_sequence)
536 return NULL;
537 return container_of(type, const struct lttng_kernel_type_sequence, parent);
538 }
539
540 static inline
541 const struct lttng_kernel_type_struct *lttng_kernel_get_type_struct(const struct lttng_kernel_type_common *type)
542 {
543 if (type->type != lttng_kernel_type_struct)
544 return NULL;
545 return container_of(type, const struct lttng_kernel_type_struct, parent);
546 }
547
548 static inline
549 const struct lttng_kernel_type_variant *lttng_kernel_get_type_variant(const struct lttng_kernel_type_common *type)
550 {
551 if (type->type != lttng_kernel_type_variant)
552 return NULL;
553 return container_of(type, const struct lttng_kernel_type_variant, parent);
554 }
555
556 static inline bool lttng_kernel_type_is_bytewise_integer(const struct lttng_kernel_type_common *type)
557 {
558 const struct lttng_kernel_type_integer *type_integer = lttng_kernel_get_type_integer(type);
559
560 if (!type_integer)
561 return false;
562 switch (type_integer->size) {
563 case 8:
564 lttng_fallthrough;
565 case 16:
566 lttng_fallthrough;
567 case 32:
568 lttng_fallthrough;
569 case 64:
570 break;
571 default:
572 return false;
573 }
574 return true;
575 }
576
577 int lttng_kernel_interpret_event_filter(const struct lttng_kernel_event_common *event,
578 const char *interpreter_stack_data,
579 struct lttng_kernel_probe_ctx *probe_ctx,
580 void *event_filter_ctx);
581
582 static inline
583 struct lttng_event_enabler_common *lttng_event_recorder_enabler_as_enabler(
584 struct lttng_event_recorder_enabler *event_recorder_enabler)
585 {
586 return &event_recorder_enabler->parent;
587 }
588
589 static inline
590 struct lttng_event_enabler_common *lttng_event_notifier_enabler_as_enabler(
591 struct lttng_event_notifier_enabler *event_notifier_enabler)
592 {
593 return &event_notifier_enabler->parent;
594 }
595
596 int lttng_context_init(void);
597 void lttng_context_exit(void);
598 int lttng_kernel_context_append(struct lttng_kernel_ctx **ctx_p,
599 const struct lttng_kernel_ctx_field *f);
600 void lttng_kernel_context_remove_last(struct lttng_kernel_ctx **ctx_p);
601 struct lttng_kernel_ctx_field *lttng_kernel_get_context_field_from_index(struct lttng_kernel_ctx *ctx,
602 size_t index);
603 int lttng_kernel_find_context(struct lttng_kernel_ctx *ctx, const char *name);
604 int lttng_kernel_get_context_index(struct lttng_kernel_ctx *ctx, const char *name);
605 void lttng_kernel_destroy_context(struct lttng_kernel_ctx *ctx);
606 int lttng_add_pid_to_ctx(struct lttng_kernel_ctx **ctx);
607 int lttng_add_cpu_id_to_ctx(struct lttng_kernel_ctx **ctx);
608 int lttng_add_procname_to_ctx(struct lttng_kernel_ctx **ctx);
609 int lttng_add_prio_to_ctx(struct lttng_kernel_ctx **ctx);
610 int lttng_add_nice_to_ctx(struct lttng_kernel_ctx **ctx);
611 int lttng_add_vpid_to_ctx(struct lttng_kernel_ctx **ctx);
612 int lttng_add_tid_to_ctx(struct lttng_kernel_ctx **ctx);
613 int lttng_add_vtid_to_ctx(struct lttng_kernel_ctx **ctx);
614 int lttng_add_ppid_to_ctx(struct lttng_kernel_ctx **ctx);
615 int lttng_add_vppid_to_ctx(struct lttng_kernel_ctx **ctx);
616 int lttng_add_hostname_to_ctx(struct lttng_kernel_ctx **ctx);
617 int lttng_add_interruptible_to_ctx(struct lttng_kernel_ctx **ctx);
618 int lttng_add_need_reschedule_to_ctx(struct lttng_kernel_ctx **ctx);
619 #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
620 int lttng_add_preemptible_to_ctx(struct lttng_kernel_ctx **ctx);
621 #else
622 static inline
623 int lttng_add_preemptible_to_ctx(struct lttng_kernel_ctx **ctx)
624 {
625 return -ENOSYS;
626 }
627 #endif
628 #ifdef CONFIG_PREEMPT_RT_FULL
629 int lttng_add_migratable_to_ctx(struct lttng_kernel_ctx **ctx);
630 #else
631 static inline
632 int lttng_add_migratable_to_ctx(struct lttng_kernel_ctx **ctx)
633 {
634 return -ENOSYS;
635 }
636 #endif
637
638 int lttng_add_callstack_to_ctx(struct lttng_kernel_ctx **ctx, int type);
639
640 #if defined(CONFIG_CGROUPS) && \
641 ((LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,6,0)) || \
642 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
643 int lttng_add_cgroup_ns_to_ctx(struct lttng_kernel_ctx **ctx);
644 #else
645 static inline
646 int lttng_add_cgroup_ns_to_ctx(struct lttng_kernel_ctx **ctx)
647 {
648 return -ENOSYS;
649 }
650 #endif
651
652 #if defined(CONFIG_IPC_NS) && \
653 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
654 int lttng_add_ipc_ns_to_ctx(struct lttng_kernel_ctx **ctx);
655 #else
656 static inline
657 int lttng_add_ipc_ns_to_ctx(struct lttng_kernel_ctx **ctx)
658 {
659 return -ENOSYS;
660 }
661 #endif
662
663 #if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
664 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
665 int lttng_add_mnt_ns_to_ctx(struct lttng_kernel_ctx **ctx);
666 #else
667 static inline
668 int lttng_add_mnt_ns_to_ctx(struct lttng_kernel_ctx **ctx)
669 {
670 return -ENOSYS;
671 }
672 #endif
673
674 #if defined(CONFIG_NET_NS) && \
675 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
676 int lttng_add_net_ns_to_ctx(struct lttng_kernel_ctx **ctx);
677 #else
678 static inline
679 int lttng_add_net_ns_to_ctx(struct lttng_kernel_ctx **ctx)
680 {
681 return -ENOSYS;
682 }
683 #endif
684
685 #if defined(CONFIG_PID_NS) && \
686 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
687 int lttng_add_pid_ns_to_ctx(struct lttng_kernel_ctx **ctx);
688 #else
689 static inline
690 int lttng_add_pid_ns_to_ctx(struct lttng_kernel_ctx **ctx)
691 {
692 return -ENOSYS;
693 }
694 #endif
695
696 #if defined(CONFIG_USER_NS) && \
697 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
698 int lttng_add_user_ns_to_ctx(struct lttng_kernel_ctx **ctx);
699 #else
700 static inline
701 int lttng_add_user_ns_to_ctx(struct lttng_kernel_ctx **ctx)
702 {
703 return -ENOSYS;
704 }
705 #endif
706
707 #if defined(CONFIG_UTS_NS) && \
708 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,8,0))
709 int lttng_add_uts_ns_to_ctx(struct lttng_kernel_ctx **ctx);
710 #else
711 static inline
712 int lttng_add_uts_ns_to_ctx(struct lttng_kernel_ctx **ctx)
713 {
714 return -ENOSYS;
715 }
716 #endif
717
718 #if defined(CONFIG_TIME_NS) && \
719 (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,6,0) || \
720 LTTNG_RHEL_KERNEL_RANGE(4,18,0,305,0,0, 4,19,0,0,0,0))
721 int lttng_add_time_ns_to_ctx(struct lttng_kernel_ctx **ctx);
722 #else
723 static inline
724 int lttng_add_time_ns_to_ctx(struct lttng_kernel_ctx **ctx)
725 {
726 return -ENOSYS;
727 }
728 #endif
729
730 int lttng_add_uid_to_ctx(struct lttng_kernel_ctx **ctx);
731 int lttng_add_euid_to_ctx(struct lttng_kernel_ctx **ctx);
732 int lttng_add_suid_to_ctx(struct lttng_kernel_ctx **ctx);
733 int lttng_add_gid_to_ctx(struct lttng_kernel_ctx **ctx);
734 int lttng_add_egid_to_ctx(struct lttng_kernel_ctx **ctx);
735 int lttng_add_sgid_to_ctx(struct lttng_kernel_ctx **ctx);
736 int lttng_add_vuid_to_ctx(struct lttng_kernel_ctx **ctx);
737 int lttng_add_veuid_to_ctx(struct lttng_kernel_ctx **ctx);
738 int lttng_add_vsuid_to_ctx(struct lttng_kernel_ctx **ctx);
739 int lttng_add_vgid_to_ctx(struct lttng_kernel_ctx **ctx);
740 int lttng_add_vegid_to_ctx(struct lttng_kernel_ctx **ctx);
741 int lttng_add_vsgid_to_ctx(struct lttng_kernel_ctx **ctx);
742
743 #if defined(CONFIG_PERF_EVENTS)
744 int lttng_add_perf_counter_to_ctx(uint32_t type,
745 uint64_t config,
746 const char *name,
747 struct lttng_kernel_ctx **ctx);
748 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
749 struct lttng_cpuhp_node *node);
750 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
751 struct lttng_cpuhp_node *node);
752 #else
753 static inline
754 int lttng_add_perf_counter_to_ctx(uint32_t type,
755 uint64_t config,
756 const char *name,
757 struct lttng_kernel_ctx **ctx)
758 {
759 return -ENOSYS;
760 }
761 static inline
762 int lttng_cpuhp_perf_counter_online(unsigned int cpu,
763 struct lttng_cpuhp_node *node)
764 {
765 return 0;
766 }
767 static inline
768 int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
769 struct lttng_cpuhp_node *node)
770 {
771 return 0;
772 }
773 #endif
774
775 struct lttng_event_recorder_enabler *lttng_event_recorder_enabler_create(
776 enum lttng_enabler_format_type format_type,
777 struct lttng_kernel_abi_event *event_param,
778 struct lttng_kernel_channel_buffer *chan);
779 void lttng_event_enabler_session_add(struct lttng_kernel_session *session,
780 struct lttng_event_recorder_enabler *event_enabler);
781
782 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
783 struct lttng_event_notifier_group *event_notifier_group,
784 enum lttng_enabler_format_type format_type,
785 struct lttng_kernel_abi_event_notifier *event_notifier_param);
786 int lttng_event_notifier_enabler_attach_capture_bytecode(
787 struct lttng_event_notifier_enabler *event_notifier_enabler,
788 struct lttng_kernel_abi_capture_bytecode __user *bytecode);
789
790 int lttng_event_enabler_enable(struct lttng_event_enabler_common *event_enabler);
791 int lttng_event_enabler_disable(struct lttng_event_enabler_common *event_enabler);
792 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler_common *event_enabler,
793 struct lttng_kernel_abi_filter_bytecode __user *bytecode);
794 void lttng_event_enabler_destroy(struct lttng_event_enabler_common *event_enabler);
795
796 int lttng_desc_match_enabler(const struct lttng_kernel_event_desc *desc,
797 struct lttng_event_enabler_common *enabler);
798
799 void lttng_enabler_link_bytecode(const struct lttng_kernel_event_desc *event_desc,
800 struct lttng_kernel_ctx *ctx,
801 struct list_head *instance_bytecode_runtime_head,
802 struct list_head *enabler_bytecode_runtime_head);
803
804 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
805 int lttng_syscalls_register_event(struct lttng_event_enabler_common *event_enabler);
806 int lttng_syscall_filter_enable_event(struct lttng_kernel_event_common *event);
807 int lttng_syscall_filter_disable_event(struct lttng_kernel_event_common *event);
808
809 int lttng_syscalls_unregister_syscall_table(struct lttng_kernel_syscall_table *syscall_table);
810 int lttng_syscalls_destroy_syscall_table(struct lttng_kernel_syscall_table *syscall_table);
811
812 long lttng_syscall_table_get_active_mask(struct lttng_kernel_syscall_table *syscall_table,
813 struct lttng_kernel_abi_syscall_mask __user *usyscall_mask);
814 #else
815 static inline int lttng_syscalls_register_event(struct lttng_event_enabler_common *event_enabler)
816 {
817 return -ENOSYS;
818 }
819
820 static inline int lttng_syscall_filter_enable_event(struct lttng_kernel_event_common *event)
821 {
822 return -ENOSYS;
823 }
824
825 static inline int lttng_syscall_filter_disable_event(struct lttng_kernel_event_common *event)
826 {
827 return -ENOSYS;
828 }
829
830 static inline int lttng_syscalls_unregister_syscall_table(struct lttng_kernel_syscall_table *syscall_table)
831 {
832 return 0;
833 }
834
835 static inline int lttng_syscalls_destroy_syscall_table(struct lttng_kernel_syscall_table *syscall_table)
836 {
837 return 0;
838 }
839
840 static inline long lttng_syscall_table_get_active_mask(struct lttng_kernel_syscall_table *syscall_table,
841 struct lttng_kernel_abi_syscall_mask __user *usyscall_mask)
842 {
843 return -ENOSYS;
844 }
845
846 static inline int lttng_syscalls_create_matching_event_notifiers(struct lttng_event_notifier_enabler *event_notifier_enabler)
847 {
848 return -ENOSYS;
849 }
850
851 #endif
852
853 #ifdef CONFIG_KPROBES
854 int lttng_kprobes_register_event(const char *name,
855 const char *symbol_name,
856 uint64_t offset,
857 uint64_t addr,
858 struct lttng_kernel_event_common *event);
859 void lttng_kprobes_unregister_event(struct lttng_kernel_event_common *event);
860 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_common *event);
861 #else
862 static inline
863 int lttng_kprobes_register_event(const char *name,
864 const char *symbol_name,
865 uint64_t offset,
866 uint64_t addr,
867 struct lttng_kernel_event_common *event)
868 {
869 return -ENOSYS;
870 }
871
872 static inline
873 void lttng_kprobes_unregister_event(struct lttng_kernel_event_common *event)
874 {
875 }
876
877 static inline
878 void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_common *event)
879 {
880 }
881 #endif
882
883 int lttng_event_add_callsite(struct lttng_kernel_event_common *event,
884 struct lttng_kernel_abi_event_callsite __user *callsite);
885
886 #ifdef CONFIG_UPROBES
887 int lttng_uprobes_register_event(const char *name,
888 int fd, struct lttng_kernel_event_common *event);
889 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
890 struct lttng_kernel_abi_event_callsite __user *callsite);
891 void lttng_uprobes_unregister_event(struct lttng_kernel_event_common *event);
892 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_common *event);
893 #else
894 static inline
895 int lttng_uprobes_register_event(const char *name,
896 int fd, struct lttng_kernel_event_common *event)
897 {
898 return -ENOSYS;
899 }
900
901 static inline
902 int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
903 struct lttng_kernel_abi_event_callsite __user *callsite)
904 {
905 return -ENOSYS;
906 }
907
908 static inline
909 void lttng_uprobes_unregister_event(struct lttng_kernel_event_common *event)
910 {
911 }
912
913 static inline
914 void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_common *event)
915 {
916 }
917 #endif
918
919 #ifdef CONFIG_KRETPROBES
920 int lttng_kretprobes_register(const char *name,
921 const char *symbol_name,
922 uint64_t offset,
923 uint64_t addr,
924 struct lttng_kernel_event_common *event_entry,
925 struct lttng_kernel_event_common *event_exit);
926 void lttng_kretprobes_unregister(struct lttng_kernel_event_common *event);
927 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_common *event);
928 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common *event,
929 int enable);
930 #else
931 static inline
932 int lttng_kretprobes_register(const char *name,
933 const char *symbol_name,
934 uint64_t offset,
935 uint64_t addr,
936 struct lttng_kernel_event_common *event_entry,
937 struct lttng_kernel_event_common *event_exit)
938 {
939 return -ENOSYS;
940 }
941
942 static inline
943 void lttng_kretprobes_unregister(struct lttng_kernel_event_common *event)
944 {
945 }
946
947 static inline
948 void lttng_kretprobes_destroy_private(struct lttng_kernel_event_common *event)
949 {
950 }
951
952 static inline
953 int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common *event,
954 int enable)
955 {
956 return -ENOSYS;
957 }
958 #endif
959
960 void lttng_lock_sessions(void);
961 void lttng_unlock_sessions(void);
962
963 struct list_head *lttng_get_probe_list_head(void);
964
965 int lttng_fix_pending_events(void);
966 int lttng_fix_pending_event_notifiers(void);
967 int lttng_session_active(void);
968 bool lttng_event_notifier_active(void);
969
970 struct lttng_kernel_session *lttng_session_create(void);
971 int lttng_session_enable(struct lttng_kernel_session *session);
972 int lttng_session_disable(struct lttng_kernel_session *session);
973 void lttng_session_destroy(struct lttng_kernel_session *session);
974 int lttng_session_metadata_regenerate(struct lttng_kernel_session *session);
975 int lttng_session_statedump(struct lttng_kernel_session *session);
976 void metadata_cache_destroy(struct kref *kref);
977
978 struct lttng_counter *lttng_kernel_counter_create(
979 const char *counter_transport_name, size_t number_dimensions,
980 const size_t *dimensions_sizes);
981 int lttng_kernel_counter_read(struct lttng_counter *counter,
982 const size_t *dimension_indexes, int32_t cpu,
983 int64_t *val, bool *overflow, bool *underflow);
984 int lttng_kernel_counter_aggregate(struct lttng_counter *counter,
985 const size_t *dimension_indexes, int64_t *val,
986 bool *overflow, bool *underflow);
987 int lttng_kernel_counter_clear(struct lttng_counter *counter,
988 const size_t *dimension_indexes);
989 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
990 int lttng_event_notifier_group_create_error_counter(
991 struct file *event_notifier_group_file,
992 const struct lttng_kernel_abi_counter_conf *error_counter_conf);
993 void lttng_event_notifier_group_destroy(
994 struct lttng_event_notifier_group *event_notifier_group);
995
996 struct lttng_kernel_channel_buffer *lttng_channel_buffer_create(struct lttng_kernel_session *session,
997 const char *transport_name,
998 void *buf_addr,
999 size_t subbuf_size, size_t num_subbuf,
1000 unsigned int switch_timer_interval,
1001 unsigned int read_timer_interval,
1002 enum channel_type channel_type);
1003 struct lttng_kernel_channel_buffer *lttng_global_channel_create(struct lttng_kernel_session *session,
1004 int overwrite, void *buf_addr,
1005 size_t subbuf_size, size_t num_subbuf,
1006 unsigned int switch_timer_interval,
1007 unsigned int read_timer_interval);
1008
1009 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer *chan);
1010 struct lttng_kernel_event_recorder *lttng_kernel_event_recorder_create(struct lttng_event_recorder_enabler *event_enabler,
1011 const struct lttng_kernel_event_desc *event_desc);
1012 struct lttng_kernel_event_recorder *_lttng_kernel_event_recorder_create(struct lttng_event_recorder_enabler *event_enabler,
1013 const struct lttng_kernel_event_desc *event_desc);
1014 struct lttng_kernel_event_recorder *lttng_event_compat_old_create(struct lttng_kernel_channel_buffer *chan,
1015 struct lttng_kernel_abi_old_event *old_event_param,
1016 const struct lttng_kernel_event_desc *internal_desc);
1017
1018 struct lttng_kernel_event_notifier *lttng_event_notifier_create(
1019 const struct lttng_kernel_event_desc *event_notifier_desc,
1020 uint64_t id,
1021 uint64_t error_counter_idx,
1022 struct lttng_event_notifier_group *event_notifier_group,
1023 struct lttng_kernel_abi_event_notifier *event_notifier_param,
1024 enum lttng_kernel_abi_instrumentation itype);
1025 struct lttng_kernel_event_notifier *_lttng_event_notifier_create(
1026 const struct lttng_kernel_event_desc *event_notifier_desc,
1027 uint64_t id,
1028 uint64_t error_counter_idx,
1029 struct lttng_event_notifier_group *event_notifier_group,
1030 struct lttng_kernel_abi_event_notifier *event_notifier_param,
1031 enum lttng_kernel_abi_instrumentation itype);
1032
1033 int lttng_channel_enable(struct lttng_kernel_channel_common *channel);
1034 int lttng_channel_disable(struct lttng_kernel_channel_common *channel);
1035 int lttng_event_enable(struct lttng_kernel_event_common *event);
1036 int lttng_event_disable(struct lttng_kernel_event_common *event);
1037
1038 void lttng_transport_register(struct lttng_transport *transport);
1039 void lttng_transport_unregister(struct lttng_transport *transport);
1040
1041 void lttng_counter_transport_register(struct lttng_counter_transport *transport);
1042 void lttng_counter_transport_unregister(struct lttng_counter_transport *transport);
1043
1044 void synchronize_trace(void);
1045 int lttng_abi_init(void);
1046 int lttng_abi_compat_old_init(void);
1047 void lttng_abi_exit(void);
1048 void lttng_abi_compat_old_exit(void);
1049
1050 const struct lttng_kernel_event_desc *lttng_event_desc_get(const char *name);
1051 void lttng_event_desc_put(const struct lttng_kernel_event_desc *desc);
1052 int lttng_probes_init(void);
1053 void lttng_probes_exit(void);
1054
1055 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
1056 struct lttng_kernel_ring_buffer_channel *chan, bool *coherent);
1057
1058 int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
1059 int lttng_id_tracker_empty_set(struct lttng_kernel_id_tracker *lf);
1060 int lttng_id_tracker_init(struct lttng_kernel_id_tracker *lf,
1061 struct lttng_kernel_session *session,
1062 enum tracker_type type);
1063 void lttng_id_tracker_fini(struct lttng_kernel_id_tracker *lf);
1064 void lttng_id_tracker_destroy(struct lttng_kernel_id_tracker *lf, bool rcu);
1065 int lttng_id_tracker_add(struct lttng_kernel_id_tracker *lf, int id);
1066 int lttng_id_tracker_del(struct lttng_kernel_id_tracker *lf, int id);
1067
1068 int lttng_session_track_id(struct lttng_kernel_session *session,
1069 enum tracker_type tracker_type, int id);
1070 int lttng_session_untrack_id(struct lttng_kernel_session *session,
1071 enum tracker_type tracker_type, int id);
1072
1073 int lttng_session_list_tracker_ids(struct lttng_kernel_session *session,
1074 enum tracker_type tracker_type);
1075
1076 void lttng_clock_ref(void);
1077 void lttng_clock_unref(void);
1078
1079 void lttng_free_event_filter_runtime(struct lttng_kernel_event_common *event);
1080
1081 int lttng_probes_init(void);
1082
1083 int lttng_logger_init(void);
1084 void lttng_logger_exit(void);
1085
1086 extern int lttng_statedump_start(struct lttng_kernel_session *session);
1087
1088 int lttng_calibrate(struct lttng_kernel_abi_calibrate *calibrate);
1089
1090 extern const struct file_operations lttng_tracepoint_list_fops;
1091 extern const struct file_operations lttng_syscall_list_fops;
1092
1093 #define lttng_kernel_static_ctx_field(_event_field, _get_size, _record, _get_value, _destroy, _priv) \
1094 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_ctx_field, { \
1095 .event_field = (_event_field), \
1096 .get_size = (_get_size), \
1097 .record = (_record), \
1098 .get_value = (_get_value), \
1099 .destroy = (_destroy), \
1100 .priv = (_priv), \
1101 })
1102
1103 #endif /* _LTTNG_EVENTS_INTERNAL_H */
This page took 0.090613 seconds and 4 git commands to generate.