1/*
  2 * builtin-test.c
  3 *
  4 * Builtin regression testing command: ever growing number of sanity tests
  5 */
  6#include "builtin.h"
  7#include "intlist.h"
  8#include "tests.h"
  9#include "debug.h"
 10#include "color.h"
 11#include "parse-options.h"
 12#include "symbol.h"
 13
 14static struct test {
 15	const char *desc;
 16	int (*func)(void);
 17} tests[] = {
 18	{
 19		.desc = "vmlinux symtab matches kallsyms",
 20		.func = test__vmlinux_matches_kallsyms,
 21	},
 22	{
 23		.desc = "detect open syscall event",
 24		.func = test__open_syscall_event,
 25	},
 26	{
 27		.desc = "detect open syscall event on all cpus",
 28		.func = test__open_syscall_event_on_all_cpus,
 29	},
 30	{
 31		.desc = "read samples using the mmap interface",
 32		.func = test__basic_mmap,
 33	},
 34	{
 35		.desc = "parse events tests",
 36		.func = test__parse_events,
 37	},
 38#if defined(__x86_64__) || defined(__i386__)
 39	{
 40		.desc = "x86 rdpmc test",
 41		.func = test__rdpmc,
 42	},
 43#endif
 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 interface",
 54		.func = test__dso_data,
 55	},
 56	{
 57		.desc = "roundtrip evsel->name check",
 58		.func = test__perf_evsel__roundtrip_name_test,
 59	},
 60	{
 61		.desc = "Check parsing of sched tracepoints fields",
 62		.func = test__perf_evsel__tp_sched_test,
 63	},
 64	{
 65		.desc = "Generate and check syscalls:sys_enter_open event fields",
 66		.func = test__syscall_open_tp_fields,
 67	},
 68	{
 69		.desc = "struct perf_event_attr setup",
 70		.func = test__attr,
 71	},
 72	{
 73		.desc = "Test matching and linking multiple hists",
 74		.func = test__hists_link,
 75	},
 76	{
 77		.desc = "Try 'use perf' in python, checking link problems",
 78		.func = test__python_use,
 79	},
 80	{
 81		.desc = "Test breakpoint overflow signal handler",
 82		.func = test__bp_signal,
 83	},
 84	{
 85		.desc = "Test breakpoint overflow sampling",
 86		.func = test__bp_signal_overflow,
 87	},
 88	{
 89		.desc = "Test number of exit event of a simple workload",
 90		.func = test__task_exit,
 91	},
 92	{
 93		.desc = "Test software clock events have valid period values",
 94		.func = test__sw_clock_freq,
 95	},
 96#if defined(__x86_64__) || defined(__i386__)
 97	{
 98		.desc = "Test converting perf time to TSC",
 99		.func = test__perf_time_to_tsc,
100	},
101#endif
102	{
103		.desc = "Test object code reading",
104		.func = test__code_reading,
105	},
106	{
107		.desc = "Test sample parsing",
108		.func = test__sample_parsing,
109	},
110	{
111		.desc = "Test using a dummy software event to keep tracking",
112		.func = test__keep_tracking,
113	},
114	{
115		.desc = "Test parsing with no sample_id_all bit set",
116		.func = test__parse_no_sample_id_all,
117	},
118#if defined(__x86_64__) || defined(__i386__)
119#ifdef HAVE_DWARF_UNWIND_SUPPORT
120	{
121		.desc = "Test dwarf unwind",
122		.func = test__dwarf_unwind,
123	},
124#endif
125#endif
126	{
127		.func = NULL,
128	},
129};
130
131static bool perf_test__matches(int curr, int argc, const char *argv[])
132{
133	int i;
134
135	if (argc == 0)
136		return true;
137
138	for (i = 0; i < argc; ++i) {
139		char *end;
140		long nr = strtoul(argv[i], &end, 10);
141
142		if (*end == '\0') {
143			if (nr == curr + 1)
144				return true;
145			continue;
146		}
147
148		if (strstr(tests[curr].desc, argv[i]))
149			return true;
150	}
151
152	return false;
153}
154
155static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
156{
157	int i = 0;
158	int width = 0;
159
160	while (tests[i].func) {
161		int len = strlen(tests[i].desc);
162
163		if (width < len)
164			width = len;
165		++i;
166	}
167
168	i = 0;
169	while (tests[i].func) {
170		int curr = i++, err;
171
172		if (!perf_test__matches(curr, argc, argv))
173			continue;
174
175		pr_info("%2d: %-*s:", i, width, tests[curr].desc);
176
177		if (intlist__find(skiplist, i)) {
178			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
179			continue;
180		}
181
182		pr_debug("\n--- start ---\n");
183		err = tests[curr].func();
184		pr_debug("---- end ----\n%s:", tests[curr].desc);
185
186		switch (err) {
187		case TEST_OK:
188			pr_info(" Ok\n");
189			break;
190		case TEST_SKIP:
191			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
192			break;
193		case TEST_FAIL:
194		default:
195			color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
196			break;
197		}
198	}
199
200	return 0;
201}
202
203static int perf_test__list(int argc, const char **argv)
204{
205	int i = 0;
206
207	while (tests[i].func) {
208		int curr = i++;
209
210		if (argc > 1 && !strstr(tests[curr].desc, argv[1]))
211			continue;
212
213		pr_info("%2d: %s\n", i, tests[curr].desc);
214	}
215
216	return 0;
217}
218
219int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
220{
221	const char * const test_usage[] = {
222	"perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
223	NULL,
224	};
225	const char *skip = NULL;
226	const struct option test_options[] = {
227	OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
228	OPT_INCR('v', "verbose", &verbose,
229		    "be more verbose (show symbol address, etc)"),
230	OPT_END()
231	};
232	struct intlist *skiplist = NULL;
233
234	argc = parse_options(argc, argv, test_options, test_usage, 0);
235	if (argc >= 1 && !strcmp(argv[0], "list"))
236		return perf_test__list(argc, argv);
237
238	symbol_conf.priv_size = sizeof(int);
239	symbol_conf.sort_by_name = true;
240	symbol_conf.try_vmlinux_path = true;
241
242	if (symbol__init() < 0)
243		return -1;
244
245	if (skip != NULL)
246		skiplist = intlist__new(skip);
247
248	return __cmd_test(argc, argv, skiplist);
249}