Commit | Line | Data |
---|---|---|
16444a8a ACM |
1 | #ifndef _LINUX_FTRACE_H |
2 | #define _LINUX_FTRACE_H | |
3 | ||
16444a8a | 4 | #include <linux/linkage.h> |
d49dbf33 | 5 | #include <linux/fs.h> |
eb7fa935 | 6 | #include <linux/ktime.h> |
d13744cd FW |
7 | #include <linux/init.h> |
8 | #include <linux/types.h> | |
5601020f | 9 | #include <linux/kallsyms.h> |
16444a8a | 10 | |
606576ce | 11 | #ifdef CONFIG_FUNCTION_TRACER |
3e1932ad | 12 | |
b0fc494f SR |
13 | extern int ftrace_enabled; |
14 | extern int | |
15 | ftrace_enable_sysctl(struct ctl_table *table, int write, | |
16 | struct file *filp, void __user *buffer, size_t *lenp, | |
17 | loff_t *ppos); | |
18 | ||
16444a8a ACM |
19 | typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip); |
20 | ||
21 | struct ftrace_ops { | |
22 | ftrace_func_t func; | |
23 | struct ftrace_ops *next; | |
24 | }; | |
25 | ||
60a7ecf4 SR |
26 | extern int function_trace_stop; |
27 | ||
e7d3737e FW |
28 | /* |
29 | * Type of the current tracing. | |
30 | */ | |
31 | enum ftrace_tracing_type_t { | |
32 | FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */ | |
33 | FTRACE_TYPE_RETURN, /* Hook the return of the function */ | |
34 | }; | |
35 | ||
36 | /* Current tracing type, default is FTRACE_TYPE_ENTER */ | |
37 | extern enum ftrace_tracing_type_t ftrace_tracing_type; | |
38 | ||
60a7ecf4 SR |
39 | /** |
40 | * ftrace_stop - stop function tracer. | |
41 | * | |
42 | * A quick way to stop the function tracer. Note this an on off switch, | |
43 | * it is not something that is recursive like preempt_disable. | |
44 | * This does not disable the calling of mcount, it only stops the | |
45 | * calling of functions from mcount. | |
46 | */ | |
47 | static inline void ftrace_stop(void) | |
48 | { | |
49 | function_trace_stop = 1; | |
50 | } | |
51 | ||
52 | /** | |
53 | * ftrace_start - start the function tracer. | |
54 | * | |
55 | * This function is the inverse of ftrace_stop. This does not enable | |
56 | * the function tracing if the function tracer is disabled. This only | |
57 | * sets the function tracer flag to continue calling the functions | |
58 | * from mcount. | |
59 | */ | |
60 | static inline void ftrace_start(void) | |
61 | { | |
62 | function_trace_stop = 0; | |
63 | } | |
64 | ||
16444a8a ACM |
65 | /* |
66 | * The ftrace_ops must be a static and should also | |
67 | * be read_mostly. These functions do modify read_mostly variables | |
68 | * so use them sparely. Never free an ftrace_op or modify the | |
69 | * next pointer after it has been registered. Even after unregistering | |
70 | * it, the next pointer may still be used internally. | |
71 | */ | |
72 | int register_ftrace_function(struct ftrace_ops *ops); | |
73 | int unregister_ftrace_function(struct ftrace_ops *ops); | |
74 | void clear_ftrace_function(void); | |
75 | ||
76 | extern void ftrace_stub(unsigned long a0, unsigned long a1); | |
16444a8a | 77 | |
606576ce | 78 | #else /* !CONFIG_FUNCTION_TRACER */ |
16444a8a ACM |
79 | # define register_ftrace_function(ops) do { } while (0) |
80 | # define unregister_ftrace_function(ops) do { } while (0) | |
81 | # define clear_ftrace_function(ops) do { } while (0) | |
81adbdc0 | 82 | static inline void ftrace_kill(void) { } |
60a7ecf4 SR |
83 | static inline void ftrace_stop(void) { } |
84 | static inline void ftrace_start(void) { } | |
606576ce | 85 | #endif /* CONFIG_FUNCTION_TRACER */ |
352ad25a | 86 | |
3d083395 | 87 | #ifdef CONFIG_DYNAMIC_FTRACE |
31e88909 SR |
88 | /* asm/ftrace.h must be defined for archs supporting dynamic ftrace */ |
89 | #include <asm/ftrace.h> | |
90 | ||
3c1720f0 | 91 | enum { |
37ad5084 SR |
92 | FTRACE_FL_FREE = (1 << 0), |
93 | FTRACE_FL_FAILED = (1 << 1), | |
94 | FTRACE_FL_FILTER = (1 << 2), | |
95 | FTRACE_FL_ENABLED = (1 << 3), | |
41c52c0d | 96 | FTRACE_FL_NOTRACE = (1 << 4), |
0eb96701 | 97 | FTRACE_FL_CONVERTED = (1 << 5), |
ecea656d | 98 | FTRACE_FL_FROZEN = (1 << 6), |
3c1720f0 SR |
99 | }; |
100 | ||
3d083395 | 101 | struct dyn_ftrace { |
08f5ac90 SR |
102 | struct list_head list; |
103 | unsigned long ip; /* address of mcount call-site */ | |
104 | unsigned long flags; | |
31e88909 | 105 | struct dyn_arch_ftrace arch; |
3d083395 SR |
106 | }; |
107 | ||
e1c08bdd | 108 | int ftrace_force_update(void); |
77a2b37d | 109 | void ftrace_set_filter(unsigned char *buf, int len, int reset); |
e1c08bdd | 110 | |
3d083395 | 111 | /* defined in arch */ |
3c1720f0 | 112 | extern int ftrace_ip_converted(unsigned long ip); |
d61f82d0 | 113 | extern int ftrace_dyn_arch_init(void *data); |
d61f82d0 SR |
114 | extern int ftrace_update_ftrace_func(ftrace_func_t func); |
115 | extern void ftrace_caller(void); | |
116 | extern void ftrace_call(void); | |
117 | extern void mcount_call(void); | |
fb52607a FW |
118 | #ifdef CONFIG_FUNCTION_GRAPH_TRACER |
119 | extern void ftrace_graph_caller(void); | |
e7d3737e | 120 | #endif |
ad90c0e3 | 121 | |
31e88909 SR |
122 | /** |
123 | * ftrace_make_nop - convert code into top | |
124 | * @mod: module structure if called by module load initialization | |
125 | * @rec: the mcount call site record | |
126 | * @addr: the address that the call site should be calling | |
127 | * | |
128 | * This is a very sensitive operation and great care needs | |
129 | * to be taken by the arch. The operation should carefully | |
130 | * read the location, check to see if what is read is indeed | |
131 | * what we expect it to be, and then on success of the compare, | |
132 | * it should write to the location. | |
133 | * | |
134 | * The code segment at @rec->ip should be a caller to @addr | |
135 | * | |
136 | * Return must be: | |
137 | * 0 on success | |
138 | * -EFAULT on error reading the location | |
139 | * -EINVAL on a failed compare of the contents | |
140 | * -EPERM on error writing to the location | |
141 | * Any other value will be considered a failure. | |
142 | */ | |
143 | extern int ftrace_make_nop(struct module *mod, | |
144 | struct dyn_ftrace *rec, unsigned long addr); | |
a26a2a27 | 145 | |
593eb8a2 | 146 | /** |
31e88909 SR |
147 | * ftrace_make_call - convert a nop call site into a call to addr |
148 | * @rec: the mcount call site record | |
149 | * @addr: the address that the call site should call | |
593eb8a2 SR |
150 | * |
151 | * This is a very sensitive operation and great care needs | |
152 | * to be taken by the arch. The operation should carefully | |
153 | * read the location, check to see if what is read is indeed | |
154 | * what we expect it to be, and then on success of the compare, | |
155 | * it should write to the location. | |
156 | * | |
31e88909 SR |
157 | * The code segment at @rec->ip should be a nop |
158 | * | |
593eb8a2 SR |
159 | * Return must be: |
160 | * 0 on success | |
161 | * -EFAULT on error reading the location | |
162 | * -EINVAL on a failed compare of the contents | |
163 | * -EPERM on error writing to the location | |
164 | * Any other value will be considered a failure. | |
165 | */ | |
31e88909 SR |
166 | extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr); |
167 | ||
168 | ||
169 | /* May be defined in arch */ | |
170 | extern int ftrace_arch_read_dyn_info(char *buf, int size); | |
593eb8a2 | 171 | |
ecea656d AS |
172 | extern int skip_trace(unsigned long ip); |
173 | ||
c0719e5a SR |
174 | extern void ftrace_release(void *start, unsigned long size); |
175 | ||
176 | extern void ftrace_disable_daemon(void); | |
177 | extern void ftrace_enable_daemon(void); | |
e1c08bdd | 178 | #else |
ecea656d | 179 | # define skip_trace(ip) ({ 0; }) |
aeaee8a2 IM |
180 | # define ftrace_force_update() ({ 0; }) |
181 | # define ftrace_set_filter(buf, len, reset) do { } while (0) | |
ad90c0e3 SR |
182 | # define ftrace_disable_daemon() do { } while (0) |
183 | # define ftrace_enable_daemon() do { } while (0) | |
c0719e5a | 184 | static inline void ftrace_release(void *start, unsigned long size) { } |
ecea656d | 185 | #endif /* CONFIG_DYNAMIC_FTRACE */ |
352ad25a | 186 | |
aeaee8a2 IM |
187 | /* totally disable ftrace - can not re-enable after this */ |
188 | void ftrace_kill(void); | |
189 | ||
f43fdad8 IM |
190 | static inline void tracer_disable(void) |
191 | { | |
606576ce | 192 | #ifdef CONFIG_FUNCTION_TRACER |
f43fdad8 IM |
193 | ftrace_enabled = 0; |
194 | #endif | |
195 | } | |
196 | ||
37002735 HY |
197 | /* |
198 | * Ftrace disable/restore without lock. Some synchronization mechanism | |
9bdeb7b5 | 199 | * must be used to prevent ftrace_enabled to be changed between |
37002735 HY |
200 | * disable/restore. |
201 | */ | |
9bdeb7b5 HY |
202 | static inline int __ftrace_enabled_save(void) |
203 | { | |
606576ce | 204 | #ifdef CONFIG_FUNCTION_TRACER |
9bdeb7b5 HY |
205 | int saved_ftrace_enabled = ftrace_enabled; |
206 | ftrace_enabled = 0; | |
207 | return saved_ftrace_enabled; | |
208 | #else | |
209 | return 0; | |
210 | #endif | |
211 | } | |
212 | ||
213 | static inline void __ftrace_enabled_restore(int enabled) | |
214 | { | |
606576ce | 215 | #ifdef CONFIG_FUNCTION_TRACER |
9bdeb7b5 HY |
216 | ftrace_enabled = enabled; |
217 | #endif | |
218 | } | |
219 | ||
352ad25a SR |
220 | #ifdef CONFIG_FRAME_POINTER |
221 | /* TODO: need to fix this for ARM */ | |
222 | # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0)) | |
223 | # define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1)) | |
224 | # define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2)) | |
225 | # define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3)) | |
226 | # define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4)) | |
227 | # define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5)) | |
86387f7e | 228 | # define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6)) |
352ad25a SR |
229 | #else |
230 | # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0)) | |
231 | # define CALLER_ADDR1 0UL | |
232 | # define CALLER_ADDR2 0UL | |
233 | # define CALLER_ADDR3 0UL | |
234 | # define CALLER_ADDR4 0UL | |
235 | # define CALLER_ADDR5 0UL | |
86387f7e | 236 | # define CALLER_ADDR6 0UL |
352ad25a SR |
237 | #endif |
238 | ||
81d68a96 | 239 | #ifdef CONFIG_IRQSOFF_TRACER |
489f1396 IM |
240 | extern void time_hardirqs_on(unsigned long a0, unsigned long a1); |
241 | extern void time_hardirqs_off(unsigned long a0, unsigned long a1); | |
81d68a96 SR |
242 | #else |
243 | # define time_hardirqs_on(a0, a1) do { } while (0) | |
244 | # define time_hardirqs_off(a0, a1) do { } while (0) | |
245 | #endif | |
246 | ||
6cd8a4bb | 247 | #ifdef CONFIG_PREEMPT_TRACER |
489f1396 IM |
248 | extern void trace_preempt_on(unsigned long a0, unsigned long a1); |
249 | extern void trace_preempt_off(unsigned long a0, unsigned long a1); | |
6cd8a4bb SR |
250 | #else |
251 | # define trace_preempt_on(a0, a1) do { } while (0) | |
252 | # define trace_preempt_off(a0, a1) do { } while (0) | |
253 | #endif | |
254 | ||
b1829d27 | 255 | #ifdef CONFIG_TRACING |
944ac425 SR |
256 | extern int ftrace_dump_on_oops; |
257 | ||
0f048701 SR |
258 | extern void tracing_start(void); |
259 | extern void tracing_stop(void); | |
69bb54ec | 260 | extern void ftrace_off_permanent(void); |
0f048701 | 261 | |
74f4e369 IM |
262 | extern void |
263 | ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3); | |
2f2c99db SR |
264 | |
265 | /** | |
266 | * ftrace_printk - printf formatting in the ftrace buffer | |
267 | * @fmt: the printf format for printing | |
268 | * | |
269 | * Note: __ftrace_printk is an internal function for ftrace_printk and | |
270 | * the @ip is passed in via the ftrace_printk macro. | |
271 | * | |
272 | * This function allows a kernel developer to debug fast path sections | |
273 | * that printk is not appropriate for. By scattering in various | |
274 | * printk like tracing in the code, a developer can quickly see | |
275 | * where problems are occurring. | |
276 | * | |
277 | * This is intended as a debugging tool for the developer only. | |
278 | * Please refrain from leaving ftrace_printks scattered around in | |
279 | * your code. | |
280 | */ | |
281 | # define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt) | |
dd0e545f SR |
282 | extern int |
283 | __ftrace_printk(unsigned long ip, const char *fmt, ...) | |
284 | __attribute__ ((format (printf, 2, 3))); | |
3f5a54e3 | 285 | extern void ftrace_dump(void); |
74f4e369 IM |
286 | #else |
287 | static inline void | |
288 | ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { } | |
dd0e545f | 289 | static inline int |
7b928c23 IM |
290 | ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 0))); |
291 | ||
0f048701 SR |
292 | static inline void tracing_start(void) { } |
293 | static inline void tracing_stop(void) { } | |
69bb54ec | 294 | static inline void ftrace_off_permanent(void) { } |
7b928c23 IM |
295 | static inline int |
296 | ftrace_printk(const char *fmt, ...) | |
dd0e545f SR |
297 | { |
298 | return 0; | |
299 | } | |
3f5a54e3 | 300 | static inline void ftrace_dump(void) { } |
74f4e369 IM |
301 | #endif |
302 | ||
68bf21aa SR |
303 | #ifdef CONFIG_FTRACE_MCOUNT_RECORD |
304 | extern void ftrace_init(void); | |
31e88909 SR |
305 | extern void ftrace_init_module(struct module *mod, |
306 | unsigned long *start, unsigned long *end); | |
68bf21aa SR |
307 | #else |
308 | static inline void ftrace_init(void) { } | |
90d595fe | 309 | static inline void |
31e88909 SR |
310 | ftrace_init_module(struct module *mod, |
311 | unsigned long *start, unsigned long *end) { } | |
68bf21aa SR |
312 | #endif |
313 | ||
dd0e545f | 314 | |
caf4b323 FW |
315 | /* |
316 | * Structure that defines a return function trace. | |
317 | */ | |
fb52607a | 318 | struct ftrace_graph_ret { |
caf4b323 FW |
319 | unsigned long ret; /* Return address */ |
320 | unsigned long func; /* Current function */ | |
321 | unsigned long long calltime; | |
322 | unsigned long long rettime; | |
0231022c FW |
323 | /* Number of functions that overran the depth limit for current task */ |
324 | unsigned long overrun; | |
caf4b323 FW |
325 | }; |
326 | ||
fb52607a | 327 | #ifdef CONFIG_FUNCTION_GRAPH_TRACER |
f201ae23 FW |
328 | #define FTRACE_RETFUNC_DEPTH 50 |
329 | #define FTRACE_RETSTACK_ALLOC_SIZE 32 | |
caf4b323 | 330 | /* Type of a callback handler of tracing return function */ |
fb52607a | 331 | typedef void (*trace_function_graph_t)(struct ftrace_graph_ret *); |
caf4b323 | 332 | |
fb52607a | 333 | extern int register_ftrace_graph(trace_function_graph_t func); |
caf4b323 | 334 | /* The current handler in use */ |
fb52607a FW |
335 | extern trace_function_graph_t ftrace_graph_function; |
336 | extern void unregister_ftrace_graph(void); | |
f201ae23 | 337 | |
fb52607a FW |
338 | extern void ftrace_graph_init_task(struct task_struct *t); |
339 | extern void ftrace_graph_exit_task(struct task_struct *t); | |
82f60f0b | 340 | #else |
fb52607a FW |
341 | static inline void ftrace_graph_init_task(struct task_struct *t) { } |
342 | static inline void ftrace_graph_exit_task(struct task_struct *t) { } | |
caf4b323 FW |
343 | #endif |
344 | ||
16444a8a | 345 | #endif /* _LINUX_FTRACE_H */ |