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(bool has_ben, char **benchmark_cmd, int span,
74 			 int cpu_no, char *bw_report)
75 {
76 	int res;
77 
78 	ksft_print_msg("Starting MBM BW change ...\n");
79 
80 	if (!validate_resctrl_feature_request(MBM_STR)) {
81 		ksft_test_result_skip("Hardware does not support MBM or MBM is disabled\n");
82 		return;
83 	}
84 
85 	if (!has_ben)
86 		sprintf(benchmark_cmd[5], "%s", MBA_STR);
87 	res = mbm_bw_change(span, cpu_no, bw_report, benchmark_cmd);
88 	ksft_test_result(!res, "MBM: bw change\n");
89 	if ((get_vendor() == ARCH_INTEL) && res)
90 		ksft_print_msg("Intel MBM may be inaccurate when Sub-NUMA Clustering is enabled. Check BIOS configuration.\n");
91 	mbm_test_cleanup();
92 }
93 
94 static void run_mba_test(bool has_ben, char **benchmark_cmd, int span,
95 			 int cpu_no, char *bw_report)
96 {
97 	int res;
98 
99 	ksft_print_msg("Starting MBA Schemata change ...\n");
100 
101 	if (!validate_resctrl_feature_request(MBA_STR)) {
102 		ksft_test_result_skip("Hardware does not support MBA or MBA is disabled\n");
103 		return;
104 	}
105 
106 	if (!has_ben)
107 		sprintf(benchmark_cmd[1], "%d", span);
108 	res = mba_schemata_change(cpu_no, bw_report, benchmark_cmd);
109 	ksft_test_result(!res, "MBA: schemata change\n");
110 	mba_test_cleanup();
111 }
112 
113 static void run_cmt_test(bool has_ben, char **benchmark_cmd, int cpu_no)
114 {
115 	int res;
116 
117 	ksft_print_msg("Starting CMT test ...\n");
118 	if (!validate_resctrl_feature_request(CMT_STR)) {
119 		ksft_test_result_skip("Hardware does not support CMT or CMT is disabled\n");
120 		return;
121 	}
122 
123 	if (!has_ben)
124 		sprintf(benchmark_cmd[5], "%s", CMT_STR);
125 	res = cmt_resctrl_val(cpu_no, 5, benchmark_cmd);
126 	ksft_test_result(!res, "CMT: test\n");
127 	if ((get_vendor() == ARCH_INTEL) && res)
128 		ksft_print_msg("Intel CMT may be inaccurate when Sub-NUMA Clustering is enabled. Check BIOS configuration.\n");
129 	cmt_test_cleanup();
130 }
131 
132 static void run_cat_test(int cpu_no, int no_of_bits)
133 {
134 	int res;
135 
136 	ksft_print_msg("Starting CAT test ...\n");
137 
138 	if (!validate_resctrl_feature_request(CAT_STR)) {
139 		ksft_test_result_skip("Hardware does not support CAT or CAT is disabled\n");
140 		return;
141 	}
142 
143 	res = cat_perf_miss_val(cpu_no, no_of_bits, "L3");
144 	ksft_test_result(!res, "CAT: test\n");
145 	cat_test_cleanup();
146 }
147 
148 int main(int argc, char **argv)
149 {
150 	bool has_ben = false, mbm_test = true, mba_test = true, cmt_test = true;
151 	int c, cpu_no = 1, span = 250, argc_new = argc, i, no_of_bits = 0;
152 	char *benchmark_cmd[BENCHMARK_ARGS], bw_report[64], bm_type[64];
153 	char benchmark_cmd_area[BENCHMARK_ARGS][BENCHMARK_ARG_SIZE];
154 	int ben_ind, ben_count, tests = 0;
155 	bool cat_test = true;
156 
157 	for (i = 0; i < argc; i++) {
158 		if (strcmp(argv[i], "-b") == 0) {
159 			ben_ind = i + 1;
160 			ben_count = argc - ben_ind;
161 			argc_new = ben_ind - 1;
162 			has_ben = true;
163 			break;
164 		}
165 	}
166 
167 	while ((c = getopt(argc_new, argv, "ht:b:n:p:")) != -1) {
168 		char *token;
169 
170 		switch (c) {
171 		case 't':
172 			token = strtok(optarg, ",");
173 
174 			mbm_test = false;
175 			mba_test = false;
176 			cmt_test = false;
177 			cat_test = false;
178 			while (token) {
179 				if (!strncmp(token, MBM_STR, sizeof(MBM_STR))) {
180 					mbm_test = true;
181 					tests++;
182 				} else if (!strncmp(token, MBA_STR, sizeof(MBA_STR))) {
183 					mba_test = true;
184 					tests++;
185 				} else if (!strncmp(token, CMT_STR, sizeof(CMT_STR))) {
186 					cmt_test = true;
187 					tests++;
188 				} else if (!strncmp(token, CAT_STR, sizeof(CAT_STR))) {
189 					cat_test = true;
190 					tests++;
191 				} else {
192 					printf("invalid argument\n");
193 
194 					return -1;
195 				}
196 				token = strtok(NULL, ",");
197 			}
198 			break;
199 		case 'p':
200 			cpu_no = atoi(optarg);
201 			break;
202 		case 'n':
203 			no_of_bits = atoi(optarg);
204 			if (no_of_bits <= 0) {
205 				printf("Bail out! invalid argument for no_of_bits\n");
206 				return -1;
207 			}
208 			break;
209 		case 'h':
210 			cmd_help();
211 
212 			return 0;
213 		default:
214 			printf("invalid argument\n");
215 
216 			return -1;
217 		}
218 	}
219 
220 	ksft_print_header();
221 
222 	/*
223 	 * Typically we need root privileges, because:
224 	 * 1. We write to resctrl FS
225 	 * 2. We execute perf commands
226 	 */
227 	if (geteuid() != 0)
228 		return ksft_exit_skip("Not running as root. Skipping...\n");
229 
230 	if (has_ben) {
231 		/* Extract benchmark command from command line. */
232 		for (i = ben_ind; i < argc; i++) {
233 			benchmark_cmd[i - ben_ind] = benchmark_cmd_area[i];
234 			sprintf(benchmark_cmd[i - ben_ind], "%s", argv[i]);
235 		}
236 		benchmark_cmd[ben_count] = NULL;
237 	} else {
238 		/* If no benchmark is given by "-b" argument, use fill_buf. */
239 		for (i = 0; i < 6; i++)
240 			benchmark_cmd[i] = benchmark_cmd_area[i];
241 
242 		strcpy(benchmark_cmd[0], "fill_buf");
243 		sprintf(benchmark_cmd[1], "%d", span);
244 		strcpy(benchmark_cmd[2], "1");
245 		strcpy(benchmark_cmd[3], "1");
246 		strcpy(benchmark_cmd[4], "0");
247 		strcpy(benchmark_cmd[5], "");
248 		benchmark_cmd[6] = NULL;
249 	}
250 
251 	sprintf(bw_report, "reads");
252 	sprintf(bm_type, "fill_buf");
253 
254 	if (!check_resctrlfs_support())
255 		return ksft_exit_skip("resctrl FS does not exist. Enable X86_CPU_RESCTRL config option.\n");
256 
257 	filter_dmesg();
258 
259 	ksft_set_plan(tests ? : 4);
260 
261 	if ((get_vendor() == ARCH_INTEL) && mbm_test)
262 		run_mbm_test(has_ben, benchmark_cmd, span, cpu_no, bw_report);
263 
264 	if ((get_vendor() == ARCH_INTEL) && mba_test)
265 		run_mba_test(has_ben, benchmark_cmd, span, cpu_no, bw_report);
266 
267 	if (cmt_test)
268 		run_cmt_test(has_ben, benchmark_cmd, cpu_no);
269 
270 	if (cat_test)
271 		run_cat_test(cpu_no, no_of_bits);
272 
273 	umount_resctrlfs();
274 
275 	return ksft_exit_pass();
276 }
277