Update old tunables framework document/script.
[glibc.git] / Rules
blob917bc969b50a250e9e2c5f523d74bdae0adeeb37
1 # Copyright (C) 1991-2017 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/>.
19 #       Rules for making a subdirectory in the GNU C library.
20 #       Each subdirectory Makefile defines some variables and includes this.
22 ifneq (,)
23 This makefile requires GNU Make.
24 endif
26 all: # Don't let the default goal come from Makeconfig.
28 include $(firstword $(..) ../)Makeconfig
30 ifndef  subdir
31 Each subdirectory makefile must define the `subdir' variable.
32 endif
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.
38 .PHONY: all
39 all: objs lib others
41 ifeq ($(build-programs),yes)
42 others: $(addprefix $(objpfx),$(extra-objs) \
43                               $(install-lib) \
44                               $(install-bin) $(install-bin-script) \
45                               $(install-rootsbin) $(install-sbin))
46 else
47 others: $(addprefix $(objpfx),$(extra-objs) \
48                               $(install-lib))
49 endif
51 ifneq   "$(findstring env,$(origin headers))" ""
52 headers :=
53 endif
55 ifneq   "$(findstring env,$(origin generated))" ""
56 generated :=
57 endif
59 ifneq   "$(findstring env,$(origin common-generated))" ""
60 common-generated :=
61 endif
63 # See below.  This must be set before Makerules processes it.
64 before-compile += $(common-objpfx)bits/stdio_lim.h
66 include $(..)Makerules
68 .PHONY: subdir_lib
69 subdir_lib: lib-noranlib
71 # Some subdirs need to install a dummy library.
72 # They can use "$(objpfx)libfnord.a: $(dep-dummy-lib); $(make-dummy-lib)".
73 dep-dummy-lib = $(common-objpfx)dummy.o
74 define make-dummy-lib
75 $(AR) cr$(verbose) $@ $<
76 endef
78 $(common-objpfx)dummy.c:
79         rm -f $@
80         (echo 'extern void __dummy__ (void);'; \
81          echo 'void __dummy__ (void) { }') > $@
82 common-generated += dummy.o dummy.c
84 ifneq "$(headers)" ""
85 # Special test of all the installed headers in this directory.
86 tests-special += $(objpfx)check-installed-headers-c.out
87 libof-check-installed-headers-c := nonlib
88 $(objpfx)check-installed-headers-c.out: \
89     $(..)scripts/check-installed-headers.sh $(headers)
90         $(SHELL) $(..)scripts/check-installed-headers.sh c \
91           "$(CC) $(filter-out -std=%,$(CFLAGS)) -D_ISOMAC $(+includes)" \
92           $(headers) > $@; \
93         $(evaluate-test)
95 ifneq "$(CXX)" ""
96 tests-special += $(objpfx)check-installed-headers-cxx.out
97 libof-check-installed-headers-cxx := nonlib
98 $(objpfx)check-installed-headers-cxx.out: \
99     $(..)scripts/check-installed-headers.sh $(headers)
100         $(SHELL) $(..)scripts/check-installed-headers.sh c++ \
101           "$(CXX) $(filter-out -std=%,$(CXXFLAGS)) -D_ISOMAC $(+includes)" \
102           $(headers) > $@; \
103         $(evaluate-test)
104 endif
105 endif
107 # This makes all the auxiliary and test programs.
109 .PHONY: others tests bench bench-build
111 # Test programs for the pretty printers.
112 tests-printers-programs := $(addprefix $(objpfx),$(tests-printers))
114 # .out files with the output of running the pretty printer tests.
115 tests-printers-out := $(patsubst %,$(objpfx)%.out,$(tests-printers))
117 ifndef PYTHON
118 # Mark tests-printers tests as unsupported if we don't have PYTHON.
119 tests-unsupported += $(tests-printers)
120 endif
122 ifeq ($(build-programs),yes)
123 others: $(addprefix $(objpfx),$(others) $(sysdep-others) $(extra-objs))
124 else
125 others: $(addprefix $(objpfx),$(extra-objs))
126 endif
128 # Generate constant files for Python pretty printers if required.
129 others: $(py-const)
131 ifeq ($(run-built-tests),no)
132 tests: $(addprefix $(objpfx),$(filter-out $(tests-unsupported),$(tests)) \
133                              $(test-srcs)) $(tests-special) \
134                              $(tests-printers-programs)
135 xtests: tests $(xtests-special)
136 else
137 tests: $(tests:%=$(objpfx)%.out) $(tests-special) $(tests-printers-out)
138 xtests: tests $(xtests:%=$(objpfx)%.out) $(xtests-special)
139 endif
141 tests-special-notdir = $(patsubst $(objpfx)%, %, $(tests-special))
142 xtests-special-notdir = $(patsubst $(objpfx)%, %, $(xtests-special))
143 ifeq ($(run-built-tests),no)
144 tests-expected =
145 else
146 tests-expected = $(tests) $(tests-printers)
147 endif
148 tests:
149         $(..)scripts/merge-test-results.sh -s $(objpfx) $(subdir) \
150           $(sort $(tests-expected) $(tests-special-notdir:.out=)) \
151           > $(objpfx)subdir-tests.sum
152 xtests:
153         $(..)scripts/merge-test-results.sh -s $(objpfx) $(subdir) \
154           $(sort $(xtests) $(xtests-special-notdir:.out=)) \
155           > $(objpfx)subdir-xtests.sum
157 ifeq ($(build-programs),yes)
158 binaries-all-notests = $(others) $(sysdep-others)
159 binaries-all-tests = $(tests) $(xtests) $(test-srcs)
160 binaries-all = $(binaries-all-notests) $(binaries-all-tests)
161 binaries-static-notests = $(others-static)
162 binaries-static-tests = $(tests-static) $(xtests-static)
163 binaries-static = $(binaries-static-notests) $(binaries-static-tests)
164 ifeq (yesyes,$(have-fpie)$(build-shared))
165 binaries-pie-tests = $(tests-pie) $(xtests-pie)
166 binaries-pie-notests = $(others-pie)
167 else
168 binaries-pie-tests =
169 binaries-pie-notests =
170 endif
171 else
172 binaries-all-notests =
173 binaries-all-tests = $(tests) $(xtests) $(test-srcs)
174 binaries-all = $(binaries-all-tests)
175 binaries-static-notests =
176 binaries-static-tests =
177 binaries-static =
178 binaries-pie-tests =
179 binaries-pie-notests =
180 endif
182 binaries-pie = $(binaries-pie-tests) $(binaries-pie-notests)
183 binaries-shared-tests = $(filter-out $(binaries-pie) $(binaries-static), \
184                                      $(binaries-all-tests))
185 binaries-shared-notests = $(filter-out $(binaries-pie) $(binaries-static), \
186                                        $(binaries-all-notests))
188 ifneq "$(strip $(binaries-shared-notests))" ""
189 $(addprefix $(objpfx),$(binaries-shared-notests)): %: %.o \
190   $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
191   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
192         $(+link)
193 endif
195 ifneq "$(strip $(binaries-shared-tests))" ""
196 $(addprefix $(objpfx),$(binaries-shared-tests)): %: %.o \
197   $(link-extra-libs-tests) \
198   $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
199   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
200         $(+link-tests)
201 endif
203 ifneq "$(strip $(binaries-pie-tests))" ""
204 $(addprefix $(objpfx),$(binaries-pie-tests)): %: %.o \
205   $(link-extra-libs-tests) \
206   $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
207   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
208         $(+link-pie-tests)
209 endif
211 ifneq "$(strip $(binaries-pie-notests))" ""
212 $(addprefix $(objpfx),$(binaries-pie-notests)): %: %.o \
213   $(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
214   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
215         $(+link-pie)
216 endif
218 ifneq "$(strip $(binaries-static-notests))" ""
219 $(addprefix $(objpfx),$(binaries-static-notests)): %: %.o \
220   $(sort $(filter $(common-objpfx)lib%,$(link-libc-static))) \
221   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
222         $(+link-static)
223 endif
225 ifneq "$(strip $(binaries-static-tests))" ""
226 $(addprefix $(objpfx),$(binaries-static-tests)): %: %.o \
227   $(link-extra-libs-tests) \
228   $(sort $(filter $(common-objpfx)lib%,$(link-libc-static-tests))) \
229   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
230         $(+link-static-tests)
231 endif
233 ifneq "$(strip $(tests) $(xtests) $(test-srcs))" ""
234 # These are the implicit rules for making test outputs
235 # from the test programs and whatever input files are present.
237 define make-test-out
238 $(if $($*-ENV-only),$(test-wrapper-env-only) $($*-ENV-only),\
239      $(test-wrapper-env) $(run-program-env) $($*-ENV)) \
240 $(host-test-program-cmd) $($*-ARGS)
241 endef
242 $(objpfx)%.out: %.input $(objpfx)%
243         $(make-test-out) > $@ < $(word 1,$^); \
244         $(evaluate-test)
245 $(objpfx)%.out: /dev/null $(objpfx)%    # Make it 2nd arg for canned sequence.
246         $(make-test-out) > $@; \
247         $(evaluate-test)
249 # tests-unsupported lists tests that we will not try to build at all in
250 # this configuration.  Note this runs every time because it does not
251 # actually create its target.  The dependency on Makefile is meant to
252 # ensure that it runs after a Makefile change to add a test to the list
253 # when it previously ran and produced a .out file (probably for a failure).
254 ifneq "$(strip $(tests-unsupported))" ""
255 $(tests-unsupported:%=$(objpfx)%.out): $(objpfx)%.out: Makefile
256         @rm -f $@
257         $(..)scripts/evaluate-test.sh $(patsubst $(common-objpfx)%.out,%,$@) \
258                                       77 false false > $(@:.out=.test-result)
259 endif
261 endif   # tests
263 ifdef PYTHON
264 ifneq "$(strip $(tests-printers))" ""
266 # Static pattern rule for building the test programs for the pretty printers.
267 $(tests-printers-programs): %: %.o $(tests-printers-libs) \
268   $(sort $(filter $(common-objpfx)lib%,$(link-libc-static-tests))) \
269   $(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
270         $(+link-printers-tests)
272 # Add the paths to the generated constants file and test_common_printers.py
273 # to PYTHONPATH so the test scripts can find them.
274 py-env := PYTHONPATH=$(py-const-dir):$(..)scripts:$${PYTHONPATH}
276 # Static pattern rule that matches the test-* targets to their .c and .py
277 # prerequisites.  It'll run the corresponding test script for each test program
278 # we compiled and place its output in the corresponding .out file.
279 # The pretty printer files and test_common_printers.py must be present for all.
280 $(tests-printers-out): $(objpfx)%.out: $(objpfx)% %.py %.c $(pretty-printers) \
281                        $(..)scripts/test_printers_common.py
282         $(test-wrapper-env) $(py-env) \
283             $(PYTHON) $*.py $*.c $(objpfx)$* $(pretty-printers) > $@; \
284         $(evaluate-test)
285 endif
286 endif
289 .PHONY: distclean realclean subdir_distclean subdir_realclean \
290         subdir_clean subdir_mostlyclean subdir_testclean
291 subdir_mostlyclean: mostlyclean
292 subdir_clean: clean
293 subdir_distclean: distclean
294 subdir_realclean: realclean
295 subdir_testclean: do-tests-clean
296 realclean: distclean
297 distclean: clean
299 # We want to install everything except the library itself, but update all
300 # our portions of the library because the parent make will install it later
301 # (likewise the stubs file).
302 .PHONY: subdir_install
303 subdir_install: install-no-libc.a lib-noranlib stubs
305 .PHONY: subdir_objs subdir_stubs
306 subdir_objs: objs
307 subdir_stubs: stubs
309 # Target required by the Hurd to ensure that all the MiG-generated
310 # headers are in place before building a subdirectory.
311 .PHONY: before-compile
312 before-compile: $(before-compile)
314 $(common-objpfx)dummy.o: $(common-objpfx)dummy.c $(before-compile);
315         $(compile-command.c)
317 # Local Variables:
318 # mode: makefile
319 # End: