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_userstack(struct ring_buffer *buffer, unsigned long flags,
617 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
620 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
621 unsigned long flags, int pc)
625 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
629 #endif /* CONFIG_STACKTRACE */
631 extern cycle_t ftrace_now(int cpu);
633 extern void trace_find_cmdline(int pid, char comm[]);
635 #ifdef CONFIG_DYNAMIC_FTRACE
636 extern unsigned long ftrace_update_tot_cnt;
638 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
639 extern int DYN_FTRACE_TEST_NAME(void);
640 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
641 extern int DYN_FTRACE_TEST_NAME2(void);
643 extern bool ring_buffer_expanded;
644 extern bool tracing_selftest_disabled;
645 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
647 #ifdef CONFIG_FTRACE_STARTUP_TEST
648 extern int trace_selftest_startup_function(struct tracer *trace,
649 struct trace_array *tr);
650 extern int trace_selftest_startup_function_graph(struct tracer *trace,
651 struct trace_array *tr);
652 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
653 struct trace_array *tr);
654 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
655 struct trace_array *tr);
656 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
657 struct trace_array *tr);
658 extern int trace_selftest_startup_wakeup(struct tracer *trace,
659 struct trace_array *tr);
660 extern int trace_selftest_startup_nop(struct tracer *trace,
661 struct trace_array *tr);
662 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
663 struct trace_array *tr);
664 extern int trace_selftest_startup_branch(struct tracer *trace,
665 struct trace_array *tr);
667 * Tracer data references selftest functions that only occur
668 * on boot up. These can be __init functions. Thus, when selftests
669 * are enabled, then the tracers need to reference __init functions.
671 #define __tracer_data __refdata
673 /* Tracers are seldom changed. Optimize when selftests are disabled. */
674 #define __tracer_data __read_mostly
675 #endif /* CONFIG_FTRACE_STARTUP_TEST */
677 extern void *head_page(struct trace_array_cpu *data);
678 extern unsigned long long ns2usecs(cycle_t nsec);
680 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
682 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
684 trace_array_vprintk(struct trace_array *tr,
685 unsigned long ip, const char *fmt, va_list args);
686 int trace_array_printk(struct trace_array *tr,
687 unsigned long ip, const char *fmt, ...);
688 int trace_array_printk_buf(struct ring_buffer *buffer,
689 unsigned long ip, const char *fmt, ...);
690 void trace_printk_seq(struct trace_seq *s);
691 enum print_line_t print_trace_line(struct trace_iterator *iter);
693 extern unsigned long trace_flags;
695 extern char trace_find_mark(unsigned long long duration);
697 /* Standard output formatting function used for function return traces */
698 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
701 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
702 #define TRACE_GRAPH_PRINT_CPU 0x2
703 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
704 #define TRACE_GRAPH_PRINT_PROC 0x8
705 #define TRACE_GRAPH_PRINT_DURATION 0x10
706 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
707 #define TRACE_GRAPH_PRINT_IRQS 0x40
708 #define TRACE_GRAPH_PRINT_TAIL 0x80
709 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
710 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
712 extern enum print_line_t
713 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
714 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
716 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
717 extern void graph_trace_open(struct trace_iterator *iter);
718 extern void graph_trace_close(struct trace_iterator *iter);
719 extern int __trace_graph_entry(struct trace_array *tr,
720 struct ftrace_graph_ent *trace,
721 unsigned long flags, int pc);
722 extern void __trace_graph_return(struct trace_array *tr,
723 struct ftrace_graph_ret *trace,
724 unsigned long flags, int pc);
727 #ifdef CONFIG_DYNAMIC_FTRACE
728 /* TODO: make this variable */
729 #define FTRACE_GRAPH_MAX_FUNCS 32
730 extern int ftrace_graph_count;
731 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
732 extern int ftrace_graph_notrace_count;
733 extern unsigned long ftrace_graph_notrace_funcs[FTRACE_GRAPH_MAX_FUNCS];
735 static inline int ftrace_graph_addr(unsigned long addr)
739 if (!ftrace_graph_count)
742 for (i = 0; i < ftrace_graph_count; i++) {
743 if (addr == ftrace_graph_funcs[i]) {
745 * If no irqs are to be traced, but a set_graph_function
746 * is set, and called by an interrupt handler, we still
750 trace_recursion_set(TRACE_IRQ_BIT);
752 trace_recursion_clear(TRACE_IRQ_BIT);
760 static inline int ftrace_graph_notrace_addr(unsigned long addr)
764 if (!ftrace_graph_notrace_count)
767 for (i = 0; i < ftrace_graph_notrace_count; i++) {
768 if (addr == ftrace_graph_notrace_funcs[i])
775 static inline int ftrace_graph_addr(unsigned long addr)
780 static inline int ftrace_graph_notrace_addr(unsigned long addr)
784 #endif /* CONFIG_DYNAMIC_FTRACE */
785 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
786 static inline enum print_line_t
787 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
789 return TRACE_TYPE_UNHANDLED;
791 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
793 extern struct list_head ftrace_pids;
795 #ifdef CONFIG_FUNCTION_TRACER
796 extern bool ftrace_filter_param __initdata;
797 static inline int ftrace_trace_task(struct task_struct *task)
799 if (list_empty(&ftrace_pids))
802 return test_tsk_trace_trace(task);
804 extern int ftrace_is_dead(void);
805 int ftrace_create_function_files(struct trace_array *tr,
806 struct dentry *parent);
807 void ftrace_destroy_function_files(struct trace_array *tr);
808 void ftrace_init_global_array_ops(struct trace_array *tr);
809 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
810 void ftrace_reset_array_ops(struct trace_array *tr);
811 int using_ftrace_ops_list_func(void);
813 static inline int ftrace_trace_task(struct task_struct *task)
817 static inline int ftrace_is_dead(void) { return 0; }
819 ftrace_create_function_files(struct trace_array *tr,
820 struct dentry *parent)
824 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
825 static inline __init void
826 ftrace_init_global_array_ops(struct trace_array *tr) { }
827 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
828 /* ftace_func_t type is not defined, use macro instead of static inline */
829 #define ftrace_init_array_ops(tr, func) do { } while (0)
830 #endif /* CONFIG_FUNCTION_TRACER */
832 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
833 void ftrace_create_filter_files(struct ftrace_ops *ops,
834 struct dentry *parent);
835 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
838 * The ops parameter passed in is usually undefined.
839 * This must be a macro.
841 #define ftrace_create_filter_files(ops, parent) do { } while (0)
842 #define ftrace_destroy_filter_files(ops) do { } while (0)
843 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
845 int ftrace_event_is_function(struct trace_event_call *call);
848 * struct trace_parser - servers for reading the user input separated by spaces
849 * @cont: set if the input is not complete - no final space char was found
850 * @buffer: holds the parsed user input
851 * @idx: user input length
854 struct trace_parser {
861 static inline bool trace_parser_loaded(struct trace_parser *parser)
863 return (parser->idx != 0);
866 static inline bool trace_parser_cont(struct trace_parser *parser)
871 static inline void trace_parser_clear(struct trace_parser *parser)
873 parser->cont = false;
877 extern int trace_parser_get_init(struct trace_parser *parser, int size);
878 extern void trace_parser_put(struct trace_parser *parser);
879 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
880 size_t cnt, loff_t *ppos);
883 * Only create function graph options if function graph is configured.
885 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
886 # define FGRAPH_FLAGS \
887 C(SLEEP_TIME, "sleep-time"), \
888 C(GRAPH_TIME, "graph-time"), \
889 C(DISPLAY_GRAPH, "display-graph"),
890 /* Initially set for trace_flags */
891 # define FUNCTION_GRAPH_DEFAULT_FLAGS \
892 (TRACE_ITER_SLEEP_TIME | TRACE_ITER_GRAPH_TIME)
894 # define FGRAPH_FLAGS
895 # define FUNCTION_GRAPH_DEFAULT_FLAGS 0UL
898 #ifdef CONFIG_BRANCH_TRACER
899 # define BRANCH_FLAGS \
902 # define BRANCH_FLAGS
905 #ifdef CONFIG_FUNCTION_TRACER
906 # define FUNCTION_FLAGS \
907 C(FUNCTION, "function-trace"),
908 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
910 # define FUNCTION_FLAGS
911 # define FUNCTION_DEFAULT_FLAGS 0UL
914 #ifdef CONFIG_STACKTRACE
915 # define STACK_FLAGS \
916 C(STACKTRACE, "stacktrace"),
922 * trace_iterator_flags is an enumeration that defines bit
923 * positions into trace_flags that controls the output.
925 * NOTE: These bits must match the trace_options array in
926 * trace.c (this macro guarantees it).
928 #define TRACE_FLAGS \
929 C(PRINT_PARENT, "print-parent"), \
930 C(SYM_OFFSET, "sym-offset"), \
931 C(SYM_ADDR, "sym-addr"), \
932 C(VERBOSE, "verbose"), \
937 C(PRINTK, "trace_printk"), \
938 C(ANNOTATE, "annotate"), \
939 C(USERSTACKTRACE, "userstacktrace"), \
940 C(SYM_USEROBJ, "sym-userobj"), \
941 C(PRINTK_MSGONLY, "printk-msg-only"), \
942 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
943 C(LATENCY_FMT, "latency-format"), \
944 C(RECORD_CMD, "record-cmd"), \
945 C(OVERWRITE, "overwrite"), \
946 C(STOP_ON_FREE, "disable_on_free"), \
947 C(IRQ_INFO, "irq-info"), \
948 C(MARKERS, "markers"), \
955 * By defining C, we can make TRACE_FLAGS a list of bit names
956 * that will define the bits for the flag masks.
959 #define C(a, b) TRACE_ITER_##a##_BIT
961 enum trace_iterator_bits { TRACE_FLAGS };
964 * By redefining C, we can make TRACE_FLAGS a list of masks that
965 * use the bits as defined above.
968 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
970 enum trace_iterator_flags { TRACE_FLAGS };
973 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
974 * control the output of kernel symbols.
976 #define TRACE_ITER_SYM_MASK \
977 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
979 extern struct tracer nop_trace;
981 #ifdef CONFIG_BRANCH_TRACER
982 extern int enable_branch_tracing(struct trace_array *tr);
983 extern void disable_branch_tracing(void);
984 static inline int trace_branch_enable(struct trace_array *tr)
986 if (trace_flags & TRACE_ITER_BRANCH)
987 return enable_branch_tracing(tr);
990 static inline void trace_branch_disable(void)
992 /* due to races, always disable */
993 disable_branch_tracing();
996 static inline int trace_branch_enable(struct trace_array *tr)
1000 static inline void trace_branch_disable(void)
1003 #endif /* CONFIG_BRANCH_TRACER */
1005 /* set ring buffers to default size if not already done so */
1006 int tracing_update_buffers(void);
1008 struct ftrace_event_field {
1009 struct list_head link;
1018 struct event_filter {
1019 int n_preds; /* Number assigned */
1020 int a_preds; /* allocated */
1021 struct filter_pred *preds;
1022 struct filter_pred *root;
1023 char *filter_string;
1026 struct event_subsystem {
1027 struct list_head list;
1029 struct event_filter *filter;
1033 struct trace_subsystem_dir {
1034 struct list_head list;
1035 struct event_subsystem *subsystem;
1036 struct trace_array *tr;
1037 struct dentry *entry;
1042 #define FILTER_PRED_INVALID ((unsigned short)-1)
1043 #define FILTER_PRED_IS_RIGHT (1 << 15)
1044 #define FILTER_PRED_FOLD (1 << 15)
1047 * The max preds is the size of unsigned short with
1048 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1049 * and FOLD flags. The other is reserved.
1051 * 2^14 preds is way more than enough.
1053 #define MAX_FILTER_PRED 16384
1058 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1060 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1070 char pattern[MAX_FILTER_STR_VAL];
1073 regex_match_func match;
1076 struct filter_pred {
1077 filter_pred_fn_t fn;
1080 unsigned short *ops;
1081 struct ftrace_event_field *field;
1085 unsigned short index;
1086 unsigned short parent;
1087 unsigned short left;
1088 unsigned short right;
1091 extern enum regex_type
1092 filter_parse_regex(char *buff, int len, char **search, int *not);
1093 extern void print_event_filter(struct trace_event_file *file,
1094 struct trace_seq *s);
1095 extern int apply_event_filter(struct trace_event_file *file,
1096 char *filter_string);
1097 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1098 char *filter_string);
1099 extern void print_subsystem_event_filter(struct event_subsystem *system,
1100 struct trace_seq *s);
1101 extern int filter_assign_type(const char *type);
1102 extern int create_event_filter(struct trace_event_call *call,
1103 char *filter_str, bool set_str,
1104 struct event_filter **filterp);
1105 extern void free_event_filter(struct event_filter *filter);
1107 struct ftrace_event_field *
1108 trace_find_event_field(struct trace_event_call *call, char *name);
1110 extern void trace_event_enable_cmd_record(bool enable);
1111 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1112 extern int event_trace_del_tracer(struct trace_array *tr);
1114 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1118 static inline void *event_file_data(struct file *filp)
1120 return ACCESS_ONCE(file_inode(filp)->i_private);
1123 extern struct mutex event_mutex;
1124 extern struct list_head ftrace_events;
1126 extern const struct file_operations event_trigger_fops;
1128 extern int register_trigger_cmds(void);
1129 extern void clear_event_triggers(struct trace_array *tr);
1131 struct event_trigger_data {
1132 unsigned long count;
1134 struct event_trigger_ops *ops;
1135 struct event_command *cmd_ops;
1136 struct event_filter __rcu *filter;
1139 struct list_head list;
1143 * struct event_trigger_ops - callbacks for trace event triggers
1145 * The methods in this structure provide per-event trigger hooks for
1146 * various trigger operations.
1148 * All the methods below, except for @init() and @free(), must be
1151 * @func: The trigger 'probe' function called when the triggering
1152 * event occurs. The data passed into this callback is the data
1153 * that was supplied to the event_command @reg() function that
1154 * registered the trigger (see struct event_command).
1156 * @init: An optional initialization function called for the trigger
1157 * when the trigger is registered (via the event_command reg()
1158 * function). This can be used to perform per-trigger
1159 * initialization such as incrementing a per-trigger reference
1160 * count, for instance. This is usually implemented by the
1161 * generic utility function @event_trigger_init() (see
1162 * trace_event_triggers.c).
1164 * @free: An optional de-initialization function called for the
1165 * trigger when the trigger is unregistered (via the
1166 * event_command @reg() function). This can be used to perform
1167 * per-trigger de-initialization such as decrementing a
1168 * per-trigger reference count and freeing corresponding trigger
1169 * data, for instance. This is usually implemented by the
1170 * generic utility function @event_trigger_free() (see
1171 * trace_event_triggers.c).
1173 * @print: The callback function invoked to have the trigger print
1174 * itself. This is usually implemented by a wrapper function
1175 * that calls the generic utility function @event_trigger_print()
1176 * (see trace_event_triggers.c).
1178 struct event_trigger_ops {
1179 void (*func)(struct event_trigger_data *data);
1180 int (*init)(struct event_trigger_ops *ops,
1181 struct event_trigger_data *data);
1182 void (*free)(struct event_trigger_ops *ops,
1183 struct event_trigger_data *data);
1184 int (*print)(struct seq_file *m,
1185 struct event_trigger_ops *ops,
1186 struct event_trigger_data *data);
1190 * struct event_command - callbacks and data members for event commands
1192 * Event commands are invoked by users by writing the command name
1193 * into the 'trigger' file associated with a trace event. The
1194 * parameters associated with a specific invocation of an event
1195 * command are used to create an event trigger instance, which is
1196 * added to the list of trigger instances associated with that trace
1197 * event. When the event is hit, the set of triggers associated with
1198 * that event is invoked.
1200 * The data members in this structure provide per-event command data
1201 * for various event commands.
1203 * All the data members below, except for @post_trigger, must be set
1204 * for each event command.
1206 * @name: The unique name that identifies the event command. This is
1207 * the name used when setting triggers via trigger files.
1209 * @trigger_type: A unique id that identifies the event command
1210 * 'type'. This value has two purposes, the first to ensure that
1211 * only one trigger of the same type can be set at a given time
1212 * for a particular event e.g. it doesn't make sense to have both
1213 * a traceon and traceoff trigger attached to a single event at
1214 * the same time, so traceon and traceoff have the same type
1215 * though they have different names. The @trigger_type value is
1216 * also used as a bit value for deferring the actual trigger
1217 * action until after the current event is finished. Some
1218 * commands need to do this if they themselves log to the trace
1219 * buffer (see the @post_trigger() member below). @trigger_type
1220 * values are defined by adding new values to the trigger_type
1221 * enum in include/linux/trace_events.h.
1223 * @post_trigger: A flag that says whether or not this command needs
1224 * to have its action delayed until after the current event has
1225 * been closed. Some triggers need to avoid being invoked while
1226 * an event is currently in the process of being logged, since
1227 * the trigger may itself log data into the trace buffer. Thus
1228 * we make sure the current event is committed before invoking
1229 * those triggers. To do that, the trigger invocation is split
1230 * in two - the first part checks the filter using the current
1231 * trace record; if a command has the @post_trigger flag set, it
1232 * sets a bit for itself in the return value, otherwise it
1233 * directly invokes the trigger. Once all commands have been
1234 * either invoked or set their return flag, the current record is
1235 * either committed or discarded. At that point, if any commands
1236 * have deferred their triggers, those commands are finally
1237 * invoked following the close of the current event. In other
1238 * words, if the event_trigger_ops @func() probe implementation
1239 * itself logs to the trace buffer, this flag should be set,
1240 * otherwise it can be left unspecified.
1242 * All the methods below, except for @set_filter(), must be
1245 * @func: The callback function responsible for parsing and
1246 * registering the trigger written to the 'trigger' file by the
1247 * user. It allocates the trigger instance and registers it with
1248 * the appropriate trace event. It makes use of the other
1249 * event_command callback functions to orchestrate this, and is
1250 * usually implemented by the generic utility function
1251 * @event_trigger_callback() (see trace_event_triggers.c).
1253 * @reg: Adds the trigger to the list of triggers associated with the
1254 * event, and enables the event trigger itself, after
1255 * initializing it (via the event_trigger_ops @init() function).
1256 * This is also where commands can use the @trigger_type value to
1257 * make the decision as to whether or not multiple instances of
1258 * the trigger should be allowed. This is usually implemented by
1259 * the generic utility function @register_trigger() (see
1260 * trace_event_triggers.c).
1262 * @unreg: Removes the trigger from the list of triggers associated
1263 * with the event, and disables the event trigger itself, after
1264 * initializing it (via the event_trigger_ops @free() function).
1265 * This is usually implemented by the generic utility function
1266 * @unregister_trigger() (see trace_event_triggers.c).
1268 * @set_filter: An optional function called to parse and set a filter
1269 * for the trigger. If no @set_filter() method is set for the
1270 * event command, filters set by the user for the command will be
1271 * ignored. This is usually implemented by the generic utility
1272 * function @set_trigger_filter() (see trace_event_triggers.c).
1274 * @get_trigger_ops: The callback function invoked to retrieve the
1275 * event_trigger_ops implementation associated with the command.
1277 struct event_command {
1278 struct list_head list;
1280 enum event_trigger_type trigger_type;
1282 int (*func)(struct event_command *cmd_ops,
1283 struct trace_event_file *file,
1284 char *glob, char *cmd, char *params);
1285 int (*reg)(char *glob,
1286 struct event_trigger_ops *ops,
1287 struct event_trigger_data *data,
1288 struct trace_event_file *file);
1289 void (*unreg)(char *glob,
1290 struct event_trigger_ops *ops,
1291 struct event_trigger_data *data,
1292 struct trace_event_file *file);
1293 int (*set_filter)(char *filter_str,
1294 struct event_trigger_data *data,
1295 struct trace_event_file *file);
1296 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1299 extern int trace_event_enable_disable(struct trace_event_file *file,
1300 int enable, int soft_disable);
1301 extern int tracing_alloc_snapshot(void);
1303 extern const char *__start___trace_bprintk_fmt[];
1304 extern const char *__stop___trace_bprintk_fmt[];
1306 extern const char *__start___tracepoint_str[];
1307 extern const char *__stop___tracepoint_str[];
1309 void trace_printk_init_buffers(void);
1310 void trace_printk_start_comm(void);
1311 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1312 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1315 * Normal trace_printk() and friends allocates special buffers
1316 * to do the manipulation, as well as saves the print formats
1317 * into sections to display. But the trace infrastructure wants
1318 * to use these without the added overhead at the price of being
1319 * a bit slower (used mainly for warnings, where we don't care
1320 * about performance). The internal_trace_puts() is for such
1323 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1326 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
1327 extern struct trace_event_call \
1328 __aligned(4) event_##call;
1329 #undef FTRACE_ENTRY_DUP
1330 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1331 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1333 #include "trace_entries.h"
1335 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1336 int perf_ftrace_event_register(struct trace_event_call *call,
1337 enum trace_reg type, void *data);
1339 #define perf_ftrace_event_register NULL
1342 #ifdef CONFIG_FTRACE_SYSCALLS
1343 void init_ftrace_syscalls(void);
1345 static inline void init_ftrace_syscalls(void) { }
1348 #ifdef CONFIG_EVENT_TRACING
1349 void trace_event_init(void);
1350 void trace_event_enum_update(struct trace_enum_map **map, int len);
1352 static inline void __init trace_event_init(void) { }
1353 static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
1356 extern struct trace_iterator *tracepoint_print_iter;
1358 #endif /* _LINUX_KERNEL_TRACE_H */