linux/tools/testing/selftests/resctrl/README
<<
>>
Prefs
   1resctrl_tests - resctrl file system test suit
   2
   3Authors:
   4        Fenghua Yu <fenghua.yu@intel.com>
   5        Sai Praneeth Prakhya <sai.praneeth.prakhya@intel.com>,
   6
   7resctrl_tests tests various resctrl functionalities and interfaces including
   8both software and hardware.
   9
  10Currently it supports Memory Bandwidth Monitoring test and Memory Bandwidth
  11Allocation test on Intel RDT hardware. More tests will be added in the future.
  12And the test suit can be extended to cover AMD QoS and ARM MPAM hardware
  13as well.
  14
  15BUILD
  16-----
  17
  18Run "make" to build executable file "resctrl_tests".
  19
  20RUN
  21---
  22
  23To use resctrl_tests, root or sudoer privileges are required. This is because
  24the test needs to mount resctrl file system and change contents in the file
  25system.
  26
  27Executing the test without any parameter will run all supported tests:
  28
  29        sudo ./resctrl_tests
  30
  31OVERVIEW OF EXECUTION
  32---------------------
  33
  34A test case has four stages:
  35
  36  - setup: mount resctrl file system, create group, setup schemata, move test
  37    process pids to tasks, start benchmark.
  38  - execute: let benchmark run
  39  - verify: get resctrl data and verify the data with another source, e.g.
  40    perf event.
  41  - teardown: umount resctrl and clear temporary files.
  42
  43ARGUMENTS
  44---------
  45
  46Parameter '-h' shows usage information.
  47
  48usage: resctrl_tests [-h] [-b "benchmark_cmd [options]"] [-t test list] [-n no_of_bits]
  49        -b benchmark_cmd [options]: run specified benchmark for MBM, MBA and CMT default benchmark is builtin fill_buf
  50        -t test list: run tests specified in the test list, e.g. -t mbm,mba,cmt,cat
  51        -n no_of_bits: run cache tests using specified no of bits in cache bit mask
  52        -p cpu_no: specify CPU number to run the test. 1 is default
  53        -h: help
  54