Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
15enum {
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
50enum perf_header_version {
51 PERF_HEADER_VERSION_1,
52 PERF_HEADER_VERSION_2,
53};
54
55struct perf_file_section {
56 u64 offset;
57 u64 size;
58};
59
60struct perf_file_header {
61 u64 magic;
62 u64 size;
63 u64 attr_size;
64 struct perf_file_section attrs;
65 struct perf_file_section data;
66 /* event_types is ignored */
67 struct perf_file_section event_types;
68 DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
69};
70
71struct perf_pipe_file_header {
72 u64 magic;
73 u64 size;
74};
75
76struct perf_header;
77
78int perf_file_header__read(struct perf_file_header *header,
79 struct perf_header *ph, int fd);
80
81struct perf_header {
82 enum perf_header_version version;
83 bool needs_swap;
84 u64 data_offset;
85 u64 data_size;
86 u64 feat_offset;
87 DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
88 struct perf_env env;
89};
90
91struct feat_fd {
92 struct perf_header *ph;
93 int fd;
94 void *buf; /* Either buf != NULL or fd >= 0 */
95 ssize_t offset;
96 size_t size;
97 struct evsel *events;
98};
99
100struct perf_header_feature_ops {
101 int (*write)(struct feat_fd *ff, struct evlist *evlist);
102 void (*print)(struct feat_fd *ff, FILE *fp);
103 int (*process)(struct feat_fd *ff, void *data);
104 const char *name;
105 bool full_only;
106 bool synthesize;
107};
108
109struct evlist;
110struct perf_session;
111struct perf_tool;
112union perf_event;
113
114int perf_session__read_header(struct perf_session *session);
115int perf_session__write_header(struct perf_session *session,
116 struct evlist *evlist,
117 int fd, bool at_exit);
118int perf_header__write_pipe(int fd);
119
120void perf_header__set_feat(struct perf_header *header, int feat);
121void perf_header__clear_feat(struct perf_header *header, int feat);
122bool perf_header__has_feat(const struct perf_header *header, int feat);
123
124int perf_header__set_cmdline(int argc, const char **argv);
125
126int perf_header__process_sections(struct perf_header *header, int fd,
127 void *data,
128 int (*process)(struct perf_file_section *section,
129 struct perf_header *ph,
130 int feat, int fd, void *data));
131
132int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
133
134int perf_event__process_feature(struct perf_session *session,
135 union perf_event *event);
136int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
137 struct evlist **pevlist);
138int perf_event__process_event_update(struct perf_tool *tool,
139 union perf_event *event,
140 struct evlist **pevlist);
141size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
142int perf_event__process_tracing_data(struct perf_session *session,
143 union perf_event *event);
144int perf_event__process_build_id(struct perf_session *session,
145 union perf_event *event);
146bool is_perf_magic(u64 magic);
147
148#define NAME_ALIGN 64
149
150struct feat_fd;
151
152int do_write(struct feat_fd *fd, const void *buf, size_t size);
153
154int write_padded(struct feat_fd *fd, const void *bf,
155 size_t count, size_t count_aligned);
156
157/*
158 * arch specific callback
159 */
160int get_cpuid(char *buffer, size_t sz);
161
162char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
163int strcmp_cpuid_str(const char *s1, const char *s2);
164#endif /* __PERF_HEADER_H */