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_PROCESS_CPUTIME_ID).  One can force
  31 the 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 Running benchmarks on another target:
  38 ====================================
  39
  40 If the target where you want to run benchmarks is not capable of building the
  41 code or you're cross-building, you could build and execute the benchmark in
  42 separate steps.  On the build system run:
  43
  44   $ make bench-build
  45
  46 and then copy the source and build directories to the target and run the
  47 benchmarks from the build directory as usual:
  48
  49   $ make bench
  50
  51 make sure the copy preserves timestamps by using either rsync or scp -p
  52 otherwise the above command may try to build the benchmark again.  Benchmarks
  53 that require generated code to be executed during the build are skipped when
  54 cross-building.
  55
  56 Running subsets of benchmarks:
  57 ==============================
  58
  59 To run only a subset of benchmarks, one may invoke make as follows
  60
  61   $ make bench BENCHSET="bench-pthread bench-math malloc-thread"
  62
  63 where BENCHSET may be a space-separated list of the following values:
  64
  65     bench-math
  66     bench-pthread
  67     bench-string
  68     string-benchset
  69     wcsmbs-benchset
  70     stdlib-benchset
  71     stdio-common-benchset
  72     math-benchset
  73     malloc-thread
  74
  75 Adding a function to benchtests:
  76 ===============================
  77
  78 If the name of the function is `foo', then the following procedure should allow
  79 one to add `foo' to the bench tests:
  80
  81 - Append the function name to the bench variable in the Makefile.
  82
  83 - Make a file called `foo-inputs` to provide the definition and input for the
  84   function.  The file should have some directives telling the parser script
  85   about the function and then one input per line.  Directives are lines that
  86   have a special meaning for the parser and they begin with two hashes '##'.
  87   The following directives are recognized:
  88
  89   - args: This should be assigned a colon separated list of types of the input
  90     arguments.  This directive may be skipped if the function does not take any
  91     inputs.  One may identify output arguments by nesting them in <>.  The
  92     generator will create variables to get outputs from the calling function.
  93   - ret: This should be assigned the type that the function returns.  This
  94     directive may be skipped if the function does not return a value.
  95   - includes: This should be assigned a comma-separated list of headers that
  96     need to be included to provide declarations for the function and types it
  97     may need (specifically, this includes using "#include <header>").
  98   - include-sources: This should be assigned a comma-separated list of source
  99     files that need to be included to provide definitions of global variables
 100     and functions (specifically, this includes using "#include "source").
 101     See pthread_once-inputs and pthreads_once-source.c for an example of how
 102     to use this to benchmark a function that needs state across several calls.
 103   - init: Name of an initializer function to call to initialize the benchtest.
 104   - name: See following section for instructions on how to use this directive.
 105
 106   Lines beginning with a single hash '#' are treated as comments.  See
 107   pow-inputs for an example of an input file.
 108
 109 Multiple execution units per function:
 110 =====================================
 111
 112 Some functions have distinct performance characteristics for different input
 113 domains and it may be necessary to measure those separately.  For example, some
 114 math functions perform computations at different levels of precision (64-bit vs
 115 240-bit vs 768-bit) and mixing them does not give a very useful picture of the
 116 performance of these functions.  One could separate inputs for these domains in
 117 the same file by using the `name' directive that looks something like this:
 118
 119   ##name: 240bit
 120
 121 See the pow-inputs file for an example of what such a partitioned input file
 122 would look like.
 123
 124 It is also possible to measure throughput of a (partial) trace extracted from
 125 a real workload.  In this case the whole trace is iterated over multiple times
 126 rather than repeating every input multiple times.  This can be done via:
 127
 128   ##name: workload-<name>
 129
 130 Benchmark Sets:
 131 ==============
 132
 133 In addition to standard benchmarking of functions, one may also generate
 134 custom outputs for a set of functions.  This is currently used by string
 135 function benchmarks where the aim is to compare performance between
 136 implementations at various alignments and for various sizes.
 137
 138 To add a benchset for `foo':
 139
 140 - Add `foo' to the benchset variable.
 141 - Write your bench-foo.c that prints out the measurements to stdout.
 142 - On execution, a bench-foo.out is created in $(objpfx) with the contents of
 143   stdout.
 144
 145 Reading String Benchmark Results:
 146 ================================
 147
 148 Some of the string benchmark results are now in JSON to make it easier to read
 149 in scripts.  Use the benchtests/compare_strings.py script to show the results
 150 in a tabular format, generate graphs and more. Run
 151
 152     benchtests/scripts/compare_strings.py -h
 153
 154 for usage information.