ftrace.h 10.4 KB
Newer Older
1
2
3
4
#ifndef _LINUX_FTRACE_H
#define _LINUX_FTRACE_H

#include <linux/linkage.h>
5
#include <linux/fs.h>
6
#include <linux/ktime.h>
7
8
#include <linux/init.h>
#include <linux/types.h>
9
#include <linux/kallsyms.h>
10

11
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
12

13
14
15
16
17
18
extern int ftrace_enabled;
extern int
ftrace_enable_sysctl(struct ctl_table *table, int write,
		     struct file *filp, void __user *buffer, size_t *lenp,
		     loff_t *ppos);

19
20
21
22
23
24
25
typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);

struct ftrace_ops {
	ftrace_func_t	  func;
	struct ftrace_ops *next;
};

26
27
extern int function_trace_stop;

28
29
30
31
32
33
34
35
36
37
38
/*
 * Type of the current tracing.
 */
enum ftrace_tracing_type_t {
	FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
	FTRACE_TYPE_RETURN,	/* Hook the return of the function */
};

/* Current tracing type, default is FTRACE_TYPE_ENTER */
extern enum ftrace_tracing_type_t ftrace_tracing_type;

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/**
 * ftrace_stop - stop function tracer.
 *
 * A quick way to stop the function tracer. Note this an on off switch,
 * it is not something that is recursive like preempt_disable.
 * This does not disable the calling of mcount, it only stops the
 * calling of functions from mcount.
 */
static inline void ftrace_stop(void)
{
	function_trace_stop = 1;
}

/**
 * ftrace_start - start the function tracer.
 *
 * This function is the inverse of ftrace_stop. This does not enable
 * the function tracing if the function tracer is disabled. This only
 * sets the function tracer flag to continue calling the functions
 * from mcount.
 */
static inline void ftrace_start(void)
{
	function_trace_stop = 0;
}

65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * The ftrace_ops must be a static and should also
 * be read_mostly.  These functions do modify read_mostly variables
 * so use them sparely. Never free an ftrace_op or modify the
 * next pointer after it has been registered. Even after unregistering
 * it, the next pointer may still be used internally.
 */
int register_ftrace_function(struct ftrace_ops *ops);
int unregister_ftrace_function(struct ftrace_ops *ops);
void clear_ftrace_function(void);

extern void ftrace_stub(unsigned long a0, unsigned long a1);

78
#else /* !CONFIG_FUNCTION_TRACER */
79
80
81
# define register_ftrace_function(ops) do { } while (0)
# define unregister_ftrace_function(ops) do { } while (0)
# define clear_ftrace_function(ops) do { } while (0)
82
static inline void ftrace_kill(void) { }
83
84
static inline void ftrace_stop(void) { }
static inline void ftrace_start(void) { }
85
#endif /* CONFIG_FUNCTION_TRACER */
86

87
#ifdef CONFIG_DYNAMIC_FTRACE
88
89
90
/* asm/ftrace.h must be defined for archs supporting dynamic ftrace */
#include <asm/ftrace.h>

91
enum {
92
93
94
95
	FTRACE_FL_FREE		= (1 << 0),
	FTRACE_FL_FAILED	= (1 << 1),
	FTRACE_FL_FILTER	= (1 << 2),
	FTRACE_FL_ENABLED	= (1 << 3),
96
	FTRACE_FL_NOTRACE	= (1 << 4),
97
	FTRACE_FL_CONVERTED	= (1 << 5),
98
	FTRACE_FL_FROZEN	= (1 << 6),
99
100
};

101
struct dyn_ftrace {
Steven Rostedt's avatar
Steven Rostedt committed
102
103
104
	struct list_head	list;
	unsigned long		ip; /* address of mcount call-site */
	unsigned long		flags;
105
	struct dyn_arch_ftrace	arch;
106
107
};

Steven Rostedt's avatar
Steven Rostedt committed
108
int ftrace_force_update(void);
109
void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedt's avatar
Steven Rostedt committed
110

111
/* defined in arch */
112
extern int ftrace_ip_converted(unsigned long ip);
113
114
115
116
117
extern int ftrace_dyn_arch_init(void *data);
extern int ftrace_update_ftrace_func(ftrace_func_t func);
extern void ftrace_caller(void);
extern void ftrace_call(void);
extern void mcount_call(void);
118
119
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
120
#endif
121

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/**
 * ftrace_make_nop - convert code into top
 * @mod: module structure if called by module load initialization
 * @rec: the mcount call site record
 * @addr: the address that the call site should be calling
 *
 * This is a very sensitive operation and great care needs
 * to be taken by the arch.  The operation should carefully
 * read the location, check to see if what is read is indeed
 * what we expect it to be, and then on success of the compare,
 * it should write to the location.
 *
 * The code segment at @rec->ip should be a caller to @addr
 *
 * Return must be:
 *  0 on success
 *  -EFAULT on error reading the location
 *  -EINVAL on a failed compare of the contents
 *  -EPERM  on error writing to the location
 * Any other value will be considered a failure.
 */
extern int ftrace_make_nop(struct module *mod,
			   struct dyn_ftrace *rec, unsigned long addr);
145

146
/**
147
148
149
 * ftrace_make_call - convert a nop call site into a call to addr
 * @rec: the mcount call site record
 * @addr: the address that the call site should call
150
151
152
153
154
155
156
 *
 * This is a very sensitive operation and great care needs
 * to be taken by the arch.  The operation should carefully
 * read the location, check to see if what is read is indeed
 * what we expect it to be, and then on success of the compare,
 * it should write to the location.
 *
157
158
 * The code segment at @rec->ip should be a nop
 *
159
160
161
162
163
164
165
 * Return must be:
 *  0 on success
 *  -EFAULT on error reading the location
 *  -EINVAL on a failed compare of the contents
 *  -EPERM  on error writing to the location
 * Any other value will be considered a failure.
 */
