]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - kernel/trace/trace.h
ring_buffer: allocate buffer page pointer
[mirror_ubuntu-bionic-kernel.git] / kernel / trace / trace.h
CommitLineData
bc0c38d1
SR
1#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>
3928a8a2 8#include <linux/ring_buffer.h>
bd8ac686 9#include <linux/mmiotrace.h>
d13744cd 10#include <linux/ftrace.h>
bc0c38d1 11
72829bc3
TG
12enum trace_type {
13 __TRACE_FIRST_TYPE = 0,
14
15 TRACE_FN,
16 TRACE_CTX,
17 TRACE_WAKE,
dd0e545f 18 TRACE_CONT,
72829bc3 19 TRACE_STACK,
dd0e545f 20 TRACE_PRINT,
72829bc3 21 TRACE_SPECIAL,
bd8ac686
PP
22 TRACE_MMIO_RW,
23 TRACE_MMIO_MAP,
d13744cd 24 TRACE_BOOT,
72829bc3
TG
25
26 __TRACE_LAST_TYPE
27};
28
777e208d
SR
29/*
30 * The trace entry - the most basic unit of tracing. This is what
31 * is printed in the end as a single line in the trace output, such as:
32 *
33 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
34 */
35struct trace_entry {
36 unsigned char type;
37 unsigned char cpu;
38 unsigned char flags;
39 unsigned char preempt_count;
40 int pid;
41};
42
bc0c38d1
SR
43/*
44 * Function trace entry - function address and parent function addres:
45 */
46struct ftrace_entry {
777e208d 47 struct trace_entry ent;
bc0c38d1
SR
48 unsigned long ip;
49 unsigned long parent_ip;
50};
d13744cd 51extern struct tracer boot_tracer;
bc0c38d1
SR
52
53/*
54 * Context switch trace entry - which task (and prio) we switched from/to:
55 */
56struct ctx_switch_entry {
777e208d 57 struct trace_entry ent;
bc0c38d1
SR
58 unsigned int prev_pid;
59 unsigned char prev_prio;
60 unsigned char prev_state;
61 unsigned int next_pid;
62 unsigned char next_prio;
bac524d3 63 unsigned char next_state;
80b5e940 64 unsigned int next_cpu;
bc0c38d1
SR
65};
66
f0a920d5
IM
67/*
68 * Special (free-form) trace entry:
69 */
70struct special_entry {
777e208d 71 struct trace_entry ent;
f0a920d5
IM
72 unsigned long arg1;
73 unsigned long arg2;
74 unsigned long arg3;
75};
76
86387f7e
IM
77/*
78 * Stack-trace entry:
79 */
80
74f4e369 81#define FTRACE_STACK_ENTRIES 8
86387f7e
IM
82
83struct stack_entry {
777e208d 84 struct trace_entry ent;
86387f7e
IM
85 unsigned long caller[FTRACE_STACK_ENTRIES];
86};
87
dd0e545f
SR
88/*
89 * ftrace_printk entry:
90 */
91struct print_entry {
777e208d 92 struct trace_entry ent;
dd0e545f
SR
93 unsigned long ip;
94 char buf[];
95};
96
777e208d
SR
97#define TRACE_OLD_SIZE 88
98
99struct trace_field_cont {
100 unsigned char type;
101 /* Temporary till we get rid of this completely */
102 char buf[TRACE_OLD_SIZE - 1];
103};
104
105struct trace_mmiotrace_rw {
106 struct trace_entry ent;
107 struct mmiotrace_rw rw;
108};
109
110struct trace_mmiotrace_map {
111 struct trace_entry ent;
112 struct mmiotrace_map map;
113};
114
115struct trace_boot {
116 struct trace_entry ent;
117 struct boot_trace initcall;
118};
119
fc5e27ae
PP
120/*
121 * trace_flag_type is an enumeration that holds different
122 * states when a trace occurs. These are:
123 * IRQS_OFF - interrupts were disabled
124 * NEED_RESCED - reschedule is requested
125 * HARDIRQ - inside an interrupt handler
126 * SOFTIRQ - inside a softirq handler
127 * CONT - multiple entries hold the trace item
128 */
129enum trace_flag_type {
130 TRACE_FLAG_IRQS_OFF = 0x01,
131 TRACE_FLAG_NEED_RESCHED = 0x02,
132 TRACE_FLAG_HARDIRQ = 0x04,
133 TRACE_FLAG_SOFTIRQ = 0x08,
134 TRACE_FLAG_CONT = 0x10,
135};
136
5bf9a1ee 137#define TRACE_BUF_SIZE 1024
bc0c38d1
SR
138
139/*
140 * The CPU trace array - it consists of thousands of trace entries
141 * plus some other descriptor data: (for example which task started
142 * the trace, etc.)
143 */
144struct trace_array_cpu {
bc0c38d1 145 atomic_t disabled;
4e3c3333 146
c7aafc54 147 /* these fields get copied into max-trace: */
c7aafc54 148 unsigned long trace_idx;
53d0aa77 149 unsigned long overrun;
bc0c38d1
SR
150 unsigned long saved_latency;
151 unsigned long critical_start;
152 unsigned long critical_end;
153 unsigned long critical_sequence;
154 unsigned long nice;
155 unsigned long policy;
156 unsigned long rt_priority;
157 cycle_t preempt_timestamp;
158 pid_t pid;
159 uid_t uid;
160 char comm[TASK_COMM_LEN];
161};
162
163struct trace_iterator;
164
165/*
166 * The trace array - an array of per-CPU trace arrays. This is the
167 * highest level data structure that individual tracers deal with.
168 * They have on/off state as well:
169 */
170struct trace_array {
3928a8a2 171 struct ring_buffer *buffer;
bc0c38d1
SR
172 unsigned long entries;
173 long ctrl;
174 int cpu;
175 cycle_t time_start;
b3806b43 176 struct task_struct *waiter;
bc0c38d1
SR
177 struct trace_array_cpu *data[NR_CPUS];
178};
179
7104f300
SR
180#define FTRACE_CMP_TYPE(var, type) \
181 __builtin_types_compatible_p(typeof(var), type *)
182
183#undef IF_ASSIGN
184#define IF_ASSIGN(var, entry, etype, id) \
185 if (FTRACE_CMP_TYPE(var, etype)) { \
186 var = (typeof(var))(entry); \
187 WARN_ON(id && (entry)->type != id); \
188 break; \
189 }
190
191/* Will cause compile errors if type is not found. */
192extern void __ftrace_bad_type(void);
193
194/*
195 * The trace_assign_type is a verifier that the entry type is
196 * the same as the type being assigned. To add new types simply
197 * add a line with the following format:
198 *
199 * IF_ASSIGN(var, ent, type, id);
200 *
201 * Where "type" is the trace type that includes the trace_entry
202 * as the "ent" item. And "id" is the trace identifier that is
203 * used in the trace_type enum.
204 *
205 * If the type can have more than one id, then use zero.
206 */
207#define trace_assign_type(var, ent) \
208 do { \
209 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
210 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
211 IF_ASSIGN(var, ent, struct trace_field_cont, TRACE_CONT); \
212 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
213 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
214 IF_ASSIGN(var, ent, struct special_entry, 0); \
215 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
216 TRACE_MMIO_RW); \
217 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
218 TRACE_MMIO_MAP); \
219 IF_ASSIGN(var, ent, struct trace_boot, TRACE_BOOT); \
220 __ftrace_bad_type(); \
221 } while (0)
2c4f035f
FW
222
223/* Return values for print_line callback */
224enum print_line_t {
225 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
226 TRACE_TYPE_HANDLED = 1,
227 TRACE_TYPE_UNHANDLED = 2 /* Relay to other output functions */
228};
229
bc0c38d1
SR
230/*
231 * A specific tracer, represented by methods that operate on a trace array:
232 */
233struct tracer {
234 const char *name;
235 void (*init)(struct trace_array *tr);
236 void (*reset)(struct trace_array *tr);
237 void (*open)(struct trace_iterator *iter);
107bad8b 238 void (*pipe_open)(struct trace_iterator *iter);
bc0c38d1
SR
239 void (*close)(struct trace_iterator *iter);
240 void (*start)(struct trace_iterator *iter);
241 void (*stop)(struct trace_iterator *iter);
107bad8b
SR
242 ssize_t (*read)(struct trace_iterator *iter,
243 struct file *filp, char __user *ubuf,
244 size_t cnt, loff_t *ppos);
bc0c38d1 245 void (*ctrl_update)(struct trace_array *tr);
60a11774
SR
246#ifdef CONFIG_FTRACE_STARTUP_TEST
247 int (*selftest)(struct tracer *trace,
248 struct trace_array *tr);
249#endif
2c4f035f 250 enum print_line_t (*print_line)(struct trace_iterator *iter);
bc0c38d1
SR
251 struct tracer *next;
252 int print_max;
253};
254
214023c3
SR
255struct trace_seq {
256 unsigned char buffer[PAGE_SIZE];
257 unsigned int len;
6c6c2796 258 unsigned int readpos;
214023c3
SR
259};
260
bc0c38d1
SR
261/*
262 * Trace iterator - used by printout routines who present trace
263 * results to users and which routines might sleep, etc:
264 */
265struct trace_iterator {
266 struct trace_array *tr;
267 struct tracer *trace;
107bad8b 268 void *private;
3928a8a2 269 struct ring_buffer_iter *buffer_iter[NR_CPUS];
4e3c3333 270
53d0aa77
SR
271 /* The below is zeroed out in pipe_read */
272 struct trace_seq seq;
bc0c38d1 273 struct trace_entry *ent;
4e3c3333 274 int cpu;
3928a8a2 275 u64 ts;
4e3c3333 276
bc0c38d1
SR
277 unsigned long iter_flags;
278 loff_t pos;
4c11d7ae 279 long idx;
bc0c38d1
SR
280};
281
45dcd8b8 282void trace_wake_up(void);
3928a8a2 283void tracing_reset(struct trace_array *tr, int cpu);
bc0c38d1
SR
284int tracing_open_generic(struct inode *inode, struct file *filp);
285struct dentry *tracing_init_dentry(void);
d618b3e6
IM
286void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
287
45dcd8b8
PP
288struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
289 struct trace_array_cpu *data);
290void tracing_generic_entry_update(struct trace_entry *entry,
291 unsigned long flags);
292
bc0c38d1
SR
293void ftrace(struct trace_array *tr,
294 struct trace_array_cpu *data,
295 unsigned long ip,
296 unsigned long parent_ip,
297 unsigned long flags);
298void tracing_sched_switch_trace(struct trace_array *tr,
299 struct trace_array_cpu *data,
300 struct task_struct *prev,
301 struct task_struct *next,
302 unsigned long flags);
303void tracing_record_cmdline(struct task_struct *tsk);
57422797
IM
304
305void tracing_sched_wakeup_trace(struct trace_array *tr,
306 struct trace_array_cpu *data,
307 struct task_struct *wakee,
308 struct task_struct *cur,
309 unsigned long flags);
f0a920d5
IM
310void trace_special(struct trace_array *tr,
311 struct trace_array_cpu *data,
312 unsigned long arg1,
313 unsigned long arg2,
314 unsigned long arg3);
6fb44b71
SR
315void trace_function(struct trace_array *tr,
316 struct trace_array_cpu *data,
317 unsigned long ip,
318 unsigned long parent_ip,
319 unsigned long flags);
bc0c38d1 320
41bc8144
SR
321void tracing_start_cmdline_record(void);
322void tracing_stop_cmdline_record(void);
bc0c38d1
SR
323int register_tracer(struct tracer *type);
324void unregister_tracer(struct tracer *type);
325
326extern unsigned long nsecs_to_usecs(unsigned long nsecs);
327
328extern unsigned long tracing_max_latency;
329extern unsigned long tracing_thresh;
330
331void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
332void update_max_tr_single(struct trace_array *tr,
333 struct task_struct *tsk, int cpu);
334
e309b41d 335extern cycle_t ftrace_now(int cpu);
bc0c38d1 336
001b6767
SR
337#ifdef CONFIG_FTRACE
338void tracing_start_function_trace(void);
339void tracing_stop_function_trace(void);
340#else
341# define tracing_start_function_trace() do { } while (0)
342# define tracing_stop_function_trace() do { } while (0)
343#endif
344
bc0c38d1
SR
345#ifdef CONFIG_CONTEXT_SWITCH_TRACER
346typedef void
347(*tracer_switch_func_t)(void *private,
5b82a1b0 348 void *__rq,
bc0c38d1
SR
349 struct task_struct *prev,
350 struct task_struct *next);
351
352struct tracer_switch_ops {
353 tracer_switch_func_t func;
354 void *private;
355 struct tracer_switch_ops *next;
356};
357
bc0c38d1
SR
358#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
359
360#ifdef CONFIG_DYNAMIC_FTRACE
361extern unsigned long ftrace_update_tot_cnt;
d05cdb25
SR
362#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
363extern int DYN_FTRACE_TEST_NAME(void);
bc0c38d1
SR
364#endif
365
60a11774 366#ifdef CONFIG_FTRACE_STARTUP_TEST
60a11774
SR
367extern int trace_selftest_startup_function(struct tracer *trace,
368 struct trace_array *tr);
60a11774
SR
369extern int trace_selftest_startup_irqsoff(struct tracer *trace,
370 struct trace_array *tr);
60a11774
SR
371extern int trace_selftest_startup_preemptoff(struct tracer *trace,
372 struct trace_array *tr);
60a11774
SR
373extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
374 struct trace_array *tr);
60a11774
SR
375extern int trace_selftest_startup_wakeup(struct tracer *trace,
376 struct trace_array *tr);
fb1b6d8b
SN
377extern int trace_selftest_startup_nop(struct tracer *trace,
378 struct trace_array *tr);
60a11774
SR
379extern int trace_selftest_startup_sched_switch(struct tracer *trace,
380 struct trace_array *tr);
a6dd24f8
IM
381extern int trace_selftest_startup_sysprof(struct tracer *trace,
382 struct trace_array *tr);
60a11774
SR
383#endif /* CONFIG_FTRACE_STARTUP_TEST */
384
c7aafc54 385extern void *head_page(struct trace_array_cpu *data);
72829bc3 386extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
fc5e27ae
PP
387extern void trace_seq_print_cont(struct trace_seq *s,
388 struct trace_iterator *iter);
6c6c2796
PP
389extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
390 size_t cnt);
72829bc3 391extern long ns2usecs(cycle_t nsec);
801fe400 392extern int trace_vprintk(unsigned long ip, const char *fmt, va_list args);
c7aafc54 393
4e655519
IM
394extern unsigned long trace_flags;
395
4fcdae83
SR
396/*
397 * trace_iterator_flags is an enumeration that defines bit
398 * positions into trace_flags that controls the output.
399 *
400 * NOTE: These bits must match the trace_options array in
401 * trace.c.
402 */
4e655519
IM
403enum trace_iterator_flags {
404 TRACE_ITER_PRINT_PARENT = 0x01,
405 TRACE_ITER_SYM_OFFSET = 0x02,
406 TRACE_ITER_SYM_ADDR = 0x04,
407 TRACE_ITER_VERBOSE = 0x08,
408 TRACE_ITER_RAW = 0x10,
409 TRACE_ITER_HEX = 0x20,
410 TRACE_ITER_BIN = 0x40,
411 TRACE_ITER_BLOCK = 0x80,
412 TRACE_ITER_STACKTRACE = 0x100,
4ac3ba41 413 TRACE_ITER_SCHED_TREE = 0x200,
f09ce573 414 TRACE_ITER_PRINTK = 0x400,
4e655519
IM
415};
416
43a15386
FW
417extern struct tracer nop_trace;
418
bc0c38d1 419#endif /* _LINUX_KERNEL_TRACE_H */