include/linux/ftrace.h

   1 /*
   2  * Ftrace header.  For implementation details beyond the random comments
   3  * scattered below, see: Documentation/trace/ftrace-design.txt
   4  */
   5
   6 #ifndef _LINUX_FTRACE_H
   7 #define _LINUX_FTRACE_H
   8
   9 #include <linux/trace_clock.h>
  10 #include <linux/kallsyms.h>
  11 #include <linux/linkage.h>
  12 #include <linux/bitops.h>
  13 #include <linux/ptrace.h>
  14 #include <linux/ktime.h>
  15 #include <linux/sched.h>
  16 #include <linux/types.h>
  17 #include <linux/init.h>
  18 #include <linux/fs.h>
  19
  20 #include <asm/ftrace.h>
  21
  22 /*
  23  * If the arch supports passing the variable contents of
  24  * function_trace_op as the third parameter back from the
  25  * mcount call, then the arch should define this as 1.
  26  */
  27 #ifndef ARCH_SUPPORTS_FTRACE_OPS
  28 #define ARCH_SUPPORTS_FTRACE_OPS 0
  29 #endif
  30
  31 /*
  32  * If the arch's mcount caller does not support all of ftrace's
  33  * features, then it must call an indirect function that
  34  * does. Or at least does enough to prevent any unwelcomed side effects.
  35  */
  36 #if !defined(CONFIG_HAVE_FUNCTION_TRACE_MCOUNT_TEST) || \
  37         !ARCH_SUPPORTS_FTRACE_OPS
  38 # define FTRACE_FORCE_LIST_FUNC 1
  39 #else
  40 # define FTRACE_FORCE_LIST_FUNC 0
  41 #endif
  42
  43
  44 struct module;
  45 struct ftrace_hash;
  46
  47 #ifdef CONFIG_FUNCTION_TRACER
  48
  49 extern int ftrace_enabled;
  50 extern int
  51 ftrace_enable_sysctl(struct ctl_table *table, int write,
  52                      void __user *buffer, size_t *lenp,
  53                      loff_t *ppos);
  54
  55 struct ftrace_ops;
  56
  57 typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip,
  58                               struct ftrace_ops *op, struct pt_regs *regs);
  59
  60 /*
  61  * FTRACE_OPS_FL_* bits denote the state of ftrace_ops struct and are
  62  * set in the flags member.
  63  *
  64  * ENABLED - set/unset when ftrace_ops is registered/unregistered
  65  * GLOBAL  - set manualy by ftrace_ops user to denote the ftrace_ops
  66  *           is part of the global tracers sharing the same filter
  67  *           via set_ftrace_* debugfs files.
  68  * DYNAMIC - set when ftrace_ops is registered to denote dynamically
  69  *           allocated ftrace_ops which need special care
  70  * CONTROL - set manualy by ftrace_ops user to denote the ftrace_ops
  71  *           could be controled by following calls:
  72  *             ftrace_function_local_enable
  73  *             ftrace_function_local_disable
  74  * SAVE_REGS - The ftrace_ops wants regs saved at each function called
  75  *            and passed to the callback. If this flag is set, but the
  76  *            architecture does not support passing regs
  77  *            (ARCH_SUPPORTS_FTRACE_SAVE_REGS is not defined), then the
  78  *            ftrace_ops will fail to register, unless the next flag
  79  *            is set.
  80  * SAVE_REGS_IF_SUPPORTED - This is the same as SAVE_REGS, but if the
  81  *            handler can handle an arch that does not save regs
  82  *            (the handler tests if regs == NULL), then it can set
  83  *            this flag instead. It will not fail registering the ftrace_ops
  84  *            but, the regs field will be NULL if the arch does not support
  85  *            passing regs to the handler.
  86  *            Note, if this flag is set, the SAVE_REGS flag will automatically
  87  *            get set upon registering the ftrace_ops, if the arch supports it.
  88  */
  89 enum {
  90         FTRACE_OPS_FL_ENABLED                   = 1 << 0,
  91         FTRACE_OPS_FL_GLOBAL                    = 1 << 1,
  92         FTRACE_OPS_FL_DYNAMIC                   = 1 << 2,
  93         FTRACE_OPS_FL_CONTROL                   = 1 << 3,
  94         FTRACE_OPS_FL_SAVE_REGS                 = 1 << 4,
  95         FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED    = 1 << 5,
  96 };
  97
  98 struct ftrace_ops {
  99         ftrace_func_t                   func;
 100         struct ftrace_ops               *next;
 101         unsigned long                   flags;
 102         int __percpu                    *disabled;
 103 #ifdef CONFIG_DYNAMIC_FTRACE
 104         struct ftrace_hash              *notrace_hash;
 105         struct ftrace_hash              *filter_hash;
 106 #endif
 107 };
 108
 109 extern int function_trace_stop;
 110
 111 /*
 112  * Type of the current tracing.
 113  */
 114 enum ftrace_tracing_type_t {
 115         FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
 116         FTRACE_TYPE_RETURN,     /* Hook the return of the function */
 117 };
 118
 119 /* Current tracing type, default is FTRACE_TYPE_ENTER */
 120 extern enum ftrace_tracing_type_t ftrace_tracing_type;
 121
 122 /**
 123  * ftrace_stop - stop function tracer.
 124  *
 125  * A quick way to stop the function tracer. Note this an on off switch,
 126  * it is not something that is recursive like preempt_disable.
 127  * This does not disable the calling of mcount, it only stops the
 128  * calling of functions from mcount.
 129  */
 130 static inline void ftrace_stop(void)
 131 {
 132         function_trace_stop = 1;
 133 }
 134
 135 /**
 136  * ftrace_start - start the function tracer.
 137  *
 138  * This function is the inverse of ftrace_stop. This does not enable
 139  * the function tracing if the function tracer is disabled. This only
 140  * sets the function tracer flag to continue calling the functions
 141  * from mcount.
 142  */
 143 static inline void ftrace_start(void)
 144 {
 145         function_trace_stop = 0;
 146 }
 147
 148 /*
 149  * The ftrace_ops must be a static and should also
 150  * be read_mostly.  These functions do modify read_mostly variables
 151  * so use them sparely. Never free an ftrace_op or modify the
 152  * next pointer after it has been registered. Even after unregistering
 153  * it, the next pointer may still be used internally.
 154  */
 155 int register_ftrace_function(struct ftrace_ops *ops);
 156 int unregister_ftrace_function(struct ftrace_ops *ops);
 157 void clear_ftrace_function(void);
 158
 159 /**
 160  * ftrace_function_local_enable - enable controlled ftrace_ops on current cpu
 161  *
 162  * This function enables tracing on current cpu by decreasing
 163  * the per cpu control variable.
 164  * It must be called with preemption disabled and only on ftrace_ops
 165  * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
 166  * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
 167  */
 168 static inline void ftrace_function_local_enable(struct ftrace_ops *ops)
 169 {
 170         if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
 171                 return;
 172
 173         (*this_cpu_ptr(ops->disabled))--;
 174 }
 175
 176 /**
 177  * ftrace_function_local_disable - enable controlled ftrace_ops on current cpu
 178  *
 179  * This function enables tracing on current cpu by decreasing
 180  * the per cpu control variable.
 181  * It must be called with preemption disabled and only on ftrace_ops
 182  * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
 183  * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
 184  */
 185 static inline void ftrace_function_local_disable(struct ftrace_ops *ops)
 186 {
 187         if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
 188                 return;
 189
 190         (*this_cpu_ptr(ops->disabled))++;
 191 }
 192
 193 /**
 194  * ftrace_function_local_disabled - returns ftrace_ops disabled value
 195  *                                  on current cpu
 196  *
 197  * This function returns value of ftrace_ops::disabled on current cpu.
 198  * It must be called with preemption disabled and only on ftrace_ops
 199  * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
 200  * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
 201  */
 202 static inline int ftrace_function_local_disabled(struct ftrace_ops *ops)
 203 {
 204         WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL));
 205         return *this_cpu_ptr(ops->disabled);
 206 }
 207
 208 extern void ftrace_stub(unsigned long a0, unsigned long a1,
 209                         struct ftrace_ops *op, struct pt_regs *regs);
 210
 211 #else /* !CONFIG_FUNCTION_TRACER */
 212 /*
 213  * (un)register_ftrace_function must be a macro since the ops parameter
 214  * must not be evaluated.
 215  */
 216 #define register_ftrace_function(ops) ({ 0; })
 217 #define unregister_ftrace_function(ops) ({ 0; })
 218 static inline void clear_ftrace_function(void) { }
 219 static inline void ftrace_kill(void) { }
 220 static inline void ftrace_stop(void) { }
 221 static inline void ftrace_start(void) { }
 222 #endif /* CONFIG_FUNCTION_TRACER */
 223
 224 #ifdef CONFIG_STACK_TRACER
 225 extern int stack_tracer_enabled;
 226 int
 227 stack_trace_sysctl(struct ctl_table *table, int write,
 228                    void __user *buffer, size_t *lenp,
 229                    loff_t *ppos);
 230 #endif
 231
 232 struct ftrace_func_command {
 233         struct list_head        list;
 234         char                    *name;
 235         int                     (*func)(struct ftrace_hash *hash,
 236                                         char *func, char *cmd,
 237                                         char *params, int enable);
 238 };
 239
 240 #ifdef CONFIG_DYNAMIC_FTRACE
 241
 242 int ftrace_arch_code_modify_prepare(void);
 243 int ftrace_arch_code_modify_post_process(void);
 244
 245 void ftrace_bug(int err, unsigned long ip);
 246
 247 struct seq_file;
 248
 249 struct ftrace_probe_ops {
 250         void                    (*func)(unsigned long ip,
 251                                         unsigned long parent_ip,
 252                                         void **data);
 253         int                     (*callback)(unsigned long ip, void **data);
 254         void                    (*free)(void **data);
 255         int                     (*print)(struct seq_file *m,
 256                                          unsigned long ip,
 257                                          struct ftrace_probe_ops *ops,
 258                                          void *data);
 259 };
 260
 261 extern int
 262 register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
 263                               void *data);
 264 extern void
 265 unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
 266                                 void *data);
 267 extern void
 268 unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
 269 extern void unregister_ftrace_function_probe_all(char *glob);
 270
 271 extern int ftrace_text_reserved(void *start, void *end);
 272
 273 /*
 274  * The dyn_ftrace record's flags field is split into two parts.
 275  * the first part which is '0-FTRACE_REF_MAX' is a counter of
 276  * the number of callbacks that have registered the function that
 277  * the dyn_ftrace descriptor represents.
 278  *
 279  * The second part is a mask:
 280  *  ENABLED - the function is being traced
 281  *  REGS    - the record wants the function to save regs
 282  *  REGS_EN - the function is set up to save regs.
 283  *
 284  * When a new ftrace_ops is registered and wants a function to save
 285  * pt_regs, the rec->flag REGS is set. When the function has been
 286  * set up to save regs, the REG_EN flag is set. Once a function
 287  * starts saving regs it will do so until all ftrace_ops are removed
 288  * from tracing that function.
 289  */
 290 enum {
 291         FTRACE_FL_ENABLED       = (1UL << 29),
 292         FTRACE_FL_REGS          = (1UL << 30),
 293         FTRACE_FL_REGS_EN       = (1UL << 31)
 294 };
 295
 296 #define FTRACE_FL_MASK          (0x7UL << 29)
 297 #define FTRACE_REF_MAX          ((1UL << 29) - 1)
 298
 299 struct dyn_ftrace {
 300         union {
 301                 unsigned long           ip; /* address of mcount call-site */
 302                 struct dyn_ftrace       *freelist;
 303         };
 304         unsigned long           flags;
 305         struct dyn_arch_ftrace          arch;
 306 };
 307
 308 int ftrace_force_update(void);
 309 int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
 310                        int len, int reset);
 311 int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
 312                         int len, int reset);
 313 void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
 314 void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
 315 void ftrace_free_filter(struct ftrace_ops *ops);
 316
 317 int register_ftrace_command(struct ftrace_func_command *cmd);
 318 int unregister_ftrace_command(struct ftrace_func_command *cmd);
 319
 320 enum {
 321         FTRACE_UPDATE_CALLS             = (1 << 0),
 322         FTRACE_DISABLE_CALLS            = (1 << 1),
 323         FTRACE_UPDATE_TRACE_FUNC        = (1 << 2),
 324         FTRACE_START_FUNC_RET           = (1 << 3),
 325         FTRACE_STOP_FUNC_RET            = (1 << 4),
 326 };
 327
 328 /*
 329  * The FTRACE_UPDATE_* enum is used to pass information back
 330  * from the ftrace_update_record() and ftrace_test_record()
 331  * functions. These are called by the code update routines
 332  * to find out what is to be done for a given function.
 333  *
 334  *  IGNORE           - The function is already what we want it to be
 335  *  MAKE_CALL        - Start tracing the function
 336  *  MODIFY_CALL      - Stop saving regs for the function
 337  *  MODIFY_CALL_REGS - Start saving regs for the function
 338  *  MAKE_NOP         - Stop tracing the function
 339  */
 340 enum {
 341         FTRACE_UPDATE_IGNORE,
 342         FTRACE_UPDATE_MAKE_CALL,
 343         FTRACE_UPDATE_MODIFY_CALL,
 344         FTRACE_UPDATE_MODIFY_CALL_REGS,
 345         FTRACE_UPDATE_MAKE_NOP,
 346 };
 347
 348 enum {
 349         FTRACE_ITER_FILTER      = (1 << 0),
 350         FTRACE_ITER_NOTRACE     = (1 << 1),
 351         FTRACE_ITER_PRINTALL    = (1 << 2),
 352         FTRACE_ITER_DO_HASH     = (1 << 3),
 353         FTRACE_ITER_HASH        = (1 << 4),
 354         FTRACE_ITER_ENABLED     = (1 << 5),
 355 };
 356
 357 void arch_ftrace_update_code(int command);
 358
 359 struct ftrace_rec_iter;
 360
 361 struct ftrace_rec_iter *ftrace_rec_iter_start(void);
 362 struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter);
 363 struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter);
 364
 365 #define for_ftrace_rec_iter(iter)               \
 366         for (iter = ftrace_rec_iter_start();    \
 367              iter;                              \
 368              iter = ftrace_rec_iter_next(iter))
 369
 370
 371 int ftrace_update_record(struct dyn_ftrace *rec, int enable);
 372 int ftrace_test_record(struct dyn_ftrace *rec, int enable);
 373 void ftrace_run_stop_machine(int command);
 374 unsigned long ftrace_location(unsigned long ip);
 375
 376 extern ftrace_func_t ftrace_trace_function;
 377
 378 int ftrace_regex_open(struct ftrace_ops *ops, int flag,
 379                   struct inode *inode, struct file *file);
 380 ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
 381                             size_t cnt, loff_t *ppos);
 382 ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
 383                              size_t cnt, loff_t *ppos);
 384 loff_t ftrace_regex_lseek(struct file *file, loff_t offset, int origin);
 385 int ftrace_regex_release(struct inode *inode, struct file *file);
 386
 387 void __init
 388 ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable);
 389
 390 /* defined in arch */
 391 extern int ftrace_ip_converted(unsigned long ip);
 392 extern int ftrace_dyn_arch_init(void *data);
 393 extern void ftrace_replace_code(int enable);
 394 extern int ftrace_update_ftrace_func(ftrace_func_t func);
 395 extern void ftrace_caller(void);
 396 extern void ftrace_regs_caller(void);
 397 extern void ftrace_call(void);
 398 extern void ftrace_regs_call(void);
 399 extern void mcount_call(void);
 400
 401 void ftrace_modify_all_code(int command);
 402
 403 #ifndef FTRACE_ADDR
 404 #define FTRACE_ADDR ((unsigned long)ftrace_caller)
 405 #endif
 406
 407 #ifndef FTRACE_REGS_ADDR
 408 #ifdef ARCH_SUPPORTS_FTRACE_SAVE_REGS
 409 # define FTRACE_REGS_ADDR ((unsigned long)ftrace_regs_caller)
 410 #else
 411 # define FTRACE_REGS_ADDR FTRACE_ADDR
 412 #endif
 413 #endif
 414
 415 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 416 extern void ftrace_graph_caller(void);
 417 extern int ftrace_enable_ftrace_graph_caller(void);
 418 extern int ftrace_disable_ftrace_graph_caller(void);
 419 #else
 420 static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
 421 static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
 422 #endif
 423
 424 /**
 425  * ftrace_make_nop - convert code into nop
 426  * @mod: module structure if called by module load initialization
 427  * @rec: the mcount call site record
 428  * @addr: the address that the call site should be calling
 429  *
 430  * This is a very sensitive operation and great care needs
 431  * to be taken by the arch.  The operation should carefully
 432  * read the location, check to see if what is read is indeed
 433  * what we expect it to be, and then on success of the compare,
 434  * it should write to the location.
 435  *
 436  * The code segment at @rec->ip should be a caller to @addr
 437  *
 438  * Return must be:
 439  *  0 on success
 440  *  -EFAULT on error reading the location
 441  *  -EINVAL on a failed compare of the contents
 442  *  -EPERM  on error writing to the location
 443  * Any other value will be considered a failure.
 444  */
 445 extern int ftrace_make_nop(struct module *mod,
 446                            struct dyn_ftrace *rec, unsigned long addr);
 447
 448 /**
 449  * ftrace_make_call - convert a nop call site into a call to addr
 450  * @rec: the mcount call site record
 451  * @addr: the address that the call site should call
 452  *
 453  * This is a very sensitive operation and great care needs
 454  * to be taken by the arch.  The operation should carefully
 455  * read the location, check to see if what is read is indeed
 456  * what we expect it to be, and then on success of the compare,
 457  * it should write to the location.
 458  *
 459  * The code segment at @rec->ip should be a nop
 460  *
 461  * Return must be:
 462  *  0 on success
 463  *  -EFAULT on error reading the location
 464  *  -EINVAL on a failed compare of the contents
 465  *  -EPERM  on error writing to the location
 466  * Any other value will be considered a failure.
 467  */
 468 extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
 469
 470 #ifdef ARCH_SUPPORTS_FTRACE_SAVE_REGS
 471 /**
 472  * ftrace_modify_call - convert from one addr to another (no nop)
 473  * @rec: the mcount call site record
 474  * @old_addr: the address expected to be currently called to
 475  * @addr: the address to change to
 476  *
 477  * This is a very sensitive operation and great care needs
 478  * to be taken by the arch.  The operation should carefully
 479  * read the location, check to see if what is read is indeed
 480  * what we expect it to be, and then on success of the compare,
 481  * it should write to the location.
 482  *
 483  * The code segment at @rec->ip should be a caller to @old_addr
 484  *
 485  * Return must be:
 486  *  0 on success
 487  *  -EFAULT on error reading the location
 488  *  -EINVAL on a failed compare of the contents
 489  *  -EPERM  on error writing to the location
 490  * Any other value will be considered a failure.
 491  */
 492 extern int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
 493                               unsigned long addr);
 494 #else
 495 /* Should never be called */
 496 static inline int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
 497                                      unsigned long addr)
 498 {
 499         return -EINVAL;
 500 }
 501 #endif
 502
 503 /* May be defined in arch */
 504 extern int ftrace_arch_read_dyn_info(char *buf, int size);
 505
 506 extern int skip_trace(unsigned long ip);
 507
 508 extern void ftrace_disable_daemon(void);
 509 extern void ftrace_enable_daemon(void);
 510 #else
 511 static inline int skip_trace(unsigned long ip) { return 0; }
 512 static inline int ftrace_force_update(void) { return 0; }
 513 static inline void ftrace_disable_daemon(void) { }
 514 static inline void ftrace_enable_daemon(void) { }
 515 static inline void ftrace_release_mod(struct module *mod) {}
 516 static inline int register_ftrace_command(struct ftrace_func_command *cmd)
 517 {
 518         return -EINVAL;
 519 }
 520 static inline int unregister_ftrace_command(char *cmd_name)
 521 {
 522         return -EINVAL;
 523 }
 524 static inline int ftrace_text_reserved(void *start, void *end)
 525 {
 526         return 0;
 527 }
 528
 529 /*
 530  * Again users of functions that have ftrace_ops may not
 531  * have them defined when ftrace is not enabled, but these
 532  * functions may still be called. Use a macro instead of inline.
 533  */
 534 #define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; })
 535 #define ftrace_set_early_filter(ops, buf, enable) do { } while (0)
 536 #define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; })
 537 #define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; })
 538 #define ftrace_free_filter(ops) do { } while (0)
 539
 540 static inline ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
 541                             size_t cnt, loff_t *ppos) { return -ENODEV; }
 542 static inline ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
 543                              size_t cnt, loff_t *ppos) { return -ENODEV; }
 544 static inline loff_t ftrace_regex_lseek(struct file *file, loff_t offset, int origin)
 545 {
 546         return -ENODEV;
 547 }
 548 static inline int
 549 ftrace_regex_release(struct inode *inode, struct file *file) { return -ENODEV; }
 550 #endif /* CONFIG_DYNAMIC_FTRACE */
 551
 552 /* totally disable ftrace - can not re-enable after this */
 553 void ftrace_kill(void);
 554
 555 static inline void tracer_disable(void)
 556 {
 557 #ifdef CONFIG_FUNCTION_TRACER
 558         ftrace_enabled = 0;
 559 #endif
 560 }
 561
 562 /*
 563  * Ftrace disable/restore without lock. Some synchronization mechanism
 564  * must be used to prevent ftrace_enabled to be changed between
 565  * disable/restore.
 566  */
 567 static inline int __ftrace_enabled_save(void)
 568 {
 569 #ifdef CONFIG_FUNCTION_TRACER
 570         int saved_ftrace_enabled = ftrace_enabled;
 571         ftrace_enabled = 0;
 572         return saved_ftrace_enabled;
 573 #else
 574         return 0;
 575 #endif
 576 }
 577
 578 static inline void __ftrace_enabled_restore(int enabled)
 579 {
 580 #ifdef CONFIG_FUNCTION_TRACER
 581         ftrace_enabled = enabled;
 582 #endif
 583 }
 584
 585 #ifndef HAVE_ARCH_CALLER_ADDR
 586 # ifdef CONFIG_FRAME_POINTER
 587 #  define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
 588 #  define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
 589 #  define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
 590 #  define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
 591 #  define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
 592 #  define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
 593 #  define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
 594 # else
 595 #  define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
 596 #  define CALLER_ADDR1 0UL
 597 #  define CALLER_ADDR2 0UL
 598 #  define CALLER_ADDR3 0UL
 599 #  define CALLER_ADDR4 0UL
 600 #  define CALLER_ADDR5 0UL
 601 #  define CALLER_ADDR6 0UL
 602 # endif
 603 #endif /* ifndef HAVE_ARCH_CALLER_ADDR */
 604
 605 #ifdef CONFIG_IRQSOFF_TRACER
 606   extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
 607   extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
 608 #else
 609   static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
 610   static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
 611 #endif
 612
 613 #ifdef CONFIG_PREEMPT_TRACER
 614   extern void trace_preempt_on(unsigned long a0, unsigned long a1);
 615   extern void trace_preempt_off(unsigned long a0, unsigned long a1);
 616 #else
 617 /*
 618  * Use defines instead of static inlines because some arches will make code out
 619  * of the CALLER_ADDR, when we really want these to be a real nop.
 620  */
 621 # define trace_preempt_on(a0, a1) do { } while (0)
 622 # define trace_preempt_off(a0, a1) do { } while (0)
 623 #endif
 624
 625 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 626 extern void ftrace_init(void);
 627 #else
 628 static inline void ftrace_init(void) { }
 629 #endif
 630
 631 /*
 632  * Structure that defines an entry function trace.
 633  */
 634 struct ftrace_graph_ent {
 635         unsigned long func; /* Current function */
 636         int depth;
 637 };
 638
 639 /*
 640  * Structure that defines a return function trace.
 641  */
 642 struct ftrace_graph_ret {
 643         unsigned long func; /* Current function */
 644         unsigned long long calltime;
 645         unsigned long long rettime;
 646         /* Number of functions that overran the depth limit for current task */
 647         unsigned long overrun;
 648         int depth;
 649 };
 650
 651 /* Type of the callback handlers for tracing function graph*/
 652 typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
 653 typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
 654
 655 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 656
 657 /* for init task */
 658 #define INIT_FTRACE_GRAPH               .ret_stack = NULL,
 659
 660 /*
 661  * Stack of return addresses for functions
 662  * of a thread.
 663  * Used in struct thread_info
 664  */
 665 struct ftrace_ret_stack {
 666         unsigned long ret;
 667         unsigned long func;
 668         unsigned long long calltime;
 669         unsigned long long subtime;
 670         unsigned long fp;
 671 };
 672
 673 /*
 674  * Primary handler of a function return.
 675  * It relays on ftrace_return_to_handler.
 676  * Defined in entry_32/64.S
 677  */
 678 extern void return_to_handler(void);
 679
 680 extern int
 681 ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
 682                          unsigned long frame_pointer);
 683
 684 /*
 685  * Sometimes we don't want to trace a function with the function
 686  * graph tracer but we want them to keep traced by the usual function
 687  * tracer if the function graph tracer is not configured.
 688  */
 689 #define __notrace_funcgraph             notrace
 690
 691 /*
 692  * We want to which function is an entrypoint of a hardirq.
 693  * That will help us to put a signal on output.
 694  */
 695 #define __irq_entry              __attribute__((__section__(".irqentry.text")))
 696
 697 /* Limits of hardirq entrypoints */
 698 extern char __irqentry_text_start[];
 699 extern char __irqentry_text_end[];
 700
 701 #define FTRACE_RETFUNC_DEPTH 50
 702 #define FTRACE_RETSTACK_ALLOC_SIZE 32
 703 extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
 704                                 trace_func_graph_ent_t entryfunc);
 705
 706 extern void ftrace_graph_stop(void);
 707
 708 /* The current handlers in use */
 709 extern trace_func_graph_ret_t ftrace_graph_return;
 710 extern trace_func_graph_ent_t ftrace_graph_entry;
 711
 712 extern void unregister_ftrace_graph(void);
 713
 714 extern void ftrace_graph_init_task(struct task_struct *t);
 715 extern void ftrace_graph_exit_task(struct task_struct *t);
 716 extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
 717
 718 static inline int task_curr_ret_stack(struct task_struct *t)
 719 {
 720         return t->curr_ret_stack;
 721 }
 722
 723 static inline void pause_graph_tracing(void)
 724 {
 725         atomic_inc(&current->tracing_graph_pause);
 726 }
 727
 728 static inline void unpause_graph_tracing(void)
 729 {
 730         atomic_dec(&current->tracing_graph_pause);
 731 }
 732 #else /* !CONFIG_FUNCTION_GRAPH_TRACER */
 733
 734 #define __notrace_funcgraph
 735 #define __irq_entry
 736 #define INIT_FTRACE_GRAPH
 737
 738 static inline void ftrace_graph_init_task(struct task_struct *t) { }
 739 static inline void ftrace_graph_exit_task(struct task_struct *t) { }
 740 static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
 741
 742 static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
 743                           trace_func_graph_ent_t entryfunc)
 744 {
 745         return -1;
 746 }
 747 static inline void unregister_ftrace_graph(void) { }
 748
 749 static inline int task_curr_ret_stack(struct task_struct *tsk)
 750 {
 751         return -1;
 752 }
 753
 754 static inline void pause_graph_tracing(void) { }
 755 static inline void unpause_graph_tracing(void) { }
 756 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
 757
 758 #ifdef CONFIG_TRACING
 759
 760 /* flags for current->trace */
 761 enum {
 762         TSK_TRACE_FL_TRACE_BIT  = 0,
 763         TSK_TRACE_FL_GRAPH_BIT  = 1,
 764 };
 765 enum {
 766         TSK_TRACE_FL_TRACE      = 1 << TSK_TRACE_FL_TRACE_BIT,
 767         TSK_TRACE_FL_GRAPH      = 1 << TSK_TRACE_FL_GRAPH_BIT,
 768 };
 769
 770 static inline void set_tsk_trace_trace(struct task_struct *tsk)
 771 {
 772         set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
 773 }
 774
 775 static inline void clear_tsk_trace_trace(struct task_struct *tsk)
 776 {
 777         clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
 778 }
 779
 780 static inline int test_tsk_trace_trace(struct task_struct *tsk)
 781 {
 782         return tsk->trace & TSK_TRACE_FL_TRACE;
 783 }
 784
 785 static inline void set_tsk_trace_graph(struct task_struct *tsk)
 786 {
 787         set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
 788 }
 789
 790 static inline void clear_tsk_trace_graph(struct task_struct *tsk)
 791 {
 792         clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
 793 }
 794
 795 static inline int test_tsk_trace_graph(struct task_struct *tsk)
 796 {
 797         return tsk->trace & TSK_TRACE_FL_GRAPH;
 798 }
 799
 800 enum ftrace_dump_mode;
 801
 802 extern enum ftrace_dump_mode ftrace_dump_on_oops;
 803
 804 #ifdef CONFIG_PREEMPT
 805 #define INIT_TRACE_RECURSION            .trace_recursion = 0,
 806 #endif
 807
 808 #endif /* CONFIG_TRACING */
 809
 810 #ifndef INIT_TRACE_RECURSION
 811 #define INIT_TRACE_RECURSION
 812 #endif
 813
 814 #ifdef CONFIG_FTRACE_SYSCALLS
 815
 816 unsigned long arch_syscall_addr(int nr);
 817
 818 #endif /* CONFIG_FTRACE_SYSCALLS */
 819
 820 #endif /* _LINUX_FTRACE_H */