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"
35 #undef CONFIG_HAVE_SYSCALL_TRACEPOINTS
37 #define lttng_is_signed_type(type) (((type)(-1)) < 0)
41 struct lttng_metadata_cache
;
42 struct lib_ring_buffer_ctx
;
44 struct perf_event_attr
;
45 struct lib_ring_buffer_config
;
47 /* Type description */
49 /* Update the astract_types name table in lttng-types.c along with this enum */
59 /* Update the string_encodings name table in lttng-types.c along with this enum */
60 enum lttng_string_encodings
{
61 lttng_encode_none
= 0,
62 lttng_encode_UTF8
= 1,
63 lttng_encode_ASCII
= 2,
72 struct lttng_enum_entry
{
73 unsigned long long start
, end
; /* start and end are inclusive */
77 #define __type_integer(_type, _byte_order, _base, _encoding) \
79 .atype = atype_integer, \
82 .size = sizeof(_type) * CHAR_BIT, \
83 .alignment = lttng_alignof(_type) * CHAR_BIT, \
84 .signedness = lttng_is_signed_type(_type), \
85 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
87 .encoding = lttng_encode_##_encoding, \
91 struct lttng_integer_type {
92 unsigned int size
; /* in bits */
93 unsigned short alignment
; /* in bits */
94 unsigned int signedness
:1,
96 unsigned int base
; /* 2, 8, 10, 16, for pretty print */
97 enum lttng_string_encodings encoding
;
100 union _lttng_basic_type
{
101 struct lttng_integer_type integer
;
106 enum lttng_string_encodings encoding
;
110 struct lttng_basic_type
{
111 enum abstract_types atype
;
113 union _lttng_basic_type basic
;
118 enum abstract_types atype
;
120 union _lttng_basic_type basic
;
122 struct lttng_basic_type elem_type
;
123 unsigned int length
; /* num. elems. */
126 struct lttng_basic_type length_type
;
127 struct lttng_basic_type elem_type
;
134 struct lttng_type container_type
;
135 const struct lttng_enum_entry
*entries
;
139 /* Event field description */
141 struct lttng_event_field
{
143 struct lttng_type type
;
144 unsigned int nowrite
:1, /* do not write into trace */
145 user
:1; /* fetch from user-space */
148 union lttng_ctx_value
{
155 * We need to keep this perf counter field separately from struct
156 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
158 struct lttng_perf_counter_field
{
159 struct notifier_block nb
;
161 struct perf_event_attr
*attr
;
162 struct perf_event
**e
; /* per-cpu array */
165 struct lttng_ctx_field
{
166 struct lttng_event_field event_field
;
167 size_t (*get_size
)(size_t offset
);
168 void (*record
)(struct lttng_ctx_field
*field
,
169 struct lib_ring_buffer_ctx
*ctx
,
170 struct lttng_channel
*chan
);
171 void (*get_value
)(struct lttng_ctx_field
*field
,
172 union lttng_ctx_value
*value
);
174 struct lttng_perf_counter_field
*perf_counter
;
176 void (*destroy
)(struct lttng_ctx_field
*field
);
180 struct lttng_ctx_field
*fields
;
181 unsigned int nr_fields
;
182 unsigned int allocated_fields
;
183 size_t largest_align
; /* in bytes */
186 struct lttng_event_desc
{
187 const char *name
; /* lttng-modules name */
188 const char *kname
; /* Linux kernel name (tracepoints) */
189 void *probe_callback
;
190 const struct lttng_event_ctx
*ctx
; /* context */
191 const struct lttng_event_field
*fields
; /* event payload */
192 unsigned int nr_fields
;
193 struct module
*owner
;
196 struct lttng_probe_desc
{
197 const char *provider
;
198 const struct lttng_event_desc
**event_desc
;
199 unsigned int nr_events
;
200 struct list_head head
; /* chain registered probes */
201 struct list_head lazy_init_head
;
202 int lazy
; /* lazy registration */
205 struct lttng_krp
; /* Kretprobe handling */
207 enum lttng_event_type
{
208 LTTNG_TYPE_EVENT
= 0,
209 LTTNG_TYPE_ENABLER
= 1,
212 struct lttng_filter_bytecode_node
{
213 struct list_head node
;
214 struct lttng_enabler
*enabler
;
216 * struct lttng_kernel_filter_bytecode has var. sized array, must be
219 struct lttng_kernel_filter_bytecode bc
;
223 * Filter return value masks.
225 enum lttng_filter_ret
{
226 LTTNG_FILTER_DISCARD
= 0,
227 LTTNG_FILTER_RECORD_FLAG
= (1ULL << 0),
228 /* Other bits are kept for future use. */
231 struct lttng_bytecode_runtime
{
232 /* Associated bytecode */
233 struct lttng_filter_bytecode_node
*bc
;
234 uint64_t (*filter
)(void *filter_data
, const char *filter_stack_data
);
236 struct list_head node
; /* list of bytecode runtime in event */
240 * Objects in a linked-list of enablers, owned by an event.
242 struct lttng_enabler_ref
{
243 struct list_head node
; /* enabler ref list */
244 struct lttng_enabler
*ref
; /* backward ref */
248 * lttng_event structure is referred to by the tracing fast path. It must be
252 enum lttng_event_type evtype
; /* First field. */
254 struct lttng_channel
*chan
;
256 const struct lttng_event_desc
*desc
;
258 struct lttng_ctx
*ctx
;
259 enum lttng_kernel_instrumentation instrumentation
;
266 struct lttng_krp
*lttng_krp
;
273 struct list_head list
; /* Event list in session */
274 unsigned int metadata_dumped
:1;
276 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
277 struct list_head enablers_ref_head
;
278 struct hlist_node hlist
; /* session ht of events */
279 int registered
; /* has reg'd tracepoint probe */
280 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
281 struct list_head bytecode_runtime_head
;
282 int has_enablers_without_bytecode
;
285 enum lttng_enabler_type
{
286 LTTNG_ENABLER_WILDCARD
,
291 * Enabler field, within whatever object is enabling an event. Target of
292 * backward reference.
294 struct lttng_enabler
{
295 enum lttng_event_type evtype
; /* First field. */
297 enum lttng_enabler_type type
;
299 struct list_head node
; /* per-session list of enablers */
300 /* head list of struct lttng_ust_filter_bytecode_node */
301 struct list_head filter_bytecode_head
;
303 struct lttng_kernel_event event_param
;
304 struct lttng_channel
*chan
;
305 struct lttng_ctx
*ctx
;
306 unsigned int enabled
:1;
309 struct lttng_channel_ops
{
310 struct channel
*(*channel_create
)(const char *name
,
311 struct lttng_channel
*lttng_chan
,
313 size_t subbuf_size
, size_t num_subbuf
,
314 unsigned int switch_timer_interval
,
315 unsigned int read_timer_interval
);
316 void (*channel_destroy
)(struct channel
*chan
);
317 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
318 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
319 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
320 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
322 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
323 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
325 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
326 const void *src
, size_t len
);
327 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
329 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
331 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
332 const char __user
*src
, size_t len
);
334 * packet_avail_size returns the available size in the current
335 * packet. Note that the size returned is only a hint, since it
336 * may change due to concurrent writes.
338 size_t (*packet_avail_size
)(struct channel
*chan
);
339 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
340 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
341 int (*is_finalized
)(struct channel
*chan
);
342 int (*is_disabled
)(struct channel
*chan
);
343 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
344 struct lib_ring_buffer
*bufb
,
345 uint64_t *timestamp_begin
);
346 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
347 struct lib_ring_buffer
*bufb
,
348 uint64_t *timestamp_end
);
349 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
350 struct lib_ring_buffer
*bufb
,
351 uint64_t *events_discarded
);
352 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
353 struct lib_ring_buffer
*bufb
,
354 uint64_t *content_size
);
355 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
356 struct lib_ring_buffer
*bufb
,
357 uint64_t *packet_size
);
358 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
359 struct lib_ring_buffer
*bufb
,
360 uint64_t *stream_id
);
361 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
362 struct lib_ring_buffer
*bufb
,
366 struct lttng_transport
{
368 struct module
*owner
;
369 struct list_head node
;
370 struct lttng_channel_ops ops
;
373 struct lttng_syscall_filter
;
375 #define LTTNG_EVENT_HT_BITS 12
376 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
378 struct lttng_event_ht
{
379 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
382 struct lttng_channel
{
384 struct channel
*chan
; /* Channel buffers */
386 struct lttng_ctx
*ctx
;
387 /* Event ID management */
388 struct lttng_session
*session
;
389 struct file
*file
; /* File associated to channel */
390 unsigned int free_event_id
; /* Next event ID to allocate */
391 struct list_head list
; /* Channel list */
392 struct lttng_channel_ops
*ops
;
393 struct lttng_transport
*transport
;
394 struct lttng_event
**sc_table
; /* for syscall tracing */
395 struct lttng_event
**compat_sc_table
;
396 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
397 struct lttng_event
**compat_sc_exit_table
;
398 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
399 struct lttng_event
*sc_compat_unknown
;
400 struct lttng_event
*sc_exit_unknown
;
401 struct lttng_event
*compat_sc_exit_unknown
;
402 struct lttng_syscall_filter
*sc_filter
;
403 int header_type
; /* 0: unset, 1: compact, 2: large */
404 enum channel_type channel_type
;
405 unsigned int metadata_dumped
:1,
406 sys_enter_registered
:1,
407 sys_exit_registered
:1,
409 tstate
:1; /* Transient enable state */
412 struct lttng_metadata_stream
{
413 void *priv
; /* Ring buffer private data */
414 struct lttng_metadata_cache
*metadata_cache
;
415 unsigned int metadata_in
; /* Bytes read from the cache */
416 unsigned int metadata_out
; /* Bytes consumed from stream */
417 int finalized
; /* Has channel been finalized */
418 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
419 struct list_head list
; /* Stream list */
420 struct lttng_transport
*transport
;
426 * struct lttng_pid_tracker declared in header due to deferencing of *v
427 * in RCU_INITIALIZER(v).
429 #define LTTNG_PID_HASH_BITS 6
430 #define LTTNG_PID_TABLE_SIZE (1 << LTTNG_PID_HASH_BITS)
432 struct lttng_pid_tracker
{
433 struct hlist_head pid_hash
[LTTNG_PID_TABLE_SIZE
];
436 struct lttng_pid_hash_node
{
437 struct hlist_node hlist
;
441 struct lttng_session
{
442 int active
; /* Is trace session active ? */
443 int been_active
; /* Has trace session been active ? */
444 struct file
*file
; /* File associated to session */
445 struct list_head chan
; /* Channel list head */
446 struct list_head events
; /* Event list head */
447 struct list_head list
; /* Session list */
448 unsigned int free_chan_id
; /* Next chan ID to allocate */
449 uuid_le uuid
; /* Trace session unique ID */
450 struct lttng_metadata_cache
*metadata_cache
;
451 struct lttng_pid_tracker
*pid_tracker
;
452 unsigned int metadata_dumped
:1,
453 tstate
:1; /* Transient enable state */
454 /* List of enablers */
455 struct list_head enablers_head
;
456 /* Hash table of events */
457 struct lttng_event_ht events_ht
;
460 struct lttng_metadata_cache
{
461 char *data
; /* Metadata cache */
462 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
463 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
464 struct kref refcount
; /* Metadata cache usage */
465 struct list_head metadata_stream
; /* Metadata stream list */
466 uuid_le uuid
; /* Trace session unique ID (copy) */
469 void lttng_lock_sessions(void);
470 void lttng_unlock_sessions(void);
472 struct list_head
*lttng_get_probe_list_head(void);
474 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
475 struct lttng_kernel_event
*event_param
,
476 struct lttng_channel
*chan
);
478 int lttng_enabler_enable(struct lttng_enabler
*enabler
);
479 int lttng_enabler_disable(struct lttng_enabler
*enabler
);
480 int lttng_fix_pending_events(void);
481 int lttng_session_active(void);
483 struct lttng_session
*lttng_session_create(void);
484 int lttng_session_enable(struct lttng_session
*session
);
485 int lttng_session_disable(struct lttng_session
*session
);
486 void lttng_session_destroy(struct lttng_session
*session
);
487 void metadata_cache_destroy(struct kref
*kref
);
489 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
490 const char *transport_name
,
492 size_t subbuf_size
, size_t num_subbuf
,
493 unsigned int switch_timer_interval
,
494 unsigned int read_timer_interval
,
495 enum channel_type channel_type
);
496 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
497 int overwrite
, void *buf_addr
,
498 size_t subbuf_size
, size_t num_subbuf
,
499 unsigned int switch_timer_interval
,
500 unsigned int read_timer_interval
);
502 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
503 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
504 struct lttng_kernel_event
*event_param
,
506 const struct lttng_event_desc
*event_desc
,
507 enum lttng_kernel_instrumentation itype
);
508 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
509 struct lttng_kernel_event
*event_param
,
511 const struct lttng_event_desc
*event_desc
,
512 enum lttng_kernel_instrumentation itype
);
513 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
514 struct lttng_kernel_old_event
*old_event_param
,
516 const struct lttng_event_desc
*internal_desc
);
518 int lttng_channel_enable(struct lttng_channel
*channel
);
519 int lttng_channel_disable(struct lttng_channel
*channel
);
520 int lttng_event_enable(struct lttng_event
*event
);
521 int lttng_event_disable(struct lttng_event
*event
);
523 void lttng_transport_register(struct lttng_transport
*transport
);
524 void lttng_transport_unregister(struct lttng_transport
*transport
);
526 void synchronize_trace(void);
527 int lttng_abi_init(void);
528 int lttng_abi_compat_old_init(void);
529 void lttng_abi_exit(void);
530 void lttng_abi_compat_old_exit(void);
532 int lttng_probe_register(struct lttng_probe_desc
*desc
);
533 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
534 const struct lttng_event_desc
*lttng_event_get(const char *name
);
535 void lttng_event_put(const struct lttng_event_desc
*desc
);
536 int lttng_probes_init(void);
537 void lttng_probes_exit(void);
539 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
540 struct channel
*chan
);
542 int lttng_pid_tracker_get_node_pid(const struct lttng_pid_hash_node
*node
);
543 struct lttng_pid_tracker
*lttng_pid_tracker_create(void);
544 void lttng_pid_tracker_destroy(struct lttng_pid_tracker
*lpf
);
545 bool lttng_pid_tracker_lookup(struct lttng_pid_tracker
*lpf
, int pid
);
546 int lttng_pid_tracker_add(struct lttng_pid_tracker
*lpf
, int pid
);
547 int lttng_pid_tracker_del(struct lttng_pid_tracker
*lpf
, int pid
);
549 int lttng_session_track_pid(struct lttng_session
*session
, int pid
);
550 int lttng_session_untrack_pid(struct lttng_session
*session
, int pid
);
552 int lttng_session_list_tracker_pids(struct lttng_session
*session
);
554 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
555 int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
);
556 int lttng_syscalls_unregister(struct lttng_channel
*chan
);
557 int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
559 int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
561 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
562 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
563 int lttng_abi_syscall_list(void);
565 static inline int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
)
570 static inline int lttng_syscalls_unregister(struct lttng_channel
*chan
)
575 static inline int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
581 static inline int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
587 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
588 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
594 int lttng_abi_syscall_list(void)
600 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
601 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
602 struct lttng_kernel_filter_bytecode __user
*bytecode
);
603 void lttng_enabler_event_link_bytecode(struct lttng_event
*event
,
604 struct lttng_enabler
*enabler
);
606 extern struct lttng_ctx
*lttng_static_ctx
;
608 int lttng_context_init(void);
609 void lttng_context_exit(void);
610 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
611 void lttng_context_update(struct lttng_ctx
*ctx
);
612 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
613 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
614 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
615 struct lttng_ctx_field
*field
);
616 void lttng_destroy_context(struct lttng_ctx
*ctx
);
617 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
618 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
619 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
620 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
621 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
622 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
623 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
624 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
625 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
626 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
627 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
628 int lttng_add_perf_counter_to_ctx(uint32_t type
,
631 struct lttng_ctx
**ctx
);
634 int lttng_add_perf_counter_to_ctx(uint32_t type
,
637 struct lttng_ctx
**ctx
)
643 int lttng_logger_init(void);
644 void lttng_logger_exit(void);
646 extern int lttng_statedump_start(struct lttng_session
*session
);
648 #ifdef CONFIG_KPROBES
649 int lttng_kprobes_register(const char *name
,
650 const char *symbol_name
,
653 struct lttng_event
*event
);
654 void lttng_kprobes_unregister(struct lttng_event
*event
);
655 void lttng_kprobes_destroy_private(struct lttng_event
*event
);
658 int lttng_kprobes_register(const char *name
,
659 const char *symbol_name
,
662 struct lttng_event
*event
)
668 void lttng_kprobes_unregister(struct lttng_event
*event
)
673 void lttng_kprobes_destroy_private(struct lttng_event
*event
)
678 #ifdef CONFIG_KRETPROBES
679 int lttng_kretprobes_register(const char *name
,
680 const char *symbol_name
,
683 struct lttng_event
*event_entry
,
684 struct lttng_event
*event_exit
);
685 void lttng_kretprobes_unregister(struct lttng_event
*event
);
686 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
689 int lttng_kretprobes_register(const char *name
,
690 const char *symbol_name
,
693 struct lttng_event
*event_entry
,
694 struct lttng_event
*event_exit
)
700 void lttng_kretprobes_unregister(struct lttng_event
*event
)
705 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
710 #ifdef CONFIG_DYNAMIC_FTRACE
711 int lttng_ftrace_register(const char *name
,
712 const char *symbol_name
,
713 struct lttng_event
*event
);
714 void lttng_ftrace_unregister(struct lttng_event
*event
);
715 void lttng_ftrace_destroy_private(struct lttng_event
*event
);
718 int lttng_ftrace_register(const char *name
,
719 const char *symbol_name
,
720 struct lttng_event
*event
)
726 void lttng_ftrace_unregister(struct lttng_event
*event
)
731 void lttng_ftrace_destroy_private(struct lttng_event
*event
)
736 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
738 extern const struct file_operations lttng_tracepoint_list_fops
;
739 extern const struct file_operations lttng_syscall_list_fops
;
741 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
742 #define TRACEPOINT_HAS_DATA_ARG
745 #endif /* _LTTNG_EVENTS_H */