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