LXR busybox/include/bb

   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 = 256 * 'B' + '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   = 256 * 0xfd + '7',
  15        XZ_MAGIC2   = 256 * (unsigned)(256 * (256 * 'z' + 'X') + 'Z') + 0,
  16        /* Different form: 32 bits, then 16 bits: */
  17        /* (unsigned) cast suppresses "integer overflow in expression" warning */
  18        XZ_MAGIC1a  = 256 * (unsigned)(256 * (256 * 0xfd + '7') + 'z') + 'X',
  19        XZ_MAGIC2a  = 256 * 'Z' + 0,
  20#else
  21        COMPRESS_MAGIC = 0x9d1f,
  22        GZIP_MAGIC  = 0x8b1f,
  23        BZIP2_MAGIC = 'B' + 'Z' * 256,
  24        XZ_MAGIC1   = 0xfd + '7' * 256,
  25        XZ_MAGIC2   = 'z' + ('X' + ('Z' + 0 * 256) * 256) * 256,
  26        XZ_MAGIC1a  = 0xfd + ('7' + ('z' + 'X' * 256) * 256) * 256,
  27        XZ_MAGIC2a  = 'Z' + 0 * 256,
  28#endif
  29};
  30
  31typedef struct file_header_t {
  32        char *name;
  33        char *link_target;
  34#if ENABLE_FEATURE_TAR_UNAME_GNAME
  35        char *tar__uname;
  36        char *tar__gname;
  37#endif
  38        off_t size;
  39        uid_t uid;
  40        gid_t gid;
  41        mode_t mode;
  42        time_t mtime;
  43        dev_t device;
  44} file_header_t;
  45
  46struct hardlinks_t;
  47
  48typedef struct archive_handle_t {
  49        /* Flags. 1st since it is most used member */
  50        unsigned ah_flags;
  51
  52        /* The raw stream as read from disk or stdin */
  53        int src_fd;
  54
  55        /* Define if the header and data component should be processed */
  56        char FAST_FUNC (*filter)(struct archive_handle_t *);
  57        /* List of files that have been accepted */
  58        llist_t *accept;
  59        /* List of files that have been rejected */
  60        llist_t *reject;
  61        /* List of files that have successfully been worked on */
  62        llist_t *passed;
  63
  64        /* Currently processed file's header */
  65        file_header_t *file_header;
  66
  67        /* Process the header component, e.g. tar -t */
  68        void FAST_FUNC (*action_header)(const file_header_t *);
  69
  70        /* Process the data component, e.g. extract to filesystem */
  71        void FAST_FUNC (*action_data)(struct archive_handle_t *);
  72
  73        /* Function that skips data */
  74        void FAST_FUNC (*seek)(int fd, off_t amount);
  75
  76        /* Count processed bytes */
  77        off_t offset;
  78
  79        /* Archiver specific. Can make it a union if it ever gets big */
  80#define PAX_NEXT_FILE 0
  81#define PAX_GLOBAL    1
  82#if ENABLE_TAR || ENABLE_DPKG || ENABLE_DPKG_DEB
  83        smallint tar__end;
  84# if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
  85        char* tar__longname;
  86        char* tar__linkname;
  87# endif
  88# if ENABLE_FEATURE_TAR_TO_COMMAND
  89        char* tar__to_command;
  90        const char* tar__to_command_shell;
  91# endif
  92# if ENABLE_FEATURE_TAR_SELINUX
  93        char* tar__sctx[2];
  94# endif
  95#endif
  96#if ENABLE_CPIO || ENABLE_RPM2CPIO || ENABLE_RPM
  97        uoff_t cpio__blocks;
  98        struct hardlinks_t *cpio__hardlinks_to_create;
  99        struct hardlinks_t *cpio__created_hardlinks;
 100#endif
 101#if ENABLE_DPKG || ENABLE_DPKG_DEB
 102        /* Temporary storage */
 103        char *dpkg__buffer;
 104        /* How to process any sub archive, e.g. get_header_tar_gz */
 105        char FAST_FUNC (*dpkg__action_data_subarchive)(struct archive_handle_t *);
 106        /* Contains the handle to a sub archive */
 107        struct archive_handle_t *dpkg__sub_archive;
 108#endif
 109#if ENABLE_FEATURE_AR_CREATE
 110        const char *ar__name;
 111        struct archive_handle_t *ar__out;
 112#endif
 113} archive_handle_t;
 114/* bits in ah_flags */
 115#define ARCHIVE_RESTORE_DATE        (1 << 0)
 116#define ARCHIVE_CREATE_LEADING_DIRS (1 << 1)
 117#define ARCHIVE_UNLINK_OLD          (1 << 2)
 118#define ARCHIVE_EXTRACT_QUIET       (1 << 3)
 119#define ARCHIVE_EXTRACT_NEWER       (1 << 4)
 120#define ARCHIVE_DONT_RESTORE_OWNER  (1 << 5)
 121#define ARCHIVE_DONT_RESTORE_PERM   (1 << 6)
 122#define ARCHIVE_NUMERIC_OWNER       (1 << 7)
 123#define ARCHIVE_O_TRUNC             (1 << 8)
 124#define ARCHIVE_REMEMBER_NAMES      (1 << 9)
 125#if ENABLE_RPM
 126#define ARCHIVE_REPLACE_VIA_RENAME  (1 << 10)
 127#endif
 128
 129
 130/* POSIX tar Header Block, from POSIX 1003.1-1990  */
 131#define TAR_BLOCK_SIZE 512
 132#define NAME_SIZE      100
 133#define NAME_SIZE_STR "100"
 134typedef struct tar_header_t {     /* byte offset */
 135        char name[NAME_SIZE];     /*   0-99 */
 136        char mode[8];             /* 100-107 */
 137        char uid[8];              /* 108-115 */
 138        char gid[8];              /* 116-123 */
 139        char size[12];            /* 124-135 */
 140        char mtime[12];           /* 136-147 */
 141        char chksum[8];           /* 148-155 */
 142        char typeflag;            /* 156-156 */
 143        char linkname[NAME_SIZE]; /* 157-256 */
 144        /* POSIX:   "ustar" NUL "00" */
 145        /* GNU tar: "ustar  " NUL */
 146        /* Normally it's defined as magic[6] followed by
 147         * version[2], but we put them together to save code.
 148         */
 149        char magic[8];            /* 257-264 */
 150        char uname[32];           /* 265-296 */
 151        char gname[32];           /* 297-328 */
 152        char devmajor[8];         /* 329-336 */
 153        char devminor[8];         /* 337-344 */
 154        char prefix[155];         /* 345-499 */
 155        char padding[12];         /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */
 156} tar_header_t;
 157struct BUG_tar_header {
 158        char c[sizeof(tar_header_t) == TAR_BLOCK_SIZE ? 1 : -1];
 159};
 160
 161
 162
 163archive_handle_t *init_handle(void) FAST_FUNC;
 164
 165char filter_accept_all(archive_handle_t *archive_handle) FAST_FUNC;
 166char filter_accept_list(archive_handle_t *archive_handle) FAST_FUNC;
 167char filter_accept_list_reassign(archive_handle_t *archive_handle) FAST_FUNC;
 168char filter_accept_reject_list(archive_handle_t *archive_handle) FAST_FUNC;
 169
 170void unpack_ar_archive(archive_handle_t *ar_archive) FAST_FUNC;
 171
 172void data_skip(archive_handle_t *archive_handle) FAST_FUNC;
 173void data_extract_all(archive_handle_t *archive_handle) FAST_FUNC;
 174void data_extract_to_stdout(archive_handle_t *archive_handle) FAST_FUNC;
 175void data_extract_to_command(archive_handle_t *archive_handle) FAST_FUNC;
 176
 177void header_skip(const file_header_t *file_header) FAST_FUNC;
 178void header_list(const file_header_t *file_header) FAST_FUNC;
 179void header_verbose_list(const file_header_t *file_header) FAST_FUNC;
 180
 181char get_header_ar(archive_handle_t *archive_handle) FAST_FUNC;
 182char get_header_cpio(archive_handle_t *archive_handle) FAST_FUNC;
 183char get_header_tar(archive_handle_t *archive_handle) FAST_FUNC;
 184char get_header_tar_gz(archive_handle_t *archive_handle) FAST_FUNC;
 185char get_header_tar_bz2(archive_handle_t *archive_handle) FAST_FUNC;
 186char get_header_tar_lzma(archive_handle_t *archive_handle) FAST_FUNC;
 187
 188void seek_by_jump(int fd, off_t amount) FAST_FUNC;
 189void seek_by_read(int fd, off_t amount) FAST_FUNC;
 190
 191const char *strip_unsafe_prefix(const char *str) FAST_FUNC;
 192
 193void data_align(archive_handle_t *archive_handle, unsigned boundary) FAST_FUNC;
 194const llist_t *find_list_entry(const llist_t *list, const char *filename) FAST_FUNC;
 195const llist_t *find_list_entry2(const llist_t *list, const char *filename) FAST_FUNC;
 196
 197/* A bit of bunzip2 internals are exposed for compressed help support: */
 198typedef struct bunzip_data bunzip_data;
 199int start_bunzip(bunzip_data **bdp, int in_fd, const void *inbuf, int len) FAST_FUNC;
 200/* NB: read_bunzip returns < 0 on error, or the number of *unfilled* bytes
 201 * in outbuf. IOW: on EOF returns len ("all bytes are not filled"), not 0: */
 202int read_bunzip(bunzip_data *bd, char *outbuf, int len) FAST_FUNC;
 203void dealloc_bunzip(bunzip_data *bd) FAST_FUNC;
 204
 205/* Meaning and direction (input/output) of the fields are transformer-specific */
 206typedef struct transformer_state_t {
 207        smallint check_signature; /* most often referenced member */
 208
 209        IF_DESKTOP(long long) int FAST_FUNC (*xformer)(struct transformer_state_t *xstate);
 210        USE_FOR_NOMMU(const char *xformer_prog;)
 211
 212        /* Source */
 213        int      src_fd;
 214        /* Output */
 215        int      dst_fd;
 216        size_t   mem_output_size_max; /* if non-zero, decompress to RAM instead of fd */
 217        size_t   mem_output_size;
 218        char     *mem_output_buf;
 219
 220        off_t    bytes_out;
 221        off_t    bytes_in;  /* used in unzip code only: needs to know packed size */
 222        uint32_t crc32;
 223        time_t   mtime;     /* gunzip code may set this on exit */
 224} transformer_state_t;
 225
 226void init_transformer_state(transformer_state_t *xstate) FAST_FUNC;
 227ssize_t transformer_write(transformer_state_t *xstate, const void *buf, size_t bufsize) FAST_FUNC;
 228ssize_t xtransformer_write(transformer_state_t *xstate, const void *buf, size_t bufsize) FAST_FUNC;
 229int check_signature16(transformer_state_t *xstate, unsigned magic16) FAST_FUNC;
 230
 231IF_DESKTOP(long long) int inflate_unzip(transformer_state_t *xstate) FAST_FUNC;
 232IF_DESKTOP(long long) int unpack_Z_stream(transformer_state_t *xstate) FAST_FUNC;
 233IF_DESKTOP(long long) int unpack_gz_stream(transformer_state_t *xstate) FAST_FUNC;
 234IF_DESKTOP(long long) int unpack_bz2_stream(transformer_state_t *xstate) FAST_FUNC;
 235IF_DESKTOP(long long) int unpack_lzma_stream(transformer_state_t *xstate) FAST_FUNC;
 236IF_DESKTOP(long long) int unpack_xz_stream(transformer_state_t *xstate) FAST_FUNC;
 237
 238char* append_ext(char *filename, const char *expected_ext) FAST_FUNC;
 239int bbunpack(char **argv,
 240                IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(transformer_state_t *xstate),
 241                char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
 242                const char *expected_ext
 243) FAST_FUNC;
 244
 245void check_errors_in_children(int signo);
 246#if BB_MMU
 247void fork_transformer(int fd,
 248        int check_signature,
 249        IF_DESKTOP(long long) int FAST_FUNC (*transformer)(transformer_state_t *xstate)
 250) FAST_FUNC;
 251#define fork_transformer_with_sig(fd, transformer, transform_prog) fork_transformer((fd), 1, (transformer))
 252#define fork_transformer_with_no_sig(fd, transformer)              fork_transformer((fd), 0, (transformer))
 253#else
 254void fork_transformer(int fd, const char *transform_prog) FAST_FUNC;
 255#define fork_transformer_with_sig(fd, transformer, transform_prog) fork_transformer((fd), (transform_prog))
 256/* fork_transformer_with_no_sig() does not exist on NOMMU */
 257#endif
 258
 259
 260POP_SAVED_FUNCTION_VISIBILITY
 261
 262#endif
 263