linux/tools/perf/tests/builtin-test.c
<<
>>
Prefs
   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
  17static bool dont_fork;
  18
  19struct test __weak arch_tests[] = {
  20        {
  21                .func = NULL,
  22        },
  23};
  24
  25static 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 events tests",
  44                .func = test__parse_events,
  45        },
  46        {
  47                .desc = "Validate PERF_RECORD_* events & perf_sample fields",
  48                .func = test__PERF_RECORD,
  49        },
  50        {
  51                .desc = "Test perf pmu format parsing",
  52                .func = test__pmu,
  53        },
  54        {
  55                .desc = "Test dso data read",
  56                .func = test__dso_data,
  57        },
  58        {
  59                .desc = "Test dso data cache",
  60                .func = test__dso_data_cache,
  61        },
  62        {
  63                .desc = "Test dso data reopen",
  64                .func = test__dso_data_reopen,
  65        },
  66        {
  67                .desc = "roundtrip evsel->name check",
  68                .func = test__perf_evsel__roundtrip_name_test,
  69        },
  70        {
  71                .desc = "Check parsing of sched tracepoints fields",
  72                .func = test__perf_evsel__tp_sched_test,
  73        },
  74        {
  75                .desc = "Generate and check syscalls:sys_enter_openat event fields",
  76                .func = test__syscall_openat_tp_fields,
  77        },
  78        {
  79                .desc = "struct perf_event_attr setup",
  80                .func = test__attr,
  81        },
  82        {
  83                .desc = "Test matching and linking multiple hists",
  84                .func = test__hists_link,
  85        },
  86        {
  87                .desc = "Try 'import perf' in python, checking link problems",
  88                .func = test__python_use,
  89        },
  90        {
  91                .desc = "Test breakpoint overflow signal handler",
  92                .func = test__bp_signal,
  93        },
  94        {
  95                .desc = "Test breakpoint overflow sampling",
  96                .func = test__bp_signal_overflow,
  97        },
  98        {
  99                .desc = "Test number of exit event of a simple workload",
 100                .func = test__task_exit,
 101        },
 102        {
 103                .desc = "Test software clock events have valid period values",
 104                .func = test__sw_clock_freq,
 105        },
 106        {
 107                .desc = "Test object code reading",
 108                .func = test__code_reading,
 109        },
 110        {
 111                .desc = "Test sample parsing",
 112                .func = test__sample_parsing,
 113        },
 114        {
 115                .desc = "Test using a dummy software event to keep tracking",
 116                .func = test__keep_tracking,
 117        },
 118        {
 119                .desc = "Test parsing with no sample_id_all bit set",
 120                .func = test__parse_no_sample_id_all,
 121        },
 122        {
 123                .desc = "Test filtering hist entries",
 124                .func = test__hists_filter,
 125        },
 126        {
 127                .desc = "Test mmap thread lookup",
 128                .func = test__mmap_thread_lookup,
 129        },
 130        {
 131                .desc = "Test thread mg sharing",
 132                .func = test__thread_mg_share,
 133        },
 134        {
 135                .desc = "Test output sorting of hist entries",
 136                .func = test__hists_output,
 137        },
 138        {
 139                .desc = "Test cumulation of child hist entries",
 140                .func = test__hists_cumulate,
 141        },
 142        {
 143                .desc = "Test tracking 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 = "Test kmod_path__parse function",
 156                .func = test__kmod_path__parse,
 157        },
 158        {
 159                .desc = "Test thread map",
 160                .func = test__thread_map,
 161        },
 162        {
 163                .desc = "Test LLVM searching and compiling",
 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 = "Test topology in session",
 173                .func = test_session_topology,
 174        },
 175        {
 176                .desc = "Test 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 = "Test thread map synthesize",
 186                .func = test__thread_map_synthesize,
 187        },
 188        {
 189                .desc = "Test cpu map synthesize",
 190                .func = test__cpu_map_synthesize,
 191        },
 192        {
 193                .desc = "Test stat config synthesize",
 194                .func = test__synthesize_stat_config,
 195        },
 196        {
 197                .desc = "Test stat synthesize",
 198                .func = test__synthesize_stat,
 199        },
 200        {
 201                .desc = "Test stat round synthesize",
 202                .func = test__synthesize_stat_round,
 203        },
 204        {
 205                .desc = "Test attr update synthesize",
 206                .func = test__event_update,
 207        },
 208        {
 209                .desc = "Test events times",
 210                .func = test__event_times,
 211        },
 212        {
 213                .desc = "Test backward reading from ring buffer",
 214                .func = test__backward_ring_buffer,
 215        },
 216        {
 217                .desc = "Test cpu map print",
 218                .func = test__cpu_map_print,
 219        },
 220        {
 221                .desc = "Test SDT event probing",
 222                .func = test__sdt_event,
 223        },
 224        {
 225                .desc = "Test is_printable_array function",
 226                .func = test__is_printable_array,
 227        },
 228        {
 229                .desc = "Test bitmap print",
 230                .func = test__bitmap_print,
 231        },
 232        {
 233                .func = NULL,
 234        },
 235};
 236
 237static struct test *tests[] = {
 238        generic_tests,
 239        arch_tests,
 240};
 241
 242static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
 243{
 244        int i;
 245
 246        if (argc == 0)
 247                return true;
 248
 249        for (i = 0; i < argc; ++i) {
 250                char *end;
 251                long nr = strtoul(argv[i], &end, 10);
 252
 253                if (*end == '\0') {
 254                        if (nr == curr + 1)
 255                                return true;
 256                        continue;
 257                }
 258
 259                if (strcasestr(test->desc, argv[i]))
 260                        return true;
 261        }
 262
 263        return false;
 264}
 265
 266static int run_test(struct test *test, int subtest)
 267{
 268        int status, err = -1, child = dont_fork ? 0 : fork();
 269        char sbuf[STRERR_BUFSIZE];
 270
 271        if (child < 0) {
 272                pr_err("failed to fork test: %s\n",
 273                        str_error_r(errno, sbuf, sizeof(sbuf)));
 274                return -1;
 275        }
 276
 277        if (!child) {
 278                if (!dont_fork) {
 279                        pr_debug("test child forked, pid %d\n", getpid());
 280
 281                        if (!verbose) {
 282                                int nullfd = open("/dev/null", O_WRONLY);
 283
 284                                if (nullfd >= 0) {
 285                                        close(STDERR_FILENO);
 286                                        close(STDOUT_FILENO);
 287
 288                                        dup2(nullfd, STDOUT_FILENO);
 289                                        dup2(STDOUT_FILENO, STDERR_FILENO);
 290                                        close(nullfd);
 291                                }
 292                        } else {
 293                                signal(SIGSEGV, sighandler_dump_stack);
 294                                signal(SIGFPE, sighandler_dump_stack);
 295                        }
 296                }
 297
 298                err = test->func(subtest);
 299                if (!dont_fork)
 300                        exit(err);
 301        }
 302
 303        if (!dont_fork) {
 304                wait(&status);
 305
 306                if (WIFEXITED(status)) {
 307                        err = (signed char)WEXITSTATUS(status);
 308                        pr_debug("test child finished with %d\n", err);
 309                } else if (WIFSIGNALED(status)) {
 310                        err = -1;
 311                        pr_debug("test child interrupted\n");
 312                }
 313        }
 314
 315        return err;
 316}
 317
 318#define for_each_test(j, t)                                     \
 319        for (j = 0; j < ARRAY_SIZE(tests); j++) \
 320                for (t = &tests[j][0]; t->func; t++)
 321
 322static int test_and_print(struct test *t, bool force_skip, int subtest)
 323{
 324        int err;
 325
 326        if (!force_skip) {
 327                pr_debug("\n--- start ---\n");
 328                err = run_test(t, subtest);
 329                pr_debug("---- end ----\n");
 330        } else {
 331                pr_debug("\n--- force skipped ---\n");
 332                err = TEST_SKIP;
 333        }
 334
 335        if (!t->subtest.get_nr)
 336                pr_debug("%s:", t->desc);
 337        else
 338                pr_debug("%s subtest %d:", t->desc, subtest);
 339
 340        switch (err) {
 341        case TEST_OK:
 342                pr_info(" Ok\n");
 343                break;
 344        case TEST_SKIP:
 345                color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
 346                break;
 347        case TEST_FAIL:
 348        default:
 349                color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
 350                break;
 351        }
 352
 353        return err;
 354}
 355
 356static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
 357{
 358        struct test *t;
 359        unsigned int j;
 360        int i = 0;
 361        int width = 0;
 362
 363        for_each_test(j, t) {
 364                int len = strlen(t->desc);
 365
 366                if (width < len)
 367                        width = len;
 368        }
 369
 370        for_each_test(j, t) {
 371                int curr = i++, err;
 372
 373                if (!perf_test__matches(t, curr, argc, argv))
 374                        continue;
 375
 376                pr_info("%2d: %-*s:", i, width, t->desc);
 377
 378                if (intlist__find(skiplist, i)) {
 379                        color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
 380                        continue;
 381                }
 382
 383                if (!t->subtest.get_nr) {
 384                        test_and_print(t, false, -1);
 385                } else {
 386                        int subn = t->subtest.get_nr();
 387                        /*
 388                         * minus 2 to align with normal testcases.
 389                         * For subtest we print additional '.x' in number.
 390                         * for example:
 391                         *
 392                         * 35: Test LLVM searching and compiling                        :
 393                         * 35.1: Basic BPF llvm compiling test                          : Ok
 394                         */
 395                        int subw = width > 2 ? width - 2 : width;
 396                        bool skip = false;
 397                        int subi;
 398
 399                        if (subn <= 0) {
 400                                color_fprintf(stderr, PERF_COLOR_YELLOW,
 401                                              " Skip (not compiled in)\n");
 402                                continue;
 403                        }
 404                        pr_info("\n");
 405
 406                        for (subi = 0; subi < subn; subi++) {
 407                                int len = strlen(t->subtest.get_desc(subi));
 408
 409                                if (subw < len)
 410                                        subw = len;
 411                        }
 412
 413                        for (subi = 0; subi < subn; subi++) {
 414                                pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
 415                                        t->subtest.get_desc(subi));
 416                                err = test_and_print(t, skip, subi);
 417                                if (err != TEST_OK && t->subtest.skip_if_fail)
 418                                        skip = true;
 419                        }
 420                }
 421        }
 422
 423        return 0;
 424}
 425
 426static int perf_test__list(int argc, const char **argv)
 427{
 428        unsigned int j;
 429        struct test *t;
 430        int i = 0;
 431
 432        for_each_test(j, t) {
 433                if (argc > 1 && !strstr(t->desc, argv[1]))
 434                        continue;
 435
 436                pr_info("%2d: %s\n", ++i, t->desc);
 437        }
 438
 439        return 0;
 440}
 441
 442int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
 443{
 444        const char *test_usage[] = {
 445        "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
 446        NULL,
 447        };
 448        const char *skip = NULL;
 449        const struct option test_options[] = {
 450        OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
 451        OPT_INCR('v', "verbose", &verbose,
 452                    "be more verbose (show symbol address, etc)"),
 453        OPT_BOOLEAN('F', "dont-fork", &dont_fork,
 454                    "Do not fork for testcase"),
 455        OPT_END()
 456        };
 457        const char * const test_subcommands[] = { "list", NULL };
 458        struct intlist *skiplist = NULL;
 459        int ret = hists__init();
 460
 461        if (ret < 0)
 462                return ret;
 463
 464        argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
 465        if (argc >= 1 && !strcmp(argv[0], "list"))
 466                return perf_test__list(argc, argv);
 467
 468        symbol_conf.priv_size = sizeof(int);
 469        symbol_conf.sort_by_name = true;
 470        symbol_conf.try_vmlinux_path = true;
 471
 472        if (symbol__init(NULL) < 0)
 473                return -1;
 474
 475        if (skip != NULL)
 476                skiplist = intlist__new(skip);
 477
 478        return __cmd_test(argc, argv, skiplist);
 479}
 480