1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * builtin-test.c
4 *
5 * Builtin regression testing command: ever growing number of sanity tests
6 */
7 #include <fcntl.h>
8 #include <errno.h>
9 #include <unistd.h>
10 #include <string.h>
11 #include <stdlib.h>
12 #include <sys/types.h>
13 #include <dirent.h>
14 #include <sys/wait.h>
15 #include <sys/stat.h>
16 #include "builtin.h"
17 #include "hist.h"
18 #include "intlist.h"
19 #include "tests.h"
20 #include "debug.h"
21 #include "color.h"
22 #include <subcmd/parse-options.h>
23 #include "string2.h"
24 #include "symbol.h"
25 #include "util/rlimit.h"
26 #include <linux/kernel.h>
27 #include <linux/string.h>
28 #include <subcmd/exec-cmd.h>
29
30 static bool dont_fork;
31
32 struct test __weak arch_tests[] = {
33 {
34 .func = NULL,
35 },
36 };
37
38 static struct test generic_tests[] = {
39 {
40 .desc = "vmlinux symtab matches kallsyms",
41 .func = test__vmlinux_matches_kallsyms,
42 },
43 {
44 .desc = "Detect openat syscall event",
45 .func = test__openat_syscall_event,
46 },
47 {
48 .desc = "Detect openat syscall event on all cpus",
49 .func = test__openat_syscall_event_on_all_cpus,
50 },
51 {
52 .desc = "Read samples using the mmap interface",
53 .func = test__basic_mmap,
54 },
55 {
56 .desc = "Test data source output",
57 .func = test__mem,
58 },
59 {
60 .desc = "Parse event definition strings",
61 .func = test__parse_events,
62 },
63 {
64 .desc = "Simple expression parser",
65 .func = test__expr,
66 },
67 {
68 .desc = "PERF_RECORD_* events & perf_sample fields",
69 .func = test__PERF_RECORD,
70 },
71 {
72 .desc = "Parse perf pmu format",
73 .func = test__pmu,
74 },
75 {
76 .desc = "DSO data read",
77 .func = test__dso_data,
78 },
79 {
80 .desc = "DSO data cache",
81 .func = test__dso_data_cache,
82 },
83 {
84 .desc = "DSO data reopen",
85 .func = test__dso_data_reopen,
86 },
87 {
88 .desc = "Roundtrip evsel->name",
89 .func = test__perf_evsel__roundtrip_name_test,
90 },
91 {
92 .desc = "Parse sched tracepoints fields",
93 .func = test__perf_evsel__tp_sched_test,
94 },
95 {
96 .desc = "syscalls:sys_enter_openat event fields",
97 .func = test__syscall_openat_tp_fields,
98 },
99 {
100 .desc = "Setup struct perf_event_attr",
101 .func = test__attr,
102 },
103 {
104 .desc = "Match and link multiple hists",
105 .func = test__hists_link,
106 },
107 {
108 .desc = "'import perf' in python",
109 .func = test__python_use,
110 },
111 {
112 .desc = "Breakpoint overflow signal handler",
113 .func = test__bp_signal,
114 .is_supported = test__bp_signal_is_supported,
115 },
116 {
117 .desc = "Breakpoint overflow sampling",
118 .func = test__bp_signal_overflow,
119 .is_supported = test__bp_signal_is_supported,
120 },
121 {
122 .desc = "Breakpoint accounting",
123 .func = test__bp_accounting,
124 .is_supported = test__bp_signal_is_supported,
125 },
126 {
127 .desc = "Watchpoint",
128 .func = test__wp,
129 .is_supported = test__wp_is_supported,
130 .subtest = {
131 .skip_if_fail = false,
132 .get_nr = test__wp_subtest_get_nr,
133 .get_desc = test__wp_subtest_get_desc,
134 },
135 },
136 {
137 .desc = "Number of exit events of a simple workload",
138 .func = test__task_exit,
139 },
140 {
141 .desc = "Software clock events period values",
142 .func = test__sw_clock_freq,
143 },
144 {
145 .desc = "Object code reading",
146 .func = test__code_reading,
147 },
148 {
149 .desc = "Sample parsing",
150 .func = test__sample_parsing,
151 },
152 {
153 .desc = "Use a dummy software event to keep tracking",
154 .func = test__keep_tracking,
155 },
156 {
157 .desc = "Parse with no sample_id_all bit set",
158 .func = test__parse_no_sample_id_all,
159 },
160 {
161 .desc = "Filter hist entries",
162 .func = test__hists_filter,
163 },
164 {
165 .desc = "Lookup mmap thread",
166 .func = test__mmap_thread_lookup,
167 },
168 {
169 .desc = "Share thread mg",
170 .func = test__thread_mg_share,
171 },
172 {
173 .desc = "Sort output of hist entries",
174 .func = test__hists_output,
175 },
176 {
177 .desc = "Cumulate child hist entries",
178 .func = test__hists_cumulate,
179 },
180 {
181 .desc = "Track with sched_switch",
182 .func = test__switch_tracking,
183 },
184 {
185 .desc = "Filter fds with revents mask in a fdarray",
186 .func = test__fdarray__filter,
187 },
188 {
189 .desc = "Add fd to a fdarray, making it autogrow",
190 .func = test__fdarray__add,
191 },
192 {
193 .desc = "kmod_path__parse",
194 .func = test__kmod_path__parse,
195 },
196 {
197 .desc = "Thread map",
198 .func = test__thread_map,
199 },
200 {
201 .desc = "LLVM search and compile",
202 .func = test__llvm,
203 .subtest = {
204 .skip_if_fail = true,
205 .get_nr = test__llvm_subtest_get_nr,
206 .get_desc = test__llvm_subtest_get_desc,
207 },
208 },
209 {
210 .desc = "Session topology",
211 .func = test__session_topology,
212 },
213 {
214 .desc = "BPF filter",
215 .func = test__bpf,
216 .subtest = {
217 .skip_if_fail = true,
218 .get_nr = test__bpf_subtest_get_nr,
219 .get_desc = test__bpf_subtest_get_desc,
220 },
221 },
222 {
223 .desc = "Synthesize thread map",
224 .func = test__thread_map_synthesize,
225 },
226 {
227 .desc = "Remove thread map",
228 .func = test__thread_map_remove,
229 },
230 {
231 .desc = "Synthesize cpu map",
232 .func = test__cpu_map_synthesize,
233 },
234 {
235 .desc = "Synthesize stat config",
236 .func = test__synthesize_stat_config,
237 },
238 {
239 .desc = "Synthesize stat",
240 .func = test__synthesize_stat,
241 },
242 {
243 .desc = "Synthesize stat round",
244 .func = test__synthesize_stat_round,
245 },
246 {
247 .desc = "Synthesize attr update",
248 .func = test__event_update,
249 },
250 {
251 .desc = "Event times",
252 .func = test__event_times,
253 },
254 {
255 .desc = "Read backward ring buffer",
256 .func = test__backward_ring_buffer,
257 },
258 {
259 .desc = "Print cpu map",
260 .func = test__cpu_map_print,
261 },
262 {
263 .desc = "Probe SDT events",
264 .func = test__sdt_event,
265 },
266 {
267 .desc = "is_printable_array",
268 .func = test__is_printable_array,
269 },
270 {
271 .desc = "Print bitmap",
272 .func = test__bitmap_print,
273 },
274 {
275 .desc = "perf hooks",
276 .func = test__perf_hooks,
277 },
278 {
279 .desc = "builtin clang support",
280 .func = test__clang,
281 .subtest = {
282 .skip_if_fail = true,
283 .get_nr = test__clang_subtest_get_nr,
284 .get_desc = test__clang_subtest_get_desc,
285 }
286 },
287 {
288 .desc = "unit_number__scnprintf",
289 .func = test__unit_number__scnprint,
290 },
291 {
292 .desc = "mem2node",
293 .func = test__mem2node,
294 },
295 {
296 .desc = "time utils",
297 .func = test__time_utils,
298 },
299 {
300 .desc = "map_groups__merge_in",
301 .func = test__map_groups__merge_in,
302 },
303 {
304 .func = NULL,
305 },
306 };
307
308 static struct test *tests[] = {
309 generic_tests,
310 arch_tests,
311 };
312
perf_test__matches(struct test * test,int curr,int argc,const char * argv[])313 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
314 {
315 int i;
316
317 if (argc == 0)
318 return true;
319
320 for (i = 0; i < argc; ++i) {
321 char *end;
322 long nr = strtoul(argv[i], &end, 10);
323
324 if (*end == '\0') {
325 if (nr == curr + 1)
326 return true;
327 continue;
328 }
329
330 if (strcasestr(test->desc, argv[i]))
331 return true;
332 }
333
334 return false;
335 }
336
run_test(struct test * test,int subtest)337 static int run_test(struct test *test, int subtest)
338 {
339 int status, err = -1, child = dont_fork ? 0 : fork();
340 char sbuf[STRERR_BUFSIZE];
341
342 if (child < 0) {
343 pr_err("failed to fork test: %s\n",
344 str_error_r(errno, sbuf, sizeof(sbuf)));
345 return -1;
346 }
347
348 if (!child) {
349 if (!dont_fork) {
350 pr_debug("test child forked, pid %d\n", getpid());
351
352 if (verbose <= 0) {
353 int nullfd = open("/dev/null", O_WRONLY);
354
355 if (nullfd >= 0) {
356 close(STDERR_FILENO);
357 close(STDOUT_FILENO);
358
359 dup2(nullfd, STDOUT_FILENO);
360 dup2(STDOUT_FILENO, STDERR_FILENO);
361 close(nullfd);
362 }
363 } else {
364 signal(SIGSEGV, sighandler_dump_stack);
365 signal(SIGFPE, sighandler_dump_stack);
366 }
367 }
368
369 err = test->func(test, subtest);
370 if (!dont_fork)
371 exit(err);
372 }
373
374 if (!dont_fork) {
375 wait(&status);
376
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)) {
381 err = -1;
382 pr_debug("test child interrupted\n");
383 }
384 }
385
386 return err;
387 }
388
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++)
392
test_and_print(struct test * t,bool force_skip,int subtest)393 static int test_and_print(struct test *t, bool force_skip, int subtest)
394 {
395 int err;
396
397 if (!force_skip) {
398 pr_debug("\n--- start ---\n");
399 err = run_test(t, subtest);
400 pr_debug("---- end ----\n");
401 } else {
402 pr_debug("\n--- force skipped ---\n");
403 err = TEST_SKIP;
404 }
405
406 if (!t->subtest.get_nr)
407 pr_debug("%s:", t->desc);
408 else
409 pr_debug("%s subtest %d:", t->desc, subtest + 1);
410
411 switch (err) {
412 case TEST_OK:
413 pr_info(" Ok\n");
414 break;
415 case TEST_SKIP:
416 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
417 break;
418 case TEST_FAIL:
419 default:
420 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
421 break;
422 }
423
424 return err;
425 }
426
shell_test__description(char * description,size_t size,const char * path,const char * name)427 static const char *shell_test__description(char *description, size_t size,
428 const char *path, const char *name)
429 {
430 FILE *fp;
431 char filename[PATH_MAX];
432
433 path__join(filename, sizeof(filename), path, name);
434 fp = fopen(filename, "r");
435 if (!fp)
436 return NULL;
437
438 /* Skip shebang */
439 while (fgetc(fp) != '\n');
440
441 description = fgets(description, size, fp);
442 fclose(fp);
443
444 return description ? strim(description + 1) : NULL;
445 }
446
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] != '.')
450
shell_tests__dir(char * path,size_t size)451 static const char *shell_tests__dir(char *path, size_t size)
452 {
453 const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
454 char *exec_path;
455 unsigned int i;
456
457 for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
458 struct stat st;
459 if (!lstat(devel_dirs[i], &st)) {
460 scnprintf(path, size, "%s/shell", devel_dirs[i]);
461 if (!lstat(devel_dirs[i], &st))
462 return path;
463 }
464 }
465
466 /* Then installed path. */
467 exec_path = get_argv_exec_path();
468 scnprintf(path, size, "%s/tests/shell", exec_path);
469 free(exec_path);
470 return path;
471 }
472
shell_tests__max_desc_width(void)473 static int shell_tests__max_desc_width(void)
474 {
475 DIR *dir;
476 struct dirent *ent;
477 char path_dir[PATH_MAX];
478 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
479 int width = 0;
480
481 if (path == NULL)
482 return -1;
483
484 dir = opendir(path);
485 if (!dir)
486 return -1;
487
488 for_each_shell_test(dir, path, ent) {
489 char bf[256];
490 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name);
491
492 if (desc) {
493 int len = strlen(desc);
494
495 if (width < len)
496 width = len;
497 }
498 }
499
500 closedir(dir);
501 return width;
502 }
503
504 struct shell_test {
505 const char *dir;
506 const char *file;
507 };
508
shell_test__run(struct test * test,int subdir __maybe_unused)509 static int shell_test__run(struct test *test, int subdir __maybe_unused)
510 {
511 int err;
512 char script[PATH_MAX];
513 struct shell_test *st = test->priv;
514
515 path__join(script, sizeof(script), st->dir, st->file);
516
517 err = system(script);
518 if (!err)
519 return TEST_OK;
520
521 return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL;
522 }
523
run_shell_tests(int argc,const char * argv[],int i,int width)524 static int run_shell_tests(int argc, const char *argv[], int i, int width)
525 {
526 DIR *dir;
527 struct dirent *ent;
528 char path_dir[PATH_MAX];
529 struct shell_test st = {
530 .dir = shell_tests__dir(path_dir, sizeof(path_dir)),
531 };
532
533 if (st.dir == NULL)
534 return -1;
535
536 dir = opendir(st.dir);
537 if (!dir)
538 return -1;
539
540 for_each_shell_test(dir, st.dir, ent) {
541 int curr = i++;
542 char desc[256];
543 struct test test = {
544 .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name),
545 .func = shell_test__run,
546 .priv = &st,
547 };
548
549 if (!perf_test__matches(&test, curr, argc, argv))
550 continue;
551
552 st.file = ent->d_name;
553 pr_info("%2d: %-*s:", i, width, test.desc);
554 test_and_print(&test, false, -1);
555 }
556
557 closedir(dir);
558 return 0;
559 }
560
__cmd_test(int argc,const char * argv[],struct intlist * skiplist)561 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
562 {
563 struct test *t;
564 unsigned int j;
565 int i = 0;
566 int width = shell_tests__max_desc_width();
567
568 for_each_test(j, t) {
569 int len = strlen(t->desc);
570
571 if (width < len)
572 width = len;
573 }
574
575 for_each_test(j, t) {
576 int curr = i++, err;
577
578 if (!perf_test__matches(t, curr, argc, argv))
579 continue;
580
581 if (t->is_supported && !t->is_supported()) {
582 pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc);
583 continue;
584 }
585
586 pr_info("%2d: %-*s:", i, width, t->desc);
587
588 if (intlist__find(skiplist, i)) {
589 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
590 continue;
591 }
592
593 if (!t->subtest.get_nr) {
594 test_and_print(t, false, -1);
595 } else {
596 int subn = t->subtest.get_nr();
597 /*
598 * minus 2 to align with normal testcases.
599 * For subtest we print additional '.x' in number.
600 * for example:
601 *
602 * 35: Test LLVM searching and compiling :
603 * 35.1: Basic BPF llvm compiling test : Ok
604 */
605 int subw = width > 2 ? width - 2 : width;
606 bool skip = false;
607 int subi;
608
609 if (subn <= 0) {
610 color_fprintf(stderr, PERF_COLOR_YELLOW,
611 " Skip (not compiled in)\n");
612 continue;
613 }
614 pr_info("\n");
615
616 for (subi = 0; subi < subn; subi++) {
617 int len = strlen(t->subtest.get_desc(subi));
618
619 if (subw < len)
620 subw = len;
621 }
622
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)
628 skip = true;
629 }
630 }
631 }
632
633 return run_shell_tests(argc, argv, i, width);
634 }
635
perf_test__list_shell(int argc,const char ** argv,int i)636 static int perf_test__list_shell(int argc, const char **argv, int i)
637 {
638 DIR *dir;
639 struct dirent *ent;
640 char path_dir[PATH_MAX];
641 const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
642
643 if (path == NULL)
644 return -1;
645
646 dir = opendir(path);
647 if (!dir)
648 return -1;
649
650 for_each_shell_test(dir, path, ent) {
651 int curr = i++;
652 char bf[256];
653 struct test t = {
654 .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name),
655 };
656
657 if (!perf_test__matches(&t, curr, argc, argv))
658 continue;
659
660 pr_info("%2d: %s\n", i, t.desc);
661 }
662
663 closedir(dir);
664 return 0;
665 }
666
perf_test__list(int argc,const char ** argv)667 static int perf_test__list(int argc, const char **argv)
668 {
669 unsigned int j;
670 struct test *t;
671 int i = 0;
672
673 for_each_test(j, t) {
674 int curr = i++;
675
676 if (!perf_test__matches(t, curr, argc, argv) ||
677 (t->is_supported && !t->is_supported()))
678 continue;
679
680 pr_info("%2d: %s\n", i, t->desc);
681
682 if (t->subtest.get_nr) {
683 int subn = t->subtest.get_nr();
684 int subi;
685
686 for (subi = 0; subi < subn; subi++)
687 pr_info("%2d:%1d: %s\n", i, subi + 1,
688 t->subtest.get_desc(subi));
689 }
690 }
691
692 perf_test__list_shell(argc, argv, i);
693
694 return 0;
695 }
696
cmd_test(int argc,const char ** argv)697 int cmd_test(int argc, const char **argv)
698 {
699 const char *test_usage[] = {
700 "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
701 NULL,
702 };
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"),
710 OPT_END()
711 };
712 const char * const test_subcommands[] = { "list", NULL };
713 struct intlist *skiplist = NULL;
714 int ret = hists__init();
715
716 if (ret < 0)
717 return ret;
718
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);
722
723 symbol_conf.priv_size = sizeof(int);
724 symbol_conf.sort_by_name = true;
725 symbol_conf.try_vmlinux_path = true;
726
727 if (symbol__init(NULL) < 0)
728 return -1;
729
730 if (skip != NULL)
731 skiplist = intlist__new(skip);
732 /*
733 * Tests that create BPF maps, for instance, need more than the 64K
734 * default:
735 */
736 rlimit__bump_memlock();
737
738 return __cmd_test(argc, argv, skiplist);
739 }
740
