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"
18 #define is_signed_type(type) (((type)(-1)) < 0)
22 struct lib_ring_buffer_ctx
;
24 struct perf_event_attr
;
26 /* Type description */
28 /* Update the astract_types name table in lttng-types.c along with this enum */
38 /* Update the string_encodings name table in lttng-types.c along with this enum */
39 enum lttng_string_encodings
{
40 lttng_encode_none
= 0,
41 lttng_encode_UTF8
= 1,
42 lttng_encode_ASCII
= 2,
46 struct lttng_enum_entry
{
47 unsigned long long start
, end
; /* start and end are inclusive */
51 #define __type_integer(_type, _byte_order, _base, _encoding) \
53 .atype = atype_integer, \
56 .size = sizeof(_type) * CHAR_BIT, \
57 .alignment = ltt_alignof(_type) * CHAR_BIT, \
58 .signedness = is_signed_type(_type), \
59 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
61 .encoding = lttng_encode_##_encoding, \
65 struct lttng_integer_type {
66 unsigned int size
; /* in bits */
67 unsigned short alignment
; /* in bits */
68 unsigned int signedness
:1;
69 unsigned int reverse_byte_order
:1;
70 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
71 enum lttng_string_encodings encoding
;
74 union _lttng_basic_type
{
75 struct lttng_integer_type integer
;
80 enum lttng_string_encodings encoding
;
84 struct lttng_basic_type
{
85 enum abstract_types atype
;
87 union _lttng_basic_type basic
;
92 enum abstract_types atype
;
94 union _lttng_basic_type basic
;
96 struct lttng_basic_type elem_type
;
97 unsigned int length
; /* num. elems. */
100 struct lttng_basic_type length_type
;
101 struct lttng_basic_type elem_type
;
108 struct lttng_type container_type
;
109 const struct lttng_enum_entry
*entries
;
113 /* Event field description */
115 struct lttng_event_field
{
117 struct lttng_type type
;
120 struct lttng_ctx_field
{
121 struct lttng_event_field event_field
;
122 size_t (*get_size
)(size_t offset
);
123 void (*record
)(struct lttng_ctx_field
*field
,
124 struct lib_ring_buffer_ctx
*ctx
,
125 struct ltt_channel
*chan
);
128 struct perf_event
**e
; /* per-cpu array */
129 struct list_head head
;
130 struct perf_event_attr
*attr
;
133 void (*destroy
)(struct lttng_ctx_field
*field
);
137 struct lttng_ctx_field
*fields
;
138 unsigned int nr_fields
;
139 unsigned int allocated_fields
;
142 struct lttng_event_desc
{
144 void *probe_callback
;
145 const struct lttng_event_ctx
*ctx
; /* context */
146 const struct lttng_event_field
*fields
; /* event payload */
147 unsigned int nr_fields
;
148 struct module
*owner
;
151 struct lttng_probe_desc
{
152 const struct lttng_event_desc
*event_desc
;
153 unsigned int nr_events
;
154 struct list_head head
; /* chain registered probes */
158 * ltt_event structure is referred to by the tracing fast path. It must be
163 struct ltt_channel
*chan
;
164 const struct lttng_event_desc
*desc
;
166 struct lttng_ctx
*ctx
;
167 enum lttng_kernel_instrumentation instrumentation
;
177 struct list_head list
; /* Event list */
178 int metadata_dumped
:1;
181 struct ltt_channel_ops
{
182 struct channel
*(*channel_create
)(const char *name
,
183 struct ltt_channel
*ltt_chan
,
185 size_t subbuf_size
, size_t num_subbuf
,
186 unsigned int switch_timer_interval
,
187 unsigned int read_timer_interval
);
188 void (*channel_destroy
)(struct channel
*chan
);
189 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
190 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
191 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
193 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
194 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
197 * packet_avail_size returns the available size in the current
198 * packet. Note that the size returned is only a hint, since it
199 * may change due to concurrent writes.
201 size_t (*packet_avail_size
)(struct channel
*chan
);
202 wait_queue_head_t
*(*get_reader_wait_queue
)(struct ltt_channel
*chan
);
207 struct channel
*chan
; /* Channel buffers */
208 struct lttng_ctx
*ctx
;
209 /* Event ID management */
210 struct ltt_session
*session
;
211 struct file
*file
; /* File associated to channel */
212 unsigned int free_event_id
; /* Next event ID to allocate */
213 struct list_head list
; /* Channel list */
214 wait_queue_head_t notify_wait
; /* Channel addition notif. waitqueue */
215 struct ltt_channel_ops
*ops
;
216 int header_type
; /* 0: unset, 1: compact, 2: large */
217 int metadata_dumped
:1;
221 int active
; /* Is trace session active ? */
222 int been_active
; /* Has trace session been active ? */
223 struct file
*file
; /* File associated to session */
224 struct ltt_channel
*metadata
; /* Metadata channel */
225 struct list_head chan
; /* Channel list head */
226 struct list_head events
; /* Event list head */
227 struct list_head list
; /* Session list */
228 unsigned int free_chan_id
; /* Next chan ID to allocate */
229 uuid_le uuid
; /* Trace session unique ID */
230 int metadata_dumped
:1;
233 struct ltt_transport
{
235 struct module
*owner
;
236 struct list_head node
;
237 struct ltt_channel_ops ops
;
240 struct ltt_session
*ltt_session_create(void);
241 int ltt_session_start(struct ltt_session
*session
);
242 int ltt_session_stop(struct ltt_session
*session
);
243 void ltt_session_destroy(struct ltt_session
*session
);
245 struct ltt_channel
*ltt_channel_create(struct ltt_session
*session
,
246 const char *transport_name
,
248 size_t subbuf_size
, size_t num_subbuf
,
249 unsigned int switch_timer_interval
,
250 unsigned int read_timer_interval
);
251 struct ltt_channel
*ltt_global_channel_create(struct ltt_session
*session
,
252 int overwrite
, void *buf_addr
,
253 size_t subbuf_size
, size_t num_subbuf
,
254 unsigned int switch_timer_interval
,
255 unsigned int read_timer_interval
);
257 struct ltt_event
*ltt_event_create(struct ltt_channel
*chan
,
258 struct lttng_kernel_event
*event_param
,
261 void ltt_transport_register(struct ltt_transport
*transport
);
262 void ltt_transport_unregister(struct ltt_transport
*transport
);
264 int ltt_debugfs_abi_init(void);
265 void ltt_debugfs_abi_exit(void);
267 int ltt_probe_register(struct lttng_probe_desc
*desc
);
268 void ltt_probe_unregister(struct lttng_probe_desc
*desc
);
269 const struct lttng_event_desc
*ltt_event_get(const char *name
);
270 void ltt_event_put(const struct lttng_event_desc
*desc
);
271 int ltt_probes_init(void);
272 void ltt_probes_exit(void);
273 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
274 void lttng_destroy_context(struct lttng_ctx
*ctx
);
275 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
276 int lttng_add_comm_to_ctx(struct lttng_ctx
**ctx
);
277 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
278 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
280 #ifdef CONFIG_KPROBES
281 int lttng_kprobes_register(const char *name
,
282 const char *symbol_name
,
285 struct ltt_event
*event
);
286 void lttng_kprobes_unregister(struct ltt_event
*event
);
287 void lttng_kprobes_destroy_private(struct ltt_event
*event
);
290 int lttng_kprobes_register(const char *name
,
291 const char *symbol_name
,
294 struct ltt_event
*event
)
300 void lttng_kprobes_unregister(struct ltt_event
*event
)
305 void lttng_kprobes_destroy_private(struct ltt_event
*event
)
310 #ifdef CONFIG_DYNAMIC_FTRACE
311 int lttng_ftrace_register(const char *name
,
312 const char *symbol_name
,
313 struct ltt_event
*event
);
314 void lttng_ftrace_unregister(struct ltt_event
*event
);
315 void lttng_ftrace_destroy_private(struct ltt_event
*event
);
318 int lttng_ftrace_register(const char *name
,
319 const char *symbol_name
,
320 struct ltt_event
*event
)
326 void lttng_ftrace_unregister(struct ltt_event
*event
)
331 void lttng_ftrace_destroy_private(struct ltt_event
*event
)
336 extern const struct file_operations lttng_tracepoint_list_fops
;
338 #endif /* _LTT_EVENTS_H */