ftrace.h 30.5 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/ptrace.h>
14
#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 23 24 25 26 27 28 29 30
/*
 * If the arch supports passing the variable contents of
 * function_trace_op as the third parameter back from the
 * mcount call, then the arch should define this as 1.
 */
#ifndef ARCH_SUPPORTS_FTRACE_OPS
#define ARCH_SUPPORTS_FTRACE_OPS 0
#endif

31 32 33 34 35
/*
 * If the arch's mcount caller does not support all of ftrace's
 * features, then it must call an indirect function that
 * does. Or at least does enough to prevent any unwelcomed side effects.
 */
36
#if !ARCH_SUPPORTS_FTRACE_OPS
37 38 39 40 41
# define FTRACE_FORCE_LIST_FUNC 1
#else
# define FTRACE_FORCE_LIST_FUNC 0
#endif

42 43 44
/* Main tracing buffer and events set up */
#ifdef CONFIG_TRACING
void trace_init(void);
45
void early_trace_init(void);
46 47
#else
static inline void trace_init(void) { }
48
static inline void early_trace_init(void) { }
49
#endif
50

51
struct module;
52 53
struct ftrace_hash;

54
#ifdef CONFIG_FUNCTION_TRACER
I
Ingo Molnar 已提交
55

56 57 58
extern int ftrace_enabled;
extern int
ftrace_enable_sysctl(struct ctl_table *table, int write,
59
		     void __user *buffer, size_t *lenp,
60 61
		     loff_t *ppos);

62 63 64
struct ftrace_ops;

typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip,
65
			      struct ftrace_ops *op, struct pt_regs *regs);
66

67 68
ftrace_func_t ftrace_ops_get_func(struct ftrace_ops *ops);

69 70 71
/*
 * FTRACE_OPS_FL_* bits denote the state of ftrace_ops struct and are
 * set in the flags member.
72 73 74 75 76
 * CONTROL, SAVE_REGS, SAVE_REGS_IF_SUPPORTED, RECURSION_SAFE, STUB and
 * IPMODIFY are a kind of attribute flags which can be set only before
 * registering the ftrace_ops, and can not be modified while registered.
 * Changing those attribute flags after regsitering ftrace_ops will
 * cause unexpected results.
77 78 79 80
 *
 * ENABLED - set/unset when ftrace_ops is registered/unregistered
 * DYNAMIC - set when ftrace_ops is registered to denote dynamically
 *           allocated ftrace_ops which need special care
81 82
 * PER_CPU - set manualy by ftrace_ops user to denote the ftrace_ops
 *           could be controlled by following calls:
83 84
 *             ftrace_function_local_enable
 *             ftrace_function_local_disable
85 86 87
 * SAVE_REGS - The ftrace_ops wants regs saved at each function called
 *            and passed to the callback. If this flag is set, but the
 *            architecture does not support passing regs
88
 *            (CONFIG_DYNAMIC_FTRACE_WITH_REGS is not defined), then the
89 90 91 92 93 94 95 96 97 98
 *            ftrace_ops will fail to register, unless the next flag
 *            is set.
 * SAVE_REGS_IF_SUPPORTED - This is the same as SAVE_REGS, but if the
 *            handler can handle an arch that does not save regs
 *            (the handler tests if regs == NULL), then it can set
 *            this flag instead. It will not fail registering the ftrace_ops
 *            but, the regs field will be NULL if the arch does not support
 *            passing regs to the handler.
 *            Note, if this flag is set, the SAVE_REGS flag will automatically
 *            get set upon registering the ftrace_ops, if the arch supports it.
99 100 101 102
 * RECURSION_SAFE - The ftrace_ops can set this to tell the ftrace infrastructure
 *            that the call back has its own recursion protection. If it does
 *            not set this, then the ftrace infrastructure will add recursion
 *            protection for the caller.
103
 * STUB   - The ftrace_ops is just a place holder.
104 105
 * INITIALIZED - The ftrace_ops has already been initialized (first use time
 *            register_ftrace_function() is called, it will initialized the ops)
106
 * DELETED - The ops are being deleted, do not let them be registered again.
107 108 109
 * ADDING  - The ops is in the process of being added.
 * REMOVING - The ops is in the process of being removed.
 * MODIFYING - The ops is in the process of changing its filter functions.
110 111 112 113 114 115 116
 * ALLOC_TRAMP - A dynamic trampoline was allocated by the core code.
 *            The arch specific code sets this flag when it allocated a
 *            trampoline. This lets the arch know that it can update the
 *            trampoline in case the callback function changes.
 *            The ftrace_ops trampoline can be set by the ftrace users, and
 *            in such cases the arch must not modify it. Only the arch ftrace
 *            core code should set this flag.
117 118 119 120
 * IPMODIFY - The ops can modify the IP register. This can only be set with
 *            SAVE_REGS. If another ops with this flag set is already registered
 *            for any of the functions that this ops will be registered for, then
 *            this ops will fail to register or set_filter_ip.
121
 * PID     - Is affected by set_ftrace_pid (allows filtering on those pids)
122
 */
