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>
16 #include <linux/compiler.h>
17 #include <linux/trace_seq.h>
19 #ifdef CONFIG_FTRACE_SYSCALLS
20 #include <asm/unistd.h> /* For NR_SYSCALLS */
21 #include <asm/syscall.h> /* some archs define it here */
25 __TRACE_FIRST_TYPE
= 0,
47 #define __field(type, item) type item;
50 #define __field_struct(type, item) __field(type, item)
53 #define __field_desc(type, container, item)
56 #define __array(type, item, size) type item[size];
59 #define __array_desc(type, container, item, size)
61 #undef __dynamic_array
62 #define __dynamic_array(type, item) type item[];
65 #define F_STRUCT(args...) args
68 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
69 struct struct_name { \
70 struct trace_entry ent; \
75 #define TP_ARGS(args...) args
77 #undef FTRACE_ENTRY_DUP
78 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
80 #undef FTRACE_ENTRY_REG
81 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
83 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
86 #include "trace_entries.h"
89 * syscalls are special, and need special handling, this is why
90 * they are not included in trace_entries.h
92 struct syscall_trace_enter
{
93 struct trace_entry ent
;
98 struct syscall_trace_exit
{
99 struct trace_entry ent
;
104 struct kprobe_trace_entry_head
{
105 struct trace_entry ent
;
109 struct kretprobe_trace_entry_head
{
110 struct trace_entry ent
;
112 unsigned long ret_ip
;
116 * trace_flag_type is an enumeration that holds different
117 * states when a trace occurs. These are:
118 * IRQS_OFF - interrupts were disabled
119 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
120 * NEED_RESCHED - reschedule is requested
121 * HARDIRQ - inside an interrupt handler
122 * SOFTIRQ - inside a softirq handler
124 enum trace_flag_type
{
125 TRACE_FLAG_IRQS_OFF
= 0x01,
126 TRACE_FLAG_IRQS_NOSUPPORT
= 0x02,
127 TRACE_FLAG_NEED_RESCHED
= 0x04,
128 TRACE_FLAG_HARDIRQ
= 0x08,
129 TRACE_FLAG_SOFTIRQ
= 0x10,
130 TRACE_FLAG_PREEMPT_RESCHED
= 0x20,
133 #define TRACE_BUF_SIZE 1024
138 * The CPU trace array - it consists of thousands of trace entries
139 * plus some other descriptor data: (for example which task started
142 struct trace_array_cpu
{
144 void *buffer_page
; /* ring buffer spare */
146 unsigned long entries
;
147 unsigned long saved_latency
;
148 unsigned long critical_start
;
149 unsigned long critical_end
;
150 unsigned long critical_sequence
;
152 unsigned long policy
;
153 unsigned long rt_priority
;
154 unsigned long skipped_entries
;
155 cycle_t preempt_timestamp
;
158 char comm
[TASK_COMM_LEN
];
163 struct trace_buffer
{
164 struct trace_array
*tr
;
165 struct ring_buffer
*buffer
;
166 struct trace_array_cpu __percpu
*data
;
172 * The trace array - an array of per-CPU trace arrays. This is the
173 * highest level data structure that individual tracers deal with.
174 * They have on/off state as well:
177 struct list_head list
;
179 struct trace_buffer trace_buffer
;
180 #ifdef CONFIG_TRACER_MAX_TRACE
182 * The max_buffer is used to snapshot the trace when a maximum
183 * latency is reached, or when the user initiates a snapshot.
184 * Some tracers will use this to store a maximum trace while
185 * it continues examining live traces.
187 * The buffers for the max_buffer are set up the same as the trace_buffer
188 * When a snapshot is taken, the buffer of the max_buffer is swapped
189 * with the buffer of the trace_buffer and the buffers are reset for
190 * the trace_buffer so the tracing can continue.
192 struct trace_buffer max_buffer
;
193 bool allocated_snapshot
;
194 unsigned long max_latency
;
197 * max_lock is used to protect the swapping of buffers
198 * when taking a max snapshot. The buffers themselves are
199 * protected by per_cpu spinlocks. But the action of the swap
200 * needs its own lock.
202 * This is defined as a arch_spinlock_t in order to help
203 * with performance when lockdep debugging is enabled.
205 * It is also used in other places outside the update_max_tr
206 * so it needs to be defined outside of the
207 * CONFIG_TRACER_MAX_TRACE.
209 arch_spinlock_t max_lock
;
211 #ifdef CONFIG_FTRACE_SYSCALLS
212 int sys_refcount_enter
;
213 int sys_refcount_exit
;
214 struct ftrace_event_file __rcu
*enter_syscall_files
[NR_syscalls
];
215 struct ftrace_event_file __rcu
*exit_syscall_files
[NR_syscalls
];
219 struct tracer
*current_trace
;
221 raw_spinlock_t start_lock
;
223 struct dentry
*options
;
224 struct dentry
*percpu_dir
;
225 struct dentry
*event_dir
;
226 struct list_head systems
;
227 struct list_head events
;
228 cpumask_var_t tracing_cpumask
; /* only trace on set CPUs */
230 #ifdef CONFIG_FUNCTION_TRACER
231 struct ftrace_ops
*ops
;
232 /* function tracing enabled */
233 int function_enabled
;
238 TRACE_ARRAY_FL_GLOBAL
= (1 << 0)
241 extern struct list_head ftrace_trace_arrays
;
243 extern struct mutex trace_types_lock
;
245 extern int trace_array_get(struct trace_array
*tr
);
246 extern void trace_array_put(struct trace_array
*tr
);
249 * The global tracer (top) should be the first trace array added,
250 * but we check the flag anyway.
252 static inline struct trace_array
*top_trace_array(void)
254 struct trace_array
*tr
;
256 if (list_empty(&ftrace_trace_arrays
))
259 tr
= list_entry(ftrace_trace_arrays
.prev
,
261 WARN_ON(!(tr
->flags
& TRACE_ARRAY_FL_GLOBAL
));
265 #define FTRACE_CMP_TYPE(var, type) \
266 __builtin_types_compatible_p(typeof(var), type *)
269 #define IF_ASSIGN(var, entry, etype, id) \
270 if (FTRACE_CMP_TYPE(var, etype)) { \
271 var = (typeof(var))(entry); \
272 WARN_ON(id && (entry)->type != id); \
276 /* Will cause compile errors if type is not found. */
277 extern void __ftrace_bad_type(void);
280 * The trace_assign_type is a verifier that the entry type is
281 * the same as the type being assigned. To add new types simply
282 * add a line with the following format:
284 * IF_ASSIGN(var, ent, type, id);
286 * Where "type" is the trace type that includes the trace_entry
287 * as the "ent" item. And "id" is the trace identifier that is
288 * used in the trace_type enum.
290 * If the type can have more than one id, then use zero.
292 #define trace_assign_type(var, ent) \
294 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
295 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
296 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
297 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
298 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
299 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
300 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
301 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
303 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
305 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
306 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
308 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
310 __ftrace_bad_type(); \
314 * An option specific to a tracer. This is a boolean value.
315 * The bit is the bit index that sets its value on the
316 * flags value in struct tracer_flags.
319 const char *name
; /* Will appear on the trace_options file */
320 u32 bit
; /* Mask assigned in val field in tracer_flags */
324 * The set of specific options for a tracer. Your tracer
325 * have to set the initial value of the flags val.
327 struct tracer_flags
{
329 struct tracer_opt
*opts
;
332 /* Makes more easy to define a tracer opt */
333 #define TRACER_OPT(s, b) .name = #s, .bit = b
337 * struct tracer - a specific tracer and its callbacks to interact with debugfs
338 * @name: the name chosen to select it on the available_tracers file
339 * @init: called when one switches to this tracer (echo name > current_tracer)
340 * @reset: called when one switches to another tracer
341 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
342 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
343 * @update_thresh: called when tracing_thresh is updated
344 * @open: called when the trace file is opened
345 * @pipe_open: called when the trace_pipe file is opened
346 * @close: called when the trace file is released
347 * @pipe_close: called when the trace_pipe file is released
348 * @read: override the default read callback on trace_pipe
349 * @splice_read: override the default splice_read callback on trace_pipe
350 * @selftest: selftest to run on boot (see trace_selftest.c)
351 * @print_headers: override the first lines that describe your columns
352 * @print_line: callback that prints a trace
353 * @set_flag: signals one of your private flags changed (trace_options file)
354 * @flags: your private flags
358 int (*init
)(struct trace_array
*tr
);
359 void (*reset
)(struct trace_array
*tr
);
360 void (*start
)(struct trace_array
*tr
);
361 void (*stop
)(struct trace_array
*tr
);
362 int (*update_thresh
)(struct trace_array
*tr
);
363 void (*open
)(struct trace_iterator
*iter
);
364 void (*pipe_open
)(struct trace_iterator
*iter
);
365 void (*close
)(struct trace_iterator
*iter
);
366 void (*pipe_close
)(struct trace_iterator
*iter
);
367 ssize_t (*read
)(struct trace_iterator
*iter
,
368 struct file
*filp
, char __user
*ubuf
,
369 size_t cnt
, loff_t
*ppos
);
370 ssize_t (*splice_read
)(struct trace_iterator
*iter
,
373 struct pipe_inode_info
*pipe
,
376 #ifdef CONFIG_FTRACE_STARTUP_TEST
377 int (*selftest
)(struct tracer
*trace
,
378 struct trace_array
*tr
);
380 void (*print_header
)(struct seq_file
*m
);
381 enum print_line_t (*print_line
)(struct trace_iterator
*iter
);
382 /* If you handled the flag setting, return 0 */
383 int (*set_flag
)(struct trace_array
*tr
,
384 u32 old_flags
, u32 bit
, int set
);
385 /* Return 0 if OK with change, else return non-zero */
386 int (*flag_changed
)(struct trace_array
*tr
,
389 struct tracer_flags
*flags
;
392 bool allow_instances
;
393 #ifdef CONFIG_TRACER_MAX_TRACE
399 /* Only current can touch trace_recursion */
402 * For function tracing recursion:
403 * The order of these bits are important.
405 * When function tracing occurs, the following steps are made:
406 * If arch does not support a ftrace feature:
407 * call internal function (uses INTERNAL bits) which calls...
408 * If callback is registered to the "global" list, the list
409 * function is called and recursion checks the GLOBAL bits.
410 * then this function calls...
411 * The function callback, which can use the FTRACE bits to
412 * check for recursion.
414 * Now if the arch does not suppport a feature, and it calls
415 * the global list function which calls the ftrace callback
416 * all three of these steps will do a recursion protection.
417 * There's no reason to do one if the previous caller already
418 * did. The recursion that we are protecting against will
419 * go through the same steps again.
421 * To prevent the multiple recursion checks, if a recursion
422 * bit is set that is higher than the MAX bit of the current
423 * check, then we know that the check was made by the previous
424 * caller, and we can skip the current check.
428 TRACE_BUFFER_NMI_BIT
,
429 TRACE_BUFFER_IRQ_BIT
,
430 TRACE_BUFFER_SIRQ_BIT
,
432 /* Start of function recursion bits */
434 TRACE_FTRACE_NMI_BIT
,
435 TRACE_FTRACE_IRQ_BIT
,
436 TRACE_FTRACE_SIRQ_BIT
,
438 /* INTERNAL_BITs must be greater than FTRACE_BITs */
440 TRACE_INTERNAL_NMI_BIT
,
441 TRACE_INTERNAL_IRQ_BIT
,
442 TRACE_INTERNAL_SIRQ_BIT
,
447 * Abuse of the trace_recursion.
448 * As we need a way to maintain state if we are tracing the function
449 * graph in irq because we want to trace a particular function that
450 * was called in irq context but we have irq tracing off. Since this
451 * can only be modified by current, we can reuse trace_recursion.
456 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
457 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
458 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
460 #define TRACE_CONTEXT_BITS 4
462 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
463 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
465 #define TRACE_LIST_START TRACE_INTERNAL_BIT
466 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
468 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
470 static __always_inline
int trace_get_context_bit(void)
474 if (in_interrupt()) {
488 static __always_inline
int trace_test_and_set_recursion(int start
, int max
)
490 unsigned int val
= current
->trace_recursion
;
493 /* A previous recursion check was made */
494 if ((val
& TRACE_CONTEXT_MASK
) > max
)
497 bit
= trace_get_context_bit() + start
;
498 if (unlikely(val
& (1 << bit
)))
502 current
->trace_recursion
= val
;
508 static __always_inline
void trace_clear_recursion(int bit
)
510 unsigned int val
= current
->trace_recursion
;
519 current
->trace_recursion
= val
;
522 static inline struct ring_buffer_iter
*
523 trace_buffer_iter(struct trace_iterator
*iter
, int cpu
)
525 if (iter
->buffer_iter
&& iter
->buffer_iter
[cpu
])
526 return iter
->buffer_iter
[cpu
];
530 int tracer_init(struct tracer
*t
, struct trace_array
*tr
);
531 int tracing_is_enabled(void);
532 void tracing_reset(struct trace_buffer
*buf
, int cpu
);
533 void tracing_reset_online_cpus(struct trace_buffer
*buf
);
534 void tracing_reset_current(int cpu
);
535 void tracing_reset_all_online_cpus(void);
536 int tracing_open_generic(struct inode
*inode
, struct file
*filp
);
537 bool tracing_is_disabled(void);
538 struct dentry
*trace_create_file(const char *name
,
540 struct dentry
*parent
,
542 const struct file_operations
*fops
);
544 struct dentry
*tracing_init_dentry_tr(struct trace_array
*tr
);
545 struct dentry
*tracing_init_dentry(void);
547 struct ring_buffer_event
;
549 struct ring_buffer_event
*
550 trace_buffer_lock_reserve(struct ring_buffer
*buffer
,
556 struct trace_entry
*tracing_get_trace_entry(struct trace_array
*tr
,
557 struct trace_array_cpu
*data
);
559 struct trace_entry
*trace_find_next_entry(struct trace_iterator
*iter
,
560 int *ent_cpu
, u64
*ent_ts
);
562 void __buffer_unlock_commit(struct ring_buffer
*buffer
,
563 struct ring_buffer_event
*event
);
565 int trace_empty(struct trace_iterator
*iter
);
567 void *trace_find_next_entry_inc(struct trace_iterator
*iter
);
569 void trace_init_global_iter(struct trace_iterator
*iter
);
571 void tracing_iter_reset(struct trace_iterator
*iter
, int cpu
);
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 int register_tracer(struct tracer
*type
);
593 int is_tracing_stopped(void);
595 loff_t
tracing_lseek(struct file
*file
, loff_t offset
, int whence
);
597 extern cpumask_var_t __read_mostly tracing_buffer_mask
;
599 #define for_each_tracing_cpu(cpu) \
600 for_each_cpu(cpu, tracing_buffer_mask)
602 extern unsigned long nsecs_to_usecs(unsigned long nsecs
);
604 extern unsigned long tracing_thresh
;
606 #ifdef CONFIG_TRACER_MAX_TRACE
607 void update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
);
608 void update_max_tr_single(struct trace_array
*tr
,
609 struct task_struct
*tsk
, int cpu
);
610 #endif /* CONFIG_TRACER_MAX_TRACE */
612 #ifdef CONFIG_STACKTRACE
613 void ftrace_trace_stack(struct ring_buffer
*buffer
, unsigned long flags
,
616 void ftrace_trace_stack_regs(struct ring_buffer
*buffer
, unsigned long flags
,
617 int skip
, int pc
, struct pt_regs
*regs
);
619 void ftrace_trace_userstack(struct ring_buffer
*buffer
, unsigned long flags
,
622 void __trace_stack(struct trace_array
*tr
, unsigned long flags
, int skip
,
625 static inline void ftrace_trace_stack(struct ring_buffer
*buffer
,
626 unsigned long flags
, int skip
, int pc
)
630 static inline void ftrace_trace_stack_regs(struct ring_buffer
*buffer
,
631 unsigned long flags
, int skip
,
632 int pc
, struct pt_regs
*regs
)
636 static inline void ftrace_trace_userstack(struct ring_buffer
*buffer
,
637 unsigned long flags
, int pc
)
641 static inline void __trace_stack(struct trace_array
*tr
, unsigned long flags
,
645 #endif /* CONFIG_STACKTRACE */
647 extern cycle_t
ftrace_now(int cpu
);
649 extern void trace_find_cmdline(int pid
, char comm
[]);
651 #ifdef CONFIG_DYNAMIC_FTRACE
652 extern unsigned long ftrace_update_tot_cnt
;
654 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
655 extern int DYN_FTRACE_TEST_NAME(void);
656 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
657 extern int DYN_FTRACE_TEST_NAME2(void);
659 extern bool ring_buffer_expanded
;
660 extern bool tracing_selftest_disabled
;
661 DECLARE_PER_CPU(int, ftrace_cpu_disabled
);
663 #ifdef CONFIG_FTRACE_STARTUP_TEST
664 extern int trace_selftest_startup_function(struct tracer
*trace
,
665 struct trace_array
*tr
);
666 extern int trace_selftest_startup_function_graph(struct tracer
*trace
,
667 struct trace_array
*tr
);
668 extern int trace_selftest_startup_irqsoff(struct tracer
*trace
,
669 struct trace_array
*tr
);
670 extern int trace_selftest_startup_preemptoff(struct tracer
*trace
,
671 struct trace_array
*tr
);
672 extern int trace_selftest_startup_preemptirqsoff(struct tracer
*trace
,
673 struct trace_array
*tr
);
674 extern int trace_selftest_startup_wakeup(struct tracer
*trace
,
675 struct trace_array
*tr
);
676 extern int trace_selftest_startup_nop(struct tracer
*trace
,
677 struct trace_array
*tr
);
678 extern int trace_selftest_startup_sched_switch(struct tracer
*trace
,
679 struct trace_array
*tr
);
680 extern int trace_selftest_startup_branch(struct tracer
*trace
,
681 struct trace_array
*tr
);
683 * Tracer data references selftest functions that only occur
684 * on boot up. These can be __init functions. Thus, when selftests
685 * are enabled, then the tracers need to reference __init functions.
687 #define __tracer_data __refdata
689 /* Tracers are seldom changed. Optimize when selftests are disabled. */
690 #define __tracer_data __read_mostly
691 #endif /* CONFIG_FTRACE_STARTUP_TEST */
693 extern void *head_page(struct trace_array_cpu
*data
);
694 extern unsigned long long ns2usecs(cycle_t nsec
);
696 trace_vbprintk(unsigned long ip
, const char *fmt
, va_list args
);
698 trace_vprintk(unsigned long ip
, const char *fmt
, va_list args
);
700 trace_array_vprintk(struct trace_array
*tr
,
701 unsigned long ip
, const char *fmt
, va_list args
);
702 int trace_array_printk(struct trace_array
*tr
,
703 unsigned long ip
, const char *fmt
, ...);
704 int trace_array_printk_buf(struct ring_buffer
*buffer
,
705 unsigned long ip
, const char *fmt
, ...);
706 void trace_printk_seq(struct trace_seq
*s
);
707 enum print_line_t
print_trace_line(struct trace_iterator
*iter
);
709 extern unsigned long trace_flags
;
711 extern char trace_find_mark(unsigned long long duration
);
713 /* Standard output formatting function used for function return traces */
714 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
717 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
718 #define TRACE_GRAPH_PRINT_CPU 0x2
719 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
720 #define TRACE_GRAPH_PRINT_PROC 0x8
721 #define TRACE_GRAPH_PRINT_DURATION 0x10
722 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
723 #define TRACE_GRAPH_PRINT_IRQS 0x40
724 #define TRACE_GRAPH_PRINT_TAIL 0x80
725 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
726 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
728 extern enum print_line_t
729 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
);
730 extern void print_graph_headers_flags(struct seq_file
*s
, u32 flags
);
732 trace_print_graph_duration(unsigned long long duration
, struct trace_seq
*s
);
733 extern void graph_trace_open(struct trace_iterator
*iter
);
734 extern void graph_trace_close(struct trace_iterator
*iter
);
735 extern int __trace_graph_entry(struct trace_array
*tr
,
736 struct ftrace_graph_ent
*trace
,
737 unsigned long flags
, int pc
);
738 extern void __trace_graph_return(struct trace_array
*tr
,
739 struct ftrace_graph_ret
*trace
,
740 unsigned long flags
, int pc
);
743 #ifdef CONFIG_DYNAMIC_FTRACE
744 /* TODO: make this variable */
745 #define FTRACE_GRAPH_MAX_FUNCS 32
746 extern int ftrace_graph_count
;
747 extern unsigned long ftrace_graph_funcs
[FTRACE_GRAPH_MAX_FUNCS
];
748 extern int ftrace_graph_notrace_count
;
749 extern unsigned long ftrace_graph_notrace_funcs
[FTRACE_GRAPH_MAX_FUNCS
];
751 static inline int ftrace_graph_addr(unsigned long addr
)
755 if (!ftrace_graph_count
)
758 for (i
= 0; i
< ftrace_graph_count
; i
++) {
759 if (addr
== ftrace_graph_funcs
[i
]) {
761 * If no irqs are to be traced, but a set_graph_function
762 * is set, and called by an interrupt handler, we still
766 trace_recursion_set(TRACE_IRQ_BIT
);
768 trace_recursion_clear(TRACE_IRQ_BIT
);
776 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
780 if (!ftrace_graph_notrace_count
)
783 for (i
= 0; i
< ftrace_graph_notrace_count
; i
++) {
784 if (addr
== ftrace_graph_notrace_funcs
[i
])
791 static inline int ftrace_graph_addr(unsigned long addr
)
796 static inline int ftrace_graph_notrace_addr(unsigned long addr
)
800 #endif /* CONFIG_DYNAMIC_FTRACE */
801 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
802 static inline enum print_line_t
803 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
)
805 return TRACE_TYPE_UNHANDLED
;
807 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
809 extern struct list_head ftrace_pids
;
811 #ifdef CONFIG_FUNCTION_TRACER
812 extern bool ftrace_filter_param __initdata
;
813 static inline int ftrace_trace_task(struct task_struct
*task
)
815 if (list_empty(&ftrace_pids
))
818 return test_tsk_trace_trace(task
);
820 extern int ftrace_is_dead(void);
821 int ftrace_create_function_files(struct trace_array
*tr
,
822 struct dentry
*parent
);
823 void ftrace_destroy_function_files(struct trace_array
*tr
);
824 void ftrace_init_global_array_ops(struct trace_array
*tr
);
825 void ftrace_init_array_ops(struct trace_array
*tr
, ftrace_func_t func
);
826 void ftrace_reset_array_ops(struct trace_array
*tr
);
827 int using_ftrace_ops_list_func(void);
829 static inline int ftrace_trace_task(struct task_struct
*task
)
833 static inline int ftrace_is_dead(void) { return 0; }
835 ftrace_create_function_files(struct trace_array
*tr
,
836 struct dentry
*parent
)
840 static inline void ftrace_destroy_function_files(struct trace_array
*tr
) { }
841 static inline __init
void
842 ftrace_init_global_array_ops(struct trace_array
*tr
) { }
843 static inline void ftrace_reset_array_ops(struct trace_array
*tr
) { }
844 /* ftace_func_t type is not defined, use macro instead of static inline */
845 #define ftrace_init_array_ops(tr, func) do { } while (0)
846 #endif /* CONFIG_FUNCTION_TRACER */
848 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
849 void ftrace_create_filter_files(struct ftrace_ops
*ops
,
850 struct dentry
*parent
);
851 void ftrace_destroy_filter_files(struct ftrace_ops
*ops
);
854 * The ops parameter passed in is usually undefined.
855 * This must be a macro.
857 #define ftrace_create_filter_files(ops, parent) do { } while (0)
858 #define ftrace_destroy_filter_files(ops) do { } while (0)
859 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
861 int ftrace_event_is_function(struct ftrace_event_call
*call
);
864 * struct trace_parser - servers for reading the user input separated by spaces
865 * @cont: set if the input is not complete - no final space char was found
866 * @buffer: holds the parsed user input
867 * @idx: user input length
870 struct trace_parser
{
877 static inline bool trace_parser_loaded(struct trace_parser
*parser
)
879 return (parser
->idx
!= 0);
882 static inline bool trace_parser_cont(struct trace_parser
*parser
)
887 static inline void trace_parser_clear(struct trace_parser
*parser
)
889 parser
->cont
= false;
893 extern int trace_parser_get_init(struct trace_parser
*parser
, int size
);
894 extern void trace_parser_put(struct trace_parser
*parser
);
895 extern int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
896 size_t cnt
, loff_t
*ppos
);
899 * trace_iterator_flags is an enumeration that defines bit
900 * positions into trace_flags that controls the output.
902 * NOTE: These bits must match the trace_options array in
905 enum trace_iterator_flags
{
906 TRACE_ITER_PRINT_PARENT
= 0x01,
907 TRACE_ITER_SYM_OFFSET
= 0x02,
908 TRACE_ITER_SYM_ADDR
= 0x04,
909 TRACE_ITER_VERBOSE
= 0x08,
910 TRACE_ITER_RAW
= 0x10,
911 TRACE_ITER_HEX
= 0x20,
912 TRACE_ITER_BIN
= 0x40,
913 TRACE_ITER_BLOCK
= 0x80,
914 TRACE_ITER_STACKTRACE
= 0x100,
915 TRACE_ITER_PRINTK
= 0x200,
916 TRACE_ITER_PREEMPTONLY
= 0x400,
917 TRACE_ITER_BRANCH
= 0x800,
918 TRACE_ITER_ANNOTATE
= 0x1000,
919 TRACE_ITER_USERSTACKTRACE
= 0x2000,
920 TRACE_ITER_SYM_USEROBJ
= 0x4000,
921 TRACE_ITER_PRINTK_MSGONLY
= 0x8000,
922 TRACE_ITER_CONTEXT_INFO
= 0x10000, /* Print pid/cpu/time */
923 TRACE_ITER_LATENCY_FMT
= 0x20000,
924 TRACE_ITER_SLEEP_TIME
= 0x40000,
925 TRACE_ITER_GRAPH_TIME
= 0x80000,
926 TRACE_ITER_RECORD_CMD
= 0x100000,
927 TRACE_ITER_OVERWRITE
= 0x200000,
928 TRACE_ITER_STOP_ON_FREE
= 0x400000,
929 TRACE_ITER_IRQ_INFO
= 0x800000,
930 TRACE_ITER_MARKERS
= 0x1000000,
931 TRACE_ITER_FUNCTION
= 0x2000000,
935 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
936 * control the output of kernel symbols.
938 #define TRACE_ITER_SYM_MASK \
939 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
941 extern struct tracer nop_trace
;
943 #ifdef CONFIG_BRANCH_TRACER
944 extern int enable_branch_tracing(struct trace_array
*tr
);
945 extern void disable_branch_tracing(void);
946 static inline int trace_branch_enable(struct trace_array
*tr
)
948 if (trace_flags
& TRACE_ITER_BRANCH
)
949 return enable_branch_tracing(tr
);
952 static inline void trace_branch_disable(void)
954 /* due to races, always disable */
955 disable_branch_tracing();
958 static inline int trace_branch_enable(struct trace_array
*tr
)
962 static inline void trace_branch_disable(void)
965 #endif /* CONFIG_BRANCH_TRACER */
967 /* set ring buffers to default size if not already done so */
968 int tracing_update_buffers(void);
970 struct ftrace_event_field
{
971 struct list_head link
;
980 struct event_filter
{
981 int n_preds
; /* Number assigned */
982 int a_preds
; /* allocated */
983 struct filter_pred
*preds
;
984 struct filter_pred
*root
;
988 struct event_subsystem
{
989 struct list_head list
;
991 struct event_filter
*filter
;
995 struct ftrace_subsystem_dir
{
996 struct list_head list
;
997 struct event_subsystem
*subsystem
;
998 struct trace_array
*tr
;
999 struct dentry
*entry
;
1004 #define FILTER_PRED_INVALID ((unsigned short)-1)
1005 #define FILTER_PRED_IS_RIGHT (1 << 15)
1006 #define FILTER_PRED_FOLD (1 << 15)
1009 * The max preds is the size of unsigned short with
1010 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1011 * and FOLD flags. The other is reserved.
1013 * 2^14 preds is way more than enough.
1015 #define MAX_FILTER_PRED 16384
1020 typedef int (*filter_pred_fn_t
) (struct filter_pred
*pred
, void *event
);
1022 typedef int (*regex_match_func
)(char *str
, struct regex
*r
, int len
);
1032 char pattern
[MAX_FILTER_STR_VAL
];
1035 regex_match_func match
;
1038 struct filter_pred
{
1039 filter_pred_fn_t fn
;
1042 unsigned short *ops
;
1043 struct ftrace_event_field
*field
;
1047 unsigned short index
;
1048 unsigned short parent
;
1049 unsigned short left
;
1050 unsigned short right
;
1053 extern enum regex_type
1054 filter_parse_regex(char *buff
, int len
, char **search
, int *not);
1055 extern void print_event_filter(struct ftrace_event_file
*file
,
1056 struct trace_seq
*s
);
1057 extern int apply_event_filter(struct ftrace_event_file
*file
,
1058 char *filter_string
);
1059 extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir
*dir
,
1060 char *filter_string
);
1061 extern void print_subsystem_event_filter(struct event_subsystem
*system
,
1062 struct trace_seq
*s
);
1063 extern int filter_assign_type(const char *type
);
1064 extern int create_event_filter(struct ftrace_event_call
*call
,
1065 char *filter_str
, bool set_str
,
1066 struct event_filter
**filterp
);
1067 extern void free_event_filter(struct event_filter
*filter
);
1069 struct ftrace_event_field
*
1070 trace_find_event_field(struct ftrace_event_call
*call
, char *name
);
1072 extern void trace_event_enable_cmd_record(bool enable
);
1073 extern int event_trace_add_tracer(struct dentry
*parent
, struct trace_array
*tr
);
1074 extern int event_trace_del_tracer(struct trace_array
*tr
);
1076 extern struct ftrace_event_file
*find_event_file(struct trace_array
*tr
,
1080 static inline void *event_file_data(struct file
*filp
)
1082 return ACCESS_ONCE(file_inode(filp
)->i_private
);
1085 extern struct mutex event_mutex
;
1086 extern struct list_head ftrace_events
;
1088 extern const struct file_operations event_trigger_fops
;
1090 extern int register_trigger_cmds(void);
1091 extern void clear_event_triggers(struct trace_array
*tr
);
1093 struct event_trigger_data
{
1094 unsigned long count
;
1096 struct event_trigger_ops
*ops
;
1097 struct event_command
*cmd_ops
;
1098 struct event_filter __rcu
*filter
;
1101 struct list_head list
;
1105 * struct event_trigger_ops - callbacks for trace event triggers
1107 * The methods in this structure provide per-event trigger hooks for
1108 * various trigger operations.
1110 * All the methods below, except for @init() and @free(), must be
1113 * @func: The trigger 'probe' function called when the triggering
1114 * event occurs. The data passed into this callback is the data
1115 * that was supplied to the event_command @reg() function that
1116 * registered the trigger (see struct event_command).
1118 * @init: An optional initialization function called for the trigger
1119 * when the trigger is registered (via the event_command reg()
1120 * function). This can be used to perform per-trigger
1121 * initialization such as incrementing a per-trigger reference
1122 * count, for instance. This is usually implemented by the
1123 * generic utility function @event_trigger_init() (see
1124 * trace_event_triggers.c).
1126 * @free: An optional de-initialization function called for the
1127 * trigger when the trigger is unregistered (via the
1128 * event_command @reg() function). This can be used to perform
1129 * per-trigger de-initialization such as decrementing a
1130 * per-trigger reference count and freeing corresponding trigger
1131 * data, for instance. This is usually implemented by the
1132 * generic utility function @event_trigger_free() (see
1133 * trace_event_triggers.c).
1135 * @print: The callback function invoked to have the trigger print
1136 * itself. This is usually implemented by a wrapper function
1137 * that calls the generic utility function @event_trigger_print()
1138 * (see trace_event_triggers.c).
1140 struct event_trigger_ops
{
1141 void (*func
)(struct event_trigger_data
*data
);
1142 int (*init
)(struct event_trigger_ops
*ops
,
1143 struct event_trigger_data
*data
);
1144 void (*free
)(struct event_trigger_ops
*ops
,
1145 struct event_trigger_data
*data
);
1146 int (*print
)(struct seq_file
*m
,
1147 struct event_trigger_ops
*ops
,
1148 struct event_trigger_data
*data
);
1152 * struct event_command - callbacks and data members for event commands
1154 * Event commands are invoked by users by writing the command name
1155 * into the 'trigger' file associated with a trace event. The
1156 * parameters associated with a specific invocation of an event
1157 * command are used to create an event trigger instance, which is
1158 * added to the list of trigger instances associated with that trace
1159 * event. When the event is hit, the set of triggers associated with
1160 * that event is invoked.
1162 * The data members in this structure provide per-event command data
1163 * for various event commands.
1165 * All the data members below, except for @post_trigger, must be set
1166 * for each event command.
1168 * @name: The unique name that identifies the event command. This is
1169 * the name used when setting triggers via trigger files.
1171 * @trigger_type: A unique id that identifies the event command
1172 * 'type'. This value has two purposes, the first to ensure that
1173 * only one trigger of the same type can be set at a given time
1174 * for a particular event e.g. it doesn't make sense to have both
1175 * a traceon and traceoff trigger attached to a single event at
1176 * the same time, so traceon and traceoff have the same type
1177 * though they have different names. The @trigger_type value is
1178 * also used as a bit value for deferring the actual trigger
1179 * action until after the current event is finished. Some
1180 * commands need to do this if they themselves log to the trace
1181 * buffer (see the @post_trigger() member below). @trigger_type
1182 * values are defined by adding new values to the trigger_type
1183 * enum in include/linux/ftrace_event.h.
1185 * @post_trigger: A flag that says whether or not this command needs
1186 * to have its action delayed until after the current event has
1187 * been closed. Some triggers need to avoid being invoked while
1188 * an event is currently in the process of being logged, since
1189 * the trigger may itself log data into the trace buffer. Thus
1190 * we make sure the current event is committed before invoking
1191 * those triggers. To do that, the trigger invocation is split
1192 * in two - the first part checks the filter using the current
1193 * trace record; if a command has the @post_trigger flag set, it
1194 * sets a bit for itself in the return value, otherwise it
1195 * directly invokes the trigger. Once all commands have been
1196 * either invoked or set their return flag, the current record is
1197 * either committed or discarded. At that point, if any commands
1198 * have deferred their triggers, those commands are finally
1199 * invoked following the close of the current event. In other
1200 * words, if the event_trigger_ops @func() probe implementation
1201 * itself logs to the trace buffer, this flag should be set,
1202 * otherwise it can be left unspecified.
1204 * All the methods below, except for @set_filter(), must be
1207 * @func: The callback function responsible for parsing and
1208 * registering the trigger written to the 'trigger' file by the
1209 * user. It allocates the trigger instance and registers it with
1210 * the appropriate trace event. It makes use of the other
1211 * event_command callback functions to orchestrate this, and is
1212 * usually implemented by the generic utility function
1213 * @event_trigger_callback() (see trace_event_triggers.c).
1215 * @reg: Adds the trigger to the list of triggers associated with the
1216 * event, and enables the event trigger itself, after
1217 * initializing it (via the event_trigger_ops @init() function).
1218 * This is also where commands can use the @trigger_type value to
1219 * make the decision as to whether or not multiple instances of
1220 * the trigger should be allowed. This is usually implemented by
1221 * the generic utility function @register_trigger() (see
1222 * trace_event_triggers.c).
1224 * @unreg: Removes the trigger from the list of triggers associated
1225 * with the event, and disables the event trigger itself, after
1226 * initializing it (via the event_trigger_ops @free() function).
1227 * This is usually implemented by the generic utility function
1228 * @unregister_trigger() (see trace_event_triggers.c).
1230 * @set_filter: An optional function called to parse and set a filter
1231 * for the trigger. If no @set_filter() method is set for the
1232 * event command, filters set by the user for the command will be
1233 * ignored. This is usually implemented by the generic utility
1234 * function @set_trigger_filter() (see trace_event_triggers.c).
1236 * @get_trigger_ops: The callback function invoked to retrieve the
1237 * event_trigger_ops implementation associated with the command.
1239 struct event_command
{
1240 struct list_head list
;
1242 enum event_trigger_type trigger_type
;
1244 int (*func
)(struct event_command
*cmd_ops
,
1245 struct ftrace_event_file
*file
,
1246 char *glob
, char *cmd
, char *params
);
1247 int (*reg
)(char *glob
,
1248 struct event_trigger_ops
*ops
,
1249 struct event_trigger_data
*data
,
1250 struct ftrace_event_file
*file
);
1251 void (*unreg
)(char *glob
,
1252 struct event_trigger_ops
*ops
,
1253 struct event_trigger_data
*data
,
1254 struct ftrace_event_file
*file
);
1255 int (*set_filter
)(char *filter_str
,
1256 struct event_trigger_data
*data
,
1257 struct ftrace_event_file
*file
);
1258 struct event_trigger_ops
*(*get_trigger_ops
)(char *cmd
, char *param
);
1261 extern int trace_event_enable_disable(struct ftrace_event_file
*file
,
1262 int enable
, int soft_disable
);
1263 extern int tracing_alloc_snapshot(void);
1265 extern const char *__start___trace_bprintk_fmt
[];
1266 extern const char *__stop___trace_bprintk_fmt
[];
1268 extern const char *__start___tracepoint_str
[];
1269 extern const char *__stop___tracepoint_str
[];
1271 void trace_printk_init_buffers(void);
1272 void trace_printk_start_comm(void);
1273 int trace_keep_overwrite(struct tracer
*tracer
, u32 mask
, int set
);
1274 int set_tracer_flag(struct trace_array
*tr
, unsigned int mask
, int enabled
);
1277 * Normal trace_printk() and friends allocates special buffers
1278 * to do the manipulation, as well as saves the print formats
1279 * into sections to display. But the trace infrastructure wants
1280 * to use these without the added overhead at the price of being
1281 * a bit slower (used mainly for warnings, where we don't care
1282 * about performance). The internal_trace_puts() is for such
1285 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1288 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1289 extern struct ftrace_event_call \
1290 __aligned(4) event_##call;
1291 #undef FTRACE_ENTRY_DUP
1292 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1293 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1295 #include "trace_entries.h"
1297 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1298 int perf_ftrace_event_register(struct ftrace_event_call
*call
,
1299 enum trace_reg type
, void *data
);
1301 #define perf_ftrace_event_register NULL
1304 #ifdef CONFIG_FTRACE_SYSCALLS
1305 void init_ftrace_syscalls(void);
1307 static inline void init_ftrace_syscalls(void) { }
1310 #ifdef CONFIG_EVENT_TRACING
1311 void trace_event_init(void);
1313 static inline void __init
trace_event_init(void) { }
1316 extern struct trace_iterator
*tracepoint_print_iter
;
1318 #endif /* _LINUX_KERNEL_TRACE_H */