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

#ifndef __PERF_RECORD_H
#define __PERF_RECORD_H

#include <limits.h>
#include <stdio.h>

#include "../perf.h"
#include "map.h"
#include "build-id.h"

struct mmap_event {
	struct perf_event_header header;
	u32 pid, tid;
	u64 start;
	u64 len;
	u64 pgoff;
	char filename[PATH_MAX];
};

struct mmap2_event {
	struct perf_event_header header;
	u32 pid, tid;
	u64 start;
	u64 len;
	u64 pgoff;
	u32 maj;
	u32 min;
	u64 ino;
	u64 ino_generation;
	char filename[PATH_MAX];
};

struct comm_event {
	struct perf_event_header header;
	u32 pid, tid;
	char comm[16];
};

struct fork_event {
	struct perf_event_header header;
	u32 pid, ppid;
	u32 tid, ptid;
	u64 time;
};

struct lost_event {
	struct perf_event_header header;
	u64 id;
	u64 lost;
};

/*
 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
 */
struct read_event {
	struct perf_event_header header;
	u32 pid, tid;
	u64 value;
	u64 time_enabled;
	u64 time_running;
	u64 id;
};

struct throttle_event {
	struct perf_event_header header;
	u64 time;
	u64 id;
	u64 stream_id;
};

#define PERF_SAMPLE_MASK				\
	(PERF_SAMPLE_IP | PERF_SAMPLE_TID |		\
	 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR |		\
	PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID |	\
	 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD |		\
	 PERF_SAMPLE_IDENTIFIER)

/* perf sample has 16 bits size limit */
#define PERF_SAMPLE_MAX_SIZE (1 << 16)

struct sample_event {
	struct perf_event_header        header;
	u64 array[];
};

struct regs_dump {
	u64 abi;
	u64 mask;
	u64 *regs;
};

struct stack_dump {
	u16 offset;
	u64 size;
	char *data;
};

struct sample_read_value {
	u64 value;
	u64 id;
};

struct sample_read {
	u64 time_enabled;
	u64 time_running;
	union {
		struct {
			u64 nr;
			struct sample_read_value *values;
		} group;
		struct sample_read_value one;
	};
};

struct perf_sample {
	u64 ip;
	u32 pid, tid;
	u64 time;
	u64 addr;
	u64 id;
	u64 stream_id;
	u64 period;
	u64 weight;
	u64 transaction;
	u32 cpu;
	u32 raw_size;
	u64 data_src;
	void *raw_data;
	struct ip_callchain *callchain;
	struct branch_stack *branch_stack;
	struct regs_dump  user_regs;
	struct stack_dump user_stack;
	struct sample_read read;
};

#define PERF_MEM_DATA_SRC_NONE \
	(PERF_MEM_S(OP, NA) |\
	 PERF_MEM_S(LVL, NA) |\
	 PERF_MEM_S(SNOOP, NA) |\
	 PERF_MEM_S(LOCK, NA) |\
	 PERF_MEM_S(TLB, NA))

struct build_id_event {
	struct perf_event_header header;
	pid_t			 pid;
	u8			 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
	char			 filename[];
};

enum perf_user_event_type { /* above any possible kernel type */
	PERF_RECORD_USER_TYPE_START		= 64,
	PERF_RECORD_HEADER_ATTR			= 64,
	PERF_RECORD_HEADER_EVENT_TYPE		= 65, /* depreceated */
	PERF_RECORD_HEADER_TRACING_DATA		= 66,
	PERF_RECORD_HEADER_BUILD_ID		= 67,
	PERF_RECORD_FINISHED_ROUND		= 68,
	PERF_RECORD_HEADER_MAX
};

struct attr_event {
	struct perf_event_header header;
	struct perf_event_attr attr;
	u64 id[];
};

#define MAX_EVENT_NAME 64

struct perf_trace_event_type {
	u64	event_id;
	char	name[MAX_EVENT_NAME];
};

struct event_type_event {
	struct perf_event_header header;
	struct perf_trace_event_type event_type;
};

struct tracing_data_event {
	struct perf_event_header header;
	u32 size;
};

union perf_event {
	struct perf_event_header	header;
	struct mmap_event		mmap;
	struct mmap2_event		mmap2;
	struct comm_event		comm;
	struct fork_event		fork;
	struct lost_event		lost;
	struct read_event		read;
	struct throttle_event		throttle;
	struct sample_event		sample;
	struct attr_event		attr;
	struct event_type_event		event_type;
	struct tracing_data_event	tracing_data;
	struct build_id_event		build_id;
};

void perf_event__print_totals(void);

struct perf_tool;
struct thread_map;

