linux/tools/testing/selftests/resctrl
Shaopeng Tan 73c55fa5ab selftests/resctrl: Commonize the signal handler register/unregister for all tests
After creating a child process with fork() in CAT test, if a signal such
as SIGINT is received, the parent process will be terminated immediately,
and therefore the child process will not be killed and also resctrlfs is
not unmounted.

There is a signal handler registered in CMT/MBM/MBA tests, which kills
child process, unmount resctrlfs, cleanups result files, etc., if a
signal such as SIGINT is received.

Commonize the signal handler registered for CMT/MBM/MBA tests and
reuse it in CAT.

To reuse the signal handler to kill child process use global bm_pid
instead of local bm_pid.

Also, since the MBA/MBA/CMT/CAT are run in order, unregister the signal
handler at the end of each test so that the signal handler cannot be
inherited by other tests.

Reviewed-by: Ilpo Jarvinen <ilpo.jarvinen@linux.intel.com>
Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>
Signed-off-by: Shaopeng Tan <tan.shaopeng@jp.fujitsu.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2023-04-13 11:34:23 -06:00
..
.gitignore selftests/resctrl: Create .gitignore to include resctrl_tests 2021-04-02 13:58:42 -06:00
cache.c selftests/resctrl: Correct get_llc_perf() param in function comment 2023-04-10 12:21:16 -06:00
cat_test.c selftests/resctrl: Commonize the signal handler register/unregister for all tests 2023-04-13 11:34:23 -06:00
cmt_test.c selftests/resctrl: Use remount_resctrlfs() consistently with boolean 2023-04-10 12:21:10 -06:00
config selftests/resctrl: Add config dependencies 2021-04-02 13:57:42 -06:00
fill_buf.c selftests/resctrl: Commonize the signal handler register/unregister for all tests 2023-04-13 11:34:23 -06:00
Makefile selftests/resctrl: Add missing SPDX license to Makefile 2022-04-25 17:11:48 -06:00
mba_test.c selftests/resctrl: Return MBA check result and make it to output message 2023-04-13 11:34:05 -06:00
mbm_test.c selftests/resctrl: Fix set up schemata with 100% allocation on first run in MBM test 2023-04-13 11:33:59 -06:00
README selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests 2022-04-25 17:11:41 -06:00
resctrl.h selftests/resctrl: Commonize the signal handler register/unregister for all tests 2023-04-13 11:34:23 -06:00
resctrl_tests.c selftests/resctrl: Use correct exit code when tests fail 2023-04-13 11:33:00 -06:00
resctrl_val.c selftests/resctrl: Commonize the signal handler register/unregister for all tests 2023-04-13 11:34:23 -06:00
resctrlfs.c selftests/resctrl: Flush stdout file buffer before executing fork() 2023-04-13 11:34:12 -06:00
settings selftests/resctrl: Change the default limited time to 120 seconds 2022-04-25 17:06:53 -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.

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