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 saved_latency;
101 unsigned long critical_start;
102 unsigned long critical_end;
103 unsigned long critical_sequence;
105 unsigned long policy;
106 unsigned long rt_priority;
107 cycle_t preempt_timestamp;
110 char comm[TASK_COMM_LEN];
113 struct trace_iterator;
116 * The trace array - an array of per-CPU trace arrays. This is the
117 * highest level data structure that individual tracers deal with.
118 * They have on/off state as well:
121 unsigned long entries;
125 struct task_struct *waiter;
126 struct trace_array_cpu *data[NR_CPUS];
130 * A specific tracer, represented by methods that operate on a trace array:
134 void (*init)(struct trace_array *tr);
135 void (*reset)(struct trace_array *tr);
136 void (*open)(struct trace_iterator *iter);
137 void (*close)(struct trace_iterator *iter);
138 void (*start)(struct trace_iterator *iter);
139 void (*stop)(struct trace_iterator *iter);
140 void (*ctrl_update)(struct trace_array *tr);
141 #ifdef CONFIG_FTRACE_STARTUP_TEST
142 int (*selftest)(struct tracer *trace,
143 struct trace_array *tr);
145 int (*print_line)(struct trace_iterator *iter);
151 unsigned char buffer[PAGE_SIZE];
156 * Trace iterator - used by printout routines who present trace
157 * results to users and which routines might sleep, etc:
159 struct trace_iterator {
160 struct trace_seq seq;
161 struct trace_array *tr;
162 struct tracer *trace;
164 struct trace_entry *ent;
167 struct trace_entry *prev_ent;
170 unsigned long iter_flags;
172 unsigned long next_idx[NR_CPUS];
173 struct list_head *next_page[NR_CPUS];
174 unsigned next_page_idx[NR_CPUS];
178 void tracing_reset(struct trace_array_cpu *data);
179 int tracing_open_generic(struct inode *inode, struct file *filp);
180 struct dentry *tracing_init_dentry(void);
181 void ftrace(struct trace_array *tr,
182 struct trace_array_cpu *data,
184 unsigned long parent_ip,
185 unsigned long flags);
186 void tracing_sched_switch_trace(struct trace_array *tr,
187 struct trace_array_cpu *data,
188 struct task_struct *prev,
189 struct task_struct *next,
190 unsigned long flags);
191 void tracing_record_cmdline(struct task_struct *tsk);
193 void tracing_sched_wakeup_trace(struct trace_array *tr,
194 struct trace_array_cpu *data,
195 struct task_struct *wakee,
196 struct task_struct *cur,
197 unsigned long flags);
198 void trace_special(struct trace_array *tr,
199 struct trace_array_cpu *data,
203 void trace_function(struct trace_array *tr,
204 struct trace_array_cpu *data,
206 unsigned long parent_ip,
207 unsigned long flags);
209 void tracing_start_function_trace(void);
210 void tracing_stop_function_trace(void);
211 int register_tracer(struct tracer *type);
212 void unregister_tracer(struct tracer *type);
214 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
216 extern unsigned long tracing_max_latency;
217 extern unsigned long tracing_thresh;
219 extern atomic_t trace_record_cmdline_enabled;
221 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
222 void update_max_tr_single(struct trace_array *tr,
223 struct task_struct *tsk, int cpu);
225 extern cycle_t ftrace_now(int cpu);
227 #ifdef CONFIG_SCHED_TRACER
229 wakeup_sched_switch(struct task_struct *prev, struct task_struct *next);
231 wakeup_sched_wakeup(struct task_struct *wakee, struct task_struct *curr);
234 wakeup_sched_switch(struct task_struct *prev, struct task_struct *next)
238 wakeup_sched_wakeup(struct task_struct *wakee, struct task_struct *curr)
243 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
245 (*tracer_switch_func_t)(void *private,
246 struct task_struct *prev,
247 struct task_struct *next);
249 struct tracer_switch_ops {
250 tracer_switch_func_t func;
252 struct tracer_switch_ops *next;
255 extern int register_tracer_switch(struct tracer_switch_ops *ops);
256 extern int unregister_tracer_switch(struct tracer_switch_ops *ops);
258 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
260 #ifdef CONFIG_DYNAMIC_FTRACE
261 extern unsigned long ftrace_update_tot_cnt;
262 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
263 extern int DYN_FTRACE_TEST_NAME(void);
266 #ifdef CONFIG_FTRACE_STARTUP_TEST
268 extern int trace_selftest_startup_function(struct tracer *trace,
269 struct trace_array *tr);
271 #ifdef CONFIG_IRQSOFF_TRACER
272 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
273 struct trace_array *tr);
275 #ifdef CONFIG_PREEMPT_TRACER
276 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
277 struct trace_array *tr);
279 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
280 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
281 struct trace_array *tr);
283 #ifdef CONFIG_SCHED_TRACER
284 extern int trace_selftest_startup_wakeup(struct tracer *trace,
285 struct trace_array *tr);
287 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
288 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
289 struct trace_array *tr);
291 #endif /* CONFIG_FTRACE_STARTUP_TEST */
293 extern void *head_page(struct trace_array_cpu *data);
294 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
295 extern long ns2usecs(cycle_t nsec);
297 extern unsigned long trace_flags;
300 * trace_iterator_flags is an enumeration that defines bit
301 * positions into trace_flags that controls the output.
303 * NOTE: These bits must match the trace_options array in
306 enum trace_iterator_flags {
307 TRACE_ITER_PRINT_PARENT = 0x01,
308 TRACE_ITER_SYM_OFFSET = 0x02,
309 TRACE_ITER_SYM_ADDR = 0x04,
310 TRACE_ITER_VERBOSE = 0x08,
311 TRACE_ITER_RAW = 0x10,
312 TRACE_ITER_HEX = 0x20,
313 TRACE_ITER_BIN = 0x40,
314 TRACE_ITER_BLOCK = 0x80,
315 TRACE_ITER_STACKTRACE = 0x100,
316 TRACE_ITER_SCHED_TREE = 0x200,
319 #endif /* _LINUX_KERNEL_TRACE_H */