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