[deliverable/linux.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>

#include <asm/ftrace.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

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

/**
 * trace_printk - printf formatting in the ftrace buffer
 * @fmt: the printf format for printing
 *
 * Note: __trace_printk is an internal function for trace_printk and
 *       the @ip is passed in via the trace_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 trace_printks scattered around in
 * your code.
 */
# define trace_printk(fmt...) __trace_printk(_THIS_IP_, fmt)
extern int
__trace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
# define ftrace_vprintk(fmt, ap) __trace_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
trace_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
trace_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

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

/*
 * 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 long time,
			 unsigned long func, int *depth);
extern void
ftrace_pop_return_trace(struct ftrace_graph_ret *trace, unsigned long *ret);

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