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