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