resources: Clean-up the SPEC 2006 README.md
This commit:
* Removed reference to checking out the gem5 develop branch. this is not
correct.
* Removed external references to readthedocs.
* Cleaned up phrasing and formatting.
Change-Id: I125dd0523f56dc065d38523389c34d7bf1575179
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-resources/+/41258
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: Bobby R. Bruce <bbruce@ucdavis.edu>
diff --git a/src/spec-2006/README.md b/src/spec-2006/README.md
index 48d05df..f931fe7 100644
--- a/src/spec-2006/README.md
+++ b/src/spec-2006/README.md
@@ -5,13 +5,13 @@
## Building the Disk Image
Creating a disk-image for SPEC 2006 requires the benchmark suite ISO file.
-More info about SPEC 2006 can be found [here](https://www.spec.org/cpu2006/).
+More info about SPEC 2006 can be found <https://www.spec.org/cpu2006/>.
In this tutorial, we assume that the file `CPU2006v1.0.1.iso` contains the SPEC
benchmark suite, and we provide the scripts that are made specifically for
SPEC 2006 version 1.0.1.
Throughout the this document, the root folder is `src/spec-2006/`.
-All commands should be run from the assumed root folder.
+All commands should be run from this root folder.
The layout of the folder after the scripts are run is as follows,
@@ -41,7 +41,6 @@
```sh
git clone https://gem5.googlesource.com/public/gem5
cd gem5
-git checkout origin/develop
cd util/m5
scons build/x86/out/m5
```
@@ -58,15 +57,6 @@
./packer build spec-2006/spec-2006.json
```
-The path to the disk image is `spec-2006/spec-2006-image/spec-2006`.
-Please refer to [this tutorial](https://gem5art.readthedocs.io/en/latest/tutorials/spec2006-tutorial.html#preparing-scripts-to-modify-the-disk-image)
-for more information about the scripts used in this document.
-
-## Linux Kernel
-The following link contains the compiled Linux kernel that was tested by
-running gem5-20 with SPEC 2006,
-- [vmlinux-4.19.83](http://dist.gem5.org/dist/v20-1/kernels/x86/static/vmlinux-4.19.83)
-
## gem5 Configuration Scripts
gem5 scripts which configure the system and run the simulation are available
in `configs/`.
@@ -83,7 +73,9 @@
are off by default.
`kernel`: required, a positional argument specifying the path to the Linux
-kernel.
+kernel. We have tested using version 4.19.83, which can be downloaded from
+<http://dist.gem5.org/dist/v20-1/kernels/x86/static/vmlinux-4.19.83>. Info on
+building Linux kernels for gem5 can be found in `src/linux-kernel`
`disk`: required, a positional argument specifying the path to the disk image
containing SPEC 2006 benchmark suite.
@@ -100,19 +92,53 @@
| atomic | AtomicSimpleCPU |
| timing | TimingSimpleCPU |
-`benchmark`: required, a positional argument specifying the name of the
-[SPEC 2006 workload](https://gem5art.readthedocs.io/en/latest/tutorials/spec2006-tutorial.html#appendix-i-working-spec-2006-benchmarks-x-cpu-model-table) to run.
+`mem_sys`: required, a positional argument specifying the memory system.
+Specify `classic` for classic memory systems. Ruby Memory Systems `MI_example`,
+`MESI_Two_Level`, and `MOESI_CMP_directory` are also supported.
-`size`: required, a positional argument specifying the input data size,
-must be one of {test, train, ref}.
+`benchmark`: required, a positional argument specifying the name of the SPEC
+2006 workload to run. The available benchmarks are:
-Assume the compiled Linux kernel is available in the assumed root folder, the
-following is an example of running a SPEC 2006 workload in full system mode,
-`
-gem5/build/X86/gem5.opt --outdir [path to the gem5 output directory] configs/run_spec.py -z vmlinux-4.19.83 disk-image/spec-2006/spec-2006-image/spec-2006 atomic 403.gcc test
-`
+* 401.bzip2
+* 403.gcc
+* 410.bwaves
+* 416.gamess
+* 429.mcf
+* 433.milc
+* 434.zeusmp
+* 435.gromacs
+* 436.cactusADM
+* 437.leslie3d
+* 444.namd
+* 445.gobmk
+* 453.povray
+* 454.calculix
+* 456.hmmer
+* 458.sjeng
+* 459.GemsFDTD
+* 462.libquantum
+* 464.h264ref
+* 465.tonto
+* 470.lbm
+* 471.omnetpp
+* 473.astar
+* 481.wrf
+* 482.sphinx3
+* 998.specrand
+* 999.specrand
+
+`size`: required, a positional argument specifying the input data size. Valid
+values are `test`, `train`, and `ref`.
+
+As a minimum the following parameters must be specified:
+
+```
+<gem5 X86 binary> --outdir <output directory> configs/run_spec.py <kernel> <disk> <cpu> <mem_sys> <benchmark> <size>
+```
+
+**Note**: `--outdir` is a required argument when running the gem5 binary with SPEC 2006.
## Working Status
Status of these benchmarks runs with respect to gem5-20, linux kernel version
4.19.83 and gcc version 7.5.0 can be found
-[here](https://www.gem5.org/documentation/benchmark_status/gem5-20#spec-2006-tests)
+[here](https://www.gem5.org/documentation/benchmark_status/gem5-20#spec-2006-tests).
