[mirror_ubuntu-bionic-kernel.git] / include / linux / ftrace.h

/*
 * Ftrace header.  For implementation details beyond the random comments
 * scattered below, see: Documentation/trace/ftrace-design.txt
 */

#ifndef _LINUX_FTRACE_H
#define _LINUX_FTRACE_H

#include <linux/trace_clock.h>
#include <linux/kallsyms.h>
#include <linux/linkage.h>
#include <linux/bitops.h>
#include <linux/ktime.h>
#include <linux/sched.h>
#include <linux/types.h>
#include <linux/init.h>
#include <linux/fs.h>

#include <asm/ftrace.h>

struct module;
struct ftrace_hash;

#ifdef CONFIG_FUNCTION_TRACER

extern int ftrace_enabled;
extern int
ftrace_enable_sysctl(struct ctl_table *table, int write,
		     void __user *buffer, size_t *lenp,
		     loff_t *ppos);

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

enum {
	FTRACE_OPS_FL_ENABLED		= 1 << 0,
	FTRACE_OPS_FL_GLOBAL		= 1 << 1,
	FTRACE_OPS_FL_DYNAMIC		= 1 << 2,
};

struct ftrace_ops {
	ftrace_func_t			func;
	struct ftrace_ops		*next;
	unsigned long			flags;
#ifdef CONFIG_DYNAMIC_FTRACE
	struct ftrace_hash		*notrace_hash;
	struct ftrace_hash		*filter_hash;
#endif
};

extern int function_trace_stop;

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

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

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

#else /* !CONFIG_FUNCTION_TRACER */
/*
 * (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) { }
static inline void ftrace_kill(void) { }
static inline void ftrace_stop(void) { }
static inline void ftrace_start(void) { }
#endif /* CONFIG_FUNCTION_TRACER */

#ifdef CONFIG_STACK_TRACER
extern int stack_tracer_enabled;
int
stack_trace_sysctl(struct ctl_table *table, int write,
		   void __user *buffer, size_t *lenp,
		   loff_t *ppos);
#endif

struct ftrace_func_command {
	struct list_head	list;
	char			*name;
	int			(*func)(struct ftrace_hash *hash,
					char *func, char *cmd,
					char *params, int enable);
};

#ifdef CONFIG_DYNAMIC_FTRACE

int ftrace_arch_code_modify_prepare(void);
int ftrace_arch_code_modify_post_process(void);

void ftrace_bug(int err, unsigned long ip);

struct seq_file;

struct ftrace_probe_ops {
	void			(*func)(unsigned long ip,
					unsigned long parent_ip,
					void **data);
	int			(*callback)(unsigned long ip, void **data);
	void			(*free)(void **data);
	int			(*print)(struct seq_file *m,
					 unsigned long ip,
					 struct ftrace_probe_ops *ops,
					 void *data);
};

extern int
register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
			      void *data);
extern void
unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
				void *data);
extern void
unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
extern void unregister_ftrace_function_probe_all(char *glob);

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

enum {
	FTRACE_FL_ENABLED	= (1 << 30),
};

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

struct dyn_ftrace {
	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;
};

int ftrace_force_update(void);
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);

int register_ftrace_command(struct ftrace_func_command *cmd);
int unregister_ftrace_command(struct ftrace_func_command *cmd);

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;

/* defined in arch */
extern int ftrace_ip_converted(unsigned long ip);
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);

#ifndef FTRACE_ADDR
#define FTRACE_ADDR ((unsigned long)ftrace_caller)
#endif
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern void ftrace_graph_caller(void);
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; }
#endif

/**
 * ftrace_make_nop - convert code into nop
 * @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);

/**
 * 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
 *
 * 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 nop
 *
 * 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_call(struct dyn_ftrace *rec, unsigned long addr);

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

extern int skip_trace(unsigned long ip);

extern void ftrace_disable_daemon(void);
extern void ftrace_enable_daemon(void);
#else
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) { }
static inline void ftrace_release_mod(struct module *mod) {}
static inline int register_ftrace_command(struct ftrace_func_command *cmd)
{
	return -EINVAL;
}
static inline int unregister_ftrace_command(char *cmd_name)
{
	return -EINVAL;
}
static inline int ftrace_text_reserved(void *start, void *end)
{
	return 0;
}
#endif /* CONFIG_DYNAMIC_FTRACE */

