Commit | Line | Data |
---|---|---|
51489cad MD |
1 | #ifndef _LTTNG_UST_EVENTS_H |
2 | #define _LTTNG_UST_EVENTS_H | |
8020ceb5 MD |
3 | |
4 | /* | |
51489cad | 5 | * lttng/ust-events.h |
8020ceb5 | 6 | * |
e92f3e28 | 7 | * Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
8020ceb5 MD |
8 | * |
9 | * Holds LTTng per-session event registry. | |
10 | * | |
e92f3e28 MD |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
a60d70e6 | 17 | * |
e92f3e28 MD |
18 | * The above copyright notice and this permission notice shall be included in |
19 | * all copies or substantial portions of the Software. | |
d2428e87 MD |
20 | * |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
8020ceb5 MD |
28 | */ |
29 | ||
9f3fdbc6 | 30 | #include <urcu/list.h> |
1f18504e | 31 | #include <urcu/hlist.h> |
b4051ad8 | 32 | #include <stddef.h> |
9f3fdbc6 | 33 | #include <stdint.h> |
d58d1454 | 34 | #include <lttng/ust-config.h> |
4318ae1b MD |
35 | #include <lttng/ust-abi.h> |
36 | #include <lttng/ust-tracer.h> | |
2ae57758 | 37 | #include <lttng/ust-endian.h> |
20f1eee7 | 38 | #include <float.h> |
d58d1454 MD |
39 | #include <errno.h> |
40 | #include <urcu/ref.h> | |
41 | #include <pthread.h> | |
8020ceb5 | 42 | |
db56acaf MD |
43 | #ifndef LTTNG_PACKED |
44 | #error "LTTNG_PACKED should be defined" | |
45 | #endif | |
46 | ||
6453d237 MD |
47 | #ifdef __cplusplus |
48 | extern "C" { | |
49 | #endif | |
50 | ||
19d8b1b3 MD |
51 | #define LTTNG_UST_UUID_LEN 16 |
52 | ||
71d31690 MD |
53 | /* |
54 | * Tracepoint provider version. Compatibility based on the major number. | |
55 | * Older tracepoint providers can always register to newer lttng-ust | |
56 | * library, but the opposite is rejected: a newer tracepoint provider is | |
57 | * rejected by an older lttng-ust library. | |
58 | */ | |
04f0b55a | 59 | #define LTTNG_UST_PROVIDER_MAJOR 2 |
71d31690 MD |
60 | #define LTTNG_UST_PROVIDER_MINOR 0 |
61 | ||
7dd08bec MD |
62 | struct lttng_channel; |
63 | struct lttng_session; | |
4cfec15c | 64 | struct lttng_ust_lib_ring_buffer_ctx; |
53569322 MD |
65 | struct lttng_ust_context_app; |
66 | struct lttng_event_field; | |
8020ceb5 | 67 | |
37d5e202 MD |
68 | /* |
69 | * Data structures used by tracepoint event declarations, and by the | |
70 | * tracer. Those structures have padding for future extension. | |
71 | */ | |
72 | ||
c1fca457 MD |
73 | /* |
74 | * LTTng client type enumeration. Used by the consumer to map the | |
75 | * callbacks from its own address space. | |
76 | */ | |
77 | enum lttng_client_types { | |
78 | LTTNG_CLIENT_METADATA = 0, | |
79 | LTTNG_CLIENT_DISCARD = 1, | |
80 | LTTNG_CLIENT_OVERWRITE = 2, | |
34a91bdb MD |
81 | LTTNG_CLIENT_DISCARD_RT = 3, |
82 | LTTNG_CLIENT_OVERWRITE_RT = 4, | |
c1fca457 MD |
83 | LTTNG_NR_CLIENT_TYPES, |
84 | }; | |
85 | ||
8020ceb5 MD |
86 | /* Type description */ |
87 | ||
88 | /* Update the astract_types name table in lttng-types.c along with this enum */ | |
7dd08bec | 89 | enum lttng_abstract_types { |
8020ceb5 | 90 | atype_integer, |
218deb69 MD |
91 | atype_enum, /* legacy */ |
92 | atype_array, /* legacy */ | |
93 | atype_sequence, /* legacy */ | |
8020ceb5 | 94 | atype_string, |
20f1eee7 | 95 | atype_float, |
53569322 | 96 | atype_dynamic, |
218deb69 MD |
97 | atype_struct, /* legacy */ |
98 | atype_enum_nestable, | |
99 | atype_array_nestable, | |
100 | atype_sequence_nestable, | |
101 | atype_struct_nestable, | |
8020ceb5 MD |
102 | NR_ABSTRACT_TYPES, |
103 | }; | |
104 | ||
105 | /* Update the string_encodings name table in lttng-types.c along with this enum */ | |
106 | enum lttng_string_encodings { | |
107 | lttng_encode_none = 0, | |
108 | lttng_encode_UTF8 = 1, | |
109 | lttng_encode_ASCII = 2, | |
110 | NR_STRING_ENCODINGS, | |
111 | }; | |
112 | ||
a6f80644 MD |
113 | struct lttng_enum_value { |
114 | unsigned long long value; | |
115 | unsigned int signedness:1; | |
116 | }; | |
117 | ||
3e762260 PP |
118 | enum lttng_enum_entry_options { |
119 | LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0, | |
120 | }; | |
121 | ||
37d5e202 | 122 | #define LTTNG_UST_ENUM_ENTRY_PADDING 16 |
8020ceb5 | 123 | struct lttng_enum_entry { |
a6f80644 | 124 | struct lttng_enum_value start, end; /* start and end are inclusive */ |
8020ceb5 | 125 | const char *string; |
3e762260 PP |
126 | union { |
127 | struct { | |
128 | unsigned int options; | |
129 | } LTTNG_PACKED extra; | |
130 | char padding[LTTNG_UST_ENUM_ENTRY_PADDING]; | |
131 | } u; | |
8020ceb5 MD |
132 | }; |
133 | ||
134 | #define __type_integer(_type, _byte_order, _base, _encoding) \ | |
135 | { \ | |
46d52200 ZT |
136 | .atype = atype_integer, \ |
137 | .u = \ | |
8020ceb5 | 138 | { \ |
218deb69 | 139 | .integer = \ |
46d52200 | 140 | { \ |
218deb69 MD |
141 | .size = sizeof(_type) * CHAR_BIT, \ |
142 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ | |
143 | .signedness = lttng_is_signed_type(_type), \ | |
144 | .reverse_byte_order = _byte_order != BYTE_ORDER, \ | |
145 | .base = _base, \ | |
146 | .encoding = lttng_encode_##_encoding, \ | |
46d52200 | 147 | } \ |
8020ceb5 MD |
148 | }, \ |
149 | } \ | |
150 | ||
37d5e202 | 151 | #define LTTNG_UST_INTEGER_TYPE_PADDING 24 |
8020ceb5 MD |
152 | struct lttng_integer_type { |
153 | unsigned int size; /* in bits */ | |
154 | unsigned short alignment; /* in bits */ | |
155 | unsigned int signedness:1; | |
156 | unsigned int reverse_byte_order:1; | |
157 | unsigned int base; /* 2, 8, 10, 16, for pretty print */ | |
158 | enum lttng_string_encodings encoding; | |
37d5e202 | 159 | char padding[LTTNG_UST_INTEGER_TYPE_PADDING]; |
8020ceb5 MD |
160 | }; |
161 | ||
d3ed854b MD |
162 | /* |
163 | * Only float and double are supported. long double is not supported at | |
164 | * the moment. | |
165 | */ | |
20f1eee7 MD |
166 | #define _float_mant_dig(_type) \ |
167 | (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \ | |
168 | : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \ | |
d3ed854b | 169 | : 0)) |
20f1eee7 MD |
170 | |
171 | #define __type_float(_type) \ | |
172 | { \ | |
46d52200 ZT |
173 | .atype = atype_float, \ |
174 | .u = \ | |
20f1eee7 | 175 | { \ |
218deb69 | 176 | ._float = \ |
46d52200 | 177 | { \ |
218deb69 MD |
178 | .exp_dig = sizeof(_type) * CHAR_BIT \ |
179 | - _float_mant_dig(_type), \ | |
180 | .mant_dig = _float_mant_dig(_type), \ | |
181 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ | |
182 | .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \ | |
46d52200 | 183 | } \ |
218deb69 | 184 | } \ |
20f1eee7 MD |
185 | } \ |
186 | ||
37d5e202 | 187 | #define LTTNG_UST_FLOAT_TYPE_PADDING 24 |
20f1eee7 MD |
188 | struct lttng_float_type { |
189 | unsigned int exp_dig; /* exponent digits, in bits */ | |
190 | unsigned int mant_dig; /* mantissa digits, in bits */ | |
191 | unsigned short alignment; /* in bits */ | |
192 | unsigned int reverse_byte_order:1; | |
37d5e202 | 193 | char padding[LTTNG_UST_FLOAT_TYPE_PADDING]; |
20f1eee7 MD |
194 | }; |
195 | ||
218deb69 | 196 | /* legacy */ |
37d5e202 | 197 | #define LTTNG_UST_BASIC_TYPE_PADDING 128 |
8020ceb5 | 198 | union _lttng_basic_type { |
218deb69 | 199 | struct lttng_integer_type integer; /* legacy */ |
8020ceb5 | 200 | struct { |
c785c634 MD |
201 | const struct lttng_enum_desc *desc; /* Enumeration mapping */ |
202 | struct lttng_integer_type container_type; | |
218deb69 | 203 | } enumeration; /* legacy */ |
8020ceb5 MD |
204 | struct { |
205 | enum lttng_string_encodings encoding; | |
218deb69 MD |
206 | } string; /* legacy */ |
207 | struct lttng_float_type _float; /* legacy */ | |
37d5e202 | 208 | char padding[LTTNG_UST_BASIC_TYPE_PADDING]; |
8020ceb5 MD |
209 | }; |
210 | ||
218deb69 | 211 | /* legacy */ |
8020ceb5 | 212 | struct lttng_basic_type { |
7dd08bec | 213 | enum lttng_abstract_types atype; |
8020ceb5 MD |
214 | union { |
215 | union _lttng_basic_type basic; | |
216 | } u; | |
217 | }; | |
218 | ||
37d5e202 | 219 | #define LTTNG_UST_TYPE_PADDING 128 |
8020ceb5 | 220 | struct lttng_type { |
7dd08bec | 221 | enum lttng_abstract_types atype; |
8020ceb5 | 222 | union { |
218deb69 MD |
223 | /* provider ABI 2.0 */ |
224 | struct lttng_integer_type integer; | |
225 | struct lttng_float_type _float; | |
226 | struct { | |
227 | enum lttng_string_encodings encoding; | |
228 | } string; | |
229 | struct { | |
230 | const struct lttng_enum_desc *desc; /* Enumeration mapping */ | |
231 | struct lttng_type *container_type; | |
232 | } enum_nestable; | |
8020ceb5 | 233 | struct { |
218deb69 MD |
234 | const struct lttng_type *elem_type; |
235 | unsigned int length; /* Num. elems. */ | |
236 | unsigned int alignment; | |
237 | } array_nestable; | |
8020ceb5 | 238 | struct { |
218deb69 MD |
239 | const char *length_name; /* Length field name. */ |
240 | const struct lttng_type *elem_type; | |
241 | unsigned int alignment; /* Alignment before elements. */ | |
242 | } sequence_nestable; | |
53569322 | 243 | struct { |
218deb69 MD |
244 | unsigned int nr_fields; |
245 | const struct lttng_event_field *fields; /* Array of fields. */ | |
246 | unsigned int alignment; | |
247 | } struct_nestable; | |
248 | ||
249 | union { | |
250 | /* legacy provider ABI 1.0 */ | |
251 | union _lttng_basic_type basic; /* legacy */ | |
252 | struct { | |
253 | struct lttng_basic_type elem_type; | |
254 | unsigned int length; /* Num. elems. */ | |
255 | } array; /* legacy */ | |
256 | struct { | |
257 | struct lttng_basic_type length_type; | |
258 | struct lttng_basic_type elem_type; | |
259 | } sequence; /* legacy */ | |
260 | struct { | |
261 | unsigned int nr_fields; | |
262 | struct lttng_event_field *fields; /* Array of fields. */ | |
263 | } _struct; /* legacy */ | |
264 | } legacy; | |
37d5e202 | 265 | char padding[LTTNG_UST_TYPE_PADDING]; |
8020ceb5 MD |
266 | } u; |
267 | }; | |
268 | ||
37d5e202 | 269 | #define LTTNG_UST_ENUM_TYPE_PADDING 24 |
c785c634 | 270 | struct lttng_enum_desc { |
8020ceb5 | 271 | const char *name; |
8020ceb5 | 272 | const struct lttng_enum_entry *entries; |
c785c634 | 273 | unsigned int nr_entries; |
37d5e202 | 274 | char padding[LTTNG_UST_ENUM_TYPE_PADDING]; |
8020ceb5 MD |
275 | }; |
276 | ||
180901e6 MD |
277 | /* |
278 | * Event field description | |
279 | * | |
280 | * IMPORTANT: this structure is part of the ABI between the probe and | |
281 | * UST. Fields need to be only added at the end, never reordered, never | |
282 | * removed. | |
283 | */ | |
8020ceb5 | 284 | |
4774c8f3 | 285 | #define LTTNG_UST_EVENT_FIELD_PADDING 28 |
8020ceb5 MD |
286 | struct lttng_event_field { |
287 | const char *name; | |
288 | struct lttng_type type; | |
180901e6 | 289 | unsigned int nowrite; /* do not write into trace */ |
218deb69 MD |
290 | union { |
291 | struct { | |
292 | unsigned int nofilter:1; /* do not consider for filter */ | |
293 | } ext; | |
294 | char padding[LTTNG_UST_EVENT_FIELD_PADDING]; | |
295 | } u; | |
8020ceb5 MD |
296 | }; |
297 | ||
53569322 MD |
298 | enum lttng_ust_dynamic_type { |
299 | LTTNG_UST_DYNAMIC_TYPE_NONE, | |
300 | LTTNG_UST_DYNAMIC_TYPE_S8, | |
301 | LTTNG_UST_DYNAMIC_TYPE_S16, | |
302 | LTTNG_UST_DYNAMIC_TYPE_S32, | |
303 | LTTNG_UST_DYNAMIC_TYPE_S64, | |
304 | LTTNG_UST_DYNAMIC_TYPE_U8, | |
305 | LTTNG_UST_DYNAMIC_TYPE_U16, | |
306 | LTTNG_UST_DYNAMIC_TYPE_U32, | |
307 | LTTNG_UST_DYNAMIC_TYPE_U64, | |
308 | LTTNG_UST_DYNAMIC_TYPE_FLOAT, | |
309 | LTTNG_UST_DYNAMIC_TYPE_DOUBLE, | |
310 | LTTNG_UST_DYNAMIC_TYPE_STRING, | |
311 | _NR_LTTNG_UST_DYNAMIC_TYPES, | |
312 | }; | |
313 | ||
314 | struct lttng_ctx_value { | |
315 | enum lttng_ust_dynamic_type sel; | |
316 | union { | |
317 | int64_t s64; | |
318 | const char *str; | |
319 | double d; | |
320 | } u; | |
77aa5901 MD |
321 | }; |
322 | ||
d58d1454 MD |
323 | struct lttng_perf_counter_field; |
324 | ||
37d5e202 | 325 | #define LTTNG_UST_CTX_FIELD_PADDING 40 |
8020ceb5 MD |
326 | struct lttng_ctx_field { |
327 | struct lttng_event_field event_field; | |
53569322 | 328 | size_t (*get_size)(struct lttng_ctx_field *field, size_t offset); |
8020ceb5 | 329 | void (*record)(struct lttng_ctx_field *field, |
4cfec15c | 330 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
7dd08bec | 331 | struct lttng_channel *chan); |
77aa5901 | 332 | void (*get_value)(struct lttng_ctx_field *field, |
53569322 | 333 | struct lttng_ctx_value *value); |
8020ceb5 | 334 | union { |
d58d1454 | 335 | struct lttng_perf_counter_field *perf_counter; |
37d5e202 | 336 | char padding[LTTNG_UST_CTX_FIELD_PADDING]; |
8020ceb5 MD |
337 | } u; |
338 | void (*destroy)(struct lttng_ctx_field *field); | |
53569322 | 339 | char *field_name; /* Has ownership, dynamically allocated. */ |
8020ceb5 MD |
340 | }; |
341 | ||
b2cc986a | 342 | #define LTTNG_UST_CTX_PADDING 20 |
8020ceb5 MD |
343 | struct lttng_ctx { |
344 | struct lttng_ctx_field *fields; | |
345 | unsigned int nr_fields; | |
346 | unsigned int allocated_fields; | |
b2cc986a | 347 | unsigned int largest_align; |
37d5e202 MD |
348 | char padding[LTTNG_UST_CTX_PADDING]; |
349 | }; | |
350 | ||
351 | #define LTTNG_UST_EVENT_DESC_PADDING 40 | |
352 | struct lttng_event_desc { | |
353 | const char *name; | |
fbdeb5ec | 354 | void (*probe_callback)(void); |
37d5e202 MD |
355 | const struct lttng_event_ctx *ctx; /* context */ |
356 | const struct lttng_event_field *fields; /* event payload */ | |
357 | unsigned int nr_fields; | |
358 | const int **loglevel; | |
68755429 | 359 | const char *signature; /* Argument types/names received */ |
6ddc916d MD |
360 | union { |
361 | struct { | |
362 | const char **model_emf_uri; | |
d8d2416d | 363 | void (*event_notifier_callback)(void); |
6ddc916d MD |
364 | } ext; |
365 | char padding[LTTNG_UST_EVENT_DESC_PADDING]; | |
366 | } u; | |
37d5e202 MD |
367 | }; |
368 | ||
71d31690 | 369 | #define LTTNG_UST_PROBE_DESC_PADDING 12 |
37d5e202 MD |
370 | struct lttng_probe_desc { |
371 | const char *provider; | |
372 | const struct lttng_event_desc **event_desc; | |
373 | unsigned int nr_events; | |
374 | struct cds_list_head head; /* chain registered probes */ | |
6715d7d1 MD |
375 | struct cds_list_head lazy_init_head; |
376 | int lazy; /* lazy registration */ | |
71d31690 MD |
377 | uint32_t major; |
378 | uint32_t minor; | |
37d5e202 | 379 | char padding[LTTNG_UST_PROBE_DESC_PADDING]; |
8020ceb5 MD |
380 | }; |
381 | ||
37d5e202 MD |
382 | /* Data structures used by the tracer. */ |
383 | ||
e450e339 FD |
384 | enum lttng_enabler_format_type { |
385 | LTTNG_ENABLER_FORMAT_STAR_GLOB, | |
386 | LTTNG_ENABLER_FORMAT_EVENT, | |
e6c12e3d MD |
387 | }; |
388 | ||
389 | /* | |
e58095ef MD |
390 | * Enabler field, within whatever object is enabling an event. Target of |
391 | * backward reference. | |
e6c12e3d | 392 | */ |
e58095ef | 393 | struct lttng_enabler { |
e450e339 | 394 | enum lttng_enabler_format_type format_type; |
e58095ef MD |
395 | |
396 | /* head list of struct lttng_ust_filter_bytecode_node */ | |
397 | struct cds_list_head filter_bytecode_head; | |
0f63324a JI |
398 | /* head list of struct lttng_ust_excluder_node */ |
399 | struct cds_list_head excluder_head; | |
e58095ef MD |
400 | |
401 | struct lttng_ust_event event_param; | |
e58095ef | 402 | unsigned int enabled:1; |
e6c12e3d MD |
403 | }; |
404 | ||
c8fcf224 MD |
405 | struct tp_list_entry { |
406 | struct lttng_ust_tracepoint_iter tp; | |
407 | struct cds_list_head head; | |
408 | }; | |
409 | ||
410 | struct lttng_ust_tracepoint_list { | |
411 | struct tp_list_entry *iter; | |
412 | struct cds_list_head head; | |
8020ceb5 MD |
413 | }; |
414 | ||
06d4f27e MD |
415 | struct tp_field_list_entry { |
416 | struct lttng_ust_field_iter field; | |
417 | struct cds_list_head head; | |
418 | }; | |
419 | ||
420 | struct lttng_ust_field_list { | |
421 | struct tp_field_list_entry *iter; | |
422 | struct cds_list_head head; | |
423 | }; | |
424 | ||
8165c8da | 425 | struct ust_pending_probe; |
7dd08bec | 426 | struct lttng_event; |
f488575f | 427 | |
8a92ed2a | 428 | /* |
04aa13f8 | 429 | * Bytecode interpreter return value masks. |
8a92ed2a | 430 | */ |
04aa13f8 FD |
431 | enum lttng_bytecode_interpreter_ret { |
432 | LTTNG_INTERPRETER_DISCARD = 0, | |
433 | LTTNG_INTERPRETER_RECORD_FLAG = (1ULL << 0), | |
8a92ed2a MD |
434 | /* Other bits are kept for future use. */ |
435 | }; | |
436 | ||
73d37531 FD |
437 | /* |
438 | * This structure is used in the probes. More specifically, the `filter` and | |
439 | * `node` fields are explicity used in the probes. When modifying this | |
440 | * structure we must not change the layout of these two fields as it is | |
441 | * considered ABI. | |
442 | */ | |
f488575f MD |
443 | struct lttng_bytecode_runtime { |
444 | /* Associated bytecode */ | |
ab249ecf | 445 | struct lttng_ust_bytecode_node *bc; |
c42416df FD |
446 | union { |
447 | uint64_t (*filter)(void *interpreter_data, | |
448 | const char *interpreter_stack_data); | |
449 | } interpreter_funcs; | |
21af05a9 | 450 | int link_failed; |
e58095ef | 451 | struct cds_list_head node; /* list of bytecode runtime in event */ |
b77aaa1b | 452 | /* |
d8d2416d FD |
453 | * Pointer to a URCU-protected pointer owned by an `struct |
454 | * lttng_session`or `struct lttng_event_notifier_group`. | |
b77aaa1b FD |
455 | */ |
456 | struct lttng_ctx **pctx; | |
e58095ef MD |
457 | }; |
458 | ||
459 | /* | |
d8d2416d FD |
460 | * Objects in a linked-list of enablers, owned by an event or event_notifier. |
461 | * This is used because an event (or a event_notifier) can be enabled by more | |
462 | * than one enabler and we want a quick way to iterate over all enablers of an | |
463 | * object. | |
464 | * | |
465 | * For example, event rules "my_app:a*" and "my_app:ab*" will both match the | |
466 | * event with the name "my_app:abc". | |
e58095ef MD |
467 | */ |
468 | struct lttng_enabler_ref { | |
469 | struct cds_list_head node; /* enabler ref list */ | |
470 | struct lttng_enabler *ref; /* backward ref */ | |
f488575f | 471 | }; |
8165c8da | 472 | |
8020ceb5 | 473 | /* |
7dd08bec MD |
474 | * lttng_event structure is referred to by the tracing fast path. It |
475 | * must be kept small. | |
180901e6 MD |
476 | * |
477 | * IMPORTANT: this structure is part of the ABI between the probe and | |
478 | * UST. Fields need to be only added at the end, never reordered, never | |
479 | * removed. | |
8020ceb5 | 480 | */ |
7dd08bec | 481 | struct lttng_event { |
180901e6 | 482 | /* LTTng-UST 2.0 starts here */ |
8020ceb5 | 483 | unsigned int id; |
7dd08bec | 484 | struct lttng_channel *chan; |
976fe9ea | 485 | int enabled; |
8020ceb5 | 486 | const struct lttng_event_desc *desc; |
e58095ef | 487 | void *_deprecated1; |
8020ceb5 | 488 | struct lttng_ctx *ctx; |
9f3fdbc6 | 489 | enum lttng_ust_instrumentation instrumentation; |
e58095ef MD |
490 | struct cds_list_head node; /* Event list in session */ |
491 | struct cds_list_head _deprecated2; | |
492 | void *_deprecated3; | |
13b21cd6 | 493 | unsigned int _deprecated4:1; |
e58095ef | 494 | |
180901e6 | 495 | /* LTTng-UST 2.1 starts here */ |
e58095ef | 496 | /* list of struct lttng_bytecode_runtime, sorted by seqnum */ |
a56fd376 | 497 | struct cds_list_head filter_bytecode_runtime_head; |
dcdeaff0 | 498 | int has_enablers_without_bytecode; |
e58095ef MD |
499 | /* Backward references: list of lttng_enabler_ref (ref to enablers) */ |
500 | struct cds_list_head enablers_ref_head; | |
d56fa719 | 501 | struct cds_hlist_node hlist; /* session ht of events */ |
ac6b4ac6 | 502 | int registered; /* has reg'd tracepoint probe */ |
8020ceb5 MD |
503 | }; |
504 | ||
d8d2416d FD |
505 | struct lttng_event_notifier { |
506 | uint64_t user_token; | |
507 | int enabled; | |
508 | int registered; /* has reg'd tracepoint probe */ | |
509 | struct cds_list_head filter_bytecode_runtime_head; | |
510 | int has_enablers_without_bytecode; | |
511 | struct cds_list_head enablers_ref_head; | |
512 | const struct lttng_event_desc *desc; | |
513 | struct cds_hlist_node hlist; /* hashtable of event_notifiers */ | |
514 | struct cds_list_head node; /* event_notifier list in session */ | |
515 | struct lttng_event_notifier_group *group; /* weak ref */ | |
516 | }; | |
517 | ||
c785c634 MD |
518 | struct lttng_enum { |
519 | const struct lttng_enum_desc *desc; | |
520 | struct lttng_session *session; | |
521 | struct cds_list_head node; /* Enum list in session */ | |
522 | struct cds_hlist_node hlist; /* Session ht of enums */ | |
523 | uint64_t id; /* Enumeration ID in sessiond */ | |
524 | }; | |
525 | ||
8d8a24c8 | 526 | struct channel; |
38fae1d3 | 527 | struct lttng_ust_shm_handle; |
8d8a24c8 | 528 | |
180901e6 MD |
529 | /* |
530 | * IMPORTANT: this structure is part of the ABI between the probe and | |
531 | * UST. Fields need to be only added at the end, never reordered, never | |
532 | * removed. | |
533 | */ | |
7dd08bec MD |
534 | struct lttng_channel_ops { |
535 | struct lttng_channel *(*channel_create)(const char *name, | |
74d81a6c MD |
536 | void *buf_addr, |
537 | size_t subbuf_size, size_t num_subbuf, | |
538 | unsigned int switch_timer_interval, | |
539 | unsigned int read_timer_interval, | |
6ca18e66 | 540 | unsigned char *uuid, |
a9ff648c | 541 | uint32_t chan_id, |
b2c5f61a MD |
542 | const int *stream_fds, int nr_stream_fds, |
543 | int64_t blocking_timeout); | |
74d81a6c | 544 | void (*channel_destroy)(struct lttng_channel *chan); |
a44c74d9 MD |
545 | union { |
546 | void *_deprecated1; | |
f9ec4a97 MD |
547 | /* |
548 | * has_strcpy is needed by probe providers version 1.0 to | |
549 | * dynamically detect whether the LTTng-UST tracepoint | |
550 | * provider ABI implements event_strcpy. Starting from | |
551 | * probe providers version 2.0, the check is not needed, | |
552 | * but backward compatibility is provided for older versions. | |
553 | */ | |
a44c74d9 MD |
554 | unsigned long has_strcpy:1; /* ABI has strcpy */ |
555 | } u; | |
9e917229 | 556 | void *_deprecated2; |
4cfec15c | 557 | int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
8020ceb5 | 558 | uint32_t event_id); |
4cfec15c | 559 | void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx); |
74d81a6c MD |
560 | void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
561 | const void *src, size_t len); | |
8020ceb5 MD |
562 | /* |
563 | * packet_avail_size returns the available size in the current | |
564 | * packet. Note that the size returned is only a hint, since it | |
565 | * may change due to concurrent writes. | |
566 | */ | |
1d498196 | 567 | size_t (*packet_avail_size)(struct channel *chan, |
38fae1d3 | 568 | struct lttng_ust_shm_handle *handle); |
9f3fdbc6 MD |
569 | //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan); |
570 | //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan); | |
8020ceb5 MD |
571 | int (*is_finalized)(struct channel *chan); |
572 | int (*is_disabled)(struct channel *chan); | |
38fae1d3 | 573 | int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle); |
a44c74d9 MD |
574 | void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
575 | const char *src, size_t len); | |
8020ceb5 MD |
576 | }; |
577 | ||
180901e6 MD |
578 | /* |
579 | * IMPORTANT: this structure is part of the ABI between the probe and | |
580 | * UST. Fields need to be only added at the end, never reordered, never | |
581 | * removed. | |
582 | */ | |
7dd08bec | 583 | struct lttng_channel { |
a3f61e7f MD |
584 | /* |
585 | * The pointers located in this private data are NOT safe to be | |
586 | * dereferenced by the consumer. The only operations the | |
587 | * consumer process is designed to be allowed to do is to read | |
588 | * and perform subbuffer flush. | |
589 | */ | |
8020ceb5 | 590 | struct channel *chan; /* Channel buffers */ |
976fe9ea | 591 | int enabled; |
8020ceb5 MD |
592 | struct lttng_ctx *ctx; |
593 | /* Event ID management */ | |
7dd08bec | 594 | struct lttng_session *session; |
0a42beb6 | 595 | int objd; /* Object associated to channel */ |
32ce8569 MD |
596 | unsigned int _deprecated1; |
597 | unsigned int _deprecated2; | |
e58095ef | 598 | struct cds_list_head node; /* Channel list in session */ |
74d81a6c | 599 | const struct lttng_channel_ops *ops; |
8020ceb5 | 600 | int header_type; /* 0: unset, 1: compact, 2: large */ |
38fae1d3 | 601 | struct lttng_ust_shm_handle *handle; /* shared-memory handle */ |
13b21cd6 | 602 | unsigned int _deprecated3:1; |
a3f61e7f | 603 | |
74d81a6c | 604 | /* Channel ID */ |
a3f61e7f | 605 | unsigned int id; |
74d81a6c | 606 | enum lttng_ust_chan_type type; |
19d8b1b3 | 607 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
ac6b4ac6 | 608 | int tstate:1; /* Transient enable state */ |
8020ceb5 MD |
609 | }; |
610 | ||
53569322 MD |
611 | #define LTTNG_UST_STACK_CTX_PADDING 32 |
612 | struct lttng_stack_ctx { | |
613 | struct lttng_event *event; | |
614 | struct lttng_ctx *chan_ctx; /* RCU dereferenced. */ | |
615 | struct lttng_ctx *event_ctx; /* RCU dereferenced. */ | |
616 | char padding[LTTNG_UST_STACK_CTX_PADDING]; | |
617 | }; | |
618 | ||
71a9d034 | 619 | #define LTTNG_UST_EVENT_HT_BITS 12 |
e58095ef MD |
620 | #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS) |
621 | ||
622 | struct lttng_ust_event_ht { | |
623 | struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE]; | |
624 | }; | |
625 | ||
d8d2416d FD |
626 | #define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12 |
627 | #define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS) | |
628 | struct lttng_ust_event_notifier_ht { | |
629 | struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE]; | |
630 | }; | |
631 | ||
c785c634 MD |
632 | #define LTTNG_UST_ENUM_HT_BITS 12 |
633 | #define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS) | |
634 | ||
635 | struct lttng_ust_enum_ht { | |
636 | struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE]; | |
637 | }; | |
638 | ||
180901e6 MD |
639 | /* |
640 | * IMPORTANT: this structure is part of the ABI between the probe and | |
641 | * UST. Fields need to be only added at the end, never reordered, never | |
642 | * removed. | |
643 | */ | |
7dd08bec | 644 | struct lttng_session { |
e58095ef MD |
645 | int active; /* Is trace session active ? */ |
646 | int been_active; /* Been active ? */ | |
647 | int objd; /* Object associated */ | |
13b21cd6 | 648 | void *_deprecated1; |
e58095ef MD |
649 | struct cds_list_head chan_head; /* Channel list head */ |
650 | struct cds_list_head events_head; /* list of events */ | |
13b21cd6 | 651 | struct cds_list_head _deprecated2; |
e58095ef | 652 | struct cds_list_head node; /* Session list */ |
13b21cd6 MD |
653 | int _deprecated3; |
654 | unsigned int _deprecated4:1; | |
e58095ef MD |
655 | |
656 | /* New UST 2.1 */ | |
657 | /* List of enablers */ | |
658 | struct cds_list_head enablers_head; | |
d56fa719 | 659 | struct lttng_ust_event_ht events_ht; /* ht of events */ |
32ce8569 | 660 | void *owner; /* object owner */ |
ac6b4ac6 | 661 | int tstate:1; /* Transient enable state */ |
246be17e PW |
662 | |
663 | /* New UST 2.4 */ | |
664 | int statedump_pending:1; | |
c785c634 MD |
665 | |
666 | /* New UST 2.8 */ | |
667 | struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */ | |
668 | struct cds_list_head enums_head; | |
53569322 | 669 | struct lttng_ctx *ctx; /* contexts for filters. */ |
8020ceb5 MD |
670 | }; |
671 | ||
d8d2416d FD |
672 | struct lttng_event_notifier_group { |
673 | int objd; | |
674 | void *owner; | |
675 | int notification_fd; | |
676 | struct cds_list_head node; /* Event notifier group handle list */ | |
677 | struct cds_list_head enablers_head; | |
678 | struct cds_list_head event_notifiers_head; /* list of event_notifiers */ | |
679 | struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */ | |
680 | struct lttng_ctx *ctx; /* contexts for filters. */ | |
681 | }; | |
682 | ||
7dd08bec | 683 | struct lttng_transport { |
8020ceb5 | 684 | char *name; |
9f3fdbc6 | 685 | struct cds_list_head node; |
7dd08bec | 686 | struct lttng_channel_ops ops; |
74d81a6c | 687 | const struct lttng_ust_lib_ring_buffer_config *client_config; |
8020ceb5 MD |
688 | }; |
689 | ||
7dd08bec MD |
690 | struct lttng_session *lttng_session_create(void); |
691 | int lttng_session_enable(struct lttng_session *session); | |
692 | int lttng_session_disable(struct lttng_session *session); | |
710b8ee3 | 693 | int lttng_session_statedump(struct lttng_session *session); |
7dd08bec | 694 | void lttng_session_destroy(struct lttng_session *session); |
8020ceb5 | 695 | |
d8d2416d FD |
696 | void lttng_event_notifier_notification_send( |
697 | struct lttng_event_notifier *event_notifier); | |
698 | ||
7dd08bec | 699 | struct lttng_channel *lttng_channel_create(struct lttng_session *session, |
8020ceb5 MD |
700 | const char *transport_name, |
701 | void *buf_addr, | |
702 | size_t subbuf_size, size_t num_subbuf, | |
703 | unsigned int switch_timer_interval, | |
193183fb | 704 | unsigned int read_timer_interval, |
ef9ff354 MD |
705 | int **shm_fd, int **wait_fd, |
706 | uint64_t **memory_map_size, | |
7dd08bec | 707 | struct lttng_channel *chan_priv_init); |
8020ceb5 | 708 | |
7dd08bec MD |
709 | int lttng_channel_enable(struct lttng_channel *channel); |
710 | int lttng_channel_disable(struct lttng_channel *channel); | |
e58095ef | 711 | |
e58095ef | 712 | int lttng_attach_context(struct lttng_ust_context *context_param, |
8e696cfa | 713 | union ust_args *uargs, |
e58095ef | 714 | struct lttng_ctx **ctx, struct lttng_session *session); |
53569322 | 715 | int lttng_session_context_init(struct lttng_ctx **ctx); |
976fe9ea | 716 | |
7dd08bec MD |
717 | void lttng_transport_register(struct lttng_transport *transport); |
718 | void lttng_transport_unregister(struct lttng_transport *transport); | |
8020ceb5 | 719 | |
4b4de73e | 720 | void synchronize_trace(void); |
8020ceb5 | 721 | |
7dd08bec MD |
722 | int lttng_probe_register(struct lttng_probe_desc *desc); |
723 | void lttng_probe_unregister(struct lttng_probe_desc *desc); | |
35ac38cb | 724 | void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc); |
5f733922 | 725 | int lttng_fix_pending_events(void); |
7dd08bec MD |
726 | int lttng_probes_init(void); |
727 | void lttng_probes_exit(void); | |
8173ec7c | 728 | int lttng_find_context(struct lttng_ctx *ctx, const char *name); |
77aa5901 | 729 | int lttng_get_context_index(struct lttng_ctx *ctx, const char *name); |
8173ec7c | 730 | struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p); |
b2cc986a | 731 | void lttng_context_update(struct lttng_ctx *ctx); |
8173ec7c | 732 | void lttng_remove_context_field(struct lttng_ctx **ctx_p, |
8020ceb5 MD |
733 | struct lttng_ctx_field *field); |
734 | void lttng_destroy_context(struct lttng_ctx *ctx); | |
3b402b40 | 735 | int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx); |
c1ef86f0 | 736 | int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx); |
8173ec7c | 737 | int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx); |
4847e9bb | 738 | int lttng_add_procname_to_ctx(struct lttng_ctx **ctx); |
96f85541 | 739 | int lttng_add_ip_to_ctx(struct lttng_ctx **ctx); |
c7ea8487 | 740 | int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx); |
53569322 | 741 | int lttng_add_dyntest_to_ctx(struct lttng_ctx **ctx); |
735bef47 MJ |
742 | int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx); |
743 | int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx); | |
744 | int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx); | |
745 | int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx); | |
746 | int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx); | |
cefef7a7 | 747 | int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx); |
735bef47 MJ |
748 | int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx); |
749 | int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx); | |
fca2f191 MJ |
750 | int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx); |
751 | int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx); | |
752 | int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx); | |
753 | int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx); | |
754 | int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx); | |
755 | int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx); | |
a93bfc45 | 756 | void lttng_context_vtid_reset(void); |
c1ef86f0 | 757 | void lttng_context_vpid_reset(void); |
46228a6f | 758 | void lttng_context_procname_reset(void); |
735bef47 MJ |
759 | void lttng_context_cgroup_ns_reset(void); |
760 | void lttng_context_ipc_ns_reset(void); | |
761 | void lttng_context_mnt_ns_reset(void); | |
762 | void lttng_context_net_ns_reset(void); | |
763 | void lttng_context_pid_ns_reset(void); | |
cefef7a7 | 764 | void lttng_context_time_ns_reset(void); |
735bef47 MJ |
765 | void lttng_context_user_ns_reset(void); |
766 | void lttng_context_uts_ns_reset(void); | |
fca2f191 MJ |
767 | void lttng_context_vuid_reset(void); |
768 | void lttng_context_veuid_reset(void); | |
769 | void lttng_context_vsuid_reset(void); | |
770 | void lttng_context_vgid_reset(void); | |
771 | void lttng_context_vegid_reset(void); | |
772 | void lttng_context_vsgid_reset(void); | |
9f3fdbc6 | 773 | |
d58d1454 MD |
774 | #ifdef LTTNG_UST_HAVE_PERF_EVENT |
775 | int lttng_add_perf_counter_to_ctx(uint32_t type, | |
776 | uint64_t config, | |
777 | const char *name, | |
778 | struct lttng_ctx **ctx); | |
779 | int lttng_perf_counter_init(void); | |
780 | void lttng_perf_counter_exit(void); | |
781 | #else /* #ifdef LTTNG_UST_HAVE_PERF_EVENT */ | |
782 | static inline | |
783 | int lttng_add_perf_counter_to_ctx(uint32_t type, | |
784 | uint64_t config, | |
785 | const char *name, | |
786 | struct lttng_ctx **ctx) | |
787 | { | |
788 | return -ENOSYS; | |
789 | } | |
790 | static inline | |
791 | int lttng_perf_counter_init(void) | |
792 | { | |
793 | return 0; | |
794 | } | |
795 | static inline | |
796 | void lttng_perf_counter_exit(void) | |
797 | { | |
798 | } | |
799 | #endif /* #else #ifdef LTTNG_UST_HAVE_PERF_EVENT */ | |
800 | ||
82b9bde8 JD |
801 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata; |
802 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_discard; | |
803 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite; | |
c1fca457 | 804 | |
7dd08bec | 805 | struct lttng_transport *lttng_transport_find(const char *name); |
c1fca457 | 806 | |
7dd08bec MD |
807 | int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list); |
808 | void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list); | |
c8fcf224 MD |
809 | struct lttng_ust_tracepoint_iter * |
810 | lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list); | |
7dd08bec MD |
811 | int lttng_probes_get_field_list(struct lttng_ust_field_list *list); |
812 | void lttng_probes_prune_field_list(struct lttng_ust_field_list *list); | |
06d4f27e MD |
813 | struct lttng_ust_field_iter * |
814 | lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list); | |
c8fcf224 | 815 | |
7dd08bec | 816 | void lttng_free_event_filter_runtime(struct lttng_event *event); |
e58095ef MD |
817 | |
818 | struct cds_list_head *lttng_get_probe_list_head(void); | |
6715d7d1 | 819 | int lttng_session_active(void); |
e6c12e3d | 820 | |
246be17e | 821 | typedef int (*t_statedump_func_ptr)(struct lttng_session *session); |
3327ac33 | 822 | void lttng_handle_pending_statedump(void *owner); |
37dddb65 | 823 | struct cds_list_head *_lttng_get_sessions(void); |
b33b46f7 FD |
824 | |
825 | struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session, | |
826 | const struct lttng_enum_desc *enum_desc); | |
246be17e | 827 | |
97c7c238 | 828 | void lttng_ust_dl_update(void *ip); |
6548fca4 | 829 | void lttng_ust_fixup_fd_tracker_tls(void); |
97c7c238 | 830 | |
4a1f7569 MD |
831 | /* For backward compatibility. Leave those exported symbols in place. */ |
832 | extern struct lttng_ctx *lttng_static_ctx; | |
92495593 FD |
833 | struct lttng_ust_filter_bytecode_node; |
834 | struct lttng_ust_excluder_node; | |
4a1f7569 MD |
835 | void lttng_context_init(void); |
836 | void lttng_context_exit(void); | |
a211b293 | 837 | void lttng_filter_event_link_bytecode(struct lttng_event *event); |
d871c65b FD |
838 | struct lttng_enabler *lttng_enabler_create( |
839 | enum lttng_enabler_format_type format_type, | |
840 | struct lttng_ust_event *event_param, | |
841 | struct lttng_channel *chan); | |
842 | int lttng_enabler_enable(struct lttng_enabler *enabler); | |
843 | int lttng_enabler_disable(struct lttng_enabler *enabler); | |
844 | int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler, | |
845 | struct lttng_ust_filter_bytecode_node *bytecode); | |
846 | int lttng_enabler_attach_context(struct lttng_enabler *enabler, | |
847 | struct lttng_ust_context *ctx); | |
848 | int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler, | |
849 | struct lttng_ust_excluder_node *excluder); | |
850 | void lttng_enabler_event_link_bytecode(struct lttng_event *event, | |
851 | struct lttng_enabler *enabler); | |
4d451c15 | 852 | void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime); |
4a1f7569 | 853 | |
6453d237 MD |
854 | #ifdef __cplusplus |
855 | } | |
856 | #endif | |
857 | ||
51489cad | 858 | #endif /* _LTTNG_UST_EVENTS_H */ |