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",
77 .func = test__pmu_events,
79 .skip_if_fail = false,
80 .get_nr = test__pmu_events_subtest_get_nr,
81 .get_desc = test__pmu_events_subtest_get_desc,
82 .skip_reason = test__pmu_events_subtest_skip_reason,
87 .desc = "DSO data read",
88 .func = test__dso_data,
91 .desc = "DSO data cache",
92 .func = test__dso_data_cache,
95 .desc = "DSO data reopen",
96 .func = test__dso_data_reopen,
99 .desc = "Roundtrip evsel->name",
100 .func = test__perf_evsel__roundtrip_name_test,
103 .desc = "Parse sched tracepoints fields",
104 .func = test__perf_evsel__tp_sched_test,
107 .desc = "syscalls:sys_enter_openat event fields",
108 .func = test__syscall_openat_tp_fields,
111 .desc = "Setup struct perf_event_attr",
115 .desc = "Match and link multiple hists",
116 .func = test__hists_link,
119 .desc = "'import perf' in python",
120 .func = test__python_use,
123 .desc = "Breakpoint overflow signal handler",
124 .func = test__bp_signal,
125 .is_supported = test__bp_signal_is_supported,
128 .desc = "Breakpoint overflow sampling",
129 .func = test__bp_signal_overflow,
130 .is_supported = test__bp_signal_is_supported,
133 .desc = "Breakpoint accounting",
134 .func = test__bp_accounting,
135 .is_supported = test__bp_account_is_supported,
138 .desc = "Watchpoint",
140 .is_supported = test__wp_is_supported,
142 .skip_if_fail = false,
143 .get_nr = test__wp_subtest_get_nr,
144 .get_desc = test__wp_subtest_get_desc,
145 .skip_reason = test__wp_subtest_skip_reason,
149 .desc = "Number of exit events of a simple workload",
150 .func = test__task_exit,
153 .desc = "Software clock events period values",
154 .func = test__sw_clock_freq,
157 .desc = "Object code reading",
158 .func = test__code_reading,
161 .desc = "Sample parsing",
162 .func = test__sample_parsing,
165 .desc = "Use a dummy software event to keep tracking",
166 .func = test__keep_tracking,
169 .desc = "Parse with no sample_id_all bit set",
170 .func = test__parse_no_sample_id_all,
173 .desc = "Filter hist entries",
174 .func = test__hists_filter,
177 .desc = "Lookup mmap thread",
178 .func = test__mmap_thread_lookup,
181 .desc = "Share thread maps",
182 .func = test__thread_maps_share,
185 .desc = "Sort output of hist entries",
186 .func = test__hists_output,
189 .desc = "Cumulate child hist entries",
190 .func = test__hists_cumulate,
193 .desc = "Track with sched_switch",
194 .func = test__switch_tracking,
197 .desc = "Filter fds with revents mask in a fdarray",
198 .func = test__fdarray__filter,
201 .desc = "Add fd to a fdarray, making it autogrow",
202 .func = test__fdarray__add,
205 .desc = "kmod_path__parse",
206 .func = test__kmod_path__parse,
209 .desc = "Thread map",
210 .func = test__thread_map,
213 .desc = "LLVM search and compile",
216 .skip_if_fail = true,
217 .get_nr = test__llvm_subtest_get_nr,
218 .get_desc = test__llvm_subtest_get_desc,
222 .desc = "Session topology",
223 .func = test__session_topology,
226 .desc = "BPF filter",
229 .skip_if_fail = true,
230 .get_nr = test__bpf_subtest_get_nr,
231 .get_desc = test__bpf_subtest_get_desc,
235 .desc = "Synthesize thread map",
236 .func = test__thread_map_synthesize,
239 .desc = "Remove thread map",
240 .func = test__thread_map_remove,
243 .desc = "Synthesize cpu map",
244 .func = test__cpu_map_synthesize,
247 .desc = "Synthesize stat config",
248 .func = test__synthesize_stat_config,
251 .desc = "Synthesize stat",
252 .func = test__synthesize_stat,
255 .desc = "Synthesize stat round",
256 .func = test__synthesize_stat_round,
259 .desc = "Synthesize attr update",
260 .func = test__event_update,
263 .desc = "Event times",
264 .func = test__event_times,
267 .desc = "Read backward ring buffer",
268 .func = test__backward_ring_buffer,
271 .desc = "Print cpu map",
272 .func = test__cpu_map_print,
275 .desc = "Merge cpu map",
276 .func = test__cpu_map_merge,
280 .desc = "Probe SDT events",
281 .func = test__sdt_event,
284 .desc = "is_printable_array",
285 .func = test__is_printable_array,
288 .desc = "Print bitmap",
289 .func = test__bitmap_print,
292 .desc = "perf hooks",
293 .func = test__perf_hooks,
296 .desc = "builtin clang support",
299 .skip_if_fail = true,
300 .get_nr = test__clang_subtest_get_nr,
301 .get_desc = test__clang_subtest_get_desc,
305 .desc = "unit_number__scnprintf",
306 .func = test__unit_number__scnprint,
310 .func = test__mem2node,
313 .desc = "time utils",
314 .func = test__time_utils,
317 .desc = "Test jit_write_elf",
318 .func = test__jit_write_elf,
321 .desc = "Test libpfm4 support",
324 .skip_if_fail = true,
325 .get_nr = test__pfm_subtest_get_nr,
326 .get_desc = test__pfm_subtest_get_desc,
330 .desc = "Test api io",
331 .func = test__api_io,
334 .desc = "maps__merge_in",
335 .func = test__maps__merge_in,
338 .desc = "Demangle Java",
339 .func = test__demangle_java,
342 .desc = "Demangle OCaml",
343 .func = test__demangle_ocaml,
346 .desc = "Parse and process metrics",
347 .func = test__parse_metric,
350 .desc = "PE file support",
351 .func = test__pe_file_parsing,
354 .desc = "Event expansion for cgroups",
355 .func = test__expand_cgroup_events,
358 .desc = "Convert perf time to TSC",
359 .func = test__perf_time_to_tsc,
360 .is_supported = test__tsc_is_supported,
367 static struct test *tests[] = {
372 static bool perf_test__matches(const char *desc, int curr, int argc, const char *argv[])
379 for (i = 0; i < argc; ++i) {
381 long nr = strtoul(argv[i], &end, 10);
389 if (strcasestr(desc, argv[i]))
396 static int run_test(struct test *test, int subtest)
398 int status, err = -1, child = dont_fork ? 0 : fork();
399 char sbuf[STRERR_BUFSIZE];
402 pr_err("failed to fork test: %s\n",
403 str_error_r(errno, sbuf, sizeof(sbuf)));
409 pr_debug("test child forked, pid %d\n", getpid());
412 int nullfd = open("/dev/null", O_WRONLY);
415 close(STDERR_FILENO);
416 close(STDOUT_FILENO);
418 dup2(nullfd, STDOUT_FILENO);
419 dup2(STDOUT_FILENO, STDERR_FILENO);
423 signal(SIGSEGV, sighandler_dump_stack);
424 signal(SIGFPE, sighandler_dump_stack);
428 err = test->func(test, subtest);
436 if (WIFEXITED(status)) {
437 err = (signed char)WEXITSTATUS(status);
438 pr_debug("test child finished with %d\n", err);
439 } else if (WIFSIGNALED(status)) {
441 pr_debug("test child interrupted\n");
448 #define for_each_test(j, t) \
449 for (j = 0; j < ARRAY_SIZE(tests); j++) \
450 for (t = &tests[j][0]; t->func; t++)
452 static int test_and_print(struct test *t, bool force_skip, int subtest)
457 pr_debug("\n--- start ---\n");
458 err = run_test(t, subtest);
459 pr_debug("---- end ----\n");
461 pr_debug("\n--- force skipped ---\n");
465 if (!t->subtest.get_nr)
466 pr_debug("%s:", t->desc);
468 pr_debug("%s subtest %d:", t->desc, subtest + 1);
475 const char *skip_reason = NULL;
476 if (t->subtest.skip_reason)
477 skip_reason = t->subtest.skip_reason(subtest);
479 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (%s)\n", skip_reason);
481 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
486 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
493 static const char *shell_test__description(char *description, size_t size,
494 const char *path, const char *name)
497 char filename[PATH_MAX];
499 path__join(filename, sizeof(filename), path, name);
500 fp = fopen(filename, "r");
505 while (fgetc(fp) != '\n');
507 description = fgets(description, size, fp);
510 return description ? strim(description + 1) : NULL;
513 #define for_each_shell_test(entlist, nr, base, ent) \
514 for (int __i = 0; __i < nr && (ent = entlist[__i]); __i++) \
515 if (!is_directory(base, ent) && ent->d_name[0] != '.')
517 static const char *shell_tests__dir(char *path, size_t size)
519 const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
523 for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
525 if (!lstat(devel_dirs[i], &st)) {
526 scnprintf(path, size, "%s/shell", devel_dirs[i]);
527 if (!lstat(devel_dirs[i], &st))
532 /* Then installed path. */
533 exec_path = get_argv_exec_path();
534 scnprintf(path, size, "%s/tests/shell", exec_path);
539 static int shell_tests__max_desc_width(void)
541 struct dirent **entlist;
544 char path_dir[PATH_MAX];
545 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
551 n_dirs = scandir(path, &entlist, NULL, alphasort);
555 for_each_shell_test(entlist, n_dirs, path, ent) {
557 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name);
560 int len = strlen(desc);
577 static int shell_test__run(struct test *test, int subdir __maybe_unused)
580 char script[PATH_MAX];
581 struct shell_test *st = test->priv;
583 path__join(script, sizeof(script) - 3, st->dir, st->file);
586 strncat(script, " -v", sizeof(script) - strlen(script) - 1);
588 err = system(script);
592 return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL;
595 static int run_shell_tests(int argc, const char *argv[], int i, int width)
597 struct dirent **entlist;
600 char path_dir[PATH_MAX];
601 struct shell_test st = {
602 .dir = shell_tests__dir(path_dir, sizeof(path_dir)),
608 n_dirs = scandir(st.dir, &entlist, NULL, alphasort);
610 pr_err("failed to open shell test directory: %s\n",
615 for_each_shell_test(entlist, n_dirs, st.dir, ent) {
619 .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name),
620 .func = shell_test__run,
624 if (!perf_test__matches(test.desc, curr, argc, argv))
627 st.file = ent->d_name;
628 pr_info("%2d: %-*s:", i, width, test.desc);
629 test_and_print(&test, false, -1);
636 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
641 int width = shell_tests__max_desc_width();
643 for_each_test(j, t) {
644 int len = strlen(t->desc);
650 for_each_test(j, t) {
654 if (!perf_test__matches(t->desc, curr, argc, argv)) {
658 if (!t->subtest.get_nr)
661 subn = t->subtest.get_nr();
663 for (subi = 0; subi < subn; subi++) {
664 if (perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv))
672 if (t->is_supported && !t->is_supported()) {
673 pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc);
677 pr_info("%2d: %-*s:", i, width, t->desc);
679 if (intlist__find(skiplist, i)) {
680 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
684 if (!t->subtest.get_nr) {
685 test_and_print(t, false, -1);
687 int subn = t->subtest.get_nr();
689 * minus 2 to align with normal testcases.
690 * For subtest we print additional '.x' in number.
693 * 35: Test LLVM searching and compiling :
694 * 35.1: Basic BPF llvm compiling test : Ok
696 int subw = width > 2 ? width - 2 : width;
700 color_fprintf(stderr, PERF_COLOR_YELLOW,
701 " Skip (not compiled in)\n");
706 for (subi = 0; subi < subn; subi++) {
707 int len = strlen(t->subtest.get_desc(subi));
713 for (subi = 0; subi < subn; subi++) {
714 if (!perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv))
717 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
718 t->subtest.get_desc(subi));
719 err = test_and_print(t, skip, subi);
720 if (err != TEST_OK && t->subtest.skip_if_fail)
726 return run_shell_tests(argc, argv, i, width);
729 static int perf_test__list_shell(int argc, const char **argv, int i)
731 struct dirent **entlist;
734 char path_dir[PATH_MAX];
735 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
740 n_dirs = scandir(path, &entlist, NULL, alphasort);
744 for_each_shell_test(entlist, n_dirs, path, ent) {
748 .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name),
751 if (!perf_test__matches(t.desc, curr, argc, argv))
754 pr_info("%2d: %s\n", i, t.desc);
761 static int perf_test__list(int argc, const char **argv)
767 for_each_test(j, t) {
770 if (!perf_test__matches(t->desc, curr, argc, argv) ||
771 (t->is_supported && !t->is_supported()))
774 pr_info("%2d: %s\n", i, t->desc);
776 if (t->subtest.get_nr) {
777 int subn = t->subtest.get_nr();
780 for (subi = 0; subi < subn; subi++)
781 pr_info("%2d:%1d: %s\n", i, subi + 1,
782 t->subtest.get_desc(subi));
786 perf_test__list_shell(argc, argv, i);
791 int cmd_test(int argc, const char **argv)
793 const char *test_usage[] = {
794 "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
797 const char *skip = NULL;
798 const struct option test_options[] = {
799 OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
800 OPT_INCR('v', "verbose", &verbose,
801 "be more verbose (show symbol address, etc)"),
802 OPT_BOOLEAN('F', "dont-fork", &dont_fork,
803 "Do not fork for testcase"),
806 const char * const test_subcommands[] = { "list", NULL };
807 struct intlist *skiplist = NULL;
808 int ret = hists__init();
813 argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
814 if (argc >= 1 && !strcmp(argv[0], "list"))
815 return perf_test__list(argc - 1, argv + 1);
817 symbol_conf.priv_size = sizeof(int);
818 symbol_conf.sort_by_name = true;
819 symbol_conf.try_vmlinux_path = true;
821 if (symbol__init(NULL) < 0)
825 skiplist = intlist__new(skip);
827 * Tests that create BPF maps, for instance, need more than the 64K
830 rlimit__bump_memlock();
832 return __cmd_test(argc, argv, skiplist);