tools/testing/selftests/resctrl/resctrl_tests.c

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