ftrace: Fix output of enabled_functions for showing tramp
[linux-2.6-block.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
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.
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
SRRH
123 FTRACE_OPS_FL_DYNAMIC = 1 << 1,
124 FTRACE_OPS_FL_CONTROL = 1 << 2,
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,
b848914c
SR
137};
138
33b7f99c
SRRH
139#ifdef CONFIG_DYNAMIC_FTRACE
140/* The hash used to know what functions callbacks trace */
141struct ftrace_ops_hash {
142 struct ftrace_hash *notrace_hash;
143 struct ftrace_hash *filter_hash;
144 struct mutex regex_lock;
145};
146#endif
147
b7e00a6c
SRRH
148/*
149 * Note, ftrace_ops can be referenced outside of RCU protection.
150 * (Although, for perf, the control ops prevent that). If ftrace_ops is
151 * allocated and not part of kernel core data, the unregistering of it will
152 * perform a scheduling on all CPUs to make sure that there are no more users.
153 * Depending on the load of the system that may take a bit of time.
154 *
155 * Any private data added must also take care not to be freed and if private
156 * data is added to a ftrace_ops that is in core code, the user of the
157 * ftrace_ops must perform a schedule_on_each_cpu() before freeing it.
158 */
16444a8a 159struct ftrace_ops {
f45948e8
SR
160 ftrace_func_t func;
161 struct ftrace_ops *next;
b848914c 162 unsigned long flags;
b7e00a6c 163 void *private;
e3eea140 164 ftrace_func_t saved_func;
79922b80 165 int __percpu *disabled;
f45948e8 166#ifdef CONFIG_DYNAMIC_FTRACE
0162d621 167 int nr_trampolines;
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
JO
198/**
199 * ftrace_function_local_enable - enable controlled ftrace_ops on current cpu
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
204 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
205 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
206 */
207static inline void ftrace_function_local_enable(struct ftrace_ops *ops)
208{
209 if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
210 return;
211
212 (*this_cpu_ptr(ops->disabled))--;
213}
214
215/**
216 * ftrace_function_local_disable - enable controlled ftrace_ops on current cpu
217 *
218 * This function enables tracing on current cpu by decreasing
219 * the per cpu control variable.
220 * It must be called with preemption disabled and only on ftrace_ops
221 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
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{
226 if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
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
238 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
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{
243 WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL));
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.
08f6fba5
SR
359 *
360 * When a new ftrace_ops is registered and wants a function to save
361 * pt_regs, the rec->flag REGS is set. When the function has been
362 * set up to save regs, the REG_EN flag is set. Once a function
363 * starts saving regs it will do so until all ftrace_ops are removed
364 * from tracing that function.
365 */
3c1720f0 366enum {
79922b80 367 FTRACE_FL_ENABLED = (1UL << 31),
08f6fba5 368 FTRACE_FL_REGS = (1UL << 30),
79922b80
SRRH
369 FTRACE_FL_REGS_EN = (1UL << 29),
370 FTRACE_FL_TRAMP = (1UL << 28),
371 FTRACE_FL_TRAMP_EN = (1UL << 27),
f8b8be8a 372 FTRACE_FL_IPMODIFY = (1UL << 26),
3c1720f0
SR
373};
374
f8b8be8a
MH
375#define FTRACE_REF_MAX_SHIFT 26
376#define FTRACE_FL_BITS 6
cf2cb0b2
SRRH
377#define FTRACE_FL_MASKED_BITS ((1UL << FTRACE_FL_BITS) - 1)
378#define FTRACE_FL_MASK (FTRACE_FL_MASKED_BITS << FTRACE_REF_MAX_SHIFT)
379#define FTRACE_REF_MAX ((1UL << FTRACE_REF_MAX_SHIFT) - 1)
ed926f9b 380
0376bde1
SRRH
381#define ftrace_rec_count(rec) ((rec)->flags & ~FTRACE_FL_MASK)
382
3d083395 383struct dyn_ftrace {
a762782d 384 unsigned long ip; /* address of mcount call-site */
85ae32ae 385 unsigned long flags;
a762782d 386 struct dyn_arch_ftrace arch;
3d083395
SR
387};
388
e1c08bdd 389int ftrace_force_update(void);
647664ea
MH
390int ftrace_set_filter_ip(struct ftrace_ops *ops, unsigned long ip,
391 int remove, int reset);
ac483c44 392int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
936e074b 393 int len, int reset);
ac483c44 394int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
936e074b
SR
395 int len, int reset);
396void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
397void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
5500fa51 398void ftrace_free_filter(struct ftrace_ops *ops);
e1c08bdd 399
f6180773
SR
400int register_ftrace_command(struct ftrace_func_command *cmd);
401int unregister_ftrace_command(struct ftrace_func_command *cmd);
402
c88fd863
SR
403enum {
404 FTRACE_UPDATE_CALLS = (1 << 0),
405 FTRACE_DISABLE_CALLS = (1 << 1),
406 FTRACE_UPDATE_TRACE_FUNC = (1 << 2),
407 FTRACE_START_FUNC_RET = (1 << 3),
408 FTRACE_STOP_FUNC_RET = (1 << 4),
409};
410
08f6fba5
SR
411/*
412 * The FTRACE_UPDATE_* enum is used to pass information back
413 * from the ftrace_update_record() and ftrace_test_record()
414 * functions. These are called by the code update routines
415 * to find out what is to be done for a given function.
416 *
417 * IGNORE - The function is already what we want it to be
418 * MAKE_CALL - Start tracing the function
419 * MODIFY_CALL - Stop saving regs for the function
08f6fba5
SR
420 * MAKE_NOP - Stop tracing the function
421 */
c88fd863
SR
422enum {
423 FTRACE_UPDATE_IGNORE,
424 FTRACE_UPDATE_MAKE_CALL,
08f6fba5 425 FTRACE_UPDATE_MODIFY_CALL,
c88fd863
SR
426 FTRACE_UPDATE_MAKE_NOP,
427};
428
fc13cb0c
SR
429enum {
430 FTRACE_ITER_FILTER = (1 << 0),
431 FTRACE_ITER_NOTRACE = (1 << 1),
432 FTRACE_ITER_PRINTALL = (1 << 2),
69a3083c
SR
433 FTRACE_ITER_DO_HASH = (1 << 3),
434 FTRACE_ITER_HASH = (1 << 4),
435 FTRACE_ITER_ENABLED = (1 << 5),
fc13cb0c
SR
436};
437
c88fd863
SR
438void arch_ftrace_update_code(int command);
439
440struct ftrace_rec_iter;
441
442struct ftrace_rec_iter *ftrace_rec_iter_start(void);
443struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter);
444struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter);
445
08d636b6
SR
446#define for_ftrace_rec_iter(iter) \
447 for (iter = ftrace_rec_iter_start(); \
448 iter; \
449 iter = ftrace_rec_iter_next(iter))
450
451
c88fd863
SR
452int ftrace_update_record(struct dyn_ftrace *rec, int enable);
453int ftrace_test_record(struct dyn_ftrace *rec, int enable);
454void ftrace_run_stop_machine(int command);
f0cf973a 455unsigned long ftrace_location(unsigned long ip);
7413af1f
SRRH
456unsigned long ftrace_get_addr_new(struct dyn_ftrace *rec);
457unsigned long ftrace_get_addr_curr(struct dyn_ftrace *rec);
c88fd863
SR
458
459extern ftrace_func_t ftrace_trace_function;
460
fc13cb0c
SR
461int ftrace_regex_open(struct ftrace_ops *ops, int flag,
462 struct inode *inode, struct file *file);
463ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
464 size_t cnt, loff_t *ppos);
465ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
466 size_t cnt, loff_t *ppos);
fc13cb0c
SR
467int ftrace_regex_release(struct inode *inode, struct file *file);
468
2a85a37f
SR
469void __init
470ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable);
471
3d083395 472/* defined in arch */
3c1720f0 473extern int ftrace_ip_converted(unsigned long ip);
3a36cb11 474extern int ftrace_dyn_arch_init(void);
e4f5d544 475extern void ftrace_replace_code(int enable);
d61f82d0
SR
476extern int ftrace_update_ftrace_func(ftrace_func_t func);
477extern void ftrace_caller(void);
08f6fba5 478extern void ftrace_regs_caller(void);
d61f82d0 479extern void ftrace_call(void);
08f6fba5 480extern void ftrace_regs_call(void);
d61f82d0 481extern void mcount_call(void);
f0001207 482
8ed3e2cf
SR
483void ftrace_modify_all_code(int command);
484
f0001207
SL
485#ifndef FTRACE_ADDR
486#define FTRACE_ADDR ((unsigned long)ftrace_caller)
487#endif
08f6fba5 488
79922b80
SRRH
489#ifndef FTRACE_GRAPH_ADDR
490#define FTRACE_GRAPH_ADDR ((unsigned long)ftrace_graph_caller)
491#endif
492
08f6fba5 493#ifndef FTRACE_REGS_ADDR
06aeaaea 494#ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
08f6fba5
SR
495# define FTRACE_REGS_ADDR ((unsigned long)ftrace_regs_caller)
496#else
497# define FTRACE_REGS_ADDR FTRACE_ADDR
498#endif
499#endif
500
646d7043
SRRH
501/*
502 * If an arch would like functions that are only traced
503 * by the function graph tracer to jump directly to its own
504 * trampoline, then they can define FTRACE_GRAPH_TRAMP_ADDR
505 * to be that address to jump to.
506 */
507#ifndef FTRACE_GRAPH_TRAMP_ADDR
508#define FTRACE_GRAPH_TRAMP_ADDR ((unsigned long) 0)
509#endif
510
fb52607a
FW
511#ifdef CONFIG_FUNCTION_GRAPH_TRACER
512extern void ftrace_graph_caller(void);
5a45cfe1
SR
513extern int ftrace_enable_ftrace_graph_caller(void);
514extern int ftrace_disable_ftrace_graph_caller(void);
515#else
516static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
517static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
e7d3737e 518#endif
ad90c0e3 519
31e88909 520/**
57794a9d 521 * ftrace_make_nop - convert code into nop
31e88909
SR
522 * @mod: module structure if called by module load initialization
523 * @rec: the mcount call site record
524 * @addr: the address that the call site should be calling
525 *
526 * This is a very sensitive operation and great care needs
527 * to be taken by the arch. The operation should carefully
528 * read the location, check to see if what is read is indeed
529 * what we expect it to be, and then on success of the compare,
530 * it should write to the location.
531 *
532 * The code segment at @rec->ip should be a caller to @addr
533 *
534 * Return must be:
535 * 0 on success
536 * -EFAULT on error reading the location
537 * -EINVAL on a failed compare of the contents
538 * -EPERM on error writing to the location
539 * Any other value will be considered a failure.
540 */
541extern int ftrace_make_nop(struct module *mod,
542 struct dyn_ftrace *rec, unsigned long addr);
a26a2a27 543
593eb8a2 544/**
31e88909
SR
545 * ftrace_make_call - convert a nop call site into a call to addr
546 * @rec: the mcount call site record
547 * @addr: the address that the call site should call
593eb8a2
SR
548 *
549 * This is a very sensitive operation and great care needs
550 * to be taken by the arch. The operation should carefully
551 * read the location, check to see if what is read is indeed
552 * what we expect it to be, and then on success of the compare,
553 * it should write to the location.
554 *
31e88909
SR
555 * The code segment at @rec->ip should be a nop
556 *
593eb8a2
SR
557 * Return must be:
558 * 0 on success
559 * -EFAULT on error reading the location
560 * -EINVAL on a failed compare of the contents
561 * -EPERM on error writing to the location
562 * Any other value will be considered a failure.
563 */
31e88909
SR
564extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
565
06aeaaea 566#ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
08f6fba5
SR
567/**
568 * ftrace_modify_call - convert from one addr to another (no nop)
569 * @rec: the mcount call site record
570 * @old_addr: the address expected to be currently called to
571 * @addr: the address to change to
572 *
573 * This is a very sensitive operation and great care needs
574 * to be taken by the arch. The operation should carefully
575 * read the location, check to see if what is read is indeed
576 * what we expect it to be, and then on success of the compare,
577 * it should write to the location.
578 *
579 * The code segment at @rec->ip should be a caller to @old_addr
580 *
581 * Return must be:
582 * 0 on success
583 * -EFAULT on error reading the location
584 * -EINVAL on a failed compare of the contents
585 * -EPERM on error writing to the location
586 * Any other value will be considered a failure.
587 */
588extern int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
589 unsigned long addr);
590#else
591/* Should never be called */
592static inline int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
593 unsigned long addr)
594{
595 return -EINVAL;
596}
597#endif
598
31e88909
SR
599/* May be defined in arch */
600extern int ftrace_arch_read_dyn_info(char *buf, int size);
593eb8a2 601
ecea656d 602extern int skip_trace(unsigned long ip);
a949ae56 603extern void ftrace_module_init(struct module *mod);
ecea656d 604
c0719e5a
SR
605extern void ftrace_disable_daemon(void);
606extern void ftrace_enable_daemon(void);
4dc93676 607#else /* CONFIG_DYNAMIC_FTRACE */
4dbf6bc2
SR
608static inline int skip_trace(unsigned long ip) { return 0; }
609static inline int ftrace_force_update(void) { return 0; }
4dbf6bc2
SR
610static inline void ftrace_disable_daemon(void) { }
611static inline void ftrace_enable_daemon(void) { }
e7247a15 612static inline void ftrace_release_mod(struct module *mod) {}
a949ae56 613static inline void ftrace_module_init(struct module *mod) {}
38de93ab 614static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
f6180773 615{
97d0bb8d 616 return -EINVAL;
f6180773 617}
38de93ab 618static inline __init int unregister_ftrace_command(char *cmd_name)
f6180773 619{
97d0bb8d 620 return -EINVAL;
f6180773 621}
d88471cb 622static inline int ftrace_text_reserved(const void *start, const void *end)
2cfa1978
MH
623{
624 return 0;
625}
4dc93676
SR
626static inline unsigned long ftrace_location(unsigned long ip)
627{
628 return 0;
629}
fc13cb0c
SR
630
631/*
632 * Again users of functions that have ftrace_ops may not
633 * have them defined when ftrace is not enabled, but these
634 * functions may still be called. Use a macro instead of inline.
635 */
636#define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; })
96de37b6 637#define ftrace_set_early_filter(ops, buf, enable) do { } while (0)
647664ea 638#define ftrace_set_filter_ip(ops, ip, remove, reset) ({ -ENODEV; })
5500fa51
JO
639#define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; })
640#define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; })
641#define ftrace_free_filter(ops) do { } while (0)
fc13cb0c
SR
642
643static inline ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
644 size_t cnt, loff_t *ppos) { return -ENODEV; }
645static inline ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
646 size_t cnt, loff_t *ppos) { return -ENODEV; }
fc13cb0c
SR
647static inline int
648ftrace_regex_release(struct inode *inode, struct file *file) { return -ENODEV; }
aec0be2d
SRRH
649
650static inline bool is_ftrace_trampoline(unsigned long addr)
651{
652 return false;
653}
ecea656d 654#endif /* CONFIG_DYNAMIC_FTRACE */
352ad25a 655
aeaee8a2
IM
656/* totally disable ftrace - can not re-enable after this */
657void ftrace_kill(void);
658
f43fdad8
IM
659static inline void tracer_disable(void)
660{
606576ce 661#ifdef CONFIG_FUNCTION_TRACER
f43fdad8
IM
662 ftrace_enabled = 0;
663#endif
664}
665
37002735
HY
666/*
667 * Ftrace disable/restore without lock. Some synchronization mechanism
9bdeb7b5 668 * must be used to prevent ftrace_enabled to be changed between
37002735
HY
669 * disable/restore.
670 */
9bdeb7b5
HY
671static inline int __ftrace_enabled_save(void)
672{
606576ce 673#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
674 int saved_ftrace_enabled = ftrace_enabled;
675 ftrace_enabled = 0;
676 return saved_ftrace_enabled;
677#else
678 return 0;
679#endif
680}
681
682static inline void __ftrace_enabled_restore(int enabled)
683{
606576ce 684#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
685 ftrace_enabled = enabled;
686#endif
687}
688
eed542d6
AT
689/* All archs should have this, but we define it for consistency */
690#ifndef ftrace_return_address0
691# define ftrace_return_address0 __builtin_return_address(0)
692#endif
693
694/* Archs may use other ways for ADDR1 and beyond */
695#ifndef ftrace_return_address
c79a61f5 696# ifdef CONFIG_FRAME_POINTER
eed542d6 697# define ftrace_return_address(n) __builtin_return_address(n)
c79a61f5 698# else
eed542d6 699# define ftrace_return_address(n) 0UL
c79a61f5 700# endif
eed542d6
AT
701#endif
702
703#define CALLER_ADDR0 ((unsigned long)ftrace_return_address0)
704#define CALLER_ADDR1 ((unsigned long)ftrace_return_address(1))
705#define CALLER_ADDR2 ((unsigned long)ftrace_return_address(2))
706#define CALLER_ADDR3 ((unsigned long)ftrace_return_address(3))
707#define CALLER_ADDR4 ((unsigned long)ftrace_return_address(4))
708#define CALLER_ADDR5 ((unsigned long)ftrace_return_address(5))
709#define CALLER_ADDR6 ((unsigned long)ftrace_return_address(6))
352ad25a 710
81d68a96 711#ifdef CONFIG_IRQSOFF_TRACER
489f1396
IM
712 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
713 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
81d68a96 714#else
4dbf6bc2
SR
715 static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
716 static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
81d68a96
SR
717#endif
718
6cd8a4bb 719#ifdef CONFIG_PREEMPT_TRACER
489f1396
IM
720 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
721 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
6cd8a4bb 722#else
b02ee9a3
MB
723/*
724 * Use defines instead of static inlines because some arches will make code out
725 * of the CALLER_ADDR, when we really want these to be a real nop.
726 */
727# define trace_preempt_on(a0, a1) do { } while (0)
728# define trace_preempt_off(a0, a1) do { } while (0)
6cd8a4bb
SR
729#endif
730
68bf21aa
SR
731#ifdef CONFIG_FTRACE_MCOUNT_RECORD
732extern void ftrace_init(void);
733#else
734static inline void ftrace_init(void) { }
735#endif
736
287b6e68
FW
737/*
738 * Structure that defines an entry function trace.
739 */
740struct ftrace_graph_ent {
741 unsigned long func; /* Current function */
742 int depth;
743};
dd0e545f 744
caf4b323
FW
745/*
746 * Structure that defines a return function trace.
747 */
fb52607a 748struct ftrace_graph_ret {
caf4b323
FW
749 unsigned long func; /* Current function */
750 unsigned long long calltime;
751 unsigned long long rettime;
0231022c
FW
752 /* Number of functions that overran the depth limit for current task */
753 unsigned long overrun;
287b6e68 754 int depth;
caf4b323
FW
755};
756
62b915f1
JO
757/* Type of the callback handlers for tracing function graph*/
758typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
759typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
760
fb52607a 761#ifdef CONFIG_FUNCTION_GRAPH_TRACER
8b96f011 762
5ac9f622 763/* for init task */
f876d346 764#define INIT_FTRACE_GRAPH .ret_stack = NULL,
5ac9f622 765
712406a6
SR
766/*
767 * Stack of return addresses for functions
768 * of a thread.
769 * Used in struct thread_info
770 */
771struct ftrace_ret_stack {
772 unsigned long ret;
773 unsigned long func;
774 unsigned long long calltime;
a2a16d6a 775 unsigned long long subtime;
71e308a2 776 unsigned long fp;
712406a6
SR
777};
778
779/*
780 * Primary handler of a function return.
781 * It relays on ftrace_return_to_handler.
782 * Defined in entry_32/64.S
783 */
784extern void return_to_handler(void);
785
786extern int
71e308a2
SR
787ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
788 unsigned long frame_pointer);
712406a6 789
8b96f011
FW
790/*
791 * Sometimes we don't want to trace a function with the function
792 * graph tracer but we want them to keep traced by the usual function
793 * tracer if the function graph tracer is not configured.
794 */
795#define __notrace_funcgraph notrace
796
bcbc4f20
FW
797/*
798 * We want to which function is an entrypoint of a hardirq.
799 * That will help us to put a signal on output.
800 */
801#define __irq_entry __attribute__((__section__(".irqentry.text")))
802
803/* Limits of hardirq entrypoints */
804extern char __irqentry_text_start[];
805extern char __irqentry_text_end[];
806
29ad23b0 807#define FTRACE_NOTRACE_DEPTH 65536
f201ae23
FW
808#define FTRACE_RETFUNC_DEPTH 50
809#define FTRACE_RETSTACK_ALLOC_SIZE 32
287b6e68
FW
810extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
811 trace_func_graph_ent_t entryfunc);
812
1b2f121c 813extern bool ftrace_graph_is_dead(void);
14a866c5
SR
814extern void ftrace_graph_stop(void);
815
287b6e68
FW
816/* The current handlers in use */
817extern trace_func_graph_ret_t ftrace_graph_return;
818extern trace_func_graph_ent_t ftrace_graph_entry;
caf4b323 819
fb52607a 820extern void unregister_ftrace_graph(void);
f201ae23 821
fb52607a
FW
822extern void ftrace_graph_init_task(struct task_struct *t);
823extern void ftrace_graph_exit_task(struct task_struct *t);
868baf07 824extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
21a8c466
FW
825
826static inline int task_curr_ret_stack(struct task_struct *t)
827{
828 return t->curr_ret_stack;
829}
380c4b14
FW
830
831static inline void pause_graph_tracing(void)
832{
833 atomic_inc(&current->tracing_graph_pause);
834}
835
836static inline void unpause_graph_tracing(void)
837{
838 atomic_dec(&current->tracing_graph_pause);
839}
5ac9f622 840#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
8b96f011
FW
841
842#define __notrace_funcgraph
bcbc4f20 843#define __irq_entry
5ac9f622 844#define INIT_FTRACE_GRAPH
8b96f011 845
fb52607a
FW
846static inline void ftrace_graph_init_task(struct task_struct *t) { }
847static inline void ftrace_graph_exit_task(struct task_struct *t) { }
868baf07 848static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
21a8c466 849
62b915f1
JO
850static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
851 trace_func_graph_ent_t entryfunc)
852{
853 return -1;
854}
855static inline void unregister_ftrace_graph(void) { }
856
21a8c466
FW
857static inline int task_curr_ret_stack(struct task_struct *tsk)
858{
859 return -1;
860}
380c4b14
FW
861
862static inline void pause_graph_tracing(void) { }
863static inline void unpause_graph_tracing(void) { }
5ac9f622 864#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
caf4b323 865
ea4e2bc4 866#ifdef CONFIG_TRACING
ea4e2bc4
SR
867
868/* flags for current->trace */
869enum {
870 TSK_TRACE_FL_TRACE_BIT = 0,
871 TSK_TRACE_FL_GRAPH_BIT = 1,
872};
873enum {
874 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
875 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
876};
877
878static inline void set_tsk_trace_trace(struct task_struct *tsk)
879{
880 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
881}
882
883static inline void clear_tsk_trace_trace(struct task_struct *tsk)
884{
885 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
886}
887
888static inline int test_tsk_trace_trace(struct task_struct *tsk)
889{
890 return tsk->trace & TSK_TRACE_FL_TRACE;
891}
892
893static inline void set_tsk_trace_graph(struct task_struct *tsk)
894{
895 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
896}
897
898static inline void clear_tsk_trace_graph(struct task_struct *tsk)
899{
900 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
901}
902
903static inline int test_tsk_trace_graph(struct task_struct *tsk)
904{
905 return tsk->trace & TSK_TRACE_FL_GRAPH;
906}
907
cecbca96
FW
908enum ftrace_dump_mode;
909
910extern enum ftrace_dump_mode ftrace_dump_on_oops;
0daa2302 911extern int tracepoint_printk;
526211bc 912
de7edd31
SRRH
913extern void disable_trace_on_warning(void);
914extern int __disable_trace_on_warning;
915
261842b7
SR
916#ifdef CONFIG_PREEMPT
917#define INIT_TRACE_RECURSION .trace_recursion = 0,
918#endif
919
de7edd31
SRRH
920#else /* CONFIG_TRACING */
921static inline void disable_trace_on_warning(void) { }
ea4e2bc4
SR
922#endif /* CONFIG_TRACING */
923
261842b7
SR
924#ifndef INIT_TRACE_RECURSION
925#define INIT_TRACE_RECURSION
926#endif
b1818748 927
e7b8e675
MF
928#ifdef CONFIG_FTRACE_SYSCALLS
929
930unsigned long arch_syscall_addr(int nr);
931
932#endif /* CONFIG_FTRACE_SYSCALLS */
933
16444a8a 934#endif /* _LINUX_FTRACE_H */