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> |
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 |
26 | struct lttng_channel; |
27 | struct lttng_session; | |
d83004aa | 28 | struct lttng_metadata_cache; |
1c25284c | 29 | struct lib_ring_buffer_ctx; |
ba1f5986 | 30 | struct perf_event; |
833ad6a0 | 31 | struct perf_event_attr; |
3b731ab1 | 32 | struct lib_ring_buffer_config; |
4e3c1b9b | 33 | |
c0edae1d MD |
34 | /* Type description */ |
35 | ||
c0edae1d MD |
36 | enum 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 | 51 | enum 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 |
58 | enum channel_type { |
59 | PER_CPU_CHANNEL, | |
60 | METADATA_CHANNEL, | |
61 | }; | |
62 | ||
141ddf28 MD |
63 | struct lttng_enum_value { |
64 | unsigned long long value; | |
65 | unsigned int signedness:1; | |
66 | }; | |
67 | ||
c0edae1d | 68 | struct 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 | ||
91 | struct 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 | ||
100 | union _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 | ||
111 | struct lttng_basic_type { | |
112 | enum abstract_types atype; | |
113 | union { | |
114 | union _lttng_basic_type basic; | |
115 | } u; | |
c0edae1d MD |
116 | }; |
117 | ||
118 | struct 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 | 152 | struct 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 | ||
160 | struct 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 |
167 | union 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 | */ | |
177 | struct 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 |
189 | struct lttng_probe_ctx { |
190 | struct lttng_event *event; | |
191 | uint8_t interruptible; | |
192 | }; | |
193 | ||
ba1f5986 | 194 | struct 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 | ||
218 | struct 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 | ||
225 | struct 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 | 235 | struct 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 |
244 | struct lttng_krp; /* Kretprobe handling */ |
245 | ||
3c997079 MD |
246 | enum lttng_event_type { |
247 | LTTNG_TYPE_EVENT = 0, | |
248 | LTTNG_TYPE_ENABLER = 1, | |
249 | }; | |
250 | ||
07dfc1d0 MD |
251 | struct 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 | */ | |
264 | enum 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 | ||
270 | struct 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 | */ | |
283 | struct lttng_enabler_ref { | |
284 | struct list_head node; /* enabler ref list */ | |
285 | struct lttng_enabler *ref; /* backward ref */ | |
286 | }; | |
287 | ||
3aed4dca FD |
288 | struct 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 | ||
e298d6af MD |
295 | enum lttng_syscall_entryexit { |
296 | LTTNG_SYSCALL_ENTRY, | |
297 | LTTNG_SYSCALL_EXIT, | |
298 | }; | |
299 | ||
300 | enum lttng_syscall_abi { | |
301 | LTTNG_SYSCALL_ABI_NATIVE, | |
302 | LTTNG_SYSCALL_ABI_COMPAT, | |
303 | }; | |
304 | ||
85a9ca7f | 305 | /* |
a90917c3 | 306 | * lttng_event structure is referred to by the tracing fast path. It must be |
85a9ca7f MD |
307 | * kept small. |
308 | */ | |
a90917c3 | 309 | struct lttng_event { |
3c997079 | 310 | enum lttng_event_type evtype; /* First field. */ |
85a9ca7f | 311 | unsigned int id; |
a90917c3 | 312 | struct lttng_channel *chan; |
e64957da | 313 | int enabled; |
d3dbe23c | 314 | const struct lttng_event_desc *desc; |
85a9ca7f | 315 | void *filter; |
f1676205 | 316 | struct lttng_ctx *ctx; |
38d024ae | 317 | enum lttng_kernel_instrumentation instrumentation; |
d6d808f3 MD |
318 | union { |
319 | struct { | |
320 | struct kprobe kp; | |
321 | char *symbol_name; | |
322 | } kprobe; | |
7371f44c MD |
323 | struct { |
324 | struct lttng_krp *lttng_krp; | |
325 | char *symbol_name; | |
326 | } kretprobe; | |
149b9a9d | 327 | struct { |
149b9a9d | 328 | struct inode *inode; |
3aed4dca | 329 | struct list_head head; |
149b9a9d | 330 | } uprobe; |
e298d6af MD |
331 | struct { |
332 | char *syscall_name; | |
333 | enum lttng_syscall_entryexit entryexit; | |
334 | enum lttng_syscall_abi abi; | |
335 | } syscall; | |
d6d808f3 | 336 | } u; |
3c997079 | 337 | struct list_head list; /* Event list in session */ |
9cccf98a | 338 | unsigned int metadata_dumped:1; |
3c997079 MD |
339 | |
340 | /* Backward references: list of lttng_enabler_ref (ref to enablers) */ | |
341 | struct list_head enablers_ref_head; | |
342 | struct hlist_node hlist; /* session ht of events */ | |
343 | int registered; /* has reg'd tracepoint probe */ | |
07dfc1d0 MD |
344 | /* list of struct lttng_bytecode_runtime, sorted by seqnum */ |
345 | struct list_head bytecode_runtime_head; | |
346 | int has_enablers_without_bytecode; | |
3c997079 MD |
347 | }; |
348 | ||
349 | enum lttng_enabler_type { | |
4993071a | 350 | LTTNG_ENABLER_STAR_GLOB, |
3c997079 MD |
351 | LTTNG_ENABLER_NAME, |
352 | }; | |
353 | ||
354 | /* | |
355 | * Enabler field, within whatever object is enabling an event. Target of | |
356 | * backward reference. | |
357 | */ | |
358 | struct lttng_enabler { | |
359 | enum lttng_event_type evtype; /* First field. */ | |
360 | ||
361 | enum lttng_enabler_type type; | |
362 | ||
363 | struct list_head node; /* per-session list of enablers */ | |
07dfc1d0 MD |
364 | /* head list of struct lttng_ust_filter_bytecode_node */ |
365 | struct list_head filter_bytecode_head; | |
3c997079 MD |
366 | |
367 | struct lttng_kernel_event event_param; | |
368 | struct lttng_channel *chan; | |
369 | struct lttng_ctx *ctx; | |
370 | unsigned int enabled:1; | |
85a9ca7f MD |
371 | }; |
372 | ||
a90917c3 | 373 | struct lttng_channel_ops { |
85a9ca7f | 374 | struct channel *(*channel_create)(const char *name, |
a90917c3 | 375 | struct lttng_channel *lttng_chan, |
85a9ca7f MD |
376 | void *buf_addr, |
377 | size_t subbuf_size, size_t num_subbuf, | |
378 | unsigned int switch_timer_interval, | |
379 | unsigned int read_timer_interval); | |
380 | void (*channel_destroy)(struct channel *chan); | |
381 | struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan); | |
f71ecafa | 382 | int (*buffer_has_read_closed_stream)(struct channel *chan); |
85a9ca7f | 383 | void (*buffer_read_close)(struct lib_ring_buffer *buf); |
4e1f08f4 | 384 | int (*event_reserve)(struct lib_ring_buffer_ctx *ctx, |
64c796d8 | 385 | uint32_t event_id); |
85a9ca7f MD |
386 | void (*event_commit)(struct lib_ring_buffer_ctx *ctx); |
387 | void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src, | |
388 | size_t len); | |
4ea00e4f JD |
389 | void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx, |
390 | const void *src, size_t len); | |
58aa5d24 MD |
391 | void (*event_memset)(struct lib_ring_buffer_ctx *ctx, |
392 | int c, size_t len); | |
16f78f3a MD |
393 | void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src, |
394 | size_t len); | |
395 | void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx, | |
396 | const char __user *src, size_t len); | |
1ec3f75a MD |
397 | /* |
398 | * packet_avail_size returns the available size in the current | |
399 | * packet. Note that the size returned is only a hint, since it | |
400 | * may change due to concurrent writes. | |
401 | */ | |
402 | size_t (*packet_avail_size)(struct channel *chan); | |
71c1d843 | 403 | wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu); |
24cedcfe MD |
404 | wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan); |
405 | int (*is_finalized)(struct channel *chan); | |
254ec7bc | 406 | int (*is_disabled)(struct channel *chan); |
3b731ab1 JD |
407 | int (*timestamp_begin) (const struct lib_ring_buffer_config *config, |
408 | struct lib_ring_buffer *bufb, | |
409 | uint64_t *timestamp_begin); | |
410 | int (*timestamp_end) (const struct lib_ring_buffer_config *config, | |
411 | struct lib_ring_buffer *bufb, | |
412 | uint64_t *timestamp_end); | |
413 | int (*events_discarded) (const struct lib_ring_buffer_config *config, | |
414 | struct lib_ring_buffer *bufb, | |
415 | uint64_t *events_discarded); | |
416 | int (*content_size) (const struct lib_ring_buffer_config *config, | |
417 | struct lib_ring_buffer *bufb, | |
418 | uint64_t *content_size); | |
419 | int (*packet_size) (const struct lib_ring_buffer_config *config, | |
420 | struct lib_ring_buffer *bufb, | |
421 | uint64_t *packet_size); | |
422 | int (*stream_id) (const struct lib_ring_buffer_config *config, | |
423 | struct lib_ring_buffer *bufb, | |
424 | uint64_t *stream_id); | |
2348ca17 JD |
425 | int (*current_timestamp) (const struct lib_ring_buffer_config *config, |
426 | struct lib_ring_buffer *bufb, | |
427 | uint64_t *ts); | |
5b3cf4f9 JD |
428 | int (*sequence_number) (const struct lib_ring_buffer_config *config, |
429 | struct lib_ring_buffer *bufb, | |
430 | uint64_t *seq); | |
5594698f JD |
431 | int (*instance_id) (const struct lib_ring_buffer_config *config, |
432 | struct lib_ring_buffer *bufb, | |
433 | uint64_t *id); | |
85a9ca7f MD |
434 | }; |
435 | ||
a90917c3 | 436 | struct lttng_transport { |
a33c9927 MD |
437 | char *name; |
438 | struct module *owner; | |
439 | struct list_head node; | |
a90917c3 | 440 | struct lttng_channel_ops ops; |
a33c9927 MD |
441 | }; |
442 | ||
80f87dd2 MD |
443 | struct lttng_syscall_filter; |
444 | ||
3c997079 MD |
445 | #define LTTNG_EVENT_HT_BITS 12 |
446 | #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS) | |
447 | ||
448 | struct lttng_event_ht { | |
449 | struct hlist_head table[LTTNG_EVENT_HT_SIZE]; | |
450 | }; | |
451 | ||
a90917c3 | 452 | struct lttng_channel { |
c099397a | 453 | unsigned int id; |
85a9ca7f | 454 | struct channel *chan; /* Channel buffers */ |
e64957da | 455 | int enabled; |
f1676205 | 456 | struct lttng_ctx *ctx; |
85a9ca7f | 457 | /* Event ID management */ |
a90917c3 | 458 | struct lttng_session *session; |
85a9ca7f MD |
459 | struct file *file; /* File associated to channel */ |
460 | unsigned int free_event_id; /* Next event ID to allocate */ | |
461 | struct list_head list; /* Channel list */ | |
a90917c3 MD |
462 | struct lttng_channel_ops *ops; |
463 | struct lttng_transport *transport; | |
464 | struct lttng_event **sc_table; /* for syscall tracing */ | |
465 | struct lttng_event **compat_sc_table; | |
5b7ac358 MD |
466 | struct lttng_event **sc_exit_table; /* for syscall exit tracing */ |
467 | struct lttng_event **compat_sc_exit_table; | |
a90917c3 MD |
468 | struct lttng_event *sc_unknown; /* for unknown syscalls */ |
469 | struct lttng_event *sc_compat_unknown; | |
5b7ac358 MD |
470 | struct lttng_event *sc_exit_unknown; |
471 | struct lttng_event *compat_sc_exit_unknown; | |
80f87dd2 | 472 | struct lttng_syscall_filter *sc_filter; |
9115fbdc | 473 | int header_type; /* 0: unset, 1: compact, 2: large */ |
d83004aa | 474 | enum channel_type channel_type; |
e298d6af | 475 | int syscall_all; |
80f87dd2 MD |
476 | unsigned int metadata_dumped:1, |
477 | sys_enter_registered:1, | |
478 | sys_exit_registered:1, | |
3c997079 | 479 | tstate:1; /* Transient enable state */ |
85a9ca7f MD |
480 | }; |
481 | ||
d83004aa JD |
482 | struct lttng_metadata_stream { |
483 | void *priv; /* Ring buffer private data */ | |
484 | struct lttng_metadata_cache *metadata_cache; | |
f613e3e6 MD |
485 | unsigned int metadata_in; /* Bytes read from the cache */ |
486 | unsigned int metadata_out; /* Bytes consumed from stream */ | |
d83004aa JD |
487 | int finalized; /* Has channel been finalized */ |
488 | wait_queue_head_t read_wait; /* Reader buffer-level wait queue */ | |
489 | struct list_head list; /* Stream list */ | |
b3b8072b | 490 | struct lttng_transport *transport; |
9616f0bf | 491 | uint64_t version; /* Current version of the metadata cache */ |
695b3509 | 492 | bool coherent; /* Stream in a coherent state */ |
d83004aa JD |
493 | }; |
494 | ||
114667d5 MD |
495 | #define LTTNG_DYNAMIC_LEN_STACK_SIZE 128 |
496 | ||
497 | struct lttng_dynamic_len_stack { | |
498 | size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE]; | |
499 | size_t offset; | |
500 | }; | |
501 | ||
502 | DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack); | |
e0130fab MD |
503 | |
504 | /* | |
505 | * struct lttng_pid_tracker declared in header due to deferencing of *v | |
506 | * in RCU_INITIALIZER(v). | |
507 | */ | |
508 | #define LTTNG_PID_HASH_BITS 6 | |
509 | #define LTTNG_PID_TABLE_SIZE (1 << LTTNG_PID_HASH_BITS) | |
510 | ||
511 | struct lttng_pid_tracker { | |
512 | struct hlist_head pid_hash[LTTNG_PID_TABLE_SIZE]; | |
513 | }; | |
514 | ||
7e6f9ef6 MD |
515 | struct lttng_pid_hash_node { |
516 | struct hlist_node hlist; | |
517 | int pid; | |
518 | }; | |
519 | ||
a90917c3 | 520 | struct lttng_session { |
85a9ca7f | 521 | int active; /* Is trace session active ? */ |
8070f5c0 | 522 | int been_active; /* Has trace session been active ? */ |
85a9ca7f MD |
523 | struct file *file; /* File associated to session */ |
524 | struct list_head chan; /* Channel list head */ | |
525 | struct list_head events; /* Event list head */ | |
526 | struct list_head list; /* Session list */ | |
c099397a | 527 | unsigned int free_chan_id; /* Next chan ID to allocate */ |
d793d5e1 | 528 | uuid_le uuid; /* Trace session unique ID */ |
d83004aa | 529 | struct lttng_metadata_cache *metadata_cache; |
e0130fab | 530 | struct lttng_pid_tracker *pid_tracker; |
3c997079 MD |
531 | unsigned int metadata_dumped:1, |
532 | tstate:1; /* Transient enable state */ | |
533 | /* List of enablers */ | |
534 | struct list_head enablers_head; | |
535 | /* Hash table of events */ | |
536 | struct lttng_event_ht events_ht; | |
e026f97d | 537 | char name[LTTNG_KERNEL_SESSION_NAME_LEN]; |
a9550ab5 | 538 | char creation_time[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN]; |
85a9ca7f MD |
539 | }; |
540 | ||
d83004aa JD |
541 | struct lttng_metadata_cache { |
542 | char *data; /* Metadata cache */ | |
543 | unsigned int cache_alloc; /* Metadata allocated size (bytes) */ | |
544 | unsigned int metadata_written; /* Number of bytes written in metadata cache */ | |
a5e2ec2d | 545 | atomic_t producing; /* Metadata being produced (incomplete) */ |
d83004aa JD |
546 | struct kref refcount; /* Metadata cache usage */ |
547 | struct list_head metadata_stream; /* Metadata stream list */ | |
a36580d5 | 548 | uuid_le uuid; /* Trace session unique ID (copy) */ |
9616f0bf JD |
549 | struct mutex lock; /* Produce/consume lock */ |
550 | uint64_t version; /* Current version of the metadata */ | |
d83004aa JD |
551 | }; |
552 | ||
3c997079 MD |
553 | void lttng_lock_sessions(void); |
554 | void lttng_unlock_sessions(void); | |
555 | ||
556 | struct list_head *lttng_get_probe_list_head(void); | |
557 | ||
558 | struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type, | |
559 | struct lttng_kernel_event *event_param, | |
560 | struct lttng_channel *chan); | |
561 | ||
562 | int lttng_enabler_enable(struct lttng_enabler *enabler); | |
563 | int lttng_enabler_disable(struct lttng_enabler *enabler); | |
564 | int lttng_fix_pending_events(void); | |
565 | int lttng_session_active(void); | |
566 | ||
a90917c3 MD |
567 | struct lttng_session *lttng_session_create(void); |
568 | int lttng_session_enable(struct lttng_session *session); | |
569 | int lttng_session_disable(struct lttng_session *session); | |
570 | void lttng_session_destroy(struct lttng_session *session); | |
9616f0bf | 571 | int lttng_session_metadata_regenerate(struct lttng_session *session); |
601252cf | 572 | int lttng_session_statedump(struct lttng_session *session); |
d83004aa | 573 | void metadata_cache_destroy(struct kref *kref); |
4e3c1b9b | 574 | |
a90917c3 | 575 | struct lttng_channel *lttng_channel_create(struct lttng_session *session, |
5dbbdb43 MD |
576 | const char *transport_name, |
577 | void *buf_addr, | |
578 | size_t subbuf_size, size_t num_subbuf, | |
579 | unsigned int switch_timer_interval, | |
d83004aa JD |
580 | unsigned int read_timer_interval, |
581 | enum channel_type channel_type); | |
a90917c3 | 582 | struct lttng_channel *lttng_global_channel_create(struct lttng_session *session, |
4e3c1b9b MD |
583 | int overwrite, void *buf_addr, |
584 | size_t subbuf_size, size_t num_subbuf, | |
585 | unsigned int switch_timer_interval, | |
586 | unsigned int read_timer_interval); | |
4e3c1b9b | 587 | |
d83004aa | 588 | void lttng_metadata_channel_destroy(struct lttng_channel *chan); |
a90917c3 | 589 | struct lttng_event *lttng_event_create(struct lttng_channel *chan, |
3c997079 MD |
590 | struct lttng_kernel_event *event_param, |
591 | void *filter, | |
592 | const struct lttng_event_desc *event_desc, | |
593 | enum lttng_kernel_instrumentation itype); | |
33a39a3c MD |
594 | struct lttng_event *_lttng_event_create(struct lttng_channel *chan, |
595 | struct lttng_kernel_event *event_param, | |
596 | void *filter, | |
597 | const struct lttng_event_desc *event_desc, | |
598 | enum lttng_kernel_instrumentation itype); | |
6dccd6c1 JD |
599 | struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan, |
600 | struct lttng_kernel_old_event *old_event_param, | |
601 | void *filter, | |
602 | const struct lttng_event_desc *internal_desc); | |
c0e31d2e | 603 | |
a90917c3 MD |
604 | int lttng_channel_enable(struct lttng_channel *channel); |
605 | int lttng_channel_disable(struct lttng_channel *channel); | |
606 | int lttng_event_enable(struct lttng_event *event); | |
607 | int lttng_event_disable(struct lttng_event *event); | |
e64957da | 608 | |
a90917c3 MD |
609 | void lttng_transport_register(struct lttng_transport *transport); |
610 | void lttng_transport_unregister(struct lttng_transport *transport); | |
11b5a3c2 | 611 | |
360f38ea | 612 | void synchronize_trace(void); |
80996790 | 613 | int lttng_abi_init(void); |
6dccd6c1 | 614 | int lttng_abi_compat_old_init(void); |
80996790 | 615 | void lttng_abi_exit(void); |
6dccd6c1 | 616 | void lttng_abi_compat_old_exit(void); |
1c25284c | 617 | |
a90917c3 MD |
618 | int lttng_probe_register(struct lttng_probe_desc *desc); |
619 | void lttng_probe_unregister(struct lttng_probe_desc *desc); | |
620 | const struct lttng_event_desc *lttng_event_get(const char *name); | |
621 | void lttng_event_put(const struct lttng_event_desc *desc); | |
622 | int lttng_probes_init(void); | |
623 | void lttng_probes_exit(void); | |
1ec65de1 | 624 | |
b3b8072b | 625 | int lttng_metadata_output_channel(struct lttng_metadata_stream *stream, |
695b3509 | 626 | struct channel *chan, bool *coherent); |
d83004aa | 627 | |
7e6f9ef6 | 628 | int lttng_pid_tracker_get_node_pid(const struct lttng_pid_hash_node *node); |
e0130fab MD |
629 | struct lttng_pid_tracker *lttng_pid_tracker_create(void); |
630 | void lttng_pid_tracker_destroy(struct lttng_pid_tracker *lpf); | |
631 | bool lttng_pid_tracker_lookup(struct lttng_pid_tracker *lpf, int pid); | |
632 | int lttng_pid_tracker_add(struct lttng_pid_tracker *lpf, int pid); | |
633 | int lttng_pid_tracker_del(struct lttng_pid_tracker *lpf, int pid); | |
634 | ||
635 | int lttng_session_track_pid(struct lttng_session *session, int pid); | |
636 | int lttng_session_untrack_pid(struct lttng_session *session, int pid); | |
637 | ||
7e6f9ef6 MD |
638 | int lttng_session_list_tracker_pids(struct lttng_session *session); |
639 | ||
2754583e MD |
640 | void lttng_clock_ref(void); |
641 | void lttng_clock_unref(void); | |
642 | ||
3a523f5b | 643 | #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS) |
a90917c3 MD |
644 | int lttng_syscalls_register(struct lttng_channel *chan, void *filter); |
645 | int lttng_syscalls_unregister(struct lttng_channel *chan); | |
e298d6af | 646 | int lttng_syscalls_destroy(struct lttng_channel *chan); |
80f87dd2 | 647 | int lttng_syscall_filter_enable(struct lttng_channel *chan, |
e298d6af | 648 | struct lttng_event *event); |
80f87dd2 | 649 | int lttng_syscall_filter_disable(struct lttng_channel *chan, |
e298d6af | 650 | struct lttng_event *event); |
12e579db MD |
651 | long lttng_channel_syscall_mask(struct lttng_channel *channel, |
652 | struct lttng_kernel_syscall_mask __user *usyscall_mask); | |
1ec65de1 | 653 | #else |
a90917c3 | 654 | static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter) |
1ec65de1 MD |
655 | { |
656 | return -ENOSYS; | |
657 | } | |
658 | ||
a90917c3 | 659 | static inline int lttng_syscalls_unregister(struct lttng_channel *chan) |
1ec65de1 MD |
660 | { |
661 | return 0; | |
662 | } | |
80f87dd2 | 663 | |
e298d6af MD |
664 | static inline int lttng_syscalls_destroy(struct lttng_channel *chan) |
665 | { | |
666 | return 0; | |
667 | } | |
668 | ||
f127e61e | 669 | static inline int lttng_syscall_filter_enable(struct lttng_channel *chan, |
e298d6af | 670 | struct lttng_event *event); |
80f87dd2 MD |
671 | { |
672 | return -ENOSYS; | |
673 | } | |
674 | ||
f127e61e | 675 | static inline int lttng_syscall_filter_disable(struct lttng_channel *chan, |
e298d6af | 676 | struct lttng_event *event); |
80f87dd2 MD |
677 | { |
678 | return -ENOSYS; | |
679 | } | |
12e579db | 680 | |
f127e61e | 681 | static inline long lttng_channel_syscall_mask(struct lttng_channel *channel, |
12e579db MD |
682 | struct lttng_kernel_syscall_mask __user *usyscall_mask) |
683 | { | |
684 | return -ENOSYS; | |
685 | } | |
1ec65de1 MD |
686 | #endif |
687 | ||
07dfc1d0 MD |
688 | void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime); |
689 | int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler, | |
690 | struct lttng_kernel_filter_bytecode __user *bytecode); | |
f127e61e MD |
691 | void lttng_enabler_event_link_bytecode(struct lttng_event *event, |
692 | struct lttng_enabler *enabler); | |
07dfc1d0 | 693 | |
114667d5 MD |
694 | int lttng_probes_init(void); |
695 | ||
07dfc1d0 MD |
696 | extern struct lttng_ctx *lttng_static_ctx; |
697 | ||
698 | int lttng_context_init(void); | |
699 | void lttng_context_exit(void); | |
2dccf128 | 700 | struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx); |
a9dd15da | 701 | void lttng_context_update(struct lttng_ctx *ctx); |
44252f0f | 702 | int lttng_find_context(struct lttng_ctx *ctx, const char *name); |
07dfc1d0 | 703 | int lttng_get_context_index(struct lttng_ctx *ctx, const char *name); |
8289661d MD |
704 | void lttng_remove_context_field(struct lttng_ctx **ctx, |
705 | struct lttng_ctx_field *field); | |
2dccf128 | 706 | void lttng_destroy_context(struct lttng_ctx *ctx); |
8070f5c0 | 707 | int lttng_add_pid_to_ctx(struct lttng_ctx **ctx); |
b3699d90 | 708 | int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx); |
a2563e83 | 709 | int lttng_add_procname_to_ctx(struct lttng_ctx **ctx); |
a8ad3613 | 710 | int lttng_add_prio_to_ctx(struct lttng_ctx **ctx); |
53f1f0ca | 711 | int lttng_add_nice_to_ctx(struct lttng_ctx **ctx); |
b64bc438 MD |
712 | int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx); |
713 | int lttng_add_tid_to_ctx(struct lttng_ctx **ctx); | |
714 | int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx); | |
715 | int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx); | |
716 | int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx); | |
975da2c0 | 717 | int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx); |
79150a49 JD |
718 | int lttng_add_interruptible_to_ctx(struct lttng_ctx **ctx); |
719 | int lttng_add_need_reschedule_to_ctx(struct lttng_ctx **ctx); | |
720 | #if defined(CONFIG_PREEMPT_RT_FULL) || defined(CONFIG_PREEMPT) | |
721 | int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx); | |
722 | #else | |
723 | static inline | |
724 | int lttng_add_preemptible_to_ctx(struct lttng_ctx **ctx) | |
725 | { | |
726 | return -ENOSYS; | |
727 | } | |
728 | #endif | |
729 | #ifdef CONFIG_PREEMPT_RT_FULL | |
730 | int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx); | |
731 | #else | |
732 | static inline | |
733 | int lttng_add_migratable_to_ctx(struct lttng_ctx **ctx) | |
734 | { | |
735 | return -ENOSYS; | |
736 | } | |
737 | #endif | |
2fa2d39a FG |
738 | |
739 | int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type); | |
740 | ||
41c3c24e | 741 | #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33)) |
c24a0d71 MD |
742 | int lttng_add_perf_counter_to_ctx(uint32_t type, |
743 | uint64_t config, | |
744 | const char *name, | |
745 | struct lttng_ctx **ctx); | |
1e367326 MD |
746 | int lttng_cpuhp_perf_counter_online(unsigned int cpu, |
747 | struct lttng_cpuhp_node *node); | |
748 | int lttng_cpuhp_perf_counter_dead(unsigned int cpu, | |
749 | struct lttng_cpuhp_node *node); | |
1d443b34 MD |
750 | #else |
751 | static inline | |
752 | int lttng_add_perf_counter_to_ctx(uint32_t type, | |
753 | uint64_t config, | |
754 | const char *name, | |
755 | struct lttng_ctx **ctx) | |
756 | { | |
757 | return -ENOSYS; | |
758 | } | |
1e367326 MD |
759 | static inline |
760 | int lttng_cpuhp_perf_counter_online(unsigned int cpu, | |
761 | struct lttng_cpuhp_node *node) | |
762 | { | |
763 | return 0; | |
764 | } | |
765 | static inline | |
766 | int lttng_cpuhp_perf_counter_dead(unsigned int cpu, | |
767 | struct lttng_cpuhp_node *node) | |
768 | { | |
769 | return 0; | |
770 | } | |
1d443b34 | 771 | #endif |
02119ee5 | 772 | |
0c956676 MD |
773 | int lttng_logger_init(void); |
774 | void lttng_logger_exit(void); | |
775 | ||
c337ddc2 MD |
776 | extern int lttng_statedump_start(struct lttng_session *session); |
777 | ||
acd614cc | 778 | #ifdef CONFIG_KPROBES |
f17701fb MD |
779 | int lttng_kprobes_register(const char *name, |
780 | const char *symbol_name, | |
781 | uint64_t offset, | |
782 | uint64_t addr, | |
a90917c3 MD |
783 | struct lttng_event *event); |
784 | void lttng_kprobes_unregister(struct lttng_event *event); | |
785 | void lttng_kprobes_destroy_private(struct lttng_event *event); | |
acd614cc MD |
786 | #else |
787 | static inline | |
788 | int lttng_kprobes_register(const char *name, | |
789 | const char *symbol_name, | |
790 | uint64_t offset, | |
791 | uint64_t addr, | |
a90917c3 | 792 | struct lttng_event *event) |
acd614cc MD |
793 | { |
794 | return -ENOSYS; | |
795 | } | |
796 | ||
25f53c39 | 797 | static inline |
a90917c3 | 798 | void lttng_kprobes_unregister(struct lttng_event *event) |
acd614cc MD |
799 | { |
800 | } | |
edeb3137 MD |
801 | |
802 | static inline | |
a90917c3 | 803 | void lttng_kprobes_destroy_private(struct lttng_event *event) |
edeb3137 MD |
804 | { |
805 | } | |
acd614cc | 806 | #endif |
d6d808f3 | 807 | |
3aed4dca FD |
808 | int lttng_event_add_callsite(struct lttng_event *event, |
809 | struct lttng_kernel_event_callsite *callsite); | |
e33fc900 | 810 | |
149b9a9d YB |
811 | #ifdef CONFIG_UPROBES |
812 | int lttng_uprobes_register(const char *name, | |
3aed4dca FD |
813 | int fd, struct lttng_event *event); |
814 | int lttng_uprobes_add_callsite(struct lttng_event *event, | |
815 | struct lttng_kernel_event_callsite *callsite); | |
149b9a9d YB |
816 | void lttng_uprobes_unregister(struct lttng_event *event); |
817 | void lttng_uprobes_destroy_private(struct lttng_event *event); | |
818 | #else | |
819 | static inline | |
820 | int lttng_uprobes_register(const char *name, | |
3aed4dca FD |
821 | int fd, struct lttng_event *event) |
822 | { | |
823 | return -ENOSYS; | |
824 | } | |
825 | ||
826 | static inline | |
827 | int lttng_uprobes_add_callsite(struct lttng_event *event, | |
e33fc900 | 828 | struct lttng_kernel_event_callsite *callsite) |
149b9a9d YB |
829 | { |
830 | return -ENOSYS; | |
831 | } | |
832 | ||
833 | static inline | |
834 | void lttng_uprobes_unregister(struct lttng_event *event) | |
835 | { | |
836 | } | |
837 | ||
838 | static inline | |
839 | void lttng_uprobes_destroy_private(struct lttng_event *event) | |
840 | { | |
841 | } | |
842 | #endif | |
843 | ||
7371f44c MD |
844 | #ifdef CONFIG_KRETPROBES |
845 | int lttng_kretprobes_register(const char *name, | |
846 | const char *symbol_name, | |
847 | uint64_t offset, | |
848 | uint64_t addr, | |
a90917c3 MD |
849 | struct lttng_event *event_entry, |
850 | struct lttng_event *event_exit); | |
851 | void lttng_kretprobes_unregister(struct lttng_event *event); | |
852 | void lttng_kretprobes_destroy_private(struct lttng_event *event); | |
a0493bef MD |
853 | int lttng_kretprobes_event_enable_state(struct lttng_event *event, |
854 | int enable); | |
7371f44c MD |
855 | #else |
856 | static inline | |
857 | int lttng_kretprobes_register(const char *name, | |
858 | const char *symbol_name, | |
859 | uint64_t offset, | |
860 | uint64_t addr, | |
a90917c3 MD |
861 | struct lttng_event *event_entry, |
862 | struct lttng_event *event_exit) | |
7371f44c MD |
863 | { |
864 | return -ENOSYS; | |
865 | } | |
866 | ||
867 | static inline | |
a90917c3 | 868 | void lttng_kretprobes_unregister(struct lttng_event *event) |
7371f44c MD |
869 | { |
870 | } | |
871 | ||
872 | static inline | |
a90917c3 | 873 | void lttng_kretprobes_destroy_private(struct lttng_event *event) |
7371f44c MD |
874 | { |
875 | } | |
a0493bef MD |
876 | |
877 | static inline | |
878 | int lttng_kretprobes_event_enable_state(struct lttng_event *event, | |
879 | int enable) | |
880 | { | |
881 | return -ENOSYS; | |
882 | } | |
7371f44c MD |
883 | #endif |
884 | ||
3db41b2c | 885 | int lttng_calibrate(struct lttng_kernel_calibrate *calibrate); |
57105fc2 | 886 | |
271b6681 | 887 | extern const struct file_operations lttng_tracepoint_list_fops; |
2d2464bd | 888 | extern const struct file_operations lttng_syscall_list_fops; |
271b6681 | 889 | |
ef200626 MD |
890 | #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35)) |
891 | #define TRACEPOINT_HAS_DATA_ARG | |
892 | #endif | |
893 | ||
a90917c3 | 894 | #endif /* _LTTNG_EVENTS_H */ |