[mirror_ubuntu-bionic-kernel.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"
#include "env.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_AUXTRACE,
	HEADER_STAT,
	HEADER_CACHE,
	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_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_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 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__synthesize_event_update_unit(struct perf_tool *tool,
					     struct perf_evsel *evsel,
					     perf_event__handler_t process);
int perf_event__synthesize_event_update_scale(struct perf_tool *tool,
					      struct perf_evsel *evsel,
					      perf_event__handler_t process);
int perf_event__synthesize_event_update_name(struct perf_tool *tool,
					     struct perf_evsel *evsel,
					     perf_event__handler_t process);
int perf_event__synthesize_event_update_cpus(struct perf_tool *tool,
					     struct perf_evsel *evsel,
					     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__process_event_update(struct perf_tool *tool,
				     union perf_event *event,
				     struct perf_evlist **pevlist);
size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);

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

#define NAME_ALIGN 64

int write_padded(int fd, const void *bf, size_t count, size_t count_aligned);

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

char *get_cpuid_str(void);
#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"
f0ce888c	10	#include "env.h"
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,
4025ea40	33	HEADER_AUXTRACE,
ffa517ad	34	HEADER_STAT,
720e98b5	35	HEADER_CACHE,
37562eac	36	HEADER_LAST_FEATURE,
b1e5a9be	37	HEADER_FEAT_BITS = 256,
37562eac	38	};
2ba08250	39
2a08c3ec JO	40	enum perf_header_version {
	41	PERF_HEADER_VERSION_1,
	42	PERF_HEADER_VERSION_2,
	43	};
	44
37562eac ACM	45	struct perf_file_section {
	46	u64 offset;
	47	u64 size;
	48	};
	49
	50	struct perf_file_header {
	51	u64 magic;
	52	u64 size;
	53	u64 attr_size;
	54	struct perf_file_section attrs;
	55	struct perf_file_section data;
44b3c578	56	/* event_types is ignored */
37562eac ACM	57	struct perf_file_section event_types;
	58	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
	59	};
	60
8dc58101 TZ	61	struct perf_pipe_file_header {
	62	u64 magic;
	63	u64 size;
	64	};
	65
37562eac ACM	66	struct perf_header;
37562eac ACM	67
1c0b04d1	68	int perf_file_header__read(struct perf_file_header *header,
37562eac ACM	69	struct perf_header *ph, int fd);
37562eac ACM	70
7c6a1c65	71	struct perf_header {
2a08c3ec JO	72	enum perf_header_version version;
	73	bool needs_swap;
	74	u64 data_offset;
	75	u64 data_size;
	76	u64 feat_offset;
db9f11e3	77	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
ce80d3be	78	struct perf_env env;
7c6a1c65 PZ	79	};
7c6a1c65 PZ	80
361c99a6	81	struct perf_evlist;
d20deb64	82	struct perf_session;
361c99a6	83
d4339569	84	int perf_session__read_header(struct perf_session *session);
a91e5431 ACM	85	int perf_session__write_header(struct perf_session *session,
	86	struct perf_evlist *evlist,
	87	int fd, bool at_exit);
8dc58101	88	int perf_header__write_pipe(int fd);
7c6a1c65	89
1c0b04d1 ACM	90	void perf_header__set_feat(struct perf_header *header, int feat);
	91	void perf_header__clear_feat(struct perf_header *header, int feat);
	92	bool perf_header__has_feat(const struct perf_header *header, int feat);
7c6a1c65	93
fbe96f29 SE	94	int perf_header__set_cmdline(int argc, const char **argv);
fbe96f29 SE	95
1c0b04d1	96	int perf_header__process_sections(struct perf_header *header, int fd,
fbe96f29	97	void *data,
1c0b04d1	98	int (process)(struct perf_file_section section,
fbe96f29 SE	99	struct perf_header *ph,
	100	int feat, int fd, void *data));
	101
	102	int perf_header__fprintf_info(struct perf_session s, FILE fp, bool full);
37562eac	103
45694aa7	104	int perf_event__synthesize_attr(struct perf_tool *tool,
f4d83436	105	struct perf_event_attr attr, u32 ids, u64 id,
743eb868	106	perf_event__handler_t process);
45694aa7	107	int perf_event__synthesize_attrs(struct perf_tool *tool,
d20deb64 ACM	108	struct perf_session *session,
d20deb64 ACM	109	perf_event__handler_t process);
a6e52817 JO	110	int perf_event__synthesize_event_update_unit(struct perf_tool *tool,
	111	struct perf_evsel *evsel,
	112	perf_event__handler_t process);
daeecbc0 JO	113	int perf_event__synthesize_event_update_scale(struct perf_tool *tool,
	114	struct perf_evsel *evsel,
	115	perf_event__handler_t process);
802c9048 JO	116	int perf_event__synthesize_event_update_name(struct perf_tool *tool,
	117	struct perf_evsel *evsel,
	118	perf_event__handler_t process);
86ebb09f JO	119	int perf_event__synthesize_event_update_cpus(struct perf_tool *tool,
	120	struct perf_evsel *evsel,
	121	perf_event__handler_t process);
47c3d109 AH	122	int perf_event__process_attr(struct perf_tool tool, union perf_event event,
47c3d109 AH	123	struct perf_evlist **pevlist);
b8f8eb84	124	int perf_event__process_event_update(struct perf_tool *tool,
ffe77725 JO	125	union perf_event *event,
ffe77725 JO	126	struct perf_evlist **pevlist);
c853f939	127	size_t perf_event__fprintf_event_update(union perf_event event, FILE fp);
8115d60c	128
45694aa7	129	int perf_event__synthesize_tracing_data(struct perf_tool *tool,
d20deb64	130	int fd, struct perf_evlist *evlist,
743eb868	131	perf_event__handler_t process);
47c3d109 AH	132	int perf_event__process_tracing_data(struct perf_tool *tool,
47c3d109 AH	133	union perf_event *event,
8115d60c ACM	134	struct perf_session *session);
8115d60c ACM	135
45694aa7	136	int perf_event__synthesize_build_id(struct perf_tool *tool,
d20deb64	137	struct dso *pos, u16 misc,
8115d60c	138	perf_event__handler_t process,
743eb868	139	struct machine *machine);
45694aa7	140	int perf_event__process_build_id(struct perf_tool *tool,
d20deb64	141	union perf_event *event,
8115d60c	142	struct perf_session *session);
e84ba4e2	143	bool is_perf_magic(u64 magic);
fbe96f29	144
e195fac8 NK	145	#define NAME_ALIGN 64
	146
	147	int write_padded(int fd, const void *bf, size_t count, size_t count_aligned);
1f625b0b	148
fbe96f29 SE	149	/*
	150	* arch specific callback
	151	*/
	152	int get_cpuid(char *buffer, size_t sz);
	153
933f82ff	154	char *get_cpuid_str(void);
8b40f521	155	#endif /* __PERF_HEADER_H */