perf test: Add free() calls for scandir() returned dirent entries
[linux-2.6-microblaze.git] / tools / perf / tests / builtin-test.c
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 <unistd.h>
10 #include <string.h>
11 #include <stdlib.h>
12 #include <sys/types.h>
13 #include <dirent.h>
14 #include <sys/wait.h>
15 #include <sys/stat.h>
16 #include "builtin.h"
17 #include "hist.h"
18 #include "intlist.h"
19 #include "tests.h"
20 #include "debug.h"
21 #include "color.h"
22 #include <subcmd/parse-options.h>
23 #include "string2.h"
24 #include "symbol.h"
25 #include "util/rlimit.h"
26 #include <linux/kernel.h>
27 #include <linux/string.h>
28 #include <subcmd/exec-cmd.h>
29 #include <linux/zalloc.h>
30
31 static bool dont_fork;
32
33 struct test __weak arch_tests[] = {
34         {
35                 .func = NULL,
36         },
37 };
38
39 static struct test generic_tests[] = {
40         {
41                 .desc = "vmlinux symtab matches kallsyms",
42                 .func = test__vmlinux_matches_kallsyms,
43         },
44         {
45                 .desc = "Detect openat syscall event",
46                 .func = test__openat_syscall_event,
47         },
48         {
49                 .desc = "Detect openat syscall event on all cpus",
50                 .func = test__openat_syscall_event_on_all_cpus,
51         },
52         {
53                 .desc = "Read samples using the mmap interface",
54                 .func = test__basic_mmap,
55         },
56         {
57                 .desc = "Test data source output",
58                 .func = test__mem,
59         },
60         {
61                 .desc = "Parse event definition strings",
62                 .func = test__parse_events,
63         },
64         {
65                 .desc = "Simple expression parser",
66                 .func = test__expr,
67         },
68         {
69                 .desc = "PERF_RECORD_* events & perf_sample fields",
70                 .func = test__PERF_RECORD,
71         },
72         {
73                 .desc = "Parse perf pmu format",
74                 .func = test__pmu,
75         },
76         {
77                 .desc = "PMU events",
78                 .func = test__pmu_events,
79                 .subtest = {
80                         .skip_if_fail   = false,
81                         .get_nr         = test__pmu_events_subtest_get_nr,
82                         .get_desc       = test__pmu_events_subtest_get_desc,
83                         .skip_reason    = test__pmu_events_subtest_skip_reason,
84                 },
85
86         },
87         {
88                 .desc = "DSO data read",
89                 .func = test__dso_data,
90         },
91         {
92                 .desc = "DSO data cache",
93                 .func = test__dso_data_cache,
94         },
95         {
96                 .desc = "DSO data reopen",
97                 .func = test__dso_data_reopen,
98         },
99         {
100                 .desc = "Roundtrip evsel->name",
101                 .func = test__perf_evsel__roundtrip_name_test,
102         },
103         {
104                 .desc = "Parse sched tracepoints fields",
105                 .func = test__perf_evsel__tp_sched_test,
106         },
107         {
108                 .desc = "syscalls:sys_enter_openat event fields",
109                 .func = test__syscall_openat_tp_fields,
110         },
111         {
112                 .desc = "Setup struct perf_event_attr",
113                 .func = test__attr,
114         },
115         {
116                 .desc = "Match and link multiple hists",
117                 .func = test__hists_link,
118         },
119         {
120                 .desc = "'import perf' in python",
121                 .func = test__python_use,
122         },
123         {
124                 .desc = "Breakpoint overflow signal handler",
125                 .func = test__bp_signal,
126                 .is_supported = test__bp_signal_is_supported,
127         },
128         {
129                 .desc = "Breakpoint overflow sampling",
130                 .func = test__bp_signal_overflow,
131                 .is_supported = test__bp_signal_is_supported,
132         },
133         {
134                 .desc = "Breakpoint accounting",
135                 .func = test__bp_accounting,
136                 .is_supported = test__bp_account_is_supported,
137         },
138         {
139                 .desc = "Watchpoint",
140                 .func = test__wp,
141                 .is_supported = test__wp_is_supported,
142                 .subtest = {
143                         .skip_if_fail   = false,
144                         .get_nr         = test__wp_subtest_get_nr,
145                         .get_desc       = test__wp_subtest_get_desc,
146                         .skip_reason    = test__wp_subtest_skip_reason,
147                 },
148         },
149         {
150                 .desc = "Number of exit events of a simple workload",
151                 .func = test__task_exit,
152         },
153         {
154                 .desc = "Software clock events period values",
155                 .func = test__sw_clock_freq,
156         },
157         {
158                 .desc = "Object code reading",
159                 .func = test__code_reading,
160         },
161         {
162                 .desc = "Sample parsing",
163                 .func = test__sample_parsing,
164         },
165         {
166                 .desc = "Use a dummy software event to keep tracking",
167                 .func = test__keep_tracking,
168         },
169         {
170                 .desc = "Parse with no sample_id_all bit set",
171                 .func = test__parse_no_sample_id_all,
172         },
173         {
174                 .desc = "Filter hist entries",
175                 .func = test__hists_filter,
176         },
177         {
178                 .desc = "Lookup mmap thread",
179                 .func = test__mmap_thread_lookup,
180         },
181         {
182                 .desc = "Share thread maps",
183                 .func = test__thread_maps_share,
184         },
185         {
186                 .desc = "Sort output of hist entries",
187                 .func = test__hists_output,
188         },
189         {
190                 .desc = "Cumulate child hist entries",
191                 .func = test__hists_cumulate,
192         },
193         {
194                 .desc = "Track with sched_switch",
195                 .func = test__switch_tracking,
196         },
197         {
198                 .desc = "Filter fds with revents mask in a fdarray",
199                 .func = test__fdarray__filter,
200         },
201         {
202                 .desc = "Add fd to a fdarray, making it autogrow",
203                 .func = test__fdarray__add,
204         },
205         {
206                 .desc = "kmod_path__parse",
207                 .func = test__kmod_path__parse,
208         },
209         {
210                 .desc = "Thread map",
211                 .func = test__thread_map,
212         },
213         {
214                 .desc = "LLVM search and compile",
215                 .func = test__llvm,
216                 .subtest = {
217                         .skip_if_fail   = true,
218                         .get_nr         = test__llvm_subtest_get_nr,
219                         .get_desc       = test__llvm_subtest_get_desc,
220                 },
221         },
222         {
223                 .desc = "Session topology",
224                 .func = test__session_topology,
225         },
226         {
227                 .desc = "BPF filter",
228                 .func = test__bpf,
229                 .subtest = {
230                         .skip_if_fail   = true,
231                         .get_nr         = test__bpf_subtest_get_nr,
232                         .get_desc       = test__bpf_subtest_get_desc,
233                 },
234         },
235         {
236                 .desc = "Synthesize thread map",
237                 .func = test__thread_map_synthesize,
238         },
239         {
240                 .desc = "Remove thread map",
241                 .func = test__thread_map_remove,
242         },
243         {
244                 .desc = "Synthesize cpu map",
245                 .func = test__cpu_map_synthesize,
246         },
247         {
248                 .desc = "Synthesize stat config",
249                 .func = test__synthesize_stat_config,
250         },
251         {
252                 .desc = "Synthesize stat",
253                 .func = test__synthesize_stat,
254         },
255         {
256                 .desc = "Synthesize stat round",
257                 .func = test__synthesize_stat_round,
258         },
259         {
260                 .desc = "Synthesize attr update",
261                 .func = test__event_update,
262         },
263         {
264                 .desc = "Event times",
265                 .func = test__event_times,
266         },
267         {
268                 .desc = "Read backward ring buffer",
269                 .func = test__backward_ring_buffer,
270         },
271         {
272                 .desc = "Print cpu map",
273                 .func = test__cpu_map_print,
274         },
275         {
276                 .desc = "Merge cpu map",
277                 .func = test__cpu_map_merge,
278         },
279
280         {
281                 .desc = "Probe SDT events",
282                 .func = test__sdt_event,
283         },
284         {
285                 .desc = "is_printable_array",
286                 .func = test__is_printable_array,
287         },
288         {
289                 .desc = "Print bitmap",
290                 .func = test__bitmap_print,
291         },
292         {
293                 .desc = "perf hooks",
294                 .func = test__perf_hooks,
295         },
296         {
297                 .desc = "builtin clang support",
298                 .func = test__clang,
299                 .subtest = {
300                         .skip_if_fail   = true,
301                         .get_nr         = test__clang_subtest_get_nr,
302                         .get_desc       = test__clang_subtest_get_desc,
303                 }
304         },
305         {
306                 .desc = "unit_number__scnprintf",
307                 .func = test__unit_number__scnprint,
308         },
309         {
310                 .desc = "mem2node",
311                 .func = test__mem2node,
312         },
313         {
314                 .desc = "time utils",
315                 .func = test__time_utils,
316         },
317         {
318                 .desc = "Test jit_write_elf",
319                 .func = test__jit_write_elf,
320         },
321         {
322                 .desc = "Test libpfm4 support",
323                 .func = test__pfm,
324                 .subtest = {
325                         .skip_if_fail   = true,
326                         .get_nr         = test__pfm_subtest_get_nr,
327                         .get_desc       = test__pfm_subtest_get_desc,
328                 }
329         },
330         {
331                 .desc = "Test api io",
332                 .func = test__api_io,
333         },
334         {
335                 .desc = "maps__merge_in",
336                 .func = test__maps__merge_in,
337         },
338         {
339                 .desc = "Demangle Java",
340                 .func = test__demangle_java,
341         },
342         {
343                 .desc = "Demangle OCaml",
344                 .func = test__demangle_ocaml,
345         },
346         {
347                 .desc = "Parse and process metrics",
348                 .func = test__parse_metric,
349         },
350         {
351                 .desc = "PE file support",
352                 .func = test__pe_file_parsing,
353         },
354         {
355                 .desc = "Event expansion for cgroups",
356                 .func = test__expand_cgroup_events,
357         },
358         {
359                 .desc = "Convert perf time to TSC",
360                 .func = test__perf_time_to_tsc,
361                 .is_supported = test__tsc_is_supported,
362         },
363         {
364                 .func = NULL,
365         },
366 };
367
368 static struct test *tests[] = {
369         generic_tests,
370         arch_tests,
371 };
372
373 static bool perf_test__matches(const char *desc, int curr, int argc, const char *argv[])
374 {
375         int i;
376
377         if (argc == 0)
378                 return true;
379
380         for (i = 0; i < argc; ++i) {
381                 char *end;
382                 long nr = strtoul(argv[i], &end, 10);
383
384                 if (*end == '\0') {
385                         if (nr == curr + 1)
386                                 return true;
387                         continue;
388                 }
389
390                 if (strcasestr(desc, argv[i]))
391                         return true;
392         }
393
394         return false;
395 }
396
397 static int run_test(struct test *test, int subtest)
398 {
399         int status, err = -1, child = dont_fork ? 0 : fork();
400         char sbuf[STRERR_BUFSIZE];
401
402         if (child < 0) {
403                 pr_err("failed to fork test: %s\n",
404                         str_error_r(errno, sbuf, sizeof(sbuf)));
405                 return -1;
406         }
407
408         if (!child) {
409                 if (!dont_fork) {
410                         pr_debug("test child forked, pid %d\n", getpid());
411
412                         if (verbose <= 0) {
413                                 int nullfd = open("/dev/null", O_WRONLY);
414
415                                 if (nullfd >= 0) {
416                                         close(STDERR_FILENO);
417                                         close(STDOUT_FILENO);
418
419                                         dup2(nullfd, STDOUT_FILENO);
420                                         dup2(STDOUT_FILENO, STDERR_FILENO);
421                                         close(nullfd);
422                                 }
423                         } else {
424                                 signal(SIGSEGV, sighandler_dump_stack);
425                                 signal(SIGFPE, sighandler_dump_stack);
426                         }
427                 }
428
429                 err = test->func(test, subtest);
430                 if (!dont_fork)
431                         exit(err);
432         }
433
434         if (!dont_fork) {
435                 wait(&status);
436
437                 if (WIFEXITED(status)) {
438                         err = (signed char)WEXITSTATUS(status);
439                         pr_debug("test child finished with %d\n", err);
440                 } else if (WIFSIGNALED(status)) {
441                         err = -1;
442                         pr_debug("test child interrupted\n");
443                 }
444         }
445
446         return err;
447 }
448
449 #define for_each_test(j, t)                                     \
450         for (j = 0; j < ARRAY_SIZE(tests); j++) \
451                 for (t = &tests[j][0]; t->func; t++)
452
453 static int test_and_print(struct test *t, bool force_skip, int subtest)
454 {
455         int err;
456
457         if (!force_skip) {
458                 pr_debug("\n--- start ---\n");
459                 err = run_test(t, subtest);
460                 pr_debug("---- end ----\n");
461         } else {
462                 pr_debug("\n--- force skipped ---\n");
463                 err = TEST_SKIP;
464         }
465
466         if (!t->subtest.get_nr)
467                 pr_debug("%s:", t->desc);
468         else
469                 pr_debug("%s subtest %d:", t->desc, subtest + 1);
470
471         switch (err) {
472         case TEST_OK:
473                 pr_info(" Ok\n");
474                 break;
475         case TEST_SKIP: {
476                 const char *skip_reason = NULL;
477                 if (t->subtest.skip_reason)
478                         skip_reason = t->subtest.skip_reason(subtest);
479                 if (skip_reason)
480                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (%s)\n", skip_reason);
481                 else
482                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
483         }
484                 break;
485         case TEST_FAIL:
486         default:
487                 color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
488                 break;
489         }
490
491         return err;
492 }
493
494 static const char *shell_test__description(char *description, size_t size,
495                                            const char *path, const char *name)
496 {
497         FILE *fp;
498         char filename[PATH_MAX];
499
500         path__join(filename, sizeof(filename), path, name);
501         fp = fopen(filename, "r");
502         if (!fp)
503                 return NULL;
504
505         /* Skip shebang */
506         while (fgetc(fp) != '\n');
507
508         description = fgets(description, size, fp);
509         fclose(fp);
510
511         return description ? strim(description + 1) : NULL;
512 }
513
514 #define for_each_shell_test(entlist, nr, base, ent)                     \
515         for (int __i = 0; __i < nr && (ent = entlist[__i]); __i++)      \
516                 if (!is_directory(base, ent) && ent->d_name[0] != '.')
517
518 static const char *shell_tests__dir(char *path, size_t size)
519 {
520         const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
521         char *exec_path;
522         unsigned int i;
523
524         for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
525                 struct stat st;
526                 if (!lstat(devel_dirs[i], &st)) {
527                         scnprintf(path, size, "%s/shell", devel_dirs[i]);
528                         if (!lstat(devel_dirs[i], &st))
529                                 return path;
530                 }
531         }
532
533         /* Then installed path. */
534         exec_path = get_argv_exec_path();
535         scnprintf(path, size, "%s/tests/shell", exec_path);
536         free(exec_path);
537         return path;
538 }
539
540 static int shell_tests__max_desc_width(void)
541 {
542         struct dirent **entlist;
543         struct dirent *ent;
544         int n_dirs, e;
545         char path_dir[PATH_MAX];
546         const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
547         int width = 0;
548
549         if (path == NULL)
550                 return -1;
551
552         n_dirs = scandir(path, &entlist, NULL, alphasort);
553         if (n_dirs == -1)
554                 return -1;
555
556         for_each_shell_test(entlist, n_dirs, path, ent) {
557                 char bf[256];
558                 const char *desc = shell_test__description(bf, sizeof(bf), path, ent->d_name);
559
560                 if (desc) {
561                         int len = strlen(desc);
562
563                         if (width < len)
564                                 width = len;
565                 }
566         }
567
568         for (e = 0; e < n_dirs; e++)
569                 zfree(&entlist[e]);
570         free(entlist);
571         return width;
572 }
573
574 struct shell_test {
575         const char *dir;
576         const char *file;
577 };
578
579 static int shell_test__run(struct test *test, int subdir __maybe_unused)
580 {
581         int err;
582         char script[PATH_MAX];
583         struct shell_test *st = test->priv;
584
585         path__join(script, sizeof(script) - 3, st->dir, st->file);
586
587         if (verbose)
588                 strncat(script, " -v", sizeof(script) - strlen(script) - 1);
589
590         err = system(script);
591         if (!err)
592                 return TEST_OK;
593
594         return WEXITSTATUS(err) == 2 ? TEST_SKIP : TEST_FAIL;
595 }
596
597 static int run_shell_tests(int argc, const char *argv[], int i, int width)
598 {
599         struct dirent **entlist;
600         struct dirent *ent;
601         int n_dirs, e;
602         char path_dir[PATH_MAX];
603         struct shell_test st = {
604                 .dir = shell_tests__dir(path_dir, sizeof(path_dir)),
605         };
606
607         if (st.dir == NULL)
608                 return -1;
609
610         n_dirs = scandir(st.dir, &entlist, NULL, alphasort);
611         if (n_dirs == -1) {
612                 pr_err("failed to open shell test directory: %s\n",
613                         st.dir);
614                 return -1;
615         }
616
617         for_each_shell_test(entlist, n_dirs, st.dir, ent) {
618                 int curr = i++;
619                 char desc[256];
620                 struct test test = {
621                         .desc = shell_test__description(desc, sizeof(desc), st.dir, ent->d_name),
622                         .func = shell_test__run,
623                         .priv = &st,
624                 };
625
626                 if (!perf_test__matches(test.desc, curr, argc, argv))
627                         continue;
628
629                 st.file = ent->d_name;
630                 pr_info("%2d: %-*s:", i, width, test.desc);
631                 test_and_print(&test, false, -1);
632         }
633
634         for (e = 0; e < n_dirs; e++)
635                 zfree(&entlist[e]);
636         free(entlist);
637         return 0;
638 }
639
640 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
641 {
642         struct test *t;
643         unsigned int j;
644         int i = 0;
645         int width = shell_tests__max_desc_width();
646
647         for_each_test(j, t) {
648                 int len = strlen(t->desc);
649
650                 if (width < len)
651                         width = len;
652         }
653
654         for_each_test(j, t) {
655                 int curr = i++, err;
656                 int subi;
657
658                 if (!perf_test__matches(t->desc, curr, argc, argv)) {
659                         bool skip = true;
660                         int subn;
661
662                         if (!t->subtest.get_nr)
663                                 continue;
664
665                         subn = t->subtest.get_nr();
666
667                         for (subi = 0; subi < subn; subi++) {
668                                 if (perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv))
669                                         skip = false;
670                         }
671
672                         if (skip)
673                                 continue;
674                 }
675
676                 if (t->is_supported && !t->is_supported()) {
677                         pr_debug("%2d: %-*s: Disabled\n", i, width, t->desc);
678                         continue;
679                 }
680
681                 pr_info("%2d: %-*s:", i, width, t->desc);
682
683                 if (intlist__find(skiplist, i)) {
684                         color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
685                         continue;
686                 }
687
688                 if (!t->subtest.get_nr) {
689                         test_and_print(t, false, -1);
690                 } else {
691                         int subn = t->subtest.get_nr();
692                         /*
693                          * minus 2 to align with normal testcases.
694                          * For subtest we print additional '.x' in number.
695                          * for example:
696                          *
697                          * 35: Test LLVM searching and compiling                        :
698                          * 35.1: Basic BPF llvm compiling test                          : Ok
699                          */
700                         int subw = width > 2 ? width - 2 : width;
701                         bool skip = false;
702
703                         if (subn <= 0) {
704                                 color_fprintf(stderr, PERF_COLOR_YELLOW,
705                                               " Skip (not compiled in)\n");
706                                 continue;
707                         }
708                         pr_info("\n");
709
710                         for (subi = 0; subi < subn; subi++) {
711                                 int len = strlen(t->subtest.get_desc(subi));
712
713                                 if (subw < len)
714                                         subw = len;
715                         }
716
717                         for (subi = 0; subi < subn; subi++) {
718                                 if (!perf_test__matches(t->subtest.get_desc(subi), curr, argc, argv))
719                                         continue;
720
721                                 pr_info("%2d.%1d: %-*s:", i, subi + 1, subw,
722                                         t->subtest.get_desc(subi));
723                                 err = test_and_print(t, skip, subi);
724                                 if (err != TEST_OK && t->subtest.skip_if_fail)
725                                         skip = true;
726                         }
727                 }
728         }
729
730         return run_shell_tests(argc, argv, i, width);
731 }
732
733 static int perf_test__list_shell(int argc, const char **argv, int i)
734 {
735         struct dirent **entlist;
736         struct dirent *ent;
737         int n_dirs, e;
738         char path_dir[PATH_MAX];
739         const char *path = shell_tests__dir(path_dir, sizeof(path_dir));
740
741         if (path == NULL)
742                 return -1;
743
744         n_dirs = scandir(path, &entlist, NULL, alphasort);
745         if (n_dirs == -1)
746                 return -1;
747
748         for_each_shell_test(entlist, n_dirs, path, ent) {
749                 int curr = i++;
750                 char bf[256];
751                 struct test t = {
752                         .desc = shell_test__description(bf, sizeof(bf), path, ent->d_name),
753                 };
754
755                 if (!perf_test__matches(t.desc, curr, argc, argv))
756                         continue;
757
758                 pr_info("%2d: %s\n", i, t.desc);
759
760         }
761
762         for (e = 0; e < n_dirs; e++)
763                 zfree(&entlist[e]);
764         free(entlist);
765         return 0;
766 }
767
768 static int perf_test__list(int argc, const char **argv)
769 {
770         unsigned int j;
771         struct test *t;
772         int i = 0;
773
774         for_each_test(j, t) {
775                 int curr = i++;
776
777                 if (!perf_test__matches(t->desc, curr, argc, argv) ||
778                     (t->is_supported && !t->is_supported()))
779                         continue;
780
781                 pr_info("%2d: %s\n", i, t->desc);
782
783                 if (t->subtest.get_nr) {
784                         int subn = t->subtest.get_nr();
785                         int subi;
786
787                         for (subi = 0; subi < subn; subi++)
788                                 pr_info("%2d:%1d: %s\n", i, subi + 1,
789                                         t->subtest.get_desc(subi));
790                 }
791         }
792
793         perf_test__list_shell(argc, argv, i);
794
795         return 0;
796 }
797
798 int cmd_test(int argc, const char **argv)
799 {
800         const char *test_usage[] = {
801         "perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
802         NULL,
803         };
804         const char *skip = NULL;
805         const struct option test_options[] = {
806         OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
807         OPT_INCR('v', "verbose", &verbose,
808                     "be more verbose (show symbol address, etc)"),
809         OPT_BOOLEAN('F', "dont-fork", &dont_fork,
810                     "Do not fork for testcase"),
811         OPT_END()
812         };
813         const char * const test_subcommands[] = { "list", NULL };
814         struct intlist *skiplist = NULL;
815         int ret = hists__init();
816
817         if (ret < 0)
818                 return ret;
819
820         argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
821         if (argc >= 1 && !strcmp(argv[0], "list"))
822                 return perf_test__list(argc - 1, argv + 1);
823
824         symbol_conf.priv_size = sizeof(int);
825         symbol_conf.sort_by_name = true;
826         symbol_conf.try_vmlinux_path = true;
827
828         if (symbol__init(NULL) < 0)
829                 return -1;
830
831         if (skip != NULL)
832                 skiplist = intlist__new(skip);
833         /*
834          * Tests that create BPF maps, for instance, need more than the 64K
835          * default:
836          */
837         rlimit__bump_memlock();
838
839         return __cmd_test(argc, argv, skiplist);
840 }