[mirror_ubuntu-jammy-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 "types.h"
#include "event.h"

#include <linux/bitmap.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_LAST_FEATURE,
	HEADER_FEAT_BITS	= 256,
};

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;
	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;
	char			*cmdline;
	int			nr_sibling_cores;
	char			*sibling_cores;
	int			nr_sibling_threads;
	char			*sibling_threads;
	int			nr_numa_nodes;
	char			*numa_nodes;
	int			nr_pmu_mappings;
	char			*pmu_mappings;
};

struct perf_header {
	int			frozen;
	bool			needs_swap;
	s64			attr_offset;
	u64			data_offset;
	u64			data_size;
	u64			event_offset;
	u64			event_size;
	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 fd);
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);

int perf_header__push_event(u64 id, const char *name);
char *perf_header__find_event(u64 id);

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(union perf_event *event, struct perf_evlist **pevlist);

int perf_event__synthesize_event_type(struct perf_tool *tool,
				      u64 event_id, char *name,
				      perf_event__handler_t process,
				      struct machine *machine);
int perf_event__synthesize_event_types(struct perf_tool *tool,
				       perf_event__handler_t process,
				       struct machine *machine);
int perf_event__process_event_type(struct perf_tool *tool,
				   union perf_event *event);

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(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>
7c6a1c65	7	#include "types.h"
ef12a141	8	#include "event.h"
7c6a1c65	9
db9f11e3 FW	10	#include <linux/bitmap.h>
db9f11e3 FW	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,
37562eac	32	HEADER_LAST_FEATURE,
b1e5a9be	33	HEADER_FEAT_BITS = 256,
37562eac	34	};
2ba08250	35
37562eac ACM	36	struct perf_file_section {
	37	u64 offset;
	38	u64 size;
	39	};
	40
	41	struct perf_file_header {
	42	u64 magic;
	43	u64 size;
	44	u64 attr_size;
	45	struct perf_file_section attrs;
	46	struct perf_file_section data;
	47	struct perf_file_section event_types;
	48	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
	49	};
	50
8dc58101 TZ	51	struct perf_pipe_file_header {
	52	u64 magic;
	53	u64 size;
	54	};
	55
37562eac ACM	56	struct perf_header;
37562eac ACM	57
1c0b04d1	58	int perf_file_header__read(struct perf_file_header *header,
37562eac ACM	59	struct perf_header *ph, int fd);
37562eac ACM	60
e93699b3 NK	61	struct perf_session_env {
	62	char *hostname;
	63	char *os_release;
	64	char *version;
	65	char *arch;
	66	int nr_cpus_online;
	67	int nr_cpus_avail;
	68	char *cpu_desc;
	69	char *cpuid;
	70	unsigned long long total_mem;
	71
	72	int nr_cmdline;
	73	char *cmdline;
	74	int nr_sibling_cores;
	75	char *sibling_cores;
	76	int nr_sibling_threads;
	77	char *sibling_threads;
	78	int nr_numa_nodes;
	79	char *numa_nodes;
	80	int nr_pmu_mappings;
	81	char *pmu_mappings;
	82	};
	83
7c6a1c65	84	struct perf_header {
2ba08250	85	int frozen;
eed05fe7	86	bool needs_swap;
2ba08250 FW	87	s64 attr_offset;
	88	u64 data_offset;
	89	u64 data_size;
	90	u64 event_offset;
	91	u64 event_size;
db9f11e3	92	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
e93699b3	93	struct perf_session_env env;
7c6a1c65 PZ	94	};
7c6a1c65 PZ	95
361c99a6	96	struct perf_evlist;
d20deb64	97	struct perf_session;
361c99a6	98
a91e5431 ACM	99	int perf_session__read_header(struct perf_session *session, int fd);
	100	int perf_session__write_header(struct perf_session *session,
	101	struct perf_evlist *evlist,
	102	int fd, bool at_exit);
8dc58101	103	int perf_header__write_pipe(int fd);
7c6a1c65	104
ae99fb2c	105	int perf_header__push_event(u64 id, const char *name);
8755a8f2 AV	106	char *perf_header__find_event(u64 id);
8755a8f2 AV	107
1c0b04d1 ACM	108	void perf_header__set_feat(struct perf_header *header, int feat);
	109	void perf_header__clear_feat(struct perf_header *header, int feat);
	110	bool perf_header__has_feat(const struct perf_header *header, int feat);
7c6a1c65	111
fbe96f29 SE	112	int perf_header__set_cmdline(int argc, const char **argv);
fbe96f29 SE	113
1c0b04d1	114	int perf_header__process_sections(struct perf_header *header, int fd,
fbe96f29	115	void *data,
1c0b04d1	116	int (process)(struct perf_file_section section,
fbe96f29 SE	117	struct perf_header *ph,
	118	int feat, int fd, void *data));
	119
	120	int perf_header__fprintf_info(struct perf_session s, FILE fp, bool full);
37562eac	121
ef12a141	122	int build_id_cache__add_s(const char sbuild_id, const char debugdir,
7dbf4dcf	123	const char *name, bool is_kallsyms, bool is_vdso);
ef12a141 ACM	124	int build_id_cache__remove_s(const char sbuild_id, const char debugdir);
ef12a141 ACM	125
45694aa7	126	int perf_event__synthesize_attr(struct perf_tool *tool,
f4d83436	127	struct perf_event_attr attr, u32 ids, u64 id,
743eb868	128	perf_event__handler_t process);
45694aa7	129	int perf_event__synthesize_attrs(struct perf_tool *tool,
d20deb64 ACM	130	struct perf_session *session,
d20deb64 ACM	131	perf_event__handler_t process);
10d0f086	132	int perf_event__process_attr(union perf_event event, struct perf_evlist *pevlist);
8115d60c	133
45694aa7	134	int perf_event__synthesize_event_type(struct perf_tool *tool,
d20deb64	135	u64 event_id, char *name,
8115d60c	136	perf_event__handler_t process,
743eb868	137	struct machine *machine);
45694aa7	138	int perf_event__synthesize_event_types(struct perf_tool *tool,
d20deb64	139	perf_event__handler_t process,
743eb868	140	struct machine *machine);
45694aa7	141	int perf_event__process_event_type(struct perf_tool *tool,
743eb868	142	union perf_event *event);
c7929e47	143
45694aa7	144	int perf_event__synthesize_tracing_data(struct perf_tool *tool,
d20deb64	145	int fd, struct perf_evlist *evlist,
743eb868	146	perf_event__handler_t process);
8115d60c ACM	147	int perf_event__process_tracing_data(union perf_event *event,
	148	struct perf_session *session);
	149
45694aa7	150	int perf_event__synthesize_build_id(struct perf_tool *tool,
d20deb64	151	struct dso *pos, u16 misc,
8115d60c	152	perf_event__handler_t process,
743eb868	153	struct machine *machine);
45694aa7	154	int perf_event__process_build_id(struct perf_tool *tool,
d20deb64	155	union perf_event *event,
8115d60c	156	struct perf_session *session);
e84ba4e2	157	bool is_perf_magic(u64 magic);
fbe96f29 SE	158
	159	/*
	160	* arch specific callback
	161	*/
	162	int get_cpuid(char *buffer, size_t sz);
	163
8b40f521	164	#endif /* __PERF_HEADER_H */