ftrace.h 14.9 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
99
100
101
102
103
104
struct ftrace_func_command {
	struct list_head	list;
	char			*name;
	int			(*func)(char *func, char *cmd,
					char *params, int enable);
};

105
#ifdef CONFIG_DYNAMIC_FTRACE
106
107
108
/* asm/ftrace.h must be defined for archs supporting dynamic ftrace */
#include <asm/ftrace.h>

109
110
struct seq_file;

111
112
113
114
115
116
struct ftrace_hook_ops {
	void			(*func)(unsigned long ip,
					unsigned long parent_ip,
					void **data);
	int			(*callback)(unsigned long ip, void **data);
	void			(*free)(void **data);
117
118
119
120
	int			(*print)(struct seq_file *m,
					 unsigned long ip,
					 struct ftrace_hook_ops *ops,
					 void *data);
121
122
123
124
125
126
127
128
129
130
131
132
};

extern int
register_ftrace_function_hook(char *glob, struct ftrace_hook_ops *ops,
			      void *data);
extern void
unregister_ftrace_function_hook(char *glob, struct ftrace_hook_ops *ops,
				void *data);
extern void
unregister_ftrace_function_hook_func(char *glob, struct ftrace_hook_ops *ops);
extern void unregister_ftrace_function_hook_all(char *glob);

133
enum {
134
135
136
137
	FTRACE_FL_FREE		= (1 << 0),
	FTRACE_FL_FAILED	= (1 << 1),
	FTRACE_FL_FILTER	= (1 << 2),
	FTRACE_FL_ENABLED	= (1 << 3),
138
	FTRACE_FL_NOTRACE	= (1 << 4),
139
	FTRACE_FL_CONVERTED	= (1 << 5),
140
	FTRACE_FL_FROZEN	= (1 << 6),
141
142
};

143
struct dyn_ftrace {
Steven Rostedt's avatar
Steven Rostedt committed
144
145
146
	struct list_head	list;
	unsigned long		ip; /* address of mcount call-site */
	unsigned long		flags;
147
	struct dyn_arch_ftrace	arch;
148
149
};

Steven Rostedt's avatar
Steven Rostedt committed
150
int ftrace_force_update(void);
151
void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedt's avatar
Steven Rostedt committed
152

153
154
155
int register_ftrace_command(struct ftrace_func_command *cmd);
int unregister_ftrace_command(struct ftrace_func_command *cmd);

156
/* defined in arch */
157
extern int ftrace_ip_converted(unsigned long ip);
158
159
160
161
162
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);
163
164
165
166

#ifndef FTRACE_ADDR
#define FTRACE_ADDR ((unsigned long)ftrace_caller)
#endif
167
168
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
169
170
171
172
173
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; }
174
#endif
175

176
/**
177
 * ftrace_make_nop - convert code into nop
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 * @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);
199

200
/**
201
202
203
 * 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
204
205
206
207
208
209
210
 *
 * 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.
 *
211
212
 * The code segment at @rec->ip should be a nop
 *
213
214
215
216
217
218
219
 * 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.
 */
220
221
222
223
224
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);
225

226
227
extern int skip_trace(unsigned long ip);

228
229
230
231
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
232
#else
233
# define skip_trace(ip)				({ 0; })
Ingo Molnar's avatar
Ingo Molnar committed
234
235
# define ftrace_force_update()			({ 0; })
# define ftrace_set_filter(buf, len, reset)	do { } while (0)
236
237
# define ftrace_disable_daemon()		do { } while (0)
# define ftrace_enable_daemon()			do { } while (0)
238
static inline void ftrace_release(void *start, unsigned long size) { }
239
240
static inline int register_ftrace_command(struct ftrace_func_command *cmd)
{
241
	return -EINVAL;
242
243
244
}
static inline int unregister_ftrace_command(char *cmd_name)
{
245
	return -EINVAL;
246
}
247
#endif /* CONFIG_DYNAMIC_FTRACE */
248

