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