208 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef RESCTRL_H3#define RESCTRL_H4#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 IDs33 *34 * Define as bits because they're used for vendor_specific bitmask in35 * the struct resctrl_test.36 */37#define ARCH_INTEL 138#define ARCH_AMD 239 40#define END_OF_TESTS 141 42#define BENCHMARK_ARGS 6443 44#define DEFAULT_SPAN (250 * MB)45 46/*47 * user_params: User supplied parameters48 * @cpu: CPU number to which the benchmark will be bound to49 * @bits: Number of bits used for cache allocation size50 * @benchmark_cmd: Benchmark command to run during (some of the) tests51 */52struct user_params {53 int cpu;54 int bits;55 const char *benchmark_cmd[BENCHMARK_ARGS];56};57 58/*59 * resctrl_test: resctrl test definition60 * @name: Test name61 * @group: Test group - a common name for tests that share some characteristic62 * (e.g., L3 CAT test belongs to the CAT group). Can be NULL63 * @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 disabled66 * @feature_check: Callback to check required resctrl features67 * @run_test: Callback to run the test68 * @cleanup: Callback to cleanup after the test69 */70struct 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 parameters84 * @ctrlgrp: Name of the control monitor group (con_mon grp)85 * @mongrp: Name of the monitor group (mon grp)86 * @filename: Name of file to which the o/p should be written87 * @init: Callback function to initialize test environment88 * @setup: Callback function to setup per test run environment89 * @measure: Callback that performs the measurement (a single test)90 */91struct resctrl_val_param {92 const char *ctrlgrp;93 const char *mongrp;94 char filename[64];95 unsigned long mask;96 int num_of_runs;97 int (*init)(const struct resctrl_val_param *param,98 int domain_id);99 int (*setup)(const struct resctrl_test *test,100 const struct user_params *uparams,101 struct resctrl_val_param *param);102 int (*measure)(const struct user_params *uparams,103 struct resctrl_val_param *param,104 pid_t bm_pid);105};106 107struct perf_event_read {108 __u64 nr; /* The number of events */109 struct {110 __u64 value; /* The value of the event */111 } values[2];112};113 114/*115 * Memory location that consumes values compiler must not optimize away.116 * Volatile ensures writes to this location cannot be optimized away by117 * compiler.118 */119extern volatile int *value_sink;120 121extern char llc_occup_path[1024];122 123int get_vendor(void);124bool check_resctrlfs_support(void);125int filter_dmesg(void);126int get_domain_id(const char *resource, int cpu_no, int *domain_id);127int mount_resctrlfs(void);128int umount_resctrlfs(void);129const char *get_bw_report_type(const char *bw_report);130bool resctrl_resource_exists(const char *resource);131bool resctrl_mon_feature_exists(const char *resource, const char *feature);132bool resource_info_file_exists(const char *resource, const char *file);133bool test_resource_feature_check(const struct resctrl_test *test);134char *fgrep(FILE *inf, const char *str);135int taskset_benchmark(pid_t bm_pid, int cpu_no, cpu_set_t *old_affinity);136int taskset_restore(pid_t bm_pid, cpu_set_t *old_affinity);137int write_schemata(const char *ctrlgrp, char *schemata, int cpu_no,138 const char *resource);139int write_bm_pid_to_resctrl(pid_t bm_pid, const char *ctrlgrp, const char *mongrp);140int perf_event_open(struct perf_event_attr *hw_event, pid_t pid, int cpu,141 int group_fd, unsigned long flags);142unsigned char *alloc_buffer(size_t buf_size, int memflush);143void mem_flush(unsigned char *buf, size_t buf_size);144void fill_cache_read(unsigned char *buf, size_t buf_size, bool once);145int run_fill_buf(size_t buf_size, int memflush, int op, bool once);146int initialize_mem_bw_imc(void);147int measure_mem_bw(const struct user_params *uparams,148 struct resctrl_val_param *param, pid_t bm_pid,149 const char *bw_report);150void initialize_mem_bw_resctrl(const struct resctrl_val_param *param,151 int domain_id);152int resctrl_val(const struct resctrl_test *test,153 const struct user_params *uparams,154 const char * const *benchmark_cmd,155 struct resctrl_val_param *param);156unsigned long create_bit_mask(unsigned int start, unsigned int len);157unsigned int count_contiguous_bits(unsigned long val, unsigned int *start);158int get_full_cbm(const char *cache_type, unsigned long *mask);159int get_mask_no_shareable(const char *cache_type, unsigned long *mask);160int get_cache_size(int cpu_no, const char *cache_type, unsigned long *cache_size);161int resource_info_unsigned_get(const char *resource, const char *filename, unsigned int *val);162void ctrlc_handler(int signum, siginfo_t *info, void *ptr);163int signal_handler_register(const struct resctrl_test *test);164void signal_handler_unregister(void);165unsigned int count_bits(unsigned long n);166 167void perf_event_attr_initialize(struct perf_event_attr *pea, __u64 config);168void perf_event_initialize_read_format(struct perf_event_read *pe_read);169int perf_open(struct perf_event_attr *pea, pid_t pid, int cpu_no);170int perf_event_reset_enable(int pe_fd);171int perf_event_measure(int pe_fd, struct perf_event_read *pe_read,172 const char *filename, pid_t bm_pid);173int measure_llc_resctrl(const char *filename, pid_t bm_pid);174void show_cache_info(int no_of_bits, __u64 avg_llc_val, size_t cache_span, bool lines);175 176/*177 * cache_portion_size - Calculate the size of a cache portion178 * @cache_size: Total cache size in bytes179 * @portion_mask: Cache portion mask180 * @full_cache_mask: Full Cache Bit Mask (CBM) for the cache181 *182 * Return: The size of the cache portion in bytes.183 */184static inline unsigned long cache_portion_size(unsigned long cache_size,185 unsigned long portion_mask,186 unsigned long full_cache_mask)187{188 unsigned int bits = count_bits(full_cache_mask);189 190 /*191 * With no bits the full CBM, assume cache cannot be split into192 * smaller portions. To avoid divide by zero, return cache_size.193 */194 if (!bits)195 return cache_size;196 197 return cache_size * count_bits(portion_mask) / bits;198}199 200extern struct resctrl_test mbm_test;201extern struct resctrl_test mba_test;202extern struct resctrl_test cmt_test;203extern struct resctrl_test l3_cat_test;204extern struct resctrl_test l3_noncont_cat_test;205extern struct resctrl_test l2_noncont_cat_test;206 207#endif /* RESCTRL_H */208