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 * 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
83 enum 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,
92 * The trace field - the most basic unit of tracing. This is what
93 * is printed in the end as a single line in the trace output, such as:
95 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
104 struct ftrace_entry fn;
105 struct ctx_switch_entry ctx;
106 struct special_entry special;
107 struct stack_entry stack;
108 struct print_entry print;
109 struct mmiotrace_rw mmiorw;
110 struct mmiotrace_map mmiomap;
114 struct trace_field_cont {
115 char buf[sizeof(struct trace_field)];
121 struct trace_field field;
122 struct trace_field_cont cont;
126 #define TRACE_ENTRY_SIZE sizeof(struct trace_entry)
129 * The CPU trace array - it consists of thousands of trace entries
130 * plus some other descriptor data: (for example which task started
133 struct trace_array_cpu {
134 struct list_head trace_pages;
137 struct lock_class_key lock_key;
139 /* these fields get copied into max-trace: */
140 unsigned trace_head_idx;
141 unsigned trace_tail_idx;
142 void *trace_head; /* producer */
143 void *trace_tail; /* consumer */
144 unsigned long trace_idx;
145 unsigned long overrun;
146 unsigned long saved_latency;
147 unsigned long critical_start;
148 unsigned long critical_end;
149 unsigned long critical_sequence;
151 unsigned long policy;
152 unsigned long rt_priority;
153 cycle_t preempt_timestamp;
156 char comm[TASK_COMM_LEN];
159 struct trace_iterator;
162 * The trace array - an array of per-CPU trace arrays. This is the
163 * highest level data structure that individual tracers deal with.
164 * They have on/off state as well:
167 unsigned long entries;
171 struct task_struct *waiter;
172 struct trace_array_cpu *data[NR_CPUS];
176 * A specific tracer, represented by methods that operate on a trace array:
180 void (*init)(struct trace_array *tr);
181 void (*reset)(struct trace_array *tr);
182 void (*open)(struct trace_iterator *iter);
183 void (*pipe_open)(struct trace_iterator *iter);
184 void (*close)(struct trace_iterator *iter);
185 void (*start)(struct trace_iterator *iter);
186 void (*stop)(struct trace_iterator *iter);
187 ssize_t (*read)(struct trace_iterator *iter,
188 struct file *filp, char __user *ubuf,
189 size_t cnt, loff_t *ppos);
190 void (*ctrl_update)(struct trace_array *tr);
191 #ifdef CONFIG_FTRACE_STARTUP_TEST
192 int (*selftest)(struct tracer *trace,
193 struct trace_array *tr);
195 int (*print_line)(struct trace_iterator *iter);
201 unsigned char buffer[PAGE_SIZE];
203 unsigned int readpos;
207 * Trace iterator - used by printout routines who present trace
208 * results to users and which routines might sleep, etc:
210 struct trace_iterator {
211 struct trace_array *tr;
212 struct tracer *trace;
214 long last_overrun[NR_CPUS];
215 long overrun[NR_CPUS];
217 /* The below is zeroed out in pipe_read */
218 struct trace_seq seq;
219 struct trace_entry *ent;
222 struct trace_entry *prev_ent;
225 unsigned long iter_flags;
227 unsigned long next_idx[NR_CPUS];
228 struct list_head *next_page[NR_CPUS];
229 unsigned next_page_idx[NR_CPUS];
233 void trace_wake_up(void);
234 void tracing_reset(struct trace_array_cpu *data);
235 int tracing_open_generic(struct inode *inode, struct file *filp);
236 struct dentry *tracing_init_dentry(void);
237 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
239 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
240 struct trace_array_cpu *data);
241 void tracing_generic_entry_update(struct trace_entry *entry,
242 unsigned long flags);
244 void ftrace(struct trace_array *tr,
245 struct trace_array_cpu *data,
247 unsigned long parent_ip,
248 unsigned long flags);
249 void tracing_sched_switch_trace(struct trace_array *tr,
250 struct trace_array_cpu *data,
251 struct task_struct *prev,
252 struct task_struct *next,
253 unsigned long flags);
254 void tracing_record_cmdline(struct task_struct *tsk);
256 void tracing_sched_wakeup_trace(struct trace_array *tr,
257 struct trace_array_cpu *data,
258 struct task_struct *wakee,
259 struct task_struct *cur,
260 unsigned long flags);
261 void trace_special(struct trace_array *tr,
262 struct trace_array_cpu *data,
266 void trace_function(struct trace_array *tr,
267 struct trace_array_cpu *data,
269 unsigned long parent_ip,
270 unsigned long flags);
272 void tracing_start_cmdline_record(void);
273 void tracing_stop_cmdline_record(void);
274 int register_tracer(struct tracer *type);
275 void unregister_tracer(struct tracer *type);
277 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
279 extern unsigned long tracing_max_latency;
280 extern unsigned long tracing_thresh;
282 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
283 void update_max_tr_single(struct trace_array *tr,
284 struct task_struct *tsk, int cpu);
286 extern cycle_t ftrace_now(int cpu);
289 void tracing_start_function_trace(void);
290 void tracing_stop_function_trace(void);
292 # define tracing_start_function_trace() do { } while (0)
293 # define tracing_stop_function_trace() do { } while (0)
296 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
298 (*tracer_switch_func_t)(void *private,
300 struct task_struct *prev,
301 struct task_struct *next);
303 struct tracer_switch_ops {
304 tracer_switch_func_t func;
306 struct tracer_switch_ops *next;
309 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
311 #ifdef CONFIG_DYNAMIC_FTRACE
312 extern unsigned long ftrace_update_tot_cnt;
313 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
314 extern int DYN_FTRACE_TEST_NAME(void);
317 #ifdef CONFIG_FTRACE_STARTUP_TEST
319 extern int trace_selftest_startup_function(struct tracer *trace,
320 struct trace_array *tr);
322 #ifdef CONFIG_IRQSOFF_TRACER
323 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
324 struct trace_array *tr);
326 #ifdef CONFIG_PREEMPT_TRACER
327 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
328 struct trace_array *tr);
330 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
331 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
332 struct trace_array *tr);
334 #ifdef CONFIG_SCHED_TRACER
335 extern int trace_selftest_startup_wakeup(struct tracer *trace,
336 struct trace_array *tr);
338 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
339 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
340 struct trace_array *tr);
342 #ifdef CONFIG_SYSPROF_TRACER
343 extern int trace_selftest_startup_sysprof(struct tracer *trace,
344 struct trace_array *tr);
346 #endif /* CONFIG_FTRACE_STARTUP_TEST */
348 extern void *head_page(struct trace_array_cpu *data);
349 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
350 extern void trace_seq_print_cont(struct trace_seq *s,
351 struct trace_iterator *iter);
352 extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
354 extern long ns2usecs(cycle_t nsec);
355 extern int trace_vprintk(unsigned long ip, const char *fmt, va_list args);
357 extern unsigned long trace_flags;
360 * trace_iterator_flags is an enumeration that defines bit
361 * positions into trace_flags that controls the output.
363 * NOTE: These bits must match the trace_options array in
366 enum trace_iterator_flags {
367 TRACE_ITER_PRINT_PARENT = 0x01,
368 TRACE_ITER_SYM_OFFSET = 0x02,
369 TRACE_ITER_SYM_ADDR = 0x04,
370 TRACE_ITER_VERBOSE = 0x08,
371 TRACE_ITER_RAW = 0x10,
372 TRACE_ITER_HEX = 0x20,
373 TRACE_ITER_BIN = 0x40,
374 TRACE_ITER_BLOCK = 0x80,
375 TRACE_ITER_STACKTRACE = 0x100,
376 TRACE_ITER_SCHED_TREE = 0x200,
377 TRACE_ITER_PRINTK = 0x400,
380 #endif /* _LINUX_KERNEL_TRACE_H */