typedef int (*perf_event__handler_t)(struct perf_tool *tool,
				     union perf_event *event,
				     struct perf_sample *sample,
				     struct machine *machine);

int perf_event__synthesize_thread_map(struct perf_tool *tool,
				      struct thread_map *threads,
				      perf_event__handler_t process,
				      struct machine *machine, bool mmap_data);
int perf_event__synthesize_threads(struct perf_tool *tool,
				   perf_event__handler_t process,
				   struct machine *machine, bool mmap_data);
int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
				       perf_event__handler_t process,
				       struct machine *machine);

int perf_event__synthesize_modules(struct perf_tool *tool,
				   perf_event__handler_t process,
				   struct machine *machine);

int perf_event__process_comm(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_sample *sample,
			     struct machine *machine);
int perf_event__process_lost(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_sample *sample,
			     struct machine *machine);
int perf_event__process_mmap(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_sample *sample,
			     struct machine *machine);
int perf_event__process_mmap2(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_sample *sample,
			     struct machine *machine);
int perf_event__process_fork(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_sample *sample,
			     struct machine *machine);
int perf_event__process_exit(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_sample *sample,
			     struct machine *machine);
int perf_event__process(struct perf_tool *tool,
			union perf_event *event,
			struct perf_sample *sample,
			struct machine *machine);

struct addr_location;

int perf_event__preprocess_sample(const union perf_event *event,
				  struct machine *machine,
				  struct addr_location *al,
				  struct perf_sample *sample);

const char *perf_event__name(unsigned int id);

size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
				     u64 read_format);
int perf_event__synthesize_sample(union perf_event *event, u64 type,
				  u64 read_format,
				  const struct perf_sample *sample,
				  bool swapped);

int perf_event__synthesize_mmap_events(struct perf_tool *tool,
				       union perf_event *event,
				       pid_t pid, pid_t tgid,
				       perf_event__handler_t process,
				       struct machine *machine,
				       bool mmap_data);

size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
size_t perf_event__fprintf(union perf_event *event, FILE *fp);

u64 kallsyms__get_function_start(const char *kallsyms_filename,
				 const char *symbol_name);

#endif /* __PERF_RECORD_H */
Commit	Line	Data
cdd6c482 IM	1	#ifndef __PERF_RECORD_H
cdd6c482 IM	2	#define __PERF_RECORD_H
8b40f521	3
4a58e611	4	#include <limits.h>
482ad897	5	#include <stdio.h>
4a58e611	6
1fe2c106	7	#include "../perf.h"
4a58e611	8	#include "map.h"
4383db88	9	#include "build-id.h"
1fe2c106	10
1fe2c106 FW	11	struct mmap_event {
	12	struct perf_event_header header;
	13	u32 pid, tid;
	14	u64 start;
	15	u64 len;
	16	u64 pgoff;
	17	char filename[PATH_MAX];
	18	};
	19
5c5e854b SE	20	struct mmap2_event {
	21	struct perf_event_header header;
	22	u32 pid, tid;
	23	u64 start;
	24	u64 len;
	25	u64 pgoff;
	26	u32 maj;
	27	u32 min;
	28	u64 ino;
	29	u64 ino_generation;
	30	char filename[PATH_MAX];
	31	};
	32
1fe2c106 FW	33	struct comm_event {
	34	struct perf_event_header header;
	35	u32 pid, tid;
	36	char comm[16];
	37	};
	38
	39	struct fork_event {
	40	struct perf_event_header header;
	41	u32 pid, ppid;
	42	u32 tid, ptid;
393b2ad8	43	u64 time;
1fe2c106 FW	44	};
	45
	46	struct lost_event {
	47	struct perf_event_header header;
	48	u64 id;
	49	u64 lost;
	50	};
	51
18408ddc PZ	52	/*
	53	* PERF_FORMAT_ENABLED \| PERF_FORMAT_RUNNING \| PERF_FORMAT_ID
	54	*/
1fe2c106 FW	55	struct read_event {
1fe2c106 FW	56	struct perf_event_header header;
dc02bf71	57	u32 pid, tid;
1fe2c106 FW	58	u64 value;
	59	u64 time_enabled;
	60	u64 time_running;
	61	u64 id;
	62	};
	63
dd96c46b JO	64	struct throttle_event {
	65	struct perf_event_header header;
	66	u64 time;
	67	u64 id;
	68	u64 stream_id;
	69	};
