mirror of
https://sourceware.org/git/glibc.git
synced 2024-11-08 14:20:07 +00:00
711a322a23
The test for obsolete typedefs in installed headers was implemented
using grep, and could therefore get false positives on e.g. “ulong”
in a comment. It was also scanning all of the headers included by
our headers, and therefore testing headers we don’t control, e.g.
Linux kernel headers.
This patch splits the obsolete-typedef test from
scripts/check-installed-headers.sh to a separate program,
scripts/check-obsolete-constructs.py. Being implemented in Python,
it is feasible to make it tokenize C accurately enough to avoid false
positives on the contents of comments and strings. It also only
examines $(headers) in each subdirectory--all the headers we install,
but not any external dependencies of those headers. Headers whose
installed name starts with finclude/ are ignored, on the assumption
that they contain Fortran.
It is also feasible to make the new test understand the difference
between _defining_ the obsolete typedefs and _using_ the obsolete
typedefs, which means posix/{bits,sys}/types.h no longer need to be
exempted. This uncovered an actual bug in bits/types.h: __quad_t and
__u_quad_t were being used to define __S64_TYPE, __U64_TYPE,
__SQUAD_TYPE and __UQUAD_TYPE. These are changed to __int64_t and
__uint64_t respectively. This is a safe change, despite the comments
in bits/types.h claiming a difference between __quad_t and __int64_t,
because those comments are incorrect. In all current ABIs, both
__quad_t and __int64_t are ‘long’ when ‘long’ is a 64-bit type, and
‘long long’ when ‘long’ is a 32-bit type, and similarly for __u_quad_t
and __uint64_t. (Changing the types to be what the comments say they
are would be an ABI break, as it affects C++ name mangling.) This
patch includes a minimal change to make the comments not completely
wrong.
sys/types.h was defining the legacy BSD u_intN_t typedefs using a
construct that was not necessarily consistent with how the C99 uintN_t
typedefs are defined, and is also too complicated for the new script to
understand (it lexes C relatively accurately, but it does not attempt
to expand preprocessor macros, nor does it do any actual parsing).
This patch cuts all of that out and uses bits/types.h's __uintN_t typedefs
to define u_intN_t instead. This is verified to not change the ABI on
any supported architecture, via the c++-types test, which means u_intN_t
and uintN_t were, in fact, consistent on all supported architectures.
Reviewed-by: Carlos O'Donell <carlos@redhat.com>
* scripts/check-obsolete-constructs.py: New test script.
* scripts/check-installed-headers.sh: Remove tests for
obsolete typedefs, superseded by check-obsolete-constructs.py.
* Rules: Run scripts/check-obsolete-constructs.py over $(headers)
as a special test. Update commentary.
* posix/bits/types.h (__SQUAD_TYPE, __S64_TYPE): Define as __int64_t.
(__UQUAD_TYPE, __U64_TYPE): Define as __uint64_t.
Update commentary.
* posix/sys/types.h (__u_intN_t): Remove.
(u_int8_t): Typedef using __uint8_t.
(u_int16_t): Typedef using __uint16_t.
(u_int32_t): Typedef using __uint32_t.
(u_int64_t): Typedef using __uint64_t.
352 lines
12 KiB
Plaintext
352 lines
12 KiB
Plaintext
# Copyright (C) 1991-2019 Free Software Foundation, Inc.
|
||
# This file is part of the GNU C Library.
|
||
|
||
# The GNU C Library is free software; you can redistribute it and/or
|
||
# modify it under the terms of the GNU Lesser General Public
|
||
# License as published by the Free Software Foundation; either
|
||
# version 2.1 of the License, or (at your option) any later version.
|
||
|
||
# The GNU C Library is distributed in the hope that it will be useful,
|
||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
# Lesser General Public License for more details.
|
||
|
||
# You should have received a copy of the GNU Lesser General Public
|
||
# License along with the GNU C Library; if not, see
|
||
# <http://www.gnu.org/licenses/>.
|
||
|
||
#
|
||
# Rules for making a subdirectory in the GNU C library.
|
||
# Each subdirectory Makefile defines some variables and includes this.
|
||
#
|
||
ifneq (,)
|
||
This makefile requires GNU Make.
|
||
endif
|
||
|
||
all: # Don't let the default goal come from Makeconfig.
|
||
|
||
include $(firstword $(..) ../)Makeconfig
|
||
|
||
ifndef subdir
|
||
Each subdirectory makefile must define the `subdir' variable.
|
||
endif
|
||
# This ` unconfuses emacs.
|
||
# This is benign and useless in GNU make before 3.63.
|
||
export subdir := $(subdir)
|
||
|
||
# This is the default target; it makes the library and auxiliary programs.
|
||
.PHONY: all
|
||
all: objs lib others
|
||
|
||
ifeq ($(build-programs),yes)
|
||
others: $(addprefix $(objpfx),$(extra-objs) \
|
||
$(install-lib) \
|
||
$(install-bin) $(install-bin-script) \
|
||
$(install-rootsbin) $(install-sbin))
|
||
else
|
||
others: $(addprefix $(objpfx),$(extra-objs) \
|
||
$(install-lib))
|
||
endif
|
||
|
||
ifneq "$(findstring env,$(origin headers))" ""
|
||
headers :=
|
||
endif
|
||
|
||
ifneq "$(findstring env,$(origin generated))" ""
|
||
generated :=
|
||
endif
|
||
|
||
ifneq "$(findstring env,$(origin common-generated))" ""
|
||
common-generated :=
|
||
endif
|
||
|
||
# See below. This must be set before Makerules processes it.
|
||
before-compile += $(common-objpfx)bits/stdio_lim.h
|
||
|
||
include $(..)Makerules
|
||
|
||
.PHONY: subdir_lib
|
||
subdir_lib: lib-noranlib
|
||
|
||
# Some subdirs need to install a dummy library.
|
||
# They can use "$(objpfx)libfnord.a: $(dep-dummy-lib); $(make-dummy-lib)".
|
||
dep-dummy-lib = $(common-objpfx)dummy.o
|
||
define make-dummy-lib
|
||
$(AR) cr$(verbose) $@ $<
|
||
endef
|
||
|
||
$(common-objpfx)dummy.c:
|
||
rm -f $@
|
||
(echo 'extern void __dummy__ (void);'; \
|
||
echo 'void __dummy__ (void) { }') > $@
|
||
common-generated += dummy.o dummy.c
|
||
|
||
ifneq "$(headers)" ""
|
||
# Test that all of the headers installed by this directory can be compiled
|
||
# in isolation.
|
||
tests-special += $(objpfx)check-installed-headers-c.out
|
||
libof-check-installed-headers-c := testsuite
|
||
$(objpfx)check-installed-headers-c.out: \
|
||
$(..)scripts/check-installed-headers.sh $(headers)
|
||
$(SHELL) $(..)scripts/check-installed-headers.sh c \
|
||
"$(CC) $(filter-out -std=%,$(CFLAGS)) -D_ISOMAC $(+includes)" \
|
||
$(headers) > $@; \
|
||
$(evaluate-test)
|
||
|
||
ifneq "$(CXX)" ""
|
||
# If a C++ compiler is available, also test that they can be compiled
|
||
# in isolation as C++.
|
||
tests-special += $(objpfx)check-installed-headers-cxx.out
|
||
libof-check-installed-headers-cxx := testsuite
|
||
$(objpfx)check-installed-headers-cxx.out: \
|
||
$(..)scripts/check-installed-headers.sh $(headers)
|
||
$(SHELL) $(..)scripts/check-installed-headers.sh c++ \
|
||
"$(CXX) $(filter-out -std=%,$(CXXFLAGS)) -D_ISOMAC $(+includes)" \
|
||
$(headers) > $@; \
|
||
$(evaluate-test)
|
||
endif # $(CXX)
|
||
|
||
# Test that a wrapper header exists in include/ for each non-sysdeps header.
|
||
# This script does not need $(py-env).
|
||
tests-special += $(objpfx)check-wrapper-headers.out
|
||
$(objpfx)check-wrapper-headers.out: \
|
||
$(..)scripts/check-wrapper-headers.py $(headers)
|
||
$(PYTHON) $< --root=$(..) --subdir=$(subdir) $(headers) > $@; \
|
||
$(evaluate-test)
|
||
|
||
# Test that none of the headers installed by this directory use certain
|
||
# obsolete constructs (e.g. legacy BSD typedefs superseded by stdint.h).
|
||
# This script does not need $(py-env).
|
||
tests-special += $(objpfx)check-obsolete-constructs.out
|
||
libof-check-obsolete-constructs := testsuite
|
||
$(objpfx)check-obsolete-constructs.out: \
|
||
$(..)scripts/check-obsolete-constructs.py $(headers)
|
||
$(PYTHON) $^ > $@ 2>&1; \
|
||
$(evaluate-test)
|
||
|
||
endif # $(headers)
|
||
|
||
# This makes all the auxiliary and test programs.
|
||
|
||
.PHONY: others tests bench bench-build
|
||
|
||
# Test programs for the pretty printers.
|
||
tests-printers-programs := $(addprefix $(objpfx),$(tests-printers))
|
||
|
||
# .out files with the output of running the pretty printer tests.
|
||
tests-printers-out := $(patsubst %,$(objpfx)%.out,$(tests-printers))
|
||
|
||
ifeq ($(build-programs),yes)
|
||
others: $(addprefix $(objpfx),$(others) $(sysdep-others) $(extra-objs))
|
||
else
|
||
others: $(addprefix $(objpfx),$(extra-objs))
|
||
endif
|
||
|
||
# Generate constant files for Python pretty printers if required.
|
||
others: $(py-const)
|
||
|
||
ifeq ($(run-built-tests),no)
|
||
tests: $(addprefix $(objpfx),$(filter-out $(tests-unsupported), \
|
||
$(tests) $(tests-internal) \
|
||
$(tests-container)) \
|
||
$(test-srcs)) $(tests-special) \
|
||
$(tests-printers-programs)
|
||
xtests: tests $(xtests-special)
|
||
else
|
||
tests: $(tests:%=$(objpfx)%.out) $(tests-internal:%=$(objpfx)%.out) \
|
||
$(tests-container:%=$(objpfx)%.out) \
|
||
$(tests-special) $(tests-printers-out)
|
||
xtests: tests $(xtests:%=$(objpfx)%.out) $(xtests-special)
|
||
endif
|
||
|
||
tests-special-notdir = $(patsubst $(objpfx)%, %, $(tests-special))
|
||
xtests-special-notdir = $(patsubst $(objpfx)%, %, $(xtests-special))
|
||
ifeq ($(run-built-tests),no)
|
||
tests-expected =
|
||
else
|
||
tests-expected = $(tests) $(tests-internal) $(tests-printers) \
|
||
$(tests-container)
|
||
endif
|
||
tests:
|
||
$(..)scripts/merge-test-results.sh -s $(objpfx) $(subdir) \
|
||
$(sort $(tests-expected) $(tests-special-notdir:.out=)) \
|
||
> $(objpfx)subdir-tests.sum
|
||
xtests:
|
||
$(..)scripts/merge-test-results.sh -s $(objpfx) $(subdir) \
|
||
$(sort $(xtests) $(xtests-special-notdir:.out=)) \
|
||
> $(objpfx)subdir-xtests.sum
|
||
|
||
ifeq ($(build-programs),yes)
|
||
binaries-all-notests = $(others) $(sysdep-others)
|
||
binaries-all-tests = $(tests) $(tests-internal) $(xtests) $(test-srcs) \
|
||
$(tests-container)
|
||
binaries-all = $(binaries-all-notests) $(binaries-all-tests)
|
||
binaries-static-notests = $(others-static)
|
||
binaries-static-tests = $(tests-static) $(xtests-static)
|
||
binaries-static = $(binaries-static-notests) $(binaries-static-tests)
|
||
ifeq (yesyes,$(have-fpie)$(build-shared))
|
||
binaries-pie-tests = $(tests-pie) $(xtests-pie)
|
||
binaries-pie-notests = $(others-pie)
|
||
else
|
||
binaries-pie-tests =
|
||
binaries-pie-notests =
|
||
endif
|
||
else
|
||
binaries-all-notests =
|
||
binaries-all-tests = $(tests) $(tests-internal) $(xtests) $(test-srcs)
|
||
binaries-all = $(binaries-all-tests)
|
||
binaries-static-notests =
|
||
binaries-static-tests =
|
||
binaries-static =
|
||
binaries-pie-tests =
|
||
binaries-pie-notests =
|
||
endif
|
||
|
||
binaries-pie = $(binaries-pie-tests) $(binaries-pie-notests)
|
||
binaries-shared-tests = $(filter-out $(binaries-pie) $(binaries-static), \
|
||
$(binaries-all-tests))
|
||
binaries-shared-notests = $(filter-out $(binaries-pie) $(binaries-static), \
|
||
$(binaries-all-notests))
|
||
|
||
ifneq "$(strip $(binaries-shared-notests))" ""
|
||
$(addprefix $(objpfx),$(binaries-shared-notests)): %: %.o \
|
||
$(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
|
||
$(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
|
||
$(+link)
|
||
endif
|
||
|
||
ifneq "$(strip $(binaries-shared-tests))" ""
|
||
$(addprefix $(objpfx),$(binaries-shared-tests)): %: %.o \
|
||
$(link-extra-libs-tests) \
|
||
$(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
|
||
$(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
|
||
$(+link-tests)
|
||
endif
|
||
|
||
ifneq "$(strip $(binaries-pie-tests))" ""
|
||
$(addprefix $(objpfx),$(binaries-pie-tests)): %: %.o \
|
||
$(link-extra-libs-tests) \
|
||
$(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
|
||
$(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
|
||
$(+link-pie-tests)
|
||
endif
|
||
|
||
ifneq "$(strip $(binaries-pie-notests))" ""
|
||
$(addprefix $(objpfx),$(binaries-pie-notests)): %: %.o \
|
||
$(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
|
||
$(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
|
||
$(+link-pie)
|
||
endif
|
||
|
||
ifneq "$(strip $(binaries-static-notests))" ""
|
||
$(addprefix $(objpfx),$(binaries-static-notests)): %: %.o \
|
||
$(sort $(filter $(common-objpfx)lib%,$(link-libc-static))) \
|
||
$(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
|
||
$(+link-static)
|
||
endif
|
||
|
||
ifneq "$(strip $(binaries-static-tests))" ""
|
||
$(addprefix $(objpfx),$(binaries-static-tests)): %: %.o \
|
||
$(link-extra-libs-tests) \
|
||
$(sort $(filter $(common-objpfx)lib%,$(link-libc-static-tests))) \
|
||
$(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
|
||
$(+link-static-tests)
|
||
endif
|
||
|
||
ifneq "$(strip $(tests) $(tests-internal) $(xtests) $(test-srcs))" ""
|
||
# These are the implicit rules for making test outputs
|
||
# from the test programs and whatever input files are present.
|
||
|
||
define make-test-out
|
||
$(if $($*-ENV-only),$(test-wrapper-env-only) $($*-ENV-only),\
|
||
$(test-wrapper-env) $(run-program-env) $($*-ENV)) \
|
||
$(host-test-program-cmd) $($*-ARGS)
|
||
endef
|
||
$(objpfx)%.out: %.input $(objpfx)%
|
||
$(make-test-out) > $@ < $(word 1,$^); \
|
||
$(evaluate-test)
|
||
$(objpfx)%.out: /dev/null $(objpfx)% # Make it 2nd arg for canned sequence.
|
||
$(make-test-out) > $@; \
|
||
$(evaluate-test)
|
||
|
||
|
||
# Any tests that require an isolated container (filesystem, network
|
||
# and pid namespaces) in which to run, should be added to
|
||
# tests-container.
|
||
$(tests-container:%=$(objpfx)%.out): $(objpfx)%.out : $(if $(wildcard $(objpfx)%.files),$(objpfx)%.files,/dev/null) $(objpfx)%
|
||
$(test-wrapper-env) $(run-program-env) $(run-via-rtld-prefix) \
|
||
$(common-objpfx)support/test-container env $(run-program-env) $($*-ENV) \
|
||
$(host-test-program-cmd) $($*-ARGS) > $@; \
|
||
$(evaluate-test)
|
||
|
||
|
||
# tests-unsupported lists tests that we will not try to build at all in
|
||
# this configuration. Note this runs every time because it does not
|
||
# actually create its target. The dependency on Makefile is meant to
|
||
# ensure that it runs after a Makefile change to add a test to the list
|
||
# when it previously ran and produced a .out file (probably for a failure).
|
||
ifneq "$(strip $(tests-unsupported))" ""
|
||
$(tests-unsupported:%=$(objpfx)%.out): $(objpfx)%.out: Makefile
|
||
@rm -f $@
|
||
$(..)scripts/evaluate-test.sh $(patsubst $(common-objpfx)%.out,%,$@) \
|
||
77 false false > $(@:.out=.test-result)
|
||
endif
|
||
|
||
endif # tests
|
||
|
||
ifneq "$(strip $(tests-printers))" ""
|
||
|
||
# Static pattern rule for building the test programs for the pretty printers.
|
||
$(tests-printers-programs): %: %.o $(tests-printers-libs) \
|
||
$(sort $(filter $(common-objpfx)lib%,$(link-libc-static-tests))) \
|
||
$(addprefix $(csu-objpfx),start.o) $(+preinit) $(+postinit)
|
||
$(+link-printers-tests)
|
||
|
||
# Add the paths to the generated constants file and test_common_printers.py
|
||
# to PYTHONPATH so the test scripts can find them.
|
||
py-env := PYTHONPATH=$(py-const-dir):$(..)scripts:$${PYTHONPATH}
|
||
|
||
# Static pattern rule that matches the test-* targets to their .c and .py
|
||
# prerequisites. It'll run the corresponding test script for each test program
|
||
# we compiled and place its output in the corresponding .out file.
|
||
# The pretty printer files and test_common_printers.py must be present for all.
|
||
$(tests-printers-out): $(objpfx)%.out: $(objpfx)% %.py %.c $(pretty-printers) \
|
||
$(..)scripts/test_printers_common.py
|
||
$(test-wrapper-env) $(py-env) \
|
||
$(PYTHON) $*.py $*.c $(objpfx)$* $(pretty-printers) > $@; \
|
||
$(evaluate-test)
|
||
endif
|
||
|
||
|
||
.PHONY: distclean realclean subdir_distclean subdir_realclean \
|
||
subdir_clean subdir_mostlyclean subdir_testclean
|
||
subdir_mostlyclean: mostlyclean
|
||
subdir_clean: clean
|
||
subdir_distclean: distclean
|
||
subdir_realclean: realclean
|
||
subdir_testclean: do-tests-clean
|
||
realclean: distclean
|
||
distclean: clean
|
||
|
||
# We want to install everything except the library itself, but update all
|
||
# our portions of the library because the parent make will install it later
|
||
# (likewise the stubs file).
|
||
.PHONY: subdir_install
|
||
subdir_install: install-no-libc.a lib-noranlib stubs
|
||
|
||
.PHONY: subdir_objs subdir_stubs
|
||
subdir_objs: objs
|
||
subdir_stubs: stubs
|
||
|
||
# Target required by the Hurd to ensure that all the MiG-generated
|
||
# headers are in place before building a subdirectory.
|
||
.PHONY: before-compile
|
||
before-compile: $(before-compile)
|
||
|
||
$(common-objpfx)dummy.o: $(common-objpfx)dummy.c $(before-compile);
|
||
$(compile-command.c)
|
||
|
||
# Local Variables:
|
||
# mode: makefile
|
||
# End:
|