[linux-2.6-block.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"
#include "perf_regs.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;
	u32 prot;
	u32 flags;
	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;

	/* Cached values/mask filled by first register access. */
	u64 cache_regs[PERF_REGS_MAX];
	u64 cache_mask;
};

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 ip_callchain {
	u64 nr;
	u64 ips[0];
};

struct branch_flags {
	u64 mispred:1;
	u64 predicted:1;
	u64 in_tx:1;
	u64 abort:1;
	u64 reserved:60;
};

struct branch_entry {
	u64			from;
	u64			to;
	struct branch_flags	flags;
};

struct branch_stack {
	u64			nr;
	struct branch_entry	entries[0];
};

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;
	u32 flags;
	u16 insn_len;
	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
};

/*
 * The kernel collects the number of events it couldn't send in a stretch and
 * when possible sends this number in a PERF_RECORD_LOST event. The number of
 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
 * the sum of all struct lost_event.lost fields reported.
 *
 * The total_period is needed because by default auto-freq is used, so
 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
 * the total number of low level events, it is necessary to to sum all struct
 * sample_event.period and stash the result in total_period.
 */
struct events_stats {
	u64 total_period;
	u64 total_non_filtered_period;
	u64 total_lost;
	u64 total_invalid_chains;
	u32 nr_events[PERF_RECORD_HEADER_MAX];
	u32 nr_non_filtered_samples;
	u32 nr_lost_warned;
	u32 nr_unknown_events;
	u32 nr_invalid_chains;
	u32 nr_unknown_id;
	u32 nr_unprocessable_samples;
};

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

struct thread;

bool is_bts_event(struct perf_event_attr *attr);
bool sample_addr_correlates_sym(struct perf_event_attr *attr);
void perf_event__preprocess_sample_addr(union perf_event *event,
					struct perf_sample *sample,
					struct thread *thread,
					struct addr_location *al);

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"
0c4e774f	10	#include "perf_regs.h"
1fe2c106	11
1fe2c106 FW	12	struct mmap_event {
	13	struct perf_event_header header;
	14	u32 pid, tid;
	15	u64 start;
	16	u64 len;
	17	u64 pgoff;
	18	char filename[PATH_MAX];
	19	};
	20
5c5e854b SE	21	struct mmap2_event {
	22	struct perf_event_header header;
	23	u32 pid, tid;
	24	u64 start;
	25	u64 len;
	26	u64 pgoff;
	27	u32 maj;
	28	u32 min;
	29	u64 ino;
	30	u64 ino_generation;
7ef80703 DZ	31	u32 prot;
7ef80703 DZ	32	u32 flags;
5c5e854b SE	33	char filename[PATH_MAX];
	34	};
	35
1fe2c106 FW	36	struct comm_event {
	37	struct perf_event_header header;
	38	u32 pid, tid;
	39	char comm[16];
	40	};
	41
	42	struct fork_event {
	43	struct perf_event_header header;
	44	u32 pid, ppid;
	45	u32 tid, ptid;
393b2ad8	46	u64 time;
1fe2c106 FW	47	};
	48
	49	struct lost_event {
	50	struct perf_event_header header;
	51	u64 id;
	52	u64 lost;
	53	};
	54
18408ddc PZ	55	/*
	56	* PERF_FORMAT_ENABLED \| PERF_FORMAT_RUNNING \| PERF_FORMAT_ID
	57	*/
1fe2c106 FW	58	struct read_event {
1fe2c106 FW	59	struct perf_event_header header;
dc02bf71	60	u32 pid, tid;
1fe2c106 FW	61	u64 value;
	62	u64 time_enabled;
	63	u64 time_running;
	64	u64 id;
	65	};
	66
dd96c46b JO	67	struct throttle_event {
	68	struct perf_event_header header;
	69	u64 time;
	70	u64 id;
	71	u64 stream_id;
	72	};