a2854124 FW	70
	71	#define PERF_SAMPLE_MASK \
	72	(PERF_SAMPLE_IP \| PERF_SAMPLE_TID \| \
	73	PERF_SAMPLE_TIME \| PERF_SAMPLE_ADDR \| \
	74	PERF_SAMPLE_ID \| PERF_SAMPLE_STREAM_ID \| \
75562573 AH	75	PERF_SAMPLE_CPU \| PERF_SAMPLE_PERIOD \| \
75562573 AH	76	PERF_SAMPLE_IDENTIFIER)
a2854124	77
a65cb4b9 JO	78	/* perf sample has 16 bits size limit */
	79	#define PERF_SAMPLE_MAX_SIZE (1 << 16)
	80
180f95e2	81	struct sample_event {
fd39e055 AV	82	struct perf_event_header header;
	83	u64 array[];
	84	};
	85
0f6a3015	86	struct regs_dump {
5b95a4a3	87	u64 abi;
352ea45a	88	u64 mask;
0f6a3015 JO	89	u64 *regs;
	90	};
	91
	92	struct stack_dump {
	93	u16 offset;
	94	u64 size;
	95	char *data;
	96	};
	97
9ede473c JO	98	struct sample_read_value {
	99	u64 value;
	100	u64 id;
	101	};
	102
	103	struct sample_read {
	104	u64 time_enabled;
	105	u64 time_running;
	106	union {
	107	struct {
	108	u64 nr;
	109	struct sample_read_value *values;
	110	} group;
	111	struct sample_read_value one;
	112	};
	113	};
	114
8d50e5b4	115	struct perf_sample {
180f95e2 OH	116	u64 ip;
	117	u32 pid, tid;
	118	u64 time;
	119	u64 addr;
	120	u64 id;
	121	u64 stream_id;
180f95e2	122	u64 period;
05484298	123	u64 weight;
475eeab9	124	u64 transaction;
eed05fe7	125	u32 cpu;
180f95e2	126	u32 raw_size;
98a3b32c	127	u64 data_src;
180f95e2	128	void *raw_data;
eed05fe7	129	struct ip_callchain *callchain;
b5387528	130	struct branch_stack *branch_stack;
0f6a3015 JO	131	struct regs_dump user_regs;
0f6a3015 JO	132	struct stack_dump user_stack;
9ede473c	133	struct sample_read read;
180f95e2 OH	134	};
180f95e2 OH	135
98a3b32c SE	136	#define PERF_MEM_DATA_SRC_NONE \
	137	(PERF_MEM_S(OP, NA) \|\
	138	PERF_MEM_S(LVL, NA) \|\
	139	PERF_MEM_S(SNOOP, NA) \|\
	140	PERF_MEM_S(LOCK, NA) \|\
	141	PERF_MEM_S(TLB, NA))
	142
8d06367f ACM	143	struct build_id_event {
8d06367f ACM	144	struct perf_event_header header;
a1645ce1	145	pid_t pid;
9ac3e487	146	u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
8d06367f ACM	147	char filename[];
8d06367f ACM	148	};
fd39e055	149
98402807	150	enum perf_user_event_type { /* above any possible kernel type */
9aefcab0	151	PERF_RECORD_USER_TYPE_START = 64,
2c46dbb5	152	PERF_RECORD_HEADER_ATTR = 64,
6065210d	153	PERF_RECORD_HEADER_EVENT_TYPE = 65, /* depreceated */
9215545e	154	PERF_RECORD_HEADER_TRACING_DATA = 66,
c7929e47	155	PERF_RECORD_HEADER_BUILD_ID = 67,
98402807	156	PERF_RECORD_FINISHED_ROUND = 68,
2c46dbb5 TZ	157	PERF_RECORD_HEADER_MAX
	158	};
	159
	160	struct attr_event {
	161	struct perf_event_header header;
	162	struct perf_event_attr attr;
	163	u64 id[];
8dc58101 TZ	164	};
8dc58101 TZ	165
cd19a035 TZ	166	#define MAX_EVENT_NAME 64
	167
	168	struct perf_trace_event_type {
	169	u64 event_id;
	170	char name[MAX_EVENT_NAME];
	171	};
	172
	173	struct event_type_event {
	174	struct perf_event_header header;
	175	struct perf_trace_event_type event_type;
	176	};
	177
9215545e TZ	178	struct tracing_data_event {
	179	struct perf_event_header header;
	180	u32 size;
	181	};
	182
