2 * Ftrace header. For implementation details beyond the random comments
3 * scattered below, see: Documentation/trace/ftrace-design.txt
6 #ifndef _LINUX_FTRACE_H
7 #define _LINUX_FTRACE_H
9 #include <linux/trace_clock.h>
10 #include <linux/kallsyms.h>
11 #include <linux/linkage.h>
12 #include <linux/bitops.h>
13 #include <linux/ptrace.h>
14 #include <linux/ktime.h>
15 #include <linux/sched.h>
16 #include <linux/types.h>
17 #include <linux/init.h>
20 #include <asm/ftrace.h>
23 * If the arch supports passing the variable contents of
24 * function_trace_op as the third parameter back from the
25 * mcount call, then the arch should define this as 1.
27 #ifndef ARCH_SUPPORTS_FTRACE_OPS
28 #define ARCH_SUPPORTS_FTRACE_OPS 0
32 * If the arch's mcount caller does not support all of ftrace's
33 * features, then it must call an indirect function that
34 * does. Or at least does enough to prevent any unwelcomed side effects.
36 #if !ARCH_SUPPORTS_FTRACE_OPS
37 # define FTRACE_FORCE_LIST_FUNC 1
39 # define FTRACE_FORCE_LIST_FUNC 0
46 #ifdef CONFIG_FUNCTION_TRACER
48 extern int ftrace_enabled;
50 ftrace_enable_sysctl(struct ctl_table *table, int write,
51 void __user *buffer, size_t *lenp,
56 typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip,
57 struct ftrace_ops *op, struct pt_regs *regs);
59 ftrace_func_t ftrace_ops_get_func(struct ftrace_ops *ops);
62 * FTRACE_OPS_FL_* bits denote the state of ftrace_ops struct and are
63 * set in the flags member.
64 * CONTROL, SAVE_REGS, SAVE_REGS_IF_SUPPORTED, RECURSION_SAFE, STUB and
65 * IPMODIFY are a kind of attribute flags which can be set only before
66 * registering the ftrace_ops, and can not be modified while registered.
67 * Changing those attribute flags after regsitering ftrace_ops will
68 * cause unexpected results.
70 * ENABLED - set/unset when ftrace_ops is registered/unregistered
71 * DYNAMIC - set when ftrace_ops is registered to denote dynamically
72 * allocated ftrace_ops which need special care
73 * CONTROL - set manualy by ftrace_ops user to denote the ftrace_ops
74 * could be controled by following calls:
75 * ftrace_function_local_enable
76 * ftrace_function_local_disable
77 * SAVE_REGS - The ftrace_ops wants regs saved at each function called
78 * and passed to the callback. If this flag is set, but the
79 * architecture does not support passing regs
80 * (CONFIG_DYNAMIC_FTRACE_WITH_REGS is not defined), then the
81 * ftrace_ops will fail to register, unless the next flag
83 * SAVE_REGS_IF_SUPPORTED - This is the same as SAVE_REGS, but if the
84 * handler can handle an arch that does not save regs
85 * (the handler tests if regs == NULL), then it can set
86 * this flag instead. It will not fail registering the ftrace_ops
87 * but, the regs field will be NULL if the arch does not support
88 * passing regs to the handler.
89 * Note, if this flag is set, the SAVE_REGS flag will automatically
90 * get set upon registering the ftrace_ops, if the arch supports it.
91 * RECURSION_SAFE - The ftrace_ops can set this to tell the ftrace infrastructure
92 * that the call back has its own recursion protection. If it does
93 * not set this, then the ftrace infrastructure will add recursion
94 * protection for the caller.
95 * STUB - The ftrace_ops is just a place holder.
96 * INITIALIZED - The ftrace_ops has already been initialized (first use time
97 * register_ftrace_function() is called, it will initialized the ops)
98 * DELETED - The ops are being deleted, do not let them be registered again.
99 * ADDING - The ops is in the process of being added.
100 * REMOVING - The ops is in the process of being removed.
101 * MODIFYING - The ops is in the process of changing its filter functions.
102 * ALLOC_TRAMP - A dynamic trampoline was allocated by the core code.
103 * The arch specific code sets this flag when it allocated a
104 * trampoline. This lets the arch know that it can update the
105 * trampoline in case the callback function changes.
106 * The ftrace_ops trampoline can be set by the ftrace users, and
107 * in such cases the arch must not modify it. Only the arch ftrace
108 * core code should set this flag.
109 * IPMODIFY - The ops can modify the IP register. This can only be set with
110 * SAVE_REGS. If another ops with this flag set is already registered
111 * for any of the functions that this ops will be registered for, then
112 * this ops will fail to register or set_filter_ip.
115 FTRACE_OPS_FL_ENABLED = 1 << 0,
116 FTRACE_OPS_FL_DYNAMIC = 1 << 1,
117 FTRACE_OPS_FL_CONTROL = 1 << 2,
118 FTRACE_OPS_FL_SAVE_REGS = 1 << 3,
119 FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED = 1 << 4,
120 FTRACE_OPS_FL_RECURSION_SAFE = 1 << 5,
121 FTRACE_OPS_FL_STUB = 1 << 6,
122 FTRACE_OPS_FL_INITIALIZED = 1 << 7,
123 FTRACE_OPS_FL_DELETED = 1 << 8,
124 FTRACE_OPS_FL_ADDING = 1 << 9,
125 FTRACE_OPS_FL_REMOVING = 1 << 10,
126 FTRACE_OPS_FL_MODIFYING = 1 << 11,
127 FTRACE_OPS_FL_ALLOC_TRAMP = 1 << 12,
128 FTRACE_OPS_FL_IPMODIFY = 1 << 13,
131 #ifdef CONFIG_DYNAMIC_FTRACE
132 /* The hash used to know what functions callbacks trace */
133 struct ftrace_ops_hash {
134 struct ftrace_hash *notrace_hash;
135 struct ftrace_hash *filter_hash;
136 struct mutex regex_lock;
141 * Note, ftrace_ops can be referenced outside of RCU protection.
142 * (Although, for perf, the control ops prevent that). If ftrace_ops is
143 * allocated and not part of kernel core data, the unregistering of it will
144 * perform a scheduling on all CPUs to make sure that there are no more users.
145 * Depending on the load of the system that may take a bit of time.
147 * Any private data added must also take care not to be freed and if private
148 * data is added to a ftrace_ops that is in core code, the user of the
149 * ftrace_ops must perform a schedule_on_each_cpu() before freeing it.
153 struct ftrace_ops *next;
156 int __percpu *disabled;
157 #ifdef CONFIG_DYNAMIC_FTRACE
159 struct ftrace_ops_hash local_hash;
160 struct ftrace_ops_hash *func_hash;
161 struct ftrace_ops_hash old_hash;
162 unsigned long trampoline;
163 unsigned long trampoline_size;
168 * Type of the current tracing.
170 enum ftrace_tracing_type_t {
171 FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
172 FTRACE_TYPE_RETURN, /* Hook the return of the function */
175 /* Current tracing type, default is FTRACE_TYPE_ENTER */
176 extern enum ftrace_tracing_type_t ftrace_tracing_type;
179 * The ftrace_ops must be a static and should also
180 * be read_mostly. These functions do modify read_mostly variables
181 * so use them sparely. Never free an ftrace_op or modify the
182 * next pointer after it has been registered. Even after unregistering
183 * it, the next pointer may still be used internally.
185 int register_ftrace_function(struct ftrace_ops *ops);
186 int unregister_ftrace_function(struct ftrace_ops *ops);
187 void clear_ftrace_function(void);
190 * ftrace_function_local_enable - enable controlled ftrace_ops on current cpu
192 * This function enables tracing on current cpu by decreasing
193 * the per cpu control variable.
194 * It must be called with preemption disabled and only on ftrace_ops
195 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
196 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
198 static inline void ftrace_function_local_enable(struct ftrace_ops *ops)
200 if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
203 (*this_cpu_ptr(ops->disabled))--;
207 * ftrace_function_local_disable - enable controlled ftrace_ops on current cpu
209 * This function enables tracing on current cpu by decreasing
210 * the per cpu control variable.
211 * It must be called with preemption disabled and only on ftrace_ops
212 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
213 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
215 static inline void ftrace_function_local_disable(struct ftrace_ops *ops)
217 if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
220 (*this_cpu_ptr(ops->disabled))++;
224 * ftrace_function_local_disabled - returns ftrace_ops disabled value
227 * This function returns value of ftrace_ops::disabled on current cpu.
228 * It must be called with preemption disabled and only on ftrace_ops
229 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
230 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
232 static inline int ftrace_function_local_disabled(struct ftrace_ops *ops)
234 WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL));
235 return *this_cpu_ptr(ops->disabled);
238 extern void ftrace_stub(unsigned long a0, unsigned long a1,
239 struct ftrace_ops *op, struct pt_regs *regs);
241 #else /* !CONFIG_FUNCTION_TRACER */
243 * (un)register_ftrace_function must be a macro since the ops parameter
244 * must not be evaluated.
246 #define register_ftrace_function(ops) ({ 0; })
247 #define unregister_ftrace_function(ops) ({ 0; })
248 static inline int ftrace_nr_registered_ops(void)
252 static inline void clear_ftrace_function(void) { }
253 static inline void ftrace_kill(void) { }
254 #endif /* CONFIG_FUNCTION_TRACER */
256 #ifdef CONFIG_STACK_TRACER
257 extern int stack_tracer_enabled;
259 stack_trace_sysctl(struct ctl_table *table, int write,
260 void __user *buffer, size_t *lenp,
264 struct ftrace_func_command {
265 struct list_head list;
267 int (*func)(struct ftrace_hash *hash,
268 char *func, char *cmd,
269 char *params, int enable);
272 #ifdef CONFIG_DYNAMIC_FTRACE
274 int ftrace_arch_code_modify_prepare(void);
275 int ftrace_arch_code_modify_post_process(void);
279 void ftrace_bug(int err, struct dyn_ftrace *rec);
283 struct ftrace_probe_ops {
284 void (*func)(unsigned long ip,
285 unsigned long parent_ip,
287 int (*init)(struct ftrace_probe_ops *ops,
288 unsigned long ip, void **data);
289 void (*free)(struct ftrace_probe_ops *ops,
290 unsigned long ip, void **data);
291 int (*print)(struct seq_file *m,
293 struct ftrace_probe_ops *ops,
298 register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
301 unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
304 unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
305 extern void unregister_ftrace_function_probe_all(char *glob);
307 extern int ftrace_text_reserved(const void *start, const void *end);
309 extern int ftrace_nr_registered_ops(void);
311 bool is_ftrace_trampoline(unsigned long addr);
314 * The dyn_ftrace record's flags field is split into two parts.
315 * the first part which is '0-FTRACE_REF_MAX' is a counter of
316 * the number of callbacks that have registered the function that
317 * the dyn_ftrace descriptor represents.
319 * The second part is a mask:
320 * ENABLED - the function is being traced
321 * REGS - the record wants the function to save regs
322 * REGS_EN - the function is set up to save regs.
323 * IPMODIFY - the record allows for the IP address to be changed.
325 * When a new ftrace_ops is registered and wants a function to save
326 * pt_regs, the rec->flag REGS is set. When the function has been
327 * set up to save regs, the REG_EN flag is set. Once a function
328 * starts saving regs it will do so until all ftrace_ops are removed
329 * from tracing that function.
332 FTRACE_FL_ENABLED = (1UL << 31),
333 FTRACE_FL_REGS = (1UL << 30),
334 FTRACE_FL_REGS_EN = (1UL << 29),
335 FTRACE_FL_TRAMP = (1UL << 28),
336 FTRACE_FL_TRAMP_EN = (1UL << 27),
337 FTRACE_FL_IPMODIFY = (1UL << 26),
340 #define FTRACE_REF_MAX_SHIFT 26
341 #define FTRACE_FL_BITS 6
342 #define FTRACE_FL_MASKED_BITS ((1UL << FTRACE_FL_BITS) - 1)
343 #define FTRACE_FL_MASK (FTRACE_FL_MASKED_BITS << FTRACE_REF_MAX_SHIFT)
344 #define FTRACE_REF_MAX ((1UL << FTRACE_REF_MAX_SHIFT) - 1)
346 #define ftrace_rec_count(rec) ((rec)->flags & ~FTRACE_FL_MASK)
349 unsigned long ip; /* address of mcount call-site */
351 struct dyn_arch_ftrace arch;
354 int ftrace_force_update(void);
355 int ftrace_set_filter_ip(struct ftrace_ops *ops, unsigned long ip,
356 int remove, int reset);
357 int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
359 int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
361 void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
362 void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
363 void ftrace_free_filter(struct ftrace_ops *ops);
365 int register_ftrace_command(struct ftrace_func_command *cmd);
366 int unregister_ftrace_command(struct ftrace_func_command *cmd);
369 FTRACE_UPDATE_CALLS = (1 << 0),
370 FTRACE_DISABLE_CALLS = (1 << 1),
371 FTRACE_UPDATE_TRACE_FUNC = (1 << 2),
372 FTRACE_START_FUNC_RET = (1 << 3),
373 FTRACE_STOP_FUNC_RET = (1 << 4),
377 * The FTRACE_UPDATE_* enum is used to pass information back
378 * from the ftrace_update_record() and ftrace_test_record()
379 * functions. These are called by the code update routines
380 * to find out what is to be done for a given function.
382 * IGNORE - The function is already what we want it to be
383 * MAKE_CALL - Start tracing the function
384 * MODIFY_CALL - Stop saving regs for the function
385 * MAKE_NOP - Stop tracing the function
388 FTRACE_UPDATE_IGNORE,
389 FTRACE_UPDATE_MAKE_CALL,
390 FTRACE_UPDATE_MODIFY_CALL,
391 FTRACE_UPDATE_MAKE_NOP,
395 FTRACE_ITER_FILTER = (1 << 0),
396 FTRACE_ITER_NOTRACE = (1 << 1),
397 FTRACE_ITER_PRINTALL = (1 << 2),
398 FTRACE_ITER_DO_HASH = (1 << 3),
399 FTRACE_ITER_HASH = (1 << 4),
400 FTRACE_ITER_ENABLED = (1 << 5),
403 void arch_ftrace_update_code(int command);
405 struct ftrace_rec_iter;
407 struct ftrace_rec_iter *ftrace_rec_iter_start(void);
408 struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter);
409 struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter);
411 #define for_ftrace_rec_iter(iter) \
412 for (iter = ftrace_rec_iter_start(); \
414 iter = ftrace_rec_iter_next(iter))
417 int ftrace_update_record(struct dyn_ftrace *rec, int enable);
418 int ftrace_test_record(struct dyn_ftrace *rec, int enable);
419 void ftrace_run_stop_machine(int command);
420 unsigned long ftrace_location(unsigned long ip);
421 unsigned long ftrace_get_addr_new(struct dyn_ftrace *rec);
422 unsigned long ftrace_get_addr_curr(struct dyn_ftrace *rec);
424 extern ftrace_func_t ftrace_trace_function;
426 int ftrace_regex_open(struct ftrace_ops *ops, int flag,
427 struct inode *inode, struct file *file);
428 ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
429 size_t cnt, loff_t *ppos);
430 ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
431 size_t cnt, loff_t *ppos);
432 int ftrace_regex_release(struct inode *inode, struct file *file);
435 ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable);
437 /* defined in arch */
438 extern int ftrace_ip_converted(unsigned long ip);
439 extern int ftrace_dyn_arch_init(void);
440 extern void ftrace_replace_code(int enable);
441 extern int ftrace_update_ftrace_func(ftrace_func_t func);
442 extern void ftrace_caller(void);
443 extern void ftrace_regs_caller(void);
444 extern void ftrace_call(void);
445 extern void ftrace_regs_call(void);
446 extern void mcount_call(void);
448 void ftrace_modify_all_code(int command);
451 #define FTRACE_ADDR ((unsigned long)ftrace_caller)
454 #ifndef FTRACE_GRAPH_ADDR
455 #define FTRACE_GRAPH_ADDR ((unsigned long)ftrace_graph_caller)
458 #ifndef FTRACE_REGS_ADDR
459 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
460 # define FTRACE_REGS_ADDR ((unsigned long)ftrace_regs_caller)
462 # define FTRACE_REGS_ADDR FTRACE_ADDR
467 * If an arch would like functions that are only traced
468 * by the function graph tracer to jump directly to its own
469 * trampoline, then they can define FTRACE_GRAPH_TRAMP_ADDR
470 * to be that address to jump to.
472 #ifndef FTRACE_GRAPH_TRAMP_ADDR
473 #define FTRACE_GRAPH_TRAMP_ADDR ((unsigned long) 0)
476 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
477 extern void ftrace_graph_caller(void);
478 extern int ftrace_enable_ftrace_graph_caller(void);
479 extern int ftrace_disable_ftrace_graph_caller(void);
481 static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
482 static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
486 * ftrace_make_nop - convert code into nop
487 * @mod: module structure if called by module load initialization
488 * @rec: the mcount call site record
489 * @addr: the address that the call site should be calling
491 * This is a very sensitive operation and great care needs
492 * to be taken by the arch. The operation should carefully
493 * read the location, check to see if what is read is indeed
494 * what we expect it to be, and then on success of the compare,
495 * it should write to the location.
497 * The code segment at @rec->ip should be a caller to @addr
501 * -EFAULT on error reading the location
502 * -EINVAL on a failed compare of the contents
503 * -EPERM on error writing to the location
504 * Any other value will be considered a failure.
506 extern int ftrace_make_nop(struct module *mod,
507 struct dyn_ftrace *rec, unsigned long addr);
510 * ftrace_make_call - convert a nop call site into a call to addr
511 * @rec: the mcount call site record
512 * @addr: the address that the call site should call
514 * This is a very sensitive operation and great care needs
515 * to be taken by the arch. The operation should carefully
516 * read the location, check to see if what is read is indeed
517 * what we expect it to be, and then on success of the compare,
518 * it should write to the location.
520 * The code segment at @rec->ip should be a nop
524 * -EFAULT on error reading the location
525 * -EINVAL on a failed compare of the contents
526 * -EPERM on error writing to the location
527 * Any other value will be considered a failure.
529 extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
531 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
533 * ftrace_modify_call - convert from one addr to another (no nop)
534 * @rec: the mcount call site record
535 * @old_addr: the address expected to be currently called to
536 * @addr: the address to change to
538 * This is a very sensitive operation and great care needs
539 * to be taken by the arch. The operation should carefully
540 * read the location, check to see if what is read is indeed
541 * what we expect it to be, and then on success of the compare,
542 * it should write to the location.
544 * The code segment at @rec->ip should be a caller to @old_addr
548 * -EFAULT on error reading the location
549 * -EINVAL on a failed compare of the contents
550 * -EPERM on error writing to the location
551 * Any other value will be considered a failure.
553 extern int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
556 /* Should never be called */
557 static inline int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
564 /* May be defined in arch */
565 extern int ftrace_arch_read_dyn_info(char *buf, int size);
567 extern int skip_trace(unsigned long ip);
568 extern void ftrace_module_init(struct module *mod);
570 extern void ftrace_disable_daemon(void);
571 extern void ftrace_enable_daemon(void);
572 #else /* CONFIG_DYNAMIC_FTRACE */
573 static inline int skip_trace(unsigned long ip) { return 0; }
574 static inline int ftrace_force_update(void) { return 0; }
575 static inline void ftrace_disable_daemon(void) { }
576 static inline void ftrace_enable_daemon(void) { }
577 static inline void ftrace_release_mod(struct module *mod) {}
578 static inline void ftrace_module_init(struct module *mod) {}
579 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
583 static inline __init int unregister_ftrace_command(char *cmd_name)
587 static inline int ftrace_text_reserved(const void *start, const void *end)
591 static inline unsigned long ftrace_location(unsigned long ip)
597 * Again users of functions that have ftrace_ops may not
598 * have them defined when ftrace is not enabled, but these
599 * functions may still be called. Use a macro instead of inline.
601 #define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; })
602 #define ftrace_set_early_filter(ops, buf, enable) do { } while (0)
603 #define ftrace_set_filter_ip(ops, ip, remove, reset) ({ -ENODEV; })
604 #define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; })
605 #define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; })
606 #define ftrace_free_filter(ops) do { } while (0)
608 static inline ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
609 size_t cnt, loff_t *ppos) { return -ENODEV; }
610 static inline ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
611 size_t cnt, loff_t *ppos) { return -ENODEV; }
613 ftrace_regex_release(struct inode *inode, struct file *file) { return -ENODEV; }
615 static inline bool is_ftrace_trampoline(unsigned long addr)
619 #endif /* CONFIG_DYNAMIC_FTRACE */
621 /* totally disable ftrace - can not re-enable after this */
622 void ftrace_kill(void);
624 static inline void tracer_disable(void)
626 #ifdef CONFIG_FUNCTION_TRACER
632 * Ftrace disable/restore without lock. Some synchronization mechanism
633 * must be used to prevent ftrace_enabled to be changed between
636 static inline int __ftrace_enabled_save(void)
638 #ifdef CONFIG_FUNCTION_TRACER
639 int saved_ftrace_enabled = ftrace_enabled;
641 return saved_ftrace_enabled;
647 static inline void __ftrace_enabled_restore(int enabled)
649 #ifdef CONFIG_FUNCTION_TRACER
650 ftrace_enabled = enabled;
654 /* All archs should have this, but we define it for consistency */
655 #ifndef ftrace_return_address0
656 # define ftrace_return_address0 __builtin_return_address(0)
659 /* Archs may use other ways for ADDR1 and beyond */
660 #ifndef ftrace_return_address
661 # ifdef CONFIG_FRAME_POINTER
662 # define ftrace_return_address(n) __builtin_return_address(n)
664 # define ftrace_return_address(n) 0UL
668 #define CALLER_ADDR0 ((unsigned long)ftrace_return_address0)
669 #define CALLER_ADDR1 ((unsigned long)ftrace_return_address(1))
670 #define CALLER_ADDR2 ((unsigned long)ftrace_return_address(2))
671 #define CALLER_ADDR3 ((unsigned long)ftrace_return_address(3))
672 #define CALLER_ADDR4 ((unsigned long)ftrace_return_address(4))
673 #define CALLER_ADDR5 ((unsigned long)ftrace_return_address(5))
674 #define CALLER_ADDR6 ((unsigned long)ftrace_return_address(6))
676 #ifdef CONFIG_IRQSOFF_TRACER
677 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
678 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
680 static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
681 static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
684 #ifdef CONFIG_PREEMPT_TRACER
685 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
686 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
689 * Use defines instead of static inlines because some arches will make code out
690 * of the CALLER_ADDR, when we really want these to be a real nop.
692 # define trace_preempt_on(a0, a1) do { } while (0)
693 # define trace_preempt_off(a0, a1) do { } while (0)
696 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
697 extern void ftrace_init(void);
699 static inline void ftrace_init(void) { }
703 * Structure that defines an entry function trace.
705 struct ftrace_graph_ent {
706 unsigned long func; /* Current function */
711 * Structure that defines a return function trace.
713 struct ftrace_graph_ret {
714 unsigned long func; /* Current function */
715 unsigned long long calltime;
716 unsigned long long rettime;
717 /* Number of functions that overran the depth limit for current task */
718 unsigned long overrun;
722 /* Type of the callback handlers for tracing function graph*/
723 typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
724 typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
726 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
729 #define INIT_FTRACE_GRAPH .ret_stack = NULL,
732 * Stack of return addresses for functions
734 * Used in struct thread_info
736 struct ftrace_ret_stack {
739 unsigned long long calltime;
740 unsigned long long subtime;
745 * Primary handler of a function return.
746 * It relays on ftrace_return_to_handler.
747 * Defined in entry_32/64.S
749 extern void return_to_handler(void);
752 ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
753 unsigned long frame_pointer);
756 * Sometimes we don't want to trace a function with the function
757 * graph tracer but we want them to keep traced by the usual function
758 * tracer if the function graph tracer is not configured.
760 #define __notrace_funcgraph notrace
763 * We want to which function is an entrypoint of a hardirq.
764 * That will help us to put a signal on output.
766 #define __irq_entry __attribute__((__section__(".irqentry.text")))
768 /* Limits of hardirq entrypoints */
769 extern char __irqentry_text_start[];
770 extern char __irqentry_text_end[];
772 #define FTRACE_NOTRACE_DEPTH 65536
773 #define FTRACE_RETFUNC_DEPTH 50
774 #define FTRACE_RETSTACK_ALLOC_SIZE 32
775 extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
776 trace_func_graph_ent_t entryfunc);
778 extern bool ftrace_graph_is_dead(void);
779 extern void ftrace_graph_stop(void);
781 /* The current handlers in use */
782 extern trace_func_graph_ret_t ftrace_graph_return;
783 extern trace_func_graph_ent_t ftrace_graph_entry;
785 extern void unregister_ftrace_graph(void);
787 extern void ftrace_graph_init_task(struct task_struct *t);
788 extern void ftrace_graph_exit_task(struct task_struct *t);
789 extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
791 static inline int task_curr_ret_stack(struct task_struct *t)
793 return t->curr_ret_stack;
796 static inline void pause_graph_tracing(void)
798 atomic_inc(¤t->tracing_graph_pause);
801 static inline void unpause_graph_tracing(void)
803 atomic_dec(¤t->tracing_graph_pause);
805 #else /* !CONFIG_FUNCTION_GRAPH_TRACER */
807 #define __notrace_funcgraph
809 #define INIT_FTRACE_GRAPH
811 static inline void ftrace_graph_init_task(struct task_struct *t) { }
812 static inline void ftrace_graph_exit_task(struct task_struct *t) { }
813 static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
815 static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
816 trace_func_graph_ent_t entryfunc)
820 static inline void unregister_ftrace_graph(void) { }
822 static inline int task_curr_ret_stack(struct task_struct *tsk)
827 static inline void pause_graph_tracing(void) { }
828 static inline void unpause_graph_tracing(void) { }
829 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
831 #ifdef CONFIG_TRACING
833 /* flags for current->trace */
835 TSK_TRACE_FL_TRACE_BIT = 0,
836 TSK_TRACE_FL_GRAPH_BIT = 1,
839 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
840 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
843 static inline void set_tsk_trace_trace(struct task_struct *tsk)
845 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
848 static inline void clear_tsk_trace_trace(struct task_struct *tsk)
850 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
853 static inline int test_tsk_trace_trace(struct task_struct *tsk)
855 return tsk->trace & TSK_TRACE_FL_TRACE;
858 static inline void set_tsk_trace_graph(struct task_struct *tsk)
860 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
863 static inline void clear_tsk_trace_graph(struct task_struct *tsk)
865 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
868 static inline int test_tsk_trace_graph(struct task_struct *tsk)
870 return tsk->trace & TSK_TRACE_FL_GRAPH;
873 enum ftrace_dump_mode;
875 extern enum ftrace_dump_mode ftrace_dump_on_oops;
877 extern void disable_trace_on_warning(void);
878 extern int __disable_trace_on_warning;
880 #ifdef CONFIG_PREEMPT
881 #define INIT_TRACE_RECURSION .trace_recursion = 0,
884 #else /* CONFIG_TRACING */
885 static inline void disable_trace_on_warning(void) { }
886 #endif /* CONFIG_TRACING */
888 #ifndef INIT_TRACE_RECURSION
889 #define INIT_TRACE_RECURSION
892 #ifdef CONFIG_FTRACE_SYSCALLS
894 unsigned long arch_syscall_addr(int nr);
896 #endif /* CONFIG_FTRACE_SYSCALLS */
898 #endif /* _LINUX_FTRACE_H */