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
;
143 union lttng_ctx_value
{
150 * We need to keep this perf counter field separately from struct
151 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
153 struct lttng_perf_counter_field
{
154 struct notifier_block nb
;
156 struct perf_event_attr
*attr
;
157 struct perf_event
**e
; /* per-cpu array */
160 struct lttng_ctx_field
{
161 struct lttng_event_field event_field
;
162 size_t (*get_size
)(size_t offset
);
163 void (*record
)(struct lttng_ctx_field
*field
,
164 struct lib_ring_buffer_ctx
*ctx
,
165 struct lttng_channel
*chan
);
166 void (*get_value
)(struct lttng_ctx_field
*field
,
167 union lttng_ctx_value
*value
);
169 struct lttng_perf_counter_field
*perf_counter
;
171 void (*destroy
)(struct lttng_ctx_field
*field
);
175 struct lttng_ctx_field
*fields
;
176 unsigned int nr_fields
;
177 unsigned int allocated_fields
;
178 size_t largest_align
; /* in bytes */
181 struct lttng_event_desc
{
182 const char *name
; /* lttng-modules name */
183 const char *kname
; /* Linux kernel name (tracepoints) */
184 void *probe_callback
;
185 const struct lttng_event_ctx
*ctx
; /* context */
186 const struct lttng_event_field
*fields
; /* event payload */
187 unsigned int nr_fields
;
188 struct module
*owner
;
191 struct lttng_probe_desc
{
192 const char *provider
;
193 const struct lttng_event_desc
**event_desc
;
194 unsigned int nr_events
;
195 struct list_head head
; /* chain registered probes */
196 struct list_head lazy_init_head
;
197 int lazy
; /* lazy registration */
200 struct lttng_krp
; /* Kretprobe handling */
202 enum lttng_event_type
{
203 LTTNG_TYPE_EVENT
= 0,
204 LTTNG_TYPE_ENABLER
= 1,
207 struct lttng_filter_bytecode_node
{
208 struct list_head node
;
209 struct lttng_enabler
*enabler
;
211 * struct lttng_kernel_filter_bytecode has var. sized array, must be
214 struct lttng_kernel_filter_bytecode bc
;
218 * Filter return value masks.
220 enum lttng_filter_ret
{
221 LTTNG_FILTER_DISCARD
= 0,
222 LTTNG_FILTER_RECORD_FLAG
= (1ULL << 0),
223 /* Other bits are kept for future use. */
226 struct lttng_bytecode_runtime
{
227 /* Associated bytecode */
228 struct lttng_filter_bytecode_node
*bc
;
229 uint64_t (*filter
)(void *filter_data
, const char *filter_stack_data
);
231 struct list_head node
; /* list of bytecode runtime in event */
235 * Objects in a linked-list of enablers, owned by an event.
237 struct lttng_enabler_ref
{
238 struct list_head node
; /* enabler ref list */
239 struct lttng_enabler
*ref
; /* backward ref */
243 * lttng_event structure is referred to by the tracing fast path. It must be
247 enum lttng_event_type evtype
; /* First field. */
249 struct lttng_channel
*chan
;
251 const struct lttng_event_desc
*desc
;
253 struct lttng_ctx
*ctx
;
254 enum lttng_kernel_instrumentation instrumentation
;
261 struct lttng_krp
*lttng_krp
;
268 struct list_head list
; /* Event list in session */
269 unsigned int metadata_dumped
:1;
271 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
272 struct list_head enablers_ref_head
;
273 struct hlist_node hlist
; /* session ht of events */
274 int registered
; /* has reg'd tracepoint probe */
275 /* list of struct lttng_bytecode_runtime, sorted by seqnum */
276 struct list_head bytecode_runtime_head
;
277 int has_enablers_without_bytecode
;
280 enum lttng_enabler_type
{
281 LTTNG_ENABLER_WILDCARD
,
286 * Enabler field, within whatever object is enabling an event. Target of
287 * backward reference.
289 struct lttng_enabler
{
290 enum lttng_event_type evtype
; /* First field. */
292 enum lttng_enabler_type type
;
294 struct list_head node
; /* per-session list of enablers */
295 /* head list of struct lttng_ust_filter_bytecode_node */
296 struct list_head filter_bytecode_head
;
298 struct lttng_kernel_event event_param
;
299 struct lttng_channel
*chan
;
300 struct lttng_ctx
*ctx
;
301 unsigned int enabled
:1;
304 struct lttng_channel_ops
{
305 struct channel
*(*channel_create
)(const char *name
,
306 struct lttng_channel
*lttng_chan
,
308 size_t subbuf_size
, size_t num_subbuf
,
309 unsigned int switch_timer_interval
,
310 unsigned int read_timer_interval
);
311 void (*channel_destroy
)(struct channel
*chan
);
312 struct lib_ring_buffer
*(*buffer_read_open
)(struct channel
*chan
);
313 int (*buffer_has_read_closed_stream
)(struct channel
*chan
);
314 void (*buffer_read_close
)(struct lib_ring_buffer
*buf
);
315 int (*event_reserve
)(struct lib_ring_buffer_ctx
*ctx
,
317 void (*event_commit
)(struct lib_ring_buffer_ctx
*ctx
);
318 void (*event_write
)(struct lib_ring_buffer_ctx
*ctx
, const void *src
,
320 void (*event_write_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
321 const void *src
, size_t len
);
322 void (*event_memset
)(struct lib_ring_buffer_ctx
*ctx
,
324 void (*event_strcpy
)(struct lib_ring_buffer_ctx
*ctx
, const char *src
,
326 void (*event_strcpy_from_user
)(struct lib_ring_buffer_ctx
*ctx
,
327 const char __user
*src
, size_t len
);
329 * packet_avail_size returns the available size in the current
330 * packet. Note that the size returned is only a hint, since it
331 * may change due to concurrent writes.
333 size_t (*packet_avail_size
)(struct channel
*chan
);
334 wait_queue_head_t
*(*get_writer_buf_wait_queue
)(struct channel
*chan
, int cpu
);
335 wait_queue_head_t
*(*get_hp_wait_queue
)(struct channel
*chan
);
336 int (*is_finalized
)(struct channel
*chan
);
337 int (*is_disabled
)(struct channel
*chan
);
338 int (*timestamp_begin
) (const struct lib_ring_buffer_config
*config
,
339 struct lib_ring_buffer
*bufb
,
340 uint64_t *timestamp_begin
);
341 int (*timestamp_end
) (const struct lib_ring_buffer_config
*config
,
342 struct lib_ring_buffer
*bufb
,
343 uint64_t *timestamp_end
);
344 int (*events_discarded
) (const struct lib_ring_buffer_config
*config
,
345 struct lib_ring_buffer
*bufb
,
346 uint64_t *events_discarded
);
347 int (*content_size
) (const struct lib_ring_buffer_config
*config
,
348 struct lib_ring_buffer
*bufb
,
349 uint64_t *content_size
);
350 int (*packet_size
) (const struct lib_ring_buffer_config
*config
,
351 struct lib_ring_buffer
*bufb
,
352 uint64_t *packet_size
);
353 int (*stream_id
) (const struct lib_ring_buffer_config
*config
,
354 struct lib_ring_buffer
*bufb
,
355 uint64_t *stream_id
);
356 int (*current_timestamp
) (const struct lib_ring_buffer_config
*config
,
357 struct lib_ring_buffer
*bufb
,
361 struct lttng_transport
{
363 struct module
*owner
;
364 struct list_head node
;
365 struct lttng_channel_ops ops
;
368 struct lttng_syscall_filter
;
370 #define LTTNG_EVENT_HT_BITS 12
371 #define LTTNG_EVENT_HT_SIZE (1U << LTTNG_EVENT_HT_BITS)
373 struct lttng_event_ht
{
374 struct hlist_head table
[LTTNG_EVENT_HT_SIZE
];
377 struct lttng_channel
{
379 struct channel
*chan
; /* Channel buffers */
381 struct lttng_ctx
*ctx
;
382 /* Event ID management */
383 struct lttng_session
*session
;
384 struct file
*file
; /* File associated to channel */
385 unsigned int free_event_id
; /* Next event ID to allocate */
386 struct list_head list
; /* Channel list */
387 struct lttng_channel_ops
*ops
;
388 struct lttng_transport
*transport
;
389 struct lttng_event
**sc_table
; /* for syscall tracing */
390 struct lttng_event
**compat_sc_table
;
391 struct lttng_event
**sc_exit_table
; /* for syscall exit tracing */
392 struct lttng_event
**compat_sc_exit_table
;
393 struct lttng_event
*sc_unknown
; /* for unknown syscalls */
394 struct lttng_event
*sc_compat_unknown
;
395 struct lttng_event
*sc_exit_unknown
;
396 struct lttng_event
*compat_sc_exit_unknown
;
397 struct lttng_syscall_filter
*sc_filter
;
398 int header_type
; /* 0: unset, 1: compact, 2: large */
399 enum channel_type channel_type
;
400 unsigned int metadata_dumped
:1,
401 sys_enter_registered
:1,
402 sys_exit_registered
:1,
404 tstate
:1; /* Transient enable state */
407 struct lttng_metadata_stream
{
408 void *priv
; /* Ring buffer private data */
409 struct lttng_metadata_cache
*metadata_cache
;
410 unsigned int metadata_in
; /* Bytes read from the cache */
411 unsigned int metadata_out
; /* Bytes consumed from stream */
412 int finalized
; /* Has channel been finalized */
413 wait_queue_head_t read_wait
; /* Reader buffer-level wait queue */
414 struct list_head list
; /* Stream list */
415 struct lttng_transport
*transport
;
421 * struct lttng_pid_tracker declared in header due to deferencing of *v
422 * in RCU_INITIALIZER(v).
424 #define LTTNG_PID_HASH_BITS 6
425 #define LTTNG_PID_TABLE_SIZE (1 << LTTNG_PID_HASH_BITS)
427 struct lttng_pid_tracker
{
428 struct hlist_head pid_hash
[LTTNG_PID_TABLE_SIZE
];
431 struct lttng_pid_hash_node
{
432 struct hlist_node hlist
;
436 struct lttng_session
{
437 int active
; /* Is trace session active ? */
438 int been_active
; /* Has trace session been active ? */
439 struct file
*file
; /* File associated to session */
440 struct list_head chan
; /* Channel list head */
441 struct list_head events
; /* Event list head */
442 struct list_head list
; /* Session list */
443 unsigned int free_chan_id
; /* Next chan ID to allocate */
444 uuid_le uuid
; /* Trace session unique ID */
445 struct lttng_metadata_cache
*metadata_cache
;
446 struct lttng_pid_tracker
*pid_tracker
;
447 unsigned int metadata_dumped
:1,
448 tstate
:1; /* Transient enable state */
449 /* List of enablers */
450 struct list_head enablers_head
;
451 /* Hash table of events */
452 struct lttng_event_ht events_ht
;
455 struct lttng_metadata_cache
{
456 char *data
; /* Metadata cache */
457 unsigned int cache_alloc
; /* Metadata allocated size (bytes) */
458 unsigned int metadata_written
; /* Number of bytes written in metadata cache */
459 struct kref refcount
; /* Metadata cache usage */
460 struct list_head metadata_stream
; /* Metadata stream list */
461 uuid_le uuid
; /* Trace session unique ID (copy) */
464 void lttng_lock_sessions(void);
465 void lttng_unlock_sessions(void);
467 struct list_head
*lttng_get_probe_list_head(void);
469 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
470 struct lttng_kernel_event
*event_param
,
471 struct lttng_channel
*chan
);
473 int lttng_enabler_enable(struct lttng_enabler
*enabler
);
474 int lttng_enabler_disable(struct lttng_enabler
*enabler
);
475 int lttng_fix_pending_events(void);
476 int lttng_session_active(void);
478 struct lttng_session
*lttng_session_create(void);
479 int lttng_session_enable(struct lttng_session
*session
);
480 int lttng_session_disable(struct lttng_session
*session
);
481 void lttng_session_destroy(struct lttng_session
*session
);
482 void metadata_cache_destroy(struct kref
*kref
);
484 struct lttng_channel
*lttng_channel_create(struct lttng_session
*session
,
485 const char *transport_name
,
487 size_t subbuf_size
, size_t num_subbuf
,
488 unsigned int switch_timer_interval
,
489 unsigned int read_timer_interval
,
490 enum channel_type channel_type
);
491 struct lttng_channel
*lttng_global_channel_create(struct lttng_session
*session
,
492 int overwrite
, void *buf_addr
,
493 size_t subbuf_size
, size_t num_subbuf
,
494 unsigned int switch_timer_interval
,
495 unsigned int read_timer_interval
);
497 void lttng_metadata_channel_destroy(struct lttng_channel
*chan
);
498 struct lttng_event
*lttng_event_create(struct lttng_channel
*chan
,
499 struct lttng_kernel_event
*event_param
,
501 const struct lttng_event_desc
*event_desc
,
502 enum lttng_kernel_instrumentation itype
);
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_compat_old_create(struct lttng_channel
*chan
,
509 struct lttng_kernel_old_event
*old_event_param
,
511 const struct lttng_event_desc
*internal_desc
);
513 int lttng_channel_enable(struct lttng_channel
*channel
);
514 int lttng_channel_disable(struct lttng_channel
*channel
);
515 int lttng_event_enable(struct lttng_event
*event
);
516 int lttng_event_disable(struct lttng_event
*event
);
518 void lttng_transport_register(struct lttng_transport
*transport
);
519 void lttng_transport_unregister(struct lttng_transport
*transport
);
521 void synchronize_trace(void);
522 int lttng_abi_init(void);
523 int lttng_abi_compat_old_init(void);
524 void lttng_abi_exit(void);
525 void lttng_abi_compat_old_exit(void);
527 int lttng_probe_register(struct lttng_probe_desc
*desc
);
528 void lttng_probe_unregister(struct lttng_probe_desc
*desc
);
529 const struct lttng_event_desc
*lttng_event_get(const char *name
);
530 void lttng_event_put(const struct lttng_event_desc
*desc
);
531 int lttng_probes_init(void);
532 void lttng_probes_exit(void);
534 int lttng_metadata_output_channel(struct lttng_metadata_stream
*stream
,
535 struct channel
*chan
);
537 int lttng_pid_tracker_get_node_pid(const struct lttng_pid_hash_node
*node
);
538 struct lttng_pid_tracker
*lttng_pid_tracker_create(void);
539 void lttng_pid_tracker_destroy(struct lttng_pid_tracker
*lpf
);
540 bool lttng_pid_tracker_lookup(struct lttng_pid_tracker
*lpf
, int pid
);
541 int lttng_pid_tracker_add(struct lttng_pid_tracker
*lpf
, int pid
);
542 int lttng_pid_tracker_del(struct lttng_pid_tracker
*lpf
, int pid
);
544 int lttng_session_track_pid(struct lttng_session
*session
, int pid
);
545 int lttng_session_untrack_pid(struct lttng_session
*session
, int pid
);
547 int lttng_session_list_tracker_pids(struct lttng_session
*session
);
549 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
550 int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
);
551 int lttng_syscalls_unregister(struct lttng_channel
*chan
);
552 int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
554 int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
556 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
557 struct lttng_kernel_syscall_mask __user
*usyscall_mask
);
558 int lttng_abi_syscall_list(void);
560 static inline int lttng_syscalls_register(struct lttng_channel
*chan
, void *filter
)
565 static inline int lttng_syscalls_unregister(struct lttng_channel
*chan
)
571 int lttng_syscall_filter_enable(struct lttng_channel
*chan
,
578 int lttng_syscall_filter_disable(struct lttng_channel
*chan
,
585 long lttng_channel_syscall_mask(struct lttng_channel
*channel
,
586 struct lttng_kernel_syscall_mask __user
*usyscall_mask
)
592 int lttng_abi_syscall_list(void)
598 void lttng_filter_sync_state(struct lttng_bytecode_runtime
*runtime
);
599 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
600 struct lttng_kernel_filter_bytecode __user
*bytecode
);
602 extern struct lttng_ctx
*lttng_static_ctx
;
604 int lttng_context_init(void);
605 void lttng_context_exit(void);
606 struct lttng_ctx_field
*lttng_append_context(struct lttng_ctx
**ctx
);
607 void lttng_context_update(struct lttng_ctx
*ctx
);
608 int lttng_find_context(struct lttng_ctx
*ctx
, const char *name
);
609 int lttng_get_context_index(struct lttng_ctx
*ctx
, const char *name
);
610 void lttng_remove_context_field(struct lttng_ctx
**ctx
,
611 struct lttng_ctx_field
*field
);
612 void lttng_destroy_context(struct lttng_ctx
*ctx
);
613 int lttng_add_pid_to_ctx(struct lttng_ctx
**ctx
);
614 int lttng_add_procname_to_ctx(struct lttng_ctx
**ctx
);
615 int lttng_add_prio_to_ctx(struct lttng_ctx
**ctx
);
616 int lttng_add_nice_to_ctx(struct lttng_ctx
**ctx
);
617 int lttng_add_vpid_to_ctx(struct lttng_ctx
**ctx
);
618 int lttng_add_tid_to_ctx(struct lttng_ctx
**ctx
);
619 int lttng_add_vtid_to_ctx(struct lttng_ctx
**ctx
);
620 int lttng_add_ppid_to_ctx(struct lttng_ctx
**ctx
);
621 int lttng_add_vppid_to_ctx(struct lttng_ctx
**ctx
);
622 int lttng_add_hostname_to_ctx(struct lttng_ctx
**ctx
);
623 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
624 int lttng_add_perf_counter_to_ctx(uint32_t type
,
627 struct lttng_ctx
**ctx
);
630 int lttng_add_perf_counter_to_ctx(uint32_t type
,
633 struct lttng_ctx
**ctx
)
639 int lttng_logger_init(void);
640 void lttng_logger_exit(void);
642 extern int lttng_statedump_start(struct lttng_session
*session
);
644 #ifdef CONFIG_KPROBES
645 int lttng_kprobes_register(const char *name
,
646 const char *symbol_name
,
649 struct lttng_event
*event
);
650 void lttng_kprobes_unregister(struct lttng_event
*event
);
651 void lttng_kprobes_destroy_private(struct lttng_event
*event
);
654 int lttng_kprobes_register(const char *name
,
655 const char *symbol_name
,
658 struct lttng_event
*event
)
664 void lttng_kprobes_unregister(struct lttng_event
*event
)
669 void lttng_kprobes_destroy_private(struct lttng_event
*event
)
674 #ifdef CONFIG_KRETPROBES
675 int lttng_kretprobes_register(const char *name
,
676 const char *symbol_name
,
679 struct lttng_event
*event_entry
,
680 struct lttng_event
*event_exit
);
681 void lttng_kretprobes_unregister(struct lttng_event
*event
);
682 void lttng_kretprobes_destroy_private(struct lttng_event
*event
);
685 int lttng_kretprobes_register(const char *name
,
686 const char *symbol_name
,
689 struct lttng_event
*event_entry
,
690 struct lttng_event
*event_exit
)
696 void lttng_kretprobes_unregister(struct lttng_event
*event
)
701 void lttng_kretprobes_destroy_private(struct lttng_event
*event
)
706 #ifdef CONFIG_DYNAMIC_FTRACE
707 int lttng_ftrace_register(const char *name
,
708 const char *symbol_name
,
709 struct lttng_event
*event
);
710 void lttng_ftrace_unregister(struct lttng_event
*event
);
711 void lttng_ftrace_destroy_private(struct lttng_event
*event
);
714 int lttng_ftrace_register(const char *name
,
715 const char *symbol_name
,
716 struct lttng_event
*event
)
722 void lttng_ftrace_unregister(struct lttng_event
*event
)
727 void lttng_ftrace_destroy_private(struct lttng_event
*event
)
732 int lttng_calibrate(struct lttng_kernel_calibrate
*calibrate
);
734 extern const struct file_operations lttng_tracepoint_list_fops
;
735 extern const struct file_operations lttng_syscall_list_fops
;
737 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
738 #define TRACEPOINT_HAS_DATA_ARG
741 #endif /* _LTTNG_EVENTS_H */