[mirror_ubuntu-zesty-kernel.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>

enum trace_type {
	__TRACE_FIRST_TYPE = 0,

	TRACE_FN,
	TRACE_CTX,
	TRACE_WAKE,
	TRACE_STACK,
	TRACE_SPECIAL,

	__TRACE_LAST_TYPE
};

/*
 * 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	8

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;
	raw_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		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 {
	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			(*pipe_open)(struct trace_iterator *iter);
	void			(*close)(struct trace_iterator *iter);
	void			(*start)(struct trace_iterator *iter);
	void			(*stop)(struct trace_iterator *iter);
	ssize_t			(*read)(struct trace_iterator *iter,
					struct file *filp, char __user *ubuf,
					size_t cnt, loff_t *ppos);
	void			(*ctrl_update)(struct trace_array *tr);
#ifdef CONFIG_FTRACE_STARTUP_TEST
	int			(*selftest)(struct tracer *trace,
					    struct trace_array *tr);
#endif
	int			(*print_line)(struct trace_iterator *iter);
	struct tracer		*next;
	int			print_max;
};

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;
	long			last_overrun[NR_CPUS];
	long			overrun[NR_CPUS];

	/* The below is zeroed out in pipe_read */
	struct trace_seq	seq;
	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;

extern atomic_t trace_record_cmdline_enabled;

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_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
#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
#ifdef CONFIG_SYSPROF_TRACER
extern int trace_selftest_startup_sysprof(struct tracer *trace,
					       struct trace_array *tr);
#endif
#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 ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
				 size_t cnt);
extern long ns2usecs(cycle_t nsec);

extern unsigned long trace_flags;

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

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