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