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