]> git.ipfire.org Git - thirdparty/glibc.git/commitdiff
Split DIAG_* macros to new header libc-diag.h.
authorZack Weinberg <zackw@panix.com>
Mon, 21 Nov 2016 01:46:30 +0000 (20:46 -0500)
committerZack Weinberg <zackw@panix.com>
Sat, 25 Feb 2017 14:59:46 +0000 (09:59 -0500)
Quite a few tests include libc-internal.h just for the DIAG_* macros.
Split those macros to their own file, which can be included safely in
_ISOMAC mode.  I also moved ignore_value, since it seems logically
related, even though I didn't notice any tests needing it.

Also add -Wnonnull suppressions to two tests that _should_ have them,
but the error is masked when compiling against internal headers.

* include/libc-diag.h: New file.  Define ignore_value,
DIAG_PUSH_NEEDS_COMMENT, DIAG_POP_NEEDS_COMMENT,
DIAG_IGNORE_NEEDS_COMMENT, and DIAG_IGNORE_Os_NEEDS_COMMENT here.

* include/libc-internal.h: Definitions of above macros moved from
here.  Include libc-diag.h.  Add copyright notice.

* malloc/tst-malloc.c, malloc/tst-memcheck.c, malloc/tst-realloc.c
* misc/tst-error1.c, posix/tst-dir.c, stdio-common/bug21.c
* stdio-common/scanf14.c, stdio-common/scanf4.c, stdio-common/scanf7.c
* stdio-common/test-vfprintf.c, stdio-common/tst-printf.c
* stdio-common/tst-printfsz.c, stdio-common/tst-sprintf.c
* stdio-common/tst-unlockedio.c, stdio-common/tstdiomisc.c
* stdlib/bug-getcontext.c, string/tester.c, string/tst-endian.c
* time/tst-strptime2.c, wcsmbs/tst-wcstof.c:
Include libc-diag.h instead of libc-internal.h.

* stdlib/tst-environ.c: Include libc-diag.h.  Suppress -Wnonnull for
call to unsetenv (NULL).
* nptl/tst-mutex1.c: Include libc-diag.h.  Suppress -Wnonnull for
call to pthread_mutexattr_destroy (NULL).

25 files changed:
ChangeLog
include/libc-diag.h [new file with mode: 0644]
include/libc-internal.h
malloc/tst-malloc.c
malloc/tst-mcheck.c
malloc/tst-realloc.c
misc/tst-error1.c
nptl/tst-mutex1.c
posix/tst-dir.c
stdio-common/bug21.c
stdio-common/scanf14.c
stdio-common/scanf4.c
stdio-common/scanf7.c
stdio-common/test-vfprintf.c
stdio-common/tst-printf.c
stdio-common/tst-printfsz.c
stdio-common/tst-sprintf.c
stdio-common/tst-unlockedio.c
stdio-common/tstdiomisc.c
stdlib/bug-getcontext.c
stdlib/tst-environ.c
string/tester.c
string/tst-endian.c
time/tst-strptime2.c
wcsmbs/tst-wcstof.c