/* totally disable ftrace - can not re-enable after this */
void ftrace_kill(void);

static inline void tracer_disable(void)
{
#ifdef CONFIG_FUNCTION_TRACER
	ftrace_enabled = 0;
#endif
}

/*
 * Ftrace disable/restore without lock. Some synchronization mechanism
 * must be used to prevent ftrace_enabled to be changed between
 * disable/restore.
 */
static inline int __ftrace_enabled_save(void)
{
#ifdef CONFIG_FUNCTION_TRACER
	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)
{
#ifdef CONFIG_FUNCTION_TRACER
	ftrace_enabled = enabled;
#endif
}

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

#ifdef CONFIG_IRQSOFF_TRACER
  extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
  extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
#else
  static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
  static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
#endif

#ifdef CONFIG_PREEMPT_TRACER
  extern void trace_preempt_on(unsigned long a0, unsigned long a1);
  extern void trace_preempt_off(unsigned long a0, unsigned long a1);
#else
  static inline void trace_preempt_on(unsigned long a0, unsigned long a1) { }
  static inline void trace_preempt_off(unsigned long a0, unsigned long a1) { }
#endif

#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
#else
static inline void ftrace_init(void) { }
#endif

/*
 * Structure that defines an entry function trace.
 */
struct ftrace_graph_ent {
	unsigned long func; /* Current function */
	int depth;
};

/*
 * Structure that defines a return function trace.
 */
struct ftrace_graph_ret {
	unsigned long func; /* Current function */
	unsigned long long calltime;
	unsigned long long rettime;
	/* Number of functions that overran the depth limit for current task */
	unsigned long overrun;
	int depth;
};

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

#ifdef CONFIG_FUNCTION_GRAPH_TRACER

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

/*
 * 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;
	unsigned long long subtime;
	unsigned long fp;
};

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

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

/*
 * 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[];

#define FTRACE_RETFUNC_DEPTH 50
#define FTRACE_RETSTACK_ALLOC_SIZE 32
extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
				trace_func_graph_ent_t entryfunc);

extern void ftrace_graph_stop(void);

/* The current handlers in use */
extern trace_func_graph_ret_t ftrace_graph_return;
extern trace_func_graph_ent_t ftrace_graph_entry;

extern void unregister_ftrace_graph(void);

extern void ftrace_graph_init_task(struct task_struct *t);
extern void ftrace_graph_exit_task(struct task_struct *t);
extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);

static inline int task_curr_ret_stack(struct task_struct *t)
{
	return t->curr_ret_stack;
}

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

#define __notrace_funcgraph
#define __irq_entry
#define INIT_FTRACE_GRAPH

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

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) { }

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

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

#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;
}

enum ftrace_dump_mode;

extern enum ftrace_dump_mode ftrace_dump_on_oops;

#ifdef CONFIG_PREEMPT
#define INIT_TRACE_RECURSION		.trace_recursion = 0,
#endif

#endif /* CONFIG_TRACING */

#ifndef INIT_TRACE_RECURSION
#define INIT_TRACE_RECURSION
#endif

#ifdef CONFIG_FTRACE_SYSCALLS

unsigned long arch_syscall_addr(int nr);

#endif /* CONFIG_FTRACE_SYSCALLS */

#endif /* _LINUX_FTRACE_H */
Commit	Line	Data
9849ed4d MF	1	/*
	2	* Ftrace header. For implementation details beyond the random comments
	3	* scattered below, see: Documentation/trace/ftrace-design.txt
	4	*/
	5
16444a8a ACM	6	#ifndef _LINUX_FTRACE_H
	7	#define _LINUX_FTRACE_H
	8
0012693a	9	#include <linux/trace_clock.h>
5601020f	10	#include <linux/kallsyms.h>
0012693a	11	#include <linux/linkage.h>
ea4e2bc4	12	#include <linux/bitops.h>
0012693a	13	#include <linux/ktime.h>
21a8c466	14	#include <linux/sched.h>
0012693a FW	15	#include <linux/types.h>
	16	#include <linux/init.h>
	17	#include <linux/fs.h>
