[deliverable/linux.git] / include / linux / ftrace_event.h

#ifndef _LINUX_FTRACE_EVENT_H
#define _LINUX_FTRACE_EVENT_H

#include <linux/ring_buffer.h>
#include <linux/trace_seq.h>
#include <linux/percpu.h>
#include <linux/hardirq.h>
#include <linux/perf_event.h>

struct trace_array;
struct tracer;
struct dentry;

struct trace_print_flags {
	unsigned long		mask;
	const char		*name;
};

struct trace_print_flags_u64 {
	unsigned long long	mask;
	const char		*name;
};

const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
				   unsigned long flags,
				   const struct trace_print_flags *flag_array);

const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
				     const struct trace_print_flags *symbol_array);

#if BITS_PER_LONG == 32
const char *ftrace_print_symbols_seq_u64(struct trace_seq *p,
					 unsigned long long val,
					 const struct trace_print_flags_u64
								 *symbol_array);
#endif

const char *ftrace_print_hex_seq(struct trace_seq *p,
				 const unsigned char *buf, int len);

/*
 * 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 short		type;
	unsigned char		flags;
	unsigned char		preempt_count;
	int			pid;
	int			padding;
};

#define FTRACE_MAX_EVENT						\
	((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)

/*
 * 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;
	int			cpu_file;
	struct mutex		mutex;
	struct ring_buffer_iter	*buffer_iter[NR_CPUS];
	unsigned long		iter_flags;

	/* trace_seq for __print_flags() and __print_symbolic() etc. */
	struct trace_seq	tmp_seq;

	/* The below is zeroed out in pipe_read */
	struct trace_seq	seq;
	struct trace_entry	*ent;
	unsigned long		lost_events;
	int			leftover;
	int			ent_size;
	int			cpu;
	u64			ts;

	loff_t			pos;
	long			idx;

	cpumask_var_t		started;
};


struct trace_event;

typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
				      int flags, struct trace_event *event);

struct trace_event_functions {
	trace_print_func	trace;
	trace_print_func	raw;
	trace_print_func	hex;
	trace_print_func	binary;
};

struct trace_event {
	struct hlist_node		node;
	struct list_head		list;
	int				type;
	struct trace_event_functions	*funcs;
};

extern int register_ftrace_event(struct trace_event *event);
extern int unregister_ftrace_event(struct trace_event *event);

/* 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 */
	TRACE_TYPE_NO_CONSUME	= 3	/* Handled but ask to not consume */
};

void tracing_generic_entry_update(struct trace_entry *entry,
				  unsigned long flags,
				  int pc);
struct ring_buffer_event *
trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
				  int type, unsigned long len,
				  unsigned long flags, int pc);
void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
					struct ring_buffer_event *event,
					unsigned long flags, int pc);
void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
				       struct ring_buffer_event *event,
					unsigned long flags, int pc);
void trace_nowake_buffer_unlock_commit_regs(struct ring_buffer *buffer,
					    struct ring_buffer_event *event,
					    unsigned long flags, int pc,
					    struct pt_regs *regs);
void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
					 struct ring_buffer_event *event);

void tracing_record_cmdline(struct task_struct *tsk);

struct event_filter;

enum trace_reg {
	TRACE_REG_REGISTER,
	TRACE_REG_UNREGISTER,
	TRACE_REG_PERF_REGISTER,
	TRACE_REG_PERF_UNREGISTER,
	TRACE_REG_PERF_OPEN,
	TRACE_REG_PERF_CLOSE,
};

struct ftrace_event_call;

struct ftrace_event_class {
	char			*system;
	void			*probe;
#ifdef CONFIG_PERF_EVENTS
	void			*perf_probe;
#endif
	int			(*reg)(struct ftrace_event_call *event,
				       enum trace_reg type, void *data);
	int			(*define_fields)(struct ftrace_event_call *);
	struct list_head	*(*get_fields)(struct ftrace_event_call *);
	struct list_head	fields;
	int			(*raw_init)(struct ftrace_event_call *);
};

extern int ftrace_event_reg(struct ftrace_event_call *event,
			    enum trace_reg type, void *data);

enum {
	TRACE_EVENT_FL_ENABLED_BIT,
	TRACE_EVENT_FL_FILTERED_BIT,
	TRACE_EVENT_FL_RECORDED_CMD_BIT,
	TRACE_EVENT_FL_CAP_ANY_BIT,
	TRACE_EVENT_FL_NO_SET_FILTER_BIT,
};

