update to version from Seq no More paper
[nofib.git] / README
1 This is the root directory of the "NoFib Haskell benchmark suite".  It
2 should be part of a GHC source tree, that is the 'nofib' directory
3 should be at the same level in the tree as 'compiler' and 'libraries'.
4
5 To run the tests:
6
7   $ make clean
8   $ make boot
9   $ make 2>&1 | tee nofib-log
10
11 will put the results in the file 'nofib-log'.
12
13 To compare the results of multiple runs, use the program in
14 ../utils/nofib-analyse.  Something like this:
15
16   $ nofib-analyse nofib-log-6.4.2 nofib-log-6.6
17
18 to generate a comparison of the runs in captured in 'nofib-log-6.4.2'
19 and 'nofib-log-6.6'.  When making comparisons, be careful to ensure
20 that the things that changed between the builds are only the things
21 that you *wanted* to change.  There are lots of variables: machine,
22 GHC version, GCC version, C libraries, static vs. dynamic GMP library,
23 build options, run options, and probably lots more.  To be on the safe
24 side, make both runs on the same unloaded machine.
25
26 To get instruction counts, memory reads/writes, and "cache misses",
27 you'll need to get hold of Cachegrind, which is part of Valgrind
28 (http://valgrind.org).
29
30 There are some options you might want to tweak; search for nofib in
31 ../mk/config.mk, and override settings in ../mk/build.mk as usual.