projects/linux·blob master · refs

225 lines · 5.8 KiB

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