xref: /linux/kernel/trace/trace.h (revision 26b0d14106954ae46d2f4f7eec3481828a210f7d)
1 #ifndef _LINUX_KERNEL_TRACE_H
2 #define _LINUX_KERNEL_TRACE_H
3 
4 #include <linux/fs.h>
5 #include <linux/atomic.h>
6 #include <linux/sched.h>
7 #include <linux/clocksource.h>
8 #include <linux/ring_buffer.h>
9 #include <linux/mmiotrace.h>
10 #include <linux/tracepoint.h>
11 #include <linux/ftrace.h>
12 #include <linux/hw_breakpoint.h>
13 #include <linux/trace_seq.h>
14 #include <linux/ftrace_event.h>
15 
16 enum trace_type {
17 	__TRACE_FIRST_TYPE = 0,
18 
19 	TRACE_FN,
20 	TRACE_CTX,
21 	TRACE_WAKE,
22 	TRACE_STACK,
23 	TRACE_PRINT,
24 	TRACE_BPRINT,
25 	TRACE_MMIO_RW,
26 	TRACE_MMIO_MAP,
27 	TRACE_BRANCH,
28 	TRACE_GRAPH_RET,
29 	TRACE_GRAPH_ENT,
30 	TRACE_USER_STACK,
31 	TRACE_BLK,
32 
33 	__TRACE_LAST_TYPE,
34 };
35 
36 
37 #undef __field
38 #define __field(type, item)		type	item;
39 
40 #undef __field_struct
41 #define __field_struct(type, item)	__field(type, item)
42 
43 #undef __field_desc
44 #define __field_desc(type, container, item)
45 
46 #undef __array
47 #define __array(type, item, size)	type	item[size];
48 
49 #undef __array_desc
50 #define __array_desc(type, container, item, size)
51 
52 #undef __dynamic_array
53 #define __dynamic_array(type, item)	type	item[];
54 
55 #undef F_STRUCT
56 #define F_STRUCT(args...)		args
57 
58 #undef FTRACE_ENTRY
59 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter)	\
60 	struct struct_name {						\
61 		struct trace_entry	ent;				\
62 		tstruct							\
63 	}
64 
65 #undef TP_ARGS
66 #define TP_ARGS(args...)	args
67 
68 #undef FTRACE_ENTRY_DUP
69 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
70 
71 #undef FTRACE_ENTRY_REG
72 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print,	\
73 			 filter, regfn) \
74 	FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
75 		     filter)
76 
77 #include "trace_entries.h"
78 
79 /*
80  * syscalls are special, and need special handling, this is why
81  * they are not included in trace_entries.h
82  */
83 struct syscall_trace_enter {
84 	struct trace_entry	ent;
85 	int			nr;
86 	unsigned long		args[];
87 };
88 
89 struct syscall_trace_exit {
90 	struct trace_entry	ent;
91 	int			nr;
92 	long			ret;
93 };
94 
95 struct kprobe_trace_entry_head {
96 	struct trace_entry	ent;
97 	unsigned long		ip;
98 };
99 
100 struct kretprobe_trace_entry_head {
101 	struct trace_entry	ent;
102 	unsigned long		func;
103 	unsigned long		ret_ip;
104 };
105 
106 struct uprobe_trace_entry_head {
107 	struct trace_entry	ent;
108 	unsigned long		ip;
109 };
110 
111 /*
112  * trace_flag_type is an enumeration that holds different
113  * states when a trace occurs. These are:
114  *  IRQS_OFF		- interrupts were disabled
115  *  IRQS_NOSUPPORT	- arch does not support irqs_disabled_flags
116  *  NEED_RESCHED	- reschedule is requested
117  *  HARDIRQ		- inside an interrupt handler
118  *  SOFTIRQ		- inside a softirq handler
119  */
120 enum trace_flag_type {
121 	TRACE_FLAG_IRQS_OFF		= 0x01,
122 	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
123 	TRACE_FLAG_NEED_RESCHED		= 0x04,
124 	TRACE_FLAG_HARDIRQ		= 0x08,
125 	TRACE_FLAG_SOFTIRQ		= 0x10,
126 };
127 
128 #define TRACE_BUF_SIZE		1024
129 
130 /*
131  * The CPU trace array - it consists of thousands of trace entries
132  * plus some other descriptor data: (for example which task started
133  * the trace, etc.)
134  */
135 struct trace_array_cpu {
136 	atomic_t		disabled;
137 	void			*buffer_page;	/* ring buffer spare */
138 
139 	unsigned long		entries;
140 	unsigned long		saved_latency;
141 	unsigned long		critical_start;
142 	unsigned long		critical_end;
143 	unsigned long		critical_sequence;
144 	unsigned long		nice;
145 	unsigned long		policy;
146 	unsigned long		rt_priority;
147 	unsigned long		skipped_entries;
148 	cycle_t			preempt_timestamp;
149 	pid_t			pid;
150 	uid_t			uid;
151 	char			comm[TASK_COMM_LEN];
152 };
153 
154 /*
155  * The trace array - an array of per-CPU trace arrays. This is the
156  * highest level data structure that individual tracers deal with.
157  * They have on/off state as well:
158  */
159 struct trace_array {
160 	struct ring_buffer	*buffer;
161 	int			cpu;
162 	int			buffer_disabled;
163 	cycle_t			time_start;
164 	struct task_struct	*waiter;
165 	struct trace_array_cpu	*data[NR_CPUS];
166 };
167 
168 #define FTRACE_CMP_TYPE(var, type) \
169 	__builtin_types_compatible_p(typeof(var), type *)
170 
171 #undef IF_ASSIGN
172 #define IF_ASSIGN(var, entry, etype, id)		\
173 	if (FTRACE_CMP_TYPE(var, etype)) {		\
174 		var = (typeof(var))(entry);		\
175 		WARN_ON(id && (entry)->type != id);	\
176 		break;					\
177 	}
178 
179 /* Will cause compile errors if type is not found. */
180 extern void __ftrace_bad_type(void);
181 
182 /*
183  * The trace_assign_type is a verifier that the entry type is
184  * the same as the type being assigned. To add new types simply
185  * add a line with the following format:
186  *
187  * IF_ASSIGN(var, ent, type, id);
188  *
189  *  Where "type" is the trace type that includes the trace_entry
190  *  as the "ent" item. And "id" is the trace identifier that is
191  *  used in the trace_type enum.
192  *
193  *  If the type can have more than one id, then use zero.
194  */
195 #define trace_assign_type(var, ent)					\
196 	do {								\
197 		IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);	\
198 		IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);	\
199 		IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);	\
200 		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
201 		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
202 		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
203 		IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,		\
204 			  TRACE_MMIO_RW);				\
205 		IF_ASSIGN(var, ent, struct trace_mmiotrace_map,		\
206 			  TRACE_MMIO_MAP);				\
207 		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
208 		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
209 			  TRACE_GRAPH_ENT);		\
210 		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
211 			  TRACE_GRAPH_RET);		\
212 		__ftrace_bad_type();					\
213 	} while (0)
214 
215 /*
216  * An option specific to a tracer. This is a boolean value.
217  * The bit is the bit index that sets its value on the
218  * flags value in struct tracer_flags.
219  */
220 struct tracer_opt {
221 	const char	*name; /* Will appear on the trace_options file */
222 	u32		bit; /* Mask assigned in val field in tracer_flags */
223 };
224 
225 /*
226  * The set of specific options for a tracer. Your tracer
227  * have to set the initial value of the flags val.
228  */
229 struct tracer_flags {
230 	u32			val;
231 	struct tracer_opt	*opts;
232 };
233 
234 /* Makes more easy to define a tracer opt */
235 #define TRACER_OPT(s, b)	.name = #s, .bit = b
236 
237 
238 /**
239  * struct tracer - a specific tracer and its callbacks to interact with debugfs
240  * @name: the name chosen to select it on the available_tracers file
241  * @init: called when one switches to this tracer (echo name > current_tracer)
242  * @reset: called when one switches to another tracer
243  * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
244  * @stop: called when tracing is paused (echo 0 > tracing_enabled)
245  * @open: called when the trace file is opened
246  * @pipe_open: called when the trace_pipe file is opened
247  * @wait_pipe: override how the user waits for traces on trace_pipe
248  * @close: called when the trace file is released
249  * @pipe_close: called when the trace_pipe file is released
250  * @read: override the default read callback on trace_pipe
251  * @splice_read: override the default splice_read callback on trace_pipe
252  * @selftest: selftest to run on boot (see trace_selftest.c)
253  * @print_headers: override the first lines that describe your columns
254  * @print_line: callback that prints a trace
255  * @set_flag: signals one of your private flags changed (trace_options file)
256  * @flags: your private flags
257  */
258 struct tracer {
259 	const char		*name;
260 	int			(*init)(struct trace_array *tr);
261 	void			(*reset)(struct trace_array *tr);
262 	void			(*start)(struct trace_array *tr);
263 	void			(*stop)(struct trace_array *tr);
264 	void			(*open)(struct trace_iterator *iter);
265 	void			(*pipe_open)(struct trace_iterator *iter);
266 	void			(*wait_pipe)(struct trace_iterator *iter);
267 	void			(*close)(struct trace_iterator *iter);
268 	void			(*pipe_close)(struct trace_iterator *iter);
269 	ssize_t			(*read)(struct trace_iterator *iter,
270 					struct file *filp, char __user *ubuf,
271 					size_t cnt, loff_t *ppos);
272 	ssize_t			(*splice_read)(struct trace_iterator *iter,
273 					       struct file *filp,
274 					       loff_t *ppos,
275 					       struct pipe_inode_info *pipe,
276 					       size_t len,
277 					       unsigned int flags);
278 #ifdef CONFIG_FTRACE_STARTUP_TEST
279 	int			(*selftest)(struct tracer *trace,
280 					    struct trace_array *tr);
281 #endif
282 	void			(*print_header)(struct seq_file *m);
283 	enum print_line_t	(*print_line)(struct trace_iterator *iter);
284 	/* If you handled the flag setting, return 0 */
285 	int			(*set_flag)(u32 old_flags, u32 bit, int set);
286 	struct tracer		*next;
287 	struct tracer_flags	*flags;
288 	int			print_max;
289 	int			use_max_tr;
290 };
291 
292 
293 /* Only current can touch trace_recursion */
294 #define trace_recursion_inc() do { (current)->trace_recursion++; } while (0)
295 #define trace_recursion_dec() do { (current)->trace_recursion--; } while (0)
296 
297 /* Ring buffer has the 10 LSB bits to count */
298 #define trace_recursion_buffer() ((current)->trace_recursion & 0x3ff)
299 
300 /* for function tracing recursion */
301 #define TRACE_INTERNAL_BIT		(1<<11)
302 #define TRACE_GLOBAL_BIT		(1<<12)
303 #define TRACE_CONTROL_BIT		(1<<13)
304 
305 /*
306  * Abuse of the trace_recursion.
307  * As we need a way to maintain state if we are tracing the function
308  * graph in irq because we want to trace a particular function that
309  * was called in irq context but we have irq tracing off. Since this
310  * can only be modified by current, we can reuse trace_recursion.
311  */
312 #define TRACE_IRQ_BIT			(1<<13)
313 
314 #define trace_recursion_set(bit)	do { (current)->trace_recursion |= (bit); } while (0)
315 #define trace_recursion_clear(bit)	do { (current)->trace_recursion &= ~(bit); } while (0)
316 #define trace_recursion_test(bit)	((current)->trace_recursion & (bit))
317 
318 #define TRACE_PIPE_ALL_CPU	-1
319 
320 int tracer_init(struct tracer *t, struct trace_array *tr);
321 int tracing_is_enabled(void);
322 void trace_wake_up(void);
323 void tracing_reset(struct trace_array *tr, int cpu);
324 void tracing_reset_online_cpus(struct trace_array *tr);
325 void tracing_reset_current(int cpu);
326 void tracing_reset_current_online_cpus(void);
327 int tracing_open_generic(struct inode *inode, struct file *filp);
328 struct dentry *trace_create_file(const char *name,
329 				 umode_t mode,
330 				 struct dentry *parent,
331 				 void *data,
332 				 const struct file_operations *fops);
333 
334 struct dentry *tracing_init_dentry(void);
335 
336 struct ring_buffer_event;
337 
338 struct ring_buffer_event *
339 trace_buffer_lock_reserve(struct ring_buffer *buffer,
340 			  int type,
341 			  unsigned long len,
342 			  unsigned long flags,
343 			  int pc);
344 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
345 				struct ring_buffer_event *event,
346 				unsigned long flags, int pc);
347 
348 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
349 						struct trace_array_cpu *data);
350 
351 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
352 					  int *ent_cpu, u64 *ent_ts);
353 
354 int trace_empty(struct trace_iterator *iter);
355 
356 void *trace_find_next_entry_inc(struct trace_iterator *iter);
357 
358 void trace_init_global_iter(struct trace_iterator *iter);
359 
360 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
361 
362 void default_wait_pipe(struct trace_iterator *iter);
363 void poll_wait_pipe(struct trace_iterator *iter);
364 
365 void ftrace(struct trace_array *tr,
366 			    struct trace_array_cpu *data,
367 			    unsigned long ip,
368 			    unsigned long parent_ip,
369 			    unsigned long flags, int pc);
370 void tracing_sched_switch_trace(struct trace_array *tr,
371 				struct task_struct *prev,
372 				struct task_struct *next,
373 				unsigned long flags, int pc);
374 
375 void tracing_sched_wakeup_trace(struct trace_array *tr,
376 				struct task_struct *wakee,
377 				struct task_struct *cur,
378 				unsigned long flags, int pc);
379 void trace_function(struct trace_array *tr,
380 		    unsigned long ip,
381 		    unsigned long parent_ip,
382 		    unsigned long flags, int pc);
383 void trace_graph_function(struct trace_array *tr,
384 		    unsigned long ip,
385 		    unsigned long parent_ip,
386 		    unsigned long flags, int pc);
387 void trace_latency_header(struct seq_file *m);
388 void trace_default_header(struct seq_file *m);
389 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
390 int trace_empty(struct trace_iterator *iter);
391 
392 void trace_graph_return(struct ftrace_graph_ret *trace);
393 int trace_graph_entry(struct ftrace_graph_ent *trace);
394 void set_graph_array(struct trace_array *tr);
395 
396 void tracing_start_cmdline_record(void);
397 void tracing_stop_cmdline_record(void);
398 void tracing_sched_switch_assign_trace(struct trace_array *tr);
399 void tracing_stop_sched_switch_record(void);
400 void tracing_start_sched_switch_record(void);
401 int register_tracer(struct tracer *type);
402 void unregister_tracer(struct tracer *type);
403 int is_tracing_stopped(void);
404 enum trace_file_type {
405 	TRACE_FILE_LAT_FMT	= 1,
406 	TRACE_FILE_ANNOTATE	= 2,
407 };
408 
409 extern cpumask_var_t __read_mostly tracing_buffer_mask;
410 
411 #define for_each_tracing_cpu(cpu)	\
412 	for_each_cpu(cpu, tracing_buffer_mask)
413 
414 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
415 
416 extern unsigned long tracing_thresh;
417 
418 #ifdef CONFIG_TRACER_MAX_TRACE
419 extern unsigned long tracing_max_latency;
420 
421 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
422 void update_max_tr_single(struct trace_array *tr,
423 			  struct task_struct *tsk, int cpu);
424 #endif /* CONFIG_TRACER_MAX_TRACE */
425 
426 #ifdef CONFIG_STACKTRACE
427 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
428 			int skip, int pc);
429 
430 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
431 			     int skip, int pc, struct pt_regs *regs);
432 
433 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
434 			    int pc);
435 
436 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
437 		   int pc);
438 #else
439 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
440 				      unsigned long flags, int skip, int pc)
441 {
442 }
443 
444 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
445 					   unsigned long flags, int skip,
446 					   int pc, struct pt_regs *regs)
447 {
448 }
449 
450 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
451 					  unsigned long flags, int pc)
452 {
453 }
454 
455 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
456 				 int skip, int pc)
457 {
458 }
459 #endif /* CONFIG_STACKTRACE */
460 
461 extern cycle_t ftrace_now(int cpu);
462 
463 extern void trace_find_cmdline(int pid, char comm[]);
464 
465 #ifdef CONFIG_DYNAMIC_FTRACE
466 extern unsigned long ftrace_update_tot_cnt;
467 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
468 extern int DYN_FTRACE_TEST_NAME(void);
469 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
470 extern int DYN_FTRACE_TEST_NAME2(void);
471 #endif
472 
473 extern int ring_buffer_expanded;
474 extern bool tracing_selftest_disabled;
475 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
476 
477 #ifdef CONFIG_FTRACE_STARTUP_TEST
478 extern int trace_selftest_startup_function(struct tracer *trace,
479 					   struct trace_array *tr);
480 extern int trace_selftest_startup_function_graph(struct tracer *trace,
481 						 struct trace_array *tr);
482 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
483 					  struct trace_array *tr);
484 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
485 					     struct trace_array *tr);
486 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
487 						 struct trace_array *tr);
488 extern int trace_selftest_startup_wakeup(struct tracer *trace,
489 					 struct trace_array *tr);
490 extern int trace_selftest_startup_nop(struct tracer *trace,
491 					 struct trace_array *tr);
492 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
493 					       struct trace_array *tr);
494 extern int trace_selftest_startup_branch(struct tracer *trace,
495 					 struct trace_array *tr);
496 #endif /* CONFIG_FTRACE_STARTUP_TEST */
497 
498 extern void *head_page(struct trace_array_cpu *data);
499 extern unsigned long long ns2usecs(cycle_t nsec);
500 extern int
501 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
502 extern int
503 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
504 extern int
505 trace_array_vprintk(struct trace_array *tr,
506 		    unsigned long ip, const char *fmt, va_list args);
507 int trace_array_printk(struct trace_array *tr,
508 		       unsigned long ip, const char *fmt, ...);
509 void trace_printk_seq(struct trace_seq *s);
510 enum print_line_t print_trace_line(struct trace_iterator *iter);
511 
512 extern unsigned long trace_flags;
513 
514 extern int trace_clock_id;
515 
516 /* Standard output formatting function used for function return traces */
517 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
518 
519 /* Flag options */
520 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
521 #define TRACE_GRAPH_PRINT_CPU           0x2
522 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
523 #define TRACE_GRAPH_PRINT_PROC          0x8
524 #define TRACE_GRAPH_PRINT_DURATION      0x10
525 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
526 
527 extern enum print_line_t
528 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
529 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
530 extern enum print_line_t
531 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
532 extern void graph_trace_open(struct trace_iterator *iter);
533 extern void graph_trace_close(struct trace_iterator *iter);
534 extern int __trace_graph_entry(struct trace_array *tr,
535 			       struct ftrace_graph_ent *trace,
536 			       unsigned long flags, int pc);
537 extern void __trace_graph_return(struct trace_array *tr,
538 				 struct ftrace_graph_ret *trace,
539 				 unsigned long flags, int pc);
540 
541 
542 #ifdef CONFIG_DYNAMIC_FTRACE
543 /* TODO: make this variable */
544 #define FTRACE_GRAPH_MAX_FUNCS		32
545 extern int ftrace_graph_filter_enabled;
546 extern int ftrace_graph_count;
547 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
548 
549 static inline int ftrace_graph_addr(unsigned long addr)
550 {
551 	int i;
552 
553 	if (!ftrace_graph_filter_enabled)
554 		return 1;
555 
556 	for (i = 0; i < ftrace_graph_count; i++) {
557 		if (addr == ftrace_graph_funcs[i]) {
558 			/*
559 			 * If no irqs are to be traced, but a set_graph_function
560 			 * is set, and called by an interrupt handler, we still
561 			 * want to trace it.
562 			 */
563 			if (in_irq())
564 				trace_recursion_set(TRACE_IRQ_BIT);
565 			else
566 				trace_recursion_clear(TRACE_IRQ_BIT);
567 			return 1;
568 		}
569 	}
570 
571 	return 0;
572 }
573 #else
574 static inline int ftrace_graph_addr(unsigned long addr)
575 {
576 	return 1;
577 }
578 #endif /* CONFIG_DYNAMIC_FTRACE */
579 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
580 static inline enum print_line_t
581 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
582 {
583 	return TRACE_TYPE_UNHANDLED;
584 }
585 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
586 
587 extern struct list_head ftrace_pids;
588 
589 #ifdef CONFIG_FUNCTION_TRACER
590 static inline int ftrace_trace_task(struct task_struct *task)
591 {
592 	if (list_empty(&ftrace_pids))
593 		return 1;
594 
595 	return test_tsk_trace_trace(task);
596 }
597 extern int ftrace_is_dead(void);
598 #else
599 static inline int ftrace_trace_task(struct task_struct *task)
600 {
601 	return 1;
602 }
603 static inline int ftrace_is_dead(void) { return 0; }
604 #endif
605 
606 int ftrace_event_is_function(struct ftrace_event_call *call);
607 
608 /*
609  * struct trace_parser - servers for reading the user input separated by spaces
610  * @cont: set if the input is not complete - no final space char was found
611  * @buffer: holds the parsed user input
612  * @idx: user input length
613  * @size: buffer size
614  */
615 struct trace_parser {
616 	bool		cont;
617 	char		*buffer;
618 	unsigned	idx;
619 	unsigned	size;
620 };
621 
622 static inline bool trace_parser_loaded(struct trace_parser *parser)
623 {
624 	return (parser->idx != 0);
625 }
626 
627 static inline bool trace_parser_cont(struct trace_parser *parser)
628 {
629 	return parser->cont;
630 }
631 
632 static inline void trace_parser_clear(struct trace_parser *parser)
633 {
634 	parser->cont = false;
635 	parser->idx = 0;
636 }
637 
638 extern int trace_parser_get_init(struct trace_parser *parser, int size);
639 extern void trace_parser_put(struct trace_parser *parser);
640 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
641 	size_t cnt, loff_t *ppos);
642 
643 /*
644  * trace_iterator_flags is an enumeration that defines bit
645  * positions into trace_flags that controls the output.
646  *
647  * NOTE: These bits must match the trace_options array in
648  *       trace.c.
649  */
650 enum trace_iterator_flags {
651 	TRACE_ITER_PRINT_PARENT		= 0x01,
652 	TRACE_ITER_SYM_OFFSET		= 0x02,
653 	TRACE_ITER_SYM_ADDR		= 0x04,
654 	TRACE_ITER_VERBOSE		= 0x08,
655 	TRACE_ITER_RAW			= 0x10,
656 	TRACE_ITER_HEX			= 0x20,
657 	TRACE_ITER_BIN			= 0x40,
658 	TRACE_ITER_BLOCK		= 0x80,
659 	TRACE_ITER_STACKTRACE		= 0x100,
660 	TRACE_ITER_PRINTK		= 0x200,
661 	TRACE_ITER_PREEMPTONLY		= 0x400,
662 	TRACE_ITER_BRANCH		= 0x800,
663 	TRACE_ITER_ANNOTATE		= 0x1000,
664 	TRACE_ITER_USERSTACKTRACE       = 0x2000,
665 	TRACE_ITER_SYM_USEROBJ          = 0x4000,
666 	TRACE_ITER_PRINTK_MSGONLY	= 0x8000,
667 	TRACE_ITER_CONTEXT_INFO		= 0x10000, /* Print pid/cpu/time */
668 	TRACE_ITER_LATENCY_FMT		= 0x20000,
669 	TRACE_ITER_SLEEP_TIME		= 0x40000,
670 	TRACE_ITER_GRAPH_TIME		= 0x80000,
671 	TRACE_ITER_RECORD_CMD		= 0x100000,
672 	TRACE_ITER_OVERWRITE		= 0x200000,
673 	TRACE_ITER_STOP_ON_FREE		= 0x400000,
674 	TRACE_ITER_IRQ_INFO		= 0x800000,
675 };
676 
677 /*
678  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
679  * control the output of kernel symbols.
680  */
681 #define TRACE_ITER_SYM_MASK \
682 	(TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
683 
684 extern struct tracer nop_trace;
685 
686 #ifdef CONFIG_BRANCH_TRACER
687 extern int enable_branch_tracing(struct trace_array *tr);
688 extern void disable_branch_tracing(void);
689 static inline int trace_branch_enable(struct trace_array *tr)
690 {
691 	if (trace_flags & TRACE_ITER_BRANCH)
692 		return enable_branch_tracing(tr);
693 	return 0;
694 }
695 static inline void trace_branch_disable(void)
696 {
697 	/* due to races, always disable */
698 	disable_branch_tracing();
699 }
700 #else
701 static inline int trace_branch_enable(struct trace_array *tr)
702 {
703 	return 0;
704 }
705 static inline void trace_branch_disable(void)
706 {
707 }
708 #endif /* CONFIG_BRANCH_TRACER */
709 
710 /* set ring buffers to default size if not already done so */
711 int tracing_update_buffers(void);
712 
713 /* trace event type bit fields, not numeric */
714 enum {
715 	TRACE_EVENT_TYPE_PRINTF		= 1,
716 	TRACE_EVENT_TYPE_RAW		= 2,
717 };
718 
719 struct ftrace_event_field {
720 	struct list_head	link;
721 	char			*name;
722 	char			*type;
723 	int			filter_type;
724 	int			offset;
725 	int			size;
726 	int			is_signed;
727 };
728 
729 struct event_filter {
730 	int			n_preds;	/* Number assigned */
731 	int			a_preds;	/* allocated */
732 	struct filter_pred	*preds;
733 	struct filter_pred	*root;
734 	char			*filter_string;
735 };
736 
737 struct event_subsystem {
738 	struct list_head	list;
739 	const char		*name;
740 	struct dentry		*entry;
741 	struct event_filter	*filter;
742 	int			nr_events;
743 	int			ref_count;
744 };
745 
746 #define FILTER_PRED_INVALID	((unsigned short)-1)
747 #define FILTER_PRED_IS_RIGHT	(1 << 15)
748 #define FILTER_PRED_FOLD	(1 << 15)
749 
750 /*
751  * The max preds is the size of unsigned short with
752  * two flags at the MSBs. One bit is used for both the IS_RIGHT
753  * and FOLD flags. The other is reserved.
754  *
755  * 2^14 preds is way more than enough.
756  */
757 #define MAX_FILTER_PRED		16384
758 
759 struct filter_pred;
760 struct regex;
761 
762 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
763 
764 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
765 
766 enum regex_type {
767 	MATCH_FULL = 0,
768 	MATCH_FRONT_ONLY,
769 	MATCH_MIDDLE_ONLY,
770 	MATCH_END_ONLY,
771 };
772 
773 struct regex {
774 	char			pattern[MAX_FILTER_STR_VAL];
775 	int			len;
776 	int			field_len;
777 	regex_match_func	match;
778 };
779 
780 struct filter_pred {
781 	filter_pred_fn_t 	fn;
782 	u64 			val;
783 	struct regex		regex;
784 	unsigned short		*ops;
785 	struct ftrace_event_field *field;
786 	int 			offset;
787 	int 			not;
788 	int 			op;
789 	unsigned short		index;
790 	unsigned short		parent;
791 	unsigned short		left;
792 	unsigned short		right;
793 };
794 
795 extern struct list_head ftrace_common_fields;
796 
797 extern enum regex_type
798 filter_parse_regex(char *buff, int len, char **search, int *not);
799 extern void print_event_filter(struct ftrace_event_call *call,
800 			       struct trace_seq *s);
801 extern int apply_event_filter(struct ftrace_event_call *call,
802 			      char *filter_string);
803 extern int apply_subsystem_event_filter(struct event_subsystem *system,
804 					char *filter_string);
805 extern void print_subsystem_event_filter(struct event_subsystem *system,
806 					 struct trace_seq *s);
807 extern int filter_assign_type(const char *type);
808 
809 struct list_head *
810 trace_get_fields(struct ftrace_event_call *event_call);
811 
812 static inline int
813 filter_check_discard(struct ftrace_event_call *call, void *rec,
814 		     struct ring_buffer *buffer,
815 		     struct ring_buffer_event *event)
816 {
817 	if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
818 	    !filter_match_preds(call->filter, rec)) {
819 		ring_buffer_discard_commit(buffer, event);
820 		return 1;
821 	}
822 
823 	return 0;
824 }
825 
826 extern void trace_event_enable_cmd_record(bool enable);
827 
828 extern struct mutex event_mutex;
829 extern struct list_head ftrace_events;
830 
831 extern const char *__start___trace_bprintk_fmt[];
832 extern const char *__stop___trace_bprintk_fmt[];
833 
834 void trace_printk_init_buffers(void);
835 
836 #undef FTRACE_ENTRY
837 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)	\
838 	extern struct ftrace_event_call					\
839 	__attribute__((__aligned__(4))) event_##call;
840 #undef FTRACE_ENTRY_DUP
841 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter)	\
842 	FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
843 		     filter)
844 #include "trace_entries.h"
845 
846 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
847 int perf_ftrace_event_register(struct ftrace_event_call *call,
848 			       enum trace_reg type, void *data);
849 #else
850 #define perf_ftrace_event_register NULL
851 #endif
852 
853 #endif /* _LINUX_KERNEL_TRACE_H */
854