Gitiles
Code Review Sign In
gerrit.nordix.org / codeaurora / busybox / 059c91711f664927534246bd5c1d5e202fcf8e1d / . / include / unarchive.h
blob: 00a00d6721a3cdf14b310a1049a169441037da9c [file] [log] [blame]
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +0000[diff] [blame]1/* vi: set sw=4 ts=4: */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]2#ifndef __UNARCHIVE_H__
3#define __UNARCHIVE_H__
Glenn L McGrathe9fc7812001-10-25 14:57:14 +0000[diff] [blame]4
Rob Landleyf3d6c942005-10-27 22:49:08 +0000[diff] [blame]5#define ARCHIVE_PRESERVE_DATE 1
6#define ARCHIVE_CREATE_LEADING_DIRS 2
7#define ARCHIVE_EXTRACT_UNCONDITIONAL 4
8#define ARCHIVE_EXTRACT_QUIET 8
9#define ARCHIVE_EXTRACT_NEWER 16
10#define ARCHIVE_NOPRESERVE_OWN 32
11#define ARCHIVE_NOPRESERVE_PERM 64
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]12
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]13typedef struct file_header_t {
Glenn L McGrathe9fc7812001-10-25 14:57:14 +0000[diff] [blame]14 char *name;
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]15 char *link_target;
Glenn L McGrathe9fc7812001-10-25 14:57:14 +0000[diff] [blame]16 off_t size;
17 uid_t uid;
18 gid_t gid;
19 mode_t mode;
20 time_t mtime;
21 dev_t device;
22} file_header_t;
23
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]24typedef struct archive_handle_t {
Denis Vlasenko714701c2006-12-22 00:21:07 +0000[diff] [blame]25 /* define if the header and data component should be processed */
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]26 char (*filter)(struct archive_handle_t *);
Glenn L McGrath66125c82002-12-08 00:54:33 +0000[diff] [blame]27 llist_t *accept;
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +0000[diff] [blame]28 /* List of files that have been rejected */
Glenn L McGrath66125c82002-12-08 00:54:33 +0000[diff] [blame]29 llist_t *reject;
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +0000[diff] [blame]30 /* List of files that have successfully been worked on */
31 llist_t *passed;
Glenn L McGrathe9fc7812001-10-25 14:57:14 +0000[diff] [blame]32
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]33 /* Contains the processed header entry */
34 file_header_t *file_header;
Glenn L McGrathe9fc7812001-10-25 14:57:14 +0000[diff] [blame]35
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]36 /* process the header component, e.g. tar -t */
37 void (*action_header)(const file_header_t *);
Glenn L McGrathe9fc7812001-10-25 14:57:14 +0000[diff] [blame]38
Glenn L McGrathf235d052003-10-29 03:37:54 +0000[diff] [blame]39 /* process the data component, e.g. extract to filesystem */
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]40 void (*action_data)(struct archive_handle_t *);
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000[diff] [blame]41
Glenn L McGrath18bbca12002-11-05 01:52:23 +0000[diff] [blame]42 /* How to process any sub archive, e.g. get_header_tar_gz */
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]43 char (*action_data_subarchive)(struct archive_handle_t *);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]44
45 /* Contains the handle to a sub archive */
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]46 struct archive_handle_t *sub_archive;
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]47
48 /* The raw stream as read from disk or stdin */
49 int src_fd;
50
51 /* Count the number of bytes processed */
52 off_t offset;
53
Glenn L McGrath237ae422002-11-03 14:05:15 +0000[diff] [blame]54 /* Function that skips data: read_by_char or read_by_skip */
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]55 void (*seek)(const struct archive_handle_t *archive_handle, const unsigned amount);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000[diff] [blame]56
Glenn L McGrathf235d052003-10-29 03:37:54 +0000[diff] [blame]57 /* Temporary storage */
Glenn L McGrath61b79042002-10-19 10:40:55 +0000[diff] [blame]58 char *buffer;
59
Bernhard Reutner-Fischer9457e702006-04-02 20:12:31 +0000[diff] [blame]60 /* Flags and misc. stuff */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]61 unsigned char flags;
62
63} archive_handle_t;
64
Denis Vlasenkobb3d0fa2007-01-03 01:57:25 +0000[diff] [blame]65
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]66extern archive_handle_t *init_handle(void);
67
Glenn L McGrath18bbca12002-11-05 01:52:23 +0000[diff] [blame]68extern char filter_accept_all(archive_handle_t *archive_handle);
69extern char filter_accept_list(archive_handle_t *archive_handle);
70extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
71extern char filter_accept_reject_list(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]72
73extern void unpack_ar_archive(archive_handle_t *ar_archive);
74
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]75extern void data_skip(archive_handle_t *archive_handle);
76extern void data_extract_all(archive_handle_t *archive_handle);
77extern void data_extract_to_stdout(archive_handle_t *archive_handle);
Glenn L McGrath61b79042002-10-19 10:40:55 +0000[diff] [blame]78extern void data_extract_to_buffer(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]79
80extern void header_skip(const file_header_t *file_header);
81extern void header_list(const file_header_t *file_header);
82extern void header_verbose_list(const file_header_t *file_header);
83
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]84extern char get_header_ar(archive_handle_t *archive_handle);
Glenn L McGrathb72a7352002-12-10 00:17:22 +0000[diff] [blame]85extern char get_header_cpio(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]86extern char get_header_tar(archive_handle_t *archive_handle);
Glenn L McGrath7f2a9532002-11-05 02:56:57 +0000[diff] [blame]87extern char get_header_tar_bz2(archive_handle_t *archive_handle);
Rob Landleyc1d69902006-01-20 18:28:50 +0000[diff] [blame]88extern char get_header_tar_lzma(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]89extern char get_header_tar_gz(archive_handle_t *archive_handle);
90
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]91extern void seek_by_jump(const archive_handle_t *archive_handle, const unsigned amount);
92extern void seek_by_read(const archive_handle_t *archive_handle, const unsigned amount);
Glenn L McGrath60bce492002-11-03 07:28:38 +0000[diff] [blame]93
Glenn L McGrath237ae422002-11-03 14:05:15 +0000[diff] [blame]94extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
95
96extern void data_align(archive_handle_t *archive_handle, const unsigned short boundary);
Glenn L McGrathc5c1a8a2002-10-19 06:19:22 +0000[diff] [blame]97extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
Denis Vlasenko314908d2006-09-03 14:04:33 +0000[diff] [blame]98extern const llist_t *find_list_entry2(const llist_t *list, const char *filename);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000[diff] [blame]99
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000[diff] [blame]100/* A bit of bunzip2 internals are exposed for compressed help support: */
101typedef struct bunzip_data bunzip_data;
102int start_bunzip(bunzip_data **bdp, int in_fd, const unsigned char *inbuf, int len);
103int read_bunzip(bunzip_data *bd, char *outbuf, int len);
104void dealloc_bunzip(bunzip_data *bd);
Denis Vlasenkocd42cb82007-01-05 23:56:53 +0000[diff] [blame]105
106typedef struct inflate_unzip_result {
107 off_t bytes_out;
108 uint32_t crc;
109} inflate_unzip_result;
110
Denis Vlasenkoc14d39e2007-06-08 13:05:39 +0000[diff] [blame]111extern USE_DESKTOP(long long) int unpack_bz2_stream(int src_fd, int dst_fd);
112extern USE_DESKTOP(long long) int inflate_unzip(inflate_unzip_result *res, unsigned bufsize, int src_fd, int dst_fd);
113extern USE_DESKTOP(long long) int unpack_gz_stream(int src_fd, int dst_fd);
114extern USE_DESKTOP(long long) int unpack_lzma_stream(int src_fd, int dst_fd);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000[diff] [blame]115
Denis Vlasenko211f7f82007-09-05 11:48:32 +0000[diff] [blame]116#if BB_MMU
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000[diff] [blame]117extern int open_transformer(int src_fd,
118 USE_DESKTOP(long long) int (*transformer)(int src_fd, int dst_fd));
Denis Vlasenko059c9172007-11-12 02:13:12 +0000[diff] [blame^]119#define open_transformer(src_fd, transformer, transform_prog) open_transformer(src_fd, transformer)
Denis Vlasenko211f7f82007-09-05 11:48:32 +0000[diff] [blame]120#else
Denis Vlasenko059c9172007-11-12 02:13:12 +0000[diff] [blame^]121extern int open_transformer(int src_fd, const char *transform_prog);
122#define open_transformer(src_fd, transformer, transform_prog) open_transformer(src_fd, transform_prog)
Denis Vlasenko211f7f82007-09-05 11:48:32 +0000[diff] [blame]123#endif
Glenn L McGrath5699b852003-11-15 23:19:05 +0000[diff] [blame]124
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]125#endif