1
0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-24 11:29:10 +00:00
freebsd/lib/libarchive
Colin Percival 3c3619cdad Convert compression_skip from taking a size_t skip length request and
returning the length skipped in a ssize_t to using off_t for both.  This
does not break any A[BP]Is, since compression_skip is entirely internal
to libarchive.

If a skip request is > SSIZE_MAX, don't pass it down to the client layer
skip function, since those still uses size_t / ssize_t.  Instead, just
read the data and throw it away.

With this commit, libarchive/bsdtar should now successfully skip archive
entries of >2GB on 32-bit systems, but does so slower than necessary.
The performance will improve with a future A[BP]I breaking commit which
makes client layer skip functions use off_t.

Discussed with:	kientzle
MFC after:	1 week
2007-01-04 12:45:00 +00:00
..
archive_check_magic.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_entry.3 Fix prototypes. 2005-11-24 10:06:05 +00:00
archive_entry.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_entry.h POSIX.1e-style Extended Attribute support 2006-03-21 16:55:46 +00:00
archive_platform.h Minor refactoring; move the FreeBSD-specific config info into 2006-12-08 06:13:49 +00:00
archive_private.h Convert compression_skip from taking a size_t skip length request and 2007-01-04 12:45:00 +00:00
archive_read_data_into_buffer.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_read_data_into_fd.c Correctly handle writing very large blocks (>1M) through to a disk 2006-11-12 23:45:40 +00:00
archive_read_extract.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_read_open_fd.c These files no longer use internal APIs, so no longer need to include 2006-11-13 00:29:57 +00:00
archive_read_open_file.c New hooks for reading/writing archives to/from a FILE * or 2006-11-24 02:00:48 +00:00
archive_read_open_filename.c Add archive_write_open_filename()/archive_read_open_filename() as 2006-11-15 05:33:38 +00:00
archive_read_open_memory.c New hooks for reading/writing archives to/from a FILE * or 2006-11-24 02:00:48 +00:00
archive_read_support_compression_all.c
archive_read_support_compression_bzip2.c Correct spelling of "accommodate", "guarantee", "guaranteed", "guard", 2006-12-28 05:21:48 +00:00
archive_read_support_compression_compress.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_read_support_compression_gzip.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_read_support_compression_none.c Convert compression_skip from taking a size_t skip length request and 2007-01-04 12:45:00 +00:00
archive_read_support_format_all.c
archive_read_support_format_cpio.c Correct spelling of "accommodate", "guarantee", "guaranteed", "guard", 2006-12-28 05:21:48 +00:00
archive_read_support_format_iso9660.c Convert compression_skip from taking a size_t skip length request and 2007-01-04 12:45:00 +00:00
archive_read_support_format_tar.c Convert compression_skip from taking a size_t skip length request and 2007-01-04 12:45:00 +00:00
archive_read_support_format_zip.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_read.3 Write-blocking cleanup, largely thanks to Colin Percival (cperciva@). 2006-11-26 19:00:50 +00:00
archive_read.c Quiet a compiler warning where (off_t + size_t) has a different sign 2007-01-03 20:01:44 +00:00
archive_string_sprintf.c
archive_string.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_string.h Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_util.3 Fix prototypes. 2005-11-24 10:06:05 +00:00
archive_util.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_write_open_fd.c Write-blocking cleanup, largely thanks to Colin Percival (cperciva@). 2006-11-26 19:00:50 +00:00
archive_write_open_file.c Write-blocking cleanup, largely thanks to Colin Percival (cperciva@). 2006-11-26 19:00:50 +00:00
archive_write_open_filename.c Argh. Restore a stat() call that was erroneously removed. 2006-12-04 08:01:53 +00:00
archive_write_open_memory.c Write-blocking cleanup, largely thanks to Colin Percival (cperciva@). 2006-11-26 19:00:50 +00:00
archive_write_set_compression_bzip2.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_write_set_compression_gzip.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_write_set_compression_none.c Write-blocking cleanup, largely thanks to Colin Percival (cperciva@). 2006-11-26 19:00:50 +00:00
archive_write_set_format_by_name.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_write_set_format_cpio.c Change the internal API for writing data to an entry; make the 2006-11-15 05:14:20 +00:00
archive_write_set_format_pax.c Fill in a couple of missing casts: clarify one narrowing conversion 2006-11-24 05:48:04 +00:00
archive_write_set_format_shar.c Style: Use the correct type for a sizeof() variable. 2006-11-15 05:20:14 +00:00
archive_write_set_format_ustar.c Unbreak libarchive on arm. Two parts of libarchive relied on a 2006-11-26 05:39:28 +00:00
archive_write_set_format.c Portability and style fixes: 2006-11-10 06:39:46 +00:00
archive_write.3 Correct spelling of "accommodate", "guarantee", "guaranteed", "guard", 2006-12-28 05:21:48 +00:00
archive_write.c Write-blocking cleanup, largely thanks to Colin Percival (cperciva@). 2006-11-26 19:00:50 +00:00
archive.h.in Correct spelling of "accommodate", "guarantee", "guaranteed", "guard", 2006-12-28 05:21:48 +00:00
config_freebsd.h Minor refactoring; move the FreeBSD-specific config info into 2006-12-08 06:13:49 +00:00
COPYING 1) Use GNU libtool to build shared libraries on non-FreeBSD 2005-10-13 05:51:38 +00:00
libarchive-formats.5 Remove mention of 'tp' format, since that support has been 2006-07-29 23:49:25 +00:00
libarchive.3 Correct spelling of "accommodate", "guarantee", "guaranteed", "guard", 2006-12-28 05:21:48 +00:00
Makefile Bump the libarchive version number, correct the shell hackery to break 2006-11-26 19:09:42 +00:00
README
tar.5 Markup fixes. 2006-09-17 21:27:35 +00:00

