]> Pileus Git - ~andy/linux/blob - kernel/trace/trace.h
tracing: Use direct field, type and system names
[~andy/linux] / kernel / trace / trace.h
1 #ifndef _LINUX_KERNEL_TRACE_H
2 #define _LINUX_KERNEL_TRACE_H
3
4 #include <linux/fs.h>
5 #include <linux/atomic.h>
6 #include <linux/sched.h>
7 #include <linux/clocksource.h>
8 #include <linux/ring_buffer.h>
9 #include <linux/mmiotrace.h>
10 #include <linux/tracepoint.h>
11 #include <linux/ftrace.h>
12 #include <linux/hw_breakpoint.h>
13 #include <linux/trace_seq.h>
14 #include <linux/ftrace_event.h>
15
16 #ifdef CONFIG_FTRACE_SYSCALLS
17 #include <asm/unistd.h>         /* For NR_SYSCALLS           */
18 #include <asm/syscall.h>        /* some archs define it here */
19 #endif
20
21 enum trace_type {
22         __TRACE_FIRST_TYPE = 0,
23
24         TRACE_FN,
25         TRACE_CTX,
26         TRACE_WAKE,
27         TRACE_STACK,
28         TRACE_PRINT,
29         TRACE_BPRINT,
30         TRACE_MMIO_RW,
31         TRACE_MMIO_MAP,
32         TRACE_BRANCH,
33         TRACE_GRAPH_RET,
34         TRACE_GRAPH_ENT,
35         TRACE_USER_STACK,
36         TRACE_BLK,
37
38         __TRACE_LAST_TYPE,
39 };
40
41
42 #undef __field
43 #define __field(type, item)             type    item;
44
45 #undef __field_struct
46 #define __field_struct(type, item)      __field(type, item)
47
48 #undef __field_desc
49 #define __field_desc(type, container, item)
50
51 #undef __array
52 #define __array(type, item, size)       type    item[size];
53
54 #undef __array_desc
55 #define __array_desc(type, container, item, size)
56
57 #undef __dynamic_array
58 #define __dynamic_array(type, item)     type    item[];
59
60 #undef F_STRUCT
61 #define F_STRUCT(args...)               args
62
63 #undef FTRACE_ENTRY
64 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter)     \
65         struct struct_name {                                            \
66                 struct trace_entry      ent;                            \
67                 tstruct                                                 \
68         }
69
70 #undef TP_ARGS
71 #define TP_ARGS(args...)        args
72
73 #undef FTRACE_ENTRY_DUP
74 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
75
76 #undef FTRACE_ENTRY_REG
77 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
78                          filter, regfn) \
79         FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
80                      filter)
81
82 #include "trace_entries.h"
83
84 /*
85  * syscalls are special, and need special handling, this is why
86  * they are not included in trace_entries.h
87  */
88 struct syscall_trace_enter {
89         struct trace_entry      ent;
90         int                     nr;
91         unsigned long           args[];
92 };
93
94 struct syscall_trace_exit {
95         struct trace_entry      ent;
96         int                     nr;
97         long                    ret;
98 };
99
100 struct kprobe_trace_entry_head {
101         struct trace_entry      ent;
102         unsigned long           ip;
103 };
104
105 struct kretprobe_trace_entry_head {
106         struct trace_entry      ent;
107         unsigned long           func;
108         unsigned long           ret_ip;
109 };
110
111 struct uprobe_trace_entry_head {
112         struct trace_entry      ent;
113         unsigned long           ip;
114 };
115
116 /*
117  * trace_flag_type is an enumeration that holds different
118  * states when a trace occurs. These are:
119  *  IRQS_OFF            - interrupts were disabled
120  *  IRQS_NOSUPPORT      - arch does not support irqs_disabled_flags
121  *  NEED_RESCHED        - reschedule is requested
122  *  HARDIRQ             - inside an interrupt handler
123  *  SOFTIRQ             - inside a softirq handler
124  */
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 };
132
133 #define TRACE_BUF_SIZE          1024
134
135 struct trace_array;
136
137 struct trace_cpu {
138         struct trace_array      *tr;
139         struct dentry           *dir;
140         int                     cpu;
141 };
142
143 /*
144  * The CPU trace array - it consists of thousands of trace entries
145  * plus some other descriptor data: (for example which task started
146  * the trace, etc.)
147  */
148 struct trace_array_cpu {
149         struct trace_cpu        trace_cpu;
150         atomic_t                disabled;
151         void                    *buffer_page;   /* ring buffer spare */
152
153         unsigned long           entries;
154         unsigned long           saved_latency;
155         unsigned long           critical_start;
156         unsigned long           critical_end;
157         unsigned long           critical_sequence;
158         unsigned long           nice;
159         unsigned long           policy;
160         unsigned long           rt_priority;
161         unsigned long           skipped_entries;
162         cycle_t                 preempt_timestamp;
163         pid_t                   pid;
164         kuid_t                  uid;
165         char                    comm[TASK_COMM_LEN];
166 };
167
168 struct tracer;
169
170 /*
171  * The trace array - an array of per-CPU trace arrays. This is the
172  * highest level data structure that individual tracers deal with.
173  * They have on/off state as well:
174  */
175 struct trace_array {
176         struct ring_buffer      *buffer;
177         struct list_head        list;
178         char                    *name;
179         int                     cpu;
180         int                     buffer_disabled;
181         struct trace_cpu        trace_cpu;      /* place holder */
182 #ifdef CONFIG_FTRACE_SYSCALLS
183         int                     sys_refcount_enter;
184         int                     sys_refcount_exit;
185         DECLARE_BITMAP(enabled_enter_syscalls, NR_syscalls);
186         DECLARE_BITMAP(enabled_exit_syscalls, NR_syscalls);
187 #endif
188         int                     stop_count;
189         int                     clock_id;
190         struct tracer           *current_trace;
191         unsigned int            flags;
192         cycle_t                 time_start;
193         raw_spinlock_t          start_lock;
194         struct dentry           *dir;
195         struct dentry           *options;
196         struct dentry           *percpu_dir;
197         struct dentry           *event_dir;
198         struct list_head        systems;
199         struct list_head        events;
200         struct task_struct      *waiter;
201         struct trace_array_cpu  *data;
202 };
203
204 enum {
205         TRACE_ARRAY_FL_GLOBAL   = (1 << 0)
206 };
207
208 extern struct list_head ftrace_trace_arrays;
209
210 /*
211  * The global tracer (top) should be the first trace array added,
212  * but we check the flag anyway.
213  */
214 static inline struct trace_array *top_trace_array(void)
215 {
216         struct trace_array *tr;
217
218         tr = list_entry(ftrace_trace_arrays.prev,
219                         typeof(*tr), list);
220         WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
221         return tr;
222 }
223
224 #define FTRACE_CMP_TYPE(var, type) \
225         __builtin_types_compatible_p(typeof(var), type *)
226
227 #undef IF_ASSIGN
228 #define IF_ASSIGN(var, entry, etype, id)                \
229         if (FTRACE_CMP_TYPE(var, etype)) {              \
230                 var = (typeof(var))(entry);             \
231                 WARN_ON(id && (entry)->type != id);     \
232                 break;                                  \
233         }
234
235 /* Will cause compile errors if type is not found. */
236 extern void __ftrace_bad_type(void);
237
238 /*
239  * The trace_assign_type is a verifier that the entry type is
240  * the same as the type being assigned. To add new types simply
241  * add a line with the following format:
242  *
243  * IF_ASSIGN(var, ent, type, id);
244  *
245  *  Where "type" is the trace type that includes the trace_entry
246  *  as the "ent" item. And "id" is the trace identifier that is
247  *  used in the trace_type enum.
248  *
249  *  If the type can have more than one id, then use zero.
250  */
251 #define trace_assign_type(var, ent)                                     \
252         do {                                                            \
253                 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);     \
254                 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);        \
255                 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);   \
256                 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
257                 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);   \
258                 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
259                 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,          \
260                           TRACE_MMIO_RW);                               \
261                 IF_ASSIGN(var, ent, struct trace_mmiotrace_map,         \
262                           TRACE_MMIO_MAP);                              \
263                 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
264                 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,      \
265                           TRACE_GRAPH_ENT);             \
266                 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,      \
267                           TRACE_GRAPH_RET);             \
268                 __ftrace_bad_type();                                    \
269         } while (0)
270
271 /*
272  * An option specific to a tracer. This is a boolean value.
273  * The bit is the bit index that sets its value on the
274  * flags value in struct tracer_flags.
275  */
276 struct tracer_opt {
277         const char      *name; /* Will appear on the trace_options file */
278         u32             bit; /* Mask assigned in val field in tracer_flags */
279 };
280
281 /*
282  * The set of specific options for a tracer. Your tracer
283  * have to set the initial value of the flags val.
284  */
285 struct tracer_flags {
286         u32                     val;
287         struct tracer_opt       *opts;
288 };
289
290 /* Makes more easy to define a tracer opt */
291 #define TRACER_OPT(s, b)        .name = #s, .bit = b
292
293
294 /**
295  * struct tracer - a specific tracer and its callbacks to interact with debugfs
296  * @name: the name chosen to select it on the available_tracers file
297  * @init: called when one switches to this tracer (echo name > current_tracer)
298  * @reset: called when one switches to another tracer
299  * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
300  * @stop: called when tracing is paused (echo 0 > tracing_enabled)
301  * @open: called when the trace file is opened
302  * @pipe_open: called when the trace_pipe file is opened
303  * @wait_pipe: override how the user waits for traces on trace_pipe
304  * @close: called when the trace file is released
305  * @pipe_close: called when the trace_pipe file is released
306  * @read: override the default read callback on trace_pipe
307  * @splice_read: override the default splice_read callback on trace_pipe
308  * @selftest: selftest to run on boot (see trace_selftest.c)
309  * @print_headers: override the first lines that describe your columns
310  * @print_line: callback that prints a trace
311  * @set_flag: signals one of your private flags changed (trace_options file)
312  * @flags: your private flags
313  */
314 struct tracer {
315         const char              *name;
316         int                     (*init)(struct trace_array *tr);
317         void                    (*reset)(struct trace_array *tr);
318         void                    (*start)(struct trace_array *tr);
319         void                    (*stop)(struct trace_array *tr);
320         void                    (*open)(struct trace_iterator *iter);
321         void                    (*pipe_open)(struct trace_iterator *iter);
322         void                    (*wait_pipe)(struct trace_iterator *iter);
323         void                    (*close)(struct trace_iterator *iter);
324         void                    (*pipe_close)(struct trace_iterator *iter);
325         ssize_t                 (*read)(struct trace_iterator *iter,
326                                         struct file *filp, char __user *ubuf,
327                                         size_t cnt, loff_t *ppos);
328         ssize_t                 (*splice_read)(struct trace_iterator *iter,
329                                                struct file *filp,
330                                                loff_t *ppos,
331                                                struct pipe_inode_info *pipe,
332                                                size_t len,
333                                                unsigned int flags);
334 #ifdef CONFIG_FTRACE_STARTUP_TEST
335         int                     (*selftest)(struct tracer *trace,
336                                             struct trace_array *tr);
337 #endif
338         void                    (*print_header)(struct seq_file *m);
339         enum print_line_t       (*print_line)(struct trace_iterator *iter);
340         /* If you handled the flag setting, return 0 */
341         int                     (*set_flag)(u32 old_flags, u32 bit, int set);
342         /* Return 0 if OK with change, else return non-zero */
343         int                     (*flag_changed)(struct tracer *tracer,
344                                                 u32 mask, int set);
345         struct tracer           *next;
346         struct tracer_flags     *flags;
347         bool                    print_max;
348         bool                    use_max_tr;
349         bool                    allocated_snapshot;
350         bool                    enabled;
351 };
352
353
354 /* Only current can touch trace_recursion */
355
356 /*
357  * For function tracing recursion:
358  *  The order of these bits are important.
359  *
360  *  When function tracing occurs, the following steps are made:
361  *   If arch does not support a ftrace feature:
362  *    call internal function (uses INTERNAL bits) which calls...
363  *   If callback is registered to the "global" list, the list
364  *    function is called and recursion checks the GLOBAL bits.
365  *    then this function calls...
366  *   The function callback, which can use the FTRACE bits to
367  *    check for recursion.
368  *
369  * Now if the arch does not suppport a feature, and it calls
370  * the global list function which calls the ftrace callback
371  * all three of these steps will do a recursion protection.
372  * There's no reason to do one if the previous caller already
373  * did. The recursion that we are protecting against will
374  * go through the same steps again.
375  *
376  * To prevent the multiple recursion checks, if a recursion
377  * bit is set that is higher than the MAX bit of the current
378  * check, then we know that the check was made by the previous
379  * caller, and we can skip the current check.
380  */
381 enum {
382         TRACE_BUFFER_BIT,
383         TRACE_BUFFER_NMI_BIT,
384         TRACE_BUFFER_IRQ_BIT,
385         TRACE_BUFFER_SIRQ_BIT,
386
387         /* Start of function recursion bits */
388         TRACE_FTRACE_BIT,
389         TRACE_FTRACE_NMI_BIT,
390         TRACE_FTRACE_IRQ_BIT,
391         TRACE_FTRACE_SIRQ_BIT,
392
393         /* GLOBAL_BITs must be greater than FTRACE_BITs */
394         TRACE_GLOBAL_BIT,
395         TRACE_GLOBAL_NMI_BIT,
396         TRACE_GLOBAL_IRQ_BIT,
397         TRACE_GLOBAL_SIRQ_BIT,
398
399         /* INTERNAL_BITs must be greater than GLOBAL_BITs */
400         TRACE_INTERNAL_BIT,
401         TRACE_INTERNAL_NMI_BIT,
402         TRACE_INTERNAL_IRQ_BIT,
403         TRACE_INTERNAL_SIRQ_BIT,
404
405         TRACE_CONTROL_BIT,
406
407 /*
408  * Abuse of the trace_recursion.
409  * As we need a way to maintain state if we are tracing the function
410  * graph in irq because we want to trace a particular function that
411  * was called in irq context but we have irq tracing off. Since this
412  * can only be modified by current, we can reuse trace_recursion.
413  */
414         TRACE_IRQ_BIT,
415 };
416
417 #define trace_recursion_set(bit)        do { (current)->trace_recursion |= (1<<(bit)); } while (0)
418 #define trace_recursion_clear(bit)      do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
419 #define trace_recursion_test(bit)       ((current)->trace_recursion & (1<<(bit)))
420
421 #define TRACE_CONTEXT_BITS      4
422
423 #define TRACE_FTRACE_START      TRACE_FTRACE_BIT
424 #define TRACE_FTRACE_MAX        ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
425
426 #define TRACE_GLOBAL_START      TRACE_GLOBAL_BIT
427 #define TRACE_GLOBAL_MAX        ((1 << (TRACE_GLOBAL_START + TRACE_CONTEXT_BITS)) - 1)
428
429 #define TRACE_LIST_START        TRACE_INTERNAL_BIT
430 #define TRACE_LIST_MAX          ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
431
432 #define TRACE_CONTEXT_MASK      TRACE_LIST_MAX
433
434 static __always_inline int trace_get_context_bit(void)
435 {
436         int bit;
437
438         if (in_interrupt()) {
439                 if (in_nmi())
440                         bit = 0;
441
442                 else if (in_irq())
443                         bit = 1;
444                 else
445                         bit = 2;
446         } else
447                 bit = 3;
448
449         return bit;
450 }
451
452 static __always_inline int trace_test_and_set_recursion(int start, int max)
453 {
454         unsigned int val = current->trace_recursion;
455         int bit;
456
457         /* A previous recursion check was made */
458         if ((val & TRACE_CONTEXT_MASK) > max)
459                 return 0;
460
461         bit = trace_get_context_bit() + start;
462         if (unlikely(val & (1 << bit)))
463                 return -1;
464
465         val |= 1 << bit;
466         current->trace_recursion = val;
467         barrier();
468
469         return bit;
470 }
471
472 static __always_inline void trace_clear_recursion(int bit)
473 {
474         unsigned int val = current->trace_recursion;
475
476         if (!bit)
477                 return;
478
479         bit = 1 << bit;
480         val &= ~bit;
481
482         barrier();
483         current->trace_recursion = val;
484 }
485
486 static inline struct ring_buffer_iter *
487 trace_buffer_iter(struct trace_iterator *iter, int cpu)
488 {
489         if (iter->buffer_iter && iter->buffer_iter[cpu])
490                 return iter->buffer_iter[cpu];
491         return NULL;
492 }
493
494 int tracer_init(struct tracer *t, struct trace_array *tr);
495 int tracing_is_enabled(void);
496 void tracing_reset(struct trace_array *tr, int cpu);
497 void tracing_reset_online_cpus(struct trace_array *tr);
498 void tracing_reset_current(int cpu);
499 void tracing_reset_current_online_cpus(void);
500 int tracing_open_generic(struct inode *inode, struct file *filp);
501 struct dentry *trace_create_file(const char *name,
502                                  umode_t mode,
503                                  struct dentry *parent,
504                                  void *data,
505                                  const struct file_operations *fops);
506
507 struct dentry *tracing_init_dentry_tr(struct trace_array *tr);
508 struct dentry *tracing_init_dentry(void);
509
510 struct ring_buffer_event;
511
512 struct ring_buffer_event *
513 trace_buffer_lock_reserve(struct ring_buffer *buffer,
514                           int type,
515                           unsigned long len,
516                           unsigned long flags,
517                           int pc);
518
519 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
520                                                 struct trace_array_cpu *data);
521
522 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
523                                           int *ent_cpu, u64 *ent_ts);
524
525 void __buffer_unlock_commit(struct ring_buffer *buffer,
526                             struct ring_buffer_event *event);
527
528 int trace_empty(struct trace_iterator *iter);
529
530 void *trace_find_next_entry_inc(struct trace_iterator *iter);
531
532 void trace_init_global_iter(struct trace_iterator *iter);
533
534 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
535
536 void poll_wait_pipe(struct trace_iterator *iter);
537
538 void ftrace(struct trace_array *tr,
539                             struct trace_array_cpu *data,
540                             unsigned long ip,
541                             unsigned long parent_ip,
542                             unsigned long flags, int pc);
543 void tracing_sched_switch_trace(struct trace_array *tr,
544                                 struct task_struct *prev,
545                                 struct task_struct *next,
546                                 unsigned long flags, int pc);
547
548 void tracing_sched_wakeup_trace(struct trace_array *tr,
549                                 struct task_struct *wakee,
550                                 struct task_struct *cur,
551                                 unsigned long flags, int pc);
552 void trace_function(struct trace_array *tr,
553                     unsigned long ip,
554                     unsigned long parent_ip,
555                     unsigned long flags, int pc);
556 void trace_graph_function(struct trace_array *tr,
557                     unsigned long ip,
558                     unsigned long parent_ip,
559                     unsigned long flags, int pc);
560 void trace_latency_header(struct seq_file *m);
561 void trace_default_header(struct seq_file *m);
562 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
563 int trace_empty(struct trace_iterator *iter);
564
565 void trace_graph_return(struct ftrace_graph_ret *trace);
566 int trace_graph_entry(struct ftrace_graph_ent *trace);
567 void set_graph_array(struct trace_array *tr);
568
569 void tracing_start_cmdline_record(void);
570 void tracing_stop_cmdline_record(void);
571 void tracing_sched_switch_assign_trace(struct trace_array *tr);
572 void tracing_stop_sched_switch_record(void);
573 void tracing_start_sched_switch_record(void);
574 int register_tracer(struct tracer *type);
575 int is_tracing_stopped(void);
576
577 extern cpumask_var_t __read_mostly tracing_buffer_mask;
578
579 #define for_each_tracing_cpu(cpu)       \
580         for_each_cpu(cpu, tracing_buffer_mask)
581
582 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
583
584 extern unsigned long tracing_thresh;
585
586 #ifdef CONFIG_TRACER_MAX_TRACE
587 extern unsigned long tracing_max_latency;
588
589 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
590 void update_max_tr_single(struct trace_array *tr,
591                           struct task_struct *tsk, int cpu);
592 #endif /* CONFIG_TRACER_MAX_TRACE */
593
594 #ifdef CONFIG_STACKTRACE
595 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
596                         int skip, int pc);
597
598 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
599                              int skip, int pc, struct pt_regs *regs);
600
601 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
602                             int pc);
603
604 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
605                    int pc);
606 #else
607 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
608                                       unsigned long flags, int skip, int pc)
609 {
610 }
611
612 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
613                                            unsigned long flags, int skip,
614                                            int pc, struct pt_regs *regs)
615 {
616 }
617
618 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
619                                           unsigned long flags, int pc)
620 {
621 }
622
623 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
624                                  int skip, int pc)
625 {
626 }
627 #endif /* CONFIG_STACKTRACE */
628
629 extern cycle_t ftrace_now(int cpu);
630
631 extern void trace_find_cmdline(int pid, char comm[]);
632
633 #ifdef CONFIG_DYNAMIC_FTRACE
634 extern unsigned long ftrace_update_tot_cnt;
635 #endif
636 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
637 extern int DYN_FTRACE_TEST_NAME(void);
638 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
639 extern int DYN_FTRACE_TEST_NAME2(void);
640
641 extern int ring_buffer_expanded;
642 extern bool tracing_selftest_disabled;
643 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
644
645 #ifdef CONFIG_FTRACE_STARTUP_TEST
646 extern int trace_selftest_startup_function(struct tracer *trace,
647                                            struct trace_array *tr);
648 extern int trace_selftest_startup_function_graph(struct tracer *trace,
649                                                  struct trace_array *tr);
650 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
651                                           struct trace_array *tr);
652 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
653                                              struct trace_array *tr);
654 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
655                                                  struct trace_array *tr);
656 extern int trace_selftest_startup_wakeup(struct tracer *trace,
657                                          struct trace_array *tr);
658 extern int trace_selftest_startup_nop(struct tracer *trace,
659                                          struct trace_array *tr);
660 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
661                                                struct trace_array *tr);
662 extern int trace_selftest_startup_branch(struct tracer *trace,
663                                          struct trace_array *tr);
664 #endif /* CONFIG_FTRACE_STARTUP_TEST */
665
666 extern void *head_page(struct trace_array_cpu *data);
667 extern unsigned long long ns2usecs(cycle_t nsec);
668 extern int
669 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
670 extern int
671 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
672 extern int
673 trace_array_vprintk(struct trace_array *tr,
674                     unsigned long ip, const char *fmt, va_list args);
675 int trace_array_printk(struct trace_array *tr,
676                        unsigned long ip, const char *fmt, ...);
677 void trace_printk_seq(struct trace_seq *s);
678 enum print_line_t print_trace_line(struct trace_iterator *iter);
679
680 extern unsigned long trace_flags;
681
682 extern int trace_clock_id;
683
684 /* Standard output formatting function used for function return traces */
685 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
686
687 /* Flag options */
688 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
689 #define TRACE_GRAPH_PRINT_CPU           0x2
690 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
691 #define TRACE_GRAPH_PRINT_PROC          0x8
692 #define TRACE_GRAPH_PRINT_DURATION      0x10
693 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
694
695 extern enum print_line_t
696 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
697 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
698 extern enum print_line_t
699 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
700 extern void graph_trace_open(struct trace_iterator *iter);
701 extern void graph_trace_close(struct trace_iterator *iter);
702 extern int __trace_graph_entry(struct trace_array *tr,
703                                struct ftrace_graph_ent *trace,
704                                unsigned long flags, int pc);
705 extern void __trace_graph_return(struct trace_array *tr,
706                                  struct ftrace_graph_ret *trace,
707                                  unsigned long flags, int pc);
708
709
710 #ifdef CONFIG_DYNAMIC_FTRACE
711 /* TODO: make this variable */
712 #define FTRACE_GRAPH_MAX_FUNCS          32
713 extern int ftrace_graph_filter_enabled;
714 extern int ftrace_graph_count;
715 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
716
717 static inline int ftrace_graph_addr(unsigned long addr)
718 {
719         int i;
720
721         if (!ftrace_graph_filter_enabled)
722                 return 1;
723
724         for (i = 0; i < ftrace_graph_count; i++) {
725                 if (addr == ftrace_graph_funcs[i]) {
726                         /*
727                          * If no irqs are to be traced, but a set_graph_function
728                          * is set, and called by an interrupt handler, we still
729                          * want to trace it.
730                          */
731                         if (in_irq())
732                                 trace_recursion_set(TRACE_IRQ_BIT);
733                         else
734                                 trace_recursion_clear(TRACE_IRQ_BIT);
735                         return 1;
736                 }
737         }
738
739         return 0;
740 }
741 #else
742 static inline int ftrace_graph_addr(unsigned long addr)
743 {
744         return 1;
745 }
746 #endif /* CONFIG_DYNAMIC_FTRACE */
747 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
748 static inline enum print_line_t
749 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
750 {
751         return TRACE_TYPE_UNHANDLED;
752 }
753 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
754
755 extern struct list_head ftrace_pids;
756
757 #ifdef CONFIG_FUNCTION_TRACER
758 static inline int ftrace_trace_task(struct task_struct *task)
759 {
760         if (list_empty(&ftrace_pids))
761                 return 1;
762
763         return test_tsk_trace_trace(task);
764 }
765 extern int ftrace_is_dead(void);
766 #else
767 static inline int ftrace_trace_task(struct task_struct *task)
768 {
769         return 1;
770 }
771 static inline int ftrace_is_dead(void) { return 0; }
772 #endif
773
774 int ftrace_event_is_function(struct ftrace_event_call *call);
775
776 /*
777  * struct trace_parser - servers for reading the user input separated by spaces
778  * @cont: set if the input is not complete - no final space char was found
779  * @buffer: holds the parsed user input
780  * @idx: user input length
781  * @size: buffer size
782  */
783 struct trace_parser {
784         bool            cont;
785         char            *buffer;
786         unsigned        idx;
787         unsigned        size;
788 };
789
790 static inline bool trace_parser_loaded(struct trace_parser *parser)
791 {
792         return (parser->idx != 0);
793 }
794
795 static inline bool trace_parser_cont(struct trace_parser *parser)
796 {
797         return parser->cont;
798 }
799
800 static inline void trace_parser_clear(struct trace_parser *parser)
801 {
802         parser->cont = false;
803         parser->idx = 0;
804 }
805
806 extern int trace_parser_get_init(struct trace_parser *parser, int size);
807 extern void trace_parser_put(struct trace_parser *parser);
808 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
809         size_t cnt, loff_t *ppos);
810
811 /*
812  * trace_iterator_flags is an enumeration that defines bit
813  * positions into trace_flags that controls the output.
814  *
815  * NOTE: These bits must match the trace_options array in
816  *       trace.c.
817  */
818 enum trace_iterator_flags {
819         TRACE_ITER_PRINT_PARENT         = 0x01,
820         TRACE_ITER_SYM_OFFSET           = 0x02,
821         TRACE_ITER_SYM_ADDR             = 0x04,
822         TRACE_ITER_VERBOSE              = 0x08,
823         TRACE_ITER_RAW                  = 0x10,
824         TRACE_ITER_HEX                  = 0x20,
825         TRACE_ITER_BIN                  = 0x40,
826         TRACE_ITER_BLOCK                = 0x80,
827         TRACE_ITER_STACKTRACE           = 0x100,
828         TRACE_ITER_PRINTK               = 0x200,
829         TRACE_ITER_PREEMPTONLY          = 0x400,
830         TRACE_ITER_BRANCH               = 0x800,
831         TRACE_ITER_ANNOTATE             = 0x1000,
832         TRACE_ITER_USERSTACKTRACE       = 0x2000,
833         TRACE_ITER_SYM_USEROBJ          = 0x4000,
834         TRACE_ITER_PRINTK_MSGONLY       = 0x8000,
835         TRACE_ITER_CONTEXT_INFO         = 0x10000, /* Print pid/cpu/time */
836         TRACE_ITER_LATENCY_FMT          = 0x20000,
837         TRACE_ITER_SLEEP_TIME           = 0x40000,
838         TRACE_ITER_GRAPH_TIME           = 0x80000,
839         TRACE_ITER_RECORD_CMD           = 0x100000,
840         TRACE_ITER_OVERWRITE            = 0x200000,
841         TRACE_ITER_STOP_ON_FREE         = 0x400000,
842         TRACE_ITER_IRQ_INFO             = 0x800000,
843         TRACE_ITER_MARKERS              = 0x1000000,
844 };
845
846 /*
847  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
848  * control the output of kernel symbols.
849  */
850 #define TRACE_ITER_SYM_MASK \
851         (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
852
853 extern struct tracer nop_trace;
854
855 #ifdef CONFIG_BRANCH_TRACER
856 extern int enable_branch_tracing(struct trace_array *tr);
857 extern void disable_branch_tracing(void);
858 static inline int trace_branch_enable(struct trace_array *tr)
859 {
860         if (trace_flags & TRACE_ITER_BRANCH)
861                 return enable_branch_tracing(tr);
862         return 0;
863 }
864 static inline void trace_branch_disable(void)
865 {
866         /* due to races, always disable */
867         disable_branch_tracing();
868 }
869 #else
870 static inline int trace_branch_enable(struct trace_array *tr)
871 {
872         return 0;
873 }
874 static inline void trace_branch_disable(void)
875 {
876 }
877 #endif /* CONFIG_BRANCH_TRACER */
878
879 /* set ring buffers to default size if not already done so */
880 int tracing_update_buffers(void);
881
882 /* trace event type bit fields, not numeric */
883 enum {
884         TRACE_EVENT_TYPE_PRINTF         = 1,
885         TRACE_EVENT_TYPE_RAW            = 2,
886 };
887
888 struct ftrace_event_field {
889         struct list_head        link;
890         const char              *name;
891         const char              *type;
892         int                     filter_type;
893         int                     offset;
894         int                     size;
895         int                     is_signed;
896 };
897
898 struct event_filter {
899         int                     n_preds;        /* Number assigned */
900         int                     a_preds;        /* allocated */
901         struct filter_pred      *preds;
902         struct filter_pred      *root;
903         char                    *filter_string;
904 };
905
906 struct event_subsystem {
907         struct list_head        list;
908         const char              *name;
909         struct event_filter     *filter;
910         int                     ref_count;
911 };
912
913 struct ftrace_subsystem_dir {
914         struct list_head                list;
915         struct event_subsystem          *subsystem;
916         struct trace_array              *tr;
917         struct dentry                   *entry;
918         int                             ref_count;
919         int                             nr_events;
920 };
921
922 #define FILTER_PRED_INVALID     ((unsigned short)-1)
923 #define FILTER_PRED_IS_RIGHT    (1 << 15)
924 #define FILTER_PRED_FOLD        (1 << 15)
925
926 /*
927  * The max preds is the size of unsigned short with
928  * two flags at the MSBs. One bit is used for both the IS_RIGHT
929  * and FOLD flags. The other is reserved.
930  *
931  * 2^14 preds is way more than enough.
932  */
933 #define MAX_FILTER_PRED         16384
934
935 struct filter_pred;
936 struct regex;
937
938 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
939
940 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
941
942 enum regex_type {
943         MATCH_FULL = 0,
944         MATCH_FRONT_ONLY,
945         MATCH_MIDDLE_ONLY,
946         MATCH_END_ONLY,
947 };
948
949 struct regex {
950         char                    pattern[MAX_FILTER_STR_VAL];
951         int                     len;
952         int                     field_len;
953         regex_match_func        match;
954 };
955
956 struct filter_pred {
957         filter_pred_fn_t        fn;
958         u64                     val;
959         struct regex            regex;
960         unsigned short          *ops;
961         struct ftrace_event_field *field;
962         int                     offset;
963         int                     not;
964         int                     op;
965         unsigned short          index;
966         unsigned short          parent;
967         unsigned short          left;
968         unsigned short          right;
969 };
970
971 extern struct list_head ftrace_common_fields;
972
973 extern enum regex_type
974 filter_parse_regex(char *buff, int len, char **search, int *not);
975 extern void print_event_filter(struct ftrace_event_call *call,
976                                struct trace_seq *s);
977 extern int apply_event_filter(struct ftrace_event_call *call,
978                               char *filter_string);
979 extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir *dir,
980                                         char *filter_string);
981 extern void print_subsystem_event_filter(struct event_subsystem *system,
982                                          struct trace_seq *s);
983 extern int filter_assign_type(const char *type);
984
985 struct list_head *
986 trace_get_fields(struct ftrace_event_call *event_call);
987
988 static inline int
989 filter_check_discard(struct ftrace_event_call *call, void *rec,
990                      struct ring_buffer *buffer,
991                      struct ring_buffer_event *event)
992 {
993         if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
994             !filter_match_preds(call->filter, rec)) {
995                 ring_buffer_discard_commit(buffer, event);
996                 return 1;
997         }
998
999         return 0;
1000 }
1001
1002 extern void trace_event_enable_cmd_record(bool enable);
1003 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1004 extern int event_trace_del_tracer(struct trace_array *tr);
1005
1006 extern struct mutex event_mutex;
1007 extern struct list_head ftrace_events;
1008
1009 extern const char *__start___trace_bprintk_fmt[];
1010 extern const char *__stop___trace_bprintk_fmt[];
1011
1012 void trace_printk_init_buffers(void);
1013 void trace_printk_start_comm(void);
1014 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1015 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1016
1017 #undef FTRACE_ENTRY
1018 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)     \
1019         extern struct ftrace_event_call                                 \
1020         __attribute__((__aligned__(4))) event_##call;
1021 #undef FTRACE_ENTRY_DUP
1022 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1023         FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1024                      filter)
1025 #include "trace_entries.h"
1026
1027 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1028 int perf_ftrace_event_register(struct ftrace_event_call *call,
1029                                enum trace_reg type, void *data);
1030 #else
1031 #define perf_ftrace_event_register NULL
1032 #endif
1033
1034 #endif /* _LINUX_KERNEL_TRACE_H */