index 6d41756ddaa706f58c3a35e52ff02fc7c25f49a7..b2bc03ebe10716634bdb08244c7642a551bc758f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,27 @@
+2017-02-25  Zack Weinberg  <zackw@panix.com>
+
+       * include/libc-diag.h: New file.  Define ignore_value,
+       DIAG_PUSH_NEEDS_COMMENT, DIAG_POP_NEEDS_COMMENT,
+       DIAG_IGNORE_NEEDS_COMMENT, and DIAG_IGNORE_Os_NEEDS_COMMENT here.
+
+       * include/libc-internal.h: Definitions of above macros moved from
+       here.  Include libc-diag.h.  Add copyright notice.
+
+       * malloc/tst-malloc.c, malloc/tst-memcheck.c, malloc/tst-realloc.c
+       * misc/tst-error1.c, posix/tst-dir.c, stdio-common/bug21.c
+       * stdio-common/scanf14.c, stdio-common/scanf4.c, stdio-common/scanf7.c
+       * stdio-common/test-vfprintf.c, stdio-common/tst-printf.c
+       * stdio-common/tst-printfsz.c, stdio-common/tst-sprintf.c
+       * stdio-common/tst-unlockedio.c, stdio-common/tstdiomisc.c
+       * stdlib/bug-getcontext.c, string/tester.c, string/tst-endian.c
+       * time/tst-strptime2.c, wcsmbs/tst-wcstof.c:
+       Include libc-diag.h instead of libc-internal.h.
+
+       * stdlib/tst-environ.c: Include libc-diag.h.  Suppress -Wnonnull for
+       call to unsetenv (NULL).
+       * nptl/tst-mutex1.c: Include libc-diag.h.  Suppress -Wnonnull for
+       call to pthread_mutexattr_destroy (NULL).
+
 2017-02-25  Zack Weinberg  <zackw@panix.com>
 
        * include/features.h (__GLIBC_USE_DEPRECATED_GETS): New macro.
diff --git a/include/libc-diag.h b/include/libc-diag.h
new file mode 100644 (file)
index 0000000..db138c6
--- /dev/null
@@ -0,0 +1,74 @@
+/* Macros for controlling diagnostic output from the compiler.
+   Copyright (C) 2014-2017 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/>.  */
+
+#ifndef _LIBC_DIAG_H
+#define _LIBC_DIAG_H 1
+
+/* Ignore the value of an expression when a cast to void does not
+   suffice (in particular, for a call to a function declared with
+   attribute warn_unused_result).  */
+#define ignore_value(x) \
+  ({ __typeof__ (x) __ignored_value = (x); (void) __ignored_value; })
+
+/* The macros to control diagnostics are structured like this, rather
+   than a single macro that both pushes and pops diagnostic state and
+   takes the affected code as an argument, because the GCC pragmas
+   work by disabling the diagnostic for a range of source locations
+   and do not work when all the pragmas and the affected code are in a
+   single macro expansion.  */
+
+/* Push diagnostic state.  */
+#define DIAG_PUSH_NEEDS_COMMENT _Pragma ("GCC diagnostic push")
+
+/* Pop diagnostic state.  */
+#define DIAG_POP_NEEDS_COMMENT _Pragma ("GCC diagnostic pop")
+
+#define _DIAG_STR1(s) #s
+#define _DIAG_STR(s) _DIAG_STR1(s)
+
+/* Ignore the diagnostic OPTION.  VERSION is the most recent GCC
+   version for which the diagnostic has been confirmed to appear in
+   the absence of the pragma (in the form MAJOR.MINOR for GCC 4.x,
+   just MAJOR for GCC 5 and later).  Uses of this pragma should be
+   reviewed when the GCC version given is no longer supported for
+   building glibc; the version number should always be on the same
+   source line as the macro name, so such uses can be found with grep.
+   Uses should come with a comment giving more details of the
+   diagnostic, and an architecture on which it is seen if possibly
+   optimization-related and not in architecture-specific code.  This
+   macro should only be used if the diagnostic seems hard to fix (for
+   example, optimization-related false positives).  */
+#define DIAG_IGNORE_NEEDS_COMMENT(version, option)     \
+  _Pragma (_DIAG_STR (GCC diagnostic ignored option))
+
+/* Similar to DIAG_IGNORE_NEEDS_COMMENT the following macro ignores the
+   diagnostic OPTION but only if optimizations for size are enabled.
+   This is required because different warnings may be generated for
+   different optimization levels.  For example a key piece of code may
+   only generate a warning when compiled at -Os, but at -O2 you could
+   still want the warning to be enabled to catch errors.  In this case
+   you would use DIAG_IGNORE_Os_NEEDS_COMMENT to disable the warning
+   only for -Os.  */
+#ifdef __OPTIMIZE_SIZE__
+# define DIAG_IGNORE_Os_NEEDS_COMMENT(version, option) \
+  _Pragma (_DIAG_STR (GCC diagnostic ignored option))
+#else
+# define DIAG_IGNORE_Os_NEEDS_COMMENT(version, option)
+#endif
+
+#endif /* libc-diag.h */
index e4395dd5c5666d6e09d4a1a52801ea2cd4ccf84d..be6c02186f1c378d64d64bcd6ed8fae05409e7e6 100644 (file)
@@ -1,5 +1,20 @@
-/* This file contains a number of internal prototype declarations that
-   don't fit anywhere else.  */
+/* Internal prototype declarations that don't fit anywhere else.
+   Copyright (C) 2000-2017 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/>.  */
 
 #ifndef _LIBC_INTERNAL
 # define _LIBC_INTERNAL 1
