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 /* It should be possible to get rid of this by extending the feature-test
  56  * macros to cover Windows API functions, probably along with non-trivial
  57  * refactoring of code to find structures that sit more cleanly on top of
  58  * either Windows or Posix APIs. */
  59 #if (defined(__WIN32__) || defined(_WIN32) || defined(__WIN32)) && !defined(__CYGWIN__)
  60 #include "archive_windows.h"
  61 #endif
  62
  63 /*
  64  * The config files define a lot of feature macros.  The following
  65  * uses those macros to select/define replacements and include key
  66  * headers as required.
  67  */
  68
  69 /* Get a real definition for __FBSDID or __RCSID if we can */
  70 #if HAVE_SYS_CDEFS_H
  71 #include <sys/cdefs.h>
  72 #endif
  73
  74 /* If not, define them so as to avoid dangling semicolons. */
  75 #ifndef __FBSDID
  76 #define __FBSDID(a)     struct _undefined_hack
  77 #endif
  78 #ifndef __RCSID
  79 #define __RCSID(a)     struct _undefined_hack
  80 #endif
  81
  82 /* Try to get standard C99-style integer type definitions. */
  83 #if HAVE_INTTYPES_H
  84 #include <inttypes.h>
  85 #endif
  86 #if HAVE_STDINT_H
  87 #include <stdint.h>
  88 #endif
  89
  90 /* Borland warns about its own constants!  */
  91 #if defined(__BORLANDC__)
  92 # if HAVE_DECL_UINT64_MAX
  93 #  undef        UINT64_MAX
  94 #  undef        HAVE_DECL_UINT64_MAX
  95 # endif
  96 # if HAVE_DECL_UINT64_MIN
  97 #  undef        UINT64_MIN
  98 #  undef        HAVE_DECL_UINT64_MIN
  99 # endif
 100 # if HAVE_DECL_INT64_MAX
 101 #  undef        INT64_MAX
 102 #  undef        HAVE_DECL_INT64_MAX
 103 # endif
 104 # if HAVE_DECL_INT64_MIN
 105 #  undef        INT64_MIN
 106 #  undef        HAVE_DECL_INT64_MIN
 107 # endif
 108 #endif
 109
 110 /* Some platforms lack the standard *_MAX definitions. */
 111 #if !HAVE_DECL_SIZE_MAX
 112 #define SIZE_MAX (~(size_t)0)
 113 #endif
 114 #if !HAVE_DECL_SSIZE_MAX
 115 #define SSIZE_MAX ((ssize_t)(SIZE_MAX >> 1))
 116 #endif
 117 #if !HAVE_DECL_UINT32_MAX
 118 #define UINT32_MAX (~(uint32_t)0)
 119 #endif
 120 #if !HAVE_DECL_INT32_MAX
 121 #define INT32_MAX ((int32_t)(UINT32_MAX >> 1))
 122 #endif
 123 #if !HAVE_DECL_INT32_MIN
 124 #define INT32_MIN ((int32_t)(~INT32_MAX))
 125 #endif
 126 #if !HAVE_DECL_UINT64_MAX
 127 #define UINT64_MAX (~(uint64_t)0)
 128 #endif
 129 #if !HAVE_DECL_INT64_MAX
 130 #define INT64_MAX ((int64_t)(UINT64_MAX >> 1))
 131 #endif
 132 #if !HAVE_DECL_INT64_MIN
 133 #define INT64_MIN ((int64_t)(~INT64_MAX))
 134 #endif
 135 #if !HAVE_DECL_UINTMAX_MAX
 136 #define UINTMAX_MAX (~(uintmax_t)0)
 137 #endif
 138 #if !HAVE_DECL_INTMAX_MAX
 139 #define INTMAX_MAX ((intmax_t)(UINTMAX_MAX >> 1))
 140 #endif
 141 #if !HAVE_DECL_INTMAX_MIN
 142 #define INTMAX_MIN ((intmax_t)(~INTMAX_MAX))
 143 #endif
 144
 145 /*
 146  * If this platform has <sys/acl.h>, acl_create(), acl_init(),
 147  * acl_set_file(), and ACL_USER, we assume it has the rest of the
 148  * POSIX.1e draft functions used in archive_read_extract.c.
 149  */
 150 #if HAVE_SYS_ACL_H && HAVE_ACL_CREATE_ENTRY && HAVE_ACL_INIT && HAVE_ACL_SET_FILE
 151 #if HAVE_DECL_ACL_USER
 152 #define HAVE_POSIX_ACL  1
 153 #elif HAVE_DECL_ACL_TYPE_EXTENDED && HAVE_MEMBERSHIP_H
 154 #define HAVE_DARWIN_ACL 1
 155 #endif
 156 #if HAVE_DECL_ACL_TYPE_NFS4
 157 #define HAVE_FREEBSD_NFS4_ACL 1
 158 #endif
 159 #endif
 160
 161 /*
 162  * If this platform has <sys/acl.h>, acl(), facl() and ACLENT_T
 163  * facl_set() and types aclent_t and ace_t it uses Solaris-style ACL functions
 164  */
 165 #if HAVE_SYS_ACL_H && HAVE_ACL && HAVE_FACL && HAVE_ACLENT_T && \
 166     HAVE_DECL_GETACL && HAVE_DECL_GETACLCNT && HAVE_DECL_SETACL
 167 #define HAVE_SUN_ACL    1
 168 #if HAVE_ACE_T && HAVE_DECL_ACE_GETACL && HAVE_DECL_ACE_GETACLCNT && \
 169     HAVE_DECL_ACE_SETACL
 170 #define HAVE_SUN_NFS4_ACL       1
 171 #endif
 172 #endif
 173
 174 /* Define if platform supports NFSv4 ACLs */
 175 #if HAVE_FREEBSD_NFS4_ACL || HAVE_SUN_NFS4_ACL || HAVE_DARWIN_ACL
 176 #define HAVE_NFS4_ACL   1
 177 #endif
 178
 179 /*
 180  * If we can't restore metadata using a file descriptor, then
 181  * for compatibility's sake, close files before trying to restore metadata.
 182  */
 183 #if defined(HAVE_FCHMOD) || defined(HAVE_FUTIMES) || defined(HAVE_ACL_SET_FD) || defined(HAVE_ACL_SET_FD_NP) || defined(HAVE_FCHOWN)
 184 #define CAN_RESTORE_METADATA_FD
 185 #endif
 186
 187 /*
 188  * glibc 2.24 deprecates readdir_r
 189  */
 190 #if defined(HAVE_READDIR_R) && (!defined(__GLIBC__) || !defined(__GLIBC_MINOR__) || __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 24))
 191 #define USE_READDIR_R   1
 192 #else
 193 #undef  USE_READDIR_R
 194 #endif
 195
 196 /* Set up defaults for internal error codes. */
 197 #ifndef ARCHIVE_ERRNO_FILE_FORMAT
 198 #if HAVE_EFTYPE
 199 #define ARCHIVE_ERRNO_FILE_FORMAT EFTYPE
 200 #else
 201 #if HAVE_EILSEQ
 202 #define ARCHIVE_ERRNO_FILE_FORMAT EILSEQ
 203 #else
 204 #define ARCHIVE_ERRNO_FILE_FORMAT EINVAL
 205 #endif
 206 #endif
 207 #endif
 208
 209 #ifndef ARCHIVE_ERRNO_PROGRAMMER
 210 #define ARCHIVE_ERRNO_PROGRAMMER EINVAL
 211 #endif
 212
 213 #ifndef ARCHIVE_ERRNO_MISC
 214 #define ARCHIVE_ERRNO_MISC (-1)
 215 #endif
 216
 217 #endif /* !ARCHIVE_PLATFORM_H_INCLUDED */