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 15 struct evlist; 16 union perf_event; 17 struct perf_header; 18 struct perf_session; 19 struct perf_tool; 20 21 enum { 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_CPU_DOMAIN_INFO, 57 HEADER_E_MACHINE, 58 HEADER_LAST_FEATURE, 59 HEADER_FEAT_BITS = 256, 60 }; 61 62 enum perf_header_version { 63 PERF_HEADER_VERSION_1, 64 PERF_HEADER_VERSION_2, 65 }; 66 67 struct perf_file_section { 68 u64 offset; 69 u64 size; 70 }; 71 72 /** 73 * struct perf_file_header: Header representation on disk. 74 */ 75 struct perf_file_header { 76 /** @magic: Holds "PERFILE2". */ 77 u64 magic; 78 /** @size: Size of this header - sizeof(struct perf_file_header). */ 79 u64 size; 80 /** 81 * @attr_size: Size of attrs entries - sizeof(struct perf_event_attr) + 82 * sizeof(struct perf_file_section). 83 */ 84 u64 attr_size; 85 /** @attrs: Offset and size of file section holding attributes. */ 86 struct perf_file_section attrs; 87 /** @data: Offset and size of file section holding regular event data. */ 88 struct perf_file_section data; 89 /** @event_types: Ignored. */ 90 struct perf_file_section event_types; 91 /** 92 * @adds_features: Bitmap of features. The features are immediately after the data section. 93 */ 94 DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS); 95 }; 96 97 struct perf_pipe_file_header { 98 u64 magic; 99 u64 size; 100 }; 101 102 int perf_file_header__read(struct perf_file_header *header, 103 struct perf_header *ph, int fd); 104 105 struct perf_header { 106 enum perf_header_version version; 107 bool needs_swap; 108 u64 data_offset; 109 u64 data_size; 110 u64 feat_offset; 111 DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS); 112 struct perf_env env; 113 }; 114 115 struct feat_fd { 116 struct perf_header *ph; 117 int fd; 118 void *buf; /* Either buf != NULL or fd >= 0 */ 119 ssize_t offset; 120 size_t size; 121 struct evsel *events; 122 }; 123 124 struct perf_header_feature_ops { 125 int (*write)(struct feat_fd *ff, struct evlist *evlist); 126 void (*print)(struct feat_fd *ff, FILE *fp); 127 int (*process)(struct feat_fd *ff, void *data); 128 const char *name; 129 bool full_only; 130 bool synthesize; 131 }; 132 133 extern const char perf_version_string[]; 134 135 int perf_session__read_header(struct perf_session *session); 136 int perf_session__write_header(struct perf_session *session, 137 struct evlist *evlist, 138 int fd, bool at_exit); 139 int perf_header__write_pipe(int fd); 140 141 /* feat_writer writes a feature section to output */ 142 struct feat_writer { 143 int (*write)(struct feat_writer *fw, void *buf, size_t sz); 144 }; 145 146 /* feat_copier copies a feature section using feat_writer to output */ 147 struct feat_copier { 148 int (*copy)(struct feat_copier *fc, int feat, struct feat_writer *fw); 149 }; 150 151 int perf_session__inject_header(struct perf_session *session, 152 struct evlist *evlist, 153 int fd, 154 struct feat_copier *fc, 155 bool write_attrs_after_data); 156 157 size_t perf_session__data_offset(const struct evlist *evlist); 158 159 void perf_header__set_feat(struct perf_header *header, int feat); 160 void perf_header__clear_feat(struct perf_header *header, int feat); 161 bool perf_header__has_feat(const struct perf_header *header, int feat); 162 163 int perf_header__set_cmdline(int argc, const char **argv); 164 165 int perf_header__process_sections(struct perf_header *header, int fd, 166 void *data, 167 int (*process)(struct perf_file_section *section, 168 struct perf_header *ph, 169 int feat, int fd, void *data)); 170 171 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full); 172 173 int perf_event__process_feature(struct perf_session *session, 174 union perf_event *event); 175 int perf_event__process_attr(const struct perf_tool *tool, union perf_event *event, 176 struct evlist **pevlist); 177 int perf_event__process_event_update(const struct perf_tool *tool, 178 union perf_event *event, 179 struct evlist **pevlist); 180 size_t perf_event__fprintf_attr(union perf_event *event, FILE *fp); 181 size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp); 182 #ifdef HAVE_LIBTRACEEVENT 183 int perf_event__process_tracing_data(const struct perf_tool *tool, 184 struct perf_session *session, 185 union perf_event *event); 186 #endif 187 int perf_event__process_build_id(const struct perf_tool *tool, 188 struct perf_session *session, 189 union perf_event *event); 190 bool is_perf_magic(u64 magic); 191 192 #define NAME_ALIGN 64 193 194 struct feat_fd; 195 196 int do_write(struct feat_fd *fd, const void *buf, size_t size); 197 198 int write_padded(struct feat_fd *fd, const void *bf, 199 size_t count, size_t count_aligned); 200 201 #define MAX_CACHE_LVL 4 202 203 int build_caches_for_cpu(u32 cpu, struct cpu_cache_level caches[], u32 *cntp); 204 205 /* 206 * arch specific callback 207 */ 208 int get_cpuid(char *buffer, size_t sz, struct perf_cpu cpu); 209 210 char *get_cpuid_str(struct perf_cpu cpu); 211 212 char *get_cpuid_allow_env_override(struct perf_cpu cpu); 213 214 int strcmp_cpuid_str(const char *s1, const char *s2); 215 216 struct cpu_domain_map **build_cpu_domain_map(u32 *schedstat_version, u32 *max_sched_domains, 217 u32 nr); 218 #endif /* __PERF_HEADER_H */ 219