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