contrib/libarchive/libarchive/archive_platform.h

   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$
  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 /* Try to get standard C99-style integer type definitions. */
  96 #if HAVE_INTTYPES_H
  97 #include <inttypes.h>
  98 #endif
  99 #if HAVE_STDINT_H
 100 #include <stdint.h>
 101 #endif
 102
 103 /* Borland warns about its own constants!  */
 104 #if defined(__BORLANDC__)
 105 # if HAVE_DECL_UINT64_MAX
 106 #  undef        UINT64_MAX
 107 #  undef        HAVE_DECL_UINT64_MAX
 108 # endif
 109 # if HAVE_DECL_UINT64_MIN
 110 #  undef        UINT64_MIN
 111 #  undef        HAVE_DECL_UINT64_MIN
 112 # endif
 113 # if HAVE_DECL_INT64_MAX
 114 #  undef        INT64_MAX
 115 #  undef        HAVE_DECL_INT64_MAX
 116 # endif
 117 # if HAVE_DECL_INT64_MIN
 118 #  undef        INT64_MIN
 119 #  undef        HAVE_DECL_INT64_MIN
 120 # endif
 121 #endif
 122
 123 /* Some platforms lack the standard *_MAX definitions. */
 124 #if !HAVE_DECL_SIZE_MAX
 125 #define SIZE_MAX (~(size_t)0)
 126 #endif
 127 #if !HAVE_DECL_SSIZE_MAX
 128 #define SSIZE_MAX ((ssize_t)(SIZE_MAX >> 1))
 129 #endif
 130 #if !HAVE_DECL_UINT32_MAX
 131 #define UINT32_MAX (~(uint32_t)0)
 132 #endif
 133 #if !HAVE_DECL_INT32_MAX
 134 #define INT32_MAX ((int32_t)(UINT32_MAX >> 1))
 135 #endif
 136 #if !HAVE_DECL_INT32_MIN
 137 #define INT32_MIN ((int32_t)(~INT32_MAX))
 138 #endif
 139 #if !HAVE_DECL_UINT64_MAX
 140 #define UINT64_MAX (~(uint64_t)0)
 141 #endif
 142 #if !HAVE_DECL_INT64_MAX
 143 #define INT64_MAX ((int64_t)(UINT64_MAX >> 1))
 144 #endif
 145 #if !HAVE_DECL_INT64_MIN
 146 #define INT64_MIN ((int64_t)(~INT64_MAX))
 147 #endif
 148 #if !HAVE_DECL_UINTMAX_MAX
 149 #define UINTMAX_MAX (~(uintmax_t)0)
 150 #endif
 151 #if !HAVE_DECL_INTMAX_MAX
 152 #define INTMAX_MAX ((intmax_t)(UINTMAX_MAX >> 1))
 153 #endif
 154 #if !HAVE_DECL_INTMAX_MIN
 155 #define INTMAX_MIN ((intmax_t)(~INTMAX_MAX))
 156 #endif
 157
 158 /*
 159  * If we can't restore metadata using a file descriptor, then
 160  * for compatibility's sake, close files before trying to restore metadata.
 161  */
 162 #if defined(HAVE_FCHMOD) || defined(HAVE_FUTIMES) || defined(HAVE_ACL_SET_FD) || defined(HAVE_ACL_SET_FD_NP) || defined(HAVE_FCHOWN)
 163 #define CAN_RESTORE_METADATA_FD
 164 #endif
 165
 166 /*
 167  * glibc 2.24 deprecates readdir_r
 168  */
 169 #if defined(HAVE_READDIR_R) && (!defined(__GLIBC__) || !defined(__GLIBC_MINOR__) || __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 24))
 170 #define USE_READDIR_R   1
 171 #else
 172 #undef  USE_READDIR_R
 173 #endif
 174
 175 /* Set up defaults for internal error codes. */
 176 #ifndef ARCHIVE_ERRNO_FILE_FORMAT
 177 #if HAVE_EFTYPE
 178 #define ARCHIVE_ERRNO_FILE_FORMAT EFTYPE
 179 #else
 180 #if HAVE_EILSEQ
 181 #define ARCHIVE_ERRNO_FILE_FORMAT EILSEQ
 182 #else
 183 #define ARCHIVE_ERRNO_FILE_FORMAT EINVAL
 184 #endif
 185 #endif
 186 #endif
 187
 188 #ifndef ARCHIVE_ERRNO_PROGRAMMER
 189 #define ARCHIVE_ERRNO_PROGRAMMER EINVAL
 190 #endif
 191
 192 #ifndef ARCHIVE_ERRNO_MISC
 193 #define ARCHIVE_ERRNO_MISC (-1)
 194 #endif
 195
 196 #if defined(__GNUC__) && (__GNUC__ >= 7)
 197 #define __LA_FALLTHROUGH        __attribute__((fallthrough))
 198 #else
 199 #define __LA_FALLTHROUGH
 200 #endif
 201
 202 #endif /* !ARCHIVE_PLATFORM_H_INCLUDED */