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