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