1 # Copyright (C) 2013-2018 Free Software Foundation, Inc.
2 # This file is part of the GNU C Library.
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.
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.
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/>.
18 # Makefile for benchmark tests. The only useful target here is `bench`.
19 # Add benchmark functions in alphabetical order.
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 expf exp2f logf log2f sincosf sinf \
29 bench-pthread := pthread_once thread_create
31 bench-string := ffs ffsll
34 bench := $(bench-math) $(bench-pthread) $(bench-string)
36 bench := $(foreach B,$(filter bench-%,${BENCHSET}), ${${B}})
39 # String function benchmarks.
40 string-benchset := bcopy bzero memccpy memchr memcmp memcpy memmem memmove \
41 mempcpy memset rawmemchr stpcpy stpncpy strcasecmp strcasestr \
42 strcat strchr strchrnul strcmp strcpy strcspn strlen \
43 strncasecmp strncat strncmp strncpy strnlen strpbrk strrchr \
44 strspn strstr strcpy_chk stpcpy_chk memrchr strsep strtok \
45 strcoll memcpy-large memcpy-random memmove-large memset-large \
46 memcpy-walk memset-walk memmove-walk
48 # Build and run locale-dependent benchmarks only if we're building natively.
49 ifeq (no,$(cross-compiling))
50 wcsmbs-benchset := wcslen wcsnlen wcscpy wcpcpy wcsncpy wcpncpy wcscat wcsncat \
51 wcscmp wcsncmp wcschr wcschrnul wcsrchr wcsspn wcspbrk wcscspn \
52 wmemchr wmemset wmemcmp
57 string-benchset-all := $(string-benchset) ${wcsmbs-benchset}
59 ifeq (no,$(cross-compiling))
60 # We have to generate locales
61 LOCALES := en_US.UTF-8 tr_TR.UTF-8 cs_CZ.UTF-8 fa_IR.UTF-8 fr_FR.UTF-8 \
62 ja_JP.UTF-8 si_LK.UTF-8 en_GB.UTF-8 vi_VN.UTF-8 ar_SA.UTF-8 \
63 da_DK.UTF-8 pl_PL.UTF-8 pt_PT.UTF-8 el_GR.UTF-8 ru_RU.UTF-8 \
64 he_IL.UTF-8 is_IS.UTF-8 es_ES.UTF-8 hi_IN.UTF-8 sv_SE.UTF-8 \
65 hu_HU.UTF-8 it_IT.UTF-8 sr_RS.UTF-8 zh_CN.UTF-8
66 include ../gen-locales.mk
69 stdlib-benchset := strtod
71 stdio-common-benchset := sprintf
73 math-benchset := math-inlines
76 benchset := $(string-benchset-all) $(stdlib-benchset) $(stdio-common-benchset) \
79 benchset := $(foreach B,$(filter %-benchset,${BENCHSET}), ${${B}})
82 CFLAGS-bench-ffs.c += -fno-builtin
83 CFLAGS-bench-ffsll.c += -fno-builtin
84 CFLAGS-bench-sqrt.c += -fno-builtin
85 CFLAGS-bench-fmin.c += -fno-builtin
86 CFLAGS-bench-fminf.c += -fno-builtin
87 CFLAGS-bench-fmax.c += -fno-builtin
88 CFLAGS-bench-fmaxf.c += -fno-builtin
89 CFLAGS-bench-trunc.c += -fno-builtin
90 CFLAGS-bench-truncf.c += -fno-builtin
93 bench-malloc := malloc-thread
95 bench-malloc := $(filter malloc-%,${BENCHSET})
98 $(addprefix $(objpfx)bench-,$(bench-math)): $(libm)
99 $(addprefix $(objpfx)bench-,$(math-benchset)): $(libm)
100 $(addprefix $(objpfx)bench-,$(bench-pthread)): $(shared-thread-library)
101 $(objpfx)bench-malloc-thread: $(shared-thread-library)
105 # Rules to build and execute the benchmarks. Do not put any benchmark
106 # parameters beyond this point.
108 # We don't want the benchmark programs to run in parallel since that could
109 # affect their performance.
112 bench-extra-objs = json-lib.o
114 extra-objs += $(bench-extra-objs)
115 others-extras = $(bench-extra-objs)
119 binaries-bench := $(addprefix $(objpfx)bench-,$(bench))
120 binaries-benchset := $(addprefix $(objpfx)bench-,$(benchset))
121 binaries-bench-malloc := $(addprefix $(objpfx)bench-,$(bench-malloc))
123 # The default duration: 10 seconds.
124 ifndef BENCH_DURATION
128 CPPFLAGS-nonlib += -DDURATION=$(BENCH_DURATION)
130 # Use clock_gettime to measure performance of functions. The default is to use
131 # HP_TIMING if it is available.
132 ifdef USE_CLOCK_GETTIME
133 CPPFLAGS-nonlib += -DUSE_CLOCK_GETTIME
142 # This makes sure CPPFLAGS-nonlib and CFLAGS-nonlib are passed
143 # for all these modules.
144 cpp-srcs-left := $(binaries-benchset:=.c) $(binaries-bench:=.c) \
145 $(binaries-bench-malloc:=.c)
147 include $(patsubst %,$(..)libof-iterator.mk,$(cpp-srcs-left))
149 bench-deps := bench-skeleton.c bench-timing.h Makefile
151 run-bench = $(test-wrapper-env) \
153 $($*-ENV) $(test-via-rtld-prefix) $${run}
155 timing-type := $(objpfx)bench-timing-type
158 rm -f $(binaries-bench) $(addsuffix .o,$(binaries-bench))
159 rm -f $(binaries-benchset) $(addsuffix .o,$(binaries-benchset))
160 rm -f $(binaries-bench-malloc) $(addsuffix .o,$(binaries-bench-malloc))
161 rm -f $(timing-type) $(addsuffix .o,$(timing-type))
162 rm -f $(addprefix $(objpfx),$(bench-extra-objs))
164 # Validate the passed in BENCHSET
165 ifneq ($(strip ${BENCHSET}),)
166 VALIDBENCHSETNAMES := bench-pthread bench-math bench-string string-benchset \
167 wcsmbs-benchset stdlib-benchset stdio-common-benchset math-benchset \
169 INVALIDBENCHSETNAMES := $(filter-out ${VALIDBENCHSETNAMES},${BENCHSET})
170 ifneq (${INVALIDBENCHSETNAMES},)
171 $(info The following values in BENCHSET are invalid: ${INVALIDBENCHSETNAMES})
172 $(info The valid ones are: ${VALIDBENCHSETNAMES})
173 $(error Invalid BENCHSET value)
177 # Define the bench target only if the target has a usable python installation.
179 bench: bench-build bench-set bench-func bench-malloc
182 @echo "The bench target needs python to run."
186 # Target to only build the benchmark without running it. We generate locales
187 # only if we're building natively.
188 ifeq (no,$(cross-compiling))
189 bench-build: $(gen-locales) $(timing-type) $(binaries-bench) \
190 $(binaries-benchset) $(binaries-bench-malloc)
192 bench-build: $(timing-type) $(binaries-bench) $(binaries-benchset) \
193 $(binaries-bench-malloc)
196 bench-set: $(binaries-benchset)
198 echo "Running $${run}"; \
199 $(run-bench) > $${run}.out; \
202 bench-malloc: $(binaries-bench-malloc)
204 for thr in 1 8 16 32; do \
205 echo "Running $${run} $${thr}"; \
206 $(run-bench) $${thr} > $${run}-$${thr}.out; \
210 # Build and execute the benchmark functions. This target generates JSON
211 # formatted bench.out. Each of the programs produce independent JSON output,
212 # so one could even execute them individually and process it using any JSON
213 # capable language or tool.
214 bench-func: $(binaries-bench)
215 if [ -n '$^' ] ; then \
216 { timing_type=$$($(timing-type)); \
217 echo "{\"timing_type\": \"$${timing_type}\","; \
218 echo " \"functions\": {"; \
220 if ! [ "x$${run}" = "x$<" ]; then \
223 echo "Running $${run}" >&2; \
224 $(run-bench) $(DETAILED_OPT); \
229 } > $(objpfx)bench.out-tmp; \
230 if [ -f $(objpfx)bench.out ]; then \
231 mv -f $(objpfx)bench.out $(objpfx)bench.out.old; \
233 mv -f $(objpfx)bench.out-tmp $(objpfx)bench.out; \
234 $(PYTHON) scripts/validate_benchout.py $(objpfx)bench.out \
235 scripts/benchout.schema.json; \
238 $(timing-type) $(binaries-bench) $(binaries-benchset) \
239 $(binaries-bench-malloc): %: %.o $(objpfx)json-lib.o \
240 $(link-extra-libs-tests) \
241 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
242 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
245 $(objpfx)bench-%.c: %-inputs $(bench-deps)
246 { if [ -n "$($*-INCLUDE)" ]; then \
249 $(PYTHON) scripts/bench.py $(patsubst %-inputs,%,$<); } > $@-tmp