ftrace.h 15.9 KB
Newer Older
1
2
3
4
5
/*
 * Ftrace header.  For implementation details beyond the random comments
 * scattered below, see: Documentation/trace/ftrace-design.txt
 */

6
7
8
#ifndef _LINUX_FTRACE_H
#define _LINUX_FTRACE_H

9
#include <linux/trace_clock.h>
10
#include <linux/kallsyms.h>
11
#include <linux/linkage.h>
12
#include <linux/bitops.h>
13
#include <linux/ktime.h>
14
#include <linux/sched.h>
15
16
17
#include <linux/types.h>
#include <linux/init.h>
#include <linux/fs.h>
18

19
20
#include <asm/ftrace.h>

21
struct module;
22
23
struct ftrace_hash;

24
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
25

26
27
28
extern int ftrace_enabled;
extern int
ftrace_enable_sysctl(struct ctl_table *table, int write,
29
		     void __user *buffer, size_t *lenp,
30
31
		     loff_t *ppos);

32
33
typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);

34
35
36
enum {
	FTRACE_OPS_FL_ENABLED		= 1 << 0,
	FTRACE_OPS_FL_GLOBAL		= 1 << 1,
37
	FTRACE_OPS_FL_DYNAMIC		= 1 << 2,
38
39
};

40
struct ftrace_ops {
41
42
	ftrace_func_t			func;
	struct ftrace_ops		*next;
43
	unsigned long			flags;
44
45
46
47
#ifdef CONFIG_DYNAMIC_FTRACE
	struct ftrace_hash		*notrace_hash;
	struct ftrace_hash		*filter_hash;
#endif
48
49
};

50
51
extern int function_trace_stop;

52
53
54
55
56
57
58
59
60
61
62
/*
 * 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;

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/**
 * 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;
}

89
90
91
92
93
94
95
96
97
98
99
100
101
/*
 * 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);

102
#else /* !CONFIG_FUNCTION_TRACER */
103
104
105
106
107
108
109
/*
 * (un)register_ftrace_function must be a macro since the ops parameter
 * must not be evaluated.
 */
#define register_ftrace_function(ops) ({ 0; })
#define unregister_ftrace_function(ops) ({ 0; })
static inline void clear_ftrace_function(void) { }
110
static inline void ftrace_kill(void) { }
111
112
static inline void ftrace_stop(void) { }
static inline void ftrace_start(void) { }
113
#endif /* CONFIG_FUNCTION_TRACER */
114

115
116
117
118
#ifdef CONFIG_STACK_TRACER
extern int stack_tracer_enabled;
int
stack_trace_sysctl(struct ctl_table *table, int write,
119
		   void __user *buffer, size_t *lenp,
120
121
122
		   loff_t *ppos);
#endif

123
124
125
struct ftrace_func_command {
	struct list_head	list;
	char			*name;
126
127
	int			(*func)(struct ftrace_hash *hash,
					char *func, char *cmd,
128
129
130
					char *params, int enable);
};

131
#ifdef CONFIG_DYNAMIC_FTRACE
132

133
134
135
int ftrace_arch_code_modify_prepare(void);
int ftrace_arch_code_modify_post_process(void);

136
137
void ftrace_bug(int err, unsigned long ip);

138
139
struct seq_file;

140
struct ftrace_probe_ops {
141
142
143
144
145
	void			(*func)(unsigned long ip,
					unsigned long parent_ip,
					void **data);
	int			(*callback)(unsigned long ip, void **data);
	void			(*free)(void **data);
146
147
	int			(*print)(struct seq_file *m,
					 unsigned long ip,
148
					 struct ftrace_probe_ops *ops,
149
					 void *data);
150
151
152
};

extern int
153
register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
154
155
			      void *data);
extern void
156
unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
157
158
				void *data);
extern void
159
160
unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
extern void unregister_ftrace_function_probe_all(char *glob);
161

162
163
extern int ftrace_text_reserved(void *start, void *end);

164
enum {
165
	FTRACE_FL_ENABLED	= (1 << 30),
166
167
};

168
169
170
#define FTRACE_FL_MASK		(0x3UL << 30)
#define FTRACE_REF_MAX		((1 << 30) - 1)

171
struct dyn_ftrace {
172
173
174
175
176
177
178
179
180
	union {
		unsigned long		ip; /* address of mcount call-site */
		struct dyn_ftrace	*freelist;
	};
	union {
		unsigned long		flags;
		struct dyn_ftrace	*newlist;
	};
	struct dyn_arch_ftrace		arch;
181
182
};

Steven Rostedt's avatar
Steven Rostedt committed
183
int ftrace_force_update(void);
184
185
186
187
188
189
void ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
		       int len, int reset);
void ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
			int len, int reset);
void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
Steven Rostedt's avatar
Steven Rostedt committed
190

191
192
193
int register_ftrace_command(struct ftrace_func_command *cmd);
int unregister_ftrace_command(struct ftrace_func_command *cmd);

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
enum {
	FTRACE_UPDATE_CALLS		= (1 << 0),
	FTRACE_DISABLE_CALLS		= (1 << 1),
	FTRACE_UPDATE_TRACE_FUNC	= (1 << 2),
	FTRACE_START_FUNC_RET		= (1 << 3),
	FTRACE_STOP_FUNC_RET		= (1 << 4),
};

enum {
	FTRACE_UPDATE_IGNORE,
	FTRACE_UPDATE_MAKE_CALL,
	FTRACE_UPDATE_MAKE_NOP,
};

void arch_ftrace_update_code(int command);

struct ftrace_rec_iter;

struct ftrace_rec_iter *ftrace_rec_iter_start(void);
struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter);
struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter);

