[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>

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

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

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

/*
 * Stack-trace entry:
 */

#define FTRACE_STACK_ENTRIES	5

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

/*
 * 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 {
	char			type;
	char			cpu;
	char			flags;
	char			preempt_count;
	int			pid;
	cycle_t			t;
	union {
		struct ftrace_entry		fn;
		struct ctx_switch_entry		ctx;
		struct special_entry		special;
		struct stack_entry		stack;
	};
};

#define TRACE_ENTRY_SIZE	sizeof(struct trace_entry)

/*
 * 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 {
	struct list_head	trace_pages;
	atomic_t		disabled;
	spinlock_t		lock;
	struct lock_class_key	lock_key;

	/* these fields get copied into max-trace: */
	unsigned		trace_head_idx;
	unsigned		trace_tail_idx;
	void			*trace_head; /* producer */
	void			*trace_tail; /* consumer */
	unsigned long		trace_idx;
	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 {
	unsigned long		entries;
	long			ctrl;
	int			cpu;
	cycle_t			time_start;
	struct task_struct	*waiter;
	struct trace_array_cpu	*data[NR_CPUS];
};

/*
 * A specific tracer, represented by methods that operate on a trace array:
 */
struct tracer {
	const char		*name;
	void			(*init)(struct trace_array *tr);
	void			(*reset)(struct trace_array *tr);
	void			(*open)(struct trace_iterator *iter);
	void			(*close)(struct trace_iterator *iter);
	void			(*start)(struct trace_iterator *iter);
	void			(*stop)(struct trace_iterator *iter);
	void			(*ctrl_update)(struct trace_array *tr);
#ifdef CONFIG_FTRACE_STARTUP_TEST
	int			(*selftest)(struct tracer *trace,
					    struct trace_array *tr);
#endif
	struct tracer		*next;
	int			print_max;
};

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

/*
 * Trace iterator - used by printout routines who present trace
 * results to users and which routines might sleep, etc:
 */
struct trace_iterator {
	struct trace_seq	seq;
	struct trace_array	*tr;
	struct tracer		*trace;

	struct trace_entry	*ent;
	int			cpu;

	struct trace_entry	*prev_ent;
	int			prev_cpu;

	unsigned long		iter_flags;
	loff_t			pos;
	unsigned long		next_idx[NR_CPUS];
	struct list_head	*next_page[NR_CPUS];
	unsigned		next_page_idx[NR_CPUS];
	long			idx;
};

void tracing_reset(struct trace_array_cpu *data);
int tracing_open_generic(struct inode *inode, struct file *filp);
struct dentry *tracing_init_dentry(void);
void ftrace(struct trace_array *tr,
			    struct trace_array_cpu *data,
			    unsigned long ip,
			    unsigned long parent_ip,
			    unsigned long flags);
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);
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);
void trace_special(struct trace_array *tr,
		   struct trace_array_cpu *data,
		   unsigned long arg1,
		   unsigned long arg2,
		   unsigned long arg3);
void trace_function(struct trace_array *tr,
		    struct trace_array_cpu *data,
		    unsigned long ip,
		    unsigned long parent_ip,
		    unsigned long flags);

void tracing_start_function_trace(void);
void tracing_stop_function_trace(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_SCHED_TRACER
extern void
wakeup_sched_switch(struct task_struct *prev, struct task_struct *next);
extern void
wakeup_sched_wakeup(struct task_struct *wakee, struct task_struct *curr);
#else
static inline void
wakeup_sched_switch(struct task_struct *prev, struct task_struct *next)
{
}
static inline void
wakeup_sched_wakeup(struct task_struct *wakee, struct task_struct *curr)
{
}
#endif

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

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

extern int register_tracer_switch(struct tracer_switch_ops *ops);
extern int unregister_tracer_switch(struct tracer_switch_ops *ops);

#endif /* CONFIG_CONTEXT_SWITCH_TRACER */

#ifdef CONFIG_DYNAMIC_FTRACE
extern unsigned long ftrace_update_tot_cnt;
#endif

#ifdef CONFIG_FTRACE_STARTUP_TEST
#ifdef CONFIG_FTRACE
extern int trace_selftest_startup_function(struct tracer *trace,
					   struct trace_array *tr);
#endif
#ifdef CONFIG_IRQSOFF_TRACER
extern int trace_selftest_startup_irqsoff(struct tracer *trace,
					  struct trace_array *tr);
#endif
#ifdef CONFIG_PREEMPT_TRACER
extern int trace_selftest_startup_preemptoff(struct tracer *trace,
					     struct trace_array *tr);
#endif
#if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
						 struct trace_array *tr);
