bb_archive.h 10 KB

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