123
enum {
124
	FTRACE_OPS_FL_ENABLED			= 1 << 0,
125
	FTRACE_OPS_FL_DYNAMIC			= 1 << 1,
126
	FTRACE_OPS_FL_PER_CPU			= 1 << 2,
127 128 129 130 131 132
	FTRACE_OPS_FL_SAVE_REGS			= 1 << 3,
	FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED	= 1 << 4,
	FTRACE_OPS_FL_RECURSION_SAFE		= 1 << 5,
	FTRACE_OPS_FL_STUB			= 1 << 6,
	FTRACE_OPS_FL_INITIALIZED		= 1 << 7,
	FTRACE_OPS_FL_DELETED			= 1 << 8,
133 134 135
	FTRACE_OPS_FL_ADDING			= 1 << 9,
	FTRACE_OPS_FL_REMOVING			= 1 << 10,
	FTRACE_OPS_FL_MODIFYING			= 1 << 11,
136
	FTRACE_OPS_FL_ALLOC_TRAMP		= 1 << 12,
137
	FTRACE_OPS_FL_IPMODIFY			= 1 << 13,
138
	FTRACE_OPS_FL_PID			= 1 << 14,
139
	FTRACE_OPS_FL_RCU			= 1 << 15,
140 141
};

142 143 144 145 146 147 148
#ifdef CONFIG_DYNAMIC_FTRACE
/* The hash used to know what functions callbacks trace */
struct ftrace_ops_hash {
	struct ftrace_hash		*notrace_hash;
	struct ftrace_hash		*filter_hash;
	struct mutex			regex_lock;
};
149

150
void ftrace_free_init_mem(void);
151
#else
152
static inline void ftrace_free_init_mem(void) { }
153 154
#endif

155
/*
156 157 158 159 160
 * Note, ftrace_ops can be referenced outside of RCU protection, unless
 * the RCU flag is set. If ftrace_ops is allocated and not part of kernel
 * core data, the unregistering of it will perform a scheduling on all CPUs
 * to make sure that there are no more users. Depending on the load of the
 * system that may take a bit of time.
161 162 163 164 165
 *
 * Any private data added must also take care not to be freed and if private
 * data is added to a ftrace_ops that is in core code, the user of the
 * ftrace_ops must perform a schedule_on_each_cpu() before freeing it.
 */
166
struct ftrace_ops {
167 168
	ftrace_func_t			func;
	struct ftrace_ops		*next;
169
	unsigned long			flags;
170
	void				*private;
171
	ftrace_func_t			saved_func;
172
	int __percpu			*disabled;
173
#ifdef CONFIG_DYNAMIC_FTRACE
174 175
	struct ftrace_ops_hash		local_hash;
	struct ftrace_ops_hash		*func_hash;
176
	struct ftrace_ops_hash		old_hash;
177
	unsigned long			trampoline;
178
	unsigned long			trampoline_size;
179
#endif
180 181
};

182 183 184 185 186 187 188 189 190 191 192
/*
 * 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;

193 194 195 196 197 198 199 200 201 202 203
/*
 * 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);

204
/**
205
 * ftrace_function_local_enable - enable ftrace_ops on current cpu
206 207 208 209
 *
 * This function enables tracing on current cpu by decreasing
 * the per cpu control variable.
 * It must be called with preemption disabled and only on ftrace_ops
210
 * registered with FTRACE_OPS_FL_PER_CPU. If called without preemption
211 212 213 214
 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
 */
static inline void ftrace_function_local_enable(struct ftrace_ops *ops)
{
215
	if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_PER_CPU)))
