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