2 #ifndef _LINUX_KERNEL_TRACE_H
3 #define _LINUX_KERNEL_TRACE_H
6 #include <linux/atomic.h>
7 #include <linux/sched.h>
8 #include <linux/clocksource.h>
9 #include <linux/ring_buffer.h>
10 #include <linux/mmiotrace.h>
11 #include <linux/tracepoint.h>
12 #include <linux/ftrace.h>
13 #include <linux/hw_breakpoint.h>
14 #include <linux/trace_seq.h>
15 #include <linux/ftrace_event.h>
17 #ifdef CONFIG_FTRACE_SYSCALLS
18 #include <asm/unistd.h> /* For NR_SYSCALLS */
19 #include <asm/syscall.h> /* some archs define it here */
23 __TRACE_FIRST_TYPE
= 0,
45 #define __field(type, item) type item;
48 #define __field_struct(type, item) __field(type, item)
51 #define __field_desc(type, container, item)
54 #define __array(type, item, size) type item[size];
57 #define __array_desc(type, container, item, size)
59 #undef __dynamic_array
60 #define __dynamic_array(type, item) type item[];
63 #define F_STRUCT(args...) args
66 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
67 struct struct_name { \
68 struct trace_entry ent; \
73 #define TP_ARGS(args...) args
75 #undef FTRACE_ENTRY_DUP
76 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
78 #undef FTRACE_ENTRY_REG
79 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
81 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
84 #include "trace_entries.h"
87 * syscalls are special, and need special handling, this is why
88 * they are not included in trace_entries.h
90 struct syscall_trace_enter
{
91 struct trace_entry ent
;
96 struct syscall_trace_exit
{
97 struct trace_entry ent
;
102 struct kprobe_trace_entry_head
{
103 struct trace_entry ent
;
107 struct kretprobe_trace_entry_head
{
108 struct trace_entry ent
;
110 unsigned long ret_ip
;
114 * trace_flag_type is an enumeration that holds different
115 * states when a trace occurs. These are:
116 * IRQS_OFF - interrupts were disabled
117 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
118 * NEED_RESCHED - reschedule is requested
119 * HARDIRQ - inside an interrupt handler
120 * SOFTIRQ - inside a softirq handler
122 enum trace_flag_type
{
123 TRACE_FLAG_IRQS_OFF
= 0x01,
124 TRACE_FLAG_IRQS_NOSUPPORT
= 0x02,
125 TRACE_FLAG_NEED_RESCHED
= 0x04,
126 TRACE_FLAG_HARDIRQ
= 0x08,
127 TRACE_FLAG_SOFTIRQ
= 0x10,
128 TRACE_FLAG_PREEMPT_RESCHED
= 0x20,
131 #define TRACE_BUF_SIZE 1024
136 * The CPU trace array - it consists of thousands of trace entries
137 * plus some other descriptor data: (for example which task started
140 struct trace_array_cpu
{
142 void *buffer_page
; /* ring buffer spare */
144 unsigned long entries
;
145 unsigned long saved_latency
;
146 unsigned long critical_start
;
147 unsigned long critical_end
;
148 unsigned long critical_sequence
;
150 unsigned long policy
;
151 unsigned long rt_priority
;
152 unsigned long skipped_entries
;
153 cycle_t preempt_timestamp
;
156 char comm
[TASK_COMM_LEN
];
161 struct trace_buffer
{
162 struct trace_array
*tr
;
163 struct ring_buffer
*buffer
;
164 struct trace_array_cpu __percpu
*data
;
170 * The trace array - an array of per-CPU trace arrays. This is the
171 * highest level data structure that individual tracers deal with.
172 * They have on/off state as well:
175 struct list_head list
;
177 struct trace_buffer trace_buffer
;
178 #ifdef CONFIG_TRACER_MAX_TRACE
180 * The max_buffer is used to snapshot the trace when a maximum
181 * latency is reached, or when the user initiates a snapshot.
182 * Some tracers will use this to store a maximum trace while
183 * it continues examining live traces.
185 * The buffers for the max_buffer are set up the same as the trace_buffer
186 * When a snapshot is taken, the buffer of the max_buffer is swapped
187 * with the buffer of the trace_buffer and the buffers are reset for
188 * the trace_buffer so the tracing can continue.
190 struct trace_buffer max_buffer
;
191 bool allocated_snapshot
;
194 #ifdef CONFIG_FTRACE_SYSCALLS
195 int sys_refcount_enter
;
196 int sys_refcount_exit
;
197 struct ftrace_event_file __rcu
*enter_syscall_files
[NR_syscalls
];
198 struct ftrace_event_file __rcu
*exit_syscall_files
[NR_syscalls
];
202 struct tracer
*current_trace
;
204 raw_spinlock_t start_lock
;
206 struct dentry
*options
;
207 struct dentry
*percpu_dir
;
208 struct dentry
*event_dir
;
209 struct list_head systems
;
210 struct list_head events
;
211 cpumask_var_t tracing_cpumask
; /* only trace on set CPUs */
213 #ifdef CONFIG_FUNCTION_TRACER
214 struct ftrace_ops
*ops
;
215 /* function tracing enabled */
216 int function_enabled
;
221 TRACE_ARRAY_FL_GLOBAL
= (1 << 0)
224 extern struct list_head ftrace_trace_arrays
;
226 extern struct mutex trace_types_lock
;
228 extern int trace_array_get(struct trace_array
*tr
);
229 extern void trace_array_put(struct trace_array
*tr
);
232 * The global tracer (top) should be the first trace array added,
233 * but we check the flag anyway.
235 static inline struct trace_array
*top_trace_array(void)
237 struct trace_array
*tr
;
239 tr
= list_entry(ftrace_trace_arrays
.prev
,
241 WARN_ON(!(tr
->flags
& TRACE_ARRAY_FL_GLOBAL
));
245 #define FTRACE_CMP_TYPE(var, type) \
246 __builtin_types_compatible_p(typeof(var), type *)
249 #define IF_ASSIGN(var, entry, etype, id) \
250 if (FTRACE_CMP_TYPE(var, etype)) { \
251 var = (typeof(var))(entry); \
252 WARN_ON(id && (entry)->type != id); \
256 /* Will cause compile errors if type is not found. */
257 extern void __ftrace_bad_type(void);
260 * The trace_assign_type is a verifier that the entry type is
261 * the same as the type being assigned. To add new types simply
262 * add a line with the following format:
264 * IF_ASSIGN(var, ent, type, id);
266 * Where "type" is the trace type that includes the trace_entry
267 * as the "ent" item. And "id" is the trace identifier that is
268 * used in the trace_type enum.
270 * If the type can have more than one id, then use zero.
272 #define trace_assign_type(var, ent) \
274 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
275 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
276 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
277 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
278 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
279 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
280 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
281 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
283 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
285 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
286 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
288 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
290 __ftrace_bad_type(); \
294 * An option specific to a tracer. This is a boolean value.
295 * The bit is the bit index that sets its value on the
296 * flags value in struct tracer_flags.
299 const char *name
; /* Will appear on the trace_options file */
300 u32 bit
; /* Mask assigned in val field in tracer_flags */
304 * The set of specific options for a tracer. Your tracer
305 * have to set the initial value of the flags val.
307 struct tracer_flags
{
309 struct tracer_opt
*opts
;
312 /* Makes more easy to define a tracer opt */
313 #define TRACER_OPT(s, b) .name = #s, .bit = b
317 * struct tracer - a specific tracer and its callbacks to interact with debugfs
318 * @name: the name chosen to select it on the available_tracers file
319 * @init: called when one switches to this tracer (echo name > current_tracer)
320 * @reset: called when one switches to another tracer
321 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
322 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
323 * @open: called when the trace file is opened
324 * @pipe_open: called when the trace_pipe file is opened
325 * @wait_pipe: override how the user waits for traces on trace_pipe
326 * @close: called when the trace file is released
327 * @pipe_close: called when the trace_pipe file is released
328 * @read: override the default read callback on trace_pipe
329 * @splice_read: override the default splice_read callback on trace_pipe
330 * @selftest: selftest to run on boot (see trace_selftest.c)
331 * @print_headers: override the first lines that describe your columns
332 * @print_line: callback that prints a trace
333 * @set_flag: signals one of your private flags changed (trace_options file)
334 * @flags: your private flags
338 int (*init
)(struct trace_array
*tr
);
339 void (*reset
)(struct trace_array
*tr
);
340 void (*start
)(struct trace_array
*tr
);
341 void (*stop
)(struct trace_array
*tr
);
342 void (*open
)(struct trace_iterator
*iter
);
343 void (*pipe_open
)(struct trace_iterator
*iter
);
344 void (*wait_pipe
)(struct trace_iterator
*iter
);
345 void (*close
)(struct trace_iterator
*iter
);
346 void (*pipe_close
)(struct trace_iterator
*iter
);
347 ssize_t (*read
)(struct trace_iterator
*iter
,
348 struct file
*filp
, char __user
*ubuf
,
349 size_t cnt
, loff_t
*ppos
);
350 ssize_t (*splice_read
)(struct trace_iterator
*iter
,
353 struct pipe_inode_info
*pipe
,
356 #ifdef CONFIG_FTRACE_STARTUP_TEST
357 int (*selftest
)(struct tracer
*trace
,
358 struct trace_array
*tr
);
360 void (*print_header
)(struct seq_file
*m
);
361 enum print_line_t (*print_line
)(struct trace_iterator
*iter
);
362 /* If you handled the flag setting, return 0 */
363 int (*set_flag
)(struct trace_array
*tr
,
364 u32 old_flags
, u32 bit
, int set
);
365 /* Return 0 if OK with change, else return non-zero */
366 int (*flag_changed
)(struct trace_array
*tr
,
369 struct tracer_flags
*flags
;
372 bool allow_instances
;
373 #ifdef CONFIG_TRACER_MAX_TRACE
379 /* Only current can touch trace_recursion */
382 * For function tracing recursion:
383 * The order of these bits are important.
385 * When function tracing occurs, the following steps are made:
386 * If arch does not support a ftrace feature:
387 * call internal function (uses INTERNAL bits) which calls...
388 * If callback is registered to the "global" list, the list
389 * function is called and recursion checks the GLOBAL bits.
390 * then this function calls...
391 * The function callback, which can use the FTRACE bits to
392 * check for recursion.
394 * Now if the arch does not suppport a feature, and it calls
395 * the global list function which calls the ftrace callback
396 * all three of these steps will do a recursion protection.
397 * There's no reason to do one if the previous caller already
398 * did. The recursion that we are protecting against will
399 * go through the same steps again.
401 * To prevent the multiple recursion checks, if a recursion
402 * bit is set that is higher than the MAX bit of the current
403 * check, then we know that the check was made by the previous
404 * caller, and we can skip the current check.
408 TRACE_BUFFER_NMI_BIT
,
409 TRACE_BUFFER_IRQ_BIT
,
410 TRACE_BUFFER_SIRQ_BIT
,
412 /* Start of function recursion bits */
414 TRACE_FTRACE_NMI_BIT
,
415 TRACE_FTRACE_IRQ_BIT
,
416 TRACE_FTRACE_SIRQ_BIT
,
418 /* GLOBAL_BITs must be greater than FTRACE_BITs */
420 TRACE_GLOBAL_NMI_BIT
,
421 TRACE_GLOBAL_IRQ_BIT
,
422 TRACE_GLOBAL_SIRQ_BIT
,
424 /* INTERNAL_BITs must be greater than GLOBAL_BITs */
426 TRACE_INTERNAL_NMI_BIT
,
427 TRACE_INTERNAL_IRQ_BIT
,
428 TRACE_INTERNAL_SIRQ_BIT
,
433 * Abuse of the trace_recursion.
434 * As we need a way to maintain state if we are tracing the function
435 * graph in irq because we want to trace a particular function that
436 * was called in irq context but we have irq tracing off. Since this
437 * can only be modified by current, we can reuse trace_recursion.
442 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
443 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
444 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
446 #define TRACE_CONTEXT_BITS 4
448 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
449 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
451 #define TRACE_GLOBAL_START TRACE_GLOBAL_BIT
452 #define TRACE_GLOBAL_MAX ((1 << (TRACE_GLOBAL_START + TRACE_CONTEXT_BITS)) - 1)
454 #define TRACE_LIST_START TRACE_INTERNAL_BIT
455 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
457 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
459 static __always_inline
int trace_get_context_bit(void)
463 if (in_interrupt()) {
477 static __always_inline
int trace_test_and_set_recursion(int start
, int max
)
479 unsigned int val
= current
->trace_recursion
;
482 /* A previous recursion check was made */
483 if ((val
& TRACE_CONTEXT_MASK
) > max
)
486 bit
= trace_get_context_bit() + start
;
487 if (unlikely(val
& (1 << bit
)))
491 current
->trace_recursion
= val
;
497 static __always_inline
void trace_clear_recursion(int bit
)
499 unsigned int val
= current
->trace_recursion
;
508 current
->trace_recursion
= val
;
511 static inline struct ring_buffer_iter
*
512 trace_buffer_iter(struct trace_iterator
*iter
, int cpu
)
514 if (iter
->buffer_iter
&& iter
->buffer_iter
[cpu
])
515 return iter
->buffer_iter
[cpu
];
519 int tracer_init(struct tracer
*t
, struct trace_array
*tr
);
520 int tracing_is_enabled(void);
521 void tracing_reset(struct trace_buffer
*buf
, int cpu
);
522 void tracing_reset_online_cpus(struct trace_buffer
*buf
);
523 void tracing_reset_current(int cpu
);
524 void tracing_reset_all_online_cpus(void);
525 int tracing_open_generic(struct inode
*inode
, struct file
*filp
);
526 bool tracing_is_disabled(void);
527 struct dentry
*trace_create_file(const char *name
,
529 struct dentry
*parent
,
531 const struct file_operations
*fops
);
533 struct dentry
*tracing_init_dentry_tr(struct trace_array
*tr
);
534 struct dentry
*tracing_init_dentry(void);
536 struct ring_buffer_event
;
538 struct ring_buffer_event
*
539 trace_buffer_lock_reserve(struct ring_buffer
*buffer
,
545 struct trace_entry
*tracing_get_trace_entry(struct trace_array
*tr
,
546 struct trace_array_cpu
*data
);
548 struct trace_entry
*trace_find_next_entry(struct trace_iterator
*iter
,
549 int *ent_cpu
, u64
*ent_ts
);
551 void __buffer_unlock_commit(struct ring_buffer
*buffer
,
552 struct ring_buffer_event
*event
);
554 int trace_empty(struct trace_iterator
*iter
);
556 void *trace_find_next_entry_inc(struct trace_iterator
*iter
);
558 void trace_init_global_iter(struct trace_iterator
*iter
);
560 void tracing_iter_reset(struct trace_iterator
*iter
, int cpu
);
562 void poll_wait_pipe(struct trace_iterator
*iter
);
564 void tracing_sched_switch_trace(struct trace_array
*tr
,
565 struct task_struct
*prev
,
566 struct task_struct
*next
,
567 unsigned long flags
, int pc
);
569 void tracing_sched_wakeup_trace(struct trace_array
*tr
,
570 struct task_struct
*wakee
,
571 struct task_struct
*cur
,
572 unsigned long flags
, int pc
);
573 void trace_function(struct trace_array
*tr
,
575 unsigned long parent_ip
,
576 unsigned long flags
, int pc
);
577 void trace_graph_function(struct trace_array
*tr
,
579 unsigned long parent_ip
,
580 unsigned long flags
, int pc
);
581 void trace_latency_header(struct seq_file
*m
);
582 void trace_default_header(struct seq_file
*m
);
583 void print_trace_header(struct seq_file
*m
, struct trace_iterator
*iter
);
584 int trace_empty(struct trace_iterator
*iter
);
586 void trace_graph_return(struct ftrace_graph_ret
*trace
);
587 int trace_graph_entry(struct ftrace_graph_ent
*trace
);
588 void set_graph_array(struct trace_array
*tr
);
590 void tracing_start_cmdline_record(void);
591 void tracing_stop_cmdline_record(void);
592 void tracing_sched_switch_assign_trace(struct trace_array
*tr
);
593 void tracing_stop_sched_switch_record(void);
594 void tracing_start_sched_switch_record(void);
595 int register_tracer(struct tracer
*type
);
596 int is_tracing_stopped(void);
598 loff_t
tracing_lseek(struct file
*file
, loff_t offset
, int whence
);
600 extern cpumask_var_t __read_mostly tracing_buffer_mask
;
602 #define for_each_tracing_cpu(cpu) \
603 for_each_cpu(cpu, tracing_buffer_mask)
605 extern unsigned long nsecs_to_usecs(unsigned long nsecs
);
607 extern unsigned long tracing_thresh
;
609 #ifdef CONFIG_TRACER_MAX_TRACE
610 extern unsigned long tracing_max_latency
;
612 void update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
);
613 void update_max_tr_single(struct trace_array
*tr
,
614 struct task_struct
*tsk
, int cpu
);
615 #endif /* CONFIG_TRACER_MAX_TRACE */
617 #ifdef CONFIG_STACKTRACE
618 void ftrace_trace_stack(struct ring_buffer
*buffer
, unsigned long flags
,
621 void ftrace_trace_stack_regs(struct ring_buffer
*buffer
, unsigned long flags
,
622 int skip
, int pc
, struct pt_regs
*regs
);
624 void ftrace_trace_userstack(struct ring_buffer
*buffer
, unsigned long flags
,
627 void __trace_stack(struct trace_array
*tr
, unsigned long flags
, int skip
,
630 static inline void ftrace_trace_stack(struct ring_buffer
*buffer
,
631 unsigned long flags
, int skip
, int pc
)
635 static inline void ftrace_trace_stack_regs(struct ring_buffer
*buffer
,
636 unsigned long flags
, int skip
,
637 int pc
, struct pt_regs
*regs
)
641 static inline void ftrace_trace_userstack(struct ring_buffer
*buffer
,
642 unsigned long flags
, int pc
)
646 static inline void __trace_stack(struct trace_array
*tr
, unsigned long flags
,
650 #endif /* CONFIG_STACKTRACE */
652 extern cycle_t
ftrace_now(int cpu
);
654 extern void trace_find_cmdline(int pid
, char comm
[]);
656 #ifdef CONFIG_DYNAMIC_FTRACE
657 extern unsigned long ftrace_update_tot_cnt
;
659 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
660 extern int DYN_FTRACE_TEST_NAME(void);
661 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
662 extern int DYN_FTRACE_TEST_NAME2(void);
664 extern bool ring_buffer_expanded
;
665 extern bool tracing_selftest_disabled
;
666 DECLARE_PER_CPU(int, ftrace_cpu_disabled
);
668 #ifdef CONFIG_FTRACE_STARTUP_TEST
669 extern int trace_selftest_startup_function(struct tracer
*trace
,
670 struct trace_array
*tr
);
671 extern int trace_selftest_startup_function_graph(struct tracer
*trace
,
672 struct trace_array
*tr
);
673 extern int trace_selftest_startup_irqsoff(struct tracer
*trace
,
674 struct trace_array
*tr
);
675 extern int trace_selftest_startup_preemptoff(struct tracer
*trace
,
676 struct trace_array
*tr
);
677 extern int trace_selftest_startup_preemptirqsoff(struct tracer
*trace
,
678 struct trace_array
*tr
);
679 extern int trace_selftest_startup_wakeup(struct tracer
*trace
,
680 struct trace_array
*tr
);
681 extern int trace_selftest_startup_nop(struct tracer
*trace
,
682 struct trace_array
*tr
);
683 extern int trace_selftest_startup_sched_switch(struct tracer
*trace
,
684 struct trace_array
*tr
);
685 extern int trace_selftest_startup_branch(struct tracer
*trace
,
686 struct trace_array
*tr
);
688 * Tracer data references selftest functions that only occur
689 * on boot up. These can be __init functions. Thus, when selftests
690 * are enabled, then the tracers need to reference __init functions.
692 #define __tracer_data __refdata
694 /* Tracers are seldom changed. Optimize when selftests are disabled. */
695 #define __tracer_data __read_mostly
696 #endif /* CONFIG_FTRACE_STARTUP_TEST */
698 extern void *head_page(struct trace_array_cpu
*data
);
699 extern unsigned long long ns2usecs(cycle_t nsec
);
701 trace_vbprintk(unsigned long ip
, const char *fmt
, va_list args
);
703 trace_vprintk(unsigned long ip
, const char *fmt
, va_list args
);
705 trace_array_vprintk(struct trace_array
*tr
,
706 unsigned long ip
, const char *fmt
, va_list args
);
707 int trace_array_printk(struct trace_array
*tr
,
708 unsigned long ip
, const char *fmt
, ...);
709 int trace_array_printk_buf(struct ring_buffer
*buffer
,
710 unsigned long ip
, const char *fmt
, ...);
711 void trace_printk_seq(struct trace_seq
*s
);
712 enum print_line_t
print_trace_line(struct trace_iterator
*iter
);
714 extern unsigned long trace_flags
;
716 /* Standard output formatting function used for function return traces */
717 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
720 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
721 #define TRACE_GRAPH_PRINT_CPU 0x2
722 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
723 #define TRACE_GRAPH_PRINT_PROC 0x8
724 #define TRACE_GRAPH_PRINT_DURATION 0x10
725 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
726 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
727 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
729 extern enum print_line_t
730 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
);
731 extern void print_graph_headers_flags(struct seq_file
*s
, u32 flags
);
732 extern enum print_line_t
733 trace_print_graph_duration(unsigned long long duration
, struct trace_seq
*s
);
734 extern void graph_trace_open(struct trace_iterator
*iter
);
735 extern void graph_trace_close(struct trace_iterator
*iter
);
736 extern int __trace_graph_entry(struct trace_array
*tr
,
737 struct ftrace_graph_ent
*trace
,
738 unsigned long flags
, int pc
);
739 extern void __trace_graph_return(struct trace_array
*tr
,
740 struct ftrace_graph_ret
*trace
,
741 unsigned long flags
, int pc
);
744 #ifdef CONFIG_DYNAMIC_FTRACE
745 /* TODO: make this variable */
746 #define FTRACE_GRAPH_MAX_FUNCS 32
747 extern int ftrace_graph_count
;
748 extern unsigned long ftrace_graph_funcs
[FTRACE_GRAPH_MAX_FUNCS
];
749 extern int ftrace_graph_notrace_count
;
750 extern unsigned long ftrace_graph_notrace_funcs
[FTRACE_GRAPH_MAX_FUNCS
];
752 static inline int ftrace_graph_addr(unsigned long addr
)
756 if (!ftrace_graph_count
)
759 for (i
= 0; i
< ftrace_graph_count
; i
++) {
760 if (addr
== ftrace_graph_funcs
[i
]) {
762 * If no irqs are to be traced, but a set_graph_function
763 * is set, and called by an interrupt handler, we still
767 trace_recursion_set(TRACE_IRQ_BIT
);
769 trace_recursion_clear(TRACE_IRQ_BIT
);
777 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
781 if (!ftrace_graph_notrace_count
)
784 for (i
= 0; i
< ftrace_graph_notrace_count
; i
++) {
785 if (addr
== ftrace_graph_notrace_funcs
[i
])
792 static inline int ftrace_graph_addr(unsigned long addr
)
797 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
801 #endif /* CONFIG_DYNAMIC_FTRACE */
802 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
803 static inline enum print_line_t
804 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
)
806 return TRACE_TYPE_UNHANDLED
;
808 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
810 extern struct list_head ftrace_pids
;
812 #ifdef CONFIG_FUNCTION_TRACER
813 extern bool ftrace_filter_param __initdata
;
814 static inline int ftrace_trace_task(struct task_struct
*task
)
816 if (list_empty(&ftrace_pids
))
819 return test_tsk_trace_trace(task
);
821 extern int ftrace_is_dead(void);
822 int ftrace_create_function_files(struct trace_array
*tr
,
823 struct dentry
*parent
);
824 void ftrace_destroy_function_files(struct trace_array
*tr
);
826 static inline int ftrace_trace_task(struct task_struct
*task
)
830 static inline int ftrace_is_dead(void) { return 0; }
832 ftrace_create_function_files(struct trace_array
*tr
,
833 struct dentry
*parent
)
837 static inline void ftrace_destroy_function_files(struct trace_array
*tr
) { }
838 #endif /* CONFIG_FUNCTION_TRACER */
840 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
841 void ftrace_create_filter_files(struct ftrace_ops
*ops
,
842 struct dentry
*parent
);
843 void ftrace_destroy_filter_files(struct ftrace_ops
*ops
);
846 * The ops parameter passed in is usually undefined.
847 * This must be a macro.
849 #define ftrace_create_filter_files(ops, parent) do { } while (0)
850 #define ftrace_destroy_filter_files(ops) do { } while (0)
851 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
853 int ftrace_event_is_function(struct ftrace_event_call
*call
);
856 * struct trace_parser - servers for reading the user input separated by spaces
857 * @cont: set if the input is not complete - no final space char was found
858 * @buffer: holds the parsed user input
859 * @idx: user input length
862 struct trace_parser
{
869 static inline bool trace_parser_loaded(struct trace_parser
*parser
)
871 return (parser
->idx
!= 0);
874 static inline bool trace_parser_cont(struct trace_parser
*parser
)
879 static inline void trace_parser_clear(struct trace_parser
*parser
)
881 parser
->cont
= false;
885 extern int trace_parser_get_init(struct trace_parser
*parser
, int size
);
886 extern void trace_parser_put(struct trace_parser
*parser
);
887 extern int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
888 size_t cnt
, loff_t
*ppos
);
891 * trace_iterator_flags is an enumeration that defines bit
892 * positions into trace_flags that controls the output.
894 * NOTE: These bits must match the trace_options array in
897 enum trace_iterator_flags
{
898 TRACE_ITER_PRINT_PARENT
= 0x01,
899 TRACE_ITER_SYM_OFFSET
= 0x02,
900 TRACE_ITER_SYM_ADDR
= 0x04,
901 TRACE_ITER_VERBOSE
= 0x08,
902 TRACE_ITER_RAW
= 0x10,
903 TRACE_ITER_HEX
= 0x20,
904 TRACE_ITER_BIN
= 0x40,
905 TRACE_ITER_BLOCK
= 0x80,
906 TRACE_ITER_STACKTRACE
= 0x100,
907 TRACE_ITER_PRINTK
= 0x200,
908 TRACE_ITER_PREEMPTONLY
= 0x400,
909 TRACE_ITER_BRANCH
= 0x800,
910 TRACE_ITER_ANNOTATE
= 0x1000,
911 TRACE_ITER_USERSTACKTRACE
= 0x2000,
912 TRACE_ITER_SYM_USEROBJ
= 0x4000,
913 TRACE_ITER_PRINTK_MSGONLY
= 0x8000,
914 TRACE_ITER_CONTEXT_INFO
= 0x10000, /* Print pid/cpu/time */
915 TRACE_ITER_LATENCY_FMT
= 0x20000,
916 TRACE_ITER_SLEEP_TIME
= 0x40000,
917 TRACE_ITER_GRAPH_TIME
= 0x80000,
918 TRACE_ITER_RECORD_CMD
= 0x100000,
919 TRACE_ITER_OVERWRITE
= 0x200000,
920 TRACE_ITER_STOP_ON_FREE
= 0x400000,
921 TRACE_ITER_IRQ_INFO
= 0x800000,
922 TRACE_ITER_MARKERS
= 0x1000000,
923 TRACE_ITER_FUNCTION
= 0x2000000,
927 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
928 * control the output of kernel symbols.
930 #define TRACE_ITER_SYM_MASK \
931 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
933 extern struct tracer nop_trace
;
935 #ifdef CONFIG_BRANCH_TRACER
936 extern int enable_branch_tracing(struct trace_array
*tr
);
937 extern void disable_branch_tracing(void);
938 static inline int trace_branch_enable(struct trace_array
*tr
)
940 if (trace_flags
& TRACE_ITER_BRANCH
)
941 return enable_branch_tracing(tr
);
944 static inline void trace_branch_disable(void)
946 /* due to races, always disable */
947 disable_branch_tracing();
950 static inline int trace_branch_enable(struct trace_array
*tr
)
954 static inline void trace_branch_disable(void)
957 #endif /* CONFIG_BRANCH_TRACER */
959 /* set ring buffers to default size if not already done so */
960 int tracing_update_buffers(void);
962 struct ftrace_event_field
{
963 struct list_head link
;
972 struct event_filter
{
973 int n_preds
; /* Number assigned */
974 int a_preds
; /* allocated */
975 struct filter_pred
*preds
;
976 struct filter_pred
*root
;
980 struct event_subsystem
{
981 struct list_head list
;
983 struct event_filter
*filter
;
987 struct ftrace_subsystem_dir
{
988 struct list_head list
;
989 struct event_subsystem
*subsystem
;
990 struct trace_array
*tr
;
991 struct dentry
*entry
;
996 #define FILTER_PRED_INVALID ((unsigned short)-1)
997 #define FILTER_PRED_IS_RIGHT (1 << 15)
998 #define FILTER_PRED_FOLD (1 << 15)
1001 * The max preds is the size of unsigned short with
1002 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1003 * and FOLD flags. The other is reserved.
1005 * 2^14 preds is way more than enough.
1007 #define MAX_FILTER_PRED 16384
1012 typedef int (*filter_pred_fn_t
) (struct filter_pred
*pred
, void *event
);
1014 typedef int (*regex_match_func
)(char *str
, struct regex
*r
, int len
);
1024 char pattern
[MAX_FILTER_STR_VAL
];
1027 regex_match_func match
;
1030 struct filter_pred
{
1031 filter_pred_fn_t fn
;
1034 unsigned short *ops
;
1035 struct ftrace_event_field
*field
;
1039 unsigned short index
;
1040 unsigned short parent
;
1041 unsigned short left
;
1042 unsigned short right
;
1045 extern enum regex_type
1046 filter_parse_regex(char *buff
, int len
, char **search
, int *not);
1047 extern void print_event_filter(struct ftrace_event_file
*file
,
1048 struct trace_seq
*s
);
1049 extern int apply_event_filter(struct ftrace_event_file
*file
,
1050 char *filter_string
);
1051 extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir
*dir
,
1052 char *filter_string
);
1053 extern void print_subsystem_event_filter(struct event_subsystem
*system
,
1054 struct trace_seq
*s
);
1055 extern int filter_assign_type(const char *type
);
1056 extern int create_event_filter(struct ftrace_event_call
*call
,
1057 char *filter_str
, bool set_str
,
1058 struct event_filter
**filterp
);
1059 extern void free_event_filter(struct event_filter
*filter
);
1061 struct ftrace_event_field
*
1062 trace_find_event_field(struct ftrace_event_call
*call
, char *name
);
1064 extern void trace_event_enable_cmd_record(bool enable
);
1065 extern int event_trace_add_tracer(struct dentry
*parent
, struct trace_array
*tr
);
1066 extern int event_trace_del_tracer(struct trace_array
*tr
);
1068 extern struct ftrace_event_file
*find_event_file(struct trace_array
*tr
,
1072 static inline void *event_file_data(struct file
*filp
)
1074 return ACCESS_ONCE(file_inode(filp
)->i_private
);
1077 extern struct mutex event_mutex
;
1078 extern struct list_head ftrace_events
;
1080 extern const struct file_operations event_trigger_fops
;
1082 extern int register_trigger_cmds(void);
1083 extern void clear_event_triggers(struct trace_array
*tr
);
1085 struct event_trigger_data
{
1086 unsigned long count
;
1088 struct event_trigger_ops
*ops
;
1089 struct event_command
*cmd_ops
;
1090 struct event_filter __rcu
*filter
;
1093 struct list_head list
;
1097 * struct event_trigger_ops - callbacks for trace event triggers
1099 * The methods in this structure provide per-event trigger hooks for
1100 * various trigger operations.
1102 * All the methods below, except for @init() and @free(), must be
1105 * @func: The trigger 'probe' function called when the triggering
1106 * event occurs. The data passed into this callback is the data
1107 * that was supplied to the event_command @reg() function that
1108 * registered the trigger (see struct event_command).
1110 * @init: An optional initialization function called for the trigger
1111 * when the trigger is registered (via the event_command reg()
1112 * function). This can be used to perform per-trigger
1113 * initialization such as incrementing a per-trigger reference
1114 * count, for instance. This is usually implemented by the
1115 * generic utility function @event_trigger_init() (see
1116 * trace_event_triggers.c).
1118 * @free: An optional de-initialization function called for the
1119 * trigger when the trigger is unregistered (via the
1120 * event_command @reg() function). This can be used to perform
1121 * per-trigger de-initialization such as decrementing a
1122 * per-trigger reference count and freeing corresponding trigger
1123 * data, for instance. This is usually implemented by the
1124 * generic utility function @event_trigger_free() (see
1125 * trace_event_triggers.c).
1127 * @print: The callback function invoked to have the trigger print
1128 * itself. This is usually implemented by a wrapper function
1129 * that calls the generic utility function @event_trigger_print()
1130 * (see trace_event_triggers.c).
1132 struct event_trigger_ops
{
1133 void (*func
)(struct event_trigger_data
*data
);
1134 int (*init
)(struct event_trigger_ops
*ops
,
1135 struct event_trigger_data
*data
);
1136 void (*free
)(struct event_trigger_ops
*ops
,
1137 struct event_trigger_data
*data
);
1138 int (*print
)(struct seq_file
*m
,
1139 struct event_trigger_ops
*ops
,
1140 struct event_trigger_data
*data
);
1144 * struct event_command - callbacks and data members for event commands
1146 * Event commands are invoked by users by writing the command name
1147 * into the 'trigger' file associated with a trace event. The
1148 * parameters associated with a specific invocation of an event
1149 * command are used to create an event trigger instance, which is
1150 * added to the list of trigger instances associated with that trace
1151 * event. When the event is hit, the set of triggers associated with
1152 * that event is invoked.
1154 * The data members in this structure provide per-event command data
1155 * for various event commands.
1157 * All the data members below, except for @post_trigger, must be set
1158 * for each event command.
1160 * @name: The unique name that identifies the event command. This is
1161 * the name used when setting triggers via trigger files.
1163 * @trigger_type: A unique id that identifies the event command
1164 * 'type'. This value has two purposes, the first to ensure that
1165 * only one trigger of the same type can be set at a given time
1166 * for a particular event e.g. it doesn't make sense to have both
1167 * a traceon and traceoff trigger attached to a single event at
1168 * the same time, so traceon and traceoff have the same type
1169 * though they have different names. The @trigger_type value is
1170 * also used as a bit value for deferring the actual trigger
1171 * action until after the current event is finished. Some
1172 * commands need to do this if they themselves log to the trace
1173 * buffer (see the @post_trigger() member below). @trigger_type
1174 * values are defined by adding new values to the trigger_type
1175 * enum in include/linux/ftrace_event.h.
1177 * @post_trigger: A flag that says whether or not this command needs
1178 * to have its action delayed until after the current event has
1179 * been closed. Some triggers need to avoid being invoked while
1180 * an event is currently in the process of being logged, since
1181 * the trigger may itself log data into the trace buffer. Thus
1182 * we make sure the current event is committed before invoking
1183 * those triggers. To do that, the trigger invocation is split
1184 * in two - the first part checks the filter using the current
1185 * trace record; if a command has the @post_trigger flag set, it
1186 * sets a bit for itself in the return value, otherwise it
1187 * directly invokes the trigger. Once all commands have been
1188 * either invoked or set their return flag, the current record is
1189 * either committed or discarded. At that point, if any commands
1190 * have deferred their triggers, those commands are finally
1191 * invoked following the close of the current event. In other
1192 * words, if the event_trigger_ops @func() probe implementation
1193 * itself logs to the trace buffer, this flag should be set,
1194 * otherwise it can be left unspecified.
1196 * All the methods below, except for @set_filter(), must be
1199 * @func: The callback function responsible for parsing and
1200 * registering the trigger written to the 'trigger' file by the
1201 * user. It allocates the trigger instance and registers it with
1202 * the appropriate trace event. It makes use of the other
1203 * event_command callback functions to orchestrate this, and is
1204 * usually implemented by the generic utility function
1205 * @event_trigger_callback() (see trace_event_triggers.c).
1207 * @reg: Adds the trigger to the list of triggers associated with the
1208 * event, and enables the event trigger itself, after
1209 * initializing it (via the event_trigger_ops @init() function).
1210 * This is also where commands can use the @trigger_type value to
1211 * make the decision as to whether or not multiple instances of
1212 * the trigger should be allowed. This is usually implemented by
1213 * the generic utility function @register_trigger() (see
1214 * trace_event_triggers.c).
1216 * @unreg: Removes the trigger from the list of triggers associated
1217 * with the event, and disables the event trigger itself, after
1218 * initializing it (via the event_trigger_ops @free() function).
1219 * This is usually implemented by the generic utility function
1220 * @unregister_trigger() (see trace_event_triggers.c).
1222 * @set_filter: An optional function called to parse and set a filter
1223 * for the trigger. If no @set_filter() method is set for the
1224 * event command, filters set by the user for the command will be
1225 * ignored. This is usually implemented by the generic utility
1226 * function @set_trigger_filter() (see trace_event_triggers.c).
1228 * @get_trigger_ops: The callback function invoked to retrieve the
1229 * event_trigger_ops implementation associated with the command.
1231 struct event_command
{
1232 struct list_head list
;
1234 enum event_trigger_type trigger_type
;
1236 int (*func
)(struct event_command
*cmd_ops
,
1237 struct ftrace_event_file
*file
,
1238 char *glob
, char *cmd
, char *params
);
1239 int (*reg
)(char *glob
,
1240 struct event_trigger_ops
*ops
,
1241 struct event_trigger_data
*data
,
1242 struct ftrace_event_file
*file
);
1243 void (*unreg
)(char *glob
,
1244 struct event_trigger_ops
*ops
,
1245 struct event_trigger_data
*data
,
1246 struct ftrace_event_file
*file
);
1247 int (*set_filter
)(char *filter_str
,
1248 struct event_trigger_data
*data
,
1249 struct ftrace_event_file
*file
);
1250 struct event_trigger_ops
*(*get_trigger_ops
)(char *cmd
, char *param
);
1253 extern int trace_event_enable_disable(struct ftrace_event_file
*file
,
1254 int enable
, int soft_disable
);
1255 extern int tracing_alloc_snapshot(void);
1257 extern const char *__start___trace_bprintk_fmt
[];
1258 extern const char *__stop___trace_bprintk_fmt
[];
1260 extern const char *__start___tracepoint_str
[];
1261 extern const char *__stop___tracepoint_str
[];
1263 void trace_printk_init_buffers(void);
1264 void trace_printk_start_comm(void);
1265 int trace_keep_overwrite(struct tracer
*tracer
, u32 mask
, int set
);
1266 int set_tracer_flag(struct trace_array
*tr
, unsigned int mask
, int enabled
);
1269 * Normal trace_printk() and friends allocates special buffers
1270 * to do the manipulation, as well as saves the print formats
1271 * into sections to display. But the trace infrastructure wants
1272 * to use these without the added overhead at the price of being
1273 * a bit slower (used mainly for warnings, where we don't care
1274 * about performance). The internal_trace_puts() is for such
1277 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1280 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1281 extern struct ftrace_event_call \
1282 __attribute__((__aligned__(4))) event_##call;
1283 #undef FTRACE_ENTRY_DUP
1284 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1285 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1287 #include "trace_entries.h"
1289 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1290 int perf_ftrace_event_register(struct ftrace_event_call
*call
,
1291 enum trace_reg type
, void *data
);
1293 #define perf_ftrace_event_register NULL
1296 #endif /* _LINUX_KERNEL_TRACE_H */