1 /* SPDX-License-Identifier: GPL-2.0 */
2 #define _GNU_SOURCE
3 #ifndef RESCTRL_H
4 #define RESCTRL_H
5 #include <stdio.h>
6 #include <stdarg.h>
7 #include <math.h>
8 #include <errno.h>
9 #include <sched.h>
10 #include <stdlib.h>
11 #include <unistd.h>
12 #include <string.h>
13 #include <signal.h>
14 #include <dirent.h>
15 #include <stdbool.h>
16 #include <sys/stat.h>
17 #include <sys/ioctl.h>
18 #include <sys/mount.h>
19 #include <sys/types.h>
20 #include <sys/wait.h>
21 #include <sys/select.h>
22 #include <sys/time.h>
23 #include <sys/eventfd.h>
24 #include <asm/unistd.h>
25 #include <linux/perf_event.h>
26 #include "../kselftest.h"
27 
28 #define MB			(1024 * 1024)
29 #define RESCTRL_PATH		"/sys/fs/resctrl"
30 #define PHYS_ID_PATH		"/sys/devices/system/cpu/cpu"
31 #define INFO_PATH		"/sys/fs/resctrl/info"
32 #define L3_PATH			"/sys/fs/resctrl/info/L3"
33 #define MB_PATH			"/sys/fs/resctrl/info/MB"
34 #define L3_MON_PATH		"/sys/fs/resctrl/info/L3_MON"
35 #define L3_MON_FEATURES_PATH	"/sys/fs/resctrl/info/L3_MON/mon_features"
36 
37 #define ARCH_INTEL     1
38 #define ARCH_AMD       2
39 
40 #define END_OF_TESTS	1
41 
42 #define PARENT_EXIT(err_msg)			\
43 	do {					\
44 		perror(err_msg);		\
45 		kill(ppid, SIGKILL);		\
46 		exit(EXIT_FAILURE);		\
47 	} while (0)
48 
49 /*
50  * resctrl_val_param:	resctrl test parameters
51  * @resctrl_val:	Resctrl feature (Eg: mbm, mba.. etc)
52  * @ctrlgrp:		Name of the control monitor group (con_mon grp)
53  * @mongrp:		Name of the monitor group (mon grp)
54  * @cpu_no:		CPU number to which the benchmark would be binded
55  * @span:		Memory bytes accessed in each benchmark iteration
56  * @mum_resctrlfs:	Should the resctrl FS be remounted?
57  * @filename:		Name of file to which the o/p should be written
58  * @bw_report:		Bandwidth report type (reads vs writes)
59  * @setup:		Call back function to setup test environment
60  */
61 struct resctrl_val_param {
62 	char		*resctrl_val;
63 	char		ctrlgrp[64];
64 	char		mongrp[64];
65 	int		cpu_no;
66 	unsigned long	span;
67 	bool		mum_resctrlfs;
68 	char		filename[64];
69 	char		*bw_report;
70 	unsigned long	mask;
71 	int		num_of_runs;
72 	int		(*setup)(int num, ...);
73 };
74 
75 #define MBM_STR			"mbm"
76 #define MBA_STR			"mba"
77 #define CMT_STR			"cmt"
78 #define CAT_STR			"cat"
79 
80 extern pid_t bm_pid, ppid;
81 
82 extern char llc_occup_path[1024];
83 
84 int get_vendor(void);
85 bool check_resctrlfs_support(void);
86 int filter_dmesg(void);
87 int remount_resctrlfs(bool mum_resctrlfs);
88 int get_resource_id(int cpu_no, int *resource_id);
89 int umount_resctrlfs(void);
90 int validate_bw_report_request(char *bw_report);
91 bool validate_resctrl_feature_request(const char *resctrl_val);
92 char *fgrep(FILE *inf, const char *str);
93 int taskset_benchmark(pid_t bm_pid, int cpu_no);
94 void run_benchmark(int signum, siginfo_t *info, void *ucontext);
95 int write_schemata(char *ctrlgrp, char *schemata, int cpu_no,
96 		   char *resctrl_val);
97 int write_bm_pid_to_resctrl(pid_t bm_pid, char *ctrlgrp, char *mongrp,
98 			    char *resctrl_val);
99 int perf_event_open(struct perf_event_attr *hw_event, pid_t pid, int cpu,
100 		    int group_fd, unsigned long flags);
101 int run_fill_buf(unsigned long span, int malloc_and_init_memory, int memflush,
102 		 int op, char *resctrl_va);
103 int resctrl_val(char **benchmark_cmd, struct resctrl_val_param *param);
104 int mbm_bw_change(int span, int cpu_no, char *bw_report, char **benchmark_cmd);
105 void tests_cleanup(void);
106 void mbm_test_cleanup(void);
107 int mba_schemata_change(int cpu_no, char *bw_report, char **benchmark_cmd);
108 void mba_test_cleanup(void);
109 int get_cbm_mask(char *cache_type, char *cbm_mask);
110 int get_cache_size(int cpu_no, char *cache_type, unsigned long *cache_size);
111 void ctrlc_handler(int signum, siginfo_t *info, void *ptr);
112 int signal_handler_register(void);
113 void signal_handler_unregister(void);
114 int cat_val(struct resctrl_val_param *param);
115 void cat_test_cleanup(void);
116 int cat_perf_miss_val(int cpu_no, int no_of_bits, char *cache_type);
117 int cmt_resctrl_val(int cpu_no, int n, char **benchmark_cmd);
118 unsigned int count_bits(unsigned long n);
119 void cmt_test_cleanup(void);
120 int get_core_sibling(int cpu_no);
121 int measure_cache_vals(struct resctrl_val_param *param, int bm_pid);
122 int show_cache_info(unsigned long sum_llc_val, int no_of_bits,
123 		    unsigned long cache_span, unsigned long max_diff,
124 		    unsigned long max_diff_percent, unsigned long num_of_runs,
125 		    bool platform, bool cmt);
126 
127 #endif /* RESCTRL_H */
128