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 <urcu/hlist.h>
23 #include <uuid/uuid.h>
25 #include <lttng/ust-abi.h>
26 #include <lttng/ust-tracer.h>
32 struct lttng_ust_lib_ring_buffer_ctx
;
35 * LTTng client type enumeration. Used by the consumer to map the
36 * callbacks from its own address space.
38 enum lttng_client_types
{
39 LTTNG_CLIENT_METADATA
= 0,
40 LTTNG_CLIENT_DISCARD
= 1,
41 LTTNG_CLIENT_OVERWRITE
= 2,
42 LTTNG_NR_CLIENT_TYPES
,
45 /* Type description */
47 /* Update the astract_types name table in lttng-types.c along with this enum */
58 /* Update the string_encodings name table in lttng-types.c along with this enum */
59 enum lttng_string_encodings
{
60 lttng_encode_none
= 0,
61 lttng_encode_UTF8
= 1,
62 lttng_encode_ASCII
= 2,
66 struct lttng_enum_entry
{
67 unsigned long long start
, end
; /* start and end are inclusive */
71 #define __type_integer(_type, _byte_order, _base, _encoding) \
73 .atype = atype_integer, \
76 .size = sizeof(_type) * CHAR_BIT, \
77 .alignment = lttng_alignof(_type) * CHAR_BIT, \
78 .signedness = lttng_is_signed_type(_type), \
79 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
81 .encoding = lttng_encode_##_encoding, \
85 struct lttng_integer_type {
86 unsigned int size
; /* in bits */
87 unsigned short alignment
; /* in bits */
88 unsigned int signedness
:1;
89 unsigned int reverse_byte_order
:1;
90 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
91 enum lttng_string_encodings encoding
;
95 * Only float and double are supported. long double is not supported at
98 #define _float_mant_dig(_type) \
99 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
100 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
103 #define __type_float(_type) \
105 .atype = atype_float, \
108 .exp_dig = sizeof(_type) * CHAR_BIT \
109 - _float_mant_dig(_type), \
110 .mant_dig = _float_mant_dig(_type), \
111 .alignment = lttng_alignof(_type) * CHAR_BIT, \
112 .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
116 struct lttng_float_type {
117 unsigned int exp_dig
; /* exponent digits, in bits */
118 unsigned int mant_dig
; /* mantissa digits, in bits */
119 unsigned short alignment
; /* in bits */
120 unsigned int reverse_byte_order
:1;
123 union _lttng_basic_type
{
124 struct lttng_integer_type integer
;
129 enum lttng_string_encodings encoding
;
131 struct lttng_float_type _float
;
134 struct lttng_basic_type
{
135 enum abstract_types atype
;
137 union _lttng_basic_type basic
;
142 enum abstract_types atype
;
144 union _lttng_basic_type basic
;
146 struct lttng_basic_type elem_type
;
147 unsigned int length
; /* num. elems. */
150 struct lttng_basic_type length_type
;
151 struct lttng_basic_type elem_type
;
158 struct lttng_type container_type
;
159 const struct lttng_enum_entry
*entries
;
163 /* Event field description */
165 struct lttng_event_field
{
167 struct lttng_type type
;
170 struct lttng_ctx_field
{
171 struct lttng_event_field event_field
;
172 size_t (*get_size
)(size_t offset
);
173 void (*record
)(struct lttng_ctx_field
*field
,
174 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
175 struct ltt_channel
*chan
);
178 void (*destroy
)(struct lttng_ctx_field
*field
);
182 struct lttng_ctx_field
*fields
;
183 unsigned int nr_fields
;
184 unsigned int allocated_fields
;
188 * Entry describing a per-session active wildcard, along with the event
189 * attribute and channel information configuring the events that need to
192 struct session_wildcard
{
193 struct ltt_channel
*chan
;
194 struct lttng_ctx
*ctx
; /* TODO */
195 struct lttng_ust_event event_param
;
196 struct cds_list_head events
; /* list of events enabled */
197 struct cds_list_head list
; /* per-session list of wildcards */
198 struct cds_list_head session_list
; /* node of session wildcard list */
199 struct wildcard_entry
*entry
;
200 unsigned int enabled
:1;
204 * Entry describing an active wildcard (per name) for all sessions.
206 struct wildcard_entry
{
207 /* node of global wildcards list */
208 struct cds_list_head list
;
209 /* head of session list to which this wildcard apply */
210 struct cds_list_head session_list
;
214 struct lttng_event_desc
{
216 void *probe_callback
;
217 const struct lttng_event_ctx
*ctx
; /* context */
218 const struct lttng_event_field
*fields
; /* event payload */
219 unsigned int nr_fields
;
220 const int **loglevel
;
223 struct lttng_probe_desc
{
224 const char *provider
;
225 const struct lttng_event_desc
**event_desc
;
226 unsigned int nr_events
;
227 struct cds_list_head head
; /* chain registered probes */
230 struct tp_list_entry
{
231 struct lttng_ust_tracepoint_iter tp
;
232 struct cds_list_head head
;
235 struct lttng_ust_tracepoint_list
{
236 struct tp_list_entry
*iter
;
237 struct cds_list_head head
;
240 struct ust_pending_probe
;
243 * ltt_event structure is referred to by the tracing fast path. It must be
248 struct ltt_channel
*chan
;
250 const struct lttng_event_desc
*desc
;
252 struct lttng_ctx
*ctx
;
253 enum lttng_ust_instrumentation instrumentation
;
256 struct cds_list_head list
; /* Event list */
257 struct cds_list_head wildcard_list
; /* Event list for wildcard */
258 struct ust_pending_probe
*pending_probe
;
259 unsigned int metadata_dumped
:1;
263 struct lttng_ust_shm_handle
;
265 struct ltt_channel_ops
{
266 struct ltt_channel
*(*channel_create
)(const char *name
,
268 size_t subbuf_size
, size_t num_subbuf
,
269 unsigned int switch_timer_interval
,
270 unsigned int read_timer_interval
,
271 int **shm_fd
, int **wait_fd
,
272 uint64_t **memory_map_size
,
273 struct ltt_channel
*chan_priv_init
);
274 void (*channel_destroy
)(struct ltt_channel
*ltt_chan
);
275 struct lttng_ust_lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
,
276 struct lttng_ust_shm_handle
*handle
,
277 int **shm_fd
, int **wait_fd
,
278 uint64_t **memory_map_size
);
279 void (*buffer_read_close
)(struct lttng_ust_lib_ring_buffer
*buf
,
280 struct lttng_ust_shm_handle
*handle
);
281 int (*event_reserve
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
283 void (*event_commit
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
);
284 void (*event_write
)(struct lttng_ust_lib_ring_buffer_ctx
*ctx
, const void *src
,
287 * packet_avail_size returns the available size in the current
288 * packet. Note that the size returned is only a hint, since it
289 * may change due to concurrent writes.
291 size_t (*packet_avail_size
)(struct channel
*chan
,
292 struct lttng_ust_shm_handle
*handle
);
293 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
294 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
295 int (*is_finalized
)(struct channel
*chan
);
296 int (*is_disabled
)(struct channel
*chan
);
297 int (*flush_buffer
)(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
);
302 * The pointers located in this private data are NOT safe to be
303 * dereferenced by the consumer. The only operations the
304 * consumer process is designed to be allowed to do is to read
305 * and perform subbuffer flush.
307 struct channel
*chan
; /* Channel buffers */
309 struct lttng_ctx
*ctx
;
310 /* Event ID management */
311 struct ltt_session
*session
;
312 int objd
; /* Object associated to channel */
313 unsigned int free_event_id
; /* Next event ID to allocate */
314 unsigned int used_event_id
; /* Max allocated event IDs */
315 struct cds_list_head list
; /* Channel list */
316 struct ltt_channel_ops
*ops
;
317 int header_type
; /* 0: unset, 1: compact, 2: large */
318 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
319 unsigned int metadata_dumped
:1;
321 /* Channel ID, available for consumer too */
323 /* Copy of session UUID for consumer (availability through shm) */
324 uuid_t uuid
; /* Trace session unique ID */
328 int active
; /* Is trace session active ? */
329 int been_active
; /* Has trace session been active ? */
330 int objd
; /* Object associated to session */
331 struct ltt_channel
*metadata
; /* Metadata channel */
332 struct cds_list_head chan
; /* Channel list head */
333 struct cds_list_head events
; /* Event list head */
334 struct cds_list_head wildcards
; /* Wildcard list head */
335 struct cds_list_head list
; /* Session list */
336 unsigned int free_chan_id
; /* Next chan ID to allocate */
337 uuid_t uuid
; /* Trace session unique ID */
338 unsigned int metadata_dumped
:1;
341 struct ltt_transport
{
343 struct cds_list_head node
;
344 struct ltt_channel_ops ops
;
347 struct ltt_session
*ltt_session_create(void);
348 int ltt_session_enable(struct ltt_session
*session
);
349 int ltt_session_disable(struct ltt_session
*session
);
350 void ltt_session_destroy(struct ltt_session
*session
);
352 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
353 const char *transport_name
,
355 size_t subbuf_size
, size_t num_subbuf
,
356 unsigned int switch_timer_interval
,
357 unsigned int read_timer_interval
,
358 int **shm_fd
, int **wait_fd
,
359 uint64_t **memory_map_size
,
360 struct ltt_channel
*chan_priv_init
);
361 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
362 int overwrite
, void *buf_addr
,
363 size_t subbuf_size
, size_t num_subbuf
,
364 unsigned int switch_timer_interval
,
365 unsigned int read_timer_interval
,
366 int **shm_fd
, int **wait_fd
,
367 uint64_t **memory_map_size
);
369 int ltt_event_create(struct ltt_channel
*chan
,
370 struct lttng_ust_event
*event_param
,
372 struct ltt_event
**event
);
374 int ltt_channel_enable(struct ltt_channel
*channel
);
375 int ltt_channel_disable(struct ltt_channel
*channel
);
376 int ltt_event_enable(struct ltt_event
*event
);
377 int ltt_event_disable(struct ltt_event
*event
);
379 void ltt_transport_register(struct ltt_transport
*transport
);
380 void ltt_transport_unregister(struct ltt_transport
*transport
);
382 void synchronize_trace(void);
384 int ltt_probe_register(struct lttng_probe_desc
*desc
);
385 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
386 int pending_probe_fix_events(const struct lttng_event_desc
*desc
);
387 const struct lttng_event_desc
*ltt_event_get(const char *name
);
388 void ltt_event_put(const struct lttng_event_desc
*desc
);
389 int ltt_probes_init(void);
390 void ltt_probes_exit(void);
391 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
392 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx_p
);
393 void lttng_remove_context_field(struct lttng_ctx
**ctx_p
,
394 struct lttng_ctx_field
*field
);
395 void lttng_destroy_context(struct lttng_ctx
*ctx
);
396 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
397 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
398 int lttng_add_pthread_id_to_ctx(struct lttng_ctx
**ctx
);
399 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
400 void lttng_context_vtid_reset(void);
401 void lttng_context_vpid_reset(void);
403 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_metadata
;
404 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_discard
;
405 const struct lttng_ust_lib_ring_buffer_client_cb
*lttng_client_callbacks_overwrite
;
407 struct ltt_transport
*ltt_transport_find(const char *name
);
409 int ltt_probes_get_event_list(struct lttng_ust_tracepoint_list
*list
);
410 void ltt_probes_prune_event_list(struct lttng_ust_tracepoint_list
*list
);
411 struct lttng_ust_tracepoint_iter
*
412 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list
*list
);
414 struct wildcard_entry
*match_wildcard(const char *name
);
415 struct session_wildcard
*add_wildcard(const char *name
,
416 struct ltt_channel
*chan
,
417 struct lttng_ust_event
*event_param
);
418 void _remove_wildcard(struct session_wildcard
*wildcard
);
419 int ltt_wildcard_enable(struct session_wildcard
*wildcard
);
420 int ltt_wildcard_disable(struct session_wildcard
*wildcard
);
421 int ltt_wildcard_create(struct ltt_channel
*chan
,
422 struct lttng_ust_event
*event_param
,
423 struct session_wildcard
**sl
);
425 #endif /* _LTTNG_UST_EVENTS_H */