header.h

  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
 15struct evlist;
 16union perf_event;
 17struct perf_header;
 18struct perf_session;
 19struct perf_tool;
 20
 21enum {
 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
 60enum perf_header_version {
 61	PERF_HEADER_VERSION_1,
 62	PERF_HEADER_VERSION_2,
 63};
 64
 65struct perf_file_section {
 66	u64 offset;
 67	u64 size;
 68};
 69
 70/**
 71 * struct perf_file_header: Header representation on disk.
 72 */
 73struct 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
 95struct perf_pipe_file_header {
 96	u64				magic;
 97	u64				size;
 98};
 99
100int perf_file_header__read(struct perf_file_header *header,
101			   struct perf_header *ph, int fd);
102
103struct 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
113struct 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
122struct 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
131extern const char perf_version_string[];
132
133int perf_session__read_header(struct perf_session *session);
134int perf_session__write_header(struct perf_session *session,
135			       struct evlist *evlist,
136			       int fd, bool at_exit);
137int perf_header__write_pipe(int fd);
138
139/* feat_writer writes a feature section to output */
140struct 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 */
145struct feat_copier {
146	int (*copy)(struct feat_copier *fc, int feat, struct feat_writer *fw);
147};
148
149int 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
155size_t perf_session__data_offset(const struct evlist *evlist);
156
157void perf_header__set_feat(struct perf_header *header, int feat);
158void perf_header__clear_feat(struct perf_header *header, int feat);
159bool perf_header__has_feat(const struct perf_header *header, int feat);
160
161int perf_header__set_cmdline(int argc, const char **argv);
162
163int 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
169int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
170
171int perf_event__process_feature(struct perf_session *session,
172				union perf_event *event);
173int perf_event__process_attr(const struct perf_tool *tool, union perf_event *event,
174			     struct evlist **pevlist);
175int perf_event__process_event_update(const struct perf_tool *tool,
176				     union perf_event *event,
177				     struct evlist **pevlist);
178size_t perf_event__fprintf_attr(union perf_event *event, FILE *fp);
179size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
180#ifdef HAVE_LIBTRACEEVENT
181int perf_event__process_tracing_data(const struct perf_tool *tool,
182				     struct perf_session *session,
183				     union perf_event *event);
184#endif
185int perf_event__process_build_id(const struct perf_tool *tool,
186				 struct perf_session *session,
187				 union perf_event *event);
188bool is_perf_magic(u64 magic);
189
190#define NAME_ALIGN 64
191
192struct feat_fd;
193
194int do_write(struct feat_fd *fd, const void *buf, size_t size);
195
196int write_padded(struct feat_fd *fd, const void *bf,
197		 size_t count, size_t count_aligned);
198
199#define MAX_CACHE_LVL 4
200
201int build_caches_for_cpu(u32 cpu, struct cpu_cache_level caches[], u32 *cntp);
202
203/*
204 * arch specific callback
205 */
206int get_cpuid(char *buffer, size_t sz, struct perf_cpu cpu);
207
208char *get_cpuid_str(struct perf_cpu cpu);
209
210char *get_cpuid_allow_env_override(struct perf_cpu cpu);
211
212int strcmp_cpuid_str(const char *s1, const char *s2);
213#endif /* __PERF_HEADER_H */