Commit | Line | Data |
---|---|---|
9849ed4d MF |
1 | /* |
2 | * Ftrace header. For implementation details beyond the random comments | |
3 | * scattered below, see: Documentation/trace/ftrace-design.txt | |
4 | */ | |
5 | ||
16444a8a ACM |
6 | #ifndef _LINUX_FTRACE_H |
7 | #define _LINUX_FTRACE_H | |
8 | ||
0012693a | 9 | #include <linux/trace_clock.h> |
5601020f | 10 | #include <linux/kallsyms.h> |
0012693a | 11 | #include <linux/linkage.h> |
ea4e2bc4 | 12 | #include <linux/bitops.h> |
a1e2e31d | 13 | #include <linux/ptrace.h> |
0012693a | 14 | #include <linux/ktime.h> |
21a8c466 | 15 | #include <linux/sched.h> |
0012693a FW |
16 | #include <linux/types.h> |
17 | #include <linux/init.h> | |
18 | #include <linux/fs.h> | |
16444a8a | 19 | |
c79a61f5 UKK |
20 | #include <asm/ftrace.h> |
21 | ||
2f5f6ad9 SR |
22 | /* |
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. | |
26 | */ | |
27 | #ifndef ARCH_SUPPORTS_FTRACE_OPS | |
28 | #define ARCH_SUPPORTS_FTRACE_OPS 0 | |
29 | #endif | |
30 | ||
ccf3672d SR |
31 | /* |
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. | |
35 | */ | |
36 | #if !defined(CONFIG_HAVE_FUNCTION_TRACE_MCOUNT_TEST) || \ | |
37 | !ARCH_SUPPORTS_FTRACE_OPS | |
38 | # define FTRACE_FORCE_LIST_FUNC 1 | |
39 | #else | |
40 | # define FTRACE_FORCE_LIST_FUNC 0 | |
41 | #endif | |
42 | ||
43 | ||
de477254 | 44 | struct module; |
04da85b8 SR |
45 | struct ftrace_hash; |
46 | ||
606576ce | 47 | #ifdef CONFIG_FUNCTION_TRACER |
3e1932ad | 48 | |
b0fc494f SR |
49 | extern int ftrace_enabled; |
50 | extern int | |
51 | ftrace_enable_sysctl(struct ctl_table *table, int write, | |
8d65af78 | 52 | void __user *buffer, size_t *lenp, |
b0fc494f SR |
53 | loff_t *ppos); |
54 | ||
2f5f6ad9 SR |
55 | struct ftrace_ops; |
56 | ||
57 | typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip, | |
a1e2e31d | 58 | struct ftrace_ops *op, struct pt_regs *regs); |
16444a8a | 59 | |
e248491a JO |
60 | /* |
61 | * FTRACE_OPS_FL_* bits denote the state of ftrace_ops struct and are | |
62 | * set in the flags member. | |
63 | * | |
64 | * ENABLED - set/unset when ftrace_ops is registered/unregistered | |
65 | * GLOBAL - set manualy by ftrace_ops user to denote the ftrace_ops | |
66 | * is part of the global tracers sharing the same filter | |
67 | * via set_ftrace_* debugfs files. | |
68 | * DYNAMIC - set when ftrace_ops is registered to denote dynamically | |
69 | * allocated ftrace_ops which need special care | |
70 | * CONTROL - set manualy by ftrace_ops user to denote the ftrace_ops | |
71 | * could be controled by following calls: | |
72 | * ftrace_function_local_enable | |
73 | * ftrace_function_local_disable | |
08f6fba5 SR |
74 | * SAVE_REGS - The ftrace_ops wants regs saved at each function called |
75 | * and passed to the callback. If this flag is set, but the | |
76 | * architecture does not support passing regs | |
77 | * (ARCH_SUPPORTS_FTRACE_SAVE_REGS is not defined), then the | |
78 | * ftrace_ops will fail to register, unless the next flag | |
79 | * is set. | |
80 | * SAVE_REGS_IF_SUPPORTED - This is the same as SAVE_REGS, but if the | |
81 | * handler can handle an arch that does not save regs | |
82 | * (the handler tests if regs == NULL), then it can set | |
83 | * this flag instead. It will not fail registering the ftrace_ops | |
84 | * but, the regs field will be NULL if the arch does not support | |
85 | * passing regs to the handler. | |
86 | * Note, if this flag is set, the SAVE_REGS flag will automatically | |
87 | * get set upon registering the ftrace_ops, if the arch supports it. | |
4740974a SR |
88 | * RECURSION_SAFE - The ftrace_ops can set this to tell the ftrace infrastructure |
89 | * that the call back has its own recursion protection. If it does | |
90 | * not set this, then the ftrace infrastructure will add recursion | |
91 | * protection for the caller. | |
e248491a | 92 | */ |
b848914c | 93 | enum { |
08f6fba5 SR |
94 | FTRACE_OPS_FL_ENABLED = 1 << 0, |
95 | FTRACE_OPS_FL_GLOBAL = 1 << 1, | |
96 | FTRACE_OPS_FL_DYNAMIC = 1 << 2, | |
97 | FTRACE_OPS_FL_CONTROL = 1 << 3, | |
98 | FTRACE_OPS_FL_SAVE_REGS = 1 << 4, | |
99 | FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED = 1 << 5, | |
4740974a | 100 | FTRACE_OPS_FL_RECURSION_SAFE = 1 << 6, |
b848914c SR |
101 | }; |
102 | ||
16444a8a | 103 | struct ftrace_ops { |
f45948e8 SR |
104 | ftrace_func_t func; |
105 | struct ftrace_ops *next; | |
b848914c | 106 | unsigned long flags; |
e248491a | 107 | int __percpu *disabled; |
f45948e8 SR |
108 | #ifdef CONFIG_DYNAMIC_FTRACE |
109 | struct ftrace_hash *notrace_hash; | |
110 | struct ftrace_hash *filter_hash; | |
111 | #endif | |
16444a8a ACM |
112 | }; |
113 | ||
60a7ecf4 SR |
114 | extern int function_trace_stop; |
115 | ||
e7d3737e FW |
116 | /* |
117 | * Type of the current tracing. | |
118 | */ | |
119 | enum ftrace_tracing_type_t { | |
120 | FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */ | |
121 | FTRACE_TYPE_RETURN, /* Hook the return of the function */ | |
122 | }; | |
123 | ||
124 | /* Current tracing type, default is FTRACE_TYPE_ENTER */ | |
125 | extern enum ftrace_tracing_type_t ftrace_tracing_type; | |
126 | ||
60a7ecf4 SR |
127 | /** |
128 | * ftrace_stop - stop function tracer. | |
129 | * | |
130 | * A quick way to stop the function tracer. Note this an on off switch, | |
131 | * it is not something that is recursive like preempt_disable. | |
132 | * This does not disable the calling of mcount, it only stops the | |
133 | * calling of functions from mcount. | |
134 | */ | |
135 | static inline void ftrace_stop(void) | |
136 | { | |
137 | function_trace_stop = 1; | |
138 | } | |
139 | ||
140 | /** | |
141 | * ftrace_start - start the function tracer. | |
142 | * | |
143 | * This function is the inverse of ftrace_stop. This does not enable | |
144 | * the function tracing if the function tracer is disabled. This only | |
145 | * sets the function tracer flag to continue calling the functions | |
146 | * from mcount. | |
147 | */ | |
148 | static inline void ftrace_start(void) | |
149 | { | |
150 | function_trace_stop = 0; | |
151 | } | |
152 | ||
16444a8a ACM |
153 | /* |
154 | * The ftrace_ops must be a static and should also | |
155 | * be read_mostly. These functions do modify read_mostly variables | |
156 | * so use them sparely. Never free an ftrace_op or modify the | |
157 | * next pointer after it has been registered. Even after unregistering | |
158 | * it, the next pointer may still be used internally. | |
159 | */ | |
160 | int register_ftrace_function(struct ftrace_ops *ops); | |
161 | int unregister_ftrace_function(struct ftrace_ops *ops); | |
162 | void clear_ftrace_function(void); | |
163 | ||
e248491a JO |
164 | /** |
165 | * ftrace_function_local_enable - enable controlled ftrace_ops on current cpu | |
166 | * | |
167 | * This function enables tracing on current cpu by decreasing | |
168 | * the per cpu control variable. | |
169 | * It must be called with preemption disabled and only on ftrace_ops | |
170 | * registered with FTRACE_OPS_FL_CONTROL. If called without preemption | |
171 | * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled. | |
172 | */ | |
173 | static inline void ftrace_function_local_enable(struct ftrace_ops *ops) | |
174 | { | |
175 | if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL))) | |
176 | return; | |
177 | ||
178 | (*this_cpu_ptr(ops->disabled))--; | |
179 | } | |
180 | ||
181 | /** | |
182 | * ftrace_function_local_disable - enable controlled ftrace_ops on current cpu | |
183 | * | |
184 | * This function enables tracing on current cpu by decreasing | |
185 | * the per cpu control variable. | |
186 | * It must be called with preemption disabled and only on ftrace_ops | |
187 | * registered with FTRACE_OPS_FL_CONTROL. If called without preemption | |
188 | * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled. | |
189 | */ | |
190 | static inline void ftrace_function_local_disable(struct ftrace_ops *ops) | |
191 | { | |
192 | if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL))) | |
193 | return; | |
194 | ||
195 | (*this_cpu_ptr(ops->disabled))++; | |
196 | } | |
197 | ||
198 | /** | |
199 | * ftrace_function_local_disabled - returns ftrace_ops disabled value | |
200 | * on current cpu | |
201 | * | |
202 | * This function returns value of ftrace_ops::disabled on current cpu. | |
203 | * It must be called with preemption disabled and only on ftrace_ops | |
204 | * registered with FTRACE_OPS_FL_CONTROL. If called without preemption | |
205 | * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled. | |
206 | */ | |
207 | static inline int ftrace_function_local_disabled(struct ftrace_ops *ops) | |
208 | { | |
209 | WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)); | |
210 | return *this_cpu_ptr(ops->disabled); | |
211 | } | |
212 | ||
a1e2e31d SR |
213 | extern void ftrace_stub(unsigned long a0, unsigned long a1, |
214 | struct ftrace_ops *op, struct pt_regs *regs); | |
16444a8a | 215 | |
606576ce | 216 | #else /* !CONFIG_FUNCTION_TRACER */ |
4dbf6bc2 SR |
217 | /* |
218 | * (un)register_ftrace_function must be a macro since the ops parameter | |
219 | * must not be evaluated. | |
220 | */ | |
221 | #define register_ftrace_function(ops) ({ 0; }) | |
222 | #define unregister_ftrace_function(ops) ({ 0; }) | |
ea701f11 SR |
223 | static inline int ftrace_nr_registered_ops(void) |
224 | { | |
225 | return 0; | |
226 | } | |
4dbf6bc2 | 227 | static inline void clear_ftrace_function(void) { } |
81adbdc0 | 228 | static inline void ftrace_kill(void) { } |
60a7ecf4 SR |
229 | static inline void ftrace_stop(void) { } |
230 | static inline void ftrace_start(void) { } | |
606576ce | 231 | #endif /* CONFIG_FUNCTION_TRACER */ |
352ad25a | 232 | |
f38f1d2a SR |
233 | #ifdef CONFIG_STACK_TRACER |
234 | extern int stack_tracer_enabled; | |
235 | int | |
236 | stack_trace_sysctl(struct ctl_table *table, int write, | |
8d65af78 | 237 | void __user *buffer, size_t *lenp, |
f38f1d2a SR |
238 | loff_t *ppos); |
239 | #endif | |
240 | ||
f6180773 SR |
241 | struct ftrace_func_command { |
242 | struct list_head list; | |
243 | char *name; | |
43dd61c9 SR |
244 | int (*func)(struct ftrace_hash *hash, |
245 | char *func, char *cmd, | |
f6180773 SR |
246 | char *params, int enable); |
247 | }; | |
248 | ||
3d083395 | 249 | #ifdef CONFIG_DYNAMIC_FTRACE |
31e88909 | 250 | |
000ab691 SR |
251 | int ftrace_arch_code_modify_prepare(void); |
252 | int ftrace_arch_code_modify_post_process(void); | |
253 | ||
c88fd863 SR |
254 | void ftrace_bug(int err, unsigned long ip); |
255 | ||
809dcf29 SR |
256 | struct seq_file; |
257 | ||
b6887d79 | 258 | struct ftrace_probe_ops { |
59df055f SR |
259 | void (*func)(unsigned long ip, |
260 | unsigned long parent_ip, | |
261 | void **data); | |
262 | int (*callback)(unsigned long ip, void **data); | |
263 | void (*free)(void **data); | |
809dcf29 SR |
264 | int (*print)(struct seq_file *m, |
265 | unsigned long ip, | |
b6887d79 | 266 | struct ftrace_probe_ops *ops, |
809dcf29 | 267 | void *data); |
59df055f SR |
268 | }; |
269 | ||
270 | extern int | |
b6887d79 | 271 | register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops, |
59df055f SR |
272 | void *data); |
273 | extern void | |
b6887d79 | 274 | unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops, |
59df055f SR |
275 | void *data); |
276 | extern void | |
b6887d79 SR |
277 | unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops); |
278 | extern void unregister_ftrace_function_probe_all(char *glob); | |
59df055f | 279 | |
2cfa1978 MH |
280 | extern int ftrace_text_reserved(void *start, void *end); |
281 | ||
ea701f11 SR |
282 | extern int ftrace_nr_registered_ops(void); |
283 | ||
08f6fba5 SR |
284 | /* |
285 | * The dyn_ftrace record's flags field is split into two parts. | |
286 | * the first part which is '0-FTRACE_REF_MAX' is a counter of | |
287 | * the number of callbacks that have registered the function that | |
288 | * the dyn_ftrace descriptor represents. | |
289 | * | |
290 | * The second part is a mask: | |
291 | * ENABLED - the function is being traced | |
292 | * REGS - the record wants the function to save regs | |
293 | * REGS_EN - the function is set up to save regs. | |
294 | * | |
295 | * When a new ftrace_ops is registered and wants a function to save | |
296 | * pt_regs, the rec->flag REGS is set. When the function has been | |
297 | * set up to save regs, the REG_EN flag is set. Once a function | |
298 | * starts saving regs it will do so until all ftrace_ops are removed | |
299 | * from tracing that function. | |
300 | */ | |
3c1720f0 | 301 | enum { |
08f6fba5 SR |
302 | FTRACE_FL_ENABLED = (1UL << 29), |
303 | FTRACE_FL_REGS = (1UL << 30), | |
304 | FTRACE_FL_REGS_EN = (1UL << 31) | |
3c1720f0 SR |
305 | }; |
306 | ||
08f6fba5 SR |
307 | #define FTRACE_FL_MASK (0x7UL << 29) |
308 | #define FTRACE_REF_MAX ((1UL << 29) - 1) | |
ed926f9b | 309 | |
3d083395 | 310 | struct dyn_ftrace { |
ee000b7f LJ |
311 | union { |
312 | unsigned long ip; /* address of mcount call-site */ | |
313 | struct dyn_ftrace *freelist; | |
314 | }; | |
85ae32ae | 315 | unsigned long flags; |
ee000b7f | 316 | struct dyn_arch_ftrace arch; |
3d083395 SR |
317 | }; |
318 | ||
e1c08bdd | 319 | int ftrace_force_update(void); |
647664ea MH |
320 | int ftrace_set_filter_ip(struct ftrace_ops *ops, unsigned long ip, |
321 | int remove, int reset); | |
ac483c44 | 322 | int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf, |
936e074b | 323 | int len, int reset); |
ac483c44 | 324 | int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf, |
936e074b SR |
325 | int len, int reset); |
326 | void ftrace_set_global_filter(unsigned char *buf, int len, int reset); | |
327 | void ftrace_set_global_notrace(unsigned char *buf, int len, int reset); | |
5500fa51 | 328 | void ftrace_free_filter(struct ftrace_ops *ops); |
e1c08bdd | 329 | |
f6180773 SR |
330 | int register_ftrace_command(struct ftrace_func_command *cmd); |
331 | int unregister_ftrace_command(struct ftrace_func_command *cmd); | |
332 | ||
c88fd863 SR |
333 | enum { |
334 | FTRACE_UPDATE_CALLS = (1 << 0), | |
335 | FTRACE_DISABLE_CALLS = (1 << 1), | |
336 | FTRACE_UPDATE_TRACE_FUNC = (1 << 2), | |
337 | FTRACE_START_FUNC_RET = (1 << 3), | |
338 | FTRACE_STOP_FUNC_RET = (1 << 4), | |
339 | }; | |
340 | ||
08f6fba5 SR |
341 | /* |
342 | * The FTRACE_UPDATE_* enum is used to pass information back | |
343 | * from the ftrace_update_record() and ftrace_test_record() | |
344 | * functions. These are called by the code update routines | |
345 | * to find out what is to be done for a given function. | |
346 | * | |
347 | * IGNORE - The function is already what we want it to be | |
348 | * MAKE_CALL - Start tracing the function | |
349 | * MODIFY_CALL - Stop saving regs for the function | |
350 | * MODIFY_CALL_REGS - Start saving regs for the function | |
351 | * MAKE_NOP - Stop tracing the function | |
352 | */ | |
c88fd863 SR |
353 | enum { |
354 | FTRACE_UPDATE_IGNORE, | |
355 | FTRACE_UPDATE_MAKE_CALL, | |
08f6fba5 SR |
356 | FTRACE_UPDATE_MODIFY_CALL, |
357 | FTRACE_UPDATE_MODIFY_CALL_REGS, | |
c88fd863 SR |
358 | FTRACE_UPDATE_MAKE_NOP, |
359 | }; | |
360 | ||
fc13cb0c SR |
361 | enum { |
362 | FTRACE_ITER_FILTER = (1 << 0), | |
363 | FTRACE_ITER_NOTRACE = (1 << 1), | |
364 | FTRACE_ITER_PRINTALL = (1 << 2), | |
69a3083c SR |
365 | FTRACE_ITER_DO_HASH = (1 << 3), |
366 | FTRACE_ITER_HASH = (1 << 4), | |
367 | FTRACE_ITER_ENABLED = (1 << 5), | |
fc13cb0c SR |
368 | }; |
369 | ||
c88fd863 SR |
370 | void arch_ftrace_update_code(int command); |
371 | ||
372 | struct ftrace_rec_iter; | |
373 | ||
374 | struct ftrace_rec_iter *ftrace_rec_iter_start(void); | |
375 | struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter); | |
376 | struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter); | |
377 | ||
08d636b6 SR |
378 | #define for_ftrace_rec_iter(iter) \ |
379 | for (iter = ftrace_rec_iter_start(); \ | |
380 | iter; \ | |
381 | iter = ftrace_rec_iter_next(iter)) | |
382 | ||
383 | ||
c88fd863 SR |
384 | int ftrace_update_record(struct dyn_ftrace *rec, int enable); |
385 | int ftrace_test_record(struct dyn_ftrace *rec, int enable); | |
386 | void ftrace_run_stop_machine(int command); | |
f0cf973a | 387 | unsigned long ftrace_location(unsigned long ip); |
c88fd863 SR |
388 | |
389 | extern ftrace_func_t ftrace_trace_function; | |
390 | ||
fc13cb0c SR |
391 | int ftrace_regex_open(struct ftrace_ops *ops, int flag, |
392 | struct inode *inode, struct file *file); | |
393 | ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf, | |
394 | size_t cnt, loff_t *ppos); | |
395 | ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf, | |
396 | size_t cnt, loff_t *ppos); | |
965c8e59 | 397 | loff_t ftrace_regex_lseek(struct file *file, loff_t offset, int whence); |
fc13cb0c SR |
398 | int ftrace_regex_release(struct inode *inode, struct file *file); |
399 | ||
2a85a37f SR |
400 | void __init |
401 | ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable); | |
402 | ||
3d083395 | 403 | /* defined in arch */ |
3c1720f0 | 404 | extern int ftrace_ip_converted(unsigned long ip); |
d61f82d0 | 405 | extern int ftrace_dyn_arch_init(void *data); |
e4f5d544 | 406 | extern void ftrace_replace_code(int enable); |
d61f82d0 SR |
407 | extern int ftrace_update_ftrace_func(ftrace_func_t func); |
408 | extern void ftrace_caller(void); | |
08f6fba5 | 409 | extern void ftrace_regs_caller(void); |
d61f82d0 | 410 | extern void ftrace_call(void); |
08f6fba5 | 411 | extern void ftrace_regs_call(void); |
d61f82d0 | 412 | extern void mcount_call(void); |
f0001207 | 413 | |
8ed3e2cf SR |
414 | void ftrace_modify_all_code(int command); |
415 | ||
f0001207 SL |
416 | #ifndef FTRACE_ADDR |
417 | #define FTRACE_ADDR ((unsigned long)ftrace_caller) | |
418 | #endif | |
08f6fba5 SR |
419 | |
420 | #ifndef FTRACE_REGS_ADDR | |
421 | #ifdef ARCH_SUPPORTS_FTRACE_SAVE_REGS | |
422 | # define FTRACE_REGS_ADDR ((unsigned long)ftrace_regs_caller) | |
423 | #else | |
424 | # define FTRACE_REGS_ADDR FTRACE_ADDR | |
425 | #endif | |
426 | #endif | |
427 | ||
fb52607a FW |
428 | #ifdef CONFIG_FUNCTION_GRAPH_TRACER |
429 | extern void ftrace_graph_caller(void); | |
5a45cfe1 SR |
430 | extern int ftrace_enable_ftrace_graph_caller(void); |
431 | extern int ftrace_disable_ftrace_graph_caller(void); | |
432 | #else | |
433 | static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; } | |
434 | static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; } | |
e7d3737e | 435 | #endif |
ad90c0e3 | 436 | |
31e88909 | 437 | /** |
57794a9d | 438 | * ftrace_make_nop - convert code into nop |
31e88909 SR |
439 | * @mod: module structure if called by module load initialization |
440 | * @rec: the mcount call site record | |
441 | * @addr: the address that the call site should be calling | |
442 | * | |
443 | * This is a very sensitive operation and great care needs | |
444 | * to be taken by the arch. The operation should carefully | |
445 | * read the location, check to see if what is read is indeed | |
446 | * what we expect it to be, and then on success of the compare, | |
447 | * it should write to the location. | |
448 | * | |
449 | * The code segment at @rec->ip should be a caller to @addr | |
450 | * | |
451 | * Return must be: | |
452 | * 0 on success | |
453 | * -EFAULT on error reading the location | |
454 | * -EINVAL on a failed compare of the contents | |
455 | * -EPERM on error writing to the location | |
456 | * Any other value will be considered a failure. | |
457 | */ | |
458 | extern int ftrace_make_nop(struct module *mod, | |
459 | struct dyn_ftrace *rec, unsigned long addr); | |
a26a2a27 | 460 | |
593eb8a2 | 461 | /** |
31e88909 SR |
462 | * ftrace_make_call - convert a nop call site into a call to addr |
463 | * @rec: the mcount call site record | |
464 | * @addr: the address that the call site should call | |
593eb8a2 SR |
465 | * |
466 | * This is a very sensitive operation and great care needs | |
467 | * to be taken by the arch. The operation should carefully | |
468 | * read the location, check to see if what is read is indeed | |
469 | * what we expect it to be, and then on success of the compare, | |
470 | * it should write to the location. | |
471 | * | |
31e88909 SR |
472 | * The code segment at @rec->ip should be a nop |
473 | * | |
593eb8a2 SR |
474 | * Return must be: |
475 | * 0 on success | |
476 | * -EFAULT on error reading the location | |
477 | * -EINVAL on a failed compare of the contents | |
478 | * -EPERM on error writing to the location | |
479 | * Any other value will be considered a failure. | |
480 | */ | |
31e88909 SR |
481 | extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr); |
482 | ||
08f6fba5 SR |
483 | #ifdef ARCH_SUPPORTS_FTRACE_SAVE_REGS |
484 | /** | |
485 | * ftrace_modify_call - convert from one addr to another (no nop) | |
486 | * @rec: the mcount call site record | |
487 | * @old_addr: the address expected to be currently called to | |
488 | * @addr: the address to change to | |
489 | * | |
490 | * This is a very sensitive operation and great care needs | |
491 | * to be taken by the arch. The operation should carefully | |
492 | * read the location, check to see if what is read is indeed | |
493 | * what we expect it to be, and then on success of the compare, | |
494 | * it should write to the location. | |
495 | * | |
496 | * The code segment at @rec->ip should be a caller to @old_addr | |
497 | * | |
498 | * Return must be: | |
499 | * 0 on success | |
500 | * -EFAULT on error reading the location | |
501 | * -EINVAL on a failed compare of the contents | |
502 | * -EPERM on error writing to the location | |
503 | * Any other value will be considered a failure. | |
504 | */ | |
505 | extern int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr, | |
506 | unsigned long addr); | |
507 | #else | |
508 | /* Should never be called */ | |
509 | static inline int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr, | |
510 | unsigned long addr) | |
511 | { | |
512 | return -EINVAL; | |
513 | } | |
514 | #endif | |
515 | ||
31e88909 SR |
516 | /* May be defined in arch */ |
517 | extern int ftrace_arch_read_dyn_info(char *buf, int size); | |
593eb8a2 | 518 | |
ecea656d AS |
519 | extern int skip_trace(unsigned long ip); |
520 | ||
c0719e5a SR |
521 | extern void ftrace_disable_daemon(void); |
522 | extern void ftrace_enable_daemon(void); | |
4dc93676 | 523 | #else /* CONFIG_DYNAMIC_FTRACE */ |
4dbf6bc2 SR |
524 | static inline int skip_trace(unsigned long ip) { return 0; } |
525 | static inline int ftrace_force_update(void) { return 0; } | |
4dbf6bc2 SR |
526 | static inline void ftrace_disable_daemon(void) { } |
527 | static inline void ftrace_enable_daemon(void) { } | |
e7247a15 | 528 | static inline void ftrace_release_mod(struct module *mod) {} |
f6180773 SR |
529 | static inline int register_ftrace_command(struct ftrace_func_command *cmd) |
530 | { | |
97d0bb8d | 531 | return -EINVAL; |
f6180773 SR |
532 | } |
533 | static inline int unregister_ftrace_command(char *cmd_name) | |
534 | { | |
97d0bb8d | 535 | return -EINVAL; |
f6180773 | 536 | } |
2cfa1978 MH |
537 | static inline int ftrace_text_reserved(void *start, void *end) |
538 | { | |
539 | return 0; | |
540 | } | |
4dc93676 SR |
541 | static inline unsigned long ftrace_location(unsigned long ip) |
542 | { | |
543 | return 0; | |
544 | } | |
fc13cb0c SR |
545 | |
546 | /* | |
547 | * Again users of functions that have ftrace_ops may not | |
548 | * have them defined when ftrace is not enabled, but these | |
549 | * functions may still be called. Use a macro instead of inline. | |
550 | */ | |
551 | #define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; }) | |
96de37b6 | 552 | #define ftrace_set_early_filter(ops, buf, enable) do { } while (0) |
647664ea | 553 | #define ftrace_set_filter_ip(ops, ip, remove, reset) ({ -ENODEV; }) |
5500fa51 JO |
554 | #define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; }) |
555 | #define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; }) | |
556 | #define ftrace_free_filter(ops) do { } while (0) | |
fc13cb0c SR |
557 | |
558 | static inline ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf, | |
559 | size_t cnt, loff_t *ppos) { return -ENODEV; } | |
560 | static inline ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf, | |
561 | size_t cnt, loff_t *ppos) { return -ENODEV; } | |
965c8e59 | 562 | static inline loff_t ftrace_regex_lseek(struct file *file, loff_t offset, int whence) |
fc13cb0c SR |
563 | { |
564 | return -ENODEV; | |
565 | } | |
566 | static inline int | |
567 | ftrace_regex_release(struct inode *inode, struct file *file) { return -ENODEV; } | |
ecea656d | 568 | #endif /* CONFIG_DYNAMIC_FTRACE */ |
352ad25a | 569 | |
aeaee8a2 IM |
570 | /* totally disable ftrace - can not re-enable after this */ |
571 | void ftrace_kill(void); | |
572 | ||
f43fdad8 IM |
573 | static inline void tracer_disable(void) |
574 | { | |
606576ce | 575 | #ifdef CONFIG_FUNCTION_TRACER |
f43fdad8 IM |
576 | ftrace_enabled = 0; |
577 | #endif | |
578 | } | |
579 | ||
37002735 HY |
580 | /* |
581 | * Ftrace disable/restore without lock. Some synchronization mechanism | |
9bdeb7b5 | 582 | * must be used to prevent ftrace_enabled to be changed between |
37002735 HY |
583 | * disable/restore. |
584 | */ | |
9bdeb7b5 HY |
585 | static inline int __ftrace_enabled_save(void) |
586 | { | |
606576ce | 587 | #ifdef CONFIG_FUNCTION_TRACER |
9bdeb7b5 HY |
588 | int saved_ftrace_enabled = ftrace_enabled; |
589 | ftrace_enabled = 0; | |
590 | return saved_ftrace_enabled; | |
591 | #else | |
592 | return 0; | |
593 | #endif | |
594 | } | |
595 | ||
596 | static inline void __ftrace_enabled_restore(int enabled) | |
597 | { | |
606576ce | 598 | #ifdef CONFIG_FUNCTION_TRACER |
9bdeb7b5 HY |
599 | ftrace_enabled = enabled; |
600 | #endif | |
601 | } | |
602 | ||
c79a61f5 UKK |
603 | #ifndef HAVE_ARCH_CALLER_ADDR |
604 | # ifdef CONFIG_FRAME_POINTER | |
605 | # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0)) | |
606 | # define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1)) | |
607 | # define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2)) | |
608 | # define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3)) | |
609 | # define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4)) | |
610 | # define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5)) | |
611 | # define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6)) | |
612 | # else | |
613 | # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0)) | |
614 | # define CALLER_ADDR1 0UL | |
615 | # define CALLER_ADDR2 0UL | |
616 | # define CALLER_ADDR3 0UL | |
617 | # define CALLER_ADDR4 0UL | |
618 | # define CALLER_ADDR5 0UL | |
619 | # define CALLER_ADDR6 0UL | |
620 | # endif | |
621 | #endif /* ifndef HAVE_ARCH_CALLER_ADDR */ | |
352ad25a | 622 | |
81d68a96 | 623 | #ifdef CONFIG_IRQSOFF_TRACER |
489f1396 IM |
624 | extern void time_hardirqs_on(unsigned long a0, unsigned long a1); |
625 | extern void time_hardirqs_off(unsigned long a0, unsigned long a1); | |
81d68a96 | 626 | #else |
4dbf6bc2 SR |
627 | static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { } |
628 | static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { } | |
81d68a96 SR |
629 | #endif |
630 | ||
6cd8a4bb | 631 | #ifdef CONFIG_PREEMPT_TRACER |
489f1396 IM |
632 | extern void trace_preempt_on(unsigned long a0, unsigned long a1); |
633 | extern void trace_preempt_off(unsigned long a0, unsigned long a1); | |
6cd8a4bb | 634 | #else |
b02ee9a3 MB |
635 | /* |
636 | * Use defines instead of static inlines because some arches will make code out | |
637 | * of the CALLER_ADDR, when we really want these to be a real nop. | |
638 | */ | |
639 | # define trace_preempt_on(a0, a1) do { } while (0) | |
640 | # define trace_preempt_off(a0, a1) do { } while (0) | |
6cd8a4bb SR |
641 | #endif |
642 | ||
68bf21aa SR |
643 | #ifdef CONFIG_FTRACE_MCOUNT_RECORD |
644 | extern void ftrace_init(void); | |
645 | #else | |
646 | static inline void ftrace_init(void) { } | |
647 | #endif | |
648 | ||
287b6e68 FW |
649 | /* |
650 | * Structure that defines an entry function trace. | |
651 | */ | |
652 | struct ftrace_graph_ent { | |
653 | unsigned long func; /* Current function */ | |
654 | int depth; | |
655 | }; | |
dd0e545f | 656 | |
caf4b323 FW |
657 | /* |
658 | * Structure that defines a return function trace. | |
659 | */ | |
fb52607a | 660 | struct ftrace_graph_ret { |
caf4b323 FW |
661 | unsigned long func; /* Current function */ |
662 | unsigned long long calltime; | |
663 | unsigned long long rettime; | |
0231022c FW |
664 | /* Number of functions that overran the depth limit for current task */ |
665 | unsigned long overrun; | |
287b6e68 | 666 | int depth; |
caf4b323 FW |
667 | }; |
668 | ||
62b915f1 JO |
669 | /* Type of the callback handlers for tracing function graph*/ |
670 | typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */ | |
671 | typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */ | |
672 | ||
fb52607a | 673 | #ifdef CONFIG_FUNCTION_GRAPH_TRACER |
8b96f011 | 674 | |
5ac9f622 | 675 | /* for init task */ |
f876d346 | 676 | #define INIT_FTRACE_GRAPH .ret_stack = NULL, |
5ac9f622 | 677 | |
712406a6 SR |
678 | /* |
679 | * Stack of return addresses for functions | |
680 | * of a thread. | |
681 | * Used in struct thread_info | |
682 | */ | |
683 | struct ftrace_ret_stack { | |
684 | unsigned long ret; | |
685 | unsigned long func; | |
686 | unsigned long long calltime; | |
a2a16d6a | 687 | unsigned long long subtime; |
71e308a2 | 688 | unsigned long fp; |
712406a6 SR |
689 | }; |
690 | ||
691 | /* | |
692 | * Primary handler of a function return. | |
693 | * It relays on ftrace_return_to_handler. | |
694 | * Defined in entry_32/64.S | |
695 | */ | |
696 | extern void return_to_handler(void); | |
697 | ||
698 | extern int | |
71e308a2 SR |
699 | ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth, |
700 | unsigned long frame_pointer); | |
712406a6 | 701 | |
8b96f011 FW |
702 | /* |
703 | * Sometimes we don't want to trace a function with the function | |
704 | * graph tracer but we want them to keep traced by the usual function | |
705 | * tracer if the function graph tracer is not configured. | |
706 | */ | |
707 | #define __notrace_funcgraph notrace | |
708 | ||
bcbc4f20 FW |
709 | /* |
710 | * We want to which function is an entrypoint of a hardirq. | |
711 | * That will help us to put a signal on output. | |
712 | */ | |
713 | #define __irq_entry __attribute__((__section__(".irqentry.text"))) | |
714 | ||
715 | /* Limits of hardirq entrypoints */ | |
716 | extern char __irqentry_text_start[]; | |
717 | extern char __irqentry_text_end[]; | |
718 | ||
f201ae23 FW |
719 | #define FTRACE_RETFUNC_DEPTH 50 |
720 | #define FTRACE_RETSTACK_ALLOC_SIZE 32 | |
287b6e68 FW |
721 | extern int register_ftrace_graph(trace_func_graph_ret_t retfunc, |
722 | trace_func_graph_ent_t entryfunc); | |
723 | ||
14a866c5 SR |
724 | extern void ftrace_graph_stop(void); |
725 | ||
287b6e68 FW |
726 | /* The current handlers in use */ |
727 | extern trace_func_graph_ret_t ftrace_graph_return; | |
728 | extern trace_func_graph_ent_t ftrace_graph_entry; | |
caf4b323 | 729 | |
fb52607a | 730 | extern void unregister_ftrace_graph(void); |
f201ae23 | 731 | |
fb52607a FW |
732 | extern void ftrace_graph_init_task(struct task_struct *t); |
733 | extern void ftrace_graph_exit_task(struct task_struct *t); | |
868baf07 | 734 | extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu); |
21a8c466 FW |
735 | |
736 | static inline int task_curr_ret_stack(struct task_struct *t) | |
737 | { | |
738 | return t->curr_ret_stack; | |
739 | } | |
380c4b14 FW |
740 | |
741 | static inline void pause_graph_tracing(void) | |
742 | { | |
743 | atomic_inc(¤t->tracing_graph_pause); | |
744 | } | |
745 | ||
746 | static inline void unpause_graph_tracing(void) | |
747 | { | |
748 | atomic_dec(¤t->tracing_graph_pause); | |
749 | } | |
5ac9f622 | 750 | #else /* !CONFIG_FUNCTION_GRAPH_TRACER */ |
8b96f011 FW |
751 | |
752 | #define __notrace_funcgraph | |
bcbc4f20 | 753 | #define __irq_entry |
5ac9f622 | 754 | #define INIT_FTRACE_GRAPH |
8b96f011 | 755 | |
fb52607a FW |
756 | static inline void ftrace_graph_init_task(struct task_struct *t) { } |
757 | static inline void ftrace_graph_exit_task(struct task_struct *t) { } | |
868baf07 | 758 | static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { } |
21a8c466 | 759 | |
62b915f1 JO |
760 | static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc, |
761 | trace_func_graph_ent_t entryfunc) | |
762 | { | |
763 | return -1; | |
764 | } | |
765 | static inline void unregister_ftrace_graph(void) { } | |
766 | ||
21a8c466 FW |
767 | static inline int task_curr_ret_stack(struct task_struct *tsk) |
768 | { | |
769 | return -1; | |
770 | } | |
380c4b14 FW |
771 | |
772 | static inline void pause_graph_tracing(void) { } | |
773 | static inline void unpause_graph_tracing(void) { } | |
5ac9f622 | 774 | #endif /* CONFIG_FUNCTION_GRAPH_TRACER */ |
caf4b323 | 775 | |
ea4e2bc4 | 776 | #ifdef CONFIG_TRACING |
ea4e2bc4 SR |
777 | |
778 | /* flags for current->trace */ | |
779 | enum { | |
780 | TSK_TRACE_FL_TRACE_BIT = 0, | |
781 | TSK_TRACE_FL_GRAPH_BIT = 1, | |
782 | }; | |
783 | enum { | |
784 | TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT, | |
785 | TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT, | |
786 | }; | |
787 | ||
788 | static inline void set_tsk_trace_trace(struct task_struct *tsk) | |
789 | { | |
790 | set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace); | |
791 | } | |
792 | ||
793 | static inline void clear_tsk_trace_trace(struct task_struct *tsk) | |
794 | { | |
795 | clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace); | |
796 | } | |
797 | ||
798 | static inline int test_tsk_trace_trace(struct task_struct *tsk) | |
799 | { | |
800 | return tsk->trace & TSK_TRACE_FL_TRACE; | |
801 | } | |
802 | ||
803 | static inline void set_tsk_trace_graph(struct task_struct *tsk) | |
804 | { | |
805 | set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace); | |
806 | } | |
807 | ||
808 | static inline void clear_tsk_trace_graph(struct task_struct *tsk) | |
809 | { | |
810 | clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace); | |
811 | } | |
812 | ||
813 | static inline int test_tsk_trace_graph(struct task_struct *tsk) | |
814 | { | |
815 | return tsk->trace & TSK_TRACE_FL_GRAPH; | |
816 | } | |
817 | ||
cecbca96 FW |
818 | enum ftrace_dump_mode; |
819 | ||
820 | extern enum ftrace_dump_mode ftrace_dump_on_oops; | |
526211bc | 821 | |
261842b7 SR |
822 | #ifdef CONFIG_PREEMPT |
823 | #define INIT_TRACE_RECURSION .trace_recursion = 0, | |
824 | #endif | |
825 | ||
ea4e2bc4 SR |
826 | #endif /* CONFIG_TRACING */ |
827 | ||
261842b7 SR |
828 | #ifndef INIT_TRACE_RECURSION |
829 | #define INIT_TRACE_RECURSION | |
830 | #endif | |
b1818748 | 831 | |
e7b8e675 MF |
832 | #ifdef CONFIG_FTRACE_SYSCALLS |
833 | ||
834 | unsigned long arch_syscall_addr(int nr); | |
835 | ||
836 | #endif /* CONFIG_FTRACE_SYSCALLS */ | |
837 | ||
16444a8a | 838 | #endif /* _LINUX_FTRACE_H */ |