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 = "PMU events", 77 .func = test__pmu_events, 78 .subtest = { 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, 83 }, 84 85 }, 86 { 87 .desc = "DSO data read", 88 .func = test__dso_data, 89 }, 90 { 91 .desc = "DSO data cache", 92 .func = test__dso_data_cache, 93 }, 94 { 95 .desc = "DSO data reopen", 96 .func = test__dso_data_reopen, 97 }, 98 { 99 .desc = "Roundtrip evsel->name", 100 .func = test__perf_evsel__roundtrip_name_test, 101 }, 102 { 103 .desc = "Parse sched tracepoints fields", 104 .func = test__perf_evsel__tp_sched_test, 105 }, 106 { 107 .desc = "syscalls:sys_enter_openat event fields", 108 .func = test__syscall_openat_tp_fields, 109 }, 110 { 111 .desc = "Setup struct perf_event_attr", 112 .func = test__attr, 113 }, 114 { 115 .desc = "Match and link multiple hists", 116 .func = test__hists_link, 117 }, 118 { 119 .desc = "'import perf' in python", 120 .func = test__python_use, 121 }, 122 { 123 .desc = "Breakpoint overflow signal handler", 124 .func = test__bp_signal, 125 .is_supported = test__bp_signal_is_supported, 126 }, 127 { 128 .desc = "Breakpoint overflow sampling", 129 .func = test__bp_signal_overflow, 130 .is_supported = test__bp_signal_is_supported, 131 }, 132 { 133 .desc = "Breakpoint accounting", 134 .func = test__bp_accounting, 135 .is_supported = test__bp_account_is_supported, 136 }, 137 { 138 .desc = "Watchpoint", 139 .func = test__wp, 140 .is_supported = test__wp_is_supported, 141 .subtest = { 142 .skip_if_fail = false, 143 .get_nr = test__wp_subtest_get_nr, 144 .get_desc = test__wp_subtest_get_desc, 145 }, 146 }, 147 { 148 .desc = "Number of exit events of a simple workload", 149 .func = test__task_exit, 150 }, 151 { 152 .desc = "Software clock events period values", 153 .func = test__sw_clock_freq, 154 }, 155 { 156 .desc = "Object code reading", 157 .func = test__code_reading, 158 }, 159 { 160 .desc = "Sample parsing", 161 .func = test__sample_parsing, 162 }, 163 { 164 .desc = "Use a dummy software event to keep tracking", 165 .func = test__keep_tracking, 166 }, 167 { 168 .desc = "Parse with no sample_id_all bit set", 169 .func = test__parse_no_sample_id_all, 170 }, 171 { 172 .desc = "Filter hist entries", 173 .func = test__hists_filter, 174 }, 175 { 176 .desc = "Lookup mmap thread", 177 .func = test__mmap_thread_lookup, 178 }, 179 { 180 .desc = "Share thread maps", 181 .func = test__thread_maps_share, 182 }, 183 { 184 .desc = "Sort output of hist entries", 185 .func = test__hists_output, 186 }, 187 { 188 .desc = "Cumulate child hist entries", 189 .func = test__hists_cumulate, 190 }, 191 { 192 .desc = "Track with sched_switch", 193 .func = test__switch_tracking, 194 }, 195 { 196 .desc = "Filter fds with revents mask in a fdarray", 197 .func = test__fdarray__filter, 198 }, 199 { 200 .desc = "Add fd to a fdarray, making it autogrow", 201 .func = test__fdarray__add, 202 }, 203 { 204 .desc = "kmod_path__parse", 205 .func = test__kmod_path__parse, 206 }, 207 { 208 .desc = "Thread map", 209 .func = test__thread_map, 210 }, 211 { 212 .desc = "LLVM search and compile", 213 .func = test__llvm, 214 .subtest = { 215 .skip_if_fail = true, 216 .get_nr = test__llvm_subtest_get_nr, 217 .get_desc = test__llvm_subtest_get_desc, 218 }, 219 }, 220 { 221 .desc = "Session topology", 222 .func = test__session_topology, 223 }, 224 { 225 .desc = "BPF filter", 226 .func = test__bpf, 227 .subtest = { 228 .skip_if_fail = true, 229 .get_nr = test__bpf_subtest_get_nr, 230 .get_desc = test__bpf_subtest_get_desc, 231 }, 232 }, 233 { 234 .desc = "Synthesize thread map", 235 .func = test__thread_map_synthesize, 236 }, 237 { 238 .desc = "Remove thread map", 239 .func = test__thread_map_remove, 240 }, 241 { 242 .desc = "Synthesize cpu map", 243 .func = test__cpu_map_synthesize, 244 }, 245 { 246 .desc = "Synthesize stat config", 247 .func = test__synthesize_stat_config, 248 }, 249 { 250 .desc = "Synthesize stat", 251 .func = test__synthesize_stat, 252 }, 253 { 254 .desc = "Synthesize stat round", 255 .func = test__synthesize_stat_round, 256 }, 257 { 258 .desc = "Synthesize attr update", 259 .func = test__event_update, 260 }, 261 { 262 .desc = "Event times", 263 .func = test__event_times, 264 }, 265 { 266 .desc = "Read backward ring buffer", 267 .func = test__backward_ring_buffer, 268 }, 269 { 270 .desc = "Print cpu map", 271 .func = test__cpu_map_print, 272 }, 273 { 274 .desc = "Merge cpu map", 275 .func = test__cpu_map_merge, 276 }, 277 278 { 279 .desc = "Probe SDT events", 280 .func = test__sdt_event, 281 }, 282 { 283 .desc = "is_printable_array", 284 .func = test__is_printable_array, 285 }, 286 { 287 .desc = "Print bitmap", 288 .func = test__bitmap_print, 289 }, 290 { 291 .desc = "perf hooks", 292 .func = test__perf_hooks, 293 }, 294 { 295 .desc = "builtin clang support", 296 .func = test__clang, 297 .subtest = { 298 .skip_if_fail = true, 299 .get_nr = test__clang_subtest_get_nr, 300 .get_desc = test__clang_subtest_get_desc, 301 } 302 }, 303 { 304 .desc = "unit_number__scnprintf", 305 .func = test__unit_number__scnprint, 306 }, 307 { 308 .desc = "mem2node", 309 .func = test__mem2node, 310 }, 311 { 312 .desc = "time utils", 313 .func = test__time_utils, 314 }, 315 { 316 .desc = "Test jit_write_elf", 317 .func = test__jit_write_elf, 318 }, 319 { 320 .desc = "Test libpfm4 support", 321 .func = test__pfm, 322 .subtest = { 323 .skip_if_fail = true, 324 .get_nr = test__pfm_subtest_get_nr, 325 .get_desc = test__pfm_subtest_get_desc, 326 } 327 }, 328 { 329 .desc = "Test api io", 330 .func = test__api_io, 331 }, 332 { 333 .desc = "maps__merge_in", 334 .func = test__maps__merge_in, 335 }, 336 { 337 .desc = "Demangle Java", 338 .func = test__demangle_java, 339 }, 340 { 341 .func = NULL, 342 }, 343 }; 344 345 static struct test *tests[] = { 346 generic_tests, 347 arch_tests, 348 }; 349 350 static bool perf_test__matches(const char *desc, int curr, int argc, const char *argv[]) 351 { 352 int i; 353 354 if (argc == 0) 355 return true; 356 357 for (i = 0; i < argc; ++i) { 358 char *end; 359 long nr = strtoul(argv[i], &end, 10); 360 361 if (*end == '\0') { 362 if (nr == curr + 1) 363 return true; 364 continue; 365 } 366 367 if (strcasestr(desc, argv[i])) 368 return true; 369 } 370 371 return false; 372 } 373 374 static int run_test(struct test *test, int subtest) 375 { 376 int status, err = -1, child = dont_fork ? 0 : fork(); 377 char sbuf[STRERR_BUFSIZE]; 378 379 if (child < 0) { 380 pr_err("failed to fork test: %s\n", 381 str_error_r(errno, sbuf, sizeof(sbuf))); 382 return -1; 383 } 384 385 if (!child) { 386 if (!dont_fork) { 387 pr_debug("test child forked, pid %d\n", getpid()); 388 389 if (verbose <= 0) { 390 int nullfd = open("/dev/null", O_WRONLY); 391 392 if (nullfd >= 0) { 393 close(STDERR_FILENO); 394 close(STDOUT_FILENO); 395 396 dup2(nullfd, STDOUT_FILENO); 397 dup2(STDOUT_FILENO, STDERR_FILENO); 398 close(nullfd); 399 } 400 } else { 401 signal(SIGSEGV, sighandler_dump_stack); 402 signal(SIGFPE, sighandler_dump_stack); 403 } 404 } 405 406 err = test->func(test, subtest); 407 if (!dont_fork) 408 exit(err); 409 } 410 411 if (!dont_fork) { 412 wait(&status); 413 414 if (WIFEXITED(status)) { 415 err = (signed char)WEXITSTATUS(status); 416 pr_debug("test child finished with %d\n", err); 417 } else if (WIFSIGNALED(status)) { 418 err = -1; 419 pr_debug("test child interrupted\n"); 420 } 421 } 422 423 return err; 424 } 425 426 #define for_each_test(j, t) \ 427 for (j = 0; j < ARRAY_SIZE(tests); j++) \ 428 for (t = &tests[j][0]; t->func; t++) 429 430 static int test_and_print(struct test *t, bool force_skip, int subtest) 431 { 432 int err; 433 434 if (!force_skip) { 435 pr_debug("\n--- start ---\n"); 436 err = run_test(t, subtest); 437 pr_debug("---- end ----\n"); 438 } else { 439 pr_debug("\n--- force skipped ---\n"); 440 err = TEST_SKIP; 441 } 442 443 if (!t->subtest.get_nr) 444 pr_debug("%s:", t->desc); 445 else 446 pr_debug("%s subtest %d:", t->desc, subtest + 1); 447 448 switch (err) { 449 case TEST_OK: 450 pr_info(" Ok\n"); 451 break; 452 case TEST_SKIP: { 453 const char *skip_reason = NULL; 454 if (t->subtest.skip_reason) 455 skip_reason = t->subtest.skip_reason(subtest); 456 if (skip_reason) 457 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (%s)\n", skip_reason); 458 else 459 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n"); 460 } 461 break; 462 case TEST_FAIL: 463 default: 464 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n"); 465 break; 466 } 467 468 return err; 469 } 470 471 static const char *shell_test__description(char *description, size_t size, 472 const char *path, const char *name) 473 { 474 FILE *fp; 475 char filename[PATH_MAX]; 476 477 path__join(filename, sizeof(filename), path, name); 478 fp = fopen(filename, "r"); 479 if (!fp) 480 return NULL; 481 482 /* Skip shebang */ 483 while (fgetc(fp) != '\n'); 484 485 description = fgets(description, size, fp); 486 fclose(fp); 487 488 return description ? strim(description + 1) : NULL; 489 } 490 491 #define for_each_shell_test(dir, base, ent) \ 492 while ((ent = readdir(dir)) != NULL) \ 493 if (!is_directory(base, ent) && ent->d_name[0] != '.') 494 495 static const char *shell_tests__dir(char *path, size_t size) 496 { 497 const char *devel_dirs[] = { "./tools/perf/tests", "./tests", }; 498 char *exec_path; 499 unsigned int i; 500 501 for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) { 502 struct stat st; 503 if (!lstat(devel_dirs[i], &st)) { 504 scnprintf(path, size, "%s/shell", devel_dirs[i]); 505 if (!lstat(devel_dirs[i], &st)) 506 return path; 507 } 508 } 509 510 /* Then installed path. */ 511 exec_path = get_argv_exec_path(); 512 scnprintf(path, size, "%s/tests/shell", exec_path); 513 free(exec_path); 514 return path; 515 } 516 517 static int shell_tests__max_desc_width(void) 518 { 519 DIR *dir; 520 struct dirent *ent; 521 char path_dir[PATH_MAX]; 522 const char *path = shell_tests__dir(path_dir, sizeof(path_dir)); 523 int width = 0; 524 525 if (path == NULL) 526 return -1; 527 528 dir = opendir(path); 529 if (!dir) 530 return -1; 531 532 for_each_shell_test(dir, path, ent) { 533 char bf[256]; 534 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name); 535 536 if (desc) { 537 int len = strlen(desc); 538 539 if (width < len) 540 width = len; 541 } 542 } 543 544 closedir(dir); 545 return width; 546 } 547 548 struct shell_test { 549 const char *dir; 550 const char *file; 551 }; 552 553 static int shell_test__run(struct test *test, int subdir __maybe_unused) 554 { 555 int err; 556 char script[PATH_MAX]; 557 struct shell_test *st = test->priv; 558 559 path__join(script, sizeof(script), st->dir, st->file); 560 561 err = system(script); 562 if (!err) 563 return TEST_OK; 564 565 return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL; 566 } 567 568 static int run_shell_tests(int argc, const char *argv[], int i, int width) 569 { 570 DIR *dir; 571 struct dirent *ent; 572 char path_dir[PATH_MAX]; 573 struct shell_test st = { 574 .dir = shell_tests__dir(path_dir, sizeof(path_dir)), 575 }; 576 577 if (st.dir == NULL) 578 return -1; 579 580 dir = opendir(st.dir); 581 if (!dir) { 582 pr_err("failed to open shell test directory: %s\n", 583 st.dir); 584 return -1; 585 } 586 587 for_each_shell_test(dir, st.dir, ent) { 588 int curr = i++; 589 char desc[256]; 590 struct test test = { 591 .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name), 592 .func = shell_test__run, 593 .priv = &st, 594 }; 595 596 if (!perf_test__matches(test.desc, curr, argc, argv)) 597 continue; 598 599 st.file = ent->d_name; 600 pr_info("%2d: %-*s:", i, width, test.desc); 601 test_and_print(&test, false, -1); 602 } 603 604 closedir(dir); 605 return 0; 606 } 607 608 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist) 609 { 610 struct test *t; 611 unsigned int j; 612 int i = 0; 613 int width = shell_tests__max_desc_width(); 614 615 for_each_test(j, t) { 616 int len = strlen(t->desc); 617 618 if (width < len) 619 width = len; 620 } 621 622 for_each_test(j, t) { 623 int curr = i++, err; 624 int subi; 625 626 if (!perf_test__matches(t->desc, curr, argc, argv)) { 627 bool skip = true; 628 int subn; 629 630 if (!t->subtest.get_nr) 631 continue; 632 633 subn = t->subtest.get_nr(); 634 635 for (subi = 0; subi < subn; subi++) { 636 if (perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv)) 637 skip = false; 638 } 639 640 if (skip) 641 continue; 642 } 643 644 if (t->is_supported && !t->is_supported()) { 645 pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc); 646 continue; 647 } 648 649 pr_info("%2d: %-*s:", i, width, t->desc); 650 651 if (intlist__find(skiplist, i)) { 652 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n"); 653 continue; 654 } 655 656 if (!t->subtest.get_nr) { 657 test_and_print(t, false, -1); 658 } else { 659 int subn = t->subtest.get_nr(); 660 /* 661 * minus 2 to align with normal testcases. 662 * For subtest we print additional '.x' in number. 663 * for example: 664 * 665 * 35: Test LLVM searching and compiling : 666 * 35.1: Basic BPF llvm compiling test : Ok 667 */ 668 int subw = width > 2 ? width - 2 : width; 669 bool skip = false; 670 671 if (subn <= 0) { 672 color_fprintf(stderr, PERF_COLOR_YELLOW, 673 " Skip (not compiled in)\n"); 674 continue; 675 } 676 pr_info("\n"); 677 678 for (subi = 0; subi < subn; subi++) { 679 int len = strlen(t->subtest.get_desc(subi)); 680 681 if (subw < len) 682 subw = len; 683 } 684 685 for (subi = 0; subi < subn; subi++) { 686 if (!perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv)) 687 continue; 688 689 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw, 690 t->subtest.get_desc(subi)); 691 err = test_and_print(t, skip, subi); 692 if (err != TEST_OK && t->subtest.skip_if_fail) 693 skip = true; 694 } 695 } 696 } 697 698 return run_shell_tests(argc, argv, i, width); 699 } 700 701 static int perf_test__list_shell(int argc, const char **argv, int i) 702 { 703 DIR *dir; 704 struct dirent *ent; 705 char path_dir[PATH_MAX]; 706 const char *path = shell_tests__dir(path_dir, sizeof(path_dir)); 707 708 if (path == NULL) 709 return -1; 710 711 dir = opendir(path); 712 if (!dir) 713 return -1; 714 715 for_each_shell_test(dir, path, ent) { 716 int curr = i++; 717 char bf[256]; 718 struct test t = { 719 .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name), 720 }; 721 722 if (!perf_test__matches(t.desc, curr, argc, argv)) 723 continue; 724 725 pr_info("%2d: %s\n", i, t.desc); 726 } 727 728 closedir(dir); 729 return 0; 730 } 731 732 static int perf_test__list(int argc, const char **argv) 733 { 734 unsigned int j; 735 struct test *t; 736 int i = 0; 737 738 for_each_test(j, t) { 739 int curr = i++; 740 741 if (!perf_test__matches(t->desc, curr, argc, argv) || 742 (t->is_supported && !t->is_supported())) 743 continue; 744 745 pr_info("%2d: %s\n", i, t->desc); 746 747 if (t->subtest.get_nr) { 748 int subn = t->subtest.get_nr(); 749 int subi; 750 751 for (subi = 0; subi < subn; subi++) 752 pr_info("%2d:%1d: %s\n", i, subi + 1, 753 t->subtest.get_desc(subi)); 754 } 755 } 756 757 perf_test__list_shell(argc, argv, i); 758 759 return 0; 760 } 761 762 int cmd_test(int argc, const char **argv) 763 { 764 const char *test_usage[] = { 765 "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]", 766 NULL, 767 }; 768 const char *skip = NULL; 769 const struct option test_options[] = { 770 OPT_STRING('s', "skip", &skip, "tests", "tests to skip"), 771 OPT_INCR('v', "verbose", &verbose, 772 "be more verbose (show symbol address, etc)"), 773 OPT_BOOLEAN('F', "dont-fork", &dont_fork, 774 "Do not fork for testcase"), 775 OPT_END() 776 }; 777 const char * const test_subcommands[] = { "list", NULL }; 778 struct intlist *skiplist = NULL; 779 int ret = hists__init(); 780 781 if (ret < 0) 782 return ret; 783 784 argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0); 785 if (argc >= 1 && !strcmp(argv[0], "list")) 786 return perf_test__list(argc - 1, argv + 1); 787 788 symbol_conf.priv_size = sizeof(int); 789 symbol_conf.sort_by_name = true; 790 symbol_conf.try_vmlinux_path = true; 791 792 if (symbol__init(NULL) < 0) 793 return -1; 794 795 if (skip != NULL) 796 skiplist = intlist__new(skip); 797 /* 798 * Tests that create BPF maps, for instance, need more than the 64K 799 * default: 800 */ 801 rlimit__bump_memlock(); 802 803 return __cmd_test(argc, argv, skiplist); 804 } 805