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