OpenCloudOS-Kernel/tools/testing/selftests/resctrl
Xiaochen Shen 1421ec684a selftests/resctrl: Fix incorrect parsing of option "-t"
Resctrl test suite accepts command line argument "-t" to specify the
unit tests to run in the test list (e.g., -t mbm,mba,cmt,cat) as
documented in the help.

When calling strtok() to parse the option, the incorrect delimiters
argument ":\t" is used. As a result, passing "-t mbm,mba,cmt,cat" throws
an invalid option error.

Fix this by using delimiters argument "," instead of ":\t" for parsing
of unit tests list. At the same time, remove the unnecessary "spaces"
between the unit tests in help documentation to prevent confusion.

Fixes: 790bf585b0 ("selftests/resctrl: Add Cache Allocation Technology (CAT) selftest")
Fixes: 78941183d1 ("selftests/resctrl: Add Cache QoS Monitoring (CQM) selftest")
Fixes: ecdbb911f2 ("selftests/resctrl: Add MBM test")
Fixes: 034c7678dd ("selftests/resctrl: Add README for resctrl tests")
Cc: stable@vger.kernel.org
Signed-off-by: Xiaochen Shen <xiaochen.shen@intel.com>
Reviewed-by: Tony Luck <tony.luck@intel.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2021-06-07 18:38:58 -06:00
..
.gitignore selftests/resctrl: Create .gitignore to include resctrl_tests 2021-04-02 13:58:42 -06:00
Makefile selftests/resctrl: Enable gcc checks to detect buffer overflows 2021-04-02 13:51:16 -06:00
README selftests/resctrl: Fix incorrect parsing of option "-t" 2021-06-07 18:38:58 -06:00
cache.c selftests/resctrl: Change a few printed messages 2021-04-07 16:37:49 -06:00
cat_test.c selftests/resctrl: Skip the test if requested resctrl feature is not supported 2021-04-02 13:58:20 -06:00
cmt_test.c selftests/resctrl: Share show_cache_info() by CAT and CMT tests 2021-04-02 13:54:14 -06:00
config selftests/resctrl: Add config dependencies 2021-04-02 13:57:42 -06:00
fill_buf.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
mba_test.c selftests/resctrl: Change a few printed messages 2021-04-07 16:37:49 -06:00
mbm_test.c selftests/resctrl: Change a few printed messages 2021-04-07 16:37:49 -06:00
resctrl.h selftests/resctrl: Use resctrl/info for feature detection 2021-04-02 13:57:57 -06:00
resctrl_tests.c selftests/resctrl: Fix incorrect parsing of option "-t" 2021-06-07 18:38:58 -06:00
resctrl_val.c selftests/resctrl: Fix checking for < 0 for unsigned values 2021-04-02 13:58:37 -06:00
resctrlfs.c selftests/resctrl: Change a few printed messages 2021-04-07 16:37:49 -06:00

README

resctrl_tests - resctrl file system test suit

Authors:
	Fenghua Yu <fenghua.yu@intel.com>
	Sai Praneeth Prakhya <sai.praneeth.prakhya@intel.com>,

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.

BUILD
-----

Run "make" to build executable file "resctrl_tests".

RUN
---

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
system.

Executing the test without any parameter will run all supported tests:

	sudo ./resctrl_tests

OVERVIEW OF EXECUTION
---------------------

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.

ARGUMENTS
---------

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 CMT default benchmark is builtin fill_buf
        -t test list: run tests specified in the test list, e.g. -t mbm,mba,cmt,cat
        -n no_of_bits: run cache tests using specified no of bits in cache bit mask
        -p cpu_no: specify CPU number to run the test. 1 is default
        -h: help