linux/tools/testing/selftests/resctrl
Maciej Wieczor-Retman d6d35d0b0f selftests/resctrl: Discover SNC kernel support and adjust messages
Resctrl selftest prints a message on test failure that Sub-Numa
Clustering (SNC) could be enabled and points the user to check their BIOS
settings. No actual check is performed before printing that message so
it is not very accurate in pinpointing a problem.

When there is SNC support for kernel's resctrl subsystem and SNC is
enabled then sub node files are created for each node in the resctrlfs.
The sub node files exist in each regular node's L3 monitoring directory.
The reliable path to check for existence of sub node files is
/sys/fs/resctrl/mon_data/mon_L3_00/mon_sub_L3_00.

Add helper that checks for mon_sub_L3_00 existence.

Correct old messages to account for kernel support of SNC in
resctrl.

Signed-off-by: Maciej Wieczor-Retman <maciej.wieczor-retman@intel.com>
Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2025-01-14 17:06:32 -07:00
..
.gitignore
cache.c selftests/resctrl: Use correct type for pids 2024-07-11 11:23:53 -06:00
cat_test.c selftests:resctrl: Fix build failure on archs without __cpuid_count() 2024-09-06 10:46:03 -06:00
cmt_test.c selftests/resctrl: Discover SNC kernel support and adjust messages 2025-01-14 17:06:32 -07:00
config
fill_buf.c selftests/resctrl: Use cache size to determine "fill_buf" buffer size 2024-11-04 17:02:03 -07:00
Makefile selftests/resctrl: Adjust effective L3 cache size with SNC enabled 2025-01-14 17:06:32 -07:00
mba_test.c selftests/resctrl: Discover SNC kernel support and adjust messages 2025-01-14 17:06:32 -07:00
mbm_test.c selftests/resctrl: Discover SNC kernel support and adjust messages 2025-01-14 17:06:32 -07:00
README
resctrl.h selftests/resctrl: Discover SNC kernel support and adjust messages 2025-01-14 17:06:32 -07:00
resctrl_tests.c selftests/resctrl: Adjust effective L3 cache size with SNC enabled 2025-01-14 17:06:32 -07:00
resctrl_val.c selftests/resctrl: Ensure measurements skip initialization of default benchmark 2024-11-04 17:02:03 -07:00
resctrlfs.c selftests/resctrl: Discover SNC kernel support and adjust messages 2025-01-14 17:06:32 -07:00
settings

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.

resctrl_tests can be run with or without kselftest framework.

WITH KSELFTEST FRAMEWORK
=======================

BUILD
-----

Build executable file "resctrl_tests" from top level directory of the kernel source:
 $ make -C tools/testing/selftests TARGETS=resctrl

RUN
---

Run resctrl_tests as sudo or root since the test needs to mount resctrl file
system and change contents in the file system.
Using kselftest framework will run all supported tests within resctrl_tests:

 $ sudo make -C tools/testing/selftests TARGETS=resctrl run_tests

More details about kselftest framework can be found in
Documentation/dev-tools/kselftest.rst.

WITHOUT KSELFTEST FRAMEWORK
===========================

BUILD
-----

Build executable file "resctrl_tests" from this directory(tools/testing/selftests/resctrl/):
  $ make

RUN
---

Run resctrl_tests as sudo or root since 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