Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/gerg/m68knommu
[deliverable/linux.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,
8d65af78 22 void __user *buffer, size_t *lenp,
b0fc494f
SR
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 */
4dbf6bc2
SR
85/*
86 * (un)register_ftrace_function must be a macro since the ops parameter
87 * must not be evaluated.
88 */
89#define register_ftrace_function(ops) ({ 0; })
90#define unregister_ftrace_function(ops) ({ 0; })
91static inline void clear_ftrace_function(void) { }
81adbdc0 92static inline void ftrace_kill(void) { }
60a7ecf4
SR
93static inline void ftrace_stop(void) { }
94static inline void ftrace_start(void) { }
606576ce 95#endif /* CONFIG_FUNCTION_TRACER */
352ad25a 96
f38f1d2a
SR
97#ifdef CONFIG_STACK_TRACER
98extern int stack_tracer_enabled;
99int
100stack_trace_sysctl(struct ctl_table *table, int write,
8d65af78 101 void __user *buffer, size_t *lenp,
f38f1d2a
SR
102 loff_t *ppos);
103#endif
104
f6180773
SR
105struct ftrace_func_command {
106 struct list_head list;
107 char *name;
108 int (*func)(char *func, char *cmd,
109 char *params, int enable);
110};
111
3d083395 112#ifdef CONFIG_DYNAMIC_FTRACE
31e88909 113
000ab691
SR
114int ftrace_arch_code_modify_prepare(void);
115int ftrace_arch_code_modify_post_process(void);
116
809dcf29
SR
117struct seq_file;
118
b6887d79 119struct ftrace_probe_ops {
59df055f
SR
120 void (*func)(unsigned long ip,
121 unsigned long parent_ip,
122 void **data);
123 int (*callback)(unsigned long ip, void **data);
124 void (*free)(void **data);
809dcf29
SR
125 int (*print)(struct seq_file *m,
126 unsigned long ip,
b6887d79 127 struct ftrace_probe_ops *ops,
809dcf29 128 void *data);
59df055f
SR
129};
130
131extern int
b6887d79 132register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
59df055f
SR
133 void *data);
134extern void
b6887d79 135unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
59df055f
SR
136 void *data);
137extern void
b6887d79
SR
138unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
139extern void unregister_ftrace_function_probe_all(char *glob);
59df055f 140
2cfa1978
MH
141extern int ftrace_text_reserved(void *start, void *end);
142
3c1720f0 143enum {
37ad5084
SR
144 FTRACE_FL_FREE = (1 << 0),
145 FTRACE_FL_FAILED = (1 << 1),
146 FTRACE_FL_FILTER = (1 << 2),
147 FTRACE_FL_ENABLED = (1 << 3),
41c52c0d 148 FTRACE_FL_NOTRACE = (1 << 4),
0eb96701 149 FTRACE_FL_CONVERTED = (1 << 5),
3c1720f0
SR
150};
151
3d083395 152struct dyn_ftrace {
ee000b7f
LJ
153 union {
154 unsigned long ip; /* address of mcount call-site */
155 struct dyn_ftrace *freelist;
156 };
157 union {
158 unsigned long flags;
159 struct dyn_ftrace *newlist;
160 };
161 struct dyn_arch_ftrace arch;
3d083395
SR
162};
163
e1c08bdd 164int ftrace_force_update(void);
77a2b37d 165void ftrace_set_filter(unsigned char *buf, int len, int reset);
e1c08bdd 166
f6180773
SR
167int register_ftrace_command(struct ftrace_func_command *cmd);
168int unregister_ftrace_command(struct ftrace_func_command *cmd);
169
3d083395 170/* defined in arch */
3c1720f0 171extern int ftrace_ip_converted(unsigned long ip);
d61f82d0 172extern int ftrace_dyn_arch_init(void *data);
d61f82d0
SR
173extern int ftrace_update_ftrace_func(ftrace_func_t func);
174extern void ftrace_caller(void);
175extern void ftrace_call(void);
176extern void mcount_call(void);
f0001207
SL
177
178#ifndef FTRACE_ADDR
179#define FTRACE_ADDR ((unsigned long)ftrace_caller)
180#endif
fb52607a
FW
181#ifdef CONFIG_FUNCTION_GRAPH_TRACER
182extern void ftrace_graph_caller(void);
5a45cfe1
SR
183extern int ftrace_enable_ftrace_graph_caller(void);
184extern int ftrace_disable_ftrace_graph_caller(void);
185#else
186static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
187static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
e7d3737e 188#endif
ad90c0e3 189
31e88909 190/**
57794a9d 191 * ftrace_make_nop - convert code into nop
31e88909
SR
192 * @mod: module structure if called by module load initialization
193 * @rec: the mcount call site record
194 * @addr: the address that the call site should be calling
195 *
196 * This is a very sensitive operation and great care needs
197 * to be taken by the arch. The operation should carefully
198 * read the location, check to see if what is read is indeed
199 * what we expect it to be, and then on success of the compare,
200 * it should write to the location.
201 *
202 * The code segment at @rec->ip should be a caller to @addr
203 *
204 * Return must be:
205 * 0 on success
206 * -EFAULT on error reading the location
207 * -EINVAL on a failed compare of the contents
208 * -EPERM on error writing to the location
209 * Any other value will be considered a failure.
210 */
211extern int ftrace_make_nop(struct module *mod,
212 struct dyn_ftrace *rec, unsigned long addr);
a26a2a27 213
593eb8a2 214/**
31e88909
SR
215 * ftrace_make_call - convert a nop call site into a call to addr
216 * @rec: the mcount call site record
217 * @addr: the address that the call site should call
593eb8a2
SR
218 *
219 * This is a very sensitive operation and great care needs
220 * to be taken by the arch. The operation should carefully
221 * read the location, check to see if what is read is indeed
222 * what we expect it to be, and then on success of the compare,
223 * it should write to the location.
224 *
31e88909
SR
225 * The code segment at @rec->ip should be a nop
226 *
593eb8a2
SR
227 * Return must be:
228 * 0 on success
229 * -EFAULT on error reading the location
230 * -EINVAL on a failed compare of the contents
231 * -EPERM on error writing to the location
232 * Any other value will be considered a failure.
233 */
31e88909
SR
234extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
235
31e88909
SR
236/* May be defined in arch */
237extern int ftrace_arch_read_dyn_info(char *buf, int size);
593eb8a2 238
ecea656d
AS
239extern int skip_trace(unsigned long ip);
240
c0719e5a
SR
241extern void ftrace_disable_daemon(void);
242extern void ftrace_enable_daemon(void);
e1c08bdd 243#else
4dbf6bc2
SR
244static inline int skip_trace(unsigned long ip) { return 0; }
245static inline int ftrace_force_update(void) { return 0; }
246static inline void ftrace_set_filter(unsigned char *buf, int len, int reset)
247{
248}
249static inline void ftrace_disable_daemon(void) { }
250static inline void ftrace_enable_daemon(void) { }
e7247a15 251static inline void ftrace_release_mod(struct module *mod) {}
f6180773
SR
252static inline int register_ftrace_command(struct ftrace_func_command *cmd)
253{
97d0bb8d 254 return -EINVAL;
f6180773
SR
255}
256static inline int unregister_ftrace_command(char *cmd_name)
257{
97d0bb8d 258 return -EINVAL;
f6180773 259}
2cfa1978
MH
260static inline int ftrace_text_reserved(void *start, void *end)
261{
262 return 0;
263}
ecea656d 264#endif /* CONFIG_DYNAMIC_FTRACE */
352ad25a 265
aeaee8a2
IM
266/* totally disable ftrace - can not re-enable after this */
267void ftrace_kill(void);
268
f43fdad8
IM
269static inline void tracer_disable(void)
270{
606576ce 271#ifdef CONFIG_FUNCTION_TRACER
f43fdad8
IM
272 ftrace_enabled = 0;
273#endif
274}
275
37002735
HY
276/*
277 * Ftrace disable/restore without lock. Some synchronization mechanism
9bdeb7b5 278 * must be used to prevent ftrace_enabled to be changed between
37002735
HY
279 * disable/restore.
280 */
9bdeb7b5
HY
281static inline int __ftrace_enabled_save(void)
282{
606576ce 283#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
284 int saved_ftrace_enabled = ftrace_enabled;
285 ftrace_enabled = 0;
286 return saved_ftrace_enabled;
287#else
288 return 0;
289#endif
290}
291
292static inline void __ftrace_enabled_restore(int enabled)
293{
606576ce 294#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
295 ftrace_enabled = enabled;
296#endif
297}
298
c79a61f5
UKK
299#ifndef HAVE_ARCH_CALLER_ADDR
300# ifdef CONFIG_FRAME_POINTER
301# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
302# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
303# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
304# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
305# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
306# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
307# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
308# else
309# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
310# define CALLER_ADDR1 0UL
311# define CALLER_ADDR2 0UL
312# define CALLER_ADDR3 0UL
313# define CALLER_ADDR4 0UL
314# define CALLER_ADDR5 0UL
315# define CALLER_ADDR6 0UL
316# endif
317#endif /* ifndef HAVE_ARCH_CALLER_ADDR */
352ad25a 318
81d68a96 319#ifdef CONFIG_IRQSOFF_TRACER
489f1396
IM
320 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
321 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
81d68a96 322#else
4dbf6bc2
SR
323 static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
324 static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
81d68a96
SR
325#endif
326
6cd8a4bb 327#ifdef CONFIG_PREEMPT_TRACER
489f1396
IM
328 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
329 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
6cd8a4bb 330#else
4dbf6bc2
SR
331 static inline void trace_preempt_on(unsigned long a0, unsigned long a1) { }
332 static inline void trace_preempt_off(unsigned long a0, unsigned long a1) { }
6cd8a4bb
SR
333#endif
334
68bf21aa
SR
335#ifdef CONFIG_FTRACE_MCOUNT_RECORD
336extern void ftrace_init(void);
337#else
338static inline void ftrace_init(void) { }
339#endif
340
287b6e68
FW
341/*
342 * Structure that defines an entry function trace.
343 */
344struct ftrace_graph_ent {
345 unsigned long func; /* Current function */
346 int depth;
347};
dd0e545f 348
caf4b323
FW
349/*
350 * Structure that defines a return function trace.
351 */
fb52607a 352struct ftrace_graph_ret {
caf4b323
FW
353 unsigned long func; /* Current function */
354 unsigned long long calltime;
355 unsigned long long rettime;
0231022c
FW
356 /* Number of functions that overran the depth limit for current task */
357 unsigned long overrun;
287b6e68 358 int depth;
caf4b323
FW
359};
360
62b915f1
JO
361/* Type of the callback handlers for tracing function graph*/
362typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
363typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
364
fb52607a 365#ifdef CONFIG_FUNCTION_GRAPH_TRACER
8b96f011 366
5ac9f622 367/* for init task */
f876d346 368#define INIT_FTRACE_GRAPH .ret_stack = NULL,
5ac9f622 369
712406a6
SR
370/*
371 * Stack of return addresses for functions
372 * of a thread.
373 * Used in struct thread_info
374 */
375struct ftrace_ret_stack {
376 unsigned long ret;
377 unsigned long func;
378 unsigned long long calltime;
a2a16d6a 379 unsigned long long subtime;
71e308a2 380 unsigned long fp;
712406a6
SR
381};
382
383/*
384 * Primary handler of a function return.
385 * It relays on ftrace_return_to_handler.
386 * Defined in entry_32/64.S
387 */
388extern void return_to_handler(void);
389
390extern int
71e308a2
SR
391ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
392 unsigned long frame_pointer);
712406a6 393
8b96f011
FW
394/*
395 * Sometimes we don't want to trace a function with the function
396 * graph tracer but we want them to keep traced by the usual function
397 * tracer if the function graph tracer is not configured.
398 */
399#define __notrace_funcgraph notrace
400
bcbc4f20
FW
401/*
402 * We want to which function is an entrypoint of a hardirq.
403 * That will help us to put a signal on output.
404 */
405#define __irq_entry __attribute__((__section__(".irqentry.text")))
406
407/* Limits of hardirq entrypoints */
408extern char __irqentry_text_start[];
409extern char __irqentry_text_end[];
410
f201ae23
FW
411#define FTRACE_RETFUNC_DEPTH 50
412#define FTRACE_RETSTACK_ALLOC_SIZE 32
287b6e68
FW
413extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
414 trace_func_graph_ent_t entryfunc);
415
14a866c5
SR
416extern void ftrace_graph_stop(void);
417
287b6e68
FW
418/* The current handlers in use */
419extern trace_func_graph_ret_t ftrace_graph_return;
420extern trace_func_graph_ent_t ftrace_graph_entry;
caf4b323 421
fb52607a 422extern void unregister_ftrace_graph(void);
f201ae23 423
fb52607a
FW
424extern void ftrace_graph_init_task(struct task_struct *t);
425extern void ftrace_graph_exit_task(struct task_struct *t);
21a8c466
FW
426
427static inline int task_curr_ret_stack(struct task_struct *t)
428{
429 return t->curr_ret_stack;
430}
380c4b14
FW
431
432static inline void pause_graph_tracing(void)
433{
434 atomic_inc(&current->tracing_graph_pause);
435}
436
437static inline void unpause_graph_tracing(void)
438{
439 atomic_dec(&current->tracing_graph_pause);
440}
5ac9f622 441#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
8b96f011
FW
442
443#define __notrace_funcgraph
bcbc4f20 444#define __irq_entry
5ac9f622 445#define INIT_FTRACE_GRAPH
8b96f011 446
fb52607a
FW
447static inline void ftrace_graph_init_task(struct task_struct *t) { }
448static inline void ftrace_graph_exit_task(struct task_struct *t) { }
21a8c466 449
62b915f1
JO
450static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
451 trace_func_graph_ent_t entryfunc)
452{
453 return -1;
454}
455static inline void unregister_ftrace_graph(void) { }
456
21a8c466
FW
457static inline int task_curr_ret_stack(struct task_struct *tsk)
458{
459 return -1;
460}
380c4b14
FW
461
462static inline void pause_graph_tracing(void) { }
463static inline void unpause_graph_tracing(void) { }
5ac9f622 464#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
caf4b323 465
ea4e2bc4 466#ifdef CONFIG_TRACING
ea4e2bc4
SR
467
468/* flags for current->trace */
469enum {
470 TSK_TRACE_FL_TRACE_BIT = 0,
471 TSK_TRACE_FL_GRAPH_BIT = 1,
472};
473enum {
474 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
475 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
476};
477
478static inline void set_tsk_trace_trace(struct task_struct *tsk)
479{
480 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
481}
482
483static inline void clear_tsk_trace_trace(struct task_struct *tsk)
484{
485 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
486}
487
488static inline int test_tsk_trace_trace(struct task_struct *tsk)
489{
490 return tsk->trace & TSK_TRACE_FL_TRACE;
491}
492
493static inline void set_tsk_trace_graph(struct task_struct *tsk)
494{
495 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
496}
497
498static inline void clear_tsk_trace_graph(struct task_struct *tsk)
499{
500 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
501}
502
503static inline int test_tsk_trace_graph(struct task_struct *tsk)
504{
505 return tsk->trace & TSK_TRACE_FL_GRAPH;
506}
507
cecbca96
FW
508enum ftrace_dump_mode;
509
510extern enum ftrace_dump_mode ftrace_dump_on_oops;
526211bc 511
261842b7
SR
512#ifdef CONFIG_PREEMPT
513#define INIT_TRACE_RECURSION .trace_recursion = 0,
514#endif
515
ea4e2bc4
SR
516#endif /* CONFIG_TRACING */
517
261842b7
SR
518#ifndef INIT_TRACE_RECURSION
519#define INIT_TRACE_RECURSION
520#endif
b1818748 521
e7b8e675
MF
522#ifdef CONFIG_FTRACE_SYSCALLS
523
524unsigned long arch_syscall_addr(int nr);
525
526#endif /* CONFIG_FTRACE_SYSCALLS */
527
16444a8a 528#endif /* _LINUX_FTRACE_H */
This page took 0.32183 seconds and 5 git commands to generate.