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