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

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

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

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

#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 notrace 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 trace_special(struct trace_array *tr,
		   struct trace_array_cpu *data,
		   unsigned long arg1,
		   unsigned long arg2,
		   unsigned long arg3);

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 notrace cycle_t ftrace_now(int cpu);

#ifdef CONFIG_SCHED_TRACER
extern void notrace
wakeup_sched_switch(struct task_struct *prev, struct task_struct *next);
#else
static inline void
wakeup_sched_switch(struct task_struct *prev, struct task_struct *next)
{
}
#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);

#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;
	26	};
	27
f0a920d5 IM	28	/*
	29	* Special (free-form) trace entry:
	30	*/
	31	struct special_entry {
	32	unsigned long arg1;
	33	unsigned long arg2;
	34	unsigned long arg3;
	35	};
	36
bc0c38d1 SR	37	/*
	38	* The trace entry - the most basic unit of tracing. This is what
	39	* is printed in the end as a single line in the trace output, such as:
	40	*
	41	* bash-15816 [01] 235.197585: idle_cpu <- irq_enter
	42	*/
	43	struct trace_entry {
	44	char type;
	45	char cpu;
	46	char flags;
	47	char preempt_count;
	48	int pid;
	49	cycle_t t;
bc0c38d1 SR	50	union {
	51	struct ftrace_entry fn;
	52	struct ctx_switch_entry ctx;
f0a920d5	53	struct special_entry special;
bc0c38d1 SR	54	};
	55	};
	56
	57	#define TRACE_ENTRY_SIZE sizeof(struct trace_entry)
	58
	59	/*
	60	* The CPU trace array - it consists of thousands of trace entries
	61	* plus some other descriptor data: (for example which task started
	62	* the trace, etc.)
	63	*/
	64	struct trace_array_cpu {
4c11d7ae	65	struct list_head trace_pages;
bc0c38d1	66	atomic_t disabled;
b3806b43	67	spinlock_t lock;
d4c5a2f5	68	struct lock_class_key lock_key;
4e3c3333	69
c7aafc54	70	/* these fields get copied into max-trace: */
93a588f4 SR	71	unsigned trace_head_idx;
	72	unsigned trace_tail_idx;
	73	void trace_head; / producer */
	74	void trace_tail; / consumer */
c7aafc54	75	unsigned long trace_idx;
bc0c38d1 SR	76	unsigned long saved_latency;
	77	unsigned long critical_start;
	78	unsigned long critical_end;
	79	unsigned long critical_sequence;
	80	unsigned long nice;
	81	unsigned long policy;
	82	unsigned long rt_priority;
	83	cycle_t preempt_timestamp;
	84	pid_t pid;
	85	uid_t uid;
	86	char comm[TASK_COMM_LEN];
	87	};
	88
	89	struct trace_iterator;
	90
	91	/*
	92	* The trace array - an array of per-CPU trace arrays. This is the
	93	* highest level data structure that individual tracers deal with.
	94	* They have on/off state as well:
	95	*/
	96	struct trace_array {
	97	unsigned long entries;
	98	long ctrl;
	99	int cpu;
	100	cycle_t time_start;
b3806b43	101	struct task_struct *waiter;
bc0c38d1 SR	102	struct trace_array_cpu *data[NR_CPUS];
	103	};
	104
	105	/*
	106	* A specific tracer, represented by methods that operate on a trace array:
	107	*/
	108	struct tracer {
	109	const char *name;
	110	void (init)(struct trace_array tr);
	111	void (reset)(struct trace_array tr);
	112	void (open)(struct trace_iterator iter);
	113	void (close)(struct trace_iterator iter);
	114	void (start)(struct trace_iterator iter);
	115	void (stop)(struct trace_iterator iter);
	116	void (ctrl_update)(struct trace_array tr);
60a11774 SR	117	#ifdef CONFIG_FTRACE_STARTUP_TEST
	118	int (selftest)(struct tracer trace,
	119	struct trace_array *tr);
	120	#endif
bc0c38d1 SR	121	struct tracer *next;
	122	int print_max;
	123	};
	124
214023c3 SR	125	struct trace_seq {
	126	unsigned char buffer[PAGE_SIZE];
	127	unsigned int len;
	128	};
	129
