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 /** <<
65 * struct perf_file_header: Header representat <<
66 */ <<
67 struct perf_file_header { 64 struct perf_file_header {
68 /** @magic: Holds "PERFILE2". */ <<
69 u64 magic; 65 u64 magic;
70 /** @size: Size of this header - sizeo <<
71 u64 size; 66 u64 size;
72 /** <<
73 * @attr_size: Size of attrs entries - <<
74 * sizeof(struct perf_file_section). <<
75 */ <<
76 u64 attr_s 67 u64 attr_size;
77 /** @attrs: Offset and size of file se <<
78 struct perf_file_section attrs; 68 struct perf_file_section attrs;
79 /** @data: Offset and size of file sec <<
80 struct perf_file_section data; 69 struct perf_file_section data;
81 /** @event_types: Ignored. */ !! 70 /* event_types is ignored */
82 struct perf_file_section event_ 71 struct perf_file_section event_types;
83 /** <<
84 * @adds_features: Bitmap of features. <<
85 */ <<
86 DECLARE_BITMAP(adds_features, HEADER_F 72 DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
87 }; 73 };
88 74
89 struct perf_pipe_file_header { 75 struct perf_pipe_file_header {
90 u64 magic; 76 u64 magic;
91 u64 size; 77 u64 size;
92 }; 78 };
93 79
94 struct perf_header; 80 struct perf_header;
95 81
96 int perf_file_header__read(struct perf_file_he 82 int perf_file_header__read(struct perf_file_header *header,
97 struct perf_header 83 struct perf_header *ph, int fd);
98 84
99 struct perf_header { 85 struct perf_header {
100 enum perf_header_version versio 86 enum perf_header_version version;
101 bool needs_ 87 bool needs_swap;
102 u64 data_o 88 u64 data_offset;
103 u64 data_s 89 u64 data_size;
104 u64 feat_o 90 u64 feat_offset;
105 DECLARE_BITMAP(adds_features, HEADER_F 91 DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
106 struct perf_env env; 92 struct perf_env env;
107 }; 93 };
108 94
109 struct feat_fd { 95 struct feat_fd {
110 struct perf_header *ph; 96 struct perf_header *ph;
111 int fd; 97 int fd;
112 void *buf; /* Eit 98 void *buf; /* Either buf != NULL or fd >= 0 */
113 ssize_t offset; 99 ssize_t offset;
114 size_t size; 100 size_t size;
115 struct evsel *events; 101 struct evsel *events;
116 }; 102 };
117 103
118 struct perf_header_feature_ops { 104 struct perf_header_feature_ops {
119 int (*write)(struct feat_fd *ff 105 int (*write)(struct feat_fd *ff, struct evlist *evlist);
120 void (*print)(struct feat_fd *ff 106 void (*print)(struct feat_fd *ff, FILE *fp);
121 int (*process)(struct feat_fd * 107 int (*process)(struct feat_fd *ff, void *data);
122 const char *name; 108 const char *name;
123 bool full_only; 109 bool full_only;
124 bool synthesize; 110 bool synthesize;
125 }; 111 };
126 112
127 struct evlist; 113 struct evlist;
128 struct perf_session; 114 struct perf_session;
129 struct perf_tool; 115 struct perf_tool;
130 union perf_event; 116 union perf_event;
131 117
132 extern const char perf_version_string[]; !! 118 int perf_session__read_header(struct perf_session *session, int repipe_fd);
133 <<
134 int perf_session__read_header(struct perf_sess <<
135 int perf_session__write_header(struct perf_ses 119 int perf_session__write_header(struct perf_session *session,
136 struct evlist * 120 struct evlist *evlist,
137 int fd, bool at 121 int fd, bool at_exit);
138 int perf_header__write_pipe(int fd); 122 int perf_header__write_pipe(int fd);
139 123
140 /* feat_writer writes a feature section to out 124 /* feat_writer writes a feature section to output */
141 struct feat_writer { 125 struct feat_writer {
142 int (*write)(struct feat_writer *fw, v 126 int (*write)(struct feat_writer *fw, void *buf, size_t sz);
143 }; 127 };
144 128
145 /* feat_copier copies a feature section using 129 /* feat_copier copies a feature section using feat_writer to output */
146 struct feat_copier { 130 struct feat_copier {
147 int (*copy)(struct feat_copier *fc, in 131 int (*copy)(struct feat_copier *fc, int feat, struct feat_writer *fw);
148 }; 132 };
149 133
150 int perf_session__inject_header(struct perf_se 134 int perf_session__inject_header(struct perf_session *session,
151 struct evlist 135 struct evlist *evlist,
152 int fd, 136 int fd,
153 struct feat_co !! 137 struct feat_copier *fc);
154 bool write_att <<
155 138
156 size_t perf_session__data_offset(const struct 139 size_t perf_session__data_offset(const struct evlist *evlist);
157 140
158 void perf_header__set_feat(struct perf_header 141 void perf_header__set_feat(struct perf_header *header, int feat);
159 void perf_header__clear_feat(struct perf_heade 142 void perf_header__clear_feat(struct perf_header *header, int feat);
160 bool perf_header__has_feat(const struct perf_h 143 bool perf_header__has_feat(const struct perf_header *header, int feat);
161 144
162 int perf_header__set_cmdline(int argc, const c 145 int perf_header__set_cmdline(int argc, const char **argv);
163 146
164 int perf_header__process_sections(struct perf_ 147 int perf_header__process_sections(struct perf_header *header, int fd,
165 void *data, 148 void *data,
166 int (*proces 149 int (*process)(struct perf_file_section *section,
167 struct perf_ 150 struct perf_header *ph,
168 int feat, in 151 int feat, int fd, void *data));
169 152
170 int perf_header__fprintf_info(struct perf_sess 153 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
171 154
172 int perf_event__process_feature(struct perf_se 155 int perf_event__process_feature(struct perf_session *session,
173 union perf_eve 156 union perf_event *event);
174 int perf_event__process_attr(const struct perf !! 157 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
175 struct evlist **p 158 struct evlist **pevlist);
176 int perf_event__process_event_update(const str !! 159 int perf_event__process_event_update(struct perf_tool *tool,
177 union per 160 union perf_event *event,
178 struct ev 161 struct evlist **pevlist);
179 size_t perf_event__fprintf_event_update(union 162 size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
180 #ifdef HAVE_LIBTRACEEVENT <<
181 int perf_event__process_tracing_data(struct pe 163 int perf_event__process_tracing_data(struct perf_session *session,
182 union per 164 union perf_event *event);
183 #endif <<
184 int perf_event__process_build_id(struct perf_s 165 int perf_event__process_build_id(struct perf_session *session,
185 union perf_ev 166 union perf_event *event);
186 bool is_perf_magic(u64 magic); 167 bool is_perf_magic(u64 magic);
187 168
188 #define NAME_ALIGN 64 169 #define NAME_ALIGN 64
189 170
190 struct feat_fd; 171 struct feat_fd;
191 172
192 int do_write(struct feat_fd *fd, const void *b 173 int do_write(struct feat_fd *fd, const void *buf, size_t size);
193 174
194 int write_padded(struct feat_fd *fd, const voi 175 int write_padded(struct feat_fd *fd, const void *bf,
195 size_t count, size_t count_al 176 size_t count, size_t count_aligned);
196 177
197 #define MAX_CACHE_LVL 4 <<
198 <<
199 int is_cpu_online(unsigned int cpu); 178 int is_cpu_online(unsigned int cpu);
200 int build_caches_for_cpu(u32 cpu, struct cpu_c <<
201 <<
202 /* 179 /*
203 * arch specific callback 180 * arch specific callback
204 */ 181 */
205 int get_cpuid(char *buffer, size_t sz); 182 int get_cpuid(char *buffer, size_t sz);
206 183
207 char *get_cpuid_str(struct perf_pmu *pmu __may 184 char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
208 int strcmp_cpuid_str(const char *s1, const cha 185 int strcmp_cpuid_str(const char *s1, const char *s2);
209 #endif /* __PERF_HEADER_H */ 186 #endif /* __PERF_HEADER_H */
210 187
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.