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
;
170 size_t largest_align
; /* in bytes */
173 struct lttng_event_desc
{
174 const char *name
; /* lttng-modules name */
175 const char *kname
; /* Linux kernel name (tracepoints) */
176 void *probe_callback
;
177 const struct lttng_event_ctx
*ctx
; /* context */
178 const struct lttng_event_field
*fields
; /* event payload */
179 unsigned int nr_fields
;
180 struct module
*owner
;
183 struct lttng_probe_desc
{
184 const char *provider
;
185 const struct lttng_event_desc
**event_desc
;
186 unsigned int nr_events
;
187 struct list_head head
; /* chain registered probes */
188 struct list_head lazy_init_head
;
189 int lazy
; /* lazy registration */
192 struct lttng_krp
; /* Kretprobe handling */
194 enum lttng_event_type
{
195 LTTNG_TYPE_EVENT
= 0,
196 LTTNG_TYPE_ENABLER
= 1,
200 * Objects in a linked-list of enablers, owned by an event.
202 struct lttng_enabler_ref
{
203 struct list_head node
; /* enabler ref list */
204 struct lttng_enabler
*ref
; /* backward ref */
208 * lttng_event structure is referred to by the tracing fast path. It must be
212 enum lttng_event_type evtype
; /* First field. */
214 struct lttng_channel
*chan
;
216 const struct lttng_event_desc
*desc
;
218 struct lttng_ctx
*ctx
;
219 enum lttng_kernel_instrumentation instrumentation
;
226 struct lttng_krp
*lttng_krp
;
233 struct list_head list
; /* Event list in session */
234 unsigned int metadata_dumped
:1;
236 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
237 struct list_head enablers_ref_head
;
238 struct hlist_node hlist
; /* session ht of events */
239 int registered
; /* has reg'd tracepoint probe */
242 enum lttng_enabler_type
{
243 LTTNG_ENABLER_WILDCARD
,
248 * Enabler field, within whatever object is enabling an event. Target of
249 * backward reference.
251 struct lttng_enabler
{
252 enum lttng_event_type evtype
; /* First field. */
254 enum lttng_enabler_type type
;
256 struct list_head node
; /* per-session list of enablers */
258 struct lttng_kernel_event event_param
;
259 struct lttng_channel
*chan
;
260 struct lttng_ctx
*ctx
;
261 unsigned int enabled
:1;
264 struct lttng_channel_ops
{
265 struct channel
*(*channel_create
)(const char *name
,
266 struct lttng_channel
*lttng_chan
,
268 size_t subbuf_size
, size_t num_subbuf
,
269 unsigned int switch_timer_interval
,
270 unsigned int read_timer_interval
);
271 void (*channel_destroy
)(struct channel
*chan
);
272 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
273 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
274 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
275 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
277 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
278 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
280 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
281 const void *src
, size_t len
);
282 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
284 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
286 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
287 const char __user
*src
, size_t len
);
289 * packet_avail_size returns the available size in the current
290 * packet. Note that the size returned is only a hint, since it
291 * may change due to concurrent writes.
293 size_t (*packet_avail_size
)(struct channel
*chan
);
294 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
295 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
296 int (*is_finalized
)(struct channel
*chan
);
297 int (*is_disabled
)(struct channel
*chan
);
298 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
299 struct lib_ring_buffer
*bufb
,
300 uint64_t *timestamp_begin
);
301 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
302 struct lib_ring_buffer
*bufb
,
303 uint64_t *timestamp_end
);
304 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
305 struct lib_ring_buffer
*bufb
,
306 uint64_t *events_discarded
);
307 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
308 struct lib_ring_buffer
*bufb
,
309 uint64_t *content_size
);
310 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
311 struct lib_ring_buffer
*bufb
,
312 uint64_t *packet_size
);
313 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
314 struct lib_ring_buffer
*bufb
,
315 uint64_t *stream_id
);
316 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
317 struct lib_ring_buffer
*bufb
,
321 struct lttng_transport
{
323 struct module
*owner
;
324 struct list_head node
;
325 struct lttng_channel_ops ops
;
328 struct lttng_syscall_filter
;
330 #define LTTNG_EVENT_HT_BITS 12
331 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
333 struct lttng_event_ht
{
334 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
337 struct lttng_channel
{
339 struct channel
*chan
; /* Channel buffers */
341 struct lttng_ctx
*ctx
;
342 /* Event ID management */
343 struct lttng_session
*session
;
344 struct file
*file
; /* File associated to channel */
345 unsigned int free_event_id
; /* Next event ID to allocate */
346 struct list_head list
; /* Channel list */
347 struct lttng_channel_ops
*ops
;
348 struct lttng_transport
*transport
;
349 struct lttng_event
**sc_table
; /* for syscall tracing */
350 struct lttng_event
**compat_sc_table
;
351 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
352 struct lttng_event
**compat_sc_exit_table
;
353 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
354 struct lttng_event
*sc_compat_unknown
;
355 struct lttng_event
*sc_exit_unknown
;
356 struct lttng_event
*compat_sc_exit_unknown
;
357 struct lttng_syscall_filter
*sc_filter
;
358 int header_type
; /* 0: unset, 1: compact, 2: large */
359 enum channel_type channel_type
;
360 unsigned int metadata_dumped
:1,
361 sys_enter_registered
:1,
362 sys_exit_registered
:1,
364 tstate
:1; /* Transient enable state */
367 struct lttng_metadata_stream
{
368 void *priv
; /* Ring buffer private data */
369 struct lttng_metadata_cache
*metadata_cache
;
370 unsigned int metadata_in
; /* Bytes read from the cache */
371 unsigned int metadata_out
; /* Bytes consumed from stream */
372 int finalized
; /* Has channel been finalized */
373 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
374 struct list_head list
; /* Stream list */
375 struct lttng_transport
*transport
;
381 * struct lttng_pid_tracker declared in header due to deferencing of *v
382 * in RCU_INITIALIZER(v).
384 #define LTTNG_PID_HASH_BITS 6
385 #define LTTNG_PID_TABLE_SIZE (1 << LTTNG_PID_HASH_BITS)
387 struct lttng_pid_tracker
{
388 struct hlist_head pid_hash
[LTTNG_PID_TABLE_SIZE
];
391 struct lttng_pid_hash_node
{
392 struct hlist_node hlist
;
396 struct lttng_session
{
397 int active
; /* Is trace session active ? */
398 int been_active
; /* Has trace session been active ? */
399 struct file
*file
; /* File associated to session */
400 struct list_head chan
; /* Channel list head */
401 struct list_head events
; /* Event list head */
402 struct list_head list
; /* Session list */
403 unsigned int free_chan_id
; /* Next chan ID to allocate */
404 uuid_le uuid
; /* Trace session unique ID */
405 struct lttng_metadata_cache
*metadata_cache
;
406 struct lttng_pid_tracker
*pid_tracker
;
407 unsigned int metadata_dumped
:1,
408 tstate
:1; /* Transient enable state */
409 /* List of enablers */
410 struct list_head enablers_head
;
411 /* Hash table of events */
412 struct lttng_event_ht events_ht
;
415 struct lttng_metadata_cache
{
416 char *data
; /* Metadata cache */
417 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
418 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
419 struct kref refcount
; /* Metadata cache usage */
420 struct list_head metadata_stream
; /* Metadata stream list */
421 uuid_le uuid
; /* Trace session unique ID (copy) */
424 void lttng_lock_sessions(void);
425 void lttng_unlock_sessions(void);
427 struct list_head
*lttng_get_probe_list_head(void);
429 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
430 struct lttng_kernel_event
*event_param
,
431 struct lttng_channel
*chan
);
433 int lttng_enabler_enable(struct lttng_enabler
*enabler
);
434 int lttng_enabler_disable(struct lttng_enabler
*enabler
);
435 int lttng_fix_pending_events(void);
436 int lttng_session_active(void);
438 struct lttng_session
*lttng_session_create(void);
439 int lttng_session_enable(struct lttng_session
*session
);
440 int lttng_session_disable(struct lttng_session
*session
);
441 void lttng_session_destroy(struct lttng_session
*session
);
442 void metadata_cache_destroy(struct kref
*kref
);
444 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
445 const char *transport_name
,
447 size_t subbuf_size
, size_t num_subbuf
,
448 unsigned int switch_timer_interval
,
449 unsigned int read_timer_interval
,
450 enum channel_type channel_type
);
451 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
452 int overwrite
, void *buf_addr
,
453 size_t subbuf_size
, size_t num_subbuf
,
454 unsigned int switch_timer_interval
,
455 unsigned int read_timer_interval
);
457 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
458 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
459 struct lttng_kernel_event
*event_param
,
461 const struct lttng_event_desc
*event_desc
,
462 enum lttng_kernel_instrumentation itype
);
463 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
464 struct lttng_kernel_old_event
*old_event_param
,
466 const struct lttng_event_desc
*internal_desc
);
468 int lttng_channel_enable(struct lttng_channel
*channel
);
469 int lttng_channel_disable(struct lttng_channel
*channel
);
470 int lttng_event_enable(struct lttng_event
*event
);
471 int lttng_event_disable(struct lttng_event
*event
);
473 void lttng_transport_register(struct lttng_transport
*transport
);
474 void lttng_transport_unregister(struct lttng_transport
*transport
);
476 void synchronize_trace(void);
477 int lttng_abi_init(void);
478 int lttng_abi_compat_old_init(void);
479 void lttng_abi_exit(void);
480 void lttng_abi_compat_old_exit(void);
482 int lttng_probe_register(struct lttng_probe_desc
*desc
);
483 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
484 const struct lttng_event_desc
*lttng_event_get(const char *name
);
485 void lttng_event_put(const struct lttng_event_desc
*desc
);
486 int lttng_probes_init(void);
487 void lttng_probes_exit(void);
489 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
490 struct channel
*chan
);
492 int lttng_pid_tracker_get_node_pid(const struct lttng_pid_hash_node
*node
);
493 struct lttng_pid_tracker
*lttng_pid_tracker_create(void);
494 void lttng_pid_tracker_destroy(struct lttng_pid_tracker
*lpf
);
495 bool lttng_pid_tracker_lookup(struct lttng_pid_tracker
*lpf
, int pid
);
496 int lttng_pid_tracker_add(struct lttng_pid_tracker
*lpf
, int pid
);
497 int lttng_pid_tracker_del(struct lttng_pid_tracker
*lpf
, int pid
);
499 int lttng_session_track_pid(struct lttng_session
*session
, int pid
);
500 int lttng_session_untrack_pid(struct lttng_session
*session
, int pid
);
502 int lttng_session_list_tracker_pids(struct lttng_session
*session
);
504 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
505 int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
);
506 int lttng_syscalls_unregister(struct lttng_channel
*chan
);
507 int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
509 int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
511 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
512 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
513 int lttng_abi_syscall_list(void);
515 static inline int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
)
520 static inline int lttng_syscalls_unregister(struct lttng_channel
*chan
)
526 int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
533 int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
540 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
541 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
547 int lttng_abi_syscall_list(void)
553 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
554 void lttng_context_update(struct lttng_ctx
*ctx
);
555 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
556 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
557 struct lttng_ctx_field
*field
);
558 void lttng_destroy_context(struct lttng_ctx
*ctx
);
559 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
560 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
561 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
562 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
563 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
564 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
565 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
566 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
567 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
568 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
569 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
570 int lttng_add_perf_counter_to_ctx(uint32_t type
,
573 struct lttng_ctx
**ctx
);
576 int lttng_add_perf_counter_to_ctx(uint32_t type
,
579 struct lttng_ctx
**ctx
)
585 int lttng_logger_init(void);
586 void lttng_logger_exit(void);
588 extern int lttng_statedump_start(struct lttng_session
*session
);
590 #ifdef CONFIG_KPROBES
591 int lttng_kprobes_register(const char *name
,
592 const char *symbol_name
,
595 struct lttng_event
*event
);
596 void lttng_kprobes_unregister(struct lttng_event
*event
);
597 void lttng_kprobes_destroy_private(struct lttng_event
*event
);
600 int lttng_kprobes_register(const char *name
,
601 const char *symbol_name
,
604 struct lttng_event
*event
)
610 void lttng_kprobes_unregister(struct lttng_event
*event
)
615 void lttng_kprobes_destroy_private(struct lttng_event
*event
)
620 #ifdef CONFIG_KRETPROBES
621 int lttng_kretprobes_register(const char *name
,
622 const char *symbol_name
,
625 struct lttng_event
*event_entry
,
626 struct lttng_event
*event_exit
);
627 void lttng_kretprobes_unregister(struct lttng_event
*event
);
628 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
631 int lttng_kretprobes_register(const char *name
,
632 const char *symbol_name
,
635 struct lttng_event
*event_entry
,
636 struct lttng_event
*event_exit
)
642 void lttng_kretprobes_unregister(struct lttng_event
*event
)
647 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
652 #ifdef CONFIG_DYNAMIC_FTRACE
653 int lttng_ftrace_register(const char *name
,
654 const char *symbol_name
,
655 struct lttng_event
*event
);
656 void lttng_ftrace_unregister(struct lttng_event
*event
);
657 void lttng_ftrace_destroy_private(struct lttng_event
*event
);
660 int lttng_ftrace_register(const char *name
,
661 const char *symbol_name
,
662 struct lttng_event
*event
)
668 void lttng_ftrace_unregister(struct lttng_event
*event
)
673 void lttng_ftrace_destroy_private(struct lttng_event
*event
)
678 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
680 extern const struct file_operations lttng_tracepoint_list_fops
;
681 extern const struct file_operations lttng_syscall_list_fops
;
683 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
684 #define TRACEPOINT_HAS_DATA_ARG
687 #endif /* _LTTNG_EVENTS_H */