linux-stable/tools/testing/selftests/resctrl
Fenghua Yu 790bf585b0 selftests/resctrl: Add Cache Allocation Technology (CAT) selftest
Cache Allocation Technology (CAT) selftest allocates a portion of
last level cache and starts a benchmark to read each cache
line in this portion of cache. Measure the cache misses in perf and
the misses should be equal to the number of cache lines in this
portion of cache.

We don't use CQM to calculate cache usage because some CAT enabled
platforms don't have CQM.

Co-developed-by: Sai Praneeth Prakhya <sai.praneeth.prakhya@intel.com>
Signed-off-by: Sai Praneeth Prakhya <sai.praneeth.prakhya@intel.com>
Co-developed-by: Babu Moger <babu.moger@amd.com>
Signed-off-by: Babu Moger <babu.moger@amd.com>
Signed-off-by: Fenghua Yu <fenghua.yu@intel.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2020-02-10 18:43:07 -07:00
..
cache.c selftests/resctrl: Add Cache Allocation Technology (CAT) selftest 2020-02-10 18:43:07 -07:00
cat_test.c selftests/resctrl: Add Cache Allocation Technology (CAT) selftest 2020-02-10 18:43:07 -07:00
cqm_test.c selftests/resctrl: Add Cache QoS Monitoring (CQM) selftest 2020-02-10 18:42:57 -07:00
fill_buf.c selftests/resctrl: Add Cache Allocation Technology (CAT) selftest 2020-02-10 18:43:07 -07:00
Makefile selftests/resctrl: Add MBM test 2020-02-10 18:42:29 -07:00
mba_test.c selftests/resctrl: Add MBA test 2020-02-10 18:42:46 -07:00
mbm_test.c selftests/resctrl: Add MBM test 2020-02-10 18:42:29 -07:00
README
resctrl.h selftests/resctrl: Add Cache Allocation Technology (CAT) selftest 2020-02-10 18:43:07 -07:00
resctrl_tests.c selftests/resctrl: Add Cache Allocation Technology (CAT) selftest 2020-02-10 18:43:07 -07:00
resctrl_val.c selftests/resctrl: Add Cache QoS Monitoring (CQM) selftest 2020-02-10 18:42:57 -07:00
resctrlfs.c selftests/resctrl: Add Cache Allocation Technology (CAT) selftest 2020-02-10 18:43:07 -07: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