4 * Support for creating WIMBoot pointer files.
6 * See http://technet.microsoft.com/en-us/library/dn594399.aspx for general
7 * information about WIMBoot.
9 * Note that WIMBoot pointer files are actually implemented on top of the
10 * Windows Overlay File System Filter (WOF). See wof.h for more info.
14 * Copyright (C) 2014 Eric Biggers
16 * This file is free software; you can redistribute it and/or modify it under
17 * the terms of the GNU Lesser General Public License as published by the Free
18 * Software Foundation; either version 3 of the License, or (at your option) any
21 * This file is distributed in the hope that it will be useful, but WITHOUT
22 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
23 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
26 * You should have received a copy of the GNU Lesser General Public License
27 * along with this file; if not, see http://www.gnu.org/licenses/.
36 #include "wimlib/win32_common.h"
38 #include "wimlib/assert.h"
39 #include "wimlib/blob_table.h"
40 #include "wimlib/inode.h"
41 #include "wimlib/error.h"
42 #include "wimlib/util.h"
43 #include "wimlib/wimboot.h"
44 #include "wimlib/win32.h"
45 #include "wimlib/wof.h"
48 open_file(const wchar_t *device_name, DWORD desiredAccess)
50 return CreateFile(device_name, desiredAccess,
51 FILE_SHARE_VALID_FLAGS, NULL, OPEN_EXISTING,
52 FILE_FLAG_BACKUP_SEMANTICS, NULL);
56 query_device(HANDLE h, DWORD code, void *out, DWORD out_size)
59 return DeviceIoControl(h, code, NULL, 0, out, out_size,
60 &bytes_returned, NULL);
64 * Gets partition and drive information for the specified path.
67 * Absolute path which must begin with a drive letter. For example, if the
68 * path is D:\install.wim, this function will query information about the
71 * Partition info is returned here.
73 * Drive info is returned here. The contained partition info will not be
76 * Returns 0 on success, or a positive error code on failure.
79 query_partition_and_disk_info(const wchar_t *path,
80 PARTITION_INFORMATION_EX *part_info,
81 DRIVE_LAYOUT_INFORMATION_EX *drive_info_ret)
83 wchar_t vol_name[] = L"\\\\.\\X:";
84 wchar_t disk_name[] = L"\\\\?\\PhysicalDriveXXXXXXXXXX";
85 HANDLE h = INVALID_HANDLE_VALUE;
86 VOLUME_DISK_EXTENTS *extents = NULL;
88 DRIVE_LAYOUT_INFORMATION_EX *drive_info = NULL;
89 size_t drive_info_size;
92 wimlib_assert(path[0] != L'\0' && path[1] == L':');
94 *(wcschr(vol_name, L'X')) = path[0];
96 h = open_file(vol_name, GENERIC_READ);
97 if (h == INVALID_HANDLE_VALUE) {
98 win32_error(GetLastError(), L"\"%ls\": Can't open volume device",
100 ret = WIMLIB_ERR_OPEN;
104 if (!query_device(h, IOCTL_DISK_GET_PARTITION_INFO_EX,
105 part_info, sizeof(PARTITION_INFORMATION_EX)))
107 win32_error(GetLastError(),
108 L"\"%ls\": Can't get partition info", vol_name);
109 ret = WIMLIB_ERR_READ;
113 extents_size = sizeof(VOLUME_DISK_EXTENTS);
115 extents_size += 4 * sizeof(DISK_EXTENT);
116 extents = MALLOC(extents_size);
118 ret = WIMLIB_ERR_NOMEM;
122 if (query_device(h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS,
123 extents, extents_size))
125 if (GetLastError() != ERROR_MORE_DATA) {
126 win32_error(GetLastError(),
127 L"\"%ls\": Can't get volume extent info",
129 ret = WIMLIB_ERR_READ;
136 h = INVALID_HANDLE_VALUE;
138 if (extents->NumberOfDiskExtents != 1) {
139 ERROR("\"%ls\": This volume has %"PRIu32" disk extents, "
140 "but this code is untested for more than 1",
141 vol_name, (u32)extents->NumberOfDiskExtents);
142 ret = WIMLIB_ERR_UNSUPPORTED;
146 wsprintf(wcschr(disk_name, L'X'), L"%"PRIu32,
147 extents->Extents[0].DiskNumber);
149 h = open_file(disk_name, GENERIC_READ);
150 if (h == INVALID_HANDLE_VALUE) {
151 win32_error(GetLastError(),
152 L"\"%ls\": Can't open disk device", disk_name);
153 ret = WIMLIB_ERR_OPEN;
157 drive_info_size = sizeof(DRIVE_LAYOUT_INFORMATION_EX);
159 drive_info_size += 4 * sizeof(PARTITION_INFORMATION_EX);
160 drive_info = MALLOC(drive_info_size);
162 ret = WIMLIB_ERR_NOMEM;
166 if (query_device(h, IOCTL_DISK_GET_DRIVE_LAYOUT_EX,
167 drive_info, drive_info_size))
169 if (GetLastError() != ERROR_INSUFFICIENT_BUFFER) {
170 win32_error(GetLastError(),
171 L"\"%ls\": Can't get disk info", disk_name);
172 ret = WIMLIB_ERR_READ;
178 *drive_info_ret = *drive_info; /* doesn't include partitions */
180 h = INVALID_HANDLE_VALUE;
182 if (drive_info->PartitionStyle != part_info->PartitionStyle) {
183 ERROR("\"%ls\", \"%ls\": Inconsistent partition table type!",
184 vol_name, disk_name);
185 ret = WIMLIB_ERR_UNSUPPORTED;
189 if (part_info->PartitionStyle == PARTITION_STYLE_GPT) {
190 STATIC_ASSERT(sizeof(part_info->Gpt.PartitionId) ==
191 sizeof(drive_info->Gpt.DiskId));
192 if (!memcmp(&part_info->Gpt.PartitionId,
193 &drive_info->Gpt.DiskId,
194 sizeof(drive_info->Gpt.DiskId)))
196 ERROR("\"%ls\", \"%ls\": Partition GUID is the "
197 "same as the disk GUID???", vol_name, disk_name);
198 ret = WIMLIB_ERR_UNSUPPORTED;
203 if (part_info->PartitionStyle != PARTITION_STYLE_MBR &&
204 part_info->PartitionStyle != PARTITION_STYLE_GPT)
206 ERROR("\"%ls\": Unknown partition style 0x%08"PRIx32,
207 vol_name, (u32)part_info->PartitionStyle);
208 ret = WIMLIB_ERR_UNSUPPORTED;
216 if (h != INVALID_HANDLE_VALUE)
222 * Allocate a new WIM data source ID.
225 * Previous WimOverlay.dat contents, or NULL if file did not exist.
227 * Returns the new data source ID.
230 alloc_new_data_source_id(const struct WimOverlay_dat_header *old_hdr)
235 for (u64 id = 0; ; id++) {
236 for (u32 i = 0; i < old_hdr->num_entries_1; i++)
237 if (id == old_hdr->entry_1s[i].data_source_id)
246 * Calculate the size of WimOverlay.dat with one entry added.
249 * Previous WimOverlay.dat contents, or NULL if file did not exist.
251 * Size of entry_2 being added.
253 * Size will be returned here.
255 * Returns 0 on success, or WIMLIB_ERR_UNSUPPORTED if size overflows 32 bits.
258 calculate_wimoverlay_dat_size(const struct WimOverlay_dat_header *old_hdr,
259 u32 new_entry_2_size, u32 *size_ret)
264 size_64 = sizeof(struct WimOverlay_dat_header);
266 for (u32 i = 0; i < old_hdr->num_entries_1; i++) {
267 size_64 += sizeof(struct WimOverlay_dat_entry_1);
268 size_64 += old_hdr->entry_1s[i].entry_2_length;
271 size_64 += sizeof(struct WimOverlay_dat_entry_1);
272 size_64 += new_entry_2_size;
276 return WIMLIB_ERR_UNSUPPORTED;
283 * Writes @size bytes of @contents to the named file @path.
285 * Returns 0 on success; WIMLIB_ERR_OPEN or WIMLIB_ERR_WRITE on failure.
288 write_wimoverlay_dat(const wchar_t *path, const void *contents, u32 size)
293 h = CreateFile(path, GENERIC_WRITE, 0, NULL,
294 CREATE_ALWAYS, FILE_FLAG_BACKUP_SEMANTICS, NULL);
295 if (h == INVALID_HANDLE_VALUE) {
296 win32_error(GetLastError(),
297 L"\"%ls\": Can't open file for writing", path);
298 return WIMLIB_ERR_OPEN;
302 if (!WriteFile(h, contents, size, &bytes_written, NULL) ||
303 bytes_written != size)
305 win32_error(GetLastError(),
306 L"\"%ls\": Can't write file", path);
308 return WIMLIB_ERR_WRITE;
311 if (!CloseHandle(h)) {
312 win32_error(GetLastError(),
313 L"\"%ls\": Can't close handle", path);
314 return WIMLIB_ERR_WRITE;
321 * Generates the contents of WimOverlay.dat in memory, with one entry added.
324 * Buffer large enough to hold the new contents.
326 * Old contents of WimOverlay.dat, or NULL if it did not exist.
328 * Absolute path to the WIM file. It must begin with a drive letter; for
329 * example, D:\install.wim.
331 * GUID of the WIM, from the WIM header.
333 * Number of the image in the WIM to specify in the new entry.
334 * @new_data_source_id
335 * Data source ID to use for the new entry.
337 * Partition information for the WIM file.
339 * Disk information for the WIM file.
341 * Size, in bytes, of the new location information structure ('struct
342 * WimOverlay_dat_entry_2').
344 * Returns a pointer one past the last byte of @buf filled in.
347 fill_in_wimoverlay_dat(u8 *buf,
348 const struct WimOverlay_dat_header *old_hdr,
349 const wchar_t *wim_path,
350 const u8 wim_guid[GUID_SIZE],
352 u64 new_data_source_id,
353 const PARTITION_INFORMATION_EX *part_info,
354 const DRIVE_LAYOUT_INFORMATION_EX *disk_info,
355 u32 new_entry_2_size)
357 struct WimOverlay_dat_header *new_hdr;
358 struct WimOverlay_dat_entry_1 *new_entry_1;
359 struct WimOverlay_dat_entry_2 *new_entry_2;
363 new_hdr = (struct WimOverlay_dat_header *)p;
365 /* Fill in new header */
366 new_hdr->magic = WIMOVERLAY_DAT_MAGIC;
367 new_hdr->wim_provider_version = WIM_PROVIDER_CURRENT_VERSION;
368 new_hdr->unknown_0x08 = 0x00000028;
369 new_hdr->num_entries_1 = (old_hdr ? old_hdr->num_entries_1 : 0) + 1;
370 new_hdr->num_entries_2 = (old_hdr ? old_hdr->num_entries_2 : 0) + 1;
371 new_hdr->unknown_0x14 = 0x00000000;
373 p += sizeof(struct WimOverlay_dat_header);
375 /* Copy WIM-specific information for old entries */
376 entry_2_offset = sizeof(struct WimOverlay_dat_header) +
377 (new_hdr->num_entries_1 * sizeof(struct WimOverlay_dat_entry_1));
379 for (u32 i = 0; i < old_hdr->num_entries_1; i++) {
380 new_entry_1 = (struct WimOverlay_dat_entry_1 *)p;
382 p = mempcpy(p, &old_hdr->entry_1s[i],
383 sizeof(struct WimOverlay_dat_entry_1));
385 new_entry_1->entry_2_offset = entry_2_offset;
386 entry_2_offset += new_entry_1->entry_2_length;
390 /* Generate WIM-specific information for new entry */
391 new_entry_1 = (struct WimOverlay_dat_entry_1 *)p;
393 new_entry_1->data_source_id = new_data_source_id;
394 new_entry_1->entry_2_offset = entry_2_offset;
395 new_entry_1->entry_2_length = new_entry_2_size;
396 new_entry_1->wim_type = WIM_BOOT_NOT_OS_WIM;
397 new_entry_1->wim_index = image;
398 STATIC_ASSERT(sizeof(new_entry_1->guid) == GUID_SIZE);
399 copy_guid(new_entry_1->guid, wim_guid);
401 p += sizeof(struct WimOverlay_dat_entry_1);
403 /* Copy WIM location information for old entries */
405 for (u32 i = 0; i < old_hdr->num_entries_1; i++) {
406 wimlib_assert(new_hdr->entry_1s[i].entry_2_offset == p - buf);
407 wimlib_assert(old_hdr->entry_1s[i].entry_2_length ==
408 new_hdr->entry_1s[i].entry_2_length);
410 ((const u8 *)old_hdr + old_hdr->entry_1s[i].entry_2_offset),
411 old_hdr->entry_1s[i].entry_2_length);
415 /* Generate WIM location information for new entry */
416 new_entry_2 = (struct WimOverlay_dat_entry_2 *)p;
418 new_entry_2->unknown_0x00 = 0x00000000;
419 new_entry_2->unknown_0x04 = 0x00000000;
420 new_entry_2->entry_2_length = new_entry_2_size;
421 new_entry_2->unknown_0x0C = 0x00000000;
422 new_entry_2->unknown_0x10 = 0x00000005;
423 new_entry_2->unknown_0x14 = 0x00000001;
424 new_entry_2->inner_struct_size = new_entry_2_size - 0x14;
425 new_entry_2->unknown_0x1C = 0x00000005;
426 new_entry_2->unknown_0x20 = 0x00000006;
427 new_entry_2->unknown_0x24 = 0x00000000;
428 new_entry_2->unknown_0x28 = 0x00000048;
429 new_entry_2->unknown_0x2C = 0x00000000;
430 new_entry_2->unknown_0x40 = 0x00000000;
432 if (part_info->PartitionStyle == PARTITION_STYLE_MBR) {
433 new_entry_2->partition.mbr.part_start_offset = part_info->StartingOffset.QuadPart;
434 new_entry_2->partition.mbr.padding = 0;
435 new_entry_2->partition_table_type = WIMOVERLAY_PARTITION_TYPE_MBR;
436 new_entry_2->disk.mbr.disk_id = disk_info->Mbr.Signature;
437 new_entry_2->disk.mbr.padding[0] = 0x00000000;
438 new_entry_2->disk.mbr.padding[1] = 0x00000000;
439 new_entry_2->disk.mbr.padding[2] = 0x00000000;
441 STATIC_ASSERT(sizeof(new_entry_2->partition.gpt.part_unique_guid) ==
442 sizeof(part_info->Gpt.PartitionId));
443 memcpy(new_entry_2->partition.gpt.part_unique_guid,
444 &part_info->Gpt.PartitionId,
445 sizeof(part_info->Gpt.PartitionId));
446 new_entry_2->partition_table_type = WIMOVERLAY_PARTITION_TYPE_GPT;
448 STATIC_ASSERT(sizeof(new_entry_2->disk.gpt.disk_guid) ==
449 sizeof(disk_info->Gpt.DiskId));
450 memcpy(new_entry_2->disk.gpt.disk_guid,
451 &disk_info->Gpt.DiskId,
452 sizeof(disk_info->Gpt.DiskId));
454 STATIC_ASSERT(sizeof(new_entry_2->disk.gpt.disk_guid) ==
455 sizeof(new_entry_2->partition.gpt.part_unique_guid));
457 new_entry_2->unknown_0x58[0] = 0x00000000;
458 new_entry_2->unknown_0x58[1] = 0x00000000;
459 new_entry_2->unknown_0x58[2] = 0x00000000;
460 new_entry_2->unknown_0x58[3] = 0x00000000;
462 wimlib_assert(wim_path[2] == L'\\');
463 return mempcpy(new_entry_2->wim_file_name,
465 new_entry_2_size - sizeof(struct WimOverlay_dat_entry_2));
469 * Prepares the new contents of WimOverlay.dat in memory, with one entry added.
472 * Old contents of WimOverlay.dat, or NULL if it did not exist.
474 * Absolute path to the WIM file. It must begin with a drive letter; for
475 * example, D:\install.wim.
477 * GUID of the WIM, from the WIM header.
479 * Number of the image in the WIM to specify in the new entry.
481 * Location into which to return the new contents as a malloc()ed buffer on
483 * @new_contents_size_ret
484 * Location into which to return the size, in bytes, of the new contents on
486 * @new_data_source_id_ret
487 * Location into which to return the data source ID of the new entry on
490 * Returns 0 on success, or a positive error code on failure.
493 prepare_wimoverlay_dat(const struct WimOverlay_dat_header *old_hdr,
494 const wchar_t *wim_path,
495 const u8 wim_guid[GUID_SIZE],
497 void **new_contents_ret,
498 u32 *new_contents_size_ret,
499 u64 *new_data_source_id_ret)
502 PARTITION_INFORMATION_EX part_info;
503 DRIVE_LAYOUT_INFORMATION_EX disk_info;
504 u64 new_data_source_id;
505 u32 new_entry_2_size;
506 u32 new_contents_size;
510 ret = query_partition_and_disk_info(wim_path, &part_info, &disk_info);
514 new_data_source_id = alloc_new_data_source_id(old_hdr);
516 new_entry_2_size = sizeof(struct WimOverlay_dat_entry_2) +
517 ((wcslen(wim_path) - 2 + 1) * sizeof(wchar_t));
518 ret = calculate_wimoverlay_dat_size(old_hdr, new_entry_2_size,
523 buf = MALLOC(new_contents_size);
525 return WIMLIB_ERR_NOMEM;
527 end = fill_in_wimoverlay_dat(buf, old_hdr, wim_path, wim_guid, image,
529 &part_info, &disk_info, new_entry_2_size);
531 wimlib_assert(end - buf == new_contents_size);
533 *new_contents_ret = buf;
534 *new_contents_size_ret = new_contents_size;
535 *new_data_source_id_ret = new_data_source_id;
540 * Reads and validates a WimOverlay.dat file.
543 * Path to the WimOverlay.dat file, such as
544 * C:\System Volume Information\WimOverlay.dat
546 * Location into which to return the contents as a malloc()ed buffer on
547 * success. This can be cast to 'struct WimOverlay_dat_header', and its
548 * contents are guaranteed to be valid. Alternatively, if the file does
549 * not exist, NULL will be returned here.
551 * Returns 0 on success, or a positive error code on failure.
554 read_wimoverlay_dat(const wchar_t *path, void **contents_ret)
557 BY_HANDLE_FILE_INFORMATION info;
560 const struct WimOverlay_dat_header *hdr;
562 bool already_retried = false;
565 h = open_file(path, GENERIC_READ);
566 if (h == INVALID_HANDLE_VALUE) {
567 DWORD err = GetLastError();
568 if (err == ERROR_FILE_NOT_FOUND) {
569 *contents_ret = NULL;
572 if (err == ERROR_PATH_NOT_FOUND &&
573 func_RtlCreateSystemVolumeInformationFolder)
575 wchar_t volume_root_path[] = L"\\??\\X:\\";
577 *(wcschr(volume_root_path, L'X')) = path[0];
579 UNICODE_STRING str = {
580 .Length = sizeof(volume_root_path) - sizeof(wchar_t),
581 .MaximumLength = sizeof(volume_root_path),
582 .Buffer = volume_root_path,
587 status = (*func_RtlCreateSystemVolumeInformationFolder)(&str);
589 err2 = (*func_RtlNtStatusToDosError)(status);
590 if (err2 == ERROR_SUCCESS) {
591 if (!already_retried) {
592 already_retried = true;
599 win32_error(err, L"\"%ls\": Can't open for reading", path);
600 return WIMLIB_ERR_OPEN;
602 if (!GetFileInformationByHandle(h, &info)) {
603 win32_error(GetLastError(), L"\"%ls\": Can't query metadata", path);
605 return WIMLIB_ERR_STAT;
609 if (!info.nFileSizeHigh)
610 contents = MALLOC(info.nFileSizeLow);
612 ERROR("\"%ls\": File is too large to fit into memory", path);
614 return WIMLIB_ERR_NOMEM;
618 if (!ReadFile(h, contents, info.nFileSizeLow, &bytes_read, NULL) ||
619 bytes_read != info.nFileSizeLow)
621 win32_error(GetLastError(), L"\"%ls\": Can't read data", path);
623 ret = WIMLIB_ERR_READ;
624 goto out_free_contents;
629 if (info.nFileSizeLow < sizeof(struct WimOverlay_dat_header)) {
630 ERROR("\"%ls\": File is unexpectedly small (only %"PRIu32" bytes)",
631 path, (u32)info.nFileSizeLow);
632 ret = WIMLIB_ERR_UNSUPPORTED;
633 goto out_free_contents;
636 hdr = (const struct WimOverlay_dat_header *)contents;
638 if (hdr->magic != WIMOVERLAY_DAT_MAGIC ||
639 hdr->wim_provider_version != WIM_PROVIDER_CURRENT_VERSION ||
640 hdr->unknown_0x08 != 0x00000028 ||
641 (hdr->num_entries_1 != hdr->num_entries_2) ||
642 hdr->unknown_0x14 != 0x00000000)
644 ERROR("\"%ls\": Header contains unexpected data:", path);
645 if (wimlib_print_errors) {
646 print_byte_field((const u8 *)hdr,
647 sizeof(struct WimOverlay_dat_header),
649 fputc('\n', wimlib_error_file);
651 ret = WIMLIB_ERR_UNSUPPORTED;
652 goto out_free_contents;
655 if ((u64)hdr->num_entries_1 * sizeof(struct WimOverlay_dat_entry_1) >
656 info.nFileSizeLow - sizeof(struct WimOverlay_dat_header))
658 ERROR("\"%ls\": File is unexpectedly small "
659 "(only %"PRIu32" bytes, but has %"PRIu32" entries)",
660 path, (u32)info.nFileSizeLow, hdr->num_entries_1);
661 ret = WIMLIB_ERR_UNSUPPORTED;
662 goto out_free_contents;
665 for (u32 i = 0; i < hdr->num_entries_1; i++) {
666 const struct WimOverlay_dat_entry_1 *entry_1;
667 const struct WimOverlay_dat_entry_2 *entry_2;
668 u32 wim_file_name_length;
670 entry_1 = &hdr->entry_1s[i];
672 if (((u64)entry_1->entry_2_offset +
673 (u64)entry_1->entry_2_length) >
676 ERROR("\"%ls\": entry %"PRIu32" (2) "
677 "(data source ID 0x%016"PRIx64") "
679 path, i, entry_1->data_source_id);
680 ret = WIMLIB_ERR_UNSUPPORTED;
681 goto out_free_contents;
683 if (entry_1->entry_2_length < sizeof(struct WimOverlay_dat_entry_2)) {
684 ERROR("\"%ls\": entry %"PRIu32" (2) "
685 "(data source ID 0x%016"PRIx64") "
687 path, i, entry_1->data_source_id);
688 ret = WIMLIB_ERR_UNSUPPORTED;
689 goto out_free_contents;
692 if (entry_1->entry_2_offset % 2 != 0) {
693 ERROR("\"%ls\": entry %"PRIu32" (2) "
694 "(data source ID 0x%016"PRIx64") "
696 path, i, entry_1->data_source_id);
697 ret = WIMLIB_ERR_UNSUPPORTED;
698 goto out_free_contents;
701 entry_2 = (const struct WimOverlay_dat_entry_2 *)
702 ((const u8 *)hdr + entry_1->entry_2_offset);
704 wim_file_name_length = entry_1->entry_2_length -
705 sizeof(struct WimOverlay_dat_entry_2);
706 if ((wim_file_name_length < 2 * sizeof(wchar_t)) ||
707 (wim_file_name_length % sizeof(wchar_t) != 0) ||
708 (wmemchr(entry_2->wim_file_name, L'\0',
709 wim_file_name_length / sizeof(wchar_t))
710 != &entry_2->wim_file_name[wim_file_name_length /
711 sizeof(wchar_t) - 1]))
713 ERROR("\"%ls\": entry %"PRIu32" (2) "
714 "(data source ID 0x%016"PRIx64") "
715 "has invalid WIM file name",
716 path, i, entry_1->data_source_id);
717 if (wimlib_print_errors) {
718 print_byte_field((const u8 *)entry_2->wim_file_name,
719 wim_file_name_length,
721 fputc('\n', wimlib_error_file);
723 ret = WIMLIB_ERR_UNSUPPORTED;
724 goto out_free_contents;
727 if (entry_2->unknown_0x00 != 0x00000000 ||
728 entry_2->unknown_0x04 != 0x00000000 ||
729 entry_2->unknown_0x0C != 0x00000000 ||
730 entry_2->entry_2_length != entry_1->entry_2_length ||
731 entry_2->unknown_0x10 != 0x00000005 ||
732 entry_2->unknown_0x14 != 0x00000001 ||
733 entry_2->inner_struct_size != entry_1->entry_2_length - 0x14 ||
734 entry_2->unknown_0x1C != 0x00000005 ||
735 entry_2->unknown_0x20 != 0x00000006 ||
736 entry_2->unknown_0x24 != 0x00000000 ||
737 entry_2->unknown_0x28 != 0x00000048 ||
738 entry_2->unknown_0x2C != 0x00000000 ||
739 entry_2->unknown_0x40 != 0x00000000 ||
740 (entry_2->partition_table_type != WIMOVERLAY_PARTITION_TYPE_GPT &&
741 entry_2->partition_table_type != WIMOVERLAY_PARTITION_TYPE_MBR) ||
742 (entry_2->partition_table_type == WIMOVERLAY_PARTITION_TYPE_MBR &&
743 entry_2->partition.mbr.padding != 0) ||
744 (entry_2->partition_table_type == WIMOVERLAY_PARTITION_TYPE_GPT &&
745 entry_2->partition.mbr.padding == 0) ||
746 entry_2->unknown_0x58[0] != 0x00000000 ||
747 entry_2->unknown_0x58[1] != 0x00000000 ||
748 entry_2->unknown_0x58[2] != 0x00000000 ||
749 entry_2->unknown_0x58[3] != 0x00000000)
751 ERROR("\"%ls\": entry %"PRIu32" (2) "
752 "(data source ID 0x%016"PRIx64") "
753 "contains unexpected data!",
754 path, i, entry_1->data_source_id);
755 if (wimlib_print_errors) {
756 print_byte_field((const u8 *)entry_2,
757 entry_1->entry_2_length,
759 fputc('\n', wimlib_error_file);
761 ret = WIMLIB_ERR_UNSUPPORTED;
762 goto out_free_contents;
766 *contents_ret = contents;
775 * Update WimOverlay.dat manually in order to add a WIM data source to the
778 * THIS CODE IS EXPERIMENTAL AS I HAD TO REVERSE ENGINEER THE FILE FORMAT!
781 * Target drive. Must be a letter followed by a colon (e.g. D:).
783 * Absolute path to the WIM file. It must begin with a drive letter; for
784 * example, D:\install.wim.
786 * GUID of the WIM, from the WIM header.
788 * Number of the image in the WIM to specify in the new entry.
789 * @data_source_id_ret
790 * On success, the allocated data source ID is returned here.
793 update_wimoverlay_manually(const wchar_t *drive, const wchar_t *wim_path,
794 const u8 wim_guid[GUID_SIZE],
795 int image, u64 *data_source_id_ret)
797 wchar_t path_main[] = L"A:\\System Volume Information\\WimOverlay.dat";
798 wchar_t path_backup[] = L"A:\\System Volume Information\\WimOverlay.backup";
799 wchar_t path_wimlib_backup[] = L"A:\\System Volume Information\\WimOverlay.wimlib_backup";
800 wchar_t path_new[] = L"A:\\System Volume Information\\WimOverlay.wimlib_new";
803 u32 new_contents_size;
804 u64 new_data_source_id;
807 wimlib_assert(drive[0] != L'\0' &&
811 path_main[0] = drive[0];
812 path_backup[0] = drive[0];
813 path_wimlib_backup[0] = drive[0];
814 path_new[0] = drive[0];
816 ret = read_wimoverlay_dat(path_main, &old_contents);
820 ret = prepare_wimoverlay_dat(old_contents, wim_path, wim_guid, image,
821 &new_contents, &new_contents_size,
822 &new_data_source_id);
827 /* Write WimOverlay.wimlib_new */
828 ret = write_wimoverlay_dat(path_new,
829 new_contents, new_contents_size);
831 goto out_free_new_contents;
833 /* Write WimOverlay.backup */
834 ret = write_wimoverlay_dat(path_backup,
835 new_contents, new_contents_size);
837 goto out_free_new_contents;
840 /* Rename WimOverlay.dat => WimOverlay.wimlib_backup */
841 ret = win32_rename_replacement(path_main, path_wimlib_backup);
843 ERROR_WITH_ERRNO("Can't rename \"%ls\" => \"%ls\"",
844 path_main, path_wimlib_backup);
845 ret = WIMLIB_ERR_RENAME;
846 goto out_free_new_contents;
850 /* Rename WimOverlay.wimlib_new => WimOverlay.dat */
851 ret = win32_rename_replacement(path_new, path_main);
853 ERROR_WITH_ERRNO("Can't rename \"%ls\" => \"%ls\"",
854 path_new, path_main);
855 ret = WIMLIB_ERR_RENAME;
857 out_free_new_contents:
860 if (ret == WIMLIB_ERR_UNSUPPORTED) {
861 ERROR("Please report to developer ("PACKAGE_BUGREPORT").\n"
862 " If possible send the file \"%ls\".\n\n", path_main);
865 *data_source_id_ret = new_data_source_id;
870 * Allocate a WOF data source ID for a WIM file.
873 * Absolute path to the WIM file. This must include a drive letter and use
874 * backslash path separators.
876 * GUID of the WIM, from the WIM header.
878 * Number of the image in the WIM being applied.
880 * Path to the target directory.
881 * @data_source_id_ret
882 * On success, an identifier for the backing WIM file will be returned
885 * Returns 0 on success, or a positive error code on failure.
888 wimboot_alloc_data_source_id(const wchar_t *wim_path,
889 const u8 wim_guid[GUID_SIZE],
890 int image, const wchar_t *target,
891 u64 *data_source_id_ret, bool *wof_running_ret)
894 size_t wim_path_nchars;
895 size_t wim_file_name_length;
898 struct wof_external_info *wof_info;
899 struct wim_provider_add_overlay_input *wim_info;
902 DWORD bytes_returned;
904 const wchar_t *prefix = L"\\??\\";
905 const size_t prefix_nchars = 4;
906 bool tried_to_attach_wof = false;
908 ret = win32_get_drive_path(target, drive_path);
912 wimlib_assert(!wcschr(wim_path, L'/'));
913 wimlib_assert(wim_path[0] != L'\0' && wim_path[1] == L':');
915 wim_path_nchars = wcslen(wim_path);
916 wim_file_name_length = sizeof(wchar_t) *
917 (wim_path_nchars + prefix_nchars);
919 insize = sizeof(struct wof_external_info) +
920 sizeof(struct wim_provider_add_overlay_input) +
921 wim_file_name_length;
925 ret = WIMLIB_ERR_NOMEM;
929 wof_info = (struct wof_external_info *)in;
930 wof_info->version = WOF_CURRENT_VERSION;
931 wof_info->provider = WOF_PROVIDER_WIM;
933 wim_info = (struct wim_provider_add_overlay_input *)(wof_info + 1);
934 wim_info->wim_type = WIM_BOOT_NOT_OS_WIM;
935 wim_info->wim_index = image;
936 wim_info->wim_file_name_offset = offsetof(struct wim_provider_add_overlay_input,
938 wim_info->wim_file_name_length = wim_file_name_length;
939 wmemcpy(&wim_info->wim_file_name[0], prefix, prefix_nchars);
940 wmemcpy(&wim_info->wim_file_name[prefix_nchars], wim_path, wim_path_nchars);
943 h = open_file(drive_path, GENERIC_WRITE);
945 if (h == INVALID_HANDLE_VALUE) {
946 win32_error(GetLastError(),
947 L"Failed to open \"%ls\"", drive_path + 4);
948 ret = WIMLIB_ERR_OPEN;
952 if (!DeviceIoControl(h, FSCTL_ADD_OVERLAY,
954 &data_source_id, sizeof(data_source_id),
955 &bytes_returned, NULL))
957 DWORD err = GetLastError();
958 if (err == ERROR_INVALID_FUNCTION) {
959 if (!tried_to_attach_wof) {
961 h = INVALID_HANDLE_VALUE;
962 tried_to_attach_wof = true;
963 if (win32_try_to_attach_wof(drive_path + 4))
966 ret = WIMLIB_ERR_UNSUPPORTED;
967 goto out_close_handle;
969 win32_error(err, L"Failed to add overlay source \"%ls\" "
970 "to volume \"%ls\"", wim_path, drive_path + 4);
971 ret = WIMLIB_ERR_WIMBOOT;
972 goto out_close_handle;
976 if (bytes_returned != sizeof(data_source_id)) {
977 ret = WIMLIB_ERR_WIMBOOT;
978 ERROR("Unexpected result size when adding "
979 "overlay source \"%ls\" to volume \"%ls\"",
980 wim_path, drive_path + 4);
981 goto out_close_handle;
984 *wof_running_ret = true;
985 *data_source_id_ret = data_source_id;
993 if (ret == WIMLIB_ERR_UNSUPPORTED) {
996 "The version of Windows you are running does not appear to support\n"
997 " the Windows Overlay File System Filter Driver. This is normally\n"
998 " available on Windows 8.1 Update 1 or later. Therefore, wimlib\n"
999 " will attempt to update the WimOverlay.dat file directly.\n");
1001 WARNING("WOF driver is not available; updating WimOverlay.dat directly.");
1003 ret = update_wimoverlay_manually(drive_path + 4, wim_path,
1005 data_source_id_ret);
1006 *wof_running_ret = false;
1013 * Set WIMBoot information on the specified file.
1015 * This turns it into a reparse point that redirects accesses to it, to the
1016 * corresponding resource in the WIM archive.
1019 * Open handle to the file, with GENERIC_WRITE access.
1021 * The blob for the unnamed data stream of the file.
1023 * Allocated identifier for the WIM data source on the destination volume.
1025 * SHA-1 message digest of the WIM's blob table.
1027 * %true if the WOF driver appears to be available and working; %false if
1030 * Returns %true on success, or %false on failure with GetLastError() set.
1033 wimboot_set_pointer(HANDLE h,
1034 const struct blob_descriptor *blob,
1036 const u8 blob_table_hash[SHA1_HASH_SIZE],
1039 DWORD bytes_returned;
1042 /* The WOF driver is running. We can create the reparse point
1043 * using FSCTL_SET_EXTERNAL_BACKING. */
1044 unsigned int max_retries = 4;
1046 struct wof_external_info wof_info;
1047 struct wim_provider_external_info wim_info;
1051 memset(&in, 0, sizeof(in));
1053 in.wof_info.version = WOF_CURRENT_VERSION;
1054 in.wof_info.provider = WOF_PROVIDER_WIM;
1056 in.wim_info.version = WIM_PROVIDER_CURRENT_VERSION;
1057 in.wim_info.flags = 0;
1058 in.wim_info.data_source_id = data_source_id;
1059 copy_hash(in.wim_info.unnamed_data_stream_hash, blob->hash);
1061 /* blob_table_hash is not necessary */
1063 if (!DeviceIoControl(h, FSCTL_SET_EXTERNAL_BACKING,
1064 &in, sizeof(in), NULL, 0,
1065 &bytes_returned, NULL))
1067 /* Try to track down sporadic errors */
1068 if (wimlib_print_errors) {
1069 WARNING("FSCTL_SET_EXTERNAL_BACKING failed (err=%u); data was %zu bytes:",
1070 (u32)GetLastError(), sizeof(in));
1071 print_byte_field((const u8 *)&in, sizeof(in), wimlib_error_file);
1072 putc('\n', wimlib_error_file);
1074 if (--max_retries) {
1075 WARNING("Retrying after 100ms...");
1079 WARNING("Too many retries; returning failure");
1084 /* The WOF driver is running. We need to create the reparse
1085 * point manually. */
1093 struct wof_external_info wof_info;
1094 struct wim_provider_rpdata wim_info;
1097 STATIC_ASSERT(sizeof(in) == 8 +
1098 sizeof(struct wof_external_info) +
1099 sizeof(struct wim_provider_rpdata));
1101 in.hdr.rptag = WIM_IO_REPARSE_TAG_WOF;
1102 in.hdr.rpdatalen = sizeof(in) - sizeof(in.hdr);
1103 in.hdr.rpreserved = 0;
1105 in.wof_info.version = WOF_CURRENT_VERSION;
1106 in.wof_info.provider = WOF_PROVIDER_WIM;
1108 in.wim_info.version = 2;
1109 in.wim_info.flags = 0;
1110 in.wim_info.data_source_id = data_source_id;
1111 copy_hash(in.wim_info.unnamed_data_stream_hash, blob->hash);
1112 copy_hash(in.wim_info.blob_table_hash, blob_table_hash);
1113 in.wim_info.unnamed_data_stream_size = blob->size;
1114 in.wim_info.unnamed_data_stream_size_in_wim = blob->rdesc->size_in_wim;
1115 in.wim_info.unnamed_data_stream_offset_in_wim = blob->rdesc->offset_in_wim;
1117 if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT,
1118 &in, sizeof(in), NULL, 0, &bytes_returned, NULL))
1121 /* We also need to create an unnamed data stream of the correct
1122 * size. Otherwise the file shows up as zero length. It can be
1123 * a sparse stream containing all zeroes; its contents
1124 * are unimportant. */
1125 if (!DeviceIoControl(h, FSCTL_SET_SPARSE, NULL, 0, NULL, 0,
1126 &bytes_returned, NULL))
1129 if (!SetFilePointerEx(h,
1130 (LARGE_INTEGER){ .QuadPart = blob->size},
1134 if (!SetEndOfFile(h))
1141 #endif /* __WIN32__ */