xref: /linux/tools/perf/tests/builtin-test.c (revision 0883c2c06fb5bcf5b9e008270827e63c09a88c1e)
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 		.desc = "Test events times",
208 		.func = test__event_times,
209 	},
210 	{
211 		.desc = "Test backward reading from ring buffer",
212 		.func = test__backward_ring_buffer,
213 	},
214 	{
215 		.func = NULL,
216 	},
217 };
218 
219 static struct test *tests[] = {
220 	generic_tests,
221 	arch_tests,
222 };
223 
224 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
225 {
226 	int i;
227 
228 	if (argc == 0)
229 		return true;
230 
231 	for (i = 0; i < argc; ++i) {
232 		char *end;
233 		long nr = strtoul(argv[i], &end, 10);
234 
235 		if (*end == '\0') {
236 			if (nr == curr + 1)
237 				return true;
238 			continue;
239 		}
240 
241 		if (strcasestr(test->desc, argv[i]))
242 			return true;
243 	}
244 
245 	return false;
246 }
247 
248 static int run_test(struct test *test, int subtest)
249 {
250 	int status, err = -1, child = fork();
251 	char sbuf[STRERR_BUFSIZE];
252 
253 	if (child < 0) {
254 		pr_err("failed to fork test: %s\n",
255 			strerror_r(errno, sbuf, sizeof(sbuf)));
256 		return -1;
257 	}
258 
259 	if (!child) {
260 		pr_debug("test child forked, pid %d\n", getpid());
261 		if (!verbose) {
262 			int nullfd = open("/dev/null", O_WRONLY);
263 			if (nullfd >= 0) {
264 				close(STDERR_FILENO);
265 				close(STDOUT_FILENO);
266 
267 				dup2(nullfd, STDOUT_FILENO);
268 				dup2(STDOUT_FILENO, STDERR_FILENO);
269 				close(nullfd);
270 			}
271 		} else {
272 			signal(SIGSEGV, sighandler_dump_stack);
273 			signal(SIGFPE, sighandler_dump_stack);
274 		}
275 
276 		err = test->func(subtest);
277 		exit(err);
278 	}
279 
280 	wait(&status);
281 
282 	if (WIFEXITED(status)) {
283 		err = (signed char)WEXITSTATUS(status);
284 		pr_debug("test child finished with %d\n", err);
285 	} else if (WIFSIGNALED(status)) {
286 		err = -1;
287 		pr_debug("test child interrupted\n");
288 	}
289 
290 	return err;
291 }
292 
293 #define for_each_test(j, t)	 				\
294 	for (j = 0; j < ARRAY_SIZE(tests); j++)	\
295 		for (t = &tests[j][0]; t->func; t++)
296 
297 static int test_and_print(struct test *t, bool force_skip, int subtest)
298 {
299 	int err;
300 
301 	if (!force_skip) {
302 		pr_debug("\n--- start ---\n");
303 		err = run_test(t, subtest);
304 		pr_debug("---- end ----\n");
305 	} else {
306 		pr_debug("\n--- force skipped ---\n");
307 		err = TEST_SKIP;
308 	}
309 
310 	if (!t->subtest.get_nr)
311 		pr_debug("%s:", t->desc);
312 	else
313 		pr_debug("%s subtest %d:", t->desc, subtest);
314 
315 	switch (err) {
316 	case TEST_OK:
317 		pr_info(" Ok\n");
318 		break;
319 	case TEST_SKIP:
320 		color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
321 		break;
322 	case TEST_FAIL:
323 	default:
324 		color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
325 		break;
326 	}
327 
328 	return err;
329 }
330 
331 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
332 {
333 	struct test *t;
334 	unsigned int j;
335 	int i = 0;
336 	int width = 0;
337 
338 	for_each_test(j, t) {
339 		int len = strlen(t->desc);
340 
341 		if (width < len)
342 			width = len;
343 	}
344 
345 	for_each_test(j, t) {
346 		int curr = i++, err;
347 
348 		if (!perf_test__matches(t, curr, argc, argv))
349 			continue;
350 
351 		pr_info("%2d: %-*s:", i, width, t->desc);
352 
353 		if (intlist__find(skiplist, i)) {
354 			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
355 			continue;
356 		}
357 
358 		if (!t->subtest.get_nr) {
359 			test_and_print(t, false, -1);
360 		} else {
361 			int subn = t->subtest.get_nr();
362 			/*
363 			 * minus 2 to align with normal testcases.
364 			 * For subtest we print additional '.x' in number.
365 			 * for example:
366 			 *
367 			 * 35: Test LLVM searching and compiling                        :
368 			 * 35.1: Basic BPF llvm compiling test                          : Ok
369 			 */
370 			int subw = width > 2 ? width - 2 : width;
371 			bool skip = false;
372 			int subi;
373 
374 			if (subn <= 0) {
375 				color_fprintf(stderr, PERF_COLOR_YELLOW,
376 					      " Skip (not compiled in)\n");
377 				continue;
378 			}
379 			pr_info("\n");
380 
381 			for (subi = 0; subi < subn; subi++) {
382 				int len = strlen(t->subtest.get_desc(subi));
383 
384 				if (subw < len)
385 					subw = len;
386 			}
387 
388 			for (subi = 0; subi < subn; subi++) {
389 				pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
390 					t->subtest.get_desc(subi));
391 				err = test_and_print(t, skip, subi);
392 				if (err != TEST_OK && t->subtest.skip_if_fail)
393 					skip = true;
394 			}
395 		}
396 	}
397 
398 	return 0;
399 }
400 
401 static int perf_test__list(int argc, const char **argv)
402 {
403 	unsigned int j;
404 	struct test *t;
405 	int i = 0;
406 
407 	for_each_test(j, t) {
408 		if (argc > 1 && !strstr(t->desc, argv[1]))
409 			continue;
410 
411 		pr_info("%2d: %s\n", ++i, t->desc);
412 	}
413 
414 	return 0;
415 }
416 
417 int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
418 {
419 	const char *test_usage[] = {
420 	"perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
421 	NULL,
422 	};
423 	const char *skip = NULL;
424 	const struct option test_options[] = {
425 	OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
426 	OPT_INCR('v', "verbose", &verbose,
427 		    "be more verbose (show symbol address, etc)"),
428 	OPT_END()
429 	};
430 	const char * const test_subcommands[] = { "list", NULL };
431 	struct intlist *skiplist = NULL;
432         int ret = hists__init();
433 
434         if (ret < 0)
435                 return ret;
436 
437 	argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
438 	if (argc >= 1 && !strcmp(argv[0], "list"))
439 		return perf_test__list(argc, argv);
440 
441 	symbol_conf.priv_size = sizeof(int);
442 	symbol_conf.sort_by_name = true;
443 	symbol_conf.try_vmlinux_path = true;
444 
445 	if (symbol__init(NULL) < 0)
446 		return -1;
447 
448 	if (skip != NULL)
449 		skiplist = intlist__new(skip);
450 
451 	return __cmd_test(argc, argv, skiplist);
452 }
453