#endif
#ifdef CONFIG_SCHED_TRACER
extern int trace_selftest_startup_wakeup(struct tracer *trace,
					 struct trace_array *tr);
#endif
#ifdef CONFIG_CONTEXT_SWITCH_TRACER
extern int trace_selftest_startup_sched_switch(struct tracer *trace,
					       struct trace_array *tr);
#endif
#endif /* CONFIG_FTRACE_STARTUP_TEST */

extern void *head_page(struct trace_array_cpu *data);

extern unsigned long trace_flags;

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

#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>
	8
	9	/*
	10	* Function trace entry - function address and parent function addres:
	11	*/
	12	struct ftrace_entry {
	13	unsigned long ip;
	14	unsigned long parent_ip;
	15	};
	16
	17	/*
	18	* Context switch trace entry - which task (and prio) we switched from/to:
	19	*/
	20	struct ctx_switch_entry {
	21	unsigned int prev_pid;
	22	unsigned char prev_prio;
	23	unsigned char prev_state;
	24	unsigned int next_pid;
	25	unsigned char next_prio;
bac524d3	26	unsigned char next_state;
bc0c38d1 SR	27	};
bc0c38d1 SR	28
f0a920d5 IM	29	/*
	30	* Special (free-form) trace entry:
	31	*/
	32	struct special_entry {
	33	unsigned long arg1;
	34	unsigned long arg2;
	35	unsigned long arg3;
	36	};
	37
86387f7e IM	38	/*
	39	* Stack-trace entry:
	40	*/
	41
	42	#define FTRACE_STACK_ENTRIES 5
	43
	44	struct stack_entry {
	45	unsigned long caller[FTRACE_STACK_ENTRIES];
	46	};
	47
bc0c38d1 SR	48	/*
	49	* The trace entry - the most basic unit of tracing. This is what
	50	* is printed in the end as a single line in the trace output, such as:
	51	*
	52	* bash-15816 [01] 235.197585: idle_cpu <- irq_enter
	53	*/
	54	struct trace_entry {
	55	char type;
	56	char cpu;
	57	char flags;
	58	char preempt_count;
	59	int pid;
	60	cycle_t t;
bc0c38d1 SR	61	union {
	62	struct ftrace_entry fn;
	63	struct ctx_switch_entry ctx;
f0a920d5	64	struct special_entry special;
86387f7e	65	struct stack_entry stack;
bc0c38d1 SR	66	};
	67	};
	68
	69	#define TRACE_ENTRY_SIZE sizeof(struct trace_entry)
	70
	71	/*
	72	* The CPU trace array - it consists of thousands of trace entries
	73	* plus some other descriptor data: (for example which task started
	74	* the trace, etc.)
	75	*/
	76	struct trace_array_cpu {
4c11d7ae	77	struct list_head trace_pages;
bc0c38d1	78	atomic_t disabled;
b3806b43	79	spinlock_t lock;
d4c5a2f5	80	struct lock_class_key lock_key;
4e3c3333	81
c7aafc54	82	/* these fields get copied into max-trace: */
93a588f4 SR	83	unsigned trace_head_idx;
	84	unsigned trace_tail_idx;
	85	void trace_head; / producer */
	86	void trace_tail; / consumer */
c7aafc54	87	unsigned long trace_idx;
bc0c38d1 SR	88	unsigned long saved_latency;
	89	unsigned long critical_start;
	90	unsigned long critical_end;
	91	unsigned long critical_sequence;
	92	unsigned long nice;
	93	unsigned long policy;
	94	unsigned long rt_priority;
	95	cycle_t preempt_timestamp;
	96	pid_t pid;
	97	uid_t uid;
	98	char comm[TASK_COMM_LEN];
	99	};
	100
	101	struct trace_iterator;
	102
	103	/*
	104	* The trace array - an array of per-CPU trace arrays. This is the
	105	* highest level data structure that individual tracers deal with.
	106	* They have on/off state as well:
	107	*/
	108	struct trace_array {
	109	unsigned long entries;
	110	long ctrl;
	111	int cpu;
	112	cycle_t time_start;
b3806b43	113	struct task_struct *waiter;
bc0c38d1 SR	114	struct trace_array_cpu *data[NR_CPUS];
	115	};
	116
	117	/*
	118	* A specific tracer, represented by methods that operate on a trace array:
	119	*/
	120	struct tracer {
	121	const char *name;
	122	void (init)(struct trace_array tr);
	123	void (reset)(struct trace_array tr);
	124	void (open)(struct trace_iterator iter);
	125	void (close)(struct trace_iterator iter);
	126	void (start)(struct trace_iterator iter);
	127	void (stop)(struct trace_iterator iter);
	128	void (ctrl_update)(struct trace_array tr);
60a11774 SR	129	#ifdef CONFIG_FTRACE_STARTUP_TEST
	130	int (selftest)(struct tracer trace,
	131	struct trace_array *tr);
	132	#endif
bc0c38d1 SR	133	struct tracer *next;
	134	int print_max;
	135	};
	136
