tracing/ftrace: fix missing include string.h
[linux-2.6-block.git] / include / linux / ftrace.h
CommitLineData
16444a8a
ACM
1#ifndef _LINUX_FTRACE_H
2#define _LINUX_FTRACE_H
3
0012693a 4#include <linux/trace_clock.h>
5601020f 5#include <linux/kallsyms.h>
0012693a 6#include <linux/linkage.h>
ea4e2bc4 7#include <linux/bitops.h>
0012693a
FW
8#include <linux/module.h>
9#include <linux/ktime.h>
21a8c466 10#include <linux/sched.h>
0012693a
FW
11#include <linux/types.h>
12#include <linux/init.h>
13#include <linux/fs.h>
16444a8a 14
c79a61f5
UKK
15#include <asm/ftrace.h>
16
606576ce 17#ifdef CONFIG_FUNCTION_TRACER
3e1932ad 18
b0fc494f
SR
19extern int ftrace_enabled;
20extern int
21ftrace_enable_sysctl(struct ctl_table *table, int write,
22 struct file *filp, void __user *buffer, size_t *lenp,
23 loff_t *ppos);
24
16444a8a
ACM
25typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
26
27struct ftrace_ops {
28 ftrace_func_t func;
29 struct ftrace_ops *next;
30};
31
60a7ecf4
SR
32extern int function_trace_stop;
33
e7d3737e
FW
34/*
35 * Type of the current tracing.
36 */
37enum ftrace_tracing_type_t {
38 FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
39 FTRACE_TYPE_RETURN, /* Hook the return of the function */
40};
41
42/* Current tracing type, default is FTRACE_TYPE_ENTER */
43extern enum ftrace_tracing_type_t ftrace_tracing_type;
44
60a7ecf4
SR
45/**
46 * ftrace_stop - stop function tracer.
47 *
48 * A quick way to stop the function tracer. Note this an on off switch,
49 * it is not something that is recursive like preempt_disable.
50 * This does not disable the calling of mcount, it only stops the
51 * calling of functions from mcount.
52 */
53static inline void ftrace_stop(void)
54{
55 function_trace_stop = 1;
56}
57
58/**
59 * ftrace_start - start the function tracer.
60 *
61 * This function is the inverse of ftrace_stop. This does not enable
62 * the function tracing if the function tracer is disabled. This only
63 * sets the function tracer flag to continue calling the functions
64 * from mcount.
65 */
66static inline void ftrace_start(void)
67{
68 function_trace_stop = 0;
69}
70
16444a8a
ACM
71/*
72 * The ftrace_ops must be a static and should also
73 * be read_mostly. These functions do modify read_mostly variables
74 * so use them sparely. Never free an ftrace_op or modify the
75 * next pointer after it has been registered. Even after unregistering
76 * it, the next pointer may still be used internally.
77 */
78int register_ftrace_function(struct ftrace_ops *ops);
79int unregister_ftrace_function(struct ftrace_ops *ops);
80void clear_ftrace_function(void);
81
82extern void ftrace_stub(unsigned long a0, unsigned long a1);
16444a8a 83
606576ce 84#else /* !CONFIG_FUNCTION_TRACER */
16444a8a
ACM
85# define register_ftrace_function(ops) do { } while (0)
86# define unregister_ftrace_function(ops) do { } while (0)
87# define clear_ftrace_function(ops) do { } while (0)
81adbdc0 88static inline void ftrace_kill(void) { }
60a7ecf4
SR
89static inline void ftrace_stop(void) { }
90static inline void ftrace_start(void) { }
606576ce 91#endif /* CONFIG_FUNCTION_TRACER */
352ad25a 92
f38f1d2a
SR
93#ifdef CONFIG_STACK_TRACER
94extern int stack_tracer_enabled;
95int
96stack_trace_sysctl(struct ctl_table *table, int write,
97 struct file *file, void __user *buffer, size_t *lenp,
98 loff_t *ppos);
99#endif
100
f6180773
SR
101struct ftrace_func_command {
102 struct list_head list;
103 char *name;
104 int (*func)(char *func, char *cmd,
105 char *params, int enable);
106};
107
3d083395 108#ifdef CONFIG_DYNAMIC_FTRACE
31e88909 109
000ab691
SR
110int ftrace_arch_code_modify_prepare(void);
111int ftrace_arch_code_modify_post_process(void);
112
809dcf29
SR
113struct seq_file;
114
b6887d79 115struct ftrace_probe_ops {
59df055f
SR
116 void (*func)(unsigned long ip,
117 unsigned long parent_ip,
118 void **data);
119 int (*callback)(unsigned long ip, void **data);
120 void (*free)(void **data);
809dcf29
SR
121 int (*print)(struct seq_file *m,
122 unsigned long ip,
b6887d79 123 struct ftrace_probe_ops *ops,
809dcf29 124 void *data);
59df055f
SR
125};
126
127extern int
b6887d79 128register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
59df055f
SR
129 void *data);
130extern void
b6887d79 131unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
59df055f
SR
132 void *data);
133extern void
b6887d79
SR
134unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
135extern void unregister_ftrace_function_probe_all(char *glob);
59df055f 136
3c1720f0 137enum {
37ad5084
SR
138 FTRACE_FL_FREE = (1 << 0),
139 FTRACE_FL_FAILED = (1 << 1),
140 FTRACE_FL_FILTER = (1 << 2),
141 FTRACE_FL_ENABLED = (1 << 3),
41c52c0d 142 FTRACE_FL_NOTRACE = (1 << 4),
0eb96701 143 FTRACE_FL_CONVERTED = (1 << 5),
ecea656d 144 FTRACE_FL_FROZEN = (1 << 6),
3c1720f0
SR
145};
146
3d083395 147struct dyn_ftrace {
ee000b7f
LJ
148 union {
149 unsigned long ip; /* address of mcount call-site */
150 struct dyn_ftrace *freelist;
151 };
152 union {
153 unsigned long flags;
154 struct dyn_ftrace *newlist;
155 };
156 struct dyn_arch_ftrace arch;
3d083395
SR
157};
158
e1c08bdd 159int ftrace_force_update(void);
77a2b37d 160void ftrace_set_filter(unsigned char *buf, int len, int reset);
e1c08bdd 161
f6180773
SR
162int register_ftrace_command(struct ftrace_func_command *cmd);
163int unregister_ftrace_command(struct ftrace_func_command *cmd);
164
3d083395 165/* defined in arch */
3c1720f0 166extern int ftrace_ip_converted(unsigned long ip);
d61f82d0 167extern int ftrace_dyn_arch_init(void *data);
d61f82d0
SR
168extern int ftrace_update_ftrace_func(ftrace_func_t func);
169extern void ftrace_caller(void);
170extern void ftrace_call(void);
171extern void mcount_call(void);
f0001207
SL
172
173#ifndef FTRACE_ADDR
174#define FTRACE_ADDR ((unsigned long)ftrace_caller)
175#endif
fb52607a
FW
176#ifdef CONFIG_FUNCTION_GRAPH_TRACER
177extern void ftrace_graph_caller(void);
5a45cfe1
SR
178extern int ftrace_enable_ftrace_graph_caller(void);
179extern int ftrace_disable_ftrace_graph_caller(void);
180#else
181static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
182static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
e7d3737e 183#endif
ad90c0e3 184
31e88909 185/**
57794a9d 186 * ftrace_make_nop - convert code into nop
31e88909
SR
187 * @mod: module structure if called by module load initialization
188 * @rec: the mcount call site record
189 * @addr: the address that the call site should be calling
190 *
191 * This is a very sensitive operation and great care needs
192 * to be taken by the arch. The operation should carefully
193 * read the location, check to see if what is read is indeed
194 * what we expect it to be, and then on success of the compare,
195 * it should write to the location.
196 *
197 * The code segment at @rec->ip should be a caller to @addr
198 *
199 * Return must be:
200 * 0 on success
201 * -EFAULT on error reading the location
202 * -EINVAL on a failed compare of the contents
203 * -EPERM on error writing to the location
204 * Any other value will be considered a failure.
205 */
206extern int ftrace_make_nop(struct module *mod,
207 struct dyn_ftrace *rec, unsigned long addr);
a26a2a27 208
593eb8a2 209/**
31e88909
SR
210 * ftrace_make_call - convert a nop call site into a call to addr
211 * @rec: the mcount call site record
212 * @addr: the address that the call site should call
593eb8a2
SR
213 *
214 * This is a very sensitive operation and great care needs
215 * to be taken by the arch. The operation should carefully
216 * read the location, check to see if what is read is indeed
217 * what we expect it to be, and then on success of the compare,
218 * it should write to the location.
219 *
31e88909
SR
220 * The code segment at @rec->ip should be a nop
221 *
593eb8a2
SR
222 * Return must be:
223 * 0 on success
224 * -EFAULT on error reading the location
225 * -EINVAL on a failed compare of the contents
226 * -EPERM on error writing to the location
227 * Any other value will be considered a failure.
228 */
31e88909
SR
229extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
230
31e88909
SR
231/* May be defined in arch */
232extern int ftrace_arch_read_dyn_info(char *buf, int size);
593eb8a2 233
ecea656d
AS
234extern int skip_trace(unsigned long ip);
235
c0719e5a
SR
236extern void ftrace_release(void *start, unsigned long size);
237
238extern void ftrace_disable_daemon(void);
239extern void ftrace_enable_daemon(void);
e1c08bdd 240#else
ecea656d 241# define skip_trace(ip) ({ 0; })
aeaee8a2
IM
242# define ftrace_force_update() ({ 0; })
243# define ftrace_set_filter(buf, len, reset) do { } while (0)
ad90c0e3
SR
244# define ftrace_disable_daemon() do { } while (0)
245# define ftrace_enable_daemon() do { } while (0)
c0719e5a 246static inline void ftrace_release(void *start, unsigned long size) { }
f6180773
SR
247static inline int register_ftrace_command(struct ftrace_func_command *cmd)
248{
97d0bb8d 249 return -EINVAL;
f6180773
SR
250}
251static inline int unregister_ftrace_command(char *cmd_name)
252{
97d0bb8d 253 return -EINVAL;
f6180773 254}
ecea656d 255#endif /* CONFIG_DYNAMIC_FTRACE */
352ad25a 256
aeaee8a2
IM
257/* totally disable ftrace - can not re-enable after this */
258void ftrace_kill(void);
259
f43fdad8
IM
260static inline void tracer_disable(void)
261{
606576ce 262#ifdef CONFIG_FUNCTION_TRACER
f43fdad8
IM
263 ftrace_enabled = 0;
264#endif
265}
266
37002735
HY
267/*
268 * Ftrace disable/restore without lock. Some synchronization mechanism
9bdeb7b5 269 * must be used to prevent ftrace_enabled to be changed between
37002735
HY
270 * disable/restore.
271 */
9bdeb7b5
HY
272static inline int __ftrace_enabled_save(void)
273{
606576ce 274#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
275 int saved_ftrace_enabled = ftrace_enabled;
276 ftrace_enabled = 0;
277 return saved_ftrace_enabled;
278#else
279 return 0;
280#endif
281}
282
283static inline void __ftrace_enabled_restore(int enabled)
284{
606576ce 285#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
286 ftrace_enabled = enabled;
287#endif
288}
289
c79a61f5
UKK
290#ifndef HAVE_ARCH_CALLER_ADDR
291# ifdef CONFIG_FRAME_POINTER
292# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
293# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
294# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
295# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
296# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
297# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
298# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
299# else
300# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
301# define CALLER_ADDR1 0UL
302# define CALLER_ADDR2 0UL
303# define CALLER_ADDR3 0UL
304# define CALLER_ADDR4 0UL
305# define CALLER_ADDR5 0UL
306# define CALLER_ADDR6 0UL
307# endif
308#endif /* ifndef HAVE_ARCH_CALLER_ADDR */
352ad25a 309
81d68a96 310#ifdef CONFIG_IRQSOFF_TRACER
489f1396
IM
311 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
312 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
81d68a96
SR
313#else
314# define time_hardirqs_on(a0, a1) do { } while (0)
315# define time_hardirqs_off(a0, a1) do { } while (0)
316#endif
317
6cd8a4bb 318#ifdef CONFIG_PREEMPT_TRACER
489f1396
IM
319 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
320 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
6cd8a4bb
SR
321#else
322# define trace_preempt_on(a0, a1) do { } while (0)
323# define trace_preempt_off(a0, a1) do { } while (0)
324#endif
325
68bf21aa
SR
326#ifdef CONFIG_FTRACE_MCOUNT_RECORD
327extern void ftrace_init(void);
31e88909
SR
328extern void ftrace_init_module(struct module *mod,
329 unsigned long *start, unsigned long *end);
68bf21aa
SR
330#else
331static inline void ftrace_init(void) { }
90d595fe 332static inline void
31e88909
SR
333ftrace_init_module(struct module *mod,
334 unsigned long *start, unsigned long *end) { }
68bf21aa
SR
335#endif
336
287b6e68
FW
337/*
338 * Structure that defines an entry function trace.
339 */
340struct ftrace_graph_ent {
341 unsigned long func; /* Current function */
342 int depth;
343};
dd0e545f 344
caf4b323
FW
345/*
346 * Structure that defines a return function trace.
347 */
fb52607a 348struct ftrace_graph_ret {
caf4b323
FW
349 unsigned long func; /* Current function */
350 unsigned long long calltime;
351 unsigned long long rettime;
0231022c
FW
352 /* Number of functions that overran the depth limit for current task */
353 unsigned long overrun;
287b6e68 354 int depth;
caf4b323
FW
355};
356
fb52607a 357#ifdef CONFIG_FUNCTION_GRAPH_TRACER
8b96f011 358
712406a6
SR
359/*
360 * Stack of return addresses for functions
361 * of a thread.
362 * Used in struct thread_info
363 */
364struct ftrace_ret_stack {
365 unsigned long ret;
366 unsigned long func;
367 unsigned long long calltime;
368};
369
370/*
371 * Primary handler of a function return.
372 * It relays on ftrace_return_to_handler.
373 * Defined in entry_32/64.S
374 */
375extern void return_to_handler(void);
376
377extern int
5d1a03dc 378ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth);
712406a6
SR
379extern void
380ftrace_pop_return_trace(struct ftrace_graph_ret *trace, unsigned long *ret);
381
8b96f011
FW
382/*
383 * Sometimes we don't want to trace a function with the function
384 * graph tracer but we want them to keep traced by the usual function
385 * tracer if the function graph tracer is not configured.
386 */
387#define __notrace_funcgraph notrace
388
bcbc4f20
FW
389/*
390 * We want to which function is an entrypoint of a hardirq.
391 * That will help us to put a signal on output.
392 */
393#define __irq_entry __attribute__((__section__(".irqentry.text")))
394
395/* Limits of hardirq entrypoints */
396extern char __irqentry_text_start[];
397extern char __irqentry_text_end[];
398
f201ae23
FW
399#define FTRACE_RETFUNC_DEPTH 50
400#define FTRACE_RETSTACK_ALLOC_SIZE 32
287b6e68
FW
401/* Type of the callback handlers for tracing function graph*/
402typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
e49dc19c 403typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
287b6e68
FW
404
405extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
406 trace_func_graph_ent_t entryfunc);
407
14a866c5
SR
408extern void ftrace_graph_stop(void);
409
287b6e68
FW
410/* The current handlers in use */
411extern trace_func_graph_ret_t ftrace_graph_return;
412extern trace_func_graph_ent_t ftrace_graph_entry;
caf4b323 413
fb52607a 414extern void unregister_ftrace_graph(void);
f201ae23 415
fb52607a
FW
416extern void ftrace_graph_init_task(struct task_struct *t);
417extern void ftrace_graph_exit_task(struct task_struct *t);
21a8c466
FW
418
419static inline int task_curr_ret_stack(struct task_struct *t)
420{
421 return t->curr_ret_stack;
422}
380c4b14
FW
423
424static inline void pause_graph_tracing(void)
425{
426 atomic_inc(&current->tracing_graph_pause);
427}
428
429static inline void unpause_graph_tracing(void)
430{
431 atomic_dec(&current->tracing_graph_pause);
432}
82f60f0b 433#else
8b96f011
FW
434
435#define __notrace_funcgraph
bcbc4f20 436#define __irq_entry
8b96f011 437
fb52607a
FW
438static inline void ftrace_graph_init_task(struct task_struct *t) { }
439static inline void ftrace_graph_exit_task(struct task_struct *t) { }
21a8c466
FW
440
441static inline int task_curr_ret_stack(struct task_struct *tsk)
442{
443 return -1;
444}
380c4b14
FW
445
446static inline void pause_graph_tracing(void) { }
447static inline void unpause_graph_tracing(void) { }
caf4b323
FW
448#endif
449
ea4e2bc4
SR
450#ifdef CONFIG_TRACING
451#include <linux/sched.h>
452
453/* flags for current->trace */
454enum {
455 TSK_TRACE_FL_TRACE_BIT = 0,
456 TSK_TRACE_FL_GRAPH_BIT = 1,
457};
458enum {
459 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
460 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
461};
462
463static inline void set_tsk_trace_trace(struct task_struct *tsk)
464{
465 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
466}
467
468static inline void clear_tsk_trace_trace(struct task_struct *tsk)
469{
470 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
471}
472
473static inline int test_tsk_trace_trace(struct task_struct *tsk)
474{
475 return tsk->trace & TSK_TRACE_FL_TRACE;
476}
477
478static inline void set_tsk_trace_graph(struct task_struct *tsk)
479{
480 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
481}
482
483static inline void clear_tsk_trace_graph(struct task_struct *tsk)
484{
485 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
486}
487
488static inline int test_tsk_trace_graph(struct task_struct *tsk)
489{
490 return tsk->trace & TSK_TRACE_FL_GRAPH;
491}
492
526211bc
IM
493extern int ftrace_dump_on_oops;
494
ea4e2bc4
SR
495#endif /* CONFIG_TRACING */
496
b1818748
MM
497
498#ifdef CONFIG_HW_BRANCH_TRACER
499
500void trace_hw_branch(u64 from, u64 to);
501void trace_hw_branch_oops(void);
502
503#else /* CONFIG_HW_BRANCH_TRACER */
504
505static inline void trace_hw_branch(u64 from, u64 to) {}
506static inline void trace_hw_branch_oops(void) {}
507
508#endif /* CONFIG_HW_BRANCH_TRACER */
509
ee08c6ec
FW
510/*
511 * A syscall entry in the ftrace syscalls array.
512 *
bed1ffca
FW
513 * @name: name of the syscall
514 * @nb_args: number of parameters it takes
515 * @types: list of types as strings
516 * @args: list of args as strings (args[i] matches types[i])
ee08c6ec 517 */
bed1ffca
FW
518struct syscall_metadata {
519 const char *name;
520 int nb_args;
521 const char **types;
522 const char **args;
ee08c6ec
FW
523};
524
525#ifdef CONFIG_FTRACE_SYSCALLS
bed1ffca
FW
526extern void arch_init_ftrace_syscalls(void);
527extern struct syscall_metadata *syscall_nr_to_meta(int nr);
ee08c6ec
FW
528extern void start_ftrace_syscalls(void);
529extern void stop_ftrace_syscalls(void);
530extern void ftrace_syscall_enter(struct pt_regs *regs);
531extern void ftrace_syscall_exit(struct pt_regs *regs);
532#else
533static inline void start_ftrace_syscalls(void) { }
534static inline void stop_ftrace_syscalls(void) { }
535static inline void ftrace_syscall_enter(struct pt_regs *regs) { }
536static inline void ftrace_syscall_exit(struct pt_regs *regs) { }
537#endif
538
16444a8a 539#endif /* _LINUX_FTRACE_H */