linux/tools/testing/selftests/resctrl
Shuah Khan 7beaf1da07 selftests:resctrl: Fix build failure on archs without __cpuid_count()
When resctrl is built on architectures without __cpuid_count()
support, build fails. resctrl uses __cpuid_count() defined in
kselftest.h.

Even though the problem is seen while building resctrl on aarch64,
this error can be seen on any platform that doesn't support CPUID.

CPUID is a x86/x86-64 feature and code paths with CPUID asm commands
will fail to build on all other architectures.

All others tests call __cpuid_count() do so from x86/x86_64 code paths
when _i386__ or __x86_64__ are defined. resctrl is an exception.

Fix the problem by defining __cpuid_count() only when __i386__ or
__x86_64__ are defined in kselftest.h and changing resctrl to call
__cpuid_count() only when __i386__ or __x86_64__ are defined.

In file included from resctrl.h:24,
                 from cat_test.c:11:
In function ‘arch_supports_noncont_cat’,
    inlined from ‘noncont_cat_run_test’ at cat_test.c:326:6:
../kselftest.h:74:9: error: impossible constraint in ‘asm’
   74 |         __asm__ __volatile__ ("cpuid\n\t"                               \
      |         ^~~~~~~
cat_test.c:304:17: note: in expansion of macro ‘__cpuid_count’
  304 |                 __cpuid_count(0x10, 1, eax, ebx, ecx, edx);
      |                 ^~~~~~~~~~~~~
../kselftest.h:74:9: error: impossible constraint in ‘asm’
   74 |         __asm__ __volatile__ ("cpuid\n\t"                               \
      |         ^~~~~~~
cat_test.c:306:17: note: in expansion of macro ‘__cpuid_count’
  306 |                 __cpuid_count(0x10, 2, eax, ebx, ecx, edx);

Fixes: ae638551ab ("selftests/resctrl: Add non-contiguous CBMs CAT test")
Reported-by: Muhammad Usama Anjum <usama.anjum@collabora.com>
Closes: https://lore.kernel.org/lkml/20240809071059.265914-1-usama.anjum@collabora.com/
Reported-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Acked-by: Reinette Chatre <reinette.chatre@intel.com>
Reviewed-by: Muhammad Usama Anjum <usama.anjum@collabora.com>
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2024-09-06 10:46:03 -06:00
..
.gitignore selftests/resctrl: Create .gitignore to include resctrl_tests 2021-04-02 13:58:42 -06:00
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: Remove test name comparing from write_bm_pid_to_resctrl() 2024-07-11 11:23:54 -06:00
config selftests/resctrl: Add config dependencies 2021-04-02 13:57:42 -06:00
fill_buf.c selftests/resctrl: Rewrite Cache Allocation Technology (CAT) test 2024-02-13 13:56:45 -07:00
Makefile selftests: centralize -D_GNU_SOURCE= to CFLAGS in lib.mk 2024-07-10 12:14:51 -07:00
mba_test.c selftests/resctrl: Remove test name comparing from write_bm_pid_to_resctrl() 2024-07-11 11:23:54 -06:00
mbm_test.c selftests/resctrl: Remove test name comparing from write_bm_pid_to_resctrl() 2024-07-11 11:23:54 -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_tests.c selftests/resctrl: ksft_exit_skip() does not return 2024-05-06 13:57:20 -06:00
resctrl_val.c selftests/resctrl: Remove test name comparing from write_bm_pid_to_resctrl() 2024-07-11 11:23:54 -06:00
resctrl.h selftests/resctrl: Remove test name comparing from write_bm_pid_to_resctrl() 2024-07-11 11:23:54 -06:00
resctrlfs.c selftests/resctrl: Remove test name comparing from write_bm_pid_to_resctrl() 2024-07-11 11:23:54 -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