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> |
9f3fdbc6 | 32 | #include <stdint.h> |
4318ae1b MD |
33 | #include <lttng/ust-abi.h> |
34 | #include <lttng/ust-tracer.h> | |
2ae57758 | 35 | #include <lttng/ust-endian.h> |
20f1eee7 | 36 | #include <float.h> |
8020ceb5 | 37 | |
6453d237 MD |
38 | #ifdef __cplusplus |
39 | extern "C" { | |
40 | #endif | |
41 | ||
19d8b1b3 MD |
42 | #define LTTNG_UST_UUID_LEN 16 |
43 | ||
71d31690 MD |
44 | /* |
45 | * Tracepoint provider version. Compatibility based on the major number. | |
46 | * Older tracepoint providers can always register to newer lttng-ust | |
47 | * library, but the opposite is rejected: a newer tracepoint provider is | |
48 | * rejected by an older lttng-ust library. | |
49 | */ | |
50 | #define LTTNG_UST_PROVIDER_MAJOR 1 | |
51 | #define LTTNG_UST_PROVIDER_MINOR 0 | |
52 | ||
7dd08bec MD |
53 | struct lttng_channel; |
54 | struct lttng_session; | |
4cfec15c | 55 | struct lttng_ust_lib_ring_buffer_ctx; |
8020ceb5 | 56 | |
37d5e202 MD |
57 | /* |
58 | * Data structures used by tracepoint event declarations, and by the | |
59 | * tracer. Those structures have padding for future extension. | |
60 | */ | |
61 | ||
c1fca457 MD |
62 | /* |
63 | * LTTng client type enumeration. Used by the consumer to map the | |
64 | * callbacks from its own address space. | |
65 | */ | |
66 | enum lttng_client_types { | |
67 | LTTNG_CLIENT_METADATA = 0, | |
68 | LTTNG_CLIENT_DISCARD = 1, | |
69 | LTTNG_CLIENT_OVERWRITE = 2, | |
34a91bdb MD |
70 | LTTNG_CLIENT_DISCARD_RT = 3, |
71 | LTTNG_CLIENT_OVERWRITE_RT = 4, | |
c1fca457 MD |
72 | LTTNG_NR_CLIENT_TYPES, |
73 | }; | |
74 | ||
8020ceb5 MD |
75 | /* Type description */ |
76 | ||
77 | /* Update the astract_types name table in lttng-types.c along with this enum */ | |
7dd08bec | 78 | enum lttng_abstract_types { |
8020ceb5 MD |
79 | atype_integer, |
80 | atype_enum, | |
81 | atype_array, | |
82 | atype_sequence, | |
83 | atype_string, | |
20f1eee7 | 84 | atype_float, |
8020ceb5 MD |
85 | NR_ABSTRACT_TYPES, |
86 | }; | |
87 | ||
88 | /* Update the string_encodings name table in lttng-types.c along with this enum */ | |
89 | enum lttng_string_encodings { | |
90 | lttng_encode_none = 0, | |
91 | lttng_encode_UTF8 = 1, | |
92 | lttng_encode_ASCII = 2, | |
93 | NR_STRING_ENCODINGS, | |
94 | }; | |
95 | ||
37d5e202 | 96 | #define LTTNG_UST_ENUM_ENTRY_PADDING 16 |
8020ceb5 MD |
97 | struct lttng_enum_entry { |
98 | unsigned long long start, end; /* start and end are inclusive */ | |
99 | const char *string; | |
37d5e202 | 100 | char padding[LTTNG_UST_ENUM_ENTRY_PADDING]; |
8020ceb5 MD |
101 | }; |
102 | ||
103 | #define __type_integer(_type, _byte_order, _base, _encoding) \ | |
104 | { \ | |
46d52200 ZT |
105 | .atype = atype_integer, \ |
106 | .u = \ | |
8020ceb5 | 107 | { \ |
46d52200 ZT |
108 | .basic = \ |
109 | { \ | |
110 | .integer = \ | |
111 | { \ | |
112 | .size = sizeof(_type) * CHAR_BIT, \ | |
113 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ | |
114 | .signedness = lttng_is_signed_type(_type), \ | |
115 | .reverse_byte_order = _byte_order != BYTE_ORDER, \ | |
116 | .base = _base, \ | |
117 | .encoding = lttng_encode_##_encoding, \ | |
118 | } \ | |
119 | } \ | |
8020ceb5 MD |
120 | }, \ |
121 | } \ | |
122 | ||
37d5e202 | 123 | #define LTTNG_UST_INTEGER_TYPE_PADDING 24 |
8020ceb5 MD |
124 | struct lttng_integer_type { |
125 | unsigned int size; /* in bits */ | |
126 | unsigned short alignment; /* in bits */ | |
127 | unsigned int signedness:1; | |
128 | unsigned int reverse_byte_order:1; | |
129 | unsigned int base; /* 2, 8, 10, 16, for pretty print */ | |
130 | enum lttng_string_encodings encoding; | |
37d5e202 | 131 | char padding[LTTNG_UST_INTEGER_TYPE_PADDING]; |
8020ceb5 MD |
132 | }; |
133 | ||
d3ed854b MD |
134 | /* |
135 | * Only float and double are supported. long double is not supported at | |
136 | * the moment. | |
137 | */ | |
20f1eee7 MD |
138 | #define _float_mant_dig(_type) \ |
139 | (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \ | |
140 | : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \ | |
d3ed854b | 141 | : 0)) |
20f1eee7 MD |
142 | |
143 | #define __type_float(_type) \ | |
144 | { \ | |
46d52200 ZT |
145 | .atype = atype_float, \ |
146 | .u = \ | |
20f1eee7 | 147 | { \ |
46d52200 ZT |
148 | .basic = \ |
149 | { \ | |
150 | ._float = \ | |
151 | { \ | |
152 | .exp_dig = sizeof(_type) * CHAR_BIT \ | |
153 | - _float_mant_dig(_type), \ | |
154 | .mant_dig = _float_mant_dig(_type), \ | |
155 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ | |
156 | .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \ | |
157 | } \ | |
158 | } \ | |
20f1eee7 MD |
159 | }, \ |
160 | } \ | |
161 | ||
37d5e202 | 162 | #define LTTNG_UST_FLOAT_TYPE_PADDING 24 |
20f1eee7 MD |
163 | struct lttng_float_type { |
164 | unsigned int exp_dig; /* exponent digits, in bits */ | |
165 | unsigned int mant_dig; /* mantissa digits, in bits */ | |
166 | unsigned short alignment; /* in bits */ | |
167 | unsigned int reverse_byte_order:1; | |
37d5e202 | 168 | char padding[LTTNG_UST_FLOAT_TYPE_PADDING]; |
20f1eee7 MD |
169 | }; |
170 | ||
37d5e202 | 171 | #define LTTNG_UST_BASIC_TYPE_PADDING 128 |
8020ceb5 MD |
172 | union _lttng_basic_type { |
173 | struct lttng_integer_type integer; | |
174 | struct { | |
175 | const char *name; | |
176 | } enumeration; | |
177 | struct { | |
178 | enum lttng_string_encodings encoding; | |
179 | } string; | |
20f1eee7 | 180 | struct lttng_float_type _float; |
37d5e202 | 181 | char padding[LTTNG_UST_BASIC_TYPE_PADDING]; |
8020ceb5 MD |
182 | }; |
183 | ||
184 | struct lttng_basic_type { | |
7dd08bec | 185 | enum lttng_abstract_types atype; |
8020ceb5 MD |
186 | union { |
187 | union _lttng_basic_type basic; | |
188 | } u; | |
189 | }; | |
190 | ||
37d5e202 | 191 | #define LTTNG_UST_TYPE_PADDING 128 |
8020ceb5 | 192 | struct lttng_type { |
7dd08bec | 193 | enum lttng_abstract_types atype; |
8020ceb5 MD |
194 | union { |
195 | union _lttng_basic_type basic; | |
196 | struct { | |
197 | struct lttng_basic_type elem_type; | |
198 | unsigned int length; /* num. elems. */ | |
199 | } array; | |
200 | struct { | |
201 | struct lttng_basic_type length_type; | |
202 | struct lttng_basic_type elem_type; | |
203 | } sequence; | |
37d5e202 | 204 | char padding[LTTNG_UST_TYPE_PADDING]; |
8020ceb5 MD |
205 | } u; |
206 | }; | |
207 | ||
37d5e202 | 208 | #define LTTNG_UST_ENUM_TYPE_PADDING 24 |
8020ceb5 MD |
209 | struct lttng_enum { |
210 | const char *name; | |
211 | struct lttng_type container_type; | |
212 | const struct lttng_enum_entry *entries; | |
23c8854a | 213 | unsigned int len; |
37d5e202 | 214 | char padding[LTTNG_UST_ENUM_TYPE_PADDING]; |
8020ceb5 MD |
215 | }; |
216 | ||
180901e6 MD |
217 | /* |
218 | * Event field description | |
219 | * | |
220 | * IMPORTANT: this structure is part of the ABI between the probe and | |
221 | * UST. Fields need to be only added at the end, never reordered, never | |
222 | * removed. | |
223 | */ | |
8020ceb5 | 224 | |
4774c8f3 | 225 | #define LTTNG_UST_EVENT_FIELD_PADDING 28 |
8020ceb5 MD |
226 | struct lttng_event_field { |
227 | const char *name; | |
228 | struct lttng_type type; | |
180901e6 | 229 | unsigned int nowrite; /* do not write into trace */ |
37d5e202 | 230 | char padding[LTTNG_UST_EVENT_FIELD_PADDING]; |
8020ceb5 MD |
231 | }; |
232 | ||
77aa5901 MD |
233 | union lttng_ctx_value { |
234 | int64_t s64; | |
235 | const char *str; | |
236 | double d; | |
237 | }; | |
238 | ||
37d5e202 | 239 | #define LTTNG_UST_CTX_FIELD_PADDING 40 |
8020ceb5 MD |
240 | struct lttng_ctx_field { |
241 | struct lttng_event_field event_field; | |
242 | size_t (*get_size)(size_t offset); | |
243 | void (*record)(struct lttng_ctx_field *field, | |
4cfec15c | 244 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
7dd08bec | 245 | struct lttng_channel *chan); |
77aa5901 MD |
246 | void (*get_value)(struct lttng_ctx_field *field, |
247 | union lttng_ctx_value *value); | |
8020ceb5 | 248 | union { |
37d5e202 | 249 | char padding[LTTNG_UST_CTX_FIELD_PADDING]; |
8020ceb5 MD |
250 | } u; |
251 | void (*destroy)(struct lttng_ctx_field *field); | |
252 | }; | |
253 | ||
37d5e202 | 254 | #define LTTNG_UST_CTX_PADDING 24 |
8020ceb5 MD |
255 | struct lttng_ctx { |
256 | struct lttng_ctx_field *fields; | |
257 | unsigned int nr_fields; | |
258 | unsigned int allocated_fields; | |
37d5e202 MD |
259 | char padding[LTTNG_UST_CTX_PADDING]; |
260 | }; | |
261 | ||
262 | #define LTTNG_UST_EVENT_DESC_PADDING 40 | |
263 | struct lttng_event_desc { | |
264 | const char *name; | |
fbdeb5ec | 265 | void (*probe_callback)(void); |
37d5e202 MD |
266 | const struct lttng_event_ctx *ctx; /* context */ |
267 | const struct lttng_event_field *fields; /* event payload */ | |
268 | unsigned int nr_fields; | |
269 | const int **loglevel; | |
68755429 | 270 | const char *signature; /* Argument types/names received */ |
6ddc916d MD |
271 | union { |
272 | struct { | |
273 | const char **model_emf_uri; | |
274 | } ext; | |
275 | char padding[LTTNG_UST_EVENT_DESC_PADDING]; | |
276 | } u; | |
37d5e202 MD |
277 | }; |
278 | ||
71d31690 | 279 | #define LTTNG_UST_PROBE_DESC_PADDING 12 |
37d5e202 MD |
280 | struct lttng_probe_desc { |
281 | const char *provider; | |
282 | const struct lttng_event_desc **event_desc; | |
283 | unsigned int nr_events; | |
284 | struct cds_list_head head; /* chain registered probes */ | |
6715d7d1 MD |
285 | struct cds_list_head lazy_init_head; |
286 | int lazy; /* lazy registration */ | |
71d31690 MD |
287 | uint32_t major; |
288 | uint32_t minor; | |
37d5e202 | 289 | char padding[LTTNG_UST_PROBE_DESC_PADDING]; |
8020ceb5 MD |
290 | }; |
291 | ||
37d5e202 MD |
292 | /* Data structures used by the tracer. */ |
293 | ||
e58095ef MD |
294 | enum lttng_enabler_type { |
295 | LTTNG_ENABLER_WILDCARD, | |
296 | LTTNG_ENABLER_EVENT, | |
e6c12e3d MD |
297 | }; |
298 | ||
299 | /* | |
e58095ef MD |
300 | * Enabler field, within whatever object is enabling an event. Target of |
301 | * backward reference. | |
e6c12e3d | 302 | */ |
e58095ef MD |
303 | struct lttng_enabler { |
304 | enum lttng_enabler_type type; | |
305 | ||
306 | /* head list of struct lttng_ust_filter_bytecode_node */ | |
307 | struct cds_list_head filter_bytecode_head; | |
0f63324a JI |
308 | /* head list of struct lttng_ust_excluder_node */ |
309 | struct cds_list_head excluder_head; | |
e58095ef MD |
310 | struct cds_list_head node; /* per-session list of enablers */ |
311 | ||
312 | struct lttng_ust_event event_param; | |
313 | struct lttng_channel *chan; | |
314 | struct lttng_ctx *ctx; | |
315 | unsigned int enabled:1; | |
e6c12e3d MD |
316 | }; |
317 | ||
c8fcf224 MD |
318 | struct tp_list_entry { |
319 | struct lttng_ust_tracepoint_iter tp; | |
320 | struct cds_list_head head; | |
321 | }; | |
322 | ||
323 | struct lttng_ust_tracepoint_list { | |
324 | struct tp_list_entry *iter; | |
325 | struct cds_list_head head; | |
8020ceb5 MD |
326 | }; |
327 | ||
06d4f27e MD |
328 | struct tp_field_list_entry { |
329 | struct lttng_ust_field_iter field; | |
330 | struct cds_list_head head; | |
331 | }; | |
332 | ||
333 | struct lttng_ust_field_list { | |
334 | struct tp_field_list_entry *iter; | |
335 | struct cds_list_head head; | |
336 | }; | |
337 | ||
8165c8da | 338 | struct ust_pending_probe; |
7dd08bec | 339 | struct lttng_event; |
f488575f MD |
340 | |
341 | struct lttng_ust_filter_bytecode_node { | |
342 | struct cds_list_head node; | |
e58095ef | 343 | struct lttng_enabler *enabler; |
a543151c MD |
344 | /* |
345 | * struct lttng_ust_filter_bytecode has var. sized array, must | |
346 | * be last field. | |
347 | */ | |
348 | struct lttng_ust_filter_bytecode bc; | |
f488575f MD |
349 | }; |
350 | ||
0f63324a JI |
351 | struct lttng_ust_excluder_node { |
352 | struct cds_list_head node; | |
353 | struct lttng_enabler *enabler; | |
354 | /* | |
355 | * struct lttng_ust_event_exclusion had variable sized array, | |
356 | * must be last field. | |
357 | */ | |
358 | struct lttng_ust_event_exclusion excluder; | |
359 | }; | |
8a92ed2a MD |
360 | /* |
361 | * Filter return value masks. | |
362 | */ | |
363 | enum lttng_filter_ret { | |
364 | LTTNG_FILTER_DISCARD = 0, | |
365 | LTTNG_FILTER_RECORD_FLAG = (1ULL << 0), | |
366 | /* Other bits are kept for future use. */ | |
367 | }; | |
368 | ||
f488575f MD |
369 | struct lttng_bytecode_runtime { |
370 | /* Associated bytecode */ | |
371 | struct lttng_ust_filter_bytecode_node *bc; | |
8a92ed2a | 372 | uint64_t (*filter)(void *filter_data, const char *filter_stack_data); |
21af05a9 | 373 | int link_failed; |
e58095ef MD |
374 | struct cds_list_head node; /* list of bytecode runtime in event */ |
375 | }; | |
376 | ||
377 | /* | |
378 | * Objects in a linked-list of enablers, owned by an event. | |
379 | */ | |
380 | struct lttng_enabler_ref { | |
381 | struct cds_list_head node; /* enabler ref list */ | |
382 | struct lttng_enabler *ref; /* backward ref */ | |
f488575f | 383 | }; |
8165c8da | 384 | |
8020ceb5 | 385 | /* |
7dd08bec MD |
386 | * lttng_event structure is referred to by the tracing fast path. It |
387 | * must be kept small. | |
180901e6 MD |
388 | * |
389 | * IMPORTANT: this structure is part of the ABI between the probe and | |
390 | * UST. Fields need to be only added at the end, never reordered, never | |
391 | * removed. | |
8020ceb5 | 392 | */ |
7dd08bec | 393 | struct lttng_event { |
180901e6 | 394 | /* LTTng-UST 2.0 starts here */ |
8020ceb5 | 395 | unsigned int id; |
7dd08bec | 396 | struct lttng_channel *chan; |
976fe9ea | 397 | int enabled; |
8020ceb5 | 398 | const struct lttng_event_desc *desc; |
e58095ef | 399 | void *_deprecated1; |
8020ceb5 | 400 | struct lttng_ctx *ctx; |
9f3fdbc6 | 401 | enum lttng_ust_instrumentation instrumentation; |
8020ceb5 | 402 | union { |
8020ceb5 | 403 | } u; |
e58095ef MD |
404 | struct cds_list_head node; /* Event list in session */ |
405 | struct cds_list_head _deprecated2; | |
406 | void *_deprecated3; | |
13b21cd6 | 407 | unsigned int _deprecated4:1; |
e58095ef | 408 | |
180901e6 | 409 | /* LTTng-UST 2.1 starts here */ |
e58095ef MD |
410 | /* list of struct lttng_bytecode_runtime, sorted by seqnum */ |
411 | struct cds_list_head bytecode_runtime_head; | |
dcdeaff0 | 412 | int has_enablers_without_bytecode; |
e58095ef MD |
413 | /* Backward references: list of lttng_enabler_ref (ref to enablers) */ |
414 | struct cds_list_head enablers_ref_head; | |
d56fa719 | 415 | struct cds_hlist_node hlist; /* session ht of events */ |
ac6b4ac6 | 416 | int registered; /* has reg'd tracepoint probe */ |
8020ceb5 MD |
417 | }; |
418 | ||
8d8a24c8 | 419 | struct channel; |
38fae1d3 | 420 | struct lttng_ust_shm_handle; |
8d8a24c8 | 421 | |
180901e6 MD |
422 | /* |
423 | * IMPORTANT: this structure is part of the ABI between the probe and | |
424 | * UST. Fields need to be only added at the end, never reordered, never | |
425 | * removed. | |
426 | */ | |
7dd08bec MD |
427 | struct lttng_channel_ops { |
428 | struct lttng_channel *(*channel_create)(const char *name, | |
74d81a6c MD |
429 | void *buf_addr, |
430 | size_t subbuf_size, size_t num_subbuf, | |
431 | unsigned int switch_timer_interval, | |
432 | unsigned int read_timer_interval, | |
6ca18e66 MD |
433 | unsigned char *uuid, |
434 | uint32_t chan_id); | |
74d81a6c | 435 | void (*channel_destroy)(struct lttng_channel *chan); |
9e917229 MD |
436 | void *_deprecated1; |
437 | void *_deprecated2; | |
4cfec15c | 438 | int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
8020ceb5 | 439 | uint32_t event_id); |
4cfec15c | 440 | void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx); |
74d81a6c MD |
441 | void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
442 | const void *src, size_t len); | |
8020ceb5 MD |
443 | /* |
444 | * packet_avail_size returns the available size in the current | |
445 | * packet. Note that the size returned is only a hint, since it | |
446 | * may change due to concurrent writes. | |
447 | */ | |
1d498196 | 448 | size_t (*packet_avail_size)(struct channel *chan, |
38fae1d3 | 449 | struct lttng_ust_shm_handle *handle); |
9f3fdbc6 MD |
450 | //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan); |
451 | //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan); | |
8020ceb5 MD |
452 | int (*is_finalized)(struct channel *chan); |
453 | int (*is_disabled)(struct channel *chan); | |
38fae1d3 | 454 | int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle); |
8020ceb5 MD |
455 | }; |
456 | ||
180901e6 MD |
457 | /* |
458 | * IMPORTANT: this structure is part of the ABI between the probe and | |
459 | * UST. Fields need to be only added at the end, never reordered, never | |
460 | * removed. | |
461 | */ | |
7dd08bec | 462 | struct lttng_channel { |
a3f61e7f MD |
463 | /* |
464 | * The pointers located in this private data are NOT safe to be | |
465 | * dereferenced by the consumer. The only operations the | |
466 | * consumer process is designed to be allowed to do is to read | |
467 | * and perform subbuffer flush. | |
468 | */ | |
8020ceb5 | 469 | struct channel *chan; /* Channel buffers */ |
976fe9ea | 470 | int enabled; |
8020ceb5 MD |
471 | struct lttng_ctx *ctx; |
472 | /* Event ID management */ | |
7dd08bec | 473 | struct lttng_session *session; |
0a42beb6 | 474 | int objd; /* Object associated to channel */ |
32ce8569 MD |
475 | unsigned int _deprecated1; |
476 | unsigned int _deprecated2; | |
e58095ef | 477 | struct cds_list_head node; /* Channel list in session */ |
74d81a6c | 478 | const struct lttng_channel_ops *ops; |
8020ceb5 | 479 | int header_type; /* 0: unset, 1: compact, 2: large */ |
38fae1d3 | 480 | struct lttng_ust_shm_handle *handle; /* shared-memory handle */ |
13b21cd6 | 481 | unsigned int _deprecated3:1; |
a3f61e7f | 482 | |
74d81a6c | 483 | /* Channel ID */ |
a3f61e7f | 484 | unsigned int id; |
74d81a6c | 485 | enum lttng_ust_chan_type type; |
19d8b1b3 | 486 | unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */ |
ac6b4ac6 | 487 | int tstate:1; /* Transient enable state */ |
8020ceb5 MD |
488 | }; |
489 | ||
71a9d034 | 490 | #define LTTNG_UST_EVENT_HT_BITS 12 |
e58095ef MD |
491 | #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS) |
492 | ||
493 | struct lttng_ust_event_ht { | |
494 | struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE]; | |
495 | }; | |
496 | ||
180901e6 MD |
497 | /* |
498 | * IMPORTANT: this structure is part of the ABI between the probe and | |
499 | * UST. Fields need to be only added at the end, never reordered, never | |
500 | * removed. | |
501 | */ | |
7dd08bec | 502 | struct lttng_session { |
e58095ef MD |
503 | int active; /* Is trace session active ? */ |
504 | int been_active; /* Been active ? */ | |
505 | int objd; /* Object associated */ | |
13b21cd6 | 506 | void *_deprecated1; |
e58095ef MD |
507 | struct cds_list_head chan_head; /* Channel list head */ |
508 | struct cds_list_head events_head; /* list of events */ | |
13b21cd6 | 509 | struct cds_list_head _deprecated2; |
e58095ef | 510 | struct cds_list_head node; /* Session list */ |
13b21cd6 MD |
511 | int _deprecated3; |
512 | unsigned int _deprecated4:1; | |
e58095ef MD |
513 | |
514 | /* New UST 2.1 */ | |
515 | /* List of enablers */ | |
516 | struct cds_list_head enablers_head; | |
d56fa719 | 517 | struct lttng_ust_event_ht events_ht; /* ht of events */ |
32ce8569 | 518 | void *owner; /* object owner */ |
ac6b4ac6 | 519 | int tstate:1; /* Transient enable state */ |
246be17e PW |
520 | |
521 | /* New UST 2.4 */ | |
522 | int statedump_pending:1; | |
8020ceb5 MD |
523 | }; |
524 | ||
7dd08bec | 525 | struct lttng_transport { |
8020ceb5 | 526 | char *name; |
9f3fdbc6 | 527 | struct cds_list_head node; |
7dd08bec | 528 | struct lttng_channel_ops ops; |
74d81a6c | 529 | const struct lttng_ust_lib_ring_buffer_config *client_config; |
8020ceb5 MD |
530 | }; |
531 | ||
7dd08bec MD |
532 | struct lttng_session *lttng_session_create(void); |
533 | int lttng_session_enable(struct lttng_session *session); | |
534 | int lttng_session_disable(struct lttng_session *session); | |
535 | void lttng_session_destroy(struct lttng_session *session); | |
8020ceb5 | 536 | |
7dd08bec | 537 | struct lttng_channel *lttng_channel_create(struct lttng_session *session, |
8020ceb5 MD |
538 | const char *transport_name, |
539 | void *buf_addr, | |
540 | size_t subbuf_size, size_t num_subbuf, | |
541 | unsigned int switch_timer_interval, | |
193183fb | 542 | unsigned int read_timer_interval, |
ef9ff354 MD |
543 | int **shm_fd, int **wait_fd, |
544 | uint64_t **memory_map_size, | |
7dd08bec | 545 | struct lttng_channel *chan_priv_init); |
8020ceb5 | 546 | |
7dd08bec MD |
547 | int lttng_channel_enable(struct lttng_channel *channel); |
548 | int lttng_channel_disable(struct lttng_channel *channel); | |
e58095ef MD |
549 | |
550 | struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type, | |
551 | struct lttng_ust_event *event_param, | |
552 | struct lttng_channel *chan); | |
553 | int lttng_enabler_enable(struct lttng_enabler *enabler); | |
554 | int lttng_enabler_disable(struct lttng_enabler *enabler); | |
555 | int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler, | |
556 | struct lttng_ust_filter_bytecode_node *bytecode); | |
557 | int lttng_enabler_attach_context(struct lttng_enabler *enabler, | |
558 | struct lttng_ust_context *ctx); | |
0bfb5cbd JI |
559 | int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler, |
560 | struct lttng_ust_excluder_node *excluder); | |
e58095ef MD |
561 | |
562 | int lttng_attach_context(struct lttng_ust_context *context_param, | |
563 | struct lttng_ctx **ctx, struct lttng_session *session); | |
a0a3bef9 MD |
564 | void lttng_context_init(void); |
565 | void lttng_context_exit(void); | |
0478bb8c | 566 | extern struct lttng_ctx *lttng_static_ctx; /* Used by filtering */ |
976fe9ea | 567 | |
7dd08bec MD |
568 | void lttng_transport_register(struct lttng_transport *transport); |
569 | void lttng_transport_unregister(struct lttng_transport *transport); | |
8020ceb5 | 570 | |
4b4de73e | 571 | void synchronize_trace(void); |
8020ceb5 | 572 | |
7dd08bec MD |
573 | int lttng_probe_register(struct lttng_probe_desc *desc); |
574 | void lttng_probe_unregister(struct lttng_probe_desc *desc); | |
5f733922 | 575 | int lttng_fix_pending_events(void); |
7dd08bec MD |
576 | int lttng_probes_init(void); |
577 | void lttng_probes_exit(void); | |
8173ec7c | 578 | int lttng_find_context(struct lttng_ctx *ctx, const char *name); |
77aa5901 | 579 | int lttng_get_context_index(struct lttng_ctx *ctx, const char *name); |
8173ec7c MD |
580 | struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p); |
581 | void lttng_remove_context_field(struct lttng_ctx **ctx_p, | |
8020ceb5 MD |
582 | struct lttng_ctx_field *field); |
583 | void lttng_destroy_context(struct lttng_ctx *ctx); | |
3b402b40 | 584 | int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx); |
c1ef86f0 | 585 | int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx); |
8173ec7c | 586 | int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx); |
4847e9bb | 587 | int lttng_add_procname_to_ctx(struct lttng_ctx **ctx); |
96f85541 | 588 | int lttng_add_ip_to_ctx(struct lttng_ctx **ctx); |
a93bfc45 | 589 | void lttng_context_vtid_reset(void); |
c1ef86f0 | 590 | void lttng_context_vpid_reset(void); |
9f3fdbc6 | 591 | |
82b9bde8 JD |
592 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata; |
593 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_discard; | |
594 | extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite; | |
c1fca457 | 595 | |
7dd08bec | 596 | struct lttng_transport *lttng_transport_find(const char *name); |
c1fca457 | 597 | |
7dd08bec MD |
598 | int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list); |
599 | void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list); | |
c8fcf224 MD |
600 | struct lttng_ust_tracepoint_iter * |
601 | lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list); | |
7dd08bec MD |
602 | int lttng_probes_get_field_list(struct lttng_ust_field_list *list); |
603 | void lttng_probes_prune_field_list(struct lttng_ust_field_list *list); | |
06d4f27e MD |
604 | struct lttng_ust_field_iter * |
605 | lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list); | |
c8fcf224 | 606 | |
7dd08bec | 607 | void lttng_filter_event_link_bytecode(struct lttng_event *event); |
e58095ef MD |
608 | void lttng_enabler_event_link_bytecode(struct lttng_event *event, |
609 | struct lttng_enabler *enabler); | |
7dd08bec | 610 | void lttng_free_event_filter_runtime(struct lttng_event *event); |
e58095ef MD |
611 | void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime); |
612 | ||
613 | struct cds_list_head *lttng_get_probe_list_head(void); | |
6715d7d1 | 614 | int lttng_session_active(void); |
e6c12e3d | 615 | |
246be17e | 616 | typedef int (*t_statedump_func_ptr)(struct lttng_session *session); |
3327ac33 | 617 | void lttng_handle_pending_statedump(void *owner); |
37dddb65 | 618 | struct cds_list_head *_lttng_get_sessions(void); |
246be17e | 619 | |
6453d237 MD |
620 | #ifdef __cplusplus |
621 | } | |
622 | #endif | |
623 | ||
51489cad | 624 | #endif /* _LTTNG_UST_EVENTS_H */ |