staging:vt6655:ttype: Whitespace cleanups
[linux-2.6.git] / kernel / trace / trace.h
blob57d7e5397d56da86f667e3139fb14703a99e8fcf
1 #ifndef _LINUX_KERNEL_TRACE_H
2 #define _LINUX_KERNEL_TRACE_H
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>
16 enum trace_type {
17 __TRACE_FIRST_TYPE = 0,
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,
33 __TRACE_LAST_TYPE,
37 #undef __field
38 #define __field(type, item) type item;
40 #undef __field_struct
41 #define __field_struct(type, item) __field(type, item)
43 #undef __field_desc
44 #define __field_desc(type, container, item)
46 #undef __array
47 #define __array(type, item, size) type item[size];
49 #undef __array_desc
50 #define __array_desc(type, container, item, size)
52 #undef __dynamic_array
53 #define __dynamic_array(type, item) type item[];
55 #undef F_STRUCT
56 #define F_STRUCT(args...) args
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 \
65 #undef TP_ARGS
66 #define TP_ARGS(args...) args
68 #undef FTRACE_ENTRY_DUP
69 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
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)
77 #include "trace_entries.h"
80 * syscalls are special, and need special handling, this is why
81 * they are not included in trace_entries.h
83 struct syscall_trace_enter {
84 struct trace_entry ent;
85 int nr;
86 unsigned long args[];
89 struct syscall_trace_exit {
90 struct trace_entry ent;
91 int nr;
92 long ret;
95 struct kprobe_trace_entry_head {
96 struct trace_entry ent;
97 unsigned long ip;
100 struct kretprobe_trace_entry_head {
101 struct trace_entry ent;
102 unsigned long func;
103 unsigned long ret_ip;
106 struct uprobe_trace_entry_head {
107 struct trace_entry ent;
108 unsigned long ip;
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
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,
128 #define TRACE_BUF_SIZE 1024
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.)
135 struct trace_array_cpu {
136 atomic_t disabled;
137 void *buffer_page; /* ring buffer spare */
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];
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:
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];
168 #define FTRACE_CMP_TYPE(var, type) \
169 __builtin_types_compatible_p(typeof(var), type *)
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; \
179 /* Will cause compile errors if type is not found. */
180 extern void __ftrace_bad_type(void);
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:
187 * IF_ASSIGN(var, ent, type, id);
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.
193 * If the type can have more than one id, then use zero.
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)
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.
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 */
226 * The set of specific options for a tracer. Your tracer
227 * have to set the initial value of the flags val.
229 struct tracer_flags {
230 u32 val;
231 struct tracer_opt *opts;
234 /* Makes more easy to define a tracer opt */
235 #define TRACER_OPT(s, b) .name = #s, .bit = b
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
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 bool allocated_snapshot;
294 /* Only current can touch trace_recursion */
297 * For function tracing recursion:
298 * The order of these bits are important.
300 * When function tracing occurs, the following steps are made:
301 * If arch does not support a ftrace feature:
302 * call internal function (uses INTERNAL bits) which calls...
303 * If callback is registered to the "global" list, the list
304 * function is called and recursion checks the GLOBAL bits.
305 * then this function calls...
306 * The function callback, which can use the FTRACE bits to
307 * check for recursion.
309 * Now if the arch does not suppport a feature, and it calls
310 * the global list function which calls the ftrace callback
311 * all three of these steps will do a recursion protection.
312 * There's no reason to do one if the previous caller already
313 * did. The recursion that we are protecting against will
314 * go through the same steps again.
316 * To prevent the multiple recursion checks, if a recursion
317 * bit is set that is higher than the MAX bit of the current
318 * check, then we know that the check was made by the previous
319 * caller, and we can skip the current check.
321 enum {
322 TRACE_BUFFER_BIT,
323 TRACE_BUFFER_NMI_BIT,
324 TRACE_BUFFER_IRQ_BIT,
325 TRACE_BUFFER_SIRQ_BIT,
327 /* Start of function recursion bits */
328 TRACE_FTRACE_BIT,
329 TRACE_FTRACE_NMI_BIT,
330 TRACE_FTRACE_IRQ_BIT,
331 TRACE_FTRACE_SIRQ_BIT,
333 /* GLOBAL_BITs must be greater than FTRACE_BITs */
334 TRACE_GLOBAL_BIT,
335 TRACE_GLOBAL_NMI_BIT,
336 TRACE_GLOBAL_IRQ_BIT,
337 TRACE_GLOBAL_SIRQ_BIT,
339 /* INTERNAL_BITs must be greater than GLOBAL_BITs */
340 TRACE_INTERNAL_BIT,
341 TRACE_INTERNAL_NMI_BIT,
342 TRACE_INTERNAL_IRQ_BIT,
343 TRACE_INTERNAL_SIRQ_BIT,
345 TRACE_CONTROL_BIT,
348 * Abuse of the trace_recursion.
349 * As we need a way to maintain state if we are tracing the function
350 * graph in irq because we want to trace a particular function that
351 * was called in irq context but we have irq tracing off. Since this
352 * can only be modified by current, we can reuse trace_recursion.
354 TRACE_IRQ_BIT,
357 #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
358 #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
359 #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
361 #define TRACE_CONTEXT_BITS 4
363 #define TRACE_FTRACE_START TRACE_FTRACE_BIT
364 #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
366 #define TRACE_GLOBAL_START TRACE_GLOBAL_BIT
367 #define TRACE_GLOBAL_MAX ((1 << (TRACE_GLOBAL_START + TRACE_CONTEXT_BITS)) - 1)
369 #define TRACE_LIST_START TRACE_INTERNAL_BIT
370 #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
372 #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
374 static __always_inline int trace_get_context_bit(void)
376 int bit;
378 if (in_interrupt()) {
379 if (in_nmi())
380 bit = 0;
382 else if (in_irq())
383 bit = 1;
384 else
385 bit = 2;
386 } else
387 bit = 3;
389 return bit;
392 static __always_inline int trace_test_and_set_recursion(int start, int max)
394 unsigned int val = current->trace_recursion;
395 int bit;
397 /* A previous recursion check was made */
398 if ((val & TRACE_CONTEXT_MASK) > max)
399 return 0;
401 bit = trace_get_context_bit() + start;
402 if (unlikely(val & (1 << bit)))
403 return -1;
405 val |= 1 << bit;
406 current->trace_recursion = val;
407 barrier();
409 return bit;
412 static __always_inline void trace_clear_recursion(int bit)
414 unsigned int val = current->trace_recursion;
416 if (!bit)
417 return;
419 bit = 1 << bit;
420 val &= ~bit;
422 barrier();
423 current->trace_recursion = val;
426 #define TRACE_PIPE_ALL_CPU -1
428 static inline struct ring_buffer_iter *
429 trace_buffer_iter(struct trace_iterator *iter, int cpu)
431 if (iter->buffer_iter && iter->buffer_iter[cpu])
432 return iter->buffer_iter[cpu];
433 return NULL;
436 int tracer_init(struct tracer *t, struct trace_array *tr);
437 int tracing_is_enabled(void);
438 void tracing_reset(struct trace_array *tr, int cpu);
439 void tracing_reset_online_cpus(struct trace_array *tr);
440 void tracing_reset_current(int cpu);
441 void tracing_reset_current_online_cpus(void);
442 int tracing_open_generic(struct inode *inode, struct file *filp);
443 struct dentry *trace_create_file(const char *name,
444 umode_t mode,
445 struct dentry *parent,
446 void *data,
447 const struct file_operations *fops);
449 struct dentry *tracing_init_dentry(void);
451 struct ring_buffer_event;
453 struct ring_buffer_event *
454 trace_buffer_lock_reserve(struct ring_buffer *buffer,
455 int type,
456 unsigned long len,
457 unsigned long flags,
458 int pc);
460 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
461 struct trace_array_cpu *data);
463 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
464 int *ent_cpu, u64 *ent_ts);
466 void __buffer_unlock_commit(struct ring_buffer *buffer,
467 struct ring_buffer_event *event);
469 int trace_empty(struct trace_iterator *iter);
471 void *trace_find_next_entry_inc(struct trace_iterator *iter);
473 void trace_init_global_iter(struct trace_iterator *iter);
475 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
477 void poll_wait_pipe(struct trace_iterator *iter);
479 void ftrace(struct trace_array *tr,
480 struct trace_array_cpu *data,
481 unsigned long ip,
482 unsigned long parent_ip,
483 unsigned long flags, int pc);
484 void tracing_sched_switch_trace(struct trace_array *tr,
485 struct task_struct *prev,
486 struct task_struct *next,
487 unsigned long flags, int pc);
489 void tracing_sched_wakeup_trace(struct trace_array *tr,
490 struct task_struct *wakee,
491 struct task_struct *cur,
492 unsigned long flags, int pc);
493 void trace_function(struct trace_array *tr,
494 unsigned long ip,
495 unsigned long parent_ip,
496 unsigned long flags, int pc);
497 void trace_graph_function(struct trace_array *tr,
498 unsigned long ip,
499 unsigned long parent_ip,
500 unsigned long flags, int pc);
501 void trace_latency_header(struct seq_file *m);
502 void trace_default_header(struct seq_file *m);
503 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
504 int trace_empty(struct trace_iterator *iter);
506 void trace_graph_return(struct ftrace_graph_ret *trace);
507 int trace_graph_entry(struct ftrace_graph_ent *trace);
508 void set_graph_array(struct trace_array *tr);
510 void tracing_start_cmdline_record(void);
511 void tracing_stop_cmdline_record(void);
512 void tracing_sched_switch_assign_trace(struct trace_array *tr);
513 void tracing_stop_sched_switch_record(void);
514 void tracing_start_sched_switch_record(void);
515 int register_tracer(struct tracer *type);
516 int is_tracing_stopped(void);
518 extern cpumask_var_t __read_mostly tracing_buffer_mask;
520 #define for_each_tracing_cpu(cpu) \
521 for_each_cpu(cpu, tracing_buffer_mask)
523 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
525 extern unsigned long tracing_thresh;
527 #ifdef CONFIG_TRACER_MAX_TRACE
528 extern unsigned long tracing_max_latency;
530 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
531 void update_max_tr_single(struct trace_array *tr,
532 struct task_struct *tsk, int cpu);
533 #endif /* CONFIG_TRACER_MAX_TRACE */
535 #ifdef CONFIG_STACKTRACE
536 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
537 int skip, int pc);
539 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
540 int skip, int pc, struct pt_regs *regs);
542 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
543 int pc);
545 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
546 int pc);
547 #else
548 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
549 unsigned long flags, int skip, int pc)
553 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
554 unsigned long flags, int skip,
555 int pc, struct pt_regs *regs)
559 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
560 unsigned long flags, int pc)
564 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
565 int skip, int pc)
568 #endif /* CONFIG_STACKTRACE */
570 extern cycle_t ftrace_now(int cpu);
572 extern void trace_find_cmdline(int pid, char comm[]);
574 #ifdef CONFIG_DYNAMIC_FTRACE
575 extern unsigned long ftrace_update_tot_cnt;
576 #endif
577 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
578 extern int DYN_FTRACE_TEST_NAME(void);
579 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
580 extern int DYN_FTRACE_TEST_NAME2(void);
582 extern int ring_buffer_expanded;
583 extern bool tracing_selftest_disabled;
584 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
586 #ifdef CONFIG_FTRACE_STARTUP_TEST
587 extern int trace_selftest_startup_function(struct tracer *trace,
588 struct trace_array *tr);
589 extern int trace_selftest_startup_function_graph(struct tracer *trace,
590 struct trace_array *tr);
591 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
592 struct trace_array *tr);
593 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
594 struct trace_array *tr);
595 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
596 struct trace_array *tr);
597 extern int trace_selftest_startup_wakeup(struct tracer *trace,
598 struct trace_array *tr);
599 extern int trace_selftest_startup_nop(struct tracer *trace,
600 struct trace_array *tr);
601 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
602 struct trace_array *tr);
603 extern int trace_selftest_startup_branch(struct tracer *trace,
604 struct trace_array *tr);
605 #endif /* CONFIG_FTRACE_STARTUP_TEST */
607 extern void *head_page(struct trace_array_cpu *data);
608 extern unsigned long long ns2usecs(cycle_t nsec);
609 extern int
610 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
611 extern int
612 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
613 extern int
614 trace_array_vprintk(struct trace_array *tr,
615 unsigned long ip, const char *fmt, va_list args);
616 int trace_array_printk(struct trace_array *tr,
617 unsigned long ip, const char *fmt, ...);
618 void trace_printk_seq(struct trace_seq *s);
619 enum print_line_t print_trace_line(struct trace_iterator *iter);
621 extern unsigned long trace_flags;
623 extern int trace_clock_id;
625 /* Standard output formatting function used for function return traces */
626 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
628 /* Flag options */
629 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
630 #define TRACE_GRAPH_PRINT_CPU 0x2
631 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
632 #define TRACE_GRAPH_PRINT_PROC 0x8
633 #define TRACE_GRAPH_PRINT_DURATION 0x10
634 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
636 extern enum print_line_t
637 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
638 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
639 extern enum print_line_t
640 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
641 extern void graph_trace_open(struct trace_iterator *iter);
642 extern void graph_trace_close(struct trace_iterator *iter);
643 extern int __trace_graph_entry(struct trace_array *tr,
644 struct ftrace_graph_ent *trace,
645 unsigned long flags, int pc);
646 extern void __trace_graph_return(struct trace_array *tr,
647 struct ftrace_graph_ret *trace,
648 unsigned long flags, int pc);
651 #ifdef CONFIG_DYNAMIC_FTRACE
652 /* TODO: make this variable */
653 #define FTRACE_GRAPH_MAX_FUNCS 32
654 extern int ftrace_graph_filter_enabled;
655 extern int ftrace_graph_count;
656 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
658 static inline int ftrace_graph_addr(unsigned long addr)
660 int i;
662 if (!ftrace_graph_filter_enabled)
663 return 1;
665 for (i = 0; i < ftrace_graph_count; i++) {
666 if (addr == ftrace_graph_funcs[i]) {
668 * If no irqs are to be traced, but a set_graph_function
669 * is set, and called by an interrupt handler, we still
670 * want to trace it.
672 if (in_irq())
673 trace_recursion_set(TRACE_IRQ_BIT);
674 else
675 trace_recursion_clear(TRACE_IRQ_BIT);
676 return 1;
680 return 0;
682 #else
683 static inline int ftrace_graph_addr(unsigned long addr)
685 return 1;
687 #endif /* CONFIG_DYNAMIC_FTRACE */
688 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
689 static inline enum print_line_t
690 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
692 return TRACE_TYPE_UNHANDLED;
694 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
696 extern struct list_head ftrace_pids;
698 #ifdef CONFIG_FUNCTION_TRACER
699 static inline int ftrace_trace_task(struct task_struct *task)
701 if (list_empty(&ftrace_pids))
702 return 1;
704 return test_tsk_trace_trace(task);
706 extern int ftrace_is_dead(void);
707 #else
708 static inline int ftrace_trace_task(struct task_struct *task)
710 return 1;
712 static inline int ftrace_is_dead(void) { return 0; }
713 #endif
715 int ftrace_event_is_function(struct ftrace_event_call *call);
718 * struct trace_parser - servers for reading the user input separated by spaces
719 * @cont: set if the input is not complete - no final space char was found
720 * @buffer: holds the parsed user input
721 * @idx: user input length
722 * @size: buffer size
724 struct trace_parser {
725 bool cont;
726 char *buffer;
727 unsigned idx;
728 unsigned size;
731 static inline bool trace_parser_loaded(struct trace_parser *parser)
733 return (parser->idx != 0);
736 static inline bool trace_parser_cont(struct trace_parser *parser)
738 return parser->cont;
741 static inline void trace_parser_clear(struct trace_parser *parser)
743 parser->cont = false;
744 parser->idx = 0;
747 extern int trace_parser_get_init(struct trace_parser *parser, int size);
748 extern void trace_parser_put(struct trace_parser *parser);
749 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
750 size_t cnt, loff_t *ppos);
753 * trace_iterator_flags is an enumeration that defines bit
754 * positions into trace_flags that controls the output.
756 * NOTE: These bits must match the trace_options array in
757 * trace.c.
759 enum trace_iterator_flags {
760 TRACE_ITER_PRINT_PARENT = 0x01,
761 TRACE_ITER_SYM_OFFSET = 0x02,
762 TRACE_ITER_SYM_ADDR = 0x04,
763 TRACE_ITER_VERBOSE = 0x08,
764 TRACE_ITER_RAW = 0x10,
765 TRACE_ITER_HEX = 0x20,
766 TRACE_ITER_BIN = 0x40,
767 TRACE_ITER_BLOCK = 0x80,
768 TRACE_ITER_STACKTRACE = 0x100,
769 TRACE_ITER_PRINTK = 0x200,
770 TRACE_ITER_PREEMPTONLY = 0x400,
771 TRACE_ITER_BRANCH = 0x800,
772 TRACE_ITER_ANNOTATE = 0x1000,
773 TRACE_ITER_USERSTACKTRACE = 0x2000,
774 TRACE_ITER_SYM_USEROBJ = 0x4000,
775 TRACE_ITER_PRINTK_MSGONLY = 0x8000,
776 TRACE_ITER_CONTEXT_INFO = 0x10000, /* Print pid/cpu/time */
777 TRACE_ITER_LATENCY_FMT = 0x20000,
778 TRACE_ITER_SLEEP_TIME = 0x40000,
779 TRACE_ITER_GRAPH_TIME = 0x80000,
780 TRACE_ITER_RECORD_CMD = 0x100000,
781 TRACE_ITER_OVERWRITE = 0x200000,
782 TRACE_ITER_STOP_ON_FREE = 0x400000,
783 TRACE_ITER_IRQ_INFO = 0x800000,
784 TRACE_ITER_MARKERS = 0x1000000,
788 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
789 * control the output of kernel symbols.
791 #define TRACE_ITER_SYM_MASK \
792 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
794 extern struct tracer nop_trace;
796 #ifdef CONFIG_BRANCH_TRACER
797 extern int enable_branch_tracing(struct trace_array *tr);
798 extern void disable_branch_tracing(void);
799 static inline int trace_branch_enable(struct trace_array *tr)
801 if (trace_flags & TRACE_ITER_BRANCH)
802 return enable_branch_tracing(tr);
803 return 0;
805 static inline void trace_branch_disable(void)
807 /* due to races, always disable */
808 disable_branch_tracing();
810 #else
811 static inline int trace_branch_enable(struct trace_array *tr)
813 return 0;
815 static inline void trace_branch_disable(void)
818 #endif /* CONFIG_BRANCH_TRACER */
820 /* set ring buffers to default size if not already done so */
821 int tracing_update_buffers(void);
823 /* trace event type bit fields, not numeric */
824 enum {
825 TRACE_EVENT_TYPE_PRINTF = 1,
826 TRACE_EVENT_TYPE_RAW = 2,
829 struct ftrace_event_field {
830 struct list_head link;
831 char *name;
832 char *type;
833 int filter_type;
834 int offset;
835 int size;
836 int is_signed;
839 struct event_filter {
840 int n_preds; /* Number assigned */
841 int a_preds; /* allocated */
842 struct filter_pred *preds;
843 struct filter_pred *root;
844 char *filter_string;
847 struct event_subsystem {
848 struct list_head list;
849 const char *name;
850 struct dentry *entry;
851 struct event_filter *filter;
852 int nr_events;
853 int ref_count;
856 #define FILTER_PRED_INVALID ((unsigned short)-1)
857 #define FILTER_PRED_IS_RIGHT (1 << 15)
858 #define FILTER_PRED_FOLD (1 << 15)
861 * The max preds is the size of unsigned short with
862 * two flags at the MSBs. One bit is used for both the IS_RIGHT
863 * and FOLD flags. The other is reserved.
865 * 2^14 preds is way more than enough.
867 #define MAX_FILTER_PRED 16384
869 struct filter_pred;
870 struct regex;
872 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
874 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
876 enum regex_type {
877 MATCH_FULL = 0,
878 MATCH_FRONT_ONLY,
879 MATCH_MIDDLE_ONLY,
880 MATCH_END_ONLY,
883 struct regex {
884 char pattern[MAX_FILTER_STR_VAL];
885 int len;
886 int field_len;
887 regex_match_func match;
890 struct filter_pred {
891 filter_pred_fn_t fn;
892 u64 val;
893 struct regex regex;
894 unsigned short *ops;
895 struct ftrace_event_field *field;
896 int offset;
897 int not;
898 int op;
899 unsigned short index;
900 unsigned short parent;
901 unsigned short left;
902 unsigned short right;
905 extern struct list_head ftrace_common_fields;
907 extern enum regex_type
908 filter_parse_regex(char *buff, int len, char **search, int *not);
909 extern void print_event_filter(struct ftrace_event_call *call,
910 struct trace_seq *s);
911 extern int apply_event_filter(struct ftrace_event_call *call,
912 char *filter_string);
913 extern int apply_subsystem_event_filter(struct event_subsystem *system,
914 char *filter_string);
915 extern void print_subsystem_event_filter(struct event_subsystem *system,
916 struct trace_seq *s);
917 extern int filter_assign_type(const char *type);
919 struct list_head *
920 trace_get_fields(struct ftrace_event_call *event_call);
922 static inline int
923 filter_check_discard(struct ftrace_event_call *call, void *rec,
924 struct ring_buffer *buffer,
925 struct ring_buffer_event *event)
927 if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
928 !filter_match_preds(call->filter, rec)) {
929 ring_buffer_discard_commit(buffer, event);
930 return 1;
933 return 0;
936 extern void trace_event_enable_cmd_record(bool enable);
938 extern struct mutex event_mutex;
939 extern struct list_head ftrace_events;
941 extern const char *__start___trace_bprintk_fmt[];
942 extern const char *__stop___trace_bprintk_fmt[];
944 void trace_printk_init_buffers(void);
945 void trace_printk_start_comm(void);
947 #undef FTRACE_ENTRY
948 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
949 extern struct ftrace_event_call \
950 __attribute__((__aligned__(4))) event_##call;
951 #undef FTRACE_ENTRY_DUP
952 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
953 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
954 filter)
955 #include "trace_entries.h"
957 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
958 int perf_ftrace_event_register(struct ftrace_event_call *call,
959 enum trace_reg type, void *data);
960 #else
961 #define perf_ftrace_event_register NULL
962 #endif
964 #endif /* _LINUX_KERNEL_TRACE_H */