1 // SPDX-License-Identifier: GPL-2.0
5 * Builtin regression testing command: ever growing number of sanity tests
12 #include <sys/types.h>
22 #include <subcmd/parse-options.h>
25 #include "util/rlimit.h"
26 #include <linux/kernel.h>
27 #include <linux/string.h>
28 #include <subcmd/exec-cmd.h>
30 static bool dont_fork;
32 struct test __weak arch_tests[] = {
38 static struct test generic_tests[] = {
40 .desc = "vmlinux symtab matches kallsyms",
41 .func = test__vmlinux_matches_kallsyms,
44 .desc = "Detect openat syscall event",
45 .func = test__openat_syscall_event,
48 .desc = "Detect openat syscall event on all cpus",
49 .func = test__openat_syscall_event_on_all_cpus,
52 .desc = "Read samples using the mmap interface",
53 .func = test__basic_mmap,
56 .desc = "Test data source output",
60 .desc = "Parse event definition strings",
61 .func = test__parse_events,
64 .desc = "Simple expression parser",
68 .desc = "PERF_RECORD_* events & perf_sample fields",
69 .func = test__PERF_RECORD,
72 .desc = "Parse perf pmu format",
76 .desc = "DSO data read",
77 .func = test__dso_data,
80 .desc = "DSO data cache",
81 .func = test__dso_data_cache,
84 .desc = "DSO data reopen",
85 .func = test__dso_data_reopen,
88 .desc = "Roundtrip evsel->name",
89 .func = test__perf_evsel__roundtrip_name_test,
92 .desc = "Parse sched tracepoints fields",
93 .func = test__perf_evsel__tp_sched_test,
96 .desc = "syscalls:sys_enter_openat event fields",
97 .func = test__syscall_openat_tp_fields,
100 .desc = "Setup struct perf_event_attr",
104 .desc = "Match and link multiple hists",
105 .func = test__hists_link,
108 .desc = "'import perf' in python",
109 .func = test__python_use,
112 .desc = "Breakpoint overflow signal handler",
113 .func = test__bp_signal,
114 .is_supported = test__bp_signal_is_supported,
117 .desc = "Breakpoint overflow sampling",
118 .func = test__bp_signal_overflow,
119 .is_supported = test__bp_signal_is_supported,
122 .desc = "Breakpoint accounting",
123 .func = test__bp_accounting,
124 .is_supported = test__bp_account_is_supported,
127 .desc = "Watchpoint",
129 .is_supported = test__wp_is_supported,
131 .skip_if_fail = false,
132 .get_nr = test__wp_subtest_get_nr,
133 .get_desc = test__wp_subtest_get_desc,
137 .desc = "Number of exit events of a simple workload",
138 .func = test__task_exit,
141 .desc = "Software clock events period values",
142 .func = test__sw_clock_freq,
145 .desc = "Object code reading",
146 .func = test__code_reading,
149 .desc = "Sample parsing",
150 .func = test__sample_parsing,
153 .desc = "Use a dummy software event to keep tracking",
154 .func = test__keep_tracking,
157 .desc = "Parse with no sample_id_all bit set",
158 .func = test__parse_no_sample_id_all,
161 .desc = "Filter hist entries",
162 .func = test__hists_filter,
165 .desc = "Lookup mmap thread",
166 .func = test__mmap_thread_lookup,
169 .desc = "Share thread mg",
170 .func = test__thread_mg_share,
173 .desc = "Sort output of hist entries",
174 .func = test__hists_output,
177 .desc = "Cumulate child hist entries",
178 .func = test__hists_cumulate,
181 .desc = "Track with sched_switch",
182 .func = test__switch_tracking,
185 .desc = "Filter fds with revents mask in a fdarray",
186 .func = test__fdarray__filter,
189 .desc = "Add fd to a fdarray, making it autogrow",
190 .func = test__fdarray__add,
193 .desc = "kmod_path__parse",
194 .func = test__kmod_path__parse,
197 .desc = "Thread map",
198 .func = test__thread_map,
201 .desc = "LLVM search and compile",
204 .skip_if_fail = true,
205 .get_nr = test__llvm_subtest_get_nr,
206 .get_desc = test__llvm_subtest_get_desc,
210 .desc = "Session topology",
211 .func = test__session_topology,
214 .desc = "BPF filter",
217 .skip_if_fail = true,
218 .get_nr = test__bpf_subtest_get_nr,
219 .get_desc = test__bpf_subtest_get_desc,
223 .desc = "Synthesize thread map",
224 .func = test__thread_map_synthesize,
227 .desc = "Remove thread map",
228 .func = test__thread_map_remove,
231 .desc = "Synthesize cpu map",
232 .func = test__cpu_map_synthesize,
235 .desc = "Synthesize stat config",
236 .func = test__synthesize_stat_config,
239 .desc = "Synthesize stat",
240 .func = test__synthesize_stat,
243 .desc = "Synthesize stat round",
244 .func = test__synthesize_stat_round,
247 .desc = "Synthesize attr update",
248 .func = test__event_update,
251 .desc = "Event times",
252 .func = test__event_times,
255 .desc = "Read backward ring buffer",
256 .func = test__backward_ring_buffer,
259 .desc = "Print cpu map",
260 .func = test__cpu_map_print,
263 .desc = "Probe SDT events",
264 .func = test__sdt_event,
267 .desc = "is_printable_array",
268 .func = test__is_printable_array,
271 .desc = "Print bitmap",
272 .func = test__bitmap_print,
275 .desc = "perf hooks",
276 .func = test__perf_hooks,
279 .desc = "builtin clang support",
282 .skip_if_fail = true,
283 .get_nr = test__clang_subtest_get_nr,
284 .get_desc = test__clang_subtest_get_desc,
288 .desc = "unit_number__scnprintf",
289 .func = test__unit_number__scnprint,
293 .func = test__mem2node,
296 .desc = "time utils",
297 .func = test__time_utils,
300 .desc = "map_groups__merge_in",
301 .func = test__map_groups__merge_in,
308 static struct test *tests[] = {
313 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
320 for (i = 0; i < argc; ++i) {
322 long nr = strtoul(argv[i], &end, 10);
330 if (strcasestr(test->desc, argv[i]))
337 static int run_test(struct test *test, int subtest)
339 int status, err = -1, child = dont_fork ? 0 : fork();
340 char sbuf[STRERR_BUFSIZE];
343 pr_err("failed to fork test: %s\n",
344 str_error_r(errno, sbuf, sizeof(sbuf)));
350 pr_debug("test child forked, pid %d\n", getpid());
353 int nullfd = open("/dev/null", O_WRONLY);
356 close(STDERR_FILENO);
357 close(STDOUT_FILENO);
359 dup2(nullfd, STDOUT_FILENO);
360 dup2(STDOUT_FILENO, STDERR_FILENO);
364 signal(SIGSEGV, sighandler_dump_stack);
365 signal(SIGFPE, sighandler_dump_stack);
369 err = test->func(test, subtest);
377 if (WIFEXITED(status)) {
378 err = (signed char)WEXITSTATUS(status);
379 pr_debug("test child finished with %d\n", err);
380 } else if (WIFSIGNALED(status)) {
382 pr_debug("test child interrupted\n");
389 #define for_each_test(j, t) \
390 for (j = 0; j < ARRAY_SIZE(tests); j++) \
391 for (t = &tests[j][0]; t->func; t++)
393 static int test_and_print(struct test *t, bool force_skip, int subtest)
398 pr_debug("\n--- start ---\n");
399 err = run_test(t, subtest);
400 pr_debug("---- end ----\n");
402 pr_debug("\n--- force skipped ---\n");
406 if (!t->subtest.get_nr)
407 pr_debug("%s:", t->desc);
409 pr_debug("%s subtest %d:", t->desc, subtest + 1);
416 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
420 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
427 static const char *shell_test__description(char *description, size_t size,
428 const char *path, const char *name)
431 char filename[PATH_MAX];
433 path__join(filename, sizeof(filename), path, name);
434 fp = fopen(filename, "r");
439 while (fgetc(fp) != '\n');
441 description = fgets(description, size, fp);
444 return description ? strim(description + 1) : NULL;
447 #define for_each_shell_test(dir, base, ent) \
448 while ((ent = readdir(dir)) != NULL) \
449 if (!is_directory(base, ent) && ent->d_name[0] != '.')
451 static const char *shell_tests__dir(char *path, size_t size)
453 const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
457 for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
459 if (!lstat(devel_dirs[i], &st)) {
460 scnprintf(path, size, "%s/shell", devel_dirs[i]);
461 if (!lstat(devel_dirs[i], &st))
466 /* Then installed path. */
467 exec_path = get_argv_exec_path();
468 scnprintf(path, size, "%s/tests/shell", exec_path);
473 static int shell_tests__max_desc_width(void)
477 char path_dir[PATH_MAX];
478 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
488 for_each_shell_test(dir, path, ent) {
490 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name);
493 int len = strlen(desc);
509 static int shell_test__run(struct test *test, int subdir __maybe_unused)
512 char script[PATH_MAX];
513 struct shell_test *st = test->priv;
515 path__join(script, sizeof(script), st->dir, st->file);
517 err = system(script);
521 return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL;
524 static int run_shell_tests(int argc, const char *argv[], int i, int width)
528 char path_dir[PATH_MAX];
529 struct shell_test st = {
530 .dir = shell_tests__dir(path_dir, sizeof(path_dir)),
536 dir = opendir(st.dir);
540 for_each_shell_test(dir, st.dir, ent) {
544 .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name),
545 .func = shell_test__run,
549 if (!perf_test__matches(&test, curr, argc, argv))
552 st.file = ent->d_name;
553 pr_info("%2d: %-*s:", i, width, test.desc);
554 test_and_print(&test, false, -1);
561 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
566 int width = shell_tests__max_desc_width();
568 for_each_test(j, t) {
569 int len = strlen(t->desc);
575 for_each_test(j, t) {
578 if (!perf_test__matches(t, curr, argc, argv))
581 if (t->is_supported && !t->is_supported()) {
582 pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc);
586 pr_info("%2d: %-*s:", i, width, t->desc);
588 if (intlist__find(skiplist, i)) {
589 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
593 if (!t->subtest.get_nr) {
594 test_and_print(t, false, -1);
596 int subn = t->subtest.get_nr();
598 * minus 2 to align with normal testcases.
599 * For subtest we print additional '.x' in number.
602 * 35: Test LLVM searching and compiling :
603 * 35.1: Basic BPF llvm compiling test : Ok
605 int subw = width > 2 ? width - 2 : width;
610 color_fprintf(stderr, PERF_COLOR_YELLOW,
611 " Skip (not compiled in)\n");
616 for (subi = 0; subi < subn; subi++) {
617 int len = strlen(t->subtest.get_desc(subi));
623 for (subi = 0; subi < subn; subi++) {
624 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
625 t->subtest.get_desc(subi));
626 err = test_and_print(t, skip, subi);
627 if (err != TEST_OK && t->subtest.skip_if_fail)
633 return run_shell_tests(argc, argv, i, width);
636 static int perf_test__list_shell(int argc, const char **argv, int i)
640 char path_dir[PATH_MAX];
641 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
650 for_each_shell_test(dir, path, ent) {
654 .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name),
657 if (!perf_test__matches(&t, curr, argc, argv))
660 pr_info("%2d: %s\n", i, t.desc);
667 static int perf_test__list(int argc, const char **argv)
673 for_each_test(j, t) {
676 if (!perf_test__matches(t, curr, argc, argv) ||
677 (t->is_supported && !t->is_supported()))
680 pr_info("%2d: %s\n", i, t->desc);
682 if (t->subtest.get_nr) {
683 int subn = t->subtest.get_nr();
686 for (subi = 0; subi < subn; subi++)
687 pr_info("%2d:%1d: %s\n", i, subi + 1,
688 t->subtest.get_desc(subi));
692 perf_test__list_shell(argc, argv, i);
697 int cmd_test(int argc, const char **argv)
699 const char *test_usage[] = {
700 "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
703 const char *skip = NULL;
704 const struct option test_options[] = {
705 OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
706 OPT_INCR('v', "verbose", &verbose,
707 "be more verbose (show symbol address, etc)"),
708 OPT_BOOLEAN('F', "dont-fork", &dont_fork,
709 "Do not fork for testcase"),
712 const char * const test_subcommands[] = { "list", NULL };
713 struct intlist *skiplist = NULL;
714 int ret = hists__init();
719 argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
720 if (argc >= 1 && !strcmp(argv[0], "list"))
721 return perf_test__list(argc - 1, argv + 1);
723 symbol_conf.priv_size = sizeof(int);
724 symbol_conf.sort_by_name = true;
725 symbol_conf.try_vmlinux_path = true;
727 if (symbol__init(NULL) < 0)
731 skiplist = intlist__new(skip);
733 * Tests that create BPF maps, for instance, need more than the 64K
736 rlimit__bump_memlock();
738 return __cmd_test(argc, argv, skiplist);