tools/perf/tests/builtin-test.c

   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                 const char *skip_reason = NULL;
 434                 if (t->subtest.skip_reason)
 435                         skip_reason = t->subtest.skip_reason(subtest);
 436                 if (skip_reason)
 437                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (%s)\n", skip_reason);
 438                 else
 439                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
 440         }
 441                 break;
 442         case TEST_FAIL:
 443         default:
 444                 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
 445                 break;
 446         }
 447
 448         return err;
 449 }
 450
 451 static const char *shell_test__description(char *description, size_t size,
 452                                            const char *path, const char *name)
 453 {
 454         FILE *fp;
 455         char filename[PATH_MAX];
 456
 457         path__join(filename, sizeof(filename), path, name);
 458         fp = fopen(filename, "r");
 459         if (!fp)
 460                 return NULL;
 461
 462         /* Skip shebang */
 463         while (fgetc(fp) != '\n');
 464
 465         description = fgets(description, size, fp);
 466         fclose(fp);
 467
 468         return description ? strim(description + 1) : NULL;
 469 }
 470
 471 #define for_each_shell_test(dir, base, ent)     \
 472         while ((ent = readdir(dir)) != NULL)    \
 473                 if (!is_directory(base, ent) && ent->d_name[0] != '.')
 474
 475 static const char *shell_tests__dir(char *path, size_t size)
 476 {
 477         const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
 478         char *exec_path;
 479         unsigned int i;
 480
 481         for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
 482                 struct stat st;
 483                 if (!lstat(devel_dirs[i], &st)) {
 484                         scnprintf(path, size, "%s/shell", devel_dirs[i]);
 485                         if (!lstat(devel_dirs[i], &st))
 486                                 return path;
 487                 }
 488         }
 489
 490         /* Then installed path. */
 491         exec_path = get_argv_exec_path();
 492         scnprintf(path, size, "%s/tests/shell", exec_path);
 493         free(exec_path);
 494         return path;
 495 }
 496
 497 static int shell_tests__max_desc_width(void)
 498 {
 499         DIR *dir;
 500         struct dirent *ent;
 501         char path_dir[PATH_MAX];
 502         const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
 503         int width = 0;
 504
 505         if (path == NULL)
 506                 return -1;
 507
 508         dir = opendir(path);
 509         if (!dir)
 510                 return -1;
 511
 512         for_each_shell_test(dir, path, ent) {
 513                 char bf[256];
 514                 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name);
 515
 516                 if (desc) {
 517                         int len = strlen(desc);
 518
 519                         if (width < len)
 520                                 width = len;
 521                 }
 522         }
 523
 524         closedir(dir);
 525         return width;
 526 }
 527
 528 struct shell_test {
 529         const char *dir;
 530         const char *file;
 531 };
 532
 533 static int shell_test__run(struct test *test, int subdir __maybe_unused)
 534 {
 535         int err;
 536         char script[PATH_MAX];
 537         struct shell_test *st = test->priv;
 538
 539         path__join(script, sizeof(script), st->dir, st->file);
 540
 541         err = system(script);
 542         if (!err)
 543                 return TEST_OK;
 544
 545         return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL;
 546 }
 547
 548 static int run_shell_tests(int argc, const char *argv[], int i, int width)
 549 {
 550         DIR *dir;
 551         struct dirent *ent;
 552         char path_dir[PATH_MAX];
 553         struct shell_test st = {
 554                 .dir = shell_tests__dir(path_dir, sizeof(path_dir)),
 555         };
 556
 557         if (st.dir == NULL)
 558                 return -1;
 559
 560         dir = opendir(st.dir);
 561         if (!dir) {
 562                 pr_err("failed to open shell test directory: %s\n",
 563                         st.dir);
 564                 return -1;
 565         }
 566
 567         for_each_shell_test(dir, st.dir, ent) {
 568                 int curr = i++;
 569                 char desc[256];
 570                 struct test test = {
 571                         .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name),
 572                         .func = shell_test__run,
 573                         .priv = &st,
 574                 };
 575
 576                 if (!perf_test__matches(&test, curr, argc, argv))
 577                         continue;
 578
 579                 st.file = ent->d_name;
 580                 pr_info("%2d: %-*s:", i, width, test.desc);
 581                 test_and_print(&test, false, -1);
 582         }
 583
 584         closedir(dir);
 585         return 0;
 586 }
 587
 588 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
 589 {
 590         struct test *t;
 591         unsigned int j;
 592         int i = 0;
 593         int width = shell_tests__max_desc_width();
 594
 595         for_each_test(j, t) {
 596                 int len = strlen(t->desc);
 597
 598                 if (width < len)
 599                         width = len;
 600         }
 601
 602         for_each_test(j, t) {
 603                 int curr = i++, err;
 604
 605                 if (!perf_test__matches(t, curr, argc, argv))
 606                         continue;
 607
 608                 if (t->is_supported && !t->is_supported()) {
 609                         pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc);
 610                         continue;
 611                 }
 612
 613                 pr_info("%2d: %-*s:", i, width, t->desc);
 614
 615                 if (intlist__find(skiplist, i)) {
 616                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
 617                         continue;
 618                 }
 619
 620                 if (!t->subtest.get_nr) {
 621                         test_and_print(t, false, -1);
 622                 } else {
 623                         int subn = t->subtest.get_nr();
 624                         /*
 625                          * minus 2 to align with normal testcases.
 626                          * For subtest we print additional '.x' in number.
 627                          * for example:
 628                          *
 629                          * 35: Test LLVM searching and compiling                        :
 630                          * 35.1: Basic BPF llvm compiling test                          : Ok
 631                          */
 632                         int subw = width > 2 ? width - 2 : width;
 633                         bool skip = false;
 634                         int subi;
 635
 636                         if (subn <= 0) {
 637                                 color_fprintf(stderr, PERF_COLOR_YELLOW,
 638                                               " Skip (not compiled in)\n");
 639                                 continue;
 640                         }
 641                         pr_info("\n");
 642
 643                         for (subi = 0; subi < subn; subi++) {
 644                                 int len = strlen(t->subtest.get_desc(subi));
 645
 646                                 if (subw < len)
 647                                         subw = len;
 648                         }
 649
 650                         for (subi = 0; subi < subn; subi++) {
 651                                 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
 652                                         t->subtest.get_desc(subi));
 653                                 err = test_and_print(t, skip, subi);
 654                                 if (err != TEST_OK && t->subtest.skip_if_fail)
 655                                         skip = true;
 656                         }
 657                 }
 658         }
 659
 660         return run_shell_tests(argc, argv, i, width);
 661 }
 662
 663 static int perf_test__list_shell(int argc, const char **argv, int i)
 664 {
 665         DIR *dir;
 666         struct dirent *ent;
 667         char path_dir[PATH_MAX];
 668         const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
 669
 670         if (path == NULL)
 671                 return -1;
 672
 673         dir = opendir(path);
 674         if (!dir)
 675                 return -1;
 676
 677         for_each_shell_test(dir, path, ent) {
 678                 int curr = i++;
 679                 char bf[256];
 680                 struct test t = {
 681                         .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name),
 682                 };
 683
 684                 if (!perf_test__matches(&t, curr, argc, argv))
 685                         continue;
 686
 687                 pr_info("%2d: %s\n", i, t.desc);
 688         }
 689
 690         closedir(dir);
 691         return 0;
 692 }
 693
 694 static int perf_test__list(int argc, const char **argv)
 695 {
 696         unsigned int j;
 697         struct test *t;
 698         int i = 0;
 699
 700         for_each_test(j, t) {
 701                 int curr = i++;
 702
 703                 if (!perf_test__matches(t, curr, argc, argv) ||
 704                     (t->is_supported && !t->is_supported()))
 705                         continue;
 706
 707                 pr_info("%2d: %s\n", i, t->desc);
 708
 709                 if (t->subtest.get_nr) {
 710                         int subn = t->subtest.get_nr();
 711                         int subi;
 712
 713                         for (subi = 0; subi < subn; subi++)
 714                                 pr_info("%2d:%1d: %s\n", i, subi + 1,
 715                                         t->subtest.get_desc(subi));
 716                 }
 717         }
 718
 719         perf_test__list_shell(argc, argv, i);
 720
 721         return 0;
 722 }
 723
 724 int cmd_test(int argc, const char **argv)
 725 {
 726         const char *test_usage[] = {
 727         "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
 728         NULL,
 729         };
 730         const char *skip = NULL;
 731         const struct option test_options[] = {
 732         OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
 733         OPT_INCR('v', "verbose", &verbose,
 734                     "be more verbose (show symbol address, etc)"),
 735         OPT_BOOLEAN('F', "dont-fork", &dont_fork,
 736                     "Do not fork for testcase"),
 737         OPT_END()
 738         };
 739         const char * const test_subcommands[] = { "list", NULL };
 740         struct intlist *skiplist = NULL;
 741         int ret = hists__init();
 742
 743         if (ret < 0)
 744                 return ret;
 745
 746         argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
 747         if (argc >= 1 && !strcmp(argv[0], "list"))
 748                 return perf_test__list(argc - 1, argv + 1);
 749
 750         symbol_conf.priv_size = sizeof(int);
 751         symbol_conf.sort_by_name = true;
 752         symbol_conf.try_vmlinux_path = true;
 753
 754         if (symbol__init(NULL) < 0)
 755                 return -1;
 756
 757         if (skip != NULL)
 758                 skiplist = intlist__new(skip);
 759         /*
 760          * Tests that create BPF maps, for instance, need more than the 64K
 761          * default:
 762          */
 763         rlimit__bump_memlock();
 764
 765         return __cmd_test(argc, argv, skiplist);
 766 }