int ftrace_update_record(struct dyn_ftrace *rec, int enable);
int ftrace_test_record(struct dyn_ftrace *rec, int enable);
void ftrace_run_stop_machine(int command);
int ftrace_location(unsigned long ip);

extern ftrace_func_t ftrace_trace_function;

223
/* defined in arch */
224
extern int ftrace_ip_converted(unsigned long ip);
225
226
227
228
229
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);
230
231
232
233

#ifndef FTRACE_ADDR
#define FTRACE_ADDR ((unsigned long)ftrace_caller)
#endif
234
235
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
236
237
238
239
240
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; }
241
#endif
242

243
/**
244
 * ftrace_make_nop - convert code into nop
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 * @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);
266

267
/**
268
269
270
 * 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
271
272
273
274
275
276
277
 *
 * 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.
 *
278
279
 * The code segment at @rec->ip should be a nop
 *
280
281
282
283
284
285
286
 * 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.
 */
287
288
289
290
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);
291

292
293
extern int skip_trace(unsigned long ip);

294
295
extern void ftrace_disable_daemon(void);
extern void ftrace_enable_daemon(void);
Steven Rostedt's avatar
Steven Rostedt committed
296
#else
297
298
299
300
301
302
303
static inline int skip_trace(unsigned long ip) { return 0; }
static inline int ftrace_force_update(void) { return 0; }
static inline void ftrace_set_filter(unsigned char *buf, int len, int reset)
{
}
static inline void ftrace_disable_daemon(void) { }
static inline void ftrace_enable_daemon(void) { }
304
static inline void ftrace_release_mod(struct module *mod) {}
305
306
static inline int register_ftrace_command(struct ftrace_func_command *cmd)
{
307
	return -EINVAL;
308
309
310
}
static inline int unregister_ftrace_command(char *cmd_name)
{
311
	return -EINVAL;
312
}
313
314
315
316
static inline int ftrace_text_reserved(void *start, void *end)
{
	return 0;
}
317
#endif /* CONFIG_DYNAMIC_FTRACE */
318

Ingo Molnar's avatar
Ingo Molnar committed
319
320
321
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

Ingo Molnar's avatar
Ingo Molnar committed
322
323
static inline void tracer_disable(void)
{
324
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
325
326
327
328
	ftrace_enabled = 0;
#endif
}

329
330
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
331
 * must be used to prevent ftrace_enabled to be changed between
332
333
 * disable/restore.
 */
334
335
static inline int __ftrace_enabled_save(void)
{
336
#ifdef CONFIG_FUNCTION_TRACER
337
338
339
340
341
342
343
344
345
346
	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)
{
347
#ifdef CONFIG_FUNCTION_TRACER
348
349
350
351
	ftrace_enabled = enabled;
#endif
}

352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
#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 */
371

372
#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
373
374
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
375
#else
376
377
  static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
  static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
378
379
#endif

380
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
381
382
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
383
#else
384
385
  static inline void trace_preempt_on(unsigned long a0, unsigned long a1) { }
  static inline void trace_preempt_off(unsigned long a0, unsigned long a1) { }
386
387
#endif

388
389
390
391
392
393
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
#else
static inline void ftrace_init(void) { }
#endif

394
395
396
397
398
399
400
/*
 * Structure that defines an entry function trace.
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
};
401

402
403
404
/*
 * Structure that defines a return function trace.
 */
405
struct ftrace_graph_ret {
406
407
408
	unsigned long func; /* Current function */
	unsigned long long calltime;
	unsigned long long rettime;
409
410
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
411
	int depth;
412
413
};

414
415
416
417
/* Type of the callback handlers for tracing function graph*/
typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */

418
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
419

420
/* for init task */
421
#define INIT_FTRACE_GRAPH		.ret_stack = NULL,
422

423
424
425
426
427
428
429
430
431
/*
 * 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;
432
	unsigned long long subtime;
433
	unsigned long fp;
434
435
436
437
438
439
440
441
442
443
};

/*
 * 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
444
445
ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
			 unsigned long frame_pointer);
446

447
448
449
450
451
452
453
/*
 * 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

454
455
456
457
458
459
460
461
462
463
/*
 * 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[];

464
465
#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
466
467
468
extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

469
470
extern void ftrace_graph_stop(void);

471
472
473
/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;
474

475
extern void unregister_ftrace_graph(void);
476

477
478
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
479
extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
480
481
482
483
484

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}
485
486
487
488
489
490
491
492
493
494

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);
}
495
#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
496
497

#define __notrace_funcgraph
498
#define __irq_entry
499
#define INIT_FTRACE_GRAPH
500

501
502
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
503
static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
504

505
506
507
508
509
510
511
static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
			  trace_func_graph_ent_t entryfunc)
{
	return -1;
}
static inline void unregister_ftrace_graph(void) { }

512
513
514
515
static inline int task_curr_ret_stack(struct task_struct *tsk)
{
	return -1;
}
516
517
518

static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
519
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
520

521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
#ifdef CONFIG_TRACING

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

563
564
565
enum ftrace_dump_mode;

extern enum ftrace_dump_mode ftrace_dump_on_oops;
566

567
568
569
570
#ifdef CONFIG_PREEMPT
#define INIT_TRACE_RECURSION		.trace_recursion = 0,
#endif

571
572
#endif /* CONFIG_TRACING */

573
574
575
#ifndef INIT_TRACE_RECURSION
#define INIT_TRACE_RECURSION
#endif
576

577
578
579
580
581
582
#ifdef CONFIG_FTRACE_SYSCALLS

unsigned long arch_syscall_addr(int nr);

#endif /* CONFIG_FTRACE_SYSCALLS */

583
#endif /* _LINUX_FTRACE_H */