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

4
#include <linux/trace_clock.h>
5
#include <linux/kallsyms.h>
6
#include <linux/linkage.h>
7
#include <linux/bitops.h>
8
9
#include <linux/module.h>
#include <linux/ktime.h>
10
#include <linux/sched.h>
11
12
13
#include <linux/types.h>
#include <linux/init.h>
#include <linux/fs.h>
14

15
16
#include <asm/ftrace.h>

17
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
18

19
20
21
22
23
24
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);

25
26
27
28
29
30
31
typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);

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

32
33
extern int function_trace_stop;

34
35
36
37
38
39
40
41
42
43
44
/*
 * 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;

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

71
72
73
74
75
76
77
78
79
80
81
82
83
/*
 * 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);

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

93
94
95
96
97
98
99
100
#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

101
102
103
104
105
106
107
struct ftrace_func_command {
	struct list_head	list;
	char			*name;
	int			(*func)(char *func, char *cmd,
					char *params, int enable);
};

108
#ifdef CONFIG_DYNAMIC_FTRACE
109

110
111
112
int ftrace_arch_code_modify_prepare(void);
int ftrace_arch_code_modify_post_process(void);

113
114
struct seq_file;

115
struct ftrace_probe_ops {
116
117
118
119
120
	void			(*func)(unsigned long ip,
					unsigned long parent_ip,
					void **data);
	int			(*callback)(unsigned long ip, void **data);
	void			(*free)(void **data);
121
122
	int			(*print)(struct seq_file *m,
					 unsigned long ip,
123
					 struct ftrace_probe_ops *ops,
124
					 void *data);
125
126
127
};

extern int
128
register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
129
130
			      void *data);
extern void
131
unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
132
133
				void *data);
extern void
134
135
unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
extern void unregister_ftrace_function_probe_all(char *glob);
136

137
enum {
138
139
140
141
	FTRACE_FL_FREE		= (1 << 0),
	FTRACE_FL_FAILED	= (1 << 1),
	FTRACE_FL_FILTER	= (1 << 2),
	FTRACE_FL_ENABLED	= (1 << 3),
142
	FTRACE_FL_NOTRACE	= (1 << 4),
143
	FTRACE_FL_CONVERTED	= (1 << 5),
144
	FTRACE_FL_FROZEN	= (1 << 6),
145
146
};

147
struct dyn_ftrace {
Steven Rostedt's avatar
Steven Rostedt committed
148
149
	unsigned long		ip; /* address of mcount call-site */
	unsigned long		flags;
150
	struct dyn_arch_ftrace	arch;
151
152
};

Steven Rostedt's avatar
Steven Rostedt committed
153
int ftrace_force_update(void);
154
void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedt's avatar
Steven Rostedt committed
155

156
157
158
int register_ftrace_command(struct ftrace_func_command *cmd);
int unregister_ftrace_command(struct ftrace_func_command *cmd);

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

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

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

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

228
229
extern int skip_trace(unsigned long ip);

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

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

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

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

284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
#ifndef HAVE_ARCH_CALLER_ADDR
# ifdef CONFIG_FRAME_POINTER
#  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))
#  define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
# 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
#  define CALLER_ADDR6 0UL
# endif
#endif /* ifndef HAVE_ARCH_CALLER_ADDR */
303

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

312
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
313
314
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
315
316
317
318
319
#else
# define trace_preempt_on(a0, a1)		do { } while (0)
# define trace_preempt_off(a0, a1)		do { } while (0)
#endif

320
321
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
322
323
extern void ftrace_init_module(struct module *mod,
			       unsigned long *start, unsigned long *end);
324
325
#else
static inline void ftrace_init(void) { }
326
static inline void
327
328
ftrace_init_module(struct module *mod,
		   unsigned long *start, unsigned long *end) { }
329
330
#endif

331
332
333
334
335
336
337
/*
 * Structure that defines an entry function trace.
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
};
338

339
340
341
/*
 * Structure that defines a return function trace.
 */
342
struct ftrace_graph_ret {
343
344
345
	unsigned long func; /* Current function */
	unsigned long long calltime;
	unsigned long long rettime;
346
347
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
348
	int depth;
349
350
};

351
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
352

353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/*
 * Stack of return addresses for functions
 * of a thread.
 * Used in struct thread_info
 */
struct ftrace_ret_stack {
	unsigned long ret;
	unsigned long func;
	unsigned long long calltime;
};

/*
 * Primary handler of a function return.
 * It relays on ftrace_return_to_handler.
 * Defined in entry_32/64.S
 */
extern void return_to_handler(void);

extern int
372
ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth);
373
374
375
extern void
ftrace_pop_return_trace(struct ftrace_graph_ret *trace, unsigned long *ret);

376
377
378
379
380
381
382
/*
 * 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

383
384
385
386
387
388
389
390
391
392
/*
 * 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[];

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

extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

402
403
extern void ftrace_graph_stop(void);

404
405
406
/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;
407

408
extern void unregister_ftrace_graph(void);
409

410
411
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
412
413
414
415
416

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}
417
418
419
420
421
422
423
424
425
426

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);
}
427
#else
428
429

#define __notrace_funcgraph
430
#define __irq_entry
431

432
433
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
434
435
436
437
438

static inline int task_curr_ret_stack(struct task_struct *tsk)
{
	return -1;
}
439
440
441

static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
442
443
#endif

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
477
478
479
480
481
482
483
484
485
486
#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;
}

487
488
extern int ftrace_dump_on_oops;

489
490
#endif /* CONFIG_TRACING */

491
492
493
494
495
496
497
498
499
500
501
502
503

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

504
505
506
/*
 * A syscall entry in the ftrace syscalls array.
 *
507
508
509
510
 * @name: name of the syscall
 * @nb_args: number of parameters it takes
 * @types: list of types as strings
 * @args: list of args as strings (args[i] matches types[i])
511
 */
512
513
514
515
516
struct syscall_metadata {
	const char	*name;
	int		nb_args;
	const char	**types;
	const char	**args;
517
518
519
};

#ifdef CONFIG_FTRACE_SYSCALLS
520
521
extern void arch_init_ftrace_syscalls(void);
extern struct syscall_metadata *syscall_nr_to_meta(int nr);
522
523
524
525
526
527
528
529
530
531
532
extern void start_ftrace_syscalls(void);
extern void stop_ftrace_syscalls(void);
extern void ftrace_syscall_enter(struct pt_regs *regs);
extern void ftrace_syscall_exit(struct pt_regs *regs);
#else
static inline void start_ftrace_syscalls(void) { }
static inline void stop_ftrace_syscalls(void) { }
static inline void ftrace_syscall_enter(struct pt_regs *regs) { }
static inline void ftrace_syscall_exit(struct pt_regs *regs) { }
#endif

533
#endif /* _LINUX_FTRACE_H */