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