x86, ftrace, hw-branch-tracer: support hotplug cpus
[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
3d083395 98#ifdef CONFIG_DYNAMIC_FTRACE
31e88909
SR
99/* asm/ftrace.h must be defined for archs supporting dynamic ftrace */
100#include <asm/ftrace.h>
101
3c1720f0 102enum {
37ad5084
SR
103 FTRACE_FL_FREE = (1 << 0),
104 FTRACE_FL_FAILED = (1 << 1),
105 FTRACE_FL_FILTER = (1 << 2),
106 FTRACE_FL_ENABLED = (1 << 3),
41c52c0d 107 FTRACE_FL_NOTRACE = (1 << 4),
0eb96701 108 FTRACE_FL_CONVERTED = (1 << 5),
ecea656d 109 FTRACE_FL_FROZEN = (1 << 6),
3c1720f0
SR
110};
111
3d083395 112struct dyn_ftrace {
08f5ac90
SR
113 struct list_head list;
114 unsigned long ip; /* address of mcount call-site */
115 unsigned long flags;
31e88909 116 struct dyn_arch_ftrace arch;
3d083395
SR
117};
118
e1c08bdd 119int ftrace_force_update(void);
77a2b37d 120void ftrace_set_filter(unsigned char *buf, int len, int reset);
e1c08bdd 121
3d083395 122/* defined in arch */
3c1720f0 123extern int ftrace_ip_converted(unsigned long ip);
d61f82d0 124extern int ftrace_dyn_arch_init(void *data);
d61f82d0
SR
125extern int ftrace_update_ftrace_func(ftrace_func_t func);
126extern void ftrace_caller(void);
127extern void ftrace_call(void);
128extern void mcount_call(void);
f0001207
SL
129
130#ifndef FTRACE_ADDR
131#define FTRACE_ADDR ((unsigned long)ftrace_caller)
132#endif
fb52607a
FW
133#ifdef CONFIG_FUNCTION_GRAPH_TRACER
134extern void ftrace_graph_caller(void);
5a45cfe1
SR
135extern int ftrace_enable_ftrace_graph_caller(void);
136extern int ftrace_disable_ftrace_graph_caller(void);
137#else
138static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
139static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
e7d3737e 140#endif
ad90c0e3 141
31e88909
SR
142/**
143 * ftrace_make_nop - convert code into top
144 * @mod: module structure if called by module load initialization
145 * @rec: the mcount call site record
146 * @addr: the address that the call site should be calling
147 *
148 * This is a very sensitive operation and great care needs
149 * to be taken by the arch. The operation should carefully
150 * read the location, check to see if what is read is indeed
151 * what we expect it to be, and then on success of the compare,
152 * it should write to the location.
153 *
154 * The code segment at @rec->ip should be a caller to @addr
155 *
156 * Return must be:
157 * 0 on success
158 * -EFAULT on error reading the location
159 * -EINVAL on a failed compare of the contents
160 * -EPERM on error writing to the location
161 * Any other value will be considered a failure.
162 */
163extern int ftrace_make_nop(struct module *mod,
164 struct dyn_ftrace *rec, unsigned long addr);
a26a2a27 165
593eb8a2 166/**
31e88909
SR
167 * ftrace_make_call - convert a nop call site into a call to addr
168 * @rec: the mcount call site record
169 * @addr: the address that the call site should call
593eb8a2
SR
170 *
171 * This is a very sensitive operation and great care needs
172 * to be taken by the arch. The operation should carefully
173 * read the location, check to see if what is read is indeed
174 * what we expect it to be, and then on success of the compare,
175 * it should write to the location.
176 *
31e88909
SR
177 * The code segment at @rec->ip should be a nop
178 *
593eb8a2
SR
179 * Return must be:
180 * 0 on success
181 * -EFAULT on error reading the location
182 * -EINVAL on a failed compare of the contents
183 * -EPERM on error writing to the location
184 * Any other value will be considered a failure.
185 */
31e88909
SR
186extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
187
188
189/* May be defined in arch */
190extern int ftrace_arch_read_dyn_info(char *buf, int size);
593eb8a2 191
ecea656d
AS
192extern int skip_trace(unsigned long ip);
193
c0719e5a
SR
194extern void ftrace_release(void *start, unsigned long size);
195
196extern void ftrace_disable_daemon(void);
197extern void ftrace_enable_daemon(void);
e1c08bdd 198#else
ecea656d 199# define skip_trace(ip) ({ 0; })
aeaee8a2
IM
200# define ftrace_force_update() ({ 0; })
201# define ftrace_set_filter(buf, len, reset) do { } while (0)
ad90c0e3
SR
202# define ftrace_disable_daemon() do { } while (0)
203# define ftrace_enable_daemon() do { } while (0)
c0719e5a 204static inline void ftrace_release(void *start, unsigned long size) { }
ecea656d 205#endif /* CONFIG_DYNAMIC_FTRACE */
352ad25a 206
aeaee8a2
IM
207/* totally disable ftrace - can not re-enable after this */
208void ftrace_kill(void);
209
f43fdad8
IM
210static inline void tracer_disable(void)
211{
606576ce 212#ifdef CONFIG_FUNCTION_TRACER
f43fdad8
IM
213 ftrace_enabled = 0;
214#endif
215}
216
37002735
HY
217/*
218 * Ftrace disable/restore without lock. Some synchronization mechanism
9bdeb7b5 219 * must be used to prevent ftrace_enabled to be changed between
37002735
HY
220 * disable/restore.
221 */
9bdeb7b5
HY
222static inline int __ftrace_enabled_save(void)
223{
606576ce 224#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
225 int saved_ftrace_enabled = ftrace_enabled;
226 ftrace_enabled = 0;
227 return saved_ftrace_enabled;
228#else
229 return 0;
230#endif
231}
232
233static inline void __ftrace_enabled_restore(int enabled)
234{
606576ce 235#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
236 ftrace_enabled = enabled;
237#endif
238}
239
352ad25a
SR
240#ifdef CONFIG_FRAME_POINTER
241/* TODO: need to fix this for ARM */
242# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
243# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
244# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
245# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
246# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
247# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
86387f7e 248# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
352ad25a
SR
249#else
250# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
251# define CALLER_ADDR1 0UL
252# define CALLER_ADDR2 0UL
253# define CALLER_ADDR3 0UL
254# define CALLER_ADDR4 0UL
255# define CALLER_ADDR5 0UL
86387f7e 256# define CALLER_ADDR6 0UL
352ad25a
SR
257#endif
258
81d68a96 259#ifdef CONFIG_IRQSOFF_TRACER
489f1396
IM
260 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
261 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
81d68a96
SR
262#else
263# define time_hardirqs_on(a0, a1) do { } while (0)
264# define time_hardirqs_off(a0, a1) do { } while (0)
265#endif
266
6cd8a4bb 267#ifdef CONFIG_PREEMPT_TRACER
489f1396
IM
268 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
269 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
6cd8a4bb
SR
270#else
271# define trace_preempt_on(a0, a1) do { } while (0)
272# define trace_preempt_off(a0, a1) do { } while (0)
273#endif
274
b1829d27 275#ifdef CONFIG_TRACING
944ac425
SR
276extern int ftrace_dump_on_oops;
277
0f048701
SR
278extern void tracing_start(void);
279extern void tracing_stop(void);
69bb54ec 280extern void ftrace_off_permanent(void);
0f048701 281
74f4e369
IM
282extern void
283ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
2f2c99db
SR
284
285/**
286 * ftrace_printk - printf formatting in the ftrace buffer
287 * @fmt: the printf format for printing
288 *
289 * Note: __ftrace_printk is an internal function for ftrace_printk and
290 * the @ip is passed in via the ftrace_printk macro.
291 *
292 * This function allows a kernel developer to debug fast path sections
293 * that printk is not appropriate for. By scattering in various
294 * printk like tracing in the code, a developer can quickly see
295 * where problems are occurring.
296 *
297 * This is intended as a debugging tool for the developer only.
298 * Please refrain from leaving ftrace_printks scattered around in
299 * your code.
300 */
301# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
dd0e545f
SR
302extern int
303__ftrace_printk(unsigned long ip, const char *fmt, ...)
304 __attribute__ ((format (printf, 2, 3)));
3f5a54e3 305extern void ftrace_dump(void);
74f4e369
IM
306#else
307static inline void
308ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
dd0e545f 309static inline int
3ddeb912 310ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
7b928c23 311
0f048701
SR
312static inline void tracing_start(void) { }
313static inline void tracing_stop(void) { }
69bb54ec 314static inline void ftrace_off_permanent(void) { }
7b928c23
IM
315static inline int
316ftrace_printk(const char *fmt, ...)
dd0e545f
SR
317{
318 return 0;
319}
3f5a54e3 320static inline void ftrace_dump(void) { }
74f4e369
IM
321#endif
322
68bf21aa
SR
323#ifdef CONFIG_FTRACE_MCOUNT_RECORD
324extern void ftrace_init(void);
31e88909
SR
325extern void ftrace_init_module(struct module *mod,
326 unsigned long *start, unsigned long *end);
68bf21aa
SR
327#else
328static inline void ftrace_init(void) { }
90d595fe 329static inline void
31e88909
SR
330ftrace_init_module(struct module *mod,
331 unsigned long *start, unsigned long *end) { }
68bf21aa
SR
332#endif
333
f3f47a67
AV
334enum {
335 POWER_NONE = 0,
336 POWER_CSTATE = 1,
337 POWER_PSTATE = 2,
338};
339
340struct power_trace {
341#ifdef CONFIG_POWER_TRACER
342 ktime_t stamp;
343 ktime_t end;
344 int type;
345 int state;
346#endif
347};
348
349#ifdef CONFIG_POWER_TRACER
350extern void trace_power_start(struct power_trace *it, unsigned int type,
351 unsigned int state);
352extern void trace_power_mark(struct power_trace *it, unsigned int type,
353 unsigned int state);
354extern void trace_power_end(struct power_trace *it);
355#else
356static inline void trace_power_start(struct power_trace *it, unsigned int type,
357 unsigned int state) { }
358static inline void trace_power_mark(struct power_trace *it, unsigned int type,
359 unsigned int state) { }
360static inline void trace_power_end(struct power_trace *it) { }
361#endif
362
dd0e545f 363
287b6e68
FW
364/*
365 * Structure that defines an entry function trace.
366 */
367struct ftrace_graph_ent {
368 unsigned long func; /* Current function */
369 int depth;
370};
dd0e545f 371
caf4b323
FW
372/*
373 * Structure that defines a return function trace.
374 */
fb52607a 375struct ftrace_graph_ret {
caf4b323
FW
376 unsigned long func; /* Current function */
377 unsigned long long calltime;
378 unsigned long long rettime;
0231022c
FW
379 /* Number of functions that overran the depth limit for current task */
380 unsigned long overrun;
287b6e68 381 int depth;
caf4b323
FW
382};
383
fb52607a 384#ifdef CONFIG_FUNCTION_GRAPH_TRACER
8b96f011
FW
385
386/*
387 * Sometimes we don't want to trace a function with the function
388 * graph tracer but we want them to keep traced by the usual function
389 * tracer if the function graph tracer is not configured.
390 */
391#define __notrace_funcgraph notrace
392
bcbc4f20
FW
393/*
394 * We want to which function is an entrypoint of a hardirq.
395 * That will help us to put a signal on output.
396 */
397#define __irq_entry __attribute__((__section__(".irqentry.text")))
398
399/* Limits of hardirq entrypoints */
400extern char __irqentry_text_start[];
401extern char __irqentry_text_end[];
402
f201ae23
FW
403#define FTRACE_RETFUNC_DEPTH 50
404#define FTRACE_RETSTACK_ALLOC_SIZE 32
287b6e68
FW
405/* Type of the callback handlers for tracing function graph*/
406typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
e49dc19c 407typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
287b6e68
FW
408
409extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
410 trace_func_graph_ent_t entryfunc);
411
14a866c5
SR
412extern void ftrace_graph_stop(void);
413
287b6e68
FW
414/* The current handlers in use */
415extern trace_func_graph_ret_t ftrace_graph_return;
416extern trace_func_graph_ent_t ftrace_graph_entry;
caf4b323 417
fb52607a 418extern void unregister_ftrace_graph(void);
f201ae23 419
fb52607a
FW
420extern void ftrace_graph_init_task(struct task_struct *t);
421extern void ftrace_graph_exit_task(struct task_struct *t);
21a8c466
FW
422
423static inline int task_curr_ret_stack(struct task_struct *t)
424{
425 return t->curr_ret_stack;
426}
380c4b14
FW
427
428static inline void pause_graph_tracing(void)
429{
430 atomic_inc(&current->tracing_graph_pause);
431}
432
433static inline void unpause_graph_tracing(void)
434{
435 atomic_dec(&current->tracing_graph_pause);
436}
82f60f0b 437#else
8b96f011
FW
438
439#define __notrace_funcgraph
bcbc4f20 440#define __irq_entry
8b96f011 441
fb52607a
FW
442static inline void ftrace_graph_init_task(struct task_struct *t) { }
443static inline void ftrace_graph_exit_task(struct task_struct *t) { }
21a8c466
FW
444
445static inline int task_curr_ret_stack(struct task_struct *tsk)
446{
447 return -1;
448}
380c4b14
FW
449
450static inline void pause_graph_tracing(void) { }
451static inline void unpause_graph_tracing(void) { }
caf4b323
FW
452#endif
453
ea4e2bc4
SR
454#ifdef CONFIG_TRACING
455#include <linux/sched.h>
456
457/* flags for current->trace */
458enum {
459 TSK_TRACE_FL_TRACE_BIT = 0,
460 TSK_TRACE_FL_GRAPH_BIT = 1,
461};
462enum {
463 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
464 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
465};
466
467static inline void set_tsk_trace_trace(struct task_struct *tsk)
468{
469 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
470}
471
472static inline void clear_tsk_trace_trace(struct task_struct *tsk)
473{
474 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
475}
476
477static inline int test_tsk_trace_trace(struct task_struct *tsk)
478{
479 return tsk->trace & TSK_TRACE_FL_TRACE;
480}
481
482static inline void set_tsk_trace_graph(struct task_struct *tsk)
483{
484 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
485}
486
487static inline void clear_tsk_trace_graph(struct task_struct *tsk)
488{
489 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
490}
491
492static inline int test_tsk_trace_graph(struct task_struct *tsk)
493{
494 return tsk->trace & TSK_TRACE_FL_GRAPH;
495}
496
497#endif /* CONFIG_TRACING */
498
16444a8a 499#endif /* _LINUX_FTRACE_H */
This page took 0.219971 seconds and 5 git commands to generate.