kernel/trace/trace.h

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