ftrace.h 15.1 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
14
#include <linux/module.h>
#include <linux/ktime.h>
15
#include <linux/sched.h>
16
17
18
#include <linux/types.h>
#include <linux/init.h>
#include <linux/fs.h>
19

20
21
#include <asm/ftrace.h>

22
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
23

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

30
31
typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);

32
33
struct ftrace_hash;

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
126
127
128
129
struct ftrace_func_command {
	struct list_head	list;
	char			*name;
	int			(*func)(char *func, char *cmd,
					char *params, int enable);
};

130
#ifdef CONFIG_DYNAMIC_FTRACE
131

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

135
136
struct seq_file;

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

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

159
160
extern int ftrace_text_reserved(void *start, void *end);

161
enum {
162
163
	FTRACE_FL_ENABLED	= (1 << 30),
	FTRACE_FL_FREE		= (1 << 31),
164
165
};

166
167
168
#define FTRACE_FL_MASK		(0x3UL << 30)
#define FTRACE_REF_MAX		((1 << 30) - 1)

169
struct dyn_ftrace {
170
171
172
173
174
175
176
177
178
	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;
179
180
};

Steven Rostedt's avatar
Steven Rostedt committed
181
int ftrace_force_update(void);
182
183
184
185
186
187
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
188

189
190
191
int register_ftrace_command(struct ftrace_func_command *cmd);
int unregister_ftrace_command(struct ftrace_func_command *cmd);

192
/* defined in arch */
193
extern int ftrace_ip_converted(unsigned long ip);
194
195
196
197
198
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);
199
200
201
202

#ifndef FTRACE_ADDR
#define FTRACE_ADDR ((unsigned long)ftrace_caller)
#endif
203
204
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
205
206
207
208
209
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; }
210
#endif
211

212
/**
213
 * ftrace_make_nop - convert code into nop
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 * @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);
235

236
/**
237
238
239
 * 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
240
241
242
243
244
245
246
 *
 * 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.
 *
247
248
 * The code segment at @rec->ip should be a nop
 *
249
250
251
252
253
254
255
 * 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.
 */
256
257
258
259
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);
260

261
262
extern int skip_trace(unsigned long ip);

263
264
extern void ftrace_disable_daemon(void);
extern void ftrace_enable_daemon(void);
Steven Rostedt's avatar
Steven Rostedt committed
265
#else
266
267
268
269
270
271
272
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) { }
273
static inline void ftrace_release_mod(struct module *mod) {}
274
275
static inline int register_ftrace_command(struct ftrace_func_command *cmd)
{
276
	return -EINVAL;
277
278
279
}
static inline int unregister_ftrace_command(char *cmd_name)
{
280
	return -EINVAL;
281
}
282
283
284
285
static inline int ftrace_text_reserved(void *start, void *end)
{
	return 0;
}
286
#endif /* CONFIG_DYNAMIC_FTRACE */
287

Ingo Molnar's avatar
Ingo Molnar committed
288
289
290
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

Ingo Molnar's avatar
Ingo Molnar committed
291
292
static inline void tracer_disable(void)
{
293
#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
294
295
296
297
	ftrace_enabled = 0;
#endif
}

298
299
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
300
 * must be used to prevent ftrace_enabled to be changed between
301
302
 * disable/restore.
 */
303
304
static inline int __ftrace_enabled_save(void)
{
305
#ifdef CONFIG_FUNCTION_TRACER
306
307
308
309
310
311
312
313
314
315
	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)
{
316
#ifdef CONFIG_FUNCTION_TRACER
317
318
319
320
	ftrace_enabled = enabled;
#endif
}

321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
#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 */
340

341
#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
342
343
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
344
#else
345
346
  static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
  static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
347
348
#endif

349
#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar's avatar
Ingo Molnar committed
350
351
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
352
#else
353
354
  static inline void trace_preempt_on(unsigned long a0, unsigned long a1) { }
  static inline void trace_preempt_off(unsigned long a0, unsigned long a1) { }
355
356
#endif

357
358
359
360
361
362
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
#else
static inline void ftrace_init(void) { }
#endif

363
364
365
366
367
368
369
/*
 * Structure that defines an entry function trace.
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
};
370

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

383
384
385
386
/* 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 */

387
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
388

389
/* for init task */
390
#define INIT_FTRACE_GRAPH		.ret_stack = NULL,
391

392
393
394
395
396
397
398
399
400
/*
 * 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;
401
	unsigned long long subtime;
402
	unsigned long fp;
403
404
405
406
407
408
409
410
411
412
};

/*
 * 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
413
414
ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
			 unsigned long frame_pointer);
415

416
417
418
419
420
421
422
/*
 * 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

423
424
425
426
427
428
429
430
431
432
/*
 * 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[];

433
434
#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
435
436
437
extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

438
439
extern void ftrace_graph_stop(void);

440
441
442
/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;
443

444
extern void unregister_ftrace_graph(void);
445

446
447
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
448
extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
449
450
451
452
453

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}
454
455
456
457
458
459
460
461
462
463

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);
}
464
#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
465
466

#define __notrace_funcgraph
467
#define __irq_entry
468
#define INIT_FTRACE_GRAPH
469

470
471
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
472
static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
473

474
475
476
477
478
479
480
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) { }

481
482
483
484
static inline int task_curr_ret_stack(struct task_struct *tsk)
{
	return -1;
}
485
486
487

static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
488
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
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
519
520
521
522
523
524
525
526
527
528
529
530
531
#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;
}

532
533
534
enum ftrace_dump_mode;

extern enum ftrace_dump_mode ftrace_dump_on_oops;
535

536
537
538
539
#ifdef CONFIG_PREEMPT
#define INIT_TRACE_RECURSION		.trace_recursion = 0,
#endif

540
541
#endif /* CONFIG_TRACING */

542
543
544
#ifndef INIT_TRACE_RECURSION
#define INIT_TRACE_RECURSION
#endif
545

546
547
548
549
550
551
#ifdef CONFIG_FTRACE_SYSCALLS

unsigned long arch_syscall_addr(int nr);

#endif /* CONFIG_FTRACE_SYSCALLS */

552
#endif /* _LINUX_FTRACE_H */