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