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