@@ -74,56 +89,6 @@ extern __typeof (__profile_frequency) __profile_frequency attribute_hidden;
 #define PTR_ALIGN_UP(base, size) \
   ((__typeof__ (base)) ALIGN_UP ((uintptr_t) (base), (size)))
 
-/* Ignore the value of an expression when a cast to void does not
-   suffice (in particular, for a call to a function declared with
-   attribute warn_unused_result).  */
-#define ignore_value(x) \
-  ({ __typeof__ (x) __ignored_value = (x); (void) __ignored_value; })
-
-/* The macros to control diagnostics are structured like this, rather
-   than a single macro that both pushes and pops diagnostic state and
-   takes the affected code as an argument, because the GCC pragmas
-   work by disabling the diagnostic for a range of source locations
-   and do not work when all the pragmas and the affected code are in a
-   single macro expansion.  */
-
-/* Push diagnostic state.  */
-#define DIAG_PUSH_NEEDS_COMMENT _Pragma ("GCC diagnostic push")
-
-/* Pop diagnostic state.  */
-#define DIAG_POP_NEEDS_COMMENT _Pragma ("GCC diagnostic pop")
-
-#define _DIAG_STR1(s) #s
-#define _DIAG_STR(s) _DIAG_STR1(s)
-
-/* Ignore the diagnostic OPTION.  VERSION is the most recent GCC
-   version for which the diagnostic has been confirmed to appear in
-   the absence of the pragma (in the form MAJOR.MINOR for GCC 4.x,
-   just MAJOR for GCC 5 and later).  Uses of this pragma should be
-   reviewed when the GCC version given is no longer supported for
-   building glibc; the version number should always be on the same
-   source line as the macro name, so such uses can be found with grep.
-   Uses should come with a comment giving more details of the
-   diagnostic, and an architecture on which it is seen if possibly
-   optimization-related and not in architecture-specific code.  This
-   macro should only be used if the diagnostic seems hard to fix (for
-   example, optimization-related false positives).  */
-#define DIAG_IGNORE_NEEDS_COMMENT(version, option)     \
-  _Pragma (_DIAG_STR (GCC diagnostic ignored option))
-
-/* Similar to DIAG_IGNORE_NEEDS_COMMENT the following macro ignores the
-   diagnostic OPTION but only if optimizations for size are enabled.
-   This is required because different warnings may be generated for
-   different optimization levels.  For example a key piece of code may
-   only generate a warning when compiled at -Os, but at -O2 you could
-   still want the warning to be enabled to catch errors.  In this case
-   you would use DIAG_IGNORE_Os_NEEDS_COMMENT to disable the warning
-   only for -Os.  */
-#ifdef __OPTIMIZE_SIZE__
-# define DIAG_IGNORE_Os_NEEDS_COMMENT(version, option) \
-  _Pragma (_DIAG_STR (GCC diagnostic ignored option))
-#else
-# define DIAG_IGNORE_Os_NEEDS_COMMENT(version, option)
-#endif
+#include <libc-diag.h>
 
 #endif /* _LIBC_INTERNAL  */
index 740ac6ce31c9c0896f04a417479befdd9b9f4dc5..dbc8d4ab56bc8f7babb634518a975cc2d81934c3 100644 (file)
@@ -19,7 +19,7 @@
 #include <errno.h>
 #include <malloc.h>
 #include <stdio.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int errors = 0;
 
