GNU Linux-libre 5.19-rc6-gnu
[releases.git] / tools / perf / tests / mmap-basic.c
1 // SPDX-License-Identifier: GPL-2.0
2 #include <errno.h>
3 #include <inttypes.h>
4 /* For the CLR_() macros */
5 #include <pthread.h>
6 #include <stdlib.h>
7 #include <perf/cpumap.h>
8
9 #include "debug.h"
10 #include "evlist.h"
11 #include "evsel.h"
12 #include "thread_map.h"
13 #include "tests.h"
14 #include "util/mmap.h"
15 #include <linux/err.h>
16 #include <linux/kernel.h>
17 #include <linux/string.h>
18 #include <perf/evlist.h>
19 #include <perf/mmap.h>
20
21 /*
22  * This test will generate random numbers of calls to some getpid syscalls,
23  * then establish an mmap for a group of events that are created to monitor
24  * the syscalls.
25  *
26  * It will receive the events, using mmap, use its PERF_SAMPLE_ID generated
27  * sample.id field to map back to its respective perf_evsel instance.
28  *
29  * Then it checks if the number of syscalls reported as perf events by
30  * the kernel corresponds to the number of syscalls made.
31  */
32 static int test__basic_mmap(struct test_suite *test __maybe_unused, int subtest __maybe_unused)
33 {
34         int err = TEST_FAIL;
35         union perf_event *event;
36         struct perf_thread_map *threads;
37         struct perf_cpu_map *cpus;
38         struct evlist *evlist;
39         cpu_set_t cpu_set;
40         const char *syscall_names[] = { "getsid", "getppid", "getpgid", };
41         pid_t (*syscalls[])(void) = { (void *)getsid, getppid, (void*)getpgid };
42 #define nsyscalls ARRAY_SIZE(syscall_names)
43         unsigned int nr_events[nsyscalls],
44                      expected_nr_events[nsyscalls], i, j;
45         struct evsel *evsels[nsyscalls], *evsel;
46         char sbuf[STRERR_BUFSIZE];
47         struct mmap *md;
48
49         threads = thread_map__new(-1, getpid(), UINT_MAX);
50         if (threads == NULL) {
51                 pr_debug("thread_map__new\n");
52                 return -1;
53         }
54
55         cpus = perf_cpu_map__new(NULL);
56         if (cpus == NULL) {
57                 pr_debug("perf_cpu_map__new\n");
58                 goto out_free_threads;
59         }
60
61         CPU_ZERO(&cpu_set);
62         CPU_SET(perf_cpu_map__cpu(cpus, 0).cpu, &cpu_set);
63         sched_setaffinity(0, sizeof(cpu_set), &cpu_set);
64         if (sched_setaffinity(0, sizeof(cpu_set), &cpu_set) < 0) {
65                 pr_debug("sched_setaffinity() failed on CPU %d: %s ",
66                          perf_cpu_map__cpu(cpus, 0).cpu,
67                          str_error_r(errno, sbuf, sizeof(sbuf)));
68                 goto out_free_cpus;
69         }
70
71         evlist = evlist__new();
72         if (evlist == NULL) {
73                 pr_debug("evlist__new\n");
74                 goto out_free_cpus;
75         }
76
77         perf_evlist__set_maps(&evlist->core, cpus, threads);
78
79         for (i = 0; i < nsyscalls; ++i) {
80                 char name[64];
81
82                 snprintf(name, sizeof(name), "sys_enter_%s", syscall_names[i]);
83                 evsels[i] = evsel__newtp("syscalls", name);
84                 if (IS_ERR(evsels[i])) {
85                         pr_debug("evsel__new(%s)\n", name);
86                         if (PTR_ERR(evsels[i]) == -EACCES) {
87                                 /* Permissions failure, flag the failure as a skip. */
88                                 err = TEST_SKIP;
89                         }
90                         goto out_delete_evlist;
91                 }
92
93                 evsels[i]->core.attr.wakeup_events = 1;
94                 evsel__set_sample_id(evsels[i], false);
95
96                 evlist__add(evlist, evsels[i]);
97
98                 if (evsel__open(evsels[i], cpus, threads) < 0) {
99                         pr_debug("failed to open counter: %s, "
100                                  "tweak /proc/sys/kernel/perf_event_paranoid?\n",
101                                  str_error_r(errno, sbuf, sizeof(sbuf)));
102                         goto out_delete_evlist;
103                 }
104
105                 nr_events[i] = 0;
106                 expected_nr_events[i] = 1 + rand() % 127;
107         }
108
109         if (evlist__mmap(evlist, 128) < 0) {
110                 pr_debug("failed to mmap events: %d (%s)\n", errno,
111                          str_error_r(errno, sbuf, sizeof(sbuf)));
112                 goto out_delete_evlist;
113         }
114
115         for (i = 0; i < nsyscalls; ++i)
116                 for (j = 0; j < expected_nr_events[i]; ++j) {
117                         int foo = syscalls[i]();
118                         ++foo;
119                 }
120
121         md = &evlist->mmap[0];
122         if (perf_mmap__read_init(&md->core) < 0)
123                 goto out_init;
124
125         while ((event = perf_mmap__read_event(&md->core)) != NULL) {
126                 struct perf_sample sample;
127
128                 if (event->header.type != PERF_RECORD_SAMPLE) {
129                         pr_debug("unexpected %s event\n",
130                                  perf_event__name(event->header.type));
131                         goto out_delete_evlist;
132                 }
133
134                 err = evlist__parse_sample(evlist, event, &sample);
135                 if (err) {
136                         pr_err("Can't parse sample, err = %d\n", err);
137                         goto out_delete_evlist;
138                 }
139
140                 err = -1;
141                 evsel = evlist__id2evsel(evlist, sample.id);
142                 if (evsel == NULL) {
143                         pr_debug("event with id %" PRIu64
144                                  " doesn't map to an evsel\n", sample.id);
145                         goto out_delete_evlist;
146                 }
147                 nr_events[evsel->core.idx]++;
148                 perf_mmap__consume(&md->core);
149         }
150         perf_mmap__read_done(&md->core);
151
152 out_init:
153         err = 0;
154         evlist__for_each_entry(evlist, evsel) {
155                 if (nr_events[evsel->core.idx] != expected_nr_events[evsel->core.idx]) {
156                         pr_debug("expected %d %s events, got %d\n",
157                                  expected_nr_events[evsel->core.idx],
158                                  evsel__name(evsel), nr_events[evsel->core.idx]);
159                         err = -1;
160                         goto out_delete_evlist;
161                 }
162         }
163
164 out_delete_evlist:
165         evlist__delete(evlist);
166 out_free_cpus:
167         perf_cpu_map__put(cpus);
168 out_free_threads:
169         perf_thread_map__put(threads);
170         return err;
171 }
172
173 static struct test_case tests__basic_mmap[] = {
174         TEST_CASE_REASON("Read samples using the mmap interface",
175                          basic_mmap,
176                          "permissions"),
177         {       .name = NULL, }
178 };
179
180 struct test_suite suite__basic_mmap = {
181         .desc = "Read samples using the mmap interface",
182         .test_cases = tests__basic_mmap,
183 };