less: document -S flag and make it independently configurable
[oweals/busybox.git] / archival / libarchive / open_transformer.c
index 743ffee0207e97f0639fc8299cc89f13d1791634..be536a3d7e715f41ef0e1aacd30842092844dc7e 100644 (file)
 #include "libbb.h"
 #include "bb_archive.h"
 
-#define ZIPPED (ENABLE_FEATURE_SEAMLESS_LZMA \
-       || ENABLE_FEATURE_SEAMLESS_BZ2 \
-       || ENABLE_FEATURE_SEAMLESS_GZ \
-       /* || ENABLE_FEATURE_SEAMLESS_Z */ \
-)
+void FAST_FUNC init_transformer_state(transformer_state_t *xstate)
+{
+       memset(xstate, 0, sizeof(*xstate));
+}
 
-#if ZIPPED
-# include "bb_archive.h"
+int FAST_FUNC check_signature16(transformer_state_t *xstate, unsigned magic16)
+{
+       if (xstate->check_signature) {
+               uint16_t magic2;
+               if (full_read(xstate->src_fd, &magic2, 2) != 2 || magic2 != magic16) {
+                       bb_error_msg("invalid magic");
+#if 0 /* possible future extension */
+                       if (xstate->check_signature > 1)
+                               xfunc_die();
 #endif
+                       return -1;
+               }
+       }
+       return 0;
+}
+
+ssize_t FAST_FUNC transformer_write(transformer_state_t *xstate, const void *buf, size_t bufsize)
+{
+       ssize_t nwrote;
+
+       if (xstate->mem_output_size_max != 0) {
+               size_t pos = xstate->mem_output_size;
+               size_t size;
+
+               size = (xstate->mem_output_size += bufsize);
+               if (size > xstate->mem_output_size_max) {
+                       free(xstate->mem_output_buf);
+                       xstate->mem_output_buf = NULL;
+                       bb_perror_msg("buffer %u too small", (unsigned)xstate->mem_output_size_max);
+                       nwrote = -1;
+                       goto ret;
+               }
+               xstate->mem_output_buf = xrealloc(xstate->mem_output_buf, size + 1);
+               memcpy(xstate->mem_output_buf + pos, buf, bufsize);
+               xstate->mem_output_buf[size] = '\0';
+               nwrote = bufsize;
+       } else {
+               nwrote = full_write(xstate->dst_fd, buf, bufsize);
+               if (nwrote != (ssize_t)bufsize) {
+                       bb_perror_msg("write");
+                       nwrote = -1;
+                       goto ret;
+               }
+       }
+ ret:
+       return nwrote;
+}
+
+ssize_t FAST_FUNC xtransformer_write(transformer_state_t *xstate, const void *buf, size_t bufsize)
+{
+       ssize_t nwrote = transformer_write(xstate, buf, bufsize);
+       if (nwrote != (ssize_t)bufsize) {
+               xfunc_die();
+       }
+       return nwrote;
+}
+
+void check_errors_in_children(int signo)
+{
+       int status;
+
+       if (!signo) {
+               /* block waiting for any child */
+               if (wait(&status) < 0)
+//FIXME: check EINTR?
+                       return; /* probably there are no children */
+               goto check_status;
+       }
+
+       /* Wait for any child without blocking */
+       for (;;) {
+               if (wait_any_nohang(&status) < 0)
+//FIXME: check EINTR?
+                       /* wait failed?! I'm confused... */
+                       return;
+ check_status:
+               /*if (WIFEXITED(status) && WEXITSTATUS(status) == 0)*/
+               /* On Linux, the above can be checked simply as: */
+               if (status == 0)
+                       /* this child exited with 0 */
+                       continue;
+               /* Cannot happen:
+               if (!WIFSIGNALED(status) && !WIFEXITED(status)) ???;
+                */
+               bb_got_signal = 1;
+       }
+}
 
 /* transformer(), more than meets the eye */
