[PATCH v4 01/10] selftests/resctrl: Add README for resctrl tests

From: Fenghua Yu
Date: Fri Dec 21 2018 - 19:26:59 EST

resctrl tests will be implemented. README is added for the tool first.

Signed-off-by: Fenghua Yu <fenghua.yu@xxxxxxxxx>
tools/testing/selftests/resctrl/README | 53 ++++++++++++++++++++++++++
1 file changed, 53 insertions(+)
create mode 100644 tools/testing/selftests/resctrl/README

diff --git a/tools/testing/selftests/resctrl/README b/tools/testing/selftests/resctrl/README
new file mode 100644
index 000000000000..f9621d6146df
--- /dev/null
+++ b/tools/testing/selftests/resctrl/README
@@ -0,0 +1,53 @@
+resctrl_tests - resctrl file system test suit
+ Fenghua Yu <fenghua.yu@xxxxxxxxx>
+ Sai Praneeth Prakhya <sai.praneeth.prakhya@xxxxxxxxx>,
+ Arshiya Hayatkhan Pathan <arshiya.hayatkhan.pathan@xxxxxxxxx>
+resctrl_tests tests various resctrl functionalities and interfaces including
+both software and hardware.
+Currently it supports Memory Bandwidth Monitoring test and Memory Bandwidth
+Allocation test on Intel RDT hardware. More tests will be added in the future.
+And the test suit can be extended to cover AMD QoS and ARM MPAM hardware
+as well.
+Run "make" to build executable file "resctrl_tests".
+To use resctrl_tests, root or sudoer privileges are required. This is because
+the test needs to mount resctrl file system and change contents in the file
+Executing the test without any parameter will run all supported tests:
+ sudo ./resctrl_tests
+A test case has four stages:
+ - setup: mount resctrl file system, create group, setup schemata, move test
+ process pids to tasks, start benchmark.
+ - execute: let benchmark run
+ - verify: get resctrl data and verify the data with another source, e.g.
+ perf event.
+ - teardown: umount resctrl and clear temporary files.
+Parameter '-h' shows usage information.
+usage: resctrl_tests [-h] [-b "benchmark_cmd [options]"] [-t test list] [-n no_of_bits]
+ -b benchmark_cmd [options]: run specified benchmark for MBM, MBA and CQM default benchmark is builtin fill_buf
+ -t test list: run tests specified in the test list, e.g. -t mbm, mba, cqm, cat
+ -n no_of_bits: run cache tests using specified no of bits in cache bit mask
+ -h: help