index 2e3cba96b8fd87fefc8a1d8a643d5afe67887cf8..5a66bab33150ead20b37d663740fda4c68b7dca9 100644 (file)
@@ -19,7 +19,7 @@
 #include <errno.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int errors = 0;
 
index 7f1f228c06b649fc1b0337e9cd3342d8e2be41a8..31a58bd0260c3522e4c0f536cf6c9dd58f7c6414 100644 (file)
@@ -19,7 +19,7 @@
 #include <malloc.h>
 #include <stdio.h>
 #include <string.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int errors = 0;
 
index a97a22ce9d2e7e0415d1a34eeaabace2f9266351..9c4a62fbd0bfd3f8ef024392aed1019596d3348f 100644 (file)
@@ -3,7 +3,7 @@
 #include <stdio.h>
 #include <string.h>
 #include <wchar.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int
 do_test (int argc, char *argv[])
index 8a4f2e6e4ec9a47bdaf424ee4d5d9efb864e997a..b2a4b5492aa1ca58f4d9b8b3a4f7843166976f77 100644 (file)
@@ -20,7 +20,7 @@
 #include <stdio.h>
 #include <errno.h>
 #include <stdbool.h>
-
+#include <libc-diag.h>
 
 #ifndef ATTR
 # define ATTR NULL
@@ -45,11 +45,16 @@ do_test (void)
       return 1;
     }
 
+  /* This deliberately tests supplying a null pointer to a function whose
+     argument is marked __attribute__ ((nonnull)). */
+  DIAG_PUSH_NEEDS_COMMENT;
+  DIAG_IGNORE_NEEDS_COMMENT (5, "-Wnonnull");
   if (!ATTR_NULL && pthread_mutexattr_destroy (ATTR) != 0)
     {
       puts ("mutexattr_destroy failed");
       return 1;
     }
