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 /* Type description */
23 /* Update the astract_types name table in lttng-types.c along with this enum */
33 /* Update the string_encodings name table in lttng-types.c along with this enum */
34 enum lttng_string_encodings
{
35 lttng_encode_none
= 0,
36 lttng_encode_UTF8
= 1,
37 lttng_encode_ASCII
= 2,
41 struct lttng_enum_entry
{
42 unsigned long long start
, end
; /* start and end are inclusive */
46 #define __type_integer(_type, _byte_order, _base) \
48 .atype = atype_integer, \
51 .size = sizeof(_type), \
52 .alignment = ltt_alignof(_type) * CHAR_BIT, \
53 .signedness = is_signed_type(_type), \
54 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
56 .encoding = lttng_encode_none, \
60 struct lttng_integer_type {
61 unsigned int size
; /* in bits */
62 unsigned short alignment
; /* in bits */
63 unsigned int signedness
:1;
64 unsigned int reverse_byte_order
:1;
65 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
66 enum lttng_string_encodings encoding
;
69 union _lttng_basic_type
{
70 struct lttng_integer_type integer
;
75 enum lttng_string_encodings encoding
;
79 struct lttng_basic_type
{
80 enum abstract_types atype
;
82 union _lttng_basic_type basic
;
87 enum abstract_types atype
;
89 union _lttng_basic_type basic
;
91 struct lttng_basic_type elem_type
;
92 unsigned int length
; /* num. elems. */
95 struct lttng_basic_type length_type
;
96 struct lttng_basic_type elem_type
;
103 struct lttng_type container_type
;
104 const struct lttng_enum_entry
*entries
;
108 /* Event field description */
110 struct lttng_event_field
{
112 struct lttng_type type
;
115 struct lttng_event_desc
{
116 const struct lttng_event_field
*fields
;
118 void *probe_callback
;
119 unsigned int nr_fields
;
122 struct lttng_probe_desc
{
123 const struct lttng_event_desc
*event_desc
;
124 unsigned int nr_events
;
125 struct list_head head
; /* chain registered probes */
129 * ltt_event structure is referred to by the tracing fast path. It must be
134 struct ltt_channel
*chan
;
135 const struct lttng_event_desc
*desc
;
137 enum lttng_kernel_instrumentation instrumentation
;
147 struct list_head list
; /* Event list */
148 int metadata_dumped
:1;
151 struct ltt_channel_ops
{
152 struct channel
*(*channel_create
)(const char *name
,
153 struct ltt_channel
*ltt_chan
,
155 size_t subbuf_size
, size_t num_subbuf
,
156 unsigned int switch_timer_interval
,
157 unsigned int read_timer_interval
);
158 void (*channel_destroy
)(struct channel
*chan
);
159 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
160 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
161 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
);
162 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
163 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
166 * packet_avail_size returns the available size in the current
167 * packet. Note that the size returned is only a hint, since it
168 * may change due to concurrent writes.
170 size_t (*packet_avail_size
)(struct channel
*chan
);
171 wait_queue_head_t
*(*get_reader_wait_queue
)(struct ltt_channel
*chan
);
176 struct channel
*chan
; /* Channel buffers */
177 /* Event ID management */
178 struct ltt_session
*session
;
179 struct file
*file
; /* File associated to channel */
180 unsigned int free_event_id
; /* Next event ID to allocate */
181 struct list_head list
; /* Channel list */
182 wait_queue_head_t notify_wait
; /* Channel addition notif. waitqueue */
183 struct ltt_channel_ops
*ops
;
184 int header_type
; /* 0: unset, 1: compact, 2: large */
185 int metadata_dumped
:1;
189 int active
; /* Is trace session active ? */
190 struct file
*file
; /* File associated to session */
191 struct ltt_channel
*metadata
; /* Metadata channel */
192 struct list_head chan
; /* Channel list head */
193 struct list_head events
; /* Event list head */
194 struct list_head list
; /* Session list */
195 unsigned int free_chan_id
; /* Next chan ID to allocate */
196 uuid_le uuid
; /* Trace session unique ID */
197 int metadata_dumped
:1;
200 struct ltt_transport
{
202 struct module
*owner
;
203 struct list_head node
;
204 struct ltt_channel_ops ops
;
207 struct ltt_session
*ltt_session_create(void);
208 int ltt_session_start(struct ltt_session
*session
);
209 int ltt_session_stop(struct ltt_session
*session
);
210 void ltt_session_destroy(struct ltt_session
*session
);
212 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
213 const char *transport_name
,
215 size_t subbuf_size
, size_t num_subbuf
,
216 unsigned int switch_timer_interval
,
217 unsigned int read_timer_interval
);
218 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
219 int overwrite
, void *buf_addr
,
220 size_t subbuf_size
, size_t num_subbuf
,
221 unsigned int switch_timer_interval
,
222 unsigned int read_timer_interval
);
223 void _ltt_channel_destroy(struct ltt_channel
*chan
);
225 struct ltt_event
*ltt_event_create(struct ltt_channel
*chan
,
227 struct lttng_kernel_event
*event_param
,
229 int ltt_event_unregister(struct ltt_event
*event
);
231 void ltt_transport_register(struct ltt_transport
*transport
);
232 void ltt_transport_unregister(struct ltt_transport
*transport
);
234 int ltt_debugfs_abi_init(void);
235 void ltt_debugfs_abi_exit(void);
237 int ltt_probe_register(struct lttng_probe_desc
*desc
);
238 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
239 const struct lttng_event_desc
*ltt_event_get(const char *name
);
240 void ltt_event_put(const struct lttng_event_desc
*desc
);
241 int ltt_probes_init(void);
242 void ltt_probes_exit(void);
244 #ifdef CONFIG_KPROBES
245 int lttng_kprobes_register(const char *name
,
246 const char *symbol_name
,
249 struct ltt_event
*event
);
250 void lttng_kprobes_unregister(struct ltt_event
*event
);
253 int lttng_kprobes_register(const char *name
,
254 const char *symbol_name
,
257 struct ltt_event
*event
)
262 void lttng_kprobes_unregister(struct ltt_event
*event
)
267 #ifdef CONFIG_DYNAMIC_FTRACE
268 int lttng_ftrace_register(const char *name
,
269 const char *symbol_name
,
270 struct ltt_event
*event
);
271 void lttng_ftrace_unregister(struct ltt_event
*event
);
274 int lttng_ftrace_register(const char *name
,
275 const char *symbol_name
,
276 struct ltt_event
*event
)
282 void lttng_ftrace_unregister(struct ltt_event
*event
)
286 #endif /* _LTT_EVENTS_H */