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