+  DIAG_POP_NEEDS_COMMENT;
 
   if (pthread_mutex_lock (&m) != 0)
     {
index 1a9c7dfe9703dea1f5cc1d5b4b3b9884f53103d0..fee79b32a0433a2a80d137abd6ac14802ebd4b46 100644 (file)
@@ -26,7 +26,7 @@
 #include <string.h>
 #include <unistd.h>
 #include <sys/stat.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 /* We expect four arguments:
    - source directory name
index ca27272ba191321e94b68459e87265294ccda2cc..7a8c6a354233ad4e918db595e99d748f5fa206cf 100644 (file)
@@ -1,5 +1,5 @@
 #include <stdio.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int
 do_test (void)
index cffccb0b19d2927b11f29703680f7bb5fb9ffd82..2bcd9c9893db9727f89a4a50175ece7b8dfcb2a8 100644 (file)
@@ -2,7 +2,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <wchar.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 #define FAIL() \
   do {                                                 \
index 9bb14bb16bee036695836916caa94c8729f5f8e0..7a2abec89b692405dccc301497557a8ab7bc9f7c 100644 (file)
@@ -1,6 +1,6 @@
 #include <stdio.h>
 #include <stdlib.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 int
 main(int arc, char *argv[])
index 53ddf4cb093ef4dbd4cf79a21d568bfdd9c21755..f568738d7e2d699aebdc0ac6deda867e68c4b89a 100644 (file)
@@ -1,6 +1,6 @@
 #include <stdio.h>
 #include <stdlib.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 int
 main (int argc, char *argv[])
index f1805d5d005f836db1fe4069ba06aef394a14b06..f8bb9cee58555a9dc4312a398d8f60cc983f35c6 100644 (file)
@@ -25,7 +25,7 @@
 #include <string.h>
 #include <unistd.h>
 #include <sys/stat.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 
 const char *locs[] =
index 719b3eb08cfe25d825badf32be31101e6288a116..b6d62a5a2f840db64948f88a98346a05282422b4 100644 (file)
@@ -26,7 +26,7 @@
 #endif
 
 #include <float.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 /* This whole file is picayune tests of corner cases of printf format strings.
    The compiler warnings are not useful here.  */
index 8a3385f94df9960d62fc35f79312cc4bd04270d4..47aa8536b3aa3036705d7421002335f2ef88762c 100644 (file)
@@ -2,7 +2,7 @@
 #include <printf.h>
 #include <stdio.h>
 #include <string.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 #define V       12345678.12345678
 
index d5284b96979df3a493b9c24357261368d95cde87..cbd35447a987e9d3c24dd13a2ec2c5f9c9d5cf70 100644 (file)
@@ -2,7 +2,7 @@
 #include <stdlib.h>
 #include <locale.h>
 #include <string.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 
 static int
index 6eec6fdbacb2f83c90a0f3edaa729ff0a0131397..35652ce772ca7beeff881c73937c9e2e8b4810cd 100644 (file)
@@ -20,7 +20,7 @@
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 int fd;
 static void do_prepare (void);
index 9c7342d55f491f20f8f40d6c096d626f07b0b975..89009e05490afd5815da97911a377db028ee2f97 100644 (file)
@@ -3,7 +3,7 @@
 #include <stdio.h>
 #include <string.h>
 #include <wchar.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int
 t1 (void)
index c4072129a6828143888437fb835d9b2f21f2d73c..163400acba4ac0f4ab735afa797633d93b764bcc 100644 (file)
@@ -5,7 +5,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <ucontext.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int
 do_test (void)
index 6a29fed62a892a3cf511dcc472f3537a05f0f30f..b2301641f559d46dad1c2f2e7cd3c1f57b6d7701 100644 (file)
@@ -19,7 +19,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
-
+#include <libc-diag.h>
 
 #define VAR "FOOBAR"
 
@@ -196,12 +196,17 @@ do_test (void)
       result = 1;
     }
 
+  /* This deliberately tests supplying a null pointer to a function whose
+     argument is marked __attribute__ ((nonnull)). */
+  DIAG_PUSH_NEEDS_COMMENT;
+  DIAG_IGNORE_NEEDS_COMMENT(5, "-Wnonnull");
   errno = 0;
   if (unsetenv (NULL) >= 0 || errno != EINVAL)
     {
       puts ("unsetenv #1 failed");
       result = 1;
     }
+  DIAG_POP_NEEDS_COMMENT;
 
   errno = 0;
   if (unsetenv ("") >= 0 || errno != EINVAL)
index ec350243ebba795b912681b132a8ab25c4600687..4b928b4f5eb1180c7dbfecfa4bdcd56634aa9a72 100644 (file)
@@ -32,7 +32,7 @@
 #include <string.h>
 #include <strings.h>
 #include <fcntl.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 
 #define        STREQ(a, b)     (strcmp((a), (b)) == 0)
index 7d39131a68efa4d66f02c390f8dba6e867e3e2b8..d3c7c2c4c594b23e83fc515b5c08f28ee19e8938 100644 (file)
@@ -3,7 +3,7 @@
 #include <inttypes.h>
 #include <stdio.h>
 #include <stdint.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 #if __GNUC_PREREQ (6, 0)
 /* GCC 6.0 warns on big endian systems about:
index 9273568b6f6ab65ad66642c7e3d4df6645ce64c1..8019e7f5d8c4c223226a140b7ec96181dde250b2 100644 (file)
@@ -4,7 +4,7 @@
 #include <stdbool.h>
 #include <stdio.h>
 #include <time.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 /* Dummy string is used to match strptime's %s specifier.  */
 
index 861f65905ad5ce6618d020e399083609dd060c3d..d3d75f8f60931cac16cecb276eefaf2b891d2999 100644 (file)
@@ -3,7 +3,7 @@
 #include <stdio.h>
 #include <string.h>
 #include <wctype.h>
-#include <libc-internal.h>
+#include <libc-diag.h>
 
 static int
 do_test (void)