1 #ifndef _LTTNG_UST_EVENTS_H
2 #define _LTTNG_UST_EVENTS_H
7 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Holds LTTng per-session event registry.
11 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
12 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
14 * Permission is hereby granted to use or copy this program
15 * for any purpose, provided the above notices are retained on all copies.
16 * Permission to modify the code and to distribute modified code is granted,
17 * provided the above notices are retained, and a notice that the code was
18 * modified is included with the above copyright notice.
21 #include <urcu/list.h>
22 #include <uuid/uuid.h>
24 #include <lttng/ust-abi.h>
25 #include <lttng/ust-tracer.h>
31 struct lttng_ust_lib_ring_buffer_ctx
;
34 * LTTng client type enumeration. Used by the consumer to map the
35 * callbacks from its own address space.
37 enum lttng_client_types
{
38 LTTNG_CLIENT_METADATA
= 0,
39 LTTNG_CLIENT_DISCARD
= 1,
40 LTTNG_CLIENT_OVERWRITE
= 2,
41 LTTNG_NR_CLIENT_TYPES
,
44 /* Type description */
46 /* Update the astract_types name table in lttng-types.c along with this enum */
57 /* Update the string_encodings name table in lttng-types.c along with this enum */
58 enum lttng_string_encodings
{
59 lttng_encode_none
= 0,
60 lttng_encode_UTF8
= 1,
61 lttng_encode_ASCII
= 2,
65 struct lttng_enum_entry
{
66 unsigned long long start
, end
; /* start and end are inclusive */
70 #define __type_integer(_type, _byte_order, _base, _encoding) \
72 .atype = atype_integer, \
75 .size = sizeof(_type) * CHAR_BIT, \
76 .alignment = lttng_alignof(_type) * CHAR_BIT, \
77 .signedness = lttng_is_signed_type(_type), \
78 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
80 .encoding = lttng_encode_##_encoding, \
84 struct lttng_integer_type {
85 unsigned int size
; /* in bits */
86 unsigned short alignment
; /* in bits */
87 unsigned int signedness
:1;
88 unsigned int reverse_byte_order
:1;
89 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
90 enum lttng_string_encodings encoding
;
94 * Only float and double are supported. long double is not supported at
97 #define _float_mant_dig(_type) \
98 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
99 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
102 #define __type_float(_type) \
104 .atype = atype_float, \
107 .exp_dig = sizeof(_type) * CHAR_BIT \
108 - _float_mant_dig(_type), \
109 .mant_dig = _float_mant_dig(_type), \
110 .alignment = lttng_alignof(_type) * CHAR_BIT, \
111 .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
115 struct lttng_float_type {
116 unsigned int exp_dig
; /* exponent digits, in bits */
117 unsigned int mant_dig
; /* mantissa digits, in bits */
118 unsigned short alignment
; /* in bits */
119 unsigned int reverse_byte_order
:1;
122 union _lttng_basic_type
{
123 struct lttng_integer_type integer
;
128 enum lttng_string_encodings encoding
;
130 struct lttng_float_type _float
;
133 struct lttng_basic_type
{
134 enum abstract_types atype
;
136 union _lttng_basic_type basic
;
141 enum abstract_types atype
;
143 union _lttng_basic_type basic
;
145 struct lttng_basic_type elem_type
;
146 unsigned int length
; /* num. elems. */
149 struct lttng_basic_type length_type
;
150 struct lttng_basic_type elem_type
;
157 struct lttng_type container_type
;
158 const struct lttng_enum_entry
*entries
;
162 /* Event field description */
164 struct lttng_event_field
{
166 struct lttng_type type
;
169 struct lttng_ctx_field
{
170 struct lttng_event_field event_field
;
171 size_t (*get_size
)(size_t offset
);
172 void (*record
)(struct lttng_ctx_field
*field
,
173 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
174 struct ltt_channel
*chan
);
177 void (*destroy
)(struct lttng_ctx_field
*field
);
181 struct lttng_ctx_field
*fields
;
182 unsigned int nr_fields
;
183 unsigned int allocated_fields
;
186 struct lttng_event_desc
{
188 void *probe_callback
;
189 const struct lttng_event_ctx
*ctx
; /* context */
190 const struct lttng_event_field
*fields
; /* event payload */
191 unsigned int nr_fields
;
194 struct lttng_probe_desc
{
195 const struct lttng_event_desc
*event_desc
;
196 unsigned int nr_events
;
197 struct cds_list_head head
; /* chain registered probes */
200 struct ust_pending_probe
;
203 * ltt_event structure is referred to by the tracing fast path. It must be
208 struct ltt_channel
*chan
;
210 const struct lttng_event_desc
*desc
;
212 struct lttng_ctx
*ctx
;
213 enum lttng_ust_instrumentation instrumentation
;
216 struct cds_list_head list
; /* Event list */
217 struct ust_pending_probe
*pending_probe
;
218 int metadata_dumped
:1;
222 struct lttng_ust_shm_handle
;
224 struct ltt_channel_ops
{
225 struct ltt_channel
*(*channel_create
)(const char *name
,
227 size_t subbuf_size
, size_t num_subbuf
,
228 unsigned int switch_timer_interval
,
229 unsigned int read_timer_interval
,
230 int *shm_fd
, int *wait_fd
,
231 uint64_t *memory_map_size
,
232 struct ltt_channel
*chan_priv_init
);
233 void (*channel_destroy
)(struct ltt_channel
*ltt_chan
);
234 struct lttng_ust_lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
,
235 struct lttng_ust_shm_handle
*handle
,
236 int *shm_fd
, int *wait_fd
,
237 uint64_t *memory_map_size
);
238 void (*buffer_read_close
)(struct lttng_ust_lib_ring_buffer
*buf
,
239 struct lttng_ust_shm_handle
*handle
);
240 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
242 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
243 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
, const void *src
,
246 * packet_avail_size returns the available size in the current
247 * packet. Note that the size returned is only a hint, since it
248 * may change due to concurrent writes.
250 size_t (*packet_avail_size
)(struct channel
*chan
,
251 struct lttng_ust_shm_handle
*handle
);
252 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
253 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
254 int (*is_finalized
)(struct channel
*chan
);
255 int (*is_disabled
)(struct channel
*chan
);
256 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
261 * The pointers located in this private data are NOT safe to be
262 * dereferenced by the consumer. The only operations the
263 * consumer process is designed to be allowed to do is to read
264 * and perform subbuffer flush.
266 struct channel
*chan
; /* Channel buffers */
268 struct lttng_ctx
*ctx
;
269 /* Event ID management */
270 struct ltt_session
*session
;
271 int objd
; /* Object associated to channel */
272 unsigned int free_event_id
; /* Next event ID to allocate */
273 unsigned int used_event_id
; /* Max allocated event IDs */
274 struct cds_list_head list
; /* Channel list */
275 struct ltt_channel_ops
*ops
;
276 int header_type
; /* 0: unset, 1: compact, 2: large */
277 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
278 int metadata_dumped
:1;
280 /* Channel ID, available for consumer too */
282 /* Copy of session UUID for consumer (availability through shm) */
283 uuid_t uuid
; /* Trace session unique ID */
287 int active
; /* Is trace session active ? */
288 int been_active
; /* Has trace session been active ? */
289 int objd
; /* Object associated to session */
290 struct ltt_channel
*metadata
; /* Metadata channel */
291 struct cds_list_head chan
; /* Channel list head */
292 struct cds_list_head events
; /* Event list head */
293 struct cds_list_head list
; /* Session list */
294 unsigned int free_chan_id
; /* Next chan ID to allocate */
295 uuid_t uuid
; /* Trace session unique ID */
296 int metadata_dumped
:1;
299 struct ltt_transport
{
301 struct cds_list_head node
;
302 struct ltt_channel_ops ops
;
305 struct ltt_session
*ltt_session_create(void);
306 int ltt_session_enable(struct ltt_session
*session
);
307 int ltt_session_disable(struct ltt_session
*session
);
308 void ltt_session_destroy(struct ltt_session
*session
);
310 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
311 const char *transport_name
,
313 size_t subbuf_size
, size_t num_subbuf
,
314 unsigned int switch_timer_interval
,
315 unsigned int read_timer_interval
,
316 int *shm_fd
, int *wait_fd
,
317 uint64_t *memory_map_size
,
318 struct ltt_channel
*chan_priv_init
);
319 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
320 int overwrite
, void *buf_addr
,
321 size_t subbuf_size
, size_t num_subbuf
,
322 unsigned int switch_timer_interval
,
323 unsigned int read_timer_interval
,
324 int *shm_fd
, int *wait_fd
,
325 uint64_t *memory_map_size
);
327 struct ltt_event
*ltt_event_create(struct ltt_channel
*chan
,
328 struct lttng_ust_event
*event_param
,
331 int ltt_channel_enable(struct ltt_channel
*channel
);
332 int ltt_channel_disable(struct ltt_channel
*channel
);
333 int ltt_event_enable(struct ltt_event
*event
);
334 int ltt_event_disable(struct ltt_event
*event
);
336 void ltt_transport_register(struct ltt_transport
*transport
);
337 void ltt_transport_unregister(struct ltt_transport
*transport
);
339 void synchronize_trace(void);
341 int ltt_probe_register(struct lttng_probe_desc
*desc
);
342 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
343 int pending_probe_fix_events(const struct lttng_event_desc
*desc
);
344 const struct lttng_event_desc
*ltt_event_get(const char *name
);
345 void ltt_event_put(const struct lttng_event_desc
*desc
);
346 int ltt_probes_init(void);
347 void ltt_probes_exit(void);
348 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
349 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx_p
);
350 void lttng_remove_context_field(struct lttng_ctx
**ctx_p
,
351 struct lttng_ctx_field
*field
);
352 void lttng_destroy_context(struct lttng_ctx
*ctx
);
353 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
354 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
355 int lttng_add_pthread_id_to_ctx(struct lttng_ctx
**ctx
);
356 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
357 void lttng_context_vtid_reset(void);
358 void lttng_context_vpid_reset(void);
360 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_metadata
;
361 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_discard
;
362 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_overwrite
;
364 struct ltt_transport
*ltt_transport_find(const char *name
);
366 #endif /* _LTTNG_UST_EVENTS_H */