[linux-2.6-block.git] / kernel / trace / trace.h

#ifndef _LINUX_KERNEL_TRACE_H
#define _LINUX_KERNEL_TRACE_H

#include <linux/fs.h>
#include <asm/atomic.h>
#include <linux/sched.h>
#include <linux/clocksource.h>
#include <linux/ring_buffer.h>
#include <linux/mmiotrace.h>
#include <linux/ftrace.h>
#include <trace/boot.h>

enum trace_type {
	__TRACE_FIRST_TYPE = 0,

	TRACE_FN,
	TRACE_CTX,
	TRACE_WAKE,
	TRACE_STACK,
	TRACE_PRINT,
	TRACE_SPECIAL,
	TRACE_MMIO_RW,
	TRACE_MMIO_MAP,
	TRACE_BRANCH,
	TRACE_BOOT_CALL,
	TRACE_BOOT_RET,
	TRACE_GRAPH_RET,
	TRACE_GRAPH_ENT,
	TRACE_USER_STACK,
	TRACE_HW_BRANCHES,
	TRACE_POWER,

	__TRACE_LAST_TYPE
};

/*
 * The trace entry - the most basic unit of tracing. This is what
 * is printed in the end as a single line in the trace output, such as:
 *
 *     bash-15816 [01]   235.197585: idle_cpu <- irq_enter
 */
struct trace_entry {
	unsigned char		type;
	unsigned char		cpu;
	unsigned char		flags;
	unsigned char		preempt_count;
	int			pid;
	int			tgid;
};

/*
 * Function trace entry - function address and parent function addres:
 */
struct ftrace_entry {
	struct trace_entry	ent;
	unsigned long		ip;
	unsigned long		parent_ip;
};

/* Function call entry */
struct ftrace_graph_ent_entry {
	struct trace_entry			ent;
	struct ftrace_graph_ent		graph_ent;
};

/* Function return entry */
struct ftrace_graph_ret_entry {
	struct trace_entry			ent;
	struct ftrace_graph_ret		ret;
};
extern struct tracer boot_tracer;

/*
 * Context switch trace entry - which task (and prio) we switched from/to:
 */
struct ctx_switch_entry {
	struct trace_entry	ent;
	unsigned int		prev_pid;
	unsigned char		prev_prio;
	unsigned char		prev_state;
	unsigned int		next_pid;
	unsigned char		next_prio;
	unsigned char		next_state;
	unsigned int		next_cpu;
};

/*
 * Special (free-form) trace entry:
 */
struct special_entry {
	struct trace_entry	ent;
	unsigned long		arg1;
	unsigned long		arg2;
	unsigned long		arg3;
};

/*
 * Stack-trace entry:
 */

#define FTRACE_STACK_ENTRIES	8

struct stack_entry {
	struct trace_entry	ent;
	unsigned long		caller[FTRACE_STACK_ENTRIES];
};

struct userstack_entry {
	struct trace_entry	ent;
	unsigned long		caller[FTRACE_STACK_ENTRIES];
};

/*
 * ftrace_printk entry:
 */
struct print_entry {
	struct trace_entry	ent;
	unsigned long		ip;
	int			depth;
	char			buf[];
};

#define TRACE_OLD_SIZE		88

struct trace_field_cont {
	unsigned char		type;
	/* Temporary till we get rid of this completely */
	char			buf[TRACE_OLD_SIZE - 1];
};

struct trace_mmiotrace_rw {
	struct trace_entry	ent;
	struct mmiotrace_rw	rw;
};

struct trace_mmiotrace_map {
	struct trace_entry	ent;
	struct mmiotrace_map	map;
};

struct trace_boot_call {
	struct trace_entry	ent;
	struct boot_trace_call boot_call;
};

struct trace_boot_ret {
	struct trace_entry	ent;
	struct boot_trace_ret boot_ret;
};

#define TRACE_FUNC_SIZE 30
#define TRACE_FILE_SIZE 20
struct trace_branch {
	struct trace_entry	ent;
	unsigned	        line;
	char			func[TRACE_FUNC_SIZE+1];
	char			file[TRACE_FILE_SIZE+1];
	char			correct;
};

struct hw_branch_entry {
	struct trace_entry	ent;
	u64			from;
	u64			to;
};

struct trace_power {
	struct trace_entry	ent;
	struct power_trace	state_data;
};

/*
 * trace_flag_type is an enumeration that holds different
 * states when a trace occurs. These are:
 *  IRQS_OFF		- interrupts were disabled
 *  IRQS_NOSUPPORT 	- arch does not support irqs_disabled_flags
 *  NEED_RESCED		- reschedule is requested
 *  HARDIRQ		- inside an interrupt handler
 *  SOFTIRQ		- inside a softirq handler
 */
enum trace_flag_type {
	TRACE_FLAG_IRQS_OFF		= 0x01,
	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
	TRACE_FLAG_NEED_RESCHED		= 0x04,
	TRACE_FLAG_HARDIRQ		= 0x08,
	TRACE_FLAG_SOFTIRQ		= 0x10,
};

#define TRACE_BUF_SIZE		1024

/*
 * The CPU trace array - it consists of thousands of trace entries
 * plus some other descriptor data: (for example which task started
 * the trace, etc.)
 */
struct trace_array_cpu {
	atomic_t		disabled;

	/* these fields get copied into max-trace: */
	unsigned long		trace_idx;
	unsigned long		overrun;
	unsigned long		saved_latency;
	unsigned long		critical_start;
	unsigned long		critical_end;
	unsigned long		critical_sequence;
	unsigned long		nice;
	unsigned long		policy;
	unsigned long		rt_priority;
	cycle_t			preempt_timestamp;
	pid_t			pid;
	uid_t			uid;
	char			comm[TASK_COMM_LEN];
};

