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