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 <poll.h> 10 #include <unistd.h> 11 #include <string.h> 12 #include <stdlib.h> 13 #include <sys/types.h> 14 #include <dirent.h> 15 #include <sys/wait.h> 16 #include <sys/stat.h> 17 #include "builtin.h" 18 #include "config.h" 19 #include "hist.h" 20 #include "intlist.h" 21 #include "tests.h" 22 #include "debug.h" 23 #include "color.h" 24 #include <subcmd/parse-options.h> 25 #include <subcmd/run-command.h> 26 #include "string2.h" 27 #include "symbol.h" 28 #include "util/rlimit.h" 29 #include "util/strbuf.h" 30 #include <linux/kernel.h> 31 #include <linux/string.h> 32 #include <subcmd/exec-cmd.h> 33 #include <linux/zalloc.h> 34 35 #include "tests-scripts.h" 36 37 /* 38 * Command line option to not fork the test running in the same process and 39 * making them easier to debug. 40 */ 41 static bool dont_fork; 42 /* Don't fork the tests in parallel and wait for their completion. */ 43 static bool sequential; 44 const char *dso_to_test; 45 const char *test_objdump_path = "objdump"; 46 47 /* 48 * List of architecture specific tests. Not a weak symbol as the array length is 49 * dependent on the initialization, as such GCC with LTO complains of 50 * conflicting definitions with a weak symbol. 51 */ 52 #if defined(__i386__) || defined(__x86_64__) || defined(__aarch64__) || defined(__powerpc64__) 53 extern struct test_suite *arch_tests[]; 54 #else 55 static struct test_suite *arch_tests[] = { 56 NULL, 57 }; 58 #endif 59 60 static struct test_suite *generic_tests[] = { 61 &suite__vmlinux_matches_kallsyms, 62 #ifdef HAVE_LIBTRACEEVENT 63 &suite__openat_syscall_event, 64 &suite__openat_syscall_event_on_all_cpus, 65 &suite__basic_mmap, 66 #endif 67 &suite__mem, 68 &suite__parse_events, 69 &suite__expr, 70 &suite__PERF_RECORD, 71 &suite__pmu, 72 &suite__pmu_events, 73 &suite__dso_data, 74 &suite__perf_evsel__roundtrip_name_test, 75 #ifdef HAVE_LIBTRACEEVENT 76 &suite__perf_evsel__tp_sched_test, 77 &suite__syscall_openat_tp_fields, 78 #endif 79 &suite__attr, 80 &suite__hists_link, 81 &suite__python_use, 82 &suite__bp_signal, 83 &suite__bp_signal_overflow, 84 &suite__bp_accounting, 85 &suite__wp, 86 &suite__task_exit, 87 &suite__sw_clock_freq, 88 &suite__code_reading, 89 &suite__sample_parsing, 90 &suite__keep_tracking, 91 &suite__parse_no_sample_id_all, 92 &suite__hists_filter, 93 &suite__mmap_thread_lookup, 94 &suite__thread_maps_share, 95 &suite__hists_output, 96 &suite__hists_cumulate, 97 #ifdef HAVE_LIBTRACEEVENT 98 &suite__switch_tracking, 99 #endif 100 &suite__fdarray__filter, 101 &suite__fdarray__add, 102 &suite__kmod_path__parse, 103 &suite__thread_map, 104 &suite__session_topology, 105 &suite__thread_map_synthesize, 106 &suite__thread_map_remove, 107 &suite__cpu_map, 108 &suite__synthesize_stat_config, 109 &suite__synthesize_stat, 110 &suite__synthesize_stat_round, 111 &suite__event_update, 112 &suite__event_times, 113 &suite__backward_ring_buffer, 114 &suite__sdt_event, 115 &suite__is_printable_array, 116 &suite__bitmap_print, 117 &suite__perf_hooks, 118 &suite__unit_number__scnprint, 119 &suite__mem2node, 120 &suite__time_utils, 121 &suite__jit_write_elf, 122 &suite__pfm, 123 &suite__api_io, 124 &suite__maps__merge_in, 125 &suite__demangle_java, 126 &suite__demangle_ocaml, 127 &suite__parse_metric, 128 &suite__pe_file_parsing, 129 &suite__expand_cgroup_events, 130 &suite__perf_time_to_tsc, 131 &suite__dlfilter, 132 &suite__sigtrap, 133 &suite__event_groups, 134 &suite__symbols, 135 &suite__util, 136 NULL, 137 }; 138 139 static struct test_suite **tests[] = { 140 generic_tests, 141 arch_tests, 142 NULL, /* shell tests created at runtime. */ 143 }; 144 145 static struct test_workload *workloads[] = { 146 &workload__noploop, 147 &workload__thloop, 148 &workload__leafloop, 149 &workload__sqrtloop, 150 &workload__brstack, 151 &workload__datasym, 152 }; 153 154 static int num_subtests(const struct test_suite *t) 155 { 156 int num; 157 158 if (!t->test_cases) 159 return 0; 160 161 num = 0; 162 while (t->test_cases[num].name) 163 num++; 164 165 return num; 166 } 167 168 static bool has_subtests(const struct test_suite *t) 169 { 170 return num_subtests(t) > 1; 171 } 172 173 static const char *skip_reason(const struct test_suite *t, int subtest) 174 { 175 if (!t->test_cases) 176 return NULL; 177 178 return t->test_cases[subtest >= 0 ? subtest : 0].skip_reason; 179 } 180 181 static const char *test_description(const struct test_suite *t, int subtest) 182 { 183 if (t->test_cases && subtest >= 0) 184 return t->test_cases[subtest].desc; 185 186 return t->desc; 187 } 188 189 static test_fnptr test_function(const struct test_suite *t, int subtest) 190 { 191 if (subtest <= 0) 192 return t->test_cases[0].run_case; 193 194 return t->test_cases[subtest].run_case; 195 } 196 197 static bool perf_test__matches(const char *desc, int curr, int argc, const char *argv[]) 198 { 199 int i; 200 201 if (argc == 0) 202 return true; 203 204 for (i = 0; i < argc; ++i) { 205 char *end; 206 long nr = strtoul(argv[i], &end, 10); 207 208 if (*end == '\0') { 209 if (nr == curr + 1) 210 return true; 211 continue; 212 } 213 214 if (strcasestr(desc, argv[i])) 215 return true; 216 } 217 218 return false; 219 } 220 221 struct child_test { 222 struct child_process process; 223 struct test_suite *test; 224 int test_num; 225 int subtest; 226 }; 227 228 static int run_test_child(struct child_process *process) 229 { 230 struct child_test *child = container_of(process, struct child_test, process); 231 int err; 232 233 pr_debug("--- start ---\n"); 234 pr_debug("test child forked, pid %d\n", getpid()); 235 err = test_function(child->test, child->subtest)(child->test, child->subtest); 236 pr_debug("---- end(%d) ----\n", err); 237 fflush(NULL); 238 return -err; 239 } 240 241 static int print_test_result(struct test_suite *t, int i, int subtest, int result, int width) 242 { 243 if (has_subtests(t)) { 244 int subw = width > 2 ? width - 2 : width; 245 246 pr_info("%3d.%1d: %-*s:", i + 1, subtest + 1, subw, test_description(t, subtest)); 247 } else 248 pr_info("%3d: %-*s:", i + 1, width, test_description(t, subtest)); 249 250 switch (result) { 251 case TEST_OK: 252 pr_info(" Ok\n"); 253 break; 254 case TEST_SKIP: { 255 const char *reason = skip_reason(t, subtest); 256 257 if (reason) 258 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (%s)\n", reason); 259 else 260 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n"); 261 } 262 break; 263 case TEST_FAIL: 264 default: 265 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n"); 266 break; 267 } 268 269 return 0; 270 } 271 272 static int finish_test(struct child_test *child_test, int width) 273 { 274 struct test_suite *t = child_test->test; 275 int i = child_test->test_num; 276 int subi = child_test->subtest; 277 int err = child_test->process.err; 278 bool err_done = err <= 0; 279 struct strbuf err_output = STRBUF_INIT; 280 int ret; 281 282 /* 283 * For test suites with subtests, display the suite name ahead of the 284 * sub test names. 285 */ 286 if (has_subtests(t) && subi == 0) 287 pr_info("%3d: %-*s:\n", i + 1, width, test_description(t, -1)); 288 289 /* 290 * Busy loop reading from the child's stdout/stderr that are set to be 291 * non-blocking until EOF. 292 */ 293 if (!err_done) 294 fcntl(err, F_SETFL, O_NONBLOCK); 295 if (verbose > 1) { 296 if (has_subtests(t)) 297 pr_info("%3d.%1d: %s:\n", i + 1, subi + 1, test_description(t, subi)); 298 else 299 pr_info("%3d: %s:\n", i + 1, test_description(t, -1)); 300 } 301 while (!err_done) { 302 struct pollfd pfds[1] = { 303 { .fd = err, 304 .events = POLLIN | POLLERR | POLLHUP | POLLNVAL, 305 }, 306 }; 307 char buf[512]; 308 ssize_t len; 309 310 /* Poll to avoid excessive spinning, timeout set for 100ms. */ 311 poll(pfds, ARRAY_SIZE(pfds), /*timeout=*/100); 312 if (!err_done && pfds[0].revents) { 313 errno = 0; 314 len = read(err, buf, sizeof(buf) - 1); 315 316 if (len <= 0) { 317 err_done = errno != EAGAIN; 318 } else { 319 buf[len] = '\0'; 320 if (verbose > 1) 321 fprintf(stdout, "%s", buf); 322 else 323 strbuf_addstr(&err_output, buf); 324 } 325 } 326 } 327 /* Clean up child process. */ 328 ret = finish_command(&child_test->process); 329 if (verbose == 1 && ret == TEST_FAIL) { 330 /* Add header for test that was skipped above. */ 331 if (has_subtests(t)) 332 pr_info("%3d.%1d: %s:\n", i + 1, subi + 1, test_description(t, subi)); 333 else 334 pr_info("%3d: %s:\n", i + 1, test_description(t, -1)); 335 fprintf(stderr, "%s", err_output.buf); 336 } 337 strbuf_release(&err_output); 338 print_test_result(t, i, subi, ret, width); 339 if (err > 0) 340 close(err); 341 return 0; 342 } 343 344 static int start_test(struct test_suite *test, int i, int subi, struct child_test **child, 345 int width) 346 { 347 int err; 348 349 *child = NULL; 350 if (dont_fork) { 351 pr_debug("--- start ---\n"); 352 err = test_function(test, subi)(test, subi); 353 pr_debug("---- end ----\n"); 354 print_test_result(test, i, subi, err, width); 355 return 0; 356 } 357 358 *child = zalloc(sizeof(**child)); 359 if (!*child) 360 return -ENOMEM; 361 362 (*child)->test = test; 363 (*child)->test_num = i; 364 (*child)->subtest = subi; 365 (*child)->process.pid = -1; 366 (*child)->process.no_stdin = 1; 367 if (verbose <= 0) { 368 (*child)->process.no_stdout = 1; 369 (*child)->process.no_stderr = 1; 370 } else { 371 (*child)->process.stdout_to_stderr = 1; 372 (*child)->process.out = -1; 373 (*child)->process.err = -1; 374 } 375 (*child)->process.no_exec_cmd = run_test_child; 376 err = start_command(&(*child)->process); 377 if (err || !sequential) 378 return err; 379 return finish_test(*child, width); 380 } 381 382 #define for_each_test(j, k, t) \ 383 for (j = 0, k = 0; j < ARRAY_SIZE(tests); j++, k = 0) \ 384 while ((t = tests[j][k++]) != NULL) 385 386 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist) 387 { 388 struct test_suite *t; 389 unsigned int j, k; 390 int i = 0; 391 int width = 0; 392 size_t num_tests = 0; 393 struct child_test **child_tests; 394 int child_test_num = 0; 395 396 for_each_test(j, k, t) { 397 int len = strlen(test_description(t, -1)); 398 399 if (width < len) 400 width = len; 401 402 if (has_subtests(t)) { 403 for (int subi = 0, subn = num_subtests(t); subi < subn; subi++) { 404 len = strlen(test_description(t, subi)); 405 if (width < len) 406 width = len; 407 num_tests++; 408 } 409 } else { 410 num_tests++; 411 } 412 } 413 child_tests = calloc(num_tests, sizeof(*child_tests)); 414 if (!child_tests) 415 return -ENOMEM; 416 417 for_each_test(j, k, t) { 418 int curr = i++; 419 420 if (!perf_test__matches(test_description(t, -1), curr, argc, argv)) { 421 bool skip = true; 422 423 for (int subi = 0, subn = num_subtests(t); subi < subn; subi++) { 424 if (perf_test__matches(test_description(t, subi), 425 curr, argc, argv)) 426 skip = false; 427 } 428 429 if (skip) 430 continue; 431 } 432 433 if (intlist__find(skiplist, i)) { 434 pr_info("%3d: %-*s:", curr + 1, width, test_description(t, -1)); 435 color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n"); 436 continue; 437 } 438 439 if (!has_subtests(t)) { 440 int err = start_test(t, curr, -1, &child_tests[child_test_num++], width); 441 442 if (err) { 443 /* TODO: if !sequential waitpid the already forked children. */ 444 free(child_tests); 445 return err; 446 } 447 } else { 448 for (int subi = 0, subn = num_subtests(t); subi < subn; subi++) { 449 int err; 450 451 if (!perf_test__matches(test_description(t, subi), 452 curr, argc, argv)) 453 continue; 454 455 err = start_test(t, curr, subi, &child_tests[child_test_num++], 456 width); 457 if (err) 458 return err; 459 } 460 } 461 } 462 for (i = 0; i < child_test_num; i++) { 463 if (!sequential) { 464 int ret = finish_test(child_tests[i], width); 465 466 if (ret) 467 return ret; 468 } 469 free(child_tests[i]); 470 } 471 free(child_tests); 472 return 0; 473 } 474 475 static int perf_test__list(int argc, const char **argv) 476 { 477 unsigned int j, k; 478 struct test_suite *t; 479 int i = 0; 480 481 for_each_test(j, k, t) { 482 int curr = i++; 483 484 if (!perf_test__matches(test_description(t, -1), curr, argc, argv)) 485 continue; 486 487 pr_info("%3d: %s\n", i, test_description(t, -1)); 488 489 if (has_subtests(t)) { 490 int subn = num_subtests(t); 491 int subi; 492 493 for (subi = 0; subi < subn; subi++) 494 pr_info("%3d:%1d: %s\n", i, subi + 1, 495 test_description(t, subi)); 496 } 497 } 498 return 0; 499 } 500 501 static int run_workload(const char *work, int argc, const char **argv) 502 { 503 unsigned int i = 0; 504 struct test_workload *twl; 505 506 for (i = 0; i < ARRAY_SIZE(workloads); i++) { 507 twl = workloads[i]; 508 if (!strcmp(twl->name, work)) 509 return twl->func(argc, argv); 510 } 511 512 pr_info("No workload found: %s\n", work); 513 return -1; 514 } 515 516 static int perf_test__config(const char *var, const char *value, 517 void *data __maybe_unused) 518 { 519 if (!strcmp(var, "annotate.objdump")) 520 test_objdump_path = value; 521 522 return 0; 523 } 524 525 int cmd_test(int argc, const char **argv) 526 { 527 const char *test_usage[] = { 528 "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]", 529 NULL, 530 }; 531 const char *skip = NULL; 532 const char *workload = NULL; 533 const struct option test_options[] = { 534 OPT_STRING('s', "skip", &skip, "tests", "tests to skip"), 535 OPT_INCR('v', "verbose", &verbose, 536 "be more verbose (show symbol address, etc)"), 537 OPT_BOOLEAN('F', "dont-fork", &dont_fork, 538 "Do not fork for testcase"), 539 OPT_BOOLEAN('S', "sequential", &sequential, 540 "Run the tests one after another rather than in parallel"), 541 OPT_STRING('w', "workload", &workload, "work", "workload to run for testing"), 542 OPT_STRING(0, "dso", &dso_to_test, "dso", "dso to test"), 543 OPT_STRING(0, "objdump", &test_objdump_path, "path", 544 "objdump binary to use for disassembly and annotations"), 545 OPT_END() 546 }; 547 const char * const test_subcommands[] = { "list", NULL }; 548 struct intlist *skiplist = NULL; 549 int ret = hists__init(); 550 551 if (ret < 0) 552 return ret; 553 554 perf_config(perf_test__config, NULL); 555 556 /* Unbuffered output */ 557 setvbuf(stdout, NULL, _IONBF, 0); 558 559 tests[2] = create_script_test_suites(); 560 argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0); 561 if (argc >= 1 && !strcmp(argv[0], "list")) 562 return perf_test__list(argc - 1, argv + 1); 563 564 if (workload) 565 return run_workload(workload, argc, argv); 566 567 if (dont_fork) 568 sequential = true; 569 570 symbol_conf.priv_size = sizeof(int); 571 symbol_conf.try_vmlinux_path = true; 572 573 if (symbol__init(NULL) < 0) 574 return -1; 575 576 if (skip != NULL) 577 skiplist = intlist__new(skip); 578 /* 579 * Tests that create BPF maps, for instance, need more than the 64K 580 * default: 581 */ 582 rlimit__bump_memlock(); 583 584 return __cmd_test(argc, argv, skiplist); 585 } 586