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>
29 #include <linux/zalloc.h>
31 static bool dont_fork;
33 struct test __weak arch_tests[] = {
39 static struct test generic_tests[] = {
41 .desc = "vmlinux symtab matches kallsyms",
42 .func = test__vmlinux_matches_kallsyms,
45 .desc = "Detect openat syscall event",
46 .func = test__openat_syscall_event,
49 .desc = "Detect openat syscall event on all cpus",
50 .func = test__openat_syscall_event_on_all_cpus,
53 .desc = "Read samples using the mmap interface",
54 .func = test__basic_mmap,
57 .desc = "Test data source output",
61 .desc = "Parse event definition strings",
62 .func = test__parse_events,
65 .desc = "Simple expression parser",
69 .desc = "PERF_RECORD_* events & perf_sample fields",
70 .func = test__PERF_RECORD,
73 .desc = "Parse perf pmu format",
78 .func = test__pmu_events,
80 .skip_if_fail = false,
81 .get_nr = test__pmu_events_subtest_get_nr,
82 .get_desc = test__pmu_events_subtest_get_desc,
83 .skip_reason = test__pmu_events_subtest_skip_reason,
88 .desc = "DSO data read",
89 .func = test__dso_data,
92 .desc = "DSO data cache",
93 .func = test__dso_data_cache,
96 .desc = "DSO data reopen",
97 .func = test__dso_data_reopen,
100 .desc = "Roundtrip evsel->name",
101 .func = test__perf_evsel__roundtrip_name_test,
104 .desc = "Parse sched tracepoints fields",
105 .func = test__perf_evsel__tp_sched_test,
108 .desc = "syscalls:sys_enter_openat event fields",
109 .func = test__syscall_openat_tp_fields,
112 .desc = "Setup struct perf_event_attr",
116 .desc = "Match and link multiple hists",
117 .func = test__hists_link,
120 .desc = "'import perf' in python",
121 .func = test__python_use,
124 .desc = "Breakpoint overflow signal handler",
125 .func = test__bp_signal,
126 .is_supported = test__bp_signal_is_supported,
129 .desc = "Breakpoint overflow sampling",
130 .func = test__bp_signal_overflow,
131 .is_supported = test__bp_signal_is_supported,
134 .desc = "Breakpoint accounting",
135 .func = test__bp_accounting,
136 .is_supported = test__bp_account_is_supported,
139 .desc = "Watchpoint",
141 .is_supported = test__wp_is_supported,
143 .skip_if_fail = false,
144 .get_nr = test__wp_subtest_get_nr,
145 .get_desc = test__wp_subtest_get_desc,
146 .skip_reason = test__wp_subtest_skip_reason,
150 .desc = "Number of exit events of a simple workload",
151 .func = test__task_exit,
154 .desc = "Software clock events period values",
155 .func = test__sw_clock_freq,
158 .desc = "Object code reading",
159 .func = test__code_reading,
162 .desc = "Sample parsing",
163 .func = test__sample_parsing,
166 .desc = "Use a dummy software event to keep tracking",
167 .func = test__keep_tracking,
170 .desc = "Parse with no sample_id_all bit set",
171 .func = test__parse_no_sample_id_all,
174 .desc = "Filter hist entries",
175 .func = test__hists_filter,
178 .desc = "Lookup mmap thread",
179 .func = test__mmap_thread_lookup,
182 .desc = "Share thread maps",
183 .func = test__thread_maps_share,
186 .desc = "Sort output of hist entries",
187 .func = test__hists_output,
190 .desc = "Cumulate child hist entries",
191 .func = test__hists_cumulate,
194 .desc = "Track with sched_switch",
195 .func = test__switch_tracking,
198 .desc = "Filter fds with revents mask in a fdarray",
199 .func = test__fdarray__filter,
202 .desc = "Add fd to a fdarray, making it autogrow",
203 .func = test__fdarray__add,
206 .desc = "kmod_path__parse",
207 .func = test__kmod_path__parse,
210 .desc = "Thread map",
211 .func = test__thread_map,
214 .desc = "LLVM search and compile",
217 .skip_if_fail = true,
218 .get_nr = test__llvm_subtest_get_nr,
219 .get_desc = test__llvm_subtest_get_desc,
223 .desc = "Session topology",
224 .func = test__session_topology,
227 .desc = "BPF filter",
230 .skip_if_fail = true,
231 .get_nr = test__bpf_subtest_get_nr,
232 .get_desc = test__bpf_subtest_get_desc,
236 .desc = "Synthesize thread map",
237 .func = test__thread_map_synthesize,
240 .desc = "Remove thread map",
241 .func = test__thread_map_remove,
244 .desc = "Synthesize cpu map",
245 .func = test__cpu_map_synthesize,
248 .desc = "Synthesize stat config",
249 .func = test__synthesize_stat_config,
252 .desc = "Synthesize stat",
253 .func = test__synthesize_stat,
256 .desc = "Synthesize stat round",
257 .func = test__synthesize_stat_round,
260 .desc = "Synthesize attr update",
261 .func = test__event_update,
264 .desc = "Event times",
265 .func = test__event_times,
268 .desc = "Read backward ring buffer",
269 .func = test__backward_ring_buffer,
272 .desc = "Print cpu map",
273 .func = test__cpu_map_print,
276 .desc = "Merge cpu map",
277 .func = test__cpu_map_merge,
281 .desc = "Probe SDT events",
282 .func = test__sdt_event,
285 .desc = "is_printable_array",
286 .func = test__is_printable_array,
289 .desc = "Print bitmap",
290 .func = test__bitmap_print,
293 .desc = "perf hooks",
294 .func = test__perf_hooks,
297 .desc = "builtin clang support",
300 .skip_if_fail = true,
301 .get_nr = test__clang_subtest_get_nr,
302 .get_desc = test__clang_subtest_get_desc,
306 .desc = "unit_number__scnprintf",
307 .func = test__unit_number__scnprint,
311 .func = test__mem2node,
314 .desc = "time utils",
315 .func = test__time_utils,
318 .desc = "Test jit_write_elf",
319 .func = test__jit_write_elf,
322 .desc = "Test libpfm4 support",
325 .skip_if_fail = true,
326 .get_nr = test__pfm_subtest_get_nr,
327 .get_desc = test__pfm_subtest_get_desc,
331 .desc = "Test api io",
332 .func = test__api_io,
335 .desc = "maps__merge_in",
336 .func = test__maps__merge_in,
339 .desc = "Demangle Java",
340 .func = test__demangle_java,
343 .desc = "Demangle OCaml",
344 .func = test__demangle_ocaml,
347 .desc = "Parse and process metrics",
348 .func = test__parse_metric,
351 .desc = "PE file support",
352 .func = test__pe_file_parsing,
355 .desc = "Event expansion for cgroups",
356 .func = test__expand_cgroup_events,
359 .desc = "Convert perf time to TSC",
360 .func = test__perf_time_to_tsc,
361 .is_supported = test__tsc_is_supported,
364 .desc = "dlfilter C API",
365 .func = test__dlfilter,
372 static struct test *tests[] = {
377 static bool perf_test__matches(const char *desc, int curr, int argc, const char *argv[])
384 for (i = 0; i < argc; ++i) {
386 long nr = strtoul(argv[i], &end, 10);
394 if (strcasestr(desc, argv[i]))
401 static int run_test(struct test *test, int subtest)
403 int status, err = -1, child = dont_fork ? 0 : fork();
404 char sbuf[STRERR_BUFSIZE];
407 pr_err("failed to fork test: %s\n",
408 str_error_r(errno, sbuf, sizeof(sbuf)));
414 pr_debug("test child forked, pid %d\n", getpid());
417 int nullfd = open("/dev/null", O_WRONLY);
420 close(STDERR_FILENO);
421 close(STDOUT_FILENO);
423 dup2(nullfd, STDOUT_FILENO);
424 dup2(STDOUT_FILENO, STDERR_FILENO);
428 signal(SIGSEGV, sighandler_dump_stack);
429 signal(SIGFPE, sighandler_dump_stack);
433 err = test->func(test, subtest);
441 if (WIFEXITED(status)) {
442 err = (signed char)WEXITSTATUS(status);
443 pr_debug("test child finished with %d\n", err);
444 } else if (WIFSIGNALED(status)) {
446 pr_debug("test child interrupted\n");
453 #define for_each_test(j, t) \
454 for (j = 0; j < ARRAY_SIZE(tests); j++) \
455 for (t = &tests[j][0]; t->func; t++)
457 static int test_and_print(struct test *t, bool force_skip, int subtest)
462 pr_debug("\n--- start ---\n");
463 err = run_test(t, subtest);
464 pr_debug("---- end ----\n");
466 pr_debug("\n--- force skipped ---\n");
470 if (!t->subtest.get_nr)
471 pr_debug("%s:", t->desc);
473 pr_debug("%s subtest %d:", t->desc, subtest + 1);
480 const char *skip_reason = NULL;
481 if (t->subtest.skip_reason)
482 skip_reason = t->subtest.skip_reason(subtest);
484 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (%s)\n", skip_reason);
486 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
491 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
498 static const char *shell_test__description(char *description, size_t size,
499 const char *path, const char *name)
502 char filename[PATH_MAX];
504 path__join(filename, sizeof(filename), path, name);
505 fp = fopen(filename, "r");
510 while (fgetc(fp) != '\n');
512 description = fgets(description, size, fp);
515 return description ? strim(description + 1) : NULL;
518 #define for_each_shell_test(entlist, nr, base, ent) \
519 for (int __i = 0; __i < nr && (ent = entlist[__i]); __i++) \
520 if (!is_directory(base, ent) && ent->d_name[0] != '.')
522 static const char *shell_tests__dir(char *path, size_t size)
524 const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
528 for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
530 if (!lstat(devel_dirs[i], &st)) {
531 scnprintf(path, size, "%s/shell", devel_dirs[i]);
532 if (!lstat(devel_dirs[i], &st))
537 /* Then installed path. */
538 exec_path = get_argv_exec_path();
539 scnprintf(path, size, "%s/tests/shell", exec_path);
544 static int shell_tests__max_desc_width(void)
546 struct dirent **entlist;
549 char path_dir[PATH_MAX];
550 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
556 n_dirs = scandir(path, &entlist, NULL, alphasort);
560 for_each_shell_test(entlist, n_dirs, path, ent) {
562 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name);
565 int len = strlen(desc);
572 for (e = 0; e < n_dirs; e++)
583 static int shell_test__run(struct test *test, int subdir __maybe_unused)
586 char script[PATH_MAX];
587 struct shell_test *st = test->priv;
589 path__join(script, sizeof(script) - 3, st->dir, st->file);
592 strncat(script, " -v", sizeof(script) - strlen(script) - 1);
594 err = system(script);
598 return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL;
601 static int run_shell_tests(int argc, const char *argv[], int i, int width,
602 struct intlist *skiplist)
604 struct dirent **entlist;
607 char path_dir[PATH_MAX];
608 struct shell_test st = {
609 .dir = shell_tests__dir(path_dir, sizeof(path_dir)),
615 n_dirs = scandir(st.dir, &entlist, NULL, alphasort);
617 pr_err("failed to open shell test directory: %s\n",
622 for_each_shell_test(entlist, n_dirs, st.dir, ent) {
626 .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name),
627 .func = shell_test__run,
631 if (!perf_test__matches(test.desc, curr, argc, argv))
634 st.file = ent->d_name;
635 pr_info("%2d: %-*s:", i, width, test.desc);
637 if (intlist__find(skiplist, i)) {
638 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
642 test_and_print(&test, false, -1);
645 for (e = 0; e < n_dirs; e++)
651 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
656 int width = shell_tests__max_desc_width();
658 for_each_test(j, t) {
659 int len = strlen(t->desc);
665 for_each_test(j, t) {
669 if (!perf_test__matches(t->desc, curr, argc, argv)) {
673 if (!t->subtest.get_nr)
676 subn = t->subtest.get_nr();
678 for (subi = 0; subi < subn; subi++) {
679 if (perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv))
687 if (t->is_supported && !t->is_supported()) {
688 pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc);
692 pr_info("%2d: %-*s:", i, width, t->desc);
694 if (intlist__find(skiplist, i)) {
695 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
699 if (!t->subtest.get_nr) {
700 test_and_print(t, false, -1);
702 int subn = t->subtest.get_nr();
704 * minus 2 to align with normal testcases.
705 * For subtest we print additional '.x' in number.
708 * 35: Test LLVM searching and compiling :
709 * 35.1: Basic BPF llvm compiling test : Ok
711 int subw = width > 2 ? width - 2 : width;
715 color_fprintf(stderr, PERF_COLOR_YELLOW,
716 " Skip (not compiled in)\n");
721 for (subi = 0; subi < subn; subi++) {
722 int len = strlen(t->subtest.get_desc(subi));
728 for (subi = 0; subi < subn; subi++) {
729 if (!perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv))
732 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
733 t->subtest.get_desc(subi));
734 err = test_and_print(t, skip, subi);
735 if (err != TEST_OK && t->subtest.skip_if_fail)
741 return run_shell_tests(argc, argv, i, width, skiplist);
744 static int perf_test__list_shell(int argc, const char **argv, int i)
746 struct dirent **entlist;
749 char path_dir[PATH_MAX];
750 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
755 n_dirs = scandir(path, &entlist, NULL, alphasort);
759 for_each_shell_test(entlist, n_dirs, path, ent) {
763 .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name),
766 if (!perf_test__matches(t.desc, curr, argc, argv))
769 pr_info("%2d: %s\n", i, t.desc);
773 for (e = 0; e < n_dirs; e++)
779 static int perf_test__list(int argc, const char **argv)
785 for_each_test(j, t) {
788 if (!perf_test__matches(t->desc, curr, argc, argv) ||
789 (t->is_supported && !t->is_supported()))
792 pr_info("%2d: %s\n", i, t->desc);
794 if (t->subtest.get_nr) {
795 int subn = t->subtest.get_nr();
798 for (subi = 0; subi < subn; subi++)
799 pr_info("%2d:%1d: %s\n", i, subi + 1,
800 t->subtest.get_desc(subi));
804 perf_test__list_shell(argc, argv, i);
809 int cmd_test(int argc, const char **argv)
811 const char *test_usage[] = {
812 "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
815 const char *skip = NULL;
816 const struct option test_options[] = {
817 OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
818 OPT_INCR('v', "verbose", &verbose,
819 "be more verbose (show symbol address, etc)"),
820 OPT_BOOLEAN('F', "dont-fork", &dont_fork,
821 "Do not fork for testcase"),
824 const char * const test_subcommands[] = { "list", NULL };
825 struct intlist *skiplist = NULL;
826 int ret = hists__init();
831 argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
832 if (argc >= 1 && !strcmp(argv[0], "list"))
833 return perf_test__list(argc - 1, argv + 1);
835 symbol_conf.priv_size = sizeof(int);
836 symbol_conf.sort_by_name = true;
837 symbol_conf.try_vmlinux_path = true;
839 if (symbol__init(NULL) < 0)
843 skiplist = intlist__new(skip);
845 * Tests that create BPF maps, for instance, need more than the 64K
848 rlimit__bump_memlock();
850 return __cmd_test(argc, argv, skiplist);