16444a8a	18
c79a61f5 UKK	19	#include <asm/ftrace.h>
c79a61f5 UKK	20
de477254	21	struct module;
04da85b8 SR	22	struct ftrace_hash;
04da85b8 SR	23
606576ce	24	#ifdef CONFIG_FUNCTION_TRACER
3e1932ad	25
b0fc494f SR	26	extern int ftrace_enabled;
	27	extern int
	28	ftrace_enable_sysctl(struct ctl_table *table, int write,
8d65af78	29	void __user buffer, size_t lenp,
b0fc494f SR	30	loff_t *ppos);
b0fc494f SR	31
16444a8a ACM	32	typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
16444a8a ACM	33
b848914c SR	34	enum {
	35	FTRACE_OPS_FL_ENABLED = 1 << 0,
	36	FTRACE_OPS_FL_GLOBAL = 1 << 1,
cdbe61bf	37	FTRACE_OPS_FL_DYNAMIC = 1 << 2,
b848914c SR	38	};
b848914c SR	39
16444a8a	40	struct ftrace_ops {
f45948e8 SR	41	ftrace_func_t func;
f45948e8 SR	42	struct ftrace_ops *next;
b848914c	43	unsigned long flags;
f45948e8 SR	44	#ifdef CONFIG_DYNAMIC_FTRACE
	45	struct ftrace_hash *notrace_hash;
	46	struct ftrace_hash *filter_hash;
	47	#endif
16444a8a ACM	48	};
16444a8a ACM	49
60a7ecf4 SR	50	extern int function_trace_stop;
60a7ecf4 SR	51
e7d3737e FW	52	/*
	53	* Type of the current tracing.
	54	*/
	55	enum ftrace_tracing_type_t {
	56	FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
	57	FTRACE_TYPE_RETURN, /* Hook the return of the function */
	58	};
	59
	60	/* Current tracing type, default is FTRACE_TYPE_ENTER */
	61	extern enum ftrace_tracing_type_t ftrace_tracing_type;
	62
60a7ecf4 SR	63	/**
	64	* ftrace_stop - stop function tracer.
	65	*
	66	* A quick way to stop the function tracer. Note this an on off switch,
	67	* it is not something that is recursive like preempt_disable.
	68	* This does not disable the calling of mcount, it only stops the
	69	* calling of functions from mcount.
	70	*/
	71	static inline void ftrace_stop(void)
	72	{
	73	function_trace_stop = 1;
	74	}
	75
	76	/**
	77	* ftrace_start - start the function tracer.
	78	*
	79	* This function is the inverse of ftrace_stop. This does not enable
	80	* the function tracing if the function tracer is disabled. This only
	81	* sets the function tracer flag to continue calling the functions
	82	* from mcount.
	83	*/
	84	static inline void ftrace_start(void)
	85	{
	86	function_trace_stop = 0;
	87	}
	88
16444a8a ACM	89	/*
	90	* The ftrace_ops must be a static and should also
	91	* be read_mostly. These functions do modify read_mostly variables
	92	* so use them sparely. Never free an ftrace_op or modify the
	93	* next pointer after it has been registered. Even after unregistering
	94	* it, the next pointer may still be used internally.
	95	*/
	96	int register_ftrace_function(struct ftrace_ops *ops);
	97	int unregister_ftrace_function(struct ftrace_ops *ops);
	98	void clear_ftrace_function(void);
	99
	100	extern void ftrace_stub(unsigned long a0, unsigned long a1);
16444a8a	101
606576ce	102	#else /* !CONFIG_FUNCTION_TRACER */
4dbf6bc2 SR	103	/*
	104	* (un)register_ftrace_function must be a macro since the ops parameter
	105	* must not be evaluated.
	106	*/
	107	#define register_ftrace_function(ops) ({ 0; })
	108	#define unregister_ftrace_function(ops) ({ 0; })
	109	static inline void clear_ftrace_function(void) { }
