1 /*-
2  * Copyright (c) 2003-2007 Tim Kientzle
3  * 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  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD: head/lib/libarchive/archive_platform.h 201090 2009-12-28 02:22:04Z kientzle $
26  */
27 
28 /* !!ONLY FOR USE INTERNALLY TO LIBARCHIVE!! */
29 
30 /*
31  * This header is the first thing included in any of the libarchive
32  * source files.  As far as possible, platform-specific issues should
33  * be dealt with here and not within individual source files.  I'm
34  * actively trying to minimize #if blocks within the main source,
35  * since they obfuscate the code.
36  */
37 
38 #ifndef ARCHIVE_PLATFORM_H_INCLUDED
39 #define	ARCHIVE_PLATFORM_H_INCLUDED
40 
41 /* archive.h and archive_entry.h require this. */
42 #define	__LIBARCHIVE_BUILD 1
43 
44 #if defined(PLATFORM_CONFIG_H)
45 /* Use hand-built config.h in environments that need it. */
46 #include PLATFORM_CONFIG_H
47 #elif defined(HAVE_CONFIG_H)
48 /* Most POSIX platforms use the 'configure' script to build config.h */
49 #include "config.h"
50 #else
51 /* Warn if the library hasn't been (automatically or manually) configured. */
52 #error Oops: No config.h and no pre-built configuration in archive_platform.h.
53 #endif
54 
55 /* On macOS check for some symbols based on the deployment target version.  */
56 #if defined(__APPLE__)
57 # undef HAVE_FUTIMENS
58 # undef HAVE_UTIMENSAT
59 # include <AvailabilityMacros.h>
60 # if MAC_OS_X_VERSION_MIN_REQUIRED >= 101300
61 #  define HAVE_FUTIMENS 1
62 #  define HAVE_UTIMENSAT 1
63 # endif
64 #endif
65 
66 /* It should be possible to get rid of this by extending the feature-test
67  * macros to cover Windows API functions, probably along with non-trivial
68  * refactoring of code to find structures that sit more cleanly on top of
69  * either Windows or Posix APIs. */
70 #if (defined(__WIN32__) || defined(_WIN32) || defined(__WIN32)) && !defined(__CYGWIN__)
71 #include "archive_windows.h"
72 #else
73 #define la_stat(path,stref)		stat(path,stref)
74 #endif
75 
76 /*
77  * The config files define a lot of feature macros.  The following
78  * uses those macros to select/define replacements and include key
79  * headers as required.
80  */
81 
82 /* Get a real definition for __FBSDID or __RCSID if we can */
83 #if HAVE_SYS_CDEFS_H
84 #include <sys/cdefs.h>
85 #endif
86 
87 /* If not, define them so as to avoid dangling semicolons. */
88 #ifndef __FBSDID
89 #define	__FBSDID(a)     struct _undefined_hack
90 #endif
91 #ifndef __RCSID
92 #define	__RCSID(a)     struct _undefined_hack
93 #endif
94 
95 /* Old glibc mbsnrtowcs fails assertions in our use case.  */
96 #if defined(__GLIBC__) && __GLIBC__ == 2 && __GLIBC_MINOR__ <= 1
97 # undef HAVE_MBSNRTOWCS
98 #endif
99 
100 /* Try to get standard C99-style integer type definitions. */
101 #if HAVE_INTTYPES_H
102 #include <inttypes.h>
103 #endif
104 #if HAVE_STDINT_H
105 #include <stdint.h>
106 #endif
107 
108 /* Borland warns about its own constants!  */
109 #if defined(__BORLANDC__)
110 # undef	UINT64_MAX
111 # undef	UINT64_MIN
112 # undef	INT64_MAX
113 # undef	INT64_MIN
114 #endif
115 
116 /* Some platforms lack the standard *_MAX definitions. */
117 #ifndef SIZE_MAX
118 #define	SIZE_MAX (~(size_t)0)
119 #endif
120 #ifndef SSIZE_MAX
121 #define	SSIZE_MAX ((ssize_t)(SIZE_MAX >> 1))
122 #endif
123 #ifndef UINT32_MAX
124 #define	UINT32_MAX (~(uint32_t)0)
125 #endif
126 #ifndef INT32_MAX
127 #define	INT32_MAX ((int32_t)(UINT32_MAX >> 1))
128 #endif
129 #ifndef INT32_MIN
130 #define	INT32_MIN ((int32_t)(~INT32_MAX))
131 #endif
132 #ifndef UINT64_MAX
133 #define	UINT64_MAX (~(uint64_t)0)
134 #endif
135 #ifndef INT64_MAX
136 #define	INT64_MAX ((int64_t)(UINT64_MAX >> 1))
137 #endif
138 #ifndef INT64_MIN
139 #define	INT64_MIN ((int64_t)(~INT64_MAX))
140 #endif
141 #ifndef UINTMAX_MAX
142 #define	UINTMAX_MAX (~(uintmax_t)0)
143 #endif
144 #ifndef INTMAX_MAX
145 #define	INTMAX_MAX ((intmax_t)(UINTMAX_MAX >> 1))
146 #endif
147 #ifndef INTMAX_MIN
148 #define	INTMAX_MIN ((intmax_t)(~INTMAX_MAX))
149 #endif
150 
151 /*
152  * If we can't restore metadata using a file descriptor, then
153  * for compatibility's sake, close files before trying to restore metadata.
154  */
155 #if defined(HAVE_FCHMOD) || defined(HAVE_FUTIMES) || defined(HAVE_ACL_SET_FD) || defined(HAVE_ACL_SET_FD_NP) || defined(HAVE_FCHOWN)
156 #define	CAN_RESTORE_METADATA_FD
157 #endif
158 
159 /*
160  * glibc 2.24 deprecates readdir_r
161  */
162 #if defined(HAVE_READDIR_R) && (!defined(__GLIBC__) || !defined(__GLIBC_MINOR__) || __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 24))
163 #define	USE_READDIR_R	1
164 #else
165 #undef	USE_READDIR_R
166 #endif
167 
168 /* Set up defaults for internal error codes. */
169 #ifndef ARCHIVE_ERRNO_FILE_FORMAT
170 #if HAVE_EFTYPE
171 #define	ARCHIVE_ERRNO_FILE_FORMAT EFTYPE
172 #else
173 #if HAVE_EILSEQ
174 #define	ARCHIVE_ERRNO_FILE_FORMAT EILSEQ
175 #else
176 #define	ARCHIVE_ERRNO_FILE_FORMAT EINVAL
177 #endif
178 #endif
179 #endif
180 
181 #ifndef ARCHIVE_ERRNO_PROGRAMMER
182 #define	ARCHIVE_ERRNO_PROGRAMMER EINVAL
183 #endif
184 
185 #ifndef ARCHIVE_ERRNO_MISC
186 #define	ARCHIVE_ERRNO_MISC (-1)
187 #endif
188 
189 #if defined(__GNUC__) && (__GNUC__ >= 7)
190 #define	__LA_FALLTHROUGH	__attribute__((fallthrough))
191 #else
192 #define	__LA_FALLTHROUGH
193 #endif
194 
195 #endif /* !ARCHIVE_PLATFORM_H_INCLUDED */
196