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