Implement event notifier group create
[lttng-modules.git] / include / lttng / events.h
CommitLineData
b7cdc182 1/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
9f36eaed 2 *
2df37e95 3 * lttng/events.h
4e3c1b9b 4 *
4e3c1b9b 5 * Holds LTTng per-session event registry.
17baffe2 6 *
886d51a3 7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4e3c1b9b
MD
8 */
9
9f36eaed
MJ
10#ifndef _LTTNG_EVENTS_H
11#define _LTTNG_EVENTS_H
12
3a523f5b 13#include <linux/version.h>
4e3c1b9b 14#include <linux/list.h>
d6d808f3 15#include <linux/kprobes.h>
d83004aa 16#include <linux/kref.h>
41f229dc 17#include <linux/uuid.h>
149b9a9d 18#include <wrapper/uprobes.h>
2df37e95
MD
19#include <lttng/cpuhotplug.h>
20#include <lttng/tracer.h>
21#include <lttng/abi.h>
22#include <lttng/abi-old.h>
23#include <lttng/endian.h>
4e3c1b9b 24
06254b0f 25#define lttng_is_signed_type(type) (((type)(-1)) < 0)
9e7e4892 26
a90917c3
MD
27struct lttng_channel;
28struct lttng_session;
d83004aa 29struct lttng_metadata_cache;
1c25284c 30struct lib_ring_buffer_ctx;
ba1f5986 31struct perf_event;
833ad6a0 32struct perf_event_attr;
3b731ab1 33struct lib_ring_buffer_config;
4e3c1b9b 34
c0edae1d
MD
35/* Type description */
36
c0edae1d
MD
37enum abstract_types {
38 atype_integer,
c0edae1d 39 atype_string,
ceabb767
MD
40 atype_enum_nestable,
41 atype_array_nestable,
42 atype_sequence_nestable,
43 atype_struct_nestable,
44 atype_variant_nestable,
c0edae1d
MD
45 NR_ABSTRACT_TYPES,
46};
47
c0edae1d 48enum lttng_string_encodings {
e0a7a7c4
MD
49 lttng_encode_none = 0,
50 lttng_encode_UTF8 = 1,
51 lttng_encode_ASCII = 2,
c0edae1d
MD
52 NR_STRING_ENCODINGS,
53};
54
d83004aa
JD
55enum channel_type {
56 PER_CPU_CHANNEL,
57 METADATA_CHANNEL,
58};
59
141ddf28
MD
60struct lttng_enum_value {
61 unsigned long long value;
62 unsigned int signedness:1;
63};
64
c0edae1d 65struct lttng_enum_entry {
141ddf28 66 struct lttng_enum_value start, end; /* start and end are inclusive */
c0edae1d 67 const char *string;
08ad1061
PP
68 struct {
69 unsigned int is_auto:1;
70 } options;
c0edae1d
MD
71};
72
43803cf2
MD
73#define __type_integer(_type, _size, _alignment, _signedness, \
74 _byte_order, _base, _encoding) \
c099397a
MD
75 { \
76 .atype = atype_integer, \
ceabb767 77 .u.integer = \
c099397a 78 { \
43803cf2
MD
79 .size = (_size) ? : sizeof(_type) * CHAR_BIT, \
80 .alignment = (_alignment) ? : lttng_alignof(_type) * CHAR_BIT, \
81 .signedness = (_signedness) >= 0 ? (_signedness) : lttng_is_signed_type(_type), \
82 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
e0a7a7c4 83 .base = _base, \
64c796d8 84 .encoding = lttng_encode_##_encoding, \
c099397a
MD
85 }, \
86 } \
87
88struct lttng_integer_type {
89 unsigned int size; /* in bits */
90 unsigned short alignment; /* in bits */
9cccf98a
MD
91 unsigned int signedness:1,
92 reverse_byte_order:1;
e0a7a7c4
MD
93 unsigned int base; /* 2, 8, 10, 16, for pretty print */
94 enum lttng_string_encodings encoding;
c099397a
MD
95};
96
c0edae1d
MD
97struct lttng_type {
98 enum abstract_types atype;
c0edae1d 99 union {
ceabb767 100 struct lttng_integer_type integer;
c0edae1d 101 struct {
ceabb767
MD
102 enum lttng_string_encodings encoding;
103 } string;
c0edae1d 104 struct {
ceabb767
MD
105 const struct lttng_enum_desc *desc; /* Enumeration mapping */
106 const struct lttng_type *container_type;
107 } enum_nestable;
f513b2bf 108 struct {
ceabb767
MD
109 const struct lttng_type *elem_type;
110 unsigned int length; /* Num. elems. */
111 unsigned int alignment;
112 } array_nestable;
f513b2bf 113 struct {
ceabb767
MD
114 const char *length_name; /* Length field name. */
115 const struct lttng_type *elem_type;
116 unsigned int alignment; /* Alignment before elements. */
117 } sequence_nestable;
f513b2bf 118 struct {
ceabb767
MD
119 unsigned int nr_fields;
120 const struct lttng_event_field *fields; /* Array of fields. */
121 unsigned int alignment;
122 } struct_nestable;
65c85aa6
MD
123 struct {
124 const char *tag_name;
ceabb767
MD
125 const struct lttng_event_field *choices; /* Array of fields. */
126 unsigned int nr_choices;
127 unsigned int alignment;
128 } variant_nestable;
c0edae1d 129 } u;
c099397a
MD
130};
131
141ddf28 132struct lttng_enum_desc {
c099397a 133 const char *name;
c099397a 134 const struct lttng_enum_entry *entries;
141ddf28 135 unsigned int nr_entries;
c099397a 136};
c0edae1d
MD
137
138/* Event field description */
139
140struct lttng_event_field {
141 const char *name;
f17701fb 142 struct lttng_type type;
f127e61e 143 unsigned int nowrite:1, /* do not write into trace */
ceabb767
MD
144 user:1, /* fetch from user-space */
145 nofilter:1; /* do not consider for filter */
c0edae1d
MD
146};
147
07dfc1d0
MD
148union lttng_ctx_value {
149 int64_t s64;
150 const char *str;
151 double d;
152};
153
2001023e
MD
154/*
155 * We need to keep this perf counter field separately from struct
156 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
157 */
158struct lttng_perf_counter_field {
1e367326
MD
159#if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
160 struct lttng_cpuhp_node cpuhp_prepare;
161 struct lttng_cpuhp_node cpuhp_online;
162#else
2001023e
MD
163 struct notifier_block nb;
164 int hp_enable;
1e367326 165#endif
2001023e
MD
166 struct perf_event_attr *attr;
167 struct perf_event **e; /* per-cpu array */
168};
169
79150a49
JD
170struct lttng_probe_ctx {
171 struct lttng_event *event;
172 uint8_t interruptible;
173};
174
ba1f5986 175struct lttng_ctx_field {
8070f5c0 176 struct lttng_event_field event_field;
f1676205 177 size_t (*get_size)(size_t offset);
1474c8e2
FG
178 size_t (*get_size_arg)(size_t offset, struct lttng_ctx_field *field,
179 struct lib_ring_buffer_ctx *ctx,
180 struct lttng_channel *chan);
f1676205
MD
181 void (*record)(struct lttng_ctx_field *field,
182 struct lib_ring_buffer_ctx *ctx,
a90917c3 183 struct lttng_channel *chan);
07dfc1d0 184 void (*get_value)(struct lttng_ctx_field *field,
79150a49 185 struct lttng_probe_ctx *lttng_probe_ctx,
07dfc1d0 186 union lttng_ctx_value *value);
ba1f5986 187 union {
2001023e 188 struct lttng_perf_counter_field *perf_counter;
ba1f5986 189 } u;
2dccf128 190 void (*destroy)(struct lttng_ctx_field *field);
3c1a57e8
MD
191 /*
192 * Private data to keep state between get_size and record.
193 * User must perform its own synchronization to protect against
194 * concurrent and reentrant contexts.
195 */
196 void *priv;
ba1f5986
MD
197};
198
199struct lttng_ctx {
833ad6a0 200 struct lttng_ctx_field *fields;
0d1a681e 201 unsigned int nr_fields;
ba1f5986 202 unsigned int allocated_fields;
a9dd15da 203 size_t largest_align; /* in bytes */
0d1a681e
MD
204};
205
206struct lttng_event_desc {
a26a7e4f
MD
207 const char *name; /* lttng-modules name */
208 const char *kname; /* Linux kernel name (tracepoints) */
c0edae1d 209 void *probe_callback;
0d1a681e
MD
210 const struct lttng_event_ctx *ctx; /* context */
211 const struct lttng_event_field *fields; /* event payload */
c0edae1d 212 unsigned int nr_fields;
dc7f600a 213 struct module *owner;
c0edae1d
MD
214};
215
85a9ca7f 216struct lttng_probe_desc {
3c997079 217 const char *provider;
f7bdf4db 218 const struct lttng_event_desc **event_desc;
85a9ca7f
MD
219 unsigned int nr_events;
220 struct list_head head; /* chain registered probes */
3c997079
MD
221 struct list_head lazy_init_head;
222 int lazy; /* lazy registration */
85a9ca7f
MD
223};
224
7371f44c
MD
225struct lttng_krp; /* Kretprobe handling */
226
3c997079
MD
227enum lttng_event_type {
228 LTTNG_TYPE_EVENT = 0,
229 LTTNG_TYPE_ENABLER = 1,
230};
231
07dfc1d0
MD
232struct lttng_filter_bytecode_node {
233 struct list_head node;
234 struct lttng_enabler *enabler;
235 /*
236 * struct lttng_kernel_filter_bytecode has var. sized array, must be
237 * last field.
238 */
239 struct lttng_kernel_filter_bytecode bc;
240};
241
242/*
243 * Filter return value masks.
244 */
245enum lttng_filter_ret {
246 LTTNG_FILTER_DISCARD = 0,
247 LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
248 /* Other bits are kept for future use. */
249};
250
251struct lttng_bytecode_runtime {
252 /* Associated bytecode */
253 struct lttng_filter_bytecode_node *bc;
79150a49
JD
254 uint64_t (*filter)(void *filter_data, struct lttng_probe_ctx *lttng_probe_ctx,
255 const char *filter_stack_data);
07dfc1d0
MD
256 int link_failed;
257 struct list_head node; /* list of bytecode runtime in event */
2dfda770 258 struct lttng_ctx *ctx;
07dfc1d0
MD
259};
260
3c997079
MD
261/*
262 * Objects in a linked-list of enablers, owned by an event.
263 */
264struct lttng_enabler_ref {
265 struct list_head node; /* enabler ref list */
266 struct lttng_enabler *ref; /* backward ref */
267};
268
3aed4dca
FD
269struct lttng_uprobe_handler {
270 struct lttng_event *event;
271 loff_t offset;
272 struct uprobe_consumer up_consumer;
273 struct list_head node;
274};
275
badfe9f5
MD
276enum lttng_syscall_entryexit {
277 LTTNG_SYSCALL_ENTRY,
278 LTTNG_SYSCALL_EXIT,
279};
280
281enum lttng_syscall_abi {
282 LTTNG_SYSCALL_ABI_NATIVE,
283 LTTNG_SYSCALL_ABI_COMPAT,
284};
285
85a9ca7f 286/*
a90917c3 287 * lttng_event structure is referred to by the tracing fast path. It must be
85a9ca7f
MD
288 * kept small.
289 */
a90917c3 290struct lttng_event {
3c997079 291 enum lttng_event_type evtype; /* First field. */
85a9ca7f 292 unsigned int id;
a90917c3 293 struct lttng_channel *chan;
e64957da 294 int enabled;
d3dbe23c 295 const struct lttng_event_desc *desc;
85a9ca7f 296 void *filter;
f1676205 297 struct lttng_ctx *ctx;
38d024ae 298 enum lttng_kernel_instrumentation instrumentation;
d6d808f3
MD
299 union {
300 struct {
301 struct kprobe kp;
302 char *symbol_name;
303 } kprobe;
7371f44c
MD
304 struct {
305 struct lttng_krp *lttng_krp;
306 char *symbol_name;
307 } kretprobe;
149b9a9d 308 struct {
149b9a9d 309 struct inode *inode;
3aed4dca 310 struct list_head head;
149b9a9d 311 } uprobe;
badfe9f5
MD
312 struct {
313 char *syscall_name;
314 enum lttng_syscall_entryexit entryexit;
315 enum lttng_syscall_abi abi;
316 } syscall;
d6d808f3 317 } u;
3c997079 318 struct list_head list; /* Event list in session */
9cccf98a 319 unsigned int metadata_dumped:1;
3c997079
MD
320
321 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
322 struct list_head enablers_ref_head;
323 struct hlist_node hlist; /* session ht of events */
324 int registered; /* has reg'd tracepoint probe */
07dfc1d0
MD
325 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
326 struct list_head bytecode_runtime_head;
327 int has_enablers_without_bytecode;
3c997079
MD
328};
329
3b861b22
FD
330enum lttng_enabler_format_type {
331 LTTNG_ENABLER_FORMAT_STAR_GLOB,
332 LTTNG_ENABLER_FORMAT_NAME,
3c997079
MD
333};
334
335/*
336 * Enabler field, within whatever object is enabling an event. Target of
337 * backward reference.
338 */
339struct lttng_enabler {
340 enum lttng_event_type evtype; /* First field. */
341
3b861b22 342 enum lttng_enabler_format_type format_type;
3c997079 343
07dfc1d0
MD
344 /* head list of struct lttng_ust_filter_bytecode_node */
345 struct list_head filter_bytecode_head;
3c997079
MD
346
347 struct lttng_kernel_event event_param;
b2bc0bc8
FD
348 unsigned int enabled:1;
349};
350
351struct lttng_event_enabler {
352 struct lttng_enabler base;
353 struct list_head node; /* per-session list of enablers */
3c997079 354 struct lttng_channel *chan;
2954b37c
FD
355 /*
356 * Unused, but kept around to make it explicit that the tracer can do
357 * it.
358 */
3c997079 359 struct lttng_ctx *ctx;
85a9ca7f
MD
360};
361
b2bc0bc8
FD
362static inline
363struct lttng_enabler *lttng_event_enabler_as_enabler(
364 struct lttng_event_enabler *event_enabler)
365{
366 return &event_enabler->base;
367}
368
369
a90917c3 370struct lttng_channel_ops {
85a9ca7f 371 struct channel *(*channel_create)(const char *name,
5cf4b87c 372 void *priv,
85a9ca7f
MD
373 void *buf_addr,
374 size_t subbuf_size, size_t num_subbuf,
375 unsigned int switch_timer_interval,
376 unsigned int read_timer_interval);
377 void (*channel_destroy)(struct channel *chan);
378 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
f71ecafa 379 int (*buffer_has_read_closed_stream)(struct channel *chan);
85a9ca7f 380 void (*buffer_read_close)(struct lib_ring_buffer *buf);
4e1f08f4 381 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
64c796d8 382 uint32_t event_id);
85a9ca7f
MD
383 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
384 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
385 size_t len);
4ea00e4f
JD
386 void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
387 const void *src, size_t len);
58aa5d24
MD
388 void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
389 int c, size_t len);
16f78f3a
MD
390 void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
391 size_t len);
392 void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
393 const char __user *src, size_t len);
1ec3f75a
MD
394 /*
395 * packet_avail_size returns the available size in the current
396 * packet. Note that the size returned is only a hint, since it
397 * may change due to concurrent writes.
398 */
399 size_t (*packet_avail_size)(struct channel *chan);
71c1d843 400 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
24cedcfe
MD
401 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
402 int (*is_finalized)(struct channel *chan);
254ec7bc 403 int (*is_disabled)(struct channel *chan);
3b731ab1
JD
404 int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
405 struct lib_ring_buffer *bufb,
406 uint64_t *timestamp_begin);
407 int (*timestamp_end) (const struct lib_ring_buffer_config *config,
408 struct lib_ring_buffer *bufb,
409 uint64_t *timestamp_end);
410 int (*events_discarded) (const struct lib_ring_buffer_config *config,
411 struct lib_ring_buffer *bufb,
412 uint64_t *events_discarded);
413 int (*content_size) (const struct lib_ring_buffer_config *config,
414 struct lib_ring_buffer *bufb,
415 uint64_t *content_size);
416 int (*packet_size) (const struct lib_ring_buffer_config *config,
417 struct lib_ring_buffer *bufb,
418 uint64_t *packet_size);
419 int (*stream_id) (const struct lib_ring_buffer_config *config,
420 struct lib_ring_buffer *bufb,
421 uint64_t *stream_id);
2348ca17
JD
422 int (*current_timestamp) (const struct lib_ring_buffer_config *config,
423 struct lib_ring_buffer *bufb,
424 uint64_t *ts);
5b3cf4f9
JD
425 int (*sequence_number) (const struct lib_ring_buffer_config *config,
426 struct lib_ring_buffer *bufb,
427 uint64_t *seq);
5594698f
JD
428 int (*instance_id) (const struct lib_ring_buffer_config *config,
429 struct lib_ring_buffer *bufb,
430 uint64_t *id);
85a9ca7f
MD
431};
432
a90917c3 433struct lttng_transport {
a33c9927
MD
434 char *name;
435 struct module *owner;
436 struct list_head node;
a90917c3 437 struct lttng_channel_ops ops;
a33c9927
MD
438};
439
80f87dd2
MD
440struct lttng_syscall_filter;
441
3c997079
MD
442#define LTTNG_EVENT_HT_BITS 12
443#define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
444
445struct lttng_event_ht {
446 struct hlist_head table[LTTNG_EVENT_HT_SIZE];
447};
448
a90917c3 449struct lttng_channel {
c099397a 450 unsigned int id;
85a9ca7f 451 struct channel *chan; /* Channel buffers */
e64957da 452 int enabled;
f1676205 453 struct lttng_ctx *ctx;
85a9ca7f 454 /* Event ID management */
a90917c3 455 struct lttng_session *session;
85a9ca7f
MD
456 struct file *file; /* File associated to channel */
457 unsigned int free_event_id; /* Next event ID to allocate */
458 struct list_head list; /* Channel list */
a90917c3
MD
459 struct lttng_channel_ops *ops;
460 struct lttng_transport *transport;
461 struct lttng_event **sc_table; /* for syscall tracing */
462 struct lttng_event **compat_sc_table;
5b7ac358
MD
463 struct lttng_event **sc_exit_table; /* for syscall exit tracing */
464 struct lttng_event **compat_sc_exit_table;
a90917c3
MD
465 struct lttng_event *sc_unknown; /* for unknown syscalls */
466 struct lttng_event *sc_compat_unknown;
5b7ac358
MD
467 struct lttng_event *sc_exit_unknown;
468 struct lttng_event *compat_sc_exit_unknown;
80f87dd2 469 struct lttng_syscall_filter *sc_filter;
9115fbdc 470 int header_type; /* 0: unset, 1: compact, 2: large */
d83004aa 471 enum channel_type channel_type;
badfe9f5 472 int syscall_all;
80f87dd2
MD
473 unsigned int metadata_dumped:1,
474 sys_enter_registered:1,
475 sys_exit_registered:1,
3c997079 476 tstate:1; /* Transient enable state */
85a9ca7f
MD
477};
478
d83004aa
JD
479struct lttng_metadata_stream {
480 void *priv; /* Ring buffer private data */
481 struct lttng_metadata_cache *metadata_cache;
f613e3e6
MD
482 unsigned int metadata_in; /* Bytes read from the cache */
483 unsigned int metadata_out; /* Bytes consumed from stream */
d83004aa
JD
484 int finalized; /* Has channel been finalized */
485 wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
486 struct list_head list; /* Stream list */
b3b8072b 487 struct lttng_transport *transport;
9616f0bf 488 uint64_t version; /* Current version of the metadata cache */
8b97fd42 489 bool coherent; /* Stream in a coherent state */
d83004aa
JD
490};
491
114667d5
MD
492#define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
493
494struct lttng_dynamic_len_stack {
495 size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
496 size_t offset;
497};
498
499DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
e0130fab
MD
500
501/*
d1f652f8 502 * struct lttng_id_tracker declared in header due to deferencing of *v
e0130fab
MD
503 * in RCU_INITIALIZER(v).
504 */
d1f652f8
MD
505#define LTTNG_ID_HASH_BITS 6
506#define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
e0130fab 507
d1f652f8
MD
508enum tracker_type {
509 TRACKER_PID,
510 TRACKER_VPID,
511 TRACKER_UID,
512 TRACKER_VUID,
513 TRACKER_GID,
514 TRACKER_VGID,
515
516 TRACKER_UNKNOWN,
517};
518
519struct lttng_id_tracker_rcu {
520 struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
521};
522
523struct lttng_id_tracker {
524 struct lttng_session *session;
525 enum tracker_type tracker_type;
526 struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
e0130fab
MD
527};
528
d1f652f8 529struct lttng_id_hash_node {
7e6f9ef6 530 struct hlist_node hlist;
d1f652f8 531 int id;
7e6f9ef6
MD
532};
533
a90917c3 534struct lttng_session {
85a9ca7f 535 int active; /* Is trace session active ? */
8070f5c0 536 int been_active; /* Has trace session been active ? */
85a9ca7f
MD
537 struct file *file; /* File associated to session */
538 struct list_head chan; /* Channel list head */
539 struct list_head events; /* Event list head */
540 struct list_head list; /* Session list */
c099397a 541 unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1 542 uuid_le uuid; /* Trace session unique ID */
d83004aa 543 struct lttng_metadata_cache *metadata_cache;
d1f652f8
MD
544 struct lttng_id_tracker pid_tracker;
545 struct lttng_id_tracker vpid_tracker;
546 struct lttng_id_tracker uid_tracker;
547 struct lttng_id_tracker vuid_tracker;
548 struct lttng_id_tracker gid_tracker;
549 struct lttng_id_tracker vgid_tracker;
3c997079
MD
550 unsigned int metadata_dumped:1,
551 tstate:1; /* Transient enable state */
b2bc0bc8 552 /* List of event enablers */
3c997079
MD
553 struct list_head enablers_head;
554 /* Hash table of events */
555 struct lttng_event_ht events_ht;
7f859fbf 556 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
1c88f269 557 char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
85a9ca7f
MD
558};
559
750b05f2
FD
560struct lttng_event_notifier_group {
561 struct file *file; /* File associated to event notifier group */
562 struct list_head node; /* event notifier group list */
563 struct lttng_ctx *ctx; /* Contexts for filters. */
564 struct lttng_channel_ops *ops;
565 struct lttng_transport *transport;
566 struct channel *chan; /* Ring buffer channel for event notifier group. */
567 struct lib_ring_buffer *buf; /* Ring buffer for event notifier group. */
568};
569
d83004aa
JD
570struct lttng_metadata_cache {
571 char *data; /* Metadata cache */
572 unsigned int cache_alloc; /* Metadata allocated size (bytes) */
573 unsigned int metadata_written; /* Number of bytes written in metadata cache */
3e75e2a7 574 atomic_t producing; /* Metadata being produced (incomplete) */
d83004aa
JD
575 struct kref refcount; /* Metadata cache usage */
576 struct list_head metadata_stream; /* Metadata stream list */
a36580d5 577 uuid_le uuid; /* Trace session unique ID (copy) */
9616f0bf
JD
578 struct mutex lock; /* Produce/consume lock */
579 uint64_t version; /* Current version of the metadata */
d83004aa
JD
580};
581
3c997079
MD
582void lttng_lock_sessions(void);
583void lttng_unlock_sessions(void);
584
585struct list_head *lttng_get_probe_list_head(void);
586
b2bc0bc8
FD
587struct lttng_event_enabler *lttng_event_enabler_create(
588 enum lttng_enabler_format_type format_type,
3c997079
MD
589 struct lttng_kernel_event *event_param,
590 struct lttng_channel *chan);
591
b2bc0bc8
FD
592int lttng_event_enabler_enable(struct lttng_event_enabler *event_enabler);
593int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler);
3c997079
MD
594int lttng_fix_pending_events(void);
595int lttng_session_active(void);
596
a90917c3
MD
597struct lttng_session *lttng_session_create(void);
598int lttng_session_enable(struct lttng_session *session);
599int lttng_session_disable(struct lttng_session *session);
600void lttng_session_destroy(struct lttng_session *session);
9616f0bf 601int lttng_session_metadata_regenerate(struct lttng_session *session);
601252cf 602int lttng_session_statedump(struct lttng_session *session);
d83004aa 603void metadata_cache_destroy(struct kref *kref);
4e3c1b9b 604
750b05f2
FD
605struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
606void lttng_event_notifier_group_destroy(
607 struct lttng_event_notifier_group *event_notifier_group);
608
a90917c3 609struct lttng_channel *lttng_channel_create(struct lttng_session *session,
5dbbdb43
MD
610 const char *transport_name,
611 void *buf_addr,
612 size_t subbuf_size, size_t num_subbuf,
613 unsigned int switch_timer_interval,
d83004aa
JD
614 unsigned int read_timer_interval,
615 enum channel_type channel_type);
a90917c3 616struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
4e3c1b9b
MD
617 int overwrite, void *buf_addr,
618 size_t subbuf_size, size_t num_subbuf,
619 unsigned int switch_timer_interval,
620 unsigned int read_timer_interval);
4e3c1b9b 621
d83004aa 622void lttng_metadata_channel_destroy(struct lttng_channel *chan);
a90917c3 623struct lttng_event *lttng_event_create(struct lttng_channel *chan,
3c997079
MD
624 struct lttng_kernel_event *event_param,
625 void *filter,
626 const struct lttng_event_desc *event_desc,
627 enum lttng_kernel_instrumentation itype);
33a39a3c
MD
628struct lttng_event *_lttng_event_create(struct lttng_channel *chan,
629 struct lttng_kernel_event *event_param,
630 void *filter,
631 const struct lttng_event_desc *event_desc,
632 enum lttng_kernel_instrumentation itype);
6dccd6c1
JD
633struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
634 struct lttng_kernel_old_event *old_event_param,
635 void *filter,
636 const struct lttng_event_desc *internal_desc);
c0e31d2e 637
a90917c3
MD
638int lttng_channel_enable(struct lttng_channel *channel);
639int lttng_channel_disable(struct lttng_channel *channel);
640int lttng_event_enable(struct lttng_event *event);
641int lttng_event_disable(struct lttng_event *event);
e64957da 642
a90917c3
MD
643void lttng_transport_register(struct lttng_transport *transport);
644void lttng_transport_unregister(struct lttng_transport *transport);
11b5a3c2 645
360f38ea 646void synchronize_trace(void);
80996790 647int lttng_abi_init(void);
6dccd6c1 648int lttng_abi_compat_old_init(void);
80996790 649void lttng_abi_exit(void);
6dccd6c1 650void lttng_abi_compat_old_exit(void);
1c25284c 651
a90917c3
MD
652int lttng_probe_register(struct lttng_probe_desc *desc);
653void lttng_probe_unregister(struct lttng_probe_desc *desc);
0bcedee9
FD
654const struct lttng_event_desc *lttng_event_desc_get(const char *name);
655void lttng_event_desc_put(const struct lttng_event_desc *desc);
a90917c3
MD
656int lttng_probes_init(void);
657void lttng_probes_exit(void);
1ec65de1 658
b3b8072b 659int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
8b97fd42 660 struct channel *chan, bool *coherent);
d83004aa 661
d1f652f8
MD
662int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
663int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
664void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
665bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
666int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
667int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
e0130fab 668
d1f652f8
MD
669int lttng_session_track_id(struct lttng_session *session,
670 enum tracker_type tracker_type, int id);
671int lttng_session_untrack_id(struct lttng_session *session,
672 enum tracker_type tracker_type, int id);
e0130fab 673
d1f652f8
MD
674int lttng_session_list_tracker_ids(struct lttng_session *session,
675 enum tracker_type tracker_type);
7e6f9ef6 676
2754583e
MD
677void lttng_clock_ref(void);
678void lttng_clock_unref(void);
679
3a523f5b 680#if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
a90917c3
MD
681int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
682int lttng_syscalls_unregister(struct lttng_channel *chan);
badfe9f5 683int lttng_syscalls_destroy(struct lttng_channel *chan);
80f87dd2 684int lttng_syscall_filter_enable(struct lttng_channel *chan,
badfe9f5 685 struct lttng_event *event);
80f87dd2 686int lttng_syscall_filter_disable(struct lttng_channel *chan,
badfe9f5 687 struct lttng_event *event);
12e579db
MD
688long lttng_channel_syscall_mask(struct lttng_channel *channel,
689 struct lttng_kernel_syscall_mask __user *usyscall_mask);
1ec65de1 690#else
a90917c3 691static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
1ec65de1
MD
692{
693 return -ENOSYS;
694}
695
a90917c3 696static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
1ec65de1
MD
697{
698 return 0;
699}
80f87dd2 700
badfe9f5
MD
701static inline int lttng_syscalls_destroy(struct lttng_channel *chan)
702{
703 return 0;
704}
705
f127e61e 706static inline int lttng_syscall_filter_enable(struct lttng_channel *chan,
badfe9f5 707 struct lttng_event *event);
80f87dd2
MD
708{
709 return -ENOSYS;
710}
711
f127e61e 712static inline int lttng_syscall_filter_disable(struct lttng_channel *chan,
badfe9f5 713 struct lttng_event *event);
80f87dd2
MD
714{
715 return -ENOSYS;
716}
12e579db 717
f127e61e 718static inline long lttng_channel_syscall_mask(struct lttng_channel *channel,
12e579db
MD
719 struct lttng_kernel_syscall_mask __user *usyscall_mask)
720{
721 return -ENOSYS;
722}
1ec65de1
MD
723#endif
724
07dfc1d0 725void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
b2bc0bc8 726int lttng_event_enabler_attach_bytecode(struct lttng_event_enabler *event_enabler,
07dfc1d0 727 struct lttng_kernel_filter_bytecode __user *bytecode);
2dfda770
FD
728
729void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
730 struct lttng_ctx *ctx,
731 struct list_head *bytecode_runtime_head,
732 struct lttng_enabler *enabler);
07dfc1d0 733
114667d5
MD
734int lttng_probes_init(void);
735
07dfc1d0
MD
736extern struct lttng_ctx *lttng_static_ctx;
737
738int lttng_context_init(void);
739void lttng_context_exit(void);
2dccf128 740struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
c02eb859
MD
741ssize_t lttng_append_context_index(struct lttng_ctx **ctx_p);
742struct lttng_ctx_field *lttng_get_context_field_from_index(struct lttng_ctx *ctx,
743 size_t index);
a9dd15da 744void lttng_context_update(struct lttng_ctx *ctx);
44252f0f 745int lttng_find_context(struct lttng_ctx *ctx, const char *name);
07dfc1d0 746int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
8289661d
MD
747void lttng_remove_context_field(struct lttng_ctx **ctx,
748 struct lttng_ctx_field *field);
c02eb859 749void lttng_remove_context_field_index(struct lttng_ctx **ctx_p, size_t index);
2dccf128 750void lttng_destroy_context(struct lttng_ctx *ctx);
8070f5c0 751int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
b3699d90 752int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
a2563e83 753int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
a8ad3613 754int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
53f1f0ca 755int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
b64bc438
MD
756int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
757int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
758int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
759int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
760int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
975da2c0 761int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
79150a49
JD
762int lttng_add_interruptible_to_ctx(struct lttng_ctx **ctx);
763int lttng_add_need_reschedule_to_ctx(struct lttng_ctx **ctx);
764#if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
765int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx);
766#else
767static inline
768int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx)
769{
770 return -ENOSYS;
771}
772#endif
773#ifdef CONFIG_PREEMPT_RT_FULL
774int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx);
775#else
776static inline
777int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx)
778{
779 return -ENOSYS;
780}
781#endif
2fa2d39a
FG
782
783int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type);
784
a6cf40a4
MJ
785#if defined(CONFIG_CGROUPS) && \
786 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
787 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
788int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
789#else
790static inline
791int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx)
792{
793 return -ENOSYS;
794}
795#endif
796
797#if defined(CONFIG_IPC_NS) && \
798 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
799int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
800#else
801static inline
802int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx)
803{
804 return -ENOSYS;
805}
806#endif
807
808#if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
809 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
810int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
811#else
812static inline
813int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx)
814{
815 return -ENOSYS;
816}
817#endif
818
819#if defined(CONFIG_NET_NS) && \
820 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
821int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
822#else
823static inline
824int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx)
825{
826 return -ENOSYS;
827}
828#endif
829
830#if defined(CONFIG_PID_NS) && \
831 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
832int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
833#else
834static inline
835int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx)
836{
837 return -ENOSYS;
838}
839#endif
840
841#if defined(CONFIG_USER_NS) && \
842 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
843int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
844#else
845static inline
846int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx)
847{
848 return -ENOSYS;
849}
850#endif
851
852#if defined(CONFIG_UTS_NS) && \
853 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
854int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
855#else
856static inline
857int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx)
858{
859 return -ENOSYS;
860}
861#endif
862
876e2e92
MJ
863#if defined(CONFIG_TIME_NS) && \
864 (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
865int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx);
866#else
867static inline
868int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx)
869{
870 return -ENOSYS;
871}
872#endif
873
dc923e75
MJ
874int lttng_add_uid_to_ctx(struct lttng_ctx **ctx);
875int lttng_add_euid_to_ctx(struct lttng_ctx **ctx);
876int lttng_add_suid_to_ctx(struct lttng_ctx **ctx);
877int lttng_add_gid_to_ctx(struct lttng_ctx **ctx);
878int lttng_add_egid_to_ctx(struct lttng_ctx **ctx);
879int lttng_add_sgid_to_ctx(struct lttng_ctx **ctx);
880int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
881int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
882int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
883int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
884int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
885int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
886
8a3af9ee 887#if defined(CONFIG_PERF_EVENTS)
c24a0d71
MD
888int lttng_add_perf_counter_to_ctx(uint32_t type,
889 uint64_t config,
890 const char *name,
891 struct lttng_ctx **ctx);
1e367326
MD
892int lttng_cpuhp_perf_counter_online(unsigned int cpu,
893 struct lttng_cpuhp_node *node);
894int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
895 struct lttng_cpuhp_node *node);
1d443b34
MD
896#else
897static inline
898int lttng_add_perf_counter_to_ctx(uint32_t type,
899 uint64_t config,
900 const char *name,
901 struct lttng_ctx **ctx)
902{
903 return -ENOSYS;
904}
1e367326
MD
905static inline
906int lttng_cpuhp_perf_counter_online(unsigned int cpu,
907 struct lttng_cpuhp_node *node)
908{
909 return 0;
910}
911static inline
912int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
913 struct lttng_cpuhp_node *node)
914{
915 return 0;
916}
1d443b34 917#endif
02119ee5 918
0c956676
MD
919int lttng_logger_init(void);
920void lttng_logger_exit(void);
921
c337ddc2
MD
922extern int lttng_statedump_start(struct lttng_session *session);
923
acd614cc 924#ifdef CONFIG_KPROBES
f17701fb
MD
925int lttng_kprobes_register(const char *name,
926 const char *symbol_name,
927 uint64_t offset,
928 uint64_t addr,
a90917c3
MD
929 struct lttng_event *event);
930void lttng_kprobes_unregister(struct lttng_event *event);
931void lttng_kprobes_destroy_private(struct lttng_event *event);
acd614cc
MD
932#else
933static inline
934int lttng_kprobes_register(const char *name,
935 const char *symbol_name,
936 uint64_t offset,
937 uint64_t addr,
a90917c3 938 struct lttng_event *event)
acd614cc
MD
939{
940 return -ENOSYS;
941}
942
25f53c39 943static inline
a90917c3 944void lttng_kprobes_unregister(struct lttng_event *event)
acd614cc
MD
945{
946}
edeb3137
MD
947
948static inline
a90917c3 949void lttng_kprobes_destroy_private(struct lttng_event *event)
edeb3137
MD
950{
951}
acd614cc 952#endif
d6d808f3 953
3aed4dca
FD
954int lttng_event_add_callsite(struct lttng_event *event,
955 struct lttng_kernel_event_callsite *callsite);
e33fc900 956
149b9a9d
YB
957#ifdef CONFIG_UPROBES
958int lttng_uprobes_register(const char *name,
3aed4dca
FD
959 int fd, struct lttng_event *event);
960int lttng_uprobes_add_callsite(struct lttng_event *event,
961 struct lttng_kernel_event_callsite *callsite);
149b9a9d
YB
962void lttng_uprobes_unregister(struct lttng_event *event);
963void lttng_uprobes_destroy_private(struct lttng_event *event);
964#else
965static inline
966int lttng_uprobes_register(const char *name,
3aed4dca
FD
967 int fd, struct lttng_event *event)
968{
969 return -ENOSYS;
970}
971
972static inline
973int lttng_uprobes_add_callsite(struct lttng_event *event,
e33fc900 974 struct lttng_kernel_event_callsite *callsite)
149b9a9d
YB
975{
976 return -ENOSYS;
977}
978
979static inline
980void lttng_uprobes_unregister(struct lttng_event *event)
981{
982}
983
984static inline
985void lttng_uprobes_destroy_private(struct lttng_event *event)
986{
987}
988#endif
989
7371f44c
MD
990#ifdef CONFIG_KRETPROBES
991int lttng_kretprobes_register(const char *name,
992 const char *symbol_name,
993 uint64_t offset,
994 uint64_t addr,
a90917c3
MD
995 struct lttng_event *event_entry,
996 struct lttng_event *event_exit);
997void lttng_kretprobes_unregister(struct lttng_event *event);
998void lttng_kretprobes_destroy_private(struct lttng_event *event);
a0493bef
MD
999int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1000 int enable);
7371f44c
MD
1001#else
1002static inline
1003int lttng_kretprobes_register(const char *name,
1004 const char *symbol_name,
1005 uint64_t offset,
1006 uint64_t addr,
a90917c3
MD
1007 struct lttng_event *event_entry,
1008 struct lttng_event *event_exit)
7371f44c
MD
1009{
1010 return -ENOSYS;
1011}
1012
1013static inline
a90917c3 1014void lttng_kretprobes_unregister(struct lttng_event *event)
7371f44c
MD
1015{
1016}
1017
1018static inline
a90917c3 1019void lttng_kretprobes_destroy_private(struct lttng_event *event)
7371f44c
MD
1020{
1021}
a0493bef
MD
1022
1023static inline
1024int lttng_kretprobes_event_enable_state(struct lttng_event *event,
1025 int enable)
1026{
1027 return -ENOSYS;
1028}
7371f44c
MD
1029#endif
1030
3db41b2c 1031int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
57105fc2 1032
271b6681 1033extern const struct file_operations lttng_tracepoint_list_fops;
2d2464bd 1034extern const struct file_operations lttng_syscall_list_fops;
271b6681 1035
ef200626 1036#define TRACEPOINT_HAS_DATA_ARG
ef200626 1037
ceabb767
MD
1038static inline bool lttng_is_bytewise_integer(const struct lttng_type *type)
1039{
1040 if (type->atype != atype_integer)
1041 return false;
1042 switch (type->u.integer.size) {
1043 case 8: /* Fall-through. */
1044 case 16: /* Fall-through. */
1045 case 32: /* Fall-through. */
1046 case 64:
1047 break;
1048 default:
1049 return false;
1050 }
1051 return true;
1052}
1053
a90917c3 1054#endif /* _LTTNG_EVENTS_H */
This page took 0.101563 seconds and 4 git commands to generate.