blob: 2bfb7d11fc176a41b3a41da3e9f215c7b4835b24 [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 Weisbecker36994e52008-12-29 13:42:23 -080033 TRACE_KMEM_ALLOC,
34 TRACE_KMEM_FREE,
Arjan van de Venf3f47a62008-11-23 16:49:58 -080035 TRACE_POWER,
Arnaldo Carvalho de Meloc71a8962009-01-23 12:06:27 -020036 TRACE_BLK,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020037
Steven Rostedtf0868d12008-12-23 23:24:12 -050038 __TRACE_LAST_TYPE,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020039};
40
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020041/*
Steven Rostedt777e2082008-09-29 23:02:42 -040042 * The trace entry - the most basic unit of tracing. This is what
43 * is printed in the end as a single line in the trace output, such as:
44 *
45 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
46 */
47struct trace_entry {
48 unsigned char type;
Steven Rostedt777e2082008-09-29 23:02:42 -040049 unsigned char flags;
50 unsigned char preempt_count;
51 int pid;
Török Edwin02b67512008-11-22 13:28:47 +020052 int tgid;
Steven Rostedt777e2082008-09-29 23:02:42 -040053};
54
55/*
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020056 * Function trace entry - function address and parent function addres:
57 */
58struct ftrace_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040059 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020060 unsigned long ip;
61 unsigned long parent_ip;
62};
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010063
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010064/* Function call entry */
65struct ftrace_graph_ent_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010066 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010067 struct ftrace_graph_ent graph_ent;
68};
69
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010070/* Function return entry */
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010071struct ftrace_graph_ret_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010072 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010073 struct ftrace_graph_ret ret;
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010074};
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +010075extern struct tracer boot_tracer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020076
77/*
78 * Context switch trace entry - which task (and prio) we switched from/to:
79 */
80struct ctx_switch_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040081 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020082 unsigned int prev_pid;
83 unsigned char prev_prio;
84 unsigned char prev_state;
85 unsigned int next_pid;
86 unsigned char next_prio;
Peter Zijlstrabac524d2008-05-12 21:20:53 +020087 unsigned char next_state;
Peter Zijlstra80b5e942008-09-04 10:24:16 +020088 unsigned int next_cpu;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020089};
90
91/*
Ingo Molnarf0a920d2008-05-12 21:20:47 +020092 * Special (free-form) trace entry:
93 */
94struct special_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040095 struct trace_entry ent;
Ingo Molnarf0a920d2008-05-12 21:20:47 +020096 unsigned long arg1;
97 unsigned long arg2;
98 unsigned long arg3;
99};
100
101/*
Ingo Molnar86387f72008-05-12 21:20:51 +0200102 * Stack-trace entry:
103 */
104
Ingo Molnar74f4e362008-05-12 21:21:15 +0200105#define FTRACE_STACK_ENTRIES 8
Ingo Molnar86387f72008-05-12 21:20:51 +0200106
107struct stack_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400108 struct trace_entry ent;
Ingo Molnar86387f72008-05-12 21:20:51 +0200109 unsigned long caller[FTRACE_STACK_ENTRIES];
110};
111
Török Edwin02b67512008-11-22 13:28:47 +0200112struct userstack_entry {
113 struct trace_entry ent;
114 unsigned long caller[FTRACE_STACK_ENTRIES];
115};
116
Ingo Molnar86387f72008-05-12 21:20:51 +0200117/*
Ingo Molnar5e1607a2009-03-05 10:24:48 +0100118 * trace_printk entry:
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400119 */
120struct print_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400121 struct trace_entry ent;
Ingo Molnar9de36822009-03-06 17:52:03 +0100122 unsigned long ip;
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100123 int depth;
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100124 const char *fmt;
Ingo Molnar9de36822009-03-06 17:52:03 +0100125 u32 buf[];
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100126};
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100127
Steven Rostedt777e2082008-09-29 23:02:42 -0400128#define TRACE_OLD_SIZE 88
129
130struct trace_field_cont {
131 unsigned char type;
132 /* Temporary till we get rid of this completely */
133 char buf[TRACE_OLD_SIZE - 1];
134};
135
136struct trace_mmiotrace_rw {
137 struct trace_entry ent;
138 struct mmiotrace_rw rw;
139};
140
141struct trace_mmiotrace_map {
142 struct trace_entry ent;
143 struct mmiotrace_map map;
144};
145
Frederic Weisbecker74239072008-11-11 23:24:42 +0100146struct trace_boot_call {
Steven Rostedt777e2082008-09-29 23:02:42 -0400147 struct trace_entry ent;
Frederic Weisbecker74239072008-11-11 23:24:42 +0100148 struct boot_trace_call boot_call;
149};
150
151struct trace_boot_ret {
152 struct trace_entry ent;
153 struct boot_trace_ret boot_ret;
Steven Rostedt777e2082008-09-29 23:02:42 -0400154};
155
Steven Rostedt52f232c2008-11-12 00:14:40 -0500156#define TRACE_FUNC_SIZE 30
157#define TRACE_FILE_SIZE 20
Steven Rostedt9f029e82008-11-12 15:24:24 -0500158struct trace_branch {
Steven Rostedt52f232c2008-11-12 00:14:40 -0500159 struct trace_entry ent;
160 unsigned line;
161 char func[TRACE_FUNC_SIZE+1];
162 char file[TRACE_FILE_SIZE+1];
163 char correct;
164};
165
Markus Metzgera93751c2008-12-11 13:53:26 +0100166struct hw_branch_entry {
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100167 struct trace_entry ent;
Markus Metzgera93751c2008-12-11 13:53:26 +0100168 u64 from;
169 u64 to;
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100170};
171
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800172struct trace_power {
173 struct trace_entry ent;
174 struct power_trace state_data;
175};
176
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800177struct kmemtrace_alloc_entry {
178 struct trace_entry ent;
179 enum kmemtrace_type_id type_id;
180 unsigned long call_site;
181 const void *ptr;
182 size_t bytes_req;
183 size_t bytes_alloc;
184 gfp_t gfp_flags;
185 int node;
186};
187
188struct kmemtrace_free_entry {
189 struct trace_entry ent;
190 enum kmemtrace_type_id type_id;
191 unsigned long call_site;
192 const void *ptr;
193};
194
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400195/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300196 * trace_flag_type is an enumeration that holds different
197 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400198 * IRQS_OFF - interrupts were disabled
Ingo Molnar9de36822009-03-06 17:52:03 +0100199 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
Steven Rostedt92444892008-10-24 09:42:59 -0400200 * NEED_RESCED - reschedule is requested
201 * HARDIRQ - inside an interrupt handler
202 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300203 */
204enum trace_flag_type {
205 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400206 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
207 TRACE_FLAG_NEED_RESCHED = 0x04,
208 TRACE_FLAG_HARDIRQ = 0x08,
209 TRACE_FLAG_SOFTIRQ = 0x10,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300210};
211
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300212#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200213
214/*
215 * The CPU trace array - it consists of thousands of trace entries
216 * plus some other descriptor data: (for example which task started
217 * the trace, etc.)
218 */
219struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200220 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500221 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200222
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200223 /* these fields get copied into max-trace: */
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200224 unsigned long trace_idx;
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200225 unsigned long overrun;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200226 unsigned long saved_latency;
227 unsigned long critical_start;
228 unsigned long critical_end;
229 unsigned long critical_sequence;
230 unsigned long nice;
231 unsigned long policy;
232 unsigned long rt_priority;
233 cycle_t preempt_timestamp;
234 pid_t pid;
235 uid_t uid;
236 char comm[TASK_COMM_LEN];
237};
238
239struct trace_iterator;
240
241/*
242 * The trace array - an array of per-CPU trace arrays. This is the
243 * highest level data structure that individual tracers deal with.
244 * They have on/off state as well:
245 */
246struct trace_array {
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400247 struct ring_buffer *buffer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200248 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200249 int cpu;
250 cycle_t time_start;
Steven Rostedtb3806b42008-05-12 21:20:46 +0200251 struct task_struct *waiter;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200252 struct trace_array_cpu *data[NR_CPUS];
253};
254
Steven Rostedt7104f302008-10-01 10:52:51 -0400255#define FTRACE_CMP_TYPE(var, type) \
256 __builtin_types_compatible_p(typeof(var), type *)
257
258#undef IF_ASSIGN
259#define IF_ASSIGN(var, entry, etype, id) \
260 if (FTRACE_CMP_TYPE(var, etype)) { \
261 var = (typeof(var))(entry); \
262 WARN_ON(id && (entry)->type != id); \
263 break; \
264 }
265
266/* Will cause compile errors if type is not found. */
267extern void __ftrace_bad_type(void);
268
269/*
270 * The trace_assign_type is a verifier that the entry type is
271 * the same as the type being assigned. To add new types simply
272 * add a line with the following format:
273 *
274 * IF_ASSIGN(var, ent, type, id);
275 *
276 * Where "type" is the trace type that includes the trace_entry
277 * as the "ent" item. And "id" is the trace identifier that is
278 * used in the trace_type enum.
279 *
280 * If the type can have more than one id, then use zero.
281 */
282#define trace_assign_type(var, ent) \
283 do { \
284 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
285 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400286 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200287 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400288 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
289 IF_ASSIGN(var, ent, struct special_entry, 0); \
290 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
291 TRACE_MMIO_RW); \
292 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
293 TRACE_MMIO_MAP); \
Frederic Weisbecker74239072008-11-11 23:24:42 +0100294 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
295 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
Steven Rostedt9f029e82008-11-12 15:24:24 -0500296 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100297 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
298 TRACE_GRAPH_ENT); \
299 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
300 TRACE_GRAPH_RET); \
Markus Metzgera93751c2008-12-11 13:53:26 +0100301 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
Ingo Molnar9de36822009-03-06 17:52:03 +0100302 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800303 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
304 TRACE_KMEM_ALLOC); \
305 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
306 TRACE_KMEM_FREE); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400307 __ftrace_bad_type(); \
308 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200309
310/* Return values for print_line callback */
311enum print_line_t {
312 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
313 TRACE_TYPE_HANDLED = 1,
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +0100314 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
315 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200316};
317
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100318
319/*
320 * An option specific to a tracer. This is a boolean value.
321 * The bit is the bit index that sets its value on the
322 * flags value in struct tracer_flags.
323 */
324struct tracer_opt {
Ingo Molnar9de36822009-03-06 17:52:03 +0100325 const char *name; /* Will appear on the trace_options file */
326 u32 bit; /* Mask assigned in val field in tracer_flags */
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100327};
328
329/*
330 * The set of specific options for a tracer. Your tracer
331 * have to set the initial value of the flags val.
332 */
333struct tracer_flags {
334 u32 val;
Ingo Molnar9de36822009-03-06 17:52:03 +0100335 struct tracer_opt *opts;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100336};
337
338/* Makes more easy to define a tracer opt */
339#define TRACER_OPT(s, b) .name = #s, .bit = b
340
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800341
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100342/**
343 * struct tracer - a specific tracer and its callbacks to interact with debugfs
344 * @name: the name chosen to select it on the available_tracers file
345 * @init: called when one switches to this tracer (echo name > current_tracer)
346 * @reset: called when one switches to another tracer
347 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
348 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
349 * @open: called when the trace file is opened
350 * @pipe_open: called when the trace_pipe file is opened
351 * @wait_pipe: override how the user waits for traces on trace_pipe
352 * @close: called when the trace file is released
353 * @read: override the default read callback on trace_pipe
354 * @splice_read: override the default splice_read callback on trace_pipe
355 * @selftest: selftest to run on boot (see trace_selftest.c)
356 * @print_headers: override the first lines that describe your columns
357 * @print_line: callback that prints a trace
358 * @set_flag: signals one of your private flags changed (trace_options file)
359 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200360 */
361struct tracer {
362 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100363 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200364 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500365 void (*start)(struct trace_array *tr);
366 void (*stop)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200367 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200368 void (*pipe_open)(struct trace_iterator *iter);
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100369 void (*wait_pipe)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200370 void (*close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200371 ssize_t (*read)(struct trace_iterator *iter,
372 struct file *filp, char __user *ubuf,
373 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200374 ssize_t (*splice_read)(struct trace_iterator *iter,
375 struct file *filp,
376 loff_t *ppos,
377 struct pipe_inode_info *pipe,
378 size_t len,
379 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200380#ifdef CONFIG_FTRACE_STARTUP_TEST
381 int (*selftest)(struct tracer *trace,
382 struct trace_array *tr);
383#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100384 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200385 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100386 /* If you handled the flag setting, return 0 */
387 int (*set_flag)(u32 old_flags, u32 bit, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200388 struct tracer *next;
389 int print_max;
Ingo Molnar9de36822009-03-06 17:52:03 +0100390 struct tracer_flags *flags;
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800391 struct tracer_stat *stats;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200392};
393
Steven Rostedt214023c2008-05-12 21:20:46 +0200394struct trace_seq {
395 unsigned char buffer[PAGE_SIZE];
396 unsigned int len;
Pekka Paalanen6c6c2792008-05-12 21:21:02 +0200397 unsigned int readpos;
Steven Rostedt214023c2008-05-12 21:20:46 +0200398};
399
Steven Rostedtf9520752009-03-02 14:04:40 -0500400static inline void
401trace_seq_init(struct trace_seq *s)
402{
403 s->len = 0;
404 s->readpos = 0;
405}
406
407
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100408#define TRACE_PIPE_ALL_CPU -1
409
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200410/*
411 * Trace iterator - used by printout routines who present trace
412 * results to users and which routines might sleep, etc:
413 */
414struct trace_iterator {
415 struct trace_array *tr;
416 struct tracer *trace;
Steven Rostedt107bad82008-05-12 21:21:01 +0200417 void *private;
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100418 int cpu_file;
Frederic Weisbeckerd7350c3f2009-02-25 06:13:16 +0100419 struct mutex mutex;
420 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200421
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200422 /* The below is zeroed out in pipe_read */
423 struct trace_seq seq;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200424 struct trace_entry *ent;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200425 int cpu;
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400426 u64 ts;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200427
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200428 unsigned long iter_flags;
429 loff_t pos;
Steven Rostedt4c11d7a2008-05-12 21:20:43 +0200430 long idx;
Steven Rostedta3097202008-11-07 22:36:02 -0500431
Rusty Russell44623442009-01-01 10:12:23 +1030432 cpumask_var_t started;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200433};
434
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200435int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500436int tracing_is_enabled(void);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300437void trace_wake_up(void);
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400438void tracing_reset(struct trace_array *tr, int cpu);
Pekka J Enberg213cc062008-12-19 12:08:39 +0200439void tracing_reset_online_cpus(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200440int tracing_open_generic(struct inode *inode, struct file *filp);
441struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200442void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
443
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200444struct ring_buffer_event;
445
446struct ring_buffer_event *trace_buffer_lock_reserve(struct trace_array *tr,
447 unsigned char type,
448 unsigned long len,
449 unsigned long flags,
450 int pc);
451void trace_buffer_unlock_commit(struct trace_array *tr,
452 struct ring_buffer_event *event,
453 unsigned long flags, int pc);
454
Steven Rostedtef5580d2009-02-27 19:38:04 -0500455struct ring_buffer_event *
456trace_current_buffer_lock_reserve(unsigned char type, unsigned long len,
457 unsigned long flags, int pc);
458void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
459 unsigned long flags, int pc);
460
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300461struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
462 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200463
464struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
465 int *ent_cpu, u64 *ent_ts);
466
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300467void tracing_generic_entry_update(struct trace_entry *entry,
Steven Rostedt38697052008-10-01 13:14:09 -0400468 unsigned long flags,
469 int pc);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300470
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100471void default_wait_pipe(struct trace_iterator *iter);
472void poll_wait_pipe(struct trace_iterator *iter);
473
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200474void ftrace(struct trace_array *tr,
475 struct trace_array_cpu *data,
476 unsigned long ip,
477 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400478 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200479void tracing_sched_switch_trace(struct trace_array *tr,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200480 struct task_struct *prev,
481 struct task_struct *next,
Steven Rostedt38697052008-10-01 13:14:09 -0400482 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200483void tracing_record_cmdline(struct task_struct *tsk);
Ingo Molnar57422792008-05-12 21:20:51 +0200484
485void tracing_sched_wakeup_trace(struct trace_array *tr,
Ingo Molnar57422792008-05-12 21:20:51 +0200486 struct task_struct *wakee,
487 struct task_struct *cur,
Steven Rostedt38697052008-10-01 13:14:09 -0400488 unsigned long flags, int pc);
Ingo Molnarf0a920d2008-05-12 21:20:47 +0200489void trace_special(struct trace_array *tr,
490 struct trace_array_cpu *data,
491 unsigned long arg1,
492 unsigned long arg2,
Steven Rostedt38697052008-10-01 13:14:09 -0400493 unsigned long arg3, int pc);
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200494void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200495 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 +0200498
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100499void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500500int trace_graph_entry(struct ftrace_graph_ent *trace);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100501
Steven Rostedt41bc8142008-05-22 11:49:22 -0400502void tracing_start_cmdline_record(void);
503void tracing_stop_cmdline_record(void);
Steven Rostedte168e052008-11-07 22:36:02 -0500504void tracing_sched_switch_assign_trace(struct trace_array *tr);
505void tracing_stop_sched_switch_record(void);
506void tracing_start_sched_switch_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200507int register_tracer(struct tracer *type);
508void unregister_tracer(struct tracer *type);
509
510extern unsigned long nsecs_to_usecs(unsigned long nsecs);
511
512extern unsigned long tracing_max_latency;
513extern unsigned long tracing_thresh;
514
515void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
516void update_max_tr_single(struct trace_array *tr,
517 struct task_struct *tsk, int cpu);
518
Steven Rostedt53614992009-01-15 19:12:40 -0500519void __trace_stack(struct trace_array *tr,
Steven Rostedt53614992009-01-15 19:12:40 -0500520 unsigned long flags,
521 int skip, int pc);
522
Ingo Molnare309b412008-05-12 21:20:51 +0200523extern cycle_t ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200524
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200525#ifdef CONFIG_CONTEXT_SWITCH_TRACER
526typedef void
527(*tracer_switch_func_t)(void *private,
Mathieu Desnoyers5b82a1b2008-05-12 21:21:10 +0200528 void *__rq,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200529 struct task_struct *prev,
530 struct task_struct *next);
531
532struct tracer_switch_ops {
533 tracer_switch_func_t func;
534 void *private;
535 struct tracer_switch_ops *next;
536};
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200537#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
538
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100539extern char *trace_find_cmdline(int pid);
540
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200541#ifdef CONFIG_DYNAMIC_FTRACE
542extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200543#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
544extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200545#endif
546
Steven Rostedt60a11772008-05-12 21:20:44 +0200547#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200548extern int trace_selftest_startup_function(struct tracer *trace,
549 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100550extern int trace_selftest_startup_function_graph(struct tracer *trace,
551 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200552extern int trace_selftest_startup_irqsoff(struct tracer *trace,
553 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200554extern int trace_selftest_startup_preemptoff(struct tracer *trace,
555 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200556extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
557 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200558extern int trace_selftest_startup_wakeup(struct tracer *trace,
559 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700560extern int trace_selftest_startup_nop(struct tracer *trace,
561 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200562extern int trace_selftest_startup_sched_switch(struct tracer *trace,
563 struct trace_array *tr);
Ingo Molnara6dd24f2008-05-12 21:20:47 +0200564extern int trace_selftest_startup_sysprof(struct tracer *trace,
565 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500566extern int trace_selftest_startup_branch(struct tracer *trace,
567 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200568#endif /* CONFIG_FTRACE_STARTUP_TEST */
569
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200570extern void *head_page(struct trace_array_cpu *data);
Thomas Gleixner72829bc2008-05-23 21:37:28 +0200571extern long ns2usecs(cycle_t nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100572extern int
573trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200574
Ingo Molnar4e655512008-05-12 21:20:52 +0200575extern unsigned long trace_flags;
576
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100577/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100578#ifdef CONFIG_FUNCTION_GRAPH_TRACER
579extern enum print_line_t print_graph_function(struct trace_iterator *iter);
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500580
581#ifdef CONFIG_DYNAMIC_FTRACE
582/* TODO: make this variable */
583#define FTRACE_GRAPH_MAX_FUNCS 32
584extern int ftrace_graph_count;
585extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
586
587static inline int ftrace_graph_addr(unsigned long addr)
588{
589 int i;
590
591 if (!ftrace_graph_count || test_tsk_trace_graph(current))
592 return 1;
593
594 for (i = 0; i < ftrace_graph_count; i++) {
595 if (addr == ftrace_graph_funcs[i])
596 return 1;
597 }
598
599 return 0;
600}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100601#else
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500602static inline int ftrace_trace_addr(unsigned long addr)
603{
Ingo Molnar6b253932008-12-04 09:18:28 +0100604 return 1;
605}
606static inline int ftrace_graph_addr(unsigned long addr)
607{
608 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500609}
610#endif /* CONFIG_DYNAMIC_FTRACE */
611
612#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100613static inline enum print_line_t
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100614print_graph_function(struct trace_iterator *iter)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100615{
616 return TRACE_TYPE_UNHANDLED;
617}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500618#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100619
Steven Rostedt978f3a42008-12-04 00:26:40 -0500620extern struct pid *ftrace_pid_trace;
Steven Rostedt804a6852008-12-03 15:36:59 -0500621
622static inline int ftrace_trace_task(struct task_struct *task)
623{
Frederic Weisbecker77d683f2008-12-04 23:49:47 +0100624 if (!ftrace_pid_trace)
Steven Rostedt804a6852008-12-03 15:36:59 -0500625 return 1;
626
627 return test_tsk_trace_trace(task);
628}
629
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200630/*
631 * trace_iterator_flags is an enumeration that defines bit
632 * positions into trace_flags that controls the output.
633 *
634 * NOTE: These bits must match the trace_options array in
635 * trace.c.
636 */
Ingo Molnar4e655512008-05-12 21:20:52 +0200637enum trace_iterator_flags {
638 TRACE_ITER_PRINT_PARENT = 0x01,
639 TRACE_ITER_SYM_OFFSET = 0x02,
640 TRACE_ITER_SYM_ADDR = 0x04,
641 TRACE_ITER_VERBOSE = 0x08,
642 TRACE_ITER_RAW = 0x10,
643 TRACE_ITER_HEX = 0x20,
644 TRACE_ITER_BIN = 0x40,
645 TRACE_ITER_BLOCK = 0x80,
646 TRACE_ITER_STACKTRACE = 0x100,
Ingo Molnar4ac3ba42008-05-12 21:20:52 +0200647 TRACE_ITER_SCHED_TREE = 0x200,
Peter Zijlstraf09ce572008-09-04 10:24:14 +0200648 TRACE_ITER_PRINTK = 0x400,
Steven Rostedtb2a866f2008-11-03 23:15:57 -0500649 TRACE_ITER_PREEMPTONLY = 0x800,
Steven Rostedt9f029e82008-11-12 15:24:24 -0500650 TRACE_ITER_BRANCH = 0x1000,
Steven Rostedt12ef7d42008-11-12 17:52:38 -0500651 TRACE_ITER_ANNOTATE = 0x2000,
Török Edwinb54d3de2008-11-22 13:28:48 +0200652 TRACE_ITER_USERSTACKTRACE = 0x4000,
Frederic Weisbecker66896a82008-12-13 20:18:13 +0100653 TRACE_ITER_SYM_USEROBJ = 0x8000,
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200654 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
Steven Rostedtc032ef642009-03-04 20:34:24 -0500655 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
656 TRACE_ITER_LATENCY_FMT = 0x40000,
Ingo Molnar4e655512008-05-12 21:20:52 +0200657};
658
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100659/*
660 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
661 * control the output of kernel symbols.
662 */
663#define TRACE_ITER_SYM_MASK \
664 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
665
Frédéric Weisbecker43a15382008-09-21 20:16:30 +0200666extern struct tracer nop_trace;
667
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500668/**
669 * ftrace_preempt_disable - disable preemption scheduler safe
670 *
671 * When tracing can happen inside the scheduler, there exists
672 * cases that the tracing might happen before the need_resched
673 * flag is checked. If this happens and the tracer calls
674 * preempt_enable (after a disable), a schedule might take place
675 * causing an infinite recursion.
676 *
Wenji Huang57794a92009-02-06 17:33:27 +0800677 * To prevent this, we read the need_resched flag before
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500678 * disabling preemption. When we want to enable preemption we
679 * check the flag, if it is set, then we call preempt_enable_no_resched.
680 * Otherwise, we call preempt_enable.
681 *
Wenji Huang57794a92009-02-06 17:33:27 +0800682 * The rational for doing the above is that if need_resched is set
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500683 * and we have yet to reschedule, we are either in an atomic location
684 * (where we do not need to check for scheduling) or we are inside
685 * the scheduler and do not want to resched.
686 */
687static inline int ftrace_preempt_disable(void)
688{
689 int resched;
690
691 resched = need_resched();
692 preempt_disable_notrace();
693
694 return resched;
695}
696
697/**
698 * ftrace_preempt_enable - enable preemption scheduler safe
699 * @resched: the return value from ftrace_preempt_disable
700 *
701 * This is a scheduler safe way to enable preemption and not miss
702 * any preemption checks. The disabled saved the state of preemption.
Wenji Huang57794a92009-02-06 17:33:27 +0800703 * If resched is set, then we are either inside an atomic or
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500704 * are inside the scheduler (we would have already scheduled
705 * otherwise). In this case, we do not want to call normal
706 * preempt_enable, but preempt_enable_no_resched instead.
707 */
708static inline void ftrace_preempt_enable(int resched)
709{
710 if (resched)
711 preempt_enable_no_resched_notrace();
712 else
713 preempt_enable_notrace();
714}
715
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500716#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -0500717extern int enable_branch_tracing(struct trace_array *tr);
718extern void disable_branch_tracing(void);
719static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500720{
Steven Rostedt9f029e82008-11-12 15:24:24 -0500721 if (trace_flags & TRACE_ITER_BRANCH)
722 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -0500723 return 0;
724}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500725static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500726{
727 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -0500728 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -0500729}
730#else
Steven Rostedt9f029e82008-11-12 15:24:24 -0500731static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500732{
733 return 0;
734}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500735static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500736{
737}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500738#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -0500739
Steven Rostedtfd994982009-02-28 02:41:25 -0500740/* trace event type bit fields, not numeric */
741enum {
742 TRACE_EVENT_TYPE_PRINTF = 1,
743 TRACE_EVENT_TYPE_RAW = 2,
744};
745
Steven Rostedtc32e8272009-02-27 19:12:30 -0500746struct ftrace_event_call {
747 char *name;
748 char *system;
749 struct dentry *dir;
750 int enabled;
751 int (*regfunc)(void);
752 void (*unregfunc)(void);
753 int id;
754 struct dentry *raw_dir;
755 int raw_enabled;
Steven Rostedtfd994982009-02-28 02:41:25 -0500756 int type;
Steven Rostedtc32e8272009-02-27 19:12:30 -0500757 int (*raw_init)(void);
758 int (*raw_reg)(void);
759 void (*raw_unreg)(void);
Steven Rostedt981d0812009-03-02 13:53:59 -0500760 int (*show_format)(struct trace_seq *s);
Steven Rostedtc32e8272009-02-27 19:12:30 -0500761};
762
763void event_trace_printk(unsigned long ip, const char *fmt, ...);
764extern struct ftrace_event_call __start_ftrace_events[];
765extern struct ftrace_event_call __stop_ftrace_events[];
766
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200767#endif /* _LINUX_KERNEL_TRACE_H */