Loading...
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>
7#include <sys/ioctl.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>
16#include <stdlib.h>
17#include <errno.h>
18#include <unistd.h>
19#include <fcntl.h>
20#include <signal.h>
21#include <poll.h>
22#include <sys/mman.h>
23#include <perf/cpumap.h>
24#include <perf/threadmap.h>
25#include <api/fd/array.h>
26#include "internal.h"
27
28void perf_evlist__init(struct perf_evlist *evlist)
29{
30 INIT_LIST_HEAD(&evlist->entries);
31 evlist->nr_entries = 0;
32 fdarray__init(&evlist->pollfd, 64);
33 perf_evlist__reset_id_hash(evlist);
34}
35
36static void __perf_evlist__propagate_maps(struct perf_evlist *evlist,
37 struct perf_evsel *evsel)
38{
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_online_cpus();
43 } else if (evlist->has_user_cpus && evsel->is_pmu_core) {
44 /*
45 * User requested CPUs on a core PMU, ensure the requested CPUs
46 * are valid by intersecting with those of the PMU.
47 */
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))) {
52 /*
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
57 * ones.
58 */
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) {
62 /*
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.
65 */
66 perf_cpu_map__put(evsel->cpus);
67 evsel->cpus = perf_cpu_map__get(evsel->own_cpus);
68 }
69
70 if (evsel->system_wide) {
71 perf_thread_map__put(evsel->threads);
72 evsel->threads = perf_thread_map__new_dummy();
73 } else {
74 perf_thread_map__put(evsel->threads);
75 evsel->threads = perf_thread_map__get(evlist->threads);
76 }
77
78 evlist->all_cpus = perf_cpu_map__merge(evlist->all_cpus, evsel->cpus);
79}
80
81static void perf_evlist__propagate_maps(struct perf_evlist *evlist)
82{
83 struct perf_evsel *evsel;
84
85 evlist->needs_map_propagation = true;
86
87 perf_evlist__for_each_evsel(evlist, evsel)
88 __perf_evlist__propagate_maps(evlist, evsel);
89}
90
91void perf_evlist__add(struct perf_evlist *evlist,
92 struct perf_evsel *evsel)
93{
94 evsel->idx = evlist->nr_entries;
95 list_add_tail(&evsel->node, &evlist->entries);
96 evlist->nr_entries += 1;
97
98 if (evlist->needs_map_propagation)
99 __perf_evlist__propagate_maps(evlist, evsel);
100}
101
102void perf_evlist__remove(struct perf_evlist *evlist,
103 struct perf_evsel *evsel)
104{
105 list_del_init(&evsel->node);
106 evlist->nr_entries -= 1;
107}
108
109struct perf_evlist *perf_evlist__new(void)
110{
111 struct perf_evlist *evlist = zalloc(sizeof(*evlist));
112
113 if (evlist != NULL)
114 perf_evlist__init(evlist);
115
116 return evlist;
117}
118
119struct perf_evsel *
120perf_evlist__next(struct perf_evlist *evlist, struct perf_evsel *prev)
121{
122 struct perf_evsel *next;
123
124 if (!prev) {
125 next = list_first_entry(&evlist->entries,
126 struct perf_evsel,
127 node);
128 } else {
129 next = list_next_entry(prev, node);
130 }
131
132 /* Empty list is noticed here so don't need checking on entry. */
133 if (&next->node == &evlist->entries)
134 return NULL;
135
136 return next;
137}
138
139static void perf_evlist__purge(struct perf_evlist *evlist)
140{
141 struct perf_evsel *pos, *n;
142
143 perf_evlist__for_each_entry_safe(evlist, n, pos) {
144 list_del_init(&pos->node);
145 perf_evsel__delete(pos);
146 }
147
148 evlist->nr_entries = 0;
149}
150
151void perf_evlist__exit(struct perf_evlist *evlist)
152{
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);
160}
161
162void perf_evlist__delete(struct perf_evlist *evlist)
163{
164 if (evlist == NULL)
165 return;
166
167 perf_evlist__munmap(evlist);
168 perf_evlist__close(evlist);
169 perf_evlist__purge(evlist);
170 perf_evlist__exit(evlist);
171 free(evlist);
172}
173
174void perf_evlist__set_maps(struct perf_evlist *evlist,
175 struct perf_cpu_map *cpus,
176 struct perf_thread_map *threads)
177{
178 /*
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.
184 */
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);
188 }
189
190 if (threads != evlist->threads) {
191 perf_thread_map__put(evlist->threads);
192 evlist->threads = perf_thread_map__get(threads);
193 }
194
195 perf_evlist__propagate_maps(evlist);
196}
197
198int perf_evlist__open(struct perf_evlist *evlist)
199{
200 struct perf_evsel *evsel;
201 int err;
202
203 perf_evlist__for_each_entry(evlist, evsel) {
204 err = perf_evsel__open(evsel, evsel->cpus, evsel->threads);
205 if (err < 0)
206 goto out_err;
207 }
208
209 return 0;
210
211out_err:
212 perf_evlist__close(evlist);
213 return err;
214}
215
216void perf_evlist__close(struct perf_evlist *evlist)
217{
218 struct perf_evsel *evsel;
219
220 perf_evlist__for_each_entry_reverse(evlist, evsel)
221 perf_evsel__close(evsel);
222}
223
224void perf_evlist__enable(struct perf_evlist *evlist)
225{
226 struct perf_evsel *evsel;
227
228 perf_evlist__for_each_entry(evlist, evsel)
229 perf_evsel__enable(evsel);
230}
231
232void perf_evlist__disable(struct perf_evlist *evlist)
233{
234 struct perf_evsel *evsel;
235
236 perf_evlist__for_each_entry(evlist, evsel)
237 perf_evsel__disable(evsel);
238}
239
240u64 perf_evlist__read_format(struct perf_evlist *evlist)
241{
242 struct perf_evsel *first = perf_evlist__first(evlist);
243
244 return first->attr.read_format;
245}
246
247#define SID(e, x, y) xyarray__entry(e->sample_id, x, y)
248
249static void perf_evlist__id_hash(struct perf_evlist *evlist,
250 struct perf_evsel *evsel,
251 int cpu, int thread, u64 id)
252{
253 int hash;
254 struct perf_sample_id *sid = SID(evsel, cpu, thread);
255
256 sid->id = id;
257 sid->evsel = evsel;
258 hash = hash_64(sid->id, PERF_EVLIST__HLIST_BITS);
259 hlist_add_head(&sid->node, &evlist->heads[hash]);
260}
261
262void perf_evlist__reset_id_hash(struct perf_evlist *evlist)
263{
264 int i;
265
266 for (i = 0; i < PERF_EVLIST__HLIST_SIZE; ++i)
267 INIT_HLIST_HEAD(&evlist->heads[i]);
268}
269
270void perf_evlist__id_add(struct perf_evlist *evlist,
271 struct perf_evsel *evsel,
272 int cpu, int thread, u64 id)
273{
274 perf_evlist__id_hash(evlist, evsel, cpu, thread, id);
275 evsel->id[evsel->ids++] = id;
276}
277
278int perf_evlist__id_add_fd(struct perf_evlist *evlist,
279 struct perf_evsel *evsel,
280 int cpu, int thread, int fd)
281{
282 u64 read_data[4] = { 0, };
283 int id_idx = 1; /* The first entry is the counter value */
284 u64 id;
285 int ret;
286
287 ret = ioctl(fd, PERF_EVENT_IOC_ID, &id);
288 if (!ret)
289 goto add;
290
291 if (errno != ENOTTY)
292 return -1;
293
294 /* Legacy way to get event id.. All hail to old kernels! */
295
296 /*
297 * This way does not work with group format read, so bail
298 * out in that case.
299 */
300 if (perf_evlist__read_format(evlist) & PERF_FORMAT_GROUP)
301 return -1;
302
303 if (!(evsel->attr.read_format & PERF_FORMAT_ID) ||
304 read(fd, &read_data, sizeof(read_data)) == -1)
305 return -1;
306
307 if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_ENABLED)
308 ++id_idx;
309 if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_RUNNING)
310 ++id_idx;
311
312 id = read_data[id_idx];
313
314add:
315 perf_evlist__id_add(evlist, evsel, cpu, thread, id);
316 return 0;
317}
318
319int perf_evlist__alloc_pollfd(struct perf_evlist *evlist)
320{
321 int nr_cpus = perf_cpu_map__nr(evlist->all_cpus);
322 int nr_threads = perf_thread_map__nr(evlist->threads);
323 int nfds = 0;
324 struct perf_evsel *evsel;
325
326 perf_evlist__for_each_entry(evlist, evsel) {
327 if (evsel->system_wide)
328 nfds += nr_cpus;
329 else
330 nfds += nr_cpus * nr_threads;
331 }
332
333 if (fdarray__available_entries(&evlist->pollfd) < nfds &&
334 fdarray__grow(&evlist->pollfd, nfds) < 0)
335 return -ENOMEM;
336
337 return 0;
338}
339
340int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd,
341 void *ptr, short revent, enum fdarray_flags flags)
342{
343 int pos = fdarray__add(&evlist->pollfd, fd, revent | POLLERR | POLLHUP, flags);
344
345 if (pos >= 0) {
346 evlist->pollfd.priv[pos].ptr = ptr;
347 fcntl(fd, F_SETFL, O_NONBLOCK);
348 }
349
350 return pos;
351}
352
353static void perf_evlist__munmap_filtered(struct fdarray *fda, int fd,
354 void *arg __maybe_unused)
355{
356 struct perf_mmap *map = fda->priv[fd].ptr;
357
358 if (map)
359 perf_mmap__put(map);
360}
361
362int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask)
363{
364 return fdarray__filter(&evlist->pollfd, revents_and_mask,
365 perf_evlist__munmap_filtered, NULL);
366}
367
368int perf_evlist__poll(struct perf_evlist *evlist, int timeout)
369{
370 return fdarray__poll(&evlist->pollfd, timeout);
371}
372
373static struct perf_mmap* perf_evlist__alloc_mmap(struct perf_evlist *evlist, bool overwrite)
374{
375 int i;
376 struct perf_mmap *map;
377
378 map = zalloc(evlist->nr_mmaps * sizeof(struct perf_mmap));
379 if (!map)
380 return NULL;
381
382 for (i = 0; i < evlist->nr_mmaps; i++) {
383 struct perf_mmap *prev = i ? &map[i - 1] : NULL;
384
385 /*
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
389 * dropped.
390 *
391 * Each PERF_EVENT_IOC_SET_OUTPUT points to this mmap and
392 * thus does perf_mmap__get() on it.
393 */
394 perf_mmap__init(&map[i], prev, overwrite, NULL);
395 }
396
397 return map;
398}
399
400static void perf_evsel__set_sid_idx(struct perf_evsel *evsel, int idx, int cpu, int thread)
401{
402 struct perf_sample_id *sid = SID(evsel, cpu, thread);
403
404 sid->idx = idx;
405 sid->cpu = perf_cpu_map__cpu(evsel->cpus, cpu);
406 sid->tid = perf_thread_map__pid(evsel->threads, thread);
407}
408
409static struct perf_mmap*
410perf_evlist__mmap_cb_get(struct perf_evlist *evlist, bool overwrite, int idx)
411{
412 struct perf_mmap *maps;
413
414 maps = overwrite ? evlist->mmap_ovw : evlist->mmap;
415
416 if (!maps) {
417 maps = perf_evlist__alloc_mmap(evlist, overwrite);
418 if (!maps)
419 return NULL;
420
421 if (overwrite)
422 evlist->mmap_ovw = maps;
423 else
424 evlist->mmap = maps;
425 }
426
427 return &maps[idx];
428}
429
430#define FD(e, x, y) (*(int *) xyarray__entry(e->fd, x, y))
431
432static int
433perf_evlist__mmap_cb_mmap(struct perf_mmap *map, struct perf_mmap_param *mp,
434 int output, struct perf_cpu cpu)
435{
436 return perf_mmap__mmap(map, mp, output, cpu);
437}
438
439static void perf_evlist__set_mmap_first(struct perf_evlist *evlist, struct perf_mmap *map,
440 bool overwrite)
441{
442 if (overwrite)
443 evlist->mmap_ovw_first = map;
444 else
445 evlist->mmap_first = map;
446}
447
448static int
449mmap_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)
452{
453 struct perf_cpu evlist_cpu = perf_cpu_map__cpu(evlist->all_cpus, cpu_idx);
454 struct perf_evsel *evsel;
455 int revent;
456
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;
462
463 if (evsel->system_wide && thread)
464 continue;
465
466 cpu = perf_cpu_map__idx(evsel->cpus, evlist_cpu);
467 if (cpu == -1)
468 continue;
469
470 map = ops->get(evlist, overwrite, idx);
471 if (map == NULL)
472 return -ENOMEM;
473
474 if (overwrite) {
475 mp->prot = PROT_READ;
476 output = _output_overwrite;
477 } else {
478 mp->prot = PROT_READ | PROT_WRITE;
479 output = _output;
480 }
481
482 fd = FD(evsel, cpu, thread);
483
484 if (*output == -1) {
485 *output = fd;
486
487 /*
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
490 * the ring buffer.
491 *
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.
495 *
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().
499 */
500 refcount_set(&map->refcnt, 2);
501
502 if (ops->idx)
503 ops->idx(evlist, evsel, mp, idx);
504
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)
508 return -1;
509
510 *nr_mmaps += 1;
511
512 if (!idx)
513 perf_evlist__set_mmap_first(evlist, map, overwrite);
514 } else {
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)
518 return -1;
519
520 perf_mmap__get(map);
521 }
522
523 revent = !overwrite ? POLLIN : 0;
524
525 flgs = evsel->system_wide ? fdarray_flag__nonfilterable : fdarray_flag__default;
526 if (perf_evlist__add_pollfd(evlist, fd, map, revent, flgs) < 0) {
527 perf_mmap__put(map);
528 return -1;
529 }
530
531 if (evsel->attr.read_format & PERF_FORMAT_ID) {
532 if (perf_evlist__id_add_fd(evlist, evsel, cpu, thread,
533 fd) < 0)
534 return -1;
535 perf_evsel__set_sid_idx(evsel, idx, cpu, thread);
536 }
537 }
538
539 return 0;
540}
541
542static int
543mmap_per_thread(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
544 struct perf_mmap_param *mp)
545{
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;
549 int nr_mmaps = 0;
550
551 pr_debug("%s: nr cpu values (may include -1) %d nr threads %d\n",
552 __func__, nr_cpus, nr_threads);
553
554 /* per-thread mmaps */
555 for (thread = 0; thread < nr_threads; thread++, idx++) {
556 int output = -1;
557 int output_overwrite = -1;
558
559 if (mmap_per_evsel(evlist, ops, idx, mp, 0, thread, &output,
560 &output_overwrite, &nr_mmaps))
561 goto out_unmap;
562 }
563
564 /* system-wide mmaps i.e. per-cpu */
565 for (cpu = 1; cpu < nr_cpus; cpu++, idx++) {
566 int output = -1;
567 int output_overwrite = -1;
568
569 if (mmap_per_evsel(evlist, ops, idx, mp, cpu, 0, &output,
570 &output_overwrite, &nr_mmaps))
571 goto out_unmap;
572 }
573
574 if (nr_mmaps != evlist->nr_mmaps)
575 pr_err("Miscounted nr_mmaps %d vs %d\n", nr_mmaps, evlist->nr_mmaps);
576
577 return 0;
578
579out_unmap:
580 perf_evlist__munmap(evlist);
581 return -1;
582}
583
584static int
585mmap_per_cpu(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
586 struct perf_mmap_param *mp)
587{
588 int nr_threads = perf_thread_map__nr(evlist->threads);
589 int nr_cpus = perf_cpu_map__nr(evlist->all_cpus);
590 int nr_mmaps = 0;
591 int cpu, thread;
592
593 pr_debug("%s: nr cpu values %d nr threads %d\n", __func__, nr_cpus, nr_threads);
594
595 for (cpu = 0; cpu < nr_cpus; cpu++) {
596 int output = -1;
597 int output_overwrite = -1;
598
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))
602 goto out_unmap;
603 }
604 }
605
606 if (nr_mmaps != evlist->nr_mmaps)
607 pr_err("Miscounted nr_mmaps %d vs %d\n", nr_mmaps, evlist->nr_mmaps);
608
609 return 0;
610
611out_unmap:
612 perf_evlist__munmap(evlist);
613 return -1;
614}
615
616static int perf_evlist__nr_mmaps(struct perf_evlist *evlist)
617{
618 int nr_mmaps;
619
620 /* One for each CPU */
621 nr_mmaps = perf_cpu_map__nr(evlist->all_cpus);
622 if (perf_cpu_map__has_any_cpu_or_is_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) */
626 nr_mmaps -= 1;
627 }
628
629 return nr_mmaps;
630}
631
632int perf_evlist__mmap_ops(struct perf_evlist *evlist,
633 struct perf_evlist_mmap_ops *ops,
634 struct perf_mmap_param *mp)
635{
636 const struct perf_cpu_map *cpus = evlist->all_cpus;
637 struct perf_evsel *evsel;
638
639 if (!ops || !ops->get || !ops->mmap)
640 return -EINVAL;
641
642 mp->mask = evlist->mmap_len - page_size - 1;
643
644 evlist->nr_mmaps = perf_evlist__nr_mmaps(evlist);
645
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)
650 return -ENOMEM;
651 }
652
653 if (evlist->pollfd.entries == NULL && perf_evlist__alloc_pollfd(evlist) < 0)
654 return -ENOMEM;
655
656 if (perf_cpu_map__has_any_cpu_or_is_empty(cpus))
657 return mmap_per_thread(evlist, ops, mp);
658
659 return mmap_per_cpu(evlist, ops, mp);
660}
661
662int perf_evlist__mmap(struct perf_evlist *evlist, int pages)
663{
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,
668 };
669
670 evlist->mmap_len = (pages + 1) * page_size;
671
672 return perf_evlist__mmap_ops(evlist, &ops, &mp);
673}
674
675void perf_evlist__munmap(struct perf_evlist *evlist)
676{
677 int i;
678
679 if (evlist->mmap) {
680 for (i = 0; i < evlist->nr_mmaps; i++)
681 perf_mmap__munmap(&evlist->mmap[i]);
682 }
683
684 if (evlist->mmap_ovw) {
685 for (i = 0; i < evlist->nr_mmaps; i++)
686 perf_mmap__munmap(&evlist->mmap_ovw[i]);
687 }
688
689 zfree(&evlist->mmap);
690 zfree(&evlist->mmap_ovw);
691}
692
693struct perf_mmap*
694perf_evlist__next_mmap(struct perf_evlist *evlist, struct perf_mmap *map,
695 bool overwrite)
696{
697 if (map)
698 return map->next;
699
700 return overwrite ? evlist->mmap_ovw_first : evlist->mmap_first;
701}
702
703void __perf_evlist__set_leader(struct list_head *list, struct perf_evsel *leader)
704{
705 struct perf_evsel *evsel;
706 int n = 0;
707
708 __perf_evlist__for_each_entry(list, evsel) {
709 evsel->leader = leader;
710 n++;
711 }
712 leader->nr_members = n;
713}
714
715void perf_evlist__set_leader(struct perf_evlist *evlist)
716{
717 if (evlist->nr_entries) {
718 struct perf_evsel *first = list_entry(evlist->entries.next,
719 struct perf_evsel, node);
720
721 __perf_evlist__set_leader(&evlist->entries, first);
722 }
723}
724
725int perf_evlist__nr_groups(struct perf_evlist *evlist)
726{
727 struct perf_evsel *evsel;
728 int nr_groups = 0;
729
730 perf_evlist__for_each_evsel(evlist, evsel) {
731 /*
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.
735 */
736 if (evsel->leader == evsel && evsel->nr_members > 1)
737 nr_groups++;
738 }
739 return nr_groups;
740}
741
742void perf_evlist__go_system_wide(struct perf_evlist *evlist, struct perf_evsel *evsel)
743{
744 if (!evsel->system_wide) {
745 evsel->system_wide = true;
746 if (evlist->needs_map_propagation)
747 __perf_evlist__propagate_maps(evlist, evsel);
748 }
749}
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>
7#include <sys/ioctl.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>
16#include <stdlib.h>
17#include <errno.h>
18#include <unistd.h>
19#include <fcntl.h>
20#include <signal.h>
21#include <poll.h>
22#include <sys/mman.h>
23#include <perf/cpumap.h>
24#include <perf/threadmap.h>
25#include <api/fd/array.h>
26
27void perf_evlist__init(struct perf_evlist *evlist)
28{
29 int i;
30
31 for (i = 0; i < PERF_EVLIST__HLIST_SIZE; ++i)
32 INIT_HLIST_HEAD(&evlist->heads[i]);
33 INIT_LIST_HEAD(&evlist->entries);
34 evlist->nr_entries = 0;
35 fdarray__init(&evlist->pollfd, 64);
36}
37
38static void __perf_evlist__propagate_maps(struct perf_evlist *evlist,
39 struct perf_evsel *evsel)
40{
41 /*
42 * We already have cpus for evsel (via PMU sysfs) so
43 * keep it, if there's no target cpu list defined.
44 */
45 if (!evsel->own_cpus || evlist->has_user_cpus) {
46 perf_cpu_map__put(evsel->cpus);
47 evsel->cpus = perf_cpu_map__get(evlist->cpus);
48 } else if (evsel->cpus != evsel->own_cpus) {
49 perf_cpu_map__put(evsel->cpus);
50 evsel->cpus = perf_cpu_map__get(evsel->own_cpus);
51 }
52
53 perf_thread_map__put(evsel->threads);
54 evsel->threads = perf_thread_map__get(evlist->threads);
55 evlist->all_cpus = perf_cpu_map__merge(evlist->all_cpus, evsel->cpus);
56}
57
58static void perf_evlist__propagate_maps(struct perf_evlist *evlist)
59{
60 struct perf_evsel *evsel;
61
62 perf_evlist__for_each_evsel(evlist, evsel)
63 __perf_evlist__propagate_maps(evlist, evsel);
64}
65
66void perf_evlist__add(struct perf_evlist *evlist,
67 struct perf_evsel *evsel)
68{
69 list_add_tail(&evsel->node, &evlist->entries);
70 evlist->nr_entries += 1;
71 __perf_evlist__propagate_maps(evlist, evsel);
72}
73
74void perf_evlist__remove(struct perf_evlist *evlist,
75 struct perf_evsel *evsel)
76{
77 list_del_init(&evsel->node);
78 evlist->nr_entries -= 1;
79}
80
81struct perf_evlist *perf_evlist__new(void)
82{
83 struct perf_evlist *evlist = zalloc(sizeof(*evlist));
84
85 if (evlist != NULL)
86 perf_evlist__init(evlist);
87
88 return evlist;
89}
90
91struct perf_evsel *
92perf_evlist__next(struct perf_evlist *evlist, struct perf_evsel *prev)
93{
94 struct perf_evsel *next;
95
96 if (!prev) {
97 next = list_first_entry(&evlist->entries,
98 struct perf_evsel,
99 node);
100 } else {
101 next = list_next_entry(prev, node);
102 }
103
104 /* Empty list is noticed here so don't need checking on entry. */
105 if (&next->node == &evlist->entries)
106 return NULL;
107
108 return next;
109}
110
111static void perf_evlist__purge(struct perf_evlist *evlist)
112{
113 struct perf_evsel *pos, *n;
114
115 perf_evlist__for_each_entry_safe(evlist, n, pos) {
116 list_del_init(&pos->node);
117 perf_evsel__delete(pos);
118 }
119
120 evlist->nr_entries = 0;
121}
122
123void perf_evlist__exit(struct perf_evlist *evlist)
124{
125 perf_cpu_map__put(evlist->cpus);
126 perf_cpu_map__put(evlist->all_cpus);
127 perf_thread_map__put(evlist->threads);
128 evlist->cpus = NULL;
129 evlist->all_cpus = NULL;
130 evlist->threads = NULL;
131 fdarray__exit(&evlist->pollfd);
132}
133
134void perf_evlist__delete(struct perf_evlist *evlist)
135{
136 if (evlist == NULL)
137 return;
138
139 perf_evlist__munmap(evlist);
140 perf_evlist__close(evlist);
141 perf_evlist__purge(evlist);
142 perf_evlist__exit(evlist);
143 free(evlist);
144}
145
146void perf_evlist__set_maps(struct perf_evlist *evlist,
147 struct perf_cpu_map *cpus,
148 struct perf_thread_map *threads)
149{
150 /*
151 * Allow for the possibility that one or another of the maps isn't being
152 * changed i.e. don't put it. Note we are assuming the maps that are
153 * being applied are brand new and evlist is taking ownership of the
154 * original reference count of 1. If that is not the case it is up to
155 * the caller to increase the reference count.
156 */
157 if (cpus != evlist->cpus) {
158 perf_cpu_map__put(evlist->cpus);
159 evlist->cpus = perf_cpu_map__get(cpus);
160 }
161
162 if (threads != evlist->threads) {
163 perf_thread_map__put(evlist->threads);
164 evlist->threads = perf_thread_map__get(threads);
165 }
166
167 if (!evlist->all_cpus && cpus)
168 evlist->all_cpus = perf_cpu_map__get(cpus);
169
170 perf_evlist__propagate_maps(evlist);
171}
172
173int perf_evlist__open(struct perf_evlist *evlist)
174{
175 struct perf_evsel *evsel;
176 int err;
177
178 perf_evlist__for_each_entry(evlist, evsel) {
179 err = perf_evsel__open(evsel, evsel->cpus, evsel->threads);
180 if (err < 0)
181 goto out_err;
182 }
183
184 return 0;
185
186out_err:
187 perf_evlist__close(evlist);
188 return err;
189}
190
191void perf_evlist__close(struct perf_evlist *evlist)
192{
193 struct perf_evsel *evsel;
194
195 perf_evlist__for_each_entry_reverse(evlist, evsel)
196 perf_evsel__close(evsel);
197}
198
199void perf_evlist__enable(struct perf_evlist *evlist)
200{
201 struct perf_evsel *evsel;
202
203 perf_evlist__for_each_entry(evlist, evsel)
204 perf_evsel__enable(evsel);
205}
206
207void perf_evlist__disable(struct perf_evlist *evlist)
208{
209 struct perf_evsel *evsel;
210
211 perf_evlist__for_each_entry(evlist, evsel)
212 perf_evsel__disable(evsel);
213}
214
215u64 perf_evlist__read_format(struct perf_evlist *evlist)
216{
217 struct perf_evsel *first = perf_evlist__first(evlist);
218
219 return first->attr.read_format;
220}
221
222#define SID(e, x, y) xyarray__entry(e->sample_id, x, y)
223
224static void perf_evlist__id_hash(struct perf_evlist *evlist,
225 struct perf_evsel *evsel,
226 int cpu, int thread, u64 id)
227{
228 int hash;
229 struct perf_sample_id *sid = SID(evsel, cpu, thread);
230
231 sid->id = id;
232 sid->evsel = evsel;
233 hash = hash_64(sid->id, PERF_EVLIST__HLIST_BITS);
234 hlist_add_head(&sid->node, &evlist->heads[hash]);
235}
236
237void perf_evlist__id_add(struct perf_evlist *evlist,
238 struct perf_evsel *evsel,
239 int cpu, int thread, u64 id)
240{
241 perf_evlist__id_hash(evlist, evsel, cpu, thread, id);
242 evsel->id[evsel->ids++] = id;
243}
244
245int perf_evlist__id_add_fd(struct perf_evlist *evlist,
246 struct perf_evsel *evsel,
247 int cpu, int thread, int fd)
248{
249 u64 read_data[4] = { 0, };
250 int id_idx = 1; /* The first entry is the counter value */
251 u64 id;
252 int ret;
253
254 ret = ioctl(fd, PERF_EVENT_IOC_ID, &id);
255 if (!ret)
256 goto add;
257
258 if (errno != ENOTTY)
259 return -1;
260
261 /* Legacy way to get event id.. All hail to old kernels! */
262
263 /*
264 * This way does not work with group format read, so bail
265 * out in that case.
266 */
267 if (perf_evlist__read_format(evlist) & PERF_FORMAT_GROUP)
268 return -1;
269
270 if (!(evsel->attr.read_format & PERF_FORMAT_ID) ||
271 read(fd, &read_data, sizeof(read_data)) == -1)
272 return -1;
273
274 if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_ENABLED)
275 ++id_idx;
276 if (evsel->attr.read_format & PERF_FORMAT_TOTAL_TIME_RUNNING)
277 ++id_idx;
278
279 id = read_data[id_idx];
280
281add:
282 perf_evlist__id_add(evlist, evsel, cpu, thread, id);
283 return 0;
284}
285
286int perf_evlist__alloc_pollfd(struct perf_evlist *evlist)
287{
288 int nr_cpus = perf_cpu_map__nr(evlist->cpus);
289 int nr_threads = perf_thread_map__nr(evlist->threads);
290 int nfds = 0;
291 struct perf_evsel *evsel;
292
293 perf_evlist__for_each_entry(evlist, evsel) {
294 if (evsel->system_wide)
295 nfds += nr_cpus;
296 else
297 nfds += nr_cpus * nr_threads;
298 }
299
300 if (fdarray__available_entries(&evlist->pollfd) < nfds &&
301 fdarray__grow(&evlist->pollfd, nfds) < 0)
302 return -ENOMEM;
303
304 return 0;
305}
306
307int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd,
308 void *ptr, short revent, enum fdarray_flags flags)
309{
310 int pos = fdarray__add(&evlist->pollfd, fd, revent | POLLERR | POLLHUP, flags);
311
312 if (pos >= 0) {
313 evlist->pollfd.priv[pos].ptr = ptr;
314 fcntl(fd, F_SETFL, O_NONBLOCK);
315 }
316
317 return pos;
318}
319
320static void perf_evlist__munmap_filtered(struct fdarray *fda, int fd,
321 void *arg __maybe_unused)
322{
323 struct perf_mmap *map = fda->priv[fd].ptr;
324
325 if (map)
326 perf_mmap__put(map);
327}
328
329int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask)
330{
331 return fdarray__filter(&evlist->pollfd, revents_and_mask,
332 perf_evlist__munmap_filtered, NULL);
333}
334
335int perf_evlist__poll(struct perf_evlist *evlist, int timeout)
336{
337 return fdarray__poll(&evlist->pollfd, timeout);
338}
339
340static struct perf_mmap* perf_evlist__alloc_mmap(struct perf_evlist *evlist, bool overwrite)
341{
342 int i;
343 struct perf_mmap *map;
344
345 map = zalloc(evlist->nr_mmaps * sizeof(struct perf_mmap));
346 if (!map)
347 return NULL;
348
349 for (i = 0; i < evlist->nr_mmaps; i++) {
350 struct perf_mmap *prev = i ? &map[i - 1] : NULL;
351
352 /*
353 * When the perf_mmap() call is made we grab one refcount, plus
354 * one extra to let perf_mmap__consume() get the last
355 * events after all real references (perf_mmap__get()) are
356 * dropped.
357 *
358 * Each PERF_EVENT_IOC_SET_OUTPUT points to this mmap and
359 * thus does perf_mmap__get() on it.
360 */
361 perf_mmap__init(&map[i], prev, overwrite, NULL);
362 }
363
364 return map;
365}
366
367static void perf_evlist__set_sid_idx(struct perf_evlist *evlist,
368 struct perf_evsel *evsel, int idx, int cpu,
369 int thread)
370{
371 struct perf_sample_id *sid = SID(evsel, cpu, thread);
372
373 sid->idx = idx;
374 if (evlist->cpus && cpu >= 0)
375 sid->cpu = evlist->cpus->map[cpu];
376 else
377 sid->cpu = -1;
378 if (!evsel->system_wide && evlist->threads && thread >= 0)
379 sid->tid = perf_thread_map__pid(evlist->threads, thread);
380 else
381 sid->tid = -1;
382}
383
384static struct perf_mmap*
385perf_evlist__mmap_cb_get(struct perf_evlist *evlist, bool overwrite, int idx)
386{
387 struct perf_mmap *maps;
388
389 maps = overwrite ? evlist->mmap_ovw : evlist->mmap;
390
391 if (!maps) {
392 maps = perf_evlist__alloc_mmap(evlist, overwrite);
393 if (!maps)
394 return NULL;
395
396 if (overwrite)
397 evlist->mmap_ovw = maps;
398 else
399 evlist->mmap = maps;
400 }
401
402 return &maps[idx];
403}
404
405#define FD(e, x, y) (*(int *) xyarray__entry(e->fd, x, y))
406
407static int
408perf_evlist__mmap_cb_mmap(struct perf_mmap *map, struct perf_mmap_param *mp,
409 int output, int cpu)
410{
411 return perf_mmap__mmap(map, mp, output, cpu);
412}
413
414static void perf_evlist__set_mmap_first(struct perf_evlist *evlist, struct perf_mmap *map,
415 bool overwrite)
416{
417 if (overwrite)
418 evlist->mmap_ovw_first = map;
419 else
420 evlist->mmap_first = map;
421}
422
423static int
424mmap_per_evsel(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
425 int idx, struct perf_mmap_param *mp, int cpu_idx,
426 int thread, int *_output, int *_output_overwrite)
427{
428 int evlist_cpu = perf_cpu_map__cpu(evlist->cpus, cpu_idx);
429 struct perf_evsel *evsel;
430 int revent;
431
432 perf_evlist__for_each_entry(evlist, evsel) {
433 bool overwrite = evsel->attr.write_backward;
434 struct perf_mmap *map;
435 int *output, fd, cpu;
436
437 if (evsel->system_wide && thread)
438 continue;
439
440 cpu = perf_cpu_map__idx(evsel->cpus, evlist_cpu);
441 if (cpu == -1)
442 continue;
443
444 map = ops->get(evlist, overwrite, idx);
445 if (map == NULL)
446 return -ENOMEM;
447
448 if (overwrite) {
449 mp->prot = PROT_READ;
450 output = _output_overwrite;
451 } else {
452 mp->prot = PROT_READ | PROT_WRITE;
453 output = _output;
454 }
455
456 fd = FD(evsel, cpu, thread);
457
458 if (*output == -1) {
459 *output = fd;
460
461 /*
462 * The last one will be done at perf_mmap__consume(), so that we
463 * make sure we don't prevent tools from consuming every last event in
464 * the ring buffer.
465 *
466 * I.e. we can get the POLLHUP meaning that the fd doesn't exist
467 * anymore, but the last events for it are still in the ring buffer,
468 * waiting to be consumed.
469 *
470 * Tools can chose to ignore this at their own discretion, but the
471 * evlist layer can't just drop it when filtering events in
472 * perf_evlist__filter_pollfd().
473 */
474 refcount_set(&map->refcnt, 2);
475
476 if (ops->mmap(map, mp, *output, evlist_cpu) < 0)
477 return -1;
478
479 if (!idx)
480 perf_evlist__set_mmap_first(evlist, map, overwrite);
481 } else {
482 if (ioctl(fd, PERF_EVENT_IOC_SET_OUTPUT, *output) != 0)
483 return -1;
484
485 perf_mmap__get(map);
486 }
487
488 revent = !overwrite ? POLLIN : 0;
489
490 if (!evsel->system_wide &&
491 perf_evlist__add_pollfd(evlist, fd, map, revent, fdarray_flag__default) < 0) {
492 perf_mmap__put(map);
493 return -1;
494 }
495
496 if (evsel->attr.read_format & PERF_FORMAT_ID) {
497 if (perf_evlist__id_add_fd(evlist, evsel, cpu, thread,
498 fd) < 0)
499 return -1;
500 perf_evlist__set_sid_idx(evlist, evsel, idx, cpu,
501 thread);
502 }
503 }
504
505 return 0;
506}
507
508static int
509mmap_per_thread(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
510 struct perf_mmap_param *mp)
511{
512 int thread;
513 int nr_threads = perf_thread_map__nr(evlist->threads);
514
515 for (thread = 0; thread < nr_threads; thread++) {
516 int output = -1;
517 int output_overwrite = -1;
518
519 if (ops->idx)
520 ops->idx(evlist, mp, thread, false);
521
522 if (mmap_per_evsel(evlist, ops, thread, mp, 0, thread,
523 &output, &output_overwrite))
524 goto out_unmap;
525 }
526
527 return 0;
528
529out_unmap:
530 perf_evlist__munmap(evlist);
531 return -1;
532}
533
534static int
535mmap_per_cpu(struct perf_evlist *evlist, struct perf_evlist_mmap_ops *ops,
536 struct perf_mmap_param *mp)
537{
538 int nr_threads = perf_thread_map__nr(evlist->threads);
539 int nr_cpus = perf_cpu_map__nr(evlist->cpus);
540 int cpu, thread;
541
542 for (cpu = 0; cpu < nr_cpus; cpu++) {
543 int output = -1;
544 int output_overwrite = -1;
545
546 if (ops->idx)
547 ops->idx(evlist, mp, cpu, true);
548
549 for (thread = 0; thread < nr_threads; thread++) {
550 if (mmap_per_evsel(evlist, ops, cpu, mp, cpu,
551 thread, &output, &output_overwrite))
552 goto out_unmap;
553 }
554 }
555
556 return 0;
557
558out_unmap:
559 perf_evlist__munmap(evlist);
560 return -1;
561}
562
563static int perf_evlist__nr_mmaps(struct perf_evlist *evlist)
564{
565 int nr_mmaps;
566
567 nr_mmaps = perf_cpu_map__nr(evlist->cpus);
568 if (perf_cpu_map__empty(evlist->cpus))
569 nr_mmaps = perf_thread_map__nr(evlist->threads);
570
571 return nr_mmaps;
572}
573
574int perf_evlist__mmap_ops(struct perf_evlist *evlist,
575 struct perf_evlist_mmap_ops *ops,
576 struct perf_mmap_param *mp)
577{
578 struct perf_evsel *evsel;
579 const struct perf_cpu_map *cpus = evlist->cpus;
580 const struct perf_thread_map *threads = evlist->threads;
581
582 if (!ops || !ops->get || !ops->mmap)
583 return -EINVAL;
584
585 mp->mask = evlist->mmap_len - page_size - 1;
586
587 evlist->nr_mmaps = perf_evlist__nr_mmaps(evlist);
588
589 perf_evlist__for_each_entry(evlist, evsel) {
590 if ((evsel->attr.read_format & PERF_FORMAT_ID) &&
591 evsel->sample_id == NULL &&
592 perf_evsel__alloc_id(evsel, perf_cpu_map__nr(cpus), threads->nr) < 0)
593 return -ENOMEM;
594 }
595
596 if (evlist->pollfd.entries == NULL && perf_evlist__alloc_pollfd(evlist) < 0)
597 return -ENOMEM;
598
599 if (perf_cpu_map__empty(cpus))
600 return mmap_per_thread(evlist, ops, mp);
601
602 return mmap_per_cpu(evlist, ops, mp);
603}
604
605int perf_evlist__mmap(struct perf_evlist *evlist, int pages)
606{
607 struct perf_mmap_param mp;
608 struct perf_evlist_mmap_ops ops = {
609 .get = perf_evlist__mmap_cb_get,
610 .mmap = perf_evlist__mmap_cb_mmap,
611 };
612
613 evlist->mmap_len = (pages + 1) * page_size;
614
615 return perf_evlist__mmap_ops(evlist, &ops, &mp);
616}
617
618void perf_evlist__munmap(struct perf_evlist *evlist)
619{
620 int i;
621
622 if (evlist->mmap) {
623 for (i = 0; i < evlist->nr_mmaps; i++)
624 perf_mmap__munmap(&evlist->mmap[i]);
625 }
626
627 if (evlist->mmap_ovw) {
628 for (i = 0; i < evlist->nr_mmaps; i++)
629 perf_mmap__munmap(&evlist->mmap_ovw[i]);
630 }
631
632 zfree(&evlist->mmap);
633 zfree(&evlist->mmap_ovw);
634}
635
636struct perf_mmap*
637perf_evlist__next_mmap(struct perf_evlist *evlist, struct perf_mmap *map,
638 bool overwrite)
639{
640 if (map)
641 return map->next;
642
643 return overwrite ? evlist->mmap_ovw_first : evlist->mmap_first;
644}