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