214023c3 SR	137	struct trace_seq {
	138	unsigned char buffer[PAGE_SIZE];
	139	unsigned int len;
	140	};
	141
bc0c38d1 SR	142	/*
	143	* Trace iterator - used by printout routines who present trace
	144	* results to users and which routines might sleep, etc:
	145	*/
	146	struct trace_iterator {
214023c3	147	struct trace_seq seq;
bc0c38d1 SR	148	struct trace_array *tr;
bc0c38d1 SR	149	struct tracer *trace;
4e3c3333	150
bc0c38d1	151	struct trace_entry *ent;
4e3c3333 IM	152	int cpu;
	153
	154	struct trace_entry *prev_ent;
	155	int prev_cpu;
	156
bc0c38d1 SR	157	unsigned long iter_flags;
	158	loff_t pos;
	159	unsigned long next_idx[NR_CPUS];
4c11d7ae SR	160	struct list_head *next_page[NR_CPUS];
	161	unsigned next_page_idx[NR_CPUS];
	162	long idx;
bc0c38d1 SR	163	};
bc0c38d1 SR	164
e309b41d	165	void tracing_reset(struct trace_array_cpu *data);
bc0c38d1 SR	166	int tracing_open_generic(struct inode inode, struct file filp);
	167	struct dentry *tracing_init_dentry(void);
	168	void ftrace(struct trace_array *tr,
	169	struct trace_array_cpu *data,
	170	unsigned long ip,
	171	unsigned long parent_ip,
	172	unsigned long flags);
	173	void tracing_sched_switch_trace(struct trace_array *tr,
	174	struct trace_array_cpu *data,
	175	struct task_struct *prev,
	176	struct task_struct *next,
	177	unsigned long flags);
	178	void tracing_record_cmdline(struct task_struct *tsk);
57422797 IM	179
	180	void tracing_sched_wakeup_trace(struct trace_array *tr,
	181	struct trace_array_cpu *data,
	182	struct task_struct *wakee,
	183	struct task_struct *cur,
	184	unsigned long flags);
f0a920d5 IM	185	void trace_special(struct trace_array *tr,
	186	struct trace_array_cpu *data,
	187	unsigned long arg1,
	188	unsigned long arg2,
	189	unsigned long arg3);
6fb44b71 SR	190	void trace_function(struct trace_array *tr,
	191	struct trace_array_cpu *data,
	192	unsigned long ip,
	193	unsigned long parent_ip,
	194	unsigned long flags);
