1 #ifndef _LTTNG_UST_EVENTS_H
2 #define _LTTNG_UST_EVENTS_H
7 * Copyright 2010-2012 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Holds LTTng per-session event registry.
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
30 #include <urcu/list.h>
31 #include <urcu/hlist.h>
33 #include <lttng/ust-config.h>
34 #include <lttng/ust-abi.h>
35 #include <lttng/ust-tracer.h>
36 #include <lttng/ust-endian.h>
46 #define LTTNG_UST_UUID_LEN 16
49 * Tracepoint provider version. Compatibility based on the major number.
50 * Older tracepoint providers can always register to newer lttng-ust
51 * library, but the opposite is rejected: a newer tracepoint provider is
52 * rejected by an older lttng-ust library.
54 #define LTTNG_UST_PROVIDER_MAJOR 1
55 #define LTTNG_UST_PROVIDER_MINOR 0
59 struct lttng_ust_lib_ring_buffer_ctx
;
62 * Data structures used by tracepoint event declarations, and by the
63 * tracer. Those structures have padding for future extension.
67 * LTTng client type enumeration. Used by the consumer to map the
68 * callbacks from its own address space.
70 enum lttng_client_types
{
71 LTTNG_CLIENT_METADATA
= 0,
72 LTTNG_CLIENT_DISCARD
= 1,
73 LTTNG_CLIENT_OVERWRITE
= 2,
74 LTTNG_CLIENT_DISCARD_RT
= 3,
75 LTTNG_CLIENT_OVERWRITE_RT
= 4,
76 LTTNG_NR_CLIENT_TYPES
,
79 /* Type description */
81 /* Update the astract_types name table in lttng-types.c along with this enum */
82 enum lttng_abstract_types
{
92 /* Update the string_encodings name table in lttng-types.c along with this enum */
93 enum lttng_string_encodings
{
94 lttng_encode_none
= 0,
95 lttng_encode_UTF8
= 1,
96 lttng_encode_ASCII
= 2,
100 #define LTTNG_UST_ENUM_ENTRY_PADDING 16
101 struct lttng_enum_entry
{
102 unsigned long long start
, end
; /* start and end are inclusive */
104 char padding
[LTTNG_UST_ENUM_ENTRY_PADDING
];
107 #define __type_integer(_type, _byte_order, _base, _encoding) \
109 .atype = atype_integer, \
116 .size = sizeof(_type) * CHAR_BIT, \
117 .alignment = lttng_alignof(_type) * CHAR_BIT, \
118 .signedness = lttng_is_signed_type(_type), \
119 .reverse_byte_order = _byte_order != BYTE_ORDER, \
121 .encoding = lttng_encode_##_encoding, \
127 #define LTTNG_UST_INTEGER_TYPE_PADDING 24
128 struct lttng_integer_type
{
129 unsigned int size
; /* in bits */
130 unsigned short alignment
; /* in bits */
131 unsigned int signedness
:1;
132 unsigned int reverse_byte_order
:1;
133 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
134 enum lttng_string_encodings encoding
;
135 char padding
[LTTNG_UST_INTEGER_TYPE_PADDING
];
139 * Only float and double are supported. long double is not supported at
142 #define _float_mant_dig(_type) \
143 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
144 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
147 #define __type_float(_type) \
149 .atype = atype_float, \
156 .exp_dig = sizeof(_type) * CHAR_BIT \
157 - _float_mant_dig(_type), \
158 .mant_dig = _float_mant_dig(_type), \
159 .alignment = lttng_alignof(_type) * CHAR_BIT, \
160 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
166 #define LTTNG_UST_FLOAT_TYPE_PADDING 24
167 struct lttng_float_type
{
168 unsigned int exp_dig
; /* exponent digits, in bits */
169 unsigned int mant_dig
; /* mantissa digits, in bits */
170 unsigned short alignment
; /* in bits */
171 unsigned int reverse_byte_order
:1;
172 char padding
[LTTNG_UST_FLOAT_TYPE_PADDING
];
175 #define LTTNG_UST_BASIC_TYPE_PADDING 128
176 union _lttng_basic_type
{
177 struct lttng_integer_type integer
;
182 enum lttng_string_encodings encoding
;
184 struct lttng_float_type _float
;
185 char padding
[LTTNG_UST_BASIC_TYPE_PADDING
];
188 struct lttng_basic_type
{
189 enum lttng_abstract_types atype
;
191 union _lttng_basic_type basic
;
195 #define LTTNG_UST_TYPE_PADDING 128
197 enum lttng_abstract_types atype
;
199 union _lttng_basic_type basic
;
201 struct lttng_basic_type elem_type
;
202 unsigned int length
; /* num. elems. */
205 struct lttng_basic_type length_type
;
206 struct lttng_basic_type elem_type
;
208 char padding
[LTTNG_UST_TYPE_PADDING
];
212 #define LTTNG_UST_ENUM_TYPE_PADDING 24
215 struct lttng_type container_type
;
216 const struct lttng_enum_entry
*entries
;
218 char padding
[LTTNG_UST_ENUM_TYPE_PADDING
];
222 * Event field description
224 * IMPORTANT: this structure is part of the ABI between the probe and
225 * UST. Fields need to be only added at the end, never reordered, never
229 #define LTTNG_UST_EVENT_FIELD_PADDING 28
230 struct lttng_event_field
{
232 struct lttng_type type
;
233 unsigned int nowrite
; /* do not write into trace */
234 char padding
[LTTNG_UST_EVENT_FIELD_PADDING
];
237 union lttng_ctx_value
{
243 struct lttng_perf_counter_field
;
245 #define LTTNG_UST_CTX_FIELD_PADDING 40
246 struct lttng_ctx_field
{
247 struct lttng_event_field event_field
;
248 size_t (*get_size
)(size_t offset
);
249 void (*record
)(struct lttng_ctx_field
*field
,
250 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
251 struct lttng_channel
*chan
);
252 void (*get_value
)(struct lttng_ctx_field
*field
,
253 union lttng_ctx_value
*value
);
255 struct lttng_perf_counter_field
*perf_counter
;
256 char padding
[LTTNG_UST_CTX_FIELD_PADDING
];
258 void (*destroy
)(struct lttng_ctx_field
*field
);
261 #define LTTNG_UST_CTX_PADDING 20
263 struct lttng_ctx_field
*fields
;
264 unsigned int nr_fields
;
265 unsigned int allocated_fields
;
266 unsigned int largest_align
;
267 char padding
[LTTNG_UST_CTX_PADDING
];
270 #define LTTNG_UST_EVENT_DESC_PADDING 40
271 struct lttng_event_desc
{
273 void (*probe_callback
)(void);
274 const struct lttng_event_ctx
*ctx
; /* context */
275 const struct lttng_event_field
*fields
; /* event payload */
276 unsigned int nr_fields
;
277 const int **loglevel
;
278 const char *signature
; /* Argument types/names received */
281 const char **model_emf_uri
;
283 char padding
[LTTNG_UST_EVENT_DESC_PADDING
];
287 #define LTTNG_UST_PROBE_DESC_PADDING 12
288 struct lttng_probe_desc
{
289 const char *provider
;
290 const struct lttng_event_desc
**event_desc
;
291 unsigned int nr_events
;
292 struct cds_list_head head
; /* chain registered probes */
293 struct cds_list_head lazy_init_head
;
294 int lazy
; /* lazy registration */
297 char padding
[LTTNG_UST_PROBE_DESC_PADDING
];
300 /* Data structures used by the tracer. */
302 enum lttng_enabler_type
{
303 LTTNG_ENABLER_WILDCARD
,
308 * Enabler field, within whatever object is enabling an event. Target of
309 * backward reference.
311 struct lttng_enabler
{
312 enum lttng_enabler_type type
;
314 /* head list of struct lttng_ust_filter_bytecode_node */
315 struct cds_list_head filter_bytecode_head
;
316 /* head list of struct lttng_ust_excluder_node */
317 struct cds_list_head excluder_head
;
318 struct cds_list_head node
; /* per-session list of enablers */
320 struct lttng_ust_event event_param
;
321 struct lttng_channel
*chan
;
322 struct lttng_ctx
*ctx
;
323 unsigned int enabled
:1;
326 struct tp_list_entry
{
327 struct lttng_ust_tracepoint_iter tp
;
328 struct cds_list_head head
;
331 struct lttng_ust_tracepoint_list
{
332 struct tp_list_entry
*iter
;
333 struct cds_list_head head
;
336 struct tp_field_list_entry
{
337 struct lttng_ust_field_iter field
;
338 struct cds_list_head head
;
341 struct lttng_ust_field_list
{
342 struct tp_field_list_entry
*iter
;
343 struct cds_list_head head
;
346 struct ust_pending_probe
;
349 struct lttng_ust_filter_bytecode_node
{
350 struct cds_list_head node
;
351 struct lttng_enabler
*enabler
;
353 * struct lttng_ust_filter_bytecode has var. sized array, must
356 struct lttng_ust_filter_bytecode bc
;
359 struct lttng_ust_excluder_node
{
360 struct cds_list_head node
;
361 struct lttng_enabler
*enabler
;
363 * struct lttng_ust_event_exclusion had variable sized array,
364 * must be last field.
366 struct lttng_ust_event_exclusion excluder
;
369 * Filter return value masks.
371 enum lttng_filter_ret
{
372 LTTNG_FILTER_DISCARD
= 0,
373 LTTNG_FILTER_RECORD_FLAG
= (1ULL << 0),
374 /* Other bits are kept for future use. */
377 struct lttng_bytecode_runtime
{
378 /* Associated bytecode */
379 struct lttng_ust_filter_bytecode_node
*bc
;
380 uint64_t (*filter
)(void *filter_data
, const char *filter_stack_data
);
382 struct cds_list_head node
; /* list of bytecode runtime in event */
386 * Objects in a linked-list of enablers, owned by an event.
388 struct lttng_enabler_ref
{
389 struct cds_list_head node
; /* enabler ref list */
390 struct lttng_enabler
*ref
; /* backward ref */
394 * lttng_event structure is referred to by the tracing fast path. It
395 * must be kept small.
397 * IMPORTANT: this structure is part of the ABI between the probe and
398 * UST. Fields need to be only added at the end, never reordered, never
402 /* LTTng-UST 2.0 starts here */
404 struct lttng_channel
*chan
;
406 const struct lttng_event_desc
*desc
;
408 struct lttng_ctx
*ctx
;
409 enum lttng_ust_instrumentation instrumentation
;
412 struct cds_list_head node
; /* Event list in session */
413 struct cds_list_head _deprecated2
;
415 unsigned int _deprecated4
:1;
417 /* LTTng-UST 2.1 starts here */
418 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
419 struct cds_list_head bytecode_runtime_head
;
420 int has_enablers_without_bytecode
;
421 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
422 struct cds_list_head enablers_ref_head
;
423 struct cds_hlist_node hlist
; /* session ht of events */
424 int registered
; /* has reg'd tracepoint probe */
428 struct lttng_ust_shm_handle
;
431 * IMPORTANT: this structure is part of the ABI between the probe and
432 * UST. Fields need to be only added at the end, never reordered, never
435 struct lttng_channel_ops
{
436 struct lttng_channel
*(*channel_create
)(const char *name
,
438 size_t subbuf_size
, size_t num_subbuf
,
439 unsigned int switch_timer_interval
,
440 unsigned int read_timer_interval
,
443 void (*channel_destroy
)(struct lttng_channel
*chan
);
446 unsigned long has_strcpy
:1; /* ABI has strcpy */
449 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
451 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
452 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
453 const void *src
, size_t len
);
455 * packet_avail_size returns the available size in the current
456 * packet. Note that the size returned is only a hint, since it
457 * may change due to concurrent writes.
459 size_t (*packet_avail_size
)(struct channel
*chan
,
460 struct lttng_ust_shm_handle
*handle
);
461 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
462 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
463 int (*is_finalized
)(struct channel
*chan
);
464 int (*is_disabled
)(struct channel
*chan
);
465 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
466 void (*event_strcpy
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
467 const char *src
, size_t len
);
471 * IMPORTANT: this structure is part of the ABI between the probe and
472 * UST. Fields need to be only added at the end, never reordered, never
475 struct lttng_channel
{
477 * The pointers located in this private data are NOT safe to be
478 * dereferenced by the consumer. The only operations the
479 * consumer process is designed to be allowed to do is to read
480 * and perform subbuffer flush.
482 struct channel
*chan
; /* Channel buffers */
484 struct lttng_ctx
*ctx
;
485 /* Event ID management */
486 struct lttng_session
*session
;
487 int objd
; /* Object associated to channel */
488 unsigned int _deprecated1
;
489 unsigned int _deprecated2
;
490 struct cds_list_head node
; /* Channel list in session */
491 const struct lttng_channel_ops
*ops
;
492 int header_type
; /* 0: unset, 1: compact, 2: large */
493 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
494 unsigned int _deprecated3
:1;
498 enum lttng_ust_chan_type type
;
499 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
500 int tstate
:1; /* Transient enable state */
503 #define LTTNG_UST_EVENT_HT_BITS 12
504 #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
506 struct lttng_ust_event_ht
{
507 struct cds_hlist_head table
[LTTNG_UST_EVENT_HT_SIZE
];
511 * IMPORTANT: this structure is part of the ABI between the probe and
512 * UST. Fields need to be only added at the end, never reordered, never
515 struct lttng_session
{
516 int active
; /* Is trace session active ? */
517 int been_active
; /* Been active ? */
518 int objd
; /* Object associated */
520 struct cds_list_head chan_head
; /* Channel list head */
521 struct cds_list_head events_head
; /* list of events */
522 struct cds_list_head _deprecated2
;
523 struct cds_list_head node
; /* Session list */
525 unsigned int _deprecated4
:1;
528 /* List of enablers */
529 struct cds_list_head enablers_head
;
530 struct lttng_ust_event_ht events_ht
; /* ht of events */
531 void *owner
; /* object owner */
532 int tstate
:1; /* Transient enable state */
535 int statedump_pending
:1;
538 struct lttng_transport
{
540 struct cds_list_head node
;
541 struct lttng_channel_ops ops
;
542 const struct lttng_ust_lib_ring_buffer_config
*client_config
;
545 struct lttng_session
*lttng_session_create(void);
546 int lttng_session_enable(struct lttng_session
*session
);
547 int lttng_session_disable(struct lttng_session
*session
);
548 void lttng_session_destroy(struct lttng_session
*session
);
550 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
551 const char *transport_name
,
553 size_t subbuf_size
, size_t num_subbuf
,
554 unsigned int switch_timer_interval
,
555 unsigned int read_timer_interval
,
556 int **shm_fd
, int **wait_fd
,
557 uint64_t **memory_map_size
,
558 struct lttng_channel
*chan_priv_init
);
560 int lttng_channel_enable(struct lttng_channel
*channel
);
561 int lttng_channel_disable(struct lttng_channel
*channel
);
563 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
564 struct lttng_ust_event
*event_param
,
565 struct lttng_channel
*chan
);
566 int lttng_enabler_enable(struct lttng_enabler
*enabler
);
567 int lttng_enabler_disable(struct lttng_enabler
*enabler
);
568 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
569 struct lttng_ust_filter_bytecode_node
*bytecode
);
570 int lttng_enabler_attach_context(struct lttng_enabler
*enabler
,
571 struct lttng_ust_context
*ctx
);
572 int lttng_enabler_attach_exclusion(struct lttng_enabler
*enabler
,
573 struct lttng_ust_excluder_node
*excluder
);
575 int lttng_attach_context(struct lttng_ust_context
*context_param
,
576 struct lttng_ctx
**ctx
, struct lttng_session
*session
);
577 void lttng_context_init(void);
578 void lttng_context_exit(void);
579 extern struct lttng_ctx
*lttng_static_ctx
; /* Used by filtering */
581 void lttng_transport_register(struct lttng_transport
*transport
);
582 void lttng_transport_unregister(struct lttng_transport
*transport
);
584 void synchronize_trace(void);
586 int lttng_probe_register(struct lttng_probe_desc
*desc
);
587 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
588 int lttng_fix_pending_events(void);
589 int lttng_probes_init(void);
590 void lttng_probes_exit(void);
591 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
592 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
593 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx_p
);
594 void lttng_context_update(struct lttng_ctx
*ctx
);
595 void lttng_remove_context_field(struct lttng_ctx
**ctx_p
,
596 struct lttng_ctx_field
*field
);
597 void lttng_destroy_context(struct lttng_ctx
*ctx
);
598 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
599 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
600 int lttng_add_pthread_id_to_ctx(struct lttng_ctx
**ctx
);
601 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
602 int lttng_add_ip_to_ctx(struct lttng_ctx
**ctx
);
603 void lttng_context_vtid_reset(void);
604 void lttng_context_vpid_reset(void);
606 #ifdef LTTNG_UST_HAVE_PERF_EVENT
607 int lttng_add_perf_counter_to_ctx(uint32_t type
,
610 struct lttng_ctx
**ctx
);
611 int lttng_perf_counter_init(void);
612 void lttng_perf_counter_exit(void);
613 #else /* #ifdef LTTNG_UST_HAVE_PERF_EVENT */
615 int lttng_add_perf_counter_to_ctx(uint32_t type
,
618 struct lttng_ctx
**ctx
)
623 int lttng_perf_counter_init(void)
628 void lttng_perf_counter_exit(void)
631 #endif /* #else #ifdef LTTNG_UST_HAVE_PERF_EVENT */
633 extern const struct lttng_ust_client_lib_ring_buffer_client_cb
*lttng_client_callbacks_metadata
;
634 extern const struct lttng_ust_client_lib_ring_buffer_client_cb
*lttng_client_callbacks_discard
;
635 extern const struct lttng_ust_client_lib_ring_buffer_client_cb
*lttng_client_callbacks_overwrite
;
637 struct lttng_transport
*lttng_transport_find(const char *name
);
639 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list
*list
);
640 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list
*list
);
641 struct lttng_ust_tracepoint_iter
*
642 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list
*list
);
643 int lttng_probes_get_field_list(struct lttng_ust_field_list
*list
);
644 void lttng_probes_prune_field_list(struct lttng_ust_field_list
*list
);
645 struct lttng_ust_field_iter
*
646 lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list
*list
);
648 void lttng_filter_event_link_bytecode(struct lttng_event
*event
);
649 void lttng_enabler_event_link_bytecode(struct lttng_event
*event
,
650 struct lttng_enabler
*enabler
);
651 void lttng_free_event_filter_runtime(struct lttng_event
*event
);
652 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
654 struct cds_list_head
*lttng_get_probe_list_head(void);
655 int lttng_session_active(void);
657 typedef int (*t_statedump_func_ptr
)(struct lttng_session
*session
);
658 void lttng_handle_pending_statedump(void *owner
);
659 struct cds_list_head
*_lttng_get_sessions(void);
665 #endif /* _LTTNG_UST_EVENTS_H */