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
,
148 .desc
= "Number of exit events of a simple workload",
149 .func
= test__task_exit
,
152 .desc
= "Software clock events period values",
153 .func
= test__sw_clock_freq
,
156 .desc
= "Object code reading",
157 .func
= test__code_reading
,
160 .desc
= "Sample parsing",
161 .func
= test__sample_parsing
,
164 .desc
= "Use a dummy software event to keep tracking",
165 .func
= test__keep_tracking
,
168 .desc
= "Parse with no sample_id_all bit set",
169 .func
= test__parse_no_sample_id_all
,
172 .desc
= "Filter hist entries",
173 .func
= test__hists_filter
,
176 .desc
= "Lookup mmap thread",
177 .func
= test__mmap_thread_lookup
,
180 .desc
= "Share thread maps",
181 .func
= test__thread_maps_share
,
184 .desc
= "Sort output of hist entries",
185 .func
= test__hists_output
,
188 .desc
= "Cumulate child hist entries",
189 .func
= test__hists_cumulate
,
192 .desc
= "Track with sched_switch",
193 .func
= test__switch_tracking
,
196 .desc
= "Filter fds with revents mask in a fdarray",
197 .func
= test__fdarray__filter
,
200 .desc
= "Add fd to a fdarray, making it autogrow",
201 .func
= test__fdarray__add
,
204 .desc
= "kmod_path__parse",
205 .func
= test__kmod_path__parse
,
208 .desc
= "Thread map",
209 .func
= test__thread_map
,
212 .desc
= "LLVM search and compile",
215 .skip_if_fail
= true,
216 .get_nr
= test__llvm_subtest_get_nr
,
217 .get_desc
= test__llvm_subtest_get_desc
,
221 .desc
= "Session topology",
222 .func
= test__session_topology
,
225 .desc
= "BPF filter",
228 .skip_if_fail
= true,
229 .get_nr
= test__bpf_subtest_get_nr
,
230 .get_desc
= test__bpf_subtest_get_desc
,
234 .desc
= "Synthesize thread map",
235 .func
= test__thread_map_synthesize
,
238 .desc
= "Remove thread map",
239 .func
= test__thread_map_remove
,
242 .desc
= "Synthesize cpu map",
243 .func
= test__cpu_map_synthesize
,
246 .desc
= "Synthesize stat config",
247 .func
= test__synthesize_stat_config
,
250 .desc
= "Synthesize stat",
251 .func
= test__synthesize_stat
,
254 .desc
= "Synthesize stat round",
255 .func
= test__synthesize_stat_round
,
258 .desc
= "Synthesize attr update",
259 .func
= test__event_update
,
262 .desc
= "Event times",
263 .func
= test__event_times
,
266 .desc
= "Read backward ring buffer",
267 .func
= test__backward_ring_buffer
,
270 .desc
= "Print cpu map",
271 .func
= test__cpu_map_print
,
274 .desc
= "Merge cpu map",
275 .func
= test__cpu_map_merge
,
279 .desc
= "Probe SDT events",
280 .func
= test__sdt_event
,
283 .desc
= "is_printable_array",
284 .func
= test__is_printable_array
,
287 .desc
= "Print bitmap",
288 .func
= test__bitmap_print
,
291 .desc
= "perf hooks",
292 .func
= test__perf_hooks
,
295 .desc
= "builtin clang support",
298 .skip_if_fail
= true,
299 .get_nr
= test__clang_subtest_get_nr
,
300 .get_desc
= test__clang_subtest_get_desc
,
304 .desc
= "unit_number__scnprintf",
305 .func
= test__unit_number__scnprint
,
309 .func
= test__mem2node
,
312 .desc
= "time utils",
313 .func
= test__time_utils
,
316 .desc
= "Test jit_write_elf",
317 .func
= test__jit_write_elf
,
320 .desc
= "Test libpfm4 support",
323 .skip_if_fail
= true,
324 .get_nr
= test__pfm_subtest_get_nr
,
325 .get_desc
= test__pfm_subtest_get_desc
,
329 .desc
= "Test api io",
330 .func
= test__api_io
,
333 .desc
= "maps__merge_in",
334 .func
= test__maps__merge_in
,
337 .desc
= "Demangle Java",
338 .func
= test__demangle_java
,
341 .desc
= "Parse and process metrics",
342 .func
= test__parse_metric
,
349 static struct test
*tests
[] = {
354 static bool perf_test__matches(const char *desc
, int curr
, int argc
, const char *argv
[])
361 for (i
= 0; i
< argc
; ++i
) {
363 long nr
= strtoul(argv
[i
], &end
, 10);
371 if (strcasestr(desc
, argv
[i
]))
378 static int run_test(struct test
*test
, int subtest
)
380 int status
, err
= -1, child
= dont_fork
? 0 : fork();
381 char sbuf
[STRERR_BUFSIZE
];
384 pr_err("failed to fork test: %s\n",
385 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
391 pr_debug("test child forked, pid %d\n", getpid());
394 int nullfd
= open("/dev/null", O_WRONLY
);
397 close(STDERR_FILENO
);
398 close(STDOUT_FILENO
);
400 dup2(nullfd
, STDOUT_FILENO
);
401 dup2(STDOUT_FILENO
, STDERR_FILENO
);
405 signal(SIGSEGV
, sighandler_dump_stack
);
406 signal(SIGFPE
, sighandler_dump_stack
);
410 err
= test
->func(test
, subtest
);
418 if (WIFEXITED(status
)) {
419 err
= (signed char)WEXITSTATUS(status
);
420 pr_debug("test child finished with %d\n", err
);
421 } else if (WIFSIGNALED(status
)) {
423 pr_debug("test child interrupted\n");
430 #define for_each_test(j, t) \
431 for (j = 0; j < ARRAY_SIZE(tests); j++) \
432 for (t = &tests[j][0]; t->func; t++)
434 static int test_and_print(struct test
*t
, bool force_skip
, int subtest
)
439 pr_debug("\n--- start ---\n");
440 err
= run_test(t
, subtest
);
441 pr_debug("---- end ----\n");
443 pr_debug("\n--- force skipped ---\n");
447 if (!t
->subtest
.get_nr
)
448 pr_debug("%s:", t
->desc
);
450 pr_debug("%s subtest %d:", t
->desc
, subtest
+ 1);
457 const char *skip_reason
= NULL
;
458 if (t
->subtest
.skip_reason
)
459 skip_reason
= t
->subtest
.skip_reason(subtest
);
461 color_fprintf(stderr
, PERF_COLOR_YELLOW
, " Skip (%s)\n", skip_reason
);
463 color_fprintf(stderr
, PERF_COLOR_YELLOW
, " Skip\n");
468 color_fprintf(stderr
, PERF_COLOR_RED
, " FAILED!\n");
475 static const char *shell_test__description(char *description
, size_t size
,
476 const char *path
, const char *name
)
479 char filename
[PATH_MAX
];
481 path__join(filename
, sizeof(filename
), path
, name
);
482 fp
= fopen(filename
, "r");
487 while (fgetc(fp
) != '\n');
489 description
= fgets(description
, size
, fp
);
492 return description
? strim(description
+ 1) : NULL
;
495 #define for_each_shell_test(dir, base, ent) \
496 while ((ent = readdir(dir)) != NULL) \
497 if (!is_directory(base, ent) && ent->d_name[0] != '.')
499 static const char *shell_tests__dir(char *path
, size_t size
)
501 const char *devel_dirs
[] = { "./tools/perf/tests", "./tests", };
505 for (i
= 0; i
< ARRAY_SIZE(devel_dirs
); ++i
) {
507 if (!lstat(devel_dirs
[i
], &st
)) {
508 scnprintf(path
, size
, "%s/shell", devel_dirs
[i
]);
509 if (!lstat(devel_dirs
[i
], &st
))
514 /* Then installed path. */
515 exec_path
= get_argv_exec_path();
516 scnprintf(path
, size
, "%s/tests/shell", exec_path
);
521 static int shell_tests__max_desc_width(void)
525 char path_dir
[PATH_MAX
];
526 const char *path
= shell_tests__dir(path_dir
, sizeof(path_dir
));
536 for_each_shell_test(dir
, path
, ent
) {
538 const char *desc
= shell_test__description(bf
, sizeof(bf
), path
, ent
->d_name
);
541 int len
= strlen(desc
);
557 static int shell_test__run(struct test
*test
, int subdir __maybe_unused
)
560 char script
[PATH_MAX
];
561 struct shell_test
*st
= test
->priv
;
563 path__join(script
, sizeof(script
), st
->dir
, st
->file
);
565 err
= system(script
);
569 return WEXITSTATUS(err
) == 2 ? TEST_SKIP
: TEST_FAIL
;
572 static int run_shell_tests(int argc
, const char *argv
[], int i
, int width
)
576 char path_dir
[PATH_MAX
];
577 struct shell_test st
= {
578 .dir
= shell_tests__dir(path_dir
, sizeof(path_dir
)),
584 dir
= opendir(st
.dir
);
586 pr_err("failed to open shell test directory: %s\n",
591 for_each_shell_test(dir
, st
.dir
, ent
) {
595 .desc
= shell_test__description(desc
, sizeof(desc
), st
.dir
, ent
->d_name
),
596 .func
= shell_test__run
,
600 if (!perf_test__matches(test
.desc
, curr
, argc
, argv
))
603 st
.file
= ent
->d_name
;
604 pr_info("%2d: %-*s:", i
, width
, test
.desc
);
605 test_and_print(&test
, false, -1);
612 static int __cmd_test(int argc
, const char *argv
[], struct intlist
*skiplist
)
617 int width
= shell_tests__max_desc_width();
619 for_each_test(j
, t
) {
620 int len
= strlen(t
->desc
);
626 for_each_test(j
, t
) {
630 if (!perf_test__matches(t
->desc
, curr
, argc
, argv
)) {
634 if (!t
->subtest
.get_nr
)
637 subn
= t
->subtest
.get_nr();
639 for (subi
= 0; subi
< subn
; subi
++) {
640 if (perf_test__matches(t
->subtest
.get_desc(subi
), curr
, argc
, argv
))
648 if (t
->is_supported
&& !t
->is_supported()) {
649 pr_debug("%2d: %-*s: Disabled\n", i
, width
, t
->desc
);
653 pr_info("%2d: %-*s:", i
, width
, t
->desc
);
655 if (intlist__find(skiplist
, i
)) {
656 color_fprintf(stderr
, PERF_COLOR_YELLOW
, " Skip (user override)\n");
660 if (!t
->subtest
.get_nr
) {
661 test_and_print(t
, false, -1);
663 int subn
= t
->subtest
.get_nr();
665 * minus 2 to align with normal testcases.
666 * For subtest we print additional '.x' in number.
669 * 35: Test LLVM searching and compiling :
670 * 35.1: Basic BPF llvm compiling test : Ok
672 int subw
= width
> 2 ? width
- 2 : width
;
676 color_fprintf(stderr
, PERF_COLOR_YELLOW
,
677 " Skip (not compiled in)\n");
682 for (subi
= 0; subi
< subn
; subi
++) {
683 int len
= strlen(t
->subtest
.get_desc(subi
));
689 for (subi
= 0; subi
< subn
; subi
++) {
690 if (!perf_test__matches(t
->subtest
.get_desc(subi
), curr
, argc
, argv
))
693 pr_info("%2d.%1d: %-*s:", i
, subi
+ 1, subw
,
694 t
->subtest
.get_desc(subi
));
695 err
= test_and_print(t
, skip
, subi
);
696 if (err
!= TEST_OK
&& t
->subtest
.skip_if_fail
)
702 return run_shell_tests(argc
, argv
, i
, width
);
705 static int perf_test__list_shell(int argc
, const char **argv
, int i
)
709 char path_dir
[PATH_MAX
];
710 const char *path
= shell_tests__dir(path_dir
, sizeof(path_dir
));
719 for_each_shell_test(dir
, path
, ent
) {
723 .desc
= shell_test__description(bf
, sizeof(bf
), path
, ent
->d_name
),
726 if (!perf_test__matches(t
.desc
, curr
, argc
, argv
))
729 pr_info("%2d: %s\n", i
, t
.desc
);
736 static int perf_test__list(int argc
, const char **argv
)
742 for_each_test(j
, t
) {
745 if (!perf_test__matches(t
->desc
, curr
, argc
, argv
) ||
746 (t
->is_supported
&& !t
->is_supported()))
749 pr_info("%2d: %s\n", i
, t
->desc
);
751 if (t
->subtest
.get_nr
) {
752 int subn
= t
->subtest
.get_nr();
755 for (subi
= 0; subi
< subn
; subi
++)
756 pr_info("%2d:%1d: %s\n", i
, subi
+ 1,
757 t
->subtest
.get_desc(subi
));
761 perf_test__list_shell(argc
, argv
, i
);
766 int cmd_test(int argc
, const char **argv
)
768 const char *test_usage
[] = {
769 "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
772 const char *skip
= NULL
;
773 const struct option test_options
[] = {
774 OPT_STRING('s', "skip", &skip
, "tests", "tests to skip"),
775 OPT_INCR('v', "verbose", &verbose
,
776 "be more verbose (show symbol address, etc)"),
777 OPT_BOOLEAN('F', "dont-fork", &dont_fork
,
778 "Do not fork for testcase"),
781 const char * const test_subcommands
[] = { "list", NULL
};
782 struct intlist
*skiplist
= NULL
;
783 int ret
= hists__init();
788 argc
= parse_options_subcommand(argc
, argv
, test_options
, test_subcommands
, test_usage
, 0);
789 if (argc
>= 1 && !strcmp(argv
[0], "list"))
790 return perf_test__list(argc
- 1, argv
+ 1);
792 symbol_conf
.priv_size
= sizeof(int);
793 symbol_conf
.sort_by_name
= true;
794 symbol_conf
.try_vmlinux_path
= true;
796 if (symbol__init(NULL
) < 0)
800 skiplist
= intlist__new(skip
);
802 * Tests that create BPF maps, for instance, need more than the 64K
805 rlimit__bump_memlock();
807 return __cmd_test(argc
, argv
, skiplist
);