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>
10 __TRACE_FIRST_TYPE = 0,
22 * Function trace entry - function address and parent function addres:
26 unsigned long parent_ip;
30 * Context switch trace entry - which task (and prio) we switched from/to:
32 struct ctx_switch_entry {
33 unsigned int prev_pid;
34 unsigned char prev_prio;
35 unsigned char prev_state;
36 unsigned int next_pid;
37 unsigned char next_prio;
38 unsigned char next_state;
42 * Special (free-form) trace entry:
44 struct special_entry {
54 #define FTRACE_STACK_ENTRIES 5
57 unsigned long caller[FTRACE_STACK_ENTRIES];
61 * The trace entry - the most basic unit of tracing. This is what
62 * is printed in the end as a single line in the trace output, such as:
64 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
74 struct ftrace_entry fn;
75 struct ctx_switch_entry ctx;
76 struct special_entry special;
77 struct stack_entry stack;
81 #define TRACE_ENTRY_SIZE sizeof(struct trace_entry)
84 * The CPU trace array - it consists of thousands of trace entries
85 * plus some other descriptor data: (for example which task started
88 struct trace_array_cpu {
89 struct list_head trace_pages;
92 struct lock_class_key lock_key;
94 /* these fields get copied into max-trace: */
95 unsigned trace_head_idx;
96 unsigned trace_tail_idx;
97 void *trace_head; /* producer */
98 void *trace_tail; /* consumer */
99 unsigned long trace_idx;
100 unsigned long overrun;
101 unsigned long saved_latency;
102 unsigned long critical_start;
103 unsigned long critical_end;
104 unsigned long critical_sequence;
106 unsigned long policy;
107 unsigned long rt_priority;
108 cycle_t preempt_timestamp;
111 char comm[TASK_COMM_LEN];
114 struct trace_iterator;
117 * The trace array - an array of per-CPU trace arrays. This is the
118 * highest level data structure that individual tracers deal with.
119 * They have on/off state as well:
122 unsigned long entries;
126 struct task_struct *waiter;
127 struct trace_array_cpu *data[NR_CPUS];
131 * A specific tracer, represented by methods that operate on a trace array:
135 void (*init)(struct trace_array *tr);
136 void (*reset)(struct trace_array *tr);
137 void (*open)(struct trace_iterator *iter);
138 void (*pipe_open)(struct trace_iterator *iter);
139 void (*close)(struct trace_iterator *iter);
140 void (*start)(struct trace_iterator *iter);
141 void (*stop)(struct trace_iterator *iter);
142 ssize_t (*read)(struct trace_iterator *iter,
143 struct file *filp, char __user *ubuf,
144 size_t cnt, loff_t *ppos);
145 void (*ctrl_update)(struct trace_array *tr);
146 #ifdef CONFIG_FTRACE_STARTUP_TEST
147 int (*selftest)(struct tracer *trace,
148 struct trace_array *tr);
150 int (*print_line)(struct trace_iterator *iter);
156 unsigned char buffer[PAGE_SIZE];
158 unsigned int readpos;
162 * Trace iterator - used by printout routines who present trace
163 * results to users and which routines might sleep, etc:
165 struct trace_iterator {
166 struct trace_array *tr;
167 struct tracer *trace;
169 long last_overrun[NR_CPUS];
170 long overrun[NR_CPUS];
172 /* The below is zeroed out in pipe_read */
173 struct trace_seq seq;
174 struct trace_entry *ent;
177 struct trace_entry *prev_ent;
180 unsigned long iter_flags;
182 unsigned long next_idx[NR_CPUS];
183 struct list_head *next_page[NR_CPUS];
184 unsigned next_page_idx[NR_CPUS];
188 void tracing_reset(struct trace_array_cpu *data);
189 int tracing_open_generic(struct inode *inode, struct file *filp);
190 struct dentry *tracing_init_dentry(void);
191 void ftrace(struct trace_array *tr,
192 struct trace_array_cpu *data,
194 unsigned long parent_ip,
195 unsigned long flags);
196 void tracing_sched_switch_trace(struct trace_array *tr,
197 struct trace_array_cpu *data,
198 struct task_struct *prev,
199 struct task_struct *next,
200 unsigned long flags);
201 void tracing_record_cmdline(struct task_struct *tsk);
203 void tracing_sched_wakeup_trace(struct trace_array *tr,
204 struct trace_array_cpu *data,
205 struct task_struct *wakee,
206 struct task_struct *cur,
207 unsigned long flags);
208 void trace_special(struct trace_array *tr,
209 struct trace_array_cpu *data,
213 void trace_function(struct trace_array *tr,
214 struct trace_array_cpu *data,
216 unsigned long parent_ip,
217 unsigned long flags);
219 void tracing_start_function_trace(void);
220 void tracing_stop_function_trace(void);
221 int register_tracer(struct tracer *type);
222 void unregister_tracer(struct tracer *type);
224 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
226 extern unsigned long tracing_max_latency;
227 extern unsigned long tracing_thresh;
229 extern atomic_t trace_record_cmdline_enabled;
231 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
232 void update_max_tr_single(struct trace_array *tr,
233 struct task_struct *tsk, int cpu);
235 extern cycle_t ftrace_now(int cpu);
237 #ifdef CONFIG_SCHED_TRACER
239 wakeup_sched_switch(struct task_struct *prev, struct task_struct *next);
241 wakeup_sched_wakeup(struct task_struct *wakee, struct task_struct *curr);
244 wakeup_sched_switch(struct task_struct *prev, struct task_struct *next)
248 wakeup_sched_wakeup(struct task_struct *wakee, struct task_struct *curr)
253 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
255 (*tracer_switch_func_t)(void *private,
256 struct task_struct *prev,
257 struct task_struct *next);
259 struct tracer_switch_ops {
260 tracer_switch_func_t func;
262 struct tracer_switch_ops *next;
265 extern int register_tracer_switch(struct tracer_switch_ops *ops);
266 extern int unregister_tracer_switch(struct tracer_switch_ops *ops);
268 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
270 #ifdef CONFIG_DYNAMIC_FTRACE
271 extern unsigned long ftrace_update_tot_cnt;
272 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
273 extern int DYN_FTRACE_TEST_NAME(void);
276 #ifdef CONFIG_FTRACE_STARTUP_TEST
278 extern int trace_selftest_startup_function(struct tracer *trace,
279 struct trace_array *tr);
281 #ifdef CONFIG_IRQSOFF_TRACER
282 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
283 struct trace_array *tr);
285 #ifdef CONFIG_PREEMPT_TRACER
286 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
287 struct trace_array *tr);
289 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
290 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
291 struct trace_array *tr);
293 #ifdef CONFIG_SCHED_TRACER
294 extern int trace_selftest_startup_wakeup(struct tracer *trace,
295 struct trace_array *tr);
297 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
298 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
299 struct trace_array *tr);
301 #endif /* CONFIG_FTRACE_STARTUP_TEST */
303 extern void *head_page(struct trace_array_cpu *data);
304 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
305 extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
307 extern long ns2usecs(cycle_t nsec);
309 extern unsigned long trace_flags;
312 * trace_iterator_flags is an enumeration that defines bit
313 * positions into trace_flags that controls the output.
315 * NOTE: These bits must match the trace_options array in
318 enum trace_iterator_flags {
319 TRACE_ITER_PRINT_PARENT = 0x01,
320 TRACE_ITER_SYM_OFFSET = 0x02,
321 TRACE_ITER_SYM_ADDR = 0x04,
322 TRACE_ITER_VERBOSE = 0x08,
323 TRACE_ITER_RAW = 0x10,
324 TRACE_ITER_HEX = 0x20,
325 TRACE_ITER_BIN = 0x40,
326 TRACE_ITER_BLOCK = 0x80,
327 TRACE_ITER_STACKTRACE = 0x100,
328 TRACE_ITER_SCHED_TREE = 0x200,
331 #endif /* _LINUX_KERNEL_TRACE_H */