xref: /linux/kernel/trace/trace.h (revision 148f9bb87745ed45f7a11b2cbd3bc0f017d5d257)
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 #ifdef CONFIG_FTRACE_SYSCALLS
17 #include <asm/unistd.h>		/* For NR_SYSCALLS	     */
18 #include <asm/syscall.h>	/* some archs define it here */
19 #endif
20 
21 enum trace_type {
22 	__TRACE_FIRST_TYPE = 0,
23 
24 	TRACE_FN,
25 	TRACE_CTX,
26 	TRACE_WAKE,
27 	TRACE_STACK,
28 	TRACE_PRINT,
29 	TRACE_BPRINT,
30 	TRACE_MMIO_RW,
31 	TRACE_MMIO_MAP,
32 	TRACE_BRANCH,
33 	TRACE_GRAPH_RET,
34 	TRACE_GRAPH_ENT,
35 	TRACE_USER_STACK,
36 	TRACE_BLK,
37 	TRACE_BPUTS,
38 
39 	__TRACE_LAST_TYPE,
40 };
41 
42 
43 #undef __field
44 #define __field(type, item)		type	item;
45 
46 #undef __field_struct
47 #define __field_struct(type, item)	__field(type, item)
48 
49 #undef __field_desc
50 #define __field_desc(type, container, item)
51 
52 #undef __array
53 #define __array(type, item, size)	type	item[size];
54 
55 #undef __array_desc
56 #define __array_desc(type, container, item, size)
57 
58 #undef __dynamic_array
59 #define __dynamic_array(type, item)	type	item[];
60 
61 #undef F_STRUCT
62 #define F_STRUCT(args...)		args
63 
64 #undef FTRACE_ENTRY
65 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter)	\
66 	struct struct_name {						\
67 		struct trace_entry	ent;				\
68 		tstruct							\
69 	}
70 
71 #undef TP_ARGS
72 #define TP_ARGS(args...)	args
73 
74 #undef FTRACE_ENTRY_DUP
75 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
76 
77 #undef FTRACE_ENTRY_REG
78 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print,	\
79 			 filter, regfn) \
80 	FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
81 		     filter)
82 
83 #include "trace_entries.h"
84 
85 /*
86  * syscalls are special, and need special handling, this is why
87  * they are not included in trace_entries.h
88  */
89 struct syscall_trace_enter {
90 	struct trace_entry	ent;
91 	int			nr;
92 	unsigned long		args[];
93 };
94 
95 struct syscall_trace_exit {
96 	struct trace_entry	ent;
97 	int			nr;
98 	long			ret;
99 };
100 
101 struct kprobe_trace_entry_head {
102 	struct trace_entry	ent;
103 	unsigned long		ip;
104 };
105 
106 struct kretprobe_trace_entry_head {
107 	struct trace_entry	ent;
108 	unsigned long		func;
109 	unsigned long		ret_ip;
110 };
111 
112 /*
113  * trace_flag_type is an enumeration that holds different
114  * states when a trace occurs. These are:
115  *  IRQS_OFF		- interrupts were disabled
116  *  IRQS_NOSUPPORT	- arch does not support irqs_disabled_flags
117  *  NEED_RESCHED	- reschedule is requested
118  *  HARDIRQ		- inside an interrupt handler
119  *  SOFTIRQ		- inside a softirq handler
120  */
121 enum trace_flag_type {
122 	TRACE_FLAG_IRQS_OFF		= 0x01,
123 	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
124 	TRACE_FLAG_NEED_RESCHED		= 0x04,
125 	TRACE_FLAG_HARDIRQ		= 0x08,
126 	TRACE_FLAG_SOFTIRQ		= 0x10,
127 };
128 
129 #define TRACE_BUF_SIZE		1024
130 
131 struct trace_array;
132 
133 struct trace_cpu {
134 	struct trace_array	*tr;
135 	struct dentry		*dir;
136 	int			cpu;
137 };
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  */
144 struct trace_array_cpu {
145 	struct trace_cpu	trace_cpu;
146 	atomic_t		disabled;
147 	void			*buffer_page;	/* ring buffer spare */
148 
149 	unsigned long		entries;
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 	unsigned long		skipped_entries;
158 	cycle_t			preempt_timestamp;
159 	pid_t			pid;
160 	kuid_t			uid;
161 	char			comm[TASK_COMM_LEN];
162 };
163 
164 struct tracer;
165 
166 struct trace_buffer {
167 	struct trace_array		*tr;
168 	struct ring_buffer		*buffer;
169 	struct trace_array_cpu __percpu	*data;
170 	cycle_t				time_start;
171 	int				cpu;
172 };
173 
174 /*
175  * The trace array - an array of per-CPU trace arrays. This is the
176  * highest level data structure that individual tracers deal with.
177  * They have on/off state as well:
178  */
179 struct trace_array {
180 	struct list_head	list;
181 	char			*name;
182 	struct trace_buffer	trace_buffer;
183 #ifdef CONFIG_TRACER_MAX_TRACE
184 	/*
185 	 * The max_buffer is used to snapshot the trace when a maximum
186 	 * latency is reached, or when the user initiates a snapshot.
187 	 * Some tracers will use this to store a maximum trace while
188 	 * it continues examining live traces.
189 	 *
190 	 * The buffers for the max_buffer are set up the same as the trace_buffer
191 	 * When a snapshot is taken, the buffer of the max_buffer is swapped
192 	 * with the buffer of the trace_buffer and the buffers are reset for
193 	 * the trace_buffer so the tracing can continue.
194 	 */
195 	struct trace_buffer	max_buffer;
196 	bool			allocated_snapshot;
197 #endif
198 	int			buffer_disabled;
199 	struct trace_cpu	trace_cpu;	/* place holder */
200 #ifdef CONFIG_FTRACE_SYSCALLS
201 	int			sys_refcount_enter;
202 	int			sys_refcount_exit;
203 	DECLARE_BITMAP(enabled_enter_syscalls, NR_syscalls);
204 	DECLARE_BITMAP(enabled_exit_syscalls, NR_syscalls);
205 #endif
206 	int			stop_count;
207 	int			clock_id;
208 	struct tracer		*current_trace;
209 	unsigned int		flags;
210 	raw_spinlock_t		start_lock;
211 	struct dentry		*dir;
212 	struct dentry		*options;
213 	struct dentry		*percpu_dir;
214 	struct dentry		*event_dir;
215 	struct list_head	systems;
216 	struct list_head	events;
217 	struct task_struct	*waiter;
218 	int			ref;
219 };
220 
221 enum {
222 	TRACE_ARRAY_FL_GLOBAL	= (1 << 0)
223 };
224 
225 extern struct list_head ftrace_trace_arrays;
226 
227 extern struct mutex trace_types_lock;
228 
229 extern int trace_array_get(struct trace_array *tr);
230 extern void trace_array_put(struct trace_array *tr);
231 
232 /*
233  * The global tracer (top) should be the first trace array added,
234  * but we check the flag anyway.
235  */
236 static inline struct trace_array *top_trace_array(void)
237 {
238 	struct trace_array *tr;
239 
240 	tr = list_entry(ftrace_trace_arrays.prev,
241 			typeof(*tr), list);
242 	WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
243 	return tr;
244 }
245 
246 #define FTRACE_CMP_TYPE(var, type) \
247 	__builtin_types_compatible_p(typeof(var), type *)
248 
249 #undef IF_ASSIGN
250 #define IF_ASSIGN(var, entry, etype, id)		\
251 	if (FTRACE_CMP_TYPE(var, etype)) {		\
252 		var = (typeof(var))(entry);		\
253 		WARN_ON(id && (entry)->type != id);	\
254 		break;					\
255 	}
256 
257 /* Will cause compile errors if type is not found. */
258 extern void __ftrace_bad_type(void);
259 
260 /*
261  * The trace_assign_type is a verifier that the entry type is
262  * the same as the type being assigned. To add new types simply
263  * add a line with the following format:
264  *
265  * IF_ASSIGN(var, ent, type, id);
266  *
267  *  Where "type" is the trace type that includes the trace_entry
268  *  as the "ent" item. And "id" is the trace identifier that is
269  *  used in the trace_type enum.
270  *
271  *  If the type can have more than one id, then use zero.
272  */
273 #define trace_assign_type(var, ent)					\
274 	do {								\
275 		IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);	\
276 		IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);	\
277 		IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);	\
278 		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
279 		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
280 		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
281 		IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS);	\
282 		IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,		\
283 			  TRACE_MMIO_RW);				\
284 		IF_ASSIGN(var, ent, struct trace_mmiotrace_map,		\
285 			  TRACE_MMIO_MAP);				\
286 		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
287 		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
288 			  TRACE_GRAPH_ENT);		\
289 		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
290 			  TRACE_GRAPH_RET);		\
291 		__ftrace_bad_type();					\
292 	} while (0)
293 
294 /*
295  * An option specific to a tracer. This is a boolean value.
296  * The bit is the bit index that sets its value on the
297  * flags value in struct tracer_flags.
298  */
299 struct tracer_opt {
300 	const char	*name; /* Will appear on the trace_options file */
301 	u32		bit; /* Mask assigned in val field in tracer_flags */
302 };
303 
304 /*
305  * The set of specific options for a tracer. Your tracer
306  * have to set the initial value of the flags val.
307  */
308 struct tracer_flags {
309 	u32			val;
310 	struct tracer_opt	*opts;
311 };
312 
313 /* Makes more easy to define a tracer opt */
314 #define TRACER_OPT(s, b)	.name = #s, .bit = b
315 
316 
317 /**
318  * struct tracer - a specific tracer and its callbacks to interact with debugfs
319  * @name: the name chosen to select it on the available_tracers file
320  * @init: called when one switches to this tracer (echo name > current_tracer)
321  * @reset: called when one switches to another tracer
322  * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
323  * @stop: called when tracing is paused (echo 0 > tracing_enabled)
324  * @open: called when the trace file is opened
325  * @pipe_open: called when the trace_pipe file is opened
326  * @wait_pipe: override how the user waits for traces on trace_pipe
327  * @close: called when the trace file is released
328  * @pipe_close: called when the trace_pipe file is released
329  * @read: override the default read callback on trace_pipe
330  * @splice_read: override the default splice_read callback on trace_pipe
331  * @selftest: selftest to run on boot (see trace_selftest.c)
332  * @print_headers: override the first lines that describe your columns
333  * @print_line: callback that prints a trace
334  * @set_flag: signals one of your private flags changed (trace_options file)
335  * @flags: your private flags
336  */
337 struct tracer {
338 	const char		*name;
339 	int			(*init)(struct trace_array *tr);
340 	void			(*reset)(struct trace_array *tr);
341 	void			(*start)(struct trace_array *tr);
342 	void			(*stop)(struct trace_array *tr);
343 	void			(*open)(struct trace_iterator *iter);
344 	void			(*pipe_open)(struct trace_iterator *iter);
345 	void			(*wait_pipe)(struct trace_iterator *iter);
346 	void			(*close)(struct trace_iterator *iter);
347 	void			(*pipe_close)(struct trace_iterator *iter);
348 	ssize_t			(*read)(struct trace_iterator *iter,
349 					struct file *filp, char __user *ubuf,
350 					size_t cnt, loff_t *ppos);
351 	ssize_t			(*splice_read)(struct trace_iterator *iter,
352 					       struct file *filp,
353 					       loff_t *ppos,
354 					       struct pipe_inode_info *pipe,
355 					       size_t len,
356 					       unsigned int flags);
357 #ifdef CONFIG_FTRACE_STARTUP_TEST
358 	int			(*selftest)(struct tracer *trace,
359 					    struct trace_array *tr);
360 #endif
361 	void			(*print_header)(struct seq_file *m);
362 	enum print_line_t	(*print_line)(struct trace_iterator *iter);
363 	/* If you handled the flag setting, return 0 */
364 	int			(*set_flag)(u32 old_flags, u32 bit, int set);
365 	/* Return 0 if OK with change, else return non-zero */
366 	int			(*flag_changed)(struct tracer *tracer,
367 						u32 mask, int set);
368 	struct tracer		*next;
369 	struct tracer_flags	*flags;
370 	bool			print_max;
371 	bool			enabled;
372 #ifdef CONFIG_TRACER_MAX_TRACE
373 	bool			use_max_tr;
374 #endif
375 };
376 
377 
378 /* Only current can touch trace_recursion */
379 
380 /*
381  * For function tracing recursion:
382  *  The order of these bits are important.
383  *
384  *  When function tracing occurs, the following steps are made:
385  *   If arch does not support a ftrace feature:
386  *    call internal function (uses INTERNAL bits) which calls...
387  *   If callback is registered to the "global" list, the list
388  *    function is called and recursion checks the GLOBAL bits.
389  *    then this function calls...
390  *   The function callback, which can use the FTRACE bits to
391  *    check for recursion.
392  *
393  * Now if the arch does not suppport a feature, and it calls
394  * the global list function which calls the ftrace callback
395  * all three of these steps will do a recursion protection.
396  * There's no reason to do one if the previous caller already
397  * did. The recursion that we are protecting against will
398  * go through the same steps again.
399  *
400  * To prevent the multiple recursion checks, if a recursion
401  * bit is set that is higher than the MAX bit of the current
402  * check, then we know that the check was made by the previous
403  * caller, and we can skip the current check.
404  */
405 enum {
406 	TRACE_BUFFER_BIT,
407 	TRACE_BUFFER_NMI_BIT,
408 	TRACE_BUFFER_IRQ_BIT,
409 	TRACE_BUFFER_SIRQ_BIT,
410 
411 	/* Start of function recursion bits */
412 	TRACE_FTRACE_BIT,
413 	TRACE_FTRACE_NMI_BIT,
414 	TRACE_FTRACE_IRQ_BIT,
415 	TRACE_FTRACE_SIRQ_BIT,
416 
417 	/* GLOBAL_BITs must be greater than FTRACE_BITs */
418 	TRACE_GLOBAL_BIT,
419 	TRACE_GLOBAL_NMI_BIT,
420 	TRACE_GLOBAL_IRQ_BIT,
421 	TRACE_GLOBAL_SIRQ_BIT,
422 
423 	/* INTERNAL_BITs must be greater than GLOBAL_BITs */
424 	TRACE_INTERNAL_BIT,
425 	TRACE_INTERNAL_NMI_BIT,
426 	TRACE_INTERNAL_IRQ_BIT,
427 	TRACE_INTERNAL_SIRQ_BIT,
428 
429 	TRACE_CONTROL_BIT,
430 
431 /*
432  * Abuse of the trace_recursion.
433  * As we need a way to maintain state if we are tracing the function
434  * graph in irq because we want to trace a particular function that
435  * was called in irq context but we have irq tracing off. Since this
436  * can only be modified by current, we can reuse trace_recursion.
437  */
438 	TRACE_IRQ_BIT,
439 };
440 
441 #define trace_recursion_set(bit)	do { (current)->trace_recursion |= (1<<(bit)); } while (0)
442 #define trace_recursion_clear(bit)	do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
443 #define trace_recursion_test(bit)	((current)->trace_recursion & (1<<(bit)))
444 
445 #define TRACE_CONTEXT_BITS	4
446 
447 #define TRACE_FTRACE_START	TRACE_FTRACE_BIT
448 #define TRACE_FTRACE_MAX	((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
449 
450 #define TRACE_GLOBAL_START	TRACE_GLOBAL_BIT
451 #define TRACE_GLOBAL_MAX	((1 << (TRACE_GLOBAL_START + TRACE_CONTEXT_BITS)) - 1)
452 
453 #define TRACE_LIST_START	TRACE_INTERNAL_BIT
454 #define TRACE_LIST_MAX		((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
455 
456 #define TRACE_CONTEXT_MASK	TRACE_LIST_MAX
457 
458 static __always_inline int trace_get_context_bit(void)
459 {
460 	int bit;
461 
462 	if (in_interrupt()) {
463 		if (in_nmi())
464 			bit = 0;
465 
466 		else if (in_irq())
467 			bit = 1;
468 		else
469 			bit = 2;
470 	} else
471 		bit = 3;
472 
473 	return bit;
474 }
475 
476 static __always_inline int trace_test_and_set_recursion(int start, int max)
477 {
478 	unsigned int val = current->trace_recursion;
479 	int bit;
480 
481 	/* A previous recursion check was made */
482 	if ((val & TRACE_CONTEXT_MASK) > max)
483 		return 0;
484 
485 	bit = trace_get_context_bit() + start;
486 	if (unlikely(val & (1 << bit)))
487 		return -1;
488 
489 	val |= 1 << bit;
490 	current->trace_recursion = val;
491 	barrier();
492 
493 	return bit;
494 }
495 
496 static __always_inline void trace_clear_recursion(int bit)
497 {
498 	unsigned int val = current->trace_recursion;
499 
500 	if (!bit)
501 		return;
502 
503 	bit = 1 << bit;
504 	val &= ~bit;
505 
506 	barrier();
507 	current->trace_recursion = val;
508 }
509 
510 static inline struct ring_buffer_iter *
511 trace_buffer_iter(struct trace_iterator *iter, int cpu)
512 {
513 	if (iter->buffer_iter && iter->buffer_iter[cpu])
514 		return iter->buffer_iter[cpu];
515 	return NULL;
516 }
517 
518 int tracer_init(struct tracer *t, struct trace_array *tr);
519 int tracing_is_enabled(void);
520 void tracing_reset(struct trace_buffer *buf, int cpu);
521 void tracing_reset_online_cpus(struct trace_buffer *buf);
522 void tracing_reset_current(int cpu);
523 void tracing_reset_all_online_cpus(void);
524 int tracing_open_generic(struct inode *inode, struct file *filp);
525 struct dentry *trace_create_file(const char *name,
526 				 umode_t mode,
527 				 struct dentry *parent,
528 				 void *data,
529 				 const struct file_operations *fops);
530 
531 struct dentry *tracing_init_dentry_tr(struct trace_array *tr);
532 struct dentry *tracing_init_dentry(void);
533 
534 struct ring_buffer_event;
535 
536 struct ring_buffer_event *
537 trace_buffer_lock_reserve(struct ring_buffer *buffer,
538 			  int type,
539 			  unsigned long len,
540 			  unsigned long flags,
541 			  int pc);
542 
543 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
544 						struct trace_array_cpu *data);
545 
546 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
547 					  int *ent_cpu, u64 *ent_ts);
548 
549 void __buffer_unlock_commit(struct ring_buffer *buffer,
550 			    struct ring_buffer_event *event);
551 
552 int trace_empty(struct trace_iterator *iter);
553 
554 void *trace_find_next_entry_inc(struct trace_iterator *iter);
555 
556 void trace_init_global_iter(struct trace_iterator *iter);
557 
558 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
559 
560 void poll_wait_pipe(struct trace_iterator *iter);
561 
562 void tracing_sched_switch_trace(struct trace_array *tr,
563 				struct task_struct *prev,
564 				struct task_struct *next,
565 				unsigned long flags, int pc);
566 
567 void tracing_sched_wakeup_trace(struct trace_array *tr,
568 				struct task_struct *wakee,
569 				struct task_struct *cur,
570 				unsigned long flags, int pc);
571 void trace_function(struct trace_array *tr,
572 		    unsigned long ip,
573 		    unsigned long parent_ip,
574 		    unsigned long flags, int pc);
575 void trace_graph_function(struct trace_array *tr,
576 		    unsigned long ip,
577 		    unsigned long parent_ip,
578 		    unsigned long flags, int pc);
579 void trace_latency_header(struct seq_file *m);
580 void trace_default_header(struct seq_file *m);
581 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
582 int trace_empty(struct trace_iterator *iter);
583 
584 void trace_graph_return(struct ftrace_graph_ret *trace);
585 int trace_graph_entry(struct ftrace_graph_ent *trace);
586 void set_graph_array(struct trace_array *tr);
587 
588 void tracing_start_cmdline_record(void);
589 void tracing_stop_cmdline_record(void);
590 void tracing_sched_switch_assign_trace(struct trace_array *tr);
591 void tracing_stop_sched_switch_record(void);
592 void tracing_start_sched_switch_record(void);
593 int register_tracer(struct tracer *type);
594 int is_tracing_stopped(void);
595 
596 extern cpumask_var_t __read_mostly tracing_buffer_mask;
597 
598 #define for_each_tracing_cpu(cpu)	\
599 	for_each_cpu(cpu, tracing_buffer_mask)
600 
601 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
602 
603 extern unsigned long tracing_thresh;
604 
605 #ifdef CONFIG_TRACER_MAX_TRACE
606 extern unsigned long tracing_max_latency;
607 
608 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
609 void update_max_tr_single(struct trace_array *tr,
610 			  struct task_struct *tsk, int cpu);
611 #endif /* CONFIG_TRACER_MAX_TRACE */
612 
613 #ifdef CONFIG_STACKTRACE
614 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
615 			int skip, int pc);
616 
617 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
618 			     int skip, int pc, struct pt_regs *regs);
619 
620 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
621 			    int pc);
622 
623 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
624 		   int pc);
625 #else
626 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
627 				      unsigned long flags, int skip, int pc)
628 {
629 }
630 
631 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
632 					   unsigned long flags, int skip,
633 					   int pc, struct pt_regs *regs)
634 {
635 }
636 
637 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
638 					  unsigned long flags, int pc)
639 {
640 }
641 
642 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
643 				 int skip, int pc)
644 {
645 }
646 #endif /* CONFIG_STACKTRACE */
647 
648 extern cycle_t ftrace_now(int cpu);
649 
650 extern void trace_find_cmdline(int pid, char comm[]);
651 
652 #ifdef CONFIG_DYNAMIC_FTRACE
653 extern unsigned long ftrace_update_tot_cnt;
654 #endif
655 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
656 extern int DYN_FTRACE_TEST_NAME(void);
657 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
658 extern int DYN_FTRACE_TEST_NAME2(void);
659 
660 extern bool ring_buffer_expanded;
661 extern bool tracing_selftest_disabled;
662 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
663 
664 #ifdef CONFIG_FTRACE_STARTUP_TEST
665 extern int trace_selftest_startup_function(struct tracer *trace,
666 					   struct trace_array *tr);
667 extern int trace_selftest_startup_function_graph(struct tracer *trace,
668 						 struct trace_array *tr);
669 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
670 					  struct trace_array *tr);
671 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
672 					     struct trace_array *tr);
673 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
674 						 struct trace_array *tr);
675 extern int trace_selftest_startup_wakeup(struct tracer *trace,
676 					 struct trace_array *tr);
677 extern int trace_selftest_startup_nop(struct tracer *trace,
678 					 struct trace_array *tr);
679 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
680 					       struct trace_array *tr);
681 extern int trace_selftest_startup_branch(struct tracer *trace,
682 					 struct trace_array *tr);
683 #endif /* CONFIG_FTRACE_STARTUP_TEST */
684 
685 extern void *head_page(struct trace_array_cpu *data);
686 extern unsigned long long ns2usecs(cycle_t nsec);
687 extern int
688 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
689 extern int
690 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
691 extern int
692 trace_array_vprintk(struct trace_array *tr,
693 		    unsigned long ip, const char *fmt, va_list args);
694 int trace_array_printk(struct trace_array *tr,
695 		       unsigned long ip, const char *fmt, ...);
696 int trace_array_printk_buf(struct ring_buffer *buffer,
697 			   unsigned long ip, const char *fmt, ...);
698 void trace_printk_seq(struct trace_seq *s);
699 enum print_line_t print_trace_line(struct trace_iterator *iter);
700 
701 extern unsigned long trace_flags;
702 
703 /* Standard output formatting function used for function return traces */
704 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
705 
706 /* Flag options */
707 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
708 #define TRACE_GRAPH_PRINT_CPU           0x2
709 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
710 #define TRACE_GRAPH_PRINT_PROC          0x8
711 #define TRACE_GRAPH_PRINT_DURATION      0x10
712 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
713 
714 extern enum print_line_t
715 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
716 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
717 extern enum print_line_t
718 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
719 extern void graph_trace_open(struct trace_iterator *iter);
720 extern void graph_trace_close(struct trace_iterator *iter);
721 extern int __trace_graph_entry(struct trace_array *tr,
722 			       struct ftrace_graph_ent *trace,
723 			       unsigned long flags, int pc);
724 extern void __trace_graph_return(struct trace_array *tr,
725 				 struct ftrace_graph_ret *trace,
726 				 unsigned long flags, int pc);
727 
728 
729 #ifdef CONFIG_DYNAMIC_FTRACE
730 /* TODO: make this variable */
731 #define FTRACE_GRAPH_MAX_FUNCS		32
732 extern int ftrace_graph_filter_enabled;
733 extern int ftrace_graph_count;
734 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
735 
736 static inline int ftrace_graph_addr(unsigned long addr)
737 {
738 	int i;
739 
740 	if (!ftrace_graph_filter_enabled)
741 		return 1;
742 
743 	for (i = 0; i < ftrace_graph_count; i++) {
744 		if (addr == ftrace_graph_funcs[i]) {
745 			/*
746 			 * If no irqs are to be traced, but a set_graph_function
747 			 * is set, and called by an interrupt handler, we still
748 			 * want to trace it.
749 			 */
750 			if (in_irq())
751 				trace_recursion_set(TRACE_IRQ_BIT);
752 			else
753 				trace_recursion_clear(TRACE_IRQ_BIT);
754 			return 1;
755 		}
756 	}
757 
758 	return 0;
759 }
760 #else
761 static inline int ftrace_graph_addr(unsigned long addr)
762 {
763 	return 1;
764 }
765 #endif /* CONFIG_DYNAMIC_FTRACE */
766 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
767 static inline enum print_line_t
768 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
769 {
770 	return TRACE_TYPE_UNHANDLED;
771 }
772 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
773 
774 extern struct list_head ftrace_pids;
775 
776 #ifdef CONFIG_FUNCTION_TRACER
777 extern bool ftrace_filter_param __initdata;
778 static inline int ftrace_trace_task(struct task_struct *task)
779 {
780 	if (list_empty(&ftrace_pids))
781 		return 1;
782 
783 	return test_tsk_trace_trace(task);
784 }
785 extern int ftrace_is_dead(void);
786 #else
787 static inline int ftrace_trace_task(struct task_struct *task)
788 {
789 	return 1;
790 }
791 static inline int ftrace_is_dead(void) { return 0; }
792 #endif
793 
794 int ftrace_event_is_function(struct ftrace_event_call *call);
795 
796 /*
797  * struct trace_parser - servers for reading the user input separated by spaces
798  * @cont: set if the input is not complete - no final space char was found
799  * @buffer: holds the parsed user input
800  * @idx: user input length
801  * @size: buffer size
802  */
803 struct trace_parser {
804 	bool		cont;
805 	char		*buffer;
806 	unsigned	idx;
807 	unsigned	size;
808 };
809 
810 static inline bool trace_parser_loaded(struct trace_parser *parser)
811 {
812 	return (parser->idx != 0);
813 }
814 
815 static inline bool trace_parser_cont(struct trace_parser *parser)
816 {
817 	return parser->cont;
818 }
819 
820 static inline void trace_parser_clear(struct trace_parser *parser)
821 {
822 	parser->cont = false;
823 	parser->idx = 0;
824 }
825 
826 extern int trace_parser_get_init(struct trace_parser *parser, int size);
827 extern void trace_parser_put(struct trace_parser *parser);
828 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
829 	size_t cnt, loff_t *ppos);
830 
831 /*
832  * trace_iterator_flags is an enumeration that defines bit
833  * positions into trace_flags that controls the output.
834  *
835  * NOTE: These bits must match the trace_options array in
836  *       trace.c.
837  */
838 enum trace_iterator_flags {
839 	TRACE_ITER_PRINT_PARENT		= 0x01,
840 	TRACE_ITER_SYM_OFFSET		= 0x02,
841 	TRACE_ITER_SYM_ADDR		= 0x04,
842 	TRACE_ITER_VERBOSE		= 0x08,
843 	TRACE_ITER_RAW			= 0x10,
844 	TRACE_ITER_HEX			= 0x20,
845 	TRACE_ITER_BIN			= 0x40,
846 	TRACE_ITER_BLOCK		= 0x80,
847 	TRACE_ITER_STACKTRACE		= 0x100,
848 	TRACE_ITER_PRINTK		= 0x200,
849 	TRACE_ITER_PREEMPTONLY		= 0x400,
850 	TRACE_ITER_BRANCH		= 0x800,
851 	TRACE_ITER_ANNOTATE		= 0x1000,
852 	TRACE_ITER_USERSTACKTRACE       = 0x2000,
853 	TRACE_ITER_SYM_USEROBJ          = 0x4000,
854 	TRACE_ITER_PRINTK_MSGONLY	= 0x8000,
855 	TRACE_ITER_CONTEXT_INFO		= 0x10000, /* Print pid/cpu/time */
856 	TRACE_ITER_LATENCY_FMT		= 0x20000,
857 	TRACE_ITER_SLEEP_TIME		= 0x40000,
858 	TRACE_ITER_GRAPH_TIME		= 0x80000,
859 	TRACE_ITER_RECORD_CMD		= 0x100000,
860 	TRACE_ITER_OVERWRITE		= 0x200000,
861 	TRACE_ITER_STOP_ON_FREE		= 0x400000,
862 	TRACE_ITER_IRQ_INFO		= 0x800000,
863 	TRACE_ITER_MARKERS		= 0x1000000,
864 	TRACE_ITER_FUNCTION		= 0x2000000,
865 };
866 
867 /*
868  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
869  * control the output of kernel symbols.
870  */
871 #define TRACE_ITER_SYM_MASK \
872 	(TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
873 
874 extern struct tracer nop_trace;
875 
876 #ifdef CONFIG_BRANCH_TRACER
877 extern int enable_branch_tracing(struct trace_array *tr);
878 extern void disable_branch_tracing(void);
879 static inline int trace_branch_enable(struct trace_array *tr)
880 {
881 	if (trace_flags & TRACE_ITER_BRANCH)
882 		return enable_branch_tracing(tr);
883 	return 0;
884 }
885 static inline void trace_branch_disable(void)
886 {
887 	/* due to races, always disable */
888 	disable_branch_tracing();
889 }
890 #else
891 static inline int trace_branch_enable(struct trace_array *tr)
892 {
893 	return 0;
894 }
895 static inline void trace_branch_disable(void)
896 {
897 }
898 #endif /* CONFIG_BRANCH_TRACER */
899 
900 /* set ring buffers to default size if not already done so */
901 int tracing_update_buffers(void);
902 
903 struct ftrace_event_field {
904 	struct list_head	link;
905 	const char		*name;
906 	const char		*type;
907 	int			filter_type;
908 	int			offset;
909 	int			size;
910 	int			is_signed;
911 };
912 
913 struct event_filter {
914 	int			n_preds;	/* Number assigned */
915 	int			a_preds;	/* allocated */
916 	struct filter_pred	*preds;
917 	struct filter_pred	*root;
918 	char			*filter_string;
919 };
920 
921 struct event_subsystem {
922 	struct list_head	list;
923 	const char		*name;
924 	struct event_filter	*filter;
925 	int			ref_count;
926 };
927 
928 struct ftrace_subsystem_dir {
929 	struct list_head		list;
930 	struct event_subsystem		*subsystem;
931 	struct trace_array		*tr;
932 	struct dentry			*entry;
933 	int				ref_count;
934 	int				nr_events;
935 };
936 
937 #define FILTER_PRED_INVALID	((unsigned short)-1)
938 #define FILTER_PRED_IS_RIGHT	(1 << 15)
939 #define FILTER_PRED_FOLD	(1 << 15)
940 
941 /*
942  * The max preds is the size of unsigned short with
943  * two flags at the MSBs. One bit is used for both the IS_RIGHT
944  * and FOLD flags. The other is reserved.
945  *
946  * 2^14 preds is way more than enough.
947  */
948 #define MAX_FILTER_PRED		16384
949 
950 struct filter_pred;
951 struct regex;
952 
953 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
954 
955 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
956 
957 enum regex_type {
958 	MATCH_FULL = 0,
959 	MATCH_FRONT_ONLY,
960 	MATCH_MIDDLE_ONLY,
961 	MATCH_END_ONLY,
962 };
963 
964 struct regex {
965 	char			pattern[MAX_FILTER_STR_VAL];
966 	int			len;
967 	int			field_len;
968 	regex_match_func	match;
969 };
970 
971 struct filter_pred {
972 	filter_pred_fn_t 	fn;
973 	u64 			val;
974 	struct regex		regex;
975 	unsigned short		*ops;
976 	struct ftrace_event_field *field;
977 	int 			offset;
978 	int 			not;
979 	int 			op;
980 	unsigned short		index;
981 	unsigned short		parent;
982 	unsigned short		left;
983 	unsigned short		right;
984 };
985 
986 extern enum regex_type
987 filter_parse_regex(char *buff, int len, char **search, int *not);
988 extern void print_event_filter(struct ftrace_event_call *call,
989 			       struct trace_seq *s);
990 extern int apply_event_filter(struct ftrace_event_call *call,
991 			      char *filter_string);
992 extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir *dir,
993 					char *filter_string);
994 extern void print_subsystem_event_filter(struct event_subsystem *system,
995 					 struct trace_seq *s);
996 extern int filter_assign_type(const char *type);
997 
998 struct ftrace_event_field *
999 trace_find_event_field(struct ftrace_event_call *call, char *name);
1000 
1001 static inline int
1002 filter_check_discard(struct ftrace_event_call *call, void *rec,
1003 		     struct ring_buffer *buffer,
1004 		     struct ring_buffer_event *event)
1005 {
1006 	if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
1007 	    !filter_match_preds(call->filter, rec)) {
1008 		ring_buffer_discard_commit(buffer, event);
1009 		return 1;
1010 	}
1011 
1012 	return 0;
1013 }
1014 
1015 extern void trace_event_enable_cmd_record(bool enable);
1016 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1017 extern int event_trace_del_tracer(struct trace_array *tr);
1018 
1019 extern struct mutex event_mutex;
1020 extern struct list_head ftrace_events;
1021 
1022 extern const char *__start___trace_bprintk_fmt[];
1023 extern const char *__stop___trace_bprintk_fmt[];
1024 
1025 void trace_printk_init_buffers(void);
1026 void trace_printk_start_comm(void);
1027 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1028 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1029 
1030 /*
1031  * Normal trace_printk() and friends allocates special buffers
1032  * to do the manipulation, as well as saves the print formats
1033  * into sections to display. But the trace infrastructure wants
1034  * to use these without the added overhead at the price of being
1035  * a bit slower (used mainly for warnings, where we don't care
1036  * about performance). The internal_trace_puts() is for such
1037  * a purpose.
1038  */
1039 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1040 
1041 #undef FTRACE_ENTRY
1042 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)	\
1043 	extern struct ftrace_event_call					\
1044 	__attribute__((__aligned__(4))) event_##call;
1045 #undef FTRACE_ENTRY_DUP
1046 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter)	\
1047 	FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1048 		     filter)
1049 #include "trace_entries.h"
1050 
1051 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1052 int perf_ftrace_event_register(struct ftrace_event_call *call,
1053 			       enum trace_reg type, void *data);
1054 #else
1055 #define perf_ftrace_event_register NULL
1056 #endif
1057 
1058 #endif /* _LINUX_KERNEL_TRACE_H */
1059