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
#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
struct seq_file;

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

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

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

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

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

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

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

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

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

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

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

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

262
263
extern int skip_trace(unsigned long ip);

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

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

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

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

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

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

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

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

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

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

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

388
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
389

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

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

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

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

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

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

439
440
extern void ftrace_graph_stop(void);

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

445
extern void unregister_ftrace_graph(void);
446

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

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

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

#define __notrace_funcgraph
468
#define __irq_entry
469
#define INIT_FTRACE_GRAPH
470

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

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

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

static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
489
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
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
532
#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;
}

533
534
535
enum ftrace_dump_mode;

extern enum ftrace_dump_mode ftrace_dump_on_oops;
536

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

541
542
#endif /* CONFIG_TRACING */

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

547
548
549
550
551
552
#ifdef CONFIG_FTRACE_SYSCALLS

unsigned long arch_syscall_addr(int nr);

#endif /* CONFIG_FTRACE_SYSCALLS */

553
#endif /* _LINUX_FTRACE_H */