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