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