216 217 218 219 220 221
		return;

	(*this_cpu_ptr(ops->disabled))--;
}

/**
222
 * ftrace_function_local_disable - disable ftrace_ops on current cpu
223
 *
224
 * This function disables tracing on current cpu by increasing
225 226
 * the per cpu control variable.
 * It must be called with preemption disabled and only on ftrace_ops
227
 * registered with FTRACE_OPS_FL_PER_CPU. If called without preemption
228 229 230 231
 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
 */
static inline void ftrace_function_local_disable(struct ftrace_ops *ops)
{
232
	if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_PER_CPU)))
233 234 235 236 237 238 239 240 241 242 243
		return;

	(*this_cpu_ptr(ops->disabled))++;
}

/**
 * ftrace_function_local_disabled - returns ftrace_ops disabled value
 *                                  on current cpu
 *
 * This function returns value of ftrace_ops::disabled on current cpu.
 * It must be called with preemption disabled and only on ftrace_ops
244
 * registered with FTRACE_OPS_FL_PER_CPU. If called without preemption
245 246 247 248
 * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
 */
static inline int ftrace_function_local_disabled(struct ftrace_ops *ops)
{
249
	WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_PER_CPU));
250 251 252
	return *this_cpu_ptr(ops->disabled);
}

253 254
extern void ftrace_stub(unsigned long a0, unsigned long a1,
			struct ftrace_ops *op, struct pt_regs *regs);
255

256
#else /* !CONFIG_FUNCTION_TRACER */
257 258 259 260 261 262
/*
 * (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; })
263 264 265 266
static inline int ftrace_nr_registered_ops(void)
{
	return 0;
}
267
static inline void clear_ftrace_function(void) { }
268
static inline void ftrace_kill(void) { }
269
static inline void ftrace_free_init_mem(void) { }
270
#endif /* CONFIG_FUNCTION_TRACER */
271

272
#ifdef CONFIG_STACK_TRACER
273 274 275 276 277 278 279 280

#define STACK_TRACE_ENTRIES 500

struct stack_trace;

extern unsigned stack_trace_index[];
extern struct stack_trace stack_trace_max;
extern unsigned long stack_trace_max_size;
281
extern arch_spinlock_t stack_trace_max_lock;
282

283
extern int stack_tracer_enabled;
284
void stack_trace_print(void);
285 286
int
stack_trace_sysctl(struct ctl_table *table, int write,
287
		   void __user *buffer, size_t *lenp,
288
		   loff_t *ppos);
289

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
/* DO NOT MODIFY THIS VARIABLE DIRECTLY! */
DECLARE_PER_CPU(int, disable_stack_tracer);

/**
 * stack_tracer_disable - temporarily disable the stack tracer
 *
 * There's a few locations (namely in RCU) where stack tracing
 * cannot be executed. This function is used to disable stack
 * tracing during those critical sections.
 *
 * This function must be called with preemption or interrupts
 * disabled and stack_tracer_enable() must be called shortly after
 * while preemption or interrupts are still disabled.
 */
static inline void stack_tracer_disable(void)
{
	/* Preemption or interupts must be disabled */
	if (IS_ENABLED(CONFIG_PREEMPT_DEBUG))
		WARN_ON_ONCE(!preempt_count() || !irqs_disabled());
	this_cpu_inc(disable_stack_tracer);
}

/**
 * stack_tracer_enable - re-enable the stack tracer
 *
 * After stack_tracer_disable() is called, stack_tracer_enable()
 * must be called shortly afterward.
 */
static inline void stack_tracer_enable(void)
{
	if (IS_ENABLED(CONFIG_PREEMPT_DEBUG))
		WARN_ON_ONCE(!preempt_count() || !irqs_disabled());
	this_cpu_dec(disable_stack_tracer);
}
324 325 326
#else
static inline void stack_tracer_disable(void) { }
static inline void stack_tracer_enable(void) { }
327 328
#endif

329
#ifdef CONFIG_DYNAMIC_FTRACE
330

331 332 333
int ftrace_arch_code_modify_prepare(void);
int ftrace_arch_code_modify_post_process(void);

334 335
struct dyn_ftrace;

336 337 338 339 340 341 342 343 344
enum ftrace_bug_type {
	FTRACE_BUG_UNKNOWN,
	FTRACE_BUG_INIT,
	FTRACE_BUG_NOP,
	FTRACE_BUG_CALL,
	FTRACE_BUG_UPDATE,
};
extern enum ftrace_bug_type ftrace_bug_type;

