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-abi.h>
34 #include <lttng/ust-tracer.h>
35 #include <lttng/ust-endian.h>
38 #define LTTNG_UST_UUID_LEN 16
42 struct lttng_ust_lib_ring_buffer_ctx
;
45 * Data structures used by tracepoint event declarations, and by the
46 * tracer. Those structures have padding for future extension.
50 * LTTng client type enumeration. Used by the consumer to map the
51 * callbacks from its own address space.
53 enum lttng_client_types
{
54 LTTNG_CLIENT_METADATA
= 0,
55 LTTNG_CLIENT_DISCARD
= 1,
56 LTTNG_CLIENT_OVERWRITE
= 2,
57 LTTNG_CLIENT_DISCARD_RT
= 3,
58 LTTNG_CLIENT_OVERWRITE_RT
= 4,
59 LTTNG_NR_CLIENT_TYPES
,
62 /* Type description */
64 /* Update the astract_types name table in lttng-types.c along with this enum */
65 enum lttng_abstract_types
{
75 /* Update the string_encodings name table in lttng-types.c along with this enum */
76 enum lttng_string_encodings
{
77 lttng_encode_none
= 0,
78 lttng_encode_UTF8
= 1,
79 lttng_encode_ASCII
= 2,
83 #define LTTNG_UST_ENUM_ENTRY_PADDING 16
84 struct lttng_enum_entry
{
85 unsigned long long start
, end
; /* start and end are inclusive */
87 char padding
[LTTNG_UST_ENUM_ENTRY_PADDING
];
90 #define __type_integer(_type, _byte_order, _base, _encoding) \
92 .atype = atype_integer, \
95 .size = sizeof(_type) * CHAR_BIT, \
96 .alignment = lttng_alignof(_type) * CHAR_BIT, \
97 .signedness = lttng_is_signed_type(_type), \
98 .reverse_byte_order = _byte_order != BYTE_ORDER, \
100 .encoding = lttng_encode_##_encoding, \
104 #define LTTNG_UST_INTEGER_TYPE_PADDING 24
105 struct lttng_integer_type
{
106 unsigned int size
; /* in bits */
107 unsigned short alignment
; /* in bits */
108 unsigned int signedness
:1;
109 unsigned int reverse_byte_order
:1;
110 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
111 enum lttng_string_encodings encoding
;
112 char padding
[LTTNG_UST_INTEGER_TYPE_PADDING
];
116 * Only float and double are supported. long double is not supported at
119 #define _float_mant_dig(_type) \
120 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
121 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
124 #define __type_float(_type) \
126 .atype = atype_float, \
129 .exp_dig = sizeof(_type) * CHAR_BIT \
130 - _float_mant_dig(_type), \
131 .mant_dig = _float_mant_dig(_type), \
132 .alignment = lttng_alignof(_type) * CHAR_BIT, \
133 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
137 #define LTTNG_UST_FLOAT_TYPE_PADDING 24
138 struct lttng_float_type
{
139 unsigned int exp_dig
; /* exponent digits, in bits */
140 unsigned int mant_dig
; /* mantissa digits, in bits */
141 unsigned short alignment
; /* in bits */
142 unsigned int reverse_byte_order
:1;
143 char padding
[LTTNG_UST_FLOAT_TYPE_PADDING
];
146 #define LTTNG_UST_BASIC_TYPE_PADDING 128
147 union _lttng_basic_type
{
148 struct lttng_integer_type integer
;
153 enum lttng_string_encodings encoding
;
155 struct lttng_float_type _float
;
156 char padding
[LTTNG_UST_BASIC_TYPE_PADDING
];
159 struct lttng_basic_type
{
160 enum lttng_abstract_types atype
;
162 union _lttng_basic_type basic
;
166 #define LTTNG_UST_TYPE_PADDING 128
168 enum lttng_abstract_types atype
;
170 union _lttng_basic_type basic
;
172 struct lttng_basic_type elem_type
;
173 unsigned int length
; /* num. elems. */
176 struct lttng_basic_type length_type
;
177 struct lttng_basic_type elem_type
;
179 char padding
[LTTNG_UST_TYPE_PADDING
];
183 #define LTTNG_UST_ENUM_TYPE_PADDING 24
186 struct lttng_type container_type
;
187 const struct lttng_enum_entry
*entries
;
189 char padding
[LTTNG_UST_ENUM_TYPE_PADDING
];
193 * Event field description
195 * IMPORTANT: this structure is part of the ABI between the probe and
196 * UST. Fields need to be only added at the end, never reordered, never
200 #define LTTNG_UST_EVENT_FIELD_PADDING 28
201 struct lttng_event_field
{
203 struct lttng_type type
;
204 unsigned int nowrite
; /* do not write into trace */
205 char padding
[LTTNG_UST_EVENT_FIELD_PADDING
];
208 union lttng_ctx_value
{
214 #define LTTNG_UST_CTX_FIELD_PADDING 40
215 struct lttng_ctx_field
{
216 struct lttng_event_field event_field
;
217 size_t (*get_size
)(size_t offset
);
218 void (*record
)(struct lttng_ctx_field
*field
,
219 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
220 struct lttng_channel
*chan
);
221 void (*get_value
)(struct lttng_ctx_field
*field
,
222 union lttng_ctx_value
*value
);
224 char padding
[LTTNG_UST_CTX_FIELD_PADDING
];
226 void (*destroy
)(struct lttng_ctx_field
*field
);
229 #define LTTNG_UST_CTX_PADDING 24
231 struct lttng_ctx_field
*fields
;
232 unsigned int nr_fields
;
233 unsigned int allocated_fields
;
234 char padding
[LTTNG_UST_CTX_PADDING
];
237 #define LTTNG_UST_EVENT_DESC_PADDING 40
238 struct lttng_event_desc
{
240 void (*probe_callback
)(void);
241 const struct lttng_event_ctx
*ctx
; /* context */
242 const struct lttng_event_field
*fields
; /* event payload */
243 unsigned int nr_fields
;
244 const int **loglevel
;
245 const char *signature
; /* Argument types/names received */
248 const char **model_emf_uri
;
250 char padding
[LTTNG_UST_EVENT_DESC_PADDING
];
254 #define LTTNG_UST_PROBE_DESC_PADDING 20
255 struct lttng_probe_desc
{
256 const char *provider
;
257 const struct lttng_event_desc
**event_desc
;
258 unsigned int nr_events
;
259 struct cds_list_head head
; /* chain registered probes */
260 struct cds_list_head lazy_init_head
;
261 int lazy
; /* lazy registration */
262 char padding
[LTTNG_UST_PROBE_DESC_PADDING
];
265 /* Data structures used by the tracer. */
267 enum lttng_enabler_type
{
268 LTTNG_ENABLER_WILDCARD
,
273 * Enabler field, within whatever object is enabling an event. Target of
274 * backward reference.
276 struct lttng_enabler
{
277 enum lttng_enabler_type type
;
279 /* head list of struct lttng_ust_filter_bytecode_node */
280 struct cds_list_head filter_bytecode_head
;
281 struct cds_list_head node
; /* per-session list of enablers */
283 struct lttng_ust_event event_param
;
284 struct lttng_channel
*chan
;
285 struct lttng_ctx
*ctx
;
286 unsigned int enabled
:1;
289 struct tp_list_entry
{
290 struct lttng_ust_tracepoint_iter tp
;
291 struct cds_list_head head
;
294 struct lttng_ust_tracepoint_list
{
295 struct tp_list_entry
*iter
;
296 struct cds_list_head head
;
299 struct tp_field_list_entry
{
300 struct lttng_ust_field_iter field
;
301 struct cds_list_head head
;
304 struct lttng_ust_field_list
{
305 struct tp_field_list_entry
*iter
;
306 struct cds_list_head head
;
309 struct ust_pending_probe
;
312 struct lttng_ust_filter_bytecode_node
{
313 struct cds_list_head node
;
314 struct lttng_enabler
*enabler
;
316 * struct lttng_ust_filter_bytecode has var. sized array, must
319 struct lttng_ust_filter_bytecode bc
;
323 * Filter return value masks.
325 enum lttng_filter_ret
{
326 LTTNG_FILTER_DISCARD
= 0,
327 LTTNG_FILTER_RECORD_FLAG
= (1ULL << 0),
328 /* Other bits are kept for future use. */
331 struct lttng_bytecode_runtime
{
332 /* Associated bytecode */
333 struct lttng_ust_filter_bytecode_node
*bc
;
334 uint64_t (*filter
)(void *filter_data
, const char *filter_stack_data
);
336 struct cds_list_head node
; /* list of bytecode runtime in event */
340 * Objects in a linked-list of enablers, owned by an event.
342 struct lttng_enabler_ref
{
343 struct cds_list_head node
; /* enabler ref list */
344 struct lttng_enabler
*ref
; /* backward ref */
348 * lttng_event structure is referred to by the tracing fast path. It
349 * must be kept small.
351 * IMPORTANT: this structure is part of the ABI between the probe and
352 * UST. Fields need to be only added at the end, never reordered, never
356 /* LTTng-UST 2.0 starts here */
358 struct lttng_channel
*chan
;
360 const struct lttng_event_desc
*desc
;
362 struct lttng_ctx
*ctx
;
363 enum lttng_ust_instrumentation instrumentation
;
366 struct cds_list_head node
; /* Event list in session */
367 struct cds_list_head _deprecated2
;
369 unsigned int _deprecated4
:1;
371 /* LTTng-UST 2.1 starts here */
372 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
373 struct cds_list_head bytecode_runtime_head
;
374 int has_enablers_without_bytecode
;
375 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
376 struct cds_list_head enablers_ref_head
;
377 struct cds_hlist_node hlist
; /* session ht of events */
378 int registered
; /* has reg'd tracepoint probe */
382 struct lttng_ust_shm_handle
;
385 * IMPORTANT: this structure is part of the ABI between the probe and
386 * UST. Fields need to be only added at the end, never reordered, never
389 struct lttng_channel_ops
{
390 struct lttng_channel
*(*channel_create
)(const char *name
,
392 size_t subbuf_size
, size_t num_subbuf
,
393 unsigned int switch_timer_interval
,
394 unsigned int read_timer_interval
,
397 void (*channel_destroy
)(struct lttng_channel
*chan
);
398 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
400 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
401 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
402 const void *src
, size_t len
);
404 * packet_avail_size returns the available size in the current
405 * packet. Note that the size returned is only a hint, since it
406 * may change due to concurrent writes.
408 size_t (*packet_avail_size
)(struct channel
*chan
,
409 struct lttng_ust_shm_handle
*handle
);
410 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
411 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
412 int (*is_finalized
)(struct channel
*chan
);
413 int (*is_disabled
)(struct channel
*chan
);
414 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
418 * IMPORTANT: this structure is part of the ABI between the probe and
419 * UST. Fields need to be only added at the end, never reordered, never
422 struct lttng_channel
{
424 * The pointers located in this private data are NOT safe to be
425 * dereferenced by the consumer. The only operations the
426 * consumer process is designed to be allowed to do is to read
427 * and perform subbuffer flush.
429 struct channel
*chan
; /* Channel buffers */
431 struct lttng_ctx
*ctx
;
432 /* Event ID management */
433 struct lttng_session
*session
;
434 int objd
; /* Object associated to channel */
435 unsigned int _deprecated1
;
436 unsigned int _deprecated2
;
437 struct cds_list_head node
; /* Channel list in session */
438 const struct lttng_channel_ops
*ops
;
439 int header_type
; /* 0: unset, 1: compact, 2: large */
440 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
441 unsigned int _deprecated3
:1;
445 enum lttng_ust_chan_type type
;
446 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
447 int tstate
:1; /* Transient enable state */
450 #define LTTNG_UST_EVENT_HT_BITS 12
451 #define LTTNG_UST_EVENT_HT_SIZE (1U << LTTNG_UST_EVENT_HT_BITS)
453 struct lttng_ust_event_ht
{
454 struct cds_hlist_head table
[LTTNG_UST_EVENT_HT_SIZE
];
458 * IMPORTANT: this structure is part of the ABI between the probe and
459 * UST. Fields need to be only added at the end, never reordered, never
462 struct lttng_session
{
463 int active
; /* Is trace session active ? */
464 int been_active
; /* Been active ? */
465 int objd
; /* Object associated */
467 struct cds_list_head chan_head
; /* Channel list head */
468 struct cds_list_head events_head
; /* list of events */
469 struct cds_list_head _deprecated2
;
470 struct cds_list_head node
; /* Session list */
472 unsigned int _deprecated4
:1;
475 /* List of enablers */
476 struct cds_list_head enablers_head
;
477 struct lttng_ust_event_ht events_ht
; /* ht of events */
478 void *owner
; /* object owner */
479 int tstate
:1; /* Transient enable state */
482 struct lttng_transport
{
484 struct cds_list_head node
;
485 struct lttng_channel_ops ops
;
486 const struct lttng_ust_lib_ring_buffer_config
*client_config
;
489 struct lttng_session
*lttng_session_create(void);
490 int lttng_session_enable(struct lttng_session
*session
);
491 int lttng_session_disable(struct lttng_session
*session
);
492 void lttng_session_destroy(struct lttng_session
*session
);
494 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
495 const char *transport_name
,
497 size_t subbuf_size
, size_t num_subbuf
,
498 unsigned int switch_timer_interval
,
499 unsigned int read_timer_interval
,
500 int **shm_fd
, int **wait_fd
,
501 uint64_t **memory_map_size
,
502 struct lttng_channel
*chan_priv_init
);
504 int lttng_channel_enable(struct lttng_channel
*channel
);
505 int lttng_channel_disable(struct lttng_channel
*channel
);
507 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
508 struct lttng_ust_event
*event_param
,
509 struct lttng_channel
*chan
);
510 int lttng_enabler_enable(struct lttng_enabler
*enabler
);
511 int lttng_enabler_disable(struct lttng_enabler
*enabler
);
512 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
513 struct lttng_ust_filter_bytecode_node
*bytecode
);
514 int lttng_enabler_attach_context(struct lttng_enabler
*enabler
,
515 struct lttng_ust_context
*ctx
);
517 int lttng_attach_context(struct lttng_ust_context
*context_param
,
518 struct lttng_ctx
**ctx
, struct lttng_session
*session
);
520 void lttng_transport_register(struct lttng_transport
*transport
);
521 void lttng_transport_unregister(struct lttng_transport
*transport
);
523 void synchronize_trace(void);
525 int lttng_probe_register(struct lttng_probe_desc
*desc
);
526 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
527 int lttng_fix_pending_event_desc(const struct lttng_event_desc
*desc
);
528 int lttng_probes_init(void);
529 void lttng_probes_exit(void);
530 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
531 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
532 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx_p
);
533 void lttng_remove_context_field(struct lttng_ctx
**ctx_p
,
534 struct lttng_ctx_field
*field
);
535 void lttng_destroy_context(struct lttng_ctx
*ctx
);
536 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
537 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
538 int lttng_add_pthread_id_to_ctx(struct lttng_ctx
**ctx
);
539 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
540 void lttng_context_vtid_reset(void);
541 void lttng_context_vpid_reset(void);
543 extern const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_metadata
;
544 extern const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_discard
;
545 extern const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_overwrite
;
547 struct lttng_transport
*lttng_transport_find(const char *name
);
549 int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list
*list
);
550 void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list
*list
);
551 struct lttng_ust_tracepoint_iter
*
552 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list
*list
);
553 int lttng_probes_get_field_list(struct lttng_ust_field_list
*list
);
554 void lttng_probes_prune_field_list(struct lttng_ust_field_list
*list
);
555 struct lttng_ust_field_iter
*
556 lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list
*list
);
558 void lttng_filter_event_link_bytecode(struct lttng_event
*event
);
559 void lttng_enabler_event_link_bytecode(struct lttng_event
*event
,
560 struct lttng_enabler
*enabler
);
561 void lttng_free_event_filter_runtime(struct lttng_event
*event
);
562 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
564 struct cds_list_head
*lttng_get_probe_list_head(void);
565 int lttng_session_active(void);
567 #endif /* _LTTNG_UST_EVENTS_H */