[deliverable/linux.git] / tools / perf / util / trace-event.h

#ifndef __PERF_TRACE_EVENTS_H
#define __PERF_TRACE_EVENTS_H

#include <stdbool.h>
#include "parse-events.h"
#include "session.h"

#define __unused __attribute__((unused))


#ifndef PAGE_MASK
#define PAGE_MASK (page_size - 1)
#endif

enum {
	RINGBUF_TYPE_PADDING		= 29,
	RINGBUF_TYPE_TIME_EXTEND	= 30,
	RINGBUF_TYPE_TIME_STAMP		= 31,
};

#ifndef TS_SHIFT
#define TS_SHIFT		27
#endif

#define NSECS_PER_SEC		1000000000ULL
#define NSECS_PER_USEC		1000ULL

enum format_flags {
	FIELD_IS_ARRAY		= 1,
	FIELD_IS_POINTER	= 2,
	FIELD_IS_SIGNED		= 4,
	FIELD_IS_STRING		= 8,
	FIELD_IS_DYNAMIC	= 16,
	FIELD_IS_FLAG		= 32,
	FIELD_IS_SYMBOLIC	= 64,
};

struct format_field {
	struct format_field	*next;
	char			*type;
	char			*name;
	int			offset;
	int			size;
	unsigned long		flags;
};

struct format {
	int			nr_common;
	int			nr_fields;
	struct format_field	*common_fields;
	struct format_field	*fields;
};

struct print_arg_atom {
	char			*atom;
};

struct print_arg_string {
	char			*string;
	int			offset;
};

struct print_arg_field {
	char			*name;
	struct format_field	*field;
};

struct print_flag_sym {
	struct print_flag_sym	*next;
	char			*value;
	char			*str;
};

struct print_arg_typecast {
	char 			*type;
	struct print_arg	*item;
};

struct print_arg_flags {
	struct print_arg	*field;
	char			*delim;
	struct print_flag_sym	*flags;
};

struct print_arg_symbol {
	struct print_arg	*field;
	struct print_flag_sym	*symbols;
};

struct print_arg;

struct print_arg_op {
	char			*op;
	int			prio;
	struct print_arg	*left;
	struct print_arg	*right;
};

struct print_arg_func {
	char			*name;
	struct print_arg	*args;
};

enum print_arg_type {
	PRINT_NULL,
	PRINT_ATOM,
	PRINT_FIELD,
	PRINT_FLAGS,
	PRINT_SYMBOL,
	PRINT_TYPE,
	PRINT_STRING,
	PRINT_OP,
};

struct print_arg {
	struct print_arg		*next;
	enum print_arg_type		type;
	union {
		struct print_arg_atom		atom;
		struct print_arg_field		field;
		struct print_arg_typecast	typecast;
		struct print_arg_flags		flags;
		struct print_arg_symbol		symbol;
		struct print_arg_func		func;
		struct print_arg_string		string;
		struct print_arg_op		op;
	};
};

struct print_fmt {
	char			*format;
	struct print_arg	*args;
};

struct event {
	struct event		*next;
	char			*name;
	int			id;
	int			flags;
	struct format		format;
	struct print_fmt	print_fmt;
	char			*system;
};

enum {
	EVENT_FL_ISFTRACE	= 0x01,
	EVENT_FL_ISPRINT	= 0x02,
	EVENT_FL_ISBPRINT	= 0x04,
	EVENT_FL_ISFUNC		= 0x08,
	EVENT_FL_ISFUNCENT	= 0x10,
	EVENT_FL_ISFUNCRET	= 0x20,

	EVENT_FL_FAILED		= 0x80000000
};

struct record {
	unsigned long long ts;
	int size;
	void *data;
};

struct record *trace_peek_data(int cpu);
struct record *trace_read_data(int cpu);

void parse_set_info(int nr_cpus, int long_sz);

ssize_t trace_report(int fd, bool repipe);

void *malloc_or_die(unsigned int size);

void parse_cmdlines(char *file, int size);
void parse_proc_kallsyms(char *file, unsigned int size);
void parse_ftrace_printk(char *file, unsigned int size);

void print_funcs(void);
void print_printk(void);

int parse_ftrace_file(char *buf, unsigned long size);
int parse_event_file(char *buf, unsigned long size, char *sys);
void print_trace_event(int cpu, void *data, int size);

extern int file_bigendian;
extern int host_bigendian;

int bigendian(void);

static inline unsigned short __data2host2(unsigned short data)
{
	unsigned short swap;

	if (host_bigendian == file_bigendian)
		return data;

	swap = ((data & 0xffULL) << 8) |
		((data & (0xffULL << 8)) >> 8);

	return swap;
}

