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

#ifndef _LINUX_FTRACE_H
#define _LINUX_FTRACE_H

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

#ifdef CONFIG_FUNCTION_TRACER

extern int ftrace_enabled;
extern int
ftrace_enable_sysctl(struct ctl_table *table, int write,
		     struct file *filp, 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,
		   struct file *file, 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
/* asm/ftrace.h must be defined for archs supporting dynamic ftrace */
#include <asm/ftrace.h>

struct ftrace_hook_ops {
	void			(*func)(unsigned long ip,
					unsigned long parent_ip,
					void **data);
	int			(*callback)(unsigned long ip, void **data);
	void			(*free)(void **data);
};

extern int
register_ftrace_function_hook(char *glob, struct ftrace_hook_ops *ops,
			      void *data);
extern void
unregister_ftrace_function_hook(char *glob, struct ftrace_hook_ops *ops,
				void *data);
extern void
unregister_ftrace_function_hook_func(char *glob, struct ftrace_hook_ops *ops);
extern void unregister_ftrace_function_hook_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 {
	struct list_head	list;
	unsigned long		ip; /* address of mcount call-site */
	unsigned long		flags;
	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_release(void *start, unsigned long size);

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(void *start, unsigned long size) { }
static inline int register_ftrace_command(struct ftrace_func_command *cmd)
{
}
static inline int unregister_ftrace_command(char *cmd_name)
{
}
#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
}

#ifdef CONFIG_FRAME_POINTER
/* TODO: need to fix this for ARM */
# 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

#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_TRACING
extern int ftrace_dump_on_oops;

extern void tracing_start(void);
extern void tracing_stop(void);
extern void ftrace_off_permanent(void);

extern void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);

/**
 * ftrace_printk - printf formatting in the ftrace buffer
 * @fmt: the printf format for printing
 *
 * Note: __ftrace_printk is an internal function for ftrace_printk and
 *       the @ip is passed in via the ftrace_printk macro.
 *
 * This function allows a kernel developer to debug fast path sections
 * that printk is not appropriate for. By scattering in various
 * printk like tracing in the code, a developer can quickly see
 * where problems are occurring.
 *
 * This is intended as a debugging tool for the developer only.
 * Please refrain from leaving ftrace_printks scattered around in
 * your code.
 */
# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
extern int
__ftrace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
# define ftrace_vprintk(fmt, ap) __ftrace_printk(_THIS_IP_, fmt, ap)
extern int
__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
extern void ftrace_dump(void);
#else
static inline void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
static inline int
ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));

static inline void tracing_start(void) { }
static inline void tracing_stop(void) { }
static inline void ftrace_off_permanent(void) { }
static inline int
ftrace_printk(const char *fmt, ...)
{
	return 0;
}
static inline int
ftrace_vprintk(const char *fmt, va_list ap)
{
	return 0;
}
static inline void ftrace_dump(void) { }
#endif

#ifdef CONFIG_FTRACE_MCOUNT_RECORD
extern void ftrace_init(void);
extern void ftrace_init_module(struct module *mod,
			       unsigned long *start, unsigned long *end);
#else
static inline void ftrace_init(void) { }
static inline void
ftrace_init_module(struct module *mod,
		   unsigned long *start, unsigned long *end) { }
#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

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

#define __notrace_funcgraph
#define __irq_entry

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

#ifdef CONFIG_TRACING
#include <linux/sched.h>

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

#endif /* CONFIG_TRACING */


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