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