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