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