1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
|
/* ws_diag_control.h
* Turn compiler diagnostic messages on and off.
*
* From FreeRADIUS build.h.
*
* @copyright 2013 The FreeRADIUS server project
*
* That project is covered by the GPLv2, so:
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __WS_DIAG_CONTROL_H__
#define __WS_DIAG_CONTROL_H__
#include "ws_compiler_tests.h"
#ifdef __cplusplus
extern "C" {
#endif
#define XSTRINGIFY(x) #x
/*
* Macros for controlling warnings in various compilers.
*/
#define DIAG_JOINSTR(x,y) XSTRINGIFY(x ## y)
/*
* XXX - this is only for GCC or GCC-compatible compilers, and we only use
* it to have a macro that takes a warning as an argument and turns it
* off in the appropriate fashion for Clang and GCC; it should only be
* used internally in this header.
*/
#define DIAG_DO_PRAGMA(x) _Pragma (#x)
#if defined(__clang__)
/*
* Clang, so we'd use _Pragma("clang diagnostic XXX"), if it's
* supported.
*/
#if WS_IS_AT_LEAST_CLANG_VERSION(2,8)
/*
* This is Clang 2.8 or later: we can use "clang diagnostic ignored -Wxxx"
* and "clang diagnostic push/pop".
*/
#define DIAG_PRAGMA(x) DIAG_DO_PRAGMA(clang diagnostic x)
#define DIAG_OFF(x) DIAG_PRAGMA(push) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
#define DIAG_ON(x) DIAG_PRAGMA(pop)
#endif
/*
* Not all versions of Clang understand -Wpedantic. Clang 4.0 appears
* to be the first version to do so.
*/
#if WS_IS_AT_LEAST_CLANG_VERSION(4,0)
#define DIAG_OFF_PEDANTIC DIAG_OFF(pedantic)
#define DIAG_ON_PEDANTIC DIAG_ON(pedantic)
#else
#define DIAG_OFF_PEDANTIC
#define DIAG_ON_PEDANTIC
#endif
#elif defined(__GNUC__)
/*
* GCC, or a compiler (other than Clang) that claims to be GCC.
* We assume that the compiler accepts _Pragma("GCC diagnostic xxx")
* even if it's only claiming to be GCC.
*/
#if WS_IS_AT_LEAST_GNUC_VERSION(4,8)
/*
* This is GCC 4.8 or later, or a compiler claiming to be that.
* We can use "GCC diagnostic ignored -Wxxx" (introduced in 4.2)
* and "GCC diagnostic push/pop" (introduced in 4.6), *and* gcc
* supports "-Wpedantic" (introduced in 4.8), allowing us to
* turn off pedantic warnings with DIAG_OFF().
*/
#define DIAG_PRAGMA(x) DIAG_DO_PRAGMA(GCC diagnostic x)
#define DIAG_OFF(x) DIAG_PRAGMA(push) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
#define DIAG_ON(x) DIAG_PRAGMA(pop)
/*
* We assume GCC 4.8 and later understand -Wpedantic.
*/
#define DIAG_OFF_PEDANTIC DIAG_OFF(pedantic)
#define DIAG_ON_PEDANTIC DIAG_ON(pedantic)
#else
#define DIAG_OFF_PEDANTIC
#define DIAG_ON_PEDANTIC
#endif
#endif
#ifndef DIAG_OFF
/*
* This is none of the above; we don't have any way to turn diagnostics
* on or off.
*
* XXX - you can do that in MSVC, but it's done differently; we'd
* have to have macros for *particular* diagnostics, using the
* warning flag for GCC and Clang and the error number for MSVC.
*/
#define DIAG_OFF(x)
#define DIAG_ON(x)
#define DIAG_OFF_PEDANTIC
#define DIAG_ON_PEDANTIC
#endif
/* Use for clang specific pragmas, so we can keep -Wpragmas enabled */
#ifdef __clang__
# define DIAG_OFF_CLANG(x) DIAG_OFF(x)
# define DIAG_ON_CLANG(x) DIAG_ON(x)
#else
# define DIAG_OFF_CLANG(x)
# define DIAG_ON_CLANG(x)
#endif
/*
* Suppress complaints about narrowing converstions and about signed vs.
* unsigned comparison.
*
* XXX - this is done solely to squelch complaints from code generated
* by Flex, but newer versions of Flex might fix the code; can we
* check the version of Flex and suppress only the checks that code
* generated by that version of Flex triggers?
*/
#if defined(_MSC_VER)
/*
* Suppress:
*
* warning C4018: signed/unsigned mismatch
* warning C4244: 'initializing' : conversion from '__int64' to 'int', possible loss of data
* warning C4267: 'argument' : conversion from 'size_t' to 'int', possible loss of data
*
* as well as Visual Studio Code Analyzer warnings:
*
* warning C6011: Dereferencing NULL pointer
* warning C6308: 'realloc' might return null pointer
* warning C6386: Buffer overrun
* warning C6387: 'XXX' could be '0'
* warning C28182: Dereferencing NULL pointer
*/
#define DIAG_OFF_FLEX \
__pragma(warning(push)) \
__pragma(warning(disable:4018)) \
__pragma(warning(disable:4244)) \
__pragma(warning(disable:4267)) \
__pragma(warning(disable:6011)) \
__pragma(warning(disable:6308)) \
__pragma(warning(disable:6386)) \
__pragma(warning(disable:6387)) \
__pragma(warning(disable:28182))
#define DIAG_ON_FLEX __pragma(warning(pop))
/*
* XXX - is there an issue with shadowed definitions with MSVC if
* somebody were to happen to use Berkeley YACC rather than Bison?
*/
#define DIAG_OFF_BYACC
#define DIAG_ON_BYACC
#else
/*
* Suppress:
*
* -Wsigned-compare warnings
* -Wshorten-64-to-32 warnings, if the compiler *has* -Wshorten-64-to-32
* -Wunreachable-code warnings
*
* We use DIAG_OFF() and DIAG_ON(), so we only use features that the
* compiler supports.
*
* We disable -Wshorten-64-to-32 if we're using Clang, or if __APPLE__
* is defined; that option was originally added to an Apple version of
* GCC, and at least some versions of Clang support it - given that
* the Clang work started at Apple, it may be in all versions of Clang.
*
* (Does no version of GCC or Clang support the same generic "you're
* narrowing a value, and you didn't throw in a cast to assert that
* you know what you're doing" warning that MSVC does?)
*/
#if defined(__clang__) || defined(__APPLE__)
#define DIAG_OFF_FLEX \
DIAG_OFF(sign-compare) \
DIAG_OFF(shorten-64-to-32) \
DIAG_OFF(unreachable-code)
#define DIAG_ON_FLEX \
DIAG_ON(unreachable-code) \
DIAG_ON(shorten-64-to-32) \
DIAG_ON(sign-compare)
#else
#define DIAG_OFF_FLEX \
DIAG_OFF(sign-compare)
#define DIAG_ON_FLEX \
DIAG_ON(sign-compare)
#endif
/*
* Berkeley YACC and, apparently, some versions of Bison, such as the
* one in Fedora 21, generate a global declaration of yylval, or the
* appropriately prefixed version of yylval, in grammar.h, *even
* though it's been told to generate a pure parser, meaning it
* doesn't have any global variables*. Other versions of Bison, such
* as the one in macOS Sierra don't do that.
*
* That causes a warning due to the local declaration in the parser
* shadowing the global declaration.
*
* So, if we have _Pragma, and have pragmas to suppress diagnostics,
* we use it to turn off -Wshadow warnings.
*
* XXX - do this for Bison only in versions of Bison with this
* problem?
*/
#define DIAG_OFF_BYACC \
DIAG_OFF(shadow)
#define DIAG_ON_BYACC \
DIAG_ON(shadow)
#endif
/*
* For dealing with APIs which are only deprecated in macOS (like the
* OpenSSL and MIT/Heimdal Kerberos APIs).
*
* Dear Apple: this is a cross-platform program, and we're not
* going to use your Shiny New Frameworks on macOS unless there's
* a sufficiently clear benefit to make it worth our while to have
* both macOS and non-macOS versions of the code.
*/
#ifdef __APPLE__
# define USES_APPLE_DEPRECATED_API DIAG_OFF(deprecated-declarations)
# define USES_APPLE_RST DIAG_ON(deprecated-declarations)
#else
# define USES_APPLE_DEPRECATED_API
# define USES_APPLE_RST
#endif
#ifdef __cplusplus
}
#endif
#endif /* __WS_DIAG_CONTROL_H__ */
|