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