[mirror_ubuntu-artful-kernel.git] / include / linux / ftrace_event.h

#ifndef _LINUX_FTRACE_EVENT_H
#define _LINUX_FTRACE_EVENT_H

#include <linux/trace_seq.h>
#include <linux/ring_buffer.h>
#include <linux/percpu.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			tgid;
};

#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;
	int			cpu;
	u64			ts;

	loff_t			pos;
	long			idx;

	cpumask_var_t		started;
};


typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
					      int flags);
struct trace_event {
	struct hlist_node	node;
	struct list_head	list;
	int			type;
	trace_print_func	trace;
	trace_print_func	raw;
	trace_print_func	hex;
	trace_print_func	binary;
};

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(int type, unsigned long len,
				  unsigned long flags, int pc);
void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
					unsigned long flags, int pc);
void trace_nowake_buffer_unlock_commit(struct ring_buffer_event *event,
					unsigned long flags, int pc);
void trace_current_buffer_discard_commit(struct ring_buffer_event *event);

void tracing_record_cmdline(struct task_struct *tsk);

struct event_filter;

struct ftrace_event_call {
	struct list_head	list;
	char			*name;
	char			*system;
	struct dentry		*dir;
	struct trace_event	*event;
	int			enabled;
	int			(*regfunc)(struct ftrace_event_call *);
	void			(*unregfunc)(struct ftrace_event_call *);
	int			id;
	int			(*raw_init)(struct ftrace_event_call *);
	int			(*show_format)(struct ftrace_event_call *,
					       struct trace_seq *);
	int			(*define_fields)(struct ftrace_event_call *);
	struct list_head	fields;
	int			filter_active;
	struct event_filter	*filter;
	void			*mod;
	void			*data;

	atomic_t		profile_count;
	int			(*profile_enable)(struct ftrace_event_call *);
	void			(*profile_disable)(struct ftrace_event_call *);
};

#define MAX_FILTER_PRED		32
#define MAX_FILTER_STR_VAL	128

extern int init_preds(struct ftrace_event_call *call);
extern void destroy_preds(struct ftrace_event_call *call);
extern int filter_match_preds(struct ftrace_event_call *call, void *rec);
extern int filter_current_check_discard(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_define_common_fields(struct ftrace_event_call *call);
extern int trace_define_field(struct ftrace_event_call *call, char *type,
			      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)

#endif /* _LINUX_FTRACE_EVENT_H */
Commit	Line	Data
97f20251 SR	1	#ifndef _LINUX_FTRACE_EVENT_H
	2	#define _LINUX_FTRACE_EVENT_H
	3
	4	#include <linux/trace_seq.h>
	5	#include <linux/ring_buffer.h>
be74b73a	6	#include <linux/percpu.h>
97f20251 SR	7
	8	struct trace_array;
	9	struct tracer;
6d723736	10	struct dentry;
97f20251	11
be74b73a SR	12	DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);
	13
	14	struct trace_print_flags {
	15	unsigned long mask;
	16	const char *name;
	17	};
	18
	19	const char ftrace_print_flags_seq(struct trace_seq p, const char *delim,
	20	unsigned long flags,
	21	const struct trace_print_flags *flag_array);
	22
0f4fc29d SR	23	const char ftrace_print_symbols_seq(struct trace_seq p, unsigned long val,
	24	const struct trace_print_flags *symbol_array);
	25
97f20251 SR	26	/*
	27	* The trace entry - the most basic unit of tracing. This is what
	28	* is printed in the end as a single line in the trace output, such as:
	29	*
	30	* bash-15816 [01] 235.197585: idle_cpu <- irq_enter
	31	*/
	32	struct trace_entry {
89ec0dee	33	unsigned short type;
97f20251 SR	34	unsigned char flags;
	35	unsigned char preempt_count;
	36	int pid;
	37	int tgid;
	38	};
	39
89ec0dee SR	40	#define FTRACE_MAX_EVENT \
	41	((1 << (sizeof(((struct trace_entry )0)->type) 8)) - 1)
	42
97f20251 SR	43	/*
	44	* Trace iterator - used by printout routines who present trace
	45	* results to users and which routines might sleep, etc:
	46	*/
	47	struct trace_iterator {
	48	struct trace_array *tr;
	49	struct tracer *trace;
	50	void *private;
	51	int cpu_file;
	52	struct mutex mutex;
	53	struct ring_buffer_iter *buffer_iter[NR_CPUS];
112f38a7	54	unsigned long iter_flags;
97f20251 SR	55
	56	/* The below is zeroed out in pipe_read */
	57	struct trace_seq seq;
	58	struct trace_entry *ent;
	59	int cpu;
	60	u64 ts;
	61
97f20251 SR	62	loff_t pos;
	63	long idx;
	64
	65	cpumask_var_t started;
	66	};
	67
	68
	69	typedef enum print_line_t (trace_print_func)(struct trace_iterator iter,
	70	int flags);
	71	struct trace_event {
	72	struct hlist_node node;
060fa5c8	73	struct list_head list;
97f20251 SR	74	int type;
	75	trace_print_func trace;
	76	trace_print_func raw;
	77	trace_print_func hex;
	78	trace_print_func binary;
	79	};
	80
	81	extern int register_ftrace_event(struct trace_event *event);
	82	extern int unregister_ftrace_event(struct trace_event *event);
	83
	84	/* Return values for print_line callback */
	85	enum print_line_t {
	86	TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
	87	TRACE_TYPE_HANDLED = 1,
	88	TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
	89	TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
	90	};
	91
