]> wimlib.net Git - wimlib/blobdiff - src/wimboot.c
Add warning messages and retries around FSCTL_SET_EXTERNAL_BACKING
[wimlib] / src / wimboot.c
index 3dd6da1eded2135c0db75660292a75290d13cd61..b1db0f8c5feac1f842d77c99c1d36610e2ca2885 100644 (file)
 /*
  * Copyright (C) 2014 Eric Biggers
  *
- * This file is part of wimlib, a library for working with WIM files.
+ * 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
+ * Software Foundation; either version 3 of the License, or (at your option) any
+ * later version.
  *
- * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU General Public License as published by the Free
- * Software Foundation; either version 3 of the License, or (at your option)
- * any later version.
- *
- * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * This file is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  * details.
  *
- * You should have received a copy of the GNU General Public License
- * along with wimlib; if not, see http://www.gnu.org/licenses/.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this file; if not, see http://www.gnu.org/licenses/.
  */
 
+#ifdef __WIN32__
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
 
-#ifdef __WIN32__
-
 #include "wimlib/win32_common.h"
 #include "wimlib/win32.h"
 #include "wimlib/assert.h"
@@ -49,8 +46,7 @@ static HANDLE
 open_file(const wchar_t *device_name, DWORD desiredAccess)
 {
        return CreateFile(device_name, desiredAccess,
-                         FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
-                         NULL, OPEN_EXISTING,
+                         FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
                          FILE_FLAG_BACKUP_SEMANTICS, NULL);
 }
 