bc0c38d1 SR	195
	196	void tracing_start_function_trace(void);
	197	void tracing_stop_function_trace(void);
	198	int register_tracer(struct tracer *type);
	199	void unregister_tracer(struct tracer *type);
	200
	201	extern unsigned long nsecs_to_usecs(unsigned long nsecs);
	202
	203	extern unsigned long tracing_max_latency;
	204	extern unsigned long tracing_thresh;
	205
	206	void update_max_tr(struct trace_array tr, struct task_struct tsk, int cpu);
	207	void update_max_tr_single(struct trace_array *tr,
	208	struct task_struct *tsk, int cpu);
	209
e309b41d	210	extern cycle_t ftrace_now(int cpu);
bc0c38d1 SR	211
bc0c38d1 SR	212	#ifdef CONFIG_SCHED_TRACER
e309b41d	213	extern void
bc0c38d1	214	wakeup_sched_switch(struct task_struct prev, struct task_struct next);
57422797 IM	215	extern void
57422797 IM	216	wakeup_sched_wakeup(struct task_struct wakee, struct task_struct curr);
bc0c38d1 SR	217	#else
	218	static inline void
	219	wakeup_sched_switch(struct task_struct prev, struct task_struct next)
	220	{
	221	}
57422797 IM	222	static inline void
	223	wakeup_sched_wakeup(struct task_struct wakee, struct task_struct curr)
	224	{
	225	}
bc0c38d1 SR	226	#endif
	227
	228	#ifdef CONFIG_CONTEXT_SWITCH_TRACER
	229	typedef void
	230	(tracer_switch_func_t)(void private,
	231	struct task_struct *prev,
	232	struct task_struct *next);
	233
	234	struct tracer_switch_ops {
	235	tracer_switch_func_t func;
	236	void *private;
	237	struct tracer_switch_ops *next;
	238	};
	239
	240	extern int register_tracer_switch(struct tracer_switch_ops *ops);
	241	extern int unregister_tracer_switch(struct tracer_switch_ops *ops);
	242
	243	#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
	244
	245	#ifdef CONFIG_DYNAMIC_FTRACE
	246	extern unsigned long ftrace_update_tot_cnt;
	247	#endif
	248
60a11774 SR	249	#ifdef CONFIG_FTRACE_STARTUP_TEST
	250	#ifdef CONFIG_FTRACE
	251	extern int trace_selftest_startup_function(struct tracer *trace,
	252	struct trace_array *tr);
	253	#endif
	254	#ifdef CONFIG_IRQSOFF_TRACER
	255	extern int trace_selftest_startup_irqsoff(struct tracer *trace,
	256	struct trace_array *tr);
	257	#endif
	258	#ifdef CONFIG_PREEMPT_TRACER
	259	extern int trace_selftest_startup_preemptoff(struct tracer *trace,
	260	struct trace_array *tr);
	261	#endif
	262	#if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
	263	extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
	264	struct trace_array *tr);
	265	#endif
	266	#ifdef CONFIG_SCHED_TRACER
	267	extern int trace_selftest_startup_wakeup(struct tracer *trace,
	268	struct trace_array *tr);
	269	#endif
	270	#ifdef CONFIG_CONTEXT_SWITCH_TRACER
	271	extern int trace_selftest_startup_sched_switch(struct tracer *trace,
	272	struct trace_array *tr);
	273	#endif
	274	#endif /* CONFIG_FTRACE_STARTUP_TEST */
	275
c7aafc54 IM	276	extern void head_page(struct trace_array_cpu data);
c7aafc54 IM	277
4e655519 IM	278	extern unsigned long trace_flags;
	279
	280	enum trace_iterator_flags {
	281	TRACE_ITER_PRINT_PARENT = 0x01,
	282	TRACE_ITER_SYM_OFFSET = 0x02,
	283	TRACE_ITER_SYM_ADDR = 0x04,
	284	TRACE_ITER_VERBOSE = 0x08,
	285	TRACE_ITER_RAW = 0x10,
	286	TRACE_ITER_HEX = 0x20,
	287	TRACE_ITER_BIN = 0x40,
	288	TRACE_ITER_BLOCK = 0x80,
	289	TRACE_ITER_STACKTRACE = 0x100,
4ac3ba41	290	TRACE_ITER_SCHED_TREE = 0x200,
4e655519 IM	291	};
4e655519 IM	292
bc0c38d1	293	#endif /* _LINUX_KERNEL_TRACE_H */