81adbdc0	110	static inline void ftrace_kill(void) { }
60a7ecf4 SR	111	static inline void ftrace_stop(void) { }
60a7ecf4 SR	112	static inline void ftrace_start(void) { }
606576ce	113	#endif /* CONFIG_FUNCTION_TRACER */
352ad25a	114
f38f1d2a SR	115	#ifdef CONFIG_STACK_TRACER
	116	extern int stack_tracer_enabled;
	117	int
	118	stack_trace_sysctl(struct ctl_table *table, int write,
8d65af78	119	void __user buffer, size_t lenp,
f38f1d2a SR	120	loff_t *ppos);
	121	#endif
	122
f6180773 SR	123	struct ftrace_func_command {
	124	struct list_head list;
	125	char *name;
43dd61c9 SR	126	int (func)(struct ftrace_hash hash,
43dd61c9 SR	127	char func, char cmd,
f6180773 SR	128	char *params, int enable);
	129	};
	130
3d083395	131	#ifdef CONFIG_DYNAMIC_FTRACE
31e88909	132
000ab691 SR	133	int ftrace_arch_code_modify_prepare(void);
	134	int ftrace_arch_code_modify_post_process(void);
	135
c88fd863 SR	136	void ftrace_bug(int err, unsigned long ip);
c88fd863 SR	137
809dcf29 SR	138	struct seq_file;
809dcf29 SR	139
b6887d79	140	struct ftrace_probe_ops {
59df055f SR	141	void (*func)(unsigned long ip,
	142	unsigned long parent_ip,
	143	void **data);
	144	int (callback)(unsigned long ip, void *data);
	145	void (free)(void *data);
809dcf29 SR	146	int (print)(struct seq_file m,
809dcf29 SR	147	unsigned long ip,
b6887d79	148	struct ftrace_probe_ops *ops,
809dcf29	149	void *data);
59df055f SR	150	};
	151
	152	extern int
b6887d79	153	register_ftrace_function_probe(char glob, struct ftrace_probe_ops ops,
59df055f SR	154	void *data);
59df055f SR	155	extern void
b6887d79	156	unregister_ftrace_function_probe(char glob, struct ftrace_probe_ops ops,
59df055f SR	157	void *data);
59df055f SR	158	extern void
b6887d79 SR	159	unregister_ftrace_function_probe_func(char glob, struct ftrace_probe_ops ops);
b6887d79 SR	160	extern void unregister_ftrace_function_probe_all(char *glob);
59df055f	161
2cfa1978 MH	162	extern int ftrace_text_reserved(void start, void end);
2cfa1978 MH	163
3c1720f0	164	enum {
ed926f9b	165	FTRACE_FL_ENABLED = (1 << 30),
3c1720f0 SR	166	};
3c1720f0 SR	167
ed926f9b SR	168	#define FTRACE_FL_MASK (0x3UL << 30)
	169	#define FTRACE_REF_MAX ((1 << 30) - 1)
	170
3d083395	171	struct dyn_ftrace {
ee000b7f LJ	172	union {
	173	unsigned long ip; /* address of mcount call-site */
	174	struct dyn_ftrace *freelist;
	175	};
	176	union {
	177	unsigned long flags;
	178	struct dyn_ftrace *newlist;
	179	};
	180	struct dyn_arch_ftrace arch;
3d083395 SR	181	};
3d083395 SR	182
e1c08bdd	183	int ftrace_force_update(void);
936e074b SR	184	void ftrace_set_filter(struct ftrace_ops ops, unsigned char buf,
	185	int len, int reset);
	186	void ftrace_set_notrace(struct ftrace_ops ops, unsigned char buf,
	187	int len, int reset);
	188	void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
	189	void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
e1c08bdd	190
f6180773 SR	191	int register_ftrace_command(struct ftrace_func_command *cmd);
	192	int unregister_ftrace_command(struct ftrace_func_command *cmd);
	193
