xref: /kernel/linux/linux-5.10/tools/perf/util/header.h (revision 8c2ecf20)
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 "pmu.h"
14
15enum {
16	HEADER_RESERVED		= 0,	/* always cleared */
17	HEADER_FIRST_FEATURE	= 1,
18	HEADER_TRACING_DATA	= 1,
19	HEADER_BUILD_ID,
20
21	HEADER_HOSTNAME,
22	HEADER_OSRELEASE,
23	HEADER_VERSION,
24	HEADER_ARCH,
25	HEADER_NRCPUS,
26	HEADER_CPUDESC,
27	HEADER_CPUID,
28	HEADER_TOTAL_MEM,
29	HEADER_CMDLINE,
30	HEADER_EVENT_DESC,
31	HEADER_CPU_TOPOLOGY,
32	HEADER_NUMA_TOPOLOGY,
33	HEADER_BRANCH_STACK,
34	HEADER_PMU_MAPPINGS,
35	HEADER_GROUP_DESC,
36	HEADER_AUXTRACE,
37	HEADER_STAT,
38	HEADER_CACHE,
39	HEADER_SAMPLE_TIME,
40	HEADER_MEM_TOPOLOGY,
41	HEADER_CLOCKID,
42	HEADER_DIR_FORMAT,
43	HEADER_BPF_PROG_INFO,
44	HEADER_BPF_BTF,
45	HEADER_COMPRESSED,
46	HEADER_CPU_PMU_CAPS,
47	HEADER_CLOCK_DATA,
48	HEADER_LAST_FEATURE,
49	HEADER_FEAT_BITS	= 256,
50};
51
52enum perf_header_version {
53	PERF_HEADER_VERSION_1,
54	PERF_HEADER_VERSION_2,
55};
56
57struct perf_file_section {
58	u64 offset;
59	u64 size;
60};
61
62struct perf_file_header {
63	u64				magic;
64	u64				size;
65	u64				attr_size;
66	struct perf_file_section	attrs;
67	struct perf_file_section	data;
68	/* event_types is ignored */
69	struct perf_file_section	event_types;
70	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
71};
72
73struct perf_pipe_file_header {
74	u64				magic;
75	u64				size;
76};
77
78struct perf_header;
79
80int perf_file_header__read(struct perf_file_header *header,
81			   struct perf_header *ph, int fd);
82
83struct perf_header {
84	enum perf_header_version	version;
85	bool				needs_swap;
86	u64				data_offset;
87	u64				data_size;
88	u64				feat_offset;
89	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
90	struct perf_env 	env;
91};
92
93struct feat_fd {
94	struct perf_header *ph;
95	int		   fd;
96	void		   *buf;	/* Either buf != NULL or fd >= 0 */
97	ssize_t		   offset;
98	size_t		   size;
99	struct evsel	   *events;
100};
101
102struct perf_header_feature_ops {
103	int	   (*write)(struct feat_fd *ff, struct evlist *evlist);
104	void	   (*print)(struct feat_fd *ff, FILE *fp);
105	int	   (*process)(struct feat_fd *ff, void *data);
106	const char *name;
107	bool	   full_only;
108	bool	   synthesize;
109};
110
111struct evlist;
112struct perf_session;
113struct perf_tool;
114union perf_event;
115
116int perf_session__read_header(struct perf_session *session);
117int perf_session__write_header(struct perf_session *session,
118			       struct evlist *evlist,
119			       int fd, bool at_exit);
120int perf_header__write_pipe(int fd);
121
122void perf_header__set_feat(struct perf_header *header, int feat);
123void perf_header__clear_feat(struct perf_header *header, int feat);
124bool perf_header__has_feat(const struct perf_header *header, int feat);
125
126int perf_header__set_cmdline(int argc, const char **argv);
127
128int perf_header__process_sections(struct perf_header *header, int fd,
129				  void *data,
130				  int (*process)(struct perf_file_section *section,
131				  struct perf_header *ph,
132				  int feat, int fd, void *data));
133
134int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
135
136int perf_event__process_feature(struct perf_session *session,
137				union perf_event *event);
138int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
139			     struct evlist **pevlist);
140int perf_event__process_event_update(struct perf_tool *tool,
141				     union perf_event *event,
142				     struct evlist **pevlist);
143size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
144int perf_event__process_tracing_data(struct perf_session *session,
145				     union perf_event *event);
146int perf_event__process_build_id(struct perf_session *session,
147				 union perf_event *event);
148bool is_perf_magic(u64 magic);
149
150#define NAME_ALIGN 64
151
152struct feat_fd;
153
154int do_write(struct feat_fd *fd, const void *buf, size_t size);
155
156int write_padded(struct feat_fd *fd, const void *bf,
157		 size_t count, size_t count_aligned);
158
159/*
160 * arch specific callback
161 */
162int get_cpuid(char *buffer, size_t sz);
163
164char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
165int strcmp_cpuid_str(const char *s1, const char *s2);
166#endif /* __PERF_HEADER_H */
167