xref: /openbmc/linux/tools/perf/tests/builtin-test.c (revision ee89bd6b)
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 
14 static 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 mutliple 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 	{
97 		.func = NULL,
98 	},
99 };
100 
101 static bool perf_test__matches(int curr, int argc, const char *argv[])
102 {
103 	int i;
104 
105 	if (argc == 0)
106 		return true;
107 
108 	for (i = 0; i < argc; ++i) {
109 		char *end;
110 		long nr = strtoul(argv[i], &end, 10);
111 
112 		if (*end == '\0') {
113 			if (nr == curr + 1)
114 				return true;
115 			continue;
116 		}
117 
118 		if (strstr(tests[curr].desc, argv[i]))
119 			return true;
120 	}
121 
122 	return false;
123 }
124 
125 static int __cmd_test(int argc, const char *argv[], struct intlist *skiplist)
126 {
127 	int i = 0;
128 	int width = 0;
129 
130 	while (tests[i].func) {
131 		int len = strlen(tests[i].desc);
132 
133 		if (width < len)
134 			width = len;
135 		++i;
136 	}
137 
138 	i = 0;
139 	while (tests[i].func) {
140 		int curr = i++, err;
141 
142 		if (!perf_test__matches(curr, argc, argv))
143 			continue;
144 
145 		pr_info("%2d: %-*s:", i, width, tests[curr].desc);
146 
147 		if (intlist__find(skiplist, i)) {
148 			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip (user override)\n");
149 			continue;
150 		}
151 
152 		pr_debug("\n--- start ---\n");
153 		err = tests[curr].func();
154 		pr_debug("---- end ----\n%s:", tests[curr].desc);
155 
156 		switch (err) {
157 		case TEST_OK:
158 			pr_info(" Ok\n");
159 			break;
160 		case TEST_SKIP:
161 			color_fprintf(stderr, PERF_COLOR_YELLOW, " Skip\n");
162 			break;
163 		case TEST_FAIL:
164 		default:
165 			color_fprintf(stderr, PERF_COLOR_RED, " FAILED!\n");
166 			break;
167 		}
168 	}
169 
170 	return 0;
171 }
172 
173 static int perf_test__list(int argc, const char **argv)
174 {
175 	int i = 0;
176 
177 	while (tests[i].func) {
178 		int curr = i++;
179 
180 		if (argc > 1 && !strstr(tests[curr].desc, argv[1]))
181 			continue;
182 
183 		pr_info("%2d: %s\n", i, tests[curr].desc);
184 	}
185 
186 	return 0;
187 }
188 
189 int cmd_test(int argc, const char **argv, const char *prefix __maybe_unused)
190 {
191 	const char * const test_usage[] = {
192 	"perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]",
193 	NULL,
194 	};
195 	const char *skip = NULL;
196 	const struct option test_options[] = {
197 	OPT_STRING('s', "skip", &skip, "tests", "tests to skip"),
198 	OPT_INCR('v', "verbose", &verbose,
199 		    "be more verbose (show symbol address, etc)"),
200 	OPT_END()
201 	};
202 	struct intlist *skiplist = NULL;
203 
204 	argc = parse_options(argc, argv, test_options, test_usage, 0);
205 	if (argc >= 1 && !strcmp(argv[0], "list"))
206 		return perf_test__list(argc, argv);
207 
208 	symbol_conf.priv_size = sizeof(int);
209 	symbol_conf.sort_by_name = true;
210 	symbol_conf.try_vmlinux_path = true;
211 
212 	if (symbol__init() < 0)
213 		return -1;
214 
215 	if (skip != NULL)
216 		skiplist = intlist__new(skip);
217 
218 	return __cmd_test(argc, argv, skiplist);
219 }
220