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