Import libarchive and bsdtar version 2.0.25
[dragonfly/port-amd64.git] / contrib / libarchive-2.0 / libarchive / archive.h.in
bloba9ba787a7e7226f5e2626f44b0a71973999d752c
1 /*-
2 * Copyright (c) 2003-2007 Tim Kientzle
3 * All rights reserved.
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.
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.
25 * $FreeBSD: src/lib/libarchive/archive.h.in,v 1.40 2007/03/11 10:29:52 kientzle Exp $
28 #ifndef ARCHIVE_H_INCLUDED
29 #define ARCHIVE_H_INCLUDED
32 * This header file corresponds to:
33 * Library version @VERSION@
34 * Shared library version @SHLIB_MAJOR@
37 #include <sys/types.h> /* Linux requires this for off_t */
38 @ARCHIVE_H_INCLUDE_INTTYPES_H@
39 #include <stdio.h> /* For FILE * */
40 #ifndef _WIN32
41 #include <unistd.h> /* For ssize_t and size_t */
42 #else
43 typedef long ssize_t;
44 typedef unsigned int uid_t;
45 typedef unsigned int gid_t;
46 typedef unsigned short mode_t;
47 #endif
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
55 * If ARCHIVE_API_VERSION != archive_api_version(), then the library you
56 * were linked with is using an incompatible API to the one you were
57 * compiled with. This is almost certainly a fatal problem.
59 * ARCHIVE_API_FEATURE is incremented with each significant feature
60 * addition, so you can test (at compile or run time) if a particular
61 * feature is implemented. It's no big deal if ARCHIVE_API_FEATURE !=
62 * archive_api_feature(), as long as both are high enough to include
63 * the features you're relying on. Specific values of FEATURE are
64 * documented here:
66 * 1 - Version tests are available.
67 * 2 - archive_{read,write}_close available separately from _finish.
68 * 3 - open_memory, open_memory2, open_FILE, open_fd available
69 * 5 - archive_write_disk interface available
71 #define ARCHIVE_API_VERSION @ARCHIVE_API_MAJOR@
72 int archive_api_version(void);
73 #define ARCHIVE_API_FEATURE @ARCHIVE_API_MINOR@
74 int archive_api_feature(void);
75 /* Textual name/version of the library. */
76 #define ARCHIVE_LIBRARY_VERSION "libarchive @VERSION@"
77 const char * archive_version(void);
79 #define ARCHIVE_BYTES_PER_RECORD 512
80 #define ARCHIVE_DEFAULT_BYTES_PER_BLOCK 10240
82 /* Declare our basic types. */
83 struct archive;
84 struct archive_entry;
87 * Error codes: Use archive_errno() and archive_error_string()
88 * to retrieve details. Unless specified otherwise, all functions
89 * that return 'int' use these codes.
91 #define ARCHIVE_EOF 1 /* Found end of archive. */
92 #define ARCHIVE_OK 0 /* Operation was successful. */
93 #define ARCHIVE_RETRY (-10) /* Retry might succeed. */
94 #define ARCHIVE_WARN (-20) /* Partial success. */
95 /* For example, if write_header "fails", then you can't push data. */
96 #define ARCHIVE_FAILED (-25) /* Current operation cannot complete. */
97 #define ARCHIVE_FATAL (-30) /* No more operations are possible. */
100 * As far as possible, archive_errno returns standard platform errno codes.
101 * Of course, the details vary by platform, so the actual definitions
102 * here are stored in "archive_platform.h". The symbols are listed here
103 * for reference; as a rule, clients should not need to know the exact
104 * platform-dependent error code.
106 /* Unrecognized or invalid file format. */
107 /* #define ARCHIVE_ERRNO_FILE_FORMAT */
108 /* Illegal usage of the library. */
109 /* #define ARCHIVE_ERRNO_PROGRAMMER_ERROR */
110 /* Unknown or unclassified error. */
111 /* #define ARCHIVE_ERRNO_MISC */
114 * Callbacks are invoked to automatically read/skip/write/open/close the
115 * archive. You can provide your own for complex tasks (like breaking
116 * archives across multiple tapes) or use standard ones built into the
117 * library.
120 /* Returns pointer and size of next block of data from archive. */
121 typedef ssize_t archive_read_callback(struct archive *, void *_client_data,
122 const void **_buffer);
123 /* Skips at most request bytes from archive and returns the skipped amount */
124 #if ARCHIVE_API_VERSION < 2
125 typedef ssize_t archive_skip_callback(struct archive *, void *_client_data,
126 size_t request);
127 #else
128 typedef off_t archive_skip_callback(struct archive *, void *_client_data,
129 off_t request);
130 #endif
131 /* Returns size actually written, zero on EOF, -1 on error. */
132 typedef ssize_t archive_write_callback(struct archive *, void *_client_data,
133 const void *_buffer, size_t _length);
134 typedef int archive_open_callback(struct archive *, void *_client_data);
135 typedef int archive_close_callback(struct archive *, void *_client_data);
138 * Codes for archive_compression.
140 #define ARCHIVE_COMPRESSION_NONE 0
141 #define ARCHIVE_COMPRESSION_GZIP 1
142 #define ARCHIVE_COMPRESSION_BZIP2 2
143 #define ARCHIVE_COMPRESSION_COMPRESS 3
146 * Codes returned by archive_format.
148 * Top 16 bits identifies the format family (e.g., "tar"); lower
149 * 16 bits indicate the variant. This is updated by read_next_header.
150 * Note that the lower 16 bits will often vary from entry to entry.
151 * In some cases, this variation occurs as libarchive learns more about
152 * the archive (for example, later entries might utilize extensions that
153 * weren't necessary earlier in the archive; in this case, libarchive
154 * will change the format code to indicate the extended format that
155 * was used). In other cases, it's because different tools have
156 * modified the archive and so different parts of the archive
157 * actually have slightly different formts. (Both tar and cpio store
158 * format codes in each entry, so it is quite possible for each
159 * entry to be in a different format.)
161 #define ARCHIVE_FORMAT_BASE_MASK 0xff0000
162 #define ARCHIVE_FORMAT_CPIO 0x10000
163 #define ARCHIVE_FORMAT_CPIO_POSIX (ARCHIVE_FORMAT_CPIO | 1)
164 #define ARCHIVE_FORMAT_CPIO_BIN_LE (ARCHIVE_FORMAT_CPIO | 2)
165 #define ARCHIVE_FORMAT_CPIO_BIN_BE (ARCHIVE_FORMAT_CPIO | 3)
166 #define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC (ARCHIVE_FORMAT_CPIO | 4)
167 #define ARCHIVE_FORMAT_CPIO_SVR4_CRC (ARCHIVE_FORMAT_CPIO | 5)
168 #define ARCHIVE_FORMAT_SHAR 0x20000
169 #define ARCHIVE_FORMAT_SHAR_BASE (ARCHIVE_FORMAT_SHAR | 1)
170 #define ARCHIVE_FORMAT_SHAR_DUMP (ARCHIVE_FORMAT_SHAR | 2)
171 #define ARCHIVE_FORMAT_TAR 0x30000
172 #define ARCHIVE_FORMAT_TAR_USTAR (ARCHIVE_FORMAT_TAR | 1)
173 #define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE (ARCHIVE_FORMAT_TAR | 2)
174 #define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED (ARCHIVE_FORMAT_TAR | 3)
175 #define ARCHIVE_FORMAT_TAR_GNUTAR (ARCHIVE_FORMAT_TAR | 4)
176 #define ARCHIVE_FORMAT_ISO9660 0x40000
177 #define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE (ARCHIVE_FORMAT_ISO9660 | 1)
178 #define ARCHIVE_FORMAT_ZIP 0x50000
179 #define ARCHIVE_FORMAT_EMPTY 0x60000
182 * Basic outline for reading an archive:
183 * 1) Ask archive_read_new for an archive reader object.
184 * 2) Update any global properties as appropriate.
185 * In particular, you'll certainly want to call appropriate
186 * archive_read_support_XXX functions.
187 * 3) Call archive_read_open_XXX to open the archive
188 * 4) Repeatedly call archive_read_next_header to get information about
189 * successive archive entries. Call archive_read_data to extract
190 * data for entries of interest.
191 * 5) Call archive_read_finish to end processing.
193 struct archive *archive_read_new(void);
196 * The archive_read_support_XXX calls enable auto-detect for this
197 * archive handle. They also link in the necessary support code.
198 * For example, if you don't want bzlib linked in, don't invoke
199 * support_compression_bzip2(). The "all" functions provide the
200 * obvious shorthand.
202 int archive_read_support_compression_all(struct archive *);
203 int archive_read_support_compression_bzip2(struct archive *);
204 int archive_read_support_compression_compress(struct archive *);
205 int archive_read_support_compression_gzip(struct archive *);
206 int archive_read_support_compression_none(struct archive *);
208 int archive_read_support_format_all(struct archive *);
209 int archive_read_support_format_cpio(struct archive *);
210 int archive_read_support_format_empty(struct archive *);
211 int archive_read_support_format_gnutar(struct archive *);
212 int archive_read_support_format_iso9660(struct archive *);
213 int archive_read_support_format_tar(struct archive *);
214 int archive_read_support_format_zip(struct archive *);
217 /* Open the archive using callbacks for archive I/O. */
218 int archive_read_open(struct archive *, void *_client_data,
219 archive_open_callback *, archive_read_callback *,
220 archive_close_callback *);
221 int archive_read_open2(struct archive *, void *_client_data,
222 archive_open_callback *, archive_read_callback *,
223 archive_skip_callback *, archive_close_callback *);
226 * A variety of shortcuts that invoke archive_read_open() with
227 * canned callbacks suitable for common situations. The ones that
228 * accept a block size handle tape blocking correctly.
230 /* Use this if you know the filename. Note: NULL indicates stdin. */
231 int archive_read_open_filename(struct archive *,
232 const char *_filename, size_t _block_size);
233 /* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */
234 int archive_read_open_file(struct archive *,
235 const char *_filename, size_t _block_size);
236 /* Read an archive that's stored in memory. */
237 int archive_read_open_memory(struct archive *,
238 void * buff, size_t size);
239 /* A more involved version that is only used for internal testing. */
240 int archive_read_open_memory2(struct archive *a, void *buff,
241 size_t size, size_t read_size);
242 /* Read an archive that's already open, using the file descriptor. */
243 int archive_read_open_fd(struct archive *, int _fd,
244 size_t _block_size);
245 /* Read an archive that's already open, using a FILE *. */
246 /* Note: DO NOT use this with tape drives. */
247 int archive_read_open_FILE(struct archive *, FILE *_file);
249 /* Parses and returns next entry header. */
250 int archive_read_next_header(struct archive *,
251 struct archive_entry **);
254 * Retrieve the byte offset in UNCOMPRESSED data where last-read
255 * header started.
257 int64_t archive_read_header_position(struct archive *);
259 /* Read data from the body of an entry. Similar to read(2). */
260 ssize_t archive_read_data(struct archive *, void *, size_t);
262 * A zero-copy version of archive_read_data that also exposes the file offset
263 * of each returned block. Note that the client has no way to specify
264 * the desired size of the block. The API does guarantee that offsets will
265 * be strictly increasing and that returned blocks will not overlap.
267 int archive_read_data_block(struct archive *a,
268 const void **buff, size_t *size, off_t *offset);
271 * Some convenience functions that are built on archive_read_data:
272 * 'skip': skips entire entry
273 * 'into_buffer': writes data into memory buffer that you provide
274 * 'into_fd': writes data to specified filedes
276 int archive_read_data_skip(struct archive *);
277 int archive_read_data_into_buffer(struct archive *, void *buffer,
278 ssize_t len);
279 int archive_read_data_into_fd(struct archive *, int fd);
282 * Convenience function to recreate the current entry (whose header
283 * has just been read) on disk.
285 * This does quite a bit more than just copy data to disk. It also:
286 * - Creates intermediate directories as required.
287 * - Manages directory permissions: non-writable directories will
288 * be initially created with write permission enabled; when the
289 * archive is closed, dir permissions are edited to the values specified
290 * in the archive.
291 * - Checks hardlinks: hardlinks will not be extracted unless the
292 * linked-to file was also extracted within the same session. (TODO)
295 /* The "flags" argument selects optional behavior, 'OR' the flags you want. */
297 /* Default: Do not try to set owner/group. */
298 #define ARCHIVE_EXTRACT_OWNER (1)
299 /* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */
300 #define ARCHIVE_EXTRACT_PERM (2)
301 /* Default: Do not restore mtime/atime. */
302 #define ARCHIVE_EXTRACT_TIME (4)
303 /* Default: Replace existing files. */
304 #define ARCHIVE_EXTRACT_NO_OVERWRITE (8)
305 /* Default: Try create first, unlink only if create fails with EEXIST. */
306 #define ARCHIVE_EXTRACT_UNLINK (16)
307 /* Default: Do not restore ACLs. */
308 #define ARCHIVE_EXTRACT_ACL (32)
309 /* Default: Do not restore fflags. */
310 #define ARCHIVE_EXTRACT_FFLAGS (64)
311 /* Default: Do not restore xattrs. */
312 #define ARCHIVE_EXTRACT_XATTR (128)
313 /* Default: Do not try to guard against extracts redirected by symlinks. */
314 /* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */
315 #define ARCHIVE_EXTRACT_SECURE_SYMLINKS (256)
316 /* Default: Do not reject entries with '..' as path elements. */
317 #define ARCHIVE_EXTRACT_SECURE_NODOTDOT (512)
319 int archive_read_extract(struct archive *, struct archive_entry *,
320 int flags);
321 void archive_read_extract_set_progress_callback(struct archive *,
322 void (*_progress_func)(void *), void *_user_data);
324 /* Record the dev/ino of a file that will not be written. This is
325 * generally set to the dev/ino of the archive being read. */
326 void archive_read_extract_set_skip_file(struct archive *,
327 dev_t, ino_t);
329 /* Close the file and release most resources. */
330 int archive_read_close(struct archive *);
331 /* Release all resources and destroy the object. */
332 /* Note that archive_read_finish will call archive_read_close for you. */
333 #if ARCHIVE_API_VERSION > 1
334 int archive_read_finish(struct archive *);
335 #else
336 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
337 /* Erroneously declared to return void in libarchive 1.x */
338 void archive_read_finish(struct archive *);
339 #endif
342 * To create an archive:
343 * 1) Ask archive_write_new for a archive writer object.
344 * 2) Set any global properties. In particular, you should set
345 * the compression and format to use.
346 * 3) Call archive_write_open to open the file (most people
347 * will use archive_write_open_file or archive_write_open_fd,
348 * which provide convenient canned I/O callbacks for you).
349 * 4) For each entry:
350 * - construct an appropriate struct archive_entry structure
351 * - archive_write_header to write the header
352 * - archive_write_data to write the entry data
353 * 5) archive_write_close to close the output
354 * 6) archive_write_finish to cleanup the writer and release resources
356 struct archive *archive_write_new(void);
357 int archive_write_set_bytes_per_block(struct archive *,
358 int bytes_per_block);
359 int archive_write_get_bytes_per_block(struct archive *);
360 /* XXX This is badly misnamed; suggestions appreciated. XXX */
361 int archive_write_set_bytes_in_last_block(struct archive *,
362 int bytes_in_last_block);
363 int archive_write_get_bytes_in_last_block(struct archive *);
365 /* The dev/ino of a file that won't be archived. This is used
366 * to avoid recursively adding an archive to itself. */
367 int archive_write_set_skip_file(struct archive *, dev_t, ino_t);
369 int archive_write_set_compression_bzip2(struct archive *);
370 int archive_write_set_compression_gzip(struct archive *);
371 int archive_write_set_compression_none(struct archive *);
372 /* A convenience function to set the format based on the code or name. */
373 int archive_write_set_format(struct archive *, int format_code);
374 int archive_write_set_format_by_name(struct archive *,
375 const char *name);
376 /* To minimize link pollution, use one or more of the following. */
377 int archive_write_set_format_cpio(struct archive *);
378 /* TODO: int archive_write_set_format_old_tar(struct archive *); */
379 int archive_write_set_format_pax(struct archive *);
380 int archive_write_set_format_pax_restricted(struct archive *);
381 int archive_write_set_format_shar(struct archive *);
382 int archive_write_set_format_shar_dump(struct archive *);
383 int archive_write_set_format_ustar(struct archive *);
384 int archive_write_open(struct archive *, void *,
385 archive_open_callback *, archive_write_callback *,
386 archive_close_callback *);
387 int archive_write_open_fd(struct archive *, int _fd);
388 int archive_write_open_filename(struct archive *, const char *_file);
389 /* A deprecated synonym for archive_write_open_filename() */
390 int archive_write_open_file(struct archive *, const char *_file);
391 int archive_write_open_FILE(struct archive *, FILE *);
392 /* _buffSize is the size of the buffer, _used refers to a variable that
393 * will be updated after each write into the buffer. */
394 int archive_write_open_memory(struct archive *,
395 void *_buffer, size_t _buffSize, size_t *_used);
398 * Note that the library will truncate writes beyond the size provided
399 * to archive_write_header or pad if the provided data is short.
401 int archive_write_header(struct archive *,
402 struct archive_entry *);
403 #if ARCHIVE_API_VERSION > 1
404 ssize_t archive_write_data(struct archive *, const void *, size_t);
405 #else
406 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
407 /* This was erroneously declared to return "int" in libarchive 1.x. */
408 int archive_write_data(struct archive *, const void *, size_t);
409 #endif
410 ssize_t archive_write_data_block(struct archive *, const void *, size_t, off_t);
411 int archive_write_finish_entry(struct archive *);
412 int archive_write_close(struct archive *);
413 #if ARCHIVE_API_VERSION > 1
414 int archive_write_finish(struct archive *);
415 #else
416 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
417 /* Return value was incorrect in libarchive 1.x. */
418 void archive_write_finish(struct archive *);
419 #endif
422 * To create objects on disk:
423 * 1) Ask archive_write_disk_new for a new archive_write_disk object.
424 * 2) Set any global properties. In particular, you should set
425 * the compression and format to use.
426 * 3) For each entry:
427 * - construct an appropriate struct archive_entry structure
428 * - archive_write_header to create the file/dir/etc on disk
429 * - archive_write_data to write the entry data
430 * 4) archive_write_finish to cleanup the writer and release resources
432 * In particular, you can use this in conjunction with archive_read()
433 * to pull entries out of an archive and create them on disk.
435 struct archive *archive_write_disk_new(void);
436 /* This file will not be overwritten. */
437 int archive_write_disk_set_skip_file(struct archive *,
438 dev_t, ino_t);
439 /* Set flags to control how the next item gets created. */
440 int archive_write_disk_set_options(struct archive *,
441 int flags);
443 * The lookup functions are given uname/uid (or gname/gid) pairs and
444 * return a uid (gid) suitable for this system. These are used for
445 * restoring ownership and for setting ACLs. The default functions
446 * are naive, they just return the uid/gid. These are small, so reasonable
447 * for applications that don't need to preserve ownership; they
448 * are probably also appropriate for applications that are doing
449 * same-system backup and restore.
452 * The "standard" lookup functions use common system calls to lookup
453 * the uname/gname, falling back to the uid/gid if the names can't be
454 * found. They cache lookups and are reasonably fast, but can be very
455 * large, so they are not used unless you ask for them. In
456 * particular, these match the specifications of POSIX "pax" and old
457 * POSIX "tar".
459 int archive_write_disk_set_standard_lookup(struct archive *);
461 * If neither the default (naive) nor the standard (big) functions suit
462 * your needs, you can write your own and register them. Be sure to
463 * include a cleanup function if you have allocated private data.
465 int archive_write_disk_set_group_lookup(struct archive *,
466 void *private_data,
467 gid_t (*loookup)(void *, const char *gname, gid_t gid),
468 void (*cleanup)(void *));
469 int archive_write_disk_set_user_lookup(struct archive *,
470 void *private_data,
471 uid_t (*)(void *, const char *uname, uid_t uid),
472 void (*cleanup)(void *));
475 * Accessor functions to read/set various information in
476 * the struct archive object:
478 /* Bytes written after compression or read before decompression. */
479 int64_t archive_position_compressed(struct archive *);
480 /* Bytes written to compressor or read from decompressor. */
481 int64_t archive_position_uncompressed(struct archive *);
483 const char *archive_compression_name(struct archive *);
484 int archive_compression(struct archive *);
485 int archive_errno(struct archive *);
486 const char *archive_error_string(struct archive *);
487 const char *archive_format_name(struct archive *);
488 int archive_format(struct archive *);
489 void archive_clear_error(struct archive *);
490 void archive_set_error(struct archive *, int _err, const char *fmt, ...);
492 #ifdef __cplusplus
494 #endif
496 #endif /* !ARCHIVE_H_INCLUDED */