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 <linux/hw_breakpoint.h>
13 #include <linux/trace_seq.h>
14 #include <linux/ftrace_event.h>
17 __TRACE_FIRST_TYPE = 0,
39 #define __field(type, item) type item;
42 #define __field_struct(type, item) __field(type, item)
45 #define __field_desc(type, container, item)
48 #define __array(type, item, size) type item[size];
51 #define __array_desc(type, container, item, size)
53 #undef __dynamic_array
54 #define __dynamic_array(type, item) type item[];
57 #define F_STRUCT(args...) args
60 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
61 struct struct_name { \
62 struct trace_entry ent; \
67 #define TP_ARGS(args...) args
69 #undef FTRACE_ENTRY_DUP
70 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
72 #include "trace_entries.h"
75 * syscalls are special, and need special handling, this is why
76 * they are not included in trace_entries.h
78 struct syscall_trace_enter {
79 struct trace_entry ent;
84 struct syscall_trace_exit {
85 struct trace_entry ent;
90 struct kprobe_trace_entry_head {
91 struct trace_entry ent;
95 struct kretprobe_trace_entry_head {
96 struct trace_entry ent;
102 * trace_flag_type is an enumeration that holds different
103 * states when a trace occurs. These are:
104 * IRQS_OFF - interrupts were disabled
105 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
106 * NEED_RESCHED - reschedule is requested
107 * HARDIRQ - inside an interrupt handler
108 * SOFTIRQ - inside a softirq handler
110 enum trace_flag_type {
111 TRACE_FLAG_IRQS_OFF = 0x01,
112 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
113 TRACE_FLAG_NEED_RESCHED = 0x04,
114 TRACE_FLAG_HARDIRQ = 0x08,
115 TRACE_FLAG_SOFTIRQ = 0x10,
118 #define TRACE_BUF_SIZE 1024
121 * The CPU trace array - it consists of thousands of trace entries
122 * plus some other descriptor data: (for example which task started
125 struct trace_array_cpu {
127 void *buffer_page; /* ring buffer spare */
129 unsigned long saved_latency;
130 unsigned long critical_start;
131 unsigned long critical_end;
132 unsigned long critical_sequence;
134 unsigned long policy;
135 unsigned long rt_priority;
136 unsigned long skipped_entries;
137 cycle_t preempt_timestamp;
140 char comm[TASK_COMM_LEN];
144 * The trace array - an array of per-CPU trace arrays. This is the
145 * highest level data structure that individual tracers deal with.
146 * They have on/off state as well:
149 struct ring_buffer *buffer;
150 unsigned long entries;
153 struct task_struct *waiter;
154 struct trace_array_cpu *data[NR_CPUS];
157 #define FTRACE_CMP_TYPE(var, type) \
158 __builtin_types_compatible_p(typeof(var), type *)
161 #define IF_ASSIGN(var, entry, etype, id) \
162 if (FTRACE_CMP_TYPE(var, etype)) { \
163 var = (typeof(var))(entry); \
164 WARN_ON(id && (entry)->type != id); \
168 /* Will cause compile errors if type is not found. */
169 extern void __ftrace_bad_type(void);
172 * The trace_assign_type is a verifier that the entry type is
173 * the same as the type being assigned. To add new types simply
174 * add a line with the following format:
176 * IF_ASSIGN(var, ent, type, id);
178 * Where "type" is the trace type that includes the trace_entry
179 * as the "ent" item. And "id" is the trace identifier that is
180 * used in the trace_type enum.
182 * If the type can have more than one id, then use zero.
184 #define trace_assign_type(var, ent) \
186 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
187 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
188 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
189 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
190 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
191 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
192 IF_ASSIGN(var, ent, struct special_entry, 0); \
193 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
195 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
197 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
198 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
200 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
202 __ftrace_bad_type(); \
206 * An option specific to a tracer. This is a boolean value.
207 * The bit is the bit index that sets its value on the
208 * flags value in struct tracer_flags.
211 const char *name; /* Will appear on the trace_options file */
212 u32 bit; /* Mask assigned in val field in tracer_flags */
216 * The set of specific options for a tracer. Your tracer
217 * have to set the initial value of the flags val.
219 struct tracer_flags {
221 struct tracer_opt *opts;
224 /* Makes more easy to define a tracer opt */
225 #define TRACER_OPT(s, b) .name = #s, .bit = b
229 * struct tracer - a specific tracer and its callbacks to interact with debugfs
230 * @name: the name chosen to select it on the available_tracers file
231 * @init: called when one switches to this tracer (echo name > current_tracer)
232 * @reset: called when one switches to another tracer
233 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
234 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
235 * @open: called when the trace file is opened
236 * @pipe_open: called when the trace_pipe file is opened
237 * @wait_pipe: override how the user waits for traces on trace_pipe
238 * @close: called when the trace file is released
239 * @pipe_close: called when the trace_pipe file is released
240 * @read: override the default read callback on trace_pipe
241 * @splice_read: override the default splice_read callback on trace_pipe
242 * @selftest: selftest to run on boot (see trace_selftest.c)
243 * @print_headers: override the first lines that describe your columns
244 * @print_line: callback that prints a trace
245 * @set_flag: signals one of your private flags changed (trace_options file)
246 * @flags: your private flags
250 int (*init)(struct trace_array *tr);
251 void (*reset)(struct trace_array *tr);
252 void (*start)(struct trace_array *tr);
253 void (*stop)(struct trace_array *tr);
254 void (*open)(struct trace_iterator *iter);
255 void (*pipe_open)(struct trace_iterator *iter);
256 void (*wait_pipe)(struct trace_iterator *iter);
257 void (*close)(struct trace_iterator *iter);
258 void (*pipe_close)(struct trace_iterator *iter);
259 ssize_t (*read)(struct trace_iterator *iter,
260 struct file *filp, char __user *ubuf,
261 size_t cnt, loff_t *ppos);
262 ssize_t (*splice_read)(struct trace_iterator *iter,
265 struct pipe_inode_info *pipe,
268 #ifdef CONFIG_FTRACE_STARTUP_TEST
269 int (*selftest)(struct tracer *trace,
270 struct trace_array *tr);
272 void (*print_header)(struct seq_file *m);
273 enum print_line_t (*print_line)(struct trace_iterator *iter);
274 /* If you handled the flag setting, return 0 */
275 int (*set_flag)(u32 old_flags, u32 bit, int set);
278 struct tracer_flags *flags;
282 #define TRACE_PIPE_ALL_CPU -1
284 int tracer_init(struct tracer *t, struct trace_array *tr);
285 int tracing_is_enabled(void);
286 void trace_wake_up(void);
287 void tracing_reset(struct trace_array *tr, int cpu);
288 void tracing_reset_online_cpus(struct trace_array *tr);
289 void tracing_reset_current(int cpu);
290 void tracing_reset_current_online_cpus(void);
291 int tracing_open_generic(struct inode *inode, struct file *filp);
292 struct dentry *trace_create_file(const char *name,
294 struct dentry *parent,
296 const struct file_operations *fops);
298 struct dentry *tracing_init_dentry(void);
299 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
301 struct ring_buffer_event;
303 struct ring_buffer_event *
304 trace_buffer_lock_reserve(struct ring_buffer *buffer,
309 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
310 struct ring_buffer_event *event,
311 unsigned long flags, int pc);
313 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
314 struct trace_array_cpu *data);
316 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
317 int *ent_cpu, u64 *ent_ts);
319 void default_wait_pipe(struct trace_iterator *iter);
320 void poll_wait_pipe(struct trace_iterator *iter);
322 void ftrace(struct trace_array *tr,
323 struct trace_array_cpu *data,
325 unsigned long parent_ip,
326 unsigned long flags, int pc);
327 void tracing_sched_switch_trace(struct trace_array *tr,
328 struct task_struct *prev,
329 struct task_struct *next,
330 unsigned long flags, int pc);
332 void tracing_sched_wakeup_trace(struct trace_array *tr,
333 struct task_struct *wakee,
334 struct task_struct *cur,
335 unsigned long flags, int pc);
336 void trace_special(struct trace_array *tr,
337 struct trace_array_cpu *data,
340 unsigned long arg3, int pc);
341 void trace_function(struct trace_array *tr,
343 unsigned long parent_ip,
344 unsigned long flags, int pc);
345 void trace_default_header(struct seq_file *m);
346 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
347 int trace_empty(struct trace_iterator *iter);
349 void trace_graph_return(struct ftrace_graph_ret *trace);
350 int trace_graph_entry(struct ftrace_graph_ent *trace);
351 void set_graph_array(struct trace_array *tr);
353 void tracing_start_cmdline_record(void);
354 void tracing_stop_cmdline_record(void);
355 void tracing_sched_switch_assign_trace(struct trace_array *tr);
356 void tracing_stop_sched_switch_record(void);
357 void tracing_start_sched_switch_record(void);
358 int register_tracer(struct tracer *type);
359 void unregister_tracer(struct tracer *type);
360 int is_tracing_stopped(void);
362 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
364 extern unsigned long tracing_thresh;
366 #ifdef CONFIG_TRACER_MAX_TRACE
367 extern unsigned long tracing_max_latency;
369 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
370 void update_max_tr_single(struct trace_array *tr,
371 struct task_struct *tsk, int cpu);
372 #endif /* CONFIG_TRACER_MAX_TRACE */
374 #ifdef CONFIG_STACKTRACE
375 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
378 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
381 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
384 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
385 unsigned long flags, int skip, int pc)
389 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
390 unsigned long flags, int pc)
394 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
398 #endif /* CONFIG_STACKTRACE */
400 extern cycle_t ftrace_now(int cpu);
402 extern void trace_find_cmdline(int pid, char comm[]);
404 #ifdef CONFIG_DYNAMIC_FTRACE
405 extern unsigned long ftrace_update_tot_cnt;
406 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
407 extern int DYN_FTRACE_TEST_NAME(void);
410 extern int ring_buffer_expanded;
411 extern bool tracing_selftest_disabled;
412 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
414 #ifdef CONFIG_FTRACE_STARTUP_TEST
415 extern int trace_selftest_startup_function(struct tracer *trace,
416 struct trace_array *tr);
417 extern int trace_selftest_startup_function_graph(struct tracer *trace,
418 struct trace_array *tr);
419 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
420 struct trace_array *tr);
421 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
422 struct trace_array *tr);
423 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
424 struct trace_array *tr);
425 extern int trace_selftest_startup_wakeup(struct tracer *trace,
426 struct trace_array *tr);
427 extern int trace_selftest_startup_nop(struct tracer *trace,
428 struct trace_array *tr);
429 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
430 struct trace_array *tr);
431 extern int trace_selftest_startup_sysprof(struct tracer *trace,
432 struct trace_array *tr);
433 extern int trace_selftest_startup_branch(struct tracer *trace,
434 struct trace_array *tr);
435 #endif /* CONFIG_FTRACE_STARTUP_TEST */
437 extern void *head_page(struct trace_array_cpu *data);
438 extern unsigned long long ns2usecs(cycle_t nsec);
440 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
442 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
444 trace_array_vprintk(struct trace_array *tr,
445 unsigned long ip, const char *fmt, va_list args);
446 int trace_array_printk(struct trace_array *tr,
447 unsigned long ip, const char *fmt, ...);
449 extern unsigned long trace_flags;
451 extern int trace_clock_id;
453 /* Standard output formatting function used for function return traces */
454 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
457 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
458 #define TRACE_GRAPH_PRINT_CPU 0x2
459 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
460 #define TRACE_GRAPH_PRINT_PROC 0x8
461 #define TRACE_GRAPH_PRINT_DURATION 0x10
462 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
464 extern enum print_line_t
465 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
466 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
467 extern enum print_line_t
468 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
469 extern void graph_trace_open(struct trace_iterator *iter);
470 extern void graph_trace_close(struct trace_iterator *iter);
471 extern int __trace_graph_entry(struct trace_array *tr,
472 struct ftrace_graph_ent *trace,
473 unsigned long flags, int pc);
474 extern void __trace_graph_return(struct trace_array *tr,
475 struct ftrace_graph_ret *trace,
476 unsigned long flags, int pc);
479 #ifdef CONFIG_DYNAMIC_FTRACE
480 /* TODO: make this variable */
481 #define FTRACE_GRAPH_MAX_FUNCS 32
482 extern int ftrace_graph_filter_enabled;
483 extern int ftrace_graph_count;
484 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
486 static inline int ftrace_graph_addr(unsigned long addr)
490 if (!ftrace_graph_filter_enabled)
493 for (i = 0; i < ftrace_graph_count; i++) {
494 if (addr == ftrace_graph_funcs[i])
501 static inline int ftrace_graph_addr(unsigned long addr)
505 #endif /* CONFIG_DYNAMIC_FTRACE */
506 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
507 static inline enum print_line_t
508 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
510 return TRACE_TYPE_UNHANDLED;
512 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
514 extern struct list_head ftrace_pids;
516 #ifdef CONFIG_FUNCTION_TRACER
517 static inline int ftrace_trace_task(struct task_struct *task)
519 if (list_empty(&ftrace_pids))
522 return test_tsk_trace_trace(task);
525 static inline int ftrace_trace_task(struct task_struct *task)
532 * struct trace_parser - servers for reading the user input separated by spaces
533 * @cont: set if the input is not complete - no final space char was found
534 * @buffer: holds the parsed user input
535 * @idx: user input length
538 struct trace_parser {
545 static inline bool trace_parser_loaded(struct trace_parser *parser)
547 return (parser->idx != 0);
550 static inline bool trace_parser_cont(struct trace_parser *parser)
555 static inline void trace_parser_clear(struct trace_parser *parser)
557 parser->cont = false;
561 extern int trace_parser_get_init(struct trace_parser *parser, int size);
562 extern void trace_parser_put(struct trace_parser *parser);
563 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
564 size_t cnt, loff_t *ppos);
567 * trace_iterator_flags is an enumeration that defines bit
568 * positions into trace_flags that controls the output.
570 * NOTE: These bits must match the trace_options array in
573 enum trace_iterator_flags {
574 TRACE_ITER_PRINT_PARENT = 0x01,
575 TRACE_ITER_SYM_OFFSET = 0x02,
576 TRACE_ITER_SYM_ADDR = 0x04,
577 TRACE_ITER_VERBOSE = 0x08,
578 TRACE_ITER_RAW = 0x10,
579 TRACE_ITER_HEX = 0x20,
580 TRACE_ITER_BIN = 0x40,
581 TRACE_ITER_BLOCK = 0x80,
582 TRACE_ITER_STACKTRACE = 0x100,
583 TRACE_ITER_PRINTK = 0x200,
584 TRACE_ITER_PREEMPTONLY = 0x400,
585 TRACE_ITER_BRANCH = 0x800,
586 TRACE_ITER_ANNOTATE = 0x1000,
587 TRACE_ITER_USERSTACKTRACE = 0x2000,
588 TRACE_ITER_SYM_USEROBJ = 0x4000,
589 TRACE_ITER_PRINTK_MSGONLY = 0x8000,
590 TRACE_ITER_CONTEXT_INFO = 0x10000, /* Print pid/cpu/time */
591 TRACE_ITER_LATENCY_FMT = 0x20000,
592 TRACE_ITER_SLEEP_TIME = 0x40000,
593 TRACE_ITER_GRAPH_TIME = 0x80000,
597 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
598 * control the output of kernel symbols.
600 #define TRACE_ITER_SYM_MASK \
601 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
603 extern struct tracer nop_trace;
605 #ifdef CONFIG_BRANCH_TRACER
606 extern int enable_branch_tracing(struct trace_array *tr);
607 extern void disable_branch_tracing(void);
608 static inline int trace_branch_enable(struct trace_array *tr)
610 if (trace_flags & TRACE_ITER_BRANCH)
611 return enable_branch_tracing(tr);
614 static inline void trace_branch_disable(void)
616 /* due to races, always disable */
617 disable_branch_tracing();
620 static inline int trace_branch_enable(struct trace_array *tr)
624 static inline void trace_branch_disable(void)
627 #endif /* CONFIG_BRANCH_TRACER */
629 /* set ring buffers to default size if not already done so */
630 int tracing_update_buffers(void);
632 /* trace event type bit fields, not numeric */
634 TRACE_EVENT_TYPE_PRINTF = 1,
635 TRACE_EVENT_TYPE_RAW = 2,
638 struct ftrace_event_field {
639 struct list_head link;
648 struct event_filter {
650 struct filter_pred **preds;
654 struct event_subsystem {
655 struct list_head list;
657 struct dentry *entry;
658 struct event_filter *filter;
665 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
668 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
678 char pattern[MAX_FILTER_STR_VAL];
681 regex_match_func match;
695 extern struct list_head ftrace_common_fields;
697 extern enum regex_type
698 filter_parse_regex(char *buff, int len, char **search, int *not);
699 extern void print_event_filter(struct ftrace_event_call *call,
700 struct trace_seq *s);
701 extern int apply_event_filter(struct ftrace_event_call *call,
702 char *filter_string);
703 extern int apply_subsystem_event_filter(struct event_subsystem *system,
704 char *filter_string);
705 extern void print_subsystem_event_filter(struct event_subsystem *system,
706 struct trace_seq *s);
707 extern int filter_assign_type(const char *type);
710 trace_get_fields(struct ftrace_event_call *event_call);
713 filter_check_discard(struct ftrace_event_call *call, void *rec,
714 struct ring_buffer *buffer,
715 struct ring_buffer_event *event)
717 if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
718 !filter_match_preds(call->filter, rec)) {
719 ring_buffer_discard_commit(buffer, event);
726 extern struct mutex event_mutex;
727 extern struct list_head ftrace_events;
729 extern const char *__start___trace_bprintk_fmt[];
730 extern const char *__stop___trace_bprintk_fmt[];
733 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
734 extern struct ftrace_event_call \
735 __attribute__((__aligned__(4))) event_##call;
736 #undef FTRACE_ENTRY_DUP
737 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
738 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
739 #include "trace_entries.h"
741 #endif /* _LINUX_KERNEL_TRACE_H */