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         int                     ref;
 223 };
 224
 225 enum {
 226         TRACE_ARRAY_FL_GLOBAL   = (1 << 0)
 227 };
 228
 229 extern struct list_head ftrace_trace_arrays;
 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 trace_mmiotrace_rw,          \
 281                           TRACE_MMIO_RW);                               \
 282                 IF_ASSIGN(var, ent, struct trace_mmiotrace_map,         \
 283                           TRACE_MMIO_MAP);                              \
 284                 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
 285                 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,      \
 286                           TRACE_GRAPH_ENT);             \
 287                 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,      \
 288                           TRACE_GRAPH_RET);             \
 289                 __ftrace_bad_type();                                    \
 290         } while (0)
 291
 292 /*
 293  * An option specific to a tracer. This is a boolean value.
 294  * The bit is the bit index that sets its value on the
 295  * flags value in struct tracer_flags.
 296  */
 297 struct tracer_opt {
 298         const char      *name; /* Will appear on the trace_options file */
 299         u32             bit; /* Mask assigned in val field in tracer_flags */
 300 };
 301
 302 /*
 303  * The set of specific options for a tracer. Your tracer
 304  * have to set the initial value of the flags val.
 305  */
 306 struct tracer_flags {
 307         u32                     val;
 308         struct tracer_opt       *opts;
 309 };
 310
 311 /* Makes more easy to define a tracer opt */
 312 #define TRACER_OPT(s, b)        .name = #s, .bit = b
 313
 314
 315 /**
 316  * struct tracer - a specific tracer and its callbacks to interact with debugfs
 317  * @name: the name chosen to select it on the available_tracers file
 318  * @init: called when one switches to this tracer (echo name > current_tracer)
 319  * @reset: called when one switches to another tracer
 320  * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
 321  * @stop: called when tracing is paused (echo 0 > tracing_enabled)
 322  * @open: called when the trace file is opened
 323  * @pipe_open: called when the trace_pipe file is opened
 324  * @wait_pipe: override how the user waits for traces on trace_pipe
 325  * @close: called when the trace file is released
 326  * @pipe_close: called when the trace_pipe file is released
 327  * @read: override the default read callback on trace_pipe
 328  * @splice_read: override the default splice_read callback on trace_pipe
 329  * @selftest: selftest to run on boot (see trace_selftest.c)
 330  * @print_headers: override the first lines that describe your columns
 331  * @print_line: callback that prints a trace
 332  * @set_flag: signals one of your private flags changed (trace_options file)
 333  * @flags: your private flags
 334  */
 335 struct tracer {
 336         const char              *name;
 337         int                     (*init)(struct trace_array *tr);
 338         void                    (*reset)(struct trace_array *tr);
 339         void                    (*start)(struct trace_array *tr);
 340         void                    (*stop)(struct trace_array *tr);
 341         void                    (*open)(struct trace_iterator *iter);
 342         void                    (*pipe_open)(struct trace_iterator *iter);
 343         void                    (*wait_pipe)(struct trace_iterator *iter);
 344         void                    (*close)(struct trace_iterator *iter);
 345         void                    (*pipe_close)(struct trace_iterator *iter);
 346         ssize_t                 (*read)(struct trace_iterator *iter,
 347                                         struct file *filp, char __user *ubuf,
 348                                         size_t cnt, loff_t *ppos);
 349         ssize_t                 (*splice_read)(struct trace_iterator *iter,
 350                                                struct file *filp,
 351                                                loff_t *ppos,
 352                                                struct pipe_inode_info *pipe,
 353                                                size_t len,
 354                                                unsigned int flags);
 355 #ifdef CONFIG_FTRACE_STARTUP_TEST
 356         int                     (*selftest)(struct tracer *trace,
 357                                             struct trace_array *tr);
 358 #endif
 359         void                    (*print_header)(struct seq_file *m);
 360         enum print_line_t       (*print_line)(struct trace_iterator *iter);
 361         /* If you handled the flag setting, return 0 */
 362         int                     (*set_flag)(u32 old_flags, u32 bit, int set);
 363         /* Return 0 if OK with change, else return non-zero */
 364         int                     (*flag_changed)(struct tracer *tracer,
 365                                                 u32 mask, int set);
 366         struct tracer           *next;
 367         struct tracer_flags     *flags;
 368         bool                    print_max;
 369         bool                    enabled;
 370 #ifdef CONFIG_TRACER_MAX_TRACE
 371         bool                    use_max_tr;
 372 #endif
 373 };
 374
 375
 376 /* Only current can touch trace_recursion */
 377
 378 /*
 379  * For function tracing recursion:
 380  *  The order of these bits are important.
 381  *
 382  *  When function tracing occurs, the following steps are made:
 383  *   If arch does not support a ftrace feature:
 384  *    call internal function (uses INTERNAL bits) which calls...
 385  *   If callback is registered to the "global" list, the list
 386  *    function is called and recursion checks the GLOBAL bits.
 387  *    then this function calls...
 388  *   The function callback, which can use the FTRACE bits to
 389  *    check for recursion.
 390  *
 391  * Now if the arch does not suppport a feature, and it calls
 392  * the global list function which calls the ftrace callback
 393  * all three of these steps will do a recursion protection.
 394  * There's no reason to do one if the previous caller already
 395  * did. The recursion that we are protecting against will
 396  * go through the same steps again.
 397  *
 398  * To prevent the multiple recursion checks, if a recursion
 399  * bit is set that is higher than the MAX bit of the current
 400  * check, then we know that the check was made by the previous
 401  * caller, and we can skip the current check.
 402  */
 403 enum {
 404         TRACE_BUFFER_BIT,
 405         TRACE_BUFFER_NMI_BIT,
 406         TRACE_BUFFER_IRQ_BIT,
 407         TRACE_BUFFER_SIRQ_BIT,
 408
 409         /* Start of function recursion bits */
 410         TRACE_FTRACE_BIT,
 411         TRACE_FTRACE_NMI_BIT,
 412         TRACE_FTRACE_IRQ_BIT,
 413         TRACE_FTRACE_SIRQ_BIT,
 414
 415         /* GLOBAL_BITs must be greater than FTRACE_BITs */
 416         TRACE_GLOBAL_BIT,
 417         TRACE_GLOBAL_NMI_BIT,
 418         TRACE_GLOBAL_IRQ_BIT,
 419         TRACE_GLOBAL_SIRQ_BIT,
 420
 421         /* INTERNAL_BITs must be greater than GLOBAL_BITs */
 422         TRACE_INTERNAL_BIT,
 423         TRACE_INTERNAL_NMI_BIT,
 424         TRACE_INTERNAL_IRQ_BIT,
 425         TRACE_INTERNAL_SIRQ_BIT,
 426
 427         TRACE_CONTROL_BIT,
 428
 429 /*
 430  * Abuse of the trace_recursion.
 431  * As we need a way to maintain state if we are tracing the function
 432  * graph in irq because we want to trace a particular function that
 433  * was called in irq context but we have irq tracing off. Since this
 434  * can only be modified by current, we can reuse trace_recursion.
 435  */
 436         TRACE_IRQ_BIT,
 437 };
 438
 439 #define trace_recursion_set(bit)        do { (current)->trace_recursion |= (1<<(bit)); } while (0)
 440 #define trace_recursion_clear(bit)      do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
 441 #define trace_recursion_test(bit)       ((current)->trace_recursion & (1<<(bit)))
 442
 443 #define TRACE_CONTEXT_BITS      4
 444
 445 #define TRACE_FTRACE_START      TRACE_FTRACE_BIT
 446 #define TRACE_FTRACE_MAX        ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
 447
 448 #define TRACE_GLOBAL_START      TRACE_GLOBAL_BIT
 449 #define TRACE_GLOBAL_MAX        ((1 << (TRACE_GLOBAL_START + TRACE_CONTEXT_BITS)) - 1)
 450
 451 #define TRACE_LIST_START        TRACE_INTERNAL_BIT
 452 #define TRACE_LIST_MAX          ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
 453
 454 #define TRACE_CONTEXT_MASK      TRACE_LIST_MAX
 455
 456 static __always_inline int trace_get_context_bit(void)
 457 {
 458         int bit;
 459
 460         if (in_interrupt()) {
 461                 if (in_nmi())
 462                         bit = 0;
 463
 464                 else if (in_irq())
 465                         bit = 1;
 466                 else
 467                         bit = 2;
 468         } else
 469                 bit = 3;
 470
 471         return bit;
 472 }
 473
 474 static __always_inline int trace_test_and_set_recursion(int start, int max)
 475 {
 476         unsigned int val = current->trace_recursion;
 477         int bit;
 478
 479         /* A previous recursion check was made */
 480         if ((val & TRACE_CONTEXT_MASK) > max)
 481                 return 0;
 482
 483         bit = trace_get_context_bit() + start;
 484         if (unlikely(val & (1 << bit)))
 485                 return -1;
 486
 487         val |= 1 << bit;
 488         current->trace_recursion = val;
 489         barrier();
 490
 491         return bit;
 492 }
 493
 494 static __always_inline void trace_clear_recursion(int bit)
 495 {
 496         unsigned int val = current->trace_recursion;
 497
 498         if (!bit)
 499                 return;
 500
 501         bit = 1 << bit;
 502         val &= ~bit;
 503
 504         barrier();
 505         current->trace_recursion = val;
 506 }
 507
 508 static inline struct ring_buffer_iter *
 509 trace_buffer_iter(struct trace_iterator *iter, int cpu)
 510 {
 511         if (iter->buffer_iter && iter->buffer_iter[cpu])
 512                 return iter->buffer_iter[cpu];
 513         return NULL;
 514 }
 515
 516 int tracer_init(struct tracer *t, struct trace_array *tr);
 517 int tracing_is_enabled(void);
 518 void tracing_reset(struct trace_buffer *buf, int cpu);
 519 void tracing_reset_online_cpus(struct trace_buffer *buf);
 520 void tracing_reset_current(int cpu);
 521 void tracing_reset_all_online_cpus(void);
 522 int tracing_open_generic(struct inode *inode, struct file *filp);
 523 struct dentry *trace_create_file(const char *name,
 524                                  umode_t mode,
 525                                  struct dentry *parent,
 526                                  void *data,
 527                                  const struct file_operations *fops);
 528
 529 struct dentry *tracing_init_dentry_tr(struct trace_array *tr);
 530 struct dentry *tracing_init_dentry(void);
 531
 532 struct ring_buffer_event;
 533
 534 struct ring_buffer_event *
 535 trace_buffer_lock_reserve(struct ring_buffer *buffer,
 536                           int type,
 537                           unsigned long len,
 538                           unsigned long flags,
 539                           int pc);
 540
 541 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
 542                                                 struct trace_array_cpu *data);
 543
 544 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
 545                                           int *ent_cpu, u64 *ent_ts);
 546
 547 void __buffer_unlock_commit(struct ring_buffer *buffer,
 548                             struct ring_buffer_event *event);
 549
 550 int trace_empty(struct trace_iterator *iter);
 551
 552 void *trace_find_next_entry_inc(struct trace_iterator *iter);
 553
 554 void trace_init_global_iter(struct trace_iterator *iter);
 555
 556 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
 557
 558 void poll_wait_pipe(struct trace_iterator *iter);
 559
 560 void ftrace(struct trace_array *tr,
 561                             struct trace_array_cpu *data,
 562                             unsigned long ip,
 563                             unsigned long parent_ip,
 564                             unsigned long flags, int pc);
 565 void tracing_sched_switch_trace(struct trace_array *tr,
 566                                 struct task_struct *prev,
 567                                 struct task_struct *next,
 568                                 unsigned long flags, int pc);
 569
 570 void tracing_sched_wakeup_trace(struct trace_array *tr,
 571                                 struct task_struct *wakee,
 572                                 struct task_struct *cur,
 573                                 unsigned long flags, int pc);
 574 void trace_function(struct trace_array *tr,
 575                     unsigned long ip,
 576                     unsigned long parent_ip,
 577                     unsigned long flags, int pc);
 578 void trace_graph_function(struct trace_array *tr,
 579                     unsigned long ip,
 580                     unsigned long parent_ip,
 581                     unsigned long flags, int pc);
 582 void trace_latency_header(struct seq_file *m);
 583 void trace_default_header(struct seq_file *m);
 584 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
 585 int trace_empty(struct trace_iterator *iter);
 586
 587 void trace_graph_return(struct ftrace_graph_ret *trace);
 588 int trace_graph_entry(struct ftrace_graph_ent *trace);
 589 void set_graph_array(struct trace_array *tr);
 590
 591 void tracing_start_cmdline_record(void);
 592 void tracing_stop_cmdline_record(void);
 593 void tracing_sched_switch_assign_trace(struct trace_array *tr);
 594 void tracing_stop_sched_switch_record(void);
 595 void tracing_start_sched_switch_record(void);
 596 int register_tracer(struct tracer *type);
 597 int is_tracing_stopped(void);
 598
 599 extern cpumask_var_t __read_mostly tracing_buffer_mask;
 600
 601 #define for_each_tracing_cpu(cpu)       \
 602         for_each_cpu(cpu, tracing_buffer_mask)
 603
 604 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
 605
 606 extern unsigned long tracing_thresh;
 607
 608 #ifdef CONFIG_TRACER_MAX_TRACE
 609 extern unsigned long tracing_max_latency;
 610
 611 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
 612 void update_max_tr_single(struct trace_array *tr,
 613                           struct task_struct *tsk, int cpu);
 614 #endif /* CONFIG_TRACER_MAX_TRACE */
 615
 616 #ifdef CONFIG_STACKTRACE
 617 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
 618                         int skip, int pc);
 619
 620 void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
 621                              int skip, int pc, struct pt_regs *regs);
 622
 623 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
 624                             int pc);
 625
 626 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
 627                    int pc);
 628 #else
 629 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
 630                                       unsigned long flags, int skip, int pc)
 631 {
 632 }
 633
 634 static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
 635                                            unsigned long flags, int skip,
 636                                            int pc, struct pt_regs *regs)
 637 {
 638 }
 639
 640 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
 641                                           unsigned long flags, int pc)
 642 {
 643 }
 644
 645 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
 646                                  int skip, int pc)
 647 {
 648 }
 649 #endif /* CONFIG_STACKTRACE */
 650
 651 extern cycle_t ftrace_now(int cpu);
 652
 653 extern void trace_find_cmdline(int pid, char comm[]);
 654
 655 #ifdef CONFIG_DYNAMIC_FTRACE
 656 extern unsigned long ftrace_update_tot_cnt;
 657 #endif
 658 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
 659 extern int DYN_FTRACE_TEST_NAME(void);
 660 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
 661 extern int DYN_FTRACE_TEST_NAME2(void);
 662
 663 extern bool ring_buffer_expanded;
 664 extern bool tracing_selftest_disabled;
 665 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
 666
 667 #ifdef CONFIG_FTRACE_STARTUP_TEST
 668 extern int trace_selftest_startup_function(struct tracer *trace,
 669                                            struct trace_array *tr);
 670 extern int trace_selftest_startup_function_graph(struct tracer *trace,
 671                                                  struct trace_array *tr);
 672 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
 673                                           struct trace_array *tr);
 674 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
 675                                              struct trace_array *tr);
 676 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
 677                                                  struct trace_array *tr);
 678 extern int trace_selftest_startup_wakeup(struct tracer *trace,
 679                                          struct trace_array *tr);
 680 extern int trace_selftest_startup_nop(struct tracer *trace,
 681                                          struct trace_array *tr);
 682 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
 683                                                struct trace_array *tr);
 684 extern int trace_selftest_startup_branch(struct tracer *trace,
 685                                          struct trace_array *tr);
 686 #endif /* CONFIG_FTRACE_STARTUP_TEST */
 687
 688 extern void *head_page(struct trace_array_cpu *data);
 689 extern unsigned long long ns2usecs(cycle_t nsec);
 690 extern int
 691 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
 692 extern int
 693 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
 694 extern int
 695 trace_array_vprintk(struct trace_array *tr,
 696                     unsigned long ip, const char *fmt, va_list args);
 697 int trace_array_printk(struct trace_array *tr,
 698                        unsigned long ip, const char *fmt, ...);
 699 int trace_array_printk_buf(struct ring_buffer *buffer,
 700                            unsigned long ip, const char *fmt, ...);
 701 void trace_printk_seq(struct trace_seq *s);
 702 enum print_line_t print_trace_line(struct trace_iterator *iter);
 703
 704 extern unsigned long trace_flags;
 705
 706 extern int trace_clock_id;
 707
 708 /* Standard output formatting function used for function return traces */
 709 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 710
 711 /* Flag options */
 712 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
 713 #define TRACE_GRAPH_PRINT_CPU           0x2
 714 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
 715 #define TRACE_GRAPH_PRINT_PROC          0x8
 716 #define TRACE_GRAPH_PRINT_DURATION      0x10
 717 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
 718
 719 extern enum print_line_t
 720 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
 721 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
 722 extern enum print_line_t
 723 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
 724 extern void graph_trace_open(struct trace_iterator *iter);
 725 extern void graph_trace_close(struct trace_iterator *iter);
 726 extern int __trace_graph_entry(struct trace_array *tr,
 727                                struct ftrace_graph_ent *trace,
 728                                unsigned long flags, int pc);
 729 extern void __trace_graph_return(struct trace_array *tr,
 730                                  struct ftrace_graph_ret *trace,
 731                                  unsigned long flags, int pc);
 732
 733
 734 #ifdef CONFIG_DYNAMIC_FTRACE
 735 /* TODO: make this variable */
 736 #define FTRACE_GRAPH_MAX_FUNCS          32
 737 extern int ftrace_graph_filter_enabled;
 738 extern int ftrace_graph_count;
 739 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
 740
 741 static inline int ftrace_graph_addr(unsigned long addr)
 742 {
 743         int i;
 744
 745         if (!ftrace_graph_filter_enabled)
 746                 return 1;
 747
 748         for (i = 0; i < ftrace_graph_count; i++) {
 749                 if (addr == ftrace_graph_funcs[i]) {
 750                         /*
 751                          * If no irqs are to be traced, but a set_graph_function
 752                          * is set, and called by an interrupt handler, we still
 753                          * want to trace it.
 754                          */
 755                         if (in_irq())
 756                                 trace_recursion_set(TRACE_IRQ_BIT);
 757                         else
 758                                 trace_recursion_clear(TRACE_IRQ_BIT);
 759                         return 1;
 760                 }
 761         }
 762
 763         return 0;
 764 }
 765 #else
 766 static inline int ftrace_graph_addr(unsigned long addr)
 767 {
 768         return 1;
 769 }
 770 #endif /* CONFIG_DYNAMIC_FTRACE */
 771 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
 772 static inline enum print_line_t
 773 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
 774 {
 775         return TRACE_TYPE_UNHANDLED;
 776 }
 777 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
 778
 779 extern struct list_head ftrace_pids;
 780
 781 #ifdef CONFIG_FUNCTION_TRACER
 782 static inline int ftrace_trace_task(struct task_struct *task)
 783 {
 784         if (list_empty(&ftrace_pids))
 785                 return 1;
 786
 787         return test_tsk_trace_trace(task);
 788 }
 789 extern int ftrace_is_dead(void);
 790 #else
 791 static inline int ftrace_trace_task(struct task_struct *task)
 792 {
 793         return 1;
 794 }
 795 static inline int ftrace_is_dead(void) { return 0; }
 796 #endif
 797
 798 int ftrace_event_is_function(struct ftrace_event_call *call);
 799
 800 /*
 801  * struct trace_parser - servers for reading the user input separated by spaces
 802  * @cont: set if the input is not complete - no final space char was found
 803  * @buffer: holds the parsed user input
 804  * @idx: user input length
 805  * @size: buffer size
 806  */
 807 struct trace_parser {
 808         bool            cont;
 809         char            *buffer;
 810         unsigned        idx;
 811         unsigned        size;
 812 };
 813
 814 static inline bool trace_parser_loaded(struct trace_parser *parser)
 815 {
 816         return (parser->idx != 0);
 817 }
 818
 819 static inline bool trace_parser_cont(struct trace_parser *parser)
 820 {
 821         return parser->cont;
 822 }
 823
 824 static inline void trace_parser_clear(struct trace_parser *parser)
 825 {
 826         parser->cont = false;
 827         parser->idx = 0;
 828 }
 829
 830 extern int trace_parser_get_init(struct trace_parser *parser, int size);
 831 extern void trace_parser_put(struct trace_parser *parser);
 832 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
 833         size_t cnt, loff_t *ppos);
 834
 835 /*
 836  * trace_iterator_flags is an enumeration that defines bit
 837  * positions into trace_flags that controls the output.
 838  *
 839  * NOTE: These bits must match the trace_options array in
 840  *       trace.c.
 841  */
 842 enum trace_iterator_flags {
 843         TRACE_ITER_PRINT_PARENT         = 0x01,
 844         TRACE_ITER_SYM_OFFSET           = 0x02,
 845         TRACE_ITER_SYM_ADDR             = 0x04,
 846         TRACE_ITER_VERBOSE              = 0x08,
 847         TRACE_ITER_RAW                  = 0x10,
 848         TRACE_ITER_HEX                  = 0x20,
 849         TRACE_ITER_BIN                  = 0x40,
 850         TRACE_ITER_BLOCK                = 0x80,
 851         TRACE_ITER_STACKTRACE           = 0x100,
 852         TRACE_ITER_PRINTK               = 0x200,
 853         TRACE_ITER_PREEMPTONLY          = 0x400,
 854         TRACE_ITER_BRANCH               = 0x800,
 855         TRACE_ITER_ANNOTATE             = 0x1000,
 856         TRACE_ITER_USERSTACKTRACE       = 0x2000,
 857         TRACE_ITER_SYM_USEROBJ          = 0x4000,
 858         TRACE_ITER_PRINTK_MSGONLY       = 0x8000,
 859         TRACE_ITER_CONTEXT_INFO         = 0x10000, /* Print pid/cpu/time */
 860         TRACE_ITER_LATENCY_FMT          = 0x20000,
 861         TRACE_ITER_SLEEP_TIME           = 0x40000,
 862         TRACE_ITER_GRAPH_TIME           = 0x80000,
 863         TRACE_ITER_RECORD_CMD           = 0x100000,
 864         TRACE_ITER_OVERWRITE            = 0x200000,
 865         TRACE_ITER_STOP_ON_FREE         = 0x400000,
 866         TRACE_ITER_IRQ_INFO             = 0x800000,
 867         TRACE_ITER_MARKERS              = 0x1000000,
 868 };
 869
 870 /*
 871  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
 872  * control the output of kernel symbols.
 873  */
 874 #define TRACE_ITER_SYM_MASK \
 875         (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
 876
 877 extern struct tracer nop_trace;
 878
 879 #ifdef CONFIG_BRANCH_TRACER
 880 extern int enable_branch_tracing(struct trace_array *tr);
 881 extern void disable_branch_tracing(void);
 882 static inline int trace_branch_enable(struct trace_array *tr)
 883 {
 884         if (trace_flags & TRACE_ITER_BRANCH)
 885                 return enable_branch_tracing(tr);
 886         return 0;
 887 }
 888 static inline void trace_branch_disable(void)
 889 {
 890         /* due to races, always disable */
 891         disable_branch_tracing();
 892 }
 893 #else
 894 static inline int trace_branch_enable(struct trace_array *tr)
 895 {
 896         return 0;
 897 }
 898 static inline void trace_branch_disable(void)
 899 {
 900 }
 901 #endif /* CONFIG_BRANCH_TRACER */
 902
 903 /* set ring buffers to default size if not already done so */
 904 int tracing_update_buffers(void);
 905
 906 /* trace event type bit fields, not numeric */
 907 enum {
 908         TRACE_EVENT_TYPE_PRINTF         = 1,
 909         TRACE_EVENT_TYPE_RAW            = 2,
 910 };
 911
 912 struct ftrace_event_field {
 913         struct list_head        link;
 914         const char              *name;
 915         const char              *type;
 916         int                     filter_type;
 917         int                     offset;
 918         int                     size;
 919         int                     is_signed;
 920 };
 921
 922 struct event_filter {
 923         int                     n_preds;        /* Number assigned */
 924         int                     a_preds;        /* allocated */
 925         struct filter_pred      *preds;
 926         struct filter_pred      *root;
 927         char                    *filter_string;
 928 };
 929
 930 struct event_subsystem {
 931         struct list_head        list;
 932         const char              *name;
 933         struct event_filter     *filter;
 934         int                     ref_count;
 935 };
 936
 937 struct ftrace_subsystem_dir {
 938         struct list_head                list;
 939         struct event_subsystem          *subsystem;
 940         struct trace_array              *tr;
 941         struct dentry                   *entry;
 942         int                             ref_count;
 943         int                             nr_events;
 944 };
 945
 946 #define FILTER_PRED_INVALID     ((unsigned short)-1)
 947 #define FILTER_PRED_IS_RIGHT    (1 << 15)
 948 #define FILTER_PRED_FOLD        (1 << 15)
 949
 950 /*
 951  * The max preds is the size of unsigned short with
 952  * two flags at the MSBs. One bit is used for both the IS_RIGHT
 953  * and FOLD flags. The other is reserved.
 954  *
 955  * 2^14 preds is way more than enough.
 956  */
 957 #define MAX_FILTER_PRED         16384
 958
 959 struct filter_pred;
 960 struct regex;
 961
 962 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
 963
 964 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
 965
 966 enum regex_type {
 967         MATCH_FULL = 0,
 968         MATCH_FRONT_ONLY,
 969         MATCH_MIDDLE_ONLY,
 970         MATCH_END_ONLY,
 971 };
 972
 973 struct regex {
 974         char                    pattern[MAX_FILTER_STR_VAL];
 975         int                     len;
 976         int                     field_len;
 977         regex_match_func        match;
 978 };
 979
 980 struct filter_pred {
 981         filter_pred_fn_t        fn;
 982         u64                     val;
 983         struct regex            regex;
 984         unsigned short          *ops;
 985         struct ftrace_event_field *field;
 986         int                     offset;
 987         int                     not;
 988         int                     op;
 989         unsigned short          index;
 990         unsigned short          parent;
 991         unsigned short          left;
 992         unsigned short          right;
 993 };
 994
 995 extern struct list_head ftrace_common_fields;
 996
 997 extern enum regex_type
 998 filter_parse_regex(char *buff, int len, char **search, int *not);
 999 extern void print_event_filter(struct ftrace_event_call *call,
1000                                struct trace_seq *s);
1001 extern int apply_event_filter(struct ftrace_event_call *call,
1002                               char *filter_string);
1003 extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir *dir,
1004                                         char *filter_string);
1005 extern void print_subsystem_event_filter(struct event_subsystem *system,
1006                                          struct trace_seq *s);
1007 extern int filter_assign_type(const char *type);
1008
1009 struct list_head *
1010 trace_get_fields(struct ftrace_event_call *event_call);
1011
1012 static inline int
1013 filter_check_discard(struct ftrace_event_call *call, void *rec,
1014                      struct ring_buffer *buffer,
1015                      struct ring_buffer_event *event)
1016 {
1017         if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
1018             !filter_match_preds(call->filter, rec)) {
1019                 ring_buffer_discard_commit(buffer, event);
1020                 return 1;
1021         }
1022
1023         return 0;
1024 }
1025
1026 extern void trace_event_enable_cmd_record(bool enable);
1027 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1028 extern int event_trace_del_tracer(struct trace_array *tr);
1029
1030 extern struct mutex event_mutex;
1031 extern struct list_head ftrace_events;
1032
1033 extern const char *__start___trace_bprintk_fmt[];
1034 extern const char *__stop___trace_bprintk_fmt[];
1035
1036 void trace_printk_init_buffers(void);
1037 void trace_printk_start_comm(void);
1038 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1039 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1040
1041 #undef FTRACE_ENTRY
1042 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter)     \
1043         extern struct ftrace_event_call                                 \
1044         __attribute__((__aligned__(4))) event_##call;
1045 #undef FTRACE_ENTRY_DUP
1046 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1047         FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1048                      filter)
1049 #include "trace_entries.h"
1050
1051 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1052 int perf_ftrace_event_register(struct ftrace_event_call *call,
1053                                enum trace_reg type, void *data);
1054 #else
1055 #define perf_ftrace_event_register NULL
1056 #endif
1057
1058 #endif /* _LINUX_KERNEL_TRACE_H */