perf_event_attr_fprintf.c

  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
 14struct bit_names {
 15	int bit;
 16	const char *name;
 17};
 18
 19static 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
 32static 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
 50static 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		bit_name(COUNTERS),
 61		{ .name = NULL, }
 62	};
 63#undef bit_name
 64	__p_bits(buf, size, value, bits);
 65}
 66
 67static void __p_read_format(char *buf, size_t size, u64 value)
 68{
 69#define bit_name(n) { PERF_FORMAT_##n, #n }
 70	struct bit_names bits[] = {
 71		bit_name(TOTAL_TIME_ENABLED), bit_name(TOTAL_TIME_RUNNING),
 72		bit_name(ID), bit_name(GROUP), bit_name(LOST),
 73		{ .name = NULL, }
 74	};
 75#undef bit_name
 76	__p_bits(buf, size, value, bits);
 77}
 78
 79#define ENUM_ID_TO_STR_CASE(x) case x: return (#x);
 80static const char *stringify_perf_type_id(struct perf_pmu *pmu, u32 type)
 81{
 82	switch (type) {
 83	ENUM_ID_TO_STR_CASE(PERF_TYPE_HARDWARE)
 84	ENUM_ID_TO_STR_CASE(PERF_TYPE_SOFTWARE)
 85	ENUM_ID_TO_STR_CASE(PERF_TYPE_TRACEPOINT)
 86	ENUM_ID_TO_STR_CASE(PERF_TYPE_HW_CACHE)
 87	ENUM_ID_TO_STR_CASE(PERF_TYPE_BREAKPOINT)
 88	case PERF_TYPE_RAW:
 89		return pmu ? pmu->name : "PERF_TYPE_RAW";
 90	default:
 91		return pmu ? pmu->name : NULL;
 92	}
 93}
 94
 95static const char *stringify_perf_hw_id(u64 value)
 96{
 97	switch (value & PERF_HW_EVENT_MASK) {
 98	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CPU_CYCLES)
 99	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_INSTRUCTIONS)
