]> wimlib.net Git - wimlib/blobdiff - src/wimboot.c
Add warning messages and retries around FSCTL_SET_EXTERNAL_BACKING
[wimlib] / src / wimboot.c
index cdd74d9468f267dece137673db408ec30a838068..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__
@@ -77,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':');
 
@@ -97,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,
@@ -134,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;
 }
 
 /*
@@ -1026,8 +1059,6 @@ out:
  *
  * @h
  *     Open handle to the file, with GENERIC_WRITE access.
- * @printable_name
- *     Printable representation of the path to the file.
  * @lte
  *     Unnamed data stream of the file.
  * @data_source_id
@@ -1038,11 +1069,10 @@ 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
+bool
 wimboot_set_pointer(HANDLE h,
-                   const wchar_t *printable_name,
                    const struct wim_lookup_table_entry *lte,
                    u64 data_source_id,
                    const u8 lookup_table_hash[SHA1_HASH_SIZE],
@@ -1054,12 +1084,15 @@ wimboot_set_pointer(HANDLE h,
        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;
 
@@ -1073,7 +1106,22 @@ wimboot_set_pointer(HANDLE h,
                if (!DeviceIoControl(h, FSCTL_SET_EXTERNAL_BACKING,
                                     &in, sizeof(in), NULL, 0,
                                     &bytes_returned, NULL))
-                       goto fail;
+               {
+                       /* 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
@@ -1111,7 +1159,7 @@ wimboot_set_pointer(HANDLE h,
 
                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
@@ -1119,25 +1167,18 @@ wimboot_set_pointer(HANDLE h,
                 * 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;
        }
 
-       return 0;
-
-fail:
-       err = GetLastError();
-       set_errno_from_win32_error(err);
-       ERROR_WITH_ERRNO("\"%ls\": Couldn't set WIMBoot pointer data "
-                        "(err=%"PRIu32")", printable_name, (u32)err);
-       return WIMLIB_ERR_WIMBOOT;
+       return true;
 }
 
 #endif /* __WIN32__ */