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