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