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 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #ifndef HAVE_STRLCPY
  47  /*
  48   * Macro that does the same thing as strlcpy().
  49   */
  50  #if defined(_MSC_VER) || defined(__MINGW32__)
  51   /*
  52    * strncpy_s() is supported at least back to Visual
  53    * Studio 2005.
  54    */
  55   #define strlcpy(x, y, z) \
  56         strncpy_s((x), (z), (y), _TRUNCATE)
  57
  58  #else
  59   #define strlcpy(x, y, z) \
  60         (strncpy((x), (y), (z)), \
  61          ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
  62          (void) strlen((y)))
  63  #endif
  64 #endif
  65
  66 #ifndef HAVE_STRLCAT
  67  /*
  68   * Macro that does the same thing as strlcat().
  69   */
  70  #if defined(_MSC_VER) || defined(__MINGW32__)
  71   /*
  72    * strncat_s() is supported at least back to Visual
  73    * Studio 2005.
  74    */
  75   #define strlcat(x, y, z) \
  76         strncat_s((x), (z), (y), _TRUNCATE)
  77  #else
  78   /*
  79    * ANSI C says strncat() always null-terminates its first argument,
  80    * so 1) we don't need to explicitly null-terminate the string
  81    * ourselves and 2) we need to leave room for the null terminator.
  82    */
  83   #define strlcat(x, y, z) \
  84         strncat((x), (y), (z) - strlen((x)) - 1)
  85  #endif
  86 #endif
  87
  88 /*
  89  * For flagging arguments as format strings in MSVC.
  90  */
  91 #if _MSC_VER >= 1400
  92  #include <sal.h>
  93  #if _MSC_VER > 1400
  94   #define FORMAT_STRING(p) _Printf_format_string_ p
  95  #else
  96   #define FORMAT_STRING(p) __format_string p
  97  #endif
  98 #else
  99  #define FORMAT_STRING(p) p
 100 #endif
 101
 102 #ifdef _MSC_VER
 103   #define strdup        _strdup
 104   #define sscanf        sscanf_s
 105   #define setbuf(x, y) \
 106         setvbuf((x), (y), _IONBF, 0)
 107   #define fopen(x, y) \
 108         fopen_safe((x), (y))
 109   FILE *fopen_safe(const char *filename, const char* mode);
 110 #endif
 111
 112 #ifdef _MSC_VER
 113   /*
 114    * MSVC.
 115    */
 116   #if _MSC_VER >= 1900
 117     /*
 118      * VS 2015 or newer; we have snprintf() function.
 119      */
 120     #define HAVE_SNPRINTF
 121   #endif
 122 #endif
 123
 124 /*
 125  * On Windows, snprintf(), with that name and with C99 behavior - i.e.,
 126  * guaranteeing that the formatted string is null-terminated - didn't
 127  * appear until Visual Studio 2015.  Prior to that, the C runtime had
 128  * only _snprintf(), which *doesn't* guarantee that the string is
 129  * null-terminated if it is truncated due to the buffer being too
 130  * small.  We therefore can't just define snprintf to be _snprintf
 131  * and define vsnprintf to be _vsnprintf, as we're relying on null-
 132  * termination of strings in all cases.
 133  *
 134  * We also want to allow this to be built with versions of Visual Studio
 135  * prior to VS 2015, so we can't rely on snprintf() being present.
 136  *
 137  * And we want to make sure that, if we support plugins in the future,
 138  * a routine with C99 snprintf() behavior will be available to them.
 139  * We also don't want it to collide with the C library snprintf() if
 140  * there is one.
 141  *
 142  * So we make pcap_snprintf() and pcap_vsnprintf() available, either by
 143  * #defining them to be snprintf or vsnprintf, respectively, or by
 144  * defining our own versions and exporting them.
 145  */
 146 #ifdef HAVE_SNPRINTF
 147 #define pcap_snprintf snprintf
 148 #else
 149 extern int pcap_snprintf(char *, size_t, FORMAT_STRING(const char *), ...)
 150 #ifdef __ATTRIBUTE___FORMAT_OK
 151     __attribute__((format (printf, 3, 4)))
 152 #endif /* __ATTRIBUTE___FORMAT_OK */
 153     ;
 154 #endif
 155
 156 #ifdef HAVE_VSNPRINTF
 157 #define pcap_vsnprintf vsnprintf
 158 #else
 159 extern int pcap_vsnprintf(char *, size_t, const char *, va_list ap);
 160 #endif
 161
 162 #ifdef HAVE_STRTOK_R
 163   #define pcap_strtok_r strtok_r
 164 #else
 165   #ifdef _MSC_VER
 166     /*
 167      * Microsoft gives it a different name.
 168      */
 169     #define pcap_strtok_r       strtok_s
 170   #else
 171     /*
 172      * Define it ourselves.
 173      */
 174     #define NEED_STRTOK_R
 175     extern char *pcap_strtok_r(char *, const char *, char **);
 176   #endif
 177 #endif /* HAVE_STRTOK_R */
 178
 179 #ifdef _WIN32
 180   /*
 181    * These may be defined by <inttypes.h>.
 182    *
 183    * XXX - for MSVC, we always want the _MSC_EXTENSIONS versions.
 184    * What about other compilers?  If, as the MinGW Web site says MinGW
 185    * does, the other compilers just use Microsoft's run-time library,
 186    * then they should probably use the _MSC_EXTENSIONS even if the
 187    * compiler doesn't define _MSC_EXTENSIONS.
 188    *
 189    * XXX - we currently aren't using any of these, but this allows
 190    * their use in the future.
 191    */
 192   #ifndef PRId64
 193     #ifdef _MSC_EXTENSIONS
 194       #define PRId64    "I64d"
 195     #else
 196       #define PRId64    "lld"
 197     #endif
 198   #endif /* PRId64 */
 199
 200   #ifndef PRIo64
 201     #ifdef _MSC_EXTENSIONS
 202       #define PRIo64    "I64o"
 203     #else
 204       #define PRIo64    "llo"
 205     #endif
 206   #endif /* PRIo64 */
 207
 208   #ifndef PRIx64
 209     #ifdef _MSC_EXTENSIONS
 210       #define PRIx64    "I64x"
 211     #else
 212       #define PRIx64    "llx"
 213     #endif
 214   #endif
 215
 216   #ifndef PRIu64
 217     #ifdef _MSC_EXTENSIONS
 218       #define PRIu64    "I64u"
 219     #else
 220       #define PRIu64    "llu"
 221     #endif
 222   #endif
 223
 224   #if !defined(__cplusplus)
 225     #define inline __inline
 226   #endif
 227 #endif /* _WIN32 */
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233 #endif