ftrace.h 13.8 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>
Hugh Dickins's avatar
Hugh Dickins committed
9
#include <linux/module.h>
10
#include <linux/kallsyms.h>
11
#include <linux/bitops.h>
12
#include <linux/sched.h>
13

14
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
15

16
17
18
19
20
21
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);

22
23
24
25
26
27
28
typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);

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

29
30
extern int function_trace_stop;

31
32
33
34
35
36
37
38
39
40
41
/*
 * 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;

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/**
 * 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;
}

68
69
70
71
72
73
74
75
76
77
78
79
80
/*
 * 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);

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

90
91
92
93
94
95
96
97
#ifdef CONFIG_STACK_TRACER
extern int stack_tracer_enabled;
int
stack_trace_sysctl(struct ctl_table *table, int write,
		   struct file *file, void __user *buffer, size_t *lenp,
		   loff_t *ppos);
#endif

98
#ifdef CONFIG_DYNAMIC_FTRACE
99
100
101
/* asm/ftrace.h must be defined for archs supporting dynamic ftrace */
#include <asm/ftrace.h>

102
enum {
103
104
105
106
	FTRACE_FL_FREE		= (1 << 0),
	FTRACE_FL_FAILED	= (1 << 1),
	FTRACE_FL_FILTER	= (1 << 2),
	FTRACE_FL_ENABLED	= (1 << 3),
107
	FTRACE_FL_NOTRACE	= (1 << 4),
108
	FTRACE_FL_CONVERTED	= (1 << 5),
109
	FTRACE_FL_FROZEN	= (1 << 6),
110
111
};

112
struct dyn_ftrace {
Steven Rostedt's avatar
Steven Rostedt committed
113
114
115
	struct list_head	list;
	unsigned long		ip; /* address of mcount call-site */
	unsigned long		flags;
116
	struct dyn_arch_ftrace	arch;
117
118
};

Steven Rostedt's avatar
Steven Rostedt committed
119
int ftrace_force_update(void);
120
void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedt's avatar
Steven Rostedt committed
121

122
/* defined in arch */
123
extern int ftrace_ip_converted(unsigned long ip);
124
125
126
127
128
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);
129
130
131
132

#ifndef FTRACE_ADDR
#define FTRACE_ADDR ((unsigned long)ftrace_caller)
#endif
133
134
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
135
136
137
138
139
extern int ftrace_enable_ftrace_graph_caller(void);
extern int ftrace_disable_ftrace_graph_caller(void);
#else
static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
140
#endif
141

142
/**
143
 * ftrace_make_nop - convert code into nop
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 * @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);
165

166
/**
167
168
169
 * 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
170
171
172
173
174
175
176
 *
 * 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.
 *
177
178
 * The code segment at @rec->ip should be a nop
 *
179
180
181
182
183
184
185
 * 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.
 */
186
187
188
189
190
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);
191

192
193
extern int skip_trace(unsigned long ip);

194
195
196
197
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
198
#else
199
# define skip_trace(ip)				({ 0; })
Ingo Molnar's avatar
Ingo Molnar committed
200
201
# define ftrace_force_update()			({ 0; })
# define ftrace_set_filter(buf, len, reset)	do { } while (0)
202
203
# define ftrace_disable_daemon()		do { } while (0)
# define ftrace_enable_daemon()			do { } while (0)
204
static inline void ftrace_release(void *start, unsigned long size) { }
205
#endif /* CONFIG_DYNAMIC_FTRACE */
206

Ingo Molnar's avatar
Ingo Molnar committed
207
208
209
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

Ingo Molnar's avatar
Ingo Molnar committed
210
211
static inline void tracer_disable(void)
{
212
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
213
214
215
216
	ftrace_enabled = 0;
#endif
}

217
218
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
219
 * must be used to prevent ftrace_enabled to be changed between
220
221
 * disable/restore.
 */
222
223
static inline int __ftrace_enabled_save(void)
{
224
#ifdef CONFIG_FUNCTION_TRACER
225
226
227
228
229
230
231
232
233
234
	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)
{
235
#ifdef CONFIG_FUNCTION_TRACER
236
237
238
239
	ftrace_enabled = enabled;
#endif
}

240
241
242
243
244
245
246
247
#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
248
# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
249
250
251
252
253
254
255
#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
256
# define CALLER_ADDR6 0UL
257
258
#endif

259
#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
260
261
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
262
263
264
265
266
#else
# define time_hardirqs_on(a0, a1)		do { } while (0)
# define time_hardirqs_off(a0, a1)		do { } while (0)
#endif

267
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
268
269
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
270
271
272
273
274
#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
275
#ifdef CONFIG_TRACING
276
277
extern int ftrace_dump_on_oops;

278
279
extern void tracing_start(void);
extern void tracing_stop(void);
280
extern void ftrace_off_permanent(void);
281

