1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Resctrl tests
4  *
5  * Copyright (C) 2018 Intel Corporation
6  *
7  * Authors:
8  *    Sai Praneeth Prakhya <sai.praneeth.prakhya@intel.com>,
9  *    Fenghua Yu <fenghua.yu@intel.com>
10  */
11 #include "resctrl.h"
12 
13 #define BENCHMARK_ARGS		64
14 #define BENCHMARK_ARG_SIZE	64
15 
16 static int detect_vendor(void)
17 {
18 	FILE *inf = fopen("/proc/cpuinfo", "r");
19 	int vendor_id = 0;
20 	char *s = NULL;
21 	char *res;
22 
23 	if (!inf)
24 		return vendor_id;
25 
26 	res = fgrep(inf, "vendor_id");
27 
28 	if (res)
29 		s = strchr(res, ':');
30 
31 	if (s && !strcmp(s, ": GenuineIntel\n"))
32 		vendor_id = ARCH_INTEL;
33 	else if (s && !strcmp(s, ": AuthenticAMD\n"))
34 		vendor_id = ARCH_AMD;
35 
36 	fclose(inf);
37 	free(res);
38 	return vendor_id;
39 }
40 
41 int get_vendor(void)
42 {
43 	static int vendor = -1;
44 
45 	if (vendor == -1)
46 		vendor = detect_vendor();
47 	if (vendor == 0)
48 		ksft_print_msg("Can not get vendor info...\n");
49 
50 	return vendor;
51 }
52 
53 static void cmd_help(void)
54 {
55 	printf("usage: resctrl_tests [-h] [-b \"benchmark_cmd [options]\"] [-t test list] [-n no_of_bits]\n");
56 	printf("\t-b benchmark_cmd [options]: run specified benchmark for MBM, MBA and CMT\n");
57 	printf("\t   default benchmark is builtin fill_buf\n");
58 	printf("\t-t test list: run tests specified in the test list, ");
59 	printf("e.g. -t mbm,mba,cmt,cat\n");
60 	printf("\t-n no_of_bits: run cache tests using specified no of bits in cache bit mask\n");
61 	printf("\t-p cpu_no: specify CPU number to run the test. 1 is default\n");
62 	printf("\t-h: help\n");
63 }
64 
65 void tests_cleanup(void)
66 {
67 	mbm_test_cleanup();
68 	mba_test_cleanup();
69 	cmt_test_cleanup();
70 	cat_test_cleanup();
71 }
72 
73 static void run_mbm_test(char **benchmark_cmd, size_t span,
74 			 int cpu_no, char *bw_report)
75 {
76 	int res;
77 
78 	ksft_print_msg("Starting MBM BW change ...\n");
79 
80 	res = mount_resctrlfs();
81 	if (res) {
82 		ksft_exit_fail_msg("Failed to mount resctrl FS\n");
83 		return;
84 	}
85 
86 	if (!validate_resctrl_feature_request(MBM_STR) || (get_vendor() != ARCH_INTEL)) {
87 		ksft_test_result_skip("Hardware does not support MBM or MBM is disabled\n");
88 		goto umount;
89 	}
90 
91 	res = mbm_bw_change(span, cpu_no, bw_report, benchmark_cmd);
92 	ksft_test_result(!res, "MBM: bw change\n");
93 	if ((get_vendor() == ARCH_INTEL) && res)
94 		ksft_print_msg("Intel MBM may be inaccurate when Sub-NUMA Clustering is enabled. Check BIOS configuration.\n");
95 
96 umount:
97 	umount_resctrlfs();
98 }
99 
100 static void run_mba_test(char **benchmark_cmd, int cpu_no, char *bw_report)
101 {
102 	int res;
103 
104 	ksft_print_msg("Starting MBA Schemata change ...\n");
105 
106 	res = mount_resctrlfs();
107 	if (res) {
108 		ksft_exit_fail_msg("Failed to mount resctrl FS\n");
109 		return;
110 	}
111 
112 	if (!validate_resctrl_feature_request(MBA_STR) || (get_vendor() != ARCH_INTEL)) {
113 		ksft_test_result_skip("Hardware does not support MBA or MBA is disabled\n");
114 		goto umount;
115 	}
116 
117 	res = mba_schemata_change(cpu_no, bw_report, benchmark_cmd);
118 	ksft_test_result(!res, "MBA: schemata change\n");
119 
120 umount:
121 	umount_resctrlfs();
122 }
123 
124 static void run_cmt_test(char **benchmark_cmd, int cpu_no)
125 {
126 	int res;
127 
128 	ksft_print_msg("Starting CMT test ...\n");
129 
130 	res = mount_resctrlfs();
131 	if (res) {
132 		ksft_exit_fail_msg("Failed to mount resctrl FS\n");
133 		return;
134 	}
135 
136 	if (!validate_resctrl_feature_request(CMT_STR)) {
137 		ksft_test_result_skip("Hardware does not support CMT or CMT is disabled\n");
138 		goto umount;
139 	}
140 
141 	res = cmt_resctrl_val(cpu_no, 5, benchmark_cmd);
142 	ksft_test_result(!res, "CMT: test\n");
143 	if ((get_vendor() == ARCH_INTEL) && res)
144 		ksft_print_msg("Intel CMT may be inaccurate when Sub-NUMA Clustering is enabled. Check BIOS configuration.\n");
145 
146 umount:
147 	umount_resctrlfs();
148 }
149 
150 static void run_cat_test(int cpu_no, int no_of_bits)
151 {
152 	int res;
153 
154 	ksft_print_msg("Starting CAT test ...\n");
155 
156 	res = mount_resctrlfs();
157 	if (res) {
158 		ksft_exit_fail_msg("Failed to mount resctrl FS\n");
159 		return;
160 	}
161 
162 	if (!validate_resctrl_feature_request(CAT_STR)) {
163 		ksft_test_result_skip("Hardware does not support CAT or CAT is disabled\n");
164 		goto umount;
165 	}
166 
167 	res = cat_perf_miss_val(cpu_no, no_of_bits, "L3");
168 	ksft_test_result(!res, "CAT: test\n");
169 
170 umount:
171 	umount_resctrlfs();
172 }
173 
174 int main(int argc, char **argv)
175 {
176 	bool has_ben = false, mbm_test = true, mba_test = true, cmt_test = true;
177 	char *benchmark_cmd[BENCHMARK_ARGS], bw_report[64], bm_type[64];
178 	char benchmark_cmd_area[BENCHMARK_ARGS][BENCHMARK_ARG_SIZE];
179 	int c, cpu_no = 1, argc_new = argc, i, no_of_bits = 0;
180 	int ben_ind, ben_count, tests = 0;
181 	size_t span = 250 * MB;
182 	bool cat_test = true;
183 
184 	for (i = 0; i < argc; i++) {
185 		if (strcmp(argv[i], "-b") == 0) {
186 			ben_ind = i + 1;
187 			ben_count = argc - ben_ind;
188 			argc_new = ben_ind - 1;
189 			has_ben = true;
190 			break;
191 		}
192 	}
193 
194 	while ((c = getopt(argc_new, argv, "ht:b:n:p:")) != -1) {
195 		char *token;
196 
197 		switch (c) {
198 		case 't':
199 			token = strtok(optarg, ",");
200 
201 			mbm_test = false;
202 			mba_test = false;
203 			cmt_test = false;
204 			cat_test = false;
205 			while (token) {
206 				if (!strncmp(token, MBM_STR, sizeof(MBM_STR))) {
207 					mbm_test = true;
208 					tests++;
209 				} else if (!strncmp(token, MBA_STR, sizeof(MBA_STR))) {
210 					mba_test = true;
211 					tests++;
212 				} else if (!strncmp(token, CMT_STR, sizeof(CMT_STR))) {
213 					cmt_test = true;
214 					tests++;
215 				} else if (!strncmp(token, CAT_STR, sizeof(CAT_STR))) {
216 					cat_test = true;
217 					tests++;
218 				} else {
219 					printf("invalid argument\n");
220 
221 					return -1;
222 				}
223 				token = strtok(NULL, ",");
224 			}
225 			break;
226 		case 'p':
227 			cpu_no = atoi(optarg);
228 			break;
229 		case 'n':
230 			no_of_bits = atoi(optarg);
231 			if (no_of_bits <= 0) {
232 				printf("Bail out! invalid argument for no_of_bits\n");
233 				return -1;
234 			}
235 			break;
236 		case 'h':
237 			cmd_help();
238 
239 			return 0;
240 		default:
241 			printf("invalid argument\n");
242 
243 			return -1;
244 		}
245 	}
246 
247 	ksft_print_header();
248 
249 	/*
250 	 * Typically we need root privileges, because:
251 	 * 1. We write to resctrl FS
252 	 * 2. We execute perf commands
253 	 */
254 	if (geteuid() != 0)
255 		return ksft_exit_skip("Not running as root. Skipping...\n");
256 
257 	if (has_ben) {
258 		if (argc - ben_ind >= BENCHMARK_ARGS)
259 			ksft_exit_fail_msg("Too long benchmark command.\n");
260 
261 		/* Extract benchmark command from command line. */
262 		for (i = ben_ind; i < argc; i++) {
263 			benchmark_cmd[i - ben_ind] = benchmark_cmd_area[i];
264 			if (strlen(argv[i]) >= BENCHMARK_ARG_SIZE)
265 				ksft_exit_fail_msg("Too long benchmark command argument.\n");
266 			sprintf(benchmark_cmd[i - ben_ind], "%s", argv[i]);
267 		}
268 		benchmark_cmd[ben_count] = NULL;
269 	} else {
270 		/* If no benchmark is given by "-b" argument, use fill_buf. */
271 		for (i = 0; i < 5; i++)
272 			benchmark_cmd[i] = benchmark_cmd_area[i];
273 
274 		strcpy(benchmark_cmd[0], "fill_buf");
275 		sprintf(benchmark_cmd[1], "%zu", span);
276 		strcpy(benchmark_cmd[2], "1");
277 		strcpy(benchmark_cmd[3], "0");
278 		strcpy(benchmark_cmd[4], "false");
279 		benchmark_cmd[5] = NULL;
280 	}
281 
282 	sprintf(bw_report, "reads");
283 	sprintf(bm_type, "fill_buf");
284 
285 	if (!check_resctrlfs_support())
286 		return ksft_exit_skip("resctrl FS does not exist. Enable X86_CPU_RESCTRL config option.\n");
287 
288 	if (umount_resctrlfs())
289 		return ksft_exit_skip("resctrl FS unmount failed.\n");
290 
291 	filter_dmesg();
292 
293 	ksft_set_plan(tests ? : 4);
294 
295 	if (mbm_test)
296 		run_mbm_test(benchmark_cmd, span, cpu_no, bw_report);
297 
298 	if (mba_test)
299 		run_mba_test(benchmark_cmd, cpu_no, bw_report);
300 
301 	if (cmt_test)
302 		run_cmt_test(benchmark_cmd, cpu_no);
303 
304 	if (cat_test)
305 		run_cat_test(cpu_no, no_of_bits);
306 
307 	ksft_finished();
308 }
309