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

#ifndef __PERF_HEADER_H
#define __PERF_HEADER_H

#include <linux/perf_event.h>
#include <sys/types.h>
#include <stdbool.h>
#include <linux/bitmap.h>
#include <linux/types.h>
#include "event.h"


enum {
	HEADER_RESERVED		= 0,	/* always cleared */
	HEADER_FIRST_FEATURE	= 1,
	HEADER_TRACING_DATA	= 1,
	HEADER_BUILD_ID,

	HEADER_HOSTNAME,
	HEADER_OSRELEASE,
	HEADER_VERSION,
	HEADER_ARCH,
	HEADER_NRCPUS,
	HEADER_CPUDESC,
	HEADER_CPUID,
	HEADER_TOTAL_MEM,
	HEADER_CMDLINE,
	HEADER_EVENT_DESC,
	HEADER_CPU_TOPOLOGY,
	HEADER_NUMA_TOPOLOGY,
	HEADER_BRANCH_STACK,
	HEADER_PMU_MAPPINGS,
	HEADER_GROUP_DESC,
	HEADER_LAST_FEATURE,
	HEADER_FEAT_BITS	= 256,
};

enum perf_header_version {
	PERF_HEADER_VERSION_1,
	PERF_HEADER_VERSION_2,
};

struct perf_file_section {
	u64 offset;
	u64 size;
};

struct perf_file_header {
	u64				magic;
	u64				size;
	u64				attr_size;
	struct perf_file_section	attrs;
	struct perf_file_section	data;
	/* event_types is ignored */
	struct perf_file_section	event_types;
	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
};

struct perf_pipe_file_header {
	u64				magic;
	u64				size;
};

struct perf_header;

int perf_file_header__read(struct perf_file_header *header,
			   struct perf_header *ph, int fd);

struct perf_session_env {
	char			*hostname;
	char			*os_release;
	char			*version;
	char			*arch;
	int			nr_cpus_online;
	int			nr_cpus_avail;
	char			*cpu_desc;
	char			*cpuid;
	unsigned long long	total_mem;

	int			nr_cmdline;
	int			nr_sibling_cores;
	int			nr_sibling_threads;
	int			nr_numa_nodes;
	int			nr_pmu_mappings;
	int			nr_groups;
	char			*cmdline;
	char			*sibling_cores;
	char			*sibling_threads;
	char			*numa_nodes;
	char			*pmu_mappings;
};

struct perf_header {
	enum perf_header_version	version;
	bool				needs_swap;
	u64				data_offset;
	u64				data_size;
	u64				feat_offset;
	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
	struct perf_session_env 	env;
};

struct perf_evlist;
struct perf_session;

int perf_session__read_header(struct perf_session *session);
int perf_session__write_header(struct perf_session *session,
			       struct perf_evlist *evlist,
			       int fd, bool at_exit);
int perf_header__write_pipe(int fd);

void perf_header__set_feat(struct perf_header *header, int feat);
void perf_header__clear_feat(struct perf_header *header, int feat);
bool perf_header__has_feat(const struct perf_header *header, int feat);

int perf_header__set_cmdline(int argc, const char **argv);

int perf_header__process_sections(struct perf_header *header, int fd,
				  void *data,
				  int (*process)(struct perf_file_section *section,
				  struct perf_header *ph,
				  int feat, int fd, void *data));

int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);

int build_id_cache__add_s(const char *sbuild_id, const char *debugdir,
			  const char *name, bool is_kallsyms, bool is_vdso);
int build_id_cache__remove_s(const char *sbuild_id, const char *debugdir);

int perf_event__synthesize_attr(struct perf_tool *tool,
				struct perf_event_attr *attr, u32 ids, u64 *id,
				perf_event__handler_t process);
int perf_event__synthesize_attrs(struct perf_tool *tool,
				 struct perf_session *session,
				 perf_event__handler_t process);
int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
			     struct perf_evlist **pevlist);