345 346 347 348 349 350
/*
 * Archs can set this to point to a variable that holds the value that was
 * expected at the call site before calling ftrace_bug().
 */
extern const void *ftrace_expected;

351
void ftrace_bug(int err, struct dyn_ftrace *rec);
352

353 354
struct seq_file;

355
extern int ftrace_text_reserved(const void *start, const void *end);
356

357 358
extern int ftrace_nr_registered_ops(void);

359 360
bool is_ftrace_trampoline(unsigned long addr);

361 362 363 364 365 366 367 368 369 370
/*
 * The dyn_ftrace record's flags field is split into two parts.
 * the first part which is '0-FTRACE_REF_MAX' is a counter of
 * the number of callbacks that have registered the function that
 * the dyn_ftrace descriptor represents.
 *
 * The second part is a mask:
 *  ENABLED - the function is being traced
 *  REGS    - the record wants the function to save regs
 *  REGS_EN - the function is set up to save regs.
371
 *  IPMODIFY - the record allows for the IP address to be changed.
372
 *  DISABLED - the record is not ready to be touched yet
373 374 375 376 377 378 379
 *
 * When a new ftrace_ops is registered and wants a function to save
 * pt_regs, the rec->flag REGS is set. When the function has been
 * set up to save regs, the REG_EN flag is set. Once a function
 * starts saving regs it will do so until all ftrace_ops are removed
 * from tracing that function.
 */
380
enum {
381
	FTRACE_FL_ENABLED	= (1UL << 31),
382
	FTRACE_FL_REGS		= (1UL << 30),
383 384 385
	FTRACE_FL_REGS_EN	= (1UL << 29),
	FTRACE_FL_TRAMP		= (1UL << 28),
	FTRACE_FL_TRAMP_EN	= (1UL << 27),
386
	FTRACE_FL_IPMODIFY	= (1UL << 26),
387
	FTRACE_FL_DISABLED	= (1UL << 25),
388 389
};

390 391
#define FTRACE_REF_MAX_SHIFT	25
#define FTRACE_FL_BITS		7
392 393 394
#define FTRACE_FL_MASKED_BITS	((1UL << FTRACE_FL_BITS) - 1)
#define FTRACE_FL_MASK		(FTRACE_FL_MASKED_BITS << FTRACE_REF_MAX_SHIFT)
#define FTRACE_REF_MAX		((1UL << FTRACE_REF_MAX_SHIFT) - 1)
395

396 397
#define ftrace_rec_count(rec)	((rec)->flags & ~FTRACE_FL_MASK)

398
struct dyn_ftrace {
399
	unsigned long		ip; /* address of mcount call-site */
400
	unsigned long		flags;
401
	struct dyn_arch_ftrace	arch;
402 403
};

S
Steven Rostedt 已提交
404
int ftrace_force_update(void);
405 406
int ftrace_set_filter_ip(struct ftrace_ops *ops, unsigned long ip,
			 int remove, int reset);
407
int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
408
		       int len, int reset);
409
int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
410 411 412
			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);
413
void ftrace_free_filter(struct ftrace_ops *ops);
414
void ftrace_ops_set_global_filter(struct ftrace_ops *ops);
S
Steven Rostedt 已提交
415

416 417 418 419 420 421 422 423
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),
};

424 425 426 427 428 429 430 431 432 433 434
/*
 * The FTRACE_UPDATE_* enum is used to pass information back
 * from the ftrace_update_record() and ftrace_test_record()
 * functions. These are called by the code update routines
 * to find out what is to be done for a given function.
 *
 *  IGNORE           - The function is already what we want it to be
 *  MAKE_CALL        - Start tracing the function
 *  MODIFY_CALL      - Stop saving regs for the function
 *  MAKE_NOP         - Stop tracing the function
 */
435 436 437
enum {
	FTRACE_UPDATE_IGNORE,
	FTRACE_UPDATE_MAKE_CALL,
438
	FTRACE_UPDATE_MODIFY_CALL,
439 440 441
	FTRACE_UPDATE_MAKE_NOP,
};

