tracepoint: Refactor representation of nested types
[lttng-modules.git] / lttng-events.h
CommitLineData
b7cdc182 1/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
9f36eaed 2 *
a90917c3 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>
1e367326 17#include <lttng-cpuhotplug.h>
41f229dc 18#include <linux/uuid.h>
149b9a9d 19#include <wrapper/uprobes.h>
f64dd4be 20#include <lttng-tracer.h>
bbd023d6
MD
21#include <lttng-abi.h>
22#include <lttng-abi-old.h>
ceabb767 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 */
3834b99f 258 struct lttng_event *event;
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
85a9ca7f 276/*
a90917c3 277 * lttng_event structure is referred to by the tracing fast path. It must be
85a9ca7f
MD
278 * kept small.
279 */
a90917c3 280struct lttng_event {
3c997079 281 enum lttng_event_type evtype; /* First field. */
85a9ca7f 282 unsigned int id;
a90917c3 283 struct lttng_channel *chan;
e64957da 284 int enabled;
d3dbe23c 285 const struct lttng_event_desc *desc;
85a9ca7f 286 void *filter;
f1676205 287 struct lttng_ctx *ctx;
38d024ae 288 enum lttng_kernel_instrumentation instrumentation;
d6d808f3
MD
289 union {
290 struct {
291 struct kprobe kp;
292 char *symbol_name;
293 } kprobe;
7371f44c
MD
294 struct {
295 struct lttng_krp *lttng_krp;
296 char *symbol_name;
297 } kretprobe;
149b9a9d 298 struct {
149b9a9d 299 struct inode *inode;
3aed4dca 300 struct list_head head;
149b9a9d 301 } uprobe;
d6d808f3 302 } u;
3c997079 303 struct list_head list; /* Event list in session */
9cccf98a 304 unsigned int metadata_dumped:1;
3c997079
MD
305
306 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
307 struct list_head enablers_ref_head;
308 struct hlist_node hlist; /* session ht of events */
309 int registered; /* has reg'd tracepoint probe */
07dfc1d0
MD
310 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
311 struct list_head bytecode_runtime_head;
312 int has_enablers_without_bytecode;
3c997079
MD
313};
314
315enum lttng_enabler_type {
4993071a 316 LTTNG_ENABLER_STAR_GLOB,
3c997079
MD
317 LTTNG_ENABLER_NAME,
318};
319
320/*
321 * Enabler field, within whatever object is enabling an event. Target of
322 * backward reference.
323 */
324struct lttng_enabler {
325 enum lttng_event_type evtype; /* First field. */
326
327 enum lttng_enabler_type type;
328
329 struct list_head node; /* per-session list of enablers */
07dfc1d0
MD
330 /* head list of struct lttng_ust_filter_bytecode_node */
331 struct list_head filter_bytecode_head;
3c997079
MD
332
333 struct lttng_kernel_event event_param;
334 struct lttng_channel *chan;
335 struct lttng_ctx *ctx;
336 unsigned int enabled:1;
85a9ca7f
MD
337};
338
a90917c3 339struct lttng_channel_ops {
85a9ca7f 340 struct channel *(*channel_create)(const char *name,
a90917c3 341 struct lttng_channel *lttng_chan,
85a9ca7f
MD
342 void *buf_addr,
343 size_t subbuf_size, size_t num_subbuf,
344 unsigned int switch_timer_interval,
345 unsigned int read_timer_interval);
346 void (*channel_destroy)(struct channel *chan);
347 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
f71ecafa 348 int (*buffer_has_read_closed_stream)(struct channel *chan);
85a9ca7f 349 void (*buffer_read_close)(struct lib_ring_buffer *buf);
4e1f08f4 350 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
64c796d8 351 uint32_t event_id);
85a9ca7f
MD
352 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
353 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
354 size_t len);
4ea00e4f
JD
355 void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
356 const void *src, size_t len);
58aa5d24
MD
357 void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
358 int c, size_t len);
16f78f3a
MD
359 void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
360 size_t len);
361 void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
362 const char __user *src, size_t len);
1ec3f75a
MD
363 /*
364 * packet_avail_size returns the available size in the current
365 * packet. Note that the size returned is only a hint, since it
366 * may change due to concurrent writes.
367 */
368 size_t (*packet_avail_size)(struct channel *chan);
71c1d843 369 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
24cedcfe
MD
370 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
371 int (*is_finalized)(struct channel *chan);
254ec7bc 372 int (*is_disabled)(struct channel *chan);
3b731ab1
JD
373 int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
374 struct lib_ring_buffer *bufb,
375 uint64_t *timestamp_begin);
376 int (*timestamp_end) (const struct lib_ring_buffer_config *config,
377 struct lib_ring_buffer *bufb,
378 uint64_t *timestamp_end);
379 int (*events_discarded) (const struct lib_ring_buffer_config *config,
380 struct lib_ring_buffer *bufb,
381 uint64_t *events_discarded);
382 int (*content_size) (const struct lib_ring_buffer_config *config,
383 struct lib_ring_buffer *bufb,
384 uint64_t *content_size);
385 int (*packet_size) (const struct lib_ring_buffer_config *config,
386 struct lib_ring_buffer *bufb,
387 uint64_t *packet_size);
388 int (*stream_id) (const struct lib_ring_buffer_config *config,
389 struct lib_ring_buffer *bufb,
390 uint64_t *stream_id);
2348ca17
JD
391 int (*current_timestamp) (const struct lib_ring_buffer_config *config,
392 struct lib_ring_buffer *bufb,
393 uint64_t *ts);
5b3cf4f9
JD
394 int (*sequence_number) (const struct lib_ring_buffer_config *config,
395 struct lib_ring_buffer *bufb,
396 uint64_t *seq);
5594698f
JD
397 int (*instance_id) (const struct lib_ring_buffer_config *config,
398 struct lib_ring_buffer *bufb,
399 uint64_t *id);
85a9ca7f
MD
400};
401
a90917c3 402struct lttng_transport {
a33c9927
MD
403 char *name;
404 struct module *owner;
405 struct list_head node;
a90917c3 406 struct lttng_channel_ops ops;
a33c9927
MD
407};
408
80f87dd2
MD
409struct lttng_syscall_filter;
410
3c997079
MD
411#define LTTNG_EVENT_HT_BITS 12
412#define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
413
414struct lttng_event_ht {
415 struct hlist_head table[LTTNG_EVENT_HT_SIZE];
416};
417
a90917c3 418struct lttng_channel {
c099397a 419 unsigned int id;
85a9ca7f 420 struct channel *chan; /* Channel buffers */
e64957da 421 int enabled;
f1676205 422 struct lttng_ctx *ctx;
85a9ca7f 423 /* Event ID management */
a90917c3 424 struct lttng_session *session;
85a9ca7f
MD
425 struct file *file; /* File associated to channel */
426 unsigned int free_event_id; /* Next event ID to allocate */
427 struct list_head list; /* Channel list */
a90917c3
MD
428 struct lttng_channel_ops *ops;
429 struct lttng_transport *transport;
430 struct lttng_event **sc_table; /* for syscall tracing */
431 struct lttng_event **compat_sc_table;
5b7ac358
MD
432 struct lttng_event **sc_exit_table; /* for syscall exit tracing */
433 struct lttng_event **compat_sc_exit_table;
a90917c3
MD
434 struct lttng_event *sc_unknown; /* for unknown syscalls */
435 struct lttng_event *sc_compat_unknown;
5b7ac358
MD
436 struct lttng_event *sc_exit_unknown;
437 struct lttng_event *compat_sc_exit_unknown;
80f87dd2 438 struct lttng_syscall_filter *sc_filter;
9115fbdc 439 int header_type; /* 0: unset, 1: compact, 2: large */
d83004aa 440 enum channel_type channel_type;
80f87dd2
MD
441 unsigned int metadata_dumped:1,
442 sys_enter_registered:1,
443 sys_exit_registered:1,
3c997079
MD
444 syscall_all:1,
445 tstate:1; /* Transient enable state */
85a9ca7f
MD
446};
447
d83004aa
JD
448struct lttng_metadata_stream {
449 void *priv; /* Ring buffer private data */
450 struct lttng_metadata_cache *metadata_cache;
f613e3e6
MD
451 unsigned int metadata_in; /* Bytes read from the cache */
452 unsigned int metadata_out; /* Bytes consumed from stream */
d83004aa
JD
453 int finalized; /* Has channel been finalized */
454 wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
455 struct list_head list; /* Stream list */
b3b8072b 456 struct lttng_transport *transport;
9616f0bf 457 uint64_t version; /* Current version of the metadata cache */
d83004aa
JD
458};
459
114667d5
MD
460#define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
461
462struct lttng_dynamic_len_stack {
463 size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
464 size_t offset;
465};
466
467DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
e0130fab
MD
468
469/*
d1f652f8 470 * struct lttng_id_tracker declared in header due to deferencing of *v
e0130fab
MD
471 * in RCU_INITIALIZER(v).
472 */
d1f652f8
MD
473#define LTTNG_ID_HASH_BITS 6
474#define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
e0130fab 475
d1f652f8
MD
476enum tracker_type {
477 TRACKER_PID,
478 TRACKER_VPID,
479 TRACKER_UID,
480 TRACKER_VUID,
481 TRACKER_GID,
482 TRACKER_VGID,
483
484 TRACKER_UNKNOWN,
485};
486
487struct lttng_id_tracker_rcu {
488 struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
489};
490
491struct lttng_id_tracker {
492 struct lttng_session *session;
493 enum tracker_type tracker_type;
494 struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
e0130fab
MD
495};
496
d1f652f8 497struct lttng_id_hash_node {
7e6f9ef6 498 struct hlist_node hlist;
d1f652f8 499 int id;
7e6f9ef6
MD
500};
501
a90917c3 502struct lttng_session {
85a9ca7f 503 int active; /* Is trace session active ? */
8070f5c0 504 int been_active; /* Has trace session been active ? */
85a9ca7f
MD
505 struct file *file; /* File associated to session */
506 struct list_head chan; /* Channel list head */
507 struct list_head events; /* Event list head */
508 struct list_head list; /* Session list */
c099397a 509 unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1 510 uuid_le uuid; /* Trace session unique ID */
d83004aa 511 struct lttng_metadata_cache *metadata_cache;
d1f652f8
MD
512 struct lttng_id_tracker pid_tracker;
513 struct lttng_id_tracker vpid_tracker;
514 struct lttng_id_tracker uid_tracker;
515 struct lttng_id_tracker vuid_tracker;
516 struct lttng_id_tracker gid_tracker;
517 struct lttng_id_tracker vgid_tracker;
3c997079
MD
518 unsigned int metadata_dumped:1,
519 tstate:1; /* Transient enable state */
520 /* List of enablers */
521 struct list_head enablers_head;
522 /* Hash table of events */
523 struct lttng_event_ht events_ht;
7f859fbf 524 char name[LTTNG_KERNEL_SESSION_NAME_LEN];
1c88f269 525 char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
85a9ca7f
MD
526};
527
d83004aa
JD
528struct lttng_metadata_cache {
529 char *data; /* Metadata cache */
530 unsigned int cache_alloc; /* Metadata allocated size (bytes) */
531 unsigned int metadata_written; /* Number of bytes written in metadata cache */
532 struct kref refcount; /* Metadata cache usage */
533 struct list_head metadata_stream; /* Metadata stream list */
a36580d5 534 uuid_le uuid; /* Trace session unique ID (copy) */
9616f0bf
JD
535 struct mutex lock; /* Produce/consume lock */
536 uint64_t version; /* Current version of the metadata */
d83004aa
JD
537};
538
3c997079
MD
539void lttng_lock_sessions(void);
540void lttng_unlock_sessions(void);
541
542struct list_head *lttng_get_probe_list_head(void);
543
544struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type,
545 struct lttng_kernel_event *event_param,
546 struct lttng_channel *chan);
547
548int lttng_enabler_enable(struct lttng_enabler *enabler);
549int lttng_enabler_disable(struct lttng_enabler *enabler);
550int lttng_fix_pending_events(void);
551int lttng_session_active(void);
552
a90917c3
MD
553struct lttng_session *lttng_session_create(void);
554int lttng_session_enable(struct lttng_session *session);
555int lttng_session_disable(struct lttng_session *session);
556void lttng_session_destroy(struct lttng_session *session);
9616f0bf 557int lttng_session_metadata_regenerate(struct lttng_session *session);
601252cf 558int lttng_session_statedump(struct lttng_session *session);
d83004aa 559void metadata_cache_destroy(struct kref *kref);
4e3c1b9b 560
a90917c3 561struct lttng_channel *lttng_channel_create(struct lttng_session *session,
5dbbdb43
MD
562 const char *transport_name,
563 void *buf_addr,
564 size_t subbuf_size, size_t num_subbuf,
565 unsigned int switch_timer_interval,
d83004aa
JD
566 unsigned int read_timer_interval,
567 enum channel_type channel_type);
a90917c3 568struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
4e3c1b9b
MD
569 int overwrite, void *buf_addr,
570 size_t subbuf_size, size_t num_subbuf,
571 unsigned int switch_timer_interval,
572 unsigned int read_timer_interval);
4e3c1b9b 573
d83004aa 574void lttng_metadata_channel_destroy(struct lttng_channel *chan);
a90917c3 575struct lttng_event *lttng_event_create(struct lttng_channel *chan,
3c997079
MD
576 struct lttng_kernel_event *event_param,
577 void *filter,
578 const struct lttng_event_desc *event_desc,
579 enum lttng_kernel_instrumentation itype);
33a39a3c
MD
580struct lttng_event *_lttng_event_create(struct lttng_channel *chan,
581 struct lttng_kernel_event *event_param,
582 void *filter,
583 const struct lttng_event_desc *event_desc,
584 enum lttng_kernel_instrumentation itype);
6dccd6c1
JD
585struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
586 struct lttng_kernel_old_event *old_event_param,
587 void *filter,
588 const struct lttng_event_desc *internal_desc);
c0e31d2e 589
a90917c3
MD
590int lttng_channel_enable(struct lttng_channel *channel);
591int lttng_channel_disable(struct lttng_channel *channel);
592int lttng_event_enable(struct lttng_event *event);
593int lttng_event_disable(struct lttng_event *event);
e64957da 594
a90917c3
MD
595void lttng_transport_register(struct lttng_transport *transport);
596void lttng_transport_unregister(struct lttng_transport *transport);
11b5a3c2 597
360f38ea 598void synchronize_trace(void);
80996790 599int lttng_abi_init(void);
6dccd6c1 600int lttng_abi_compat_old_init(void);
80996790 601void lttng_abi_exit(void);
6dccd6c1 602void lttng_abi_compat_old_exit(void);
1c25284c 603
a90917c3
MD
604int lttng_probe_register(struct lttng_probe_desc *desc);
605void lttng_probe_unregister(struct lttng_probe_desc *desc);
606const struct lttng_event_desc *lttng_event_get(const char *name);
607void lttng_event_put(const struct lttng_event_desc *desc);
608int lttng_probes_init(void);
609void lttng_probes_exit(void);
1ec65de1 610
b3b8072b
MD
611int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
612 struct channel *chan);
d83004aa 613
d1f652f8
MD
614int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
615int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
616void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
617bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
618int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
619int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
e0130fab 620
d1f652f8
MD
621int lttng_session_track_id(struct lttng_session *session,
622 enum tracker_type tracker_type, int id);
623int lttng_session_untrack_id(struct lttng_session *session,
624 enum tracker_type tracker_type, int id);
e0130fab 625
d1f652f8
MD
626int lttng_session_list_tracker_ids(struct lttng_session *session,
627 enum tracker_type tracker_type);
7e6f9ef6 628
2754583e
MD
629void lttng_clock_ref(void);
630void lttng_clock_unref(void);
631
3a523f5b 632#if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
a90917c3
MD
633int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
634int lttng_syscalls_unregister(struct lttng_channel *chan);
80f87dd2
MD
635int lttng_syscall_filter_enable(struct lttng_channel *chan,
636 const char *name);
637int lttng_syscall_filter_disable(struct lttng_channel *chan,
638 const char *name);
12e579db
MD
639long lttng_channel_syscall_mask(struct lttng_channel *channel,
640 struct lttng_kernel_syscall_mask __user *usyscall_mask);
1ec65de1 641#else
a90917c3 642static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
1ec65de1
MD
643{
644 return -ENOSYS;
645}
646
a90917c3 647static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
1ec65de1
MD
648{
649 return 0;
650}
80f87dd2 651
f127e61e 652static inline int lttng_syscall_filter_enable(struct lttng_channel *chan,
80f87dd2
MD
653 const char *name)
654{
655 return -ENOSYS;
656}
657
f127e61e 658static inline int lttng_syscall_filter_disable(struct lttng_channel *chan,
80f87dd2
MD
659 const char *name)
660{
661 return -ENOSYS;
662}
12e579db 663
f127e61e 664static inline long lttng_channel_syscall_mask(struct lttng_channel *channel,
12e579db
MD
665 struct lttng_kernel_syscall_mask __user *usyscall_mask)
666{
667 return -ENOSYS;
668}
1ec65de1
MD
669#endif
670
07dfc1d0
MD
671void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
672int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
673 struct lttng_kernel_filter_bytecode __user *bytecode);
f127e61e
MD
674void lttng_enabler_event_link_bytecode(struct lttng_event *event,
675 struct lttng_enabler *enabler);
07dfc1d0 676
114667d5
MD
677int lttng_probes_init(void);
678
07dfc1d0
MD
679extern struct lttng_ctx *lttng_static_ctx;
680
681int lttng_context_init(void);
682void lttng_context_exit(void);
2dccf128 683struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
a9dd15da 684void lttng_context_update(struct lttng_ctx *ctx);
44252f0f 685int lttng_find_context(struct lttng_ctx *ctx, const char *name);
07dfc1d0 686int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
8289661d
MD
687void lttng_remove_context_field(struct lttng_ctx **ctx,
688 struct lttng_ctx_field *field);
2dccf128 689void lttng_destroy_context(struct lttng_ctx *ctx);
8070f5c0 690int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
b3699d90 691int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
a2563e83 692int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
a8ad3613 693int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
53f1f0ca 694int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
b64bc438
MD
695int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
696int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
697int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
698int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
699int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
975da2c0 700int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
79150a49
JD
701int lttng_add_interruptible_to_ctx(struct lttng_ctx **ctx);
702int lttng_add_need_reschedule_to_ctx(struct lttng_ctx **ctx);
703#if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT)
704int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx);
705#else
706static inline
707int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx)
708{
709 return -ENOSYS;
710}
711#endif
712#ifdef CONFIG_PREEMPT_RT_FULL
713int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx);
714#else
715static inline
716int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx)
717{
718 return -ENOSYS;
719}
720#endif
2fa2d39a
FG
721
722int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type);
723
a6cf40a4
MJ
724#if defined(CONFIG_CGROUPS) && \
725 ((LINUX_VERSION_CODE >= KERNEL_VERSION(4,6,0)) || \
726 LTTNG_UBUNTU_KERNEL_RANGE(4,4,0,0, 4,5,0,0))
727int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
728#else
729static inline
730int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx)
731{
732 return -ENOSYS;
733}
734#endif
735
736#if defined(CONFIG_IPC_NS) && \
737 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
738int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
739#else
740static inline
741int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx)
742{
743 return -ENOSYS;
744}
745#endif
746
747#if !defined(LTTNG_MNT_NS_MISSING_HEADER) && \
748 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
749int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
750#else
751static inline
752int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx)
753{
754 return -ENOSYS;
755}
756#endif
757
758#if defined(CONFIG_NET_NS) && \
759 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
760int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
761#else
762static inline
763int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx)
764{
765 return -ENOSYS;
766}
767#endif
768
769#if defined(CONFIG_PID_NS) && \
770 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
771int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
772#else
773static inline
774int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx)
775{
776 return -ENOSYS;
777}
778#endif
779
780#if defined(CONFIG_USER_NS) && \
781 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
782int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
783#else
784static inline
785int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx)
786{
787 return -ENOSYS;
788}
789#endif
790
791#if defined(CONFIG_UTS_NS) && \
792 (LINUX_VERSION_CODE >= KERNEL_VERSION(3,8,0))
793int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
794#else
795static inline
796int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx)
797{
798 return -ENOSYS;
799}
800#endif
801
dc923e75
MJ
802int lttng_add_uid_to_ctx(struct lttng_ctx **ctx);
803int lttng_add_euid_to_ctx(struct lttng_ctx **ctx);
804int lttng_add_suid_to_ctx(struct lttng_ctx **ctx);
805int lttng_add_gid_to_ctx(struct lttng_ctx **ctx);
806int lttng_add_egid_to_ctx(struct lttng_ctx **ctx);
807int lttng_add_sgid_to_ctx(struct lttng_ctx **ctx);
808int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
809int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
810int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
811int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
812int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
813int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
814
8a3af9ee 815#if defined(CONFIG_PERF_EVENTS)
c24a0d71
MD
816int lttng_add_perf_counter_to_ctx(uint32_t type,
817 uint64_t config,
818 const char *name,
819 struct lttng_ctx **ctx);
1e367326
MD
820int lttng_cpuhp_perf_counter_online(unsigned int cpu,
821 struct lttng_cpuhp_node *node);
822int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
823 struct lttng_cpuhp_node *node);
1d443b34
MD
824#else
825static inline
826int lttng_add_perf_counter_to_ctx(uint32_t type,
827 uint64_t config,
828 const char *name,
829 struct lttng_ctx **ctx)
830{
831 return -ENOSYS;
832}
1e367326
MD
833static inline
834int lttng_cpuhp_perf_counter_online(unsigned int cpu,
835 struct lttng_cpuhp_node *node)
836{
837 return 0;
838}
839static inline
840int lttng_cpuhp_perf_counter_dead(unsigned int cpu,
841 struct lttng_cpuhp_node *node)
842{
843 return 0;
844}
1d443b34 845#endif
02119ee5 846
0c956676
MD
847int lttng_logger_init(void);
848void lttng_logger_exit(void);
849
c337ddc2
MD
850extern int lttng_statedump_start(struct lttng_session *session);
851
acd614cc 852#ifdef CONFIG_KPROBES
f17701fb
MD
853int lttng_kprobes_register(const char *name,
854 const char *symbol_name,
855 uint64_t offset,
856 uint64_t addr,
a90917c3
MD
857 struct lttng_event *event);
858void lttng_kprobes_unregister(struct lttng_event *event);
859void lttng_kprobes_destroy_private(struct lttng_event *event);
acd614cc
MD
860#else
861static inline
862int lttng_kprobes_register(const char *name,
863 const char *symbol_name,
864 uint64_t offset,
865 uint64_t addr,
a90917c3 866 struct lttng_event *event)
acd614cc
MD
867{
868 return -ENOSYS;
869}
870
25f53c39 871static inline
a90917c3 872void lttng_kprobes_unregister(struct lttng_event *event)
acd614cc
MD
873{
874}
edeb3137
MD
875
876static inline
a90917c3 877void lttng_kprobes_destroy_private(struct lttng_event *event)
edeb3137
MD
878{
879}
acd614cc 880#endif
d6d808f3 881
3aed4dca
FD
882int lttng_event_add_callsite(struct lttng_event *event,
883 struct lttng_kernel_event_callsite *callsite);
e33fc900 884
149b9a9d
YB
885#ifdef CONFIG_UPROBES
886int lttng_uprobes_register(const char *name,
3aed4dca
FD
887 int fd, struct lttng_event *event);
888int lttng_uprobes_add_callsite(struct lttng_event *event,
889 struct lttng_kernel_event_callsite *callsite);
149b9a9d
YB
890void lttng_uprobes_unregister(struct lttng_event *event);
891void lttng_uprobes_destroy_private(struct lttng_event *event);
892#else
893static inline
894int lttng_uprobes_register(const char *name,
3aed4dca
FD
895 int fd, struct lttng_event *event)
896{
897 return -ENOSYS;
898}
899
900static inline
901int lttng_uprobes_add_callsite(struct lttng_event *event,
e33fc900 902 struct lttng_kernel_event_callsite *callsite)
149b9a9d
YB
903{
904 return -ENOSYS;
905}
906
907static inline
908void lttng_uprobes_unregister(struct lttng_event *event)
909{
910}
911
912static inline
913void lttng_uprobes_destroy_private(struct lttng_event *event)
914{
915}
916#endif
917
7371f44c
MD
918#ifdef CONFIG_KRETPROBES
919int lttng_kretprobes_register(const char *name,
920 const char *symbol_name,
921 uint64_t offset,
922 uint64_t addr,
a90917c3
MD
923 struct lttng_event *event_entry,
924 struct lttng_event *event_exit);
925void lttng_kretprobes_unregister(struct lttng_event *event);
926void lttng_kretprobes_destroy_private(struct lttng_event *event);
a0493bef
MD
927int lttng_kretprobes_event_enable_state(struct lttng_event *event,
928 int enable);
7371f44c
MD
929#else
930static inline
931int lttng_kretprobes_register(const char *name,
932 const char *symbol_name,
933 uint64_t offset,
934 uint64_t addr,
a90917c3
MD
935 struct lttng_event *event_entry,
936 struct lttng_event *event_exit)
7371f44c
MD
937{
938 return -ENOSYS;
939}
940
941static inline
a90917c3 942void lttng_kretprobes_unregister(struct lttng_event *event)
7371f44c
MD
943{
944}
945
946static inline
a90917c3 947void lttng_kretprobes_destroy_private(struct lttng_event *event)
7371f44c
MD
948{
949}
a0493bef
MD
950
951static inline
952int lttng_kretprobes_event_enable_state(struct lttng_event *event,
953 int enable)
954{
955 return -ENOSYS;
956}
7371f44c
MD
957#endif
958
3db41b2c 959int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
57105fc2 960
271b6681 961extern const struct file_operations lttng_tracepoint_list_fops;
2d2464bd 962extern const struct file_operations lttng_syscall_list_fops;
271b6681 963
ef200626 964#define TRACEPOINT_HAS_DATA_ARG
ef200626 965
ceabb767
MD
966static inline bool lttng_is_bytewise_integer(const struct lttng_type *type)
967{
968 if (type->atype != atype_integer)
969 return false;
970 switch (type->u.integer.size) {
971 case 8: /* Fall-through. */
972 case 16: /* Fall-through. */
973 case 32: /* Fall-through. */
974 case 64:
975 break;
976 default:
977 return false;
978 }
979 return true;
980}
981
a90917c3 982#endif /* _LTTNG_EVENTS_H */
This page took 0.087375 seconds and 4 git commands to generate.