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