xref: /linux-6.15/tools/perf/util/header.h (revision 27830616)
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 "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_BPF_BTF,
45 	HEADER_COMPRESSED,
46 	HEADER_LAST_FEATURE,
47 	HEADER_FEAT_BITS	= 256,
48 };
49 
50 enum perf_header_version {
51 	PERF_HEADER_VERSION_1,
52 	PERF_HEADER_VERSION_2,
53 };
54 
55 enum perf_dir_version {
56 	PERF_DIR_VERSION	= 1,
57 };
58 
59 struct perf_file_section {
60 	u64 offset;
61 	u64 size;
62 };
63 
64 struct perf_file_header {
65 	u64				magic;
66 	u64				size;
67 	u64				attr_size;
68 	struct perf_file_section	attrs;
69 	struct perf_file_section	data;
70 	/* event_types is ignored */
71 	struct perf_file_section	event_types;
72 	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
73 };
74 
75 struct perf_pipe_file_header {
76 	u64				magic;
77 	u64				size;
78 };
79 
80 struct perf_header;
81 
82 int perf_file_header__read(struct perf_file_header *header,
83 			   struct perf_header *ph, int fd);
84 
85 struct perf_header {
86 	enum perf_header_version	version;
87 	bool				needs_swap;
88 	u64				data_offset;
89 	u64				data_size;
90 	u64				feat_offset;
91 	DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
92 	struct perf_env 	env;
93 };
94 
95 struct evlist;
96 struct perf_session;
97 struct perf_tool;
98 union perf_event;
99 
100 int perf_session__read_header(struct perf_session *session);
101 int perf_session__write_header(struct perf_session *session,
102 			       struct evlist *evlist,
103 			       int fd, bool at_exit);
104 int perf_header__write_pipe(int fd);
105 
106 void perf_header__set_feat(struct perf_header *header, int feat);
107 void perf_header__clear_feat(struct perf_header *header, int feat);
108 bool perf_header__has_feat(const struct perf_header *header, int feat);
109 
110 int perf_header__set_cmdline(int argc, const char **argv);
111 
112 int perf_header__process_sections(struct perf_header *header, int fd,
113 				  void *data,
114 				  int (*process)(struct perf_file_section *section,
115 				  struct perf_header *ph,
116 				  int feat, int fd, void *data));
117 
118 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
119 
120 int perf_event__process_feature(struct perf_session *session,
121 				union perf_event *event);
122 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
123 			     struct evlist **pevlist);
124 int perf_event__process_event_update(struct perf_tool *tool,
125 				     union perf_event *event,
126 				     struct evlist **pevlist);
127 size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
128 int perf_event__process_tracing_data(struct perf_session *session,
129 				     union perf_event *event);
130 int perf_event__process_build_id(struct perf_session *session,
131 				 union perf_event *event);
132 bool is_perf_magic(u64 magic);
133 
134 #define NAME_ALIGN 64
135 
136 struct feat_fd;
137 
138 int do_write(struct feat_fd *fd, const void *buf, size_t size);
139 
140 int write_padded(struct feat_fd *fd, const void *bf,
141 		 size_t count, size_t count_aligned);
142 
143 /*
144  * arch specific callback
145  */
146 int get_cpuid(char *buffer, size_t sz);
147 
148 char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
149 int strcmp_cpuid_str(const char *s1, const char *s2);
150 #endif /* __PERF_HEADER_H */
151