$FreeBSD$

libarchive: a library for reading and writing streaming archives

This is all under a BSD license.  Use, enjoy, but don't blame me if it breaks!

Documentation:
 * libarchive.3 gives an overview of the library as a whole
 * archive_read.3 and archive_write.3 provide detailed calling
   sequences for the read and write APIs
 * archive_entry.3 details the "struct archive_entry" utility class
 * libarchive-formats.5 documents the file formats supported by the library
 * tar.5 provides some detailed information about a variety of different
   "tar" formats.

You should also read the copious comments in "archive.h" and the source
code for the sample "bsdtar" program for more details.  Please let me know
about any errors or omissions you find.

Currently, the library automatically detects and reads the following:
  * gzip compression
  * bzip2 compression
  * compress/LZW compression
  * GNU tar format (including GNU long filenames, long link names, and
    sparse files)
  * Solaris 9 extended tar format (including ACLs)
  * Old V7 tar archives
  * POSIX ustar
  * POSIX pax interchange format
  * POSIX octet-oriented cpio
  * SVR4 ASCII cpio
  * Binary cpio (big-endian or little-endian)
  * ISO9660 CD-ROM images (with optional Rockridge extensions)
  * ZIP archives (with uncompressed or "deflate" compressed entries)

The library can write:
  * gzip compression
  * bzip2 compression
  * POSIX ustar
  * POSIX pax interchange format
  * "restricted" pax format, which will create ustar archives except for
    entries that require pax extensions (for long filenames, ACLs, etc).
  * POSIX octet-oriented cpio
  * shar archives

Notes:
 * This is a heavily stream-oriented system.  There is no direct
   support for in-place modification or random access and no intention
   of ever adding such support.  Adding such support would require
   sacrificing a lot of other features, so don't bother asking.

 * The library is designed to be extended with new compression and
   archive formats.  The only requirement is that the format be
   readable or writable as a stream and that each archive entry be
   independent.

 * On read, compression and format are always detected automatically.

 * I've attempted to minimize static link pollution.  If you don't
   explicitly invoke a particular feature (such as support for a
   particular compression or format), it won't get pulled in.
   In particular, if you don't explicitly enable a particular
   compression or decompression support, you won't need to link
   against the corresponding compression or decompression libraries.
   This also reduces the size of statically-linked binaries in
   environments where that matters.

 * On read, the library accepts whatever blocks you hand it.
   Your read callback is free to pass the library a byte at a time
   or mmap the entire archive and give it to the library at once.
   On write, the library always produces correctly-blocked
   output.

 * The object-style approach allows you to have multiple archive streams
   open at once.  bsdtar uses this in its "@archive" extension.

 * The archive itself is read/written using callback functions.
   You can read an archive directly from an in-memory buffer or
   write it to a socket, if you wish.  There are some utility
   functions to provide easy-to-use "open file," etc, capabilities.

 * The read/write APIs are designed to allow individual entries
   to be read or written to any data source:  You can create
   a block of data in memory and add it to a tar archive without
   first writing a temporary file.  You can also read an entry from
   an archive and write the data directly to a socket.  If you want
   to read/write entries to disk, there are convenience functions to
   make this especially easy.

 * Note: "pax interchange format" is really an extended tar format,
   despite what the name says.