Commit | Line | Data |
---|---|---|
8020ceb5 | 1 | /* |
c0c0989a | 2 | * SPDX-License-Identifier: MIT |
8020ceb5 | 3 | * |
c0c0989a | 4 | * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
8020ceb5 MD |
5 | * |
6 | * Holds LTTng per-session event registry. | |
8020ceb5 MD |
7 | */ |
8 | ||
c0c0989a MJ |
9 | #ifndef _LTTNG_UST_EVENTS_H |
10 | #define _LTTNG_UST_EVENTS_H | |
11 | ||
9f3fdbc6 | 12 | #include <urcu/list.h> |
1f18504e | 13 | #include <urcu/hlist.h> |
b4051ad8 | 14 | #include <stddef.h> |
9f3fdbc6 | 15 | #include <stdint.h> |
4318ae1b MD |
16 | #include <lttng/ust-abi.h> |
17 | #include <lttng/ust-tracer.h> | |
2ae57758 | 18 | #include <lttng/ust-endian.h> |
20f1eee7 | 19 | #include <float.h> |
d58d1454 MD |
20 | #include <errno.h> |
21 | #include <urcu/ref.h> | |
22 | #include <pthread.h> | |
8020ceb5 | 23 | |
db56acaf MD |
24 | #ifndef LTTNG_PACKED |
25 | #error "LTTNG_PACKED should be defined" | |
26 | #endif | |
27 | ||
6453d237 MD |
28 | #ifdef __cplusplus |
29 | extern "C" { | |
30 | #endif | |
31 | ||
19d8b1b3 MD |
32 | #define LTTNG_UST_UUID_LEN 16 |
33 | ||
71d31690 MD |
34 | /* |
35 | * Tracepoint provider version. Compatibility based on the major number. | |
36 | * Older tracepoint providers can always register to newer lttng-ust | |
37 | * library, but the opposite is rejected: a newer tracepoint provider is | |
38 | * rejected by an older lttng-ust library. | |
39 | */ | |
04f0b55a | 40 | #define LTTNG_UST_PROVIDER_MAJOR 2 |
71d31690 MD |
41 | #define LTTNG_UST_PROVIDER_MINOR 0 |
42 | ||
7dd08bec MD |
43 | struct lttng_channel; |
44 | struct lttng_session; | |
4cfec15c | 45 | struct lttng_ust_lib_ring_buffer_ctx; |
53569322 | 46 | struct lttng_event_field; |
ebabbf58 | 47 | struct lttng_event_notifier_group; |
8020ceb5 | 48 | |
37d5e202 MD |
49 | /* |
50 | * Data structures used by tracepoint event declarations, and by the | |
51 | * tracer. Those structures have padding for future extension. | |
52 | */ | |
53 | ||
8020ceb5 MD |
54 | /* Type description */ |
55 | ||
56 | /* Update the astract_types name table in lttng-types.c along with this enum */ | |
7dd08bec | 57 | enum lttng_abstract_types { |
8020ceb5 | 58 | atype_integer, |
8020ceb5 | 59 | atype_string, |
20f1eee7 | 60 | atype_float, |
53569322 | 61 | atype_dynamic, |
218deb69 MD |
62 | atype_enum_nestable, |
63 | atype_array_nestable, | |
64 | atype_sequence_nestable, | |
65 | atype_struct_nestable, | |
8020ceb5 MD |
66 | NR_ABSTRACT_TYPES, |
67 | }; | |
68 | ||
69 | /* Update the string_encodings name table in lttng-types.c along with this enum */ | |
70 | enum lttng_string_encodings { | |
71 | lttng_encode_none = 0, | |
72 | lttng_encode_UTF8 = 1, | |
73 | lttng_encode_ASCII = 2, | |
74 | NR_STRING_ENCODINGS, | |
75 | }; | |
76 | ||
a6f80644 MD |
77 | struct lttng_enum_value { |
78 | unsigned long long value; | |
79 | unsigned int signedness:1; | |
80 | }; | |
81 | ||
3e762260 PP |
82 | enum lttng_enum_entry_options { |
83 | LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0, | |
84 | }; | |
85 | ||
37d5e202 | 86 | #define LTTNG_UST_ENUM_ENTRY_PADDING 16 |
8020ceb5 | 87 | struct lttng_enum_entry { |
a6f80644 | 88 | struct lttng_enum_value start, end; /* start and end are inclusive */ |
8020ceb5 | 89 | const char *string; |
3e762260 PP |
90 | union { |
91 | struct { | |
92 | unsigned int options; | |
93 | } LTTNG_PACKED extra; | |
94 | char padding[LTTNG_UST_ENUM_ENTRY_PADDING]; | |
95 | } u; | |
8020ceb5 MD |
96 | }; |
97 | ||
98 | #define __type_integer(_type, _byte_order, _base, _encoding) \ | |
99 | { \ | |
46d52200 ZT |
100 | .atype = atype_integer, \ |
101 | .u = \ | |
8020ceb5 | 102 | { \ |
218deb69 | 103 | .integer = \ |
46d52200 | 104 | { \ |
218deb69 MD |
105 | .size = sizeof(_type) * CHAR_BIT, \ |
106 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ | |
107 | .signedness = lttng_is_signed_type(_type), \ | |
108 | .reverse_byte_order = _byte_order != BYTE_ORDER, \ | |
109 | .base = _base, \ | |
110 | .encoding = lttng_encode_##_encoding, \ | |
46d52200 | 111 | } \ |
8020ceb5 MD |
112 | }, \ |
113 | } \ | |
114 | ||
37d5e202 | 115 | #define LTTNG_UST_INTEGER_TYPE_PADDING 24 |
8020ceb5 MD |
116 | struct lttng_integer_type { |
117 | unsigned int size; /* in bits */ | |
118 | unsigned short alignment; /* in bits */ | |
119 | unsigned int signedness:1; | |
120 | unsigned int reverse_byte_order:1; | |
121 | unsigned int base; /* 2, 8, 10, 16, for pretty print */ | |
122 | enum lttng_string_encodings encoding; | |
37d5e202 | 123 | char padding[LTTNG_UST_INTEGER_TYPE_PADDING]; |
8020ceb5 MD |
124 | }; |
125 | ||
d3ed854b MD |
126 | /* |
127 | * Only float and double are supported. long double is not supported at | |
128 | * the moment. | |
129 | */ | |
20f1eee7 MD |
130 | #define _float_mant_dig(_type) \ |
131 | (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \ | |
132 | : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \ | |
d3ed854b | 133 | : 0)) |
20f1eee7 MD |
134 | |
135 | #define __type_float(_type) \ | |
136 | { \ | |
46d52200 ZT |
137 | .atype = atype_float, \ |
138 | .u = \ | |
20f1eee7 | 139 | { \ |
218deb69 | 140 | ._float = \ |
46d52200 | 141 | { \ |
218deb69 MD |
142 | .exp_dig = sizeof(_type) * CHAR_BIT \ |
143 | - _float_mant_dig(_type), \ | |
144 | .mant_dig = _float_mant_dig(_type), \ | |
145 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ | |
146 | .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \ | |
46d52200 | 147 | } \ |
218deb69 | 148 | } \ |
20f1eee7 MD |
149 | } \ |
150 | ||
37d5e202 | 151 | #define LTTNG_UST_FLOAT_TYPE_PADDING 24 |
20f1eee7 MD |
152 | struct lttng_float_type { |
153 | unsigned int exp_dig; /* exponent digits, in bits */ | |
154 | unsigned int mant_dig; /* mantissa digits, in bits */ | |
155 | unsigned short alignment; /* in bits */ | |
156 | unsigned int reverse_byte_order:1; | |
37d5e202 | 157 | char padding[LTTNG_UST_FLOAT_TYPE_PADDING]; |
20f1eee7 MD |
158 | }; |
159 | ||
37d5e202 | 160 | #define LTTNG_UST_TYPE_PADDING 128 |
8020ceb5 | 161 | struct lttng_type { |
7dd08bec | 162 | enum lttng_abstract_types atype; |
8020ceb5 | 163 | union { |
218deb69 MD |
164 | /* provider ABI 2.0 */ |
165 | struct lttng_integer_type integer; | |
166 | struct lttng_float_type _float; | |
167 | struct { | |
168 | enum lttng_string_encodings encoding; | |
169 | } string; | |
170 | struct { | |
171 | const struct lttng_enum_desc *desc; /* Enumeration mapping */ | |
172 | struct lttng_type *container_type; | |
173 | } enum_nestable; | |
8020ceb5 | 174 | struct { |
218deb69 MD |
175 | const struct lttng_type *elem_type; |
176 | unsigned int length; /* Num. elems. */ | |
177 | unsigned int alignment; | |
178 | } array_nestable; | |
8020ceb5 | 179 | struct { |
218deb69 MD |
180 | const char *length_name; /* Length field name. */ |
181 | const struct lttng_type *elem_type; | |
182 | unsigned int alignment; /* Alignment before elements. */ | |
183 | } sequence_nestable; | |
53569322 | 184 | struct { |
218deb69 MD |
185 | unsigned int nr_fields; |
186 | const struct lttng_event_field *fields; /* Array of fields. */ | |
187 | unsigned int alignment; | |
188 | } struct_nestable; | |
189 | ||
37d5e202 | 190 | char padding[LTTNG_UST_TYPE_PADDING]; |
8020ceb5 MD |
191 | } u; |
192 | }; | |
193 | ||
37d5e202 | 194 | #define LTTNG_UST_ENUM_TYPE_PADDING 24 |
c785c634 | 195 | struct lttng_enum_desc { |
8020ceb5 | 196 | const char *name; |
8020ceb5 | 197 | const struct lttng_enum_entry *entries; |
c785c634 | 198 | unsigned int nr_entries; |
37d5e202 | 199 | char padding[LTTNG_UST_ENUM_TYPE_PADDING]; |
8020ceb5 MD |
200 | }; |
201 | ||
180901e6 MD |
202 | /* |
203 | * Event field description | |
204 | * | |
205 | * IMPORTANT: this structure is part of the ABI between the probe and | |
206 | * UST. Fields need to be only added at the end, never reordered, never | |
207 | * removed. | |
208 | */ | |
8020ceb5 | 209 | |
4774c8f3 | 210 | #define LTTNG_UST_EVENT_FIELD_PADDING 28 |
8020ceb5 MD |
211 | struct lttng_event_field { |
212 | const char *name; | |
213 | struct lttng_type type; | |
180901e6 | 214 | unsigned int nowrite; /* do not write into trace */ |
218deb69 MD |
215 | union { |
216 | struct { | |
217 | unsigned int nofilter:1; /* do not consider for filter */ | |
218 | } ext; | |
219 | char padding[LTTNG_UST_EVENT_FIELD_PADDING]; | |
220 | } u; | |
8020ceb5 MD |
221 | }; |
222 | ||
53569322 MD |
223 | enum lttng_ust_dynamic_type { |
224 | LTTNG_UST_DYNAMIC_TYPE_NONE, | |
225 | LTTNG_UST_DYNAMIC_TYPE_S8, | |
226 | LTTNG_UST_DYNAMIC_TYPE_S16, | |
227 | LTTNG_UST_DYNAMIC_TYPE_S32, | |
228 | LTTNG_UST_DYNAMIC_TYPE_S64, | |
229 | LTTNG_UST_DYNAMIC_TYPE_U8, | |
230 | LTTNG_UST_DYNAMIC_TYPE_U16, | |
231 | LTTNG_UST_DYNAMIC_TYPE_U32, | |
232 | LTTNG_UST_DYNAMIC_TYPE_U64, | |
233 | LTTNG_UST_DYNAMIC_TYPE_FLOAT, | |
234 | LTTNG_UST_DYNAMIC_TYPE_DOUBLE, | |
235 | LTTNG_UST_DYNAMIC_TYPE_STRING, | |
236 | _NR_LTTNG_UST_DYNAMIC_TYPES, | |
237 | }; | |
238 | ||
239 | struct lttng_ctx_value { | |
240 | enum lttng_ust_dynamic_type sel; | |
241 | union { | |
242 | int64_t s64; | |
86133caf | 243 | uint64_t u64; |
53569322 MD |
244 | const char *str; |
245 | double d; | |
246 | } u; | |
77aa5901 MD |
247 | }; |
248 | ||
d58d1454 MD |
249 | struct lttng_perf_counter_field; |
250 | ||
37d5e202 | 251 | #define LTTNG_UST_CTX_FIELD_PADDING 40 |
8020ceb5 MD |
252 | struct lttng_ctx_field { |
253 | struct lttng_event_field event_field; | |
53569322 | 254 | size_t (*get_size)(struct lttng_ctx_field *field, size_t offset); |
8020ceb5 | 255 | void (*record)(struct lttng_ctx_field *field, |
4cfec15c | 256 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
7dd08bec | 257 | struct lttng_channel *chan); |
77aa5901 | 258 | void (*get_value)(struct lttng_ctx_field *field, |
53569322 | 259 | struct lttng_ctx_value *value); |
8020ceb5 | 260 | union { |
d58d1454 | 261 | struct lttng_perf_counter_field *perf_counter; |
37d5e202 | 262 | char padding[LTTNG_UST_CTX_FIELD_PADDING]; |
8020ceb5 MD |
263 | } u; |
264 | void (*destroy)(struct lttng_ctx_field *field); | |
53569322 | 265 | char *field_name; /* Has ownership, dynamically allocated. */ |
8020ceb5 MD |
266 | }; |
267 | ||
b2cc986a | 268 | #define LTTNG_UST_CTX_PADDING 20 |
8020ceb5 MD |
269 | struct lttng_ctx { |
270 | struct lttng_ctx_field *fields; | |
271 | unsigned int nr_fields; | |
272 | unsigned int allocated_fields; | |
b2cc986a | 273 | unsigned int largest_align; |
37d5e202 MD |
274 | char padding[LTTNG_UST_CTX_PADDING]; |
275 | }; | |
276 | ||
dc11f93f MD |
277 | /* |
278 | * IMPORTANT: this structure is part of the ABI between the probe and | |
279 | * UST. Fields need to be only added at the end, never reordered, never | |
280 | * removed. | |
281 | * | |
282 | * The field @struct_size should be used to determine the size of the | |
283 | * structure. It should be queried before using additional fields added | |
284 | * at the end of the structure. | |
285 | */ | |
286 | struct lttng_ust_event_desc { | |
287 | uint32_t struct_size; /* Size of this structure. */ | |
37d5e202 | 288 | const char *name; |
fbdeb5ec | 289 | void (*probe_callback)(void); |
37d5e202 MD |
290 | const struct lttng_event_ctx *ctx; /* context */ |
291 | const struct lttng_event_field *fields; /* event payload */ | |
292 | unsigned int nr_fields; | |
293 | const int **loglevel; | |
dc11f93f MD |
294 | const char *signature; /* Argument types/names received */ |
295 | const char **model_emf_uri; | |
296 | ||
297 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
37d5e202 MD |
298 | }; |
299 | ||
dc11f93f MD |
300 | /* |
301 | * IMPORTANT: this structure is part of the ABI between the probe and | |
302 | * UST. Fields need to be only added at the end, never reordered, never | |
303 | * removed. | |
304 | * | |
305 | * The field @struct_size should be used to determine the size of the | |
306 | * structure. It should be queried before using additional fields added | |
307 | * at the end of the structure. | |
308 | */ | |
309 | struct lttng_ust_probe_desc { | |
310 | uint32_t struct_size; /* Size of this structure. */ | |
311 | ||
37d5e202 | 312 | const char *provider; |
dc11f93f | 313 | const struct lttng_ust_event_desc **event_desc; |
37d5e202 MD |
314 | unsigned int nr_events; |
315 | struct cds_list_head head; /* chain registered probes */ | |
6715d7d1 MD |
316 | struct cds_list_head lazy_init_head; |
317 | int lazy; /* lazy registration */ | |
71d31690 MD |
318 | uint32_t major; |
319 | uint32_t minor; | |
dc11f93f MD |
320 | |
321 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
8020ceb5 MD |
322 | }; |
323 | ||
37d5e202 MD |
324 | /* Data structures used by the tracer. */ |
325 | ||
8a92ed2a | 326 | /* |
04aa13f8 | 327 | * Bytecode interpreter return value masks. |
8a92ed2a | 328 | */ |
04aa13f8 FD |
329 | enum lttng_bytecode_interpreter_ret { |
330 | LTTNG_INTERPRETER_DISCARD = 0, | |
331 | LTTNG_INTERPRETER_RECORD_FLAG = (1ULL << 0), | |
8a92ed2a MD |
332 | /* Other bits are kept for future use. */ |
333 | }; | |
334 | ||
d37ecb3f | 335 | struct lttng_interpreter_output; |
362a65de | 336 | struct lttng_ust_bytecode_runtime_private; |
d37ecb3f | 337 | |
73d37531 | 338 | /* |
362a65de MD |
339 | * This structure is used in the probes. More specifically, the |
340 | * `interpreter_funcs` and `node` fields are explicity used in the | |
341 | * probes. When modifying this structure we must not change the layout | |
342 | * of these two fields as it is considered ABI. | |
73d37531 | 343 | */ |
f488575f | 344 | struct lttng_bytecode_runtime { |
362a65de MD |
345 | struct lttng_ust_bytecode_runtime_private *priv; |
346 | ||
f488575f | 347 | /* Associated bytecode */ |
c42416df FD |
348 | union { |
349 | uint64_t (*filter)(void *interpreter_data, | |
350 | const char *interpreter_stack_data); | |
d37ecb3f FD |
351 | uint64_t (*capture)(void *interpreter_data, |
352 | const char *interpreter_stack_data, | |
353 | struct lttng_interpreter_output *interpreter_output); | |
c42416df | 354 | } interpreter_funcs; |
e58095ef MD |
355 | struct cds_list_head node; /* list of bytecode runtime in event */ |
356 | }; | |
357 | ||
8020ceb5 | 358 | /* |
7dd08bec MD |
359 | * lttng_event structure is referred to by the tracing fast path. It |
360 | * must be kept small. | |
180901e6 MD |
361 | * |
362 | * IMPORTANT: this structure is part of the ABI between the probe and | |
363 | * UST. Fields need to be only added at the end, never reordered, never | |
364 | * removed. | |
8020ceb5 | 365 | */ |
68bb7559 | 366 | |
80333dfa MD |
367 | struct lttng_ust_event_common_private; |
368 | ||
808edfc8 MD |
369 | enum lttng_ust_event_type { |
370 | LTTNG_UST_EVENT_TYPE_RECORDER = 0, | |
371 | LTTNG_UST_EVENT_TYPE_NOTIFIER = 1, | |
372 | }; | |
373 | ||
93cfd247 | 374 | /* |
6d35572a MD |
375 | * IMPORTANT: this structure is part of the ABI between the probe and |
376 | * UST. Fields need to be only added at the end, never reordered, never | |
377 | * removed. | |
378 | * | |
93cfd247 MD |
379 | * struct lttng_ust_event_common is the common ancestor of the various |
380 | * public event actions. Inheritance is done by composition: The parent | |
381 | * has a pointer to its child, and the child has a pointer to its | |
382 | * parent. Inheritance of those public structures is done by composition | |
383 | * to ensure both parent and child structures can be extended. | |
384 | * | |
385 | * The field @struct_size should be used to determine the size of the | |
386 | * structure. It should be queried before using additional fields added | |
387 | * at the end of the structure. | |
388 | */ | |
7ee76145 | 389 | struct lttng_ust_event_common { |
80333dfa MD |
390 | uint32_t struct_size; /* Size of this structure. */ |
391 | struct lttng_ust_event_common_private *priv; /* Private event interface */ | |
392 | ||
808edfc8 | 393 | enum lttng_ust_event_type type; |
ba99fbe2 MD |
394 | void *child; /* Pointer to child, for inheritance by aggregation. */ |
395 | ||
80333dfa MD |
396 | int enabled; |
397 | int has_enablers_without_bytecode; | |
398 | /* list of struct lttng_bytecode_runtime, sorted by seqnum */ | |
399 | struct cds_list_head filter_bytecode_runtime_head; | |
93cfd247 MD |
400 | |
401 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
80333dfa MD |
402 | }; |
403 | ||
2e70391c | 404 | struct lttng_ust_event_recorder_private; |
68bb7559 | 405 | |
93cfd247 | 406 | /* |
6d35572a MD |
407 | * IMPORTANT: this structure is part of the ABI between the probe and |
408 | * UST. Fields need to be only added at the end, never reordered, never | |
409 | * removed. | |
410 | * | |
93cfd247 MD |
411 | * struct lttng_ust_event_recorder is the action for recording events |
412 | * into a ring buffer. It inherits from struct lttng_ust_event_common | |
413 | * by composition to ensure both parent and child structure are | |
414 | * extensible. | |
415 | * | |
416 | * The field @struct_size should be used to determine the size of the | |
417 | * structure. It should be queried before using additional fields added | |
418 | * at the end of the structure. | |
419 | */ | |
2e70391c MD |
420 | struct lttng_ust_event_recorder { |
421 | uint32_t struct_size; /* Size of this structure. */ | |
ba99fbe2 | 422 | struct lttng_ust_event_common *parent; /* Inheritance by aggregation. */ |
2e70391c | 423 | struct lttng_ust_event_recorder_private *priv; /* Private event record interface */ |
68bb7559 | 424 | |
8020ceb5 | 425 | unsigned int id; |
68bb7559 MD |
426 | struct lttng_channel *chan; |
427 | struct lttng_ctx *ctx; | |
93cfd247 MD |
428 | |
429 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
8020ceb5 MD |
430 | }; |
431 | ||
115db533 MD |
432 | struct lttng_ust_event_notifier_private; |
433 | ||
93cfd247 | 434 | /* |
6d35572a MD |
435 | * IMPORTANT: this structure is part of the ABI between the probe and |
436 | * UST. Fields need to be only added at the end, never reordered, never | |
437 | * removed. | |
438 | * | |
93cfd247 MD |
439 | * struct lttng_ust_event_notifier is the action for sending |
440 | * notifications. It inherits from struct lttng_ust_event_common | |
441 | * by composition to ensure both parent and child structure are | |
442 | * extensible. | |
443 | * | |
444 | * The field @struct_size should be used to determine the size of the | |
445 | * structure. It should be queried before using additional fields added | |
446 | * at the end of the structure. | |
447 | */ | |
d7d45c0d | 448 | struct lttng_ust_event_notifier { |
115db533 | 449 | uint32_t struct_size; /* Size of this structure. */ |
ba99fbe2 | 450 | struct lttng_ust_event_common *parent; /* Inheritance by aggregation. */ |
115db533 MD |
451 | struct lttng_ust_event_notifier_private *priv; /* Private event notifier interface */ |
452 | ||
d7d45c0d | 453 | void (*notification_send)(struct lttng_ust_event_notifier *event_notifier, |
cab88ff8 | 454 | const char *stack_data); |
d37ecb3f | 455 | struct cds_list_head capture_bytecode_runtime_head; |
93cfd247 MD |
456 | |
457 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
d8d2416d FD |
458 | }; |
459 | ||
c785c634 MD |
460 | struct lttng_enum { |
461 | const struct lttng_enum_desc *desc; | |
462 | struct lttng_session *session; | |
463 | struct cds_list_head node; /* Enum list in session */ | |
464 | struct cds_hlist_node hlist; /* Session ht of enums */ | |
465 | uint64_t id; /* Enumeration ID in sessiond */ | |
466 | }; | |
467 | ||
8d8a24c8 | 468 | struct channel; |
38fae1d3 | 469 | struct lttng_ust_shm_handle; |
8d8a24c8 | 470 | |
180901e6 MD |
471 | /* |
472 | * IMPORTANT: this structure is part of the ABI between the probe and | |
473 | * UST. Fields need to be only added at the end, never reordered, never | |
474 | * removed. | |
475 | */ | |
7dd08bec MD |
476 | struct lttng_channel_ops { |
477 | struct lttng_channel *(*channel_create)(const char *name, | |
74d81a6c MD |
478 | void *buf_addr, |
479 | size_t subbuf_size, size_t num_subbuf, | |
480 | unsigned int switch_timer_interval, | |
481 | unsigned int read_timer_interval, | |
6ca18e66 | 482 | unsigned char *uuid, |
a9ff648c | 483 | uint32_t chan_id, |
b2c5f61a MD |
484 | const int *stream_fds, int nr_stream_fds, |
485 | int64_t blocking_timeout); | |
74d81a6c | 486 | void (*channel_destroy)(struct lttng_channel *chan); |
4cfec15c | 487 | int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
8020ceb5 | 488 | uint32_t event_id); |
4cfec15c | 489 | void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx); |
74d81a6c MD |
490 | void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
491 | const void *src, size_t len); | |
8020ceb5 MD |
492 | /* |
493 | * packet_avail_size returns the available size in the current | |
494 | * packet. Note that the size returned is only a hint, since it | |
495 | * may change due to concurrent writes. | |
496 | */ | |
1d498196 | 497 | size_t (*packet_avail_size)(struct channel *chan, |
38fae1d3 | 498 | struct lttng_ust_shm_handle *handle); |
8020ceb5 MD |
499 | int (*is_finalized)(struct channel *chan); |
500 | int (*is_disabled)(struct channel *chan); | |
38fae1d3 | 501 | int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle); |
a44c74d9 MD |
502 | void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
503 | const char *src, size_t len); | |
8020ceb5 MD |
504 | }; |
505 | ||
180901e6 MD |
506 | /* |
507 | * IMPORTANT: this structure is part of the ABI between the probe and | |
508 | * UST. Fields need to be only added at the end, never reordered, never | |
509 | * removed. | |
510 | */ | |
7dd08bec | 511 | struct lttng_channel { |
a3f61e7f MD |
512 | /* |
513 | * The pointers located in this private data are NOT safe to be | |
514 | * dereferenced by the consumer. The only operations the | |
515 | * consumer process is designed to be allowed to do is to read | |
516 | * and perform subbuffer flush. | |
517 | */ | |
8020ceb5 | 518 | struct channel *chan; /* Channel buffers */ |
976fe9ea | 519 | int enabled; |
8020ceb5 MD |
520 | struct lttng_ctx *ctx; |
521 | /* Event ID management */ | |
7dd08bec | 522 | struct lttng_session *session; |
0a42beb6 | 523 | int objd; /* Object associated to channel */ |
e58095ef | 524 | struct cds_list_head node; /* Channel list in session */ |
74d81a6c | 525 | const struct lttng_channel_ops *ops; |
8020ceb5 | 526 | int header_type; /* 0: unset, 1: compact, 2: large */ |
38fae1d3 | 527 | struct lttng_ust_shm_handle *handle; /* shared-memory handle */ |
a3f61e7f | 528 | |
74d81a6c | 529 | /* Channel ID */ |
a3f61e7f | 530 | unsigned int id; |
fd17d7ce | 531 | enum lttng_ust_abi_chan_type type; |
19d8b1b3 | 532 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
ac6b4ac6 | 533 | int tstate:1; /* Transient enable state */ |
8020ceb5 MD |
534 | }; |
535 | ||
bb7ad29d | 536 | struct lttng_counter_dimension; |
ebabbf58 MD |
537 | |
538 | struct lttng_counter_ops { | |
539 | struct lib_counter *(*counter_create)(size_t nr_dimensions, | |
540 | const struct lttng_counter_dimension *dimensions, | |
541 | int64_t global_sum_step, | |
542 | int global_counter_fd, | |
543 | int nr_counter_cpu_fds, | |
544 | const int *counter_cpu_fds, | |
545 | bool is_daemon); | |
546 | void (*counter_destroy)(struct lib_counter *counter); | |
547 | int (*counter_add)(struct lib_counter *counter, | |
548 | const size_t *dimension_indexes, int64_t v); | |
549 | int (*counter_read)(struct lib_counter *counter, | |
550 | const size_t *dimension_indexes, int cpu, | |
551 | int64_t *value, bool *overflow, bool *underflow); | |
552 | int (*counter_aggregate)(struct lib_counter *counter, | |
553 | const size_t *dimension_indexes, int64_t *value, | |
554 | bool *overflow, bool *underflow); | |
555 | int (*counter_clear)(struct lib_counter *counter, const size_t *dimension_indexes); | |
556 | }; | |
557 | ||
53569322 MD |
558 | #define LTTNG_UST_STACK_CTX_PADDING 32 |
559 | struct lttng_stack_ctx { | |
2e70391c | 560 | struct lttng_ust_event_recorder *event_recorder; |
53569322 MD |
561 | struct lttng_ctx *chan_ctx; /* RCU dereferenced. */ |
562 | struct lttng_ctx *event_ctx; /* RCU dereferenced. */ | |
563 | char padding[LTTNG_UST_STACK_CTX_PADDING]; | |
564 | }; | |
565 | ||
71a9d034 | 566 | #define LTTNG_UST_EVENT_HT_BITS 12 |
e58095ef MD |
567 | #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS) |
568 | ||
569 | struct lttng_ust_event_ht { | |
570 | struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE]; | |
571 | }; | |
572 | ||
d8d2416d FD |
573 | #define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12 |
574 | #define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS) | |
575 | struct lttng_ust_event_notifier_ht { | |
576 | struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE]; | |
577 | }; | |
578 | ||
c785c634 MD |
579 | #define LTTNG_UST_ENUM_HT_BITS 12 |
580 | #define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS) | |
581 | ||
582 | struct lttng_ust_enum_ht { | |
583 | struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE]; | |
584 | }; | |
585 | ||
bdb12629 MD |
586 | struct lttng_ust_session_private; |
587 | ||
180901e6 MD |
588 | /* |
589 | * IMPORTANT: this structure is part of the ABI between the probe and | |
590 | * UST. Fields need to be only added at the end, never reordered, never | |
591 | * removed. | |
6d35572a MD |
592 | * |
593 | * The field @struct_size should be used to determine the size of the | |
594 | * structure. It should be queried before using additional fields added | |
595 | * at the end of the structure. | |
180901e6 | 596 | */ |
7dd08bec | 597 | struct lttng_session { |
bd640d74 | 598 | uint32_t struct_size; /* Size of this structure */ |
bdb12629 MD |
599 | struct lttng_ust_session_private *priv; /* Private session interface */ |
600 | ||
e58095ef | 601 | int active; /* Is trace session active ? */ |
6d35572a MD |
602 | |
603 | /* End of base ABI. Fields below should be used after checking struct_size. */ | |
8020ceb5 MD |
604 | }; |
605 | ||
dc11f93f MD |
606 | int lttng_ust_probe_register(struct lttng_ust_probe_desc *desc); |
607 | void lttng_ust_probe_unregister(struct lttng_ust_probe_desc *desc); | |
9f3fdbc6 | 608 | |
fc80554e MJ |
609 | /* |
610 | * Can be used by applications that change their procname to clear the ust cached value. | |
611 | */ | |
612 | void lttng_context_procname_reset(void); | |
d58d1454 | 613 | |
7dd08bec | 614 | struct lttng_transport *lttng_transport_find(const char *name); |
c1fca457 | 615 | |
6715d7d1 | 616 | int lttng_session_active(void); |
e6c12e3d | 617 | |
97c7c238 MD |
618 | void lttng_ust_dl_update(void *ip); |
619 | ||
6453d237 MD |
620 | #ifdef __cplusplus |
621 | } | |
622 | #endif | |
623 | ||
51489cad | 624 | #endif /* _LTTNG_UST_EVENTS_H */ |