Skip to content

Commit 034c767

Browse files
Fenghua Yushuahkh
authored andcommitted
selftests/resctrl: Add README for resctrl tests
resctrl tests will be implemented. README is added for the tool first. Co-developed-by: Babu Moger <babu.moger@amd.com> Signed-off-by: Babu Moger <babu.moger@amd.com> Signed-off-by: Fenghua Yu <fenghua.yu@intel.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
1 parent bb6d3fb commit 034c767

File tree

1 file changed

+53
-0
lines changed
  • tools/testing/selftests/resctrl

1 file changed

+53
-0
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
resctrl_tests - resctrl file system test suit
2+
3+
Authors:
4+
Fenghua Yu <fenghua.yu@intel.com>
5+
Sai Praneeth Prakhya <sai.praneeth.prakhya@intel.com>,
6+
7+
resctrl_tests tests various resctrl functionalities and interfaces including
8+
both software and hardware.
9+
10+
Currently it supports Memory Bandwidth Monitoring test and Memory Bandwidth
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 QoS and ARM MPAM hardware
13+
as well.
14+
15+
BUILD
16+
-----
17+
18+
Run "make" to build executable file "resctrl_tests".
19+
20+
RUN
21+
---
22+
23+
To use resctrl_tests, root or sudoer privileges are required. This is because
24+
the test needs to mount resctrl file system and change contents in the file
25+
system.
26+
27+
Executing the test without any parameter will run all supported tests:
28+
29+
sudo ./resctrl_tests
30+
31+
OVERVIEW OF EXECUTION
32+
---------------------
33+
34+
A test case has four stages:
35+
36+
- setup: mount resctrl file system, create group, setup schemata, move test
37+
process pids to tasks, start benchmark.
38+
- execute: let benchmark run
39+
- verify: get resctrl data and verify the data with another source, e.g.
40+
perf event.
41+
- teardown: umount resctrl and clear temporary files.
42+
43+
ARGUMENTS
44+
---------
45+
46+
Parameter '-h' shows usage information.
47+
48+
usage: resctrl_tests [-h] [-b "benchmark_cmd [options]"] [-t test list] [-n no_of_bits]
49+
-b benchmark_cmd [options]: run specified benchmark for MBM, MBA and CQM default benchmark is builtin fill_buf
50+
-t test list: run tests specified in the test list, e.g. -t mbm, mba, cqm, cat
51+
-n no_of_bits: run cache tests using specified no of bits in cache bit mask
52+
-p cpu_no: specify CPU number to run the test. 1 is default
53+
-h: help

0 commit comments

Comments
 (0)