From: Zack Weinberg Date: Sun, 17 Mar 2019 01:01:12 +0000 (-0400) Subject: Limit the set of strings.h functions also exposed in string.h. X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7e2c24ffcbb36f4c568da4d7c6b31f89b21613ab;p=thirdparty%2Fglibc.git Limit the set of strings.h functions also exposed in string.h. As someone who can remember when you might not be able to include both string.h and strings.h at the same time, it annoys me that strings.h still exists and is the only standard source for str(n)casecmp(_l) and ffs. I think it’s right that we expose those functions from string.h. However, there’s no reason we need to keep exposing the other obsolete functions that strings.h declares from string.h. This patch creates , which declares the non-obsolete functions whose official home is strings.h. strings.h includes it unconditionally, and string.h includes it under __USE_MISC, instead of strings.h. Two tests of the obsolete strings.h functions had to be adjusted. * string/strings.h (strcasecmp, strncasecmp, strcasecmp_l) (strncasecmp_l, ffs, ffsl, ffsll): Move declarations to... * string/bits/strings_x2k8.h: ... this new file. * string/Makefile: Install bits/strings_x2k8.h. * include/bits/strings_x2k8h: New wrapper. * string/string.h: Include bits/strings_x2k8.h instead of strings.h. * debug/tst-chk1.c, string/test-string.h: Include strings.h. * scripts/check-obsolete-constructs.py: string.h is no longer expected to include strings.h. * sysdeps/i386/i686/multiarch/bcopy.c * sysdeps/i386/i686/multiarch/bzero.c * sysdeps/i386/i686/multiarch/ifunc-impl-list.c * sysdeps/powerpc/powerpc32/power4/multiarch/ifunc-impl-list.c * sysdeps/powerpc/powerpc64/multiarch/bcopy-ppc64.c * sysdeps/powerpc/powerpc64/multiarch/bcopy.c * sysdeps/powerpc/powerpc64/multiarch/ifunc-impl-list.c * sysdeps/s390/bzero.c * sysdeps/s390/multiarch/ifunc-impl-list.c * sysdeps/sparc/sparc64/multiarch/bzero.c * sysdeps/sparc/sparc64/multiarch/ifunc-impl-list.c: Include strings.h. --- diff --git a/NEWS b/NEWS index 599db8f4f9b..93be478f333 100644 --- a/NEWS +++ b/NEWS @@ -187,6 +187,9 @@ Deprecated and removed features, and other changes affecting compatibility: * The obsolete and never-implemented XSI STREAMS header files and have been removed. +* The obsolete functions bcmp, bcopy, bzero, index, and rindex are no + longer declared in , only . + * The typedefs u_int8_t, u_int16_t, u_int32_t, u_int64_t, and register_t are no longer defined by in strict conformance modes. These types were historically provided by on BSD systems, diff --git a/debug/tst-chk1.c b/debug/tst-chk1.c index 5d02592978b..ae7d0c289af 100644 --- a/debug/tst-chk1.c +++ b/debug/tst-chk1.c @@ -30,6 +30,7 @@ #include #include #include +#include #include #include #include diff --git a/include/bits/strings_x2k8.h b/include/bits/strings_x2k8.h new file mode 100644 index 00000000000..7eddd92d931 --- /dev/null +++ b/include/bits/strings_x2k8.h @@ -0,0 +1 @@ +#include diff --git a/scripts/check-obsolete-constructs.py b/scripts/check-obsolete-constructs.py index 77253dfb1d4..dfe0d0fff5e 100755 --- a/scripts/check-obsolete-constructs.py +++ b/scripts/check-obsolete-constructs.py @@ -506,7 +506,6 @@ HEADER_ALLOWED_INCLUDES = { "inttypes.h": [ "stdint.h" ], "signal.h": [ "sys/ucontext.h" ], "stdlib.h": [ "alloca.h", "sys/types.h" ], - "string.h": [ "strings.h" ], "tgmath.h": [ "complex.h", "math.h" ], "threads.h": [ "time.h" ], diff --git a/string/Makefile b/string/Makefile index c46785f1a13..d9503bd2b35 100644 --- a/string/Makefile +++ b/string/Makefile @@ -23,7 +23,7 @@ subdir := string include ../Makeconfig headers := string.h bits/string_fortified.h \ - strings.h bits/strings_fortified.h \ + strings.h bits/strings_x2k8.h bits/strings_fortified.h \ byteswap.h bits/byteswap.h \ endian.h bits/endian.h bits/endianness.h \ bits/uintn-identity.h \ diff --git a/string/bits/strings_x2k8.h b/string/bits/strings_x2k8.h new file mode 100644 index 00000000000..dbcb0b2c31b --- /dev/null +++ b/string/bits/strings_x2k8.h @@ -0,0 +1,70 @@ +/* Copyright (C) 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 + . */ + +#ifndef _BITS_STRINGS_X2K8_H +#define _BITS_STRINGS_X2K8_H 1 + +/* This header file declares all of the strings.h functions that are + not marked as "obsolete" in POSIX.1-2008. As a GNU extension, + these functions are also made available via string.h. */ + +#if !defined _STRING_H && !defined _STRINGS_H +# error "Never include directly, use ." +#endif + +__BEGIN_DECLS + +/* Compare S1 and S2, ignoring case. */ +extern int strcasecmp (const char *__s1, const char *__s2) + __THROW __attribute_pure__ __nonnull ((1, 2)); + +/* Compare no more than N chars of S1 and S2, ignoring case. */ +extern int strncasecmp (const char *__s1, const char *__s2, size_t __n) + __THROW __attribute_pure__ __nonnull ((1, 2)); + +#ifdef __USE_XOPEN2K8 +/* POSIX.1-2008 extended locale interface (see locale.h). */ +# include + +/* Compare S1 and S2, ignoring case, using collation rules from LOC. */ +extern int strcasecmp_l (const char *__s1, const char *__s2, locale_t __loc) + __THROW __attribute_pure__ __nonnull ((1, 2, 3)); + +/* Compare no more than N chars of S1 and S2, ignoring case, using + collation rules from LOC. */ +extern int strncasecmp_l (const char *__s1, const char *__s2, + size_t __n, locale_t __loc) + __THROW __attribute_pure__ __nonnull ((1, 2, 4)); +#endif + +#if defined __USE_MISC || !defined __USE_XOPEN2K8 || defined __USE_XOPEN2K8XSI +/* Return the position of the first bit set in I, or 0 if none are set. + The least-significant bit is position 1, the most-significant 32. */ +extern int ffs (int __i) __THROW __attribute_const__; +#endif + +/* The following two functions are non-standard but necessary for non-32 bit + platforms. */ +#ifdef __USE_MISC +extern int ffsl (long int __l) __THROW __attribute_const__; +__extension__ extern int ffsll (long long int __ll) + __THROW __attribute_const__; +#endif + +__END_DECLS + +#endif /* bits/strings_x2k8.h */ diff --git a/string/string.h b/string/string.h index 234ee91d4a3..fcb7da84ec9 100644 --- a/string/string.h +++ b/string/string.h @@ -427,7 +427,7 @@ extern char *strerror_l (int __errnum, locale_t __l) __THROW; #endif #ifdef __USE_MISC -# include +# include /* Set N bytes of S to 0. The compiler will not delete a call to this function, even if S is dead after the call. */ diff --git a/string/strings.h b/string/strings.h index 65dfca89357..540eb1514fa 100644 --- a/string/strings.h +++ b/string/strings.h @@ -21,6 +21,8 @@ #include #include +#include + /* Tell the caller that we provide correct C++ prototypes. */ #if defined __cplusplus && __GNUC_PREREQ (4, 4) # define __CORRECT_ISO_CPP_STRINGS_H_PROTO @@ -97,43 +99,6 @@ extern char *rindex (const char *__s, int __c) # endif #endif -#if defined __USE_MISC || !defined __USE_XOPEN2K8 || defined __USE_XOPEN2K8XSI -/* Return the position of the first bit set in I, or 0 if none are set. - The least-significant bit is position 1, the most-significant 32. */ -extern int ffs (int __i) __THROW __attribute_const__; -#endif - -/* The following two functions are non-standard but necessary for non-32 bit - platforms. */ -# ifdef __USE_MISC -extern int ffsl (long int __l) __THROW __attribute_const__; -__extension__ extern int ffsll (long long int __ll) - __THROW __attribute_const__; -# endif - -/* Compare S1 and S2, ignoring case. */ -extern int strcasecmp (const char *__s1, const char *__s2) - __THROW __attribute_pure__ __nonnull ((1, 2)); - -/* Compare no more than N chars of S1 and S2, ignoring case. */ -extern int strncasecmp (const char *__s1, const char *__s2, size_t __n) - __THROW __attribute_pure__ __nonnull ((1, 2)); - -#ifdef __USE_XOPEN2K8 -/* POSIX.1-2008 extended locale interface (see locale.h). */ -# include - -/* Compare S1 and S2, ignoring case, using collation rules from LOC. */ -extern int strcasecmp_l (const char *__s1, const char *__s2, locale_t __loc) - __THROW __attribute_pure__ __nonnull ((1, 2, 3)); - -/* Compare no more than N chars of S1 and S2, ignoring case, using - collation rules from LOC. */ -extern int strncasecmp_l (const char *__s1, const char *__s2, - size_t __n, locale_t __loc) - __THROW __attribute_pure__ __nonnull ((1, 2, 4)); -#endif - __END_DECLS #if __GNUC_PREREQ (3,4) && __USE_FORTIFY_LEVEL > 0 \ diff --git a/string/test-string.h b/string/test-string.h index 0efe5d870ea..a6d8d1eb80f 100644 --- a/string/test-string.h +++ b/string/test-string.h @@ -55,6 +55,7 @@ extern impl_t __start_impls[], __stop_impls[]; #include #include #include +#include #include #include #include diff --git a/sysdeps/i386/i686/multiarch/bcopy.c b/sysdeps/i386/i686/multiarch/bcopy.c index 2145ab7e69f..929dc70321a 100644 --- a/sysdeps/i386/i686/multiarch/bcopy.c +++ b/sysdeps/i386/i686/multiarch/bcopy.c @@ -21,6 +21,7 @@ #if IS_IN (libc) # define bcopy __redirect_bcopy # include +# include # undef bcopy # define SYMBOL_NAME bcopy diff --git a/sysdeps/i386/i686/multiarch/bzero.c b/sysdeps/i386/i686/multiarch/bzero.c index 3b68e1c1134..3655262f1b1 100644 --- a/sysdeps/i386/i686/multiarch/bzero.c +++ b/sysdeps/i386/i686/multiarch/bzero.c @@ -21,6 +21,7 @@ #if IS_IN (libc) # define bzero __redirect_bzero # include +# include # undef bzero # define SYMBOL_NAME bzero diff --git a/sysdeps/i386/i686/multiarch/ifunc-impl-list.c b/sysdeps/i386/i686/multiarch/ifunc-impl-list.c index 23774fbe8a7..8101c0a2db2 100644 --- a/sysdeps/i386/i686/multiarch/ifunc-impl-list.c +++ b/sysdeps/i386/i686/multiarch/ifunc-impl-list.c @@ -18,6 +18,7 @@ #include #include +#include #include #include #include "init-arch.h" diff --git a/sysdeps/powerpc/powerpc32/power4/multiarch/ifunc-impl-list.c b/sysdeps/powerpc/powerpc32/power4/multiarch/ifunc-impl-list.c index fca6c2cbef7..07de0a96abe 100644 --- a/sysdeps/powerpc/powerpc32/power4/multiarch/ifunc-impl-list.c +++ b/sysdeps/powerpc/powerpc32/power4/multiarch/ifunc-impl-list.c @@ -18,6 +18,7 @@ #include #include +#include #include #include #include diff --git a/sysdeps/powerpc/powerpc64/multiarch/bcopy-ppc64.c b/sysdeps/powerpc/powerpc64/multiarch/bcopy-ppc64.c index 0851afa3138..4b530cdb6d9 100644 --- a/sysdeps/powerpc/powerpc64/multiarch/bcopy-ppc64.c +++ b/sysdeps/powerpc/powerpc64/multiarch/bcopy-ppc64.c @@ -17,6 +17,7 @@ . */ #include +#include extern __typeof (bcopy) __bcopy_ppc attribute_hidden; extern __typeof (memmove) __memmove_ppc attribute_hidden; diff --git a/sysdeps/powerpc/powerpc64/multiarch/bcopy.c b/sysdeps/powerpc/powerpc64/multiarch/bcopy.c index 2aebfc0a8e1..1a7c9099d9c 100644 --- a/sysdeps/powerpc/powerpc64/multiarch/bcopy.c +++ b/sysdeps/powerpc/powerpc64/multiarch/bcopy.c @@ -17,6 +17,7 @@ . */ #include +#include #include "init-arch.h" extern __typeof (bcopy) __bcopy_ppc attribute_hidden; diff --git a/sysdeps/powerpc/powerpc64/multiarch/ifunc-impl-list.c b/sysdeps/powerpc/powerpc64/multiarch/ifunc-impl-list.c index b9fef3f43c9..41d133051d7 100644 --- a/sysdeps/powerpc/powerpc64/multiarch/ifunc-impl-list.c +++ b/sysdeps/powerpc/powerpc64/multiarch/ifunc-impl-list.c @@ -18,6 +18,7 @@ #include #include +#include #include #include #include diff --git a/sysdeps/s390/bzero.c b/sysdeps/s390/bzero.c index fc0d46e2e1b..fc641e12fc9 100644 --- a/sysdeps/s390/bzero.c +++ b/sysdeps/s390/bzero.c @@ -19,6 +19,7 @@ #include #if HAVE_MEMSET_IFUNC # include +# include # include # if HAVE_MEMSET_Z900_G5 diff --git a/sysdeps/s390/multiarch/ifunc-impl-list.c b/sysdeps/s390/multiarch/ifunc-impl-list.c index e6195c6e261..0d94949145e 100644 --- a/sysdeps/s390/multiarch/ifunc-impl-list.c +++ b/sysdeps/s390/multiarch/ifunc-impl-list.c @@ -18,6 +18,7 @@ #include #include +#include #include #include #include diff --git a/sysdeps/sparc/sparc64/multiarch/bzero.c b/sysdeps/sparc/sparc64/multiarch/bzero.c index ee501502aad..fc7af26d840 100644 --- a/sysdeps/sparc/sparc64/multiarch/bzero.c +++ b/sysdeps/sparc/sparc64/multiarch/bzero.c @@ -20,6 +20,7 @@ #if IS_IN (libc) # define bzero __redirect_bzero # include +# include # undef bzero # include diff --git a/sysdeps/sparc/sparc64/multiarch/ifunc-impl-list.c b/sysdeps/sparc/sparc64/multiarch/ifunc-impl-list.c index ad79a26169a..2fa7a3a9ef2 100644 --- a/sysdeps/sparc/sparc64/multiarch/ifunc-impl-list.c +++ b/sysdeps/sparc/sparc64/multiarch/ifunc-impl-list.c @@ -18,6 +18,7 @@ #include #include +#include #include #include #include