3
0

bb_archive.h 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
  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. /* Process the header component, e.g. tar -t */
  59. void FAST_FUNC (*action_header)(const file_header_t *);
  60. /* Process the data component, e.g. extract to filesystem */
  61. void FAST_FUNC (*action_data)(struct archive_handle_t *);
  62. /* Function that skips data */
  63. void FAST_FUNC (*seek)(int fd, off_t amount);
  64. /* Count processed bytes */
  65. off_t offset;
  66. /* Archiver specific. Can make it a union if it ever gets big */
  67. #define PAX_NEXT_FILE 0
  68. #define PAX_GLOBAL 1
  69. #if ENABLE_TAR || ENABLE_DPKG || ENABLE_DPKG_DEB
  70. smallint tar__end;
  71. # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
  72. char* tar__longname;
  73. char* tar__linkname;
  74. # endif
  75. # if ENABLE_FEATURE_TAR_TO_COMMAND
  76. char* tar__to_command;
  77. const char* tar__to_command_shell;
  78. # endif
  79. # if ENABLE_FEATURE_TAR_SELINUX
  80. char* tar__sctx[2];
  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. #define ARCHIVE_REMEMBER_NAMES (1 << 9)
  112. /* POSIX tar Header Block, from POSIX 1003.1-1990 */
  113. #define TAR_BLOCK_SIZE 512
  114. #define NAME_SIZE 100
  115. #define NAME_SIZE_STR "100"
  116. typedef struct tar_header_t { /* byte offset */
  117. char name[NAME_SIZE]; /* 0-99 */
  118. char mode[8]; /* 100-107 */
  119. char uid[8]; /* 108-115 */
  120. char gid[8]; /* 116-123 */
  121. char size[12]; /* 124-135 */
  122. char mtime[12]; /* 136-147 */
  123. char chksum[8]; /* 148-155 */
  124. char typeflag; /* 156-156 */
  125. char linkname[NAME_SIZE]; /* 157-256 */
  126. /* POSIX: "ustar" NUL "00" */
  127. /* GNU tar: "ustar " NUL */
  128. /* Normally it's defined as magic[6] followed by
  129. * version[2], but we put them together to save code.
  130. */
  131. char magic[8]; /* 257-264 */
  132. char uname[32]; /* 265-296 */
  133. char gname[32]; /* 297-328 */
  134. char devmajor[8]; /* 329-336 */
  135. char devminor[8]; /* 337-344 */
  136. char prefix[155]; /* 345-499 */
  137. char padding[12]; /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */
  138. } tar_header_t;
  139. struct BUG_tar_header {
  140. char c[sizeof(tar_header_t) == TAR_BLOCK_SIZE ? 1 : -1];
  141. };
  142. archive_handle_t *init_handle(void) FAST_FUNC;
  143. char filter_accept_all(archive_handle_t *archive_handle) FAST_FUNC;
  144. char filter_accept_list(archive_handle_t *archive_handle) FAST_FUNC;
  145. char filter_accept_list_reassign(archive_handle_t *archive_handle) FAST_FUNC;
  146. char filter_accept_reject_list(archive_handle_t *archive_handle) FAST_FUNC;
  147. void unpack_ar_archive(archive_handle_t *ar_archive) FAST_FUNC;
  148. void data_skip(archive_handle_t *archive_handle) FAST_FUNC;
  149. void data_extract_all(archive_handle_t *archive_handle) FAST_FUNC;
  150. void data_extract_to_stdout(archive_handle_t *archive_handle) FAST_FUNC;
  151. void data_extract_to_command(archive_handle_t *archive_handle) FAST_FUNC;
  152. void header_skip(const file_header_t *file_header) FAST_FUNC;
  153. void header_list(const file_header_t *file_header) FAST_FUNC;
  154. void header_verbose_list(const file_header_t *file_header) FAST_FUNC;
  155. char get_header_ar(archive_handle_t *archive_handle) FAST_FUNC;
  156. char get_header_cpio(archive_handle_t *archive_handle) FAST_FUNC;
  157. char get_header_tar(archive_handle_t *archive_handle) FAST_FUNC;
  158. char get_header_tar_gz(archive_handle_t *archive_handle) FAST_FUNC;
  159. char get_header_tar_bz2(archive_handle_t *archive_handle) FAST_FUNC;
  160. char get_header_tar_lzma(archive_handle_t *archive_handle) FAST_FUNC;
  161. void seek_by_jump(int fd, off_t amount) FAST_FUNC;
  162. void seek_by_read(int fd, off_t amount) FAST_FUNC;
  163. const char *strip_unsafe_prefix(const char *str) FAST_FUNC;
  164. void data_align(archive_handle_t *archive_handle, unsigned boundary) FAST_FUNC;
  165. const llist_t *find_list_entry(const llist_t *list, const char *filename) FAST_FUNC;
  166. const llist_t *find_list_entry2(const llist_t *list, const char *filename) FAST_FUNC;
  167. /* A bit of bunzip2 internals are exposed for compressed help support: */
  168. typedef struct bunzip_data bunzip_data;
  169. int start_bunzip(bunzip_data **bdp, int in_fd, const void *inbuf, int len) FAST_FUNC;
  170. /* NB: read_bunzip returns < 0 on error, or the number of *unfilled* bytes
  171. * in outbuf. IOW: on EOF returns len ("all bytes are not filled"), not 0: */
  172. int read_bunzip(bunzip_data *bd, char *outbuf, int len) FAST_FUNC;
  173. void dealloc_bunzip(bunzip_data *bd) FAST_FUNC;
  174. /* Meaning and direction (input/output) of the fields are transformer-specific */
  175. typedef struct transformer_aux_data_t {
  176. smallint check_signature; /* most often referenced member */
  177. off_t bytes_out;
  178. off_t bytes_in; /* used in unzip code only: needs to know packed size */
  179. uint32_t crc32;
  180. time_t mtime; /* gunzip code may set this on exit */
  181. } transformer_aux_data_t;
  182. void init_transformer_aux_data(transformer_aux_data_t *aux) FAST_FUNC;
  183. int FAST_FUNC check_signature16(transformer_aux_data_t *aux, int src_fd, unsigned magic16) FAST_FUNC;
  184. IF_DESKTOP(long long) int inflate_unzip(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
  185. IF_DESKTOP(long long) int unpack_Z_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
  186. IF_DESKTOP(long long) int unpack_gz_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
  187. IF_DESKTOP(long long) int unpack_bz2_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
  188. IF_DESKTOP(long long) int unpack_lzma_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
  189. IF_DESKTOP(long long) int unpack_xz_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
  190. char* append_ext(char *filename, const char *expected_ext) FAST_FUNC;
  191. int bbunpack(char **argv,
  192. IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(transformer_aux_data_t *aux),
  193. char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
  194. const char *expected_ext
  195. ) FAST_FUNC;
  196. void check_errors_in_children(int signo);
  197. #if BB_MMU
  198. void open_transformer(int fd,
  199. int check_signature,
  200. IF_DESKTOP(long long) int FAST_FUNC (*transformer)(transformer_aux_data_t *aux, int src_fd, int dst_fd)
  201. ) FAST_FUNC;
  202. #define open_transformer_with_sig(fd, transformer, transform_prog) open_transformer((fd), 1, (transformer))
  203. #define open_transformer_with_no_sig(fd, transformer) open_transformer((fd), 0, (transformer))
  204. #else
  205. void open_transformer(int fd, const char *transform_prog) FAST_FUNC;
  206. #define open_transformer_with_sig(fd, transformer, transform_prog) open_transformer((fd), (transform_prog))
  207. /* open_transformer_with_no_sig() does not exist on NOMMU */
  208. #endif
  209. POP_SAVED_FUNCTION_VISIBILITY
  210. #endif