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