struct trace_iterator;

/*
 * The trace array - an array of per-CPU trace arrays. This is the
 * highest level data structure that individual tracers deal with.
 * They have on/off state as well:
 */
struct trace_array {
	struct ring_buffer	*buffer;
	unsigned long		entries;
	int			cpu;
	cycle_t			time_start;
	struct task_struct	*waiter;
	struct trace_array_cpu	*data[NR_CPUS];
};

#define FTRACE_CMP_TYPE(var, type) \
	__builtin_types_compatible_p(typeof(var), type *)

#undef IF_ASSIGN
#define IF_ASSIGN(var, entry, etype, id)		\
	if (FTRACE_CMP_TYPE(var, etype)) {		\
		var = (typeof(var))(entry);		\
		WARN_ON(id && (entry)->type != id);	\
		break;					\
	}

/* Will cause compile errors if type is not found. */
extern void __ftrace_bad_type(void);

/*
 * The trace_assign_type is a verifier that the entry type is
 * the same as the type being assigned. To add new types simply
 * add a line with the following format:
 *
 * IF_ASSIGN(var, ent, type, id);
 *
 *  Where "type" is the trace type that includes the trace_entry
 *  as the "ent" item. And "id" is the trace identifier that is
 *  used in the trace_type enum.
 *
 *  If the type can have more than one id, then use zero.
 */
#define trace_assign_type(var, ent)					\
	do {								\
		IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN);	\
		IF_ASSIGN(var, ent, struct ctx_switch_entry, 0);	\
		IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK);	\
		IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
		IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT);	\
		IF_ASSIGN(var, ent, struct special_entry, 0);		\
		IF_ASSIGN(var, ent, struct trace_mmiotrace_rw,		\
			  TRACE_MMIO_RW);				\
		IF_ASSIGN(var, ent, struct trace_mmiotrace_map,		\
			  TRACE_MMIO_MAP);				\
		IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
		IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
		IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
		IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry,	\
			  TRACE_GRAPH_ENT);		\
		IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry,	\
			  TRACE_GRAPH_RET);		\
		IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
 		IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
		__ftrace_bad_type();					\
	} while (0)

/* Return values for print_line callback */
enum print_line_t {
	TRACE_TYPE_PARTIAL_LINE	= 0,	/* Retry after flushing the seq */
	TRACE_TYPE_HANDLED	= 1,
	TRACE_TYPE_UNHANDLED	= 2	/* Relay to other output functions */
};


/*
 * An option specific to a tracer. This is a boolean value.
 * The bit is the bit index that sets its value on the
 * flags value in struct tracer_flags.
 */
struct tracer_opt {
	const char 	*name; /* Will appear on the trace_options file */
	u32 		bit; /* Mask assigned in val field in tracer_flags */
};

/*
 * The set of specific options for a tracer. Your tracer
 * have to set the initial value of the flags val.
 */
struct tracer_flags {
	u32			val;
	struct tracer_opt 	*opts;
};

/* Makes more easy to define a tracer opt */
#define TRACER_OPT(s, b)	.name = #s, .bit = b

/*
 * A specific tracer, represented by methods that operate on a trace array:
 */
struct tracer {
	const char		*name;
	/* Your tracer should raise a warning if init fails */
	int			(*init)(struct trace_array *tr);
	void			(*reset)(struct trace_array *tr);
	void			(*start)(struct trace_array *tr);
	void			(*stop)(struct trace_array *tr);
	void			(*open)(struct trace_iterator *iter);
	void			(*pipe_open)(struct trace_iterator *iter);
	void			(*close)(struct trace_iterator *iter);
	ssize_t			(*read)(struct trace_iterator *iter,
					struct file *filp, char __user *ubuf,
					size_t cnt, loff_t *ppos);
#ifdef CONFIG_FTRACE_STARTUP_TEST
	int			(*selftest)(struct tracer *trace,
					    struct trace_array *tr);
#endif
	void			(*print_header)(struct seq_file *m);
	enum print_line_t	(*print_line)(struct trace_iterator *iter);
	/* If you handled the flag setting, return 0 */
	int			(*set_flag)(u32 old_flags, u32 bit, int set);
	struct tracer		*next;
	int			print_max;
	struct tracer_flags 	*flags;
};

struct trace_seq {
	unsigned char		buffer[PAGE_SIZE];
	unsigned int		len;
	unsigned int		readpos;
};

/*
 * Trace iterator - used by printout routines who present trace
 * results to users and which routines might sleep, etc:
 */
struct trace_iterator {
	struct trace_array	*tr;
	struct tracer		*trace;
	void			*private;
	struct ring_buffer_iter	*buffer_iter[NR_CPUS];

	/* The below is zeroed out in pipe_read */
	struct trace_seq	seq;
	struct trace_entry	*ent;
	int			cpu;
	u64			ts;

	unsigned long		iter_flags;
	loff_t			pos;
	long			idx;

	cpumask_t		started;
};

int tracing_is_enabled(void);
void trace_wake_up(void);
void tracing_reset(struct trace_array *tr, int cpu);
void tracing_reset_online_cpus(struct trace_array *tr);
int tracing_open_generic(struct inode *inode, struct file *filp);
struct dentry *tracing_init_dentry(void);
void init_tracer_sysprof_debugfs(struct dentry *d_tracer);

struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
						struct trace_array_cpu *data);
void tracing_generic_entry_update(struct trace_entry *entry,
				  unsigned long flags,
				  int pc);

