blob: e7fbc826f1e93391faa03cee96d84c68094b4e7a [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 Weisbeckeree08c6e2009-03-07 05:52:59 +010034 TRACE_SYSCALL_ENTER,
35 TRACE_SYSCALL_EXIT,
Frederic Weisbecker36994e52008-12-29 13:42:23 -080036 TRACE_KMEM_ALLOC,
37 TRACE_KMEM_FREE,
Arjan van de Venf3f47a62008-11-23 16:49:58 -080038 TRACE_POWER,
Arnaldo Carvalho de Meloc71a8962009-01-23 12:06:27 -020039 TRACE_BLK,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020040
Steven Rostedtf0868d12008-12-23 23:24:12 -050041 __TRACE_LAST_TYPE,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020042};
43
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020044/*
Steven Rostedt777e2082008-09-29 23:02:42 -040045 * The trace entry - the most basic unit of tracing. This is what
46 * is printed in the end as a single line in the trace output, such as:
47 *
48 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
49 */
50struct trace_entry {
51 unsigned char type;
Steven Rostedt777e2082008-09-29 23:02:42 -040052 unsigned char flags;
53 unsigned char preempt_count;
54 int pid;
Török Edwin02b67512008-11-22 13:28:47 +020055 int tgid;
Steven Rostedt777e2082008-09-29 23:02:42 -040056};
57
58/*
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020059 * Function trace entry - function address and parent function addres:
60 */
61struct ftrace_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040062 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020063 unsigned long ip;
64 unsigned long parent_ip;
65};
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010066
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010067/* Function call entry */
68struct ftrace_graph_ent_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010069 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010070 struct ftrace_graph_ent graph_ent;
71};
72
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010073/* Function return entry */
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010074struct ftrace_graph_ret_entry {
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +010075 struct trace_entry ent;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010076 struct ftrace_graph_ret ret;
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010077};
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +010078extern struct tracer boot_tracer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020079
80/*
81 * Context switch trace entry - which task (and prio) we switched from/to:
82 */
83struct ctx_switch_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040084 struct trace_entry ent;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020085 unsigned int prev_pid;
86 unsigned char prev_prio;
87 unsigned char prev_state;
88 unsigned int next_pid;
89 unsigned char next_prio;
Peter Zijlstrabac524d2008-05-12 21:20:53 +020090 unsigned char next_state;
Peter Zijlstra80b5e942008-09-04 10:24:16 +020091 unsigned int next_cpu;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020092};
93
94/*
Ingo Molnarf0a920d2008-05-12 21:20:47 +020095 * Special (free-form) trace entry:
96 */
97struct special_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -040098 struct trace_entry ent;
Ingo Molnarf0a920d2008-05-12 21:20:47 +020099 unsigned long arg1;
100 unsigned long arg2;
101 unsigned long arg3;
102};
103
104/*
Ingo Molnar86387f72008-05-12 21:20:51 +0200105 * Stack-trace entry:
106 */
107
Ingo Molnar74f4e362008-05-12 21:21:15 +0200108#define FTRACE_STACK_ENTRIES 8
Ingo Molnar86387f72008-05-12 21:20:51 +0200109
110struct stack_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400111 struct trace_entry ent;
Ingo Molnar86387f72008-05-12 21:20:51 +0200112 unsigned long caller[FTRACE_STACK_ENTRIES];
113};
114
Török Edwin02b67512008-11-22 13:28:47 +0200115struct userstack_entry {
116 struct trace_entry ent;
117 unsigned long caller[FTRACE_STACK_ENTRIES];
118};
119
Ingo Molnar86387f72008-05-12 21:20:51 +0200120/*
Ingo Molnar5e1607a2009-03-05 10:24:48 +0100121 * trace_printk entry:
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400122 */
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100123struct bprint_entry {
Steven Rostedt777e2082008-09-29 23:02:42 -0400124 struct trace_entry ent;
Ingo Molnar9de36822009-03-06 17:52:03 +0100125 unsigned long ip;
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100126 int depth;
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100127 const char *fmt;
Ingo Molnar9de36822009-03-06 17:52:03 +0100128 u32 buf[];
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100129};
Lai Jiangshan1427cdf2009-03-06 17:21:47 +0100130
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100131struct print_entry {
132 struct trace_entry ent;
133 unsigned long ip;
134 int depth;
135 char buf[];
136};
137
Steven Rostedt777e2082008-09-29 23:02:42 -0400138#define TRACE_OLD_SIZE 88
139
140struct trace_field_cont {
141 unsigned char type;
142 /* Temporary till we get rid of this completely */
143 char buf[TRACE_OLD_SIZE - 1];
144};
145
146struct trace_mmiotrace_rw {
147 struct trace_entry ent;
148 struct mmiotrace_rw rw;
149};
150
151struct trace_mmiotrace_map {
152 struct trace_entry ent;
153 struct mmiotrace_map map;
154};
155
Frederic Weisbecker74239072008-11-11 23:24:42 +0100156struct trace_boot_call {
Steven Rostedt777e2082008-09-29 23:02:42 -0400157 struct trace_entry ent;
Frederic Weisbecker74239072008-11-11 23:24:42 +0100158 struct boot_trace_call boot_call;
159};
160
161struct trace_boot_ret {
162 struct trace_entry ent;
163 struct boot_trace_ret boot_ret;
Steven Rostedt777e2082008-09-29 23:02:42 -0400164};
165
Steven Rostedt52f232c2008-11-12 00:14:40 -0500166#define TRACE_FUNC_SIZE 30
167#define TRACE_FILE_SIZE 20
Steven Rostedt9f029e82008-11-12 15:24:24 -0500168struct trace_branch {
Steven Rostedt52f232c2008-11-12 00:14:40 -0500169 struct trace_entry ent;
170 unsigned line;
171 char func[TRACE_FUNC_SIZE+1];
172 char file[TRACE_FILE_SIZE+1];
173 char correct;
174};
175
Markus Metzgera93751c2008-12-11 13:53:26 +0100176struct hw_branch_entry {
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100177 struct trace_entry ent;
Markus Metzgera93751c2008-12-11 13:53:26 +0100178 u64 from;
179 u64 to;
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100180};
181
Arjan van de Venf3f47a62008-11-23 16:49:58 -0800182struct trace_power {
183 struct trace_entry ent;
184 struct power_trace state_data;
185};
186
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800187struct kmemtrace_alloc_entry {
188 struct trace_entry ent;
189 enum kmemtrace_type_id type_id;
190 unsigned long call_site;
191 const void *ptr;
192 size_t bytes_req;
193 size_t bytes_alloc;
194 gfp_t gfp_flags;
195 int node;
196};
197
198struct kmemtrace_free_entry {
199 struct trace_entry ent;
200 enum kmemtrace_type_id type_id;
201 unsigned long call_site;
202 const void *ptr;
203};
204
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400205/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300206 * trace_flag_type is an enumeration that holds different
207 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400208 * IRQS_OFF - interrupts were disabled
Ingo Molnar9de36822009-03-06 17:52:03 +0100209 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
Steven Rostedt92444892008-10-24 09:42:59 -0400210 * NEED_RESCED - reschedule is requested
211 * HARDIRQ - inside an interrupt handler
212 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300213 */
214enum trace_flag_type {
215 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400216 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
217 TRACE_FLAG_NEED_RESCHED = 0x04,
218 TRACE_FLAG_HARDIRQ = 0x08,
219 TRACE_FLAG_SOFTIRQ = 0x10,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300220};
221
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300222#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200223
224/*
225 * The CPU trace array - it consists of thousands of trace entries
226 * plus some other descriptor data: (for example which task started
227 * the trace, etc.)
228 */
229struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200230 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500231 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200232
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200233 /* these fields get copied into max-trace: */
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200234 unsigned long trace_idx;
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200235 unsigned long overrun;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200236 unsigned long saved_latency;
237 unsigned long critical_start;
238 unsigned long critical_end;
239 unsigned long critical_sequence;
240 unsigned long nice;
241 unsigned long policy;
242 unsigned long rt_priority;
243 cycle_t preempt_timestamp;
244 pid_t pid;
245 uid_t uid;
246 char comm[TASK_COMM_LEN];
247};
248
249struct trace_iterator;
250
251/*
252 * The trace array - an array of per-CPU trace arrays. This is the
253 * highest level data structure that individual tracers deal with.
254 * They have on/off state as well:
255 */
256struct trace_array {
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400257 struct ring_buffer *buffer;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200258 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200259 int cpu;
260 cycle_t time_start;
Steven Rostedtb3806b42008-05-12 21:20:46 +0200261 struct task_struct *waiter;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200262 struct trace_array_cpu *data[NR_CPUS];
263};
264
Steven Rostedt7104f302008-10-01 10:52:51 -0400265#define FTRACE_CMP_TYPE(var, type) \
266 __builtin_types_compatible_p(typeof(var), type *)
267
268#undef IF_ASSIGN
269#define IF_ASSIGN(var, entry, etype, id) \
270 if (FTRACE_CMP_TYPE(var, etype)) { \
271 var = (typeof(var))(entry); \
272 WARN_ON(id && (entry)->type != id); \
273 break; \
274 }
275
276/* Will cause compile errors if type is not found. */
277extern void __ftrace_bad_type(void);
278
279/*
280 * The trace_assign_type is a verifier that the entry type is
281 * the same as the type being assigned. To add new types simply
282 * add a line with the following format:
283 *
284 * IF_ASSIGN(var, ent, type, id);
285 *
286 * Where "type" is the trace type that includes the trace_entry
287 * as the "ent" item. And "id" is the trace identifier that is
288 * used in the trace_type enum.
289 *
290 * If the type can have more than one id, then use zero.
291 */
292#define trace_assign_type(var, ent) \
293 do { \
294 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
295 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400296 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200297 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400298 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100299 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400300 IF_ASSIGN(var, ent, struct special_entry, 0); \
301 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
302 TRACE_MMIO_RW); \
303 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
304 TRACE_MMIO_MAP); \
Frederic Weisbecker74239072008-11-11 23:24:42 +0100305 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
306 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
Steven Rostedt9f029e82008-11-12 15:24:24 -0500307 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100308 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
309 TRACE_GRAPH_ENT); \
310 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
311 TRACE_GRAPH_RET); \
Markus Metzgera93751c2008-12-11 13:53:26 +0100312 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
Ingo Molnar9de36822009-03-06 17:52:03 +0100313 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800314 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
315 TRACE_KMEM_ALLOC); \
316 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
317 TRACE_KMEM_FREE); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400318 __ftrace_bad_type(); \
319 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200320
321/* Return values for print_line callback */
322enum print_line_t {
323 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
324 TRACE_TYPE_HANDLED = 1,
Frederic Weisbeckerb91facc2009-02-06 18:30:44 +0100325 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
326 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200327};
328
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100329
330/*
331 * An option specific to a tracer. This is a boolean value.
332 * The bit is the bit index that sets its value on the
333 * flags value in struct tracer_flags.
334 */
335struct tracer_opt {
Ingo Molnar9de36822009-03-06 17:52:03 +0100336 const char *name; /* Will appear on the trace_options file */
337 u32 bit; /* Mask assigned in val field in tracer_flags */
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100338};
339
340/*
341 * The set of specific options for a tracer. Your tracer
342 * have to set the initial value of the flags val.
343 */
344struct tracer_flags {
345 u32 val;
Ingo Molnar9de36822009-03-06 17:52:03 +0100346 struct tracer_opt *opts;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100347};
348
349/* Makes more easy to define a tracer opt */
350#define TRACER_OPT(s, b) .name = #s, .bit = b
351
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800352
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100353/**
354 * struct tracer - a specific tracer and its callbacks to interact with debugfs
355 * @name: the name chosen to select it on the available_tracers file
356 * @init: called when one switches to this tracer (echo name > current_tracer)
357 * @reset: called when one switches to another tracer
358 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
359 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
360 * @open: called when the trace file is opened
361 * @pipe_open: called when the trace_pipe file is opened
362 * @wait_pipe: override how the user waits for traces on trace_pipe
363 * @close: called when the trace file is released
364 * @read: override the default read callback on trace_pipe
365 * @splice_read: override the default splice_read callback on trace_pipe
366 * @selftest: selftest to run on boot (see trace_selftest.c)
367 * @print_headers: override the first lines that describe your columns
368 * @print_line: callback that prints a trace
369 * @set_flag: signals one of your private flags changed (trace_options file)
370 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200371 */
372struct tracer {
373 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100374 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200375 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500376 void (*start)(struct trace_array *tr);
377 void (*stop)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200378 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200379 void (*pipe_open)(struct trace_iterator *iter);
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100380 void (*wait_pipe)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200381 void (*close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200382 ssize_t (*read)(struct trace_iterator *iter,
383 struct file *filp, char __user *ubuf,
384 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200385 ssize_t (*splice_read)(struct trace_iterator *iter,
386 struct file *filp,
387 loff_t *ppos,
388 struct pipe_inode_info *pipe,
389 size_t len,
390 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200391#ifdef CONFIG_FTRACE_STARTUP_TEST
392 int (*selftest)(struct tracer *trace,
393 struct trace_array *tr);
394#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100395 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200396 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100397 /* If you handled the flag setting, return 0 */
398 int (*set_flag)(u32 old_flags, u32 bit, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200399 struct tracer *next;
400 int print_max;
Ingo Molnar9de36822009-03-06 17:52:03 +0100401 struct tracer_flags *flags;
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800402 struct tracer_stat *stats;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200403};
404
Steven Rostedt214023c2008-05-12 21:20:46 +0200405struct trace_seq {
406 unsigned char buffer[PAGE_SIZE];
407 unsigned int len;
Pekka Paalanen6c6c2792008-05-12 21:21:02 +0200408 unsigned int readpos;
Steven Rostedt214023c2008-05-12 21:20:46 +0200409};
410
Steven Rostedtf9520752009-03-02 14:04:40 -0500411static inline void
412trace_seq_init(struct trace_seq *s)
413{
414 s->len = 0;
415 s->readpos = 0;
416}
417
418
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100419#define TRACE_PIPE_ALL_CPU -1
420
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200421/*
422 * Trace iterator - used by printout routines who present trace
423 * results to users and which routines might sleep, etc:
424 */
425struct trace_iterator {
426 struct trace_array *tr;
427 struct tracer *trace;
Steven Rostedt107bad82008-05-12 21:21:01 +0200428 void *private;
Frederic Weisbeckerb04cc6b2009-02-25 03:22:28 +0100429 int cpu_file;
Frederic Weisbeckerd7350c3f2009-02-25 06:13:16 +0100430 struct mutex mutex;
431 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200432
Steven Rostedt53d0aa72008-05-12 21:21:01 +0200433 /* The below is zeroed out in pipe_read */
434 struct trace_seq seq;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200435 struct trace_entry *ent;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200436 int cpu;
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400437 u64 ts;
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200438
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200439 unsigned long iter_flags;
440 loff_t pos;
Steven Rostedt4c11d7a2008-05-12 21:20:43 +0200441 long idx;
Steven Rostedta3097202008-11-07 22:36:02 -0500442
Rusty Russell44623442009-01-01 10:12:23 +1030443 cpumask_var_t started;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200444};
445
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200446int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500447int tracing_is_enabled(void);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300448void trace_wake_up(void);
Steven Rostedt3928a8a2008-09-29 23:02:41 -0400449void tracing_reset(struct trace_array *tr, int cpu);
Pekka J Enberg213cc062008-12-19 12:08:39 +0200450void tracing_reset_online_cpus(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200451int tracing_open_generic(struct inode *inode, struct file *filp);
452struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200453void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
454
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200455struct ring_buffer_event;
456
457struct ring_buffer_event *trace_buffer_lock_reserve(struct trace_array *tr,
458 unsigned char type,
459 unsigned long len,
460 unsigned long flags,
461 int pc);
462void trace_buffer_unlock_commit(struct trace_array *tr,
463 struct ring_buffer_event *event,
464 unsigned long flags, int pc);
465
Steven Rostedtef5580d2009-02-27 19:38:04 -0500466struct ring_buffer_event *
467trace_current_buffer_lock_reserve(unsigned char type, unsigned long len,
468 unsigned long flags, int pc);
469void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
470 unsigned long flags, int pc);
471
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300472struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
473 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200474
475struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
476 int *ent_cpu, u64 *ent_ts);
477
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300478void tracing_generic_entry_update(struct trace_entry *entry,
Steven Rostedt38697052008-10-01 13:14:09 -0400479 unsigned long flags,
480 int pc);
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300481
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100482void default_wait_pipe(struct trace_iterator *iter);
483void poll_wait_pipe(struct trace_iterator *iter);
484
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200485void ftrace(struct trace_array *tr,
486 struct trace_array_cpu *data,
487 unsigned long ip,
488 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400489 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200490void tracing_sched_switch_trace(struct trace_array *tr,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200491 struct task_struct *prev,
492 struct task_struct *next,
Steven Rostedt38697052008-10-01 13:14:09 -0400493 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200494void tracing_record_cmdline(struct task_struct *tsk);
Ingo Molnar57422792008-05-12 21:20:51 +0200495
496void tracing_sched_wakeup_trace(struct trace_array *tr,
Ingo Molnar57422792008-05-12 21:20:51 +0200497 struct task_struct *wakee,
498 struct task_struct *cur,
Steven Rostedt38697052008-10-01 13:14:09 -0400499 unsigned long flags, int pc);
Ingo Molnarf0a920d2008-05-12 21:20:47 +0200500void trace_special(struct trace_array *tr,
501 struct trace_array_cpu *data,
502 unsigned long arg1,
503 unsigned long arg2,
Steven Rostedt38697052008-10-01 13:14:09 -0400504 unsigned long arg3, int pc);
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200505void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200506 unsigned long ip,
507 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400508 unsigned long flags, int pc);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200509
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100510void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500511int trace_graph_entry(struct ftrace_graph_ent *trace);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100512
Steven Rostedt41bc8142008-05-22 11:49:22 -0400513void tracing_start_cmdline_record(void);
514void tracing_stop_cmdline_record(void);
Steven Rostedte168e052008-11-07 22:36:02 -0500515void tracing_sched_switch_assign_trace(struct trace_array *tr);
516void tracing_stop_sched_switch_record(void);
517void tracing_start_sched_switch_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200518int register_tracer(struct tracer *type);
519void unregister_tracer(struct tracer *type);
520
521extern unsigned long nsecs_to_usecs(unsigned long nsecs);
522
523extern unsigned long tracing_max_latency;
524extern unsigned long tracing_thresh;
525
526void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
527void update_max_tr_single(struct trace_array *tr,
528 struct task_struct *tsk, int cpu);
529
Steven Rostedt53614992009-01-15 19:12:40 -0500530void __trace_stack(struct trace_array *tr,
Steven Rostedt53614992009-01-15 19:12:40 -0500531 unsigned long flags,
532 int skip, int pc);
533
Ingo Molnare309b412008-05-12 21:20:51 +0200534extern cycle_t ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200535
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200536#ifdef CONFIG_CONTEXT_SWITCH_TRACER
537typedef void
538(*tracer_switch_func_t)(void *private,
Mathieu Desnoyers5b82a1b2008-05-12 21:21:10 +0200539 void *__rq,
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200540 struct task_struct *prev,
541 struct task_struct *next);
542
543struct tracer_switch_ops {
544 tracer_switch_func_t func;
545 void *private;
546 struct tracer_switch_ops *next;
547};
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200548#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
549
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100550extern char *trace_find_cmdline(int pid);
551
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200552#ifdef CONFIG_DYNAMIC_FTRACE
553extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200554#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
555extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200556#endif
557
Steven Rostedt60a11772008-05-12 21:20:44 +0200558#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200559extern int trace_selftest_startup_function(struct tracer *trace,
560 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100561extern int trace_selftest_startup_function_graph(struct tracer *trace,
562 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200563extern int trace_selftest_startup_irqsoff(struct tracer *trace,
564 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200565extern int trace_selftest_startup_preemptoff(struct tracer *trace,
566 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200567extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
568 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200569extern int trace_selftest_startup_wakeup(struct tracer *trace,
570 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700571extern int trace_selftest_startup_nop(struct tracer *trace,
572 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200573extern int trace_selftest_startup_sched_switch(struct tracer *trace,
574 struct trace_array *tr);
Ingo Molnara6dd24f2008-05-12 21:20:47 +0200575extern int trace_selftest_startup_sysprof(struct tracer *trace,
576 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500577extern int trace_selftest_startup_branch(struct tracer *trace,
578 struct trace_array *tr);
Markus Metzger321bb5e2009-03-13 10:50:27 +0100579extern int trace_selftest_startup_hw_branches(struct tracer *trace,
580 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200581#endif /* CONFIG_FTRACE_STARTUP_TEST */
582
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200583extern void *head_page(struct trace_array_cpu *data);
Thomas Gleixner72829bc2008-05-23 21:37:28 +0200584extern long ns2usecs(cycle_t nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100585extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100586trace_vbprintk(unsigned long ip, int depth, const char *fmt, va_list args);
587extern int
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100588trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200589
Ingo Molnar4e655512008-05-12 21:20:52 +0200590extern unsigned long trace_flags;
591
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100592/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100593#ifdef CONFIG_FUNCTION_GRAPH_TRACER
594extern enum print_line_t print_graph_function(struct trace_iterator *iter);
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500595
596#ifdef CONFIG_DYNAMIC_FTRACE
597/* TODO: make this variable */
598#define FTRACE_GRAPH_MAX_FUNCS 32
599extern int ftrace_graph_count;
600extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
601
602static inline int ftrace_graph_addr(unsigned long addr)
603{
604 int i;
605
606 if (!ftrace_graph_count || test_tsk_trace_graph(current))
607 return 1;
608
609 for (i = 0; i < ftrace_graph_count; i++) {
610 if (addr == ftrace_graph_funcs[i])
611 return 1;
612 }
613
614 return 0;
615}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100616#else
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500617static inline int ftrace_trace_addr(unsigned long addr)
618{
Ingo Molnar6b253932008-12-04 09:18:28 +0100619 return 1;
620}
621static inline int ftrace_graph_addr(unsigned long addr)
622{
623 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500624}
625#endif /* CONFIG_DYNAMIC_FTRACE */
626
627#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100628static inline enum print_line_t
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100629print_graph_function(struct trace_iterator *iter)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100630{
631 return TRACE_TYPE_UNHANDLED;
632}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500633#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100634
Steven Rostedt978f3a42008-12-04 00:26:40 -0500635extern struct pid *ftrace_pid_trace;
Steven Rostedt804a6852008-12-03 15:36:59 -0500636
637static inline int ftrace_trace_task(struct task_struct *task)
638{
Frederic Weisbecker77d683f2008-12-04 23:49:47 +0100639 if (!ftrace_pid_trace)
Steven Rostedt804a6852008-12-03 15:36:59 -0500640 return 1;
641
642 return test_tsk_trace_trace(task);
643}
644
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200645/*
646 * trace_iterator_flags is an enumeration that defines bit
647 * positions into trace_flags that controls the output.
648 *
649 * NOTE: These bits must match the trace_options array in
650 * trace.c.
651 */
Ingo Molnar4e655512008-05-12 21:20:52 +0200652enum trace_iterator_flags {
653 TRACE_ITER_PRINT_PARENT = 0x01,
654 TRACE_ITER_SYM_OFFSET = 0x02,
655 TRACE_ITER_SYM_ADDR = 0x04,
656 TRACE_ITER_VERBOSE = 0x08,
657 TRACE_ITER_RAW = 0x10,
658 TRACE_ITER_HEX = 0x20,
659 TRACE_ITER_BIN = 0x40,
660 TRACE_ITER_BLOCK = 0x80,
661 TRACE_ITER_STACKTRACE = 0x100,
Ingo Molnar4ac3ba42008-05-12 21:20:52 +0200662 TRACE_ITER_SCHED_TREE = 0x200,
Peter Zijlstraf09ce572008-09-04 10:24:14 +0200663 TRACE_ITER_PRINTK = 0x400,
Steven Rostedtb2a866f2008-11-03 23:15:57 -0500664 TRACE_ITER_PREEMPTONLY = 0x800,
Steven Rostedt9f029e82008-11-12 15:24:24 -0500665 TRACE_ITER_BRANCH = 0x1000,
Steven Rostedt12ef7d42008-11-12 17:52:38 -0500666 TRACE_ITER_ANNOTATE = 0x2000,
Török Edwinb54d3de2008-11-22 13:28:48 +0200667 TRACE_ITER_USERSTACKTRACE = 0x4000,
Frederic Weisbecker66896a82008-12-13 20:18:13 +0100668 TRACE_ITER_SYM_USEROBJ = 0x8000,
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200669 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
Steven Rostedtc032ef642009-03-04 20:34:24 -0500670 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
671 TRACE_ITER_LATENCY_FMT = 0x40000,
Ingo Molnar4e655512008-05-12 21:20:52 +0200672};
673
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100674/*
675 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
676 * control the output of kernel symbols.
677 */
678#define TRACE_ITER_SYM_MASK \
679 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
680
Frédéric Weisbecker43a15382008-09-21 20:16:30 +0200681extern struct tracer nop_trace;
682
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500683/**
684 * ftrace_preempt_disable - disable preemption scheduler safe
685 *
686 * When tracing can happen inside the scheduler, there exists
687 * cases that the tracing might happen before the need_resched
688 * flag is checked. If this happens and the tracer calls
689 * preempt_enable (after a disable), a schedule might take place
690 * causing an infinite recursion.
691 *
Wenji Huang57794a92009-02-06 17:33:27 +0800692 * To prevent this, we read the need_resched flag before
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500693 * disabling preemption. When we want to enable preemption we
694 * check the flag, if it is set, then we call preempt_enable_no_resched.
695 * Otherwise, we call preempt_enable.
696 *
Wenji Huang57794a92009-02-06 17:33:27 +0800697 * The rational for doing the above is that if need_resched is set
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500698 * and we have yet to reschedule, we are either in an atomic location
699 * (where we do not need to check for scheduling) or we are inside
700 * the scheduler and do not want to resched.
701 */
702static inline int ftrace_preempt_disable(void)
703{
704 int resched;
705
706 resched = need_resched();
707 preempt_disable_notrace();
708
709 return resched;
710}
711
712/**
713 * ftrace_preempt_enable - enable preemption scheduler safe
714 * @resched: the return value from ftrace_preempt_disable
715 *
716 * This is a scheduler safe way to enable preemption and not miss
717 * any preemption checks. The disabled saved the state of preemption.
Wenji Huang57794a92009-02-06 17:33:27 +0800718 * If resched is set, then we are either inside an atomic or
Steven Rostedt8f0a0562008-11-03 23:15:55 -0500719 * are inside the scheduler (we would have already scheduled
720 * otherwise). In this case, we do not want to call normal
721 * preempt_enable, but preempt_enable_no_resched instead.
722 */
723static inline void ftrace_preempt_enable(int resched)
724{
725 if (resched)
726 preempt_enable_no_resched_notrace();
727 else
728 preempt_enable_notrace();
729}
730
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500731#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -0500732extern int enable_branch_tracing(struct trace_array *tr);
733extern void disable_branch_tracing(void);
734static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500735{
Steven Rostedt9f029e82008-11-12 15:24:24 -0500736 if (trace_flags & TRACE_ITER_BRANCH)
737 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -0500738 return 0;
739}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500740static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500741{
742 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -0500743 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -0500744}
745#else
Steven Rostedt9f029e82008-11-12 15:24:24 -0500746static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500747{
748 return 0;
749}
Steven Rostedt9f029e82008-11-12 15:24:24 -0500750static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -0500751{
752}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500753#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -0500754
Steven Rostedt1852fcc2009-03-11 14:33:00 -0400755/* set ring buffers to default size if not already done so */
756int tracing_update_buffers(void);
757
Steven Rostedtfd994982009-02-28 02:41:25 -0500758/* trace event type bit fields, not numeric */
759enum {
760 TRACE_EVENT_TYPE_PRINTF = 1,
761 TRACE_EVENT_TYPE_RAW = 2,
762};
763
Steven Rostedtc32e8272009-02-27 19:12:30 -0500764struct ftrace_event_call {
765 char *name;
766 char *system;
767 struct dentry *dir;
768 int enabled;
769 int (*regfunc)(void);
770 void (*unregfunc)(void);
771 int id;
Steven Rostedtc32e8272009-02-27 19:12:30 -0500772 int (*raw_init)(void);
Steven Rostedt981d0812009-03-02 13:53:59 -0500773 int (*show_format)(struct trace_seq *s);
Steven Rostedtc32e8272009-02-27 19:12:30 -0500774};
775
776void event_trace_printk(unsigned long ip, const char *fmt, ...);
777extern struct ftrace_event_call __start_ftrace_events[];
778extern struct ftrace_event_call __stop_ftrace_events[];
779
Steven Rostedte9fb2b62009-03-12 14:19:25 -0400780extern const char *__start___trace_bprintk_fmt[];
781extern const char *__stop___trace_bprintk_fmt[];
782
Steven Rostedtbdc067582009-03-13 00:12:52 -0400783/*
784 * The double __builtin_constant_p is because gcc will give us an error
785 * if we try to allocate the static variable to fmt if it is not a
786 * constant. Even with the outer if statement optimizing out.
787 */
Steven Rostedte9fb2b62009-03-12 14:19:25 -0400788#define event_trace_printk(ip, fmt, args...) \
789do { \
790 __trace_printk_check_format(fmt, ##args); \
791 tracing_record_cmdline(current); \
792 if (__builtin_constant_p(fmt)) { \
793 static const char *trace_printk_fmt \
794 __attribute__((section("__trace_printk_fmt"))) = \
795 __builtin_constant_p(fmt) ? fmt : NULL; \
796 \
797 __trace_bprintk(ip, trace_printk_fmt, ##args); \
798 } else \
799 __trace_printk(ip, fmt, ##args); \
800} while (0)
801
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200802#endif /* _LINUX_KERNEL_TRACE_H */