442 443 444 445
enum {
	FTRACE_ITER_FILTER	= (1 << 0),
	FTRACE_ITER_NOTRACE	= (1 << 1),
	FTRACE_ITER_PRINTALL	= (1 << 2),
446 447
	FTRACE_ITER_DO_PROBES	= (1 << 3),
	FTRACE_ITER_PROBE	= (1 << 4),
448
	FTRACE_ITER_ENABLED	= (1 << 5),
449 450
};

451 452 453 454 455 456 457 458
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);

459 460 461 462 463 464
#define for_ftrace_rec_iter(iter)		\
	for (iter = ftrace_rec_iter_start();	\
	     iter;				\
	     iter = ftrace_rec_iter_next(iter))


465 466 467
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);
468
unsigned long ftrace_location(unsigned long ip);
469
unsigned long ftrace_location_range(unsigned long start, unsigned long end);
470 471
unsigned long ftrace_get_addr_new(struct dyn_ftrace *rec);
unsigned long ftrace_get_addr_curr(struct dyn_ftrace *rec);
472 473 474

extern ftrace_func_t ftrace_trace_function;

475 476 477 478 479 480 481 482
int ftrace_regex_open(struct ftrace_ops *ops, int flag,
		  struct inode *inode, struct file *file);
ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
			    size_t cnt, loff_t *ppos);
ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
			     size_t cnt, loff_t *ppos);
int ftrace_regex_release(struct inode *inode, struct file *file);

483 484 485
void __init
ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable);

486
/* defined in arch */
487
extern int ftrace_ip_converted(unsigned long ip);
488
extern int ftrace_dyn_arch_init(void);
489
extern void ftrace_replace_code(int enable);
490 491
extern int ftrace_update_ftrace_func(ftrace_func_t func);
extern void ftrace_caller(void);
492
extern void ftrace_regs_caller(void);
493
extern void ftrace_call(void);
494
extern void ftrace_regs_call(void);
495
extern void mcount_call(void);
496

497 498
void ftrace_modify_all_code(int command);

499 500 501
#ifndef FTRACE_ADDR
#define FTRACE_ADDR ((unsigned long)ftrace_caller)
#endif
502

503 504 505 506
#ifndef FTRACE_GRAPH_ADDR
#define FTRACE_GRAPH_ADDR ((unsigned long)ftrace_graph_caller)
#endif

507
#ifndef FTRACE_REGS_ADDR
508
#ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
509 510 511 512 513 514
# define FTRACE_REGS_ADDR ((unsigned long)ftrace_regs_caller)
#else
# define FTRACE_REGS_ADDR FTRACE_ADDR
#endif
#endif

515 516 517 518 519 520 521 522 523 524
/*
 * If an arch would like functions that are only traced
 * by the function graph tracer to jump directly to its own
 * trampoline, then they can define FTRACE_GRAPH_TRAMP_ADDR
 * to be that address to jump to.
 */
#ifndef FTRACE_GRAPH_TRAMP_ADDR
#define FTRACE_GRAPH_TRAMP_ADDR ((unsigned long) 0)
#endif

525 526
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
527 528 529 530 531
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; }
532
#endif
533

534
/**
535
 * ftrace_make_nop - convert code into nop
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
 * @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);
S
Steven Rostedt 已提交
557

558
/**
559 560 561
 * 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
562 563 564 565 566 567 568
 *
 * 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.
 *
569 570
 * The code segment at @rec->ip should be a nop
 *
571 572 573 574 575 576 577
 * 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.
 */
578 579
extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);

580
#ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
/**
 * ftrace_modify_call - convert from one addr to another (no nop)
 * @rec: the mcount call site record
 * @old_addr: the address expected to be currently called to
 * @addr: the address to change to
 *
 * 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 @old_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_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
			      unsigned long addr);
#else
/* Should never be called */
static inline int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
				     unsigned long addr)
{
	return -EINVAL;
}
#endif

613 614
/* May be defined in arch */
extern int ftrace_arch_read_dyn_info(char *buf, int size);
615

A
Abhishek Sagar 已提交
616
extern int skip_trace(unsigned long ip);
617
extern void ftrace_module_init(struct module *mod);
618
extern void ftrace_module_enable(struct module *mod);
619
extern void ftrace_release_mod(struct module *mod);
A
Abhishek Sagar 已提交
620

