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"
31 #include "lttng-abi-old.h"
34 #define is_signed_type(type) (((type)(-1)) < 0)
38 struct lib_ring_buffer_ctx
;
40 struct perf_event_attr
;
42 /* Type description */
44 /* Update the astract_types name table in lttng-types.c along with this enum */
54 /* Update the string_encodings name table in lttng-types.c along with this enum */
55 enum lttng_string_encodings
{
56 lttng_encode_none
= 0,
57 lttng_encode_UTF8
= 1,
58 lttng_encode_ASCII
= 2,
62 struct lttng_enum_entry
{
63 unsigned long long start
, end
; /* start and end are inclusive */
67 #define __type_integer(_type, _byte_order, _base, _encoding) \
69 .atype = atype_integer, \
72 .size = sizeof(_type) * CHAR_BIT, \
73 .alignment = lttng_alignof(_type) * CHAR_BIT, \
74 .signedness = is_signed_type(_type), \
75 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
77 .encoding = lttng_encode_##_encoding, \
81 struct lttng_integer_type {
82 unsigned int size
; /* in bits */
83 unsigned short alignment
; /* in bits */
84 unsigned int signedness
:1,
86 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
87 enum lttng_string_encodings encoding
;
90 union _lttng_basic_type
{
91 struct lttng_integer_type integer
;
96 enum lttng_string_encodings encoding
;
100 struct lttng_basic_type
{
101 enum abstract_types atype
;
103 union _lttng_basic_type basic
;
108 enum abstract_types atype
;
110 union _lttng_basic_type basic
;
112 struct lttng_basic_type elem_type
;
113 unsigned int length
; /* num. elems. */
116 struct lttng_basic_type length_type
;
117 struct lttng_basic_type elem_type
;
124 struct lttng_type container_type
;
125 const struct lttng_enum_entry
*entries
;
129 /* Event field description */
131 struct lttng_event_field
{
133 struct lttng_type type
;
137 * We need to keep this perf counter field separately from struct
138 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
140 struct lttng_perf_counter_field
{
141 struct notifier_block nb
;
143 struct perf_event_attr
*attr
;
144 struct perf_event
**e
; /* per-cpu array */
147 struct lttng_ctx_field
{
148 struct lttng_event_field event_field
;
149 size_t (*get_size
)(size_t offset
);
150 void (*record
)(struct lttng_ctx_field
*field
,
151 struct lib_ring_buffer_ctx
*ctx
,
152 struct lttng_channel
*chan
);
154 struct lttng_perf_counter_field
*perf_counter
;
156 void (*destroy
)(struct lttng_ctx_field
*field
);
160 struct lttng_ctx_field
*fields
;
161 unsigned int nr_fields
;
162 unsigned int allocated_fields
;
165 struct lttng_event_desc
{
167 void *probe_callback
;
168 const struct lttng_event_ctx
*ctx
; /* context */
169 const struct lttng_event_field
*fields
; /* event payload */
170 unsigned int nr_fields
;
171 struct module
*owner
;
174 struct lttng_probe_desc
{
175 const struct lttng_event_desc
**event_desc
;
176 unsigned int nr_events
;
177 struct list_head head
; /* chain registered probes */
180 struct lttng_krp
; /* Kretprobe handling */
183 * lttng_event structure is referred to by the tracing fast path. It must be
188 struct lttng_channel
*chan
;
190 const struct lttng_event_desc
*desc
;
192 struct lttng_ctx
*ctx
;
193 enum lttng_kernel_instrumentation instrumentation
;
200 struct lttng_krp
*lttng_krp
;
207 struct list_head list
; /* Event list */
208 unsigned int metadata_dumped
:1;
211 struct lttng_channel_ops
{
212 struct channel
*(*channel_create
)(const char *name
,
213 struct lttng_channel
*lttng_chan
,
215 size_t subbuf_size
, size_t num_subbuf
,
216 unsigned int switch_timer_interval
,
217 unsigned int read_timer_interval
);
218 void (*channel_destroy
)(struct channel
*chan
);
219 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
220 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
221 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
222 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
224 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
225 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
227 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
228 const void *src
, size_t len
);
229 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
232 * packet_avail_size returns the available size in the current
233 * packet. Note that the size returned is only a hint, since it
234 * may change due to concurrent writes.
236 size_t (*packet_avail_size
)(struct channel
*chan
);
237 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
238 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
239 int (*is_finalized
)(struct channel
*chan
);
240 int (*is_disabled
)(struct channel
*chan
);
243 struct lttng_transport
{
245 struct module
*owner
;
246 struct list_head node
;
247 struct lttng_channel_ops ops
;
250 struct lttng_channel
{
252 struct channel
*chan
; /* Channel buffers */
254 struct lttng_ctx
*ctx
;
255 /* Event ID management */
256 struct lttng_session
*session
;
257 struct file
*file
; /* File associated to channel */
258 unsigned int free_event_id
; /* Next event ID to allocate */
259 struct list_head list
; /* Channel list */
260 struct lttng_channel_ops
*ops
;
261 struct lttng_transport
*transport
;
262 struct lttng_event
**sc_table
; /* for syscall tracing */
263 struct lttng_event
**compat_sc_table
;
264 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
265 struct lttng_event
*sc_compat_unknown
;
266 struct lttng_event
*sc_exit
; /* for syscall exit */
267 int header_type
; /* 0: unset, 1: compact, 2: large */
268 unsigned int metadata_dumped
:1;
271 struct lttng_session
{
272 int active
; /* Is trace session active ? */
273 int been_active
; /* Has trace session been active ? */
274 struct file
*file
; /* File associated to session */
275 struct lttng_channel
*metadata
; /* Metadata channel */
276 struct list_head chan
; /* Channel list head */
277 struct list_head events
; /* Event list head */
278 struct list_head list
; /* Session list */
279 unsigned int free_chan_id
; /* Next chan ID to allocate */
280 uuid_le uuid
; /* Trace session unique ID */
281 unsigned int metadata_dumped
:1;
284 struct lttng_session
*lttng_session_create(void);
285 int lttng_session_enable(struct lttng_session
*session
);
286 int lttng_session_disable(struct lttng_session
*session
);
287 void lttng_session_destroy(struct lttng_session
*session
);
289 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
290 const char *transport_name
,
292 size_t subbuf_size
, size_t num_subbuf
,
293 unsigned int switch_timer_interval
,
294 unsigned int read_timer_interval
);
295 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
296 int overwrite
, void *buf_addr
,
297 size_t subbuf_size
, size_t num_subbuf
,
298 unsigned int switch_timer_interval
,
299 unsigned int read_timer_interval
);
301 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
302 struct lttng_kernel_event
*event_param
,
304 const struct lttng_event_desc
*internal_desc
);
305 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
306 struct lttng_kernel_old_event
*old_event_param
,
308 const struct lttng_event_desc
*internal_desc
);
310 int lttng_channel_enable(struct lttng_channel
*channel
);
311 int lttng_channel_disable(struct lttng_channel
*channel
);
312 int lttng_event_enable(struct lttng_event
*event
);
313 int lttng_event_disable(struct lttng_event
*event
);
315 void lttng_transport_register(struct lttng_transport
*transport
);
316 void lttng_transport_unregister(struct lttng_transport
*transport
);
318 void synchronize_trace(void);
319 int lttng_abi_init(void);
320 int lttng_abi_compat_old_init(void);
321 void lttng_abi_exit(void);
322 void lttng_abi_compat_old_exit(void);
324 int lttng_probe_register(struct lttng_probe_desc
*desc
);
325 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
326 const struct lttng_event_desc
*lttng_event_get(const char *name
);
327 void lttng_event_put(const struct lttng_event_desc
*desc
);
328 int lttng_probes_init(void);
329 void lttng_probes_exit(void);
331 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
332 int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
);
333 int lttng_syscalls_unregister(struct lttng_channel
*chan
);
335 static inline int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
)
340 static inline int lttng_syscalls_unregister(struct lttng_channel
*chan
)
346 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
347 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
348 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
349 struct lttng_ctx_field
*field
);
350 void lttng_destroy_context(struct lttng_ctx
*ctx
);
351 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
352 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
353 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
354 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
355 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
356 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
357 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
358 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
359 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
360 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
361 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
362 int lttng_add_perf_counter_to_ctx(uint32_t type
,
365 struct lttng_ctx
**ctx
);
368 int lttng_add_perf_counter_to_ctx(uint32_t type
,
371 struct lttng_ctx
**ctx
)
377 extern int lttng_statedump_start(struct lttng_session
*session
);
379 #ifdef CONFIG_KPROBES
380 int lttng_kprobes_register(const char *name
,
381 const char *symbol_name
,
384 struct lttng_event
*event
);
385 void lttng_kprobes_unregister(struct lttng_event
*event
);
386 void lttng_kprobes_destroy_private(struct lttng_event
*event
);
389 int lttng_kprobes_register(const char *name
,
390 const char *symbol_name
,
393 struct lttng_event
*event
)
399 void lttng_kprobes_unregister(struct lttng_event
*event
)
404 void lttng_kprobes_destroy_private(struct lttng_event
*event
)
409 #ifdef CONFIG_KRETPROBES
410 int lttng_kretprobes_register(const char *name
,
411 const char *symbol_name
,
414 struct lttng_event
*event_entry
,
415 struct lttng_event
*event_exit
);
416 void lttng_kretprobes_unregister(struct lttng_event
*event
);
417 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
420 int lttng_kretprobes_register(const char *name
,
421 const char *symbol_name
,
424 struct lttng_event
*event_entry
,
425 struct lttng_event
*event_exit
)
431 void lttng_kretprobes_unregister(struct lttng_event
*event
)
436 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
441 #ifdef CONFIG_DYNAMIC_FTRACE
442 int lttng_ftrace_register(const char *name
,
443 const char *symbol_name
,
444 struct lttng_event
*event
);
445 void lttng_ftrace_unregister(struct lttng_event
*event
);
446 void lttng_ftrace_destroy_private(struct lttng_event
*event
);
449 int lttng_ftrace_register(const char *name
,
450 const char *symbol_name
,
451 struct lttng_event
*event
)
457 void lttng_ftrace_unregister(struct lttng_event
*event
)
462 void lttng_ftrace_destroy_private(struct lttng_event
*event
)
467 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
469 extern const struct file_operations lttng_tracepoint_list_fops
;
471 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
472 #define TRACEPOINT_HAS_DATA_ARG
475 #endif /* _LTTNG_EVENTS_H */