include/unarchive.h

   1 /* vi: set sw=4 ts=4: */
   2 #ifndef UNARCHIVE_H
   3 #define UNARCHIVE_H 1
   4
   5 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
   6
   7 enum {
   8 #if BB_BIG_ENDIAN
   9         COMPRESS_MAGIC = 0x1f9d,
  10         GZIP_MAGIC = 0x1f8b,
  11         BZIP2_MAGIC = ('B'<<8) + 'Z',
  12         XZ_MAGIC1 = (0xfd<<8) + '7',
  13         XZ_MAGIC2 = ((((('z'<<8) + 'X')<<8) + 'Z')<<8) + 0,
  14 #else
  15         COMPRESS_MAGIC = 0x9d1f,
  16         GZIP_MAGIC = 0x8b1f,
  17         BZIP2_MAGIC = ('Z'<<8) + 'B',
  18         XZ_MAGIC1 = ('7'<<8) + 0xfd,
  19         XZ_MAGIC2 = (((((0<<8) + 'Z')<<8) + 'X')<<8) + 'z',
  20 #endif
  21 };
  22
  23 typedef struct file_header_t {
  24         char *name;
  25         char *link_target;
  26 #if ENABLE_FEATURE_TAR_UNAME_GNAME
  27         char *tar__uname;
  28         char *tar__gname;
  29 #endif
  30         off_t size;
  31         uid_t uid;
  32         gid_t gid;
  33         mode_t mode;
  34         time_t mtime;
  35         dev_t device;
  36 } file_header_t;
  37
  38 struct hardlinks_t;
  39
  40 typedef struct archive_handle_t {
  41         /* Flags. 1st since it is most used member */
  42         unsigned ah_flags;
  43
  44         /* The raw stream as read from disk or stdin */
  45         int src_fd;
  46
  47         /* Define if the header and data component should be processed */
  48         char FAST_FUNC (*filter)(struct archive_handle_t *);
  49         /* List of files that have been accepted */
  50         llist_t *accept;
  51         /* List of files that have been rejected */
  52         llist_t *reject;
  53         /* List of files that have successfully been worked on */
  54         llist_t *passed;
  55
  56         /* Currently processed file's header */
  57         file_header_t *file_header;
  58
  59         /* Process the header component, e.g. tar -t */
  60         void FAST_FUNC (*action_header)(const file_header_t *);
  61
  62         /* Process the data component, e.g. extract to filesystem */
  63         void FAST_FUNC (*action_data)(struct archive_handle_t *);
  64
  65         /* Function that skips data */
  66         void FAST_FUNC (*seek)(int fd, off_t amount);
  67
  68         /* Count processed bytes */
  69         off_t offset;
  70
  71         /* Archiver specific. Can make it a union if it ever gets big */
  72 #if ENABLE_TAR || ENABLE_DPKG || ENABLE_DPKG_DEB
  73         smallint tar__end;
  74 # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
  75         char* tar__longname;
  76         char* tar__linkname;
  77 # endif
  78 # if ENABLE_FEATURE_TAR_SELINUX
  79         char* tar__global_sctx;
  80         char* tar__next_file_sctx;
  81 # endif
  82 #endif
  83 #if ENABLE_CPIO || ENABLE_RPM2CPIO || ENABLE_RPM
  84         uoff_t cpio__blocks;
  85         struct hardlinks_t *cpio__hardlinks_to_create;
  86         struct hardlinks_t *cpio__created_hardlinks;
  87 #endif
  88 #if ENABLE_DPKG || ENABLE_DPKG_DEB
  89         /* Temporary storage */
  90         char *dpkg__buffer;
  91         /* How to process any sub archive, e.g. get_header_tar_gz */
  92         char FAST_FUNC (*dpkg__action_data_subarchive)(struct archive_handle_t *);
  93         /* Contains the handle to a sub archive */
  94         struct archive_handle_t *dpkg__sub_archive;
  95 #endif
  96 #if ENABLE_FEATURE_AR_CREATE
  97         const char *ar__name;
  98         struct archive_handle_t *ar__out;
  99 #endif
 100 } archive_handle_t;
 101 /* bits in ah_flags */
 102 #define ARCHIVE_RESTORE_DATE        (1 << 0)
 103 #define ARCHIVE_CREATE_LEADING_DIRS (1 << 1)
 104 #define ARCHIVE_UNLINK_OLD          (1 << 2)
 105 #define ARCHIVE_EXTRACT_QUIET       (1 << 3)
 106 #define ARCHIVE_EXTRACT_NEWER       (1 << 4)
 107 #define ARCHIVE_DONT_RESTORE_OWNER  (1 << 5)
 108 #define ARCHIVE_DONT_RESTORE_PERM   (1 << 6)
 109 #define ARCHIVE_NUMERIC_OWNER       (1 << 7)
 110 #define ARCHIVE_O_TRUNC             (1 << 8)
 111
 112
 113 /* Info struct unpackers can fill out to inform users of thing like
 114  * timestamps of unpacked files */
 115 typedef struct unpack_info_t {
 116         time_t mtime;
 117 } unpack_info_t;
 118
 119 extern archive_handle_t *init_handle(void) FAST_FUNC;
 120
 121 extern char filter_accept_all(archive_handle_t *archive_handle) FAST_FUNC;
 122 extern char filter_accept_list(archive_handle_t *archive_handle) FAST_FUNC;
 123 extern char filter_accept_list_reassign(archive_handle_t *archive_handle) FAST_FUNC;
 124 extern char filter_accept_reject_list(archive_handle_t *archive_handle) FAST_FUNC;
 125
 126 extern void unpack_ar_archive(archive_handle_t *ar_archive) FAST_FUNC;
 127
 128 extern void data_skip(archive_handle_t *archive_handle) FAST_FUNC;
 129 extern void data_extract_all(archive_handle_t *archive_handle) FAST_FUNC;
 130 extern void data_extract_to_stdout(archive_handle_t *archive_handle) FAST_FUNC;
 131
 132 extern void header_skip(const file_header_t *file_header) FAST_FUNC;
 133 extern void header_list(const file_header_t *file_header) FAST_FUNC;
 134 extern void header_verbose_list(const file_header_t *file_header) FAST_FUNC;
 135
 136 extern char get_header_ar(archive_handle_t *archive_handle) FAST_FUNC;
 137 extern char get_header_cpio(archive_handle_t *archive_handle) FAST_FUNC;
 138 extern char get_header_tar(archive_handle_t *archive_handle) FAST_FUNC;
 139 extern char get_header_tar_gz(archive_handle_t *archive_handle) FAST_FUNC;
 140 extern char get_header_tar_bz2(archive_handle_t *archive_handle) FAST_FUNC;
 141 extern char get_header_tar_lzma(archive_handle_t *archive_handle) FAST_FUNC;
 142
 143 extern void seek_by_jump(int fd, off_t amount) FAST_FUNC;
 144 extern void seek_by_read(int fd, off_t amount) FAST_FUNC;
 145
 146 extern void data_align(archive_handle_t *archive_handle, unsigned boundary) FAST_FUNC;
 147 extern const llist_t *find_list_entry(const llist_t *list, const char *filename) FAST_FUNC;
 148 extern const llist_t *find_list_entry2(const llist_t *list, const char *filename) FAST_FUNC;
 149
 150 /* A bit of bunzip2 internals are exposed for compressed help support: */
 151 typedef struct bunzip_data bunzip_data;
 152 int start_bunzip(bunzip_data **bdp, int in_fd, const unsigned char *inbuf, int len) FAST_FUNC;
 153 int read_bunzip(bunzip_data *bd, char *outbuf, int len) FAST_FUNC;
 154 void dealloc_bunzip(bunzip_data *bd) FAST_FUNC;
 155
 156 typedef struct inflate_unzip_result {
 157         off_t bytes_out;
 158         uint32_t crc;
 159 } inflate_unzip_result;
 160
 161 IF_DESKTOP(long long) int inflate_unzip(inflate_unzip_result *res, off_t compr_size, int src_fd, int dst_fd) FAST_FUNC;
 162 /* xz unpacker takes .xz stream from offset 0 */
 163 IF_DESKTOP(long long) int unpack_xz_stream(int src_fd, int dst_fd) FAST_FUNC;
 164 /* lzma unpacker takes .lzma stream from offset 0 */
 165 IF_DESKTOP(long long) int unpack_lzma_stream(int src_fd, int dst_fd) FAST_FUNC;
 166 /* the rest wants 2 first bytes already skipped by the caller */
 167 IF_DESKTOP(long long) int unpack_bz2_stream(int src_fd, int dst_fd) FAST_FUNC;
 168 IF_DESKTOP(long long) int unpack_gz_stream(int src_fd, int dst_fd) FAST_FUNC;
 169 IF_DESKTOP(long long) int unpack_gz_stream_with_info(int src_fd, int dst_fd, unpack_info_t *info) FAST_FUNC;
 170 IF_DESKTOP(long long) int unpack_Z_stream(int src_fd, int dst_fd) FAST_FUNC;
 171 /* wrapper which checks first two bytes to be "BZ" */
 172 IF_DESKTOP(long long) int unpack_bz2_stream_prime(int src_fd, int dst_fd) FAST_FUNC;
 173
 174 char* append_ext(char *filename, const char *expected_ext) FAST_FUNC;
 175 int bbunpack(char **argv,
 176             IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(unpack_info_t *info),
 177             char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
 178             const char *expected_ext
 179 ) FAST_FUNC;
 180
 181 #if BB_MMU
 182 void open_transformer(int fd,
 183         IF_DESKTOP(long long) int FAST_FUNC (*transformer)(int src_fd, int dst_fd)) FAST_FUNC;
 184 #define open_transformer(fd, transformer, transform_prog) open_transformer(fd, transformer)
 185 #else
 186 void open_transformer(int src_fd, const char *transform_prog) FAST_FUNC;
 187 #define open_transformer(fd, transformer, transform_prog) open_transformer(fd, transform_prog)
 188 #endif
 189
 190 POP_SAVED_FUNCTION_VISIBILITY
 191
 192 #endif