// SPDX-License-Identifier: GPL-2.0 /* * builtin-test.c * * Builtin regression testing command: ever growing number of sanity tests */ #include #include #include #include #include #include #include #include #include #include "builtin.h" #include "hist.h" #include "intlist.h" #include "tests.h" #include "debug.h" #include "color.h" #include #include "string2.h" #include "symbol.h" #include "util/rlimit.h" #include #include #include #include static bool dont_fork; struct test *__weak arch_tests[] = { NULL, }; DEFINE_SUITE("vmlinux symtab matches kallsyms", vmlinux_matches_kallsyms); DEFINE_SUITE("Detect openat syscall event", openat_syscall_event); DEFINE_SUITE("Detect openat syscall event on all cpus", openat_syscall_event_on_all_cpus); DEFINE_SUITE("Read samples using the mmap interface", basic_mmap); DEFINE_SUITE("Test data source output", mem); DEFINE_SUITE("Parse event definition strings", parse_events); DEFINE_SUITE("Simple expression parser", expr); DEFINE_SUITE("PERF_RECORD_* events & perf_sample fields", PERF_RECORD); DEFINE_SUITE("Parse perf pmu format", pmu); static struct test pmu_events = { .desc = "PMU events", .func = test__pmu_events, .subtest = { .skip_if_fail = false, .get_nr = test__pmu_events_subtest_get_nr, .get_desc = test__pmu_events_subtest_get_desc, .skip_reason = test__pmu_events_subtest_skip_reason, }, }; DEFINE_SUITE("DSO data read", dso_data); DEFINE_SUITE("DSO data cache", dso_data_cache); DEFINE_SUITE("DSO data reopen", dso_data_reopen); DEFINE_SUITE("Roundtrip evsel->name", perf_evsel__roundtrip_name_test); DEFINE_SUITE("Parse sched tracepoints fields", perf_evsel__tp_sched_test); DEFINE_SUITE("syscalls:sys_enter_openat event fields", syscall_openat_tp_fields); DEFINE_SUITE("Setup struct perf_event_attr", attr); DEFINE_SUITE("Match and link multiple hists", hists_link); DEFINE_SUITE("'import perf' in python", python_use); static struct test bp_signal = { .desc = "Breakpoint overflow signal handler", .func = test__bp_signal, .is_supported = test__bp_signal_is_supported, }; static struct test bp_signal_overflow = { .desc = "Breakpoint overflow sampling", .func = test__bp_signal_overflow, .is_supported = test__bp_signal_is_supported, }; static struct test bp_accounting = { .desc = "Breakpoint accounting", .func = test__bp_accounting, .is_supported = test__bp_account_is_supported, }; static struct test wp = { .desc = "Watchpoint", .func = test__wp, .is_supported = test__wp_is_supported, .subtest = { .skip_if_fail = false, .get_nr = test__wp_subtest_get_nr, .get_desc = test__wp_subtest_get_desc, .skip_reason = test__wp_subtest_skip_reason, }, }; DEFINE_SUITE("Number of exit events of a simple workload", task_exit); DEFINE_SUITE("Software clock events period values", sw_clock_freq); DEFINE_SUITE("Object code reading", code_reading); DEFINE_SUITE("Sample parsing", sample_parsing); DEFINE_SUITE("Use a dummy software event to keep tracking", keep_tracking); DEFINE_SUITE("Parse with no sample_id_all bit set", parse_no_sample_id_all); DEFINE_SUITE("Filter hist entries", hists_filter); DEFINE_SUITE("Lookup mmap thread", mmap_thread_lookup); DEFINE_SUITE("Share thread maps", thread_maps_share); DEFINE_SUITE("Sort output of hist entries", hists_output); DEFINE_SUITE("Cumulate child hist entries", hists_cumulate); DEFINE_SUITE("Track with sched_switch", switch_tracking); DEFINE_SUITE("Filter fds with revents mask in a fdarray", fdarray__filter); DEFINE_SUITE("Add fd to a fdarray, making it autogrow", fdarray__add); DEFINE_SUITE("kmod_path__parse", kmod_path__parse); DEFINE_SUITE("Thread map", thread_map); static struct test llvm = { .desc = "LLVM search and compile", .func = test__llvm, .subtest = { .skip_if_fail = true, .get_nr = test__llvm_subtest_get_nr, .get_desc = test__llvm_subtest_get_desc, }, }; DEFINE_SUITE("Session topology", session_topology); static struct test bpf = { .desc = "BPF filter", .func = test__bpf, .subtest = { .skip_if_fail = true, .get_nr = test__bpf_subtest_get_nr, .get_desc = test__bpf_subtest_get_desc, }, }; DEFINE_SUITE("Synthesize thread map", thread_map_synthesize); DEFINE_SUITE("Remove thread map", thread_map_remove); DEFINE_SUITE("Synthesize cpu map", cpu_map_synthesize); DEFINE_SUITE("Synthesize stat config", synthesize_stat_config); DEFINE_SUITE("Synthesize stat", synthesize_stat); DEFINE_SUITE("Synthesize stat round", synthesize_stat_round); DEFINE_SUITE("Synthesize attr update", event_update); DEFINE_SUITE("Event times", event_times); DEFINE_SUITE("Read backward ring buffer", backward_ring_buffer); DEFINE_SUITE("Print cpu map", cpu_map_print); DEFINE_SUITE("Merge cpu map", cpu_map_merge); DEFINE_SUITE("Probe SDT events", sdt_event); DEFINE_SUITE("is_printable_array", is_printable_array); DEFINE_SUITE("Print bitmap", bitmap_print); DEFINE_SUITE("perf hooks", perf_hooks); static struct test clang = { .desc = "builtin clang support", .func = test__clang, .subtest = { .skip_if_fail = true, .get_nr = test__clang_subtest_get_nr, .get_desc = test__clang_subtest_get_desc, } }; DEFINE_SUITE("unit_number__scnprintf", unit_number__scnprint); DEFINE_SUITE("mem2node", mem2node); DEFINE_SUITE("time utils", time_utils); DEFINE_SUITE("Test jit_write_elf", jit_write_elf); static struct test pfm = { .desc = "Test libpfm4 support", .func = test__pfm, .subtest = { .skip_if_fail = true, .get_nr = test__pfm_subtest_get_nr, .get_desc = test__pfm_subtest_get_desc, } }; DEFINE_SUITE("Test api io", api_io); DEFINE_SUITE("maps__merge_in", maps__merge_in); DEFINE_SUITE("Demangle Java", demangle_java); DEFINE_SUITE("Demangle OCaml", demangle_ocaml); DEFINE_SUITE("Parse and process metrics", parse_metric); DEFINE_SUITE("PE file support", pe_file_parsing); DEFINE_SUITE("Event expansion for cgroups", expand_cgroup_events); static struct test perf_time_to_tsc = { .desc = "Convert perf time to TSC", .func = test__perf_time_to_tsc, .is_supported = test__tsc_is_supported, }; DEFINE_SUITE("dlfilter C API", dlfilter); static struct test *generic_tests[] = { &vmlinux_matches_kallsyms, &openat_syscall_event, &openat_syscall_event_on_all_cpus, &basic_mmap, &mem, &parse_events, &expr, &PERF_RECORD, &pmu, &pmu_events, &dso_data, &dso_data_cache, &dso_data_reopen, &perf_evsel__roundtrip_name_test, &perf_evsel__tp_sched_test, &syscall_openat_tp_fields, &attr, &hists_link, &python_use, &bp_signal, &bp_signal_overflow, &bp_accounting, &wp, &task_exit, &sw_clock_freq, &code_reading, &sample_parsing, &keep_tracking, &parse_no_sample_id_all, &hists_filter, &mmap_thread_lookup, &thread_maps_share, &hists_output, &hists_cumulate, &switch_tracking, &fdarray__filter, &fdarray__add, &kmod_path__parse, &thread_map, &llvm, &session_topology, &bpf, &thread_map_synthesize, &thread_map_remove, &cpu_map_synthesize, &synthesize_stat_config, &synthesize_stat, &synthesize_stat_round, &event_update, &event_times, &backward_ring_buffer, &cpu_map_print, &cpu_map_merge, &sdt_event, &is_printable_array, &bitmap_print, &perf_hooks, &clang, &unit_number__scnprint, &mem2node, &time_utils, &jit_write_elf, &pfm, &api_io, &maps__merge_in, &demangle_java, &demangle_ocaml, &parse_metric, &pe_file_parsing, &expand_cgroup_events, &perf_time_to_tsc, &dlfilter, NULL, }; static struct test **tests[] = { generic_tests, arch_tests, }; static bool perf_test__matches(const char *desc, int curr, int argc, const char *argv[]) { int i; if (argc == 0) return true; for (i = 0; i < argc; ++i) { char *end; long nr = strtoul(argv[i], &end, 10); if (*end == '\0') { if (nr == curr + 1) return true; continue; } if (strcasestr(desc, argv[i])) return true; } return false; } static int run_test(struct test *test, int subtest) { int status, err = -1, child = dont_fork ? 0 : fork(); char sbuf[STRERR_BUFSIZE]; if (child < 0) { pr_err("failed to fork test: %s\n", str_error_r(errno, sbuf, sizeof(sbuf))); return -1; } if (!child) { if (!dont_fork) { pr_debug("test child forked, pid %d\n", getpid()); if (verbose <= 0) { int nullfd = open("/dev/null", O_WRONLY); if (nullfd >= 0) { close(STDERR_FILENO); close(STDOUT_FILENO); dup2(nullfd, STDOUT_FILENO); dup2(STDOUT_FILENO, STDERR_FILENO); close(nullfd); } } else { signal(SIGSEGV, sighandler_dump_stack); signal(SIGFPE, sighandler_dump_stack); } } err = test->func(test, subtest); if (!dont_fork) exit(err); } if (!dont_fork) { wait(&status); if (WIFEXITED(status)) { err = (signed char)WEXITSTATUS(status); pr_debug("test child finished with %d\n", err); } else if (WIFSIGNALED(status)) { err = -1; pr_debug("test child interrupted\n"); } } return err; } #define for_each_test(j, k, t) \ for (j = 0; j < ARRAY_SIZE(tests); j++) \ for (k = 0, t = tests[j][k]; tests[j][k]; k++, t = tests[j][k]) static int test_and_print(struct test *t, bool force_skip, int subtest) { int err; if (!force_skip) { pr_debug("\n--- start ---\n"); err = run_test(t, subtest); pr_debug("---- end ----\n"); } else { pr_debug("\n--- force skipped ---\n"); err = TEST_SKIP; } if (!t->subtest.get_nr) pr_debug("%s:", t->desc); else pr_debug("%s subtest %d:", t->desc, subtest + 1); switch (err) { case TEST_OK: pr_info(" Ok\n"); break; case TEST_SKIP: { const char *skip_reason = NULL; if (t->subtest.skip_reason) skip_reason = t->subtest.skip_reason(subtest); if (skip_reason) color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (%s)\n", skip_reason); else color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n"); } break; case TEST_FAIL: default: color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n"); break; } return err; } static const char *shell_test__description(char *description, size_t size, const char *path, const char *name) { FILE *fp; char filename[PATH_MAX]; path__join(filename, sizeof(filename), path, name); fp = fopen(filename, "r"); if (!fp) return NULL; /* Skip shebang */ while (fgetc(fp) != '\n'); description = fgets(description, size, fp); fclose(fp); return description ? strim(description + 1) : NULL; } #define for_each_shell_test(entlist, nr, base, ent) \ for (int __i = 0; __i < nr && (ent = entlist[__i]); __i++) \ if (!is_directory(base, ent) && ent->d_name[0] != '.') static const char *shell_tests__dir(char *path, size_t size) { const char *devel_dirs[] = { "./tools/perf/tests", "./tests", }; char *exec_path; unsigned int i; for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) { struct stat st; if (!lstat(devel_dirs[i], &st)) { scnprintf(path, size, "%s/shell", devel_dirs[i]); if (!lstat(devel_dirs[i], &st)) return path; } } /* Then installed path. */ exec_path = get_argv_exec_path(); scnprintf(path, size, "%s/tests/shell", exec_path); free(exec_path); return path; } static int shell_tests__max_desc_width(void) { struct dirent **entlist; struct dirent *ent; int n_dirs, e; char path_dir[PATH_MAX]; const char *path = shell_tests__dir(path_dir, sizeof(path_dir)); int width = 0; if (path == NULL) return -1; n_dirs = scandir(path, &entlist, NULL, alphasort); if (n_dirs == -1) return -1; for_each_shell_test(entlist, n_dirs, path, ent) { char bf[256]; const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name); if (desc) { int len = strlen(desc); if (width < len) width = len; } } for (e = 0; e < n_dirs; e++) zfree(&entlist[e]); free(entlist); return width; } struct shell_test { const char *dir; const char *file; }; static int shell_test__run(struct test *test, int subdir __maybe_unused) { int err; char script[PATH_MAX]; struct shell_test *st = test->priv; path__join(script, sizeof(script) - 3, st->dir, st->file); if (verbose) strncat(script, " -v", sizeof(script) - strlen(script) - 1); err = system(script); if (!err) return TEST_OK; return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL; } static int run_shell_tests(int argc, const char *argv[], int i, int width, struct intlist *skiplist) { struct dirent **entlist; struct dirent *ent; int n_dirs, e; char path_dir[PATH_MAX]; struct shell_test st = { .dir = shell_tests__dir(path_dir, sizeof(path_dir)), }; if (st.dir == NULL) return -1; n_dirs = scandir(st.dir, &entlist, NULL, alphasort); if (n_dirs == -1) { pr_err("failed to open shell test directory: %s\n", st.dir); return -1; } for_each_shell_test(entlist, n_dirs, st.dir, ent) { int curr = i++; char desc[256]; struct test test = { .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name), .func = shell_test__run, .priv = &st, }; if (!perf_test__matches(test.desc, curr, argc, argv)) continue; st.file = ent->d_name; pr_info("%2d: %-*s:", i, width, test.desc); if (intlist__find(skiplist, i)) { color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n"); continue; } test_and_print(&test, false, -1); } for (e = 0; e < n_dirs; e++) zfree(&entlist[e]); free(entlist); return 0; } static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist) { struct test *t; unsigned int j, k; int i = 0; int width = shell_tests__max_desc_width(); for_each_test(j, k, t) { int len = strlen(t->desc); if (width < len) width = len; } for_each_test(j, k, t) { int curr = i++, err; int subi; if (!perf_test__matches(t->desc, curr, argc, argv)) { bool skip = true; int subn; if (!t->subtest.get_nr) continue; subn = t->subtest.get_nr(); for (subi = 0; subi < subn; subi++) { if (perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv)) skip = false; } if (skip) continue; } if (t->is_supported && !t->is_supported()) { pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc); continue; } pr_info("%2d: %-*s:", i, width, t->desc); if (intlist__find(skiplist, i)) { color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n"); continue; } if (!t->subtest.get_nr) { test_and_print(t, false, -1); } else { int subn = t->subtest.get_nr(); /* * minus 2 to align with normal testcases. * For subtest we print additional '.x' in number. * for example: * * 35: Test LLVM searching and compiling : * 35.1: Basic BPF llvm compiling test : Ok */ int subw = width > 2 ? width - 2 : width; bool skip = false; if (subn <= 0) { color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (not compiled in)\n"); continue; } pr_info("\n"); for (subi = 0; subi < subn; subi++) { int len = strlen(t->subtest.get_desc(subi)); if (subw < len) subw = len; } for (subi = 0; subi < subn; subi++) { if (!perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv)) continue; pr_info("%2d.%1d: %-*s:", i, subi + 1, subw, t->subtest.get_desc(subi)); err = test_and_print(t, skip, subi); if (err != TEST_OK && t->subtest.skip_if_fail) skip = true; } } } return run_shell_tests(argc, argv, i, width, skiplist); } static int perf_test__list_shell(int argc, const char **argv, int i) { struct dirent **entlist; struct dirent *ent; int n_dirs, e; char path_dir[PATH_MAX]; const char *path = shell_tests__dir(path_dir, sizeof(path_dir)); if (path == NULL) return -1; n_dirs = scandir(path, &entlist, NULL, alphasort); if (n_dirs == -1) return -1; for_each_shell_test(entlist, n_dirs, path, ent) { int curr = i++; char bf[256]; struct test t = { .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name), }; if (!perf_test__matches(t.desc, curr, argc, argv)) continue; pr_info("%2d: %s\n", i, t.desc); } for (e = 0; e < n_dirs; e++) zfree(&entlist[e]); free(entlist); return 0; } static int perf_test__list(int argc, const char **argv) { unsigned int j, k; struct test *t; int i = 0; for_each_test(j, k, t) { int curr = i++; if (!perf_test__matches(t->desc, curr, argc, argv) || (t->is_supported && !t->is_supported())) continue; pr_info("%2d: %s\n", i, t->desc); if (t->subtest.get_nr) { int subn = t->subtest.get_nr(); int subi; for (subi = 0; subi < subn; subi++) pr_info("%2d:%1d: %s\n", i, subi + 1, t->subtest.get_desc(subi)); } } perf_test__list_shell(argc, argv, i); return 0; } int cmd_test(int argc, const char **argv) { const char *test_usage[] = { "perf test [] [{list |[|]}]", NULL, }; const char *skip = NULL; const struct option test_options[] = { OPT_STRING('s', "skip", &skip, "tests", "tests to skip"), OPT_INCR('v', "verbose", &verbose, "be more verbose (show symbol address, etc)"), OPT_BOOLEAN('F', "dont-fork", &dont_fork, "Do not fork for testcase"), OPT_END() }; const char * const test_subcommands[] = { "list", NULL }; struct intlist *skiplist = NULL; int ret = hists__init(); if (ret < 0) return ret; argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0); if (argc >= 1 && !strcmp(argv[0], "list")) return perf_test__list(argc - 1, argv + 1); symbol_conf.priv_size = sizeof(int); symbol_conf.sort_by_name = true; symbol_conf.try_vmlinux_path = true; if (symbol__init(NULL) < 0) return -1; if (skip != NULL) skiplist = intlist__new(skip); /* * Tests that create BPF maps, for instance, need more than the 64K * default: */ rlimit__bump_memlock(); return __cmd_test(argc, argv, skiplist); }