1 // SPDX-License-Identifier: GPL-2.0
2 #include <inttypes.h>
3 #include <stdio.h>
4 #include <stdlib.h>
5 #include <stdbool.h>
6 #include <linux/kernel.h>
7 #include <linux/types.h>
8 #include <linux/perf_event.h>
9 #include "util/evsel_fprintf.h"
10 #include "util/pmu.h"
11 #include "util/pmus.h"
12 #include "trace-event.h"
13 
14 struct bit_names {
15 	int bit;
16 	const char *name;
17 };
18 
19 static void __p_bits(char *buf, size_t size, u64 value, struct bit_names *bits)
20 {
21 	bool first_bit = true;
22 	int i = 0;
23 
24 	do {
25 		if (value & bits[i].bit) {
26 			buf += scnprintf(buf, size, "%s%s", first_bit ? "" : "|", bits[i].name);
27 			first_bit = false;
28 		}
29 	} while (bits[++i].name != NULL);
30 }
31 
32 static void __p_sample_type(char *buf, size_t size, u64 value)
33 {
34 #define bit_name(n) { PERF_SAMPLE_##n, #n }
35 	struct bit_names bits[] = {
36 		bit_name(IP), bit_name(TID), bit_name(TIME), bit_name(ADDR),
37 		bit_name(READ), bit_name(CALLCHAIN), bit_name(ID), bit_name(CPU),
38 		bit_name(PERIOD), bit_name(STREAM_ID), bit_name(RAW),
39 		bit_name(BRANCH_STACK), bit_name(REGS_USER), bit_name(STACK_USER),
40 		bit_name(IDENTIFIER), bit_name(REGS_INTR), bit_name(DATA_SRC),
41 		bit_name(WEIGHT), bit_name(PHYS_ADDR), bit_name(AUX),
42 		bit_name(CGROUP), bit_name(DATA_PAGE_SIZE), bit_name(CODE_PAGE_SIZE),
43 		bit_name(WEIGHT_STRUCT),
44 		{ .name = NULL, }
45 	};
46 #undef bit_name
47 	__p_bits(buf, size, value, bits);
48 }
49 
50 static void __p_branch_sample_type(char *buf, size_t size, u64 value)
51 {
52 #define bit_name(n) { PERF_SAMPLE_BRANCH_##n, #n }
53 	struct bit_names bits[] = {
54 		bit_name(USER), bit_name(KERNEL), bit_name(HV), bit_name(ANY),
55 		bit_name(ANY_CALL), bit_name(ANY_RETURN), bit_name(IND_CALL),
56 		bit_name(ABORT_TX), bit_name(IN_TX), bit_name(NO_TX),
57 		bit_name(COND), bit_name(CALL_STACK), bit_name(IND_JUMP),
58 		bit_name(CALL), bit_name(NO_FLAGS), bit_name(NO_CYCLES),
59 		bit_name(TYPE_SAVE), bit_name(HW_INDEX), bit_name(PRIV_SAVE),
60 		{ .name = NULL, }
61 	};
62 #undef bit_name
63 	__p_bits(buf, size, value, bits);
64 }
65 
66 static void __p_read_format(char *buf, size_t size, u64 value)
67 {
68 #define bit_name(n) { PERF_FORMAT_##n, #n }
69 	struct bit_names bits[] = {
70 		bit_name(TOTAL_TIME_ENABLED), bit_name(TOTAL_TIME_RUNNING),
71 		bit_name(ID), bit_name(GROUP), bit_name(LOST),
72 		{ .name = NULL, }
73 	};
74 #undef bit_name
75 	__p_bits(buf, size, value, bits);
76 }
77 
78 #define ENUM_ID_TO_STR_CASE(x) case x: return (#x);
79 static const char *stringify_perf_type_id(struct perf_pmu *pmu, u32 type)
80 {
81 	if (pmu)
82 		return pmu->name;
83 
84 	switch (type) {
85 	ENUM_ID_TO_STR_CASE(PERF_TYPE_HARDWARE)
86 	ENUM_ID_TO_STR_CASE(PERF_TYPE_SOFTWARE)
87 	ENUM_ID_TO_STR_CASE(PERF_TYPE_TRACEPOINT)
88 	ENUM_ID_TO_STR_CASE(PERF_TYPE_HW_CACHE)
89 	ENUM_ID_TO_STR_CASE(PERF_TYPE_RAW)
90 	ENUM_ID_TO_STR_CASE(PERF_TYPE_BREAKPOINT)
91 	default:
92 		return NULL;
93 	}
94 }
95 
96 static const char *stringify_perf_hw_id(u64 value)
97 {
98 	switch (value) {
99 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CPU_CYCLES)
100 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_INSTRUCTIONS)
101 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_REFERENCES)
102 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_MISSES)
103 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BRANCH_INSTRUCTIONS)
104 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BRANCH_MISSES)
105 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BUS_CYCLES)
106 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_STALLED_CYCLES_FRONTEND)
107 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_STALLED_CYCLES_BACKEND)
108 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_REF_CPU_CYCLES)
109 	default:
110 		return NULL;
111 	}
112 }
113 
114 static const char *stringify_perf_hw_cache_id(u64 value)
115 {
116 	switch (value) {
117 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_L1D)
118 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_L1I)
119 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_LL)
120 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_DTLB)
121 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_ITLB)
122 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_BPU)
123 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_NODE)
124 	default:
125 		return NULL;
126 	}
127 }
128 
129 static const char *stringify_perf_hw_cache_op_id(u64 value)
130 {
131 	switch (value) {
132 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_READ)
133 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_WRITE)
134 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_PREFETCH)
135 	default:
136 		return NULL;
137 	}
138 }
139 
140 static const char *stringify_perf_hw_cache_op_result_id(u64 value)
141 {
142 	switch (value) {
143 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_RESULT_ACCESS)
144 	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_RESULT_MISS)
145 	default:
146 		return NULL;
147 	}
148 }
149 
150 static const char *stringify_perf_sw_id(u64 value)
151 {
152 	switch (value) {
153 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CPU_CLOCK)
154 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_TASK_CLOCK)
155 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS)
156 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CONTEXT_SWITCHES)
157 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CPU_MIGRATIONS)
158 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS_MIN)
159 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS_MAJ)
160 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_ALIGNMENT_FAULTS)
161 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_EMULATION_FAULTS)
162 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_DUMMY)
163 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_BPF_OUTPUT)
164 	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CGROUP_SWITCHES)
165 	default:
166 		return NULL;
167 	}
168 }
169 #undef ENUM_ID_TO_STR_CASE
170 
171 #define PRINT_ID(_s, _f)					\
172 do {								\
173 	const char *__s = _s;					\
174 	if (__s == NULL)					\
175 		snprintf(buf, size, _f, value);			\
176 	else							\
177 		snprintf(buf, size, _f" (%s)", value, __s);	\
178 } while (0)
179 #define print_id_unsigned(_s)	PRINT_ID(_s, "%"PRIu64)
180 #define print_id_hex(_s)	PRINT_ID(_s, "%#"PRIx64)
181 
182 static void __p_type_id(struct perf_pmu *pmu, char *buf, size_t size, u64 value)
183 {
184 	print_id_unsigned(stringify_perf_type_id(pmu, value));
185 }
186 
187 static void __p_config_hw_id(char *buf, size_t size, u64 value)
188 {
189 	print_id_hex(stringify_perf_hw_id(value));
190 }
191 
192 static void __p_config_sw_id(char *buf, size_t size, u64 value)
193 {
194 	print_id_hex(stringify_perf_sw_id(value));
195 }
196 
197 static void __p_config_hw_cache_id(char *buf, size_t size, u64 value)
198 {
199 	const char *hw_cache_str = stringify_perf_hw_cache_id(value & 0xff);
200 	const char *hw_cache_op_str =
201 		stringify_perf_hw_cache_op_id((value & 0xff00) >> 8);
202 	const char *hw_cache_op_result_str =
203 		stringify_perf_hw_cache_op_result_id((value & 0xff0000) >> 16);
204 
205 	if (hw_cache_str == NULL || hw_cache_op_str == NULL ||
206 	    hw_cache_op_result_str == NULL) {
207 		snprintf(buf, size, "%#"PRIx64, value);
208 	} else {
209 		snprintf(buf, size, "%#"PRIx64" (%s | %s | %s)", value,
210 			 hw_cache_op_result_str, hw_cache_op_str, hw_cache_str);
211 	}
212 }
213 
214 #ifdef HAVE_LIBTRACEEVENT
215 static void __p_config_tracepoint_id(char *buf, size_t size, u64 value)
216 {
217 	char *str = tracepoint_id_to_name(value);
218 
219 	print_id_hex(str);
220 	free(str);
221 }
222 #endif
223 
224 static void __p_config_id(struct perf_pmu *pmu, char *buf, size_t size, u32 type, u64 value)
225 {
226 	const char *name = perf_pmu__name_from_config(pmu, value);
227 
228 	if (name) {
229 		print_id_hex(name);
230 		return;
231 	}
232 	switch (type) {
233 	case PERF_TYPE_HARDWARE:
234 		return __p_config_hw_id(buf, size, value);
235 	case PERF_TYPE_SOFTWARE:
236 		return __p_config_sw_id(buf, size, value);
237 	case PERF_TYPE_HW_CACHE:
238 		return __p_config_hw_cache_id(buf, size, value);
239 	case PERF_TYPE_TRACEPOINT:
240 #ifdef HAVE_LIBTRACEEVENT
241 		return __p_config_tracepoint_id(buf, size, value);
242 #endif
243 	case PERF_TYPE_RAW:
244 	case PERF_TYPE_BREAKPOINT:
245 	default:
246 		snprintf(buf, size, "%#"PRIx64, value);
247 		return;
248 	}
249 }
250 
251 #define BUF_SIZE		1024
252 
253 #define p_hex(val)		snprintf(buf, BUF_SIZE, "%#"PRIx64, (uint64_t)(val))
254 #define p_unsigned(val)		snprintf(buf, BUF_SIZE, "%"PRIu64, (uint64_t)(val))
255 #define p_signed(val)		snprintf(buf, BUF_SIZE, "%"PRId64, (int64_t)(val))
256 #define p_sample_type(val)	__p_sample_type(buf, BUF_SIZE, val)
257 #define p_branch_sample_type(val) __p_branch_sample_type(buf, BUF_SIZE, val)
258 #define p_read_format(val)	__p_read_format(buf, BUF_SIZE, val)
259 #define p_type_id(val)		__p_type_id(pmu, buf, BUF_SIZE, val)
260 #define p_config_id(val)	__p_config_id(pmu, buf, BUF_SIZE, attr->type, val)
261 
262 #define PRINT_ATTRn(_n, _f, _p, _a)			\
263 do {							\
264 	if (_a || attr->_f) {				\
265 		_p(attr->_f);				\
266 		ret += attr__fprintf(fp, _n, buf, priv);\
267 	}						\
268 } while (0)
269 
270 #define PRINT_ATTRf(_f, _p)	PRINT_ATTRn(#_f, _f, _p, false)
271 
272 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
273 			     attr__fprintf_f attr__fprintf, void *priv)
274 {
275 	struct perf_pmu *pmu = perf_pmus__find_by_type(attr->type);
276 	char buf[BUF_SIZE];
277 	int ret = 0;
278 
279 	PRINT_ATTRn("type", type, p_type_id, true);
280 	PRINT_ATTRf(size, p_unsigned);
281 	PRINT_ATTRn("config", config, p_config_id, true);
282 	PRINT_ATTRn("{ sample_period, sample_freq }", sample_period, p_unsigned, false);
283 	PRINT_ATTRf(sample_type, p_sample_type);
284 	PRINT_ATTRf(read_format, p_read_format);
285 
286 	PRINT_ATTRf(disabled, p_unsigned);
287 	PRINT_ATTRf(inherit, p_unsigned);
288 	PRINT_ATTRf(pinned, p_unsigned);
289 	PRINT_ATTRf(exclusive, p_unsigned);
290 	PRINT_ATTRf(exclude_user, p_unsigned);
291 	PRINT_ATTRf(exclude_kernel, p_unsigned);
292 	PRINT_ATTRf(exclude_hv, p_unsigned);
293 	PRINT_ATTRf(exclude_idle, p_unsigned);
294 	PRINT_ATTRf(mmap, p_unsigned);
295 	PRINT_ATTRf(comm, p_unsigned);
296 	PRINT_ATTRf(freq, p_unsigned);
297 	PRINT_ATTRf(inherit_stat, p_unsigned);
298 	PRINT_ATTRf(enable_on_exec, p_unsigned);
299 	PRINT_ATTRf(task, p_unsigned);
300 	PRINT_ATTRf(watermark, p_unsigned);
301 	PRINT_ATTRf(precise_ip, p_unsigned);
302 	PRINT_ATTRf(mmap_data, p_unsigned);
303 	PRINT_ATTRf(sample_id_all, p_unsigned);
304 	PRINT_ATTRf(exclude_host, p_unsigned);
305 	PRINT_ATTRf(exclude_guest, p_unsigned);
306 	PRINT_ATTRf(exclude_callchain_kernel, p_unsigned);
307 	PRINT_ATTRf(exclude_callchain_user, p_unsigned);
308 	PRINT_ATTRf(mmap2, p_unsigned);
309 	PRINT_ATTRf(comm_exec, p_unsigned);
310 	PRINT_ATTRf(use_clockid, p_unsigned);
311 	PRINT_ATTRf(context_switch, p_unsigned);
312 	PRINT_ATTRf(write_backward, p_unsigned);
313 	PRINT_ATTRf(namespaces, p_unsigned);
314 	PRINT_ATTRf(ksymbol, p_unsigned);
315 	PRINT_ATTRf(bpf_event, p_unsigned);
316 	PRINT_ATTRf(aux_output, p_unsigned);
317 	PRINT_ATTRf(cgroup, p_unsigned);
318 	PRINT_ATTRf(text_poke, p_unsigned);
319 	PRINT_ATTRf(build_id, p_unsigned);
320 	PRINT_ATTRf(inherit_thread, p_unsigned);
321 	PRINT_ATTRf(remove_on_exec, p_unsigned);
322 	PRINT_ATTRf(sigtrap, p_unsigned);
323 
324 	PRINT_ATTRn("{ wakeup_events, wakeup_watermark }", wakeup_events, p_unsigned, false);
325 	PRINT_ATTRf(bp_type, p_unsigned);
326 	PRINT_ATTRn("{ bp_addr, config1 }", bp_addr, p_hex, false);
327 	PRINT_ATTRn("{ bp_len, config2 }", bp_len, p_hex, false);
328 	PRINT_ATTRf(branch_sample_type, p_branch_sample_type);
329 	PRINT_ATTRf(sample_regs_user, p_hex);
330 	PRINT_ATTRf(sample_stack_user, p_unsigned);
331 	PRINT_ATTRf(clockid, p_signed);
332 	PRINT_ATTRf(sample_regs_intr, p_hex);
333 	PRINT_ATTRf(aux_watermark, p_unsigned);
334 	PRINT_ATTRf(sample_max_stack, p_unsigned);
335 	PRINT_ATTRf(aux_sample_size, p_unsigned);
336 	PRINT_ATTRf(sig_data, p_unsigned);
337 
338 	return ret;
339 }
340