a2854124 FW	73
	74	#define PERF_SAMPLE_MASK \
	75	(PERF_SAMPLE_IP \| PERF_SAMPLE_TID \| \
	76	PERF_SAMPLE_TIME \| PERF_SAMPLE_ADDR \| \
	77	PERF_SAMPLE_ID \| PERF_SAMPLE_STREAM_ID \| \
75562573 AH	78	PERF_SAMPLE_CPU \| PERF_SAMPLE_PERIOD \| \
75562573 AH	79	PERF_SAMPLE_IDENTIFIER)
a2854124	80
a65cb4b9 JO	81	/* perf sample has 16 bits size limit */
	82	#define PERF_SAMPLE_MAX_SIZE (1 << 16)
	83
180f95e2	84	struct sample_event {
fd39e055 AV	85	struct perf_event_header header;
	86	u64 array[];
	87	};
	88
0f6a3015	89	struct regs_dump {
5b95a4a3	90	u64 abi;
352ea45a	91	u64 mask;
0f6a3015	92	u64 *regs;
0c4e774f JO	93
	94	/* Cached values/mask filled by first register access. */
	95	u64 cache_regs[PERF_REGS_MAX];
	96	u64 cache_mask;
0f6a3015 JO	97	};
	98
	99	struct stack_dump {
	100	u16 offset;
	101	u64 size;
	102	char *data;
	103	};
	104
9ede473c JO	105	struct sample_read_value {
	106	u64 value;
	107	u64 id;
	108	};
	109
	110	struct sample_read {
	111	u64 time_enabled;
	112	u64 time_running;
	113	union {
	114	struct {
	115	u64 nr;
	116	struct sample_read_value *values;
	117	} group;
	118	struct sample_read_value one;
	119	};
	120	};
	121
0776eb59 JO	122	struct ip_callchain {
	123	u64 nr;
	124	u64 ips[0];
	125	};
	126
	127	struct branch_flags {
	128	u64 mispred:1;
	129	u64 predicted:1;
	130	u64 in_tx:1;
	131	u64 abort:1;
	132	u64 reserved:60;
	133	};
	134
	135	struct branch_entry {
	136	u64 from;
	137	u64 to;
	138	struct branch_flags flags;
	139	};
	140
	141	struct branch_stack {
	142	u64 nr;
	143	struct branch_entry entries[0];
	144	};
	145
8d50e5b4	146	struct perf_sample {
180f95e2 OH	147	u64 ip;
	148	u32 pid, tid;
	149	u64 time;
	150	u64 addr;
	151	u64 id;
	152	u64 stream_id;
180f95e2	153	u64 period;
05484298	154	u64 weight;
475eeab9	155	u64 transaction;
eed05fe7	156	u32 cpu;
180f95e2	157	u32 raw_size;
98a3b32c	158	u64 data_src;
bf493902 AH	159	u32 flags;
bf493902 AH	160	u16 insn_len;
180f95e2	161	void *raw_data;
eed05fe7	162	struct ip_callchain *callchain;
b5387528	163	struct branch_stack *branch_stack;
0f6a3015 JO	164	struct regs_dump user_regs;
0f6a3015 JO	165	struct stack_dump user_stack;
9ede473c	166	struct sample_read read;
180f95e2 OH	167	};
180f95e2 OH	168
98a3b32c SE	169	#define PERF_MEM_DATA_SRC_NONE \
	170	(PERF_MEM_S(OP, NA) \|\
	171	PERF_MEM_S(LVL, NA) \|\
	172	PERF_MEM_S(SNOOP, NA) \|\
	173	PERF_MEM_S(LOCK, NA) \|\
	174	PERF_MEM_S(TLB, NA))
	175
