[mirror_ubuntu-bionic-kernel.git] / tools / perf / util / header.h

/* SPDX-License-Identifier: GPL-2.0 */
#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_features(struct perf_tool *tool,
				    struct perf_session *session,
				    struct perf_evlist *evlist,
				    perf_event__handler_t process);

int perf_event__process_feature(struct perf_tool *tool,
				union perf_event *event,
				struct perf_session *session);

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

struct feat_fd;

int do_write(struct feat_fd *fd, const void *buf, size_t size);

int write_padded(struct feat_fd *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
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
8b40f521 JK	2	#ifndef __PERF_HEADER_H
8b40f521 JK	3	#define __PERF_HEADER_H
7c6a1c65	4
d2709c7c	5	#include <linux/perf_event.h>
7c6a1c65	6	#include <sys/types.h>
8d06367f	7	#include <stdbool.h>
d944c4ee BP	8	#include <linux/bitmap.h>
d944c4ee BP	9	#include <linux/types.h>
ef12a141	10	#include "event.h"
f0ce888c	11	#include "env.h"
db9f11e3	12
37562eac	13	enum {
b1e5a9be	14	HEADER_RESERVED = 0, /* always cleared */
781ba9d2	15	HEADER_FIRST_FEATURE = 1,
2eeaaa09	16	HEADER_TRACING_DATA = 1,
37562eac	17	HEADER_BUILD_ID,
fbe96f29 SE	18
	19	HEADER_HOSTNAME,
	20	HEADER_OSRELEASE,
	21	HEADER_VERSION,
	22	HEADER_ARCH,
	23	HEADER_NRCPUS,
	24	HEADER_CPUDESC,
	25	HEADER_CPUID,
	26	HEADER_TOTAL_MEM,
	27	HEADER_CMDLINE,
	28	HEADER_EVENT_DESC,
	29	HEADER_CPU_TOPOLOGY,
	30	HEADER_NUMA_TOPOLOGY,
330aa675	31	HEADER_BRANCH_STACK,
50a9667c	32	HEADER_PMU_MAPPINGS,
a8bb559b	33	HEADER_GROUP_DESC,
4025ea40	34	HEADER_AUXTRACE,
ffa517ad	35	HEADER_STAT,
720e98b5	36	HEADER_CACHE,
37562eac	37	HEADER_LAST_FEATURE,
b1e5a9be	38	HEADER_FEAT_BITS = 256,
37562eac	39	};
2ba08250	40
2a08c3ec JO	41	enum perf_header_version {
	42	PERF_HEADER_VERSION_1,
	43	PERF_HEADER_VERSION_2,
	44	};
	45
37562eac ACM	46	struct perf_file_section {
	47	u64 offset;
	48	u64 size;
	49	};
	50
	51	struct perf_file_header {
	52	u64 magic;
	53	u64 size;
	54	u64 attr_size;
	55	struct perf_file_section attrs;
	56	struct perf_file_section data;
44b3c578	57	/* event_types is ignored */
37562eac ACM	58	struct perf_file_section event_types;
	59	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
	60	};
	61
8dc58101 TZ	62	struct perf_pipe_file_header {
	63	u64 magic;
	64	u64 size;
	65	};
	66
37562eac ACM	67	struct perf_header;
37562eac ACM	68
1c0b04d1	69	int perf_file_header__read(struct perf_file_header *header,
37562eac ACM	70	struct perf_header *ph, int fd);
37562eac ACM	71
7c6a1c65	72	struct perf_header {
2a08c3ec JO	73	enum perf_header_version version;
	74	bool needs_swap;
	75	u64 data_offset;
	76	u64 data_size;
	77	u64 feat_offset;
db9f11e3	78	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
ce80d3be	79	struct perf_env env;
7c6a1c65 PZ	80	};
7c6a1c65 PZ	81
361c99a6	82	struct perf_evlist;
d20deb64	83	struct perf_session;
361c99a6	84
d4339569	85	int perf_session__read_header(struct perf_session *session);
a91e5431 ACM	86	int perf_session__write_header(struct perf_session *session,
	87	struct perf_evlist *evlist,
	88	int fd, bool at_exit);
8dc58101	89	int perf_header__write_pipe(int fd);
7c6a1c65	90
1c0b04d1 ACM	91	void perf_header__set_feat(struct perf_header *header, int feat);
	92	void perf_header__clear_feat(struct perf_header *header, int feat);
	93	bool perf_header__has_feat(const struct perf_header *header, int feat);
7c6a1c65	94
fbe96f29 SE	95	int perf_header__set_cmdline(int argc, const char **argv);
fbe96f29 SE	96
1c0b04d1	97	int perf_header__process_sections(struct perf_header *header, int fd,
fbe96f29	98	void *data,
1c0b04d1	99	int (process)(struct perf_file_section section,
fbe96f29 SE	100	struct perf_header *ph,
	101	int feat, int fd, void *data));
	102
	103	int perf_header__fprintf_info(struct perf_session s, FILE fp, bool full);
37562eac	104
e9def1b2 DCC	105	int perf_event__synthesize_features(struct perf_tool *tool,
	106	struct perf_session *session,
	107	struct perf_evlist *evlist,
	108	perf_event__handler_t process);
	109
	110	int perf_event__process_feature(struct perf_tool *tool,
	111	union perf_event *event,
	112	struct perf_session *session);
	113
45694aa7	114	int perf_event__synthesize_attr(struct perf_tool *tool,
f4d83436	115	struct perf_event_attr attr, u32 ids, u64 id,
743eb868	116	perf_event__handler_t process);
45694aa7	117	int perf_event__synthesize_attrs(struct perf_tool *tool,
d20deb64 ACM	118	struct perf_session *session,
d20deb64 ACM	119	perf_event__handler_t process);
a6e52817 JO	120	int perf_event__synthesize_event_update_unit(struct perf_tool *tool,
	121	struct perf_evsel *evsel,
	122	perf_event__handler_t process);
daeecbc0 JO	123	int perf_event__synthesize_event_update_scale(struct perf_tool *tool,
	124	struct perf_evsel *evsel,
	125	perf_event__handler_t process);
802c9048 JO	126	int perf_event__synthesize_event_update_name(struct perf_tool *tool,
	127	struct perf_evsel *evsel,
	128	perf_event__handler_t process);
86ebb09f JO	129	int perf_event__synthesize_event_update_cpus(struct perf_tool *tool,
	130	struct perf_evsel *evsel,
	131	perf_event__handler_t process);
47c3d109 AH	132	int perf_event__process_attr(struct perf_tool tool, union perf_event event,
47c3d109 AH	133	struct perf_evlist **pevlist);
b8f8eb84	134	int perf_event__process_event_update(struct perf_tool *tool,
ffe77725 JO	135	union perf_event *event,
ffe77725 JO	136	struct perf_evlist **pevlist);
c853f939	137	size_t perf_event__fprintf_event_update(union perf_event event, FILE fp);
8115d60c	138
45694aa7	139	int perf_event__synthesize_tracing_data(struct perf_tool *tool,
d20deb64	140	int fd, struct perf_evlist *evlist,
743eb868	141	perf_event__handler_t process);
47c3d109 AH	142	int perf_event__process_tracing_data(struct perf_tool *tool,
47c3d109 AH	143	union perf_event *event,
8115d60c ACM	144	struct perf_session *session);
8115d60c ACM	145
45694aa7	146	int perf_event__synthesize_build_id(struct perf_tool *tool,
d20deb64	147	struct dso *pos, u16 misc,
8115d60c	148	perf_event__handler_t process,
743eb868	149	struct machine *machine);
45694aa7	150	int perf_event__process_build_id(struct perf_tool *tool,
d20deb64	151	union perf_event *event,
8115d60c	152	struct perf_session *session);
e84ba4e2	153	bool is_perf_magic(u64 magic);
fbe96f29	154
e195fac8 NK	155	#define NAME_ALIGN 64
e195fac8 NK	156
ccebbeb6	157	struct feat_fd;
3b8f51a6	158
ccebbeb6 DCC	159	int do_write(struct feat_fd fd, const void buf, size_t size);
	160
	161	int write_padded(struct feat_fd fd, const void bf,
	162	size_t count, size_t count_aligned);
1f625b0b	163
fbe96f29 SE	164	/*
	165	* arch specific callback
	166	*/
	167	int get_cpuid(char *buffer, size_t sz);
	168
933f82ff	169	char *get_cpuid_str(void);
8b40f521	170	#endif /* __PERF_HEADER_H */