1 # Copyright (C) 1991-2023 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 features-time64.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))
113 -test ! -x $(elf-objpfx)ldconfig || LC_ALL=C \
114 $(elf-objpfx)ldconfig $(addprefix -r ,$(install_root)) \
117 ifeq (/usr,$(prefix))
118 ifeq (,$(install_root))
119 LD_SO=$(ld.so-version) CC="$(CC)" $(PERL) scripts/test-installation.pl $(common-objpfx)
126 # Build subdirectory lib objects.
127 lib-noranlib: subdir_lib
129 ifeq (yes,$(build-shared))
130 # Build the shared object from the PIC object library.
131 lib: $(common-objpfx)libc.so $(common-objpfx)linkobj/libc.so
132 endif # $(build-shared)
134 # Used to build testrun.sh.
135 define testrun-script
137 builddir=`dirname "$$0"`
138 GCONV_PATH="$${builddir}/iconvdata"
142 Usage: $$0 [OPTIONS] <program> [ARGUMENTS...]
144 --tool=TOOL Run with the specified TOOL. It can be strace, rpctrace,
145 valgrind or container. The container will run within
146 support/test-container. For strace and valgrind,
147 additional arguments can be passed after the tool name.
154 while test $$# -gt 0 ; do
169 if test $$# -eq 0 ; then
175 exec $(subst $(common-objdir),"$${builddir}", $(test-program-prefix)) \
179 exec $$toolname $(patsubst %, -E%, $(run-program-env)) \
180 $(test-via-rtld-prefix) $${1+"$$@"}
183 exec rpctrace $(patsubst %, -E%, $(run-program-env)) \
184 $(test-via-rtld-prefix) $${1+"$$@"}
187 exec env $(run-program-env) $$toolname $(test-via-rtld-prefix) $${1+"$$@"}
190 exec env $(run-program-env) $(test-via-rtld-prefix) \
191 $(common-objdir)/support/test-container \
192 env $(run-program-env) $(test-via-rtld-prefix) $${1+"$$@"}
200 # This is a handy script for running any dynamically linked program against
201 # the current libc build for testing.
202 $(common-objpfx)testrun.sh: $(common-objpfx)config.make \
203 $(..)Makeconfig $(..)Makefile
204 $(file >$@T,$(testrun-script))
207 postclean-generated += testrun.sh
212 SOURCE_DIR="$(CURDIR)"
213 BUILD_DIR="$(common-objpfx)"
214 CMD_FILE="$(common-objpfx)debugglibc.gdb"
226 Usage: $$0 [OPTIONS] <program>
228 Or: $$0 [OPTIONS] -- <program> [<args>]...
230 where <program> is the path to the program being tested,
231 and <args> are the arguments to be passed to it.
236 Prints this message and leaves.
238 The following options require one argument:
241 Breakpoints to set at the beginning of the execution
242 (each breakpoint demands its own -b option, e.g. -b foo -b bar)
243 -e, --environment-variable
244 Environment variables to be set with 'exec-wrapper env' in GDB
245 (each environment variable demands its own -e option, e.g.
246 -e FOO=foo -e BAR=bar)
248 The following options do not take arguments:
251 Run the test case inside a container and automatically attach
254 Selects whether to pass the --direct flag to the program.
255 --direct is useful when debugging glibc test cases. It inhibits the
256 tests from forking and executing in a subprocess.
257 Default behaviour is to pass the --direct flag, except when the
258 program is run with user specified arguments using the "--" separator.
259 -s, --no-symbols-file
260 Do not tell GDB to load debug symbols from the program.
264 # Parse input options
274 BREAKPOINTS="break $$2\n$$BREAKPOINTS"
277 -e|--environment-variable)
278 ENVVARS="$$2 $$ENVVARS"
287 -s|--no-symbols-file)
294 # Don't add --direct when user specifies program arguments
300 COMMANDLINE=$$TESTCASE
306 # Check for required argument and if the testcase exists
307 if [ ! -v TESTCASE ] || [ ! -f $${TESTCASE} ]
313 # Container tests needing locale data should install them in-container.
314 # Other tests/binaries need to use locale data from the build tree.
315 if [ "$$CONTAINER" = false ]
317 ENVVARS="GCONV_PATH=$${BUILD_DIR}/iconvdata $$ENVVARS"
318 ENVVARS="LOCPATH=$${BUILD_DIR}/localedata $$ENVVARS"
319 ENVVARS="LC_ALL=C $$ENVVARS"
322 # Expand environment setup command
325 ENVVARSCMD="set exec-wrapper env $$ENVVARS"
328 # Expand direct argument
329 if [ "$$DIRECT" == true ]
336 # Check if the test case is static
337 if file $${TESTCASE} | grep "statically linked" >/dev/null
344 # Expand symbols loading command
345 if [ "$$SYMBOLSFILE" == true ]
347 SYMBOLSFILE="add-symbol-file $${TESTCASE}"
352 # GDB commands template
356 set environment C -E -x c-header
357 set auto-load safe-path $${BUILD_DIR}/nptl_db:\$$debugdir:\$$datadir/auto-load
358 set libthread-db-search-path $${BUILD_DIR}/nptl_db
362 run --library-path $(rpath-link):$${BUILD_DIR}/nptl_db \
363 __COMMANDLINE__ __DIRECT__
368 # Generate the commands file for gdb initialization
370 -e "s|__ENVVARS__|$$ENVVARSCMD|" \
371 -e "s|__SYMBOLSFILE__|$$SYMBOLSFILE|" \
372 -e "s|__COMMANDLINE__|$$COMMANDLINE|" \
373 -e "s|__DIRECT__|$$DIRECT|" \
374 -e "s|__BREAKPOINTS__|$$BREAKPOINTS|" \
378 echo "Debugging glibc..."
379 echo "Build directory : $$BUILD_DIR"
380 echo "Source directory : $$SOURCE_DIR"
381 echo "GLIBC Testcase : $$TESTCASE"
382 echo "GDB Commands : $$CMD_FILE"
383 echo "Env vars : $$ENVVARS"
386 if [ "$$CONTAINER" == true ]
388 # Use testrun.sh to start the test case with WAIT_FOR_DEBUGGER=1, then
389 # automatically attach GDB to it.
390 WAIT_FOR_DEBUGGER=1 $(common-objpfx)testrun.sh --tool=container $${TESTCASE} &
391 gdb -x $${TESTCASE}.gdb
392 elif [ "$$STATIC" == true ]
396 # Start the test case debugging in two steps:
397 # 1. the following command invokes gdb to run the loader;
398 # 2. the commands file tells the loader to run the test case.
402 $${BUILD_DIR}/elf/ld.so
406 # This is another handy script for debugging dynamically linked program
407 # against the current libc build for testing.
408 $(common-objpfx)debugglibc.sh: $(common-objpfx)config.make \
409 $(..)Makeconfig $(..)Makefile
410 $(file >$@T,$(debugglibc))
413 postclean-generated += debugglibc.sh debugglibc.gdb
415 others: $(common-objpfx)testrun.sh $(common-objpfx)debugglibc.sh
417 # Makerules creates a file `stubs' in each subdirectory, which
418 # contains `#define __stub_FUNCTION' for each function defined in that
419 # directory which is a stub.
420 # Here we paste all of these together into <gnu/stubs.h>.
422 subdir-stubs := $(foreach dir,$(subdirs),$(common-objpfx)$(dir)/stubs)
425 installed-stubs = $(inst_includedir)/gnu/stubs.h
427 installed-stubs = $(inst_includedir)/gnu/stubs-$(default-abi).h
429 $(inst_includedir)/gnu/stubs.h: $(+force)
430 $(make-target-directory)
432 echo '/* This file is automatically generated.';\
433 echo " This file selects the right generated file of \`__stub_FUNCTION' macros";\
434 echo ' based on the architecture being compiled for. */'; \
436 $(foreach h,$(abi-includes), echo '#include <$(h)>';) \
438 $(foreach v,$(abi-variants),\
439 $(if $(abi-$(v)-condition),\
440 echo '#if $(abi-$(v)-condition)'; \
441 echo '# include <gnu/stubs-$(v).h>'); \
442 $(if $(abi-$(v)-condition),echo '#endif';) \
443 rm -f $(@:.d=.h).new$(v); \
446 mv -f $(@:.d=.h).new $(@:.d=.h)
448 install-others-nosubdir: $(installed-stubs)
452 # Since stubs.h is never needed when building the library, we simplify the
453 # hairy installation process by producing it in place only as the last part
454 # of the top-level `make install'. It depends on subdir_install, which
455 # iterates over all the subdirs; subdir_install in each subdir depends on
456 # the subdir's stubs file. Having more direct dependencies would result in
457 # extra iterations over the list for subdirs and many recursive makes.
458 $(installed-stubs): include/stubs-prologue.h subdir_install
459 $(make-target-directory)
460 @rm -f $(objpfx)stubs.h
461 (sed '/^@/d' $<; LC_ALL=C sort $(subdir-stubs)) > $(objpfx)stubs.h
462 if test -r $@ && cmp -s $(objpfx)stubs.h $@; \
463 then echo 'stubs.h unchanged'; \
464 else $(INSTALL_DATA) $(objpfx)stubs.h $@; fi
465 rm -f $(objpfx)stubs.h
467 # This makes the Info or DVI file of the documentation from the Texinfo source.
468 .PHONY: info dvi pdf html
470 $(MAKE) $(PARALLELMFLAGS) -C manual $@
472 # This makes all the subdirectory targets.
474 # For each target, make it depend on DIR/target for each subdirectory DIR.
475 $(+subdir_targets): %: $(addsuffix /%,$(subdirs))
477 # Compute a list of all those targets.
478 all-subdirs-targets := $(foreach dir,$(subdirs),\
479 $(addprefix $(dir)/,$(+subdir_targets)))
481 # The action for each of those is to cd into the directory and make the
483 $(all-subdirs-targets):
484 $(MAKE) $(PARALLELMFLAGS) $(subdir-target-args) $(@F)
486 define subdir-target-args
487 subdir=$(@D)$(if $($(@D)-srcdir),\
488 -C $($(@D)-srcdir) ..=`pwd`/,\
492 .PHONY: $(+subdir_targets) $(all-subdirs-targets)
494 # Targets to clean things up to various degrees.
496 .PHONY: clean realclean distclean distclean-1 parent-clean parent-mostlyclean \
499 # Subroutines of all cleaning targets.
500 parent-mostlyclean: common-mostlyclean # common-mostlyclean is in Makerules.
501 -rm -f $(foreach o,$(object-suffixes-for-libc),\
502 $(common-objpfx)$(patsubst %,$(libtype$o),c)) \
503 $(addprefix $(objpfx),$(install-lib))
504 parent-clean: parent-mostlyclean common-clean
506 postclean = $(addprefix $(common-objpfx),$(postclean-generated)) \
507 $(addprefix $(objpfx),sysd-dirs sysd-rules) \
508 $(addprefix $(objpfx),sysd-sorted soversions.mk soversions.i)
511 # This is done this way rather than having `subdir_clean' be a
512 # dependency of this target so that libc.a will be removed before the
513 # subdirectories are dealt with and so they won't try to remove object
514 # files from it when it's going to be removed anyway.
515 @$(MAKE) subdir_clean no_deps=t
517 mostlyclean: parent-mostlyclean
518 @$(MAKE) subdir_mostlyclean no_deps=t
521 # Remove test artifacts from the whole glibc build.
522 # do-tests-clean removes test artifacts from top-level directory, and
523 # subdir_testclean removes them from individual sub-directories.
524 tests-clean: do-tests-clean
525 @$(MAKE) subdir_testclean no_deps=t
528 vpath c++-types.data $(+sysdep_dirs)
530 tests-special += $(objpfx)c++-types-check.out
531 $(objpfx)c++-types-check.out: c++-types.data scripts/check-c++-types.sh
532 scripts/check-c++-types.sh $< $(CXX) $(filter-out -std=gnu11 $(+gccwarn-c),$(CFLAGS)) $(CPPFLAGS) > $@; \
536 tests-special += $(objpfx)check-local-headers.out
537 $(objpfx)check-local-headers.out: scripts/check-local-headers.sh
538 AWK='$(AWK)' scripts/check-local-headers.sh \
539 "$(includedir)" "$(objpfx)" < /dev/null > $@; \
542 ifneq "$(headers)" ""
543 # Special test of all the installed headers in this directory.
544 tests-special += $(objpfx)check-installed-headers-c.out
545 libof-check-installed-headers-c := testsuite
546 $(objpfx)check-installed-headers-c.out: \
547 scripts/check-installed-headers.sh $(headers)
548 $(SHELL) $(..)scripts/check-installed-headers.sh c $(supported-fortify) \
549 "$(CC) $(filter-out -std=%,$(CFLAGS)) -D_ISOMAC $(+includes)" \
554 tests-special += $(objpfx)check-installed-headers-cxx.out
555 libof-check-installed-headers-cxx := testsuite
556 $(objpfx)check-installed-headers-cxx.out: \
557 scripts/check-installed-headers.sh $(headers)
558 $(SHELL) $(..)scripts/check-installed-headers.sh c++ $(supported-fortify) \
559 "$(CXX) $(filter-out -std=%,$(CXXFLAGS)) -D_ISOMAC $(+includes)" \
564 tests-special += $(objpfx)check-wrapper-headers.out
565 $(objpfx)check-wrapper-headers.out: scripts/check-wrapper-headers.py $(headers)
566 $(PYTHON) $< --root=. --subdir=. $(headers) \
567 --generated $(common-generated) > $@; $(evaluate-test)
570 # Lint all Makefiles; including this one. Pass `pwd` as the source
571 # directory since the top-level Makefile is in the root of the source
572 # tree and these tests are run from there. We add light-weight linting
573 # to the 'check' target to support the existing developer workflow of:
574 # edit -> make -> make check; without needing an additional step.
575 tests-special += $(objpfx)lint-makefiles.out
576 $(objpfx)lint-makefiles.out: scripts/lint-makefiles.sh
577 $(SHELL) $< "$(PYTHON)" `pwd` > $@ ; \
580 define summarize-tests
581 @grep -E -v '^(PASS|XFAIL):' $(objpfx)$1 || true
582 @echo "Summary of test results$2:"
583 @sed 's/:.*//' < $(objpfx)$1 | sort | uniq -c
584 @! grep -E -q -v '^(X?PASS|XFAIL|UNSUPPORTED):' $(objpfx)$1
587 # The intention here is to do ONE install of our build into the
588 # testroot.pristine/ directory, then rsync (internal to
589 # support/test-container) that to testroot.root/ at the start of each
590 # test. That way we can promise each test a "clean" install, without
591 # having to do the install for each test.
593 # In addition, we have to copy some files (which we build) into this
594 # root in addition to what glibc installs. For example, many tests
595 # require additional programs including /bin/sh, /bin/true, and
596 # /bin/echo, all of which we build below to limit library dependencies
597 # to just those things in glibc and language support libraries which
598 # we also copy into the into the rootfs. To determine what language
599 # support libraries we need we build a "test" program in either C or
600 # (if available) C++ just so we can copy in any shared objects
601 # (which we do not build) that GCC-compiled programs depend on.
605 LINKS_DSO_PROGRAM = links-dso-program-c
607 LINKS_DSO_PROGRAM = links-dso-program
610 $(tests-container) $(addsuffix /tests,$(subdirs)) : \
611 $(objpfx)testroot.pristine/install.stamp
612 $(objpfx)testroot.pristine/install.stamp :
613 test -d $(objpfx)testroot.pristine || \
614 mkdir $(objpfx)testroot.pristine
615 # We need a working /bin/sh for some of the tests.
616 test -d $(objpfx)testroot.pristine/bin || \
617 mkdir $(objpfx)testroot.pristine/bin
618 # We need the compiled locale dir for localedef tests.
619 test -d $(objpfx)testroot.pristine/$(complocaledir) || \
620 mkdir -p $(objpfx)testroot.pristine/$(complocaledir)
621 cp $(objpfx)support/shell-container $(objpfx)testroot.pristine/bin/sh
622 cp $(objpfx)support/echo-container $(objpfx)testroot.pristine/bin/echo
623 cp $(objpfx)support/true-container $(objpfx)testroot.pristine/bin/true
624 ifeq ($(run-built-tests),yes)
625 # Copy these DSOs first so we can overwrite them with our own.
626 for dso in `$(test-wrapper-env) LD_TRACE_LOADED_OBJECTS=1 \
628 $(objpfx)testroot.pristine/bin/sh \
629 | sed -n '/\//{s@.*=> /@/@;s/^[^/]*//;s/ .*//p;}'` ;\
631 test -d `dirname $(objpfx)testroot.pristine$$dso` || \
632 mkdir -p `dirname $(objpfx)testroot.pristine$$dso` ;\
633 $(test-wrapper) cp $$dso $(objpfx)testroot.pristine$$dso ;\
635 for dso in `$(test-wrapper-env) LD_TRACE_LOADED_OBJECTS=1 \
637 $(objpfx)support/$(LINKS_DSO_PROGRAM) \
638 | sed -n '/\//{s@.*=> /@/@;s/^[^/]*//;s/ .*//p;}'` ;\
640 test -d `dirname $(objpfx)testroot.pristine$$dso` || \
641 mkdir -p `dirname $(objpfx)testroot.pristine$$dso` ;\
642 $(test-wrapper) cp $$dso $(objpfx)testroot.pristine$$dso ;\
645 # $(symbolic-link-list) is a file that encodes $(DESTDIR) so we
647 rm -f $(symbolic-link-list)
648 # Setting INSTALL_UNCOMPRESSED causes localedata/Makefile to
649 # install the charmaps uncompressed, as the testroot does not
650 # provide a gunzip program.
651 $(MAKE) install DESTDIR=$(objpfx)testroot.pristine \
652 INSTALL_UNCOMPRESSED=yes subdirs='$(sorted-subdirs)'
653 rm -f $(symbolic-link-list)
654 touch $(objpfx)testroot.pristine/install.stamp
656 tests-special-notdir = $(patsubst $(objpfx)%, %, $(tests-special))
657 tests: $(tests-special)
658 $(..)scripts/merge-test-results.sh -s $(objpfx) "" \
659 $(sort $(tests-special-notdir:.out=)) \
660 > $(objpfx)subdir-tests.sum
661 $(..)scripts/merge-test-results.sh -t $(objpfx) subdir-tests.sum \
662 $(sort $(subdirs) .) \
664 $(call summarize-tests,tests.sum)
666 $(..)scripts/merge-test-results.sh -t $(objpfx) subdir-xtests.sum \
668 > $(objpfx)xtests.sum
669 $(call summarize-tests,xtests.sum, for extra tests)
671 # The realclean target is just like distclean for the parent, but we want
672 # the subdirs to know the difference in case they care.
673 realclean distclean: parent-clean
674 # This is done this way rather than having `subdir_distclean' be a
675 # dependency of this target so that libc.a will be removed before the
676 # subdirectories are dealt with and so they won't try to remove object
677 # files from it when it's going to be removed anyway.
678 @$(MAKE) distclean-1 no_deps=t distclean-1=$@ avoid-generated=yes \
679 sysdep-subdirs="$(sysdep-subdirs)"
682 # Subroutine of distclean and realclean.
683 distclean-1: subdir_$(distclean-1)
684 -rm -f $(config-generated)
685 -rm -f $(addprefix $(objpfx),config.status config.cache config.log)
686 -rm -f $(addprefix $(objpfx),config.make config-name.h config.h)
688 -rm -f $(objpfx)Makefile
690 -rm -f $(sysdep-$(distclean-1))
692 # Make the TAGS file for Emacs users.
696 scripts/list-sources.sh | sed -n -e '/Makefile/p' \
697 $(foreach S,[chsSyl] cxx sh bash pl,\
698 $(subst .,\.,-e '/.$S\(.in\)*$$/p')) \
701 # Make the distribution tarfile.
702 .PHONY: dist dist-prepare
704 generated := $(generated) stubs.h
706 files-for-dist := README INSTALL configure NEWS
708 # Regenerate stuff, then error if these things are not committed yet.
709 dist-prepare: $(files-for-dist)
710 conf=`find sysdeps -name configure`; \
712 git diff --stat HEAD -- $^ $$conf \
713 | $(AWK) '{ print; rc=1 } END { exit rc }'
716 git archive --prefix=$*/ $* > $@.new
719 # Do `make dist dist-version=X.Y.Z' to make tar files of an older version.
721 ifneq (,$(strip $(dist-version)))
722 dist: $(foreach Z,.bz2 .gz .xz,$(dist-version).tar$Z)
726 @if v=`git describe`; then \
727 echo Distribution version $$v; \
728 $(MAKE) dist dist-version=$$v; \
734 INSTALL: manual/install-plain.texi manual/macros.texi \
735 $(common-objpfx)manual/pkgvers.texi manual/install.texi
736 makeinfo --no-validate --plaintext --no-number-sections \
737 -I$(common-objpfx)manual $< -o $@-tmp
738 $(AWK) 'NF == 0 { ++n; next } \
739 NF != 0 { while (n-- > 0) print ""; n = 0; print }' \
744 $(common-objpfx)manual/%: FORCE
745 $(MAKE) $(PARALLELMFLAGS) -C manual $@
748 iconvdata/% localedata/% po/%: FORCE
749 $(MAKE) $(PARALLELMFLAGS) -C $(@D) $(@F)
751 # Convenience target to rerun one test, from the top of the build tree
752 # Example: make test t=wcsmbs/test-wcsnlen
755 @-rm -f $(objpfx)$t.out
756 $(MAKE) subdir=$(patsubst %/,%,$(dir $t)) -C $(dir $t) ..=../ $(objpfx)$t.out
757 @cat $(objpfx)$t.test-result