1 // SPDX-License-Identifier: GPL-2.0
2 #include <perf/evlist.h>
3 #include <perf/evsel.h>
4 #include <linux/bitops.h>
5 #include <linux/list.h>
6 #include <linux/hash.h>
8 #include <internal/evlist.h>
9 #include <internal/evsel.h>
10 #include <internal/xyarray.h>
11 #include <internal/mmap.h>
12 #include <internal/cpumap.h>
13 #include <internal/threadmap.h>
14 #include <internal/lib.h>
15 #include <linux/zalloc.h>
23 #include <perf/cpumap.h>
24 #include <perf/threadmap.h>
25 #include <api/fd/array.h>
28 void perf_evlist__init(struct perf_evlist *evlist)
30 INIT_LIST_HEAD(&evlist->entries);
31 evlist->nr_entries = 0;
32 fdarray__init(&evlist->pollfd, 64);
33 perf_evlist__reset_id_hash(evlist);
36 static void __perf_evlist__propagate_maps(struct perf_evlist *evlist,
37 struct perf_evsel *evsel)
39 if (evsel->system_wide) {
40 /* System wide: set the cpu map of the evsel to all online CPUs. */
41 perf_cpu_map__put(evsel->cpus);
42 evsel->cpus = perf_cpu_map__new(NULL);
43 } else if (evlist->has_user_cpus && evsel->is_pmu_core) {
45 * User requested CPUs on a core PMU, ensure the requested CPUs
46 * are valid by intersecting with those of the PMU.
48 perf_cpu_map__put(evsel->cpus);
49 evsel->cpus = perf_cpu_map__intersect(evlist->user_requested_cpus, evsel->own_cpus);
50 } else if (!evsel->own_cpus || evlist->has_user_cpus ||
51 (!evsel->requires_cpu && perf_cpu_map__has_any_cpu(evlist->user_requested_cpus))) {
53 * The PMU didn't specify a default cpu map, this isn't a core
54 * event and the user requested CPUs or the evlist user
55 * requested CPUs have the "any CPU" (aka dummy) CPU value. In
56 * which case use the user requested CPUs rather than the PMU
59 perf_cpu_map__put(evsel->cpus);
60 evsel->cpus = perf_cpu_map__get(evlist->user_requested_cpus);
61 } else if (evsel->cpus != evsel->own_cpus) {
63 * No user requested cpu map but the PMU cpu map doesn't match
64 * the evsel's. Reset it back to the PMU cpu map.
66 perf_cpu_map__put(evsel->cpus);
67 evsel->cpus = perf_cpu_map__get(evsel->own_cpus);
70 if (evsel->system_wide) {
71 perf_thread_map__put(evsel->threads);
72 evsel->threads = perf_thread_map__new_dummy();
74 perf_thread_map__put(evsel->threads);
75 evsel->threads = perf_thread_map__get(evlist->threads);
78 evlist->all_cpus = perf_cpu_map__merge(evlist->all_cpus, evsel->cpus);
81 static void perf_evlist__propagate_maps(struct perf_evlist *evlist)
83 struct perf_evsel *evsel;
85 evlist->needs_map_propagation = true;
87 perf_evlist__for_each_evsel(evlist, evsel)
88 __perf_evlist__propagate_maps(evlist, evsel);
91 void perf_evlist__add(struct perf_evlist *evlist,
92 struct perf_evsel *evsel)
94 evsel->idx = evlist->nr_entries;
95 list_add_tail(&evsel->node, &evlist->entries);
96 evlist->nr_entries += 1;
98 if (evlist->needs_map_propagation)
99 __perf_evlist__propagate_maps(evlist, evsel);
102 void perf_evlist__remove(struct perf_evlist *evlist,
103 struct perf_evsel *evsel)
105 list_del_init(&evsel->node);
106 evlist->nr_entries -= 1;
109 struct perf_evlist *perf_evlist__new(void)
111 struct perf_evlist *evlist = zalloc(sizeof(*evlist));
114 perf_evlist__init(evlist);
120 perf_evlist__next(struct perf_evlist *evlist, struct perf_evsel *prev)
122 struct perf_evsel *next;
125 next = list_first_entry(&evlist->entries,
129 next = list_next_entry(prev, node);
132 /* Empty list is noticed here so don't need checking on entry. */
133 if (&next->node == &evlist->entries)
139 static void perf_evlist__purge(struct perf_evlist *evlist)
141 struct perf_evsel *pos, *n;
143 perf_evlist__for_each_entry_safe(evlist, n, pos) {
144 list_del_init(&pos->node);
145 perf_evsel__delete(pos);
148 evlist->nr_entries = 0;
151 void perf_evlist__exit(struct perf_evlist *evlist)
153 perf_cpu_map__put(evlist->user_requested_cpus);
154 perf_cpu_map__put(evlist->all_cpus);
155 perf_thread_map__put(evlist->threads);
156 evlist->user_requested_cpus = NULL;
157 evlist->all_cpus = NULL;
158 evlist->threads = NULL;
159 fdarray__exit(&evlist->pollfd);
162 void perf_evlist__delete(struct perf_evlist *evlist)
167 perf_evlist__munmap(evlist);
168 perf_evlist__close(evlist);
169 perf_evlist__purge(evlist);
170 perf_evlist__exit(evlist);
174 void perf_evlist__set_maps(struct perf_evlist *evlist,
175 struct perf_cpu_map *cpus,
176 struct perf_thread_map *threads)
179 * Allow for the possibility that one or another of the maps isn't being
180 * changed i.e. don't put it. Note we are assuming the maps that are
181 * being applied are brand new and evlist is taking ownership of the
182 * original reference count of 1. If that is not the case it is up to
183 * the caller to increase the reference count.
185 if (cpus != evlist->user_requested_cpus) {
186 perf_cpu_map__put(evlist->user_requested_cpus);
187 evlist->user_requested_cpus = perf_cpu_map__get(cpus);
190 if (threads != evlist->threads) {
191 perf_thread_map__put(evlist->threads);
192 evlist->threads = perf_thread_map__get(threads);
195 perf_evlist__propagate_maps(evlist);
198 int perf_evlist__open(struct perf_evlist *evlist)
200 struct perf_evsel *evsel;
203 perf_evlist__for_each_entry(evlist, evsel) {
204 err = perf_evsel__open(evsel, evsel->cpus, evsel->threads);
212 perf_evlist__close(evlist);
216 void perf_evlist__close(struct perf_evlist *evlist)
218 struct perf_evsel *evsel;
220 perf_evlist__for_each_entry_reverse(evlist, evsel)
221 perf_evsel__close(evsel);
224 void perf_evlist__enable(struct perf_evlist *evlist)
226 struct perf_evsel *evsel;
228 perf_evlist__for_each_entry(evlist, evsel)
229 perf_evsel__enable(evsel);
232 void perf_evlist__disable(struct perf_evlist *evlist)
234 struct perf_evsel *evsel;
236 perf_evlist__for_each_entry(evlist, evsel)
237 perf_evsel__disable(evsel);
240 u64 perf_evlist__read_format(struct perf_evlist *evlist)
242 struct perf_evsel *first = perf_evlist__first(evlist);
244 return first->attr.read_format;
247 #define SID(e, x, y) xyarray__entry(e->sample_id, x, y)
249 static void perf_evlist__id_hash(struct perf_evlist *evlist,
250 struct perf_evsel *evsel,
251 int cpu, int thread, u64 id)
254 struct perf_sample_id *sid = SID(evsel, cpu, thread);
258 hash = hash_64(sid->id, PERF_EVLIST__HLIST_BITS);
259 hlist_add_head(&sid->node, &evlist->heads[hash]);
262 void perf_evlist__reset_id_hash(struct perf_evlist *evlist)
266 for (i = 0; i < PERF_EVLIST__HLIST_SIZE; ++i)
267 INIT_HLIST_HEAD(&evlist->heads[i]);
270 void perf_evlist__id_add(struct perf_evlist *evlist,
271 struct perf_evsel *evsel,
272 int cpu, int thread, u64 id)
274 perf_evlist__id_hash(evlist, evsel, cpu, thread, id);
275 evsel->id[evsel->ids++] = id;
278 int perf_evlist__id_add_fd(struct perf_evlist *evlist,
279 struct perf_evsel *evsel,
280 int cpu, int thread, int fd)
282 u64 read_data[4] = { 0, };
283 int id_idx = 1; /* The first entry is the counter value */
287 ret = ioctl(fd, PERF_EVENT_IOC_ID, &id);
294 /* Legacy way to get event id.. All hail to old kernels! */
297 * This way does not work with group format read, so bail
300 if (perf_evlist__read_format(evlist) & PERF_FORMAT_GROUP)
303 if (!(evsel->attr.read_format & PERF_FORMAT_ID) ||
304 read(fd, &read_data, sizeof(read_data)) == -1)
307 if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_ENABLED)
309 if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_RUNNING)
312 id = read_data[id_idx];
315 perf_evlist__id_add(evlist, evsel, cpu, thread, id);
319 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist)
321 int nr_cpus = perf_cpu_map__nr(evlist->all_cpus);
322 int nr_threads = perf_thread_map__nr(evlist->threads);
324 struct perf_evsel *evsel;
326 perf_evlist__for_each_entry(evlist, evsel) {
327 if (evsel->system_wide)
330 nfds += nr_cpus * nr_threads;
333 if (fdarray__available_entries(&evlist->pollfd) < nfds &&
334 fdarray__grow(&evlist->pollfd, nfds) < 0)
340 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd,
341 void *ptr, short revent, enum fdarray_flags flags)
343 int pos = fdarray__add(&evlist->pollfd, fd, revent | POLLERR | POLLHUP, flags);
346 evlist->pollfd.priv[pos].ptr = ptr;
347 fcntl(fd, F_SETFL, O_NONBLOCK);
353 static void perf_evlist__munmap_filtered(struct fdarray *fda, int fd,
354 void *arg __maybe_unused)
356 struct perf_mmap *map = fda->priv[fd].ptr;
362 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask)
364 return fdarray__filter(&evlist->pollfd, revents_and_mask,
365 perf_evlist__munmap_filtered, NULL);
368 int perf_evlist__poll(struct perf_evlist *evlist, int timeout)
370 return fdarray__poll(&evlist->pollfd, timeout);
373 static struct perf_mmap* perf_evlist__alloc_mmap(struct perf_evlist *evlist, bool overwrite)
376 struct perf_mmap *map;
378 map = zalloc(evlist->nr_mmaps * sizeof(struct perf_mmap));
382 for (i = 0; i < evlist->nr_mmaps; i++) {
383 struct perf_mmap *prev = i ? &map[i - 1] : NULL;
386 * When the perf_mmap() call is made we grab one refcount, plus
387 * one extra to let perf_mmap__consume() get the last
388 * events after all real references (perf_mmap__get()) are
391 * Each PERF_EVENT_IOC_SET_OUTPUT points to this mmap and
392 * thus does perf_mmap__get() on it.
394 perf_mmap__init(&map[i], prev, overwrite, NULL);
400 static void perf_evsel__set_sid_idx(struct perf_evsel *evsel, int idx, int cpu, int thread)
402 struct perf_sample_id *sid = SID(evsel, cpu, thread);
405 sid->cpu = perf_cpu_map__cpu(evsel->cpus, cpu);
406 sid->tid = perf_thread_map__pid(evsel->threads, thread);
409 static struct perf_mmap*
410 perf_evlist__mmap_cb_get(struct perf_evlist *evlist, bool overwrite, int idx)
412 struct perf_mmap *maps;
414 maps = overwrite ? evlist->mmap_ovw : evlist->mmap;
417 maps = perf_evlist__alloc_mmap(evlist, overwrite);
422 evlist->mmap_ovw = maps;
430 #define FD(e, x, y) (*(int *) xyarray__entry(e->fd, x, y))
433 perf_evlist__mmap_cb_mmap(struct perf_mmap *map, struct perf_mmap_param *mp,
434 int output, struct perf_cpu cpu)
436 return perf_mmap__mmap(map, mp, output, cpu);
439 static void perf_evlist__set_mmap_first(struct perf_evlist *evlist, struct perf_mmap *map,
443 evlist->mmap_ovw_first = map;
445 evlist->mmap_first = map;
449 mmap_per_evsel(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
450 int idx, struct perf_mmap_param *mp, int cpu_idx,
451 int thread, int *_output, int *_output_overwrite, int *nr_mmaps)
453 struct perf_cpu evlist_cpu = perf_cpu_map__cpu(evlist->all_cpus, cpu_idx);
454 struct perf_evsel *evsel;
457 perf_evlist__for_each_entry(evlist, evsel) {
458 bool overwrite = evsel->attr.write_backward;
459 enum fdarray_flags flgs;
460 struct perf_mmap *map;
461 int *output, fd, cpu;
463 if (evsel->system_wide && thread)
466 cpu = perf_cpu_map__idx(evsel->cpus, evlist_cpu);
470 map = ops->get(evlist, overwrite, idx);
475 mp->prot = PROT_READ;
476 output = _output_overwrite;
478 mp->prot = PROT_READ | PROT_WRITE;
482 fd = FD(evsel, cpu, thread);
488 * The last one will be done at perf_mmap__consume(), so that we
489 * make sure we don't prevent tools from consuming every last event in
492 * I.e. we can get the POLLHUP meaning that the fd doesn't exist
493 * anymore, but the last events for it are still in the ring buffer,
494 * waiting to be consumed.
496 * Tools can chose to ignore this at their own discretion, but the
497 * evlist layer can't just drop it when filtering events in
498 * perf_evlist__filter_pollfd().
500 refcount_set(&map->refcnt, 2);
503 ops->idx(evlist, evsel, mp, idx);
505 /* Debug message used by test scripts */
506 pr_debug("idx %d: mmapping fd %d\n", idx, *output);
507 if (ops->mmap(map, mp, *output, evlist_cpu) < 0)
513 perf_evlist__set_mmap_first(evlist, map, overwrite);
515 /* Debug message used by test scripts */
516 pr_debug("idx %d: set output fd %d -> %d\n", idx, fd, *output);
517 if (ioctl(fd, PERF_EVENT_IOC_SET_OUTPUT, *output) != 0)
523 revent = !overwrite ? POLLIN : 0;
525 flgs = evsel->system_wide ? fdarray_flag__nonfilterable : fdarray_flag__default;
526 if (perf_evlist__add_pollfd(evlist, fd, map, revent, flgs) < 0) {
531 if (evsel->attr.read_format & PERF_FORMAT_ID) {
532 if (perf_evlist__id_add_fd(evlist, evsel, cpu, thread,
535 perf_evsel__set_sid_idx(evsel, idx, cpu, thread);
543 mmap_per_thread(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
544 struct perf_mmap_param *mp)
546 int nr_threads = perf_thread_map__nr(evlist->threads);
547 int nr_cpus = perf_cpu_map__nr(evlist->all_cpus);
548 int cpu, thread, idx = 0;
551 pr_debug("%s: nr cpu values (may include -1) %d nr threads %d\n",
552 __func__, nr_cpus, nr_threads);
554 /* per-thread mmaps */
555 for (thread = 0; thread < nr_threads; thread++, idx++) {
557 int output_overwrite = -1;
559 if (mmap_per_evsel(evlist, ops, idx, mp, 0, thread, &output,
560 &output_overwrite, &nr_mmaps))
564 /* system-wide mmaps i.e. per-cpu */
565 for (cpu = 1; cpu < nr_cpus; cpu++, idx++) {
567 int output_overwrite = -1;
569 if (mmap_per_evsel(evlist, ops, idx, mp, cpu, 0, &output,
570 &output_overwrite, &nr_mmaps))
574 if (nr_mmaps != evlist->nr_mmaps)
575 pr_err("Miscounted nr_mmaps %d vs %d\n", nr_mmaps, evlist->nr_mmaps);
580 perf_evlist__munmap(evlist);
585 mmap_per_cpu(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
586 struct perf_mmap_param *mp)
588 int nr_threads = perf_thread_map__nr(evlist->threads);
589 int nr_cpus = perf_cpu_map__nr(evlist->all_cpus);
593 pr_debug("%s: nr cpu values %d nr threads %d\n", __func__, nr_cpus, nr_threads);
595 for (cpu = 0; cpu < nr_cpus; cpu++) {
597 int output_overwrite = -1;
599 for (thread = 0; thread < nr_threads; thread++) {
600 if (mmap_per_evsel(evlist, ops, cpu, mp, cpu,
601 thread, &output, &output_overwrite, &nr_mmaps))
606 if (nr_mmaps != evlist->nr_mmaps)
607 pr_err("Miscounted nr_mmaps %d vs %d\n", nr_mmaps, evlist->nr_mmaps);
612 perf_evlist__munmap(evlist);
616 static int perf_evlist__nr_mmaps(struct perf_evlist *evlist)
620 /* One for each CPU */
621 nr_mmaps = perf_cpu_map__nr(evlist->all_cpus);
622 if (perf_cpu_map__empty(evlist->all_cpus)) {
623 /* Plus one for each thread */
624 nr_mmaps += perf_thread_map__nr(evlist->threads);
625 /* Minus the per-thread CPU (-1) */
632 int perf_evlist__mmap_ops(struct perf_evlist *evlist,
633 struct perf_evlist_mmap_ops *ops,
634 struct perf_mmap_param *mp)
636 const struct perf_cpu_map *cpus = evlist->all_cpus;
637 struct perf_evsel *evsel;
639 if (!ops || !ops->get || !ops->mmap)
642 mp->mask = evlist->mmap_len - page_size - 1;
644 evlist->nr_mmaps = perf_evlist__nr_mmaps(evlist);
646 perf_evlist__for_each_entry(evlist, evsel) {
647 if ((evsel->attr.read_format & PERF_FORMAT_ID) &&
648 evsel->sample_id == NULL &&
649 perf_evsel__alloc_id(evsel, evsel->fd->max_x, evsel->fd->max_y) < 0)
653 if (evlist->pollfd.entries == NULL && perf_evlist__alloc_pollfd(evlist) < 0)
656 if (perf_cpu_map__empty(cpus))
657 return mmap_per_thread(evlist, ops, mp);
659 return mmap_per_cpu(evlist, ops, mp);
662 int perf_evlist__mmap(struct perf_evlist *evlist, int pages)
664 struct perf_mmap_param mp;
665 struct perf_evlist_mmap_ops ops = {
666 .get = perf_evlist__mmap_cb_get,
667 .mmap = perf_evlist__mmap_cb_mmap,
670 evlist->mmap_len = (pages + 1) * page_size;
672 return perf_evlist__mmap_ops(evlist, &ops, &mp);
675 void perf_evlist__munmap(struct perf_evlist *evlist)
680 for (i = 0; i < evlist->nr_mmaps; i++)
681 perf_mmap__munmap(&evlist->mmap[i]);
684 if (evlist->mmap_ovw) {
685 for (i = 0; i < evlist->nr_mmaps; i++)
686 perf_mmap__munmap(&evlist->mmap_ovw[i]);
689 zfree(&evlist->mmap);
690 zfree(&evlist->mmap_ovw);
694 perf_evlist__next_mmap(struct perf_evlist *evlist, struct perf_mmap *map,
700 return overwrite ? evlist->mmap_ovw_first : evlist->mmap_first;
703 void __perf_evlist__set_leader(struct list_head *list, struct perf_evsel *leader)
705 struct perf_evsel *evsel;
708 __perf_evlist__for_each_entry(list, evsel) {
709 evsel->leader = leader;
712 leader->nr_members = n;
715 void perf_evlist__set_leader(struct perf_evlist *evlist)
717 if (evlist->nr_entries) {
718 struct perf_evsel *first = list_entry(evlist->entries.next,
719 struct perf_evsel, node);
721 __perf_evlist__set_leader(&evlist->entries, first);
725 int perf_evlist__nr_groups(struct perf_evlist *evlist)
727 struct perf_evsel *evsel;
730 perf_evlist__for_each_evsel(evlist, evsel) {
732 * evsels by default have a nr_members of 1, and they are their
733 * own leader. If the nr_members is >1 then this is an
734 * indication of a group.
736 if (evsel->leader == evsel && evsel->nr_members > 1)