ftrace.h 8.96 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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
extern int function_trace_stop;

/**
 * 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;
}

54
55
56
57
58
59
60
61
62
63
64
65
66
/*
 * 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);

67
#else /* !CONFIG_FUNCTION_TRACER */
68
69
70
# define register_ftrace_function(ops) do { } while (0)
# define unregister_ftrace_function(ops) do { } while (0)
# define clear_ftrace_function(ops) do { } while (0)
71
static inline void ftrace_kill(void) { }
72
73
static inline void ftrace_stop(void) { }
static inline void ftrace_start(void) { }
74
#endif /* CONFIG_FUNCTION_TRACER */
75

76
77
#ifdef CONFIG_DYNAMIC_FTRACE

78
enum {
79
80
81
82
	FTRACE_FL_FREE		= (1 << 0),
	FTRACE_FL_FAILED	= (1 << 1),
	FTRACE_FL_FILTER	= (1 << 2),
	FTRACE_FL_ENABLED	= (1 << 3),
83
	FTRACE_FL_NOTRACE	= (1 << 4),
84
	FTRACE_FL_CONVERTED	= (1 << 5),
85
	FTRACE_FL_FROZEN	= (1 << 6),
86
87
};

88
struct dyn_ftrace {
Steven Rostedt's avatar
Steven Rostedt committed
89
90
91
	struct list_head	list;
	unsigned long		ip; /* address of mcount call-site */
	unsigned long		flags;
92
93
};

Steven Rostedt's avatar
Steven Rostedt committed
94
int ftrace_force_update(void);
95
void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedt's avatar
Steven Rostedt committed
96

97
/* defined in arch */
98
99
100
extern int ftrace_ip_converted(unsigned long ip);
extern unsigned char *ftrace_nop_replace(void);
extern unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr);
101
102
103
104
105
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);
106

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

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/**
 * ftrace_modify_code - modify code segment
 * @ip: the address of the code segment
 * @old_code: the contents of what is expected to be there
 * @new_code: the code to patch in
 *
 * 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.
 *
 * 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_modify_code(unsigned long ip, unsigned char *old_code,
			      unsigned char *new_code);

132
133
extern int skip_trace(unsigned long ip);

134
135
136
137
extern void ftrace_release(void *start, unsigned long size);

extern void ftrace_disable_daemon(void);
extern void ftrace_enable_daemon(void);
138

Steven Rostedt's avatar
Steven Rostedt committed
139
#else
140
# define skip_trace(ip)				({ 0; })
Ingo Molnar's avatar
Ingo Molnar committed
141
142
# define ftrace_force_update()			({ 0; })
# define ftrace_set_filter(buf, len, reset)	do { } while (0)
143
144
# define ftrace_disable_daemon()		do { } while (0)
# define ftrace_enable_daemon()			do { } while (0)
145
static inline void ftrace_release(void *start, unsigned long size) { }
146
#endif /* CONFIG_DYNAMIC_FTRACE */
147

Ingo Molnar's avatar
Ingo Molnar committed
148
149
150
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

Ingo Molnar's avatar
Ingo Molnar committed
151
152
static inline void tracer_disable(void)
{
153
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
154
155
156
157
	ftrace_enabled = 0;
#endif
}

158
159
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
160
 * must be used to prevent ftrace_enabled to be changed between
161
162
 * disable/restore.
 */
163
164
static inline int __ftrace_enabled_save(void)
{
165
#ifdef CONFIG_FUNCTION_TRACER
166
167
168
169
170
171
172
173
174
175
	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)
{
176
#ifdef CONFIG_FUNCTION_TRACER
177
178
179
180
	ftrace_enabled = enabled;
#endif
}

181
182
183
184
185
186
187
188
#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
189
# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
190
191
192
193
194
195
196
#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
197
# define CALLER_ADDR6 0UL
198
199
#endif

200
#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
201
202
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
203
204
205
206
207
#else
# define time_hardirqs_on(a0, a1)		do { } while (0)
# define time_hardirqs_off(a0, a1)		do { } while (0)
#endif

208
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
209
210
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
211
212
213
214
215
#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
216
#ifdef CONFIG_TRACING
217
218
extern int ftrace_dump_on_oops;

Ingo Molnar's avatar
Ingo Molnar committed
219
220
extern void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

/**
 * 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)
239
240
241
extern int
__ftrace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
242
extern void ftrace_dump(void);
Ingo Molnar's avatar
Ingo Molnar committed
243
244
245
#else
static inline void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
246
static inline int
Ingo Molnar's avatar
Ingo Molnar committed
247
248
249
250
ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 0)));

static inline int
ftrace_printk(const char *fmt, ...)
251
252
253
{
	return 0;
}
254
static inline void ftrace_dump(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
255
256
#endif

257
258
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
259
extern void ftrace_init_module(unsigned long *start, unsigned long *end);
260
261
#else
static inline void ftrace_init(void) { }
262
263
static inline void
ftrace_init_module(unsigned long *start, unsigned long *end) { }
264
265
#endif

266

267
268
269
270
271
/*
 * Structure which defines the trace of an initcall.
 * You don't have to fill the func field since it is
 * only used internally by the tracer.
 */
272
273
struct boot_trace {
	pid_t			caller;
274
	char			func[KSYM_NAME_LEN];
275
	int			result;
276
	unsigned long long	duration;		/* usecs */
277
278
	ktime_t			calltime;
	ktime_t			rettime;
279
280
281
};

#ifdef CONFIG_BOOT_TRACER
282
/* Append the trace on the ring-buffer */
283
extern void trace_boot(struct boot_trace *it, initcall_t fn);
284
285
286
287

/* Tells the tracer that smp_pre_initcall is finished.
 * So we can start the tracing
 */
288
extern void start_boot_trace(void);
289
290
291
292
293
294
295
296
297
298

/* Resume the tracing of other necessary events
 * such as sched switches
 */
extern void enable_boot_trace(void);

/* Suspend this tracing. Actually, only sched_switches tracing have
 * to be suspended. Initcalls doesn't need it.)
 */
extern void disable_boot_trace(void);
299
#else
300
static inline void trace_boot(struct boot_trace *it, initcall_t fn) { }
301
static inline void start_boot_trace(void) { }
302
303
static inline void enable_boot_trace(void) { }
static inline void disable_boot_trace(void) { }
304
305
306
307
#endif



308
#endif /* _LINUX_FTRACE_H */