The Tcpdump Group git mirrors - libpcap/blob - portability.h

   1 /*
   2  * Copyright (c) 1994, 1995, 1996
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the Computer Systems
  16  *      Engineering Group at Lawrence Berkeley Laboratory.
  17  * 4. Neither the name of the University nor of the Laboratory may be used
  18  *    to endorse or promote products derived from this software without
  19  *    specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #ifndef portability_h
  35 #define portability_h
  36
  37 /*
  38  * Helpers for portability between Windows and UN*X and between different
  39  * flavors of UN*X.
  40  */
  41
  42 #include "funcattrs.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #ifndef HAVE_STRLCPY
  49  /*
  50   * Macro that does the same thing as strlcpy().
  51   */
  52  #if defined(_MSC_VER) || defined(__MINGW32__)
  53   /*
  54    * strncpy_s() is supported at least back to Visual
  55    * Studio 2005.
  56    */
  57   #define strlcpy(x, y, z) \
  58         strncpy_s((x), (z), (y), _TRUNCATE)
  59
  60  #else
  61   #define strlcpy(x, y, z) \
  62         (strncpy((x), (y), (z)), \
  63          ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
  64          (void) strlen((y)))
  65  #endif
  66 #endif
  67
  68 #ifndef HAVE_STRLCAT
  69  /*
  70   * Macro that does the same thing as strlcat().
  71   */
  72  #if defined(_MSC_VER) || defined(__MINGW32__)
  73   /*
  74    * strncat_s() is supported at least back to Visual
  75    * Studio 2005.
  76    */
  77   #define strlcat(x, y, z) \
  78         strncat_s((x), (z), (y), _TRUNCATE)
  79  #else
  80   /*
  81    * ANSI C says strncat() always null-terminates its first argument,
  82    * so 1) we don't need to explicitly null-terminate the string
  83    * ourselves and 2) we need to leave room for the null terminator.
  84    */
  85   #define strlcat(x, y, z) \
  86         strncat((x), (y), (z) - strlen((x)) - 1)
  87  #endif
  88 #endif
  89
  90 #ifdef _MSC_VER
  91   #ifndef _DEBUG
  92   #define strdup        _strdup
  93   #endif
  94   #define sscanf        sscanf_s
  95   #define setbuf(x, y) \
  96         setvbuf((x), (y), _IONBF, 0)
  97   #define fopen(x, y) \
  98         fopen_safe((x), (y))
  99   FILE *fopen_safe(const char *filename, const char* mode);
 100 #endif
 101
 102 #ifdef _MSC_VER
 103   /*
 104    * MSVC.
 105    */
 106   #if _MSC_VER >= 1900
 107     /*
 108      * VS 2015 or newer; we have snprintf() function.
 109      */
 110     #define HAVE_SNPRINTF
 111   #endif
 112 #endif
 113
 114 /*
 115  * On Windows, snprintf(), with that name and with C99 behavior - i.e.,
 116  * guaranteeing that the formatted string is null-terminated - didn't
 117  * appear until Visual Studio 2015.  Prior to that, the C runtime had
 118  * only _snprintf(), which *doesn't* guarantee that the string is
 119  * null-terminated if it is truncated due to the buffer being too
 120  * small.  We therefore can't just define snprintf to be _snprintf
 121  * and define vsnprintf to be _vsnprintf, as we're relying on null-
 122  * termination of strings in all cases.
 123  *
 124  * We also want to allow this to be built with versions of Visual Studio
 125  * prior to VS 2015, so we can't rely on snprintf() being present.
 126  *
 127  * And we want to make sure that, if we support plugins in the future,
 128  * a routine with C99 snprintf() behavior will be available to them.
 129  * We also don't want it to collide with the C library snprintf() if
 130  * there is one.
 131  *
 132  * So we make pcap_snprintf() and pcap_vsnprintf() available, either by
 133  * #defining them to be snprintf or vsnprintf, respectively, or by
 134  * defining our own versions and exporting them.
 135  */
 136 #ifdef HAVE_SNPRINTF
 137 #define pcap_snprintf snprintf
 138 #else
 139 extern int pcap_snprintf(char *, size_t, PCAP_FORMAT_STRING(const char *), ...)
 140     PCAP_PRINTFLIKE(3, 4);
 141 #endif
 142
 143 #ifdef HAVE_VSNPRINTF
 144 #define pcap_vsnprintf vsnprintf
 145 #else
 146 extern int pcap_vsnprintf(char *, size_t, const char *, va_list ap);
 147 #endif
 148
 149 #ifdef HAVE_STRTOK_R
 150   #define pcap_strtok_r strtok_r
 151 #else
 152   #ifdef _MSC_VER
 153     /*
 154      * Microsoft gives it a different name.
 155      */
 156     #define pcap_strtok_r       strtok_s
 157   #else
 158     /*
 159      * Define it ourselves.
 160      */
 161     #define NEED_STRTOK_R
 162     extern char *pcap_strtok_r(char *, const char *, char **);
 163   #endif
 164 #endif /* HAVE_STRTOK_R */
 165
 166 #ifdef _WIN32
 167   /*
 168    * These may be defined by <inttypes.h>.
 169    *
 170    * XXX - for MSVC, we always want the _MSC_EXTENSIONS versions.
 171    * What about other compilers?  If, as the MinGW Web site says MinGW
 172    * does, the other compilers just use Microsoft's run-time library,
 173    * then they should probably use the _MSC_EXTENSIONS even if the
 174    * compiler doesn't define _MSC_EXTENSIONS.
 175    *
 176    * XXX - we currently aren't using any of these, but this allows
 177    * their use in the future.
 178    */
 179   #ifndef PRId64
 180     #ifdef _MSC_EXTENSIONS
 181       #define PRId64    "I64d"
 182     #else
 183       #define PRId64    "lld"
 184     #endif
 185   #endif /* PRId64 */
 186
 187   #ifndef PRIo64
 188     #ifdef _MSC_EXTENSIONS
 189       #define PRIo64    "I64o"
 190     #else
 191       #define PRIo64    "llo"
 192     #endif
 193   #endif /* PRIo64 */
 194
 195   #ifndef PRIx64
 196     #ifdef _MSC_EXTENSIONS
 197       #define PRIx64    "I64x"
 198     #else
 199       #define PRIx64    "llx"
 200     #endif
 201   #endif
 202
 203   #ifndef PRIu64
 204     #ifdef _MSC_EXTENSIONS
 205       #define PRIu64    "I64u"
 206     #else
 207       #define PRIu64    "llu"
 208     #endif
 209   #endif
 210
 211   #if !defined(__cplusplus)
 212     #define inline __inline
 213   #endif
 214 #endif /* _WIN32 */
 215
 216 #ifdef __cplusplus
 217 }
 218 #endif
 219
 220 #endif