include/linux/ftrace.h

   1 #ifndef _LINUX_FTRACE_H
   2 #define _LINUX_FTRACE_H
   3
   4 #include <linux/linkage.h>
   5 #include <linux/fs.h>
   6 #include <linux/ktime.h>
   7 #include <linux/init.h>
   8 #include <linux/types.h>
   9 #include <linux/module.h>
  10 #include <linux/kallsyms.h>
  11 #include <linux/bitops.h>
  12 #include <linux/sched.h>
  13
  14 #include <asm/ftrace.h>
  15
  16 #ifdef CONFIG_FUNCTION_TRACER
  17
  18 extern int ftrace_enabled;
  19 extern int
  20 ftrace_enable_sysctl(struct ctl_table *table, int write,
  21                      struct file *filp, void __user *buffer, size_t *lenp,
  22                      loff_t *ppos);
  23
  24 typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
  25
  26 struct ftrace_ops {
  27         ftrace_func_t     func;
  28         struct ftrace_ops *next;
  29 };
  30
  31 extern int function_trace_stop;
  32
  33 /*
  34  * Type of the current tracing.
  35  */
  36 enum ftrace_tracing_type_t {
  37         FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
  38         FTRACE_TYPE_RETURN,     /* Hook the return of the function */
  39 };
  40
  41 /* Current tracing type, default is FTRACE_TYPE_ENTER */
  42 extern enum ftrace_tracing_type_t ftrace_tracing_type;
  43
  44 /**
  45  * ftrace_stop - stop function tracer.
  46  *
  47  * A quick way to stop the function tracer. Note this an on off switch,
  48  * it is not something that is recursive like preempt_disable.
  49  * This does not disable the calling of mcount, it only stops the
  50  * calling of functions from mcount.
  51  */
  52 static inline void ftrace_stop(void)
  53 {
  54         function_trace_stop = 1;
  55 }
  56
  57 /**
  58  * ftrace_start - start the function tracer.
  59  *
  60  * This function is the inverse of ftrace_stop. This does not enable
  61  * the function tracing if the function tracer is disabled. This only
  62  * sets the function tracer flag to continue calling the functions
  63  * from mcount.
  64  */
  65 static inline void ftrace_start(void)
  66 {
  67         function_trace_stop = 0;
  68 }
  69
  70 /*
  71  * The ftrace_ops must be a static and should also
  72  * be read_mostly.  These functions do modify read_mostly variables
  73  * so use them sparely. Never free an ftrace_op or modify the
  74  * next pointer after it has been registered. Even after unregistering
  75  * it, the next pointer may still be used internally.
  76  */
  77 int register_ftrace_function(struct ftrace_ops *ops);
  78 int unregister_ftrace_function(struct ftrace_ops *ops);
  79 void clear_ftrace_function(void);
  80
  81 extern void ftrace_stub(unsigned long a0, unsigned long a1);
  82
  83 #else /* !CONFIG_FUNCTION_TRACER */
  84 # define register_ftrace_function(ops) do { } while (0)
  85 # define unregister_ftrace_function(ops) do { } while (0)
  86 # define clear_ftrace_function(ops) do { } while (0)
  87 static inline void ftrace_kill(void) { }
  88 static inline void ftrace_stop(void) { }
  89 static inline void ftrace_start(void) { }
  90 #endif /* CONFIG_FUNCTION_TRACER */
  91
  92 #ifdef CONFIG_STACK_TRACER
  93 extern int stack_tracer_enabled;
  94 int
  95 stack_trace_sysctl(struct ctl_table *table, int write,
  96                    struct file *file, void __user *buffer, size_t *lenp,
  97                    loff_t *ppos);
  98 #endif
  99
 100 struct ftrace_func_command {
 101         struct list_head        list;
 102         char                    *name;
 103         int                     (*func)(char *func, char *cmd,
 104                                         char *params, int enable);
 105 };
 106
 107 #ifdef CONFIG_DYNAMIC_FTRACE
 108
 109 int ftrace_arch_code_modify_prepare(void);
 110 int ftrace_arch_code_modify_post_process(void);
 111
 112 struct seq_file;
 113
 114 struct ftrace_probe_ops {
 115         void                    (*func)(unsigned long ip,
 116                                         unsigned long parent_ip,
 117                                         void **data);
 118         int                     (*callback)(unsigned long ip, void **data);
 119         void                    (*free)(void **data);
 120         int                     (*print)(struct seq_file *m,
 121                                          unsigned long ip,
 122                                          struct ftrace_probe_ops *ops,
 123                                          void *data);
 124 };
 125
 126 extern int
 127 register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
 128                               void *data);
 129 extern void
 130 unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
 131                                 void *data);
 132 extern void
 133 unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
 134 extern void unregister_ftrace_function_probe_all(char *glob);
 135
 136 enum {
 137         FTRACE_FL_FREE          = (1 << 0),
 138         FTRACE_FL_FAILED        = (1 << 1),
 139         FTRACE_FL_FILTER        = (1 << 2),
 140         FTRACE_FL_ENABLED       = (1 << 3),
 141         FTRACE_FL_NOTRACE       = (1 << 4),
 142         FTRACE_FL_CONVERTED     = (1 << 5),
 143         FTRACE_FL_FROZEN        = (1 << 6),
 144 };
 145
 146 struct dyn_ftrace {
 147         struct list_head        list;
 148         unsigned long           ip; /* address of mcount call-site */
 149         unsigned long           flags;
 150         struct dyn_arch_ftrace  arch;
 151 };
 152
 153 int ftrace_force_update(void);
 154 void ftrace_set_filter(unsigned char *buf, int len, int reset);
 155
 156 int register_ftrace_command(struct ftrace_func_command *cmd);
 157 int unregister_ftrace_command(struct ftrace_func_command *cmd);
 158
 159 /* defined in arch */
 160 extern int ftrace_ip_converted(unsigned long ip);
 161 extern int ftrace_dyn_arch_init(void *data);
 162 extern int ftrace_update_ftrace_func(ftrace_func_t func);
 163 extern void ftrace_caller(void);
 164 extern void ftrace_call(void);
 165 extern void mcount_call(void);
 166
 167 #ifndef FTRACE_ADDR
 168 #define FTRACE_ADDR ((unsigned long)ftrace_caller)
 169 #endif
 170 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 171 extern void ftrace_graph_caller(void);
 172 extern int ftrace_enable_ftrace_graph_caller(void);
 173 extern int ftrace_disable_ftrace_graph_caller(void);
 174 #else
 175 static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
 176 static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
 177 #endif
 178
 179 /**
 180  * ftrace_make_nop - convert code into nop
 181  * @mod: module structure if called by module load initialization
 182  * @rec: the mcount call site record
 183  * @addr: the address that the call site should be calling
 184  *
 185  * This is a very sensitive operation and great care needs
 186  * to be taken by the arch.  The operation should carefully
 187  * read the location, check to see if what is read is indeed
 188  * what we expect it to be, and then on success of the compare,
 189  * it should write to the location.
 190  *
 191  * The code segment at @rec->ip should be a caller to @addr
 192  *
 193  * Return must be:
 194  *  0 on success
 195  *  -EFAULT on error reading the location
 196  *  -EINVAL on a failed compare of the contents
 197  *  -EPERM  on error writing to the location
 198  * Any other value will be considered a failure.
 199  */
 200 extern int ftrace_make_nop(struct module *mod,
 201                            struct dyn_ftrace *rec, unsigned long addr);
 202
 203 /**
 204  * ftrace_make_call - convert a nop call site into a call to addr
 205  * @rec: the mcount call site record
 206  * @addr: the address that the call site should call
 207  *
 208  * This is a very sensitive operation and great care needs
 209  * to be taken by the arch.  The operation should carefully
 210  * read the location, check to see if what is read is indeed
 211  * what we expect it to be, and then on success of the compare,
 212  * it should write to the location.
 213  *
 214  * The code segment at @rec->ip should be a nop
 215  *
 216  * Return must be:
 217  *  0 on success
 218  *  -EFAULT on error reading the location
 219  *  -EINVAL on a failed compare of the contents
 220  *  -EPERM  on error writing to the location
 221  * Any other value will be considered a failure.
 222  */
 223 extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
 224
 225
 226 /* May be defined in arch */
 227 extern int ftrace_arch_read_dyn_info(char *buf, int size);
 228
 229 extern int skip_trace(unsigned long ip);
 230
 231 extern void ftrace_release(void *start, unsigned long size);
 232
 233 extern void ftrace_disable_daemon(void);
 234 extern void ftrace_enable_daemon(void);
 235 #else
 236 # define skip_trace(ip)                         ({ 0; })
 237 # define ftrace_force_update()                  ({ 0; })
 238 # define ftrace_set_filter(buf, len, reset)     do { } while (0)
 239 # define ftrace_disable_daemon()                do { } while (0)
 240 # define ftrace_enable_daemon()                 do { } while (0)
 241 static inline void ftrace_release(void *start, unsigned long size) { }
 242 static inline int register_ftrace_command(struct ftrace_func_command *cmd)
 243 {
 244         return -EINVAL;
 245 }
 246 static inline int unregister_ftrace_command(char *cmd_name)
 247 {
 248         return -EINVAL;
 249 }
 250 #endif /* CONFIG_DYNAMIC_FTRACE */
 251
 252 /* totally disable ftrace - can not re-enable after this */
 253 void ftrace_kill(void);
 254
 255 static inline void tracer_disable(void)
 256 {
 257 #ifdef CONFIG_FUNCTION_TRACER
 258         ftrace_enabled = 0;
 259 #endif
 260 }
 261
 262 /*
 263  * Ftrace disable/restore without lock. Some synchronization mechanism
 264  * must be used to prevent ftrace_enabled to be changed between
 265  * disable/restore.
 266  */
 267 static inline int __ftrace_enabled_save(void)
 268 {
 269 #ifdef CONFIG_FUNCTION_TRACER
 270         int saved_ftrace_enabled = ftrace_enabled;
 271         ftrace_enabled = 0;
 272         return saved_ftrace_enabled;
 273 #else
 274         return 0;
 275 #endif
 276 }
 277
 278 static inline void __ftrace_enabled_restore(int enabled)
 279 {
 280 #ifdef CONFIG_FUNCTION_TRACER
 281         ftrace_enabled = enabled;
 282 #endif
 283 }
 284
 285 #ifndef HAVE_ARCH_CALLER_ADDR
 286 # ifdef CONFIG_FRAME_POINTER
 287 #  define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
 288 #  define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
 289 #  define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
 290 #  define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
 291 #  define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
 292 #  define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
 293 #  define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
 294 # else
 295 #  define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
 296 #  define CALLER_ADDR1 0UL
 297 #  define CALLER_ADDR2 0UL
 298 #  define CALLER_ADDR3 0UL
 299 #  define CALLER_ADDR4 0UL
 300 #  define CALLER_ADDR5 0UL
 301 #  define CALLER_ADDR6 0UL
 302 # endif
 303 #endif /* ifndef HAVE_ARCH_CALLER_ADDR */
 304
 305 #ifdef CONFIG_IRQSOFF_TRACER
 306   extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
 307   extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
 308 #else
 309 # define time_hardirqs_on(a0, a1)               do { } while (0)
 310 # define time_hardirqs_off(a0, a1)              do { } while (0)
 311 #endif
 312
 313 #ifdef CONFIG_PREEMPT_TRACER
 314   extern void trace_preempt_on(unsigned long a0, unsigned long a1);
 315   extern void trace_preempt_off(unsigned long a0, unsigned long a1);
 316 #else
 317 # define trace_preempt_on(a0, a1)               do { } while (0)
 318 # define trace_preempt_off(a0, a1)              do { } while (0)
 319 #endif
 320
 321 #ifdef CONFIG_TRACING
 322 extern int ftrace_dump_on_oops;
 323
 324 extern void tracing_start(void);
 325 extern void tracing_stop(void);
 326 extern void ftrace_off_permanent(void);
 327
 328 extern void
 329 ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
 330
 331 /**
 332  * trace_printk - printf formatting in the ftrace buffer
 333  * @fmt: the printf format for printing
 334  *
 335  * Note: __trace_printk is an internal function for trace_printk and
 336  *       the @ip is passed in via the trace_printk macro.
 337  *
 338  * This function allows a kernel developer to debug fast path sections
 339  * that printk is not appropriate for. By scattering in various
 340  * printk like tracing in the code, a developer can quickly see
 341  * where problems are occurring.
 342  *
 343  * This is intended as a debugging tool for the developer only.
 344  * Please refrain from leaving trace_printks scattered around in
 345  * your code.
 346  */
 347 # define trace_printk(fmt...) __trace_printk(_THIS_IP_, fmt)
 348 extern int
 349 __trace_printk(unsigned long ip, const char *fmt, ...)
 350         __attribute__ ((format (printf, 2, 3)));
 351 # define ftrace_vprintk(fmt, ap) __trace_printk(_THIS_IP_, fmt, ap)
 352 extern int
 353 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
 354 extern void ftrace_dump(void);
 355 #else
 356 static inline void
 357 ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
 358 static inline int
 359 trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
 360
 361 static inline void tracing_start(void) { }
 362 static inline void tracing_stop(void) { }
 363 static inline void ftrace_off_permanent(void) { }
 364 static inline int
 365 trace_printk(const char *fmt, ...)
 366 {
 367         return 0;
 368 }
 369 static inline int
 370 ftrace_vprintk(const char *fmt, va_list ap)
 371 {
 372         return 0;
 373 }
 374 static inline void ftrace_dump(void) { }
 375 #endif
 376
 377 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 378 extern void ftrace_init(void);
 379 extern void ftrace_init_module(struct module *mod,
 380                                unsigned long *start, unsigned long *end);
 381 #else
 382 static inline void ftrace_init(void) { }
 383 static inline void
 384 ftrace_init_module(struct module *mod,
 385                    unsigned long *start, unsigned long *end) { }
 386 #endif
 387
 388 /*
 389  * Structure that defines an entry function trace.
 390  */
 391 struct ftrace_graph_ent {
 392         unsigned long func; /* Current function */
 393         int depth;
 394 };
 395
 396 /*
 397  * Structure that defines a return function trace.
 398  */
 399 struct ftrace_graph_ret {
 400         unsigned long func; /* Current function */
 401         unsigned long long calltime;
 402         unsigned long long rettime;
 403         /* Number of functions that overran the depth limit for current task */
 404         unsigned long overrun;
 405         int depth;
 406 };
 407
 408 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 409
 410 /*
 411  * Stack of return addresses for functions
 412  * of a thread.
 413  * Used in struct thread_info
 414  */
 415 struct ftrace_ret_stack {
 416         unsigned long ret;
 417         unsigned long func;
 418         unsigned long long calltime;
 419 };
 420
 421 /*
 422  * Primary handler of a function return.
 423  * It relays on ftrace_return_to_handler.
 424  * Defined in entry_32/64.S
 425  */
 426 extern void return_to_handler(void);
 427
 428 extern int
 429 ftrace_push_return_trace(unsigned long ret, unsigned long long time,
 430                          unsigned long func, int *depth);
 431 extern void
 432 ftrace_pop_return_trace(struct ftrace_graph_ret *trace, unsigned long *ret);
 433
 434 /*
 435  * Sometimes we don't want to trace a function with the function
 436  * graph tracer but we want them to keep traced by the usual function
 437  * tracer if the function graph tracer is not configured.
 438  */
 439 #define __notrace_funcgraph             notrace
 440
 441 /*
 442  * We want to which function is an entrypoint of a hardirq.
 443  * That will help us to put a signal on output.
 444  */
 445 #define __irq_entry              __attribute__((__section__(".irqentry.text")))
 446
 447 /* Limits of hardirq entrypoints */
 448 extern char __irqentry_text_start[];
 449 extern char __irqentry_text_end[];
 450
 451 #define FTRACE_RETFUNC_DEPTH 50
 452 #define FTRACE_RETSTACK_ALLOC_SIZE 32
 453 /* Type of the callback handlers for tracing function graph*/
 454 typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
 455 typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
 456
 457 extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
 458                                 trace_func_graph_ent_t entryfunc);
 459
 460 extern void ftrace_graph_stop(void);
 461
 462 /* The current handlers in use */
 463 extern trace_func_graph_ret_t ftrace_graph_return;
 464 extern trace_func_graph_ent_t ftrace_graph_entry;
 465
 466 extern void unregister_ftrace_graph(void);
 467
 468 extern void ftrace_graph_init_task(struct task_struct *t);
 469 extern void ftrace_graph_exit_task(struct task_struct *t);
 470
 471 static inline int task_curr_ret_stack(struct task_struct *t)
 472 {
 473         return t->curr_ret_stack;
 474 }
 475
 476 static inline void pause_graph_tracing(void)
 477 {
 478         atomic_inc(&current->tracing_graph_pause);
 479 }
 480
 481 static inline void unpause_graph_tracing(void)
 482 {
 483         atomic_dec(&current->tracing_graph_pause);
 484 }
 485 #else
 486
 487 #define __notrace_funcgraph
 488 #define __irq_entry
 489
 490 static inline void ftrace_graph_init_task(struct task_struct *t) { }
 491 static inline void ftrace_graph_exit_task(struct task_struct *t) { }
 492
 493 static inline int task_curr_ret_stack(struct task_struct *tsk)
 494 {
 495         return -1;
 496 }
 497
 498 static inline void pause_graph_tracing(void) { }
 499 static inline void unpause_graph_tracing(void) { }
 500 #endif
 501
 502 #ifdef CONFIG_TRACING
 503 #include <linux/sched.h>
 504
 505 /* flags for current->trace */
 506 enum {
 507         TSK_TRACE_FL_TRACE_BIT  = 0,
 508         TSK_TRACE_FL_GRAPH_BIT  = 1,
 509 };
 510 enum {
 511         TSK_TRACE_FL_TRACE      = 1 << TSK_TRACE_FL_TRACE_BIT,
 512         TSK_TRACE_FL_GRAPH      = 1 << TSK_TRACE_FL_GRAPH_BIT,
 513 };
 514
 515 static inline void set_tsk_trace_trace(struct task_struct *tsk)
 516 {
 517         set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
 518 }
 519
 520 static inline void clear_tsk_trace_trace(struct task_struct *tsk)
 521 {
 522         clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
 523 }
 524
 525 static inline int test_tsk_trace_trace(struct task_struct *tsk)
 526 {
 527         return tsk->trace & TSK_TRACE_FL_TRACE;
 528 }
 529
 530 static inline void set_tsk_trace_graph(struct task_struct *tsk)
 531 {
 532         set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
 533 }
 534
 535 static inline void clear_tsk_trace_graph(struct task_struct *tsk)
 536 {
 537         clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
 538 }
 539
 540 static inline int test_tsk_trace_graph(struct task_struct *tsk)
 541 {
 542         return tsk->trace & TSK_TRACE_FL_GRAPH;
 543 }
 544
 545 #endif /* CONFIG_TRACING */
 546
 547
 548 #ifdef CONFIG_HW_BRANCH_TRACER
 549
 550 void trace_hw_branch(u64 from, u64 to);
 551 void trace_hw_branch_oops(void);
 552
 553 #else /* CONFIG_HW_BRANCH_TRACER */
 554
 555 static inline void trace_hw_branch(u64 from, u64 to) {}
 556 static inline void trace_hw_branch_oops(void) {}
 557
 558 #endif /* CONFIG_HW_BRANCH_TRACER */
 559
 560 #endif /* _LINUX_FTRACE_H */