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