Pileus Git - ~andy/linux/blob - include/linux/ftrace.h

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