void ftrace(struct trace_array *tr,
			    struct trace_array_cpu *data,
			    unsigned long ip,
			    unsigned long parent_ip,
			    unsigned long flags, int pc);
void tracing_sched_switch_trace(struct trace_array *tr,
				struct trace_array_cpu *data,
				struct task_struct *prev,
				struct task_struct *next,
				unsigned long flags, int pc);
void tracing_record_cmdline(struct task_struct *tsk);

void tracing_sched_wakeup_trace(struct trace_array *tr,
				struct trace_array_cpu *data,
				struct task_struct *wakee,
				struct task_struct *cur,
				unsigned long flags, int pc);
void trace_special(struct trace_array *tr,
		   struct trace_array_cpu *data,
		   unsigned long arg1,
		   unsigned long arg2,
		   unsigned long arg3, int pc);
void trace_function(struct trace_array *tr,
		    struct trace_array_cpu *data,
		    unsigned long ip,
		    unsigned long parent_ip,
		    unsigned long flags, int pc);

void trace_graph_return(struct ftrace_graph_ret *trace);
int trace_graph_entry(struct ftrace_graph_ent *trace);
void trace_hw_branch(struct trace_array *tr, u64 from, u64 to);

void tracing_start_cmdline_record(void);
void tracing_stop_cmdline_record(void);
void tracing_sched_switch_assign_trace(struct trace_array *tr);
void tracing_stop_sched_switch_record(void);
void tracing_start_sched_switch_record(void);
int register_tracer(struct tracer *type);
void unregister_tracer(struct tracer *type);

extern unsigned long nsecs_to_usecs(unsigned long nsecs);

extern unsigned long tracing_max_latency;
extern unsigned long tracing_thresh;

void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
void update_max_tr_single(struct trace_array *tr,
			  struct task_struct *tsk, int cpu);

extern cycle_t ftrace_now(int cpu);

#ifdef CONFIG_FUNCTION_TRACER
void tracing_start_function_trace(void);
void tracing_stop_function_trace(void);
#else
# define tracing_start_function_trace()		do { } while (0)
# define tracing_stop_function_trace()		do { } while (0)
#endif

#ifdef CONFIG_CONTEXT_SWITCH_TRACER
typedef void
(*tracer_switch_func_t)(void *private,
			void *__rq,
			struct task_struct *prev,
			struct task_struct *next);

struct tracer_switch_ops {
	tracer_switch_func_t		func;
	void				*private;
	struct tracer_switch_ops	*next;
};

char *trace_find_cmdline(int pid);
#endif /* CONFIG_CONTEXT_SWITCH_TRACER */

#ifdef CONFIG_DYNAMIC_FTRACE
extern unsigned long ftrace_update_tot_cnt;
#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
extern int DYN_FTRACE_TEST_NAME(void);
#endif

#ifdef CONFIG_FTRACE_STARTUP_TEST
extern int trace_selftest_startup_function(struct tracer *trace,
					   struct trace_array *tr);
extern int trace_selftest_startup_irqsoff(struct tracer *trace,
					  struct trace_array *tr);
extern int trace_selftest_startup_preemptoff(struct tracer *trace,
					     struct trace_array *tr);
extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
						 struct trace_array *tr);
extern int trace_selftest_startup_wakeup(struct tracer *trace,
					 struct trace_array *tr);
extern int trace_selftest_startup_nop(struct tracer *trace,
					 struct trace_array *tr);
extern int trace_selftest_startup_sched_switch(struct tracer *trace,
					       struct trace_array *tr);
extern int trace_selftest_startup_sysprof(struct tracer *trace,
					       struct trace_array *tr);
extern int trace_selftest_startup_branch(struct tracer *trace,
					 struct trace_array *tr);
#endif /* CONFIG_FTRACE_STARTUP_TEST */

extern void *head_page(struct trace_array_cpu *data);
extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
extern int
seq_print_ip_sym(struct trace_seq *s, unsigned long ip,
		unsigned long sym_flags);
extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
				 size_t cnt);
extern long ns2usecs(cycle_t nsec);
extern int
trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);

extern unsigned long trace_flags;

/* Standard output formatting function used for function return traces */
#ifdef CONFIG_FUNCTION_GRAPH_TRACER
extern enum print_line_t print_graph_function(struct trace_iterator *iter);

#ifdef CONFIG_DYNAMIC_FTRACE
/* TODO: make this variable */
#define FTRACE_GRAPH_MAX_FUNCS		32
extern int ftrace_graph_count;
extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];

static inline int ftrace_graph_addr(unsigned long addr)
{
	int i;

	if (!ftrace_graph_count || test_tsk_trace_graph(current))
		return 1;

	for (i = 0; i < ftrace_graph_count; i++) {
		if (addr == ftrace_graph_funcs[i])
			return 1;
	}

	return 0;
}
#else
static inline int ftrace_trace_addr(unsigned long addr)
{
	return 1;
}
static inline int ftrace_graph_addr(unsigned long addr)
{
	return 1;
}
#endif /* CONFIG_DYNAMIC_FTRACE */

#else /* CONFIG_FUNCTION_GRAPH_TRACER */
static inline enum print_line_t
print_graph_function(struct trace_iterator *iter)
{
	return TRACE_TYPE_UNHANDLED;
}
#endif /* CONFIG_FUNCTION_GRAPH_TRACER */

extern struct pid *ftrace_pid_trace;

static inline int ftrace_trace_task(struct task_struct *task)
{
	if (!ftrace_pid_trace)
		return 1;

	return test_tsk_trace_trace(task);
}

