xref: /linux/tools/perf/tests/tests.h (revision df9c299371054cb725eef730fd0f1d0fe2ed6bb0)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef TESTS_H
3 #define TESTS_H
4 
5 #include <stdbool.h>
6 
7 enum {
8 	TEST_OK   =  0,
9 	TEST_FAIL = -1,
10 	TEST_SKIP = -2,
11 };
12 
13 #define TEST_ASSERT_VAL(text, cond)					 \
14 do {									 \
15 	if (!(cond)) {							 \
16 		pr_debug("FAILED %s:%d %s\n", __FILE__, __LINE__, text); \
17 		return TEST_FAIL;					 \
18 	}								 \
19 } while (0)
20 
21 #define TEST_ASSERT_EQUAL(text, val, expected)				 \
22 do {									 \
23 	if (val != expected) {						 \
24 		pr_debug("FAILED %s:%d %s (%d != %d)\n",		 \
25 			 __FILE__, __LINE__, text, val, expected);	 \
26 		return TEST_FAIL;						 \
27 	}								 \
28 } while (0)
29 
30 struct test_suite;
31 
32 typedef int (*test_fnptr)(struct test_suite *, int);
33 
34 struct test_case {
35 	const char *name;
36 	const char *desc;
37 	const char *skip_reason;
38 	test_fnptr run_case;
39 	bool exclusive;
40 };
41 
42 struct test_suite {
43 	const char *desc;
44 	struct test_case *test_cases;
45 	void *priv;
46 };
47 
48 #define DECLARE_SUITE(name) \
49 	extern struct test_suite suite__##name;
50 
51 #define TEST_CASE(description, _name)			\
52 	{						\
53 		.name = #_name,				\
54 		.desc = description,			\
55 		.run_case = test__##_name,		\
56 	}
57 
58 #define TEST_CASE_REASON(description, _name, _reason)	\
59 	{						\
60 		.name = #_name,				\
61 		.desc = description,			\
62 		.run_case = test__##_name,		\
63 		.skip_reason = _reason,			\
64 	}
65 
66 #define TEST_CASE_EXCLUSIVE(description, _name)		\
67 	{						\
68 		.name = #_name,				\
69 		.desc = description,			\
70 		.run_case = test__##_name,		\
71 		.exclusive = true,			\
72 	}
73 
74 #define TEST_CASE_REASON_EXCLUSIVE(description, _name, _reason)	\
75 	{						\
76 		.name = #_name,				\
77 		.desc = description,			\
78 		.run_case = test__##_name,		\
79 		.skip_reason = _reason,			\
80 		.exclusive = true,			\
81 	}
82 
83 #define DEFINE_SUITE(description, _name)		\
84 	struct test_case tests__##_name[] = {           \
85 		TEST_CASE(description, _name),		\
86 		{	.name = NULL, }			\
87 	};						\
88 	struct test_suite suite__##_name = {		\
89 		.desc = description,			\
90 		.test_cases = tests__##_name,		\
91 	}
92 
93 #define DEFINE_SUITE_EXCLUSIVE(description, _name)	\
94 	struct test_case tests__##_name[] = {           \
95 		TEST_CASE_EXCLUSIVE(description, _name),\
96 		{	.name = NULL, }			\
97 	};						\
98 	struct test_suite suite__##_name = {		\
99 		.desc = description,			\
100 		.test_cases = tests__##_name,		\
101 	}
102 
103 /* Tests */
104 DECLARE_SUITE(vmlinux_matches_kallsyms);
105 DECLARE_SUITE(openat_syscall_event);
106 DECLARE_SUITE(openat_syscall_event_on_all_cpus);
107 DECLARE_SUITE(basic_mmap);
108 DECLARE_SUITE(PERF_RECORD);
109 DECLARE_SUITE(perf_evsel__roundtrip_name_test);
110 DECLARE_SUITE(perf_evsel__tp_sched_test);
111 DECLARE_SUITE(syscall_openat_tp_fields);
112 DECLARE_SUITE(pmu);
113 DECLARE_SUITE(pmu_events);
114 DECLARE_SUITE(hwmon_pmu);
115 DECLARE_SUITE(tool_pmu);
116 DECLARE_SUITE(attr);
117 DECLARE_SUITE(dso_data);
118 DECLARE_SUITE(dso_data_cache);
119 DECLARE_SUITE(dso_data_reopen);
120 DECLARE_SUITE(parse_events);
121 DECLARE_SUITE(hists_link);
122 DECLARE_SUITE(python_use);
123 DECLARE_SUITE(bp_signal);
124 DECLARE_SUITE(bp_signal_overflow);
125 DECLARE_SUITE(bp_accounting);
126 DECLARE_SUITE(wp);
127 DECLARE_SUITE(task_exit);
128 DECLARE_SUITE(mem);
129 DECLARE_SUITE(sw_clock_freq);
130 DECLARE_SUITE(code_reading);
131 DECLARE_SUITE(sample_parsing);
132 DECLARE_SUITE(keep_tracking);
133 DECLARE_SUITE(parse_no_sample_id_all);
134 DECLARE_SUITE(dwarf_unwind);
135 DECLARE_SUITE(expr);
136 DECLARE_SUITE(hists_filter);
137 DECLARE_SUITE(mmap_thread_lookup);
138 DECLARE_SUITE(thread_maps_share);
139 DECLARE_SUITE(hists_output);
140 DECLARE_SUITE(hists_cumulate);
141 DECLARE_SUITE(switch_tracking);
142 DECLARE_SUITE(fdarray__filter);
143 DECLARE_SUITE(fdarray__add);
144 DECLARE_SUITE(kmod_path__parse);
145 DECLARE_SUITE(thread_map);
146 DECLARE_SUITE(bpf);
147 DECLARE_SUITE(session_topology);
148 DECLARE_SUITE(thread_map_synthesize);
149 DECLARE_SUITE(thread_map_remove);
150 DECLARE_SUITE(cpu_map);
151 DECLARE_SUITE(synthesize_stat_config);
152 DECLARE_SUITE(synthesize_stat);
153 DECLARE_SUITE(synthesize_stat_round);
154 DECLARE_SUITE(event_update);
155 DECLARE_SUITE(event_times);
156 DECLARE_SUITE(backward_ring_buffer);
157 DECLARE_SUITE(sdt_event);
158 DECLARE_SUITE(is_printable_array);
159 DECLARE_SUITE(bitmap_print);
160 DECLARE_SUITE(perf_hooks);
161 DECLARE_SUITE(unit_number__scnprint);
162 DECLARE_SUITE(mem2node);
163 DECLARE_SUITE(maps__merge_in);
164 DECLARE_SUITE(time_utils);
165 DECLARE_SUITE(jit_write_elf);
166 DECLARE_SUITE(api_io);
167 DECLARE_SUITE(demangle_java);
168 DECLARE_SUITE(demangle_ocaml);
169 DECLARE_SUITE(demangle_rust);
170 DECLARE_SUITE(pfm);
171 DECLARE_SUITE(parse_metric);
172 DECLARE_SUITE(pe_file_parsing);
173 DECLARE_SUITE(expand_cgroup_events);
174 DECLARE_SUITE(perf_time_to_tsc);
175 DECLARE_SUITE(dlfilter);
176 DECLARE_SUITE(sigtrap);
177 DECLARE_SUITE(event_groups);
178 DECLARE_SUITE(symbols);
179 DECLARE_SUITE(util);
180 
181 /*
182  * PowerPC and S390 do not support creation of instruction breakpoints using the
183  * perf_event interface.
184  *
185  * ARM requires explicit rounding down of the instruction pointer in Thumb mode,
186  * and then requires the single-step to be handled explicitly in the overflow
187  * handler to avoid stepping into the SIGIO handler and getting stuck on the
188  * breakpointed instruction.
189  *
190  * Since arm64 has the same issue with arm for the single-step handling, this
191  * case also gets stuck on the breakpointed instruction.
192  *
193  * Just disable the test for these architectures until these issues are
194  * resolved.
195  */
196 #if defined(__powerpc__) || defined(__s390x__) || defined(__arm__) || defined(__aarch64__)
197 #define BP_SIGNAL_IS_SUPPORTED 0
198 #else
199 #define BP_SIGNAL_IS_SUPPORTED 1
200 #endif
201 
202 #ifdef HAVE_DWARF_UNWIND_SUPPORT
203 struct thread;
204 struct perf_sample;
205 int test__arch_unwind_sample(struct perf_sample *sample,
206 			     struct thread *thread);
207 #endif
208 
209 #if defined(__arm__)
210 DECLARE_SUITE(vectors_page);
211 #endif
212 
213 /*
214  * Define test workloads to be used in test suites.
215  */
216 typedef int (*workload_fnptr)(int argc, const char **argv);
217 
218 struct test_workload {
219 	const char	*name;
220 	workload_fnptr	func;
221 };
222 
223 #define DECLARE_WORKLOAD(work) \
224 	extern struct test_workload workload__##work
225 
226 #define DEFINE_WORKLOAD(work) \
227 struct test_workload workload__##work = {	\
228 	.name = #work,				\
229 	.func = work,				\
230 }
231 
232 /* The list of test workloads */
233 DECLARE_WORKLOAD(noploop);
234 DECLARE_WORKLOAD(thloop);
235 DECLARE_WORKLOAD(leafloop);
236 DECLARE_WORKLOAD(sqrtloop);
237 DECLARE_WORKLOAD(brstack);
238 DECLARE_WORKLOAD(datasym);
239 DECLARE_WORKLOAD(landlock);
240 
241 extern const char *dso_to_test;
242 extern const char *test_objdump_path;
243 
244 #endif /* TESTS_H */
245