kernel/trace/trace.h

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