/*
 * trace_iterator_flags is an enumeration that defines bit
 * positions into trace_flags that controls the output.
 *
 * NOTE: These bits must match the trace_options array in
 *       trace.c.
 */
enum trace_iterator_flags {
	TRACE_ITER_PRINT_PARENT		= 0x01,
	TRACE_ITER_SYM_OFFSET		= 0x02,
	TRACE_ITER_SYM_ADDR		= 0x04,
	TRACE_ITER_VERBOSE		= 0x08,
	TRACE_ITER_RAW			= 0x10,
	TRACE_ITER_HEX			= 0x20,
	TRACE_ITER_BIN			= 0x40,
	TRACE_ITER_BLOCK		= 0x80,
	TRACE_ITER_STACKTRACE		= 0x100,
	TRACE_ITER_SCHED_TREE		= 0x200,
	TRACE_ITER_PRINTK		= 0x400,
	TRACE_ITER_PREEMPTONLY		= 0x800,
	TRACE_ITER_BRANCH		= 0x1000,
	TRACE_ITER_ANNOTATE		= 0x2000,
	TRACE_ITER_USERSTACKTRACE       = 0x4000,
	TRACE_ITER_SYM_USEROBJ          = 0x8000,
	TRACE_ITER_PRINTK_MSGONLY	= 0x10000
};

/*
 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
 * control the output of kernel symbols.
 */
#define TRACE_ITER_SYM_MASK \
	(TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)

extern struct tracer nop_trace;

/**
 * ftrace_preempt_disable - disable preemption scheduler safe
 *
 * When tracing can happen inside the scheduler, there exists
 * cases that the tracing might happen before the need_resched
 * flag is checked. If this happens and the tracer calls
 * preempt_enable (after a disable), a schedule might take place
 * causing an infinite recursion.
 *
 * To prevent this, we read the need_recshed flag before
 * disabling preemption. When we want to enable preemption we
 * check the flag, if it is set, then we call preempt_enable_no_resched.
 * Otherwise, we call preempt_enable.
 *
 * The rational for doing the above is that if need resched is set
 * and we have yet to reschedule, we are either in an atomic location
 * (where we do not need to check for scheduling) or we are inside
 * the scheduler and do not want to resched.
 */
static inline int ftrace_preempt_disable(void)
{
	int resched;

	resched = need_resched();
	preempt_disable_notrace();

	return resched;
}

/**
 * ftrace_preempt_enable - enable preemption scheduler safe
 * @resched: the return value from ftrace_preempt_disable
 *
 * This is a scheduler safe way to enable preemption and not miss
 * any preemption checks. The disabled saved the state of preemption.
 * If resched is set, then we were either inside an atomic or
 * are inside the scheduler (we would have already scheduled
 * otherwise). In this case, we do not want to call normal
 * preempt_enable, but preempt_enable_no_resched instead.
 */
static inline void ftrace_preempt_enable(int resched)
{
	if (resched)
		preempt_enable_no_resched_notrace();
	else
		preempt_enable_notrace();
}

#ifdef CONFIG_BRANCH_TRACER
extern int enable_branch_tracing(struct trace_array *tr);
extern void disable_branch_tracing(void);
static inline int trace_branch_enable(struct trace_array *tr)
{
	if (trace_flags & TRACE_ITER_BRANCH)
		return enable_branch_tracing(tr);
	return 0;
}
static inline void trace_branch_disable(void)
{
	/* due to races, always disable */
	disable_branch_tracing();
}
#else
static inline int trace_branch_enable(struct trace_array *tr)
{
	return 0;
}
static inline void trace_branch_disable(void)
{
}
#endif /* CONFIG_BRANCH_TRACER */

