blob: 6140922392c8a5caac6d83a4dcd471b9f237d80f [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;
Frederic Weisbecker769b0442009-03-06 17:21:49 +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;
125 u32 buf[];
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100126};
127#ifdef CONFIG_TRACE_BPRINTK
128extern int trace_bprintk_enable;
129#endif
130
Steven Rostedt777e2082008-09-29 23:02:42 -0400131#define TRACE_OLD_SIZE 88
132
133struct trace_field_cont {
134 unsigned char type;
135 /* Temporary till we get rid of this completely */
136 char buf[TRACE_OLD_SIZE - 1];
137};
138
139struct trace_mmiotrace_rw {
140 struct trace_entry ent;
141 struct mmiotrace_rw rw;
142};
143
144struct trace_mmiotrace_map {
145 struct trace_entry ent;
146 struct mmiotrace_map map;
147};
148
Frederic Weisbecker74239072008-11-11 23:24:42 +0100149struct trace_boot_call {
Steven Rostedt777e2082008-09-29 23:02:42 -0400150 struct trace_entry ent;
Frederic Weisbecker74239072008-11-11 23:24:42 +0100151 struct boot_trace_call boot_call;
152};
153
154struct trace_boot_ret {
155 struct trace_entry ent;
156 struct boot_trace_ret boot_ret;
Steven Rostedt777e2082008-09-29 23:02:42 -0400157};
158
Steven Rostedt52f232c2008-11-12 00:14:40 -0500159#define TRACE_FUNC_SIZE 30
160#define TRACE_FILE_SIZE 20
Steven Rostedt9f029e82008-11-12 15:24:24 -0500161struct trace_branch {
Steven Rostedt52f232c2008-11-12 00:14:40 -0500162 struct trace_entry ent;
163 unsigned line;
164 char func[TRACE_FUNC_SIZE+1];
165 char file[TRACE_FILE_SIZE+1];
166 char correct;
167};
168
Markus Metzgera93751c2008-12-11 13:53:26 +0100169struct hw_branch_entry {
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100170 struct trace_entry ent;
Markus Metzgera93751c2008-12-11 13:53:26 +0100171 u64 from;
172 u64 to;
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100173};
174
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800175struct trace_power {
176 struct trace_entry ent;
177 struct power_trace state_data;
178};
179
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800180struct kmemtrace_alloc_entry {
181 struct trace_entry ent;
182 enum kmemtrace_type_id type_id;
183 unsigned long call_site;
184 const void *ptr;
185 size_t bytes_req;
186 size_t bytes_alloc;
187 gfp_t gfp_flags;
188 int node;
189};
190
191struct kmemtrace_free_entry {
192 struct trace_entry ent;
193 enum kmemtrace_type_id type_id;
194 unsigned long call_site;
195 const void *ptr;
196};
197
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400198/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300199 * trace_flag_type is an enumeration that holds different
200 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400201 * IRQS_OFF - interrupts were disabled
202 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
203 * NEED_RESCED - reschedule is requested
204 * HARDIRQ - inside an interrupt handler
205 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300206 */
207enum trace_flag_type {
208 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400209 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
210 TRACE_FLAG_NEED_RESCHED = 0x04,
211 TRACE_FLAG_HARDIRQ = 0x08,
212 TRACE_FLAG_SOFTIRQ = 0x10,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300213};
214
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300215#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200216
217/*
218 * The CPU trace array - it consists of thousands of trace entries
219 * plus some other descriptor data: (for example which task started
220 * the trace, etc.)
221 */
222struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200223 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500224 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200225
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200226 /* these fields get copied into max-trace: */
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200227 unsigned long trace_idx;
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200228 unsigned long overrun;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200229 unsigned long saved_latency;
230 unsigned long critical_start;
231 unsigned long critical_end;
232 unsigned long critical_sequence;
233 unsigned long nice;
234 unsigned long policy;
235 unsigned long rt_priority;
236 cycle_t preempt_timestamp;
237 pid_t pid;
238 uid_t uid;
239 char comm[TASK_COMM_LEN];
240};
241
242struct trace_iterator;
243
244/*
245 * The trace array - an array of per-CPU trace arrays. This is the
246 * highest level data structure that individual tracers deal with.
247 * They have on/off state as well:
248 */
249struct trace_array {
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400250 struct ring_buffer *buffer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200251 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200252 int cpu;
253 cycle_t time_start;
Steven Rostedtb3806b42008-05-12 21:20:46 +0200254 struct task_struct *waiter;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200255 struct trace_array_cpu *data[NR_CPUS];
256};
257
Steven Rostedt7104f302008-10-01 10:52:51 -0400258#define FTRACE_CMP_TYPE(var, type) \
259 __builtin_types_compatible_p(typeof(var), type *)
260
261#undef IF_ASSIGN
262#define IF_ASSIGN(var, entry, etype, id) \
263 if (FTRACE_CMP_TYPE(var, etype)) { \
264 var = (typeof(var))(entry); \
265 WARN_ON(id && (entry)->type != id); \
266 break; \
267 }
268
269/* Will cause compile errors if type is not found. */
270extern void __ftrace_bad_type(void);
271
272/*
273 * The trace_assign_type is a verifier that the entry type is
274 * the same as the type being assigned. To add new types simply
275 * add a line with the following format:
276 *
277 * IF_ASSIGN(var, ent, type, id);
278 *
279 * Where "type" is the trace type that includes the trace_entry
280 * as the "ent" item. And "id" is the trace identifier that is
281 * used in the trace_type enum.
282 *
283 * If the type can have more than one id, then use zero.
284 */
285#define trace_assign_type(var, ent) \
286 do { \
287 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
288 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400289 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200290 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400291 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
292 IF_ASSIGN(var, ent, struct special_entry, 0); \
293 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
294 TRACE_MMIO_RW); \
295 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
296 TRACE_MMIO_MAP); \
Frederic Weisbecker74239072008-11-11 23:24:42 +0100297 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
298 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
Steven Rostedt9f029e82008-11-12 15:24:24 -0500299 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100300 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
301 TRACE_GRAPH_ENT); \
302 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
303 TRACE_GRAPH_RET); \
Markus Metzgera93751c2008-12-11 13:53:26 +0100304 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800305 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800306 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
307 TRACE_KMEM_ALLOC); \
308 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
309 TRACE_KMEM_FREE); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400310 __ftrace_bad_type(); \
311 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200312
313/* Return values for print_line callback */
314enum print_line_t {
315 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
316 TRACE_TYPE_HANDLED = 1,
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +0100317 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
318 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200319};
320
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100321
322/*
323 * An option specific to a tracer. This is a boolean value.
324 * The bit is the bit index that sets its value on the
325 * flags value in struct tracer_flags.
326 */
327struct tracer_opt {
328 const char *name; /* Will appear on the trace_options file */
329 u32 bit; /* Mask assigned in val field in tracer_flags */
330};
331
332/*
333 * The set of specific options for a tracer. Your tracer
334 * have to set the initial value of the flags val.
335 */
336struct tracer_flags {
337 u32 val;
338 struct tracer_opt *opts;
339};
340
341/* Makes more easy to define a tracer opt */
342#define TRACER_OPT(s, b) .name = #s, .bit = b
343
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800344
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100345/**
346 * struct tracer - a specific tracer and its callbacks to interact with debugfs
347 * @name: the name chosen to select it on the available_tracers file
348 * @init: called when one switches to this tracer (echo name > current_tracer)
349 * @reset: called when one switches to another tracer
350 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
351 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
352 * @open: called when the trace file is opened
353 * @pipe_open: called when the trace_pipe file is opened
354 * @wait_pipe: override how the user waits for traces on trace_pipe
355 * @close: called when the trace file is released
356 * @read: override the default read callback on trace_pipe
357 * @splice_read: override the default splice_read callback on trace_pipe
358 * @selftest: selftest to run on boot (see trace_selftest.c)
359 * @print_headers: override the first lines that describe your columns
360 * @print_line: callback that prints a trace
361 * @set_flag: signals one of your private flags changed (trace_options file)
362 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200363 */
364struct tracer {
365 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100366 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200367 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500368 void (*start)(struct trace_array *tr);
369 void (*stop)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200370 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200371 void (*pipe_open)(struct trace_iterator *iter);
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100372 void (*wait_pipe)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200373 void (*close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200374 ssize_t (*read)(struct trace_iterator *iter,
375 struct file *filp, char __user *ubuf,
376 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200377 ssize_t (*splice_read)(struct trace_iterator *iter,
378 struct file *filp,
379 loff_t *ppos,
380 struct pipe_inode_info *pipe,
381 size_t len,
382 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200383#ifdef CONFIG_FTRACE_STARTUP_TEST
384 int (*selftest)(struct tracer *trace,
385 struct trace_array *tr);
386#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100387 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200388 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100389 /* If you handled the flag setting, return 0 */
390 int (*set_flag)(u32 old_flags, u32 bit, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200391 struct tracer *next;
392 int print_max;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100393 struct tracer_flags *flags;
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800394 struct tracer_stat *stats;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200395};
396
Steven Rostedt214023c2008-05-12 21:20:46 +0200397struct trace_seq {
398 unsigned char buffer[PAGE_SIZE];
399 unsigned int len;
Pekka Paalanen6c6c2792008-05-12 21:21:02 +0200400 unsigned int readpos;
Steven Rostedt214023c2008-05-12 21:20:46 +0200401};
402
Steven Rostedtf9520752009-03-02 14:04:40 -0500403static inline void
404trace_seq_init(struct trace_seq *s)
405{
406 s->len = 0;
407 s->readpos = 0;
408}
409
410
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100411#define TRACE_PIPE_ALL_CPU -1
412
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200413/*
414 * Trace iterator - used by printout routines who present trace
415 * results to users and which routines might sleep, etc:
416 */
417struct trace_iterator {
418 struct trace_array *tr;
419 struct tracer *trace;
Steven Rostedt107bad82008-05-12 21:21:01 +0200420 void *private;
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100421 int cpu_file;
Frederic Weisbeckerd7350c3f2009-02-25 06:13:16 +0100422 struct mutex mutex;
423 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200424
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200425 /* The below is zeroed out in pipe_read */
426 struct trace_seq seq;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200427 struct trace_entry *ent;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200428 int cpu;
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400429 u64 ts;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200430
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200431 unsigned long iter_flags;
432 loff_t pos;
Steven Rostedt4c11d7a2008-05-12 21:20:43 +0200433 long idx;
Steven Rostedta3097202008-11-07 22:36:02 -0500434
Rusty Russell44623442009-01-01 10:12:23 +1030435 cpumask_var_t started;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200436};
437
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200438int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500439int tracing_is_enabled(void);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300440void trace_wake_up(void);
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400441void tracing_reset(struct trace_array *tr, int cpu);
Pekka J Enberg213cc062008-12-19 12:08:39 +0200442void tracing_reset_online_cpus(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200443int tracing_open_generic(struct inode *inode, struct file *filp);
444struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200445void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
446
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200447struct ring_buffer_event;
448
449struct ring_buffer_event *trace_buffer_lock_reserve(struct trace_array *tr,
450 unsigned char type,
451 unsigned long len,
452 unsigned long flags,
453 int pc);
454void trace_buffer_unlock_commit(struct trace_array *tr,
455 struct ring_buffer_event *event,
456 unsigned long flags, int pc);
457
Steven Rostedtef5580d2009-02-27 19:38:04 -0500458struct ring_buffer_event *
459trace_current_buffer_lock_reserve(unsigned char type, unsigned long len,
460 unsigned long flags, int pc);
461void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
462 unsigned long flags, int pc);
463
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300464struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
465 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200466
467struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
468 int *ent_cpu, u64 *ent_ts);
469
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300470void tracing_generic_entry_update(struct trace_entry *entry,
Steven Rostedt38697052008-10-01 13:14:09 -0400471 unsigned long flags,
472 int pc);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300473
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100474void default_wait_pipe(struct trace_iterator *iter);
475void poll_wait_pipe(struct trace_iterator *iter);
476
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200477void ftrace(struct trace_array *tr,
478 struct trace_array_cpu *data,
479 unsigned long ip,
480 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400481 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200482void tracing_sched_switch_trace(struct trace_array *tr,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200483 struct task_struct *prev,
484 struct task_struct *next,
Steven Rostedt38697052008-10-01 13:14:09 -0400485 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200486void tracing_record_cmdline(struct task_struct *tsk);
Ingo Molnar57422792008-05-12 21:20:51 +0200487
488void tracing_sched_wakeup_trace(struct trace_array *tr,
Ingo Molnar57422792008-05-12 21:20:51 +0200489 struct task_struct *wakee,
490 struct task_struct *cur,
Steven Rostedt38697052008-10-01 13:14:09 -0400491 unsigned long flags, int pc);
Ingo Molnarf0a920d2008-05-12 21:20:47 +0200492void trace_special(struct trace_array *tr,
493 struct trace_array_cpu *data,
494 unsigned long arg1,
495 unsigned long arg2,
Steven Rostedt38697052008-10-01 13:14:09 -0400496 unsigned long arg3, int pc);
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200497void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200498 unsigned long ip,
499 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400500 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200501
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100502void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500503int trace_graph_entry(struct ftrace_graph_ent *trace);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100504
Steven Rostedt41bc8142008-05-22 11:49:22 -0400505void tracing_start_cmdline_record(void);
506void tracing_stop_cmdline_record(void);
Steven Rostedte168e052008-11-07 22:36:02 -0500507void tracing_sched_switch_assign_trace(struct trace_array *tr);
508void tracing_stop_sched_switch_record(void);
509void tracing_start_sched_switch_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200510int register_tracer(struct tracer *type);
511void unregister_tracer(struct tracer *type);
512
513extern unsigned long nsecs_to_usecs(unsigned long nsecs);
514
515extern unsigned long tracing_max_latency;
516extern unsigned long tracing_thresh;
517
518void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
519void update_max_tr_single(struct trace_array *tr,
520 struct task_struct *tsk, int cpu);
521
Steven Rostedt53614992009-01-15 19:12:40 -0500522void __trace_stack(struct trace_array *tr,
Steven Rostedt53614992009-01-15 19:12:40 -0500523 unsigned long flags,
524 int skip, int pc);
525
Ingo Molnare309b412008-05-12 21:20:51 +0200526extern cycle_t ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200527
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200528#ifdef CONFIG_CONTEXT_SWITCH_TRACER
529typedef void
530(*tracer_switch_func_t)(void *private,
Mathieu Desnoyers5b82a1b2008-05-12 21:21:10 +0200531 void *__rq,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200532 struct task_struct *prev,
533 struct task_struct *next);
534
535struct tracer_switch_ops {
536 tracer_switch_func_t func;
537 void *private;
538 struct tracer_switch_ops *next;
539};
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200540#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
541
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100542extern char *trace_find_cmdline(int pid);
543
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200544#ifdef CONFIG_DYNAMIC_FTRACE
545extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200546#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
547extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200548#endif
549
Steven Rostedt60a11772008-05-12 21:20:44 +0200550#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200551extern int trace_selftest_startup_function(struct tracer *trace,
552 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100553extern int trace_selftest_startup_function_graph(struct tracer *trace,
554 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200555extern int trace_selftest_startup_irqsoff(struct tracer *trace,
556 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200557extern int trace_selftest_startup_preemptoff(struct tracer *trace,
558 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200559extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
560 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200561extern int trace_selftest_startup_wakeup(struct tracer *trace,
562 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700563extern int trace_selftest_startup_nop(struct tracer *trace,
564 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200565extern int trace_selftest_startup_sched_switch(struct tracer *trace,
566 struct trace_array *tr);
Ingo Molnara6dd24f2008-05-12 21:20:47 +0200567extern int trace_selftest_startup_sysprof(struct tracer *trace,
568 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500569extern int trace_selftest_startup_branch(struct tracer *trace,
570 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200571#endif /* CONFIG_FTRACE_STARTUP_TEST */
572
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200573extern void *head_page(struct trace_array_cpu *data);
Thomas Gleixner72829bc2008-05-23 21:37:28 +0200574extern long ns2usecs(cycle_t nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100575extern int
576trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200577
Ingo Molnar4e655512008-05-12 21:20:52 +0200578extern unsigned long trace_flags;
579
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100580/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100581#ifdef CONFIG_FUNCTION_GRAPH_TRACER
582extern enum print_line_t print_graph_function(struct trace_iterator *iter);
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500583
584#ifdef CONFIG_DYNAMIC_FTRACE
585/* TODO: make this variable */
586#define FTRACE_GRAPH_MAX_FUNCS 32
587extern int ftrace_graph_count;
588extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
589
590static inline int ftrace_graph_addr(unsigned long addr)
591{
592 int i;
593
594 if (!ftrace_graph_count || test_tsk_trace_graph(current))
595 return 1;
596
597 for (i = 0; i < ftrace_graph_count; i++) {
598 if (addr == ftrace_graph_funcs[i])
599 return 1;
600 }
601
602 return 0;
603}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100604#else
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500605static inline int ftrace_trace_addr(unsigned long addr)
606{
Ingo Molnar6b253932008-12-04 09:18:28 +0100607 return 1;
608}
609static inline int ftrace_graph_addr(unsigned long addr)
610{
611 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500612}
613#endif /* CONFIG_DYNAMIC_FTRACE */
614
615#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100616static inline enum print_line_t
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100617print_graph_function(struct trace_iterator *iter)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100618{
619 return TRACE_TYPE_UNHANDLED;
620}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500621#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100622
Steven Rostedt978f3a42008-12-04 00:26:40 -0500623extern struct pid *ftrace_pid_trace;
Steven Rostedt804a6852008-12-03 15:36:59 -0500624
625static inline int ftrace_trace_task(struct task_struct *task)
626{
Frederic Weisbecker77d683f2008-12-04 23:49:47 +0100627 if (!ftrace_pid_trace)
Steven Rostedt804a6852008-12-03 15:36:59 -0500628 return 1;
629
630 return test_tsk_trace_trace(task);
631}
632
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200633/*
634 * trace_iterator_flags is an enumeration that defines bit
635 * positions into trace_flags that controls the output.
636 *
637 * NOTE: These bits must match the trace_options array in
638 * trace.c.
639 */
Ingo Molnar4e655512008-05-12 21:20:52 +0200640enum trace_iterator_flags {
641 TRACE_ITER_PRINT_PARENT = 0x01,
642 TRACE_ITER_SYM_OFFSET = 0x02,
643 TRACE_ITER_SYM_ADDR = 0x04,
644 TRACE_ITER_VERBOSE = 0x08,
645 TRACE_ITER_RAW = 0x10,
646 TRACE_ITER_HEX = 0x20,
647 TRACE_ITER_BIN = 0x40,
648 TRACE_ITER_BLOCK = 0x80,
649 TRACE_ITER_STACKTRACE = 0x100,
Ingo Molnar4ac3ba42008-05-12 21:20:52 +0200650 TRACE_ITER_SCHED_TREE = 0x200,
Peter Zijlstraf09ce572008-09-04 10:24:14 +0200651 TRACE_ITER_PRINTK = 0x400,
Steven Rostedtb2a866f2008-11-03 23:15:57 -0500652 TRACE_ITER_PREEMPTONLY = 0x800,
Steven Rostedt9f029e82008-11-12 15:24:24 -0500653 TRACE_ITER_BRANCH = 0x1000,
Steven Rostedt12ef7d42008-11-12 17:52:38 -0500654 TRACE_ITER_ANNOTATE = 0x2000,
Török Edwinb54d3de2008-11-22 13:28:48 +0200655 TRACE_ITER_USERSTACKTRACE = 0x4000,
Frederic Weisbecker66896a82008-12-13 20:18:13 +0100656 TRACE_ITER_SYM_USEROBJ = 0x8000,
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200657 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
Steven Rostedtc032ef642009-03-04 20:34:24 -0500658 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
659 TRACE_ITER_LATENCY_FMT = 0x40000,
Ingo Molnar4e655512008-05-12 21:20:52 +0200660};
661
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100662/*
663 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
664 * control the output of kernel symbols.
665 */
666#define TRACE_ITER_SYM_MASK \
667 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
668
Frédéric Weisbecker43a15382008-09-21 20:16:30 +0200669extern struct tracer nop_trace;
670
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500671/**
672 * ftrace_preempt_disable - disable preemption scheduler safe
673 *
674 * When tracing can happen inside the scheduler, there exists
675 * cases that the tracing might happen before the need_resched
676 * flag is checked. If this happens and the tracer calls
677 * preempt_enable (after a disable), a schedule might take place
678 * causing an infinite recursion.
679 *
Wenji Huang57794a92009-02-06 17:33:27 +0800680 * To prevent this, we read the need_resched flag before
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500681 * disabling preemption. When we want to enable preemption we
682 * check the flag, if it is set, then we call preempt_enable_no_resched.
683 * Otherwise, we call preempt_enable.
684 *
Wenji Huang57794a92009-02-06 17:33:27 +0800685 * The rational for doing the above is that if need_resched is set
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500686 * and we have yet to reschedule, we are either in an atomic location
687 * (where we do not need to check for scheduling) or we are inside
688 * the scheduler and do not want to resched.
689 */
690static inline int ftrace_preempt_disable(void)
691{
692 int resched;
693
694 resched = need_resched();
695 preempt_disable_notrace();
696
697 return resched;
698}
699
700/**
701 * ftrace_preempt_enable - enable preemption scheduler safe
702 * @resched: the return value from ftrace_preempt_disable
703 *
704 * This is a scheduler safe way to enable preemption and not miss
705 * any preemption checks. The disabled saved the state of preemption.
Wenji Huang57794a92009-02-06 17:33:27 +0800706 * If resched is set, then we are either inside an atomic or
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500707 * are inside the scheduler (we would have already scheduled
708 * otherwise). In this case, we do not want to call normal
709 * preempt_enable, but preempt_enable_no_resched instead.
710 */
711static inline void ftrace_preempt_enable(int resched)
712{
713 if (resched)
714 preempt_enable_no_resched_notrace();
715 else
716 preempt_enable_notrace();
717}
718
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500719#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -0500720extern int enable_branch_tracing(struct trace_array *tr);
721extern void disable_branch_tracing(void);
722static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500723{
Steven Rostedt9f029e82008-11-12 15:24:24 -0500724 if (trace_flags & TRACE_ITER_BRANCH)
725 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -0500726 return 0;
727}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500728static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500729{
730 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -0500731 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -0500732}
733#else
Steven Rostedt9f029e82008-11-12 15:24:24 -0500734static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500735{
736 return 0;
737}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500738static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500739{
740}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500741#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -0500742
Steven Rostedtfd994982009-02-28 02:41:25 -0500743/* trace event type bit fields, not numeric */
744enum {
745 TRACE_EVENT_TYPE_PRINTF = 1,
746 TRACE_EVENT_TYPE_RAW = 2,
747};
748
Steven Rostedtc32e8272009-02-27 19:12:30 -0500749struct ftrace_event_call {
750 char *name;
751 char *system;
752 struct dentry *dir;
753 int enabled;
754 int (*regfunc)(void);
755 void (*unregfunc)(void);
756 int id;
757 struct dentry *raw_dir;
758 int raw_enabled;
Steven Rostedtfd994982009-02-28 02:41:25 -0500759 int type;
Steven Rostedtc32e8272009-02-27 19:12:30 -0500760 int (*raw_init)(void);
761 int (*raw_reg)(void);
762 void (*raw_unreg)(void);
Steven Rostedt981d0812009-03-02 13:53:59 -0500763 int (*show_format)(struct trace_seq *s);
Steven Rostedtc32e8272009-02-27 19:12:30 -0500764};
765
766void event_trace_printk(unsigned long ip, const char *fmt, ...);
767extern struct ftrace_event_call __start_ftrace_events[];
768extern struct ftrace_event_call __stop_ftrace_events[];
769
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200770#endif /* _LINUX_KERNEL_TRACE_H */