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 powf trunc truncf
  27
  28 bench-pthread := pthread_once thread_create
  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 memcpy-random 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 CFLAGS-bench-trunc.c += -fno-builtin
  80 CFLAGS-bench-truncf.c += -fno-builtin
  81
  82 bench-malloc := malloc-thread
  83
  84 $(addprefix $(objpfx)bench-,$(bench-math)): $(libm)
  85 $(addprefix $(objpfx)bench-,$(math-benchset)): $(libm)
  86 $(addprefix $(objpfx)bench-,$(bench-pthread)): $(shared-thread-library)
  87 $(objpfx)bench-malloc-thread: $(shared-thread-library)
  88
  89 \f
  90
  91 # Rules to build and execute the benchmarks.  Do not put any benchmark
  92 # parameters beyond this point.
  93
  94 # We don't want the benchmark programs to run in parallel since that could
  95 # affect their performance.
  96 .NOTPARALLEL:
  97
  98 bench-extra-objs = json-lib.o
  99
 100 extra-objs += $(bench-extra-objs)
 101 others-extras = $(bench-extra-objs)
 102
 103 include ../Rules
 104
 105 binaries-bench := $(addprefix $(objpfx)bench-,$(bench))
 106 binaries-benchset := $(addprefix $(objpfx)bench-,$(benchset))
 107 binaries-bench-malloc := $(addprefix $(objpfx)bench-,$(bench-malloc))
 108
 109 # The default duration: 10 seconds.
 110 ifndef BENCH_DURATION
 111 BENCH_DURATION := 10
 112 endif
 113
 114 CPPFLAGS-nonlib += -DDURATION=$(BENCH_DURATION)
 115
 116 # Use clock_gettime to measure performance of functions.  The default is to use
 117 # HP_TIMING if it is available.
 118 ifdef USE_CLOCK_GETTIME
 119 CPPFLAGS-nonlib += -DUSE_CLOCK_GETTIME
 120 endif
 121
 122 DETAILED_OPT :=
 123
 124 ifdef DETAILED
 125 DETAILED_OPT := -d
 126 endif
 127
 128 # This makes sure CPPFLAGS-nonlib and CFLAGS-nonlib are passed
 129 # for all these modules.
 130 cpp-srcs-left := $(binaries-benchset:=.c) $(binaries-bench:=.c) \
 131                  $(binaries-bench-malloc:=.c)
 132 lib := nonlib
 133 include $(patsubst %,$(..)libof-iterator.mk,$(cpp-srcs-left))
 134
 135 bench-deps := bench-skeleton.c bench-timing.h Makefile
 136
 137 run-bench = $(test-wrapper-env) \
 138             $(run-program-env) \
 139             $($*-ENV) $(test-via-rtld-prefix) $${run}
 140
 141 timing-type := $(objpfx)bench-timing-type
 142
 143 bench-clean:
 144         rm -f $(binaries-bench) $(addsuffix .o,$(binaries-bench))
 145         rm -f $(binaries-benchset) $(addsuffix .o,$(binaries-benchset))
 146         rm -f $(binaries-bench-malloc) $(addsuffix .o,$(binaries-bench-malloc))
 147         rm -f $(timing-type) $(addsuffix .o,$(timing-type))
 148         rm -f $(addprefix $(objpfx),$(bench-extra-objs))
 149
 150 # Define the bench target only if the target has a usable python installation.
 151 ifdef PYTHON
 152 bench: bench-build bench-set bench-func bench-malloc
 153 else
 154 bench:
 155         @echo "The bench target needs python to run."
 156         @exit 1
 157 endif
 158
 159 # Target to only build the benchmark without running it.  We generate locales
 160 # only if we're building natively.
 161 ifeq (no,$(cross-compiling))
 162 bench-build: $(gen-locales) $(timing-type) $(binaries-bench) \
 163         $(binaries-benchset) $(binaries-bench-malloc)
 164 else
 165 bench-build: $(timing-type) $(binaries-bench) $(binaries-benchset) \
 166         $(binaries-bench-malloc)
 167 endif
 168
 169 bench-set: $(binaries-benchset)
 170         for run in $^; do \
 171           echo "Running $${run}"; \
 172           $(run-bench) > $${run}.out; \
 173         done
 174
 175 bench-malloc: $(binaries-bench-malloc)
 176         run=$(objpfx)bench-malloc-thread; \
 177         for thr in 1 8 16 32; do \
 178           echo "Running $${run} $${thr}"; \
 179           $(run-bench) $${thr} > $${run}-$${thr}.out; \
 180         done
 181
 182 # Build and execute the benchmark functions.  This target generates JSON
 183 # formatted bench.out.  Each of the programs produce independent JSON output,
 184 # so one could even execute them individually and process it using any JSON
 185 # capable language or tool.
 186 bench-func: $(binaries-bench)
 187         { timing_type=$$($(timing-type)); \
 188         echo "{\"timing_type\": \"$${timing_type}\","; \
 189         echo " \"functions\": {"; \
 190         for run in $^; do \
 191           if ! [ "x$${run}" = "x$<" ]; then \
 192             echo ","; \
 193           fi; \
 194           echo "Running $${run}" >&2; \
 195           $(run-bench) $(DETAILED_OPT); \
 196         done; \
 197         echo; \
 198         echo " }"; \
 199         echo "}"; } > $(objpfx)bench.out-tmp; \
 200         if [ -f $(objpfx)bench.out ]; then \
 201           mv -f $(objpfx)bench.out $(objpfx)bench.out.old; \
 202         fi; \
 203         mv -f $(objpfx)bench.out-tmp $(objpfx)bench.out
 204         $(PYTHON) scripts/validate_benchout.py $(objpfx)bench.out \
 205                 scripts/benchout.schema.json
 206
 207 $(timing-type) $(binaries-bench) $(binaries-benchset) \
 208         $(binaries-bench-malloc): %: %.o $(objpfx)json-lib.o \
 209         $(link-extra-libs-tests) \
 210   $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
 211   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
 212         $(+link-tests)
 213
 214 $(objpfx)bench-%.c: %-inputs $(bench-deps)
 215         { if [ -n "$($*-INCLUDE)" ]; then \
 216           cat $($*-INCLUDE); \
 217         fi; \
 218         $(PYTHON) scripts/bench.py $(patsubst %-inputs,%,$<); } > $@-tmp
 219         mv -f $@-tmp $@