Gitiles
Code Review Sign In
gerrit.nordix.org / codeaurora / busybox / b61e13d24741536fc713dab1c10a4925197b2072 / . / include / unarchive.h
blob: a6b0477940aabf2c0ced117e2112d77055ed0e6f [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 Vlasenko714701c2006-12-22 00:21:07 +0000[diff] [blame]33 /* define if the header and data component should be processed */
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]34 char (*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
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]44 /* process the header component, e.g. tar -t */
45 void (*action_header)(const file_header_t *);
Glenn L McGrathe9fc7812001-10-25 14:57:14 +0000[diff] [blame]46
Glenn L McGrathf235d052003-10-29 03:37:54 +0000[diff] [blame]47 /* process the data component, e.g. extract to filesystem */
Denis Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]48 void (*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 Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]51 char (*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 Vlasenko75103842007-06-20 14:49:47 +0000[diff] [blame]63 void (*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 */
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]69 unsigned char flags;
70
71} archive_handle_t;
72
Denis Vlasenkobb3d0fa2007-01-03 01:57:25 +0000[diff] [blame]73
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]74extern archive_handle_t *init_handle(void);
75
Glenn L McGrath18bbca12002-11-05 01:52:23 +0000[diff] [blame]76extern char filter_accept_all(archive_handle_t *archive_handle);
77extern char filter_accept_list(archive_handle_t *archive_handle);
78extern char filter_accept_list_reassign(archive_handle_t *archive_handle);
79extern char filter_accept_reject_list(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]80
81extern void unpack_ar_archive(archive_handle_t *ar_archive);
82
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]83extern void data_skip(archive_handle_t *archive_handle);
84extern void data_extract_all(archive_handle_t *archive_handle);
85extern void data_extract_to_stdout(archive_handle_t *archive_handle);
Glenn L McGrath61b79042002-10-19 10:40:55 +0000[diff] [blame]86extern void data_extract_to_buffer(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]87
88extern void header_skip(const file_header_t *file_header);
89extern void header_list(const file_header_t *file_header);
90extern void header_verbose_list(const file_header_t *file_header);
91
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]92extern char get_header_ar(archive_handle_t *archive_handle);
Glenn L McGrathb72a7352002-12-10 00:17:22 +0000[diff] [blame]93extern char get_header_cpio(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]94extern char get_header_tar(archive_handle_t *archive_handle);
Glenn L McGrath7f2a9532002-11-05 02:56:57 +0000[diff] [blame]95extern char get_header_tar_bz2(archive_handle_t *archive_handle);
Rob Landleyc1d69902006-01-20 18:28:50 +0000[diff] [blame]96extern char get_header_tar_lzma(archive_handle_t *archive_handle);
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]97extern char get_header_tar_gz(archive_handle_t *archive_handle);
98
Denis Vlasenko37188322008-02-16 13:20:56 +0000[diff] [blame]99extern void seek_by_jump(const archive_handle_t *archive_handle, unsigned amount);
100extern void seek_by_read(const archive_handle_t *archive_handle, unsigned amount);
Glenn L McGrath60bce492002-11-03 07:28:38 +0000[diff] [blame]101
Glenn L McGrath237ae422002-11-03 14:05:15 +0000[diff] [blame]102extern ssize_t archive_xread_all_eof(archive_handle_t *archive_handle, unsigned char *buf, size_t count);
103
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000[diff] [blame]104extern void data_align(archive_handle_t *archive_handle, unsigned boundary);
Glenn L McGrathc5c1a8a2002-10-19 06:19:22 +0000[diff] [blame]105extern const llist_t *find_list_entry(const llist_t *list, const char *filename);
Denis Vlasenko314908d2006-09-03 14:04:33 +0000[diff] [blame]106extern const llist_t *find_list_entry2(const llist_t *list, const char *filename);
Glenn L McGrath237ae422002-11-03 14:05:15 +0000[diff] [blame]107
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000[diff] [blame]108/* A bit of bunzip2 internals are exposed for compressed help support: */
109typedef struct bunzip_data bunzip_data;
110int start_bunzip(bunzip_data **bdp, int in_fd, const unsigned char *inbuf, int len);
111int read_bunzip(bunzip_data *bd, char *outbuf, int len);
112void dealloc_bunzip(bunzip_data *bd);
Denis Vlasenkocd42cb82007-01-05 23:56:53 +0000[diff] [blame]113
114typedef struct inflate_unzip_result {
115 off_t bytes_out;
116 uint32_t crc;
117} inflate_unzip_result;
118
Denis Vlasenkoc14d39e2007-06-08 13:05:39 +0000[diff] [blame]119extern USE_DESKTOP(long long) int unpack_bz2_stream(int src_fd, int dst_fd);
Denis Vlasenkoe8ef7ec2008-02-04 12:12:48 +0000[diff] [blame]120extern USE_DESKTOP(long long) int inflate_unzip(inflate_unzip_result *res, off_t compr_size, int src_fd, int dst_fd);
Denis Vlasenkoc14d39e2007-06-08 13:05:39 +0000[diff] [blame]121extern USE_DESKTOP(long long) int unpack_gz_stream(int src_fd, int dst_fd);
122extern 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]123
Denis Vlasenko211f7f82007-09-05 11:48:32 +0000[diff] [blame]124#if BB_MMU
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000[diff] [blame]125extern int open_transformer(int src_fd,
126 USE_DESKTOP(long long) int (*transformer)(int src_fd, int dst_fd));
Denis Vlasenko059c9172007-11-12 02:13:12 +0000[diff] [blame]127#define open_transformer(src_fd, transformer, transform_prog) open_transformer(src_fd, transformer)
Denis Vlasenko211f7f82007-09-05 11:48:32 +0000[diff] [blame]128#else
Denis Vlasenko059c9172007-11-12 02:13:12 +0000[diff] [blame]129extern int open_transformer(int src_fd, const char *transform_prog);
130#define open_transformer(src_fd, transformer, transform_prog) open_transformer(src_fd, transform_prog)
Denis Vlasenko211f7f82007-09-05 11:48:32 +0000[diff] [blame]131#endif
Glenn L McGrath5699b852003-11-15 23:19:05 +0000[diff] [blame]132
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000[diff] [blame]133#if __GNUC_PREREQ(4,1)
134# pragma GCC visibility pop
135#endif
136
Glenn L McGrath7ca04f32002-09-25 02:47:48 +0000[diff] [blame]137#endif