linux/tools/testing/selftests/resctrl
Fenghua Yu d7af3d0d51 selftests/resctrl: Fix missing options "-n" and "-p"
resctrl test suite accepts command line arguments (like -b, -t, -n and -p)
as documented in the help. But passing -n and -p throws an invalid option
error. This happens because -n and -p are missing in the list of
characters that getopt() recognizes as valid arguments. Hence, they are
treated as invalid options.

Fix this by adding them to the list of characters that getopt() recognizes
as valid arguments. Please note that the main() function already has the
logic to deal with the values passed as part of these arguments and hence
no changes are needed there.

Tested-by: Babu Moger <babu.moger@amd.com>
Signed-off-by: Fenghua Yu <fenghua.yu@intel.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2021-04-02 13:53:02 -06:00
..
cache.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
cat_test.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
cqm_test.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
fill_buf.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
Makefile selftests/resctrl: Enable gcc checks to detect buffer overflows 2021-04-02 13:51:16 -06:00
mba_test.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
mbm_test.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
README
resctrl_tests.c selftests/resctrl: Fix missing options "-n" and "-p" 2021-04-02 13:53:02 -06:00
resctrl_val.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
resctrl.h selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
resctrlfs.c selftests/resctrl: Ensure sibling CPU is not same as original CPU 2021-04-02 13:51:43 -06:00

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 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
        -p cpu_no: specify CPU number to run the test. 1 is default
        -h: help