1 #ifndef _LINUX_FTRACE_H
2 #define _LINUX_FTRACE_H
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>
15 #include <asm/ftrace.h>
17 #ifdef CONFIG_FUNCTION_TRACER
19 extern int ftrace_enabled;
21 ftrace_enable_sysctl(struct ctl_table *table, int write,
22 void __user *buffer, size_t *lenp,
25 typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
29 struct ftrace_ops *next;
32 extern int function_trace_stop;
35 * Type of the current tracing.
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 */
42 /* Current tracing type, default is FTRACE_TYPE_ENTER */
43 extern enum ftrace_tracing_type_t ftrace_tracing_type;
46 * ftrace_stop - stop function tracer.
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.
53 static inline void ftrace_stop(void)
55 function_trace_stop = 1;
59 * ftrace_start - start the function tracer.
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
66 static inline void ftrace_start(void)
68 function_trace_stop = 0;
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.
78 int register_ftrace_function(struct ftrace_ops *ops);
79 int unregister_ftrace_function(struct ftrace_ops *ops);
80 void clear_ftrace_function(void);
82 extern void ftrace_stub(unsigned long a0, unsigned long a1);
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 */
93 #ifdef CONFIG_STACK_TRACER
94 extern int stack_tracer_enabled;
96 stack_trace_sysctl(struct ctl_table *table, int write,
97 void __user *buffer, size_t *lenp,
101 struct ftrace_func_command {
102 struct list_head list;
104 int (*func)(char *func, char *cmd,
105 char *params, int enable);
108 #ifdef CONFIG_DYNAMIC_FTRACE
110 int ftrace_arch_code_modify_prepare(void);
111 int ftrace_arch_code_modify_post_process(void);
115 struct ftrace_probe_ops {
116 void (*func)(unsigned long ip,
117 unsigned long parent_ip,
119 int (*callback)(unsigned long ip, void **data);
120 void (*free)(void **data);
121 int (*print)(struct seq_file *m,
123 struct ftrace_probe_ops *ops,
128 register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
131 unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
134 unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
135 extern void unregister_ftrace_function_probe_all(char *glob);
137 extern int ftrace_text_reserved(void *start, void *end);
140 FTRACE_FL_FREE = (1 << 0),
141 FTRACE_FL_FAILED = (1 << 1),
142 FTRACE_FL_FILTER = (1 << 2),
143 FTRACE_FL_ENABLED = (1 << 3),
144 FTRACE_FL_NOTRACE = (1 << 4),
145 FTRACE_FL_CONVERTED = (1 << 5),
146 FTRACE_FL_FROZEN = (1 << 6),
151 unsigned long ip; /* address of mcount call-site */
152 struct dyn_ftrace *freelist;
156 struct dyn_ftrace *newlist;
158 struct dyn_arch_ftrace arch;
161 int ftrace_force_update(void);
162 void ftrace_set_filter(unsigned char *buf, int len, int reset);
164 int register_ftrace_command(struct ftrace_func_command *cmd);
165 int unregister_ftrace_command(struct ftrace_func_command *cmd);
167 /* defined in arch */
168 extern int ftrace_ip_converted(unsigned long ip);
169 extern int ftrace_dyn_arch_init(void *data);
170 extern int ftrace_update_ftrace_func(ftrace_func_t func);
171 extern void ftrace_caller(void);
172 extern void ftrace_call(void);
173 extern void mcount_call(void);
176 #define FTRACE_ADDR ((unsigned long)ftrace_caller)
178 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
179 extern void ftrace_graph_caller(void);
180 extern int ftrace_enable_ftrace_graph_caller(void);
181 extern int ftrace_disable_ftrace_graph_caller(void);
183 static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
184 static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
188 * ftrace_make_nop - convert code into nop
189 * @mod: module structure if called by module load initialization
190 * @rec: the mcount call site record
191 * @addr: the address that the call site should be calling
193 * This is a very sensitive operation and great care needs
194 * to be taken by the arch. The operation should carefully
195 * read the location, check to see if what is read is indeed
196 * what we expect it to be, and then on success of the compare,
197 * it should write to the location.
199 * The code segment at @rec->ip should be a caller to @addr
203 * -EFAULT on error reading the location
204 * -EINVAL on a failed compare of the contents
205 * -EPERM on error writing to the location
206 * Any other value will be considered a failure.
208 extern int ftrace_make_nop(struct module *mod,
209 struct dyn_ftrace *rec, unsigned long addr);
212 * ftrace_make_call - convert a nop call site into a call to addr
213 * @rec: the mcount call site record
214 * @addr: the address that the call site should call
216 * This is a very sensitive operation and great care needs
217 * to be taken by the arch. The operation should carefully
218 * read the location, check to see if what is read is indeed
219 * what we expect it to be, and then on success of the compare,
220 * it should write to the location.
222 * The code segment at @rec->ip should be a nop
226 * -EFAULT on error reading the location
227 * -EINVAL on a failed compare of the contents
228 * -EPERM on error writing to the location
229 * Any other value will be considered a failure.
231 extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
233 /* May be defined in arch */
234 extern int ftrace_arch_read_dyn_info(char *buf, int size);
236 extern int skip_trace(unsigned long ip);
238 extern void ftrace_disable_daemon(void);
239 extern void ftrace_enable_daemon(void);
241 # define skip_trace(ip) ({ 0; })
242 # define ftrace_force_update() ({ 0; })
243 # define ftrace_set_filter(buf, len, reset) do { } while (0)
244 # define ftrace_disable_daemon() do { } while (0)
245 # define ftrace_enable_daemon() do { } while (0)
246 static inline void ftrace_release_mod(struct module *mod) {}
247 static inline int register_ftrace_command(struct ftrace_func_command *cmd)
251 static inline int unregister_ftrace_command(char *cmd_name)
255 static inline int ftrace_text_reserved(void *start, void *end)
259 #endif /* CONFIG_DYNAMIC_FTRACE */
261 /* totally disable ftrace - can not re-enable after this */
262 void ftrace_kill(void);
264 static inline void tracer_disable(void)
266 #ifdef CONFIG_FUNCTION_TRACER
272 * Ftrace disable/restore without lock. Some synchronization mechanism
273 * must be used to prevent ftrace_enabled to be changed between
276 static inline int __ftrace_enabled_save(void)
278 #ifdef CONFIG_FUNCTION_TRACER
279 int saved_ftrace_enabled = ftrace_enabled;
281 return saved_ftrace_enabled;
287 static inline void __ftrace_enabled_restore(int enabled)
289 #ifdef CONFIG_FUNCTION_TRACER
290 ftrace_enabled = enabled;
294 #ifndef HAVE_ARCH_CALLER_ADDR
295 # ifdef CONFIG_FRAME_POINTER
296 # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
297 # define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
298 # define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
299 # define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
300 # define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
301 # define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
302 # define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
304 # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
305 # define CALLER_ADDR1 0UL
306 # define CALLER_ADDR2 0UL
307 # define CALLER_ADDR3 0UL
308 # define CALLER_ADDR4 0UL
309 # define CALLER_ADDR5 0UL
310 # define CALLER_ADDR6 0UL
312 #endif /* ifndef HAVE_ARCH_CALLER_ADDR */
314 #ifdef CONFIG_IRQSOFF_TRACER
315 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
316 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
318 # define time_hardirqs_on(a0, a1) do { } while (0)
319 # define time_hardirqs_off(a0, a1) do { } while (0)
322 #ifdef CONFIG_PREEMPT_TRACER
323 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
324 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
326 # define trace_preempt_on(a0, a1) do { } while (0)
327 # define trace_preempt_off(a0, a1) do { } while (0)
330 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
331 extern void ftrace_init(void);
333 static inline void ftrace_init(void) { }
337 * Structure that defines an entry function trace.
339 struct ftrace_graph_ent {
340 unsigned long func; /* Current function */
345 * Structure that defines a return function trace.
347 struct ftrace_graph_ret {
348 unsigned long func; /* Current function */
349 unsigned long long calltime;
350 unsigned long long rettime;
351 /* Number of functions that overran the depth limit for current task */
352 unsigned long overrun;
356 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
359 #define INIT_FTRACE_GRAPH .ret_stack = NULL,
362 * Stack of return addresses for functions
364 * Used in struct thread_info
366 struct ftrace_ret_stack {
369 unsigned long long calltime;
370 unsigned long long subtime;
375 * Primary handler of a function return.
376 * It relays on ftrace_return_to_handler.
377 * Defined in entry_32/64.S
379 extern void return_to_handler(void);
382 ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
383 unsigned long frame_pointer);
386 * Sometimes we don't want to trace a function with the function
387 * graph tracer but we want them to keep traced by the usual function
388 * tracer if the function graph tracer is not configured.
390 #define __notrace_funcgraph notrace
393 * We want to which function is an entrypoint of a hardirq.
394 * That will help us to put a signal on output.
396 #define __irq_entry __attribute__((__section__(".irqentry.text")))
398 /* Limits of hardirq entrypoints */
399 extern char __irqentry_text_start[];
400 extern char __irqentry_text_end[];
402 #define FTRACE_RETFUNC_DEPTH 50
403 #define FTRACE_RETSTACK_ALLOC_SIZE 32
404 /* Type of the callback handlers for tracing function graph*/
405 typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
406 typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
408 extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
409 trace_func_graph_ent_t entryfunc);
411 extern void ftrace_graph_stop(void);
413 /* The current handlers in use */
414 extern trace_func_graph_ret_t ftrace_graph_return;
415 extern trace_func_graph_ent_t ftrace_graph_entry;
417 extern void unregister_ftrace_graph(void);
419 extern void ftrace_graph_init_task(struct task_struct *t);
420 extern void ftrace_graph_exit_task(struct task_struct *t);
422 static inline int task_curr_ret_stack(struct task_struct *t)
424 return t->curr_ret_stack;
427 static inline void pause_graph_tracing(void)
429 atomic_inc(¤t->tracing_graph_pause);
432 static inline void unpause_graph_tracing(void)
434 atomic_dec(¤t->tracing_graph_pause);
436 #else /* !CONFIG_FUNCTION_GRAPH_TRACER */
438 #define __notrace_funcgraph
440 #define INIT_FTRACE_GRAPH
442 static inline void ftrace_graph_init_task(struct task_struct *t) { }
443 static inline void ftrace_graph_exit_task(struct task_struct *t) { }
445 static inline int task_curr_ret_stack(struct task_struct *tsk)
450 static inline void pause_graph_tracing(void) { }
451 static inline void unpause_graph_tracing(void) { }
452 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
454 #ifdef CONFIG_TRACING
456 /* flags for current->trace */
458 TSK_TRACE_FL_TRACE_BIT = 0,
459 TSK_TRACE_FL_GRAPH_BIT = 1,
462 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
463 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
466 static inline void set_tsk_trace_trace(struct task_struct *tsk)
468 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
471 static inline void clear_tsk_trace_trace(struct task_struct *tsk)
473 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
476 static inline int test_tsk_trace_trace(struct task_struct *tsk)
478 return tsk->trace & TSK_TRACE_FL_TRACE;
481 static inline void set_tsk_trace_graph(struct task_struct *tsk)
483 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
486 static inline void clear_tsk_trace_graph(struct task_struct *tsk)
488 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
491 static inline int test_tsk_trace_graph(struct task_struct *tsk)
493 return tsk->trace & TSK_TRACE_FL_GRAPH;
496 extern int ftrace_dump_on_oops;
498 #ifdef CONFIG_PREEMPT
499 #define INIT_TRACE_RECURSION .trace_recursion = 0,
502 #endif /* CONFIG_TRACING */
504 #ifndef INIT_TRACE_RECURSION
505 #define INIT_TRACE_RECURSION
508 #ifdef CONFIG_HW_BRANCH_TRACER
510 void trace_hw_branch(u64 from, u64 to);
511 void trace_hw_branch_oops(void);
513 #else /* CONFIG_HW_BRANCH_TRACER */
515 static inline void trace_hw_branch(u64 from, u64 to) {}
516 static inline void trace_hw_branch_oops(void) {}
518 #endif /* CONFIG_HW_BRANCH_TRACER */
520 #endif /* _LINUX_FTRACE_H */