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 "parse-options.h"
  15 #include "symbol.h"
  16
  17 struct test __weak arch_tests[] = {
  18         {
  19                 .func = NULL,
  20         },
  21 };
  22
  23 static struct test generic_tests[] = {
  24         {
  25                 .desc = "vmlinux symtab matches kallsyms",
  26                 .func = test__vmlinux_matches_kallsyms,
  27         },
  28         {
  29                 .desc = "detect openat syscall event",
  30                 .func = test__openat_syscall_event,
  31         },
  32         {
  33                 .desc = "detect openat syscall event on all cpus",
  34                 .func = test__openat_syscall_event_on_all_cpus,
  35         },
  36         {
  37                 .desc = "read samples using the mmap interface",
  38                 .func = test__basic_mmap,
  39         },
  40         {
  41                 .desc = "parse events tests",
  42                 .func = test__parse_events,
  43         },
  44         {
  45                 .desc = "Validate PERF_RECORD_* events & perf_sample fields",
  46                 .func = test__PERF_RECORD,
  47         },
  48         {
  49                 .desc = "Test perf pmu format parsing",
  50                 .func = test__pmu,
  51         },
  52         {
  53                 .desc = "Test dso data read",
  54                 .func = test__dso_data,
  55         },
  56         {
  57                 .desc = "Test dso data cache",
  58                 .func = test__dso_data_cache,
  59         },
  60         {
  61                 .desc = "Test dso data reopen",
  62                 .func = test__dso_data_reopen,
  63         },
  64         {
  65                 .desc = "roundtrip evsel->name check",
  66                 .func = test__perf_evsel__roundtrip_name_test,
  67         },
  68         {
  69                 .desc = "Check parsing of sched tracepoints fields",
  70                 .func = test__perf_evsel__tp_sched_test,
  71         },
  72         {
  73                 .desc = "Generate and check syscalls:sys_enter_openat event fields",
  74                 .func = test__syscall_openat_tp_fields,
  75         },
  76         {
  77                 .desc = "struct perf_event_attr setup",
  78                 .func = test__attr,
  79         },
  80         {
  81                 .desc = "Test matching and linking multiple hists",
  82                 .func = test__hists_link,
  83         },
  84         {
  85                 .desc = "Try 'import perf' in python, checking link problems",
  86                 .func = test__python_use,
  87         },
  88         {
  89                 .desc = "Test breakpoint overflow signal handler",
  90                 .func = test__bp_signal,
  91         },
  92         {
  93                 .desc = "Test breakpoint overflow sampling",
  94                 .func = test__bp_signal_overflow,
  95         },
  96         {
  97                 .desc = "Test number of exit event of a simple workload",
  98                 .func = test__task_exit,
  99         },
 100         {
 101                 .desc = "Test software clock events have valid period values",
 102                 .func = test__sw_clock_freq,
 103         },
 104         {
 105                 .desc = "Test object code reading",
 106                 .func = test__code_reading,
 107         },
 108         {
 109                 .desc = "Test sample parsing",
 110                 .func = test__sample_parsing,
 111         },
 112         {
 113                 .desc = "Test using a dummy software event to keep tracking",
 114                 .func = test__keep_tracking,
 115         },
 116         {
 117                 .desc = "Test parsing with no sample_id_all bit set",
 118                 .func = test__parse_no_sample_id_all,
 119         },
 120         {
 121                 .desc = "Test filtering hist entries",
 122                 .func = test__hists_filter,
 123         },
 124         {
 125                 .desc = "Test mmap thread lookup",
 126                 .func = test__mmap_thread_lookup,
 127         },
 128         {
 129                 .desc = "Test thread mg sharing",
 130                 .func = test__thread_mg_share,
 131         },
 132         {
 133                 .desc = "Test output sorting of hist entries",
 134                 .func = test__hists_output,
 135         },
 136         {
 137                 .desc = "Test cumulation of child hist entries",
 138                 .func = test__hists_cumulate,
 139         },
 140         {
 141                 .desc = "Test tracking with sched_switch",
 142                 .func = test__switch_tracking,
 143         },
 144         {
 145                 .desc = "Filter fds with revents mask in a fdarray",
 146                 .func = test__fdarray__filter,
 147         },
 148         {
 149                 .desc = "Add fd to a fdarray, making it autogrow",
 150                 .func = test__fdarray__add,
 151         },
 152         {
 153                 .desc = "Test kmod_path__parse function",
 154                 .func = test__kmod_path__parse,
 155         },
 156         {
 157                 .desc = "Test thread map",
 158                 .func = test__thread_map,
 159         },
 160         {
 161                 .desc = "Test LLVM searching and compiling",
 162                 .func = test__llvm,
 163         },
 164         {
 165                 .desc = "Test topology in session",
 166                 .func = test_session_topology,
 167         },
 168         {
 169                 .func = NULL,
 170         },
 171 };
 172
 173 static struct test *tests[] = {
 174         generic_tests,
 175         arch_tests,
 176 };
 177
 178 static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
 179 {
 180         int i;
 181
 182         if (argc == 0)
 183                 return true;
 184
 185         for (i = 0; i < argc; ++i) {
 186                 char *end;
 187                 long nr = strtoul(argv[i], &end, 10);
 188
 189                 if (*end == '\0') {
 190                         if (nr == curr + 1)
 191                                 return true;
 192                         continue;
 193                 }
 194
 195                 if (strstr(test->desc, argv[i]))
 196                         return true;
 197         }
 198
 199         return false;
 200 }
 201
 202 static int run_test(struct test *test)
 203 {
 204         int status, err = -1, child = fork();
 205         char sbuf[STRERR_BUFSIZE];
 206
 207         if (child < 0) {
 208                 pr_err("failed to fork test: %s\n",
 209                         strerror_r(errno, sbuf, sizeof(sbuf)));
 210                 return -1;
 211         }
 212
 213         if (!child) {
 214                 pr_debug("test child forked, pid %d\n", getpid());
 215                 err = test->func();
 216                 exit(err);
 217         }
 218
 219         wait(&status);
 220
 221         if (WIFEXITED(status)) {
 222                 err = (signed char)WEXITSTATUS(status);
 223                 pr_debug("test child finished with %d\n", err);
 224         } else if (WIFSIGNALED(status)) {
 225                 err = -1;
 226                 pr_debug("test child interrupted\n");
 227         }
 228
 229         return err;
 230 }
 231
 232 #define for_each_test(j, t)                                     \
 233         for (j = 0; j < ARRAY_SIZE(tests); j++) \
 234                 for (t = &tests[j][0]; t->func; t++)
 235
 236 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
 237 {
 238         struct test *t;
 239         unsigned int j;
 240         int i = 0;
 241         int width = 0;
 242
 243         for_each_test(j, t) {
 244                 int len = strlen(t->desc);
 245
 246                 if (width < len)
 247                         width = len;
 248         }
 249
 250         for_each_test(j, t) {
 251                 int curr = i++, err;
 252
 253                 if (!perf_test__matches(t, curr, argc, argv))
 254                         continue;
 255
 256                 pr_info("%2d: %-*s:", i, width, t->desc);
 257
 258                 if (intlist__find(skiplist, i)) {
 259                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
 260                         continue;
 261                 }
 262
 263                 pr_debug("\n--- start ---\n");
 264                 err = run_test(t);
 265                 pr_debug("---- end ----\n%s:", t->desc);
 266
 267                 switch (err) {
 268                 case TEST_OK:
 269                         pr_info(" Ok\n");
 270                         break;
 271                 case TEST_SKIP:
 272                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
 273                         break;
 274                 case TEST_FAIL:
 275                 default:
 276                         color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
 277                         break;
 278                 }
 279         }
 280
 281         return 0;
 282 }
 283
 284 static int perf_test__list(int argc, const char **argv)
 285 {
 286         unsigned int j;
 287         struct test *t;
 288         int i = 0;
 289
 290         for_each_test(j, t) {
 291                 if (argc > 1 && !strstr(t->desc, argv[1]))
 292                         continue;
 293
 294                 pr_info("%2d: %s\n", ++i, t->desc);
 295         }
 296
 297         return 0;
 298 }
 299
 300 int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
 301 {
 302         const char *test_usage[] = {
 303         "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
 304         NULL,
 305         };
 306         const char *skip = NULL;
 307         const struct option test_options[] = {
 308         OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
 309         OPT_INCR('v', "verbose", &verbose,
 310                     "be more verbose (show symbol address, etc)"),
 311         OPT_END()
 312         };
 313         const char * const test_subcommands[] = { "list", NULL };
 314         struct intlist *skiplist = NULL;
 315         int ret = hists__init();
 316
 317         if (ret < 0)
 318                 return ret;
 319
 320         argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
 321         if (argc >= 1 && !strcmp(argv[0], "list"))
 322                 return perf_test__list(argc, argv);
 323
 324         symbol_conf.priv_size = sizeof(int);
 325         symbol_conf.sort_by_name = true;
 326         symbol_conf.try_vmlinux_path = true;
 327
 328         if (symbol__init(NULL) < 0)
 329                 return -1;
 330
 331         if (skip != NULL)
 332                 skiplist = intlist__new(skip);
 333
 334         return __cmd_test(argc, argv, skiplist);
 335 }