1 # Copyright (C) 1991-2019 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 # Master Makefile for the GNU C library
22 This makefile requires GNU Make.
28 # This is the default target; it makes everything except the tests.
29 .PHONY: all help minihelp
30 all: minihelp lib others
33 @sed '0,/^help-starts-here$$/d' Makefile.help
37 @echo type \"make help\" for help with common glibc makefile targets
41 ifneq ($(AUTOCONF),no)
45 $(AUTOCONF) $(ACFLAGS) $< > $@.new
46 chmod a-w$(patsubst %,$(comma)a+x,$(filter .,$(@D))) $@.new
50 configure: configure.ac aclocal.m4; $(autoconf-it)
51 %/configure: %/configure.ac aclocal.m4; $(autoconf-it)
52 %/preconfigure: %/preconfigure.ac aclocal.m4; $(autoconf-it)
54 endif # $(AUTOCONF) = no
57 # We don't want to run anything here in parallel.
60 # These are the targets that are made by making them in each subdirectory.
61 +subdir_targets := subdir_lib objects objs others subdir_mostlyclean \
62 subdir_clean subdir_distclean subdir_realclean \
64 subdir_update-abi subdir_check-abi \
65 subdir_update-all-abi \
68 subdir_objs subdir_stubs subdir_testclean \
69 $(addprefix install-, no-libc.a bin lib data headers others)
71 headers := limits.h values.h features.h gnu-versions.h \
72 bits/xopen_lim.h gnu/libc-version.h stdc-predef.h \
73 bits/libc-header-start.h
75 echo-headers: subdir_echo-headers
77 # The headers are in the include directory.
79 vpath %.h $(subdir-dirs)
82 install-others = $(inst_includedir)/gnu/stubs.h
85 ifeq (yes,$(build-shared))
86 headers += gnu/lib-names.h
91 ifeq ($(build-programs),yes)
92 others: $(addprefix $(objpfx),$(install-bin-script))
95 # Install from subdirectories too.
96 install: subdir_install
98 # Explicit dependency so that `make install-headers' works
99 install-headers: install-headers-nosubdir
101 # Make sure that the dynamic linker is installed before libc.
102 $(inst_slibdir)/libc-$(version).so: elf/ldso_install
104 .PHONY: elf/ldso_install
106 $(MAKE) -C $(@D) $(@F)
108 # Create links for shared libraries using the `ldconfig' program if possible.
109 # Ignore the error if we cannot update /etc/ld.so.cache.
110 ifeq (no,$(cross-compiling))
111 ifeq (yes,$(build-shared))
112 install: install-symbolic-link
113 .PHONY: install-symbolic-link
114 install-symbolic-link: subdir_install
115 $(symbolic-link-prog) $(symbolic-link-list)
116 rm -f $(symbolic-link-list)
119 -test ! -x $(elf-objpfx)ldconfig || LC_ALL=C \
120 $(elf-objpfx)ldconfig $(addprefix -r ,$(install_root)) \
123 ifeq (/usr,$(prefix))
124 ifeq (,$(install_root))
125 LD_SO=$(ld.so-version) CC="$(CC)" $(PERL) scripts/test-installation.pl $(common-objpfx)
132 # Build subdirectory lib objects.
133 lib-noranlib: subdir_lib
135 ifeq (yes,$(build-shared))
136 # Build the shared object from the PIC object library.
137 lib: $(common-objpfx)libc.so $(common-objpfx)linkobj/libc.so
138 endif # $(build-shared)
140 # Used to build testrun.sh.
141 define testrun-script
143 builddir=`dirname "$$0"`
144 GCONV_PATH="$${builddir}/iconvdata"
147 echo "usage: $$0 [--tool=strace] PROGRAM [ARGUMENTS...]" 2>&1
148 echo " $$0 --tool=valgrind PROGRAM [ARGUMENTS...]" 2>&1
153 while test $$# -gt 0 ; do
168 if test $$# -eq 0 ; then
174 exec $(subst $(common-objdir),"$${builddir}", $(test-program-prefix)) \
178 exec strace $(patsubst %, -E%, $(run-program-env)) \
179 $(test-via-rtld-prefix) $${1+"$$@"}
182 exec env $(run-program-env) valgrind $(test-via-rtld-prefix) $${1+"$$@"}
190 # This is a handy script for running any dynamically linked program against
191 # the current libc build for testing.
192 $(common-objpfx)testrun.sh: $(common-objpfx)config.make \
193 $(..)Makeconfig $(..)Makefile
194 $(file >$@T,$(testrun-script))
197 postclean-generated += testrun.sh
202 SOURCE_DIR="$(CURDIR)"
203 BUILD_DIR="$(common-objpfx)"
204 CMD_FILE="$(common-objpfx)debugglibc.gdb"
214 Usage: $$0 [OPTIONS] <program>
216 Or: $$0 [OPTIONS] -- <program> [<args>]...
218 where <program> is the path to the program being tested,
219 and <args> are the arguments to be passed to it.
224 Prints this message and leaves.
226 The following options require one argument:
229 Breakpoints to set at the beginning of the execution
230 (each breakpoint demands its own -b option, e.g. -b foo -b bar)
231 -e, --environment-variable
232 Environment variables to be set with 'exec-wrapper env' in GDB
233 (each environment variable demands its own -e option, e.g.
234 -e FOO=foo -e BAR=bar)
236 The following options do not take arguments:
239 Selects whether to pass the --direct flag to the program.
240 --direct is useful when debugging glibc test cases. It inhibits the
241 tests from forking and executing in a subprocess.
242 Default behaviour is to pass the --direct flag, except when the
243 program is run with user specified arguments using the "--" separator.
244 -s, --no-symbols-file
245 Do not tell GDB to load debug symbols from the program.
249 # Parse input options
259 BREAKPOINTS="break $$2\n$$BREAKPOINTS"
262 -e|--environment-variable)
263 ENVVARS="$$2 $$ENVVARS"
269 -s|--no-symbols-file)
276 # Don't add --direct when user specifies program arguments
282 COMMANDLINE=$$TESTCASE
288 # Check for required argument
295 # Expand environment setup command
298 ENVVARSCMD="set exec-wrapper env $$ENVVARS"
301 # Expand direct argument
302 if [ "$$DIRECT" == true ]
309 # Expand symbols loading command
310 if [ "$$SYMBOLSFILE" == true ]
312 SYMBOLSFILE="add-symbol-file $${TESTCASE}"
317 # GDB commands template
321 set environment C -E -x c-header
322 set auto-load safe-path $${BUILD_DIR}/nptl_db:\$$debugdir:\$$datadir/auto-load
323 set libthread-db-search-path $${BUILD_DIR}/nptl_db
327 run --library-path $(rpath-link):$${BUILD_DIR}/nptl_db \
328 __COMMANDLINE__ __DIRECT__
333 # Generate the commands file for gdb initialization
335 -e "s|__ENVVARS__|$$ENVVARSCMD|" \
336 -e "s|__SYMBOLSFILE__|$$SYMBOLSFILE|" \
337 -e "s|__COMMANDLINE__|$$COMMANDLINE|" \
338 -e "s|__DIRECT__|$$DIRECT|" \
339 -e "s|__BREAKPOINTS__|$$BREAKPOINTS|" \
343 echo "Debugging glibc..."
344 echo "Build directory : $$BUILD_DIR"
345 echo "Source directory : $$SOURCE_DIR"
346 echo "GLIBC Testcase : $$TESTCASE"
347 echo "GDB Commands : $$CMD_FILE"
348 echo "Env vars : $$ENVVARS"
351 # Start the test case debugging in two steps:
352 # 1. the following command invokes gdb to run the loader;
353 # 2. the commands file tells the loader to run the test case.
357 $${BUILD_DIR}/elf/ld.so
360 # This is another handy script for debugging dynamically linked program
361 # against the current libc build for testing.
362 $(common-objpfx)debugglibc.sh: $(common-objpfx)config.make \
363 $(..)Makeconfig $(..)Makefile
364 $(file >$@T,$(debugglibc))
367 postclean-generated += debugglibc.sh debugglibc.gdb
369 others: $(common-objpfx)testrun.sh $(common-objpfx)debugglibc.sh
371 # Makerules creates a file `stubs' in each subdirectory, which
372 # contains `#define __stub_FUNCTION' for each function defined in that
373 # directory which is a stub.
374 # Here we paste all of these together into <gnu/stubs.h>.
376 subdir-stubs := $(foreach dir,$(subdirs),$(common-objpfx)$(dir)/stubs)
379 installed-stubs = $(inst_includedir)/gnu/stubs.h
381 installed-stubs = $(inst_includedir)/gnu/stubs-$(default-abi).h
383 $(inst_includedir)/gnu/stubs.h: $(+force)
384 $(make-target-directory)
386 echo '/* This file is automatically generated.';\
387 echo " This file selects the right generated file of \`__stub_FUNCTION' macros";\
388 echo ' based on the architecture being compiled for. */'; \
390 $(foreach h,$(abi-includes), echo '#include <$(h)>';) \
392 $(foreach v,$(abi-variants),\
393 $(if $(abi-$(v)-condition),\
394 echo '#if $(abi-$(v)-condition)'; \
395 echo '# include <gnu/stubs-$(v).h>'); \
396 $(if $(abi-$(v)-condition),echo '#endif';) \
397 rm -f $(@:.d=.h).new$(v); \
400 mv -f $(@:.d=.h).new $(@:.d=.h)
402 install-others-nosubdir: $(installed-stubs)
406 # Since stubs.h is never needed when building the library, we simplify the
407 # hairy installation process by producing it in place only as the last part
408 # of the top-level `make install'. It depends on subdir_install, which
409 # iterates over all the subdirs; subdir_install in each subdir depends on
410 # the subdir's stubs file. Having more direct dependencies would result in
411 # extra iterations over the list for subdirs and many recursive makes.
412 $(installed-stubs): include/stubs-prologue.h subdir_install
413 $(make-target-directory)
414 @rm -f $(objpfx)stubs.h
415 (sed '/^@/d' $<; LC_ALL=C sort $(subdir-stubs)) > $(objpfx)stubs.h
416 if test -r $@ && cmp -s $(objpfx)stubs.h $@; \
417 then echo 'stubs.h unchanged'; \
418 else $(INSTALL_DATA) $(objpfx)stubs.h $@; fi
419 rm -f $(objpfx)stubs.h
421 # This makes the Info or DVI file of the documentation from the Texinfo source.
422 .PHONY: info dvi pdf html
424 $(MAKE) $(PARALLELMFLAGS) -C manual $@
426 # This makes all the subdirectory targets.
428 # For each target, make it depend on DIR/target for each subdirectory DIR.
429 $(+subdir_targets): %: $(addsuffix /%,$(subdirs))
431 # Compute a list of all those targets.
432 all-subdirs-targets := $(foreach dir,$(subdirs),\
433 $(addprefix $(dir)/,$(+subdir_targets)))
435 # The action for each of those is to cd into the directory and make the
437 $(all-subdirs-targets):
438 $(MAKE) $(PARALLELMFLAGS) $(subdir-target-args) $(@F)
440 define subdir-target-args
441 subdir=$(@D)$(if $($(@D)-srcdir),\
442 -C $($(@D)-srcdir) ..=`pwd`/,\
446 .PHONY: $(+subdir_targets) $(all-subdirs-targets)
448 # Targets to clean things up to various degrees.
450 .PHONY: clean realclean distclean distclean-1 parent-clean parent-mostlyclean \
453 # Subroutines of all cleaning targets.
454 parent-mostlyclean: common-mostlyclean # common-mostlyclean is in Makerules.
455 -rm -f $(foreach o,$(object-suffixes-for-libc),\
456 $(common-objpfx)$(patsubst %,$(libtype$o),c)) \
457 $(addprefix $(objpfx),$(install-lib))
458 parent-clean: parent-mostlyclean common-clean
460 postclean = $(addprefix $(common-objpfx),$(postclean-generated)) \
461 $(addprefix $(objpfx),sysd-dirs sysd-rules) \
462 $(addprefix $(objpfx),sysd-sorted soversions.mk soversions.i)
465 # This is done this way rather than having `subdir_clean' be a
466 # dependency of this target so that libc.a will be removed before the
467 # subdirectories are dealt with and so they won't try to remove object
468 # files from it when it's going to be removed anyway.
469 @$(MAKE) subdir_clean no_deps=t
471 mostlyclean: parent-mostlyclean
472 @$(MAKE) subdir_mostlyclean no_deps=t
476 @$(MAKE) subdir_testclean no_deps=t
479 vpath c++-types.data $(+sysdep_dirs)
481 tests-special += $(objpfx)c++-types-check.out
482 $(objpfx)c++-types-check.out: c++-types.data scripts/check-c++-types.sh
483 scripts/check-c++-types.sh $< $(CXX) $(filter-out -std=gnu11 $(+gccwarn-c),$(CFLAGS)) $(CPPFLAGS) > $@; \
487 tests-special += $(objpfx)check-local-headers.out
488 $(objpfx)check-local-headers.out: scripts/check-local-headers.sh
489 AWK='$(AWK)' scripts/check-local-headers.sh \
490 "$(includedir)" "$(objpfx)" < /dev/null > $@; \
493 ifneq "$(headers)" ""
494 # Special test of all the installed headers in this directory.
495 tests-special += $(objpfx)check-installed-headers-c.out
496 libof-check-installed-headers-c := testsuite
497 $(objpfx)check-installed-headers-c.out: \
498 scripts/check-installed-headers.sh $(headers)
499 $(SHELL) $(..)scripts/check-installed-headers.sh c \
500 "$(CC) $(filter-out -std=%,$(CFLAGS)) -D_ISOMAC $(+includes)" \
505 tests-special += $(objpfx)check-installed-headers-cxx.out
506 libof-check-installed-headers-cxx := testsuite
507 $(objpfx)check-installed-headers-cxx.out: \
508 scripts/check-installed-headers.sh $(headers)
509 $(SHELL) $(..)scripts/check-installed-headers.sh c++ \
510 "$(CXX) $(filter-out -std=%,$(CXXFLAGS)) -D_ISOMAC $(+includes)" \
515 tests-special += $(objpfx)check-wrapper-headers.out
516 $(objpfx)check-wrapper-headers.out: scripts/check-wrapper-headers.py $(headers)
517 $(PYTHON) $< --root=. --subdir=. $(headers) \
518 --generated $(common-generated) > $@; $(evaluate-test)
521 define summarize-tests
522 @egrep -v '^(PASS|XFAIL):' $(objpfx)$1 || true
523 @echo "Summary of test results$2:"
524 @sed 's/:.*//' < $(objpfx)$1 | sort | uniq -c
525 @! egrep -q -v '^(X?PASS|XFAIL|UNSUPPORTED):' $(objpfx)$1
528 # The intention here is to do ONE install of our build into the
529 # testroot.pristine/ directory, then rsync (internal to
530 # support/test-container) that to testroot.root/ at the start of each
531 # test. That way we can promise each test a "clean" install, without
532 # having to do the install for each test.
534 # In addition, we have to copy some files (which we build) into this
535 # root in addition to what glibc installs. For example, many tests
536 # require additional programs including /bin/sh, /bin/true, and
537 # /bin/echo, all of which we build below to limit library dependencies
538 # to just those things in glibc and language support libraries which
539 # we also copy into the into the rootfs. To determine what language
540 # support libraries we need we build a "test" program in either C or
541 # (if available) C++ just so we can copy in any shared objects
542 # (which we do not build) that GCC-compiled programs depend on.
546 LINKS_DSO_PROGRAM = links-dso-program-c
548 LINKS_DSO_PROGRAM = links-dso-program
551 $(tests-container) $(addsuffix /tests,$(subdirs)) : \
552 $(objpfx)testroot.pristine/install.stamp
553 $(objpfx)testroot.pristine/install.stamp :
554 test -d $(objpfx)testroot.pristine || \
555 mkdir $(objpfx)testroot.pristine
556 # We need a working /bin/sh for some of the tests.
557 test -d $(objpfx)testroot.pristine/bin || \
558 mkdir $(objpfx)testroot.pristine/bin
559 cp $(objpfx)support/shell-container $(objpfx)testroot.pristine/bin/sh
560 cp $(objpfx)support/echo-container $(objpfx)testroot.pristine/bin/echo
561 cp $(objpfx)support/true-container $(objpfx)testroot.pristine/bin/true
562 ifeq ($(run-built-tests),yes)
563 # Copy these DSOs first so we can overwrite them with our own.
564 for dso in `$(test-wrapper-env) LD_TRACE_LOADED_OBJECTS=1 \
566 $(objpfx)testroot.pristine/bin/sh \
567 | grep / | sed 's/^[^/]*//' | sed 's/ .*//'` ;\
569 test -d `dirname $(objpfx)testroot.pristine$$dso` || \
570 mkdir -p `dirname $(objpfx)testroot.pristine$$dso` ;\
571 $(test-wrapper) cp $$dso $(objpfx)testroot.pristine$$dso ;\
573 for dso in `$(test-wrapper-env) LD_TRACE_LOADED_OBJECTS=1 \
575 $(objpfx)support/$(LINKS_DSO_PROGRAM) \
576 | grep / | sed 's/^[^/]*//' | sed 's/ .*//'` ;\
578 test -d `dirname $(objpfx)testroot.pristine$$dso` || \
579 mkdir -p `dirname $(objpfx)testroot.pristine$$dso` ;\
580 $(test-wrapper) cp $$dso $(objpfx)testroot.pristine$$dso ;\
583 $(MAKE) install DESTDIR=$(objpfx)testroot.pristine \
584 subdirs='$(sorted-subdirs)'
585 touch $(objpfx)testroot.pristine/install.stamp
587 tests-special-notdir = $(patsubst $(objpfx)%, %, $(tests-special))
588 tests: $(tests-special)
589 $(..)scripts/merge-test-results.sh -s $(objpfx) "" \
590 $(sort $(tests-special-notdir:.out=)) \
591 > $(objpfx)subdir-tests.sum
592 $(..)scripts/merge-test-results.sh -t $(objpfx) subdir-tests.sum \
593 $(sort $(subdirs) .) \
595 $(call summarize-tests,tests.sum)
597 $(..)scripts/merge-test-results.sh -t $(objpfx) subdir-xtests.sum \
599 > $(objpfx)xtests.sum
600 $(call summarize-tests,xtests.sum, for extra tests)
602 # The realclean target is just like distclean for the parent, but we want
603 # the subdirs to know the difference in case they care.
604 realclean distclean: parent-clean
605 # This is done this way rather than having `subdir_distclean' be a
606 # dependency of this target so that libc.a will be removed before the
607 # subdirectories are dealt with and so they won't try to remove object
608 # files from it when it's going to be removed anyway.
609 @$(MAKE) distclean-1 no_deps=t distclean-1=$@ avoid-generated=yes \
610 sysdep-subdirs="$(sysdep-subdirs)"
613 # Subroutine of distclean and realclean.
614 distclean-1: subdir_$(distclean-1)
615 -rm -f $(config-generated)
616 -rm -f $(addprefix $(objpfx),config.status config.cache config.log)
617 -rm -f $(addprefix $(objpfx),config.make config-name.h config.h)
619 -rm -f $(objpfx)Makefile
621 -rm -f $(sysdep-$(distclean-1))
623 # Make the TAGS file for Emacs users.
627 scripts/list-sources.sh | sed -n -e '/Makefile/p' \
628 $(foreach S,[chsSyl] cxx sh bash pl,\
629 $(subst .,\.,-e '/.$S\(.in\)*$$/p')) \
632 # Make the distribution tarfile.
633 .PHONY: dist dist-prepare
635 generated := $(generated) stubs.h
637 files-for-dist := README INSTALL configure ChangeLog NEWS
639 # Regenerate stuff, then error if these things are not committed yet.
640 dist-prepare: $(files-for-dist)
641 conf=`find sysdeps -name configure`; \
643 git diff --stat HEAD -- $^ $$conf \
644 | $(AWK) '{ print; rc=1 } END { exit rc }'
647 git archive --prefix=$*/ $* > $@.new
650 # Do `make dist dist-version=X.Y.Z' to make tar files of an older version.
652 ifneq (,$(strip $(dist-version)))
653 dist: $(foreach Z,.bz2 .gz .xz,$(dist-version).tar$Z)
657 @if v=`git describe`; then \
658 echo Distribution version $$v; \
659 $(MAKE) dist dist-version=$$v; \
665 INSTALL: manual/install-plain.texi manual/macros.texi \
666 $(common-objpfx)manual/pkgvers.texi manual/install.texi
667 makeinfo --no-validate --plaintext --no-number-sections \
668 -I$(common-objpfx)manual $< -o $@-tmp
669 $(AWK) 'NF == 0 { ++n; next } \
670 NF != 0 { while (n-- > 0) print ""; n = 0; print }' \
675 $(common-objpfx)manual/%: FORCE
676 $(MAKE) $(PARALLELMFLAGS) -C manual $@
679 iconvdata/% localedata/% po/%: FORCE
680 $(MAKE) $(PARALLELMFLAGS) -C $(@D) $(@F)
682 # Convenience target to rerun one test, from the top of the build tree
683 # Example: make test t=wcsmbs/test-wcsnlen
686 @-rm -f $(objpfx)$t.out
687 $(MAKE) subdir=$(dir $t) -C $(dir $t) ..=../ $(objpfx)$t.out
688 @cat $(objpfx)$t.test-result