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 /*
  45  * Get the C99 types, and the PRI[doux]64 format strings, defined.
  46  */
  47 #ifdef HAVE_PCAP_PCAP_INTTYPES_H
  48   /*
  49    * We have pcap/pcap-inttypes.h; use that, as it'll do all the
  50    * work, and won't cause problems if a file includes this file
  51    * and later includes a pcap header file that also includes
  52    * pcap/pcap-inttypes.h.
  53    */
  54   #include <pcap/pcap-inttypes.h>
  55 #else
  56   /*
  57    * OK, we don't have pcap/pcap-inttypes.h, so we'll have to
  58    * do the work ourselves, but at least we don't have to
  59    * worry about other headers including it and causing
  60    * clashes.
  61    */
  62   #if defined(_MSC_VER)
  63     /*
  64      * Compiler is MSVC.
  65      */
  66     #if _MSC_VER >= 1800
  67       /*
  68        * VS 2013 or newer; we have <inttypes.h>.
  69        */
  70       #include <inttypes.h>
  71     #else
  72       /*
  73        * Earlier VS; we have to define this stuff ourselves.
  74        */
  75       typedef unsigned char uint8_t;
  76       typedef signed char int8_t;
  77       typedef unsigned short uint16_t;
  78       typedef signed short int16_t;
  79       typedef unsigned int uint32_t;
  80       typedef signed int int32_t;
  81       #ifdef _MSC_EXTENSIONS
  82         typedef unsigned _int64 uint64_t;
  83         typedef _int64 int64_t;
  84       #else /* _MSC_EXTENSIONS */
  85         typedef unsigned long long uint64_t;
  86         typedef long long int64_t;
  87       #endif
  88
  89       /*
  90        * We have _strtoi64().  Use that for strtoint64_t().
  91        */
  92       #define strtoint64_t      _strtoi64
  93     #endif
  94
  95     /*
  96      * Suppress definition of intN_t in bittypes.h, which might be included
  97      * by <pcap/pcap.h> in older versions of WinPcap.
  98      * (Yes, HAVE_U_INTn_T, as the definition guards are UN*X-oriented, and
  99      * we check for u_intN_t in the UN*X configure script.)
 100      */
 101     #define HAVE_U_INT8_T
 102     #define HAVE_U_INT16_T
 103     #define HAVE_U_INT32_T
 104     #define HAVE_U_INT64_T
 105
 106     /*
 107      * These may be defined by <inttypes.h>.  If not, define them
 108      * ourselves.
 109      *
 110      * XXX - for MSVC, we always want the _MSC_EXTENSIONS versions.
 111      * What about other compilers?  If, as the MinGW Web site says MinGW
 112      * does, the other compilers just use Microsoft's run-time library,
 113      * then they should probably use the _MSC_EXTENSIONS even if the
 114      * compiler doesn't define _MSC_EXTENSIONS.
 115      */
 116     #ifndef PRId64
 117       #ifdef _MSC_EXTENSIONS
 118         #define PRId64  "I64d"
 119       #else
 120         #define PRId64  "lld"
 121       #endif
 122     #endif /* PRId64 */
 123
 124     #ifndef PRIo64
 125       #ifdef _MSC_EXTENSIONS
 126         #define PRIo64  "I64o"
 127       #else
 128         #define PRIo64  "llo"
 129       #endif
 130     #endif /* PRIo64 */
 131
 132     #ifndef PRIx64
 133       #ifdef _MSC_EXTENSIONS
 134         #define PRIx64  "I64x"
 135       #else
 136         #define PRIx64  "llx"
 137       #endif
 138     #endif
 139
 140     #ifndef PRIu64
 141       #ifdef _MSC_EXTENSIONS
 142         #define PRIu64  "I64u"
 143       #else
 144         #define PRIu64  "llu"
 145       #endif
 146     #endif
 147   #elif defined(__MINGW32__) || !defined(_WIN32)
 148     /*
 149      * Compiler is MinGW or target is UN*X or MS-DOS.  Just use
 150      * <inttypes.h>.
 151      */
 152     #include <inttypes.h>
 153   #endif
 154 #endif /* HAVE_PCAP_PCAP_INTTYPES_H */
 155
 156 #ifdef _WIN32
 157
 158 /*
 159  * Includes and definitions for Windows.
 160  */
 161
 162 #include <stdio.h>
 163 #include <winsock2.h>
 164 #include <ws2tcpip.h>
 165 #include <ctype.h>
 166 #include <time.h>
 167 #include <io.h>
 168 #include <fcntl.h>
 169 #include <sys/types.h>
 170
 171 #ifdef _MSC_VER
 172   /*
 173    * Compiler is MSVC.
 174    */
 175   #if _MSC_VER >= 1800
 176     /*
 177      * VS 2013 or newer; we have strtoll().  Use that for strtoint64_t().
 178      */
 179     #define strtoint64_t        strtoll
 180   #else
 181     /*
 182      * Earlier VS; we don't have strtoll(), but we do have
 183      * _strtoi64().  Use that for strtoint64_t().
 184      */
 185     #define strtoint64_t        _strtoi64
 186   #endif
 187
 188   /*
 189    * Microsoft's documentation doesn't speak of LL as a valid
 190    * suffix for 64-bit integers, so we'll just use i64.
 191    */
 192   #define INT64_T_CONSTANT(constant)    (constant##i64)
 193 #else
 194   /*
 195    * Non-Microsoft compiler.
 196    *
 197    * XXX - should we use strtoll or should we use _strtoi64()?
 198    */
 199   #define strtoint64_t          strtoll
 200
 201   /*
 202    * Assume LL works.
 203    */
 204   #define INT64_T_CONSTANT(constant)    (constant##LL)
 205 #endif
 206
 207 #ifdef _MSC_VER
 208 #define stat _stat
 209 #define open _open
 210 #define fstat _fstat
 211 #define read _read
 212 #define close _close
 213 #define O_RDONLY _O_RDONLY
 214 #endif  /* _MSC_VER */
 215
 216 /*
 217  * With MSVC, for C, __inline is used to make a function an inline.
 218  */
 219 #ifdef _MSC_VER
 220 #define inline __inline
 221 #endif
 222
 223 #if defined(AF_INET6) && !defined(HAVE_OS_IPV6_SUPPORT)
 224 #define HAVE_OS_IPV6_SUPPORT
 225 #endif
 226
 227 #ifndef INET6_ADDRSTRLEN
 228 #define INET6_ADDRSTRLEN 46
 229 #endif
 230
 231 /* It is in MSVC's <errno.h>, but not defined in MingW+Watcom.
 232  */
 233 #ifndef EAFNOSUPPORT
 234 #define EAFNOSUPPORT WSAEAFNOSUPPORT
 235 #endif
 236
 237 #ifndef caddr_t
 238 typedef char* caddr_t;
 239 #endif /* caddr_t */
 240
 241 #define MAXHOSTNAMELEN  64
 242 #define snprintf _snprintf
 243 #define vsnprintf _vsnprintf
 244
 245 #else /* _WIN32 */
 246
 247 /*
 248  * Includes and definitions for various flavors of UN*X.
 249  */
 250
 251 #include <ctype.h>
 252 #include <unistd.h>
 253 #include <netdb.h>
 254 #include <sys/param.h>
 255 #include <sys/types.h>                  /* concession to AIX */
 256 #include <sys/time.h>
 257 #include <sys/socket.h>
 258 #include <netinet/in.h>
 259
 260 #include <time.h>
 261
 262 #include <arpa/inet.h>
 263
 264 /*
 265  * Assume all UN*Xes have strtoll(), and use it for strtoint64_t().
 266  */
 267 #define strtoint64_t    strtoll
 268
 269 /*
 270  * Assume LL works.
 271  */
 272 #define INT64_T_CONSTANT(constant)      (constant##LL)
 273
 274 #endif /* _WIN32 */
 275
 276 #ifndef HAVE___ATTRIBUTE__
 277 #define __attribute__(x)
 278 #endif
 279
 280 /*
 281  * Used to declare a structure unaligned, so that the C compiler,
 282  * if necessary, generates code that doesn't assume alignment.
 283  * This is required because there is no guarantee that the packet
 284  * data we get from libpcap/WinPcap is properly aligned.
 285  *
 286  * This assumes that, for all compilers that support __attribute__:
 287  *
 288  *      1) they support __attribute__((packed));
 289  *
 290  *      2) for all instruction set architectures requiring strict
 291  *         alignment, declaring a structure with that attribute
 292  *         causes the compiler to generate code that handles
 293  *         misaligned 2-byte, 4-byte, and 8-byte integral
 294  *         quantities.
 295  *
 296  * It does not (yet) handle compilers where you can get the compiler
 297  * to generate code of that sort by some other means.
 298  *
 299  * This is required in order to, for example, keep the compiler from
 300  * generating, for
 301  *
 302  *      if (bp->bp_htype == 1 && bp->bp_hlen == 6 && bp->bp_op == BOOTPREQUEST) {
 303  *
 304  * in print-bootp.c, code that loads the first 4-byte word of a
 305  * "struct bootp", masking out the bp_hops field, and comparing the result
 306  * against 0x01010600.
 307  *
 308  * Note: this also requires that padding be put into the structure,
 309  * at least for compilers where it's implemented as __attribute__((packed)).
 310  */
 311 #if !(defined(_MSC_VER) && defined(UNALIGNED))
 312 /* MSVC may have its own macro defined with the same name and purpose. */
 313 #undef UNALIGNED
 314 #define UNALIGNED       __attribute__((packed))
 315 #endif
 316
 317 /*
 318  * fopen() read and write modes for text files and binary files.
 319  */
 320 #if defined(_WIN32) || defined(MSDOS)
 321   #define FOPEN_READ_TXT   "rt"
 322   #define FOPEN_READ_BIN   "rb"
 323   #define FOPEN_WRITE_TXT  "wt"
 324   #define FOPEN_WRITE_BIN  "wb"
 325 #else
 326   #define FOPEN_READ_TXT   "r"
 327   #define FOPEN_READ_BIN   FOPEN_READ_TXT
 328   #define FOPEN_WRITE_TXT  "w"
 329   #define FOPEN_WRITE_BIN  FOPEN_WRITE_TXT
 330 #endif
 331
 332 /*
 333  * Inline x86 assembler-language versions of ntoh[ls]() and hton[ls](),
 334  * defined if the OS doesn't provide them.  These assume no more than
 335  * an 80386, so, for example, it avoids the bswap instruction added in
 336  * the 80486.
 337  *
 338  * (We don't use them on OS X; Apple provides their own, which *doesn't*
 339  * avoid the bswap instruction, as OS X only supports machines that
 340  * have it.)
 341  */
 342 #if defined(__GNUC__) && defined(__i386__) && !defined(__APPLE__) && !defined(__ntohl)
 343   #undef ntohl
 344   #undef ntohs
 345   #undef htonl
 346   #undef htons
 347
 348   static __inline__ unsigned long __ntohl (unsigned long x);
 349   static __inline__ unsigned short __ntohs (unsigned short x);
 350
 351   #define ntohl(x)  __ntohl(x)
 352   #define ntohs(x)  __ntohs(x)
 353   #define htonl(x)  __ntohl(x)
 354   #define htons(x)  __ntohs(x)
 355
 356   static __inline__ unsigned long __ntohl (unsigned long x)
 357   {
 358     __asm__ ("xchgb %b0, %h0\n\t"   /* swap lower bytes  */
 359              "rorl  $16, %0\n\t"    /* swap words        */
 360              "xchgb %b0, %h0"       /* swap higher bytes */
 361             : "=q" (x) : "0" (x));
 362     return (x);
 363   }
 364
 365   static __inline__ unsigned short __ntohs (unsigned short x)
 366   {
 367     __asm__ ("xchgb %b0, %h0"       /* swap bytes */
 368             : "=q" (x) : "0" (x));
 369     return (x);
 370   }
 371 #endif
 372
 373 /*
 374  * If the OS doesn't define AF_INET6 and struct in6_addr:
 375  *
 376  * define AF_INET6, so we can use it internally as a "this is an
 377  * IPv6 address" indication;
 378  *
 379  * define struct in6_addr so that we can use it for IPv6 addresses.
 380  */
 381 #ifndef HAVE_OS_IPV6_SUPPORT
 382 #ifndef AF_INET6
 383 #define AF_INET6        24
 384
 385 struct in6_addr {
 386         union {
 387                 __uint8_t   __u6_addr8[16];
 388                 __uint16_t  __u6_addr16[8];
 389                 __uint32_t  __u6_addr32[4];
 390         } __u6_addr;                    /* 128-bit IP6 address */
 391 };
 392 #endif
 393 #endif
 394
 395 #ifndef NI_MAXHOST
 396 #define NI_MAXHOST      1025
 397 #endif
 398
 399 #ifndef INET_ADDRSTRLEN
 400 #define INET_ADDRSTRLEN 16
 401 #endif
 402
 403 #ifndef TRUE
 404 #define TRUE 1
 405 #endif
 406
 407 #ifndef FALSE
 408 #define FALSE 0
 409 #endif
 410
 411 /*
 412  * The Apple deprecation workaround macros below were adopted from the
 413  * FreeRADIUS server code under permission of Alan DeKok and Arran Cudbard-Bell.
 414  */
 415
 416 #define XSTRINGIFY(x) #x
 417
 418 /*
 419  *      Macros for controlling warnings in GCC >= 4.2 and clang >= 2.8
 420  */
 421 #define DIAG_JOINSTR(x,y) XSTRINGIFY(x ## y)
 422 #define DIAG_DO_PRAGMA(x) _Pragma (#x)
 423
 424 /*
 425  * The current clang compilers also define __GNUC__ and __GNUC_MINOR__
 426  * thus we need to test the clang case before the GCC one
 427  */
 428 #if defined(__clang__)
 429 #  if (__clang_major__ * 100) + __clang_minor__ >= 208
 430 #    define DIAG_PRAGMA(x) DIAG_DO_PRAGMA(clang diagnostic x)
 431 #    define DIAG_OFF(x) DIAG_PRAGMA(push) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
 432 #    define DIAG_ON(x) DIAG_PRAGMA(pop)
 433 #  else
 434 #    define DIAG_OFF(x)
 435 #    define DIAG_ON(x)
 436 #  endif
 437 #elif defined(__GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 402
 438 #  define DIAG_PRAGMA(x) DIAG_DO_PRAGMA(GCC diagnostic x)
 439 #  if ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406
 440 #    define DIAG_OFF(x) DIAG_PRAGMA(push) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
 441 #    define DIAG_ON(x) DIAG_PRAGMA(pop)
 442 #  else
 443 #    define DIAG_OFF(x) DIAG_PRAGMA(ignored DIAG_JOINSTR(-W,x))
 444 #    define DIAG_ON(x)  DIAG_PRAGMA(warning DIAG_JOINSTR(-W,x))
 445 #  endif
 446 #else
 447 #  define DIAG_OFF(x)
 448 #  define DIAG_ON(x)
 449 #endif
 450
 451 /* Use for clang specific warnings */
 452 #ifdef __clang__
 453 #  define DIAG_OFF_CLANG(x) DIAG_OFF(x)
 454 #  define DIAG_ON_CLANG(x)  DIAG_ON(x)
 455 #else
 456 #  define DIAG_OFF_CLANG(x)
 457 #  define DIAG_ON_CLANG(x)
 458 #endif
 459
 460 /*
 461  *      For dealing with APIs which are only deprecated in OSX (like the OpenSSL API)
 462  */
 463 #ifdef __APPLE__
 464 #  define USES_APPLE_DEPRECATED_API DIAG_OFF(deprecated-declarations)
 465 #  define USES_APPLE_RST DIAG_ON(deprecated-declarations)
 466 #else
 467 #  define USES_APPLE_DEPRECATED_API
 468 #  define USES_APPLE_RST
 469 #endif
 470
 471 /*
 472  * end of Apple deprecation workaround macros
 473  */
 474
 475 /*
 476  * Function attributes, for various compilers.
 477  */
 478 #include "funcattrs.h"
 479
 480 #ifndef min
 481 #define min(a,b) ((a)>(b)?(b):(a))
 482 #endif
 483 #ifndef max
 484 #define max(a,b) ((b)>(a)?(b):(a))
 485 #endif
 486
 487 #ifdef __ATTRIBUTE___FALLTHROUGH_OK
 488 #  define ND_FALL_THROUGH __attribute__ ((fallthrough))
 489 #else
 490 #  define ND_FALL_THROUGH
 491 #endif /* __ATTRIBUTE___FALLTHROUGH_OK */
 492
 493 #endif /* netdissect_stdinc_h */