• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 
2 #ifndef _LINUX_KERNEL_TRACE_H
3 #define _LINUX_KERNEL_TRACE_H
4 
5 #include <linux/fs.h>
6 #include <linux/atomic.h>
7 #include <linux/sched.h>
8 #include <linux/clocksource.h>
9 #include <linux/ring_buffer.h>
10 #include <linux/mmiotrace.h>
11 #include <linux/tracepoint.h>
12 #include <linux/ftrace.h>
13 #include <linux/hw_breakpoint.h>
14 #include <linux/trace_seq.h>
15 #include <linux/trace_events.h>
16 #include <linux/compiler.h>
17 #include <linux/trace_seq.h>
18 
19 #ifdef CONFIG_FTRACE_SYSCALLS
20 #include <asm/unistd.h>		/* For NR_SYSCALLS	     */
21 #include <asm/syscall.h>	/* some archs define it here */
22 #endif
23 
24 enum trace_type {
25 	__TRACE_FIRST_TYPE = 0,
26 
27 	TRACE_FN,
28 	TRACE_CTX,
29 	TRACE_WAKE,
30 	TRACE_STACK,
31 	TRACE_PRINT,
32 	TRACE_BPRINT,
33 	TRACE_MMIO_RW,
34 	TRACE_MMIO_MAP,
35 	TRACE_BRANCH,
36 	TRACE_GRAPH_RET,
37 	TRACE_GRAPH_ENT,
38 	TRACE_USER_STACK,
39 	TRACE_BLK,
40 	TRACE_BPUTS,
41 
42 	__TRACE_LAST_TYPE,
43 };
44 
45 
46 #undef __field
47 #define __field(type, item)		type	item;
48 
49 #undef __field_struct
50 #define __field_struct(type, item)	__field(type, item)
51 
52 #undef __field_desc
53 #define __field_desc(type, container, item)
54 
55 #undef __array
56 #define __array(type, item, size)	type	item[size];
57 
58 #undef __array_desc
59 #define __array_desc(type, container, item, size)
60 
61 #undef __dynamic_array
62 #define __dynamic_array(type, item)	type	item[];
63 
64 #undef F_STRUCT
65 #define F_STRUCT(args...)		args
66 
67 #undef FTRACE_ENTRY
68 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter)	\
69 	struct struct_name {						\
70 		struct trace_entry	ent;				\
71 		tstruct							\
72 	}
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 	TRACE_FLAG_PREEMPT_RESCHED	= 0x20,
128 };
129 
130 #define TRACE_BUF_SIZE		1024
131 
132 struct trace_array;
133 
134 /*
135  * The CPU trace array - it consists of thousands of trace entries
136  * plus some other descriptor data: (for example which task started
137  * the trace, etc.)
138  */
139 struct trace_array_cpu {
140 	atomic_t		disabled;
141 	void			*buffer_page;	/* ring buffer spare */
142 
143 	unsigned long		entries;
144 	unsigned long		saved_latency;
145 	unsigned long		critical_start;
146 	unsigned long		critical_end;
147 	unsigned long		critical_sequence;
148 	unsigned long		nice;
149 	unsigned long		policy;
150 	unsigned long		rt_priority;
151 	unsigned long		skipped_entries;
152 	cycle_t			preempt_timestamp;
153 	pid_t			pid;
154 	kuid_t			uid;
155 	char			comm[TASK_COMM_LEN];
156 
157 	bool			ignore_pid;
158 };
159 
160 struct tracer;
161 struct trace_option_dentry;
162 
163 struct trace_buffer {
164 	struct trace_array		*tr;
165 	struct ring_buffer		*buffer;
166 	struct trace_array_cpu __percpu	*data;
167 	cycle_t				time_start;
168 	int				cpu;
169 };
170 
171 #define TRACE_FLAGS_MAX_SIZE		32
172 
173 struct trace_options {
174 	struct tracer			*tracer;
175 	struct trace_option_dentry	*topts;
176 };
177 
178 struct trace_pid_list {
179 	unsigned int			nr_pids;
180 	int				order;
181 	pid_t				*pids;
182 };
183 
184 /*
185  * The trace array - an array of per-CPU trace arrays. This is the
186  * highest level data structure that individual tracers deal with.
187  * They have on/off state as well:
188  */
189 struct trace_array {
190 	struct list_head	list;
191 	char			*name;
192 	struct trace_buffer	trace_buffer;
193 #ifdef CONFIG_TRACER_MAX_TRACE
194 	/*
195 	 * The max_buffer is used to snapshot the trace when a maximum
196 	 * latency is reached, or when the user initiates a snapshot.
197 	 * Some tracers will use this to store a maximum trace while
198 	 * it continues examining live traces.
199 	 *
200 	 * The buffers for the max_buffer are set up the same as the trace_buffer
201 	 * When a snapshot is taken, the buffer of the max_buffer is swapped
202 	 * with the buffer of the trace_buffer and the buffers are reset for
203 	 * the trace_buffer so the tracing can continue.
204 	 */
205 	struct trace_buffer	max_buffer;
206 	bool			allocated_snapshot;
207 	unsigned long		max_latency;
208 #endif
209 	struct trace_pid_list	__rcu *filtered_pids;
210 	/*
211 	 * max_lock is used to protect the swapping of buffers
212 	 * when taking a max snapshot. The buffers themselves are
213 	 * protected by per_cpu spinlocks. But the action of the swap
214 	 * needs its own lock.
215 	 *
216 	 * This is defined as a arch_spinlock_t in order to help
217 	 * with performance when lockdep debugging is enabled.
218 	 *
219 	 * It is also used in other places outside the update_max_tr
220 	 * so it needs to be defined outside of the
221 	 * CONFIG_TRACER_MAX_TRACE.
222 	 */
223 	arch_spinlock_t		max_lock;
224 	int			buffer_disabled;
225 #ifdef CONFIG_FTRACE_SYSCALLS
226 	int			sys_refcount_enter;
227 	int			sys_refcount_exit;
228 	struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
229 	struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
230 #endif
231 	int			stop_count;
232 	int			clock_id;
233 	int			nr_topts;
234 	struct tracer		*current_trace;
235 	unsigned int		trace_flags;
236 	unsigned char		trace_flags_index[TRACE_FLAGS_MAX_SIZE];
237 	unsigned int		flags;
238 	raw_spinlock_t		start_lock;
239 	struct dentry		*dir;
240 	struct dentry		*options;
241 	struct dentry		*percpu_dir;
242 	struct dentry		*event_dir;
243 	struct trace_options	*topts;
244 	struct list_head	systems;
245 	struct list_head	events;
246 	cpumask_var_t		tracing_cpumask; /* only trace on set CPUs */
247 	int			ref;
248 #ifdef CONFIG_FUNCTION_TRACER
249 	struct ftrace_ops	*ops;
250 	/* function tracing enabled */
251 	int			function_enabled;
252 #endif
253 };
254 
255 enum {
256 	TRACE_ARRAY_FL_GLOBAL	= (1 << 0)
257 };
258 
259 extern struct list_head ftrace_trace_arrays;
260 
261 extern struct mutex trace_types_lock;
262 
263 extern int trace_array_get(struct trace_array *tr);
264 extern void trace_array_put(struct trace_array *tr);
265 
266 /*
267  * The global tracer (top) should be the first trace array added,
268  * but we check the flag anyway.
269  */
top_trace_array(void)270 static inline struct trace_array *top_trace_array(void)
271 {
272 	struct trace_array *tr;
273 
274 	if (list_empty(&ftrace_trace_arrays))
275 		return NULL;
276 
277 	tr = list_entry(ftrace_trace_arrays.prev,
278 			typeof(*tr), list);
279 	WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
280 	return tr;
281 }
282 
283 #define FTRACE_CMP_TYPE(var, type) \
284 	__builtin_types_compatible_p(typeof(var), type *)
285 
286 #undef IF_ASSIGN
287 #define IF_ASSIGN(var, entry, etype, id)		\
288 	if (FTRACE_CMP_TYPE(var, etype)) {		\
289 		var = (typeof(var))(entry);		\
290 		WARN_ON(id && (entry)->type != id);	\
291 		break;					\
292 	}
293 
294 /* Will cause compile errors if type is not found. */
295 extern void __ftrace_bad_type(void);
296 
297 /*
298  * The trace_assign_type is a verifier that the entry type is
299  * the same as the type being assigned. To add new types simply
300  * add a line with the following format:
301  *
302  * IF_ASSIGN(var, ent, type, id);
303  *
304  *  Where "type" is the trace type that includes the trace_entry
305  *  as the "ent" item. And "id" is the trace identifier that is
306  *  used in the trace_type enum.
307  *
308  *  If the type can have more than one id, then use zero.
309  */
310 #define trace_assign_type(var, ent)					\
311 	do {								\
312 		IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);	\
313 		IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);	\
314 		IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);	\
315 		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
316 		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
317 		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
318 		IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS);	\
319 		IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,		\
320 			  TRACE_MMIO_RW);				\
321 		IF_ASSIGN(var, ent, struct trace_mmiotrace_map,		\
322 			  TRACE_MMIO_MAP);				\
323 		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
324 		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
325 			  TRACE_GRAPH_ENT);		\
326 		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
327 			  TRACE_GRAPH_RET);		\
328 		__ftrace_bad_type();					\
329 	} while (0)
330 
331 /*
332  * An option specific to a tracer. This is a boolean value.
333  * The bit is the bit index that sets its value on the
334  * flags value in struct tracer_flags.
335  */
336 struct tracer_opt {
337 	const char	*name; /* Will appear on the trace_options file */
338 	u32		bit; /* Mask assigned in val field in tracer_flags */
339 };
340 
341 /*
342  * The set of specific options for a tracer. Your tracer
343  * have to set the initial value of the flags val.
344  */
345 struct tracer_flags {
346 	u32			val;
347 	struct tracer_opt	*opts;
348 };
349 
350 /* Makes more easy to define a tracer opt */
351 #define TRACER_OPT(s, b)	.name = #s, .bit = b
352 
353 
354 struct trace_option_dentry {
355 	struct tracer_opt		*opt;
356 	struct tracer_flags		*flags;
357 	struct trace_array		*tr;
358 	struct dentry			*entry;
359 };
360 
361 /**
362  * struct tracer - a specific tracer and its callbacks to interact with tracefs
363  * @name: the name chosen to select it on the available_tracers file
364  * @init: called when one switches to this tracer (echo name > current_tracer)
365  * @reset: called when one switches to another tracer
366  * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
367  * @stop: called when tracing is paused (echo 0 > tracing_enabled)
368  * @update_thresh: called when tracing_thresh is updated
369  * @open: called when the trace file is opened
370  * @pipe_open: called when the trace_pipe file is opened
371  * @close: called when the trace file is released
372  * @pipe_close: called when the trace_pipe file is released
373  * @read: override the default read callback on trace_pipe
374  * @splice_read: override the default splice_read callback on trace_pipe
375  * @selftest: selftest to run on boot (see trace_selftest.c)
376  * @print_headers: override the first lines that describe your columns
377  * @print_line: callback that prints a trace
378  * @set_flag: signals one of your private flags changed (trace_options file)
379  * @flags: your private flags
380  */
381 struct tracer {
382 	const char		*name;
383 	int			(*init)(struct trace_array *tr);
384 	void			(*reset)(struct trace_array *tr);
385 	void			(*start)(struct trace_array *tr);
386 	void			(*stop)(struct trace_array *tr);
387 	int			(*update_thresh)(struct trace_array *tr);
388 	void			(*open)(struct trace_iterator *iter);
389 	void			(*pipe_open)(struct trace_iterator *iter);
390 	void			(*close)(struct trace_iterator *iter);
391 	void			(*pipe_close)(struct trace_iterator *iter);
392 	ssize_t			(*read)(struct trace_iterator *iter,
393 					struct file *filp, char __user *ubuf,
394 					size_t cnt, loff_t *ppos);
395 	ssize_t			(*splice_read)(struct trace_iterator *iter,
396 					       struct file *filp,
397 					       loff_t *ppos,
398 					       struct pipe_inode_info *pipe,
399 					       size_t len,
400 					       unsigned int flags);
401 #ifdef CONFIG_FTRACE_STARTUP_TEST
402 	int			(*selftest)(struct tracer *trace,
403 					    struct trace_array *tr);
404 #endif
405 	void			(*print_header)(struct seq_file *m);
406 	enum print_line_t	(*print_line)(struct trace_iterator *iter);
407 	/* If you handled the flag setting, return 0 */
408 	int			(*set_flag)(struct trace_array *tr,
409 					    u32 old_flags, u32 bit, int set);
410 	/* Return 0 if OK with change, else return non-zero */
411 	int			(*flag_changed)(struct trace_array *tr,
412 						u32 mask, int set);
413 	struct tracer		*next;
414 	struct tracer_flags	*flags;
415 	int			enabled;
416 	int			ref;
417 	bool			print_max;
418 	bool			allow_instances;
419 #ifdef CONFIG_TRACER_MAX_TRACE
420 	bool			use_max_tr;
421 #endif
422 };
423 
424 
425 /* Only current can touch trace_recursion */
426 
427 /*
428  * For function tracing recursion:
429  *  The order of these bits are important.
430  *
431  *  When function tracing occurs, the following steps are made:
432  *   If arch does not support a ftrace feature:
433  *    call internal function (uses INTERNAL bits) which calls...
434  *   The function callback, which can use the FTRACE bits to
435  *    check for recursion.
436  */
437 enum {
438 	TRACE_BUFFER_BIT,
439 	TRACE_BUFFER_NMI_BIT,
440 	TRACE_BUFFER_IRQ_BIT,
441 	TRACE_BUFFER_SIRQ_BIT,
442 
443 	/* Start of function recursion bits */
444 	TRACE_FTRACE_BIT,
445 	TRACE_FTRACE_NMI_BIT,
446 	TRACE_FTRACE_IRQ_BIT,
447 	TRACE_FTRACE_SIRQ_BIT,
448 	TRACE_FTRACE_TRANSITION_BIT,
449 
450 	/* Internal use recursion bits */
451 	TRACE_INTERNAL_BIT,
452 	TRACE_INTERNAL_NMI_BIT,
453 	TRACE_INTERNAL_IRQ_BIT,
454 	TRACE_INTERNAL_SIRQ_BIT,
455 	TRACE_INTERNAL_TRANSITION_BIT,
456 
457 	TRACE_CONTROL_BIT,
458 
459 	TRACE_BRANCH_BIT,
460 /*
461  * Abuse of the trace_recursion.
462  * As we need a way to maintain state if we are tracing the function
463  * graph in irq because we want to trace a particular function that
464  * was called in irq context but we have irq tracing off. Since this
465  * can only be modified by current, we can reuse trace_recursion.
466  */
467 	TRACE_IRQ_BIT,
468 };
469 
470 #define trace_recursion_set(bit)	do { (current)->trace_recursion |= (1<<(bit)); } while (0)
471 #define trace_recursion_clear(bit)	do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
472 #define trace_recursion_test(bit)	((current)->trace_recursion & (1<<(bit)))
473 
474 #define TRACE_CONTEXT_BITS	4
475 
476 #define TRACE_FTRACE_START	TRACE_FTRACE_BIT
477 
478 #define TRACE_LIST_START	TRACE_INTERNAL_BIT
479 
480 #define TRACE_CONTEXT_MASK	((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
481 
482 enum {
483 	TRACE_CTX_NMI,
484 	TRACE_CTX_IRQ,
485 	TRACE_CTX_SOFTIRQ,
486 	TRACE_CTX_NORMAL,
487 	TRACE_CTX_TRANSITION,
488 };
489 
trace_get_context_bit(void)490 static __always_inline int trace_get_context_bit(void)
491 {
492 	int bit;
493 
494 	if (in_interrupt()) {
495 		if (in_nmi())
496 			bit = TRACE_CTX_NMI;
497 
498 		else if (in_irq())
499 			bit = TRACE_CTX_IRQ;
500 		else
501 			bit = TRACE_CTX_SOFTIRQ;
502 	} else
503 		bit = TRACE_CTX_NORMAL;
504 
505 	return bit;
506 }
507 
trace_test_and_set_recursion(int start)508 static __always_inline int trace_test_and_set_recursion(int start)
509 {
510 	unsigned int val = current->trace_recursion;
511 	int bit;
512 
513 	bit = trace_get_context_bit() + start;
514 	if (unlikely(val & (1 << bit))) {
515 		/*
516 		 * It could be that preempt_count has not been updated during
517 		 * a switch between contexts. Allow for a single recursion.
518 		 */
519 		bit = start + TRACE_CTX_TRANSITION;
520 		if (trace_recursion_test(bit))
521 			return -1;
522 		trace_recursion_set(bit);
523 		barrier();
524 		return bit;
525 	}
526 
527 	val |= 1 << bit;
528 	current->trace_recursion = val;
529 	barrier();
530 
531 	return bit;
532 }
533 
trace_clear_recursion(int bit)534 static __always_inline void trace_clear_recursion(int bit)
535 {
536 	unsigned int val = current->trace_recursion;
537 
538 	bit = 1 << bit;
539 	val &= ~bit;
540 
541 	barrier();
542 	current->trace_recursion = val;
543 }
544 
545 static inline struct ring_buffer_iter *
trace_buffer_iter(struct trace_iterator * iter,int cpu)546 trace_buffer_iter(struct trace_iterator *iter, int cpu)
547 {
548 	if (iter->buffer_iter && iter->buffer_iter[cpu])
549 		return iter->buffer_iter[cpu];
550 	return NULL;
551 }
552 
553 int tracer_init(struct tracer *t, struct trace_array *tr);
554 int tracing_is_enabled(void);
555 void tracing_reset(struct trace_buffer *buf, int cpu);
556 void tracing_reset_online_cpus(struct trace_buffer *buf);
557 void tracing_reset_current(int cpu);
558 void tracing_reset_all_online_cpus(void);
559 int tracing_open_generic(struct inode *inode, struct file *filp);
560 bool tracing_is_disabled(void);
561 struct dentry *trace_create_file(const char *name,
562 				 umode_t mode,
563 				 struct dentry *parent,
564 				 void *data,
565 				 const struct file_operations *fops);
566 
567 struct dentry *tracing_init_dentry(void);
568 
569 struct ring_buffer_event;
570 
571 struct ring_buffer_event *
572 trace_buffer_lock_reserve(struct ring_buffer *buffer,
573 			  int type,
574 			  unsigned long len,
575 			  unsigned long flags,
576 			  int pc);
577 
578 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
579 						struct trace_array_cpu *data);
580 
581 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
582 					  int *ent_cpu, u64 *ent_ts);
583 
584 void __buffer_unlock_commit(struct ring_buffer *buffer,
585 			    struct ring_buffer_event *event);
586 
587 int trace_empty(struct trace_iterator *iter);
588 
589 void *trace_find_next_entry_inc(struct trace_iterator *iter);
590 
591 void trace_init_global_iter(struct trace_iterator *iter);
592 
593 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
594 
595 void trace_function(struct trace_array *tr,
596 		    unsigned long ip,
597 		    unsigned long parent_ip,
598 		    unsigned long flags, int pc);
599 void trace_graph_function(struct trace_array *tr,
600 		    unsigned long ip,
601 		    unsigned long parent_ip,
602 		    unsigned long flags, int pc);
603 void trace_latency_header(struct seq_file *m);
604 void trace_default_header(struct seq_file *m);
605 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
606 int trace_empty(struct trace_iterator *iter);
607 
608 void trace_graph_return(struct ftrace_graph_ret *trace);
609 int trace_graph_entry(struct ftrace_graph_ent *trace);
610 void set_graph_array(struct trace_array *tr);
611 
612 void tracing_start_cmdline_record(void);
613 void tracing_stop_cmdline_record(void);
614 int register_tracer(struct tracer *type);
615 int is_tracing_stopped(void);
616 
617 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
618 
619 extern cpumask_var_t __read_mostly tracing_buffer_mask;
620 
621 #define for_each_tracing_cpu(cpu)	\
622 	for_each_cpu(cpu, tracing_buffer_mask)
623 
624 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
625 
626 extern unsigned long tracing_thresh;
627 
628 #ifdef CONFIG_TRACER_MAX_TRACE
629 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
630 void update_max_tr_single(struct trace_array *tr,
631 			  struct task_struct *tsk, int cpu);
632 #endif /* CONFIG_TRACER_MAX_TRACE */
633 
634 #ifdef CONFIG_STACKTRACE
635 void ftrace_trace_userstack(struct trace_array *tr,
636 			    struct ring_buffer *buffer, unsigned long flags,
637 			    int pc);
638 
639 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
640 		   int pc);
641 #else
ftrace_trace_userstack(struct trace_array * tr,struct ring_buffer * buffer,unsigned long flags,int pc)642 static inline void ftrace_trace_userstack(struct trace_array *tr,
643 					  struct ring_buffer *buffer,
644 					  unsigned long flags, int pc)
645 {
646 }
647 
__trace_stack(struct trace_array * tr,unsigned long flags,int skip,int pc)648 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
649 				 int skip, int pc)
650 {
651 }
652 #endif /* CONFIG_STACKTRACE */
653 
654 extern cycle_t ftrace_now(int cpu);
655 
656 extern void trace_find_cmdline(int pid, char comm[]);
657 extern int trace_find_tgid(int pid);
658 
659 #ifdef CONFIG_DYNAMIC_FTRACE
660 extern unsigned long ftrace_update_tot_cnt;
661 #endif
662 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
663 extern int DYN_FTRACE_TEST_NAME(void);
664 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
665 extern int DYN_FTRACE_TEST_NAME2(void);
666 
667 extern bool ring_buffer_expanded;
668 extern bool tracing_selftest_disabled;
669 
670 #ifdef CONFIG_FTRACE_STARTUP_TEST
671 extern int trace_selftest_startup_function(struct tracer *trace,
672 					   struct trace_array *tr);
673 extern int trace_selftest_startup_function_graph(struct tracer *trace,
674 						 struct trace_array *tr);
675 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
676 					  struct trace_array *tr);
677 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
678 					     struct trace_array *tr);
679 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
680 						 struct trace_array *tr);
681 extern int trace_selftest_startup_wakeup(struct tracer *trace,
682 					 struct trace_array *tr);
683 extern int trace_selftest_startup_nop(struct tracer *trace,
684 					 struct trace_array *tr);
685 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
686 					       struct trace_array *tr);
687 extern int trace_selftest_startup_branch(struct tracer *trace,
688 					 struct trace_array *tr);
689 /*
690  * Tracer data references selftest functions that only occur
691  * on boot up. These can be __init functions. Thus, when selftests
692  * are enabled, then the tracers need to reference __init functions.
693  */
694 #define __tracer_data		__refdata
695 #else
696 /* Tracers are seldom changed. Optimize when selftests are disabled. */
697 #define __tracer_data		__read_mostly
698 #endif /* CONFIG_FTRACE_STARTUP_TEST */
699 
700 extern void *head_page(struct trace_array_cpu *data);
701 extern unsigned long long ns2usecs(cycle_t nsec);
702 extern int
703 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
704 extern int
705 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
706 extern int
707 trace_array_vprintk(struct trace_array *tr,
708 		    unsigned long ip, const char *fmt, va_list args);
709 int trace_array_printk(struct trace_array *tr,
710 		       unsigned long ip, const char *fmt, ...);
711 int trace_array_printk_buf(struct ring_buffer *buffer,
712 			   unsigned long ip, const char *fmt, ...);
713 void trace_printk_seq(struct trace_seq *s);
714 enum print_line_t print_trace_line(struct trace_iterator *iter);
715 
716 extern char trace_find_mark(unsigned long long duration);
717 
718 /* Standard output formatting function used for function return traces */
719 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
720 
721 /* Flag options */
722 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
723 #define TRACE_GRAPH_PRINT_CPU           0x2
724 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
725 #define TRACE_GRAPH_PRINT_PROC          0x8
726 #define TRACE_GRAPH_PRINT_DURATION      0x10
727 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
728 #define TRACE_GRAPH_PRINT_IRQS          0x40
729 #define TRACE_GRAPH_PRINT_TAIL          0x80
730 #define TRACE_GRAPH_SLEEP_TIME		0x100
731 #define TRACE_GRAPH_GRAPH_TIME		0x200
732 #define TRACE_GRAPH_PRINT_FILL_SHIFT	28
733 #define TRACE_GRAPH_PRINT_FILL_MASK	(0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
734 
735 extern void ftrace_graph_sleep_time_control(bool enable);
736 extern void ftrace_graph_graph_time_control(bool enable);
737 
738 extern enum print_line_t
739 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
740 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
741 extern void
742 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
743 extern void graph_trace_open(struct trace_iterator *iter);
744 extern void graph_trace_close(struct trace_iterator *iter);
745 extern int __trace_graph_entry(struct trace_array *tr,
746 			       struct ftrace_graph_ent *trace,
747 			       unsigned long flags, int pc);
748 extern void __trace_graph_return(struct trace_array *tr,
749 				 struct ftrace_graph_ret *trace,
750 				 unsigned long flags, int pc);
751 
752 
753 #ifdef CONFIG_DYNAMIC_FTRACE
754 /* TODO: make this variable */
755 #define FTRACE_GRAPH_MAX_FUNCS		32
756 extern int ftrace_graph_count;
757 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
758 extern int ftrace_graph_notrace_count;
759 extern unsigned long ftrace_graph_notrace_funcs[FTRACE_GRAPH_MAX_FUNCS];
760 
ftrace_graph_addr(unsigned long addr)761 static inline int ftrace_graph_addr(unsigned long addr)
762 {
763 	int i;
764 
765 	if (!ftrace_graph_count)
766 		return 1;
767 
768 	for (i = 0; i < ftrace_graph_count; i++) {
769 		if (addr == ftrace_graph_funcs[i]) {
770 			/*
771 			 * If no irqs are to be traced, but a set_graph_function
772 			 * is set, and called by an interrupt handler, we still
773 			 * want to trace it.
774 			 */
775 			if (in_irq())
776 				trace_recursion_set(TRACE_IRQ_BIT);
777 			else
778 				trace_recursion_clear(TRACE_IRQ_BIT);
779 			return 1;
780 		}
781 	}
782 
783 	return 0;
784 }
785 
ftrace_graph_notrace_addr(unsigned long addr)786 static inline int ftrace_graph_notrace_addr(unsigned long addr)
787 {
788 	int i;
789 
790 	if (!ftrace_graph_notrace_count)
791 		return 0;
792 
793 	for (i = 0; i < ftrace_graph_notrace_count; i++) {
794 		if (addr == ftrace_graph_notrace_funcs[i])
795 			return 1;
796 	}
797 
798 	return 0;
799 }
800 #else
ftrace_graph_addr(unsigned long addr)801 static inline int ftrace_graph_addr(unsigned long addr)
802 {
803 	return 1;
804 }
805 
ftrace_graph_notrace_addr(unsigned long addr)806 static inline int ftrace_graph_notrace_addr(unsigned long addr)
807 {
808 	return 0;
809 }
810 #endif /* CONFIG_DYNAMIC_FTRACE */
811 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
812 static inline enum print_line_t
print_graph_function_flags(struct trace_iterator * iter,u32 flags)813 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
814 {
815 	return TRACE_TYPE_UNHANDLED;
816 }
817 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
818 
819 extern struct list_head ftrace_pids;
820 
821 #ifdef CONFIG_FUNCTION_TRACER
822 extern bool ftrace_filter_param __initdata;
ftrace_trace_task(struct task_struct * task)823 static inline int ftrace_trace_task(struct task_struct *task)
824 {
825 	if (list_empty(&ftrace_pids))
826 		return 1;
827 
828 	return test_tsk_trace_trace(task);
829 }
830 extern int ftrace_is_dead(void);
831 int ftrace_create_function_files(struct trace_array *tr,
832 				 struct dentry *parent);
833 void ftrace_destroy_function_files(struct trace_array *tr);
834 void ftrace_init_global_array_ops(struct trace_array *tr);
835 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
836 void ftrace_reset_array_ops(struct trace_array *tr);
837 int using_ftrace_ops_list_func(void);
838 #else
ftrace_trace_task(struct task_struct * task)839 static inline int ftrace_trace_task(struct task_struct *task)
840 {
841 	return 1;
842 }
ftrace_is_dead(void)843 static inline int ftrace_is_dead(void) { return 0; }
844 static inline int
ftrace_create_function_files(struct trace_array * tr,struct dentry * parent)845 ftrace_create_function_files(struct trace_array *tr,
846 			     struct dentry *parent)
847 {
848 	return 0;
849 }
ftrace_destroy_function_files(struct trace_array * tr)850 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
851 static inline __init void
ftrace_init_global_array_ops(struct trace_array * tr)852 ftrace_init_global_array_ops(struct trace_array *tr) { }
ftrace_reset_array_ops(struct trace_array * tr)853 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
854 /* ftace_func_t type is not defined, use macro instead of static inline */
855 #define ftrace_init_array_ops(tr, func) do { } while (0)
856 #endif /* CONFIG_FUNCTION_TRACER */
857 
858 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
859 void ftrace_create_filter_files(struct ftrace_ops *ops,
860 				struct dentry *parent);
861 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
862 #else
863 /*
864  * The ops parameter passed in is usually undefined.
865  * This must be a macro.
866  */
867 #define ftrace_create_filter_files(ops, parent) do { } while (0)
868 #define ftrace_destroy_filter_files(ops) do { } while (0)
869 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
870 
871 bool ftrace_event_is_function(struct trace_event_call *call);
872 
873 /*
874  * struct trace_parser - servers for reading the user input separated by spaces
875  * @cont: set if the input is not complete - no final space char was found
876  * @buffer: holds the parsed user input
877  * @idx: user input length
878  * @size: buffer size
879  */
880 struct trace_parser {
881 	bool		cont;
882 	char		*buffer;
883 	unsigned	idx;
884 	unsigned	size;
885 };
886 
trace_parser_loaded(struct trace_parser * parser)887 static inline bool trace_parser_loaded(struct trace_parser *parser)
888 {
889 	return (parser->idx != 0);
890 }
891 
trace_parser_cont(struct trace_parser * parser)892 static inline bool trace_parser_cont(struct trace_parser *parser)
893 {
894 	return parser->cont;
895 }
896 
trace_parser_clear(struct trace_parser * parser)897 static inline void trace_parser_clear(struct trace_parser *parser)
898 {
899 	parser->cont = false;
900 	parser->idx = 0;
901 }
902 
903 extern int trace_parser_get_init(struct trace_parser *parser, int size);
904 extern void trace_parser_put(struct trace_parser *parser);
905 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
906 	size_t cnt, loff_t *ppos);
907 
908 /*
909  * Only create function graph options if function graph is configured.
910  */
911 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
912 # define FGRAPH_FLAGS						\
913 		C(DISPLAY_GRAPH,	"display-graph"),
914 #else
915 # define FGRAPH_FLAGS
916 #endif
917 
918 #ifdef CONFIG_BRANCH_TRACER
919 # define BRANCH_FLAGS					\
920 		C(BRANCH,		"branch"),
921 #else
922 # define BRANCH_FLAGS
923 #endif
924 
925 #ifdef CONFIG_FUNCTION_TRACER
926 # define FUNCTION_FLAGS						\
927 		C(FUNCTION,		"function-trace"),
928 # define FUNCTION_DEFAULT_FLAGS		TRACE_ITER_FUNCTION
929 #else
930 # define FUNCTION_FLAGS
931 # define FUNCTION_DEFAULT_FLAGS		0UL
932 #endif
933 
934 #ifdef CONFIG_STACKTRACE
935 # define STACK_FLAGS				\
936 		C(STACKTRACE,		"stacktrace"),
937 #else
938 # define STACK_FLAGS
939 #endif
940 
941 /*
942  * trace_iterator_flags is an enumeration that defines bit
943  * positions into trace_flags that controls the output.
944  *
945  * NOTE: These bits must match the trace_options array in
946  *       trace.c (this macro guarantees it).
947  */
948 #define TRACE_FLAGS						\
949 		C(PRINT_PARENT,		"print-parent"),	\
950 		C(SYM_OFFSET,		"sym-offset"),		\
951 		C(SYM_ADDR,		"sym-addr"),		\
952 		C(VERBOSE,		"verbose"),		\
953 		C(RAW,			"raw"),			\
954 		C(HEX,			"hex"),			\
955 		C(BIN,			"bin"),			\
956 		C(BLOCK,		"block"),		\
957 		C(PRINTK,		"trace_printk"),	\
958 		C(ANNOTATE,		"annotate"),		\
959 		C(USERSTACKTRACE,	"userstacktrace"),	\
960 		C(SYM_USEROBJ,		"sym-userobj"),		\
961 		C(PRINTK_MSGONLY,	"printk-msg-only"),	\
962 		C(CONTEXT_INFO,		"context-info"),   /* Print pid/cpu/time */ \
963 		C(LATENCY_FMT,		"latency-format"),	\
964 		C(RECORD_CMD,		"record-cmd"),		\
965 		C(OVERWRITE,		"overwrite"),		\
966 		C(STOP_ON_FREE,		"disable_on_free"),	\
967 		C(IRQ_INFO,		"irq-info"),		\
968 		C(MARKERS,		"markers"),		\
969 		FUNCTION_FLAGS					\
970 		FGRAPH_FLAGS					\
971 		STACK_FLAGS					\
972 		BRANCH_FLAGS					\
973 		C(TGID,			"print-tgid"),
974 
975 /*
976  * By defining C, we can make TRACE_FLAGS a list of bit names
977  * that will define the bits for the flag masks.
978  */
979 #undef C
980 #define C(a, b) TRACE_ITER_##a##_BIT
981 
982 enum trace_iterator_bits {
983 	TRACE_FLAGS
984 	/* Make sure we don't go more than we have bits for */
985 	TRACE_ITER_LAST_BIT
986 };
987 
988 /*
989  * By redefining C, we can make TRACE_FLAGS a list of masks that
990  * use the bits as defined above.
991  */
992 #undef C
993 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
994 
995 enum trace_iterator_flags { TRACE_FLAGS };
996 
997 /*
998  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
999  * control the output of kernel symbols.
1000  */
1001 #define TRACE_ITER_SYM_MASK \
1002 	(TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1003 
1004 extern struct tracer nop_trace;
1005 
1006 #ifdef CONFIG_BRANCH_TRACER
1007 extern int enable_branch_tracing(struct trace_array *tr);
1008 extern void disable_branch_tracing(void);
trace_branch_enable(struct trace_array * tr)1009 static inline int trace_branch_enable(struct trace_array *tr)
1010 {
1011 	if (tr->trace_flags & TRACE_ITER_BRANCH)
1012 		return enable_branch_tracing(tr);
1013 	return 0;
1014 }
trace_branch_disable(void)1015 static inline void trace_branch_disable(void)
1016 {
1017 	/* due to races, always disable */
1018 	disable_branch_tracing();
1019 }
1020 #else
trace_branch_enable(struct trace_array * tr)1021 static inline int trace_branch_enable(struct trace_array *tr)
1022 {
1023 	return 0;
1024 }
trace_branch_disable(void)1025 static inline void trace_branch_disable(void)
1026 {
1027 }
1028 #endif /* CONFIG_BRANCH_TRACER */
1029 
1030 /* set ring buffers to default size if not already done so */
1031 int tracing_update_buffers(void);
1032 
1033 struct ftrace_event_field {
1034 	struct list_head	link;
1035 	const char		*name;
1036 	const char		*type;
1037 	int			filter_type;
1038 	int			offset;
1039 	int			size;
1040 	int			is_signed;
1041 };
1042 
1043 struct event_filter {
1044 	int			n_preds;	/* Number assigned */
1045 	int			a_preds;	/* allocated */
1046 	struct filter_pred	*preds;
1047 	struct filter_pred	*root;
1048 	char			*filter_string;
1049 };
1050 
1051 struct event_subsystem {
1052 	struct list_head	list;
1053 	const char		*name;
1054 	struct event_filter	*filter;
1055 	int			ref_count;
1056 };
1057 
1058 struct trace_subsystem_dir {
1059 	struct list_head		list;
1060 	struct event_subsystem		*subsystem;
1061 	struct trace_array		*tr;
1062 	struct dentry			*entry;
1063 	int				ref_count;
1064 	int				nr_events;
1065 };
1066 
1067 #define FILTER_PRED_INVALID	((unsigned short)-1)
1068 #define FILTER_PRED_IS_RIGHT	(1 << 15)
1069 #define FILTER_PRED_FOLD	(1 << 15)
1070 
1071 /*
1072  * The max preds is the size of unsigned short with
1073  * two flags at the MSBs. One bit is used for both the IS_RIGHT
1074  * and FOLD flags. The other is reserved.
1075  *
1076  * 2^14 preds is way more than enough.
1077  */
1078 #define MAX_FILTER_PRED		16384
1079 
1080 struct filter_pred;
1081 struct regex;
1082 
1083 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1084 
1085 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1086 
1087 enum regex_type {
1088 	MATCH_FULL = 0,
1089 	MATCH_FRONT_ONLY,
1090 	MATCH_MIDDLE_ONLY,
1091 	MATCH_END_ONLY,
1092 };
1093 
1094 struct regex {
1095 	char			pattern[MAX_FILTER_STR_VAL];
1096 	int			len;
1097 	int			field_len;
1098 	regex_match_func	match;
1099 };
1100 
1101 struct filter_pred {
1102 	filter_pred_fn_t 	fn;
1103 	u64 			val;
1104 	struct regex		regex;
1105 	unsigned short		*ops;
1106 	struct ftrace_event_field *field;
1107 	int 			offset;
1108 	int 			not;
1109 	int 			op;
1110 	unsigned short		index;
1111 	unsigned short		parent;
1112 	unsigned short		left;
1113 	unsigned short		right;
1114 };
1115 
1116 extern enum regex_type
1117 filter_parse_regex(char *buff, int len, char **search, int *not);
1118 extern void print_event_filter(struct trace_event_file *file,
1119 			       struct trace_seq *s);
1120 extern int apply_event_filter(struct trace_event_file *file,
1121 			      char *filter_string);
1122 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1123 					char *filter_string);
1124 extern void print_subsystem_event_filter(struct event_subsystem *system,
1125 					 struct trace_seq *s);
1126 extern int filter_assign_type(const char *type);
1127 extern int create_event_filter(struct trace_event_call *call,
1128 			       char *filter_str, bool set_str,
1129 			       struct event_filter **filterp);
1130 extern void free_event_filter(struct event_filter *filter);
1131 
1132 struct ftrace_event_field *
1133 trace_find_event_field(struct trace_event_call *call, char *name);
1134 
1135 extern void trace_event_enable_cmd_record(bool enable);
1136 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1137 extern int event_trace_del_tracer(struct trace_array *tr);
1138 
1139 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1140 						const char *system,
1141 						const char *event);
1142 
event_file_data(struct file * filp)1143 static inline void *event_file_data(struct file *filp)
1144 {
1145 	return ACCESS_ONCE(file_inode(filp)->i_private);
1146 }
1147 
1148 extern struct mutex event_mutex;
1149 extern struct list_head ftrace_events;
1150 
1151 extern const struct file_operations event_trigger_fops;
1152 
1153 extern int register_trigger_cmds(void);
1154 extern void clear_event_triggers(struct trace_array *tr);
1155 
1156 struct event_trigger_data {
1157 	unsigned long			count;
1158 	int				ref;
1159 	struct event_trigger_ops	*ops;
1160 	struct event_command		*cmd_ops;
1161 	struct event_filter __rcu	*filter;
1162 	char				*filter_str;
1163 	void				*private_data;
1164 	struct list_head		list;
1165 };
1166 
1167 /**
1168  * struct event_trigger_ops - callbacks for trace event triggers
1169  *
1170  * The methods in this structure provide per-event trigger hooks for
1171  * various trigger operations.
1172  *
1173  * All the methods below, except for @init() and @free(), must be
1174  * implemented.
1175  *
1176  * @func: The trigger 'probe' function called when the triggering
1177  *	event occurs.  The data passed into this callback is the data
1178  *	that was supplied to the event_command @reg() function that
1179  *	registered the trigger (see struct event_command).
1180  *
1181  * @init: An optional initialization function called for the trigger
1182  *	when the trigger is registered (via the event_command reg()
1183  *	function).  This can be used to perform per-trigger
1184  *	initialization such as incrementing a per-trigger reference
1185  *	count, for instance.  This is usually implemented by the
1186  *	generic utility function @event_trigger_init() (see
1187  *	trace_event_triggers.c).
1188  *
1189  * @free: An optional de-initialization function called for the
1190  *	trigger when the trigger is unregistered (via the
1191  *	event_command @reg() function).  This can be used to perform
1192  *	per-trigger de-initialization such as decrementing a
1193  *	per-trigger reference count and freeing corresponding trigger
1194  *	data, for instance.  This is usually implemented by the
1195  *	generic utility function @event_trigger_free() (see
1196  *	trace_event_triggers.c).
1197  *
1198  * @print: The callback function invoked to have the trigger print
1199  *	itself.  This is usually implemented by a wrapper function
1200  *	that calls the generic utility function @event_trigger_print()
1201  *	(see trace_event_triggers.c).
1202  */
1203 struct event_trigger_ops {
1204 	void			(*func)(struct event_trigger_data *data);
1205 	int			(*init)(struct event_trigger_ops *ops,
1206 					struct event_trigger_data *data);
1207 	void			(*free)(struct event_trigger_ops *ops,
1208 					struct event_trigger_data *data);
1209 	int			(*print)(struct seq_file *m,
1210 					 struct event_trigger_ops *ops,
1211 					 struct event_trigger_data *data);
1212 };
1213 
1214 /**
1215  * struct event_command - callbacks and data members for event commands
1216  *
1217  * Event commands are invoked by users by writing the command name
1218  * into the 'trigger' file associated with a trace event.  The
1219  * parameters associated with a specific invocation of an event
1220  * command are used to create an event trigger instance, which is
1221  * added to the list of trigger instances associated with that trace
1222  * event.  When the event is hit, the set of triggers associated with
1223  * that event is invoked.
1224  *
1225  * The data members in this structure provide per-event command data
1226  * for various event commands.
1227  *
1228  * All the data members below, except for @post_trigger, must be set
1229  * for each event command.
1230  *
1231  * @name: The unique name that identifies the event command.  This is
1232  *	the name used when setting triggers via trigger files.
1233  *
1234  * @trigger_type: A unique id that identifies the event command
1235  *	'type'.  This value has two purposes, the first to ensure that
1236  *	only one trigger of the same type can be set at a given time
1237  *	for a particular event e.g. it doesn't make sense to have both
1238  *	a traceon and traceoff trigger attached to a single event at
1239  *	the same time, so traceon and traceoff have the same type
1240  *	though they have different names.  The @trigger_type value is
1241  *	also used as a bit value for deferring the actual trigger
1242  *	action until after the current event is finished.  Some
1243  *	commands need to do this if they themselves log to the trace
1244  *	buffer (see the @post_trigger() member below).  @trigger_type
1245  *	values are defined by adding new values to the trigger_type
1246  *	enum in include/linux/trace_events.h.
1247  *
1248  * @post_trigger: A flag that says whether or not this command needs
1249  *	to have its action delayed until after the current event has
1250  *	been closed.  Some triggers need to avoid being invoked while
1251  *	an event is currently in the process of being logged, since
1252  *	the trigger may itself log data into the trace buffer.  Thus
1253  *	we make sure the current event is committed before invoking
1254  *	those triggers.  To do that, the trigger invocation is split
1255  *	in two - the first part checks the filter using the current
1256  *	trace record; if a command has the @post_trigger flag set, it
1257  *	sets a bit for itself in the return value, otherwise it
1258  *	directly invokes the trigger.  Once all commands have been
1259  *	either invoked or set their return flag, the current record is
1260  *	either committed or discarded.  At that point, if any commands
1261  *	have deferred their triggers, those commands are finally
1262  *	invoked following the close of the current event.  In other
1263  *	words, if the event_trigger_ops @func() probe implementation
1264  *	itself logs to the trace buffer, this flag should be set,
1265  *	otherwise it can be left unspecified.
1266  *
1267  * All the methods below, except for @set_filter(), must be
1268  * implemented.
1269  *
1270  * @func: The callback function responsible for parsing and
1271  *	registering the trigger written to the 'trigger' file by the
1272  *	user.  It allocates the trigger instance and registers it with
1273  *	the appropriate trace event.  It makes use of the other
1274  *	event_command callback functions to orchestrate this, and is
1275  *	usually implemented by the generic utility function
1276  *	@event_trigger_callback() (see trace_event_triggers.c).
1277  *
1278  * @reg: Adds the trigger to the list of triggers associated with the
1279  *	event, and enables the event trigger itself, after
1280  *	initializing it (via the event_trigger_ops @init() function).
1281  *	This is also where commands can use the @trigger_type value to
1282  *	make the decision as to whether or not multiple instances of
1283  *	the trigger should be allowed.  This is usually implemented by
1284  *	the generic utility function @register_trigger() (see
1285  *	trace_event_triggers.c).
1286  *
1287  * @unreg: Removes the trigger from the list of triggers associated
1288  *	with the event, and disables the event trigger itself, after
1289  *	initializing it (via the event_trigger_ops @free() function).
1290  *	This is usually implemented by the generic utility function
1291  *	@unregister_trigger() (see trace_event_triggers.c).
1292  *
1293  * @set_filter: An optional function called to parse and set a filter
1294  *	for the trigger.  If no @set_filter() method is set for the
1295  *	event command, filters set by the user for the command will be
1296  *	ignored.  This is usually implemented by the generic utility
1297  *	function @set_trigger_filter() (see trace_event_triggers.c).
1298  *
1299  * @get_trigger_ops: The callback function invoked to retrieve the
1300  *	event_trigger_ops implementation associated with the command.
1301  */
1302 struct event_command {
1303 	struct list_head	list;
1304 	char			*name;
1305 	enum event_trigger_type	trigger_type;
1306 	bool			post_trigger;
1307 	int			(*func)(struct event_command *cmd_ops,
1308 					struct trace_event_file *file,
1309 					char *glob, char *cmd, char *params);
1310 	int			(*reg)(char *glob,
1311 				       struct event_trigger_ops *ops,
1312 				       struct event_trigger_data *data,
1313 				       struct trace_event_file *file);
1314 	void			(*unreg)(char *glob,
1315 					 struct event_trigger_ops *ops,
1316 					 struct event_trigger_data *data,
1317 					 struct trace_event_file *file);
1318 	int			(*set_filter)(char *filter_str,
1319 					      struct event_trigger_data *data,
1320 					      struct trace_event_file *file);
1321 	struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1322 };
1323 
1324 extern int trace_event_enable_disable(struct trace_event_file *file,
1325 				      int enable, int soft_disable);
1326 extern int tracing_alloc_snapshot(void);
1327 
1328 extern const char *__start___trace_bprintk_fmt[];
1329 extern const char *__stop___trace_bprintk_fmt[];
1330 
1331 extern const char *__start___tracepoint_str[];
1332 extern const char *__stop___tracepoint_str[];
1333 
1334 void trace_printk_control(bool enabled);
1335 void trace_printk_init_buffers(void);
1336 void trace_printk_start_comm(void);
1337 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1338 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1339 
1340 /*
1341  * Normal trace_printk() and friends allocates special buffers
1342  * to do the manipulation, as well as saves the print formats
1343  * into sections to display. But the trace infrastructure wants
1344  * to use these without the added overhead at the price of being
1345  * a bit slower (used mainly for warnings, where we don't care
1346  * about performance). The internal_trace_puts() is for such
1347  * a purpose.
1348  */
1349 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1350 
1351 #undef FTRACE_ENTRY
1352 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)	\
1353 	extern struct trace_event_call					\
1354 	__aligned(4) event_##call;
1355 #undef FTRACE_ENTRY_DUP
1356 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter)	\
1357 	FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1358 		     filter)
1359 #include "trace_entries.h"
1360 
1361 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1362 int perf_ftrace_event_register(struct trace_event_call *call,
1363 			       enum trace_reg type, void *data);
1364 #else
1365 #define perf_ftrace_event_register NULL
1366 #endif
1367 
1368 #ifdef CONFIG_FTRACE_SYSCALLS
1369 void init_ftrace_syscalls(void);
1370 #else
init_ftrace_syscalls(void)1371 static inline void init_ftrace_syscalls(void) { }
1372 #endif
1373 
1374 #ifdef CONFIG_EVENT_TRACING
1375 void trace_event_init(void);
1376 void trace_event_enum_update(struct trace_enum_map **map, int len);
1377 #else
trace_event_init(void)1378 static inline void __init trace_event_init(void) { }
trace_event_enum_update(struct trace_enum_map ** map,int len)1379 static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
1380 #endif
1381 
1382 extern struct trace_iterator *tracepoint_print_iter;
1383 
1384 /*
1385  * Reset the state of the trace_iterator so that it can read consumed data.
1386  * Normally, the trace_iterator is used for reading the data when it is not
1387  * consumed, and must retain state.
1388  */
trace_iterator_reset(struct trace_iterator * iter)1389 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
1390 {
1391 	const size_t offset = offsetof(struct trace_iterator, seq);
1392 
1393 	/*
1394 	 * Keep gcc from complaining about overwriting more than just one
1395 	 * member in the structure.
1396 	 */
1397 	memset((char *)iter + offset, 0, sizeof(struct trace_iterator) - offset);
1398 
1399 	iter->pos = -1;
1400 }
1401 
1402 #endif /* _LINUX_KERNEL_TRACE_H */
1403