xref: /linux/kernel/trace/trace.h (revision 4e0ae876f77bc01a7e77724dea57b4b82bd53244)
1 // SPDX-License-Identifier: GPL-2.0
2 
3 #ifndef _LINUX_KERNEL_TRACE_H
4 #define _LINUX_KERNEL_TRACE_H
5 
6 #include <linux/fs.h>
7 #include <linux/atomic.h>
8 #include <linux/sched.h>
9 #include <linux/clocksource.h>
10 #include <linux/ring_buffer.h>
11 #include <linux/mmiotrace.h>
12 #include <linux/tracepoint.h>
13 #include <linux/ftrace.h>
14 #include <linux/hw_breakpoint.h>
15 #include <linux/trace_seq.h>
16 #include <linux/trace_events.h>
17 #include <linux/compiler.h>
18 #include <linux/trace_seq.h>
19 #include <linux/glob.h>
20 
21 #ifdef CONFIG_FTRACE_SYSCALLS
22 #include <asm/unistd.h>		/* For NR_SYSCALLS	     */
23 #include <asm/syscall.h>	/* some archs define it here */
24 #endif
25 
26 enum trace_type {
27 	__TRACE_FIRST_TYPE = 0,
28 
29 	TRACE_FN,
30 	TRACE_CTX,
31 	TRACE_WAKE,
32 	TRACE_STACK,
33 	TRACE_PRINT,
34 	TRACE_BPRINT,
35 	TRACE_MMIO_RW,
36 	TRACE_MMIO_MAP,
37 	TRACE_BRANCH,
38 	TRACE_GRAPH_RET,
39 	TRACE_GRAPH_ENT,
40 	TRACE_USER_STACK,
41 	TRACE_BLK,
42 	TRACE_BPUTS,
43 	TRACE_HWLAT,
44 	TRACE_RAW_DATA,
45 
46 	__TRACE_LAST_TYPE,
47 };
48 
49 
50 #undef __field
51 #define __field(type, item)		type	item;
52 
53 #undef __field_struct
54 #define __field_struct(type, item)	__field(type, item)
55 
56 #undef __field_desc
57 #define __field_desc(type, container, item)
58 
59 #undef __array
60 #define __array(type, item, size)	type	item[size];
61 
62 #undef __array_desc
63 #define __array_desc(type, container, item, size)
64 
65 #undef __dynamic_array
66 #define __dynamic_array(type, item)	type	item[];
67 
68 #undef F_STRUCT
69 #define F_STRUCT(args...)		args
70 
71 #undef FTRACE_ENTRY
72 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter)	\
73 	struct struct_name {						\
74 		struct trace_entry	ent;				\
75 		tstruct							\
76 	}
77 
78 #undef FTRACE_ENTRY_DUP
79 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
80 
81 #undef FTRACE_ENTRY_REG
82 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print,	\
83 			 filter, regfn) \
84 	FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
85 		     filter)
86 
87 #undef FTRACE_ENTRY_PACKED
88 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print,	\
89 			    filter)					\
90 	FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
91 		     filter) __packed
92 
93 #include "trace_entries.h"
94 
95 /*
96  * syscalls are special, and need special handling, this is why
97  * they are not included in trace_entries.h
98  */
99 struct syscall_trace_enter {
100 	struct trace_entry	ent;
101 	int			nr;
102 	unsigned long		args[];
103 };
104 
105 struct syscall_trace_exit {
106 	struct trace_entry	ent;
107 	int			nr;
108 	long			ret;
109 };
110 
111 struct kprobe_trace_entry_head {
112 	struct trace_entry	ent;
113 	unsigned long		ip;
114 };
115 
116 struct kretprobe_trace_entry_head {
117 	struct trace_entry	ent;
118 	unsigned long		func;
119 	unsigned long		ret_ip;
120 };
121 
122 /*
123  * trace_flag_type is an enumeration that holds different
124  * states when a trace occurs. These are:
125  *  IRQS_OFF		- interrupts were disabled
126  *  IRQS_NOSUPPORT	- arch does not support irqs_disabled_flags
127  *  NEED_RESCHED	- reschedule is requested
128  *  HARDIRQ		- inside an interrupt handler
129  *  SOFTIRQ		- inside a softirq handler
130  */
131 enum trace_flag_type {
132 	TRACE_FLAG_IRQS_OFF		= 0x01,
133 	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
134 	TRACE_FLAG_NEED_RESCHED		= 0x04,
135 	TRACE_FLAG_HARDIRQ		= 0x08,
136 	TRACE_FLAG_SOFTIRQ		= 0x10,
137 	TRACE_FLAG_PREEMPT_RESCHED	= 0x20,
138 	TRACE_FLAG_NMI			= 0x40,
139 };
140 
141 #define TRACE_BUF_SIZE		1024
142 
143 struct trace_array;
144 
145 /*
146  * The CPU trace array - it consists of thousands of trace entries
147  * plus some other descriptor data: (for example which task started
148  * the trace, etc.)
149  */
150 struct trace_array_cpu {
151 	atomic_t		disabled;
152 	void			*buffer_page;	/* ring buffer spare */
153 
154 	unsigned long		entries;
155 	unsigned long		saved_latency;
156 	unsigned long		critical_start;
157 	unsigned long		critical_end;
158 	unsigned long		critical_sequence;
159 	unsigned long		nice;
160 	unsigned long		policy;
161 	unsigned long		rt_priority;
162 	unsigned long		skipped_entries;
163 	u64			preempt_timestamp;
164 	pid_t			pid;
165 	kuid_t			uid;
166 	char			comm[TASK_COMM_LEN];
167 
168 	bool			ignore_pid;
169 #ifdef CONFIG_FUNCTION_TRACER
170 	bool			ftrace_ignore_pid;
171 #endif
172 };
173 
174 struct tracer;
175 struct trace_option_dentry;
176 
177 struct trace_buffer {
178 	struct trace_array		*tr;
179 	struct ring_buffer		*buffer;
180 	struct trace_array_cpu __percpu	*data;
181 	u64				time_start;
182 	int				cpu;
183 };
184 
185 #define TRACE_FLAGS_MAX_SIZE		32
186 
187 struct trace_options {
188 	struct tracer			*tracer;
189 	struct trace_option_dentry	*topts;
190 };
191 
192 struct trace_pid_list {
193 	int				pid_max;
194 	unsigned long			*pids;
195 };
196 
197 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
198 
199 /**
200  * struct cond_snapshot - conditional snapshot data and callback
201  *
202  * The cond_snapshot structure encapsulates a callback function and
203  * data associated with the snapshot for a given tracing instance.
204  *
205  * When a snapshot is taken conditionally, by invoking
206  * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
207  * passed in turn to the cond_snapshot.update() function.  That data
208  * can be compared by the update() implementation with the cond_data
209  * contained wihin the struct cond_snapshot instance associated with
210  * the trace_array.  Because the tr->max_lock is held throughout the
211  * update() call, the update() function can directly retrieve the
212  * cond_snapshot and cond_data associated with the per-instance
213  * snapshot associated with the trace_array.
214  *
215  * The cond_snapshot.update() implementation can save data to be
216  * associated with the snapshot if it decides to, and returns 'true'
217  * in that case, or it returns 'false' if the conditional snapshot
218  * shouldn't be taken.
219  *
220  * The cond_snapshot instance is created and associated with the
221  * user-defined cond_data by tracing_cond_snapshot_enable().
222  * Likewise, the cond_snapshot instance is destroyed and is no longer
223  * associated with the trace instance by
224  * tracing_cond_snapshot_disable().
225  *
226  * The method below is required.
227  *
228  * @update: When a conditional snapshot is invoked, the update()
229  *	callback function is invoked with the tr->max_lock held.  The
230  *	update() implementation signals whether or not to actually
231  *	take the snapshot, by returning 'true' if so, 'false' if no
232  *	snapshot should be taken.  Because the max_lock is held for
233  *	the duration of update(), the implementation is safe to
234  *	directly retrieven and save any implementation data it needs
235  *	to in association with the snapshot.
236  */
237 struct cond_snapshot {
238 	void				*cond_data;
239 	cond_update_fn_t		update;
240 };
241 
242 /*
243  * The trace array - an array of per-CPU trace arrays. This is the
244  * highest level data structure that individual tracers deal with.
245  * They have on/off state as well:
246  */
247 struct trace_array {
248 	struct list_head	list;
249 	char			*name;
250 	struct trace_buffer	trace_buffer;
251 #ifdef CONFIG_TRACER_MAX_TRACE
252 	/*
253 	 * The max_buffer is used to snapshot the trace when a maximum
254 	 * latency is reached, or when the user initiates a snapshot.
255 	 * Some tracers will use this to store a maximum trace while
256 	 * it continues examining live traces.
257 	 *
258 	 * The buffers for the max_buffer are set up the same as the trace_buffer
259 	 * When a snapshot is taken, the buffer of the max_buffer is swapped
260 	 * with the buffer of the trace_buffer and the buffers are reset for
261 	 * the trace_buffer so the tracing can continue.
262 	 */
263 	struct trace_buffer	max_buffer;
264 	bool			allocated_snapshot;
265 #endif
266 #if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
267 	unsigned long		max_latency;
268 #endif
269 	struct trace_pid_list	__rcu *filtered_pids;
270 	/*
271 	 * max_lock is used to protect the swapping of buffers
272 	 * when taking a max snapshot. The buffers themselves are
273 	 * protected by per_cpu spinlocks. But the action of the swap
274 	 * needs its own lock.
275 	 *
276 	 * This is defined as a arch_spinlock_t in order to help
277 	 * with performance when lockdep debugging is enabled.
278 	 *
279 	 * It is also used in other places outside the update_max_tr
280 	 * so it needs to be defined outside of the
281 	 * CONFIG_TRACER_MAX_TRACE.
282 	 */
283 	arch_spinlock_t		max_lock;
284 	int			buffer_disabled;
285 #ifdef CONFIG_FTRACE_SYSCALLS
286 	int			sys_refcount_enter;
287 	int			sys_refcount_exit;
288 	struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
289 	struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
290 #endif
291 	int			stop_count;
292 	int			clock_id;
293 	int			nr_topts;
294 	bool			clear_trace;
295 	int			buffer_percent;
296 	struct tracer		*current_trace;
297 	unsigned int		trace_flags;
298 	unsigned char		trace_flags_index[TRACE_FLAGS_MAX_SIZE];
299 	unsigned int		flags;
300 	raw_spinlock_t		start_lock;
301 	struct dentry		*dir;
302 	struct dentry		*options;
303 	struct dentry		*percpu_dir;
304 	struct dentry		*event_dir;
305 	struct trace_options	*topts;
306 	struct list_head	systems;
307 	struct list_head	events;
308 	struct trace_event_file *trace_marker_file;
309 	cpumask_var_t		tracing_cpumask; /* only trace on set CPUs */
310 	int			ref;
311 #ifdef CONFIG_FUNCTION_TRACER
312 	struct ftrace_ops	*ops;
313 	struct trace_pid_list	__rcu *function_pids;
314 #ifdef CONFIG_DYNAMIC_FTRACE
315 	/* All of these are protected by the ftrace_lock */
316 	struct list_head	func_probes;
317 	struct list_head	mod_trace;
318 	struct list_head	mod_notrace;
319 #endif
320 	/* function tracing enabled */
321 	int			function_enabled;
322 #endif
323 	int			time_stamp_abs_ref;
324 	struct list_head	hist_vars;
325 #ifdef CONFIG_TRACER_SNAPSHOT
326 	struct cond_snapshot	*cond_snapshot;
327 #endif
328 };
329 
330 enum {
331 	TRACE_ARRAY_FL_GLOBAL	= (1 << 0)
332 };
333 
334 extern struct list_head ftrace_trace_arrays;
335 
336 extern struct mutex trace_types_lock;
337 
338 extern int trace_array_get(struct trace_array *tr);
339 extern void trace_array_put(struct trace_array *tr);
340 
341 extern int tracing_set_time_stamp_abs(struct trace_array *tr, bool abs);
342 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
343 
344 extern bool trace_clock_in_ns(struct trace_array *tr);
345 
346 /*
347  * The global tracer (top) should be the first trace array added,
348  * but we check the flag anyway.
349  */
350 static inline struct trace_array *top_trace_array(void)
351 {
352 	struct trace_array *tr;
353 
354 	if (list_empty(&ftrace_trace_arrays))
355 		return NULL;
356 
357 	tr = list_entry(ftrace_trace_arrays.prev,
358 			typeof(*tr), list);
359 	WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
360 	return tr;
361 }
362 
363 #define FTRACE_CMP_TYPE(var, type) \
364 	__builtin_types_compatible_p(typeof(var), type *)
365 
366 #undef IF_ASSIGN
367 #define IF_ASSIGN(var, entry, etype, id)		\
368 	if (FTRACE_CMP_TYPE(var, etype)) {		\
369 		var = (typeof(var))(entry);		\
370 		WARN_ON(id && (entry)->type != id);	\
371 		break;					\
372 	}
373 
374 /* Will cause compile errors if type is not found. */
375 extern void __ftrace_bad_type(void);
376 
377 /*
378  * The trace_assign_type is a verifier that the entry type is
379  * the same as the type being assigned. To add new types simply
380  * add a line with the following format:
381  *
382  * IF_ASSIGN(var, ent, type, id);
383  *
384  *  Where "type" is the trace type that includes the trace_entry
385  *  as the "ent" item. And "id" is the trace identifier that is
386  *  used in the trace_type enum.
387  *
388  *  If the type can have more than one id, then use zero.
389  */
390 #define trace_assign_type(var, ent)					\
391 	do {								\
392 		IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);	\
393 		IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);	\
394 		IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);	\
395 		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
396 		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
397 		IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT);	\
398 		IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS);	\
399 		IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT);	\
400 		IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
401 		IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,		\
402 			  TRACE_MMIO_RW);				\
403 		IF_ASSIGN(var, ent, struct trace_mmiotrace_map,		\
404 			  TRACE_MMIO_MAP);				\
405 		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
406 		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
407 			  TRACE_GRAPH_ENT);		\
408 		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
409 			  TRACE_GRAPH_RET);		\
410 		__ftrace_bad_type();					\
411 	} while (0)
412 
413 /*
414  * An option specific to a tracer. This is a boolean value.
415  * The bit is the bit index that sets its value on the
416  * flags value in struct tracer_flags.
417  */
418 struct tracer_opt {
419 	const char	*name; /* Will appear on the trace_options file */
420 	u32		bit; /* Mask assigned in val field in tracer_flags */
421 };
422 
423 /*
424  * The set of specific options for a tracer. Your tracer
425  * have to set the initial value of the flags val.
426  */
427 struct tracer_flags {
428 	u32			val;
429 	struct tracer_opt	*opts;
430 	struct tracer		*trace;
431 };
432 
433 /* Makes more easy to define a tracer opt */
434 #define TRACER_OPT(s, b)	.name = #s, .bit = b
435 
436 
437 struct trace_option_dentry {
438 	struct tracer_opt		*opt;
439 	struct tracer_flags		*flags;
440 	struct trace_array		*tr;
441 	struct dentry			*entry;
442 };
443 
444 /**
445  * struct tracer - a specific tracer and its callbacks to interact with tracefs
446  * @name: the name chosen to select it on the available_tracers file
447  * @init: called when one switches to this tracer (echo name > current_tracer)
448  * @reset: called when one switches to another tracer
449  * @start: called when tracing is unpaused (echo 1 > tracing_on)
450  * @stop: called when tracing is paused (echo 0 > tracing_on)
451  * @update_thresh: called when tracing_thresh is updated
452  * @open: called when the trace file is opened
453  * @pipe_open: called when the trace_pipe file is opened
454  * @close: called when the trace file is released
455  * @pipe_close: called when the trace_pipe file is released
456  * @read: override the default read callback on trace_pipe
457  * @splice_read: override the default splice_read callback on trace_pipe
458  * @selftest: selftest to run on boot (see trace_selftest.c)
459  * @print_headers: override the first lines that describe your columns
460  * @print_line: callback that prints a trace
461  * @set_flag: signals one of your private flags changed (trace_options file)
462  * @flags: your private flags
463  */
464 struct tracer {
465 	const char		*name;
466 	int			(*init)(struct trace_array *tr);
467 	void			(*reset)(struct trace_array *tr);
468 	void			(*start)(struct trace_array *tr);
469 	void			(*stop)(struct trace_array *tr);
470 	int			(*update_thresh)(struct trace_array *tr);
471 	void			(*open)(struct trace_iterator *iter);
472 	void			(*pipe_open)(struct trace_iterator *iter);
473 	void			(*close)(struct trace_iterator *iter);
474 	void			(*pipe_close)(struct trace_iterator *iter);
475 	ssize_t			(*read)(struct trace_iterator *iter,
476 					struct file *filp, char __user *ubuf,
477 					size_t cnt, loff_t *ppos);
478 	ssize_t			(*splice_read)(struct trace_iterator *iter,
479 					       struct file *filp,
480 					       loff_t *ppos,
481 					       struct pipe_inode_info *pipe,
482 					       size_t len,
483 					       unsigned int flags);
484 #ifdef CONFIG_FTRACE_STARTUP_TEST
485 	int			(*selftest)(struct tracer *trace,
486 					    struct trace_array *tr);
487 #endif
488 	void			(*print_header)(struct seq_file *m);
489 	enum print_line_t	(*print_line)(struct trace_iterator *iter);
490 	/* If you handled the flag setting, return 0 */
491 	int			(*set_flag)(struct trace_array *tr,
492 					    u32 old_flags, u32 bit, int set);
493 	/* Return 0 if OK with change, else return non-zero */
494 	int			(*flag_changed)(struct trace_array *tr,
495 						u32 mask, int set);
496 	struct tracer		*next;
497 	struct tracer_flags	*flags;
498 	int			enabled;
499 	int			ref;
500 	bool			print_max;
501 	bool			allow_instances;
502 #ifdef CONFIG_TRACER_MAX_TRACE
503 	bool			use_max_tr;
504 #endif
505 	/* True if tracer cannot be enabled in kernel param */
506 	bool			noboot;
507 };
508 
509 
510 /* Only current can touch trace_recursion */
511 
512 /*
513  * For function tracing recursion:
514  *  The order of these bits are important.
515  *
516  *  When function tracing occurs, the following steps are made:
517  *   If arch does not support a ftrace feature:
518  *    call internal function (uses INTERNAL bits) which calls...
519  *   If callback is registered to the "global" list, the list
520  *    function is called and recursion checks the GLOBAL bits.
521  *    then this function calls...
522  *   The function callback, which can use the FTRACE bits to
523  *    check for recursion.
524  *
525  * Now if the arch does not suppport a feature, and it calls
526  * the global list function which calls the ftrace callback
527  * all three of these steps will do a recursion protection.
528  * There's no reason to do one if the previous caller already
529  * did. The recursion that we are protecting against will
530  * go through the same steps again.
531  *
532  * To prevent the multiple recursion checks, if a recursion
533  * bit is set that is higher than the MAX bit of the current
534  * check, then we know that the check was made by the previous
535  * caller, and we can skip the current check.
536  */
537 enum {
538 	TRACE_BUFFER_BIT,
539 	TRACE_BUFFER_NMI_BIT,
540 	TRACE_BUFFER_IRQ_BIT,
541 	TRACE_BUFFER_SIRQ_BIT,
542 
543 	/* Start of function recursion bits */
544 	TRACE_FTRACE_BIT,
545 	TRACE_FTRACE_NMI_BIT,
546 	TRACE_FTRACE_IRQ_BIT,
547 	TRACE_FTRACE_SIRQ_BIT,
548 
549 	/* INTERNAL_BITs must be greater than FTRACE_BITs */
550 	TRACE_INTERNAL_BIT,
551 	TRACE_INTERNAL_NMI_BIT,
552 	TRACE_INTERNAL_IRQ_BIT,
553 	TRACE_INTERNAL_SIRQ_BIT,
554 
555 	TRACE_BRANCH_BIT,
556 /*
557  * Abuse of the trace_recursion.
558  * As we need a way to maintain state if we are tracing the function
559  * graph in irq because we want to trace a particular function that
560  * was called in irq context but we have irq tracing off. Since this
561  * can only be modified by current, we can reuse trace_recursion.
562  */
563 	TRACE_IRQ_BIT,
564 
565 	/* Set if the function is in the set_graph_function file */
566 	TRACE_GRAPH_BIT,
567 
568 	/*
569 	 * In the very unlikely case that an interrupt came in
570 	 * at a start of graph tracing, and we want to trace
571 	 * the function in that interrupt, the depth can be greater
572 	 * than zero, because of the preempted start of a previous
573 	 * trace. In an even more unlikely case, depth could be 2
574 	 * if a softirq interrupted the start of graph tracing,
575 	 * followed by an interrupt preempting a start of graph
576 	 * tracing in the softirq, and depth can even be 3
577 	 * if an NMI came in at the start of an interrupt function
578 	 * that preempted a softirq start of a function that
579 	 * preempted normal context!!!! Luckily, it can't be
580 	 * greater than 3, so the next two bits are a mask
581 	 * of what the depth is when we set TRACE_GRAPH_BIT
582 	 */
583 
584 	TRACE_GRAPH_DEPTH_START_BIT,
585 	TRACE_GRAPH_DEPTH_END_BIT,
586 
587 	/*
588 	 * To implement set_graph_notrace, if this bit is set, we ignore
589 	 * function graph tracing of called functions, until the return
590 	 * function is called to clear it.
591 	 */
592 	TRACE_GRAPH_NOTRACE_BIT,
593 };
594 
595 #define trace_recursion_set(bit)	do { (current)->trace_recursion |= (1<<(bit)); } while (0)
596 #define trace_recursion_clear(bit)	do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
597 #define trace_recursion_test(bit)	((current)->trace_recursion & (1<<(bit)))
598 
599 #define trace_recursion_depth() \
600 	(((current)->trace_recursion >> TRACE_GRAPH_DEPTH_START_BIT) & 3)
601 #define trace_recursion_set_depth(depth) \
602 	do {								\
603 		current->trace_recursion &=				\
604 			~(3 << TRACE_GRAPH_DEPTH_START_BIT);		\
605 		current->trace_recursion |=				\
606 			((depth) & 3) << TRACE_GRAPH_DEPTH_START_BIT;	\
607 	} while (0)
608 
609 #define TRACE_CONTEXT_BITS	4
610 
611 #define TRACE_FTRACE_START	TRACE_FTRACE_BIT
612 #define TRACE_FTRACE_MAX	((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
613 
614 #define TRACE_LIST_START	TRACE_INTERNAL_BIT
615 #define TRACE_LIST_MAX		((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
616 
617 #define TRACE_CONTEXT_MASK	TRACE_LIST_MAX
618 
619 static __always_inline int trace_get_context_bit(void)
620 {
621 	int bit;
622 
623 	if (in_interrupt()) {
624 		if (in_nmi())
625 			bit = 0;
626 
627 		else if (in_irq())
628 			bit = 1;
629 		else
630 			bit = 2;
631 	} else
632 		bit = 3;
633 
634 	return bit;
635 }
636 
637 static __always_inline int trace_test_and_set_recursion(int start, int max)
638 {
639 	unsigned int val = current->trace_recursion;
640 	int bit;
641 
642 	/* A previous recursion check was made */
643 	if ((val & TRACE_CONTEXT_MASK) > max)
644 		return 0;
645 
646 	bit = trace_get_context_bit() + start;
647 	if (unlikely(val & (1 << bit)))
648 		return -1;
649 
650 	val |= 1 << bit;
651 	current->trace_recursion = val;
652 	barrier();
653 
654 	return bit;
655 }
656 
657 static __always_inline void trace_clear_recursion(int bit)
658 {
659 	unsigned int val = current->trace_recursion;
660 
661 	if (!bit)
662 		return;
663 
664 	bit = 1 << bit;
665 	val &= ~bit;
666 
667 	barrier();
668 	current->trace_recursion = val;
669 }
670 
671 static inline struct ring_buffer_iter *
672 trace_buffer_iter(struct trace_iterator *iter, int cpu)
673 {
674 	return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
675 }
676 
677 int tracer_init(struct tracer *t, struct trace_array *tr);
678 int tracing_is_enabled(void);
679 void tracing_reset(struct trace_buffer *buf, int cpu);
680 void tracing_reset_online_cpus(struct trace_buffer *buf);
681 void tracing_reset_current(int cpu);
682 void tracing_reset_all_online_cpus(void);
683 int tracing_open_generic(struct inode *inode, struct file *filp);
684 bool tracing_is_disabled(void);
685 bool tracer_tracing_is_on(struct trace_array *tr);
686 void tracer_tracing_on(struct trace_array *tr);
687 void tracer_tracing_off(struct trace_array *tr);
688 struct dentry *trace_create_file(const char *name,
689 				 umode_t mode,
690 				 struct dentry *parent,
691 				 void *data,
692 				 const struct file_operations *fops);
693 
694 struct dentry *tracing_init_dentry(void);
695 
696 struct ring_buffer_event;
697 
698 struct ring_buffer_event *
699 trace_buffer_lock_reserve(struct ring_buffer *buffer,
700 			  int type,
701 			  unsigned long len,
702 			  unsigned long flags,
703 			  int pc);
704 
705 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
706 						struct trace_array_cpu *data);
707 
708 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
709 					  int *ent_cpu, u64 *ent_ts);
710 
711 void trace_buffer_unlock_commit_nostack(struct ring_buffer *buffer,
712 					struct ring_buffer_event *event);
713 
714 int trace_empty(struct trace_iterator *iter);
715 
716 void *trace_find_next_entry_inc(struct trace_iterator *iter);
717 
718 void trace_init_global_iter(struct trace_iterator *iter);
719 
720 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
721 
722 void trace_function(struct trace_array *tr,
723 		    unsigned long ip,
724 		    unsigned long parent_ip,
725 		    unsigned long flags, int pc);
726 void trace_graph_function(struct trace_array *tr,
727 		    unsigned long ip,
728 		    unsigned long parent_ip,
729 		    unsigned long flags, int pc);
730 void trace_latency_header(struct seq_file *m);
731 void trace_default_header(struct seq_file *m);
732 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
733 int trace_empty(struct trace_iterator *iter);
734 
735 void trace_graph_return(struct ftrace_graph_ret *trace);
736 int trace_graph_entry(struct ftrace_graph_ent *trace);
737 void set_graph_array(struct trace_array *tr);
738 
739 void tracing_start_cmdline_record(void);
740 void tracing_stop_cmdline_record(void);
741 void tracing_start_tgid_record(void);
742 void tracing_stop_tgid_record(void);
743 
744 int register_tracer(struct tracer *type);
745 int is_tracing_stopped(void);
746 
747 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
748 
749 extern cpumask_var_t __read_mostly tracing_buffer_mask;
750 
751 #define for_each_tracing_cpu(cpu)	\
752 	for_each_cpu(cpu, tracing_buffer_mask)
753 
754 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
755 
756 extern unsigned long tracing_thresh;
757 
758 /* PID filtering */
759 
760 extern int pid_max;
761 
762 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
763 			     pid_t search_pid);
764 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
765 			    struct task_struct *task);
766 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
767 				  struct task_struct *self,
768 				  struct task_struct *task);
769 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
770 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
771 int trace_pid_show(struct seq_file *m, void *v);
772 void trace_free_pid_list(struct trace_pid_list *pid_list);
773 int trace_pid_write(struct trace_pid_list *filtered_pids,
774 		    struct trace_pid_list **new_pid_list,
775 		    const char __user *ubuf, size_t cnt);
776 
777 #ifdef CONFIG_TRACER_MAX_TRACE
778 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
779 		   void *cond_data);
780 void update_max_tr_single(struct trace_array *tr,
781 			  struct task_struct *tsk, int cpu);
782 #endif /* CONFIG_TRACER_MAX_TRACE */
783 
784 #ifdef CONFIG_STACKTRACE
785 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
786 			    int pc);
787 
788 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
789 		   int pc);
790 #else
791 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
792 					  unsigned long flags, int pc)
793 {
794 }
795 
796 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
797 				 int skip, int pc)
798 {
799 }
800 #endif /* CONFIG_STACKTRACE */
801 
802 extern u64 ftrace_now(int cpu);
803 
804 extern void trace_find_cmdline(int pid, char comm[]);
805 extern int trace_find_tgid(int pid);
806 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
807 
808 #ifdef CONFIG_DYNAMIC_FTRACE
809 extern unsigned long ftrace_update_tot_cnt;
810 void ftrace_init_trace_array(struct trace_array *tr);
811 #else
812 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
813 #endif
814 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
815 extern int DYN_FTRACE_TEST_NAME(void);
816 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
817 extern int DYN_FTRACE_TEST_NAME2(void);
818 
819 extern bool ring_buffer_expanded;
820 extern bool tracing_selftest_disabled;
821 
822 #ifdef CONFIG_FTRACE_STARTUP_TEST
823 extern int trace_selftest_startup_function(struct tracer *trace,
824 					   struct trace_array *tr);
825 extern int trace_selftest_startup_function_graph(struct tracer *trace,
826 						 struct trace_array *tr);
827 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
828 					  struct trace_array *tr);
829 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
830 					     struct trace_array *tr);
831 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
832 						 struct trace_array *tr);
833 extern int trace_selftest_startup_wakeup(struct tracer *trace,
834 					 struct trace_array *tr);
835 extern int trace_selftest_startup_nop(struct tracer *trace,
836 					 struct trace_array *tr);
837 extern int trace_selftest_startup_branch(struct tracer *trace,
838 					 struct trace_array *tr);
839 /*
840  * Tracer data references selftest functions that only occur
841  * on boot up. These can be __init functions. Thus, when selftests
842  * are enabled, then the tracers need to reference __init functions.
843  */
844 #define __tracer_data		__refdata
845 #else
846 /* Tracers are seldom changed. Optimize when selftests are disabled. */
847 #define __tracer_data		__read_mostly
848 #endif /* CONFIG_FTRACE_STARTUP_TEST */
849 
850 extern void *head_page(struct trace_array_cpu *data);
851 extern unsigned long long ns2usecs(u64 nsec);
852 extern int
853 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
854 extern int
855 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
856 extern int
857 trace_array_vprintk(struct trace_array *tr,
858 		    unsigned long ip, const char *fmt, va_list args);
859 int trace_array_printk(struct trace_array *tr,
860 		       unsigned long ip, const char *fmt, ...);
861 int trace_array_printk_buf(struct ring_buffer *buffer,
862 			   unsigned long ip, const char *fmt, ...);
863 void trace_printk_seq(struct trace_seq *s);
864 enum print_line_t print_trace_line(struct trace_iterator *iter);
865 
866 extern char trace_find_mark(unsigned long long duration);
867 
868 struct ftrace_hash;
869 
870 struct ftrace_mod_load {
871 	struct list_head	list;
872 	char			*func;
873 	char			*module;
874 	int			 enable;
875 };
876 
877 enum {
878 	FTRACE_HASH_FL_MOD	= (1 << 0),
879 };
880 
881 struct ftrace_hash {
882 	unsigned long		size_bits;
883 	struct hlist_head	*buckets;
884 	unsigned long		count;
885 	unsigned long		flags;
886 	struct rcu_head		rcu;
887 };
888 
889 struct ftrace_func_entry *
890 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
891 
892 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
893 {
894 	return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
895 }
896 
897 /* Standard output formatting function used for function return traces */
898 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
899 
900 /* Flag options */
901 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
902 #define TRACE_GRAPH_PRINT_CPU           0x2
903 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
904 #define TRACE_GRAPH_PRINT_PROC          0x8
905 #define TRACE_GRAPH_PRINT_DURATION      0x10
906 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
907 #define TRACE_GRAPH_PRINT_REL_TIME      0x40
908 #define TRACE_GRAPH_PRINT_IRQS          0x80
909 #define TRACE_GRAPH_PRINT_TAIL          0x100
910 #define TRACE_GRAPH_SLEEP_TIME          0x200
911 #define TRACE_GRAPH_GRAPH_TIME          0x400
912 #define TRACE_GRAPH_PRINT_FILL_SHIFT	28
913 #define TRACE_GRAPH_PRINT_FILL_MASK	(0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
914 
915 extern void ftrace_graph_sleep_time_control(bool enable);
916 
917 #ifdef CONFIG_FUNCTION_PROFILER
918 extern void ftrace_graph_graph_time_control(bool enable);
919 #else
920 static inline void ftrace_graph_graph_time_control(bool enable) { }
921 #endif
922 
923 extern enum print_line_t
924 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
925 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
926 extern void
927 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
928 extern void graph_trace_open(struct trace_iterator *iter);
929 extern void graph_trace_close(struct trace_iterator *iter);
930 extern int __trace_graph_entry(struct trace_array *tr,
931 			       struct ftrace_graph_ent *trace,
932 			       unsigned long flags, int pc);
933 extern void __trace_graph_return(struct trace_array *tr,
934 				 struct ftrace_graph_ret *trace,
935 				 unsigned long flags, int pc);
936 
937 #ifdef CONFIG_DYNAMIC_FTRACE
938 extern struct ftrace_hash *ftrace_graph_hash;
939 extern struct ftrace_hash *ftrace_graph_notrace_hash;
940 
941 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
942 {
943 	unsigned long addr = trace->func;
944 	int ret = 0;
945 
946 	preempt_disable_notrace();
947 
948 	if (ftrace_hash_empty(ftrace_graph_hash)) {
949 		ret = 1;
950 		goto out;
951 	}
952 
953 	if (ftrace_lookup_ip(ftrace_graph_hash, addr)) {
954 
955 		/*
956 		 * This needs to be cleared on the return functions
957 		 * when the depth is zero.
958 		 */
959 		trace_recursion_set(TRACE_GRAPH_BIT);
960 		trace_recursion_set_depth(trace->depth);
961 
962 		/*
963 		 * If no irqs are to be traced, but a set_graph_function
964 		 * is set, and called by an interrupt handler, we still
965 		 * want to trace it.
966 		 */
967 		if (in_irq())
968 			trace_recursion_set(TRACE_IRQ_BIT);
969 		else
970 			trace_recursion_clear(TRACE_IRQ_BIT);
971 		ret = 1;
972 	}
973 
974 out:
975 	preempt_enable_notrace();
976 	return ret;
977 }
978 
979 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
980 {
981 	if (trace_recursion_test(TRACE_GRAPH_BIT) &&
982 	    trace->depth == trace_recursion_depth())
983 		trace_recursion_clear(TRACE_GRAPH_BIT);
984 }
985 
986 static inline int ftrace_graph_notrace_addr(unsigned long addr)
987 {
988 	int ret = 0;
989 
990 	preempt_disable_notrace();
991 
992 	if (ftrace_lookup_ip(ftrace_graph_notrace_hash, addr))
993 		ret = 1;
994 
995 	preempt_enable_notrace();
996 	return ret;
997 }
998 #else
999 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
1000 {
1001 	return 1;
1002 }
1003 
1004 static inline int ftrace_graph_notrace_addr(unsigned long addr)
1005 {
1006 	return 0;
1007 }
1008 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
1009 { }
1010 #endif /* CONFIG_DYNAMIC_FTRACE */
1011 
1012 extern unsigned int fgraph_max_depth;
1013 
1014 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
1015 {
1016 	/* trace it when it is-nested-in or is a function enabled. */
1017 	return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
1018 		 ftrace_graph_addr(trace)) ||
1019 		(trace->depth < 0) ||
1020 		(fgraph_max_depth && trace->depth >= fgraph_max_depth);
1021 }
1022 
1023 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
1024 static inline enum print_line_t
1025 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1026 {
1027 	return TRACE_TYPE_UNHANDLED;
1028 }
1029 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
1030 
1031 extern struct list_head ftrace_pids;
1032 
1033 #ifdef CONFIG_FUNCTION_TRACER
1034 struct ftrace_func_command {
1035 	struct list_head	list;
1036 	char			*name;
1037 	int			(*func)(struct trace_array *tr,
1038 					struct ftrace_hash *hash,
1039 					char *func, char *cmd,
1040 					char *params, int enable);
1041 };
1042 extern bool ftrace_filter_param __initdata;
1043 static inline int ftrace_trace_task(struct trace_array *tr)
1044 {
1045 	return !this_cpu_read(tr->trace_buffer.data->ftrace_ignore_pid);
1046 }
1047 extern int ftrace_is_dead(void);
1048 int ftrace_create_function_files(struct trace_array *tr,
1049 				 struct dentry *parent);
1050 void ftrace_destroy_function_files(struct trace_array *tr);
1051 void ftrace_init_global_array_ops(struct trace_array *tr);
1052 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1053 void ftrace_reset_array_ops(struct trace_array *tr);
1054 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1055 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1056 				  struct dentry *d_tracer);
1057 void ftrace_clear_pids(struct trace_array *tr);
1058 int init_function_trace(void);
1059 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1060 #else
1061 static inline int ftrace_trace_task(struct trace_array *tr)
1062 {
1063 	return 1;
1064 }
1065 static inline int ftrace_is_dead(void) { return 0; }
1066 static inline int
1067 ftrace_create_function_files(struct trace_array *tr,
1068 			     struct dentry *parent)
1069 {
1070 	return 0;
1071 }
1072 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1073 static inline __init void
1074 ftrace_init_global_array_ops(struct trace_array *tr) { }
1075 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
1076 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
1077 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
1078 static inline void ftrace_clear_pids(struct trace_array *tr) { }
1079 static inline int init_function_trace(void) { return 0; }
1080 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1081 /* ftace_func_t type is not defined, use macro instead of static inline */
1082 #define ftrace_init_array_ops(tr, func) do { } while (0)
1083 #endif /* CONFIG_FUNCTION_TRACER */
1084 
1085 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1086 
1087 struct ftrace_probe_ops {
1088 	void			(*func)(unsigned long ip,
1089 					unsigned long parent_ip,
1090 					struct trace_array *tr,
1091 					struct ftrace_probe_ops *ops,
1092 					void *data);
1093 	int			(*init)(struct ftrace_probe_ops *ops,
1094 					struct trace_array *tr,
1095 					unsigned long ip, void *init_data,
1096 					void **data);
1097 	void			(*free)(struct ftrace_probe_ops *ops,
1098 					struct trace_array *tr,
1099 					unsigned long ip, void *data);
1100 	int			(*print)(struct seq_file *m,
1101 					 unsigned long ip,
1102 					 struct ftrace_probe_ops *ops,
1103 					 void *data);
1104 };
1105 
1106 struct ftrace_func_mapper;
1107 typedef int (*ftrace_mapper_func)(void *data);
1108 
1109 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1110 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1111 					   unsigned long ip);
1112 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1113 			       unsigned long ip, void *data);
1114 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1115 				   unsigned long ip);
1116 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1117 			     ftrace_mapper_func free_func);
1118 
1119 extern int
1120 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1121 			       struct ftrace_probe_ops *ops, void *data);
1122 extern int
1123 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1124 				      struct ftrace_probe_ops *ops);
1125 extern void clear_ftrace_function_probes(struct trace_array *tr);
1126 
1127 int register_ftrace_command(struct ftrace_func_command *cmd);
1128 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1129 
1130 void ftrace_create_filter_files(struct ftrace_ops *ops,
1131 				struct dentry *parent);
1132 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1133 #else
1134 struct ftrace_func_command;
1135 
1136 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1137 {
1138 	return -EINVAL;
1139 }
1140 static inline __init int unregister_ftrace_command(char *cmd_name)
1141 {
1142 	return -EINVAL;
1143 }
1144 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1145 {
1146 }
1147 
1148 /*
1149  * The ops parameter passed in is usually undefined.
1150  * This must be a macro.
1151  */
1152 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1153 #define ftrace_destroy_filter_files(ops) do { } while (0)
1154 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1155 
1156 bool ftrace_event_is_function(struct trace_event_call *call);
1157 
1158 /*
1159  * struct trace_parser - servers for reading the user input separated by spaces
1160  * @cont: set if the input is not complete - no final space char was found
1161  * @buffer: holds the parsed user input
1162  * @idx: user input length
1163  * @size: buffer size
1164  */
1165 struct trace_parser {
1166 	bool		cont;
1167 	char		*buffer;
1168 	unsigned	idx;
1169 	unsigned	size;
1170 };
1171 
1172 static inline bool trace_parser_loaded(struct trace_parser *parser)
1173 {
1174 	return (parser->idx != 0);
1175 }
1176 
1177 static inline bool trace_parser_cont(struct trace_parser *parser)
1178 {
1179 	return parser->cont;
1180 }
1181 
1182 static inline void trace_parser_clear(struct trace_parser *parser)
1183 {
1184 	parser->cont = false;
1185 	parser->idx = 0;
1186 }
1187 
1188 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1189 extern void trace_parser_put(struct trace_parser *parser);
1190 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1191 	size_t cnt, loff_t *ppos);
1192 
1193 /*
1194  * Only create function graph options if function graph is configured.
1195  */
1196 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1197 # define FGRAPH_FLAGS						\
1198 		C(DISPLAY_GRAPH,	"display-graph"),
1199 #else
1200 # define FGRAPH_FLAGS
1201 #endif
1202 
1203 #ifdef CONFIG_BRANCH_TRACER
1204 # define BRANCH_FLAGS					\
1205 		C(BRANCH,		"branch"),
1206 #else
1207 # define BRANCH_FLAGS
1208 #endif
1209 
1210 #ifdef CONFIG_FUNCTION_TRACER
1211 # define FUNCTION_FLAGS						\
1212 		C(FUNCTION,		"function-trace"),	\
1213 		C(FUNC_FORK,		"function-fork"),
1214 # define FUNCTION_DEFAULT_FLAGS		TRACE_ITER_FUNCTION
1215 #else
1216 # define FUNCTION_FLAGS
1217 # define FUNCTION_DEFAULT_FLAGS		0UL
1218 # define TRACE_ITER_FUNC_FORK		0UL
1219 #endif
1220 
1221 #ifdef CONFIG_STACKTRACE
1222 # define STACK_FLAGS				\
1223 		C(STACKTRACE,		"stacktrace"),
1224 #else
1225 # define STACK_FLAGS
1226 #endif
1227 
1228 /*
1229  * trace_iterator_flags is an enumeration that defines bit
1230  * positions into trace_flags that controls the output.
1231  *
1232  * NOTE: These bits must match the trace_options array in
1233  *       trace.c (this macro guarantees it).
1234  */
1235 #define TRACE_FLAGS						\
1236 		C(PRINT_PARENT,		"print-parent"),	\
1237 		C(SYM_OFFSET,		"sym-offset"),		\
1238 		C(SYM_ADDR,		"sym-addr"),		\
1239 		C(VERBOSE,		"verbose"),		\
1240 		C(RAW,			"raw"),			\
1241 		C(HEX,			"hex"),			\
1242 		C(BIN,			"bin"),			\
1243 		C(BLOCK,		"block"),		\
1244 		C(PRINTK,		"trace_printk"),	\
1245 		C(ANNOTATE,		"annotate"),		\
1246 		C(USERSTACKTRACE,	"userstacktrace"),	\
1247 		C(SYM_USEROBJ,		"sym-userobj"),		\
1248 		C(PRINTK_MSGONLY,	"printk-msg-only"),	\
1249 		C(CONTEXT_INFO,		"context-info"),   /* Print pid/cpu/time */ \
1250 		C(LATENCY_FMT,		"latency-format"),	\
1251 		C(RECORD_CMD,		"record-cmd"),		\
1252 		C(RECORD_TGID,		"record-tgid"),		\
1253 		C(OVERWRITE,		"overwrite"),		\
1254 		C(STOP_ON_FREE,		"disable_on_free"),	\
1255 		C(IRQ_INFO,		"irq-info"),		\
1256 		C(MARKERS,		"markers"),		\
1257 		C(EVENT_FORK,		"event-fork"),		\
1258 		FUNCTION_FLAGS					\
1259 		FGRAPH_FLAGS					\
1260 		STACK_FLAGS					\
1261 		BRANCH_FLAGS
1262 
1263 /*
1264  * By defining C, we can make TRACE_FLAGS a list of bit names
1265  * that will define the bits for the flag masks.
1266  */
1267 #undef C
1268 #define C(a, b) TRACE_ITER_##a##_BIT
1269 
1270 enum trace_iterator_bits {
1271 	TRACE_FLAGS
1272 	/* Make sure we don't go more than we have bits for */
1273 	TRACE_ITER_LAST_BIT
1274 };
1275 
1276 /*
1277  * By redefining C, we can make TRACE_FLAGS a list of masks that
1278  * use the bits as defined above.
1279  */
1280 #undef C
1281 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1282 
1283 enum trace_iterator_flags { TRACE_FLAGS };
1284 
1285 /*
1286  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1287  * control the output of kernel symbols.
1288  */
1289 #define TRACE_ITER_SYM_MASK \
1290 	(TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1291 
1292 extern struct tracer nop_trace;
1293 
1294 #ifdef CONFIG_BRANCH_TRACER
1295 extern int enable_branch_tracing(struct trace_array *tr);
1296 extern void disable_branch_tracing(void);
1297 static inline int trace_branch_enable(struct trace_array *tr)
1298 {
1299 	if (tr->trace_flags & TRACE_ITER_BRANCH)
1300 		return enable_branch_tracing(tr);
1301 	return 0;
1302 }
1303 static inline void trace_branch_disable(void)
1304 {
1305 	/* due to races, always disable */
1306 	disable_branch_tracing();
1307 }
1308 #else
1309 static inline int trace_branch_enable(struct trace_array *tr)
1310 {
1311 	return 0;
1312 }
1313 static inline void trace_branch_disable(void)
1314 {
1315 }
1316 #endif /* CONFIG_BRANCH_TRACER */
1317 
1318 /* set ring buffers to default size if not already done so */
1319 int tracing_update_buffers(void);
1320 
1321 struct ftrace_event_field {
1322 	struct list_head	link;
1323 	const char		*name;
1324 	const char		*type;
1325 	int			filter_type;
1326 	int			offset;
1327 	int			size;
1328 	int			is_signed;
1329 };
1330 
1331 struct prog_entry;
1332 
1333 struct event_filter {
1334 	struct prog_entry __rcu	*prog;
1335 	char			*filter_string;
1336 };
1337 
1338 struct event_subsystem {
1339 	struct list_head	list;
1340 	const char		*name;
1341 	struct event_filter	*filter;
1342 	int			ref_count;
1343 };
1344 
1345 struct trace_subsystem_dir {
1346 	struct list_head		list;
1347 	struct event_subsystem		*subsystem;
1348 	struct trace_array		*tr;
1349 	struct dentry			*entry;
1350 	int				ref_count;
1351 	int				nr_events;
1352 };
1353 
1354 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1355 				     struct ring_buffer *buffer,
1356 				     struct ring_buffer_event *event);
1357 
1358 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1359 				     struct ring_buffer *buffer,
1360 				     struct ring_buffer_event *event,
1361 				     unsigned long flags, int pc,
1362 				     struct pt_regs *regs);
1363 
1364 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1365 					      struct ring_buffer *buffer,
1366 					      struct ring_buffer_event *event,
1367 					      unsigned long flags, int pc)
1368 {
1369 	trace_buffer_unlock_commit_regs(tr, buffer, event, flags, pc, NULL);
1370 }
1371 
1372 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1373 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1374 void trace_buffered_event_disable(void);
1375 void trace_buffered_event_enable(void);
1376 
1377 static inline void
1378 __trace_event_discard_commit(struct ring_buffer *buffer,
1379 			     struct ring_buffer_event *event)
1380 {
1381 	if (this_cpu_read(trace_buffered_event) == event) {
1382 		/* Simply release the temp buffer */
1383 		this_cpu_dec(trace_buffered_event_cnt);
1384 		return;
1385 	}
1386 	ring_buffer_discard_commit(buffer, event);
1387 }
1388 
1389 /*
1390  * Helper function for event_trigger_unlock_commit{_regs}().
1391  * If there are event triggers attached to this event that requires
1392  * filtering against its fields, then they wil be called as the
1393  * entry already holds the field information of the current event.
1394  *
1395  * It also checks if the event should be discarded or not.
1396  * It is to be discarded if the event is soft disabled and the
1397  * event was only recorded to process triggers, or if the event
1398  * filter is active and this event did not match the filters.
1399  *
1400  * Returns true if the event is discarded, false otherwise.
1401  */
1402 static inline bool
1403 __event_trigger_test_discard(struct trace_event_file *file,
1404 			     struct ring_buffer *buffer,
1405 			     struct ring_buffer_event *event,
1406 			     void *entry,
1407 			     enum event_trigger_type *tt)
1408 {
1409 	unsigned long eflags = file->flags;
1410 
1411 	if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1412 		*tt = event_triggers_call(file, entry, event);
1413 
1414 	if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
1415 	    (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
1416 	     !filter_match_preds(file->filter, entry))) {
1417 		__trace_event_discard_commit(buffer, event);
1418 		return true;
1419 	}
1420 
1421 	return false;
1422 }
1423 
1424 /**
1425  * event_trigger_unlock_commit - handle triggers and finish event commit
1426  * @file: The file pointer assoctiated to the event
1427  * @buffer: The ring buffer that the event is being written to
1428  * @event: The event meta data in the ring buffer
1429  * @entry: The event itself
1430  * @irq_flags: The state of the interrupts at the start of the event
1431  * @pc: The state of the preempt count at the start of the event.
1432  *
1433  * This is a helper function to handle triggers that require data
1434  * from the event itself. It also tests the event against filters and
1435  * if the event is soft disabled and should be discarded.
1436  */
1437 static inline void
1438 event_trigger_unlock_commit(struct trace_event_file *file,
1439 			    struct ring_buffer *buffer,
1440 			    struct ring_buffer_event *event,
1441 			    void *entry, unsigned long irq_flags, int pc)
1442 {
1443 	enum event_trigger_type tt = ETT_NONE;
1444 
1445 	if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1446 		trace_buffer_unlock_commit(file->tr, buffer, event, irq_flags, pc);
1447 
1448 	if (tt)
1449 		event_triggers_post_call(file, tt);
1450 }
1451 
1452 /**
1453  * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1454  * @file: The file pointer assoctiated to the event
1455  * @buffer: The ring buffer that the event is being written to
1456  * @event: The event meta data in the ring buffer
1457  * @entry: The event itself
1458  * @irq_flags: The state of the interrupts at the start of the event
1459  * @pc: The state of the preempt count at the start of the event.
1460  *
1461  * This is a helper function to handle triggers that require data
1462  * from the event itself. It also tests the event against filters and
1463  * if the event is soft disabled and should be discarded.
1464  *
1465  * Same as event_trigger_unlock_commit() but calls
1466  * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1467  */
1468 static inline void
1469 event_trigger_unlock_commit_regs(struct trace_event_file *file,
1470 				 struct ring_buffer *buffer,
1471 				 struct ring_buffer_event *event,
1472 				 void *entry, unsigned long irq_flags, int pc,
1473 				 struct pt_regs *regs)
1474 {
1475 	enum event_trigger_type tt = ETT_NONE;
1476 
1477 	if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1478 		trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1479 						irq_flags, pc, regs);
1480 
1481 	if (tt)
1482 		event_triggers_post_call(file, tt);
1483 }
1484 
1485 #define FILTER_PRED_INVALID	((unsigned short)-1)
1486 #define FILTER_PRED_IS_RIGHT	(1 << 15)
1487 #define FILTER_PRED_FOLD	(1 << 15)
1488 
1489 /*
1490  * The max preds is the size of unsigned short with
1491  * two flags at the MSBs. One bit is used for both the IS_RIGHT
1492  * and FOLD flags. The other is reserved.
1493  *
1494  * 2^14 preds is way more than enough.
1495  */
1496 #define MAX_FILTER_PRED		16384
1497 
1498 struct filter_pred;
1499 struct regex;
1500 
1501 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
1502 
1503 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1504 
1505 enum regex_type {
1506 	MATCH_FULL = 0,
1507 	MATCH_FRONT_ONLY,
1508 	MATCH_MIDDLE_ONLY,
1509 	MATCH_END_ONLY,
1510 	MATCH_GLOB,
1511 	MATCH_INDEX,
1512 };
1513 
1514 struct regex {
1515 	char			pattern[MAX_FILTER_STR_VAL];
1516 	int			len;
1517 	int			field_len;
1518 	regex_match_func	match;
1519 };
1520 
1521 struct filter_pred {
1522 	filter_pred_fn_t 	fn;
1523 	u64 			val;
1524 	struct regex		regex;
1525 	unsigned short		*ops;
1526 	struct ftrace_event_field *field;
1527 	int 			offset;
1528 	int			not;
1529 	int 			op;
1530 };
1531 
1532 static inline bool is_string_field(struct ftrace_event_field *field)
1533 {
1534 	return field->filter_type == FILTER_DYN_STRING ||
1535 	       field->filter_type == FILTER_STATIC_STRING ||
1536 	       field->filter_type == FILTER_PTR_STRING ||
1537 	       field->filter_type == FILTER_COMM;
1538 }
1539 
1540 static inline bool is_function_field(struct ftrace_event_field *field)
1541 {
1542 	return field->filter_type == FILTER_TRACE_FN;
1543 }
1544 
1545 extern enum regex_type
1546 filter_parse_regex(char *buff, int len, char **search, int *not);
1547 extern void print_event_filter(struct trace_event_file *file,
1548 			       struct trace_seq *s);
1549 extern int apply_event_filter(struct trace_event_file *file,
1550 			      char *filter_string);
1551 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1552 					char *filter_string);
1553 extern void print_subsystem_event_filter(struct event_subsystem *system,
1554 					 struct trace_seq *s);
1555 extern int filter_assign_type(const char *type);
1556 extern int create_event_filter(struct trace_event_call *call,
1557 			       char *filter_str, bool set_str,
1558 			       struct event_filter **filterp);
1559 extern void free_event_filter(struct event_filter *filter);
1560 
1561 struct ftrace_event_field *
1562 trace_find_event_field(struct trace_event_call *call, char *name);
1563 
1564 extern void trace_event_enable_cmd_record(bool enable);
1565 extern void trace_event_enable_tgid_record(bool enable);
1566 
1567 extern int event_trace_init(void);
1568 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1569 extern int event_trace_del_tracer(struct trace_array *tr);
1570 
1571 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1572 						  const char *system,
1573 						  const char *event);
1574 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1575 						const char *system,
1576 						const char *event);
1577 
1578 static inline void *event_file_data(struct file *filp)
1579 {
1580 	return READ_ONCE(file_inode(filp)->i_private);
1581 }
1582 
1583 extern struct mutex event_mutex;
1584 extern struct list_head ftrace_events;
1585 
1586 extern const struct file_operations event_trigger_fops;
1587 extern const struct file_operations event_hist_fops;
1588 
1589 #ifdef CONFIG_HIST_TRIGGERS
1590 extern int register_trigger_hist_cmd(void);
1591 extern int register_trigger_hist_enable_disable_cmds(void);
1592 #else
1593 static inline int register_trigger_hist_cmd(void) { return 0; }
1594 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1595 #endif
1596 
1597 extern int register_trigger_cmds(void);
1598 extern void clear_event_triggers(struct trace_array *tr);
1599 
1600 struct event_trigger_data {
1601 	unsigned long			count;
1602 	int				ref;
1603 	struct event_trigger_ops	*ops;
1604 	struct event_command		*cmd_ops;
1605 	struct event_filter __rcu	*filter;
1606 	char				*filter_str;
1607 	void				*private_data;
1608 	bool				paused;
1609 	bool				paused_tmp;
1610 	struct list_head		list;
1611 	char				*name;
1612 	struct list_head		named_list;
1613 	struct event_trigger_data	*named_data;
1614 };
1615 
1616 /* Avoid typos */
1617 #define ENABLE_EVENT_STR	"enable_event"
1618 #define DISABLE_EVENT_STR	"disable_event"
1619 #define ENABLE_HIST_STR		"enable_hist"
1620 #define DISABLE_HIST_STR	"disable_hist"
1621 
1622 struct enable_trigger_data {
1623 	struct trace_event_file		*file;
1624 	bool				enable;
1625 	bool				hist;
1626 };
1627 
1628 extern int event_enable_trigger_print(struct seq_file *m,
1629 				      struct event_trigger_ops *ops,
1630 				      struct event_trigger_data *data);
1631 extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1632 				      struct event_trigger_data *data);
1633 extern int event_enable_trigger_func(struct event_command *cmd_ops,
1634 				     struct trace_event_file *file,
1635 				     char *glob, char *cmd, char *param);
1636 extern int event_enable_register_trigger(char *glob,
1637 					 struct event_trigger_ops *ops,
1638 					 struct event_trigger_data *data,
1639 					 struct trace_event_file *file);
1640 extern void event_enable_unregister_trigger(char *glob,
1641 					    struct event_trigger_ops *ops,
1642 					    struct event_trigger_data *test,
1643 					    struct trace_event_file *file);
1644 extern void trigger_data_free(struct event_trigger_data *data);
1645 extern int event_trigger_init(struct event_trigger_ops *ops,
1646 			      struct event_trigger_data *data);
1647 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1648 					      int trigger_enable);
1649 extern void update_cond_flag(struct trace_event_file *file);
1650 extern int set_trigger_filter(char *filter_str,
1651 			      struct event_trigger_data *trigger_data,
1652 			      struct trace_event_file *file);
1653 extern struct event_trigger_data *find_named_trigger(const char *name);
1654 extern bool is_named_trigger(struct event_trigger_data *test);
1655 extern int save_named_trigger(const char *name,
1656 			      struct event_trigger_data *data);
1657 extern void del_named_trigger(struct event_trigger_data *data);
1658 extern void pause_named_trigger(struct event_trigger_data *data);
1659 extern void unpause_named_trigger(struct event_trigger_data *data);
1660 extern void set_named_trigger_data(struct event_trigger_data *data,
1661 				   struct event_trigger_data *named_data);
1662 extern struct event_trigger_data *
1663 get_named_trigger_data(struct event_trigger_data *data);
1664 extern int register_event_command(struct event_command *cmd);
1665 extern int unregister_event_command(struct event_command *cmd);
1666 extern int register_trigger_hist_enable_disable_cmds(void);
1667 
1668 /**
1669  * struct event_trigger_ops - callbacks for trace event triggers
1670  *
1671  * The methods in this structure provide per-event trigger hooks for
1672  * various trigger operations.
1673  *
1674  * All the methods below, except for @init() and @free(), must be
1675  * implemented.
1676  *
1677  * @func: The trigger 'probe' function called when the triggering
1678  *	event occurs.  The data passed into this callback is the data
1679  *	that was supplied to the event_command @reg() function that
1680  *	registered the trigger (see struct event_command) along with
1681  *	the trace record, rec.
1682  *
1683  * @init: An optional initialization function called for the trigger
1684  *	when the trigger is registered (via the event_command reg()
1685  *	function).  This can be used to perform per-trigger
1686  *	initialization such as incrementing a per-trigger reference
1687  *	count, for instance.  This is usually implemented by the
1688  *	generic utility function @event_trigger_init() (see
1689  *	trace_event_triggers.c).
1690  *
1691  * @free: An optional de-initialization function called for the
1692  *	trigger when the trigger is unregistered (via the
1693  *	event_command @reg() function).  This can be used to perform
1694  *	per-trigger de-initialization such as decrementing a
1695  *	per-trigger reference count and freeing corresponding trigger
1696  *	data, for instance.  This is usually implemented by the
1697  *	generic utility function @event_trigger_free() (see
1698  *	trace_event_triggers.c).
1699  *
1700  * @print: The callback function invoked to have the trigger print
1701  *	itself.  This is usually implemented by a wrapper function
1702  *	that calls the generic utility function @event_trigger_print()
1703  *	(see trace_event_triggers.c).
1704  */
1705 struct event_trigger_ops {
1706 	void			(*func)(struct event_trigger_data *data,
1707 					void *rec,
1708 					struct ring_buffer_event *rbe);
1709 	int			(*init)(struct event_trigger_ops *ops,
1710 					struct event_trigger_data *data);
1711 	void			(*free)(struct event_trigger_ops *ops,
1712 					struct event_trigger_data *data);
1713 	int			(*print)(struct seq_file *m,
1714 					 struct event_trigger_ops *ops,
1715 					 struct event_trigger_data *data);
1716 };
1717 
1718 /**
1719  * struct event_command - callbacks and data members for event commands
1720  *
1721  * Event commands are invoked by users by writing the command name
1722  * into the 'trigger' file associated with a trace event.  The
1723  * parameters associated with a specific invocation of an event
1724  * command are used to create an event trigger instance, which is
1725  * added to the list of trigger instances associated with that trace
1726  * event.  When the event is hit, the set of triggers associated with
1727  * that event is invoked.
1728  *
1729  * The data members in this structure provide per-event command data
1730  * for various event commands.
1731  *
1732  * All the data members below, except for @post_trigger, must be set
1733  * for each event command.
1734  *
1735  * @name: The unique name that identifies the event command.  This is
1736  *	the name used when setting triggers via trigger files.
1737  *
1738  * @trigger_type: A unique id that identifies the event command
1739  *	'type'.  This value has two purposes, the first to ensure that
1740  *	only one trigger of the same type can be set at a given time
1741  *	for a particular event e.g. it doesn't make sense to have both
1742  *	a traceon and traceoff trigger attached to a single event at
1743  *	the same time, so traceon and traceoff have the same type
1744  *	though they have different names.  The @trigger_type value is
1745  *	also used as a bit value for deferring the actual trigger
1746  *	action until after the current event is finished.  Some
1747  *	commands need to do this if they themselves log to the trace
1748  *	buffer (see the @post_trigger() member below).  @trigger_type
1749  *	values are defined by adding new values to the trigger_type
1750  *	enum in include/linux/trace_events.h.
1751  *
1752  * @flags: See the enum event_command_flags below.
1753  *
1754  * All the methods below, except for @set_filter() and @unreg_all(),
1755  * must be implemented.
1756  *
1757  * @func: The callback function responsible for parsing and
1758  *	registering the trigger written to the 'trigger' file by the
1759  *	user.  It allocates the trigger instance and registers it with
1760  *	the appropriate trace event.  It makes use of the other
1761  *	event_command callback functions to orchestrate this, and is
1762  *	usually implemented by the generic utility function
1763  *	@event_trigger_callback() (see trace_event_triggers.c).
1764  *
1765  * @reg: Adds the trigger to the list of triggers associated with the
1766  *	event, and enables the event trigger itself, after
1767  *	initializing it (via the event_trigger_ops @init() function).
1768  *	This is also where commands can use the @trigger_type value to
1769  *	make the decision as to whether or not multiple instances of
1770  *	the trigger should be allowed.  This is usually implemented by
1771  *	the generic utility function @register_trigger() (see
1772  *	trace_event_triggers.c).
1773  *
1774  * @unreg: Removes the trigger from the list of triggers associated
1775  *	with the event, and disables the event trigger itself, after
1776  *	initializing it (via the event_trigger_ops @free() function).
1777  *	This is usually implemented by the generic utility function
1778  *	@unregister_trigger() (see trace_event_triggers.c).
1779  *
1780  * @unreg_all: An optional function called to remove all the triggers
1781  *	from the list of triggers associated with the event.  Called
1782  *	when a trigger file is opened in truncate mode.
1783  *
1784  * @set_filter: An optional function called to parse and set a filter
1785  *	for the trigger.  If no @set_filter() method is set for the
1786  *	event command, filters set by the user for the command will be
1787  *	ignored.  This is usually implemented by the generic utility
1788  *	function @set_trigger_filter() (see trace_event_triggers.c).
1789  *
1790  * @get_trigger_ops: The callback function invoked to retrieve the
1791  *	event_trigger_ops implementation associated with the command.
1792  */
1793 struct event_command {
1794 	struct list_head	list;
1795 	char			*name;
1796 	enum event_trigger_type	trigger_type;
1797 	int			flags;
1798 	int			(*func)(struct event_command *cmd_ops,
1799 					struct trace_event_file *file,
1800 					char *glob, char *cmd, char *params);
1801 	int			(*reg)(char *glob,
1802 				       struct event_trigger_ops *ops,
1803 				       struct event_trigger_data *data,
1804 				       struct trace_event_file *file);
1805 	void			(*unreg)(char *glob,
1806 					 struct event_trigger_ops *ops,
1807 					 struct event_trigger_data *data,
1808 					 struct trace_event_file *file);
1809 	void			(*unreg_all)(struct trace_event_file *file);
1810 	int			(*set_filter)(char *filter_str,
1811 					      struct event_trigger_data *data,
1812 					      struct trace_event_file *file);
1813 	struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1814 };
1815 
1816 /**
1817  * enum event_command_flags - flags for struct event_command
1818  *
1819  * @POST_TRIGGER: A flag that says whether or not this command needs
1820  *	to have its action delayed until after the current event has
1821  *	been closed.  Some triggers need to avoid being invoked while
1822  *	an event is currently in the process of being logged, since
1823  *	the trigger may itself log data into the trace buffer.  Thus
1824  *	we make sure the current event is committed before invoking
1825  *	those triggers.  To do that, the trigger invocation is split
1826  *	in two - the first part checks the filter using the current
1827  *	trace record; if a command has the @post_trigger flag set, it
1828  *	sets a bit for itself in the return value, otherwise it
1829  *	directly invokes the trigger.  Once all commands have been
1830  *	either invoked or set their return flag, the current record is
1831  *	either committed or discarded.  At that point, if any commands
1832  *	have deferred their triggers, those commands are finally
1833  *	invoked following the close of the current event.  In other
1834  *	words, if the event_trigger_ops @func() probe implementation
1835  *	itself logs to the trace buffer, this flag should be set,
1836  *	otherwise it can be left unspecified.
1837  *
1838  * @NEEDS_REC: A flag that says whether or not this command needs
1839  *	access to the trace record in order to perform its function,
1840  *	regardless of whether or not it has a filter associated with
1841  *	it (filters make a trigger require access to the trace record
1842  *	but are not always present).
1843  */
1844 enum event_command_flags {
1845 	EVENT_CMD_FL_POST_TRIGGER	= 1,
1846 	EVENT_CMD_FL_NEEDS_REC		= 2,
1847 };
1848 
1849 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1850 {
1851 	return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1852 }
1853 
1854 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1855 {
1856 	return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1857 }
1858 
1859 extern int trace_event_enable_disable(struct trace_event_file *file,
1860 				      int enable, int soft_disable);
1861 extern int tracing_alloc_snapshot(void);
1862 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1863 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1864 
1865 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1866 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1867 
1868 extern const char *__start___trace_bprintk_fmt[];
1869 extern const char *__stop___trace_bprintk_fmt[];
1870 
1871 extern const char *__start___tracepoint_str[];
1872 extern const char *__stop___tracepoint_str[];
1873 
1874 void trace_printk_control(bool enabled);
1875 void trace_printk_init_buffers(void);
1876 void trace_printk_start_comm(void);
1877 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1878 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1879 
1880 #define MAX_EVENT_NAME_LEN	64
1881 
1882 extern int trace_run_command(const char *buf, int (*createfn)(int, char**));
1883 extern ssize_t trace_parse_run_command(struct file *file,
1884 		const char __user *buffer, size_t count, loff_t *ppos,
1885 		int (*createfn)(int, char**));
1886 
1887 /*
1888  * Normal trace_printk() and friends allocates special buffers
1889  * to do the manipulation, as well as saves the print formats
1890  * into sections to display. But the trace infrastructure wants
1891  * to use these without the added overhead at the price of being
1892  * a bit slower (used mainly for warnings, where we don't care
1893  * about performance). The internal_trace_puts() is for such
1894  * a purpose.
1895  */
1896 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1897 
1898 #undef FTRACE_ENTRY
1899 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)	\
1900 	extern struct trace_event_call					\
1901 	__aligned(4) event_##call;
1902 #undef FTRACE_ENTRY_DUP
1903 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter)	\
1904 	FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1905 		     filter)
1906 #undef FTRACE_ENTRY_PACKED
1907 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print, filter) \
1908 	FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1909 		     filter)
1910 
1911 #include "trace_entries.h"
1912 
1913 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1914 int perf_ftrace_event_register(struct trace_event_call *call,
1915 			       enum trace_reg type, void *data);
1916 #else
1917 #define perf_ftrace_event_register NULL
1918 #endif
1919 
1920 #ifdef CONFIG_FTRACE_SYSCALLS
1921 void init_ftrace_syscalls(void);
1922 const char *get_syscall_name(int syscall);
1923 #else
1924 static inline void init_ftrace_syscalls(void) { }
1925 static inline const char *get_syscall_name(int syscall)
1926 {
1927 	return NULL;
1928 }
1929 #endif
1930 
1931 #ifdef CONFIG_EVENT_TRACING
1932 void trace_event_init(void);
1933 void trace_event_eval_update(struct trace_eval_map **map, int len);
1934 #else
1935 static inline void __init trace_event_init(void) { }
1936 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1937 #endif
1938 
1939 #ifdef CONFIG_TRACER_SNAPSHOT
1940 void tracing_snapshot_instance(struct trace_array *tr);
1941 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1942 #else
1943 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
1944 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1945 {
1946 	return 0;
1947 }
1948 #endif
1949 
1950 #ifdef CONFIG_PREEMPT_TRACER
1951 void tracer_preempt_on(unsigned long a0, unsigned long a1);
1952 void tracer_preempt_off(unsigned long a0, unsigned long a1);
1953 #else
1954 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
1955 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
1956 #endif
1957 #ifdef CONFIG_IRQSOFF_TRACER
1958 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
1959 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
1960 #else
1961 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
1962 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
1963 #endif
1964 
1965 extern struct trace_iterator *tracepoint_print_iter;
1966 
1967 #endif /* _LINUX_KERNEL_TRACE_H */
1968