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
123 * NEED_RESCHED_LAZY - lazy reschedule is requested
125 enum trace_flag_type {
126 TRACE_FLAG_IRQS_OFF = 0x01,
127 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
128 TRACE_FLAG_NEED_RESCHED = 0x04,
129 TRACE_FLAG_HARDIRQ = 0x08,
130 TRACE_FLAG_SOFTIRQ = 0x10,
131 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
132 TRACE_FLAG_NEED_RESCHED_LAZY = 0x40,
135 #define TRACE_BUF_SIZE 1024
140 * The CPU trace array - it consists of thousands of trace entries
141 * plus some other descriptor data: (for example which task started
144 struct trace_array_cpu {
146 void *buffer_page; /* ring buffer spare */
148 unsigned long entries;
149 unsigned long saved_latency;
150 unsigned long critical_start;
151 unsigned long critical_end;
152 unsigned long critical_sequence;
154 unsigned long policy;
155 unsigned long rt_priority;
156 unsigned long skipped_entries;
157 cycle_t preempt_timestamp;
160 char comm[TASK_COMM_LEN];
165 struct trace_buffer {
166 struct trace_array *tr;
167 struct ring_buffer *buffer;
168 struct trace_array_cpu __percpu *data;
174 * The trace array - an array of per-CPU trace arrays. This is the
175 * highest level data structure that individual tracers deal with.
176 * They have on/off state as well:
179 struct list_head list;
181 struct trace_buffer trace_buffer;
182 #ifdef CONFIG_TRACER_MAX_TRACE
184 * The max_buffer is used to snapshot the trace when a maximum
185 * latency is reached, or when the user initiates a snapshot.
186 * Some tracers will use this to store a maximum trace while
187 * it continues examining live traces.
189 * The buffers for the max_buffer are set up the same as the trace_buffer
190 * When a snapshot is taken, the buffer of the max_buffer is swapped
191 * with the buffer of the trace_buffer and the buffers are reset for
192 * the trace_buffer so the tracing can continue.
194 struct trace_buffer max_buffer;
195 bool allocated_snapshot;
196 unsigned long max_latency;
199 * max_lock is used to protect the swapping of buffers
200 * when taking a max snapshot. The buffers themselves are
201 * protected by per_cpu spinlocks. But the action of the swap
202 * needs its own lock.
204 * This is defined as a arch_spinlock_t in order to help
205 * with performance when lockdep debugging is enabled.
207 * It is also used in other places outside the update_max_tr
208 * so it needs to be defined outside of the
209 * CONFIG_TRACER_MAX_TRACE.
211 arch_spinlock_t max_lock;
213 #ifdef CONFIG_FTRACE_SYSCALLS
214 int sys_refcount_enter;
215 int sys_refcount_exit;
216 struct ftrace_event_file __rcu *enter_syscall_files[NR_syscalls];
217 struct ftrace_event_file __rcu *exit_syscall_files[NR_syscalls];
221 struct tracer *current_trace;
223 raw_spinlock_t start_lock;
225 struct dentry *options;
226 struct dentry *percpu_dir;
227 struct dentry *event_dir;
228 struct list_head systems;
229 struct list_head events;
230 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
232 #ifdef CONFIG_FUNCTION_TRACER
233 struct ftrace_ops *ops;
234 /* function tracing enabled */
235 int function_enabled;
240 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
243 extern struct list_head ftrace_trace_arrays;
245 extern struct mutex trace_types_lock;
247 extern int trace_array_get(struct trace_array *tr);
248 extern void trace_array_put(struct trace_array *tr);
251 * The global tracer (top) should be the first trace array added,
252 * but we check the flag anyway.
254 static inline struct trace_array *top_trace_array(void)
256 struct trace_array *tr;
258 if (list_empty(&ftrace_trace_arrays))
261 tr = list_entry(ftrace_trace_arrays.prev,
263 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
267 #define FTRACE_CMP_TYPE(var, type) \
268 __builtin_types_compatible_p(typeof(var), type *)
271 #define IF_ASSIGN(var, entry, etype, id) \
272 if (FTRACE_CMP_TYPE(var, etype)) { \
273 var = (typeof(var))(entry); \
274 WARN_ON(id && (entry)->type != id); \
278 /* Will cause compile errors if type is not found. */
279 extern void __ftrace_bad_type(void);
282 * The trace_assign_type is a verifier that the entry type is
283 * the same as the type being assigned. To add new types simply
284 * add a line with the following format:
286 * IF_ASSIGN(var, ent, type, id);
288 * Where "type" is the trace type that includes the trace_entry
289 * as the "ent" item. And "id" is the trace identifier that is
290 * used in the trace_type enum.
292 * If the type can have more than one id, then use zero.
294 #define trace_assign_type(var, ent) \
296 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
297 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
298 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
299 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
300 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
301 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
302 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
303 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
305 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
307 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
308 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
310 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
312 __ftrace_bad_type(); \
316 * An option specific to a tracer. This is a boolean value.
317 * The bit is the bit index that sets its value on the
318 * flags value in struct tracer_flags.
321 const char *name; /* Will appear on the trace_options file */
322 u32 bit; /* Mask assigned in val field in tracer_flags */
326 * The set of specific options for a tracer. Your tracer
327 * have to set the initial value of the flags val.
329 struct tracer_flags {
331 struct tracer_opt *opts;
334 /* Makes more easy to define a tracer opt */
335 #define TRACER_OPT(s, b) .name = #s, .bit = b
339 * struct tracer - a specific tracer and its callbacks to interact with tracefs
340 * @name: the name chosen to select it on the available_tracers file
341 * @init: called when one switches to this tracer (echo name > current_tracer)
342 * @reset: called when one switches to another tracer
343 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
344 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
345 * @update_thresh: called when tracing_thresh is updated
346 * @open: called when the trace file is opened
347 * @pipe_open: called when the trace_pipe file is opened
348 * @close: called when the trace file is released
349 * @pipe_close: called when the trace_pipe file is released
350 * @read: override the default read callback on trace_pipe
351 * @splice_read: override the default splice_read callback on trace_pipe
352 * @selftest: selftest to run on boot (see trace_selftest.c)
353 * @print_headers: override the first lines that describe your columns
354 * @print_line: callback that prints a trace
355 * @set_flag: signals one of your private flags changed (trace_options file)
356 * @flags: your private flags
360 int (*init)(struct trace_array *tr);
361 void (*reset)(struct trace_array *tr);
362 void (*start)(struct trace_array *tr);
363 void (*stop)(struct trace_array *tr);
364 int (*update_thresh)(struct trace_array *tr);
365 void (*open)(struct trace_iterator *iter);
366 void (*pipe_open)(struct trace_iterator *iter);
367 void (*close)(struct trace_iterator *iter);
368 void (*pipe_close)(struct trace_iterator *iter);
369 ssize_t (*read)(struct trace_iterator *iter,
370 struct file *filp, char __user *ubuf,
371 size_t cnt, loff_t *ppos);
372 ssize_t (*splice_read)(struct trace_iterator *iter,
375 struct pipe_inode_info *pipe,
378 #ifdef CONFIG_FTRACE_STARTUP_TEST
379 int (*selftest)(struct tracer *trace,
380 struct trace_array *tr);
382 void (*print_header)(struct seq_file *m);
383 enum print_line_t (*print_line)(struct trace_iterator *iter);
384 /* If you handled the flag setting, return 0 */
385 int (*set_flag)(struct trace_array *tr,
386 u32 old_flags, u32 bit, int set);
387 /* Return 0 if OK with change, else return non-zero */
388 int (*flag_changed)(struct trace_array *tr,
391 struct tracer_flags *flags;
395 bool allow_instances;
396 #ifdef CONFIG_TRACER_MAX_TRACE
402 /* Only current can touch trace_recursion */
405 * For function tracing recursion:
406 * The order of these bits are important.
408 * When function tracing occurs, the following steps are made:
409 * If arch does not support a ftrace feature:
410 * call internal function (uses INTERNAL bits) which calls...
411 * If callback is registered to the "global" list, the list
412 * function is called and recursion checks the GLOBAL bits.
413 * then this function calls...
414 * The function callback, which can use the FTRACE bits to
415 * check for recursion.
417 * Now if the arch does not suppport a feature, and it calls
418 * the global list function which calls the ftrace callback
419 * all three of these steps will do a recursion protection.
420 * There's no reason to do one if the previous caller already
421 * did. The recursion that we are protecting against will
422 * go through the same steps again.
424 * To prevent the multiple recursion checks, if a recursion
425 * bit is set that is higher than the MAX bit of the current
426 * check, then we know that the check was made by the previous
427 * caller, and we can skip the current check.
431 TRACE_BUFFER_NMI_BIT,
432 TRACE_BUFFER_IRQ_BIT,
433 TRACE_BUFFER_SIRQ_BIT,
435 /* Start of function recursion bits */
437 TRACE_FTRACE_NMI_BIT,
438 TRACE_FTRACE_IRQ_BIT,
439 TRACE_FTRACE_SIRQ_BIT,
441 /* INTERNAL_BITs must be greater than FTRACE_BITs */
443 TRACE_INTERNAL_NMI_BIT,
444 TRACE_INTERNAL_IRQ_BIT,
445 TRACE_INTERNAL_SIRQ_BIT,
451 * Abuse of the trace_recursion.
452 * As we need a way to maintain state if we are tracing the function
453 * graph in irq because we want to trace a particular function that
454 * was called in irq context but we have irq tracing off. Since this
455 * can only be modified by current, we can reuse trace_recursion.
460 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
461 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
462 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
464 #define TRACE_CONTEXT_BITS 4
466 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
467 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
469 #define TRACE_LIST_START TRACE_INTERNAL_BIT
470 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
472 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
474 static __always_inline int trace_get_context_bit(void)
478 if (in_interrupt()) {
492 static __always_inline int trace_test_and_set_recursion(int start, int max)
494 unsigned int val = current->trace_recursion;
497 /* A previous recursion check was made */
498 if ((val & TRACE_CONTEXT_MASK) > max)
501 bit = trace_get_context_bit() + start;
502 if (unlikely(val & (1 << bit)))
506 current->trace_recursion = val;
512 static __always_inline void trace_clear_recursion(int bit)
514 unsigned int val = current->trace_recursion;
523 current->trace_recursion = val;
526 static inline struct ring_buffer_iter *
527 trace_buffer_iter(struct trace_iterator *iter, int cpu)
529 if (iter->buffer_iter && iter->buffer_iter[cpu])
530 return iter->buffer_iter[cpu];
534 int tracer_init(struct tracer *t, struct trace_array *tr);
535 int tracing_is_enabled(void);
536 void tracing_reset(struct trace_buffer *buf, int cpu);
537 void tracing_reset_online_cpus(struct trace_buffer *buf);
538 void tracing_reset_current(int cpu);
539 void tracing_reset_all_online_cpus(void);
540 int tracing_open_generic(struct inode *inode, struct file *filp);
541 bool tracing_is_disabled(void);
542 struct dentry *trace_create_file(const char *name,
544 struct dentry *parent,
546 const struct file_operations *fops);
548 struct dentry *tracing_init_dentry(void);
550 struct ring_buffer_event;
552 struct ring_buffer_event *
553 trace_buffer_lock_reserve(struct ring_buffer *buffer,
559 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
560 struct trace_array_cpu *data);
562 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
563 int *ent_cpu, u64 *ent_ts);
565 void __buffer_unlock_commit(struct ring_buffer *buffer,
566 struct ring_buffer_event *event);
568 int trace_empty(struct trace_iterator *iter);
570 void *trace_find_next_entry_inc(struct trace_iterator *iter);
572 void trace_init_global_iter(struct trace_iterator *iter);
574 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
576 void trace_function(struct trace_array *tr,
578 unsigned long parent_ip,
579 unsigned long flags, int pc);
580 void trace_graph_function(struct trace_array *tr,
582 unsigned long parent_ip,
583 unsigned long flags, int pc);
584 void trace_latency_header(struct seq_file *m);
585 void trace_default_header(struct seq_file *m);
586 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
587 int trace_empty(struct trace_iterator *iter);
589 void trace_graph_return(struct ftrace_graph_ret *trace);
590 int trace_graph_entry(struct ftrace_graph_ent *trace);
591 void set_graph_array(struct trace_array *tr);
593 void tracing_start_cmdline_record(void);
594 void tracing_stop_cmdline_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 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
611 void update_max_tr_single(struct trace_array *tr,
612 struct task_struct *tsk, int cpu);
613 #endif /* CONFIG_TRACER_MAX_TRACE */
615 #ifdef CONFIG_STACKTRACE
616 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
619 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
620 int skip, int pc, struct pt_regs *regs);
622 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
625 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
628 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
629 unsigned long flags, int skip, int pc)
633 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
634 unsigned long flags, int skip,
635 int pc, struct pt_regs *regs)
639 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
640 unsigned long flags, int pc)
644 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
648 #endif /* CONFIG_STACKTRACE */
650 extern cycle_t ftrace_now(int cpu);
652 extern void trace_find_cmdline(int pid, char comm[]);
654 #ifdef CONFIG_DYNAMIC_FTRACE
655 extern unsigned long ftrace_update_tot_cnt;
657 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
658 extern int DYN_FTRACE_TEST_NAME(void);
659 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
660 extern int DYN_FTRACE_TEST_NAME2(void);
662 extern bool ring_buffer_expanded;
663 extern bool tracing_selftest_disabled;
664 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
666 #ifdef CONFIG_FTRACE_STARTUP_TEST
667 extern int trace_selftest_startup_function(struct tracer *trace,
668 struct trace_array *tr);
669 extern int trace_selftest_startup_function_graph(struct tracer *trace,
670 struct trace_array *tr);
671 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
672 struct trace_array *tr);
673 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
674 struct trace_array *tr);
675 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
676 struct trace_array *tr);
677 extern int trace_selftest_startup_wakeup(struct tracer *trace,
678 struct trace_array *tr);
679 extern int trace_selftest_startup_nop(struct tracer *trace,
680 struct trace_array *tr);
681 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
682 struct trace_array *tr);
683 extern int trace_selftest_startup_branch(struct tracer *trace,
684 struct trace_array *tr);
686 * Tracer data references selftest functions that only occur
687 * on boot up. These can be __init functions. Thus, when selftests
688 * are enabled, then the tracers need to reference __init functions.
690 #define __tracer_data __refdata
692 /* Tracers are seldom changed. Optimize when selftests are disabled. */
693 #define __tracer_data __read_mostly
694 #endif /* CONFIG_FTRACE_STARTUP_TEST */
696 extern void *head_page(struct trace_array_cpu *data);
697 extern unsigned long long ns2usecs(cycle_t nsec);
699 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
701 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
703 trace_array_vprintk(struct trace_array *tr,
704 unsigned long ip, const char *fmt, va_list args);
705 int trace_array_printk(struct trace_array *tr,
706 unsigned long ip, const char *fmt, ...);
707 int trace_array_printk_buf(struct ring_buffer *buffer,
708 unsigned long ip, const char *fmt, ...);
709 void trace_printk_seq(struct trace_seq *s);
710 enum print_line_t print_trace_line(struct trace_iterator *iter);
712 extern unsigned long trace_flags;
714 extern char trace_find_mark(unsigned long long duration);
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_IRQS 0x40
727 #define TRACE_GRAPH_PRINT_TAIL 0x80
728 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
729 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
731 extern enum print_line_t
732 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
733 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
735 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
736 extern void graph_trace_open(struct trace_iterator *iter);
737 extern void graph_trace_close(struct trace_iterator *iter);
738 extern int __trace_graph_entry(struct trace_array *tr,
739 struct ftrace_graph_ent *trace,
740 unsigned long flags, int pc);
741 extern void __trace_graph_return(struct trace_array *tr,
742 struct ftrace_graph_ret *trace,
743 unsigned long flags, int pc);
746 #ifdef CONFIG_DYNAMIC_FTRACE
747 /* TODO: make this variable */
748 #define FTRACE_GRAPH_MAX_FUNCS 32
749 extern int ftrace_graph_count;
750 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
751 extern int ftrace_graph_notrace_count;
752 extern unsigned long ftrace_graph_notrace_funcs[FTRACE_GRAPH_MAX_FUNCS];
754 static inline int ftrace_graph_addr(unsigned long addr)
758 if (!ftrace_graph_count)
761 for (i = 0; i < ftrace_graph_count; i++) {
762 if (addr == ftrace_graph_funcs[i]) {
764 * If no irqs are to be traced, but a set_graph_function
765 * is set, and called by an interrupt handler, we still
769 trace_recursion_set(TRACE_IRQ_BIT);
771 trace_recursion_clear(TRACE_IRQ_BIT);
779 static inline int ftrace_graph_notrace_addr(unsigned long addr)
783 if (!ftrace_graph_notrace_count)
786 for (i = 0; i < ftrace_graph_notrace_count; i++) {
787 if (addr == ftrace_graph_notrace_funcs[i])
794 static inline int ftrace_graph_addr(unsigned long addr)
799 static inline int ftrace_graph_notrace_addr(unsigned long addr)
803 #endif /* CONFIG_DYNAMIC_FTRACE */
804 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
805 static inline enum print_line_t
806 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
808 return TRACE_TYPE_UNHANDLED;
810 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
812 extern struct list_head ftrace_pids;
814 #ifdef CONFIG_FUNCTION_TRACER
815 extern bool ftrace_filter_param __initdata;
816 static inline int ftrace_trace_task(struct task_struct *task)
818 if (list_empty(&ftrace_pids))
821 return test_tsk_trace_trace(task);
823 extern int ftrace_is_dead(void);
824 int ftrace_create_function_files(struct trace_array *tr,
825 struct dentry *parent);
826 void ftrace_destroy_function_files(struct trace_array *tr);
827 void ftrace_init_global_array_ops(struct trace_array *tr);
828 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
829 void ftrace_reset_array_ops(struct trace_array *tr);
830 int using_ftrace_ops_list_func(void);
832 static inline int ftrace_trace_task(struct task_struct *task)
836 static inline int ftrace_is_dead(void) { return 0; }
838 ftrace_create_function_files(struct trace_array *tr,
839 struct dentry *parent)
843 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
844 static inline __init void
845 ftrace_init_global_array_ops(struct trace_array *tr) { }
846 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
847 /* ftace_func_t type is not defined, use macro instead of static inline */
848 #define ftrace_init_array_ops(tr, func) do { } while (0)
849 #endif /* CONFIG_FUNCTION_TRACER */
851 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
852 void ftrace_create_filter_files(struct ftrace_ops *ops,
853 struct dentry *parent);
854 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
857 * The ops parameter passed in is usually undefined.
858 * This must be a macro.
860 #define ftrace_create_filter_files(ops, parent) do { } while (0)
861 #define ftrace_destroy_filter_files(ops) do { } while (0)
862 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
864 int ftrace_event_is_function(struct ftrace_event_call *call);
867 * struct trace_parser - servers for reading the user input separated by spaces
868 * @cont: set if the input is not complete - no final space char was found
869 * @buffer: holds the parsed user input
870 * @idx: user input length
873 struct trace_parser {
880 static inline bool trace_parser_loaded(struct trace_parser *parser)
882 return (parser->idx != 0);
885 static inline bool trace_parser_cont(struct trace_parser *parser)
890 static inline void trace_parser_clear(struct trace_parser *parser)
892 parser->cont = false;
896 extern int trace_parser_get_init(struct trace_parser *parser, int size);
897 extern void trace_parser_put(struct trace_parser *parser);
898 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
899 size_t cnt, loff_t *ppos);
902 * trace_iterator_flags is an enumeration that defines bit
903 * positions into trace_flags that controls the output.
905 * NOTE: These bits must match the trace_options array in
908 enum trace_iterator_flags {
909 TRACE_ITER_PRINT_PARENT = 0x01,
910 TRACE_ITER_SYM_OFFSET = 0x02,
911 TRACE_ITER_SYM_ADDR = 0x04,
912 TRACE_ITER_VERBOSE = 0x08,
913 TRACE_ITER_RAW = 0x10,
914 TRACE_ITER_HEX = 0x20,
915 TRACE_ITER_BIN = 0x40,
916 TRACE_ITER_BLOCK = 0x80,
917 TRACE_ITER_STACKTRACE = 0x100,
918 TRACE_ITER_PRINTK = 0x200,
919 TRACE_ITER_PREEMPTONLY = 0x400,
920 TRACE_ITER_BRANCH = 0x800,
921 TRACE_ITER_ANNOTATE = 0x1000,
922 TRACE_ITER_USERSTACKTRACE = 0x2000,
923 TRACE_ITER_SYM_USEROBJ = 0x4000,
924 TRACE_ITER_PRINTK_MSGONLY = 0x8000,
925 TRACE_ITER_CONTEXT_INFO = 0x10000, /* Print pid/cpu/time */
926 TRACE_ITER_LATENCY_FMT = 0x20000,
927 TRACE_ITER_SLEEP_TIME = 0x40000,
928 TRACE_ITER_GRAPH_TIME = 0x80000,
929 TRACE_ITER_RECORD_CMD = 0x100000,
930 TRACE_ITER_OVERWRITE = 0x200000,
931 TRACE_ITER_STOP_ON_FREE = 0x400000,
932 TRACE_ITER_IRQ_INFO = 0x800000,
933 TRACE_ITER_MARKERS = 0x1000000,
934 TRACE_ITER_FUNCTION = 0x2000000,
938 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
939 * control the output of kernel symbols.
941 #define TRACE_ITER_SYM_MASK \
942 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
944 extern struct tracer nop_trace;
946 #ifdef CONFIG_BRANCH_TRACER
947 extern int enable_branch_tracing(struct trace_array *tr);
948 extern void disable_branch_tracing(void);
949 static inline int trace_branch_enable(struct trace_array *tr)
951 if (trace_flags & TRACE_ITER_BRANCH)
952 return enable_branch_tracing(tr);
955 static inline void trace_branch_disable(void)
957 /* due to races, always disable */
958 disable_branch_tracing();
961 static inline int trace_branch_enable(struct trace_array *tr)
965 static inline void trace_branch_disable(void)
968 #endif /* CONFIG_BRANCH_TRACER */
970 /* set ring buffers to default size if not already done so */
971 int tracing_update_buffers(void);
973 struct ftrace_event_field {
974 struct list_head link;
983 struct event_filter {
984 int n_preds; /* Number assigned */
985 int a_preds; /* allocated */
986 struct filter_pred *preds;
987 struct filter_pred *root;
991 struct event_subsystem {
992 struct list_head list;
994 struct event_filter *filter;
998 struct ftrace_subsystem_dir {
999 struct list_head list;
1000 struct event_subsystem *subsystem;
1001 struct trace_array *tr;
1002 struct dentry *entry;
1007 #define FILTER_PRED_INVALID ((unsigned short)-1)
1008 #define FILTER_PRED_IS_RIGHT (1 << 15)
1009 #define FILTER_PRED_FOLD (1 << 15)
1012 * The max preds is the size of unsigned short with
1013 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1014 * and FOLD flags. The other is reserved.
1016 * 2^14 preds is way more than enough.
1018 #define MAX_FILTER_PRED 16384
1023 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1025 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1035 char pattern[MAX_FILTER_STR_VAL];
1038 regex_match_func match;
1041 struct filter_pred {
1042 filter_pred_fn_t fn;
1045 unsigned short *ops;
1046 struct ftrace_event_field *field;
1050 unsigned short index;
1051 unsigned short parent;
1052 unsigned short left;
1053 unsigned short right;
1056 extern enum regex_type
1057 filter_parse_regex(char *buff, int len, char **search, int *not);
1058 extern void print_event_filter(struct ftrace_event_file *file,
1059 struct trace_seq *s);
1060 extern int apply_event_filter(struct ftrace_event_file *file,
1061 char *filter_string);
1062 extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir *dir,
1063 char *filter_string);
1064 extern void print_subsystem_event_filter(struct event_subsystem *system,
1065 struct trace_seq *s);
1066 extern int filter_assign_type(const char *type);
1067 extern int create_event_filter(struct ftrace_event_call *call,
1068 char *filter_str, bool set_str,
1069 struct event_filter **filterp);
1070 extern void free_event_filter(struct event_filter *filter);
1072 struct ftrace_event_field *
1073 trace_find_event_field(struct ftrace_event_call *call, char *name);
1075 extern void trace_event_enable_cmd_record(bool enable);
1076 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1077 extern int event_trace_del_tracer(struct trace_array *tr);
1079 extern struct ftrace_event_file *find_event_file(struct trace_array *tr,
1083 static inline void *event_file_data(struct file *filp)
1085 return ACCESS_ONCE(file_inode(filp)->i_private);
1088 extern struct mutex event_mutex;
1089 extern struct list_head ftrace_events;
1091 extern const struct file_operations event_trigger_fops;
1093 extern int register_trigger_cmds(void);
1094 extern void clear_event_triggers(struct trace_array *tr);
1096 struct event_trigger_data {
1097 unsigned long count;
1099 struct event_trigger_ops *ops;
1100 struct event_command *cmd_ops;
1101 struct event_filter __rcu *filter;
1104 struct list_head list;
1108 * struct event_trigger_ops - callbacks for trace event triggers
1110 * The methods in this structure provide per-event trigger hooks for
1111 * various trigger operations.
1113 * All the methods below, except for @init() and @free(), must be
1116 * @func: The trigger 'probe' function called when the triggering
1117 * event occurs. The data passed into this callback is the data
1118 * that was supplied to the event_command @reg() function that
1119 * registered the trigger (see struct event_command).
1121 * @init: An optional initialization function called for the trigger
1122 * when the trigger is registered (via the event_command reg()
1123 * function). This can be used to perform per-trigger
1124 * initialization such as incrementing a per-trigger reference
1125 * count, for instance. This is usually implemented by the
1126 * generic utility function @event_trigger_init() (see
1127 * trace_event_triggers.c).
1129 * @free: An optional de-initialization function called for the
1130 * trigger when the trigger is unregistered (via the
1131 * event_command @reg() function). This can be used to perform
1132 * per-trigger de-initialization such as decrementing a
1133 * per-trigger reference count and freeing corresponding trigger
1134 * data, for instance. This is usually implemented by the
1135 * generic utility function @event_trigger_free() (see
1136 * trace_event_triggers.c).
1138 * @print: The callback function invoked to have the trigger print
1139 * itself. This is usually implemented by a wrapper function
1140 * that calls the generic utility function @event_trigger_print()
1141 * (see trace_event_triggers.c).
1143 struct event_trigger_ops {
1144 void (*func)(struct event_trigger_data *data);
1145 int (*init)(struct event_trigger_ops *ops,
1146 struct event_trigger_data *data);
1147 void (*free)(struct event_trigger_ops *ops,
1148 struct event_trigger_data *data);
1149 int (*print)(struct seq_file *m,
1150 struct event_trigger_ops *ops,
1151 struct event_trigger_data *data);
1155 * struct event_command - callbacks and data members for event commands
1157 * Event commands are invoked by users by writing the command name
1158 * into the 'trigger' file associated with a trace event. The
1159 * parameters associated with a specific invocation of an event
1160 * command are used to create an event trigger instance, which is
1161 * added to the list of trigger instances associated with that trace
1162 * event. When the event is hit, the set of triggers associated with
1163 * that event is invoked.
1165 * The data members in this structure provide per-event command data
1166 * for various event commands.
1168 * All the data members below, except for @post_trigger, must be set
1169 * for each event command.
1171 * @name: The unique name that identifies the event command. This is
1172 * the name used when setting triggers via trigger files.
1174 * @trigger_type: A unique id that identifies the event command
1175 * 'type'. This value has two purposes, the first to ensure that
1176 * only one trigger of the same type can be set at a given time
1177 * for a particular event e.g. it doesn't make sense to have both
1178 * a traceon and traceoff trigger attached to a single event at
1179 * the same time, so traceon and traceoff have the same type
1180 * though they have different names. The @trigger_type value is
1181 * also used as a bit value for deferring the actual trigger
1182 * action until after the current event is finished. Some
1183 * commands need to do this if they themselves log to the trace
1184 * buffer (see the @post_trigger() member below). @trigger_type
1185 * values are defined by adding new values to the trigger_type
1186 * enum in include/linux/ftrace_event.h.
1188 * @post_trigger: A flag that says whether or not this command needs
1189 * to have its action delayed until after the current event has
1190 * been closed. Some triggers need to avoid being invoked while
1191 * an event is currently in the process of being logged, since
1192 * the trigger may itself log data into the trace buffer. Thus
1193 * we make sure the current event is committed before invoking
1194 * those triggers. To do that, the trigger invocation is split
1195 * in two - the first part checks the filter using the current
1196 * trace record; if a command has the @post_trigger flag set, it
1197 * sets a bit for itself in the return value, otherwise it
1198 * directly invokes the trigger. Once all commands have been
1199 * either invoked or set their return flag, the current record is
1200 * either committed or discarded. At that point, if any commands
1201 * have deferred their triggers, those commands are finally
1202 * invoked following the close of the current event. In other
1203 * words, if the event_trigger_ops @func() probe implementation
1204 * itself logs to the trace buffer, this flag should be set,
1205 * otherwise it can be left unspecified.
1207 * All the methods below, except for @set_filter(), must be
1210 * @func: The callback function responsible for parsing and
1211 * registering the trigger written to the 'trigger' file by the
1212 * user. It allocates the trigger instance and registers it with
1213 * the appropriate trace event. It makes use of the other
1214 * event_command callback functions to orchestrate this, and is
1215 * usually implemented by the generic utility function
1216 * @event_trigger_callback() (see trace_event_triggers.c).
1218 * @reg: Adds the trigger to the list of triggers associated with the
1219 * event, and enables the event trigger itself, after
1220 * initializing it (via the event_trigger_ops @init() function).
1221 * This is also where commands can use the @trigger_type value to
1222 * make the decision as to whether or not multiple instances of
1223 * the trigger should be allowed. This is usually implemented by
1224 * the generic utility function @register_trigger() (see
1225 * trace_event_triggers.c).
1227 * @unreg: Removes the trigger from the list of triggers associated
1228 * with the event, and disables the event trigger itself, after
1229 * initializing it (via the event_trigger_ops @free() function).
1230 * This is usually implemented by the generic utility function
1231 * @unregister_trigger() (see trace_event_triggers.c).
1233 * @set_filter: An optional function called to parse and set a filter
1234 * for the trigger. If no @set_filter() method is set for the
1235 * event command, filters set by the user for the command will be
1236 * ignored. This is usually implemented by the generic utility
1237 * function @set_trigger_filter() (see trace_event_triggers.c).
1239 * @get_trigger_ops: The callback function invoked to retrieve the
1240 * event_trigger_ops implementation associated with the command.
1242 struct event_command {
1243 struct list_head list;
1245 enum event_trigger_type trigger_type;
1247 int (*func)(struct event_command *cmd_ops,
1248 struct ftrace_event_file *file,
1249 char *glob, char *cmd, char *params);
1250 int (*reg)(char *glob,
1251 struct event_trigger_ops *ops,
1252 struct event_trigger_data *data,
1253 struct ftrace_event_file *file);
1254 void (*unreg)(char *glob,
1255 struct event_trigger_ops *ops,
1256 struct event_trigger_data *data,
1257 struct ftrace_event_file *file);
1258 int (*set_filter)(char *filter_str,
1259 struct event_trigger_data *data,
1260 struct ftrace_event_file *file);
1261 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1264 extern int trace_event_enable_disable(struct ftrace_event_file *file,
1265 int enable, int soft_disable);
1266 extern int tracing_alloc_snapshot(void);
1268 extern const char *__start___trace_bprintk_fmt[];
1269 extern const char *__stop___trace_bprintk_fmt[];
1271 extern const char *__start___tracepoint_str[];
1272 extern const char *__stop___tracepoint_str[];
1274 void trace_printk_init_buffers(void);
1275 void trace_printk_start_comm(void);
1276 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1277 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1280 * Normal trace_printk() and friends allocates special buffers
1281 * to do the manipulation, as well as saves the print formats
1282 * into sections to display. But the trace infrastructure wants
1283 * to use these without the added overhead at the price of being
1284 * a bit slower (used mainly for warnings, where we don't care
1285 * about performance). The internal_trace_puts() is for such
1288 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1291 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1292 extern struct ftrace_event_call \
1293 __aligned(4) event_##call;
1294 #undef FTRACE_ENTRY_DUP
1295 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1296 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1298 #include "trace_entries.h"
1300 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1301 int perf_ftrace_event_register(struct ftrace_event_call *call,
1302 enum trace_reg type, void *data);
1304 #define perf_ftrace_event_register NULL
1307 #ifdef CONFIG_FTRACE_SYSCALLS
1308 void init_ftrace_syscalls(void);
1310 static inline void init_ftrace_syscalls(void) { }
1313 #ifdef CONFIG_EVENT_TRACING
1314 void trace_event_init(void);
1315 void trace_event_enum_update(struct trace_enum_map **map, int len);
1317 static inline void __init trace_event_init(void) { }
1318 static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
1321 extern struct trace_iterator *tracepoint_print_iter;
1323 #endif /* _LINUX_KERNEL_TRACE_H */