lib/libarchive/archive.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 #ifndef ARCHIVE_H_INCLUDED
  29 #define ARCHIVE_H_INCLUDED
  30
  31 /*
  32  * Note: archive.h is for use outside of libarchive; the configuration
  33  * headers (config.h, archive_platform.h, etc.) are purely internal.
  34  * Do NOT use HAVE_XXX configuration macros to control the behavior of
  35  * this header!  If you must conditionalize, use predefined compiler and/or
  36  * platform macros.
  37  */
  38 #if defined(__BORLANDC__) && __BORLANDC__ >= 0x560
  39 # define __LA_STDINT_H <stdint.h>
  40 #elif !defined(__WATCOMC__) && !defined(_MSC_VER) && !defined(__INTERIX) && !defined(__BORLANDC__)
  41 # define __LA_STDINT_H <inttypes.h>
  42 #endif
  43
  44 #include <sys/stat.h>
  45 #include <sys/types.h>  /* Linux requires this for off_t */
  46 #ifdef __LA_STDINT_H
  47 # include __LA_STDINT_H /* int64_t, etc. */
  48 #endif
  49 #include <stdio.h> /* For FILE * */
  50
  51 /* Get appropriate definitions of standard POSIX-style types. */
  52 /* These should match the types used in 'struct stat' */
  53 #if defined(_WIN32) && !defined(__CYGWIN__)
  54 #define __LA_INT64_T    __int64
  55 # if    defined(_WIN64)
  56 #  define       __LA_SSIZE_T    __int64
  57 # else
  58 #  define       __LA_SSIZE_T    long
  59 # endif
  60 # if defined(__BORLANDC__)
  61 #  define       __LA_UID_T      uid_t
  62 #  define       __LA_GID_T      gid_t
  63 # else
  64 #  define       __LA_UID_T      short
  65 #  define       __LA_GID_T      short
  66 # endif
  67 #else
  68 #include <unistd.h>  /* ssize_t, uid_t, and gid_t */
  69 #define __LA_INT64_T    int64_t
  70 #define __LA_SSIZE_T    ssize_t
  71 #define __LA_UID_T      uid_t
  72 #define __LA_GID_T      gid_t
  73 #endif
  74
  75 /*
  76  * On Windows, define LIBARCHIVE_STATIC if you're building or using a
  77  * .lib.  The default here assumes you're building a DLL.  Only
  78  * libarchive source should ever define __LIBARCHIVE_BUILD.
  79  */
  80 #if ((defined __WIN32__) || (defined _WIN32) || defined(__CYGWIN__)) && (!defined LIBARCHIVE_STATIC)
  81 # ifdef __LIBARCHIVE_BUILD
  82 #  ifdef __GNUC__
  83 #   define __LA_DECL    __attribute__((dllexport)) extern
  84 #  else
  85 #   define __LA_DECL    __declspec(dllexport)
  86 #  endif
  87 # else
  88 #  ifdef __GNUC__
  89 #   define __LA_DECL    __attribute__((dllimport)) extern
  90 #  else
  91 #   define __LA_DECL    __declspec(dllimport)
  92 #  endif
  93 # endif
  94 #else
  95 /* Static libraries or non-Windows needs no special declaration. */
  96 # define __LA_DECL
  97 #endif
  98
  99 #ifdef __cplusplus
 100 extern "C" {
 101 #endif
 102
 103 /*
 104  * The version number is provided as both a macro and a function.
 105  * The macro identifies the installed header; the function identifies
 106  * the library version (which may not be the same if you're using a
 107  * dynamically-linked version of the library).  Of course, if the
 108  * header and library are very different, you should expect some
 109  * strangeness.  Don't do that.
 110  */
 111
 112 /*
 113  * The version number is expressed as a single integer that makes it
 114  * easy to compare versions at build time: for version a.b.c, the
 115  * version number is printf("%d%03d%03d",a,b,c).  For example, if you
 116  * know your application requires version 2.12.108 or later, you can
 117  * assert that ARCHIVE_VERSION >= 2012108.
 118  *
 119  * This single-number format was introduced with libarchive 1.9.0 in
 120  * the libarchive 1.x family and libarchive 2.2.4 in the libarchive
 121  * 2.x family.  The following may be useful if you really want to do
 122  * feature detection for earlier libarchive versions (which defined
 123  * ARCHIVE_API_VERSION and ARCHIVE_API_FEATURE instead):
 124  *
 125  * #ifndef ARCHIVE_VERSION_NUMBER
 126  * #define ARCHIVE_VERSION_NUMBER       \
 127  *             (ARCHIVE_API_VERSION * 1000000 + ARCHIVE_API_FEATURE * 1000)
 128  * #endif
 129  */
 130 #define ARCHIVE_VERSION_NUMBER 2007000
 131 __LA_DECL int           archive_version_number(void);
 132
 133 /*
 134  * Textual name/version of the library, useful for version displays.
 135  */
 136 #define ARCHIVE_VERSION_STRING "libarchive 2.7.0"
 137 __LA_DECL const char *  archive_version_string(void);
 138
 139 #if ARCHIVE_VERSION_NUMBER < 3000000
 140 /*
 141  * Deprecated; these are older names that will be removed in favor of
 142  * the simpler definitions above.
 143  */
 144 #define ARCHIVE_VERSION_STAMP   ARCHIVE_VERSION_NUMBER
 145 __LA_DECL int           archive_version_stamp(void);
 146 #define ARCHIVE_LIBRARY_VERSION ARCHIVE_VERSION_STRING
 147 __LA_DECL const char *  archive_version(void);
 148 #define ARCHIVE_API_VERSION     (ARCHIVE_VERSION_NUMBER / 1000000)
 149 __LA_DECL int           archive_api_version(void);
 150 #define ARCHIVE_API_FEATURE     ((ARCHIVE_VERSION_NUMBER / 1000) % 1000)
 151 __LA_DECL int           archive_api_feature(void);
 152 #endif
 153
 154 #if ARCHIVE_VERSION_NUMBER < 3000000
 155 /* This should never have been here in the first place. */
 156 /* Legacy of old tar assumptions, will be removed in libarchive 3.0. */
 157 #define ARCHIVE_BYTES_PER_RECORD          512
 158 #define ARCHIVE_DEFAULT_BYTES_PER_BLOCK 10240
 159 #endif
 160
 161 /* Declare our basic types. */
 162 struct archive;
 163 struct archive_entry;
 164
 165 /*
 166  * Error codes: Use archive_errno() and archive_error_string()
 167  * to retrieve details.  Unless specified otherwise, all functions
 168  * that return 'int' use these codes.
 169  */
 170 #define ARCHIVE_EOF       1     /* Found end of archive. */
 171 #define ARCHIVE_OK        0     /* Operation was successful. */
 172 #define ARCHIVE_RETRY   (-10)   /* Retry might succeed. */
 173 #define ARCHIVE_WARN    (-20)   /* Partial success. */
 174 /* For example, if write_header "fails", then you can't push data. */
 175 #define ARCHIVE_FAILED  (-25)   /* Current operation cannot complete. */
 176 /* But if write_header is "fatal," then this archive is dead and useless. */
 177 #define ARCHIVE_FATAL   (-30)   /* No more operations are possible. */
 178
 179 /*
 180  * As far as possible, archive_errno returns standard platform errno codes.
 181  * Of course, the details vary by platform, so the actual definitions
 182  * here are stored in "archive_platform.h".  The symbols are listed here
 183  * for reference; as a rule, clients should not need to know the exact
 184  * platform-dependent error code.
 185  */
 186 /* Unrecognized or invalid file format. */
 187 /* #define      ARCHIVE_ERRNO_FILE_FORMAT */
 188 /* Illegal usage of the library. */
 189 /* #define      ARCHIVE_ERRNO_PROGRAMMER_ERROR */
 190 /* Unknown or unclassified error. */
 191 /* #define      ARCHIVE_ERRNO_MISC */
 192
 193 /*
 194  * Callbacks are invoked to automatically read/skip/write/open/close the
 195  * archive. You can provide your own for complex tasks (like breaking
 196  * archives across multiple tapes) or use standard ones built into the
 197  * library.
 198  */
 199
 200 /* Returns pointer and size of next block of data from archive. */
 201 typedef __LA_SSIZE_T    archive_read_callback(struct archive *,
 202                             void *_client_data, const void **_buffer);
 203
 204 /* Skips at most request bytes from archive and returns the skipped amount */
 205 #if ARCHIVE_VERSION_NUMBER < 2000000
 206 /* Libarchive 1.0 used ssize_t for the return, which is only 32 bits
 207  * on most 32-bit platforms; not large enough. */
 208 typedef __LA_SSIZE_T    archive_skip_callback(struct archive *,
 209                             void *_client_data, size_t request);
 210 #elif ARCHIVE_VERSION_NUMBER < 3000000
 211 /* Libarchive 2.0 used off_t here, but that is a bad idea on Linux and a
 212  * few other platforms where off_t varies with build settings. */
 213 typedef off_t           archive_skip_callback(struct archive *,
 214                             void *_client_data, off_t request);
 215 #else
 216 /* Libarchive 3.0 uses int64_t here, which is actually guaranteed to be
 217  * 64 bits on every platform. */
 218 typedef __LA_INT64_T    archive_skip_callback(struct archive *,
 219                             void *_client_data, __LA_INT64_T request);
 220 #endif
 221
 222 /* Returns size actually written, zero on EOF, -1 on error. */
 223 typedef __LA_SSIZE_T    archive_write_callback(struct archive *,
 224                             void *_client_data,
 225                             const void *_buffer, size_t _length);
 226
 227 #if ARCHIVE_VERSION_NUMBER < 3000000
 228 /* Open callback is actually never needed; remove it in libarchive 3.0. */
 229 typedef int     archive_open_callback(struct archive *, void *_client_data);
 230 #endif
 231
 232 typedef int     archive_close_callback(struct archive *, void *_client_data);
 233
 234 /*
 235  * Codes for archive_compression.
 236  */
 237 #define ARCHIVE_COMPRESSION_NONE        0
 238 #define ARCHIVE_COMPRESSION_GZIP        1
 239 #define ARCHIVE_COMPRESSION_BZIP2       2
 240 #define ARCHIVE_COMPRESSION_COMPRESS    3
 241 #define ARCHIVE_COMPRESSION_PROGRAM     4
 242 #define ARCHIVE_COMPRESSION_LZMA        5
 243 #define ARCHIVE_COMPRESSION_XZ          6
 244
 245 /*
 246  * Codes returned by archive_format.
 247  *
 248  * Top 16 bits identifies the format family (e.g., "tar"); lower
 249  * 16 bits indicate the variant.  This is updated by read_next_header.
 250  * Note that the lower 16 bits will often vary from entry to entry.
 251  * In some cases, this variation occurs as libarchive learns more about
 252  * the archive (for example, later entries might utilize extensions that
 253  * weren't necessary earlier in the archive; in this case, libarchive
 254  * will change the format code to indicate the extended format that
 255  * was used).  In other cases, it's because different tools have
 256  * modified the archive and so different parts of the archive
 257  * actually have slightly different formts.  (Both tar and cpio store
 258  * format codes in each entry, so it is quite possible for each
 259  * entry to be in a different format.)
 260  */
 261 #define ARCHIVE_FORMAT_BASE_MASK                0xff0000
 262 #define ARCHIVE_FORMAT_CPIO                     0x10000
 263 #define ARCHIVE_FORMAT_CPIO_POSIX               (ARCHIVE_FORMAT_CPIO | 1)
 264 #define ARCHIVE_FORMAT_CPIO_BIN_LE              (ARCHIVE_FORMAT_CPIO | 2)
 265 #define ARCHIVE_FORMAT_CPIO_BIN_BE              (ARCHIVE_FORMAT_CPIO | 3)
 266 #define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC          (ARCHIVE_FORMAT_CPIO | 4)
 267 #define ARCHIVE_FORMAT_CPIO_SVR4_CRC            (ARCHIVE_FORMAT_CPIO | 5)
 268 #define ARCHIVE_FORMAT_SHAR                     0x20000
 269 #define ARCHIVE_FORMAT_SHAR_BASE                (ARCHIVE_FORMAT_SHAR | 1)
 270 #define ARCHIVE_FORMAT_SHAR_DUMP                (ARCHIVE_FORMAT_SHAR | 2)
 271 #define ARCHIVE_FORMAT_TAR                      0x30000
 272 #define ARCHIVE_FORMAT_TAR_USTAR                (ARCHIVE_FORMAT_TAR | 1)
 273 #define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE      (ARCHIVE_FORMAT_TAR | 2)
 274 #define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED       (ARCHIVE_FORMAT_TAR | 3)
 275 #define ARCHIVE_FORMAT_TAR_GNUTAR               (ARCHIVE_FORMAT_TAR | 4)
 276 #define ARCHIVE_FORMAT_ISO9660                  0x40000
 277 #define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE        (ARCHIVE_FORMAT_ISO9660 | 1)
 278 #define ARCHIVE_FORMAT_ZIP                      0x50000
 279 #define ARCHIVE_FORMAT_EMPTY                    0x60000
 280 #define ARCHIVE_FORMAT_AR                       0x70000
 281 #define ARCHIVE_FORMAT_AR_GNU                   (ARCHIVE_FORMAT_AR | 1)
 282 #define ARCHIVE_FORMAT_AR_BSD                   (ARCHIVE_FORMAT_AR | 2)
 283 #define ARCHIVE_FORMAT_MTREE                    0x80000
 284 #define ARCHIVE_FORMAT_RAW                      0x90000
 285
 286 /*-
 287  * Basic outline for reading an archive:
 288  *   1) Ask archive_read_new for an archive reader object.
 289  *   2) Update any global properties as appropriate.
 290  *      In particular, you'll certainly want to call appropriate
 291  *      archive_read_support_XXX functions.
 292  *   3) Call archive_read_open_XXX to open the archive
 293  *   4) Repeatedly call archive_read_next_header to get information about
 294  *      successive archive entries.  Call archive_read_data to extract
 295  *      data for entries of interest.
 296  *   5) Call archive_read_finish to end processing.
 297  */
 298 __LA_DECL struct archive        *archive_read_new(void);
 299
 300 /*
 301  * The archive_read_support_XXX calls enable auto-detect for this
 302  * archive handle.  They also link in the necessary support code.
 303  * For example, if you don't want bzlib linked in, don't invoke
 304  * support_compression_bzip2().  The "all" functions provide the
 305  * obvious shorthand.
 306  */
 307 __LA_DECL int            archive_read_support_compression_all(struct archive *);
 308 __LA_DECL int            archive_read_support_compression_bzip2(struct archive *);
 309 __LA_DECL int            archive_read_support_compression_compress(struct archive *);
 310 __LA_DECL int            archive_read_support_compression_gzip(struct archive *);
 311 __LA_DECL int            archive_read_support_compression_lzma(struct archive *);
 312 __LA_DECL int            archive_read_support_compression_none(struct archive *);
 313 __LA_DECL int            archive_read_support_compression_program(struct archive *,
 314                      const char *command);
 315 __LA_DECL int            archive_read_support_compression_program_signature
 316                                 (struct archive *, const char *,
 317                                     const void * /* match */, size_t);
 318
 319 __LA_DECL int            archive_read_support_compression_xz(struct archive *);
 320
 321 __LA_DECL int            archive_read_support_format_all(struct archive *);
 322 __LA_DECL int            archive_read_support_format_ar(struct archive *);
 323 __LA_DECL int            archive_read_support_format_cpio(struct archive *);
 324 __LA_DECL int            archive_read_support_format_empty(struct archive *);
 325 __LA_DECL int            archive_read_support_format_gnutar(struct archive *);
 326 __LA_DECL int            archive_read_support_format_iso9660(struct archive *);
 327 __LA_DECL int            archive_read_support_format_mtree(struct archive *);
 328 __LA_DECL int            archive_read_support_format_raw(struct archive *);
 329 __LA_DECL int            archive_read_support_format_tar(struct archive *);
 330 __LA_DECL int            archive_read_support_format_zip(struct archive *);
 331
 332
 333 /* Open the archive using callbacks for archive I/O. */
 334 __LA_DECL int            archive_read_open(struct archive *, void *_client_data,
 335                      archive_open_callback *, archive_read_callback *,
 336                      archive_close_callback *);
 337 __LA_DECL int            archive_read_open2(struct archive *, void *_client_data,
 338                      archive_open_callback *, archive_read_callback *,
 339                      archive_skip_callback *, archive_close_callback *);
 340
 341 /*
 342  * A variety of shortcuts that invoke archive_read_open() with
 343  * canned callbacks suitable for common situations.  The ones that
 344  * accept a block size handle tape blocking correctly.
 345  */
 346 /* Use this if you know the filename.  Note: NULL indicates stdin. */
 347 __LA_DECL int            archive_read_open_filename(struct archive *,
 348                      const char *_filename, size_t _block_size);
 349 /* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */
 350 __LA_DECL int            archive_read_open_file(struct archive *,
 351                      const char *_filename, size_t _block_size);
 352 /* Read an archive that's stored in memory. */
 353 __LA_DECL int            archive_read_open_memory(struct archive *,
 354                      void * buff, size_t size);
 355 /* A more involved version that is only used for internal testing. */
 356 __LA_DECL int           archive_read_open_memory2(struct archive *a, void *buff,
 357                      size_t size, size_t read_size);
 358 /* Read an archive that's already open, using the file descriptor. */
 359 __LA_DECL int            archive_read_open_fd(struct archive *, int _fd,
 360                      size_t _block_size);
 361 /* Read an archive that's already open, using a FILE *. */
 362 /* Note: DO NOT use this with tape drives. */
 363 __LA_DECL int            archive_read_open_FILE(struct archive *, FILE *_file);
 364
 365 /* Parses and returns next entry header. */
 366 __LA_DECL int            archive_read_next_header(struct archive *,
 367                      struct archive_entry **);
 368
 369 /* Parses and returns next entry header using the archive_entry passed in */
 370 __LA_DECL int            archive_read_next_header2(struct archive *,
 371                      struct archive_entry *);
 372
 373 /*
 374  * Retrieve the byte offset in UNCOMPRESSED data where last-read
 375  * header started.
 376  */
 377 __LA_DECL __LA_INT64_T           archive_read_header_position(struct archive *);
 378
 379 /* Read data from the body of an entry.  Similar to read(2). */
 380 __LA_DECL __LA_SSIZE_T           archive_read_data(struct archive *,
 381                                     void *, size_t);
 382
 383 /*
 384  * A zero-copy version of archive_read_data that also exposes the file offset
 385  * of each returned block.  Note that the client has no way to specify
 386  * the desired size of the block.  The API does guarantee that offsets will
 387  * be strictly increasing and that returned blocks will not overlap.
 388  */
 389 #if ARCHIVE_VERSION_NUMBER < 3000000
 390 __LA_DECL int            archive_read_data_block(struct archive *a,
 391                             const void **buff, size_t *size, off_t *offset);
 392 #else
 393 __LA_DECL int            archive_read_data_block(struct archive *a,
 394                             const void **buff, size_t *size,
 395                             __LA_INT64_T *offset);
 396 #endif
 397
 398 /*-
 399  * Some convenience functions that are built on archive_read_data:
 400  *  'skip': skips entire entry
 401  *  'into_buffer': writes data into memory buffer that you provide
 402  *  'into_fd': writes data to specified filedes
 403  */
 404 __LA_DECL int            archive_read_data_skip(struct archive *);
 405 __LA_DECL int            archive_read_data_into_buffer(struct archive *,
 406                             void *buffer, __LA_SSIZE_T len);
 407 __LA_DECL int            archive_read_data_into_fd(struct archive *, int fd);
 408
 409 /*
 410  * Set read options.
 411  */
 412 /* Apply option string to the format only. */
 413 __LA_DECL int           archive_read_set_format_options(struct archive *_a,
 414                             const char *s);
 415 /* Apply option string to the filter only. */
 416 __LA_DECL int           archive_read_set_filter_options(struct archive *_a,
 417                             const char *s);
 418 /* Apply option string to both the format and the filter. */
 419 __LA_DECL int           archive_read_set_options(struct archive *_a,
 420                             const char *s);
 421
 422 /*-
 423  * Convenience function to recreate the current entry (whose header
 424  * has just been read) on disk.
 425  *
 426  * This does quite a bit more than just copy data to disk. It also:
 427  *  - Creates intermediate directories as required.
 428  *  - Manages directory permissions:  non-writable directories will
 429  *    be initially created with write permission enabled; when the
 430  *    archive is closed, dir permissions are edited to the values specified
 431  *    in the archive.
 432  *  - Checks hardlinks:  hardlinks will not be extracted unless the
 433  *    linked-to file was also extracted within the same session. (TODO)
 434  */
 435
 436 /* The "flags" argument selects optional behavior, 'OR' the flags you want. */
 437
 438 /* Default: Do not try to set owner/group. */
 439 #define ARCHIVE_EXTRACT_OWNER                   (0x0001)
 440 /* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */
 441 #define ARCHIVE_EXTRACT_PERM                    (0x0002)
 442 /* Default: Do not restore mtime/atime. */
 443 #define ARCHIVE_EXTRACT_TIME                    (0x0004)
 444 /* Default: Replace existing files. */
 445 #define ARCHIVE_EXTRACT_NO_OVERWRITE            (0x0008)
 446 /* Default: Try create first, unlink only if create fails with EEXIST. */
 447 #define ARCHIVE_EXTRACT_UNLINK                  (0x0010)
 448 /* Default: Do not restore ACLs. */
 449 #define ARCHIVE_EXTRACT_ACL                     (0x0020)
 450 /* Default: Do not restore fflags. */
 451 #define ARCHIVE_EXTRACT_FFLAGS                  (0x0040)
 452 /* Default: Do not restore xattrs. */
 453 #define ARCHIVE_EXTRACT_XATTR                   (0x0080)
 454 /* Default: Do not try to guard against extracts redirected by symlinks. */
 455 /* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */
 456 #define ARCHIVE_EXTRACT_SECURE_SYMLINKS         (0x0100)
 457 /* Default: Do not reject entries with '..' as path elements. */
 458 #define ARCHIVE_EXTRACT_SECURE_NODOTDOT         (0x0200)
 459 /* Default: Create parent directories as needed. */
 460 #define ARCHIVE_EXTRACT_NO_AUTODIR              (0x0400)
 461 /* Default: Overwrite files, even if one on disk is newer. */
 462 #define ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER      (0x0800)
 463 /* Detect blocks of 0 and write holes instead. */
 464 #define ARCHIVE_EXTRACT_SPARSE                  (0x1000)
 465
 466 __LA_DECL int    archive_read_extract(struct archive *, struct archive_entry *,
 467                      int flags);
 468 __LA_DECL int    archive_read_extract2(struct archive *, struct archive_entry *,
 469                      struct archive * /* dest */);
 470 __LA_DECL void   archive_read_extract_set_progress_callback(struct archive *,
 471                      void (*_progress_func)(void *), void *_user_data);
 472
 473 /* Record the dev/ino of a file that will not be written.  This is
 474  * generally set to the dev/ino of the archive being read. */
 475 __LA_DECL void          archive_read_extract_set_skip_file(struct archive *,
 476                      dev_t, ino_t);
 477
 478 /* Close the file and release most resources. */
 479 __LA_DECL int            archive_read_close(struct archive *);
 480 /* Release all resources and destroy the object. */
 481 /* Note that archive_read_finish will call archive_read_close for you. */
 482 #if ARCHIVE_VERSION_NUMBER < 2000000
 483 /* Erroneously declared to return void in libarchive 1.x */
 484 __LA_DECL void           archive_read_finish(struct archive *);
 485 #else
 486 __LA_DECL int            archive_read_finish(struct archive *);
 487 #endif
 488
 489 /*-
 490  * To create an archive:
 491  *   1) Ask archive_write_new for a archive writer object.
 492  *   2) Set any global properties.  In particular, you should set
 493  *      the compression and format to use.
 494  *   3) Call archive_write_open to open the file (most people
 495  *       will use archive_write_open_file or archive_write_open_fd,
 496  *       which provide convenient canned I/O callbacks for you).
 497  *   4) For each entry:
 498  *      - construct an appropriate struct archive_entry structure
 499  *      - archive_write_header to write the header
 500  *      - archive_write_data to write the entry data
 501  *   5) archive_write_close to close the output
 502  *   6) archive_write_finish to cleanup the writer and release resources
 503  */
 504 __LA_DECL struct archive        *archive_write_new(void);
 505 __LA_DECL int            archive_write_set_bytes_per_block(struct archive *,
 506                      int bytes_per_block);
 507 __LA_DECL int            archive_write_get_bytes_per_block(struct archive *);
 508 /* XXX This is badly misnamed; suggestions appreciated. XXX */
 509 __LA_DECL int            archive_write_set_bytes_in_last_block(struct archive *,
 510                      int bytes_in_last_block);
 511 __LA_DECL int            archive_write_get_bytes_in_last_block(struct archive *);
 512
 513 /* The dev/ino of a file that won't be archived.  This is used
 514  * to avoid recursively adding an archive to itself. */
 515 __LA_DECL int            archive_write_set_skip_file(struct archive *, dev_t, ino_t);
 516
 517 __LA_DECL int            archive_write_set_compression_bzip2(struct archive *);
 518 __LA_DECL int            archive_write_set_compression_compress(struct archive *);
 519 __LA_DECL int            archive_write_set_compression_gzip(struct archive *);
 520 __LA_DECL int            archive_write_set_compression_lzma(struct archive *);
 521 __LA_DECL int            archive_write_set_compression_none(struct archive *);
 522 __LA_DECL int            archive_write_set_compression_program(struct archive *,
 523                      const char *cmd);
 524 __LA_DECL int            archive_write_set_compression_xz(struct archive *);
 525 /* A convenience function to set the format based on the code or name. */
 526 __LA_DECL int            archive_write_set_format(struct archive *, int format_code);
 527 __LA_DECL int            archive_write_set_format_by_name(struct archive *,
 528                      const char *name);
 529 /* To minimize link pollution, use one or more of the following. */
 530 __LA_DECL int            archive_write_set_format_ar_bsd(struct archive *);
 531 __LA_DECL int            archive_write_set_format_ar_svr4(struct archive *);
 532 __LA_DECL int            archive_write_set_format_cpio(struct archive *);
 533 __LA_DECL int            archive_write_set_format_cpio_newc(struct archive *);
 534 __LA_DECL int            archive_write_set_format_mtree(struct archive *);
 535 /* TODO: int archive_write_set_format_old_tar(struct archive *); */
 536 __LA_DECL int            archive_write_set_format_pax(struct archive *);
 537 __LA_DECL int            archive_write_set_format_pax_restricted(struct archive *);
 538 __LA_DECL int            archive_write_set_format_shar(struct archive *);
 539 __LA_DECL int            archive_write_set_format_shar_dump(struct archive *);
 540 __LA_DECL int            archive_write_set_format_ustar(struct archive *);
 541 __LA_DECL int            archive_write_open(struct archive *, void *,
 542                      archive_open_callback *, archive_write_callback *,
 543                      archive_close_callback *);
 544 __LA_DECL int            archive_write_open_fd(struct archive *, int _fd);
 545 __LA_DECL int            archive_write_open_filename(struct archive *, const char *_file);
 546 /* A deprecated synonym for archive_write_open_filename() */
 547 __LA_DECL int            archive_write_open_file(struct archive *, const char *_file);
 548 __LA_DECL int            archive_write_open_FILE(struct archive *, FILE *);
 549 /* _buffSize is the size of the buffer, _used refers to a variable that
 550  * will be updated after each write into the buffer. */
 551 __LA_DECL int            archive_write_open_memory(struct archive *,
 552                         void *_buffer, size_t _buffSize, size_t *_used);
 553
 554 /*
 555  * Note that the library will truncate writes beyond the size provided
 556  * to archive_write_header or pad if the provided data is short.
 557  */
 558 __LA_DECL int            archive_write_header(struct archive *,
 559                      struct archive_entry *);
 560 #if ARCHIVE_VERSION_NUMBER < 2000000
 561 /* This was erroneously declared to return "int" in libarchive 1.x. */
 562 __LA_DECL int            archive_write_data(struct archive *,
 563                             const void *, size_t);
 564 #else
 565 /* Libarchive 2.0 and later return ssize_t here. */
 566 __LA_DECL __LA_SSIZE_T   archive_write_data(struct archive *,
 567                             const void *, size_t);
 568 #endif
 569
 570 #if ARCHIVE_VERSION_NUMBER < 3000000
 571 /* Libarchive 1.x and 2.x use off_t for the argument, but that's not
 572  * stable on Linux. */
 573 __LA_DECL __LA_SSIZE_T   archive_write_data_block(struct archive *,
 574                                     const void *, size_t, off_t);
 575 #else
 576 /* Libarchive 3.0 uses explicit int64_t to ensure consistent 64-bit support. */
 577 __LA_DECL __LA_SSIZE_T   archive_write_data_block(struct archive *,
 578                                     const void *, size_t, __LA_INT64_T);
 579 #endif
 580 __LA_DECL int            archive_write_finish_entry(struct archive *);
 581 __LA_DECL int            archive_write_close(struct archive *);
 582 #if ARCHIVE_VERSION_NUMBER < 2000000
 583 /* Return value was incorrect in libarchive 1.x. */
 584 __LA_DECL void           archive_write_finish(struct archive *);
 585 #else
 586 /* Libarchive 2.x and later returns an error if this fails. */
 587 /* It can fail if the archive wasn't already closed, in which case
 588  * archive_write_finish() will implicitly call archive_write_close(). */
 589 __LA_DECL int            archive_write_finish(struct archive *);
 590 #endif
 591
 592 /*
 593  * Set write options.
 594  */
 595 /* Apply option string to the format only. */
 596 __LA_DECL int           archive_write_set_format_options(struct archive *_a,
 597                             const char *s);
 598 /* Apply option string to the compressor only. */
 599 __LA_DECL int           archive_write_set_compressor_options(struct archive *_a,
 600                             const char *s);
 601 /* Apply option string to both the format and the compressor. */
 602 __LA_DECL int           archive_write_set_options(struct archive *_a,
 603                             const char *s);
 604
 605
 606 /*-
 607  * ARCHIVE_WRITE_DISK API
 608  *
 609  * To create objects on disk:
 610  *   1) Ask archive_write_disk_new for a new archive_write_disk object.
 611  *   2) Set any global properties.  In particular, you probably
 612  *      want to set the options.
 613  *   3) For each entry:
 614  *      - construct an appropriate struct archive_entry structure
 615  *      - archive_write_header to create the file/dir/etc on disk
 616  *      - archive_write_data to write the entry data
 617  *   4) archive_write_finish to cleanup the writer and release resources
 618  *
 619  * In particular, you can use this in conjunction with archive_read()
 620  * to pull entries out of an archive and create them on disk.
 621  */
 622 __LA_DECL struct archive        *archive_write_disk_new(void);
 623 /* This file will not be overwritten. */
 624 __LA_DECL int            archive_write_disk_set_skip_file(struct archive *,
 625                      dev_t, ino_t);
 626 /* Set flags to control how the next item gets created.
 627  * This accepts a bitmask of ARCHIVE_EXTRACT_XXX flags defined above. */
 628 __LA_DECL int            archive_write_disk_set_options(struct archive *,
 629                      int flags);
 630 /*
 631  * The lookup functions are given uname/uid (or gname/gid) pairs and
 632  * return a uid (gid) suitable for this system.  These are used for
 633  * restoring ownership and for setting ACLs.  The default functions
 634  * are naive, they just return the uid/gid.  These are small, so reasonable
 635  * for applications that don't need to preserve ownership; they
 636  * are probably also appropriate for applications that are doing
 637  * same-system backup and restore.
 638  */
 639 /*
 640  * The "standard" lookup functions use common system calls to lookup
 641  * the uname/gname, falling back to the uid/gid if the names can't be
 642  * found.  They cache lookups and are reasonably fast, but can be very
 643  * large, so they are not used unless you ask for them.  In
 644  * particular, these match the specifications of POSIX "pax" and old
 645  * POSIX "tar".
 646  */
 647 __LA_DECL int    archive_write_disk_set_standard_lookup(struct archive *);
 648 /*
 649  * If neither the default (naive) nor the standard (big) functions suit
 650  * your needs, you can write your own and register them.  Be sure to
 651  * include a cleanup function if you have allocated private data.
 652  */
 653 __LA_DECL int    archive_write_disk_set_group_lookup(struct archive *,
 654                             void * /* private_data */,
 655                             __LA_GID_T (*)(void *, const char *, __LA_GID_T),
 656                             void (* /* cleanup */)(void *));
 657 __LA_DECL int    archive_write_disk_set_user_lookup(struct archive *,
 658                             void * /* private_data */,
 659                             __LA_UID_T (*)(void *, const char *, __LA_UID_T),
 660                             void (* /* cleanup */)(void *));
 661
 662 /*
 663  * ARCHIVE_READ_DISK API
 664  *
 665  * This is still evolving and somewhat experimental.
 666  */
 667 __LA_DECL struct archive *archive_read_disk_new(void);
 668 /* The names for symlink modes here correspond to an old BSD
 669  * command-line argument convention: -L, -P, -H */
 670 /* Follow all symlinks. */
 671 __LA_DECL int archive_read_disk_set_symlink_logical(struct archive *);
 672 /* Follow no symlinks. */
 673 __LA_DECL int archive_read_disk_set_symlink_physical(struct archive *);
 674 /* Follow symlink initially, then not. */
 675 __LA_DECL int archive_read_disk_set_symlink_hybrid(struct archive *);
 676 /* TODO: Handle Linux stat32/stat64 ugliness. <sigh> */
 677 __LA_DECL int archive_read_disk_entry_from_file(struct archive *,
 678     struct archive_entry *, int /* fd */, const struct stat *);
 679 /* Look up gname for gid or uname for uid. */
 680 /* Default implementations are very, very stupid. */
 681 __LA_DECL const char *archive_read_disk_gname(struct archive *, __LA_GID_T);
 682 __LA_DECL const char *archive_read_disk_uname(struct archive *, __LA_UID_T);
 683 /* "Standard" implementation uses getpwuid_r, getgrgid_r and caches the
 684  * results for performance. */
 685 __LA_DECL int   archive_read_disk_set_standard_lookup(struct archive *);
 686 /* You can install your own lookups if you like. */
 687 __LA_DECL int   archive_read_disk_set_gname_lookup(struct archive *,
 688     void * /* private_data */,
 689     const char *(* /* lookup_fn */)(void *, __LA_GID_T),
 690     void (* /* cleanup_fn */)(void *));
 691 __LA_DECL int   archive_read_disk_set_uname_lookup(struct archive *,
 692     void * /* private_data */,
 693     const char *(* /* lookup_fn */)(void *, __LA_UID_T),
 694     void (* /* cleanup_fn */)(void *));
 695
 696 /*
 697  * Accessor functions to read/set various information in
 698  * the struct archive object:
 699  */
 700 /* Bytes written after compression or read before decompression. */
 701 __LA_DECL __LA_INT64_T   archive_position_compressed(struct archive *);
 702 /* Bytes written to compressor or read from decompressor. */
 703 __LA_DECL __LA_INT64_T   archive_position_uncompressed(struct archive *);
 704
 705 __LA_DECL const char    *archive_compression_name(struct archive *);
 706 __LA_DECL int            archive_compression(struct archive *);
 707 __LA_DECL int            archive_errno(struct archive *);
 708 __LA_DECL const char    *archive_error_string(struct archive *);
 709 __LA_DECL const char    *archive_format_name(struct archive *);
 710 __LA_DECL int            archive_format(struct archive *);
 711 __LA_DECL void           archive_clear_error(struct archive *);
 712 __LA_DECL void           archive_set_error(struct archive *, int _err,
 713                             const char *fmt, ...);
 714 __LA_DECL void           archive_copy_error(struct archive *dest,
 715                             struct archive *src);
 716 __LA_DECL int            archive_file_count(struct archive *);
 717
 718 #ifdef __cplusplus
 719 }
 720 #endif
 721
 722 /* These are meaningless outside of this header. */
 723 #undef __LA_DECL
 724 #undef __LA_GID_T
 725 #undef __LA_UID_T
 726
 727 /* These need to remain defined because they're used in the
 728  * callback type definitions.  XXX Fix this.  This is ugly. XXX */
 729 /* #undef __LA_INT64_T */
 730 /* #undef __LA_SSIZE_T */
 731
 732 #endif /* !ARCHIVE_H_INCLUDED */