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,
38 #define __field(type, item) type item;
41 #define __field_struct(type, item) __field(type, item)
44 #define __field_desc(type, container, item)
47 #define __array(type, item, size) type item[size];
50 #define __array_desc(type, container, item, size)
52 #undef __dynamic_array
53 #define __dynamic_array(type, item) type item[];
56 #define F_STRUCT(args...) args
59 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
60 struct struct_name { \
61 struct trace_entry ent; \
66 #define TP_ARGS(args...) args
68 #undef FTRACE_ENTRY_DUP
69 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
71 #include "trace_entries.h"
74 * syscalls are special, and need special handling, this is why
75 * they are not included in trace_entries.h
77 struct syscall_trace_enter
{
78 struct trace_entry ent
;
83 struct syscall_trace_exit
{
84 struct trace_entry ent
;
89 struct kprobe_trace_entry_head
{
90 struct trace_entry ent
;
94 struct kretprobe_trace_entry_head
{
95 struct trace_entry ent
;
101 * trace_flag_type is an enumeration that holds different
102 * states when a trace occurs. These are:
103 * IRQS_OFF - interrupts were disabled
104 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
105 * NEED_RESCHED - reschedule is requested
106 * HARDIRQ - inside an interrupt handler
107 * SOFTIRQ - inside a softirq handler
109 enum trace_flag_type
{
110 TRACE_FLAG_IRQS_OFF
= 0x01,
111 TRACE_FLAG_IRQS_NOSUPPORT
= 0x02,
112 TRACE_FLAG_NEED_RESCHED
= 0x04,
113 TRACE_FLAG_HARDIRQ
= 0x08,
114 TRACE_FLAG_SOFTIRQ
= 0x10,
117 #define TRACE_BUF_SIZE 1024
120 * The CPU trace array - it consists of thousands of trace entries
121 * plus some other descriptor data: (for example which task started
124 struct trace_array_cpu
{
126 void *buffer_page
; /* ring buffer spare */
128 unsigned long saved_latency
;
129 unsigned long critical_start
;
130 unsigned long critical_end
;
131 unsigned long critical_sequence
;
133 unsigned long policy
;
134 unsigned long rt_priority
;
135 unsigned long skipped_entries
;
136 cycle_t preempt_timestamp
;
139 char comm
[TASK_COMM_LEN
];
143 * The trace array - an array of per-CPU trace arrays. This is the
144 * highest level data structure that individual tracers deal with.
145 * They have on/off state as well:
148 struct ring_buffer
*buffer
;
149 unsigned long entries
;
152 struct task_struct
*waiter
;
153 struct trace_array_cpu
*data
[NR_CPUS
];
156 #define FTRACE_CMP_TYPE(var, type) \
157 __builtin_types_compatible_p(typeof(var), type *)
160 #define IF_ASSIGN(var, entry, etype, id) \
161 if (FTRACE_CMP_TYPE(var, etype)) { \
162 var = (typeof(var))(entry); \
163 WARN_ON(id && (entry)->type != id); \
167 /* Will cause compile errors if type is not found. */
168 extern void __ftrace_bad_type(void);
171 * The trace_assign_type is a verifier that the entry type is
172 * the same as the type being assigned. To add new types simply
173 * add a line with the following format:
175 * IF_ASSIGN(var, ent, type, id);
177 * Where "type" is the trace type that includes the trace_entry
178 * as the "ent" item. And "id" is the trace identifier that is
179 * used in the trace_type enum.
181 * If the type can have more than one id, then use zero.
183 #define trace_assign_type(var, ent) \
185 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
186 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
187 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
188 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
189 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
190 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
191 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
193 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
195 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
196 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
198 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
200 __ftrace_bad_type(); \
204 * An option specific to a tracer. This is a boolean value.
205 * The bit is the bit index that sets its value on the
206 * flags value in struct tracer_flags.
209 const char *name
; /* Will appear on the trace_options file */
210 u32 bit
; /* Mask assigned in val field in tracer_flags */
214 * The set of specific options for a tracer. Your tracer
215 * have to set the initial value of the flags val.
217 struct tracer_flags
{
219 struct tracer_opt
*opts
;
222 /* Makes more easy to define a tracer opt */
223 #define TRACER_OPT(s, b) .name = #s, .bit = b
227 * struct tracer - a specific tracer and its callbacks to interact with debugfs
228 * @name: the name chosen to select it on the available_tracers file
229 * @init: called when one switches to this tracer (echo name > current_tracer)
230 * @reset: called when one switches to another tracer
231 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
232 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
233 * @open: called when the trace file is opened
234 * @pipe_open: called when the trace_pipe file is opened
235 * @wait_pipe: override how the user waits for traces on trace_pipe
236 * @close: called when the trace file is released
237 * @pipe_close: called when the trace_pipe file is released
238 * @read: override the default read callback on trace_pipe
239 * @splice_read: override the default splice_read callback on trace_pipe
240 * @selftest: selftest to run on boot (see trace_selftest.c)
241 * @print_headers: override the first lines that describe your columns
242 * @print_line: callback that prints a trace
243 * @set_flag: signals one of your private flags changed (trace_options file)
244 * @flags: your private flags
248 int (*init
)(struct trace_array
*tr
);
249 void (*reset
)(struct trace_array
*tr
);
250 void (*start
)(struct trace_array
*tr
);
251 void (*stop
)(struct trace_array
*tr
);
252 void (*open
)(struct trace_iterator
*iter
);
253 void (*pipe_open
)(struct trace_iterator
*iter
);
254 void (*wait_pipe
)(struct trace_iterator
*iter
);
255 void (*close
)(struct trace_iterator
*iter
);
256 void (*pipe_close
)(struct trace_iterator
*iter
);
257 ssize_t (*read
)(struct trace_iterator
*iter
,
258 struct file
*filp
, char __user
*ubuf
,
259 size_t cnt
, loff_t
*ppos
);
260 ssize_t (*splice_read
)(struct trace_iterator
*iter
,
263 struct pipe_inode_info
*pipe
,
266 #ifdef CONFIG_FTRACE_STARTUP_TEST
267 int (*selftest
)(struct tracer
*trace
,
268 struct trace_array
*tr
);
270 void (*print_header
)(struct seq_file
*m
);
271 enum print_line_t (*print_line
)(struct trace_iterator
*iter
);
272 /* If you handled the flag setting, return 0 */
273 int (*set_flag
)(u32 old_flags
, u32 bit
, int set
);
276 struct tracer_flags
*flags
;
281 #define TRACE_PIPE_ALL_CPU -1
283 int tracer_init(struct tracer
*t
, struct trace_array
*tr
);
284 int tracing_is_enabled(void);
285 void trace_wake_up(void);
286 void tracing_reset(struct trace_array
*tr
, int cpu
);
287 void tracing_reset_online_cpus(struct trace_array
*tr
);
288 void tracing_reset_current(int cpu
);
289 void tracing_reset_current_online_cpus(void);
290 int tracing_open_generic(struct inode
*inode
, struct file
*filp
);
291 struct dentry
*trace_create_file(const char *name
,
293 struct dentry
*parent
,
295 const struct file_operations
*fops
);
297 struct dentry
*tracing_init_dentry(void);
299 struct ring_buffer_event
;
301 struct ring_buffer_event
*
302 trace_buffer_lock_reserve(struct ring_buffer
*buffer
,
307 void trace_buffer_unlock_commit(struct ring_buffer
*buffer
,
308 struct ring_buffer_event
*event
,
309 unsigned long flags
, int pc
);
311 struct trace_entry
*tracing_get_trace_entry(struct trace_array
*tr
,
312 struct trace_array_cpu
*data
);
314 struct trace_entry
*trace_find_next_entry(struct trace_iterator
*iter
,
315 int *ent_cpu
, u64
*ent_ts
);
317 void default_wait_pipe(struct trace_iterator
*iter
);
318 void poll_wait_pipe(struct trace_iterator
*iter
);
320 void ftrace(struct trace_array
*tr
,
321 struct trace_array_cpu
*data
,
323 unsigned long parent_ip
,
324 unsigned long flags
, int pc
);
325 void tracing_sched_switch_trace(struct trace_array
*tr
,
326 struct task_struct
*prev
,
327 struct task_struct
*next
,
328 unsigned long flags
, int pc
);
330 void tracing_sched_wakeup_trace(struct trace_array
*tr
,
331 struct task_struct
*wakee
,
332 struct task_struct
*cur
,
333 unsigned long flags
, int pc
);
334 void trace_function(struct trace_array
*tr
,
336 unsigned long parent_ip
,
337 unsigned long flags
, int pc
);
338 void trace_default_header(struct seq_file
*m
);
339 void print_trace_header(struct seq_file
*m
, struct trace_iterator
*iter
);
340 int trace_empty(struct trace_iterator
*iter
);
342 void trace_graph_return(struct ftrace_graph_ret
*trace
);
343 int trace_graph_entry(struct ftrace_graph_ent
*trace
);
344 void set_graph_array(struct trace_array
*tr
);
346 void tracing_start_cmdline_record(void);
347 void tracing_stop_cmdline_record(void);
348 void tracing_sched_switch_assign_trace(struct trace_array
*tr
);
349 void tracing_stop_sched_switch_record(void);
350 void tracing_start_sched_switch_record(void);
351 int register_tracer(struct tracer
*type
);
352 void unregister_tracer(struct tracer
*type
);
353 int is_tracing_stopped(void);
355 extern unsigned long nsecs_to_usecs(unsigned long nsecs
);
357 extern unsigned long tracing_thresh
;
359 #ifdef CONFIG_TRACER_MAX_TRACE
360 extern unsigned long tracing_max_latency
;
362 void update_max_tr(struct trace_array
*tr
, struct task_struct
*tsk
, int cpu
);
363 void update_max_tr_single(struct trace_array
*tr
,
364 struct task_struct
*tsk
, int cpu
);
365 #endif /* CONFIG_TRACER_MAX_TRACE */
367 #ifdef CONFIG_STACKTRACE
368 void ftrace_trace_stack(struct ring_buffer
*buffer
, unsigned long flags
,
371 void ftrace_trace_userstack(struct ring_buffer
*buffer
, unsigned long flags
,
374 void __trace_stack(struct trace_array
*tr
, unsigned long flags
, int skip
,
377 static inline void ftrace_trace_stack(struct ring_buffer
*buffer
,
378 unsigned long flags
, int skip
, int pc
)
382 static inline void ftrace_trace_userstack(struct ring_buffer
*buffer
,
383 unsigned long flags
, int pc
)
387 static inline void __trace_stack(struct trace_array
*tr
, unsigned long flags
,
391 #endif /* CONFIG_STACKTRACE */
393 extern cycle_t
ftrace_now(int cpu
);
395 extern void trace_find_cmdline(int pid
, char comm
[]);
397 #ifdef CONFIG_DYNAMIC_FTRACE
398 extern unsigned long ftrace_update_tot_cnt
;
399 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
400 extern int DYN_FTRACE_TEST_NAME(void);
403 extern int ring_buffer_expanded
;
404 extern bool tracing_selftest_disabled
;
405 DECLARE_PER_CPU(int, ftrace_cpu_disabled
);
407 #ifdef CONFIG_FTRACE_STARTUP_TEST
408 extern int trace_selftest_startup_function(struct tracer
*trace
,
409 struct trace_array
*tr
);
410 extern int trace_selftest_startup_function_graph(struct tracer
*trace
,
411 struct trace_array
*tr
);
412 extern int trace_selftest_startup_irqsoff(struct tracer
*trace
,
413 struct trace_array
*tr
);
414 extern int trace_selftest_startup_preemptoff(struct tracer
*trace
,
415 struct trace_array
*tr
);
416 extern int trace_selftest_startup_preemptirqsoff(struct tracer
*trace
,
417 struct trace_array
*tr
);
418 extern int trace_selftest_startup_wakeup(struct tracer
*trace
,
419 struct trace_array
*tr
);
420 extern int trace_selftest_startup_nop(struct tracer
*trace
,
421 struct trace_array
*tr
);
422 extern int trace_selftest_startup_sched_switch(struct tracer
*trace
,
423 struct trace_array
*tr
);
424 extern int trace_selftest_startup_branch(struct tracer
*trace
,
425 struct trace_array
*tr
);
426 #endif /* CONFIG_FTRACE_STARTUP_TEST */
428 extern void *head_page(struct trace_array_cpu
*data
);
429 extern unsigned long long ns2usecs(cycle_t nsec
);
431 trace_vbprintk(unsigned long ip
, const char *fmt
, va_list args
);
433 trace_vprintk(unsigned long ip
, const char *fmt
, va_list args
);
435 trace_array_vprintk(struct trace_array
*tr
,
436 unsigned long ip
, const char *fmt
, va_list args
);
437 int trace_array_printk(struct trace_array
*tr
,
438 unsigned long ip
, const char *fmt
, ...);
440 extern unsigned long trace_flags
;
442 extern int trace_clock_id
;
444 /* Standard output formatting function used for function return traces */
445 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
448 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
449 #define TRACE_GRAPH_PRINT_CPU 0x2
450 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
451 #define TRACE_GRAPH_PRINT_PROC 0x8
452 #define TRACE_GRAPH_PRINT_DURATION 0x10
453 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
455 extern enum print_line_t
456 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
);
457 extern void print_graph_headers_flags(struct seq_file
*s
, u32 flags
);
458 extern enum print_line_t
459 trace_print_graph_duration(unsigned long long duration
, struct trace_seq
*s
);
460 extern void graph_trace_open(struct trace_iterator
*iter
);
461 extern void graph_trace_close(struct trace_iterator
*iter
);
462 extern int __trace_graph_entry(struct trace_array
*tr
,
463 struct ftrace_graph_ent
*trace
,
464 unsigned long flags
, int pc
);
465 extern void __trace_graph_return(struct trace_array
*tr
,
466 struct ftrace_graph_ret
*trace
,
467 unsigned long flags
, int pc
);
470 #ifdef CONFIG_DYNAMIC_FTRACE
471 /* TODO: make this variable */
472 #define FTRACE_GRAPH_MAX_FUNCS 32
473 extern int ftrace_graph_filter_enabled
;
474 extern int ftrace_graph_count
;
475 extern unsigned long ftrace_graph_funcs
[FTRACE_GRAPH_MAX_FUNCS
];
477 static inline int ftrace_graph_addr(unsigned long addr
)
481 if (!ftrace_graph_filter_enabled
)
484 for (i
= 0; i
< ftrace_graph_count
; i
++) {
485 if (addr
== ftrace_graph_funcs
[i
])
492 static inline int ftrace_graph_addr(unsigned long addr
)
496 #endif /* CONFIG_DYNAMIC_FTRACE */
497 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
498 static inline enum print_line_t
499 print_graph_function_flags(struct trace_iterator
*iter
, u32 flags
)
501 return TRACE_TYPE_UNHANDLED
;
503 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
505 extern struct list_head ftrace_pids
;
507 #ifdef CONFIG_FUNCTION_TRACER
508 static inline int ftrace_trace_task(struct task_struct
*task
)
510 if (list_empty(&ftrace_pids
))
513 return test_tsk_trace_trace(task
);
516 static inline int ftrace_trace_task(struct task_struct
*task
)
523 * struct trace_parser - servers for reading the user input separated by spaces
524 * @cont: set if the input is not complete - no final space char was found
525 * @buffer: holds the parsed user input
526 * @idx: user input length
529 struct trace_parser
{
536 static inline bool trace_parser_loaded(struct trace_parser
*parser
)
538 return (parser
->idx
!= 0);
541 static inline bool trace_parser_cont(struct trace_parser
*parser
)
546 static inline void trace_parser_clear(struct trace_parser
*parser
)
548 parser
->cont
= false;
552 extern int trace_parser_get_init(struct trace_parser
*parser
, int size
);
553 extern void trace_parser_put(struct trace_parser
*parser
);
554 extern int trace_get_user(struct trace_parser
*parser
, const char __user
*ubuf
,
555 size_t cnt
, loff_t
*ppos
);
558 * trace_iterator_flags is an enumeration that defines bit
559 * positions into trace_flags that controls the output.
561 * NOTE: These bits must match the trace_options array in
564 enum trace_iterator_flags
{
565 TRACE_ITER_PRINT_PARENT
= 0x01,
566 TRACE_ITER_SYM_OFFSET
= 0x02,
567 TRACE_ITER_SYM_ADDR
= 0x04,
568 TRACE_ITER_VERBOSE
= 0x08,
569 TRACE_ITER_RAW
= 0x10,
570 TRACE_ITER_HEX
= 0x20,
571 TRACE_ITER_BIN
= 0x40,
572 TRACE_ITER_BLOCK
= 0x80,
573 TRACE_ITER_STACKTRACE
= 0x100,
574 TRACE_ITER_PRINTK
= 0x200,
575 TRACE_ITER_PREEMPTONLY
= 0x400,
576 TRACE_ITER_BRANCH
= 0x800,
577 TRACE_ITER_ANNOTATE
= 0x1000,
578 TRACE_ITER_USERSTACKTRACE
= 0x2000,
579 TRACE_ITER_SYM_USEROBJ
= 0x4000,
580 TRACE_ITER_PRINTK_MSGONLY
= 0x8000,
581 TRACE_ITER_CONTEXT_INFO
= 0x10000, /* Print pid/cpu/time */
582 TRACE_ITER_LATENCY_FMT
= 0x20000,
583 TRACE_ITER_SLEEP_TIME
= 0x40000,
584 TRACE_ITER_GRAPH_TIME
= 0x80000,
585 TRACE_ITER_RECORD_CMD
= 0x100000,
589 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
590 * control the output of kernel symbols.
592 #define TRACE_ITER_SYM_MASK \
593 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
595 extern struct tracer nop_trace
;
597 #ifdef CONFIG_BRANCH_TRACER
598 extern int enable_branch_tracing(struct trace_array
*tr
);
599 extern void disable_branch_tracing(void);
600 static inline int trace_branch_enable(struct trace_array
*tr
)
602 if (trace_flags
& TRACE_ITER_BRANCH
)
603 return enable_branch_tracing(tr
);
606 static inline void trace_branch_disable(void)
608 /* due to races, always disable */
609 disable_branch_tracing();
612 static inline int trace_branch_enable(struct trace_array
*tr
)
616 static inline void trace_branch_disable(void)
619 #endif /* CONFIG_BRANCH_TRACER */
621 /* set ring buffers to default size if not already done so */
622 int tracing_update_buffers(void);
624 /* trace event type bit fields, not numeric */
626 TRACE_EVENT_TYPE_PRINTF
= 1,
627 TRACE_EVENT_TYPE_RAW
= 2,
630 struct ftrace_event_field
{
631 struct list_head link
;
640 struct event_filter
{
642 struct filter_pred
**preds
;
646 struct event_subsystem
{
647 struct list_head list
;
649 struct dentry
*entry
;
650 struct event_filter
*filter
;
657 typedef int (*filter_pred_fn_t
) (struct filter_pred
*pred
, void *event
,
660 typedef int (*regex_match_func
)(char *str
, struct regex
*r
, int len
);
670 char pattern
[MAX_FILTER_STR_VAL
];
673 regex_match_func match
;
687 extern struct list_head ftrace_common_fields
;
689 extern enum regex_type
690 filter_parse_regex(char *buff
, int len
, char **search
, int *not);
691 extern void print_event_filter(struct ftrace_event_call
*call
,
692 struct trace_seq
*s
);
693 extern int apply_event_filter(struct ftrace_event_call
*call
,
694 char *filter_string
);
695 extern int apply_subsystem_event_filter(struct event_subsystem
*system
,
696 char *filter_string
);
697 extern void print_subsystem_event_filter(struct event_subsystem
*system
,
698 struct trace_seq
*s
);
699 extern int filter_assign_type(const char *type
);
702 trace_get_fields(struct ftrace_event_call
*event_call
);
705 filter_check_discard(struct ftrace_event_call
*call
, void *rec
,
706 struct ring_buffer
*buffer
,
707 struct ring_buffer_event
*event
)
709 if (unlikely(call
->flags
& TRACE_EVENT_FL_FILTERED
) &&
710 !filter_match_preds(call
->filter
, rec
)) {
711 ring_buffer_discard_commit(buffer
, event
);
718 extern void trace_event_enable_cmd_record(bool enable
);
720 extern struct mutex event_mutex
;
721 extern struct list_head ftrace_events
;
723 extern const char *__start___trace_bprintk_fmt
[];
724 extern const char *__stop___trace_bprintk_fmt
[];
727 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
728 extern struct ftrace_event_call \
729 __attribute__((__aligned__(4))) event_##call;
730 #undef FTRACE_ENTRY_DUP
731 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
732 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
733 #include "trace_entries.h"
735 #endif /* _LINUX_KERNEL_TRACE_H */