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 <ust/lttng-ust-abi.h>
18 #include <ust/lttng-tracer.h>
24 struct lib_ring_buffer_ctx
;
26 /* Type description */
28 /* Update the astract_types name table in lttng-types.c along with this enum */
39 /* Update the string_encodings name table in lttng-types.c along with this enum */
40 enum lttng_string_encodings
{
41 lttng_encode_none
= 0,
42 lttng_encode_UTF8
= 1,
43 lttng_encode_ASCII
= 2,
47 struct lttng_enum_entry
{
48 unsigned long long start
, end
; /* start and end are inclusive */
52 #define __type_integer(_type, _byte_order, _base, _encoding) \
54 .atype = atype_integer, \
57 .size = sizeof(_type) * CHAR_BIT, \
58 .alignment = lttng_alignof(_type) * CHAR_BIT, \
59 .signedness = lttng_is_signed_type(_type), \
60 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
62 .encoding = lttng_encode_##_encoding, \
66 struct lttng_integer_type {
67 unsigned int size
; /* in bits */
68 unsigned short alignment
; /* in bits */
69 unsigned int signedness
:1;
70 unsigned int reverse_byte_order
:1;
71 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
72 enum lttng_string_encodings encoding
;
75 #define _float_mant_dig(_type) \
76 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
77 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
78 : (sizeof(_type) == sizeof(long double) ? LDBL_MANT_DIG \
81 #define __type_float(_type) \
83 .atype = atype_float, \
86 .exp_dig = sizeof(_type) * CHAR_BIT \
87 - _float_mant_dig(_type), \
88 .mant_dig = _float_mant_dig(_type), \
89 .alignment = lttng_alignof(_type) * CHAR_BIT, \
90 .signedness = lttng_is_signed_type(_type), \
91 .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
95 struct lttng_float_type {
96 unsigned int exp_dig
; /* exponent digits, in bits */
97 unsigned int mant_dig
; /* mantissa digits, in bits */
98 unsigned short alignment
; /* in bits */
99 unsigned int reverse_byte_order
:1;
102 union _lttng_basic_type
{
103 struct lttng_integer_type integer
;
108 enum lttng_string_encodings encoding
;
110 struct lttng_float_type _float
;
113 struct lttng_basic_type
{
114 enum abstract_types atype
;
116 union _lttng_basic_type basic
;
121 enum abstract_types atype
;
123 union _lttng_basic_type basic
;
125 struct lttng_basic_type elem_type
;
126 unsigned int length
; /* num. elems. */
129 struct lttng_basic_type length_type
;
130 struct lttng_basic_type elem_type
;
137 struct lttng_type container_type
;
138 const struct lttng_enum_entry
*entries
;
142 /* Event field description */
144 struct lttng_event_field
{
146 struct lttng_type type
;
149 struct lttng_ctx_field
{
150 struct lttng_event_field event_field
;
151 size_t (*get_size
)(size_t offset
);
152 void (*record
)(struct lttng_ctx_field
*field
,
153 struct lib_ring_buffer_ctx
*ctx
,
154 struct ltt_channel
*chan
);
157 void (*destroy
)(struct lttng_ctx_field
*field
);
161 struct lttng_ctx_field
*fields
;
162 unsigned int nr_fields
;
163 unsigned int allocated_fields
;
166 struct lttng_event_desc
{
168 void *probe_callback
;
169 const struct lttng_event_ctx
*ctx
; /* context */
170 const struct lttng_event_field
*fields
; /* event payload */
171 unsigned int nr_fields
;
174 struct lttng_probe_desc
{
175 const struct lttng_event_desc
*event_desc
;
176 unsigned int nr_events
;
177 struct cds_list_head head
; /* chain registered probes */
181 * ltt_event structure is referred to by the tracing fast path. It must be
186 struct ltt_channel
*chan
;
188 const struct lttng_event_desc
*desc
;
190 struct lttng_ctx
*ctx
;
191 enum lttng_ust_instrumentation instrumentation
;
194 struct cds_list_head list
; /* Event list */
195 int metadata_dumped
:1;
200 struct ltt_channel_ops
{
201 struct shm_handle
*(*channel_create
)(const char *name
,
202 struct ltt_channel
*ltt_chan
,
204 size_t subbuf_size
, size_t num_subbuf
,
205 unsigned int switch_timer_interval
,
206 unsigned int read_timer_interval
);
207 void (*channel_destroy
)(struct shm_handle
*handle
);
208 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
209 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
210 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
212 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
213 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
216 * packet_avail_size returns the available size in the current
217 * packet. Note that the size returned is only a hint, since it
218 * may change due to concurrent writes.
220 size_t (*packet_avail_size
)(struct channel
*chan
);
221 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
222 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
223 int (*is_finalized
)(struct channel
*chan
);
224 int (*is_disabled
)(struct channel
*chan
);
229 struct channel
*chan
; /* Channel buffers */
231 struct lttng_ctx
*ctx
;
232 /* Event ID management */
233 struct ltt_session
*session
;
234 int objd
; /* Object associated to channel */
235 unsigned int free_event_id
; /* Next event ID to allocate */
236 struct cds_list_head list
; /* Channel list */
237 struct ltt_channel_ops
*ops
;
238 int header_type
; /* 0: unset, 1: compact, 2: large */
239 struct shm_handle
*handle
; /* shared-memory handle */
240 int metadata_dumped
:1;
244 int active
; /* Is trace session active ? */
245 int been_active
; /* Has trace session been active ? */
246 int objd
; /* Object associated to session */
247 struct ltt_channel
*metadata
; /* Metadata channel */
248 struct cds_list_head chan
; /* Channel list head */
249 struct cds_list_head events
; /* Event list head */
250 struct cds_list_head list
; /* Session list */
251 unsigned int free_chan_id
; /* Next chan ID to allocate */
252 uuid_t uuid
; /* Trace session unique ID */
253 int metadata_dumped
:1;
256 struct ltt_transport
{
258 struct cds_list_head node
;
259 struct ltt_channel_ops ops
;
262 struct ltt_session
*ltt_session_create(void);
263 int ltt_session_enable(struct ltt_session
*session
);
264 int ltt_session_disable(struct ltt_session
*session
);
265 void ltt_session_destroy(struct ltt_session
*session
);
267 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
268 const char *transport_name
,
270 size_t subbuf_size
, size_t num_subbuf
,
271 unsigned int switch_timer_interval
,
272 unsigned int read_timer_interval
);
273 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
274 int overwrite
, void *buf_addr
,
275 size_t subbuf_size
, size_t num_subbuf
,
276 unsigned int switch_timer_interval
,
277 unsigned int read_timer_interval
);
279 struct ltt_event
*ltt_event_create(struct ltt_channel
*chan
,
280 struct lttng_ust_event
*event_param
,
283 int ltt_channel_enable(struct ltt_channel
*channel
);
284 int ltt_channel_disable(struct ltt_channel
*channel
);
285 int ltt_event_enable(struct ltt_event
*event
);
286 int ltt_event_disable(struct ltt_event
*event
);
288 void ltt_transport_register(struct ltt_transport
*transport
);
289 void ltt_transport_unregister(struct ltt_transport
*transport
);
291 void synchronize_trace(void);
292 //int ltt_debugfs_abi_init(void);
293 //void ltt_debugfs_abi_exit(void);
295 int ltt_probe_register(struct lttng_probe_desc
*desc
);
296 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
297 const struct lttng_event_desc
*ltt_event_get(const char *name
);
298 void ltt_event_put(const struct lttng_event_desc
*desc
);
299 int ltt_probes_init(void);
300 void ltt_probes_exit(void);
301 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
302 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
303 struct lttng_ctx_field
*field
);
304 void lttng_destroy_context(struct lttng_ctx
*ctx
);
305 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
307 //extern const struct file_operations lttng_tracepoint_list_fops;
309 #endif /* _UST_LTTNG_EVENTS_H */