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
;
141 unsigned int nowrite
:1, /* do not write into trace */
142 user
:1; /* fetch from user-space */
145 union lttng_ctx_value
{
152 * We need to keep this perf counter field separately from struct
153 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
155 struct lttng_perf_counter_field
{
156 struct notifier_block nb
;
158 struct perf_event_attr
*attr
;
159 struct perf_event
**e
; /* per-cpu array */
162 struct lttng_ctx_field
{
163 struct lttng_event_field event_field
;
164 size_t (*get_size
)(size_t offset
);
165 void (*record
)(struct lttng_ctx_field
*field
,
166 struct lib_ring_buffer_ctx
*ctx
,
167 struct lttng_channel
*chan
);
168 void (*get_value
)(struct lttng_ctx_field
*field
,
169 union lttng_ctx_value
*value
);
171 struct lttng_perf_counter_field
*perf_counter
;
173 void (*destroy
)(struct lttng_ctx_field
*field
);
177 struct lttng_ctx_field
*fields
;
178 unsigned int nr_fields
;
179 unsigned int allocated_fields
;
180 size_t largest_align
; /* in bytes */
183 struct lttng_event_desc
{
184 const char *name
; /* lttng-modules name */
185 const char *kname
; /* Linux kernel name (tracepoints) */
186 void *probe_callback
;
187 const struct lttng_event_ctx
*ctx
; /* context */
188 const struct lttng_event_field
*fields
; /* event payload */
189 unsigned int nr_fields
;
190 struct module
*owner
;
193 struct lttng_probe_desc
{
194 const char *provider
;
195 const struct lttng_event_desc
**event_desc
;
196 unsigned int nr_events
;
197 struct list_head head
; /* chain registered probes */
198 struct list_head lazy_init_head
;
199 int lazy
; /* lazy registration */
202 struct lttng_krp
; /* Kretprobe handling */
204 enum lttng_event_type
{
205 LTTNG_TYPE_EVENT
= 0,
206 LTTNG_TYPE_ENABLER
= 1,
209 struct lttng_filter_bytecode_node
{
210 struct list_head node
;
211 struct lttng_enabler
*enabler
;
213 * struct lttng_kernel_filter_bytecode has var. sized array, must be
216 struct lttng_kernel_filter_bytecode bc
;
220 * Filter return value masks.
222 enum lttng_filter_ret
{
223 LTTNG_FILTER_DISCARD
= 0,
224 LTTNG_FILTER_RECORD_FLAG
= (1ULL << 0),
225 /* Other bits are kept for future use. */
228 struct lttng_bytecode_runtime
{
229 /* Associated bytecode */
230 struct lttng_filter_bytecode_node
*bc
;
231 uint64_t (*filter
)(void *filter_data
, const char *filter_stack_data
);
233 struct list_head node
; /* list of bytecode runtime in event */
237 * Objects in a linked-list of enablers, owned by an event.
239 struct lttng_enabler_ref
{
240 struct list_head node
; /* enabler ref list */
241 struct lttng_enabler
*ref
; /* backward ref */
245 * lttng_event structure is referred to by the tracing fast path. It must be
249 enum lttng_event_type evtype
; /* First field. */
251 struct lttng_channel
*chan
;
253 const struct lttng_event_desc
*desc
;
255 struct lttng_ctx
*ctx
;
256 enum lttng_kernel_instrumentation instrumentation
;
263 struct lttng_krp
*lttng_krp
;
270 struct list_head list
; /* Event list in session */
271 unsigned int metadata_dumped
:1;
273 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
274 struct list_head enablers_ref_head
;
275 struct hlist_node hlist
; /* session ht of events */
276 int registered
; /* has reg'd tracepoint probe */
277 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
278 struct list_head bytecode_runtime_head
;
279 int has_enablers_without_bytecode
;
282 enum lttng_enabler_type
{
283 LTTNG_ENABLER_WILDCARD
,
288 * Enabler field, within whatever object is enabling an event. Target of
289 * backward reference.
291 struct lttng_enabler
{
292 enum lttng_event_type evtype
; /* First field. */
294 enum lttng_enabler_type type
;
296 struct list_head node
; /* per-session list of enablers */
297 /* head list of struct lttng_ust_filter_bytecode_node */
298 struct list_head filter_bytecode_head
;
300 struct lttng_kernel_event event_param
;
301 struct lttng_channel
*chan
;
302 struct lttng_ctx
*ctx
;
303 unsigned int enabled
:1;
306 struct lttng_channel_ops
{
307 struct channel
*(*channel_create
)(const char *name
,
308 struct lttng_channel
*lttng_chan
,
310 size_t subbuf_size
, size_t num_subbuf
,
311 unsigned int switch_timer_interval
,
312 unsigned int read_timer_interval
);
313 void (*channel_destroy
)(struct channel
*chan
);
314 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
315 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
316 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
317 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
319 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
320 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
322 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
323 const void *src
, size_t len
);
324 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
326 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
328 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
329 const char __user
*src
, size_t len
);
331 * packet_avail_size returns the available size in the current
332 * packet. Note that the size returned is only a hint, since it
333 * may change due to concurrent writes.
335 size_t (*packet_avail_size
)(struct channel
*chan
);
336 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
337 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
338 int (*is_finalized
)(struct channel
*chan
);
339 int (*is_disabled
)(struct channel
*chan
);
340 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
341 struct lib_ring_buffer
*bufb
,
342 uint64_t *timestamp_begin
);
343 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
344 struct lib_ring_buffer
*bufb
,
345 uint64_t *timestamp_end
);
346 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
347 struct lib_ring_buffer
*bufb
,
348 uint64_t *events_discarded
);
349 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
350 struct lib_ring_buffer
*bufb
,
351 uint64_t *content_size
);
352 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
353 struct lib_ring_buffer
*bufb
,
354 uint64_t *packet_size
);
355 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
356 struct lib_ring_buffer
*bufb
,
357 uint64_t *stream_id
);
358 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
359 struct lib_ring_buffer
*bufb
,
363 struct lttng_transport
{
365 struct module
*owner
;
366 struct list_head node
;
367 struct lttng_channel_ops ops
;
370 struct lttng_syscall_filter
;
372 #define LTTNG_EVENT_HT_BITS 12
373 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
375 struct lttng_event_ht
{
376 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
379 struct lttng_channel
{
381 struct channel
*chan
; /* Channel buffers */
383 struct lttng_ctx
*ctx
;
384 /* Event ID management */
385 struct lttng_session
*session
;
386 struct file
*file
; /* File associated to channel */
387 unsigned int free_event_id
; /* Next event ID to allocate */
388 struct list_head list
; /* Channel list */
389 struct lttng_channel_ops
*ops
;
390 struct lttng_transport
*transport
;
391 struct lttng_event
**sc_table
; /* for syscall tracing */
392 struct lttng_event
**compat_sc_table
;
393 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
394 struct lttng_event
**compat_sc_exit_table
;
395 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
396 struct lttng_event
*sc_compat_unknown
;
397 struct lttng_event
*sc_exit_unknown
;
398 struct lttng_event
*compat_sc_exit_unknown
;
399 struct lttng_syscall_filter
*sc_filter
;
400 int header_type
; /* 0: unset, 1: compact, 2: large */
401 enum channel_type channel_type
;
402 unsigned int metadata_dumped
:1,
403 sys_enter_registered
:1,
404 sys_exit_registered
:1,
406 tstate
:1; /* Transient enable state */
409 struct lttng_metadata_stream
{
410 void *priv
; /* Ring buffer private data */
411 struct lttng_metadata_cache
*metadata_cache
;
412 unsigned int metadata_in
; /* Bytes read from the cache */
413 unsigned int metadata_out
; /* Bytes consumed from stream */
414 int finalized
; /* Has channel been finalized */
415 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
416 struct list_head list
; /* Stream list */
417 struct lttng_transport
*transport
;
422 * struct lttng_pid_tracker declared in header due to deferencing of *v
423 * in RCU_INITIALIZER(v).
425 #define LTTNG_PID_HASH_BITS 6
426 #define LTTNG_PID_TABLE_SIZE (1 << LTTNG_PID_HASH_BITS)
428 struct lttng_pid_tracker
{
429 struct hlist_head pid_hash
[LTTNG_PID_TABLE_SIZE
];
432 struct lttng_pid_hash_node
{
433 struct hlist_node hlist
;
437 struct lttng_session
{
438 int active
; /* Is trace session active ? */
439 int been_active
; /* Has trace session been active ? */
440 struct file
*file
; /* File associated to session */
441 struct list_head chan
; /* Channel list head */
442 struct list_head events
; /* Event list head */
443 struct list_head list
; /* Session list */
444 unsigned int free_chan_id
; /* Next chan ID to allocate */
445 uuid_le uuid
; /* Trace session unique ID */
446 struct lttng_metadata_cache
*metadata_cache
;
447 struct lttng_pid_tracker
*pid_tracker
;
448 unsigned int metadata_dumped
:1,
449 tstate
:1; /* Transient enable state */
450 /* List of enablers */
451 struct list_head enablers_head
;
452 /* Hash table of events */
453 struct lttng_event_ht events_ht
;
456 struct lttng_metadata_cache
{
457 char *data
; /* Metadata cache */
458 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
459 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
460 struct kref refcount
; /* Metadata cache usage */
461 struct list_head metadata_stream
; /* Metadata stream list */
462 uuid_le uuid
; /* Trace session unique ID (copy) */
466 void lttng_lock_sessions(void);
467 void lttng_unlock_sessions(void);
469 struct list_head
*lttng_get_probe_list_head(void);
471 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
472 struct lttng_kernel_event
*event_param
,
473 struct lttng_channel
*chan
);
475 int lttng_enabler_enable(struct lttng_enabler
*enabler
);
476 int lttng_enabler_disable(struct lttng_enabler
*enabler
);
477 int lttng_fix_pending_events(void);
478 int lttng_session_active(void);
480 struct lttng_session
*lttng_session_create(void);
481 int lttng_session_enable(struct lttng_session
*session
);
482 int lttng_session_disable(struct lttng_session
*session
);
483 void lttng_session_destroy(struct lttng_session
*session
);
484 void metadata_cache_destroy(struct kref
*kref
);
486 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
487 const char *transport_name
,
489 size_t subbuf_size
, size_t num_subbuf
,
490 unsigned int switch_timer_interval
,
491 unsigned int read_timer_interval
,
492 enum channel_type channel_type
);
493 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
494 int overwrite
, void *buf_addr
,
495 size_t subbuf_size
, size_t num_subbuf
,
496 unsigned int switch_timer_interval
,
497 unsigned int read_timer_interval
);
499 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
500 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
501 struct lttng_kernel_event
*event_param
,
503 const struct lttng_event_desc
*event_desc
,
504 enum lttng_kernel_instrumentation itype
);
505 struct lttng_event
*_lttng_event_create(struct lttng_channel
*chan
,
506 struct lttng_kernel_event
*event_param
,
508 const struct lttng_event_desc
*event_desc
,
509 enum lttng_kernel_instrumentation itype
);
510 struct lttng_event
*lttng_event_compat_old_create(struct lttng_channel
*chan
,
511 struct lttng_kernel_old_event
*old_event_param
,
513 const struct lttng_event_desc
*internal_desc
);
515 int lttng_channel_enable(struct lttng_channel
*channel
);
516 int lttng_channel_disable(struct lttng_channel
*channel
);
517 int lttng_event_enable(struct lttng_event
*event
);
518 int lttng_event_disable(struct lttng_event
*event
);
520 void lttng_transport_register(struct lttng_transport
*transport
);
521 void lttng_transport_unregister(struct lttng_transport
*transport
);
523 void synchronize_trace(void);
524 int lttng_abi_init(void);
525 int lttng_abi_compat_old_init(void);
526 void lttng_abi_exit(void);
527 void lttng_abi_compat_old_exit(void);
529 int lttng_probe_register(struct lttng_probe_desc
*desc
);
530 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
531 const struct lttng_event_desc
*lttng_event_get(const char *name
);
532 void lttng_event_put(const struct lttng_event_desc
*desc
);
533 int lttng_probes_init(void);
534 void lttng_probes_exit(void);
536 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
537 struct channel
*chan
);
539 int lttng_pid_tracker_get_node_pid(const struct lttng_pid_hash_node
*node
);
540 struct lttng_pid_tracker
*lttng_pid_tracker_create(void);
541 void lttng_pid_tracker_destroy(struct lttng_pid_tracker
*lpf
);
542 bool lttng_pid_tracker_lookup(struct lttng_pid_tracker
*lpf
, int pid
);
543 int lttng_pid_tracker_add(struct lttng_pid_tracker
*lpf
, int pid
);
544 int lttng_pid_tracker_del(struct lttng_pid_tracker
*lpf
, int pid
);
546 int lttng_session_track_pid(struct lttng_session
*session
, int pid
);
547 int lttng_session_untrack_pid(struct lttng_session
*session
, int pid
);
549 int lttng_session_list_tracker_pids(struct lttng_session
*session
);
551 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
552 int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
);
553 int lttng_syscalls_unregister(struct lttng_channel
*chan
);
554 int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
556 int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
558 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
559 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
561 static inline int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
)
566 static inline int lttng_syscalls_unregister(struct lttng_channel
*chan
)
571 static inline int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
577 static inline int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
583 static inline long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
584 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
590 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
591 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
592 struct lttng_kernel_filter_bytecode __user
*bytecode
);
593 void lttng_enabler_event_link_bytecode(struct lttng_event
*event
,
594 struct lttng_enabler
*enabler
);
596 extern struct lttng_ctx
*lttng_static_ctx
;
598 int lttng_context_init(void);
599 void lttng_context_exit(void);
600 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
601 void lttng_context_update(struct lttng_ctx
*ctx
);
602 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
603 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
604 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
605 struct lttng_ctx_field
*field
);
606 void lttng_destroy_context(struct lttng_ctx
*ctx
);
607 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
608 int lttng_add_cpu_id_to_ctx(struct lttng_ctx
**ctx
);
609 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
610 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
611 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
612 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
613 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
614 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
615 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
616 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
617 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
618 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
619 int lttng_add_perf_counter_to_ctx(uint32_t type
,
622 struct lttng_ctx
**ctx
);
625 int lttng_add_perf_counter_to_ctx(uint32_t type
,
628 struct lttng_ctx
**ctx
)
634 int lttng_logger_init(void);
635 void lttng_logger_exit(void);
637 extern int lttng_statedump_start(struct lttng_session
*session
);
639 #ifdef CONFIG_KPROBES
640 int lttng_kprobes_register(const char *name
,
641 const char *symbol_name
,
644 struct lttng_event
*event
);
645 void lttng_kprobes_unregister(struct lttng_event
*event
);
646 void lttng_kprobes_destroy_private(struct lttng_event
*event
);
649 int lttng_kprobes_register(const char *name
,
650 const char *symbol_name
,
653 struct lttng_event
*event
)
659 void lttng_kprobes_unregister(struct lttng_event
*event
)
664 void lttng_kprobes_destroy_private(struct lttng_event
*event
)
669 #ifdef CONFIG_KRETPROBES
670 int lttng_kretprobes_register(const char *name
,
671 const char *symbol_name
,
674 struct lttng_event
*event_entry
,
675 struct lttng_event
*event_exit
);
676 void lttng_kretprobes_unregister(struct lttng_event
*event
);
677 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
678 int lttng_kretprobes_event_enable_state(struct lttng_event
*event
,
682 int lttng_kretprobes_register(const char *name
,
683 const char *symbol_name
,
686 struct lttng_event
*event_entry
,
687 struct lttng_event
*event_exit
)
693 void lttng_kretprobes_unregister(struct lttng_event
*event
)
698 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
703 int lttng_kretprobes_event_enable_state(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 */