1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef RESCTRL_H 3 #define RESCTRL_H 4 #include <stdio.h> 5 #include <math.h> 6 #include <errno.h> 7 #include <sched.h> 8 #include <stdlib.h> 9 #include <unistd.h> 10 #include <string.h> 11 #include <signal.h> 12 #include <dirent.h> 13 #include <stdbool.h> 14 #include <sys/stat.h> 15 #include <sys/ioctl.h> 16 #include <sys/mount.h> 17 #include <sys/types.h> 18 #include <sys/wait.h> 19 #include <sys/select.h> 20 #include <sys/time.h> 21 #include <sys/eventfd.h> 22 #include <asm/unistd.h> 23 #include <linux/perf_event.h> 24 #include "../kselftest.h" 25 26 #define MB (1024 * 1024) 27 #define RESCTRL_PATH "/sys/fs/resctrl" 28 #define PHYS_ID_PATH "/sys/devices/system/cpu/cpu" 29 #define INFO_PATH "/sys/fs/resctrl/info" 30 31 /* 32 * CPU vendor IDs 33 * 34 * Define as bits because they're used for vendor_specific bitmask in 35 * the struct resctrl_test. 36 */ 37 #define ARCH_INTEL 1 38 #define ARCH_AMD 2 39 40 #define END_OF_TESTS 1 41 42 #define BENCHMARK_ARGS 64 43 44 #define DEFAULT_SPAN (250 * MB) 45 46 /* 47 * user_params: User supplied parameters 48 * @cpu: CPU number to which the benchmark will be bound to 49 * @bits: Number of bits used for cache allocation size 50 * @benchmark_cmd: Benchmark command to run during (some of the) tests 51 */ 52 struct user_params { 53 int cpu; 54 int bits; 55 const char *benchmark_cmd[BENCHMARK_ARGS]; 56 }; 57 58 /* 59 * resctrl_test: resctrl test definition 60 * @name: Test name 61 * @group: Test group - a common name for tests that share some characteristic 62 * (e.g., L3 CAT test belongs to the CAT group). Can be NULL 63 * @resource: Resource to test (e.g., MB, L3, L2, etc.) 64 * @vendor_specific: Bitmask for vendor-specific tests (can be 0 for universal tests) 65 * @disabled: Test is disabled 66 * @feature_check: Callback to check required resctrl features 67 * @run_test: Callback to run the test 68 * @cleanup: Callback to cleanup after the test 69 */ 70 struct resctrl_test { 71 const char *name; 72 const char *group; 73 const char *resource; 74 unsigned int vendor_specific; 75 bool disabled; 76 bool (*feature_check)(const struct resctrl_test *test); 77 int (*run_test)(const struct resctrl_test *test, 78 const struct user_params *uparams); 79 void (*cleanup)(void); 80 }; 81 82 /* 83 * resctrl_val_param: resctrl test parameters 84 * @resctrl_val: Resctrl feature (Eg: mbm, mba.. etc) 85 * @ctrlgrp: Name of the control monitor group (con_mon grp) 86 * @mongrp: Name of the monitor group (mon grp) 87 * @filename: Name of file to which the o/p should be written 88 * @bw_report: Bandwidth report type (reads vs writes) 89 * @setup: Call back function to setup test environment 90 */ 91 struct resctrl_val_param { 92 char *resctrl_val; 93 char ctrlgrp[64]; 94 char mongrp[64]; 95 char filename[64]; 96 char *bw_report; 97 unsigned long mask; 98 int num_of_runs; 99 int (*setup)(const struct resctrl_test *test, 100 const struct user_params *uparams, 101 struct resctrl_val_param *param); 102 }; 103 104 struct perf_event_read { 105 __u64 nr; /* The number of events */ 106 struct { 107 __u64 value; /* The value of the event */ 108 } values[2]; 109 }; 110 111 #define MBM_STR "mbm" 112 #define MBA_STR "mba" 113 #define CMT_STR "cmt" 114 #define CAT_STR "cat" 115 116 /* 117 * Memory location that consumes values compiler must not optimize away. 118 * Volatile ensures writes to this location cannot be optimized away by 119 * compiler. 120 */ 121 extern volatile int *value_sink; 122 123 extern char llc_occup_path[1024]; 124 125 int get_vendor(void); 126 bool check_resctrlfs_support(void); 127 int filter_dmesg(void); 128 int get_domain_id(const char *resource, int cpu_no, int *domain_id); 129 int mount_resctrlfs(void); 130 int umount_resctrlfs(void); 131 int validate_bw_report_request(char *bw_report); 132 bool resctrl_resource_exists(const char *resource); 133 bool resctrl_mon_feature_exists(const char *resource, const char *feature); 134 bool resource_info_file_exists(const char *resource, const char *file); 135 bool test_resource_feature_check(const struct resctrl_test *test); 136 char *fgrep(FILE *inf, const char *str); 137 int taskset_benchmark(pid_t bm_pid, int cpu_no, cpu_set_t *old_affinity); 138 int taskset_restore(pid_t bm_pid, cpu_set_t *old_affinity); 139 int write_schemata(char *ctrlgrp, char *schemata, int cpu_no, const char *resource); 140 int write_bm_pid_to_resctrl(pid_t bm_pid, char *ctrlgrp, char *mongrp, 141 char *resctrl_val); 142 int perf_event_open(struct perf_event_attr *hw_event, pid_t pid, int cpu, 143 int group_fd, unsigned long flags); 144 unsigned char *alloc_buffer(size_t buf_size, int memflush); 145 void mem_flush(unsigned char *buf, size_t buf_size); 146 void fill_cache_read(unsigned char *buf, size_t buf_size, bool once); 147 int run_fill_buf(size_t buf_size, int memflush, int op, bool once); 148 int resctrl_val(const struct resctrl_test *test, 149 const struct user_params *uparams, 150 const char * const *benchmark_cmd, 151 struct resctrl_val_param *param); 152 unsigned long create_bit_mask(unsigned int start, unsigned int len); 153 unsigned int count_contiguous_bits(unsigned long val, unsigned int *start); 154 int get_full_cbm(const char *cache_type, unsigned long *mask); 155 int get_mask_no_shareable(const char *cache_type, unsigned long *mask); 156 int get_cache_size(int cpu_no, const char *cache_type, unsigned long *cache_size); 157 int resource_info_unsigned_get(const char *resource, const char *filename, unsigned int *val); 158 void ctrlc_handler(int signum, siginfo_t *info, void *ptr); 159 int signal_handler_register(const struct resctrl_test *test); 160 void signal_handler_unregister(void); 161 unsigned int count_bits(unsigned long n); 162 163 void perf_event_attr_initialize(struct perf_event_attr *pea, __u64 config); 164 void perf_event_initialize_read_format(struct perf_event_read *pe_read); 165 int perf_open(struct perf_event_attr *pea, pid_t pid, int cpu_no); 166 int perf_event_reset_enable(int pe_fd); 167 int perf_event_measure(int pe_fd, struct perf_event_read *pe_read, 168 const char *filename, pid_t bm_pid); 169 int measure_llc_resctrl(const char *filename, pid_t bm_pid); 170 void show_cache_info(int no_of_bits, __u64 avg_llc_val, size_t cache_span, bool lines); 171 172 /* 173 * cache_portion_size - Calculate the size of a cache portion 174 * @cache_size: Total cache size in bytes 175 * @portion_mask: Cache portion mask 176 * @full_cache_mask: Full Cache Bit Mask (CBM) for the cache 177 * 178 * Return: The size of the cache portion in bytes. 179 */ 180 static inline unsigned long cache_portion_size(unsigned long cache_size, 181 unsigned long portion_mask, 182 unsigned long full_cache_mask) 183 { 184 unsigned int bits = count_bits(full_cache_mask); 185 186 /* 187 * With no bits the full CBM, assume cache cannot be split into 188 * smaller portions. To avoid divide by zero, return cache_size. 189 */ 190 if (!bits) 191 return cache_size; 192 193 return cache_size * count_bits(portion_mask) / bits; 194 } 195 196 extern struct resctrl_test mbm_test; 197 extern struct resctrl_test mba_test; 198 extern struct resctrl_test cmt_test; 199 extern struct resctrl_test l3_cat_test; 200 extern struct resctrl_test l3_noncont_cat_test; 201 extern struct resctrl_test l2_noncont_cat_test; 202 203 #endif /* RESCTRL_H */ 204