621 622
extern void ftrace_disable_daemon(void);
extern void ftrace_enable_daemon(void);
623
#else /* CONFIG_DYNAMIC_FTRACE */
624 625 626 627
static inline int skip_trace(unsigned long ip) { return 0; }
static inline int ftrace_force_update(void) { return 0; }
static inline void ftrace_disable_daemon(void) { }
static inline void ftrace_enable_daemon(void) { }
628 629 630
static inline void ftrace_module_init(struct module *mod) { }
static inline void ftrace_module_enable(struct module *mod) { }
static inline void ftrace_release_mod(struct module *mod) { }
631
static inline int ftrace_text_reserved(const void *start, const void *end)
632 633 634
{
	return 0;
}
635 636 637 638
static inline unsigned long ftrace_location(unsigned long ip)
{
	return 0;
}
639 640 641 642 643 644 645

/*
 * Again users of functions that have ftrace_ops may not
 * have them defined when ftrace is not enabled, but these
 * functions may still be called. Use a macro instead of inline.
 */
#define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; })
646
#define ftrace_set_early_filter(ops, buf, enable) do { } while (0)
647
#define ftrace_set_filter_ip(ops, ip, remove, reset) ({ -ENODEV; })
648 649 650
#define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; })
#define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; })
#define ftrace_free_filter(ops) do { } while (0)
651
#define ftrace_ops_set_global_filter(ops) do { } while (0)
652 653 654 655 656 657 658

static inline ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
			    size_t cnt, loff_t *ppos) { return -ENODEV; }
static inline ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
			     size_t cnt, loff_t *ppos) { return -ENODEV; }
static inline int
ftrace_regex_release(struct inode *inode, struct file *file) { return -ENODEV; }
659 660 661 662 663

static inline bool is_ftrace_trampoline(unsigned long addr)
{
	return false;
}
A
Abhishek Sagar 已提交
664
#endif /* CONFIG_DYNAMIC_FTRACE */
665

I
Ingo Molnar 已提交
666 667 668
/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

I
Ingo Molnar 已提交
669 670
static inline void tracer_disable(void)
{
671
#ifdef CONFIG_FUNCTION_TRACER
I
Ingo Molnar 已提交
672 673 674 675
	ftrace_enabled = 0;
#endif
}

676 677
/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
678
 * must be used to prevent ftrace_enabled to be changed between
679 680
 * disable/restore.
 */
681 682
static inline int __ftrace_enabled_save(void)
{
683
#ifdef CONFIG_FUNCTION_TRACER
684 685 686 687 688 689 690 691 692 693
	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)
{
694
#ifdef CONFIG_FUNCTION_TRACER
695 696 697 698
	ftrace_enabled = enabled;
#endif
}

699 700 701 702 703 704 705
/* All archs should have this, but we define it for consistency */
#ifndef ftrace_return_address0
# define ftrace_return_address0 __builtin_return_address(0)
#endif

/* Archs may use other ways for ADDR1 and beyond */
#ifndef ftrace_return_address
706
# ifdef CONFIG_FRAME_POINTER
707
#  define ftrace_return_address(n) __builtin_return_address(n)
708
# else
709
#  define ftrace_return_address(n) 0UL
710
# endif
711 712 713 714 715 716 717 718 719
#endif

#define CALLER_ADDR0 ((unsigned long)ftrace_return_address0)
#define CALLER_ADDR1 ((unsigned long)ftrace_return_address(1))
#define CALLER_ADDR2 ((unsigned long)ftrace_return_address(2))
#define CALLER_ADDR3 ((unsigned long)ftrace_return_address(3))
#define CALLER_ADDR4 ((unsigned long)ftrace_return_address(4))
#define CALLER_ADDR5 ((unsigned long)ftrace_return_address(5))
#define CALLER_ADDR6 ((unsigned long)ftrace_return_address(6))
720

721 722 723 724 725 726 727 728 729 730 731 732
static inline unsigned long get_lock_parent_ip(void)
{
	unsigned long addr = CALLER_ADDR0;

	if (!in_lock_functions(addr))
		return addr;
	addr = CALLER_ADDR1;
	if (!in_lock_functions(addr))
		return addr;
	return CALLER_ADDR2;
}

733
#ifdef CONFIG_IRQSOFF_TRACER
I
Ingo Molnar 已提交
734 735
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
736
#else
737 738
  static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
  static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
739 740
#endif

