From: Fenghua Yu <fenghua.yu@intel.com>
To: "Thomas Gleixner" <tglx@linutronix.de>,
"Ingo Molnar" <mingo@redhat.com>,
"Borislav Petkov" <bp@alien8.de>, "H Peter Anvin" <hpa@zytor.com>,
"Tony Luck" <tony.luck@intel.com>,
"Reinette Chatre" <reinette.chatre@intel.com>,
"Babu Moger" <babu.moger@amd.com>,
"Andre Przywara" <Andre.Przywara@arm.com>,
"Sai Praneeth Prakhya" <sai.praneeth.prakhya@intel.com>,
"Ravi V Shankar" <ravi.v.shankar@intel.com>
Cc: "linux-kernel" <linux-kernel@vger.kernel.org>,
"x86" <x86@kernel.org>, Fenghua Yu <fenghua.yu@intel.com>
Subject: [PATCH v8 01/13] selftests/resctrl: Add README for resctrl tests
Date: Wed, 27 Nov 2019 16:39:32 -0800 [thread overview]
Message-ID: <1574901584-212957-2-git-send-email-fenghua.yu@intel.com> (raw)
In-Reply-To: <1574901584-212957-1-git-send-email-fenghua.yu@intel.com>
resctrl tests will be implemented. README is added for the tool first.
Signed-off-by: Babu Moger <babu.moger@amd.com>
Signed-off-by: Fenghua Yu <fenghua.yu@intel.com>
---
tools/testing/selftests/resctrl/README | 53 ++++++++++++++++++++++++++
1 file changed, 53 insertions(+)
create mode 100644 tools/testing/selftests/resctrl/README
diff --git a/tools/testing/selftests/resctrl/README b/tools/testing/selftests/resctrl/README
new file mode 100644
index 000000000000..6e5a0ffa18e8
--- /dev/null
+++ b/tools/testing/selftests/resctrl/README
@@ -0,0 +1,53 @@
+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.
+
+BUILD
+-----
+
+Run "make" to build executable file "resctrl_tests".
+
+RUN
+---
+
+To use resctrl_tests, root or sudoer privileges are required. This is because
+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 CQM default benchmark is builtin fill_buf
+ -t test list: run tests specified in the test list, e.g. -t mbm, mba, cqm, 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
--
2.19.1
next prev parent reply other threads:[~2019-11-28 1:43 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-28 0:39 [PATCH v8 00/13] selftests/resctrl: Add resctrl selftest Fenghua Yu
2019-11-28 0:39 ` Fenghua Yu [this message]
2019-11-28 7:23 ` [PATCH v8 01/13] selftests/resctrl: Add README for resctrl tests Borislav Petkov
2019-12-02 18:53 ` Fenghua Yu
2019-12-02 23:06 ` Borislav Petkov
2019-12-02 23:42 ` Fenghua Yu
2019-12-02 23:49 ` Borislav Petkov
2019-12-03 0:04 ` Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 02/13] selftests/resctrl: Add basic resctrl file system operations and data Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 03/13] selftests/resctrl: Read memory bandwidth from perf IMC counter and from resctrl file system Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 04/13] selftests/resctrl: Add callback to start a benchmark Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 05/13] selftests/resctrl: Add built in benchmark Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 06/13] selftests/resctrl: Add MBM test Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 07/13] selftests/resctrl: Add MBA test Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 08/13] selftests/resctrl: Add Cache QoS Monitoring (CQM) selftest Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 09/13] selftests/resctrl: Add Cache Allocation Technology (CAT) selftest Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 10/13] selftests/resctrl: Add vendor detection mechanism Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 11/13] selftests/resctrl: Use cache index3 id for AMD schemata masks Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 12/13] selftests/resctrl: Disable MBA and MBM tests for AMD Fenghua Yu
2019-11-28 0:39 ` [PATCH v8 13/13] selftests/resctrl: Add the test in MAINTAINERS Fenghua Yu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1574901584-212957-2-git-send-email-fenghua.yu@intel.com \
--to=fenghua.yu@intel.com \
--cc=Andre.Przywara@arm.com \
--cc=babu.moger@amd.com \
--cc=bp@alien8.de \
--cc=hpa@zytor.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=ravi.v.shankar@intel.com \
--cc=reinette.chatre@intel.com \
--cc=sai.praneeth.prakhya@intel.com \
--cc=tglx@linutronix.de \
--cc=tony.luck@intel.com \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).