2 #ifndef _LINUX_FTRACE_EVENT_H
3 #define _LINUX_FTRACE_EVENT_H
5 #include <linux/ring_buffer.h>
6 #include <linux/trace_seq.h>
7 #include <linux/percpu.h>
8 #include <linux/hardirq.h>
9 #include <linux/perf_event.h>
10 #include <linux/tracepoint.h>
18 struct trace_print_flags
{
23 struct trace_print_flags_u64
{
24 unsigned long long mask
;
28 const char *ftrace_print_flags_seq(struct trace_seq
*p
, const char *delim
,
30 const struct trace_print_flags
*flag_array
);
32 const char *ftrace_print_symbols_seq(struct trace_seq
*p
, unsigned long val
,
33 const struct trace_print_flags
*symbol_array
);
35 #if BITS_PER_LONG == 32
36 const char *ftrace_print_symbols_seq_u64(struct trace_seq
*p
,
37 unsigned long long val
,
38 const struct trace_print_flags_u64
42 const char *ftrace_print_bitmask_seq(struct trace_seq
*p
, void *bitmask_ptr
,
43 unsigned int bitmask_size
);
45 const char *ftrace_print_hex_seq(struct trace_seq
*p
,
46 const unsigned char *buf
, int len
);
48 const char *ftrace_print_array_seq(struct trace_seq
*p
,
49 const void *buf
, int count
,
52 struct trace_iterator
;
55 int ftrace_raw_output_prep(struct trace_iterator
*iter
,
56 struct trace_event
*event
);
59 * The trace entry - the most basic unit of tracing. This is what
60 * is printed in the end as a single line in the trace output, such as:
62 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
67 unsigned char preempt_count
;
71 #define FTRACE_MAX_EVENT \
72 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
75 * Trace iterator - used by printout routines who present trace
76 * results to users and which routines might sleep, etc:
78 struct trace_iterator
{
79 struct trace_array
*tr
;
81 struct trace_buffer
*trace_buffer
;
85 struct ring_buffer_iter
**buffer_iter
;
86 unsigned long iter_flags
;
88 /* trace_seq for __print_flags() and __print_symbolic() etc. */
89 struct trace_seq tmp_seq
;
91 cpumask_var_t started
;
93 /* it's true when current open file is snapshot */
96 /* The below is zeroed out in pipe_read */
98 struct trace_entry
*ent
;
99 unsigned long lost_events
;
108 /* All new field here will be zeroed out in pipe_read */
111 enum trace_iter_flags
{
112 TRACE_FILE_LAT_FMT
= 1,
113 TRACE_FILE_ANNOTATE
= 2,
114 TRACE_FILE_TIME_IN_NS
= 4,
118 typedef enum print_line_t (*trace_print_func
)(struct trace_iterator
*iter
,
119 int flags
, struct trace_event
*event
);
121 struct trace_event_functions
{
122 trace_print_func trace
;
123 trace_print_func raw
;
124 trace_print_func hex
;
125 trace_print_func binary
;
129 struct hlist_node node
;
130 struct list_head list
;
132 struct trace_event_functions
*funcs
;
135 extern int register_ftrace_event(struct trace_event
*event
);
136 extern int unregister_ftrace_event(struct trace_event
*event
);
138 /* Return values for print_line callback */
140 TRACE_TYPE_PARTIAL_LINE
= 0, /* Retry after flushing the seq */
141 TRACE_TYPE_HANDLED
= 1,
142 TRACE_TYPE_UNHANDLED
= 2, /* Relay to other output functions */
143 TRACE_TYPE_NO_CONSUME
= 3 /* Handled but ask to not consume */
147 * Several functions return TRACE_TYPE_PARTIAL_LINE if the trace_seq
148 * overflowed, and TRACE_TYPE_HANDLED otherwise. This helper function
149 * simplifies those functions and keeps them in sync.
151 static inline enum print_line_t
trace_handle_return(struct trace_seq
*s
)
153 return trace_seq_has_overflowed(s
) ?
154 TRACE_TYPE_PARTIAL_LINE
: TRACE_TYPE_HANDLED
;
157 void tracing_generic_entry_update(struct trace_entry
*entry
,
160 struct ftrace_event_file
;
162 struct ring_buffer_event
*
163 trace_event_buffer_lock_reserve(struct ring_buffer
**current_buffer
,
164 struct ftrace_event_file
*ftrace_file
,
165 int type
, unsigned long len
,
166 unsigned long flags
, int pc
);
167 struct ring_buffer_event
*
168 trace_current_buffer_lock_reserve(struct ring_buffer
**current_buffer
,
169 int type
, unsigned long len
,
170 unsigned long flags
, int pc
);
171 void trace_current_buffer_unlock_commit(struct ring_buffer
*buffer
,
172 struct ring_buffer_event
*event
,
173 unsigned long flags
, int pc
);
174 void trace_buffer_unlock_commit(struct ring_buffer
*buffer
,
175 struct ring_buffer_event
*event
,
176 unsigned long flags
, int pc
);
177 void trace_buffer_unlock_commit_regs(struct ring_buffer
*buffer
,
178 struct ring_buffer_event
*event
,
179 unsigned long flags
, int pc
,
180 struct pt_regs
*regs
);
181 void trace_current_buffer_discard_commit(struct ring_buffer
*buffer
,
182 struct ring_buffer_event
*event
);
184 void tracing_record_cmdline(struct task_struct
*tsk
);
186 int ftrace_output_call(struct trace_iterator
*iter
, char *name
, char *fmt
, ...);
192 TRACE_REG_UNREGISTER
,
193 #ifdef CONFIG_PERF_EVENTS
194 TRACE_REG_PERF_REGISTER
,
195 TRACE_REG_PERF_UNREGISTER
,
197 TRACE_REG_PERF_CLOSE
,
203 struct ftrace_event_call
;
205 struct ftrace_event_class
{
208 #ifdef CONFIG_PERF_EVENTS
211 int (*reg
)(struct ftrace_event_call
*event
,
212 enum trace_reg type
, void *data
);
213 int (*define_fields
)(struct ftrace_event_call
*);
214 struct list_head
*(*get_fields
)(struct ftrace_event_call
*);
215 struct list_head fields
;
216 int (*raw_init
)(struct ftrace_event_call
*);
219 extern int ftrace_event_reg(struct ftrace_event_call
*event
,
220 enum trace_reg type
, void *data
);
222 int ftrace_output_event(struct trace_iterator
*iter
, struct ftrace_event_call
*event
,
225 int ftrace_event_define_field(struct ftrace_event_call
*call
,
226 char *type
, int len
, char *item
, int offset
,
227 int field_size
, int sign
, int filter
);
229 struct ftrace_event_buffer
{
230 struct ring_buffer
*buffer
;
231 struct ring_buffer_event
*event
;
232 struct ftrace_event_file
*ftrace_file
;
238 void *ftrace_event_buffer_reserve(struct ftrace_event_buffer
*fbuffer
,
239 struct ftrace_event_file
*ftrace_file
,
242 void ftrace_event_buffer_commit(struct ftrace_event_buffer
*fbuffer
);
244 int ftrace_event_define_field(struct ftrace_event_call
*call
,
245 char *type
, int len
, char *item
, int offset
,
246 int field_size
, int sign
, int filter
);
249 TRACE_EVENT_FL_FILTERED_BIT
,
250 TRACE_EVENT_FL_CAP_ANY_BIT
,
251 TRACE_EVENT_FL_NO_SET_FILTER_BIT
,
252 TRACE_EVENT_FL_IGNORE_ENABLE_BIT
,
253 TRACE_EVENT_FL_WAS_ENABLED_BIT
,
254 TRACE_EVENT_FL_USE_CALL_FILTER_BIT
,
255 TRACE_EVENT_FL_TRACEPOINT_BIT
,
256 TRACE_EVENT_FL_KPROBE_BIT
,
261 * FILTERED - The event has a filter attached
262 * CAP_ANY - Any user can enable for perf
263 * NO_SET_FILTER - Set when filter has error and is to be ignored
264 * IGNORE_ENABLE - For ftrace internal events, do not enable with debugfs file
265 * WAS_ENABLED - Set and stays set when an event was ever enabled
266 * (used for module unloading, if a module event is enabled,
267 * it is best to clear the buffers that used it).
268 * USE_CALL_FILTER - For ftrace internal events, don't use file filter
269 * TRACEPOINT - Event is a tracepoint
270 * KPROBE - Event is a kprobe
273 TRACE_EVENT_FL_FILTERED
= (1 << TRACE_EVENT_FL_FILTERED_BIT
),
274 TRACE_EVENT_FL_CAP_ANY
= (1 << TRACE_EVENT_FL_CAP_ANY_BIT
),
275 TRACE_EVENT_FL_NO_SET_FILTER
= (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT
),
276 TRACE_EVENT_FL_IGNORE_ENABLE
= (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT
),
277 TRACE_EVENT_FL_WAS_ENABLED
= (1 << TRACE_EVENT_FL_WAS_ENABLED_BIT
),
278 TRACE_EVENT_FL_USE_CALL_FILTER
= (1 << TRACE_EVENT_FL_USE_CALL_FILTER_BIT
),
279 TRACE_EVENT_FL_TRACEPOINT
= (1 << TRACE_EVENT_FL_TRACEPOINT_BIT
),
280 TRACE_EVENT_FL_KPROBE
= (1 << TRACE_EVENT_FL_KPROBE_BIT
),
283 struct ftrace_event_call
{
284 struct list_head list
;
285 struct ftrace_event_class
*class;
288 /* Set TRACE_EVENT_FL_TRACEPOINT flag when using "tp" */
289 struct tracepoint
*tp
;
291 struct trace_event event
;
293 struct event_filter
*filter
;
297 * bit 0: filter_active
298 * bit 1: allow trace by non root (cap any)
299 * bit 2: failed to apply filter
300 * bit 3: ftrace internal event (do not enable)
301 * bit 4: Event was enabled by module
302 * bit 5: use call filter rather than file filter
303 * bit 6: Event is a tracepoint
305 int flags
; /* static flags of different events */
307 #ifdef CONFIG_PERF_EVENTS
309 struct hlist_head __percpu
*perf_events
;
310 struct bpf_prog
*prog
;
312 int (*perf_perm
)(struct ftrace_event_call
*,
313 struct perf_event
*);
317 static inline const char *
318 ftrace_event_name(struct ftrace_event_call
*call
)
320 if (call
->flags
& TRACE_EVENT_FL_TRACEPOINT
)
321 return call
->tp
? call
->tp
->name
: NULL
;
327 struct ftrace_subsystem_dir
;
330 FTRACE_EVENT_FL_ENABLED_BIT
,
331 FTRACE_EVENT_FL_RECORDED_CMD_BIT
,
332 FTRACE_EVENT_FL_FILTERED_BIT
,
333 FTRACE_EVENT_FL_NO_SET_FILTER_BIT
,
334 FTRACE_EVENT_FL_SOFT_MODE_BIT
,
335 FTRACE_EVENT_FL_SOFT_DISABLED_BIT
,
336 FTRACE_EVENT_FL_TRIGGER_MODE_BIT
,
337 FTRACE_EVENT_FL_TRIGGER_COND_BIT
,
341 * Ftrace event file flags:
342 * ENABLED - The event is enabled
343 * RECORDED_CMD - The comms should be recorded at sched_switch
344 * FILTERED - The event has a filter attached
345 * NO_SET_FILTER - Set when filter has error and is to be ignored
346 * SOFT_MODE - The event is enabled/disabled by SOFT_DISABLED
347 * SOFT_DISABLED - When set, do not trace the event (even though its
348 * tracepoint may be enabled)
349 * TRIGGER_MODE - When set, invoke the triggers associated with the event
350 * TRIGGER_COND - When set, one or more triggers has an associated filter
353 FTRACE_EVENT_FL_ENABLED
= (1 << FTRACE_EVENT_FL_ENABLED_BIT
),
354 FTRACE_EVENT_FL_RECORDED_CMD
= (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT
),
355 FTRACE_EVENT_FL_FILTERED
= (1 << FTRACE_EVENT_FL_FILTERED_BIT
),
356 FTRACE_EVENT_FL_NO_SET_FILTER
= (1 << FTRACE_EVENT_FL_NO_SET_FILTER_BIT
),
357 FTRACE_EVENT_FL_SOFT_MODE
= (1 << FTRACE_EVENT_FL_SOFT_MODE_BIT
),
358 FTRACE_EVENT_FL_SOFT_DISABLED
= (1 << FTRACE_EVENT_FL_SOFT_DISABLED_BIT
),
359 FTRACE_EVENT_FL_TRIGGER_MODE
= (1 << FTRACE_EVENT_FL_TRIGGER_MODE_BIT
),
360 FTRACE_EVENT_FL_TRIGGER_COND
= (1 << FTRACE_EVENT_FL_TRIGGER_COND_BIT
),
363 struct ftrace_event_file
{
364 struct list_head list
;
365 struct ftrace_event_call
*event_call
;
366 struct event_filter
*filter
;
368 struct trace_array
*tr
;
369 struct ftrace_subsystem_dir
*system
;
370 struct list_head triggers
;
375 * bit 1: enabled cmd record
376 * bit 2: enable/disable with the soft disable bit
377 * bit 3: soft disabled
378 * bit 4: trigger enabled
380 * Note: The bits must be set atomically to prevent races
381 * from other writers. Reads of flags do not need to be in
382 * sync as they occur in critical sections. But the way flags
383 * is currently used, these changes do not affect the code
384 * except that when a change is made, it may have a slight
385 * delay in propagating the changes to other CPUs due to
386 * caching and such. Which is mostly OK ;-)
389 atomic_t sm_ref
; /* soft-mode reference counter */
390 atomic_t tm_ref
; /* trigger-mode reference counter */
393 #define __TRACE_EVENT_FLAGS(name, value) \
394 static int __init trace_init_flags_##name(void) \
396 event_##name.flags |= value; \
399 early_initcall(trace_init_flags_##name);
401 #define __TRACE_EVENT_PERF_PERM(name, expr...) \
402 static int perf_perm_##name(struct ftrace_event_call *tp_event, \
403 struct perf_event *p_event) \
405 return ({ expr; }); \
407 static int __init trace_init_perf_perm_##name(void) \
409 event_##name.perf_perm = &perf_perm_##name; \
412 early_initcall(trace_init_perf_perm_##name);
414 #define PERF_MAX_TRACE_SIZE 2048
416 #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
418 enum event_trigger_type
{
420 ETT_TRACE_ONOFF
= (1 << 0),
421 ETT_SNAPSHOT
= (1 << 1),
422 ETT_STACKTRACE
= (1 << 2),
423 ETT_EVENT_ENABLE
= (1 << 3),
426 extern int filter_match_preds(struct event_filter
*filter
, void *rec
);
428 extern int filter_check_discard(struct ftrace_event_file
*file
, void *rec
,
429 struct ring_buffer
*buffer
,
430 struct ring_buffer_event
*event
);
431 extern int call_filter_check_discard(struct ftrace_event_call
*call
, void *rec
,
432 struct ring_buffer
*buffer
,
433 struct ring_buffer_event
*event
);
434 extern enum event_trigger_type
event_triggers_call(struct ftrace_event_file
*file
,
436 extern void event_triggers_post_call(struct ftrace_event_file
*file
,
437 enum event_trigger_type tt
);
440 * ftrace_trigger_soft_disabled - do triggers and test if soft disabled
441 * @file: The file pointer of the event to test
443 * If any triggers without filters are attached to this event, they
444 * will be called here. If the event is soft disabled and has no
445 * triggers that require testing the fields, it will return true,
449 ftrace_trigger_soft_disabled(struct ftrace_event_file
*file
)
451 unsigned long eflags
= file
->flags
;
453 if (!(eflags
& FTRACE_EVENT_FL_TRIGGER_COND
)) {
454 if (eflags
& FTRACE_EVENT_FL_TRIGGER_MODE
)
455 event_triggers_call(file
, NULL
);
456 if (eflags
& FTRACE_EVENT_FL_SOFT_DISABLED
)
463 * Helper function for event_trigger_unlock_commit{_regs}().
464 * If there are event triggers attached to this event that requires
465 * filtering against its fields, then they wil be called as the
466 * entry already holds the field information of the current event.
468 * It also checks if the event should be discarded or not.
469 * It is to be discarded if the event is soft disabled and the
470 * event was only recorded to process triggers, or if the event
471 * filter is active and this event did not match the filters.
473 * Returns true if the event is discarded, false otherwise.
476 __event_trigger_test_discard(struct ftrace_event_file
*file
,
477 struct ring_buffer
*buffer
,
478 struct ring_buffer_event
*event
,
480 enum event_trigger_type
*tt
)
482 unsigned long eflags
= file
->flags
;
484 if (eflags
& FTRACE_EVENT_FL_TRIGGER_COND
)
485 *tt
= event_triggers_call(file
, entry
);
487 if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT
, &file
->flags
))
488 ring_buffer_discard_commit(buffer
, event
);
489 else if (!filter_check_discard(file
, entry
, buffer
, event
))
496 * event_trigger_unlock_commit - handle triggers and finish event commit
497 * @file: The file pointer assoctiated to the event
498 * @buffer: The ring buffer that the event is being written to
499 * @event: The event meta data in the ring buffer
500 * @entry: The event itself
501 * @irq_flags: The state of the interrupts at the start of the event
502 * @pc: The state of the preempt count at the start of the event.
504 * This is a helper function to handle triggers that require data
505 * from the event itself. It also tests the event against filters and
506 * if the event is soft disabled and should be discarded.
509 event_trigger_unlock_commit(struct ftrace_event_file
*file
,
510 struct ring_buffer
*buffer
,
511 struct ring_buffer_event
*event
,
512 void *entry
, unsigned long irq_flags
, int pc
)
514 enum event_trigger_type tt
= ETT_NONE
;
516 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
517 trace_buffer_unlock_commit(buffer
, event
, irq_flags
, pc
);
520 event_triggers_post_call(file
, tt
);
524 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
525 * @file: The file pointer assoctiated to the event
526 * @buffer: The ring buffer that the event is being written to
527 * @event: The event meta data in the ring buffer
528 * @entry: The event itself
529 * @irq_flags: The state of the interrupts at the start of the event
530 * @pc: The state of the preempt count at the start of the event.
532 * This is a helper function to handle triggers that require data
533 * from the event itself. It also tests the event against filters and
534 * if the event is soft disabled and should be discarded.
536 * Same as event_trigger_unlock_commit() but calls
537 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
540 event_trigger_unlock_commit_regs(struct ftrace_event_file
*file
,
541 struct ring_buffer
*buffer
,
542 struct ring_buffer_event
*event
,
543 void *entry
, unsigned long irq_flags
, int pc
,
544 struct pt_regs
*regs
)
546 enum event_trigger_type tt
= ETT_NONE
;
548 if (!__event_trigger_test_discard(file
, buffer
, event
, entry
, &tt
))
549 trace_buffer_unlock_commit_regs(buffer
, event
,
550 irq_flags
, pc
, regs
);
553 event_triggers_post_call(file
, tt
);
556 #ifdef CONFIG_BPF_SYSCALL
557 unsigned int trace_call_bpf(struct bpf_prog
*prog
, void *ctx
);
559 static inline unsigned int trace_call_bpf(struct bpf_prog
*prog
, void *ctx
)
567 FILTER_STATIC_STRING
,
573 extern int trace_event_raw_init(struct ftrace_event_call
*call
);
574 extern int trace_define_field(struct ftrace_event_call
*call
, const char *type
,
575 const char *name
, int offset
, int size
,
576 int is_signed
, int filter_type
);
577 extern int trace_add_event_call(struct ftrace_event_call
*call
);
578 extern int trace_remove_event_call(struct ftrace_event_call
*call
);
580 #define is_signed_type(type) (((type)(-1)) < (type)1)
582 int trace_set_clr_event(const char *system
, const char *event
, int set
);
585 * The double __builtin_constant_p is because gcc will give us an error
586 * if we try to allocate the static variable to fmt if it is not a
587 * constant. Even with the outer if statement optimizing out.
589 #define event_trace_printk(ip, fmt, args...) \
591 __trace_printk_check_format(fmt, ##args); \
592 tracing_record_cmdline(current); \
593 if (__builtin_constant_p(fmt)) { \
594 static const char *trace_printk_fmt \
595 __attribute__((section("__trace_printk_fmt"))) = \
596 __builtin_constant_p(fmt) ? fmt : NULL; \
598 __trace_bprintk(ip, trace_printk_fmt, ##args); \
600 __trace_printk(ip, fmt, ##args); \
603 #ifdef CONFIG_PERF_EVENTS
606 DECLARE_PER_CPU(struct pt_regs
, perf_trace_regs
);
608 extern int perf_trace_init(struct perf_event
*event
);
609 extern void perf_trace_destroy(struct perf_event
*event
);
610 extern int perf_trace_add(struct perf_event
*event
, int flags
);
611 extern void perf_trace_del(struct perf_event
*event
, int flags
);
612 extern int ftrace_profile_set_filter(struct perf_event
*event
, int event_id
,
614 extern void ftrace_profile_free_filter(struct perf_event
*event
);
615 extern void *perf_trace_buf_prepare(int size
, unsigned short type
,
616 struct pt_regs
**regs
, int *rctxp
);
619 perf_trace_buf_submit(void *raw_data
, int size
, int rctx
, u64 addr
,
620 u64 count
, struct pt_regs
*regs
, void *head
,
621 struct task_struct
*task
)
623 perf_tp_event(addr
, count
, raw_data
, size
, regs
, head
, rctx
, task
);
627 #endif /* _LINUX_FTRACE_EVENT_H */