* along with wimlib; if not, see http://www.gnu.org/licenses/.
*/
-#include "config.h"
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
#if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
-/* On BSD, this should be included before "list.h" so that "list.h" can
+/* On BSD, this should be included before "wimlib/list.h" so that "wimlib/list.h" can
* overwrite the LIST_HEAD macro. */
# include <sys/file.h>
#endif
+#include "wimlib/endianness.h"
+#include "wimlib/error.h"
+#include "wimlib/file_io.h"
+#include "wimlib/header.h"
+#include "wimlib/integrity.h"
+#include "wimlib/lookup_table.h"
+#include "wimlib/metadata.h"
+#include "wimlib/resource.h"
+#include "wimlib/write.h"
+#include "wimlib/xml.h"
+
#ifdef __WIN32__
-# include "win32.h"
+# include "wimlib/win32.h" /* win32_get_number_of_processors() */
#endif
-#include "list.h"
-#include "wimlib_internal.h"
-#include "buffer_io.h"
-#include "dentry.h"
-#include "lookup_table.h"
-#include "xml.h"
-
#ifdef ENABLE_MULTITHREADED_COMPRESSION
# include <pthread.h>
#endif
-#include <unistd.h>
#include <errno.h>
-
-#ifdef WITH_NTFS_3G
-# include <time.h>
-# include <ntfs-3g/attrib.h>
-# include <ntfs-3g/inode.h>
-# include <ntfs-3g/dir.h>
-#endif
+#include <fcntl.h>
+#include <limits.h>
+#include <stdlib.h>
+#include <unistd.h>
#ifdef HAVE_ALLOCA_H
# include <alloca.h>
-#else
-# include <stdlib.h>
#endif
-#include <limits.h>
-#if defined(__WIN32__) && !defined(INVALID_HANDLE_VALUE)
-# define INVALID_HANDLE_VALUE ((HANDLE)(-1))
+#ifndef __WIN32__
+# include <sys/uio.h> /* for `struct iovec' */
#endif
-static int
-fflush_and_ftruncate(FILE *fp, off_t size)
+/* Return true if the specified resource is compressed and the compressed data
+ * can be reused with the specified output parameters. */
+static bool
+can_raw_copy(const struct wim_lookup_table_entry *lte,
+ int write_resource_flags, int out_ctype, u32 out_chunk_size)
{
- int ret;
+ return (out_ctype == wim_resource_compression_type(lte)
+ && out_chunk_size == wim_resource_chunk_size(lte)
+ && out_ctype != WIMLIB_COMPRESSION_TYPE_NONE);
+}
- ret = fflush(fp);
- if (ret != 0) {
- ERROR_WITH_ERRNO("Failed to flush data to output WIM file");
- return WIMLIB_ERR_WRITE;
- }
- ret = ftruncate(fileno(fp), size);
- if (ret != 0) {
- ERROR_WITH_ERRNO("Failed to truncate output WIM file to "
- "%"PRIu64" bytes", size);
- return WIMLIB_ERR_WRITE;
+
+/* Return true if the specified resource must be recompressed when the specified
+ * output parameters are used. */
+static bool
+must_compress_stream(const struct wim_lookup_table_entry *lte,
+ int write_resource_flags, int out_ctype, u32 out_chunk_size)
+{
+ return (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE
+ && ((write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS)
+ || !can_raw_copy(lte, write_resource_flags,
+ out_ctype, out_chunk_size)));
+}
+
+static unsigned
+compress_chunk(const void * uncompressed_data,
+ unsigned uncompressed_len,
+ void *compressed_data,
+ int out_ctype,
+ struct wimlib_lzx_context *comp_ctx)
+{
+ switch (out_ctype) {
+ case WIMLIB_COMPRESSION_TYPE_XPRESS:
+ return wimlib_xpress_compress(uncompressed_data,
+ uncompressed_len,
+ compressed_data);
+ case WIMLIB_COMPRESSION_TYPE_LZX:
+ return wimlib_lzx_compress2(uncompressed_data,
+ uncompressed_len,
+ compressed_data,
+ comp_ctx);
+ default:
+ wimlib_assert(0);
+ return 0;
}
- return 0;
}
/* Chunk table that's located at the beginning of each compressed resource in
* the WIM. (This is not the on-disk format; the on-disk format just has an
* array of offsets.) */
struct chunk_table {
- off_t file_offset;
- u64 num_chunks;
u64 original_resource_size;
- u64 bytes_per_chunk_entry;
+ u64 num_chunks;
u64 table_disk_size;
- u64 cur_offset;
- u64 *cur_offset_p;
- u64 offsets[0];
+ unsigned bytes_per_chunk_entry;
+ void *cur_offset_p;
+ union {
+ u32 cur_offset_u32;
+ u64 cur_offset_u64;
+ };
+ /* Beginning of chunk offsets, in either 32-bit or 64-bit little endian
+ * integers, including the first offset of 0, which will not be written.
+ * */
+ u8 offsets[] _aligned_attribute(8);
};
-/*
- * Allocates and initializes a chunk table, and reserves space for it in the
- * output file.
- */
+/* Allocate and initializes a chunk table, then reserve space for it in the
+ * output file unless writing a pipable resource. */
static int
begin_wim_resource_chunk_tab(const struct wim_lookup_table_entry *lte,
- FILE *out_fp,
- off_t file_offset,
- struct chunk_table **chunk_tab_ret)
-{
- u64 size = wim_resource_size(lte);
- u64 num_chunks = (size + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
- size_t alloc_size = sizeof(struct chunk_table) + num_chunks * sizeof(u64);
- struct chunk_table *chunk_tab = CALLOC(1, alloc_size);
+ struct filedes *out_fd,
+ u32 out_chunk_size,
+ struct chunk_table **chunk_tab_ret,
+ int resource_flags)
+{
+ u64 size;
+ u64 num_chunks;
+ unsigned bytes_per_chunk_entry;
+ size_t alloc_size;
+ struct chunk_table *chunk_tab;
int ret;
+ size = wim_resource_size(lte);
+ num_chunks = DIV_ROUND_UP(size, out_chunk_size);
+ bytes_per_chunk_entry = (size > (1ULL << 32)) ? 8 : 4;
+ alloc_size = sizeof(struct chunk_table) + num_chunks * sizeof(u64);
+ chunk_tab = CALLOC(1, alloc_size);
+
if (!chunk_tab) {
ERROR("Failed to allocate chunk table for %"PRIu64" byte "
"resource", size);
- ret = WIMLIB_ERR_NOMEM;
- goto out;
+ return WIMLIB_ERR_NOMEM;
}
- chunk_tab->file_offset = file_offset;
chunk_tab->num_chunks = num_chunks;
chunk_tab->original_resource_size = size;
- chunk_tab->bytes_per_chunk_entry = (size >= (1ULL << 32)) ? 8 : 4;
+ chunk_tab->bytes_per_chunk_entry = bytes_per_chunk_entry;
chunk_tab->table_disk_size = chunk_tab->bytes_per_chunk_entry *
(num_chunks - 1);
- chunk_tab->cur_offset = 0;
chunk_tab->cur_offset_p = chunk_tab->offsets;
- if (fwrite(chunk_tab, 1, chunk_tab->table_disk_size, out_fp) !=
- chunk_tab->table_disk_size) {
- ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
- "file resource");
- ret = WIMLIB_ERR_WRITE;
- goto out;
+ /* We don't know the correct offsets yet; so just write zeroes to
+ * reserve space for the table, so we can go back to it later after
+ * we've written the compressed chunks following it.
+ *
+ * Special case: if writing a pipable WIM, compressed resources are in a
+ * modified format (see comment above write_pipable_wim()) and do not
+ * have a chunk table at the beginning, so don't reserve any space for
+ * one. */
+ if (!(resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE)) {
+ ret = full_write(out_fd, chunk_tab->offsets,
+ chunk_tab->table_disk_size);
+ if (ret) {
+ ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
+ "file resource");
+ FREE(chunk_tab);
+ return ret;
+ }
}
-
- ret = 0;
-out:
*chunk_tab_ret = chunk_tab;
- return ret;
+ return 0;
}
-/*
- * compress_func_t- Pointer to a function to compresses a chunk
- * of a WIM resource. This may be either
- * wimlib_xpress_compress() (xpress-compress.c) or
- * wimlib_lzx_compress() (lzx-compress.c).
- *
- * @chunk: Uncompressed data of the chunk.
- * @chunk_size: Size of the uncompressed chunk, in bytes.
- * @out: Pointer to output buffer of size at least (@chunk_size - 1) bytes.
- *
- * Returns the size of the compressed data written to @out in bytes, or 0 if the
- * data could not be compressed to (@chunk_size - 1) bytes or fewer.
- *
- * As a special requirement, the compression code is optimized for the WIM
- * format and therefore requires (@chunk_size <= 32768).
- *
- * As another special requirement, the compression code will read up to 8 bytes
- * off the end of the @chunk array for performance reasons. The values of these
- * bytes will not affect the output of the compression, but the calling code
- * must make sure that the buffer holding the uncompressed chunk is actually at
- * least (@chunk_size + 8) bytes, or at least that these extra bytes are in
- * mapped memory that will not cause a memory access violation if accessed.
- */
-typedef unsigned (*compress_func_t)(const void *chunk, unsigned chunk_size,
- void *out);
-
-compress_func_t
-get_compress_func(int out_ctype)
+/* Add the offset for the next chunk to the chunk table being constructed for a
+ * compressed stream. */
+static void
+chunk_tab_record_chunk(struct chunk_table *chunk_tab, unsigned out_chunk_size)
{
- if (out_ctype == WIMLIB_COMPRESSION_TYPE_LZX)
- return wimlib_lzx_compress;
- else
- return wimlib_xpress_compress;
+ if (chunk_tab->bytes_per_chunk_entry == 4) {
+ *(le32*)chunk_tab->cur_offset_p = cpu_to_le32(chunk_tab->cur_offset_u32);
+ chunk_tab->cur_offset_p = (le32*)chunk_tab->cur_offset_p + 1;
+ chunk_tab->cur_offset_u32 += out_chunk_size;
+ } else {
+ *(le64*)chunk_tab->cur_offset_p = cpu_to_le64(chunk_tab->cur_offset_u64);
+ chunk_tab->cur_offset_p = (le64*)chunk_tab->cur_offset_p + 1;
+ chunk_tab->cur_offset_u64 += out_chunk_size;
+ }
}
-/*
- * Writes a chunk of a WIM resource to an output file.
- *
- * @chunk: Uncompressed data of the chunk.
- * @chunk_size: Size of the chunk (<= WIM_CHUNK_SIZE)
- * @out_fp: FILE * to write the chunk to.
- * @compress: Compression function to use (NULL if writing uncompressed
- * data).
- * @chunk_tab: Pointer to chunk table being created. It is updated with the
- * offset of the chunk we write.
- *
- * Returns 0 on success; nonzero on failure.
- */
+/* Finishes a WIM chunk table and writes it to the output file at the correct
+ * offset. */
static int
-write_wim_resource_chunk(const void *chunk, unsigned chunk_size,
- FILE *out_fp, compress_func_t compress,
- struct chunk_table *chunk_tab)
+finish_wim_resource_chunk_tab(struct chunk_table *chunk_tab,
+ struct filedes *out_fd,
+ off_t res_start_offset,
+ int write_resource_flags)
{
- const u8 *out_chunk;
- unsigned out_chunk_size;
- if (compress) {
- u8 *compressed_chunk = alloca(chunk_size);
+ int ret;
- out_chunk_size = compress(chunk, chunk_size, compressed_chunk);
- if (out_chunk_size) {
- /* Write compressed */
- out_chunk = compressed_chunk;
- } else {
- /* Write uncompressed */
- out_chunk = chunk;
- out_chunk_size = chunk_size;
- }
- *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset;
- chunk_tab->cur_offset += out_chunk_size;
+ if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
+ ret = full_write(out_fd,
+ chunk_tab->offsets +
+ chunk_tab->bytes_per_chunk_entry,
+ chunk_tab->table_disk_size);
} else {
- /* Write uncompressed */
- out_chunk = chunk;
- out_chunk_size = chunk_size;
- }
- if (fwrite(out_chunk, 1, out_chunk_size, out_fp) != out_chunk_size) {
- ERROR_WITH_ERRNO("Failed to write WIM resource chunk");
- return WIMLIB_ERR_WRITE;
+ ret = full_pwrite(out_fd,
+ chunk_tab->offsets +
+ chunk_tab->bytes_per_chunk_entry,
+ chunk_tab->table_disk_size,
+ res_start_offset);
}
- return 0;
+ if (ret)
+ ERROR_WITH_ERRNO("Write error");
+ return ret;
}
-/*
- * Finishes a WIM chunk table and writes it to the output file at the correct
- * offset.
- *
- * The final size of the full compressed resource is returned in the
- * @compressed_size_p.
+/* Write the header for a stream in a pipable WIM.
*/
static int
-finish_wim_resource_chunk_tab(struct chunk_table *chunk_tab,
- FILE *out_fp, u64 *compressed_size_p)
+write_pwm_stream_header(const struct wim_lookup_table_entry *lte,
+ struct filedes *out_fd,
+ int additional_reshdr_flags)
{
- size_t bytes_written;
- if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) {
- ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" of output "
- "WIM file", chunk_tab->file_offset);
- return WIMLIB_ERR_WRITE;
- }
+ struct pwm_stream_hdr stream_hdr;
+ u32 reshdr_flags;
+ int ret;
- if (chunk_tab->bytes_per_chunk_entry == 8) {
- array_cpu_to_le64(chunk_tab->offsets, chunk_tab->num_chunks);
+ stream_hdr.magic = PWM_STREAM_MAGIC;
+ stream_hdr.uncompressed_size = cpu_to_le64(lte->resource_entry.original_size);
+ if (additional_reshdr_flags & PWM_RESHDR_FLAG_UNHASHED) {
+ zero_out_hash(stream_hdr.hash);
} else {
- for (u64 i = 0; i < chunk_tab->num_chunks; i++)
- ((u32*)chunk_tab->offsets)[i] =
- cpu_to_le32(chunk_tab->offsets[i]);
- }
- bytes_written = fwrite((u8*)chunk_tab->offsets +
- chunk_tab->bytes_per_chunk_entry,
- 1, chunk_tab->table_disk_size, out_fp);
- if (bytes_written != chunk_tab->table_disk_size) {
- ERROR_WITH_ERRNO("Failed to write chunk table in compressed "
- "file resource");
- return WIMLIB_ERR_WRITE;
+ wimlib_assert(!lte->unhashed);
+ copy_hash(stream_hdr.hash, lte->hash);
}
- if (fseeko(out_fp, 0, SEEK_END) != 0) {
- ERROR_WITH_ERRNO("Failed to seek to end of output WIM file");
+
+ reshdr_flags = lte->resource_entry.flags & ~WIM_RESHDR_FLAG_COMPRESSED;
+ reshdr_flags |= additional_reshdr_flags;
+ stream_hdr.flags = cpu_to_le32(reshdr_flags);
+ ret = full_write(out_fd, &stream_hdr, sizeof(stream_hdr));
+ if (ret)
+ ERROR_WITH_ERRNO("Error writing stream header");
+ return ret;
+}
+
+static int
+seek_and_truncate(struct filedes *out_fd, off_t offset)
+{
+ if (filedes_seek(out_fd, offset) == -1 ||
+ ftruncate(out_fd->fd, offset))
+ {
+ ERROR_WITH_ERRNO("Failed to truncate output WIM file");
return WIMLIB_ERR_WRITE;
}
- *compressed_size_p = chunk_tab->cur_offset + chunk_tab->table_disk_size;
return 0;
}
static int
-write_uncompressed_resource_and_truncate(struct wim_lookup_table_entry *lte,
- FILE *out_fp,
- off_t file_offset,
- struct resource_entry *out_res_entry)
+finalize_and_check_sha1(SHA_CTX *sha_ctx, struct wim_lookup_table_entry *lte)
{
- int ret;
- if (fseeko(out_fp, file_offset, SEEK_SET) != 0) {
- ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" of "
- "output WIM file", file_offset);
- return WIMLIB_ERR_WRITE;
+ u8 md[SHA1_HASH_SIZE];
+
+ sha1_final(md, sha_ctx);
+ if (lte->unhashed) {
+ copy_hash(lte->hash, md);
+ } else if (!hashes_equal(md, lte->hash)) {
+ ERROR("WIM resource has incorrect hash!");
+ if (lte_filename_valid(lte)) {
+ ERROR("We were reading it from \"%"TS"\"; maybe "
+ "it changed while we were reading it.",
+ lte->file_on_disk);
+ }
+ return WIMLIB_ERR_INVALID_RESOURCE_HASH;
}
- ret = write_wim_resource(lte, out_fp,
- WIMLIB_COMPRESSION_TYPE_NONE,
- out_res_entry,
- 0);
- if (ret)
- return ret;
-
- return fflush_and_ftruncate(out_fp,
- file_offset + wim_resource_size(lte));
+ return 0;
}
struct write_resource_ctx {
- compress_func_t compress;
+ int out_ctype;
+ u32 out_chunk_size;
+ struct wimlib_lzx_context *comp_ctx;
struct chunk_table *chunk_tab;
- FILE *out_fp;
+ struct filedes *out_fd;
SHA_CTX sha_ctx;
bool doing_sha;
+ int resource_flags;
};
static int
write_resource_cb(const void *chunk, size_t chunk_size, void *_ctx)
{
struct write_resource_ctx *ctx = _ctx;
+ const void *out_chunk;
+ unsigned out_chunk_size;
+ int ret;
+ void *compressed_chunk = NULL;
+ unsigned compressed_size;
+ bool compressed_chunk_malloced = false;
+ size_t stack_max = 32768;
if (ctx->doing_sha)
sha1_update(&ctx->sha_ctx, chunk, chunk_size);
- if (ctx->compress) {
- return write_wim_resource_chunk(chunk, chunk_size,
- ctx->out_fp, ctx->compress,
- ctx->chunk_tab);
- } else {
- if (fwrite(chunk, 1, chunk_size, ctx->out_fp) != chunk_size) {
- ERROR_WITH_ERRNO("Error writing to output WIM");
- return WIMLIB_ERR_WRITE;
+ out_chunk = chunk;
+ out_chunk_size = chunk_size;
+ if (ctx->out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
+
+ /* Compress the chunk. */
+ if (chunk_size <= stack_max) {
+ compressed_chunk = alloca(chunk_size);
} else {
- return 0;
+ compressed_chunk = MALLOC(chunk_size);
+ if (compressed_chunk == NULL)
+ return WIMLIB_ERR_NOMEM;
+ compressed_chunk_malloced = true;
+ }
+
+ compressed_size = compress_chunk(chunk, chunk_size,
+ compressed_chunk,
+ ctx->out_ctype,
+ ctx->comp_ctx);
+ /* Use compressed data if compression to less than input size
+ * was successful. */
+ if (compressed_size) {
+ out_chunk = compressed_chunk;
+ out_chunk_size = compressed_size;
+ }
+ }
+
+ if (ctx->chunk_tab) {
+ /* Update chunk table accounting. */
+ chunk_tab_record_chunk(ctx->chunk_tab, out_chunk_size);
+
+ /* If writing compressed chunks to a pipable WIM, before the
+ * chunk data write a chunk header that provides the compressed
+ * chunk size. */
+ if (ctx->resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
+ struct pwm_chunk_hdr chunk_hdr = {
+ .compressed_size = cpu_to_le32(out_chunk_size),
+ };
+ ret = full_write(ctx->out_fd, &chunk_hdr,
+ sizeof(chunk_hdr));
+ if (ret)
+ goto error;
}
}
+
+ /* Write the chunk data. */
+ ret = full_write(ctx->out_fd, out_chunk, out_chunk_size);
+ if (ret)
+ goto error;
+
+out_free_memory:
+ if (compressed_chunk_malloced)
+ FREE(compressed_chunk);
+ return ret;
+
+error:
+ ERROR_WITH_ERRNO("Failed to write WIM resource chunk");
+ goto out_free_memory;
}
-int
+/*
+ * write_wim_resource()-
+ *
+ * Write a resource to an output WIM.
+ *
+ * @lte:
+ * Lookup table entry for the resource, which could be in another WIM, in
+ * an external file, or in another location.
+ *
+ * @out_fd:
+ * File descriptor opened to the output WIM.
+ *
+ * @out_ctype:
+ * One of the WIMLIB_COMPRESSION_TYPE_* constants to indicate which
+ * compression algorithm to use.
+ *
+ * @out_chunk_size:
+ * Compressed chunk size to use.
+ *
+ * @out_res_entry:
+ * On success, this is filled in with the offset, flags, compressed size,
+ * and uncompressed size of the resource in the output WIM.
+ *
+ * @resource_flags:
+ * * WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS to force data to be recompressed even
+ * if it could otherwise be copied directly from the input;
+ * * WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE if writing a resource for a pipable WIM
+ * (and the output file descriptor may be a pipe).
+ *
+ * @comp_ctx:
+ * Location of LZX compression context pointer, which will be allocated or
+ * updated if needed. (Initialize to NULL.)
+ *
+ * Additional notes: The SHA1 message digest of the uncompressed data is
+ * calculated (except when doing a raw copy --- see below). If the @unhashed
+ * flag is set on the lookup table entry, this message digest is simply copied
+ * to it; otherwise, the message digest is compared with the existing one, and
+ * this function will fail if they do not match.
+ */
+static int
write_wim_resource(struct wim_lookup_table_entry *lte,
- FILE *out_fp, int out_ctype,
+ struct filedes *out_fd, int out_ctype,
+ u32 out_chunk_size,
struct resource_entry *out_res_entry,
- int flags)
+ int resource_flags,
+ struct wimlib_lzx_context **comp_ctx)
{
struct write_resource_ctx write_ctx;
- u64 new_size;
- off_t offset;
+ off_t res_start_offset;
+ u32 in_chunk_size;
+ u64 read_size;
int ret;
- if (wim_resource_size(lte) == 0) {
- /* Empty resource; nothing needs to be done, so just return
- * success. */
- return 0;
- }
-
- offset = ftello(out_fp);
- if (offset == -1) {
- ERROR_WITH_ERRNO("Can't get position in output WIM");
- return WIMLIB_ERR_WRITE;
- }
-
- /* Can we simply copy the compressed data without recompressing it? */
-
- if (!(flags & WIMLIB_RESOURCE_FLAG_RECOMPRESS) &&
- lte->resource_location == RESOURCE_IN_WIM &&
- wimlib_get_compression_type(lte->wim) == out_ctype)
- {
- flags |= WIMLIB_RESOURCE_FLAG_RAW;
+ /* Mask out any irrelevant flags, since this function also uses this
+ * variable to store WIMLIB_READ_RESOURCE flags. */
+ resource_flags &= WIMLIB_WRITE_RESOURCE_MASK;
+
+ /* Get current position in output WIM. */
+ res_start_offset = out_fd->offset;
+
+ /* If we are not forcing the data to be recompressed, and the input
+ * resource is located in a WIM with a compression mode compatible with
+ * the output, we can simply copy the compressed data without
+ * recompressing it. This also means we must skip calculating the SHA1,
+ * as we never will see the uncompressed data. */
+ if (can_raw_copy(lte, resource_flags, out_ctype, out_chunk_size)) {
+ /* Normally, for raw copies we can request a RAW_FULL read, but
+ * if we're reading from a pipable resource and writing a
+ * non-pipable resource or vice versa, then a RAW_CHUNKS read
+ * needs to be requested so that the written resource can be
+ * appropriately formatted. However, in neither case is any
+ * actual decompression needed. */
+ if (lte->is_pipable == !!(resource_flags &
+ WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE))
+ {
+ resource_flags |= WIMLIB_READ_RESOURCE_FLAG_RAW_FULL;
+ read_size = lte->resource_entry.size;
+ } else {
+ resource_flags |= WIMLIB_READ_RESOURCE_FLAG_RAW_CHUNKS;
+ read_size = lte->resource_entry.original_size;
+ }
write_ctx.doing_sha = false;
} else {
write_ctx.doing_sha = true;
sha1_init(&write_ctx.sha_ctx);
+ read_size = lte->resource_entry.original_size;
}
- /* Initialize the chunk table and set the compression function if
- * compressing the resource. */
- if (out_ctype == WIMLIB_COMPRESSION_TYPE_NONE ||
- (flags & WIMLIB_RESOURCE_FLAG_RAW)) {
- write_ctx.compress = NULL;
- write_ctx.chunk_tab = NULL;
- } else {
- write_ctx.compress = get_compress_func(out_ctype);
- ret = begin_wim_resource_chunk_tab(lte, out_fp,
- offset,
- &write_ctx.chunk_tab);
+ /* Set the output compression mode and initialize chunk table if needed.
+ */
+ write_ctx.out_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
+ write_ctx.out_chunk_size = out_chunk_size;
+ write_ctx.chunk_tab = NULL;
+ if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
+ wimlib_assert(out_chunk_size > 0);
+ if (!(resource_flags & WIMLIB_READ_RESOURCE_FLAG_RAW)) {
+ /* Compression needed. */
+ write_ctx.out_ctype = out_ctype;
+ if (out_ctype == WIMLIB_COMPRESSION_TYPE_LZX) {
+ ret = wimlib_lzx_alloc_context(out_chunk_size,
+ NULL, comp_ctx);
+ if (ret)
+ goto out;
+ }
+ write_ctx.comp_ctx = *comp_ctx;
+ }
+ if (!(resource_flags & WIMLIB_READ_RESOURCE_FLAG_RAW_FULL)) {
+ /* Chunk table needed. */
+ ret = begin_wim_resource_chunk_tab(lte, out_fd,
+ out_chunk_size,
+ &write_ctx.chunk_tab,
+ resource_flags);
+ if (ret)
+ goto out;
+ }
+ }
+
+ /* If writing a pipable resource, write the stream header and update
+ * @res_start_offset to be the end of the stream header. */
+ if (resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
+ int reshdr_flags = 0;
+ if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE)
+ reshdr_flags |= WIM_RESHDR_FLAG_COMPRESSED;
+ ret = write_pwm_stream_header(lte, out_fd, reshdr_flags);
if (ret)
- return ret;
+ goto out_free_chunk_tab;
+ res_start_offset = out_fd->offset;
}
- /* Write the data */
- write_ctx.out_fp = out_fp;
- ret = read_resource_prefix(lte, wim_resource_size(lte),
- write_resource_cb, &write_ctx, 0);
+ /* Write the entire resource by reading the entire resource and feeding
+ * the data through write_resource_cb(). */
+ write_ctx.out_fd = out_fd;
+ write_ctx.resource_flags = resource_flags;
+try_write_again:
+ if (write_ctx.out_ctype == WIMLIB_COMPRESSION_TYPE_NONE)
+ in_chunk_size = wim_resource_chunk_size(lte);
+ else
+ in_chunk_size = out_chunk_size;
+ ret = read_resource_prefix(lte, read_size,
+ write_resource_cb,
+ in_chunk_size, &write_ctx, resource_flags);
+ if (ret)
+ goto out_free_chunk_tab;
/* Verify SHA1 message digest of the resource, or set the hash for the
* first time. */
if (write_ctx.doing_sha) {
- u8 md[SHA1_HASH_SIZE];
- sha1_final(md, &write_ctx.sha_ctx);
- if (lte->unhashed) {
- copy_hash(lte->hash, md);
- } else if (!hashes_equal(md, lte->hash)) {
- ERROR("WIM resource has incorrect hash!");
- if (lte_filename_valid(lte)) {
- ERROR("We were reading it from \"%"TS"\"; maybe "
- "it changed while we were reading it.",
- lte->file_on_disk);
- }
- ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
+ ret = finalize_and_check_sha1(&write_ctx.sha_ctx, lte);
+ if (ret)
goto out_free_chunk_tab;
- }
}
- out_res_entry->flags = lte->resource_entry.flags;
- out_res_entry->original_size = wim_resource_size(lte);
- out_res_entry->offset = offset;
- if (flags & WIMLIB_RESOURCE_FLAG_RAW) {
- /* Doing a raw write: The new compressed size is the same as
- * the compressed size in the other WIM. */
- new_size = lte->resource_entry.size;
- } else if (out_ctype == WIMLIB_COMPRESSION_TYPE_NONE) {
- /* Using WIMLIB_COMPRESSION_TYPE_NONE: The new compressed size
- * is the original size. */
- new_size = lte->resource_entry.original_size;
- out_res_entry->flags &= ~WIM_RESHDR_FLAG_COMPRESSED;
- } else {
- /* Using a different compression type: Call
- * finish_wim_resource_chunk_tab() and it will provide the new
- * compressed size. */
- ret = finish_wim_resource_chunk_tab(write_ctx.chunk_tab, out_fp,
- &new_size);
+ /* Write chunk table if needed. */
+ if (write_ctx.chunk_tab) {
+ ret = finish_wim_resource_chunk_tab(write_ctx.chunk_tab,
+ out_fd,
+ res_start_offset,
+ resource_flags);
if (ret)
goto out_free_chunk_tab;
- if (new_size >= wim_resource_size(lte)) {
- /* Oops! We compressed the resource to larger than the original
- * size. Write the resource uncompressed instead. */
- ret = write_uncompressed_resource_and_truncate(lte,
- out_fp,
- offset,
- out_res_entry);
- goto out_free_chunk_tab;
- }
+ }
+
+ /* Fill in out_res_entry with information about the newly written
+ * resource. */
+ out_res_entry->size = out_fd->offset - res_start_offset;
+ out_res_entry->flags = lte->resource_entry.flags;
+ if (out_ctype == WIMLIB_COMPRESSION_TYPE_NONE)
+ out_res_entry->flags &= ~WIM_RESHDR_FLAG_COMPRESSED;
+ else
out_res_entry->flags |= WIM_RESHDR_FLAG_COMPRESSED;
+ out_res_entry->offset = res_start_offset;
+ out_res_entry->original_size = wim_resource_size(lte);
+
+ /* Check for resources compressed to greater than their original size
+ * and write them uncompressed instead. (But never do this if writing
+ * to a pipe, and don't bother if we did a raw copy.) */
+ if (out_res_entry->size > out_res_entry->original_size &&
+ !(resource_flags & (WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE |
+ WIMLIB_READ_RESOURCE_FLAG_RAW)))
+ {
+ DEBUG("Compressed %"PRIu64" => %"PRIu64" bytes; "
+ "writing uncompressed instead",
+ out_res_entry->original_size, out_res_entry->size);
+ ret = seek_and_truncate(out_fd, res_start_offset);
+ if (ret)
+ goto out_free_chunk_tab;
+ out_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
+ FREE(write_ctx.chunk_tab);
+ write_ctx.out_ctype = WIMLIB_COMPRESSION_TYPE_NONE;
+ write_ctx.chunk_tab = NULL;
+ write_ctx.doing_sha = false;
+ goto try_write_again;
+ }
+ if (resource_flags & WIMLIB_READ_RESOURCE_FLAG_RAW) {
+ DEBUG("Copied raw compressed data "
+ "(%"PRIu64" => %"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
+ out_res_entry->original_size, out_res_entry->size,
+ out_res_entry->offset, out_res_entry->flags);
+ } else if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE) {
+ DEBUG("Wrote compressed resource "
+ "(%"PRIu64" => %"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
+ out_res_entry->original_size, out_res_entry->size,
+ out_res_entry->offset, out_res_entry->flags);
+ } else {
+ DEBUG("Wrote uncompressed resource "
+ "(%"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
+ out_res_entry->original_size,
+ out_res_entry->offset, out_res_entry->flags);
}
- out_res_entry->size = new_size;
ret = 0;
out_free_chunk_tab:
FREE(write_ctx.chunk_tab);
+out:
+ return ret;
+}
+
+/* Like write_wim_resource(), but the resource is specified by a buffer of
+ * uncompressed data rather a lookup table entry. Also writes the SHA1 message
+ * digest of the buffer to @hash_ret if it is non-NULL. */
+int
+write_wim_resource_from_buffer(const void *buf, size_t buf_size,
+ int reshdr_flags, struct filedes *out_fd,
+ int out_ctype,
+ u32 out_chunk_size,
+ struct resource_entry *out_res_entry,
+ u8 *hash_ret, int write_resource_flags,
+ struct wimlib_lzx_context **comp_ctx)
+{
+ int ret;
+ struct wim_lookup_table_entry *lte;
+
+ /* Set up a temporary lookup table entry to provide to
+ * write_wim_resource(). */
+
+ lte = new_lookup_table_entry();
+ if (lte == NULL)
+ return WIMLIB_ERR_NOMEM;
+
+ lte->resource_location = RESOURCE_IN_ATTACHED_BUFFER;
+ lte->attached_buffer = (void*)buf;
+ lte->resource_entry.original_size = buf_size;
+ lte->resource_entry.flags = reshdr_flags;
+
+ if (write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE) {
+ sha1_buffer(buf, buf_size, lte->hash);
+ lte->unhashed = 0;
+ } else {
+ lte->unhashed = 1;
+ }
+
+ ret = write_wim_resource(lte, out_fd, out_ctype, out_chunk_size,
+ out_res_entry, write_resource_flags, comp_ctx);
+ if (ret)
+ goto out_free_lte;
+ if (hash_ret)
+ copy_hash(hash_ret, lte->hash);
+ ret = 0;
+out_free_lte:
+ lte->resource_location = RESOURCE_NONEXISTENT;
+ free_lookup_table_entry(lte);
return ret;
}
+
#ifdef ENABLE_MULTITHREADED_COMPRESSION
/* Blocking shared queue (solves the producer-consumer problem) */
wimlib_assert(size != 0);
q->array = CALLOC(sizeof(q->array[0]), size);
if (!q->array)
- return WIMLIB_ERR_NOMEM;
+ goto err;
q->filled_slots = 0;
q->front = 0;
q->back = size - 1;
q->size = size;
- pthread_mutex_init(&q->lock, NULL);
- pthread_cond_init(&q->msg_avail_cond, NULL);
- pthread_cond_init(&q->space_avail_cond, NULL);
+ if (pthread_mutex_init(&q->lock, NULL)) {
+ ERROR_WITH_ERRNO("Failed to initialize mutex");
+ goto err;
+ }
+ if (pthread_cond_init(&q->msg_avail_cond, NULL)) {
+ ERROR_WITH_ERRNO("Failed to initialize condition variable");
+ goto err_destroy_lock;
+ }
+ if (pthread_cond_init(&q->space_avail_cond, NULL)) {
+ ERROR_WITH_ERRNO("Failed to initialize condition variable");
+ goto err_destroy_msg_avail_cond;
+ }
return 0;
+err_destroy_msg_avail_cond:
+ pthread_cond_destroy(&q->msg_avail_cond);
+err_destroy_lock:
+ pthread_mutex_destroy(&q->lock);
+err:
+ return WIMLIB_ERR_NOMEM;
}
static void
struct compressor_thread_params {
struct shared_queue *res_to_compress_queue;
struct shared_queue *compressed_res_queue;
- compress_func_t compress;
+ int out_ctype;
+ struct wimlib_lzx_context *comp_ctx;
};
#define MAX_CHUNKS_PER_MSG 2
struct message {
struct wim_lookup_table_entry *lte;
+ u32 out_chunk_size;
u8 *uncompressed_chunks[MAX_CHUNKS_PER_MSG];
- u8 *out_compressed_chunks[MAX_CHUNKS_PER_MSG];
u8 *compressed_chunks[MAX_CHUNKS_PER_MSG];
unsigned uncompressed_chunk_sizes[MAX_CHUNKS_PER_MSG];
- unsigned compressed_chunk_sizes[MAX_CHUNKS_PER_MSG];
+ struct iovec out_chunks[MAX_CHUNKS_PER_MSG];
unsigned num_chunks;
struct list_head list;
bool complete;
};
static void
-compress_chunks(struct message *msg, compress_func_t compress)
+compress_chunks(struct message *msg, int out_ctype,
+ struct wimlib_lzx_context *comp_ctx)
{
for (unsigned i = 0; i < msg->num_chunks; i++) {
- DEBUG2("compress chunk %u of %u", i, msg->num_chunks);
- unsigned len = compress(msg->uncompressed_chunks[i],
- msg->uncompressed_chunk_sizes[i],
- msg->compressed_chunks[i]);
+ unsigned len;
+
+ len = compress_chunk(msg->uncompressed_chunks[i],
+ msg->uncompressed_chunk_sizes[i],
+ msg->compressed_chunks[i],
+ out_ctype,
+ comp_ctx);
+
+ void *out_chunk;
+ unsigned out_len;
if (len) {
/* To be written compressed */
- msg->out_compressed_chunks[i] = msg->compressed_chunks[i];
- msg->compressed_chunk_sizes[i] = len;
+ out_chunk = msg->compressed_chunks[i];
+ out_len = len;
} else {
/* To be written uncompressed */
- msg->out_compressed_chunks[i] = msg->uncompressed_chunks[i];
- msg->compressed_chunk_sizes[i] = msg->uncompressed_chunk_sizes[i];
-
+ out_chunk = msg->uncompressed_chunks[i];
+ out_len = msg->uncompressed_chunk_sizes[i];
}
+ msg->out_chunks[i].iov_base = out_chunk;
+ msg->out_chunks[i].iov_len = out_len;
}
}
struct compressor_thread_params *params = arg;
struct shared_queue *res_to_compress_queue = params->res_to_compress_queue;
struct shared_queue *compressed_res_queue = params->compressed_res_queue;
- compress_func_t compress = params->compress;
struct message *msg;
DEBUG("Compressor thread ready");
while ((msg = shared_queue_get(res_to_compress_queue)) != NULL) {
- compress_chunks(msg, compress);
+ compress_chunks(msg, params->out_ctype, params->comp_ctx);
shared_queue_put(compressed_res_queue, msg);
}
DEBUG("Compressor thread terminating");
}
#endif /* ENABLE_MULTITHREADED_COMPRESSION */
+struct write_streams_progress_data {
+ wimlib_progress_func_t progress_func;
+ union wimlib_progress_info progress;
+ uint64_t next_progress;
+ WIMStruct *prev_wim_part;
+};
+
static void
-do_write_streams_progress(union wimlib_progress_info *progress,
- wimlib_progress_func_t progress_func,
- uint64_t size_added)
+do_write_streams_progress(struct write_streams_progress_data *progress_data,
+ struct wim_lookup_table_entry *lte,
+ bool stream_discarded)
{
- progress->write_streams.completed_bytes += size_added;
+ union wimlib_progress_info *progress = &progress_data->progress;
+ bool new_wim_part;
+
+ if (stream_discarded) {
+ progress->write_streams.total_bytes -= wim_resource_size(lte);
+ if (progress_data->next_progress != ~(uint64_t)0 &&
+ progress_data->next_progress > progress->write_streams.total_bytes)
+ {
+ progress_data->next_progress = progress->write_streams.total_bytes;
+ }
+ } else {
+ progress->write_streams.completed_bytes += wim_resource_size(lte);
+ }
+ new_wim_part = false;
+ if (lte->resource_location == RESOURCE_IN_WIM &&
+ lte->wim != progress_data->prev_wim_part)
+ {
+ if (progress_data->prev_wim_part) {
+ new_wim_part = true;
+ progress->write_streams.completed_parts++;
+ }
+ progress_data->prev_wim_part = lte->wim;
+ }
progress->write_streams.completed_streams++;
- if (progress_func &&
- progress->write_streams.completed_bytes >= progress->write_streams._private)
+ if (progress_data->progress_func
+ && (progress->write_streams.completed_bytes >= progress_data->next_progress
+ || new_wim_part))
{
- progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
- progress);
- if (progress->write_streams._private == progress->write_streams.total_bytes) {
- progress->write_streams._private = ~0;
+ progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
+ progress);
+ if (progress_data->next_progress == progress->write_streams.total_bytes) {
+ progress_data->next_progress = ~(uint64_t)0;
} else {
- progress->write_streams._private =
+ progress_data->next_progress =
min(progress->write_streams.total_bytes,
progress->write_streams.completed_bytes +
progress->write_streams.total_bytes / 100);
}
}
-static int
-sha1_chunk(const void *buf, size_t len, void *ctx)
-{
- sha1_update(ctx, buf, len);
- return 0;
-}
+struct serial_write_stream_ctx {
+ struct filedes *out_fd;
+ int out_ctype;
+ u32 out_chunk_size;
+ struct wimlib_lzx_context **comp_ctx;
+ int write_resource_flags;
+};
static int
-sha1_resource(struct wim_lookup_table_entry *lte)
+serial_write_stream(struct wim_lookup_table_entry *lte, void *_ctx)
{
- int ret;
- SHA_CTX sha_ctx;
-
- sha1_init(&sha_ctx);
- ret = read_resource_prefix(lte, wim_resource_size(lte),
- sha1_chunk, &sha_ctx, 0);
- if (ret == 0)
- sha1_final(lte->hash, &sha_ctx);
- return ret;
+ struct serial_write_stream_ctx *ctx = _ctx;
+ return write_wim_resource(lte, ctx->out_fd,
+ ctx->out_ctype,
+ ctx->out_chunk_size,
+ <e->output_resource_entry,
+ ctx->write_resource_flags,
+ ctx->comp_ctx);
}
-enum {
- STREAMS_MERGED = 0,
- STREAMS_NOT_MERGED = 1,
-};
+/* Write a list of streams, taking into account that some streams may be
+ * duplicates that are checksummed and discarded on the fly, and also delegating
+ * the actual writing of a stream to a function @write_stream_cb, which is
+ * passed the context @write_stream_ctx. */
static int
-do_write_stream_list(struct list_head *my_resources,
+do_write_stream_list(struct list_head *stream_list,
struct wim_lookup_table *lookup_table,
- FILE *out_fp,
- int out_ctype,
- wimlib_progress_func_t progress_func,
- union wimlib_progress_info *progress,
- int write_resource_flags)
+ int (*write_stream_cb)(struct wim_lookup_table_entry *, void *),
+ void *write_stream_ctx,
+ struct write_streams_progress_data *progress_data)
{
- int ret;
+ int ret = 0;
struct wim_lookup_table_entry *lte;
+ bool stream_discarded;
- while (!list_empty(my_resources)) {
- lte = container_of(my_resources->next,
+ /* For each stream in @stream_list ... */
+ while (!list_empty(stream_list)) {
+ stream_discarded = false;
+ lte = container_of(stream_list->next,
struct wim_lookup_table_entry,
write_streams_list);
list_del(<e->write_streams_list);
if (lte->unhashed && !lte->unique_size) {
- struct wim_lookup_table_entry *duplicate_lte;
- struct wim_lookup_table_entry **my_ptr;
+ /* Unhashed stream that shares a size with some other
+ * stream in the WIM we are writing. The stream must be
+ * checksummed to know if we need to write it or not. */
+ struct wim_lookup_table_entry *tmp;
+ u32 orig_out_refcnt = lte->out_refcnt;
- my_ptr = lte->my_ptr;
- ret = sha1_resource(lte);
+ ret = hash_unhashed_stream(lte, lookup_table, &tmp);
if (ret)
- return ret;
- duplicate_lte = __lookup_resource(lookup_table, lte->hash);
- if (duplicate_lte) {
- bool new_stream = (duplicate_lte->out_refcnt == 0);
- duplicate_lte->refcnt += lte->refcnt;
- duplicate_lte->out_refcnt += lte->refcnt;
- *my_ptr = duplicate_lte;
- free_lookup_table_entry(lte);
-
- if (new_stream) {
- lte = duplicate_lte;
- DEBUG("Stream of length %"PRIu64" is duplicate "
- "with one already in WIM",
- wim_resource_size(duplicate_lte));
- } else {
- DEBUG("Discarding duplicate stream of length %"PRIu64,
- wim_resource_size(duplicate_lte));
+ break;
+ if (tmp != lte) {
+ /* We found a duplicate stream. 'lte' was
+ * freed, so replace it with the duplicate. */
+ lte = tmp;
+
+ /* 'out_refcnt' was transferred to the
+ * duplicate, and we can detect if the duplicate
+ * stream was already referenced for writing by
+ * checking if its 'out_refcnt' is higher than
+ * that of the original stream. In such cases,
+ * the current stream can be discarded. We can
+ * also discard the current stream if it was
+ * previously marked as filtered (e.g. already
+ * present in the WIM being written). */
+ if (lte->out_refcnt > orig_out_refcnt ||
+ lte->filtered) {
+ DEBUG("Discarding duplicate stream of "
+ "length %"PRIu64,
+ wim_resource_size(lte));
+ lte->no_progress = 0;
+ stream_discarded = true;
goto skip_to_progress;
}
-
- } else {
- lookup_table_insert(lookup_table, lte);
- lte->out_refcnt = lte->refcnt;
- lte->unhashed = 0;
}
}
+ /* Here, @lte is either a hashed stream or an unhashed stream
+ * with a unique size. In either case we know that the stream
+ * has to be written. In either case the SHA1 message digest
+ * will be calculated over the stream while writing it; however,
+ * in the former case this is done merely to check the data,
+ * while in the latter case this is done because we do not have
+ * the SHA1 message digest yet. */
wimlib_assert(lte->out_refcnt != 0);
-
- ret = write_wim_resource(lte,
- out_fp,
- out_ctype,
- <e->output_resource_entry,
- write_resource_flags);
+ lte->deferred = 0;
+ lte->no_progress = 0;
+ ret = (*write_stream_cb)(lte, write_stream_ctx);
if (ret)
- return ret;
+ break;
+ /* In parallel mode, some streams are deferred for later,
+ * serialized processing; ignore them here. */
+ if (lte->deferred)
+ continue;
if (lte->unhashed) {
+ list_del(<e->unhashed_list);
lookup_table_insert(lookup_table, lte);
lte->unhashed = 0;
}
skip_to_progress:
- do_write_streams_progress(progress,
- progress_func,
- wim_resource_size(lte));
+ if (!lte->no_progress) {
+ do_write_streams_progress(progress_data,
+ lte, stream_discarded);
+ }
}
- return 0;
+ return ret;
}
static int
-write_stream_list_serial(struct list_head *stream_list,
- struct wim_lookup_table *lookup_table,
- FILE *out_fp,
- int out_ctype,
- int write_flags,
- wimlib_progress_func_t progress_func,
- union wimlib_progress_info *progress)
+do_write_stream_list_serial(struct list_head *stream_list,
+ struct wim_lookup_table *lookup_table,
+ struct filedes *out_fd,
+ int out_ctype,
+ u32 out_chunk_size,
+ struct wimlib_lzx_context **comp_ctx,
+ int write_resource_flags,
+ struct write_streams_progress_data *progress_data)
{
- int write_resource_flags;
-
- if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
- write_resource_flags = WIMLIB_RESOURCE_FLAG_RECOMPRESS;
- else
- write_resource_flags = 0;
- progress->write_streams.num_threads = 1;
- if (progress_func)
- progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS, progress);
+ struct serial_write_stream_ctx ctx = {
+ .out_fd = out_fd,
+ .out_ctype = out_ctype,
+ .out_chunk_size = out_chunk_size,
+ .write_resource_flags = write_resource_flags,
+ .comp_ctx = comp_ctx,
+ };
return do_write_stream_list(stream_list,
lookup_table,
- out_fp,
- out_ctype, progress_func,
- progress, write_resource_flags);
+ serial_write_stream,
+ &ctx,
+ progress_data);
}
-#ifdef ENABLE_MULTITHREADED_COMPRESSION
-static int
-write_wim_chunks(struct message *msg, FILE *out_fp,
- struct chunk_table *chunk_tab)
+static inline int
+write_flags_to_resource_flags(int write_flags)
{
- for (unsigned i = 0; i < msg->num_chunks; i++) {
- unsigned chunk_csize = msg->compressed_chunk_sizes[i];
+ int resource_flags = 0;
- DEBUG2("Write wim chunk %u of %u (csize = %u)",
- i, msg->num_chunks, chunk_csize);
+ if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
+ resource_flags |= WIMLIB_WRITE_RESOURCE_FLAG_RECOMPRESS;
+ if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
+ resource_flags |= WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE;
+ return resource_flags;
+}
- if (fwrite(msg->out_compressed_chunks[i], 1, chunk_csize, out_fp)
- != chunk_csize)
- {
- ERROR_WITH_ERRNO("Failed to write WIM chunk");
- return WIMLIB_ERR_WRITE;
- }
-
- *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset;
- chunk_tab->cur_offset += chunk_csize;
- }
- return 0;
+static int
+write_stream_list_serial(struct list_head *stream_list,
+ struct wim_lookup_table *lookup_table,
+ struct filedes *out_fd,
+ int out_ctype,
+ u32 out_chunk_size,
+ struct wimlib_lzx_context **comp_ctx,
+ int write_resource_flags,
+ struct write_streams_progress_data *progress_data)
+{
+ union wimlib_progress_info *progress = &progress_data->progress;
+ DEBUG("Writing stream list of size %"PRIu64" (serial version)",
+ progress->write_streams.total_streams);
+ progress->write_streams.num_threads = 1;
+ if (progress_data->progress_func) {
+ progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
+ progress);
+ }
+ return do_write_stream_list_serial(stream_list,
+ lookup_table,
+ out_fd,
+ out_ctype,
+ out_chunk_size,
+ comp_ctx,
+ write_resource_flags,
+ progress_data);
}
-/*
- * This function is executed by the main thread when the resources are being
- * compressed in parallel. The main thread is in change of all reading of the
- * uncompressed data and writing of the compressed data. The compressor threads
- * *only* do compression from/to in-memory buffers.
- *
- * Each unit of work given to a compressor thread is up to MAX_CHUNKS_PER_MSG
- * chunks of compressed data to compress, represented in a `struct message'.
- * Each message is passed from the main thread to a worker thread through the
- * res_to_compress_queue, and it is passed back through the
- * compressed_res_queue.
- */
+#ifdef ENABLE_MULTITHREADED_COMPRESSION
static int
-main_writer_thread_proc(struct list_head *stream_list,
- FILE *out_fp,
- int out_ctype,
- struct shared_queue *res_to_compress_queue,
- struct shared_queue *compressed_res_queue,
- size_t num_messages,
- int write_flags,
- wimlib_progress_func_t progress_func,
- union wimlib_progress_info *progress)
+write_wim_chunks(struct message *msg, struct filedes *out_fd,
+ struct chunk_table *chunk_tab,
+ int write_resource_flags)
{
+ struct iovec *vecs;
+ struct pwm_chunk_hdr *chunk_hdrs;
+ unsigned nvecs;
int ret;
- struct chunk_table *cur_chunk_tab = NULL;
- struct message *msgs = CALLOC(num_messages, sizeof(struct message));
- struct wim_lookup_table_entry *next_lte = NULL;
- // Initially, all the messages are available to use.
- LIST_HEAD(available_msgs);
+ for (unsigned i = 0; i < msg->num_chunks; i++)
+ chunk_tab_record_chunk(chunk_tab, msg->out_chunks[i].iov_len);
+
+ if (!(write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE)) {
+ nvecs = msg->num_chunks;
+ vecs = msg->out_chunks;
+ } else {
+ /* Special case: If writing a compressed resource to a pipable
+ * WIM, prefix each compressed chunk with a header that gives
+ * its compressed size. */
+ nvecs = msg->num_chunks * 2;
+ vecs = alloca(nvecs * sizeof(vecs[0]));
+ chunk_hdrs = alloca(msg->num_chunks * sizeof(chunk_hdrs[0]));
+
+ for (unsigned i = 0; i < msg->num_chunks; i++) {
+ chunk_hdrs[i].compressed_size = cpu_to_le32(msg->out_chunks[i].iov_len);
+ vecs[i * 2].iov_base = &chunk_hdrs[i];
+ vecs[i * 2].iov_len = sizeof(chunk_hdrs[i]);
+ vecs[i * 2 + 1].iov_base = msg->out_chunks[i].iov_base;
+ vecs[i * 2 + 1].iov_len = msg->out_chunks[i].iov_len;
+ }
+ }
+ ret = full_writev(out_fd, vecs, nvecs);
+ if (ret)
+ ERROR_WITH_ERRNO("Write error");
+ return ret;
+}
+
+struct main_writer_thread_ctx {
+ struct list_head *stream_list;
+ struct wim_lookup_table *lookup_table;
+ struct filedes *out_fd;
+ off_t res_start_offset;
+ int out_ctype;
+ u32 out_chunk_size;
+ struct wimlib_lzx_context **comp_ctx;
+ int write_resource_flags;
+ struct shared_queue *res_to_compress_queue;
+ struct shared_queue *compressed_res_queue;
+ size_t num_messages;
+ struct write_streams_progress_data *progress_data;
+
+ struct list_head available_msgs;
+ struct list_head outstanding_streams;
+ struct list_head serial_streams;
+ size_t num_outstanding_messages;
- if (!msgs) {
- ret = WIMLIB_ERR_NOMEM;
- goto out;
- }
-
- for (size_t i = 0; i < num_messages; i++)
- list_add(&msgs[i].list, &available_msgs);
-
- // outstanding_resources is the list of resources that currently have
- // had chunks sent off for compression.
- //
- // The first stream in outstanding_resources is the stream that is
- // currently being written (cur_lte).
- //
- // The last stream in outstanding_resources is the stream that is
- // currently being read and chunks fed to the compressor threads
- // (next_lte).
- //
- // Depending on the number of threads and the sizes of the resource,
- // the outstanding streams list may contain streams between cur_lte and
- // next_lte that have all their chunks compressed or being compressed,
- // but haven't been written yet.
- //
- LIST_HEAD(outstanding_resources);
- struct list_head *next_resource = stream_list->next;
- u64 next_chunk = 0;
- u64 next_num_chunks = 0;
-
- // As in write_wim_resource(), each resource we read is checksummed.
SHA_CTX next_sha_ctx;
- u8 next_hash[SHA1_HASH_SIZE];
+ u64 next_chunk;
+ u64 next_num_chunks;
+ struct wim_lookup_table_entry *next_lte;
- // Resources that don't need any chunks compressed are added to this
- // list and written directly by the main thread.
- LIST_HEAD(my_resources);
+ struct message *msgs;
+ struct message *next_msg;
+ struct chunk_table *cur_chunk_tab;
+};
- struct wim_lookup_table_entry *cur_lte = NULL;
- struct message *msg;
+static int
+init_message(struct message *msg, u32 out_chunk_size)
+{
+ msg->out_chunk_size = out_chunk_size;
+ for (size_t i = 0; i < MAX_CHUNKS_PER_MSG; i++) {
+ msg->compressed_chunks[i] = MALLOC(out_chunk_size);
+ msg->uncompressed_chunks[i] = MALLOC(out_chunk_size);
+ if (msg->compressed_chunks[i] == NULL ||
+ msg->uncompressed_chunks[i] == NULL)
+ return WIMLIB_ERR_NOMEM;
+ }
+ return 0;
+}
-#ifdef WITH_NTFS_3G
- ntfs_inode *ni = NULL;
-#endif
+static void
+destroy_message(struct message *msg)
+{
+ for (size_t i = 0; i < MAX_CHUNKS_PER_MSG; i++) {
+ FREE(msg->compressed_chunks[i]);
+ FREE(msg->uncompressed_chunks[i]);
+ }
+}
- DEBUG("Initializing buffers for uncompressed "
- "and compressed data (%zu bytes needed)",
- num_messages * MAX_CHUNKS_PER_MSG * WIM_CHUNK_SIZE * 2);
+static void
+free_messages(struct message *msgs, size_t num_messages)
+{
+ if (msgs) {
+ for (size_t i = 0; i < num_messages; i++)
+ destroy_message(&msgs[i]);
+ FREE(msgs);
+ }
+}
+
+static struct message *
+allocate_messages(size_t num_messages, u32 out_chunk_size)
+{
+ struct message *msgs;
- // Pre-allocate all the buffers that will be needed to do the chunk
- // compression.
+ msgs = CALLOC(num_messages, sizeof(struct message));
+ if (msgs == NULL)
+ return NULL;
for (size_t i = 0; i < num_messages; i++) {
- for (size_t j = 0; j < MAX_CHUNKS_PER_MSG; j++) {
- msgs[i].compressed_chunks[j] = MALLOC(WIM_CHUNK_SIZE);
-
- // The extra 8 bytes is because longest_match() in
- // lz77.c may read a little bit off the end of the
- // uncompressed data. It doesn't need to be
- // initialized--- we really just need to avoid accessing
- // an unmapped page.
- msgs[i].uncompressed_chunks[j] = MALLOC(WIM_CHUNK_SIZE + 8);
- if (msgs[i].compressed_chunks[j] == NULL ||
- msgs[i].uncompressed_chunks[j] == NULL)
- {
- ret = WIMLIB_ERR_NOMEM;
- goto out;
- }
+ if (init_message(&msgs[i], out_chunk_size)) {
+ free_messages(msgs, num_messages);
+ return NULL;
}
}
+ return msgs;
+}
- // This loop is executed until all resources have been written, except
- // possibly a few that have been added to the @my_resources list for
- // writing later.
- while (1) {
- // Send chunks to the compressor threads until either (a) there
- // are no more messages available since they were all sent off,
- // or (b) there are no more resources that need to be
- // compressed.
- while (!list_empty(&available_msgs)) {
- if (next_chunk == next_num_chunks) {
- // If next_chunk == next_num_chunks, there are
- // no more chunks to write in the current
- // stream. So, check the SHA1 message digest of
- // the stream that was just finished (unless
- // next_lte == NULL, which is the case the very
- // first time this loop is entered, and also
- // near the very end of the compression when
- // there are no more streams.) Then, advance to
- // the next stream (if there is one).
- if (next_lte != NULL) {
- #ifdef WITH_NTFS_3G
- end_wim_resource_read(next_lte, ni);
- ni = NULL;
- #else
- end_wim_resource_read(next_lte);
- #endif
- DEBUG2("Finalize SHA1 md (next_num_chunks=%zu)",
- next_num_chunks);
- sha1_final(next_hash, &next_sha_ctx);
- if (!hashes_equal(next_lte->hash, next_hash)) {
- ERROR("WIM resource has incorrect hash!");
- if (next_lte->resource_location ==
- RESOURCE_IN_FILE_ON_DISK)
- {
- ERROR("We were reading it from `%"TS"'; "
- "maybe it changed while we were "
- "reading it.",
- next_lte->file_on_disk);
- }
- ret = WIMLIB_ERR_INVALID_RESOURCE_HASH;
- goto out;
- }
- }
+static void
+main_writer_thread_destroy_ctx(struct main_writer_thread_ctx *ctx)
+{
+ while (ctx->num_outstanding_messages--)
+ shared_queue_get(ctx->compressed_res_queue);
+ free_messages(ctx->msgs, ctx->num_messages);
+ FREE(ctx->cur_chunk_tab);
+}
- // Advance to the next resource.
- //
- // If the next resource needs no compression, just write
- // it with this thread (not now though--- we could be in
- // the middle of writing another resource.) Keep doing
- // this until we either get to the end of the resources
- // list, or we get to a resource that needs compression.
- while (1) {
- if (next_resource == stream_list) {
- // No more resources to send for
- // compression
- next_lte = NULL;
- break;
- }
- next_lte = container_of(next_resource,
- struct wim_lookup_table_entry,
- staging_list);
- next_resource = next_resource->next;
- if ((!(write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
- && wim_resource_compression_type(next_lte) == out_ctype)
- || wim_resource_size(next_lte) == 0)
- {
- list_add_tail(&next_lte->staging_list,
- &my_resources);
- } else {
- list_add_tail(&next_lte->staging_list,
- &outstanding_resources);
- next_chunk = 0;
- next_num_chunks = wim_resource_chunks(next_lte);
- sha1_init(&next_sha_ctx);
- INIT_LIST_HEAD(&next_lte->msg_list);
- #ifdef WITH_NTFS_3G
- ret = prepare_resource_for_read(next_lte, &ni);
- #else
- ret = prepare_resource_for_read(next_lte);
- #endif
-
- if (ret != 0)
- goto out;
- if (cur_lte == NULL) {
- // Set cur_lte for the
- // first time
- cur_lte = next_lte;
- }
- break;
- }
- }
- }
+static int
+main_writer_thread_init_ctx(struct main_writer_thread_ctx *ctx)
+{
+ /* Pre-allocate all the buffers that will be needed to do the chunk
+ * compression. */
+ ctx->msgs = allocate_messages(ctx->num_messages, ctx->out_chunk_size);
+ if (ctx->msgs == NULL)
+ return WIMLIB_ERR_NOMEM;
- if (next_lte == NULL) {
- // No more resources to send for compression
- break;
- }
+ /* Initially, all the messages are available to use. */
+ INIT_LIST_HEAD(&ctx->available_msgs);
+ for (size_t i = 0; i < ctx->num_messages; i++)
+ list_add_tail(&ctx->msgs[i].list, &ctx->available_msgs);
+
+ /* outstanding_streams is the list of streams that currently have had
+ * chunks sent off for compression.
+ *
+ * The first stream in outstanding_streams is the stream that is
+ * currently being written.
+ *
+ * The last stream in outstanding_streams is the stream that is
+ * currently being read and having chunks fed to the compressor threads.
+ * */
+ INIT_LIST_HEAD(&ctx->outstanding_streams);
+ ctx->num_outstanding_messages = 0;
+
+ /* Message currently being prepared. */
+ ctx->next_msg = NULL;
+
+ /* Resources that don't need any chunks compressed are added to this
+ * list and written directly by the main thread. */
+ INIT_LIST_HEAD(&ctx->serial_streams);
+
+ /* Pointer to chunk table for stream currently being written. */
+ ctx->cur_chunk_tab = NULL;
- // Get a message from the available messages
- // list
- msg = container_of(available_msgs.next,
- struct message,
- list);
-
- // ... and delete it from the available messages
- // list
- list_del(&msg->list);
-
- // Initialize the message with the chunks to
- // compress.
- msg->num_chunks = min(next_num_chunks - next_chunk,
- MAX_CHUNKS_PER_MSG);
- msg->lte = next_lte;
- msg->complete = false;
- msg->begin_chunk = next_chunk;
-
- unsigned size = WIM_CHUNK_SIZE;
- for (unsigned i = 0; i < msg->num_chunks; i++) {
-
- // Read chunk @next_chunk of the stream into the
- // message so that a compressor thread can
- // compress it.
-
- if (next_chunk == next_num_chunks - 1) {
- size = MODULO_NONZERO(wim_resource_size(next_lte),
- WIM_CHUNK_SIZE);
- }
+ return 0;
+}
- DEBUG2("Read resource (size=%u, offset=%zu)",
- size, next_chunk * WIM_CHUNK_SIZE);
+static int
+receive_compressed_chunks(struct main_writer_thread_ctx *ctx)
+{
+ struct message *msg;
+ struct wim_lookup_table_entry *cur_lte;
+ int ret;
- msg->uncompressed_chunk_sizes[i] = size;
+ wimlib_assert(!list_empty(&ctx->outstanding_streams));
+ wimlib_assert(ctx->num_outstanding_messages != 0);
+
+ cur_lte = container_of(ctx->outstanding_streams.next,
+ struct wim_lookup_table_entry,
+ being_compressed_list);
+
+ /* Get the next message from the queue and process it.
+ * The message will contain 1 or more data chunks that have been
+ * compressed. */
+ msg = shared_queue_get(ctx->compressed_res_queue);
+ msg->complete = true;
+ --ctx->num_outstanding_messages;
+
+ /* Is this the next chunk in the current resource? If it's not (i.e.,
+ * an earlier chunk in a same or different resource hasn't been
+ * compressed yet), do nothing, and keep this message around until all
+ * earlier chunks are received.
+ *
+ * Otherwise, write all the chunks we can. */
+ while (cur_lte != NULL &&
+ !list_empty(&cur_lte->msg_list)
+ && (msg = container_of(cur_lte->msg_list.next,
+ struct message,
+ list))->complete)
+ {
+ list_move(&msg->list, &ctx->available_msgs);
+ if (msg->begin_chunk == 0) {
+ /* First set of chunks. */
- ret = read_wim_resource(next_lte,
- msg->uncompressed_chunks[i],
- size,
- next_chunk * WIM_CHUNK_SIZE,
- 0);
- if (ret != 0)
- goto out;
- sha1_update(&next_sha_ctx,
- msg->uncompressed_chunks[i], size);
- next_chunk++;
+ /* Write pipable WIM stream header if needed. */
+ if (ctx->write_resource_flags &
+ WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE)
+ {
+ ret = write_pwm_stream_header(cur_lte, ctx->out_fd,
+ WIM_RESHDR_FLAG_COMPRESSED);
+ if (ret)
+ return ret;
}
- // Send the compression request
- list_add_tail(&msg->list, &next_lte->msg_list);
- shared_queue_put(res_to_compress_queue, msg);
- DEBUG2("Compression request sent");
- }
+ /* Save current offset. */
+ ctx->res_start_offset = ctx->out_fd->offset;
- // If there are no outstanding resources, there are no more
- // resources that need to be written.
- if (list_empty(&outstanding_resources)) {
- ret = 0;
- goto out;
+ /* Begin building the chunk table, and leave space for
+ * it if needed. */
+ ret = begin_wim_resource_chunk_tab(cur_lte,
+ ctx->out_fd,
+ ctx->out_chunk_size,
+ &ctx->cur_chunk_tab,
+ ctx->write_resource_flags);
+ if (ret)
+ return ret;
}
- // Get the next message from the queue and process it.
- // The message will contain 1 or more data chunks that have been
- // compressed.
- msg = shared_queue_get(compressed_res_queue);
- msg->complete = true;
-
- // Is this the next chunk in the current resource? If it's not
- // (i.e., an earlier chunk in a same or different resource
- // hasn't been compressed yet), do nothing, and keep this
- // message around until all earlier chunks are received.
- //
- // Otherwise, write all the chunks we can.
- while (cur_lte != NULL &&
- !list_empty(&cur_lte->msg_list) &&
- (msg = container_of(cur_lte->msg_list.next,
- struct message,
- list))->complete)
+ /* Write the compressed chunks from the message. */
+ ret = write_wim_chunks(msg, ctx->out_fd, ctx->cur_chunk_tab,
+ ctx->write_resource_flags);
+ if (ret)
+ return ret;
+
+ /* Was this the last chunk of the stream? If so, finish the
+ * stream by writing the chunk table. */
+ if (list_empty(&cur_lte->msg_list) &&
+ msg->begin_chunk + msg->num_chunks == ctx->cur_chunk_tab->num_chunks)
{
- DEBUG2("Complete msg (begin_chunk=%"PRIu64")", msg->begin_chunk);
- if (msg->begin_chunk == 0) {
- DEBUG2("Begin chunk tab");
-
- // This is the first set of chunks. Leave space
- // for the chunk table in the output file.
- off_t cur_offset = ftello(out_fp);
- if (cur_offset == -1) {
- ret = WIMLIB_ERR_WRITE;
- goto out;
- }
- ret = begin_wim_resource_chunk_tab(cur_lte,
- out_fp,
- cur_offset,
- &cur_chunk_tab);
- if (ret != 0)
- goto out;
- }
+ u64 res_csize;
- // Write the compressed chunks from the message.
- ret = write_wim_chunks(msg, out_fp, cur_chunk_tab);
- if (ret != 0)
- goto out;
+ ret = finish_wim_resource_chunk_tab(ctx->cur_chunk_tab,
+ ctx->out_fd,
+ ctx->res_start_offset,
+ ctx->write_resource_flags);
+ if (ret)
+ return ret;
- list_del(&msg->list);
+ list_del(&cur_lte->being_compressed_list);
- // This message is available to use for different chunks
- // now.
- list_add(&msg->list, &available_msgs);
+ res_csize = ctx->out_fd->offset - ctx->res_start_offset;
- // Was this the last chunk of the stream? If so, finish
- // it.
- if (list_empty(&cur_lte->msg_list) &&
- msg->begin_chunk + msg->num_chunks == cur_chunk_tab->num_chunks)
- {
- DEBUG2("Finish wim chunk tab");
- u64 res_csize;
- ret = finish_wim_resource_chunk_tab(cur_chunk_tab,
- out_fp,
- &res_csize);
- if (ret != 0)
- goto out;
+ FREE(ctx->cur_chunk_tab);
+ ctx->cur_chunk_tab = NULL;
- if (res_csize >= wim_resource_size(cur_lte)) {
- /* Oops! We compressed the resource to
- * larger than the original size. Write
- * the resource uncompressed instead. */
- ret = write_uncompressed_resource_and_truncate(
- cur_lte,
- out_fp,
- cur_chunk_tab->file_offset,
- &cur_lte->output_resource_entry);
- if (ret != 0)
- goto out;
- } else {
- cur_lte->output_resource_entry.size =
- res_csize;
-
- cur_lte->output_resource_entry.original_size =
- cur_lte->resource_entry.original_size;
-
- cur_lte->output_resource_entry.offset =
- cur_chunk_tab->file_offset;
-
- cur_lte->output_resource_entry.flags =
- cur_lte->resource_entry.flags |
- WIM_RESHDR_FLAG_COMPRESSED;
- }
+ /* Check for resources compressed to greater than or
+ * equal to their original size and write them
+ * uncompressed instead. (But never do this if writing
+ * to a pipe.) */
+ if (res_csize >= wim_resource_size(cur_lte) &&
+ !(ctx->write_resource_flags & WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE))
+ {
+ DEBUG("Compressed %"PRIu64" => %"PRIu64" bytes; "
+ "writing uncompressed instead",
+ wim_resource_size(cur_lte), res_csize);
+ ret = seek_and_truncate(ctx->out_fd, ctx->res_start_offset);
+ if (ret)
+ return ret;
+ ret = write_wim_resource(cur_lte,
+ ctx->out_fd,
+ WIMLIB_COMPRESSION_TYPE_NONE,
+ 0,
+ &cur_lte->output_resource_entry,
+ ctx->write_resource_flags,
+ ctx->comp_ctx);
+ if (ret)
+ return ret;
+ } else {
+ cur_lte->output_resource_entry.size =
+ res_csize;
- do_write_streams_progress(progress, progress_func,
- wim_resource_size(cur_lte));
-
- FREE(cur_chunk_tab);
- cur_chunk_tab = NULL;
-
- struct list_head *next = cur_lte->staging_list.next;
- list_del(&cur_lte->staging_list);
-
- if (next == &outstanding_resources)
- cur_lte = NULL;
- else
- cur_lte = container_of(cur_lte->staging_list.next,
- struct wim_lookup_table_entry,
- staging_list);
-
- // Since we just finished writing a stream,
- // write any streams that have been added to the
- // my_resources list for direct writing by the
- // main thread (e.g. resources that don't need
- // to be compressed because the desired
- // compression type is the same as the previous
- // compression type).
- ret = do_write_stream_list(&my_resources,
- out_fp,
- out_ctype,
- progress_func,
- progress,
- 0);
- if (ret != 0)
- goto out;
- }
- }
- }
+ cur_lte->output_resource_entry.original_size =
+ cur_lte->resource_entry.original_size;
-out:
- if (ret == WIMLIB_ERR_NOMEM) {
- ERROR("Could not allocate enough memory for "
- "multi-threaded compression");
- }
+ cur_lte->output_resource_entry.offset =
+ ctx->res_start_offset;
- if (next_lte) {
-#ifdef WITH_NTFS_3G
- end_wim_resource_read(next_lte, ni);
-#else
- end_wim_resource_read(next_lte);
-#endif
- }
+ cur_lte->output_resource_entry.flags =
+ cur_lte->resource_entry.flags |
+ WIM_RESHDR_FLAG_COMPRESSED;
- if (ret == 0) {
- ret = do_write_stream_list(&my_resources, out_fp,
- out_ctype, progress_func,
- progress, 0);
- } else {
- if (msgs) {
- size_t num_available_msgs = 0;
- struct list_head *cur;
+ DEBUG("Wrote compressed resource "
+ "(%"PRIu64" => %"PRIu64" bytes @ +%"PRIu64", flags=0x%02x)",
+ cur_lte->output_resource_entry.original_size,
+ cur_lte->output_resource_entry.size,
+ cur_lte->output_resource_entry.offset,
+ cur_lte->output_resource_entry.flags);
+ }
- list_for_each(cur, &available_msgs) {
- num_available_msgs++;
+ do_write_streams_progress(ctx->progress_data,
+ cur_lte, false);
+
+ /* Since we just finished writing a stream, write any
+ * streams that have been added to the serial_streams
+ * list for direct writing by the main thread (e.g.
+ * resources that don't need to be compressed because
+ * the desired compression type is the same as the
+ * previous compression type). */
+ if (!list_empty(&ctx->serial_streams)) {
+ ret = do_write_stream_list_serial(&ctx->serial_streams,
+ ctx->lookup_table,
+ ctx->out_fd,
+ ctx->out_ctype,
+ ctx->out_chunk_size,
+ ctx->comp_ctx,
+ ctx->write_resource_flags,
+ ctx->progress_data);
+ if (ret)
+ return ret;
}
- while (num_available_msgs < num_messages) {
- shared_queue_get(compressed_res_queue);
- num_available_msgs++;
+ /* Advance to the next stream to write. */
+ if (list_empty(&ctx->outstanding_streams)) {
+ cur_lte = NULL;
+ } else {
+ cur_lte = container_of(ctx->outstanding_streams.next,
+ struct wim_lookup_table_entry,
+ being_compressed_list);
}
}
}
+ return 0;
+}
- if (msgs) {
- for (size_t i = 0; i < num_messages; i++) {
- for (size_t j = 0; j < MAX_CHUNKS_PER_MSG; j++) {
- FREE(msgs[i].compressed_chunks[j]);
- FREE(msgs[i].uncompressed_chunks[j]);
- }
+/* Called when the main thread has read a new chunk of data. */
+static int
+main_writer_thread_cb(const void *chunk, size_t chunk_size, void *_ctx)
+{
+ struct main_writer_thread_ctx *ctx = _ctx;
+ int ret;
+ struct message *next_msg;
+ u64 next_chunk_in_msg;
+
+ /* Update SHA1 message digest for the stream currently being read by the
+ * main thread. */
+ sha1_update(&ctx->next_sha_ctx, chunk, chunk_size);
+
+ /* We send chunks of data to the compressor chunks in batches which we
+ * refer to as "messages". @next_msg is the message that is currently
+ * being prepared to send off. If it is NULL, that indicates that we
+ * need to start a new message. */
+ next_msg = ctx->next_msg;
+ if (!next_msg) {
+ /* We need to start a new message. First check to see if there
+ * is a message available in the list of available messages. If
+ * so, we can just take one. If not, all the messages (there is
+ * a fixed number of them, proportional to the number of
+ * threads) have been sent off to the compressor threads, so we
+ * receive messages from the compressor threads containing
+ * compressed chunks of data.
+ *
+ * We may need to receive multiple messages before one is
+ * actually available to use because messages received that are
+ * *not* for the very next set of chunks to compress must be
+ * buffered until it's time to write those chunks. */
+ while (list_empty(&ctx->available_msgs)) {
+ ret = receive_compressed_chunks(ctx);
+ if (ret)
+ return ret;
}
- FREE(msgs);
+
+ next_msg = container_of(ctx->available_msgs.next,
+ struct message, list);
+ list_del(&next_msg->list);
+ next_msg->complete = false;
+ next_msg->begin_chunk = ctx->next_chunk;
+ next_msg->num_chunks = min(MAX_CHUNKS_PER_MSG,
+ ctx->next_num_chunks - ctx->next_chunk);
+ ctx->next_msg = next_msg;
+ }
+
+ /* Fill in the next chunk to compress */
+ next_chunk_in_msg = ctx->next_chunk - next_msg->begin_chunk;
+
+ next_msg->uncompressed_chunk_sizes[next_chunk_in_msg] = chunk_size;
+ memcpy(next_msg->uncompressed_chunks[next_chunk_in_msg],
+ chunk, chunk_size);
+ ctx->next_chunk++;
+ if (++next_chunk_in_msg == next_msg->num_chunks) {
+ /* Send off an array of chunks to compress */
+ list_add_tail(&next_msg->list, &ctx->next_lte->msg_list);
+ shared_queue_put(ctx->res_to_compress_queue, next_msg);
+ ++ctx->num_outstanding_messages;
+ ctx->next_msg = NULL;
+ }
+ return 0;
+}
+
+static int
+main_writer_thread_finish(void *_ctx)
+{
+ struct main_writer_thread_ctx *ctx = _ctx;
+ int ret;
+ while (ctx->num_outstanding_messages != 0) {
+ ret = receive_compressed_chunks(ctx);
+ if (ret)
+ return ret;
}
+ wimlib_assert(list_empty(&ctx->outstanding_streams));
+ return do_write_stream_list_serial(&ctx->serial_streams,
+ ctx->lookup_table,
+ ctx->out_fd,
+ ctx->out_ctype,
+ ctx->out_chunk_size,
+ ctx->comp_ctx,
+ ctx->write_resource_flags,
+ ctx->progress_data);
+}
+
+static int
+submit_stream_for_compression(struct wim_lookup_table_entry *lte,
+ struct main_writer_thread_ctx *ctx)
+{
+ int ret;
+
+ /* Read the entire stream @lte, feeding its data chunks to the
+ * compressor threads. Also SHA1-sum the stream; this is required in
+ * the case that @lte is unhashed, and a nice additional verification
+ * when @lte is already hashed. */
+ sha1_init(&ctx->next_sha_ctx);
+ ctx->next_chunk = 0;
+ ctx->next_num_chunks = DIV_ROUND_UP(wim_resource_size(lte),
+ ctx->out_chunk_size);
+ ctx->next_lte = lte;
+ INIT_LIST_HEAD(<e->msg_list);
+ list_add_tail(<e->being_compressed_list, &ctx->outstanding_streams);
+ ret = read_resource_prefix(lte, wim_resource_size(lte),
+ main_writer_thread_cb,
+ ctx->out_chunk_size, ctx, 0);
+ if (ret)
+ return ret;
+ wimlib_assert(ctx->next_chunk == ctx->next_num_chunks);
+ return finalize_and_check_sha1(&ctx->next_sha_ctx, lte);
+}
+
+static int
+main_thread_process_next_stream(struct wim_lookup_table_entry *lte, void *_ctx)
+{
+ struct main_writer_thread_ctx *ctx = _ctx;
+ int ret;
- FREE(cur_chunk_tab);
+ if (wim_resource_size(lte) < 1000 ||
+ !must_compress_stream(lte, ctx->write_resource_flags,
+ ctx->out_ctype, ctx->out_chunk_size))
+ {
+ /* Stream is too small or isn't being compressed. Process it by
+ * the main thread when we have a chance. We can't necessarily
+ * process it right here, as the main thread could be in the
+ * middle of writing a different stream. */
+ list_add_tail(<e->write_streams_list, &ctx->serial_streams);
+ lte->deferred = 1;
+ ret = 0;
+ } else {
+ ret = submit_stream_for_compression(lte, ctx);
+ }
+ lte->no_progress = 1;
return ret;
}
static long
-get_default_num_threads()
+get_default_num_threads(void)
{
#ifdef __WIN32__
return win32_get_number_of_processors();
#endif
}
+/* Equivalent to write_stream_list_serial(), except this takes a @num_threads
+ * parameter and will perform compression using that many threads. Falls
+ * back to write_stream_list_serial() on certain errors, such as a failure to
+ * create the number of threads requested.
+ *
+ * High level description of the algorithm for writing compressed streams in
+ * parallel: We perform compression on chunks rather than on full files. The
+ * currently executing thread becomes the main thread and is entirely in charge
+ * of reading the data to compress (which may be in any location understood by
+ * the resource code--- such as in an external file being captured, or in
+ * another WIM file from which an image is being exported) and actually writing
+ * the compressed data to the output file. Additional threads are "compressor
+ * threads" and all execute the compressor_thread_proc, where they repeatedly
+ * retrieve buffers of data from the main thread, compress them, and hand them
+ * back to the main thread.
+ *
+ * Certain streams, such as streams that do not need to be compressed (e.g.
+ * input compression type same as output compression type) or streams of very
+ * small size are placed in a list (main_writer_thread_ctx.serial_list) and
+ * handled entirely by the main thread at an appropriate time.
+ *
+ * At any given point in time, multiple streams may be having chunks compressed
+ * concurrently. The stream that the main thread is currently *reading* may be
+ * later in the list that the stream that the main thread is currently
+ * *writing*. */
static int
write_stream_list_parallel(struct list_head *stream_list,
struct wim_lookup_table *lookup_table,
- FILE *out_fp,
+ struct filedes *out_fd,
int out_ctype,
- int write_flags,
- unsigned num_threads,
- wimlib_progress_func_t progress_func,
- union wimlib_progress_info *progress)
+ u32 out_chunk_size,
+ struct wimlib_lzx_context **comp_ctx,
+ int write_resource_flags,
+ struct write_streams_progress_data *progress_data,
+ unsigned num_threads)
{
int ret;
struct shared_queue res_to_compress_queue;
struct shared_queue compressed_res_queue;
pthread_t *compressor_threads = NULL;
+ union wimlib_progress_info *progress = &progress_data->progress;
+ unsigned num_started_threads;
+ bool can_retry = true;
if (num_threads == 0) {
long nthreads = get_default_num_threads();
if (nthreads < 1 || nthreads > UINT_MAX) {
WARNING("Could not determine number of processors! Assuming 1");
- goto out_serial;
+ goto out_serial_quiet;
+ } else if (nthreads == 1) {
+ goto out_serial_quiet;
} else {
num_threads = nthreads;
}
}
+ DEBUG("Writing stream list of size %"PRIu64" "
+ "(parallel version, num_threads=%u)",
+ progress->write_streams.total_streams, num_threads);
+
progress->write_streams.num_threads = num_threads;
- wimlib_assert(stream_list->next != stream_list);
- static const double MESSAGES_PER_THREAD = 2.0;
+ static const size_t MESSAGES_PER_THREAD = 2;
size_t queue_size = (size_t)(num_threads * MESSAGES_PER_THREAD);
DEBUG("Initializing shared queues (queue_size=%zu)", queue_size);
ret = shared_queue_init(&res_to_compress_queue, queue_size);
- if (ret != 0)
+ if (ret)
goto out_serial;
ret = shared_queue_init(&compressed_res_queue, queue_size);
- if (ret != 0)
+ if (ret)
goto out_destroy_res_to_compress_queue;
- struct compressor_thread_params params;
- params.res_to_compress_queue = &res_to_compress_queue;
- params.compressed_res_queue = &compressed_res_queue;
- params.compress = get_compress_func(out_ctype);
+ struct compressor_thread_params *params;
- compressor_threads = MALLOC(num_threads * sizeof(pthread_t));
- if (!compressor_threads) {
+ params = CALLOC(num_threads, sizeof(params[0]));
+ if (params == NULL) {
ret = WIMLIB_ERR_NOMEM;
goto out_destroy_compressed_res_queue;
}
for (unsigned i = 0; i < num_threads; i++) {
- DEBUG("pthread_create thread %u", i);
+ params[i].res_to_compress_queue = &res_to_compress_queue;
+ params[i].compressed_res_queue = &compressed_res_queue;
+ params[i].out_ctype = out_ctype;
+ if (out_ctype == WIMLIB_COMPRESSION_TYPE_LZX) {
+ ret = wimlib_lzx_alloc_context(out_chunk_size,
+ NULL, ¶ms[i].comp_ctx);
+ if (ret)
+ goto out_free_params;
+ }
+ }
+
+ compressor_threads = MALLOC(num_threads * sizeof(pthread_t));
+ if (compressor_threads == NULL) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_free_params;
+ }
+
+ for (unsigned i = 0; i < num_threads; i++) {
+ DEBUG("pthread_create thread %u of %u", i + 1, num_threads);
ret = pthread_create(&compressor_threads[i], NULL,
- compressor_thread_proc, ¶ms);
- if (ret != 0) {
+ compressor_thread_proc, ¶ms[i]);
+ if (ret) {
+ errno = ret;
ret = -1;
ERROR_WITH_ERRNO("Failed to create compressor "
- "thread %u", i);
- num_threads = i;
+ "thread %u of %u",
+ i + 1, num_threads);
+ num_started_threads = i;
goto out_join;
}
}
+ num_started_threads = num_threads;
- if (progress_func)
- progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS, progress);
-
- ret = main_writer_thread_proc(stream_list,
- out_fp,
- out_ctype,
- &res_to_compress_queue,
- &compressed_res_queue,
- queue_size,
- write_flags,
- progress_func,
- progress);
+ if (progress_data->progress_func) {
+ progress_data->progress_func(WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
+ progress);
+ }
+
+ struct main_writer_thread_ctx ctx;
+
+ memset(&ctx, 0, sizeof(ctx));
+
+ ctx.stream_list = stream_list;
+ ctx.lookup_table = lookup_table;
+ ctx.out_fd = out_fd;
+ ctx.out_ctype = out_ctype;
+ ctx.out_chunk_size = out_chunk_size;
+ ctx.comp_ctx = comp_ctx;
+ ctx.res_to_compress_queue = &res_to_compress_queue;
+ ctx.compressed_res_queue = &compressed_res_queue;
+ ctx.num_messages = queue_size;
+ ctx.write_resource_flags = write_resource_flags;
+ ctx.progress_data = progress_data;
+ ret = main_writer_thread_init_ctx(&ctx);
+ if (ret)
+ goto out_join;
+
+ can_retry = false;
+ ret = do_write_stream_list(stream_list, lookup_table,
+ main_thread_process_next_stream,
+ &ctx, progress_data);
+ if (ret)
+ goto out_destroy_ctx;
+
+ /* The main thread has finished reading all streams that are going to be
+ * compressed in parallel, and it now needs to wait for all remaining
+ * chunks to be compressed so that the remaining streams can actually be
+ * written to the output file. Furthermore, any remaining streams that
+ * had processing deferred to the main thread need to be handled. These
+ * tasks are done by the main_writer_thread_finish() function. */
+ ret = main_writer_thread_finish(&ctx);
+out_destroy_ctx:
+ main_writer_thread_destroy_ctx(&ctx);
out_join:
- for (unsigned i = 0; i < num_threads; i++)
+ for (unsigned i = 0; i < num_started_threads; i++)
shared_queue_put(&res_to_compress_queue, NULL);
- for (unsigned i = 0; i < num_threads; i++) {
+ for (unsigned i = 0; i < num_started_threads; i++) {
if (pthread_join(compressor_threads[i], NULL)) {
WARNING_WITH_ERRNO("Failed to join compressor "
- "thread %u", i);
+ "thread %u of %u",
+ i + 1, num_threads);
}
}
FREE(compressor_threads);
+out_free_params:
+ for (unsigned i = 0; i < num_threads; i++)
+ wimlib_lzx_free_context(params[i].comp_ctx);
+ FREE(params);
out_destroy_compressed_res_queue:
shared_queue_destroy(&compressed_res_queue);
out_destroy_res_to_compress_queue:
shared_queue_destroy(&res_to_compress_queue);
- if (ret >= 0 && ret != WIMLIB_ERR_NOMEM)
+ if (!can_retry || (ret >= 0 && ret != WIMLIB_ERR_NOMEM))
return ret;
out_serial:
WARNING("Falling back to single-threaded compression");
+out_serial_quiet:
return write_stream_list_serial(stream_list,
lookup_table,
- out_fp,
+ out_fd,
out_ctype,
- write_flags,
- progress_func,
- progress);
+ out_chunk_size,
+ comp_ctx,
+ write_resource_flags,
+ progress_data);
}
#endif
-/*
- * Write a list of streams to a WIM (@out_fp) using the compression type
- * @out_ctype and up to @num_threads compressor threads.
- */
+/* Write a list of streams to a WIM (@out_fd) using the compression type
+ * @out_ctype, chunk size @out_chunk_size, and up to @num_threads compressor
+ * threads. */
static int
write_stream_list(struct list_head *stream_list,
struct wim_lookup_table *lookup_table,
- FILE *out_fp, int out_ctype, int write_flags,
+ struct filedes *out_fd, int out_ctype,
+ u32 out_chunk_size,
+ struct wimlib_lzx_context **comp_ctx,
+ int write_flags,
unsigned num_threads, wimlib_progress_func_t progress_func)
{
- struct wim_lookup_table_entry *lte;
- size_t num_streams = 0;
- u64 total_bytes = 0;
- u64 total_compression_bytes = 0;
- union wimlib_progress_info progress;
int ret;
+ int write_resource_flags;
+ u64 total_bytes;
+ u64 total_compression_bytes;
+ unsigned total_parts;
+ WIMStruct *prev_wim_part;
+ size_t num_streams;
+ struct wim_lookup_table_entry *lte;
+ struct write_streams_progress_data progress_data;
+
+ if (list_empty(stream_list)) {
+ DEBUG("No streams to write.");
+ return 0;
+ }
+
+ write_resource_flags = write_flags_to_resource_flags(write_flags);
+
+ DEBUG("Writing stream list (offset = %"PRIu64", write_resource_flags=0x%08x)",
+ out_fd->offset, write_resource_flags);
+ /* Sort the stream list into a good order for reading. */
+ ret = sort_stream_list_by_sequential_order(stream_list,
+ offsetof(struct wim_lookup_table_entry,
+ write_streams_list));
+ if (ret)
+ return ret;
+
+ /* Calculate the total size of the streams to be written. Note: this
+ * will be the uncompressed size, as we may not know the compressed size
+ * yet, and also this will assume that every unhashed stream will be
+ * written (which will not necessarily be the case). */
+ total_bytes = 0;
+ total_compression_bytes = 0;
+ num_streams = 0;
+ total_parts = 0;
+ prev_wim_part = NULL;
list_for_each_entry(lte, stream_list, write_streams_list) {
num_streams++;
total_bytes += wim_resource_size(lte);
- if (out_ctype != WIMLIB_COMPRESSION_TYPE_NONE
- && (wim_resource_compression_type(lte) != out_ctype ||
- (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)))
- {
+ if (must_compress_stream(lte, write_resource_flags,
+ out_ctype, out_chunk_size))
total_compression_bytes += wim_resource_size(lte);
+ if (lte->resource_location == RESOURCE_IN_WIM) {
+ if (prev_wim_part != lte->wim) {
+ prev_wim_part = lte->wim;
+ total_parts++;
+ }
}
}
- progress.write_streams.total_bytes = total_bytes;
- progress.write_streams.total_streams = num_streams;
- progress.write_streams.completed_bytes = 0;
- progress.write_streams.completed_streams = 0;
- progress.write_streams.num_threads = num_threads;
- progress.write_streams.compression_type = out_ctype;
- progress.write_streams._private = 0;
+
+ memset(&progress_data, 0, sizeof(progress_data));
+ progress_data.progress_func = progress_func;
+
+ progress_data.progress.write_streams.total_bytes = total_bytes;
+ progress_data.progress.write_streams.total_streams = num_streams;
+ progress_data.progress.write_streams.completed_bytes = 0;
+ progress_data.progress.write_streams.completed_streams = 0;
+ progress_data.progress.write_streams.num_threads = num_threads;
+ progress_data.progress.write_streams.compression_type = out_ctype;
+ progress_data.progress.write_streams.total_parts = total_parts;
+ progress_data.progress.write_streams.completed_parts = 0;
+
+ progress_data.next_progress = 0;
+ progress_data.prev_wim_part = NULL;
#ifdef ENABLE_MULTITHREADED_COMPRESSION
- if (total_compression_bytes >= 1000000 && num_threads != 1)
+ if (total_compression_bytes >= 2000000 && num_threads != 1)
ret = write_stream_list_parallel(stream_list,
lookup_table,
- out_fp,
+ out_fd,
out_ctype,
- write_flags,
- num_threads,
- progress_func,
- &progress);
+ out_chunk_size,
+ comp_ctx,
+ write_resource_flags,
+ &progress_data,
+ num_threads);
else
#endif
ret = write_stream_list_serial(stream_list,
lookup_table,
- out_fp,
+ out_fd,
out_ctype,
- write_flags,
- progress_func,
- &progress);
+ out_chunk_size,
+ comp_ctx,
+ write_resource_flags,
+ &progress_data);
+ if (ret == 0)
+ DEBUG("Successfully wrote stream list.");
+ else
+ DEBUG("Failed to write stream list (ret=%d).", ret);
return ret;
}
-struct lte_overwrite_prepare_args {
- WIMStruct *wim;
- off_t end_offset;
- struct list_head *stream_list;
-};
-
-static int
-lte_overwrite_prepare(struct wim_lookup_table_entry *lte, void *arg)
-{
- struct lte_overwrite_prepare_args *args = arg;
-
- if (lte->resource_location == RESOURCE_IN_WIM &&
- lte->wim == args->wim &&
- lte->resource_entry.offset + lte->resource_entry.size > args->end_offset)
- {
- #ifdef ENABLE_ERROR_MESSAGES
- ERROR("The following resource is after the XML data:");
- print_lookup_table_entry(lte, stderr);
- #endif
- return WIMLIB_ERR_RESOURCE_ORDER;
- }
-
- lte->out_refcnt = lte->refcnt;
- memcpy(<e->output_resource_entry, <e->resource_entry,
- sizeof(struct resource_entry));
- if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_METADATA))
- if (lte->resource_location != RESOURCE_IN_WIM || lte->wim != args->wim)
- list_add(<e->staging_list, args->stream_list);
- return 0;
-}
-
-static int
-wim_prepare_streams(WIMStruct *wim, off_t end_offset,
- struct list_head *stream_list)
-{
- struct lte_overwrite_prepare_args args = {
- .wim = wim,
- .end_offset = end_offset,
- .stream_list = stream_list,
- };
- int ret;
-
- for (int i = 0; i < wim->hdr.image_count; i++) {
- ret = lte_overwrite_prepare(wim->image_metadata[i]->metadata_lte,
- &args);
- if (ret)
- return ret;
- }
- return for_lookup_table_entry(wim->lookup_table,
- lte_overwrite_prepare, &args);
-}
-
struct stream_size_table {
struct hlist_head *array;
size_t num_entries;
{
struct stream_size_table *tab = _tab;
size_t pos;
- struct wim_lookup_table_entry *hashed_lte;
+ struct wim_lookup_table_entry *same_size_lte;
struct hlist_node *tmp;
- pos = hash_u64(wim_resource_size(lte)) % tab->capacity;
+ pos = hash_u64(wim_resource_size(lte)) % tab->capacity;
lte->unique_size = 1;
- hlist_for_each_entry(hashed_lte, tmp, &tab->array[pos], hash_list_2) {
- if (wim_resource_size(hashed_lte) == wim_resource_size(lte)) {
+ hlist_for_each_entry(same_size_lte, tmp, &tab->array[pos], hash_list_2) {
+ if (wim_resource_size(same_size_lte) == wim_resource_size(lte)) {
lte->unique_size = 0;
- hashed_lte->unique_size = 0;
+ same_size_lte->unique_size = 0;
break;
}
}
return 0;
}
-
struct find_streams_ctx {
+ WIMStruct *wim;
+ int write_flags;
struct list_head stream_list;
struct stream_size_table stream_size_tab;
};
+static void
+lte_reference_for_logical_write(struct wim_lookup_table_entry *lte,
+ struct find_streams_ctx *ctx,
+ unsigned nref)
+{
+ if (lte->out_refcnt == 0) {
+ stream_size_table_insert(lte, &ctx->stream_size_tab);
+ list_add_tail(<e->write_streams_list, &ctx->stream_list);
+ }
+ lte->out_refcnt += nref;
+}
+
+static int
+do_lte_full_reference_for_logical_write(struct wim_lookup_table_entry *lte,
+ void *_ctx)
+{
+ struct find_streams_ctx *ctx = _ctx;
+ lte->out_refcnt = 0;
+ lte_reference_for_logical_write(lte, ctx,
+ (lte->refcnt ? lte->refcnt : 1));
+ return 0;
+}
+
static int
inode_find_streams_to_write(struct wim_inode *inode,
struct wim_lookup_table *table,
- struct list_head *stream_list,
- struct stream_size_table *tab)
+ struct find_streams_ctx *ctx)
{
struct wim_lookup_table_entry *lte;
- for (unsigned i = 0; i <= inode->i_num_ads; i++) {
+ unsigned i;
+
+ for (i = 0; i <= inode->i_num_ads; i++) {
lte = inode_stream_lte(inode, i, table);
- if (lte) {
- if (lte->out_refcnt == 0) {
- if (lte->unhashed)
- stream_size_table_insert(lte, tab);
- list_add_tail(<e->write_streams_list, stream_list);
- }
- lte->out_refcnt += inode->i_nlink;
- }
+ if (lte)
+ lte_reference_for_logical_write(lte, ctx, inode->i_nlink);
+ else if (!is_zero_hash(inode_stream_hash(inode, i)))
+ return WIMLIB_ERR_RESOURCE_NOT_FOUND;
}
return 0;
}
static int
-image_find_streams_to_write(WIMStruct *w)
+image_find_streams_to_write(WIMStruct *wim)
{
- struct wim_image_metadata *imd;
struct find_streams_ctx *ctx;
+ struct wim_image_metadata *imd;
struct wim_inode *inode;
struct wim_lookup_table_entry *lte;
+ int ret;
- ctx = w->private;
- imd = wim_get_current_image_metadata(w);
+ ctx = wim->private;
+ imd = wim_get_current_image_metadata(wim);
- image_for_each_unhashed_stream(lte, imd) {
+ image_for_each_unhashed_stream(lte, imd)
lte->out_refcnt = 0;
- wimlib_assert(lte->unhashed);
- wimlib_assert(lte->my_ptr != NULL);
- }
/* Go through this image's inodes to find any streams that have not been
* found yet. */
image_for_each_inode(inode, imd) {
- inode_find_streams_to_write(inode, w->lookup_table,
- &ctx->stream_list,
- &ctx->stream_size_tab);
+ ret = inode_find_streams_to_write(inode, wim->lookup_table, ctx);
+ if (ret)
+ return ret;
}
return 0;
}
-/* Given a WIM that from which one or all of the images is being written, build
- * the list of unique streams ('struct wim_lookup_table_entry's) that must be
- * written, plus any unhashed streams that need to be written but may be
- * identical to other hashed or unhashed streams being written. These unhashed
- * streams are checksummed while the streams are being written. To aid this
- * process, the member @unique_size is set to 1 on streams that have a unique
- * size and therefore must be written.
+/*
+ * Build a list of streams (via `struct wim_lookup_table_entry's) included in
+ * the "logical write" of the WIM, meaning all streams that are referenced at
+ * least once by dentries in the the image(s) being written. 'out_refcnt' on
+ * each stream being included in the logical write is set to the number of
+ * references from dentries in the image(s). Furthermore, 'unique_size' on each
+ * stream being included in the logical write is set to indicate whether that
+ * stream has a unique size relative to the streams being included in the
+ * logical write. Still furthermore, 'part_number' on each stream being
+ * included in the logical write is set to the part number given in the
+ * in-memory header of @p wim.
*
- * The out_refcnt member of each 'struct wim_lookup_table_entry' is set to
- * indicate the number of times the stream is referenced in only the streams
- * that are being written; this may still be adjusted later when unhashed
- * streams are being resolved.
+ * This is considered a "logical write" because it does not take into account
+ * filtering out streams already present in the WIM (in the case of an in place
+ * overwrite) or present in other WIMs (in case of creating delta WIM).
*/
static int
-prepare_stream_list(WIMStruct *wim, int image, struct list_head *stream_list)
+prepare_logical_stream_list(WIMStruct *wim, int image, bool streams_ok,
+ struct find_streams_ctx *ctx)
{
int ret;
- struct find_streams_ctx ctx;
+ struct wim_lookup_table_entry *lte;
- for_lookup_table_entry(wim->lookup_table, lte_zero_out_refcnt, NULL);
- ret = init_stream_size_table(&ctx.stream_size_tab, 9001);
- if (ret)
- return ret;
- for_lookup_table_entry(wim->lookup_table, stream_size_table_insert,
- &ctx.stream_size_tab);
- INIT_LIST_HEAD(&ctx.stream_list);
- wim->private = &ctx;
- for_image(wim, image, image_find_streams_to_write);
- destroy_stream_size_table(&ctx.stream_size_tab);
+ if (streams_ok && (image == WIMLIB_ALL_IMAGES ||
+ (image == 1 && wim->hdr.image_count == 1)))
+ {
+ /* Fast case: Assume that all streams are being written and
+ * that the reference counts are correct. */
+ struct wim_lookup_table_entry *lte;
+ struct wim_image_metadata *imd;
+ unsigned i;
+
+ for_lookup_table_entry(wim->lookup_table,
+ do_lte_full_reference_for_logical_write, ctx);
+ for (i = 0; i < wim->hdr.image_count; i++) {
+ imd = wim->image_metadata[i];
+ image_for_each_unhashed_stream(lte, imd)
+ do_lte_full_reference_for_logical_write(lte, ctx);
+ }
+ } else {
+ /* Slow case: Walk through the images being written and
+ * determine the streams referenced. */
+ for_lookup_table_entry(wim->lookup_table, lte_zero_out_refcnt, NULL);
+ wim->private = ctx;
+ ret = for_image(wim, image, image_find_streams_to_write);
+ if (ret)
+ return ret;
+ }
- INIT_LIST_HEAD(stream_list);
- list_splice(&ctx.stream_list, stream_list);
+ list_for_each_entry(lte, &ctx->stream_list, write_streams_list)
+ lte->part_number = wim->hdr.part_number;
return 0;
}
-/* Writes the streams for the specified @image in @wim to @wim->out_fp.
- */
static int
-write_wim_streams(WIMStruct *wim, int image, int write_flags,
- unsigned num_threads,
- wimlib_progress_func_t progress_func)
+process_filtered_stream(struct wim_lookup_table_entry *lte, void *_ctx)
{
- int ret;
- struct list_head stream_list;
+ struct find_streams_ctx *ctx = _ctx;
+ u16 filtered = 0;
+
+ /* Calculate and set lte->filtered. */
+ if (lte->resource_location == RESOURCE_IN_WIM) {
+ if (lte->wim == ctx->wim &&
+ (ctx->write_flags & WIMLIB_WRITE_FLAG_OVERWRITE))
+ filtered |= FILTERED_SAME_WIM;
+ if (lte->wim != ctx->wim &&
+ (ctx->write_flags & WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS))
+ filtered |= FILTERED_EXTERNAL_WIM;
+ }
+ lte->filtered = filtered;
+
+ /* Filtered streams get inserted into the stream size table too, unless
+ * they already were. This is because streams that are checksummed
+ * on-the-fly during the write should not be written if they are
+ * duplicates of filtered stream. */
+ if (lte->filtered && lte->out_refcnt == 0)
+ stream_size_table_insert(lte, &ctx->stream_size_tab);
+ return 0;
+}
+
+static int
+mark_stream_not_filtered(struct wim_lookup_table_entry *lte, void *_ignore)
+{
+ lte->filtered = 0;
+ return 0;
+}
+
+/* Given the list of streams to include in a logical write of a WIM, handle
+ * filtering out streams already present in the WIM or already present in
+ * external WIMs, depending on the write flags provided. */
+static void
+handle_stream_filtering(struct find_streams_ctx *ctx)
+{
+ struct wim_lookup_table_entry *lte, *tmp;
+
+ if (!(ctx->write_flags & (WIMLIB_WRITE_FLAG_OVERWRITE |
+ WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS)))
+ {
+ for_lookup_table_entry(ctx->wim->lookup_table,
+ mark_stream_not_filtered, ctx);
+ return;
+ }
+
+ for_lookup_table_entry(ctx->wim->lookup_table,
+ process_filtered_stream, ctx);
- ret = prepare_stream_list(wim, image, &stream_list);
+ /* Streams in logical write list that were filtered can be removed. */
+ list_for_each_entry_safe(lte, tmp, &ctx->stream_list,
+ write_streams_list)
+ if (lte->filtered)
+ list_del(<e->write_streams_list);
+}
+
+/* Prepares list of streams to write for the specified WIM image(s). This wraps
+ * around prepare_logical_stream_list() to handle filtering out streams already
+ * present in the WIM or already present in external WIMs, depending on the
+ * write flags provided.
+ *
+ * Note: some additional data is stored in each `struct wim_lookup_table_entry':
+ *
+ * - 'out_refcnt' is set to the number of references found for the logical write.
+ * This will be nonzero on all streams in the list returned by this function,
+ * but will also be nonzero on streams not in the list that were included in
+ * the logical write list, but filtered out from the returned list.
+ * - 'filtered' is set to nonzero if the stream was filtered. Filtered streams
+ * are not included in the list of streams returned by this function.
+ * - 'unique_size' is set if the stream has a unique size among all streams in
+ * the logical write plus any filtered streams in the entire WIM that could
+ * potentially turn out to have the same checksum as a yet-to-be-checksummed
+ * stream being written.
+ */
+static int
+prepare_stream_list(WIMStruct *wim, int image, int write_flags,
+ struct list_head *stream_list)
+{
+ int ret;
+ bool streams_ok;
+ struct find_streams_ctx ctx;
+
+ INIT_LIST_HEAD(&ctx.stream_list);
+ ret = init_stream_size_table(&ctx.stream_size_tab,
+ wim->lookup_table->capacity);
if (ret)
return ret;
- return write_stream_list(&stream_list,
+ ctx.write_flags = write_flags;
+ ctx.wim = wim;
+
+ streams_ok = ((write_flags & WIMLIB_WRITE_FLAG_STREAMS_OK) != 0);
+
+ ret = prepare_logical_stream_list(wim, image, streams_ok, &ctx);
+ if (ret)
+ goto out_destroy_table;
+
+ handle_stream_filtering(&ctx);
+ list_transfer(&ctx.stream_list, stream_list);
+ ret = 0;
+out_destroy_table:
+ destroy_stream_size_table(&ctx.stream_size_tab);
+ return ret;
+}
+
+static int
+write_wim_streams(WIMStruct *wim, int image, int write_flags,
+ unsigned num_threads,
+ wimlib_progress_func_t progress_func,
+ struct list_head *stream_list_override)
+{
+ int ret;
+ struct list_head _stream_list;
+ struct list_head *stream_list;
+ struct wim_lookup_table_entry *lte;
+
+ if (stream_list_override == NULL) {
+ /* Normal case: prepare stream list from image(s) being written.
+ */
+ stream_list = &_stream_list;
+ ret = prepare_stream_list(wim, image, write_flags, stream_list);
+ if (ret)
+ return ret;
+ } else {
+ /* Currently only as a result of wimlib_split() being called:
+ * use stream list already explicitly provided. Use existing
+ * reference counts. */
+ stream_list = stream_list_override;
+ list_for_each_entry(lte, stream_list, write_streams_list) {
+ lte->out_refcnt = (lte->refcnt ? lte->refcnt : 1);
+ lte->part_number = wim->hdr.part_number;
+ }
+ }
+
+ return write_stream_list(stream_list,
wim->lookup_table,
- wim->out_fp,
- wimlib_get_compression_type(wim),
+ &wim->out_fd,
+ wim->out_compression_type,
+ wim->out_chunk_size,
+ &wim->lzx_context,
write_flags,
num_threads,
progress_func);
}
+static int
+write_wim_metadata_resources(WIMStruct *wim, int image, int write_flags,
+ wimlib_progress_func_t progress_func)
+{
+ int ret;
+ int start_image;
+ int end_image;
+ int write_resource_flags;
+
+ if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA) {
+ DEBUG("Not writing any metadata resources.");
+ return 0;
+ }
+
+ write_resource_flags = write_flags_to_resource_flags(write_flags);
+
+ DEBUG("Writing metadata resources (offset=%"PRIu64")",
+ wim->out_fd.offset);
+
+ if (progress_func)
+ progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, NULL);
+
+ if (image == WIMLIB_ALL_IMAGES) {
+ start_image = 1;
+ end_image = wim->hdr.image_count;
+ } else {
+ start_image = image;
+ end_image = image;
+ }
+
+ for (int i = start_image; i <= end_image; i++) {
+ struct wim_image_metadata *imd;
+
+ imd = wim->image_metadata[i - 1];
+ /* Build a new metadata resource only if image was modified from
+ * the original (or was newly added). Otherwise just copy the
+ * existing one. */
+ if (imd->modified) {
+ DEBUG("Image %u was modified; building and writing new "
+ "metadata resource", i);
+ ret = write_metadata_resource(wim, i,
+ write_resource_flags);
+ } else if (write_flags & WIMLIB_WRITE_FLAG_OVERWRITE) {
+ DEBUG("Image %u was not modified; re-using existing "
+ "metadata resource.", i);
+ copy_resource_entry(&imd->metadata_lte->output_resource_entry,
+ &imd->metadata_lte->resource_entry);
+ ret = 0;
+ } else {
+ DEBUG("Image %u was not modified; copying existing "
+ "metadata resource.", i);
+ ret = write_wim_resource(imd->metadata_lte,
+ &wim->out_fd,
+ wim->out_compression_type,
+ wim->out_chunk_size,
+ &imd->metadata_lte->output_resource_entry,
+ write_resource_flags,
+ &wim->lzx_context);
+ }
+ if (ret)
+ return ret;
+ }
+ if (progress_func)
+ progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, NULL);
+ return 0;
+}
+
+static int
+open_wim_writable(WIMStruct *wim, const tchar *path, int open_flags)
+{
+ int raw_fd;
+ DEBUG("Opening \"%"TS"\" for writing.", path);
+
+ raw_fd = topen(path, open_flags | O_BINARY, 0644);
+ if (raw_fd < 0) {
+ ERROR_WITH_ERRNO("Failed to open \"%"TS"\" for writing", path);
+ return WIMLIB_ERR_OPEN;
+ }
+ filedes_init(&wim->out_fd, raw_fd);
+ return 0;
+}
+
+static int
+close_wim_writable(WIMStruct *wim, int write_flags)
+{
+ int ret = 0;
+
+ if (!(write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)) {
+ DEBUG("Closing WIM file.");
+ if (filedes_valid(&wim->out_fd))
+ if (filedes_close(&wim->out_fd))
+ ret = WIMLIB_ERR_WRITE;
+ }
+ filedes_invalidate(&wim->out_fd);
+ return ret;
+}
+
/*
+ * finish_write():
+ *
* Finish writing a WIM file: write the lookup table, xml data, and integrity
- * table (optional), then overwrite the WIM header.
+ * table, then overwrite the WIM header. By default, closes the WIM file
+ * descriptor (@wim->out_fd) if successful.
*
* write_flags is a bitwise OR of the following:
*
- * (public) WIMLIB_WRITE_FLAG_CHECK_INTEGRITY:
- * Include an integrity table.
- *
- * (public) WIMLIB_WRITE_FLAG_SHOW_PROGRESS:
- * Show progress information when (if) writing the integrity table.
+ * (public) WIMLIB_WRITE_FLAG_CHECK_INTEGRITY:
+ * Include an integrity table.
*
- * (private) WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE:
- * Don't write the lookup table.
+ * (public) WIMLIB_WRITE_FLAG_FSYNC:
+ * fsync() the output file before closing it.
*
- * (private) WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE:
- * When (if) writing the integrity table, re-use entries from the
- * existing integrity table, if possible.
+ * (public) WIMLIB_WRITE_FLAG_PIPABLE:
+ * Writing a pipable WIM, possibly to a pipe; include pipable WIM
+ * stream headers before the lookup table and XML data, and also
+ * write the WIM header at the end instead of seeking to the
+ * beginning. Can't be combined with
+ * WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.
*
- * (private) WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML:
- * After writing the XML data but before writing the integrity
- * table, write a temporary WIM header and flush the stream so that
- * the WIM is less likely to become corrupted upon abrupt program
- * termination.
+ * (private) WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE:
+ * Don't write the lookup table.
*
- * (private) WIMLIB_WRITE_FLAG_FSYNC:
- * fsync() the output file before closing it.
+ * (private) WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE:
+ * When (if) writing the integrity table, re-use entries from the
+ * existing integrity table, if possible.
*
+ * (private) WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML:
+ * After writing the XML data but before writing the integrity
+ * table, write a temporary WIM header and flush the stream so that
+ * the WIM is less likely to become corrupted upon abrupt program
+ * termination.
+ * (private) WIMLIB_WRITE_FLAG_HEADER_AT_END:
+ * Instead of overwriting the WIM header at the beginning of the
+ * file, simply append it to the end of the file. (Used when
+ * writing to pipe.)
+ * (private) WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR:
+ * Do not close the file descriptor @wim->out_fd on either success
+ * on failure.
+ * (private) WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES:
+ * Use the existing <TOTALBYTES> stored in the in-memory XML
+ * information, rather than setting it to the offset of the XML
+ * data being written.
*/
-int
-finish_write(WIMStruct *w, int image, int write_flags,
- wimlib_progress_func_t progress_func)
+static int
+finish_write(WIMStruct *wim, int image, int write_flags,
+ wimlib_progress_func_t progress_func,
+ struct list_head *stream_list_override)
{
int ret;
- struct wim_header hdr;
- FILE *out = w->out_fp;
+ off_t hdr_offset;
+ int write_resource_flags;
+ off_t old_lookup_table_end;
+ off_t new_lookup_table_end;
+ u64 xml_totalbytes;
+
+ DEBUG("image=%d, write_flags=%08x", image, write_flags);
- /* @hdr will be the header for the new WIM. First copy all the data
- * from the header in the WIMStruct; then set all the fields that may
- * have changed, including the resource entries, boot index, and image
- * count. */
- memcpy(&hdr, &w->hdr, sizeof(struct wim_header));
+ write_resource_flags = write_flags_to_resource_flags(write_flags);
+ /* In the WIM header, there is room for the resource entry for a
+ * metadata resource labeled as the "boot metadata". This entry should
+ * be zeroed out if there is no bootable image (boot_idx 0). Otherwise,
+ * it should be a copy of the resource entry for the image that is
+ * marked as bootable. This is not well documented... */
+ if (wim->hdr.boot_idx == 0) {
+ zero_resource_entry(&wim->hdr.boot_metadata_res_entry);
+ } else {
+ copy_resource_entry(&wim->hdr.boot_metadata_res_entry,
+ &wim->image_metadata[wim->hdr.boot_idx- 1
+ ]->metadata_lte->output_resource_entry);
+ }
+
+ /* Write lookup table. (Save old position first.) */
+ old_lookup_table_end = wim->hdr.lookup_table_res_entry.offset +
+ wim->hdr.lookup_table_res_entry.size;
if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
- ret = write_lookup_table(w, image, &hdr.lookup_table_res_entry);
- if (ret != 0)
- goto out;
+ ret = write_wim_lookup_table(wim, image, write_flags,
+ &wim->hdr.lookup_table_res_entry,
+ stream_list_override);
+ if (ret)
+ return ret;
}
- ret = write_xml_data(w->wim_info, image, out,
- (write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE) ?
- wim_info_get_total_bytes(w->wim_info) : 0,
- &hdr.xml_res_entry);
- if (ret != 0)
- goto out;
+ /* Write XML data. */
+ xml_totalbytes = wim->out_fd.offset;
+ if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
+ xml_totalbytes = WIM_TOTALBYTES_USE_EXISTING;
+ ret = write_wim_xml_data(wim, image, xml_totalbytes,
+ &wim->hdr.xml_res_entry,
+ write_resource_flags);
+ if (ret)
+ return ret;
+ /* Write integrity table (optional). */
if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
if (write_flags & WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML) {
struct wim_header checkpoint_hdr;
- memcpy(&checkpoint_hdr, &hdr, sizeof(struct wim_header));
- memset(&checkpoint_hdr.integrity, 0, sizeof(struct resource_entry));
- if (fseeko(out, 0, SEEK_SET) != 0) {
- ERROR_WITH_ERRNO("Failed to seek to beginning "
- "of WIM being written");
- ret = WIMLIB_ERR_WRITE;
- goto out;
- }
- ret = write_header(&checkpoint_hdr, out);
- if (ret != 0)
- goto out;
-
- if (fflush(out) != 0) {
- ERROR_WITH_ERRNO("Can't write data to WIM");
- ret = WIMLIB_ERR_WRITE;
- goto out;
- }
-
- if (fseeko(out, 0, SEEK_END) != 0) {
- ERROR_WITH_ERRNO("Failed to seek to end "
- "of WIM being written");
- ret = WIMLIB_ERR_WRITE;
- goto out;
- }
+ memcpy(&checkpoint_hdr, &wim->hdr, sizeof(struct wim_header));
+ zero_resource_entry(&checkpoint_hdr.integrity);
+ checkpoint_hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
+ ret = write_wim_header_at_offset(&checkpoint_hdr,
+ &wim->out_fd, 0);
+ if (ret)
+ return ret;
}
- off_t old_lookup_table_end;
- off_t new_lookup_table_end;
- if (write_flags & WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE) {
- old_lookup_table_end = w->hdr.lookup_table_res_entry.offset +
- w->hdr.lookup_table_res_entry.size;
- } else {
+ if (!(write_flags & WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE))
old_lookup_table_end = 0;
- }
- new_lookup_table_end = hdr.lookup_table_res_entry.offset +
- hdr.lookup_table_res_entry.size;
- ret = write_integrity_table(out,
- &hdr.integrity,
+ new_lookup_table_end = wim->hdr.lookup_table_res_entry.offset +
+ wim->hdr.lookup_table_res_entry.size;
+
+ ret = write_integrity_table(wim,
new_lookup_table_end,
old_lookup_table_end,
progress_func);
- if (ret != 0)
- goto out;
- } else {
- memset(&hdr.integrity, 0, sizeof(struct resource_entry));
- }
-
- /*
- * In the WIM header, there is room for the resource entry for a
- * metadata resource labeled as the "boot metadata". This entry should
- * be zeroed out if there is no bootable image (boot_idx 0). Otherwise,
- * it should be a copy of the resource entry for the image that is
- * marked as bootable. This is not well documented...
- */
-
- /* Set image count and boot index correctly for single image writes */
- if (image != WIMLIB_ALL_IMAGES) {
- hdr.image_count = 1;
- if (hdr.boot_idx == image)
- hdr.boot_idx = 1;
- else
- hdr.boot_idx = 0;
- }
-
- if (hdr.boot_idx == 0) {
- memset(&hdr.boot_metadata_res_entry, 0,
- sizeof(struct resource_entry));
+ if (ret)
+ return ret;
} else {
- memcpy(&hdr.boot_metadata_res_entry,
- &w->image_metadata[
- hdr.boot_idx - 1]->metadata_lte->output_resource_entry,
- sizeof(struct resource_entry));
- }
-
- if (fseeko(out, 0, SEEK_SET) != 0) {
- ERROR_WITH_ERRNO("Failed to seek to beginning of WIM "
- "being written");
- ret = WIMLIB_ERR_WRITE;
- goto out;
- }
-
- ret = write_header(&hdr, out);
+ /* No integrity table. */
+ zero_resource_entry(&wim->hdr.integrity);
+ }
+
+ /* Now that all information in the WIM header has been determined, the
+ * preliminary header written earlier can be overwritten, the header of
+ * the existing WIM file can be overwritten, or the final header can be
+ * written to the end of the pipable WIM. */
+ wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
+ hdr_offset = 0;
+ if (write_flags & WIMLIB_WRITE_FLAG_HEADER_AT_END)
+ hdr_offset = wim->out_fd.offset;
+ DEBUG("Writing new header @ %"PRIu64".", hdr_offset);
+ ret = write_wim_header_at_offset(&wim->hdr, &wim->out_fd, hdr_offset);
if (ret)
- goto out;
+ return ret;
+ /* Possibly sync file data to disk before closing. On POSIX systems, it
+ * is necessary to do this before using rename() to overwrite an
+ * existing file with a new file. Otherwise, data loss would occur if
+ * the system is abruptly terminated when the metadata for the rename
+ * operation has been written to disk, but the new file data has not.
+ */
if (write_flags & WIMLIB_WRITE_FLAG_FSYNC) {
- if (fflush(out) != 0
- || fsync(fileno(out)) != 0)
- {
- ERROR_WITH_ERRNO("Error flushing data to WIM file");
- ret = WIMLIB_ERR_WRITE;
+ DEBUG("Syncing WIM file.");
+ if (fsync(wim->out_fd.fd)) {
+ ERROR_WITH_ERRNO("Error syncing data to WIM file");
+ return WIMLIB_ERR_WRITE;
}
}
-out:
- if (fclose(out) != 0) {
- ERROR_WITH_ERRNO("Failed to close the WIM file");
- if (ret == 0)
- ret = WIMLIB_ERR_WRITE;
+
+ if (close_wim_writable(wim, write_flags)) {
+ ERROR_WITH_ERRNO("Failed to close the output WIM file");
+ return WIMLIB_ERR_WRITE;
}
- w->out_fp = NULL;
- return ret;
+
+ return 0;
}
#if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
int
-lock_wim(WIMStruct *w, FILE *fp)
+lock_wim(WIMStruct *wim, int fd)
{
int ret = 0;
- if (fp && !w->wim_locked) {
- ret = flock(fileno(fp), LOCK_EX | LOCK_NB);
+ if (fd != -1 && !wim->wim_locked) {
+ ret = flock(fd, LOCK_EX | LOCK_NB);
if (ret != 0) {
if (errno == EWOULDBLOCK) {
ERROR("`%"TS"' is already being modified or has been "
"mounted read-write\n"
- " by another process!", w->filename);
+ " by another process!", wim->filename);
ret = WIMLIB_ERR_ALREADY_LOCKED;
} else {
WARNING_WITH_ERRNO("Failed to lock `%"TS"'",
- w->filename);
+ wim->filename);
ret = 0;
}
} else {
- w->wim_locked = 1;
+ wim->wim_locked = 1;
}
}
return ret;
}
#endif
+/*
+ * write_pipable_wim():
+ *
+ * Perform the intermediate stages of creating a "pipable" WIM (i.e. a WIM
+ * capable of being applied from a pipe).
+ *
+ * Pipable WIMs are a wimlib-specific modification of the WIM format such that
+ * images can be applied from them sequentially when the file data is sent over
+ * a pipe. In addition, a pipable WIM can be written sequentially to a pipe.
+ * The modifications made to the WIM format for pipable WIMs are:
+ *
+ * - Magic characters in header are "WLPWM\0\0\0" (wimlib pipable WIM) instead
+ * of "MSWIM\0\0\0". This lets wimlib know that the WIM is pipable and also
+ * stops other software from trying to read the file as a normal WIM.
+ *
+ * - The header at the beginning of the file does not contain all the normal
+ * information; in particular it will have all 0's for the lookup table and
+ * XML data resource entries. This is because this information cannot be
+ * determined until the lookup table and XML data have been written.
+ * Consequently, wimlib will write the full header at the very end of the
+ * file. The header at the end, however, is only used when reading the WIM
+ * from a seekable file (not a pipe).
+ *
+ * - An extra copy of the XML data is placed directly after the header. This
+ * allows image names and sizes to be determined at an appropriate time when
+ * reading the WIM from a pipe. This copy of the XML data is ignored if the
+ * WIM is read from a seekable file (not a pipe).
+ *
+ * - The format of resources, or streams, has been modified to allow them to be
+ * used before the "lookup table" has been read. Each stream is prefixed with
+ * a `struct pwm_stream_hdr' that is basically an abbreviated form of `struct
+ * wim_lookup_table_entry_disk' that only contains the SHA1 message digest,
+ * uncompressed stream size, and flags that indicate whether the stream is
+ * compressed. The data of uncompressed streams then follows literally, while
+ * the data of compressed streams follows in a modified format. Compressed
+ * streams do not begin with a chunk table, since the chunk table cannot be
+ * written until all chunks have been compressed. Instead, each compressed
+ * chunk is prefixed by a `struct pwm_chunk_hdr' that gives its size.
+ * Furthermore, the chunk table is written at the end of the resource instead
+ * of the start. Note: chunk offsets are given in the chunk table as if the
+ * `struct pwm_chunk_hdr's were not present; also, the chunk table is only
+ * used if the WIM is being read from a seekable file (not a pipe).
+ *
+ * - Metadata resources always come before other file resources (streams).
+ * (This does not by itself constitute an incompatibility with normal WIMs,
+ * since this is valid in normal WIMs.)
+ *
+ * - At least up to the end of the file resources, all components must be packed
+ * as tightly as possible; there cannot be any "holes" in the WIM. (This does
+ * not by itself consititute an incompatibility with normal WIMs, since this
+ * is valid in normal WIMs.)
+ *
+ * Note: the lookup table, XML data, and header at the end are not used when
+ * applying from a pipe. They exist to support functionality such as image
+ * application and export when the WIM is *not* read from a pipe.
+ *
+ * Layout of pipable WIM:
+ *
+ * ---------+----------+--------------------+----------------+--------------+-----------+--------+
+ * | Header | XML data | Metadata resources | File resources | Lookup table | XML data | Header |
+ * ---------+----------+--------------------+----------------+--------------+-----------+--------+
+ *
+ * Layout of normal WIM:
+ *
+ * +--------+-----------------------------+-------------------------+
+ * | Header | File and metadata resources | Lookup table | XML data |
+ * +--------+-----------------------------+-------------------------+
+ *
+ * An optional integrity table can follow the final XML data in both normal and
+ * pipable WIMs. However, due to implementation details, wimlib currently can
+ * only include an integrity table in a pipable WIM when writing it to a
+ * seekable file (not a pipe).
+ *
+ * Do note that since pipable WIMs are not supported by Microsoft's software,
+ * wimlib does not create them unless explicitly requested (with
+ * WIMLIB_WRITE_FLAG_PIPABLE) and as stated above they use different magic
+ * characters to identify the file.
+ */
static int
-open_wim_writable(WIMStruct *w, const tchar *path,
- bool trunc, bool also_readable)
+write_pipable_wim(WIMStruct *wim, int image, int write_flags,
+ unsigned num_threads, wimlib_progress_func_t progress_func,
+ struct list_head *stream_list_override)
{
- const tchar *mode;
- if (trunc)
- if (also_readable)
- mode = T("w+b");
- else
- mode = T("wb");
+ int ret;
+ struct resource_entry xml_res_entry;
+
+ WARNING("Creating a pipable WIM, which will "
+ "be incompatible\n"
+ " with Microsoft's software (wimgapi/imagex/Dism).");
+
+ /* At this point, the header at the beginning of the file has already
+ * been written. */
+
+ /* For efficiency, when wimlib adds an image to the WIM with
+ * wimlib_add_image(), the SHA1 message digests of files is not
+ * calculated; instead, they are calculated while the files are being
+ * written. However, this does not work when writing a pipable WIM,
+ * since when writing a stream to a pipable WIM, its SHA1 message digest
+ * needs to be known before the stream data is written. Therefore,
+ * before getting much farther, we need to pre-calculate the SHA1
+ * message digests of all streams that will be written. */
+ ret = wim_checksum_unhashed_streams(wim);
+ if (ret)
+ return ret;
+
+ /* Write extra copy of the XML data. */
+ ret = write_wim_xml_data(wim, image, WIM_TOTALBYTES_OMIT,
+ &xml_res_entry,
+ WIMLIB_WRITE_RESOURCE_FLAG_PIPABLE);
+ if (ret)
+ return ret;
+
+ /* Write metadata resources for the image(s) being included in the
+ * output WIM. */
+ ret = write_wim_metadata_resources(wim, image, write_flags,
+ progress_func);
+ if (ret)
+ return ret;
+
+ /* Write streams needed for the image(s) being included in the output
+ * WIM, or streams needed for the split WIM part. */
+ return write_wim_streams(wim, image, write_flags, num_threads,
+ progress_func, stream_list_override);
+
+ /* The lookup table, XML data, and header at end are handled by
+ * finish_write(). */
+}
+
+/* Write a standalone WIM or split WIM (SWM) part to a new file or to a file
+ * descriptor. */
+int
+write_wim_part(WIMStruct *wim,
+ const void *path_or_fd,
+ int image,
+ int write_flags,
+ unsigned num_threads,
+ wimlib_progress_func_t progress_func,
+ unsigned part_number,
+ unsigned total_parts,
+ struct list_head *stream_list_override,
+ const u8 *guid)
+{
+ int ret;
+ struct wim_header hdr_save;
+ struct list_head lt_stream_list_override;
+
+ if (total_parts == 1)
+ DEBUG("Writing standalone WIM.");
+ else
+ DEBUG("Writing split WIM part %u/%u", part_number, total_parts);
+ if (image == WIMLIB_ALL_IMAGES)
+ DEBUG("Including all images.");
else
- mode = T("r+b");
+ DEBUG("Including image %d only.", image);
+ if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
+ DEBUG("File descriptor: %d", *(const int*)path_or_fd);
+ else
+ DEBUG("Path: \"%"TS"\"", (const tchar*)path_or_fd);
+ DEBUG("Write flags: 0x%08x", write_flags);
+ if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY)
+ DEBUG("\tCHECK_INTEGRITY");
+ if (write_flags & WIMLIB_WRITE_FLAG_REBUILD)
+ DEBUG("\tREBUILD");
+ if (write_flags & WIMLIB_WRITE_FLAG_RECOMPRESS)
+ DEBUG("\tRECOMPRESS");
+ if (write_flags & WIMLIB_WRITE_FLAG_FSYNC)
+ DEBUG("\tFSYNC");
+ if (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE)
+ DEBUG("\tFSYNC");
+ if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
+ DEBUG("\tIGNORE_READONLY_FLAG");
+ if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
+ DEBUG("\tPIPABLE");
+ if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
+ DEBUG("\tFILE_DESCRIPTOR");
+ if (write_flags & WIMLIB_WRITE_FLAG_NO_METADATA)
+ DEBUG("\tNO_METADATA");
+ if (write_flags & WIMLIB_WRITE_FLAG_USE_EXISTING_TOTALBYTES)
+ DEBUG("\tUSE_EXISTING_TOTALBYTES");
+ if (num_threads == 0)
+ DEBUG("Number of threads: autodetect");
+ else
+ DEBUG("Number of threads: %u", num_threads);
+ DEBUG("Progress function: %s", (progress_func ? "yes" : "no"));
+ DEBUG("Stream list: %s", (stream_list_override ? "specified" : "autodetect"));
+ DEBUG("GUID: %s", ((guid || wim->guid_set_explicitly) ?
+ "specified" : "generate new"));
+
+ /* Internally, this is always called with a valid part number and total
+ * parts. */
+ wimlib_assert(total_parts >= 1);
+ wimlib_assert(part_number >= 1 && part_number <= total_parts);
+
+ /* A valid image (or all images) must be specified. */
+ if (image != WIMLIB_ALL_IMAGES &&
+ (image < 1 || image > wim->hdr.image_count))
+ return WIMLIB_ERR_INVALID_IMAGE;
+
+ /* If we need to write metadata resources, make sure the ::WIMStruct has
+ * the needed information attached (e.g. is not a resource-only WIM,
+ * such as a non-first part of a split WIM). */
+ if (!wim_has_metadata(wim) &&
+ !(write_flags & WIMLIB_WRITE_FLAG_NO_METADATA))
+ return WIMLIB_ERR_METADATA_NOT_FOUND;
+
+ /* Check for contradictory flags. */
+ if ((write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
+ WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
+ == (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
+ WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY))
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ if ((write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
+ WIMLIB_WRITE_FLAG_NOT_PIPABLE))
+ == (WIMLIB_WRITE_FLAG_PIPABLE |
+ WIMLIB_WRITE_FLAG_NOT_PIPABLE))
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ /* Save previous header, then start initializing the new one. */
+ memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
+
+ /* Set default integrity and pipable flags. */
+ if (!(write_flags & (WIMLIB_WRITE_FLAG_PIPABLE |
+ WIMLIB_WRITE_FLAG_NOT_PIPABLE)))
+ if (wim_is_pipable(wim))
+ write_flags |= WIMLIB_WRITE_FLAG_PIPABLE;
+
+ if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
+ WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
+ if (wim_has_integrity_table(wim))
+ write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
+
+ /* Set appropriate magic number. */
+ if (write_flags & WIMLIB_WRITE_FLAG_PIPABLE)
+ wim->hdr.magic = PWM_MAGIC;
+ else
+ wim->hdr.magic = WIM_MAGIC;
+
+ /* Clear header flags that will be set automatically. */
+ wim->hdr.flags &= ~(WIM_HDR_FLAG_METADATA_ONLY |
+ WIM_HDR_FLAG_RESOURCE_ONLY |
+ WIM_HDR_FLAG_SPANNED |
+ WIM_HDR_FLAG_WRITE_IN_PROGRESS);
+
+ /* Set SPANNED header flag if writing part of a split WIM. */
+ if (total_parts != 1)
+ wim->hdr.flags |= WIM_HDR_FLAG_SPANNED;
+
+ /* Set part number and total parts of split WIM. This will be 1 and 1
+ * if the WIM is standalone. */
+ wim->hdr.part_number = part_number;
+ wim->hdr.total_parts = total_parts;
+
+ /* Set compression type if different. */
+ if (wim->compression_type != wim->out_compression_type) {
+ ret = set_wim_hdr_cflags(wim->out_compression_type, &wim->hdr);
+ wimlib_assert(ret == 0);
+ }
+
+ /* Set chunk size if different. */
+ wim->hdr.chunk_size = wim->out_chunk_size;
+
+ /* Use GUID if specified; otherwise generate a new one. */
+ if (guid)
+ memcpy(wim->hdr.guid, guid, WIMLIB_GUID_LEN);
+ else if (!wim->guid_set_explicitly)
+ randomize_byte_array(wim->hdr.guid, WIMLIB_GUID_LEN);
+
+ /* Clear references to resources that have not been written yet. */
+ zero_resource_entry(&wim->hdr.lookup_table_res_entry);
+ zero_resource_entry(&wim->hdr.xml_res_entry);
+ zero_resource_entry(&wim->hdr.boot_metadata_res_entry);
+ zero_resource_entry(&wim->hdr.integrity);
+
+ /* Set image count and boot index correctly for single image writes. */
+ if (image != WIMLIB_ALL_IMAGES) {
+ wim->hdr.image_count = 1;
+ if (wim->hdr.boot_idx == image)
+ wim->hdr.boot_idx = 1;
+ else
+ wim->hdr.boot_idx = 0;
+ }
+
+ /* Split WIMs can't be bootable. */
+ if (total_parts != 1)
+ wim->hdr.boot_idx = 0;
+
+ /* Initialize output file descriptor. */
+ if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR) {
+ /* File descriptor was explicitly provided. Return error if
+ * file descriptor is not seekable, unless writing a pipable WIM
+ * was requested. */
+ wim->out_fd.fd = *(const int*)path_or_fd;
+ wim->out_fd.offset = 0;
+ if (!filedes_is_seekable(&wim->out_fd)) {
+ ret = WIMLIB_ERR_INVALID_PARAM;
+ if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
+ goto out_restore_hdr;
+ if (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) {
+ ERROR("Can't include integrity check when "
+ "writing pipable WIM to pipe!");
+ goto out_restore_hdr;
+ }
+ }
- wimlib_assert(w->out_fp == NULL);
- w->out_fp = tfopen(path, mode);
- if (w->out_fp) {
- return 0;
} else {
- ERROR_WITH_ERRNO("Failed to open `%"TS"' for writing", path);
- return WIMLIB_ERR_OPEN;
+ /* Filename of WIM to write was provided; open file descriptor
+ * to it. */
+ ret = open_wim_writable(wim, (const tchar*)path_or_fd,
+ O_TRUNC | O_CREAT | O_RDWR);
+ if (ret)
+ goto out_restore_hdr;
}
-}
+ /* Write initial header. This is merely a "dummy" header since it
+ * doesn't have all the information yet, so it will be overwritten later
+ * (unless writing a pipable WIM). */
+ if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE))
+ wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
+ ret = write_wim_header(&wim->hdr, &wim->out_fd);
+ wim->hdr.flags &= ~WIM_HDR_FLAG_WRITE_IN_PROGRESS;
+ if (ret)
+ goto out_restore_hdr;
-void
-close_wim_writable(WIMStruct *w)
-{
- if (w->out_fp) {
- if (fclose(w->out_fp) != 0) {
- WARNING_WITH_ERRNO("Failed to close output WIM");
+ if (stream_list_override) {
+ struct wim_lookup_table_entry *lte;
+ INIT_LIST_HEAD(<_stream_list_override);
+ list_for_each_entry(lte, stream_list_override,
+ write_streams_list)
+ {
+ list_add_tail(<e->lookup_table_list,
+ <_stream_list_override);
}
- w->out_fp = NULL;
}
+
+ /* Write metadata resources and streams. */
+ if (!(write_flags & WIMLIB_WRITE_FLAG_PIPABLE)) {
+ /* Default case: create a normal (non-pipable) WIM. */
+ ret = write_wim_streams(wim, image, write_flags, num_threads,
+ progress_func, stream_list_override);
+ if (ret)
+ goto out_restore_hdr;
+
+ ret = write_wim_metadata_resources(wim, image, write_flags,
+ progress_func);
+ if (ret)
+ goto out_restore_hdr;
+ } else {
+ /* Non-default case: create pipable WIM. */
+ ret = write_pipable_wim(wim, image, write_flags, num_threads,
+ progress_func, stream_list_override);
+ if (ret)
+ goto out_restore_hdr;
+ write_flags |= WIMLIB_WRITE_FLAG_HEADER_AT_END;
+ }
+
+ if (stream_list_override)
+ stream_list_override = <_stream_list_override;
+
+ /* Write lookup table, XML data, and (optional) integrity table. */
+ ret = finish_write(wim, image, write_flags, progress_func,
+ stream_list_override);
+out_restore_hdr:
+ memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
+ (void)close_wim_writable(wim, write_flags);
+ DEBUG("ret=%d", ret);
+ return ret;
}
-/* Open file stream and write dummy header for WIM. */
-int
-begin_write(WIMStruct *w, const tchar *path, int write_flags)
+/* Write a standalone WIM to a file or file descriptor. */
+static int
+write_standalone_wim(WIMStruct *wim, const void *path_or_fd,
+ int image, int write_flags, unsigned num_threads,
+ wimlib_progress_func_t progress_func)
{
- int ret;
- ret = open_wim_writable(w, path, true,
- (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) != 0);
- if (ret != 0)
- return ret;
- /* Write dummy header. It will be overwritten later. */
- return write_header(&w->hdr, w->out_fp);
+ return write_wim_part(wim, path_or_fd, image, write_flags,
+ num_threads, progress_func, 1, 1, NULL, NULL);
}
-/* Writes a stand-alone WIM to a file. */
+/* API function documented in wimlib.h */
WIMLIBAPI int
-wimlib_write(WIMStruct *w, const tchar *path,
+wimlib_write(WIMStruct *wim, const tchar *path,
int image, int write_flags, unsigned num_threads,
wimlib_progress_func_t progress_func)
{
- int ret;
-
if (!path)
return WIMLIB_ERR_INVALID_PARAM;
write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
- if (image != WIMLIB_ALL_IMAGES &&
- (image < 1 || image > w->hdr.image_count))
- return WIMLIB_ERR_INVALID_IMAGE;
-
- if (w->hdr.total_parts != 1) {
- ERROR("Cannot call wimlib_write() on part of a split WIM");
- return WIMLIB_ERR_SPLIT_UNSUPPORTED;
- }
-
- ret = begin_write(w, path, write_flags);
- if (ret)
- goto out;
-
- ret = write_wim_streams(w, image, write_flags, num_threads,
- progress_func);
- if (ret)
- goto out;
-
- if (progress_func)
- progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, NULL);
+ return write_standalone_wim(wim, path, image, write_flags,
+ num_threads, progress_func);
+}
- ret = for_image(w, image, write_metadata_resource);
- if (ret)
- goto out;
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_write_to_fd(WIMStruct *wim, int fd,
+ int image, int write_flags, unsigned num_threads,
+ wimlib_progress_func_t progress_func)
+{
+ if (fd < 0)
+ return WIMLIB_ERR_INVALID_PARAM;
- if (progress_func)
- progress_func(WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, NULL);
+ write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
+ write_flags |= WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR;
- ret = finish_write(w, image, write_flags, progress_func);
-out:
- close_wim_writable(w);
- DEBUG("wimlib_write(path=%"TS") = %d", path, ret);
- return ret;
+ return write_standalone_wim(wim, &fd, image, write_flags,
+ num_threads, progress_func);
}
static bool
-any_images_modified(WIMStruct *w)
+any_images_modified(WIMStruct *wim)
{
- for (int i = 0; i < w->hdr.image_count; i++)
- if (w->image_metadata[i]->modified)
+ for (int i = 0; i < wim->hdr.image_count; i++)
+ if (wim->image_metadata[i]->modified)
return true;
return false;
}
+static int
+check_resource_offset(struct wim_lookup_table_entry *lte, void *_wim)
+{
+ const WIMStruct *wim = _wim;
+ off_t end_offset = *(const off_t*)wim->private;
+
+ if (lte->resource_location == RESOURCE_IN_WIM && lte->wim == wim &&
+ lte->resource_entry.offset + lte->resource_entry.size > end_offset)
+ return WIMLIB_ERR_RESOURCE_ORDER;
+ return 0;
+}
+
+/* Make sure no file or metadata resources are located after the XML data (or
+ * integrity table if present)--- otherwise we can't safely overwrite the WIM in
+ * place and we return WIMLIB_ERR_RESOURCE_ORDER. */
+static int
+check_resource_offsets(WIMStruct *wim, off_t end_offset)
+{
+ int ret;
+ unsigned i;
+
+ wim->private = &end_offset;
+ ret = for_lookup_table_entry(wim->lookup_table, check_resource_offset, wim);
+ if (ret)
+ return ret;
+
+ for (i = 0; i < wim->hdr.image_count; i++) {
+ ret = check_resource_offset(wim->image_metadata[i]->metadata_lte, wim);
+ if (ret)
+ return ret;
+ }
+ return 0;
+}
+
/*
* Overwrite a WIM, possibly appending streams to it.
*
* small amount of space compared to the streams, however.)
*/
static int
-overwrite_wim_inplace(WIMStruct *w, int write_flags,
+overwrite_wim_inplace(WIMStruct *wim, int write_flags,
unsigned num_threads,
wimlib_progress_func_t progress_func)
{
int ret;
struct list_head stream_list;
off_t old_wim_end;
+ u64 old_lookup_table_end, old_xml_begin, old_xml_end;
+ struct wim_header hdr_save;
+
+ DEBUG("Overwriting `%"TS"' in-place", wim->filename);
- DEBUG("Overwriting `%"TS"' in-place", w->filename);
+ /* Set default integrity flag. */
+ if (!(write_flags & (WIMLIB_WRITE_FLAG_CHECK_INTEGRITY |
+ WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY)))
+ if (wim_has_integrity_table(wim))
+ write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
+
+ /* Set additional flags for overwrite. */
+ write_flags |= WIMLIB_WRITE_FLAG_OVERWRITE |
+ WIMLIB_WRITE_FLAG_STREAMS_OK;
/* Make sure that the integrity table (if present) is after the XML
* data, and that there are no stream resources, metadata resources, or
* lookup tables after the XML data. Otherwise, these data would be
* overwritten. */
- if (w->hdr.integrity.offset != 0 &&
- w->hdr.integrity.offset < w->hdr.xml_res_entry.offset) {
- ERROR("Didn't expect the integrity table to be before the XML data");
+ old_xml_begin = wim->hdr.xml_res_entry.offset;
+ old_xml_end = old_xml_begin + wim->hdr.xml_res_entry.size;
+ old_lookup_table_end = wim->hdr.lookup_table_res_entry.offset +
+ wim->hdr.lookup_table_res_entry.size;
+ if (wim->hdr.integrity.offset != 0 && wim->hdr.integrity.offset < old_xml_end) {
+ WARNING("Didn't expect the integrity table to be before the XML data");
return WIMLIB_ERR_RESOURCE_ORDER;
}
- if (w->hdr.lookup_table_res_entry.offset > w->hdr.xml_res_entry.offset) {
- ERROR("Didn't expect the lookup table to be after the XML data");
+ if (old_lookup_table_end > old_xml_begin) {
+ WARNING("Didn't expect the lookup table to be after the XML data");
return WIMLIB_ERR_RESOURCE_ORDER;
}
-
- if (w->hdr.integrity.offset)
- old_wim_end = w->hdr.integrity.offset + w->hdr.integrity.size;
- else
- old_wim_end = w->hdr.xml_res_entry.offset + w->hdr.xml_res_entry.size;
-
- if (!w->deletion_occurred && !any_images_modified(w)) {
+ /* Set @old_wim_end, which indicates the point beyond which we don't
+ * allow any file and metadata resources to appear without returning
+ * WIMLIB_ERR_RESOURCE_ORDER (due to the fact that we would otherwise
+ * overwrite these resources). */
+ if (!wim->deletion_occurred && !any_images_modified(wim)) {
/* If no images have been modified and no images have been
- * deleted, a new lookup table does not need to be written. */
- old_wim_end = w->hdr.lookup_table_res_entry.offset +
- w->hdr.lookup_table_res_entry.size;
+ * deleted, a new lookup table does not need to be written. We
+ * shall write the new XML data and optional integrity table
+ * immediately after the lookup table. Note that this may
+ * overwrite an existing integrity table. */
+ DEBUG("Skipping writing lookup table "
+ "(no images modified or deleted)");
+ old_wim_end = old_lookup_table_end;
write_flags |= WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE |
WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML;
+ } else if (wim->hdr.integrity.offset) {
+ /* Old WIM has an integrity table; begin writing new streams
+ * after it. */
+ old_wim_end = wim->hdr.integrity.offset + wim->hdr.integrity.size;
+ } else {
+ /* No existing integrity table; begin writing new streams after
+ * the old XML data. */
+ old_wim_end = old_xml_end;
}
- INIT_LIST_HEAD(&stream_list);
- ret = wim_prepare_streams(w, old_wim_end, &stream_list);
- if (ret != 0)
+
+ ret = check_resource_offsets(wim, old_wim_end);
+ if (ret)
return ret;
- ret = open_wim_writable(w, w->filename, false,
- (write_flags & WIMLIB_WRITE_FLAG_CHECK_INTEGRITY) != 0);
- if (ret != 0)
+ ret = prepare_stream_list(wim, WIMLIB_ALL_IMAGES, write_flags,
+ &stream_list);
+ if (ret)
return ret;
- ret = lock_wim(w, w->out_fp);
- if (ret != 0) {
- fclose(w->out_fp);
- w->out_fp = NULL;
+ ret = open_wim_writable(wim, wim->filename, O_RDWR);
+ if (ret)
return ret;
+
+ ret = lock_wim(wim, wim->out_fd.fd);
+ if (ret)
+ goto out_close_wim;
+
+ /* Save original header so it can be restored in case of error */
+ memcpy(&hdr_save, &wim->hdr, sizeof(struct wim_header));
+
+ /* Set WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in header. */
+ wim->hdr.flags |= WIM_HDR_FLAG_WRITE_IN_PROGRESS;
+ ret = write_wim_header_flags(wim->hdr.flags, &wim->out_fd);
+ if (ret) {
+ ERROR_WITH_ERRNO("Error updating WIM header flags");
+ goto out_restore_memory_hdr;
}
- if (fseeko(w->out_fp, old_wim_end, SEEK_SET) != 0) {
+ if (filedes_seek(&wim->out_fd, old_wim_end) == -1) {
ERROR_WITH_ERRNO("Can't seek to end of WIM");
- fclose(w->out_fp);
- w->out_fp = NULL;
- w->wim_locked = 0;
- return WIMLIB_ERR_WRITE;
+ ret = WIMLIB_ERR_WRITE;
+ goto out_restore_physical_hdr;
}
- if (!list_empty(&stream_list)) {
- DEBUG("Writing newly added streams (offset = %"PRIu64")",
- old_wim_end);
- ret = write_stream_list(&stream_list,
- w->lookup_table,
- w->out_fp,
- wimlib_get_compression_type(w),
- write_flags, num_threads,
- progress_func);
- if (ret != 0)
- goto out_ftruncate;
- } else {
- DEBUG("No new streams were added");
- }
+ ret = write_stream_list(&stream_list,
+ wim->lookup_table,
+ &wim->out_fd,
+ wim->compression_type,
+ wim->chunk_size,
+ &wim->lzx_context,
+ write_flags,
+ num_threads,
+ progress_func);
+ if (ret)
+ goto out_truncate;
+
+ ret = write_wim_metadata_resources(wim, WIMLIB_ALL_IMAGES,
+ write_flags, progress_func);
+ if (ret)
+ goto out_truncate;
- for (int i = 0; i < w->hdr.image_count; i++) {
- if (w->image_metadata[i]->modified) {
- select_wim_image(w, i + 1);
- ret = write_metadata_resource(w);
- if (ret)
- goto out_ftruncate;
- }
- }
write_flags |= WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE;
- ret = finish_write(w, WIMLIB_ALL_IMAGES, write_flags,
- progress_func);
-out_ftruncate:
- close_wim_writable(w);
- if (ret != 0 && !(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
+ ret = finish_write(wim, WIMLIB_ALL_IMAGES, write_flags,
+ progress_func, NULL);
+ if (ret)
+ goto out_truncate;
+
+ goto out_unlock_wim;
+
+out_truncate:
+ if (!(write_flags & WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE)) {
WARNING("Truncating `%"TS"' to its original size (%"PRIu64" bytes)",
- w->filename, old_wim_end);
- /* Return value of truncate() is ignored because this is already
- * an error path. */
- (void)ttruncate(w->filename, old_wim_end);
- }
- w->wim_locked = 0;
+ wim->filename, old_wim_end);
+ /* Return value of ftruncate() is ignored because this is
+ * already an error path. */
+ (void)ftruncate(wim->out_fd.fd, old_wim_end);
+ }
+out_restore_physical_hdr:
+ (void)write_wim_header_flags(hdr_save.flags, &wim->out_fd);
+out_restore_memory_hdr:
+ memcpy(&wim->hdr, &hdr_save, sizeof(struct wim_header));
+out_close_wim:
+ (void)close_wim_writable(wim, write_flags);
+out_unlock_wim:
+ wim->wim_locked = 0;
return ret;
}
static int
-overwrite_wim_via_tmpfile(WIMStruct *w, int write_flags,
+overwrite_wim_via_tmpfile(WIMStruct *wim, int write_flags,
unsigned num_threads,
wimlib_progress_func_t progress_func)
{
size_t wim_name_len;
int ret;
- DEBUG("Overwriting `%"TS"' via a temporary file", w->filename);
+ DEBUG("Overwriting `%"TS"' via a temporary file", wim->filename);
/* Write the WIM to a temporary file in the same directory as the
* original WIM. */
- wim_name_len = tstrlen(w->filename);
+ wim_name_len = tstrlen(wim->filename);
tchar tmpfile[wim_name_len + 10];
- tmemcpy(tmpfile, w->filename, wim_name_len);
+ tmemcpy(tmpfile, wim->filename, wim_name_len);
randomize_char_array_with_alnum(tmpfile + wim_name_len, 9);
tmpfile[wim_name_len + 9] = T('\0');
- ret = wimlib_write(w, tmpfile, WIMLIB_ALL_IMAGES,
+ ret = wimlib_write(wim, tmpfile, WIMLIB_ALL_IMAGES,
write_flags | WIMLIB_WRITE_FLAG_FSYNC,
num_threads, progress_func);
- if (ret != 0) {
- ERROR("Failed to write the WIM file `%"TS"'", tmpfile);
- goto err;
+ if (ret) {
+ tunlink(tmpfile);
+ return ret;
}
- DEBUG("Renaming `%"TS"' to `%"TS"'", tmpfile, w->filename);
+ close_wim(wim);
-#ifdef __WIN32__
- /* Windows won't let you delete open files unless FILE_SHARE_DELETE was
- * specified to CreateFile(). The WIM was opened with fopen(), which
- * didn't provided this flag to CreateFile, so the handle must be closed
- * before executing the rename(). */
- if (w->fp != NULL) {
- fclose(w->fp);
- w->fp = NULL;
- }
-#endif
-
- /* Rename the new file to the old file .*/
- if (trename(tmpfile, w->filename) != 0) {
+ /* Rename the new WIM file to the original WIM file. Note: on Windows
+ * this actually calls win32_rename_replacement(), not _wrename(), so
+ * that removing the existing destination file can be handled. */
+ DEBUG("Renaming `%"TS"' to `%"TS"'", tmpfile, wim->filename);
+ ret = trename(tmpfile, wim->filename);
+ if (ret) {
ERROR_WITH_ERRNO("Failed to rename `%"TS"' to `%"TS"'",
- tmpfile, w->filename);
- ret = WIMLIB_ERR_RENAME;
- goto err;
+ tmpfile, wim->filename);
+ #ifdef __WIN32__
+ if (ret < 0)
+ #endif
+ {
+ tunlink(tmpfile);
+ }
+ return WIMLIB_ERR_RENAME;
}
if (progress_func) {
union wimlib_progress_info progress;
progress.rename.from = tmpfile;
- progress.rename.to = w->filename;
+ progress.rename.to = wim->filename;
progress_func(WIMLIB_PROGRESS_MSG_RENAME, &progress);
}
-
- /* Close the original WIM file that was opened for reading. */
- if (w->fp != NULL) {
- fclose(w->fp);
- w->fp = NULL;
- }
-
- /* Re-open the WIM read-only. */
- w->fp = tfopen(w->filename, T("rb"));
- if (w->fp == NULL) {
- ret = WIMLIB_ERR_REOPEN;
- WARNING_WITH_ERRNO("Failed to re-open `%"TS"' read-only",
- w->filename);
- FREE(w->filename);
- w->filename = NULL;
- }
- return ret;
-err:
- /* Remove temporary file. */
- if (tunlink(tmpfile) != 0)
- WARNING_WITH_ERRNO("Failed to remove `%"TS"'", tmpfile);
- return ret;
+ return 0;
}
-/*
- * Writes a WIM file to the original file that it was read from, overwriting it.
- */
+/* API function documented in wimlib.h */
WIMLIBAPI int
-wimlib_overwrite(WIMStruct *w, int write_flags,
+wimlib_overwrite(WIMStruct *wim, int write_flags,
unsigned num_threads,
wimlib_progress_func_t progress_func)
{
+ int ret;
+ u32 orig_hdr_flags;
+
write_flags &= WIMLIB_WRITE_MASK_PUBLIC;
- if (!w->filename)
+ if (write_flags & WIMLIB_WRITE_FLAG_FILE_DESCRIPTOR)
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ if (!wim->filename)
return WIMLIB_ERR_NO_FILENAME;
- if (w->hdr.total_parts != 1) {
- ERROR("Cannot modify a split WIM");
- return WIMLIB_ERR_SPLIT_UNSUPPORTED;
- }
+ orig_hdr_flags = wim->hdr.flags;
+ if (write_flags & WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG)
+ wim->hdr.flags &= ~WIM_HDR_FLAG_READONLY;
+ ret = can_modify_wim(wim);
+ wim->hdr.flags = orig_hdr_flags;
+ if (ret)
+ return ret;
- if ((!w->deletion_occurred || (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE))
- && !(write_flags & WIMLIB_WRITE_FLAG_REBUILD))
+ if ((!wim->deletion_occurred || (write_flags & WIMLIB_WRITE_FLAG_SOFT_DELETE))
+ && !(write_flags & (WIMLIB_WRITE_FLAG_REBUILD |
+ WIMLIB_WRITE_FLAG_PIPABLE))
+ && !(wim_is_pipable(wim))
+ && wim->compression_type == wim->out_compression_type
+ && wim->chunk_size == wim->out_chunk_size)
{
- int ret;
- ret = overwrite_wim_inplace(w, write_flags, num_threads,
+ ret = overwrite_wim_inplace(wim, write_flags, num_threads,
progress_func);
- if (ret == WIMLIB_ERR_RESOURCE_ORDER)
- WARNING("Falling back to re-building entire WIM");
- else
+ if (ret != WIMLIB_ERR_RESOURCE_ORDER)
return ret;
+ WARNING("Falling back to re-building entire WIM");
}
- return overwrite_wim_via_tmpfile(w, write_flags, num_threads,
+ return overwrite_wim_via_tmpfile(wim, write_flags, num_threads,
progress_func);
}
git://wimlib.net / wimlib / blobdiff