kernel/trace/trace.h

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