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/mmiotrace.h>
11 __TRACE_FIRST_TYPE = 0,
25 * Function trace entry - function address and parent function addres:
29 unsigned long parent_ip;
33 * Context switch trace entry - which task (and prio) we switched from/to:
35 struct ctx_switch_entry {
36 unsigned int prev_pid;
37 unsigned char prev_prio;
38 unsigned char prev_state;
39 unsigned int next_pid;
40 unsigned char next_prio;
41 unsigned char next_state;
45 * Special (free-form) trace entry:
47 struct special_entry {
57 #define FTRACE_STACK_ENTRIES 8
60 unsigned long caller[FTRACE_STACK_ENTRIES];
64 * The trace entry - the most basic unit of tracing. This is what
65 * is printed in the end as a single line in the trace output, such as:
67 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
77 struct ftrace_entry fn;
78 struct ctx_switch_entry ctx;
79 struct special_entry special;
80 struct stack_entry stack;
81 struct mmiotrace_rw mmiorw;
82 struct mmiotrace_map mmiomap;
86 #define TRACE_ENTRY_SIZE sizeof(struct trace_entry)
89 * The CPU trace array - it consists of thousands of trace entries
90 * plus some other descriptor data: (for example which task started
93 struct trace_array_cpu {
94 struct list_head trace_pages;
97 struct lock_class_key lock_key;
99 /* these fields get copied into max-trace: */
100 unsigned trace_head_idx;
101 unsigned trace_tail_idx;
102 void *trace_head; /* producer */
103 void *trace_tail; /* consumer */
104 unsigned long trace_idx;
105 unsigned long overrun;
106 unsigned long saved_latency;
107 unsigned long critical_start;
108 unsigned long critical_end;
109 unsigned long critical_sequence;
111 unsigned long policy;
112 unsigned long rt_priority;
113 cycle_t preempt_timestamp;
116 char comm[TASK_COMM_LEN];
119 struct trace_iterator;
122 * The trace array - an array of per-CPU trace arrays. This is the
123 * highest level data structure that individual tracers deal with.
124 * They have on/off state as well:
127 unsigned long entries;
131 struct task_struct *waiter;
132 struct trace_array_cpu *data[NR_CPUS];
136 * A specific tracer, represented by methods that operate on a trace array:
140 void (*init)(struct trace_array *tr);
141 void (*reset)(struct trace_array *tr);
142 void (*open)(struct trace_iterator *iter);
143 void (*pipe_open)(struct trace_iterator *iter);
144 void (*close)(struct trace_iterator *iter);
145 void (*start)(struct trace_iterator *iter);
146 void (*stop)(struct trace_iterator *iter);
147 ssize_t (*read)(struct trace_iterator *iter,
148 struct file *filp, char __user *ubuf,
149 size_t cnt, loff_t *ppos);
150 void (*ctrl_update)(struct trace_array *tr);
151 #ifdef CONFIG_FTRACE_STARTUP_TEST
152 int (*selftest)(struct tracer *trace,
153 struct trace_array *tr);
155 int (*print_line)(struct trace_iterator *iter);
161 unsigned char buffer[PAGE_SIZE];
163 unsigned int readpos;
167 * Trace iterator - used by printout routines who present trace
168 * results to users and which routines might sleep, etc:
170 struct trace_iterator {
171 struct trace_array *tr;
172 struct tracer *trace;
174 long last_overrun[NR_CPUS];
175 long overrun[NR_CPUS];
177 /* The below is zeroed out in pipe_read */
178 struct trace_seq seq;
179 struct trace_entry *ent;
182 struct trace_entry *prev_ent;
185 unsigned long iter_flags;
187 unsigned long next_idx[NR_CPUS];
188 struct list_head *next_page[NR_CPUS];
189 unsigned next_page_idx[NR_CPUS];
193 void tracing_reset(struct trace_array_cpu *data);
194 int tracing_open_generic(struct inode *inode, struct file *filp);
195 struct dentry *tracing_init_dentry(void);
196 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
198 void ftrace(struct trace_array *tr,
199 struct trace_array_cpu *data,
201 unsigned long parent_ip,
202 unsigned long flags);
203 void tracing_sched_switch_trace(struct trace_array *tr,
204 struct trace_array_cpu *data,
205 struct task_struct *prev,
206 struct task_struct *next,
207 unsigned long flags);
208 void tracing_record_cmdline(struct task_struct *tsk);
210 void tracing_sched_wakeup_trace(struct trace_array *tr,
211 struct trace_array_cpu *data,
212 struct task_struct *wakee,
213 struct task_struct *cur,
214 unsigned long flags);
215 void trace_special(struct trace_array *tr,
216 struct trace_array_cpu *data,
220 void trace_function(struct trace_array *tr,
221 struct trace_array_cpu *data,
223 unsigned long parent_ip,
224 unsigned long flags);
226 void tracing_start_function_trace(void);
227 void tracing_stop_function_trace(void);
228 void tracing_start_cmdline_record(void);
229 void tracing_stop_cmdline_record(void);
230 int register_tracer(struct tracer *type);
231 void unregister_tracer(struct tracer *type);
233 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
235 extern unsigned long tracing_max_latency;
236 extern unsigned long tracing_thresh;
238 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
239 void update_max_tr_single(struct trace_array *tr,
240 struct task_struct *tsk, int cpu);
242 extern cycle_t ftrace_now(int cpu);
244 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
246 (*tracer_switch_func_t)(void *private,
248 struct task_struct *prev,
249 struct task_struct *next);
251 struct tracer_switch_ops {
252 tracer_switch_func_t func;
254 struct tracer_switch_ops *next;
257 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
259 #ifdef CONFIG_DYNAMIC_FTRACE
260 extern unsigned long ftrace_update_tot_cnt;
261 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
262 extern int DYN_FTRACE_TEST_NAME(void);
265 #ifdef CONFIG_MMIOTRACE
266 extern void __trace_mmiotrace_rw(struct trace_array *tr,
267 struct trace_array_cpu *data,
268 struct mmiotrace_rw *rw);
269 extern void __trace_mmiotrace_map(struct trace_array *tr,
270 struct trace_array_cpu *data,
271 struct mmiotrace_map *map);
274 #ifdef CONFIG_FTRACE_STARTUP_TEST
276 extern int trace_selftest_startup_function(struct tracer *trace,
277 struct trace_array *tr);
279 #ifdef CONFIG_IRQSOFF_TRACER
280 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
281 struct trace_array *tr);
283 #ifdef CONFIG_PREEMPT_TRACER
284 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
285 struct trace_array *tr);
287 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
288 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
289 struct trace_array *tr);
291 #ifdef CONFIG_SCHED_TRACER
292 extern int trace_selftest_startup_wakeup(struct tracer *trace,
293 struct trace_array *tr);
295 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
296 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
297 struct trace_array *tr);
299 #ifdef CONFIG_SYSPROF_TRACER
300 extern int trace_selftest_startup_sysprof(struct tracer *trace,
301 struct trace_array *tr);
303 #endif /* CONFIG_FTRACE_STARTUP_TEST */
305 extern void *head_page(struct trace_array_cpu *data);
306 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
307 extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
309 extern long ns2usecs(cycle_t nsec);
311 extern unsigned long trace_flags;
314 * trace_iterator_flags is an enumeration that defines bit
315 * positions into trace_flags that controls the output.
317 * NOTE: These bits must match the trace_options array in
320 enum trace_iterator_flags {
321 TRACE_ITER_PRINT_PARENT = 0x01,
322 TRACE_ITER_SYM_OFFSET = 0x02,
323 TRACE_ITER_SYM_ADDR = 0x04,
324 TRACE_ITER_VERBOSE = 0x08,
325 TRACE_ITER_RAW = 0x10,
326 TRACE_ITER_HEX = 0x20,
327 TRACE_ITER_BIN = 0x40,
328 TRACE_ITER_BLOCK = 0x80,
329 TRACE_ITER_STACKTRACE = 0x100,
330 TRACE_ITER_SCHED_TREE = 0x200,
333 #endif /* _LINUX_KERNEL_TRACE_H */