100	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_REFERENCES)
101	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_MISSES)
102	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BRANCH_INSTRUCTIONS)
103	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BRANCH_MISSES)
104	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BUS_CYCLES)
105	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_STALLED_CYCLES_FRONTEND)
106	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_STALLED_CYCLES_BACKEND)
107	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_REF_CPU_CYCLES)
108	default:
109		return NULL;
110	}
111}
112
113static const char *stringify_perf_hw_cache_id(u64 value)
114{
115	switch (value) {
116	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_L1D)
117	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_L1I)
118	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_LL)
119	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_DTLB)
120	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_ITLB)
121	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_BPU)
122	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_NODE)
123	default:
124		return NULL;
125	}
126}
127
128static const char *stringify_perf_hw_cache_op_id(u64 value)
129{
130	switch (value) {
131	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_READ)
132	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_WRITE)
133	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_PREFETCH)
134	default:
135		return NULL;
136	}
137}
138
139static const char *stringify_perf_hw_cache_op_result_id(u64 value)
140{
141	switch (value) {
142	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_RESULT_ACCESS)
143	ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_RESULT_MISS)
144	default:
145		return NULL;
146	}
147}
148
149static const char *stringify_perf_sw_id(u64 value)
150{
151	switch (value) {
152	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CPU_CLOCK)
153	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_TASK_CLOCK)
154	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS)
155	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CONTEXT_SWITCHES)
156	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CPU_MIGRATIONS)
157	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS_MIN)
158	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS_MAJ)
159	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_ALIGNMENT_FAULTS)
160	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_EMULATION_FAULTS)
161	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_DUMMY)
162	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_BPF_OUTPUT)
163	ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CGROUP_SWITCHES)
164	default:
165		return NULL;
166	}
167}
168#undef ENUM_ID_TO_STR_CASE
169
170static void print_id_unsigned(char *buf, size_t size, u64 value, const char *s)
171{
172	if (s == NULL)
173		snprintf(buf, size, "%"PRIu64, value);
174	else
175		snprintf(buf, size, "%"PRIu64" (%s)", value, s);
176}
177
178static void print_id_hex(char *buf, size_t size, u64 value, const char *s)
179{
180	if (s == NULL)
181		snprintf(buf, size, "%#"PRIx64, value);
182	else
183		snprintf(buf, size, "%#"PRIx64" (%s)", value, s);
184}
185
186static void __p_type_id(char *buf, size_t size, struct perf_pmu *pmu, u32 type)
187{
188	print_id_unsigned(buf, size, type, stringify_perf_type_id(pmu, type));
189}
190
191static void __p_config_hw_id(char *buf, size_t size, struct perf_pmu *pmu, u64 config)
192{
193	const char *name = stringify_perf_hw_id(config);
194
195	if (name == NULL) {
196		if (pmu == NULL) {
197			snprintf(buf, size, "%#"PRIx64, config);
198		} else {
199			snprintf(buf, size, "%#"PRIx64" (%s/config=%#"PRIx64"/)", config, pmu->name,
200				 config);
201		}
202	} else {
203		if (pmu == NULL)
204			snprintf(buf, size, "%#"PRIx64" (%s)", config, name);
205		else
206			snprintf(buf, size, "%#"PRIx64" (%s/%s/)", config, pmu->name, name);
207	}
208}
209
210static void __p_config_sw_id(char *buf, size_t size, u64 id)
211{
212	print_id_hex(buf, size, id, stringify_perf_sw_id(id));
213}
214
215static void __p_config_hw_cache_id(char *buf, size_t size, struct perf_pmu *pmu, u64 config)
216{
217	const char *hw_cache_str = stringify_perf_hw_cache_id(config & 0xff);
218	const char *hw_cache_op_str =
219		stringify_perf_hw_cache_op_id((config & 0xff00) >> 8);
220	const char *hw_cache_op_result_str =
221		stringify_perf_hw_cache_op_result_id((config & 0xff0000) >> 16);
222
223	if (hw_cache_str == NULL || hw_cache_op_str == NULL || hw_cache_op_result_str == NULL) {
224		if (pmu == NULL) {
225			snprintf(buf, size, "%#"PRIx64, config);
226		} else {
227			snprintf(buf, size, "%#"PRIx64" (%s/config=%#"PRIx64"/)", config, pmu->name,
228				 config);
229		}
230	} else {
231		if (pmu == NULL) {
232			snprintf(buf, size, "%#"PRIx64" (%s | %s | %s)", config,
233				 hw_cache_op_result_str, hw_cache_op_str, hw_cache_str);
234		} else {
235			snprintf(buf, size, "%#"PRIx64" (%s/%s | %s | %s/)", config, pmu->name,
236				 hw_cache_op_result_str, hw_cache_op_str, hw_cache_str);
237		}
238	}
239}
240
241static void __p_config_tracepoint_id(char *buf, size_t size, u64 id)
242{
243	char *str = tracepoint_id_to_name(id);
244
245	print_id_hex(buf, size, id, str);
246	free(str);
247}
248
249static void __p_config_id(struct perf_pmu *pmu, char *buf, size_t size, u32 type, u64 config)
250{
251	switch (type) {
252	case PERF_TYPE_HARDWARE:
253		return __p_config_hw_id(buf, size, pmu, config);
254	case PERF_TYPE_SOFTWARE:
255		return __p_config_sw_id(buf, size, config);
256	case PERF_TYPE_HW_CACHE:
257		return __p_config_hw_cache_id(buf, size, pmu, config);
258	case PERF_TYPE_TRACEPOINT:
259		return __p_config_tracepoint_id(buf, size, config);
260	case PERF_TYPE_RAW:
261	case PERF_TYPE_BREAKPOINT:
262	default:
263		return print_id_hex(buf, size, config, perf_pmu__name_from_config(pmu, config));
264	}
265}
266
267#define BUF_SIZE		1024
268
269#define p_hex(val)		snprintf(buf, BUF_SIZE, "%#"PRIx64, (uint64_t)(val))
270#define p_unsigned(val)		snprintf(buf, BUF_SIZE, "%"PRIu64, (uint64_t)(val))
271#define p_signed(val)		snprintf(buf, BUF_SIZE, "%"PRId64, (int64_t)(val))
272#define p_sample_type(val)	__p_sample_type(buf, BUF_SIZE, val)
273#define p_branch_sample_type(val) __p_branch_sample_type(buf, BUF_SIZE, val)
274#define p_read_format(val)	__p_read_format(buf, BUF_SIZE, val)
275#define p_type_id(val)		__p_type_id(buf, BUF_SIZE, pmu, val)
276#define p_config_id(val)	__p_config_id(pmu, buf, BUF_SIZE, attr->type, val)
277
278#define PRINT_ATTRn(_n, _f, _p, _a)			\
279do {							\
280	if (_a || attr->_f) {				\
281		_p(attr->_f);				\
282		ret += attr__fprintf(fp, _n, buf, priv);\
283	}						\
284} while (0)
285
286#define PRINT_ATTRf(_f, _p)	PRINT_ATTRn(#_f, _f, _p, false)
287
288int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
289			     attr__fprintf_f attr__fprintf, void *priv)
290{
291	struct perf_pmu *pmu = perf_pmus__find_by_type(attr->type);
292	char buf[BUF_SIZE];
293	int ret = 0;
294
295	if (!pmu && (attr->type == PERF_TYPE_HARDWARE || attr->type == PERF_TYPE_HW_CACHE)) {
296		u32 extended_type = attr->config >> PERF_PMU_TYPE_SHIFT;
297
298		if (extended_type)
299			pmu = perf_pmus__find_by_type(extended_type);
300	}
301
302	PRINT_ATTRn("type", type, p_type_id, true);
303	PRINT_ATTRf(size, p_unsigned);
304	PRINT_ATTRn("config", config, p_config_id, true);
305	PRINT_ATTRn("{ sample_period, sample_freq }", sample_period, p_unsigned, false);
306	PRINT_ATTRf(sample_type, p_sample_type);
307	PRINT_ATTRf(read_format, p_read_format);
308
309	PRINT_ATTRf(disabled, p_unsigned);
310	PRINT_ATTRf(inherit, p_unsigned);
311	PRINT_ATTRf(pinned, p_unsigned);
312	PRINT_ATTRf(exclusive, p_unsigned);
313	PRINT_ATTRf(exclude_user, p_unsigned);
314	PRINT_ATTRf(exclude_kernel, p_unsigned);
315	PRINT_ATTRf(exclude_hv, p_unsigned);
316	PRINT_ATTRf(exclude_idle, p_unsigned);
317	PRINT_ATTRf(mmap, p_unsigned);
318	PRINT_ATTRf(comm, p_unsigned);
319	PRINT_ATTRf(freq, p_unsigned);
320	PRINT_ATTRf(inherit_stat, p_unsigned);
321	PRINT_ATTRf(enable_on_exec, p_unsigned);
322	PRINT_ATTRf(task, p_unsigned);
323	PRINT_ATTRf(watermark, p_unsigned);
324	PRINT_ATTRf(precise_ip, p_unsigned);
325	PRINT_ATTRf(mmap_data, p_unsigned);
326	PRINT_ATTRf(sample_id_all, p_unsigned);
327	PRINT_ATTRf(exclude_host, p_unsigned);
328	PRINT_ATTRf(exclude_guest, p_unsigned);
329	PRINT_ATTRf(exclude_callchain_kernel, p_unsigned);
330	PRINT_ATTRf(exclude_callchain_user, p_unsigned);
331	PRINT_ATTRf(mmap2, p_unsigned);
332	PRINT_ATTRf(comm_exec, p_unsigned);
333	PRINT_ATTRf(use_clockid, p_unsigned);
334	PRINT_ATTRf(context_switch, p_unsigned);
335	PRINT_ATTRf(write_backward, p_unsigned);
336	PRINT_ATTRf(namespaces, p_unsigned);
337	PRINT_ATTRf(ksymbol, p_unsigned);
338	PRINT_ATTRf(bpf_event, p_unsigned);
339	PRINT_ATTRf(aux_output, p_unsigned);
340	PRINT_ATTRf(cgroup, p_unsigned);
341	PRINT_ATTRf(text_poke, p_unsigned);
342	PRINT_ATTRf(build_id, p_unsigned);
343	PRINT_ATTRf(inherit_thread, p_unsigned);
344	PRINT_ATTRf(remove_on_exec, p_unsigned);
345	PRINT_ATTRf(sigtrap, p_unsigned);
346	PRINT_ATTRf(defer_callchain, p_unsigned);
347	PRINT_ATTRf(defer_output, p_unsigned);
348
349	PRINT_ATTRn("{ wakeup_events, wakeup_watermark }", wakeup_events, p_unsigned, false);
350	PRINT_ATTRf(bp_type, p_unsigned);
351	PRINT_ATTRn("{ bp_addr, config1 }", bp_addr, p_hex, false);
352	PRINT_ATTRn("{ bp_len, config2 }", bp_len, p_hex, false);
353	PRINT_ATTRf(branch_sample_type, p_branch_sample_type);
354	PRINT_ATTRf(sample_regs_user, p_hex);
355	PRINT_ATTRf(sample_stack_user, p_unsigned);
356	PRINT_ATTRf(clockid, p_signed);
357	PRINT_ATTRf(sample_regs_intr, p_hex);
358	PRINT_ATTRf(aux_watermark, p_unsigned);
359	PRINT_ATTRf(sample_max_stack, p_unsigned);
360	PRINT_ATTRf(aux_sample_size, p_unsigned);
361	PRINT_ATTRf(sig_data, p_unsigned);
362	PRINT_ATTRf(aux_start_paused, p_unsigned);
363	PRINT_ATTRf(aux_pause, p_unsigned);
364	PRINT_ATTRf(aux_resume, p_unsigned);
365
366	return ret;
367}