bc0c38d1 SR	130	/*
	131	* Trace iterator - used by printout routines who present trace
	132	* results to users and which routines might sleep, etc:
	133	*/
	134	struct trace_iterator {
214023c3	135	struct trace_seq seq;
bc0c38d1 SR	136	struct trace_array *tr;
bc0c38d1 SR	137	struct tracer *trace;
4e3c3333	138
bc0c38d1	139	struct trace_entry *ent;
4e3c3333 IM	140	int cpu;
	141
	142	struct trace_entry *prev_ent;
	143	int prev_cpu;
	144
bc0c38d1 SR	145	unsigned long iter_flags;
	146	loff_t pos;
	147	unsigned long next_idx[NR_CPUS];
4c11d7ae SR	148	struct list_head *next_page[NR_CPUS];
	149	unsigned next_page_idx[NR_CPUS];
	150	long idx;
bc0c38d1 SR	151	};
	152
	153	void notrace tracing_reset(struct trace_array_cpu *data);
	154	int tracing_open_generic(struct inode inode, struct file filp);
	155	struct dentry *tracing_init_dentry(void);
	156	void ftrace(struct trace_array *tr,
	157	struct trace_array_cpu *data,
	158	unsigned long ip,
	159	unsigned long parent_ip,
	160	unsigned long flags);
	161	void tracing_sched_switch_trace(struct trace_array *tr,
	162	struct trace_array_cpu *data,
	163	struct task_struct *prev,
	164	struct task_struct *next,
	165	unsigned long flags);
	166	void tracing_record_cmdline(struct task_struct *tsk);
f0a920d5 IM	167	void trace_special(struct trace_array *tr,
	168	struct trace_array_cpu *data,
	169	unsigned long arg1,
	170	unsigned long arg2,
	171	unsigned long arg3);
bc0c38d1 SR	172
	173	void tracing_start_function_trace(void);
	174	void tracing_stop_function_trace(void);
	175	int register_tracer(struct tracer *type);
	176	void unregister_tracer(struct tracer *type);
	177
	178	extern unsigned long nsecs_to_usecs(unsigned long nsecs);
	179
	180	extern unsigned long tracing_max_latency;
	181	extern unsigned long tracing_thresh;
	182
	183	void update_max_tr(struct trace_array tr, struct task_struct tsk, int cpu);
	184	void update_max_tr_single(struct trace_array *tr,
	185	struct task_struct *tsk, int cpu);
	186
750ed1a4	187	extern notrace cycle_t ftrace_now(int cpu);
bc0c38d1 SR	188
	189	#ifdef CONFIG_SCHED_TRACER
	190	extern void notrace
	191	wakeup_sched_switch(struct task_struct prev, struct task_struct next);
	192	#else
	193	static inline void
	194	wakeup_sched_switch(struct task_struct prev, struct task_struct next)
	195	{
	196	}
	197	#endif
	198
	199	#ifdef CONFIG_CONTEXT_SWITCH_TRACER
	200	typedef void
	201	(tracer_switch_func_t)(void private,
	202	struct task_struct *prev,
	203	struct task_struct *next);
	204
	205	struct tracer_switch_ops {
	206	tracer_switch_func_t func;
	207	void *private;
	208	struct tracer_switch_ops *next;
	209	};
	210
	211	extern int register_tracer_switch(struct tracer_switch_ops *ops);
	212	extern int unregister_tracer_switch(struct tracer_switch_ops *ops);
	213
	214	#endif /* CONFIG_CONTEXT_SWITCH_TRACER */
	215
	216	#ifdef CONFIG_DYNAMIC_FTRACE
	217	extern unsigned long ftrace_update_tot_cnt;
	218	#endif
	219
60a11774 SR	220	#ifdef CONFIG_FTRACE_STARTUP_TEST
	221	#ifdef CONFIG_FTRACE
	222	extern int trace_selftest_startup_function(struct tracer *trace,
	223	struct trace_array *tr);
	224	#endif
	225	#ifdef CONFIG_IRQSOFF_TRACER
	226	extern int trace_selftest_startup_irqsoff(struct tracer *trace,
	227	struct trace_array *tr);
	228	#endif
	229	#ifdef CONFIG_PREEMPT_TRACER
	230	extern int trace_selftest_startup_preemptoff(struct tracer *trace,
	231	struct trace_array *tr);
	232	#endif
	233	#if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
	234	extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
	235	struct trace_array *tr);
	236	#endif
	237	#ifdef CONFIG_SCHED_TRACER
	238	extern int trace_selftest_startup_wakeup(struct tracer *trace,
	239	struct trace_array *tr);
	240	#endif
	241	#ifdef CONFIG_CONTEXT_SWITCH_TRACER
	242	extern int trace_selftest_startup_sched_switch(struct tracer *trace,
	243	struct trace_array *tr);
	244	#endif
	245	#endif /* CONFIG_FTRACE_STARTUP_TEST */
	246
c7aafc54 IM	247	extern void head_page(struct trace_array_cpu data);
c7aafc54 IM	248
bc0c38d1	249	#endif /* _LINUX_KERNEL_TRACE_H */