166
167
168
169
170
extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);


/* May be defined in arch */
extern int ftrace_arch_read_dyn_info(char *buf, int size);
171

172
173
extern int skip_trace(unsigned long ip);

174
175
176
177
extern void ftrace_release(void *start, unsigned long size);

extern void ftrace_disable_daemon(void);
extern void ftrace_enable_daemon(void);
Steven Rostedt's avatar
Steven Rostedt committed
178
#else
179
# define skip_trace(ip)				({ 0; })
Ingo Molnar's avatar
Ingo Molnar committed
180
181
# define ftrace_force_update()			({ 0; })
# define ftrace_set_filter(buf, len, reset)	do { } while (0)
182
183
# define ftrace_disable_daemon()		do { } while (0)
# define ftrace_enable_daemon()			do { } while (0)
184
static inline void ftrace_release(void *start, unsigned long size) { }
185
#endif /* CONFIG_DYNAMIC_FTRACE */
186

Ingo Molnar's avatar
Ingo Molnar committed
187
188
189
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

Ingo Molnar's avatar
Ingo Molnar committed
190
191
static inline void tracer_disable(void)
{
192
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
193
194
195
196
	ftrace_enabled = 0;
#endif
}

197
198
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
199
 * must be used to prevent ftrace_enabled to be changed between
200
201
 * disable/restore.
 */
202
203
static inline int __ftrace_enabled_save(void)
{
204
#ifdef CONFIG_FUNCTION_TRACER
205
206
207
208
209
210
211
212
213
214
	int saved_ftrace_enabled = ftrace_enabled;
	ftrace_enabled = 0;
	return saved_ftrace_enabled;
#else
	return 0;
#endif
}

static inline void __ftrace_enabled_restore(int enabled)
{
215
#ifdef CONFIG_FUNCTION_TRACER
216
217
218
219
	ftrace_enabled = enabled;
#endif
}

220
221
222
223
224
225
226
227
#ifdef CONFIG_FRAME_POINTER
/* TODO: need to fix this for ARM */
# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
Ingo Molnar's avatar
Ingo Molnar committed
228
# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
229
230
231
232
233
234
235
#else
# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
# define CALLER_ADDR1 0UL
# define CALLER_ADDR2 0UL
# define CALLER_ADDR3 0UL
# define CALLER_ADDR4 0UL
# define CALLER_ADDR5 0UL
Ingo Molnar's avatar
Ingo Molnar committed
236
# define CALLER_ADDR6 0UL
237
238
#endif

239
#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
240
241
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
242
243
244
245
246
#else
# define time_hardirqs_on(a0, a1)		do { } while (0)
# define time_hardirqs_off(a0, a1)		do { } while (0)
#endif

247
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
248
249
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
250
251
252
253
254
#else
# define trace_preempt_on(a0, a1)		do { } while (0)
# define trace_preempt_off(a0, a1)		do { } while (0)
#endif

Ingo Molnar's avatar
Ingo Molnar committed
255
#ifdef CONFIG_TRACING
256
257
extern int ftrace_dump_on_oops;

258
259
extern void tracing_start(void);
extern void tracing_stop(void);
260
extern void ftrace_off_permanent(void);
261

Ingo Molnar's avatar
Ingo Molnar committed
262
263
extern void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281

/**
 * ftrace_printk - printf formatting in the ftrace buffer
 * @fmt: the printf format for printing
 *
 * Note: __ftrace_printk is an internal function for ftrace_printk and
 *       the @ip is passed in via the ftrace_printk macro.
 *
 * This function allows a kernel developer to debug fast path sections
 * that printk is not appropriate for. By scattering in various
 * printk like tracing in the code, a developer can quickly see
 * where problems are occurring.
 *
 * This is intended as a debugging tool for the developer only.
 * Please refrain from leaving ftrace_printks scattered around in
 * your code.
 */
# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
282
283
284
extern int
__ftrace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
285
extern void ftrace_dump(void);
Ingo Molnar's avatar
Ingo Molnar committed
286
287
288
#else
static inline void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
289
static inline int
Ingo Molnar's avatar
Ingo Molnar committed
290
291
ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 0)));

292
293
static inline void tracing_start(void) { }
static inline void tracing_stop(void) { }
294
static inline void ftrace_off_permanent(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
295
296
static inline int
ftrace_printk(const char *fmt, ...)
297
298
299
{
	return 0;
}
300
static inline void ftrace_dump(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
301
302
#endif

303
304
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
305
306
extern void ftrace_init_module(struct module *mod,
			       unsigned long *start, unsigned long *end);
307
308
#else
static inline void ftrace_init(void) { }
309
static inline void
310
311
ftrace_init_module(struct module *mod,
		   unsigned long *start, unsigned long *end) { }
312
313
#endif

314

315
316
317
/*
 * Structure that defines a return function trace.
 */
318
struct ftrace_graph_ret {
319
320
321
322
	unsigned long ret; /* Return address */
	unsigned long func; /* Current function */
	unsigned long long calltime;
	unsigned long long rettime;
323
324
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
325
326
};

327
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
328
329
#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
330
/* Type of a callback handler of tracing return function */
331
typedef void (*trace_function_graph_t)(struct ftrace_graph_ret *);
332

333
extern int register_ftrace_graph(trace_function_graph_t func);
334
/* The current handler in use */
335
336
extern trace_function_graph_t ftrace_graph_function;
extern void unregister_ftrace_graph(void);
337

338
339
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
340
#else
341
342
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
343
344
#endif

345
#endif /* _LINUX_FTRACE_H */