8115d60c	183	union perf_event {
1fe2c106	184	struct perf_event_header header;
1fe2c106	185	struct mmap_event mmap;
5c5e854b	186	struct mmap2_event mmap2;
1fe2c106 FW	187	struct comm_event comm;
	188	struct fork_event fork;
	189	struct lost_event lost;
	190	struct read_event read;
dd96c46b	191	struct throttle_event throttle;
fd39e055	192	struct sample_event sample;
2c46dbb5	193	struct attr_event attr;
cd19a035	194	struct event_type_event event_type;
9215545e	195	struct tracing_data_event tracing_data;
c7929e47	196	struct build_id_event build_id;
8115d60c	197	};
66e274f3	198
8115d60c	199	void perf_event__print_totals(void);
62daacb5	200
45694aa7	201	struct perf_tool;
401b8e13	202	struct thread_map;
4aa65636	203
45694aa7	204	typedef int (perf_event__handler_t)(struct perf_tool tool,
d20deb64	205	union perf_event *event,
8115d60c	206	struct perf_sample *sample,
743eb868	207	struct machine *machine);
cf553114	208
45694aa7	209	int perf_event__synthesize_thread_map(struct perf_tool *tool,
d20deb64	210	struct thread_map *threads,
7c940c18	211	perf_event__handler_t process,
62605dc5	212	struct machine *machine, bool mmap_data);
45694aa7	213	int perf_event__synthesize_threads(struct perf_tool *tool,
d20deb64	214	perf_event__handler_t process,
62605dc5	215	struct machine *machine, bool mmap_data);
45694aa7	216	int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
d20deb64	217	perf_event__handler_t process,
0ae617be	218	struct machine *machine);
8115d60c	219
45694aa7	220	int perf_event__synthesize_modules(struct perf_tool *tool,
d20deb64	221	perf_event__handler_t process,
8115d60c ACM	222	struct machine *machine);
8115d60c ACM	223
45694aa7	224	int perf_event__process_comm(struct perf_tool *tool,
d20deb64 ACM	225	union perf_event *event,
d20deb64 ACM	226	struct perf_sample *sample,
743eb868	227	struct machine *machine);
45694aa7	228	int perf_event__process_lost(struct perf_tool *tool,
d20deb64 ACM	229	union perf_event *event,
d20deb64 ACM	230	struct perf_sample *sample,
743eb868	231	struct machine *machine);
45694aa7	232	int perf_event__process_mmap(struct perf_tool *tool,
d20deb64 ACM	233	union perf_event *event,
d20deb64 ACM	234	struct perf_sample *sample,
743eb868	235	struct machine *machine);
5c5e854b SE	236	int perf_event__process_mmap2(struct perf_tool *tool,
	237	union perf_event *event,
	238	struct perf_sample *sample,
	239	struct machine *machine);
f62d3f0f ACM	240	int perf_event__process_fork(struct perf_tool *tool,
	241	union perf_event *event,
	242	struct perf_sample *sample,
	243	struct machine *machine);
	244	int perf_event__process_exit(struct perf_tool *tool,
d20deb64 ACM	245	union perf_event *event,
d20deb64 ACM	246	struct perf_sample *sample,
743eb868	247	struct machine *machine);
45694aa7	248	int perf_event__process(struct perf_tool *tool,
d20deb64 ACM	249	union perf_event *event,
d20deb64 ACM	250	struct perf_sample *sample,
743eb868	251	struct machine *machine);
62daacb5	252
1ed091c4	253	struct addr_location;
316c7136 ACM	254
316c7136 ACM	255	int perf_event__preprocess_sample(const union perf_event *event,
743eb868	256	struct machine *machine,
8115d60c	257	struct addr_location *al,
e44baa3e	258	struct perf_sample *sample);
1ed091c4	259
8115d60c	260	const char *perf_event__name(unsigned int id);
c8446b9b	261
b1cf6f65	262	size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
352ea45a	263	u64 read_format);
74eec26f	264	int perf_event__synthesize_sample(union perf_event *event, u64 type,
352ea45a	265	u64 read_format,
74eec26f AV	266	const struct perf_sample *sample,
74eec26f AV	267	bool swapped);
d0dd74e8	268
a18382b6 JO	269	int perf_event__synthesize_mmap_events(struct perf_tool *tool,
	270	union perf_event *event,
	271	pid_t pid, pid_t tgid,
	272	perf_event__handler_t process,
	273	struct machine *machine,
	274	bool mmap_data);
	275
482ad897 ACM	276	size_t perf_event__fprintf_comm(union perf_event event, FILE fp);
482ad897 ACM	277	size_t perf_event__fprintf_mmap(union perf_event event, FILE fp);
5c5e854b	278	size_t perf_event__fprintf_mmap2(union perf_event event, FILE fp);
482ad897 ACM	279	size_t perf_event__fprintf_task(union perf_event event, FILE fp);
	280	size_t perf_event__fprintf(union perf_event event, FILE fp);
	281
29b596b5 AH	282	u64 kallsyms__get_function_start(const char *kallsyms_filename,
	283	const char *symbol_name);
	284
8b40f521	285	#endif /* __PERF_RECORD_H */