c88fd863 SR	194	enum {
	195	FTRACE_UPDATE_CALLS = (1 << 0),
	196	FTRACE_DISABLE_CALLS = (1 << 1),
	197	FTRACE_UPDATE_TRACE_FUNC = (1 << 2),
	198	FTRACE_START_FUNC_RET = (1 << 3),
	199	FTRACE_STOP_FUNC_RET = (1 << 4),
	200	};
	201
	202	enum {
	203	FTRACE_UPDATE_IGNORE,
	204	FTRACE_UPDATE_MAKE_CALL,
	205	FTRACE_UPDATE_MAKE_NOP,
	206	};
	207
	208	void arch_ftrace_update_code(int command);
	209
	210	struct ftrace_rec_iter;
	211
	212	struct ftrace_rec_iter *ftrace_rec_iter_start(void);
	213	struct ftrace_rec_iter ftrace_rec_iter_next(struct ftrace_rec_iter iter);
	214	struct dyn_ftrace ftrace_rec_iter_record(struct ftrace_rec_iter iter);
	215
	216	int ftrace_update_record(struct dyn_ftrace *rec, int enable);
	217	int ftrace_test_record(struct dyn_ftrace *rec, int enable);
	218	void ftrace_run_stop_machine(int command);
	219	int ftrace_location(unsigned long ip);
	220
	221	extern ftrace_func_t ftrace_trace_function;
	222
3d083395	223	/* defined in arch */
3c1720f0	224	extern int ftrace_ip_converted(unsigned long ip);
d61f82d0	225	extern int ftrace_dyn_arch_init(void *data);
d61f82d0 SR	226	extern int ftrace_update_ftrace_func(ftrace_func_t func);
	227	extern void ftrace_caller(void);
	228	extern void ftrace_call(void);
	229	extern void mcount_call(void);
f0001207 SL	230
	231	#ifndef FTRACE_ADDR
	232	#define FTRACE_ADDR ((unsigned long)ftrace_caller)
	233	#endif
fb52607a FW	234	#ifdef CONFIG_FUNCTION_GRAPH_TRACER
fb52607a FW	235	extern void ftrace_graph_caller(void);
5a45cfe1 SR	236	extern int ftrace_enable_ftrace_graph_caller(void);
	237	extern int ftrace_disable_ftrace_graph_caller(void);
	238	#else
	239	static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
	240	static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
e7d3737e	241	#endif
ad90c0e3	242
31e88909	243	/**
57794a9d	244	* ftrace_make_nop - convert code into nop
31e88909 SR	245	* @mod: module structure if called by module load initialization
	246	* @rec: the mcount call site record
	247	* @addr: the address that the call site should be calling
	248	*
	249	* This is a very sensitive operation and great care needs
	250	* to be taken by the arch. The operation should carefully
	251	* read the location, check to see if what is read is indeed
	252	* what we expect it to be, and then on success of the compare,
	253	* it should write to the location.
	254	*
	255	* The code segment at @rec->ip should be a caller to @addr
	256	*
	257	* Return must be:
	258	* 0 on success
	259	* -EFAULT on error reading the location
	260	* -EINVAL on a failed compare of the contents
	261	* -EPERM on error writing to the location
	262	* Any other value will be considered a failure.
	263	*/
	264	extern int ftrace_make_nop(struct module *mod,
	265	struct dyn_ftrace *rec, unsigned long addr);
a26a2a27	266
593eb8a2	267	/**
31e88909 SR	268	* ftrace_make_call - convert a nop call site into a call to addr
	269	* @rec: the mcount call site record
	270	* @addr: the address that the call site should call
593eb8a2 SR	271	*
	272	* This is a very sensitive operation and great care needs
	273	* to be taken by the arch. The operation should carefully
	274	* read the location, check to see if what is read is indeed
	275	* what we expect it to be, and then on success of the compare,
	276	* it should write to the location.
	277	*
31e88909 SR	278	* The code segment at @rec->ip should be a nop
31e88909 SR	279	*
593eb8a2 SR	280	* Return must be:
	281	* 0 on success
	282	* -EFAULT on error reading the location
	283	* -EINVAL on a failed compare of the contents
	284	* -EPERM on error writing to the location
	285	* Any other value will be considered a failure.
	286	*/
