blob: 12cd119cca3284de67ef87916b56fe17d5adf287 [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/*
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400118 * ftrace_printk entry:
119 */
120struct print_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400121 struct trace_entry ent;
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400122 unsigned long ip;
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100123 int depth;
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400124 char buf[];
125};
126
Steven Rostedt777e2082008-09-29 23:02:42 -0400127#define TRACE_OLD_SIZE 88
128
129struct trace_field_cont {
130 unsigned char type;
131 /* Temporary till we get rid of this completely */
132 char buf[TRACE_OLD_SIZE - 1];
133};
134
135struct trace_mmiotrace_rw {
136 struct trace_entry ent;
137 struct mmiotrace_rw rw;
138};
139
140struct trace_mmiotrace_map {
141 struct trace_entry ent;
142 struct mmiotrace_map map;
143};
144
Frederic Weisbecker74239072008-11-11 23:24:42 +0100145struct trace_boot_call {
Steven Rostedt777e2082008-09-29 23:02:42 -0400146 struct trace_entry ent;
Frederic Weisbecker74239072008-11-11 23:24:42 +0100147 struct boot_trace_call boot_call;
148};
149
150struct trace_boot_ret {
151 struct trace_entry ent;
152 struct boot_trace_ret boot_ret;
Steven Rostedt777e2082008-09-29 23:02:42 -0400153};
154
Steven Rostedt52f232c2008-11-12 00:14:40 -0500155#define TRACE_FUNC_SIZE 30
156#define TRACE_FILE_SIZE 20
Steven Rostedt9f029e82008-11-12 15:24:24 -0500157struct trace_branch {
Steven Rostedt52f232c2008-11-12 00:14:40 -0500158 struct trace_entry ent;
159 unsigned line;
160 char func[TRACE_FUNC_SIZE+1];
161 char file[TRACE_FILE_SIZE+1];
162 char correct;
163};
164
Markus Metzgera93751c2008-12-11 13:53:26 +0100165struct hw_branch_entry {
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100166 struct trace_entry ent;
Markus Metzgera93751c2008-12-11 13:53:26 +0100167 u64 from;
168 u64 to;
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100169};
170
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800171struct trace_power {
172 struct trace_entry ent;
173 struct power_trace state_data;
174};
175
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800176struct kmemtrace_alloc_entry {
177 struct trace_entry ent;
178 enum kmemtrace_type_id type_id;
179 unsigned long call_site;
180 const void *ptr;
181 size_t bytes_req;
182 size_t bytes_alloc;
183 gfp_t gfp_flags;
184 int node;
185};
186
187struct kmemtrace_free_entry {
188 struct trace_entry ent;
189 enum kmemtrace_type_id type_id;
190 unsigned long call_site;
191 const void *ptr;
192};
193
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400194/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300195 * trace_flag_type is an enumeration that holds different
196 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400197 * IRQS_OFF - interrupts were disabled
198 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
199 * NEED_RESCED - reschedule is requested
200 * HARDIRQ - inside an interrupt handler
201 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300202 */
203enum trace_flag_type {
204 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400205 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
206 TRACE_FLAG_NEED_RESCHED = 0x04,
207 TRACE_FLAG_HARDIRQ = 0x08,
208 TRACE_FLAG_SOFTIRQ = 0x10,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300209};
210
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300211#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200212
213/*
214 * The CPU trace array - it consists of thousands of trace entries
215 * plus some other descriptor data: (for example which task started
216 * the trace, etc.)
217 */
218struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200219 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500220 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200221
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200222 /* these fields get copied into max-trace: */
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200223 unsigned long trace_idx;
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200224 unsigned long overrun;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200225 unsigned long saved_latency;
226 unsigned long critical_start;
227 unsigned long critical_end;
228 unsigned long critical_sequence;
229 unsigned long nice;
230 unsigned long policy;
231 unsigned long rt_priority;
232 cycle_t preempt_timestamp;
233 pid_t pid;
234 uid_t uid;
235 char comm[TASK_COMM_LEN];
236};
237
238struct trace_iterator;
239
240/*
241 * The trace array - an array of per-CPU trace arrays. This is the
242 * highest level data structure that individual tracers deal with.
243 * They have on/off state as well:
244 */
245struct trace_array {
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400246 struct ring_buffer *buffer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200247 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200248 int cpu;
249 cycle_t time_start;
Steven Rostedtb3806b42008-05-12 21:20:46 +0200250 struct task_struct *waiter;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200251 struct trace_array_cpu *data[NR_CPUS];
252};
253
Steven Rostedt7104f302008-10-01 10:52:51 -0400254#define FTRACE_CMP_TYPE(var, type) \
255 __builtin_types_compatible_p(typeof(var), type *)
256
257#undef IF_ASSIGN
258#define IF_ASSIGN(var, entry, etype, id) \
259 if (FTRACE_CMP_TYPE(var, etype)) { \
260 var = (typeof(var))(entry); \
261 WARN_ON(id && (entry)->type != id); \
262 break; \
263 }
264
265/* Will cause compile errors if type is not found. */
266extern void __ftrace_bad_type(void);
267
268/*
269 * The trace_assign_type is a verifier that the entry type is
270 * the same as the type being assigned. To add new types simply
271 * add a line with the following format:
272 *
273 * IF_ASSIGN(var, ent, type, id);
274 *
275 * Where "type" is the trace type that includes the trace_entry
276 * as the "ent" item. And "id" is the trace identifier that is
277 * used in the trace_type enum.
278 *
279 * If the type can have more than one id, then use zero.
280 */
281#define trace_assign_type(var, ent) \
282 do { \
283 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
284 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400285 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200286 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400287 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
288 IF_ASSIGN(var, ent, struct special_entry, 0); \
289 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
290 TRACE_MMIO_RW); \
291 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
292 TRACE_MMIO_MAP); \
Frederic Weisbecker74239072008-11-11 23:24:42 +0100293 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
294 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
Steven Rostedt9f029e82008-11-12 15:24:24 -0500295 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100296 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
297 TRACE_GRAPH_ENT); \
298 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
299 TRACE_GRAPH_RET); \
Markus Metzgera93751c2008-12-11 13:53:26 +0100300 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800301 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800302 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
303 TRACE_KMEM_ALLOC); \
304 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
305 TRACE_KMEM_FREE); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400306 __ftrace_bad_type(); \
307 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200308
309/* Return values for print_line callback */
310enum print_line_t {
311 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
312 TRACE_TYPE_HANDLED = 1,
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +0100313 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
314 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200315};
316
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100317
318/*
319 * An option specific to a tracer. This is a boolean value.
320 * The bit is the bit index that sets its value on the
321 * flags value in struct tracer_flags.
322 */
323struct tracer_opt {
324 const char *name; /* Will appear on the trace_options file */
325 u32 bit; /* Mask assigned in val field in tracer_flags */
326};
327
328/*
329 * The set of specific options for a tracer. Your tracer
330 * have to set the initial value of the flags val.
331 */
332struct tracer_flags {
333 u32 val;
334 struct tracer_opt *opts;
335};
336
337/* Makes more easy to define a tracer opt */
338#define TRACER_OPT(s, b) .name = #s, .bit = b
339
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800340
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100341/**
342 * struct tracer - a specific tracer and its callbacks to interact with debugfs
343 * @name: the name chosen to select it on the available_tracers file
344 * @init: called when one switches to this tracer (echo name > current_tracer)
345 * @reset: called when one switches to another tracer
346 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
347 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
348 * @open: called when the trace file is opened
349 * @pipe_open: called when the trace_pipe file is opened
350 * @wait_pipe: override how the user waits for traces on trace_pipe
351 * @close: called when the trace file is released
352 * @read: override the default read callback on trace_pipe
353 * @splice_read: override the default splice_read callback on trace_pipe
354 * @selftest: selftest to run on boot (see trace_selftest.c)
355 * @print_headers: override the first lines that describe your columns
356 * @print_line: callback that prints a trace
357 * @set_flag: signals one of your private flags changed (trace_options file)
358 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200359 */
360struct tracer {
361 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100362 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200363 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500364 void (*start)(struct trace_array *tr);
365 void (*stop)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200366 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200367 void (*pipe_open)(struct trace_iterator *iter);
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100368 void (*wait_pipe)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200369 void (*close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200370 ssize_t (*read)(struct trace_iterator *iter,
371 struct file *filp, char __user *ubuf,
372 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200373 ssize_t (*splice_read)(struct trace_iterator *iter,
374 struct file *filp,
375 loff_t *ppos,
376 struct pipe_inode_info *pipe,
377 size_t len,
378 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200379#ifdef CONFIG_FTRACE_STARTUP_TEST
380 int (*selftest)(struct tracer *trace,
381 struct trace_array *tr);
382#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100383 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200384 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100385 /* If you handled the flag setting, return 0 */
386 int (*set_flag)(u32 old_flags, u32 bit, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200387 struct tracer *next;
388 int print_max;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100389 struct tracer_flags *flags;
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800390 struct tracer_stat *stats;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200391};
392
Steven Rostedt214023c2008-05-12 21:20:46 +0200393struct trace_seq {
394 unsigned char buffer[PAGE_SIZE];
395 unsigned int len;
Pekka Paalanen6c6c2792008-05-12 21:21:02 +0200396 unsigned int readpos;
Steven Rostedt214023c2008-05-12 21:20:46 +0200397};
398
Steven Rostedtf9520752009-03-02 14:04:40 -0500399static inline void
400trace_seq_init(struct trace_seq *s)
401{
402 s->len = 0;
403 s->readpos = 0;
404}
405
406
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100407#define TRACE_PIPE_ALL_CPU -1
408
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200409/*
410 * Trace iterator - used by printout routines who present trace
411 * results to users and which routines might sleep, etc:
412 */
413struct trace_iterator {
414 struct trace_array *tr;
415 struct tracer *trace;
Steven Rostedt107bad82008-05-12 21:21:01 +0200416 void *private;
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100417 int cpu_file;
Frederic Weisbeckerd7350c32009-02-25 06:13:16 +0100418 struct mutex mutex;
419 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200420
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200421 /* The below is zeroed out in pipe_read */
422 struct trace_seq seq;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200423 struct trace_entry *ent;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200424 int cpu;
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400425 u64 ts;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200426
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200427 unsigned long iter_flags;
428 loff_t pos;
Steven Rostedt4c11d7a2008-05-12 21:20:43 +0200429 long idx;
Steven Rostedta3097202008-11-07 22:36:02 -0500430
Rusty Russell44623442009-01-01 10:12:23 +1030431 cpumask_var_t started;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200432};
433
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200434int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500435int tracing_is_enabled(void);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300436void trace_wake_up(void);
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400437void tracing_reset(struct trace_array *tr, int cpu);
Pekka J Enberg213cc062008-12-19 12:08:39 +0200438void tracing_reset_online_cpus(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200439int tracing_open_generic(struct inode *inode, struct file *filp);
440struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200441void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
442
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200443struct ring_buffer_event;
444
445struct ring_buffer_event *trace_buffer_lock_reserve(struct trace_array *tr,
446 unsigned char type,
447 unsigned long len,
448 unsigned long flags,
449 int pc);
450void trace_buffer_unlock_commit(struct trace_array *tr,
451 struct ring_buffer_event *event,
452 unsigned long flags, int pc);
453
Steven Rostedtef5580d2009-02-27 19:38:04 -0500454struct ring_buffer_event *
455trace_current_buffer_lock_reserve(unsigned char type, unsigned long len,
456 unsigned long flags, int pc);
457void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
458 unsigned long flags, int pc);
459
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300460struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
461 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200462
463struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
464 int *ent_cpu, u64 *ent_ts);
465
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300466void tracing_generic_entry_update(struct trace_entry *entry,
Steven Rostedt38697052008-10-01 13:14:09 -0400467 unsigned long flags,
468 int pc);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300469
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100470void default_wait_pipe(struct trace_iterator *iter);
471void poll_wait_pipe(struct trace_iterator *iter);
472
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200473void ftrace(struct trace_array *tr,
474 struct trace_array_cpu *data,
475 unsigned long ip,
476 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400477 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200478void tracing_sched_switch_trace(struct trace_array *tr,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200479 struct task_struct *prev,
480 struct task_struct *next,
Steven Rostedt38697052008-10-01 13:14:09 -0400481 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200482void tracing_record_cmdline(struct task_struct *tsk);
Ingo Molnar57422792008-05-12 21:20:51 +0200483
484void tracing_sched_wakeup_trace(struct trace_array *tr,
Ingo Molnar57422792008-05-12 21:20:51 +0200485 struct task_struct *wakee,
486 struct task_struct *cur,
Steven Rostedt38697052008-10-01 13:14:09 -0400487 unsigned long flags, int pc);
Ingo Molnarf0a920d2008-05-12 21:20:47 +0200488void trace_special(struct trace_array *tr,
489 struct trace_array_cpu *data,
490 unsigned long arg1,
491 unsigned long arg2,
Steven Rostedt38697052008-10-01 13:14:09 -0400492 unsigned long arg3, int pc);
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200493void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200494 unsigned long ip,
495 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400496 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200497
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100498void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500499int trace_graph_entry(struct ftrace_graph_ent *trace);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100500
Steven Rostedt41bc8142008-05-22 11:49:22 -0400501void tracing_start_cmdline_record(void);
502void tracing_stop_cmdline_record(void);
Steven Rostedte168e052008-11-07 22:36:02 -0500503void tracing_sched_switch_assign_trace(struct trace_array *tr);
504void tracing_stop_sched_switch_record(void);
505void tracing_start_sched_switch_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200506int register_tracer(struct tracer *type);
507void unregister_tracer(struct tracer *type);
508
509extern unsigned long nsecs_to_usecs(unsigned long nsecs);
510
511extern unsigned long tracing_max_latency;
512extern unsigned long tracing_thresh;
513
514void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
515void update_max_tr_single(struct trace_array *tr,
516 struct task_struct *tsk, int cpu);
517
Steven Rostedt53614992009-01-15 19:12:40 -0500518void __trace_stack(struct trace_array *tr,
Steven Rostedt53614992009-01-15 19:12:40 -0500519 unsigned long flags,
520 int skip, int pc);
521
Ingo Molnare309b412008-05-12 21:20:51 +0200522extern cycle_t ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200523
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200524#ifdef CONFIG_CONTEXT_SWITCH_TRACER
525typedef void
526(*tracer_switch_func_t)(void *private,
Mathieu Desnoyers5b82a1b2008-05-12 21:21:10 +0200527 void *__rq,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200528 struct task_struct *prev,
529 struct task_struct *next);
530
531struct tracer_switch_ops {
532 tracer_switch_func_t func;
533 void *private;
534 struct tracer_switch_ops *next;
535};
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200536#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
537
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100538extern char *trace_find_cmdline(int pid);
539
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200540#ifdef CONFIG_DYNAMIC_FTRACE
541extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200542#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
543extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200544#endif
545
Steven Rostedt60a11772008-05-12 21:20:44 +0200546#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200547extern int trace_selftest_startup_function(struct tracer *trace,
548 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100549extern int trace_selftest_startup_function_graph(struct tracer *trace,
550 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200551extern int trace_selftest_startup_irqsoff(struct tracer *trace,
552 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200553extern int trace_selftest_startup_preemptoff(struct tracer *trace,
554 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200555extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
556 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200557extern int trace_selftest_startup_wakeup(struct tracer *trace,
558 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700559extern int trace_selftest_startup_nop(struct tracer *trace,
560 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200561extern int trace_selftest_startup_sched_switch(struct tracer *trace,
562 struct trace_array *tr);
Ingo Molnara6dd24f2008-05-12 21:20:47 +0200563extern int trace_selftest_startup_sysprof(struct tracer *trace,
564 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500565extern int trace_selftest_startup_branch(struct tracer *trace,
566 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200567#endif /* CONFIG_FTRACE_STARTUP_TEST */
568
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200569extern void *head_page(struct trace_array_cpu *data);
Thomas Gleixner72829bc2008-05-23 21:37:28 +0200570extern long ns2usecs(cycle_t nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100571extern int
572trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200573
Ingo Molnar4e655512008-05-12 21:20:52 +0200574extern unsigned long trace_flags;
575
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100576/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100577#ifdef CONFIG_FUNCTION_GRAPH_TRACER
578extern enum print_line_t print_graph_function(struct trace_iterator *iter);
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500579
580#ifdef CONFIG_DYNAMIC_FTRACE
581/* TODO: make this variable */
582#define FTRACE_GRAPH_MAX_FUNCS 32
583extern int ftrace_graph_count;
584extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
585
586static inline int ftrace_graph_addr(unsigned long addr)
587{
588 int i;
589
590 if (!ftrace_graph_count || test_tsk_trace_graph(current))
591 return 1;
592
593 for (i = 0; i < ftrace_graph_count; i++) {
594 if (addr == ftrace_graph_funcs[i])
595 return 1;
596 }
597
598 return 0;
599}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100600#else
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500601static inline int ftrace_trace_addr(unsigned long addr)
602{
Ingo Molnar6b253932008-12-04 09:18:28 +0100603 return 1;
604}
605static inline int ftrace_graph_addr(unsigned long addr)
606{
607 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500608}
609#endif /* CONFIG_DYNAMIC_FTRACE */
610
611#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100612static inline enum print_line_t
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100613print_graph_function(struct trace_iterator *iter)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100614{
615 return TRACE_TYPE_UNHANDLED;
616}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500617#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100618
Steven Rostedt978f3a42008-12-04 00:26:40 -0500619extern struct pid *ftrace_pid_trace;
Steven Rostedt804a6852008-12-03 15:36:59 -0500620
621static inline int ftrace_trace_task(struct task_struct *task)
622{
Frederic Weisbecker77d683f2008-12-04 23:49:47 +0100623 if (!ftrace_pid_trace)
Steven Rostedt804a6852008-12-03 15:36:59 -0500624 return 1;
625
626 return test_tsk_trace_trace(task);
627}
628
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200629/*
630 * trace_iterator_flags is an enumeration that defines bit
631 * positions into trace_flags that controls the output.
632 *
633 * NOTE: These bits must match the trace_options array in
634 * trace.c.
635 */
Ingo Molnar4e655512008-05-12 21:20:52 +0200636enum trace_iterator_flags {
637 TRACE_ITER_PRINT_PARENT = 0x01,
638 TRACE_ITER_SYM_OFFSET = 0x02,
639 TRACE_ITER_SYM_ADDR = 0x04,
640 TRACE_ITER_VERBOSE = 0x08,
641 TRACE_ITER_RAW = 0x10,
642 TRACE_ITER_HEX = 0x20,
643 TRACE_ITER_BIN = 0x40,
644 TRACE_ITER_BLOCK = 0x80,
645 TRACE_ITER_STACKTRACE = 0x100,
Ingo Molnar4ac3ba42008-05-12 21:20:52 +0200646 TRACE_ITER_SCHED_TREE = 0x200,
Peter Zijlstraf09ce572008-09-04 10:24:14 +0200647 TRACE_ITER_PRINTK = 0x400,
Steven Rostedtb2a866f2008-11-03 23:15:57 -0500648 TRACE_ITER_PREEMPTONLY = 0x800,
Steven Rostedt9f029e82008-11-12 15:24:24 -0500649 TRACE_ITER_BRANCH = 0x1000,
Steven Rostedt12ef7d42008-11-12 17:52:38 -0500650 TRACE_ITER_ANNOTATE = 0x2000,
Török Edwinb54d3de2008-11-22 13:28:48 +0200651 TRACE_ITER_USERSTACKTRACE = 0x4000,
Frederic Weisbecker66896a82008-12-13 20:18:13 +0100652 TRACE_ITER_SYM_USEROBJ = 0x8000,
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200653 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
Steven Rostedtc032ef642009-03-04 20:34:24 -0500654 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
655 TRACE_ITER_LATENCY_FMT = 0x40000,
Ingo Molnar4e655512008-05-12 21:20:52 +0200656};
657
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100658/*
659 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
660 * control the output of kernel symbols.
661 */
662#define TRACE_ITER_SYM_MASK \
663 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
664
Frédéric Weisbecker43a15382008-09-21 20:16:30 +0200665extern struct tracer nop_trace;
666
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500667/**
668 * ftrace_preempt_disable - disable preemption scheduler safe
669 *
670 * When tracing can happen inside the scheduler, there exists
671 * cases that the tracing might happen before the need_resched
672 * flag is checked. If this happens and the tracer calls
673 * preempt_enable (after a disable), a schedule might take place
674 * causing an infinite recursion.
675 *
Wenji Huang57794a92009-02-06 17:33:27 +0800676 * To prevent this, we read the need_resched flag before
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500677 * disabling preemption. When we want to enable preemption we
678 * check the flag, if it is set, then we call preempt_enable_no_resched.
679 * Otherwise, we call preempt_enable.
680 *
Wenji Huang57794a92009-02-06 17:33:27 +0800681 * The rational for doing the above is that if need_resched is set
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500682 * and we have yet to reschedule, we are either in an atomic location
683 * (where we do not need to check for scheduling) or we are inside
684 * the scheduler and do not want to resched.
685 */
686static inline int ftrace_preempt_disable(void)
687{
688 int resched;
689
690 resched = need_resched();
691 preempt_disable_notrace();
692
693 return resched;
694}
695
696/**
697 * ftrace_preempt_enable - enable preemption scheduler safe
698 * @resched: the return value from ftrace_preempt_disable
699 *
700 * This is a scheduler safe way to enable preemption and not miss
701 * any preemption checks. The disabled saved the state of preemption.
Wenji Huang57794a92009-02-06 17:33:27 +0800702 * If resched is set, then we are either inside an atomic or
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500703 * are inside the scheduler (we would have already scheduled
704 * otherwise). In this case, we do not want to call normal
705 * preempt_enable, but preempt_enable_no_resched instead.
706 */
707static inline void ftrace_preempt_enable(int resched)
708{
709 if (resched)
710 preempt_enable_no_resched_notrace();
711 else
712 preempt_enable_notrace();
713}
714
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500715#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -0500716extern int enable_branch_tracing(struct trace_array *tr);
717extern void disable_branch_tracing(void);
718static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500719{
Steven Rostedt9f029e82008-11-12 15:24:24 -0500720 if (trace_flags & TRACE_ITER_BRANCH)
721 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -0500722 return 0;
723}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500724static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500725{
726 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -0500727 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -0500728}
729#else
Steven Rostedt9f029e82008-11-12 15:24:24 -0500730static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500731{
732 return 0;
733}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500734static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500735{
736}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500737#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -0500738
Steven Rostedtfd994982009-02-28 02:41:25 -0500739/* trace event type bit fields, not numeric */
740enum {
741 TRACE_EVENT_TYPE_PRINTF = 1,
742 TRACE_EVENT_TYPE_RAW = 2,
743};
744
Steven Rostedtc32e8272009-02-27 19:12:30 -0500745struct ftrace_event_call {
746 char *name;
747 char *system;
748 struct dentry *dir;
749 int enabled;
750 int (*regfunc)(void);
751 void (*unregfunc)(void);
752 int id;
753 struct dentry *raw_dir;
754 int raw_enabled;
Steven Rostedtfd994982009-02-28 02:41:25 -0500755 int type;
Steven Rostedtc32e8272009-02-27 19:12:30 -0500756 int (*raw_init)(void);
757 int (*raw_reg)(void);
758 void (*raw_unreg)(void);
Steven Rostedt981d0812009-03-02 13:53:59 -0500759 int (*show_format)(struct trace_seq *s);
Steven Rostedtc32e8272009-02-27 19:12:30 -0500760};
761
762void event_trace_printk(unsigned long ip, const char *fmt, ...);
763extern struct ftrace_event_call __start_ftrace_events[];
764extern struct ftrace_event_call __stop_ftrace_events[];
765
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200766#endif /* _LINUX_KERNEL_TRACE_H */