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 = "Remove thread map",
 190                 .func = test__thread_map_remove,
 191         },
 192         {
 193                 .desc = "Synthesize cpu map",
 194                 .func = test__cpu_map_synthesize,
 195         },
 196         {
 197                 .desc = "Synthesize stat config",
 198                 .func = test__synthesize_stat_config,
 199         },
 200         {
 201                 .desc = "Synthesize stat",
 202                 .func = test__synthesize_stat,
 203         },
 204         {
 205                 .desc = "Synthesize stat round",
 206                 .func = test__synthesize_stat_round,
 207         },
 208         {
 209                 .desc = "Synthesize attr update",
 210                 .func = test__event_update,
 211         },
 212         {
 213                 .desc = "Event times",
 214                 .func = test__event_times,
 215         },
 216         {
 217                 .desc = "Read backward ring buffer",
 218                 .func = test__backward_ring_buffer,
 219         },
 220         {
 221                 .desc = "Print cpu map",
 222                 .func = test__cpu_map_print,
 223         },
 224         {
 225                 .desc = "Probe SDT events",
 226                 .func = test__sdt_event,
 227         },
 228         {
 229                 .desc = "is_printable_array",
 230                 .func = test__is_printable_array,
 231         },
 232         {
 233                 .desc = "Print bitmap",
 234                 .func = test__bitmap_print,
 235         },
 236         {
 237                 .desc = "perf hooks",
 238                 .func = test__perf_hooks,
 239         },
 240         {
 241                 .desc = "builtin clang support",
 242                 .func = test__clang,
 243                 .subtest = {
 244                         .skip_if_fail   = true,
 245                         .get_nr         = test__clang_subtest_get_nr,
 246                         .get_desc       = test__clang_subtest_get_desc,
 247                 }
 248         },
 249         {
 250                 .func = NULL,
 251         },
 252 };
 253
 254 static struct test *tests[] = {
 255         generic_tests,
 256         arch_tests,
 257 };
 258
 259 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
 260 {
 261         int i;
 262
 263         if (argc == 0)
 264                 return true;
 265
 266         for (i = 0; i < argc; ++i) {
 267                 char *end;
 268                 long nr = strtoul(argv[i], &end, 10);
 269
 270                 if (*end == '\0') {
 271                         if (nr == curr + 1)
 272                                 return true;
 273                         continue;
 274                 }
 275
 276                 if (strcasestr(test->desc, argv[i]))
 277                         return true;
 278         }
 279
 280         return false;
 281 }
 282
 283 static int run_test(struct test *test, int subtest)
 284 {
 285         int status, err = -1, child = dont_fork ? 0 : fork();
 286         char sbuf[STRERR_BUFSIZE];
 287
 288         if (child < 0) {
 289                 pr_err("failed to fork test: %s\n",
 290                         str_error_r(errno, sbuf, sizeof(sbuf)));
 291                 return -1;
 292         }
 293
 294         if (!child) {
 295                 if (!dont_fork) {
 296                         pr_debug("test child forked, pid %d\n", getpid());
 297
 298                         if (!verbose) {
 299                                 int nullfd = open("/dev/null", O_WRONLY);
 300
 301                                 if (nullfd >= 0) {
 302                                         close(STDERR_FILENO);
 303                                         close(STDOUT_FILENO);
 304
 305                                         dup2(nullfd, STDOUT_FILENO);
 306                                         dup2(STDOUT_FILENO, STDERR_FILENO);
 307                                         close(nullfd);
 308                                 }
 309                         } else {
 310                                 signal(SIGSEGV, sighandler_dump_stack);
 311                                 signal(SIGFPE, sighandler_dump_stack);
 312                         }
 313                 }
 314
 315                 err = test->func(subtest);
 316                 if (!dont_fork)
 317                         exit(err);
 318         }
 319
 320         if (!dont_fork) {
 321                 wait(&status);
 322
 323                 if (WIFEXITED(status)) {
 324                         err = (signed char)WEXITSTATUS(status);
 325                         pr_debug("test child finished with %d\n", err);
 326                 } else if (WIFSIGNALED(status)) {
 327                         err = -1;
 328                         pr_debug("test child interrupted\n");
 329                 }
 330         }
 331
 332         return err;
 333 }
 334
 335 #define for_each_test(j, t)                                     \
 336         for (j = 0; j < ARRAY_SIZE(tests); j++) \
 337                 for (t = &tests[j][0]; t->func; t++)
 338
 339 static int test_and_print(struct test *t, bool force_skip, int subtest)
 340 {
 341         int err;
 342
 343         if (!force_skip) {
 344                 pr_debug("\n--- start ---\n");
 345                 err = run_test(t, subtest);
 346                 pr_debug("---- end ----\n");
 347         } else {
 348                 pr_debug("\n--- force skipped ---\n");
 349                 err = TEST_SKIP;
 350         }
 351
 352         if (!t->subtest.get_nr)
 353                 pr_debug("%s:", t->desc);
 354         else
 355                 pr_debug("%s subtest %d:", t->desc, subtest);
 356
 357         switch (err) {
 358         case TEST_OK:
 359                 pr_info(" Ok\n");
 360                 break;
 361         case TEST_SKIP:
 362                 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
 363                 break;
 364         case TEST_FAIL:
 365         default:
 366                 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
 367                 break;
 368         }
 369
 370         return err;
 371 }
 372
 373 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
 374 {
 375         struct test *t;
 376         unsigned int j;
 377         int i = 0;
 378         int width = 0;
 379
 380         for_each_test(j, t) {
 381                 int len = strlen(t->desc);
 382
 383                 if (width < len)
 384                         width = len;
 385         }
 386
 387         for_each_test(j, t) {
 388                 int curr = i++, err;
 389
 390                 if (!perf_test__matches(t, curr, argc, argv))
 391                         continue;
 392
 393                 pr_info("%2d: %-*s:", i, width, t->desc);
 394
 395                 if (intlist__find(skiplist, i)) {
 396                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
 397                         continue;
 398                 }
 399
 400                 if (!t->subtest.get_nr) {
 401                         test_and_print(t, false, -1);
 402                 } else {
 403                         int subn = t->subtest.get_nr();
 404                         /*
 405                          * minus 2 to align with normal testcases.
 406                          * For subtest we print additional '.x' in number.
 407                          * for example:
 408                          *
 409                          * 35: Test LLVM searching and compiling                        :
 410                          * 35.1: Basic BPF llvm compiling test                          : Ok
 411                          */
 412                         int subw = width > 2 ? width - 2 : width;
 413                         bool skip = false;
 414                         int subi;
 415
 416                         if (subn <= 0) {
 417                                 color_fprintf(stderr, PERF_COLOR_YELLOW,
 418                                               " Skip (not compiled in)\n");
 419                                 continue;
 420                         }
 421                         pr_info("\n");
 422
 423                         for (subi = 0; subi < subn; subi++) {
 424                                 int len = strlen(t->subtest.get_desc(subi));
 425
 426                                 if (subw < len)
 427                                         subw = len;
 428                         }
 429
 430                         for (subi = 0; subi < subn; subi++) {
 431                                 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
 432                                         t->subtest.get_desc(subi));
 433                                 err = test_and_print(t, skip, subi);
 434                                 if (err != TEST_OK && t->subtest.skip_if_fail)
 435                                         skip = true;
 436                         }
 437                 }
 438         }
 439
 440         return 0;
 441 }
 442
 443 static int perf_test__list(int argc, const char **argv)
 444 {
 445         unsigned int j;
 446         struct test *t;
 447         int i = 0;
 448
 449         for_each_test(j, t) {
 450                 if (argc > 1 && !strstr(t->desc, argv[1]))
 451                         continue;
 452
 453                 pr_info("%2d: %s\n", ++i, t->desc);
 454         }
 455
 456         return 0;
 457 }
 458
 459 int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
 460 {
 461         const char *test_usage[] = {
 462         "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
 463         NULL,
 464         };
 465         const char *skip = NULL;
 466         const struct option test_options[] = {
 467         OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
 468         OPT_INCR('v', "verbose", &verbose,
 469                     "be more verbose (show symbol address, etc)"),
 470         OPT_BOOLEAN('F', "dont-fork", &dont_fork,
 471                     "Do not fork for testcase"),
 472         OPT_END()
 473         };
 474         const char * const test_subcommands[] = { "list", NULL };
 475         struct intlist *skiplist = NULL;
 476         int ret = hists__init();
 477
 478         if (ret < 0)
 479                 return ret;
 480
 481         argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
 482         if (argc >= 1 && !strcmp(argv[0], "list"))
 483                 return perf_test__list(argc, argv);
 484
 485         symbol_conf.priv_size = sizeof(int);
 486         symbol_conf.sort_by_name = true;
 487         symbol_conf.try_vmlinux_path = true;
 488
 489         if (symbol__init(NULL) < 0)
 490                 return -1;
 491
 492         if (skip != NULL)
 493                 skiplist = intlist__new(skip);
 494
 495         return __cmd_test(argc, argv, skiplist);
 496 }