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