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