xref: /openbmc/linux/tools/perf/util/header.h (revision 4f3db074)
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 perf_session_env {
70 	char			*hostname;
71 	char			*os_release;
72 	char			*version;
73 	char			*arch;
74 	int			nr_cpus_online;
75 	int			nr_cpus_avail;
76 	char			*cpu_desc;
77 	char			*cpuid;
78 	unsigned long long	total_mem;
79 
80 	int			nr_cmdline;
81 	int			nr_sibling_cores;
82 	int			nr_sibling_threads;
83 	int			nr_numa_nodes;
84 	int			nr_pmu_mappings;
85 	int			nr_groups;
86 	char			*cmdline;
87 	char			*sibling_cores;
88 	char			*sibling_threads;
89 	char			*numa_nodes;
90 	char			*pmu_mappings;
91 };
92 
93 struct perf_header {
94 	enum perf_header_version	version;
95 	bool				needs_swap;
96 	u64				data_offset;
97 	u64				data_size;
98 	u64				feat_offset;
99 	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
100 	struct perf_session_env 	env;
101 };
102 
103 struct perf_evlist;
104 struct perf_session;
105 
106 int perf_session__read_header(struct perf_session *session);
107 int perf_session__write_header(struct perf_session *session,
108 			       struct perf_evlist *evlist,
109 			       int fd, bool at_exit);
110 int perf_header__write_pipe(int fd);
111 
112 void perf_header__set_feat(struct perf_header *header, int feat);
113 void perf_header__clear_feat(struct perf_header *header, int feat);
114 bool perf_header__has_feat(const struct perf_header *header, int feat);
115 
116 int perf_header__set_cmdline(int argc, const char **argv);
117 
118 int perf_header__process_sections(struct perf_header *header, int fd,
119 				  void *data,
120 				  int (*process)(struct perf_file_section *section,
121 				  struct perf_header *ph,
122 				  int feat, int fd, void *data));
123 
124 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
125 
126 int perf_event__synthesize_attr(struct perf_tool *tool,
127 				struct perf_event_attr *attr, u32 ids, u64 *id,
128 				perf_event__handler_t process);
129 int perf_event__synthesize_attrs(struct perf_tool *tool,
130 				 struct perf_session *session,
131 				 perf_event__handler_t process);
132 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
133 			     struct perf_evlist **pevlist);
134 
135 int perf_event__synthesize_tracing_data(struct perf_tool *tool,
136 					int fd, struct perf_evlist *evlist,
137 					perf_event__handler_t process);
138 int perf_event__process_tracing_data(struct perf_tool *tool,
139 				     union perf_event *event,
140 				     struct perf_session *session);
141 
142 int perf_event__synthesize_build_id(struct perf_tool *tool,
143 				    struct dso *pos, u16 misc,
144 				    perf_event__handler_t process,
145 				    struct machine *machine);
146 int perf_event__process_build_id(struct perf_tool *tool,
147 				 union perf_event *event,
148 				 struct perf_session *session);
149 bool is_perf_magic(u64 magic);
150 
151 #define NAME_ALIGN 64
152 
153 int write_padded(int fd, const void *bf, size_t count, size_t count_aligned);
154 
155 /*
156  * arch specific callback
157  */
158 int get_cpuid(char *buffer, size_t sz);
159 
160 #endif /* __PERF_HEADER_H */
161