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