static inline unsigned int __data2host4(unsigned int data)
{
	unsigned int swap;

	if (host_bigendian == file_bigendian)
		return data;

	swap = ((data & 0xffULL) << 24) |
		((data & (0xffULL << 8)) << 8) |
		((data & (0xffULL << 16)) >> 8) |
		((data & (0xffULL << 24)) >> 24);

	return swap;
}

static inline unsigned long long __data2host8(unsigned long long data)
{
	unsigned long long swap;

	if (host_bigendian == file_bigendian)
		return data;

	swap = ((data & 0xffULL) << 56) |
		((data & (0xffULL << 8)) << 40) |
		((data & (0xffULL << 16)) << 24) |
		((data & (0xffULL << 24)) << 8) |
		((data & (0xffULL << 32)) >> 8) |
		((data & (0xffULL << 40)) >> 24) |
		((data & (0xffULL << 48)) >> 40) |
		((data & (0xffULL << 56)) >> 56);

	return swap;
}

#define data2host2(ptr)		__data2host2(*(unsigned short *)ptr)
#define data2host4(ptr)		__data2host4(*(unsigned int *)ptr)
#define data2host8(ptr)		({				\
	unsigned long long __val;				\
								\
	memcpy(&__val, (ptr), sizeof(unsigned long long));	\
	__data2host8(__val);					\
})

extern int header_page_ts_offset;
extern int header_page_ts_size;
extern int header_page_size_offset;
extern int header_page_size_size;
extern int header_page_data_offset;
extern int header_page_data_size;

extern bool latency_format;

int trace_parse_common_type(void *data);
int trace_parse_common_pid(void *data);
int parse_common_pc(void *data);
int parse_common_flags(void *data);
int parse_common_lock_depth(void *data);
struct event *trace_find_event(int id);
struct event *trace_find_next_event(struct event *event);
unsigned long long read_size(void *ptr, int size);
unsigned long long
raw_field_value(struct event *event, const char *name, void *data);
void *raw_field_ptr(struct event *event, const char *name, void *data);
unsigned long long eval_flag(const char *flag);

int read_tracing_data(int fd, struct list_head *pattrs);

struct tracing_data {
	/* size is only valid if temp is 'true' */
	ssize_t size;
	bool temp;
	char temp_file[50];
};

struct tracing_data *tracing_data_get(struct list_head *pattrs,
				      int fd, bool temp);
void tracing_data_put(struct tracing_data *tdata);


/* taken from kernel/trace/trace.h */
enum trace_flag_type {
	TRACE_FLAG_IRQS_OFF		= 0x01,
	TRACE_FLAG_IRQS_NOSUPPORT	= 0x02,
	TRACE_FLAG_NEED_RESCHED		= 0x04,
	TRACE_FLAG_HARDIRQ		= 0x08,
	TRACE_FLAG_SOFTIRQ		= 0x10,
};

struct scripting_ops {
	const char *name;
	int (*start_script) (const char *script, int argc, const char **argv);
	int (*stop_script) (void);
	void (*process_event) (union perf_event *event,
			       struct perf_sample *sample,
			       struct perf_evsel *evsel,
			       struct perf_session *session,
			       struct thread *thread);
	int (*generate_script) (const char *outfile);
};

int script_spec_register(const char *spec, struct scripting_ops *ops);

void setup_perl_scripting(void);
void setup_python_scripting(void);

struct scripting_context {
	void *event_data;
};

int common_pc(struct scripting_context *context);
int common_flags(struct scripting_context *context);
int common_lock_depth(struct scripting_context *context);

