kernel/trace/trace.h

   1 #ifndef _LINUX_KERNEL_TRACE_H
   2 #define _LINUX_KERNEL_TRACE_H
   3
   4 #include <linux/fs.h>
   5 #include <linux/atomic.h>
   6 #include <linux/sched.h>
   7 #include <linux/clocksource.h>
   8 #include <linux/ring_buffer.h>
   9 #include <linux/mmiotrace.h>
  10 #include <linux/tracepoint.h>
  11 #include <linux/ftrace.h>
  12 #include <linux/hw_breakpoint.h>
  13 #include <linux/trace_seq.h>
  14 #include <linux/ftrace_event.h>
  15
  16 #ifdef CONFIG_FTRACE_SYSCALLS
  17 #include <asm/unistd.h>         /* For NR_SYSCALLS           */
  18 #include <asm/syscall.h>        /* some archs define it here */
  19 #endif
  20
  21 enum trace_type {
  22         __TRACE_FIRST_TYPE = 0,
  23
  24         TRACE_FN,
  25         TRACE_CTX,
  26         TRACE_WAKE,
  27         TRACE_STACK,
  28         TRACE_PRINT,
  29         TRACE_BPRINT,
  30         TRACE_MMIO_RW,
  31         TRACE_MMIO_MAP,
  32         TRACE_BRANCH,
  33         TRACE_GRAPH_RET,
  34         TRACE_GRAPH_ENT,
  35         TRACE_USER_STACK,
  36         TRACE_BLK,
  37
  38         __TRACE_LAST_TYPE,
  39 };
  40
  41
  42 #undef __field
  43 #define __field(type, item)             type    item;
  44
  45 #undef __field_struct
  46 #define __field_struct(type, item)      __field(type, item)
  47
  48 #undef __field_desc
  49 #define __field_desc(type, container, item)
  50
  51 #undef __array
  52 #define __array(type, item, size)       type    item[size];
  53
  54 #undef __array_desc
  55 #define __array_desc(type, container, item, size)
  56
  57 #undef __dynamic_array
  58 #define __dynamic_array(type, item)     type    item[];
  59
  60 #undef F_STRUCT
  61 #define F_STRUCT(args...)               args
  62
  63 #undef FTRACE_ENTRY
  64 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter)     \
  65         struct struct_name {                                            \
  66                 struct trace_entry      ent;                            \
  67                 tstruct                                                 \
  68         }
  69
  70 #undef TP_ARGS
  71 #define TP_ARGS(args...)        args
  72
  73 #undef FTRACE_ENTRY_DUP
  74 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
  75
  76 #undef FTRACE_ENTRY_REG
  77 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
  78                          filter, regfn) \
  79         FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
  80                      filter)
  81
  82 #include "trace_entries.h"
  83
  84 /*
  85  * syscalls are special, and need special handling, this is why
  86  * they are not included in trace_entries.h
  87  */
  88 struct syscall_trace_enter {
  89         struct trace_entry      ent;
  90         int                     nr;
  91         unsigned long           args[];
  92 };
  93
  94 struct syscall_trace_exit {
  95         struct trace_entry      ent;
  96         int                     nr;
  97         long                    ret;
  98 };
  99
 100 struct kprobe_trace_entry_head {
 101         struct trace_entry      ent;
 102         unsigned long           ip;
 103 };
 104
 105 struct kretprobe_trace_entry_head {
 106         struct trace_entry      ent;
 107         unsigned long           func;
 108         unsigned long           ret_ip;
 109 };
 110
 111 struct uprobe_trace_entry_head {
 112         struct trace_entry      ent;
 113         unsigned long           ip;
 114 };
 115
 116 /*
 117  * trace_flag_type is an enumeration that holds different
 118  * states when a trace occurs. These are:
 119  *  IRQS_OFF            - interrupts were disabled
 120  *  IRQS_NOSUPPORT      - arch does not support irqs_disabled_flags
 121  *  NEED_RESCHED        - reschedule is requested
 122  *  HARDIRQ             - inside an interrupt handler
 123  *  SOFTIRQ             - inside a softirq handler
 124  */
 125 enum trace_flag_type {
 126         TRACE_FLAG_IRQS_OFF             = 0x01,
 127         TRACE_FLAG_IRQS_NOSUPPORT       = 0x02,
 128         TRACE_FLAG_NEED_RESCHED         = 0x04,
 129         TRACE_FLAG_HARDIRQ              = 0x08,
 130         TRACE_FLAG_SOFTIRQ              = 0x10,
 131 };
 132
 133 #define TRACE_BUF_SIZE          1024
 134
 135 struct trace_array;
 136
 137 struct trace_cpu {
 138         struct trace_array      *tr;
 139         struct dentry           *dir;
 140         int                     cpu;
 141 };
 142
 143 /*
 144  * The CPU trace array - it consists of thousands of trace entries
 145  * plus some other descriptor data: (for example which task started
 146  * the trace, etc.)
 147  */
 148 struct trace_array_cpu {
 149         struct trace_cpu        trace_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         cycle_t                 preempt_timestamp;
 163         pid_t                   pid;
 164         kuid_t                  uid;
 165         char                    comm[TASK_COMM_LEN];
 166 };
 167
 168 struct tracer;
 169
 170 struct trace_buffer {
 171         struct trace_array              *tr;
 172         struct ring_buffer              *buffer;
 173         struct trace_array_cpu __percpu *data;
 174         cycle_t                         time_start;
 175         int                             cpu;
 176 };
 177
 178 /*
 179  * The trace array - an array of per-CPU trace arrays. This is the
 180  * highest level data structure that individual tracers deal with.
 181  * They have on/off state as well:
 182  */
 183 struct trace_array {
 184         struct list_head        list;
 185         char                    *name;
 186         struct trace_buffer     trace_buffer;
 187 #ifdef CONFIG_TRACER_MAX_TRACE
 188         /*
 189          * The max_buffer is used to snapshot the trace when a maximum
 190          * latency is reached, or when the user initiates a snapshot.
 191          * Some tracers will use this to store a maximum trace while
 192          * it continues examining live traces.
 193          *
 194          * The buffers for the max_buffer are set up the same as the trace_buffer
 195          * When a snapshot is taken, the buffer of the max_buffer is swapped
 196          * with the buffer of the trace_buffer and the buffers are reset for
 197          * the trace_buffer so the tracing can continue.
 198          */
 199         struct trace_buffer     max_buffer;
 200         bool                    allocated_snapshot;
 201 #endif
 202         int                     buffer_disabled;
 203         struct trace_cpu        trace_cpu;      /* place holder */
 204 #ifdef CONFIG_FTRACE_SYSCALLS
 205         int                     sys_refcount_enter;
 206         int                     sys_refcount_exit;
 207         DECLARE_BITMAP(enabled_enter_syscalls, NR_syscalls);
 208         DECLARE_BITMAP(enabled_exit_syscalls, NR_syscalls);
 209 #endif
 210         int                     stop_count;
 211         int                     clock_id;
 212         struct tracer           *current_trace;
 213         unsigned int            flags;
 214         raw_spinlock_t          start_lock;
 215         struct dentry           *dir;
 216         struct dentry           *options;
 217         struct dentry           *percpu_dir;
 218         struct dentry           *event_dir;
 219         struct list_head        systems;
 220         struct list_head        events;
 221         struct task_struct      *waiter;
 222 };
 223
 224 enum {
 225         TRACE_ARRAY_FL_GLOBAL   = (1 << 0)
 226 };
 227
 228 extern struct list_head ftrace_trace_arrays;
 229
 230 /*
 231  * The global tracer (top) should be the first trace array added,
 232  * but we check the flag anyway.
 233  */
 234 static inline struct trace_array *top_trace_array(void)
 235 {
 236         struct trace_array *tr;
 237
 238         tr = list_entry(ftrace_trace_arrays.prev,
 239                         typeof(*tr), list);
 240         WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
 241         return tr;
 242 }
 243
 244 #define FTRACE_CMP_TYPE(var, type) \
 245         __builtin_types_compatible_p(typeof(var), type *)
 246
 247 #undef IF_ASSIGN
 248 #define IF_ASSIGN(var, entry, etype, id)                \
 249         if (FTRACE_CMP_TYPE(var, etype)) {              \
 250                 var = (typeof(var))(entry);             \
 251                 WARN_ON(id && (entry)->type != id);     \
 252                 break;                                  \
 253         }
 254
 255 /* Will cause compile errors if type is not found. */
 256 extern void __ftrace_bad_type(void);
 257
 258 /*
 259  * The trace_assign_type is a verifier that the entry type is
 260  * the same as the type being assigned. To add new types simply
 261  * add a line with the following format:
 262  *
 263  * IF_ASSIGN(var, ent, type, id);
 264  *
 265  *  Where "type" is the trace type that includes the trace_entry
 266  *  as the "ent" item. And "id" is the trace identifier that is
 267  *  used in the trace_type enum.
 268  *
 269  *  If the type can have more than one id, then use zero.
 270  */
 271 #define trace_assign_type(var, ent)                                     \
 272         do {                                                            \
 273                 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);     \
 274                 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);        \
 275                 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);   \
 276                 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
 277                 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);   \
 278                 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
 279                 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,          \
 280                           TRACE_MMIO_RW);                               \
 281                 IF_ASSIGN(var, ent, struct trace_mmiotrace_map,         \
 282                           TRACE_MMIO_MAP);                              \
 283                 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
 284                 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,      \
 285                           TRACE_GRAPH_ENT);             \
 286                 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,      \
 287                           TRACE_GRAPH_RET);             \
 288                 __ftrace_bad_type();                                    \
 289         } while (0)
 290
 291 /*
 292  * An option specific to a tracer. This is a boolean value.
 293  * The bit is the bit index that sets its value on the
 294  * flags value in struct tracer_flags.
 295  */
 296 struct tracer_opt {
 297         const char      *name; /* Will appear on the trace_options file */
 298         u32             bit; /* Mask assigned in val field in tracer_flags */
 299 };
 300
 301 /*
 302  * The set of specific options for a tracer. Your tracer
 303  * have to set the initial value of the flags val.
 304  */
 305 struct tracer_flags {
 306         u32                     val;
 307         struct tracer_opt       *opts;
 308 };
 309
 310 /* Makes more easy to define a tracer opt */
 311 #define TRACER_OPT(s, b)        .name = #s, .bit = b
 312
 313
 314 /**
 315  * struct tracer - a specific tracer and its callbacks to interact with debugfs
 316  * @name: the name chosen to select it on the available_tracers file
 317  * @init: called when one switches to this tracer (echo name > current_tracer)
 318  * @reset: called when one switches to another tracer
 319  * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
 320  * @stop: called when tracing is paused (echo 0 > tracing_enabled)
 321  * @open: called when the trace file is opened
 322  * @pipe_open: called when the trace_pipe file is opened
 323  * @wait_pipe: override how the user waits for traces on trace_pipe
 324  * @close: called when the trace file is released
 325  * @pipe_close: called when the trace_pipe file is released
 326  * @read: override the default read callback on trace_pipe
 327  * @splice_read: override the default splice_read callback on trace_pipe
 328  * @selftest: selftest to run on boot (see trace_selftest.c)
 329  * @print_headers: override the first lines that describe your columns
 330  * @print_line: callback that prints a trace
 331  * @set_flag: signals one of your private flags changed (trace_options file)
 332  * @flags: your private flags
 333  */
 334 struct tracer {
 335         const char              *name;
 336         int                     (*init)(struct trace_array *tr);
 337         void                    (*reset)(struct trace_array *tr);
 338         void                    (*start)(struct trace_array *tr);
 339         void                    (*stop)(struct trace_array *tr);
 340         void                    (*open)(struct trace_iterator *iter);
 341         void                    (*pipe_open)(struct trace_iterator *iter);
 342         void                    (*wait_pipe)(struct trace_iterator *iter);
 343         void                    (*close)(struct trace_iterator *iter);
 344         void                    (*pipe_close)(struct trace_iterator *iter);
 345         ssize_t                 (*read)(struct trace_iterator *iter,
 346                                         struct file *filp, char __user *ubuf,
 347                                         size_t cnt, loff_t *ppos);
 348         ssize_t                 (*splice_read)(struct trace_iterator *iter,
 349                                                struct file *filp,
 350                                                loff_t *ppos,
 351                                                struct pipe_inode_info *pipe,
 352                                                size_t len,
 353                                                unsigned int flags);
 354 #ifdef CONFIG_FTRACE_STARTUP_TEST
 355         int                     (*selftest)(struct tracer *trace,
 356                                             struct trace_array *tr);
 357 #endif
 358         void                    (*print_header)(struct seq_file *m);
 359         enum print_line_t       (*print_line)(struct trace_iterator *iter);
 360         /* If you handled the flag setting, return 0 */
 361         int                     (*set_flag)(u32 old_flags, u32 bit, int set);
 362         /* Return 0 if OK with change, else return non-zero */
 363         int                     (*flag_changed)(struct tracer *tracer,
 364                                                 u32 mask, int set);
 365         struct tracer           *next;
 366         struct tracer_flags     *flags;
 367         bool                    print_max;
 368         bool                    enabled;
 369 #ifdef CONFIG_TRACER_MAX_TRACE
 370         bool                    use_max_tr;
 371 #endif
 372 };
 373
 374
 375 /* Only current can touch trace_recursion */
 376
 377 /*
 378  * For function tracing recursion:
 379  *  The order of these bits are important.
 380  *
 381  *  When function tracing occurs, the following steps are made:
 382  *   If arch does not support a ftrace feature:
 383  *    call internal function (uses INTERNAL bits) which calls...
 384  *   If callback is registered to the "global" list, the list
 385  *    function is called and recursion checks the GLOBAL bits.
 386  *    then this function calls...
 387  *   The function callback, which can use the FTRACE bits to
 388  *    check for recursion.
 389  *
 390  * Now if the arch does not suppport a feature, and it calls
 391  * the global list function which calls the ftrace callback
 392  * all three of these steps will do a recursion protection.
 393  * There's no reason to do one if the previous caller already
 394  * did. The recursion that we are protecting against will
 395  * go through the same steps again.
 396  *
 397  * To prevent the multiple recursion checks, if a recursion
 398  * bit is set that is higher than the MAX bit of the current
 399  * check, then we know that the check was made by the previous
 400  * caller, and we can skip the current check.
 401  */
 402 enum {
 403         TRACE_BUFFER_BIT,
 404         TRACE_BUFFER_NMI_BIT,
 405         TRACE_BUFFER_IRQ_BIT,
 406         TRACE_BUFFER_SIRQ_BIT,
 407
 408         /* Start of function recursion bits */
 409         TRACE_FTRACE_BIT,
 410         TRACE_FTRACE_NMI_BIT,
 411         TRACE_FTRACE_IRQ_BIT,
 412         TRACE_FTRACE_SIRQ_BIT,
 413
 414         /* GLOBAL_BITs must be greater than FTRACE_BITs */
 415         TRACE_GLOBAL_BIT,
 416         TRACE_GLOBAL_NMI_BIT,
 417         TRACE_GLOBAL_IRQ_BIT,
 418         TRACE_GLOBAL_SIRQ_BIT,
 419
 420         /* INTERNAL_BITs must be greater than GLOBAL_BITs */
 421         TRACE_INTERNAL_BIT,
 422         TRACE_INTERNAL_NMI_BIT,
 423         TRACE_INTERNAL_IRQ_BIT,
 424         TRACE_INTERNAL_SIRQ_BIT,
 425
 426         TRACE_CONTROL_BIT,
 427
 428 /*
 429  * Abuse of the trace_recursion.
 430  * As we need a way to maintain state if we are tracing the function
 431  * graph in irq because we want to trace a particular function that
 432  * was called in irq context but we have irq tracing off. Since this
 433  * can only be modified by current, we can reuse trace_recursion.
 434  */
 435         TRACE_IRQ_BIT,
 436 };
 437
 438 #define trace_recursion_set(bit)        do { (current)->trace_recursion |= (1<<(bit)); } while (0)
 439 #define trace_recursion_clear(bit)      do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
 440 #define trace_recursion_test(bit)       ((current)->trace_recursion & (1<<(bit)))
 441
 442 #define TRACE_CONTEXT_BITS      4
 443
 444 #define TRACE_FTRACE_START      TRACE_FTRACE_BIT
 445 #define TRACE_FTRACE_MAX        ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
 446
 447 #define TRACE_GLOBAL_START      TRACE_GLOBAL_BIT
 448 #define TRACE_GLOBAL_MAX        ((1 << (TRACE_GLOBAL_START + TRACE_CONTEXT_BITS)) - 1)
 449
 450 #define TRACE_LIST_START        TRACE_INTERNAL_BIT
 451 #define TRACE_LIST_MAX          ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
 452
 453 #define TRACE_CONTEXT_MASK      TRACE_LIST_MAX
 454
 455 static __always_inline int trace_get_context_bit(void)
 456 {
 457         int bit;
 458
 459         if (in_interrupt()) {
 460                 if (in_nmi())
 461                         bit = 0;
 462
 463                 else if (in_irq())
 464                         bit = 1;
 465                 else
 466                         bit = 2;
 467         } else
 468                 bit = 3;
 469
 470         return bit;
 471 }
 472
 473 static __always_inline int trace_test_and_set_recursion(int start, int max)
 474 {
 475         unsigned int val = current->trace_recursion;
 476         int bit;
 477
 478         /* A previous recursion check was made */
 479         if ((val & TRACE_CONTEXT_MASK) > max)
 480                 return 0;
 481
 482         bit = trace_get_context_bit() + start;
 483         if (unlikely(val & (1 << bit)))
 484                 return -1;
 485
 486         val |= 1 << bit;
 487         current->trace_recursion = val;
 488         barrier();
 489
 490         return bit;
 491 }
 492
 493 static __always_inline void trace_clear_recursion(int bit)
 494 {
 495         unsigned int val = current->trace_recursion;
 496
 497         if (!bit)
 498                 return;
 499
 500         bit = 1 << bit;
 501         val &= ~bit;
 502
 503         barrier();
 504         current->trace_recursion = val;
 505 }
 506
 507 static inline struct ring_buffer_iter *
 508 trace_buffer_iter(struct trace_iterator *iter, int cpu)
 509 {
 510         if (iter->buffer_iter && iter->buffer_iter[cpu])
 511                 return iter->buffer_iter[cpu];
 512         return NULL;
 513 }
 514
 515 int tracer_init(struct tracer *t, struct trace_array *tr);
 516 int tracing_is_enabled(void);
 517 void tracing_reset(struct trace_buffer *buf, int cpu);
 518 void tracing_reset_online_cpus(struct trace_buffer *buf);
 519 void tracing_reset_current(int cpu);
 520 void tracing_reset_all_online_cpus(void);
 521 int tracing_open_generic(struct inode *inode, struct file *filp);
 522 struct dentry *trace_create_file(const char *name,
 523                                  umode_t mode,
 524                                  struct dentry *parent,
 525                                  void *data,
 526                                  const struct file_operations *fops);
 527
 528 struct dentry *tracing_init_dentry_tr(struct trace_array *tr);
 529 struct dentry *tracing_init_dentry(void);
 530
 531 struct ring_buffer_event;
 532
 533 struct ring_buffer_event *
 534 trace_buffer_lock_reserve(struct ring_buffer *buffer,
 535                           int type,
 536                           unsigned long len,
 537                           unsigned long flags,
 538                           int pc);
 539
 540 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
 541                                                 struct trace_array_cpu *data);
 542
 543 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
 544                                           int *ent_cpu, u64 *ent_ts);
 545
 546 void __buffer_unlock_commit(struct ring_buffer *buffer,
 547                             struct ring_buffer_event *event);
 548
 549 int trace_empty(struct trace_iterator *iter);
 550
 551 void *trace_find_next_entry_inc(struct trace_iterator *iter);
 552
 553 void trace_init_global_iter(struct trace_iterator *iter);
 554
 555 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
 556
 557 void poll_wait_pipe(struct trace_iterator *iter);
 558
 559 void ftrace(struct trace_array *tr,
 560                             struct trace_array_cpu *data,
 561                             unsigned long ip,
 562                             unsigned long parent_ip,
 563                             unsigned long flags, int pc);
 564 void tracing_sched_switch_trace(struct trace_array *tr,
 565                                 struct task_struct *prev,
 566                                 struct task_struct *next,
 567                                 unsigned long flags, int pc);
 568
 569 void tracing_sched_wakeup_trace(struct trace_array *tr,
 570                                 struct task_struct *wakee,
 571                                 struct task_struct *cur,
 572                                 unsigned long flags, int pc);
 573 void trace_function(struct trace_array *tr,
 574                     unsigned long ip,
 575                     unsigned long parent_ip,
 576                     unsigned long flags, int pc);
 577 void trace_graph_function(struct trace_array *tr,
 578                     unsigned long ip,
 579                     unsigned long parent_ip,
 580                     unsigned long flags, int pc);
 581 void trace_latency_header(struct seq_file *m);
 582 void trace_default_header(struct seq_file *m);
 583 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
 584 int trace_empty(struct trace_iterator *iter);
 585
 586 void trace_graph_return(struct ftrace_graph_ret *trace);
 587 int trace_graph_entry(struct ftrace_graph_ent *trace);
 588 void set_graph_array(struct trace_array *tr);
 589
 590 void tracing_start_cmdline_record(void);
 591 void tracing_stop_cmdline_record(void);
 592 void tracing_sched_switch_assign_trace(struct trace_array *tr);
 593 void tracing_stop_sched_switch_record(void);
 594 void tracing_start_sched_switch_record(void);
 595 int register_tracer(struct tracer *type);
 596 int is_tracing_stopped(void);
 597
 598 extern cpumask_var_t __read_mostly tracing_buffer_mask;
 599
 600 #define for_each_tracing_cpu(cpu)       \
 601         for_each_cpu(cpu, tracing_buffer_mask)
 602
 603 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
 604
 605 extern unsigned long tracing_thresh;
 606
 607 #ifdef CONFIG_TRACER_MAX_TRACE
 608 extern unsigned long tracing_max_latency;
 609
 610 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
 611 void update_max_tr_single(struct trace_array *tr,
 612                           struct task_struct *tsk, int cpu);
 613 #endif /* CONFIG_TRACER_MAX_TRACE */
 614
 615 #ifdef CONFIG_STACKTRACE
 616 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
 617                         int skip, int pc);
 618
 619 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
 620                              int skip, int pc, struct pt_regs *regs);
 621
 622 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
 623                             int pc);
 624
 625 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
 626                    int pc);
 627 #else
 628 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
 629                                       unsigned long flags, int skip, int pc)
 630 {
 631 }
 632
 633 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
 634                                            unsigned long flags, int skip,
 635                                            int pc, struct pt_regs *regs)
 636 {
 637 }
 638
 639 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
 640                                           unsigned long flags, int pc)
 641 {
 642 }
 643
 644 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
 645                                  int skip, int pc)
 646 {
 647 }
 648 #endif /* CONFIG_STACKTRACE */
 649
 650 extern cycle_t ftrace_now(int cpu);
 651
 652 extern void trace_find_cmdline(int pid, char comm[]);
 653
 654 #ifdef CONFIG_DYNAMIC_FTRACE
 655 extern unsigned long ftrace_update_tot_cnt;
 656 #endif
 657 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
 658 extern int DYN_FTRACE_TEST_NAME(void);
 659 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
 660 extern int DYN_FTRACE_TEST_NAME2(void);
 661
 662 extern int ring_buffer_expanded;
 663 extern bool tracing_selftest_disabled;
 664 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
 665
 666 #ifdef CONFIG_FTRACE_STARTUP_TEST
 667 extern int trace_selftest_startup_function(struct tracer *trace,
 668                                            struct trace_array *tr);
 669 extern int trace_selftest_startup_function_graph(struct tracer *trace,
 670                                                  struct trace_array *tr);
 671 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
 672                                           struct trace_array *tr);
 673 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
 674                                              struct trace_array *tr);
 675 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
 676                                                  struct trace_array *tr);
 677 extern int trace_selftest_startup_wakeup(struct tracer *trace,
 678                                          struct trace_array *tr);
 679 extern int trace_selftest_startup_nop(struct tracer *trace,
 680                                          struct trace_array *tr);
 681 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
 682                                                struct trace_array *tr);
 683 extern int trace_selftest_startup_branch(struct tracer *trace,
 684                                          struct trace_array *tr);
 685 #endif /* CONFIG_FTRACE_STARTUP_TEST */
 686
 687 extern void *head_page(struct trace_array_cpu *data);
 688 extern unsigned long long ns2usecs(cycle_t nsec);
 689 extern int
 690 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
 691 extern int
 692 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
 693 extern int
 694 trace_array_vprintk(struct trace_array *tr,
 695                     unsigned long ip, const char *fmt, va_list args);
 696 int trace_array_printk(struct trace_array *tr,
 697                        unsigned long ip, const char *fmt, ...);
 698 int trace_array_printk_buf(struct ring_buffer *buffer,
 699                            unsigned long ip, const char *fmt, ...);
 700 void trace_printk_seq(struct trace_seq *s);
 701 enum print_line_t print_trace_line(struct trace_iterator *iter);
 702
 703 extern unsigned long trace_flags;
 704
 705 extern int trace_clock_id;
 706
 707 /* Standard output formatting function used for function return traces */
 708 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 709
 710 /* Flag options */
 711 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
 712 #define TRACE_GRAPH_PRINT_CPU           0x2
 713 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
 714 #define TRACE_GRAPH_PRINT_PROC          0x8
 715 #define TRACE_GRAPH_PRINT_DURATION      0x10
 716 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
 717
 718 extern enum print_line_t
 719 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
 720 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
 721 extern enum print_line_t
 722 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
 723 extern void graph_trace_open(struct trace_iterator *iter);
 724 extern void graph_trace_close(struct trace_iterator *iter);
 725 extern int __trace_graph_entry(struct trace_array *tr,
 726                                struct ftrace_graph_ent *trace,
 727                                unsigned long flags, int pc);
 728 extern void __trace_graph_return(struct trace_array *tr,
 729                                  struct ftrace_graph_ret *trace,
 730                                  unsigned long flags, int pc);
 731
 732
 733 #ifdef CONFIG_DYNAMIC_FTRACE
 734 /* TODO: make this variable */
 735 #define FTRACE_GRAPH_MAX_FUNCS          32
 736 extern int ftrace_graph_filter_enabled;
 737 extern int ftrace_graph_count;
 738 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
 739
 740 static inline int ftrace_graph_addr(unsigned long addr)
 741 {
 742         int i;
 743
 744         if (!ftrace_graph_filter_enabled)
 745                 return 1;
 746
 747         for (i = 0; i < ftrace_graph_count; i++) {
 748                 if (addr == ftrace_graph_funcs[i]) {
 749                         /*
 750                          * If no irqs are to be traced, but a set_graph_function
 751                          * is set, and called by an interrupt handler, we still
 752                          * want to trace it.
 753                          */
 754                         if (in_irq())
 755                                 trace_recursion_set(TRACE_IRQ_BIT);
 756                         else
 757                                 trace_recursion_clear(TRACE_IRQ_BIT);
 758                         return 1;
 759                 }
 760         }
 761
 762         return 0;
 763 }
 764 #else
 765 static inline int ftrace_graph_addr(unsigned long addr)
 766 {
 767         return 1;
 768 }
 769 #endif /* CONFIG_DYNAMIC_FTRACE */
 770 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
 771 static inline enum print_line_t
 772 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
 773 {
 774         return TRACE_TYPE_UNHANDLED;
 775 }
 776 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
 777
 778 extern struct list_head ftrace_pids;
 779
 780 #ifdef CONFIG_FUNCTION_TRACER
 781 static inline int ftrace_trace_task(struct task_struct *task)
 782 {
 783         if (list_empty(&ftrace_pids))
 784                 return 1;
 785
 786         return test_tsk_trace_trace(task);
 787 }
 788 extern int ftrace_is_dead(void);
 789 #else
 790 static inline int ftrace_trace_task(struct task_struct *task)
 791 {
 792         return 1;
 793 }
 794 static inline int ftrace_is_dead(void) { return 0; }
 795 #endif
 796
 797 int ftrace_event_is_function(struct ftrace_event_call *call);
 798
 799 /*
 800  * struct trace_parser - servers for reading the user input separated by spaces
 801  * @cont: set if the input is not complete - no final space char was found
 802  * @buffer: holds the parsed user input
 803  * @idx: user input length
 804  * @size: buffer size
 805  */
 806 struct trace_parser {
 807         bool            cont;
 808         char            *buffer;
 809         unsigned        idx;
 810         unsigned        size;
 811 };
 812
 813 static inline bool trace_parser_loaded(struct trace_parser *parser)
 814 {
 815         return (parser->idx != 0);
 816 }
 817
 818 static inline bool trace_parser_cont(struct trace_parser *parser)
 819 {
 820         return parser->cont;
 821 }
 822
 823 static inline void trace_parser_clear(struct trace_parser *parser)
 824 {
 825         parser->cont = false;
 826         parser->idx = 0;
 827 }
 828
 829 extern int trace_parser_get_init(struct trace_parser *parser, int size);
 830 extern void trace_parser_put(struct trace_parser *parser);
 831 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
 832         size_t cnt, loff_t *ppos);
 833
 834 /*
 835  * trace_iterator_flags is an enumeration that defines bit
 836  * positions into trace_flags that controls the output.
 837  *
 838  * NOTE: These bits must match the trace_options array in
 839  *       trace.c.
 840  */
 841 enum trace_iterator_flags {
 842         TRACE_ITER_PRINT_PARENT         = 0x01,
 843         TRACE_ITER_SYM_OFFSET           = 0x02,
 844         TRACE_ITER_SYM_ADDR             = 0x04,
 845         TRACE_ITER_VERBOSE              = 0x08,
 846         TRACE_ITER_RAW                  = 0x10,
 847         TRACE_ITER_HEX                  = 0x20,
 848         TRACE_ITER_BIN                  = 0x40,
 849         TRACE_ITER_BLOCK                = 0x80,
 850         TRACE_ITER_STACKTRACE           = 0x100,
 851         TRACE_ITER_PRINTK               = 0x200,
 852         TRACE_ITER_PREEMPTONLY          = 0x400,
 853         TRACE_ITER_BRANCH               = 0x800,
 854         TRACE_ITER_ANNOTATE             = 0x1000,
 855         TRACE_ITER_USERSTACKTRACE       = 0x2000,
 856         TRACE_ITER_SYM_USEROBJ          = 0x4000,
 857         TRACE_ITER_PRINTK_MSGONLY       = 0x8000,
 858         TRACE_ITER_CONTEXT_INFO         = 0x10000, /* Print pid/cpu/time */
 859         TRACE_ITER_LATENCY_FMT          = 0x20000,
 860         TRACE_ITER_SLEEP_TIME           = 0x40000,
 861         TRACE_ITER_GRAPH_TIME           = 0x80000,
 862         TRACE_ITER_RECORD_CMD           = 0x100000,
 863         TRACE_ITER_OVERWRITE            = 0x200000,
 864         TRACE_ITER_STOP_ON_FREE         = 0x400000,
 865         TRACE_ITER_IRQ_INFO             = 0x800000,
 866         TRACE_ITER_MARKERS              = 0x1000000,
 867 };
 868
 869 /*
 870  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
 871  * control the output of kernel symbols.
 872  */
 873 #define TRACE_ITER_SYM_MASK \
 874         (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
 875
 876 extern struct tracer nop_trace;
 877
 878 #ifdef CONFIG_BRANCH_TRACER
 879 extern int enable_branch_tracing(struct trace_array *tr);
 880 extern void disable_branch_tracing(void);
 881 static inline int trace_branch_enable(struct trace_array *tr)
 882 {
 883         if (trace_flags & TRACE_ITER_BRANCH)
 884                 return enable_branch_tracing(tr);
 885         return 0;
 886 }
 887 static inline void trace_branch_disable(void)
 888 {
 889         /* due to races, always disable */
 890         disable_branch_tracing();
 891 }
 892 #else
 893 static inline int trace_branch_enable(struct trace_array *tr)
 894 {
 895         return 0;
 896 }
 897 static inline void trace_branch_disable(void)
 898 {
 899 }
 900 #endif /* CONFIG_BRANCH_TRACER */
 901
 902 /* set ring buffers to default size if not already done so */
 903 int tracing_update_buffers(void);
 904
 905 /* trace event type bit fields, not numeric */
 906 enum {
 907         TRACE_EVENT_TYPE_PRINTF         = 1,
 908         TRACE_EVENT_TYPE_RAW            = 2,
 909 };
 910
 911 struct ftrace_event_field {
 912         struct list_head        link;
 913         const char              *name;
 914         const char              *type;
 915         int                     filter_type;
 916         int                     offset;
 917         int                     size;
 918         int                     is_signed;
 919 };
 920
 921 struct event_filter {
 922         int                     n_preds;        /* Number assigned */
 923         int                     a_preds;        /* allocated */
 924         struct filter_pred      *preds;
 925         struct filter_pred      *root;
 926         char                    *filter_string;
 927 };
 928
 929 struct event_subsystem {
 930         struct list_head        list;
 931         const char              *name;
 932         struct event_filter     *filter;
 933         int                     ref_count;
 934 };
 935
 936 struct ftrace_subsystem_dir {
 937         struct list_head                list;
 938         struct event_subsystem          *subsystem;
 939         struct trace_array              *tr;
 940         struct dentry                   *entry;
 941         int                             ref_count;
 942         int                             nr_events;
 943 };
 944
 945 #define FILTER_PRED_INVALID     ((unsigned short)-1)
 946 #define FILTER_PRED_IS_RIGHT    (1 << 15)
 947 #define FILTER_PRED_FOLD        (1 << 15)
 948
 949 /*
 950  * The max preds is the size of unsigned short with
 951  * two flags at the MSBs. One bit is used for both the IS_RIGHT
 952  * and FOLD flags. The other is reserved.
 953  *
 954  * 2^14 preds is way more than enough.
 955  */
 956 #define MAX_FILTER_PRED         16384
 957
 958 struct filter_pred;
 959 struct regex;
 960
 961 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
 962
 963 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
 964
 965 enum regex_type {
 966         MATCH_FULL = 0,
 967         MATCH_FRONT_ONLY,
 968         MATCH_MIDDLE_ONLY,
 969         MATCH_END_ONLY,
 970 };
 971
 972 struct regex {
 973         char                    pattern[MAX_FILTER_STR_VAL];
 974         int                     len;
 975         int                     field_len;
 976         regex_match_func        match;
 977 };
 978
 979 struct filter_pred {
 980         filter_pred_fn_t        fn;
 981         u64                     val;
 982         struct regex            regex;
 983         unsigned short          *ops;
 984         struct ftrace_event_field *field;
 985         int                     offset;
 986         int                     not;
 987         int                     op;
 988         unsigned short          index;
 989         unsigned short          parent;
 990         unsigned short          left;
 991         unsigned short          right;
 992 };
 993
 994 extern struct list_head ftrace_common_fields;
 995
 996 extern enum regex_type
 997 filter_parse_regex(char *buff, int len, char **search, int *not);
 998 extern void print_event_filter(struct ftrace_event_call *call,
 999                                struct trace_seq *s);
1000 extern int apply_event_filter(struct ftrace_event_call *call,
1001                               char *filter_string);
1002 extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir *dir,
1003                                         char *filter_string);
1004 extern void print_subsystem_event_filter(struct event_subsystem *system,
1005                                          struct trace_seq *s);
1006 extern int filter_assign_type(const char *type);
1007
1008 struct list_head *
1009 trace_get_fields(struct ftrace_event_call *event_call);
1010
1011 static inline int
1012 filter_check_discard(struct ftrace_event_call *call, void *rec,
1013                      struct ring_buffer *buffer,
1014                      struct ring_buffer_event *event)
1015 {
1016         if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
1017             !filter_match_preds(call->filter, rec)) {
1018                 ring_buffer_discard_commit(buffer, event);
1019                 return 1;
1020         }
1021
1022         return 0;
1023 }
1024
1025 extern void trace_event_enable_cmd_record(bool enable);
1026 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1027 extern int event_trace_del_tracer(struct trace_array *tr);
1028
1029 extern struct mutex event_mutex;
1030 extern struct list_head ftrace_events;
1031
1032 extern const char *__start___trace_bprintk_fmt[];
1033 extern const char *__stop___trace_bprintk_fmt[];
1034
1035 void trace_printk_init_buffers(void);
1036 void trace_printk_start_comm(void);
1037 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1038 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1039
1040 #undef FTRACE_ENTRY
1041 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)     \
1042         extern struct ftrace_event_call                                 \
1043         __attribute__((__aligned__(4))) event_##call;
1044 #undef FTRACE_ENTRY_DUP
1045 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1046         FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1047                      filter)
1048 #include "trace_entries.h"
1049
1050 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1051 int perf_ftrace_event_register(struct ftrace_event_call *call,
1052                                enum trace_reg type, void *data);
1053 #else
1054 #define perf_ftrace_event_register NULL
1055 #endif
1056
1057 #endif /* _LINUX_KERNEL_TRACE_H */