The Tcpdump Group git mirrors - tcpdump/blob - diag-control.h

   1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
   2 /*
   3  * Copyright (c) 1993, 1994, 1995, 1996, 1997
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the following acknowledgement:
  16  *      This product includes software developed by the Computer Systems
  17  *      Engineering Group at Lawrence Berkeley Laboratory.
  18  * 4. Neither the name of the University nor of the Laboratory may be used
  19  *    to endorse or promote products derived from this software without
  20  *    specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #ifndef _diag_control_h
  36 #define _diag_control_h
  37
  38 #include "compiler-tests.h"
  39
  40 #ifndef _MSC_VER
  41   /*
  42    * Clang and GCC both support this way of putting pragmas into #defines.
  43    * We don't use it unless we have a compiler that supports it; the
  44    * warning-suppressing pragmas differ between Clang and GCC, so we test
  45    * for both of those separately.
  46    */
  47   #define DIAG_DO_PRAGMA(x) _Pragma (#x)
  48 #endif
  49
  50 /*
  51  * XL C 12.1 and 13.1 for AIX require no attention in this department.
  52  * XL C 16.1 defines both __GNUC__ and __clang__, so has to be tested first.
  53  */
  54 #if ND_IS_AT_LEAST_XL_C_VERSION(16,1)
  55   /*
  56    * See respective Clang note below.
  57    */
  58   #define DIAG_OFF_ASSIGN_ENUM \
  59     DIAG_DO_PRAGMA(clang diagnostic push) \
  60     DIAG_DO_PRAGMA(clang diagnostic ignored "-Wassign-enum")
  61   #define DIAG_ON_ASSIGN_ENUM \
  62     DIAG_DO_PRAGMA(clang diagnostic pop)
  63 /*
  64  * The current clang compilers also define __GNUC__ and __GNUC_MINOR__
  65  * thus we need to test the clang case before the GCC one
  66  */
  67 #elif ND_IS_AT_LEAST_CLANG_VERSION(2,8)
  68   /*
  69    * Clang complains if you OR together multiple enum values of a
  70    * given enum type and them pass it as an argument of that enum
  71    * type.  Some libcap-ng routines use enums to define bit flags;
  72    * we want to squelch the warnings that produces.
  73    */
  74   #define DIAG_OFF_ASSIGN_ENUM \
  75     DIAG_DO_PRAGMA(clang diagnostic push) \
  76     DIAG_DO_PRAGMA(clang diagnostic ignored "-Wassign-enum")
  77   #define DIAG_ON_ASSIGN_ENUM \
  78     DIAG_DO_PRAGMA(clang diagnostic pop)
  79
  80   /*
  81    * It also legitimately complains about some code in the BSD
  82    * getopt_long() - that code explicitly and deliberately
  83    * violates the contract by permuting the argument vector
  84    * (declared as char const *argv[], meaning "I won't change
  85    * the vector by changing any of its elements), as do the
  86    * GNU and Solaris getopt_long().  This is documented in the
  87    * man pages for all versions; it can be suppressed by setting
  88    * the environment variable POSIXLY_CORRECT or by putting a "+"
  89    * at the beginning of the option string.
  90    *
  91    * We suppress the warning.
  92    */
  93   #define DIAG_OFF_CAST_QUAL \
  94     DIAG_DO_PRAGMA(clang diagnostic push) \
  95     DIAG_DO_PRAGMA(clang diagnostic ignored "-Wcast-qual")
  96   #define DIAG_ON_CAST_QUAL \
  97     DIAG_DO_PRAGMA(clang diagnostic pop)
  98
  99   /*
 100    * Suppress deprecation warnings.
 101    */
 102   #define DIAG_OFF_DEPRECATION \
 103     DIAG_DO_PRAGMA(clang diagnostic push) \
 104     DIAG_DO_PRAGMA(clang diagnostic ignored "-Wdeprecated-declarations")
 105   #define DIAG_ON_DEPRECATION \
 106     DIAG_DO_PRAGMA(clang diagnostic pop)
 107
 108   /*
 109    * Clang supports the generic C11 extension even if run with the -std=gnu99
 110    * flag, which leads FreeBSD <sys/cdefs.h> to use the extension, which
 111    * results in Clang emitting a -Wc11-extensions warning. The warning is not
 112    * documented in the user manual, but it happens with Clang 10.0.1 on
 113    * FreeBSD 12.2, so let's use that as a reference.
 114    */
 115   #if ND_IS_AT_LEAST_CLANG_VERSION(10,0)
 116     #define DIAG_OFF_C11_EXTENSIONS \
 117       DIAG_DO_PRAGMA(clang diagnostic push) \
 118       DIAG_DO_PRAGMA(clang diagnostic ignored "-Wc11-extensions")
 119     #define DIAG_ON_C11_EXTENSIONS \
 120       DIAG_DO_PRAGMA(clang diagnostic pop)
 121   #endif
 122 #elif ND_IS_AT_LEAST_GNUC_VERSION(4,2)
 123   /* GCC apparently doesn't complain about ORing enums together. */
 124
 125   /*
 126    * It does, however, complain about casting away constness in
 127    * missing/getopt_long.c.
 128    */
 129   #define DIAG_OFF_CAST_QUAL \
 130     DIAG_DO_PRAGMA(GCC diagnostic push) \
 131     DIAG_DO_PRAGMA(GCC diagnostic ignored "-Wcast-qual")
 132   #define DIAG_ON_CAST_QUAL \
 133     DIAG_DO_PRAGMA(GCC diagnostic pop)
 134
 135   #if ND_IS_AT_LEAST_GNUC_VERSION(4,5)
 136     /*
 137      * GCC warns about unused return values if a function is marked as
 138      * "warn about ignoring this function's return value".
 139      *
 140      * Clang appears to let you ignore a result without a warning by
 141      * casting the function result to void, so we don't appear to
 142      * need this for Clang.
 143      */
 144     #define DIAG_OFF_WARN_UNUSED_RESULT \
 145       DIAG_DO_PRAGMA(GCC diagnostic push) \
 146       DIAG_DO_PRAGMA(GCC diagnostic ignored "-Wunused-result")
 147     #define DIAG_ON_WARN_UNUSED_RESULT \
 148       DIAG_DO_PRAGMA(GCC diagnostic pop)
 149   #endif
 150
 151   /*
 152    * Suppress deprecation warnings.
 153    */
 154   #define DIAG_OFF_DEPRECATION \
 155     DIAG_DO_PRAGMA(GCC diagnostic push) \
 156     DIAG_DO_PRAGMA(GCC diagnostic ignored "-Wdeprecated-declarations")
 157   #define DIAG_ON_DEPRECATION \
 158     DIAG_DO_PRAGMA(GCC diagnostic pop)
 159   /*
 160    * GCC supports -Wc99-c11-compat since version 5.1.0, but the warning does
 161    * not trigger for now, so let's just leave it be.
 162    */
 163 #endif
 164
 165 /*
 166  * GCC needs this on AIX for longjmp().
 167  */
 168 #if ND_IS_AT_LEAST_GNUC_VERSION(5,1)
 169   /*
 170    * Beware that the effect of this builtin is more than just squelching the
 171    * warning! GCC trusts it enough for the process to segfault if the control
 172    * flow reaches the builtin (an infinite empty loop in the same context would
 173    * squelch the warning and ruin the process too, albeit in a different way).
 174    * So please remember to use this very carefully.
 175    */
 176   #define ND_UNREACHABLE __builtin_unreachable();
 177 #endif
 178
 179 #ifndef DIAG_OFF_ASSIGN_ENUM
 180 #define DIAG_OFF_ASSIGN_ENUM
 181 #endif
 182 #ifndef DIAG_ON_ASSIGN_ENUM
 183 #define DIAG_ON_ASSIGN_ENUM
 184 #endif
 185 #ifndef DIAG_OFF_CAST_QUAL
 186 #define DIAG_OFF_CAST_QUAL
 187 #endif
 188 #ifndef DIAG_ON_CAST_QUAL
 189 #define DIAG_ON_CAST_QUAL
 190 #endif
 191 #ifndef DIAG_OFF_WARN_UNUSED_RESULT
 192 #define DIAG_OFF_WARN_UNUSED_RESULT
 193 #endif
 194 #ifndef DIAG_ON_WARN_UNUSED_RESULT
 195 #define DIAG_ON_WARN_UNUSED_RESULT
 196 #endif
 197 #ifndef DIAG_OFF_DEPRECATION
 198 #define DIAG_OFF_DEPRECATION
 199 #endif
 200 #ifndef DIAG_ON_DEPRECATION
 201 #define DIAG_ON_DEPRECATION
 202 #endif
 203 #ifndef DIAG_OFF_C11_EXTENSIONS
 204 #define DIAG_OFF_C11_EXTENSIONS
 205 #endif
 206 #ifndef DIAG_ON_C11_EXTENSIONS
 207 #define DIAG_ON_C11_EXTENSIONS
 208 #endif
 209 #ifndef ND_UNREACHABLE
 210 #define ND_UNREACHABLE
 211 #endif
 212
 213 #endif /* _diag_control_h */