blob: 67595b8f0f157d1c684e66425ec3eebe604756c4 [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,
Frederic Weisbecker48ead022009-03-12 18:24:49 +010023 TRACE_BPRINT,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020024 TRACE_SPECIAL,
Pekka Paalanenbd8ac682008-05-12 21:20:57 +020025 TRACE_MMIO_RW,
26 TRACE_MMIO_MAP,
Steven Rostedt9f029e82008-11-12 15:24:24 -050027 TRACE_BRANCH,
Frederic Weisbecker74239072008-11-11 23:24:42 +010028 TRACE_BOOT_CALL,
29 TRACE_BOOT_RET,
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010030 TRACE_GRAPH_RET,
31 TRACE_GRAPH_ENT,
Török Edwin02b67512008-11-22 13:28:47 +020032 TRACE_USER_STACK,
Markus Metzgera93751c2008-12-11 13:53:26 +010033 TRACE_HW_BRANCHES,
Frederic Weisbecker36994e52008-12-29 13:42:23 -080034 TRACE_KMEM_ALLOC,
35 TRACE_KMEM_FREE,
Arjan van de Venf3f47a62008-11-23 16:49:58 -080036 TRACE_POWER,
Arnaldo Carvalho de Meloc71a8962009-01-23 12:06:27 -020037 TRACE_BLK,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020038
Steven Rostedtf0868d12008-12-23 23:24:12 -050039 __TRACE_LAST_TYPE,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020040};
41
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020042/*
Steven Rostedt777e2082008-09-29 23:02:42 -040043 * The trace entry - the most basic unit of tracing. This is what
44 * is printed in the end as a single line in the trace output, such as:
45 *
46 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
47 */
48struct trace_entry {
49 unsigned char type;
Steven Rostedt777e2082008-09-29 23:02:42 -040050 unsigned char flags;
51 unsigned char preempt_count;
52 int pid;
Török Edwin02b67512008-11-22 13:28:47 +020053 int tgid;
Steven Rostedt777e2082008-09-29 23:02:42 -040054};
55
56/*
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020057 * Function trace entry - function address and parent function addres:
58 */
59struct ftrace_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040060 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020061 unsigned long ip;
62 unsigned long parent_ip;
63};
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010064
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010065/* Function call entry */
66struct ftrace_graph_ent_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010067 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010068 struct ftrace_graph_ent graph_ent;
69};
70
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010071/* Function return entry */
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010072struct ftrace_graph_ret_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010073 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010074 struct ftrace_graph_ret ret;
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010075};
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +010076extern struct tracer boot_tracer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020077
78/*
79 * Context switch trace entry - which task (and prio) we switched from/to:
80 */
81struct ctx_switch_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040082 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020083 unsigned int prev_pid;
84 unsigned char prev_prio;
85 unsigned char prev_state;
86 unsigned int next_pid;
87 unsigned char next_prio;
Peter Zijlstrabac524d2008-05-12 21:20:53 +020088 unsigned char next_state;
Peter Zijlstra80b5e942008-09-04 10:24:16 +020089 unsigned int next_cpu;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020090};
91
92/*
Ingo Molnarf0a920d2008-05-12 21:20:47 +020093 * Special (free-form) trace entry:
94 */
95struct special_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040096 struct trace_entry ent;
Ingo Molnarf0a920d2008-05-12 21:20:47 +020097 unsigned long arg1;
98 unsigned long arg2;
99 unsigned long arg3;
100};
101
102/*
Ingo Molnar86387f72008-05-12 21:20:51 +0200103 * Stack-trace entry:
104 */
105
Ingo Molnar74f4e362008-05-12 21:21:15 +0200106#define FTRACE_STACK_ENTRIES 8
Ingo Molnar86387f72008-05-12 21:20:51 +0200107
108struct stack_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400109 struct trace_entry ent;
Ingo Molnar86387f72008-05-12 21:20:51 +0200110 unsigned long caller[FTRACE_STACK_ENTRIES];
111};
112
Török Edwin02b67512008-11-22 13:28:47 +0200113struct userstack_entry {
114 struct trace_entry ent;
115 unsigned long caller[FTRACE_STACK_ENTRIES];
116};
117
Ingo Molnar86387f72008-05-12 21:20:51 +0200118/*
Ingo Molnar5e1607a2009-03-05 10:24:48 +0100119 * trace_printk entry:
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400120 */
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100121struct bprint_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400122 struct trace_entry ent;
Ingo Molnar9de36822009-03-06 17:52:03 +0100123 unsigned long ip;
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100124 int depth;
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100125 const char *fmt;
Ingo Molnar9de36822009-03-06 17:52:03 +0100126 u32 buf[];
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100127};
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100128
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100129struct print_entry {
130 struct trace_entry ent;
131 unsigned long ip;
132 int depth;
133 char buf[];
134};
135
Steven Rostedt777e2082008-09-29 23:02:42 -0400136#define TRACE_OLD_SIZE 88
137
138struct trace_field_cont {
139 unsigned char type;
140 /* Temporary till we get rid of this completely */
141 char buf[TRACE_OLD_SIZE - 1];
142};
143
144struct trace_mmiotrace_rw {
145 struct trace_entry ent;
146 struct mmiotrace_rw rw;
147};
148
149struct trace_mmiotrace_map {
150 struct trace_entry ent;
151 struct mmiotrace_map map;
152};
153
Frederic Weisbecker74239072008-11-11 23:24:42 +0100154struct trace_boot_call {
Steven Rostedt777e2082008-09-29 23:02:42 -0400155 struct trace_entry ent;
Frederic Weisbecker74239072008-11-11 23:24:42 +0100156 struct boot_trace_call boot_call;
157};
158
159struct trace_boot_ret {
160 struct trace_entry ent;
161 struct boot_trace_ret boot_ret;
Steven Rostedt777e2082008-09-29 23:02:42 -0400162};
163
Steven Rostedt52f232c2008-11-12 00:14:40 -0500164#define TRACE_FUNC_SIZE 30
165#define TRACE_FILE_SIZE 20
Steven Rostedt9f029e82008-11-12 15:24:24 -0500166struct trace_branch {
Steven Rostedt52f232c2008-11-12 00:14:40 -0500167 struct trace_entry ent;
168 unsigned line;
169 char func[TRACE_FUNC_SIZE+1];
170 char file[TRACE_FILE_SIZE+1];
171 char correct;
172};
173
Markus Metzgera93751c2008-12-11 13:53:26 +0100174struct hw_branch_entry {
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100175 struct trace_entry ent;
Markus Metzgera93751c2008-12-11 13:53:26 +0100176 u64 from;
177 u64 to;
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100178};
179
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800180struct trace_power {
181 struct trace_entry ent;
182 struct power_trace state_data;
183};
184
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800185struct kmemtrace_alloc_entry {
186 struct trace_entry ent;
187 enum kmemtrace_type_id type_id;
188 unsigned long call_site;
189 const void *ptr;
190 size_t bytes_req;
191 size_t bytes_alloc;
192 gfp_t gfp_flags;
193 int node;
194};
195
196struct kmemtrace_free_entry {
197 struct trace_entry ent;
198 enum kmemtrace_type_id type_id;
199 unsigned long call_site;
200 const void *ptr;
201};
202
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400203/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300204 * trace_flag_type is an enumeration that holds different
205 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400206 * IRQS_OFF - interrupts were disabled
Ingo Molnar9de36822009-03-06 17:52:03 +0100207 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
Steven Rostedt92444892008-10-24 09:42:59 -0400208 * NEED_RESCED - reschedule is requested
209 * HARDIRQ - inside an interrupt handler
210 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300211 */
212enum trace_flag_type {
213 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400214 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
215 TRACE_FLAG_NEED_RESCHED = 0x04,
216 TRACE_FLAG_HARDIRQ = 0x08,
217 TRACE_FLAG_SOFTIRQ = 0x10,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300218};
219
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300220#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200221
222/*
223 * The CPU trace array - it consists of thousands of trace entries
224 * plus some other descriptor data: (for example which task started
225 * the trace, etc.)
226 */
227struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200228 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500229 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200230
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200231 /* these fields get copied into max-trace: */
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200232 unsigned long trace_idx;
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200233 unsigned long overrun;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200234 unsigned long saved_latency;
235 unsigned long critical_start;
236 unsigned long critical_end;
237 unsigned long critical_sequence;
238 unsigned long nice;
239 unsigned long policy;
240 unsigned long rt_priority;
241 cycle_t preempt_timestamp;
242 pid_t pid;
243 uid_t uid;
244 char comm[TASK_COMM_LEN];
245};
246
247struct trace_iterator;
248
249/*
250 * The trace array - an array of per-CPU trace arrays. This is the
251 * highest level data structure that individual tracers deal with.
252 * They have on/off state as well:
253 */
254struct trace_array {
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400255 struct ring_buffer *buffer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200256 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200257 int cpu;
258 cycle_t time_start;
Steven Rostedtb3806b42008-05-12 21:20:46 +0200259 struct task_struct *waiter;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200260 struct trace_array_cpu *data[NR_CPUS];
261};
262
Steven Rostedt7104f302008-10-01 10:52:51 -0400263#define FTRACE_CMP_TYPE(var, type) \
264 __builtin_types_compatible_p(typeof(var), type *)
265
266#undef IF_ASSIGN
267#define IF_ASSIGN(var, entry, etype, id) \
268 if (FTRACE_CMP_TYPE(var, etype)) { \
269 var = (typeof(var))(entry); \
270 WARN_ON(id && (entry)->type != id); \
271 break; \
272 }
273
274/* Will cause compile errors if type is not found. */
275extern void __ftrace_bad_type(void);
276
277/*
278 * The trace_assign_type is a verifier that the entry type is
279 * the same as the type being assigned. To add new types simply
280 * add a line with the following format:
281 *
282 * IF_ASSIGN(var, ent, type, id);
283 *
284 * Where "type" is the trace type that includes the trace_entry
285 * as the "ent" item. And "id" is the trace identifier that is
286 * used in the trace_type enum.
287 *
288 * If the type can have more than one id, then use zero.
289 */
290#define trace_assign_type(var, ent) \
291 do { \
292 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
293 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400294 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200295 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400296 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100297 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400298 IF_ASSIGN(var, ent, struct special_entry, 0); \
299 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
300 TRACE_MMIO_RW); \
301 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
302 TRACE_MMIO_MAP); \
Frederic Weisbecker74239072008-11-11 23:24:42 +0100303 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
304 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
Steven Rostedt9f029e82008-11-12 15:24:24 -0500305 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100306 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
307 TRACE_GRAPH_ENT); \
308 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
309 TRACE_GRAPH_RET); \
Markus Metzgera93751c2008-12-11 13:53:26 +0100310 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
Ingo Molnar9de36822009-03-06 17:52:03 +0100311 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800312 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
313 TRACE_KMEM_ALLOC); \
314 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
315 TRACE_KMEM_FREE); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400316 __ftrace_bad_type(); \
317 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200318
319/* Return values for print_line callback */
320enum print_line_t {
321 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
322 TRACE_TYPE_HANDLED = 1,
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +0100323 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
324 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200325};
326
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100327
328/*
329 * An option specific to a tracer. This is a boolean value.
330 * The bit is the bit index that sets its value on the
331 * flags value in struct tracer_flags.
332 */
333struct tracer_opt {
Ingo Molnar9de36822009-03-06 17:52:03 +0100334 const char *name; /* Will appear on the trace_options file */
335 u32 bit; /* Mask assigned in val field in tracer_flags */
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100336};
337
338/*
339 * The set of specific options for a tracer. Your tracer
340 * have to set the initial value of the flags val.
341 */
342struct tracer_flags {
343 u32 val;
Ingo Molnar9de36822009-03-06 17:52:03 +0100344 struct tracer_opt *opts;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100345};
346
347/* Makes more easy to define a tracer opt */
348#define TRACER_OPT(s, b) .name = #s, .bit = b
349
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800350
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100351/**
352 * struct tracer - a specific tracer and its callbacks to interact with debugfs
353 * @name: the name chosen to select it on the available_tracers file
354 * @init: called when one switches to this tracer (echo name > current_tracer)
355 * @reset: called when one switches to another tracer
356 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
357 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
358 * @open: called when the trace file is opened
359 * @pipe_open: called when the trace_pipe file is opened
360 * @wait_pipe: override how the user waits for traces on trace_pipe
361 * @close: called when the trace file is released
362 * @read: override the default read callback on trace_pipe
363 * @splice_read: override the default splice_read callback on trace_pipe
364 * @selftest: selftest to run on boot (see trace_selftest.c)
365 * @print_headers: override the first lines that describe your columns
366 * @print_line: callback that prints a trace
367 * @set_flag: signals one of your private flags changed (trace_options file)
368 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200369 */
370struct tracer {
371 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100372 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200373 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500374 void (*start)(struct trace_array *tr);
375 void (*stop)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200376 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200377 void (*pipe_open)(struct trace_iterator *iter);
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100378 void (*wait_pipe)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200379 void (*close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200380 ssize_t (*read)(struct trace_iterator *iter,
381 struct file *filp, char __user *ubuf,
382 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200383 ssize_t (*splice_read)(struct trace_iterator *iter,
384 struct file *filp,
385 loff_t *ppos,
386 struct pipe_inode_info *pipe,
387 size_t len,
388 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200389#ifdef CONFIG_FTRACE_STARTUP_TEST
390 int (*selftest)(struct tracer *trace,
391 struct trace_array *tr);
392#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100393 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200394 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100395 /* If you handled the flag setting, return 0 */
396 int (*set_flag)(u32 old_flags, u32 bit, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200397 struct tracer *next;
398 int print_max;
Ingo Molnar9de36822009-03-06 17:52:03 +0100399 struct tracer_flags *flags;
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800400 struct tracer_stat *stats;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200401};
402
Steven Rostedt214023c2008-05-12 21:20:46 +0200403struct trace_seq {
404 unsigned char buffer[PAGE_SIZE];
405 unsigned int len;
Pekka Paalanen6c6c2792008-05-12 21:21:02 +0200406 unsigned int readpos;
Steven Rostedt214023c2008-05-12 21:20:46 +0200407};
408
Steven Rostedtf9520752009-03-02 14:04:40 -0500409static inline void
410trace_seq_init(struct trace_seq *s)
411{
412 s->len = 0;
413 s->readpos = 0;
414}
415
416
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100417#define TRACE_PIPE_ALL_CPU -1
418
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200419/*
420 * Trace iterator - used by printout routines who present trace
421 * results to users and which routines might sleep, etc:
422 */
423struct trace_iterator {
424 struct trace_array *tr;
425 struct tracer *trace;
Steven Rostedt107bad82008-05-12 21:21:01 +0200426 void *private;
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100427 int cpu_file;
Frederic Weisbeckerd7350c32009-02-25 06:13:16 +0100428 struct mutex mutex;
429 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200430
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200431 /* The below is zeroed out in pipe_read */
432 struct trace_seq seq;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200433 struct trace_entry *ent;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200434 int cpu;
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400435 u64 ts;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200436
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200437 unsigned long iter_flags;
438 loff_t pos;
Steven Rostedt4c11d7a2008-05-12 21:20:43 +0200439 long idx;
Steven Rostedta3097202008-11-07 22:36:02 -0500440
Rusty Russell44623442009-01-01 10:12:23 +1030441 cpumask_var_t started;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200442};
443
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200444int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500445int tracing_is_enabled(void);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300446void trace_wake_up(void);
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400447void tracing_reset(struct trace_array *tr, int cpu);
Pekka J Enberg213cc062008-12-19 12:08:39 +0200448void tracing_reset_online_cpus(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200449int tracing_open_generic(struct inode *inode, struct file *filp);
450struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200451void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
452
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200453struct ring_buffer_event;
454
455struct ring_buffer_event *trace_buffer_lock_reserve(struct trace_array *tr,
456 unsigned char type,
457 unsigned long len,
458 unsigned long flags,
459 int pc);
460void trace_buffer_unlock_commit(struct trace_array *tr,
461 struct ring_buffer_event *event,
462 unsigned long flags, int pc);
463
Steven Rostedtef5580d2009-02-27 19:38:04 -0500464struct ring_buffer_event *
465trace_current_buffer_lock_reserve(unsigned char type, unsigned long len,
466 unsigned long flags, int pc);
467void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
468 unsigned long flags, int pc);
469
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300470struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
471 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200472
473struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
474 int *ent_cpu, u64 *ent_ts);
475
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300476void tracing_generic_entry_update(struct trace_entry *entry,
Steven Rostedt38697052008-10-01 13:14:09 -0400477 unsigned long flags,
478 int pc);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300479
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100480void default_wait_pipe(struct trace_iterator *iter);
481void poll_wait_pipe(struct trace_iterator *iter);
482
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200483void ftrace(struct trace_array *tr,
484 struct trace_array_cpu *data,
485 unsigned long ip,
486 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400487 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200488void tracing_sched_switch_trace(struct trace_array *tr,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200489 struct task_struct *prev,
490 struct task_struct *next,
Steven Rostedt38697052008-10-01 13:14:09 -0400491 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200492void tracing_record_cmdline(struct task_struct *tsk);
Ingo Molnar57422792008-05-12 21:20:51 +0200493
494void tracing_sched_wakeup_trace(struct trace_array *tr,
Ingo Molnar57422792008-05-12 21:20:51 +0200495 struct task_struct *wakee,
496 struct task_struct *cur,
Steven Rostedt38697052008-10-01 13:14:09 -0400497 unsigned long flags, int pc);
Ingo Molnarf0a920d2008-05-12 21:20:47 +0200498void trace_special(struct trace_array *tr,
499 struct trace_array_cpu *data,
500 unsigned long arg1,
501 unsigned long arg2,
Steven Rostedt38697052008-10-01 13:14:09 -0400502 unsigned long arg3, int pc);
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200503void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200504 unsigned long ip,
505 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400506 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200507
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100508void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500509int trace_graph_entry(struct ftrace_graph_ent *trace);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100510
Steven Rostedt41bc8142008-05-22 11:49:22 -0400511void tracing_start_cmdline_record(void);
512void tracing_stop_cmdline_record(void);
Steven Rostedte168e052008-11-07 22:36:02 -0500513void tracing_sched_switch_assign_trace(struct trace_array *tr);
514void tracing_stop_sched_switch_record(void);
515void tracing_start_sched_switch_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200516int register_tracer(struct tracer *type);
517void unregister_tracer(struct tracer *type);
518
519extern unsigned long nsecs_to_usecs(unsigned long nsecs);
520
521extern unsigned long tracing_max_latency;
522extern unsigned long tracing_thresh;
523
524void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
525void update_max_tr_single(struct trace_array *tr,
526 struct task_struct *tsk, int cpu);
527
Steven Rostedt53614992009-01-15 19:12:40 -0500528void __trace_stack(struct trace_array *tr,
Steven Rostedt53614992009-01-15 19:12:40 -0500529 unsigned long flags,
530 int skip, int pc);
531
Ingo Molnare309b412008-05-12 21:20:51 +0200532extern cycle_t ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200533
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200534#ifdef CONFIG_CONTEXT_SWITCH_TRACER
535typedef void
536(*tracer_switch_func_t)(void *private,
Mathieu Desnoyers5b82a1b2008-05-12 21:21:10 +0200537 void *__rq,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200538 struct task_struct *prev,
539 struct task_struct *next);
540
541struct tracer_switch_ops {
542 tracer_switch_func_t func;
543 void *private;
544 struct tracer_switch_ops *next;
545};
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200546#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
547
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100548extern char *trace_find_cmdline(int pid);
549
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200550#ifdef CONFIG_DYNAMIC_FTRACE
551extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200552#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
553extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200554#endif
555
Steven Rostedt60a11772008-05-12 21:20:44 +0200556#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200557extern int trace_selftest_startup_function(struct tracer *trace,
558 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100559extern int trace_selftest_startup_function_graph(struct tracer *trace,
560 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200561extern int trace_selftest_startup_irqsoff(struct tracer *trace,
562 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200563extern int trace_selftest_startup_preemptoff(struct tracer *trace,
564 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200565extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
566 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200567extern int trace_selftest_startup_wakeup(struct tracer *trace,
568 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700569extern int trace_selftest_startup_nop(struct tracer *trace,
570 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200571extern int trace_selftest_startup_sched_switch(struct tracer *trace,
572 struct trace_array *tr);
Ingo Molnara6dd24f2008-05-12 21:20:47 +0200573extern int trace_selftest_startup_sysprof(struct tracer *trace,
574 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500575extern int trace_selftest_startup_branch(struct tracer *trace,
576 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200577#endif /* CONFIG_FTRACE_STARTUP_TEST */
578
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200579extern void *head_page(struct trace_array_cpu *data);
Thomas Gleixner72829bc2008-05-23 21:37:28 +0200580extern long ns2usecs(cycle_t nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100581extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100582trace_vbprintk(unsigned long ip, int depth, const char *fmt, va_list args);
583extern int
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100584trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200585
Ingo Molnar4e655512008-05-12 21:20:52 +0200586extern unsigned long trace_flags;
587
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100588/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100589#ifdef CONFIG_FUNCTION_GRAPH_TRACER
590extern enum print_line_t print_graph_function(struct trace_iterator *iter);
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500591
592#ifdef CONFIG_DYNAMIC_FTRACE
593/* TODO: make this variable */
594#define FTRACE_GRAPH_MAX_FUNCS 32
595extern int ftrace_graph_count;
596extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
597
598static inline int ftrace_graph_addr(unsigned long addr)
599{
600 int i;
601
602 if (!ftrace_graph_count || test_tsk_trace_graph(current))
603 return 1;
604
605 for (i = 0; i < ftrace_graph_count; i++) {
606 if (addr == ftrace_graph_funcs[i])
607 return 1;
608 }
609
610 return 0;
611}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100612#else
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500613static inline int ftrace_trace_addr(unsigned long addr)
614{
Ingo Molnar6b253932008-12-04 09:18:28 +0100615 return 1;
616}
617static inline int ftrace_graph_addr(unsigned long addr)
618{
619 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500620}
621#endif /* CONFIG_DYNAMIC_FTRACE */
622
623#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100624static inline enum print_line_t
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100625print_graph_function(struct trace_iterator *iter)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100626{
627 return TRACE_TYPE_UNHANDLED;
628}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500629#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100630
Steven Rostedt978f3a42008-12-04 00:26:40 -0500631extern struct pid *ftrace_pid_trace;
Steven Rostedt804a6852008-12-03 15:36:59 -0500632
633static inline int ftrace_trace_task(struct task_struct *task)
634{
Frederic Weisbecker77d683f2008-12-04 23:49:47 +0100635 if (!ftrace_pid_trace)
Steven Rostedt804a6852008-12-03 15:36:59 -0500636 return 1;
637
638 return test_tsk_trace_trace(task);
639}
640
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200641/*
642 * trace_iterator_flags is an enumeration that defines bit
643 * positions into trace_flags that controls the output.
644 *
645 * NOTE: These bits must match the trace_options array in
646 * trace.c.
647 */
Ingo Molnar4e655512008-05-12 21:20:52 +0200648enum trace_iterator_flags {
649 TRACE_ITER_PRINT_PARENT = 0x01,
650 TRACE_ITER_SYM_OFFSET = 0x02,
651 TRACE_ITER_SYM_ADDR = 0x04,
652 TRACE_ITER_VERBOSE = 0x08,
653 TRACE_ITER_RAW = 0x10,
654 TRACE_ITER_HEX = 0x20,
655 TRACE_ITER_BIN = 0x40,
656 TRACE_ITER_BLOCK = 0x80,
657 TRACE_ITER_STACKTRACE = 0x100,
Ingo Molnar4ac3ba42008-05-12 21:20:52 +0200658 TRACE_ITER_SCHED_TREE = 0x200,
Peter Zijlstraf09ce572008-09-04 10:24:14 +0200659 TRACE_ITER_PRINTK = 0x400,
Steven Rostedtb2a866f2008-11-03 23:15:57 -0500660 TRACE_ITER_PREEMPTONLY = 0x800,
Steven Rostedt9f029e82008-11-12 15:24:24 -0500661 TRACE_ITER_BRANCH = 0x1000,
Steven Rostedt12ef7d42008-11-12 17:52:38 -0500662 TRACE_ITER_ANNOTATE = 0x2000,
Török Edwinb54d3de2008-11-22 13:28:48 +0200663 TRACE_ITER_USERSTACKTRACE = 0x4000,
Frederic Weisbecker66896a82008-12-13 20:18:13 +0100664 TRACE_ITER_SYM_USEROBJ = 0x8000,
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200665 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
Steven Rostedtc032ef642009-03-04 20:34:24 -0500666 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
667 TRACE_ITER_LATENCY_FMT = 0x40000,
Ingo Molnar4e655512008-05-12 21:20:52 +0200668};
669
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100670/*
671 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
672 * control the output of kernel symbols.
673 */
674#define TRACE_ITER_SYM_MASK \
675 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
676
Frédéric Weisbecker43a15382008-09-21 20:16:30 +0200677extern struct tracer nop_trace;
678
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500679/**
680 * ftrace_preempt_disable - disable preemption scheduler safe
681 *
682 * When tracing can happen inside the scheduler, there exists
683 * cases that the tracing might happen before the need_resched
684 * flag is checked. If this happens and the tracer calls
685 * preempt_enable (after a disable), a schedule might take place
686 * causing an infinite recursion.
687 *
Wenji Huang57794a92009-02-06 17:33:27 +0800688 * To prevent this, we read the need_resched flag before
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500689 * disabling preemption. When we want to enable preemption we
690 * check the flag, if it is set, then we call preempt_enable_no_resched.
691 * Otherwise, we call preempt_enable.
692 *
Wenji Huang57794a92009-02-06 17:33:27 +0800693 * The rational for doing the above is that if need_resched is set
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500694 * and we have yet to reschedule, we are either in an atomic location
695 * (where we do not need to check for scheduling) or we are inside
696 * the scheduler and do not want to resched.
697 */
698static inline int ftrace_preempt_disable(void)
699{
700 int resched;
701
702 resched = need_resched();
703 preempt_disable_notrace();
704
705 return resched;
706}
707
708/**
709 * ftrace_preempt_enable - enable preemption scheduler safe
710 * @resched: the return value from ftrace_preempt_disable
711 *
712 * This is a scheduler safe way to enable preemption and not miss
713 * any preemption checks. The disabled saved the state of preemption.
Wenji Huang57794a92009-02-06 17:33:27 +0800714 * If resched is set, then we are either inside an atomic or
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500715 * are inside the scheduler (we would have already scheduled
716 * otherwise). In this case, we do not want to call normal
717 * preempt_enable, but preempt_enable_no_resched instead.
718 */
719static inline void ftrace_preempt_enable(int resched)
720{
721 if (resched)
722 preempt_enable_no_resched_notrace();
723 else
724 preempt_enable_notrace();
725}
726
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500727#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -0500728extern int enable_branch_tracing(struct trace_array *tr);
729extern void disable_branch_tracing(void);
730static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500731{
Steven Rostedt9f029e82008-11-12 15:24:24 -0500732 if (trace_flags & TRACE_ITER_BRANCH)
733 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -0500734 return 0;
735}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500736static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500737{
738 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -0500739 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -0500740}
741#else
Steven Rostedt9f029e82008-11-12 15:24:24 -0500742static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500743{
744 return 0;
745}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500746static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500747{
748}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500749#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -0500750
Steven Rostedt1852fcc2009-03-11 14:33:00 -0400751/* set ring buffers to default size if not already done so */
752int tracing_update_buffers(void);
753
Steven Rostedtfd994982009-02-28 02:41:25 -0500754/* trace event type bit fields, not numeric */
755enum {
756 TRACE_EVENT_TYPE_PRINTF = 1,
757 TRACE_EVENT_TYPE_RAW = 2,
758};
759
Steven Rostedtc32e8272009-02-27 19:12:30 -0500760struct ftrace_event_call {
761 char *name;
762 char *system;
763 struct dentry *dir;
764 int enabled;
765 int (*regfunc)(void);
766 void (*unregfunc)(void);
767 int id;
Steven Rostedtc32e8272009-02-27 19:12:30 -0500768 int (*raw_init)(void);
Steven Rostedt981d0812009-03-02 13:53:59 -0500769 int (*show_format)(struct trace_seq *s);
Steven Rostedtc32e8272009-02-27 19:12:30 -0500770};
771
772void event_trace_printk(unsigned long ip, const char *fmt, ...);
773extern struct ftrace_event_call __start_ftrace_events[];
774extern struct ftrace_event_call __stop_ftrace_events[];
775
Steven Rostedte9fb2b62009-03-12 14:19:25 -0400776extern const char *__start___trace_bprintk_fmt[];
777extern const char *__stop___trace_bprintk_fmt[];
778
Steven Rostedtbdc06752009-03-13 00:12:52 -0400779/*
780 * The double __builtin_constant_p is because gcc will give us an error
781 * if we try to allocate the static variable to fmt if it is not a
782 * constant. Even with the outer if statement optimizing out.
783 */
Steven Rostedte9fb2b62009-03-12 14:19:25 -0400784#define event_trace_printk(ip, fmt, args...) \
785do { \
786 __trace_printk_check_format(fmt, ##args); \
787 tracing_record_cmdline(current); \
788 if (__builtin_constant_p(fmt)) { \
789 static const char *trace_printk_fmt \
790 __attribute__((section("__trace_printk_fmt"))) = \
791 __builtin_constant_p(fmt) ? fmt : NULL; \
792 \
793 __trace_bprintk(ip, trace_printk_fmt, ##args); \
794 } else \
795 __trace_printk(ip, fmt, ##args); \
796} while (0)
797
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200798#endif /* _LINUX_KERNEL_TRACE_H */