From e15f7de60c26bb75fe1923b17c5f0461164d1a41 Mon Sep 17 00:00:00 2001 From: Zack Weinberg Date: Sun, 20 Nov 2016 20:46:30 -0500 Subject: Split DIAG_* macros to new header libc-diag.h. 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). --- ChangeLog | 24 ++++++++++++++ include/libc-diag.h | 74 +++++++++++++++++++++++++++++++++++++++++++ include/libc-internal.h | 71 +++++++++++------------------------------ malloc/tst-malloc.c | 2 +- malloc/tst-mcheck.c | 2 +- malloc/tst-realloc.c | 2 +- misc/tst-error1.c | 2 +- nptl/tst-mutex1.c | 7 +++- posix/tst-dir.c | 2 +- stdio-common/bug21.c | 2 +- stdio-common/scanf14.c | 2 +- stdio-common/scanf4.c | 2 +- stdio-common/scanf7.c | 2 +- stdio-common/test-vfprintf.c | 2 +- stdio-common/tst-printf.c | 2 +- stdio-common/tst-printfsz.c | 2 +- stdio-common/tst-sprintf.c | 2 +- stdio-common/tst-unlockedio.c | 2 +- stdio-common/tstdiomisc.c | 2 +- stdlib/bug-getcontext.c | 2 +- stdlib/tst-environ.c | 7 +++- string/tester.c | 2 +- string/tst-endian.c | 2 +- time/tst-strptime2.c | 2 +- wcsmbs/tst-wcstof.c | 2 +- 25 files changed, 148 insertions(+), 75 deletions(-) create mode 100644 include/libc-diag.h diff --git a/ChangeLog b/ChangeLog index 6d41756..b2bc03e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,29 @@ 2017-02-25 Zack Weinberg + * 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 + * include/features.h (__GLIBC_USE_DEPRECATED_GETS): New macro. * libio/stdio.h, libio/bits/stdio2.h: Condition gets on __GLIBC_USE (DEPRECATED_GETS). Update comments to indicate diff --git a/include/libc-diag.h b/include/libc-diag.h new file mode 100644 index 0000000..db138c6 --- /dev/null +++ b/include/libc-diag.h @@ -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 + . */ + +#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 */ diff --git a/include/libc-internal.h b/include/libc-internal.h index e4395dd..be6c021 100644 --- a/include/libc-internal.h +++ b/include/libc-internal.h @@ -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 + . */ #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 #endif /* _LIBC_INTERNAL */ diff --git a/malloc/tst-malloc.c b/malloc/tst-malloc.c index 740ac6c..dbc8d4a 100644 --- a/malloc/tst-malloc.c +++ b/malloc/tst-malloc.c @@ -19,7 +19,7 @@ #include #include #include -#include +#include static int errors = 0; diff --git a/malloc/tst-mcheck.c b/malloc/tst-mcheck.c index 2e3cba9..5a66bab 100644 --- a/malloc/tst-mcheck.c +++ b/malloc/tst-mcheck.c @@ -19,7 +19,7 @@ #include #include #include -#include +#include static int errors = 0; diff --git a/malloc/tst-realloc.c b/malloc/tst-realloc.c index 7f1f228..31a58bd 100644 --- a/malloc/tst-realloc.c +++ b/malloc/tst-realloc.c @@ -19,7 +19,7 @@ #include #include #include -#include +#include static int errors = 0; diff --git a/misc/tst-error1.c b/misc/tst-error1.c index a97a22c..9c4a62f 100644 --- a/misc/tst-error1.c +++ b/misc/tst-error1.c @@ -3,7 +3,7 @@ #include #include #include -#include +#include static int do_test (int argc, char *argv[]) diff --git a/nptl/tst-mutex1.c b/nptl/tst-mutex1.c index 8a4f2e6..b2a4b54 100644 --- a/nptl/tst-mutex1.c +++ b/nptl/tst-mutex1.c @@ -20,7 +20,7 @@ #include #include #include - +#include #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) { diff --git a/posix/tst-dir.c b/posix/tst-dir.c index 1a9c7df..fee79b3 100644 --- a/posix/tst-dir.c +++ b/posix/tst-dir.c @@ -26,7 +26,7 @@ #include #include #include -#include +#include /* We expect four arguments: - source directory name diff --git a/stdio-common/bug21.c b/stdio-common/bug21.c index ca27272..7a8c6a3 100644 --- a/stdio-common/bug21.c +++ b/stdio-common/bug21.c @@ -1,5 +1,5 @@ #include -#include +#include static int do_test (void) diff --git a/stdio-common/scanf14.c b/stdio-common/scanf14.c index cffccb0..2bcd9c9 100644 --- a/stdio-common/scanf14.c +++ b/stdio-common/scanf14.c @@ -2,7 +2,7 @@ #include #include #include -#include +#include #define FAIL() \ do { \ diff --git a/stdio-common/scanf4.c b/stdio-common/scanf4.c index 9bb14bb..7a2abec 100644 --- a/stdio-common/scanf4.c +++ b/stdio-common/scanf4.c @@ -1,6 +1,6 @@ #include #include -#include +#include int main(int arc, char *argv[]) diff --git a/stdio-common/scanf7.c b/stdio-common/scanf7.c index 53ddf4c..f568738 100644 --- a/stdio-common/scanf7.c +++ b/stdio-common/scanf7.c @@ -1,6 +1,6 @@ #include #include -#include +#include int main (int argc, char *argv[]) diff --git a/stdio-common/test-vfprintf.c b/stdio-common/test-vfprintf.c index f1805d5..f8bb9ce 100644 --- a/stdio-common/test-vfprintf.c +++ b/stdio-common/test-vfprintf.c @@ -25,7 +25,7 @@ #include #include #include -#include +#include const char *locs[] = diff --git a/stdio-common/tst-printf.c b/stdio-common/tst-printf.c index 719b3eb..b6d62a5 100644 --- a/stdio-common/tst-printf.c +++ b/stdio-common/tst-printf.c @@ -26,7 +26,7 @@ #endif #include -#include +#include /* This whole file is picayune tests of corner cases of printf format strings. The compiler warnings are not useful here. */ diff --git a/stdio-common/tst-printfsz.c b/stdio-common/tst-printfsz.c index 8a3385f..47aa853 100644 --- a/stdio-common/tst-printfsz.c +++ b/stdio-common/tst-printfsz.c @@ -2,7 +2,7 @@ #include #include #include -#include +#include #define V 12345678.12345678 diff --git a/stdio-common/tst-sprintf.c b/stdio-common/tst-sprintf.c index d5284b9..cbd3544 100644 --- a/stdio-common/tst-sprintf.c +++ b/stdio-common/tst-sprintf.c @@ -2,7 +2,7 @@ #include #include #include -#include +#include static int diff --git a/stdio-common/tst-unlockedio.c b/stdio-common/tst-unlockedio.c index 6eec6fd..35652ce 100644 --- a/stdio-common/tst-unlockedio.c +++ b/stdio-common/tst-unlockedio.c @@ -20,7 +20,7 @@ #include #include #include -#include +#include int fd; static void do_prepare (void); diff --git a/stdio-common/tstdiomisc.c b/stdio-common/tstdiomisc.c index 9c7342d..89009e0 100644 --- a/stdio-common/tstdiomisc.c +++ b/stdio-common/tstdiomisc.c @@ -3,7 +3,7 @@ #include #include #include -#include +#include static int t1 (void) diff --git a/stdlib/bug-getcontext.c b/stdlib/bug-getcontext.c index c407212..163400a 100644 --- a/stdlib/bug-getcontext.c +++ b/stdlib/bug-getcontext.c @@ -5,7 +5,7 @@ #include #include #include -#include +#include static int do_test (void) diff --git a/stdlib/tst-environ.c b/stdlib/tst-environ.c index 6a29fed..b230164 100644 --- a/stdlib/tst-environ.c +++ b/stdlib/tst-environ.c @@ -19,7 +19,7 @@ #include #include #include - +#include #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) diff --git a/string/tester.c b/string/tester.c index ec35024..4b928b4 100644 --- a/string/tester.c +++ b/string/tester.c @@ -32,7 +32,7 @@ #include #include #include -#include +#include #define STREQ(a, b) (strcmp((a), (b)) == 0) diff --git a/string/tst-endian.c b/string/tst-endian.c index 7d39131..d3c7c2c 100644 --- a/string/tst-endian.c +++ b/string/tst-endian.c @@ -3,7 +3,7 @@ #include #include #include -#include +#include #if __GNUC_PREREQ (6, 0) /* GCC 6.0 warns on big endian systems about: diff --git a/time/tst-strptime2.c b/time/tst-strptime2.c index 9273568..8019e7f 100644 --- a/time/tst-strptime2.c +++ b/time/tst-strptime2.c @@ -4,7 +4,7 @@ #include #include #include -#include +#include /* Dummy string is used to match strptime's %s specifier. */ diff --git a/wcsmbs/tst-wcstof.c b/wcsmbs/tst-wcstof.c index 861f659..d3d75f8 100644 --- a/wcsmbs/tst-wcstof.c +++ b/wcsmbs/tst-wcstof.c @@ -3,7 +3,7 @@ #include #include #include -#include +#include static int do_test (void) -- cgit v1.1