iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests

Browse Source 
resctrl_tests can be built or run using kselftests framework.
Add description on how to do so in README.

Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>
Reviewed-by: Fenghua Yu <fenghua.yu@intel.com>
Signed-off-by: Shaopeng Tan <tan.shaopeng@jp.fujitsu.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
This commit is contained in:
Shaopeng Tan 2022-03-23 17:12:26 +09:00 committed by Shuah Khan
parent b733143cc4
commit 42e2f21451
1 changed files with 32 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
tools/testing/selftests/resctrl/README
View File

@ -12,24 +12,49 @@ 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 And the test suit can be extended to cover AMD QoS and ARM MPAM hardware
as well. as well.
resctrl_tests can be run with or without kselftest framework.
WITH KSELFTEST FRAMEWORK
=======================
BUILD BUILD
----- -----
Run "make" to build executable file "resctrl_tests". Build executable file "resctrl_tests" from top level directory of the kernel source:
$ make -C tools/testing/selftests TARGETS=resctrl
RUN RUN
--- ---
To use resctrl_tests, root or sudoer privileges are required. This is because Run resctrl_tests as sudo or root since the test needs to mount resctrl file
the test needs to mount resctrl file system and change contents in the file system and change contents in the file system.
system. Using kselftest framework will run all supported tests within resctrl_tests:
$ sudo make -C tools/testing/selftests TARGETS=resctrl run_tests
More details about kselftest framework can be found in
Documentation/dev-tools/kselftest.rst.
WITHOUT KSELFTEST FRAMEWORK
===========================
BUILD
-----
Build executable file "resctrl_tests" from this directory(tools/testing/selftests/resctrl/):
$ make
RUN
---
Run resctrl_tests as sudo or root since the test needs to mount resctrl file
system and change contents in the file system.
Executing the test without any parameter will run all supported tests: Executing the test without any parameter will run all supported tests:
sudo ./resctrl_tests $ sudo ./resctrl_tests
OVERVIEW OF EXECUTION OVERVIEW OF EXECUTION
--------------------- =====================
A test case has four stages: A test case has four stages:
@ -41,7 +66,7 @@ A test case has four stages:
- teardown: umount resctrl and clear temporary files. - teardown: umount resctrl and clear temporary files.
ARGUMENTS ARGUMENTS
--------- =========
Parameter '-h' shows usage information. Parameter '-h' shows usage information.