-/*
- * On MMU machine, the transform_prog is removed by macro magic
- * in include/archive.h. On NOMMU, transformer is removed.
- */
-void FAST_FUNC open_transformer(int fd,
-       IF_DESKTOP(long long) int FAST_FUNC (*transformer)(int src_fd, int dst_fd),
-       const char *transform_prog)
+#if BB_MMU
+void FAST_FUNC fork_transformer(int fd,
+       int check_signature,
+       IF_DESKTOP(long long) int FAST_FUNC (*transformer)(transformer_state_t *xstate)
+)
+#else
+void FAST_FUNC fork_transformer(int fd, const char *transform_prog)
+#endif
 {
        struct fd_pair fd_pipe;
        int pid;
@@ -35,13 +119,21 @@ void FAST_FUNC open_transformer(int fd,
                close(fd_pipe.rd); /* we don't want to read from the parent */
                // FIXME: error check?
 #if BB_MMU
-               transformer(fd, fd_pipe.wr);
-               if (ENABLE_FEATURE_CLEAN_UP) {
-                       close(fd_pipe.wr); /* send EOF */
-                       close(fd);
+               {
+                       IF_DESKTOP(long long) int r;
+                       transformer_state_t xstate;
+                       init_transformer_state(&xstate);
+                       xstate.check_signature = check_signature;
+                       xstate.src_fd = fd;
+                       xstate.dst_fd = fd_pipe.wr;
+                       r = transformer(&xstate);
+                       if (ENABLE_FEATURE_CLEAN_UP) {
+                               close(fd_pipe.wr); /* send EOF */
+                               close(fd);
+                       }
+                       /* must be _exit! bug was actually seen here */
+                       _exit(/*error if:*/ r < 0);
                }
-               /* must be _exit! bug was actually seen here */
-               _exit(EXIT_SUCCESS);
 #else
                {
                        char *argv[4];
@@ -64,26 +156,24 @@ void FAST_FUNC open_transformer(int fd,
 }
 
 
+#if SEAMLESS_COMPRESSION
+
 /* Used by e.g. rpm which gives us a fd without filename,
  * thus we can't guess the format from filename's extension.
  */
-#if ZIPPED
-void FAST_FUNC setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/)
+static transformer_state_t *setup_transformer_on_fd(int fd, int fail_if_not_compressed)
 {
-       const int fail_if_not_detected = 1;
        union {
                uint8_t b[4];
                uint16_t b16[2];
                uint32_t b32[1];
        } magic;
-       int offset = -2;
-# if BB_MMU
-       IF_DESKTOP(long long) int FAST_FUNC (*xformer)(int src_fd, int dst_fd);
-       enum { xformer_prog = 0 };
-# else
-       enum { xformer = 0 };
-       const char *xformer_prog;
-# endif
+       int offset;
+       transformer_state_t *xstate;
+
+       offset = -2;
+       xstate = xzalloc(sizeof(*xstate));
+       xstate->src_fd = fd;
 
        /* .gz and .bz2 both have 2-byte signature, and their
         * unpack_XXX_stream wants this header skipped. */
@@ -91,21 +181,22 @@ void FAST_FUNC setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/)
        if (ENABLE_FEATURE_SEAMLESS_GZ
         && magic.b16[0] == GZIP_MAGIC
        ) {
-# if BB_MMU
-               xformer = unpack_gz_stream;
-# else
-               xformer_prog = "gunzip";
-# endif
+               xstate->xformer = unpack_gz_stream;
+               USE_FOR_NOMMU(xstate->xformer_prog = "gunzip";)
+               goto found_magic;
+       }
+       if (ENABLE_FEATURE_SEAMLESS_Z
+        && magic.b16[0] == COMPRESS_MAGIC
+       ) {
+               xstate->xformer = unpack_Z_stream;
+               USE_FOR_NOMMU(xstate->xformer_prog = "uncompress";)
                goto found_magic;
        }
        if (ENABLE_FEATURE_SEAMLESS_BZ2
         && magic.b16[0] == BZIP2_MAGIC
        ) {
-# if BB_MMU
-               xformer = unpack_bz2_stream;
-# else
-               xformer_prog = "bunzip2";
-# endif
+               xstate->xformer = unpack_bz2_stream;
+               USE_FOR_NOMMU(xstate->xformer_prog = "bunzip2";)
                goto found_magic;
        }
        if (ENABLE_FEATURE_SEAMLESS_XZ
@@ -114,74 +205,146 @@ void FAST_FUNC setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/)
                offset = -6;
                xread(fd, magic.b32, sizeof(magic.b32[0]));
                if (magic.b32[0] == XZ_MAGIC2) {
-# if BB_MMU
-                       xformer = unpack_xz_stream;
-                       /* unpack_xz_stream wants fd at position 6, no need to seek */
-                       //xlseek(fd, offset, SEEK_CUR);
-# else
-                       xformer_prog = "unxz";
-# endif
+                       xstate->xformer = unpack_xz_stream;
+                       USE_FOR_NOMMU(xstate->xformer_prog = "unxz";)
                        goto found_magic;
                }
        }
 
        /* No known magic seen */
-       if (fail_if_not_detected)
+       if (fail_if_not_compressed)
                bb_error_msg_and_die("no gzip"
                        IF_FEATURE_SEAMLESS_BZ2("/bzip2")
                        IF_FEATURE_SEAMLESS_XZ("/xz")
                        " magic");
-       xlseek(fd, offset, SEEK_CUR);
-       return;
 
- found_magic:
-# if !BB_MMU
-       /* NOMMU version of open_transformer execs
+       /* Some callers expect this function to "consume" fd
+        * even if data is not compressed. In this case,
+        * we return a state with trivial transformer.
+        */
+//     USE_FOR_MMU(xstate->xformer = copy_stream;)
+//     USE_FOR_NOMMU(xstate->xformer_prog = "cat";)
+       /* fall through to seeking bck over bytes we read earlier */
+
+ USE_FOR_NOMMU(found_magic:)
+       /* NOMMU version of fork_transformer execs
         * an external unzipper that wants
-        * file position at the start of the file */
+        * file position at the start of the file.
+        */
        xlseek(fd, offset, SEEK_CUR);
+
+ USE_FOR_MMU(found_magic:)
+       /* In MMU case, if magic was found, seeking back is not necessary */
+
+       return xstate;
+}
+
+/* Used by e.g. rpm which gives us a fd without filename,
+ * thus we can't guess the format from filename's extension.
+ */
+int FAST_FUNC setup_unzip_on_fd(int fd, int fail_if_not_compressed)
+{
+       transformer_state_t *xstate = setup_transformer_on_fd(fd, fail_if_not_compressed);
+
+       if (!xstate || !xstate->xformer) {
+               free(xstate);
+               return 1;
+       }
+
+# if BB_MMU
+       fork_transformer_with_no_sig(xstate->src_fd, xstate->xformer);
+# else
+       fork_transformer_with_sig(xstate->src_fd, xstate->xformer, xstate->xformer_prog);
 # endif
-       open_transformer(fd, xformer, xformer_prog);
+       free(xstate);
+       return 0;
 }
-#endif /* ZIPPED */
 
-int FAST_FUNC open_zipped(const char *fname)
+static transformer_state_t *open_transformer(const char *fname, int fail_if_not_compressed)
 {
-#if !ZIPPED
-       return open(fname, O_RDONLY);
-#else
-       char *sfx;
+       transformer_state_t *xstate;
        int fd;
 
        fd = open(fname, O_RDONLY);
        if (fd < 0)
-               return fd;
-
-       sfx = strrchr(fname, '.');
-       if (sfx) {
-               sfx++;
-               if (ENABLE_FEATURE_SEAMLESS_LZMA && strcmp(sfx, "lzma") == 0)
-                       /* .lzma has no header/signature, just trust it */
-                       open_transformer(fd, unpack_lzma_stream, "unlzma");
-               else
-               if ((ENABLE_FEATURE_SEAMLESS_GZ && strcmp(sfx, "gz") == 0)
-                || (ENABLE_FEATURE_SEAMLESS_BZ2 && strcmp(sfx, "bz2") == 0)
-                || (ENABLE_FEATURE_SEAMLESS_XZ && strcmp(sfx, "xz") == 0)
-               ) {
-                       setup_unzip_on_fd(fd /*, fail_if_not_detected: 1*/);
+               return NULL;
+
+       if (ENABLE_FEATURE_SEAMLESS_LZMA) {
+               /* .lzma has no header/signature, can only detect it by extension */
+               char *sfx = strrchr(fname, '.');
+               if (sfx && strcmp(sfx+1, "lzma") == 0) {
+                       xstate = xzalloc(sizeof(*xstate));
+                       xstate->src_fd = fd;
+                       xstate->xformer = unpack_lzma_stream;
+                       USE_FOR_NOMMU(xstate->xformer_prog = "unlzma";)
+                       return xstate;
                }
        }
 
+       xstate = setup_transformer_on_fd(fd, fail_if_not_compressed);
+
+       return xstate;
+}
+
+int FAST_FUNC open_zipped(const char *fname, int fail_if_not_compressed)
+{
+       int fd;
+       transformer_state_t *xstate;
+
+       xstate = open_transformer(fname, fail_if_not_compressed);
+       if (!xstate)
+               return -1;
+
+       fd = xstate->src_fd;
+       if (xstate->xformer) {
+# if BB_MMU
+               fork_transformer_with_no_sig(xstate->src_fd, xstate->xformer);
+# else
+               fork_transformer_with_sig(xstate->src_fd, xstate->xformer, xstate->xformer_prog);
+# endif
+       }
+       /* else: the file is not compressed */
+
+       free(xstate);
        return fd;
-#endif
 }
 
 void* FAST_FUNC xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p)
 {
+# if 1
+       transformer_state_t *xstate;
+       char *image;
+
+       xstate = open_transformer(fname, /*fail_if_not_compressed:*/ 0);
+       if (!xstate) /* file open error */
+               return NULL;
+
+       image = NULL;
+       if (xstate->xformer) {
+               /* In-memory decompression */
+               xstate->mem_output_size_max = maxsz_p ? *maxsz_p : (size_t)(INT_MAX - 4095);
+               xstate->xformer(xstate);
+               if (xstate->mem_output_buf) {
+                       image = xstate->mem_output_buf;
+                       if (maxsz_p)
+                               *maxsz_p = xstate->mem_output_size;
+               }
+       } else {
+               /* File is not compressed */
+               image = xmalloc_read(xstate->src_fd, maxsz_p);
+       }
+
+       if (!image)
+               bb_perror_msg("read error from '%s'", fname);
+       close(xstate->src_fd);
+       free(xstate);
+       return image;
+# else
+       /* This version forks a subprocess - much more expensive */
        int fd;
        char *image;
 
-       fd = open_zipped(fname);
+       fd = open_zipped(fname, /*fail_if_not_compressed:*/ 0);
        if (fd < 0)
                return NULL;
 
@@ -189,6 +352,8 @@ void* FAST_FUNC xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_
        if (!image)
                bb_perror_msg("read error from '%s'", fname);
        close(fd);
-
        return image;
+# endif
 }
+
+#endif /* SEAMLESS_COMPRESSION */