#endif /* __PERF_TRACE_EVENTS_H */
Commit	Line	Data
8b40f521 JK	1	#ifndef __PERF_TRACE_EVENTS_H
8b40f521 JK	2	#define __PERF_TRACE_EVENTS_H
52050943	3
c0555642	4	#include <stdbool.h>
1ef2ed10	5	#include "parse-events.h"
be6d842a	6	#include "session.h"
52050943 SR	7
	8	#define __unused __attribute__((unused))
	9
	10
	11	#ifndef PAGE_MASK
	12	#define PAGE_MASK (page_size - 1)
	13	#endif
	14
	15	enum {
	16	RINGBUF_TYPE_PADDING = 29,
	17	RINGBUF_TYPE_TIME_EXTEND = 30,
	18	RINGBUF_TYPE_TIME_STAMP = 31,
	19	};
	20
	21	#ifndef TS_SHIFT
	22	#define TS_SHIFT 27
	23	#endif
	24
	25	#define NSECS_PER_SEC 1000000000ULL
	26	#define NSECS_PER_USEC 1000ULL
	27
	28	enum format_flags {
	29	FIELD_IS_ARRAY = 1,
	30	FIELD_IS_POINTER = 2,
26a50744	31	FIELD_IS_SIGNED = 4,
064739bc TZ	32	FIELD_IS_STRING = 8,
064739bc TZ	33	FIELD_IS_DYNAMIC = 16,
eb9a42ca TZ	34	FIELD_IS_FLAG = 32,
eb9a42ca TZ	35	FIELD_IS_SYMBOLIC = 64,
52050943 SR	36	};
	37
	38	struct format_field {
	39	struct format_field *next;
	40	char *type;
	41	char *name;
	42	int offset;
	43	int size;
	44	unsigned long flags;
	45	};
	46
	47	struct format {
	48	int nr_common;
	49	int nr_fields;
	50	struct format_field *common_fields;
	51	struct format_field *fields;
	52	};
	53
	54	struct print_arg_atom {
	55	char *atom;
	56	};
	57
	58	struct print_arg_string {
	59	char *string;
561f732c	60	int offset;
52050943 SR	61	};
	62
	63	struct print_arg_field {
	64	char *name;
	65	struct format_field *field;
	66	};
	67
	68	struct print_flag_sym {
	69	struct print_flag_sym *next;
	70	char *value;
	71	char *str;
	72	};
	73
	74	struct print_arg_typecast {
	75	char *type;
	76	struct print_arg *item;
	77	};
	78
	79	struct print_arg_flags {
	80	struct print_arg *field;
	81	char *delim;
	82	struct print_flag_sym *flags;
	83	};
	84
	85	struct print_arg_symbol {
	86	struct print_arg *field;
	87	struct print_flag_sym *symbols;
	88	};
	89
	90	struct print_arg;
	91
	92	struct print_arg_op {
	93	char *op;
	94	int prio;
	95	struct print_arg *left;
	96	struct print_arg *right;
	97	};
	98
	99	struct print_arg_func {
	100	char *name;
	101	struct print_arg *args;
	102	};
	103
	104	enum print_arg_type {
	105	PRINT_NULL,
	106	PRINT_ATOM,
	107	PRINT_FIELD,
	108	PRINT_FLAGS,
	109	PRINT_SYMBOL,
	110	PRINT_TYPE,
	111	PRINT_STRING,
	112	PRINT_OP,
	113	};
	114
	115	struct print_arg {
	116	struct print_arg *next;
	117	enum print_arg_type type;
	118	union {
	119	struct print_arg_atom atom;
	120	struct print_arg_field field;
	121	struct print_arg_typecast typecast;
	122	struct print_arg_flags flags;
	123	struct print_arg_symbol symbol;
	124	struct print_arg_func func;
125	struct print_arg_string string;
126	struct print_arg_op op;
127	};
128	};
129
130	struct print_fmt {
131	char *format;
132	struct print_arg *args;
133	};
134
135	struct event {
136	struct event *next;
137	char *name;
138	int id;
139	int flags;
140	struct format format;
141	struct print_fmt print_fmt;
27746018	142	char *system;
52050943 SR	143	};
	144
	145	enum {
07a4bddd SR	146	EVENT_FL_ISFTRACE = 0x01,
	147	EVENT_FL_ISPRINT = 0x02,
	148	EVENT_FL_ISBPRINT = 0x04,
	149	EVENT_FL_ISFUNC = 0x08,
	150	EVENT_FL_ISFUNCENT = 0x10,
	151	EVENT_FL_ISFUNCRET = 0x20,
	152
	153	EVENT_FL_FAILED = 0x80000000
52050943 SR	154	};
	155
	156	struct record {
	157	unsigned long long ts;
	158	int size;
	159	void *data;
	160	};
	161
	162	struct record *trace_peek_data(int cpu);
	163	struct record *trace_read_data(int cpu);
	164
	165	void parse_set_info(int nr_cpus, int long_sz);
	166
454c407e	167	ssize_t trace_report(int fd, bool repipe);
52050943 SR	168
	169	void *malloc_or_die(unsigned int size);
	170
	171	void parse_cmdlines(char *file, int size);
	172	void parse_proc_kallsyms(char *file, unsigned int size);
	173	void parse_ftrace_printk(char *file, unsigned int size);
	174
	175	void print_funcs(void);
	176	void print_printk(void);
	177
	178	int parse_ftrace_file(char *buf, unsigned long size);
