xref: /openbmc/linux/tools/perf/tests/mmap-basic.c (revision dff03381)
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 int test_stat_user_read(int event)
174 {
175 	struct perf_counts_values counts = { .val = 0 };
176 	struct perf_thread_map *threads;
177 	struct perf_evsel *evsel;
178 	struct perf_event_mmap_page *pc;
179 	struct perf_event_attr attr = {
180 		.type	= PERF_TYPE_HARDWARE,
181 		.config	= event,
182 #ifdef __aarch64__
183 		.config1 = 0x2,		/* Request user access */
184 #endif
185 	};
186 	int err, i, ret = TEST_FAIL;
187 	bool opened = false, mapped = false;
188 
189 	threads = perf_thread_map__new_dummy();
190 	TEST_ASSERT_VAL("failed to create threads", threads);
191 
192 	perf_thread_map__set_pid(threads, 0, 0);
193 
194 	evsel = perf_evsel__new(&attr);
195 	TEST_ASSERT_VAL("failed to create evsel", evsel);
196 
197 	err = perf_evsel__open(evsel, NULL, threads);
198 	if (err) {
199 		pr_err("failed to open evsel: %s\n", strerror(-err));
200 		ret = TEST_SKIP;
201 		goto out;
202 	}
203 	opened = true;
204 
205 	err = perf_evsel__mmap(evsel, 0);
206 	if (err) {
207 		pr_err("failed to mmap evsel: %s\n", strerror(-err));
208 		goto out;
209 	}
210 	mapped = true;
211 
212 	pc = perf_evsel__mmap_base(evsel, 0, 0);
213 	if (!pc) {
214 		pr_err("failed to get mmapped address\n");
215 		goto out;
216 	}
217 
218 	if (!pc->cap_user_rdpmc || !pc->index) {
219 		pr_err("userspace counter access not %s\n",
220 			!pc->cap_user_rdpmc ? "supported" : "enabled");
221 		ret = TEST_SKIP;
222 		goto out;
223 	}
224 	if (pc->pmc_width < 32) {
225 		pr_err("userspace counter width not set (%d)\n", pc->pmc_width);
226 		goto out;
227 	}
228 
229 	perf_evsel__read(evsel, 0, 0, &counts);
230 	if (counts.val == 0) {
231 		pr_err("failed to read value for evsel\n");
232 		goto out;
233 	}
234 
235 	for (i = 0; i < 5; i++) {
236 		volatile int count = 0x10000 << i;
237 		__u64 start, end, last = 0;
238 
239 		pr_debug("\tloop = %u, ", count);
240 
241 		perf_evsel__read(evsel, 0, 0, &counts);
242 		start = counts.val;
243 
244 		while (count--) ;
245 
246 		perf_evsel__read(evsel, 0, 0, &counts);
247 		end = counts.val;
248 
249 		if ((end - start) < last) {
250 			pr_err("invalid counter data: end=%llu start=%llu last= %llu\n",
251 				end, start, last);
252 			goto out;
253 		}
254 		last = end - start;
255 		pr_debug("count = %llu\n", end - start);
256 	}
257 	ret = TEST_OK;
258 
259 out:
260 	if (mapped)
261 		perf_evsel__munmap(evsel);
262 	if (opened)
263 		perf_evsel__close(evsel);
264 	perf_evsel__delete(evsel);
265 
266 	perf_thread_map__put(threads);
267 	return ret;
268 }
269 
270 static int test__mmap_user_read_instr(struct test_suite *test __maybe_unused,
271 				      int subtest __maybe_unused)
272 {
273 	return test_stat_user_read(PERF_COUNT_HW_INSTRUCTIONS);
274 }
275 
276 static int test__mmap_user_read_cycles(struct test_suite *test __maybe_unused,
277 				       int subtest __maybe_unused)
278 {
279 	return test_stat_user_read(PERF_COUNT_HW_CPU_CYCLES);
280 }
281 
282 static struct test_case tests__basic_mmap[] = {
283 	TEST_CASE_REASON("Read samples using the mmap interface",
284 			 basic_mmap,
285 			 "permissions"),
286 	TEST_CASE_REASON("User space counter reading of instructions",
287 			 mmap_user_read_instr,
288 #if defined(__i386__) || defined(__x86_64__) || defined(__aarch64__)
289 			 "permissions"
290 #else
291 			 "unsupported"
292 #endif
293 		),
294 	TEST_CASE_REASON("User space counter reading of cycles",
295 			 mmap_user_read_cycles,
296 #if defined(__i386__) || defined(__x86_64__) || defined(__aarch64__)
297 			 "permissions"
298 #else
299 			 "unsupported"
300 #endif
301 		),
302 	{	.name = NULL, }
303 };
304 
305 struct test_suite suite__basic_mmap = {
306 	.desc = "mmap interface tests",
307 	.test_cases = tests__basic_mmap,
308 };
309