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 = "maps__merge_in",
 314                 .func = test__maps__merge_in,
 315         },
 316         {
 317                 .func = NULL,
 318         },
 319 };
 320
 321 static struct test *tests[] = {
 322         generic_tests,
 323         arch_tests,
 324 };
 325
 326 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
 327 {
 328         int i;
 329
 330         if (argc == 0)
 331                 return true;
 332
 333         for (i = 0; i < argc; ++i) {
 334                 char *end;
 335                 long nr = strtoul(argv[i], &end, 10);
 336
 337                 if (*end == '\0') {
 338                         if (nr == curr + 1)
 339                                 return true;
 340                         continue;
 341                 }
 342
 343                 if (strcasestr(test->desc, argv[i]))
 344                         return true;
 345         }
 346
 347         return false;
 348 }
 349
 350 static int run_test(struct test *test, int subtest)
 351 {
 352         int status, err = -1, child = dont_fork ? 0 : fork();
 353         char sbuf[STRERR_BUFSIZE];
 354
 355         if (child < 0) {
 356                 pr_err("failed to fork test: %s\n",
 357                         str_error_r(errno, sbuf, sizeof(sbuf)));
 358                 return -1;
 359         }
 360
 361         if (!child) {
 362                 if (!dont_fork) {
 363                         pr_debug("test child forked, pid %d\n", getpid());
 364
 365                         if (verbose <= 0) {
 366                                 int nullfd = open("/dev/null", O_WRONLY);
 367
 368                                 if (nullfd >= 0) {
 369                                         close(STDERR_FILENO);
 370                                         close(STDOUT_FILENO);
 371
 372                                         dup2(nullfd, STDOUT_FILENO);
 373                                         dup2(STDOUT_FILENO, STDERR_FILENO);
 374                                         close(nullfd);
 375                                 }
 376                         } else {
 377                                 signal(SIGSEGV, sighandler_dump_stack);
 378                                 signal(SIGFPE, sighandler_dump_stack);
 379                         }
 380                 }
 381
 382                 err = test->func(test, subtest);
 383                 if (!dont_fork)
 384                         exit(err);
 385         }
 386
 387         if (!dont_fork) {
 388                 wait(&status);
 389
 390                 if (WIFEXITED(status)) {
 391                         err = (signed char)WEXITSTATUS(status);
 392                         pr_debug("test child finished with %d\n", err);
 393                 } else if (WIFSIGNALED(status)) {
 394                         err = -1;
 395                         pr_debug("test child interrupted\n");
 396                 }
 397         }
 398
 399         return err;
 400 }
 401
 402 #define for_each_test(j, t)                                     \
 403         for (j = 0; j < ARRAY_SIZE(tests); j++) \
 404                 for (t = &tests[j][0]; t->func; t++)
 405
 406 static int test_and_print(struct test *t, bool force_skip, int subtest)
 407 {
 408         int err;
 409
 410         if (!force_skip) {
 411                 pr_debug("\n--- start ---\n");
 412                 err = run_test(t, subtest);
 413                 pr_debug("---- end ----\n");
 414         } else {
 415                 pr_debug("\n--- force skipped ---\n");
 416                 err = TEST_SKIP;
 417         }
 418
 419         if (!t->subtest.get_nr)
 420                 pr_debug("%s:", t->desc);
 421         else
 422                 pr_debug("%s subtest %d:", t->desc, subtest + 1);
 423
 424         switch (err) {
 425         case TEST_OK:
 426                 pr_info(" Ok\n");
 427                 break;
 428         case TEST_SKIP:
 429                 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
 430                 break;
 431         case TEST_FAIL:
 432         default:
 433                 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
 434                 break;
 435         }
 436
 437         return err;
 438 }
 439
 440 static const char *shell_test__description(char *description, size_t size,
 441                                            const char *path, const char *name)
 442 {
 443         FILE *fp;
 444         char filename[PATH_MAX];
 445
 446         path__join(filename, sizeof(filename), path, name);
 447         fp = fopen(filename, "r");
 448         if (!fp)
 449                 return NULL;
 450
 451         /* Skip shebang */
 452         while (fgetc(fp) != '\n');
 453
 454         description = fgets(description, size, fp);
 455         fclose(fp);
 456
 457         return description ? strim(description + 1) : NULL;
 458 }
 459
 460 #define for_each_shell_test(dir, base, ent)     \
 461         while ((ent = readdir(dir)) != NULL)    \
 462                 if (!is_directory(base, ent) && ent->d_name[0] != '.')
 463
 464 static const char *shell_tests__dir(char *path, size_t size)
 465 {
 466         const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
 467         char *exec_path;
 468         unsigned int i;
 469
 470         for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
 471                 struct stat st;
 472                 if (!lstat(devel_dirs[i], &st)) {
 473                         scnprintf(path, size, "%s/shell", devel_dirs[i]);
 474                         if (!lstat(devel_dirs[i], &st))
 475                                 return path;
 476                 }
 477         }
 478
 479         /* Then installed path. */
 480         exec_path = get_argv_exec_path();
 481         scnprintf(path, size, "%s/tests/shell", exec_path);
 482         free(exec_path);
 483         return path;
 484 }
 485
 486 static int shell_tests__max_desc_width(void)
 487 {
 488         DIR *dir;
 489         struct dirent *ent;
 490         char path_dir[PATH_MAX];
 491         const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
 492         int width = 0;
 493
 494         if (path == NULL)
 495                 return -1;
 496
 497         dir = opendir(path);
 498         if (!dir)
 499                 return -1;
 500
 501         for_each_shell_test(dir, path, ent) {
 502                 char bf[256];
 503                 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name);
 504
 505                 if (desc) {
 506                         int len = strlen(desc);
 507
 508                         if (width < len)
 509                                 width = len;
 510                 }
 511         }
 512
 513         closedir(dir);
 514         return width;
 515 }
 516
 517 struct shell_test {
 518         const char *dir;
 519         const char *file;
 520 };
 521
 522 static int shell_test__run(struct test *test, int subdir __maybe_unused)
 523 {
 524         int err;
 525         char script[PATH_MAX];
 526         struct shell_test *st = test->priv;
 527
 528         path__join(script, sizeof(script), st->dir, st->file);
 529
 530         err = system(script);
 531         if (!err)
 532                 return TEST_OK;
 533
 534         return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL;
 535 }
 536
 537 static int run_shell_tests(int argc, const char *argv[], int i, int width)
 538 {
 539         DIR *dir;
 540         struct dirent *ent;
 541         char path_dir[PATH_MAX];
 542         struct shell_test st = {
 543                 .dir = shell_tests__dir(path_dir, sizeof(path_dir)),
 544         };
 545
 546         if (st.dir == NULL)
 547                 return -1;
 548
 549         dir = opendir(st.dir);
 550         if (!dir) {
 551                 pr_err("failed to open shell test directory: %s\n",
 552                         st.dir);
 553                 return -1;
 554         }
 555
 556         for_each_shell_test(dir, st.dir, ent) {
 557                 int curr = i++;
 558                 char desc[256];
 559                 struct test test = {
 560                         .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name),
 561                         .func = shell_test__run,
 562                         .priv = &st,
 563                 };
 564
 565                 if (!perf_test__matches(&test, curr, argc, argv))
 566                         continue;
 567
 568                 st.file = ent->d_name;
 569                 pr_info("%2d: %-*s:", i, width, test.desc);
 570                 test_and_print(&test, false, -1);
 571         }
 572
 573         closedir(dir);
 574         return 0;
 575 }
 576
 577 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
 578 {
 579         struct test *t;
 580         unsigned int j;
 581         int i = 0;
 582         int width = shell_tests__max_desc_width();
 583
 584         for_each_test(j, t) {
 585                 int len = strlen(t->desc);
 586
 587                 if (width < len)
 588                         width = len;
 589         }
 590
 591         for_each_test(j, t) {
 592                 int curr = i++, err;
 593
 594                 if (!perf_test__matches(t, curr, argc, argv))
 595                         continue;
 596
 597                 if (t->is_supported && !t->is_supported()) {
 598                         pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc);
 599                         continue;
 600                 }
 601
 602                 pr_info("%2d: %-*s:", i, width, t->desc);
 603
 604                 if (intlist__find(skiplist, i)) {
 605                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
 606                         continue;
 607                 }
 608
 609                 if (!t->subtest.get_nr) {
 610                         test_and_print(t, false, -1);
 611                 } else {
 612                         int subn = t->subtest.get_nr();
 613                         /*
 614                          * minus 2 to align with normal testcases.
 615                          * For subtest we print additional '.x' in number.
 616                          * for example:
 617                          *
 618                          * 35: Test LLVM searching and compiling                        :
 619                          * 35.1: Basic BPF llvm compiling test                          : Ok
 620                          */
 621                         int subw = width > 2 ? width - 2 : width;
 622                         bool skip = false;
 623                         int subi;
 624
 625                         if (subn <= 0) {
 626                                 color_fprintf(stderr, PERF_COLOR_YELLOW,
 627                                               " Skip (not compiled in)\n");
 628                                 continue;
 629                         }
 630                         pr_info("\n");
 631
 632                         for (subi = 0; subi < subn; subi++) {
 633                                 int len = strlen(t->subtest.get_desc(subi));
 634
 635                                 if (subw < len)
 636                                         subw = len;
 637                         }
 638
 639                         for (subi = 0; subi < subn; subi++) {
 640                                 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
 641                                         t->subtest.get_desc(subi));
 642                                 err = test_and_print(t, skip, subi);
 643                                 if (err != TEST_OK && t->subtest.skip_if_fail)
 644                                         skip = true;
 645                         }
 646                 }
 647         }
 648
 649         return run_shell_tests(argc, argv, i, width);
 650 }
 651
 652 static int perf_test__list_shell(int argc, const char **argv, int i)
 653 {
 654         DIR *dir;
 655         struct dirent *ent;
 656         char path_dir[PATH_MAX];
 657         const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
 658
 659         if (path == NULL)
 660                 return -1;
 661
 662         dir = opendir(path);
 663         if (!dir)
 664                 return -1;
 665
 666         for_each_shell_test(dir, path, ent) {
 667                 int curr = i++;
 668                 char bf[256];
 669                 struct test t = {
 670                         .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name),
 671                 };
 672
 673                 if (!perf_test__matches(&t, curr, argc, argv))
 674                         continue;
 675
 676                 pr_info("%2d: %s\n", i, t.desc);
 677         }
 678
 679         closedir(dir);
 680         return 0;
 681 }
 682
 683 static int perf_test__list(int argc, const char **argv)
 684 {
 685         unsigned int j;
 686         struct test *t;
 687         int i = 0;
 688
 689         for_each_test(j, t) {
 690                 int curr = i++;
 691
 692                 if (!perf_test__matches(t, curr, argc, argv) ||
 693                     (t->is_supported && !t->is_supported()))
 694                         continue;
 695
 696                 pr_info("%2d: %s\n", i, t->desc);
 697
 698                 if (t->subtest.get_nr) {
 699                         int subn = t->subtest.get_nr();
 700                         int subi;
 701
 702                         for (subi = 0; subi < subn; subi++)
 703                                 pr_info("%2d:%1d: %s\n", i, subi + 1,
 704                                         t->subtest.get_desc(subi));
 705                 }
 706         }
 707
 708         perf_test__list_shell(argc, argv, i);
 709
 710         return 0;
 711 }
 712
 713 int cmd_test(int argc, const char **argv)
 714 {
 715         const char *test_usage[] = {
 716         "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
 717         NULL,
 718         };
 719         const char *skip = NULL;
 720         const struct option test_options[] = {
 721         OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
 722         OPT_INCR('v', "verbose", &verbose,
 723                     "be more verbose (show symbol address, etc)"),
 724         OPT_BOOLEAN('F', "dont-fork", &dont_fork,
 725                     "Do not fork for testcase"),
 726         OPT_END()
 727         };
 728         const char * const test_subcommands[] = { "list", NULL };
 729         struct intlist *skiplist = NULL;
 730         int ret = hists__init();
 731
 732         if (ret < 0)
 733                 return ret;
 734
 735         argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
 736         if (argc >= 1 && !strcmp(argv[0], "list"))
 737                 return perf_test__list(argc - 1, argv + 1);
 738
 739         symbol_conf.priv_size = sizeof(int);
 740         symbol_conf.sort_by_name = true;
 741         symbol_conf.try_vmlinux_path = true;
 742
 743         if (symbol__init(NULL) < 0)
 744                 return -1;
 745
 746         if (skip != NULL)
 747                 skiplist = intlist__new(skip);
 748         /*
 749          * Tests that create BPF maps, for instance, need more than the 64K
 750          * default:
 751          */
 752         rlimit__bump_memlock();
 753
 754         return __cmd_test(argc, argv, skiplist);
 755 }