27746018	179	int parse_event_file(char buf, unsigned long size, char sys);
c70c94b4	180	void print_trace_event(int cpu, void *data, int size);
52050943 SR	181
	182	extern int file_bigendian;
	183	extern int host_bigendian;
	184
	185	int bigendian(void);
	186
	187	static inline unsigned short __data2host2(unsigned short data)
	188	{
	189	unsigned short swap;
	190
	191	if (host_bigendian == file_bigendian)
	192	return data;
	193
	194	swap = ((data & 0xffULL) << 8) \|
	195	((data & (0xffULL << 8)) >> 8);
	196
	197	return swap;
	198	}
	199
	200	static inline unsigned int __data2host4(unsigned int data)
	201	{
	202	unsigned int swap;
	203
	204	if (host_bigendian == file_bigendian)
	205	return data;
	206
	207	swap = ((data & 0xffULL) << 24) \|
	208	((data & (0xffULL << 8)) << 8) \|
	209	((data & (0xffULL << 16)) >> 8) \|
	210	((data & (0xffULL << 24)) >> 24);
	211
	212	return swap;
	213	}
	214
	215	static inline unsigned long long __data2host8(unsigned long long data)
	216	{
	217	unsigned long long swap;
	218
	219	if (host_bigendian == file_bigendian)
	220	return data;
	221
	222	swap = ((data & 0xffULL) << 56) \|
	223	((data & (0xffULL << 8)) << 40) \|
	224	((data & (0xffULL << 16)) << 24) \|
	225	((data & (0xffULL << 24)) << 8) \|
	226	((data & (0xffULL << 32)) >> 8) \|
	227	((data & (0xffULL << 40)) >> 24) \|
	228	((data & (0xffULL << 48)) >> 40) \|
	229	((data & (0xffULL << 56)) >> 56);
	230
	231	return swap;
	232	}
	233
	234	#define data2host2(ptr) __data2host2((unsigned short )ptr)
	235	#define data2host4(ptr) __data2host4((unsigned int )ptr)
85cb68b2 FW	236	#define data2host8(ptr) ({ \
	237	unsigned long long __val; \
	238	\
	239	memcpy(&__val, (ptr), sizeof(unsigned long long)); \
	240	__data2host8(__val); \
	241	})
52050943 SR	242
	243	extern int header_page_ts_offset;
	244	extern int header_page_ts_size;
	245	extern int header_page_size_offset;
	246	extern int header_page_size_size;
	247	extern int header_page_data_offset;
	248	extern int header_page_data_size;
	249
c0555642	250	extern bool latency_format;
cda48461	251
ec156764	252	int trace_parse_common_type(void *data);
16c632de	253	int trace_parse_common_pid(void *data);
d1b93772 TZ	254	int parse_common_pc(void *data);
	255	int parse_common_flags(void *data);
	256	int parse_common_lock_depth(void *data);
ec156764	257	struct event *trace_find_event(int id);
16c632de TZ	258	struct event trace_find_next_event(struct event event);
16c632de TZ	259	unsigned long long read_size(void *ptr, int size);
46538818 FW	260	unsigned long long
	261	raw_field_value(struct event event, const char name, void *data);
	262	void raw_field_ptr(struct event event, const char name, void data);
16c632de	263	unsigned long long eval_flag(const char *flag);
52050943	264
69aad6f1	265	int read_tracing_data(int fd, struct list_head *pattrs);
29208e57 JO	266
	267	struct tracing_data {
	268	/* size is only valid if temp is 'true' */
	269	ssize_t size;
	270	bool temp;
	271	char temp_file[50];
	272	};
	273
	274	struct tracing_data tracing_data_get(struct list_head pattrs,
	275	int fd, bool temp);
	276	void tracing_data_put(struct tracing_data *tdata);
	277
52050943	278
cda48461 SR	279	/* taken from kernel/trace/trace.h */
	280	enum trace_flag_type {
	281	TRACE_FLAG_IRQS_OFF = 0x01,
	282	TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
	283	TRACE_FLAG_NEED_RESCHED = 0x04,
	284	TRACE_FLAG_HARDIRQ = 0x08,
	285	TRACE_FLAG_SOFTIRQ = 0x10,
	286	};
	287
956ffd02 TZ	288	struct scripting_ops {
956ffd02 TZ	289	const char *name;
586bc5cc	290	int (start_script) (const char script, int argc, const char **argv);
956ffd02	291	int (*stop_script) (void);
be6d842a DA	292	void (process_event) (union perf_event event,
be6d842a DA	293	struct perf_sample *sample,
9e69c210	294	struct perf_evsel *evsel,
be6d842a DA	295	struct perf_session *session,
be6d842a DA	296	struct thread *thread);
956ffd02 TZ	297	int (generate_script) (const char outfile);
	298	};
	299
	300	int script_spec_register(const char spec, struct scripting_ops ops);
	301
16c632de	302	void setup_perl_scripting(void);
7e4b21b8	303	void setup_python_scripting(void);
16c632de	304
7397d80d TZ	305	struct scripting_context {
	306	void *event_data;
	307	};
	308
	309	int common_pc(struct scripting_context *context);
	310	int common_flags(struct scripting_context *context);
	311	int common_lock_depth(struct scripting_context *context);
	312
8b40f521	313	#endif /* __PERF_TRACE_EVENTS_H */