ftrace: Create ftrace_hash_empty() helper routine
[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 13#include <linux/ktime.h>
21a8c466 14#include <linux/sched.h>
0012693a
FW
15#include <linux/types.h>
16#include <linux/init.h>
17#include <linux/fs.h>
16444a8a 18
c79a61f5
UKK
19#include <asm/ftrace.h>
20
de477254 21struct module;
04da85b8
SR
22struct ftrace_hash;
23
606576ce 24#ifdef CONFIG_FUNCTION_TRACER
3e1932ad 25
b0fc494f
SR
26extern int ftrace_enabled;
27extern int
28ftrace_enable_sysctl(struct ctl_table *table, int write,
8d65af78 29 void __user *buffer, size_t *lenp,
b0fc494f
SR
30 loff_t *ppos);
31
16444a8a
ACM
32typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
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;
43dd61c9
SR
126 int (*func)(struct ftrace_hash *hash,
127 char *func, char *cmd,
f6180773
SR
128 char *params, int enable);
129};
130
3d083395 131#ifdef CONFIG_DYNAMIC_FTRACE
31e88909 132
000ab691
SR
133int ftrace_arch_code_modify_prepare(void);
134int ftrace_arch_code_modify_post_process(void);
135
c88fd863
SR
136void ftrace_bug(int err, unsigned long ip);
137
809dcf29
SR
138struct seq_file;
139
b6887d79 140struct ftrace_probe_ops {
59df055f
SR
141 void (*func)(unsigned long ip,
142 unsigned long parent_ip,
143 void **data);
144 int (*callback)(unsigned long ip, void **data);
145 void (*free)(void **data);
809dcf29
SR
146 int (*print)(struct seq_file *m,
147 unsigned long ip,
b6887d79 148 struct ftrace_probe_ops *ops,
809dcf29 149 void *data);
59df055f
SR
150};
151
152extern int
b6887d79 153register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
59df055f
SR
154 void *data);
155extern void
b6887d79 156unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
59df055f
SR
157 void *data);
158extern void
b6887d79
SR
159unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
160extern void unregister_ftrace_function_probe_all(char *glob);
59df055f 161
2cfa1978
MH
162extern int ftrace_text_reserved(void *start, void *end);
163
3c1720f0 164enum {
ed926f9b 165 FTRACE_FL_ENABLED = (1 << 30),
3c1720f0
SR
166};
167
ed926f9b
SR
168#define FTRACE_FL_MASK (0x3UL << 30)
169#define FTRACE_REF_MAX ((1 << 30) - 1)
170
3d083395 171struct dyn_ftrace {
ee000b7f
LJ
172 union {
173 unsigned long ip; /* address of mcount call-site */
174 struct dyn_ftrace *freelist;
175 };
85ae32ae 176 unsigned long flags;
ee000b7f 177 struct dyn_arch_ftrace arch;
3d083395
SR
178};
179
e1c08bdd 180int ftrace_force_update(void);
936e074b
SR
181void ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
182 int len, int reset);
183void ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
184 int len, int reset);
185void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
186void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
e1c08bdd 187
f6180773
SR
188int register_ftrace_command(struct ftrace_func_command *cmd);
189int unregister_ftrace_command(struct ftrace_func_command *cmd);
190
c88fd863
SR
191enum {
192 FTRACE_UPDATE_CALLS = (1 << 0),
193 FTRACE_DISABLE_CALLS = (1 << 1),
194 FTRACE_UPDATE_TRACE_FUNC = (1 << 2),
195 FTRACE_START_FUNC_RET = (1 << 3),
196 FTRACE_STOP_FUNC_RET = (1 << 4),
197};
198
199enum {
200 FTRACE_UPDATE_IGNORE,
201 FTRACE_UPDATE_MAKE_CALL,
202 FTRACE_UPDATE_MAKE_NOP,
203};
204
205void arch_ftrace_update_code(int command);
206
207struct ftrace_rec_iter;
208
209struct ftrace_rec_iter *ftrace_rec_iter_start(void);
210struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter);
211struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter);
212
213int ftrace_update_record(struct dyn_ftrace *rec, int enable);
214int ftrace_test_record(struct dyn_ftrace *rec, int enable);
215void ftrace_run_stop_machine(int command);
216int ftrace_location(unsigned long ip);
217
218extern ftrace_func_t ftrace_trace_function;
219
3d083395 220/* defined in arch */
3c1720f0 221extern int ftrace_ip_converted(unsigned long ip);
d61f82d0 222extern int ftrace_dyn_arch_init(void *data);
d61f82d0
SR
223extern int ftrace_update_ftrace_func(ftrace_func_t func);
224extern void ftrace_caller(void);
225extern void ftrace_call(void);
226extern void mcount_call(void);
f0001207
SL
227
228#ifndef FTRACE_ADDR
229#define FTRACE_ADDR ((unsigned long)ftrace_caller)
230#endif
fb52607a
FW
231#ifdef CONFIG_FUNCTION_GRAPH_TRACER
232extern void ftrace_graph_caller(void);
5a45cfe1
SR
233extern int ftrace_enable_ftrace_graph_caller(void);
234extern int ftrace_disable_ftrace_graph_caller(void);
235#else
236static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
237static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
e7d3737e 238#endif
ad90c0e3 239
31e88909 240/**
57794a9d 241 * ftrace_make_nop - convert code into nop
31e88909
SR
242 * @mod: module structure if called by module load initialization
243 * @rec: the mcount call site record
244 * @addr: the address that the call site should be calling
245 *
246 * This is a very sensitive operation and great care needs
247 * to be taken by the arch. The operation should carefully
248 * read the location, check to see if what is read is indeed
249 * what we expect it to be, and then on success of the compare,
250 * it should write to the location.
251 *
252 * The code segment at @rec->ip should be a caller to @addr
253 *
254 * Return must be:
255 * 0 on success
256 * -EFAULT on error reading the location
257 * -EINVAL on a failed compare of the contents
258 * -EPERM on error writing to the location
259 * Any other value will be considered a failure.
260 */
261extern int ftrace_make_nop(struct module *mod,
262 struct dyn_ftrace *rec, unsigned long addr);
a26a2a27 263
593eb8a2 264/**
31e88909
SR
265 * ftrace_make_call - convert a nop call site into a call to addr
266 * @rec: the mcount call site record
267 * @addr: the address that the call site should call
593eb8a2
SR
268 *
269 * This is a very sensitive operation and great care needs
270 * to be taken by the arch. The operation should carefully
271 * read the location, check to see if what is read is indeed
272 * what we expect it to be, and then on success of the compare,
273 * it should write to the location.
274 *
31e88909
SR
275 * The code segment at @rec->ip should be a nop
276 *
593eb8a2
SR
277 * Return must be:
278 * 0 on success
279 * -EFAULT on error reading the location
280 * -EINVAL on a failed compare of the contents
281 * -EPERM on error writing to the location
282 * Any other value will be considered a failure.
283 */
31e88909
SR
284extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
285
31e88909
SR
286/* May be defined in arch */
287extern int ftrace_arch_read_dyn_info(char *buf, int size);
593eb8a2 288
ecea656d
AS
289extern int skip_trace(unsigned long ip);
290
c0719e5a
SR
291extern void ftrace_disable_daemon(void);
292extern void ftrace_enable_daemon(void);
e1c08bdd 293#else
4dbf6bc2
SR
294static inline int skip_trace(unsigned long ip) { return 0; }
295static inline int ftrace_force_update(void) { return 0; }
296static inline void ftrace_set_filter(unsigned char *buf, int len, int reset)
297{
298}
299static inline void ftrace_disable_daemon(void) { }
300static inline void ftrace_enable_daemon(void) { }
e7247a15 301static inline void ftrace_release_mod(struct module *mod) {}
f6180773
SR
302static inline int register_ftrace_command(struct ftrace_func_command *cmd)
303{
97d0bb8d 304 return -EINVAL;
f6180773
SR
305}
306static inline int unregister_ftrace_command(char *cmd_name)
307{
97d0bb8d 308 return -EINVAL;
f6180773 309}
2cfa1978
MH
310static inline int ftrace_text_reserved(void *start, void *end)
311{
312 return 0;
313}
ecea656d 314#endif /* CONFIG_DYNAMIC_FTRACE */
352ad25a 315
aeaee8a2
IM
316/* totally disable ftrace - can not re-enable after this */
317void ftrace_kill(void);
318
f43fdad8
IM
319static inline void tracer_disable(void)
320{
606576ce 321#ifdef CONFIG_FUNCTION_TRACER
f43fdad8
IM
322 ftrace_enabled = 0;
323#endif
324}
325
37002735
HY
326/*
327 * Ftrace disable/restore without lock. Some synchronization mechanism
9bdeb7b5 328 * must be used to prevent ftrace_enabled to be changed between
37002735
HY
329 * disable/restore.
330 */
9bdeb7b5
HY
331static inline int __ftrace_enabled_save(void)
332{
606576ce 333#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
334 int saved_ftrace_enabled = ftrace_enabled;
335 ftrace_enabled = 0;
336 return saved_ftrace_enabled;
337#else
338 return 0;
339#endif
340}
341
342static inline void __ftrace_enabled_restore(int enabled)
343{
606576ce 344#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5
HY
345 ftrace_enabled = enabled;
346#endif
347}
348
c79a61f5
UKK
349#ifndef HAVE_ARCH_CALLER_ADDR
350# ifdef CONFIG_FRAME_POINTER
351# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
352# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
353# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
354# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
355# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
356# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
357# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
358# else
359# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
360# define CALLER_ADDR1 0UL
361# define CALLER_ADDR2 0UL
362# define CALLER_ADDR3 0UL
363# define CALLER_ADDR4 0UL
364# define CALLER_ADDR5 0UL
365# define CALLER_ADDR6 0UL
366# endif
367#endif /* ifndef HAVE_ARCH_CALLER_ADDR */
352ad25a 368
81d68a96 369#ifdef CONFIG_IRQSOFF_TRACER
489f1396
IM
370 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
371 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
81d68a96 372#else
4dbf6bc2
SR
373 static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
374 static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
81d68a96
SR
375#endif
376
6cd8a4bb 377#ifdef CONFIG_PREEMPT_TRACER
489f1396
IM
378 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
379 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
6cd8a4bb 380#else
4dbf6bc2
SR
381 static inline void trace_preempt_on(unsigned long a0, unsigned long a1) { }
382 static inline void trace_preempt_off(unsigned long a0, unsigned long a1) { }
6cd8a4bb
SR
383#endif
384
68bf21aa
SR
385#ifdef CONFIG_FTRACE_MCOUNT_RECORD
386extern void ftrace_init(void);
387#else
388static inline void ftrace_init(void) { }
389#endif
390
287b6e68
FW
391/*
392 * Structure that defines an entry function trace.
393 */
394struct ftrace_graph_ent {
395 unsigned long func; /* Current function */
396 int depth;
397};
dd0e545f 398
caf4b323
FW
399/*
400 * Structure that defines a return function trace.
401 */
fb52607a 402struct ftrace_graph_ret {
caf4b323
FW
403 unsigned long func; /* Current function */
404 unsigned long long calltime;
405 unsigned long long rettime;
0231022c
FW
406 /* Number of functions that overran the depth limit for current task */
407 unsigned long overrun;
287b6e68 408 int depth;
caf4b323
FW
409};
410
62b915f1
JO
411/* Type of the callback handlers for tracing function graph*/
412typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
413typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
414
fb52607a 415#ifdef CONFIG_FUNCTION_GRAPH_TRACER
8b96f011 416
5ac9f622 417/* for init task */
f876d346 418#define INIT_FTRACE_GRAPH .ret_stack = NULL,
5ac9f622 419
712406a6
SR
420/*
421 * Stack of return addresses for functions
422 * of a thread.
423 * Used in struct thread_info
424 */
425struct ftrace_ret_stack {
426 unsigned long ret;
427 unsigned long func;
428 unsigned long long calltime;
a2a16d6a 429 unsigned long long subtime;
71e308a2 430 unsigned long fp;
712406a6
SR
431};
432
433/*
434 * Primary handler of a function return.
435 * It relays on ftrace_return_to_handler.
436 * Defined in entry_32/64.S
437 */
438extern void return_to_handler(void);
439
440extern int
71e308a2
SR
441ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
442 unsigned long frame_pointer);
712406a6 443
8b96f011
FW
444/*
445 * Sometimes we don't want to trace a function with the function
446 * graph tracer but we want them to keep traced by the usual function
447 * tracer if the function graph tracer is not configured.
448 */
449#define __notrace_funcgraph notrace
450
bcbc4f20
FW
451/*
452 * We want to which function is an entrypoint of a hardirq.
453 * That will help us to put a signal on output.
454 */
455#define __irq_entry __attribute__((__section__(".irqentry.text")))
456
457/* Limits of hardirq entrypoints */
458extern char __irqentry_text_start[];
459extern char __irqentry_text_end[];
460
f201ae23
FW
461#define FTRACE_RETFUNC_DEPTH 50
462#define FTRACE_RETSTACK_ALLOC_SIZE 32
287b6e68
FW
463extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
464 trace_func_graph_ent_t entryfunc);
465
14a866c5
SR
466extern void ftrace_graph_stop(void);
467
287b6e68
FW
468/* The current handlers in use */
469extern trace_func_graph_ret_t ftrace_graph_return;
470extern trace_func_graph_ent_t ftrace_graph_entry;
caf4b323 471
fb52607a 472extern void unregister_ftrace_graph(void);
f201ae23 473
fb52607a
FW
474extern void ftrace_graph_init_task(struct task_struct *t);
475extern void ftrace_graph_exit_task(struct task_struct *t);
868baf07 476extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
21a8c466
FW
477
478static inline int task_curr_ret_stack(struct task_struct *t)
479{
480 return t->curr_ret_stack;
481}
380c4b14
FW
482
483static inline void pause_graph_tracing(void)
484{
485 atomic_inc(&current->tracing_graph_pause);
486}
487
488static inline void unpause_graph_tracing(void)
489{
490 atomic_dec(&current->tracing_graph_pause);
491}
5ac9f622 492#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
8b96f011
FW
493
494#define __notrace_funcgraph
bcbc4f20 495#define __irq_entry
5ac9f622 496#define INIT_FTRACE_GRAPH
8b96f011 497
fb52607a
FW
498static inline void ftrace_graph_init_task(struct task_struct *t) { }
499static inline void ftrace_graph_exit_task(struct task_struct *t) { }
868baf07 500static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
21a8c466 501
62b915f1
JO
502static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
503 trace_func_graph_ent_t entryfunc)
504{
505 return -1;
506}
507static inline void unregister_ftrace_graph(void) { }
508
21a8c466
FW
509static inline int task_curr_ret_stack(struct task_struct *tsk)
510{
511 return -1;
512}
380c4b14
FW
513
514static inline void pause_graph_tracing(void) { }
515static inline void unpause_graph_tracing(void) { }
5ac9f622 516#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
caf4b323 517
ea4e2bc4 518#ifdef CONFIG_TRACING
ea4e2bc4
SR
519
520/* flags for current->trace */
521enum {
522 TSK_TRACE_FL_TRACE_BIT = 0,
523 TSK_TRACE_FL_GRAPH_BIT = 1,
524};
525enum {
526 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
527 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
528};
529
530static inline void set_tsk_trace_trace(struct task_struct *tsk)
531{
532 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
533}
534
535static inline void clear_tsk_trace_trace(struct task_struct *tsk)
536{
537 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
538}
539
540static inline int test_tsk_trace_trace(struct task_struct *tsk)
541{
542 return tsk->trace & TSK_TRACE_FL_TRACE;
543}
544
545static inline void set_tsk_trace_graph(struct task_struct *tsk)
546{
547 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
548}
549
550static inline void clear_tsk_trace_graph(struct task_struct *tsk)
551{
552 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
553}
554
555static inline int test_tsk_trace_graph(struct task_struct *tsk)
556{
557 return tsk->trace & TSK_TRACE_FL_GRAPH;
558}
559
cecbca96
FW
560enum ftrace_dump_mode;
561
562extern enum ftrace_dump_mode ftrace_dump_on_oops;
526211bc 563
261842b7
SR
564#ifdef CONFIG_PREEMPT
565#define INIT_TRACE_RECURSION .trace_recursion = 0,
566#endif
567
ea4e2bc4
SR
568#endif /* CONFIG_TRACING */
569
261842b7
SR
570#ifndef INIT_TRACE_RECURSION
571#define INIT_TRACE_RECURSION
572#endif
b1818748 573
e7b8e675
MF
574#ifdef CONFIG_FTRACE_SYSCALLS
575
576unsigned long arch_syscall_addr(int nr);
577
578#endif /* CONFIG_FTRACE_SYSCALLS */
579
16444a8a 580#endif /* _LINUX_FTRACE_H */