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