xref: /openbmc/linux/tools/perf/util/header.h (revision 606f972b)
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 <stdbool.h>
9 #include <linux/bitmap.h>
10 #include <linux/types.h>
11 #include "event.h"
12 #include "env.h"
13 #include "pmu.h"
14 
15 enum {
16 	HEADER_RESERVED		= 0,	/* always cleared */
17 	HEADER_FIRST_FEATURE	= 1,
18 	HEADER_TRACING_DATA	= 1,
19 	HEADER_BUILD_ID,
20 
21 	HEADER_HOSTNAME,
22 	HEADER_OSRELEASE,
23 	HEADER_VERSION,
24 	HEADER_ARCH,
25 	HEADER_NRCPUS,
26 	HEADER_CPUDESC,
27 	HEADER_CPUID,
28 	HEADER_TOTAL_MEM,
29 	HEADER_CMDLINE,
30 	HEADER_EVENT_DESC,
31 	HEADER_CPU_TOPOLOGY,
32 	HEADER_NUMA_TOPOLOGY,
33 	HEADER_BRANCH_STACK,
34 	HEADER_PMU_MAPPINGS,
35 	HEADER_GROUP_DESC,
36 	HEADER_AUXTRACE,
37 	HEADER_STAT,
38 	HEADER_CACHE,
39 	HEADER_SAMPLE_TIME,
40 	HEADER_MEM_TOPOLOGY,
41 	HEADER_CLOCKID,
42 	HEADER_DIR_FORMAT,
43 	HEADER_BPF_PROG_INFO,
44 	HEADER_LAST_FEATURE,
45 	HEADER_FEAT_BITS	= 256,
46 };
47 
48 enum perf_header_version {
49 	PERF_HEADER_VERSION_1,
50 	PERF_HEADER_VERSION_2,
51 };
52 
53 enum perf_dir_version {
54 	PERF_DIR_VERSION	= 1,
55 };
56 
57 struct perf_file_section {
58 	u64 offset;
59 	u64 size;
60 };
61 
62 struct perf_file_header {
63 	u64				magic;
64 	u64				size;
65 	u64				attr_size;
66 	struct perf_file_section	attrs;
67 	struct perf_file_section	data;
68 	/* event_types is ignored */
69 	struct perf_file_section	event_types;
70 	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
71 };
72 
73 struct perf_pipe_file_header {
74 	u64				magic;
75 	u64				size;
76 };
77 
78 struct perf_header;
79 
80 int perf_file_header__read(struct perf_file_header *header,
81 			   struct perf_header *ph, int fd);
82 
83 struct perf_header {
84 	enum perf_header_version	version;
85 	bool				needs_swap;
86 	u64				data_offset;
87 	u64				data_size;
88 	u64				feat_offset;
89 	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
90 	struct perf_env 	env;
91 };
92 
93 struct perf_evlist;
94 struct perf_session;
95 
96 int perf_session__read_header(struct perf_session *session);
97 int perf_session__write_header(struct perf_session *session,
98 			       struct perf_evlist *evlist,
99 			       int fd, bool at_exit);
100 int perf_header__write_pipe(int fd);
101 
102 void perf_header__set_feat(struct perf_header *header, int feat);
103 void perf_header__clear_feat(struct perf_header *header, int feat);
104 bool perf_header__has_feat(const struct perf_header *header, int feat);
105 
106 int perf_header__set_cmdline(int argc, const char **argv);
107 
108 int perf_header__process_sections(struct perf_header *header, int fd,
109 				  void *data,
110 				  int (*process)(struct perf_file_section *section,
111 				  struct perf_header *ph,
112 				  int feat, int fd, void *data));
113 
114 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
115 
116 int perf_event__synthesize_features(struct perf_tool *tool,
117 				    struct perf_session *session,
118 				    struct perf_evlist *evlist,
119 				    perf_event__handler_t process);
120 
121 int perf_event__synthesize_extra_attr(struct perf_tool *tool,
122 				      struct perf_evlist *evsel_list,
123 				      perf_event__handler_t process,
124 				      bool is_pipe);
125 
126 int perf_event__process_feature(struct perf_session *session,
127 				union perf_event *event);
128 
129 int perf_event__synthesize_attr(struct perf_tool *tool,
130 				struct perf_event_attr *attr, u32 ids, u64 *id,
131 				perf_event__handler_t process);
132 int perf_event__synthesize_attrs(struct perf_tool *tool,
133 				 struct perf_evlist *evlist,
134 				 perf_event__handler_t process);
135 int perf_event__synthesize_event_update_unit(struct perf_tool *tool,
136 					     struct perf_evsel *evsel,
137 					     perf_event__handler_t process);
138 int perf_event__synthesize_event_update_scale(struct perf_tool *tool,
139 					      struct perf_evsel *evsel,
140 					      perf_event__handler_t process);
141 int perf_event__synthesize_event_update_name(struct perf_tool *tool,
142 					     struct perf_evsel *evsel,
143 					     perf_event__handler_t process);
144 int perf_event__synthesize_event_update_cpus(struct perf_tool *tool,
145 					     struct perf_evsel *evsel,
146 					     perf_event__handler_t process);
147 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
148 			     struct perf_evlist **pevlist);
149 int perf_event__process_event_update(struct perf_tool *tool,
150 				     union perf_event *event,
151 				     struct perf_evlist **pevlist);
152 size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
153 
154 int perf_event__synthesize_tracing_data(struct perf_tool *tool,
155 					int fd, struct perf_evlist *evlist,
156 					perf_event__handler_t process);
157 int perf_event__process_tracing_data(struct perf_session *session,
158 				     union perf_event *event);
159 
160 int perf_event__synthesize_build_id(struct perf_tool *tool,
161 				    struct dso *pos, u16 misc,
162 				    perf_event__handler_t process,
163 				    struct machine *machine);
164 int perf_event__process_build_id(struct perf_session *session,
165 				 union perf_event *event);
166 bool is_perf_magic(u64 magic);
167 
168 #define NAME_ALIGN 64
169 
170 struct feat_fd;
171 
172 int do_write(struct feat_fd *fd, const void *buf, size_t size);
173 
174 int write_padded(struct feat_fd *fd, const void *bf,
175 		 size_t count, size_t count_aligned);
176 
177 /*
178  * arch specific callback
179  */
180 int get_cpuid(char *buffer, size_t sz);
181 
182 char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
183 int strcmp_cpuid_str(const char *s1, const char *s2);
184 #endif /* __PERF_HEADER_H */
185