[linux-block.git] / tools / perf / util / header.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_HEADER_H
#define __PERF_HEADER_H

#include <linux/stddef.h>
#include <linux/perf_event.h>
#include <sys/types.h>
#include <stdio.h> // FILE
#include <stdbool.h>
#include <linux/bitmap.h>
#include <linux/types.h>
#include "env.h"
#include <perf/cpumap.h>

struct evlist;
union perf_event;
struct perf_header;
struct perf_session;
struct perf_tool;

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_SAMPLE_TIME,
	HEADER_MEM_TOPOLOGY,
	HEADER_CLOCKID,
	HEADER_DIR_FORMAT,
	HEADER_BPF_PROG_INFO,
	HEADER_BPF_BTF,
	HEADER_COMPRESSED,
	HEADER_CPU_PMU_CAPS,
	HEADER_CLOCK_DATA,
	HEADER_HYBRID_TOPOLOGY,
	HEADER_PMU_CAPS,
	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: Header representation on disk.
 */
struct perf_file_header {
	/** @magic: Holds "PERFILE2". */
	u64				magic;
	/** @size: Size of this header - sizeof(struct perf_file_header). */
	u64				size;
	/**
	 * @attr_size: Size of attrs entries - sizeof(struct perf_event_attr) +
	 * sizeof(struct perf_file_section).
	 */
	u64				attr_size;
	/** @attrs: Offset and size of file section holding attributes. */
	struct perf_file_section	attrs;
	/** @data: Offset and size of file section holding regular event data. */
	struct perf_file_section	data;
	/** @event_types: Ignored. */
	struct perf_file_section	event_types;
	/**
	 * @adds_features: Bitmap of features. The features are immediately after the data section.
	 */
	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
};

struct perf_pipe_file_header {
	u64				magic;
	u64				size;
};

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 feat_fd {
	struct perf_header *ph;
	int		   fd;
	void		   *buf;	/* Either buf != NULL or fd >= 0 */
	ssize_t		   offset;
	size_t		   size;
	struct evsel	   *events;
};

struct perf_header_feature_ops {
	int	   (*write)(struct feat_fd *ff, struct evlist *evlist);
	void	   (*print)(struct feat_fd *ff, FILE *fp);
	int	   (*process)(struct feat_fd *ff, void *data);
	const char *name;
	bool	   full_only;
	bool	   synthesize;
};

extern const char perf_version_string[];

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

/* feat_writer writes a feature section to output */
struct feat_writer {
	int (*write)(struct feat_writer *fw, void *buf, size_t sz);
};

/* feat_copier copies a feature section using feat_writer to output */
struct feat_copier {
	int (*copy)(struct feat_copier *fc, int feat, struct feat_writer *fw);
};

int perf_session__inject_header(struct perf_session *session,
				struct evlist *evlist,
				int fd,
				struct feat_copier *fc,
				bool write_attrs_after_data);

size_t perf_session__data_offset(const struct evlist *evlist);

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__process_feature(struct perf_session *session,
				union perf_event *event);
int perf_event__process_attr(const struct perf_tool *tool, union perf_event *event,
			     struct evlist **pevlist);
int perf_event__process_event_update(const struct perf_tool *tool,
				     union perf_event *event,
				     struct evlist **pevlist);
size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
#ifdef HAVE_LIBTRACEEVENT
int perf_event__process_tracing_data(struct perf_session *session,
				     union perf_event *event);
#endif
int perf_event__process_build_id(struct perf_session *session,
				 union perf_event *event);
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);

#define MAX_CACHE_LVL 4

int build_caches_for_cpu(u32 cpu, struct cpu_cache_level caches[], u32 *cntp);

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

char *get_cpuid_str(struct perf_cpu cpu);

char *get_cpuid_allow_env_override(struct perf_cpu cpu);

