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
17struct test __weak arch_tests[] = {
18	{
19		.func = NULL,
20	},
21};
22
23static 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		.desc = "Test BPF filter",
170		.func = test__bpf,
171	},
172	{
173		.func = NULL,
174	},
175};
176
177static struct test *tests[] = {
178	generic_tests,
179	arch_tests,
180};
181
182static bool perf_test__matches(struct test *test, int curr, int argc, const char *argv[])
183{
184	int i;
185
186	if (argc == 0)
187		return true;
188
189	for (i = 0; i < argc; ++i) {
190		char *end;
191		long nr = strtoul(argv[i], &end, 10);
192
193		if (*end == '\0') {
194			if (nr == curr + 1)
195				return true;
196			continue;
197		}
198
199		if (strcasestr(test->desc, argv[i]))
200			return true;
201	}
202
203	return false;
204}
205
206static int run_test(struct test *test)
207{
208	int status, err = -1, child = fork();
209	char sbuf[STRERR_BUFSIZE];
210
211	if (child < 0) {
212		pr_err("failed to fork test: %s\n",
213			strerror_r(errno, sbuf, sizeof(sbuf)));
214		return -1;
215	}
216
217	if (!child) {
218		pr_debug("test child forked, pid %d\n", getpid());
219		err = test->func();
220		exit(err);
221	}
222
223	wait(&status);
224
225	if (WIFEXITED(status)) {
226		err = (signed char)WEXITSTATUS(status);
227		pr_debug("test child finished with %d\n", err);
228	} else if (WIFSIGNALED(status)) {
229		err = -1;
230		pr_debug("test child interrupted\n");
231	}
232
233	return err;
234}
235
236#define for_each_test(j, t)	 				\
237	for (j = 0; j < ARRAY_SIZE(tests); j++)	\
238		for (t = &tests[j][0]; t->func; t++)
239
240static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
241{
242	struct test *t;
243	unsigned int j;
244	int i = 0;
245	int width = 0;
246
247	for_each_test(j, t) {
248		int len = strlen(t->desc);
249
250		if (width < len)
251			width = len;
252	}
253
254	for_each_test(j, t) {
255		int curr = i++, err;
256
257		if (!perf_test__matches(t, curr, argc, argv))
258			continue;
259
260		pr_info("%2d: %-*s:", i, width, t->desc);
261
262		if (intlist__find(skiplist, i)) {
263			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
264			continue;
265		}
266
267		pr_debug("\n--- start ---\n");
268		err = run_test(t);
269		pr_debug("---- end ----\n%s:", t->desc);
270
271		switch (err) {
272		case TEST_OK:
273			pr_info(" Ok\n");
274			break;
275		case TEST_SKIP:
276			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
277			break;
278		case TEST_FAIL:
279		default:
280			color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
281			break;
282		}
283	}
284
285	return 0;
286}
287
288static int perf_test__list(int argc, const char **argv)
289{
290	unsigned int j;
291	struct test *t;
292	int i = 0;
293
294	for_each_test(j, t) {
295		if (argc > 1 && !strstr(t->desc, argv[1]))
296			continue;
297
298		pr_info("%2d: %s\n", ++i, t->desc);
299	}
300
301	return 0;
302}
303
304int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
305{
306	const char *test_usage[] = {
307	"perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
308	NULL,
309	};
310	const char *skip = NULL;
311	const struct option test_options[] = {
312	OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
313	OPT_INCR('v', "verbose", &verbose,
314		    "be more verbose (show symbol address, etc)"),
315	OPT_END()
316	};
317	const char * const test_subcommands[] = { "list", NULL };
318	struct intlist *skiplist = NULL;
319        int ret = hists__init();
320
321        if (ret < 0)
322                return ret;
323
324	argc = parse_options_subcommand(argc, argv, test_options, test_subcommands, test_usage, 0);
325	if (argc >= 1 && !strcmp(argv[0], "list"))
326		return perf_test__list(argc, argv);
327
328	symbol_conf.priv_size = sizeof(int);
329	symbol_conf.sort_by_name = true;
330	symbol_conf.try_vmlinux_path = true;
331
332	if (symbol__init(NULL) < 0)
333		return -1;
334
335	if (skip != NULL)
336		skiplist = intlist__new(skip);
337
338	return __cmd_test(argc, argv, skiplist);
339}
340