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