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,
27 * Function trace entry - function address and parent function addres:
31 unsigned long parent_ip;
35 * Context switch trace entry - which task (and prio) we switched from/to:
37 struct ctx_switch_entry {
38 unsigned int prev_pid;
39 unsigned char prev_prio;
40 unsigned char prev_state;
41 unsigned int next_pid;
42 unsigned char next_prio;
43 unsigned char next_state;
44 unsigned int next_cpu;
48 * Special (free-form) trace entry:
50 struct special_entry {
60 #define FTRACE_STACK_ENTRIES 8
63 unsigned long caller[FTRACE_STACK_ENTRIES];
67 * ftrace_printk entry:
75 * The trace field - the most basic unit of tracing. This is what
76 * is printed in the end as a single line in the trace output, such as:
78 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
87 struct ftrace_entry fn;
88 struct ctx_switch_entry ctx;
89 struct special_entry special;
90 struct stack_entry stack;
91 struct print_entry print;
92 struct mmiotrace_rw mmiorw;
93 struct mmiotrace_map mmiomap;
97 struct trace_field_cont {
98 char buf[sizeof(struct trace_field)];
104 struct trace_field field;
105 struct trace_field_cont cont;
109 #define TRACE_ENTRY_SIZE sizeof(struct trace_entry)
112 * The CPU trace array - it consists of thousands of trace entries
113 * plus some other descriptor data: (for example which task started
116 struct trace_array_cpu {
117 struct list_head trace_pages;
120 struct lock_class_key lock_key;
122 /* these fields get copied into max-trace: */
123 unsigned trace_head_idx;
124 unsigned trace_tail_idx;
125 void *trace_head; /* producer */
126 void *trace_tail; /* consumer */
127 unsigned long trace_idx;
128 unsigned long overrun;
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 cycle_t preempt_timestamp;
139 char comm[TASK_COMM_LEN];
142 struct trace_iterator;
145 * The trace array - an array of per-CPU trace arrays. This is the
146 * highest level data structure that individual tracers deal with.
147 * They have on/off state as well:
150 unsigned long entries;
154 struct task_struct *waiter;
155 struct trace_array_cpu *data[NR_CPUS];
159 * A specific tracer, represented by methods that operate on a trace array:
163 void (*init)(struct trace_array *tr);
164 void (*reset)(struct trace_array *tr);
165 void (*open)(struct trace_iterator *iter);
166 void (*pipe_open)(struct trace_iterator *iter);
167 void (*close)(struct trace_iterator *iter);
168 void (*start)(struct trace_iterator *iter);
169 void (*stop)(struct trace_iterator *iter);
170 ssize_t (*read)(struct trace_iterator *iter,
171 struct file *filp, char __user *ubuf,
172 size_t cnt, loff_t *ppos);
173 void (*ctrl_update)(struct trace_array *tr);
174 #ifdef CONFIG_FTRACE_STARTUP_TEST
175 int (*selftest)(struct tracer *trace,
176 struct trace_array *tr);
178 int (*print_line)(struct trace_iterator *iter);
184 unsigned char buffer[PAGE_SIZE];
186 unsigned int readpos;
190 * Trace iterator - used by printout routines who present trace
191 * results to users and which routines might sleep, etc:
193 struct trace_iterator {
194 struct trace_array *tr;
195 struct tracer *trace;
197 long last_overrun[NR_CPUS];
198 long overrun[NR_CPUS];
200 /* The below is zeroed out in pipe_read */
201 struct trace_seq seq;
202 struct trace_entry *ent;
205 struct trace_entry *prev_ent;
208 unsigned long iter_flags;
210 unsigned long next_idx[NR_CPUS];
211 struct list_head *next_page[NR_CPUS];
212 unsigned next_page_idx[NR_CPUS];
216 void tracing_reset(struct trace_array_cpu *data);
217 int tracing_open_generic(struct inode *inode, struct file *filp);
218 struct dentry *tracing_init_dentry(void);
219 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
221 void ftrace(struct trace_array *tr,
222 struct trace_array_cpu *data,
224 unsigned long parent_ip,
225 unsigned long flags);
226 void tracing_sched_switch_trace(struct trace_array *tr,
227 struct trace_array_cpu *data,
228 struct task_struct *prev,
229 struct task_struct *next,
230 unsigned long flags);
231 void tracing_record_cmdline(struct task_struct *tsk);
233 void tracing_sched_wakeup_trace(struct trace_array *tr,
234 struct trace_array_cpu *data,
235 struct task_struct *wakee,
236 struct task_struct *cur,
237 unsigned long flags);
238 void trace_special(struct trace_array *tr,
239 struct trace_array_cpu *data,
243 void trace_function(struct trace_array *tr,
244 struct trace_array_cpu *data,
246 unsigned long parent_ip,
247 unsigned long flags);
249 void tracing_start_cmdline_record(void);
250 void tracing_stop_cmdline_record(void);
251 int register_tracer(struct tracer *type);
252 void unregister_tracer(struct tracer *type);
254 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
256 extern unsigned long tracing_max_latency;
257 extern unsigned long tracing_thresh;
259 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
260 void update_max_tr_single(struct trace_array *tr,
261 struct task_struct *tsk, int cpu);
263 extern cycle_t ftrace_now(int cpu);
266 void tracing_start_function_trace(void);
267 void tracing_stop_function_trace(void);
269 # define tracing_start_function_trace() do { } while (0)
270 # define tracing_stop_function_trace() do { } while (0)
273 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
275 (*tracer_switch_func_t)(void *private,
277 struct task_struct *prev,
278 struct task_struct *next);
280 struct tracer_switch_ops {
281 tracer_switch_func_t func;
283 struct tracer_switch_ops *next;
286 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
288 #ifdef CONFIG_DYNAMIC_FTRACE
289 extern unsigned long ftrace_update_tot_cnt;
290 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
291 extern int DYN_FTRACE_TEST_NAME(void);
294 #ifdef CONFIG_MMIOTRACE
295 extern void __trace_mmiotrace_rw(struct trace_array *tr,
296 struct trace_array_cpu *data,
297 struct mmiotrace_rw *rw);
298 extern void __trace_mmiotrace_map(struct trace_array *tr,
299 struct trace_array_cpu *data,
300 struct mmiotrace_map *map);
303 #ifdef CONFIG_FTRACE_STARTUP_TEST
305 extern int trace_selftest_startup_function(struct tracer *trace,
306 struct trace_array *tr);
308 #ifdef CONFIG_IRQSOFF_TRACER
309 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
310 struct trace_array *tr);
312 #ifdef CONFIG_PREEMPT_TRACER
313 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
314 struct trace_array *tr);
316 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
317 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
318 struct trace_array *tr);
320 #ifdef CONFIG_SCHED_TRACER
321 extern int trace_selftest_startup_wakeup(struct tracer *trace,
322 struct trace_array *tr);
324 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
325 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
326 struct trace_array *tr);
328 #ifdef CONFIG_SYSPROF_TRACER
329 extern int trace_selftest_startup_sysprof(struct tracer *trace,
330 struct trace_array *tr);
332 #endif /* CONFIG_FTRACE_STARTUP_TEST */
334 extern void *head_page(struct trace_array_cpu *data);
335 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
336 extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
338 extern long ns2usecs(cycle_t nsec);
340 extern unsigned long trace_flags;
343 * trace_iterator_flags is an enumeration that defines bit
344 * positions into trace_flags that controls the output.
346 * NOTE: These bits must match the trace_options array in
349 enum trace_iterator_flags {
350 TRACE_ITER_PRINT_PARENT = 0x01,
351 TRACE_ITER_SYM_OFFSET = 0x02,
352 TRACE_ITER_SYM_ADDR = 0x04,
353 TRACE_ITER_VERBOSE = 0x08,
354 TRACE_ITER_RAW = 0x10,
355 TRACE_ITER_HEX = 0x20,
356 TRACE_ITER_BIN = 0x40,
357 TRACE_ITER_BLOCK = 0x80,
358 TRACE_ITER_STACKTRACE = 0x100,
359 TRACE_ITER_SCHED_TREE = 0x200,
360 TRACE_ITER_PRINTK = 0x400,
363 #endif /* _LINUX_KERNEL_TRACE_H */