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/tracepoint.h>
11 #include <linux/ftrace.h>
12 #include <trace/boot.h>
13 #include <linux/kmemtrace.h>
14 #include <linux/hw_breakpoint.h>
16 #include <linux/trace_seq.h>
17 #include <linux/ftrace_event.h>
20 __TRACE_FIRST_TYPE = 0,
45 enum kmemtrace_type_id {
46 KMEMTRACE_TYPE_KMALLOC = 0, /* kmalloc() or kfree(). */
47 KMEMTRACE_TYPE_CACHE, /* kmem_cache_*(). */
48 KMEMTRACE_TYPE_PAGES, /* __get_free_pages() and friends. */
51 extern struct tracer boot_tracer;
54 #define __field(type, item) type item;
57 #define __field_struct(type, item) __field(type, item)
60 #define __field_desc(type, container, item)
63 #define __array(type, item, size) type item[size];
66 #define __array_desc(type, container, item, size)
68 #undef __dynamic_array
69 #define __dynamic_array(type, item) type item[];
72 #define F_STRUCT(args...) args
75 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
76 struct struct_name { \
77 struct trace_entry ent; \
82 #define TP_ARGS(args...) args
84 #undef FTRACE_ENTRY_DUP
85 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
87 #include "trace_entries.h"
90 * syscalls are special, and need special handling, this is why
91 * they are not included in trace_entries.h
93 struct syscall_trace_enter {
94 struct trace_entry ent;
99 struct syscall_trace_exit {
100 struct trace_entry ent;
105 struct kprobe_trace_entry_head {
106 struct trace_entry ent;
110 struct kretprobe_trace_entry_head {
111 struct trace_entry ent;
113 unsigned long ret_ip;
117 * trace_flag_type is an enumeration that holds different
118 * states when a trace occurs. These are:
119 * IRQS_OFF - interrupts were disabled
120 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
121 * NEED_RESCHED - reschedule is requested
122 * HARDIRQ - inside an interrupt handler
123 * SOFTIRQ - inside a softirq handler
125 enum trace_flag_type {
126 TRACE_FLAG_IRQS_OFF = 0x01,
127 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
128 TRACE_FLAG_NEED_RESCHED = 0x04,
129 TRACE_FLAG_HARDIRQ = 0x08,
130 TRACE_FLAG_SOFTIRQ = 0x10,
133 #define TRACE_BUF_SIZE 1024
136 * The CPU trace array - it consists of thousands of trace entries
137 * plus some other descriptor data: (for example which task started
140 struct trace_array_cpu {
142 void *buffer_page; /* ring buffer spare */
144 unsigned long saved_latency;
145 unsigned long critical_start;
146 unsigned long critical_end;
147 unsigned long critical_sequence;
149 unsigned long policy;
150 unsigned long rt_priority;
151 unsigned long skipped_entries;
152 cycle_t preempt_timestamp;
155 char comm[TASK_COMM_LEN];
159 * The trace array - an array of per-CPU trace arrays. This is the
160 * highest level data structure that individual tracers deal with.
161 * They have on/off state as well:
164 struct ring_buffer *buffer;
165 unsigned long entries;
168 struct task_struct *waiter;
169 struct trace_array_cpu *data[NR_CPUS];
172 #define FTRACE_CMP_TYPE(var, type) \
173 __builtin_types_compatible_p(typeof(var), type *)
176 #define IF_ASSIGN(var, entry, etype, id) \
177 if (FTRACE_CMP_TYPE(var, etype)) { \
178 var = (typeof(var))(entry); \
179 WARN_ON(id && (entry)->type != id); \
183 /* Will cause compile errors if type is not found. */
184 extern void __ftrace_bad_type(void);
187 * The trace_assign_type is a verifier that the entry type is
188 * the same as the type being assigned. To add new types simply
189 * add a line with the following format:
191 * IF_ASSIGN(var, ent, type, id);
193 * Where "type" is the trace type that includes the trace_entry
194 * as the "ent" item. And "id" is the trace identifier that is
195 * used in the trace_type enum.
197 * If the type can have more than one id, then use zero.
199 #define trace_assign_type(var, ent) \
201 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
202 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
203 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
204 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
205 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
206 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
207 IF_ASSIGN(var, ent, struct special_entry, 0); \
208 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
210 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
212 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
213 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
214 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
215 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
217 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
219 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
221 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
223 IF_ASSIGN(var, ent, struct ksym_trace_entry, TRACE_KSYM);\
224 __ftrace_bad_type(); \
228 * An option specific to a tracer. This is a boolean value.
229 * The bit is the bit index that sets its value on the
230 * flags value in struct tracer_flags.
233 const char *name; /* Will appear on the trace_options file */
234 u32 bit; /* Mask assigned in val field in tracer_flags */
238 * The set of specific options for a tracer. Your tracer
239 * have to set the initial value of the flags val.
241 struct tracer_flags {
243 struct tracer_opt *opts;
246 /* Makes more easy to define a tracer opt */
247 #define TRACER_OPT(s, b) .name = #s, .bit = b
251 * struct tracer - a specific tracer and its callbacks to interact with debugfs
252 * @name: the name chosen to select it on the available_tracers file
253 * @init: called when one switches to this tracer (echo name > current_tracer)
254 * @reset: called when one switches to another tracer
255 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
256 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
257 * @open: called when the trace file is opened
258 * @pipe_open: called when the trace_pipe file is opened
259 * @wait_pipe: override how the user waits for traces on trace_pipe
260 * @close: called when the trace file is released
261 * @pipe_close: called when the trace_pipe file is released
262 * @read: override the default read callback on trace_pipe
263 * @splice_read: override the default splice_read callback on trace_pipe
264 * @selftest: selftest to run on boot (see trace_selftest.c)
265 * @print_headers: override the first lines that describe your columns
266 * @print_line: callback that prints a trace
267 * @set_flag: signals one of your private flags changed (trace_options file)
268 * @flags: your private flags
272 int (*init)(struct trace_array *tr);
273 void (*reset)(struct trace_array *tr);
274 void (*start)(struct trace_array *tr);
275 void (*stop)(struct trace_array *tr);
276 void (*open)(struct trace_iterator *iter);
277 void (*pipe_open)(struct trace_iterator *iter);
278 void (*wait_pipe)(struct trace_iterator *iter);
279 void (*close)(struct trace_iterator *iter);
280 void (*pipe_close)(struct trace_iterator *iter);
281 ssize_t (*read)(struct trace_iterator *iter,
282 struct file *filp, char __user *ubuf,
283 size_t cnt, loff_t *ppos);
284 ssize_t (*splice_read)(struct trace_iterator *iter,
287 struct pipe_inode_info *pipe,
290 #ifdef CONFIG_FTRACE_STARTUP_TEST
291 int (*selftest)(struct tracer *trace,
292 struct trace_array *tr);
294 void (*print_header)(struct seq_file *m);
295 enum print_line_t (*print_line)(struct trace_iterator *iter);
296 /* If you handled the flag setting, return 0 */
297 int (*set_flag)(u32 old_flags, u32 bit, int set);
300 struct tracer_flags *flags;
304 #define TRACE_PIPE_ALL_CPU -1
306 int tracer_init(struct tracer *t, struct trace_array *tr);
307 int tracing_is_enabled(void);
308 void trace_wake_up(void);
309 void tracing_reset(struct trace_array *tr, int cpu);
310 void tracing_reset_online_cpus(struct trace_array *tr);
311 void tracing_reset_current(int cpu);
312 void tracing_reset_current_online_cpus(void);
313 int tracing_open_generic(struct inode *inode, struct file *filp);
314 struct dentry *trace_create_file(const char *name,
316 struct dentry *parent,
318 const struct file_operations *fops);
320 struct dentry *tracing_init_dentry(void);
321 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
323 struct ring_buffer_event;
325 struct ring_buffer_event *
326 trace_buffer_lock_reserve(struct ring_buffer *buffer,
331 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
332 struct ring_buffer_event *event,
333 unsigned long flags, int pc);
335 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
336 struct trace_array_cpu *data);
338 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
339 int *ent_cpu, u64 *ent_ts);
341 void default_wait_pipe(struct trace_iterator *iter);
342 void poll_wait_pipe(struct trace_iterator *iter);
344 void ftrace(struct trace_array *tr,
345 struct trace_array_cpu *data,
347 unsigned long parent_ip,
348 unsigned long flags, int pc);
349 void tracing_sched_switch_trace(struct trace_array *tr,
350 struct task_struct *prev,
351 struct task_struct *next,
352 unsigned long flags, int pc);
354 void tracing_sched_wakeup_trace(struct trace_array *tr,
355 struct task_struct *wakee,
356 struct task_struct *cur,
357 unsigned long flags, int pc);
358 void trace_special(struct trace_array *tr,
359 struct trace_array_cpu *data,
362 unsigned long arg3, int pc);
363 void trace_function(struct trace_array *tr,
365 unsigned long parent_ip,
366 unsigned long flags, int pc);
368 void trace_graph_return(struct ftrace_graph_ret *trace);
369 int trace_graph_entry(struct ftrace_graph_ent *trace);
370 void set_graph_array(struct trace_array *tr);
372 void tracing_start_cmdline_record(void);
373 void tracing_stop_cmdline_record(void);
374 void tracing_sched_switch_assign_trace(struct trace_array *tr);
375 void tracing_stop_sched_switch_record(void);
376 void tracing_start_sched_switch_record(void);
377 int register_tracer(struct tracer *type);
378 void unregister_tracer(struct tracer *type);
379 int is_tracing_stopped(void);
381 extern int process_new_ksym_entry(char *ksymname, int op, unsigned long addr);
383 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
385 extern unsigned long tracing_thresh;
387 #ifdef CONFIG_TRACER_MAX_TRACE
388 extern unsigned long tracing_max_latency;
390 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
391 void update_max_tr_single(struct trace_array *tr,
392 struct task_struct *tsk, int cpu);
393 #endif /* CONFIG_TRACER_MAX_TRACE */
395 #ifdef CONFIG_STACKTRACE
396 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
399 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
402 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
405 static inline void ftrace_trace_stack(struct trace_array *tr,
406 unsigned long flags, int skip, int pc)
410 static inline void ftrace_trace_userstack(struct trace_array *tr,
411 unsigned long flags, int pc)
415 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
419 #endif /* CONFIG_STACKTRACE */
421 extern cycle_t ftrace_now(int cpu);
423 extern void trace_find_cmdline(int pid, char comm[]);
425 #ifdef CONFIG_DYNAMIC_FTRACE
426 extern unsigned long ftrace_update_tot_cnt;
427 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
428 extern int DYN_FTRACE_TEST_NAME(void);
431 extern int ring_buffer_expanded;
432 extern bool tracing_selftest_disabled;
433 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
435 #ifdef CONFIG_FTRACE_STARTUP_TEST
436 extern int trace_selftest_startup_function(struct tracer *trace,
437 struct trace_array *tr);
438 extern int trace_selftest_startup_function_graph(struct tracer *trace,
439 struct trace_array *tr);
440 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
441 struct trace_array *tr);
442 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
443 struct trace_array *tr);
444 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
445 struct trace_array *tr);
446 extern int trace_selftest_startup_wakeup(struct tracer *trace,
447 struct trace_array *tr);
448 extern int trace_selftest_startup_nop(struct tracer *trace,
449 struct trace_array *tr);
450 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
451 struct trace_array *tr);
452 extern int trace_selftest_startup_sysprof(struct tracer *trace,
453 struct trace_array *tr);
454 extern int trace_selftest_startup_branch(struct tracer *trace,
455 struct trace_array *tr);
456 extern int trace_selftest_startup_ksym(struct tracer *trace,
457 struct trace_array *tr);
458 #endif /* CONFIG_FTRACE_STARTUP_TEST */
460 extern void *head_page(struct trace_array_cpu *data);
461 extern unsigned long long ns2usecs(cycle_t nsec);
463 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
465 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
467 trace_array_vprintk(struct trace_array *tr,
468 unsigned long ip, const char *fmt, va_list args);
469 int trace_array_printk(struct trace_array *tr,
470 unsigned long ip, const char *fmt, ...);
472 extern unsigned long trace_flags;
474 extern int trace_clock_id;
476 /* Standard output formatting function used for function return traces */
477 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
478 extern enum print_line_t print_graph_function(struct trace_iterator *iter);
479 extern enum print_line_t
480 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
482 #ifdef CONFIG_DYNAMIC_FTRACE
483 /* TODO: make this variable */
484 #define FTRACE_GRAPH_MAX_FUNCS 32
485 extern int ftrace_graph_filter_enabled;
486 extern int ftrace_graph_count;
487 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
489 static inline int ftrace_graph_addr(unsigned long addr)
493 if (!ftrace_graph_filter_enabled)
496 for (i = 0; i < ftrace_graph_count; i++) {
497 if (addr == ftrace_graph_funcs[i])
504 static inline int ftrace_graph_addr(unsigned long addr)
508 #endif /* CONFIG_DYNAMIC_FTRACE */
509 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
510 static inline enum print_line_t
511 print_graph_function(struct trace_iterator *iter)
513 return TRACE_TYPE_UNHANDLED;
515 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
517 extern struct list_head ftrace_pids;
519 #ifdef CONFIG_FUNCTION_TRACER
520 static inline int ftrace_trace_task(struct task_struct *task)
522 if (list_empty(&ftrace_pids))
525 return test_tsk_trace_trace(task);
528 static inline int ftrace_trace_task(struct task_struct *task)
535 * struct trace_parser - servers for reading the user input separated by spaces
536 * @cont: set if the input is not complete - no final space char was found
537 * @buffer: holds the parsed user input
538 * @idx: user input length
541 struct trace_parser {
548 static inline bool trace_parser_loaded(struct trace_parser *parser)
550 return (parser->idx != 0);
553 static inline bool trace_parser_cont(struct trace_parser *parser)
558 static inline void trace_parser_clear(struct trace_parser *parser)
560 parser->cont = false;
564 extern int trace_parser_get_init(struct trace_parser *parser, int size);
565 extern void trace_parser_put(struct trace_parser *parser);
566 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
567 size_t cnt, loff_t *ppos);
570 * trace_iterator_flags is an enumeration that defines bit
571 * positions into trace_flags that controls the output.
573 * NOTE: These bits must match the trace_options array in
576 enum trace_iterator_flags {
577 TRACE_ITER_PRINT_PARENT = 0x01,
578 TRACE_ITER_SYM_OFFSET = 0x02,
579 TRACE_ITER_SYM_ADDR = 0x04,
580 TRACE_ITER_VERBOSE = 0x08,
581 TRACE_ITER_RAW = 0x10,
582 TRACE_ITER_HEX = 0x20,
583 TRACE_ITER_BIN = 0x40,
584 TRACE_ITER_BLOCK = 0x80,
585 TRACE_ITER_STACKTRACE = 0x100,
586 TRACE_ITER_PRINTK = 0x200,
587 TRACE_ITER_PREEMPTONLY = 0x400,
588 TRACE_ITER_BRANCH = 0x800,
589 TRACE_ITER_ANNOTATE = 0x1000,
590 TRACE_ITER_USERSTACKTRACE = 0x2000,
591 TRACE_ITER_SYM_USEROBJ = 0x4000,
592 TRACE_ITER_PRINTK_MSGONLY = 0x8000,
593 TRACE_ITER_CONTEXT_INFO = 0x10000, /* Print pid/cpu/time */
594 TRACE_ITER_LATENCY_FMT = 0x20000,
595 TRACE_ITER_SLEEP_TIME = 0x40000,
596 TRACE_ITER_GRAPH_TIME = 0x80000,
600 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
601 * control the output of kernel symbols.
603 #define TRACE_ITER_SYM_MASK \
604 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
606 extern struct tracer nop_trace;
609 * ftrace_preempt_disable - disable preemption scheduler safe
611 * When tracing can happen inside the scheduler, there exists
612 * cases that the tracing might happen before the need_resched
613 * flag is checked. If this happens and the tracer calls
614 * preempt_enable (after a disable), a schedule might take place
615 * causing an infinite recursion.
617 * To prevent this, we read the need_resched flag before
618 * disabling preemption. When we want to enable preemption we
619 * check the flag, if it is set, then we call preempt_enable_no_resched.
620 * Otherwise, we call preempt_enable.
622 * The rational for doing the above is that if need_resched is set
623 * and we have yet to reschedule, we are either in an atomic location
624 * (where we do not need to check for scheduling) or we are inside
625 * the scheduler and do not want to resched.
627 static inline int ftrace_preempt_disable(void)
631 resched = need_resched();
632 preempt_disable_notrace();
638 * ftrace_preempt_enable - enable preemption scheduler safe
639 * @resched: the return value from ftrace_preempt_disable
641 * This is a scheduler safe way to enable preemption and not miss
642 * any preemption checks. The disabled saved the state of preemption.
643 * If resched is set, then we are either inside an atomic or
644 * are inside the scheduler (we would have already scheduled
645 * otherwise). In this case, we do not want to call normal
646 * preempt_enable, but preempt_enable_no_resched instead.
648 static inline void ftrace_preempt_enable(int resched)
651 preempt_enable_no_resched_notrace();
653 preempt_enable_notrace();
656 #ifdef CONFIG_BRANCH_TRACER
657 extern int enable_branch_tracing(struct trace_array *tr);
658 extern void disable_branch_tracing(void);
659 static inline int trace_branch_enable(struct trace_array *tr)
661 if (trace_flags & TRACE_ITER_BRANCH)
662 return enable_branch_tracing(tr);
665 static inline void trace_branch_disable(void)
667 /* due to races, always disable */
668 disable_branch_tracing();
671 static inline int trace_branch_enable(struct trace_array *tr)
675 static inline void trace_branch_disable(void)
678 #endif /* CONFIG_BRANCH_TRACER */
680 /* set ring buffers to default size if not already done so */
681 int tracing_update_buffers(void);
683 /* trace event type bit fields, not numeric */
685 TRACE_EVENT_TYPE_PRINTF = 1,
686 TRACE_EVENT_TYPE_RAW = 2,
689 struct ftrace_event_field {
690 struct list_head link;
699 struct event_filter {
701 struct filter_pred **preds;
705 struct event_subsystem {
706 struct list_head list;
708 struct dentry *entry;
709 struct event_filter *filter;
716 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
719 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
729 char pattern[MAX_FILTER_STR_VAL];
732 regex_match_func match;
746 extern enum regex_type
747 filter_parse_regex(char *buff, int len, char **search, int *not);
748 extern void print_event_filter(struct ftrace_event_call *call,
749 struct trace_seq *s);
750 extern int apply_event_filter(struct ftrace_event_call *call,
751 char *filter_string);
752 extern int apply_subsystem_event_filter(struct event_subsystem *system,
753 char *filter_string);
754 extern void print_subsystem_event_filter(struct event_subsystem *system,
755 struct trace_seq *s);
756 extern int filter_assign_type(const char *type);
759 filter_check_discard(struct ftrace_event_call *call, void *rec,
760 struct ring_buffer *buffer,
761 struct ring_buffer_event *event)
763 if (unlikely(call->filter_active) &&
764 !filter_match_preds(call->filter, rec)) {
765 ring_buffer_discard_commit(buffer, event);
772 extern struct mutex event_mutex;
773 extern struct list_head ftrace_events;
775 extern const char *__start___trace_bprintk_fmt[];
776 extern const char *__stop___trace_bprintk_fmt[];
779 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
780 extern struct ftrace_event_call \
781 __attribute__((__aligned__(4))) event_##call;
782 #undef FTRACE_ENTRY_DUP
783 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
784 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
785 #include "trace_entries.h"
787 #endif /* _LINUX_KERNEL_TRACE_H */