tools/perf/tests/builtin-test.c

   1 /*
   2  * builtin-test.c
   3  *
   4  * Builtin regression testing command: ever growing number of sanity tests
   5  */
   6 #include <unistd.h>
   7 #include <string.h>
   8 #include "builtin.h"
   9 #include "hist.h"
  10 #include "intlist.h"
  11 #include "tests.h"
  12 #include "debug.h"
  13 #include "color.h"
  14 #include <subcmd/parse-options.h>
  15 #include "symbol.h"
  16
  17 static bool dont_fork;
  18
  19 struct test __weak arch_tests[] = {
  20         {
  21                 .func = NULL,
  22         },
  23 };
  24
  25 static struct test generic_tests[] = {
  26         {
  27                 .desc = "vmlinux symtab matches kallsyms",
  28                 .func = test__vmlinux_matches_kallsyms,
  29         },
  30         {
  31                 .desc = "Detect openat syscall event",
  32                 .func = test__openat_syscall_event,
  33         },
  34         {
  35                 .desc = "Detect openat syscall event on all cpus",
  36                 .func = test__openat_syscall_event_on_all_cpus,
  37         },
  38         {
  39                 .desc = "Read samples using the mmap interface",
  40                 .func = test__basic_mmap,
  41         },
  42         {
  43                 .desc = "Parse event definition strings",
  44                 .func = test__parse_events,
  45         },
  46         {
  47                 .desc = "PERF_RECORD_* events & perf_sample fields",
  48                 .func = test__PERF_RECORD,
  49         },
  50         {
  51                 .desc = "Parse perf pmu format",
  52                 .func = test__pmu,
  53         },
  54         {
  55                 .desc = "DSO data read",
  56                 .func = test__dso_data,
  57         },
  58         {
  59                 .desc = "DSO data cache",
  60                 .func = test__dso_data_cache,
  61         },
  62         {
  63                 .desc = "DSO data reopen",
  64                 .func = test__dso_data_reopen,
  65         },
  66         {
  67                 .desc = "Roundtrip evsel->name",
  68                 .func = test__perf_evsel__roundtrip_name_test,
  69         },
  70         {
  71                 .desc = "Parse sched tracepoints fields",
  72                 .func = test__perf_evsel__tp_sched_test,
  73         },
  74         {
  75                 .desc = "syscalls:sys_enter_openat event fields",
  76                 .func = test__syscall_openat_tp_fields,
  77         },
  78         {
  79                 .desc = "Setup struct perf_event_attr",
  80                 .func = test__attr,
  81         },
  82         {
  83                 .desc = "Match and link multiple hists",
  84                 .func = test__hists_link,
  85         },
  86         {
  87                 .desc = "'import perf' in python",
  88                 .func = test__python_use,
  89         },
  90         {
  91                 .desc = "Breakpoint overflow signal handler",
  92                 .func = test__bp_signal,
  93         },
  94         {
  95                 .desc = "Breakpoint overflow sampling",
  96                 .func = test__bp_signal_overflow,
  97         },
  98         {
  99                 .desc = "Number of exit events of a simple workload",
 100                 .func = test__task_exit,
 101         },
 102         {
 103                 .desc = "Software clock events period values",
 104                 .func = test__sw_clock_freq,
 105         },
 106         {
 107                 .desc = "Object code reading",
 108                 .func = test__code_reading,
 109         },
 110         {
 111                 .desc = "Sample parsing",
 112                 .func = test__sample_parsing,
 113         },
 114         {
 115                 .desc = "Use a dummy software event to keep tracking",
 116                 .func = test__keep_tracking,
 117         },
 118         {
 119                 .desc = "Parse with no sample_id_all bit set",
 120                 .func = test__parse_no_sample_id_all,
 121         },
 122         {
 123                 .desc = "Filter hist entries",
 124                 .func = test__hists_filter,
 125         },
 126         {
 127                 .desc = "Lookup mmap thread",
 128                 .func = test__mmap_thread_lookup,
 129         },
 130         {
 131                 .desc = "Share thread mg",
 132                 .func = test__thread_mg_share,
 133         },
 134         {
 135                 .desc = "Sort output of hist entries",
 136                 .func = test__hists_output,
 137         },
 138         {
 139                 .desc = "Cumulate child hist entries",
 140                 .func = test__hists_cumulate,
 141         },
 142         {
 143                 .desc = "Track with sched_switch",
 144                 .func = test__switch_tracking,
 145         },
 146         {
 147                 .desc = "Filter fds with revents mask in a fdarray",
 148                 .func = test__fdarray__filter,
 149         },
 150         {
 151                 .desc = "Add fd to a fdarray, making it autogrow",
 152                 .func = test__fdarray__add,
 153         },
 154         {
 155                 .desc = "kmod_path__parse",
 156                 .func = test__kmod_path__parse,
 157         },
 158         {
 159                 .desc = "Thread map",
 160                 .func = test__thread_map,
 161         },
 162         {
 163                 .desc = "LLVM search and compile",
 164                 .func = test__llvm,
 165                 .subtest = {
 166                         .skip_if_fail   = true,
 167                         .get_nr         = test__llvm_subtest_get_nr,
 168                         .get_desc       = test__llvm_subtest_get_desc,
 169                 },
 170         },
 171         {
 172                 .desc = "Session topology",
 173                 .func = test_session_topology,
 174         },
 175         {
 176                 .desc = "BPF filter",
 177                 .func = test__bpf,
 178                 .subtest = {
 179                         .skip_if_fail   = true,
 180                         .get_nr         = test__bpf_subtest_get_nr,
 181                         .get_desc       = test__bpf_subtest_get_desc,
 182                 },
 183         },
 184         {
 185                 .desc = "Synthesize thread map",
 186                 .func = test__thread_map_synthesize,
 187         },
 188         {
 189                 .desc = "Synthesize cpu map",
 190                 .func = test__cpu_map_synthesize,
 191         },
 192         {
 193                 .desc = "Synthesize stat config",
 194                 .func = test__synthesize_stat_config,
 195         },
 196         {
 197                 .desc = "Synthesize stat",
 198                 .func = test__synthesize_stat,
 199         },
 200         {
 201                 .desc = "Synthesize stat round",
 202                 .func = test__synthesize_stat_round,
 203         },
 204         {
 205                 .desc = "Synthesize attr update",
 206                 .func = test__event_update,
 207         },
 208         {
 209                 .desc = "Event times",
 210                 .func = test__event_times,
 211         },
 212         {
 213                 .desc = "Read backward ring buffer",
 214                 .func = test__backward_ring_buffer,
 215         },
 216         {
 217                 .desc = "Print cpu map",
 218                 .func = test__cpu_map_print,
 219         },
 220         {
 221                 .desc = "Probe SDT events",
 222                 .func = test__sdt_event,
 223         },
 224         {
 225                 .desc = "is_printable_array",
 226                 .func = test__is_printable_array,
 227         },
 228         {
 229                 .desc = "Print bitmap",
 230                 .func = test__bitmap_print,
 231         },
 232         {
 233                 .desc = "perf hooks",
 234                 .func = test__perf_hooks,
 235         },
 236         {
 237                 .desc = "builtin clang support",
 238                 .func = test__clang,
 239                 .subtest = {
 240                         .skip_if_fail   = true,
 241                         .get_nr         = test__clang_subtest_get_nr,
 242                         .get_desc       = test__clang_subtest_get_desc,
 243                 }
 244         },
 245         {
 246                 .func = NULL,
 247         },
 248 };
 249
 250 static struct test *tests[] = {
 251         generic_tests,
 252         arch_tests,
 253 };
 254
 255 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
 256 {
 257         int i;
 258
 259         if (argc == 0)
 260                 return true;
 261
 262         for (i = 0; i < argc; ++i) {
 263                 char *end;
 264                 long nr = strtoul(argv[i], &end, 10);
 265
 266                 if (*end == '\0') {
 267                         if (nr == curr + 1)
 268                                 return true;
 269                         continue;
 270                 }
 271
 272                 if (strcasestr(test->desc, argv[i]))
 273                         return true;
 274         }
 275
 276         return false;
 277 }
 278
 279 static int run_test(struct test *test, int subtest)
 280 {
 281         int status, err = -1, child = dont_fork ? 0 : fork();
 282         char sbuf[STRERR_BUFSIZE];
 283
 284         if (child < 0) {
 285                 pr_err("failed to fork test: %s\n",
 286                         str_error_r(errno, sbuf, sizeof(sbuf)));
 287                 return -1;
 288         }
 289
 290         if (!child) {
 291                 if (!dont_fork) {
 292                         pr_debug("test child forked, pid %d\n", getpid());
 293
 294                         if (!verbose) {
 295                                 int nullfd = open("/dev/null", O_WRONLY);
 296
 297                                 if (nullfd >= 0) {
 298                                         close(STDERR_FILENO);
 299                                         close(STDOUT_FILENO);
 300
 301                                         dup2(nullfd, STDOUT_FILENO);
 302                                         dup2(STDOUT_FILENO, STDERR_FILENO);
 303                                         close(nullfd);
 304                                 }
 305                         } else {
 306                                 signal(SIGSEGV, sighandler_dump_stack);
 307                                 signal(SIGFPE, sighandler_dump_stack);
 308                         }
 309                 }
 310
 311                 err = test->func(subtest);
 312                 if (!dont_fork)
 313                         exit(err);
 314         }
 315
 316         if (!dont_fork) {
 317                 wait(&status);
 318
 319                 if (WIFEXITED(status)) {
 320                         err = (signed char)WEXITSTATUS(status);
 321                         pr_debug("test child finished with %d\n", err);
 322                 } else if (WIFSIGNALED(status)) {
 323                         err = -1;
 324                         pr_debug("test child interrupted\n");
 325                 }
 326         }
 327
 328         return err;
 329 }
 330
 331 #define for_each_test(j, t)                                     \
 332         for (j = 0; j < ARRAY_SIZE(tests); j++) \
 333                 for (t = &tests[j][0]; t->func; t++)
 334
 335 static int test_and_print(struct test *t, bool force_skip, int subtest)
 336 {
 337         int err;
 338
 339         if (!force_skip) {
 340                 pr_debug("\n--- start ---\n");
 341                 err = run_test(t, subtest);
 342                 pr_debug("---- end ----\n");
 343         } else {
 344                 pr_debug("\n--- force skipped ---\n");
 345                 err = TEST_SKIP;
 346         }
 347
 348         if (!t->subtest.get_nr)
 349                 pr_debug("%s:", t->desc);
 350         else
 351                 pr_debug("%s subtest %d:", t->desc, subtest);
 352
 353         switch (err) {
 354         case TEST_OK:
 355                 pr_info(" Ok\n");
 356                 break;
 357         case TEST_SKIP:
 358                 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
 359                 break;
 360         case TEST_FAIL:
 361         default:
 362                 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
 363                 break;
 364         }
 365
 366         return err;
 367 }
 368
 369 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
 370 {
 371         struct test *t;
 372         unsigned int j;
 373         int i = 0;
 374         int width = 0;
 375
 376         for_each_test(j, t) {
 377                 int len = strlen(t->desc);
 378
 379                 if (width < len)
 380                         width = len;
 381         }
 382
 383         for_each_test(j, t) {
 384                 int curr = i++, err;
 385
 386                 if (!perf_test__matches(t, curr, argc, argv))
 387                         continue;
 388
 389                 pr_info("%2d: %-*s:", i, width, t->desc);
 390
 391                 if (intlist__find(skiplist, i)) {
 392                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
 393                         continue;
 394                 }
 395
 396                 if (!t->subtest.get_nr) {
 397                         test_and_print(t, false, -1);
 398                 } else {
 399                         int subn = t->subtest.get_nr();
 400                         /*
 401                          * minus 2 to align with normal testcases.
 402                          * For subtest we print additional '.x' in number.
 403                          * for example:
 404                          *
 405                          * 35: Test LLVM searching and compiling                        :
 406                          * 35.1: Basic BPF llvm compiling test                          : Ok
 407                          */
 408                         int subw = width > 2 ? width - 2 : width;
 409                         bool skip = false;
 410                         int subi;
 411
 412                         if (subn <= 0) {
 413                                 color_fprintf(stderr, PERF_COLOR_YELLOW,
 414                                               " Skip (not compiled in)\n");
 415                                 continue;
 416                         }
 417                         pr_info("\n");
 418
 419                         for (subi = 0; subi < subn; subi++) {
 420                                 int len = strlen(t->subtest.get_desc(subi));
 421
 422                                 if (subw < len)
 423                                         subw = len;
 424                         }
 425
 426                         for (subi = 0; subi < subn; subi++) {
 427                                 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
 428                                         t->subtest.get_desc(subi));
 429                                 err = test_and_print(t, skip, subi);
 430                                 if (err != TEST_OK && t->subtest.skip_if_fail)
 431                                         skip = true;
 432                         }
 433                 }
 434         }
 435
 436         return 0;
 437 }
 438
 439 static int perf_test__list(int argc, const char **argv)
 440 {
 441         unsigned int j;
 442         struct test *t;
 443         int i = 0;
 444
 445         for_each_test(j, t) {
 446                 if (argc > 1 && !strstr(t->desc, argv[1]))
 447                         continue;
 448
 449                 pr_info("%2d: %s\n", ++i, t->desc);
 450         }
 451
 452         return 0;
 453 }
 454
 455 int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
 456 {
 457         const char *test_usage[] = {
 458         "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
 459         NULL,
 460         };
 461         const char *skip = NULL;
 462         const struct option test_options[] = {
 463         OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
 464         OPT_INCR('v', "verbose", &verbose,
 465                     "be more verbose (show symbol address, etc)"),
 466         OPT_BOOLEAN('F', "dont-fork", &dont_fork,
 467                     "Do not fork for testcase"),
 468         OPT_END()
 469         };
 470         const char * const test_subcommands[] = { "list", NULL };
 471         struct intlist *skiplist = NULL;
 472         int ret = hists__init();
 473
 474         if (ret < 0)
 475                 return ret;
 476
 477         argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
 478         if (argc >= 1 && !strcmp(argv[0], "list"))
 479                 return perf_test__list(argc, argv);
 480
 481         symbol_conf.priv_size = sizeof(int);
 482         symbol_conf.sort_by_name = true;
 483         symbol_conf.try_vmlinux_path = true;
 484
 485         if (symbol__init(NULL) < 0)
 486                 return -1;
 487
 488         if (skip != NULL)
 489                 skiplist = intlist__new(skip);
 490
 491         return __cmd_test(argc, argv, skiplist);
 492 }