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 {
106 struct trace_entry ent;
109 unsigned long args[];
112 #define SIZEOF_KPROBE_TRACE_ENTRY(n) \
113 (offsetof(struct kprobe_trace_entry, args) + \
114 (sizeof(unsigned long) * (n)))
116 struct kretprobe_trace_entry {
117 struct trace_entry ent;
119 unsigned long ret_ip;
121 unsigned long args[];
124 #define SIZEOF_KRETPROBE_TRACE_ENTRY(n) \
125 (offsetof(struct kretprobe_trace_entry, args) + \
126 (sizeof(unsigned long) * (n)))
129 * trace_flag_type is an enumeration that holds different
130 * states when a trace occurs. These are:
131 * IRQS_OFF - interrupts were disabled
132 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
133 * NEED_RESCHED - reschedule is requested
134 * HARDIRQ - inside an interrupt handler
135 * SOFTIRQ - inside a softirq handler
137 enum trace_flag_type {
138 TRACE_FLAG_IRQS_OFF = 0x01,
139 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
140 TRACE_FLAG_NEED_RESCHED = 0x04,
141 TRACE_FLAG_HARDIRQ = 0x08,
142 TRACE_FLAG_SOFTIRQ = 0x10,
145 #define TRACE_BUF_SIZE 1024
148 * The CPU trace array - it consists of thousands of trace entries
149 * plus some other descriptor data: (for example which task started
152 struct trace_array_cpu {
154 void *buffer_page; /* ring buffer spare */
156 unsigned long saved_latency;
157 unsigned long critical_start;
158 unsigned long critical_end;
159 unsigned long critical_sequence;
161 unsigned long policy;
162 unsigned long rt_priority;
163 unsigned long skipped_entries;
164 cycle_t preempt_timestamp;
167 char comm[TASK_COMM_LEN];
171 * The trace array - an array of per-CPU trace arrays. This is the
172 * highest level data structure that individual tracers deal with.
173 * They have on/off state as well:
176 struct ring_buffer *buffer;
177 unsigned long entries;
180 struct task_struct *waiter;
181 struct trace_array_cpu *data[NR_CPUS];
184 #define FTRACE_CMP_TYPE(var, type) \
185 __builtin_types_compatible_p(typeof(var), type *)
188 #define IF_ASSIGN(var, entry, etype, id) \
189 if (FTRACE_CMP_TYPE(var, etype)) { \
190 var = (typeof(var))(entry); \
191 WARN_ON(id && (entry)->type != id); \
195 /* Will cause compile errors if type is not found. */
196 extern void __ftrace_bad_type(void);
199 * The trace_assign_type is a verifier that the entry type is
200 * the same as the type being assigned. To add new types simply
201 * add a line with the following format:
203 * IF_ASSIGN(var, ent, type, id);
205 * Where "type" is the trace type that includes the trace_entry
206 * as the "ent" item. And "id" is the trace identifier that is
207 * used in the trace_type enum.
209 * If the type can have more than one id, then use zero.
211 #define trace_assign_type(var, ent) \
213 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
214 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
215 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
216 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
217 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
218 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
219 IF_ASSIGN(var, ent, struct special_entry, 0); \
220 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
222 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
224 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
225 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
226 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
227 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
229 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
231 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
233 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
235 IF_ASSIGN(var, ent, struct ksym_trace_entry, TRACE_KSYM);\
236 __ftrace_bad_type(); \
240 * An option specific to a tracer. This is a boolean value.
241 * The bit is the bit index that sets its value on the
242 * flags value in struct tracer_flags.
245 const char *name; /* Will appear on the trace_options file */
246 u32 bit; /* Mask assigned in val field in tracer_flags */
250 * The set of specific options for a tracer. Your tracer
251 * have to set the initial value of the flags val.
253 struct tracer_flags {
255 struct tracer_opt *opts;
258 /* Makes more easy to define a tracer opt */
259 #define TRACER_OPT(s, b) .name = #s, .bit = b
263 * struct tracer - a specific tracer and its callbacks to interact with debugfs
264 * @name: the name chosen to select it on the available_tracers file
265 * @init: called when one switches to this tracer (echo name > current_tracer)
266 * @reset: called when one switches to another tracer
267 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
268 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
269 * @open: called when the trace file is opened
270 * @pipe_open: called when the trace_pipe file is opened
271 * @wait_pipe: override how the user waits for traces on trace_pipe
272 * @close: called when the trace file is released
273 * @pipe_close: called when the trace_pipe file is released
274 * @read: override the default read callback on trace_pipe
275 * @splice_read: override the default splice_read callback on trace_pipe
276 * @selftest: selftest to run on boot (see trace_selftest.c)
277 * @print_headers: override the first lines that describe your columns
278 * @print_line: callback that prints a trace
279 * @set_flag: signals one of your private flags changed (trace_options file)
280 * @flags: your private flags
284 int (*init)(struct trace_array *tr);
285 void (*reset)(struct trace_array *tr);
286 void (*start)(struct trace_array *tr);
287 void (*stop)(struct trace_array *tr);
288 void (*open)(struct trace_iterator *iter);
289 void (*pipe_open)(struct trace_iterator *iter);
290 void (*wait_pipe)(struct trace_iterator *iter);
291 void (*close)(struct trace_iterator *iter);
292 void (*pipe_close)(struct trace_iterator *iter);
293 ssize_t (*read)(struct trace_iterator *iter,
294 struct file *filp, char __user *ubuf,
295 size_t cnt, loff_t *ppos);
296 ssize_t (*splice_read)(struct trace_iterator *iter,
299 struct pipe_inode_info *pipe,
302 #ifdef CONFIG_FTRACE_STARTUP_TEST
303 int (*selftest)(struct tracer *trace,
304 struct trace_array *tr);
306 void (*print_header)(struct seq_file *m);
307 enum print_line_t (*print_line)(struct trace_iterator *iter);
308 /* If you handled the flag setting, return 0 */
309 int (*set_flag)(u32 old_flags, u32 bit, int set);
312 struct tracer_flags *flags;
316 #define TRACE_PIPE_ALL_CPU -1
318 int tracer_init(struct tracer *t, struct trace_array *tr);
319 int tracing_is_enabled(void);
320 void trace_wake_up(void);
321 void tracing_reset(struct trace_array *tr, int cpu);
322 void tracing_reset_online_cpus(struct trace_array *tr);
323 void tracing_reset_current(int cpu);
324 void tracing_reset_current_online_cpus(void);
325 int tracing_open_generic(struct inode *inode, struct file *filp);
326 struct dentry *trace_create_file(const char *name,
328 struct dentry *parent,
330 const struct file_operations *fops);
332 struct dentry *tracing_init_dentry(void);
333 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
335 struct ring_buffer_event;
337 struct ring_buffer_event *
338 trace_buffer_lock_reserve(struct ring_buffer *buffer,
343 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
344 struct ring_buffer_event *event,
345 unsigned long flags, int pc);
347 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
348 struct trace_array_cpu *data);
350 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
351 int *ent_cpu, u64 *ent_ts);
353 void default_wait_pipe(struct trace_iterator *iter);
354 void poll_wait_pipe(struct trace_iterator *iter);
356 void ftrace(struct trace_array *tr,
357 struct trace_array_cpu *data,
359 unsigned long parent_ip,
360 unsigned long flags, int pc);
361 void tracing_sched_switch_trace(struct trace_array *tr,
362 struct task_struct *prev,
363 struct task_struct *next,
364 unsigned long flags, int pc);
366 void tracing_sched_wakeup_trace(struct trace_array *tr,
367 struct task_struct *wakee,
368 struct task_struct *cur,
369 unsigned long flags, int pc);
370 void trace_special(struct trace_array *tr,
371 struct trace_array_cpu *data,
374 unsigned long arg3, int pc);
375 void trace_function(struct trace_array *tr,
377 unsigned long parent_ip,
378 unsigned long flags, int pc);
380 void trace_graph_return(struct ftrace_graph_ret *trace);
381 int trace_graph_entry(struct ftrace_graph_ent *trace);
382 void set_graph_array(struct trace_array *tr);
384 void tracing_start_cmdline_record(void);
385 void tracing_stop_cmdline_record(void);
386 void tracing_sched_switch_assign_trace(struct trace_array *tr);
387 void tracing_stop_sched_switch_record(void);
388 void tracing_start_sched_switch_record(void);
389 int register_tracer(struct tracer *type);
390 void unregister_tracer(struct tracer *type);
391 int is_tracing_stopped(void);
393 extern int process_new_ksym_entry(char *ksymname, int op, unsigned long addr);
395 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
397 extern unsigned long tracing_thresh;
399 #ifdef CONFIG_TRACER_MAX_TRACE
400 extern unsigned long tracing_max_latency;
402 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
403 void update_max_tr_single(struct trace_array *tr,
404 struct task_struct *tsk, int cpu);
405 #endif /* CONFIG_TRACER_MAX_TRACE */
407 #ifdef CONFIG_STACKTRACE
408 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
411 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
414 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
417 static inline void ftrace_trace_stack(struct trace_array *tr,
418 unsigned long flags, int skip, int pc)
422 static inline void ftrace_trace_userstack(struct trace_array *tr,
423 unsigned long flags, int pc)
427 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
431 #endif /* CONFIG_STACKTRACE */
433 extern cycle_t ftrace_now(int cpu);
435 extern void trace_find_cmdline(int pid, char comm[]);
437 #ifdef CONFIG_DYNAMIC_FTRACE
438 extern unsigned long ftrace_update_tot_cnt;
439 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
440 extern int DYN_FTRACE_TEST_NAME(void);
443 extern int ring_buffer_expanded;
444 extern bool tracing_selftest_disabled;
445 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
447 #ifdef CONFIG_FTRACE_STARTUP_TEST
448 extern int trace_selftest_startup_function(struct tracer *trace,
449 struct trace_array *tr);
450 extern int trace_selftest_startup_function_graph(struct tracer *trace,
451 struct trace_array *tr);
452 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
453 struct trace_array *tr);
454 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
455 struct trace_array *tr);
456 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
457 struct trace_array *tr);
458 extern int trace_selftest_startup_wakeup(struct tracer *trace,
459 struct trace_array *tr);
460 extern int trace_selftest_startup_nop(struct tracer *trace,
461 struct trace_array *tr);
462 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
463 struct trace_array *tr);
464 extern int trace_selftest_startup_sysprof(struct tracer *trace,
465 struct trace_array *tr);
466 extern int trace_selftest_startup_branch(struct tracer *trace,
467 struct trace_array *tr);
468 extern int trace_selftest_startup_ksym(struct tracer *trace,
469 struct trace_array *tr);
470 #endif /* CONFIG_FTRACE_STARTUP_TEST */
472 extern void *head_page(struct trace_array_cpu *data);
473 extern unsigned long long ns2usecs(cycle_t nsec);
475 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
477 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
479 trace_array_vprintk(struct trace_array *tr,
480 unsigned long ip, const char *fmt, va_list args);
481 int trace_array_printk(struct trace_array *tr,
482 unsigned long ip, const char *fmt, ...);
484 extern unsigned long trace_flags;
486 extern int trace_clock_id;
488 /* Standard output formatting function used for function return traces */
489 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
490 extern enum print_line_t print_graph_function(struct trace_iterator *iter);
491 extern enum print_line_t
492 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
494 #ifdef CONFIG_DYNAMIC_FTRACE
495 /* TODO: make this variable */
496 #define FTRACE_GRAPH_MAX_FUNCS 32
497 extern int ftrace_graph_filter_enabled;
498 extern int ftrace_graph_count;
499 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
501 static inline int ftrace_graph_addr(unsigned long addr)
505 if (!ftrace_graph_filter_enabled)
508 for (i = 0; i < ftrace_graph_count; i++) {
509 if (addr == ftrace_graph_funcs[i])
516 static inline int ftrace_graph_addr(unsigned long addr)
520 #endif /* CONFIG_DYNAMIC_FTRACE */
521 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
522 static inline enum print_line_t
523 print_graph_function(struct trace_iterator *iter)
525 return TRACE_TYPE_UNHANDLED;
527 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
529 extern struct list_head ftrace_pids;
531 #ifdef CONFIG_FUNCTION_TRACER
532 static inline int ftrace_trace_task(struct task_struct *task)
534 if (list_empty(&ftrace_pids))
537 return test_tsk_trace_trace(task);
540 static inline int ftrace_trace_task(struct task_struct *task)
547 * struct trace_parser - servers for reading the user input separated by spaces
548 * @cont: set if the input is not complete - no final space char was found
549 * @buffer: holds the parsed user input
550 * @idx: user input length
553 struct trace_parser {
560 static inline bool trace_parser_loaded(struct trace_parser *parser)
562 return (parser->idx != 0);
565 static inline bool trace_parser_cont(struct trace_parser *parser)
570 static inline void trace_parser_clear(struct trace_parser *parser)
572 parser->cont = false;
576 extern int trace_parser_get_init(struct trace_parser *parser, int size);
577 extern void trace_parser_put(struct trace_parser *parser);
578 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
579 size_t cnt, loff_t *ppos);
582 * trace_iterator_flags is an enumeration that defines bit
583 * positions into trace_flags that controls the output.
585 * NOTE: These bits must match the trace_options array in
588 enum trace_iterator_flags {
589 TRACE_ITER_PRINT_PARENT = 0x01,
590 TRACE_ITER_SYM_OFFSET = 0x02,
591 TRACE_ITER_SYM_ADDR = 0x04,
592 TRACE_ITER_VERBOSE = 0x08,
593 TRACE_ITER_RAW = 0x10,
594 TRACE_ITER_HEX = 0x20,
595 TRACE_ITER_BIN = 0x40,
596 TRACE_ITER_BLOCK = 0x80,
597 TRACE_ITER_STACKTRACE = 0x100,
598 TRACE_ITER_PRINTK = 0x200,
599 TRACE_ITER_PREEMPTONLY = 0x400,
600 TRACE_ITER_BRANCH = 0x800,
601 TRACE_ITER_ANNOTATE = 0x1000,
602 TRACE_ITER_USERSTACKTRACE = 0x2000,
603 TRACE_ITER_SYM_USEROBJ = 0x4000,
604 TRACE_ITER_PRINTK_MSGONLY = 0x8000,
605 TRACE_ITER_CONTEXT_INFO = 0x10000, /* Print pid/cpu/time */
606 TRACE_ITER_LATENCY_FMT = 0x20000,
607 TRACE_ITER_SLEEP_TIME = 0x40000,
608 TRACE_ITER_GRAPH_TIME = 0x80000,
612 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
613 * control the output of kernel symbols.
615 #define TRACE_ITER_SYM_MASK \
616 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
618 extern struct tracer nop_trace;
621 * ftrace_preempt_disable - disable preemption scheduler safe
623 * When tracing can happen inside the scheduler, there exists
624 * cases that the tracing might happen before the need_resched
625 * flag is checked. If this happens and the tracer calls
626 * preempt_enable (after a disable), a schedule might take place
627 * causing an infinite recursion.
629 * To prevent this, we read the need_resched flag before
630 * disabling preemption. When we want to enable preemption we
631 * check the flag, if it is set, then we call preempt_enable_no_resched.
632 * Otherwise, we call preempt_enable.
634 * The rational for doing the above is that if need_resched is set
635 * and we have yet to reschedule, we are either in an atomic location
636 * (where we do not need to check for scheduling) or we are inside
637 * the scheduler and do not want to resched.
639 static inline int ftrace_preempt_disable(void)
643 resched = need_resched();
644 preempt_disable_notrace();
650 * ftrace_preempt_enable - enable preemption scheduler safe
651 * @resched: the return value from ftrace_preempt_disable
653 * This is a scheduler safe way to enable preemption and not miss
654 * any preemption checks. The disabled saved the state of preemption.
655 * If resched is set, then we are either inside an atomic or
656 * are inside the scheduler (we would have already scheduled
657 * otherwise). In this case, we do not want to call normal
658 * preempt_enable, but preempt_enable_no_resched instead.
660 static inline void ftrace_preempt_enable(int resched)
663 preempt_enable_no_resched_notrace();
665 preempt_enable_notrace();
668 #ifdef CONFIG_BRANCH_TRACER
669 extern int enable_branch_tracing(struct trace_array *tr);
670 extern void disable_branch_tracing(void);
671 static inline int trace_branch_enable(struct trace_array *tr)
673 if (trace_flags & TRACE_ITER_BRANCH)
674 return enable_branch_tracing(tr);
677 static inline void trace_branch_disable(void)
679 /* due to races, always disable */
680 disable_branch_tracing();
683 static inline int trace_branch_enable(struct trace_array *tr)
687 static inline void trace_branch_disable(void)
690 #endif /* CONFIG_BRANCH_TRACER */
692 /* set ring buffers to default size if not already done so */
693 int tracing_update_buffers(void);
695 /* trace event type bit fields, not numeric */
697 TRACE_EVENT_TYPE_PRINTF = 1,
698 TRACE_EVENT_TYPE_RAW = 2,
701 struct ftrace_event_field {
702 struct list_head link;
711 struct event_filter {
713 struct filter_pred **preds;
717 struct event_subsystem {
718 struct list_head list;
720 struct dentry *entry;
721 struct event_filter *filter;
728 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
731 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
741 char pattern[MAX_FILTER_STR_VAL];
744 regex_match_func match;
758 extern enum regex_type
759 filter_parse_regex(char *buff, int len, char **search, int *not);
760 extern void print_event_filter(struct ftrace_event_call *call,
761 struct trace_seq *s);
762 extern int apply_event_filter(struct ftrace_event_call *call,
763 char *filter_string);
764 extern int apply_subsystem_event_filter(struct event_subsystem *system,
765 char *filter_string);
766 extern void print_subsystem_event_filter(struct event_subsystem *system,
767 struct trace_seq *s);
768 extern int filter_assign_type(const char *type);
771 filter_check_discard(struct ftrace_event_call *call, void *rec,
772 struct ring_buffer *buffer,
773 struct ring_buffer_event *event)
775 if (unlikely(call->filter_active) &&
776 !filter_match_preds(call->filter, rec)) {
777 ring_buffer_discard_commit(buffer, event);
784 extern struct mutex event_mutex;
785 extern struct list_head ftrace_events;
787 extern const char *__start___trace_bprintk_fmt[];
788 extern const char *__stop___trace_bprintk_fmt[];
791 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
792 extern struct ftrace_event_call \
793 __attribute__((__aligned__(4))) event_##call;
794 #undef FTRACE_ENTRY_DUP
795 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
796 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
797 #include "trace_entries.h"
799 #endif /* _LINUX_KERNEL_TRACE_H */