tracing/fastboot: add a script to visualize the kernel boot process / time
[linux-2.6-block.git] / kernel / trace / trace.h
CommitLineData
bc0c38d1
SR
1#ifndef _LINUX_KERNEL_TRACE_H
2#define _LINUX_KERNEL_TRACE_H
3
4#include <linux/fs.h>
5#include <asm/atomic.h>
6#include <linux/sched.h>
7#include <linux/clocksource.h>
bd8ac686 8#include <linux/mmiotrace.h>
bc0c38d1 9
72829bc3
TG
10enum trace_type {
11 __TRACE_FIRST_TYPE = 0,
12
13 TRACE_FN,
14 TRACE_CTX,
15 TRACE_WAKE,
dd0e545f 16 TRACE_CONT,
72829bc3 17 TRACE_STACK,
dd0e545f 18 TRACE_PRINT,
72829bc3 19 TRACE_SPECIAL,
bd8ac686
PP
20 TRACE_MMIO_RW,
21 TRACE_MMIO_MAP,
72829bc3
TG
22
23 __TRACE_LAST_TYPE
24};
25
bc0c38d1
SR
26/*
27 * Function trace entry - function address and parent function addres:
28 */
29struct ftrace_entry {
30 unsigned long ip;
31 unsigned long parent_ip;
32};
33
34/*
35 * Context switch trace entry - which task (and prio) we switched from/to:
36 */
37struct 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;
bac524d3 43 unsigned char next_state;
80b5e940 44 unsigned int next_cpu;
bc0c38d1
SR
45};
46
f0a920d5
IM
47/*
48 * Special (free-form) trace entry:
49 */
50struct special_entry {
51 unsigned long arg1;
52 unsigned long arg2;
53 unsigned long arg3;
54};
55
86387f7e
IM
56/*
57 * Stack-trace entry:
58 */
59
74f4e369 60#define FTRACE_STACK_ENTRIES 8
86387f7e
IM
61
62struct stack_entry {
63 unsigned long caller[FTRACE_STACK_ENTRIES];
64};
65
dd0e545f
SR
66/*
67 * ftrace_printk entry:
68 */
69struct print_entry {
70 unsigned long ip;
71 char buf[];
72};
73
fc5e27ae
PP
74/*
75 * trace_flag_type is an enumeration that holds different
76 * states when a trace occurs. These are:
77 * IRQS_OFF - interrupts were disabled
78 * NEED_RESCED - reschedule is requested
79 * HARDIRQ - inside an interrupt handler
80 * SOFTIRQ - inside a softirq handler
81 * CONT - multiple entries hold the trace item
82 */
83enum trace_flag_type {
84 TRACE_FLAG_IRQS_OFF = 0x01,
85 TRACE_FLAG_NEED_RESCHED = 0x02,
86 TRACE_FLAG_HARDIRQ = 0x04,
87 TRACE_FLAG_SOFTIRQ = 0x08,
88 TRACE_FLAG_CONT = 0x10,
89};
90
bc0c38d1 91/*
2e2ca155 92 * The trace field - the most basic unit of tracing. This is what
bc0c38d1
SR
93 * is printed in the end as a single line in the trace output, such as:
94 *
95 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
96 */
2e2ca155 97struct trace_field {
bc0c38d1
SR
98 char cpu;
99 char flags;
100 char preempt_count;
101 int pid;
102 cycle_t t;
bc0c38d1
SR
103 union {
104 struct ftrace_entry fn;
105 struct ctx_switch_entry ctx;
f0a920d5 106 struct special_entry special;
86387f7e 107 struct stack_entry stack;
dd0e545f 108 struct print_entry print;
bd8ac686
PP
109 struct mmiotrace_rw mmiorw;
110 struct mmiotrace_map mmiomap;
bc0c38d1
SR
111 };
112};
113
2e2ca155
SR
114struct trace_field_cont {
115 char buf[sizeof(struct trace_field)];
116};
117
118struct trace_entry {
119 char type;
120 union {
121 struct trace_field field;
122 struct trace_field_cont cont;
123 };
124};
125
bc0c38d1 126#define TRACE_ENTRY_SIZE sizeof(struct trace_entry)
5bf9a1ee
PP
127#define TRACE_BUF_SIZE 1024
128#define TRACE_PRINT_BUF_SIZE \
129 (sizeof(struct trace_field) - offsetof(struct trace_field, print.buf))
130#define TRACE_CONT_BUF_SIZE sizeof(struct trace_field)
bc0c38d1
SR
131
132/*
133 * The CPU trace array - it consists of thousands of trace entries
134 * plus some other descriptor data: (for example which task started
135 * the trace, etc.)
136 */
137struct trace_array_cpu {
4c11d7ae 138 struct list_head trace_pages;
bc0c38d1 139 atomic_t disabled;
92205c23 140 raw_spinlock_t lock;
d4c5a2f5 141 struct lock_class_key lock_key;
4e3c3333 142
c7aafc54 143 /* these fields get copied into max-trace: */
93a588f4
SR
144 unsigned trace_head_idx;
145 unsigned trace_tail_idx;
146 void *trace_head; /* producer */
147 void *trace_tail; /* consumer */
c7aafc54 148 unsigned long trace_idx;
53d0aa77 149 unsigned long overrun;
bc0c38d1
SR
150 unsigned long saved_latency;
151 unsigned long critical_start;
152 unsigned long critical_end;
153 unsigned long critical_sequence;
154 unsigned long nice;
155 unsigned long policy;
156 unsigned long rt_priority;
157 cycle_t preempt_timestamp;
158 pid_t pid;
159 uid_t uid;
160 char comm[TASK_COMM_LEN];
161};
162
163struct trace_iterator;
164
165/*
166 * The trace array - an array of per-CPU trace arrays. This is the
167 * highest level data structure that individual tracers deal with.
168 * They have on/off state as well:
169 */
170struct trace_array {
171 unsigned long entries;
172 long ctrl;
173 int cpu;
174 cycle_t time_start;
b3806b43 175 struct task_struct *waiter;
bc0c38d1
SR
176 struct trace_array_cpu *data[NR_CPUS];
177};
178
179/*
180 * A specific tracer, represented by methods that operate on a trace array:
181 */
182struct tracer {
183 const char *name;
184 void (*init)(struct trace_array *tr);
185 void (*reset)(struct trace_array *tr);
186 void (*open)(struct trace_iterator *iter);
107bad8b 187 void (*pipe_open)(struct trace_iterator *iter);
bc0c38d1
SR
188 void (*close)(struct trace_iterator *iter);
189 void (*start)(struct trace_iterator *iter);
190 void (*stop)(struct trace_iterator *iter);
107bad8b
SR
191 ssize_t (*read)(struct trace_iterator *iter,
192 struct file *filp, char __user *ubuf,
193 size_t cnt, loff_t *ppos);
bc0c38d1 194 void (*ctrl_update)(struct trace_array *tr);
60a11774
SR
195#ifdef CONFIG_FTRACE_STARTUP_TEST
196 int (*selftest)(struct tracer *trace,
197 struct trace_array *tr);
198#endif
72829bc3 199 int (*print_line)(struct trace_iterator *iter);
bc0c38d1
SR
200 struct tracer *next;
201 int print_max;
202};
203
214023c3
SR
204struct trace_seq {
205 unsigned char buffer[PAGE_SIZE];
206 unsigned int len;
6c6c2796 207 unsigned int readpos;
214023c3
SR
208};
209
bc0c38d1
SR
210/*
211 * Trace iterator - used by printout routines who present trace
212 * results to users and which routines might sleep, etc:
213 */
214struct trace_iterator {
215 struct trace_array *tr;
216 struct tracer *trace;
107bad8b 217 void *private;
53d0aa77
SR
218 long last_overrun[NR_CPUS];
219 long overrun[NR_CPUS];
4e3c3333 220
53d0aa77
SR
221 /* The below is zeroed out in pipe_read */
222 struct trace_seq seq;
bc0c38d1 223 struct trace_entry *ent;
4e3c3333
IM
224 int cpu;
225
226 struct trace_entry *prev_ent;
227 int prev_cpu;
228
bc0c38d1
SR
229 unsigned long iter_flags;
230 loff_t pos;
231 unsigned long next_idx[NR_CPUS];
4c11d7ae
SR
232 struct list_head *next_page[NR_CPUS];
233 unsigned next_page_idx[NR_CPUS];
234 long idx;
bc0c38d1
SR
235};
236
45dcd8b8 237void trace_wake_up(void);
e309b41d 238void tracing_reset(struct trace_array_cpu *data);
bc0c38d1
SR
239int tracing_open_generic(struct inode *inode, struct file *filp);
240struct dentry *tracing_init_dentry(void);
d618b3e6
IM
241void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
242
45dcd8b8
PP
243struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
244 struct trace_array_cpu *data);
245void tracing_generic_entry_update(struct trace_entry *entry,
246 unsigned long flags);
247
bc0c38d1
SR
248void ftrace(struct trace_array *tr,
249 struct trace_array_cpu *data,
250 unsigned long ip,
251 unsigned long parent_ip,
252 unsigned long flags);
253void tracing_sched_switch_trace(struct trace_array *tr,
254 struct trace_array_cpu *data,
255 struct task_struct *prev,
256 struct task_struct *next,
257 unsigned long flags);
258void tracing_record_cmdline(struct task_struct *tsk);
57422797
IM
259
260void tracing_sched_wakeup_trace(struct trace_array *tr,
261 struct trace_array_cpu *data,
262 struct task_struct *wakee,
263 struct task_struct *cur,
264 unsigned long flags);
f0a920d5
IM
265void trace_special(struct trace_array *tr,
266 struct trace_array_cpu *data,
267 unsigned long arg1,
268 unsigned long arg2,
269 unsigned long arg3);
6fb44b71
SR
270void trace_function(struct trace_array *tr,
271 struct trace_array_cpu *data,
272 unsigned long ip,
273 unsigned long parent_ip,
274 unsigned long flags);
bc0c38d1 275
41bc8144
SR
276void tracing_start_cmdline_record(void);
277void tracing_stop_cmdline_record(void);
bc0c38d1
SR
278int register_tracer(struct tracer *type);
279void unregister_tracer(struct tracer *type);
280
281extern unsigned long nsecs_to_usecs(unsigned long nsecs);
282
283extern unsigned long tracing_max_latency;
284extern unsigned long tracing_thresh;
285
286void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
287void update_max_tr_single(struct trace_array *tr,
288 struct task_struct *tsk, int cpu);
289
e309b41d 290extern cycle_t ftrace_now(int cpu);
bc0c38d1 291
001b6767
SR
292#ifdef CONFIG_FTRACE
293void tracing_start_function_trace(void);
294void tracing_stop_function_trace(void);
295#else
296# define tracing_start_function_trace() do { } while (0)
297# define tracing_stop_function_trace() do { } while (0)
298#endif
299
bc0c38d1
SR
300#ifdef CONFIG_CONTEXT_SWITCH_TRACER
301typedef void
302(*tracer_switch_func_t)(void *private,
5b82a1b0 303 void *__rq,
bc0c38d1
SR
304 struct task_struct *prev,
305 struct task_struct *next);
306
307struct tracer_switch_ops {
308 tracer_switch_func_t func;
309 void *private;
310 struct tracer_switch_ops *next;
311};
312
bc0c38d1
SR
313#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
314
315#ifdef CONFIG_DYNAMIC_FTRACE
316extern unsigned long ftrace_update_tot_cnt;
d05cdb25
SR
317#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
318extern int DYN_FTRACE_TEST_NAME(void);
bc0c38d1
SR
319#endif
320
60a11774 321#ifdef CONFIG_FTRACE_STARTUP_TEST
60a11774
SR
322extern int trace_selftest_startup_function(struct tracer *trace,
323 struct trace_array *tr);
60a11774
SR
324extern int trace_selftest_startup_irqsoff(struct tracer *trace,
325 struct trace_array *tr);
60a11774
SR
326extern int trace_selftest_startup_preemptoff(struct tracer *trace,
327 struct trace_array *tr);
60a11774
SR
328extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
329 struct trace_array *tr);
60a11774
SR
330extern int trace_selftest_startup_wakeup(struct tracer *trace,
331 struct trace_array *tr);
fb1b6d8b
SN
332extern int trace_selftest_startup_nop(struct tracer *trace,
333 struct trace_array *tr);
60a11774
SR
334extern int trace_selftest_startup_sched_switch(struct tracer *trace,
335 struct trace_array *tr);
a6dd24f8
IM
336extern int trace_selftest_startup_sysprof(struct tracer *trace,
337 struct trace_array *tr);
60a11774
SR
338#endif /* CONFIG_FTRACE_STARTUP_TEST */
339
c7aafc54 340extern void *head_page(struct trace_array_cpu *data);
72829bc3 341extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
fc5e27ae
PP
342extern void trace_seq_print_cont(struct trace_seq *s,
343 struct trace_iterator *iter);
6c6c2796
PP
344extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
345 size_t cnt);
72829bc3 346extern long ns2usecs(cycle_t nsec);
801fe400 347extern int trace_vprintk(unsigned long ip, const char *fmt, va_list args);
c7aafc54 348
4e655519
IM
349extern unsigned long trace_flags;
350
4fcdae83
SR
351/*
352 * trace_iterator_flags is an enumeration that defines bit
353 * positions into trace_flags that controls the output.
354 *
355 * NOTE: These bits must match the trace_options array in
356 * trace.c.
357 */
4e655519
IM
358enum trace_iterator_flags {
359 TRACE_ITER_PRINT_PARENT = 0x01,
360 TRACE_ITER_SYM_OFFSET = 0x02,
361 TRACE_ITER_SYM_ADDR = 0x04,
362 TRACE_ITER_VERBOSE = 0x08,
363 TRACE_ITER_RAW = 0x10,
364 TRACE_ITER_HEX = 0x20,
365 TRACE_ITER_BIN = 0x40,
366 TRACE_ITER_BLOCK = 0x80,
367 TRACE_ITER_STACKTRACE = 0x100,
4ac3ba41 368 TRACE_ITER_SCHED_TREE = 0x200,
f09ce573 369 TRACE_ITER_PRINTK = 0x400,
4e655519
IM
370};
371
43a15386
FW
372extern struct tracer nop_trace;
373
bc0c38d1 374#endif /* _LINUX_KERNEL_TRACE_H */