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