f413cdb8 FW	92	void tracing_generic_entry_update(struct trace_entry *entry,
	93	unsigned long flags,
	94	int pc);
97f20251	95	struct ring_buffer_event *
7a4f453b	96	trace_current_buffer_lock_reserve(int type, unsigned long len,
97f20251 SR	97	unsigned long flags, int pc);
	98	void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
	99	unsigned long flags, int pc);
	100	void trace_nowake_buffer_unlock_commit(struct ring_buffer_event *event,
	101	unsigned long flags, int pc);
	102	void trace_current_buffer_discard_commit(struct ring_buffer_event *event);
	103
	104	void tracing_record_cmdline(struct task_struct *tsk);
	105
1f9963cb LZ	106	struct event_filter;
1f9963cb LZ	107
97f20251	108	struct ftrace_event_call {
a59fd602	109	struct list_head list;
97f20251 SR	110	char *name;
	111	char *system;
	112	struct dentry *dir;
6d723736	113	struct trace_event *event;
97f20251	114	int enabled;
bd1a5c84 MH	115	int (regfunc)(struct ftrace_event_call );
bd1a5c84 MH	116	void (unregfunc)(struct ftrace_event_call );
97f20251	117	int id;
bd1a5c84 MH	118	int (raw_init)(struct ftrace_event_call );
	119	int (show_format)(struct ftrace_event_call ,
	120	struct trace_seq *);
14be96c9	121	int (define_fields)(struct ftrace_event_call );
97f20251	122	struct list_head fields;
30e673b2	123	int filter_active;
1f9963cb	124	struct event_filter *filter;
6d723736	125	void *mod;
69fd4f0e	126	void *data;
97f20251	127
af6af30c PZ	128	atomic_t profile_count;
	129	int (profile_enable)(struct ftrace_event_call );
	130	void (profile_disable)(struct ftrace_event_call );
97f20251 SR	131	};
97f20251 SR	132
8b372562	133	#define MAX_FILTER_PRED 32
97f20251 SR	134	#define MAX_FILTER_STR_VAL 128
	135
	136	extern int init_preds(struct ftrace_event_call *call);
2df75e41	137	extern void destroy_preds(struct ftrace_event_call *call);
97f20251 SR	138	extern int filter_match_preds(struct ftrace_event_call call, void rec);
	139	extern int filter_current_check_discard(struct ftrace_event_call *call,
	140	void *rec,
	141	struct ring_buffer_event *event);
	142
43b51ead LZ	143	enum {
	144	FILTER_OTHER = 0,
	145	FILTER_STATIC_STRING,
	146	FILTER_DYN_STRING,
87a342f5	147	FILTER_PTR_STRING,
43b51ead LZ	148	};
43b51ead LZ	149
e647d6b3	150	extern int trace_define_common_fields(struct ftrace_event_call *call);
bd1a5c84 MH	151	extern int trace_define_field(struct ftrace_event_call call, char type,
	152	char *name, int offset, int size, int is_signed,
	153	int filter_type);
	154	extern int trace_add_event_call(struct ftrace_event_call *call);
	155	extern void trace_remove_event_call(struct ftrace_event_call *call);
97f20251	156
a118e4d1	157	#define is_signed_type(type) (((type)(-1)) < 0)
97f20251	158
4671c794 SR	159	int trace_set_clr_event(const char system, const char event, int set);
4671c794 SR	160
97f20251 SR	161	/*
	162	* The double __builtin_constant_p is because gcc will give us an error
	163	* if we try to allocate the static variable to fmt if it is not a
	164	* constant. Even with the outer if statement optimizing out.
	165	*/
	166	#define event_trace_printk(ip, fmt, args...) \
	167	do { \
	168	__trace_printk_check_format(fmt, ##args); \
	169	tracing_record_cmdline(current); \
	170	if (__builtin_constant_p(fmt)) { \
	171	static const char *trace_printk_fmt \
	172	__attribute__((section("__trace_printk_fmt"))) = \
	173	__builtin_constant_p(fmt) ? fmt : NULL; \
	174	\
	175	__trace_bprintk(ip, trace_printk_fmt, ##args); \
	176	} else \
	177	__trace_printk(ip, fmt, ##args); \
	178	} while (0)
	179
97f20251	180	#endif /* _LINUX_FTRACE_EVENT_H */