Docs: explain why unused `lttng_enabler::ctx` is kept around
[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 */
59#define LTTNG_UST_PROVIDER_MAJOR 1
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
MD
90 atype_integer,
91 atype_enum,
92 atype_array,
93 atype_sequence,
94 atype_string,
20f1eee7 95 atype_float,
53569322
MD
96 atype_dynamic,
97 atype_struct,
8020ceb5
MD
98 NR_ABSTRACT_TYPES,
99};
100
101/* Update the string_encodings name table in lttng-types.c along with this enum */
102enum lttng_string_encodings {
103 lttng_encode_none = 0,
104 lttng_encode_UTF8 = 1,
105 lttng_encode_ASCII = 2,
106 NR_STRING_ENCODINGS,
107};
108
a6f80644
MD
109struct lttng_enum_value {
110 unsigned long long value;
111 unsigned int signedness:1;
112};
113
3e762260
PP
114enum lttng_enum_entry_options {
115 LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
116};
117
37d5e202 118#define LTTNG_UST_ENUM_ENTRY_PADDING 16
8020ceb5 119struct lttng_enum_entry {
a6f80644 120 struct lttng_enum_value start, end; /* start and end are inclusive */
8020ceb5 121 const char *string;
3e762260
PP
122 union {
123 struct {
124 unsigned int options;
125 } LTTNG_PACKED extra;
126 char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
127 } u;
8020ceb5
MD
128};
129
130#define __type_integer(_type, _byte_order, _base, _encoding) \
131 { \
46d52200
ZT
132 .atype = atype_integer, \
133 .u = \
8020ceb5 134 { \
46d52200
ZT
135 .basic = \
136 { \
137 .integer = \
138 { \
139 .size = sizeof(_type) * CHAR_BIT, \
140 .alignment = lttng_alignof(_type) * CHAR_BIT, \
141 .signedness = lttng_is_signed_type(_type), \
142 .reverse_byte_order = _byte_order != BYTE_ORDER, \
143 .base = _base, \
144 .encoding = lttng_encode_##_encoding, \
145 } \
146 } \
8020ceb5
MD
147 }, \
148 } \
149
37d5e202 150#define LTTNG_UST_INTEGER_TYPE_PADDING 24
8020ceb5
MD
151struct lttng_integer_type {
152 unsigned int size; /* in bits */
153 unsigned short alignment; /* in bits */
154 unsigned int signedness:1;
155 unsigned int reverse_byte_order:1;
156 unsigned int base; /* 2, 8, 10, 16, for pretty print */
157 enum lttng_string_encodings encoding;
37d5e202 158 char padding[LTTNG_UST_INTEGER_TYPE_PADDING];
8020ceb5
MD
159};
160
d3ed854b
MD
161/*
162 * Only float and double are supported. long double is not supported at
163 * the moment.
164 */
20f1eee7
MD
165#define _float_mant_dig(_type) \
166 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
167 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
d3ed854b 168 : 0))
20f1eee7
MD
169
170#define __type_float(_type) \
171 { \
46d52200
ZT
172 .atype = atype_float, \
173 .u = \
20f1eee7 174 { \
46d52200
ZT
175 .basic = \
176 { \
177 ._float = \
178 { \
179 .exp_dig = sizeof(_type) * CHAR_BIT \
180 - _float_mant_dig(_type), \
181 .mant_dig = _float_mant_dig(_type), \
182 .alignment = lttng_alignof(_type) * CHAR_BIT, \
183 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
184 } \
185 } \
20f1eee7
MD
186 }, \
187 } \
188
37d5e202 189#define LTTNG_UST_FLOAT_TYPE_PADDING 24
20f1eee7
MD
190struct lttng_float_type {
191 unsigned int exp_dig; /* exponent digits, in bits */
192 unsigned int mant_dig; /* mantissa digits, in bits */
193 unsigned short alignment; /* in bits */
194 unsigned int reverse_byte_order:1;
37d5e202 195 char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
20f1eee7
MD
196};
197
37d5e202 198#define LTTNG_UST_BASIC_TYPE_PADDING 128
8020ceb5
MD
199union _lttng_basic_type {
200 struct lttng_integer_type integer;
201 struct {
c785c634
MD
202 const struct lttng_enum_desc *desc; /* Enumeration mapping */
203 struct lttng_integer_type container_type;
8020ceb5
MD
204 } enumeration;
205 struct {
206 enum lttng_string_encodings encoding;
207 } string;
20f1eee7 208 struct lttng_float_type _float;
37d5e202 209 char padding[LTTNG_UST_BASIC_TYPE_PADDING];
8020ceb5
MD
210};
211
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
MD
222 union {
223 union _lttng_basic_type basic;
224 struct {
225 struct lttng_basic_type elem_type;
226 unsigned int length; /* num. elems. */
227 } array;
228 struct {
229 struct lttng_basic_type length_type;
230 struct lttng_basic_type elem_type;
231 } sequence;
53569322
MD
232 struct {
233 uint32_t nr_fields;
234 struct lttng_event_field *fields; /* Array of fields. */
235 } _struct;
37d5e202 236 char padding[LTTNG_UST_TYPE_PADDING];
8020ceb5
MD
237 } u;
238};
239
37d5e202 240#define LTTNG_UST_ENUM_TYPE_PADDING 24
c785c634 241struct lttng_enum_desc {
8020ceb5 242 const char *name;
8020ceb5 243 const struct lttng_enum_entry *entries;
c785c634 244 unsigned int nr_entries;
37d5e202 245 char padding[LTTNG_UST_ENUM_TYPE_PADDING];
8020ceb5
MD
246};
247
180901e6
MD
248/*
249 * Event field description
250 *
251 * IMPORTANT: this structure is part of the ABI between the probe and
252 * UST. Fields need to be only added at the end, never reordered, never
253 * removed.
254 */
8020ceb5 255
4774c8f3 256#define LTTNG_UST_EVENT_FIELD_PADDING 28
8020ceb5
MD
257struct lttng_event_field {
258 const char *name;
259 struct lttng_type type;
180901e6 260 unsigned int nowrite; /* do not write into trace */
37d5e202 261 char padding[LTTNG_UST_EVENT_FIELD_PADDING];
8020ceb5
MD
262};
263
53569322
MD
264enum lttng_ust_dynamic_type {
265 LTTNG_UST_DYNAMIC_TYPE_NONE,
266 LTTNG_UST_DYNAMIC_TYPE_S8,
267 LTTNG_UST_DYNAMIC_TYPE_S16,
268 LTTNG_UST_DYNAMIC_TYPE_S32,
269 LTTNG_UST_DYNAMIC_TYPE_S64,
270 LTTNG_UST_DYNAMIC_TYPE_U8,
271 LTTNG_UST_DYNAMIC_TYPE_U16,
272 LTTNG_UST_DYNAMIC_TYPE_U32,
273 LTTNG_UST_DYNAMIC_TYPE_U64,
274 LTTNG_UST_DYNAMIC_TYPE_FLOAT,
275 LTTNG_UST_DYNAMIC_TYPE_DOUBLE,
276 LTTNG_UST_DYNAMIC_TYPE_STRING,
277 _NR_LTTNG_UST_DYNAMIC_TYPES,
278};
279
280struct lttng_ctx_value {
281 enum lttng_ust_dynamic_type sel;
282 union {
283 int64_t s64;
284 const char *str;
285 double d;
286 } u;
77aa5901
MD
287};
288
d58d1454
MD
289struct lttng_perf_counter_field;
290
37d5e202 291#define LTTNG_UST_CTX_FIELD_PADDING 40
8020ceb5
MD
292struct lttng_ctx_field {
293 struct lttng_event_field event_field;
53569322 294 size_t (*get_size)(struct lttng_ctx_field *field, size_t offset);
8020ceb5 295 void (*record)(struct lttng_ctx_field *field,
4cfec15c 296 struct lttng_ust_lib_ring_buffer_ctx *ctx,
7dd08bec 297 struct lttng_channel *chan);
77aa5901 298 void (*get_value)(struct lttng_ctx_field *field,
53569322 299 struct lttng_ctx_value *value);
8020ceb5 300 union {
d58d1454 301 struct lttng_perf_counter_field *perf_counter;
37d5e202 302 char padding[LTTNG_UST_CTX_FIELD_PADDING];
8020ceb5
MD
303 } u;
304 void (*destroy)(struct lttng_ctx_field *field);
53569322 305 char *field_name; /* Has ownership, dynamically allocated. */
8020ceb5
MD
306};
307
b2cc986a 308#define LTTNG_UST_CTX_PADDING 20
8020ceb5
MD
309struct lttng_ctx {
310 struct lttng_ctx_field *fields;
311 unsigned int nr_fields;
312 unsigned int allocated_fields;
b2cc986a 313 unsigned int largest_align;
37d5e202
MD
314 char padding[LTTNG_UST_CTX_PADDING];
315};
316
317#define LTTNG_UST_EVENT_DESC_PADDING 40
318struct lttng_event_desc {
319 const char *name;
fbdeb5ec 320 void (*probe_callback)(void);
37d5e202
MD
321 const struct lttng_event_ctx *ctx; /* context */
322 const struct lttng_event_field *fields; /* event payload */
323 unsigned int nr_fields;
324 const int **loglevel;
68755429 325 const char *signature; /* Argument types/names received */
6ddc916d
MD
326 union {
327 struct {
328 const char **model_emf_uri;
329 } ext;
330 char padding[LTTNG_UST_EVENT_DESC_PADDING];
331 } u;
37d5e202
MD
332};
333
71d31690 334#define LTTNG_UST_PROBE_DESC_PADDING 12
37d5e202
MD
335struct lttng_probe_desc {
336 const char *provider;
337 const struct lttng_event_desc **event_desc;
338 unsigned int nr_events;
339 struct cds_list_head head; /* chain registered probes */
6715d7d1
MD
340 struct cds_list_head lazy_init_head;
341 int lazy; /* lazy registration */
71d31690
MD
342 uint32_t major;
343 uint32_t minor;
37d5e202 344 char padding[LTTNG_UST_PROBE_DESC_PADDING];
8020ceb5
MD
345};
346
37d5e202
MD
347/* Data structures used by the tracer. */
348
e58095ef 349enum lttng_enabler_type {
196ec2df 350 LTTNG_ENABLER_STAR_GLOB,
e58095ef 351 LTTNG_ENABLER_EVENT,
e6c12e3d
MD
352};
353
354/*
e58095ef
MD
355 * Enabler field, within whatever object is enabling an event. Target of
356 * backward reference.
e6c12e3d 357 */
e58095ef
MD
358struct lttng_enabler {
359 enum lttng_enabler_type type;
360
361 /* head list of struct lttng_ust_filter_bytecode_node */
362 struct cds_list_head filter_bytecode_head;
0f63324a
JI
363 /* head list of struct lttng_ust_excluder_node */
364 struct cds_list_head excluder_head;
e58095ef
MD
365 struct cds_list_head node; /* per-session list of enablers */
366
367 struct lttng_ust_event event_param;
368 struct lttng_channel *chan;
416165a5
FD
369 /*
370 * Unused, but kept around to make it explicit that the tracer can do
371 * it.
372 */
e58095ef
MD
373 struct lttng_ctx *ctx;
374 unsigned int enabled:1;
e6c12e3d
MD
375};
376
c8fcf224
MD
377struct tp_list_entry {
378 struct lttng_ust_tracepoint_iter tp;
379 struct cds_list_head head;
380};
381
382struct lttng_ust_tracepoint_list {
383 struct tp_list_entry *iter;
384 struct cds_list_head head;
8020ceb5
MD
385};
386
06d4f27e
MD
387struct tp_field_list_entry {
388 struct lttng_ust_field_iter field;
389 struct cds_list_head head;
390};
391
392struct lttng_ust_field_list {
393 struct tp_field_list_entry *iter;
394 struct cds_list_head head;
395};
396
8165c8da 397struct ust_pending_probe;
7dd08bec 398struct lttng_event;
f488575f
MD
399
400struct lttng_ust_filter_bytecode_node {
401 struct cds_list_head node;
e58095ef 402 struct lttng_enabler *enabler;
a543151c
MD
403 /*
404 * struct lttng_ust_filter_bytecode has var. sized array, must
405 * be last field.
406 */
407 struct lttng_ust_filter_bytecode bc;
f488575f
MD
408};
409
0f63324a
JI
410struct lttng_ust_excluder_node {
411 struct cds_list_head node;
412 struct lttng_enabler *enabler;
413 /*
414 * struct lttng_ust_event_exclusion had variable sized array,
415 * must be last field.
416 */
417 struct lttng_ust_event_exclusion excluder;
418};
8a92ed2a
MD
419/*
420 * Filter return value masks.
421 */
422enum lttng_filter_ret {
423 LTTNG_FILTER_DISCARD = 0,
424 LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
425 /* Other bits are kept for future use. */
426};
427
f488575f
MD
428struct lttng_bytecode_runtime {
429 /* Associated bytecode */
430 struct lttng_ust_filter_bytecode_node *bc;
8a92ed2a 431 uint64_t (*filter)(void *filter_data, const char *filter_stack_data);
21af05a9 432 int link_failed;
e58095ef 433 struct cds_list_head node; /* list of bytecode runtime in event */
53569322 434 struct lttng_session *session;
47e5f13e 435 struct lttng_event *event;
e58095ef
MD
436};
437
438/*
439 * Objects in a linked-list of enablers, owned by an event.
440 */
441struct lttng_enabler_ref {
442 struct cds_list_head node; /* enabler ref list */
443 struct lttng_enabler *ref; /* backward ref */
f488575f 444};
8165c8da 445
8020ceb5 446/*
7dd08bec
MD
447 * lttng_event structure is referred to by the tracing fast path. It
448 * must be kept small.
180901e6
MD
449 *
450 * IMPORTANT: this structure is part of the ABI between the probe and
451 * UST. Fields need to be only added at the end, never reordered, never
452 * removed.
8020ceb5 453 */
7dd08bec 454struct lttng_event {
180901e6 455 /* LTTng-UST 2.0 starts here */
8020ceb5 456 unsigned int id;
7dd08bec 457 struct lttng_channel *chan;
976fe9ea 458 int enabled;
8020ceb5 459 const struct lttng_event_desc *desc;
e58095ef 460 void *_deprecated1;
8020ceb5 461 struct lttng_ctx *ctx;
9f3fdbc6 462 enum lttng_ust_instrumentation instrumentation;
e58095ef
MD
463 struct cds_list_head node; /* Event list in session */
464 struct cds_list_head _deprecated2;
465 void *_deprecated3;
13b21cd6 466 unsigned int _deprecated4:1;
e58095ef 467
180901e6 468 /* LTTng-UST 2.1 starts here */
e58095ef
MD
469 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
470 struct cds_list_head bytecode_runtime_head;
dcdeaff0 471 int has_enablers_without_bytecode;
e58095ef
MD
472 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
473 struct cds_list_head enablers_ref_head;
d56fa719 474 struct cds_hlist_node hlist; /* session ht of events */
ac6b4ac6 475 int registered; /* has reg'd tracepoint probe */
8020ceb5
MD
476};
477
c785c634
MD
478struct lttng_enum {
479 const struct lttng_enum_desc *desc;
480 struct lttng_session *session;
481 struct cds_list_head node; /* Enum list in session */
482 struct cds_hlist_node hlist; /* Session ht of enums */
483 uint64_t id; /* Enumeration ID in sessiond */
484};
485
8d8a24c8 486struct channel;
38fae1d3 487struct lttng_ust_shm_handle;
8d8a24c8 488
180901e6
MD
489/*
490 * IMPORTANT: this structure is part of the ABI between the probe and
491 * UST. Fields need to be only added at the end, never reordered, never
492 * removed.
493 */
7dd08bec
MD
494struct lttng_channel_ops {
495 struct lttng_channel *(*channel_create)(const char *name,
74d81a6c
MD
496 void *buf_addr,
497 size_t subbuf_size, size_t num_subbuf,
498 unsigned int switch_timer_interval,
499 unsigned int read_timer_interval,
6ca18e66 500 unsigned char *uuid,
a9ff648c 501 uint32_t chan_id,
b2c5f61a
MD
502 const int *stream_fds, int nr_stream_fds,
503 int64_t blocking_timeout);
74d81a6c 504 void (*channel_destroy)(struct lttng_channel *chan);
a44c74d9
MD
505 union {
506 void *_deprecated1;
507 unsigned long has_strcpy:1; /* ABI has strcpy */
508 } u;
9e917229 509 void *_deprecated2;
4cfec15c 510 int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
8020ceb5 511 uint32_t event_id);
4cfec15c 512 void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
74d81a6c
MD
513 void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
514 const void *src, size_t len);
8020ceb5
MD
515 /*
516 * packet_avail_size returns the available size in the current
517 * packet. Note that the size returned is only a hint, since it
518 * may change due to concurrent writes.
519 */
1d498196 520 size_t (*packet_avail_size)(struct channel *chan,
38fae1d3 521 struct lttng_ust_shm_handle *handle);
9f3fdbc6
MD
522 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
523 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
8020ceb5
MD
524 int (*is_finalized)(struct channel *chan);
525 int (*is_disabled)(struct channel *chan);
38fae1d3 526 int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
a44c74d9
MD
527 void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
528 const char *src, size_t len);
8020ceb5
MD
529};
530
180901e6
MD
531/*
532 * IMPORTANT: this structure is part of the ABI between the probe and
533 * UST. Fields need to be only added at the end, never reordered, never
534 * removed.
535 */
7dd08bec 536struct lttng_channel {
a3f61e7f
MD
537 /*
538 * The pointers located in this private data are NOT safe to be
539 * dereferenced by the consumer. The only operations the
540 * consumer process is designed to be allowed to do is to read
541 * and perform subbuffer flush.
542 */
8020ceb5 543 struct channel *chan; /* Channel buffers */
976fe9ea 544 int enabled;
8020ceb5
MD
545 struct lttng_ctx *ctx;
546 /* Event ID management */
7dd08bec 547 struct lttng_session *session;
0a42beb6 548 int objd; /* Object associated to channel */
32ce8569
MD
549 unsigned int _deprecated1;
550 unsigned int _deprecated2;
e58095ef 551 struct cds_list_head node; /* Channel list in session */
74d81a6c 552 const struct lttng_channel_ops *ops;
8020ceb5 553 int header_type; /* 0: unset, 1: compact, 2: large */
38fae1d3 554 struct lttng_ust_shm_handle *handle; /* shared-memory handle */
13b21cd6 555 unsigned int _deprecated3:1;
a3f61e7f 556
74d81a6c 557 /* Channel ID */
a3f61e7f 558 unsigned int id;
74d81a6c 559 enum lttng_ust_chan_type type;
19d8b1b3 560 unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
ac6b4ac6 561 int tstate:1; /* Transient enable state */
8020ceb5
MD
562};
563
53569322
MD
564#define LTTNG_UST_STACK_CTX_PADDING 32
565struct lttng_stack_ctx {
566 struct lttng_event *event;
567 struct lttng_ctx *chan_ctx; /* RCU dereferenced. */
568 struct lttng_ctx *event_ctx; /* RCU dereferenced. */
569 char padding[LTTNG_UST_STACK_CTX_PADDING];
570};
571
71a9d034 572#define LTTNG_UST_EVENT_HT_BITS 12
e58095ef
MD
573#define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
574
575struct lttng_ust_event_ht {
576 struct cds_hlist_head table[LTTNG_UST_EVENT_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
582struct lttng_ust_enum_ht {
583 struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
584};
585
180901e6
MD
586/*
587 * IMPORTANT: this structure is part of the ABI between the probe and
588 * UST. Fields need to be only added at the end, never reordered, never
589 * removed.
590 */
7dd08bec 591struct lttng_session {
e58095ef
MD
592 int active; /* Is trace session active ? */
593 int been_active; /* Been active ? */
594 int objd; /* Object associated */
13b21cd6 595 void *_deprecated1;
e58095ef
MD
596 struct cds_list_head chan_head; /* Channel list head */
597 struct cds_list_head events_head; /* list of events */
13b21cd6 598 struct cds_list_head _deprecated2;
e58095ef 599 struct cds_list_head node; /* Session list */
13b21cd6
MD
600 int _deprecated3;
601 unsigned int _deprecated4:1;
e58095ef
MD
602
603 /* New UST 2.1 */
604 /* List of enablers */
605 struct cds_list_head enablers_head;
d56fa719 606 struct lttng_ust_event_ht events_ht; /* ht of events */
32ce8569 607 void *owner; /* object owner */
ac6b4ac6 608 int tstate:1; /* Transient enable state */
246be17e
PW
609
610 /* New UST 2.4 */
611 int statedump_pending:1;
c785c634
MD
612
613 /* New UST 2.8 */
614 struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */
615 struct cds_list_head enums_head;
53569322 616 struct lttng_ctx *ctx; /* contexts for filters. */
8020ceb5
MD
617};
618
7dd08bec 619struct lttng_transport {
8020ceb5 620 char *name;
9f3fdbc6 621 struct cds_list_head node;
7dd08bec 622 struct lttng_channel_ops ops;
74d81a6c 623 const struct lttng_ust_lib_ring_buffer_config *client_config;
8020ceb5
MD
624};
625
7dd08bec
MD
626struct lttng_session *lttng_session_create(void);
627int lttng_session_enable(struct lttng_session *session);
628int lttng_session_disable(struct lttng_session *session);
710b8ee3 629int lttng_session_statedump(struct lttng_session *session);
7dd08bec 630void lttng_session_destroy(struct lttng_session *session);
8020ceb5 631
7dd08bec 632struct lttng_channel *lttng_channel_create(struct lttng_session *session,
8020ceb5
MD
633 const char *transport_name,
634 void *buf_addr,
635 size_t subbuf_size, size_t num_subbuf,
636 unsigned int switch_timer_interval,
193183fb 637 unsigned int read_timer_interval,
ef9ff354
MD
638 int **shm_fd, int **wait_fd,
639 uint64_t **memory_map_size,
7dd08bec 640 struct lttng_channel *chan_priv_init);
8020ceb5 641
7dd08bec
MD
642int lttng_channel_enable(struct lttng_channel *channel);
643int lttng_channel_disable(struct lttng_channel *channel);
e58095ef
MD
644
645struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type,
646 struct lttng_ust_event *event_param,
647 struct lttng_channel *chan);
648int lttng_enabler_enable(struct lttng_enabler *enabler);
649int lttng_enabler_disable(struct lttng_enabler *enabler);
650int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
651 struct lttng_ust_filter_bytecode_node *bytecode);
652int lttng_enabler_attach_context(struct lttng_enabler *enabler,
653 struct lttng_ust_context *ctx);
0bfb5cbd
JI
654int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler,
655 struct lttng_ust_excluder_node *excluder);
e58095ef
MD
656
657int lttng_attach_context(struct lttng_ust_context *context_param,
8e696cfa 658 union ust_args *uargs,
e58095ef 659 struct lttng_ctx **ctx, struct lttng_session *session);
53569322 660int lttng_session_context_init(struct lttng_ctx **ctx);
976fe9ea 661
7dd08bec
MD
662void lttng_transport_register(struct lttng_transport *transport);
663void lttng_transport_unregister(struct lttng_transport *transport);
8020ceb5 664
4b4de73e 665void synchronize_trace(void);
8020ceb5 666
7dd08bec
MD
667int lttng_probe_register(struct lttng_probe_desc *desc);
668void lttng_probe_unregister(struct lttng_probe_desc *desc);
35ac38cb 669void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc);
5f733922 670int lttng_fix_pending_events(void);
7dd08bec
MD
671int lttng_probes_init(void);
672void lttng_probes_exit(void);
8173ec7c 673int lttng_find_context(struct lttng_ctx *ctx, const char *name);
77aa5901 674int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
8173ec7c 675struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p);
b2cc986a 676void lttng_context_update(struct lttng_ctx *ctx);
8173ec7c 677void lttng_remove_context_field(struct lttng_ctx **ctx_p,
8020ceb5
MD
678 struct lttng_ctx_field *field);
679void lttng_destroy_context(struct lttng_ctx *ctx);
3b402b40 680int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
c1ef86f0 681int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
8173ec7c 682int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
4847e9bb 683int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
96f85541 684int lttng_add_ip_to_ctx(struct lttng_ctx **ctx);
c7ea8487 685int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
53569322 686int lttng_add_dyntest_to_ctx(struct lttng_ctx **ctx);
735bef47
MJ
687int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
688int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
689int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
690int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
691int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
692int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
693int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
fca2f191
MJ
694int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
695int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
696int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
697int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
698int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
699int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
a93bfc45 700void lttng_context_vtid_reset(void);
c1ef86f0 701void lttng_context_vpid_reset(void);
46228a6f 702void lttng_context_procname_reset(void);
735bef47
MJ
703void lttng_context_cgroup_ns_reset(void);
704void lttng_context_ipc_ns_reset(void);
705void lttng_context_mnt_ns_reset(void);
706void lttng_context_net_ns_reset(void);
707void lttng_context_pid_ns_reset(void);
708void lttng_context_user_ns_reset(void);
709void lttng_context_uts_ns_reset(void);
fca2f191
MJ
710void lttng_context_vuid_reset(void);
711void lttng_context_veuid_reset(void);
712void lttng_context_vsuid_reset(void);
713void lttng_context_vgid_reset(void);
714void lttng_context_vegid_reset(void);
715void lttng_context_vsgid_reset(void);
9f3fdbc6 716
d58d1454
MD
717#ifdef LTTNG_UST_HAVE_PERF_EVENT
718int lttng_add_perf_counter_to_ctx(uint32_t type,
719 uint64_t config,
720 const char *name,
721 struct lttng_ctx **ctx);
722int lttng_perf_counter_init(void);
723void lttng_perf_counter_exit(void);
724#else /* #ifdef LTTNG_UST_HAVE_PERF_EVENT */
725static inline
726int lttng_add_perf_counter_to_ctx(uint32_t type,
727 uint64_t config,
728 const char *name,
729 struct lttng_ctx **ctx)
730{
731 return -ENOSYS;
732}
733static inline
734int lttng_perf_counter_init(void)
735{
736 return 0;
737}
738static inline
739void lttng_perf_counter_exit(void)
740{
741}
742#endif /* #else #ifdef LTTNG_UST_HAVE_PERF_EVENT */
743
82b9bde8
JD
744extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
745extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
746extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
c1fca457 747
7dd08bec 748struct lttng_transport *lttng_transport_find(const char *name);
c1fca457 749
7dd08bec
MD
750int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
751void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
c8fcf224
MD
752struct lttng_ust_tracepoint_iter *
753 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
7dd08bec
MD
754int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
755void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
06d4f27e
MD
756struct lttng_ust_field_iter *
757 lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
c8fcf224 758
e58095ef
MD
759void lttng_enabler_event_link_bytecode(struct lttng_event *event,
760 struct lttng_enabler *enabler);
7dd08bec 761void lttng_free_event_filter_runtime(struct lttng_event *event);
e58095ef
MD
762void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
763
764struct cds_list_head *lttng_get_probe_list_head(void);
6715d7d1 765int lttng_session_active(void);
e6c12e3d 766
246be17e 767typedef int (*t_statedump_func_ptr)(struct lttng_session *session);
3327ac33 768void lttng_handle_pending_statedump(void *owner);
37dddb65 769struct cds_list_head *_lttng_get_sessions(void);
b33b46f7
FD
770
771struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
772 const struct lttng_enum_desc *enum_desc);
246be17e 773
97c7c238 774void lttng_ust_dl_update(void *ip);
6548fca4 775void lttng_ust_fixup_fd_tracker_tls(void);
97c7c238 776
4a1f7569
MD
777/* For backward compatibility. Leave those exported symbols in place. */
778extern struct lttng_ctx *lttng_static_ctx;
779void lttng_context_init(void);
780void lttng_context_exit(void);
a211b293 781void lttng_filter_event_link_bytecode(struct lttng_event *event);
4a1f7569 782
6453d237
MD
783#ifdef __cplusplus
784}
785#endif
786
51489cad 787#endif /* _LTTNG_UST_EVENTS_H */
This page took 0.074458 seconds and 4 git commands to generate.