archive_platform.h revision 324417
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: stable/11/contrib/libarchive/libarchive/archive_platform.h 324417 2017-10-08 20:54:53Z mm $
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#endif
73
74/*
75 * The config files define a lot of feature macros.  The following
76 * uses those macros to select/define replacements and include key
77 * headers as required.
78 */
79
80/* Get a real definition for __FBSDID or __RCSID if we can */
81#if HAVE_SYS_CDEFS_H
82#include <sys/cdefs.h>
83#endif
84
85/* If not, define them so as to avoid dangling semicolons. */
86#ifndef __FBSDID
87#define	__FBSDID(a)     struct _undefined_hack
88#endif
89#ifndef __RCSID
90#define	__RCSID(a)     struct _undefined_hack
91#endif
92
93/* Try to get standard C99-style integer type definitions. */
94#if HAVE_INTTYPES_H
95#include <inttypes.h>
96#endif
97#if HAVE_STDINT_H
98#include <stdint.h>
99#endif
100
101/* Borland warns about its own constants!  */
102#if defined(__BORLANDC__)
103# if HAVE_DECL_UINT64_MAX
104#  undef	UINT64_MAX
105#  undef	HAVE_DECL_UINT64_MAX
106# endif
107# if HAVE_DECL_UINT64_MIN
108#  undef	UINT64_MIN
109#  undef	HAVE_DECL_UINT64_MIN
110# endif
111# if HAVE_DECL_INT64_MAX
112#  undef	INT64_MAX
113#  undef	HAVE_DECL_INT64_MAX
114# endif
115# if HAVE_DECL_INT64_MIN
116#  undef	INT64_MIN
117#  undef	HAVE_DECL_INT64_MIN
118# endif
119#endif
120
121/* Some platforms lack the standard *_MAX definitions. */
122#if !HAVE_DECL_SIZE_MAX
123#define	SIZE_MAX (~(size_t)0)
124#endif
125#if !HAVE_DECL_SSIZE_MAX
126#define	SSIZE_MAX ((ssize_t)(SIZE_MAX >> 1))
127#endif
128#if !HAVE_DECL_UINT32_MAX
129#define	UINT32_MAX (~(uint32_t)0)
130#endif
131#if !HAVE_DECL_INT32_MAX
132#define	INT32_MAX ((int32_t)(UINT32_MAX >> 1))
133#endif
134#if !HAVE_DECL_INT32_MIN
135#define	INT32_MIN ((int32_t)(~INT32_MAX))
136#endif
137#if !HAVE_DECL_UINT64_MAX
138#define	UINT64_MAX (~(uint64_t)0)
139#endif
140#if !HAVE_DECL_INT64_MAX
141#define	INT64_MAX ((int64_t)(UINT64_MAX >> 1))
142#endif
143#if !HAVE_DECL_INT64_MIN
144#define	INT64_MIN ((int64_t)(~INT64_MAX))
145#endif
146#if !HAVE_DECL_UINTMAX_MAX
147#define	UINTMAX_MAX (~(uintmax_t)0)
148#endif
149#if !HAVE_DECL_INTMAX_MAX
150#define	INTMAX_MAX ((intmax_t)(UINTMAX_MAX >> 1))
151#endif
152#if !HAVE_DECL_INTMAX_MIN
153#define	INTMAX_MIN ((intmax_t)(~INTMAX_MAX))
154#endif
155
156/*
157 * If we can't restore metadata using a file descriptor, then
158 * for compatibility's sake, close files before trying to restore metadata.
159 */
160#if defined(HAVE_FCHMOD) || defined(HAVE_FUTIMES) || defined(HAVE_ACL_SET_FD) || defined(HAVE_ACL_SET_FD_NP) || defined(HAVE_FCHOWN)
161#define	CAN_RESTORE_METADATA_FD
162#endif
163
164/*
165 * glibc 2.24 deprecates readdir_r
166 */
167#if defined(HAVE_READDIR_R) && (!defined(__GLIBC__) || !defined(__GLIBC_MINOR__) || __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 24))
168#define	USE_READDIR_R	1
169#else
170#undef	USE_READDIR_R
171#endif
172
173/* Set up defaults for internal error codes. */
174#ifndef ARCHIVE_ERRNO_FILE_FORMAT
175#if HAVE_EFTYPE
176#define	ARCHIVE_ERRNO_FILE_FORMAT EFTYPE
177#else
178#if HAVE_EILSEQ
179#define	ARCHIVE_ERRNO_FILE_FORMAT EILSEQ
180#else
181#define	ARCHIVE_ERRNO_FILE_FORMAT EINVAL
182#endif
183#endif
184#endif
185
186#ifndef ARCHIVE_ERRNO_PROGRAMMER
187#define	ARCHIVE_ERRNO_PROGRAMMER EINVAL
188#endif
189
190#ifndef ARCHIVE_ERRNO_MISC
191#define	ARCHIVE_ERRNO_MISC (-1)
192#endif
193
194#endif /* !ARCHIVE_PLATFORM_H_INCLUDED */
195