Cleanup: Rename filter functions/fields to mention "filter"
[lttng-ust.git] / include / lttng / ust-events.h
1 #ifndef _LTTNG_UST_EVENTS_H
2 #define _LTTNG_UST_EVENTS_H
3
4 /*
5 * lttng/ust-events.h
6 *
7 * Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * Holds LTTng per-session event registry.
10 *
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:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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.
28 */
29
30 #include <urcu/list.h>
31 #include <urcu/hlist.h>
32 #include <stddef.h>
33 #include <stdint.h>
34 #include <lttng/ust-config.h>
35 #include <lttng/ust-abi.h>
36 #include <lttng/ust-tracer.h>
37 #include <lttng/ust-endian.h>
38 #include <float.h>
39 #include <errno.h>
40 #include <urcu/ref.h>
41 #include <pthread.h>
42
43 #ifndef LTTNG_PACKED
44 #error "LTTNG_PACKED should be defined"
45 #endif
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 #define LTTNG_UST_UUID_LEN 16
52
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 2
60 #define LTTNG_UST_PROVIDER_MINOR 0
61
62 struct lttng_channel;
63 struct lttng_session;
64 struct lttng_ust_lib_ring_buffer_ctx;
65 struct lttng_ust_context_app;
66 struct lttng_event_field;
67
68 /*
69 * Data structures used by tracepoint event declarations, and by the
70 * tracer. Those structures have padding for future extension.
71 */
72
73 /*
74 * LTTng client type enumeration. Used by the consumer to map the
75 * callbacks from its own address space.
76 */
77 enum lttng_client_types {
78 LTTNG_CLIENT_METADATA = 0,
79 LTTNG_CLIENT_DISCARD = 1,
80 LTTNG_CLIENT_OVERWRITE = 2,
81 LTTNG_CLIENT_DISCARD_RT = 3,
82 LTTNG_CLIENT_OVERWRITE_RT = 4,
83 LTTNG_NR_CLIENT_TYPES,
84 };
85
86 /* Type description */
87
88 /* Update the astract_types name table in lttng-types.c along with this enum */
89 enum lttng_abstract_types {
90 atype_integer,
91 atype_enum, /* legacy */
92 atype_array, /* legacy */
93 atype_sequence, /* legacy */
94 atype_string,
95 atype_float,
96 atype_dynamic,
97 atype_struct, /* legacy */
98 atype_enum_nestable,
99 atype_array_nestable,
100 atype_sequence_nestable,
101 atype_struct_nestable,
102 NR_ABSTRACT_TYPES,
103 };
104
105 /* Update the string_encodings name table in lttng-types.c along with this enum */
106 enum lttng_string_encodings {
107 lttng_encode_none = 0,
108 lttng_encode_UTF8 = 1,
109 lttng_encode_ASCII = 2,
110 NR_STRING_ENCODINGS,
111 };
112
113 struct lttng_enum_value {
114 unsigned long long value;
115 unsigned int signedness:1;
116 };
117
118 enum lttng_enum_entry_options {
119 LTTNG_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
120 };
121
122 #define LTTNG_UST_ENUM_ENTRY_PADDING 16
123 struct lttng_enum_entry {
124 struct lttng_enum_value start, end; /* start and end are inclusive */
125 const char *string;
126 union {
127 struct {
128 unsigned int options;
129 } LTTNG_PACKED extra;
130 char padding[LTTNG_UST_ENUM_ENTRY_PADDING];
131 } u;
132 };
133
134 #define __type_integer(_type, _byte_order, _base, _encoding) \
135 { \
136 .atype = atype_integer, \
137 .u = \
138 { \
139 .integer = \
140 { \
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, \
147 } \
148 }, \
149 } \
150
151 #define LTTNG_UST_INTEGER_TYPE_PADDING 24
152 struct 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;
159 char padding[LTTNG_UST_INTEGER_TYPE_PADDING];
160 };
161
162 /*
163 * Only float and double are supported. long double is not supported at
164 * the moment.
165 */
166 #define _float_mant_dig(_type) \
167 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
168 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
169 : 0))
170
171 #define __type_float(_type) \
172 { \
173 .atype = atype_float, \
174 .u = \
175 { \
176 ._float = \
177 { \
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, \
183 } \
184 } \
185 } \
186
187 #define LTTNG_UST_FLOAT_TYPE_PADDING 24
188 struct 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;
193 char padding[LTTNG_UST_FLOAT_TYPE_PADDING];
194 };
195
196 /* legacy */
197 #define LTTNG_UST_BASIC_TYPE_PADDING 128
198 union _lttng_basic_type {
199 struct lttng_integer_type integer; /* legacy */
200 struct {
201 const struct lttng_enum_desc *desc; /* Enumeration mapping */
202 struct lttng_integer_type container_type;
203 } enumeration; /* legacy */
204 struct {
205 enum lttng_string_encodings encoding;
206 } string; /* legacy */
207 struct lttng_float_type _float; /* legacy */
208 char padding[LTTNG_UST_BASIC_TYPE_PADDING];
209 };
210
211 /* legacy */
212 struct lttng_basic_type {
213 enum lttng_abstract_types atype;
214 union {
215 union _lttng_basic_type basic;
216 } u;
217 };
218
219 #define LTTNG_UST_TYPE_PADDING 128
220 struct lttng_type {
221 enum lttng_abstract_types atype;
222 union {
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;
233 struct {
234 const struct lttng_type *elem_type;
235 unsigned int length; /* Num. elems. */
236 unsigned int alignment;
237 } array_nestable;
238 struct {
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;
243 struct {
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;
265 char padding[LTTNG_UST_TYPE_PADDING];
266 } u;
267 };
268
269 #define LTTNG_UST_ENUM_TYPE_PADDING 24
270 struct lttng_enum_desc {
271 const char *name;
272 const struct lttng_enum_entry *entries;
273 unsigned int nr_entries;
274 char padding[LTTNG_UST_ENUM_TYPE_PADDING];
275 };
276
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 */
284
285 #define LTTNG_UST_EVENT_FIELD_PADDING 28
286 struct lttng_event_field {
287 const char *name;
288 struct lttng_type type;
289 unsigned int nowrite; /* do not write into trace */
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;
296 };
297
298 enum 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
314 struct 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;
321 };
322
323 struct lttng_perf_counter_field;
324
325 #define LTTNG_UST_CTX_FIELD_PADDING 40
326 struct lttng_ctx_field {
327 struct lttng_event_field event_field;
328 size_t (*get_size)(struct lttng_ctx_field *field, size_t offset);
329 void (*record)(struct lttng_ctx_field *field,
330 struct lttng_ust_lib_ring_buffer_ctx *ctx,
331 struct lttng_channel *chan);
332 void (*get_value)(struct lttng_ctx_field *field,
333 struct lttng_ctx_value *value);
334 union {
335 struct lttng_perf_counter_field *perf_counter;
336 char padding[LTTNG_UST_CTX_FIELD_PADDING];
337 } u;
338 void (*destroy)(struct lttng_ctx_field *field);
339 char *field_name; /* Has ownership, dynamically allocated. */
340 };
341
342 #define LTTNG_UST_CTX_PADDING 20
343 struct lttng_ctx {
344 struct lttng_ctx_field *fields;
345 unsigned int nr_fields;
346 unsigned int allocated_fields;
347 unsigned int largest_align;
348 char padding[LTTNG_UST_CTX_PADDING];
349 };
350
351 #define LTTNG_UST_EVENT_DESC_PADDING 40
352 struct lttng_event_desc {
353 const char *name;
354 void (*probe_callback)(void);
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;
359 const char *signature; /* Argument types/names received */
360 union {
361 struct {
362 const char **model_emf_uri;
363 void (*event_notifier_callback)(void);
364 } ext;
365 char padding[LTTNG_UST_EVENT_DESC_PADDING];
366 } u;
367 };
368
369 #define LTTNG_UST_PROBE_DESC_PADDING 12
370 struct lttng_probe_desc {
371 const char *provider;
372 const struct lttng_event_desc **event_desc;
373 unsigned int nr_events;
374 struct cds_list_head head; /* chain registered probes */
375 struct cds_list_head lazy_init_head;
376 int lazy; /* lazy registration */
377 uint32_t major;
378 uint32_t minor;
379 char padding[LTTNG_UST_PROBE_DESC_PADDING];
380 };
381
382 /* Data structures used by the tracer. */
383
384 enum lttng_enabler_format_type {
385 LTTNG_ENABLER_FORMAT_STAR_GLOB,
386 LTTNG_ENABLER_FORMAT_EVENT,
387 };
388
389 /*
390 * Enabler field, within whatever object is enabling an event. Target of
391 * backward reference.
392 */
393 struct lttng_enabler {
394 enum lttng_enabler_format_type format_type;
395
396 /* head list of struct lttng_ust_filter_bytecode_node */
397 struct cds_list_head filter_bytecode_head;
398 /* head list of struct lttng_ust_excluder_node */
399 struct cds_list_head excluder_head;
400
401 struct lttng_ust_event event_param;
402 unsigned int enabled:1;
403 };
404
405 struct tp_list_entry {
406 struct lttng_ust_tracepoint_iter tp;
407 struct cds_list_head head;
408 };
409
410 struct lttng_ust_tracepoint_list {
411 struct tp_list_entry *iter;
412 struct cds_list_head head;
413 };
414
415 struct tp_field_list_entry {
416 struct lttng_ust_field_iter field;
417 struct cds_list_head head;
418 };
419
420 struct lttng_ust_field_list {
421 struct tp_field_list_entry *iter;
422 struct cds_list_head head;
423 };
424
425 struct ust_pending_probe;
426 struct lttng_event;
427
428 /*
429 * Filter return value masks.
430 */
431 enum lttng_filter_ret {
432 LTTNG_FILTER_DISCARD = 0,
433 LTTNG_FILTER_RECORD_FLAG = (1ULL << 0),
434 /* Other bits are kept for future use. */
435 };
436
437 /*
438 * This structure is used in the probes. More specifically, the `filter` and
439 * `node` fields are explicity used in the probes. When modifying this
440 * structure we must not change the layout of these two fields as it is
441 * considered ABI.
442 */
443 struct lttng_bytecode_runtime {
444 /* Associated bytecode */
445 struct lttng_ust_filter_bytecode_node *bc;
446 uint64_t (*filter)(void *filter_data, const char *filter_stack_data);
447 int link_failed;
448 struct cds_list_head node; /* list of bytecode runtime in event */
449 /*
450 * Pointer to a URCU-protected pointer owned by an `struct
451 * lttng_session`or `struct lttng_event_notifier_group`.
452 */
453 struct lttng_ctx **pctx;
454 };
455
456 /*
457 * Objects in a linked-list of enablers, owned by an event or event_notifier.
458 * This is used because an event (or a event_notifier) can be enabled by more
459 * than one enabler and we want a quick way to iterate over all enablers of an
460 * object.
461 *
462 * For example, event rules "my_app:a*" and "my_app:ab*" will both match the
463 * event with the name "my_app:abc".
464 */
465 struct lttng_enabler_ref {
466 struct cds_list_head node; /* enabler ref list */
467 struct lttng_enabler *ref; /* backward ref */
468 };
469
470 /*
471 * lttng_event structure is referred to by the tracing fast path. It
472 * must be kept small.
473 *
474 * IMPORTANT: this structure is part of the ABI between the probe and
475 * UST. Fields need to be only added at the end, never reordered, never
476 * removed.
477 */
478 struct lttng_event {
479 /* LTTng-UST 2.0 starts here */
480 unsigned int id;
481 struct lttng_channel *chan;
482 int enabled;
483 const struct lttng_event_desc *desc;
484 void *_deprecated1;
485 struct lttng_ctx *ctx;
486 enum lttng_ust_instrumentation instrumentation;
487 struct cds_list_head node; /* Event list in session */
488 struct cds_list_head _deprecated2;
489 void *_deprecated3;
490 unsigned int _deprecated4:1;
491
492 /* LTTng-UST 2.1 starts here */
493 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
494 struct cds_list_head filter_bytecode_runtime_head;
495 int has_enablers_without_bytecode;
496 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
497 struct cds_list_head enablers_ref_head;
498 struct cds_hlist_node hlist; /* session ht of events */
499 int registered; /* has reg'd tracepoint probe */
500 };
501
502 struct lttng_event_notifier {
503 uint64_t user_token;
504 int enabled;
505 int registered; /* has reg'd tracepoint probe */
506 struct cds_list_head filter_bytecode_runtime_head;
507 int has_enablers_without_bytecode;
508 struct cds_list_head enablers_ref_head;
509 const struct lttng_event_desc *desc;
510 struct cds_hlist_node hlist; /* hashtable of event_notifiers */
511 struct cds_list_head node; /* event_notifier list in session */
512 struct lttng_event_notifier_group *group; /* weak ref */
513 };
514
515 struct lttng_enum {
516 const struct lttng_enum_desc *desc;
517 struct lttng_session *session;
518 struct cds_list_head node; /* Enum list in session */
519 struct cds_hlist_node hlist; /* Session ht of enums */
520 uint64_t id; /* Enumeration ID in sessiond */
521 };
522
523 struct channel;
524 struct lttng_ust_shm_handle;
525
526 /*
527 * IMPORTANT: this structure is part of the ABI between the probe and
528 * UST. Fields need to be only added at the end, never reordered, never
529 * removed.
530 */
531 struct lttng_channel_ops {
532 struct lttng_channel *(*channel_create)(const char *name,
533 void *buf_addr,
534 size_t subbuf_size, size_t num_subbuf,
535 unsigned int switch_timer_interval,
536 unsigned int read_timer_interval,
537 unsigned char *uuid,
538 uint32_t chan_id,
539 const int *stream_fds, int nr_stream_fds,
540 int64_t blocking_timeout);
541 void (*channel_destroy)(struct lttng_channel *chan);
542 union {
543 void *_deprecated1;
544 /*
545 * has_strcpy is needed by probe providers version 1.0 to
546 * dynamically detect whether the LTTng-UST tracepoint
547 * provider ABI implements event_strcpy. Starting from
548 * probe providers version 2.0, the check is not needed,
549 * but backward compatibility is provided for older versions.
550 */
551 unsigned long has_strcpy:1; /* ABI has strcpy */
552 } u;
553 void *_deprecated2;
554 int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
555 uint32_t event_id);
556 void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
557 void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
558 const void *src, size_t len);
559 /*
560 * packet_avail_size returns the available size in the current
561 * packet. Note that the size returned is only a hint, since it
562 * may change due to concurrent writes.
563 */
564 size_t (*packet_avail_size)(struct channel *chan,
565 struct lttng_ust_shm_handle *handle);
566 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
567 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
568 int (*is_finalized)(struct channel *chan);
569 int (*is_disabled)(struct channel *chan);
570 int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
571 void (*event_strcpy)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
572 const char *src, size_t len);
573 };
574
575 /*
576 * IMPORTANT: this structure is part of the ABI between the probe and
577 * UST. Fields need to be only added at the end, never reordered, never
578 * removed.
579 */
580 struct lttng_channel {
581 /*
582 * The pointers located in this private data are NOT safe to be
583 * dereferenced by the consumer. The only operations the
584 * consumer process is designed to be allowed to do is to read
585 * and perform subbuffer flush.
586 */
587 struct channel *chan; /* Channel buffers */
588 int enabled;
589 struct lttng_ctx *ctx;
590 /* Event ID management */
591 struct lttng_session *session;
592 int objd; /* Object associated to channel */
593 unsigned int _deprecated1;
594 unsigned int _deprecated2;
595 struct cds_list_head node; /* Channel list in session */
596 const struct lttng_channel_ops *ops;
597 int header_type; /* 0: unset, 1: compact, 2: large */
598 struct lttng_ust_shm_handle *handle; /* shared-memory handle */
599 unsigned int _deprecated3:1;
600
601 /* Channel ID */
602 unsigned int id;
603 enum lttng_ust_chan_type type;
604 unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
605 int tstate:1; /* Transient enable state */
606 };
607
608 #define LTTNG_UST_STACK_CTX_PADDING 32
609 struct lttng_stack_ctx {
610 struct lttng_event *event;
611 struct lttng_ctx *chan_ctx; /* RCU dereferenced. */
612 struct lttng_ctx *event_ctx; /* RCU dereferenced. */
613 char padding[LTTNG_UST_STACK_CTX_PADDING];
614 };
615
616 #define LTTNG_UST_EVENT_HT_BITS 12
617 #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
618
619 struct lttng_ust_event_ht {
620 struct cds_hlist_head table[LTTNG_UST_EVENT_HT_SIZE];
621 };
622
623 #define LTTNG_UST_EVENT_NOTIFIER_HT_BITS 12
624 #define LTTNG_UST_EVENT_NOTIFIER_HT_SIZE (1U << LTTNG_UST_EVENT_NOTIFIER_HT_BITS)
625 struct lttng_ust_event_notifier_ht {
626 struct cds_hlist_head table[LTTNG_UST_EVENT_NOTIFIER_HT_SIZE];
627 };
628
629 #define LTTNG_UST_ENUM_HT_BITS 12
630 #define LTTNG_UST_ENUM_HT_SIZE (1U << LTTNG_UST_ENUM_HT_BITS)
631
632 struct lttng_ust_enum_ht {
633 struct cds_hlist_head table[LTTNG_UST_ENUM_HT_SIZE];
634 };
635
636 /*
637 * IMPORTANT: this structure is part of the ABI between the probe and
638 * UST. Fields need to be only added at the end, never reordered, never
639 * removed.
640 */
641 struct lttng_session {
642 int active; /* Is trace session active ? */
643 int been_active; /* Been active ? */
644 int objd; /* Object associated */
645 void *_deprecated1;
646 struct cds_list_head chan_head; /* Channel list head */
647 struct cds_list_head events_head; /* list of events */
648 struct cds_list_head _deprecated2;
649 struct cds_list_head node; /* Session list */
650 int _deprecated3;
651 unsigned int _deprecated4:1;
652
653 /* New UST 2.1 */
654 /* List of enablers */
655 struct cds_list_head enablers_head;
656 struct lttng_ust_event_ht events_ht; /* ht of events */
657 void *owner; /* object owner */
658 int tstate:1; /* Transient enable state */
659
660 /* New UST 2.4 */
661 int statedump_pending:1;
662
663 /* New UST 2.8 */
664 struct lttng_ust_enum_ht enums_ht; /* ht of enumerations */
665 struct cds_list_head enums_head;
666 struct lttng_ctx *ctx; /* contexts for filters. */
667 };
668
669 struct lttng_event_notifier_group {
670 int objd;
671 void *owner;
672 int notification_fd;
673 struct cds_list_head node; /* Event notifier group handle list */
674 struct cds_list_head enablers_head;
675 struct cds_list_head event_notifiers_head; /* list of event_notifiers */
676 struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
677 struct lttng_ctx *ctx; /* contexts for filters. */
678 };
679
680 struct lttng_transport {
681 char *name;
682 struct cds_list_head node;
683 struct lttng_channel_ops ops;
684 const struct lttng_ust_lib_ring_buffer_config *client_config;
685 };
686
687 struct lttng_session *lttng_session_create(void);
688 int lttng_session_enable(struct lttng_session *session);
689 int lttng_session_disable(struct lttng_session *session);
690 int lttng_session_statedump(struct lttng_session *session);
691 void lttng_session_destroy(struct lttng_session *session);
692
693 void lttng_event_notifier_notification_send(
694 struct lttng_event_notifier *event_notifier);
695
696 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
697 const char *transport_name,
698 void *buf_addr,
699 size_t subbuf_size, size_t num_subbuf,
700 unsigned int switch_timer_interval,
701 unsigned int read_timer_interval,
702 int **shm_fd, int **wait_fd,
703 uint64_t **memory_map_size,
704 struct lttng_channel *chan_priv_init);
705
706 int lttng_channel_enable(struct lttng_channel *channel);
707 int lttng_channel_disable(struct lttng_channel *channel);
708
709 int lttng_attach_context(struct lttng_ust_context *context_param,
710 union ust_args *uargs,
711 struct lttng_ctx **ctx, struct lttng_session *session);
712 int lttng_session_context_init(struct lttng_ctx **ctx);
713
714 void lttng_transport_register(struct lttng_transport *transport);
715 void lttng_transport_unregister(struct lttng_transport *transport);
716
717 void synchronize_trace(void);
718
719 int lttng_probe_register(struct lttng_probe_desc *desc);
720 void lttng_probe_unregister(struct lttng_probe_desc *desc);
721 void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc);
722 int lttng_fix_pending_events(void);
723 int lttng_probes_init(void);
724 void lttng_probes_exit(void);
725 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
726 int lttng_get_context_index(struct lttng_ctx *ctx, const char *name);
727 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p);
728 void lttng_context_update(struct lttng_ctx *ctx);
729 void lttng_remove_context_field(struct lttng_ctx **ctx_p,
730 struct lttng_ctx_field *field);
731 void lttng_destroy_context(struct lttng_ctx *ctx);
732 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
733 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
734 int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
735 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
736 int lttng_add_ip_to_ctx(struct lttng_ctx **ctx);
737 int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
738 int lttng_add_dyntest_to_ctx(struct lttng_ctx **ctx);
739 int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
740 int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
741 int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
742 int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
743 int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
744 int lttng_add_time_ns_to_ctx(struct lttng_ctx **ctx);
745 int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
746 int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
747 int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
748 int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
749 int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
750 int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
751 int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
752 int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
753 void lttng_context_vtid_reset(void);
754 void lttng_context_vpid_reset(void);
755 void lttng_context_procname_reset(void);
756 void lttng_context_cgroup_ns_reset(void);
757 void lttng_context_ipc_ns_reset(void);
758 void lttng_context_mnt_ns_reset(void);
759 void lttng_context_net_ns_reset(void);
760 void lttng_context_pid_ns_reset(void);
761 void lttng_context_time_ns_reset(void);
762 void lttng_context_user_ns_reset(void);
763 void lttng_context_uts_ns_reset(void);
764 void lttng_context_vuid_reset(void);
765 void lttng_context_veuid_reset(void);
766 void lttng_context_vsuid_reset(void);
767 void lttng_context_vgid_reset(void);
768 void lttng_context_vegid_reset(void);
769 void lttng_context_vsgid_reset(void);
770
771 #ifdef LTTNG_UST_HAVE_PERF_EVENT
772 int lttng_add_perf_counter_to_ctx(uint32_t type,
773 uint64_t config,
774 const char *name,
775 struct lttng_ctx **ctx);
776 int lttng_perf_counter_init(void);
777 void lttng_perf_counter_exit(void);
778 #else /* #ifdef LTTNG_UST_HAVE_PERF_EVENT */
779 static inline
780 int lttng_add_perf_counter_to_ctx(uint32_t type,
781 uint64_t config,
782 const char *name,
783 struct lttng_ctx **ctx)
784 {
785 return -ENOSYS;
786 }
787 static inline
788 int lttng_perf_counter_init(void)
789 {
790 return 0;
791 }
792 static inline
793 void lttng_perf_counter_exit(void)
794 {
795 }
796 #endif /* #else #ifdef LTTNG_UST_HAVE_PERF_EVENT */
797
798 extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
799 extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
800 extern const struct lttng_ust_client_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
801
802 struct lttng_transport *lttng_transport_find(const char *name);
803
804 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
805 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
806 struct lttng_ust_tracepoint_iter *
807 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
808 int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
809 void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
810 struct lttng_ust_field_iter *
811 lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
812
813 void lttng_free_event_filter_runtime(struct lttng_event *event);
814 void lttng_filter_sync_state(struct lttng_bytecode_runtime *runtime);
815
816 struct cds_list_head *lttng_get_probe_list_head(void);
817 int lttng_session_active(void);
818
819 typedef int (*t_statedump_func_ptr)(struct lttng_session *session);
820 void lttng_handle_pending_statedump(void *owner);
821 struct cds_list_head *_lttng_get_sessions(void);
822
823 struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
824 const struct lttng_enum_desc *enum_desc);
825
826 void lttng_ust_dl_update(void *ip);
827 void lttng_ust_fixup_fd_tracker_tls(void);
828
829 /* For backward compatibility. Leave those exported symbols in place. */
830 extern struct lttng_ctx *lttng_static_ctx;
831 struct lttng_ust_filter_bytecode_node;
832 struct lttng_ust_excluder_node;
833 void lttng_context_init(void);
834 void lttng_context_exit(void);
835 void lttng_filter_event_link_bytecode(struct lttng_event *event);
836 struct lttng_enabler *lttng_enabler_create(
837 enum lttng_enabler_format_type format_type,
838 struct lttng_ust_event *event_param,
839 struct lttng_channel *chan);
840 int lttng_enabler_enable(struct lttng_enabler *enabler);
841 int lttng_enabler_disable(struct lttng_enabler *enabler);
842 int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler,
843 struct lttng_ust_filter_bytecode_node *bytecode);
844 int lttng_enabler_attach_context(struct lttng_enabler *enabler,
845 struct lttng_ust_context *ctx);
846 int lttng_enabler_attach_exclusion(struct lttng_enabler *enabler,
847 struct lttng_ust_excluder_node *excluder);
848 void lttng_enabler_event_link_bytecode(struct lttng_event *event,
849 struct lttng_enabler *enabler);
850
851 #ifdef __cplusplus
852 }
853 #endif
854
855 #endif /* _LTTNG_UST_EVENTS_H */
This page took 0.050578 seconds and 5 git commands to generate.