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