perf header: Add DIR_FORMAT feature to describe directory data
[linux-2.6-microblaze.git] / tools / perf / util / header.h
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_LAST_FEATURE,
44         HEADER_FEAT_BITS        = 256,
45 };
46
47 enum perf_header_version {
48         PERF_HEADER_VERSION_1,
49         PERF_HEADER_VERSION_2,
50 };
51
52 enum perf_dir_version {
53         PERF_DIR_VERSION        = 1,
54 };
55
56 struct perf_file_section {
57         u64 offset;
58         u64 size;
59 };
60
61 struct perf_file_header {
62         u64                             magic;
63         u64                             size;
64         u64                             attr_size;
65         struct perf_file_section        attrs;
66         struct perf_file_section        data;
67         /* event_types is ignored */
68         struct perf_file_section        event_types;
69         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
70 };
71
72 struct perf_pipe_file_header {
73         u64                             magic;
74         u64                             size;
75 };
76
77 struct perf_header;
78
79 int perf_file_header__read(struct perf_file_header *header,
80                            struct perf_header *ph, int fd);
81
82 struct perf_header {
83         enum perf_header_version        version;
84         bool                            needs_swap;
85         u64                             data_offset;
86         u64                             data_size;
87         u64                             feat_offset;
88         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
89         struct perf_env         env;
90 };
91
92 struct perf_evlist;
93 struct perf_session;
94
95 int perf_session__read_header(struct perf_session *session);
96 int perf_session__write_header(struct perf_session *session,
97                                struct perf_evlist *evlist,
98                                int fd, bool at_exit);
99 int perf_header__write_pipe(int fd);
100
101 void perf_header__set_feat(struct perf_header *header, int feat);
102 void perf_header__clear_feat(struct perf_header *header, int feat);
103 bool perf_header__has_feat(const struct perf_header *header, int feat);
104
105 int perf_header__set_cmdline(int argc, const char **argv);
106
107 int perf_header__process_sections(struct perf_header *header, int fd,
108                                   void *data,
109                                   int (*process)(struct perf_file_section *section,
110                                   struct perf_header *ph,
111                                   int feat, int fd, void *data));
112
113 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
114
115 int perf_event__synthesize_features(struct perf_tool *tool,
116                                     struct perf_session *session,
117                                     struct perf_evlist *evlist,
118                                     perf_event__handler_t process);
119
120 int perf_event__synthesize_extra_attr(struct perf_tool *tool,
121                                       struct perf_evlist *evsel_list,
122                                       perf_event__handler_t process,
123                                       bool is_pipe);
124
125 int perf_event__process_feature(struct perf_session *session,
126                                 union perf_event *event);
127
128 int perf_event__synthesize_attr(struct perf_tool *tool,
129                                 struct perf_event_attr *attr, u32 ids, u64 *id,
130                                 perf_event__handler_t process);
131 int perf_event__synthesize_attrs(struct perf_tool *tool,
132                                  struct perf_evlist *evlist,
133                                  perf_event__handler_t process);
134 int perf_event__synthesize_event_update_unit(struct perf_tool *tool,
135                                              struct perf_evsel *evsel,
136                                              perf_event__handler_t process);
137 int perf_event__synthesize_event_update_scale(struct perf_tool *tool,
138                                               struct perf_evsel *evsel,
139                                               perf_event__handler_t process);
140 int perf_event__synthesize_event_update_name(struct perf_tool *tool,
141                                              struct perf_evsel *evsel,
142                                              perf_event__handler_t process);
143 int perf_event__synthesize_event_update_cpus(struct perf_tool *tool,
144                                              struct perf_evsel *evsel,
145                                              perf_event__handler_t process);
146 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
147                              struct perf_evlist **pevlist);
148 int perf_event__process_event_update(struct perf_tool *tool,
149                                      union perf_event *event,
150                                      struct perf_evlist **pevlist);
151 size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
152
153 int perf_event__synthesize_tracing_data(struct perf_tool *tool,
154                                         int fd, struct perf_evlist *evlist,
155                                         perf_event__handler_t process);
156 int perf_event__process_tracing_data(struct perf_session *session,
157                                      union perf_event *event);
158
159 int perf_event__synthesize_build_id(struct perf_tool *tool,
160                                     struct dso *pos, u16 misc,
161                                     perf_event__handler_t process,
162                                     struct machine *machine);
163 int perf_event__process_build_id(struct perf_session *session,
164                                  union perf_event *event);
165 bool is_perf_magic(u64 magic);
166
167 #define NAME_ALIGN 64
168
169 struct feat_fd;
170
171 int do_write(struct feat_fd *fd, const void *buf, size_t size);
172
173 int write_padded(struct feat_fd *fd, const void *bf,
174                  size_t count, size_t count_aligned);
175
176 /*
177  * arch specific callback
178  */
179 int get_cpuid(char *buffer, size_t sz);
180
181 char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
182 int strcmp_cpuid_str(const char *s1, const char *s2);
183 #endif /* __PERF_HEADER_H */