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