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