int perf_event__synthesize_tracing_data(struct perf_tool *tool,
					int fd, struct perf_evlist *evlist,
					perf_event__handler_t process);
int perf_event__process_tracing_data(struct perf_tool *tool,
				     union perf_event *event,
				     struct perf_session *session);

int perf_event__synthesize_build_id(struct perf_tool *tool,
				    struct dso *pos, u16 misc,
				    perf_event__handler_t process,
				    struct machine *machine);
int perf_event__process_build_id(struct perf_tool *tool,
				 union perf_event *event,
				 struct perf_session *session);
bool is_perf_magic(u64 magic);

/*
 * arch specific callback
 */
int get_cpuid(char *buffer, size_t sz);

#endif /* __PERF_HEADER_H */
Commit	Line	Data
8b40f521 JK	1	#ifndef __PERF_HEADER_H
8b40f521 JK	2	#define __PERF_HEADER_H
7c6a1c65	3
d2709c7c	4	#include <linux/perf_event.h>
7c6a1c65	5	#include <sys/types.h>
8d06367f	6	#include <stdbool.h>
d944c4ee BP	7	#include <linux/bitmap.h>
d944c4ee BP	8	#include <linux/types.h>
ef12a141	9	#include "event.h"
7c6a1c65	10
db9f11e3	11
37562eac	12	enum {
b1e5a9be	13	HEADER_RESERVED = 0, /* always cleared */
781ba9d2	14	HEADER_FIRST_FEATURE = 1,
2eeaaa09	15	HEADER_TRACING_DATA = 1,
37562eac	16	HEADER_BUILD_ID,
fbe96f29 SE	17
	18	HEADER_HOSTNAME,
	19	HEADER_OSRELEASE,
	20	HEADER_VERSION,
	21	HEADER_ARCH,
	22	HEADER_NRCPUS,
	23	HEADER_CPUDESC,
	24	HEADER_CPUID,
	25	HEADER_TOTAL_MEM,
	26	HEADER_CMDLINE,
	27	HEADER_EVENT_DESC,
	28	HEADER_CPU_TOPOLOGY,
	29	HEADER_NUMA_TOPOLOGY,
330aa675	30	HEADER_BRANCH_STACK,
50a9667c	31	HEADER_PMU_MAPPINGS,
a8bb559b	32	HEADER_GROUP_DESC,
37562eac	33	HEADER_LAST_FEATURE,
b1e5a9be	34	HEADER_FEAT_BITS = 256,
37562eac	35	};
2ba08250	36
2a08c3ec JO	37	enum perf_header_version {
	38	PERF_HEADER_VERSION_1,
	39	PERF_HEADER_VERSION_2,
	40	};
	41
37562eac ACM	42	struct perf_file_section {
	43	u64 offset;
	44	u64 size;
	45	};
	46
	47	struct perf_file_header {
	48	u64 magic;
	49	u64 size;
	50	u64 attr_size;
	51	struct perf_file_section attrs;
	52	struct perf_file_section data;
44b3c578	53	/* event_types is ignored */
37562eac ACM	54	struct perf_file_section event_types;
	55	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
	56	};
	57
8dc58101 TZ	58	struct perf_pipe_file_header {
	59	u64 magic;
	60	u64 size;
	61	};
	62
