[deliverable/linux.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_CONT,
	TRACE_STACK,
	TRACE_PRINT,
	TRACE_SPECIAL,
	TRACE_MMIO_RW,
	TRACE_MMIO_MAP,
	TRACE_BRANCH,
	TRACE_BOOT_CALL,
	TRACE_BOOT_RET,
	TRACE_FN_RET,
	TRACE_USER_STACK,
	TRACE_BTS,

	__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 return entry */
struct ftrace_graph_entry {
	struct trace_entry	ent;
	unsigned long		ip;
	unsigned long		parent_ip;
	unsigned long long	calltime;
	unsigned long long	rettime;
	unsigned long		overrun;
};
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;
	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 bts_entry {
	struct trace_entry	ent;
	unsigned long		from;
	unsigned long		to;
};

/*
 * 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
 *  CONT		- multiple entries hold the trace item
 */
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,
	TRACE_FLAG_CONT			= 0x20,
};

#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 trace_field_cont, TRACE_CONT); \
		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_entry, TRACE_FN_RET);\
		IF_ASSIGN(var, ent, struct bts_entry, TRACE_BTS);\
		__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);
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_function_graph(struct ftrace_graph_ret *trace);

void trace_bts(struct trace_array *tr,
	       unsigned long from,
	       unsigned long 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;
};

#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 void trace_seq_print_cont(struct trace_seq *s,
				 struct trace_iterator *iter);

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, 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);
#else
static inline enum print_line_t
print_graph_function(struct trace_iterator *iter)
{
	return TRACE_TYPE_UNHANDLED;
}
#endif

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