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