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