31e88909 SR	287	extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
31e88909 SR	288
31e88909 SR	289	/* May be defined in arch */
31e88909 SR	290	extern int ftrace_arch_read_dyn_info(char *buf, int size);
593eb8a2	291
ecea656d AS	292	extern int skip_trace(unsigned long ip);
ecea656d AS	293
c0719e5a SR	294	extern void ftrace_disable_daemon(void);
c0719e5a SR	295	extern void ftrace_enable_daemon(void);
e1c08bdd	296	#else
4dbf6bc2 SR	297	static inline int skip_trace(unsigned long ip) { return 0; }
	298	static inline int ftrace_force_update(void) { return 0; }
	299	static inline void ftrace_set_filter(unsigned char *buf, int len, int reset)
	300	{
	301	}
	302	static inline void ftrace_disable_daemon(void) { }
	303	static inline void ftrace_enable_daemon(void) { }
e7247a15	304	static inline void ftrace_release_mod(struct module *mod) {}
f6180773 SR	305	static inline int register_ftrace_command(struct ftrace_func_command *cmd)
f6180773 SR	306	{
97d0bb8d	307	return -EINVAL;
f6180773 SR	308	}
	309	static inline int unregister_ftrace_command(char *cmd_name)
	310	{
97d0bb8d	311	return -EINVAL;
f6180773	312	}
2cfa1978 MH	313	static inline int ftrace_text_reserved(void start, void end)
	314	{
	315	return 0;
	316	}
ecea656d	317	#endif /* CONFIG_DYNAMIC_FTRACE */
352ad25a	318
aeaee8a2 IM	319	/* totally disable ftrace - can not re-enable after this */
	320	void ftrace_kill(void);
	321
f43fdad8 IM	322	static inline void tracer_disable(void)
f43fdad8 IM	323	{
606576ce	324	#ifdef CONFIG_FUNCTION_TRACER
f43fdad8 IM	325	ftrace_enabled = 0;
	326	#endif
	327	}
	328
37002735 HY	329	/*
37002735 HY	330	* Ftrace disable/restore without lock. Some synchronization mechanism
9bdeb7b5	331	* must be used to prevent ftrace_enabled to be changed between
37002735 HY	332	* disable/restore.
37002735 HY	333	*/
9bdeb7b5 HY	334	static inline int __ftrace_enabled_save(void)
9bdeb7b5 HY	335	{
606576ce	336	#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5 HY	337	int saved_ftrace_enabled = ftrace_enabled;
	338	ftrace_enabled = 0;
	339	return saved_ftrace_enabled;
	340	#else
	341	return 0;
	342	#endif
	343	}
	344
	345	static inline void __ftrace_enabled_restore(int enabled)
	346	{
606576ce	347	#ifdef CONFIG_FUNCTION_TRACER
9bdeb7b5 HY	348	ftrace_enabled = enabled;
	349	#endif
	350	}
	351
c79a61f5 UKK	352	#ifndef HAVE_ARCH_CALLER_ADDR
	353	# ifdef CONFIG_FRAME_POINTER
	354	# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
	355	# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
	356	# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
	357	# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
	358	# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
	359	# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
	360	# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
	361	# else
	362	# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
	363	# define CALLER_ADDR1 0UL
	364	# define CALLER_ADDR2 0UL
	365	# define CALLER_ADDR3 0UL
	366	# define CALLER_ADDR4 0UL
	367	# define CALLER_ADDR5 0UL
	368	# define CALLER_ADDR6 0UL
	369	# endif
	370	#endif /* ifndef HAVE_ARCH_CALLER_ADDR */