#endif /* _LINUX_KERNEL_TRACE_H */
Commit	Line	Data
	1	#ifndef _LINUX_KERNEL_TRACE_H
	2	#define _LINUX_KERNEL_TRACE_H
	3
	4	#include <linux/fs.h>
	5	#include <asm/atomic.h>
	6	#include <linux/sched.h>
	7	#include <linux/clocksource.h>
	8	#include <linux/ring_buffer.h>
	9	#include <linux/mmiotrace.h>
	10	#include <linux/ftrace.h>
	11	#include <trace/boot.h>
	12
	13	enum trace_type {
	14	__TRACE_FIRST_TYPE = 0,
	15
	16	TRACE_FN,
	17	TRACE_CTX,
	18	TRACE_WAKE,
	19	TRACE_STACK,
	20	TRACE_PRINT,
	21	TRACE_SPECIAL,
	22	TRACE_MMIO_RW,
	23	TRACE_MMIO_MAP,
	24	TRACE_BRANCH,
	25	TRACE_BOOT_CALL,
	26	TRACE_BOOT_RET,
	27	TRACE_GRAPH_RET,
	28	TRACE_GRAPH_ENT,
	29	TRACE_USER_STACK,
	30	TRACE_HW_BRANCHES,
	31	TRACE_POWER,
	32
	33	__TRACE_LAST_TYPE
	34	};
	35
	36	/*
	37	* The trace entry - the most basic unit of tracing. This is what
	38	* is printed in the end as a single line in the trace output, such as:
	39	*
	40	* bash-15816 [01] 235.197585: idle_cpu <- irq_enter
	41	*/
	42	struct trace_entry {
	43	unsigned char type;
	44	unsigned char cpu;
	45	unsigned char flags;
	46	unsigned char preempt_count;
	47	int pid;
	48	int tgid;
	49	};
	50
	51	/*
	52	* Function trace entry - function address and parent function addres:
	53	*/
	54	struct ftrace_entry {
	55	struct trace_entry ent;
	56	unsigned long ip;
	57	unsigned long parent_ip;
	58	};
	59
	60	/* Function call entry */
	61	struct ftrace_graph_ent_entry {
	62	struct trace_entry ent;
	63	struct ftrace_graph_ent graph_ent;
	64	};
	65
	66	/* Function return entry */
	67	struct ftrace_graph_ret_entry {
	68	struct trace_entry ent;
	69	struct ftrace_graph_ret ret;
	70	};
	71	extern struct tracer boot_tracer;
	72
	73	/*
	74	* Context switch trace entry - which task (and prio) we switched from/to:
	75	*/
	76	struct ctx_switch_entry {
	77	struct trace_entry ent;
	78	unsigned int prev_pid;
	79	unsigned char prev_prio;
	80	unsigned char prev_state;
	81	unsigned int next_pid;
	82	unsigned char next_prio;
	83	unsigned char next_state;
	84	unsigned int next_cpu;
	85	};
	86
	87	/*
	88	* Special (free-form) trace entry:
	89	*/
	90	struct special_entry {
	91	struct trace_entry ent;
	92	unsigned long arg1;
	93	unsigned long arg2;
	94	unsigned long arg3;
	95	};
	96
	97	/*
	98	* Stack-trace entry:
	99	*/
	100
	101	#define FTRACE_STACK_ENTRIES 8
	102
	103	struct stack_entry {
	104	struct trace_entry ent;
	105	unsigned long caller[FTRACE_STACK_ENTRIES];
	106	};
	107
	108	struct userstack_entry {
	109	struct trace_entry ent;
	110	unsigned long caller[FTRACE_STACK_ENTRIES];
	111	};
	112
	113	/*
	114	* ftrace_printk entry:
	115	*/
	116	struct print_entry {
	117	struct trace_entry ent;
	118	unsigned long ip;
	119	int depth;
	120	char buf[];
	121	};
	122
	123	#define TRACE_OLD_SIZE 88
	124
	125	struct trace_field_cont {
	126	unsigned char type;
	127	/* Temporary till we get rid of this completely */
	128	char buf[TRACE_OLD_SIZE - 1];
	129	};
	130
	131	struct trace_mmiotrace_rw {
	132	struct trace_entry ent;
	133	struct mmiotrace_rw rw;
	134	};
	135
	136	struct trace_mmiotrace_map {
	137	struct trace_entry ent;
	138	struct mmiotrace_map map;
	139	};
	140
	141	struct trace_boot_call {
	142	struct trace_entry ent;
	143	struct boot_trace_call boot_call;
	144	};
	145
	146	struct trace_boot_ret {
	147	struct trace_entry ent;
	148	struct boot_trace_ret boot_ret;
	149	};
	150
	151	#define TRACE_FUNC_SIZE 30
	152	#define TRACE_FILE_SIZE 20
	153	struct trace_branch {
	154	struct trace_entry ent;
	155	unsigned line;
	156	char func[TRACE_FUNC_SIZE+1];
	157	char file[TRACE_FILE_SIZE+1];
	158	char correct;
	159	};
	160
	161	struct hw_branch_entry {
	162	struct trace_entry ent;
	163	u64 from;
	164	u64 to;
	165	};
	166
	167	struct trace_power {
	168	struct trace_entry ent;
	169	struct power_trace state_data;
	170	};
	171
	172	/*
	173	* trace_flag_type is an enumeration that holds different
	174	* states when a trace occurs. These are:
	175	* IRQS_OFF - interrupts were disabled
	176	* IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
	177	* NEED_RESCED - reschedule is requested
	178	* HARDIRQ - inside an interrupt handler
	179	* SOFTIRQ - inside a softirq handler
	180	*/
	181	enum trace_flag_type {
	182	TRACE_FLAG_IRQS_OFF = 0x01,
	183	TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
	184	TRACE_FLAG_NEED_RESCHED = 0x04,
	185	TRACE_FLAG_HARDIRQ = 0x08,
	186	TRACE_FLAG_SOFTIRQ = 0x10,
	187	};
	188
	189	#define TRACE_BUF_SIZE 1024
	190
	191	/*
	192	* The CPU trace array - it consists of thousands of trace entries
	193	* plus some other descriptor data: (for example which task started
	194	* the trace, etc.)
	195	*/
	196	struct trace_array_cpu {
	197	atomic_t disabled;
	198
	199	/* these fields get copied into max-trace: */
	200	unsigned long trace_idx;
	201	unsigned long overrun;
	202	unsigned long saved_latency;
	203	unsigned long critical_start;
	204	unsigned long critical_end;
	205	unsigned long critical_sequence;
	206	unsigned long nice;
	207	unsigned long policy;
	208	unsigned long rt_priority;
	209	cycle_t preempt_timestamp;
	210	pid_t pid;
	211	uid_t uid;
	212	char comm[TASK_COMM_LEN];
	213	};
	214
	215	struct trace_iterator;
	216
	217	/*
	218	* The trace array - an array of per-CPU trace arrays. This is the
	219	* highest level data structure that individual tracers deal with.
	220	* They have on/off state as well:
	221	*/
	222	struct trace_array {
	223	struct ring_buffer *buffer;
	224	unsigned long entries;
	225	int cpu;
	226	cycle_t time_start;
	227	struct task_struct *waiter;
	228	struct trace_array_cpu *data[NR_CPUS];
	229	};
	230
	231	#define FTRACE_CMP_TYPE(var, type) \
	232	__builtin_types_compatible_p(typeof(var), type *)
	233
	234	#undef IF_ASSIGN
	235	#define IF_ASSIGN(var, entry, etype, id) \
	236	if (FTRACE_CMP_TYPE(var, etype)) { \
	237	var = (typeof(var))(entry); \
	238	WARN_ON(id && (entry)->type != id); \
	239	break; \
	240	}
	241
	242	/* Will cause compile errors if type is not found. */
	243	extern void __ftrace_bad_type(void);
	244
	245	/*
	246	* The trace_assign_type is a verifier that the entry type is
	247	* the same as the type being assigned. To add new types simply
	248	* add a line with the following format:
	249	*
	250	* IF_ASSIGN(var, ent, type, id);
	251	*
	252	* Where "type" is the trace type that includes the trace_entry
	253	* as the "ent" item. And "id" is the trace identifier that is
	254	* used in the trace_type enum.
	255	*
	256	* If the type can have more than one id, then use zero.
	257	*/
	258	#define trace_assign_type(var, ent) \
	259	do { \
	260	IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
	261	IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
	262	IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
	263	IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
	264	IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
	265	IF_ASSIGN(var, ent, struct special_entry, 0); \
	266	IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
	267	TRACE_MMIO_RW); \
	268	IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
	269	TRACE_MMIO_MAP); \
	270	IF_ASSIGN(var, ent, struct trace_boot_call, TRACE_BOOT_CALL);\
	271	IF_ASSIGN(var, ent, struct trace_boot_ret, TRACE_BOOT_RET);\
	272	IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
	273	IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
	274	TRACE_GRAPH_ENT); \
	275	IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
	276	TRACE_GRAPH_RET); \
	277	IF_ASSIGN(var, ent, struct hw_branch_entry, TRACE_HW_BRANCHES);\
	278	IF_ASSIGN(var, ent, struct trace_power, TRACE_POWER); \
	279	__ftrace_bad_type(); \
	280	} while (0)
	281
	282	/* Return values for print_line callback */
	283	enum print_line_t {
	284	TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
	285	TRACE_TYPE_HANDLED = 1,
	286	TRACE_TYPE_UNHANDLED = 2 /* Relay to other output functions */
	287	};
	288
	289
	290	/*
	291	* An option specific to a tracer. This is a boolean value.
	292	* The bit is the bit index that sets its value on the
	293	* flags value in struct tracer_flags.
	294	*/
	295	struct tracer_opt {
	296	const char name; / Will appear on the trace_options file */
	297	u32 bit; /* Mask assigned in val field in tracer_flags */
	298	};
	299
	300	/*
	301	* The set of specific options for a tracer. Your tracer
	302	* have to set the initial value of the flags val.
	303	*/
	304	struct tracer_flags {
	305	u32 val;
	306	struct tracer_opt *opts;
	307	};
	308
	309	/* Makes more easy to define a tracer opt */
	310	#define TRACER_OPT(s, b) .name = #s, .bit = b
	311
	312	/*
	313	* A specific tracer, represented by methods that operate on a trace array:
	314	*/
	315	struct tracer {
	316	const char *name;
	317	/* Your tracer should raise a warning if init fails */
	318	int (init)(struct trace_array tr);
	319	void (reset)(struct trace_array tr);
	320	void (start)(struct trace_array tr);
	321	void (stop)(struct trace_array tr);
	322	void (open)(struct trace_iterator iter);
	323	void (pipe_open)(struct trace_iterator iter);
	324	void (close)(struct trace_iterator iter);
	325	ssize_t (read)(struct trace_iterator iter,
	326	struct file filp, char __user ubuf,
	327	size_t cnt, loff_t *ppos);
	328	#ifdef CONFIG_FTRACE_STARTUP_TEST
	329	int (selftest)(struct tracer trace,
	330	struct trace_array *tr);
	331	#endif
	332	void (print_header)(struct seq_file m);
	333	enum print_line_t (print_line)(struct trace_iterator iter);
	334	/* If you handled the flag setting, return 0 */
	335	int (*set_flag)(u32 old_flags, u32 bit, int set);
	336	struct tracer *next;
	337	int print_max;
	338	struct tracer_flags *flags;
	339	};
	340
	341	struct trace_seq {
	342	unsigned char buffer[PAGE_SIZE];
	343	unsigned int len;
	344	unsigned int readpos;
	345	};
	346
	347	/*
	348	* Trace iterator - used by printout routines who present trace
	349	* results to users and which routines might sleep, etc:
	350	*/
	351	struct trace_iterator {
	352	struct trace_array *tr;
	353	struct tracer *trace;
	354	void *private;
	355	struct ring_buffer_iter *buffer_iter[NR_CPUS];
	356
	357	/* The below is zeroed out in pipe_read */
	358	struct trace_seq seq;
	359	struct trace_entry *ent;
	360	int cpu;
	361	u64 ts;
	362
	363	unsigned long iter_flags;
	364	loff_t pos;
	365	long idx;
	366
	367	cpumask_t started;
	368	};
	369
	370	int tracing_is_enabled(void);
	371	void trace_wake_up(void);
	372	void tracing_reset(struct trace_array *tr, int cpu);
	373	void tracing_reset_online_cpus(struct trace_array *tr);
	374	int tracing_open_generic(struct inode inode, struct file filp);
	375	struct dentry *tracing_init_dentry(void);
	376	void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
	377
	378	struct trace_entry tracing_get_trace_entry(struct trace_array tr,
	379	struct trace_array_cpu *data);
	380	void tracing_generic_entry_update(struct trace_entry *entry,
	381	unsigned long flags,
	382	int pc);
	383
	384	void ftrace(struct trace_array *tr,
	385	struct trace_array_cpu *data,
	386	unsigned long ip,
	387	unsigned long parent_ip,
	388	unsigned long flags, int pc);
	389	void tracing_sched_switch_trace(struct trace_array *tr,
	390	struct trace_array_cpu *data,
	391	struct task_struct *prev,
	392	struct task_struct *next,
	393	unsigned long flags, int pc);
	394	void tracing_record_cmdline(struct task_struct *tsk);
	395
	396	void tracing_sched_wakeup_trace(struct trace_array *tr,
	397	struct trace_array_cpu *data,
	398	struct task_struct *wakee,
	399	struct task_struct *cur,
	400	unsigned long flags, int pc);
	401	void trace_special(struct trace_array *tr,
	402	struct trace_array_cpu *data,
	403	unsigned long arg1,
	404	unsigned long arg2,
	405	unsigned long arg3, int pc);
	406	void trace_function(struct trace_array *tr,
	407	struct trace_array_cpu *data,
	408	unsigned long ip,
	409	unsigned long parent_ip,
	410	unsigned long flags, int pc);
	411
	412	void trace_graph_return(struct ftrace_graph_ret *trace);
	413	int trace_graph_entry(struct ftrace_graph_ent *trace);
	414	void trace_hw_branch(struct trace_array *tr, u64 from, u64 to);
	415
	416	void tracing_start_cmdline_record(void);
	417	void tracing_stop_cmdline_record(void);
	418	void tracing_sched_switch_assign_trace(struct trace_array *tr);
	419	void tracing_stop_sched_switch_record(void);
	420	void tracing_start_sched_switch_record(void);
	421	int register_tracer(struct tracer *type);
	422	void unregister_tracer(struct tracer *type);
	423
	424	extern unsigned long nsecs_to_usecs(unsigned long nsecs);
	425
	426	extern unsigned long tracing_max_latency;
	427	extern unsigned long tracing_thresh;
	428
	429	void update_max_tr(struct trace_array tr, struct task_struct tsk, int cpu);
	430	void update_max_tr_single(struct trace_array *tr,
	431	struct task_struct *tsk, int cpu);
	432
	433	extern cycle_t ftrace_now(int cpu);
	434
	435	#ifdef CONFIG_FUNCTION_TRACER
	436	void tracing_start_function_trace(void);
	437	void tracing_stop_function_trace(void);
	438	#else
	439	# define tracing_start_function_trace() do { } while (0)
	440	# define tracing_stop_function_trace() do { } while (0)
	441	#endif
	442
	443	#ifdef CONFIG_CONTEXT_SWITCH_TRACER
	444	typedef void
	445	(tracer_switch_func_t)(void private,
	446	void *__rq,
	447	struct task_struct *prev,
	448	struct task_struct *next);
	449
	450	struct tracer_switch_ops {
	451	tracer_switch_func_t func;
	452	void *private;
	453	struct tracer_switch_ops *next;
	454	};
	455
	456	char *trace_find_cmdline(int pid);
	457	#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
	458
	459	#ifdef CONFIG_DYNAMIC_FTRACE
	460	extern unsigned long ftrace_update_tot_cnt;
	461	#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
	462	extern int DYN_FTRACE_TEST_NAME(void);
	463	#endif
	464
	465	#ifdef CONFIG_FTRACE_STARTUP_TEST
	466	extern int trace_selftest_startup_function(struct tracer *trace,
	467	struct trace_array *tr);
	468	extern int trace_selftest_startup_irqsoff(struct tracer *trace,
	469	struct trace_array *tr);
	470	extern int trace_selftest_startup_preemptoff(struct tracer *trace,
	471	struct trace_array *tr);
	472	extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
	473	struct trace_array *tr);
	474	extern int trace_selftest_startup_wakeup(struct tracer *trace,
	475	struct trace_array *tr);
	476	extern int trace_selftest_startup_nop(struct tracer *trace,
	477	struct trace_array *tr);
	478	extern int trace_selftest_startup_sched_switch(struct tracer *trace,
	479	struct trace_array *tr);
	480	extern int trace_selftest_startup_sysprof(struct tracer *trace,
	481	struct trace_array *tr);
	482	extern int trace_selftest_startup_branch(struct tracer *trace,
	483	struct trace_array *tr);
	484	#endif /* CONFIG_FTRACE_STARTUP_TEST */
	485
	486	extern void head_page(struct trace_array_cpu data);
	487	extern int trace_seq_printf(struct trace_seq s, const char fmt, ...);
	488	extern int
	489	seq_print_ip_sym(struct trace_seq *s, unsigned long ip,
	490	unsigned long sym_flags);
	491	extern ssize_t trace_seq_to_user(struct trace_seq s, char __user ubuf,
	492	size_t cnt);
	493	extern long ns2usecs(cycle_t nsec);
	494	extern int
	495	trace_vprintk(unsigned long ip, int depth, const char *fmt, va_list args);
	496
	497	extern unsigned long trace_flags;
	498
	499	/* Standard output formatting function used for function return traces */
	500	#ifdef CONFIG_FUNCTION_GRAPH_TRACER
	501	extern enum print_line_t print_graph_function(struct trace_iterator *iter);
	502
	503	#ifdef CONFIG_DYNAMIC_FTRACE
	504	/* TODO: make this variable */
	505	#define FTRACE_GRAPH_MAX_FUNCS 32
	506	extern int ftrace_graph_count;
	507	extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
	508
	509	static inline int ftrace_graph_addr(unsigned long addr)
	510	{
	511	int i;
	512
	513	if (!ftrace_graph_count \|\| test_tsk_trace_graph(current))
	514	return 1;
	515
	516	for (i = 0; i < ftrace_graph_count; i++) {
	517	if (addr == ftrace_graph_funcs[i])
	518	return 1;
	519	}
	520
	521	return 0;
	522	}
	523	#else
	524	static inline int ftrace_trace_addr(unsigned long addr)
	525	{
	526	return 1;
	527	}
	528	static inline int ftrace_graph_addr(unsigned long addr)
	529	{
	530	return 1;
	531	}
	532	#endif /* CONFIG_DYNAMIC_FTRACE */
	533
	534	#else /* CONFIG_FUNCTION_GRAPH_TRACER */
	535	static inline enum print_line_t
	536	print_graph_function(struct trace_iterator *iter)
	537	{
	538	return TRACE_TYPE_UNHANDLED;
	539	}
	540	#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
	541
	542	extern struct pid *ftrace_pid_trace;
	543
	544	static inline int ftrace_trace_task(struct task_struct *task)
	545	{
	546	if (!ftrace_pid_trace)
	547	return 1;
	548
	549	return test_tsk_trace_trace(task);
	550	}
	551
	552	/*
	553	* trace_iterator_flags is an enumeration that defines bit
	554	* positions into trace_flags that controls the output.
	555	*
	556	* NOTE: These bits must match the trace_options array in
	557	* trace.c.
	558	*/
	559	enum trace_iterator_flags {
	560	TRACE_ITER_PRINT_PARENT = 0x01,
	561	TRACE_ITER_SYM_OFFSET = 0x02,
	562	TRACE_ITER_SYM_ADDR = 0x04,
	563	TRACE_ITER_VERBOSE = 0x08,
	564	TRACE_ITER_RAW = 0x10,
	565	TRACE_ITER_HEX = 0x20,
	566	TRACE_ITER_BIN = 0x40,
	567	TRACE_ITER_BLOCK = 0x80,
	568	TRACE_ITER_STACKTRACE = 0x100,
	569	TRACE_ITER_SCHED_TREE = 0x200,
	570	TRACE_ITER_PRINTK = 0x400,
	571	TRACE_ITER_PREEMPTONLY = 0x800,
	572	TRACE_ITER_BRANCH = 0x1000,
	573	TRACE_ITER_ANNOTATE = 0x2000,
	574	TRACE_ITER_USERSTACKTRACE = 0x4000,
	575	TRACE_ITER_SYM_USEROBJ = 0x8000,
	576	TRACE_ITER_PRINTK_MSGONLY = 0x10000
	577	};
	578
	579	/*
	580	* TRACE_ITER_SYM_MASK masks the options in trace_flags that
	581	* control the output of kernel symbols.
	582	*/
	583	#define TRACE_ITER_SYM_MASK \
	584	(TRACE_ITER_PRINT_PARENT\|TRACE_ITER_SYM_OFFSET\|TRACE_ITER_SYM_ADDR)
	585
	586	extern struct tracer nop_trace;
	587
	588	/**
	589	* ftrace_preempt_disable - disable preemption scheduler safe
	590	*
	591	* When tracing can happen inside the scheduler, there exists
	592	* cases that the tracing might happen before the need_resched
	593	* flag is checked. If this happens and the tracer calls
	594	* preempt_enable (after a disable), a schedule might take place
	595	* causing an infinite recursion.
	596	*
	597	* To prevent this, we read the need_recshed flag before
	598	* disabling preemption. When we want to enable preemption we
	599	* check the flag, if it is set, then we call preempt_enable_no_resched.
	600	* Otherwise, we call preempt_enable.
	601	*
	602	* The rational for doing the above is that if need resched is set
	603	* and we have yet to reschedule, we are either in an atomic location
	604	* (where we do not need to check for scheduling) or we are inside
	605	* the scheduler and do not want to resched.
	606	*/
	607	static inline int ftrace_preempt_disable(void)
	608	{
	609	int resched;
	610
	611	resched = need_resched();
	612	preempt_disable_notrace();
	613
	614	return resched;
	615	}
	616
	617	/**
	618	* ftrace_preempt_enable - enable preemption scheduler safe
	619	* @resched: the return value from ftrace_preempt_disable
	620	*
	621	* This is a scheduler safe way to enable preemption and not miss
	622	* any preemption checks. The disabled saved the state of preemption.
	623	* If resched is set, then we were either inside an atomic or
	624	* are inside the scheduler (we would have already scheduled
	625	* otherwise). In this case, we do not want to call normal
	626	* preempt_enable, but preempt_enable_no_resched instead.
	627	*/
	628	static inline void ftrace_preempt_enable(int resched)
	629	{
	630	if (resched)
	631	preempt_enable_no_resched_notrace();
	632	else
	633	preempt_enable_notrace();
	634	}
	635
	636	#ifdef CONFIG_BRANCH_TRACER
	637	extern int enable_branch_tracing(struct trace_array *tr);
	638	extern void disable_branch_tracing(void);
	639	static inline int trace_branch_enable(struct trace_array *tr)
	640	{
	641	if (trace_flags & TRACE_ITER_BRANCH)
	642	return enable_branch_tracing(tr);
	643	return 0;
	644	}
	645	static inline void trace_branch_disable(void)
	646	{
	647	/* due to races, always disable */
	648	disable_branch_tracing();
	649	}
	650	#else
	651	static inline int trace_branch_enable(struct trace_array *tr)
	652	{
	653	return 0;
	654	}
	655	static inline void trace_branch_disable(void)
	656	{
	657	}
	658	#endif /* CONFIG_BRANCH_TRACER */
	659
	660	#endif /* _LINUX_KERNEL_TRACE_H */