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 <linux/kref.h>
30 #include "wrapper/uuid.h"
31 #include "lttng-abi.h"
32 #include "lttng-abi-old.h"
34 #define lttng_is_signed_type(type) (((type)(-1)) < 0)
38 struct lttng_metadata_cache
;
39 struct lib_ring_buffer_ctx
;
41 struct perf_event_attr
;
42 struct lib_ring_buffer_config
;
44 /* Type description */
46 /* Update the astract_types name table in lttng-types.c along with this enum */
56 /* Update the string_encodings name table in lttng-types.c along with this enum */
57 enum lttng_string_encodings
{
58 lttng_encode_none
= 0,
59 lttng_encode_UTF8
= 1,
60 lttng_encode_ASCII
= 2,
69 struct lttng_enum_entry
{
70 unsigned long long start
, end
; /* start and end are inclusive */
74 #define __type_integer(_type, _byte_order, _base, _encoding) \
76 .atype = atype_integer, \
79 .size = sizeof(_type) * CHAR_BIT, \
80 .alignment = lttng_alignof(_type) * CHAR_BIT, \
81 .signedness = lttng_is_signed_type(_type), \
82 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
84 .encoding = lttng_encode_##_encoding, \
88 struct lttng_integer_type {
89 unsigned int size
; /* in bits */
90 unsigned short alignment
; /* in bits */
91 unsigned int signedness
:1,
93 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
94 enum lttng_string_encodings encoding
;
97 union _lttng_basic_type
{
98 struct lttng_integer_type integer
;
103 enum lttng_string_encodings encoding
;
107 struct lttng_basic_type
{
108 enum abstract_types atype
;
110 union _lttng_basic_type basic
;
115 enum abstract_types atype
;
117 union _lttng_basic_type basic
;
119 struct lttng_basic_type elem_type
;
120 unsigned int length
; /* num. elems. */
123 struct lttng_basic_type length_type
;
124 struct lttng_basic_type elem_type
;
131 struct lttng_type container_type
;
132 const struct lttng_enum_entry
*entries
;
136 /* Event field description */
138 struct lttng_event_field
{
140 struct lttng_type type
;
144 * We need to keep this perf counter field separately from struct
145 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
147 struct lttng_perf_counter_field
{
148 struct notifier_block nb
;
150 struct perf_event_attr
*attr
;
151 struct perf_event
**e
; /* per-cpu array */
154 struct lttng_ctx_field
{
155 struct lttng_event_field event_field
;
156 size_t (*get_size
)(size_t offset
);
157 void (*record
)(struct lttng_ctx_field
*field
,
158 struct lib_ring_buffer_ctx
*ctx
,
159 struct lttng_channel
*chan
);
161 struct lttng_perf_counter_field
*perf_counter
;
163 void (*destroy
)(struct lttng_ctx_field
*field
);
167 struct lttng_ctx_field
*fields
;
168 unsigned int nr_fields
;
169 unsigned int allocated_fields
;
172 struct lttng_event_desc
{
173 const char *name
; /* lttng-modules name */
174 const char *kname
; /* Linux kernel name (tracepoints) */
175 void *probe_callback
;
176 const struct lttng_event_ctx
*ctx
; /* context */
177 const struct lttng_event_field
*fields
; /* event payload */
178 unsigned int nr_fields
;
179 struct module
*owner
;
182 struct lttng_probe_desc
{
183 const struct lttng_event_desc
**event_desc
;
184 unsigned int nr_events
;
185 struct list_head head
; /* chain registered probes */
188 struct lttng_krp
; /* Kretprobe handling */
191 * lttng_event structure is referred to by the tracing fast path. It must be
196 struct lttng_channel
*chan
;
198 const struct lttng_event_desc
*desc
;
200 struct lttng_ctx
*ctx
;
201 enum lttng_kernel_instrumentation instrumentation
;
208 struct lttng_krp
*lttng_krp
;
215 struct list_head list
; /* Event list */
216 unsigned int metadata_dumped
:1;
219 struct lttng_channel_ops
{
220 struct channel
*(*channel_create
)(const char *name
,
221 struct lttng_channel
*lttng_chan
,
223 size_t subbuf_size
, size_t num_subbuf
,
224 unsigned int switch_timer_interval
,
225 unsigned int read_timer_interval
);
226 void (*channel_destroy
)(struct channel
*chan
);
227 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
228 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
229 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
230 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
232 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
233 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
235 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
236 const void *src
, size_t len
);
237 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
239 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
241 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
242 const char __user
*src
, size_t len
);
244 * packet_avail_size returns the available size in the current
245 * packet. Note that the size returned is only a hint, since it
246 * may change due to concurrent writes.
248 size_t (*packet_avail_size
)(struct channel
*chan
);
249 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
250 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
251 int (*is_finalized
)(struct channel
*chan
);
252 int (*is_disabled
)(struct channel
*chan
);
253 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
254 struct lib_ring_buffer
*bufb
,
255 uint64_t *timestamp_begin
);
256 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
257 struct lib_ring_buffer
*bufb
,
258 uint64_t *timestamp_end
);
259 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
260 struct lib_ring_buffer
*bufb
,
261 uint64_t *events_discarded
);
262 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
263 struct lib_ring_buffer
*bufb
,
264 uint64_t *content_size
);
265 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
266 struct lib_ring_buffer
*bufb
,
267 uint64_t *packet_size
);
268 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
269 struct lib_ring_buffer
*bufb
,
270 uint64_t *stream_id
);
271 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
272 struct lib_ring_buffer
*bufb
,
276 struct lttng_transport
{
278 struct module
*owner
;
279 struct list_head node
;
280 struct lttng_channel_ops ops
;
283 struct lttng_channel
{
285 struct channel
*chan
; /* Channel buffers */
287 struct lttng_ctx
*ctx
;
288 /* Event ID management */
289 struct lttng_session
*session
;
290 struct file
*file
; /* File associated to channel */
291 unsigned int free_event_id
; /* Next event ID to allocate */
292 struct list_head list
; /* Channel list */
293 struct lttng_channel_ops
*ops
;
294 struct lttng_transport
*transport
;
295 struct lttng_event
**sc_table
; /* for syscall tracing */
296 struct lttng_event
**compat_sc_table
;
297 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
298 struct lttng_event
*sc_compat_unknown
;
299 struct lttng_event
*sc_exit
; /* for syscall exit */
300 int header_type
; /* 0: unset, 1: compact, 2: large */
301 enum channel_type channel_type
;
302 unsigned int metadata_dumped
:1;
305 struct lttng_metadata_stream
{
306 void *priv
; /* Ring buffer private data */
307 struct lttng_metadata_cache
*metadata_cache
;
308 unsigned int metadata_in
; /* Bytes read from the cache */
309 unsigned int metadata_out
; /* Bytes consumed from stream */
310 int finalized
; /* Has channel been finalized */
311 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
312 struct list_head list
; /* Stream list */
313 struct lttng_transport
*transport
;
316 struct lttng_session
{
317 int active
; /* Is trace session active ? */
318 int been_active
; /* Has trace session been active ? */
319 struct file
*file
; /* File associated to session */
320 struct list_head chan
; /* Channel list head */
321 struct list_head events
; /* Event list head */
322 struct list_head list
; /* Session list */
323 unsigned int free_chan_id
; /* Next chan ID to allocate */
324 uuid_le uuid
; /* Trace session unique ID */
325 struct lttng_metadata_cache
*metadata_cache
;
326 unsigned int metadata_dumped
:1;
329 struct lttng_metadata_cache
{
330 char *data
; /* Metadata cache */
331 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
332 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
333 struct kref refcount
; /* Metadata cache usage */
334 struct list_head metadata_stream
; /* Metadata stream list */
337 struct lttng_session
*lttng_session_create(void);
338 int lttng_session_enable(struct lttng_session
*session
);
339 int lttng_session_disable(struct lttng_session
*session
);
340 void lttng_session_destroy(struct lttng_session
*session
);
341 void metadata_cache_destroy(struct kref
*kref
);
343 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
344 const char *transport_name
,
346 size_t subbuf_size
, size_t num_subbuf
,
347 unsigned int switch_timer_interval
,
348 unsigned int read_timer_interval
,
349 enum channel_type channel_type
);
350 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
351 int overwrite
, void *buf_addr
,
352 size_t subbuf_size
, size_t num_subbuf
,
353 unsigned int switch_timer_interval
,
354 unsigned int read_timer_interval
);
356 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
357 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
358 struct lttng_kernel_event
*event_param
,
360 const struct lttng_event_desc
*internal_desc
);
361 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
362 struct lttng_kernel_old_event
*old_event_param
,
364 const struct lttng_event_desc
*internal_desc
);
366 int lttng_channel_enable(struct lttng_channel
*channel
);
367 int lttng_channel_disable(struct lttng_channel
*channel
);
368 int lttng_event_enable(struct lttng_event
*event
);
369 int lttng_event_disable(struct lttng_event
*event
);
371 void lttng_transport_register(struct lttng_transport
*transport
);
372 void lttng_transport_unregister(struct lttng_transport
*transport
);
374 void synchronize_trace(void);
375 int lttng_abi_init(void);
376 int lttng_abi_compat_old_init(void);
377 void lttng_abi_exit(void);
378 void lttng_abi_compat_old_exit(void);
380 int lttng_probe_register(struct lttng_probe_desc
*desc
);
381 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
382 const struct lttng_event_desc
*lttng_event_get(const char *name
);
383 void lttng_event_put(const struct lttng_event_desc
*desc
);
384 int lttng_probes_init(void);
385 void lttng_probes_exit(void);
387 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
388 struct channel
*chan
);
390 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
391 int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
);
392 int lttng_syscalls_unregister(struct lttng_channel
*chan
);
394 static inline int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
)
399 static inline int lttng_syscalls_unregister(struct lttng_channel
*chan
)
405 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
406 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
407 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
408 struct lttng_ctx_field
*field
);
409 void lttng_destroy_context(struct lttng_ctx
*ctx
);
410 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
411 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
412 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
413 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
414 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
415 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
416 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
417 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
418 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
419 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
420 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
421 int lttng_add_perf_counter_to_ctx(uint32_t type
,
424 struct lttng_ctx
**ctx
);
427 int lttng_add_perf_counter_to_ctx(uint32_t type
,
430 struct lttng_ctx
**ctx
)
436 int lttng_logger_init(void);
437 void lttng_logger_exit(void);
439 extern int lttng_statedump_start(struct lttng_session
*session
);
441 #ifdef CONFIG_KPROBES
442 int lttng_kprobes_register(const char *name
,
443 const char *symbol_name
,
446 struct lttng_event
*event
);
447 void lttng_kprobes_unregister(struct lttng_event
*event
);
448 void lttng_kprobes_destroy_private(struct lttng_event
*event
);
451 int lttng_kprobes_register(const char *name
,
452 const char *symbol_name
,
455 struct lttng_event
*event
)
461 void lttng_kprobes_unregister(struct lttng_event
*event
)
466 void lttng_kprobes_destroy_private(struct lttng_event
*event
)
471 #ifdef CONFIG_KRETPROBES
472 int lttng_kretprobes_register(const char *name
,
473 const char *symbol_name
,
476 struct lttng_event
*event_entry
,
477 struct lttng_event
*event_exit
);
478 void lttng_kretprobes_unregister(struct lttng_event
*event
);
479 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
482 int lttng_kretprobes_register(const char *name
,
483 const char *symbol_name
,
486 struct lttng_event
*event_entry
,
487 struct lttng_event
*event_exit
)
493 void lttng_kretprobes_unregister(struct lttng_event
*event
)
498 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
503 #ifdef CONFIG_DYNAMIC_FTRACE
504 int lttng_ftrace_register(const char *name
,
505 const char *symbol_name
,
506 struct lttng_event
*event
);
507 void lttng_ftrace_unregister(struct lttng_event
*event
);
508 void lttng_ftrace_destroy_private(struct lttng_event
*event
);
511 int lttng_ftrace_register(const char *name
,
512 const char *symbol_name
,
513 struct lttng_event
*event
)
519 void lttng_ftrace_unregister(struct lttng_event
*event
)
524 void lttng_ftrace_destroy_private(struct lttng_event
*event
)
529 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
531 extern const struct file_operations lttng_tracepoint_list_fops
;
533 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
534 #define TRACEPOINT_HAS_DATA_ARG
537 #endif /* _LTTNG_EVENTS_H */