kernel/trace/trace.h

   1 #ifndef _LINUX_KERNEL_TRACE_H
   2 #define _LINUX_KERNEL_TRACE_H
   3
   4 #include <linux/fs.h>
   5 #include <asm/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)     \
  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)
  70
  71 #include "trace_entries.h"
  72
  73 /*
  74  * syscalls are special, and need special handling, this is why
  75  * they are not included in trace_entries.h
  76  */
  77 struct syscall_trace_enter {
  78         struct trace_entry      ent;
  79         int                     nr;
  80         unsigned long           args[];
  81 };
  82
  83 struct syscall_trace_exit {
  84         struct trace_entry      ent;
  85         int                     nr;
  86         long                    ret;
  87 };
  88
  89 struct kprobe_trace_entry_head {
  90         struct trace_entry      ent;
  91         unsigned long           ip;
  92 };
  93
  94 struct kretprobe_trace_entry_head {
  95         struct trace_entry      ent;
  96         unsigned long           func;
  97         unsigned long           ret_ip;
  98 };
  99
 100 /*
 101  * trace_flag_type is an enumeration that holds different
 102  * states when a trace occurs. These are:
 103  *  IRQS_OFF            - interrupts were disabled
 104  *  IRQS_NOSUPPORT      - arch does not support irqs_disabled_flags
 105  *  NEED_RESCHED        - reschedule is requested
 106  *  HARDIRQ             - inside an interrupt handler
 107  *  SOFTIRQ             - inside a softirq handler
 108  */
 109 enum trace_flag_type {
 110         TRACE_FLAG_IRQS_OFF             = 0x01,
 111         TRACE_FLAG_IRQS_NOSUPPORT       = 0x02,
 112         TRACE_FLAG_NEED_RESCHED         = 0x04,
 113         TRACE_FLAG_HARDIRQ              = 0x08,
 114         TRACE_FLAG_SOFTIRQ              = 0x10,
 115 };
 116
 117 #define TRACE_BUF_SIZE          1024
 118
 119 /*
 120  * The CPU trace array - it consists of thousands of trace entries
 121  * plus some other descriptor data: (for example which task started
 122  * the trace, etc.)
 123  */
 124 struct trace_array_cpu {
 125         atomic_t                disabled;
 126         void                    *buffer_page;   /* ring buffer spare */
 127
 128         unsigned long           saved_latency;
 129         unsigned long           critical_start;
 130         unsigned long           critical_end;
 131         unsigned long           critical_sequence;
 132         unsigned long           nice;
 133         unsigned long           policy;
 134         unsigned long           rt_priority;
 135         unsigned long           skipped_entries;
 136         cycle_t                 preempt_timestamp;
 137         pid_t                   pid;
 138         uid_t                   uid;
 139         char                    comm[TASK_COMM_LEN];
 140 };
 141
 142 /*
 143  * The trace array - an array of per-CPU trace arrays. This is the
 144  * highest level data structure that individual tracers deal with.
 145  * They have on/off state as well:
 146  */
 147 struct trace_array {
 148         struct ring_buffer      *buffer;
 149         unsigned long           entries;
 150         int                     cpu;
 151         cycle_t                 time_start;
 152         struct task_struct      *waiter;
 153         struct trace_array_cpu  *data[NR_CPUS];
 154 };
 155
 156 #define FTRACE_CMP_TYPE(var, type) \
 157         __builtin_types_compatible_p(typeof(var), type *)
 158
 159 #undef IF_ASSIGN
 160 #define IF_ASSIGN(var, entry, etype, id)                \
 161         if (FTRACE_CMP_TYPE(var, etype)) {              \
 162                 var = (typeof(var))(entry);             \
 163                 WARN_ON(id && (entry)->type != id);     \
 164                 break;                                  \
 165         }
 166
 167 /* Will cause compile errors if type is not found. */
 168 extern void __ftrace_bad_type(void);
 169
 170 /*
 171  * The trace_assign_type is a verifier that the entry type is
 172  * the same as the type being assigned. To add new types simply
 173  * add a line with the following format:
 174  *
 175  * IF_ASSIGN(var, ent, type, id);
 176  *
 177  *  Where "type" is the trace type that includes the trace_entry
 178  *  as the "ent" item. And "id" is the trace identifier that is
 179  *  used in the trace_type enum.
 180  *
 181  *  If the type can have more than one id, then use zero.
 182  */
 183 #define trace_assign_type(var, ent)                                     \
 184         do {                                                            \
 185                 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);     \
 186                 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);        \
 187                 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);   \
 188                 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
 189                 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);   \
 190                 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
 191                 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,          \
 192                           TRACE_MMIO_RW);                               \
 193                 IF_ASSIGN(var, ent, struct trace_mmiotrace_map,         \
 194                           TRACE_MMIO_MAP);                              \
 195                 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
 196                 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,      \
 197                           TRACE_GRAPH_ENT);             \
 198                 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,      \
 199                           TRACE_GRAPH_RET);             \
 200                 __ftrace_bad_type();                                    \
 201         } while (0)
 202
 203 /*
 204  * An option specific to a tracer. This is a boolean value.
 205  * The bit is the bit index that sets its value on the
 206  * flags value in struct tracer_flags.
 207  */
 208 struct tracer_opt {
 209         const char      *name; /* Will appear on the trace_options file */
 210         u32             bit; /* Mask assigned in val field in tracer_flags */
 211 };
 212
 213 /*
 214  * The set of specific options for a tracer. Your tracer
 215  * have to set the initial value of the flags val.
 216  */
 217 struct tracer_flags {
 218         u32                     val;
 219         struct tracer_opt       *opts;
 220 };
 221
 222 /* Makes more easy to define a tracer opt */
 223 #define TRACER_OPT(s, b)        .name = #s, .bit = b
 224
 225
 226 /**
 227  * struct tracer - a specific tracer and its callbacks to interact with debugfs
 228  * @name: the name chosen to select it on the available_tracers file
 229  * @init: called when one switches to this tracer (echo name > current_tracer)
 230  * @reset: called when one switches to another tracer
 231  * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
 232  * @stop: called when tracing is paused (echo 0 > tracing_enabled)
 233  * @open: called when the trace file is opened
 234  * @pipe_open: called when the trace_pipe file is opened
 235  * @wait_pipe: override how the user waits for traces on trace_pipe
 236  * @close: called when the trace file is released
 237  * @pipe_close: called when the trace_pipe file is released
 238  * @read: override the default read callback on trace_pipe
 239  * @splice_read: override the default splice_read callback on trace_pipe
 240  * @selftest: selftest to run on boot (see trace_selftest.c)
 241  * @print_headers: override the first lines that describe your columns
 242  * @print_line: callback that prints a trace
 243  * @set_flag: signals one of your private flags changed (trace_options file)
 244  * @flags: your private flags
 245  */
 246 struct tracer {
 247         const char              *name;
 248         int                     (*init)(struct trace_array *tr);
 249         void                    (*reset)(struct trace_array *tr);
 250         void                    (*start)(struct trace_array *tr);
 251         void                    (*stop)(struct trace_array *tr);
 252         void                    (*open)(struct trace_iterator *iter);
 253         void                    (*pipe_open)(struct trace_iterator *iter);
 254         void                    (*wait_pipe)(struct trace_iterator *iter);
 255         void                    (*close)(struct trace_iterator *iter);
 256         void                    (*pipe_close)(struct trace_iterator *iter);
 257         ssize_t                 (*read)(struct trace_iterator *iter,
 258                                         struct file *filp, char __user *ubuf,
 259                                         size_t cnt, loff_t *ppos);
 260         ssize_t                 (*splice_read)(struct trace_iterator *iter,
 261                                                struct file *filp,
 262                                                loff_t *ppos,
 263                                                struct pipe_inode_info *pipe,
 264                                                size_t len,
 265                                                unsigned int flags);
 266 #ifdef CONFIG_FTRACE_STARTUP_TEST
 267         int                     (*selftest)(struct tracer *trace,
 268                                             struct trace_array *tr);
 269 #endif
 270         void                    (*print_header)(struct seq_file *m);
 271         enum print_line_t       (*print_line)(struct trace_iterator *iter);
 272         /* If you handled the flag setting, return 0 */
 273         int                     (*set_flag)(u32 old_flags, u32 bit, int set);
 274         struct tracer           *next;
 275         struct tracer_flags     *flags;
 276         int                     print_max;
 277         int                     use_max_tr;
 278 };
 279
 280
 281 #define TRACE_PIPE_ALL_CPU      -1
 282
 283 int tracer_init(struct tracer *t, struct trace_array *tr);
 284 int tracing_is_enabled(void);
 285 void trace_wake_up(void);
 286 void tracing_reset(struct trace_array *tr, int cpu);
 287 void tracing_reset_online_cpus(struct trace_array *tr);
 288 void tracing_reset_current(int cpu);
 289 void tracing_reset_current_online_cpus(void);
 290 int tracing_open_generic(struct inode *inode, struct file *filp);
 291 struct dentry *trace_create_file(const char *name,
 292                                  mode_t mode,
 293                                  struct dentry *parent,
 294                                  void *data,
 295                                  const struct file_operations *fops);
 296
 297 struct dentry *tracing_init_dentry(void);
 298
 299 struct ring_buffer_event;
 300
 301 struct ring_buffer_event *
 302 trace_buffer_lock_reserve(struct ring_buffer *buffer,
 303                           int type,
 304                           unsigned long len,
 305                           unsigned long flags,
 306                           int pc);
 307 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
 308                                 struct ring_buffer_event *event,
 309                                 unsigned long flags, int pc);
 310
 311 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
 312                                                 struct trace_array_cpu *data);
 313
 314 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
 315                                           int *ent_cpu, u64 *ent_ts);
 316
 317 int trace_empty(struct trace_iterator *iter);
 318
 319 void *trace_find_next_entry_inc(struct trace_iterator *iter);
 320
 321 void trace_init_global_iter(struct trace_iterator *iter);
 322
 323 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
 324
 325 void default_wait_pipe(struct trace_iterator *iter);
 326 void poll_wait_pipe(struct trace_iterator *iter);
 327
 328 void ftrace(struct trace_array *tr,
 329                             struct trace_array_cpu *data,
 330                             unsigned long ip,
 331                             unsigned long parent_ip,
 332                             unsigned long flags, int pc);
 333 void tracing_sched_switch_trace(struct trace_array *tr,
 334                                 struct task_struct *prev,
 335                                 struct task_struct *next,
 336                                 unsigned long flags, int pc);
 337
 338 void tracing_sched_wakeup_trace(struct trace_array *tr,
 339                                 struct task_struct *wakee,
 340                                 struct task_struct *cur,
 341                                 unsigned long flags, int pc);
 342 void trace_function(struct trace_array *tr,
 343                     unsigned long ip,
 344                     unsigned long parent_ip,
 345                     unsigned long flags, int pc);
 346 void trace_graph_function(struct trace_array *tr,
 347                     unsigned long ip,
 348                     unsigned long parent_ip,
 349                     unsigned long flags, int pc);
 350 void trace_default_header(struct seq_file *m);
 351 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
 352 int trace_empty(struct trace_iterator *iter);
 353
 354 void trace_graph_return(struct ftrace_graph_ret *trace);
 355 int trace_graph_entry(struct ftrace_graph_ent *trace);
 356 void set_graph_array(struct trace_array *tr);
 357
 358 void tracing_start_cmdline_record(void);
 359 void tracing_stop_cmdline_record(void);
 360 void tracing_sched_switch_assign_trace(struct trace_array *tr);
 361 void tracing_stop_sched_switch_record(void);
 362 void tracing_start_sched_switch_record(void);
 363 int register_tracer(struct tracer *type);
 364 void unregister_tracer(struct tracer *type);
 365 int is_tracing_stopped(void);
 366 enum trace_file_type {
 367         TRACE_FILE_LAT_FMT      = 1,
 368         TRACE_FILE_ANNOTATE     = 2,
 369 };
 370
 371 extern cpumask_var_t __read_mostly tracing_buffer_mask;
 372
 373 #define for_each_tracing_cpu(cpu)       \
 374         for_each_cpu(cpu, tracing_buffer_mask)
 375
 376 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
 377
 378 extern unsigned long tracing_thresh;
 379
 380 #ifdef CONFIG_TRACER_MAX_TRACE
 381 extern unsigned long tracing_max_latency;
 382
 383 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
 384 void update_max_tr_single(struct trace_array *tr,
 385                           struct task_struct *tsk, int cpu);
 386 #endif /* CONFIG_TRACER_MAX_TRACE */
 387
 388 #ifdef CONFIG_STACKTRACE
 389 void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
 390                         int skip, int pc);
 391
 392 void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
 393                             int pc);
 394
 395 void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
 396                    int pc);
 397 #else
 398 static inline void ftrace_trace_stack(struct ring_buffer *buffer,
 399                                       unsigned long flags, int skip, int pc)
 400 {
 401 }
 402
 403 static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
 404                                           unsigned long flags, int pc)
 405 {
 406 }
 407
 408 static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
 409                                  int skip, int pc)
 410 {
 411 }
 412 #endif /* CONFIG_STACKTRACE */
 413
 414 extern cycle_t ftrace_now(int cpu);
 415
 416 extern void trace_find_cmdline(int pid, char comm[]);
 417
 418 #ifdef CONFIG_DYNAMIC_FTRACE
 419 extern unsigned long ftrace_update_tot_cnt;
 420 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
 421 extern int DYN_FTRACE_TEST_NAME(void);
 422 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
 423 extern int DYN_FTRACE_TEST_NAME2(void);
 424 #endif
 425
 426 extern int ring_buffer_expanded;
 427 extern bool tracing_selftest_disabled;
 428 DECLARE_PER_CPU(int, ftrace_cpu_disabled);
 429
 430 #ifdef CONFIG_FTRACE_STARTUP_TEST
 431 extern int trace_selftest_startup_function(struct tracer *trace,
 432                                            struct trace_array *tr);
 433 extern int trace_selftest_startup_function_graph(struct tracer *trace,
 434                                                  struct trace_array *tr);
 435 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
 436                                           struct trace_array *tr);
 437 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
 438                                              struct trace_array *tr);
 439 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
 440                                                  struct trace_array *tr);
 441 extern int trace_selftest_startup_wakeup(struct tracer *trace,
 442                                          struct trace_array *tr);
 443 extern int trace_selftest_startup_nop(struct tracer *trace,
 444                                          struct trace_array *tr);
 445 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
 446                                                struct trace_array *tr);
 447 extern int trace_selftest_startup_branch(struct tracer *trace,
 448                                          struct trace_array *tr);
 449 #endif /* CONFIG_FTRACE_STARTUP_TEST */
 450
 451 extern void *head_page(struct trace_array_cpu *data);
 452 extern unsigned long long ns2usecs(cycle_t nsec);
 453 extern int
 454 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
 455 extern int
 456 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
 457 extern int
 458 trace_array_vprintk(struct trace_array *tr,
 459                     unsigned long ip, const char *fmt, va_list args);
 460 int trace_array_printk(struct trace_array *tr,
 461                        unsigned long ip, const char *fmt, ...);
 462 void trace_printk_seq(struct trace_seq *s);
 463 enum print_line_t print_trace_line(struct trace_iterator *iter);
 464
 465 extern unsigned long trace_flags;
 466
 467 extern int trace_clock_id;
 468
 469 /* Standard output formatting function used for function return traces */
 470 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 471
 472 /* Flag options */
 473 #define TRACE_GRAPH_PRINT_OVERRUN       0x1
 474 #define TRACE_GRAPH_PRINT_CPU           0x2
 475 #define TRACE_GRAPH_PRINT_OVERHEAD      0x4
 476 #define TRACE_GRAPH_PRINT_PROC          0x8
 477 #define TRACE_GRAPH_PRINT_DURATION      0x10
 478 #define TRACE_GRAPH_PRINT_ABS_TIME      0x20
 479
 480 extern enum print_line_t
 481 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
 482 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
 483 extern enum print_line_t
 484 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
 485 extern void graph_trace_open(struct trace_iterator *iter);
 486 extern void graph_trace_close(struct trace_iterator *iter);
 487 extern int __trace_graph_entry(struct trace_array *tr,
 488                                struct ftrace_graph_ent *trace,
 489                                unsigned long flags, int pc);
 490 extern void __trace_graph_return(struct trace_array *tr,
 491                                  struct ftrace_graph_ret *trace,
 492                                  unsigned long flags, int pc);
 493
 494
 495 #ifdef CONFIG_DYNAMIC_FTRACE
 496 /* TODO: make this variable */
 497 #define FTRACE_GRAPH_MAX_FUNCS          32
 498 extern int ftrace_graph_filter_enabled;
 499 extern int ftrace_graph_count;
 500 extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
 501
 502 static inline int ftrace_graph_addr(unsigned long addr)
 503 {
 504         int i;
 505
 506         if (!ftrace_graph_filter_enabled)
 507                 return 1;
 508
 509         for (i = 0; i < ftrace_graph_count; i++) {
 510                 if (addr == ftrace_graph_funcs[i])
 511                         return 1;
 512         }
 513
 514         return 0;
 515 }
 516 #else
 517 static inline int ftrace_graph_addr(unsigned long addr)
 518 {
 519         return 1;
 520 }
 521 #endif /* CONFIG_DYNAMIC_FTRACE */
 522 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
 523 static inline enum print_line_t
 524 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
 525 {
 526         return TRACE_TYPE_UNHANDLED;
 527 }
 528 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
 529
 530 extern struct list_head ftrace_pids;
 531
 532 #ifdef CONFIG_FUNCTION_TRACER
 533 static inline int ftrace_trace_task(struct task_struct *task)
 534 {
 535         if (list_empty(&ftrace_pids))
 536                 return 1;
 537
 538         return test_tsk_trace_trace(task);
 539 }
 540 #else
 541 static inline int ftrace_trace_task(struct task_struct *task)
 542 {
 543         return 1;
 544 }
 545 #endif
 546
 547 /*
 548  * struct trace_parser - servers for reading the user input separated by spaces
 549  * @cont: set if the input is not complete - no final space char was found
 550  * @buffer: holds the parsed user input
 551  * @idx: user input length
 552  * @size: buffer size
 553  */
 554 struct trace_parser {
 555         bool            cont;
 556         char            *buffer;
 557         unsigned        idx;
 558         unsigned        size;
 559 };
 560
 561 static inline bool trace_parser_loaded(struct trace_parser *parser)
 562 {
 563         return (parser->idx != 0);
 564 }
 565
 566 static inline bool trace_parser_cont(struct trace_parser *parser)
 567 {
 568         return parser->cont;
 569 }
 570
 571 static inline void trace_parser_clear(struct trace_parser *parser)
 572 {
 573         parser->cont = false;
 574         parser->idx = 0;
 575 }
 576
 577 extern int trace_parser_get_init(struct trace_parser *parser, int size);
 578 extern void trace_parser_put(struct trace_parser *parser);
 579 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
 580         size_t cnt, loff_t *ppos);
 581
 582 /*
 583  * trace_iterator_flags is an enumeration that defines bit
 584  * positions into trace_flags that controls the output.
 585  *
 586  * NOTE: These bits must match the trace_options array in
 587  *       trace.c.
 588  */
 589 enum trace_iterator_flags {
 590         TRACE_ITER_PRINT_PARENT         = 0x01,
 591         TRACE_ITER_SYM_OFFSET           = 0x02,
 592         TRACE_ITER_SYM_ADDR             = 0x04,
 593         TRACE_ITER_VERBOSE              = 0x08,
 594         TRACE_ITER_RAW                  = 0x10,
 595         TRACE_ITER_HEX                  = 0x20,
 596         TRACE_ITER_BIN                  = 0x40,
 597         TRACE_ITER_BLOCK                = 0x80,
 598         TRACE_ITER_STACKTRACE           = 0x100,
 599         TRACE_ITER_PRINTK               = 0x200,
 600         TRACE_ITER_PREEMPTONLY          = 0x400,
 601         TRACE_ITER_BRANCH               = 0x800,
 602         TRACE_ITER_ANNOTATE             = 0x1000,
 603         TRACE_ITER_USERSTACKTRACE       = 0x2000,
 604         TRACE_ITER_SYM_USEROBJ          = 0x4000,
 605         TRACE_ITER_PRINTK_MSGONLY       = 0x8000,
 606         TRACE_ITER_CONTEXT_INFO         = 0x10000, /* Print pid/cpu/time */
 607         TRACE_ITER_LATENCY_FMT          = 0x20000,
 608         TRACE_ITER_SLEEP_TIME           = 0x40000,
 609         TRACE_ITER_GRAPH_TIME           = 0x80000,
 610         TRACE_ITER_RECORD_CMD           = 0x100000,
 611         TRACE_ITER_OVERWRITE            = 0x200000,
 612 };
 613
 614 /*
 615  * TRACE_ITER_SYM_MASK masks the options in trace_flags that
 616  * control the output of kernel symbols.
 617  */
 618 #define TRACE_ITER_SYM_MASK \
 619         (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
 620
 621 extern struct tracer nop_trace;
 622
 623 #ifdef CONFIG_BRANCH_TRACER
 624 extern int enable_branch_tracing(struct trace_array *tr);
 625 extern void disable_branch_tracing(void);
 626 static inline int trace_branch_enable(struct trace_array *tr)
 627 {
 628         if (trace_flags & TRACE_ITER_BRANCH)
 629                 return enable_branch_tracing(tr);
 630         return 0;
 631 }
 632 static inline void trace_branch_disable(void)
 633 {
 634         /* due to races, always disable */
 635         disable_branch_tracing();
 636 }
 637 #else
 638 static inline int trace_branch_enable(struct trace_array *tr)
 639 {
 640         return 0;
 641 }
 642 static inline void trace_branch_disable(void)
 643 {
 644 }
 645 #endif /* CONFIG_BRANCH_TRACER */
 646
 647 /* set ring buffers to default size if not already done so */
 648 int tracing_update_buffers(void);
 649
 650 /* trace event type bit fields, not numeric */
 651 enum {
 652         TRACE_EVENT_TYPE_PRINTF         = 1,
 653         TRACE_EVENT_TYPE_RAW            = 2,
 654 };
 655
 656 struct ftrace_event_field {
 657         struct list_head        link;
 658         char                    *name;
 659         char                    *type;
 660         int                     filter_type;
 661         int                     offset;
 662         int                     size;
 663         int                     is_signed;
 664 };
 665
 666 struct event_filter {
 667         int                     n_preds;        /* Number assigned */
 668         int                     a_preds;        /* allocated */
 669         struct filter_pred      *preds;
 670         struct filter_pred      *root;
 671         char                    *filter_string;
 672 };
 673
 674 struct event_subsystem {
 675         struct list_head        list;
 676         const char              *name;
 677         struct dentry           *entry;
 678         struct event_filter     *filter;
 679         int                     nr_events;
 680 };
 681
 682 #define FILTER_PRED_INVALID     ((unsigned short)-1)
 683 #define FILTER_PRED_IS_RIGHT    (1 << 15)
 684 #define FILTER_PRED_FOLD        (1 << 15)
 685
 686 /*
 687  * The max preds is the size of unsigned short with
 688  * two flags at the MSBs. One bit is used for both the IS_RIGHT
 689  * and FOLD flags. The other is reserved.
 690  *
 691  * 2^14 preds is way more than enough.
 692  */
 693 #define MAX_FILTER_PRED         16384
 694
 695 struct filter_pred;
 696 struct regex;
 697
 698 typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
 699
 700 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
 701
 702 enum regex_type {
 703         MATCH_FULL = 0,
 704         MATCH_FRONT_ONLY,
 705         MATCH_MIDDLE_ONLY,
 706         MATCH_END_ONLY,
 707 };
 708
 709 struct regex {
 710         char                    pattern[MAX_FILTER_STR_VAL];
 711         int                     len;
 712         int                     field_len;
 713         regex_match_func        match;
 714 };
 715
 716 struct filter_pred {
 717         filter_pred_fn_t        fn;
 718         u64                     val;
 719         struct regex            regex;
 720         /*
 721          * Leaf nodes use field_name, ops is used by AND and OR
 722          * nodes. The field_name is always freed when freeing a pred.
 723          * We can overload field_name for ops and have it freed
 724          * as well.
 725          */
 726         union {
 727                 char            *field_name;
 728                 unsigned short  *ops;
 729         };
 730         int                     offset;
 731         int                     not;
 732         int                     op;
 733         unsigned short          index;
 734         unsigned short          parent;
 735         unsigned short          left;
 736         unsigned short          right;
 737 };
 738
 739 extern struct list_head ftrace_common_fields;
 740
 741 extern enum regex_type
 742 filter_parse_regex(char *buff, int len, char **search, int *not);
 743 extern void print_event_filter(struct ftrace_event_call *call,
 744                                struct trace_seq *s);
 745 extern int apply_event_filter(struct ftrace_event_call *call,
 746                               char *filter_string);
 747 extern int apply_subsystem_event_filter(struct event_subsystem *system,
 748                                         char *filter_string);
 749 extern void print_subsystem_event_filter(struct event_subsystem *system,
 750                                          struct trace_seq *s);
 751 extern int filter_assign_type(const char *type);
 752
 753 struct list_head *
 754 trace_get_fields(struct ftrace_event_call *event_call);
 755
 756 static inline int
 757 filter_check_discard(struct ftrace_event_call *call, void *rec,
 758                      struct ring_buffer *buffer,
 759                      struct ring_buffer_event *event)
 760 {
 761         if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
 762             !filter_match_preds(call->filter, rec)) {
 763                 ring_buffer_discard_commit(buffer, event);
 764                 return 1;
 765         }
 766
 767         return 0;
 768 }
 769
 770 extern void trace_event_enable_cmd_record(bool enable);
 771
 772 extern struct mutex event_mutex;
 773 extern struct list_head ftrace_events;
 774
 775 extern const char *__start___trace_bprintk_fmt[];
 776 extern const char *__stop___trace_bprintk_fmt[];
 777
 778 #undef FTRACE_ENTRY
 779 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print)             \
 780         extern struct ftrace_event_call                                 \
 781         __attribute__((__aligned__(4))) event_##call;
 782 #undef FTRACE_ENTRY_DUP
 783 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print)         \
 784         FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
 785 #include "trace_entries.h"
 786
 787 /* Only current can touch trace_recursion */
 788 #define trace_recursion_inc() do { (current)->trace_recursion++; } while (0)
 789 #define trace_recursion_dec() do { (current)->trace_recursion--; } while (0)
 790
 791 /* Ring buffer has the 10 LSB bits to count */
 792 #define trace_recursion_buffer() ((current)->trace_recursion & 0x3ff)
 793
 794 /* for function tracing recursion */
 795 #define TRACE_INTERNAL_BIT              (1<<11)
 796 #define TRACE_GLOBAL_BIT                (1<<12)
 797
 798 #define trace_recursion_set(bit)        do { (current)->trace_recursion |= (bit); } while (0)
 799 #define trace_recursion_clear(bit)      do { (current)->trace_recursion &= ~(bit); } while (0)
 800 #define trace_recursion_test(bit)       ((current)->trace_recursion & (bit))
 801
 802 #endif /* _LINUX_KERNEL_TRACE_H */