include/linux/ftrace.h

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