37562eac ACM	63	struct perf_header;
37562eac ACM	64
1c0b04d1	65	int perf_file_header__read(struct perf_file_header *header,
37562eac ACM	66	struct perf_header *ph, int fd);
37562eac ACM	67
e93699b3 NK	68	struct perf_session_env {
	69	char *hostname;
	70	char *os_release;
	71	char *version;
	72	char *arch;
	73	int nr_cpus_online;
	74	int nr_cpus_avail;
	75	char *cpu_desc;
	76	char *cpuid;
	77	unsigned long long total_mem;
	78
	79	int nr_cmdline;
e93699b3	80	int nr_sibling_cores;
e93699b3	81	int nr_sibling_threads;
e93699b3	82	int nr_numa_nodes;
e93699b3	83	int nr_pmu_mappings;
a8bb559b	84	int nr_groups;
3ba4d2e1 ACM	85	char *cmdline;
	86	char *sibling_cores;
	87	char *sibling_threads;
	88	char *numa_nodes;
	89	char *pmu_mappings;
e93699b3 NK	90	};
e93699b3 NK	91
7c6a1c65	92	struct perf_header {
2a08c3ec JO	93	enum perf_header_version version;
	94	bool needs_swap;
	95	u64 data_offset;
	96	u64 data_size;
	97	u64 feat_offset;
db9f11e3	98	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
2a08c3ec	99	struct perf_session_env env;
7c6a1c65 PZ	100	};
7c6a1c65 PZ	101
361c99a6	102	struct perf_evlist;
d20deb64	103	struct perf_session;
361c99a6	104
d4339569	105	int perf_session__read_header(struct perf_session *session);
a91e5431 ACM	106	int perf_session__write_header(struct perf_session *session,
	107	struct perf_evlist *evlist,
	108	int fd, bool at_exit);
8dc58101	109	int perf_header__write_pipe(int fd);
7c6a1c65	110
1c0b04d1 ACM	111	void perf_header__set_feat(struct perf_header *header, int feat);
	112	void perf_header__clear_feat(struct perf_header *header, int feat);
	113	bool perf_header__has_feat(const struct perf_header *header, int feat);
7c6a1c65	114
fbe96f29 SE	115	int perf_header__set_cmdline(int argc, const char **argv);
fbe96f29 SE	116
1c0b04d1	117	int perf_header__process_sections(struct perf_header *header, int fd,
fbe96f29	118	void *data,
1c0b04d1	119	int (process)(struct perf_file_section section,
fbe96f29 SE	120	struct perf_header *ph,
	121	int feat, int fd, void *data));
	122
	123	int perf_header__fprintf_info(struct perf_session s, FILE fp, bool full);
37562eac	124
ef12a141	125	int build_id_cache__add_s(const char sbuild_id, const char debugdir,
7dbf4dcf	126	const char *name, bool is_kallsyms, bool is_vdso);
ef12a141 ACM	127	int build_id_cache__remove_s(const char sbuild_id, const char debugdir);
ef12a141 ACM	128
45694aa7	129	int perf_event__synthesize_attr(struct perf_tool *tool,
f4d83436	130	struct perf_event_attr attr, u32 ids, u64 id,
743eb868	131	perf_event__handler_t process);
45694aa7	132	int perf_event__synthesize_attrs(struct perf_tool *tool,
d20deb64 ACM	133	struct perf_session *session,
d20deb64 ACM	134	perf_event__handler_t process);
47c3d109 AH	135	int perf_event__process_attr(struct perf_tool tool, union perf_event event,
47c3d109 AH	136	struct perf_evlist **pevlist);
8115d60c	137
45694aa7	138	int perf_event__synthesize_tracing_data(struct perf_tool *tool,
d20deb64	139	int fd, struct perf_evlist *evlist,
743eb868	140	perf_event__handler_t process);
47c3d109 AH	141	int perf_event__process_tracing_data(struct perf_tool *tool,
47c3d109 AH	142	union perf_event *event,
8115d60c ACM	143	struct perf_session *session);
8115d60c ACM	144
45694aa7	145	int perf_event__synthesize_build_id(struct perf_tool *tool,
d20deb64	146	struct dso *pos, u16 misc,
8115d60c	147	perf_event__handler_t process,
743eb868	148	struct machine *machine);
45694aa7	149	int perf_event__process_build_id(struct perf_tool *tool,
d20deb64	150	union perf_event *event,
8115d60c	151	struct perf_session *session);
e84ba4e2	152	bool is_perf_magic(u64 magic);
fbe96f29 SE	153
	154	/*
	155	* arch specific callback
	156	*/
	157	int get_cpuid(char *buffer, size_t sz);
	158
8b40f521	159	#endif /* __PERF_HEADER_H */