xref: /kernel/linux/linux-5.10/tools/perf/util/evsel.c (revision 8c2ecf20)
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
4 *
5 * Parts came from builtin-{top,stat,record}.c, see those files for further
6 * copyright notes.
7 */
8
9#include <byteswap.h>
10#include <errno.h>
11#include <inttypes.h>
12#include <linux/bitops.h>
13#include <api/fs/fs.h>
14#include <api/fs/tracing_path.h>
15#include <traceevent/event-parse.h>
16#include <linux/hw_breakpoint.h>
17#include <linux/perf_event.h>
18#include <linux/compiler.h>
19#include <linux/err.h>
20#include <linux/zalloc.h>
21#include <sys/ioctl.h>
22#include <sys/resource.h>
23#include <sys/types.h>
24#include <dirent.h>
25#include <stdlib.h>
26#include <perf/evsel.h>
27#include "asm/bug.h"
28#include "callchain.h"
29#include "cgroup.h"
30#include "counts.h"
31#include "event.h"
32#include "evsel.h"
33#include "util/env.h"
34#include "util/evsel_config.h"
35#include "util/evsel_fprintf.h"
36#include "evlist.h"
37#include <perf/cpumap.h>
38#include "thread_map.h"
39#include "target.h"
40#include "perf_regs.h"
41#include "record.h"
42#include "debug.h"
43#include "trace-event.h"
44#include "stat.h"
45#include "string2.h"
46#include "memswap.h"
47#include "util.h"
48#include "../perf-sys.h"
49#include "util/parse-branch-options.h"
50#include <internal/xyarray.h>
51#include <internal/lib.h>
52
53#include <linux/ctype.h>
54
55struct perf_missing_features perf_missing_features;
56
57static clockid_t clockid;
58
59static int evsel__no_extra_init(struct evsel *evsel __maybe_unused)
60{
61	return 0;
62}
63
64void __weak test_attr__ready(void) { }
65
66static void evsel__no_extra_fini(struct evsel *evsel __maybe_unused)
67{
68}
69
70static struct {
71	size_t	size;
72	int	(*init)(struct evsel *evsel);
73	void	(*fini)(struct evsel *evsel);
74} perf_evsel__object = {
75	.size = sizeof(struct evsel),
76	.init = evsel__no_extra_init,
77	.fini = evsel__no_extra_fini,
78};
79
80int evsel__object_config(size_t object_size, int (*init)(struct evsel *evsel),
81			 void (*fini)(struct evsel *evsel))
82{
83
84	if (object_size == 0)
85		goto set_methods;
86
87	if (perf_evsel__object.size > object_size)
88		return -EINVAL;
89
90	perf_evsel__object.size = object_size;
91
92set_methods:
93	if (init != NULL)
94		perf_evsel__object.init = init;
95
96	if (fini != NULL)
97		perf_evsel__object.fini = fini;
98
99	return 0;
100}
101
102#define FD(e, x, y) (*(int *)xyarray__entry(e->core.fd, x, y))
103
104int __evsel__sample_size(u64 sample_type)
105{
106	u64 mask = sample_type & PERF_SAMPLE_MASK;
107	int size = 0;
108	int i;
109
110	for (i = 0; i < 64; i++) {
111		if (mask & (1ULL << i))
112			size++;
113	}
114
115	size *= sizeof(u64);
116
117	return size;
118}
119
120/**
121 * __perf_evsel__calc_id_pos - calculate id_pos.
122 * @sample_type: sample type
123 *
124 * This function returns the position of the event id (PERF_SAMPLE_ID or
125 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of struct
126 * perf_record_sample.
127 */
128static int __perf_evsel__calc_id_pos(u64 sample_type)
129{
130	int idx = 0;
131
132	if (sample_type & PERF_SAMPLE_IDENTIFIER)
133		return 0;
134
135	if (!(sample_type & PERF_SAMPLE_ID))
136		return -1;
137
138	if (sample_type & PERF_SAMPLE_IP)
139		idx += 1;
140
141	if (sample_type & PERF_SAMPLE_TID)
142		idx += 1;
143
144	if (sample_type & PERF_SAMPLE_TIME)
145		idx += 1;
146
147	if (sample_type & PERF_SAMPLE_ADDR)
148		idx += 1;
149
150	return idx;
151}
152
153/**
154 * __perf_evsel__calc_is_pos - calculate is_pos.
155 * @sample_type: sample type
156 *
157 * This function returns the position (counting backwards) of the event id
158 * (PERF_SAMPLE_ID or PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if
159 * sample_id_all is used there is an id sample appended to non-sample events.
160 */
161static int __perf_evsel__calc_is_pos(u64 sample_type)
162{
163	int idx = 1;
164
165	if (sample_type & PERF_SAMPLE_IDENTIFIER)
166		return 1;
167
168	if (!(sample_type & PERF_SAMPLE_ID))
169		return -1;
170
171	if (sample_type & PERF_SAMPLE_CPU)
172		idx += 1;
173
174	if (sample_type & PERF_SAMPLE_STREAM_ID)
175		idx += 1;
176
177	return idx;
178}
179
180void evsel__calc_id_pos(struct evsel *evsel)
181{
182	evsel->id_pos = __perf_evsel__calc_id_pos(evsel->core.attr.sample_type);
183	evsel->is_pos = __perf_evsel__calc_is_pos(evsel->core.attr.sample_type);
184}
185
186void __evsel__set_sample_bit(struct evsel *evsel,
187				  enum perf_event_sample_format bit)
188{
189	if (!(evsel->core.attr.sample_type & bit)) {
190		evsel->core.attr.sample_type |= bit;
191		evsel->sample_size += sizeof(u64);
192		evsel__calc_id_pos(evsel);
193	}
194}
195
196void __evsel__reset_sample_bit(struct evsel *evsel,
197				    enum perf_event_sample_format bit)
198{
199	if (evsel->core.attr.sample_type & bit) {
200		evsel->core.attr.sample_type &= ~bit;
201		evsel->sample_size -= sizeof(u64);
202		evsel__calc_id_pos(evsel);
203	}
204}
205
206void evsel__set_sample_id(struct evsel *evsel,
207			       bool can_sample_identifier)
208{
209	if (can_sample_identifier) {
210		evsel__reset_sample_bit(evsel, ID);
211		evsel__set_sample_bit(evsel, IDENTIFIER);
212	} else {
213		evsel__set_sample_bit(evsel, ID);
214	}
215	evsel->core.attr.read_format |= PERF_FORMAT_ID;
216}
217
218/**
219 * evsel__is_function_event - Return whether given evsel is a function
220 * trace event
221 *
222 * @evsel - evsel selector to be tested
223 *
224 * Return %true if event is function trace event
225 */
226bool evsel__is_function_event(struct evsel *evsel)
227{
228#define FUNCTION_EVENT "ftrace:function"
229
230	return evsel->name &&
231	       !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
232
233#undef FUNCTION_EVENT
234}
235
236void evsel__init(struct evsel *evsel,
237		 struct perf_event_attr *attr, int idx)
238{
239	perf_evsel__init(&evsel->core, attr);
240	evsel->idx	   = idx;
241	evsel->tracking	   = !idx;
242	evsel->leader	   = evsel;
243	evsel->unit	   = "";
244	evsel->scale	   = 1.0;
245	evsel->max_events  = ULONG_MAX;
246	evsel->evlist	   = NULL;
247	evsel->bpf_obj	   = NULL;
248	evsel->bpf_fd	   = -1;
249	INIT_LIST_HEAD(&evsel->config_terms);
250	perf_evsel__object.init(evsel);
251	evsel->sample_size = __evsel__sample_size(attr->sample_type);
252	evsel__calc_id_pos(evsel);
253	evsel->cmdline_group_boundary = false;
254	evsel->metric_expr   = NULL;
255	evsel->metric_name   = NULL;
256	evsel->metric_events = NULL;
257	evsel->per_pkg_mask  = NULL;
258	evsel->collect_stat  = false;
259	evsel->pmu_name      = NULL;
260}
261
262struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx)
263{
264	struct evsel *evsel = zalloc(perf_evsel__object.size);
265
266	if (!evsel)
267		return NULL;
268	evsel__init(evsel, attr, idx);
269
270	if (evsel__is_bpf_output(evsel)) {
271		evsel->core.attr.sample_type |= (PERF_SAMPLE_RAW | PERF_SAMPLE_TIME |
272					    PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD),
273		evsel->core.attr.sample_period = 1;
274	}
275
276	if (evsel__is_clock(evsel)) {
277		/*
278		 * The evsel->unit points to static alias->unit
279		 * so it's ok to use static string in here.
280		 */
281		static const char *unit = "msec";
282
283		evsel->unit = unit;
284		evsel->scale = 1e-6;
285	}
286
287	return evsel;
288}
289
290static bool perf_event_can_profile_kernel(void)
291{
292	return perf_event_paranoid_check(1);
293}
294
295struct evsel *evsel__new_cycles(bool precise)
296{
297	struct perf_event_attr attr = {
298		.type	= PERF_TYPE_HARDWARE,
299		.config	= PERF_COUNT_HW_CPU_CYCLES,
300		.exclude_kernel	= !perf_event_can_profile_kernel(),
301	};
302	struct evsel *evsel;
303
304	event_attr_init(&attr);
305
306	if (!precise)
307		goto new_event;
308
309	/*
310	 * Now let the usual logic to set up the perf_event_attr defaults
311	 * to kick in when we return and before perf_evsel__open() is called.
312	 */
313new_event:
314	evsel = evsel__new(&attr);
315	if (evsel == NULL)
316		goto out;
317
318	evsel->precise_max = true;
319
320	/* use asprintf() because free(evsel) assumes name is allocated */
321	if (asprintf(&evsel->name, "cycles%s%s%.*s",
322		     (attr.precise_ip || attr.exclude_kernel) ? ":" : "",
323		     attr.exclude_kernel ? "u" : "",
324		     attr.precise_ip ? attr.precise_ip + 1 : 0, "ppp") < 0)
325		goto error_free;
326out:
327	return evsel;
328error_free:
329	evsel__delete(evsel);
330	evsel = NULL;
331	goto out;
332}
333
334static int evsel__copy_config_terms(struct evsel *dst, struct evsel *src)
335{
336	struct evsel_config_term *pos, *tmp;
337
338	list_for_each_entry(pos, &src->config_terms, list) {
339		tmp = malloc(sizeof(*tmp));
340		if (tmp == NULL)
341			return -ENOMEM;
342
343		*tmp = *pos;
344		if (tmp->free_str) {
345			tmp->val.str = strdup(pos->val.str);
346			if (tmp->val.str == NULL) {
347				free(tmp);
348				return -ENOMEM;
349			}
350		}
351		list_add_tail(&tmp->list, &dst->config_terms);
352	}
353	return 0;
354}
355
356/**
357 * evsel__clone - create a new evsel copied from @orig
358 * @orig: original evsel
359 *
360 * The assumption is that @orig is not configured nor opened yet.
361 * So we only care about the attributes that can be set while it's parsed.
362 */
363struct evsel *evsel__clone(struct evsel *orig)
364{
365	struct evsel *evsel;
366
367	BUG_ON(orig->core.fd);
368	BUG_ON(orig->counts);
369	BUG_ON(orig->priv);
370	BUG_ON(orig->per_pkg_mask);
371
372	/* cannot handle BPF objects for now */
373	if (orig->bpf_obj)
374		return NULL;
375
376	evsel = evsel__new(&orig->core.attr);
377	if (evsel == NULL)
378		return NULL;
379
380	evsel->core.cpus = perf_cpu_map__get(orig->core.cpus);
381	evsel->core.own_cpus = perf_cpu_map__get(orig->core.own_cpus);
382	evsel->core.threads = perf_thread_map__get(orig->core.threads);
383	evsel->core.nr_members = orig->core.nr_members;
384	evsel->core.system_wide = orig->core.system_wide;
385
386	if (orig->name) {
387		evsel->name = strdup(orig->name);
388		if (evsel->name == NULL)
389			goto out_err;
390	}
391	if (orig->group_name) {
392		evsel->group_name = strdup(orig->group_name);
393		if (evsel->group_name == NULL)
394			goto out_err;
395	}
396	if (orig->pmu_name) {
397		evsel->pmu_name = strdup(orig->pmu_name);
398		if (evsel->pmu_name == NULL)
399			goto out_err;
400	}
401	if (orig->filter) {
402		evsel->filter = strdup(orig->filter);
403		if (evsel->filter == NULL)
404			goto out_err;
405	}
406	evsel->cgrp = cgroup__get(orig->cgrp);
407	evsel->tp_format = orig->tp_format;
408	evsel->handler = orig->handler;
409	evsel->leader = orig->leader;
410
411	evsel->max_events = orig->max_events;
412	evsel->tool_event = orig->tool_event;
413	evsel->unit = orig->unit;
414	evsel->scale = orig->scale;
415	evsel->snapshot = orig->snapshot;
416	evsel->per_pkg = orig->per_pkg;
417	evsel->percore = orig->percore;
418	evsel->precise_max = orig->precise_max;
419	evsel->use_uncore_alias = orig->use_uncore_alias;
420	evsel->is_libpfm_event = orig->is_libpfm_event;
421
422	evsel->exclude_GH = orig->exclude_GH;
423	evsel->sample_read = orig->sample_read;
424	evsel->auto_merge_stats = orig->auto_merge_stats;
425	evsel->collect_stat = orig->collect_stat;
426	evsel->weak_group = orig->weak_group;
427
428	if (evsel__copy_config_terms(evsel, orig) < 0)
429		goto out_err;
430
431	return evsel;
432
433out_err:
434	evsel__delete(evsel);
435	return NULL;
436}
437
438/*
439 * Returns pointer with encoded error via <linux/err.h> interface.
440 */
441struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx)
442{
443	struct evsel *evsel = zalloc(perf_evsel__object.size);
444	int err = -ENOMEM;
445
446	if (evsel == NULL) {
447		goto out_err;
448	} else {
449		struct perf_event_attr attr = {
450			.type	       = PERF_TYPE_TRACEPOINT,
451			.sample_type   = (PERF_SAMPLE_RAW | PERF_SAMPLE_TIME |
452					  PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD),
453		};
454
455		if (asprintf(&evsel->name, "%s:%s", sys, name) < 0)
456			goto out_free;
457
458		evsel->tp_format = trace_event__tp_format(sys, name);
459		if (IS_ERR(evsel->tp_format)) {
460			err = PTR_ERR(evsel->tp_format);
461			goto out_free;
462		}
463
464		event_attr_init(&attr);
465		attr.config = evsel->tp_format->id;
466		attr.sample_period = 1;
467		evsel__init(evsel, &attr, idx);
468	}
469
470	return evsel;
471
472out_free:
473	zfree(&evsel->name);
474	free(evsel);
475out_err:
476	return ERR_PTR(err);
477}
478
479const char *evsel__hw_names[PERF_COUNT_HW_MAX] = {
480	"cycles",
481	"instructions",
482	"cache-references",
483	"cache-misses",
484	"branches",
485	"branch-misses",
486	"bus-cycles",
487	"stalled-cycles-frontend",
488	"stalled-cycles-backend",
489	"ref-cycles",
490};
491
492static const char *__evsel__hw_name(u64 config)
493{
494	if (config < PERF_COUNT_HW_MAX && evsel__hw_names[config])
495		return evsel__hw_names[config];
496
497	return "unknown-hardware";
498}
499
500static int perf_evsel__add_modifiers(struct evsel *evsel, char *bf, size_t size)
501{
502	int colon = 0, r = 0;
503	struct perf_event_attr *attr = &evsel->core.attr;
504	bool exclude_guest_default = false;
505
506#define MOD_PRINT(context, mod)	do {					\
507		if (!attr->exclude_##context) {				\
508			if (!colon) colon = ++r;			\
509			r += scnprintf(bf + r, size - r, "%c", mod);	\
510		} } while(0)
511
512	if (attr->exclude_kernel || attr->exclude_user || attr->exclude_hv) {
513		MOD_PRINT(kernel, 'k');
514		MOD_PRINT(user, 'u');
515		MOD_PRINT(hv, 'h');
516		exclude_guest_default = true;
517	}
518
519	if (attr->precise_ip) {
520		if (!colon)
521			colon = ++r;
522		r += scnprintf(bf + r, size - r, "%.*s", attr->precise_ip, "ppp");
523		exclude_guest_default = true;
524	}
525
526	if (attr->exclude_host || attr->exclude_guest == exclude_guest_default) {
527		MOD_PRINT(host, 'H');
528		MOD_PRINT(guest, 'G');
529	}
530#undef MOD_PRINT
531	if (colon)
532		bf[colon - 1] = ':';
533	return r;
534}
535
536static int evsel__hw_name(struct evsel *evsel, char *bf, size_t size)
537{
538	int r = scnprintf(bf, size, "%s", __evsel__hw_name(evsel->core.attr.config));
539	return r + perf_evsel__add_modifiers(evsel, bf + r, size - r);
540}
541
542const char *evsel__sw_names[PERF_COUNT_SW_MAX] = {
543	"cpu-clock",
544	"task-clock",
545	"page-faults",
546	"context-switches",
547	"cpu-migrations",
548	"minor-faults",
549	"major-faults",
550	"alignment-faults",
551	"emulation-faults",
552	"dummy",
553};
554
555static const char *__evsel__sw_name(u64 config)
556{
557	if (config < PERF_COUNT_SW_MAX && evsel__sw_names[config])
558		return evsel__sw_names[config];
559	return "unknown-software";
560}
561
562static int evsel__sw_name(struct evsel *evsel, char *bf, size_t size)
563{
564	int r = scnprintf(bf, size, "%s", __evsel__sw_name(evsel->core.attr.config));
565	return r + perf_evsel__add_modifiers(evsel, bf + r, size - r);
566}
567
568static int __evsel__bp_name(char *bf, size_t size, u64 addr, u64 type)
569{
570	int r;
571
572	r = scnprintf(bf, size, "mem:0x%" PRIx64 ":", addr);
573
574	if (type & HW_BREAKPOINT_R)
575		r += scnprintf(bf + r, size - r, "r");
576
577	if (type & HW_BREAKPOINT_W)
578		r += scnprintf(bf + r, size - r, "w");
579
580	if (type & HW_BREAKPOINT_X)
581		r += scnprintf(bf + r, size - r, "x");
582
583	return r;
584}
585
586static int evsel__bp_name(struct evsel *evsel, char *bf, size_t size)
587{
588	struct perf_event_attr *attr = &evsel->core.attr;
589	int r = __evsel__bp_name(bf, size, attr->bp_addr, attr->bp_type);
590	return r + perf_evsel__add_modifiers(evsel, bf + r, size - r);
591}
592
593const char *evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES] = {
594 { "L1-dcache",	"l1-d",		"l1d",		"L1-data",		},
595 { "L1-icache",	"l1-i",		"l1i",		"L1-instruction",	},
596 { "LLC",	"L2",							},
597 { "dTLB",	"d-tlb",	"Data-TLB",				},
598 { "iTLB",	"i-tlb",	"Instruction-TLB",			},
599 { "branch",	"branches",	"bpu",		"btb",		"bpc",	},
600 { "node",								},
601};
602
603const char *evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES] = {
604 { "load",	"loads",	"read",					},
605 { "store",	"stores",	"write",				},
606 { "prefetch",	"prefetches",	"speculative-read", "speculative-load",	},
607};
608
609const char *evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES] = {
610 { "refs",	"Reference",	"ops",		"access",		},
611 { "misses",	"miss",							},
612};
613
614#define C(x)		PERF_COUNT_HW_CACHE_##x
615#define CACHE_READ	(1 << C(OP_READ))
616#define CACHE_WRITE	(1 << C(OP_WRITE))
617#define CACHE_PREFETCH	(1 << C(OP_PREFETCH))
618#define COP(x)		(1 << x)
619
620/*
621 * cache operartion stat
622 * L1I : Read and prefetch only
623 * ITLB and BPU : Read-only
624 */
625static unsigned long evsel__hw_cache_stat[C(MAX)] = {
626 [C(L1D)]	= (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
627 [C(L1I)]	= (CACHE_READ | CACHE_PREFETCH),
628 [C(LL)]	= (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
629 [C(DTLB)]	= (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
630 [C(ITLB)]	= (CACHE_READ),
631 [C(BPU)]	= (CACHE_READ),
632 [C(NODE)]	= (CACHE_READ | CACHE_WRITE | CACHE_PREFETCH),
633};
634
635bool evsel__is_cache_op_valid(u8 type, u8 op)
636{
637	if (evsel__hw_cache_stat[type] & COP(op))
638		return true;	/* valid */
639	else
640		return false;	/* invalid */
641}
642
643int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size)
644{
645	if (result) {
646		return scnprintf(bf, size, "%s-%s-%s", evsel__hw_cache[type][0],
647				 evsel__hw_cache_op[op][0],
648				 evsel__hw_cache_result[result][0]);
649	}
650
651	return scnprintf(bf, size, "%s-%s", evsel__hw_cache[type][0],
652			 evsel__hw_cache_op[op][1]);
653}
654
655static int __evsel__hw_cache_name(u64 config, char *bf, size_t size)
656{
657	u8 op, result, type = (config >>  0) & 0xff;
658	const char *err = "unknown-ext-hardware-cache-type";
659
660	if (type >= PERF_COUNT_HW_CACHE_MAX)
661		goto out_err;
662
663	op = (config >>  8) & 0xff;
664	err = "unknown-ext-hardware-cache-op";
665	if (op >= PERF_COUNT_HW_CACHE_OP_MAX)
666		goto out_err;
667
668	result = (config >> 16) & 0xff;
669	err = "unknown-ext-hardware-cache-result";
670	if (result >= PERF_COUNT_HW_CACHE_RESULT_MAX)
671		goto out_err;
672
673	err = "invalid-cache";
674	if (!evsel__is_cache_op_valid(type, op))
675		goto out_err;
676
677	return __evsel__hw_cache_type_op_res_name(type, op, result, bf, size);
678out_err:
679	return scnprintf(bf, size, "%s", err);
680}
681
682static int evsel__hw_cache_name(struct evsel *evsel, char *bf, size_t size)
683{
684	int ret = __evsel__hw_cache_name(evsel->core.attr.config, bf, size);
685	return ret + perf_evsel__add_modifiers(evsel, bf + ret, size - ret);
686}
687
688static int evsel__raw_name(struct evsel *evsel, char *bf, size_t size)
689{
690	int ret = scnprintf(bf, size, "raw 0x%" PRIx64, evsel->core.attr.config);
691	return ret + perf_evsel__add_modifiers(evsel, bf + ret, size - ret);
692}
693
694static int evsel__tool_name(char *bf, size_t size)
695{
696	int ret = scnprintf(bf, size, "duration_time");
697	return ret;
698}
699
700const char *evsel__name(struct evsel *evsel)
701{
702	char bf[128];
703
704	if (!evsel)
705		goto out_unknown;
706
707	if (evsel->name)
708		return evsel->name;
709
710	switch (evsel->core.attr.type) {
711	case PERF_TYPE_RAW:
712		evsel__raw_name(evsel, bf, sizeof(bf));
713		break;
714
715	case PERF_TYPE_HARDWARE:
716		evsel__hw_name(evsel, bf, sizeof(bf));
717		break;
718
719	case PERF_TYPE_HW_CACHE:
720		evsel__hw_cache_name(evsel, bf, sizeof(bf));
721		break;
722
723	case PERF_TYPE_SOFTWARE:
724		if (evsel->tool_event)
725			evsel__tool_name(bf, sizeof(bf));
726		else
727			evsel__sw_name(evsel, bf, sizeof(bf));
728		break;
729
730	case PERF_TYPE_TRACEPOINT:
731		scnprintf(bf, sizeof(bf), "%s", "unknown tracepoint");
732		break;
733
734	case PERF_TYPE_BREAKPOINT:
735		evsel__bp_name(evsel, bf, sizeof(bf));
736		break;
737
738	default:
739		scnprintf(bf, sizeof(bf), "unknown attr type: %d",
740			  evsel->core.attr.type);
741		break;
742	}
743
744	evsel->name = strdup(bf);
745
746	if (evsel->name)
747		return evsel->name;
748out_unknown:
749	return "unknown";
750}
751
752const char *evsel__group_name(struct evsel *evsel)
753{
754	return evsel->group_name ?: "anon group";
755}
756
757/*
758 * Returns the group details for the specified leader,
759 * with following rules.
760 *
761 *  For record -e '{cycles,instructions}'
762 *    'anon group { cycles:u, instructions:u }'
763 *
764 *  For record -e 'cycles,instructions' and report --group
765 *    'cycles:u, instructions:u'
766 */
767int evsel__group_desc(struct evsel *evsel, char *buf, size_t size)
768{
769	int ret = 0;
770	struct evsel *pos;
771	const char *group_name = evsel__group_name(evsel);
772
773	if (!evsel->forced_leader)
774		ret = scnprintf(buf, size, "%s { ", group_name);
775
776	ret += scnprintf(buf + ret, size - ret, "%s", evsel__name(evsel));
777
778	for_each_group_member(pos, evsel)
779		ret += scnprintf(buf + ret, size - ret, ", %s", evsel__name(pos));
780
781	if (!evsel->forced_leader)
782		ret += scnprintf(buf + ret, size - ret, " }");
783
784	return ret;
785}
786
787static void __evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
788				      struct callchain_param *param)
789{
790	bool function = evsel__is_function_event(evsel);
791	struct perf_event_attr *attr = &evsel->core.attr;
792
793	evsel__set_sample_bit(evsel, CALLCHAIN);
794
795	attr->sample_max_stack = param->max_stack;
796
797	if (opts->kernel_callchains)
798		attr->exclude_callchain_user = 1;
799	if (opts->user_callchains)
800		attr->exclude_callchain_kernel = 1;
801	if (param->record_mode == CALLCHAIN_LBR) {
802		if (!opts->branch_stack) {
803			if (attr->exclude_user) {
804				pr_warning("LBR callstack option is only available "
805					   "to get user callchain information. "
806					   "Falling back to framepointers.\n");
807			} else {
808				evsel__set_sample_bit(evsel, BRANCH_STACK);
809				attr->branch_sample_type = PERF_SAMPLE_BRANCH_USER |
810							PERF_SAMPLE_BRANCH_CALL_STACK |
811							PERF_SAMPLE_BRANCH_NO_CYCLES |
812							PERF_SAMPLE_BRANCH_NO_FLAGS |
813							PERF_SAMPLE_BRANCH_HW_INDEX;
814			}
815		} else
816			 pr_warning("Cannot use LBR callstack with branch stack. "
817				    "Falling back to framepointers.\n");
818	}
819
820	if (param->record_mode == CALLCHAIN_DWARF) {
821		if (!function) {
822			evsel__set_sample_bit(evsel, REGS_USER);
823			evsel__set_sample_bit(evsel, STACK_USER);
824			if (opts->sample_user_regs && DWARF_MINIMAL_REGS != PERF_REGS_MASK) {
825				attr->sample_regs_user |= DWARF_MINIMAL_REGS;
826				pr_warning("WARNING: The use of --call-graph=dwarf may require all the user registers, "
827					   "specifying a subset with --user-regs may render DWARF unwinding unreliable, "
828					   "so the minimal registers set (IP, SP) is explicitly forced.\n");
829			} else {
830				attr->sample_regs_user |= PERF_REGS_MASK;
831			}
832			attr->sample_stack_user = param->dump_size;
833			attr->exclude_callchain_user = 1;
834		} else {
835			pr_info("Cannot use DWARF unwind for function trace event,"
836				" falling back to framepointers.\n");
837		}
838	}
839
840	if (function) {
841		pr_info("Disabling user space callchains for function trace event.\n");
842		attr->exclude_callchain_user = 1;
843	}
844}
845
846void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
847			     struct callchain_param *param)
848{
849	if (param->enabled)
850		return __evsel__config_callchain(evsel, opts, param);
851}
852
853static void
854perf_evsel__reset_callgraph(struct evsel *evsel,
855			    struct callchain_param *param)
856{
857	struct perf_event_attr *attr = &evsel->core.attr;
858
859	evsel__reset_sample_bit(evsel, CALLCHAIN);
860	if (param->record_mode == CALLCHAIN_LBR) {
861		evsel__reset_sample_bit(evsel, BRANCH_STACK);
862		attr->branch_sample_type &= ~(PERF_SAMPLE_BRANCH_USER |
863					      PERF_SAMPLE_BRANCH_CALL_STACK |
864					      PERF_SAMPLE_BRANCH_HW_INDEX);
865	}
866	if (param->record_mode == CALLCHAIN_DWARF) {
867		evsel__reset_sample_bit(evsel, REGS_USER);
868		evsel__reset_sample_bit(evsel, STACK_USER);
869	}
870}
871
872static void evsel__apply_config_terms(struct evsel *evsel,
873				      struct record_opts *opts, bool track)
874{
875	struct evsel_config_term *term;
876	struct list_head *config_terms = &evsel->config_terms;
877	struct perf_event_attr *attr = &evsel->core.attr;
878	/* callgraph default */
879	struct callchain_param param = {
880		.record_mode = callchain_param.record_mode,
881	};
882	u32 dump_size = 0;
883	int max_stack = 0;
884	const char *callgraph_buf = NULL;
885
886	list_for_each_entry(term, config_terms, list) {
887		switch (term->type) {
888		case EVSEL__CONFIG_TERM_PERIOD:
889			if (!(term->weak && opts->user_interval != ULLONG_MAX)) {
890				attr->sample_period = term->val.period;
891				attr->freq = 0;
892				evsel__reset_sample_bit(evsel, PERIOD);
893			}
894			break;
895		case EVSEL__CONFIG_TERM_FREQ:
896			if (!(term->weak && opts->user_freq != UINT_MAX)) {
897				attr->sample_freq = term->val.freq;
898				attr->freq = 1;
899				evsel__set_sample_bit(evsel, PERIOD);
900			}
901			break;
902		case EVSEL__CONFIG_TERM_TIME:
903			if (term->val.time)
904				evsel__set_sample_bit(evsel, TIME);
905			else
906				evsel__reset_sample_bit(evsel, TIME);
907			break;
908		case EVSEL__CONFIG_TERM_CALLGRAPH:
909			callgraph_buf = term->val.str;
910			break;
911		case EVSEL__CONFIG_TERM_BRANCH:
912			if (term->val.str && strcmp(term->val.str, "no")) {
913				evsel__set_sample_bit(evsel, BRANCH_STACK);
914				parse_branch_str(term->val.str,
915						 &attr->branch_sample_type);
916			} else
917				evsel__reset_sample_bit(evsel, BRANCH_STACK);
918			break;
919		case EVSEL__CONFIG_TERM_STACK_USER:
920			dump_size = term->val.stack_user;
921			break;
922		case EVSEL__CONFIG_TERM_MAX_STACK:
923			max_stack = term->val.max_stack;
924			break;
925		case EVSEL__CONFIG_TERM_MAX_EVENTS:
926			evsel->max_events = term->val.max_events;
927			break;
928		case EVSEL__CONFIG_TERM_INHERIT:
929			/*
930			 * attr->inherit should has already been set by
931			 * evsel__config. If user explicitly set
932			 * inherit using config terms, override global
933			 * opt->no_inherit setting.
934			 */
935			attr->inherit = term->val.inherit ? 1 : 0;
936			break;
937		case EVSEL__CONFIG_TERM_OVERWRITE:
938			attr->write_backward = term->val.overwrite ? 1 : 0;
939			break;
940		case EVSEL__CONFIG_TERM_DRV_CFG:
941			break;
942		case EVSEL__CONFIG_TERM_PERCORE:
943			break;
944		case EVSEL__CONFIG_TERM_AUX_OUTPUT:
945			attr->aux_output = term->val.aux_output ? 1 : 0;
946			break;
947		case EVSEL__CONFIG_TERM_AUX_SAMPLE_SIZE:
948			/* Already applied by auxtrace */
949			break;
950		case EVSEL__CONFIG_TERM_CFG_CHG:
951			break;
952		default:
953			break;
954		}
955	}
956
957	/* User explicitly set per-event callgraph, clear the old setting and reset. */
958	if ((callgraph_buf != NULL) || (dump_size > 0) || max_stack) {
959		bool sample_address = false;
960
961		if (max_stack) {
962			param.max_stack = max_stack;
963			if (callgraph_buf == NULL)
964				callgraph_buf = "fp";
965		}
966
967		/* parse callgraph parameters */
968		if (callgraph_buf != NULL) {
969			if (!strcmp(callgraph_buf, "no")) {
970				param.enabled = false;
971				param.record_mode = CALLCHAIN_NONE;
972			} else {
973				param.enabled = true;
974				if (parse_callchain_record(callgraph_buf, &param)) {
975					pr_err("per-event callgraph setting for %s failed. "
976					       "Apply callgraph global setting for it\n",
977					       evsel->name);
978					return;
979				}
980				if (param.record_mode == CALLCHAIN_DWARF)
981					sample_address = true;
982			}
983		}
984		if (dump_size > 0) {
985			dump_size = round_up(dump_size, sizeof(u64));
986			param.dump_size = dump_size;
987		}
988
989		/* If global callgraph set, clear it */
990		if (callchain_param.enabled)
991			perf_evsel__reset_callgraph(evsel, &callchain_param);
992
993		/* set perf-event callgraph */
994		if (param.enabled) {
995			if (sample_address) {
996				evsel__set_sample_bit(evsel, ADDR);
997				evsel__set_sample_bit(evsel, DATA_SRC);
998				evsel->core.attr.mmap_data = track;
999			}
1000			evsel__config_callchain(evsel, opts, &param);
1001		}
1002	}
1003}
1004
1005struct evsel_config_term *__evsel__get_config_term(struct evsel *evsel, enum evsel_term_type type)
1006{
1007	struct evsel_config_term *term, *found_term = NULL;
1008
1009	list_for_each_entry(term, &evsel->config_terms, list) {
1010		if (term->type == type)
1011			found_term = term;
1012	}
1013
1014	return found_term;
1015}
1016
1017static void evsel__set_default_freq_period(struct record_opts *opts,
1018					   struct perf_event_attr *attr)
1019{
1020	if (opts->freq) {
1021		attr->freq = 1;
1022		attr->sample_freq = opts->freq;
1023	} else {
1024		attr->sample_period = opts->default_interval;
1025	}
1026}
1027
1028/*
1029 * The enable_on_exec/disabled value strategy:
1030 *
1031 *  1) For any type of traced program:
1032 *    - all independent events and group leaders are disabled
1033 *    - all group members are enabled
1034 *
1035 *     Group members are ruled by group leaders. They need to
1036 *     be enabled, because the group scheduling relies on that.
1037 *
1038 *  2) For traced programs executed by perf:
1039 *     - all independent events and group leaders have
1040 *       enable_on_exec set
1041 *     - we don't specifically enable or disable any event during
1042 *       the record command
1043 *
1044 *     Independent events and group leaders are initially disabled
1045 *     and get enabled by exec. Group members are ruled by group
1046 *     leaders as stated in 1).
1047 *
1048 *  3) For traced programs attached by perf (pid/tid):
1049 *     - we specifically enable or disable all events during
1050 *       the record command
1051 *
1052 *     When attaching events to already running traced we
1053 *     enable/disable events specifically, as there's no
1054 *     initial traced exec call.
1055 */
1056void evsel__config(struct evsel *evsel, struct record_opts *opts,
1057		   struct callchain_param *callchain)
1058{
1059	struct evsel *leader = evsel->leader;
1060	struct perf_event_attr *attr = &evsel->core.attr;
1061	int track = evsel->tracking;
1062	bool per_cpu = opts->target.default_per_cpu && !opts->target.per_thread;
1063
1064	attr->sample_id_all = perf_missing_features.sample_id_all ? 0 : 1;
1065	attr->inherit	    = !opts->no_inherit;
1066	attr->write_backward = opts->overwrite ? 1 : 0;
1067
1068	evsel__set_sample_bit(evsel, IP);
1069	evsel__set_sample_bit(evsel, TID);
1070
1071	if (evsel->sample_read) {
1072		evsel__set_sample_bit(evsel, READ);
1073
1074		/*
1075		 * We need ID even in case of single event, because
1076		 * PERF_SAMPLE_READ process ID specific data.
1077		 */
1078		evsel__set_sample_id(evsel, false);
1079
1080		/*
1081		 * Apply group format only if we belong to group
1082		 * with more than one members.
1083		 */
1084		if (leader->core.nr_members > 1) {
1085			attr->read_format |= PERF_FORMAT_GROUP;
1086			attr->inherit = 0;
1087		}
1088	}
1089
1090	/*
1091	 * We default some events to have a default interval. But keep
1092	 * it a weak assumption overridable by the user.
1093	 */
1094	if ((evsel->is_libpfm_event && !attr->sample_period) ||
1095	    (!evsel->is_libpfm_event && (!attr->sample_period ||
1096					 opts->user_freq != UINT_MAX ||
1097					 opts->user_interval != ULLONG_MAX)))
1098		evsel__set_default_freq_period(opts, attr);
1099
1100	/*
1101	 * If attr->freq was set (here or earlier), ask for period
1102	 * to be sampled.
1103	 */
1104	if (attr->freq)
1105		evsel__set_sample_bit(evsel, PERIOD);
1106
1107	if (opts->no_samples)
1108		attr->sample_freq = 0;
1109
1110	if (opts->inherit_stat) {
1111		evsel->core.attr.read_format |=
1112			PERF_FORMAT_TOTAL_TIME_ENABLED |
1113			PERF_FORMAT_TOTAL_TIME_RUNNING |
1114			PERF_FORMAT_ID;
1115		attr->inherit_stat = 1;
1116	}
1117
1118	if (opts->sample_address) {
1119		evsel__set_sample_bit(evsel, ADDR);
1120		attr->mmap_data = track;
1121	}
1122
1123	/*
1124	 * We don't allow user space callchains for  function trace
1125	 * event, due to issues with page faults while tracing page
1126	 * fault handler and its overall trickiness nature.
1127	 */
1128	if (evsel__is_function_event(evsel))
1129		evsel->core.attr.exclude_callchain_user = 1;
1130
1131	if (callchain && callchain->enabled && !evsel->no_aux_samples)
1132		evsel__config_callchain(evsel, opts, callchain);
1133
1134	if (opts->sample_intr_regs && !evsel->no_aux_samples &&
1135	    !evsel__is_dummy_event(evsel)) {
1136		attr->sample_regs_intr = opts->sample_intr_regs;
1137		evsel__set_sample_bit(evsel, REGS_INTR);
1138	}
1139
1140	if (opts->sample_user_regs && !evsel->no_aux_samples &&
1141	    !evsel__is_dummy_event(evsel)) {
1142		attr->sample_regs_user |= opts->sample_user_regs;
1143		evsel__set_sample_bit(evsel, REGS_USER);
1144	}
1145
1146	if (target__has_cpu(&opts->target) || opts->sample_cpu)
1147		evsel__set_sample_bit(evsel, CPU);
1148
1149	/*
1150	 * When the user explicitly disabled time don't force it here.
1151	 */
1152	if (opts->sample_time &&
1153	    (!perf_missing_features.sample_id_all &&
1154	    (!opts->no_inherit || target__has_cpu(&opts->target) || per_cpu ||
1155	     opts->sample_time_set)))
1156		evsel__set_sample_bit(evsel, TIME);
1157
1158	if (opts->raw_samples && !evsel->no_aux_samples) {
1159		evsel__set_sample_bit(evsel, TIME);
1160		evsel__set_sample_bit(evsel, RAW);
1161		evsel__set_sample_bit(evsel, CPU);
1162	}
1163
1164	if (opts->sample_address)
1165		evsel__set_sample_bit(evsel, DATA_SRC);
1166
1167	if (opts->sample_phys_addr)
1168		evsel__set_sample_bit(evsel, PHYS_ADDR);
1169
1170	if (opts->no_buffering) {
1171		attr->watermark = 0;
1172		attr->wakeup_events = 1;
1173	}
1174	if (opts->branch_stack && !evsel->no_aux_samples) {
1175		evsel__set_sample_bit(evsel, BRANCH_STACK);
1176		attr->branch_sample_type = opts->branch_stack;
1177	}
1178
1179	if (opts->sample_weight)
1180		evsel__set_sample_bit(evsel, WEIGHT);
1181
1182	attr->task  = track;
1183	attr->mmap  = track;
1184	attr->mmap2 = track && !perf_missing_features.mmap2;
1185	attr->comm  = track;
1186	/*
1187	 * ksymbol is tracked separately with text poke because it needs to be
1188	 * system wide and enabled immediately.
1189	 */
1190	if (!opts->text_poke)
1191		attr->ksymbol = track && !perf_missing_features.ksymbol;
1192	attr->bpf_event = track && !opts->no_bpf_event && !perf_missing_features.bpf;
1193
1194	if (opts->record_namespaces)
1195		attr->namespaces  = track;
1196
1197	if (opts->record_cgroup) {
1198		attr->cgroup = track && !perf_missing_features.cgroup;
1199		evsel__set_sample_bit(evsel, CGROUP);
1200	}
1201
1202	if (opts->record_switch_events)
1203		attr->context_switch = track;
1204
1205	if (opts->sample_transaction)
1206		evsel__set_sample_bit(evsel, TRANSACTION);
1207
1208	if (opts->running_time) {
1209		evsel->core.attr.read_format |=
1210			PERF_FORMAT_TOTAL_TIME_ENABLED |
1211			PERF_FORMAT_TOTAL_TIME_RUNNING;
1212	}
1213
1214	/*
1215	 * XXX see the function comment above
1216	 *
1217	 * Disabling only independent events or group leaders,
1218	 * keeping group members enabled.
1219	 */
1220	if (evsel__is_group_leader(evsel))
1221		attr->disabled = 1;
1222
1223	/*
1224	 * Setting enable_on_exec for independent events and
1225	 * group leaders for traced executed by perf.
1226	 */
1227	if (target__none(&opts->target) && evsel__is_group_leader(evsel) &&
1228	    !opts->initial_delay)
1229		attr->enable_on_exec = 1;
1230
1231	if (evsel->immediate) {
1232		attr->disabled = 0;
1233		attr->enable_on_exec = 0;
1234	}
1235
1236	clockid = opts->clockid;
1237	if (opts->use_clockid) {
1238		attr->use_clockid = 1;
1239		attr->clockid = opts->clockid;
1240	}
1241
1242	if (evsel->precise_max)
1243		attr->precise_ip = 3;
1244
1245	if (opts->all_user) {
1246		attr->exclude_kernel = 1;
1247		attr->exclude_user   = 0;
1248	}
1249
1250	if (opts->all_kernel) {
1251		attr->exclude_kernel = 0;
1252		attr->exclude_user   = 1;
1253	}
1254
1255	if (evsel->core.own_cpus || evsel->unit)
1256		evsel->core.attr.read_format |= PERF_FORMAT_ID;
1257
1258	/*
1259	 * Apply event specific term settings,
1260	 * it overloads any global configuration.
1261	 */
1262	evsel__apply_config_terms(evsel, opts, track);
1263
1264	evsel->ignore_missing_thread = opts->ignore_missing_thread;
1265
1266	/* The --period option takes the precedence. */
1267	if (opts->period_set) {
1268		if (opts->period)
1269			evsel__set_sample_bit(evsel, PERIOD);
1270		else
1271			evsel__reset_sample_bit(evsel, PERIOD);
1272	}
1273
1274	/*
1275	 * A dummy event never triggers any actual counter and therefore
1276	 * cannot be used with branch_stack.
1277	 *
1278	 * For initial_delay, a dummy event is added implicitly.
1279	 * The software event will trigger -EOPNOTSUPP error out,
1280	 * if BRANCH_STACK bit is set.
1281	 */
1282	if (evsel__is_dummy_event(evsel))
1283		evsel__reset_sample_bit(evsel, BRANCH_STACK);
1284}
1285
1286int evsel__set_filter(struct evsel *evsel, const char *filter)
1287{
1288	char *new_filter = strdup(filter);
1289
1290	if (new_filter != NULL) {
1291		free(evsel->filter);
1292		evsel->filter = new_filter;
1293		return 0;
1294	}
1295
1296	return -1;
1297}
1298
1299static int evsel__append_filter(struct evsel *evsel, const char *fmt, const char *filter)
1300{
1301	char *new_filter;
1302
1303	if (evsel->filter == NULL)
1304		return evsel__set_filter(evsel, filter);
1305
1306	if (asprintf(&new_filter, fmt, evsel->filter, filter) > 0) {
1307		free(evsel->filter);
1308		evsel->filter = new_filter;
1309		return 0;
1310	}
1311
1312	return -1;
1313}
1314
1315int evsel__append_tp_filter(struct evsel *evsel, const char *filter)
1316{
1317	return evsel__append_filter(evsel, "(%s) && (%s)", filter);
1318}
1319
1320int evsel__append_addr_filter(struct evsel *evsel, const char *filter)
1321{
1322	return evsel__append_filter(evsel, "%s,%s", filter);
1323}
1324
1325/* Caller has to clear disabled after going through all CPUs. */
1326int evsel__enable_cpu(struct evsel *evsel, int cpu)
1327{
1328	return perf_evsel__enable_cpu(&evsel->core, cpu);
1329}
1330
1331int evsel__enable(struct evsel *evsel)
1332{
1333	int err = perf_evsel__enable(&evsel->core);
1334
1335	if (!err)
1336		evsel->disabled = false;
1337	return err;
1338}
1339
1340/* Caller has to set disabled after going through all CPUs. */
1341int evsel__disable_cpu(struct evsel *evsel, int cpu)
1342{
1343	return perf_evsel__disable_cpu(&evsel->core, cpu);
1344}
1345
1346int evsel__disable(struct evsel *evsel)
1347{
1348	int err = perf_evsel__disable(&evsel->core);
1349	/*
1350	 * We mark it disabled here so that tools that disable a event can
1351	 * ignore events after they disable it. I.e. the ring buffer may have
1352	 * already a few more events queued up before the kernel got the stop
1353	 * request.
1354	 */
1355	if (!err)
1356		evsel->disabled = true;
1357
1358	return err;
1359}
1360
1361static void evsel__free_config_terms(struct evsel *evsel)
1362{
1363	struct evsel_config_term *term, *h;
1364
1365	list_for_each_entry_safe(term, h, &evsel->config_terms, list) {
1366		list_del_init(&term->list);
1367		if (term->free_str)
1368			zfree(&term->val.str);
1369		free(term);
1370	}
1371}
1372
1373void evsel__exit(struct evsel *evsel)
1374{
1375	assert(list_empty(&evsel->core.node));
1376	assert(evsel->evlist == NULL);
1377	evsel__free_counts(evsel);
1378	perf_evsel__free_fd(&evsel->core);
1379	perf_evsel__free_id(&evsel->core);
1380	evsel__free_config_terms(evsel);
1381	cgroup__put(evsel->cgrp);
1382	perf_cpu_map__put(evsel->core.cpus);
1383	perf_cpu_map__put(evsel->core.own_cpus);
1384	perf_thread_map__put(evsel->core.threads);
1385	zfree(&evsel->group_name);
1386	zfree(&evsel->name);
1387	zfree(&evsel->pmu_name);
1388	zfree(&evsel->per_pkg_mask);
1389	zfree(&evsel->metric_events);
1390	perf_evsel__object.fini(evsel);
1391}
1392
1393void evsel__delete(struct evsel *evsel)
1394{
1395	evsel__exit(evsel);
1396	free(evsel);
1397}
1398
1399void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
1400			   struct perf_counts_values *count)
1401{
1402	struct perf_counts_values tmp;
1403
1404	if (!evsel->prev_raw_counts)
1405		return;
1406
1407	if (cpu == -1) {
1408		tmp = evsel->prev_raw_counts->aggr;
1409		evsel->prev_raw_counts->aggr = *count;
1410	} else {
1411		tmp = *perf_counts(evsel->prev_raw_counts, cpu, thread);
1412		*perf_counts(evsel->prev_raw_counts, cpu, thread) = *count;
1413	}
1414
1415	count->val = count->val - tmp.val;
1416	count->ena = count->ena - tmp.ena;
1417	count->run = count->run - tmp.run;
1418}
1419
1420void perf_counts_values__scale(struct perf_counts_values *count,
1421			       bool scale, s8 *pscaled)
1422{
1423	s8 scaled = 0;
1424
1425	if (scale) {
1426		if (count->run == 0) {
1427			scaled = -1;
1428			count->val = 0;
1429		} else if (count->run < count->ena) {
1430			scaled = 1;
1431			count->val = (u64)((double) count->val * count->ena / count->run);
1432		}
1433	}
1434
1435	if (pscaled)
1436		*pscaled = scaled;
1437}
1438
1439static int evsel__read_one(struct evsel *evsel, int cpu, int thread)
1440{
1441	struct perf_counts_values *count = perf_counts(evsel->counts, cpu, thread);
1442
1443	return perf_evsel__read(&evsel->core, cpu, thread, count);
1444}
1445
1446static void
1447perf_evsel__set_count(struct evsel *counter, int cpu, int thread,
1448		      u64 val, u64 ena, u64 run)
1449{
1450	struct perf_counts_values *count;
1451
1452	count = perf_counts(counter->counts, cpu, thread);
1453
1454	count->val    = val;
1455	count->ena    = ena;
1456	count->run    = run;
1457
1458	perf_counts__set_loaded(counter->counts, cpu, thread, true);
1459}
1460
1461static int
1462perf_evsel__process_group_data(struct evsel *leader,
1463			       int cpu, int thread, u64 *data)
1464{
1465	u64 read_format = leader->core.attr.read_format;
1466	struct sample_read_value *v;
1467	u64 nr, ena = 0, run = 0, i;
1468
1469	nr = *data++;
1470
1471	if (nr != (u64) leader->core.nr_members)
1472		return -EINVAL;
1473
1474	if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED)
1475		ena = *data++;
1476
1477	if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING)
1478		run = *data++;
1479
1480	v = (struct sample_read_value *) data;
1481
1482	perf_evsel__set_count(leader, cpu, thread,
1483			      v[0].value, ena, run);
1484
1485	for (i = 1; i < nr; i++) {
1486		struct evsel *counter;
1487
1488		counter = perf_evlist__id2evsel(leader->evlist, v[i].id);
1489		if (!counter)
1490			return -EINVAL;
1491
1492		perf_evsel__set_count(counter, cpu, thread,
1493				      v[i].value, ena, run);
1494	}
1495
1496	return 0;
1497}
1498
1499static int evsel__read_group(struct evsel *leader, int cpu, int thread)
1500{
1501	struct perf_stat_evsel *ps = leader->stats;
1502	u64 read_format = leader->core.attr.read_format;
1503	int size = perf_evsel__read_size(&leader->core);
1504	u64 *data = ps->group_data;
1505
1506	if (!(read_format & PERF_FORMAT_ID))
1507		return -EINVAL;
1508
1509	if (!evsel__is_group_leader(leader))
1510		return -EINVAL;
1511
1512	if (!data) {
1513		data = zalloc(size);
1514		if (!data)
1515			return -ENOMEM;
1516
1517		ps->group_data = data;
1518	}
1519
1520	if (FD(leader, cpu, thread) < 0)
1521		return -EINVAL;
1522
1523	if (readn(FD(leader, cpu, thread), data, size) <= 0)
1524		return -errno;
1525
1526	return perf_evsel__process_group_data(leader, cpu, thread, data);
1527}
1528
1529int evsel__read_counter(struct evsel *evsel, int cpu, int thread)
1530{
1531	u64 read_format = evsel->core.attr.read_format;
1532
1533	if (read_format & PERF_FORMAT_GROUP)
1534		return evsel__read_group(evsel, cpu, thread);
1535
1536	return evsel__read_one(evsel, cpu, thread);
1537}
1538
1539int __evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread, bool scale)
1540{
1541	struct perf_counts_values count;
1542	size_t nv = scale ? 3 : 1;
1543
1544	if (FD(evsel, cpu, thread) < 0)
1545		return -EINVAL;
1546
1547	if (evsel->counts == NULL && evsel__alloc_counts(evsel, cpu + 1, thread + 1) < 0)
1548		return -ENOMEM;
1549
1550	if (readn(FD(evsel, cpu, thread), &count, nv * sizeof(u64)) <= 0)
1551		return -errno;
1552
1553	evsel__compute_deltas(evsel, cpu, thread, &count);
1554	perf_counts_values__scale(&count, scale, NULL);
1555	*perf_counts(evsel->counts, cpu, thread) = count;
1556	return 0;
1557}
1558
1559static int get_group_fd(struct evsel *evsel, int cpu, int thread)
1560{
1561	struct evsel *leader = evsel->leader;
1562	int fd;
1563
1564	if (evsel__is_group_leader(evsel))
1565		return -1;
1566
1567	/*
1568	 * Leader must be already processed/open,
1569	 * if not it's a bug.
1570	 */
1571	BUG_ON(!leader->core.fd);
1572
1573	fd = FD(leader, cpu, thread);
1574	BUG_ON(fd == -1);
1575
1576	return fd;
1577}
1578
1579static void perf_evsel__remove_fd(struct evsel *pos,
1580				  int nr_cpus, int nr_threads,
1581				  int thread_idx)
1582{
1583	for (int cpu = 0; cpu < nr_cpus; cpu++)
1584		for (int thread = thread_idx; thread < nr_threads - 1; thread++)
1585			FD(pos, cpu, thread) = FD(pos, cpu, thread + 1);
1586}
1587
1588static int update_fds(struct evsel *evsel,
1589		      int nr_cpus, int cpu_idx,
1590		      int nr_threads, int thread_idx)
1591{
1592	struct evsel *pos;
1593
1594	if (cpu_idx >= nr_cpus || thread_idx >= nr_threads)
1595		return -EINVAL;
1596
1597	evlist__for_each_entry(evsel->evlist, pos) {
1598		nr_cpus = pos != evsel ? nr_cpus : cpu_idx;
1599
1600		perf_evsel__remove_fd(pos, nr_cpus, nr_threads, thread_idx);
1601
1602		/*
1603		 * Since fds for next evsel has not been created,
1604		 * there is no need to iterate whole event list.
1605		 */
1606		if (pos == evsel)
1607			break;
1608	}
1609	return 0;
1610}
1611
1612static bool ignore_missing_thread(struct evsel *evsel,
1613				  int nr_cpus, int cpu,
1614				  struct perf_thread_map *threads,
1615				  int thread, int err)
1616{
1617	pid_t ignore_pid = perf_thread_map__pid(threads, thread);
1618
1619	if (!evsel->ignore_missing_thread)
1620		return false;
1621
1622	/* The system wide setup does not work with threads. */
1623	if (evsel->core.system_wide)
1624		return false;
1625
1626	/* The -ESRCH is perf event syscall errno for pid's not found. */
1627	if (err != -ESRCH)
1628		return false;
1629
1630	/* If there's only one thread, let it fail. */
1631	if (threads->nr == 1)
1632		return false;
1633
1634	/*
1635	 * We should remove fd for missing_thread first
1636	 * because thread_map__remove() will decrease threads->nr.
1637	 */
1638	if (update_fds(evsel, nr_cpus, cpu, threads->nr, thread))
1639		return false;
1640
1641	if (thread_map__remove(threads, thread))
1642		return false;
1643
1644	pr_warning("WARNING: Ignored open failure for pid %d\n",
1645		   ignore_pid);
1646	return true;
1647}
1648
1649static int __open_attr__fprintf(FILE *fp, const char *name, const char *val,
1650				void *priv __maybe_unused)
1651{
1652	return fprintf(fp, "  %-32s %s\n", name, val);
1653}
1654
1655static void display_attr(struct perf_event_attr *attr)
1656{
1657	if (verbose >= 2 || debug_peo_args) {
1658		fprintf(stderr, "%.60s\n", graph_dotted_line);
1659		fprintf(stderr, "perf_event_attr:\n");
1660		perf_event_attr__fprintf(stderr, attr, __open_attr__fprintf, NULL);
1661		fprintf(stderr, "%.60s\n", graph_dotted_line);
1662	}
1663}
1664
1665static int perf_event_open(struct evsel *evsel,
1666			   pid_t pid, int cpu, int group_fd,
1667			   unsigned long flags)
1668{
1669	int precise_ip = evsel->core.attr.precise_ip;
1670	int fd;
1671
1672	while (1) {
1673		pr_debug2_peo("sys_perf_event_open: pid %d  cpu %d  group_fd %d  flags %#lx",
1674			  pid, cpu, group_fd, flags);
1675
1676		fd = sys_perf_event_open(&evsel->core.attr, pid, cpu, group_fd, flags);
1677		if (fd >= 0)
1678			break;
1679
1680		/* Do not try less precise if not requested. */
1681		if (!evsel->precise_max)
1682			break;
1683
1684		/*
1685		 * We tried all the precise_ip values, and it's
1686		 * still failing, so leave it to standard fallback.
1687		 */
1688		if (!evsel->core.attr.precise_ip) {
1689			evsel->core.attr.precise_ip = precise_ip;
1690			break;
1691		}
1692
1693		pr_debug2_peo("\nsys_perf_event_open failed, error %d\n", -ENOTSUP);
1694		evsel->core.attr.precise_ip--;
1695		pr_debug2_peo("decreasing precise_ip by one (%d)\n", evsel->core.attr.precise_ip);
1696		display_attr(&evsel->core.attr);
1697	}
1698
1699	return fd;
1700}
1701
1702static int evsel__open_cpu(struct evsel *evsel, struct perf_cpu_map *cpus,
1703		struct perf_thread_map *threads,
1704		int start_cpu, int end_cpu)
1705{
1706	int cpu, thread, nthreads;
1707	unsigned long flags = PERF_FLAG_FD_CLOEXEC;
1708	int pid = -1, err, old_errno;
1709	enum { NO_CHANGE, SET_TO_MAX, INCREASED_MAX } set_rlimit = NO_CHANGE;
1710
1711	if ((perf_missing_features.write_backward && evsel->core.attr.write_backward) ||
1712	    (perf_missing_features.aux_output     && evsel->core.attr.aux_output))
1713		return -EINVAL;
1714
1715	if (cpus == NULL) {
1716		static struct perf_cpu_map *empty_cpu_map;
1717
1718		if (empty_cpu_map == NULL) {
1719			empty_cpu_map = perf_cpu_map__dummy_new();
1720			if (empty_cpu_map == NULL)
1721				return -ENOMEM;
1722		}
1723
1724		cpus = empty_cpu_map;
1725	}
1726
1727	if (threads == NULL) {
1728		static struct perf_thread_map *empty_thread_map;
1729
1730		if (empty_thread_map == NULL) {
1731			empty_thread_map = thread_map__new_by_tid(-1);
1732			if (empty_thread_map == NULL)
1733				return -ENOMEM;
1734		}
1735
1736		threads = empty_thread_map;
1737	}
1738
1739	if (evsel->core.system_wide)
1740		nthreads = 1;
1741	else
1742		nthreads = threads->nr;
1743
1744	if (evsel->core.fd == NULL &&
1745	    perf_evsel__alloc_fd(&evsel->core, cpus->nr, nthreads) < 0)
1746		return -ENOMEM;
1747
1748	if (evsel->cgrp) {
1749		flags |= PERF_FLAG_PID_CGROUP;
1750		pid = evsel->cgrp->fd;
1751	}
1752
1753fallback_missing_features:
1754	if (perf_missing_features.clockid_wrong)
1755		evsel->core.attr.clockid = CLOCK_MONOTONIC; /* should always work */
1756	if (perf_missing_features.clockid) {
1757		evsel->core.attr.use_clockid = 0;
1758		evsel->core.attr.clockid = 0;
1759	}
1760	if (perf_missing_features.cloexec)
1761		flags &= ~(unsigned long)PERF_FLAG_FD_CLOEXEC;
1762	if (perf_missing_features.mmap2)
1763		evsel->core.attr.mmap2 = 0;
1764	if (perf_missing_features.exclude_guest)
1765		evsel->core.attr.exclude_guest = evsel->core.attr.exclude_host = 0;
1766	if (perf_missing_features.lbr_flags)
1767		evsel->core.attr.branch_sample_type &= ~(PERF_SAMPLE_BRANCH_NO_FLAGS |
1768				     PERF_SAMPLE_BRANCH_NO_CYCLES);
1769	if (perf_missing_features.group_read && evsel->core.attr.inherit)
1770		evsel->core.attr.read_format &= ~(PERF_FORMAT_GROUP|PERF_FORMAT_ID);
1771	if (perf_missing_features.ksymbol)
1772		evsel->core.attr.ksymbol = 0;
1773	if (perf_missing_features.bpf)
1774		evsel->core.attr.bpf_event = 0;
1775	if (perf_missing_features.branch_hw_idx)
1776		evsel->core.attr.branch_sample_type &= ~PERF_SAMPLE_BRANCH_HW_INDEX;
1777retry_sample_id:
1778	if (perf_missing_features.sample_id_all)
1779		evsel->core.attr.sample_id_all = 0;
1780
1781	display_attr(&evsel->core.attr);
1782
1783	for (cpu = start_cpu; cpu < end_cpu; cpu++) {
1784
1785		for (thread = 0; thread < nthreads; thread++) {
1786			int fd, group_fd;
1787
1788			if (!evsel->cgrp && !evsel->core.system_wide)
1789				pid = perf_thread_map__pid(threads, thread);
1790
1791			group_fd = get_group_fd(evsel, cpu, thread);
1792retry_open:
1793			test_attr__ready();
1794
1795			fd = perf_event_open(evsel, pid, cpus->map[cpu],
1796					     group_fd, flags);
1797
1798			FD(evsel, cpu, thread) = fd;
1799
1800			if (unlikely(test_attr__enabled)) {
1801				test_attr__open(&evsel->core.attr, pid, cpus->map[cpu],
1802						fd, group_fd, flags);
1803			}
1804
1805			if (fd < 0) {
1806				err = -errno;
1807
1808				if (ignore_missing_thread(evsel, cpus->nr, cpu, threads, thread, err)) {
1809					/*
1810					 * We just removed 1 thread, so take a step
1811					 * back on thread index and lower the upper
1812					 * nthreads limit.
1813					 */
1814					nthreads--;
1815					thread--;
1816
1817					/* ... and pretend like nothing have happened. */
1818					err = 0;
1819					continue;
1820				}
1821
1822				pr_debug2_peo("\nsys_perf_event_open failed, error %d\n",
1823					  err);
1824				goto try_fallback;
1825			}
1826
1827			pr_debug2_peo(" = %d\n", fd);
1828
1829			if (evsel->bpf_fd >= 0) {
1830				int evt_fd = fd;
1831				int bpf_fd = evsel->bpf_fd;
1832
1833				err = ioctl(evt_fd,
1834					    PERF_EVENT_IOC_SET_BPF,
1835					    bpf_fd);
1836				if (err && errno != EEXIST) {
1837					pr_err("failed to attach bpf fd %d: %s\n",
1838					       bpf_fd, strerror(errno));
1839					err = -EINVAL;
1840					goto out_close;
1841				}
1842			}
1843
1844			set_rlimit = NO_CHANGE;
1845
1846			/*
1847			 * If we succeeded but had to kill clockid, fail and
1848			 * have evsel__open_strerror() print us a nice error.
1849			 */
1850			if (perf_missing_features.clockid ||
1851			    perf_missing_features.clockid_wrong) {
1852				err = -EINVAL;
1853				goto out_close;
1854			}
1855		}
1856	}
1857
1858	return 0;
1859
1860try_fallback:
1861	/*
1862	 * perf stat needs between 5 and 22 fds per CPU. When we run out
1863	 * of them try to increase the limits.
1864	 */
1865	if (err == -EMFILE && set_rlimit < INCREASED_MAX) {
1866		struct rlimit l;
1867
1868		old_errno = errno;
1869		if (getrlimit(RLIMIT_NOFILE, &l) == 0) {
1870			if (set_rlimit == NO_CHANGE)
1871				l.rlim_cur = l.rlim_max;
1872			else {
1873				l.rlim_cur = l.rlim_max + 1000;
1874				l.rlim_max = l.rlim_cur;
1875			}
1876			if (setrlimit(RLIMIT_NOFILE, &l) == 0) {
1877				set_rlimit++;
1878				errno = old_errno;
1879				goto retry_open;
1880			}
1881		}
1882		errno = old_errno;
1883	}
1884
1885	if (err != -EINVAL || cpu > 0 || thread > 0)
1886		goto out_close;
1887
1888	/*
1889	 * Must probe features in the order they were added to the
1890	 * perf_event_attr interface.
1891	 */
1892        if (!perf_missing_features.cgroup && evsel->core.attr.cgroup) {
1893		perf_missing_features.cgroup = true;
1894		pr_debug2_peo("Kernel has no cgroup sampling support, bailing out\n");
1895		goto out_close;
1896        } else if (!perf_missing_features.branch_hw_idx &&
1897	    (evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX)) {
1898		perf_missing_features.branch_hw_idx = true;
1899		pr_debug2("switching off branch HW index support\n");
1900		goto fallback_missing_features;
1901	} else if (!perf_missing_features.aux_output && evsel->core.attr.aux_output) {
1902		perf_missing_features.aux_output = true;
1903		pr_debug2_peo("Kernel has no attr.aux_output support, bailing out\n");
1904		goto out_close;
1905	} else if (!perf_missing_features.bpf && evsel->core.attr.bpf_event) {
1906		perf_missing_features.bpf = true;
1907		pr_debug2_peo("switching off bpf_event\n");
1908		goto fallback_missing_features;
1909	} else if (!perf_missing_features.ksymbol && evsel->core.attr.ksymbol) {
1910		perf_missing_features.ksymbol = true;
1911		pr_debug2_peo("switching off ksymbol\n");
1912		goto fallback_missing_features;
1913	} else if (!perf_missing_features.write_backward && evsel->core.attr.write_backward) {
1914		perf_missing_features.write_backward = true;
1915		pr_debug2_peo("switching off write_backward\n");
1916		goto out_close;
1917	} else if (!perf_missing_features.clockid_wrong && evsel->core.attr.use_clockid) {
1918		perf_missing_features.clockid_wrong = true;
1919		pr_debug2_peo("switching off clockid\n");
1920		goto fallback_missing_features;
1921	} else if (!perf_missing_features.clockid && evsel->core.attr.use_clockid) {
1922		perf_missing_features.clockid = true;
1923		pr_debug2_peo("switching off use_clockid\n");
1924		goto fallback_missing_features;
1925	} else if (!perf_missing_features.cloexec && (flags & PERF_FLAG_FD_CLOEXEC)) {
1926		perf_missing_features.cloexec = true;
1927		pr_debug2_peo("switching off cloexec flag\n");
1928		goto fallback_missing_features;
1929	} else if (!perf_missing_features.mmap2 && evsel->core.attr.mmap2) {
1930		perf_missing_features.mmap2 = true;
1931		pr_debug2_peo("switching off mmap2\n");
1932		goto fallback_missing_features;
1933	} else if (!perf_missing_features.exclude_guest &&
1934		   (evsel->core.attr.exclude_guest || evsel->core.attr.exclude_host)) {
1935		perf_missing_features.exclude_guest = true;
1936		pr_debug2_peo("switching off exclude_guest, exclude_host\n");
1937		goto fallback_missing_features;
1938	} else if (!perf_missing_features.sample_id_all) {
1939		perf_missing_features.sample_id_all = true;
1940		pr_debug2_peo("switching off sample_id_all\n");
1941		goto retry_sample_id;
1942	} else if (!perf_missing_features.lbr_flags &&
1943			(evsel->core.attr.branch_sample_type &
1944			 (PERF_SAMPLE_BRANCH_NO_CYCLES |
1945			  PERF_SAMPLE_BRANCH_NO_FLAGS))) {
1946		perf_missing_features.lbr_flags = true;
1947		pr_debug2_peo("switching off branch sample type no (cycles/flags)\n");
1948		goto fallback_missing_features;
1949	} else if (!perf_missing_features.group_read &&
1950		    evsel->core.attr.inherit &&
1951		   (evsel->core.attr.read_format & PERF_FORMAT_GROUP) &&
1952		   evsel__is_group_leader(evsel)) {
1953		perf_missing_features.group_read = true;
1954		pr_debug2_peo("switching off group read\n");
1955		goto fallback_missing_features;
1956	}
1957out_close:
1958	if (err)
1959		threads->err_thread = thread;
1960
1961	old_errno = errno;
1962	do {
1963		while (--thread >= 0) {
1964			if (FD(evsel, cpu, thread) >= 0)
1965				close(FD(evsel, cpu, thread));
1966			FD(evsel, cpu, thread) = -1;
1967		}
1968		thread = nthreads;
1969	} while (--cpu >= 0);
1970	errno = old_errno;
1971	return err;
1972}
1973
1974int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
1975		struct perf_thread_map *threads)
1976{
1977	return evsel__open_cpu(evsel, cpus, threads, 0, cpus ? cpus->nr : 1);
1978}
1979
1980void evsel__close(struct evsel *evsel)
1981{
1982	perf_evsel__close(&evsel->core);
1983	perf_evsel__free_id(&evsel->core);
1984}
1985
1986int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu)
1987{
1988	if (cpu == -1)
1989		return evsel__open_cpu(evsel, cpus, NULL, 0,
1990					cpus ? cpus->nr : 1);
1991
1992	return evsel__open_cpu(evsel, cpus, NULL, cpu, cpu + 1);
1993}
1994
1995int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads)
1996{
1997	return evsel__open(evsel, NULL, threads);
1998}
1999
2000static int perf_evsel__parse_id_sample(const struct evsel *evsel,
2001				       const union perf_event *event,
2002				       struct perf_sample *sample)
2003{
2004	u64 type = evsel->core.attr.sample_type;
2005	const __u64 *array = event->sample.array;
2006	bool swapped = evsel->needs_swap;
2007	union u64_swap u;
2008
2009	array += ((event->header.size -
2010		   sizeof(event->header)) / sizeof(u64)) - 1;
2011
2012	if (type & PERF_SAMPLE_IDENTIFIER) {
2013		sample->id = *array;
2014		array--;
2015	}
2016
2017	if (type & PERF_SAMPLE_CPU) {
2018		u.val64 = *array;
2019		if (swapped) {
2020			/* undo swap of u64, then swap on individual u32s */
2021			u.val64 = bswap_64(u.val64);
2022			u.val32[0] = bswap_32(u.val32[0]);
2023		}
2024
2025		sample->cpu = u.val32[0];
2026		array--;
2027	}
2028
2029	if (type & PERF_SAMPLE_STREAM_ID) {
2030		sample->stream_id = *array;
2031		array--;
2032	}
2033
2034	if (type & PERF_SAMPLE_ID) {
2035		sample->id = *array;
2036		array--;
2037	}
2038
2039	if (type & PERF_SAMPLE_TIME) {
2040		sample->time = *array;
2041		array--;
2042	}
2043
2044	if (type & PERF_SAMPLE_TID) {
2045		u.val64 = *array;
2046		if (swapped) {
2047			/* undo swap of u64, then swap on individual u32s */
2048			u.val64 = bswap_64(u.val64);
2049			u.val32[0] = bswap_32(u.val32[0]);
2050			u.val32[1] = bswap_32(u.val32[1]);
2051		}
2052
2053		sample->pid = u.val32[0];
2054		sample->tid = u.val32[1];
2055		array--;
2056	}
2057
2058	return 0;
2059}
2060
2061static inline bool overflow(const void *endp, u16 max_size, const void *offset,
2062			    u64 size)
2063{
2064	return size > max_size || offset + size > endp;
2065}
2066
2067#define OVERFLOW_CHECK(offset, size, max_size)				\
2068	do {								\
2069		if (overflow(endp, (max_size), (offset), (size)))	\
2070			return -EFAULT;					\
2071	} while (0)
2072
2073#define OVERFLOW_CHECK_u64(offset) \
2074	OVERFLOW_CHECK(offset, sizeof(u64), sizeof(u64))
2075
2076static int
2077perf_event__check_size(union perf_event *event, unsigned int sample_size)
2078{
2079	/*
2080	 * The evsel's sample_size is based on PERF_SAMPLE_MASK which includes
2081	 * up to PERF_SAMPLE_PERIOD.  After that overflow() must be used to
2082	 * check the format does not go past the end of the event.
2083	 */
2084	if (sample_size + sizeof(event->header) > event->header.size)
2085		return -EFAULT;
2086
2087	return 0;
2088}
2089
2090int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
2091			struct perf_sample *data)
2092{
2093	u64 type = evsel->core.attr.sample_type;
2094	bool swapped = evsel->needs_swap;
2095	const __u64 *array;
2096	u16 max_size = event->header.size;
2097	const void *endp = (void *)event + max_size;
2098	u64 sz;
2099
2100	/*
2101	 * used for cross-endian analysis. See git commit 65014ab3
2102	 * for why this goofiness is needed.
2103	 */
2104	union u64_swap u;
2105
2106	memset(data, 0, sizeof(*data));
2107	data->cpu = data->pid = data->tid = -1;
2108	data->stream_id = data->id = data->time = -1ULL;
2109	data->period = evsel->core.attr.sample_period;
2110	data->cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
2111	data->misc    = event->header.misc;
2112	data->id = -1ULL;
2113	data->data_src = PERF_MEM_DATA_SRC_NONE;
2114
2115	if (event->header.type != PERF_RECORD_SAMPLE) {
2116		if (!evsel->core.attr.sample_id_all)
2117			return 0;
2118		return perf_evsel__parse_id_sample(evsel, event, data);
2119	}
2120
2121	array = event->sample.array;
2122
2123	if (perf_event__check_size(event, evsel->sample_size))
2124		return -EFAULT;
2125
2126	if (type & PERF_SAMPLE_IDENTIFIER) {
2127		data->id = *array;
2128		array++;
2129	}
2130
2131	if (type & PERF_SAMPLE_IP) {
2132		data->ip = *array;
2133		array++;
2134	}
2135
2136	if (type & PERF_SAMPLE_TID) {
2137		u.val64 = *array;
2138		if (swapped) {
2139			/* undo swap of u64, then swap on individual u32s */
2140			u.val64 = bswap_64(u.val64);
2141			u.val32[0] = bswap_32(u.val32[0]);
2142			u.val32[1] = bswap_32(u.val32[1]);
2143		}
2144
2145		data->pid = u.val32[0];
2146		data->tid = u.val32[1];
2147		array++;
2148	}
2149
2150	if (type & PERF_SAMPLE_TIME) {
2151		data->time = *array;
2152		array++;
2153	}
2154
2155	if (type & PERF_SAMPLE_ADDR) {
2156		data->addr = *array;
2157		array++;
2158	}
2159
2160	if (type & PERF_SAMPLE_ID) {
2161		data->id = *array;
2162		array++;
2163	}
2164
2165	if (type & PERF_SAMPLE_STREAM_ID) {
2166		data->stream_id = *array;
2167		array++;
2168	}
2169
2170	if (type & PERF_SAMPLE_CPU) {
2171
2172		u.val64 = *array;
2173		if (swapped) {
2174			/* undo swap of u64, then swap on individual u32s */
2175			u.val64 = bswap_64(u.val64);
2176			u.val32[0] = bswap_32(u.val32[0]);
2177		}
2178
2179		data->cpu = u.val32[0];
2180		array++;
2181	}
2182
2183	if (type & PERF_SAMPLE_PERIOD) {
2184		data->period = *array;
2185		array++;
2186	}
2187
2188	if (type & PERF_SAMPLE_READ) {
2189		u64 read_format = evsel->core.attr.read_format;
2190
2191		OVERFLOW_CHECK_u64(array);
2192		if (read_format & PERF_FORMAT_GROUP)
2193			data->read.group.nr = *array;
2194		else
2195			data->read.one.value = *array;
2196
2197		array++;
2198
2199		if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED) {
2200			OVERFLOW_CHECK_u64(array);
2201			data->read.time_enabled = *array;
2202			array++;
2203		}
2204
2205		if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING) {
2206			OVERFLOW_CHECK_u64(array);
2207			data->read.time_running = *array;
2208			array++;
2209		}
2210
2211		/* PERF_FORMAT_ID is forced for PERF_SAMPLE_READ */
2212		if (read_format & PERF_FORMAT_GROUP) {
2213			const u64 max_group_nr = UINT64_MAX /
2214					sizeof(struct sample_read_value);
2215
2216			if (data->read.group.nr > max_group_nr)
2217				return -EFAULT;
2218			sz = data->read.group.nr *
2219			     sizeof(struct sample_read_value);
2220			OVERFLOW_CHECK(array, sz, max_size);
2221			data->read.group.values =
2222					(struct sample_read_value *)array;
2223			array = (void *)array + sz;
2224		} else {
2225			OVERFLOW_CHECK_u64(array);
2226			data->read.one.id = *array;
2227			array++;
2228		}
2229	}
2230
2231	if (type & PERF_SAMPLE_CALLCHAIN) {
2232		const u64 max_callchain_nr = UINT64_MAX / sizeof(u64);
2233
2234		OVERFLOW_CHECK_u64(array);
2235		data->callchain = (struct ip_callchain *)array++;
2236		if (data->callchain->nr > max_callchain_nr)
2237			return -EFAULT;
2238		sz = data->callchain->nr * sizeof(u64);
2239		OVERFLOW_CHECK(array, sz, max_size);
2240		array = (void *)array + sz;
2241	}
2242
2243	if (type & PERF_SAMPLE_RAW) {
2244		OVERFLOW_CHECK_u64(array);
2245		u.val64 = *array;
2246
2247		/*
2248		 * Undo swap of u64, then swap on individual u32s,
2249		 * get the size of the raw area and undo all of the
2250		 * swap. The pevent interface handles endianity by
2251		 * itself.
2252		 */
2253		if (swapped) {
2254			u.val64 = bswap_64(u.val64);
2255			u.val32[0] = bswap_32(u.val32[0]);
2256			u.val32[1] = bswap_32(u.val32[1]);
2257		}
2258		data->raw_size = u.val32[0];
2259
2260		/*
2261		 * The raw data is aligned on 64bits including the
2262		 * u32 size, so it's safe to use mem_bswap_64.
2263		 */
2264		if (swapped)
2265			mem_bswap_64((void *) array, data->raw_size);
2266
2267		array = (void *)array + sizeof(u32);
2268
2269		OVERFLOW_CHECK(array, data->raw_size, max_size);
2270		data->raw_data = (void *)array;
2271		array = (void *)array + data->raw_size;
2272	}
2273
2274	if (type & PERF_SAMPLE_BRANCH_STACK) {
2275		const u64 max_branch_nr = UINT64_MAX /
2276					  sizeof(struct branch_entry);
2277
2278		OVERFLOW_CHECK_u64(array);
2279		data->branch_stack = (struct branch_stack *)array++;
2280
2281		if (data->branch_stack->nr > max_branch_nr)
2282			return -EFAULT;
2283
2284		sz = data->branch_stack->nr * sizeof(struct branch_entry);
2285		if (evsel__has_branch_hw_idx(evsel))
2286			sz += sizeof(u64);
2287		else
2288			data->no_hw_idx = true;
2289		OVERFLOW_CHECK(array, sz, max_size);
2290		array = (void *)array + sz;
2291	}
2292
2293	if (type & PERF_SAMPLE_REGS_USER) {
2294		OVERFLOW_CHECK_u64(array);
2295		data->user_regs.abi = *array;
2296		array++;
2297
2298		if (data->user_regs.abi) {
2299			u64 mask = evsel->core.attr.sample_regs_user;
2300
2301			sz = hweight64(mask) * sizeof(u64);
2302			OVERFLOW_CHECK(array, sz, max_size);
2303			data->user_regs.mask = mask;
2304			data->user_regs.regs = (u64 *)array;
2305			array = (void *)array + sz;
2306		}
2307	}
2308
2309	if (type & PERF_SAMPLE_STACK_USER) {
2310		OVERFLOW_CHECK_u64(array);
2311		sz = *array++;
2312
2313		data->user_stack.offset = ((char *)(array - 1)
2314					  - (char *) event);
2315
2316		if (!sz) {
2317			data->user_stack.size = 0;
2318		} else {
2319			OVERFLOW_CHECK(array, sz, max_size);
2320			data->user_stack.data = (char *)array;
2321			array = (void *)array + sz;
2322			OVERFLOW_CHECK_u64(array);
2323			data->user_stack.size = *array++;
2324			if (WARN_ONCE(data->user_stack.size > sz,
2325				      "user stack dump failure\n"))
2326				return -EFAULT;
2327		}
2328	}
2329
2330	if (type & PERF_SAMPLE_WEIGHT) {
2331		OVERFLOW_CHECK_u64(array);
2332		data->weight = *array;
2333		array++;
2334	}
2335
2336	if (type & PERF_SAMPLE_DATA_SRC) {
2337		OVERFLOW_CHECK_u64(array);
2338		data->data_src = *array;
2339		array++;
2340	}
2341
2342	if (type & PERF_SAMPLE_TRANSACTION) {
2343		OVERFLOW_CHECK_u64(array);
2344		data->transaction = *array;
2345		array++;
2346	}
2347
2348	data->intr_regs.abi = PERF_SAMPLE_REGS_ABI_NONE;
2349	if (type & PERF_SAMPLE_REGS_INTR) {
2350		OVERFLOW_CHECK_u64(array);
2351		data->intr_regs.abi = *array;
2352		array++;
2353
2354		if (data->intr_regs.abi != PERF_SAMPLE_REGS_ABI_NONE) {
2355			u64 mask = evsel->core.attr.sample_regs_intr;
2356
2357			sz = hweight64(mask) * sizeof(u64);
2358			OVERFLOW_CHECK(array, sz, max_size);
2359			data->intr_regs.mask = mask;
2360			data->intr_regs.regs = (u64 *)array;
2361			array = (void *)array + sz;
2362		}
2363	}
2364
2365	data->phys_addr = 0;
2366	if (type & PERF_SAMPLE_PHYS_ADDR) {
2367		data->phys_addr = *array;
2368		array++;
2369	}
2370
2371	data->cgroup = 0;
2372	if (type & PERF_SAMPLE_CGROUP) {
2373		data->cgroup = *array;
2374		array++;
2375	}
2376
2377	if (type & PERF_SAMPLE_AUX) {
2378		OVERFLOW_CHECK_u64(array);
2379		sz = *array++;
2380
2381		OVERFLOW_CHECK(array, sz, max_size);
2382		/* Undo swap of data */
2383		if (swapped)
2384			mem_bswap_64((char *)array, sz);
2385		data->aux_sample.size = sz;
2386		data->aux_sample.data = (char *)array;
2387		array = (void *)array + sz;
2388	}
2389
2390	return 0;
2391}
2392
2393int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
2394				  u64 *timestamp)
2395{
2396	u64 type = evsel->core.attr.sample_type;
2397	const __u64 *array;
2398
2399	if (!(type & PERF_SAMPLE_TIME))
2400		return -1;
2401
2402	if (event->header.type != PERF_RECORD_SAMPLE) {
2403		struct perf_sample data = {
2404			.time = -1ULL,
2405		};
2406
2407		if (!evsel->core.attr.sample_id_all)
2408			return -1;
2409		if (perf_evsel__parse_id_sample(evsel, event, &data))
2410			return -1;
2411
2412		*timestamp = data.time;
2413		return 0;
2414	}
2415
2416	array = event->sample.array;
2417
2418	if (perf_event__check_size(event, evsel->sample_size))
2419		return -EFAULT;
2420
2421	if (type & PERF_SAMPLE_IDENTIFIER)
2422		array++;
2423
2424	if (type & PERF_SAMPLE_IP)
2425		array++;
2426
2427	if (type & PERF_SAMPLE_TID)
2428		array++;
2429
2430	if (type & PERF_SAMPLE_TIME)
2431		*timestamp = *array;
2432
2433	return 0;
2434}
2435
2436struct tep_format_field *evsel__field(struct evsel *evsel, const char *name)
2437{
2438	return tep_find_field(evsel->tp_format, name);
2439}
2440
2441void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name)
2442{
2443	struct tep_format_field *field = evsel__field(evsel, name);
2444	int offset;
2445
2446	if (!field)
2447		return NULL;
2448
2449	offset = field->offset;
2450
2451	if (field->flags & TEP_FIELD_IS_DYNAMIC) {
2452		offset = *(int *)(sample->raw_data + field->offset);
2453		offset &= 0xffff;
2454	}
2455
2456	return sample->raw_data + offset;
2457}
2458
2459u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample,
2460			 bool needs_swap)
2461{
2462	u64 value;
2463	void *ptr = sample->raw_data + field->offset;
2464
2465	switch (field->size) {
2466	case 1:
2467		return *(u8 *)ptr;
2468	case 2:
2469		value = *(u16 *)ptr;
2470		break;
2471	case 4:
2472		value = *(u32 *)ptr;
2473		break;
2474	case 8:
2475		memcpy(&value, ptr, sizeof(u64));
2476		break;
2477	default:
2478		return 0;
2479	}
2480
2481	if (!needs_swap)
2482		return value;
2483
2484	switch (field->size) {
2485	case 2:
2486		return bswap_16(value);
2487	case 4:
2488		return bswap_32(value);
2489	case 8:
2490		return bswap_64(value);
2491	default:
2492		return 0;
2493	}
2494
2495	return 0;
2496}
2497
2498u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name)
2499{
2500	struct tep_format_field *field = evsel__field(evsel, name);
2501
2502	if (!field)
2503		return 0;
2504
2505	return field ? format_field__intval(field, sample, evsel->needs_swap) : 0;
2506}
2507
2508bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize)
2509{
2510	int paranoid;
2511
2512	if ((err == ENOENT || err == ENXIO || err == ENODEV) &&
2513	    evsel->core.attr.type   == PERF_TYPE_HARDWARE &&
2514	    evsel->core.attr.config == PERF_COUNT_HW_CPU_CYCLES) {
2515		/*
2516		 * If it's cycles then fall back to hrtimer based
2517		 * cpu-clock-tick sw counter, which is always available even if
2518		 * no PMU support.
2519		 *
2520		 * PPC returns ENXIO until 2.6.37 (behavior changed with commit
2521		 * b0a873e).
2522		 */
2523		scnprintf(msg, msgsize, "%s",
2524"The cycles event is not supported, trying to fall back to cpu-clock-ticks");
2525
2526		evsel->core.attr.type   = PERF_TYPE_SOFTWARE;
2527		evsel->core.attr.config = PERF_COUNT_SW_CPU_CLOCK;
2528
2529		zfree(&evsel->name);
2530		return true;
2531	} else if (err == EACCES && !evsel->core.attr.exclude_kernel &&
2532		   (paranoid = perf_event_paranoid()) > 1) {
2533		const char *name = evsel__name(evsel);
2534		char *new_name;
2535		const char *sep = ":";
2536
2537		/* If event has exclude user then don't exclude kernel. */
2538		if (evsel->core.attr.exclude_user)
2539			return false;
2540
2541		/* Is there already the separator in the name. */
2542		if (strchr(name, '/') ||
2543		    (strchr(name, ':') && !evsel->is_libpfm_event))
2544			sep = "";
2545
2546		if (asprintf(&new_name, "%s%su", name, sep) < 0)
2547			return false;
2548
2549		if (evsel->name)
2550			free(evsel->name);
2551		evsel->name = new_name;
2552		scnprintf(msg, msgsize, "kernel.perf_event_paranoid=%d, trying "
2553			  "to fall back to excluding kernel and hypervisor "
2554			  " samples", paranoid);
2555		evsel->core.attr.exclude_kernel = 1;
2556		evsel->core.attr.exclude_hv     = 1;
2557
2558		return true;
2559	}
2560
2561	return false;
2562}
2563
2564static bool find_process(const char *name)
2565{
2566	size_t len = strlen(name);
2567	DIR *dir;
2568	struct dirent *d;
2569	int ret = -1;
2570
2571	dir = opendir(procfs__mountpoint());
2572	if (!dir)
2573		return false;
2574
2575	/* Walk through the directory. */
2576	while (ret && (d = readdir(dir)) != NULL) {
2577		char path[PATH_MAX];
2578		char *data;
2579		size_t size;
2580
2581		if ((d->d_type != DT_DIR) ||
2582		     !strcmp(".", d->d_name) ||
2583		     !strcmp("..", d->d_name))
2584			continue;
2585
2586		scnprintf(path, sizeof(path), "%s/%s/comm",
2587			  procfs__mountpoint(), d->d_name);
2588
2589		if (filename__read_str(path, &data, &size))
2590			continue;
2591
2592		ret = strncmp(name, data, len);
2593		free(data);
2594	}
2595
2596	closedir(dir);
2597	return ret ? false : true;
2598}
2599
2600int evsel__open_strerror(struct evsel *evsel, struct target *target,
2601			 int err, char *msg, size_t size)
2602{
2603	char sbuf[STRERR_BUFSIZE];
2604	int printed = 0, enforced = 0;
2605
2606	switch (err) {
2607	case EPERM:
2608	case EACCES:
2609		printed += scnprintf(msg + printed, size - printed,
2610			"Access to performance monitoring and observability operations is limited.\n");
2611
2612		if (!sysfs__read_int("fs/selinux/enforce", &enforced)) {
2613			if (enforced) {
2614				printed += scnprintf(msg + printed, size - printed,
2615					"Enforced MAC policy settings (SELinux) can limit access to performance\n"
2616					"monitoring and observability operations. Inspect system audit records for\n"
2617					"more perf_event access control information and adjusting the policy.\n");
2618			}
2619		}
2620
2621		if (err == EPERM)
2622			printed += scnprintf(msg, size,
2623				"No permission to enable %s event.\n\n", evsel__name(evsel));
2624
2625		return scnprintf(msg + printed, size - printed,
2626		 "Consider adjusting /proc/sys/kernel/perf_event_paranoid setting to open\n"
2627		 "access to performance monitoring and observability operations for processes\n"
2628		 "without CAP_PERFMON, CAP_SYS_PTRACE or CAP_SYS_ADMIN Linux capability.\n"
2629		 "More information can be found at 'Perf events and tool security' document:\n"
2630		 "https://www.kernel.org/doc/html/latest/admin-guide/perf-security.html\n"
2631		 "perf_event_paranoid setting is %d:\n"
2632		 "  -1: Allow use of (almost) all events by all users\n"
2633		 "      Ignore mlock limit after perf_event_mlock_kb without CAP_IPC_LOCK\n"
2634		 ">= 0: Disallow raw and ftrace function tracepoint access\n"
2635		 ">= 1: Disallow CPU event access\n"
2636		 ">= 2: Disallow kernel profiling\n"
2637		 "To make the adjusted perf_event_paranoid setting permanent preserve it\n"
2638		 "in /etc/sysctl.conf (e.g. kernel.perf_event_paranoid = <setting>)",
2639		 perf_event_paranoid());
2640	case ENOENT:
2641		return scnprintf(msg, size, "The %s event is not supported.", evsel__name(evsel));
2642	case EMFILE:
2643		return scnprintf(msg, size, "%s",
2644			 "Too many events are opened.\n"
2645			 "Probably the maximum number of open file descriptors has been reached.\n"
2646			 "Hint: Try again after reducing the number of events.\n"
2647			 "Hint: Try increasing the limit with 'ulimit -n <limit>'");
2648	case ENOMEM:
2649		if (evsel__has_callchain(evsel) &&
2650		    access("/proc/sys/kernel/perf_event_max_stack", F_OK) == 0)
2651			return scnprintf(msg, size,
2652					 "Not enough memory to setup event with callchain.\n"
2653					 "Hint: Try tweaking /proc/sys/kernel/perf_event_max_stack\n"
2654					 "Hint: Current value: %d", sysctl__max_stack());
2655		break;
2656	case ENODEV:
2657		if (target->cpu_list)
2658			return scnprintf(msg, size, "%s",
2659	 "No such device - did you specify an out-of-range profile CPU?");
2660		break;
2661	case EOPNOTSUPP:
2662		if (evsel->core.attr.aux_output)
2663			return scnprintf(msg, size,
2664	"%s: PMU Hardware doesn't support 'aux_output' feature",
2665					 evsel__name(evsel));
2666		if (evsel->core.attr.sample_period != 0)
2667			return scnprintf(msg, size,
2668	"%s: PMU Hardware doesn't support sampling/overflow-interrupts. Try 'perf stat'",
2669					 evsel__name(evsel));
2670		if (evsel->core.attr.precise_ip)
2671			return scnprintf(msg, size, "%s",
2672	"\'precise\' request may not be supported. Try removing 'p' modifier.");
2673#if defined(__i386__) || defined(__x86_64__)
2674		if (evsel->core.attr.type == PERF_TYPE_HARDWARE)
2675			return scnprintf(msg, size, "%s",
2676	"No hardware sampling interrupt available.\n");
2677#endif
2678		break;
2679	case EBUSY:
2680		if (find_process("oprofiled"))
2681			return scnprintf(msg, size,
2682	"The PMU counters are busy/taken by another profiler.\n"
2683	"We found oprofile daemon running, please stop it and try again.");
2684		break;
2685	case EINVAL:
2686		if (evsel->core.attr.write_backward && perf_missing_features.write_backward)
2687			return scnprintf(msg, size, "Reading from overwrite event is not supported by this kernel.");
2688		if (perf_missing_features.clockid)
2689			return scnprintf(msg, size, "clockid feature not supported.");
2690		if (perf_missing_features.clockid_wrong)
2691			return scnprintf(msg, size, "wrong clockid (%d).", clockid);
2692		if (perf_missing_features.aux_output)
2693			return scnprintf(msg, size, "The 'aux_output' feature is not supported, update the kernel.");
2694		break;
2695	default:
2696		break;
2697	}
2698
2699	return scnprintf(msg, size,
2700	"The sys_perf_event_open() syscall returned with %d (%s) for event (%s).\n"
2701	"/bin/dmesg | grep -i perf may provide additional information.\n",
2702			 err, str_error_r(err, sbuf, sizeof(sbuf)), evsel__name(evsel));
2703}
2704
2705struct perf_env *evsel__env(struct evsel *evsel)
2706{
2707	if (evsel && evsel->evlist)
2708		return evsel->evlist->env;
2709	return &perf_env;
2710}
2711
2712static int store_evsel_ids(struct evsel *evsel, struct evlist *evlist)
2713{
2714	int cpu, thread;
2715
2716	for (cpu = 0; cpu < xyarray__max_x(evsel->core.fd); cpu++) {
2717		for (thread = 0; thread < xyarray__max_y(evsel->core.fd);
2718		     thread++) {
2719			int fd = FD(evsel, cpu, thread);
2720
2721			if (perf_evlist__id_add_fd(&evlist->core, &evsel->core,
2722						   cpu, thread, fd) < 0)
2723				return -1;
2724		}
2725	}
2726
2727	return 0;
2728}
2729
2730int evsel__store_ids(struct evsel *evsel, struct evlist *evlist)
2731{
2732	struct perf_cpu_map *cpus = evsel->core.cpus;
2733	struct perf_thread_map *threads = evsel->core.threads;
2734
2735	if (perf_evsel__alloc_id(&evsel->core, cpus->nr, threads->nr))
2736		return -ENOMEM;
2737
2738	return store_evsel_ids(evsel, evlist);
2739}
2740