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/trace_events.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 trace_event_file __rcu *enter_syscall_files[NR_syscalls];
215 struct trace_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 tracefs
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;
393 bool allow_instances;
394 #ifdef CONFIG_TRACER_MAX_TRACE
400 /* Only current can touch trace_recursion */
403 * For function tracing recursion:
404 * The order of these bits are important.
406 * When function tracing occurs, the following steps are made:
407 * If arch does not support a ftrace feature:
408 * call internal function (uses INTERNAL bits) which calls...
409 * If callback is registered to the "global" list, the list
410 * function is called and recursion checks the GLOBAL bits.
411 * then this function calls...
412 * The function callback, which can use the FTRACE bits to
413 * check for recursion.
415 * Now if the arch does not suppport a feature, and it calls
416 * the global list function which calls the ftrace callback
417 * all three of these steps will do a recursion protection.
418 * There's no reason to do one if the previous caller already
419 * did. The recursion that we are protecting against will
420 * go through the same steps again.
422 * To prevent the multiple recursion checks, if a recursion
423 * bit is set that is higher than the MAX bit of the current
424 * check, then we know that the check was made by the previous
425 * caller, and we can skip the current check.
429 TRACE_BUFFER_NMI_BIT,
430 TRACE_BUFFER_IRQ_BIT,
431 TRACE_BUFFER_SIRQ_BIT,
433 /* Start of function recursion bits */
435 TRACE_FTRACE_NMI_BIT,
436 TRACE_FTRACE_IRQ_BIT,
437 TRACE_FTRACE_SIRQ_BIT,
439 /* INTERNAL_BITs must be greater than FTRACE_BITs */
441 TRACE_INTERNAL_NMI_BIT,
442 TRACE_INTERNAL_IRQ_BIT,
443 TRACE_INTERNAL_SIRQ_BIT,
449 * Abuse of the trace_recursion.
450 * As we need a way to maintain state if we are tracing the function
451 * graph in irq because we want to trace a particular function that
452 * was called in irq context but we have irq tracing off. Since this
453 * can only be modified by current, we can reuse trace_recursion.
458 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
459 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
460 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
462 #define TRACE_CONTEXT_BITS 4
464 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
465 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
467 #define TRACE_LIST_START TRACE_INTERNAL_BIT
468 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
470 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
472 static __always_inline int trace_get_context_bit(void)
476 if (in_interrupt()) {
490 static __always_inline int trace_test_and_set_recursion(int start, int max)
492 unsigned int val = current->trace_recursion;
495 /* A previous recursion check was made */
496 if ((val & TRACE_CONTEXT_MASK) > max)
499 bit = trace_get_context_bit() + start;
500 if (unlikely(val & (1 << bit)))
504 current->trace_recursion = val;
510 static __always_inline void trace_clear_recursion(int bit)
512 unsigned int val = current->trace_recursion;
521 current->trace_recursion = val;
524 static inline struct ring_buffer_iter *
525 trace_buffer_iter(struct trace_iterator *iter, int cpu)
527 if (iter->buffer_iter && iter->buffer_iter[cpu])
528 return iter->buffer_iter[cpu];
532 int tracer_init(struct tracer *t, struct trace_array *tr);
533 int tracing_is_enabled(void);
534 void tracing_reset(struct trace_buffer *buf, int cpu);
535 void tracing_reset_online_cpus(struct trace_buffer *buf);
536 void tracing_reset_current(int cpu);
537 void tracing_reset_all_online_cpus(void);
538 int tracing_open_generic(struct inode *inode, struct file *filp);
539 bool tracing_is_disabled(void);
540 struct dentry *trace_create_file(const char *name,
542 struct dentry *parent,
544 const struct file_operations *fops);
546 struct dentry *tracing_init_dentry(void);
548 struct ring_buffer_event;
550 struct ring_buffer_event *
551 trace_buffer_lock_reserve(struct ring_buffer *buffer,
557 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
558 struct trace_array_cpu *data);
560 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
561 int *ent_cpu, u64 *ent_ts);
563 void __buffer_unlock_commit(struct ring_buffer *buffer,
564 struct ring_buffer_event *event);
566 int trace_empty(struct trace_iterator *iter);
568 void *trace_find_next_entry_inc(struct trace_iterator *iter);
570 void trace_init_global_iter(struct trace_iterator *iter);
572 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
574 void trace_function(struct trace_array *tr,
576 unsigned long parent_ip,
577 unsigned long flags, int pc);
578 void trace_graph_function(struct trace_array *tr,
580 unsigned long parent_ip,
581 unsigned long flags, int pc);
582 void trace_latency_header(struct seq_file *m);
583 void trace_default_header(struct seq_file *m);
584 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
585 int trace_empty(struct trace_iterator *iter);
587 void trace_graph_return(struct ftrace_graph_ret *trace);
588 int trace_graph_entry(struct ftrace_graph_ent *trace);
589 void set_graph_array(struct trace_array *tr);
591 void tracing_start_cmdline_record(void);
592 void tracing_stop_cmdline_record(void);
593 int register_tracer(struct tracer *type);
594 int is_tracing_stopped(void);
596 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
598 extern cpumask_var_t __read_mostly tracing_buffer_mask;
600 #define for_each_tracing_cpu(cpu) \
601 for_each_cpu(cpu, tracing_buffer_mask)
603 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
605 extern unsigned long tracing_thresh;
607 #ifdef CONFIG_TRACER_MAX_TRACE
608 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
609 void update_max_tr_single(struct trace_array *tr,
610 struct task_struct *tsk, int cpu);
611 #endif /* CONFIG_TRACER_MAX_TRACE */
613 #ifdef CONFIG_STACKTRACE
614 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
617 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
620 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
623 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
624 unsigned long flags, int skip, int pc)
628 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
629 unsigned long flags, int pc)
633 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
637 #endif /* CONFIG_STACKTRACE */
639 extern cycle_t ftrace_now(int cpu);
641 extern void trace_find_cmdline(int pid, char comm[]);
643 #ifdef CONFIG_DYNAMIC_FTRACE
644 extern unsigned long ftrace_update_tot_cnt;
646 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
647 extern int DYN_FTRACE_TEST_NAME(void);
648 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
649 extern int DYN_FTRACE_TEST_NAME2(void);
651 extern bool ring_buffer_expanded;
652 extern bool tracing_selftest_disabled;
653 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
655 #ifdef CONFIG_FTRACE_STARTUP_TEST
656 extern int trace_selftest_startup_function(struct tracer *trace,
657 struct trace_array *tr);
658 extern int trace_selftest_startup_function_graph(struct tracer *trace,
659 struct trace_array *tr);
660 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
661 struct trace_array *tr);
662 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
663 struct trace_array *tr);
664 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
665 struct trace_array *tr);
666 extern int trace_selftest_startup_wakeup(struct tracer *trace,
667 struct trace_array *tr);
668 extern int trace_selftest_startup_nop(struct tracer *trace,
669 struct trace_array *tr);
670 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
671 struct trace_array *tr);
672 extern int trace_selftest_startup_branch(struct tracer *trace,
673 struct trace_array *tr);
675 * Tracer data references selftest functions that only occur
676 * on boot up. These can be __init functions. Thus, when selftests
677 * are enabled, then the tracers need to reference __init functions.
679 #define __tracer_data __refdata
681 /* Tracers are seldom changed. Optimize when selftests are disabled. */
682 #define __tracer_data __read_mostly
683 #endif /* CONFIG_FTRACE_STARTUP_TEST */
685 extern void *head_page(struct trace_array_cpu *data);
686 extern unsigned long long ns2usecs(cycle_t nsec);
688 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
690 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
692 trace_array_vprintk(struct trace_array *tr,
693 unsigned long ip, const char *fmt, va_list args);
694 int trace_array_printk(struct trace_array *tr,
695 unsigned long ip, const char *fmt, ...);
696 int trace_array_printk_buf(struct ring_buffer *buffer,
697 unsigned long ip, const char *fmt, ...);
698 void trace_printk_seq(struct trace_seq *s);
699 enum print_line_t print_trace_line(struct trace_iterator *iter);
701 extern unsigned long trace_flags;
703 extern char trace_find_mark(unsigned long long duration);
705 /* Standard output formatting function used for function return traces */
706 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
709 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
710 #define TRACE_GRAPH_PRINT_CPU 0x2
711 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
712 #define TRACE_GRAPH_PRINT_PROC 0x8
713 #define TRACE_GRAPH_PRINT_DURATION 0x10
714 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
715 #define TRACE_GRAPH_PRINT_IRQS 0x40
716 #define TRACE_GRAPH_PRINT_TAIL 0x80
717 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
718 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
720 extern enum print_line_t
721 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
722 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
724 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
725 extern void graph_trace_open(struct trace_iterator *iter);
726 extern void graph_trace_close(struct trace_iterator *iter);
727 extern int __trace_graph_entry(struct trace_array *tr,
728 struct ftrace_graph_ent *trace,
729 unsigned long flags, int pc);
730 extern void __trace_graph_return(struct trace_array *tr,
731 struct ftrace_graph_ret *trace,
732 unsigned long flags, int pc);
735 #ifdef CONFIG_DYNAMIC_FTRACE
736 /* TODO: make this variable */
737 #define FTRACE_GRAPH_MAX_FUNCS 32
738 extern int ftrace_graph_count;
739 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
740 extern int ftrace_graph_notrace_count;
741 extern unsigned long ftrace_graph_notrace_funcs[FTRACE_GRAPH_MAX_FUNCS];
743 static inline int ftrace_graph_addr(unsigned long addr)
747 if (!ftrace_graph_count)
750 for (i = 0; i < ftrace_graph_count; i++) {
751 if (addr == ftrace_graph_funcs[i]) {
753 * If no irqs are to be traced, but a set_graph_function
754 * is set, and called by an interrupt handler, we still
758 trace_recursion_set(TRACE_IRQ_BIT);
760 trace_recursion_clear(TRACE_IRQ_BIT);
768 static inline int ftrace_graph_notrace_addr(unsigned long addr)
772 if (!ftrace_graph_notrace_count)
775 for (i = 0; i < ftrace_graph_notrace_count; i++) {
776 if (addr == ftrace_graph_notrace_funcs[i])
783 static inline int ftrace_graph_addr(unsigned long addr)
788 static inline int ftrace_graph_notrace_addr(unsigned long addr)
792 #endif /* CONFIG_DYNAMIC_FTRACE */
793 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
794 static inline enum print_line_t
795 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
797 return TRACE_TYPE_UNHANDLED;
799 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
801 extern struct list_head ftrace_pids;
803 #ifdef CONFIG_FUNCTION_TRACER
804 extern bool ftrace_filter_param __initdata;
805 static inline int ftrace_trace_task(struct task_struct *task)
807 if (list_empty(&ftrace_pids))
810 return test_tsk_trace_trace(task);
812 extern int ftrace_is_dead(void);
813 int ftrace_create_function_files(struct trace_array *tr,
814 struct dentry *parent);
815 void ftrace_destroy_function_files(struct trace_array *tr);
816 void ftrace_init_global_array_ops(struct trace_array *tr);
817 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
818 void ftrace_reset_array_ops(struct trace_array *tr);
819 int using_ftrace_ops_list_func(void);
821 static inline int ftrace_trace_task(struct task_struct *task)
825 static inline int ftrace_is_dead(void) { return 0; }
827 ftrace_create_function_files(struct trace_array *tr,
828 struct dentry *parent)
832 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
833 static inline __init void
834 ftrace_init_global_array_ops(struct trace_array *tr) { }
835 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
836 /* ftace_func_t type is not defined, use macro instead of static inline */
837 #define ftrace_init_array_ops(tr, func) do { } while (0)
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 trace_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 trace_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 trace_event_file *file,
1048 struct trace_seq *s);
1049 extern int apply_event_filter(struct trace_event_file *file,
1050 char *filter_string);
1051 extern int apply_subsystem_event_filter(struct trace_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 trace_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 trace_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 trace_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/trace_events.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 trace_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 trace_event_file *file);
1243 void (*unreg)(char *glob,
1244 struct event_trigger_ops *ops,
1245 struct event_trigger_data *data,
1246 struct trace_event_file *file);
1247 int (*set_filter)(char *filter_str,
1248 struct event_trigger_data *data,
1249 struct trace_event_file *file);
1250 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1253 extern int trace_event_enable_disable(struct trace_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 trace_event_call \
1282 __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 trace_event_call *call,
1291 enum trace_reg type, void *data);
1293 #define perf_ftrace_event_register NULL
1296 #ifdef CONFIG_FTRACE_SYSCALLS
1297 void init_ftrace_syscalls(void);
1299 static inline void init_ftrace_syscalls(void) { }
1302 #ifdef CONFIG_EVENT_TRACING
1303 void trace_event_init(void);
1304 void trace_event_enum_update(struct trace_enum_map **map, int len);
1306 static inline void __init trace_event_init(void) { }
1307 static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
1310 extern struct trace_iterator *tracepoint_print_iter;
1312 #endif /* _LINUX_KERNEL_TRACE_H */