benchtests/Makefile

   1 # Copyright (C) 2013-2017 Free Software Foundation, Inc.
   2 # This file is part of the GNU C Library.
   3
   4 # The GNU C Library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8
   9 # The GNU C Library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with the GNU C Library; if not, see
  16 # <http://www.gnu.org/licenses/>.
  17
  18 # Makefile for benchmark tests.  The only useful target here is `bench`.
  19 # Add benchmark functions in alphabetical order.
  20
  21 subdir := benchtests
  22
  23 include ../Makeconfig
  24 bench-math := acos acosh asin asinh atan atanh cos cosh exp exp2 log log2 \
  25               modf pow rint sin sincos sinh sqrt tan tanh fmin fmax fminf \
  26               fmaxf
  27
  28 bench-pthread := pthread_once
  29
  30 bench-string := ffs ffsll
  31
  32 bench := $(bench-math) $(bench-pthread) $(bench-string)
  33
  34 # String function benchmarks.
  35 string-benchset := bcopy bzero memccpy memchr memcmp memcpy memmem memmove \
  36                    mempcpy memset rawmemchr stpcpy stpncpy strcasecmp strcasestr \
  37                    strcat strchr strchrnul strcmp strcpy strcspn strlen \
  38                    strncasecmp strncat strncmp strncpy strnlen strpbrk strrchr \
  39                    strspn strstr strcpy_chk stpcpy_chk memrchr strsep strtok \
  40                    strcoll memcpy-large memmove-large memset-large
  41
  42 # Build and run locale-dependent benchmarks only if we're building natively.
  43 ifeq (no,$(cross-compiling))
  44 wcsmbs-benchset := wcslen wcsnlen wcscpy wcpcpy wcsncpy wcpncpy wcscat wcsncat \
  45                    wcscmp wcsncmp wcschr wcschrnul wcsrchr wcsspn wcspbrk wcscspn \
  46                    wmemchr wmemset wmemcmp
  47 else
  48 wcsmbs-benchset :=
  49 endif
  50
  51 string-benchset-all := $(string-benchset) ${wcsmbs-benchset}
  52
  53 ifeq (no,$(cross-compiling))
  54 # We have to generate locales
  55 LOCALES := en_US.UTF-8 tr_TR.UTF-8 cs_CZ.UTF-8 fa_IR.UTF-8 fr_FR.UTF-8 \
  56            ja_JP.UTF-8 si_LK.UTF-8 en_GB.UTF-8 vi_VN.UTF-8 ar_SA.UTF-8 \
  57            da_DK.UTF-8 pl_PL.UTF-8 pt_PT.UTF-8 el_GR.UTF-8 ru_RU.UTF-8 \
  58            he_IL.UTF-8 is_IS.UTF-8 es_ES.UTF-8 hi_IN.UTF-8 sv_SE.UTF-8 \
  59            hu_HU.UTF-8 it_IT.UTF-8 sr_RS.UTF-8 zh_CN.UTF-8
  60 include ../gen-locales.mk
  61 endif
  62
  63 stdlib-benchset := strtod
  64
  65 stdio-common-benchset := sprintf
  66
  67 math-benchset := math-inlines
  68
  69 benchset := $(string-benchset-all) $(stdlib-benchset) $(stdio-common-benchset) \
  70             $(math-benchset)
  71
  72 CFLAGS-bench-ffs.c += -fno-builtin
  73 CFLAGS-bench-ffsll.c += -fno-builtin
  74 CFLAGS-bench-sqrt.c += -fno-builtin
  75 CFLAGS-bench-fmin.c += -fno-builtin
  76 CFLAGS-bench-fminf.c += -fno-builtin
  77 CFLAGS-bench-fmax.c += -fno-builtin
  78 CFLAGS-bench-fmaxf.c += -fno-builtin
  79
  80 bench-malloc := malloc-thread
  81
  82 $(addprefix $(objpfx)bench-,$(bench-math)): $(libm)
  83 $(addprefix $(objpfx)bench-,$(math-benchset)): $(libm)
  84 $(addprefix $(objpfx)bench-,$(bench-pthread)): $(shared-thread-library)
  85 $(objpfx)bench-malloc-thread: $(shared-thread-library)
  86
  87 \f
  88
  89 # Rules to build and execute the benchmarks.  Do not put any benchmark
  90 # parameters beyond this point.
  91
  92 # We don't want the benchmark programs to run in parallel since that could
  93 # affect their performance.
  94 .NOTPARALLEL:
  95
  96 include ../Rules
  97
  98 binaries-bench := $(addprefix $(objpfx)bench-,$(bench))
  99 binaries-benchset := $(addprefix $(objpfx)bench-,$(benchset))
 100 binaries-bench-malloc := $(addprefix $(objpfx)bench-,$(bench-malloc))
 101
 102 # The default duration: 10 seconds.
 103 ifndef BENCH_DURATION
 104 BENCH_DURATION := 10
 105 endif
 106
 107 CPPFLAGS-nonlib += -DDURATION=$(BENCH_DURATION)
 108
 109 # Use clock_gettime to measure performance of functions.  The default is to use
 110 # HP_TIMING if it is available.
 111 ifdef USE_CLOCK_GETTIME
 112 CPPFLAGS-nonlib += -DUSE_CLOCK_GETTIME
 113 endif
 114
 115 DETAILED_OPT :=
 116
 117 ifdef DETAILED
 118 DETAILED_OPT := -d
 119 endif
 120
 121 # This makes sure CPPFLAGS-nonlib and CFLAGS-nonlib are passed
 122 # for all these modules.
 123 cpp-srcs-left := $(binaries-benchset:=.c) $(binaries-bench:=.c) \
 124                  $(binaries-bench-malloc:=.c)
 125 lib := nonlib
 126 include $(patsubst %,$(..)cppflags-iterator.mk,$(cpp-srcs-left))
 127
 128 bench-extra-objs = json-lib.o
 129
 130 extra-objs += $(bench-extra-objs)
 131
 132 bench-deps := bench-skeleton.c bench-timing.h Makefile
 133
 134 run-bench = $(test-wrapper-env) \
 135             $(run-program-env) \
 136             $($*-ENV) $(test-via-rtld-prefix) $${run}
 137
 138 timing-type := $(objpfx)bench-timing-type
 139
 140 bench-clean:
 141         rm -f $(binaries-bench) $(addsuffix .o,$(binaries-bench))
 142         rm -f $(binaries-benchset) $(addsuffix .o,$(binaries-benchset))
 143         rm -f $(binaries-bench-malloc) $(addsuffix .o,$(binaries-bench-malloc))
 144         rm -f $(timing-type) $(addsuffix .o,$(timing-type))
 145         rm -f $(addprefix $(objpfx),$(bench-extra-objs))
 146
 147 # Define the bench target only if the target has a usable python installation.
 148 ifdef PYTHON
 149 bench: bench-build bench-set bench-func bench-malloc
 150 else
 151 bench:
 152         @echo "The bench target needs python to run."
 153         @exit 1
 154 endif
 155
 156 # Target to only build the benchmark without running it.  We generate locales
 157 # only if we're building natively.
 158 ifeq (no,$(cross-compiling))
 159 bench-build: $(gen-locales) $(timing-type) $(binaries-bench) \
 160         $(binaries-benchset) $(binaries-bench-malloc)
 161 else
 162 bench-build: $(timing-type) $(binaries-bench) $(binaries-benchset) \
 163         $(binaries-bench-malloc)
 164 endif
 165
 166 bench-set: $(binaries-benchset)
 167         for run in $^; do \
 168           echo "Running $${run}"; \
 169           $(run-bench) > $${run}.out; \
 170         done
 171
 172 bench-malloc: $(binaries-bench-malloc)
 173         run=$(objpfx)bench-malloc-thread; \
 174         for thr in 1 8 16 32; do \
 175           echo "Running $${run} $${thr}"; \
 176           $(run-bench) $${thr} > $${run}-$${thr}.out; \
 177         done
 178
 179 # Build and execute the benchmark functions.  This target generates JSON
 180 # formatted bench.out.  Each of the programs produce independent JSON output,
 181 # so one could even execute them individually and process it using any JSON
 182 # capable language or tool.
 183 bench-func: $(binaries-bench)
 184         { timing_type=$$($(timing-type)); \
 185         echo "{\"timing_type\": \"$${timing_type}\","; \
 186         echo " \"functions\": {"; \
 187         for run in $^; do \
 188           if ! [ "x$${run}" = "x$<" ]; then \
 189             echo ","; \
 190           fi; \
 191           echo "Running $${run}" >&2; \
 192           $(run-bench) $(DETAILED_OPT); \
 193         done; \
 194         echo; \
 195         echo " }"; \
 196         echo "}"; } > $(objpfx)bench.out-tmp; \
 197         if [ -f $(objpfx)bench.out ]; then \
 198           mv -f $(objpfx)bench.out $(objpfx)bench.out.old; \
 199         fi; \
 200         mv -f $(objpfx)bench.out-tmp $(objpfx)bench.out
 201         $(PYTHON) scripts/validate_benchout.py $(objpfx)bench.out \
 202                 scripts/benchout.schema.json
 203
 204 $(timing-type) $(binaries-bench) $(binaries-benchset) \
 205         $(binaries-bench-malloc): %: %.o $(objpfx)json-lib.o \
 206         $(link-extra-libs-tests) \
 207   $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
 208   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
 209         $(+link-tests)
 210
 211 $(objpfx)bench-%.c: %-inputs $(bench-deps)
 212         { if [ -n "$($*-INCLUDE)" ]; then \
 213           cat $($*-INCLUDE); \
 214         fi; \
 215         $(PYTHON) scripts/bench.py $(patsubst %-inputs,%,$<); } > $@-tmp
 216         mv -f $@-tmp $@