7 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Holds LTTng per-session event registry.
12 #include <linux/list.h>
13 #include <linux/uuid.h>
14 #include <linux/kprobes.h>
15 #include "ltt-debugfs-abi.h"
19 struct lib_ring_buffer_ctx
;
21 struct perf_event_attr
;
23 /* Type description */
25 /* Update the astract_types name table in lttng-types.c along with this enum */
35 /* Update the string_encodings name table in lttng-types.c along with this enum */
36 enum lttng_string_encodings
{
37 lttng_encode_none
= 0,
38 lttng_encode_UTF8
= 1,
39 lttng_encode_ASCII
= 2,
43 struct lttng_enum_entry
{
44 unsigned long long start
, end
; /* start and end are inclusive */
48 #define __type_integer(_type, _byte_order, _base) \
50 .atype = atype_integer, \
53 .size = sizeof(_type) * CHAR_BIT, \
54 .alignment = ltt_alignof(_type) * CHAR_BIT, \
55 .signedness = is_signed_type(_type), \
56 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
58 .encoding = lttng_encode_none, \
62 struct lttng_integer_type {
63 unsigned int size
; /* in bits */
64 unsigned short alignment
; /* in bits */
65 unsigned int signedness
:1;
66 unsigned int reverse_byte_order
:1;
67 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
68 enum lttng_string_encodings encoding
;
71 union _lttng_basic_type
{
72 struct lttng_integer_type integer
;
77 enum lttng_string_encodings encoding
;
81 struct lttng_basic_type
{
82 enum abstract_types atype
;
84 union _lttng_basic_type basic
;
89 enum abstract_types atype
;
91 union _lttng_basic_type basic
;
93 struct lttng_basic_type elem_type
;
94 unsigned int length
; /* num. elems. */
97 struct lttng_basic_type length_type
;
98 struct lttng_basic_type elem_type
;
105 struct lttng_type container_type
;
106 const struct lttng_enum_entry
*entries
;
110 /* Event field description */
112 struct lttng_event_field
{
114 struct lttng_type type
;
117 struct lttng_ctx_field
{
119 struct lttng_type type
;
123 struct perf_event
**e
; /* per-cpu array */
124 struct list_head head
;
125 struct perf_event_attr
*attr
;
131 struct lttng_ctx_field
*fields
;
132 unsigned int nr_fields
;
133 unsigned int allocated_fields
;
136 struct lttng_event_desc
{
138 void *probe_callback
;
139 const struct lttng_event_ctx
*ctx
; /* context */
140 const struct lttng_event_field
*fields
; /* event payload */
141 unsigned int nr_fields
;
144 struct lttng_probe_desc
{
145 const struct lttng_event_desc
*event_desc
;
146 unsigned int nr_events
;
147 struct list_head head
; /* chain registered probes */
151 * ltt_event structure is referred to by the tracing fast path. It must be
156 struct ltt_channel
*chan
;
157 const struct lttng_event_desc
*desc
;
159 enum lttng_kernel_instrumentation instrumentation
;
169 struct list_head list
; /* Event list */
170 int metadata_dumped
:1;
173 struct ltt_channel_ops
{
174 struct channel
*(*channel_create
)(const char *name
,
175 struct ltt_channel
*ltt_chan
,
177 size_t subbuf_size
, size_t num_subbuf
,
178 unsigned int switch_timer_interval
,
179 unsigned int read_timer_interval
);
180 void (*channel_destroy
)(struct channel
*chan
);
181 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
182 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
183 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
185 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
186 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
189 * packet_avail_size returns the available size in the current
190 * packet. Note that the size returned is only a hint, since it
191 * may change due to concurrent writes.
193 size_t (*packet_avail_size
)(struct channel
*chan
);
194 wait_queue_head_t
*(*get_reader_wait_queue
)(struct ltt_channel
*chan
);
199 struct channel
*chan
; /* Channel buffers */
200 /* Event ID management */
201 struct ltt_session
*session
;
202 struct file
*file
; /* File associated to channel */
203 unsigned int free_event_id
; /* Next event ID to allocate */
204 struct list_head list
; /* Channel list */
205 wait_queue_head_t notify_wait
; /* Channel addition notif. waitqueue */
206 struct ltt_channel_ops
*ops
;
207 int header_type
; /* 0: unset, 1: compact, 2: large */
208 int metadata_dumped
:1;
212 int active
; /* Is trace session active ? */
213 struct file
*file
; /* File associated to session */
214 struct ltt_channel
*metadata
; /* Metadata channel */
215 struct list_head chan
; /* Channel list head */
216 struct list_head events
; /* Event list head */
217 struct list_head list
; /* Session list */
218 unsigned int free_chan_id
; /* Next chan ID to allocate */
219 uuid_le uuid
; /* Trace session unique ID */
220 int metadata_dumped
:1;
223 struct ltt_transport
{
225 struct module
*owner
;
226 struct list_head node
;
227 struct ltt_channel_ops ops
;
230 struct ltt_session
*ltt_session_create(void);
231 int ltt_session_start(struct ltt_session
*session
);
232 int ltt_session_stop(struct ltt_session
*session
);
233 void ltt_session_destroy(struct ltt_session
*session
);
235 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
236 const char *transport_name
,
238 size_t subbuf_size
, size_t num_subbuf
,
239 unsigned int switch_timer_interval
,
240 unsigned int read_timer_interval
);
241 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
242 int overwrite
, void *buf_addr
,
243 size_t subbuf_size
, size_t num_subbuf
,
244 unsigned int switch_timer_interval
,
245 unsigned int read_timer_interval
);
247 struct ltt_event
*ltt_event_create(struct ltt_channel
*chan
,
248 struct lttng_kernel_event
*event_param
,
251 void ltt_transport_register(struct ltt_transport
*transport
);
252 void ltt_transport_unregister(struct ltt_transport
*transport
);
254 int ltt_debugfs_abi_init(void);
255 void ltt_debugfs_abi_exit(void);
257 int ltt_probe_register(struct lttng_probe_desc
*desc
);
258 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
259 const struct lttng_event_desc
*ltt_event_get(const char *name
);
260 void ltt_event_put(const struct lttng_event_desc
*desc
);
261 int ltt_probes_init(void);
262 void ltt_probes_exit(void);
264 #ifdef CONFIG_KPROBES
265 int lttng_kprobes_register(const char *name
,
266 const char *symbol_name
,
269 struct ltt_event
*event
);
270 void lttng_kprobes_unregister(struct ltt_event
*event
);
273 int lttng_kprobes_register(const char *name
,
274 const char *symbol_name
,
277 struct ltt_event
*event
)
283 void lttng_kprobes_unregister(struct ltt_event
*event
)
288 #ifdef CONFIG_DYNAMIC_FTRACE
289 int lttng_ftrace_register(const char *name
,
290 const char *symbol_name
,
291 struct ltt_event
*event
);
292 void lttng_ftrace_unregister(struct ltt_event
*event
);
295 int lttng_ftrace_register(const char *name
,
296 const char *symbol_name
,
297 struct ltt_event
*event
)
303 void lttng_ftrace_unregister(struct ltt_event
*event
)
307 #endif /* _LTT_EVENTS_H */