kernel/trace/trace.h

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