352ad25a	371
81d68a96	372	#ifdef CONFIG_IRQSOFF_TRACER
489f1396 IM	373	extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
489f1396 IM	374	extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
81d68a96	375	#else
4dbf6bc2 SR	376	static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
4dbf6bc2 SR	377	static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
81d68a96 SR	378	#endif
81d68a96 SR	379
6cd8a4bb	380	#ifdef CONFIG_PREEMPT_TRACER
489f1396 IM	381	extern void trace_preempt_on(unsigned long a0, unsigned long a1);
489f1396 IM	382	extern void trace_preempt_off(unsigned long a0, unsigned long a1);
6cd8a4bb	383	#else
4dbf6bc2 SR	384	static inline void trace_preempt_on(unsigned long a0, unsigned long a1) { }
4dbf6bc2 SR	385	static inline void trace_preempt_off(unsigned long a0, unsigned long a1) { }
6cd8a4bb SR	386	#endif
6cd8a4bb SR	387
68bf21aa SR	388	#ifdef CONFIG_FTRACE_MCOUNT_RECORD
	389	extern void ftrace_init(void);
	390	#else
	391	static inline void ftrace_init(void) { }
	392	#endif
	393
287b6e68 FW	394	/*
	395	* Structure that defines an entry function trace.
	396	*/
	397	struct ftrace_graph_ent {
	398	unsigned long func; /* Current function */
	399	int depth;
	400	};
dd0e545f	401
caf4b323 FW	402	/*
	403	* Structure that defines a return function trace.
	404	*/
fb52607a	405	struct ftrace_graph_ret {
caf4b323 FW	406	unsigned long func; /* Current function */
	407	unsigned long long calltime;
	408	unsigned long long rettime;
0231022c FW	409	/* Number of functions that overran the depth limit for current task */
0231022c FW	410	unsigned long overrun;
287b6e68	411	int depth;
caf4b323 FW	412	};
caf4b323 FW	413
62b915f1 JO	414	/* Type of the callback handlers for tracing function graph*/
	415	typedef void (trace_func_graph_ret_t)(struct ftrace_graph_ret ); /* return */
	416	typedef int (trace_func_graph_ent_t)(struct ftrace_graph_ent ); /* entry */
	417
fb52607a	418	#ifdef CONFIG_FUNCTION_GRAPH_TRACER
8b96f011	419
5ac9f622	420	/* for init task */
f876d346	421	#define INIT_FTRACE_GRAPH .ret_stack = NULL,
5ac9f622	422
712406a6 SR	423	/*
	424	* Stack of return addresses for functions
	425	* of a thread.
	426	* Used in struct thread_info
	427	*/
	428	struct ftrace_ret_stack {
	429	unsigned long ret;
	430	unsigned long func;
	431	unsigned long long calltime;
a2a16d6a	432	unsigned long long subtime;
71e308a2	433	unsigned long fp;
712406a6 SR	434	};
	435
	436	/*
	437	* Primary handler of a function return.
	438	* It relays on ftrace_return_to_handler.
	439	* Defined in entry_32/64.S
	440	*/
	441	extern void return_to_handler(void);
	442
	443	extern int
71e308a2 SR	444	ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
71e308a2 SR	445	unsigned long frame_pointer);
712406a6	446
8b96f011 FW	447	/*
	448	* Sometimes we don't want to trace a function with the function
	449	* graph tracer but we want them to keep traced by the usual function
	450	* tracer if the function graph tracer is not configured.
	451	*/
	452	#define __notrace_funcgraph notrace
	453
bcbc4f20 FW	454	/*
	455	* We want to which function is an entrypoint of a hardirq.
	456	* That will help us to put a signal on output.
	457	*/
	458	#define __irq_entry __attribute__((__section__(".irqentry.text")))
	459
	460	/* Limits of hardirq entrypoints */
	461	extern char __irqentry_text_start[];
	462	extern char __irqentry_text_end[];
	463
f201ae23 FW	464	#define FTRACE_RETFUNC_DEPTH 50
f201ae23 FW	465	#define FTRACE_RETSTACK_ALLOC_SIZE 32
287b6e68 FW	466	extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
	467	trace_func_graph_ent_t entryfunc);
	468
14a866c5 SR	469	extern void ftrace_graph_stop(void);
14a866c5 SR	470
287b6e68 FW	471	/* The current handlers in use */
	472	extern trace_func_graph_ret_t ftrace_graph_return;
	473	extern trace_func_graph_ent_t ftrace_graph_entry;
