1 resctrl_tests - resctrl file system test suit 1 resctrl_tests - resctrl file system test suit
2 2
3 Authors: 3 Authors:
4 Fenghua Yu <fenghua.yu@intel.com> 4 Fenghua Yu <fenghua.yu@intel.com>
5 Sai Praneeth Prakhya <sai.praneeth.prak 5 Sai Praneeth Prakhya <sai.praneeth.prakhya@intel.com>,
6 6
7 resctrl_tests tests various resctrl functional 7 resctrl_tests tests various resctrl functionalities and interfaces including
8 both software and hardware. 8 both software and hardware.
9 9
10 Currently it supports Memory Bandwidth Monitor 10 Currently it supports Memory Bandwidth Monitoring test and Memory Bandwidth
11 Allocation test on Intel RDT hardware. More te 11 Allocation test on Intel RDT hardware. More tests will be added in the future.
12 And the test suit can be extended to cover AMD 12 And the test suit can be extended to cover AMD QoS and ARM MPAM hardware
13 as well. 13 as well.
14 14
15 resctrl_tests can be run with or without kself 15 resctrl_tests can be run with or without kselftest framework.
16 16
17 WITH KSELFTEST FRAMEWORK 17 WITH KSELFTEST FRAMEWORK
18 ======================= 18 =======================
19 19
20 BUILD 20 BUILD
21 ----- 21 -----
22 22
23 Build executable file "resctrl_tests" from top 23 Build executable file "resctrl_tests" from top level directory of the kernel source:
24 $ make -C tools/testing/selftests TARGETS=res 24 $ make -C tools/testing/selftests TARGETS=resctrl
25 25
26 RUN 26 RUN
27 --- 27 ---
28 28
29 Run resctrl_tests as sudo or root since the te 29 Run resctrl_tests as sudo or root since the test needs to mount resctrl file
30 system and change contents in the file system. 30 system and change contents in the file system.
31 Using kselftest framework will run all support 31 Using kselftest framework will run all supported tests within resctrl_tests:
32 32
33 $ sudo make -C tools/testing/selftests TARGET 33 $ sudo make -C tools/testing/selftests TARGETS=resctrl run_tests
34 34
35 More details about kselftest framework can be 35 More details about kselftest framework can be found in
36 Documentation/dev-tools/kselftest.rst. 36 Documentation/dev-tools/kselftest.rst.
37 37
38 WITHOUT KSELFTEST FRAMEWORK 38 WITHOUT KSELFTEST FRAMEWORK
39 =========================== 39 ===========================
40 40
41 BUILD 41 BUILD
42 ----- 42 -----
43 43
44 Build executable file "resctrl_tests" from thi 44 Build executable file "resctrl_tests" from this directory(tools/testing/selftests/resctrl/):
45 $ make 45 $ make
46 46
47 RUN 47 RUN
48 --- 48 ---
49 49
50 Run resctrl_tests as sudo or root since the te 50 Run resctrl_tests as sudo or root since the test needs to mount resctrl file
51 system and change contents in the file system. 51 system and change contents in the file system.
52 Executing the test without any parameter will 52 Executing the test without any parameter will run all supported tests:
53 53
54 $ sudo ./resctrl_tests 54 $ sudo ./resctrl_tests
55 55
56 OVERVIEW OF EXECUTION 56 OVERVIEW OF EXECUTION
57 ===================== 57 =====================
58 58
59 A test case has four stages: 59 A test case has four stages:
60 60
61 - setup: mount resctrl file system, create g 61 - setup: mount resctrl file system, create group, setup schemata, move test
62 process pids to tasks, start benchmark. 62 process pids to tasks, start benchmark.
63 - execute: let benchmark run 63 - execute: let benchmark run
64 - verify: get resctrl data and verify the da 64 - verify: get resctrl data and verify the data with another source, e.g.
65 perf event. 65 perf event.
66 - teardown: umount resctrl and clear tempora 66 - teardown: umount resctrl and clear temporary files.
67 67
68 ARGUMENTS 68 ARGUMENTS
69 ========= 69 =========
70 70
71 Parameter '-h' shows usage information. 71 Parameter '-h' shows usage information.
72 72
73 usage: resctrl_tests [-h] [-b "benchmark_cmd [ 73 usage: resctrl_tests [-h] [-b "benchmark_cmd [options]"] [-t test list] [-n no_of_bits]
74 -b benchmark_cmd [options]: run specif 74 -b benchmark_cmd [options]: run specified benchmark for MBM, MBA and CMT default benchmark is builtin fill_buf
75 -t test list: run tests specified in t 75 -t test list: run tests specified in the test list, e.g. -t mbm,mba,cmt,cat
76 -n no_of_bits: run cache tests using s 76 -n no_of_bits: run cache tests using specified no of bits in cache bit mask
77 -p cpu_no: specify CPU number to run t 77 -p cpu_no: specify CPU number to run the test. 1 is default
78 -h: help 78 -h: help
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.