1 #ifndef _LINUX_KERNEL_TRACE_H
2 #define _LINUX_KERNEL_TRACE_H
5 #include <asm/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/ftrace.h>
11 #include <trace/boot.h>
12 #include <trace/kmemtrace.h>
15 __TRACE_FIRST_TYPE = 0,
40 * The trace entry - the most basic unit of tracing. This is what
41 * is printed in the end as a single line in the trace output, such as:
43 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
49 unsigned char preempt_count;
55 * Function trace entry - function address and parent function addres:
58 struct trace_entry ent;
60 unsigned long parent_ip;
63 /* Function call entry */
64 struct ftrace_graph_ent_entry {
65 struct trace_entry ent;
66 struct ftrace_graph_ent graph_ent;
69 /* Function return entry */
70 struct ftrace_graph_ret_entry {
71 struct trace_entry ent;
72 struct ftrace_graph_ret ret;
74 extern struct tracer boot_tracer;
77 * Context switch trace entry - which task (and prio) we switched from/to:
79 struct ctx_switch_entry {
80 struct trace_entry ent;
81 unsigned int prev_pid;
82 unsigned char prev_prio;
83 unsigned char prev_state;
84 unsigned int next_pid;
85 unsigned char next_prio;
86 unsigned char next_state;
87 unsigned int next_cpu;
91 * Special (free-form) trace entry:
93 struct special_entry {
94 struct trace_entry ent;
104 #define FTRACE_STACK_ENTRIES 8
107 struct trace_entry ent;
108 unsigned long caller[FTRACE_STACK_ENTRIES];
111 struct userstack_entry {
112 struct trace_entry ent;
113 unsigned long caller[FTRACE_STACK_ENTRIES];
117 * ftrace_printk entry:
120 struct trace_entry ent;
126 #define TRACE_OLD_SIZE 88
128 struct trace_field_cont {
130 /* Temporary till we get rid of this completely */
131 char buf[TRACE_OLD_SIZE - 1];
134 struct trace_mmiotrace_rw {
135 struct trace_entry ent;
136 struct mmiotrace_rw rw;
139 struct trace_mmiotrace_map {
140 struct trace_entry ent;
141 struct mmiotrace_map map;
144 struct trace_boot_call {
145 struct trace_entry ent;
146 struct boot_trace_call boot_call;
149 struct trace_boot_ret {
150 struct trace_entry ent;
151 struct boot_trace_ret boot_ret;
154 #define TRACE_FUNC_SIZE 30
155 #define TRACE_FILE_SIZE 20
156 struct trace_branch {
157 struct trace_entry ent;
159 char func[TRACE_FUNC_SIZE+1];
160 char file[TRACE_FILE_SIZE+1];
164 struct hw_branch_entry {
165 struct trace_entry ent;
171 struct trace_entry ent;
172 struct power_trace state_data;
175 struct kmemtrace_alloc_entry {
176 struct trace_entry ent;
177 enum kmemtrace_type_id type_id;
178 unsigned long call_site;
186 struct kmemtrace_free_entry {
187 struct trace_entry ent;
188 enum kmemtrace_type_id type_id;
189 unsigned long call_site;
194 * trace_flag_type is an enumeration that holds different
195 * states when a trace occurs. These are:
196 * IRQS_OFF - interrupts were disabled
197 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
198 * NEED_RESCED - reschedule is requested
199 * HARDIRQ - inside an interrupt handler
200 * SOFTIRQ - inside a softirq handler
202 enum trace_flag_type {
203 TRACE_FLAG_IRQS_OFF = 0x01,
204 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
205 TRACE_FLAG_NEED_RESCHED = 0x04,
206 TRACE_FLAG_HARDIRQ = 0x08,
207 TRACE_FLAG_SOFTIRQ = 0x10,
210 #define TRACE_BUF_SIZE 1024
213 * The CPU trace array - it consists of thousands of trace entries
214 * plus some other descriptor data: (for example which task started
217 struct trace_array_cpu {
220 /* these fields get copied into max-trace: */
221 unsigned long trace_idx;
222 unsigned long overrun;
223 unsigned long saved_latency;
224 unsigned long critical_start;
225 unsigned long critical_end;
226 unsigned long critical_sequence;
228 unsigned long policy;
229 unsigned long rt_priority;
230 cycle_t preempt_timestamp;
233 char comm[TASK_COMM_LEN];
236 struct trace_iterator;
239 * The trace array - an array of per-CPU trace arrays. This is the
240 * highest level data structure that individual tracers deal with.
241 * They have on/off state as well:
244 struct ring_buffer *buffer;
245 unsigned long entries;
248 struct task_struct *waiter;
249 struct trace_array_cpu *data[NR_CPUS];
252 #define FTRACE_CMP_TYPE(var, type) \
253 __builtin_types_compatible_p(typeof(var), type *)
256 #define IF_ASSIGN(var, entry, etype, id) \
257 if (FTRACE_CMP_TYPE(var, etype)) { \
258 var = (typeof(var))(entry); \
259 WARN_ON(id && (entry)->type != id); \
263 /* Will cause compile errors if type is not found. */
264 extern void __ftrace_bad_type(void);
267 * The trace_assign_type is a verifier that the entry type is
268 * the same as the type being assigned. To add new types simply
269 * add a line with the following format:
271 * IF_ASSIGN(var, ent, type, id);
273 * Where "type" is the trace type that includes the trace_entry
274 * as the "ent" item. And "id" is the trace identifier that is
275 * used in the trace_type enum.
277 * If the type can have more than one id, then use zero.
279 #define trace_assign_type(var, ent) \
281 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
282 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
283 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
284 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
285 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
286 IF_ASSIGN(var, ent, struct special_entry, 0); \
287 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
289 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
291 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
292 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
293 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
294 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
296 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
298 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
299 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
300 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
302 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
304 __ftrace_bad_type(); \
307 /* Return values for print_line callback */
309 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
310 TRACE_TYPE_HANDLED = 1,
311 TRACE_TYPE_UNHANDLED = 2 /* Relay to other output functions */
316 * An option specific to a tracer. This is a boolean value.
317 * The bit is the bit index that sets its value on the
318 * flags value in struct tracer_flags.
321 const char *name; /* Will appear on the trace_options file */
322 u32 bit; /* Mask assigned in val field in tracer_flags */
326 * The set of specific options for a tracer. Your tracer
327 * have to set the initial value of the flags val.
329 struct tracer_flags {
331 struct tracer_opt *opts;
334 /* Makes more easy to define a tracer opt */
335 #define TRACER_OPT(s, b) .name = #s, .bit = b
339 * A specific tracer, represented by methods that operate on a trace array:
343 /* Your tracer should raise a warning if init fails */
344 int (*init)(struct trace_array *tr);
345 void (*reset)(struct trace_array *tr);
346 void (*start)(struct trace_array *tr);
347 void (*stop)(struct trace_array *tr);
348 void (*open)(struct trace_iterator *iter);
349 void (*pipe_open)(struct trace_iterator *iter);
350 void (*close)(struct trace_iterator *iter);
351 ssize_t (*read)(struct trace_iterator *iter,
352 struct file *filp, char __user *ubuf,
353 size_t cnt, loff_t *ppos);
354 #ifdef CONFIG_FTRACE_STARTUP_TEST
355 int (*selftest)(struct tracer *trace,
356 struct trace_array *tr);
358 void (*print_header)(struct seq_file *m);
359 enum print_line_t (*print_line)(struct trace_iterator *iter);
360 /* If you handled the flag setting, return 0 */
361 int (*set_flag)(u32 old_flags, u32 bit, int set);
364 struct tracer_flags *flags;
365 struct tracer_stat *stats;
369 unsigned char buffer[PAGE_SIZE];
371 unsigned int readpos;
375 * Trace iterator - used by printout routines who present trace
376 * results to users and which routines might sleep, etc:
378 struct trace_iterator {
379 struct trace_array *tr;
380 struct tracer *trace;
382 struct ring_buffer_iter *buffer_iter[NR_CPUS];
384 /* The below is zeroed out in pipe_read */
385 struct trace_seq seq;
386 struct trace_entry *ent;
390 unsigned long iter_flags;
394 cpumask_var_t started;
397 int tracing_is_enabled(void);
398 void trace_wake_up(void);
399 void tracing_reset(struct trace_array *tr, int cpu);
400 void tracing_reset_online_cpus(struct trace_array *tr);
401 int tracing_open_generic(struct inode *inode, struct file *filp);
402 struct dentry *tracing_init_dentry(void);
403 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
405 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
406 struct trace_array_cpu *data);
407 void tracing_generic_entry_update(struct trace_entry *entry,
411 void ftrace(struct trace_array *tr,
412 struct trace_array_cpu *data,
414 unsigned long parent_ip,
415 unsigned long flags, int pc);
416 void tracing_sched_switch_trace(struct trace_array *tr,
417 struct trace_array_cpu *data,
418 struct task_struct *prev,
419 struct task_struct *next,
420 unsigned long flags, int pc);
421 void tracing_record_cmdline(struct task_struct *tsk);
423 void tracing_sched_wakeup_trace(struct trace_array *tr,
424 struct trace_array_cpu *data,
425 struct task_struct *wakee,
426 struct task_struct *cur,
427 unsigned long flags, int pc);
428 void trace_special(struct trace_array *tr,
429 struct trace_array_cpu *data,
432 unsigned long arg3, int pc);
433 void trace_function(struct trace_array *tr,
434 struct trace_array_cpu *data,
436 unsigned long parent_ip,
437 unsigned long flags, int pc);
439 void trace_graph_return(struct ftrace_graph_ret *trace);
440 int trace_graph_entry(struct ftrace_graph_ent *trace);
441 void trace_hw_branch(struct trace_array *tr, u64 from, u64 to);
443 void tracing_start_cmdline_record(void);
444 void tracing_stop_cmdline_record(void);
445 void tracing_sched_switch_assign_trace(struct trace_array *tr);
446 void tracing_stop_sched_switch_record(void);
447 void tracing_start_sched_switch_record(void);
448 int register_tracer(struct tracer *type);
449 void unregister_tracer(struct tracer *type);
451 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
453 extern unsigned long tracing_max_latency;
454 extern unsigned long tracing_thresh;
456 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
457 void update_max_tr_single(struct trace_array *tr,
458 struct task_struct *tsk, int cpu);
460 void __trace_stack(struct trace_array *tr,
461 struct trace_array_cpu *data,
465 extern cycle_t ftrace_now(int cpu);
467 #ifdef CONFIG_FUNCTION_TRACER
468 void tracing_start_function_trace(void);
469 void tracing_stop_function_trace(void);
471 # define tracing_start_function_trace() do { } while (0)
472 # define tracing_stop_function_trace() do { } while (0)
475 extern int ftrace_function_enabled;
477 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
479 (*tracer_switch_func_t)(void *private,
481 struct task_struct *prev,
482 struct task_struct *next);
484 struct tracer_switch_ops {
485 tracer_switch_func_t func;
487 struct tracer_switch_ops *next;
489 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
491 extern char *trace_find_cmdline(int pid);
493 #ifdef CONFIG_DYNAMIC_FTRACE
494 extern unsigned long ftrace_update_tot_cnt;
495 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
496 extern int DYN_FTRACE_TEST_NAME(void);
499 #ifdef CONFIG_FTRACE_STARTUP_TEST
500 extern int trace_selftest_startup_function(struct tracer *trace,
501 struct trace_array *tr);
502 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
503 struct trace_array *tr);
504 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
505 struct trace_array *tr);
506 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
507 struct trace_array *tr);
508 extern int trace_selftest_startup_wakeup(struct tracer *trace,
509 struct trace_array *tr);
510 extern int trace_selftest_startup_nop(struct tracer *trace,
511 struct trace_array *tr);
512 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
513 struct trace_array *tr);
514 extern int trace_selftest_startup_sysprof(struct tracer *trace,
515 struct trace_array *tr);
516 extern int trace_selftest_startup_branch(struct tracer *trace,
517 struct trace_array *tr);
518 #endif /* CONFIG_FTRACE_STARTUP_TEST */
520 extern void *head_page(struct trace_array_cpu *data);
521 extern long ns2usecs(cycle_t nsec);
523 trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
525 extern unsigned long trace_flags;
527 /* Standard output formatting function used for function return traces */
528 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
529 extern enum print_line_t print_graph_function(struct trace_iterator *iter);
531 #ifdef CONFIG_DYNAMIC_FTRACE
532 /* TODO: make this variable */
533 #define FTRACE_GRAPH_MAX_FUNCS 32
534 extern int ftrace_graph_count;
535 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
537 static inline int ftrace_graph_addr(unsigned long addr)
541 if (!ftrace_graph_count || test_tsk_trace_graph(current))
544 for (i = 0; i < ftrace_graph_count; i++) {
545 if (addr == ftrace_graph_funcs[i])
552 static inline int ftrace_trace_addr(unsigned long addr)
556 static inline int ftrace_graph_addr(unsigned long addr)
560 #endif /* CONFIG_DYNAMIC_FTRACE */
562 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
563 static inline enum print_line_t
564 print_graph_function(struct trace_iterator *iter)
566 return TRACE_TYPE_UNHANDLED;
568 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
570 extern struct pid *ftrace_pid_trace;
572 static inline int ftrace_trace_task(struct task_struct *task)
574 if (!ftrace_pid_trace)
577 return test_tsk_trace_trace(task);
581 * trace_iterator_flags is an enumeration that defines bit
582 * positions into trace_flags that controls the output.
584 * NOTE: These bits must match the trace_options array in
587 enum trace_iterator_flags {
588 TRACE_ITER_PRINT_PARENT = 0x01,
589 TRACE_ITER_SYM_OFFSET = 0x02,
590 TRACE_ITER_SYM_ADDR = 0x04,
591 TRACE_ITER_VERBOSE = 0x08,
592 TRACE_ITER_RAW = 0x10,
593 TRACE_ITER_HEX = 0x20,
594 TRACE_ITER_BIN = 0x40,
595 TRACE_ITER_BLOCK = 0x80,
596 TRACE_ITER_STACKTRACE = 0x100,
597 TRACE_ITER_SCHED_TREE = 0x200,
598 TRACE_ITER_PRINTK = 0x400,
599 TRACE_ITER_PREEMPTONLY = 0x800,
600 TRACE_ITER_BRANCH = 0x1000,
601 TRACE_ITER_ANNOTATE = 0x2000,
602 TRACE_ITER_USERSTACKTRACE = 0x4000,
603 TRACE_ITER_SYM_USEROBJ = 0x8000,
604 TRACE_ITER_PRINTK_MSGONLY = 0x10000
608 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
609 * control the output of kernel symbols.
611 #define TRACE_ITER_SYM_MASK \
612 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
614 extern struct tracer nop_trace;
617 * ftrace_preempt_disable - disable preemption scheduler safe
619 * When tracing can happen inside the scheduler, there exists
620 * cases that the tracing might happen before the need_resched
621 * flag is checked. If this happens and the tracer calls
622 * preempt_enable (after a disable), a schedule might take place
623 * causing an infinite recursion.
625 * To prevent this, we read the need_recshed flag before
626 * disabling preemption. When we want to enable preemption we
627 * check the flag, if it is set, then we call preempt_enable_no_resched.
628 * Otherwise, we call preempt_enable.
630 * The rational for doing the above is that if need resched is set
631 * and we have yet to reschedule, we are either in an atomic location
632 * (where we do not need to check for scheduling) or we are inside
633 * the scheduler and do not want to resched.
635 static inline int ftrace_preempt_disable(void)
639 resched = need_resched();
640 preempt_disable_notrace();
646 * ftrace_preempt_enable - enable preemption scheduler safe
647 * @resched: the return value from ftrace_preempt_disable
649 * This is a scheduler safe way to enable preemption and not miss
650 * any preemption checks. The disabled saved the state of preemption.
651 * If resched is set, then we were either inside an atomic or
652 * are inside the scheduler (we would have already scheduled
653 * otherwise). In this case, we do not want to call normal
654 * preempt_enable, but preempt_enable_no_resched instead.
656 static inline void ftrace_preempt_enable(int resched)
659 preempt_enable_no_resched_notrace();
661 preempt_enable_notrace();
664 #ifdef CONFIG_BRANCH_TRACER
665 extern int enable_branch_tracing(struct trace_array *tr);
666 extern void disable_branch_tracing(void);
667 static inline int trace_branch_enable(struct trace_array *tr)
669 if (trace_flags & TRACE_ITER_BRANCH)
670 return enable_branch_tracing(tr);
673 static inline void trace_branch_disable(void)
675 /* due to races, always disable */
676 disable_branch_tracing();
679 static inline int trace_branch_enable(struct trace_array *tr)
683 static inline void trace_branch_disable(void)
686 #endif /* CONFIG_BRANCH_TRACER */
688 #endif /* _LINUX_KERNEL_TRACE_H */