Ingo Molnar's avatar
Ingo Molnar committed
249
250
251
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

Ingo Molnar's avatar
Ingo Molnar committed
252
253
static inline void tracer_disable(void)
{
254
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
255
256
257
258
	ftrace_enabled = 0;
#endif
}

259
260
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
261
 * must be used to prevent ftrace_enabled to be changed between
262
263
 * disable/restore.
 */
264
265
static inline int __ftrace_enabled_save(void)
{
266
#ifdef CONFIG_FUNCTION_TRACER
267
268
269
270
271
272
273
274
275
276
	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)
{
277
#ifdef CONFIG_FUNCTION_TRACER
278
279
280
281
	ftrace_enabled = enabled;
#endif
}

282
283
284
285
286
287
288
289
#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
290
# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
291
292
293
294
295
296
297
#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
298
# define CALLER_ADDR6 0UL
299
300
#endif

301
#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
302
303
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
304
305
306
307
308
#else
# define time_hardirqs_on(a0, a1)		do { } while (0)
# define time_hardirqs_off(a0, a1)		do { } while (0)
#endif

309
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
310
311
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
312
313
314
315
316
#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
317
#ifdef CONFIG_TRACING
318
319
extern int ftrace_dump_on_oops;

320
321
extern void tracing_start(void);
extern void tracing_stop(void);
322
extern void ftrace_off_permanent(void);
323

Ingo Molnar's avatar
Ingo Molnar committed
324
325
extern void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343

/**
 * 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)
344
345
346
extern int
__ftrace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
347
348
349
# define ftrace_vprintk(fmt, ap) __ftrace_printk(_THIS_IP_, fmt, ap)
extern int
__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
350
extern void ftrace_dump(void);
Ingo Molnar's avatar
Ingo Molnar committed
351
352
353
#else
static inline void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
354
static inline int
355
ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
Ingo Molnar's avatar
Ingo Molnar committed
356

357
358
static inline void tracing_start(void) { }
static inline void tracing_stop(void) { }
359
static inline void ftrace_off_permanent(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
360
361
static inline int
ftrace_printk(const char *fmt, ...)
362
363
364
{
	return 0;
}
365
366
367
368
369
static inline int
ftrace_vprintk(const char *fmt, va_list ap)
{
	return 0;
}
370
static inline void ftrace_dump(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
371
372
#endif

373
374
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
375
376
extern void ftrace_init_module(struct module *mod,
			       unsigned long *start, unsigned long *end);
377
378
#else
static inline void ftrace_init(void) { }
379
static inline void
380
381
ftrace_init_module(struct module *mod,
		   unsigned long *start, unsigned long *end) { }
382
383
#endif

384
385
386
387
388
389
390
/*
 * Structure that defines an entry function trace.
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
};
391

392
393
394
/*
 * Structure that defines a return function trace.
 */
395
struct ftrace_graph_ret {
396
397
398
	unsigned long func; /* Current function */
	unsigned long long calltime;
	unsigned long long rettime;
399
400
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
401
	int depth;
402
403
};

404
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
405
406
407
408
409
410
411
412

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

413
414
415
416
417
418
419
420
421
422
/*
 * 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[];

423
424
#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
425
426
/* Type of the callback handlers for tracing function graph*/
typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
427
typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
428
429
430
431

extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

432
433
extern void ftrace_graph_stop(void);

434
435
436
/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;
437

438
extern void unregister_ftrace_graph(void);
439

440
441
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
442
443
444
445
446

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}
447
448
449
450
451
452
453
454
455
456

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);
}
457
#else
458
459

#define __notrace_funcgraph
460
#define __irq_entry
461

462
463
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
464
465
466
467
468

static inline int task_curr_ret_stack(struct task_struct *tsk)
{
	return -1;
}
469
470
471

static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
472
473
#endif

474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
#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 */

519
520
521
522
523
524
525
526
527
528
529
530
531

#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 */

532
#endif /* _LINUX_FTRACE_H */