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  #ifdef _WIN32
  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 /*
  67  * For flagging arguments as format strings in MSVC.
  68  */
  69 #if _MSC_VER >= 1400
  70  #include <sal.h>
  71  #if _MSC_VER > 1400
  72   #define FORMAT_STRING(p) _Printf_format_string_ p
  73  #else
  74   #define FORMAT_STRING(p) __format_string p
  75  #endif
  76 #else
  77  #define FORMAT_STRING(p) p
  78 #endif
  79
  80 #ifdef _MSC_VER
  81   #define strdup    _strdup
  82   #define sscanf        sscanf_s
  83 char *tokbuf;
  84   #define strltok(x, y) \
  85         strtok_s((x), (y), &tokbuf)
  86   #define strlcat(x, y, z) \
  87         strncat_s((x), (z), (y), _TRUNCATE)
  88   #define setbuf(x, y) \
  89         setvbuf((x), (y), _IONBF, 0)
  90   #define fopen(x, y) \
  91         fopen_safe((x), (y))
  92   FILE *fopen_safe(const char *filename, const char* mode);
  93 #else
  94   #define strltok strtok
  95 #endif
  96
  97 /*
  98  * On Windows, snprintf(), with that name and with C99 behavior - i.e.,
  99  * guaranteeing that the formatted string is null-terminated - didn't
 100  * appear until Visual Studio 2015.  Prior to that, the C runtime had
 101  * only _snprintf(), which *doesn't* guarantee that the string is
 102  * null-terminated if it is truncated due to the buffer being too
 103  * small.  We therefore can't just define snprintf to be _snprintf
 104  * and define vsnprintf to be _vsnprintf, as we're relying on null-
 105  * termination of strings in all cases.
 106  *
 107  * We also want to allow this to be built with versions of Visual Studio
 108  * prior to VS 2015, so we can't rely on snprintf() being present.
 109  *
 110  * And we want to make sure that, if we support plugins in the future,
 111  * a routine with C99 snprintf() behavior will be available to them.
 112  * We also don't want it to collide with the C library snprintf() if
 113  * there is one.
 114  *
 115  * So we make pcap_snprintf() and pcap_vsnprintf() available, either by
 116  * #defining them to be snprintf or vsnprintf, respectively, or by
 117  * defining our own versions and exporting them.
 118  */
 119 #ifdef HAVE_SNPRINTF
 120 #define pcap_snprintf snprintf
 121 #else
 122 extern int pcap_snprintf(char *, size_t, FORMAT_STRING(const char *), ...);
 123 #endif
 124
 125 #ifdef HAVE_VSNPRINTF
 126 #define pcap_vsnprintf vsnprintf
 127 #else
 128 extern int pcap_vsnprintf(char *, size_t, const char *, va_list ap);
 129 #endif
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif