X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwin32_capture.c;h=0d4b783e4086b395d779fa8df64dde45acc9cb94;hp=96b373602747c94808ed62b7da4fdfcc8ddc44d3;hb=d1c07c5254225e35a1ec2f8babe30a27ef6a8a8b;hpb=d5a64bb4299105c93b4e9a95e97b579c6f9254af diff --git a/src/win32_capture.c b/src/win32_capture.c index 96b37360..0d4b783e 100644 --- a/src/win32_capture.c +++ b/src/win32_capture.c @@ -5,7 +5,7 @@ */ /* - * Copyright (C) 2013, 2014, 2015 Eric Biggers + * Copyright (C) 2013-2016 Eric Biggers * * This file 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 @@ -38,10 +38,22 @@ #include "wimlib/error.h" #include "wimlib/paths.h" #include "wimlib/reparse.h" +#include "wimlib/win32_vss.h" +#include "wimlib/wof.h" -struct winnt_scan_stats { +struct winnt_scan_ctx { + struct capture_params *params; + bool is_ntfs; + u32 vol_flags; unsigned long num_get_sd_access_denied; unsigned long num_get_sacl_priv_notheld; + + /* True if WOF is definitely not attached to the volume being scanned; + * false if it may be */ + bool wof_not_attached; + + /* A reference to the VSS snapshot being used, or NULL if none */ + struct vss_snapshot *snapshot; }; static inline const wchar_t * @@ -51,40 +63,215 @@ printable_path(const wchar_t *full_path) return full_path + 4; } +/* Description of where data is located on a Windows filesystem */ +struct windows_file { + + /* Is the data the raw encrypted data of an EFS-encrypted file? */ + u64 is_encrypted : 1; + + /* Is this file "open by file ID" rather than the regular "open by + * path"? "Open by file ID" uses resources more efficiently. */ + u64 is_file_id : 1; + + /* The file's LCN (logical cluster number) for sorting, or 0 if unknown. + */ + u64 sort_key : 62; + + /* Length of the path in bytes, excluding the null terminator if + * present. */ + size_t path_nbytes; + + /* A reference to the VSS snapshot containing the file, or NULL if none. + */ + struct vss_snapshot *snapshot; + + /* The path to the file. If 'is_encrypted=0' this is an NT namespace + * path; if 'is_encrypted=1' this is a Win32 namespace path. If + * 'is_file_id=0', then the path is null-terminated. If 'is_file_id=1' + * (only allowed with 'is_encrypted=0') the path ends with a binary file + * ID and may not be null-terminated. */ + wchar_t path[0]; +}; + +/* Allocate a structure to describe the location of a data stream by path. */ +static struct windows_file * +alloc_windows_file(const wchar_t *path, size_t path_nchars, + const wchar_t *stream_name, size_t stream_name_nchars, + struct vss_snapshot *snapshot, bool is_encrypted) +{ + size_t full_path_nbytes; + struct windows_file *file; + wchar_t *p; + + full_path_nbytes = path_nchars * sizeof(wchar_t); + if (stream_name_nchars) + full_path_nbytes += (1 + stream_name_nchars) * sizeof(wchar_t); + + file = MALLOC(sizeof(struct windows_file) + full_path_nbytes + + sizeof(wchar_t)); + if (!file) + return NULL; + + file->is_encrypted = is_encrypted; + file->is_file_id = 0; + file->sort_key = 0; + file->path_nbytes = full_path_nbytes; + file->snapshot = vss_get_snapshot(snapshot); + p = wmempcpy(file->path, path, path_nchars); + if (stream_name_nchars) { + /* Named data stream */ + *p++ = L':'; + p = wmempcpy(p, stream_name, stream_name_nchars); + } + *p = L'\0'; + return file; +} + +/* Allocate a structure to describe the location of a file by ID. */ +static struct windows_file * +alloc_windows_file_for_file_id(u64 file_id, const wchar_t *root_path, + size_t root_path_nchars, + struct vss_snapshot *snapshot) +{ + size_t full_path_nbytes; + struct windows_file *file; + wchar_t *p; + + full_path_nbytes = (root_path_nchars * sizeof(wchar_t)) + + sizeof(file_id); + file = MALLOC(sizeof(struct windows_file) + full_path_nbytes + + sizeof(wchar_t)); + if (!file) + return NULL; + + file->is_encrypted = 0; + file->is_file_id = 1; + file->sort_key = 0; + file->path_nbytes = full_path_nbytes; + file->snapshot = vss_get_snapshot(snapshot); + p = wmempcpy(file->path, root_path, root_path_nchars); + p = mempcpy(p, &file_id, sizeof(file_id)); + *p = L'\0'; + return file; +} + +/* Add a stream, located on a Windows filesystem, to the specified WIM inode. */ +static int +add_stream(struct wim_inode *inode, struct windows_file *windows_file, + u64 stream_size, int stream_type, const utf16lechar *stream_name, + struct list_head *unhashed_blobs) +{ + struct blob_descriptor *blob = NULL; + struct wim_inode_stream *strm; + int ret; + + if (!windows_file) + goto err_nomem; + + /* If the stream is nonempty, create a blob descriptor for it. */ + if (stream_size) { + blob = new_blob_descriptor(); + if (!blob) + goto err_nomem; + blob->windows_file = windows_file; + blob->blob_location = BLOB_IN_WINDOWS_FILE; + blob->file_inode = inode; + blob->size = stream_size; + windows_file = NULL; + } + + strm = inode_add_stream(inode, stream_type, stream_name, blob); + if (!strm) + goto err_nomem; + + prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs); + ret = 0; +out: + if (windows_file) + free_windows_file(windows_file); + return ret; + +err_nomem: + free_blob_descriptor(blob); + ret = WIMLIB_ERR_NOMEM; + goto out; +} + +struct windows_file * +clone_windows_file(const struct windows_file *file) +{ + struct windows_file *new; + + new = memdup(file, sizeof(*file) + file->path_nbytes + sizeof(wchar_t)); + if (new) + vss_get_snapshot(new->snapshot); + return new; +} + +void +free_windows_file(struct windows_file *file) +{ + vss_put_snapshot(file->snapshot); + FREE(file); +} + +int +cmp_windows_files(const struct windows_file *file1, + const struct windows_file *file2) +{ + /* Compare by starting LCN (logical cluster number) */ + int v = cmp_u64(file1->sort_key, file2->sort_key); + if (v) + return v; + + /* Fall back to comparing files by path (arbitrary heuristic). */ + v = memcmp(file1->path, file2->path, + min(file1->path_nbytes, file2->path_nbytes)); + if (v) + return v; + + return cmp_u32(file1->path_nbytes, file2->path_nbytes); +} + +const wchar_t * +get_windows_file_path(const struct windows_file *file) +{ + return file->path; +} + /* - * If cur_dir is not NULL, open an existing file relative to the already-open - * directory cur_dir. - * - * Otherwise, open the file specified by @path, which must be a Windows NT - * namespace path. + * Open the file named by the NT namespace path @path of length @path_nchars + * characters. If @cur_dir is not NULL then the path is given relative to + * @cur_dir; otherwise the path is absolute. @perms is the access mask of + * permissions to request on the handle. If permission to read the data is + * requested, then SYNCHRONIZE is automatically added. */ static NTSTATUS winnt_openat(HANDLE cur_dir, const wchar_t *path, size_t path_nchars, ACCESS_MASK perms, HANDLE *h_ret) { - UNICODE_STRING name; - OBJECT_ATTRIBUTES attr; + UNICODE_STRING name = { + .Length = path_nchars * sizeof(wchar_t), + .MaximumLength = path_nchars * sizeof(wchar_t), + .Buffer = (wchar_t *)path, + }; + OBJECT_ATTRIBUTES attr = { + .Length = sizeof(attr), + .RootDirectory = cur_dir, + .ObjectName = &name, + }; IO_STATUS_BLOCK iosb; NTSTATUS status; + ULONG options = FILE_OPEN_REPARSE_POINT | FILE_OPEN_FOR_BACKUP_INTENT; - name.Length = path_nchars * sizeof(wchar_t); - name.MaximumLength = name.Length + sizeof(wchar_t); - name.Buffer = (wchar_t *)path; - - attr.Length = sizeof(attr); - attr.RootDirectory = cur_dir; - attr.ObjectName = &name; - attr.Attributes = 0; - attr.SecurityDescriptor = NULL; - attr.SecurityQualityOfService = NULL; - + if (perms & (FILE_READ_DATA | FILE_LIST_DIRECTORY)) { + perms |= SYNCHRONIZE; + options |= FILE_SYNCHRONOUS_IO_NONALERT; + options |= FILE_SEQUENTIAL_ONLY; + } retry: status = (*func_NtOpenFile)(h_ret, perms, &attr, &iosb, - FILE_SHARE_VALID_FLAGS, - FILE_OPEN_REPARSE_POINT | - FILE_OPEN_FOR_BACKUP_INTENT | - FILE_SYNCHRONOUS_IO_NONALERT | - FILE_SEQUENTIAL_ONLY); + FILE_SHARE_VALID_FLAGS, options); if (!NT_SUCCESS(status)) { /* Try requesting fewer permissions */ if (status == STATUS_ACCESS_DENIED || @@ -102,27 +289,68 @@ retry: return status; } -/* Read the first @size bytes from the file, or named data stream of a file, - * described by @blob. */ -int -read_winnt_stream_prefix(const struct blob_descriptor *blob, u64 size, - const struct read_blob_callbacks *cbs) +static NTSTATUS +winnt_open(const wchar_t *path, size_t path_nchars, ACCESS_MASK perms, + HANDLE *h_ret) +{ + return winnt_openat(NULL, path, path_nchars, perms, h_ret); +} + +static const wchar_t * +windows_file_to_string(const struct windows_file *file, u8 *buf, size_t bufsize) +{ + if (file->is_file_id) { + u64 file_id; + memcpy(&file_id, + (u8 *)file->path + file->path_nbytes - sizeof(file_id), + sizeof(file_id)); + swprintf((wchar_t *)buf, L"NTFS inode 0x%016"PRIx64, file_id); + } else if (file->path_nbytes + 3 * sizeof(wchar_t) <= bufsize) { + swprintf((wchar_t *)buf, L"\"%ls\"", file->path); + } else { + return L"(name too long)"; + } + return (wchar_t *)buf; +} + +static int +read_winnt_stream_prefix(const struct windows_file *file, + u64 size, const struct read_blob_callbacks *cbs) { - const wchar_t *path; + IO_STATUS_BLOCK iosb; + UNICODE_STRING name = { + .Buffer = (wchar_t *)file->path, + .Length = file->path_nbytes, + .MaximumLength = file->path_nbytes, + }; + OBJECT_ATTRIBUTES attr = { + .Length = sizeof(attr), + .ObjectName = &name, + }; HANDLE h; NTSTATUS status; - u8 buf[BUFFER_SIZE]; + u8 buf[BUFFER_SIZE] _aligned_attribute(8); u64 bytes_remaining; int ret; - /* This is an NT namespace path. */ - path = blob->file_on_disk; - - status = winnt_openat(NULL, path, wcslen(path), - FILE_READ_DATA | SYNCHRONIZE, &h); - if (!NT_SUCCESS(status)) { - winnt_error(status, L"\"%ls\": Can't open for reading", - printable_path(path)); + status = (*func_NtOpenFile)(&h, FILE_READ_DATA | SYNCHRONIZE, + &attr, &iosb, + FILE_SHARE_VALID_FLAGS, + FILE_OPEN_REPARSE_POINT | + FILE_OPEN_FOR_BACKUP_INTENT | + FILE_SYNCHRONOUS_IO_NONALERT | + FILE_SEQUENTIAL_ONLY | + (file->is_file_id ? FILE_OPEN_BY_FILE_ID : 0)); + if (unlikely(!NT_SUCCESS(status))) { + if (status == STATUS_SHARING_VIOLATION) { + ERROR("Can't open %ls for reading:\n" + " File is in use by another process! " + "Consider using snapshot (VSS) mode.", + windows_file_to_string(file, buf, sizeof(buf))); + } else { + winnt_error(status, L"Can't open %ls for reading", + windows_file_to_string(file, buf, sizeof(buf))); + } return WIMLIB_ERR_OPEN; } @@ -137,10 +365,16 @@ read_winnt_stream_prefix(const struct blob_descriptor *blob, u64 size, status = (*func_NtReadFile)(h, NULL, NULL, NULL, &iosb, buf, count, NULL, NULL); - if (!NT_SUCCESS(status)) { - winnt_error(status, L"\"%ls\": Error reading data", - printable_path(path)); - ret = WIMLIB_ERR_READ; + if (unlikely(!NT_SUCCESS(status))) { + if (status == STATUS_END_OF_FILE) { + ERROR("%ls: File was concurrently truncated", + windows_file_to_string(file, buf, sizeof(buf))); + ret = WIMLIB_ERR_CONCURRENT_MODIFICATION_DETECTED; + } else { + winnt_error(status, L"Error reading data from %ls", + windows_file_to_string(file, buf, sizeof(buf))); + ret = WIMLIB_ERR_READ; + } break; } @@ -182,9 +416,8 @@ win32_encrypted_export_cb(unsigned char *data, void *_ctx, unsigned long len) return ERROR_SUCCESS; } -int -read_win32_encrypted_file_prefix(const struct blob_descriptor *blob, - u64 size, +static int +read_win32_encrypted_file_prefix(const wchar_t *path, bool is_dir, u64 size, const struct read_blob_callbacks *cbs) { struct win32_encrypted_read_ctx export_ctx; @@ -193,18 +426,18 @@ read_win32_encrypted_file_prefix(const struct blob_descriptor *blob, int ret; DWORD flags = 0; - if (blob->file_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) + if (is_dir) flags |= CREATE_FOR_DIR; export_ctx.cbs = cbs; export_ctx.wimlib_err_code = 0; export_ctx.bytes_remaining = size; - err = OpenEncryptedFileRaw(blob->file_on_disk, flags, &file_ctx); + err = OpenEncryptedFileRaw(path, flags, &file_ctx); if (err != ERROR_SUCCESS) { win32_error(err, L"Failed to open encrypted file \"%ls\" for raw read", - printable_path(blob->file_on_disk)); + printable_path(path)); return WIMLIB_ERR_OPEN; } err = ReadEncryptedFileRaw(win32_encrypted_export_cb, @@ -214,14 +447,14 @@ read_win32_encrypted_file_prefix(const struct blob_descriptor *blob, if (ret == 0) { win32_error(err, L"Failed to read encrypted file \"%ls\"", - printable_path(blob->file_on_disk)); + printable_path(path)); ret = WIMLIB_ERR_READ; } } else if (export_ctx.bytes_remaining != 0) { ERROR("Only could read %"PRIu64" of %"PRIu64" bytes from " "encrypted file \"%ls\"", size - export_ctx.bytes_remaining, size, - printable_path(blob->file_on_disk)); + printable_path(path)); ret = WIMLIB_ERR_READ; } else { ret = 0; @@ -230,6 +463,22 @@ read_win32_encrypted_file_prefix(const struct blob_descriptor *blob, return ret; } +/* Read the first @size bytes from the file, or named data stream of a file, + * described by @blob. */ +int +read_windows_file_prefix(const struct blob_descriptor *blob, u64 size, + const struct read_blob_callbacks *cbs) +{ + const struct windows_file *file = blob->windows_file; + + if (unlikely(file->is_encrypted)) { + bool is_dir = (blob->file_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY); + return read_win32_encrypted_file_prefix(file->path, is_dir, size, cbs); + } + + return read_winnt_stream_prefix(file, size, cbs); +} + /* * Load the short name of a file into a WIM dentry. */ @@ -261,10 +510,10 @@ winnt_get_short_name(HANDLE h, struct wim_dentry *dentry) * Load the security descriptor of a file into the corresponding inode and the * WIM image's security descriptor set. */ -static noinline_for_stack NTSTATUS -winnt_get_security_descriptor(HANDLE h, struct wim_inode *inode, - struct wim_sd_set *sd_set, - struct winnt_scan_stats *stats, int add_flags) +static noinline_for_stack int +winnt_load_security_descriptor(HANDLE h, struct wim_inode *inode, + const wchar_t *full_path, + struct winnt_scan_ctx *ctx) { SECURITY_INFORMATION requestedInformation; u8 _buf[4096] _aligned_attribute(8); @@ -336,21 +585,23 @@ winnt_get_security_descriptor(HANDLE h, struct wim_inode *inode, case STATUS_BUFFER_TOO_SMALL: wimlib_assert(buf == _buf); buf = MALLOC(len_needed); - if (!buf) - return STATUS_NO_MEMORY; + if (!buf) { + status = STATUS_NO_MEMORY; + goto out; + } bufsize = len_needed; break; case STATUS_PRIVILEGE_NOT_HELD: case STATUS_ACCESS_DENIED: - if (add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS) { + if (ctx->params->add_flags & WIMLIB_ADD_FLAG_STRICT_ACLS) { default: /* Permission denied in STRICT_ACLS mode, or * unknown error. */ - goto out_free_buf; + goto out; } if (requestedInformation & SACL_SECURITY_INFORMATION) { /* Try again without the SACL. */ - stats->num_get_sacl_priv_notheld++; + ctx->num_get_sacl_priv_notheld++; requestedInformation &= ~(SACL_SECURITY_INFORMATION | LABEL_SECURITY_INFORMATION | BACKUP_SECURITY_INFORMATION); @@ -358,21 +609,26 @@ winnt_get_security_descriptor(HANDLE h, struct wim_inode *inode, } /* Fake success (useful when capturing as * non-Administrator). */ - stats->num_get_sd_access_denied++; + ctx->num_get_sd_access_denied++; status = STATUS_SUCCESS; - goto out_free_buf; + goto out; } } /* Add the security descriptor to the WIM image, and save its ID in * file's inode. */ - inode->i_security_id = sd_set_add_sd(sd_set, buf, len_needed); + inode->i_security_id = sd_set_add_sd(ctx->params->sd_set, buf, len_needed); if (unlikely(inode->i_security_id < 0)) status = STATUS_NO_MEMORY; -out_free_buf: +out: if (unlikely(buf != _buf)) FREE(buf); - return status; + if (!NT_SUCCESS(status)) { + winnt_error(status, L"\"%ls\": Can't read security descriptor", + printable_path(full_path)); + return WIMLIB_ERR_STAT; + } + return 0; } static int @@ -380,20 +636,17 @@ winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret, HANDLE cur_dir, wchar_t *full_path, size_t full_path_nchars, + wchar_t *relative_path, + size_t relative_path_nchars, const wchar_t *filename, - size_t filename_nchars, - struct capture_params *params, - struct winnt_scan_stats *stats, - u32 vol_flags); + struct winnt_scan_ctx *ctx); static int winnt_recurse_directory(HANDLE h, wchar_t *full_path, size_t full_path_nchars, struct wim_dentry *parent, - struct capture_params *params, - struct winnt_scan_stats *stats, - u32 vol_flags) + struct winnt_scan_ctx *ctx) { void *buf; const size_t bufsize = 8192; @@ -415,9 +668,8 @@ winnt_recurse_directory(HANDLE h, { const FILE_NAMES_INFORMATION *info = buf; for (;;) { - if (!(info->FileNameLength == 2 && info->FileName[0] == L'.') && - !(info->FileNameLength == 4 && info->FileName[0] == L'.' && - info->FileName[1] == L'.')) + if (!should_ignore_filename(info->FileName, + info->FileNameLength / 2)) { wchar_t *p; wchar_t *filename; @@ -442,16 +694,15 @@ winnt_recurse_directory(HANDLE h, p - full_path, filename, info->FileNameLength / 2, - params, - stats, - vol_flags); + filename, + ctx); full_path[full_path_nchars] = L'\0'; if (ret) goto out_free_buf; - if (child) - dentry_add_child(parent, child); + attach_scanned_tree(parent, child, + ctx->params->blob_table); } if (info->NextEntryOffset == 0) break; @@ -604,7 +855,7 @@ winnt_rpfix_progress(struct capture_params *params, const wchar_t *path, wmemcpy(print_name0, link->print_name, print_name_nchars); print_name0[print_name_nchars] = L'\0'; - params->progress.scan.cur_path = printable_path(path); + params->progress.scan.cur_path = path; params->progress.scan.symlink_target = print_name0; return do_capture_progress(params, scan_status, NULL); } @@ -630,7 +881,7 @@ winnt_try_rpfix(struct reparse_buffer_disk *rpbuf, u16 *rpbuflen_p, * SYMBOLIC_LINK_RELATIVE. We will use this information, although this * may not always do what the user expects, since drive-relative * symbolic links such as "\Users\Public" have SYMBOLIC_LINK_RELATIVE - * set, in addition to truely relative symbolic links such as "Users" or + * set, in addition to truly relative symbolic links such as "Users" or * "Users\Public". However, WIMGAPI (as of Windows 8.1) has this same * behavior. * @@ -744,6 +995,8 @@ winnt_load_reparse_data(HANDLE h, struct wim_inode *inode, } inode->i_reparse_tag = le32_to_cpu(rpbuf.rptag); + inode->i_rp_reserved = le16_to_cpu(rpbuf.rpreserved); + if (!inode_add_stream_with_data(inode, STREAM_TYPE_REPARSE_POINT, NO_STREAM_NAME, @@ -797,55 +1050,38 @@ win32_get_encrypted_file_size(const wchar_t *path, bool is_dir, u64 *size_ret) } static int -winnt_scan_efsrpc_raw_data(struct wim_inode *inode, const wchar_t *nt_path, - struct list_head *unhashed_blobs) +winnt_scan_efsrpc_raw_data(struct wim_inode *inode, + wchar_t *path, size_t path_nchars, + struct winnt_scan_ctx *ctx) { - struct blob_descriptor *blob; - struct wim_inode_stream *strm; + const bool is_dir = (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY); + struct windows_file *windows_file; + u64 size; int ret; - blob = new_blob_descriptor(); - if (!blob) - goto err_nomem; - - blob->file_on_disk = WCSDUP(nt_path); - if (!blob->file_on_disk) - goto err_nomem; - blob->blob_location = BLOB_WIN32_ENCRYPTED; - /* OpenEncryptedFileRaw() expects a Win32 name. */ - wimlib_assert(!wmemcmp(blob->file_on_disk, L"\\??\\", 4)); - blob->file_on_disk[1] = L'\\'; - - blob->file_inode = inode; + wimlib_assert(!wmemcmp(path, L"\\??\\", 4)); + path[1] = L'\\'; - ret = win32_get_encrypted_file_size(blob->file_on_disk, - (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY), - &blob->size); + ret = win32_get_encrypted_file_size(path, is_dir, &size); if (ret) - goto err; + goto out; /* Empty EFSRPC data does not make sense */ - wimlib_assert(blob->size != 0); - - strm = inode_add_stream(inode, STREAM_TYPE_EFSRPC_RAW_DATA, - NO_STREAM_NAME, blob); - if (!strm) - goto err_nomem; + wimlib_assert(size != 0); - prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs); - return 0; - -err_nomem: - ret = WIMLIB_ERR_NOMEM; -err: - free_blob_descriptor(blob); + windows_file = alloc_windows_file(path, path_nchars, NULL, 0, + ctx->snapshot, true); + ret = add_stream(inode, windows_file, size, STREAM_TYPE_EFSRPC_RAW_DATA, + NO_STREAM_NAME, ctx->params->unhashed_blobs); +out: + path[1] = L'?'; return ret; } static bool -get_data_stream_name(wchar_t *raw_stream_name, size_t raw_stream_name_nchars, - wchar_t **stream_name_ret, size_t *stream_name_nchars_ret) +get_data_stream_name(const wchar_t *raw_stream_name, size_t raw_stream_name_nchars, + const wchar_t **stream_name_ret, size_t *stream_name_nchars_ret) { const wchar_t *sep, *type, *end; @@ -876,81 +1112,31 @@ get_data_stream_name(wchar_t *raw_stream_name, size_t raw_stream_name_nchars, return true; } -/* Build the path to the data stream. For unnamed streams, this is simply the - * path to the file. For named streams, this is the path to the file, followed - * by a colon, followed by the stream name. */ -static wchar_t * -build_data_stream_path(const wchar_t *path, size_t path_nchars, - const wchar_t *stream_name, size_t stream_name_nchars) -{ - size_t stream_path_nchars; - wchar_t *stream_path; - wchar_t *p; - - stream_path_nchars = path_nchars; - if (stream_name_nchars) - stream_path_nchars += 1 + stream_name_nchars; - - stream_path = MALLOC((stream_path_nchars + 1) * sizeof(wchar_t)); - if (stream_path) { - p = wmempcpy(stream_path, path, path_nchars); - if (stream_name_nchars) { - *p++ = L':'; - p = wmempcpy(p, stream_name, stream_name_nchars); - } - *p++ = L'\0'; - } - return stream_path; -} - static int winnt_scan_data_stream(const wchar_t *path, size_t path_nchars, wchar_t *raw_stream_name, size_t raw_stream_name_nchars, - u64 stream_size, - struct wim_inode *inode, struct list_head *unhashed_blobs) + u64 stream_size, struct wim_inode *inode, + struct winnt_scan_ctx *ctx) { wchar_t *stream_name; size_t stream_name_nchars; - struct blob_descriptor *blob; - struct wim_inode_stream *strm; + struct windows_file *windows_file; /* Given the raw stream name (which is something like * :streamname:$DATA), extract just the stream name part (streamname). * Ignore any non-$DATA streams. */ if (!get_data_stream_name(raw_stream_name, raw_stream_name_nchars, - &stream_name, &stream_name_nchars)) + (const wchar_t **)&stream_name, + &stream_name_nchars)) return 0; stream_name[stream_name_nchars] = L'\0'; - /* If the stream is non-empty, set up a blob descriptor for it. */ - if (stream_size != 0) { - blob = new_blob_descriptor(); - if (!blob) - goto err_nomem; - blob->file_on_disk = build_data_stream_path(path, - path_nchars, - stream_name, - stream_name_nchars); - if (!blob->file_on_disk) - goto err_nomem; - blob->blob_location = BLOB_IN_WINNT_FILE_ON_DISK; - blob->size = stream_size; - blob->file_inode = inode; - } else { - blob = NULL; - } - - strm = inode_add_stream(inode, STREAM_TYPE_DATA, stream_name, blob); - if (!strm) - goto err_nomem; - - prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs); - return 0; - -err_nomem: - free_blob_descriptor(blob); - return WIMLIB_ERR_NOMEM; + windows_file = alloc_windows_file(path, path_nchars, + stream_name, stream_name_nchars, + ctx->snapshot, false); + return add_stream(inode, windows_file, stream_size, STREAM_TYPE_DATA, + stream_name, ctx->params->unhashed_blobs); } /* @@ -969,8 +1155,8 @@ err_nomem: */ static noinline_for_stack int winnt_scan_data_streams(HANDLE h, const wchar_t *path, size_t path_nchars, - struct wim_inode *inode, struct list_head *unhashed_blobs, - u64 file_size, u32 vol_flags) + struct wim_inode *inode, u64 file_size, + struct winnt_scan_ctx *ctx) { int ret; u8 _buf[4096] _aligned_attribute(8); @@ -983,7 +1169,7 @@ winnt_scan_data_streams(HANDLE h, const wchar_t *path, size_t path_nchars, buf = _buf; bufsize = sizeof(_buf); - if (!(vol_flags & FILE_NAMED_STREAMS)) + if (!(ctx->vol_flags & FILE_NAMED_STREAMS)) goto unnamed_only; /* Get a buffer containing the stream information. */ @@ -1038,7 +1224,7 @@ winnt_scan_data_streams(HANDLE h, const wchar_t *path, size_t path_nchars, info->StreamName, info->StreamNameLength / 2, info->StreamSize.QuadPart, - inode, unhashed_blobs); + inode, ctx); if (ret) goto out_free_buf; @@ -1066,7 +1252,7 @@ unnamed_only: { wchar_t stream_name[] = L"::$DATA"; ret = winnt_scan_data_stream(path, path_nchars, stream_name, 7, - file_size, inode, unhashed_blobs); + file_size, inode, ctx); } out_free_buf: /* Free buffer if allocated on heap. */ @@ -1075,6 +1261,15 @@ out_free_buf: return ret; } +static u64 +extract_starting_lcn(const RETRIEVAL_POINTERS_BUFFER *extents) +{ + if (extents->ExtentCount < 1) + return 0; + + return extents->Extents[0].Lcn.QuadPart; +} + static noinline_for_stack u64 get_sort_key(HANDLE h) { @@ -1088,10 +1283,7 @@ get_sort_key(HANDLE h) &bytesReturned, NULL)) return 0; - if (out.ExtentCount < 1) - return 0; - - return out.Extents[0].Lcn.QuadPart; + return extract_starting_lcn(&out); } static void @@ -1100,58 +1292,162 @@ set_sort_key(struct wim_inode *inode, u64 sort_key) for (unsigned i = 0; i < inode->i_num_streams; i++) { struct wim_inode_stream *strm = &inode->i_streams[i]; struct blob_descriptor *blob = stream_blob_resolved(strm); - if (blob && (blob->blob_location == BLOB_IN_WINNT_FILE_ON_DISK || - blob->blob_location == BLOB_WIN32_ENCRYPTED)) - blob->sort_key = sort_key; + if (blob && blob->blob_location == BLOB_IN_WINDOWS_FILE) + blob->windows_file->sort_key = sort_key; } } -static noinline_for_stack u32 -get_volume_information(HANDLE h, const wchar_t *full_path, - struct capture_params *params) +static inline bool +should_try_to_use_wimboot_hash(const struct wim_inode *inode, + const struct winnt_scan_ctx *ctx, + const struct capture_params *params) { - FILE_FS_ATTRIBUTE_INFORMATION attr_info; - FILE_FS_VOLUME_INFORMATION vol_info; - IO_STATUS_BLOCK iosb; - NTSTATUS status; - u32 vol_flags; + /* Directories and encrypted files aren't valid for external backing. */ + if (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY | + FILE_ATTRIBUTE_ENCRYPTED)) + return false; - /* Get volume flags */ - status = (*func_NtQueryVolumeInformationFile)(h, &iosb, - &attr_info, - sizeof(attr_info), - FileFsAttributeInformation); - if (likely((NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW) && - (iosb.Information >= - offsetof(FILE_FS_ATTRIBUTE_INFORMATION, - FileSystemAttributes) + - sizeof(attr_info.FileSystemAttributes)))) - { - vol_flags = attr_info.FileSystemAttributes; + /* If the file is a reparse point, then try the hash fixup if it's a WOF + * reparse point and we're in WIMBOOT mode. Otherwise, try the hash + * fixup if WOF may be attached. */ + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) + return (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_WOF) && + (params->add_flags & WIMLIB_ADD_FLAG_WIMBOOT); + return !ctx->wof_not_attached; +} + +/* + * This function implements an optimization for capturing files from a + * filesystem with a backing WIM(s). If a file is WIM-backed, then we can + * retrieve the SHA-1 message digest of its original contents from its reparse + * point. This may eliminate the need to read the file's data and/or allow the + * file's data to be immediately deduplicated with existing data in the WIM. + * + * If WOF is attached, then this function is merely an optimization, but + * potentially a very effective one. If WOF is detached, then this function + * really causes WIM-backed files to be, effectively, automatically + * "dereferenced" when possible; the unnamed data stream is updated to reference + * the original contents and the reparse point is removed. + * + * This function returns 0 if the fixup succeeded or was intentionally not + * executed. Otherwise it returns an error code. + */ +static noinline_for_stack int +try_to_use_wimboot_hash(HANDLE h, struct wim_inode *inode, + struct winnt_scan_ctx *ctx, const wchar_t *full_path) +{ + struct blob_table *blob_table = ctx->params->blob_table; + struct wim_inode_stream *reparse_strm = NULL; + struct wim_inode_stream *strm; + struct blob_descriptor *blob; + u8 hash[SHA1_HASH_SIZE]; + int ret; + + if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) { + struct reparse_buffer_disk rpbuf; + struct { + struct wof_external_info wof_info; + struct wim_provider_rpdata wim_info; + } *rpdata = (void *)rpbuf.rpdata; + struct blob_descriptor *reparse_blob; + + /* The file has a WOF reparse point, so WOF must be detached. + * We can read the reparse point directly. */ + ctx->wof_not_attached = true; + reparse_strm = inode_get_unnamed_stream(inode, STREAM_TYPE_REPARSE_POINT); + reparse_blob = stream_blob_resolved(reparse_strm); + + if (!reparse_blob || reparse_blob->size < sizeof(*rpdata)) + return 0; /* Not a WIM-backed file */ + + ret = read_blob_into_buf(reparse_blob, rpdata); + if (ret) + return ret; + + if (rpdata->wof_info.version != WOF_CURRENT_VERSION || + rpdata->wof_info.provider != WOF_PROVIDER_WIM || + rpdata->wim_info.version != 2) + return 0; /* Not a WIM-backed file */ + + /* Okay, this is a WIM backed file. Get its SHA-1 hash. */ + copy_hash(hash, rpdata->wim_info.unnamed_data_stream_hash); } else { - winnt_warning(status, L"\"%ls\": Can't get volume attributes", - printable_path(full_path)); - vol_flags = 0; + struct { + struct wof_external_info wof_info; + struct wim_provider_external_info wim_info; + } out; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + + /* WOF may be attached. Try reading this file's external + * backing info. */ + status = (*func_NtFsControlFile)(h, NULL, NULL, NULL, &iosb, + FSCTL_GET_EXTERNAL_BACKING, + NULL, 0, &out, sizeof(out)); + + /* Is WOF not attached? */ + if (status == STATUS_INVALID_DEVICE_REQUEST || + status == STATUS_NOT_SUPPORTED) { + ctx->wof_not_attached = true; + return 0; + } + + /* Is this file not externally backed? */ + if (status == STATUS_OBJECT_NOT_EXTERNALLY_BACKED) + return 0; + + /* Does this file have an unknown type of external backing that + * needed a larger information buffer? */ + if (status == STATUS_BUFFER_TOO_SMALL) + return 0; + + /* Was there some other failure? */ + if (status != STATUS_SUCCESS) { + winnt_error(status, + L"\"%ls\": FSCTL_GET_EXTERNAL_BACKING failed", + full_path); + return WIMLIB_ERR_STAT; + } + + /* Is this file backed by a WIM? */ + if (out.wof_info.version != WOF_CURRENT_VERSION || + out.wof_info.provider != WOF_PROVIDER_WIM || + out.wim_info.version != WIM_PROVIDER_CURRENT_VERSION) + return 0; + + /* Okay, this is a WIM backed file. Get its SHA-1 hash. */ + copy_hash(hash, out.wim_info.unnamed_data_stream_hash); } - /* Get volume ID. */ - status = (*func_NtQueryVolumeInformationFile)(h, &iosb, - &vol_info, - sizeof(vol_info), - FileFsVolumeInformation); - if (likely((NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW) && - (iosb.Information >= - offsetof(FILE_FS_VOLUME_INFORMATION, - VolumeSerialNumber) + - sizeof(vol_info.VolumeSerialNumber)))) - { - params->capture_root_dev = vol_info.VolumeSerialNumber; - } else { - winnt_warning(status, L"\"%ls\": Can't get volume ID", - printable_path(full_path)); - params->capture_root_dev = 0; + /* If the file's unnamed data stream is nonempty, then fill in its hash + * and deduplicate it if possible. + * + * With WOF detached, we require that the blob *must* de-duplicable for + * any action can be taken, since without WOF we can't fall back to + * getting the "dereferenced" data by reading the stream (the real + * stream is sparse and contains all zeroes). */ + strm = inode_get_unnamed_data_stream(inode); + if (strm && (blob = stream_blob_resolved(strm))) { + struct blob_descriptor **back_ptr; + + if (reparse_strm && !lookup_blob(blob_table, hash)) + return 0; + back_ptr = retrieve_pointer_to_unhashed_blob(blob); + copy_hash(blob->hash, hash); + if (after_blob_hashed(blob, back_ptr, blob_table) != blob) + free_blob_descriptor(blob); + } + + /* Remove the reparse point, if present. */ + if (reparse_strm) { + inode_remove_stream(inode, reparse_strm, blob_table); + inode->i_attributes &= ~(FILE_ATTRIBUTE_REPARSE_POINT | + FILE_ATTRIBUTE_SPARSE_FILE); + if (inode->i_attributes == 0) + inode->i_attributes = FILE_ATTRIBUTE_NORMAL; } - return vol_flags; + + return 0; } struct file_info { @@ -1188,43 +1484,88 @@ get_file_info(HANDLE h, struct file_info *info) return STATUS_SUCCESS; } -static int -winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret, - HANDLE cur_dir, - wchar_t *full_path, - size_t full_path_nchars, - const wchar_t *filename, - size_t filename_nchars, - struct capture_params *params, - struct winnt_scan_stats *stats, - u32 vol_flags) +static void +get_volume_information(HANDLE h, const wchar_t *full_path, + struct winnt_scan_ctx *ctx) { - struct wim_dentry *root = NULL; + u8 _attr_info[sizeof(FILE_FS_ATTRIBUTE_INFORMATION) + 128] _aligned_attribute(8); + FILE_FS_ATTRIBUTE_INFORMATION *attr_info = (void *)_attr_info; + FILE_FS_VOLUME_INFORMATION vol_info; + struct file_info file_info; + IO_STATUS_BLOCK iosb; + NTSTATUS status; + + /* Get volume flags */ + status = (*func_NtQueryVolumeInformationFile)(h, &iosb, attr_info, + sizeof(_attr_info), + FileFsAttributeInformation); + if (NT_SUCCESS(status)) { + ctx->vol_flags = attr_info->FileSystemAttributes; + ctx->is_ntfs = (attr_info->FileSystemNameLength == 4 * sizeof(wchar_t)) && + !wmemcmp(attr_info->FileSystemName, L"NTFS", 4); + } else { + winnt_warning(status, L"\"%ls\": Can't get volume attributes", + printable_path(full_path)); + } + + /* Get volume ID. */ + status = (*func_NtQueryVolumeInformationFile)(h, &iosb, &vol_info, + sizeof(vol_info), + FileFsVolumeInformation); + if ((NT_SUCCESS(status) || status == STATUS_BUFFER_OVERFLOW) && + (iosb.Information >= offsetof(FILE_FS_VOLUME_INFORMATION, + VolumeSerialNumber) + + sizeof(vol_info.VolumeSerialNumber))) + { + ctx->params->capture_root_dev = vol_info.VolumeSerialNumber; + } else { + winnt_warning(status, L"\"%ls\": Can't get volume ID", + printable_path(full_path)); + } + + /* Get inode number. */ + status = get_file_info(h, &file_info); + if (NT_SUCCESS(status)) { + ctx->params->capture_root_ino = file_info.ino; + } else { + winnt_warning(status, L"\"%ls\": Can't get file information", + printable_path(full_path)); + } +} + +static int +winnt_build_dentry_tree_recursive(struct wim_dentry **root_ret, + HANDLE cur_dir, + wchar_t *full_path, + size_t full_path_nchars, + wchar_t *relative_path, + size_t relative_path_nchars, + const wchar_t *filename, + struct winnt_scan_ctx *ctx) +{ + struct wim_dentry *root = NULL; struct wim_inode *inode = NULL; HANDLE h = NULL; int ret; NTSTATUS status; struct file_info file_info; - ACCESS_MASK requestedPerms; u64 sort_key; - ret = try_exclude(full_path, params); + ret = try_exclude(full_path, ctx->params); if (unlikely(ret < 0)) /* Excluded? */ goto out_progress; if (unlikely(ret > 0)) /* Error? */ goto out; - /* Open the file. */ - requestedPerms = FILE_READ_DATA | - FILE_READ_ATTRIBUTES | - READ_CONTROL | - ACCESS_SYSTEM_SECURITY | - SYNCHRONIZE; -retry_open: - status = winnt_openat(cur_dir, - (cur_dir ? filename : full_path), - (cur_dir ? filename_nchars : full_path_nchars), - requestedPerms, + /* Open the file with permission to read metadata. Although we will + * later need a handle with FILE_LIST_DIRECTORY permission (or, + * equivalently, FILE_READ_DATA; they're the same numeric value) if the + * file is a directory, it can significantly slow things down to request + * this permission on all nondirectories. Perhaps it causes Windows to + * start prefetching the file contents... */ + status = winnt_openat(cur_dir, relative_path, relative_path_nchars, + FILE_READ_ATTRIBUTES | READ_CONTROL | + ACCESS_SYSTEM_SECURITY, &h); if (unlikely(!NT_SUCCESS(status))) { if (status == STATUS_DELETE_PENDING) { @@ -1233,13 +1574,14 @@ retry_open: ret = 0; goto out; } - if (status == STATUS_ACCESS_DENIED && - (requestedPerms & FILE_READ_DATA)) { - /* This happens on encrypted files. */ - requestedPerms &= ~FILE_READ_DATA; - goto retry_open; + if (status == STATUS_SHARING_VIOLATION) { + ERROR("Can't open \"%ls\":\n" + " File is in use by another process! " + "Consider using snapshot (VSS) mode.", + printable_path(full_path)); + ret = WIMLIB_ERR_OPEN; + goto out; } - winnt_error(status, L"\"%ls\": Can't open file", printable_path(full_path)); if (status == STATUS_FVE_LOCKED_VOLUME) @@ -1258,22 +1600,6 @@ retry_open: goto out; } - if (unlikely(!(requestedPerms & FILE_READ_DATA)) && - !(file_info.attributes & FILE_ATTRIBUTE_ENCRYPTED)) - { - ERROR("\"%ls\": Permission to read data was denied", - printable_path(full_path)); - ret = WIMLIB_ERR_OPEN; - goto out; - } - - if (unlikely(!cur_dir)) { - /* Root of tree being captured; get volume information. */ - vol_flags = get_volume_information(h, full_path, params); - params->capture_root_ino = file_info.ino; - } - - /* Create a WIM dentry with an associated inode, which may be shared. * * However, we need to explicitly check for directories and files with @@ -1286,12 +1612,11 @@ retry_open: * can't simply pass 0, because then there could be inode collisions * among multiple calls to win32_build_dentry_tree() that are scanning * files on different volumes. */ - ret = inode_table_new_dentry(params->inode_table, + ret = inode_table_new_dentry(ctx->params->inode_table, filename, file_info.ino, - params->capture_root_dev, - (file_info.num_links <= 1 || - (file_info.attributes & FILE_ATTRIBUTE_DIRECTORY)), + ctx->params->capture_root_dev, + (file_info.num_links <= 1), &root); if (ret) goto out; @@ -1323,24 +1648,17 @@ retry_open: /* Get the file's security descriptor, unless we are capturing in * NO_ACLS mode or the volume does not support security descriptors. */ - if (!(params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS) - && (vol_flags & FILE_PERSISTENT_ACLS)) + if (!(ctx->params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS) + && (ctx->vol_flags & FILE_PERSISTENT_ACLS)) { - status = winnt_get_security_descriptor(h, inode, - params->sd_set, stats, - params->add_flags); - if (!NT_SUCCESS(status)) { - winnt_error(status, - L"\"%ls\": Can't read security descriptor", - printable_path(full_path)); - ret = WIMLIB_ERR_STAT; + ret = winnt_load_security_descriptor(h, inode, full_path, ctx); + if (ret) goto out; - } } /* If this is a reparse point, load the reparse data. */ if (unlikely(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) { - ret = winnt_load_reparse_data(h, inode, full_path, params); + ret = winnt_load_reparse_data(h, inode, full_path, ctx->params); if (ret) goto out; } @@ -1359,7 +1677,7 @@ retry_open: (*func_NtClose)(h); h = NULL; ret = winnt_scan_efsrpc_raw_data(inode, full_path, - params->unhashed_blobs); + full_path_nchars, ctx); if (ret) goto out; } else { @@ -1377,9 +1695,14 @@ retry_open: full_path, full_path_nchars, inode, - params->unhashed_blobs, file_info.end_of_file, - vol_flags); + ctx); + if (ret) + goto out; + } + + if (unlikely(should_try_to_use_wimboot_hash(inode, ctx, ctx->params))) { + ret = try_to_use_wimboot_hash(h, inode, ctx, full_path); if (ret) goto out; } @@ -1390,88 +1713,1076 @@ retry_open: /* Directory: recurse to children. */ - if (unlikely(!h)) { - /* Re-open handle that was closed to read raw encrypted - * data. */ - status = winnt_openat(cur_dir, - (cur_dir ? - filename : full_path), - (cur_dir ? - filename_nchars : full_path_nchars), - FILE_LIST_DIRECTORY | SYNCHRONIZE, - &h); - if (!NT_SUCCESS(status)) { - winnt_error(status, - L"\"%ls\": Can't re-open file", - printable_path(full_path)); - ret = WIMLIB_ERR_OPEN; - goto out; - } + /* Re-open the directory with FILE_LIST_DIRECTORY access. */ + if (h) { + (*func_NtClose)(h); + h = NULL; + } + status = winnt_openat(cur_dir, relative_path, + relative_path_nchars, FILE_LIST_DIRECTORY, + &h); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"\"%ls\": Can't open directory", + printable_path(full_path)); + ret = WIMLIB_ERR_OPEN; + goto out; } ret = winnt_recurse_directory(h, full_path, full_path_nchars, root, - params, - stats, - vol_flags); + ctx); if (ret) goto out; } out_progress: - params->progress.scan.cur_path = printable_path(full_path); + ctx->params->progress.scan.cur_path = full_path; if (likely(root)) - ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode); + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_OK, inode); else - ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL); + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL); out: if (likely(h)) (*func_NtClose)(h); if (unlikely(ret)) { - free_dentry_tree(root, params->blob_table); + free_dentry_tree(root, ctx->params->blob_table); root = NULL; - ret = report_capture_error(params, ret, full_path); + ret = report_capture_error(ctx->params, ret, full_path); } *root_ret = root; return ret; } static void -winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_stats *stats) +winnt_do_scan_warnings(const wchar_t *path, const struct winnt_scan_ctx *ctx) { - if (likely(stats->num_get_sacl_priv_notheld == 0 && - stats->num_get_sd_access_denied == 0)) + if (likely(ctx->num_get_sacl_priv_notheld == 0 && + ctx->num_get_sd_access_denied == 0)) return; WARNING("Scan of \"%ls\" complete, but with one or more warnings:", path); - if (stats->num_get_sacl_priv_notheld != 0) { + if (ctx->num_get_sacl_priv_notheld != 0) { WARNING("- Could not capture SACL (System Access Control List)\n" " on %lu files or directories.", - stats->num_get_sacl_priv_notheld); + ctx->num_get_sacl_priv_notheld); } - if (stats->num_get_sd_access_denied != 0) { + if (ctx->num_get_sd_access_denied != 0) { WARNING("- Could not capture security descriptor at all\n" " on %lu files or directories.", - stats->num_get_sd_access_denied); + ctx->num_get_sd_access_denied); } WARNING("To fully capture all security descriptors, run the program\n" " with Administrator rights."); } +/*----------------------------------------------------------------------------* + * Fast MFT scan implementation * + *----------------------------------------------------------------------------*/ + +#define ENABLE_FAST_MFT_SCAN 1 + +#ifdef ENABLE_FAST_MFT_SCAN + +typedef struct { + u64 StartingCluster; + u64 ClusterCount; +} CLUSTER_RANGE; + +typedef struct { + u64 StartingFileReferenceNumber; + u64 EndingFileReferenceNumber; +} FILE_REFERENCE_RANGE; + +/* The FSCTL_QUERY_FILE_LAYOUT ioctl. This ioctl can be used on Windows 8 and + * later to scan the MFT of an NTFS volume. */ +#define FSCTL_QUERY_FILE_LAYOUT CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 157, METHOD_NEITHER, FILE_ANY_ACCESS) + +/* The input to FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 NumberOfPairs; +#define QUERY_FILE_LAYOUT_RESTART 0x00000001 +#define QUERY_FILE_LAYOUT_INCLUDE_NAMES 0x00000002 +#define QUERY_FILE_LAYOUT_INCLUDE_STREAMS 0x00000004 +#define QUERY_FILE_LAYOUT_INCLUDE_EXTENTS 0x00000008 +#define QUERY_FILE_LAYOUT_INCLUDE_EXTRA_INFO 0x00000010 +#define QUERY_FILE_LAYOUT_INCLUDE_STREAMS_WITH_NO_CLUSTERS_ALLOCATED 0x00000020 + u32 Flags; +#define QUERY_FILE_LAYOUT_FILTER_TYPE_NONE 0 +#define QUERY_FILE_LAYOUT_FILTER_TYPE_CLUSTERS 1 +#define QUERY_FILE_LAYOUT_FILTER_TYPE_FILEID 2 +#define QUERY_FILE_LAYOUT_NUM_FILTER_TYPES 3 + u32 FilterType; + u32 Reserved; + union { + CLUSTER_RANGE ClusterRanges[1]; + FILE_REFERENCE_RANGE FileReferenceRanges[1]; + } Filter; +} QUERY_FILE_LAYOUT_INPUT; + +/* The header of the buffer returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 FileEntryCount; + u32 FirstFileOffset; +#define QUERY_FILE_LAYOUT_SINGLE_INSTANCED 0x00000001 + u32 Flags; + u32 Reserved; +} QUERY_FILE_LAYOUT_OUTPUT; + +/* Inode information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 Version; + u32 NextFileOffset; + u32 Flags; + u32 FileAttributes; + u64 FileReferenceNumber; + u32 FirstNameOffset; + u32 FirstStreamOffset; + u32 ExtraInfoOffset; + u32 Reserved; +} FILE_LAYOUT_ENTRY; + +/* Extra inode information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + struct { + u64 CreationTime; + u64 LastAccessTime; + u64 LastWriteTime; + u64 ChangeTime; + u32 FileAttributes; + } BasicInformation; + u32 OwnerId; + u32 SecurityId; + s64 Usn; +} FILE_LAYOUT_INFO_ENTRY; + +/* Filename (or dentry) information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 NextNameOffset; +#define FILE_LAYOUT_NAME_ENTRY_PRIMARY 0x00000001 +#define FILE_LAYOUT_NAME_ENTRY_DOS 0x00000002 + u32 Flags; + u64 ParentFileReferenceNumber; + u32 FileNameLength; + u32 Reserved; + wchar_t FileName[1]; +} FILE_LAYOUT_NAME_ENTRY; + +/* Stream information returned by FSCTL_QUERY_FILE_LAYOUT */ +typedef struct { + u32 Version; + u32 NextStreamOffset; +#define STREAM_LAYOUT_ENTRY_IMMOVABLE 0x00000001 +#define STREAM_LAYOUT_ENTRY_PINNED 0x00000002 +#define STREAM_LAYOUT_ENTRY_RESIDENT 0x00000004 +#define STREAM_LAYOUT_ENTRY_NO_CLUSTERS_ALLOCATED 0x00000008 + u32 Flags; + u32 ExtentInformationOffset; + u64 AllocationSize; + u64 EndOfFile; + u64 Reserved; + u32 AttributeFlags; + u32 StreamIdentifierLength; + wchar_t StreamIdentifier[1]; +} STREAM_LAYOUT_ENTRY; + + +typedef struct { +#define STREAM_EXTENT_ENTRY_AS_RETRIEVAL_POINTERS 0x00000001 +#define STREAM_EXTENT_ENTRY_ALL_EXTENTS 0x00000002 + u32 Flags; + union { + RETRIEVAL_POINTERS_BUFFER RetrievalPointers; + } ExtentInformation; +} STREAM_EXTENT_ENTRY; + +/* Extract the MFT number part of the full inode number */ +#define NTFS_MFT_NO(ref) ((ref) & (((u64)1 << 48) - 1)) + +/* Is the file the root directory of the NTFS volume? The root directory always + * occupies MFT record 5. */ +#define NTFS_IS_ROOT_FILE(ino) (NTFS_MFT_NO(ino) == 5) + +/* Is the file a special NTFS file, other than the root directory? The special + * files are the first 16 records in the MFT. */ +#define NTFS_IS_SPECIAL_FILE(ino) \ + (NTFS_MFT_NO(ino) <= 15 && !NTFS_IS_ROOT_FILE(ino)) + +/* Intermediate inode structure. This is used to temporarily save information + * from FSCTL_QUERY_FILE_LAYOUT before creating the full 'struct wim_inode'. */ +struct ntfs_inode { + struct avl_tree_node index_node; + u64 ino; + u64 creation_time; + u64 last_access_time; + u64 last_write_time; + u64 starting_lcn; + u32 attributes; + u32 security_id; + u32 num_aliases; + u32 num_streams; + u32 first_stream_offset; + struct ntfs_dentry *first_child; + wchar_t short_name[13]; +}; + +/* Intermediate dentry structure. This is used to temporarily save information + * from FSCTL_QUERY_FILE_LAYOUT before creating the full 'struct wim_dentry'. */ +struct ntfs_dentry { + u32 offset_from_inode : 31; + u32 is_primary : 1; + union { + /* Note: build_children_lists() replaces 'parent_ino' with + * 'next_child'. */ + u64 parent_ino; + struct ntfs_dentry *next_child; + }; + wchar_t name[0]; +}; + +/* Intermediate stream structure. This is used to temporarily save information + * from FSCTL_QUERY_FILE_LAYOUT before creating the full 'struct + * wim_inode_stream'. */ +struct ntfs_stream { + u64 size; + wchar_t name[0]; +}; + +/* Map of all known NTFS inodes, keyed by inode number */ +struct ntfs_inode_map { + struct avl_tree_node *root; +}; + +#define NTFS_INODE(node) \ + avl_tree_entry((node), struct ntfs_inode, index_node) + +#define SKIP_ALIGNED(p, size) ((void *)(p) + ALIGN((size), 8)) + +/* Get a pointer to the first dentry of the inode. */ +#define FIRST_DENTRY(ni) SKIP_ALIGNED((ni), sizeof(struct ntfs_inode)) + +/* Get a pointer to the first stream of the inode. */ +#define FIRST_STREAM(ni) ((const void *)ni + ni->first_stream_offset) + +/* Advance to the next dentry of the inode. */ +#define NEXT_DENTRY(nd) SKIP_ALIGNED((nd), sizeof(struct ntfs_dentry) + \ + (wcslen((nd)->name) + 1) * sizeof(wchar_t)) + +/* Advance to the next stream of the inode. */ +#define NEXT_STREAM(ns) SKIP_ALIGNED((ns), sizeof(struct ntfs_stream) + \ + (wcslen((ns)->name) + 1) * sizeof(wchar_t)) + +static int +_avl_cmp_ntfs_inodes(const struct avl_tree_node *node1, + const struct avl_tree_node *node2) +{ + return cmp_u64(NTFS_INODE(node1)->ino, NTFS_INODE(node2)->ino); +} + +/* Adds an NTFS inode to the map. */ +static void +ntfs_inode_map_add_inode(struct ntfs_inode_map *map, struct ntfs_inode *ni) +{ + if (avl_tree_insert(&map->root, &ni->index_node, _avl_cmp_ntfs_inodes)) { + WARNING("Inode 0x%016"PRIx64" is a duplicate!", ni->ino); + FREE(ni); + } +} + +/* Find an ntfs_inode in the map by inode number. Returns NULL if not found. */ +static struct ntfs_inode * +ntfs_inode_map_lookup(struct ntfs_inode_map *map, u64 ino) +{ + struct ntfs_inode tmp; + struct avl_tree_node *res; + + tmp.ino = ino; + res = avl_tree_lookup_node(map->root, &tmp.index_node, _avl_cmp_ntfs_inodes); + if (!res) + return NULL; + return NTFS_INODE(res); +} + +/* Remove an ntfs_inode from the map and free it. */ +static void +ntfs_inode_map_remove(struct ntfs_inode_map *map, struct ntfs_inode *ni) +{ + avl_tree_remove(&map->root, &ni->index_node); + FREE(ni); +} + +/* Free all ntfs_inodes in the map. */ +static void +ntfs_inode_map_destroy(struct ntfs_inode_map *map) +{ + struct ntfs_inode *ni; + + avl_tree_for_each_in_postorder(ni, map->root, struct ntfs_inode, index_node) + FREE(ni); +} + +static bool +file_has_streams(const FILE_LAYOUT_ENTRY *file) +{ + return (file->FirstStreamOffset != 0) && + !(file->FileAttributes & FILE_ATTRIBUTE_ENCRYPTED); +} + +static bool +is_valid_name_entry(const FILE_LAYOUT_NAME_ENTRY *name) +{ + return name->FileNameLength > 0 && + name->FileNameLength % 2 == 0 && + !wmemchr(name->FileName, L'\0', name->FileNameLength / 2) && + (!(name->Flags & FILE_LAYOUT_NAME_ENTRY_DOS) || + name->FileNameLength <= 24); +} + +/* Validate the FILE_LAYOUT_NAME_ENTRYs of the specified file and compute the + * total length in bytes of the ntfs_dentry structures needed to hold the name + * information. */ +static int +validate_names_and_compute_total_length(const FILE_LAYOUT_ENTRY *file, + size_t *total_length_ret) +{ + const FILE_LAYOUT_NAME_ENTRY *name = + (const void *)file + file->FirstNameOffset; + size_t total = 0; + size_t num_long_names = 0; + + for (;;) { + if (unlikely(!is_valid_name_entry(name))) { + ERROR("Invalid FILE_LAYOUT_NAME_ENTRY! " + "FileReferenceNumber=0x%016"PRIx64", " + "FileNameLength=%"PRIu32", " + "FileName=%.*ls, Flags=0x%08"PRIx32, + file->FileReferenceNumber, + name->FileNameLength, + (int)(name->FileNameLength / 2), + name->FileName, name->Flags); + return WIMLIB_ERR_UNSUPPORTED; + } + if (name->Flags != FILE_LAYOUT_NAME_ENTRY_DOS) { + num_long_names++; + total += ALIGN(sizeof(struct ntfs_dentry) + + name->FileNameLength + sizeof(wchar_t), + 8); + } + if (name->NextNameOffset == 0) + break; + name = (const void *)name + name->NextNameOffset; + } + + if (unlikely(num_long_names == 0)) { + ERROR("Inode 0x%016"PRIx64" has no long names!", + file->FileReferenceNumber); + return WIMLIB_ERR_UNSUPPORTED; + } + + *total_length_ret = total; + return 0; +} + +static bool +is_valid_stream_entry(const STREAM_LAYOUT_ENTRY *stream) +{ + return stream->StreamIdentifierLength % 2 == 0 && + !wmemchr(stream->StreamIdentifier , L'\0', + stream->StreamIdentifierLength / 2); +} + +/* + * If the specified STREAM_LAYOUT_ENTRY represents a DATA stream as opposed to + * some other type of NTFS stream such as a STANDARD_INFORMATION stream, return + * true and set *stream_name_ret and *stream_name_nchars_ret to specify just the + * stream name. For example, ":foo:$DATA" would become "foo" with length 3 + * characters. Otherwise return false. + */ +static bool +use_stream(const FILE_LAYOUT_ENTRY *file, const STREAM_LAYOUT_ENTRY *stream, + const wchar_t **stream_name_ret, size_t *stream_name_nchars_ret) +{ + const wchar_t *stream_name; + size_t stream_name_nchars; + + if (stream->StreamIdentifierLength == 0) { + /* The unnamed data stream may be given as an empty string + * rather than as "::$DATA". Handle it both ways. */ + stream_name = L""; + stream_name_nchars = 0; + } else if (!get_data_stream_name(stream->StreamIdentifier, + stream->StreamIdentifierLength / 2, + &stream_name, &stream_name_nchars)) + return false; + + /* Skip the unnamed data stream for directories. */ + if (stream_name_nchars == 0 && + (file->FileAttributes & FILE_ATTRIBUTE_DIRECTORY)) + return false; + + *stream_name_ret = stream_name; + *stream_name_nchars_ret = stream_name_nchars; + return true; +} + +/* Validate the STREAM_LAYOUT_ENTRYs of the specified file and compute the total + * length in bytes of the ntfs_stream structures needed to hold the stream + * information. */ +static int +validate_streams_and_compute_total_length(const FILE_LAYOUT_ENTRY *file, + size_t *total_length_ret) +{ + const STREAM_LAYOUT_ENTRY *stream = + (const void *)file + file->FirstStreamOffset; + size_t total = 0; + for (;;) { + const wchar_t *name; + size_t name_nchars; + + if (unlikely(!is_valid_stream_entry(stream))) { + WARNING("Invalid STREAM_LAYOUT_ENTRY! " + "FileReferenceNumber=0x%016"PRIx64", " + "StreamIdentifierLength=%"PRIu32", " + "StreamIdentifier=%.*ls", + file->FileReferenceNumber, + stream->StreamIdentifierLength, + (int)(stream->StreamIdentifierLength / 2), + stream->StreamIdentifier); + return WIMLIB_ERR_UNSUPPORTED; + } + + if (use_stream(file, stream, &name, &name_nchars)) { + total += ALIGN(sizeof(struct ntfs_stream) + + (name_nchars + 1) * sizeof(wchar_t), 8); + } + if (stream->NextStreamOffset == 0) + break; + stream = (const void *)stream + stream->NextStreamOffset; + } + + *total_length_ret = total; + return 0; +} + +static void * +load_name_information(const FILE_LAYOUT_ENTRY *file, struct ntfs_inode *ni, + void *p) +{ + const FILE_LAYOUT_NAME_ENTRY *name = + (const void *)file + file->FirstNameOffset; + for (;;) { + struct ntfs_dentry *nd = p; + /* Note that a name may be just a short (DOS) name, just a long + * name, or both a short name and a long name. If there is a + * short name, one name should also be marked as "primary" to + * indicate which long name the short name is associated with. + * Also, there should be at most one short name per inode. */ + if (name->Flags & FILE_LAYOUT_NAME_ENTRY_DOS) { + memcpy(ni->short_name, + name->FileName, name->FileNameLength); + ni->short_name[name->FileNameLength / 2] = L'\0'; + } + if (name->Flags != FILE_LAYOUT_NAME_ENTRY_DOS) { + ni->num_aliases++; + nd->offset_from_inode = (u8 *)nd - (u8 *)ni; + nd->is_primary = ((name->Flags & + FILE_LAYOUT_NAME_ENTRY_PRIMARY) != 0); + nd->parent_ino = name->ParentFileReferenceNumber; + memcpy(nd->name, name->FileName, name->FileNameLength); + nd->name[name->FileNameLength / 2] = L'\0'; + p += ALIGN(sizeof(struct ntfs_dentry) + + name->FileNameLength + sizeof(wchar_t), 8); + } + if (name->NextNameOffset == 0) + break; + name = (const void *)name + name->NextNameOffset; + } + return p; +} + +static u64 +load_starting_lcn(const STREAM_LAYOUT_ENTRY *stream) +{ + const STREAM_EXTENT_ENTRY *entry; + + if (stream->ExtentInformationOffset == 0) + return 0; + + entry = (const void *)stream + stream->ExtentInformationOffset; + + if (!(entry->Flags & STREAM_EXTENT_ENTRY_AS_RETRIEVAL_POINTERS)) + return 0; + + return extract_starting_lcn(&entry->ExtentInformation.RetrievalPointers); +} + +static void * +load_stream_information(const FILE_LAYOUT_ENTRY *file, struct ntfs_inode *ni, + void *p) +{ + const STREAM_LAYOUT_ENTRY *stream = + (const void *)file + file->FirstStreamOffset; + const u32 first_stream_offset = (const u8 *)p - (const u8 *)ni; + for (;;) { + struct ntfs_stream *ns = p; + const wchar_t *name; + size_t name_nchars; + + if (use_stream(file, stream, &name, &name_nchars)) { + ni->first_stream_offset = first_stream_offset; + ni->num_streams++; + if (name_nchars == 0) + ni->starting_lcn = load_starting_lcn(stream); + ns->size = stream->EndOfFile; + wmemcpy(ns->name, name, name_nchars); + ns->name[name_nchars] = L'\0'; + p += ALIGN(sizeof(struct ntfs_stream) + + (name_nchars + 1) * sizeof(wchar_t), 8); + } + if (stream->NextStreamOffset == 0) + break; + stream = (const void *)stream + stream->NextStreamOffset; + } + return p; +} + +/* Process the information for a file given by FSCTL_QUERY_FILE_LAYOUT. */ +static int +load_one_file(const FILE_LAYOUT_ENTRY *file, struct ntfs_inode_map *inode_map) +{ + const FILE_LAYOUT_INFO_ENTRY *info = + (const void *)file + file->ExtraInfoOffset; + size_t inode_size; + struct ntfs_inode *ni; + size_t n; + int ret; + void *p; + + inode_size = ALIGN(sizeof(struct ntfs_inode), 8); + + /* The root file should have no names, and all other files should have + * at least one name. But just in case, we ignore the names of the root + * file, and we ignore any non-root file with no names. */ + if (!NTFS_IS_ROOT_FILE(file->FileReferenceNumber)) { + if (file->FirstNameOffset == 0) + return 0; + ret = validate_names_and_compute_total_length(file, &n); + if (ret) + return ret; + inode_size += n; + } + + if (file_has_streams(file)) { + ret = validate_streams_and_compute_total_length(file, &n); + if (ret) + return ret; + inode_size += n; + } + + /* To save memory, we allocate the ntfs_dentry's and ntfs_stream's in + * the same memory block as their ntfs_inode. */ + ni = CALLOC(1, inode_size); + if (!ni) + return WIMLIB_ERR_NOMEM; + + ni->ino = file->FileReferenceNumber; + ni->attributes = info->BasicInformation.FileAttributes; + ni->creation_time = info->BasicInformation.CreationTime; + ni->last_write_time = info->BasicInformation.LastWriteTime; + ni->last_access_time = info->BasicInformation.LastAccessTime; + ni->security_id = info->SecurityId; + + p = FIRST_DENTRY(ni); + + if (!NTFS_IS_ROOT_FILE(file->FileReferenceNumber)) + p = load_name_information(file, ni, p); + + if (file_has_streams(file)) + p = load_stream_information(file, ni, p); + + wimlib_assert((u8 *)p - (u8 *)ni == inode_size); + + ntfs_inode_map_add_inode(inode_map, ni); + return 0; +} + +/* + * Quickly find all files on an NTFS volume by using FSCTL_QUERY_FILE_LAYOUT to + * scan the MFT. The NTFS volume is specified by the NT namespace path @path. + * For each file, allocate an 'ntfs_inode' structure for each file and add it to + * 'inode_map' keyed by inode number. Include NTFS special files such as + * $Bitmap (they will be removed later). + */ +static int +load_files_from_mft(const wchar_t *path, struct ntfs_inode_map *inode_map) +{ + HANDLE h = NULL; + QUERY_FILE_LAYOUT_INPUT in = (QUERY_FILE_LAYOUT_INPUT) { + .NumberOfPairs = 0, + .Flags = QUERY_FILE_LAYOUT_RESTART | + QUERY_FILE_LAYOUT_INCLUDE_NAMES | + QUERY_FILE_LAYOUT_INCLUDE_STREAMS | + QUERY_FILE_LAYOUT_INCLUDE_EXTENTS | + QUERY_FILE_LAYOUT_INCLUDE_EXTRA_INFO | + QUERY_FILE_LAYOUT_INCLUDE_STREAMS_WITH_NO_CLUSTERS_ALLOCATED, + .FilterType = QUERY_FILE_LAYOUT_FILTER_TYPE_NONE, + }; + const size_t outsize = 32768; + QUERY_FILE_LAYOUT_OUTPUT *out = NULL; + DWORD bytes_returned; + int ret; + DWORD err; + NTSTATUS status; + + status = winnt_open(path, wcslen(path), + FILE_READ_DATA | FILE_READ_ATTRIBUTES, &h); + if (!NT_SUCCESS(status)) { + ret = -1; /* Silently try standard recursive scan instead */ + goto out; + } + + out = MALLOC(outsize); + if (!out) { + ret = WIMLIB_ERR_NOMEM; + goto out; + } + + while (DeviceIoControl(h, FSCTL_QUERY_FILE_LAYOUT, &in, sizeof(in), + out, outsize, &bytes_returned, NULL)) + { + const FILE_LAYOUT_ENTRY *file = + (const void *)out + out->FirstFileOffset; + for (;;) { + ret = load_one_file(file, inode_map); + if (ret) + goto out; + if (file->NextFileOffset == 0) + break; + file = (const void *)file + file->NextFileOffset; + } + in.Flags &= ~QUERY_FILE_LAYOUT_RESTART; + } + + /* Normally, FSCTL_QUERY_FILE_LAYOUT fails with error code 38 after all + * files have been enumerated. */ + err = GetLastError(); + if (err != 38) { + if (err == ERROR_INVALID_FUNCTION || + err == ERROR_INVALID_PARAMETER) { + /* Silently try standard recursive scan instead */ + ret = -1; + } else { + win32_error(err, + L"Error enumerating files on volume \"%ls\"", + path); + /* Try standard recursive scan instead */ + ret = WIMLIB_ERR_UNSUPPORTED; + } + goto out; + } + ret = 0; +out: + FREE(out); + (*func_NtClose)(h); + return ret; +} + +/* Build the list of child dentries for each inode in @map. This is done by + * iterating through each name of each inode and adding it to its parent's + * children list. Note that every name should have a parent, i.e. should belong + * to some directory. The root directory does not have any names. */ +static int +build_children_lists(struct ntfs_inode_map *map, struct ntfs_inode **root_ret) +{ + struct ntfs_inode *ni; + + avl_tree_for_each_in_order(ni, map->root, struct ntfs_inode, index_node) + { + struct ntfs_dentry *nd; + u32 n; + + if (NTFS_IS_ROOT_FILE(ni->ino)) { + *root_ret = ni; + continue; + } + + n = ni->num_aliases; + nd = FIRST_DENTRY(ni); + for (;;) { + struct ntfs_inode *parent; + + parent = ntfs_inode_map_lookup(map, nd->parent_ino); + if (unlikely(!parent)) { + ERROR("Parent inode 0x%016"PRIx64" of" + "directory entry \"%ls\" (inode " + "0x%016"PRIx64") was missing from the " + "MFT listing!", + nd->parent_ino, nd->name, ni->ino); + return WIMLIB_ERR_UNSUPPORTED; + } + nd->next_child = parent->first_child; + parent->first_child = nd; + if (!--n) + break; + nd = NEXT_DENTRY(nd); + } + } + return 0; +} + +struct security_map_node { + struct avl_tree_node index_node; + u32 disk_security_id; + u32 wim_security_id; +}; + +/* Map from disk security IDs to WIM security IDs */ +struct security_map { + struct avl_tree_node *root; +}; + +#define SECURITY_MAP_NODE(node) \ + avl_tree_entry((node), struct security_map_node, index_node) + +static int +_avl_cmp_security_map_nodes(const struct avl_tree_node *node1, + const struct avl_tree_node *node2) +{ + return cmp_u32(SECURITY_MAP_NODE(node1)->disk_security_id, + SECURITY_MAP_NODE(node2)->disk_security_id); +} + +static s32 +security_map_lookup(struct security_map *map, u32 disk_security_id) +{ + struct security_map_node tmp; + const struct avl_tree_node *res; + + if (disk_security_id == 0) /* No on-disk security ID; uncacheable */ + return -1; + + tmp.disk_security_id = disk_security_id; + res = avl_tree_lookup_node(map->root, &tmp.index_node, + _avl_cmp_security_map_nodes); + if (!res) + return -1; + return SECURITY_MAP_NODE(res)->wim_security_id; +} + +static int +security_map_insert(struct security_map *map, u32 disk_security_id, + u32 wim_security_id) +{ + struct security_map_node *node; + + if (disk_security_id == 0) /* No on-disk security ID; uncacheable */ + return 0; + + node = MALLOC(sizeof(*node)); + if (!node) + return WIMLIB_ERR_NOMEM; + + node->disk_security_id = disk_security_id; + node->wim_security_id = wim_security_id; + avl_tree_insert(&map->root, &node->index_node, + _avl_cmp_security_map_nodes); + return 0; +} + +static void +security_map_destroy(struct security_map *map) +{ + struct security_map_node *node; + + avl_tree_for_each_in_postorder(node, map->root, + struct security_map_node, index_node) + FREE(node); +} + +/* + * Turn our temporary NTFS structures into the final WIM structures: + * + * ntfs_inode => wim_inode + * ntfs_dentry => wim_dentry + * ntfs_stream => wim_inode_stream + * + * This also handles things such as exclusions and issuing progress messages. + * It's similar to winnt_build_dentry_tree_recursive(), but this is much faster + * because almost all information we need is already loaded in memory in the + * ntfs_* structures. However, in some cases we still fall back to + * winnt_build_dentry_tree_recursive() and/or opening the file. + */ +static int +generate_wim_structures_recursive(struct wim_dentry **root_ret, + wchar_t *path, size_t path_nchars, + const wchar_t *filename, bool is_primary_name, + struct ntfs_inode *ni, + struct winnt_scan_ctx *ctx, + struct ntfs_inode_map *inode_map, + struct security_map *security_map) +{ + int ret = 0; + struct wim_dentry *root = NULL; + struct wim_inode *inode = NULL; + const struct ntfs_stream *ns; + + /* Completely ignore NTFS special files. */ + if (NTFS_IS_SPECIAL_FILE(ni->ino)) + goto out; + + /* Fall back to a recursive scan for unhandled cases. Reparse points, + * in particular, can't be properly handled here because a commonly used + * filter driver (WOF) hides reparse points from regular filesystem APIs + * but not from FSCTL_QUERY_FILE_LAYOUT. */ + if (ni->attributes & (FILE_ATTRIBUTE_REPARSE_POINT | + FILE_ATTRIBUTE_ENCRYPTED)) + { + ret = winnt_build_dentry_tree_recursive(&root, + NULL, + path, + path_nchars, + path, + path_nchars, + filename, + ctx); + goto out; + } + + /* Test for exclusion based on path. */ + ret = try_exclude(path, ctx->params); + if (unlikely(ret < 0)) /* Excluded? */ + goto out_progress; + if (unlikely(ret > 0)) /* Error? */ + goto out; + + /* Create the WIM dentry and possibly a new WIM inode */ + ret = inode_table_new_dentry(ctx->params->inode_table, filename, + ni->ino, ctx->params->capture_root_dev, + false, &root); + if (ret) + goto out; + + inode = root->d_inode; + + /* Set the short name if needed. */ + if (is_primary_name && *ni->short_name) { + size_t nbytes = wcslen(ni->short_name) * sizeof(wchar_t); + root->d_short_name = memdup(ni->short_name, + nbytes + sizeof(wchar_t)); + if (!root->d_short_name) { + ret = WIMLIB_ERR_NOMEM; + goto out; + } + root->d_short_name_nbytes = nbytes; + } + + if (inode->i_nlink > 1) { /* Already seen this inode? */ + ret = 0; + goto out_progress; + } + + /* The file attributes and timestamps were cached from the MFT. */ + inode->i_attributes = ni->attributes; + inode->i_creation_time = ni->creation_time; + inode->i_last_write_time = ni->last_write_time; + inode->i_last_access_time = ni->last_access_time; + + /* Set the security descriptor if needed. */ + if (!(ctx->params->add_flags & WIMLIB_ADD_FLAG_NO_ACLS)) { + /* Look up the WIM security ID that corresponds to the on-disk + * security ID. */ + s32 wim_security_id = + security_map_lookup(security_map, ni->security_id); + if (likely(wim_security_id >= 0)) { + /* The mapping for this security ID is already cached.*/ + inode->i_security_id = wim_security_id; + } else { + HANDLE h; + NTSTATUS status; + + /* Create a mapping for this security ID and insert it + * into the security map. */ + + status = winnt_open(path, path_nchars, + READ_CONTROL | + ACCESS_SYSTEM_SECURITY, &h); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"Can't open \"%ls\" to " + "read security descriptor", + printable_path(path)); + ret = WIMLIB_ERR_OPEN; + goto out; + } + ret = winnt_load_security_descriptor(h, inode, path, ctx); + (*func_NtClose)(h); + if (ret) + goto out; + + ret = security_map_insert(security_map, ni->security_id, + inode->i_security_id); + if (ret) + goto out; + } + } + + /* Add data streams based on the cached information from the MFT. */ + ns = FIRST_STREAM(ni); + for (u32 i = 0; i < ni->num_streams; i++) { + struct windows_file *windows_file; + + /* Reference the stream by path if it's a named data stream, or + * if the volume doesn't support "open by file ID", or if the + * application hasn't explicitly opted in to "open by file ID". + * Otherwise, only save the inode number (file ID). */ + if (*ns->name || + !(ctx->vol_flags & FILE_SUPPORTS_OPEN_BY_FILE_ID) || + !(ctx->params->add_flags & WIMLIB_ADD_FLAG_FILE_PATHS_UNNEEDED)) + { + windows_file = alloc_windows_file(path, + path_nchars, + ns->name, + wcslen(ns->name), + ctx->snapshot, + false); + } else { + windows_file = alloc_windows_file_for_file_id(ni->ino, + path, + ctx->params->capture_root_nchars + 1, + ctx->snapshot); + } + + ret = add_stream(inode, windows_file, ns->size, + STREAM_TYPE_DATA, ns->name, + ctx->params->unhashed_blobs); + if (ret) + goto out; + ns = NEXT_STREAM(ns); + } + + set_sort_key(inode, ni->starting_lcn); + + /* If processing a directory, then recurse to its children. In this + * version there is no need to go to disk, as we already have the list + * of children cached from the MFT. */ + if (inode_is_directory(inode)) { + const struct ntfs_dentry *nd = ni->first_child; + + while (nd != NULL) { + const size_t name_len = wcslen(nd->name); + wchar_t *p = path + path_nchars; + struct wim_dentry *child; + const struct ntfs_dentry *next = nd->next_child; + + if (*(p - 1) != L'\\') + *p++ = L'\\'; + p = wmempcpy(p, nd->name, name_len); + *p = '\0'; + + ret = generate_wim_structures_recursive( + &child, + path, + p - path, + nd->name, + nd->is_primary, + (void *)nd - nd->offset_from_inode, + ctx, + inode_map, + security_map); + + path[path_nchars] = L'\0'; + + if (ret) + goto out; + + attach_scanned_tree(root, child, ctx->params->blob_table); + nd = next; + } + } + +out_progress: + ctx->params->progress.scan.cur_path = path; + if (likely(root)) + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_OK, inode); + else + ret = do_capture_progress(ctx->params, WIMLIB_SCAN_DENTRY_EXCLUDED, NULL); +out: + if (--ni->num_aliases == 0) { + /* Memory usage optimization: when we don't need the ntfs_inode + * (and its names and streams) anymore, free it. */ + ntfs_inode_map_remove(inode_map, ni); + } + if (unlikely(ret)) { + free_dentry_tree(root, ctx->params->blob_table); + root = NULL; + } + *root_ret = root; + return ret; +} + +static int +winnt_build_dentry_tree_fast(struct wim_dentry **root_ret, wchar_t *path, + size_t path_nchars, struct winnt_scan_ctx *ctx) +{ + struct ntfs_inode_map inode_map = { .root = NULL }; + struct security_map security_map = { .root = NULL }; + struct ntfs_inode *root = NULL; + bool adjust_path; + int ret; + + adjust_path = (path[path_nchars - 1] == L'\\'); + if (adjust_path) + path[path_nchars - 1] = L'\0'; + + ret = load_files_from_mft(path, &inode_map); + + if (adjust_path) + path[path_nchars - 1] = L'\\'; + + if (ret) + goto out; + + ret = build_children_lists(&inode_map, &root); + if (ret) + goto out; + + if (!root) { + ERROR("The MFT listing for volume \"%ls\" did not include a " + "root directory!", path); + ret = WIMLIB_ERR_UNSUPPORTED; + goto out; + } + + root->num_aliases = 1; + + ret = generate_wim_structures_recursive(root_ret, path, path_nchars, + L"", false, root, ctx, + &inode_map, &security_map); +out: + ntfs_inode_map_destroy(&inode_map); + security_map_destroy(&security_map); + return ret; +} + +#endif /* ENABLE_FAST_MFT_SCAN */ + +/*----------------------------------------------------------------------------* + * Entry point for directory tree scans on Windows * + *----------------------------------------------------------------------------*/ + #define WINDOWS_NT_MAX_PATH 32768 -/* Win32 version of capturing a directory tree. */ int win32_build_dentry_tree(struct wim_dentry **root_ret, const wchar_t *root_disk_path, struct capture_params *params) { - wchar_t *path; - int ret; + wchar_t *path = NULL; + struct winnt_scan_ctx ctx = { .params = params }; UNICODE_STRING ntpath; - struct winnt_scan_stats stats; size_t ntpath_nchars; + HANDLE h = NULL; + NTSTATUS status; + int ret; /* WARNING: There is no check for overflow later when this buffer is * being used! But it's as long as the maximum path length understood @@ -1480,9 +2791,13 @@ win32_build_dentry_tree(struct wim_dentry **root_ret, if (!path) return WIMLIB_ERR_NOMEM; - ret = win32_path_to_nt_path(root_disk_path, &ntpath); + if (params->add_flags & WIMLIB_ADD_FLAG_SNAPSHOT) + ret = vss_create_snapshot(root_disk_path, &ntpath, &ctx.snapshot); + else + ret = win32_path_to_nt_path(root_disk_path, &ntpath); + if (ret) - goto out_free_path; + goto out; if (ntpath.Length < 4 * sizeof(wchar_t) || ntpath.Length > WINDOWS_NT_MAX_PATH * sizeof(wchar_t) || @@ -1502,17 +2817,44 @@ win32_build_dentry_tree(struct wim_dentry **root_ret, } HeapFree(GetProcessHeap(), 0, ntpath.Buffer); if (ret) - goto out_free_path; + goto out; + + status = winnt_open(path, ntpath_nchars, FILE_READ_ATTRIBUTES, &h); + if (!NT_SUCCESS(status)) { + winnt_error(status, L"Can't open \"%ls\"", printable_path(path)); + if (status == STATUS_FVE_LOCKED_VOLUME) + ret = WIMLIB_ERR_FVE_LOCKED_VOLUME; + else + ret = WIMLIB_ERR_OPEN; + goto out; + } + + get_volume_information(h, path, &ctx); - memset(&stats, 0, sizeof(stats)); + (*func_NtClose)(h); +#ifdef ENABLE_FAST_MFT_SCAN + if (ctx.is_ntfs && !_wgetenv(L"WIMLIB_DISABLE_QUERY_FILE_LAYOUT")) { + ret = winnt_build_dentry_tree_fast(root_ret, path, + ntpath_nchars, &ctx); + if (ret >= 0 && ret != WIMLIB_ERR_UNSUPPORTED) + goto out; + if (ret >= 0) { + WARNING("A problem occurred during the fast MFT scan.\n" + " Falling back to the standard " + "recursive directory tree scan."); + } + } +#endif ret = winnt_build_dentry_tree_recursive(root_ret, NULL, path, ntpath_nchars, - L"", 0, params, &stats, 0); -out_free_path: + path, ntpath_nchars, + L"", &ctx); +out: + vss_put_snapshot(ctx.snapshot); FREE(path); if (ret == 0) - winnt_do_scan_warnings(root_disk_path, &stats); + winnt_do_scan_warnings(root_disk_path, &ctx); return ret; }