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

DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);

struct trace_print_flags {
	unsigned 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);

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

#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;

	/* The below is zeroed out in pipe_read */
	struct trace_seq	seq;
	struct trace_entry	*ent;
	unsigned long		lost_events;
	int			leftover;
	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_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,
};

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

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

	int			perf_refcount;
};

#define PERF_MAX_TRACE_SIZE	2048

#define MAX_FILTER_PRED		32
#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,
};

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_enable(int event_id);
extern void perf_trace_disable(int event_id);
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, int *rctxp,
			 unsigned long *irq_flags);

static inline void
perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
		       u64 count, unsigned long irq_flags, struct pt_regs *regs)
{
	struct trace_entry *entry = raw_data;

	perf_tp_event(entry->type, addr, count, raw_data, size, regs);
	perf_swevent_put_recursion_context(rctx);
	local_irq_restore(irq_flags);
}
#endif

#endif /* _LINUX_FTRACE_EVENT_H */
Commit	Line	Data
	1	#ifndef _LINUX_FTRACE_EVENT_H
	2	#define _LINUX_FTRACE_EVENT_H
	3
	4	#include <linux/ring_buffer.h>
	5	#include <linux/trace_seq.h>
	6	#include <linux/percpu.h>
	7	#include <linux/hardirq.h>
	8	#include <linux/perf_event.h>
	9
	10	struct trace_array;
	11	struct tracer;
	12	struct dentry;
	13
	14	DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);
	15
	16	struct trace_print_flags {
	17	unsigned long mask;
	18	const char *name;
	19	};
	20
	21	const char ftrace_print_flags_seq(struct trace_seq p, const char *delim,
	22	unsigned long flags,
	23	const struct trace_print_flags *flag_array);
	24
	25	const char ftrace_print_symbols_seq(struct trace_seq p, unsigned long val,
	26	const struct trace_print_flags *symbol_array);
	27
	28	/*
	29	* The trace entry - the most basic unit of tracing. This is what
	30	* is printed in the end as a single line in the trace output, such as:
	31	*
	32	* bash-15816 [01] 235.197585: idle_cpu <- irq_enter
	33	*/
	34	struct trace_entry {
	35	unsigned short type;
	36	unsigned char flags;
	37	unsigned char preempt_count;
	38	int pid;
	39	int lock_depth;
	40	};
	41
	42	#define FTRACE_MAX_EVENT \
	43	((1 << (sizeof(((struct trace_entry )0)->type) 8)) - 1)
	44
	45	/*
	46	* Trace iterator - used by printout routines who present trace
	47	* results to users and which routines might sleep, etc:
	48	*/
	49	struct trace_iterator {
	50	struct trace_array *tr;
	51	struct tracer *trace;
	52	void *private;
	53	int cpu_file;
	54	struct mutex mutex;
	55	struct ring_buffer_iter *buffer_iter[NR_CPUS];
	56	unsigned long iter_flags;
	57
	58	/* The below is zeroed out in pipe_read */
	59	struct trace_seq seq;
	60	struct trace_entry *ent;
	61	unsigned long lost_events;
	62	int leftover;
	63	int cpu;
	64	u64 ts;
	65
	66	loff_t pos;
	67	long idx;
	68
	69	cpumask_var_t started;
	70	};
	71
	72
	73	struct trace_event;
	74
	75	typedef enum print_line_t (trace_print_func)(struct trace_iterator iter,
	76	int flags, struct trace_event *event);
	77
	78	struct trace_event_functions {
	79	trace_print_func trace;
	80	trace_print_func raw;
	81	trace_print_func hex;
	82	trace_print_func binary;
	83	};
	84
	85	struct trace_event {
	86	struct hlist_node node;
	87	struct list_head list;
	88	int type;
	89	struct trace_event_functions *funcs;
	90	};
	91
	92	extern int register_ftrace_event(struct trace_event *event);
	93	extern int unregister_ftrace_event(struct trace_event *event);
	94
	95	/* Return values for print_line callback */
	96	enum print_line_t {
	97	TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
	98	TRACE_TYPE_HANDLED = 1,
	99	TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
	100	TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
	101	};
	102
	103	void tracing_generic_entry_update(struct trace_entry *entry,
	104	unsigned long flags,
	105	int pc);
	106	struct ring_buffer_event *
	107	trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
	108	int type, unsigned long len,
	109	unsigned long flags, int pc);
	110	void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
	111	struct ring_buffer_event *event,
	112	unsigned long flags, int pc);
	113	void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
	114	struct ring_buffer_event *event,
	115	unsigned long flags, int pc);
	116	void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
	117	struct ring_buffer_event *event);
	118
	119	void tracing_record_cmdline(struct task_struct *tsk);
	120
	121	struct event_filter;
	122
	123	enum trace_reg {
	124	TRACE_REG_REGISTER,
	125	TRACE_REG_UNREGISTER,
	126	TRACE_REG_PERF_REGISTER,
	127	TRACE_REG_PERF_UNREGISTER,
	128	};
	129
	130	struct ftrace_event_call;
	131
	132	struct ftrace_event_class {
	133	char *system;
	134	void *probe;
	135	#ifdef CONFIG_PERF_EVENTS
	136	void *perf_probe;
	137	#endif
	138	int (reg)(struct ftrace_event_call event,
	139	enum trace_reg type);
	140	int (define_fields)(struct ftrace_event_call );
	141	struct list_head (get_fields)(struct ftrace_event_call *);
	142	struct list_head fields;
	143	int (raw_init)(struct ftrace_event_call );
	144	};
	145
	146	struct ftrace_event_call {
	147	struct list_head list;
	148	struct ftrace_event_class *class;
	149	char *name;
	150	struct dentry *dir;
	151	struct trace_event *event;
	152	int enabled;
	153	int id;
	154	const char *print_fmt;
	155	int filter_active;
	156	struct event_filter *filter;
	157	void *mod;
	158	void *data;
	159
	160	int perf_refcount;
	161	};
	162
	163	#define PERF_MAX_TRACE_SIZE 2048
	164
	165	#define MAX_FILTER_PRED 32
	166	#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
	167
	168	extern void destroy_preds(struct ftrace_event_call *call);
	169	extern int filter_match_preds(struct event_filter filter, void rec);
	170	extern int filter_current_check_discard(struct ring_buffer *buffer,
	171	struct ftrace_event_call *call,
	172	void *rec,
	173	struct ring_buffer_event *event);
	174
	175	enum {
	176	FILTER_OTHER = 0,
	177	FILTER_STATIC_STRING,
	178	FILTER_DYN_STRING,
	179	FILTER_PTR_STRING,
	180	};
	181
	182	extern int trace_event_raw_init(struct ftrace_event_call *call);
	183	extern int trace_define_field(struct ftrace_event_call call, const char type,
	184	const char *name, int offset, int size,
	185	int is_signed, int filter_type);
	186	extern int trace_add_event_call(struct ftrace_event_call *call);
	187	extern void trace_remove_event_call(struct ftrace_event_call *call);
	188
	189	#define is_signed_type(type) (((type)(-1)) < 0)
	190
	191	int trace_set_clr_event(const char system, const char event, int set);
	192
	193	/*
	194	* The double __builtin_constant_p is because gcc will give us an error
	195	* if we try to allocate the static variable to fmt if it is not a
	196	* constant. Even with the outer if statement optimizing out.
	197	*/
	198	#define event_trace_printk(ip, fmt, args...) \
	199	do { \
	200	__trace_printk_check_format(fmt, ##args); \
	201	tracing_record_cmdline(current); \
	202	if (__builtin_constant_p(fmt)) { \
	203	static const char *trace_printk_fmt \
	204	__attribute__((section("__trace_printk_fmt"))) = \
	205	__builtin_constant_p(fmt) ? fmt : NULL; \
	206	\
	207	__trace_bprintk(ip, trace_printk_fmt, ##args); \
	208	} else \
	209	__trace_printk(ip, fmt, ##args); \
	210	} while (0)
	211
	212	#ifdef CONFIG_PERF_EVENTS
	213	struct perf_event;
	214
	215	DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
	216
	217	extern int perf_trace_enable(int event_id);
	218	extern void perf_trace_disable(int event_id);
	219	extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
	220	char *filter_str);
	221	extern void ftrace_profile_free_filter(struct perf_event *event);
	222	extern void *
	223	perf_trace_buf_prepare(int size, unsigned short type, int *rctxp,
	224	unsigned long *irq_flags);
	225
	226	static inline void
	227	perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
	228	u64 count, unsigned long irq_flags, struct pt_regs *regs)
	229	{
	230	struct trace_entry *entry = raw_data;
	231
	232	perf_tp_event(entry->type, addr, count, raw_data, size, regs);
	233	perf_swevent_put_recursion_context(rctx);
	234	local_irq_restore(irq_flags);
	235	}
	236	#endif
	237
	238	#endif /* _LINUX_FTRACE_EVENT_H */