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