linux/tools/testing/selftests/resctrl
Fenghua Yu 2f320911d9 selftests/resctrl: Rename CQM test as CMT test
CMT (Cache Monitoring Technology) [1] is a H/W feature that reports cache
occupancy of a process. resctrl selftest suite has a unit test to test CMT
for LLC but the test is named as CQM (Cache Quality Monitoring).
Furthermore, the unit test source file is named as cqm_test.c and several
functions, variables, comments, preprocessors and statements widely use
"cqm" as either suffix or prefix. This rampant misusage of CQM for CMT
might confuse someone who is newly looking at resctrl selftests because
this feature is named CMT in the Intel Software Developer's Manual.

Hence, rename all the occurrences (unit test source file name, functions,
variables, comments and preprocessors) of cqm with cmt.

[1] Please see Intel SDM, Volume 3, chapter 17 and section 18 for more
    information on CMT: https://software.intel.com/content/www/us/en/develop/articles/intel-sdm.html

Suggested-by: Reinette Chatre <reinette.chatre@intel.com>
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:54 -06:00
..
cache.c selftests/resctrl: Rename CQM test as CMT test 2021-04-02 13:53:54 -06:00
cat_test.c selftests/resctrl: Clean up resctrl features check 2021-04-02 13:51:36 -06:00
cmt_test.c selftests/resctrl: Rename CQM test as CMT test 2021-04-02 13:53:54 -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 selftests/resctrl: Rename CQM test as CMT test 2021-04-02 13:53:54 -06:00
resctrl_tests.c selftests/resctrl: Rename CQM test as CMT test 2021-04-02 13:53:54 -06:00
resctrl_val.c selftests/resctrl: Rename CQM test as CMT test 2021-04-02 13:53:54 -06:00
resctrl.h selftests/resctrl: Rename CQM test as CMT test 2021-04-02 13:53:54 -06:00
resctrlfs.c selftests/resctrl: Rename CQM test as CMT test 2021-04-02 13:53:54 -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 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