enum {
	TRACE_EVENT_FL_ENABLED		= (1 << TRACE_EVENT_FL_ENABLED_BIT),
	TRACE_EVENT_FL_FILTERED		= (1 << TRACE_EVENT_FL_FILTERED_BIT),
	TRACE_EVENT_FL_RECORDED_CMD	= (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
	TRACE_EVENT_FL_CAP_ANY		= (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
	TRACE_EVENT_FL_NO_SET_FILTER	= (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
};

struct ftrace_event_call {
	struct list_head	list;
	struct ftrace_event_class *class;
	char			*name;
	struct dentry		*dir;
	struct trace_event	event;
	const char		*print_fmt;
	struct event_filter	*filter;
	void			*mod;
	void			*data;

	/*
	 * 32 bit flags:
	 *   bit 1:		enabled
	 *   bit 2:		filter_active
	 *   bit 3:		enabled cmd record
	 *
	 * Changes to flags must hold the event_mutex.
	 *
	 * Note: Reads of flags do not hold the event_mutex since
	 * they occur in critical sections. But the way flags
	 * is currently used, these changes do no affect the code
	 * except that when a change is made, it may have a slight
	 * delay in propagating the changes to other CPUs due to
	 * caching and such.
	 */
	unsigned int		flags;

#ifdef CONFIG_PERF_EVENTS
	int				perf_refcount;
	struct hlist_head __percpu	*perf_events;
#endif
};

#define __TRACE_EVENT_FLAGS(name, value)				\
	static int __init trace_init_flags_##name(void)			\
	{								\
		event_##name.flags = value;				\
		return 0;						\
	}								\
	early_initcall(trace_init_flags_##name);

#define PERF_MAX_TRACE_SIZE	2048

#define MAX_FILTER_STR_VAL	256	/* Should handle KSYM_SYMBOL_LEN */

extern void destroy_preds(struct ftrace_event_call *call);
extern int filter_match_preds(struct event_filter *filter, void *rec);
extern int filter_current_check_discard(struct ring_buffer *buffer,
					struct ftrace_event_call *call,
					void *rec,
					struct ring_buffer_event *event);

enum {
	FILTER_OTHER = 0,
	FILTER_STATIC_STRING,
	FILTER_DYN_STRING,
	FILTER_PTR_STRING,
};

#define EVENT_STORAGE_SIZE 128
extern struct mutex event_storage_mutex;
extern char event_storage[EVENT_STORAGE_SIZE];

extern int trace_event_raw_init(struct ftrace_event_call *call);
extern int trace_define_field(struct ftrace_event_call *call, const char *type,
			      const char *name, int offset, int size,
			      int is_signed, int filter_type);
extern int trace_add_event_call(struct ftrace_event_call *call);
extern void trace_remove_event_call(struct ftrace_event_call *call);

#define is_signed_type(type)	(((type)(-1)) < 0)

int trace_set_clr_event(const char *system, const char *event, int set);

/*
 * The double __builtin_constant_p is because gcc will give us an error
 * if we try to allocate the static variable to fmt if it is not a
 * constant. Even with the outer if statement optimizing out.
 */
#define event_trace_printk(ip, fmt, args...)				\
do {									\
	__trace_printk_check_format(fmt, ##args);			\
	tracing_record_cmdline(current);				\
	if (__builtin_constant_p(fmt)) {				\
		static const char *trace_printk_fmt			\
		  __attribute__((section("__trace_printk_fmt"))) =	\
			__builtin_constant_p(fmt) ? fmt : NULL;		\
									\
		__trace_bprintk(ip, trace_printk_fmt, ##args);		\
	} else								\
		__trace_printk(ip, fmt, ##args);			\
} while (0)

#ifdef CONFIG_PERF_EVENTS
struct perf_event;

DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);

extern int  perf_trace_init(struct perf_event *event);
extern void perf_trace_destroy(struct perf_event *event);
extern int  perf_trace_add(struct perf_event *event, int flags);
extern void perf_trace_del(struct perf_event *event, int flags);
extern int  ftrace_profile_set_filter(struct perf_event *event, int event_id,
				     char *filter_str);
extern void ftrace_profile_free_filter(struct perf_event *event);
extern void *perf_trace_buf_prepare(int size, unsigned short type,
				    struct pt_regs *regs, int *rctxp);

static inline void
perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
		       u64 count, struct pt_regs *regs, void *head)
{
	perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
}
#endif

#endif /* _LINUX_FTRACE_EVENT_H */
Commit	Line	Data
97f20251 SR	1	#ifndef _LINUX_FTRACE_EVENT_H
	2	#define _LINUX_FTRACE_EVENT_H
	3
97f20251	4	#include <linux/ring_buffer.h>
16bb8eb1	5	#include <linux/trace_seq.h>
be74b73a	6	#include <linux/percpu.h>
20ab4425	7	#include <linux/hardirq.h>
430ad5a6	8	#include <linux/perf_event.h>
97f20251 SR	9
	10	struct trace_array;
	11	struct tracer;
6d723736	12	struct dentry;
97f20251	13
be74b73a SR	14	struct trace_print_flags {
	15	unsigned long mask;
	16	const char *name;
	17	};
	18
2fc1b6f0	19	struct trace_print_flags_u64 {
	20	unsigned long long mask;
	21	const char *name;
	22	};
	23
be74b73a SR	24	const char ftrace_print_flags_seq(struct trace_seq p, const char *delim,
	25	unsigned long flags,
	26	const struct trace_print_flags *flag_array);
	27
0f4fc29d SR	28	const char ftrace_print_symbols_seq(struct trace_seq p, unsigned long val,
	29	const struct trace_print_flags *symbol_array);
	30
2fc1b6f0	31	#if BITS_PER_LONG == 32
	32	const char ftrace_print_symbols_seq_u64(struct trace_seq p,
	33	unsigned long long val,
	34	const struct trace_print_flags_u64
	35	*symbol_array);
	36	#endif
	37
5a2e3995 KT	38	const char ftrace_print_hex_seq(struct trace_seq p,
	39	const unsigned char *buf, int len);
	40
97f20251 SR	41	/*
	42	* The trace entry - the most basic unit of tracing. This is what
	43	* is printed in the end as a single line in the trace output, such as:
	44	*
	45	* bash-15816 [01] 235.197585: idle_cpu <- irq_enter
	46	*/
	47	struct trace_entry {
89ec0dee	48	unsigned short type;
97f20251 SR	49	unsigned char flags;
	50	unsigned char preempt_count;
	51	int pid;
a3a4a5ac	52	int padding;
97f20251 SR	53	};
97f20251 SR	54
89ec0dee SR	55	#define FTRACE_MAX_EVENT \
	56	((1 << (sizeof(((struct trace_entry )0)->type) 8)) - 1)
	57
97f20251 SR	58	/*
	59	* Trace iterator - used by printout routines who present trace
	60	* results to users and which routines might sleep, etc:
	61	*/
	62	struct trace_iterator {
	63	struct trace_array *tr;
	64	struct tracer *trace;
	65	void *private;
	66	int cpu_file;
	67	struct mutex mutex;
	68	struct ring_buffer_iter *buffer_iter[NR_CPUS];
112f38a7	69	unsigned long iter_flags;
97f20251	70
bc289ae9 LJ	71	/* trace_seq for __print_flags() and __print_symbolic() etc. */
	72	struct trace_seq tmp_seq;
	73
97f20251 SR	74	/* The below is zeroed out in pipe_read */
	75	struct trace_seq seq;
	76	struct trace_entry *ent;
bc21b478	77	unsigned long lost_events;
a63ce5b3	78	int leftover;
4a9bd3f1	79	int ent_size;
97f20251 SR	80	int cpu;
	81	u64 ts;
	82
97f20251 SR	83	loff_t pos;
	84	long idx;
	85
	86	cpumask_var_t started;
	87	};
	88
	89
a9a57763 SR	90	struct trace_event;
a9a57763 SR	91
97f20251	92	typedef enum print_line_t (trace_print_func)(struct trace_iterator iter,
a9a57763 SR	93	int flags, struct trace_event *event);
	94
	95	struct trace_event_functions {
97f20251 SR	96	trace_print_func trace;
	97	trace_print_func raw;
	98	trace_print_func hex;
	99	trace_print_func binary;
	100	};
	101
a9a57763 SR	102	struct trace_event {
	103	struct hlist_node node;
	104	struct list_head list;
	105	int type;
	106	struct trace_event_functions *funcs;
	107	};
	108
97f20251 SR	109	extern int register_ftrace_event(struct trace_event *event);
	110	extern int unregister_ftrace_event(struct trace_event *event);
	111
	112	/* Return values for print_line callback */
	113	enum print_line_t {
	114	TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
	115	TRACE_TYPE_HANDLED = 1,
	116	TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
	117	TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
	118	};
	119
f413cdb8 FW	120	void tracing_generic_entry_update(struct trace_entry *entry,
	121	unsigned long flags,
	122	int pc);
97f20251	123	struct ring_buffer_event *
e77405ad SR	124	trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
e77405ad SR	125	int type, unsigned long len,
97f20251	126	unsigned long flags, int pc);
e77405ad SR	127	void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
e77405ad SR	128	struct ring_buffer_event *event,
97f20251	129	unsigned long flags, int pc);
e77405ad SR	130	void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
e77405ad SR	131	struct ring_buffer_event *event,
97f20251	132	unsigned long flags, int pc);
1fd8df2c MH	133	void trace_nowake_buffer_unlock_commit_regs(struct ring_buffer *buffer,
	134	struct ring_buffer_event *event,
	135	unsigned long flags, int pc,
	136	struct pt_regs *regs);
e77405ad SR	137	void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
e77405ad SR	138	struct ring_buffer_event *event);
97f20251 SR	139
	140	void tracing_record_cmdline(struct task_struct *tsk);
	141
1f9963cb LZ	142	struct event_filter;
1f9963cb LZ	143
2239291a SR	144	enum trace_reg {
	145	TRACE_REG_REGISTER,
	146	TRACE_REG_UNREGISTER,
	147	TRACE_REG_PERF_REGISTER,
	148	TRACE_REG_PERF_UNREGISTER,
ceec0b6f JO	149	TRACE_REG_PERF_OPEN,
ceec0b6f JO	150	TRACE_REG_PERF_CLOSE,
2239291a SR	151	};
	152
	153	struct ftrace_event_call;
	154
8f082018 SR	155	struct ftrace_event_class {
8f082018 SR	156	char *system;
2239291a SR	157	void *probe;
	158	#ifdef CONFIG_PERF_EVENTS
	159	void *perf_probe;
	160	#endif
	161	int (reg)(struct ftrace_event_call event,
ceec0b6f	162	enum trace_reg type, void *data);
2e33af02 SR	163	int (define_fields)(struct ftrace_event_call );
	164	struct list_head (get_fields)(struct ftrace_event_call *);
	165	struct list_head fields;
0405ab80	166	int (raw_init)(struct ftrace_event_call );
8f082018 SR	167	};
8f082018 SR	168
a1d0ce82	169	extern int ftrace_event_reg(struct ftrace_event_call *event,
ceec0b6f	170	enum trace_reg type, void *data);
a1d0ce82	171
553552ce SR	172	enum {
	173	TRACE_EVENT_FL_ENABLED_BIT,
	174	TRACE_EVENT_FL_FILTERED_BIT,
e870e9a1	175	TRACE_EVENT_FL_RECORDED_CMD_BIT,
61c32659	176	TRACE_EVENT_FL_CAP_ANY_BIT,
27b14b56	177	TRACE_EVENT_FL_NO_SET_FILTER_BIT,
553552ce SR	178	};
	179
	180	enum {
e870e9a1 LZ	181	TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
	182	TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
	183	TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
61c32659	184	TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
27b14b56	185	TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
553552ce SR	186	};
553552ce SR	187
97f20251	188	struct ftrace_event_call {
a59fd602	189	struct list_head list;
8f082018	190	struct ftrace_event_class *class;
97f20251	191	char *name;
97f20251	192	struct dentry *dir;
80decc70	193	struct trace_event event;
509e760c	194	const char *print_fmt;
1f9963cb	195	struct event_filter *filter;
6d723736	196	void *mod;
69fd4f0e	197	void *data;
97f20251	198
553552ce SR	199	/*
	200	* 32 bit flags:
	201	* bit 1: enabled
	202	* bit 2: filter_active
e870e9a1	203	* bit 3: enabled cmd record
553552ce	204	*
1eaa4787 SR	205	* Changes to flags must hold the event_mutex.
	206	*
	207	* Note: Reads of flags do not hold the event_mutex since
	208	* they occur in critical sections. But the way flags
	209	* is currently used, these changes do no affect the code
	210	* except that when a change is made, it may have a slight
	211	* delay in propagating the changes to other CPUs due to
	212	* caching and such.
553552ce SR	213	*/
	214	unsigned int flags;
	215
ff5f149b	216	#ifdef CONFIG_PERF_EVENTS
6016ee13 NK	217	int perf_refcount;
6016ee13 NK	218	struct hlist_head __percpu *perf_events;
ff5f149b	219	#endif
97f20251 SR	220	};
97f20251 SR	221
53cf810b FW	222	#define __TRACE_EVENT_FLAGS(name, value) \
	223	static int __init trace_init_flags_##name(void) \
	224	{ \
	225	event_##name.flags = value; \
	226	return 0; \
	227	} \
	228	early_initcall(trace_init_flags_##name);
	229
97d5a220	230	#define PERF_MAX_TRACE_SIZE 2048
20ab4425	231
16bb8eb1	232	#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
97f20251	233
2df75e41	234	extern void destroy_preds(struct ftrace_event_call *call);
6fb2915d	235	extern int filter_match_preds(struct event_filter filter, void rec);
e77405ad SR	236	extern int filter_current_check_discard(struct ring_buffer *buffer,
e77405ad SR	237	struct ftrace_event_call *call,
97f20251 SR	238	void *rec,
	239	struct ring_buffer_event *event);
	240
43b51ead LZ	241	enum {
	242	FILTER_OTHER = 0,
	243	FILTER_STATIC_STRING,
	244	FILTER_DYN_STRING,
87a342f5	245	FILTER_PTR_STRING,
43b51ead LZ	246	};
43b51ead LZ	247
04295780 SR	248	#define EVENT_STORAGE_SIZE 128
	249	extern struct mutex event_storage_mutex;
	250	extern char event_storage[EVENT_STORAGE_SIZE];
	251
87d9b4e1	252	extern int trace_event_raw_init(struct ftrace_event_call *call);
aeaeae11 FW	253	extern int trace_define_field(struct ftrace_event_call call, const char type,
	254	const char *name, int offset, int size,
	255	int is_signed, int filter_type);
bd1a5c84 MH	256	extern int trace_add_event_call(struct ftrace_event_call *call);
bd1a5c84 MH	257	extern void trace_remove_event_call(struct ftrace_event_call *call);
97f20251	258
a118e4d1	259	#define is_signed_type(type) (((type)(-1)) < 0)
97f20251	260
4671c794 SR	261	int trace_set_clr_event(const char system, const char event, int set);
4671c794 SR	262
97f20251 SR	263	/*
	264	* The double __builtin_constant_p is because gcc will give us an error
	265	* if we try to allocate the static variable to fmt if it is not a
	266	* constant. Even with the outer if statement optimizing out.
	267	*/
	268	#define event_trace_printk(ip, fmt, args...) \
	269	do { \
	270	__trace_printk_check_format(fmt, ##args); \
	271	tracing_record_cmdline(current); \
	272	if (__builtin_constant_p(fmt)) { \
	273	static const char *trace_printk_fmt \
	274	__attribute__((section("__trace_printk_fmt"))) = \
	275	__builtin_constant_p(fmt) ? fmt : NULL; \
	276	\
	277	__trace_bprintk(ip, trace_printk_fmt, ##args); \
	278	} else \
	279	__trace_printk(ip, fmt, ##args); \
	280	} while (0)
	281
07b139c8	282	#ifdef CONFIG_PERF_EVENTS
6fb2915d	283	struct perf_event;
c530665c FW	284
	285	DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
	286
1c024eca PZ	287	extern int perf_trace_init(struct perf_event *event);
1c024eca PZ	288	extern void perf_trace_destroy(struct perf_event *event);
a4eaf7f1 PZ	289	extern int perf_trace_add(struct perf_event *event, int flags);
a4eaf7f1 PZ	290	extern void perf_trace_del(struct perf_event *event, int flags);
1c024eca	291	extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
6fb2915d LZ	292	char *filter_str);
6fb2915d LZ	293	extern void ftrace_profile_free_filter(struct perf_event *event);
b7e2ecef PZ	294	extern void *perf_trace_buf_prepare(int size, unsigned short type,
b7e2ecef PZ	295	struct pt_regs regs, int rctxp);
430ad5a6 XG	296
430ad5a6 XG	297	static inline void
97d5a220	298	perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
1c024eca	299	u64 count, struct pt_regs regs, void head)
430ad5a6	300	{
ecc55f84	301	perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
430ad5a6	302	}
6fb2915d LZ	303	#endif
6fb2915d LZ	304
97f20251	305	#endif /* _LINUX_FTRACE_EVENT_H */