1 #ifndef _UST_LTTNG_EVENTS_H
2 #define _UST_LTTNG_EVENTS_H
7 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Holds LTTng per-session event registry.
11 * Dual LGPL v2.1/GPL v2 license.
14 #include <urcu/list.h>
15 #include <uuid/uuid.h>
17 #include <lttng/ust-abi.h>
18 #include <lttng/ust-tracer.h>
24 struct lttng_ust_lib_ring_buffer_ctx
;
27 * LTTng client type enumeration. Used by the consumer to map the
28 * callbacks from its own address space.
30 enum lttng_client_types
{
31 LTTNG_CLIENT_METADATA
= 0,
32 LTTNG_CLIENT_DISCARD
= 1,
33 LTTNG_CLIENT_OVERWRITE
= 2,
34 LTTNG_NR_CLIENT_TYPES
,
37 /* Type description */
39 /* Update the astract_types name table in lttng-types.c along with this enum */
50 /* Update the string_encodings name table in lttng-types.c along with this enum */
51 enum lttng_string_encodings
{
52 lttng_encode_none
= 0,
53 lttng_encode_UTF8
= 1,
54 lttng_encode_ASCII
= 2,
58 struct lttng_enum_entry
{
59 unsigned long long start
, end
; /* start and end are inclusive */
63 #define __type_integer(_type, _byte_order, _base, _encoding) \
65 .atype = atype_integer, \
68 .size = sizeof(_type) * CHAR_BIT, \
69 .alignment = lttng_alignof(_type) * CHAR_BIT, \
70 .signedness = lttng_is_signed_type(_type), \
71 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
73 .encoding = lttng_encode_##_encoding, \
77 struct lttng_integer_type {
78 unsigned int size
; /* in bits */
79 unsigned short alignment
; /* in bits */
80 unsigned int signedness
:1;
81 unsigned int reverse_byte_order
:1;
82 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
83 enum lttng_string_encodings encoding
;
87 * Only float and double are supported. long double is not supported at
90 #define _float_mant_dig(_type) \
91 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
92 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
95 #define __type_float(_type) \
97 .atype = atype_float, \
100 .exp_dig = sizeof(_type) * CHAR_BIT \
101 - _float_mant_dig(_type), \
102 .mant_dig = _float_mant_dig(_type), \
103 .alignment = lttng_alignof(_type) * CHAR_BIT, \
104 .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
108 struct lttng_float_type {
109 unsigned int exp_dig
; /* exponent digits, in bits */
110 unsigned int mant_dig
; /* mantissa digits, in bits */
111 unsigned short alignment
; /* in bits */
112 unsigned int reverse_byte_order
:1;
115 union _lttng_basic_type
{
116 struct lttng_integer_type integer
;
121 enum lttng_string_encodings encoding
;
123 struct lttng_float_type _float
;
126 struct lttng_basic_type
{
127 enum abstract_types atype
;
129 union _lttng_basic_type basic
;
134 enum abstract_types atype
;
136 union _lttng_basic_type basic
;
138 struct lttng_basic_type elem_type
;
139 unsigned int length
; /* num. elems. */
142 struct lttng_basic_type length_type
;
143 struct lttng_basic_type elem_type
;
150 struct lttng_type container_type
;
151 const struct lttng_enum_entry
*entries
;
155 /* Event field description */
157 struct lttng_event_field
{
159 struct lttng_type type
;
162 struct lttng_ctx_field
{
163 struct lttng_event_field event_field
;
164 size_t (*get_size
)(size_t offset
);
165 void (*record
)(struct lttng_ctx_field
*field
,
166 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
167 struct ltt_channel
*chan
);
170 void (*destroy
)(struct lttng_ctx_field
*field
);
174 struct lttng_ctx_field
*fields
;
175 unsigned int nr_fields
;
176 unsigned int allocated_fields
;
179 struct lttng_event_desc
{
181 void *probe_callback
;
182 const struct lttng_event_ctx
*ctx
; /* context */
183 const struct lttng_event_field
*fields
; /* event payload */
184 unsigned int nr_fields
;
187 struct lttng_probe_desc
{
188 const struct lttng_event_desc
*event_desc
;
189 unsigned int nr_events
;
190 struct cds_list_head head
; /* chain registered probes */
193 struct ust_pending_probe
;
196 * ltt_event structure is referred to by the tracing fast path. It must be
201 struct ltt_channel
*chan
;
203 const struct lttng_event_desc
*desc
;
205 struct lttng_ctx
*ctx
;
206 enum lttng_ust_instrumentation instrumentation
;
209 struct cds_list_head list
; /* Event list */
210 struct ust_pending_probe
*pending_probe
;
211 int metadata_dumped
:1;
215 struct lttng_ust_shm_handle
;
217 struct ltt_channel_ops
{
218 struct ltt_channel
*(*channel_create
)(const char *name
,
220 size_t subbuf_size
, size_t num_subbuf
,
221 unsigned int switch_timer_interval
,
222 unsigned int read_timer_interval
,
223 int *shm_fd
, int *wait_fd
,
224 uint64_t *memory_map_size
,
225 struct ltt_channel
*chan_priv_init
);
226 void (*channel_destroy
)(struct ltt_channel
*ltt_chan
);
227 struct lttng_ust_lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
,
228 struct lttng_ust_shm_handle
*handle
,
229 int *shm_fd
, int *wait_fd
,
230 uint64_t *memory_map_size
);
231 void (*buffer_read_close
)(struct lttng_ust_lib_ring_buffer
*buf
,
232 struct lttng_ust_shm_handle
*handle
);
233 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
235 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
236 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
, const void *src
,
239 * packet_avail_size returns the available size in the current
240 * packet. Note that the size returned is only a hint, since it
241 * may change due to concurrent writes.
243 size_t (*packet_avail_size
)(struct channel
*chan
,
244 struct lttng_ust_shm_handle
*handle
);
245 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
246 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
247 int (*is_finalized
)(struct channel
*chan
);
248 int (*is_disabled
)(struct channel
*chan
);
249 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
254 * The pointers located in this private data are NOT safe to be
255 * dereferenced by the consumer. The only operations the
256 * consumer process is designed to be allowed to do is to read
257 * and perform subbuffer flush.
259 struct channel
*chan
; /* Channel buffers */
261 struct lttng_ctx
*ctx
;
262 /* Event ID management */
263 struct ltt_session
*session
;
264 int objd
; /* Object associated to channel */
265 unsigned int free_event_id
; /* Next event ID to allocate */
266 unsigned int used_event_id
; /* Max allocated event IDs */
267 struct cds_list_head list
; /* Channel list */
268 struct ltt_channel_ops
*ops
;
269 int header_type
; /* 0: unset, 1: compact, 2: large */
270 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
271 int metadata_dumped
:1;
273 /* Channel ID, available for consumer too */
275 /* Copy of session UUID for consumer (availability through shm) */
276 uuid_t uuid
; /* Trace session unique ID */
280 int active
; /* Is trace session active ? */
281 int been_active
; /* Has trace session been active ? */
282 int objd
; /* Object associated to session */
283 struct ltt_channel
*metadata
; /* Metadata channel */
284 struct cds_list_head chan
; /* Channel list head */
285 struct cds_list_head events
; /* Event list head */
286 struct cds_list_head list
; /* Session list */
287 unsigned int free_chan_id
; /* Next chan ID to allocate */
288 uuid_t uuid
; /* Trace session unique ID */
289 int metadata_dumped
:1;
292 struct ltt_transport
{
294 struct cds_list_head node
;
295 struct ltt_channel_ops ops
;
298 struct ltt_session
*ltt_session_create(void);
299 int ltt_session_enable(struct ltt_session
*session
);
300 int ltt_session_disable(struct ltt_session
*session
);
301 void ltt_session_destroy(struct ltt_session
*session
);
303 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
304 const char *transport_name
,
306 size_t subbuf_size
, size_t num_subbuf
,
307 unsigned int switch_timer_interval
,
308 unsigned int read_timer_interval
,
309 int *shm_fd
, int *wait_fd
,
310 uint64_t *memory_map_size
,
311 struct ltt_channel
*chan_priv_init
);
312 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
313 int overwrite
, void *buf_addr
,
314 size_t subbuf_size
, size_t num_subbuf
,
315 unsigned int switch_timer_interval
,
316 unsigned int read_timer_interval
,
317 int *shm_fd
, int *wait_fd
,
318 uint64_t *memory_map_size
);
320 struct ltt_event
*ltt_event_create(struct ltt_channel
*chan
,
321 struct lttng_ust_event
*event_param
,
324 int ltt_channel_enable(struct ltt_channel
*channel
);
325 int ltt_channel_disable(struct ltt_channel
*channel
);
326 int ltt_event_enable(struct ltt_event
*event
);
327 int ltt_event_disable(struct ltt_event
*event
);
329 void ltt_transport_register(struct ltt_transport
*transport
);
330 void ltt_transport_unregister(struct ltt_transport
*transport
);
332 void synchronize_trace(void);
334 int ltt_probe_register(struct lttng_probe_desc
*desc
);
335 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
336 int pending_probe_fix_events(const struct lttng_event_desc
*desc
);
337 const struct lttng_event_desc
*ltt_event_get(const char *name
);
338 void ltt_event_put(const struct lttng_event_desc
*desc
);
339 int ltt_probes_init(void);
340 void ltt_probes_exit(void);
341 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
342 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx_p
);
343 void lttng_remove_context_field(struct lttng_ctx
**ctx_p
,
344 struct lttng_ctx_field
*field
);
345 void lttng_destroy_context(struct lttng_ctx
*ctx
);
346 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
347 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
348 int lttng_add_pthread_id_to_ctx(struct lttng_ctx
**ctx
);
349 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
350 void lttng_context_vtid_reset(void);
351 void lttng_context_vpid_reset(void);
353 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_metadata
;
354 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_discard
;
355 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_overwrite
;
357 struct cds_list_head ltt_transport_list
;
358 struct ltt_transport
*ltt_transport_find(const char *name
);
360 #endif /* _UST_LTTNG_EVENTS_H */