Remove unused TRACEPOINT_HAS_DATA_ARG
[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
5f4c791e 13#include <lttng/kernel-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>
754d534a 18#include <linux/irq_work.h>
149b9a9d 19#include <wrapper/uprobes.h>
2df37e95
MD
20#include <lttng/cpuhotplug.h>
21#include <lttng/tracer.h>
22#include <lttng/abi.h>
23#include <lttng/abi-old.h>
24#include <lttng/endian.h>
4e3c1b9b 25
e97dc605 26#define lttng_is_signed_type(type) (((type) -1) < (type) 1)
9e7e4892 27
a90917c3
MD
28struct lttng_channel;
29struct lttng_session;
d83004aa 30struct lttng_metadata_cache;
1c25284c 31struct lib_ring_buffer_ctx;
ba1f5986 32struct perf_event;
833ad6a0 33struct perf_event_attr;
3b731ab1 34struct lib_ring_buffer_config;
4e3c1b9b 35
c0edae1d
MD
36/* Type description */
37
12bb2edb
MD
38enum lttng_kernel_type {
39 lttng_kernel_type_integer,
40 lttng_kernel_type_string,
437d5aa5
MD
41 lttng_kernel_type_enum,
42 lttng_kernel_type_array,
43 lttng_kernel_type_sequence,
44 lttng_kernel_type_struct,
45 lttng_kernel_type_variant,
12bb2edb 46 NR_LTTNG_KERNEL_TYPES,
c0edae1d
MD
47};
48
28cbcb59
MD
49enum lttng_kernel_string_encoding {
50 lttng_kernel_string_encoding_none = 0,
51 lttng_kernel_string_encoding_UTF8 = 1,
52 lttng_kernel_string_encoding_ASCII = 2,
53 NR_LTTNG_KERNEL_STRING_ENCODING,
c0edae1d
MD
54};
55
d83004aa
JD
56enum channel_type {
57 PER_CPU_CHANNEL,
58 METADATA_CHANNEL,
59};
60
a28cc520 61struct lttng_kernel_enum_value {
141ddf28
MD
62 unsigned long long value;
63 unsigned int signedness:1;
64};
65
a28cc520
MD
66struct lttng_kernel_enum_entry {
67 struct lttng_kernel_enum_value start, end; /* start and end are inclusive */
c0edae1d 68 const char *string;
08ad1061
PP
69 struct {
70 unsigned int is_auto:1;
71 } options;
c0edae1d
MD
72};
73
437d5aa5
MD
74/*
75 * struct lttng_kernel_type_common is fixed-size. Its children inherits
76 * from it by embedding struct lttng_kernel_type_common as its first field.
77 */
78struct lttng_kernel_type_common {
79 enum lttng_kernel_type type;
80};
81
82struct lttng_kernel_type_integer {
83 struct lttng_kernel_type_common parent;
c099397a
MD
84 unsigned int size; /* in bits */
85 unsigned short alignment; /* in bits */
9cccf98a
MD
86 unsigned int signedness:1,
87 reverse_byte_order:1;
e0a7a7c4 88 unsigned int base; /* 2, 8, 10, 16, for pretty print */
437d5aa5
MD
89};
90
91struct lttng_kernel_type_string {
92 struct lttng_kernel_type_common parent;
28cbcb59 93 enum lttng_kernel_string_encoding encoding;
c099397a
MD
94};
95
437d5aa5
MD
96struct lttng_kernel_type_enum {
97 struct lttng_kernel_type_common parent;
98 const struct lttng_kernel_enum_desc *desc; /* Enumeration mapping */
99 const struct lttng_kernel_type_common *container_type;
100};
101
102struct lttng_kernel_type_array {
103 struct lttng_kernel_type_common parent;
104 const struct lttng_kernel_type_common *elem_type;
105 unsigned int length; /* Num. elems. */
106 unsigned int alignment;
107 enum lttng_kernel_string_encoding encoding;
108};
109
110struct lttng_kernel_type_sequence {
111 struct lttng_kernel_type_common parent;
51ef4536 112 const char *length_name; /* Length field name. If NULL, use previous field. */
437d5aa5
MD
113 const struct lttng_kernel_type_common *elem_type;
114 unsigned int alignment; /* Alignment before elements. */
115 enum lttng_kernel_string_encoding encoding;
116};
117
118struct lttng_kernel_type_struct {
119 struct lttng_kernel_type_common parent;
120 unsigned int nr_fields;
121 const struct lttng_kernel_event_field **fields; /* Array of pointers to fields. */
122 unsigned int alignment;
123};
124
125struct lttng_kernel_type_variant {
126 struct lttng_kernel_type_common parent;
51ef4536 127 const char *tag_name; /* Tag field name. If NULL, use previous field. */
437d5aa5
MD
128 const struct lttng_kernel_event_field **choices; /* Array of pointers to fields. */
129 unsigned int nr_choices;
130 unsigned int alignment;
c099397a
MD
131};
132
d96a4a7a 133struct lttng_kernel_enum_desc {
c099397a 134 const char *name;
437d5aa5 135 const struct lttng_kernel_enum_entry **entries;
141ddf28 136 unsigned int nr_entries;
c099397a 137};
c0edae1d
MD
138
139/* Event field description */
140
437d5aa5 141struct lttng_kernel_event_field {
c0edae1d 142 const char *name;
437d5aa5 143 const struct lttng_kernel_type_common *type;
f127e61e 144 unsigned int nowrite:1, /* do not write into trace */
ceabb767
MD
145 user:1, /* fetch from user-space */
146 nofilter:1; /* do not consider for filter */
c0edae1d
MD
147};
148
437d5aa5
MD
149#define lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, _base) \
150 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_integer, { \
151 .parent = { \
152 .type = lttng_kernel_type_integer, \
153 }, \
154 .size = (_size), \
155 .alignment = (_alignment), \
156 .signedness = (_signedness), \
157 .reverse_byte_order = (_byte_order) != __BYTE_ORDER, \
158 .base = (_base), \
159 }))
160
161#define lttng_kernel_static_type_integer_from_type(_type, _byte_order, _base) \
162 lttng_kernel_static_type_integer(sizeof(_type) * CHAR_BIT, \
163 lttng_alignof(_type) * CHAR_BIT, \
164 lttng_is_signed_type(_type), \
165 _byte_order, \
166 _base)
167
168#define lttng_kernel_static_type_enum(_desc, _container_type) \
169 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_enum, { \
170 .parent = { \
171 .type = lttng_kernel_type_enum, \
172 }, \
173 .desc = (_desc), \
174 .container_type = (_container_type), \
175 }))
176
177#define lttng_kernel_static_type_array(_length, _elem_type, _alignment, _encoding) \
178 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_array, { \
179 .parent = { \
180 .type = lttng_kernel_type_array, \
181 }, \
182 .length = (_length), \
183 .alignment = (_alignment), \
184 .encoding = lttng_kernel_string_encoding_##_encoding, \
185 .elem_type = (_elem_type), \
186 }))
187
188#define lttng_kernel_static_type_array_text(_length) \
189 lttng_kernel_static_type_array(_length, \
190 lttng_kernel_static_type_integer(sizeof(char) * CHAR_BIT, \
191 lttng_alignof(char) * CHAR_BIT, lttng_is_signed_type(char), \
192 __BYTE_ORDER, 10), \
193 0, UTF8)
194
195#define lttng_kernel_static_type_sequence(_length_name, _elem_type, _alignment, _encoding) \
196 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_sequence, { \
197 .parent = { \
198 .type = lttng_kernel_type_sequence, \
199 }, \
200 .length_name = (_length_name), \
201 .alignment = (_alignment), \
202 .encoding = lttng_kernel_string_encoding_##_encoding, \
203 .elem_type = (_elem_type), \
204 }))
205
206#define lttng_kernel_static_type_string(_encoding) \
207 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_string, { \
208 .parent = { \
209 .type = lttng_kernel_type_string, \
210 }, \
211 .encoding = lttng_kernel_string_encoding_##_encoding, \
212 }))
213
214#define lttng_kernel_static_type_struct(_nr_fields, _fields, _alignment) \
215 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_struct, { \
216 .parent = { \
217 .type = lttng_kernel_type_struct, \
218 }, \
219 .nr_fields = (_nr_fields), \
220 .fields = _fields, \
221 .alignment = (_alignment), \
222 }))
223
224#define lttng_kernel_static_type_variant(_nr_choices, _choices, _tag_name, _alignment) \
225 ((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_variant, { \
226 .parent = { \
227 .type = lttng_kernel_type_variant, \
228 }, \
229 .tag_name = (_tag_name), \
230 .choices = _choices, \
231 .nr_choices = (_nr_choices), \
232 .alignment = (_alignment), \
233 }))
234
235#define lttng_kernel_static_event_field(_name, _type, _nowrite, _user, _nofilter) \
236 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field, { \
237 .name = (_name), \
238 .type = (_type), \
239 .nowrite = (_nowrite), \
240 .user = (_user), \
241 .nofilter = (_nofilter), \
242 })
243
244#define lttng_kernel_static_event_field_array(_fields...) \
245 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field *, \
246 _fields \
247 )
248
437d5aa5
MD
249#define lttng_kernel_static_enum_entry_value(_string, _value) \
250 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
251 .start = { \
252 .signedness = lttng_is_signed_type(__typeof__(_value)), \
253 .value = lttng_is_signed_type(__typeof__(_value)) ? \
254 (long long) (_value) : (_value), \
255 }, \
256 .end = { \
257 .signedness = lttng_is_signed_type(__typeof__(_value)), \
258 .value = lttng_is_signed_type(__typeof__(_value)) ? \
259 (long long) (_value) : (_value), \
260 }, \
261 .string = (_string), \
262 }),
263
264#define lttng_kernel_static_enum_entry_range(_string, _range_start, _range_end) \
265 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
266 .start = { \
267 .signedness = lttng_is_signed_type(__typeof__(_range_start)), \
268 .value = lttng_is_signed_type(__typeof__(_range_start)) ? \
269 (long long) (_range_start) : (_range_start), \
270 }, \
271 .end = { \
272 .signedness = lttng_is_signed_type(__typeof__(_range_end)), \
273 .value = lttng_is_signed_type(__typeof__(_range_end)) ? \
274 (long long) (_range_end) : (_range_end), \
275 }, \
276 .string = (_string), \
277 }),
278
279#define lttng_kernel_static_enum_entry_auto(_string) \
280 __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
281 .start = { \
282 .signedness = -1, \
283 .value = -1, \
284 }, \
285 .end = { \
286 .signedness = -1, \
287 .value = -1, \
288 }, \
289 .string = (_string), \
290 .options = { \
291 .is_auto = 1, \
292 } \
293 }),
294
a92e844e 295struct lttng_kernel_probe_ctx {
e2d5dbc7 296 struct lttng_kernel_event_common *event;
79150a49
JD
297 uint8_t interruptible;
298};
299
437d5aa5
MD
300struct lttng_kernel_event_desc {
301 const char *event_name; /* lttng-modules name */
302 const char *event_kname; /* Linux kernel name (tracepoints) */
303 const struct lttng_kernel_probe_desc *probe_desc;
304 void (*probe_callback)(void);
305 const struct lttng_kernel_event_field **fields; /* event payload */
c0edae1d 306 unsigned int nr_fields;
dc7f600a 307 struct module *owner;
c0edae1d
MD
308};
309
437d5aa5
MD
310struct lttng_kernel_probe_desc {
311 const char *provider_name;
312 const struct lttng_kernel_event_desc **event_desc;
85a9ca7f
MD
313 unsigned int nr_events;
314 struct list_head head; /* chain registered probes */
3c997079
MD
315 struct list_head lazy_init_head;
316 int lazy; /* lazy registration */
85a9ca7f
MD
317};
318
7371f44c
MD
319struct lttng_krp; /* Kretprobe handling */
320
3aed4dca 321struct lttng_uprobe_handler {
e2d5dbc7 322 struct lttng_kernel_event_common *event;
3aed4dca
FD
323 loff_t offset;
324 struct uprobe_consumer up_consumer;
325 struct list_head node;
326};
327
8bf17deb
FD
328struct lttng_kprobe {
329 struct kprobe kp;
330 char *symbol_name;
331};
332
83b802dc
FD
333struct lttng_uprobe {
334 struct inode *inode;
335 struct list_head head;
336};
337
badfe9f5
MD
338enum lttng_syscall_entryexit {
339 LTTNG_SYSCALL_ENTRY,
340 LTTNG_SYSCALL_EXIT,
341};
342
343enum lttng_syscall_abi {
344 LTTNG_SYSCALL_ABI_NATIVE,
345 LTTNG_SYSCALL_ABI_COMPAT,
346};
347
8a445457
MD
348/*
349 * Result of the run_filter() callback.
350 */
351enum lttng_kernel_event_filter_result {
352 LTTNG_KERNEL_EVENT_FILTER_ACCEPT = 0,
353 LTTNG_KERNEL_EVENT_FILTER_REJECT = 1,
354};
355
a67ba386
MD
356struct lttng_kernel_event_common_private;
357
358enum lttng_kernel_event_type {
359 LTTNG_KERNEL_EVENT_TYPE_RECORDER = 0,
360 LTTNG_KERNEL_EVENT_TYPE_NOTIFIER = 1,
361};
362
363struct lttng_kernel_event_common {
364 struct lttng_kernel_event_common_private *priv; /* Private event interface */
365
366 enum lttng_kernel_event_type type;
367 /* Get child with container_of(). */
368
e64957da 369 int enabled;
a67ba386 370 int eval_filter; /* Need to evaluate filters */
8a445457 371 int (*run_filter)(const struct lttng_kernel_event_common *event,
a67ba386 372 const char *stack_data,
a92e844e 373 struct lttng_kernel_probe_ctx *probe_ctx,
a67ba386 374 void *filter_ctx);
3c997079
MD
375};
376
a67ba386
MD
377struct lttng_kernel_event_recorder_private;
378
379struct lttng_kernel_event_recorder {
380 struct lttng_kernel_event_common parent;
381 struct lttng_kernel_event_recorder_private *priv; /* Private event record interface */
382
383 struct lttng_channel *chan;
c3eddb2e
MD
384};
385
a67ba386
MD
386struct lttng_kernel_notification_ctx {
387 int eval_capture; /* Capture evaluation available. */
388};
dffef45d 389
a67ba386 390struct lttng_kernel_event_notifier_private;
8a8ac9a8 391
a67ba386
MD
392struct lttng_kernel_event_notifier {
393 struct lttng_kernel_event_common parent;
394 struct lttng_kernel_event_notifier_private *priv; /* Private event notifier interface */
dffef45d 395
a67ba386
MD
396 int eval_capture; /* Need to evaluate capture */
397 void (*notification_send)(struct lttng_kernel_event_notifier *event_notifier,
a67ba386 398 const char *stack_data,
a92e844e 399 struct lttng_kernel_probe_ctx *probe_ctx,
a67ba386 400 struct lttng_kernel_notification_ctx *notif_ctx);
dffef45d
FD
401};
402
a90917c3 403struct lttng_channel_ops {
85a9ca7f 404 struct channel *(*channel_create)(const char *name,
5cf4b87c 405 void *priv,
85a9ca7f
MD
406 void *buf_addr,
407 size_t subbuf_size, size_t num_subbuf,
408 unsigned int switch_timer_interval,
409 unsigned int read_timer_interval);
410 void (*channel_destroy)(struct channel *chan);
411 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
f71ecafa 412 int (*buffer_has_read_closed_stream)(struct channel *chan);
85a9ca7f 413 void (*buffer_read_close)(struct lib_ring_buffer *buf);
c2fb9c1c 414 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx);
85a9ca7f
MD
415 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
416 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
417 size_t len);
4ea00e4f
JD
418 void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
419 const void *src, size_t len);
58aa5d24
MD
420 void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
421 int c, size_t len);
16f78f3a
MD
422 void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
423 size_t len);
424 void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
425 const char __user *src, size_t len);
1ec3f75a
MD
426 /*
427 * packet_avail_size returns the available size in the current
428 * packet. Note that the size returned is only a hint, since it
429 * may change due to concurrent writes.
430 */
431 size_t (*packet_avail_size)(struct channel *chan);
71c1d843 432 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
24cedcfe
MD
433 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
434 int (*is_finalized)(struct channel *chan);
254ec7bc 435 int (*is_disabled)(struct channel *chan);
3b731ab1
JD
436 int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
437 struct lib_ring_buffer *bufb,
438 uint64_t *timestamp_begin);
439 int (*timestamp_end) (const struct lib_ring_buffer_config *config,
440 struct lib_ring_buffer *bufb,
441 uint64_t *timestamp_end);
442 int (*events_discarded) (const struct lib_ring_buffer_config *config,
443 struct lib_ring_buffer *bufb,
444 uint64_t *events_discarded);
445 int (*content_size) (const struct lib_ring_buffer_config *config,
446 struct lib_ring_buffer *bufb,
447 uint64_t *content_size);
448 int (*packet_size) (const struct lib_ring_buffer_config *config,
449 struct lib_ring_buffer *bufb,
450 uint64_t *packet_size);
451 int (*stream_id) (const struct lib_ring_buffer_config *config,
452 struct lib_ring_buffer *bufb,
453 uint64_t *stream_id);
2348ca17
JD
454 int (*current_timestamp) (const struct lib_ring_buffer_config *config,
455 struct lib_ring_buffer *bufb,
456 uint64_t *ts);
5b3cf4f9
JD
457 int (*sequence_number) (const struct lib_ring_buffer_config *config,
458 struct lib_ring_buffer *bufb,
459 uint64_t *seq);
5594698f
JD
460 int (*instance_id) (const struct lib_ring_buffer_config *config,
461 struct lib_ring_buffer *bufb,
462 uint64_t *id);
85a9ca7f
MD
463};
464
a101fa10
MD
465struct lttng_counter_ops {
466 struct lib_counter *(*counter_create)(size_t nr_dimensions,
467 const size_t *max_nr_elem, /* for each dimension */
468 int64_t global_sum_step);
469 void (*counter_destroy)(struct lib_counter *counter);
470 int (*counter_add)(struct lib_counter *counter, const size_t *dimension_indexes,
471 int64_t v);
472 /*
473 * counter_read reads a specific cpu's counter if @cpu >= 0, or
474 * the global aggregation counter if @cpu == -1.
475 */
476 int (*counter_read)(struct lib_counter *counter, const size_t *dimension_indexes, int cpu,
477 int64_t *value, bool *overflow, bool *underflow);
478 /*
479 * counter_aggregate returns the total sum of all per-cpu counters and
480 * the global aggregation counter.
481 */
482 int (*counter_aggregate)(struct lib_counter *counter, const size_t *dimension_indexes,
483 int64_t *value, bool *overflow, bool *underflow);
484 int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes);
485};
486
a90917c3 487struct lttng_transport {
a33c9927
MD
488 char *name;
489 struct module *owner;
490 struct list_head node;
a90917c3 491 struct lttng_channel_ops ops;
a33c9927
MD
492};
493
a101fa10
MD
494struct lttng_counter_transport {
495 char *name;
496 struct module *owner;
497 struct list_head node;
498 struct lttng_counter_ops ops;
499};
500
80f87dd2
MD
501struct lttng_syscall_filter;
502
3c997079
MD
503#define LTTNG_EVENT_HT_BITS 12
504#define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
505
506struct lttng_event_ht {
507 struct hlist_head table[LTTNG_EVENT_HT_SIZE];
508};
509
dffef45d
FD
510#define LTTNG_EVENT_NOTIFIER_HT_BITS 12
511#define LTTNG_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_EVENT_NOTIFIER_HT_BITS)
512
513struct lttng_event_notifier_ht {
514 struct hlist_head table[LTTNG_EVENT_NOTIFIER_HT_SIZE];
515};
516
a90917c3 517struct lttng_channel {
c099397a 518 unsigned int id;
85a9ca7f 519 struct channel *chan; /* Channel buffers */
e64957da 520 int enabled;
437d5aa5 521 struct lttng_kernel_ctx *ctx;
85a9ca7f 522 /* Event ID management */
a90917c3 523 struct lttng_session *session;
85a9ca7f
MD
524 struct file *file; /* File associated to channel */
525 unsigned int free_event_id; /* Next event ID to allocate */
526 struct list_head list; /* Channel list */
a90917c3
MD
527 struct lttng_channel_ops *ops;
528 struct lttng_transport *transport;
3b82c4e1
MD
529 struct hlist_head *sc_table; /* for syscall tracing */
530 struct hlist_head *compat_sc_table;
531 struct hlist_head *sc_exit_table; /* for syscall exit tracing */
532 struct hlist_head *compat_sc_exit_table;
533 struct hlist_head sc_unknown; /* for unknown syscalls */
534 struct hlist_head sc_compat_unknown;
535 struct hlist_head sc_exit_unknown;
536 struct hlist_head compat_sc_exit_unknown;
80f87dd2 537 struct lttng_syscall_filter *sc_filter;
9115fbdc 538 int header_type; /* 0: unset, 1: compact, 2: large */
d83004aa 539 enum channel_type channel_type;
3b82c4e1
MD
540 int syscall_all_entry;
541 int syscall_all_exit;
80f87dd2
MD
542 unsigned int metadata_dumped:1,
543 sys_enter_registered:1,
544 sys_exit_registered:1,
3c997079 545 tstate:1; /* Transient enable state */
85a9ca7f
MD
546};
547
d83004aa
JD
548struct lttng_metadata_stream {
549 void *priv; /* Ring buffer private data */
550 struct lttng_metadata_cache *metadata_cache;
f613e3e6
MD
551 unsigned int metadata_in; /* Bytes read from the cache */
552 unsigned int metadata_out; /* Bytes consumed from stream */
d83004aa
JD
553 int finalized; /* Has channel been finalized */
554 wait_queue_head_t read_wait; /* Reader buffer-level wait queue */
555 struct list_head list; /* Stream list */
b3b8072b 556 struct lttng_transport *transport;
9616f0bf 557 uint64_t version; /* Current version of the metadata cache */
8b97fd42 558 bool coherent; /* Stream in a coherent state */
d83004aa
JD
559};
560
114667d5
MD
561#define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
562
563struct lttng_dynamic_len_stack {
564 size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
565 size_t offset;
566};
567
568DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
e0130fab
MD
569
570/*
d1f652f8 571 * struct lttng_id_tracker declared in header due to deferencing of *v
e0130fab
MD
572 * in RCU_INITIALIZER(v).
573 */
d1f652f8
MD
574#define LTTNG_ID_HASH_BITS 6
575#define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
e0130fab 576
d1f652f8
MD
577enum tracker_type {
578 TRACKER_PID,
579 TRACKER_VPID,
580 TRACKER_UID,
581 TRACKER_VUID,
582 TRACKER_GID,
583 TRACKER_VGID,
584
585 TRACKER_UNKNOWN,
586};
587
588struct lttng_id_tracker_rcu {
589 struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
590};
591
592struct lttng_id_tracker {
593 struct lttng_session *session;
594 enum tracker_type tracker_type;
595 struct lttng_id_tracker_rcu *p; /* RCU dereferenced. */
e0130fab
MD
596};
597
d1f652f8 598struct lttng_id_hash_node {
7e6f9ef6 599 struct hlist_node hlist;
d1f652f8 600 int id;
7e6f9ef6
MD
601};
602
a90917c3 603struct lttng_session {
85a9ca7f 604 int active; /* Is trace session active ? */
8070f5c0 605 int been_active; /* Has trace session been active ? */
85a9ca7f
MD
606 struct file *file; /* File associated to session */
607 struct list_head chan; /* Channel list head */
608 struct list_head events; /* Event list head */
609 struct list_head list; /* Session list */
c099397a 610 unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1 611 uuid_le uuid; /* Trace session unique ID */
d83004aa 612 struct lttng_metadata_cache *metadata_cache;
d1f652f8
MD
613 struct lttng_id_tracker pid_tracker;
614 struct lttng_id_tracker vpid_tracker;
615 struct lttng_id_tracker uid_tracker;
616 struct lttng_id_tracker vuid_tracker;
617 struct lttng_id_tracker gid_tracker;
618 struct lttng_id_tracker vgid_tracker;
3c997079
MD
619 unsigned int metadata_dumped:1,
620 tstate:1; /* Transient enable state */
b2bc0bc8 621 /* List of event enablers */
3c997079
MD
622 struct list_head enablers_head;
623 /* Hash table of events */
624 struct lttng_event_ht events_ht;
606828e4
MD
625 char name[LTTNG_KERNEL_ABI_SESSION_NAME_LEN];
626 char creation_time[LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN];
85a9ca7f
MD
627};
628
99f52fcc
FD
629struct lttng_counter {
630 struct file *file; /* File associated to counter. */
631 struct file *owner;
632 struct lttng_counter_transport *transport;
633 struct lib_counter *counter;
634 struct lttng_counter_ops *ops;
635};
636
750b05f2
FD
637struct lttng_event_notifier_group {
638 struct file *file; /* File associated to event notifier group */
21f58fb7 639 struct file *notif_file; /* File used to expose notifications to userspace. */
750b05f2 640 struct list_head node; /* event notifier group list */
dffef45d
FD
641 struct list_head enablers_head; /* List of enablers */
642 struct list_head event_notifiers_head; /* List of event notifier */
643 struct lttng_event_notifier_ht event_notifiers_ht; /* Hash table of event notifiers */
750b05f2
FD
644 struct lttng_channel_ops *ops;
645 struct lttng_transport *transport;
646 struct channel *chan; /* Ring buffer channel for event notifier group. */
647 struct lib_ring_buffer *buf; /* Ring buffer for event notifier group. */
21f58fb7
FD
648 wait_queue_head_t read_wait;
649 struct irq_work wakeup_pending; /* Pending wakeup irq work. */
a67ba386
MD
650 struct lttng_kernel_event_notifier *sc_unknown; /* for unknown syscalls */
651 struct lttng_kernel_event_notifier *sc_compat_unknown;
8a8ac9a8
FD
652
653 struct lttng_syscall_filter *sc_filter;
654
655 struct hlist_head *event_notifier_syscall_dispatch;
656 struct hlist_head *event_notifier_compat_syscall_dispatch;
657 struct hlist_head *event_notifier_exit_syscall_dispatch;
658 struct hlist_head *event_notifier_exit_compat_syscall_dispatch;
659
660 struct hlist_head event_notifier_unknown_syscall_dispatch;
661 struct hlist_head event_notifier_compat_unknown_syscall_dispatch;
662 struct hlist_head event_notifier_exit_unknown_syscall_dispatch;
663 struct hlist_head event_notifier_exit_compat_unknown_syscall_dispatch;
664
665 int syscall_all_entry;
666 int syscall_all_exit;
667
668 unsigned int sys_enter_registered:1, sys_exit_registered:1;
669
670 struct lttng_counter *error_counter;
671 size_t error_counter_len;
750b05f2
FD
672};
673
d83004aa
JD
674struct lttng_metadata_cache {
675 char *data; /* Metadata cache */
676 unsigned int cache_alloc; /* Metadata allocated size (bytes) */
677 unsigned int metadata_written; /* Number of bytes written in metadata cache */
3e75e2a7 678 atomic_t producing; /* Metadata being produced (incomplete) */
d83004aa
JD
679 struct kref refcount; /* Metadata cache usage */
680 struct list_head metadata_stream; /* Metadata stream list */
a36580d5 681 uuid_le uuid; /* Trace session unique ID (copy) */
9616f0bf
JD
682 struct mutex lock; /* Produce/consume lock */
683 uint64_t version; /* Current version of the metadata */
d83004aa
JD
684};
685
3c997079
MD
686void lttng_lock_sessions(void);
687void lttng_unlock_sessions(void);
688
689struct list_head *lttng_get_probe_list_head(void);
690
3c997079 691int lttng_fix_pending_events(void);
b01155ba 692int lttng_fix_pending_event_notifiers(void);
3c997079 693int lttng_session_active(void);
b01155ba 694bool lttng_event_notifier_active(void);
3c997079 695
a90917c3
MD
696struct lttng_session *lttng_session_create(void);
697int lttng_session_enable(struct lttng_session *session);
698int lttng_session_disable(struct lttng_session *session);
699void lttng_session_destroy(struct lttng_session *session);
9616f0bf 700int lttng_session_metadata_regenerate(struct lttng_session *session);
601252cf 701int lttng_session_statedump(struct lttng_session *session);
d83004aa 702void metadata_cache_destroy(struct kref *kref);
4e3c1b9b 703
99f52fcc
FD
704struct lttng_counter *lttng_kernel_counter_create(
705 const char *counter_transport_name, size_t number_dimensions,
706 const size_t *dimensions_sizes);
707int lttng_kernel_counter_read(struct lttng_counter *counter,
708 const size_t *dimension_indexes, int32_t cpu,
709 int64_t *val, bool *overflow, bool *underflow);
710int lttng_kernel_counter_aggregate(struct lttng_counter *counter,
711 const size_t *dimension_indexes, int64_t *val,
712 bool *overflow, bool *underflow);
713int lttng_kernel_counter_clear(struct lttng_counter *counter,
714 const size_t *dimension_indexes);
715
716
750b05f2 717struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
99f52fcc
FD
718int lttng_event_notifier_group_create_error_counter(
719 struct file *event_notifier_group_file,
606828e4 720 const struct lttng_kernel_abi_counter_conf *error_counter_conf);
750b05f2
FD
721void lttng_event_notifier_group_destroy(
722 struct lttng_event_notifier_group *event_notifier_group);
723
a90917c3 724struct lttng_channel *lttng_channel_create(struct lttng_session *session,
5dbbdb43
MD
725 const char *transport_name,
726 void *buf_addr,
727 size_t subbuf_size, size_t num_subbuf,
728 unsigned int switch_timer_interval,
d83004aa
JD
729 unsigned int read_timer_interval,
730 enum channel_type channel_type);
a90917c3 731struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
4e3c1b9b
MD
732 int overwrite, void *buf_addr,
733 size_t subbuf_size, size_t num_subbuf,
734 unsigned int switch_timer_interval,
735 unsigned int read_timer_interval);
4e3c1b9b 736
d83004aa 737void lttng_metadata_channel_destroy(struct lttng_channel *chan);
a67ba386 738struct lttng_kernel_event_recorder *lttng_kernel_event_recorder_create(struct lttng_channel *chan,
606828e4 739 struct lttng_kernel_abi_event *event_param,
437d5aa5 740 const struct lttng_kernel_event_desc *event_desc,
606828e4 741 enum lttng_kernel_abi_instrumentation itype);
a67ba386 742struct lttng_kernel_event_recorder *_lttng_kernel_event_recorder_create(struct lttng_channel *chan,
606828e4 743 struct lttng_kernel_abi_event *event_param,
437d5aa5 744 const struct lttng_kernel_event_desc *event_desc,
606828e4 745 enum lttng_kernel_abi_instrumentation itype);
a67ba386 746struct lttng_kernel_event_recorder *lttng_event_compat_old_create(struct lttng_channel *chan,
606828e4 747 struct lttng_kernel_abi_old_event *old_event_param,
437d5aa5 748 const struct lttng_kernel_event_desc *internal_desc);
c0e31d2e 749
a67ba386 750struct lttng_kernel_event_notifier *lttng_event_notifier_create(
437d5aa5 751 const struct lttng_kernel_event_desc *event_notifier_desc,
dffef45d 752 uint64_t id,
99f52fcc 753 uint64_t error_counter_idx,
dffef45d 754 struct lttng_event_notifier_group *event_notifier_group,
606828e4 755 struct lttng_kernel_abi_event_notifier *event_notifier_param,
606828e4 756 enum lttng_kernel_abi_instrumentation itype);
a67ba386 757struct lttng_kernel_event_notifier *_lttng_event_notifier_create(
437d5aa5 758 const struct lttng_kernel_event_desc *event_notifier_desc,
dffef45d 759 uint64_t id,
99f52fcc 760 uint64_t error_counter_idx,
dffef45d 761 struct lttng_event_notifier_group *event_notifier_group,
606828e4 762 struct lttng_kernel_abi_event_notifier *event_notifier_param,
606828e4 763 enum lttng_kernel_abi_instrumentation itype);
dffef45d 764
a90917c3
MD
765int lttng_channel_enable(struct lttng_channel *channel);
766int lttng_channel_disable(struct lttng_channel *channel);
9d993668
MD
767int lttng_event_enable(struct lttng_kernel_event_common *event);
768int lttng_event_disable(struct lttng_kernel_event_common *event);
2b16f0c9 769
a90917c3
MD
770void lttng_transport_register(struct lttng_transport *transport);
771void lttng_transport_unregister(struct lttng_transport *transport);
11b5a3c2 772
a101fa10
MD
773void lttng_counter_transport_register(struct lttng_counter_transport *transport);
774void lttng_counter_transport_unregister(struct lttng_counter_transport *transport);
775
360f38ea 776void synchronize_trace(void);
80996790 777int lttng_abi_init(void);
6dccd6c1 778int lttng_abi_compat_old_init(void);
80996790 779void lttng_abi_exit(void);
6dccd6c1 780void lttng_abi_compat_old_exit(void);
1c25284c 781
437d5aa5
MD
782int lttng_probe_register(struct lttng_kernel_probe_desc *desc);
783void lttng_probe_unregister(struct lttng_kernel_probe_desc *desc);
784const struct lttng_kernel_event_desc *lttng_event_desc_get(const char *name);
785void lttng_event_desc_put(const struct lttng_kernel_event_desc *desc);
a90917c3
MD
786int lttng_probes_init(void);
787void lttng_probes_exit(void);
1ec65de1 788
b3b8072b 789int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
8b97fd42 790 struct channel *chan, bool *coherent);
d83004aa 791
d1f652f8
MD
792int lttng_id_tracker_get_node_id(const struct lttng_id_hash_node *node);
793int lttng_id_tracker_empty_set(struct lttng_id_tracker *lf);
794void lttng_id_tracker_destroy(struct lttng_id_tracker *lf, bool rcu);
795bool lttng_id_tracker_lookup(struct lttng_id_tracker_rcu *p, int id);
796int lttng_id_tracker_add(struct lttng_id_tracker *lf, int id);
797int lttng_id_tracker_del(struct lttng_id_tracker *lf, int id);
e0130fab 798
d1f652f8
MD
799int lttng_session_track_id(struct lttng_session *session,
800 enum tracker_type tracker_type, int id);
801int lttng_session_untrack_id(struct lttng_session *session,
802 enum tracker_type tracker_type, int id);
e0130fab 803
d1f652f8
MD
804int lttng_session_list_tracker_ids(struct lttng_session *session,
805 enum tracker_type tracker_type);
7e6f9ef6 806
2754583e
MD
807void lttng_clock_ref(void);
808void lttng_clock_unref(void);
809
0648898e 810void lttng_free_event_filter_runtime(struct lttng_kernel_event_common *event);
07dfc1d0 811
114667d5
MD
812int lttng_probes_init(void);
813
0c956676
MD
814int lttng_logger_init(void);
815void lttng_logger_exit(void);
816
c337ddc2
MD
817extern int lttng_statedump_start(struct lttng_session *session);
818
acd614cc 819#ifdef CONFIG_KPROBES
8bf17deb 820int lttng_kprobes_register_event(const char *name,
f17701fb
MD
821 const char *symbol_name,
822 uint64_t offset,
823 uint64_t addr,
a67ba386
MD
824 struct lttng_kernel_event_recorder *event);
825void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder *event);
826void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder *event);
2b16f0c9
FD
827int lttng_kprobes_register_event_notifier(const char *symbol_name,
828 uint64_t offset,
829 uint64_t addr,
a67ba386
MD
830 struct lttng_kernel_event_notifier *event_notifier);
831void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
832void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier);
acd614cc
MD
833#else
834static inline
8bf17deb 835int lttng_kprobes_register_event(const char *name,
acd614cc
MD
836 const char *symbol_name,
837 uint64_t offset,
838 uint64_t addr,
a67ba386 839 struct lttng_kernel_event_recorder *event)
acd614cc
MD
840{
841 return -ENOSYS;
842}
843
25f53c39 844static inline
a67ba386 845void lttng_kprobes_unregister_event(struct lttng_kernel_event_recorder *event)
8bf17deb
FD
846{
847}
848
849static inline
a67ba386 850void lttng_kprobes_destroy_event_private(struct lttng_kernel_event_recorder *event)
acd614cc
MD
851{
852}
edeb3137
MD
853
854static inline
2b16f0c9
FD
855int lttng_kprobes_register_event_notifier(const char *symbol_name,
856 uint64_t offset,
857 uint64_t addr,
a67ba386 858 struct lttng_kernel_event_notifier *event_notifier)
2b16f0c9
FD
859{
860 return -ENOSYS;
861}
862
863static inline
a67ba386 864void lttng_kprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier)
2b16f0c9
FD
865{
866}
867
868static inline
a67ba386 869void lttng_kprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier)
edeb3137
MD
870{
871}
acd614cc 872#endif
d6d808f3 873
e2d5dbc7 874int lttng_event_add_callsite(struct lttng_kernel_event_common *event,
606828e4 875 struct lttng_kernel_abi_event_callsite __user *callsite);
9de67196 876
149b9a9d 877#ifdef CONFIG_UPROBES
83b802dc 878int lttng_uprobes_register_event(const char *name,
a67ba386 879 int fd, struct lttng_kernel_event_recorder *event);
e2d5dbc7 880int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
606828e4 881 struct lttng_kernel_abi_event_callsite __user *callsite);
a67ba386
MD
882void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder *event);
883void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder *event);
9de67196 884int lttng_uprobes_register_event_notifier(const char *name,
a67ba386 885 int fd, struct lttng_kernel_event_notifier *event_notifier);
a67ba386
MD
886void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier);
887void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier);
149b9a9d
YB
888#else
889static inline
83b802dc 890int lttng_uprobes_register_event(const char *name,
a67ba386 891 int fd, struct lttng_kernel_event_recorder *event)
3aed4dca
FD
892{
893 return -ENOSYS;
894}
895
896static inline
e2d5dbc7 897int lttng_uprobes_event_add_callsite(struct lttng_kernel_event_common *event,
606828e4 898 struct lttng_kernel_abi_event_callsite __user *callsite)
149b9a9d
YB
899{
900 return -ENOSYS;
901}
902
903static inline
a67ba386 904void lttng_uprobes_unregister_event(struct lttng_kernel_event_recorder *event)
149b9a9d
YB
905{
906}
907
908static inline
a67ba386 909void lttng_uprobes_destroy_event_private(struct lttng_kernel_event_recorder *event)
149b9a9d
YB
910{
911}
9de67196
FD
912
913static inline
914int lttng_uprobes_register_event_notifier(const char *name,
a67ba386 915 int fd, struct lttng_kernel_event_notifier *event_notifier)
9de67196
FD
916{
917 return -ENOSYS;
918}
919
9de67196 920static inline
a67ba386 921void lttng_uprobes_unregister_event_notifier(struct lttng_kernel_event_notifier *event_notifier)
9de67196
FD
922{
923}
924
925static inline
a67ba386 926void lttng_uprobes_destroy_event_notifier_private(struct lttng_kernel_event_notifier *event_notifier)
9de67196
FD
927{
928}
149b9a9d
YB
929#endif
930
7371f44c
MD
931#ifdef CONFIG_KRETPROBES
932int lttng_kretprobes_register(const char *name,
933 const char *symbol_name,
934 uint64_t offset,
935 uint64_t addr,
a67ba386
MD
936 struct lttng_kernel_event_recorder *event_entry,
937 struct lttng_kernel_event_recorder *event_exit);
938void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder *event);
939void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder *event);
e2d5dbc7 940int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common *event,
a0493bef 941 int enable);
7371f44c
MD
942#else
943static inline
944int lttng_kretprobes_register(const char *name,
945 const char *symbol_name,
946 uint64_t offset,
947 uint64_t addr,
a67ba386
MD
948 struct lttng_kernel_event_recorder *event_entry,
949 struct lttng_kernel_event_recorder *event_exit)
7371f44c
MD
950{
951 return -ENOSYS;
952}
953
954static inline
a67ba386 955void lttng_kretprobes_unregister(struct lttng_kernel_event_recorder *event)
7371f44c
MD
956{
957}
958
959static inline
a67ba386 960void lttng_kretprobes_destroy_private(struct lttng_kernel_event_recorder *event)
7371f44c
MD
961{
962}
a0493bef
MD
963
964static inline
e2d5dbc7 965int lttng_kretprobes_event_enable_state(struct lttng_kernel_event_common *event,
a0493bef
MD
966 int enable)
967{
968 return -ENOSYS;
969}
7371f44c
MD
970#endif
971
606828e4 972int lttng_calibrate(struct lttng_kernel_abi_calibrate *calibrate);
57105fc2 973
271b6681 974extern const struct file_operations lttng_tracepoint_list_fops;
2d2464bd 975extern const struct file_operations lttng_syscall_list_fops;
271b6681 976
a90917c3 977#endif /* _LTTNG_EVENTS_H */
This page took 0.108089 seconds and 4 git commands to generate.