@@ -79,19 +75,17 @@ query_device(HANDLE h, DWORD code, void *out, DWORD out_size)
  */
 static int
 query_partition_and_disk_info(const wchar_t *path,
-                             PARTITION_INFORMATION_EX *part_info_ret,
+                             PARTITION_INFORMATION_EX *part_info,
                              DRIVE_LAYOUT_INFORMATION_EX *drive_info_ret)
 {
-       HANDLE h;
        wchar_t vol_name[] = L"\\\\.\\X:";
        wchar_t disk_name[] = L"\\\\?\\PhysicalDriveXXXXXXXXXX";
-
-       PARTITION_INFORMATION_EX part_info;
-       size_t extents_size = sizeof(VOLUME_DISK_EXTENTS) + 4 * sizeof(DISK_EXTENT);
-       VOLUME_DISK_EXTENTS *extents = alloca(extents_size);
-       size_t drive_info_size = sizeof(DRIVE_LAYOUT_INFORMATION_EX) +
-                                       8 * sizeof(PARTITION_INFORMATION_EX);
-       DRIVE_LAYOUT_INFORMATION_EX *drive_info = alloca(drive_info_size);
+       HANDLE h = INVALID_HANDLE_VALUE;
+       VOLUME_DISK_EXTENTS *extents = NULL;
+       size_t extents_size;
+       DRIVE_LAYOUT_INFORMATION_EX *drive_info = NULL;
+       size_t drive_info_size;
+       int ret;
 
        wimlib_assert(path[0] != L'\0' && path[1] == L':');
 
@@ -99,36 +93,51 @@ query_partition_and_disk_info(const wchar_t *path,
 
        h = open_file(vol_name, GENERIC_READ);
        if (h == INVALID_HANDLE_VALUE) {
-               set_errno_from_GetLastError();
-               ERROR_WITH_ERRNO("\"%ls\": Can't open volume device", vol_name);
-               return WIMLIB_ERR_OPEN;
+               ERROR("\"%ls\": Can't open volume device (err=%"PRIu32")",
+                     vol_name, (u32)GetLastError());
+               ret = WIMLIB_ERR_OPEN;
+               goto out;
        }
 
        if (!query_device(h, IOCTL_DISK_GET_PARTITION_INFO_EX,
-                         &part_info, sizeof(part_info)))
+                         part_info, sizeof(PARTITION_INFORMATION_EX)))
        {
-               ERROR("\"%ls\": Can't get partition info (err=0x%08"PRIx32")",
+               ERROR("\"%ls\": Can't get partition info (err=%"PRIu32")",
                      vol_name, (u32)GetLastError());
-               CloseHandle(h);
-               return WIMLIB_ERR_READ;
+               ret = WIMLIB_ERR_READ;
+               goto out;
        }
 
-       if (!query_device(h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS,
-                         extents, extents_size))
-       {
-               ERROR("\"%ls\": Can't get volume extent info (err=0x%08"PRIx32")",
-                     vol_name, (u32)GetLastError());
-               CloseHandle(h);
-               return WIMLIB_ERR_READ;
+       extents_size = sizeof(VOLUME_DISK_EXTENTS);
+       for (;;) {
+               extents_size += 4 * sizeof(DISK_EXTENT);
+               extents = MALLOC(extents_size);
+               if (!extents) {
+                       ret = WIMLIB_ERR_NOMEM;
+                       goto out;
+               }
+
+               if (query_device(h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS,
+                                extents, extents_size))
+                       break;
+               if (GetLastError() != ERROR_MORE_DATA) {
+                       ERROR("\"%ls\": Can't get volume extent info (err=%"PRIu32")",
+                             vol_name, (u32)GetLastError());
+                       ret = WIMLIB_ERR_READ;
+                       goto out;
+               }
+               FREE(extents);
        }
 
        CloseHandle(h);
+       h = INVALID_HANDLE_VALUE;
 
        if (extents->NumberOfDiskExtents != 1) {
                ERROR("\"%ls\": This volume has %"PRIu32" disk extents, "
                      "but this code is untested for more than 1",
                      vol_name, (u32)extents->NumberOfDiskExtents);
-               return WIMLIB_ERR_UNSUPPORTED;
+               ret = WIMLIB_ERR_UNSUPPORTED;
+               goto out;
        }
 
        wsprintf(wcschr(disk_name, L'X'), L"%"PRIu32,
@@ -136,52 +145,74 @@ query_partition_and_disk_info(const wchar_t *path,
 
        h = open_file(disk_name, GENERIC_READ);
        if (h == INVALID_HANDLE_VALUE) {
-               set_errno_from_GetLastError();
-               ERROR_WITH_ERRNO("\"%ls\": Can't open disk device", disk_name);
-               return WIMLIB_ERR_OPEN;
+               ERROR("\"%ls\": Can't open disk device (err=%"PRIu32")",
+                     disk_name, (u32)GetLastError());
+               ret = WIMLIB_ERR_OPEN;
+               goto out;
        }
 
-       if (!query_device(h, IOCTL_DISK_GET_DRIVE_LAYOUT_EX,
-                         drive_info, drive_info_size))
-       {
-               ERROR("\"%ls\": Can't get disk info (err=0x%08"PRIx32")",
-                     disk_name, (u32)GetLastError());
-               CloseHandle(h);
-               return WIMLIB_ERR_READ;
+       drive_info_size = sizeof(DRIVE_LAYOUT_INFORMATION_EX);
+       for (;;) {
+               drive_info_size += 4 * sizeof(PARTITION_INFORMATION_EX);
+               drive_info = MALLOC(drive_info_size);
+               if (!drive_info) {
+                       ret = WIMLIB_ERR_NOMEM;
+                       goto out;
+               }
+
+               if (query_device(h, IOCTL_DISK_GET_DRIVE_LAYOUT_EX,
+                                drive_info, drive_info_size))
+                       break;
+               if (GetLastError() != ERROR_INSUFFICIENT_BUFFER) {
+                       ERROR("\"%ls\": Can't get disk info (err=%"PRIu32")",
+                             disk_name, (u32)GetLastError());
+                       ret = WIMLIB_ERR_READ;
+                       goto out;
+               }
+               FREE(drive_info);
        }
 
+       *drive_info_ret = *drive_info;  /* doesn't include partitions */
        CloseHandle(h);
+       h = INVALID_HANDLE_VALUE;
 
-       if (drive_info->PartitionStyle != part_info.PartitionStyle) {
+       if (drive_info->PartitionStyle != part_info->PartitionStyle) {
                ERROR("\"%ls\", \"%ls\": Inconsistent partition table type!",
                      vol_name, disk_name);
-               return WIMLIB_ERR_UNSUPPORTED;
+               ret = WIMLIB_ERR_UNSUPPORTED;
+               goto out;
        }
 
-       if (part_info.PartitionStyle == PARTITION_STYLE_GPT) {
-               BUILD_BUG_ON(sizeof(part_info.Gpt.PartitionId) !=
+       if (part_info->PartitionStyle == PARTITION_STYLE_GPT) {
+               BUILD_BUG_ON(sizeof(part_info->Gpt.PartitionId) !=
                             sizeof(drive_info->Gpt.DiskId));
-               if (!memcmp(&part_info.Gpt.PartitionId,
+               if (!memcmp(&part_info->Gpt.PartitionId,
                            &drive_info->Gpt.DiskId,
                            sizeof(drive_info->Gpt.DiskId)))
                {
                        ERROR("\"%ls\", \"%ls\": Partition GUID is the "
                              "same as the disk GUID???", vol_name, disk_name);
-                       return WIMLIB_ERR_UNSUPPORTED;
+                       ret = WIMLIB_ERR_UNSUPPORTED;
+                       goto out;
                }
        }
 
-       if (part_info.PartitionStyle != PARTITION_STYLE_MBR &&
-           part_info.PartitionStyle != PARTITION_STYLE_GPT)
+       if (part_info->PartitionStyle != PARTITION_STYLE_MBR &&
+           part_info->PartitionStyle != PARTITION_STYLE_GPT)
        {
                ERROR("\"%ls\": Unknown partition style 0x%08"PRIx32,
-                     vol_name, (u32)part_info.PartitionStyle);
-               return WIMLIB_ERR_UNSUPPORTED;
+                     vol_name, (u32)part_info->PartitionStyle);
+               ret = WIMLIB_ERR_UNSUPPORTED;
+               goto out;
        }
 
-       *part_info_ret = part_info;
-       *drive_info_ret = *drive_info;
-       return 0;
+       ret = 0;
+out:
+       FREE(extents);
+       FREE(drive_info);
+       if (h != INVALID_HANDLE_VALUE)
+               CloseHandle(h);
+       return ret;
 }
 
 /*
@@ -612,8 +643,8 @@ retry:
                if (wimlib_print_errors) {
                        print_byte_field((const u8 *)hdr,
                                         sizeof(struct WimOverlay_dat_header),
-                                        stderr);
-                       fputc('\n', stderr);
+                                        wimlib_error_file);
+                       fputc('\n', wimlib_error_file);
                }
                ret = WIMLIB_ERR_UNSUPPORTED;
                goto out_free_contents;
@@ -683,8 +714,9 @@ retry:
                              path, i, entry_1->data_source_id);
                        if (wimlib_print_errors) {
                                print_byte_field((const u8 *)entry_2->wim_file_name,
-                                                wim_file_name_length, stderr);
-                               fputc('\n', stderr);
+                                                wim_file_name_length,
+                                                wimlib_error_file);
+                               fputc('\n', wimlib_error_file);
                        }
                        ret = WIMLIB_ERR_UNSUPPORTED;
                        goto out_free_contents;
@@ -721,8 +753,8 @@ retry:
                        if (wimlib_print_errors) {
                                print_byte_field((const u8 *)entry_2,
                                                 entry_1->entry_2_length,
-                                                stderr);
-                               fputc('\n', stderr);
+                                                wimlib_error_file);
+                               fputc('\n', wimlib_error_file);
                        }
                        ret = WIMLIB_ERR_UNSUPPORTED;
                        goto out_free_contents;
@@ -808,6 +840,7 @@ update_wimoverlay_manually(const wchar_t *drive, const wchar_t *wim_path,
                if (ret) {
                        ERROR_WITH_ERRNO("Can't rename \"%ls\" => \"%ls\"",
                                         path_main, path_wimlib_backup);
+                       ret = WIMLIB_ERR_RENAME;
                        goto out_free_new_contents;
                }
        }
@@ -817,6 +850,7 @@ update_wimoverlay_manually(const wchar_t *drive, const wchar_t *wim_path,
        if (ret) {
                ERROR_WITH_ERRNO("Can't rename \"%ls\" => \"%ls\"",
                                 path_new, path_main);
+               ret = WIMLIB_ERR_RENAME;
        }
 out_free_new_contents:
        FREE(new_contents);
@@ -830,26 +864,6 @@ out:
        return ret;
 }
 
-static int
-win32_get_drive_path(const wchar_t *file_path, wchar_t drive_path[7])
-{
-       tchar *file_abspath;
-
-       file_abspath = realpath(file_path, NULL);
-       if (!file_abspath)
-               return WIMLIB_ERR_NOMEM;
-
-       if (file_abspath[0] == L'\0' || file_abspath[1] != L':') {
-               ERROR("\"%ls\": Path format not recognized", file_abspath);
-               FREE(file_abspath);
-               return WIMLIB_ERR_UNSUPPORTED;
-       }
-
-       wsprintf(drive_path, L"\\\\.\\%lc:", file_abspath[0]);
-       FREE(file_abspath);
-       return 0;
-}
-
 /* Try to attach an instance of the Windows Overlay File System Filter Driver to
  * the specified drive (such as C:)  */
 static bool
@@ -902,7 +916,7 @@ try_to_attach_wof(const wchar_t *drive)
  * @image
  *     Number of the image in the WIM being applied.
  * @target
- *     Path to the target drive.
+ *     Path to the target directory.
  * @data_source_id_ret
  *     On success, an identifier for the backing WIM file will be returned
  *     here.
@@ -1043,8 +1057,8 @@ out:
  * This turns it into a reparse point that redirects accesses to it, to the
  * corresponding resource in the WIM archive.
  *
- * @path
- *     Path to extracted file (already created).
+ * @h
+ *     Open handle to the file, with GENERIC_WRITE access.
  * @lte
  *     Unnamed data stream of the file.
  * @data_source_id
@@ -1055,37 +1069,30 @@ out:
  *     %true if the WOF driver appears to be available and working; %false if
  *     not.
  *
- * Returns 0 on success, or a positive error code on failure.
+ * Returns %true on success, or %false on failure with GetLastError() set.
  */
-int
-wimboot_set_pointer(const wchar_t *path,
+bool
+wimboot_set_pointer(HANDLE h,
                    const struct wim_lookup_table_entry *lte,
                    u64 data_source_id,
                    const u8 lookup_table_hash[SHA1_HASH_SIZE],
                    bool wof_running)
 {
-       HANDLE h;
        DWORD bytes_returned;
-       int ret;
-
-
-       /* Open the file  */
-       h = win32_open_existing_file(path, GENERIC_WRITE);
-       if (h == INVALID_HANDLE_VALUE) {
-               set_errno_from_GetLastError();
-               ret = WIMLIB_ERR_OPEN;
-               goto out;
-       }
+       DWORD err;
 
        if (wof_running) {
                /* The WOF driver is running.  We can create the reparse point
                 * using FSCTL_SET_EXTERNAL_BACKING.  */
-
+               unsigned int max_retries = 4;
                struct {
                        struct wof_external_info wof_info;
                        struct wim_provider_external_info wim_info;
                } in;
 
+       retry:
+               memset(&in, 0, sizeof(in));
+
                in.wof_info.version = WOF_CURRENT_VERSION;
                in.wof_info.provider = WOF_PROVIDER_WIM;
 
@@ -1097,8 +1104,24 @@ wimboot_set_pointer(const wchar_t *path,
                /* lookup_table_hash is not necessary  */
 
                if (!DeviceIoControl(h, FSCTL_SET_EXTERNAL_BACKING,
-                                    &in, sizeof(in), NULL, 0, &bytes_returned, NULL))
-                       goto fail;
+                                    &in, sizeof(in), NULL, 0,
+                                    &bytes_returned, NULL))
+               {
+                       /* Try to track down sporadic errors  */
+                       if (wimlib_print_errors) {
+                               WARNING("FSCTL_SET_EXTERNAL_BACKING failed (err=%u); data was %zu bytes:",
+                                       (u32)GetLastError(), sizeof(in));
+                               print_byte_field((const u8 *)&in, sizeof(in), wimlib_error_file);
+                               putc('\n', wimlib_error_file);
+                       }
+                       if (--max_retries) {
+                               WARNING("Retrying after 100ms...");
+                               Sleep(100);
+                               goto retry;
+                       }
+                       WARNING("Too many retries; returning failure");
+                       return false;
+               }
        } else {
 
                /* The WOF driver is running.  We need to create the reparse
@@ -1136,7 +1159,7 @@ wimboot_set_pointer(const wchar_t *path,
 
                if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT,
                                     &in, sizeof(in), NULL, 0, &bytes_returned, NULL))
-                       goto fail;
+                       return false;
 
                /* We also need to create an unnamed data stream of the correct
                 * size.  Otherwise the file shows up as zero length.  It can be
@@ -1144,32 +1167,18 @@ wimboot_set_pointer(const wchar_t *path,
                 * are unimportant.  */
                if (!DeviceIoControl(h, FSCTL_SET_SPARSE, NULL, 0, NULL, 0,
                                     &bytes_returned, NULL))
-                       goto fail;
+                       return false;
 
                if (!SetFilePointerEx(h,
                                      (LARGE_INTEGER){ .QuadPart = lte->size},
                                      NULL, FILE_BEGIN))
-                       goto fail;
+                       return false;
 
                if (!SetEndOfFile(h))
-                       goto fail;
+                       return false;
        }
 
-       ret = 0;
-out_close_handle:
-       CloseHandle(h);
-out:
-       return ret;
-
-fail:
-       {
-               DWORD err = GetLastError();
-               set_errno_from_win32_error(err);
-               ERROR_WITH_ERRNO("\"%ls\": Couldn't set WIMBoot pointer data "
-                                "(err=0x%08"PRIx32")", path, (u32)err);
-               ret = WIMLIB_ERR_WIMBOOT;
-               goto out_close_handle;
-       }
+       return true;
 }
 
 #endif /* __WIN32__ */