1 # Copyright (C) 1991-2024 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 # <https://www.gnu.org/licenses/>.
19 # Rules for making a subdirectory in the GNU C library.
20 # Each subdirectory Makefile defines some variables and includes this.
23 This makefile requires GNU Make.
26 all: # Don't let the default goal come from Makeconfig.
28 include $(firstword $(..) ../)Makeconfig
31 Each subdirectory makefile must define the `subdir' variable.
33 # This ` unconfuses emacs.
34 # This is benign and useless in GNU make before 3.63.
35 export subdir := $(subdir)
37 # This is the default target; it makes the library and auxiliary programs.
41 ifeq ($(build-programs),yes)
42 others: $(addprefix $(objpfx),$(extra-objs) \
44 $(install-bin) $(install-bin-script) \
45 $(install-rootsbin) $(install-sbin))
47 others: $(addprefix $(objpfx),$(extra-objs) \
51 ifneq "$(findstring env,$(origin headers))" ""
55 ifneq "$(findstring env,$(origin generated))" ""
59 ifneq "$(findstring env,$(origin common-generated))" ""
63 include $(..)Makerules
66 subdir_lib: lib-noranlib
68 # Some subdirs need to install a dummy library.
69 # They can use "$(objpfx)libfnord.a: $(dep-dummy-lib); $(make-dummy-lib)".
70 dep-dummy-lib = $(common-objpfx)dummy.o
72 $(AR) cr$(verbose) $@ $<
75 $(common-objpfx)dummy.c:
77 (echo 'extern void __dummy__ (void);'; \
78 echo 'void __dummy__ (void) { }') > $@
79 common-generated += dummy.o dummy.c
82 # Test that all of the headers installed by this directory can be compiled
84 tests-special += $(objpfx)check-installed-headers-c.out
85 libof-check-installed-headers-c := testsuite
86 $(objpfx)check-installed-headers-c.out: \
87 $(..)scripts/check-installed-headers.sh $(headers)
88 $(SHELL) $(..)scripts/check-installed-headers.sh c $(supported-fortify) \
89 "$(CC) $(filter-out -std=%,$(CFLAGS)) -D_ISOMAC $(+includes)" \
94 # If a C++ compiler is available, also test that they can be compiled
95 # in isolation as C++.
96 tests-special += $(objpfx)check-installed-headers-cxx.out
97 libof-check-installed-headers-cxx := testsuite
98 $(objpfx)check-installed-headers-cxx.out: \
99 $(..)scripts/check-installed-headers.sh $(headers)
100 $(SHELL) $(..)scripts/check-installed-headers.sh c++ $(supported-fortify) \
101 "$(CXX) $(filter-out -std=%,$(CXXFLAGS)) -D_ISOMAC $(+includes)" \
106 # Test that a wrapper header exists in include/ for each non-sysdeps header.
107 # This script does not need $(py-env).
108 tests-special += $(objpfx)check-wrapper-headers.out
109 $(objpfx)check-wrapper-headers.out: \
110 $(..)scripts/check-wrapper-headers.py $(headers)
111 $(PYTHON) $< --root=$(..) --subdir=$(subdir) $(headers) > $@; \
114 # Test that none of the headers installed by this directory use certain
115 # obsolete constructs (e.g. legacy BSD typedefs superseded by stdint.h).
116 # This script does not need $(py-env).
117 tests-special += $(objpfx)check-obsolete-constructs.out
118 libof-check-obsolete-constructs := testsuite
119 $(objpfx)check-obsolete-constructs.out: \
120 $(..)scripts/check-obsolete-constructs.py $(headers)
121 $(PYTHON) $^ > $@ 2>&1; \
126 # This makes all the auxiliary and test programs.
128 .PHONY: others tests bench bench-build
130 # Test programs for the pretty printers.
131 tests-printers-programs := $(addprefix $(objpfx),$(tests-printers))
133 # .out files with the output of running the pretty printer tests.
134 tests-printers-out := $(patsubst %,$(objpfx)%.out,$(tests-printers))
136 ifeq ($(build-programs),yes)
137 others: $(addprefix $(objpfx),$(others) $(sysdep-others) $(extra-objs))
139 others: $(addprefix $(objpfx),$(extra-objs))
142 # Generate constant files for Python pretty printers if required.
145 ifeq ($(run-built-tests),no)
146 tests: $(addprefix $(objpfx),$(filter-out $(tests-unsupported), \
147 $(tests) $(tests-internal) \
148 $(tests-container)) \
149 $(test-srcs)) $(tests-special) \
150 $(tests-printers-programs)
151 xtests: tests $(xtests-special)
153 tests: $(tests:%=$(objpfx)%.out) $(tests-internal:%=$(objpfx)%.out) \
154 $(tests-container:%=$(objpfx)%.out) \
155 $(tests-mcheck:%=$(objpfx)%-mcheck.out) \
156 $(tests-malloc-check:%=$(objpfx)%-malloc-check.out) \
157 $(tests-malloc-hugetlb1:%=$(objpfx)%-malloc-hugetlb1.out) \
158 $(tests-malloc-hugetlb2:%=$(objpfx)%-malloc-hugetlb2.out) \
159 $(tests-special) $(tests-printers-out)
160 xtests: tests $(xtests:%=$(objpfx)%.out) $(xtests-special)
163 tests-special-notdir = $(patsubst $(objpfx)%, %, $(tests-special))
164 xtests-special-notdir = $(patsubst $(objpfx)%, %, $(xtests-special))
165 ifeq ($(run-built-tests),no)
168 tests-expected = $(tests) $(tests-internal) $(tests-printers) \
169 $(tests-container) $(tests-malloc-check:%=%-malloc-check) \
170 $(tests-malloc-hugetlb1:%=%-malloc-hugetlb1) \
171 $(tests-malloc-hugetlb2:%=%-malloc-hugetlb2) \
172 $(tests-mcheck:%=%-mcheck)
175 $(..)scripts/merge-test-results.sh -s $(objpfx) $(subdir) \
176 $(sort $(tests-expected) $(tests-special-notdir:.out=)) \
177 > $(objpfx)subdir-tests.sum
179 $(..)scripts/merge-test-results.sh -s $(objpfx) $(subdir) \
180 $(sort $(xtests) $(xtests-special-notdir:.out=)) \
181 > $(objpfx)subdir-xtests.sum
183 ifeq ($(build-programs),yes)
184 binaries-all-notests = $(others) $(sysdep-others)
185 binaries-all-tests = $(tests) $(tests-internal) $(xtests) $(test-srcs) \
187 binaries-all = $(binaries-all-notests) $(binaries-all-tests)
188 binaries-static-notests = $(others-static)
189 binaries-static-tests = $(tests-static) $(xtests-static)
190 binaries-static = $(binaries-static-notests) $(binaries-static-tests)
191 binaries-shared-2.0-tests = $(tests-2.0)
192 ifeq (yesyes,$(have-fpie)$(build-shared))
193 binaries-pie-tests = $(tests-pie) $(xtests-pie)
194 binaries-pie-notests = $(others-pie)
197 binaries-pie-notests =
199 binaries-mcheck-tests = $(tests-mcheck:%=%-mcheck)
200 binaries-malloc-check-tests = $(tests-malloc-check:%=%-malloc-check)
201 binaries-malloc-hugetlb1-tests = $(tests-malloc-hugetlb1:%=%-malloc-hugetlb1)
202 binaries-malloc-hugetlb2-tests = $(tests-malloc-hugetlb2:%=%-malloc-hugetlb2)
204 binaries-all-notests =
205 binaries-all-tests = $(tests) $(tests-internal) $(xtests) $(test-srcs)
206 binaries-all = $(binaries-all-tests)
207 binaries-static-notests =
208 binaries-static-tests =
211 binaries-pie-notests =
212 binaries-mcheck-tests =
213 binaries-malloc-check-tests =
214 binaries-malloc-hugetlb1-tests =
215 binaries-malloc-hugetlb2-tests =
218 binaries-pie = $(binaries-pie-tests) $(binaries-pie-notests)
219 binaries-shared-tests = $(filter-out $(binaries-pie) $(binaries-static) \
220 $(binaries-shared-2.0-tests), \
221 $(binaries-all-tests))
222 binaries-shared-notests = $(filter-out $(binaries-pie) $(binaries-static), \
223 $(binaries-all-notests))
225 ifneq "$(strip $(binaries-shared-notests))" ""
226 $(addprefix $(objpfx),$(binaries-shared-notests)): %: %.o \
227 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
228 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
232 ifneq "$(strip $(binaries-shared-tests))" ""
233 $(addprefix $(objpfx),$(binaries-shared-tests)): %: %.o \
234 $(link-extra-libs-tests) \
235 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
236 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
240 # Linking test programs with crt1.o from glibc 2.0.
241 ifneq "$(strip $(binaries-shared-2.0-tests))" ""
242 $(addprefix $(objpfx),$(binaries-shared-2.0-tests)): %: %.o \
243 $(link-extra-libs-tests) \
244 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
245 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
249 ifneq "$(strip $(binaries-mcheck-tests))" ""
250 $(addprefix $(objpfx),$(binaries-mcheck-tests)): %-mcheck: %.o \
251 $(link-extra-libs-tests) \
252 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
253 $(common-objpfx)malloc/libmcheck.a \
254 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
258 ifneq "$(strip $(binaries-malloc-check-tests))" ""
259 $(addprefix $(objpfx),$(binaries-malloc-check-tests)): %-malloc-check: %.o \
260 $(link-extra-libs-tests) \
261 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
262 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
266 ifneq "$(strip $(binaries-malloc-hugetlb1-tests))" ""
267 $(addprefix $(objpfx),$(binaries-malloc-hugetlb1-tests)): %-malloc-hugetlb1: %.o \
268 $(link-extra-libs-tests) \
269 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
270 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
274 ifneq "$(strip $(binaries-malloc-hugetlb2-tests))" ""
275 $(addprefix $(objpfx),$(binaries-malloc-hugetlb2-tests)): %-malloc-hugetlb2: %.o \
276 $(link-extra-libs-tests) \
277 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
278 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
282 ifneq "$(strip $(binaries-pie-tests))" ""
283 $(addprefix $(objpfx),$(binaries-pie-tests)): %: %.o \
284 $(link-extra-libs-tests) \
285 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
286 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
290 ifneq "$(strip $(binaries-pie-notests))" ""
291 $(addprefix $(objpfx),$(binaries-pie-notests)): %: %.o \
292 $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
293 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
297 ifneq "$(strip $(binaries-static-notests))" ""
298 $(addprefix $(objpfx),$(binaries-static-notests)): %: %.o \
299 $(sort $(filter $(common-objpfx)lib%,$(link-libc-static))) \
300 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
304 ifneq "$(strip $(binaries-static-tests))" ""
305 $(addprefix $(objpfx),$(binaries-static-tests)): %: %.o \
306 $(link-extra-libs-tests) \
307 $(sort $(filter $(common-objpfx)lib%,$(link-libc-static-tests))) \
308 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
309 $(+link-static-tests)
312 # All malloc-check tests will be run with MALLOC_CHECK_=3
313 define malloc-check-ENVS
314 $(1)-malloc-check-ENV = MALLOC_CHECK_=3 \
315 LD_PRELOAD=$(common-objpfx)/malloc/libc_malloc_debug.so
317 $(foreach t,$(tests-malloc-check),$(eval $(call malloc-check-ENVS,$(t))))
319 # All malloc-hugetlb1 tests will be run with GLIBC_TUNABLES=glibc.malloc.hugetlb=1
320 define malloc-hugetlb1-ENVS
321 $(1)-malloc-hugetlb1-ENV += GLIBC_TUNABLES=glibc.malloc.hugetlb=1
323 $(foreach t,$(tests-malloc-hugetlb1),$(eval $(call malloc-hugetlb1-ENVS,$(t))))
325 # All malloc-hugetlb2 tests will be run with GLIBC_TUNABLE=glibc.malloc.hugetlb=2
326 define malloc-hugetlb2-ENVS
327 $(1)-malloc-hugetlb2-ENV += GLIBC_TUNABLES=glibc.malloc.hugetlb=2
329 $(foreach t,$(tests-malloc-hugetlb2),$(eval $(call malloc-hugetlb2-ENVS,$(t))))
331 # mcheck tests need the debug DSO to support -lmcheck.
333 $(1)-mcheck-ENV = LD_PRELOAD=$(common-objpfx)/malloc/libc_malloc_debug.so
335 $(foreach t,$(tests-mcheck),$(eval $(call mcheck-ENVS,$(t))))
337 ifneq "$(strip $(tests) $(tests-internal) $(xtests) $(test-srcs))" ""
338 # These are the implicit rules for making test outputs
339 # from the test programs and whatever input files are present.
342 $(if $($*-ENV-only),$(test-wrapper-env-only) $($*-ENV-only),\
343 $(test-wrapper-env) $(run-program-env) $($*-ENV)) \
344 $(host-test-program-cmd) $($*-ARGS)
346 $(objpfx)%.out: %.input $(objpfx)%
347 $(make-test-out) > $@ < $(word 1,$^); \
349 $(objpfx)%.out: /dev/null $(objpfx)% # Make it 2nd arg for canned sequence.
350 $(make-test-out) > $@; \
354 # Any tests that require an isolated container (filesystem, network
355 # and pid namespaces) in which to run, should be added to
357 $(tests-container:%=$(objpfx)%.out): $(objpfx)%.out : $(if $(wildcard $(objpfx)%.files),$(objpfx)%.files,/dev/null) $(objpfx)%
358 $(test-wrapper-env) $(run-program-env) $(run-via-rtld-prefix) \
359 $(common-objpfx)support/test-container env $(run-program-env) $($*-ENV) \
360 $(host-test-program-cmd) $($*-ARGS) > $@; \
364 # tests-unsupported lists tests that we will not try to build at all in
365 # this configuration. Note this runs every time because it does not
366 # actually create its target. The dependency on Makefile is meant to
367 # ensure that it runs after a Makefile change to add a test to the list
368 # when it previously ran and produced a .out file (probably for a failure).
369 ifneq "$(strip $(tests-unsupported))" ""
370 $(tests-unsupported:%=$(objpfx)%.out): $(objpfx)%.out: Makefile
372 $(..)scripts/evaluate-test.sh $(patsubst $(common-objpfx)%.out,%,$@) \
373 77 false false > $(@:.out=.test-result)
378 ifneq "$(strip $(tests-printers))" ""
380 # Static pattern rule for building the test programs for the pretty printers.
381 $(tests-printers-programs): %: %.o $(tests-printers-libs) \
382 $(sort $(filter $(common-objpfx)lib%,$(link-libc-static-tests))) \
383 $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
384 $(+link-printers-tests)
386 # Add the paths to the generated constants file and test_common_printers.py
387 # to PYTHONPATH so the test scripts can find them.
388 py-env := PYTHONPATH=$(py-const-dir):$(..)scripts:$${PYTHONPATH}
390 # Static pattern rule that matches the test-* targets to their .c and .py
391 # prerequisites. It'll run the corresponding test script for each test program
392 # we compiled and place its output in the corresponding .out file.
393 # The pretty printer files and test_common_printers.py must be present for all.
394 $(tests-printers-out): $(objpfx)%.out: $(objpfx)% %.py %.c $(pretty-printers) \
395 $(..)scripts/test_printers_common.py
396 $(test-wrapper-env) $(py-env) \
397 $(PYTHON) $*.py $*.c $(objpfx)$* $(pretty-printers) > $@; \
402 .PHONY: distclean realclean subdir_distclean subdir_realclean \
403 subdir_clean subdir_mostlyclean subdir_testclean
404 subdir_mostlyclean: mostlyclean
406 subdir_distclean: distclean
407 subdir_realclean: realclean
408 subdir_testclean: do-tests-clean
412 # We want to install everything except the library itself, but update all
413 # our portions of the library because the parent make will install it later
414 # (likewise the stubs file).
415 .PHONY: subdir_install
416 subdir_install: install-no-libc.a lib-noranlib stubs
418 .PHONY: subdir_objs subdir_stubs
422 # Target required by the Hurd to ensure that all the MiG-generated
423 # headers are in place before building a subdirectory.
424 .PHONY: before-compile
425 before-compile: $(before-compile)
427 $(common-objpfx)dummy.o: $(common-objpfx)dummy.c $(before-compile);