Ingo Molnar's avatar
Ingo Molnar committed
282
283
extern void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301

/**
 * 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)
302
303
304
extern int
__ftrace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
305
306
307
# define ftrace_vprintk(fmt, ap) __ftrace_printk(_THIS_IP_, fmt, ap)
extern int
__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
308
extern void ftrace_dump(void);
Ingo Molnar's avatar
Ingo Molnar committed
309
310
311
#else
static inline void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
312
static inline int
313
ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
Ingo Molnar's avatar
Ingo Molnar committed
314

315
316
static inline void tracing_start(void) { }
static inline void tracing_stop(void) { }
317
static inline void ftrace_off_permanent(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
318
319
static inline int
ftrace_printk(const char *fmt, ...)
320
321
322
{
	return 0;
}
323
324
325
326
327
static inline int
ftrace_vprintk(const char *fmt, va_list ap)
{
	return 0;
}
328
static inline void ftrace_dump(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
329
330
#endif

331
332
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
333
334
extern void ftrace_init_module(struct module *mod,
			       unsigned long *start, unsigned long *end);
335
336
#else
static inline void ftrace_init(void) { }
337
static inline void
338
339
ftrace_init_module(struct module *mod,
		   unsigned long *start, unsigned long *end) { }
340
341
#endif

342
343
344
345
346
347
348
/*
 * Structure that defines an entry function trace.
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
};
349

350
351
352
/*
 * Structure that defines a return function trace.
 */
353
struct ftrace_graph_ret {
354
355
356
	unsigned long func; /* Current function */
	unsigned long long calltime;
	unsigned long long rettime;
357
358
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
359
	int depth;
360
361
};

362
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
363
364
365
366
367
368
369
370

/*
 * Sometimes we don't want to trace a function with the function
 * graph tracer but we want them to keep traced by the usual function
 * tracer if the function graph tracer is not configured.
 */
#define __notrace_funcgraph		notrace

371
372
373
374
375
376
377
378
379
380
/*
 * We want to which function is an entrypoint of a hardirq.
 * That will help us to put a signal on output.
 */
#define __irq_entry		 __attribute__((__section__(".irqentry.text")))

/* Limits of hardirq entrypoints */
extern char __irqentry_text_start[];
extern char __irqentry_text_end[];

381
382
#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
383
384
/* Type of the callback handlers for tracing function graph*/
typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
385
typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
386
387
388
389

extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

390
391
extern void ftrace_graph_stop(void);

392
393
394
/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;
395

396
extern void unregister_ftrace_graph(void);
397

398
399
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
400
401
402
403
404

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}
405
406
407
408
409
410
411
412
413
414

static inline void pause_graph_tracing(void)
{
	atomic_inc(&current->tracing_graph_pause);
}

static inline void unpause_graph_tracing(void)
{
	atomic_dec(&current->tracing_graph_pause);
}
415
#else
416
417

#define __notrace_funcgraph
418
#define __irq_entry
419

420
421
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
422
423
424
425
426

static inline int task_curr_ret_stack(struct task_struct *tsk)
{
	return -1;
}
427
428
429

static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
430
431
#endif

432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
#ifdef CONFIG_TRACING
#include <linux/sched.h>

/* flags for current->trace */
enum {
	TSK_TRACE_FL_TRACE_BIT	= 0,
	TSK_TRACE_FL_GRAPH_BIT	= 1,
};
enum {
	TSK_TRACE_FL_TRACE	= 1 << TSK_TRACE_FL_TRACE_BIT,
	TSK_TRACE_FL_GRAPH	= 1 << TSK_TRACE_FL_GRAPH_BIT,
};

static inline void set_tsk_trace_trace(struct task_struct *tsk)
{
	set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
}

static inline void clear_tsk_trace_trace(struct task_struct *tsk)
{
	clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
}

static inline int test_tsk_trace_trace(struct task_struct *tsk)
{
	return tsk->trace & TSK_TRACE_FL_TRACE;
}

static inline void set_tsk_trace_graph(struct task_struct *tsk)
{
	set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
}

static inline void clear_tsk_trace_graph(struct task_struct *tsk)
{
	clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
}

static inline int test_tsk_trace_graph(struct task_struct *tsk)
{
	return tsk->trace & TSK_TRACE_FL_GRAPH;
}

#endif /* CONFIG_TRACING */

477
478
479
480
481
482
483
484
485
486
487
488
489

#ifdef CONFIG_HW_BRANCH_TRACER

void trace_hw_branch(u64 from, u64 to);
void trace_hw_branch_oops(void);

#else /* CONFIG_HW_BRANCH_TRACER */

static inline void trace_hw_branch(u64 from, u64 to) {}
static inline void trace_hw_branch_oops(void) {}

#endif /* CONFIG_HW_BRANCH_TRACER */

490
#endif /* _LINUX_FTRACE_H */