[net-next-2.6.git] / include / linux / ftrace.h

#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/module.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>

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

struct ftrace_ops {
	ftrace_func_t	  func;
	struct ftrace_ops *next;
};

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 */
# define register_ftrace_function(ops) do { } while (0)
# define unregister_ftrace_function(ops) do { } while (0)
# define clear_ftrace_function(ops) do { } while (0)
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)(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);

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

enum {
	FTRACE_FL_FREE		= (1 << 0),
	FTRACE_FL_FAILED	= (1 << 1),
	FTRACE_FL_FILTER	= (1 << 2),
	FTRACE_FL_ENABLED	= (1 << 3),
	FTRACE_FL_NOTRACE	= (1 << 4),
	FTRACE_FL_CONVERTED	= (1 << 5),
	FTRACE_FL_FROZEN	= (1 << 6),
};

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(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);

/* 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
# define skip_trace(ip)				({ 0; })
# define ftrace_force_update()			({ 0; })
# define ftrace_set_filter(buf, len, reset)	do { } while (0)
# define ftrace_disable_daemon()		do { } while (0)
# define ftrace_enable_daemon()			do { } while (0)
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;
}
#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
# define time_hardirqs_on(a0, a1)		do { } while (0)
# define time_hardirqs_off(a0, a1)		do { } while (0)
#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
# define trace_preempt_on(a0, a1)		do { } while (0)
# define trace_preempt_off(a0, a1)		do { } while (0)
#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;
};

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

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

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

extern int 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_HW_BRANCH_TRACER

void trace_hw_branch(u64 from, u64 to);
void trace_hw_branch_oops(void);

#else /* CONFIG_HW_BRANCH_TRACER */

static inline void trace_hw_branch(u64 from, u64 to) {}
static inline void trace_hw_branch_oops(void) {}

#endif /* CONFIG_HW_BRANCH_TRACER */

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