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; | |
363 | } ext; | |
364 | char padding[LTTNG_UST_EVENT_DESC_PADDING]; | |
365 | } u; | |
37d5e202 MD |
366 | }; |
367 | ||
71d31690 | 368 | #define LTTNG_UST_PROBE_DESC_PADDING 12 |
37d5e202 MD |
369 | struct lttng_probe_desc { |
370 | const char *provider; | |
371 | const struct lttng_event_desc **event_desc; | |
372 | unsigned int nr_events; | |
373 | struct cds_list_head head; /* chain registered probes */ | |
6715d7d1 MD |
374 | struct cds_list_head lazy_init_head; |
375 | int lazy; /* lazy registration */ | |
71d31690 MD |
376 | uint32_t major; |
377 | uint32_t minor; | |
37d5e202 | 378 | char padding[LTTNG_UST_PROBE_DESC_PADDING]; |
8020ceb5 MD |
379 | }; |
380 | ||
37d5e202 MD |
381 | /* Data structures used by the tracer. */ |
382 | ||
e58095ef | 383 | enum lttng_enabler_type { |
196ec2df | 384 | LTTNG_ENABLER_STAR_GLOB, |
e58095ef | 385 | LTTNG_ENABLER_EVENT, |
e6c12e3d MD |
386 | }; |
387 | ||
388 | /* | |
e58095ef MD |
389 | * Enabler field, within whatever object is enabling an event. Target of |
390 | * backward reference. | |
e6c12e3d | 391 | */ |
e58095ef MD |
392 | struct lttng_enabler { |
393 | enum lttng_enabler_type type; | |
394 | ||
395 | /* head list of struct lttng_ust_filter_bytecode_node */ | |
396 | struct cds_list_head filter_bytecode_head; | |
0f63324a JI |
397 | /* head list of struct lttng_ust_excluder_node */ |
398 | struct cds_list_head excluder_head; | |
e58095ef MD |
399 | struct cds_list_head node; /* per-session list of enablers */ |
400 | ||
401 | struct lttng_ust_event event_param; | |
402 | struct lttng_channel *chan; | |
416165a5 FD |
403 | /* |
404 | * Unused, but kept around to make it explicit that the tracer can do | |
405 | * it. | |
406 | */ | |
e58095ef MD |
407 | struct lttng_ctx *ctx; |
408 | unsigned int enabled:1; | |
e6c12e3d MD |
409 | }; |
410 | ||
c8fcf224 MD |
411 | struct tp_list_entry { |
412 | struct lttng_ust_tracepoint_iter tp; | |
413 | struct cds_list_head head; | |
414 | }; | |
415 | ||
416 | struct lttng_ust_tracepoint_list { | |
417 | struct tp_list_entry *iter; | |
418 | struct cds_list_head head; | |
8020ceb5 MD |
419 | }; |
420 | ||
06d4f27e MD |
421 | struct tp_field_list_entry { |
422 | struct lttng_ust_field_iter field; | |
423 | struct cds_list_head head; | |
424 | }; | |
425 | ||
426 | struct lttng_ust_field_list { | |
427 | struct tp_field_list_entry *iter; | |
428 | struct cds_list_head head; | |
429 | }; | |
430 | ||
8165c8da | 431 | struct ust_pending_probe; |
7dd08bec | 432 | struct lttng_event; |
f488575f MD |
433 | |
434 | struct lttng_ust_filter_bytecode_node { | |
435 | struct cds_list_head node; | |
e58095ef | 436 | struct lttng_enabler *enabler; |
a543151c MD |
437 | /* |
438 | * struct lttng_ust_filter_bytecode has var. sized array, must | |
439 | * be last field. | |
440 | */ | |
441 | struct lttng_ust_filter_bytecode bc; | |
f488575f MD |
442 | }; |
443 | ||
0f63324a JI |
444 | struct lttng_ust_excluder_node { |
445 | struct cds_list_head node; | |
446 | struct lttng_enabler *enabler; | |
447 | /* | |
448 | * struct lttng_ust_event_exclusion had variable sized array, | |
449 | * must be last field. | |
450 | */ | |
451 | struct lttng_ust_event_exclusion excluder; | |
452 | }; | |
8a92ed2a MD |
453 | /* |
454 | * Filter return value masks. | |
455 | */ | |
456 | enum lttng_filter_ret { | |
457 | LTTNG_FILTER_DISCARD = 0, | |
458 | LTTNG_FILTER_RECORD_FLAG = (1ULL << 0), | |
459 | /* Other bits are kept for future use. */ | |
460 | }; | |
461 | ||
73d37531 FD |
462 | /* |
463 | * This structure is used in the probes. More specifically, the `filter` and | |
464 | * `node` fields are explicity used in the probes. When modifying this | |
465 | * structure we must not change the layout of these two fields as it is | |
466 | * considered ABI. | |
467 | */ | |
f488575f MD |
468 | struct lttng_bytecode_runtime { |
469 | /* Associated bytecode */ | |
470 | struct lttng_ust_filter_bytecode_node *bc; | |
8a92ed2a | 471 | uint64_t (*filter)(void *filter_data, const char *filter_stack_data); |
21af05a9 | 472 | int link_failed; |
e58095ef | 473 | struct cds_list_head node; /* list of bytecode runtime in event */ |
53569322 | 474 | struct lttng_session *session; |
e58095ef MD |
475 | }; |
476 | ||
477 | /* | |
478 | * Objects in a linked-list of enablers, owned by an event. | |
479 | */ | |
480 | struct lttng_enabler_ref { | |
481 | struct cds_list_head node; /* enabler ref list */ | |
482 | struct lttng_enabler *ref; /* backward ref */ | |
f488575f | 483 | }; |
8165c8da | 484 | |
8020ceb5 | 485 | /* |
7dd08bec MD |
486 | * lttng_event structure is referred to by the tracing fast path. It |
487 | * must be kept small. | |
180901e6 MD |
488 | * |
489 | * IMPORTANT: this structure is part of the ABI between the probe and | |
490 | * UST. Fields need to be only added at the end, never reordered, never | |
491 | * removed. | |
8020ceb5 | 492 | */ |
7dd08bec | 493 | struct lttng_event { |
180901e6 | 494 | /* LTTng-UST 2.0 starts here */ |
8020ceb5 | 495 | unsigned int id; |
7dd08bec | 496 | struct lttng_channel *chan; |
976fe9ea | 497 | int enabled; |
8020ceb5 | 498 | const struct lttng_event_desc *desc; |
e58095ef | 499 | void *_deprecated1; |
8020ceb5 | 500 | struct lttng_ctx *ctx; |
9f3fdbc6 | 501 | enum lttng_ust_instrumentation instrumentation; |
e58095ef MD |
502 | struct cds_list_head node; /* Event list in session */ |
503 | struct cds_list_head _deprecated2; | |
504 | void *_deprecated3; | |
13b21cd6 | 505 | unsigned int _deprecated4:1; |
e58095ef | 506 | |
180901e6 | 507 | /* LTTng-UST 2.1 starts here */ |
e58095ef MD |
508 | /* list of struct lttng_bytecode_runtime, sorted by seqnum */ |
509 | struct cds_list_head bytecode_runtime_head; | |
dcdeaff0 | 510 | int has_enablers_without_bytecode; |
e58095ef MD |
511 | /* Backward references: list of lttng_enabler_ref (ref to enablers) */ |
512 | struct cds_list_head enablers_ref_head; | |
d56fa719 | 513 | struct cds_hlist_node hlist; /* session ht of events */ |
ac6b4ac6 | 514 | int registered; /* has reg'd tracepoint probe */ |
8020ceb5 MD |
515 | }; |
516 | ||
c785c634 MD |
517 | struct lttng_enum { |
518 | const struct lttng_enum_desc *desc; | |
519 | struct lttng_session *session; | |
520 | struct cds_list_head node; /* Enum list in session */ | |
521 | struct cds_hlist_node hlist; /* Session ht of enums */ | |
522 | uint64_t id; /* Enumeration ID in sessiond */ | |
523 | }; | |
524 | ||
8d8a24c8 | 525 | struct channel; |
38fae1d3 | 526 | struct lttng_ust_shm_handle; |
8d8a24c8 | 527 | |
180901e6 MD |
528 | /* |
529 | * IMPORTANT: this structure is part of the ABI between the probe and | |
530 | * UST. Fields need to be only added at the end, never reordered, never | |
531 | * removed. | |
532 | */ | |
7dd08bec MD |
533 | struct lttng_channel_ops { |
534 | struct lttng_channel *(*channel_create)(const char *name, | |
74d81a6c MD |
535 | void *buf_addr, |
536 | size_t subbuf_size, size_t num_subbuf, | |
537 | unsigned int switch_timer_interval, | |
538 | unsigned int read_timer_interval, | |
6ca18e66 | 539 | unsigned char *uuid, |
a9ff648c | 540 | uint32_t chan_id, |
b2c5f61a MD |
541 | const int *stream_fds, int nr_stream_fds, |
542 | int64_t blocking_timeout); | |
74d81a6c | 543 | void (*channel_destroy)(struct lttng_channel *chan); |
a44c74d9 MD |
544 | union { |
545 | void *_deprecated1; | |
f9ec4a97 MD |
546 | /* |
547 | * has_strcpy is needed by probe providers version 1.0 to | |
548 | * dynamically detect whether the LTTng-UST tracepoint | |
549 | * provider ABI implements event_strcpy. Starting from | |
550 | * probe providers version 2.0, the check is not needed, | |
551 | * but backward compatibility is provided for older versions. | |
552 | */ | |
a44c74d9 MD |
553 | unsigned long has_strcpy:1; /* ABI has strcpy */ |
554 | } u; | |
9e917229 | 555 | void *_deprecated2; |
4cfec15c | 556 | int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
8020ceb5 | 557 | uint32_t event_id); |
4cfec15c | 558 | void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx); |
74d81a6c MD |
559 | void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
560 | const void *src, size_t len); | |
8020ceb5 MD |
561 | /* |
562 | * packet_avail_size returns the available size in the current | |
563 | * packet. Note that the size returned is only a hint, since it | |
564 | * may change due to concurrent writes. | |
565 | */ | |
1d498196 | 566 | size_t (*packet_avail_size)(struct channel *chan, |
38fae1d3 | 567 | struct lttng_ust_shm_handle *handle); |
9f3fdbc6 MD |
568 | //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan); |
569 | //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan); | |
8020ceb5 MD |
570 | int (*is_finalized)(struct channel *chan); |
571 | int (*is_disabled)(struct channel *chan); | |
38fae1d3 | 572 | int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle); |
a44c74d9 MD |
573 | void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
574 | const char *src, size_t len); | |
8020ceb5 MD |
575 | }; |
576 | ||
180901e6 MD |
577 | /* |
578 | * IMPORTANT: this structure is part of the ABI between the probe and | |
579 | * UST. Fields need to be only added at the end, never reordered, never | |
580 | * removed. | |
581 | */ | |
7dd08bec | 582 | struct lttng_channel { |
a3f61e7f MD |
583 | /* |
584 | * The pointers located in this private data are NOT safe to be | |
585 | * dereferenced by the consumer. The only operations the | |
586 | * consumer process is designed to be allowed to do is to read | |
587 | * and perform subbuffer flush. | |
588 | */ | |
8020ceb5 | 589 | struct channel *chan; /* Channel buffers */ |
976fe9ea | 590 | int enabled; |
8020ceb5 MD |
591 | struct lttng_ctx *ctx; |
592 | /* Event ID management */ | |
7dd08bec | 593 | struct lttng_session *session; |
0a42beb6 | 594 | int objd; /* Object associated to channel */ |
32ce8569 MD |
595 | unsigned int _deprecated1; |
596 | unsigned int _deprecated2; | |
e58095ef | 597 | struct cds_list_head node; /* Channel list in session */ |
74d81a6c | 598 | const struct lttng_channel_ops *ops; |
8020ceb5 | 599 | int header_type; /* 0: unset, 1: compact, 2: large */ |
38fae1d3 | 600 | struct lttng_ust_shm_handle *handle; /* shared-memory handle */ |
13b21cd6 | 601 | unsigned int _deprecated3:1; |
a3f61e7f | 602 | |
74d81a6c | 603 | /* Channel ID */ |
a3f61e7f | 604 | unsigned int id; |
74d81a6c | 605 | enum lttng_ust_chan_type type; |
19d8b1b3 | 606 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
ac6b4ac6 | 607 | int tstate:1; /* Transient enable state */ |
8020ceb5 MD |
608 | }; |
609 | ||
53569322 MD |
610 | #define LTTNG_UST_STACK_CTX_PADDING 32 |
611 | struct lttng_stack_ctx { | |
612 | struct lttng_event *event; | |
613 | struct lttng_ctx *chan_ctx; /* RCU dereferenced. */ | |
614 | struct lttng_ctx *event_ctx; /* RCU dereferenced. */ | |
615 | char padding[LTTNG_UST_STACK_CTX_PADDING]; | |
616 | }; | |
617 | ||
71a9d034 | 618 | #define LTTNG_UST_EVENT_HT_BITS 12 |
e58095ef MD |
619 | #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS) |
620 | ||
621 | struct lttng_ust_event_ht { | |
622 | struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE]; | |
623 | }; | |
624 | ||
c785c634 MD |
625 | #define LTTNG_UST_ENUM_HT_BITS 12 |
626 | #define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS) | |
627 | ||
628 | struct lttng_ust_enum_ht { | |
629 | struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE]; | |
630 | }; | |
631 | ||
180901e6 MD |
632 | /* |
633 | * IMPORTANT: this structure is part of the ABI between the probe and | |
634 | * UST. Fields need to be only added at the end, never reordered, never | |
635 | * removed. | |
636 | */ | |
7dd08bec | 637 | struct lttng_session { |
e58095ef MD |
638 | int active; /* Is trace session active ? */ |
639 | int been_active; /* Been active ? */ | |
640 | int objd; /* Object associated */ | |
13b21cd6 | 641 | void *_deprecated1; |
e58095ef MD |
642 | struct cds_list_head chan_head; /* Channel list head */ |
643 | struct cds_list_head events_head; /* list of events */ | |
13b21cd6 | 644 | struct cds_list_head _deprecated2; |
e58095ef | 645 | struct cds_list_head node; /* Session list */ |
13b21cd6 MD |
646 | int _deprecated3; |
647 | unsigned int _deprecated4:1; | |
e58095ef MD |
648 | |
649 | /* New UST 2.1 */ | |
650 | /* List of enablers */ | |
651 | struct cds_list_head enablers_head; | |
d56fa719 | 652 | struct lttng_ust_event_ht events_ht; /* ht of events */ |
32ce8569 | 653 | void *owner; /* object owner */ |
ac6b4ac6 | 654 | int tstate:1; /* Transient enable state */ |
246be17e PW |
655 | |
656 | /* New UST 2.4 */ | |
657 | int statedump_pending:1; | |
c785c634 MD |
658 | |
659 | /* New UST 2.8 */ | |
660 | struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */ | |
661 | struct cds_list_head enums_head; | |
53569322 | 662 | struct lttng_ctx *ctx; /* contexts for filters. */ |
8020ceb5 MD |
663 | }; |
664 | ||
7dd08bec | 665 | struct lttng_transport { |
8020ceb5 | 666 | char *name; |
9f3fdbc6 | 667 | struct cds_list_head node; |
7dd08bec | 668 | struct lttng_channel_ops ops; |
74d81a6c | 669 | const struct lttng_ust_lib_ring_buffer_config *client_config; |
8020ceb5 MD |
670 | }; |
671 | ||
7dd08bec MD |
672 | struct lttng_session *lttng_session_create(void); |
673 | int lttng_session_enable(struct lttng_session *session); | |
674 | int lttng_session_disable(struct lttng_session *session); | |
710b8ee3 | 675 | int lttng_session_statedump(struct lttng_session *session); |
7dd08bec | 676 | void lttng_session_destroy(struct lttng_session *session); |
8020ceb5 | 677 | |
7dd08bec | 678 | struct lttng_channel *lttng_channel_create(struct lttng_session *session, |
8020ceb5 MD |
679 | const char *transport_name, |
680 | void *buf_addr, | |
681 | size_t subbuf_size, size_t num_subbuf, | |
682 | unsigned int switch_timer_interval, | |
193183fb | 683 | unsigned int read_timer_interval, |
ef9ff354 MD |
684 | int **shm_fd, int **wait_fd, |
685 | uint64_t **memory_map_size, | |
7dd08bec | 686 | struct lttng_channel *chan_priv_init); |
8020ceb5 | 687 | |
7dd08bec MD |
688 | int lttng_channel_enable(struct lttng_channel *channel); |
689 | int lttng_channel_disable(struct lttng_channel *channel); | |
e58095ef MD |
690 | |
691 | struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type, | |
692 | struct lttng_ust_event *event_param, | |
693 | struct lttng_channel *chan); | |
694 | int lttng_enabler_enable(struct lttng_enabler *enabler); | |
695 | int lttng_enabler_disable(struct lttng_enabler *enabler); | |
696 | int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler, | |
697 | struct lttng_ust_filter_bytecode_node *bytecode); | |
698 | int lttng_enabler_attach_context(struct lttng_enabler *enabler, | |
699 | struct lttng_ust_context *ctx); | |
0bfb5cbd JI |
700 | int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler, |
701 | struct lttng_ust_excluder_node *excluder); | |
e58095ef MD |
702 | |
703 | int lttng_attach_context(struct lttng_ust_context *context_param, | |
8e696cfa | 704 | union ust_args *uargs, |
e58095ef | 705 | struct lttng_ctx **ctx, struct lttng_session *session); |
53569322 | 706 | int lttng_session_context_init(struct lttng_ctx **ctx); |
976fe9ea | 707 | |
7dd08bec MD |
708 | void lttng_transport_register(struct lttng_transport *transport); |
709 | void lttng_transport_unregister(struct lttng_transport *transport); | |
8020ceb5 | 710 | |
4b4de73e | 711 | void synchronize_trace(void); |
8020ceb5 | 712 | |
7dd08bec MD |
713 | int lttng_probe_register(struct lttng_probe_desc *desc); |
714 | void lttng_probe_unregister(struct lttng_probe_desc *desc); | |
35ac38cb | 715 | void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc); |
5f733922 | 716 | int lttng_fix_pending_events(void); |
7dd08bec MD |
717 | int lttng_probes_init(void); |
718 | void lttng_probes_exit(void); | |
8173ec7c | 719 | int lttng_find_context(struct lttng_ctx *ctx, const char *name); |
77aa5901 | 720 | int lttng_get_context_index(struct lttng_ctx *ctx, const char *name); |
8173ec7c | 721 | struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p); |
b2cc986a | 722 | void lttng_context_update(struct lttng_ctx *ctx); |
8173ec7c | 723 | void lttng_remove_context_field(struct lttng_ctx **ctx_p, |
8020ceb5 MD |
724 | struct lttng_ctx_field *field); |
725 | void lttng_destroy_context(struct lttng_ctx *ctx); | |
3b402b40 | 726 | int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx); |
c1ef86f0 | 727 | int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx); |
8173ec7c | 728 | int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx); |
4847e9bb | 729 | int lttng_add_procname_to_ctx(struct lttng_ctx **ctx); |
96f85541 | 730 | int lttng_add_ip_to_ctx(struct lttng_ctx **ctx); |
c7ea8487 | 731 | int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx); |
53569322 | 732 | int lttng_add_dyntest_to_ctx(struct lttng_ctx **ctx); |
735bef47 MJ |
733 | int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx); |
734 | int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx); | |
735 | int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx); | |
736 | int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx); | |
737 | int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx); | |
738 | int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx); | |
739 | int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx); | |
fca2f191 MJ |
740 | int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx); |
741 | int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx); | |
742 | int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx); | |
743 | int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx); | |
744 | int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx); | |
745 | int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx); | |
a93bfc45 | 746 | void lttng_context_vtid_reset(void); |
c1ef86f0 | 747 | void lttng_context_vpid_reset(void); |
46228a6f | 748 | void lttng_context_procname_reset(void); |
735bef47 MJ |
749 | void lttng_context_cgroup_ns_reset(void); |
750 | void lttng_context_ipc_ns_reset(void); | |
751 | void lttng_context_mnt_ns_reset(void); | |
752 | void lttng_context_net_ns_reset(void); | |
753 | void lttng_context_pid_ns_reset(void); | |
754 | void lttng_context_user_ns_reset(void); | |
755 | void lttng_context_uts_ns_reset(void); | |
fca2f191 MJ |
756 | void lttng_context_vuid_reset(void); |
757 | void lttng_context_veuid_reset(void); | |
758 | void lttng_context_vsuid_reset(void); | |
759 | void lttng_context_vgid_reset(void); | |
760 | void lttng_context_vegid_reset(void); | |
761 | void lttng_context_vsgid_reset(void); | |
9f3fdbc6 | 762 | |
d58d1454 MD |
763 | #ifdef LTTNG_UST_HAVE_PERF_EVENT |
764 | int lttng_add_perf_counter_to_ctx(uint32_t type, | |
765 | uint64_t config, | |
766 | const char *name, | |
767 | struct lttng_ctx **ctx); | |
768 | int lttng_perf_counter_init(void); | |
769 | void lttng_perf_counter_exit(void); | |
770 | #else /* #ifdef LTTNG_UST_HAVE_PERF_EVENT */ | |
771 | static inline | |
772 | int lttng_add_perf_counter_to_ctx(uint32_t type, | |
773 | uint64_t config, | |
774 | const char *name, | |
775 | struct lttng_ctx **ctx) | |
776 | { | |
777 | return -ENOSYS; | |
778 | } | |
779 | static inline | |
780 | int lttng_perf_counter_init(void) | |
781 | { | |
782 | return 0; | |
783 | } | |
784 | static inline | |
785 | void lttng_perf_counter_exit(void) | |
786 | { | |
787 | } | |
788 | #endif /* #else #ifdef LTTNG_UST_HAVE_PERF_EVENT */ | |
789 | ||
82b9bde8 JD |
790 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata; |
791 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_discard; | |
792 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite; | |
c1fca457 | 793 | |
7dd08bec | 794 | struct lttng_transport *lttng_transport_find(const char *name); |
c1fca457 | 795 | |
7dd08bec MD |
796 | int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list); |
797 | void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list); | |
c8fcf224 MD |
798 | struct lttng_ust_tracepoint_iter * |
799 | lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list); | |
7dd08bec MD |
800 | int lttng_probes_get_field_list(struct lttng_ust_field_list *list); |
801 | void lttng_probes_prune_field_list(struct lttng_ust_field_list *list); | |
06d4f27e MD |
802 | struct lttng_ust_field_iter * |
803 | lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list); | |
c8fcf224 | 804 | |
e58095ef MD |
805 | void lttng_enabler_event_link_bytecode(struct lttng_event *event, |
806 | struct lttng_enabler *enabler); | |
7dd08bec | 807 | void lttng_free_event_filter_runtime(struct lttng_event *event); |
e58095ef MD |
808 | void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime); |
809 | ||
810 | struct cds_list_head *lttng_get_probe_list_head(void); | |
6715d7d1 | 811 | int lttng_session_active(void); |
e6c12e3d | 812 | |
246be17e | 813 | typedef int (*t_statedump_func_ptr)(struct lttng_session *session); |
3327ac33 | 814 | void lttng_handle_pending_statedump(void *owner); |
37dddb65 | 815 | struct cds_list_head *_lttng_get_sessions(void); |
b33b46f7 FD |
816 | |
817 | struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session, | |
818 | const struct lttng_enum_desc *enum_desc); | |
246be17e | 819 | |
97c7c238 | 820 | void lttng_ust_dl_update(void *ip); |
6548fca4 | 821 | void lttng_ust_fixup_fd_tracker_tls(void); |
97c7c238 | 822 | |
4a1f7569 MD |
823 | /* For backward compatibility. Leave those exported symbols in place. */ |
824 | extern struct lttng_ctx *lttng_static_ctx; | |
825 | void lttng_context_init(void); | |
826 | void lttng_context_exit(void); | |
a211b293 | 827 | void lttng_filter_event_link_bytecode(struct lttng_event *event); |
4a1f7569 | 828 | |
6453d237 MD |
829 | #ifdef __cplusplus |
830 | } | |
831 | #endif | |
832 | ||
51489cad | 833 | #endif /* _LTTNG_UST_EVENTS_H */ |