The Tcpdump Group git mirrors - tcpdump/blob - netdissect-stdinc.h

   1 /*
   2  * Copyright (c) 2002 - 2003
   3  * NetGroup, Politecnico di Torino (Italy)
   4  * 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  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  * notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  * notice, this list of conditions and the following disclaimer in the
  14  * documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the Politecnico di Torino nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /*
  33  * Include the appropriate OS header files on Windows and various flavors
  34  * of UNIX, include various non-OS header files on Windows, and define
  35  * various items as needed, to isolate most of netdissect's platform
  36  * differences to this one file.
  37  */
  38
  39 #ifndef netdissect_stdinc_h
  40 #define netdissect_stdinc_h
  41
  42 #include <errno.h>
  43
  44 #include "compiler-tests.h"
  45
  46 #include "varattrs.h"
  47
  48 /*
  49  * Get the C99 types, and the PRI[doux]64 format strings, defined.
  50  */
  51 #ifdef HAVE_PCAP_PCAP_INTTYPES_H
  52   /*
  53    * We have pcap/pcap-inttypes.h; use that, as it'll do all the
  54    * work, and won't cause problems if a file includes this file
  55    * and later includes a pcap header file that also includes
  56    * pcap/pcap-inttypes.h.
  57    */
  58   #include <pcap/pcap-inttypes.h>
  59 #else
  60   /*
  61    * OK, we don't have pcap/pcap-inttypes.h, so we'll have to
  62    * do the work ourselves, but at least we don't have to
  63    * worry about other headers including it and causing
  64    * clashes.
  65    */
  66   #if defined(_MSC_VER)
  67     /*
  68      * Compiler is MSVC.
  69      */
  70     #if _MSC_VER >= 1800
  71       /*
  72        * VS 2013 or newer; we have <inttypes.h>.
  73        */
  74       #include <inttypes.h>
  75     #else
  76       /*
  77        * Earlier VS; we have to define this stuff ourselves.
  78        */
  79       typedef unsigned char uint8_t;
  80       typedef signed char int8_t;
  81       typedef unsigned short uint16_t;
  82       typedef signed short int16_t;
  83       typedef unsigned int uint32_t;
  84       typedef signed int int32_t;
  85       #ifdef _MSC_EXTENSIONS
  86         typedef unsigned _int64 uint64_t;
  87         typedef _int64 int64_t;
  88       #else /* _MSC_EXTENSIONS */
  89         typedef unsigned long long uint64_t;
  90         typedef long long int64_t;
  91       #endif
  92
  93       /*
  94        * We have _strtoi64().  Use that for strtoint64_t().
  95        */
  96       #define strtoint64_t      _strtoi64
  97     #endif
  98
  99     /*
 100      * Suppress definition of intN_t in bittypes.h, which might be included
 101      * by <pcap/pcap.h> in older versions of WinPcap.
 102      * (Yes, HAVE_U_INTn_T, as the definition guards are UN*X-oriented, and
 103      * we check for u_intN_t in the UN*X configure script.)
 104      */
 105     #define HAVE_U_INT8_T
 106     #define HAVE_U_INT16_T
 107     #define HAVE_U_INT32_T
 108     #define HAVE_U_INT64_T
 109
 110     /*
 111      * These may be defined by <inttypes.h>.  If not, define them
 112      * ourselves.
 113      *
 114      * XXX - for MSVC, we always want the _MSC_EXTENSIONS versions.
 115      * What about other compilers?  If, as the MinGW Web site says MinGW
 116      * does, the other compilers just use Microsoft's run-time library,
 117      * then they should probably use the _MSC_EXTENSIONS even if the
 118      * compiler doesn't define _MSC_EXTENSIONS.
 119      */
 120     #ifndef PRId64
 121       #ifdef _MSC_EXTENSIONS
 122         #define PRId64  "I64d"
 123       #else
 124         #define PRId64  "lld"
 125       #endif
 126     #endif /* PRId64 */
 127
 128     #ifndef PRIo64
 129       #ifdef _MSC_EXTENSIONS
 130         #define PRIo64  "I64o"
 131       #else
 132         #define PRIo64  "llo"
 133       #endif
 134     #endif /* PRIo64 */
 135
 136     #ifndef PRIx64
 137       #ifdef _MSC_EXTENSIONS
 138         #define PRIx64  "I64x"
 139       #else
 140         #define PRIx64  "llx"
 141       #endif
 142     #endif
 143
 144     #ifndef PRIu64
 145       #ifdef _MSC_EXTENSIONS
 146         #define PRIu64  "I64u"
 147       #else
 148         #define PRIu64  "llu"
 149       #endif
 150     #endif
 151   #elif defined(__MINGW32__) || !defined(_WIN32)
 152     /*
 153      * Compiler is MinGW or target is UN*X or MS-DOS.  Just use
 154      * <inttypes.h>.
 155      */
 156     #include <inttypes.h>
 157   #endif
 158 #endif /* HAVE_PCAP_PCAP_INTTYPES_H */
 159
 160 #ifdef _WIN32
 161
 162 /*
 163  * Includes and definitions for Windows.
 164  */
 165
 166 #include <stdio.h>
 167 #include <winsock2.h>
 168 #include <ws2tcpip.h>
 169 #include <ctype.h>
 170 #include <time.h>
 171 #include <io.h>
 172 #include <fcntl.h>
 173 #include <sys/types.h>
 174
 175 #ifdef _MSC_VER
 176   /*
 177    * Compiler is MSVC.
 178    */
 179   #if _MSC_VER >= 1800
 180     /*
 181      * VS 2013 or newer; we have strtoll().  Use that for strtoint64_t().
 182      */
 183     #define strtoint64_t        strtoll
 184   #else
 185     /*
 186      * Earlier VS; we don't have strtoll(), but we do have
 187      * _strtoi64().  Use that for strtoint64_t().
 188      */
 189     #define strtoint64_t        _strtoi64
 190   #endif
 191
 192   /*
 193    * Microsoft's documentation doesn't speak of LL as a valid
 194    * suffix for 64-bit integers, so we'll just use i64.
 195    */
 196   #define INT64_T_CONSTANT(constant)    (constant##i64)
 197 #else
 198   /*
 199    * Non-Microsoft compiler.
 200    *
 201    * XXX - should we use strtoll or should we use _strtoi64()?
 202    */
 203   #define strtoint64_t          strtoll
 204
 205   /*
 206    * Assume LL works.
 207    */
 208   #define INT64_T_CONSTANT(constant)    (constant##LL)
 209 #endif
 210
 211 #ifdef _MSC_VER
 212 #define stat _stat
 213 #define open _open
 214 #define fstat _fstat
 215 #define read _read
 216 #define close _close
 217 #define O_RDONLY _O_RDONLY
 218 #endif  /* _MSC_VER */
 219
 220 /*
 221  * With MSVC, for C, __inline is used to make a function an inline.
 222  */
 223 #ifdef _MSC_VER
 224 #define inline __inline
 225 #endif
 226
 227 #if defined(AF_INET6) && !defined(HAVE_OS_IPV6_SUPPORT)
 228 #define HAVE_OS_IPV6_SUPPORT
 229 #endif
 230
 231 #ifndef INET6_ADDRSTRLEN
 232 #define INET6_ADDRSTRLEN 46
 233 #endif
 234
 235 /* It is in MSVC's <errno.h>, but not defined in MingW+Watcom.
 236  */
 237 #ifndef EAFNOSUPPORT
 238 #define EAFNOSUPPORT WSAEAFNOSUPPORT
 239 #endif
 240
 241 #ifndef caddr_t
 242 typedef char* caddr_t;
 243 #endif /* caddr_t */
 244
 245 #define MAXHOSTNAMELEN  64
 246 #define snprintf _snprintf
 247 #define vsnprintf _vsnprintf
 248
 249 #else /* _WIN32 */
 250
 251 /*
 252  * Includes and definitions for various flavors of UN*X.
 253  */
 254
 255 #include <ctype.h>
 256 #include <unistd.h>
 257 #include <netdb.h>
 258 #include <sys/param.h>
 259 #include <sys/types.h>                  /* concession to AIX */
 260 #include <sys/time.h>
 261 #include <sys/socket.h>
 262 #include <netinet/in.h>
 263
 264 #include <time.h>
 265
 266 #include <arpa/inet.h>
 267
 268 /*
 269  * Assume all UN*Xes have strtoll(), and use it for strtoint64_t().
 270  */
 271 #define strtoint64_t    strtoll
 272
 273 /*
 274  * Assume LL works.
 275  */
 276 #define INT64_T_CONSTANT(constant)      (constant##LL)
 277
 278 #endif /* _WIN32 */
 279
 280 /*
 281  * fopen() read and write modes for text files and binary files.
 282  */
 283 #if defined(_WIN32) || defined(MSDOS)
 284   #define FOPEN_READ_TXT   "rt"
 285   #define FOPEN_READ_BIN   "rb"
 286   #define FOPEN_WRITE_TXT  "wt"
 287   #define FOPEN_WRITE_BIN  "wb"
 288 #else
 289   #define FOPEN_READ_TXT   "r"
 290   #define FOPEN_READ_BIN   FOPEN_READ_TXT
 291   #define FOPEN_WRITE_TXT  "w"
 292   #define FOPEN_WRITE_BIN  FOPEN_WRITE_TXT
 293 #endif
 294
 295 /*
 296  * Inline x86 assembler-language versions of ntoh[ls]() and hton[ls](),
 297  * defined if the OS doesn't provide them.  These assume no more than
 298  * an 80386, so, for example, it avoids the bswap instruction added in
 299  * the 80486.
 300  *
 301  * (We don't use them on macOS; Apple provides their own, which *doesn't*
 302  * avoid the bswap instruction, as macOS only supports machines that
 303  * have it.)
 304  */
 305 #if defined(__GNUC__) && defined(__i386__) && !defined(__APPLE__) && !defined(__ntohl)
 306   #undef ntohl
 307   #undef ntohs
 308   #undef htonl
 309   #undef htons
 310
 311   static __inline__ unsigned long __ntohl (unsigned long x);
 312   static __inline__ unsigned short __ntohs (unsigned short x);
 313
 314   #define ntohl(x)  __ntohl(x)
 315   #define ntohs(x)  __ntohs(x)
 316   #define htonl(x)  __ntohl(x)
 317   #define htons(x)  __ntohs(x)
 318
 319   static __inline__ unsigned long __ntohl (unsigned long x)
 320   {
 321     __asm__ ("xchgb %b0, %h0\n\t"   /* swap lower bytes  */
 322              "rorl  $16, %0\n\t"    /* swap words        */
 323              "xchgb %b0, %h0"       /* swap higher bytes */
 324             : "=q" (x) : "0" (x));
 325     return (x);
 326   }
 327
 328   static __inline__ unsigned short __ntohs (unsigned short x)
 329   {
 330     __asm__ ("xchgb %b0, %h0"       /* swap bytes */
 331             : "=q" (x) : "0" (x));
 332     return (x);
 333   }
 334 #endif
 335
 336 /*
 337  * If the OS doesn't define AF_INET6 and struct in6_addr:
 338  *
 339  * define AF_INET6, so we can use it internally as a "this is an
 340  * IPv6 address" indication;
 341  *
 342  * define struct in6_addr so that we can use it for IPv6 addresses.
 343  */
 344 #ifndef HAVE_OS_IPV6_SUPPORT
 345 #ifndef AF_INET6
 346 #define AF_INET6        24
 347
 348 struct in6_addr {
 349         union {
 350                 __uint8_t   __u6_addr8[16];
 351                 __uint16_t  __u6_addr16[8];
 352                 __uint32_t  __u6_addr32[4];
 353         } __u6_addr;                    /* 128-bit IP6 address */
 354 };
 355 #endif
 356 #endif
 357
 358 #ifndef NI_MAXHOST
 359 #define NI_MAXHOST      1025
 360 #endif
 361
 362 #ifndef INET_ADDRSTRLEN
 363 #define INET_ADDRSTRLEN 16
 364 #endif
 365
 366 #ifndef TRUE
 367 #define TRUE 1
 368 #endif
 369
 370 #ifndef FALSE
 371 #define FALSE 0
 372 #endif
 373
 374 /*
 375  * The Apple deprecation workaround macros below were adopted from the
 376  * FreeRADIUS server code under permission of Alan DeKok and Arran Cudbard-Bell.
 377  */
 378
 379 #define XSTRINGIFY(x) #x
 380
 381 /*
 382  *      Macros for controlling warnings in GCC >= 4.2 and clang >= 2.8
 383  */
 384 #define DIAG_JOINSTR(x,y) XSTRINGIFY(x ## y)
 385 #define DIAG_DO_PRAGMA(x) _Pragma (#x)
 386
 387 /*
 388  * The current clang compilers also define __GNUC__ and __GNUC_MINOR__
 389  * thus we need to test the clang case before the GCC one
 390  */
 391 #if defined(__clang__)
 392 #  if (__clang_major__ * 100) + __clang_minor__ >= 208
 393 #    define DIAG_PRAGMA(x) DIAG_DO_PRAGMA(clang diagnostic x)
 394 #    define DIAG_OFF(x) DIAG_PRAGMA(push) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
 395 #    define DIAG_ON(x) DIAG_PRAGMA(pop)
 396 #  else
 397 #    define DIAG_OFF(x)
 398 #    define DIAG_ON(x)
 399 #  endif
 400 #elif defined(__GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 402
 401 #  define DIAG_PRAGMA(x) DIAG_DO_PRAGMA(GCC diagnostic x)
 402 #  if ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406
 403 #    define DIAG_OFF(x) DIAG_PRAGMA(push) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
 404 #    define DIAG_ON(x) DIAG_PRAGMA(pop)
 405 #  else
 406 #    define DIAG_OFF(x) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
 407 #    define DIAG_ON(x)  DIAG_PRAGMA(warning DIAG_JOINSTR(-W,x))
 408 #  endif
 409 #else
 410 #  define DIAG_OFF(x)
 411 #  define DIAG_ON(x)
 412 #endif
 413
 414 /* Use for clang specific warnings */
 415 #ifdef __clang__
 416 #  define DIAG_OFF_CLANG(x) DIAG_OFF(x)
 417 #  define DIAG_ON_CLANG(x)  DIAG_ON(x)
 418 #else
 419 #  define DIAG_OFF_CLANG(x)
 420 #  define DIAG_ON_CLANG(x)
 421 #endif
 422
 423 /*
 424  *      For dealing with APIs which are only deprecated in OSX (like the OpenSSL API)
 425  */
 426 #ifdef __APPLE__
 427 #  define USES_APPLE_DEPRECATED_API DIAG_OFF(deprecated-declarations)
 428 #  define USES_APPLE_RST DIAG_ON(deprecated-declarations)
 429 #else
 430 #  define USES_APPLE_DEPRECATED_API
 431 #  define USES_APPLE_RST
 432 #endif
 433
 434 /*
 435  * end of Apple deprecation workaround macros
 436  */
 437
 438 /*
 439  * Function attributes, for various compilers.
 440  */
 441 #include "funcattrs.h"
 442
 443 /*
 444  * Statement attributes, for various compilers.
 445  *
 446  * This was introduced sufficiently recently that compilers implementing
 447  * it also implement __has_attribute() (for example, GCC 5.0 and later
 448  * have __has_attribute(), and the "fallthrough" attribute was introduced
 449  * in GCC 7).
 450  */
 451 #if __has_attribute(fallthrough)
 452 #  define ND_FALL_THROUGH __attribute__ ((fallthrough))
 453 #else
 454 #  define ND_FALL_THROUGH
 455 #endif /*  __has_attribute(fallthrough) */
 456
 457 #endif /* netdissect_stdinc_h */