From: "Moger, Babu" <Babu.Moger@amd.com>
To: "fenghua.yu@intel.com" <fenghua.yu@intel.com>,
"tglx@linutronix.de" <tglx@linutronix.de>,
"mingo@redhat.com" <mingo@redhat.com>,
"hpa@zytor.com" <hpa@zytor.com>,
"tony.luck@intel.com" <tony.luck@intel.com>,
"peterz@infradead.org" <peterz@infradead.org>,
"reinette.chatre@intel.com" <reinette.chatre@intel.com>,
"Moger, Babu" <Babu.Moger@amd.com>,
"james.morse@arm.com" <james.morse@arm.com>,
"xiaochen.shen@intel.com" <xiaochen.shen@intel.com>,
"ravi.v.shankar@intel.com" <ravi.v.shankar@intel.com>,
"sai.praneeth.prakhya@intel.com" <sai.praneeth.prakhya@intel.com>,
"arshiya.hayatkhan.pathan@intel.com"
<arshiya.hayatkhan.pathan@intel.com>
Cc: "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"linux-kselftest@vger.kernel.org"
<linux-kselftest@vger.kernel.org>
Subject: [PATCH v5 01/13] selftests/resctrl: Add README for resctrl tests
Date: Fri, 18 Jan 2019 18:27:02 +0000 [thread overview]
Message-ID: <20190118182646.16594-2-babu.moger@amd.com> (raw)
In-Reply-To: <20190118182646.16594-1-babu.moger@amd.com>
From: Fenghua Yu <fenghua.yu@intel.com>
resctrl tests will be implemented. README is added for the tool first.
Signed-off-by: Fenghua Yu <fenghua.yu@intel.com>
Signed-off-by: Babu Moger <babu.moger@amd.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 0000000..f9621d6
--- /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>,
+ Arshiya Hayatkhan Pathan <arshiya.hayatkhan.pathan@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
+ -h: help
--
1.8.3.1
next prev parent reply other threads:[~2019-01-18 18:28 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-18 18:27 [PATCH v5 00/13] selftests/resctrl: Add resctrl selftest Moger, Babu
2019-01-18 18:27 ` Moger, Babu [this message]
2019-01-18 18:27 ` [PATCH v5 02/13] selftests/resctrl: Add basic resctrl file system operations and data Moger, Babu
2019-01-18 18:27 ` [PATCH v5 03/13] selftests/resctrl: Read memory bandwidth from perf IMC counter and from resctrl file system Moger, Babu
2019-01-18 18:27 ` [PATCH v5 04/13] selftests/resctrl: Add callback to start a benchmark Moger, Babu
2019-01-18 18:27 ` [PATCH v5 05/13] selftests/resctrl: Add built in benchmark Moger, Babu
2019-01-18 18:27 ` [PATCH v5 06/13] selftests/resctrl: Add MBM test Moger, Babu
2019-01-18 18:27 ` [PATCH v5 07/13] selftests/resctrl: Add MBA test Moger, Babu
2019-01-18 18:27 ` [PATCH v5 08/13] selftests/resctrl Add Cache QoS Monitoring (CQM) selftest Moger, Babu
2019-01-18 18:27 ` [PATCH v5 09/13] selftests/resctrl: Add Cache Allocation Technology (CAT) selftest Moger, Babu
2019-01-18 18:27 ` [PATCH v5 10/13] selftests/resctrl: Add the test in MAINTAINERS Moger, Babu
2019-01-18 18:27 ` [PATCH v5 11/13] selftests/resctrl: Add vendor detection mechanism Moger, Babu
2019-01-18 18:27 ` [PATCH v5 12/13] selftests/resctrl: Use cache index3 id for AMD schemata masks Moger, Babu
2019-01-18 18:27 ` [PATCH v5 13/13] selftests/resctrl: Disable MBA and MBM tests for AMD Moger, Babu
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=20190118182646.16594-2-babu.moger@amd.com \
--to=babu.moger@amd.com \
--cc=arshiya.hayatkhan.pathan@intel.com \
--cc=fenghua.yu@intel.com \
--cc=hpa@zytor.com \
--cc=james.morse@arm.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--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=xiaochen.shen@intel.com \
/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).