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