8d06367f ACM	176	struct build_id_event {
8d06367f ACM	177	struct perf_event_header header;
a1645ce1	178	pid_t pid;
9ac3e487	179	u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
8d06367f ACM	180	char filename[];
8d06367f ACM	181	};
fd39e055	182
98402807	183	enum perf_user_event_type { /* above any possible kernel type */
9aefcab0	184	PERF_RECORD_USER_TYPE_START = 64,
2c46dbb5	185	PERF_RECORD_HEADER_ATTR = 64,
6065210d	186	PERF_RECORD_HEADER_EVENT_TYPE = 65, /* depreceated */
9215545e	187	PERF_RECORD_HEADER_TRACING_DATA = 66,
c7929e47	188	PERF_RECORD_HEADER_BUILD_ID = 67,
98402807	189	PERF_RECORD_FINISHED_ROUND = 68,
2c46dbb5 TZ	190	PERF_RECORD_HEADER_MAX
	191	};
	192
4318bcb7 ACM	193	/*
	194	* The kernel collects the number of events it couldn't send in a stretch and
	195	* when possible sends this number in a PERF_RECORD_LOST event. The number of
	196	* such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
	197	* total_lost tells exactly how many events the kernel in fact lost, i.e. it is
	198	* the sum of all struct lost_event.lost fields reported.
	199	*
	200	* The total_period is needed because by default auto-freq is used, so
	201	* multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
	202	* the total number of low level events, it is necessary to to sum all struct
	203	* sample_event.period and stash the result in total_period.
	204	*/
	205	struct events_stats {
	206	u64 total_period;
	207	u64 total_non_filtered_period;
	208	u64 total_lost;
	209	u64 total_invalid_chains;
	210	u32 nr_events[PERF_RECORD_HEADER_MAX];
	211	u32 nr_non_filtered_samples;
	212	u32 nr_lost_warned;
	213	u32 nr_unknown_events;
	214	u32 nr_invalid_chains;
	215	u32 nr_unknown_id;
	216	u32 nr_unprocessable_samples;
	217	};
	218
2c46dbb5 TZ	219	struct attr_event {
	220	struct perf_event_header header;
	221	struct perf_event_attr attr;
	222	u64 id[];
8dc58101 TZ	223	};
8dc58101 TZ	224
cd19a035 TZ	225	#define MAX_EVENT_NAME 64
	226
	227	struct perf_trace_event_type {
	228	u64 event_id;
	229	char name[MAX_EVENT_NAME];
	230	};
	231
	232	struct event_type_event {
	233	struct perf_event_header header;
	234	struct perf_trace_event_type event_type;
	235	};
	236
9215545e TZ	237	struct tracing_data_event {
	238	struct perf_event_header header;
	239	u32 size;
	240	};
	241
8115d60c	242	union perf_event {
1fe2c106	243	struct perf_event_header header;
1fe2c106	244	struct mmap_event mmap;
5c5e854b	245	struct mmap2_event mmap2;
1fe2c106 FW	246	struct comm_event comm;
	247	struct fork_event fork;
	248	struct lost_event lost;
	249	struct read_event read;
dd96c46b	250	struct throttle_event throttle;
fd39e055	251	struct sample_event sample;
2c46dbb5	252	struct attr_event attr;
cd19a035	253	struct event_type_event event_type;
9215545e	254	struct tracing_data_event tracing_data;
c7929e47	255	struct build_id_event build_id;
8115d60c	256	};
66e274f3	257
8115d60c	258	void perf_event__print_totals(void);
62daacb5	259
45694aa7	260	struct perf_tool;
401b8e13	261	struct thread_map;
4aa65636	262
45694aa7	263	typedef int (perf_event__handler_t)(struct perf_tool tool,
d20deb64	264	union perf_event *event,
8115d60c	265	struct perf_sample *sample,
743eb868	266	struct machine *machine);
cf553114	267
45694aa7	268	int perf_event__synthesize_thread_map(struct perf_tool *tool,
d20deb64	269	struct thread_map *threads,
7c940c18	270	perf_event__handler_t process,
62605dc5	271	struct machine *machine, bool mmap_data);
45694aa7	272	int perf_event__synthesize_threads(struct perf_tool *tool,
d20deb64	273	perf_event__handler_t process,
62605dc5	274	struct machine *machine, bool mmap_data);
45694aa7	275	int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
d20deb64	276	perf_event__handler_t process,
0ae617be	277	struct machine *machine);
8115d60c	278
45694aa7	279	int perf_event__synthesize_modules(struct perf_tool *tool,
d20deb64	280	perf_event__handler_t process,
8115d60c ACM	281	struct machine *machine);
8115d60c ACM	282
45694aa7	283	int perf_event__process_comm(struct perf_tool *tool,
d20deb64 ACM	284	union perf_event *event,
d20deb64 ACM	285	struct perf_sample *sample,
743eb868	286	struct machine *machine);
45694aa7	287	int perf_event__process_lost(struct perf_tool *tool,
d20deb64 ACM	288	union perf_event *event,
d20deb64 ACM	289	struct perf_sample *sample,
743eb868	290	struct machine *machine);
45694aa7	291	int perf_event__process_mmap(struct perf_tool *tool,
d20deb64 ACM	292	union perf_event *event,
d20deb64 ACM	293	struct perf_sample *sample,
743eb868	294	struct machine *machine);
5c5e854b SE	295	int perf_event__process_mmap2(struct perf_tool *tool,
	296	union perf_event *event,
	297	struct perf_sample *sample,
	298	struct machine *machine);
