lib/libarchive/archive_platform.h

   1 /*-
   2  * Copyright (c) 2003-2004 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  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 /*
  30  * This header is the first thing included in any of the libarchive
  31  * source files.  As far as possible, platform-specific issues should
  32  * be dealt with here and not within individual source files.  I'm
  33  * actively trying to minimize #if blocks within the main source,
  34  * since they obfuscate the code.
  35  */
  36
  37 #ifndef ARCHIVE_PLATFORM_H_INCLUDED
  38 #define ARCHIVE_PLATFORM_H_INCLUDED
  39
  40 #if HAVE_CONFIG_H
  41 #include "../config.h"
  42 #else
  43
  44 /*
  45  * If there's no 'config.h' file, check if we have a hand-coded config
  46  * for this platform.  This handles systems where the library is built
  47  * without running the configure script, such as FreeBSD (where
  48  * libarchive is part of the base system).
  49  */
  50 #ifdef __FreeBSD__
  51 /* Begin of hand-coded __FreeBSD__ configuration. */
  52 #if __FreeBSD__ > 4
  53 #define HAVE_ACL_CREATE_ENTRY 1
  54 #define HAVE_ACL_INIT 1
  55 #define HAVE_ACL_SET_FD 1
  56 #define HAVE_ACL_SET_FD_NP 1
  57 #define HAVE_ACL_SET_FILE 1
  58 #define HAVE_ACL_USER 1
  59 #endif
  60 #define HAVE_BZLIB_H 1
  61 #define HAVE_CHFLAGS 1
  62 #define HAVE_DECL_STRERROR_R 1
  63 #define HAVE_EFTYPE 1
  64 #define HAVE_EILSEQ 1
  65 #define HAVE_ERRNO_H 1
  66 #define HAVE_FCHDIR 1
  67 #define HAVE_FCHFLAGS 1
  68 #define HAVE_FCHMOD 1
  69 #define HAVE_FCHOWN 1
  70 #define HAVE_FCNTL_H 1
  71 #define HAVE_FSEEKO 1
  72 #define HAVE_FUTIMES 1
  73 #define HAVE_GRP_H 1
  74 #define HAVE_INTTYPES_H 1
  75 #define HAVE_LCHFLAGS 1
  76 #define HAVE_LCHMOD 1
  77 #define HAVE_LCHOWN 1
  78 #define HAVE_LIMITS_H 1
  79 #define HAVE_LUTIMES 1
  80 #define HAVE_MALLOC 1
  81 #define HAVE_MEMMOVE 1
  82 #define HAVE_MEMSET 1
  83 #define HAVE_MKDIR 1
  84 #define HAVE_MKFIFO 1
  85 #define HAVE_PWD_H 1
  86 #define HAVE_STDINT_H 1
  87 #define HAVE_STDLIB_H 1
  88 #define HAVE_STRCHR 1
  89 #define HAVE_STRDUP 1
  90 #define HAVE_STRERROR 1
  91 #define HAVE_STRERROR_R 1
  92 #define HAVE_STRINGS_H 1
  93 #define HAVE_STRING_H 1
  94 #define HAVE_STRRCHR 1
  95 #define HAVE_STRUCT_STAT_ST_MTIMESPEC_TV_NSEC 1
  96 #define HAVE_STRUCT_STAT_ST_RDEV 1
  97 #define HAVE_SYS_ACL_H 1
  98 #define HAVE_SYS_IOCTL_H 1
  99 #define HAVE_SYS_STAT_H 1
 100 #define HAVE_SYS_TIME_H 1
 101 #define HAVE_SYS_TYPES_H 1
 102 #define HAVE_SYS_WAIT_H 1
 103 #define HAVE_TIMEGM 1
 104 #define HAVE_UNISTD_H 1
 105 #define HAVE_WCHAR_H 1
 106 #define HAVE_ZLIB_H 1
 107 #define STDC_HEADERS 1
 108 #define TIME_WITH_SYS_TIME 1
 109 /* End of __FreeBSD__ definitions. */
 110 #else /* !__FreeBSD__ */
 111 /* Warn if the library hasn't been (automatically or manually) configured. */
 112 #error Oops: No config.h and no built-in configuration in archive_platform.h.
 113 #endif /* !__FreeBSD__ */
 114
 115 #endif /* !HAVE_CONFIG_H */
 116
 117 /* No non-FreeBSD platform will have __FBSDID, so just define it here. */
 118 #ifdef __FreeBSD__
 119 #include <sys/cdefs.h>  /* For __FBSDID */
 120 #else
 121 #define __FBSDID(a)     /* null */
 122 #endif
 123
 124 #if HAVE_INTTYPES_H
 125 #include <inttypes.h>
 126 #elif HAVE_STDINT_H
 127 #include <stdint.h>
 128 #endif
 129
 130 /* FreeBSD 4 and earlier lack intmax_t/uintmax_t */
 131 #if defined(__FreeBSD__) && __FreeBSD__ < 5
 132 #define intmax_t int64_t
 133 #define uintmax_t uint64_t
 134 #endif
 135
 136 /*
 137  * If this platform has <sys/acl.h>, acl_create(), acl_init(),
 138  * acl_set_file(), and ACL_USER, we assume it has the rest of the
 139  * POSIX.1e draft functions used in archive_read_extract.c.
 140  */
 141 #if HAVE_SYS_ACL_H && HAVE_ACL_CREATE_ENTRY && HAVE_ACL_INIT && HAVE_ACL_SET_FILE && HAVE_ACL_USER
 142 #define HAVE_POSIX_ACL  1
 143 #endif
 144
 145 /*
 146  * If we can't restore metadata using a file descriptor, then
 147  * for compatibility's sake, close files before trying to restore metadata.
 148  */
 149 #if defined(HAVE_FCHMOD) || defined(HAVE_FUTIMES) || defined(HAVE_ACL_SET_FD) || defined(HAVE_ACL_SET_FD_NP) || defined(HAVE_FCHOWN)
 150 #define CAN_RESTORE_METADATA_FD
 151 #endif
 152
 153 /* Set up defaults for internal error codes. */
 154 #ifndef ARCHIVE_ERRNO_FILE_FORMAT
 155 #if HAVE_EFTYPE
 156 #define ARCHIVE_ERRNO_FILE_FORMAT EFTYPE
 157 #else
 158 #if HAVE_EILSEQ
 159 #define ARCHIVE_ERRNO_FILE_FORMAT EILSEQ
 160 #else
 161 #define ARCHIVE_ERRNO_FILE_FORMAT EINVAL
 162 #endif
 163 #endif
 164 #endif
 165
 166 #ifndef ARCHIVE_ERRNO_PROGRAMMER
 167 #define ARCHIVE_ERRNO_PROGRAMMER EINVAL
 168 #endif
 169
 170 #ifndef ARCHIVE_ERRNO_MISC
 171 #define ARCHIVE_ERRNO_MISC (-1)
 172 #endif
 173
 174 /* Select the best way to set/get hi-res timestamps. */
 175 #if HAVE_STRUCT_STAT_ST_MTIMESPEC_TV_NSEC
 176 /* FreeBSD uses "timespec" members. */
 177 #define ARCHIVE_STAT_ATIME_NANOS(st)    (st)->st_atimespec.tv_nsec
 178 #define ARCHIVE_STAT_CTIME_NANOS(st)    (st)->st_ctimespec.tv_nsec
 179 #define ARCHIVE_STAT_MTIME_NANOS(st)    (st)->st_mtimespec.tv_nsec
 180 #define ARCHIVE_STAT_SET_ATIME_NANOS(st, n) (st)->st_atimespec.tv_nsec = (n)
 181 #define ARCHIVE_STAT_SET_CTIME_NANOS(st, n) (st)->st_ctimespec.tv_nsec = (n)
 182 #define ARCHIVE_STAT_SET_MTIME_NANOS(st, n) (st)->st_mtimespec.tv_nsec = (n)
 183 #else
 184 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 185 /* Linux uses "tim" members. */
 186 #define ARCHIVE_STAT_ATIME_NANOS(pstat) (pstat)->st_atim.tv_nsec
 187 #define ARCHIVE_STAT_CTIME_NANOS(pstat) (pstat)->st_ctim.tv_nsec
 188 #define ARCHIVE_STAT_MTIME_NANOS(pstat) (pstat)->st_mtim.tv_nsec
 189 #define ARCHIVE_STAT_SET_ATIME_NANOS(st, n) (st)->st_atim.tv_nsec = (n)
 190 #define ARCHIVE_STAT_SET_CTIME_NANOS(st, n) (st)->st_ctim.tv_nsec = (n)
 191 #define ARCHIVE_STAT_SET_MTIME_NANOS(st, n) (st)->st_mtim.tv_nsec = (n)
 192 #else
 193 /* If we can't find a better way, just use stubs. */
 194 #define ARCHIVE_STAT_ATIME_NANOS(pstat) 0
 195 #define ARCHIVE_STAT_CTIME_NANOS(pstat) 0
 196 #define ARCHIVE_STAT_MTIME_NANOS(pstat) 0
 197 #define ARCHIVE_STAT_SET_ATIME_NANOS(st, n) ((void)(n))
 198 #define ARCHIVE_STAT_SET_CTIME_NANOS(st, n) ((void)(n))
 199 #define ARCHIVE_STAT_SET_MTIME_NANOS(st, n) ((void)(n))
 200 #endif
 201 #endif
 202
 203 #endif /* !ARCHIVE_H_INCLUDED */