1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Ftrace header. For implementation details beyond the random comments
4 * scattered below, see: Documentation/trace/ftrace-design.txt
7 #ifndef _LINUX_FTRACE_H
8 #define _LINUX_FTRACE_H
10 #include <linux/trace_clock.h>
11 #include <linux/kallsyms.h>
12 #include <linux/linkage.h>
13 #include <linux/bitops.h>
14 #include <linux/ptrace.h>
15 #include <linux/ktime.h>
16 #include <linux/sched.h>
17 #include <linux/types.h>
18 #include <linux/init.h>
21 #include <asm/ftrace.h>
24 * If the arch supports passing the variable contents of
25 * function_trace_op as the third parameter back from the
26 * mcount call, then the arch should define this as 1.
28 #ifndef ARCH_SUPPORTS_FTRACE_OPS
29 #define ARCH_SUPPORTS_FTRACE_OPS 0
33 * If the arch's mcount caller does not support all of ftrace's
34 * features, then it must call an indirect function that
35 * does. Or at least does enough to prevent any unwelcomed side effects.
37 #if !ARCH_SUPPORTS_FTRACE_OPS
38 # define FTRACE_FORCE_LIST_FUNC 1
40 # define FTRACE_FORCE_LIST_FUNC 0
43 /* Main tracing buffer and events set up */
45 void trace_init(void);
46 void early_trace_init(void);
48 static inline void trace_init(void) { }
49 static inline void early_trace_init(void) { }
55 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_MODULES) && \
56 defined(CONFIG_DYNAMIC_FTRACE)
58 ftrace_mod_address_lookup(unsigned long addr
, unsigned long *size
,
59 unsigned long *off
, char **modname
, char *sym
);
60 int ftrace_mod_get_kallsym(unsigned int symnum
, unsigned long *value
,
61 char *type
, char *name
,
62 char *module_name
, int *exported
);
64 static inline const char *
65 ftrace_mod_address_lookup(unsigned long addr
, unsigned long *size
,
66 unsigned long *off
, char **modname
, char *sym
)
70 static inline int ftrace_mod_get_kallsym(unsigned int symnum
, unsigned long *value
,
71 char *type
, char *name
,
72 char *module_name
, int *exported
)
79 #ifdef CONFIG_FUNCTION_TRACER
81 extern int ftrace_enabled
;
83 ftrace_enable_sysctl(struct ctl_table
*table
, int write
,
84 void __user
*buffer
, size_t *lenp
,
89 typedef void (*ftrace_func_t
)(unsigned long ip
, unsigned long parent_ip
,
90 struct ftrace_ops
*op
, struct pt_regs
*regs
);
92 ftrace_func_t
ftrace_ops_get_func(struct ftrace_ops
*ops
);
95 * FTRACE_OPS_FL_* bits denote the state of ftrace_ops struct and are
96 * set in the flags member.
97 * CONTROL, SAVE_REGS, SAVE_REGS_IF_SUPPORTED, RECURSION_SAFE, STUB and
98 * IPMODIFY are a kind of attribute flags which can be set only before
99 * registering the ftrace_ops, and can not be modified while registered.
100 * Changing those attribute flags after registering ftrace_ops will
101 * cause unexpected results.
103 * ENABLED - set/unset when ftrace_ops is registered/unregistered
104 * DYNAMIC - set when ftrace_ops is registered to denote dynamically
105 * allocated ftrace_ops which need special care
106 * SAVE_REGS - The ftrace_ops wants regs saved at each function called
107 * and passed to the callback. If this flag is set, but the
108 * architecture does not support passing regs
109 * (CONFIG_DYNAMIC_FTRACE_WITH_REGS is not defined), then the
110 * ftrace_ops will fail to register, unless the next flag
112 * SAVE_REGS_IF_SUPPORTED - This is the same as SAVE_REGS, but if the
113 * handler can handle an arch that does not save regs
114 * (the handler tests if regs == NULL), then it can set
115 * this flag instead. It will not fail registering the ftrace_ops
116 * but, the regs field will be NULL if the arch does not support
117 * passing regs to the handler.
118 * Note, if this flag is set, the SAVE_REGS flag will automatically
119 * get set upon registering the ftrace_ops, if the arch supports it.
120 * RECURSION_SAFE - The ftrace_ops can set this to tell the ftrace infrastructure
121 * that the call back has its own recursion protection. If it does
122 * not set this, then the ftrace infrastructure will add recursion
123 * protection for the caller.
124 * STUB - The ftrace_ops is just a place holder.
125 * INITIALIZED - The ftrace_ops has already been initialized (first use time
126 * register_ftrace_function() is called, it will initialized the ops)
127 * DELETED - The ops are being deleted, do not let them be registered again.
128 * ADDING - The ops is in the process of being added.
129 * REMOVING - The ops is in the process of being removed.
130 * MODIFYING - The ops is in the process of changing its filter functions.
131 * ALLOC_TRAMP - A dynamic trampoline was allocated by the core code.
132 * The arch specific code sets this flag when it allocated a
133 * trampoline. This lets the arch know that it can update the
134 * trampoline in case the callback function changes.
135 * The ftrace_ops trampoline can be set by the ftrace users, and
136 * in such cases the arch must not modify it. Only the arch ftrace
137 * core code should set this flag.
138 * IPMODIFY - The ops can modify the IP register. This can only be set with
139 * SAVE_REGS. If another ops with this flag set is already registered
140 * for any of the functions that this ops will be registered for, then
141 * this ops will fail to register or set_filter_ip.
142 * PID - Is affected by set_ftrace_pid (allows filtering on those pids)
143 * RCU - Set when the ops can only be called when RCU is watching.
144 * TRACE_ARRAY - The ops->private points to a trace_array descriptor.
147 FTRACE_OPS_FL_ENABLED
= 1 << 0,
148 FTRACE_OPS_FL_DYNAMIC
= 1 << 1,
149 FTRACE_OPS_FL_SAVE_REGS
= 1 << 2,
150 FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED
= 1 << 3,
151 FTRACE_OPS_FL_RECURSION_SAFE
= 1 << 4,
152 FTRACE_OPS_FL_STUB
= 1 << 5,
153 FTRACE_OPS_FL_INITIALIZED
= 1 << 6,
154 FTRACE_OPS_FL_DELETED
= 1 << 7,
155 FTRACE_OPS_FL_ADDING
= 1 << 8,
156 FTRACE_OPS_FL_REMOVING
= 1 << 9,
157 FTRACE_OPS_FL_MODIFYING
= 1 << 10,
158 FTRACE_OPS_FL_ALLOC_TRAMP
= 1 << 11,
159 FTRACE_OPS_FL_IPMODIFY
= 1 << 12,
160 FTRACE_OPS_FL_PID
= 1 << 13,
161 FTRACE_OPS_FL_RCU
= 1 << 14,
162 FTRACE_OPS_FL_TRACE_ARRAY
= 1 << 15,
165 #ifdef CONFIG_DYNAMIC_FTRACE
166 /* The hash used to know what functions callbacks trace */
167 struct ftrace_ops_hash
{
168 struct ftrace_hash __rcu
*notrace_hash
;
169 struct ftrace_hash __rcu
*filter_hash
;
170 struct mutex regex_lock
;
173 void ftrace_free_init_mem(void);
174 void ftrace_free_mem(struct module
*mod
, void *start
, void *end
);
176 static inline void ftrace_free_init_mem(void) { }
177 static inline void ftrace_free_mem(struct module
*mod
, void *start
, void *end
) { }
181 * Note, ftrace_ops can be referenced outside of RCU protection, unless
182 * the RCU flag is set. If ftrace_ops is allocated and not part of kernel
183 * core data, the unregistering of it will perform a scheduling on all CPUs
184 * to make sure that there are no more users. Depending on the load of the
185 * system that may take a bit of time.
187 * Any private data added must also take care not to be freed and if private
188 * data is added to a ftrace_ops that is in core code, the user of the
189 * ftrace_ops must perform a schedule_on_each_cpu() before freeing it.
193 struct ftrace_ops __rcu
*next
;
196 ftrace_func_t saved_func
;
197 #ifdef CONFIG_DYNAMIC_FTRACE
198 struct ftrace_ops_hash local_hash
;
199 struct ftrace_ops_hash
*func_hash
;
200 struct ftrace_ops_hash old_hash
;
201 unsigned long trampoline
;
202 unsigned long trampoline_size
;
207 * Type of the current tracing.
209 enum ftrace_tracing_type_t
{
210 FTRACE_TYPE_ENTER
= 0, /* Hook the call of the function */
211 FTRACE_TYPE_RETURN
, /* Hook the return of the function */
214 /* Current tracing type, default is FTRACE_TYPE_ENTER */
215 extern enum ftrace_tracing_type_t ftrace_tracing_type
;
218 * The ftrace_ops must be a static and should also
219 * be read_mostly. These functions do modify read_mostly variables
220 * so use them sparely. Never free an ftrace_op or modify the
221 * next pointer after it has been registered. Even after unregistering
222 * it, the next pointer may still be used internally.
224 int register_ftrace_function(struct ftrace_ops
*ops
);
225 int unregister_ftrace_function(struct ftrace_ops
*ops
);
226 void clear_ftrace_function(void);
228 extern void ftrace_stub(unsigned long a0
, unsigned long a1
,
229 struct ftrace_ops
*op
, struct pt_regs
*regs
);
231 #else /* !CONFIG_FUNCTION_TRACER */
233 * (un)register_ftrace_function must be a macro since the ops parameter
234 * must not be evaluated.
236 #define register_ftrace_function(ops) ({ 0; })
237 #define unregister_ftrace_function(ops) ({ 0; })
238 static inline int ftrace_nr_registered_ops(void)
242 static inline void clear_ftrace_function(void) { }
243 static inline void ftrace_kill(void) { }
244 static inline void ftrace_free_init_mem(void) { }
245 static inline void ftrace_free_mem(struct module
*mod
, void *start
, void *end
) { }
246 #endif /* CONFIG_FUNCTION_TRACER */
248 #ifdef CONFIG_STACK_TRACER
250 #define STACK_TRACE_ENTRIES 500
254 extern unsigned stack_trace_index
[];
255 extern struct stack_trace stack_trace_max
;
256 extern unsigned long stack_trace_max_size
;
257 extern arch_spinlock_t stack_trace_max_lock
;
259 extern int stack_tracer_enabled
;
260 void stack_trace_print(void);
262 stack_trace_sysctl(struct ctl_table
*table
, int write
,
263 void __user
*buffer
, size_t *lenp
,
266 /* DO NOT MODIFY THIS VARIABLE DIRECTLY! */
267 DECLARE_PER_CPU(int, disable_stack_tracer
);
270 * stack_tracer_disable - temporarily disable the stack tracer
272 * There's a few locations (namely in RCU) where stack tracing
273 * cannot be executed. This function is used to disable stack
274 * tracing during those critical sections.
276 * This function must be called with preemption or interrupts
277 * disabled and stack_tracer_enable() must be called shortly after
278 * while preemption or interrupts are still disabled.
280 static inline void stack_tracer_disable(void)
282 /* Preemption or interupts must be disabled */
283 if (IS_ENABLED(CONFIG_DEBUG_PREEMPT
))
284 WARN_ON_ONCE(!preempt_count() || !irqs_disabled());
285 this_cpu_inc(disable_stack_tracer
);
289 * stack_tracer_enable - re-enable the stack tracer
291 * After stack_tracer_disable() is called, stack_tracer_enable()
292 * must be called shortly afterward.
294 static inline void stack_tracer_enable(void)
296 if (IS_ENABLED(CONFIG_DEBUG_PREEMPT
))
297 WARN_ON_ONCE(!preempt_count() || !irqs_disabled());
298 this_cpu_dec(disable_stack_tracer
);
301 static inline void stack_tracer_disable(void) { }
302 static inline void stack_tracer_enable(void) { }
305 #ifdef CONFIG_DYNAMIC_FTRACE
307 int ftrace_arch_code_modify_prepare(void);
308 int ftrace_arch_code_modify_post_process(void);
312 enum ftrace_bug_type
{
319 extern enum ftrace_bug_type ftrace_bug_type
;
322 * Archs can set this to point to a variable that holds the value that was
323 * expected at the call site before calling ftrace_bug().
325 extern const void *ftrace_expected
;
327 void ftrace_bug(int err
, struct dyn_ftrace
*rec
);
331 extern int ftrace_text_reserved(const void *start
, const void *end
);
333 extern int ftrace_nr_registered_ops(void);
335 bool is_ftrace_trampoline(unsigned long addr
);
338 * The dyn_ftrace record's flags field is split into two parts.
339 * the first part which is '0-FTRACE_REF_MAX' is a counter of
340 * the number of callbacks that have registered the function that
341 * the dyn_ftrace descriptor represents.
343 * The second part is a mask:
344 * ENABLED - the function is being traced
345 * REGS - the record wants the function to save regs
346 * REGS_EN - the function is set up to save regs.
347 * IPMODIFY - the record allows for the IP address to be changed.
348 * DISABLED - the record is not ready to be touched yet
350 * When a new ftrace_ops is registered and wants a function to save
351 * pt_regs, the rec->flag REGS is set. When the function has been
352 * set up to save regs, the REG_EN flag is set. Once a function
353 * starts saving regs it will do so until all ftrace_ops are removed
354 * from tracing that function.
357 FTRACE_FL_ENABLED
= (1UL << 31),
358 FTRACE_FL_REGS
= (1UL << 30),
359 FTRACE_FL_REGS_EN
= (1UL << 29),
360 FTRACE_FL_TRAMP
= (1UL << 28),
361 FTRACE_FL_TRAMP_EN
= (1UL << 27),
362 FTRACE_FL_IPMODIFY
= (1UL << 26),
363 FTRACE_FL_DISABLED
= (1UL << 25),
366 #define FTRACE_REF_MAX_SHIFT 25
367 #define FTRACE_FL_BITS 7
368 #define FTRACE_FL_MASKED_BITS ((1UL << FTRACE_FL_BITS) - 1)
369 #define FTRACE_FL_MASK (FTRACE_FL_MASKED_BITS << FTRACE_REF_MAX_SHIFT)
370 #define FTRACE_REF_MAX ((1UL << FTRACE_REF_MAX_SHIFT) - 1)
372 #define ftrace_rec_count(rec) ((rec)->flags & ~FTRACE_FL_MASK)
375 unsigned long ip
; /* address of mcount call-site */
377 struct dyn_arch_ftrace arch
;
380 int ftrace_force_update(void);
381 int ftrace_set_filter_ip(struct ftrace_ops
*ops
, unsigned long ip
,
382 int remove
, int reset
);
383 int ftrace_set_filter(struct ftrace_ops
*ops
, unsigned char *buf
,
385 int ftrace_set_notrace(struct ftrace_ops
*ops
, unsigned char *buf
,
387 void ftrace_set_global_filter(unsigned char *buf
, int len
, int reset
);
388 void ftrace_set_global_notrace(unsigned char *buf
, int len
, int reset
);
389 void ftrace_free_filter(struct ftrace_ops
*ops
);
390 void ftrace_ops_set_global_filter(struct ftrace_ops
*ops
);
393 FTRACE_UPDATE_CALLS
= (1 << 0),
394 FTRACE_DISABLE_CALLS
= (1 << 1),
395 FTRACE_UPDATE_TRACE_FUNC
= (1 << 2),
396 FTRACE_START_FUNC_RET
= (1 << 3),
397 FTRACE_STOP_FUNC_RET
= (1 << 4),
401 * The FTRACE_UPDATE_* enum is used to pass information back
402 * from the ftrace_update_record() and ftrace_test_record()
403 * functions. These are called by the code update routines
404 * to find out what is to be done for a given function.
406 * IGNORE - The function is already what we want it to be
407 * MAKE_CALL - Start tracing the function
408 * MODIFY_CALL - Stop saving regs for the function
409 * MAKE_NOP - Stop tracing the function
412 FTRACE_UPDATE_IGNORE
,
413 FTRACE_UPDATE_MAKE_CALL
,
414 FTRACE_UPDATE_MODIFY_CALL
,
415 FTRACE_UPDATE_MAKE_NOP
,
419 FTRACE_ITER_FILTER
= (1 << 0),
420 FTRACE_ITER_NOTRACE
= (1 << 1),
421 FTRACE_ITER_PRINTALL
= (1 << 2),
422 FTRACE_ITER_DO_PROBES
= (1 << 3),
423 FTRACE_ITER_PROBE
= (1 << 4),
424 FTRACE_ITER_MOD
= (1 << 5),
425 FTRACE_ITER_ENABLED
= (1 << 6),
428 void arch_ftrace_update_code(int command
);
430 struct ftrace_rec_iter
;
432 struct ftrace_rec_iter
*ftrace_rec_iter_start(void);
433 struct ftrace_rec_iter
*ftrace_rec_iter_next(struct ftrace_rec_iter
*iter
);
434 struct dyn_ftrace
*ftrace_rec_iter_record(struct ftrace_rec_iter
*iter
);
436 #define for_ftrace_rec_iter(iter) \
437 for (iter = ftrace_rec_iter_start(); \
439 iter = ftrace_rec_iter_next(iter))
442 int ftrace_update_record(struct dyn_ftrace
*rec
, int enable
);
443 int ftrace_test_record(struct dyn_ftrace
*rec
, int enable
);
444 void ftrace_run_stop_machine(int command
);
445 unsigned long ftrace_location(unsigned long ip
);
446 unsigned long ftrace_location_range(unsigned long start
, unsigned long end
);
447 unsigned long ftrace_get_addr_new(struct dyn_ftrace
*rec
);
448 unsigned long ftrace_get_addr_curr(struct dyn_ftrace
*rec
);
450 extern ftrace_func_t ftrace_trace_function
;
452 int ftrace_regex_open(struct ftrace_ops
*ops
, int flag
,
453 struct inode
*inode
, struct file
*file
);
454 ssize_t
ftrace_filter_write(struct file
*file
, const char __user
*ubuf
,
455 size_t cnt
, loff_t
*ppos
);
456 ssize_t
ftrace_notrace_write(struct file
*file
, const char __user
*ubuf
,
457 size_t cnt
, loff_t
*ppos
);
458 int ftrace_regex_release(struct inode
*inode
, struct file
*file
);
461 ftrace_set_early_filter(struct ftrace_ops
*ops
, char *buf
, int enable
);
463 /* defined in arch */
464 extern int ftrace_ip_converted(unsigned long ip
);
465 extern int ftrace_dyn_arch_init(void);
466 extern void ftrace_replace_code(int enable
);
467 extern int ftrace_update_ftrace_func(ftrace_func_t func
);
468 extern void ftrace_caller(void);
469 extern void ftrace_regs_caller(void);
470 extern void ftrace_call(void);
471 extern void ftrace_regs_call(void);
472 extern void mcount_call(void);
474 void ftrace_modify_all_code(int command
);
477 #define FTRACE_ADDR ((unsigned long)ftrace_caller)
480 #ifndef FTRACE_GRAPH_ADDR
481 #define FTRACE_GRAPH_ADDR ((unsigned long)ftrace_graph_caller)
484 #ifndef FTRACE_REGS_ADDR
485 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
486 # define FTRACE_REGS_ADDR ((unsigned long)ftrace_regs_caller)
488 # define FTRACE_REGS_ADDR FTRACE_ADDR
493 * If an arch would like functions that are only traced
494 * by the function graph tracer to jump directly to its own
495 * trampoline, then they can define FTRACE_GRAPH_TRAMP_ADDR
496 * to be that address to jump to.
498 #ifndef FTRACE_GRAPH_TRAMP_ADDR
499 #define FTRACE_GRAPH_TRAMP_ADDR ((unsigned long) 0)
502 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
503 extern void ftrace_graph_caller(void);
504 extern int ftrace_enable_ftrace_graph_caller(void);
505 extern int ftrace_disable_ftrace_graph_caller(void);
507 static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
508 static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
512 * ftrace_make_nop - convert code into nop
513 * @mod: module structure if called by module load initialization
514 * @rec: the mcount call site record
515 * @addr: the address that the call site should be calling
517 * This is a very sensitive operation and great care needs
518 * to be taken by the arch. The operation should carefully
519 * read the location, check to see if what is read is indeed
520 * what we expect it to be, and then on success of the compare,
521 * it should write to the location.
523 * The code segment at @rec->ip should be a caller to @addr
527 * -EFAULT on error reading the location
528 * -EINVAL on a failed compare of the contents
529 * -EPERM on error writing to the location
530 * Any other value will be considered a failure.
532 extern int ftrace_make_nop(struct module
*mod
,
533 struct dyn_ftrace
*rec
, unsigned long addr
);
536 * ftrace_make_call - convert a nop call site into a call to addr
537 * @rec: the mcount call site record
538 * @addr: the address that the call site should call
540 * This is a very sensitive operation and great care needs
541 * to be taken by the arch. The operation should carefully
542 * read the location, check to see if what is read is indeed
543 * what we expect it to be, and then on success of the compare,
544 * it should write to the location.
546 * The code segment at @rec->ip should be a nop
550 * -EFAULT on error reading the location
551 * -EINVAL on a failed compare of the contents
552 * -EPERM on error writing to the location
553 * Any other value will be considered a failure.
555 extern int ftrace_make_call(struct dyn_ftrace
*rec
, unsigned long addr
);
557 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
559 * ftrace_modify_call - convert from one addr to another (no nop)
560 * @rec: the mcount call site record
561 * @old_addr: the address expected to be currently called to
562 * @addr: the address to change to
564 * This is a very sensitive operation and great care needs
565 * to be taken by the arch. The operation should carefully
566 * read the location, check to see if what is read is indeed
567 * what we expect it to be, and then on success of the compare,
568 * it should write to the location.
570 * The code segment at @rec->ip should be a caller to @old_addr
574 * -EFAULT on error reading the location
575 * -EINVAL on a failed compare of the contents
576 * -EPERM on error writing to the location
577 * Any other value will be considered a failure.
579 extern int ftrace_modify_call(struct dyn_ftrace
*rec
, unsigned long old_addr
,
582 /* Should never be called */
583 static inline int ftrace_modify_call(struct dyn_ftrace
*rec
, unsigned long old_addr
,
590 /* May be defined in arch */
591 extern int ftrace_arch_read_dyn_info(char *buf
, int size
);
593 extern int skip_trace(unsigned long ip
);
594 extern void ftrace_module_init(struct module
*mod
);
595 extern void ftrace_module_enable(struct module
*mod
);
596 extern void ftrace_release_mod(struct module
*mod
);
598 extern void ftrace_disable_daemon(void);
599 extern void ftrace_enable_daemon(void);
600 #else /* CONFIG_DYNAMIC_FTRACE */
601 static inline int skip_trace(unsigned long ip
) { return 0; }
602 static inline int ftrace_force_update(void) { return 0; }
603 static inline void ftrace_disable_daemon(void) { }
604 static inline void ftrace_enable_daemon(void) { }
605 static inline void ftrace_module_init(struct module
*mod
) { }
606 static inline void ftrace_module_enable(struct module
*mod
) { }
607 static inline void ftrace_release_mod(struct module
*mod
) { }
608 static inline int ftrace_text_reserved(const void *start
, const void *end
)
612 static inline unsigned long ftrace_location(unsigned long ip
)
618 * Again users of functions that have ftrace_ops may not
619 * have them defined when ftrace is not enabled, but these
620 * functions may still be called. Use a macro instead of inline.
622 #define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; })
623 #define ftrace_set_early_filter(ops, buf, enable) do { } while (0)
624 #define ftrace_set_filter_ip(ops, ip, remove, reset) ({ -ENODEV; })
625 #define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; })
626 #define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; })
627 #define ftrace_free_filter(ops) do { } while (0)
628 #define ftrace_ops_set_global_filter(ops) do { } while (0)
630 static inline ssize_t
ftrace_filter_write(struct file
*file
, const char __user
*ubuf
,
631 size_t cnt
, loff_t
*ppos
) { return -ENODEV
; }
632 static inline ssize_t
ftrace_notrace_write(struct file
*file
, const char __user
*ubuf
,
633 size_t cnt
, loff_t
*ppos
) { return -ENODEV
; }
635 ftrace_regex_release(struct inode
*inode
, struct file
*file
) { return -ENODEV
; }
637 static inline bool is_ftrace_trampoline(unsigned long addr
)
641 #endif /* CONFIG_DYNAMIC_FTRACE */
643 /* totally disable ftrace - can not re-enable after this */
644 void ftrace_kill(void);
646 static inline void tracer_disable(void)
648 #ifdef CONFIG_FUNCTION_TRACER
654 * Ftrace disable/restore without lock. Some synchronization mechanism
655 * must be used to prevent ftrace_enabled to be changed between
658 static inline int __ftrace_enabled_save(void)
660 #ifdef CONFIG_FUNCTION_TRACER
661 int saved_ftrace_enabled
= ftrace_enabled
;
663 return saved_ftrace_enabled
;
669 static inline void __ftrace_enabled_restore(int enabled
)
671 #ifdef CONFIG_FUNCTION_TRACER
672 ftrace_enabled
= enabled
;
676 /* All archs should have this, but we define it for consistency */
677 #ifndef ftrace_return_address0
678 # define ftrace_return_address0 __builtin_return_address(0)
681 /* Archs may use other ways for ADDR1 and beyond */
682 #ifndef ftrace_return_address
683 # ifdef CONFIG_FRAME_POINTER
684 # define ftrace_return_address(n) __builtin_return_address(n)
686 # define ftrace_return_address(n) 0UL
690 #define CALLER_ADDR0 ((unsigned long)ftrace_return_address0)
691 #define CALLER_ADDR1 ((unsigned long)ftrace_return_address(1))
692 #define CALLER_ADDR2 ((unsigned long)ftrace_return_address(2))
693 #define CALLER_ADDR3 ((unsigned long)ftrace_return_address(3))
694 #define CALLER_ADDR4 ((unsigned long)ftrace_return_address(4))
695 #define CALLER_ADDR5 ((unsigned long)ftrace_return_address(5))
696 #define CALLER_ADDR6 ((unsigned long)ftrace_return_address(6))
698 static inline unsigned long get_lock_parent_ip(void)
700 unsigned long addr
= CALLER_ADDR0
;
702 if (!in_lock_functions(addr
))
705 if (!in_lock_functions(addr
))
710 #ifdef CONFIG_IRQSOFF_TRACER
711 extern void time_hardirqs_on(unsigned long a0
, unsigned long a1
);
712 extern void time_hardirqs_off(unsigned long a0
, unsigned long a1
);
714 static inline void time_hardirqs_on(unsigned long a0
, unsigned long a1
) { }
715 static inline void time_hardirqs_off(unsigned long a0
, unsigned long a1
) { }
718 #if defined(CONFIG_PREEMPT_TRACER) || \
719 (defined(CONFIG_DEBUG_PREEMPT) && defined(CONFIG_PREEMPTIRQ_EVENTS))
720 extern void trace_preempt_on(unsigned long a0
, unsigned long a1
);
721 extern void trace_preempt_off(unsigned long a0
, unsigned long a1
);
724 * Use defines instead of static inlines because some arches will make code out
725 * of the CALLER_ADDR, when we really want these to be a real nop.
727 # define trace_preempt_on(a0, a1) do { } while (0)
728 # define trace_preempt_off(a0, a1) do { } while (0)
731 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
732 extern void ftrace_init(void);
734 static inline void ftrace_init(void) { }
738 * Structure that defines an entry function trace.
739 * It's already packed but the attribute "packed" is needed
740 * to remove extra padding at the end.
742 struct ftrace_graph_ent
{
743 unsigned long func
; /* Current function */
748 * Structure that defines a return function trace.
749 * It's already packed but the attribute "packed" is needed
750 * to remove extra padding at the end.
752 struct ftrace_graph_ret
{
753 unsigned long func
; /* Current function */
754 /* Number of functions that overran the depth limit for current task */
755 unsigned long overrun
;
756 unsigned long long calltime
;
757 unsigned long long rettime
;
761 /* Type of the callback handlers for tracing function graph*/
762 typedef void (*trace_func_graph_ret_t
)(struct ftrace_graph_ret
*); /* return */
763 typedef int (*trace_func_graph_ent_t
)(struct ftrace_graph_ent
*); /* entry */
765 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
768 #define INIT_FTRACE_GRAPH .ret_stack = NULL,
771 * Stack of return addresses for functions
773 * Used in struct thread_info
775 struct ftrace_ret_stack
{
778 unsigned long long calltime
;
779 #ifdef CONFIG_FUNCTION_PROFILER
780 unsigned long long subtime
;
782 #ifdef HAVE_FUNCTION_GRAPH_FP_TEST
785 #ifdef HAVE_FUNCTION_GRAPH_RET_ADDR_PTR
791 * Primary handler of a function return.
792 * It relays on ftrace_return_to_handler.
793 * Defined in entry_32/64.S
795 extern void return_to_handler(void);
798 ftrace_push_return_trace(unsigned long ret
, unsigned long func
, int *depth
,
799 unsigned long frame_pointer
, unsigned long *retp
);
801 unsigned long ftrace_graph_ret_addr(struct task_struct
*task
, int *idx
,
802 unsigned long ret
, unsigned long *retp
);
805 * Sometimes we don't want to trace a function with the function
806 * graph tracer but we want them to keep traced by the usual function
807 * tracer if the function graph tracer is not configured.
809 #define __notrace_funcgraph notrace
811 #define FTRACE_NOTRACE_DEPTH 65536
812 #define FTRACE_RETFUNC_DEPTH 50
813 #define FTRACE_RETSTACK_ALLOC_SIZE 32
814 extern int register_ftrace_graph(trace_func_graph_ret_t retfunc
,
815 trace_func_graph_ent_t entryfunc
);
817 extern bool ftrace_graph_is_dead(void);
818 extern void ftrace_graph_stop(void);
820 /* The current handlers in use */
821 extern trace_func_graph_ret_t ftrace_graph_return
;
822 extern trace_func_graph_ent_t ftrace_graph_entry
;
824 extern void unregister_ftrace_graph(void);
826 extern void ftrace_graph_init_task(struct task_struct
*t
);
827 extern void ftrace_graph_exit_task(struct task_struct
*t
);
828 extern void ftrace_graph_init_idle_task(struct task_struct
*t
, int cpu
);
830 static inline int task_curr_ret_stack(struct task_struct
*t
)
832 return t
->curr_ret_stack
;
835 static inline void pause_graph_tracing(void)
837 atomic_inc(¤t
->tracing_graph_pause
);
840 static inline void unpause_graph_tracing(void)
842 atomic_dec(¤t
->tracing_graph_pause
);
844 #else /* !CONFIG_FUNCTION_GRAPH_TRACER */
846 #define __notrace_funcgraph
847 #define INIT_FTRACE_GRAPH
849 static inline void ftrace_graph_init_task(struct task_struct
*t
) { }
850 static inline void ftrace_graph_exit_task(struct task_struct
*t
) { }
851 static inline void ftrace_graph_init_idle_task(struct task_struct
*t
, int cpu
) { }
853 static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc
,
854 trace_func_graph_ent_t entryfunc
)
858 static inline void unregister_ftrace_graph(void) { }
860 static inline int task_curr_ret_stack(struct task_struct
*tsk
)
865 static inline unsigned long
866 ftrace_graph_ret_addr(struct task_struct
*task
, int *idx
, unsigned long ret
,
872 static inline void pause_graph_tracing(void) { }
873 static inline void unpause_graph_tracing(void) { }
874 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
876 #ifdef CONFIG_TRACING
878 /* flags for current->trace */
880 TSK_TRACE_FL_TRACE_BIT
= 0,
881 TSK_TRACE_FL_GRAPH_BIT
= 1,
884 TSK_TRACE_FL_TRACE
= 1 << TSK_TRACE_FL_TRACE_BIT
,
885 TSK_TRACE_FL_GRAPH
= 1 << TSK_TRACE_FL_GRAPH_BIT
,
888 static inline void set_tsk_trace_trace(struct task_struct
*tsk
)
890 set_bit(TSK_TRACE_FL_TRACE_BIT
, &tsk
->trace
);
893 static inline void clear_tsk_trace_trace(struct task_struct
*tsk
)
895 clear_bit(TSK_TRACE_FL_TRACE_BIT
, &tsk
->trace
);
898 static inline int test_tsk_trace_trace(struct task_struct
*tsk
)
900 return tsk
->trace
& TSK_TRACE_FL_TRACE
;
903 static inline void set_tsk_trace_graph(struct task_struct
*tsk
)
905 set_bit(TSK_TRACE_FL_GRAPH_BIT
, &tsk
->trace
);
908 static inline void clear_tsk_trace_graph(struct task_struct
*tsk
)
910 clear_bit(TSK_TRACE_FL_GRAPH_BIT
, &tsk
->trace
);
913 static inline int test_tsk_trace_graph(struct task_struct
*tsk
)
915 return tsk
->trace
& TSK_TRACE_FL_GRAPH
;
918 enum ftrace_dump_mode
;
920 extern enum ftrace_dump_mode ftrace_dump_on_oops
;
921 extern int tracepoint_printk
;
923 extern void disable_trace_on_warning(void);
924 extern int __disable_trace_on_warning
;
926 #ifdef CONFIG_PREEMPT
927 #define INIT_TRACE_RECURSION .trace_recursion = 0,
930 int tracepoint_printk_sysctl(struct ctl_table
*table
, int write
,
931 void __user
*buffer
, size_t *lenp
,
934 #else /* CONFIG_TRACING */
935 static inline void disable_trace_on_warning(void) { }
936 #endif /* CONFIG_TRACING */
938 #ifndef INIT_TRACE_RECURSION
939 #define INIT_TRACE_RECURSION
942 #ifdef CONFIG_FTRACE_SYSCALLS
944 unsigned long arch_syscall_addr(int nr
);
946 #endif /* CONFIG_FTRACE_SYSCALLS */
948 #endif /* _LINUX_FTRACE_H */