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 <linux/kmemtrace.h>
13 #include <trace/power.h>
15 #include <linux/trace_seq.h>
16 #include <linux/ftrace_event.h>
19 __TRACE_FIRST_TYPE = 0,
46 * Function trace entry - function address and parent function addres:
49 struct trace_entry ent;
51 unsigned long parent_ip;
54 /* Function call entry */
55 struct ftrace_graph_ent_entry {
56 struct trace_entry ent;
57 struct ftrace_graph_ent graph_ent;
60 /* Function return entry */
61 struct ftrace_graph_ret_entry {
62 struct trace_entry ent;
63 struct ftrace_graph_ret ret;
65 extern struct tracer boot_tracer;
68 * Context switch trace entry - which task (and prio) we switched from/to:
70 struct ctx_switch_entry {
71 struct trace_entry ent;
72 unsigned int prev_pid;
73 unsigned char prev_prio;
74 unsigned char prev_state;
75 unsigned int next_pid;
76 unsigned char next_prio;
77 unsigned char next_state;
78 unsigned int next_cpu;
82 * Special (free-form) trace entry:
84 struct special_entry {
85 struct trace_entry ent;
95 #define FTRACE_STACK_ENTRIES 8
98 struct trace_entry ent;
99 unsigned long caller[FTRACE_STACK_ENTRIES];
102 struct userstack_entry {
103 struct trace_entry ent;
104 unsigned long caller[FTRACE_STACK_ENTRIES];
108 * trace_printk entry:
110 struct bprint_entry {
111 struct trace_entry ent;
118 struct trace_entry ent;
123 struct trace_mmiotrace_rw {
124 struct trace_entry ent;
125 struct mmiotrace_rw rw;
128 struct trace_mmiotrace_map {
129 struct trace_entry ent;
130 struct mmiotrace_map map;
133 struct trace_boot_call {
134 struct trace_entry ent;
135 struct boot_trace_call boot_call;
138 struct trace_boot_ret {
139 struct trace_entry ent;
140 struct boot_trace_ret boot_ret;
143 #define TRACE_FUNC_SIZE 30
144 #define TRACE_FILE_SIZE 20
145 struct trace_branch {
146 struct trace_entry ent;
148 char func[TRACE_FUNC_SIZE+1];
149 char file[TRACE_FILE_SIZE+1];
153 struct hw_branch_entry {
154 struct trace_entry ent;
160 struct trace_entry ent;
161 struct power_trace state_data;
164 enum kmemtrace_type_id {
165 KMEMTRACE_TYPE_KMALLOC = 0, /* kmalloc() or kfree(). */
166 KMEMTRACE_TYPE_CACHE, /* kmem_cache_*(). */
167 KMEMTRACE_TYPE_PAGES, /* __get_free_pages() and friends. */
170 struct kmemtrace_alloc_entry {
171 struct trace_entry ent;
172 enum kmemtrace_type_id type_id;
173 unsigned long call_site;
181 struct kmemtrace_free_entry {
182 struct trace_entry ent;
183 enum kmemtrace_type_id type_id;
184 unsigned long call_site;
188 struct syscall_trace_enter {
189 struct trace_entry ent;
191 unsigned long args[];
194 struct syscall_trace_exit {
195 struct trace_entry ent;
202 * trace_flag_type is an enumeration that holds different
203 * states when a trace occurs. These are:
204 * IRQS_OFF - interrupts were disabled
205 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
206 * NEED_RESCHED - reschedule is requested
207 * HARDIRQ - inside an interrupt handler
208 * SOFTIRQ - inside a softirq handler
210 enum trace_flag_type {
211 TRACE_FLAG_IRQS_OFF = 0x01,
212 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
213 TRACE_FLAG_NEED_RESCHED = 0x04,
214 TRACE_FLAG_HARDIRQ = 0x08,
215 TRACE_FLAG_SOFTIRQ = 0x10,
218 #define TRACE_BUF_SIZE 1024
221 * The CPU trace array - it consists of thousands of trace entries
222 * plus some other descriptor data: (for example which task started
225 struct trace_array_cpu {
227 void *buffer_page; /* ring buffer spare */
229 unsigned long saved_latency;
230 unsigned long critical_start;
231 unsigned long critical_end;
232 unsigned long critical_sequence;
234 unsigned long policy;
235 unsigned long rt_priority;
236 unsigned long skipped_entries;
237 cycle_t preempt_timestamp;
240 char comm[TASK_COMM_LEN];
244 * The trace array - an array of per-CPU trace arrays. This is the
245 * highest level data structure that individual tracers deal with.
246 * They have on/off state as well:
249 struct ring_buffer *buffer;
250 unsigned long entries;
253 struct task_struct *waiter;
254 struct trace_array_cpu *data[NR_CPUS];
257 #define FTRACE_CMP_TYPE(var, type) \
258 __builtin_types_compatible_p(typeof(var), type *)
261 #define IF_ASSIGN(var, entry, etype, id) \
262 if (FTRACE_CMP_TYPE(var, etype)) { \
263 var = (typeof(var))(entry); \
264 WARN_ON(id && (entry)->type != id); \
268 /* Will cause compile errors if type is not found. */
269 extern void __ftrace_bad_type(void);
272 * The trace_assign_type is a verifier that the entry type is
273 * the same as the type being assigned. To add new types simply
274 * add a line with the following format:
276 * IF_ASSIGN(var, ent, type, id);
278 * Where "type" is the trace type that includes the trace_entry
279 * as the "ent" item. And "id" is the trace identifier that is
280 * used in the trace_type enum.
282 * If the type can have more than one id, then use zero.
284 #define trace_assign_type(var, ent) \
286 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
287 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
288 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
289 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
290 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
291 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
292 IF_ASSIGN(var, ent, struct special_entry, 0); \
293 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
295 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
297 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
298 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
299 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
300 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
302 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
304 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
305 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
306 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
308 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
310 __ftrace_bad_type(); \
314 * An option specific to a tracer. This is a boolean value.
315 * The bit is the bit index that sets its value on the
316 * flags value in struct tracer_flags.
319 const char *name; /* Will appear on the trace_options file */
320 u32 bit; /* Mask assigned in val field in tracer_flags */
324 * The set of specific options for a tracer. Your tracer
325 * have to set the initial value of the flags val.
327 struct tracer_flags {
329 struct tracer_opt *opts;
332 /* Makes more easy to define a tracer opt */
333 #define TRACER_OPT(s, b) .name = #s, .bit = b
337 * struct tracer - a specific tracer and its callbacks to interact with debugfs
338 * @name: the name chosen to select it on the available_tracers file
339 * @init: called when one switches to this tracer (echo name > current_tracer)
340 * @reset: called when one switches to another tracer
341 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
342 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
343 * @open: called when the trace file is opened
344 * @pipe_open: called when the trace_pipe file is opened
345 * @wait_pipe: override how the user waits for traces on trace_pipe
346 * @close: called when the trace file is released
347 * @read: override the default read callback on trace_pipe
348 * @splice_read: override the default splice_read callback on trace_pipe
349 * @selftest: selftest to run on boot (see trace_selftest.c)
350 * @print_headers: override the first lines that describe your columns
351 * @print_line: callback that prints a trace
352 * @set_flag: signals one of your private flags changed (trace_options file)
353 * @flags: your private flags
357 int (*init)(struct trace_array *tr);
358 void (*reset)(struct trace_array *tr);
359 void (*start)(struct trace_array *tr);
360 void (*stop)(struct trace_array *tr);
361 void (*open)(struct trace_iterator *iter);
362 void (*pipe_open)(struct trace_iterator *iter);
363 void (*wait_pipe)(struct trace_iterator *iter);
364 void (*close)(struct trace_iterator *iter);
365 ssize_t (*read)(struct trace_iterator *iter,
366 struct file *filp, char __user *ubuf,
367 size_t cnt, loff_t *ppos);
368 ssize_t (*splice_read)(struct trace_iterator *iter,
371 struct pipe_inode_info *pipe,
374 #ifdef CONFIG_FTRACE_STARTUP_TEST
375 int (*selftest)(struct tracer *trace,
376 struct trace_array *tr);
378 void (*print_header)(struct seq_file *m);
379 enum print_line_t (*print_line)(struct trace_iterator *iter);
380 /* If you handled the flag setting, return 0 */
381 int (*set_flag)(u32 old_flags, u32 bit, int set);
384 struct tracer_flags *flags;
388 #define TRACE_PIPE_ALL_CPU -1
390 int tracer_init(struct tracer *t, struct trace_array *tr);
391 int tracing_is_enabled(void);
392 void trace_wake_up(void);
393 void tracing_reset(struct trace_array *tr, int cpu);
394 void tracing_reset_online_cpus(struct trace_array *tr);
395 void tracing_reset_current(int cpu);
396 void tracing_reset_current_online_cpus(void);
397 int tracing_open_generic(struct inode *inode, struct file *filp);
398 struct dentry *trace_create_file(const char *name,
400 struct dentry *parent,
402 const struct file_operations *fops);
404 struct dentry *tracing_init_dentry(void);
405 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
407 struct ring_buffer_event;
409 struct ring_buffer_event *
410 trace_buffer_lock_reserve(struct ring_buffer *buffer,
415 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
416 struct ring_buffer_event *event,
417 unsigned long flags, int pc);
419 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
420 struct trace_array_cpu *data);
422 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
423 int *ent_cpu, u64 *ent_ts);
425 void default_wait_pipe(struct trace_iterator *iter);
426 void poll_wait_pipe(struct trace_iterator *iter);
428 void ftrace(struct trace_array *tr,
429 struct trace_array_cpu *data,
431 unsigned long parent_ip,
432 unsigned long flags, int pc);
433 void tracing_sched_switch_trace(struct trace_array *tr,
434 struct task_struct *prev,
435 struct task_struct *next,
436 unsigned long flags, int pc);
438 void tracing_sched_wakeup_trace(struct trace_array *tr,
439 struct task_struct *wakee,
440 struct task_struct *cur,
441 unsigned long flags, int pc);
442 void trace_special(struct trace_array *tr,
443 struct trace_array_cpu *data,
446 unsigned long arg3, int pc);
447 void trace_function(struct trace_array *tr,
449 unsigned long parent_ip,
450 unsigned long flags, int pc);
452 void trace_graph_return(struct ftrace_graph_ret *trace);
453 int trace_graph_entry(struct ftrace_graph_ent *trace);
454 void set_graph_array(struct trace_array *tr);
456 void tracing_start_cmdline_record(void);
457 void tracing_stop_cmdline_record(void);
458 void tracing_sched_switch_assign_trace(struct trace_array *tr);
459 void tracing_stop_sched_switch_record(void);
460 void tracing_start_sched_switch_record(void);
461 int register_tracer(struct tracer *type);
462 void unregister_tracer(struct tracer *type);
464 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
466 #ifdef CONFIG_TRACER_MAX_TRACE
467 extern unsigned long tracing_max_latency;
468 extern unsigned long tracing_thresh;
470 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
471 void update_max_tr_single(struct trace_array *tr,
472 struct task_struct *tsk, int cpu);
473 #endif /* CONFIG_TRACER_MAX_TRACE */
475 #ifdef CONFIG_STACKTRACE
476 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
479 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
482 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
485 static inline void ftrace_trace_stack(struct trace_array *tr,
486 unsigned long flags, int skip, int pc)
490 static inline void ftrace_trace_userstack(struct trace_array *tr,
491 unsigned long flags, int pc)
495 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
499 #endif /* CONFIG_STACKTRACE */
501 extern cycle_t ftrace_now(int cpu);
503 extern void trace_find_cmdline(int pid, char comm[]);
505 #ifdef CONFIG_DYNAMIC_FTRACE
506 extern unsigned long ftrace_update_tot_cnt;
507 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
508 extern int DYN_FTRACE_TEST_NAME(void);
511 extern int ring_buffer_expanded;
512 extern bool tracing_selftest_disabled;
513 DECLARE_PER_CPU(local_t, ftrace_cpu_disabled);
515 #ifdef CONFIG_FTRACE_STARTUP_TEST
516 extern int trace_selftest_startup_function(struct tracer *trace,
517 struct trace_array *tr);
518 extern int trace_selftest_startup_function_graph(struct tracer *trace,
519 struct trace_array *tr);
520 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
521 struct trace_array *tr);
522 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
523 struct trace_array *tr);
524 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
525 struct trace_array *tr);
526 extern int trace_selftest_startup_wakeup(struct tracer *trace,
527 struct trace_array *tr);
528 extern int trace_selftest_startup_nop(struct tracer *trace,
529 struct trace_array *tr);
530 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
531 struct trace_array *tr);
532 extern int trace_selftest_startup_sysprof(struct tracer *trace,
533 struct trace_array *tr);
534 extern int trace_selftest_startup_branch(struct tracer *trace,
535 struct trace_array *tr);
536 extern int trace_selftest_startup_hw_branches(struct tracer *trace,
537 struct trace_array *tr);
538 #endif /* CONFIG_FTRACE_STARTUP_TEST */
540 extern void *head_page(struct trace_array_cpu *data);
541 extern unsigned long long ns2usecs(cycle_t nsec);
543 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
545 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
547 trace_array_vprintk(struct trace_array *tr,
548 unsigned long ip, const char *fmt, va_list args);
549 int trace_array_printk(struct trace_array *tr,
550 unsigned long ip, const char *fmt, ...);
552 extern unsigned long trace_flags;
554 extern int trace_clock_id;
556 /* Standard output formatting function used for function return traces */
557 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
558 extern enum print_line_t print_graph_function(struct trace_iterator *iter);
559 extern enum print_line_t
560 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
562 #ifdef CONFIG_DYNAMIC_FTRACE
563 /* TODO: make this variable */
564 #define FTRACE_GRAPH_MAX_FUNCS 32
565 extern int ftrace_graph_count;
566 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
568 static inline int ftrace_graph_addr(unsigned long addr)
572 if (!ftrace_graph_count || test_tsk_trace_graph(current))
575 for (i = 0; i < ftrace_graph_count; i++) {
576 if (addr == ftrace_graph_funcs[i])
583 static inline int ftrace_trace_addr(unsigned long addr)
587 static inline int ftrace_graph_addr(unsigned long addr)
591 #endif /* CONFIG_DYNAMIC_FTRACE */
592 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
593 static inline enum print_line_t
594 print_graph_function(struct trace_iterator *iter)
596 return TRACE_TYPE_UNHANDLED;
598 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
600 extern struct pid *ftrace_pid_trace;
602 #ifdef CONFIG_FUNCTION_TRACER
603 static inline int ftrace_trace_task(struct task_struct *task)
605 if (!ftrace_pid_trace)
608 return test_tsk_trace_trace(task);
611 static inline int ftrace_trace_task(struct task_struct *task)
618 * trace_iterator_flags is an enumeration that defines bit
619 * positions into trace_flags that controls the output.
621 * NOTE: These bits must match the trace_options array in
624 enum trace_iterator_flags {
625 TRACE_ITER_PRINT_PARENT = 0x01,
626 TRACE_ITER_SYM_OFFSET = 0x02,
627 TRACE_ITER_SYM_ADDR = 0x04,
628 TRACE_ITER_VERBOSE = 0x08,
629 TRACE_ITER_RAW = 0x10,
630 TRACE_ITER_HEX = 0x20,
631 TRACE_ITER_BIN = 0x40,
632 TRACE_ITER_BLOCK = 0x80,
633 TRACE_ITER_STACKTRACE = 0x100,
634 TRACE_ITER_SCHED_TREE = 0x200,
635 TRACE_ITER_PRINTK = 0x400,
636 TRACE_ITER_PREEMPTONLY = 0x800,
637 TRACE_ITER_BRANCH = 0x1000,
638 TRACE_ITER_ANNOTATE = 0x2000,
639 TRACE_ITER_USERSTACKTRACE = 0x4000,
640 TRACE_ITER_SYM_USEROBJ = 0x8000,
641 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
642 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
643 TRACE_ITER_LATENCY_FMT = 0x40000,
644 TRACE_ITER_SLEEP_TIME = 0x80000,
645 TRACE_ITER_GRAPH_TIME = 0x100000,
649 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
650 * control the output of kernel symbols.
652 #define TRACE_ITER_SYM_MASK \
653 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
655 extern struct tracer nop_trace;
658 * ftrace_preempt_disable - disable preemption scheduler safe
660 * When tracing can happen inside the scheduler, there exists
661 * cases that the tracing might happen before the need_resched
662 * flag is checked. If this happens and the tracer calls
663 * preempt_enable (after a disable), a schedule might take place
664 * causing an infinite recursion.
666 * To prevent this, we read the need_resched flag before
667 * disabling preemption. When we want to enable preemption we
668 * check the flag, if it is set, then we call preempt_enable_no_resched.
669 * Otherwise, we call preempt_enable.
671 * The rational for doing the above is that if need_resched is set
672 * and we have yet to reschedule, we are either in an atomic location
673 * (where we do not need to check for scheduling) or we are inside
674 * the scheduler and do not want to resched.
676 static inline int ftrace_preempt_disable(void)
680 resched = need_resched();
681 preempt_disable_notrace();
687 * ftrace_preempt_enable - enable preemption scheduler safe
688 * @resched: the return value from ftrace_preempt_disable
690 * This is a scheduler safe way to enable preemption and not miss
691 * any preemption checks. The disabled saved the state of preemption.
692 * If resched is set, then we are either inside an atomic or
693 * are inside the scheduler (we would have already scheduled
694 * otherwise). In this case, we do not want to call normal
695 * preempt_enable, but preempt_enable_no_resched instead.
697 static inline void ftrace_preempt_enable(int resched)
700 preempt_enable_no_resched_notrace();
702 preempt_enable_notrace();
705 #ifdef CONFIG_BRANCH_TRACER
706 extern int enable_branch_tracing(struct trace_array *tr);
707 extern void disable_branch_tracing(void);
708 static inline int trace_branch_enable(struct trace_array *tr)
710 if (trace_flags & TRACE_ITER_BRANCH)
711 return enable_branch_tracing(tr);
714 static inline void trace_branch_disable(void)
716 /* due to races, always disable */
717 disable_branch_tracing();
720 static inline int trace_branch_enable(struct trace_array *tr)
724 static inline void trace_branch_disable(void)
727 #endif /* CONFIG_BRANCH_TRACER */
729 /* set ring buffers to default size if not already done so */
730 int tracing_update_buffers(void);
732 /* trace event type bit fields, not numeric */
734 TRACE_EVENT_TYPE_PRINTF = 1,
735 TRACE_EVENT_TYPE_RAW = 2,
738 struct ftrace_event_field {
739 struct list_head link;
748 struct event_filter {
750 struct filter_pred **preds;
755 struct event_subsystem {
756 struct list_head list;
758 struct dentry *entry;
759 struct event_filter *filter;
765 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
771 char str_val[MAX_FILTER_STR_VAL];
780 extern void print_event_filter(struct ftrace_event_call *call,
781 struct trace_seq *s);
782 extern int apply_event_filter(struct ftrace_event_call *call,
783 char *filter_string);
784 extern int apply_subsystem_event_filter(struct event_subsystem *system,
785 char *filter_string);
786 extern void print_subsystem_event_filter(struct event_subsystem *system,
787 struct trace_seq *s);
788 extern int filter_assign_type(const char *type);
791 filter_check_discard(struct ftrace_event_call *call, void *rec,
792 struct ring_buffer *buffer,
793 struct ring_buffer_event *event)
795 if (unlikely(call->filter_active) && !filter_match_preds(call, rec)) {
796 ring_buffer_discard_commit(buffer, event);
803 extern struct mutex event_mutex;
804 extern struct list_head ftrace_events;
806 extern const char *__start___trace_bprintk_fmt[];
807 extern const char *__stop___trace_bprintk_fmt[];
809 #undef TRACE_EVENT_FORMAT
810 #define TRACE_EVENT_FORMAT(call, proto, args, fmt, tstruct, tpfmt) \
811 extern struct ftrace_event_call event_##call;
812 #undef TRACE_EVENT_FORMAT_NOFILTER
813 #define TRACE_EVENT_FORMAT_NOFILTER(call, proto, args, fmt, tstruct, tpfmt)
814 #include "trace_event_types.h"
816 #endif /* _LINUX_KERNEL_TRACE_H */