f62d3f0f ACM	299	int perf_event__process_fork(struct perf_tool *tool,
	300	union perf_event *event,
	301	struct perf_sample *sample,
	302	struct machine *machine);
	303	int perf_event__process_exit(struct perf_tool *tool,
d20deb64 ACM	304	union perf_event *event,
d20deb64 ACM	305	struct perf_sample *sample,
743eb868	306	struct machine *machine);
45694aa7	307	int perf_event__process(struct perf_tool *tool,
d20deb64 ACM	308	union perf_event *event,
d20deb64 ACM	309	struct perf_sample *sample,
743eb868	310	struct machine *machine);
62daacb5	311
1ed091c4	312	struct addr_location;
316c7136 ACM	313
316c7136 ACM	314	int perf_event__preprocess_sample(const union perf_event *event,
743eb868	315	struct machine *machine,
8115d60c	316	struct addr_location *al,
e44baa3e	317	struct perf_sample *sample);
1ed091c4	318
9b0d2d87 AH	319	struct thread;
	320
	321	bool is_bts_event(struct perf_event_attr *attr);
	322	bool sample_addr_correlates_sym(struct perf_event_attr *attr);
	323	void perf_event__preprocess_sample_addr(union perf_event *event,
	324	struct perf_sample *sample,
9b0d2d87 AH	325	struct thread *thread,
	326	struct addr_location *al);
	327
8115d60c	328	const char *perf_event__name(unsigned int id);
c8446b9b	329
b1cf6f65	330	size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
352ea45a	331	u64 read_format);
74eec26f	332	int perf_event__synthesize_sample(union perf_event *event, u64 type,
352ea45a	333	u64 read_format,
74eec26f AV	334	const struct perf_sample *sample,
74eec26f AV	335	bool swapped);
d0dd74e8	336
a18382b6 JO	337	int perf_event__synthesize_mmap_events(struct perf_tool *tool,
	338	union perf_event *event,
	339	pid_t pid, pid_t tgid,
	340	perf_event__handler_t process,
	341	struct machine *machine,
	342	bool mmap_data);
	343
482ad897 ACM	344	size_t perf_event__fprintf_comm(union perf_event event, FILE fp);
482ad897 ACM	345	size_t perf_event__fprintf_mmap(union perf_event event, FILE fp);
5c5e854b	346	size_t perf_event__fprintf_mmap2(union perf_event event, FILE fp);
482ad897 ACM	347	size_t perf_event__fprintf_task(union perf_event event, FILE fp);
	348	size_t perf_event__fprintf(union perf_event event, FILE fp);
	349
29b596b5 AH	350	u64 kallsyms__get_function_start(const char *kallsyms_filename,
	351	const char *symbol_name);
	352
8b40f521	353	#endif /* __PERF_RECORD_H */