]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - kernel/trace/trace.h
tracing: use macros to create internal ftrace entry ring buffer structures
[mirror_ubuntu-jammy-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>
3f5ec136 11#include <trace/boot.h>
02af61bb 12#include <linux/kmemtrace.h>
12922110 13#include <trace/power.h>
bc0c38d1 14
9504504c 15#include <linux/trace_seq.h>
97f20251 16#include <linux/ftrace_event.h>
9504504c 17
72829bc3
TG
18enum trace_type {
19 __TRACE_FIRST_TYPE = 0,
20
21 TRACE_FN,
22 TRACE_CTX,
23 TRACE_WAKE,
24 TRACE_STACK,
dd0e545f 25 TRACE_PRINT,
48ead020 26 TRACE_BPRINT,
72829bc3 27 TRACE_SPECIAL,
bd8ac686
PP
28 TRACE_MMIO_RW,
29 TRACE_MMIO_MAP,
9f029e83 30 TRACE_BRANCH,
74239072
FW
31 TRACE_BOOT_CALL,
32 TRACE_BOOT_RET,
287b6e68
FW
33 TRACE_GRAPH_RET,
34 TRACE_GRAPH_ENT,
02b67518 35 TRACE_USER_STACK,
a93751ca 36 TRACE_HW_BRANCHES,
36994e58
FW
37 TRACE_KMEM_ALLOC,
38 TRACE_KMEM_FREE,
f3f47a67 39 TRACE_POWER,
c71a8961 40 TRACE_BLK,
72829bc3 41
f0868d1e 42 __TRACE_LAST_TYPE,
72829bc3
TG
43};
44
0a1c49db
SR
45enum kmemtrace_type_id {
46 KMEMTRACE_TYPE_KMALLOC = 0, /* kmalloc() or kfree(). */
47 KMEMTRACE_TYPE_CACHE, /* kmem_cache_*(). */
48 KMEMTRACE_TYPE_PAGES, /* __get_free_pages() and friends. */
287b6e68
FW
49};
50
d13744cd 51extern struct tracer boot_tracer;
bc0c38d1 52
0a1c49db
SR
53#undef __field
54#define __field(type, item) type item;
48ead020 55
0a1c49db
SR
56#undef __array
57#define __array(type, item, size) type item[size];
777e208d 58
0a1c49db
SR
59#undef __dynamic_array
60#define __dynamic_array(type, item) type item[];
777e208d 61
0a1c49db
SR
62#undef F_STRUCT
63#define F_STRUCT(args...) args
74239072 64
0a1c49db
SR
65#undef FTRACE_ENTRY
66#define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
67 struct struct_name { \
68 struct trace_entry ent; \
69 tstruct \
70 }
777e208d 71
0a1c49db
SR
72#undef TP_ARGS
73#define TP_ARGS(args...) args
52f232cb 74
0a1c49db
SR
75#undef FTRACE_ENTRY_DUP
76#define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
1e9b51c2 77
0a1c49db 78#include "trace_entries.h"
36994e58 79
0a1c49db
SR
80/*
81 * syscalls are special, and need special handling, this is why
82 * they are not included in trace_entries.h
83 */
bed1ffca
FW
84struct syscall_trace_enter {
85 struct trace_entry ent;
86 int nr;
87 unsigned long args[];
88};
89
90struct syscall_trace_exit {
91 struct trace_entry ent;
92 int nr;
93 unsigned long ret;
94};
95
fc5e27ae
PP
96/*
97 * trace_flag_type is an enumeration that holds different
98 * states when a trace occurs. These are:
9244489a 99 * IRQS_OFF - interrupts were disabled
9de36825 100 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
bd9cfca9 101 * NEED_RESCHED - reschedule is requested
9244489a
SR
102 * HARDIRQ - inside an interrupt handler
103 * SOFTIRQ - inside a softirq handler
fc5e27ae
PP
104 */
105enum trace_flag_type {
106 TRACE_FLAG_IRQS_OFF = 0x01,
9244489a
SR
107 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
108 TRACE_FLAG_NEED_RESCHED = 0x04,
109 TRACE_FLAG_HARDIRQ = 0x08,
110 TRACE_FLAG_SOFTIRQ = 0x10,
fc5e27ae
PP
111};
112
5bf9a1ee 113#define TRACE_BUF_SIZE 1024
bc0c38d1
SR
114
115/*
116 * The CPU trace array - it consists of thousands of trace entries
117 * plus some other descriptor data: (for example which task started
118 * the trace, etc.)
119 */
120struct trace_array_cpu {
bc0c38d1 121 atomic_t disabled;
2cadf913 122 void *buffer_page; /* ring buffer spare */
4e3c3333 123
bc0c38d1
SR
124 unsigned long saved_latency;
125 unsigned long critical_start;
126 unsigned long critical_end;
127 unsigned long critical_sequence;
128 unsigned long nice;
129 unsigned long policy;
130 unsigned long rt_priority;
2f26ebd5 131 unsigned long skipped_entries;
bc0c38d1
SR
132 cycle_t preempt_timestamp;
133 pid_t pid;
134 uid_t uid;
135 char comm[TASK_COMM_LEN];
136};
137
bc0c38d1
SR
138/*
139 * The trace array - an array of per-CPU trace arrays. This is the
140 * highest level data structure that individual tracers deal with.
141 * They have on/off state as well:
142 */
143struct trace_array {
3928a8a2 144 struct ring_buffer *buffer;
bc0c38d1 145 unsigned long entries;
bc0c38d1
SR
146 int cpu;
147 cycle_t time_start;
b3806b43 148 struct task_struct *waiter;
bc0c38d1
SR
149 struct trace_array_cpu *data[NR_CPUS];
150};
151
7104f300
SR
152#define FTRACE_CMP_TYPE(var, type) \
153 __builtin_types_compatible_p(typeof(var), type *)
154
155#undef IF_ASSIGN
156#define IF_ASSIGN(var, entry, etype, id) \
157 if (FTRACE_CMP_TYPE(var, etype)) { \
158 var = (typeof(var))(entry); \
159 WARN_ON(id && (entry)->type != id); \
160 break; \
161 }
162
163/* Will cause compile errors if type is not found. */
164extern void __ftrace_bad_type(void);
165
166/*
167 * The trace_assign_type is a verifier that the entry type is
168 * the same as the type being assigned. To add new types simply
169 * add a line with the following format:
170 *
171 * IF_ASSIGN(var, ent, type, id);
172 *
173 * Where "type" is the trace type that includes the trace_entry
174 * as the "ent" item. And "id" is the trace identifier that is
175 * used in the trace_type enum.
176 *
177 * If the type can have more than one id, then use zero.
178 */
179#define trace_assign_type(var, ent) \
180 do { \
181 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
182 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
7104f300 183 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
02b67518 184 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
7104f300 185 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
48ead020 186 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
7104f300
SR
187 IF_ASSIGN(var, ent, struct special_entry, 0); \
188 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
189 TRACE_MMIO_RW); \
190 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
191 TRACE_MMIO_MAP); \
74239072
FW
192 IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
193 IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
9f029e83 194 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
287b6e68
FW
195 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
196 TRACE_GRAPH_ENT); \
197 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
198 TRACE_GRAPH_RET); \
a93751ca 199 IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
9de36825 200 IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
36994e58
FW
201 IF_ASSIGN(var, ent, struct kmemtrace_alloc_entry, \
202 TRACE_KMEM_ALLOC); \
203 IF_ASSIGN(var, ent, struct kmemtrace_free_entry, \
204 TRACE_KMEM_FREE); \
7104f300
SR
205 __ftrace_bad_type(); \
206 } while (0)
2c4f035f 207
adf9f195
FW
208/*
209 * An option specific to a tracer. This is a boolean value.
210 * The bit is the bit index that sets its value on the
211 * flags value in struct tracer_flags.
212 */
213struct tracer_opt {
9de36825
IM
214 const char *name; /* Will appear on the trace_options file */
215 u32 bit; /* Mask assigned in val field in tracer_flags */
adf9f195
FW
216};
217
218/*
219 * The set of specific options for a tracer. Your tracer
220 * have to set the initial value of the flags val.
221 */
222struct tracer_flags {
223 u32 val;
9de36825 224 struct tracer_opt *opts;
adf9f195
FW
225};
226
227/* Makes more easy to define a tracer opt */
228#define TRACER_OPT(s, b) .name = #s, .bit = b
229
034939b6 230
6eaaa5d5
FW
231/**
232 * struct tracer - a specific tracer and its callbacks to interact with debugfs
233 * @name: the name chosen to select it on the available_tracers file
234 * @init: called when one switches to this tracer (echo name > current_tracer)
235 * @reset: called when one switches to another tracer
236 * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
237 * @stop: called when tracing is paused (echo 0 > tracing_enabled)
238 * @open: called when the trace file is opened
239 * @pipe_open: called when the trace_pipe file is opened
240 * @wait_pipe: override how the user waits for traces on trace_pipe
241 * @close: called when the trace file is released
242 * @read: override the default read callback on trace_pipe
243 * @splice_read: override the default splice_read callback on trace_pipe
244 * @selftest: selftest to run on boot (see trace_selftest.c)
245 * @print_headers: override the first lines that describe your columns
246 * @print_line: callback that prints a trace
247 * @set_flag: signals one of your private flags changed (trace_options file)
248 * @flags: your private flags
bc0c38d1
SR
249 */
250struct tracer {
251 const char *name;
1c80025a 252 int (*init)(struct trace_array *tr);
bc0c38d1 253 void (*reset)(struct trace_array *tr);
9036990d
SR
254 void (*start)(struct trace_array *tr);
255 void (*stop)(struct trace_array *tr);
bc0c38d1 256 void (*open)(struct trace_iterator *iter);
107bad8b 257 void (*pipe_open)(struct trace_iterator *iter);
6eaaa5d5 258 void (*wait_pipe)(struct trace_iterator *iter);
bc0c38d1 259 void (*close)(struct trace_iterator *iter);
107bad8b
SR
260 ssize_t (*read)(struct trace_iterator *iter,
261 struct file *filp, char __user *ubuf,
262 size_t cnt, loff_t *ppos);
3c56819b
EGM
263 ssize_t (*splice_read)(struct trace_iterator *iter,
264 struct file *filp,
265 loff_t *ppos,
266 struct pipe_inode_info *pipe,
267 size_t len,
268 unsigned int flags);
60a11774
SR
269#ifdef CONFIG_FTRACE_STARTUP_TEST
270 int (*selftest)(struct tracer *trace,
271 struct trace_array *tr);
272#endif
8bba1bf5 273 void (*print_header)(struct seq_file *m);
2c4f035f 274 enum print_line_t (*print_line)(struct trace_iterator *iter);
adf9f195
FW
275 /* If you handled the flag setting, return 0 */
276 int (*set_flag)(u32 old_flags, u32 bit, int set);
bc0c38d1
SR
277 struct tracer *next;
278 int print_max;
9de36825 279 struct tracer_flags *flags;
bc0c38d1
SR
280};
281
f9520750 282
b04cc6b1
FW
283#define TRACE_PIPE_ALL_CPU -1
284
b6f11df2 285int tracer_init(struct tracer *t, struct trace_array *tr);
9036990d 286int tracing_is_enabled(void);
45dcd8b8 287void trace_wake_up(void);
3928a8a2 288void tracing_reset(struct trace_array *tr, int cpu);
213cc060 289void tracing_reset_online_cpus(struct trace_array *tr);
9456f0fa
SR
290void tracing_reset_current(int cpu);
291void tracing_reset_current_online_cpus(void);
bc0c38d1 292int tracing_open_generic(struct inode *inode, struct file *filp);
5452af66
FW
293struct dentry *trace_create_file(const char *name,
294 mode_t mode,
295 struct dentry *parent,
296 void *data,
297 const struct file_operations *fops);
298
bc0c38d1 299struct dentry *tracing_init_dentry(void);
d618b3e6
IM
300void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
301
51a763dd
ACM
302struct ring_buffer_event;
303
e77405ad
SR
304struct ring_buffer_event *
305trace_buffer_lock_reserve(struct ring_buffer *buffer,
306 int type,
307 unsigned long len,
308 unsigned long flags,
309 int pc);
310void trace_buffer_unlock_commit(struct ring_buffer *buffer,
51a763dd
ACM
311 struct ring_buffer_event *event,
312 unsigned long flags, int pc);
313
45dcd8b8
PP
314struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
315 struct trace_array_cpu *data);
c4a8e8be
FW
316
317struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
318 int *ent_cpu, u64 *ent_ts);
319
6eaaa5d5
FW
320void default_wait_pipe(struct trace_iterator *iter);
321void poll_wait_pipe(struct trace_iterator *iter);
322
bc0c38d1
SR
323void ftrace(struct trace_array *tr,
324 struct trace_array_cpu *data,
325 unsigned long ip,
326 unsigned long parent_ip,
38697053 327 unsigned long flags, int pc);
bc0c38d1 328void tracing_sched_switch_trace(struct trace_array *tr,
bc0c38d1
SR
329 struct task_struct *prev,
330 struct task_struct *next,
38697053 331 unsigned long flags, int pc);
57422797
IM
332
333void tracing_sched_wakeup_trace(struct trace_array *tr,
57422797
IM
334 struct task_struct *wakee,
335 struct task_struct *cur,
38697053 336 unsigned long flags, int pc);
f0a920d5
IM
337void trace_special(struct trace_array *tr,
338 struct trace_array_cpu *data,
339 unsigned long arg1,
340 unsigned long arg2,
38697053 341 unsigned long arg3, int pc);
6fb44b71 342void trace_function(struct trace_array *tr,
6fb44b71
SR
343 unsigned long ip,
344 unsigned long parent_ip,
38697053 345 unsigned long flags, int pc);
bc0c38d1 346
287b6e68 347void trace_graph_return(struct ftrace_graph_ret *trace);
e49dc19c 348int trace_graph_entry(struct ftrace_graph_ent *trace);
1a0799a8 349void set_graph_array(struct trace_array *tr);
1e9b51c2 350
41bc8144
SR
351void tracing_start_cmdline_record(void);
352void tracing_stop_cmdline_record(void);
e168e051
SR
353void tracing_sched_switch_assign_trace(struct trace_array *tr);
354void tracing_stop_sched_switch_record(void);
355void tracing_start_sched_switch_record(void);
bc0c38d1
SR
356int register_tracer(struct tracer *type);
357void unregister_tracer(struct tracer *type);
b5130b1e 358int is_tracing_stopped(void);
bc0c38d1
SR
359
360extern unsigned long nsecs_to_usecs(unsigned long nsecs);
361
5d4a9dba 362#ifdef CONFIG_TRACER_MAX_TRACE
bc0c38d1
SR
363extern unsigned long tracing_max_latency;
364extern unsigned long tracing_thresh;
365
366void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
367void update_max_tr_single(struct trace_array *tr,
368 struct task_struct *tsk, int cpu);
5d4a9dba 369#endif /* CONFIG_TRACER_MAX_TRACE */
bc0c38d1 370
c0a0d0d3 371#ifdef CONFIG_STACKTRACE
e77405ad 372void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
c0a0d0d3
FW
373 int skip, int pc);
374
e77405ad 375void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
c0a0d0d3
FW
376 int pc);
377
378void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
379 int pc);
380#else
381static inline void ftrace_trace_stack(struct trace_array *tr,
382 unsigned long flags, int skip, int pc)
383{
384}
385
386static inline void ftrace_trace_userstack(struct trace_array *tr,
387 unsigned long flags, int pc)
388{
389}
390
391static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
392 int skip, int pc)
393{
394}
395#endif /* CONFIG_STACKTRACE */
53614991 396
e309b41d 397extern cycle_t ftrace_now(int cpu);
bc0c38d1 398
4ca53085 399extern void trace_find_cmdline(int pid, char comm[]);
f7d48cbd 400
bc0c38d1
SR
401#ifdef CONFIG_DYNAMIC_FTRACE
402extern unsigned long ftrace_update_tot_cnt;
d05cdb25
SR
403#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
404extern int DYN_FTRACE_TEST_NAME(void);
bc0c38d1
SR
405#endif
406
020e5f85
LZ
407extern int ring_buffer_expanded;
408extern bool tracing_selftest_disabled;
5e5bf483 409DECLARE_PER_CPU(local_t, ftrace_cpu_disabled);
020e5f85 410
60a11774 411#ifdef CONFIG_FTRACE_STARTUP_TEST
60a11774
SR
412extern int trace_selftest_startup_function(struct tracer *trace,
413 struct trace_array *tr);
7447dce9
FW
414extern int trace_selftest_startup_function_graph(struct tracer *trace,
415 struct trace_array *tr);
60a11774
SR
416extern int trace_selftest_startup_irqsoff(struct tracer *trace,
417 struct trace_array *tr);
60a11774
SR
418extern int trace_selftest_startup_preemptoff(struct tracer *trace,
419 struct trace_array *tr);
60a11774
SR
420extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
421 struct trace_array *tr);
60a11774
SR
422extern int trace_selftest_startup_wakeup(struct tracer *trace,
423 struct trace_array *tr);
fb1b6d8b
SN
424extern int trace_selftest_startup_nop(struct tracer *trace,
425 struct trace_array *tr);
60a11774
SR
426extern int trace_selftest_startup_sched_switch(struct tracer *trace,
427 struct trace_array *tr);
a6dd24f8
IM
428extern int trace_selftest_startup_sysprof(struct tracer *trace,
429 struct trace_array *tr);
80e5ea45
SR
430extern int trace_selftest_startup_branch(struct tracer *trace,
431 struct trace_array *tr);
321bb5e1
MM
432extern int trace_selftest_startup_hw_branches(struct tracer *trace,
433 struct trace_array *tr);
60a11774
SR
434#endif /* CONFIG_FTRACE_STARTUP_TEST */
435
c7aafc54 436extern void *head_page(struct trace_array_cpu *data);
cf8e3474 437extern unsigned long long ns2usecs(cycle_t nsec);
1fd8f2a3 438extern int
40ce74f1 439trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
48ead020 440extern int
40ce74f1 441trace_vprintk(unsigned long ip, const char *fmt, va_list args);
659372d3
SR
442extern int
443trace_array_vprintk(struct trace_array *tr,
444 unsigned long ip, const char *fmt, va_list args);
445int trace_array_printk(struct trace_array *tr,
446 unsigned long ip, const char *fmt, ...);
c7aafc54 447
4e655519
IM
448extern unsigned long trace_flags;
449
5079f326
Z
450extern int trace_clock_id;
451
15e6cb36 452/* Standard output formatting function used for function return traces */
fb52607a
FW
453#ifdef CONFIG_FUNCTION_GRAPH_TRACER
454extern enum print_line_t print_graph_function(struct trace_iterator *iter);
0706f1c4
SR
455extern enum print_line_t
456trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
ea4e2bc4
SR
457
458#ifdef CONFIG_DYNAMIC_FTRACE
459/* TODO: make this variable */
460#define FTRACE_GRAPH_MAX_FUNCS 32
461extern int ftrace_graph_count;
462extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
463
464static inline int ftrace_graph_addr(unsigned long addr)
465{
466 int i;
467
468 if (!ftrace_graph_count || test_tsk_trace_graph(current))
469 return 1;
470
471 for (i = 0; i < ftrace_graph_count; i++) {
472 if (addr == ftrace_graph_funcs[i])
473 return 1;
474 }
475
476 return 0;
477}
15e6cb36 478#else
ea4e2bc4
SR
479static inline int ftrace_trace_addr(unsigned long addr)
480{
6b253930
IM
481 return 1;
482}
483static inline int ftrace_graph_addr(unsigned long addr)
484{
485 return 1;
ea4e2bc4
SR
486}
487#endif /* CONFIG_DYNAMIC_FTRACE */
ea4e2bc4 488#else /* CONFIG_FUNCTION_GRAPH_TRACER */
15e6cb36 489static inline enum print_line_t
fb52607a 490print_graph_function(struct trace_iterator *iter)
15e6cb36
FW
491{
492 return TRACE_TYPE_UNHANDLED;
493}
ea4e2bc4 494#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
15e6cb36 495
978f3a45 496extern struct pid *ftrace_pid_trace;
804a6851 497
1155de47 498#ifdef CONFIG_FUNCTION_TRACER
804a6851
SR
499static inline int ftrace_trace_task(struct task_struct *task)
500{
77d683f3 501 if (!ftrace_pid_trace)
804a6851
SR
502 return 1;
503
504 return test_tsk_trace_trace(task);
505}
1155de47
PM
506#else
507static inline int ftrace_trace_task(struct task_struct *task)
508{
509 return 1;
510}
511#endif
804a6851 512
b63f39ea 513/*
514 * struct trace_parser - servers for reading the user input separated by spaces
515 * @cont: set if the input is not complete - no final space char was found
516 * @buffer: holds the parsed user input
517 * @idx: user input lenght
518 * @size: buffer size
519 */
520struct trace_parser {
521 bool cont;
522 char *buffer;
523 unsigned idx;
524 unsigned size;
525};
526
527static inline bool trace_parser_loaded(struct trace_parser *parser)
528{
529 return (parser->idx != 0);
530}
531
532static inline bool trace_parser_cont(struct trace_parser *parser)
533{
534 return parser->cont;
535}
536
537static inline void trace_parser_clear(struct trace_parser *parser)
538{
539 parser->cont = false;
540 parser->idx = 0;
541}
542
543extern int trace_parser_get_init(struct trace_parser *parser, int size);
544extern void trace_parser_put(struct trace_parser *parser);
545extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
546 size_t cnt, loff_t *ppos);
547
4fcdae83
SR
548/*
549 * trace_iterator_flags is an enumeration that defines bit
550 * positions into trace_flags that controls the output.
551 *
552 * NOTE: These bits must match the trace_options array in
553 * trace.c.
554 */
4e655519
IM
555enum trace_iterator_flags {
556 TRACE_ITER_PRINT_PARENT = 0x01,
557 TRACE_ITER_SYM_OFFSET = 0x02,
558 TRACE_ITER_SYM_ADDR = 0x04,
559 TRACE_ITER_VERBOSE = 0x08,
560 TRACE_ITER_RAW = 0x10,
561 TRACE_ITER_HEX = 0x20,
562 TRACE_ITER_BIN = 0x40,
563 TRACE_ITER_BLOCK = 0x80,
564 TRACE_ITER_STACKTRACE = 0x100,
4ac3ba41 565 TRACE_ITER_SCHED_TREE = 0x200,
f09ce573 566 TRACE_ITER_PRINTK = 0x400,
b2a866f9 567 TRACE_ITER_PREEMPTONLY = 0x800,
9f029e83 568 TRACE_ITER_BRANCH = 0x1000,
12ef7d44 569 TRACE_ITER_ANNOTATE = 0x2000,
b54d3de9 570 TRACE_ITER_USERSTACKTRACE = 0x4000,
66896a85 571 TRACE_ITER_SYM_USEROBJ = 0x8000,
c4a8e8be 572 TRACE_ITER_PRINTK_MSGONLY = 0x10000,
c032ef64
SR
573 TRACE_ITER_CONTEXT_INFO = 0x20000, /* Print pid/cpu/time */
574 TRACE_ITER_LATENCY_FMT = 0x40000,
5079f326
Z
575 TRACE_ITER_SLEEP_TIME = 0x80000,
576 TRACE_ITER_GRAPH_TIME = 0x100000,
4e655519
IM
577};
578
15e6cb36
FW
579/*
580 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
581 * control the output of kernel symbols.
582 */
583#define TRACE_ITER_SYM_MASK \
584 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
585
43a15386
FW
586extern struct tracer nop_trace;
587
8f0a056f
SR
588/**
589 * ftrace_preempt_disable - disable preemption scheduler safe
590 *
591 * When tracing can happen inside the scheduler, there exists
592 * cases that the tracing might happen before the need_resched
593 * flag is checked. If this happens and the tracer calls
594 * preempt_enable (after a disable), a schedule might take place
595 * causing an infinite recursion.
596 *
57794a9d 597 * To prevent this, we read the need_resched flag before
8f0a056f
SR
598 * disabling preemption. When we want to enable preemption we
599 * check the flag, if it is set, then we call preempt_enable_no_resched.
600 * Otherwise, we call preempt_enable.
601 *
57794a9d 602 * The rational for doing the above is that if need_resched is set
8f0a056f
SR
603 * and we have yet to reschedule, we are either in an atomic location
604 * (where we do not need to check for scheduling) or we are inside
605 * the scheduler and do not want to resched.
606 */
607static inline int ftrace_preempt_disable(void)
608{
609 int resched;
610
611 resched = need_resched();
612 preempt_disable_notrace();
613
614 return resched;
615}
616
617/**
618 * ftrace_preempt_enable - enable preemption scheduler safe
619 * @resched: the return value from ftrace_preempt_disable
620 *
621 * This is a scheduler safe way to enable preemption and not miss
622 * any preemption checks. The disabled saved the state of preemption.
57794a9d 623 * If resched is set, then we are either inside an atomic or
8f0a056f
SR
624 * are inside the scheduler (we would have already scheduled
625 * otherwise). In this case, we do not want to call normal
626 * preempt_enable, but preempt_enable_no_resched instead.
627 */
628static inline void ftrace_preempt_enable(int resched)
629{
630 if (resched)
631 preempt_enable_no_resched_notrace();
632 else
633 preempt_enable_notrace();
634}
635
2ed84eeb 636#ifdef CONFIG_BRANCH_TRACER
9f029e83
SR
637extern int enable_branch_tracing(struct trace_array *tr);
638extern void disable_branch_tracing(void);
639static inline int trace_branch_enable(struct trace_array *tr)
52f232cb 640{
9f029e83
SR
641 if (trace_flags & TRACE_ITER_BRANCH)
642 return enable_branch_tracing(tr);
52f232cb
SR
643 return 0;
644}
9f029e83 645static inline void trace_branch_disable(void)
52f232cb
SR
646{
647 /* due to races, always disable */
9f029e83 648 disable_branch_tracing();
52f232cb
SR
649}
650#else
9f029e83 651static inline int trace_branch_enable(struct trace_array *tr)
52f232cb
SR
652{
653 return 0;
654}
9f029e83 655static inline void trace_branch_disable(void)
52f232cb
SR
656{
657}
2ed84eeb 658#endif /* CONFIG_BRANCH_TRACER */
52f232cb 659
1852fcce
SR
660/* set ring buffers to default size if not already done so */
661int tracing_update_buffers(void);
662
fd994989
SR
663/* trace event type bit fields, not numeric */
664enum {
665 TRACE_EVENT_TYPE_PRINTF = 1,
666 TRACE_EVENT_TYPE_RAW = 2,
667};
668
cf027f64
TZ
669struct ftrace_event_field {
670 struct list_head link;
671 char *name;
672 char *type;
aa38e9fc 673 int filter_type;
cf027f64
TZ
674 int offset;
675 int size;
a118e4d1 676 int is_signed;
cf027f64
TZ
677};
678
30e673b2
TZ
679struct event_filter {
680 int n_preds;
681 struct filter_pred **preds;
8b372562 682 char *filter_string;
1f9963cb 683 bool no_reset;
30e673b2
TZ
684};
685
cfb180f3
TZ
686struct event_subsystem {
687 struct list_head list;
688 const char *name;
689 struct dentry *entry;
1f9963cb 690 struct event_filter *filter;
dc82ec98 691 int nr_events;
cfb180f3
TZ
692};
693
7ce7e424
TZ
694struct filter_pred;
695
8b372562
TZ
696typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event,
697 int val1, int val2);
7ce7e424
TZ
698
699struct filter_pred {
700 filter_pred_fn_t fn;
701 u64 val;
0a19e53c 702 char str_val[MAX_FILTER_STR_VAL];
7ce7e424
TZ
703 int str_len;
704 char *field_name;
705 int offset;
706 int not;
8b372562
TZ
707 int op;
708 int pop_n;
7ce7e424
TZ
709};
710
8b372562 711extern void print_event_filter(struct ftrace_event_call *call,
4bda2d51 712 struct trace_seq *s);
8b372562
TZ
713extern int apply_event_filter(struct ftrace_event_call *call,
714 char *filter_string);
715extern int apply_subsystem_event_filter(struct event_subsystem *system,
716 char *filter_string);
717extern void print_subsystem_event_filter(struct event_subsystem *system,
ac1adc55 718 struct trace_seq *s);
aa38e9fc 719extern int filter_assign_type(const char *type);
7ce7e424 720
eb02ce01 721static inline int
e1112b4d 722filter_check_discard(struct ftrace_event_call *call, void *rec,
eb02ce01 723 struct ring_buffer *buffer,
e1112b4d
TZ
724 struct ring_buffer_event *event)
725{
30e673b2 726 if (unlikely(call->filter_active) && !filter_match_preds(call, rec)) {
eb02ce01
TZ
727 ring_buffer_discard_commit(buffer, event);
728 return 1;
729 }
730
731 return 0;
e1112b4d
TZ
732}
733
20c8928a 734extern struct mutex event_mutex;
a59fd602 735extern struct list_head ftrace_events;
ac199db0 736
e9fb2b6d
SR
737extern const char *__start___trace_bprintk_fmt[];
738extern const char *__stop___trace_bprintk_fmt[];
739
e1112b4d
TZ
740#undef TRACE_EVENT_FORMAT
741#define TRACE_EVENT_FORMAT(call, proto, args, fmt, tstruct, tpfmt) \
742 extern struct ftrace_event_call event_##call;
e45f2e2b
TZ
743#undef TRACE_EVENT_FORMAT_NOFILTER
744#define TRACE_EVENT_FORMAT_NOFILTER(call, proto, args, fmt, tstruct, tpfmt)
e1112b4d
TZ
745#include "trace_event_types.h"
746
bc0c38d1 747#endif /* _LINUX_KERNEL_TRACE_H */