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.
22 #include <urcu/list.h>
23 #include <urcu/hlist.h>
25 #include <lttng/ust-abi.h>
26 #include <lttng/ust-tracer.h>
27 #include <lttng/ust-endian.h>
30 #define LTTNG_UST_UUID_LEN 16
34 struct lttng_ust_lib_ring_buffer_ctx
;
37 * Data structures used by tracepoint event declarations, and by the
38 * tracer. Those structures have padding for future extension.
42 * LTTng client type enumeration. Used by the consumer to map the
43 * callbacks from its own address space.
45 enum lttng_client_types
{
46 LTTNG_CLIENT_METADATA
= 0,
47 LTTNG_CLIENT_DISCARD
= 1,
48 LTTNG_CLIENT_OVERWRITE
= 2,
49 LTTNG_NR_CLIENT_TYPES
,
52 /* Type description */
54 /* Update the astract_types name table in lttng-types.c along with this enum */
65 /* Update the string_encodings name table in lttng-types.c along with this enum */
66 enum lttng_string_encodings
{
67 lttng_encode_none
= 0,
68 lttng_encode_UTF8
= 1,
69 lttng_encode_ASCII
= 2,
73 #define LTTNG_UST_ENUM_ENTRY_PADDING 16
74 struct lttng_enum_entry
{
75 unsigned long long start
, end
; /* start and end are inclusive */
77 char padding
[LTTNG_UST_ENUM_ENTRY_PADDING
];
80 #define __type_integer(_type, _byte_order, _base, _encoding) \
82 .atype = atype_integer, \
85 .size = sizeof(_type) * CHAR_BIT, \
86 .alignment = lttng_alignof(_type) * CHAR_BIT, \
87 .signedness = lttng_is_signed_type(_type), \
88 .reverse_byte_order = _byte_order != BYTE_ORDER, \
90 .encoding = lttng_encode_##_encoding, \
94 #define LTTNG_UST_INTEGER_TYPE_PADDING 24
95 struct lttng_integer_type
{
96 unsigned int size
; /* in bits */
97 unsigned short alignment
; /* in bits */
98 unsigned int signedness
:1;
99 unsigned int reverse_byte_order
:1;
100 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
101 enum lttng_string_encodings encoding
;
102 char padding
[LTTNG_UST_INTEGER_TYPE_PADDING
];
106 * Only float and double are supported. long double is not supported at
109 #define _float_mant_dig(_type) \
110 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
111 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
114 #define __type_float(_type) \
116 .atype = atype_float, \
119 .exp_dig = sizeof(_type) * CHAR_BIT \
120 - _float_mant_dig(_type), \
121 .mant_dig = _float_mant_dig(_type), \
122 .alignment = lttng_alignof(_type) * CHAR_BIT, \
123 .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \
127 #define LTTNG_UST_FLOAT_TYPE_PADDING 24
128 struct lttng_float_type
{
129 unsigned int exp_dig
; /* exponent digits, in bits */
130 unsigned int mant_dig
; /* mantissa digits, in bits */
131 unsigned short alignment
; /* in bits */
132 unsigned int reverse_byte_order
:1;
133 char padding
[LTTNG_UST_FLOAT_TYPE_PADDING
];
136 #define LTTNG_UST_BASIC_TYPE_PADDING 128
137 union _lttng_basic_type
{
138 struct lttng_integer_type integer
;
143 enum lttng_string_encodings encoding
;
145 struct lttng_float_type _float
;
146 char padding
[LTTNG_UST_BASIC_TYPE_PADDING
];
149 struct lttng_basic_type
{
150 enum abstract_types atype
;
152 union _lttng_basic_type basic
;
156 #define LTTNG_UST_TYPE_PADDING 128
158 enum abstract_types atype
;
160 union _lttng_basic_type basic
;
162 struct lttng_basic_type elem_type
;
163 unsigned int length
; /* num. elems. */
166 struct lttng_basic_type length_type
;
167 struct lttng_basic_type elem_type
;
169 char padding
[LTTNG_UST_TYPE_PADDING
];
173 #define LTTNG_UST_ENUM_TYPE_PADDING 24
176 struct lttng_type container_type
;
177 const struct lttng_enum_entry
*entries
;
179 char padding
[LTTNG_UST_ENUM_TYPE_PADDING
];
183 * Event field description
185 * IMPORTANT: this structure is part of the ABI between the probe and
186 * UST. Fields need to be only added at the end, never reordered, never
190 #define LTTNG_UST_EVENT_FIELD_PADDING 28
191 struct lttng_event_field
{
193 struct lttng_type type
;
194 unsigned int nowrite
; /* do not write into trace */
195 char padding
[LTTNG_UST_EVENT_FIELD_PADDING
];
198 #define LTTNG_UST_CTX_FIELD_PADDING 40
199 struct lttng_ctx_field
{
200 struct lttng_event_field event_field
;
201 size_t (*get_size
)(size_t offset
);
202 void (*record
)(struct lttng_ctx_field
*field
,
203 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
204 struct ltt_channel
*chan
);
206 char padding
[LTTNG_UST_CTX_FIELD_PADDING
];
208 void (*destroy
)(struct lttng_ctx_field
*field
);
211 #define LTTNG_UST_CTX_PADDING 24
213 struct lttng_ctx_field
*fields
;
214 unsigned int nr_fields
;
215 unsigned int allocated_fields
;
216 char padding
[LTTNG_UST_CTX_PADDING
];
219 #define LTTNG_UST_EVENT_DESC_PADDING 40
220 struct lttng_event_desc
{
222 void (*probe_callback
)(void);
223 const struct lttng_event_ctx
*ctx
; /* context */
224 const struct lttng_event_field
*fields
; /* event payload */
225 unsigned int nr_fields
;
226 const int **loglevel
;
227 const char *signature
; /* Argument types/names received */
230 const char **model_emf_uri
;
232 char padding
[LTTNG_UST_EVENT_DESC_PADDING
];
236 #define LTTNG_UST_PROBE_DESC_PADDING 40
237 struct lttng_probe_desc
{
238 const char *provider
;
239 const struct lttng_event_desc
**event_desc
;
240 unsigned int nr_events
;
241 struct cds_list_head head
; /* chain registered probes */
242 char padding
[LTTNG_UST_PROBE_DESC_PADDING
];
245 /* Data structures used by the tracer. */
248 * Entry describing a per-session active wildcard, along with the event
249 * attribute and channel information configuring the events that need to
252 struct session_wildcard
{
253 struct ltt_channel
*chan
;
254 struct lttng_ctx
*ctx
; /* TODO */
255 struct lttng_ust_event event_param
;
256 struct cds_list_head events
; /* list of events enabled */
257 struct cds_list_head list
; /* per-session list of wildcards */
258 struct cds_list_head session_list
; /* node of session wildcard list */
259 struct wildcard_entry
*entry
;
260 struct lttng_ust_filter_bytecode
*filter_bytecode
;
261 unsigned int enabled
:1;
265 * Entry describing an active wildcard (per name) for all sessions.
267 struct wildcard_entry
{
268 /* node of global wildcards list */
269 struct cds_list_head list
;
270 /* head of session list to which this wildcard apply */
271 struct cds_list_head session_list
;
272 enum lttng_ust_loglevel_type loglevel_type
;
273 struct lttng_ust_filter_bytecode
*filter_bytecode
;
278 struct tp_list_entry
{
279 struct lttng_ust_tracepoint_iter tp
;
280 struct cds_list_head head
;
283 struct lttng_ust_tracepoint_list
{
284 struct tp_list_entry
*iter
;
285 struct cds_list_head head
;
288 struct tp_field_list_entry
{
289 struct lttng_ust_field_iter field
;
290 struct cds_list_head head
;
293 struct lttng_ust_field_list
{
294 struct tp_field_list_entry
*iter
;
295 struct cds_list_head head
;
298 struct ust_pending_probe
;
300 struct lttng_ust_filter_bytecode
;
303 * ltt_event structure is referred to by the tracing fast path. It must be
306 * IMPORTANT: this structure is part of the ABI between the probe and
307 * UST. Fields need to be only added at the end, never reordered, never
311 /* LTTng-UST 2.0 starts here */
313 struct ltt_channel
*chan
;
315 const struct lttng_event_desc
*desc
;
316 int (*filter
)(void *filter_data
, const char *filter_stack_data
);
317 struct lttng_ctx
*ctx
;
318 enum lttng_ust_instrumentation instrumentation
;
321 struct cds_list_head list
; /* Event list */
322 struct cds_list_head wildcard_list
; /* Event list for wildcard */
323 struct ust_pending_probe
*pending_probe
;
324 unsigned int metadata_dumped
:1;
325 /* LTTng-UST 2.1 starts here */
326 struct lttng_ust_filter_bytecode
*filter_bytecode
;
331 struct lttng_ust_shm_handle
;
334 * IMPORTANT: this structure is part of the ABI between the probe and
335 * UST. Fields need to be only added at the end, never reordered, never
338 struct ltt_channel_ops
{
339 struct ltt_channel
*(*channel_create
)(const char *name
,
341 size_t subbuf_size
, size_t num_subbuf
,
342 unsigned int switch_timer_interval
,
343 unsigned int read_timer_interval
,
344 int **shm_fd
, int **wait_fd
,
345 uint64_t **memory_map_size
,
346 struct ltt_channel
*chan_priv_init
);
347 void (*channel_destroy
)(struct ltt_channel
*ltt_chan
);
348 struct lttng_ust_lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
,
349 struct lttng_ust_shm_handle
*handle
,
350 int **shm_fd
, int **wait_fd
,
351 uint64_t **memory_map_size
);
352 void (*buffer_read_close
)(struct lttng_ust_lib_ring_buffer
*buf
,
353 struct lttng_ust_shm_handle
*handle
);
354 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
356 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
357 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
, const void *src
,
360 * packet_avail_size returns the available size in the current
361 * packet. Note that the size returned is only a hint, since it
362 * may change due to concurrent writes.
364 size_t (*packet_avail_size
)(struct channel
*chan
,
365 struct lttng_ust_shm_handle
*handle
);
366 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
367 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
368 int (*is_finalized
)(struct channel
*chan
);
369 int (*is_disabled
)(struct channel
*chan
);
370 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
374 * IMPORTANT: this structure is part of the ABI between the probe and
375 * UST. Fields need to be only added at the end, never reordered, never
380 * The pointers located in this private data are NOT safe to be
381 * dereferenced by the consumer. The only operations the
382 * consumer process is designed to be allowed to do is to read
383 * and perform subbuffer flush.
385 struct channel
*chan
; /* Channel buffers */
387 struct lttng_ctx
*ctx
;
388 /* Event ID management */
389 struct ltt_session
*session
;
390 int objd
; /* Object associated to channel */
391 unsigned int free_event_id
; /* Next event ID to allocate */
392 unsigned int used_event_id
; /* Max allocated event IDs */
393 struct cds_list_head list
; /* Channel list */
394 struct ltt_channel_ops
*ops
;
395 int header_type
; /* 0: unset, 1: compact, 2: large */
396 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
397 unsigned int metadata_dumped
:1;
399 /* Channel ID, available for consumer too */
401 /* Copy of session UUID for consumer (availability through shm) */
402 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
406 * IMPORTANT: this structure is part of the ABI between the probe and
407 * UST. Fields need to be only added at the end, never reordered, never
411 int active
; /* Is trace session active ? */
412 int been_active
; /* Has trace session been active ? */
413 int objd
; /* Object associated to session */
414 struct ltt_channel
*metadata
; /* Metadata channel */
415 struct cds_list_head chan
; /* Channel list head */
416 struct cds_list_head events
; /* Event list head */
417 struct cds_list_head wildcards
; /* Wildcard list head */
418 struct cds_list_head list
; /* Session list */
419 unsigned int free_chan_id
; /* Next chan ID to allocate */
420 unsigned char uuid
[LTTNG_UST_UUID_LEN
]; /* Trace session unique ID */
421 unsigned int metadata_dumped
:1;
424 struct ltt_transport
{
426 struct cds_list_head node
;
427 struct ltt_channel_ops ops
;
430 struct ltt_session
*ltt_session_create(void);
431 int ltt_session_enable(struct ltt_session
*session
);
432 int ltt_session_disable(struct ltt_session
*session
);
433 void ltt_session_destroy(struct ltt_session
*session
);
435 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
436 const char *transport_name
,
438 size_t subbuf_size
, size_t num_subbuf
,
439 unsigned int switch_timer_interval
,
440 unsigned int read_timer_interval
,
441 int **shm_fd
, int **wait_fd
,
442 uint64_t **memory_map_size
,
443 struct ltt_channel
*chan_priv_init
);
444 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
445 int overwrite
, void *buf_addr
,
446 size_t subbuf_size
, size_t num_subbuf
,
447 unsigned int switch_timer_interval
,
448 unsigned int read_timer_interval
,
449 int **shm_fd
, int **wait_fd
,
450 uint64_t **memory_map_size
);
452 int ltt_event_create(struct ltt_channel
*chan
,
453 struct lttng_ust_event
*event_param
,
454 struct ltt_event
**event
);
456 int ltt_channel_enable(struct ltt_channel
*channel
);
457 int ltt_channel_disable(struct ltt_channel
*channel
);
458 int ltt_event_enable(struct ltt_event
*event
);
459 int ltt_event_disable(struct ltt_event
*event
);
461 void ltt_transport_register(struct ltt_transport
*transport
);
462 void ltt_transport_unregister(struct ltt_transport
*transport
);
464 void synchronize_trace(void);
466 int ltt_probe_register(struct lttng_probe_desc
*desc
);
467 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
468 int pending_probe_fix_events(const struct lttng_event_desc
*desc
);
469 const struct lttng_event_desc
*ltt_event_get(const char *name
);
470 void ltt_event_put(const struct lttng_event_desc
*desc
);
471 int ltt_probes_init(void);
472 void ltt_probes_exit(void);
473 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
474 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx_p
);
475 void lttng_remove_context_field(struct lttng_ctx
**ctx_p
,
476 struct lttng_ctx_field
*field
);
477 void lttng_destroy_context(struct lttng_ctx
*ctx
);
478 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
479 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
480 int lttng_add_pthread_id_to_ctx(struct lttng_ctx
**ctx
);
481 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
482 void lttng_context_vtid_reset(void);
483 void lttng_context_vpid_reset(void);
485 extern const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_metadata
;
486 extern const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_discard
;
487 extern const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_overwrite
;
489 struct ltt_transport
*ltt_transport_find(const char *name
);
491 int ltt_probes_get_event_list(struct lttng_ust_tracepoint_list
*list
);
492 void ltt_probes_prune_event_list(struct lttng_ust_tracepoint_list
*list
);
493 struct lttng_ust_tracepoint_iter
*
494 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list
*list
);
495 int ltt_probes_get_field_list(struct lttng_ust_field_list
*list
);
496 void ltt_probes_prune_field_list(struct lttng_ust_field_list
*list
);
497 struct lttng_ust_field_iter
*
498 lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list
*list
);
500 int ltt_wildcard_enable(struct session_wildcard
*wildcard
);
501 int ltt_wildcard_disable(struct session_wildcard
*wildcard
);
502 int ltt_wildcard_create(struct ltt_channel
*chan
,
503 struct lttng_ust_event
*event_param
,
504 struct session_wildcard
**sl
);
505 int ltt_loglevel_match(const struct lttng_event_desc
*desc
,
506 enum lttng_ust_loglevel_type req_type
,
508 void ltt_probes_create_wildcard_events(struct wildcard_entry
*entry
,
509 struct session_wildcard
*wildcard
);
510 int lttng_filter_event_attach_bytecode(struct ltt_event
*event
,
511 struct lttng_ust_filter_bytecode
*filter
);
512 int lttng_filter_wildcard_attach_bytecode(struct session_wildcard
*wildcard
,
513 struct lttng_ust_filter_bytecode
*filter
);
514 void lttng_filter_event_link_bytecode(struct ltt_event
*event
,
515 struct lttng_ust_filter_bytecode
*filter_bytecode
);
516 void lttng_filter_wildcard_link_bytecode(struct session_wildcard
*wildcard
);
518 #endif /* _LTTNG_UST_EVENTS_H */