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