X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fresource.c;h=69a531fbce354309867ca3bc2cc42689517ab983;hp=8f85cba40b90f42c45c3bc288662fcbb4df2b124;hb=ebd6c0ec0ff47ac18af4ef918fd78fb8d9f19540;hpb=b51021c82376ce8d2aecb206c8cbfc4ffa6d4f3a diff --git a/src/resource.c b/src/resource.c index 8f85cba4..69a531fb 100644 --- a/src/resource.c +++ b/src/resource.c @@ -1,51 +1,56 @@ /* * resource.c * - * Read uncompressed and compressed metadata and file resources. + * Read uncompressed and compressed metadata and file resources from a WIM file. */ /* - * Copyright (C) 2010 Carl Thijssen - * Copyright (C) 2012 Eric Biggers + * Copyright (C) 2012, 2013 Eric Biggers * * This file is part of wimlib, a library for working with WIM files. * * wimlib is free software; you can redistribute it and/or modify it under the - * terms of the GNU Lesser General Public License as published by the Free - * Software Foundation; either version 2.1 of the License, or (at your option) - * any later version. + * terms of the GNU General Public License as published by the Free Software + * Foundation; either version 3 of the License, or (at your option) any later + * version. * * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more - * details. + * A PARTICULAR PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU Lesser General Public License - * along with wimlib; if not, see http://www.gnu.org/licenses/. + * You should have received a copy of the GNU General Public License along with + * wimlib; if not, see http://www.gnu.org/licenses/. */ #include "wimlib_internal.h" +#include "dentry.h" #include "lookup_table.h" -#include "io.h" +#include "buffer_io.h" #include "lzx.h" #include "xpress.h" #include "sha1.h" -#include "dentry.h" -#include "config.h" -#include + #include -#include +#include +#include +#include +#ifdef WITH_NTFS_3G +#include +#include +#include +#include +#endif -/* +/* * Reads all or part of a compressed resource into an in-memory buffer. * * @fp: The FILE* for the WIM file. - * @resource_compressed_size: The compressed size of the resource. + * @resource_compressed_size: The compressed size of the resource. * @resource_uncompressed_size: The uncompressed size of the resource. * @resource_offset: The offset of the start of the resource from * the start of the stream @fp. - * @resource_ctype: The compression type of the resource. + * @resource_ctype: The compression type of the resource. * @len: The number of bytes of uncompressed data to read from * the resource. * @offset: The offset of the bytes to read within the uncompressed @@ -55,9 +60,9 @@ * * Returns zero on success, nonzero on failure. */ -static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, - u64 resource_uncompressed_size, - u64 resource_offset, int resource_ctype, +static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, + u64 resource_uncompressed_size, + u64 resource_offset, int resource_ctype, u64 len, u64 offset, u8 contents_ret[]) { @@ -72,9 +77,9 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, if (len == 0) return 0; - int (*decompress)(const void *, uint, void *, uint); + int (*decompress)(const void *, unsigned, void *, unsigned); /* Set the appropriate decompress function. */ - if (resource_ctype == WIM_COMPRESSION_TYPE_LZX) + if (resource_ctype == WIMLIB_COMPRESSION_TYPE_LZX) decompress = lzx_decompress; else decompress = xpress_decompress; @@ -88,7 +93,7 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, * The chunk offsets are measured relative to the end of the chunk * table. The first chunk is omitted from the table in the WIM file * because its offset is implicitly given by the fact that it directly - * follows the chunk table and therefore must have an offset of 0. + * follows the chunk table and therefore must have an offset of 0. */ /* Calculate how many chunks the resource conists of in its entirety. */ @@ -136,7 +141,7 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, /* According to M$'s documentation, if the uncompressed size of * the file is greater than 4 GB, the chunk entries are 8-byte * integers. Otherwise, they are 4-byte integers. */ - u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ? + u64 chunk_entry_size = (resource_uncompressed_size >= (u64)1 << 32) ? 8 : 4; /* Size of the full chunk table in the WIM file. */ @@ -150,11 +155,11 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, /* Number of entries we need to actually read from the chunk * table (excludes the implicit first chunk). */ - u64 num_needed_chunk_entries = (start_chunk == 0) ? + u64 num_needed_chunk_entries = (start_chunk == 0) ? num_needed_chunks - 1 : num_needed_chunks; /* Skip over unneeded chunk table entries. */ - u64 file_offset_of_needed_chunk_entries = resource_offset + + u64 file_offset_of_needed_chunk_entries = resource_offset + start_table_idx * chunk_entry_size; if (fseeko(fp, file_offset_of_needed_chunk_entries, SEEK_SET) != 0) { ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read " @@ -181,17 +186,17 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, if (chunk_entry_size == 4) { u32 *entries = (u32*)chunk_tab_buf; while (num_needed_chunk_entries--) - *chunk_tab_p++ = to_le32(*entries++); + *chunk_tab_p++ = le32_to_cpu(*entries++); } else { u64 *entries = (u64*)chunk_tab_buf; while (num_needed_chunk_entries--) - *chunk_tab_p++ = to_le64(*entries++); + *chunk_tab_p++ = le64_to_cpu(*entries++); } /* Done with the chunk table now. We must now seek to the first chunk * that is needed for the read. */ - u64 file_offset_of_first_needed_chunk = resource_offset + + u64 file_offset_of_first_needed_chunk = resource_offset + chunk_table_size + chunk_offsets[0]; if (fseeko(fp, file_offset_of_first_needed_chunk, SEEK_SET) != 0) { ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read " @@ -221,13 +226,14 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, /* Calculate the sizes of the compressed chunk and of the * uncompressed chunk. */ - uint compressed_chunk_size, uncompressed_chunk_size; + unsigned compressed_chunk_size; + unsigned uncompressed_chunk_size; if (i != num_chunks - 1) { /* All the chunks except the last one in the resource * expand to WIM_CHUNK_SIZE uncompressed, and the amount * of compressed data for the chunk is given by the * difference of offsets in the chunk offset table. */ - compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] - + compressed_chunk_size = chunk_offsets[i + 1 - start_chunk] - chunk_offsets[i - start_chunk]; uncompressed_chunk_size = WIM_CHUNK_SIZE; } else { @@ -235,15 +241,15 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, * bytes in the file resource, and the last uncompressed * chunk has size equal to however many bytes are left- * that is, the remainder of the uncompressed size when - * divided by WIM_CHUNK_SIZE. + * divided by WIM_CHUNK_SIZE. * * Note that the resource_compressed_size includes the * chunk table, so the size of it must be subtracted. */ - compressed_chunk_size = resource_compressed_size - + compressed_chunk_size = resource_compressed_size - chunk_table_size - chunk_offsets[i - start_chunk]; - uncompressed_chunk_size = resource_uncompressed_size % + uncompressed_chunk_size = resource_uncompressed_size % WIM_CHUNK_SIZE; /* If the remainder is 0, the last chunk actually @@ -270,7 +276,7 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, end_offset = WIM_CHUNK_SIZE - 1; u64 partial_chunk_size = end_offset + 1 - start_offset; - bool is_partial_chunk = (partial_chunk_size != + bool is_partial_chunk = (partial_chunk_size != uncompressed_chunk_size); DEBUG2("start_offset = %u, end_offset = %u", start_offset, @@ -290,7 +296,7 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, return WIMLIB_ERR_READ; } } - if (fread(out_p, 1, partial_chunk_size, fp) != + if (fread(out_p, 1, partial_chunk_size, fp) != partial_chunk_size) goto err; } else { @@ -298,7 +304,7 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, int ret; /* Read the compressed data into compressed_buf. */ - if (fread(compressed_buf, 1, compressed_chunk_size, + if (fread(compressed_buf, 1, compressed_chunk_size, fp) != compressed_chunk_size) goto err; @@ -309,7 +315,7 @@ static int read_compressed_resource(FILE *fp, u64 resource_compressed_size, ret = decompress(compressed_buf, compressed_chunk_size, - uncompressed_buf, + uncompressed_buf, uncompressed_chunk_size); if (ret != 0) return WIMLIB_ERR_DECOMPRESSION; @@ -340,14 +346,12 @@ err: return WIMLIB_ERR_READ; } -/* +/* * Reads uncompressed data from an open file stream. */ int read_uncompressed_resource(FILE *fp, u64 offset, u64 len, u8 contents_ret[]) { - DEBUG("fp = %p, offset = %lu, len = %lu, contents_ret = %p", - fp, offset, len, contents_ret); if (fseeko(fp, offset, SEEK_SET) != 0) { ERROR("Failed to seek to byte %"PRIu64" of input file " "to read uncompressed resource (len = %"PRIu64")", @@ -367,9 +371,6 @@ int read_uncompressed_resource(FILE *fp, u64 offset, u64 len, return 0; } - - - /* Reads the contents of a struct resource_entry, as represented in the on-disk * format, from the memory pointed to by @p, and fills in the fields of @entry. * A pointer to the byte after the memory read at @p is returned. */ @@ -382,8 +383,21 @@ const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry) p = get_u8(p, &flags); entry->size = size; entry->flags = flags; + + /* offset and original_size are truncated to 62 bits to avoid possible + * overflows, when converting to a signed 64-bit integer (off_t) or when + * adding size or original_size. This is okay since no one would ever + * actually have a WIM bigger than 4611686018427387903 bytes... */ p = get_u64(p, &entry->offset); + if (entry->offset & 0xc000000000000000ULL) { + WARNING("Truncating offset in resource entry"); + entry->offset &= 0x3fffffffffffffffULL; + } p = get_u64(p, &entry->original_size); + if (entry->original_size & 0xc000000000000000ULL) { + WARNING("Truncating original_size in resource entry"); + entry->original_size &= 0x3fffffffffffffffULL; + } return p; } @@ -399,72 +413,134 @@ u8 *put_resource_entry(u8 *p, const struct resource_entry *entry) return p; } +#ifdef WITH_FUSE +static FILE *wim_get_fp(WIMStruct *w) +{ + pthread_mutex_lock(&w->fp_tab_mutex); + FILE *fp; + + wimlib_assert(w->filename != NULL); + + for (size_t i = 0; i < w->num_allocated_fps; i++) { + if (w->fp_tab[i]) { + fp = w->fp_tab[i]; + w->fp_tab[i] = NULL; + goto out; + } + } + DEBUG("Opening extra file descriptor to `%s'", w->filename); + fp = fopen(w->filename, "rb"); + if (!fp) + ERROR_WITH_ERRNO("Failed to open `%s'", w->filename); +out: + pthread_mutex_unlock(&w->fp_tab_mutex); + return fp; +} + +static int wim_release_fp(WIMStruct *w, FILE *fp) +{ + int ret = 0; + FILE **fp_tab; + + pthread_mutex_lock(&w->fp_tab_mutex); + + for (size_t i = 0; i < w->num_allocated_fps; i++) { + if (w->fp_tab[i] == NULL) { + w->fp_tab[i] = fp; + goto out; + } + } + + fp_tab = REALLOC(w->fp_tab, sizeof(FILE*) * (w->num_allocated_fps + 4)); + if (!fp_tab) { + ret = WIMLIB_ERR_NOMEM; + goto out; + } + w->fp_tab = fp_tab; + memset(&w->fp_tab[w->num_allocated_fps], 0, 4 * sizeof(FILE*)); + w->fp_tab[w->num_allocated_fps] = fp; + w->num_allocated_fps += 4; +out: + pthread_mutex_unlock(&w->fp_tab_mutex); + return ret; +} +#endif + /* - * Reads some data from a WIM resource. + * Reads some data from the resource corresponding to a WIM lookup table entry. * - * If %raw is true, compressed data is read literally rather than being - * decompressed first. + * @lte: The WIM lookup table entry for the resource. + * @buf: Buffer into which to write the data. + * @size: Number of bytes to read. + * @offset: Offset at which to start reading the resource. * * Returns zero on success, nonzero on failure. */ -static int __read_wim_resource(const struct lookup_table_entry *lte, - u8 buf[], size_t size, u64 offset, bool raw) +int read_wim_resource(const struct wim_lookup_table_entry *lte, u8 buf[], + size_t size, u64 offset, int flags) { + int ctype; + int ret = 0; + FILE *fp; + /* We shouldn't be allowing read over-runs in any part of the library. * */ - wimlib_assert(offset + size <= wim_resource_size(lte)); - - DEBUG("lte = %p, buf = %p, size = %zu, offset = %lu, raw = %d", - lte, buf, size, offset, raw); - print_lookup_table_entry(lte); + if (flags & WIMLIB_RESOURCE_FLAG_RAW) + wimlib_assert(offset + size <= lte->resource_entry.size); + else + wimlib_assert(offset + size <= lte->resource_entry.original_size); - int ctype; - int ret; - FILE *fp; switch (lte->resource_location) { case RESOURCE_IN_WIM: /* The resource is in a WIM file, and its WIMStruct is given by * the lte->wim member. The resource may be either compressed * or uncompressed. */ - wimlib_assert(lte->wim); - wimlib_assert(lte->wim->fp); + wimlib_assert(lte->wim != NULL); + + #ifdef WITH_FUSE + if (flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED) { + fp = wim_get_fp(lte->wim); + if (!fp) + return WIMLIB_ERR_OPEN; + } else + #endif + { + wimlib_assert(!(flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED)); + wimlib_assert(lte->wim->fp != NULL); + fp = lte->wim->fp; + } + ctype = wim_resource_compression_type(lte); - /* XXX This check should be moved elsewhere */ - if (ctype == WIM_COMPRESSION_TYPE_NONE && - lte->resource_entry.original_size != - lte->resource_entry.size) { - ERROR("WIM resource at offset %"PRIu64", size %"PRIu64 - "has an original size of %"PRIu64", but is " - "uncompressed", - lte->resource_entry.offset, - lte->resource_entry.size, - lte->resource_entry.original_size); - return WIMLIB_ERR_INVALID_RESOURCE_SIZE; - } + wimlib_assert(ctype != WIMLIB_COMPRESSION_TYPE_NONE || + (lte->resource_entry.original_size == + lte->resource_entry.size)); - if (raw || ctype == WIM_COMPRESSION_TYPE_NONE) - return read_uncompressed_resource(lte->wim->fp, - lte->resource_entry.offset, - size, buf); + if ((flags & WIMLIB_RESOURCE_FLAG_RAW) + || ctype == WIMLIB_COMPRESSION_TYPE_NONE) + ret = read_uncompressed_resource(fp, + lte->resource_entry.offset + offset, + size, buf); else - return read_compressed_resource(lte->wim->fp, - lte->resource_entry.size, - lte->resource_entry.original_size, - lte->resource_entry.offset, - ctype, size, offset, buf); + ret = read_compressed_resource(fp, + lte->resource_entry.size, + lte->resource_entry.original_size, + lte->resource_entry.offset, + ctype, size, offset, buf); + #ifdef WITH_FUSE + if (flags & WIMLIB_RESOURCE_FLAG_MULTITHREADED) { + int ret2 = wim_release_fp(lte->wim, fp); + if (ret == 0) + ret = ret2; + } + #endif break; case RESOURCE_IN_STAGING_FILE: - /* The WIM FUSE implementation needs to handle multiple open - * file descriptors per lookup table entry so it does not - * currently work with this function. */ - wimlib_assert(lte->staging_file_name); - wimlib_assert(0); - break; case RESOURCE_IN_FILE_ON_DISK: /* The resource is in some file on the external filesystem and * needs to be read uncompressed */ - wimlib_assert(lte->file_on_disk); + wimlib_assert(lte->file_on_disk != NULL); + BUILD_BUG_ON(<e->file_on_disk != <e->staging_file_name); /* Use existing file pointer if available; otherwise open one * temporarily */ if (lte->file_on_disk_fp) { @@ -474,42 +550,51 @@ static int __read_wim_resource(const struct lookup_table_entry *lte, if (!fp) { ERROR_WITH_ERRNO("Failed to open the file " "`%s'", lte->file_on_disk); + ret = WIMLIB_ERR_OPEN; + break; } } ret = read_uncompressed_resource(fp, offset, size, buf); if (fp != lte->file_on_disk_fp) fclose(fp); - return ret; break; +#if defined(__CYGWIN__) || defined(__WIN32__) + case RESOURCE_WIN32: + wimlib_assert(lte->file_on_disk_fp != NULL); + DEBUG("Calling win32_read_file()"); + ret = win32_read_file(lte->file_on_disk, lte->file_on_disk_fp, + offset, size, buf); + break; +#endif case RESOURCE_IN_ATTACHED_BUFFER: /* The resource is directly attached uncompressed in an * in-memory buffer. */ - wimlib_assert(lte->attached_buffer); + wimlib_assert(lte->attached_buffer != NULL); memcpy(buf, lte->attached_buffer + offset, size); - return 0; break; +#ifdef WITH_NTFS_3G + case RESOURCE_IN_NTFS_VOLUME: + wimlib_assert(lte->ntfs_loc != NULL); + wimlib_assert(lte->attr != NULL); + if (lte->ntfs_loc->is_reparse_point) + offset += 8; + if (ntfs_attr_pread(lte->attr, offset, size, buf) != size) { + ERROR_WITH_ERRNO("Error reading NTFS attribute " + "at `%s'", + lte->ntfs_loc->path_utf8); + ret = WIMLIB_ERR_NTFS_3G; + } + break; +#endif default: - assert(0); + wimlib_assert(0); + ret = -1; + break; } + return ret; } -/* - * Reads some data from the resource corresponding to a WIM lookup table entry. - * - * @lte: The WIM lookup table entry for the resource. - * @buf: Buffer into which to write the data. - * @size: Number of bytes to read. - * @offset: Offset at which to start reading the resource. - * - * Returns 0 on success; nonzero on failure. - */ -int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[], - size_t size, u64 offset) -{ - return __read_wim_resource(lte, buf, size, offset, false); -} - -/* +/* * Reads all the data from the resource corresponding to a WIM lookup table * entry. * @@ -519,299 +604,109 @@ int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[], * * Returns 0 on success; nonzero on failure. */ -int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[]) +int read_full_wim_resource(const struct wim_lookup_table_entry *lte, u8 buf[], + int flags) { - return __read_wim_resource(lte, buf, lte->resource_entry.original_size, - 0, false); + return read_wim_resource(lte, buf, wim_resource_size(lte), 0, flags); } -struct chunk_table { - off_t file_offset; - u64 num_chunks; - u64 original_resource_size; - u64 bytes_per_chunk_entry; - u64 table_disk_size; - u64 cur_offset; - u64 *cur_offset_p; - u64 offsets[0]; -}; - -static int -begin_wim_resource_chunk_tab(const struct 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; - struct chunk_table *chunk_tab = MALLOC(sizeof(struct chunk_table) + - num_chunks * sizeof(u64)); - int ret = 0; - - if (!chunk_tab) { - ERROR("Failed to allocate chunk table for %"PRIu64" byte " - "resource", size); - ret = WIMLIB_ERR_NOMEM; - goto out; - } - chunk_tab->file_offset = file_offset; - chunk_tab->num_chunks = num_chunks; - chunk_tab->cur_offset_p = chunk_tab->offsets; - chunk_tab->original_resource_size = lte->resource_entry.original_size; - chunk_tab->bytes_per_chunk_entry = - (lte->resource_entry.original_size >= (1ULL << 32)) - ? 8 : 4; - chunk_tab->table_disk_size = chunk_tab->bytes_per_chunk_entry * - (num_chunks - 1); - - 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; - } - - *chunk_tab_ret = chunk_tab; -out: - return ret; -} - -static int compress_chunk(const u8 chunk[], unsigned chunk_sz, - u8 compressed_chunk[], - unsigned *compressed_chunk_len_ret, - int ctype) -{ - unsigned compressed_chunk_sz; - int (*compress)(const void *, unsigned, void *, unsigned *); - if (ctype == WIM_COMPRESSION_TYPE_LZX) - compress = lzx_compress; - else - compress = xpress_compress; - return (*compress)(chunk, chunk_sz, compressed_chunk, - compressed_chunk_len_ret); -} - -static int write_wim_resource_chunk(const u8 chunk[], unsigned chunk_size, - FILE *out_fp, int out_ctype, - struct chunk_table *chunk_tab) -{ - const u8 *out_chunk; - unsigned out_chunk_size; - - if (out_ctype == WIM_COMPRESSION_TYPE_NONE) { - out_chunk = chunk; - out_chunk_size = chunk_size; - } else { - u8 *compressed_chunk = alloca(chunk_size); - int ret; - unsigned compressed_chunk_len; - - wimlib_assert(chunk_tab != NULL); - - ret = compress_chunk(chunk, chunk_size, compressed_chunk, - &out_chunk_size, out_ctype); - if (ret > 0) - return ret; - else if (ret < 0) { - out_chunk = chunk; - out_chunk_size = chunk_size; - } else { - out_chunk = compressed_chunk; - } - *chunk_tab->cur_offset_p++ = chunk_tab->cur_offset; - chunk_tab->cur_offset += out_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; - } - return 0; -} - -static int -finish_wim_resource_chunk_tab(struct chunk_table *chunk_tab, - FILE *out_fp, u64 *compressed_size_p) -{ - if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) { - ERROR_WITH_ERRNO("Failed to seet to byte "PRIu64" of output " - "WIM file", chunk_tab->file_offset); - return WIMLIB_ERR_WRITE; - } - - if (chunk_tab->bytes_per_chunk_entry == 8) { - array_to_le64(chunk_tab->offsets, chunk_tab->num_chunks - 1); - } else { - for (u64 i = 0; i < chunk_tab->num_chunks - 1; i++) - ((u32*)chunk_tab->offsets)[i] = - to_le32(chunk_tab->offsets[i]); - } - if (fwrite(chunk_tab->offsets, 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"); - return WIMLIB_ERR_WRITE; - } - if (fseeko(out_fp, chunk_tab->file_offset, SEEK_SET) != 0) { - ERROR_WITH_ERRNO("Failed to seet to byte "PRIu64" of output " - "WIM file", chunk_tab->file_offset); - return WIMLIB_ERR_WRITE; - } - *compressed_size_p = chunk_tab->cur_offset; - return 0; -} - -/* - * Writes a WIM resource to a FILE * opened for writing. The resource may be - * written uncompressed or compressed depending on the @out_ctype parameter. - * - * @lte: The lookup table entry for the WIM resource. - * @out_fp: The FILE * to write the resource to. - * @out_ctype: The compression type of the resource to write. Note: if this is - * the same as the compression type of the WIM resource we - * need to read, we simply copy the data (i.e. we do not - * uncompress it, then compress it again). - * @out_res_entry: If non-NULL, a resource entry that is filled in with the - * offset, original size, compressed size, and compression flag - * of the output resource. +/* Extracts the first @size bytes of a WIM resource to somewhere. In the + * process, the SHA1 message digest of the resource is checked if the full + * resource is being extracted. * - * Returns 0 on success; nonzero on failure. - */ -static int __write_wim_resource(const struct lookup_table_entry *lte, - FILE *out_fp, int out_ctype, - struct resource_entry *out_res_entry) + * @extract_chunk is a function that is called to extract each chunk of the + * resource. */ +int extract_wim_resource(const struct wim_lookup_table_entry *lte, + u64 size, + extract_chunk_func_t extract_chunk, + void *extract_chunk_arg) { - u64 size = wim_resource_size(lte); u64 bytes_remaining = size; - char buf[min(WIM_CHUNK_SIZE, bytes_remaining)]; + u8 buf[min(WIM_CHUNK_SIZE, bytes_remaining)]; u64 offset = 0; - u64 compressed_size = bytes_remaining; int ret = 0; - struct chunk_table *chunk_tab = NULL; - bool raw; - off_t file_offset; - - if (out_res_entry) { - file_offset = ftello(out_fp); - if (file_offset == -1) { - ERROR_WITH_ERRNO("Failed to get offset in output " - "stream"); - return WIMLIB_ERR_WRITE; - } - } - - raw = (wim_resource_compression_type(lte) == out_ctype); - if (raw) - out_ctype = WIM_COMPRESSION_TYPE_NONE; - - if (out_ctype != WIM_COMPRESSION_TYPE_NONE) { - ret = begin_wim_resource_chunk_tab(lte, out_fp, file_offset, - &chunk_tab); - if (ret != 0) - goto out; - } + u8 hash[SHA1_HASH_SIZE]; + bool check_hash = (size == wim_resource_size(lte)); + SHA_CTX ctx; + + if (check_hash) + sha1_init(&ctx); while (bytes_remaining) { - u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE); - ret = __read_wim_resource(lte, buf, to_read, offset, raw); - if (ret != 0) - goto out; - ret = write_wim_resource_chunk(buf, to_read, out_fp, - out_ctype, chunk_tab); + u64 to_read = min(bytes_remaining, sizeof(buf)); + ret = read_wim_resource(lte, buf, to_read, offset, 0); if (ret != 0) - goto out; + return ret; + if (check_hash) + sha1_update(&ctx, buf, to_read); + ret = extract_chunk(buf, to_read, offset, extract_chunk_arg); + if (ret != 0) { + ERROR_WITH_ERRNO("Error extracting WIM resource"); + return ret; + } bytes_remaining -= to_read; offset += to_read; } - if (out_ctype != WIM_COMPRESSION_TYPE_NONE) { - ret = finish_wim_resource_chunk_tab(chunk_tab, out_fp, - &compressed_size); - if (ret != 0) - goto out; - } - if (out_res_entry) { - out_res_entry->size = compressed_size; - out_res_entry->original_size = size; - out_res_entry->offset = file_offset; - if (out_ctype == WIM_COMPRESSION_TYPE_NONE) - out_res_entry->flags = 0; - else - out_res_entry->flags = WIM_RESHDR_FLAG_COMPRESSED; + if (check_hash) { + sha1_final(hash, &ctx); + if (!hashes_equal(hash, lte->hash)) { + #ifdef ENABLE_ERROR_MESSAGES + ERROR("Invalid checksum on the following WIM resource:"); + print_lookup_table_entry(lte, stderr); + #endif + return WIMLIB_ERR_INVALID_RESOURCE_HASH; + } } -out: - FREE(chunk_tab); - return ret; -} - -static int write_wim_resource(struct lookup_table_entry *lte, - FILE *out_fp, int out_ctype) -{ - return __write_wim_resource(lte, out_fp, out_ctype, - <e->output_resource_entry); -} - -static int write_wim_resource_from_buffer(const u8 *buf, u64 buf_size, - FILE *out_fp, int out_ctype, - struct resource_entry *out_res_entry) -{ - struct lookup_table_entry lte; - lte.resource_entry.flags = 0; - lte.resource_entry.original_size = buf_size; - lte.resource_entry.size = buf_size; - lte.resource_entry.offset = 0; - lte.resource_location = RESOURCE_IN_ATTACHED_BUFFER; - lte.attached_buffer = (u8*)buf; - return __write_wim_resource(<e, out_fp, out_ctype, out_res_entry); + return 0; } -/* - * Extracts the first @size bytes of the resource specified by @lte to the open - * file @fd. Returns nonzero on error. - */ -int extract_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd, - u64 size) +/* Write @n bytes from @buf to the file descriptor @fd, retrying on internupt + * and on short writes. + * + * Returns short count and set errno on failure. */ +static ssize_t full_write(int fd, const void *buf, size_t n) { - u64 bytes_remaining = size; - char buf[min(WIM_CHUNK_SIZE, bytes_remaining)]; - u64 offset = 0; - int ret = 0; - - while (bytes_remaining) { - u64 to_read = min(bytes_remaining, WIM_CHUNK_SIZE); - ret = read_wim_resource(lte, buf, to_read, offset); - if (ret != 0) - break; - if (full_write(fd, buf, to_read) < 0) { - ERROR_WITH_ERRNO("Error extracting WIM resource"); - return WIMLIB_ERR_WRITE; + const char *p = buf; + ssize_t ret; + ssize_t total = 0; + + while (total != n) { + ret = write(fd, p, n); + if (ret < 0) { + if (errno == EINTR) + continue; + else + break; } - bytes_remaining -= to_read; - offset += to_read; + total += ret; + p += ret; } - return 0; + return total; } -int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte, int fd) +int extract_wim_chunk_to_fd(const u8 *buf, size_t len, u64 offset, void *arg) { - return extract_wim_resource_to_fd(lte, fd, - lte->resource_entry.original_size); + int fd = *(int*)arg; + ssize_t ret = full_write(fd, buf, len); + if (ret < len) { + ERROR_WITH_ERRNO("Error writing to file descriptor"); + return WIMLIB_ERR_WRITE; + } else { + return 0; + } } -/* +/* * Copies the file resource specified by the lookup table entry @lte from the - * input WIM, pointed to by the fp field of the WIMStruct, to the output WIM, - * pointed to by the out_fp field of the WIMStruct. + * input WIM to the output WIM that has its FILE * given by + * ((WIMStruct*)wim)->out_fp. * * The output_resource_entry, out_refcnt, and part_number fields of @lte are * updated. * - * Metadata resources are not copied (they are handled elsewhere for joining and - * splitting). + * (This function is confusing and should be refactored somehow.) */ -int copy_resource(struct lookup_table_entry *lte, void *wim) +int copy_resource(struct wim_lookup_table_entry *lte, void *wim) { WIMStruct *w = wim; int ret; @@ -820,240 +715,12 @@ int copy_resource(struct lookup_table_entry *lte, void *wim) !w->write_metadata) return 0; - ret = write_wim_resource(lte, w->out_fp, wimlib_get_compression_type(w)); + ret = write_wim_resource(lte, w->out_fp, + wim_resource_compression_type(lte), + <e->output_resource_entry, 0); if (ret != 0) return ret; lte->out_refcnt = lte->refcnt; lte->part_number = w->hdr.part_number; return 0; } - -/* - * Writes a dentry's resources, including the main file resource as well as all - * alternate data streams, to the output file. - * - * @dentry: The dentry for the file. - * @wim_p: A pointer to the WIMStruct. The fields of interest to this - * function are the input and output file streams and the lookup - * table. - * - * @return zero on success, nonzero on failure. - */ -int write_dentry_resources(struct dentry *dentry, void *wim_p) -{ - WIMStruct *w = wim_p; - int ret = 0; - struct lookup_table_entry *lte; - int ctype = wimlib_get_compression_type(w); - - for (unsigned i = 0; i <= dentry->num_ads; i++) { - lte = dentry_stream_lte(dentry, i, w->lookup_table); - if (lte && ++lte->out_refcnt == 1) { - ret = write_wim_resource(lte, w->out_fp, ctype); - if (ret != 0) - break; - } - } - return ret; -} - -/* - * Reads the metadata metadata resource from the WIM file. The metadata - * resource consists of the security data, followed by the directory entry for - * the root directory, followed by all the other directory entries in the - * filesystem. The subdir_offset field of each directory entry gives the start - * of its child entries from the beginning of the metadata resource. An - * end-of-directory is signaled by a directory entry of length '0', really of - * length 8, because that's how long the 'length' field is. - * - * @fp: The FILE* for the input WIM file. - * @wim_ctype: The compression type of the WIM file. - * @imd: Pointer to the image metadata structure. Its - * `lookup_table_entry' member specifies the lookup table entry for - * the metadata resource. The rest of the image metadata entry - * will be filled in by this function. - * - * @return: Zero on success, nonzero on failure. - */ -int read_metadata_resource(FILE *fp, int wim_ctype, struct image_metadata *imd) -{ - u8 *buf; - int ctype; - u32 dentry_offset; - int ret; - struct dentry *dentry; - struct wim_security_data *sd; - struct link_group_table *lgt; - const struct lookup_table_entry *metadata_lte; - const struct resource_entry *res_entry; - - metadata_lte = imd->metadata_lte; - res_entry = &metadata_lte->resource_entry; - - DEBUG("Reading metadata resource: length = %"PRIu64", " - "offset = %"PRIu64"", - res_entry->original_size, res_entry->offset); - - if (res_entry->original_size < 8) { - ERROR("Expected at least 8 bytes for the metadata resource"); - return WIMLIB_ERR_INVALID_RESOURCE_SIZE; - } - - /* Allocate memory for the uncompressed metadata resource. */ - buf = MALLOC(res_entry->original_size); - - if (!buf) { - ERROR("Failed to allocate %"PRIu64" bytes for uncompressed " - "metadata resource", res_entry->original_size); - return WIMLIB_ERR_NOMEM; - } - - /* Determine the compression type of the metadata resource. */ - - /* Read the metadata resource into memory. (It may be compressed.) */ - ret = read_full_wim_resource(metadata_lte, buf); - if (ret != 0) - goto out_free_buf; - - DEBUG("Finished reading metadata resource into memory."); - - /* The root directory entry starts after security data, on an 8-byte - * aligned address. - * - * The security data starts with a 4-byte integer giving its total - * length. */ - - /* Read the security data into a wim_security_data structure. */ - ret = read_security_data(buf, res_entry->original_size, &sd); - if (ret != 0) - goto out_free_buf; - - dentry = MALLOC(sizeof(struct dentry)); - if (!dentry) { - ERROR("Failed to allocate %zu bytes for root dentry", - sizeof(struct dentry)); - ret = WIMLIB_ERR_NOMEM; - goto out_free_security_data; - } - - get_u32(buf, &dentry_offset); - if (dentry_offset == 0) - dentry_offset = 8; - dentry_offset = (dentry_offset + 7) & ~7; - - ret = read_dentry(buf, res_entry->original_size, dentry_offset, dentry); - /* This is the root dentry, so set its pointers correctly. */ - dentry->parent = dentry; - dentry->next = dentry; - dentry->prev = dentry; - if (ret != 0) - goto out_free_dentry_tree; - - DEBUG("Reading dentry tree"); - /* Now read the entire directory entry tree. */ - ret = read_dentry_tree(buf, res_entry->original_size, dentry); - if (ret != 0) - goto out_free_dentry_tree; - - DEBUG("Calculating dentry full paths"); - /* Calculate the full paths in the dentry tree. */ - ret = for_dentry_in_tree(dentry, calculate_dentry_full_path, NULL); - if (ret != 0) - goto out_free_dentry_tree; - - DEBUG("Building link group table"); - /* Build hash table that maps hard link group IDs to dentry sets */ - lgt = new_link_group_table(9001); - if (!lgt) - goto out_free_dentry_tree; - ret = for_dentry_in_tree(dentry, link_group_table_insert, lgt); - if (ret != 0) - goto out_free_lgt; - - DEBUG("Freeing duplicate ADS entries in link group table"); - ret = link_groups_free_duplicate_data(lgt); - if (ret != 0) - goto out_free_lgt; - DEBUG("Done reading image metadata"); - - imd->lgt = lgt; - imd->security_data = sd; - imd->root_dentry = dentry; - goto out_free_buf; -out_free_lgt: - free_link_group_table(lgt); -out_free_dentry_tree: - free_dentry_tree(dentry, NULL); -out_free_security_data: - free_security_data(sd); -out_free_buf: - FREE(buf); - return ret; -} - -/* Write the metadata resource for the current image. */ -int write_metadata_resource(WIMStruct *w) -{ - FILE *out; - u8 *buf; - u8 *p; - int ret; - u64 subdir_offset; - struct dentry *root; - struct lookup_table_entry *lte; - off_t metadata_offset; - u64 metadata_original_size; - u64 metadata_compressed_size; - int metadata_ctype; - u8 hash[SHA1_HASH_SIZE]; - - DEBUG("Writing metadata resource for image %d", w->current_image); - - out = w->out_fp; - root = wim_root_dentry(w); - metadata_ctype = wimlib_get_compression_type(w); - metadata_offset = ftello(out); - if (metadata_offset == -1) - return WIMLIB_ERR_WRITE; - - struct wim_security_data *sd = wim_security_data(w); - if (sd) - subdir_offset = sd->total_length + root->length + 8; - else - subdir_offset = 8 + root->length + 8; - calculate_subdir_offsets(root, &subdir_offset); - metadata_original_size = subdir_offset; - buf = MALLOC(metadata_original_size); - if (!buf) { - ERROR("Failed to allocate %"PRIu64" bytes for " - "metadata resource", metadata_original_size); - return WIMLIB_ERR_NOMEM; - } - - p = write_security_data(sd, buf); - - DEBUG("Writing dentry tree."); - p = write_dentry_tree(root, p); - - /* Like file resources, the lookup table entry for a metadata resource - * uses for the hash code a SHA1 message digest of its uncompressed - * contents. */ - sha1_buffer(buf, metadata_original_size, hash); - - - lte = wim_metadata_lookup_table_entry(w); - - ret = write_wim_resource_from_buffer(buf, metadata_original_size, - out, metadata_ctype, - <e->output_resource_entry); - FREE(buf); - if (ret != 0) - return ret; - - lte->out_refcnt++; - lte->output_resource_entry.flags |= WIM_RESHDR_FLAG_METADATA; - lookup_table_unlink(w->lookup_table, lte); - copy_hash(lte->hash, hash); - lookup_table_insert(w->lookup_table, lte); - return 0; -}