linux-stable/tools/testing/selftests/resctrl
Colin Ian King c7b607fa93 selftests/resctrl: Fix null pointer dereference on open failed
Currently if opening /dev/null fails to open then file pointer fp
is null and further access to fp via fprintf will cause a null
pointer dereference. Fix this by returning a negative error value
when a null fp is detected.

Detected using cppcheck static analysis:
tools/testing/selftests/resctrl/fill_buf.c:124:6: note: Assuming
that condition '!fp' is not redundant
 if (!fp)
     ^
tools/testing/selftests/resctrl/fill_buf.c:126:10: note: Null
pointer dereference
 fprintf(fp, "Sum: %d ", ret);

Fixes: a2561b12fe ("selftests/resctrl: Add built in benchmark")
Signed-off-by: Colin Ian King <colin.i.king@gmail.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2022-04-26 09:20:00 -06:00
..
.gitignore selftests/resctrl: Create .gitignore to include resctrl_tests 2021-04-02 13:58:42 -06:00
Makefile selftests/resctrl: Add missing SPDX license to Makefile 2022-04-25 17:11:48 -06:00
README selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests 2022-04-25 17:11:41 -06:00
cache.c selftests/resctrl: Change a few printed messages 2021-04-07 16:37:49 -06:00
cat_test.c selftests/resctrl: Extend CPU vendor detection 2022-04-25 16:57:50 -06:00
cmt_test.c selftests/resctrl: Share show_cache_info() by CAT and CMT tests 2021-04-02 13:54:14 -06:00
config selftests/resctrl: Add config dependencies 2021-04-02 13:57:42 -06:00
fill_buf.c selftests/resctrl: Fix null pointer dereference on open failed 2022-04-26 09:20:00 -06:00
mba_test.c selftests/resctrl: Change a few printed messages 2021-04-07 16:37:49 -06:00
mbm_test.c selftests/resctrl: Change a few printed messages 2021-04-07 16:37:49 -06:00
resctrl.h selftests/resctrl: Extend CPU vendor detection 2022-04-25 16:57:50 -06:00
resctrl_tests.c selftests/resctrl: Fix resctrl_tests' return code to work with selftest framework 2022-04-25 17:10:21 -06:00
resctrl_val.c selftests/resctrl: Kill child process before parent process terminates if SIGTERM is received 2022-04-25 17:06:41 -06:00
resctrlfs.c selftests/resctrl: Extend CPU vendor detection 2022-04-25 16:57:50 -06:00
settings selftests/resctrl: Change the default limited time to 120 seconds 2022-04-25 17:06:53 -06:00

README

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