blob: 3651fdc3bec9d4caa96b1c61476ef3a5a6ed5a96 [file] [log] [blame]
Mike Frysinger9849ed42010-07-20 03:13:35 -04001/*
2 * Ftrace header. For implementation details beyond the random comments
3 * scattered below, see: Documentation/trace/ftrace-design.txt
4 */
5
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +02006#ifndef _LINUX_FTRACE_H
7#define _LINUX_FTRACE_H
8
Frederic Weisbecker00126932009-03-05 01:49:22 +01009#include <linux/trace_clock.h>
Frederic Weisbecker56010202008-10-02 13:26:05 +020010#include <linux/kallsyms.h>
Frederic Weisbecker00126932009-03-05 01:49:22 +010011#include <linux/linkage.h>
Steven Rostedtea4e2bc2008-12-03 15:36:57 -050012#include <linux/bitops.h>
Frederic Weisbecker00126932009-03-05 01:49:22 +010013#include <linux/ktime.h>
Frederic Weisbecker21a8c462008-12-04 23:51:23 +010014#include <linux/sched.h>
Frederic Weisbecker00126932009-03-05 01:49:22 +010015#include <linux/types.h>
16#include <linux/init.h>
17#include <linux/fs.h>
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020018
Uwe Kleine-Koenigc79a61f2009-02-27 21:30:03 +010019#include <asm/ftrace.h>
20
Steven Rostedt2f5f6ad2011-08-08 16:57:47 -040021/*
22 * If the arch supports passing the variable contents of
23 * function_trace_op as the third parameter back from the
24 * mcount call, then the arch should define this as 1.
25 */
26#ifndef ARCH_SUPPORTS_FTRACE_OPS
27#define ARCH_SUPPORTS_FTRACE_OPS 0
28#endif
29
Steven Rostedtccf36722012-06-05 09:44:25 -040030/*
31 * If the arch's mcount caller does not support all of ftrace's
32 * features, then it must call an indirect function that
33 * does. Or at least does enough to prevent any unwelcomed side effects.
34 */
35#if !defined(CONFIG_HAVE_FUNCTION_TRACE_MCOUNT_TEST) || \
36 !ARCH_SUPPORTS_FTRACE_OPS
37# define FTRACE_FORCE_LIST_FUNC 1
38#else
39# define FTRACE_FORCE_LIST_FUNC 0
40#endif
41
42
Paul Gortmakerde477252011-05-26 13:46:22 -040043struct module;
Steven Rostedt04da85b2011-07-11 10:12:59 -040044struct ftrace_hash;
45
Steven Rostedt606576c2008-10-06 19:06:12 -040046#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar3e1932a2008-10-02 17:45:47 +020047
Steven Rostedtb0fc4942008-05-12 21:20:43 +020048extern int ftrace_enabled;
49extern int
50ftrace_enable_sysctl(struct ctl_table *table, int write,
Alexey Dobriyan8d65af72009-09-23 15:57:19 -070051 void __user *buffer, size_t *lenp,
Steven Rostedtb0fc4942008-05-12 21:20:43 +020052 loff_t *ppos);
53
Steven Rostedt2f5f6ad2011-08-08 16:57:47 -040054struct ftrace_ops;
55
56typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip,
57 struct ftrace_ops *op);
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020058
Jiri Olsae2484912012-02-15 15:51:48 +010059/*
60 * FTRACE_OPS_FL_* bits denote the state of ftrace_ops struct and are
61 * set in the flags member.
62 *
63 * ENABLED - set/unset when ftrace_ops is registered/unregistered
64 * GLOBAL - set manualy by ftrace_ops user to denote the ftrace_ops
65 * is part of the global tracers sharing the same filter
66 * via set_ftrace_* debugfs files.
67 * DYNAMIC - set when ftrace_ops is registered to denote dynamically
68 * allocated ftrace_ops which need special care
69 * CONTROL - set manualy by ftrace_ops user to denote the ftrace_ops
70 * could be controled by following calls:
71 * ftrace_function_local_enable
72 * ftrace_function_local_disable
73 */
Steven Rostedtb8489142011-05-04 09:27:52 -040074enum {
75 FTRACE_OPS_FL_ENABLED = 1 << 0,
76 FTRACE_OPS_FL_GLOBAL = 1 << 1,
Steven Rostedtcdbe61b2011-05-05 21:14:55 -040077 FTRACE_OPS_FL_DYNAMIC = 1 << 2,
Jiri Olsae2484912012-02-15 15:51:48 +010078 FTRACE_OPS_FL_CONTROL = 1 << 3,
Steven Rostedtb8489142011-05-04 09:27:52 -040079};
80
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020081struct ftrace_ops {
Steven Rostedtf45948e2011-05-02 12:29:25 -040082 ftrace_func_t func;
83 struct ftrace_ops *next;
Steven Rostedtb8489142011-05-04 09:27:52 -040084 unsigned long flags;
Jiri Olsae2484912012-02-15 15:51:48 +010085 int __percpu *disabled;
Steven Rostedtf45948e2011-05-02 12:29:25 -040086#ifdef CONFIG_DYNAMIC_FTRACE
87 struct ftrace_hash *notrace_hash;
88 struct ftrace_hash *filter_hash;
89#endif
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020090};
91
Steven Rostedt60a7ecf2008-11-05 16:05:44 -050092extern int function_trace_stop;
93
Frederic Weisbeckere7d37372008-11-16 06:02:06 +010094/*
95 * Type of the current tracing.
96 */
97enum ftrace_tracing_type_t {
98 FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
99 FTRACE_TYPE_RETURN, /* Hook the return of the function */
100};
101
102/* Current tracing type, default is FTRACE_TYPE_ENTER */
103extern enum ftrace_tracing_type_t ftrace_tracing_type;
104
Steven Rostedt60a7ecf2008-11-05 16:05:44 -0500105/**
106 * ftrace_stop - stop function tracer.
107 *
108 * A quick way to stop the function tracer. Note this an on off switch,
109 * it is not something that is recursive like preempt_disable.
110 * This does not disable the calling of mcount, it only stops the
111 * calling of functions from mcount.
112 */
113static inline void ftrace_stop(void)
114{
115 function_trace_stop = 1;
116}
117
118/**
119 * ftrace_start - start the function tracer.
120 *
121 * This function is the inverse of ftrace_stop. This does not enable
122 * the function tracing if the function tracer is disabled. This only
123 * sets the function tracer flag to continue calling the functions
124 * from mcount.
125 */
126static inline void ftrace_start(void)
127{
128 function_trace_stop = 0;
129}
130
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +0200131/*
132 * The ftrace_ops must be a static and should also
133 * be read_mostly. These functions do modify read_mostly variables
134 * so use them sparely. Never free an ftrace_op or modify the
135 * next pointer after it has been registered. Even after unregistering
136 * it, the next pointer may still be used internally.
137 */
138int register_ftrace_function(struct ftrace_ops *ops);
139int unregister_ftrace_function(struct ftrace_ops *ops);
140void clear_ftrace_function(void);
141
Jiri Olsae2484912012-02-15 15:51:48 +0100142/**
143 * ftrace_function_local_enable - enable controlled ftrace_ops on current cpu
144 *
145 * This function enables tracing on current cpu by decreasing
146 * the per cpu control variable.
147 * It must be called with preemption disabled and only on ftrace_ops
148 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
149 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
150 */
151static inline void ftrace_function_local_enable(struct ftrace_ops *ops)
152{
153 if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
154 return;
155
156 (*this_cpu_ptr(ops->disabled))--;
157}
158
159/**
160 * ftrace_function_local_disable - enable controlled ftrace_ops on current cpu
161 *
162 * This function enables tracing on current cpu by decreasing
163 * the per cpu control variable.
164 * It must be called with preemption disabled and only on ftrace_ops
165 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
166 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
167 */
168static inline void ftrace_function_local_disable(struct ftrace_ops *ops)
169{
170 if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
171 return;
172
173 (*this_cpu_ptr(ops->disabled))++;
174}
175
176/**
177 * ftrace_function_local_disabled - returns ftrace_ops disabled value
178 * on current cpu
179 *
180 * This function returns value of ftrace_ops::disabled on current cpu.
181 * It must be called with preemption disabled and only on ftrace_ops
182 * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
183 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
184 */
185static inline int ftrace_function_local_disabled(struct ftrace_ops *ops)
186{
187 WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL));
188 return *this_cpu_ptr(ops->disabled);
189}
190
Steven Rostedt2f5f6ad2011-08-08 16:57:47 -0400191extern void ftrace_stub(unsigned long a0, unsigned long a1, struct ftrace_ops *op);
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +0200192
Steven Rostedt606576c2008-10-06 19:06:12 -0400193#else /* !CONFIG_FUNCTION_TRACER */
Steven Rostedt4dbf6bc2010-05-04 11:24:01 -0400194/*
195 * (un)register_ftrace_function must be a macro since the ops parameter
196 * must not be evaluated.
197 */
198#define register_ftrace_function(ops) ({ 0; })
199#define unregister_ftrace_function(ops) ({ 0; })
200static inline void clear_ftrace_function(void) { }
Steven Rostedt81adbdc2008-10-23 09:33:02 -0400201static inline void ftrace_kill(void) { }
Steven Rostedt60a7ecf2008-11-05 16:05:44 -0500202static inline void ftrace_stop(void) { }
203static inline void ftrace_start(void) { }
Steven Rostedt606576c2008-10-06 19:06:12 -0400204#endif /* CONFIG_FUNCTION_TRACER */
Steven Rostedt352ad252008-05-12 21:20:42 +0200205
Steven Rostedtf38f1d22008-12-16 23:06:40 -0500206#ifdef CONFIG_STACK_TRACER
207extern int stack_tracer_enabled;
208int
209stack_trace_sysctl(struct ctl_table *table, int write,
Alexey Dobriyan8d65af72009-09-23 15:57:19 -0700210 void __user *buffer, size_t *lenp,
Steven Rostedtf38f1d22008-12-16 23:06:40 -0500211 loff_t *ppos);
212#endif
213
Steven Rostedtf6180772009-02-14 00:40:25 -0500214struct ftrace_func_command {
215 struct list_head list;
216 char *name;
Steven Rostedt43dd61c2011-07-07 11:09:22 -0400217 int (*func)(struct ftrace_hash *hash,
218 char *func, char *cmd,
Steven Rostedtf6180772009-02-14 00:40:25 -0500219 char *params, int enable);
220};
221
Steven Rostedt3d083392008-05-12 21:20:42 +0200222#ifdef CONFIG_DYNAMIC_FTRACE
Steven Rostedt31e88902008-11-14 16:21:19 -0800223
Steven Rostedt000ab692009-02-17 13:35:06 -0500224int ftrace_arch_code_modify_prepare(void);
225int ftrace_arch_code_modify_post_process(void);
226
Steven Rostedtc88fd862011-08-16 09:53:39 -0400227void ftrace_bug(int err, unsigned long ip);
228
Steven Rostedt809dcf22009-02-16 23:06:01 -0500229struct seq_file;
230
Steven Rostedtb6887d72009-02-17 12:32:04 -0500231struct ftrace_probe_ops {
Steven Rostedt59df055f2009-02-14 15:29:06 -0500232 void (*func)(unsigned long ip,
233 unsigned long parent_ip,
234 void **data);
235 int (*callback)(unsigned long ip, void **data);
236 void (*free)(void **data);
Steven Rostedt809dcf22009-02-16 23:06:01 -0500237 int (*print)(struct seq_file *m,
238 unsigned long ip,
Steven Rostedtb6887d72009-02-17 12:32:04 -0500239 struct ftrace_probe_ops *ops,
Steven Rostedt809dcf22009-02-16 23:06:01 -0500240 void *data);
Steven Rostedt59df055f2009-02-14 15:29:06 -0500241};
242
243extern int
Steven Rostedtb6887d72009-02-17 12:32:04 -0500244register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
Steven Rostedt59df055f2009-02-14 15:29:06 -0500245 void *data);
246extern void
Steven Rostedtb6887d72009-02-17 12:32:04 -0500247unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
Steven Rostedt59df055f2009-02-14 15:29:06 -0500248 void *data);
249extern void
Steven Rostedtb6887d72009-02-17 12:32:04 -0500250unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
251extern void unregister_ftrace_function_probe_all(char *glob);
Steven Rostedt59df055f2009-02-14 15:29:06 -0500252
Masami Hiramatsu2cfa1972010-02-02 16:49:11 -0500253extern int ftrace_text_reserved(void *start, void *end);
254
Steven Rostedt3c1720f2008-05-12 21:20:43 +0200255enum {
Steven Rostedted926f92011-05-03 13:25:24 -0400256 FTRACE_FL_ENABLED = (1 << 30),
Steven Rostedt3c1720f2008-05-12 21:20:43 +0200257};
258
Steven Rostedted926f92011-05-03 13:25:24 -0400259#define FTRACE_FL_MASK (0x3UL << 30)
260#define FTRACE_REF_MAX ((1 << 30) - 1)
261
Steven Rostedt3d083392008-05-12 21:20:42 +0200262struct dyn_ftrace {
Lai Jiangshanee000b72009-03-24 13:38:06 +0800263 union {
264 unsigned long ip; /* address of mcount call-site */
265 struct dyn_ftrace *freelist;
266 };
Steven Rostedt85ae32a2011-12-16 16:30:31 -0500267 unsigned long flags;
Lai Jiangshanee000b72009-03-24 13:38:06 +0800268 struct dyn_arch_ftrace arch;
Steven Rostedt3d083392008-05-12 21:20:42 +0200269};
270
Steven Rostedte1c08bd2008-05-12 21:20:44 +0200271int ftrace_force_update(void);
Jiri Olsaac483c42012-01-02 10:04:14 +0100272int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
Steven Rostedt936e0742011-05-05 22:54:01 -0400273 int len, int reset);
Jiri Olsaac483c42012-01-02 10:04:14 +0100274int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
Steven Rostedt936e0742011-05-05 22:54:01 -0400275 int len, int reset);
276void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
277void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
Jiri Olsa5500fa52012-02-15 15:51:54 +0100278void ftrace_free_filter(struct ftrace_ops *ops);
Steven Rostedte1c08bd2008-05-12 21:20:44 +0200279
Steven Rostedtf6180772009-02-14 00:40:25 -0500280int register_ftrace_command(struct ftrace_func_command *cmd);
281int unregister_ftrace_command(struct ftrace_func_command *cmd);
282
Steven Rostedtc88fd862011-08-16 09:53:39 -0400283enum {
284 FTRACE_UPDATE_CALLS = (1 << 0),
285 FTRACE_DISABLE_CALLS = (1 << 1),
286 FTRACE_UPDATE_TRACE_FUNC = (1 << 2),
287 FTRACE_START_FUNC_RET = (1 << 3),
288 FTRACE_STOP_FUNC_RET = (1 << 4),
289};
290
291enum {
292 FTRACE_UPDATE_IGNORE,
293 FTRACE_UPDATE_MAKE_CALL,
294 FTRACE_UPDATE_MAKE_NOP,
295};
296
Steven Rostedtfc13cb02011-12-19 14:41:25 -0500297enum {
298 FTRACE_ITER_FILTER = (1 << 0),
299 FTRACE_ITER_NOTRACE = (1 << 1),
300 FTRACE_ITER_PRINTALL = (1 << 2),
Steven Rostedt69a30832011-12-19 15:21:16 -0500301 FTRACE_ITER_DO_HASH = (1 << 3),
302 FTRACE_ITER_HASH = (1 << 4),
303 FTRACE_ITER_ENABLED = (1 << 5),
Steven Rostedtfc13cb02011-12-19 14:41:25 -0500304};
305
Steven Rostedtc88fd862011-08-16 09:53:39 -0400306void arch_ftrace_update_code(int command);
307
308struct ftrace_rec_iter;
309
310struct ftrace_rec_iter *ftrace_rec_iter_start(void);
311struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter);
312struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter);
313
Steven Rostedt08d636b2011-08-16 09:57:10 -0400314#define for_ftrace_rec_iter(iter) \
315 for (iter = ftrace_rec_iter_start(); \
316 iter; \
317 iter = ftrace_rec_iter_next(iter))
318
319
Steven Rostedtc88fd862011-08-16 09:53:39 -0400320int ftrace_update_record(struct dyn_ftrace *rec, int enable);
321int ftrace_test_record(struct dyn_ftrace *rec, int enable);
322void ftrace_run_stop_machine(int command);
Steven Rostedtf0cf9732012-04-25 14:39:54 -0400323unsigned long ftrace_location(unsigned long ip);
Steven Rostedtc88fd862011-08-16 09:53:39 -0400324
325extern ftrace_func_t ftrace_trace_function;
326
Steven Rostedtfc13cb02011-12-19 14:41:25 -0500327int ftrace_regex_open(struct ftrace_ops *ops, int flag,
328 struct inode *inode, struct file *file);
329ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
330 size_t cnt, loff_t *ppos);
331ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
332 size_t cnt, loff_t *ppos);
333loff_t ftrace_regex_lseek(struct file *file, loff_t offset, int origin);
334int ftrace_regex_release(struct inode *inode, struct file *file);
335
Steven Rostedt2a85a372011-12-19 21:57:44 -0500336void __init
337ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable);
338
Steven Rostedt3d083392008-05-12 21:20:42 +0200339/* defined in arch */
Steven Rostedt3c1720f2008-05-12 21:20:43 +0200340extern int ftrace_ip_converted(unsigned long ip);
Steven Rostedtd61f82d2008-05-12 21:20:43 +0200341extern int ftrace_dyn_arch_init(void *data);
Steven Rostedte4f5d542012-04-27 09:13:18 -0400342extern void ftrace_replace_code(int enable);
Steven Rostedtd61f82d2008-05-12 21:20:43 +0200343extern int ftrace_update_ftrace_func(ftrace_func_t func);
344extern void ftrace_caller(void);
345extern void ftrace_call(void);
346extern void mcount_call(void);
Shaohua Lif0001202009-01-09 11:29:42 +0800347
Steven Rostedt8ed3e2c2012-04-26 14:59:43 -0400348void ftrace_modify_all_code(int command);
349
Shaohua Lif0001202009-01-09 11:29:42 +0800350#ifndef FTRACE_ADDR
351#define FTRACE_ADDR ((unsigned long)ftrace_caller)
352#endif
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100353#ifdef CONFIG_FUNCTION_GRAPH_TRACER
354extern void ftrace_graph_caller(void);
Steven Rostedt5a45cfe2008-11-26 00:16:24 -0500355extern int ftrace_enable_ftrace_graph_caller(void);
356extern int ftrace_disable_ftrace_graph_caller(void);
357#else
358static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
359static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
Frederic Weisbeckere7d37372008-11-16 06:02:06 +0100360#endif
Steven Rostedtad90c0e2008-05-27 20:48:37 -0400361
Steven Rostedt593eb8a2008-10-23 09:32:59 -0400362/**
Wenji Huang57794a92009-02-06 17:33:27 +0800363 * ftrace_make_nop - convert code into nop
Steven Rostedt31e88902008-11-14 16:21:19 -0800364 * @mod: module structure if called by module load initialization
365 * @rec: the mcount call site record
366 * @addr: the address that the call site should be calling
Steven Rostedt593eb8a2008-10-23 09:32:59 -0400367 *
368 * This is a very sensitive operation and great care needs
369 * to be taken by the arch. The operation should carefully
370 * read the location, check to see if what is read is indeed
371 * what we expect it to be, and then on success of the compare,
372 * it should write to the location.
373 *
Steven Rostedt31e88902008-11-14 16:21:19 -0800374 * The code segment at @rec->ip should be a caller to @addr
375 *
Steven Rostedt593eb8a2008-10-23 09:32:59 -0400376 * Return must be:
377 * 0 on success
378 * -EFAULT on error reading the location
379 * -EINVAL on a failed compare of the contents
380 * -EPERM on error writing to the location
381 * Any other value will be considered a failure.
382 */
Steven Rostedt31e88902008-11-14 16:21:19 -0800383extern int ftrace_make_nop(struct module *mod,
384 struct dyn_ftrace *rec, unsigned long addr);
385
386/**
387 * ftrace_make_call - convert a nop call site into a call to addr
388 * @rec: the mcount call site record
389 * @addr: the address that the call site should call
390 *
391 * This is a very sensitive operation and great care needs
392 * to be taken by the arch. The operation should carefully
393 * read the location, check to see if what is read is indeed
394 * what we expect it to be, and then on success of the compare,
395 * it should write to the location.
396 *
397 * The code segment at @rec->ip should be a nop
398 *
399 * Return must be:
400 * 0 on success
401 * -EFAULT on error reading the location
402 * -EINVAL on a failed compare of the contents
403 * -EPERM on error writing to the location
404 * Any other value will be considered a failure.
405 */
406extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
407
Steven Rostedt31e88902008-11-14 16:21:19 -0800408/* May be defined in arch */
409extern int ftrace_arch_read_dyn_info(char *buf, int size);
Steven Rostedt593eb8a2008-10-23 09:32:59 -0400410
Abhishek Sagarecea6562008-06-21 23:47:53 +0530411extern int skip_trace(unsigned long ip);
412
Steven Rostedtc0719e52008-09-06 01:06:03 -0400413extern void ftrace_disable_daemon(void);
414extern void ftrace_enable_daemon(void);
Steven Rostedte1c08bd2008-05-12 21:20:44 +0200415#else
Steven Rostedt4dbf6bc2010-05-04 11:24:01 -0400416static inline int skip_trace(unsigned long ip) { return 0; }
417static inline int ftrace_force_update(void) { return 0; }
Steven Rostedt4dbf6bc2010-05-04 11:24:01 -0400418static inline void ftrace_disable_daemon(void) { }
419static inline void ftrace_enable_daemon(void) { }
jolsa@redhat.come7247a12009-10-07 19:00:35 +0200420static inline void ftrace_release_mod(struct module *mod) {}
Steven Rostedtf6180772009-02-14 00:40:25 -0500421static inline int register_ftrace_command(struct ftrace_func_command *cmd)
422{
Ingo Molnar97d0bb82009-02-17 11:47:39 +0100423 return -EINVAL;
Steven Rostedtf6180772009-02-14 00:40:25 -0500424}
425static inline int unregister_ftrace_command(char *cmd_name)
426{
Ingo Molnar97d0bb82009-02-17 11:47:39 +0100427 return -EINVAL;
Steven Rostedtf6180772009-02-14 00:40:25 -0500428}
Masami Hiramatsu2cfa1972010-02-02 16:49:11 -0500429static inline int ftrace_text_reserved(void *start, void *end)
430{
431 return 0;
432}
Steven Rostedtfc13cb02011-12-19 14:41:25 -0500433
434/*
435 * Again users of functions that have ftrace_ops may not
436 * have them defined when ftrace is not enabled, but these
437 * functions may still be called. Use a macro instead of inline.
438 */
439#define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; })
Steven Rostedt96de37b2012-01-07 17:26:49 -0500440#define ftrace_set_early_filter(ops, buf, enable) do { } while (0)
Jiri Olsa5500fa52012-02-15 15:51:54 +0100441#define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; })
442#define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; })
443#define ftrace_free_filter(ops) do { } while (0)
Steven Rostedtfc13cb02011-12-19 14:41:25 -0500444
445static inline ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
446 size_t cnt, loff_t *ppos) { return -ENODEV; }
447static inline ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
448 size_t cnt, loff_t *ppos) { return -ENODEV; }
449static inline loff_t ftrace_regex_lseek(struct file *file, loff_t offset, int origin)
450{
451 return -ENODEV;
452}
453static inline int
454ftrace_regex_release(struct inode *inode, struct file *file) { return -ENODEV; }
Abhishek Sagarecea6562008-06-21 23:47:53 +0530455#endif /* CONFIG_DYNAMIC_FTRACE */
Steven Rostedt352ad252008-05-12 21:20:42 +0200456
Ingo Molnaraeaee8a2008-05-12 21:20:49 +0200457/* totally disable ftrace - can not re-enable after this */
458void ftrace_kill(void);
459
Ingo Molnarf43fdad2008-05-12 21:20:43 +0200460static inline void tracer_disable(void)
461{
Steven Rostedt606576c2008-10-06 19:06:12 -0400462#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnarf43fdad2008-05-12 21:20:43 +0200463 ftrace_enabled = 0;
464#endif
465}
466
Huang Ying37002732008-08-18 16:24:56 +0800467/*
468 * Ftrace disable/restore without lock. Some synchronization mechanism
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700469 * must be used to prevent ftrace_enabled to be changed between
Huang Ying37002732008-08-18 16:24:56 +0800470 * disable/restore.
471 */
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700472static inline int __ftrace_enabled_save(void)
473{
Steven Rostedt606576c2008-10-06 19:06:12 -0400474#ifdef CONFIG_FUNCTION_TRACER
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700475 int saved_ftrace_enabled = ftrace_enabled;
476 ftrace_enabled = 0;
477 return saved_ftrace_enabled;
478#else
479 return 0;
480#endif
481}
482
483static inline void __ftrace_enabled_restore(int enabled)
484{
Steven Rostedt606576c2008-10-06 19:06:12 -0400485#ifdef CONFIG_FUNCTION_TRACER
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700486 ftrace_enabled = enabled;
487#endif
488}
489
Uwe Kleine-Koenigc79a61f2009-02-27 21:30:03 +0100490#ifndef HAVE_ARCH_CALLER_ADDR
491# ifdef CONFIG_FRAME_POINTER
492# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
493# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
494# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
495# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
496# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
497# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
498# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
499# else
500# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
501# define CALLER_ADDR1 0UL
502# define CALLER_ADDR2 0UL
503# define CALLER_ADDR3 0UL
504# define CALLER_ADDR4 0UL
505# define CALLER_ADDR5 0UL
506# define CALLER_ADDR6 0UL
507# endif
508#endif /* ifndef HAVE_ARCH_CALLER_ADDR */
Steven Rostedt352ad252008-05-12 21:20:42 +0200509
Steven Rostedt81d68a92008-05-12 21:20:42 +0200510#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar489f1392008-02-25 13:38:05 +0100511 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
512 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
Steven Rostedt81d68a92008-05-12 21:20:42 +0200513#else
Steven Rostedt4dbf6bc2010-05-04 11:24:01 -0400514 static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
515 static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
Steven Rostedt81d68a92008-05-12 21:20:42 +0200516#endif
517
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200518#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar489f1392008-02-25 13:38:05 +0100519 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
520 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200521#else
Minho Banb02ee9a2012-05-07 11:36:00 +0900522/*
523 * Use defines instead of static inlines because some arches will make code out
524 * of the CALLER_ADDR, when we really want these to be a real nop.
525 */
526# define trace_preempt_on(a0, a1) do { } while (0)
527# define trace_preempt_off(a0, a1) do { } while (0)
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200528#endif
529
Steven Rostedt68bf21a2008-08-14 15:45:08 -0400530#ifdef CONFIG_FTRACE_MCOUNT_RECORD
531extern void ftrace_init(void);
532#else
533static inline void ftrace_init(void) { }
534#endif
535
Frederic Weisbecker71566a02008-10-31 12:57:20 +0100536/*
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100537 * Structure that defines an entry function trace.
538 */
539struct ftrace_graph_ent {
540 unsigned long func; /* Current function */
541 int depth;
542};
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400543
Frederic Weisbecker71566a02008-10-31 12:57:20 +0100544/*
Frederic Weisbeckercaf4b322008-11-11 07:03:45 +0100545 * Structure that defines a return function trace.
546 */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100547struct ftrace_graph_ret {
Frederic Weisbeckercaf4b322008-11-11 07:03:45 +0100548 unsigned long func; /* Current function */
549 unsigned long long calltime;
550 unsigned long long rettime;
Frederic Weisbecker02310222008-11-17 03:22:41 +0100551 /* Number of functions that overran the depth limit for current task */
552 unsigned long overrun;
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100553 int depth;
Frederic Weisbeckercaf4b322008-11-11 07:03:45 +0100554};
555
Jiri Olsa62b915f2010-04-02 19:01:22 +0200556/* Type of the callback handlers for tracing function graph*/
557typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
558typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
559
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100560#ifdef CONFIG_FUNCTION_GRAPH_TRACER
Frederic Weisbecker8b96f012008-12-06 03:40:00 +0100561
Steven Rostedt5ac9f622009-03-25 20:55:00 -0400562/* for init task */
Tetsuo Handaf876d342009-04-08 14:05:43 +0900563#define INIT_FTRACE_GRAPH .ret_stack = NULL,
Steven Rostedt5ac9f622009-03-25 20:55:00 -0400564
Frederic Weisbecker8b96f012008-12-06 03:40:00 +0100565/*
Steven Rostedt712406a2009-02-09 10:54:03 -0800566 * Stack of return addresses for functions
567 * of a thread.
568 * Used in struct thread_info
569 */
570struct ftrace_ret_stack {
571 unsigned long ret;
572 unsigned long func;
573 unsigned long long calltime;
Steven Rostedta2a16d62009-03-24 23:17:58 -0400574 unsigned long long subtime;
Steven Rostedt71e308a2009-06-18 12:45:08 -0400575 unsigned long fp;
Steven Rostedt712406a2009-02-09 10:54:03 -0800576};
577
578/*
579 * Primary handler of a function return.
580 * It relays on ftrace_return_to_handler.
581 * Defined in entry_32/64.S
582 */
583extern void return_to_handler(void);
584
585extern int
Steven Rostedt71e308a2009-06-18 12:45:08 -0400586ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
587 unsigned long frame_pointer);
Steven Rostedt712406a2009-02-09 10:54:03 -0800588
589/*
Frederic Weisbecker8b96f012008-12-06 03:40:00 +0100590 * Sometimes we don't want to trace a function with the function
591 * graph tracer but we want them to keep traced by the usual function
592 * tracer if the function graph tracer is not configured.
593 */
594#define __notrace_funcgraph notrace
595
Frederic Weisbeckerbcbc4f22008-12-09 23:54:20 +0100596/*
597 * We want to which function is an entrypoint of a hardirq.
598 * That will help us to put a signal on output.
599 */
600#define __irq_entry __attribute__((__section__(".irqentry.text")))
601
602/* Limits of hardirq entrypoints */
603extern char __irqentry_text_start[];
604extern char __irqentry_text_end[];
605
Frederic Weisbeckerf201ae22008-11-23 06:22:56 +0100606#define FTRACE_RETFUNC_DEPTH 50
607#define FTRACE_RETSTACK_ALLOC_SIZE 32
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100608extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
609 trace_func_graph_ent_t entryfunc);
Frederic Weisbeckerf201ae22008-11-23 06:22:56 +0100610
Steven Rostedt14a866c2008-12-02 23:50:02 -0500611extern void ftrace_graph_stop(void);
612
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100613/* The current handlers in use */
614extern trace_func_graph_ret_t ftrace_graph_return;
615extern trace_func_graph_ent_t ftrace_graph_entry;
616
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100617extern void unregister_ftrace_graph(void);
Frederic Weisbeckerf201ae22008-11-23 06:22:56 +0100618
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100619extern void ftrace_graph_init_task(struct task_struct *t);
620extern void ftrace_graph_exit_task(struct task_struct *t);
Steven Rostedt868baf02011-02-10 21:26:13 -0500621extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
Frederic Weisbecker21a8c462008-12-04 23:51:23 +0100622
623static inline int task_curr_ret_stack(struct task_struct *t)
624{
625 return t->curr_ret_stack;
626}
Frederic Weisbecker380c4b12008-12-06 03:43:41 +0100627
628static inline void pause_graph_tracing(void)
629{
630 atomic_inc(&current->tracing_graph_pause);
631}
632
633static inline void unpause_graph_tracing(void)
634{
635 atomic_dec(&current->tracing_graph_pause);
636}
Steven Rostedt5ac9f622009-03-25 20:55:00 -0400637#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker8b96f012008-12-06 03:40:00 +0100638
639#define __notrace_funcgraph
Frederic Weisbeckerbcbc4f22008-12-09 23:54:20 +0100640#define __irq_entry
Steven Rostedt5ac9f622009-03-25 20:55:00 -0400641#define INIT_FTRACE_GRAPH
Frederic Weisbecker8b96f012008-12-06 03:40:00 +0100642
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100643static inline void ftrace_graph_init_task(struct task_struct *t) { }
644static inline void ftrace_graph_exit_task(struct task_struct *t) { }
Steven Rostedt868baf02011-02-10 21:26:13 -0500645static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
Frederic Weisbecker21a8c462008-12-04 23:51:23 +0100646
Jiri Olsa62b915f2010-04-02 19:01:22 +0200647static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
648 trace_func_graph_ent_t entryfunc)
649{
650 return -1;
651}
652static inline void unregister_ftrace_graph(void) { }
653
Frederic Weisbecker21a8c462008-12-04 23:51:23 +0100654static inline int task_curr_ret_stack(struct task_struct *tsk)
655{
656 return -1;
657}
Frederic Weisbecker380c4b12008-12-06 03:43:41 +0100658
659static inline void pause_graph_tracing(void) { }
660static inline void unpause_graph_tracing(void) { }
Steven Rostedt5ac9f622009-03-25 20:55:00 -0400661#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbeckercaf4b322008-11-11 07:03:45 +0100662
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500663#ifdef CONFIG_TRACING
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500664
665/* flags for current->trace */
666enum {
667 TSK_TRACE_FL_TRACE_BIT = 0,
668 TSK_TRACE_FL_GRAPH_BIT = 1,
669};
670enum {
671 TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
672 TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
673};
674
675static inline void set_tsk_trace_trace(struct task_struct *tsk)
676{
677 set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
678}
679
680static inline void clear_tsk_trace_trace(struct task_struct *tsk)
681{
682 clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
683}
684
685static inline int test_tsk_trace_trace(struct task_struct *tsk)
686{
687 return tsk->trace & TSK_TRACE_FL_TRACE;
688}
689
690static inline void set_tsk_trace_graph(struct task_struct *tsk)
691{
692 set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
693}
694
695static inline void clear_tsk_trace_graph(struct task_struct *tsk)
696{
697 clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
698}
699
700static inline int test_tsk_trace_graph(struct task_struct *tsk)
701{
702 return tsk->trace & TSK_TRACE_FL_GRAPH;
703}
704
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200705enum ftrace_dump_mode;
706
707extern enum ftrace_dump_mode ftrace_dump_on_oops;
Ingo Molnar526211b2009-03-05 10:28:45 +0100708
Steven Rostedt261842b2009-04-16 21:41:52 -0400709#ifdef CONFIG_PREEMPT
710#define INIT_TRACE_RECURSION .trace_recursion = 0,
711#endif
712
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500713#endif /* CONFIG_TRACING */
714
Steven Rostedt261842b2009-04-16 21:41:52 -0400715#ifndef INIT_TRACE_RECURSION
716#define INIT_TRACE_RECURSION
717#endif
Markus Metzgerb1818742009-01-19 10:31:01 +0100718
Mike Frysingere7b8e672010-01-26 04:40:03 -0500719#ifdef CONFIG_FTRACE_SYSCALLS
720
721unsigned long arch_syscall_addr(int nr);
722
723#endif /* CONFIG_FTRACE_SYSCALLS */
724
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +0200725#endif /* _LINUX_FTRACE_H */