...
 
Commits (226)

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.

{
"project.name" : "nofib",
"repository.callsign" : "NOFIB",
"phabricator.uri" : "https://phabricator.haskell.org"
}
# Generated file patterns # Generated file patterns
*.exe
*.o *.o
*.hi *.hi
.depend .depend
.depend.bak .depend.bak
cachegrind.out.* cachegrind.out.*
cachegrind.out.summary cachegrind.out.summary
perf.data
perf.data.*
dist-newstyle/
.ghc.environment.*
# Specific generated files # Specific generated files
nofib-analyse/nofib-analyse nofib-analyse/nofib-analyse
runstdtest/runstdtest runstdtest/runstdtest
imaginary/bernouilli/bernouilli imaginary/bernouilli/bernouilli
imaginary/digits-of-e1/digits-of-e1
imaginary/digits-of-e2/digits-of-e2
imaginary/exp3_8/exp3_8 imaginary/exp3_8/exp3_8
imaginary/gen_regexps/gen_regexps imaginary/gen_regexps/gen_regexps
imaginary/integrate/integrate imaginary/integrate/integrate
...@@ -22,12 +29,20 @@ imaginary/tak/tak ...@@ -22,12 +29,20 @@ imaginary/tak/tak
imaginary/wheel-sieve1/wheel-sieve1 imaginary/wheel-sieve1/wheel-sieve1
imaginary/wheel-sieve2/wheel-sieve2 imaginary/wheel-sieve2/wheel-sieve2
imaginary/x2n1/x2n1 imaginary/x2n1/x2n1
imaginary/kahan/kahan
real/anna/anna real/anna/anna
real/bspt/bspt real/bspt/bspt
real/cacheprof/cacheprof real/cacheprof/cacheprof
real/compress/compress real/compress/compress
real/compress2/compress2 real/compress2/compress2
real/eff/CS/CS
real/eff/CSD/CSD
real/eff/FS/FS
real/eff/S/S
real/eff/VS/VS
real/eff/VSD/VSD
real/eff/VSM/VSM
real/fem/fem real/fem/fem
real/fluid/fluid real/fluid/fluid
real/fulsom/fulsom real/fulsom/fulsom
...@@ -38,7 +53,8 @@ real/hidden/hidden ...@@ -38,7 +53,8 @@ real/hidden/hidden
real/hpg/hpg real/hpg/hpg
real/infer/infer real/infer/infer
real/lift/lift real/lift/lift
real/maillist/addresses.tex real/linear/linear
real/maillist/runtime_files/*.tex
real/maillist/maillist real/maillist/maillist
real/mkhprog/mkhprog real/mkhprog/mkhprog
real/parser/parser real/parser/parser
...@@ -50,10 +66,39 @@ real/scs/scs ...@@ -50,10 +66,39 @@ real/scs/scs
real/symalg/symalg real/symalg/symalg
real/veritas/veritas real/veritas/veritas
shootout/binary-trees/binary-trees
shootout/fannkuch-redux/fannkuch-redux
shootout/fasta/fasta
shootout/fasta/fasta-c
shootout/fasta/fasta.faststdout
shootout/fasta/fasta.slowstdout
shootout/fasta/fasta.stdout
shootout/k-nucleotide/fasta-c
shootout/k-nucleotide/k-nucleotide
shootout/k-nucleotide/k-nucleotide.faststdin
shootout/k-nucleotide/k-nucleotide.slowstdin
shootout/k-nucleotide/k-nucleotide.stdin
shootout/n-body/n-body
shootout/pidigits/pidigits
shootout/reverse-complement/fasta-c
shootout/reverse-complement/revcomp-c
shootout/reverse-complement/reverse-complement.faststdin
shootout/reverse-complement/reverse-complement.slowstdin
shootout/reverse-complement/reverse-complement.stdin
shootout/reverse-complement/reverse-complement
shootout/reverse-complement/reverse-complement.faststdout
shootout/reverse-complement/reverse-complement.slowstdout
shootout/reverse-complement/reverse-complement.stdout
shootout/spectral-norm/spectral-norm
spectral/ansi/ansi spectral/ansi/ansi
spectral/atom/atom spectral/atom/atom
spectral/awards/awards spectral/awards/awards
spectral/awards/*.stdout
spectral/awards/*.slowstdout
spectral/banner/banner spectral/banner/banner
spectral/banner/*stdout
spectral/banner/*stdin
spectral/boyer/boyer spectral/boyer/boyer
spectral/boyer2/boyer2 spectral/boyer2/boyer2
spectral/calendar/calendar spectral/calendar/calendar
...@@ -64,7 +109,9 @@ spectral/constraints/constraints ...@@ -64,7 +109,9 @@ spectral/constraints/constraints
spectral/cryptarithm1/cryptarithm1 spectral/cryptarithm1/cryptarithm1
spectral/cryptarithm2/cryptarithm2 spectral/cryptarithm2/cryptarithm2
spectral/cse/cse spectral/cse/cse
spectral/dom-lt/dom-lt
spectral/eliza/eliza spectral/eliza/eliza
spectral/exact-reals/exact-reals
spectral/expert/expert spectral/expert/expert
spectral/fft2/fft2 spectral/fft2/fft2
spectral/fibheaps/fibheaps spectral/fibheaps/fibheaps
...@@ -87,10 +134,13 @@ spectral/hartel/wang/wang ...@@ -87,10 +134,13 @@ spectral/hartel/wang/wang
spectral/hartel/wave4main/wave4main spectral/hartel/wave4main/wave4main
spectral/integer/integer spectral/integer/integer
spectral/knights/knights spectral/knights/knights
spectral/lambda/lambda
spectral/last-piece/last-piece
spectral/lcss/lcss spectral/lcss/lcss
spectral/life/life spectral/life/life
spectral/mandel/mandel spectral/mandel/mandel
spectral/mandel2/mandel2 spectral/mandel2/mandel2
spectral/mate/mate
spectral/minimax/minimax spectral/minimax/minimax
spectral/multiplier/multiplier spectral/multiplier/multiplier
spectral/para/para spectral/para/para
...@@ -117,6 +167,7 @@ gc/mutstore1/mutstore1 ...@@ -117,6 +167,7 @@ gc/mutstore1/mutstore1
gc/mutstore2/mutstore2 gc/mutstore2/mutstore2
gc/power/power gc/power/power
gc/spellcheck/spellcheck gc/spellcheck/spellcheck
gc/treejoin/treejoin
parallel/blackscholes/blackscholes parallel/blackscholes/blackscholes
parallel/coins/coins parallel/coins/coins
......
variables:
DOCKER_REV: 2b69e99de97bd5bf1fbdbf45852231c3dcb602b6
validate:
image: "registry.gitlab.haskell.org/ghc/ci-images/x86_64-linux-deb9:$DOCKER_REV"
tags:
- x86_64-linux
before_script:
- git clean -xdf
- sudo apt install -y time
- ghc --version
- cabal --version
script:
- make clean
- cabal update
- make boot mode=fast
- "make mode=fast NoFibRuns=1 2>&1 | tee log"
- "nofib-analyse/nofib-analyse log"
- |
# The following checks that `make distclean` removes any files reported
# by `git clean -fxd`
make distclean
files=$(git clean -nxd | cut -d" " -f3 | sed "/log/d")
if ! [ -z $files ]
then
echo "The following files weren't cleaned:\n$files"
exit 1
fi
# Syntax: https://docs.gitlab.com/ee/user/project/code_owners.html
* @sgraf812 @bgamari
\ No newline at end of file
...@@ -28,7 +28,7 @@ SUBDIRS = runstdtest nofib-analyse $(NoFibSubDirs) ...@@ -28,7 +28,7 @@ SUBDIRS = runstdtest nofib-analyse $(NoFibSubDirs)
# #
SRC_DIST_DIR=$(shell pwd)/nofib SRC_DIST_DIR=$(shell pwd)/nofib
SRC_DIST_NAME=nofib SRC_DIST_NAME=nofib
SRC_DIST_DIRS=docs fibon gc imaginary smp spectral real parallel mk SRC_DIST_DIRS=docs fibon gc imaginary smp spectral real parallel mk shootout
dist :: nofib-dist-pre dist :: nofib-dist-pre
include $(TOP)/mk/target.mk include $(TOP)/mk/target.mk
......
This is the root directory of the "NoFib Haskell benchmark suite". It
should be part of a GHC source tree, that is the 'nofib' directory
should be at the same level in the tree as 'compiler' and 'libraries'.
To run the tests:
$ make clean
$ make boot
$ make 2>&1 | tee nofib-log
will put the results in the file 'nofib-log'. You can pass extra options to a
nofib run using the EXTRA_HC_OPTS variable like this:
$ make clean
$ make boot
$ make EXTRA_HC_OPTS="-fllvm" >&1 | tee nofib-llvm-log
To compare the results of multiple runs, use the program in
../utils/nofib-analyse. Something like this:
$ nofib-analyse nofib-log-6.4.2 nofib-log-6.6
to generate a comparison of the runs in captured in 'nofib-log-6.4.2'
and 'nofib-log-6.6'. When making comparisons, be careful to ensure
that the things that changed between the builds are only the things
that you *wanted* to change. There are lots of variables: machine,
GHC version, GCC version, C libraries, static vs. dynamic GMP library,
build options, run options, and probably lots more. To be on the safe
side, make both runs on the same unloaded machine.
To get instruction counts, memory reads/writes, and "cache misses",
you'll need to get hold of Cachegrind, which is part of Valgrind
(http://valgrind.org).
There are some options you might want to tweak; search for nofib in
../mk/config.mk, and override settings in ../mk/build.mk as usual.
Package Requirements:
* html
* regex-compat (mtl, regex-base, regex-posix)
* stm (for smp benches)
# NoFib: Haskell Benchmark Suite
This is the root directory of the "NoFib Haskell benchmark suite". It
should be part of a GHC source tree, that is the 'nofib' directory
should be at the same level in the tree as 'compiler' and 'libraries'.
This makes sure that NoFib picks up the stage 2 compiler from the
surrounding GHC source tree.
You can also clone this repository in isolation, in which case it will
pick `$(which ghc)` or whatever the `HC` environment variable is set to.
Additional information can also be found on
[NoFib's wiki page](https://ghc.haskell.org/trac/ghc/wiki/Building/RunningNoFib).
There's also a `easy.sh` helper script, which as name implies, is
automated and easy way to run `nofib`.
See the section at the end of README for its usage.
## Using
<details>
<summary>Git symlink support for Windows machines</summary>
NoFib uses a few symlinks here and there to share code between benchmarks.
Git for Windows has symlinks support for some time now, but
[it may not be enabled by default](https://stackoverflow.com/a/42137273/388010).
You will notice strange `make boot` failures if it's not enabled for you.
Make sure you follow the instructions in the link to enable symlink support,
possibly as simple as through `git config core.symlinks true` or cloning with
`git clone -c core.symlinks=true <URL>`.
</details>
Install [`cabal-install-2.4`](https://www.haskell.org/cabal/download.html) or later.
Then, to run the tests, execute:
```
$ make clean # or git clean -fxd, it's faster
$ # Generates input files for the benchmarks and builds compilation
$ # dependencies for make (ghc -M)
$ make boot
$ # Builds the benchmarks and runs them $NoFibRuns (default: 5) times
$ make
```
This will put the results in the file `nofib-log`. You can pass extra
options to a nofib run using the `EXTRA_HC_OPTS` variable like this:
```
$ make clean
$ make boot
$ make EXTRA_HC_OPTS="-fllvm"
```
**Note:** to get all the results, you have to `clean` and `boot` between
separate `nofib` runs.
To compare the results of multiple runs, save the output in a logfile
and use the program in `./nofib-analyse/nofib-analyse`, for example:
```
...
$ make 2>&1 | tee nofib-log-6.4.2
...
$ make 2>&1 | tee nofib-log-6.6
$ nofib-analyse nofib-log-6.4.2 nofib-log-6.6 | less
```
to generate a comparison of the runs in captured in `nofib-log-6.4.2`
and `nofib-log-6.6`. When making comparisons, be careful to ensure
that the things that changed between the builds are only the things
that you _wanted_ to change. There are lots of variables: machine,
GHC version, GCC version, C libraries, static vs. dynamic GMP library,
build options, run options, and probably lots more. To be on the safe
side, make both runs on the same unloaded machine.
## Modes
Each benchmark is runnable in three different time `mode`s:
- `fast`: 0.1-0.2s
- `norm`: 1-2s
- `slow`: 5-10s
You can control which mode to run by setting an additional `mode` variable for
`make`. The default is `mode=norm`. Example for `mode=fast`:
```
$ make clean
$ make boot mode=fast
$ make mode=fast
```
Note that the `mode`s set in `make boot` and `make` need to agree. Otherwise you
will get output errors, because `make boot` will generate input files for a
different `mode`. A more DRY way to control the `mode` would be
```
$ make clean
$ export mode=fast
$ make boot
$ make
```
As CPU architectures advance, the above running times may drift and
occasionally, all benchmarks will need adjustments.
Be aware that `nofib-analyse` will ignore the result if it falls below 0.2s.
This is the default of its `-i` option, which is of course incompatible with
`mode=fast`. In that case, you should just set `-i` as appropriate, even
deactivate it with `-i 0`.
## Boot vs. benchmarked GHC
The `nofib-analyse` utility is compiled with `BOOT_HC` compiler,
which may be different then the GHC under the benchmark.
You can control which GHC you benchmark with `HC` variable
```
$ make clean
$ make boot HC=ghc-head
$ make HC=ghc-head 2>&1 | tee nofib-log-ghc-head
```
## Configuration
There are some options you might want to tweak; search for nofib in
`../mk/config.mk`, and override settings in `../mk/build.mk` as usual.
## Extra Metrics: Valgrind
To get instruction counts, memory reads/writes, and "cache misses",
you'll need to get hold of Cachegrind, which is part of
[Valgrind](http://valgrind.org).
You can then pass `-cachegrind` as `EXTRA_RUNTEST_OPTS`. Counting
instructions slows down execution by a factor of ~30. But it's
a deterministic metric, so you can combine it with `NoFibRuns=1`:
```
$ (make EXTRA_RUNTEST_OPTS="-cachegrind" NoFibRuns=1) 2>&1 | tee nofib-log
```
Optionally combine this with `mode=fast`, see [Modes](#modes).
## Extra Packages
Some benchmarks aren't run by default and require extra packages are
installed for the GHC compiler being tested. These packages include:
* `old-time`: for `gc` benchmarks
* `stm`: for smp benchmarks
* `parallel`: for parallel benchmarks
* `random`: for various benchmarks
These can be installed with
```
cabal v1-install --allow-newer -w $HC random parallel old-time
````
## Adding benchmarks
If you add a benchmark try to set the problem sizes for
fast/normal/slow reasonably. [Modes](#modes) lists the recommended brackets for
each mode.
### Benchmark Categories
So you have a benchmark to submit but don't know in which subfolder to put it? Here's some
advice on the intended semantics of each category.
#### Single threaded benchmarks
These are run when you just type `make`. Their semantics is explained in
[the Nofib paper](https://link.springer.com/chapter/10.1007%2F978-1-4471-3215-8_17)
(You can find a .ps online, thanks to @bgamari. Alternatively grep for
'Spectral' in docs/paper/paper.verb).
- `imaginary`: Mostly toy benchmarks, solving puzzles like n-queens.
- `spectral`: Algorithmic kernels, like FFT. If you want to add a benchmark of a
library, this most certainly the place to put it.
- `real`: Actual applications, with a command-line interface and all. Because of
the large dependency footprint of today's applications, these have become
rather aged.
- `shootout`: Benchmarks from
[the benchmarks game](https://benchmarksgame-team.pages.debian.net/benchmarksgame/),
formerly known as "language shootout".
Most of the benchmarks are quite old and aren't really written in way one would
write high-performance Haskell code today (e.g., use of `String`, lists,
redefining own list combinators that don't take part in list fusion, rare use of
strictness annotations or unboxed data), so new benchmarks for the `real` and
`spectral` in brackets in particular are always welcome!
#### Other categories
Other than the default single-threaded categories above, there are the
following (SG: I'm guessing here, have never run them):
- `gc`: Run by `make -C gc` (though you'll probably have to edit the Makefile to
your specific config). Select benchmarks from `spectral` and `real`, plus a
few more (Careful, these have not been touched by #15999/!5, see the next
subsection). Testdrives different GC configs, apparently.
- `smp`: Microbenchmarks for the `-threaded` runtime, measuring scheduler
performance on concurrent and STM-heavy code.
### Stability wrt. GC paramerisations
Additionally, pay attention that your benchmarks are stable wrt. different
GC paramerisations, so that small changes in allocation don't lead to big,
unexplicable jumps in performance. See #15999 for details. Also make sure
that you run the benchmark with the default GC settings, as enlarging Gen 0 or
Gen 1 heaps just amplifies the problem.
As a rule of thumb on how to ensure this: Make sure that your benchmark doesn't
just build up one big data and consume it in a final step, but rather that the
working set grows and shrinks (e.g. is approximately constant) over the whole
run of the benchmark. You can ensure this by iterating your main logic `$n`
times (how often depends on your program, but in the ball park of 100-1000).
You can test stability by plotting productivity curves for your `fast` settings
with the `prod.py` script attached to #15999.
If in doubt, ask Sebastian Graf for help.
## Important notes
Note that some of these tests (e.g. `spectral/fish`) tend to be very sensitive
to branch predictor effectiveness. This means that changes in the compiler
can easily be masked by "random" fluctuations in the code layout produced by
particular compiler runs. Recent GHC versions provide the `-fproc-alignment`
flag to pad procedures, ensuring slightly better stability across runs. If you
are seeing an unexpected change in performance try adding `-fproc-alignment=64`
the compiler flags of both your baseline and test tree.
## easy.sh
```
./easy.sh - easy nofib
Usage: ./easy.sh [ -m mode ] /path/to/baseline/ghc /path/to/new/ghc"