Last updated: $Date: 2009-12-01 09:38:49 -0500 (Tue, 01 Dec 2009) $ by $Author: keeper $
(To check for possible updates to this document, please
see http://www.spec.org/mpi2007/Docs/ )
Contents
Editing result description fields
Fields allowed only in rawfiles
This document describes various useful utilities that ship with SPEC MPI2007. It is assumed that you have already read runspec.html and config.html.
Note: links to SPEC MPI2007 documents on this web page assume that you are reading the page from a directory that also contains the other SPEC MPI2007 documents. If by some chance you are reading this web page from a location where the links do not work, try accessing the referenced documents at one of the following locations:
Most of the examples in this document have been written in Unix syntax. That means you'll need to use your imagination just a bit as you read this document:
| If you see: | Just pretend you saw: |
| cat | type |
|---|---|
| cp | copy |
| diff | fc |
| grep | findstr |
| ls | dir |
| / | \ |
| $SPEC | %spec% |
"configpp" is a short way to say:
$ runspec --action configpp
That switch is mentioned in runspec.html but you'll find much more about the config file preprocessor in config.html. The configuration file is specified using the --config switch, or -c for short, at the command line. For example, the following two command are equivalent:
$ runspec --action configpp -c try_utilities.cfg $ configpp -c try_utilities.cfg
There are a couple of points worth mentioning here:
The configpp utility is a good way to check your configuration file for fatal errors, as the config file is completely parsed before it's output.
The "convert_to_development" utility removes various safety checks that ensure that benchmark code, data, and tools haven't been modified. This utility is useful if you are pursuing experimental changes that you would like to try out while still continuing to use the SPEC tool harness. For example, you might want to add your own performance instrumentation code, add some debugging code, or try out a modified workload.
A development tree cannnot be used for reportable runs.
Benchmark binaries built in one type of tree (reportable or development) cannot be used in the other type unless you set check_md5=0. Note that even in a development tree, the default for check_md5 remains 1.
Warning 1: If you use this utility, you will permanently render the current SPEC directory tree incapable of doing reportable runs. If you are doing both development work and reportable runs, install the suite twice in two different directory trees (for example, on different disks).
Warning 2: Because benchmark binaries built in a reportable tree cannot be used in a development tree (unless you set check_md5=0), care should be taken to avoid accidental deletion and rebuilding of benchmark binaries. Consider the following scenario, where the user only wanted to try changing input files from the workload of 130.socorro:
$ runspec --config myconfig --action build 130.socorro
$ convert_to_development
Modify the workload for 130.socorro to try out some idea,
changing files in 130.socorro/data/ref/input
$ runspec --config myconfig --action validate 130.socorro
...
Building 130.socorro base
Unless myconfig.cfg contains check_md5=0, the effect of the above command will be to immediately rebuild 130.socorro, which probably isn't your intent if you are only studying the effects of workload modifications for 130.socorro.
The convert_to_development utility is new with SPEC MPI2007 v1.1.
SPEC distributes approved source changes in packages referred to as src.alts, which are applied using the config file src.alt option. In config.html, you will also find an example showing what happens when one is applied.
The dumpsrcalt tool allows you to find out what's in a src.alt without necessarily having to apply it.
dumpsrcalt takes a packaged src.alt, an installed src.alt, or just the src.alt description file (srcalt.pm) and outputs the source changes as a unified diff file, which shows "-" for lines that are removed and "+" for lines that are added.
A src.alt package may also contain whole new files. In fact, all will contain at least one, as the presence of a "README" file is enforced by makesrcalt. The new files will also be printed, if they are available.
dumpsrcalt's command-line options control which parts of the src.alt are output. By default all information known about a src.alt is printed. This includes a summary with the name of the src.alt, the benchmark to which it applies, the versions of MPI2007 with which it may be used, and a count of new and changed files.
Here are the contents of the src.alt created in the example for makesrcalt:
$ dumpsrcalt 132.zeusmp2.fix_fft_name.mpi2007.v1.1.tar.bz2
This is src.alt "fix_fft_name" for 132.zeusmp2.
It is usable with MPI2007 version 1.1.
It contains 1 new file and changes to 1 existing file.
------------------------------------------------------------------------------
Index: README
===================================================================
--- original/README 1969-12-31 16:00:00.000000000 -0800
+++ fix_fft_name/README 2008-08-20 11:34:19.000000000 -0700
@@ -0,0 +1,1 @@
+This is a test to show how dumpsrcalt works.
Index: zeusmp.F
===================================================================
--- original/zeusmp.F 1969-12-31 16:00:00.000000000 -0800
+++ fix_fft_name/zeusmp.F 2008-08-20 11:34:19.000000000 -0700
@@ -92,7 +92,7 @@
c Create best calculating plans for FFTW to perform forward
c and backward FFT.
c
-#ifdef FFT
+#ifdef FFTW
if(xgrvfft) then
nx=ie-is+1
ny=je-js+1
$
Notice above that dumpsrcalt was applied to the packaged (.bz2) src.alt. The dumpsrcalt utility can also be applied to an installed src.alt, producing the same output:
$ dumpsrcalt 126.lammps fix_flt_unstability
This is src.alt "fix_flt_unstability" for 126.lammps.
It is usable with MPI2007 version 1.1.
It contains 1 new file and changes to 1 existing files.
------------------------------------------------------------------------------
Index: README
===================================================================
--- original/README 1969-12-31 16:00:00.000000000 -0800
+++ fix_flt_unstability/README 2008-08-20 11:38:47.000000000 -0700
@@ -0,0 +1,29 @@
+This is a patch to fix certain anomalies in 126.lammps.
+
===================================================================
--- original/comm.cpp 1969-12-31 16:00:00.000000000 -0800
+++ fix_flt_unstability/comm.cpp 2008-08-20 11:38:47.000000000 -0700
@@ -215,8 +215,12 @@
slablo[iswap] = domain->boxlo[dim] +
nbox * domain->prd[dim] / procgrid[dim];
slabhi[iswap] = domain->sublo[dim] + neighbor->cutneigh;
- slabhi[iswap] = MIN(slabhi[iswap],domain->boxlo[dim] +
+ if ((nbox+1) == procgrid[dim]) {
- (nbox+1) * domain->prd[dim] / procgrid[dim]);
+ slabhi[iswap] = MIN(slabhi[iswap],domain->boxlo[dim] + domain->prd[dim]);
+ } else {
+ slabhi[iswap] = MIN(slabhi[iswap],domain->boxlo[dim] +
+ (nbox+1) * domain->prd[dim] / procgrid[dim]);
+ }
if (myloc[dim] == 0) {
if (domain->periodicity[dim] == 0) slabhi[iswap] = slablo[iswap];
else {
@@ -231,8 +235,12 @@
slablo[iswap] = domain->subhi[dim] - neighbor->cutneigh;
slablo[iswap] = MAX(slablo[iswap],domain->boxlo[dim] +
nbox * domain->prd[dim] / procgrid[dim]);
- slabhi[iswap] = domain->boxlo[dim] +
+ if ((nbox+1) == procgrid[dim]) {
- (nbox+1) * domain->prd[dim] / procgrid[dim];
+ slabhi[iswap] = domain->boxlo[dim] + domain->prd[dim];
+ } else {
+ slabhi[iswap] = domain->boxlo[dim] +
+ (nbox+1) * domain->prd[dim] / procgrid[dim];
+ }
if (myloc[dim] == procgrid[dim]-1) {
if (domain->periodicity[dim] == 0) slabhi[iswap] = slablo[iswap];
else {
/* ----------------------------------------------------------------------
Finally, you can apply dumpsrcalt just to srcalt.pm. In that case, the README file is not displayed, since srcalt.pm contains only differences:
$ dumpsrcalt benchspec/MPI2007/132.zeusmp2/src/src.alt/fix_fft_name/srcalt.pm
This is src.alt "fix_fft_name" for 132.zeusmp2.
It is usable with MPI2007 version 1.1.
It contains 1 new file and changes to 1 existing file.
------------------------------------------------------------------------------
New file "README" isn't present, and can't be dumped.
Index: zeusmp.F
===================================================================
--- original/zeusmp.F 1969-12-31 16:00:00.000000000 -0800
+++ fix_fft_name/zeusmp.F 2008-08-20 11:42:15.000000000 -0700
@@ -92,7 +92,7 @@
c Create best calculating plans for FFTW to perform forward
c and backward FFT.
c
-#ifdef FFT
+#ifdef FFTW
if(xgrvfft) then
nx=ie-is+1
ny=je-js+1
$
Notice that the output from dumpsrcalt is suitable for use as input to many patch (1) programs, available on Unix systems and in some add-on packages for Windows (e.g. Cygwin). If you try to apply the output of dumpsrcalt yourself, take care to notice how paths are handled by your patch program, especially if the src.alt is for a benchmark that has a complicated source tree. Many patch programs will pay attention to the filename but not the path listed on the "Index:" lines, so it may be best to apply them using the "-p1" option, to cause patch to ignore "Index:" lines and use the full paths of the files as listed in the diff.
dumpsrcalt's command-line options are intended to be self-explanatory:
$ dumpsrcalt --help
Usage: bin/dumpsrcalt [options] <benchmark> <srcaltname>
bin/dumpsrcalt [options] <path to srcalt tarball>
bin/dumpsrcalt [options] <path to srcalt.pm>
Options:
--skip-changed -- Do not output diffs of files that have changed
--skip-new -- Do not output diffs for new files
--summarize -- Do not output any diffs at all
--no-summary -- Do not output the summary for the src.alt
<benchmark> must be the full nnn.name form
<srcaltname> must match the name of the subdirectory in the benchmark's
src.alt directory
The dumpsrcalt utility is new in MPI2007 V1.1.
If you have a rawfile, you can extract the config file that was used with it. To do so, use the extract_config utility.
For example, starting with a freshly-installed SPEC MPI2007 directory tree:
% runspec --config=Example-simple --size=test --iterations=1 \ --tuning=base --output_format=text,raw milc > /dev/null % cd result % ls MPIM2007.001.mtest.rsf MPIM2007.001.mtest.txt MPI2007.001.log lock.MPI2007
Note that we have just the single result. Let's make a temporary directory and copy the rawfile there:
% mkdir tmp % cd tmp % cp ../MPIM2007.001.mtest.rsf . % ls MPIM2007.001.mtest.rsf
(On Windows, that ls command would be spelt dir. You'll find some more Windows notes in the introduction.)
Now, attempt to extract the config file:
% extract_config --stdout MPIM2007.001.mtest.rsf > tmp.cfg
Does the extracted file match the original?
% diff -u ../../config/try_utilities.cfg tmp.cfg
--- ../../config/try_utilities.cfg 2006-05-22 14:41:42.000000000 -0700
+++ tmp.cfg 2006-05-22 14:43:16.000000000 -0700
@@ -1,3 +1,6 @@
+# Invocation command line:
+# /Volumes/storage/WorkRelated/SPEC/MPI2007/Kits/mpi2007-kit91/bin/runspec
--config=try_utilities --size=mtest --iterations=1 --tuning=base
--output_format=asc,raw milc
+############################################################################
# This is a sample config file. It was tested with:
#
# Compiler name/version: Apple GCC v4.0.1 build 5245
@@ -128,15 +131,8 @@
sw_state = Default
sw_other = None
-__MD5__
-104.milc=base=try_utilities=default:
-# Last updated Mon May 22 14:41:42 2006
-optmd5=0666e60587f33e2aa13eb6ba0917aa60
-baggage=
-compile_options=\
-@eNqNj00LgkAQhu/7K4a9b5duoUKuJpa6C+qlS9QmYqAjaYf+faMF2cfBYQ8Dsy/P80oV6xWUxoCg\
-h4BtX2HTLRCEl2pfHqTOaU08380DoBFqCaI+35tjXRnRoGgrCpbwNVaHt6spHCZXIKXNicDHXblb\
-pTObf+A4IwkibaJ1kNLtF82ZGsI6C+Nw79OX/xqcRWGyexaa4Wrh6VKYvnMm5m+rwTfyXu4z8WNE\
-5UPBSbsHPPNh9Q==
-exemd5=d828496b92983e96408f680b55393225
%
Yes. The only differences are:
The config file can also be extracted directly to a file:
% extract_config --nostdout MPIM2007.001.mtest.rsf Wrote "MPIM2007.001.mtest.cfg"
or
% extract_config MPIM2007.001.mtest.rsf Wrote "MPIM2007.001.mtest.cfg"
Lastly, you can choose the filename if you're piping files in via stdin:
% extract_config --basename=SampleFilename < MPIM2007.001.mtest.rsf Wrote "SampleFilename.cfg"
Instead of saying diff just above, you would say fc (and, as already mentioned, dir is the Windows spelling for what Unix calls ls.)
If you have a rawfile, you can extract the XML flags description file that the result uses. To do so, use extract_flags. Usage is similar to extract_raw, but unlike extract_raw, the extract_flags utility might not produce a flags description file identical to the original flags file. This is because EOLs (end-of-line) characters are normalized to Unix-style LF (line feed) only.
Note: If you have used a flags description file to format your result, the entire flags file is stored in the raw file (not just the part needed for result).
For example, continuing the example from extract_raw, you can extract the flags file using the following command:
$ extract_flags --stdout new.rsf > extracted.flags.xml $ diff ../myflags.xml ./extracted.flags.xml $
We see no difference between the extracted flags description file and the original. Notice that the above command asked for the flags to be written to standard out; without that switch, they would have been written to whatever filename was suggested.
If you'd like for the filename of the extracted flags file to match the rawfile, use the --nofilename option. This will cause extract_flags to ignore the flag file's "suggested filename":
% ls *rsf
mpi2007-20060901-00074.rsf mpi2007-20060904-00080.rsf
mpi2007-20060901-00075.rsf mpi2007-20060904-00081.rsf
mpi2007-20060903-00076.rsf mpi2007-20060904-00082.rsf
mpi2007-20060903-00077.rsf mpi2007-20060904-00083.rsf
mpi2007-20060904-00078.rsf mpi2007-20060904-00084.rsf
mpi2007-20060904-00079.rsf mpi2007-20060904-00085.rsf
% extract_flags --nofilename mpi2007-20060904-00085.rsf
Reading "mpi2007-20060904-00085.rsf"
Wrote "mpi2007-20060904-00085.xml"
%
New with MPI2007 V1.1, you can format a result with multiple flags files. If you used multiple flags files as input to runspec then you will get multiple flags files when running extract_flags.
# extract_flags MPIM2007.001.mref.rsf Reading "MPIM2007.001.mref.rsf" Wrote "platform-setup.xml" Wrote "pathscale-flags.xml" # extract_flags --nofilename MPIM2007.001.mref.rsf Reading "MPIM2007.001.mref.rsf" Wrote "MPIM2007.001.mref.xml" Wrote "MPIM2007.001.mref-1.xml"
In the examples above, result 001 used two flags files. One has information about the platform (which might contain items such as BIOS settings), and the other describes the compiler.
Note: If a raw file has not been formatted with a flags description file, extract_flags does nothing.
If you have a PDF, HTML, or PostScript output file, you can extract the rawfile that was used to generate it. To do so, use extract_raw. For example:
$ cp -p MPIM2007.267.mref.rsf new $ ls -g new -rw-rw-r-- 1 ptg 186202 Mar 13 22:57 new $ rawformat -o html,raw --flagsurl ./myflags.xml new 2>&1 > /dev/null $ ls -g new.html new.rsf -rw-rw-r-- 1 ptg 109390 Mar 20 12:48 new.html -rw-rw-r-- 1 ptg 194193 Mar 20 12:48 new.rsf $ mkdir AppleFrancisco $ cd AppleFrancisco/ $ cp ../new.html . $ ls -g -rw-rw-r-- 1 ptg 109390 Mar 20 12:51 new.html $ extract_raw new.html new.html: Wrote "new.rsf" $ ls -g -rw-rw-r-- 1 ptg 109390 Mar 20 12:51 new.html -rw-rw-r-- 1 ptg 194193 Mar 20 12:51 new.rsf $ diff ../new.rsf new.rsf $
In the above example, we begin by copying the original rawfile (always recommended anytime you use commands that create new rawfiles). The rawformat command takes new as input and produces as output both new.html and new.rsf. We copy only new.html to a newly created directory, where we demonstrate that extract_raw can create a copy of new.rsf that is identical to the copy in the parent directory.
Note that the file you extract from can be PDF, PostScript, or HTML, just as on Unix systems, with one important exception: if you are using a browser that attempts to add value to the HTML when you save it, that browser may break the embedded rawfile. For example, with Internet Explorer Version 5.00.3103.1000, if you are viewing a SPEC MPI2007 html file and you select File -> Save As, the default for "Save as type" is shown as
"Web Page, complete (*.htm,*.html)"
Do not accept that default if you want to be able to retrieve the rawfile later on. If you take the default, your saved file will be incomplete. To save the web page INCLUDING the embedded rawfile, you must change "Save as type" to
"Web Page, HTML only (*.htm,*.html)"
(You can also invoke this utility with the spelling: 'flags_dump')
If you have an XML flag description file, such as one extracted using extract_flags, or one downloaded from SPEC, flag_dump will create a more human-readable HTML version from it. The flag_dump utility will also handle more than one XML flag description at a time.
For example:
$ cd /tmp $ mkdir myflags $ cd myflags/ $ cp $SPEC/Docs/flags/*xml . $ ls example-medium-cfg-flags.xml flags-advanced.xml flags-simple.xml $ cp flags-advanced.xml flags-for-willi.xml $ flag_dump flags-advanced.xml flags-for-willi.xml flags-simple.xml Processing flags-advanced.xml...wrote flags-advanced.html Processing flags-for-willi.xml...wrote flags-for-willi.html Processing flags-simple.xml...wrote flags-simple.html $
If you are writing a flags file, you should validate that the dump is valid HTML. If it isn't, you probably made a mistake in the HTML text that you have included inside your XML flags file. A handy HTML validator can be found at http://validator.w3.org/.
Note that flag_dump utility assumes that you are formatting flags files written by users. These files are not allowed to contain mandatory flags. If you attempt to use the flag_dump utility to format any of the suite-provided flag files such as flags_mandatory.xml or the benchmark flag files that reside in $SPEC/benchspec/MPI2007/*/Spec/ directory, the utility will exit with an error message such as the one below.
% cd $SPEC/benchspec
% flag_dump flags_mandatory.xml
Processing flags_mandatory.xml...
ERROR: The flag file at
flags_mandatory.xml
contains one or more flags in the class "mandatory", which is not
allowed.
%
When you source the shrc, as described in runspec.html, the 'go' shell alias is created. go is a handy utility to navigate the directory structure of a SPEC source tree. Here are the various things it understands and the places they will take you:
| If you say | You'll end up in |
| go
go top | $SPEC |
|---|---|
| go bin | $SPEC/bin (where the tools live) |
| go config | $SPEC/config |
| go result
go results | $SPEC/result |
| go doc
go docs | $SPEC/Docs |
| go cpu | $SPEC/benchspec/MPI2007 |
| go benchmark | The top level directory for the named benchmark, if it can be found. (Examples follow) |
| go 126 | $SPEC/benchspec/MPI2007/126.lammps |
| go zeus | $SPEC/benchspec/MPI2007/132.zeusmp2 Notice that abbreviated names are accepted. But if the abbreviation is ambiguous, the command will pick the first match, so pay attention to the reply: $ go G /spec/mpi2007/kit91/benchspec/MPI2007/113.GemsFDTD $ go GA /spec/mpi2007/kit91/benchspec/MPI2007/128.GAPgeofem $ |
| go nada | no change: there's no benchmark named nada* |
| go benchmark subdir | The named subdirectory of the directory tree for the referenced benchmark, for example "go tera run". You can also name more than one level of subdirectory: "go 129 data mtrain". |
| go subdir | If you are already in a benchmark subtree, then you can move to a different branch of the same benchmark, by naming the branch and not mentioning a benchmark. For example: $ pwd /rahul/benchspec/MPI2007/127.wrf2/run/build_base_a3.0000 $ go exe /rahul/benchspec/MPI2007/127.wrf2/exe $ |
go also understands -h and --help, and will output a short usage message in response to either of those arguments.
Note: If you leave the shell where you sourced shrc, the alias is no longer available! So if you want to use this alias, do not start a sub-shell.
Note: 'go' does not know about your settings for output_root or expid, and will not be able to take you to your run, exe, or result directories if you use those features. See ogo for something that can help.
If you use a csh-like shell, please note that after you say source cshrc, there is a go alias that is set up for you, which implements the same features as described above.
Sorry, the go feature does not exist for Windows systems.
As you are preparing sets of results, you might find it handy to use scripts.misc/index. This script is NOT supported - please do not submit bug reports for it. But you're welcome to try it out, like so:
$ ls run128.rsf run64.rsf $ rawformat -o html *rsf > /dev/null $ ls run128.flags.html run128.rsf run64.html run128.gif run64.flags.html run64.rsf run128.html run64.gif $ $SPEC/bin/scripts.misc/index $ ls index.html run128.html run64.gif run128.flags.html run128.rsf run64.html run128.gif run64.flags.html run64.rsf $
In the above example, we have a couple rawfiles in a directory, generate html reports for them, and then add an index.
SPEC distributes approved source changes in packages referred to as src.alts, which are applied using the config file src.alt option. (The file config.html also has an example showing what happens when one is applied.)
A src.alt is a specialized difference file, and can't be made by hand. When you need to package some source changes, makesrcalt is the tool you need.
If you are a developer and you believe that changes are needed to the SPEC source code, it will probably be convenient to work in a sandbox, temporarily abandoning the tools during your development phase. (Or, you can use convert_to_development to make the whole installation into one big sandbox.) Once you have a pretty good idea of the changes that you want:
Create a subdirectory under the benchmark's src/ directory named "src.alt/".
Decide on a name for your src.alt. The src.alt name may contain only letters, digits, and underscores. For convenience, it should be short. Create a subdirectory under src/src.alt/ using the name you have chosen.
In that subdirectory, deposit any modified or new source files for the benchmark.
You must also put a file named "README" in that subdirectory. Its contents are up to you; to see examples of the kind of information that is usually placed in README files, see www.spec.org/mpi2007/src.alt. In your draft, kindly do NOT claim that it is approved; the release manager will do that at the last minute.
Once the directory structure is set up, creation of the src.alt package is simple: just type makesrcalt followed by the name of the benchmark and the src.alt name.
Contact SPEC to get the src.alt approved.
Example: We've made source changes to 104.milc to fix an MPI routine calling problem in the com_mpi.c source file. This src.alt will be called 'send_fix':
$ makesrcalt 104.milc send_fix Making 'send_fix' src.alt for 104.milc This will be usable with version 1.1 of the suite. Making differences and computing checksums... Writing control file... Gathering files... Wrote /spec/mpi2007/104.milc.send_fix.mpi2007.v1.1.tar.bz2 Finished making 'send_fix' src.alt for 104.milc. Elapsed time: 0 seconds $
If you use --help, you'll get an up-to-date list of options. Usually, you won't need any of these:
$ makesrcalt --help
Usage: bin/makesrcalt [options] <benchmark> <srcaltname>
Options:
--usewith <min>:<max> -- Set the versions of the suite that will accept
this src.alt (defaults to 1.1)
--notarball -- Skip packaging the src.alt as a tarball (created
by default)
--context <lines> -- Set lines of context for the diff. This defaults
to 3 and should not be changed.
--help -- Print this message
<benchmark> must be the full nnn.name form
<srcaltname> must match the name of the subdirectory in the benchmark's
src.alt directory
$
The makesrcalt utility is improved in, and is documented for the first time with, MPI2007 V1.1.
When you source shrc, as described in runspec.html, the 'ogo' shell alias is created. Its function is similar to the go alias with one important difference: if you use the output_root setting in your config file (also discussed in runspec.html) you can use ogo as a shorthand for moving around both the original installed benchmark tree and your output tree.
To do so, simply set the GO environment variable to the same value as your output_root. Then, 'ogo' will use the contents of that variable as the top level of the benchmark tree when looking for run directories and results.
For example, you could say something like this:
$ go config /spec/config $ grep output_root cds.cfg output_root = /cds_stuff $ GO=/cds_stuff $ ogo run milc Using value in GO for output_root: /cds_stuff /cds_stuff/benchspec/MPI2007/104.milc/run $
Note the helpful message that tells you which directory you have landed in. (If you define the environment variable OGO_NO_WARN the message will be shorter - the first line "Using value in GO..." will not be output.)
In this example, the benchmarks are installed in "/spec", and output_root is set to "/cds_stuff" in the config file. Any runs using that config file will write their results, executables, and run directories under "/cds_stuff". Continuing with other examples:
| If you say | You'll end up in |
| ogo ogo top | /cds_stuff
Your own private output tree |
|---|---|
| ogo result | /cds_stuff/result
Your own private result directory |
| ogo 104 run | /cds_stuff/benchspec/MPI2007/104.milc/run
Your own private run directories |
| ogo wrf2 exe | /cds_stuff/benchspec/MPI2007/127.wrf2/exe
Your own private executables |
| ogo doc | /spec/Docs
There's only one Docs directory, on the original installed $SPEC tree |
| ogo config | /spec/config
The config directory is always on the original installed tree; set its protections as described in runspec.html |
| ogo 104 src | /spec/benchspec/MPI2007/104.milc/src
Run directories are under output_root, but the benchmark src directory is still in the original installed $SPEC tree. |
ogo also understands -h and --help, and will output a short usage message in response to either of those arguments.
New with MPI2007 V1.1, saying ogo top or just ogo takes you to $GO. It used to take you to $SPEC.
Note: It's not necessary to export the "GO" variable. Declaring this variable at the command-prompt is sufficient.
$ GO=/tmp/cds
$ echo $GO
/tmp/cds
ogo has also been implemented for cshrc. There is one restriction: to get the full feature set above, you must set OGO to the actual directory, not to a symbolic link.
Sorry, the ogo feature does not exist for Windows systems.
The port_progress utility analyzes log files and summarizes errors. It was primarily used during the benchmark porting phase for SPEC MPI2007, but can still come in handy, for example when trying the benchmarks with a new compiler. To use it:
cd $SPEC/result (or on Windows, cd %SPEC%\result) port_progress logfile...
Optionally, you can limit output by saying:
-c config only report logs that match the named config file
In the example below:
port_progress -c dec2 *.log
SPEC MPI2007 mpi2007.70a
Tester: john
dec22a
Base Peak
Te Tr Ref Te Tr Ref
104.milc S S S b? b? b?
107.leslie3d S S S b? b? b?
113.GemsFDTD S S S b? b? b?
115.fds4 S S S b? b? b?
121.pop2 S r? r? b? b? b?
122.tachyon S S r? b? b? b?
126.lammps
127.wrf2 S S S b? b? b?
128.GAPgeofem S S S b? b? b?
129.tera_tf S S S b? b? b?
130.socorro S S S b? b? b?
132.zeusmp2 S S S b? b? b?
137.lu S S S b? b? b?
121.pop2 run failures in logs:
020 -i mtrain --ranks=96 -c dec22a.cfg -a validate -T base medium
Dir: run_base_mtrain_dec22a.0000
021 -i mref --ranks=96 -c dec22a.cfg -a validate -T base medium
Dir: run_base_mref_dec22a.0000
122.tachyon run failures in logs:
021 -i mref --ranks=96 -c dec22a.cfg -a validate -T base medium
Dir: run_base_mref_dec22a.0000
Some benchmark executables are invoked multiple times. If you'd like to know how much time was spent on each invocation, it may not be easy to tell. You could examine "speccmds.out", but that file is not easy to interpret:
$ runspec --config=try_utilities --size=mtrain --iterations=1 \
--tuning=base --output_format=ps 126
$ go 126 run
$ cd run_base_mtrain_try_utilities.0000/
$
$ cat speccmds.out | fold -s
running commands in speccmds.cmd 1 times
runs started at 1217013281, 969080000, Fri Jul 25 12:14:41 2008
run 1 started at 1217013281, 969254000, Fri Jul 25 12:14:41 2008
child started: 0, 1217013281, 969277000, pid=10328,
'mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lammps_base.try_utilities -in in.chain -log none'
child finished: 0, 1217013295, 703592000, sec=13, nsec=734315000, pid=10328, rc=0
child started: 0, 1217013295, 703672000, pid=10524,
'mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lammps_base.try_utilities -in in.chute -log none'
child finished: 0, 1217013309, 812711000, sec=14, nsec=109039000, pid=10524, rc=0
child started: 0, 1217013309, 812787000, pid=10720,
'mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lammps_base.try_utilities -in in.eam -log none'
child finished: 0, 1217013322, 941256000, sec=13, nsec=128469000, pid=10720, rc=0
child started: 0, 1217013322, 941313000, pid=10916,
'mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lammps_base.try_utilities -in in.lj -log none'
child finished: 0, 1217013335, 72802000, sec=12, nsec=131489000, pid=10916, rc=0
run 1 finished at: 1217013335, 72890000, Fri Jul 25 12:15:35 2008
run 1 elapsed time: 53, 103636000, 53.103636000
runs finished at 1217013335, 72937000, Fri Jul 25 12:15:35 2008
runs elapsed time: 53, 103857000, 53.103857000
$
Fortunately, SPEC has provided a tool to interpret the above for you:
$ printkids.pl
Seconds Command
13.73 mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lam
14.11 mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lam
13.13 mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lam
12.13 mpirun -np 96 -host sumocat ../run_base_mtrain_try_utilities.0000/lam
=========
53.10 Total by adding children
53.10 Total according to speccmds.out
$
"rawformat" is the result formatter. It can be invoked directly, by typing rawformat, or equivalently by typing runspec --rawformat. These two commands achieve the same effect because, saying runspec --rawformat just causes runspec to exit, invoking rawformat in its stead, and passing the formatter whatever other options you mentioned on the command line.
The rawformat utility is also automatically invoked by runspec at the end of a run, to generate the reports from your run.
For convenience, most rawformat options are documented in runspec.html, which see for basic information on using this command. You can also say rawformat --help to get a list of switches that are used by the formatter.
Note that when runnng rawformat, you will always get format "Submission Check", which encourages consistent formatting for various result fields when preparing final (submittable) reports. In addition, you will get the formats that you mention on the command line, or, if none are mentioned there, then you will get the defaults documented under output_format. The automatic addition of subcheck to the list of outputs is new with MPI2007 V1.1
A few additional points are worth mentioning, in the following sections.
A result rawfile may be edited to update reader fields, such as the system description. Rawfile syntax is similar to the syntax in config files, with a few exceptions:
These points are described in this section.
WARNING: Before you do anything, make a backup copy of the rawfile first!
Example: What do you do when Marketing decides to change the name from "SuperMPI 4" to "SuperMPI IV" just before you publish the results, or just before you're ready to submit them to SPEC? In your config file, you had
sw_mpi_library = SuperMPI 4
which has caused the rawfile to contain the line
spec.mpi2007.sw_mpi_library: SuperMPI 4
and you've just been told that the name is wrong. You don't have time to re-run your test. It's too late to change the config file.
SPEC does allow you to edit the rawfile to make corrections. Just make sure that you only edit the fields located before the "fence":
# =============== do not edit below this point ===================
WARNING: Make a backup copy of the rawfile first!
For example:
$ cd $SPEC/result
$ cp MPIM2007.001.mref.rsf new.rsf
edit new.rsf to make your changes
$ diff MPIM2007.001.mref.rsf new.rsf
9c9
< spec.mpi2007.sw_mpi_library: SuperMPI 4
---
> spec.mpi2007.sw_mpi_library: SuperMPI IV
$
$ rawformat -o ps new.rsf
rawformat v1036 - Copyright 1999-2008 Standard Performance Evaluation Corporation
Using 'solaris-sparc' tools
Reading MANIFEST... 2367 files
Loading rawformat modules............
Locating benchmarks...found 13 benchmarks in 2 benchsets.
Locating output formats: ASCII, config, CSV, flags, HTML, mail, PDF, PostScript, raw, Screen, Submission Check
Formatting new.rsf
Parsing flags for 104.milc base: done
Parsing flags for 107.leslie3d base: done
Parsing flags for 113.GemsFDTD base: done
Parsing flags for 115.fds4 base: done
Parsing flags for 121.pop2 base: done
Parsing flags for 122.tachyon base: done
Parsing flags for 126.lammps base: done
Parsing flags for 127.wrf2 base: done
Parsing flags for 128.GAPgeofem base: done
Parsing flags for 129.tera_tf base: done
Parsing flags for 130.socorro base: done
Parsing flags for 132.zeusmp2 base: done
Parsing flags for 137.lu base: done
Doing flag reduction: done
format: PostScript -> new.ps
There is no log file for this run.
rawformat finished at Wed Aug 20 10:31:00 2008; 10 total seconds elapsed
$
Notice when editing fields that have more than one line that you need to construct the numbers with correct syntax. The syntax in the rawfile is a bit more picky than in config files (compare the following vs. the config.html section on "Field scoping and continuation". You cannot say something like this:
| WRONG: |
spec.mpi2007.sw_c_compiler: Intel C Compiler 9.1 for Windows XP
spec.mpi2007.sw_c_compiler1: Visual Studio 2005 (for libraries) |
because the tools are not prepared at this point for a mixture of numbered and un-numbered fields. If you need to have continued fields, say instead:
| RIGHT: |
spec.mpi2007.sw_c_compiler0: Intel C Compiler 9.1 for Windows XP
spec.mpi2007.sw_c_compiler1: Visual Studio 2005 (for libraries) |
The testbed description field is allowed in raw files but not allowed in config files:
| test_date | When the tests were run. New with MPI2007 V1.1, this field is populated automatically based on the clock in the system under test. Setting this in the config file will generate a warning and the setting will be ignored. If your system clock is incorrect, then the value may be edited in the raw file. It's better to avoid the necessity to edit, by setting your system clock properly. |
You may find that --output_format will only accept one argument at a time. If so, first create the rawfile with --output_format raw, then use the new rawfile to create the other reports.
If you rearrange mount points or rename your SPEC root directory, you will probably find confusing problems like the one in the example that follows. We used to have a working SPEC tree under /mpi2007/mpi2007-kit91, but we're going to change that:
$ cd /mpi2007 $ mv mpi2007-kit91 jamesbond $ cd jamesbond $ . ./shrc $ runspec -h -bash: /mpi2007/jamesbond/bin/runspec: /mpi2007/mpi2007-kit91/bin/specperl: bad interpreter: No such file or directory
The problem is that the first line of runspec points to a path that no longer exists:
$ head -1 bin/runspec #!/mpi2007/mpi2007-kit91/bin/specperl $
Fortunately, SPEC has provided a tool to relocate the tools in the new tree:
$ cd /mpi2007/jamesbond $ . ./shrc $ relocate Top of SPEC benchmark tree is '/mpi2007/jamesbond' $ runspec -h | head -3 runspec v1041 - Copyright 1999-2008 Standard Performance Evaluation Corporation Using 'solaris-sparc' tools Reading MANIFEST... 10349 files
Limitations: There are some limitations to this tool. Most notably, it uses perl, so if the tree has been re-arranged in such a way that perl has an identity crisis and can't find itself, you'll be in trouble. Make sure that you have sourced shrc, as in the next example; if it still fails, you may need to reinstall the MPI2007 kit.
$ cd /mpi2007
$ mv jamesbond dr_evil
$ cd dr_evil
$ bin/relocate
Your $SPEC variable is not set correctly!
Top of SPEC benchmark tree is '/mpi2007/dr_evil'
Can't locate strict.pm in @INC (@INC contains: /mpi2007/jamesbond/bin
/mpi2007/jamesbond/bin/lib .) at bin/relocate line 3.
BEGIN failed--compilation aborted at bin/relocate line 3.
$ . ./shrc
$ bin/relocate
Top of SPEC benchmark tree is '/mpi2007/dr_evil'
$ runspec -h | head -2
runspec v1041 - Copyright 1999-2008 Standard Performance Evaluation Corporation
Using 'solaris-sparc' tools
Reading MANIFEST... 10349 files
$
In order to decide whether your system got the correct answer for a benchmark, runspec writes a file called compare.cmd in the run directory, and then calls specinvoke, which calls specdiff. (The specinvoke utility is described below.)
Suppose that your results are flagged as incorrect, but you'd like to have more detail. You could ask for more than 10 lines of detail by changing the config file's default for difflines from 10 to something else, and re-running the experiment. But, you might save a lot of time and avoid the re-run of the experiment, by calling specdiff directly, with a different number of lines for its switch -l.
For example, a file chock-full of wrong answers for 107.leslie3d has been created by hand. First, let's see how specdiff would normally be run (line wraps added for readability):
$ go leslie3d run $ cd run_base_test_try_utilities.0000/ $ specinvoke -c 1 -f compare.cmd -n # Use another -n on the command line to see chdir commands # Starting run for copy #0 specperl /mpi2007/george/bin/specdiff -m -l 10 --abstol 0.0005 --reltol 0.005 /mpi2007/george/benchspec/MPI2007/107.leslie3d/data/mref/output/tml.dat tml.dat > tml.dat.cmp
The above says that normally we test for correct answers by comparing the file $SPEC/benchspec/MPI2007/107.leslie3d/data/mref/output/tml.dat versus the file tml.dat in the current directory. Normally, 10 lines of detail are printed. Let's change that to 15 lines, and compare versus our intentionally wrong file instead:
$ specdiff -m -l 15 --abstol 0.0005 --reltol 0.005 \
/mpi2007/george/benchspec/MPI2007/107.leslie3d/data/mref/output/tml.dat tml.dat
0003: 0.03643 1.04361
0.03643 1.08361
^
0005: 0.06071 1.04405
1.06071 1.04405
^
0006: 0.07286 1.04427
1.07286 1.04427
^
0007: 0.08500 1.04449
1.08500 1.04449
^
0008: 0.09714 1.04471
1.09714 1.04472
^
0009: 0.10928 1.04494
1.10928 1.04494
^
0010: 0.12142 1.04517
1.12142 1.04517
^
0011: 0.13357 1.04540
1.13357 1.04540
^
0014: 0.16999 1.04610
0.16999 1.07611
^
0018: 0.21857 1.04706
0.21857 1.03707
^
0021: 0.25502 1.04779
0.25502 1.09781
^
0027: 0.32794 1.04928
0.32794 1.08930
^
0028: 0.34010 1.04953
1.34010 1.04955
^
0029: 0.35225 1.04978
1.35225 2.04979
^
0030: 0.36441 1.05003
1.36441 2.05004
^
specdiff run completed
$
Here are the switches supported by specdiff:
$ specdiff -h
Usage: /spec/mpi2007/bin/specdiff <options> file1 [file2]
-l,--lines # of lines of differences to print (-1 for all)
-q,--quiet don't print lines just set return code
-a,--abstol absolute tolerance (for floating point compares)
-r,--reltol relative tolerance (for floating point compares)
-o,--obiwan allow off-by-one errors
-O,--OBIWAN *don't* allow off-by-one errors
-s,--skiptol # of differences to ignore
--skipabstol # of abstol differences to ignore
--skipreltol # of reltol differences to ignore
--skipobiwan # of off-by-one differences to ignore
-t,--calctol calculate required tolerances
-H,--histogram show a histogram of differences
-f,--floatcompare Do comparison for floating-point values even if no
tolerances are specified. (Normally this is
automatic.)
-m,--mis write file2.mis with miscompares
-c,--cw collapse whitespace (probably doesn't do what you
think it does)
-C,--CW *don't* collapse whitespace
-b,--binary Do byte-wise comparison for binary outputs
-i,--ignorecase Ignore case for string comparisons
-d,--datadir Compare against file(s) in data directory
--os Set the operating system type (this is unnecessary)
-v,--verbose Set the level of noisiness for the output
-h,--help Print this message
$
In order to run a benchmark, runspec writes a series of commands in the run directory, in the file speccmds.cmd. These commands are then interpreted by specinvoke.
When something goes wrong, it is often useful to try the commands by hand. Ask specinvoke what it did, by using the "-n" switch:
$ go leslie3d run /mpi2007/george/benchspec/MPI2007/107.leslie3d/run $ cd run_base_mtest_try_util.0000 $ ls compare.cmd input.data speccmds.out compare.err leslie3d.err speccmds.stdout compare.out leslie3d.out tml.dat compare.stdout leslie3d_base.try_util tml.dat.cmp flow_000.dat speccmds.cmd grid.dat speccmds.err $ specinvoke -n # Use another -n on the command line to see chdir commands # Starting run for copy #0 mpirun -np 96 -host sumocat \ ../run_base_mtest_try_util.0000/leslie3d_base.try_util > leslie3d.out 2>> leslie3d.err $
In the above example, we see how leslie3d is invoked (line wraps added for readability). If you wanted to try out your own variations on the above command by hand, you could do so.
Here are the switches supported by specinvoke:
$ specinvoke -h
Usage: specinvoke [options] [instructionfile]
-i # iterations
-c # concurrent processes (overrides -u in command file)
-E return non-zero exit code if child does
-s shell shell to invoke
-f file instruction file
-o file output file
-e file error file
-d dir change to dir first
-n[n] print a 'dry_run' of commands
-A return 0 error code
-S msecs sleep between spawning copies (in milliseconds)
-r don't do I/O redirection ($command already has it)
-N open null device when no input file is specified
-Z use zero-length file when no input file is specified
-C (default) close stdin when no input file is specified
-h this message
To build a benchmark, runspec uses specmake, which is simply GNU make under a unique name to avoid possible conflicts with other versions of make on your system.
If a benchmark build fails, one of the most massively useful things you can do is to ask specmake what it did, by using the "-n" switch, which means "dry run".
For example, let's create a config file that is unlikely to work:
$ go config $ cat > tmp.cfg ext = silly FC = f66 $
and try it out:
$ runspec --config=tmp --tuning=base --action=build leslie3d runspec v1041 - Copyright 1999-2008 Standard Performance Evaluation Corporation Using 'solaris-sparc' tools Reading MANIFEST... 10349 files Loading runspec modules................ Locating benchmarks...found 13 benchmarks in 20 benchsets. Reading config file '/mpi2007/george/config/tmp.cfg' Benchmarks selected: 107.leslie3d Compiling Binaries Building 107.leslie3d base silly default: (build_base_silly.0000) Error with make 'specmake build': check file '/mpi2007/george/benchspec/MPI2007/107.leslie3d/build/build_base_silly.0000/make.err' Command returned exit code 2 Error with make! *** Error building 107.leslie3d If you wish to ignore this error, please use '-I' or ignore errors. The log for this run is in /mpi2007/george/result/MPI2007.034.log runspec finished at Wed Aug 20 11:14:18 2008; 3 total seconds elapsed $
Sure enough, it failed. Let's find the appropriate run directory where our silly build was attempted:
$ go leslie3d build /mpi2007/george/benchspec/MPI2007/107.leslie3d/build $ ls build_base_silly.0000 list $ cd build_base_silly.0000
And ask specmake just exactly what it generated:
$ specmake -n f66 -c -o modules.o modules.f f66 -c -o flowio.o flowio.f f66 -c -o fluxi.o fluxi.f f66 -c -o fluxj.o fluxj.f f66 -c -o fluxk.o fluxk.f f66 -c -o grid.o grid.f f66 -c -o main.o main.f f66 -c -o parallel.o parallel.f f66 -c -o props.o props.f f66 -c -o setbc.o setbc.f f66 -c -o setiv.o setiv.f f66 -c -o tmstep.o tmstep.f f66 -c -o update.o update.f f66 -c -o alloc.o alloc.f f66 modules.o flowio.o fluxi.o fluxj.o fluxk.o grid.o main.o \ parallel.o props.o setbc.o setiv.o tmstep.o update.o alloc.o -o leslie3d
OK, let's enter the command by hand:
$ f66 -c -o modules.o modules.f f66: Command not found $
A great convenience of the MPI2007 suite is the fact that you can now proceed to play with all the files in this run directory, to prototype different changes and try out ideas, without fear that you will break anything. As long as you confine your edits to (in this example) $SPEC/benchspec/MPI2007/107.leslie3d/run/build_base_silly.0000, you are in a private sandbox and will not harm the original sources.
Here are the switches supported by specmake:
$ specmake -h
Usage: specmake [options] [target] ...
Options:
-b, -m Ignored for compatibility.
-B, --always-make Unconditionally make all targets.
-C DIRECTORY, --directory=DIRECTORY
Change to DIRECTORY before doing anything.
-d Print lots of debugging information.
--debug[=FLAGS] Print various types of debugging information.
-e, --environment-overrides
Environment variables override makefiles.
-f FILE, --file=FILE, --makefile=FILE
Read FILE as a makefile.
-h, --help Print this message and exit.
-i, --ignore-errors Ignore errors from commands.
-I DIRECTORY, --include-dir=DIRECTORY
Search DIRECTORY for included makefiles.
-j [N], --jobs[=N] Allow N jobs at once; infinite jobs with no arg.
-k, --keep-going Keep going when some targets can't be made.
-l [N], --load-average[=N], --max-load[=N]
Don't start multiple jobs unless load is below N.
-n, --just-print, --dry-run, --recon
Don't actually run any commands; just print them.
-o FILE, --old-file=FILE, --assume-old=FILE
Consider FILE to be very old and don't remake it.
-p, --print-data-base Print make's internal database.
-q, --question Run no commands; exit status says if up to date.
-r, --no-builtin-rules Disable the built-in implicit rules.
-R, --no-builtin-variables Disable the built-in variable settings.
-s, --silent, --quiet Don't echo commands.
-S, --no-keep-going, --stop
Turns off -k.
-t, --touch Touch targets instead of remaking them.
-v, --version Print the version number of make and exit.
-w, --print-directory Print the current directory.
--no-print-directory Turn off -w, even if it was turned on implicitly.
-W FILE, --what-if=FILE, --new-file=FILE, --assume-new=FILE
Consider FILE to be infinitely new.
--warn-undefined-variables Warn when an undefined variable is referenced.
This program built for powerpc-apple-darwin6.8
Report bugs to <[email protected]>
To check XML flags files, runspec uses specrxp, which is simply RXP under a unique name to ensure no possible conflicts with other versions of rxp on your system. RXP is a validating XML parser. If your flags file passes RXP's tests, that doesn't mean that the flags file makes sense, but it's a start.
You don't have to know anything abour specrxp, as it is called automatically. But if you want to, you can call it directly, for example:
specrxp -V -s myflags.xml
The -V switch requests validation, and -s requests that all output be suppressed except error messages.
A manpage for rxp is available.
Once you have your flags file passing specrxp validation, you should do a flag_dump, and validate that the dump is valid HTML.
The specrxp utility is new with MPI2007 V1.1
If you have a rawfile, you can get information about the binary toolset and the versions of all of the system-independent tools files. To do so, use the toolsver utility.
For example, starting with a freshly-installed SPEC MPI2007 directory tree:
% runspec --config=try_utilities --size=mtest --iterations=1 \ --tuning=base --output_format=ps > /dev/null % cd $SPEC/result % ls MPIM2007.001.mtest.ps MPIM2007.001.mtest.rsf MPI2007.001.log lock.MPI2007
Note that we have just the single result file. Now, attempt to extract the version information:
% toolsver MPIM2007.001.mtest.rsf
MPIM2007.001.mtest.rsf:
Binary toolset used was 'solaris-sparc'
Versions of Perl-based tools:
1041 runspec
998 CPUFlagsParser.pm
1079 benchmark.pm
1029 benchset.pm
1052 benchset_common.pl
998 compare.pl
1029 config.pl
998 config_common.pl
998 flagutils.pl
1036 flagutils_common.pl
998 format.pm
1029 listfile.pm
998 locate.pl
1029 log.pl
998 log_common.pl
1024 monitor.pl
998 os.pl
998 os_common.pl
1041 output_raw.pl
1056 parse.pl
1029 setup.pl
1029 util.pl
1029 util_common.pl
1052 vars_common.pl
Copyright © 1999-2010 Standard Performance Evaluation Corporation
All Rights Reserved