caf4b323	474
fb52607a	475	extern void unregister_ftrace_graph(void);
f201ae23	476
fb52607a FW	477	extern void ftrace_graph_init_task(struct task_struct *t);
fb52607a FW	478	extern void ftrace_graph_exit_task(struct task_struct *t);
868baf07	479	extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
21a8c466 FW	480
	481	static inline int task_curr_ret_stack(struct task_struct *t)
	482	{
	483	return t->curr_ret_stack;
	484	}
380c4b14 FW	485
	486	static inline void pause_graph_tracing(void)
	487	{
	488	atomic_inc(&current->tracing_graph_pause);
	489	}
	490
	491	static inline void unpause_graph_tracing(void)
	492	{
	493	atomic_dec(&current->tracing_graph_pause);
	494	}
5ac9f622	495	#else /* !CONFIG_FUNCTION_GRAPH_TRACER */
8b96f011 FW	496
8b96f011 FW	497	#define __notrace_funcgraph
bcbc4f20	498	#define __irq_entry
5ac9f622	499	#define INIT_FTRACE_GRAPH
8b96f011	500
fb52607a FW	501	static inline void ftrace_graph_init_task(struct task_struct *t) { }
fb52607a FW	502	static inline void ftrace_graph_exit_task(struct task_struct *t) { }
868baf07	503	static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
21a8c466	504
62b915f1 JO	505	static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
	506	trace_func_graph_ent_t entryfunc)
	507	{
	508	return -1;
	509	}
	510	static inline void unregister_ftrace_graph(void) { }
	511
21a8c466 FW	512	static inline int task_curr_ret_stack(struct task_struct *tsk)
	513	{
	514	return -1;
	515	}
380c4b14 FW	516
	517	static inline void pause_graph_tracing(void) { }
	518	static inline void unpause_graph_tracing(void) { }
5ac9f622	519	#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
caf4b323	520
ea4e2bc4	521	#ifdef CONFIG_TRACING
ea4e2bc4 SR	522
	523	/* flags for current->trace */
	524	enum {
	525	TSK_TRACE_FL_TRACE_BIT = 0,
	526	TSK_TRACE_FL_GRAPH_BIT = 1,
	527	};
	528	enum {
	529	TSK_TRACE_FL_TRACE = 1 << TSK_TRACE_FL_TRACE_BIT,
	530	TSK_TRACE_FL_GRAPH = 1 << TSK_TRACE_FL_GRAPH_BIT,
	531	};
	532
	533	static inline void set_tsk_trace_trace(struct task_struct *tsk)
	534	{
	535	set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
	536	}
	537
	538	static inline void clear_tsk_trace_trace(struct task_struct *tsk)
	539	{
	540	clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
	541	}
	542
	543	static inline int test_tsk_trace_trace(struct task_struct *tsk)
	544	{
	545	return tsk->trace & TSK_TRACE_FL_TRACE;
	546	}
	547
	548	static inline void set_tsk_trace_graph(struct task_struct *tsk)
	549	{
	550	set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
	551	}
	552
	553	static inline void clear_tsk_trace_graph(struct task_struct *tsk)
	554	{
	555	clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
	556	}
	557
	558	static inline int test_tsk_trace_graph(struct task_struct *tsk)
	559	{
	560	return tsk->trace & TSK_TRACE_FL_GRAPH;
	561	}
	562
cecbca96 FW	563	enum ftrace_dump_mode;
	564
	565	extern enum ftrace_dump_mode ftrace_dump_on_oops;
526211bc	566
261842b7 SR	567	#ifdef CONFIG_PREEMPT
	568	#define INIT_TRACE_RECURSION .trace_recursion = 0,
	569	#endif
	570
ea4e2bc4 SR	571	#endif /* CONFIG_TRACING */
ea4e2bc4 SR	572
261842b7 SR	573	#ifndef INIT_TRACE_RECURSION
	574	#define INIT_TRACE_RECURSION
	575	#endif
b1818748	576
e7b8e675 MF	577	#ifdef CONFIG_FTRACE_SYSCALLS
	578
	579	unsigned long arch_syscall_addr(int nr);
	580
	581	#endif /* CONFIG_FTRACE_SYSCALLS */
	582
16444a8a	583	#endif /* _LINUX_FTRACE_H */