tracing/function-graph-tracer: implement a print_headers function
[deliverable/linux.git] / include / linux / ftrace.h
CommitLineData
16444a8a
ACM
1#ifndef _LINUX_FTRACE_H
2#define _LINUX_FTRACE_H
3
16444a8a 4#include <linux/linkage.h>
d49dbf33 5#include <linux/fs.h>
eb7fa935 6#include <linux/ktime.h>
d13744cd
FW
7#include <linux/init.h>
8#include <linux/types.h>
5601020f 9#include <linux/kallsyms.h>
ea4e2bc4 10#include <linux/bitops.h>
21a8c466 11#include <linux/sched.h>
16444a8a 12
606576ce 13#ifdef CONFIG_FUNCTION_TRACER
3e1932ad 14
b0fc494f
SR
15extern int ftrace_enabled;
16extern int
17ftrace_enable_sysctl(struct ctl_table *table, int write,
18 struct file *filp, void __user *buffer, size_t *lenp,
19 loff_t *ppos);
20
16444a8a
ACM
21typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
22
23struct ftrace_ops {
24 ftrace_func_t func;
25 struct ftrace_ops *next;
26};
27
60a7ecf4
SR
28extern int function_trace_stop;
29
e7d3737e
FW
30/*
31 * Type of the current tracing.
32 */
33enum ftrace_tracing_type_t {
34 FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
35 FTRACE_TYPE_RETURN, /* Hook the return of the function */
36};
37
38/* Current tracing type, default is FTRACE_TYPE_ENTER */
39extern enum ftrace_tracing_type_t ftrace_tracing_type;
40
60a7ecf4
SR
41/**
42 * ftrace_stop - stop function tracer.
43 *
44 * A quick way to stop the function tracer. Note this an on off switch,
45 * it is not something that is recursive like preempt_disable.
46 * This does not disable the calling of mcount, it only stops the
47 * calling of functions from mcount.
48 */
49static inline void ftrace_stop(void)
50{
51 function_trace_stop = 1;
52}
53
54/**
55 * ftrace_start - start the function tracer.
56 *
57 * This function is the inverse of ftrace_stop. This does not enable
58 * the function tracing if the function tracer is disabled. This only
59 * sets the function tracer flag to continue calling the functions
60 * from mcount.
61 */
62static inline void ftrace_start(void)
63{
64 function_trace_stop = 0;
65}
66
16444a8a
ACM
67/*
68 * The ftrace_ops must be a static and should also
69 * be read_mostly. These functions do modify read_mostly variables
70 * so use them sparely. Never free an ftrace_op or modify the
71 * next pointer after it has been registered. Even after unregistering
72 * it, the next pointer may still be used internally.
73 */
74int register_ftrace_function(struct ftrace_ops *ops);
75int unregister_ftrace_function(struct ftrace_ops *ops);
76void clear_ftrace_function(void);
77
78extern void ftrace_stub(unsigned long a0, unsigned long a1);
16444a8a 79
606576ce 80#else /* !CONFIG_FUNCTION_TRACER */
16444a8a
ACM
81# define register_ftrace_function(ops) do { } while (0)
82# define unregister_ftrace_function(ops) do { } while (0)
83# define clear_ftrace_function(ops) do { } while (0)
81adbdc0 84static inline void ftrace_kill(void) { }
60a7ecf4
SR
85static inline void ftrace_stop(void) { }
86static inline void ftrace_start(void) { }
606576ce 87#endif /* CONFIG_FUNCTION_TRACER */
352ad25a 88
3d083395 89#ifdef CONFIG_DYNAMIC_FTRACE
31e88909
SR
90/* asm/ftrace.h must be defined for archs supporting dynamic ftrace */
91#include <asm/ftrace.h>
92
3c1720f0 93enum {
37ad5084
SR
94 FTRACE_FL_FREE = (1 << 0),
95 FTRACE_FL_FAILED = (1 << 1),
96 FTRACE_FL_FILTER = (1 << 2),
97 FTRACE_FL_ENABLED = (1 << 3),
41c52c0d 98 FTRACE_FL_NOTRACE = (1 << 4),
0eb96701 99 FTRACE_FL_CONVERTED = (1 << 5),
ecea656d 100 FTRACE_FL_FROZEN = (1 << 6),
3c1720f0
SR
101};
102
3d083395 103struct dyn_ftrace {
08f5ac90
SR
104 struct list_head list;
105 unsigned long ip; /* address of mcount call-site */
106 unsigned long flags;
31e88909 107 struct dyn_arch_ftrace arch;
3d083395
SR
108};
109
e1c08bdd 110int ftrace_force_update(void);
77a2b37d 111void ftrace_set_filter(unsigned char *buf, int len, int reset);
e1c08bdd 112
3d083395 113/* defined in arch */
3c1720f0 114extern int ftrace_ip_converted(unsigned long ip);
d61f82d0 115extern int ftrace_dyn_arch_init(void *data);
d61f82d0
SR
116extern int ftrace_update_ftrace_func(ftrace_func_t func);
117extern void ftrace_caller(void);
118extern void ftrace_call(void);
119extern void mcount_call(void);
fb52607a
FW
120#ifdef CONFIG_FUNCTION_GRAPH_TRACER
121extern void ftrace_graph_caller(void);
5a45cfe1
SR
122extern int ftrace_enable_ftrace_graph_caller(void);
123extern int ftrace_disable_ftrace_graph_caller(void);
124#else
125static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
126static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
e7d3737e 127#endif
ad90c0e3 128
31e88909
SR
129/**
130 * ftrace_make_nop - convert code into top
131 * @mod: module structure if called by module load initialization
132 * @rec: the mcount call site record
133 * @addr: the address that the call site should be calling
134 *
135 * This is a very sensitive operation and great care needs
136 * to be taken by the arch. The operation should carefully
137 * read the location, check to see if what is read is indeed
138 * what we expect it to be, and then on success of the compare,
139 * it should write to the location.
140 *
141 * The code segment at @rec->ip should be a caller to @addr
142 *
143 * Return must be:
144 * 0 on success
145 * -EFAULT on error reading the location
146 * -EINVAL on a failed compare of the contents
147 * -EPERM on error writing to the location
148 * Any other value will be considered a failure.
149 */
150extern int ftrace_make_nop(struct module *mod,
151 struct dyn_ftrace *rec, unsigned long addr);
a26a2a27 152
593eb8a2 153/**
31e88909
SR
154 * ftrace_make_call - convert a nop call site into a call to addr
155 * @rec: the mcount call site record
156 * @addr: the address that the call site should call
593eb8a2
SR
157 *
158 * This is a very sensitive operation and great care needs
159 * to be taken by the arch. The operation should carefully
160 * read the location, check to see if what is read is indeed
161 * what we expect it to be, and then on success of the compare,
162 * it should write to the location.
163 *
31e88909
SR
164 * The code segment at @rec->ip should be a nop
165 *
593eb8a2
SR
166 * Return must be:
167 * 0 on success
168 * -EFAULT on error reading the location
169 * -EINVAL on a failed compare of the contents
170 * -EPERM on error writing to the location
171 * Any other value will be considered a failure.
172 */
31e88909
SR
173extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
174
175
176/* May be defined in arch */
177extern int ftrace_arch_read_dyn_info(char *buf, int size);
593eb8a2 178
ecea656d
AS
179extern int skip_trace(unsigned long ip);
180
c0719e5a
SR
181extern void ftrace_release(void *start, unsigned long size);
182
183extern void ftrace_disable_daemon(void);
184extern void ftrace_enable_daemon(void);
e1c08bdd 185#else
ecea656d 186# define skip_trace(ip) ({ 0; })
aeaee8a2
IM
187# define ftrace_force_update() ({ 0; })
188# define ftrace_set_filter(buf, len, reset) do { } while (0)
ad90c0e3
SR
189# define ftrace_disable_daemon() do { } while (0)
190# define ftrace_enable_daemon() do { } while (0)
c0719e5a 191static inline void ftrace_release(void *start, unsigned long size) { }
ecea656d 192#endif /* CONFIG_DYNAMIC_FTRACE */
352ad25a 193
aeaee8a2
IM
194/* totally disable ftrace - can not re-enable after this */
195void ftrace_kill(void);
196
f43fdad8
IM
197static inline void tracer_disable(void)
198{
606576ce 199#ifdef CONFIG_FUNCTION_TRACER
f43fdad8
IM
200 ftrace_enabled = 0;
201#endif
202}
203
37002735
HY
204/*
205 * Ftrace disable/restore without lock. Some synchronization mechanism
9bdeb7b5 206 * must be used to prevent ftrace_enabled to be changed between
37002735
HY
207 * disable/restore.
208 */
9bdeb7b5
HY
209static inline int __ftrace_enabled_save(void)
210{
606576ce 211#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
212 int saved_ftrace_enabled = ftrace_enabled;
213 ftrace_enabled = 0;
214 return saved_ftrace_enabled;
215#else
216 return 0;
217#endif
218}
219
220static inline void __ftrace_enabled_restore(int enabled)
221{
606576ce 222#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
223 ftrace_enabled = enabled;
224#endif
225}
226
352ad25a
SR
227#ifdef CONFIG_FRAME_POINTER
228/* TODO: need to fix this for ARM */
229# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
230# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
231# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
232# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
233# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
234# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
86387f7e 235# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
352ad25a
SR
236#else
237# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
238# define CALLER_ADDR1 0UL
239# define CALLER_ADDR2 0UL
240# define CALLER_ADDR3 0UL
241# define CALLER_ADDR4 0UL
242# define CALLER_ADDR5 0UL
86387f7e 243# define CALLER_ADDR6 0UL
352ad25a
SR
244#endif
245
81d68a96 246#ifdef CONFIG_IRQSOFF_TRACER
489f1396
IM
247 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
248 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
81d68a96
SR
249#else
250# define time_hardirqs_on(a0, a1) do { } while (0)
251# define time_hardirqs_off(a0, a1) do { } while (0)
252#endif
253
6cd8a4bb 254#ifdef CONFIG_PREEMPT_TRACER
489f1396
IM
255 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
256 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
6cd8a4bb
SR
257#else
258# define trace_preempt_on(a0, a1) do { } while (0)
259# define trace_preempt_off(a0, a1) do { } while (0)
260#endif
261
b1829d27 262#ifdef CONFIG_TRACING
944ac425
SR
263extern int ftrace_dump_on_oops;
264
0f048701
SR
265extern void tracing_start(void);
266extern void tracing_stop(void);
69bb54ec 267extern void ftrace_off_permanent(void);
0f048701 268
74f4e369
IM
269extern void
270ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
2f2c99db
SR
271
272/**
273 * ftrace_printk - printf formatting in the ftrace buffer
274 * @fmt: the printf format for printing
275 *
276 * Note: __ftrace_printk is an internal function for ftrace_printk and
277 * the @ip is passed in via the ftrace_printk macro.
278 *
279 * This function allows a kernel developer to debug fast path sections
280 * that printk is not appropriate for. By scattering in various
281 * printk like tracing in the code, a developer can quickly see
282 * where problems are occurring.
283 *
284 * This is intended as a debugging tool for the developer only.
285 * Please refrain from leaving ftrace_printks scattered around in
286 * your code.
287 */
288# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
dd0e545f
SR
289extern int
290__ftrace_printk(unsigned long ip, const char *fmt, ...)
291 __attribute__ ((format (printf, 2, 3)));
3f5a54e3 292extern void ftrace_dump(void);
74f4e369
IM
293#else
294static inline void
295ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
dd0e545f 296static inline int
7b928c23
IM
297ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 0)));
298
0f048701
SR
299static inline void tracing_start(void) { }
300static inline void tracing_stop(void) { }
69bb54ec 301static inline void ftrace_off_permanent(void) { }
7b928c23
IM
302static inline int
303ftrace_printk(const char *fmt, ...)
dd0e545f
SR
304{
305 return 0;
306}
3f5a54e3 307static inline void ftrace_dump(void) { }
74f4e369
IM
308#endif
309
68bf21aa
SR
310#ifdef CONFIG_FTRACE_MCOUNT_RECORD
311extern void ftrace_init(void);
31e88909
SR
312extern void ftrace_init_module(struct module *mod,
313 unsigned long *start, unsigned long *end);
68bf21aa
SR
314#else
315static inline void ftrace_init(void) { }
90d595fe 316static inline void
31e88909
SR
317ftrace_init_module(struct module *mod,
318 unsigned long *start, unsigned long *end) { }
68bf21aa
SR
319#endif
320
f3f47a67
AV
321enum {
322 POWER_NONE = 0,
323 POWER_CSTATE = 1,
324 POWER_PSTATE = 2,
325};
326
327struct power_trace {
328#ifdef CONFIG_POWER_TRACER
329 ktime_t stamp;
330 ktime_t end;
331 int type;
332 int state;
333#endif
334};
335
336#ifdef CONFIG_POWER_TRACER
337extern void trace_power_start(struct power_trace *it, unsigned int type,
338 unsigned int state);
339extern void trace_power_mark(struct power_trace *it, unsigned int type,
340 unsigned int state);
341extern void trace_power_end(struct power_trace *it);
342#else
343static inline void trace_power_start(struct power_trace *it, unsigned int type,
344 unsigned int state) { }
345static inline void trace_power_mark(struct power_trace *it, unsigned int type,
346 unsigned int state) { }
347static inline void trace_power_end(struct power_trace *it) { }
348#endif
349
dd0e545f 350
287b6e68
FW
351/*
352 * Structure that defines an entry function trace.
353 */
354struct ftrace_graph_ent {
355 unsigned long func; /* Current function */
356 int depth;
357};
dd0e545f 358
caf4b323
FW
359/*
360 * Structure that defines a return function trace.
361 */
fb52607a 362struct ftrace_graph_ret {
caf4b323
FW
363 unsigned long func; /* Current function */
364 unsigned long long calltime;
365 unsigned long long rettime;
0231022c
FW
366 /* Number of functions that overran the depth limit for current task */
367 unsigned long overrun;
287b6e68 368 int depth;
caf4b323
FW
369};
370
fb52607a 371#ifdef CONFIG_FUNCTION_GRAPH_TRACER
f201ae23
FW
372#define FTRACE_RETFUNC_DEPTH 50
373#define FTRACE_RETSTACK_ALLOC_SIZE 32
287b6e68
FW
374/* Type of the callback handlers for tracing function graph*/
375typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
e49dc19c 376typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
287b6e68
FW
377
378extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
379 trace_func_graph_ent_t entryfunc);
380
14a866c5
SR
381extern void ftrace_graph_stop(void);
382
287b6e68
FW
383/* The current handlers in use */
384extern trace_func_graph_ret_t ftrace_graph_return;
385extern trace_func_graph_ent_t ftrace_graph_entry;
caf4b323 386
fb52607a 387extern void unregister_ftrace_graph(void);
f201ae23 388
fb52607a
FW
389extern void ftrace_graph_init_task(struct task_struct *t);
390extern void ftrace_graph_exit_task(struct task_struct *t);
21a8c466
FW
391
392static inline int task_curr_ret_stack(struct task_struct *t)
393{
394 return t->curr_ret_stack;
395}
82f60f0b 396#else
fb52607a
FW
397static inline void ftrace_graph_init_task(struct task_struct *t) { }
398static inline void ftrace_graph_exit_task(struct task_struct *t) { }
21a8c466
FW
399
400static inline int task_curr_ret_stack(struct task_struct *tsk)
401{
402 return -1;
403}
caf4b323
FW
404#endif
405
ea4e2bc4
SR
406#ifdef CONFIG_TRACING
407#include <linux/sched.h>
408
409/* flags for current->trace */
410enum {
411 TSK_TRACE_FL_TRACE_BIT = 0,
412 TSK_TRACE_FL_GRAPH_BIT = 1,
413};
414enum {
415 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
416 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
417};
418
419static inline void set_tsk_trace_trace(struct task_struct *tsk)
420{
421 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
422}
423
424static inline void clear_tsk_trace_trace(struct task_struct *tsk)
425{
426 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
427}
428
429static inline int test_tsk_trace_trace(struct task_struct *tsk)
430{
431 return tsk->trace & TSK_TRACE_FL_TRACE;
432}
433
434static inline void set_tsk_trace_graph(struct task_struct *tsk)
435{
436 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
437}
438
439static inline void clear_tsk_trace_graph(struct task_struct *tsk)
440{
441 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
442}
443
444static inline int test_tsk_trace_graph(struct task_struct *tsk)
445{
446 return tsk->trace & TSK_TRACE_FL_GRAPH;
447}
448
449#endif /* CONFIG_TRACING */
450
16444a8a 451#endif /* _LINUX_FTRACE_H */
This page took 0.116582 seconds and 5 git commands to generate.