xref: /openbmc/linux/tools/perf/tests/builtin-test.c (revision 3e26a691)
1 /*
2  * builtin-test.c
3  *
4  * Builtin regression testing command: ever growing number of sanity tests
5  */
6 #include <unistd.h>
7 #include <string.h>
8 #include "builtin.h"
9 #include "hist.h"
10 #include "intlist.h"
11 #include "tests.h"
12 #include "debug.h"
13 #include "color.h"
14 #include <subcmd/parse-options.h>
15 #include "symbol.h"
16 
17 struct test __weak arch_tests[] = {
18 	{
19 		.func = NULL,
20 	},
21 };
22 
23 static struct test generic_tests[] = {
24 	{
25 		.desc = "vmlinux symtab matches kallsyms",
26 		.func = test__vmlinux_matches_kallsyms,
27 	},
28 	{
29 		.desc = "detect openat syscall event",
30 		.func = test__openat_syscall_event,
31 	},
32 	{
33 		.desc = "detect openat syscall event on all cpus",
34 		.func = test__openat_syscall_event_on_all_cpus,
35 	},
36 	{
37 		.desc = "read samples using the mmap interface",
38 		.func = test__basic_mmap,
39 	},
40 	{
41 		.desc = "parse events tests",
42 		.func = test__parse_events,
43 	},
44 	{
45 		.desc = "Validate PERF_RECORD_* events & perf_sample fields",
46 		.func = test__PERF_RECORD,
47 	},
48 	{
49 		.desc = "Test perf pmu format parsing",
50 		.func = test__pmu,
51 	},
52 	{
53 		.desc = "Test dso data read",
54 		.func = test__dso_data,
55 	},
56 	{
57 		.desc = "Test dso data cache",
58 		.func = test__dso_data_cache,
59 	},
60 	{
61 		.desc = "Test dso data reopen",
62 		.func = test__dso_data_reopen,
63 	},
64 	{
65 		.desc = "roundtrip evsel->name check",
66 		.func = test__perf_evsel__roundtrip_name_test,
67 	},
68 	{
69 		.desc = "Check parsing of sched tracepoints fields",
70 		.func = test__perf_evsel__tp_sched_test,
71 	},
72 	{
73 		.desc = "Generate and check syscalls:sys_enter_openat event fields",
74 		.func = test__syscall_openat_tp_fields,
75 	},
76 	{
77 		.desc = "struct perf_event_attr setup",
78 		.func = test__attr,
79 	},
80 	{
81 		.desc = "Test matching and linking multiple hists",
82 		.func = test__hists_link,
83 	},
84 	{
85 		.desc = "Try 'import perf' in python, checking link problems",
86 		.func = test__python_use,
87 	},
88 	{
89 		.desc = "Test breakpoint overflow signal handler",
90 		.func = test__bp_signal,
91 	},
92 	{
93 		.desc = "Test breakpoint overflow sampling",
94 		.func = test__bp_signal_overflow,
95 	},
96 	{
97 		.desc = "Test number of exit event of a simple workload",
98 		.func = test__task_exit,
99 	},
100 	{
101 		.desc = "Test software clock events have valid period values",
102 		.func = test__sw_clock_freq,
103 	},
104 	{
105 		.desc = "Test object code reading",
106 		.func = test__code_reading,
107 	},
108 	{
109 		.desc = "Test sample parsing",
110 		.func = test__sample_parsing,
111 	},
112 	{
113 		.desc = "Test using a dummy software event to keep tracking",
114 		.func = test__keep_tracking,
115 	},
116 	{
117 		.desc = "Test parsing with no sample_id_all bit set",
118 		.func = test__parse_no_sample_id_all,
119 	},
120 	{
121 		.desc = "Test filtering hist entries",
122 		.func = test__hists_filter,
123 	},
124 	{
125 		.desc = "Test mmap thread lookup",
126 		.func = test__mmap_thread_lookup,
127 	},
128 	{
129 		.desc = "Test thread mg sharing",
130 		.func = test__thread_mg_share,
131 	},
132 	{
133 		.desc = "Test output sorting of hist entries",
134 		.func = test__hists_output,
135 	},
136 	{
137 		.desc = "Test cumulation of child hist entries",
138 		.func = test__hists_cumulate,
139 	},
140 	{
141 		.desc = "Test tracking with sched_switch",
142 		.func = test__switch_tracking,
143 	},
144 	{
145 		.desc = "Filter fds with revents mask in a fdarray",
146 		.func = test__fdarray__filter,
147 	},
148 	{
149 		.desc = "Add fd to a fdarray, making it autogrow",
150 		.func = test__fdarray__add,
151 	},
152 	{
153 		.desc = "Test kmod_path__parse function",
154 		.func = test__kmod_path__parse,
155 	},
156 	{
157 		.desc = "Test thread map",
158 		.func = test__thread_map,
159 	},
160 	{
161 		.desc = "Test LLVM searching and compiling",
162 		.func = test__llvm,
163 		.subtest = {
164 			.skip_if_fail	= true,
165 			.get_nr		= test__llvm_subtest_get_nr,
166 			.get_desc	= test__llvm_subtest_get_desc,
167 		},
168 	},
169 	{
170 		.desc = "Test topology in session",
171 		.func = test_session_topology,
172 	},
173 	{
174 		.desc = "Test BPF filter",
175 		.func = test__bpf,
176 		.subtest = {
177 			.skip_if_fail	= true,
178 			.get_nr		= test__bpf_subtest_get_nr,
179 			.get_desc	= test__bpf_subtest_get_desc,
180 		},
181 	},
182 	{
183 		.desc = "Test thread map synthesize",
184 		.func = test__thread_map_synthesize,
185 	},
186 	{
187 		.desc = "Test cpu map synthesize",
188 		.func = test__cpu_map_synthesize,
189 	},
190 	{
191 		.desc = "Test stat config synthesize",
192 		.func = test__synthesize_stat_config,
193 	},
194 	{
195 		.desc = "Test stat synthesize",
196 		.func = test__synthesize_stat,
197 	},
198 	{
199 		.desc = "Test stat round synthesize",
200 		.func = test__synthesize_stat_round,
201 	},
202 	{
203 		.desc = "Test attr update synthesize",
204 		.func = test__event_update,
205 	},
206 	{
207 		.func = NULL,
208 	},
209 };
210 
211 static struct test *tests[] = {
212 	generic_tests,
213 	arch_tests,
214 };
215 
216 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
217 {
218 	int i;
219 
220 	if (argc == 0)
221 		return true;
222 
223 	for (i = 0; i < argc; ++i) {
224 		char *end;
225 		long nr = strtoul(argv[i], &end, 10);
226 
227 		if (*end == '\0') {
228 			if (nr == curr + 1)
229 				return true;
230 			continue;
231 		}
232 
233 		if (strcasestr(test->desc, argv[i]))
234 			return true;
235 	}
236 
237 	return false;
238 }
239 
240 static int run_test(struct test *test, int subtest)
241 {
242 	int status, err = -1, child = fork();
243 	char sbuf[STRERR_BUFSIZE];
244 
245 	if (child < 0) {
246 		pr_err("failed to fork test: %s\n",
247 			strerror_r(errno, sbuf, sizeof(sbuf)));
248 		return -1;
249 	}
250 
251 	if (!child) {
252 		pr_debug("test child forked, pid %d\n", getpid());
253 		if (!verbose) {
254 			int nullfd = open("/dev/null", O_WRONLY);
255 			if (nullfd >= 0) {
256 				close(STDERR_FILENO);
257 				close(STDOUT_FILENO);
258 
259 				dup2(nullfd, STDOUT_FILENO);
260 				dup2(STDOUT_FILENO, STDERR_FILENO);
261 				close(nullfd);
262 			}
263 		} else {
264 			signal(SIGSEGV, sighandler_dump_stack);
265 			signal(SIGFPE, sighandler_dump_stack);
266 		}
267 
268 		err = test->func(subtest);
269 		exit(err);
270 	}
271 
272 	wait(&status);
273 
274 	if (WIFEXITED(status)) {
275 		err = (signed char)WEXITSTATUS(status);
276 		pr_debug("test child finished with %d\n", err);
277 	} else if (WIFSIGNALED(status)) {
278 		err = -1;
279 		pr_debug("test child interrupted\n");
280 	}
281 
282 	return err;
283 }
284 
285 #define for_each_test(j, t)	 				\
286 	for (j = 0; j < ARRAY_SIZE(tests); j++)	\
287 		for (t = &tests[j][0]; t->func; t++)
288 
289 static int test_and_print(struct test *t, bool force_skip, int subtest)
290 {
291 	int err;
292 
293 	if (!force_skip) {
294 		pr_debug("\n--- start ---\n");
295 		err = run_test(t, subtest);
296 		pr_debug("---- end ----\n");
297 	} else {
298 		pr_debug("\n--- force skipped ---\n");
299 		err = TEST_SKIP;
300 	}
301 
302 	if (!t->subtest.get_nr)
303 		pr_debug("%s:", t->desc);
304 	else
305 		pr_debug("%s subtest %d:", t->desc, subtest);
306 
307 	switch (err) {
308 	case TEST_OK:
309 		pr_info(" Ok\n");
310 		break;
311 	case TEST_SKIP:
312 		color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
313 		break;
314 	case TEST_FAIL:
315 	default:
316 		color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
317 		break;
318 	}
319 
320 	return err;
321 }
322 
323 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
324 {
325 	struct test *t;
326 	unsigned int j;
327 	int i = 0;
328 	int width = 0;
329 
330 	for_each_test(j, t) {
331 		int len = strlen(t->desc);
332 
333 		if (width < len)
334 			width = len;
335 	}
336 
337 	for_each_test(j, t) {
338 		int curr = i++, err;
339 
340 		if (!perf_test__matches(t, curr, argc, argv))
341 			continue;
342 
343 		pr_info("%2d: %-*s:", i, width, t->desc);
344 
345 		if (intlist__find(skiplist, i)) {
346 			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
347 			continue;
348 		}
349 
350 		if (!t->subtest.get_nr) {
351 			test_and_print(t, false, -1);
352 		} else {
353 			int subn = t->subtest.get_nr();
354 			/*
355 			 * minus 2 to align with normal testcases.
356 			 * For subtest we print additional '.x' in number.
357 			 * for example:
358 			 *
359 			 * 35: Test LLVM searching and compiling                        :
360 			 * 35.1: Basic BPF llvm compiling test                          : Ok
361 			 */
362 			int subw = width > 2 ? width - 2 : width;
363 			bool skip = false;
364 			int subi;
365 
366 			if (subn <= 0) {
367 				color_fprintf(stderr, PERF_COLOR_YELLOW,
368 					      " Skip (not compiled in)\n");
369 				continue;
370 			}
371 			pr_info("\n");
372 
373 			for (subi = 0; subi < subn; subi++) {
374 				int len = strlen(t->subtest.get_desc(subi));
375 
376 				if (subw < len)
377 					subw = len;
378 			}
379 
380 			for (subi = 0; subi < subn; subi++) {
381 				pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
382 					t->subtest.get_desc(subi));
383 				err = test_and_print(t, skip, subi);
384 				if (err != TEST_OK && t->subtest.skip_if_fail)
385 					skip = true;
386 			}
387 		}
388 	}
389 
390 	return 0;
391 }
392 
393 static int perf_test__list(int argc, const char **argv)
394 {
395 	unsigned int j;
396 	struct test *t;
397 	int i = 0;
398 
399 	for_each_test(j, t) {
400 		if (argc > 1 && !strstr(t->desc, argv[1]))
401 			continue;
402 
403 		pr_info("%2d: %s\n", ++i, t->desc);
404 	}
405 
406 	return 0;
407 }
408 
409 int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
410 {
411 	const char *test_usage[] = {
412 	"perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
413 	NULL,
414 	};
415 	const char *skip = NULL;
416 	const struct option test_options[] = {
417 	OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
418 	OPT_INCR('v', "verbose", &verbose,
419 		    "be more verbose (show symbol address, etc)"),
420 	OPT_END()
421 	};
422 	const char * const test_subcommands[] = { "list", NULL };
423 	struct intlist *skiplist = NULL;
424         int ret = hists__init();
425 
426         if (ret < 0)
427                 return ret;
428 
429 	argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
430 	if (argc >= 1 && !strcmp(argv[0], "list"))
431 		return perf_test__list(argc, argv);
432 
433 	symbol_conf.priv_size = sizeof(int);
434 	symbol_conf.sort_by_name = true;
435 	symbol_conf.try_vmlinux_path = true;
436 
437 	if (symbol__init(NULL) < 0)
438 		return -1;
439 
440 	if (skip != NULL)
441 		skiplist = intlist__new(skip);
442 
443 	return __cmd_test(argc, argv, skiplist);
444 }
445