]> Pileus Git - ~andy/linux/blob - kernel/trace/trace.h
tracing: Make the trace recursion bits into enums
[~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 enum {
302         TRACE_INTERNAL_BIT = 11,
303         TRACE_INTERNAL_NMI_BIT,
304         TRACE_INTERNAL_IRQ_BIT,
305         TRACE_INTERNAL_SIRQ_BIT,
306
307         TRACE_GLOBAL_BIT,
308         TRACE_GLOBAL_NMI_BIT,
309         TRACE_GLOBAL_IRQ_BIT,
310         TRACE_GLOBAL_SIRQ_BIT,
311
312         TRACE_CONTROL_BIT,
313
314 /*
315  * Abuse of the trace_recursion.
316  * As we need a way to maintain state if we are tracing the function
317  * graph in irq because we want to trace a particular function that
318  * was called in irq context but we have irq tracing off. Since this
319  * can only be modified by current, we can reuse trace_recursion.
320  */
321         TRACE_IRQ_BIT,
322 };
323
324 #define trace_recursion_set(bit)        do { (current)->trace_recursion |= (1<<(bit)); } while (0)
325 #define trace_recursion_clear(bit)      do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
326 #define trace_recursion_test(bit)       ((current)->trace_recursion & (1<<(bit)))
327
328 #define TRACE_PIPE_ALL_CPU      -1
329
330 static inline struct ring_buffer_iter *
331 trace_buffer_iter(struct trace_iterator *iter, int cpu)
332 {
333         if (iter->buffer_iter && iter->buffer_iter[cpu])
334                 return iter->buffer_iter[cpu];
335         return NULL;
336 }
337
338 int tracer_init(struct tracer *t, struct trace_array *tr);
339 int tracing_is_enabled(void);
340 void tracing_reset(struct trace_array *tr, int cpu);
341 void tracing_reset_online_cpus(struct trace_array *tr);
342 void tracing_reset_current(int cpu);
343 void tracing_reset_current_online_cpus(void);
344 int tracing_open_generic(struct inode *inode, struct file *filp);
345 struct dentry *trace_create_file(const char *name,
346                                  umode_t mode,
347                                  struct dentry *parent,
348                                  void *data,
349                                  const struct file_operations *fops);
350
351 struct dentry *tracing_init_dentry(void);
352
353 struct ring_buffer_event;
354
355 struct ring_buffer_event *
356 trace_buffer_lock_reserve(struct ring_buffer *buffer,
357                           int type,
358                           unsigned long len,
359                           unsigned long flags,
360                           int pc);
361
362 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
363                                                 struct trace_array_cpu *data);
364
365 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
366                                           int *ent_cpu, u64 *ent_ts);
367
368 void __buffer_unlock_commit(struct ring_buffer *buffer,
369                             struct ring_buffer_event *event);
370
371 int trace_empty(struct trace_iterator *iter);
372
373 void *trace_find_next_entry_inc(struct trace_iterator *iter);
374
375 void trace_init_global_iter(struct trace_iterator *iter);
376
377 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
378
379 void poll_wait_pipe(struct trace_iterator *iter);
380
381 void ftrace(struct trace_array *tr,
382                             struct trace_array_cpu *data,
383                             unsigned long ip,
384                             unsigned long parent_ip,
385                             unsigned long flags, int pc);
386 void tracing_sched_switch_trace(struct trace_array *tr,
387                                 struct task_struct *prev,
388                                 struct task_struct *next,
389                                 unsigned long flags, int pc);
390
391 void tracing_sched_wakeup_trace(struct trace_array *tr,
392                                 struct task_struct *wakee,
393                                 struct task_struct *cur,
394                                 unsigned long flags, int pc);
395 void trace_function(struct trace_array *tr,
396                     unsigned long ip,
397                     unsigned long parent_ip,
398                     unsigned long flags, int pc);
399 void trace_graph_function(struct trace_array *tr,
400                     unsigned long ip,
401                     unsigned long parent_ip,
402                     unsigned long flags, int pc);
403 void trace_latency_header(struct seq_file *m);
404 void trace_default_header(struct seq_file *m);
405 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
406 int trace_empty(struct trace_iterator *iter);
407
408 void trace_graph_return(struct ftrace_graph_ret *trace);
409 int trace_graph_entry(struct ftrace_graph_ent *trace);
410 void set_graph_array(struct trace_array *tr);
411
412 void tracing_start_cmdline_record(void);
413 void tracing_stop_cmdline_record(void);
414 void tracing_sched_switch_assign_trace(struct trace_array *tr);
415 void tracing_stop_sched_switch_record(void);
416 void tracing_start_sched_switch_record(void);
417 int register_tracer(struct tracer *type);
418 int is_tracing_stopped(void);
419
420 extern cpumask_var_t __read_mostly tracing_buffer_mask;
421
422 #define for_each_tracing_cpu(cpu)       \
423         for_each_cpu(cpu, tracing_buffer_mask)
424
425 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
426
427 extern unsigned long tracing_thresh;
428
429 #ifdef CONFIG_TRACER_MAX_TRACE
430 extern unsigned long tracing_max_latency;
431
432 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
433 void update_max_tr_single(struct trace_array *tr,
434                           struct task_struct *tsk, int cpu);
435 #endif /* CONFIG_TRACER_MAX_TRACE */
436
437 #ifdef CONFIG_STACKTRACE
438 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
439                         int skip, int pc);
440
441 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
442                              int skip, int pc, struct pt_regs *regs);
443
444 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
445                             int pc);
446
447 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
448                    int pc);
449 #else
450 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
451                                       unsigned long flags, int skip, int pc)
452 {
453 }
454
455 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
456                                            unsigned long flags, int skip,
457                                            int pc, struct pt_regs *regs)
458 {
459 }
460
461 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
462                                           unsigned long flags, int pc)
463 {
464 }
465
466 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
467                                  int skip, int pc)
468 {
469 }
470 #endif /* CONFIG_STACKTRACE */
471
472 extern cycle_t ftrace_now(int cpu);
473
474 extern void trace_find_cmdline(int pid, char comm[]);
475
476 #ifdef CONFIG_DYNAMIC_FTRACE
477 extern unsigned long ftrace_update_tot_cnt;
478 #endif
479 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
480 extern int DYN_FTRACE_TEST_NAME(void);
481 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
482 extern int DYN_FTRACE_TEST_NAME2(void);
483
484 extern int ring_buffer_expanded;
485 extern bool tracing_selftest_disabled;
486 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
487
488 #ifdef CONFIG_FTRACE_STARTUP_TEST
489 extern int trace_selftest_startup_function(struct tracer *trace,
490                                            struct trace_array *tr);
491 extern int trace_selftest_startup_function_graph(struct tracer *trace,
492                                                  struct trace_array *tr);
493 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
494                                           struct trace_array *tr);
495 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
496                                              struct trace_array *tr);
497 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
498                                                  struct trace_array *tr);
499 extern int trace_selftest_startup_wakeup(struct tracer *trace,
500                                          struct trace_array *tr);
501 extern int trace_selftest_startup_nop(struct tracer *trace,
502                                          struct trace_array *tr);
503 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
504                                                struct trace_array *tr);
505 extern int trace_selftest_startup_branch(struct tracer *trace,
506                                          struct trace_array *tr);
507 #endif /* CONFIG_FTRACE_STARTUP_TEST */
508
509 extern void *head_page(struct trace_array_cpu *data);
510 extern unsigned long long ns2usecs(cycle_t nsec);
511 extern int
512 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
513 extern int
514 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
515 extern int
516 trace_array_vprintk(struct trace_array *tr,
517                     unsigned long ip, const char *fmt, va_list args);
518 int trace_array_printk(struct trace_array *tr,
519                        unsigned long ip, const char *fmt, ...);
520 void trace_printk_seq(struct trace_seq *s);
521 enum print_line_t print_trace_line(struct trace_iterator *iter);
522
523 extern unsigned long trace_flags;
524
525 extern int trace_clock_id;
526
527 /* Standard output formatting function used for function return traces */
528 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
529
530 /* Flag options */
531 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
532 #define TRACE_GRAPH_PRINT_CPU           0x2
533 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
534 #define TRACE_GRAPH_PRINT_PROC          0x8
535 #define TRACE_GRAPH_PRINT_DURATION      0x10
536 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
537
538 extern enum print_line_t
539 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
540 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
541 extern enum print_line_t
542 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
543 extern void graph_trace_open(struct trace_iterator *iter);
544 extern void graph_trace_close(struct trace_iterator *iter);
545 extern int __trace_graph_entry(struct trace_array *tr,
546                                struct ftrace_graph_ent *trace,
547                                unsigned long flags, int pc);
548 extern void __trace_graph_return(struct trace_array *tr,
549                                  struct ftrace_graph_ret *trace,
550                                  unsigned long flags, int pc);
551
552
553 #ifdef CONFIG_DYNAMIC_FTRACE
554 /* TODO: make this variable */
555 #define FTRACE_GRAPH_MAX_FUNCS          32
556 extern int ftrace_graph_filter_enabled;
557 extern int ftrace_graph_count;
558 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
559
560 static inline int ftrace_graph_addr(unsigned long addr)
561 {
562         int i;
563
564         if (!ftrace_graph_filter_enabled)
565                 return 1;
566
567         for (i = 0; i < ftrace_graph_count; i++) {
568                 if (addr == ftrace_graph_funcs[i]) {
569                         /*
570                          * If no irqs are to be traced, but a set_graph_function
571                          * is set, and called by an interrupt handler, we still
572                          * want to trace it.
573                          */
574                         if (in_irq())
575                                 trace_recursion_set(TRACE_IRQ_BIT);
576                         else
577                                 trace_recursion_clear(TRACE_IRQ_BIT);
578                         return 1;
579                 }
580         }
581
582         return 0;
583 }
584 #else
585 static inline int ftrace_graph_addr(unsigned long addr)
586 {
587         return 1;
588 }
589 #endif /* CONFIG_DYNAMIC_FTRACE */
590 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
591 static inline enum print_line_t
592 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
593 {
594         return TRACE_TYPE_UNHANDLED;
595 }
596 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
597
598 extern struct list_head ftrace_pids;
599
600 #ifdef CONFIG_FUNCTION_TRACER
601 static inline int ftrace_trace_task(struct task_struct *task)
602 {
603         if (list_empty(&ftrace_pids))
604                 return 1;
605
606         return test_tsk_trace_trace(task);
607 }
608 extern int ftrace_is_dead(void);
609 #else
610 static inline int ftrace_trace_task(struct task_struct *task)
611 {
612         return 1;
613 }
614 static inline int ftrace_is_dead(void) { return 0; }
615 #endif
616
617 int ftrace_event_is_function(struct ftrace_event_call *call);
618
619 /*
620  * struct trace_parser - servers for reading the user input separated by spaces
621  * @cont: set if the input is not complete - no final space char was found
622  * @buffer: holds the parsed user input
623  * @idx: user input length
624  * @size: buffer size
625  */
626 struct trace_parser {
627         bool            cont;
628         char            *buffer;
629         unsigned        idx;
630         unsigned        size;
631 };
632
633 static inline bool trace_parser_loaded(struct trace_parser *parser)
634 {
635         return (parser->idx != 0);
636 }
637
638 static inline bool trace_parser_cont(struct trace_parser *parser)
639 {
640         return parser->cont;
641 }
642
643 static inline void trace_parser_clear(struct trace_parser *parser)
644 {
645         parser->cont = false;
646         parser->idx = 0;
647 }
648
649 extern int trace_parser_get_init(struct trace_parser *parser, int size);
650 extern void trace_parser_put(struct trace_parser *parser);
651 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
652         size_t cnt, loff_t *ppos);
653
654 /*
655  * trace_iterator_flags is an enumeration that defines bit
656  * positions into trace_flags that controls the output.
657  *
658  * NOTE: These bits must match the trace_options array in
659  *       trace.c.
660  */
661 enum trace_iterator_flags {
662         TRACE_ITER_PRINT_PARENT         = 0x01,
663         TRACE_ITER_SYM_OFFSET           = 0x02,
664         TRACE_ITER_SYM_ADDR             = 0x04,
665         TRACE_ITER_VERBOSE              = 0x08,
666         TRACE_ITER_RAW                  = 0x10,
667         TRACE_ITER_HEX                  = 0x20,
668         TRACE_ITER_BIN                  = 0x40,
669         TRACE_ITER_BLOCK                = 0x80,
670         TRACE_ITER_STACKTRACE           = 0x100,
671         TRACE_ITER_PRINTK               = 0x200,
672         TRACE_ITER_PREEMPTONLY          = 0x400,
673         TRACE_ITER_BRANCH               = 0x800,
674         TRACE_ITER_ANNOTATE             = 0x1000,
675         TRACE_ITER_USERSTACKTRACE       = 0x2000,
676         TRACE_ITER_SYM_USEROBJ          = 0x4000,
677         TRACE_ITER_PRINTK_MSGONLY       = 0x8000,
678         TRACE_ITER_CONTEXT_INFO         = 0x10000, /* Print pid/cpu/time */
679         TRACE_ITER_LATENCY_FMT          = 0x20000,
680         TRACE_ITER_SLEEP_TIME           = 0x40000,
681         TRACE_ITER_GRAPH_TIME           = 0x80000,
682         TRACE_ITER_RECORD_CMD           = 0x100000,
683         TRACE_ITER_OVERWRITE            = 0x200000,
684         TRACE_ITER_STOP_ON_FREE         = 0x400000,
685         TRACE_ITER_IRQ_INFO             = 0x800000,
686         TRACE_ITER_MARKERS              = 0x1000000,
687 };
688
689 /*
690  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
691  * control the output of kernel symbols.
692  */
693 #define TRACE_ITER_SYM_MASK \
694         (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
695
696 extern struct tracer nop_trace;
697
698 #ifdef CONFIG_BRANCH_TRACER
699 extern int enable_branch_tracing(struct trace_array *tr);
700 extern void disable_branch_tracing(void);
701 static inline int trace_branch_enable(struct trace_array *tr)
702 {
703         if (trace_flags & TRACE_ITER_BRANCH)
704                 return enable_branch_tracing(tr);
705         return 0;
706 }
707 static inline void trace_branch_disable(void)
708 {
709         /* due to races, always disable */
710         disable_branch_tracing();
711 }
712 #else
713 static inline int trace_branch_enable(struct trace_array *tr)
714 {
715         return 0;
716 }
717 static inline void trace_branch_disable(void)
718 {
719 }
720 #endif /* CONFIG_BRANCH_TRACER */
721
722 /* set ring buffers to default size if not already done so */
723 int tracing_update_buffers(void);
724
725 /* trace event type bit fields, not numeric */
726 enum {
727         TRACE_EVENT_TYPE_PRINTF         = 1,
728         TRACE_EVENT_TYPE_RAW            = 2,
729 };
730
731 struct ftrace_event_field {
732         struct list_head        link;
733         char                    *name;
734         char                    *type;
735         int                     filter_type;
736         int                     offset;
737         int                     size;
738         int                     is_signed;
739 };
740
741 struct event_filter {
742         int                     n_preds;        /* Number assigned */
743         int                     a_preds;        /* allocated */
744         struct filter_pred      *preds;
745         struct filter_pred      *root;
746         char                    *filter_string;
747 };
748
749 struct event_subsystem {
750         struct list_head        list;
751         const char              *name;
752         struct dentry           *entry;
753         struct event_filter     *filter;
754         int                     nr_events;
755         int                     ref_count;
756 };
757
758 #define FILTER_PRED_INVALID     ((unsigned short)-1)
759 #define FILTER_PRED_IS_RIGHT    (1 << 15)
760 #define FILTER_PRED_FOLD        (1 << 15)
761
762 /*
763  * The max preds is the size of unsigned short with
764  * two flags at the MSBs. One bit is used for both the IS_RIGHT
765  * and FOLD flags. The other is reserved.
766  *
767  * 2^14 preds is way more than enough.
768  */
769 #define MAX_FILTER_PRED         16384
770
771 struct filter_pred;
772 struct regex;
773
774 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
775
776 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
777
778 enum regex_type {
779         MATCH_FULL = 0,
780         MATCH_FRONT_ONLY,
781         MATCH_MIDDLE_ONLY,
782         MATCH_END_ONLY,
783 };
784
785 struct regex {
786         char                    pattern[MAX_FILTER_STR_VAL];
787         int                     len;
788         int                     field_len;
789         regex_match_func        match;
790 };
791
792 struct filter_pred {
793         filter_pred_fn_t        fn;
794         u64                     val;
795         struct regex            regex;
796         unsigned short          *ops;
797         struct ftrace_event_field *field;
798         int                     offset;
799         int                     not;
800         int                     op;
801         unsigned short          index;
802         unsigned short          parent;
803         unsigned short          left;
804         unsigned short          right;
805 };
806
807 extern struct list_head ftrace_common_fields;
808
809 extern enum regex_type
810 filter_parse_regex(char *buff, int len, char **search, int *not);
811 extern void print_event_filter(struct ftrace_event_call *call,
812                                struct trace_seq *s);
813 extern int apply_event_filter(struct ftrace_event_call *call,
814                               char *filter_string);
815 extern int apply_subsystem_event_filter(struct event_subsystem *system,
816                                         char *filter_string);
817 extern void print_subsystem_event_filter(struct event_subsystem *system,
818                                          struct trace_seq *s);
819 extern int filter_assign_type(const char *type);
820
821 struct list_head *
822 trace_get_fields(struct ftrace_event_call *event_call);
823
824 static inline int
825 filter_check_discard(struct ftrace_event_call *call, void *rec,
826                      struct ring_buffer *buffer,
827                      struct ring_buffer_event *event)
828 {
829         if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
830             !filter_match_preds(call->filter, rec)) {
831                 ring_buffer_discard_commit(buffer, event);
832                 return 1;
833         }
834
835         return 0;
836 }
837
838 extern void trace_event_enable_cmd_record(bool enable);
839
840 extern struct mutex event_mutex;
841 extern struct list_head ftrace_events;
842
843 extern const char *__start___trace_bprintk_fmt[];
844 extern const char *__stop___trace_bprintk_fmt[];
845
846 void trace_printk_init_buffers(void);
847 void trace_printk_start_comm(void);
848
849 #undef FTRACE_ENTRY
850 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)     \
851         extern struct ftrace_event_call                                 \
852         __attribute__((__aligned__(4))) event_##call;
853 #undef FTRACE_ENTRY_DUP
854 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
855         FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
856                      filter)
857 #include "trace_entries.h"
858
859 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
860 int perf_ftrace_event_register(struct ftrace_event_call *call,
861                                enum trace_reg type, void *data);
862 #else
863 #define perf_ftrace_event_register NULL
864 #endif
865
866 #endif /* _LINUX_KERNEL_TRACE_H */