Contents
+ +The benchmark framework currently supports only Linux systems and the GCC and +Intel compilers. Every other configuration probably requires adjustment inside +the code and the makefiles. Further some code might be platform or at least +POSIX specific.
+The benchmark can be build via make from the src subdirectory. This will +generate one binary which hosts all implemented benchmark kernels.
+Binaries are located under the bin subdirectory and will have different names +depending on compiler and build configuration.
++make ++
Running make without any arguments builds the debug version (BUILD=debug) of +the benchmark kernels, where no optimizations are performed, line numbers and +debug symbols are included as well as DEBUG will be defined. The resulting +binary will be found in the bin subdirectory and named +lbmbenchk-linux-<compiler>-debug.
+Without any further specification the binary includes verification +(VERIFICATION=on), statistics (STATISTICS), and VTK output +(VTK_OUTPUT=on) enabled.
+Please note that the generated binary will therefore +exhibit a poor performance.
+To generate a binary for benchmarking run make with
++make BENCHMARK=on BUILD=release ++
Here BUILD=release turns optimizations on and BENCHMARK=on disables +verfification, statistics, and VTK output.
+Verification with the debug builds can be extremely slow. Hence verification +capabilities can be build with release builds:
++make BUILD=release ++
Currently only the GCC and Intel compiler under Linux are supported. Between +both configuration can be chosen via CONFIG=linux-gcc or +CONFIG=linux-intel.
+Options that can be specified when building the framework with make:
+| name | +values | +default | +description | +
| TARCH | +-- | +-- | +Via TARCH the architecture the compiler generates code for can be overriden. The value depends on the chose compiler. | +
| BENCHMARK | +on, off | +off | +If enabled, disables VERIFICATION, STATISTICS, VTK_OUTPUT. | +
| BUILD | +debug, release | +debug | +No optimization, debug symbols, DEBUG defined. | +
| CONFIG | +linux-gcc, linux-intel | +linux-intel | +Select GCC or Intel compiler. | +
| ISA | +avx, sse | +avx | +Determines which ISA extension is used for macro definitions. This is not the architecture the compiler generates code for. | +
| OPENMP | +on, off | +on | +OpenMP, i.,e.. threading support. | +
| STATISTICS | +on, off | +off | +View statistics, like density etc, during simulation. | +
| VERIFICATION | +on, off | +off | +Turn verification on/off. | +
| VTK_OUTPUT | +on, off | +off | +Enable/Disable VTK file output. | +
Running the binary will print among the GPL licence header a line like the following:
++LBM Benchmark Kernels 0.1, compiled Jul 5 2017 21:59:22, type: verification+
if verfication was enabled during compilation or
++LBM Benchmark Kernels 0.1, compiled Jul 5 2017 21:59:22, type: benchmark+
if verfication was disabled during compilation.
+Running the binary with -h list all available parameters:
+
+Usage:
+./lbmbenchk -list
+./lbmbenchk
+ [-dims XxYyZ] [-geometry box|channel|pipe|blocks[-<block size>]] [-iterations <iterations>] [-lattice-dump-ascii]
+ [-rho-in <density>] [-rho-out <density] [-omega <omega>] [-kernel <kernel>]
+ [-periodic-x]
+ [-t <number of threads>]
+ [-pin core{,core}*]
+ [-verify]
+ -- <kernel specific parameters>
+
+-list List available kernels.
+
+-dims XxYxZ Specify geometry dimensions.
+
+-geometry blocks-<block size>
+ Geometetry with blocks of size <block size> regularily layout out.
+
+If an option is specified multiple times the last one overrides previous ones. +This holds also true for -verify which sets geometry dimensions, +iterations, etc, which can afterward be override, e.g.:
++$ bin/lbmbenchk-linux-intel-release -verfiy -dims 32x32x32 ++
Kernel specific parameters can be opatained via selecting the specific kernel +and passing -h as parameter:
++$ bin/lbmbenchk-linux-intel-release -kernel -- -h +... +Kernel parameters: +[-blk <n>] [-blk-[xyz] <n>] ++
A list of all available kernels can be obtained via -list:
++$ ../bin/lbmbenchk-linux-gcc-debug -list +Lattice Boltzmann Benchmark Kernels (LbmBenchKernels) Copyright (C) 2016, 2017 LSS, RRZE +This program comes with ABSOLUTELY NO WARRANTY; for details see LICENSE. +This is free software, and you are welcome to redistribute it under certain conditions. + +LBM Benchmark Kernels 0.1, compiled Jul 5 2017 21:59:22, type: verification +Available kernels to benchmark: + list-aa-pv-soa + list-aa-ria-soa + list-aa-soa + list-aa-aos + list-pull-split-nt-1s-soa + list-pull-split-nt-2s-soa + list-push-soa + list-push-aos + list-pull-soa + list-pull-aos + push-soa + push-aos + pull-soa + pull-aos + blk-push-soa + blk-push-aos + blk-pull-soa + blk-pull-aos ++
Correct benchmarking is a nontrivial task. Whenever benchmark results should be +created make sure the binary was compiled with:
+During benchmarking pinning should be used via the -pin parameter. Running +a benchmark with 10 threads an pin them to the first 10 cores works like
++$ bin/lbmbenchk-linux-intel-release ... -t 10 -pin $(seq -s , 0 9) ++
Things the binary does nor check or controll:
+This work was funded by BMBF, grant no. 01IH15003A (project SKAMPY).
+This work was funded by KONWHIR project OMI4PAPS.
+Document was generated at 2017-10-26 09:43.
+