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