ftrace.h 14.2 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
enum {
110
111
112
113
	FTRACE_FL_FREE		= (1 << 0),
	FTRACE_FL_FAILED	= (1 << 1),
	FTRACE_FL_FILTER	= (1 << 2),
	FTRACE_FL_ENABLED	= (1 << 3),
114
	FTRACE_FL_NOTRACE	= (1 << 4),
115
	FTRACE_FL_CONVERTED	= (1 << 5),
116
	FTRACE_FL_FROZEN	= (1 << 6),
117
118
};

119
struct dyn_ftrace {
Steven Rostedt's avatar
Steven Rostedt committed
120
121
122
	struct list_head	list;
	unsigned long		ip; /* address of mcount call-site */
	unsigned long		flags;
123
	struct dyn_arch_ftrace	arch;
124
125
};

Steven Rostedt's avatar
Steven Rostedt committed
126
int ftrace_force_update(void);
127
void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedt's avatar
Steven Rostedt committed
128

129
130
131
int register_ftrace_command(struct ftrace_func_command *cmd);
int unregister_ftrace_command(struct ftrace_func_command *cmd);

132
/* defined in arch */
133
extern int ftrace_ip_converted(unsigned long ip);
134
135
136
137
138
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);
139
140
141
142

#ifndef FTRACE_ADDR
#define FTRACE_ADDR ((unsigned long)ftrace_caller)
#endif
143
144
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
145
146
147
148
149
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; }
150
#endif
151

152
/**
153
 * ftrace_make_nop - convert code into nop
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 * @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);
175

176
/**
177
178
179
 * 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
180
181
182
183
184
185
186
 *
 * 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.
 *
187
188
 * The code segment at @rec->ip should be a nop
 *
189
190
191
192
193
194
195
 * 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.
 */
196
197
198
199
200
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);
201

202
203
extern int skip_trace(unsigned long ip);

204
205
206
207
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
208
#else
209
# define skip_trace(ip)				({ 0; })
Ingo Molnar's avatar
Ingo Molnar committed
210
211
# define ftrace_force_update()			({ 0; })
# define ftrace_set_filter(buf, len, reset)	do { } while (0)
212
213
# define ftrace_disable_daemon()		do { } while (0)
# define ftrace_enable_daemon()			do { } while (0)
214
static inline void ftrace_release(void *start, unsigned long size) { }
215
216
217
218
219
220
static inline int register_ftrace_command(struct ftrace_func_command *cmd)
{
}
static inline int unregister_ftrace_command(char *cmd_name)
{
}
221
#endif /* CONFIG_DYNAMIC_FTRACE */
222

Ingo Molnar's avatar
Ingo Molnar committed
223
224
225
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

Ingo Molnar's avatar
Ingo Molnar committed
226
227
static inline void tracer_disable(void)
{
228
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
229
230
231
232
	ftrace_enabled = 0;
#endif
}

233
234
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
235
 * must be used to prevent ftrace_enabled to be changed between
236
237
 * disable/restore.
 */
238
239
static inline int __ftrace_enabled_save(void)
{
240
#ifdef CONFIG_FUNCTION_TRACER
241
242
243
244
245
246
247
248
249
250
	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)
{
251
#ifdef CONFIG_FUNCTION_TRACER
252
253
254
255
	ftrace_enabled = enabled;
#endif
}

256
257
258
259
260
261
262
263
#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
264
# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
265
266
267
268
269
270
271
#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
272
# define CALLER_ADDR6 0UL
273
274
#endif

275
#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
276
277
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
278
279
280
281
282
#else
# define time_hardirqs_on(a0, a1)		do { } while (0)
# define time_hardirqs_off(a0, a1)		do { } while (0)
#endif

283
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
284
285
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
286
287
288
289
290
#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
291
#ifdef CONFIG_TRACING
292
293
extern int ftrace_dump_on_oops;

294
295
extern void tracing_start(void);
extern void tracing_stop(void);
296
extern void ftrace_off_permanent(void);
297

Ingo Molnar's avatar
Ingo Molnar committed
298
299
extern void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317

/**
 * 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)
318
319
320
extern int
__ftrace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
321
322
323
# define ftrace_vprintk(fmt, ap) __ftrace_printk(_THIS_IP_, fmt, ap)
extern int
__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
324
extern void ftrace_dump(void);
Ingo Molnar's avatar
Ingo Molnar committed
325
326
327
#else
static inline void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
328
static inline int
329
ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
Ingo Molnar's avatar
Ingo Molnar committed
330

331
332
static inline void tracing_start(void) { }
static inline void tracing_stop(void) { }
333
static inline void ftrace_off_permanent(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
334
335
static inline int
ftrace_printk(const char *fmt, ...)
336
337
338
{
	return 0;
}
339
340
341
342
343
static inline int
ftrace_vprintk(const char *fmt, va_list ap)
{
	return 0;
}
344
static inline void ftrace_dump(void) { }
Ingo Molnar's avatar
Ingo Molnar committed
345
346
#endif

347
348
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
349
350
extern void ftrace_init_module(struct module *mod,
			       unsigned long *start, unsigned long *end);
351
352
#else
static inline void ftrace_init(void) { }
353
static inline void
354
355
ftrace_init_module(struct module *mod,
		   unsigned long *start, unsigned long *end) { }
356
357
#endif

358
359
360
361
362
363
364
/*
 * Structure that defines an entry function trace.
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
};
365

366
367
368
/*
 * Structure that defines a return function trace.
 */
369
struct ftrace_graph_ret {
370
371
372
	unsigned long func; /* Current function */
	unsigned long long calltime;
	unsigned long long rettime;
373
374
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
375
	int depth;
376
377
};

378
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
379
380
381
382
383
384
385
386

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

387
388
389
390
391
392
393
394
395
396
/*
 * 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[];

397
398
#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
399
400
/* Type of the callback handlers for tracing function graph*/
typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
401
typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
402
403
404
405

extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

406
407
extern void ftrace_graph_stop(void);

408
409
410
/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;
411

412
extern void unregister_ftrace_graph(void);
413

414
415
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
416
417
418
419
420

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}
421
422
423
424
425
426
427
428
429
430

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);
}
431
#else
432
433

#define __notrace_funcgraph
434
#define __irq_entry
435

436
437
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
438
439
440
441
442

static inline int task_curr_ret_stack(struct task_struct *tsk)
{
	return -1;
}
443
444
445

static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
446
447
#endif

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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
#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 */

493
494
495
496
497
498
499
500
501
502
503
504
505

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

506
#endif /* _LINUX_FTRACE_H */