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