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 "pcap/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   /*
  92    * If <crtdbg.h> has been included, and _DEBUG is defined, and
  93    * __STDC__ is zero, <crtdbg.h> will define strdup() to call
  94    * _strdup_dbg().  So if it's already defined, don't redefine
  95    * it.
  96    */
  97   #ifndef strdup
  98   #define strdup        _strdup
  99   #endif
 100
 101   #include <stdio.h>
 102
 103   /*
 104    * Make fopen() call a wrapper that calls fopen_s(), to squelch
 105    * warnings.
 106    */
 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, PCAP_FORMAT_STRING(const char *), ...)
 150     PCAP_PRINTFLIKE(3, 4);
 151 #endif
 152
 153 #ifdef HAVE_VSNPRINTF
 154 #define pcap_vsnprintf vsnprintf
 155 #else
 156 extern int pcap_vsnprintf(char *, size_t, const char *, va_list ap);
 157 #endif
 158
 159 #ifdef HAVE_STRTOK_R
 160   #define pcap_strtok_r strtok_r
 161 #else
 162   #ifdef _WIN32
 163     /*
 164      * Microsoft gives it a different name.
 165      */
 166     #define pcap_strtok_r       strtok_s
 167   #else
 168     /*
 169      * Define it ourselves.
 170      */
 171     #define NEED_STRTOK_R
 172     extern char *pcap_strtok_r(char *, const char *, char **);
 173   #endif
 174 #endif /* HAVE_STRTOK_R */
 175
 176 #ifdef _WIN32
 177   #if !defined(__cplusplus)
 178     #define inline __inline
 179   #endif
 180 #endif /* _WIN32 */
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif
 185
 186 #endif