#include "wimlib/apply.h"
#include "wimlib/assert.h"
+#include "wimlib/blob_table.h"
#include "wimlib/capture.h" /* for mangle_pat() and match_pattern_list() */
#include "wimlib/dentry.h"
+#include "wimlib/encoding.h"
#include "wimlib/error.h"
-#include "wimlib/lookup_table.h"
#include "wimlib/metadata.h"
#include "wimlib/paths.h"
+#include "wimlib/pattern.h"
#include "wimlib/reparse.h"
#include "wimlib/textfile.h"
#include "wimlib/xml.h"
-#include "wimlib/wildcard.h"
#include "wimlib/wimboot.h"
+#include "wimlib/wof.h"
struct win32_apply_ctx {
/* WIMBoot information, only filled in if WIMLIB_EXTRACT_FLAG_WIMBOOT
* was provided */
struct {
- u64 data_source_id;
- struct string_set *prepopulate_pats;
- void *mem_prepopulate_pats;
- u8 wim_lookup_table_hash[SHA1_HASH_SIZE];
+ /* This array contains the WIM files registered with WOF on the
+ * target volume for this extraction operation. All WIMStructs
+ * in this array are distinct and have ->filename != NULL. */
+ struct wimboot_wim {
+ WIMStruct *wim;
+ u64 data_source_id;
+ u8 blob_table_hash[SHA1_HASH_SIZE];
+ } *wims;
+ size_t num_wims;
bool wof_running;
- bool tried_to_load_prepopulate_list;
+ bool have_wrong_version_wims;
+ bool have_uncompressed_wims;
+ bool have_unsupported_compressed_resources;
+ bool have_huge_resources;
} wimboot;
+ /* External backing information */
+ struct string_set *prepopulate_pats;
+ void *mem_prepopulate_pats;
+ bool tried_to_load_prepopulate_list;
+
/* Open handle to the target directory */
HANDLE h_target;
* target-relative NT paths */
wchar_t *print_buffer;
- /* Allocated buffer for reading stream data when it cannot be extracted
+ /* Allocated buffer for reading blob data when it cannot be extracted
* directly */
u8 *data_buffer;
/* Array of open handles to filesystem streams currently being written
*/
- HANDLE open_handles[MAX_OPEN_STREAMS];
+ HANDLE open_handles[MAX_OPEN_FILES];
/* Number of handles in @open_handles currently open (filled in from the
* beginning of the array) */
unsigned num_open_handles;
- /* List of dentries, joined by @tmp_list, that need to have reparse data
- * extracted as soon as the whole stream has been read into
+ /* List of dentries, joined by @d_tmp_list, that need to have reparse
+ * data extracted as soon as the whole blob has been read into
* @data_buffer. */
struct list_head reparse_dentries;
- /* List of dentries, joined by @tmp_list, that need to have raw
- * encrypted data extracted as soon as the whole stream has been read
- * into @data_buffer. */
+ /* List of dentries, joined by @d_tmp_list, that need to have raw
+ * encrypted data extracted as soon as the whole blob has been read into
+ * @data_buffer. */
struct list_head encrypted_dentries;
/* Number of files for which we didn't have permission to set the full
/* Number of files for which we couldn't remove the short name. */
unsigned long num_remove_short_name_failures;
+ /* Number of files on which we couldn't set System Compression. */
+ unsigned long num_system_compression_failures;
+
/* Have we tried to enable short name support on the target volume yet?
*/
bool tried_to_enable_short_names;
return 0;
}
-/* Load the patterns from [PrepopulateList] of WimBootCompress.ini in the WIM
- * image being extracted. */
+#define COMPACT_FLAGS (WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K | \
+ WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K | \
+ WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K | \
+ WIMLIB_EXTRACT_FLAG_COMPACT_LZX)
+
+
+
+/*
+ * If not done already, load the patterns from the [PrepopulateList] section of
+ * WimBootCompress.ini in the WIM image being extracted.
+ *
+ * Note: WimBootCompress.ini applies to both types of "external backing":
+ *
+ * - WIM backing ("WIMBoot" - Windows 8.1 and later)
+ * - File backing ("System Compression" - Windows 10 and later)
+ */
static int
load_prepopulate_pats(struct win32_apply_ctx *ctx)
{
const wchar_t *path = L"\\Windows\\System32\\WimBootCompress.ini";
struct wim_dentry *dentry;
- struct wim_lookup_table_entry *lte;
+ const struct blob_descriptor *blob;
int ret;
void *buf;
struct string_set *s;
void *mem;
struct text_file_section sec;
- ctx->wimboot.tried_to_load_prepopulate_list = true;
+ if (ctx->tried_to_load_prepopulate_list)
+ return 0;
+
+ ctx->tried_to_load_prepopulate_list = true;
dentry = get_dentry(ctx->common.wim, path, WIMLIB_CASE_INSENSITIVE);
if (!dentry ||
(dentry->d_inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
FILE_ATTRIBUTE_REPARSE_POINT |
FILE_ATTRIBUTE_ENCRYPTED)) ||
- !(lte = inode_unnamed_lte(dentry->d_inode, ctx->common.wim->lookup_table)))
+ !(blob = inode_get_blob_for_unnamed_data_stream(dentry->d_inode,
+ ctx->common.wim->blob_table)))
{
- WARNING("%ls does not exist in WIM image!", path);
+ WARNING("%ls does not exist in the WIM image.\n"
+ " The default configuration will be used instead; it assumes that all\n"
+ " files are valid for external backing regardless of path, equivalent\n"
+ " to an empty [PrepopulateList] section.", path);
return WIMLIB_ERR_PATH_DOES_NOT_EXIST;
}
- ret = read_full_stream_into_alloc_buf(lte, &buf);
+ ret = read_blob_into_alloc_buf(blob, &buf);
if (ret)
return ret;
sec.name = T("PrepopulateList");
sec.strings = s;
- ret = do_load_text_file(path, buf, lte->size, &mem, &sec, 1,
+ ret = do_load_text_file(path, buf, blob->size, &mem, &sec, 1,
LOAD_TEXT_FILE_REMOVE_QUOTES |
LOAD_TEXT_FILE_NO_WARNINGS,
mangle_pat);
FREE(s);
return ret;
}
- ctx->wimboot.prepopulate_pats = s;
- ctx->wimboot.mem_prepopulate_pats = mem;
+ ctx->prepopulate_pats = s;
+ ctx->mem_prepopulate_pats = mem;
return 0;
}
-/* Returns %true if the specified absolute path to a file in the WIM image
- * matches a pattern in [PrepopulateList] of WimBootCompress.ini. Otherwise
- * returns %false. */
-static bool
-in_prepopulate_list(const wchar_t *path, size_t path_nchars,
- const struct win32_apply_ctx *ctx)
-{
- const struct string_set *pats = ctx->wimboot.prepopulate_pats;
-
- if (!pats || !pats->num_strings)
- return false;
-
- return match_pattern_list(path, path_nchars, pats);
-}
-
/* Returns %true if the specified absolute path to a file in the WIM image can
* be subject to external backing when extracted. Otherwise returns %false. */
static bool
-can_externally_back_path(const wchar_t *path, size_t path_nchars,
- const struct win32_apply_ctx *ctx)
+can_externally_back_path(const wchar_t *path, const struct win32_apply_ctx *ctx)
{
- if (in_prepopulate_list(path, path_nchars, ctx))
+ /* Does the path match a pattern given in the [PrepopulateList] section
+ * of WimBootCompress.ini? */
+ if (ctx->prepopulate_pats && match_pattern_list(path, ctx->prepopulate_pats))
return false;
/* Since we attempt to modify the SYSTEM registry after it's extracted
* However, a WIM that wasn't specifically captured in "WIMBoot mode"
* may contain SYSTEM.* files. So to make things "just work", hard-code
* the pattern. */
- if (match_path(path, path_nchars, L"\\Windows\\System32\\config\\SYSTEM*",
- OS_PREFERRED_PATH_SEPARATOR, false))
+ if (match_path(path, L"\\Windows\\System32\\config\\SYSTEM*", false))
return false;
return true;
}
-#define WIM_BACKING_NOT_ENABLED -1
-#define WIM_BACKING_NOT_POSSIBLE -2
-#define WIM_BACKING_EXCLUDED -3
+/* Can the specified WIM resource be used as the source of an external backing
+ * for the wof.sys WIM provider? */
+static bool
+is_resource_valid_for_external_backing(const struct wim_resource_descriptor *rdesc,
+ struct win32_apply_ctx *ctx)
+{
+ /* Must be the original WIM file format. This check excludes pipable
+ * resources and solid resources. It also excludes other resources
+ * contained in such files even if they would be otherwise compatible.
+ */
+ if (rdesc->wim->hdr.magic != WIM_MAGIC ||
+ rdesc->wim->hdr.wim_version != WIM_VERSION_DEFAULT)
+ {
+ ctx->wimboot.have_wrong_version_wims = true;
+ return false;
+ }
+
+ /*
+ * Whitelist of compression types and chunk sizes supported by
+ * Microsoft's WOF driver.
+ *
+ * Notes:
+ * - Uncompressed WIMs result in BSOD. However, this only applies to
+ * the WIM file itself, not to uncompressed resources in a WIM file
+ * that is otherwise compressed.
+ * - XPRESS 64K sometimes appears to work, but sometimes it causes
+ * reads to fail with STATUS_UNSUCCESSFUL.
+ */
+ switch (rdesc->compression_type) {
+ case WIMLIB_COMPRESSION_TYPE_NONE:
+ if (rdesc->wim->compression_type == WIMLIB_COMPRESSION_TYPE_NONE) {
+ ctx->wimboot.have_uncompressed_wims = true;
+ return false;
+ }
+ break;
+ case WIMLIB_COMPRESSION_TYPE_XPRESS:
+ switch (rdesc->chunk_size) {
+ case 4096:
+ case 8192:
+ case 16384:
+ case 32768:
+ break;
+ default:
+ ctx->wimboot.have_unsupported_compressed_resources = true;
+ return false;
+ }
+ break;
+ case WIMLIB_COMPRESSION_TYPE_LZX:
+ switch (rdesc->chunk_size) {
+ case 32768:
+ break;
+ default:
+ ctx->wimboot.have_unsupported_compressed_resources = true;
+ return false;
+ }
+ break;
+ default:
+ ctx->wimboot.have_unsupported_compressed_resources = true;
+ return false;
+ }
+
+ /* Microsoft's WoF driver errors out if it tries to satisfy a read with
+ * ending offset >= 4 GiB from an externally backed file. */
+ if (rdesc->uncompressed_size > 4200000000) {
+ ctx->wimboot.have_huge_resources = true;
+ return false;
+ }
+ return true;
+}
+
+#define EXTERNAL_BACKING_NOT_ENABLED -1
+#define EXTERNAL_BACKING_NOT_POSSIBLE -2
+#define EXTERNAL_BACKING_EXCLUDED -3
+
+/*
+ * Determines whether the specified file will be externally backed. Returns a
+ * negative status code if no, 0 if yes, or a positive wimlib error code on
+ * error. If the file is excluded from external backing based on its path, then
+ * *excluded_dentry_ret is set to the dentry for the path that matched the
+ * exclusion rule.
+ *
+ * Note that this logic applies to both types of "external backing":
+ *
+ * - WIM backing ("WIMBoot" - Windows 8.1 and later)
+ * - File backing ("System Compression" - Windows 10 and later)
+ *
+ * However, in the case of WIM backing we also need to validate that the WIM
+ * resource that would be the source of the backing is supported by the wof.sys
+ * WIM provider.
+ */
static int
will_externally_back_inode(struct wim_inode *inode, struct win32_apply_ctx *ctx,
- const struct wim_dentry **excluded_dentry_ret)
+ const struct wim_dentry **excluded_dentry_ret,
+ bool wimboot_mode)
{
- struct list_head *next;
struct wim_dentry *dentry;
- struct wim_lookup_table_entry *stream;
+ struct blob_descriptor *blob;
int ret;
+ if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
+ return WIMLIB_ERR_NOMEM;
+
if (inode->i_can_externally_back)
return 0;
if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
FILE_ATTRIBUTE_REPARSE_POINT |
FILE_ATTRIBUTE_ENCRYPTED))
- return WIM_BACKING_NOT_POSSIBLE;
+ return EXTERNAL_BACKING_NOT_POSSIBLE;
- stream = inode_unnamed_lte_resolved(inode);
+ blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
- if (!stream ||
- stream->resource_location != RESOURCE_IN_WIM ||
- stream->rspec->wim != ctx->common.wim ||
- stream->size != stream->rspec->uncompressed_size)
- return WIM_BACKING_NOT_POSSIBLE;
+ if (!blob)
+ return EXTERNAL_BACKING_NOT_POSSIBLE;
+
+ if (wimboot_mode &&
+ (blob->blob_location != BLOB_IN_WIM ||
+ !is_resource_valid_for_external_backing(blob->rdesc, ctx)))
+ return EXTERNAL_BACKING_NOT_POSSIBLE;
/*
* We need to check the patterns in [PrepopulateList] against every name
* of the inode, in case any of them match.
*/
- next = inode->i_extraction_aliases.next;
- do {
- dentry = list_entry(next, struct wim_dentry,
- d_extraction_alias_node);
+
+ inode_for_each_extraction_alias(dentry, inode) {
ret = calculate_dentry_full_path(dentry);
if (ret)
return ret;
- if (!can_externally_back_path(dentry->_full_path,
- wcslen(dentry->_full_path), ctx))
- {
+ if (!can_externally_back_path(dentry->d_full_path, ctx)) {
if (excluded_dentry_ret)
*excluded_dentry_ret = dentry;
- return WIM_BACKING_EXCLUDED;
+ return EXTERNAL_BACKING_EXCLUDED;
}
- next = next->next;
- } while (next != &inode->i_extraction_aliases);
+ }
inode->i_can_externally_back = 1;
return 0;
}
/*
- * Determines if the unnamed data stream of a file will be created as an
- * external backing, as opposed to a standard extraction.
+ * Determines if the unnamed data stream of a file will be created as a WIM
+ * external backing (a "WIMBoot pointer file"), as opposed to a standard
+ * extraction.
*/
static int
-win32_will_externally_back(struct wim_dentry *dentry, struct apply_ctx *_ctx)
+win32_will_back_from_wim(struct wim_dentry *dentry, struct apply_ctx *_ctx)
{
struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
- return WIM_BACKING_NOT_ENABLED;
+ return EXTERNAL_BACKING_NOT_ENABLED;
- if (!ctx->wimboot.tried_to_load_prepopulate_list)
- if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
- return WIMLIB_ERR_NOMEM;
+ return will_externally_back_inode(dentry->d_inode, ctx, NULL, true);
+}
- return will_externally_back_inode(dentry->d_inode, ctx, NULL);
+/* Find the WOF registration information for the specified WIM file. */
+static struct wimboot_wim *
+find_wimboot_wim(WIMStruct *wim_to_find, struct win32_apply_ctx *ctx)
+{
+ for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
+ if (wim_to_find == ctx->wimboot.wims[i].wim)
+ return &ctx->wimboot.wims[i];
+
+ wimlib_assert(0);
+ return NULL;
}
static int
-set_external_backing(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
+set_backed_from_wim(HANDLE h, struct wim_inode *inode, struct win32_apply_ctx *ctx)
{
int ret;
const struct wim_dentry *excluded_dentry;
+ const struct blob_descriptor *blob;
+ const struct wimboot_wim *wimboot_wim;
- ret = will_externally_back_inode(inode, ctx, &excluded_dentry);
+ ret = will_externally_back_inode(inode, ctx, &excluded_dentry, true);
if (ret > 0) /* Error. */
return ret;
- if (ret < 0 && ret != WIM_BACKING_EXCLUDED)
+ if (ret < 0 && ret != EXTERNAL_BACKING_EXCLUDED)
return 0; /* Not externally backing, other than due to exclusion. */
- if (unlikely(ret == WIM_BACKING_EXCLUDED)) {
+ if (unlikely(ret == EXTERNAL_BACKING_EXCLUDED)) {
/* Not externally backing due to exclusion. */
union wimlib_progress_info info;
build_extraction_path(excluded_dentry, ctx);
- info.wimboot_exclude.path_in_wim = excluded_dentry->_full_path;
+ info.wimboot_exclude.path_in_wim = excluded_dentry->d_full_path;
info.wimboot_exclude.extraction_path = current_path(ctx);
return call_progress(ctx->common.progfunc,
WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE,
&info, ctx->common.progctx);
- } else {
- /* Externally backing. */
- if (unlikely(!wimboot_set_pointer(h,
- inode_unnamed_lte_resolved(inode),
- ctx->wimboot.data_source_id,
- ctx->wimboot.wim_lookup_table_hash,
- ctx->wimboot.wof_running)))
- {
- const DWORD err = GetLastError();
+ }
- build_extraction_path(inode_first_extraction_dentry(inode), ctx);
- win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
- current_path(ctx));
- return WIMLIB_ERR_WIMBOOT;
- }
- return 0;
+ /* Externally backing. */
+
+ blob = inode_get_blob_for_unnamed_data_stream_resolved(inode);
+ wimboot_wim = find_wimboot_wim(blob->rdesc->wim, ctx);
+
+ if (unlikely(!wimboot_set_pointer(h,
+ blob,
+ wimboot_wim->data_source_id,
+ wimboot_wim->blob_table_hash,
+ ctx->wimboot.wof_running)))
+ {
+ const DWORD err = GetLastError();
+
+ build_extraction_path(inode_first_extraction_dentry(inode), ctx);
+ win32_error(err, L"\"%ls\": Couldn't set WIMBoot pointer data",
+ current_path(ctx));
+ return WIMLIB_ERR_WIMBOOT;
}
+ return 0;
}
-/* Calculates the SHA-1 message digest of the WIM's lookup table. */
+/* Calculates the SHA-1 message digest of the WIM's blob table. */
static int
-hash_lookup_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
+hash_blob_table(WIMStruct *wim, u8 hash[SHA1_HASH_SIZE])
{
- return wim_reshdr_to_hash(&wim->hdr.lookup_table_reshdr, wim, hash);
+ return wim_reshdr_to_hash(&wim->hdr.blob_table_reshdr, wim, hash);
}
-/* Prepare for doing a "WIMBoot" extraction by loading patterns from
- * [PrepopulateList] of WimBootCompress.ini and allocating a WOF data source ID
- * on the target volume. */
static int
-start_wimboot_extraction(struct win32_apply_ctx *ctx)
+register_wim_with_wof(WIMStruct *wim, struct win32_apply_ctx *ctx)
{
+ struct wimboot_wim *p;
int ret;
- WIMStruct *wim = ctx->common.wim;
- if (!ctx->wimboot.tried_to_load_prepopulate_list)
- if (load_prepopulate_pats(ctx) == WIMLIB_ERR_NOMEM)
- return WIMLIB_ERR_NOMEM;
+ /* Check if already registered */
+ for (size_t i = 0; i < ctx->wimboot.num_wims; i++)
+ if (wim == ctx->wimboot.wims[i].wim)
+ return 0;
- if (!wim_info_get_wimboot(wim->wim_info, wim->current_image))
- WARNING("Image is not marked as WIMBoot compatible!");
+ /* Not yet registered */
- ret = hash_lookup_table(ctx->common.wim,
- ctx->wimboot.wim_lookup_table_hash);
+ p = REALLOC(ctx->wimboot.wims,
+ (ctx->wimboot.num_wims + 1) * sizeof(ctx->wimboot.wims[0]));
+ if (!p)
+ return WIMLIB_ERR_NOMEM;
+ ctx->wimboot.wims = p;
+
+ ctx->wimboot.wims[ctx->wimboot.num_wims].wim = wim;
+
+ ret = hash_blob_table(wim, ctx->wimboot.wims[ctx->wimboot.num_wims].blob_table_hash);
+ if (ret)
+ return ret;
+
+ ret = wimboot_alloc_data_source_id(wim->filename,
+ wim->hdr.guid,
+ ctx->common.wim->current_image,
+ ctx->common.target,
+ &ctx->wimboot.wims[ctx->wimboot.num_wims].data_source_id,
+ &ctx->wimboot.wof_running);
if (ret)
return ret;
- return wimboot_alloc_data_source_id(wim->filename,
- wim->hdr.guid,
- wim->current_image,
- ctx->common.target,
- &ctx->wimboot.data_source_id,
- &ctx->wimboot.wof_running);
+ ctx->wimboot.num_wims++;
+ return 0;
+}
+
+/* Prepare for doing a "WIMBoot" extraction by registering each source WIM file
+ * with WOF on the target volume. */
+static int
+start_wimboot_extraction(struct list_head *dentry_list, struct win32_apply_ctx *ctx)
+{
+ int ret;
+ struct wim_dentry *dentry;
+
+ if (!wim_info_get_wimboot(ctx->common.wim->wim_info,
+ ctx->common.wim->current_image))
+ WARNING("The WIM image is not marked as WIMBoot compatible. This usually\n"
+ " means it is not intended to be used to back a Windows operating\n"
+ " system. Proceeding anyway.");
+
+ list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
+ struct blob_descriptor *blob;
+
+ ret = win32_will_back_from_wim(dentry, &ctx->common);
+ if (ret > 0) /* Error */
+ return ret;
+ if (ret < 0) /* Won't externally back */
+ continue;
+
+ blob = inode_get_blob_for_unnamed_data_stream_resolved(dentry->d_inode);
+ ret = register_wim_with_wof(blob->rdesc->wim, ctx);
+ if (ret)
+ return ret;
+ }
+
+ if (ctx->wimboot.have_wrong_version_wims) {
+ WARNING("At least one of the source WIM files uses a version of the WIM\n"
+" file format that not supported by Microsoft's wof.sys driver.\n"
+" Files whose data is contained in one of these WIM files will be\n"
+" extracted as full files rather than externally backed.");
+ }
+
+ if (ctx->wimboot.have_uncompressed_wims) {
+ WARNING("At least one of the source WIM files is uncompressed. Files whose\n"
+" data is contained in an uncompressed WIM file will be extracted as\n"
+" full files rather than externally backed, since uncompressed WIM\n"
+" files are not supported by Microsoft's wof.sys driver.");
+ }
+
+ if (ctx->wimboot.have_unsupported_compressed_resources) {
+ WARNING("At least one of the source WIM files uses a compression format that\n"
+" is not supported by Microsoft's wof.sys driver. Files whose data is\n"
+" contained in a compressed resource in one of these WIM files will be\n"
+" extracted as full files rather than externally backed. (The\n"
+" compression formats supported by wof.sys are: XPRESS 4K, XPRESS 8K,\n"
+" XPRESS 16K, XPRESS 32K, and LZX 32K.)");
+ }
+
+ if (ctx->wimboot.have_huge_resources) {
+ WARNING("Some files exceeded 4.2 GB in size. Such files will be extracted\n"
+" as full files rather than externally backed, since very large files\n"
+" are not supported by Microsoft's wof.sys driver.");
+ }
+
+ return 0;
}
static void
inode_longest_named_data_stream_spec(const struct wim_inode *inode)
{
size_t max = 0;
- for (u16 i = 0; i < inode->i_num_ads; i++) {
- size_t len = inode->i_ads_entries[i].stream_name_nbytes;
+ for (unsigned i = 0; i < inode->i_num_streams; i++) {
+ const struct wim_inode_stream *strm = &inode->i_streams[i];
+ if (!stream_is_named_data_stream(strm))
+ continue;
+ size_t len = utf16le_len_chars(strm->stream_name);
if (len > max)
max = len;
}
if (max)
- max = 1 + (max / sizeof(wchar_t));
+ max += 1;
return max;
}
static struct wim_dentry *
first_extraction_alias(const struct wim_inode *inode)
{
- struct list_head *next = inode->i_extraction_aliases.next;
struct wim_dentry *dentry;
- do {
- dentry = list_entry(next, struct wim_dentry,
- d_extraction_alias_node);
+ inode_for_each_extraction_alias(dentry, inode)
if (dentry_has_short_name(dentry))
- break;
- next = next->next;
- } while (next != &inode->i_extraction_aliases);
- return dentry;
+ return dentry;
+ return inode_first_extraction_dentry(inode);
}
/*
name = &ctx->pathbuf.Buffer[ctx->pathbuf.Length / sizeof(wchar_t)];
while (name != ctx->pathbuf.Buffer && *(name - 1) != L'\\')
name--;
- end = mempcpy(name, dentry->short_name, dentry->short_name_nbytes);
+ end = mempcpy(name, dentry->d_short_name, dentry->d_short_name_nbytes);
ctx->pathbuf.Length = ((u8 *)end - (u8 *)ctx->pathbuf.Buffer);
/* Open the conflicting file (by short name). */
*/
size_t bufsize = offsetof(FILE_NAME_INFORMATION, FileName) +
- max(dentry->short_name_nbytes, sizeof(wchar_t)) +
+ max(dentry->d_short_name_nbytes, sizeof(wchar_t)) +
sizeof(wchar_t);
u8 buf[bufsize] _aligned_attribute(8);
FILE_NAME_INFORMATION *info = (FILE_NAME_INFORMATION *)buf;
memset(buf, 0, bufsize);
- info->FileNameLength = dentry->short_name_nbytes;
- memcpy(info->FileName, dentry->short_name, dentry->short_name_nbytes);
+ info->FileNameLength = dentry->d_short_name_nbytes;
+ memcpy(info->FileName, dentry->d_short_name, dentry->d_short_name_nbytes);
retry:
status = (*func_NtSetInformationFile)(h, &ctx->iosb, info, bufsize,
return 0;
if (status == STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME) {
- if (dentry->short_name_nbytes == 0)
+ if (dentry->d_short_name_nbytes == 0)
return 0;
if (!ctx->tried_to_enable_short_names) {
wchar_t volume[7];
* from files.
*/
if (unlikely(status == STATUS_OBJECT_NAME_COLLISION) &&
- dentry->short_name_nbytes && !tried_to_remove_existing)
+ dentry->d_short_name_nbytes && !tried_to_remove_existing)
{
tried_to_remove_existing = true;
status = remove_conflicting_short_name(dentry, ctx);
/* By default, failure to set short names is not an error (since short
* names aren't too important anymore...). */
if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES)) {
- if (dentry->short_name_nbytes)
+ if (dentry->d_short_name_nbytes)
ctx->num_set_short_name_failures++;
else
ctx->num_remove_short_name_failures++;
return WIMLIB_ERR_OPEN;
}
-/* Create empty named data streams.
+/* Set the reparse point @rpbuf of length @rpbuflen on the extracted file
+ * corresponding to the WIM dentry @dentry. */
+static int
+do_set_reparse_point(const struct wim_dentry *dentry,
+ const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
+ struct win32_apply_ctx *ctx)
+{
+ NTSTATUS status;
+ HANDLE h;
+
+ status = create_file(&h, GENERIC_WRITE, NULL,
+ 0, FILE_OPEN, 0, dentry, ctx);
+ if (!NT_SUCCESS(status))
+ goto fail;
+
+ status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
+ &ctx->iosb, FSCTL_SET_REPARSE_POINT,
+ (void *)rpbuf, rpbuflen,
+ NULL, 0);
+ (*func_NtClose)(h);
+
+ if (NT_SUCCESS(status))
+ return 0;
+
+ /* On Windows, by default only the Administrator can create symbolic
+ * links for some reason. By default we just issue a warning if this
+ * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
+ * to get a hard error. */
+ if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
+ && (status == STATUS_PRIVILEGE_NOT_HELD ||
+ status == STATUS_ACCESS_DENIED)
+ && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
+ dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
+ {
+ WARNING("Can't create symbolic link \"%ls\"! \n"
+ " (Need Administrator rights, or at least "
+ "the\n"
+ " SeCreateSymbolicLink privilege.)",
+ current_path(ctx));
+ return 0;
+ }
+
+fail:
+ winnt_error(status, L"Can't set reparse data on \"%ls\"",
+ current_path(ctx));
+ return WIMLIB_ERR_SET_REPARSE_DATA;
+}
+
+/*
+ * Create empty named data streams and potentially a reparse point for the
+ * specified file, if any.
*
- * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
- * in the call to extract_stream_list(). Hence the need for the special case.
+ * Since these won't have blob descriptors, they won't show up in the call to
+ * extract_blob_list(). Hence the need for the special case.
*/
static int
-create_any_empty_ads(const struct wim_dentry *dentry,
+create_empty_streams(const struct wim_dentry *dentry,
struct win32_apply_ctx *ctx)
{
const struct wim_inode *inode = dentry->d_inode;
- bool path_modified = false;
- int ret = 0;
+ int ret;
- if (!ctx->common.supported_features.named_data_streams)
- return 0;
+ for (unsigned i = 0; i < inode->i_num_streams; i++) {
+ const struct wim_inode_stream *strm = &inode->i_streams[i];
- for (u16 i = 0; i < inode->i_num_ads; i++) {
- const struct wim_ads_entry *entry;
- HANDLE h;
+ if (stream_blob_resolved(strm) != NULL)
+ continue;
- entry = &inode->i_ads_entries[i];
+ if (strm->stream_type == STREAM_TYPE_REPARSE_POINT &&
+ ctx->common.supported_features.reparse_points)
+ {
+ u8 buf[REPARSE_DATA_OFFSET] _aligned_attribute(8);
+ struct reparse_buffer_disk *rpbuf =
+ (struct reparse_buffer_disk *)buf;
+ complete_reparse_point(rpbuf, inode, 0);
+ ret = do_set_reparse_point(dentry, rpbuf,
+ REPARSE_DATA_OFFSET, ctx);
+ if (ret)
+ return ret;
+ } else if (stream_is_named_data_stream(strm) &&
+ ctx->common.supported_features.named_data_streams)
+ {
+ HANDLE h;
- /* Not named? */
- if (!entry->stream_name_nbytes)
- continue;
+ build_extraction_path_with_ads(dentry, ctx,
+ strm->stream_name,
+ utf16le_len_chars(strm->stream_name));
+ ret = supersede_file_or_stream(ctx, &h);
- /* Not empty? */
- if (entry->lte)
- continue;
+ build_extraction_path(dentry, ctx);
- build_extraction_path_with_ads(dentry, ctx,
- entry->stream_name,
- entry->stream_name_nbytes /
- sizeof(wchar_t));
- path_modified = true;
- ret = supersede_file_or_stream(ctx, &h);
- if (ret)
- break;
- (*func_NtClose)(h);
+ if (ret)
+ return ret;
+ (*func_NtClose)(h);
+ }
}
- /* Restore the path to the dentry itself */
- if (path_modified)
- build_extraction_path(dentry, ctx);
- return ret;
+
+ return 0;
}
/*
* Returns 0, WIMLIB_ERR_MKDIR, or WIMLIB_ERR_SET_SHORT_NAME.
*/
static int
-create_directory(const struct wim_dentry *dentry,
- struct win32_apply_ctx *ctx)
+create_directory(const struct wim_dentry *dentry, struct win32_apply_ctx *ctx)
{
- HANDLE h;
+ DWORD perms;
NTSTATUS status;
+ HANDLE h;
int ret;
/* DELETE is needed for set_short_name(); GENERIC_READ and GENERIC_WRITE
- * are needed for adjust_compression_attribute().
- *
- * FILE_ATTRIBUTE_SYSTEM is needed to ensure that
+ * are needed for adjust_compression_attribute(). */
+ perms = GENERIC_READ | GENERIC_WRITE;
+ if (!dentry_is_root(dentry))
+ perms |= DELETE;
+
+ /* FILE_ATTRIBUTE_SYSTEM is needed to ensure that
* FILE_ATTRIBUTE_ENCRYPTED doesn't get set before we want it to be. */
- status = create_file(&h, GENERIC_READ | GENERIC_WRITE | DELETE, NULL,
- FILE_ATTRIBUTE_SYSTEM, FILE_OPEN_IF, FILE_DIRECTORY_FILE,
- dentry, ctx);
+ status = create_file(&h, perms, NULL, FILE_ATTRIBUTE_SYSTEM,
+ FILE_OPEN_IF, FILE_DIRECTORY_FILE, dentry, ctx);
if (!NT_SUCCESS(status)) {
winnt_error(status, L"Can't create directory \"%ls\"",
current_path(ctx));
return WIMLIB_ERR_MKDIR;
}
- ret = set_short_name(h, dentry, ctx);
+ if (ctx->iosb.Information == FILE_OPENED) {
+ /* If we opened an existing directory, try to clear its file
+ * attributes. As far as I know, this only actually makes a
+ * difference in the case where a FILE_ATTRIBUTE_READONLY
+ * directory has a named data stream which needs to be
+ * extracted. You cannot create a named data stream of such a
+ * directory, even though this contradicts Microsoft's
+ * documentation for FILE_ATTRIBUTE_READONLY which states it is
+ * not honored for directories! */
+ FILE_BASIC_INFORMATION basic_info = { .FileAttributes = FILE_ATTRIBUTE_NORMAL };
+ (*func_NtSetInformationFile)(h, &ctx->iosb, &basic_info,
+ sizeof(basic_info), FileBasicInformation);
+ }
- if (!ret)
- ret = adjust_compression_attribute(h, dentry, ctx);
+ if (!dentry_is_root(dentry)) {
+ ret = set_short_name(h, dentry, ctx);
+ if (ret)
+ goto out;
+ }
+ ret = adjust_compression_attribute(h, dentry, ctx);
+out:
(*func_NtClose)(h);
return ret;
}
* FILE_ATTRIBUTE_DIRECTORY|FILE_ATTRIBUTE_REPARSE_POINT, but we
* wait until later to actually set the reparse data. */
- /* If the root dentry is being extracted, it was already done so
- * in prepare_target(). */
- if (!dentry_is_root(dentry)) {
- ret = create_directory(dentry, ctx);
- ret = check_apply_error(dentry, ctx, ret);
- if (ret)
- return ret;
+ ret = create_directory(dentry, ctx);
- ret = create_any_empty_ads(dentry, ctx);
- ret = check_apply_error(dentry, ctx, ret);
- if (ret)
- return ret;
- }
+ if (!ret)
+ ret = create_empty_streams(dentry, ctx);
+
+ ret = check_apply_error(dentry, ctx, ret);
+ if (ret)
+ return ret;
ret = report_file_created(&ctx->common);
if (ret)
if (ret)
goto out_close;
- ret = create_any_empty_ads(dentry, ctx);
+ ret = create_empty_streams(dentry, ctx);
if (ret)
goto out_close;
create_links(HANDLE h, const struct wim_dentry *first_dentry,
struct win32_apply_ctx *ctx)
{
- const struct wim_inode *inode;
- const struct list_head *next;
+ const struct wim_inode *inode = first_dentry->d_inode;
const struct wim_dentry *dentry;
int ret;
- inode = first_dentry->d_inode;
- next = inode->i_extraction_aliases.next;
- do {
- dentry = list_entry(next, struct wim_dentry,
- d_extraction_alias_node);
+ inode_for_each_extraction_alias(dentry, inode) {
if (dentry != first_dentry) {
ret = create_link(h, dentry, ctx);
if (ret)
return ret;
}
- next = next->next;
- } while (next != &inode->i_extraction_aliases);
+ }
return 0;
}
/* "WIMBoot" extraction: set external backing by the WIM file if needed. */
if (!ret && unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT))
- ret = set_external_backing(h, inode, ctx);
+ ret = set_backed_from_wim(h, inode, ctx);
(*func_NtClose)(h);
return ret;
(*func_NtClose)(ctx->open_handles[i]);
}
-/* Prepare to read the next stream, which has size @stream_size, into an
- * in-memory buffer. */
+/* Prepare to read the next blob, which has size @blob_size, into an in-memory
+ * buffer. */
static bool
-prepare_data_buffer(struct win32_apply_ctx *ctx, u64 stream_size)
+prepare_data_buffer(struct win32_apply_ctx *ctx, u64 blob_size)
{
- if (stream_size > ctx->data_buffer_size) {
+ if (blob_size > ctx->data_buffer_size) {
/* Larger buffer needed. */
void *new_buffer;
- if ((size_t)stream_size != stream_size)
+ if ((size_t)blob_size != blob_size)
return false;
- new_buffer = REALLOC(ctx->data_buffer, stream_size);
+ new_buffer = REALLOC(ctx->data_buffer, blob_size);
if (!new_buffer)
return false;
ctx->data_buffer = new_buffer;
- ctx->data_buffer_size = stream_size;
+ ctx->data_buffer_size = blob_size;
}
/* On the first call this changes data_buffer_ptr from NULL, which tells
* extract_chunk() that the data buffer needs to be filled while reading
}
static int
-begin_extract_stream_instance(const struct wim_lookup_table_entry *stream,
- struct wim_dentry *dentry,
- const wchar_t *stream_name,
- struct win32_apply_ctx *ctx)
+begin_extract_blob_instance(const struct blob_descriptor *blob,
+ struct wim_dentry *dentry,
+ const struct wim_inode_stream *strm,
+ struct win32_apply_ctx *ctx)
{
- const struct wim_inode *inode = dentry->d_inode;
- size_t stream_name_nchars = 0;
FILE_ALLOCATION_INFORMATION alloc_info;
HANDLE h;
NTSTATUS status;
- if (unlikely(stream_name))
- stream_name_nchars = wcslen(stream_name);
-
- if (unlikely(stream_name_nchars)) {
- build_extraction_path_with_ads(dentry, ctx,
- stream_name, stream_name_nchars);
- } else {
- build_extraction_path(dentry, ctx);
+ if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
+ /* We can't write the reparse point stream directly; we must set
+ * it with FSCTL_SET_REPARSE_POINT, which requires that all the
+ * data be available. So, stage the data in a buffer. */
+ if (!prepare_data_buffer(ctx, blob->size))
+ return WIMLIB_ERR_NOMEM;
+ list_add_tail(&dentry->d_tmp_list, &ctx->reparse_dentries);
+ return 0;
}
-
- /* Encrypted file? */
- if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED)
- && (stream_name_nchars == 0))
- {
- if (!ctx->common.supported_features.encrypted_files)
- return 0;
-
- /* We can't write encrypted file streams directly; we must use
+ if (unlikely(strm->stream_type == STREAM_TYPE_EFSRPC_RAW_DATA)) {
+ /* We can't write encrypted files directly; we must use
* WriteEncryptedFileRaw(), which requires providing the data
* through a callback function. This can't easily be combined
* with our own callback-based approach.
*
- * The current workaround is to simply read the stream into
- * memory and write the encrypted file from that.
+ * The current workaround is to simply read the blob into memory
+ * and write the encrypted file from that.
*
* TODO: This isn't sufficient for extremely large encrypted
* files. Perhaps we should create an extra thread to write
* such files... */
- if (!prepare_data_buffer(ctx, stream->size))
+ if (!prepare_data_buffer(ctx, blob->size))
return WIMLIB_ERR_NOMEM;
- list_add_tail(&dentry->tmp_list, &ctx->encrypted_dentries);
+ list_add_tail(&dentry->d_tmp_list, &ctx->encrypted_dentries);
return 0;
}
- /* Reparse point?
- *
- * Note: FILE_ATTRIBUTE_REPARSE_POINT is tested *after*
- * FILE_ATTRIBUTE_ENCRYPTED since the WIM format does not store both EFS
- * data and reparse data for the same file, and the EFS data takes
- * precedence. */
- if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
- && (stream_name_nchars == 0))
- {
- if (!ctx->common.supported_features.reparse_points)
- return 0;
-
- /* We can't write the reparse stream directly; we must set it
- * with FSCTL_SET_REPARSE_POINT, which requires that all the
- * data be available. So, stage the data in a buffer. */
-
- if (!prepare_data_buffer(ctx, stream->size))
- return WIMLIB_ERR_NOMEM;
- list_add_tail(&dentry->tmp_list, &ctx->reparse_dentries);
- return 0;
- }
+ /* It's a data stream (may be unnamed or named). */
+ wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
- if (ctx->num_open_handles == MAX_OPEN_STREAMS) {
+ if (ctx->num_open_handles == MAX_OPEN_FILES) {
/* XXX: Fix this. But because of the checks in
- * extract_stream_list(), this can now only happen on a
- * filesystem that does not support hard links. */
+ * extract_blob_list(), this can now only happen on a filesystem
+ * that does not support hard links. */
ERROR("Can't extract data: too many open files!");
return WIMLIB_ERR_UNSUPPORTED;
}
+
+ if (unlikely(stream_is_named(strm))) {
+ build_extraction_path_with_ads(dentry, ctx,
+ strm->stream_name,
+ utf16le_len_chars(strm->stream_name));
+ } else {
+ build_extraction_path(dentry, ctx);
+ }
+
+
/* Open a new handle */
status = do_create_file(&h,
FILE_WRITE_DATA | SYNCHRONIZE,
ctx->open_handles[ctx->num_open_handles++] = h;
/* Allocate space for the data. */
- alloc_info.AllocationSize.QuadPart = stream->size;
+ alloc_info.AllocationSize.QuadPart = blob->size;
(*func_NtSetInformationFile)(h, &ctx->iosb,
&alloc_info, sizeof(alloc_info),
FileAllocationInformation);
return 0;
}
-/* Set the reparse data @rpbuf of length @rpbuflen on the extracted file
- * corresponding to the WIM dentry @dentry. */
-static int
-do_set_reparse_data(const struct wim_dentry *dentry,
- const void *rpbuf, u16 rpbuflen,
- struct win32_apply_ctx *ctx)
-{
- NTSTATUS status;
- HANDLE h;
-
- status = create_file(&h, GENERIC_WRITE, NULL,
- 0, FILE_OPEN, 0, dentry, ctx);
- if (!NT_SUCCESS(status))
- goto fail;
-
- status = (*func_NtFsControlFile)(h, NULL, NULL, NULL,
- &ctx->iosb, FSCTL_SET_REPARSE_POINT,
- (void *)rpbuf, rpbuflen,
- NULL, 0);
- (*func_NtClose)(h);
-
- if (NT_SUCCESS(status))
- return 0;
-
- /* On Windows, by default only the Administrator can create symbolic
- * links for some reason. By default we just issue a warning if this
- * appears to be the problem. Use WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS
- * to get a hard error. */
- if (!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS)
- && (status == STATUS_PRIVILEGE_NOT_HELD ||
- status == STATUS_ACCESS_DENIED)
- && (dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
- dentry->d_inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
- {
- WARNING("Can't create symbolic link \"%ls\"! \n"
- " (Need Administrator rights, or at least "
- "the\n"
- " SeCreateSymbolicLink privilege.)",
- current_path(ctx));
- return 0;
- }
-
-fail:
- winnt_error(status, L"Can't set reparse data on \"%ls\"",
- current_path(ctx));
- return WIMLIB_ERR_SET_REPARSE_DATA;
-}
-
/* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
* pointer to the suffix of the path that begins with the device directly, such
* as e:\Windows\System32. */
L"\\DosDevices\\",
L"\\Device\\",
};
- size_t first_dir_len = 0;
const wchar_t * const end = path + path_nchars;
for (size_t i = 0; i < ARRAY_LEN(dirs); i++) {
size_t len = wcslen(dirs[i]);
- if (len <= (end - path) && !wcsnicmp(path, dirs[i], len)) {
- first_dir_len = len;
- break;
+ if (len <= (end - path) && !wmemcmp(path, dirs[i], len)) {
+ path += len;
+ while (path != end && *path == L'\\')
+ path++;
+ return path;
}
}
- if (first_dir_len == 0)
- return path;
- path += first_dir_len;
- while (path != end && *path == L'\\')
- path++;
return path;
}
-/* Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
- * pointer to the suffix of the path that is device-relative, such as
- * Windows\System32.
+/*
+ * Given a Windows NT namespace path, such as \??\e:\Windows\System32, return a
+ * pointer to the suffix of the path that is device-relative but possibly with
+ * leading slashes, such as \Windows\System32.
*
* The path has an explicit length and is not necessarily null terminated.
- *
- * If the path just something like \??\e: then the returned pointer will point
- * just past the colon. In this case the length of the result will be 0
- * characters. */
+ */
static const wchar_t *
get_device_relative_path(const wchar_t *path, size_t path_nchars)
{
if (path == orig_path)
return orig_path;
- path = wmemchr(path, L'\\', (end - path));
- if (!path)
- return end;
- do {
+ while (path != end && *path != L'\\')
path++;
- } while (path != end && *path == L'\\');
+
return path;
}
/*
- * Given a reparse point buffer for a symbolic link or junction, adjust its
- * contents so that the target of the link is consistent with the new location
- * of the files.
+ * Given a reparse point buffer for an inode for which the absolute link target
+ * was relativized when it was archived, de-relative the link target to be
+ * consistent with the actual extraction location.
*/
static void
-try_rpfix(u8 *rpbuf, u16 *rpbuflen_p, struct win32_apply_ctx *ctx)
+try_rpfix(struct reparse_buffer_disk *rpbuf, u16 *rpbuflen_p,
+ struct win32_apply_ctx *ctx)
{
- struct reparse_data rpdata;
+ struct link_reparse_point link;
size_t orig_subst_name_nchars;
const wchar_t *relpath;
size_t relpath_nchars;
const wchar_t *fixed_print_name;
size_t fixed_print_name_nchars;
- if (parse_reparse_data(rpbuf, *rpbuflen_p, &rpdata)) {
- /* Do nothing if the reparse data is invalid. */
+ /* Do nothing if the reparse data is invalid. */
+ if (parse_link_reparse_point(rpbuf, *rpbuflen_p, &link))
return;
- }
- if (rpdata.rptag == WIM_IO_REPARSE_TAG_SYMLINK &&
- (rpdata.rpflags & SYMBOLIC_LINK_RELATIVE))
- {
- /* Do nothing if it's a relative symbolic link. */
+ /* Do nothing if the reparse point is a relative symbolic link. */
+ if (link_is_relative_symlink(&link))
return;
- }
/* Build the new substitute name from the NT namespace path to the
* target directory, then a path separator, then the "device relative"
* part of the old substitute name. */
- orig_subst_name_nchars = rpdata.substitute_name_nbytes / sizeof(wchar_t);
+ orig_subst_name_nchars = link.substitute_name_nbytes / sizeof(wchar_t);
- relpath = get_device_relative_path(rpdata.substitute_name,
+ relpath = get_device_relative_path(link.substitute_name,
orig_subst_name_nchars);
relpath_nchars = orig_subst_name_nchars -
- (relpath - rpdata.substitute_name);
+ (relpath - link.substitute_name);
target_ntpath_nchars = ctx->target_ntpath.Length / sizeof(wchar_t);
- fixed_subst_name_nchars = target_ntpath_nchars;
- if (relpath_nchars)
- fixed_subst_name_nchars += 1 + relpath_nchars;
+ fixed_subst_name_nchars = target_ntpath_nchars + relpath_nchars;
+
wchar_t fixed_subst_name[fixed_subst_name_nchars];
- wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer,
- target_ntpath_nchars);
- if (relpath_nchars) {
- fixed_subst_name[target_ntpath_nchars] = L'\\';
- wmemcpy(&fixed_subst_name[target_ntpath_nchars + 1],
- relpath, relpath_nchars);
- }
+ wmemcpy(fixed_subst_name, ctx->target_ntpath.Buffer, target_ntpath_nchars);
+ wmemcpy(&fixed_subst_name[target_ntpath_nchars], relpath, relpath_nchars);
/* Doesn't need to be null-terminated. */
/* Print name should be Win32, but not all NT names can even be
fixed_print_name_nchars = fixed_subst_name_nchars - (fixed_print_name -
fixed_subst_name);
- rpdata.substitute_name = fixed_subst_name;
- rpdata.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
- rpdata.print_name = (wchar_t *)fixed_print_name;
- rpdata.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
- make_reparse_buffer(&rpdata, rpbuf, rpbuflen_p);
+ link.substitute_name = fixed_subst_name;
+ link.substitute_name_nbytes = fixed_subst_name_nchars * sizeof(wchar_t);
+ link.print_name = (wchar_t *)fixed_print_name;
+ link.print_name_nbytes = fixed_print_name_nchars * sizeof(wchar_t);
+ make_link_reparse_point(&link, rpbuf, rpbuflen_p);
}
-/* Sets reparse data on the specified file. This handles "fixing" the targets
- * of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX was
- * specified. */
+/* Sets the reparse point on the specified file. This handles "fixing" the
+ * targets of absolute symbolic links and junctions if WIMLIB_EXTRACT_FLAG_RPFIX
+ * was specified. */
static int
-set_reparse_data(const struct wim_dentry *dentry,
- const void *_rpbuf, u16 rpbuflen, struct win32_apply_ctx *ctx)
+set_reparse_point(const struct wim_dentry *dentry,
+ const struct reparse_buffer_disk *rpbuf, u16 rpbuflen,
+ struct win32_apply_ctx *ctx)
{
- const struct wim_inode *inode = dentry->d_inode;
- const void *rpbuf = _rpbuf;
-
if ((ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_RPFIX)
- && !inode->i_not_rpfixed
- && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
- inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
+ && !(dentry->d_inode->i_rp_flags & WIM_RP_FLAG_NOT_FIXED))
{
- memcpy(&ctx->rpfixbuf, _rpbuf, rpbuflen);
- try_rpfix((u8 *)&ctx->rpfixbuf, &rpbuflen, ctx);
+ memcpy(&ctx->rpfixbuf, rpbuf, rpbuflen);
+ try_rpfix(&ctx->rpfixbuf, &rpbuflen, ctx);
rpbuf = &ctx->rpfixbuf;
}
- return do_set_reparse_data(dentry, rpbuf, rpbuflen, ctx);
+ return do_set_reparse_point(dentry, rpbuf, rpbuflen, ctx);
}
return 0;
}
-/* Called when starting to read a stream for extraction on Windows */
+/* Called when starting to read a blob for extraction on Windows */
static int
-begin_extract_stream(struct wim_lookup_table_entry *stream, void *_ctx)
+begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
{
struct win32_apply_ctx *ctx = _ctx;
- const struct stream_owner *owners = stream_owners(stream);
+ const struct blob_extraction_target *targets = blob_extraction_targets(blob);
int ret;
ctx->num_open_handles = 0;
INIT_LIST_HEAD(&ctx->reparse_dentries);
INIT_LIST_HEAD(&ctx->encrypted_dentries);
- for (u32 i = 0; i < stream->out_refcnt; i++) {
- const struct wim_inode *inode = owners[i].inode;
- const wchar_t *stream_name = owners[i].stream_name;
+ for (u32 i = 0; i < blob->out_refcnt; i++) {
+ const struct wim_inode *inode = targets[i].inode;
+ const struct wim_inode_stream *strm = targets[i].stream;
struct wim_dentry *dentry;
- /* A copy of the stream needs to be extracted to @inode. */
+ /* A copy of the blob needs to be extracted to @inode. */
if (ctx->common.supported_features.hard_links) {
dentry = inode_first_extraction_dentry(inode);
- ret = begin_extract_stream_instance(stream, dentry,
- stream_name, ctx);
+ ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
ret = check_apply_error(dentry, ctx, ret);
if (ret)
goto fail;
} else {
- /* Hard links not supported. Extract the stream
+ /* Hard links not supported. Extract the blob
* separately to each alias of the inode. */
- struct list_head *next;
-
- next = inode->i_extraction_aliases.next;
- do {
- dentry = list_entry(next, struct wim_dentry,
- d_extraction_alias_node);
- ret = begin_extract_stream_instance(stream,
- dentry,
- stream_name,
- ctx);
+ inode_for_each_extraction_alias(dentry, inode) {
+ ret = begin_extract_blob_instance(blob, dentry, strm, ctx);
ret = check_apply_error(dentry, ctx, ret);
if (ret)
goto fail;
- next = next->next;
- } while (next != &inode->i_extraction_aliases);
+ }
}
}
return ret;
}
-/* Called when the next chunk of a stream has been read for extraction on
- * Windows */
+/* Called when the next chunk of a blob has been read for extraction on Windows
+ */
static int
extract_chunk(const void *chunk, size_t size, void *_ctx)
{
return 0;
}
-/* Called when a stream has been fully read for extraction on Windows */
static int
-end_extract_stream(struct wim_lookup_table_entry *stream, int status, void *_ctx)
+get_system_compression_format(int extract_flags)
+{
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K)
+ return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS4K;
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K)
+ return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS8K;
+
+ if (extract_flags & WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K)
+ return FILE_PROVIDER_COMPRESSION_FORMAT_XPRESS16K;
+
+ return FILE_PROVIDER_COMPRESSION_FORMAT_LZX;
+}
+
+static DWORD
+set_system_compression(HANDLE h, int format)
+{
+ DWORD bytes_returned;
+ DWORD err;
+ struct {
+ struct wof_external_info wof_info;
+ struct file_provider_external_info file_info;
+ } in = {
+ .wof_info = {
+ .version = WOF_CURRENT_VERSION,
+ .provider = WOF_PROVIDER_FILE,
+ },
+ .file_info = {
+ .version = FILE_PROVIDER_CURRENT_VERSION,
+ .compression_format = format,
+ },
+ };
+
+ if (DeviceIoControl(h, FSCTL_SET_EXTERNAL_BACKING, &in, sizeof(in),
+ NULL, 0, &bytes_returned, NULL))
+ return 0;
+
+ err = GetLastError();
+
+ if (err == 344) /* "Compressing this object would not save space." */
+ return 0;
+
+ return err;
+}
+
+/*
+ * This function is called when doing a "compact-mode" extraction and we just
+ * finished extracting a blob to one or more locations. For each location that
+ * was the unnamed data stream of a file, this function compresses the
+ * corresponding file using System Compression, if allowed.
+ *
+ * Note: we're doing the compression immediately after extracting the data
+ * rather than during a separate compression pass. This way should be faster
+ * since the operating system should still have the file's data cached.
+ *
+ * Note: we're having the operating system do the compression, which is not
+ * ideal because wimlib could create the compressed data faster and more
+ * efficiently (the compressed data format is identical to a WIM resource). But
+ * we seemingly don't have a choice because WOF prevents applications from
+ * creating its reparse points.
+ */
+static void
+handle_system_compression(struct blob_descriptor *blob, struct win32_apply_ctx *ctx)
+{
+ const struct blob_extraction_target *targets = blob_extraction_targets(blob);
+
+ const int format = get_system_compression_format(ctx->common.extract_flags);
+
+ for (u32 i = 0; i < blob->out_refcnt; i++) {
+ struct wim_inode *inode = targets[i].inode;
+ struct wim_inode_stream *strm = targets[i].stream;
+ HANDLE h;
+ NTSTATUS status;
+ DWORD err;
+
+ if (!stream_is_unnamed_data_stream(strm))
+ continue;
+
+ if (will_externally_back_inode(inode, ctx, NULL, false) != 0)
+ continue;
+
+ status = create_file(&h, GENERIC_READ | GENERIC_WRITE, NULL,
+ 0, FILE_OPEN, 0,
+ inode_first_extraction_dentry(inode), ctx);
+
+ if (NT_SUCCESS(status)) {
+ err = set_system_compression(h, format);
+ (*func_NtClose)(h);
+ } else {
+ err = (*func_RtlNtStatusToDosError)(status);
+ }
+
+ if (err == ERROR_INVALID_FUNCTION) {
+ WARNING(
+ "The request to compress the extracted files using System Compression\n"
+" will not be honored because the operating system or target volume\n"
+" does not support it. System Compression is only supported on\n"
+" Windows 10 and later, and only on NTFS volumes.");
+ ctx->common.extract_flags &= ~COMPACT_FLAGS;
+ return;
+ }
+
+ if (err) {
+ ctx->num_system_compression_failures++;
+ if (ctx->num_system_compression_failures < 10) {
+ win32_warning(err, L"\"%ls\": Failed to compress "
+ "extracted file using System Compression",
+ current_path(ctx));
+ } else if (ctx->num_system_compression_failures == 10) {
+ WARNING("Suppressing further warnings about "
+ "System Compression failures.");
+ }
+ }
+ }
+}
+
+/* Called when a blob has been fully read for extraction on Windows */
+static int
+end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
{
struct win32_apply_ctx *ctx = _ctx;
int ret;
if (status)
return status;
+ if (unlikely(ctx->common.extract_flags & COMPACT_FLAGS))
+ handle_system_compression(blob, ctx);
+
if (likely(!ctx->data_buffer_ptr))
return 0;
if (!list_empty(&ctx->reparse_dentries)) {
- if (stream->size > REPARSE_DATA_MAX_SIZE) {
+ if (blob->size > REPARSE_DATA_MAX_SIZE) {
dentry = list_first_entry(&ctx->reparse_dentries,
- struct wim_dentry, tmp_list);
+ struct wim_dentry, d_tmp_list);
build_extraction_path(dentry, ctx);
ERROR("Reparse data of \"%ls\" has size "
"%"PRIu64" bytes (exceeds %u bytes)",
- current_path(ctx), stream->size,
+ current_path(ctx), blob->size,
REPARSE_DATA_MAX_SIZE);
ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
return check_apply_error(dentry, ctx, ret);
}
- /* In the WIM format, reparse streams are just the reparse data
- * and omit the header. But we can reconstruct the header. */
- memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, stream->size);
- ctx->rpbuf.rpdatalen = stream->size;
- ctx->rpbuf.rpreserved = 0;
- list_for_each_entry(dentry, &ctx->reparse_dentries, tmp_list) {
- ctx->rpbuf.rptag = dentry->d_inode->i_reparse_tag;
- ret = set_reparse_data(dentry, &ctx->rpbuf,
- stream->size + REPARSE_DATA_OFFSET,
- ctx);
+ /* Reparse data */
+ memcpy(ctx->rpbuf.rpdata, ctx->data_buffer, blob->size);
+
+ list_for_each_entry(dentry, &ctx->reparse_dentries, d_tmp_list) {
+
+ /* Reparse point header */
+ complete_reparse_point(&ctx->rpbuf, dentry->d_inode,
+ blob->size);
+
+ ret = set_reparse_point(dentry, &ctx->rpbuf,
+ REPARSE_DATA_OFFSET + blob->size,
+ ctx);
ret = check_apply_error(dentry, ctx, ret);
if (ret)
return ret;
}
if (!list_empty(&ctx->encrypted_dentries)) {
- ctx->encrypted_size = stream->size;
- list_for_each_entry(dentry, &ctx->encrypted_dentries, tmp_list) {
+ ctx->encrypted_size = blob->size;
+ list_for_each_entry(dentry, &ctx->encrypted_dentries, d_tmp_list) {
ret = extract_encrypted_file(dentry, ctx);
ret = check_apply_error(dentry, ctx, ret);
if (ret)
NTSTATUS status;
/* Set security descriptor if present and not in NO_ACLS mode */
- if (inode->i_security_id >= 0 &&
+ if (inode_has_security_descriptor(inode) &&
!(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
{
const struct wim_security_data *sd;
}
}
-static uint64_t
+static u64
count_dentries(const struct list_head *dentry_list)
{
const struct list_head *cur;
- uint64_t count = 0;
+ u64 count = 0;
list_for_each(cur, dentry_list)
count++;
{
int ret;
struct win32_apply_ctx *ctx = (struct win32_apply_ctx *)_ctx;
- uint64_t dentry_count;
+ u64 dentry_count;
ret = prepare_target(dentry_list, ctx);
if (ret)
goto out;
if (unlikely(ctx->common.extract_flags & WIMLIB_EXTRACT_FLAG_WIMBOOT)) {
- ret = start_wimboot_extraction(ctx);
+ ret = start_wimboot_extraction(dentry_list, ctx);
if (ret)
goto out;
}
if (ret)
goto out;
- struct read_stream_list_callbacks cbs = {
- .begin_stream = begin_extract_stream,
- .begin_stream_ctx = ctx,
- .consume_chunk = extract_chunk,
- .consume_chunk_ctx = ctx,
- .end_stream = end_extract_stream,
- .end_stream_ctx = ctx,
+ struct read_blob_callbacks cbs = {
+ .begin_blob = begin_extract_blob,
+ .consume_chunk = extract_chunk,
+ .end_blob = end_extract_blob,
+ .ctx = ctx,
};
- ret = extract_stream_list(&ctx->common, &cbs);
+ ret = extract_blob_list(&ctx->common, &cbs);
if (ret)
goto out;
HeapFree(GetProcessHeap(), 0, ctx->target_ntpath.Buffer);
FREE(ctx->pathbuf.Buffer);
FREE(ctx->print_buffer);
- if (ctx->wimboot.prepopulate_pats) {
- FREE(ctx->wimboot.prepopulate_pats->strings);
- FREE(ctx->wimboot.prepopulate_pats);
+ FREE(ctx->wimboot.wims);
+ if (ctx->prepopulate_pats) {
+ FREE(ctx->prepopulate_pats->strings);
+ FREE(ctx->prepopulate_pats);
}
- FREE(ctx->wimboot.mem_prepopulate_pats);
+ FREE(ctx->mem_prepopulate_pats);
FREE(ctx->data_buffer);
return ret;
}
.name = "Windows",
.get_supported_features = win32_get_supported_features,
.extract = win32_extract,
- .will_externally_back = win32_will_externally_back,
+ .will_back_from_wim = win32_will_back_from_wim,
.context_size = sizeof(struct win32_apply_ctx),
};
git://wimlib.net / wimlib / blobdiff