int strcmp_cpuid_str(const char *s1, const char *s2);
#endif /* __PERF_HEADER_H */
Commit	Line	Data
	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	#ifndef __PERF_HEADER_H
	3	#define __PERF_HEADER_H
	4
	5	#include <linux/stddef.h>
	6	#include <linux/perf_event.h>
	7	#include <sys/types.h>
	8	#include <stdio.h> // FILE
	9	#include <stdbool.h>
	10	#include <linux/bitmap.h>
	11	#include <linux/types.h>
	12	#include "env.h"
	13	#include <perf/cpumap.h>
	14
	15	struct evlist;
	16	union perf_event;
	17	struct perf_header;
	18	struct perf_session;
	19	struct perf_tool;
	20
	21	enum {
	22	HEADER_RESERVED = 0, /* always cleared */
	23	HEADER_FIRST_FEATURE = 1,
	24	HEADER_TRACING_DATA = 1,
	25	HEADER_BUILD_ID,
	26
	27	HEADER_HOSTNAME,
	28	HEADER_OSRELEASE,
	29	HEADER_VERSION,
	30	HEADER_ARCH,
	31	HEADER_NRCPUS,
	32	HEADER_CPUDESC,
	33	HEADER_CPUID,
	34	HEADER_TOTAL_MEM,
	35	HEADER_CMDLINE,
	36	HEADER_EVENT_DESC,
	37	HEADER_CPU_TOPOLOGY,
	38	HEADER_NUMA_TOPOLOGY,
	39	HEADER_BRANCH_STACK,
	40	HEADER_PMU_MAPPINGS,
	41	HEADER_GROUP_DESC,
	42	HEADER_AUXTRACE,
	43	HEADER_STAT,
	44	HEADER_CACHE,
	45	HEADER_SAMPLE_TIME,
	46	HEADER_MEM_TOPOLOGY,
	47	HEADER_CLOCKID,
	48	HEADER_DIR_FORMAT,
	49	HEADER_BPF_PROG_INFO,
	50	HEADER_BPF_BTF,
	51	HEADER_COMPRESSED,
	52	HEADER_CPU_PMU_CAPS,
	53	HEADER_CLOCK_DATA,
	54	HEADER_HYBRID_TOPOLOGY,
	55	HEADER_PMU_CAPS,
	56	HEADER_LAST_FEATURE,
	57	HEADER_FEAT_BITS = 256,
	58	};
	59
	60	enum perf_header_version {
	61	PERF_HEADER_VERSION_1,
	62	PERF_HEADER_VERSION_2,
	63	};
	64
	65	struct perf_file_section {
	66	u64 offset;
	67	u64 size;
	68	};
	69
	70	/**
	71	* struct perf_file_header: Header representation on disk.
	72	*/
	73	struct perf_file_header {
	74	/** @magic: Holds "PERFILE2". */
	75	u64 magic;
	76	/** @size: Size of this header - sizeof(struct perf_file_header). */
	77	u64 size;
	78	/**
	79	* @attr_size: Size of attrs entries - sizeof(struct perf_event_attr) +
	80	* sizeof(struct perf_file_section).
	81	*/
	82	u64 attr_size;
	83	/** @attrs: Offset and size of file section holding attributes. */
	84	struct perf_file_section attrs;
	85	/** @data: Offset and size of file section holding regular event data. */
	86	struct perf_file_section data;
	87	/** @event_types: Ignored. */
	88	struct perf_file_section event_types;
	89	/**
	90	* @adds_features: Bitmap of features. The features are immediately after the data section.
	91	*/
	92	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
	93	};
	94
	95	struct perf_pipe_file_header {
	96	u64 magic;
	97	u64 size;
	98	};
	99
	100	int perf_file_header__read(struct perf_file_header *header,
	101	struct perf_header *ph, int fd);
	102
	103	struct perf_header {
	104	enum perf_header_version version;
	105	bool needs_swap;
	106	u64 data_offset;
	107	u64 data_size;
	108	u64 feat_offset;
	109	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
	110	struct perf_env env;
	111	};
	112
	113	struct feat_fd {
	114	struct perf_header *ph;
	115	int fd;
	116	void buf; / Either buf != NULL or fd >= 0 */
	117	ssize_t offset;
	118	size_t size;
	119	struct evsel *events;
	120	};
	121
	122	struct perf_header_feature_ops {
	123	int (write)(struct feat_fd ff, struct evlist *evlist);
	124	void (print)(struct feat_fd ff, FILE *fp);
	125	int (process)(struct feat_fd ff, void *data);
	126	const char *name;
	127	bool full_only;
	128	bool synthesize;
	129	};
	130
	131	extern const char perf_version_string[];
	132
	133	int perf_session__read_header(struct perf_session *session);
	134	int perf_session__write_header(struct perf_session *session,
	135	struct evlist *evlist,
	136	int fd, bool at_exit);
	137	int perf_header__write_pipe(int fd);
	138
	139	/* feat_writer writes a feature section to output */
	140	struct feat_writer {
	141	int (write)(struct feat_writer fw, void *buf, size_t sz);
	142	};
	143
	144	/* feat_copier copies a feature section using feat_writer to output */
	145	struct feat_copier {
	146	int (copy)(struct feat_copier fc, int feat, struct feat_writer *fw);
	147	};
	148
	149	int perf_session__inject_header(struct perf_session *session,
	150	struct evlist *evlist,
	151	int fd,
	152	struct feat_copier *fc,
	153	bool write_attrs_after_data);
	154
	155	size_t perf_session__data_offset(const struct evlist *evlist);
	156
	157	void perf_header__set_feat(struct perf_header *header, int feat);
	158	void perf_header__clear_feat(struct perf_header *header, int feat);
	159	bool perf_header__has_feat(const struct perf_header *header, int feat);
	160
	161	int perf_header__set_cmdline(int argc, const char **argv);
	162
	163	int perf_header__process_sections(struct perf_header *header, int fd,
	164	void *data,
	165	int (process)(struct perf_file_section section,
	166	struct perf_header *ph,
	167	int feat, int fd, void *data));
	168
	169	int perf_header__fprintf_info(struct perf_session s, FILE fp, bool full);
	170
	171	int perf_event__process_feature(struct perf_session *session,
	172	union perf_event *event);
	173	int perf_event__process_attr(const struct perf_tool tool, union perf_event event,
	174	struct evlist **pevlist);
	175	int perf_event__process_event_update(const struct perf_tool *tool,
	176	union perf_event *event,
	177	struct evlist **pevlist);
	178	size_t perf_event__fprintf_event_update(union perf_event event, FILE fp);
	179	#ifdef HAVE_LIBTRACEEVENT
	180	int perf_event__process_tracing_data(struct perf_session *session,
	181	union perf_event *event);
	182	#endif
	183	int perf_event__process_build_id(struct perf_session *session,
	184	union perf_event *event);
	185	bool is_perf_magic(u64 magic);
	186
	187	#define NAME_ALIGN 64
	188
	189	struct feat_fd;
	190
	191	int do_write(struct feat_fd fd, const void buf, size_t size);
	192
	193	int write_padded(struct feat_fd fd, const void bf,
	194	size_t count, size_t count_aligned);
	195
	196	#define MAX_CACHE_LVL 4
	197
	198	int build_caches_for_cpu(u32 cpu, struct cpu_cache_level caches[], u32 *cntp);
	199
	200	/*
	201	* arch specific callback
	202	*/
	203	int get_cpuid(char *buffer, size_t sz, struct perf_cpu cpu);
	204
	205	char *get_cpuid_str(struct perf_cpu cpu);
	206
	207	char *get_cpuid_allow_env_override(struct perf_cpu cpu);
	208
	209	int strcmp_cpuid_str(const char s1, const char s2);
	210	#endif /* __PERF_HEADER_H */