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