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 #ifdef HAVE_STRLCAT
  49   #define pcap_strlcat  strlcat
  50 #else
  51   #if defined(_MSC_VER) || defined(__MINGW32__)
  52     /*
  53      * strncat_s() is supported at least back to Visual
  54      * Studio 2005.
  55      */
  56     #define pcap_strlcat(x, y, z) \
  57         strncat_s((x), (z), (y), _TRUNCATE)
  58   #else
  59     /*
  60      * Define it ourselves.
  61      */
  62     extern size_t pcap_strlcat(char * restrict dst, const char * restrict src, size_t dstsize);
  63   #endif
  64 #endif
  65
  66 #ifdef HAVE_STRLCPY
  67   #define pcap_strlcpy  strlcpy
  68 #else
  69   #if defined(_MSC_VER) || defined(__MINGW32__)
  70     /*
  71      * strncpy_s() is supported at least back to Visual
  72      * Studio 2005.
  73      */
  74     #define pcap_strlcpy(x, y, z) \
  75         strncpy_s((x), (z), (y), _TRUNCATE)
  76   #else
  77     /*
  78      * Define it ourselves.
  79      */
  80     extern size_t pcap_strlcpy(char * restrict dst, const char * restrict src, size_t dstsize);
  81   #endif
  82 #endif
  83
  84 #ifdef _MSC_VER
  85   #define isascii       __isascii
  86
  87   /*
  88    * If <crtdbg.h> has been included, and _DEBUG is defined, and
  89    * __STDC__ is zero, <crtdbg.h> will define strdup() to call
  90    * _strdup_dbg().  So if it's already defined, don't redefine
  91    * it.
  92    */
  93   #ifndef strdup
  94   #define strdup        _strdup
  95   #endif
  96 #endif
  97
  98 /*
  99  * On Windows, snprintf(), with that name and with C99 behavior - i.e.,
 100  * guaranteeing that the formatted string is null-terminated - didn't
 101  * appear until Visual Studio 2015.  Prior to that, the C runtime had
 102  * only _snprintf(), which *doesn't* guarantee that the string is
 103  * null-terminated if it is truncated due to the buffer being too
 104  * small.  We therefore can't just define snprintf to be _snprintf
 105  * and define vsnprintf to be _vsnprintf, as we're relying on null-
 106  * termination of strings in all cases.
 107  *
 108  * We also want to allow this to be built with versions of Visual Studio
 109  * prior to VS 2015, so we can't rely on snprintf() being present.
 110  *
 111  * And we want to make sure that, if we support plugins in the future,
 112  * a routine with C99 snprintf() behavior will be available to them.
 113  * We also don't want it to collide with the C library snprintf() if
 114  * there is one.
 115  *
 116  * So we make pcap_snprintf() and pcap_vsnprintf() available, either by
 117  * #defining them to be snprintf or vsnprintf, respectively, or by
 118  * defining our own versions and exporting them.
 119  */
 120 #ifdef HAVE_SNPRINTF
 121 #define pcap_snprintf snprintf
 122 #else
 123 extern int pcap_snprintf(char *, size_t, PCAP_FORMAT_STRING(const char *), ...)
 124     PCAP_PRINTFLIKE(3, 4);
 125 #endif
 126
 127 #ifdef HAVE_VSNPRINTF
 128 #define pcap_vsnprintf vsnprintf
 129 #else
 130 extern int pcap_vsnprintf(char *, size_t, const char *, va_list ap);
 131 #endif
 132
 133 #ifdef HAVE_STRTOK_R
 134   #define pcap_strtok_r strtok_r
 135 #else
 136   #ifdef _WIN32
 137     /*
 138      * Microsoft gives it a different name.
 139      */
 140     #define pcap_strtok_r       strtok_s
 141   #else
 142     /*
 143      * Define it ourselves.
 144      */
 145     extern char *pcap_strtok_r(char *, const char *, char **);
 146   #endif
 147 #endif /* HAVE_STRTOK_R */
 148
 149 #ifdef _WIN32
 150   #if !defined(__cplusplus)
 151     #define inline __inline
 152   #endif
 153 #endif /* _WIN32 */
 154
 155 #ifdef __cplusplus
 156 }
 157 #endif
 158
 159 #endif