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>
14 __TRACE_FIRST_TYPE = 0,
38 * The trace entry - the most basic unit of tracing. This is what
39 * is printed in the end as a single line in the trace output, such as:
41 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
47 unsigned char preempt_count;
53 * Function trace entry - function address and parent function addres:
56 struct trace_entry ent;
58 unsigned long parent_ip;
61 /* Function call entry */
62 struct ftrace_graph_ent_entry {
63 struct trace_entry ent;
64 struct ftrace_graph_ent graph_ent;
67 /* Function return entry */
68 struct ftrace_graph_ret_entry {
69 struct trace_entry ent;
70 struct ftrace_graph_ret ret;
72 extern struct tracer boot_tracer;
75 * Context switch trace entry - which task (and prio) we switched from/to:
77 struct ctx_switch_entry {
78 struct trace_entry ent;
79 unsigned int prev_pid;
80 unsigned char prev_prio;
81 unsigned char prev_state;
82 unsigned int next_pid;
83 unsigned char next_prio;
84 unsigned char next_state;
85 unsigned int next_cpu;
89 * Special (free-form) trace entry:
91 struct special_entry {
92 struct trace_entry ent;
102 #define FTRACE_STACK_ENTRIES 8
105 struct trace_entry ent;
106 unsigned long caller[FTRACE_STACK_ENTRIES];
109 struct userstack_entry {
110 struct trace_entry ent;
111 unsigned long caller[FTRACE_STACK_ENTRIES];
115 * ftrace_printk entry:
118 struct trace_entry ent;
124 #define TRACE_OLD_SIZE 88
126 struct trace_field_cont {
128 /* Temporary till we get rid of this completely */
129 char buf[TRACE_OLD_SIZE - 1];
132 struct trace_mmiotrace_rw {
133 struct trace_entry ent;
134 struct mmiotrace_rw rw;
137 struct trace_mmiotrace_map {
138 struct trace_entry ent;
139 struct mmiotrace_map map;
142 struct trace_boot_call {
143 struct trace_entry ent;
144 struct boot_trace_call boot_call;
147 struct trace_boot_ret {
148 struct trace_entry ent;
149 struct boot_trace_ret boot_ret;
152 #define TRACE_FUNC_SIZE 30
153 #define TRACE_FILE_SIZE 20
154 struct trace_branch {
155 struct trace_entry ent;
157 char func[TRACE_FUNC_SIZE+1];
158 char file[TRACE_FILE_SIZE+1];
162 struct hw_branch_entry {
163 struct trace_entry ent;
169 struct trace_entry ent;
170 struct power_trace state_data;
174 * trace_flag_type is an enumeration that holds different
175 * states when a trace occurs. These are:
176 * IRQS_OFF - interrupts were disabled
177 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
178 * NEED_RESCED - reschedule is requested
179 * HARDIRQ - inside an interrupt handler
180 * SOFTIRQ - inside a softirq handler
181 * CONT - multiple entries hold the trace item
183 enum trace_flag_type {
184 TRACE_FLAG_IRQS_OFF = 0x01,
185 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
186 TRACE_FLAG_NEED_RESCHED = 0x04,
187 TRACE_FLAG_HARDIRQ = 0x08,
188 TRACE_FLAG_SOFTIRQ = 0x10,
189 TRACE_FLAG_CONT = 0x20,
192 #define TRACE_BUF_SIZE 1024
195 * The CPU trace array - it consists of thousands of trace entries
196 * plus some other descriptor data: (for example which task started
199 struct trace_array_cpu {
202 /* these fields get copied into max-trace: */
203 unsigned long trace_idx;
204 unsigned long overrun;
205 unsigned long saved_latency;
206 unsigned long critical_start;
207 unsigned long critical_end;
208 unsigned long critical_sequence;
210 unsigned long policy;
211 unsigned long rt_priority;
212 cycle_t preempt_timestamp;
215 char comm[TASK_COMM_LEN];
218 struct trace_iterator;
221 * The trace array - an array of per-CPU trace arrays. This is the
222 * highest level data structure that individual tracers deal with.
223 * They have on/off state as well:
226 struct ring_buffer *buffer;
227 unsigned long entries;
230 struct task_struct *waiter;
231 struct trace_array_cpu *data[NR_CPUS];
234 #define FTRACE_CMP_TYPE(var, type) \
235 __builtin_types_compatible_p(typeof(var), type *)
238 #define IF_ASSIGN(var, entry, etype, id) \
239 if (FTRACE_CMP_TYPE(var, etype)) { \
240 var = (typeof(var))(entry); \
241 WARN_ON(id && (entry)->type != id); \
245 /* Will cause compile errors if type is not found. */
246 extern void __ftrace_bad_type(void);
249 * The trace_assign_type is a verifier that the entry type is
250 * the same as the type being assigned. To add new types simply
251 * add a line with the following format:
253 * IF_ASSIGN(var, ent, type, id);
255 * Where "type" is the trace type that includes the trace_entry
256 * as the "ent" item. And "id" is the trace identifier that is
257 * used in the trace_type enum.
259 * If the type can have more than one id, then use zero.
261 #define trace_assign_type(var, ent) \
263 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
264 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
265 IF_ASSIGN(var, ent, struct trace_field_cont, TRACE_CONT); \
266 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
267 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
268 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
269 IF_ASSIGN(var, ent, struct special_entry, 0); \
270 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
272 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
274 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
275 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
276 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
277 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
279 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
281 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
282 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
283 __ftrace_bad_type(); \
286 /* Return values for print_line callback */
288 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
289 TRACE_TYPE_HANDLED = 1,
290 TRACE_TYPE_UNHANDLED = 2 /* Relay to other output functions */
295 * An option specific to a tracer. This is a boolean value.
296 * The bit is the bit index that sets its value on the
297 * flags value in struct tracer_flags.
300 const char *name; /* Will appear on the trace_options file */
301 u32 bit; /* Mask assigned in val field in tracer_flags */
305 * The set of specific options for a tracer. Your tracer
306 * have to set the initial value of the flags val.
308 struct tracer_flags {
310 struct tracer_opt *opts;
313 /* Makes more easy to define a tracer opt */
314 #define TRACER_OPT(s, b) .name = #s, .bit = b
317 * A specific tracer, represented by methods that operate on a trace array:
321 /* Your tracer should raise a warning if init fails */
322 int (*init)(struct trace_array *tr);
323 void (*reset)(struct trace_array *tr);
324 void (*start)(struct trace_array *tr);
325 void (*stop)(struct trace_array *tr);
326 void (*open)(struct trace_iterator *iter);
327 void (*pipe_open)(struct trace_iterator *iter);
328 void (*close)(struct trace_iterator *iter);
329 ssize_t (*read)(struct trace_iterator *iter,
330 struct file *filp, char __user *ubuf,
331 size_t cnt, loff_t *ppos);
332 #ifdef CONFIG_FTRACE_STARTUP_TEST
333 int (*selftest)(struct tracer *trace,
334 struct trace_array *tr);
336 void (*print_header)(struct seq_file *m);
337 enum print_line_t (*print_line)(struct trace_iterator *iter);
338 /* If you handled the flag setting, return 0 */
339 int (*set_flag)(u32 old_flags, u32 bit, int set);
342 struct tracer_flags *flags;
346 unsigned char buffer[PAGE_SIZE];
348 unsigned int readpos;
352 * Trace iterator - used by printout routines who present trace
353 * results to users and which routines might sleep, etc:
355 struct trace_iterator {
356 struct trace_array *tr;
357 struct tracer *trace;
359 struct ring_buffer_iter *buffer_iter[NR_CPUS];
361 /* The below is zeroed out in pipe_read */
362 struct trace_seq seq;
363 struct trace_entry *ent;
367 unsigned long iter_flags;
374 int tracing_is_enabled(void);
375 void trace_wake_up(void);
376 void tracing_reset(struct trace_array *tr, int cpu);
377 int tracing_open_generic(struct inode *inode, struct file *filp);
378 struct dentry *tracing_init_dentry(void);
379 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
381 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
382 struct trace_array_cpu *data);
383 void tracing_generic_entry_update(struct trace_entry *entry,
387 void ftrace(struct trace_array *tr,
388 struct trace_array_cpu *data,
390 unsigned long parent_ip,
391 unsigned long flags, int pc);
392 void tracing_sched_switch_trace(struct trace_array *tr,
393 struct trace_array_cpu *data,
394 struct task_struct *prev,
395 struct task_struct *next,
396 unsigned long flags, int pc);
397 void tracing_record_cmdline(struct task_struct *tsk);
399 void tracing_sched_wakeup_trace(struct trace_array *tr,
400 struct trace_array_cpu *data,
401 struct task_struct *wakee,
402 struct task_struct *cur,
403 unsigned long flags, int pc);
404 void trace_special(struct trace_array *tr,
405 struct trace_array_cpu *data,
408 unsigned long arg3, int pc);
409 void trace_function(struct trace_array *tr,
410 struct trace_array_cpu *data,
412 unsigned long parent_ip,
413 unsigned long flags, int pc);
415 void trace_graph_return(struct ftrace_graph_ret *trace);
416 int trace_graph_entry(struct ftrace_graph_ent *trace);
417 void trace_hw_branch(struct trace_array *tr, u64 from, u64 to);
419 void tracing_start_cmdline_record(void);
420 void tracing_stop_cmdline_record(void);
421 void tracing_sched_switch_assign_trace(struct trace_array *tr);
422 void tracing_stop_sched_switch_record(void);
423 void tracing_start_sched_switch_record(void);
424 int register_tracer(struct tracer *type);
425 void unregister_tracer(struct tracer *type);
427 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
429 extern unsigned long tracing_max_latency;
430 extern unsigned long tracing_thresh;
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);
436 extern cycle_t ftrace_now(int cpu);
438 #ifdef CONFIG_FUNCTION_TRACER
439 void tracing_start_function_trace(void);
440 void tracing_stop_function_trace(void);
442 # define tracing_start_function_trace() do { } while (0)
443 # define tracing_stop_function_trace() do { } while (0)
446 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
448 (*tracer_switch_func_t)(void *private,
450 struct task_struct *prev,
451 struct task_struct *next);
453 struct tracer_switch_ops {
454 tracer_switch_func_t func;
456 struct tracer_switch_ops *next;
459 char *trace_find_cmdline(int pid);
460 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
462 #ifdef CONFIG_DYNAMIC_FTRACE
463 extern unsigned long ftrace_update_tot_cnt;
464 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
465 extern int DYN_FTRACE_TEST_NAME(void);
468 #ifdef CONFIG_FTRACE_STARTUP_TEST
469 extern int trace_selftest_startup_function(struct tracer *trace,
470 struct trace_array *tr);
471 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
472 struct trace_array *tr);
473 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
474 struct trace_array *tr);
475 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
476 struct trace_array *tr);
477 extern int trace_selftest_startup_wakeup(struct tracer *trace,
478 struct trace_array *tr);
479 extern int trace_selftest_startup_nop(struct tracer *trace,
480 struct trace_array *tr);
481 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
482 struct trace_array *tr);
483 extern int trace_selftest_startup_sysprof(struct tracer *trace,
484 struct trace_array *tr);
485 extern int trace_selftest_startup_branch(struct tracer *trace,
486 struct trace_array *tr);
487 #endif /* CONFIG_FTRACE_STARTUP_TEST */
489 extern void *head_page(struct trace_array_cpu *data);
490 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
491 extern void trace_seq_print_cont(struct trace_seq *s,
492 struct trace_iterator *iter);
495 seq_print_ip_sym(struct trace_seq *s, unsigned long ip,
496 unsigned long sym_flags);
497 extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
499 extern long ns2usecs(cycle_t nsec);
501 trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
503 extern unsigned long trace_flags;
505 /* Standard output formatting function used for function return traces */
506 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
507 extern enum print_line_t print_graph_function(struct trace_iterator *iter);
509 #ifdef CONFIG_DYNAMIC_FTRACE
510 /* TODO: make this variable */
511 #define FTRACE_GRAPH_MAX_FUNCS 32
512 extern int ftrace_graph_count;
513 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
515 static inline int ftrace_graph_addr(unsigned long addr)
519 if (!ftrace_graph_count || test_tsk_trace_graph(current))
522 for (i = 0; i < ftrace_graph_count; i++) {
523 if (addr == ftrace_graph_funcs[i])
530 static inline int ftrace_trace_addr(unsigned long addr)
534 static inline int ftrace_graph_addr(unsigned long addr)
538 #endif /* CONFIG_DYNAMIC_FTRACE */
540 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
541 static inline enum print_line_t
542 print_graph_function(struct trace_iterator *iter)
544 return TRACE_TYPE_UNHANDLED;
546 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
548 extern struct pid *ftrace_pid_trace;
550 static inline int ftrace_trace_task(struct task_struct *task)
552 if (!ftrace_pid_trace)
555 return test_tsk_trace_trace(task);
559 * trace_iterator_flags is an enumeration that defines bit
560 * positions into trace_flags that controls the output.
562 * NOTE: These bits must match the trace_options array in
565 enum trace_iterator_flags {
566 TRACE_ITER_PRINT_PARENT = 0x01,
567 TRACE_ITER_SYM_OFFSET = 0x02,
568 TRACE_ITER_SYM_ADDR = 0x04,
569 TRACE_ITER_VERBOSE = 0x08,
570 TRACE_ITER_RAW = 0x10,
571 TRACE_ITER_HEX = 0x20,
572 TRACE_ITER_BIN = 0x40,
573 TRACE_ITER_BLOCK = 0x80,
574 TRACE_ITER_STACKTRACE = 0x100,
575 TRACE_ITER_SCHED_TREE = 0x200,
576 TRACE_ITER_PRINTK = 0x400,
577 TRACE_ITER_PREEMPTONLY = 0x800,
578 TRACE_ITER_BRANCH = 0x1000,
579 TRACE_ITER_ANNOTATE = 0x2000,
580 TRACE_ITER_USERSTACKTRACE = 0x4000,
581 TRACE_ITER_SYM_USEROBJ = 0x8000,
582 TRACE_ITER_PRINTK_MSGONLY = 0x10000
586 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
587 * control the output of kernel symbols.
589 #define TRACE_ITER_SYM_MASK \
590 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
592 extern struct tracer nop_trace;
595 * ftrace_preempt_disable - disable preemption scheduler safe
597 * When tracing can happen inside the scheduler, there exists
598 * cases that the tracing might happen before the need_resched
599 * flag is checked. If this happens and the tracer calls
600 * preempt_enable (after a disable), a schedule might take place
601 * causing an infinite recursion.
603 * To prevent this, we read the need_recshed flag before
604 * disabling preemption. When we want to enable preemption we
605 * check the flag, if it is set, then we call preempt_enable_no_resched.
606 * Otherwise, we call preempt_enable.
608 * The rational for doing the above is that if need resched is set
609 * and we have yet to reschedule, we are either in an atomic location
610 * (where we do not need to check for scheduling) or we are inside
611 * the scheduler and do not want to resched.
613 static inline int ftrace_preempt_disable(void)
617 resched = need_resched();
618 preempt_disable_notrace();
624 * ftrace_preempt_enable - enable preemption scheduler safe
625 * @resched: the return value from ftrace_preempt_disable
627 * This is a scheduler safe way to enable preemption and not miss
628 * any preemption checks. The disabled saved the state of preemption.
629 * If resched is set, then we were either inside an atomic or
630 * are inside the scheduler (we would have already scheduled
631 * otherwise). In this case, we do not want to call normal
632 * preempt_enable, but preempt_enable_no_resched instead.
634 static inline void ftrace_preempt_enable(int resched)
637 preempt_enable_no_resched_notrace();
639 preempt_enable_notrace();
642 #ifdef CONFIG_BRANCH_TRACER
643 extern int enable_branch_tracing(struct trace_array *tr);
644 extern void disable_branch_tracing(void);
645 static inline int trace_branch_enable(struct trace_array *tr)
647 if (trace_flags & TRACE_ITER_BRANCH)
648 return enable_branch_tracing(tr);
651 static inline void trace_branch_disable(void)
653 /* due to races, always disable */
654 disable_branch_tracing();
657 static inline int trace_branch_enable(struct trace_array *tr)
661 static inline void trace_branch_disable(void)
664 #endif /* CONFIG_BRANCH_TRACER */
666 #endif /* _LINUX_KERNEL_TRACE_H */