blob: d80ca0d464d970675030b622a8025c3af601765c [file] [log] [blame]
Steven Rostedtbc0c38d2008-05-12 21:20:42 +02001#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>
Steven Rostedt3928a8a2008-09-29 23:02:41 -04008#include <linux/ring_buffer.h>
Pekka Paalanenbd8ac682008-05-12 21:20:57 +02009#include <linux/mmiotrace.h>
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +010010#include <linux/ftrace.h>
Frederic Weisbecker3f5ec132008-11-11 23:21:31 +010011#include <trace/boot.h>
Frederic Weisbecker36994e52008-12-29 13:42:23 -080012#include <trace/kmemtrace.h>
Frederic Weisbecker12922112009-02-07 22:16:12 +010013#include <trace/power.h>
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020014
Thomas Gleixner72829bc2008-05-23 21:37:28 +020015enum trace_type {
16 __TRACE_FIRST_TYPE = 0,
17
18 TRACE_FN,
19 TRACE_CTX,
20 TRACE_WAKE,
21 TRACE_STACK,
Steven Rostedtdd0e5452008-08-01 12:26:41 -040022 TRACE_PRINT,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020023 TRACE_SPECIAL,
Pekka Paalanenbd8ac682008-05-12 21:20:57 +020024 TRACE_MMIO_RW,
25 TRACE_MMIO_MAP,
Steven Rostedt9f029e82008-11-12 15:24:24 -050026 TRACE_BRANCH,
Frederic Weisbecker74239072008-11-11 23:24:42 +010027 TRACE_BOOT_CALL,
28 TRACE_BOOT_RET,
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010029 TRACE_GRAPH_RET,
30 TRACE_GRAPH_ENT,
Török Edwin02b67512008-11-22 13:28:47 +020031 TRACE_USER_STACK,
Markus Metzgera93751c2008-12-11 13:53:26 +010032 TRACE_HW_BRANCHES,
Frederic Weisbeckeree08c6e2009-03-07 05:52:59 +010033 TRACE_SYSCALL_ENTER,
34 TRACE_SYSCALL_EXIT,
Frederic Weisbecker36994e52008-12-29 13:42:23 -080035 TRACE_KMEM_ALLOC,
36 TRACE_KMEM_FREE,
Arjan van de Venf3f47a62008-11-23 16:49:58 -080037 TRACE_POWER,
Arnaldo Carvalho de Meloc71a8962009-01-23 12:06:27 -020038 TRACE_BLK,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020039
Steven Rostedtf0868d12008-12-23 23:24:12 -050040 __TRACE_LAST_TYPE,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020041};
42
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020043/*
Steven Rostedt777e2082008-09-29 23:02:42 -040044 * The trace entry - the most basic unit of tracing. This is what
45 * is printed in the end as a single line in the trace output, such as:
46 *
47 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
48 */
49struct trace_entry {
50 unsigned char type;
Steven Rostedt777e2082008-09-29 23:02:42 -040051 unsigned char flags;
52 unsigned char preempt_count;
53 int pid;
Török Edwin02b67512008-11-22 13:28:47 +020054 int tgid;
Steven Rostedt777e2082008-09-29 23:02:42 -040055};
56
57/*
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020058 * Function trace entry - function address and parent function addres:
59 */
60struct ftrace_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040061 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020062 unsigned long ip;
63 unsigned long parent_ip;
64};
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010065
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010066/* Function call entry */
67struct ftrace_graph_ent_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010068 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010069 struct ftrace_graph_ent graph_ent;
70};
71
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010072/* Function return entry */
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010073struct ftrace_graph_ret_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010074 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010075 struct ftrace_graph_ret ret;
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010076};
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +010077extern struct tracer boot_tracer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020078
79/*
80 * Context switch trace entry - which task (and prio) we switched from/to:
81 */
82struct ctx_switch_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040083 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020084 unsigned int prev_pid;
85 unsigned char prev_prio;
86 unsigned char prev_state;
87 unsigned int next_pid;
88 unsigned char next_prio;
Peter Zijlstrabac524d2008-05-12 21:20:53 +020089 unsigned char next_state;
Peter Zijlstra80b5e942008-09-04 10:24:16 +020090 unsigned int next_cpu;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020091};
92
93/*
Ingo Molnarf0a920d2008-05-12 21:20:47 +020094 * Special (free-form) trace entry:
95 */
96struct special_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040097 struct trace_entry ent;
Ingo Molnarf0a920d2008-05-12 21:20:47 +020098 unsigned long arg1;
99 unsigned long arg2;
100 unsigned long arg3;
101};
102
103/*
Ingo Molnar86387f72008-05-12 21:20:51 +0200104 * Stack-trace entry:
105 */
106
Ingo Molnar74f4e362008-05-12 21:21:15 +0200107#define FTRACE_STACK_ENTRIES 8
Ingo Molnar86387f72008-05-12 21:20:51 +0200108
109struct stack_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400110 struct trace_entry ent;
Ingo Molnar86387f72008-05-12 21:20:51 +0200111 unsigned long caller[FTRACE_STACK_ENTRIES];
112};
113
Török Edwin02b67512008-11-22 13:28:47 +0200114struct userstack_entry {
115 struct trace_entry ent;
116 unsigned long caller[FTRACE_STACK_ENTRIES];
117};
118
Ingo Molnar86387f72008-05-12 21:20:51 +0200119/*
Ingo Molnar5e1607a2009-03-05 10:24:48 +0100120 * trace_printk entry:
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400121 */
122struct print_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400123 struct trace_entry ent;
Ingo Molnar9de36822009-03-06 17:52:03 +0100124 unsigned long ip;
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100125 int depth;
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100126 const char *fmt;
Ingo Molnar9de36822009-03-06 17:52:03 +0100127 u32 buf[];
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100128};
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100129
Steven Rostedt777e2082008-09-29 23:02:42 -0400130#define TRACE_OLD_SIZE 88
131
132struct trace_field_cont {
133 unsigned char type;
134 /* Temporary till we get rid of this completely */
135 char buf[TRACE_OLD_SIZE - 1];
136};
137
138struct trace_mmiotrace_rw {
139 struct trace_entry ent;
140 struct mmiotrace_rw rw;
141};
142
143struct trace_mmiotrace_map {
144 struct trace_entry ent;
145 struct mmiotrace_map map;
146};
147
Frederic Weisbecker74239072008-11-11 23:24:42 +0100148struct trace_boot_call {
Steven Rostedt777e2082008-09-29 23:02:42 -0400149 struct trace_entry ent;
Frederic Weisbecker74239072008-11-11 23:24:42 +0100150 struct boot_trace_call boot_call;
151};
152
153struct trace_boot_ret {
154 struct trace_entry ent;
155 struct boot_trace_ret boot_ret;
Steven Rostedt777e2082008-09-29 23:02:42 -0400156};
157
Steven Rostedt52f232c2008-11-12 00:14:40 -0500158#define TRACE_FUNC_SIZE 30
159#define TRACE_FILE_SIZE 20
Steven Rostedt9f029e82008-11-12 15:24:24 -0500160struct trace_branch {
Steven Rostedt52f232c2008-11-12 00:14:40 -0500161 struct trace_entry ent;
162 unsigned line;
163 char func[TRACE_FUNC_SIZE+1];
164 char file[TRACE_FILE_SIZE+1];
165 char correct;
166};
167
Markus Metzgera93751c2008-12-11 13:53:26 +0100168struct hw_branch_entry {
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100169 struct trace_entry ent;
Markus Metzgera93751c2008-12-11 13:53:26 +0100170 u64 from;
171 u64 to;
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100172};
173
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800174struct trace_power {
175 struct trace_entry ent;
176 struct power_trace state_data;
177};
178
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800179struct kmemtrace_alloc_entry {
180 struct trace_entry ent;
181 enum kmemtrace_type_id type_id;
182 unsigned long call_site;
183 const void *ptr;
184 size_t bytes_req;
185 size_t bytes_alloc;
186 gfp_t gfp_flags;
187 int node;
188};
189
190struct kmemtrace_free_entry {
191 struct trace_entry ent;
192 enum kmemtrace_type_id type_id;
193 unsigned long call_site;
194 const void *ptr;
195};
196
Frederic Weisbeckerbed1ffc2009-03-13 15:42:11 +0100197struct syscall_trace_enter {
198 struct trace_entry ent;
199 int nr;
200 unsigned long args[];
201};
202
203struct syscall_trace_exit {
204 struct trace_entry ent;
205 int nr;
206 unsigned long ret;
207};
208
209
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400210/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300211 * trace_flag_type is an enumeration that holds different
212 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400213 * IRQS_OFF - interrupts were disabled
Ingo Molnar9de36822009-03-06 17:52:03 +0100214 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
Steven Rostedt92444892008-10-24 09:42:59 -0400215 * NEED_RESCED - reschedule is requested
216 * HARDIRQ - inside an interrupt handler
217 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300218 */
219enum trace_flag_type {
220 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400221 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
222 TRACE_FLAG_NEED_RESCHED = 0x04,
223 TRACE_FLAG_HARDIRQ = 0x08,
224 TRACE_FLAG_SOFTIRQ = 0x10,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300225};
226
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300227#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200228
229/*
230 * The CPU trace array - it consists of thousands of trace entries
231 * plus some other descriptor data: (for example which task started
232 * the trace, etc.)
233 */
234struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200235 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500236 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200237
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200238 /* these fields get copied into max-trace: */
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200239 unsigned long trace_idx;
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200240 unsigned long overrun;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200241 unsigned long saved_latency;
242 unsigned long critical_start;
243 unsigned long critical_end;
244 unsigned long critical_sequence;
245 unsigned long nice;
246 unsigned long policy;
247 unsigned long rt_priority;
248 cycle_t preempt_timestamp;
249 pid_t pid;
250 uid_t uid;
251 char comm[TASK_COMM_LEN];
252};
253
254struct trace_iterator;
255
256/*
257 * The trace array - an array of per-CPU trace arrays. This is the
258 * highest level data structure that individual tracers deal with.
259 * They have on/off state as well:
260 */
261struct trace_array {
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400262 struct ring_buffer *buffer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200263 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200264 int cpu;
265 cycle_t time_start;
Steven Rostedtb3806b42008-05-12 21:20:46 +0200266 struct task_struct *waiter;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200267 struct trace_array_cpu *data[NR_CPUS];
268};
269
Steven Rostedt7104f302008-10-01 10:52:51 -0400270#define FTRACE_CMP_TYPE(var, type) \
271 __builtin_types_compatible_p(typeof(var), type *)
272
273#undef IF_ASSIGN
274#define IF_ASSIGN(var, entry, etype, id) \
275 if (FTRACE_CMP_TYPE(var, etype)) { \
276 var = (typeof(var))(entry); \
277 WARN_ON(id && (entry)->type != id); \
278 break; \
279 }
280
281/* Will cause compile errors if type is not found. */
282extern void __ftrace_bad_type(void);
283
284/*
285 * The trace_assign_type is a verifier that the entry type is
286 * the same as the type being assigned. To add new types simply
287 * add a line with the following format:
288 *
289 * IF_ASSIGN(var, ent, type, id);
290 *
291 * Where "type" is the trace type that includes the trace_entry
292 * as the "ent" item. And "id" is the trace identifier that is
293 * used in the trace_type enum.
294 *
295 * If the type can have more than one id, then use zero.
296 */
297#define trace_assign_type(var, ent) \
298 do { \
299 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
300 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400301 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200302 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400303 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
304 IF_ASSIGN(var, ent, struct special_entry, 0); \
305 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
306 TRACE_MMIO_RW); \
307 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
308 TRACE_MMIO_MAP); \
Frederic Weisbecker74239072008-11-11 23:24:42 +0100309 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
310 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
Steven Rostedt9f029e82008-11-12 15:24:24 -0500311 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100312 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
313 TRACE_GRAPH_ENT); \
314 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
315 TRACE_GRAPH_RET); \
Markus Metzgera93751c2008-12-11 13:53:26 +0100316 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
Ingo Molnar9de36822009-03-06 17:52:03 +0100317 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800318 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
319 TRACE_KMEM_ALLOC); \
320 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
321 TRACE_KMEM_FREE); \
Frederic Weisbeckerbed1ffc2009-03-13 15:42:11 +0100322 IF_ASSIGN(var, ent, struct syscall_trace_enter, \
323 TRACE_SYSCALL_ENTER); \
324 IF_ASSIGN(var, ent, struct syscall_trace_exit, \
325 TRACE_SYSCALL_EXIT); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400326 __ftrace_bad_type(); \
327 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200328
329/* Return values for print_line callback */
330enum print_line_t {
331 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
332 TRACE_TYPE_HANDLED = 1,
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +0100333 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
334 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200335};
336
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100337
338/*
339 * An option specific to a tracer. This is a boolean value.
340 * The bit is the bit index that sets its value on the
341 * flags value in struct tracer_flags.
342 */
343struct tracer_opt {
Ingo Molnar9de36822009-03-06 17:52:03 +0100344 const char *name; /* Will appear on the trace_options file */
345 u32 bit; /* Mask assigned in val field in tracer_flags */
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100346};
347
348/*
349 * The set of specific options for a tracer. Your tracer
350 * have to set the initial value of the flags val.
351 */
352struct tracer_flags {
353 u32 val;
Ingo Molnar9de36822009-03-06 17:52:03 +0100354 struct tracer_opt *opts;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100355};
356
357/* Makes more easy to define a tracer opt */
358#define TRACER_OPT(s, b) .name = #s, .bit = b
359
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800360
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100361/**
362 * struct tracer - a specific tracer and its callbacks to interact with debugfs
363 * @name: the name chosen to select it on the available_tracers file
364 * @init: called when one switches to this tracer (echo name > current_tracer)
365 * @reset: called when one switches to another tracer
366 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
367 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
368 * @open: called when the trace file is opened
369 * @pipe_open: called when the trace_pipe file is opened
370 * @wait_pipe: override how the user waits for traces on trace_pipe
371 * @close: called when the trace file is released
372 * @read: override the default read callback on trace_pipe
373 * @splice_read: override the default splice_read callback on trace_pipe
374 * @selftest: selftest to run on boot (see trace_selftest.c)
375 * @print_headers: override the first lines that describe your columns
376 * @print_line: callback that prints a trace
377 * @set_flag: signals one of your private flags changed (trace_options file)
378 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200379 */
380struct tracer {
381 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100382 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200383 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500384 void (*start)(struct trace_array *tr);
385 void (*stop)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200386 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200387 void (*pipe_open)(struct trace_iterator *iter);
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100388 void (*wait_pipe)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200389 void (*close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200390 ssize_t (*read)(struct trace_iterator *iter,
391 struct file *filp, char __user *ubuf,
392 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200393 ssize_t (*splice_read)(struct trace_iterator *iter,
394 struct file *filp,
395 loff_t *ppos,
396 struct pipe_inode_info *pipe,
397 size_t len,
398 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200399#ifdef CONFIG_FTRACE_STARTUP_TEST
400 int (*selftest)(struct tracer *trace,
401 struct trace_array *tr);
402#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100403 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200404 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100405 /* If you handled the flag setting, return 0 */
406 int (*set_flag)(u32 old_flags, u32 bit, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200407 struct tracer *next;
408 int print_max;
Ingo Molnar9de36822009-03-06 17:52:03 +0100409 struct tracer_flags *flags;
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800410 struct tracer_stat *stats;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200411};
412
Steven Rostedt214023c2008-05-12 21:20:46 +0200413struct trace_seq {
414 unsigned char buffer[PAGE_SIZE];
415 unsigned int len;
Pekka Paalanen6c6c2792008-05-12 21:21:02 +0200416 unsigned int readpos;
Steven Rostedt214023c2008-05-12 21:20:46 +0200417};
418
Steven Rostedtf9520752009-03-02 14:04:40 -0500419static inline void
420trace_seq_init(struct trace_seq *s)
421{
422 s->len = 0;
423 s->readpos = 0;
424}
425
426
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100427#define TRACE_PIPE_ALL_CPU -1
428
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200429/*
430 * Trace iterator - used by printout routines who present trace
431 * results to users and which routines might sleep, etc:
432 */
433struct trace_iterator {
434 struct trace_array *tr;
435 struct tracer *trace;
Steven Rostedt107bad82008-05-12 21:21:01 +0200436 void *private;
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100437 int cpu_file;
Frederic Weisbeckerd7350c3f2009-02-25 06:13:16 +0100438 struct mutex mutex;
439 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200440
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200441 /* The below is zeroed out in pipe_read */
442 struct trace_seq seq;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200443 struct trace_entry *ent;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200444 int cpu;
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400445 u64 ts;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200446
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200447 unsigned long iter_flags;
448 loff_t pos;
Steven Rostedt4c11d7a2008-05-12 21:20:43 +0200449 long idx;
Steven Rostedta3097202008-11-07 22:36:02 -0500450
Rusty Russell44623442009-01-01 10:12:23 +1030451 cpumask_var_t started;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200452};
453
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200454int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500455int tracing_is_enabled(void);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300456void trace_wake_up(void);
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400457void tracing_reset(struct trace_array *tr, int cpu);
Pekka J Enberg213cc062008-12-19 12:08:39 +0200458void tracing_reset_online_cpus(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200459int tracing_open_generic(struct inode *inode, struct file *filp);
460struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200461void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
462
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200463struct ring_buffer_event;
464
465struct ring_buffer_event *trace_buffer_lock_reserve(struct trace_array *tr,
466 unsigned char type,
467 unsigned long len,
468 unsigned long flags,
469 int pc);
470void trace_buffer_unlock_commit(struct trace_array *tr,
471 struct ring_buffer_event *event,
472 unsigned long flags, int pc);
473
Steven Rostedtef5580d2009-02-27 19:38:04 -0500474struct ring_buffer_event *
475trace_current_buffer_lock_reserve(unsigned char type, unsigned long len,
476 unsigned long flags, int pc);
477void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
478 unsigned long flags, int pc);
479
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300480struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
481 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200482
483struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
484 int *ent_cpu, u64 *ent_ts);
485
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300486void tracing_generic_entry_update(struct trace_entry *entry,
Steven Rostedt38697052008-10-01 13:14:09 -0400487 unsigned long flags,
488 int pc);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300489
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100490void default_wait_pipe(struct trace_iterator *iter);
491void poll_wait_pipe(struct trace_iterator *iter);
492
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200493void ftrace(struct trace_array *tr,
494 struct trace_array_cpu *data,
495 unsigned long ip,
496 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400497 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200498void tracing_sched_switch_trace(struct trace_array *tr,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200499 struct task_struct *prev,
500 struct task_struct *next,
Steven Rostedt38697052008-10-01 13:14:09 -0400501 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200502void tracing_record_cmdline(struct task_struct *tsk);
Ingo Molnar57422792008-05-12 21:20:51 +0200503
504void tracing_sched_wakeup_trace(struct trace_array *tr,
Ingo Molnar57422792008-05-12 21:20:51 +0200505 struct task_struct *wakee,
506 struct task_struct *cur,
Steven Rostedt38697052008-10-01 13:14:09 -0400507 unsigned long flags, int pc);
Ingo Molnarf0a920d2008-05-12 21:20:47 +0200508void trace_special(struct trace_array *tr,
509 struct trace_array_cpu *data,
510 unsigned long arg1,
511 unsigned long arg2,
Steven Rostedt38697052008-10-01 13:14:09 -0400512 unsigned long arg3, int pc);
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200513void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200514 unsigned long ip,
515 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400516 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200517
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100518void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500519int trace_graph_entry(struct ftrace_graph_ent *trace);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100520
Steven Rostedt41bc8142008-05-22 11:49:22 -0400521void tracing_start_cmdline_record(void);
522void tracing_stop_cmdline_record(void);
Steven Rostedte168e052008-11-07 22:36:02 -0500523void tracing_sched_switch_assign_trace(struct trace_array *tr);
524void tracing_stop_sched_switch_record(void);
525void tracing_start_sched_switch_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200526int register_tracer(struct tracer *type);
527void unregister_tracer(struct tracer *type);
528
529extern unsigned long nsecs_to_usecs(unsigned long nsecs);
530
531extern unsigned long tracing_max_latency;
532extern unsigned long tracing_thresh;
533
534void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
535void update_max_tr_single(struct trace_array *tr,
536 struct task_struct *tsk, int cpu);
537
Steven Rostedt53614992009-01-15 19:12:40 -0500538void __trace_stack(struct trace_array *tr,
Steven Rostedt53614992009-01-15 19:12:40 -0500539 unsigned long flags,
540 int skip, int pc);
541
Ingo Molnare309b412008-05-12 21:20:51 +0200542extern cycle_t ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200543
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200544#ifdef CONFIG_CONTEXT_SWITCH_TRACER
545typedef void
546(*tracer_switch_func_t)(void *private,
Mathieu Desnoyers5b82a1b2008-05-12 21:21:10 +0200547 void *__rq,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200548 struct task_struct *prev,
549 struct task_struct *next);
550
551struct tracer_switch_ops {
552 tracer_switch_func_t func;
553 void *private;
554 struct tracer_switch_ops *next;
555};
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200556#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
557
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100558extern char *trace_find_cmdline(int pid);
559
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200560#ifdef CONFIG_DYNAMIC_FTRACE
561extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200562#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
563extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200564#endif
565
Steven Rostedt60a11772008-05-12 21:20:44 +0200566#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200567extern int trace_selftest_startup_function(struct tracer *trace,
568 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100569extern int trace_selftest_startup_function_graph(struct tracer *trace,
570 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200571extern int trace_selftest_startup_irqsoff(struct tracer *trace,
572 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200573extern int trace_selftest_startup_preemptoff(struct tracer *trace,
574 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200575extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
576 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200577extern int trace_selftest_startup_wakeup(struct tracer *trace,
578 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700579extern int trace_selftest_startup_nop(struct tracer *trace,
580 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200581extern int trace_selftest_startup_sched_switch(struct tracer *trace,
582 struct trace_array *tr);
Ingo Molnara6dd24f2008-05-12 21:20:47 +0200583extern int trace_selftest_startup_sysprof(struct tracer *trace,
584 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500585extern int trace_selftest_startup_branch(struct tracer *trace,
586 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200587#endif /* CONFIG_FTRACE_STARTUP_TEST */
588
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200589extern void *head_page(struct trace_array_cpu *data);
Thomas Gleixner72829bc2008-05-23 21:37:28 +0200590extern long ns2usecs(cycle_t nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100591extern int
592trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200593
Ingo Molnar4e655512008-05-12 21:20:52 +0200594extern unsigned long trace_flags;
595
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100596/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100597#ifdef CONFIG_FUNCTION_GRAPH_TRACER
598extern enum print_line_t print_graph_function(struct trace_iterator *iter);
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500599
600#ifdef CONFIG_DYNAMIC_FTRACE
601/* TODO: make this variable */
602#define FTRACE_GRAPH_MAX_FUNCS 32
603extern int ftrace_graph_count;
604extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
605
606static inline int ftrace_graph_addr(unsigned long addr)
607{
608 int i;
609
610 if (!ftrace_graph_count || test_tsk_trace_graph(current))
611 return 1;
612
613 for (i = 0; i < ftrace_graph_count; i++) {
614 if (addr == ftrace_graph_funcs[i])
615 return 1;
616 }
617
618 return 0;
619}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100620#else
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500621static inline int ftrace_trace_addr(unsigned long addr)
622{
Ingo Molnar6b253932008-12-04 09:18:28 +0100623 return 1;
624}
625static inline int ftrace_graph_addr(unsigned long addr)
626{
627 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500628}
629#endif /* CONFIG_DYNAMIC_FTRACE */
630
631#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100632static inline enum print_line_t
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100633print_graph_function(struct trace_iterator *iter)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100634{
635 return TRACE_TYPE_UNHANDLED;
636}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500637#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100638
Steven Rostedt978f3a42008-12-04 00:26:40 -0500639extern struct pid *ftrace_pid_trace;
Steven Rostedt804a6852008-12-03 15:36:59 -0500640
641static inline int ftrace_trace_task(struct task_struct *task)
642{
Frederic Weisbecker77d683f2008-12-04 23:49:47 +0100643 if (!ftrace_pid_trace)
Steven Rostedt804a6852008-12-03 15:36:59 -0500644 return 1;
645
646 return test_tsk_trace_trace(task);
647}
648
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200649/*
650 * trace_iterator_flags is an enumeration that defines bit
651 * positions into trace_flags that controls the output.
652 *
653 * NOTE: These bits must match the trace_options array in
654 * trace.c.
655 */
Ingo Molnar4e655512008-05-12 21:20:52 +0200656enum trace_iterator_flags {
657 TRACE_ITER_PRINT_PARENT = 0x01,
658 TRACE_ITER_SYM_OFFSET = 0x02,
659 TRACE_ITER_SYM_ADDR = 0x04,
660 TRACE_ITER_VERBOSE = 0x08,
661 TRACE_ITER_RAW = 0x10,
662 TRACE_ITER_HEX = 0x20,
663 TRACE_ITER_BIN = 0x40,
664 TRACE_ITER_BLOCK = 0x80,
665 TRACE_ITER_STACKTRACE = 0x100,
Ingo Molnar4ac3ba42008-05-12 21:20:52 +0200666 TRACE_ITER_SCHED_TREE = 0x200,
Peter Zijlstraf09ce572008-09-04 10:24:14 +0200667 TRACE_ITER_PRINTK = 0x400,
Steven Rostedtb2a866f2008-11-03 23:15:57 -0500668 TRACE_ITER_PREEMPTONLY = 0x800,
Steven Rostedt9f029e82008-11-12 15:24:24 -0500669 TRACE_ITER_BRANCH = 0x1000,
Steven Rostedt12ef7d42008-11-12 17:52:38 -0500670 TRACE_ITER_ANNOTATE = 0x2000,
Török Edwinb54d3de2008-11-22 13:28:48 +0200671 TRACE_ITER_USERSTACKTRACE = 0x4000,
Frederic Weisbecker66896a82008-12-13 20:18:13 +0100672 TRACE_ITER_SYM_USEROBJ = 0x8000,
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200673 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
Steven Rostedtc032ef642009-03-04 20:34:24 -0500674 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
675 TRACE_ITER_LATENCY_FMT = 0x40000,
Ingo Molnar4e655512008-05-12 21:20:52 +0200676};
677
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100678/*
679 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
680 * control the output of kernel symbols.
681 */
682#define TRACE_ITER_SYM_MASK \
683 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
684
Frédéric Weisbecker43a15382008-09-21 20:16:30 +0200685extern struct tracer nop_trace;
686
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500687/**
688 * ftrace_preempt_disable - disable preemption scheduler safe
689 *
690 * When tracing can happen inside the scheduler, there exists
691 * cases that the tracing might happen before the need_resched
692 * flag is checked. If this happens and the tracer calls
693 * preempt_enable (after a disable), a schedule might take place
694 * causing an infinite recursion.
695 *
Wenji Huang57794a92009-02-06 17:33:27 +0800696 * To prevent this, we read the need_resched flag before
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500697 * disabling preemption. When we want to enable preemption we
698 * check the flag, if it is set, then we call preempt_enable_no_resched.
699 * Otherwise, we call preempt_enable.
700 *
Wenji Huang57794a92009-02-06 17:33:27 +0800701 * The rational for doing the above is that if need_resched is set
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500702 * and we have yet to reschedule, we are either in an atomic location
703 * (where we do not need to check for scheduling) or we are inside
704 * the scheduler and do not want to resched.
705 */
706static inline int ftrace_preempt_disable(void)
707{
708 int resched;
709
710 resched = need_resched();
711 preempt_disable_notrace();
712
713 return resched;
714}
715
716/**
717 * ftrace_preempt_enable - enable preemption scheduler safe
718 * @resched: the return value from ftrace_preempt_disable
719 *
720 * This is a scheduler safe way to enable preemption and not miss
721 * any preemption checks. The disabled saved the state of preemption.
Wenji Huang57794a92009-02-06 17:33:27 +0800722 * If resched is set, then we are either inside an atomic or
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500723 * are inside the scheduler (we would have already scheduled
724 * otherwise). In this case, we do not want to call normal
725 * preempt_enable, but preempt_enable_no_resched instead.
726 */
727static inline void ftrace_preempt_enable(int resched)
728{
729 if (resched)
730 preempt_enable_no_resched_notrace();
731 else
732 preempt_enable_notrace();
733}
734
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500735#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -0500736extern int enable_branch_tracing(struct trace_array *tr);
737extern void disable_branch_tracing(void);
738static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500739{
Steven Rostedt9f029e82008-11-12 15:24:24 -0500740 if (trace_flags & TRACE_ITER_BRANCH)
741 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -0500742 return 0;
743}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500744static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500745{
746 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -0500747 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -0500748}
749#else
Steven Rostedt9f029e82008-11-12 15:24:24 -0500750static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500751{
752 return 0;
753}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500754static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500755{
756}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500757#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -0500758
Steven Rostedtfd994982009-02-28 02:41:25 -0500759/* trace event type bit fields, not numeric */
760enum {
761 TRACE_EVENT_TYPE_PRINTF = 1,
762 TRACE_EVENT_TYPE_RAW = 2,
763};
764
Steven Rostedtc32e8272009-02-27 19:12:30 -0500765struct ftrace_event_call {
766 char *name;
767 char *system;
768 struct dentry *dir;
769 int enabled;
770 int (*regfunc)(void);
771 void (*unregfunc)(void);
772 int id;
Steven Rostedtc32e8272009-02-27 19:12:30 -0500773 int (*raw_init)(void);
Steven Rostedt981d0812009-03-02 13:53:59 -0500774 int (*show_format)(struct trace_seq *s);
Steven Rostedtc32e8272009-02-27 19:12:30 -0500775};
776
777void event_trace_printk(unsigned long ip, const char *fmt, ...);
778extern struct ftrace_event_call __start_ftrace_events[];
779extern struct ftrace_event_call __stop_ftrace_events[];
780
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200781#endif /* _LINUX_KERNEL_TRACE_H */