source: branches/3.0/mindi-busybox/include/archive.h @ 3085

Last change on this file since 3085 was 2725, checked in by bruno, 8 years ago
  • Update mindi-busybox to 1.18.3 to avoid problems with the tar command which is now failing on recent versions with busybox 1.7.3
  • Property svn:eol-style set to native
File size: 8.6 KB
Line 
1/* vi: set sw=4 ts=4: */
2#ifndef UNARCHIVE_H
3#define UNARCHIVE_H 1
4
5PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
6
7enum {
8#if BB_BIG_ENDIAN
9    COMPRESS_MAGIC = 0x1f9d,
10    GZIP_MAGIC  = 0x1f8b,
11    BZIP2_MAGIC = 'B' * 256 + 'Z',
12    /* .xz signature: 0xfd, '7', 'z', 'X', 'Z', 0x00 */
13    /* More info at: http://tukaani.org/xz/xz-file-format.txt */
14    XZ_MAGIC1   = 0xfd * 256 + '7',
15    XZ_MAGIC2   = (('z' * 256 + 'X') * 256 + 'Z') * 256 + 0,
16    /* Different form: 32 bits, then 16 bits: */
17    XZ_MAGIC1a  = ((0xfd * 256 + '7') * 256 + 'z') * 256 + 'X',
18    XZ_MAGIC2a  = 'Z' * 256 + 0,
19#else
20    COMPRESS_MAGIC = 0x9d1f,
21    GZIP_MAGIC  = 0x8b1f,
22    BZIP2_MAGIC = 'Z' * 256 + 'B',
23    XZ_MAGIC1   = '7' * 256 + 0xfd,
24    XZ_MAGIC2   = ((0 * 256 + 'Z') * 256 + 'X') * 256 + 'z',
25    XZ_MAGIC1a  = (('X' * 256 + 'z') * 256 + '7') * 256 + 0xfd,
26    XZ_MAGIC2a  = 0 * 256 + 'Z',
27#endif
28};
29
30typedef struct file_header_t {
31    char *name;
32    char *link_target;
33#if ENABLE_FEATURE_TAR_UNAME_GNAME
34    char *tar__uname;
35    char *tar__gname;
36#endif
37    off_t size;
38    uid_t uid;
39    gid_t gid;
40    mode_t mode;
41    time_t mtime;
42    dev_t device;
43} file_header_t;
44
45struct hardlinks_t;
46
47typedef struct archive_handle_t {
48    /* Flags. 1st since it is most used member */
49    unsigned ah_flags;
50
51    /* The raw stream as read from disk or stdin */
52    int src_fd;
53
54    /* Define if the header and data component should be processed */
55    char FAST_FUNC (*filter)(struct archive_handle_t *);
56    /* List of files that have been accepted */
57    llist_t *accept;
58    /* List of files that have been rejected */
59    llist_t *reject;
60    /* List of files that have successfully been worked on */
61    llist_t *passed;
62
63    /* Currently processed file's header */
64    file_header_t *file_header;
65
66    /* Process the header component, e.g. tar -t */
67    void FAST_FUNC (*action_header)(const file_header_t *);
68
69    /* Process the data component, e.g. extract to filesystem */
70    void FAST_FUNC (*action_data)(struct archive_handle_t *);
71
72    /* Function that skips data */
73    void FAST_FUNC (*seek)(int fd, off_t amount);
74
75    /* Count processed bytes */
76    off_t offset;
77
78    /* Archiver specific. Can make it a union if it ever gets big */
79#if ENABLE_TAR || ENABLE_DPKG || ENABLE_DPKG_DEB
80    smallint tar__end;
81# if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
82    char* tar__longname;
83    char* tar__linkname;
84# endif
85#if ENABLE_FEATURE_TAR_TO_COMMAND
86    char* tar__to_command;
87#endif
88# if ENABLE_FEATURE_TAR_SELINUX
89    char* tar__global_sctx;
90    char* tar__next_file_sctx;
91# endif
92#endif
93#if ENABLE_CPIO || ENABLE_RPM2CPIO || ENABLE_RPM
94    uoff_t cpio__blocks;
95    struct hardlinks_t *cpio__hardlinks_to_create;
96    struct hardlinks_t *cpio__created_hardlinks;
97#endif
98#if ENABLE_DPKG || ENABLE_DPKG_DEB
99    /* Temporary storage */
100    char *dpkg__buffer;
101    /* How to process any sub archive, e.g. get_header_tar_gz */
102    char FAST_FUNC (*dpkg__action_data_subarchive)(struct archive_handle_t *);
103    /* Contains the handle to a sub archive */
104    struct archive_handle_t *dpkg__sub_archive;
105#endif
106#if ENABLE_FEATURE_AR_CREATE
107    const char *ar__name;
108    struct archive_handle_t *ar__out;
109#endif
110} archive_handle_t;
111/* bits in ah_flags */
112#define ARCHIVE_RESTORE_DATE        (1 << 0)
113#define ARCHIVE_CREATE_LEADING_DIRS (1 << 1)
114#define ARCHIVE_UNLINK_OLD          (1 << 2)
115#define ARCHIVE_EXTRACT_QUIET       (1 << 3)
116#define ARCHIVE_EXTRACT_NEWER       (1 << 4)
117#define ARCHIVE_DONT_RESTORE_OWNER  (1 << 5)
118#define ARCHIVE_DONT_RESTORE_PERM   (1 << 6)
119#define ARCHIVE_NUMERIC_OWNER       (1 << 7)
120#define ARCHIVE_O_TRUNC             (1 << 8)
121
122
123/* POSIX tar Header Block, from POSIX 1003.1-1990  */
124#define TAR_BLOCK_SIZE 512
125#define NAME_SIZE      100
126#define NAME_SIZE_STR "100"
127typedef struct tar_header_t {       /* byte offset */
128    char name[NAME_SIZE];     /*   0-99 */
129    char mode[8];             /* 100-107 */
130    char uid[8];              /* 108-115 */
131    char gid[8];              /* 116-123 */
132    char size[12];            /* 124-135 */
133    char mtime[12];           /* 136-147 */
134    char chksum[8];           /* 148-155 */
135    char typeflag;            /* 156-156 */
136    char linkname[NAME_SIZE]; /* 157-256 */
137    /* POSIX:   "ustar" NUL "00" */
138    /* GNU tar: "ustar  " NUL */
139    /* Normally it's defined as magic[6] followed by
140     * version[2], but we put them together to save code.
141     */
142    char magic[8];            /* 257-264 */
143    char uname[32];           /* 265-296 */
144    char gname[32];           /* 297-328 */
145    char devmajor[8];         /* 329-336 */
146    char devminor[8];         /* 337-344 */
147    char prefix[155];         /* 345-499 */
148    char padding[12];         /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */
149} tar_header_t;
150struct BUG_tar_header {
151    char c[sizeof(tar_header_t) == TAR_BLOCK_SIZE ? 1 : -1];
152};
153
154
155
156/* Info struct unpackers can fill out to inform users of thing like
157 * timestamps of unpacked files */
158typedef struct unpack_info_t {
159    time_t mtime;
160} unpack_info_t;
161
162extern archive_handle_t *init_handle(void) FAST_FUNC;
163
164extern char filter_accept_all(archive_handle_t *archive_handle) FAST_FUNC;
165extern char filter_accept_list(archive_handle_t *archive_handle) FAST_FUNC;
166extern char filter_accept_list_reassign(archive_handle_t *archive_handle) FAST_FUNC;
167extern char filter_accept_reject_list(archive_handle_t *archive_handle) FAST_FUNC;
168
169extern void unpack_ar_archive(archive_handle_t *ar_archive) FAST_FUNC;
170
171extern void data_skip(archive_handle_t *archive_handle) FAST_FUNC;
172extern void data_extract_all(archive_handle_t *archive_handle) FAST_FUNC;
173extern void data_extract_to_stdout(archive_handle_t *archive_handle) FAST_FUNC;
174extern void data_extract_to_command(archive_handle_t *archive_handle) FAST_FUNC;
175
176extern void header_skip(const file_header_t *file_header) FAST_FUNC;
177extern void header_list(const file_header_t *file_header) FAST_FUNC;
178extern void header_verbose_list(const file_header_t *file_header) FAST_FUNC;
179
180extern char get_header_ar(archive_handle_t *archive_handle) FAST_FUNC;
181extern char get_header_cpio(archive_handle_t *archive_handle) FAST_FUNC;
182extern char get_header_tar(archive_handle_t *archive_handle) FAST_FUNC;
183extern char get_header_tar_gz(archive_handle_t *archive_handle) FAST_FUNC;
184extern char get_header_tar_bz2(archive_handle_t *archive_handle) FAST_FUNC;
185extern char get_header_tar_lzma(archive_handle_t *archive_handle) FAST_FUNC;
186
187extern void seek_by_jump(int fd, off_t amount) FAST_FUNC;
188extern void seek_by_read(int fd, off_t amount) FAST_FUNC;
189
190extern void data_align(archive_handle_t *archive_handle, unsigned boundary) FAST_FUNC;
191extern const llist_t *find_list_entry(const llist_t *list, const char *filename) FAST_FUNC;
192extern const llist_t *find_list_entry2(const llist_t *list, const char *filename) FAST_FUNC;
193
194/* A bit of bunzip2 internals are exposed for compressed help support: */
195typedef struct bunzip_data bunzip_data;
196int start_bunzip(bunzip_data **bdp, int in_fd, const void *inbuf, int len) FAST_FUNC;
197/* NB: read_bunzip returns < 0 on error, or the number of *unfilled* bytes
198 * in outbuf. IOW: on EOF returns len ("all bytes are not filled"), not 0: */
199int read_bunzip(bunzip_data *bd, char *outbuf, int len) FAST_FUNC;
200void dealloc_bunzip(bunzip_data *bd) FAST_FUNC;
201
202typedef struct inflate_unzip_result {
203    off_t bytes_out;
204    uint32_t crc;
205} inflate_unzip_result;
206
207IF_DESKTOP(long long) int inflate_unzip(inflate_unzip_result *res, off_t compr_size, int src_fd, int dst_fd) FAST_FUNC;
208/* xz unpacker takes .xz stream from offset 6 */
209IF_DESKTOP(long long) int unpack_xz_stream(int src_fd, int dst_fd) FAST_FUNC;
210/* lzma unpacker takes .lzma stream from offset 0 */
211IF_DESKTOP(long long) int unpack_lzma_stream(int src_fd, int dst_fd) FAST_FUNC;
212/* the rest wants 2 first bytes already skipped by the caller */
213IF_DESKTOP(long long) int unpack_bz2_stream(int src_fd, int dst_fd) FAST_FUNC;
214IF_DESKTOP(long long) int unpack_gz_stream(int src_fd, int dst_fd) FAST_FUNC;
215IF_DESKTOP(long long) int unpack_gz_stream_with_info(int src_fd, int dst_fd, unpack_info_t *info) FAST_FUNC;
216IF_DESKTOP(long long) int unpack_Z_stream(int src_fd, int dst_fd) FAST_FUNC;
217/* wrapper which checks first two bytes to be "BZ" */
218IF_DESKTOP(long long) int unpack_bz2_stream_prime(int src_fd, int dst_fd) FAST_FUNC;
219
220char* append_ext(char *filename, const char *expected_ext) FAST_FUNC;
221int bbunpack(char **argv,
222        IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(unpack_info_t *info),
223        char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
224        const char *expected_ext
225) FAST_FUNC;
226
227#if BB_MMU
228void open_transformer(int fd,
229    IF_DESKTOP(long long) int FAST_FUNC (*transformer)(int src_fd, int dst_fd)) FAST_FUNC;
230#define open_transformer(fd, transformer, transform_prog) open_transformer(fd, transformer)
231#else
232void open_transformer(int src_fd, const char *transform_prog) FAST_FUNC;
233#define open_transformer(fd, transformer, transform_prog) open_transformer(fd, transform_prog)
234#endif
235
236POP_SAVED_FUNCTION_VISIBILITY
237
238#endif
Note: See TracBrowser for help on using the repository browser.