1 #ifndef _LTTNG_EVENTS_H
2 #define _LTTNG_EVENTS_H
7 * Holds LTTng per-session event registry.
9 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; only
14 * version 2.1 of the License.
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include <linux/version.h>
27 #include <linux/list.h>
28 #include <linux/kprobes.h>
29 #include "wrapper/uuid.h"
30 #include "lttng-abi.h"
33 #define is_signed_type(type) (((type)(-1)) < 0)
37 struct lib_ring_buffer_ctx
;
39 struct perf_event_attr
;
41 /* Type description */
43 /* Update the astract_types name table in lttng-types.c along with this enum */
53 /* Update the string_encodings name table in lttng-types.c along with this enum */
54 enum lttng_string_encodings
{
55 lttng_encode_none
= 0,
56 lttng_encode_UTF8
= 1,
57 lttng_encode_ASCII
= 2,
61 struct lttng_enum_entry
{
62 unsigned long long start
, end
; /* start and end are inclusive */
66 #define __type_integer(_type, _byte_order, _base, _encoding) \
68 .atype = atype_integer, \
71 .size = sizeof(_type) * CHAR_BIT, \
72 .alignment = lttng_alignof(_type) * CHAR_BIT, \
73 .signedness = is_signed_type(_type), \
74 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
76 .encoding = lttng_encode_##_encoding, \
80 struct lttng_integer_type {
81 unsigned int size
; /* in bits */
82 unsigned short alignment
; /* in bits */
83 unsigned int signedness
:1,
85 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
86 enum lttng_string_encodings encoding
;
89 union _lttng_basic_type
{
90 struct lttng_integer_type integer
;
95 enum lttng_string_encodings encoding
;
99 struct lttng_basic_type
{
100 enum abstract_types atype
;
102 union _lttng_basic_type basic
;
107 enum abstract_types atype
;
109 union _lttng_basic_type basic
;
111 struct lttng_basic_type elem_type
;
112 unsigned int length
; /* num. elems. */
115 struct lttng_basic_type length_type
;
116 struct lttng_basic_type elem_type
;
123 struct lttng_type container_type
;
124 const struct lttng_enum_entry
*entries
;
128 /* Event field description */
130 struct lttng_event_field
{
132 struct lttng_type type
;
136 * We need to keep this perf counter field separately from struct
137 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
139 struct lttng_perf_counter_field
{
140 struct notifier_block nb
;
142 struct perf_event_attr
*attr
;
143 struct perf_event
**e
; /* per-cpu array */
146 struct lttng_ctx_field
{
147 struct lttng_event_field event_field
;
148 size_t (*get_size
)(size_t offset
);
149 void (*record
)(struct lttng_ctx_field
*field
,
150 struct lib_ring_buffer_ctx
*ctx
,
151 struct lttng_channel
*chan
);
153 struct lttng_perf_counter_field
*perf_counter
;
155 void (*destroy
)(struct lttng_ctx_field
*field
);
159 struct lttng_ctx_field
*fields
;
160 unsigned int nr_fields
;
161 unsigned int allocated_fields
;
164 struct lttng_event_desc
{
166 void *probe_callback
;
167 const struct lttng_event_ctx
*ctx
; /* context */
168 const struct lttng_event_field
*fields
; /* event payload */
169 unsigned int nr_fields
;
170 struct module
*owner
;
173 struct lttng_probe_desc
{
174 const struct lttng_event_desc
**event_desc
;
175 unsigned int nr_events
;
176 struct list_head head
; /* chain registered probes */
179 struct lttng_krp
; /* Kretprobe handling */
182 * lttng_event structure is referred to by the tracing fast path. It must be
187 struct lttng_channel
*chan
;
189 const struct lttng_event_desc
*desc
;
191 struct lttng_ctx
*ctx
;
192 enum lttng_kernel_instrumentation instrumentation
;
199 struct lttng_krp
*lttng_krp
;
206 struct list_head list
; /* Event list */
207 unsigned int metadata_dumped
:1;
210 struct lttng_channel_ops
{
211 struct channel
*(*channel_create
)(const char *name
,
212 struct lttng_channel
*lttng_chan
,
214 size_t subbuf_size
, size_t num_subbuf
,
215 unsigned int switch_timer_interval
,
216 unsigned int read_timer_interval
);
217 void (*channel_destroy
)(struct channel
*chan
);
218 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
219 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
220 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
221 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
223 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
224 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
226 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
227 const void *src
, size_t len
);
228 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
231 * packet_avail_size returns the available size in the current
232 * packet. Note that the size returned is only a hint, since it
233 * may change due to concurrent writes.
235 size_t (*packet_avail_size
)(struct channel
*chan
);
236 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
237 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
238 int (*is_finalized
)(struct channel
*chan
);
239 int (*is_disabled
)(struct channel
*chan
);
242 struct lttng_transport
{
244 struct module
*owner
;
245 struct list_head node
;
246 struct lttng_channel_ops ops
;
249 struct lttng_channel
{
251 struct channel
*chan
; /* Channel buffers */
253 struct lttng_ctx
*ctx
;
254 /* Event ID management */
255 struct lttng_session
*session
;
256 struct file
*file
; /* File associated to channel */
257 unsigned int free_event_id
; /* Next event ID to allocate */
258 struct list_head list
; /* Channel list */
259 struct lttng_channel_ops
*ops
;
260 struct lttng_transport
*transport
;
261 struct lttng_event
**sc_table
; /* for syscall tracing */
262 struct lttng_event
**compat_sc_table
;
263 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
264 struct lttng_event
*sc_compat_unknown
;
265 struct lttng_event
*sc_exit
; /* for syscall exit */
266 int header_type
; /* 0: unset, 1: compact, 2: large */
267 unsigned int metadata_dumped
:1;
270 struct lttng_session
{
271 int active
; /* Is trace session active ? */
272 int been_active
; /* Has trace session been active ? */
273 struct file
*file
; /* File associated to session */
274 struct lttng_channel
*metadata
; /* Metadata channel */
275 struct list_head chan
; /* Channel list head */
276 struct list_head events
; /* Event list head */
277 struct list_head list
; /* Session list */
278 unsigned int free_chan_id
; /* Next chan ID to allocate */
279 uuid_le uuid
; /* Trace session unique ID */
280 unsigned int metadata_dumped
:1;
283 struct lttng_session
*lttng_session_create(void);
284 int lttng_session_enable(struct lttng_session
*session
);
285 int lttng_session_disable(struct lttng_session
*session
);
286 void lttng_session_destroy(struct lttng_session
*session
);
288 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
289 const char *transport_name
,
291 size_t subbuf_size
, size_t num_subbuf
,
292 unsigned int switch_timer_interval
,
293 unsigned int read_timer_interval
);
294 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
295 int overwrite
, void *buf_addr
,
296 size_t subbuf_size
, size_t num_subbuf
,
297 unsigned int switch_timer_interval
,
298 unsigned int read_timer_interval
);
300 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
301 struct lttng_kernel_event
*event_param
,
303 const struct lttng_event_desc
*internal_desc
);
305 int lttng_channel_enable(struct lttng_channel
*channel
);
306 int lttng_channel_disable(struct lttng_channel
*channel
);
307 int lttng_event_enable(struct lttng_event
*event
);
308 int lttng_event_disable(struct lttng_event
*event
);
310 void lttng_transport_register(struct lttng_transport
*transport
);
311 void lttng_transport_unregister(struct lttng_transport
*transport
);
313 void synchronize_trace(void);
314 int lttng_abi_init(void);
315 void lttng_abi_exit(void);
317 int lttng_probe_register(struct lttng_probe_desc
*desc
);
318 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
319 const struct lttng_event_desc
*lttng_event_get(const char *name
);
320 void lttng_event_put(const struct lttng_event_desc
*desc
);
321 int lttng_probes_init(void);
322 void lttng_probes_exit(void);
324 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
325 int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
);
326 int lttng_syscalls_unregister(struct lttng_channel
*chan
);
328 static inline int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
)
333 static inline int lttng_syscalls_unregister(struct lttng_channel
*chan
)
339 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
340 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
341 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
342 struct lttng_ctx_field
*field
);
343 void lttng_destroy_context(struct lttng_ctx
*ctx
);
344 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
345 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
346 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
347 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
348 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
349 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
350 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
351 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
352 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
353 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
354 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
355 int lttng_add_perf_counter_to_ctx(uint32_t type
,
358 struct lttng_ctx
**ctx
);
361 int lttng_add_perf_counter_to_ctx(uint32_t type
,
364 struct lttng_ctx
**ctx
)
370 extern int lttng_statedump_start(struct lttng_session
*session
);
372 #ifdef CONFIG_KPROBES
373 int lttng_kprobes_register(const char *name
,
374 const char *symbol_name
,
377 struct lttng_event
*event
);
378 void lttng_kprobes_unregister(struct lttng_event
*event
);
379 void lttng_kprobes_destroy_private(struct lttng_event
*event
);
382 int lttng_kprobes_register(const char *name
,
383 const char *symbol_name
,
386 struct lttng_event
*event
)
392 void lttng_kprobes_unregister(struct lttng_event
*event
)
397 void lttng_kprobes_destroy_private(struct lttng_event
*event
)
402 #ifdef CONFIG_KRETPROBES
403 int lttng_kretprobes_register(const char *name
,
404 const char *symbol_name
,
407 struct lttng_event
*event_entry
,
408 struct lttng_event
*event_exit
);
409 void lttng_kretprobes_unregister(struct lttng_event
*event
);
410 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
413 int lttng_kretprobes_register(const char *name
,
414 const char *symbol_name
,
417 struct lttng_event
*event_entry
,
418 struct lttng_event
*event_exit
)
424 void lttng_kretprobes_unregister(struct lttng_event
*event
)
429 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
434 #ifdef CONFIG_DYNAMIC_FTRACE
435 int lttng_ftrace_register(const char *name
,
436 const char *symbol_name
,
437 struct lttng_event
*event
);
438 void lttng_ftrace_unregister(struct lttng_event
*event
);
439 void lttng_ftrace_destroy_private(struct lttng_event
*event
);
442 int lttng_ftrace_register(const char *name
,
443 const char *symbol_name
,
444 struct lttng_event
*event
)
450 void lttng_ftrace_unregister(struct lttng_event
*event
)
455 void lttng_ftrace_destroy_private(struct lttng_event
*event
)
460 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
462 extern const struct file_operations lttng_tracepoint_list_fops
;
464 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
465 #define TRACEPOINT_HAS_DATA_ARG
468 #endif /* _LTTNG_EVENTS_H */