741
#ifdef CONFIG_PREEMPT_TRACER
I
Ingo Molnar 已提交
742 743
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
744
#else
745 746 747 748 749 750
/*
 * Use defines instead of static inlines because some arches will make code out
 * of the CALLER_ADDR, when we really want these to be a real nop.
 */
# define trace_preempt_on(a0, a1) do { } while (0)
# define trace_preempt_off(a0, a1) do { } while (0)
751 752
#endif

753 754 755 756 757 758
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
#else
static inline void ftrace_init(void) { }
#endif

759 760
/*
 * Structure that defines an entry function trace.
761 762
 * It's already packed but the attribute "packed" is needed
 * to remove extra padding at the end.
763 764 765 766
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
767
} __packed;
768

769 770
/*
 * Structure that defines a return function trace.
771 772
 * It's already packed but the attribute "packed" is needed
 * to remove extra padding at the end.
773
 */
774
struct ftrace_graph_ret {
775
	unsigned long func; /* Current function */
776 777
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
778 779
	unsigned long long calltime;
	unsigned long long rettime;
780
	int depth;
781
} __packed;
782

783 784 785 786
/* 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 */

787
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
788

789
/* for init task */
790
#define INIT_FTRACE_GRAPH		.ret_stack = NULL,
791

792 793 794 795 796 797 798 799 800
/*
 * 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;
801
#ifdef CONFIG_FUNCTION_PROFILER
802
	unsigned long long subtime;
803
#endif
804
#ifdef HAVE_FUNCTION_GRAPH_FP_TEST
805
	unsigned long fp;
806
#endif
807 808 809
#ifdef HAVE_FUNCTION_GRAPH_RET_ADDR_PTR
	unsigned long *retp;
#endif
810 811 812 813 814 815 816 817 818 819
};

/*
 * 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
820
ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
821
			 unsigned long frame_pointer, unsigned long *retp);
822

823 824 825
unsigned long ftrace_graph_ret_addr(struct task_struct *task, int *idx,
				    unsigned long ret, unsigned long *retp);

826 827 828 829 830 831 832
/*
 * 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

833
#define FTRACE_NOTRACE_DEPTH 65536
834 835
#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
836 837 838
extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

839
extern bool ftrace_graph_is_dead(void);
S
Steven Rostedt 已提交
840 841
extern void ftrace_graph_stop(void);

842 843 844
/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;
845

846
extern void unregister_ftrace_graph(void);
847

848 849
extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
850
extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
851 852 853 854 855

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}
856 857 858 859 860 861 862 863 864 865

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);
}
866
#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
867 868

#define __notrace_funcgraph
869
#define INIT_FTRACE_GRAPH
870

871 872
static inline void ftrace_graph_init_task(struct task_struct *t) { }
static inline void ftrace_graph_exit_task(struct task_struct *t) { }
873
static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
874

875 876 877 878 879 880 881
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) { }

882 883 884 885
static inline int task_curr_ret_stack(struct task_struct *tsk)
{
	return -1;
}
886

887 888 889 890 891 892 893
static inline unsigned long
ftrace_graph_ret_addr(struct task_struct *task, int *idx, unsigned long ret,
		      unsigned long *retp)
{
	return ret;
}

894 895
static inline void pause_graph_tracing(void) { }
static inline void unpause_graph_tracing(void) { }
896
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
897

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
#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;
}

940 941 942
enum ftrace_dump_mode;

extern enum ftrace_dump_mode ftrace_dump_on_oops;
943
extern int tracepoint_printk;
944

945 946 947
extern void disable_trace_on_warning(void);
extern int __disable_trace_on_warning;

948 949 950 951
#ifdef CONFIG_PREEMPT
#define INIT_TRACE_RECURSION		.trace_recursion = 0,
#endif

952 953 954 955
int tracepoint_printk_sysctl(struct ctl_table *table, int write,
			     void __user *buffer, size_t *lenp,
			     loff_t *ppos);

956 957
#else /* CONFIG_TRACING */
static inline void  disable_trace_on_warning(void) { }
958 959
#endif /* CONFIG_TRACING */

960 961 962
#ifndef INIT_TRACE_RECURSION
#define INIT_TRACE_RECURSION
#endif
963

964 965 966 967 968 969
#ifdef CONFIG_FTRACE_SYSCALLS

unsigned long arch_syscall_addr(int nr);

#endif /* CONFIG_FTRACE_SYSCALLS */

970
#endif /* _LINUX_FTRACE_H */