benchtests/README

   1 Using the glibc microbenchmark suite
   2 ====================================
   3
   4 The glibc microbenchmark suite automatically generates code for specified
   5 functions, builds and calls them repeatedly for given inputs to give some
   6 basic performance properties of the function.
   7
   8 Running the benchmark:
   9 =====================
  10
  11 The benchmark needs python 2.7 or later in addition to the
  12 dependencies required to build the GNU C Library.  One may run the
  13 benchmark by invoking make as follows:
  14
  15   $ make bench
  16
  17 This runs each function for 10 seconds and appends its output to
  18 benchtests/bench.out.  To ensure that the tests are rebuilt, one could run:
  19
  20   $ make bench-clean
  21
  22 The duration of each test can be configured setting the BENCH_DURATION variable
  23 in the call to make.  One should run `make bench-clean' before changing
  24 BENCH_DURATION.
  25
  26   $ make BENCH_DURATION=1 bench
  27
  28 The benchmark suite does function call measurements using architecture-specific
  29 high precision timing instructions whenever available.  When such support is
  30 not available, it uses clock_gettime (CLOCK_MONOTONIC).  One can force the
  31 benchmark to use clock_gettime by invoking make as follows:
  32
  33   $ make USE_CLOCK_GETTIME=1 bench
  34
  35 Again, one must run `make bench-clean' before changing the measurement method.
  36
  37 On x86 processors, RDTSCP instruction provides more precise timing data
  38 than RDTSC instruction.  All x86 processors since 2010 support RDTSCP
  39 instruction.  One can force the benchmark to use RDTSCP by invoking make
  40 as follows:
  41
  42   $ make USE_RDTSCP=1 bench
  43
  44 One must run `make bench-clean' before changing the measurement method.
  45
  46 Running benchmarks on another target:
  47 ====================================
  48
  49 If the target where you want to run benchmarks is not capable of building the
  50 code or you're cross-building, you could build and execute the benchmark in
  51 separate steps.  On the build system run:
  52
  53   $ make bench-build
  54
  55 and then copy the source and build directories to the target and run the
  56 benchmarks from the build directory as usual:
  57
  58   $ make bench
  59
  60 make sure the copy preserves timestamps by using either rsync or scp -p
  61 otherwise the above command may try to build the benchmark again.  Benchmarks
  62 that require generated code to be executed during the build are skipped when
  63 cross-building.
  64
  65 Building benchmarks as static executables:
  66 =========================================
  67
  68 To build benchmarks as static executables, on the build system, run:
  69
  70   $ make STATIC-BENCHTESTS=yes bench-build
  71
  72 You can copy benchmark executables to another machine and run them
  73 without copying the source nor build directories.
  74
  75 Running subsets of benchmarks:
  76 ==============================
  77
  78 To run only a subset of benchmarks, one may invoke make as follows
  79
  80   $ make bench BENCHSET="bench-pthread bench-math malloc-thread"
  81
  82 where BENCHSET may be a space-separated list of the following values:
  83
  84     bench-math
  85     bench-pthread
  86     bench-string
  87     string-benchset
  88     wcsmbs-benchset
  89     stdlib-benchset
  90     stdio-common-benchset
  91     math-benchset
  92     malloc-thread
  93
  94 Adding a function to benchtests:
  95 ===============================
  96
  97 If the name of the function is `foo', then the following procedure should allow
  98 one to add `foo' to the bench tests:
  99
 100 - Append the function name to the bench variable in the Makefile.
 101
 102 - Make a file called `foo-inputs` to provide the definition and input for the
 103   function.  The file should have some directives telling the parser script
 104   about the function and then one input per line.  Directives are lines that
 105   have a special meaning for the parser and they begin with two hashes '##'.
 106   The following directives are recognized:
 107
 108   - args: This should be assigned a colon separated list of types of the input
 109     arguments.  This directive may be skipped if the function does not take any
 110     inputs.  One may identify output arguments by nesting them in <>.  The
 111     generator will create variables to get outputs from the calling function.
 112   - ret: This should be assigned the type that the function returns.  This
 113     directive may be skipped if the function does not return a value.
 114   - includes: This should be assigned a comma-separated list of headers that
 115     need to be included to provide declarations for the function and types it
 116     may need (specifically, this includes using "#include <header>").
 117   - include-sources: This should be assigned a comma-separated list of source
 118     files that need to be included to provide definitions of global variables
 119     and functions (specifically, this includes using "#include "source").
 120     See pthread_once-inputs and pthreads_once-source.c for an example of how
 121     to use this to benchmark a function that needs state across several calls.
 122   - init: Name of an initializer function to call to initialize the benchtest.
 123   - name: See following section for instructions on how to use this directive.
 124
 125   Lines beginning with a single hash '#' are treated as comments.  See
 126   pow-inputs for an example of an input file.
 127
 128 Multiple execution units per function:
 129 =====================================
 130
 131 Some functions have distinct performance characteristics for different input
 132 domains and it may be necessary to measure those separately.  For example, some
 133 math functions perform computations at different levels of precision (64-bit vs
 134 240-bit vs 768-bit) and mixing them does not give a very useful picture of the
 135 performance of these functions.  One could separate inputs for these domains in
 136 the same file by using the `name' directive that looks something like this:
 137
 138   ##name: 240bits
 139
 140 All inputs after the ##name: 240bits directive and until the next `name'
 141 directive (or the end of file) are part of the "240bits" benchmark and
 142 will be output separately in benchtests/bench.out.  See the pow-inputs file
 143 for an example of what such a partitioned input file would look like.
 144
 145 It is also possible to measure latency and reciprocal throughput of a
 146 (partial) trace extracted from a real workload.  In this case the whole trace
 147 is iterated over multiple times rather than repeating every input multiple
 148 times.  This can be done via:
 149
 150   ##name: workload-<name>
 151
 152 where <name> is simply used to distinguish between different traces in the
 153 same file.  To create such a trace, you can simply extract using printf()
 154 values uses for a specific application, or generate random values in some
 155 interval.  See the expf-inputs file for an example of this workload mechanism.
 156
 157 Benchmark Sets:
 158 ==============
 159
 160 In addition to standard benchmarking of functions, one may also generate
 161 custom outputs for a set of functions.  This is currently used by string
 162 function benchmarks where the aim is to compare performance between
 163 implementations at various alignments and for various sizes.
 164
 165 To add a benchset for `foo':
 166
 167 - Add `foo' to the benchset variable.
 168 - Write your bench-foo.c that prints out the measurements to stdout.
 169 - On execution, a bench-foo.out is created in $(objpfx) with the contents of
 170   stdout.
 171
 172 Reading String Benchmark Results:
 173 ================================
 174
 175 Some of the string benchmark results are now in JSON to make it easier to read
 176 in scripts.  Use the benchtests/compare_strings.py script to show the results
 177 in a tabular format, generate graphs and more. Run
 178
 179     benchtests/scripts/compare_strings.py -h
 180
 181 for usage information.