VirtualBox

source: vbox/trunk/src/VBox/Storage/VHDX.cpp@ 49439

Last change on this file since 49439 was 48861, checked in by vboxsync, 11 years ago

warning
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 90.5 KB
Line 
1/* $Id: VHDX.cpp 48861 2013-10-04 00:59:38Z vboxsync $ */
2/** @file
3 * VHDX - VHDX Disk image, Core Code.
4 */
5
6/*
7 * Copyright (C) 2012-2013 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18/*******************************************************************************
19* Header Files *
20*******************************************************************************/
21#define LOG_GROUP LOG_GROUP_DEFAULT /** @todo: Log group */
22#include <VBox/vd-plugin.h>
23#include <VBox/err.h>
24
25#include <VBox/log.h>
26#include <iprt/asm.h>
27#include <iprt/assert.h>
28#include <iprt/alloc.h>
29#include <iprt/path.h>
30#include <iprt/uuid.h>
31#include <iprt/crc.h>
32
33/*******************************************************************************
34* On disk data structures *
35*******************************************************************************/
36
37/**
38 * VHDX file type identifier.
39 */
40#pragma pack(1)
41typedef struct VhdxFileIdentifier
42{
43 /** Signature. */
44 uint64_t u64Signature;
45 /** Creator ID - UTF-16 string (not neccessarily null terminated). */
46 uint16_t awszCreator[256];
47} VhdxFileIdentifier;
48#pragma pack()
49/** Pointer to an on disk VHDX file type identifier. */
50typedef VhdxFileIdentifier *PVhdxFileIdentifier;
51
52/** VHDX file type identifier signature ("vhdxfile"). */
53#define VHDX_FILE_IDENTIFIER_SIGNATURE UINT64_C(0x656c696678646876)
54/** Start offset of the VHDX file type identifier. */
55#define VHDX_FILE_IDENTIFIER_OFFSET UINT64_C(0)
56
57/**
58 * VHDX header.
59 */
60#pragma pack(1)
61typedef struct VhdxHeader
62{
63 /** Signature. */
64 uint32_t u32Signature;
65 /** Checksum. */
66 uint32_t u32Checksum;
67 /** Sequence number. */
68 uint64_t u64SequenceNumber;
69 /** File write UUID. */
70 RTUUID UuidFileWrite;
71 /** Data write UUID. */
72 RTUUID UuidDataWrite;
73 /** Log UUID. */
74 RTUUID UuidLog;
75 /** Version of the log format. */
76 uint16_t u16LogVersion;
77 /** VHDX format version.. */
78 uint16_t u16Version;
79 /** Length of the log region. */
80 uint32_t u32LogLength;
81 /** Start offset of the log offset in the file. */
82 uint64_t u64LogOffset;
83 /** Reserved bytes. */
84 uint8_t u8Reserved[4016];
85} VhdxHeader;
86#pragma pack()
87/** Pointer to an on disk VHDX header. */
88typedef VhdxHeader *PVhdxHeader;
89
90/** VHDX header signature ("head"). */
91#define VHDX_HEADER_SIGNATURE UINT32_C(0x64616568)
92/** Start offset of the first VHDX header. */
93#define VHDX_HEADER1_OFFSET _64K
94/** Start offset of the second VHDX header. */
95#define VHDX_HEADER2_OFFSET _128K
96/** Current Log format version. */
97#define VHDX_HEADER_LOG_VERSION UINT16_C(0)
98/** Current VHDX format version. */
99#define VHDX_HEADER_VHDX_VERSION UINT16_C(1)
100
101/**
102 * VHDX region table header
103 */
104#pragma pack(1)
105typedef struct VhdxRegionTblHdr
106{
107 /** Signature. */
108 uint32_t u32Signature;
109 /** Checksum. */
110 uint32_t u32Checksum;
111 /** Number of region table entries following this header. */
112 uint32_t u32EntryCount;
113 /** Reserved. */
114 uint32_t u32Reserved;
115} VhdxRegionTblHdr;
116#pragma pack()
117/** Pointer to an on disk VHDX region table header. */
118typedef VhdxRegionTblHdr *PVhdxRegionTblHdr;
119
120/** VHDX region table header signature. */
121#define VHDX_REGION_TBL_HDR_SIGNATURE UINT32_C(0x69676572)
122/** Maximum number of entries which can follow. */
123#define VHDX_REGION_TBL_HDR_ENTRY_COUNT_MAX UINT32_C(2047)
124/** Offset where the region table is stored (192 KB). */
125#define VHDX_REGION_TBL_HDR_OFFSET UINT64_C(196608)
126/** Maximum size of the region table. */
127#define VHDX_REGION_TBL_SIZE_MAX _64K
128
129/**
130 * VHDX region table entry.
131 */
132#pragma pack(1)
133typedef struct VhdxRegionTblEntry
134{
135 /** Object UUID. */
136 RTUUID UuidObject;
137 /** File offset of the region. */
138 uint64_t u64FileOffset;
139 /** Length of the region in bytes. */
140 uint32_t u32Length;
141 /** Flags for this object. */
142 uint32_t u32Flags;
143} VhdxRegionTblEntry;
144#pragma pack()
145/** Pointer to an on disk VHDX region table entry. */
146typedef struct VhdxRegionTblEntry *PVhdxRegionTblEntry;
147
148/** Flag whether this region is required. */
149#define VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED RT_BIT_32(0)
150/** UUID for the BAT region. */
151#define VHDX_REGION_TBL_ENTRY_UUID_BAT "2dc27766-f623-4200-9d64-115e9bfd4a08"
152/** UUID for the metadata region. */
153#define VHDX_REGION_TBL_ENTRY_UUID_METADATA "8b7ca206-4790-4b9a-b8fe-575f050f886e"
154
155/**
156 * VHDX Log entry header.
157 */
158#pragma pack(1)
159typedef struct VhdxLogEntryHdr
160{
161 /** Signature. */
162 uint32_t u32Signature;
163 /** Checksum. */
164 uint32_t u32Checksum;
165 /** Total length of the entry in bytes. */
166 uint32_t u32EntryLength;
167 /** Tail of the log entries. */
168 uint32_t u32Tail;
169 /** Sequence number. */
170 uint64_t u64SequenceNumber;
171 /** Number of descriptors in this log entry. */
172 uint32_t u32DescriptorCount;
173 /** Reserved. */
174 uint32_t u32Reserved;
175 /** Log UUID. */
176 RTUUID UuidLog;
177 /** VHDX file size in bytes while the log entry was written. */
178 uint64_t u64FlushedFileOffset;
179 /** File size in bytes all allocated file structures fit into when the
180 * log entry was written. */
181 uint64_t u64LastFileOffset;
182} VhdxLogEntryHdr;
183#pragma pack()
184/** Pointer to an on disk VHDX log entry header. */
185typedef struct VhdxLogEntryHdr *PVhdxLogEntryHdr;
186
187/** VHDX log entry signature ("loge"). */
188#define VHDX_LOG_ENTRY_HEADER_SIGNATURE UINT32_C(0x65676f6c)
189
190/**
191 * VHDX log zero descriptor.
192 */
193#pragma pack(1)
194typedef struct VhdxLogZeroDesc
195{
196 /** Signature of this descriptor. */
197 uint32_t u32ZeroSignature;
198 /** Reserved. */
199 uint32_t u32Reserved;
200 /** Length of the section to zero. */
201 uint64_t u64ZeroLength;
202 /** File offset to write zeros to. */
203 uint64_t u64FileOffset;
204 /** Sequence number (must macht the field in the log entry header). */
205 uint64_t u64SequenceNumber;
206} VhdxLogZeroDesc;
207#pragma pack()
208/** Pointer to an on disk VHDX log zero descriptor. */
209typedef struct VhdxLogZeroDesc *PVhdxLogZeroDesc;
210
211/** Signature of a VHDX log zero descriptor ("zero"). */
212#define VHDX_LOG_ZERO_DESC_SIGNATURE UINT32_C(0x6f72657a)
213
214/**
215 * VHDX log data descriptor.
216 */
217#pragma pack(1)
218typedef struct VhdxLogDataDesc
219{
220 /** Signature of this descriptor. */
221 uint32_t u32DataSignature;
222 /** Trailing 4 bytes removed from the update. */
223 uint32_t u32TrailingBytes;
224 /** Leading 8 bytes removed from the update. */
225 uint64_t u64LeadingBytes;
226 /** File offset to write zeros to. */
227 uint64_t u64FileOffset;
228 /** Sequence number (must macht the field in the log entry header). */
229 uint64_t u64SequenceNumber;
230} VhdxLogDataDesc;
231#pragma pack()
232/** Pointer to an on disk VHDX log data descriptor. */
233typedef struct VhdxLogDataDesc *PVhdxLogDataDesc;
234
235/** Signature of a VHDX log data descriptor ("desc"). */
236#define VHDX_LOG_DATA_DESC_SIGNATURE UINT32_C(0x63736564)
237
238/**
239 * VHDX log data sector.
240 */
241#pragma pack(1)
242typedef struct VhdxLogDataSector
243{
244 /** Signature of the data sector. */
245 uint32_t u32DataSignature;
246 /** 4 most significant bytes of the sequence number. */
247 uint32_t u32SequenceHigh;
248 /** Raw data associated with the update. */
249 uint8_t u8Data[4084];
250 /** 4 least significant bytes of the sequence number. */
251 uint32_t u32SequenceLow;
252} VhdxLogDataSector;
253#pragma pack()
254/** Pointer to an on disk VHDX log data sector. */
255typedef VhdxLogDataSector *PVhdxLogDataSector;
256
257/** Signature of a VHDX log data sector ("data"). */
258#define VHDX_LOG_DATA_SECTOR_SIGNATURE UINT32_C(0x61746164)
259
260/**
261 * VHDX BAT entry.
262 */
263#pragma pack(1)
264typedef struct VhdxBatEntry
265{
266 /** The BAT entry, contains state and offset. */
267 uint64_t u64BatEntry;
268} VhdxBatEntry;
269#pragma pack()
270typedef VhdxBatEntry *PVhdxBatEntry;
271
272/** Return the BAT state from a given entry. */
273#define VHDX_BAT_ENTRY_GET_STATE(bat) ((bat) & UINT64_C(0x7))
274/** Get the FileOffsetMB field from a given BAT entry. */
275#define VHDX_BAT_ENTRY_GET_FILE_OFFSET_MB(bat) (((bat) & UINT64_C(0xfffffffffff00000)) >> 20)
276/** Get a byte offset from the BAT entry. */
277#define VHDX_BAT_ENTRY_GET_FILE_OFFSET(bat) (VHDX_BAT_ENTRY_GET_FILE_OFFSET_MB(bat) * (uint64_t)_1M)
278
279/** Block not present and the data is undefined. */
280#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_NOT_PRESENT (0)
281/** Data in this block is undefined. */
282#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_UNDEFINED (1)
283/** Data in this block contains zeros. */
284#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_ZERO (2)
285/** Block was unmapped by the application or system and data is either zero or
286 * the data before the block was unmapped. */
287#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_UNMAPPED (3)
288/** Block data is in the file pointed to by the FileOffsetMB field. */
289#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_FULLY_PRESENT (6)
290/** Block is partially present, use sector bitmap to get present sectors. */
291#define VHDX_BAT_ENTRY_PAYLOAD_BLOCK_PARTIALLY_PRESENT (7)
292
293/** The sector bitmap block is undefined and not allocated in the file. */
294#define VHDX_BAT_ENTRY_SB_BLOCK_NOT_PRESENT (0)
295/** The sector bitmap block is defined at the file location. */
296#define VHDX_BAT_ENTRY_SB_BLOCK_PRESENT (6)
297
298/**
299 * VHDX Metadata tabl header.
300 */
301#pragma pack(1)
302typedef struct VhdxMetadataTblHdr
303{
304 /** Signature. */
305 uint64_t u64Signature;
306 /** Reserved. */
307 uint16_t u16Reserved;
308 /** Number of entries in the table. */
309 uint16_t u16EntryCount;
310 /** Reserved */
311 uint32_t u32Reserved2[5];
312} VhdxMetadataTblHdr;
313#pragma pack()
314/** Pointer to an on disk metadata table header. */
315typedef VhdxMetadataTblHdr *PVhdxMetadataTblHdr;
316
317/** Signature of a VHDX metadata table header ("metadata"). */
318#define VHDX_METADATA_TBL_HDR_SIGNATURE UINT64_C(0x617461646174656d)
319/** Maximum number of entries the metadata table can have. */
320#define VHDX_METADATA_TBL_HDR_ENTRY_COUNT_MAX UINT16_C(2047)
321
322/**
323 * VHDX Metadata table entry.
324 */
325#pragma pack(1)
326typedef struct VhdxMetadataTblEntry
327{
328 /** Item UUID. */
329 RTUUID UuidItem;
330 /** Offset of the metadata item. */
331 uint32_t u32Offset;
332 /** Length of the metadata item. */
333 uint32_t u32Length;
334 /** Flags for the metadata item. */
335 uint32_t u32Flags;
336 /** Reserved. */
337 uint32_t u32Reserved;
338} VhdxMetadataTblEntry;
339#pragma pack()
340/** Pointer to an on disk metadata table entry. */
341typedef VhdxMetadataTblEntry *PVhdxMetadataTblEntry;
342
343/** FLag whether the metadata item is system or user metadata. */
344#define VHDX_METADATA_TBL_ENTRY_FLAGS_IS_USER RT_BIT_32(0)
345/** FLag whether the metadata item is file or virtual disk metadata. */
346#define VHDX_METADATA_TBL_ENTRY_FLAGS_IS_VDISK RT_BIT_32(1)
347/** FLag whether the backend must understand the metadata item to load the image. */
348#define VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED RT_BIT_32(2)
349
350/** File parameters item UUID. */
351#define VHDX_METADATA_TBL_ENTRY_ITEM_FILE_PARAMS "caa16737-fa36-4d43-b3b6-33f0aa44e76b"
352/** Virtual disk size item UUID. */
353#define VHDX_METADATA_TBL_ENTRY_ITEM_VDISK_SIZE "2fa54224-cd1b-4876-b211-5dbed83bf4b8"
354/** Page 83 UUID. */
355#define VHDX_METADATA_TBL_ENTRY_ITEM_PAGE83_DATA "beca12ab-b2e6-4523-93ef-c309e000c746"
356/** Logical sector size UUID. */
357#define VHDX_METADATA_TBL_ENTRY_ITEM_LOG_SECT_SIZE "8141bf1d-a96f-4709-ba47-f233a8faab5f"
358/** Physical sector size UUID. */
359#define VHDX_METADATA_TBL_ENTRY_ITEM_PHYS_SECT_SIZE "cda348c7-445d-4471-9cc9-e9885251c556"
360/** Parent locator UUID. */
361#define VHDX_METADATA_TBL_ENTRY_ITEM_PARENT_LOCATOR "a8d35f2d-b30b-454d-abf7-d3d84834ab0c"
362
363/**
364 * VHDX File parameters metadata item.
365 */
366#pragma pack(1)
367typedef struct VhdxFileParameters
368{
369 /** Block size. */
370 uint32_t u32BlockSize;
371 /** Flags. */
372 uint32_t u32Flags;
373} VhdxFileParameters;
374#pragma pack()
375/** Pointer to an on disk VHDX file parameters metadata item. */
376typedef struct VhdxFileParameters *PVhdxFileParameters;
377
378/** Flag whether to leave blocks allocated in the file or if it is possible to unmap them. */
379#define VHDX_FILE_PARAMETERS_FLAGS_LEAVE_BLOCKS_ALLOCATED RT_BIT_32(0)
380/** Flag whether this file has a parent VHDX file. */
381#define VHDX_FILE_PARAMETERS_FLAGS_HAS_PARENT RT_BIT_32(1)
382
383/**
384 * VHDX virtual disk size metadata item.
385 */
386#pragma pack(1)
387typedef struct VhdxVDiskSize
388{
389 /** Virtual disk size. */
390 uint64_t u64VDiskSize;
391} VhdxVDiskSize;
392#pragma pack()
393/** Pointer to an on disk VHDX virtual disk size metadata item. */
394typedef struct VhdxVDiskSize *PVhdxVDiskSize;
395
396/**
397 * VHDX page 83 data metadata item.
398 */
399#pragma pack(1)
400typedef struct VhdxPage83Data
401{
402 /** UUID for the SCSI device. */
403 RTUUID UuidPage83Data;
404} VhdxPage83Data;
405#pragma pack()
406/** Pointer to an on disk VHDX vpage 83 data metadata item. */
407typedef struct VhdxPage83Data *PVhdxPage83Data;
408
409/**
410 * VHDX virtual disk logical sector size.
411 */
412#pragma pack(1)
413typedef struct VhdxVDiskLogicalSectorSize
414{
415 /** Logical sector size. */
416 uint32_t u32LogicalSectorSize;
417} VhdxVDiskLogicalSectorSize;
418#pragma pack()
419/** Pointer to an on disk VHDX virtual disk logical sector size metadata item. */
420typedef struct VhdxVDiskLogicalSectorSize *PVhdxVDiskLogicalSectorSize;
421
422/**
423 * VHDX virtual disk physical sector size.
424 */
425#pragma pack(1)
426typedef struct VhdxVDiskPhysicalSectorSize
427{
428 /** Physical sector size. */
429 uint64_t u64PhysicalSectorSize;
430} VhdxVDiskPhysicalSectorSize;
431#pragma pack()
432/** Pointer to an on disk VHDX virtual disk physical sector size metadata item. */
433typedef struct VhdxVDiskPhysicalSectorSize *PVhdxVDiskPhysicalSectorSize;
434
435/**
436 * VHDX parent locator header.
437 */
438#pragma pack(1)
439typedef struct VhdxParentLocatorHeader
440{
441 /** Locator type UUID. */
442 RTUUID UuidLocatorType;
443 /** Reserved. */
444 uint16_t u16Reserved;
445 /** Number of key value pairs. */
446 uint16_t u16KeyValueCount;
447} VhdxParentLocatorHeader;
448#pragma pack()
449/** Pointer to an on disk VHDX parent locator header metadata item. */
450typedef struct VhdxParentLocatorHeader *PVhdxParentLocatorHeader;
451
452/** VHDX parent locator type. */
453#define VHDX_PARENT_LOCATOR_TYPE_VHDX "b04aefb7-d19e-4a81-b789-25b8e9445913"
454
455/**
456 * VHDX parent locator entry.
457 */
458#pragma pack(1)
459typedef struct VhdxParentLocatorEntry
460{
461 /** Offset of the key. */
462 uint32_t u32KeyOffset;
463 /** Offset of the value. */
464 uint32_t u32ValueOffset;
465 /** Length of the key. */
466 uint16_t u16KeyLength;
467 /** Length of the value. */
468 uint16_t u16ValueLength;
469} VhdxParentLocatorEntry;
470#pragma pack()
471/** Pointer to an on disk VHDX parent locator entry. */
472typedef struct VhdxParentLocatorEntry *PVhdxParentLocatorEntry;
473
474/*******************************************************************************
475* Constants And Macros, Structures and Typedefs *
476*******************************************************************************/
477
478typedef enum VHDXMETADATAITEM
479{
480 VHDXMETADATAITEM_UNKNOWN = 0,
481 VHDXMETADATAITEM_FILE_PARAMS,
482 VHDXMETADATAITEM_VDISK_SIZE,
483 VHDXMETADATAITEM_PAGE83_DATA,
484 VHDXMETADATAITEM_LOGICAL_SECTOR_SIZE,
485 VHDXMETADATAITEM_PHYSICAL_SECTOR_SIZE,
486 VHDXMETADATAITEM_PARENT_LOCATOR,
487 VHDXMETADATAITEM_32BIT_HACK = 0x7fffffff
488} VHDXMETADATAITEM;
489
490/**
491 * Table to validate the metadata item UUIDs and the flags.
492 */
493typedef struct VHDXMETADATAITEMPROPS
494{
495 /** Item UUID. */
496 const char *pszItemUuid;
497 /** Flag whether this is a user or system metadata item. */
498 bool fIsUser;
499 /** Flag whether this is a virtual disk or file metadata item. */
500 bool fIsVDisk;
501 /** Flag whether this metadata item is required to load the file. */
502 bool fIsRequired;
503 /** Metadata item enum associated with this UUID. */
504 VHDXMETADATAITEM enmMetadataItem;
505} VHDXMETADATAITEMPROPS;
506
507/**
508 * VHDX image data structure.
509 */
510typedef struct VHDXIMAGE
511{
512 /** Image name. */
513 const char *pszFilename;
514 /** Storage handle. */
515 PVDIOSTORAGE pStorage;
516
517 /** Pointer to the per-disk VD interface list. */
518 PVDINTERFACE pVDIfsDisk;
519 /** Pointer to the per-image VD interface list. */
520 PVDINTERFACE pVDIfsImage;
521 /** Error interface. */
522 PVDINTERFACEERROR pIfError;
523 /** I/O interface. */
524 PVDINTERFACEIOINT pIfIo;
525
526 /** Open flags passed by VBoxHD layer. */
527 unsigned uOpenFlags;
528 /** Image flags defined during creation or determined during open. */
529 unsigned uImageFlags;
530 /** Version of the VHDX image format. */
531 unsigned uVersion;
532 /** Total size of the image. */
533 uint64_t cbSize;
534 /** Logical sector size of the image. */
535 uint32_t cbLogicalSector;
536 /** Block size of the image. */
537 size_t cbBlock;
538 /** Physical geometry of this image. */
539 VDGEOMETRY PCHSGeometry;
540 /** Logical geometry of this image. */
541 VDGEOMETRY LCHSGeometry;
542
543 /** The BAT. */
544 PVhdxBatEntry paBat;
545 /** Chunk ratio. */
546 uint32_t uChunkRatio;
547
548} VHDXIMAGE, *PVHDXIMAGE;
549
550/**
551 * Endianess conversion direction.
552 */
553typedef enum VHDXECONV
554{
555 /** Host to file endianess. */
556 VHDXECONV_H2F = 0,
557 /** File to host endianess. */
558 VHDXECONV_F2H
559} VHDXECONV;
560
561/** Macros for endianess conversion. */
562#define SET_ENDIAN_U16(u16) (enmConv == VHDXECONV_H2F ? RT_H2LE_U16(u16) : RT_LE2H_U16(u16))
563#define SET_ENDIAN_U32(u32) (enmConv == VHDXECONV_H2F ? RT_H2LE_U32(u32) : RT_LE2H_U32(u32))
564#define SET_ENDIAN_U64(u64) (enmConv == VHDXECONV_H2F ? RT_H2LE_U64(u64) : RT_LE2H_U64(u64))
565
566/*******************************************************************************
567* Static Variables *
568*******************************************************************************/
569
570/**
571 * NULL-terminated array of supported file extensions.
572 */
573static const VDFILEEXTENSION s_aVhdxFileExtensions[] =
574{
575 {"vhdx", VDTYPE_HDD},
576 {NULL, VDTYPE_INVALID}
577};
578
579/**
580 * Static table to verify the metadata item properties and the flags.
581 */
582static const VHDXMETADATAITEMPROPS s_aVhdxMetadataItemProps[] =
583{
584 /* pcszItemUuid fIsUser, fIsVDisk, fIsRequired, enmMetadataItem */
585 {VHDX_METADATA_TBL_ENTRY_ITEM_FILE_PARAMS, false, false, true, VHDXMETADATAITEM_FILE_PARAMS},
586 {VHDX_METADATA_TBL_ENTRY_ITEM_VDISK_SIZE, false, true, true, VHDXMETADATAITEM_VDISK_SIZE},
587 {VHDX_METADATA_TBL_ENTRY_ITEM_PAGE83_DATA, false, true, true, VHDXMETADATAITEM_PAGE83_DATA},
588 {VHDX_METADATA_TBL_ENTRY_ITEM_LOG_SECT_SIZE, false, true, true, VHDXMETADATAITEM_LOGICAL_SECTOR_SIZE},
589 {VHDX_METADATA_TBL_ENTRY_ITEM_PHYS_SECT_SIZE, false, true, true, VHDXMETADATAITEM_PHYSICAL_SECTOR_SIZE},
590 {VHDX_METADATA_TBL_ENTRY_ITEM_PARENT_LOCATOR, false, false, true, VHDXMETADATAITEM_PARENT_LOCATOR}
591};
592
593/*******************************************************************************
594* Internal Functions *
595*******************************************************************************/
596
597/**
598 * Converts the file identifier between file and host endianness.
599 *
600 * @returns nothing.
601 * @param enmConv Direction of the conversion.
602 * @param pFileIdentifierConv Where to store the converted file identifier.
603 * @param pFileIdentifier The file identifier to convert.
604 *
605 * @note It is safe to use the same pointer for pFileIdentifierConv and pFileIdentifier.
606 */
607DECLINLINE(void) vhdxConvFileIdentifierEndianess(VHDXECONV enmConv, PVhdxFileIdentifier pFileIdentifierConv,
608 PVhdxFileIdentifier pFileIdentifier)
609{
610 pFileIdentifierConv->u64Signature = SET_ENDIAN_U64(pFileIdentifier->u64Signature);
611 for (unsigned i = 0; i < RT_ELEMENTS(pFileIdentifierConv->awszCreator); i++)
612 pFileIdentifierConv->awszCreator[i] = SET_ENDIAN_U16(pFileIdentifier->awszCreator[i]);
613}
614
615/**
616 * Converts a UUID between file and host endianness.
617 *
618 * @returns nothing.
619 * @param enmConv Direction of the conversion.
620 * @param pUuidConv Where to store the converted UUID.
621 * @param pUuid The UUID to convert.
622 *
623 * @note It is safe to use the same pointer for pUuidConv and pUuid.
624 */
625DECLINLINE(void) vhdxConvUuidEndianess(VHDXECONV enmConv, PRTUUID pUuidConv, PRTUUID pUuid)
626{
627#if 1
628 memcpy(pUuidConv, pUuid, sizeof(RTUUID));
629#else
630 pUuidConv->Gen.u32TimeLow = SET_ENDIAN_U32(pUuid->Gen.u32TimeLow);
631 pUuidConv->Gen.u16TimeMid = SET_ENDIAN_U16(pUuid->Gen.u16TimeMid);
632 pUuidConv->Gen.u16TimeHiAndVersion = SET_ENDIAN_U16(pUuid->Gen.u16TimeHiAndVersion);
633 pUuidConv->Gen.u8ClockSeqHiAndReserved = pUuid->Gen.u8ClockSeqHiAndReserved;
634 pUuidConv->Gen.u8ClockSeqLow = pUuid->Gen.u8ClockSeqLow;
635 for (unsigned i = 0; i < RT_ELEMENTS(pUuidConv->Gen.au8Node); i++)
636 pUuidConv->Gen.au8Node[i] = pUuid->Gen.au8Node[i];
637#endif
638}
639
640/**
641 * Converts a VHDX header between file and host endianness.
642 *
643 * @returns nothing.
644 * @param enmConv Direction of the conversion.
645 * @param pHdrConv Where to store the converted header.
646 * @param pHdr The VHDX header to convert.
647 *
648 * @note It is safe to use the same pointer for pHdrConv and pHdr.
649 */
650DECLINLINE(void) vhdxConvHeaderEndianess(VHDXECONV enmConv, PVhdxHeader pHdrConv, PVhdxHeader pHdr)
651{
652 pHdrConv->u32Signature = SET_ENDIAN_U32(pHdr->u32Signature);
653 pHdrConv->u32Checksum = SET_ENDIAN_U32(pHdr->u32Checksum);
654 pHdrConv->u64SequenceNumber = SET_ENDIAN_U64(pHdr->u64SequenceNumber);
655 vhdxConvUuidEndianess(enmConv, &pHdrConv->UuidFileWrite, &pHdrConv->UuidFileWrite);
656 vhdxConvUuidEndianess(enmConv, &pHdrConv->UuidDataWrite, &pHdrConv->UuidDataWrite);
657 vhdxConvUuidEndianess(enmConv, &pHdrConv->UuidLog, &pHdrConv->UuidLog);
658 pHdrConv->u16LogVersion = SET_ENDIAN_U16(pHdr->u16LogVersion);
659 pHdrConv->u16Version = SET_ENDIAN_U16(pHdr->u16Version);
660 pHdrConv->u32LogLength = SET_ENDIAN_U32(pHdr->u32LogLength);
661 pHdrConv->u64LogOffset = SET_ENDIAN_U64(pHdr->u64LogOffset);
662}
663
664/**
665 * Converts a VHDX region table header between file and host endianness.
666 *
667 * @returns nothing.
668 * @param enmConv Direction of the conversion.
669 * @param pRegTblHdrConv Where to store the converted header.
670 * @param pRegTblHdr The VHDX region table header to convert.
671 *
672 * @note It is safe to use the same pointer for pRegTblHdrConv and pRegTblHdr.
673 */
674DECLINLINE(void) vhdxConvRegionTblHdrEndianess(VHDXECONV enmConv, PVhdxRegionTblHdr pRegTblHdrConv,
675 PVhdxRegionTblHdr pRegTblHdr)
676{
677 pRegTblHdrConv->u32Signature = SET_ENDIAN_U32(pRegTblHdr->u32Signature);
678 pRegTblHdrConv->u32Checksum = SET_ENDIAN_U32(pRegTblHdr->u32Checksum);
679 pRegTblHdrConv->u32EntryCount = SET_ENDIAN_U32(pRegTblHdr->u32EntryCount);
680 pRegTblHdrConv->u32Reserved = SET_ENDIAN_U32(pRegTblHdr->u32Reserved);
681}
682
683/**
684 * Converts a VHDX region table entry between file and host endianness.
685 *
686 * @returns nothing.
687 * @param enmConv Direction of the conversion.
688 * @param pRegTblEntConv Where to store the converted region table entry.
689 * @param pRegTblEnt The VHDX region table entry to convert.
690 *
691 * @note It is safe to use the same pointer for pRegTblEntConv and pRegTblEnt.
692 */
693DECLINLINE(void) vhdxConvRegionTblEntryEndianess(VHDXECONV enmConv, PVhdxRegionTblEntry pRegTblEntConv,
694 PVhdxRegionTblEntry pRegTblEnt)
695{
696 vhdxConvUuidEndianess(enmConv, &pRegTblEntConv->UuidObject, &pRegTblEnt->UuidObject);
697 pRegTblEntConv->u64FileOffset = SET_ENDIAN_U64(pRegTblEnt->u64FileOffset);
698 pRegTblEntConv->u32Length = SET_ENDIAN_U32(pRegTblEnt->u32Length);
699 pRegTblEntConv->u32Flags = SET_ENDIAN_U32(pRegTblEnt->u32Flags);
700}
701
702/**
703 * Converts a VHDX log entry header between file and host endianness.
704 *
705 * @returns nothing.
706 * @param enmConv Direction of the conversion.
707 * @param pLogEntryHdrConv Where to store the converted log entry header.
708 * @param pLogEntryHdr The VHDX log entry header to convert.
709 *
710 * @note It is safe to use the same pointer for pLogEntryHdrConv and pLogEntryHdr.
711 */
712DECLINLINE(void) vhdxConvLogEntryHdrEndianess(VHDXECONV enmConv, PVhdxLogEntryHdr pLogEntryHdrConv,
713 PVhdxLogEntryHdr pLogEntryHdr)
714{
715 pLogEntryHdrConv->u32Signature = SET_ENDIAN_U32(pLogEntryHdr->u32Signature);
716 pLogEntryHdrConv->u32Checksum = SET_ENDIAN_U32(pLogEntryHdr->u32Checksum);
717 pLogEntryHdrConv->u32EntryLength = SET_ENDIAN_U32(pLogEntryHdr->u32EntryLength);
718 pLogEntryHdrConv->u32Tail = SET_ENDIAN_U32(pLogEntryHdr->u32Tail);
719 pLogEntryHdrConv->u64SequenceNumber = SET_ENDIAN_U64(pLogEntryHdr->u64SequenceNumber);
720 pLogEntryHdrConv->u32DescriptorCount = SET_ENDIAN_U32(pLogEntryHdr->u32DescriptorCount);
721 pLogEntryHdrConv->u32Reserved = SET_ENDIAN_U32(pLogEntryHdr->u32Reserved);
722 vhdxConvUuidEndianess(enmConv, &pLogEntryHdrConv->UuidLog, &pLogEntryHdr->UuidLog);
723 pLogEntryHdrConv->u64FlushedFileOffset = SET_ENDIAN_U64(pLogEntryHdr->u64FlushedFileOffset);
724}
725
726/**
727 * Converts a VHDX log zero descriptor between file and host endianness.
728 *
729 * @returns nothing.
730 * @param enmConv Direction of the conversion.
731 * @param pLogZeroDescConv Where to store the converted log zero descriptor.
732 * @param pLogZeroDesc The VHDX log zero descriptor to convert.
733 *
734 * @note It is safe to use the same pointer for pLogZeroDescConv and pLogZeroDesc.
735 */
736DECLINLINE(void) vhdxConvLogZeroDescEndianess(VHDXECONV enmConv, PVhdxLogZeroDesc pLogZeroDescConv,
737 PVhdxLogZeroDesc pLogZeroDesc)
738{
739 pLogZeroDescConv->u32ZeroSignature = SET_ENDIAN_U32(pLogZeroDesc->u32ZeroSignature);
740 pLogZeroDescConv->u32Reserved = SET_ENDIAN_U32(pLogZeroDesc->u32Reserved);
741 pLogZeroDescConv->u64ZeroLength = SET_ENDIAN_U64(pLogZeroDesc->u64ZeroLength);
742 pLogZeroDescConv->u64FileOffset = SET_ENDIAN_U64(pLogZeroDesc->u64FileOffset);
743 pLogZeroDescConv->u64SequenceNumber = SET_ENDIAN_U64(pLogZeroDesc->u64SequenceNumber);
744}
745
746/**
747 * Converts a VHDX log data descriptor between file and host endianness.
748 *
749 * @returns nothing.
750 * @param enmConv Direction of the conversion.
751 * @param pLogDataDescConv Where to store the converted log data descriptor.
752 * @param pLogDataDesc The VHDX log data descriptor to convert.
753 *
754 * @note It is safe to use the same pointer for pLogDataDescConv and pLogDataDesc.
755 */
756DECLINLINE(void) vhdxConvLogDataDescEndianess(VHDXECONV enmConv, PVhdxLogDataDesc pLogDataDescConv,
757 PVhdxLogDataDesc pLogDataDesc)
758{
759 pLogDataDescConv->u32DataSignature = SET_ENDIAN_U32(pLogDataDesc->u32DataSignature);
760 pLogDataDescConv->u32TrailingBytes = SET_ENDIAN_U32(pLogDataDesc->u32TrailingBytes);
761 pLogDataDescConv->u64LeadingBytes = SET_ENDIAN_U64(pLogDataDesc->u64LeadingBytes);
762 pLogDataDescConv->u64FileOffset = SET_ENDIAN_U64(pLogDataDesc->u64FileOffset);
763 pLogDataDescConv->u64SequenceNumber = SET_ENDIAN_U64(pLogDataDesc->u64SequenceNumber);
764}
765
766/**
767 * Converts a VHDX log data sector between file and host endianness.
768 *
769 * @returns nothing.
770 * @param enmConv Direction of the conversion.
771 * @param pLogDataSectorConv Where to store the converted log data sector.
772 * @param pLogDataSector The VHDX log data sector to convert.
773 *
774 * @note It is safe to use the same pointer for pLogDataSectorConv and pLogDataSector.
775 */
776DECLINLINE(void) vhdxConvLogDataSectorEndianess(VHDXECONV enmConv, PVhdxLogDataSector pLogDataSectorConv,
777 PVhdxLogDataSector pLogDataSector)
778{
779 pLogDataSectorConv->u32DataSignature = SET_ENDIAN_U32(pLogDataSector->u32DataSignature);
780 pLogDataSectorConv->u32SequenceHigh = SET_ENDIAN_U32(pLogDataSector->u32SequenceHigh);
781 pLogDataSectorConv->u32SequenceLow = SET_ENDIAN_U32(pLogDataSector->u32SequenceLow);
782}
783
784/**
785 * Converts a BAT between file and host endianess.
786 *
787 * @returns nothing.
788 * @param enmConv Direction of the conversion.
789 * @param paBatEntriesConv Where to store the converted BAT.
790 * @param paBatEntries The VHDX BAT to convert.
791 *
792 * @note It is safe to use the same pointer for paBatEntriesConv and paBatEntries.
793 */
794DECLINLINE(void) vhdxConvBatTableEndianess(VHDXECONV enmConv, PVhdxBatEntry paBatEntriesConv,
795 PVhdxBatEntry paBatEntries, uint32_t cBatEntries)
796{
797 for (uint32_t i = 0; i < cBatEntries; i++)
798 paBatEntriesConv[i].u64BatEntry = SET_ENDIAN_U64(paBatEntries[i].u64BatEntry);
799}
800
801/**
802 * Converts a VHDX metadata table header between file and host endianness.
803 *
804 * @returns nothing.
805 * @param enmConv Direction of the conversion.
806 * @param pMetadataTblHdrConv Where to store the converted metadata table header.
807 * @param pMetadataTblHdr The VHDX metadata table header to convert.
808 *
809 * @note It is safe to use the same pointer for pMetadataTblHdrConv and pMetadataTblHdr.
810 */
811DECLINLINE(void) vhdxConvMetadataTblHdrEndianess(VHDXECONV enmConv, PVhdxMetadataTblHdr pMetadataTblHdrConv,
812 PVhdxMetadataTblHdr pMetadataTblHdr)
813{
814 pMetadataTblHdrConv->u64Signature = SET_ENDIAN_U64(pMetadataTblHdr->u64Signature);
815 pMetadataTblHdrConv->u16Reserved = SET_ENDIAN_U16(pMetadataTblHdr->u16Reserved);
816 pMetadataTblHdrConv->u16EntryCount = SET_ENDIAN_U16(pMetadataTblHdr->u16EntryCount);
817 for (unsigned i = 0; i < RT_ELEMENTS(pMetadataTblHdr->u32Reserved2); i++)
818 pMetadataTblHdrConv->u32Reserved2[i] = SET_ENDIAN_U32(pMetadataTblHdr->u32Reserved2[i]);
819}
820
821/**
822 * Converts a VHDX metadata table entry between file and host endianness.
823 *
824 * @returns nothing.
825 * @param enmConv Direction of the conversion.
826 * @param pMetadataTblEntryConv Where to store the converted metadata table entry.
827 * @param pMetadataTblEntry The VHDX metadata table entry to convert.
828 *
829 * @note It is safe to use the same pointer for pMetadataTblEntryConv and pMetadataTblEntry.
830 */
831DECLINLINE(void) vhdxConvMetadataTblEntryEndianess(VHDXECONV enmConv, PVhdxMetadataTblEntry pMetadataTblEntryConv,
832 PVhdxMetadataTblEntry pMetadataTblEntry)
833{
834 vhdxConvUuidEndianess(enmConv, &pMetadataTblEntryConv->UuidItem, &pMetadataTblEntry->UuidItem);
835 pMetadataTblEntryConv->u32Offset = SET_ENDIAN_U32(pMetadataTblEntry->u32Offset);
836 pMetadataTblEntryConv->u32Length = SET_ENDIAN_U32(pMetadataTblEntry->u32Length);
837 pMetadataTblEntryConv->u32Flags = SET_ENDIAN_U32(pMetadataTblEntry->u32Flags);
838 pMetadataTblEntryConv->u32Reserved = SET_ENDIAN_U32(pMetadataTblEntry->u32Reserved);
839}
840
841/**
842 * Converts a VHDX file parameters item between file and host endianness.
843 *
844 * @returns nothing.
845 * @param enmConv Direction of the conversion.
846 * @param pFileParamsConv Where to store the converted file parameters item entry.
847 * @param pFileParams The VHDX file parameters item to convert.
848 *
849 * @note It is safe to use the same pointer for pFileParamsConv and pFileParams.
850 */
851DECLINLINE(void) vhdxConvFileParamsEndianess(VHDXECONV enmConv, PVhdxFileParameters pFileParamsConv,
852 PVhdxFileParameters pFileParams)
853{
854 pFileParamsConv->u32BlockSize = SET_ENDIAN_U32(pFileParams->u32BlockSize);
855 pFileParamsConv->u32Flags = SET_ENDIAN_U32(pFileParams->u32Flags);
856}
857
858/**
859 * Converts a VHDX virtual disk size item between file and host endianness.
860 *
861 * @returns nothing.
862 * @param enmConv Direction of the conversion.
863 * @param pVDiskSizeConv Where to store the converted virtual disk size item entry.
864 * @param pVDiskSize The VHDX virtual disk size item to convert.
865 *
866 * @note It is safe to use the same pointer for pVDiskSizeConv and pVDiskSize.
867 */
868DECLINLINE(void) vhdxConvVDiskSizeEndianess(VHDXECONV enmConv, PVhdxVDiskSize pVDiskSizeConv,
869 PVhdxVDiskSize pVDiskSize)
870{
871 pVDiskSizeConv->u64VDiskSize = SET_ENDIAN_U64(pVDiskSize->u64VDiskSize);
872}
873
874/**
875 * Converts a VHDX page 83 data item between file and host endianness.
876 *
877 * @returns nothing.
878 * @param enmConv Direction of the conversion.
879 * @param pPage83DataConv Where to store the converted page 83 data item entry.
880 * @param pPage83Data The VHDX page 83 data item to convert.
881 *
882 * @note It is safe to use the same pointer for pPage83DataConv and pPage83Data.
883 */
884DECLINLINE(void) vhdxConvPage83DataEndianess(VHDXECONV enmConv, PVhdxPage83Data pPage83DataConv,
885 PVhdxPage83Data pPage83Data)
886{
887 vhdxConvUuidEndianess(enmConv, &pPage83DataConv->UuidPage83Data, &pPage83Data->UuidPage83Data);
888}
889
890/**
891 * Converts a VHDX logical sector size item between file and host endianness.
892 *
893 * @returns nothing.
894 * @param enmConv Direction of the conversion.
895 * @param pVDiskLogSectSizeConv Where to store the converted logical sector size item entry.
896 * @param pVDiskLogSectSize The VHDX logical sector size item to convert.
897 *
898 * @note It is safe to use the same pointer for pVDiskLogSectSizeConv and pVDiskLogSectSize.
899 */
900DECLINLINE(void) vhdxConvVDiskLogSectSizeEndianess(VHDXECONV enmConv, PVhdxVDiskLogicalSectorSize pVDiskLogSectSizeConv,
901 PVhdxVDiskLogicalSectorSize pVDiskLogSectSize)
902{
903 pVDiskLogSectSizeConv->u32LogicalSectorSize = SET_ENDIAN_U32(pVDiskLogSectSize->u32LogicalSectorSize);
904}
905
906/**
907 * Converts a VHDX physical sector size item between file and host endianness.
908 *
909 * @returns nothing.
910 * @param enmConv Direction of the conversion.
911 * @param pVDiskPhysSectSizeConv Where to store the converted physical sector size item entry.
912 * @param pVDiskPhysSectSize The VHDX physical sector size item to convert.
913 *
914 * @note It is safe to use the same pointer for pVDiskPhysSectSizeConv and pVDiskPhysSectSize.
915 */
916DECLINLINE(void) vhdxConvVDiskPhysSectSizeEndianess(VHDXECONV enmConv, PVhdxVDiskPhysicalSectorSize pVDiskPhysSectSizeConv,
917 PVhdxVDiskPhysicalSectorSize pVDiskPhysSectSize)
918{
919 pVDiskPhysSectSizeConv->u64PhysicalSectorSize = SET_ENDIAN_U64(pVDiskPhysSectSize->u64PhysicalSectorSize);
920}
921
922/**
923 * Converts a VHDX parent locator header item between file and host endianness.
924 *
925 * @returns nothing.
926 * @param enmConv Direction of the conversion.
927 * @param pParentLocatorHdrConv Where to store the converted parent locator header item entry.
928 * @param pParentLocatorHdr The VHDX parent locator header item to convert.
929 *
930 * @note It is safe to use the same pointer for pParentLocatorHdrConv and pParentLocatorHdr.
931 */
932DECLINLINE(void) vhdxConvParentLocatorHeaderEndianness(VHDXECONV enmConv, PVhdxParentLocatorHeader pParentLocatorHdrConv,
933 PVhdxParentLocatorHeader pParentLocatorHdr)
934{
935 vhdxConvUuidEndianess(enmConv, &pParentLocatorHdrConv->UuidLocatorType, &pParentLocatorHdr->UuidLocatorType);
936 pParentLocatorHdrConv->u16Reserved = SET_ENDIAN_U16(pParentLocatorHdr->u16Reserved);
937 pParentLocatorHdrConv->u16KeyValueCount = SET_ENDIAN_U16(pParentLocatorHdr->u16KeyValueCount);
938}
939
940/**
941 * Converts a VHDX parent locator entry between file and host endianness.
942 *
943 * @returns nothing.
944 * @param enmConv Direction of the conversion.
945 * @param pParentLocatorEntryConv Where to store the converted parent locator entry.
946 * @param pParentLocatorEntry The VHDX parent locator entry to convert.
947 *
948 * @note It is safe to use the same pointer for pParentLocatorEntryConv and pParentLocatorEntry.
949 */
950DECLINLINE(void) vhdxConvParentLocatorEntryEndianess(VHDXECONV enmConv, PVhdxParentLocatorEntry pParentLocatorEntryConv,
951 PVhdxParentLocatorEntry pParentLocatorEntry)
952{
953 pParentLocatorEntryConv->u32KeyOffset = SET_ENDIAN_U32(pParentLocatorEntry->u32KeyOffset);
954 pParentLocatorEntryConv->u32ValueOffset = SET_ENDIAN_U32(pParentLocatorEntry->u32ValueOffset);
955 pParentLocatorEntryConv->u16KeyLength = SET_ENDIAN_U16(pParentLocatorEntry->u16KeyLength);
956 pParentLocatorEntryConv->u16ValueLength = SET_ENDIAN_U16(pParentLocatorEntry->u16ValueLength);
957}
958
959/**
960 * Internal. Free all allocated space for representing an image except pImage,
961 * and optionally delete the image from disk.
962 */
963static int vhdxFreeImage(PVHDXIMAGE pImage, bool fDelete)
964{
965 int rc = VINF_SUCCESS;
966
967 /* Freeing a never allocated image (e.g. because the open failed) is
968 * not signalled as an error. After all nothing bad happens. */
969 if (pImage)
970 {
971 if (pImage->pStorage)
972 {
973 rc = vdIfIoIntFileClose(pImage->pIfIo, pImage->pStorage);
974 pImage->pStorage = NULL;
975 }
976
977 if (pImage->paBat)
978 {
979 RTMemFree(pImage->paBat);
980 pImage->paBat = NULL;
981 }
982
983 if (fDelete && pImage->pszFilename)
984 vdIfIoIntFileDelete(pImage->pIfIo, pImage->pszFilename);
985 }
986
987 LogFlowFunc(("returns %Rrc\n", rc));
988 return rc;
989}
990
991/**
992 * Loads all required fields from the given VHDX header.
993 * The header must be converted to the host endianess and validated already.
994 *
995 * @returns VBox status code.
996 * @param pImage Image instance data.
997 * @param pHdr The header to load.
998 */
999static int vhdxLoadHeader(PVHDXIMAGE pImage, PVhdxHeader pHdr)
1000{
1001 int rc = VINF_SUCCESS;
1002
1003 LogFlowFunc(("pImage=%#p pHdr=%#p\n", pImage, pHdr));
1004
1005 /*
1006 * Most fields in the header are not required because the backend implements
1007 * readonly access only so far.
1008 * We just have to check that the log is empty, we have to refuse to load the
1009 * image otherwsie because replaying the log is not implemented.
1010 */
1011 if (pHdr->u16Version == VHDX_HEADER_VHDX_VERSION)
1012 {
1013 /* Check that the log UUID is zero. */
1014 pImage->uVersion = pHdr->u16Version;
1015 if (!RTUuidIsNull(&pHdr->UuidLog))
1016 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1017 "VHDX: Image \'%s\' has a non empty log which is not supported",
1018 pImage->pszFilename);
1019 }
1020 else
1021 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1022 "VHDX: Image \'%s\' uses an unsupported version (%u) of the VHDX format",
1023 pImage->pszFilename, pHdr->u16Version);
1024
1025 LogFlowFunc(("return rc=%Rrc\n", rc));
1026 return rc;
1027}
1028
1029/**
1030 * Determines the current header and loads it.
1031 *
1032 * @returns VBox status code.
1033 * @param pImage Image instance data.
1034 */
1035static int vhdxFindAndLoadCurrentHeader(PVHDXIMAGE pImage)
1036{
1037 PVhdxHeader pHdr1, pHdr2;
1038 uint32_t u32ChkSum = 0;
1039 uint32_t u32ChkSumSaved = 0;
1040 bool fHdr1Valid = false;
1041 bool fHdr2Valid = false;
1042 int rc = VINF_SUCCESS;
1043
1044 LogFlowFunc(("pImage=%#p\n", pImage));
1045
1046 /*
1047 * The VHDX format defines two headers at different offsets to provide failure
1048 * consistency. Only one header is current. This can be determined using the
1049 * sequence number and checksum fields in the header.
1050 */
1051 pHdr1 = (PVhdxHeader)RTMemAllocZ(sizeof(VhdxHeader));
1052 pHdr2 = (PVhdxHeader)RTMemAllocZ(sizeof(VhdxHeader));
1053
1054 if (pHdr1 && pHdr2)
1055 {
1056 /* Read the first header. */
1057 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_HEADER1_OFFSET,
1058 pHdr1, sizeof(*pHdr1));
1059 if (RT_SUCCESS(rc))
1060 {
1061 vhdxConvHeaderEndianess(VHDXECONV_F2H, pHdr1, pHdr1);
1062
1063 /* Validate checksum. */
1064 u32ChkSumSaved = pHdr1->u32Checksum;
1065 pHdr1->u32Checksum = 0;
1066 //u32ChkSum = RTCrc32C(pHdr1, RT_OFFSETOF(VhdxHeader, u8Reserved[502]));
1067
1068 if ( pHdr1->u32Signature == VHDX_HEADER_SIGNATURE
1069 /*&& u32ChkSum == u32ChkSumSaved*/)
1070 fHdr1Valid = true;
1071 }
1072
1073 /* Try to read the second header in any case (even if reading the first failed). */
1074 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_HEADER2_OFFSET,
1075 pHdr2, sizeof(*pHdr2));
1076 if (RT_SUCCESS(rc))
1077 {
1078 vhdxConvHeaderEndianess(VHDXECONV_F2H, pHdr2, pHdr2);
1079
1080 /* Validate checksum. */
1081 u32ChkSumSaved = pHdr2->u32Checksum;
1082 pHdr2->u32Checksum = 0;
1083 //u32ChkSum = RTCrc32C(pHdr2, RT_OFFSETOF(VhdxHeader, u8Reserved[502]));
1084
1085 if ( pHdr2->u32Signature == VHDX_HEADER_SIGNATURE
1086 /*&& u32ChkSum == u32ChkSumSaved*/)
1087 fHdr2Valid = true;
1088 }
1089
1090 /* Determine the current header. */
1091 if (fHdr1Valid != fHdr2Valid)
1092 {
1093 /* Only one header is valid - use it. */
1094 rc = vhdxLoadHeader(pImage, fHdr1Valid ? pHdr1 : pHdr2);
1095 }
1096 else if (!fHdr1Valid && !fHdr2Valid)
1097 {
1098 /* Crap, both headers are corrupt, refuse to load the image. */
1099 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1100 "VHDX: Can not load the image because both headers are corrupt");
1101 }
1102 else
1103 {
1104 /* Both headers are valid. Use the sequence number to find the current one. */
1105 if (pHdr1->u64SequenceNumber > pHdr2->u64SequenceNumber)
1106 rc = vhdxLoadHeader(pImage, pHdr1);
1107 else
1108 rc = vhdxLoadHeader(pImage, pHdr2);
1109 }
1110 }
1111 else
1112 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
1113 "VHDX: Out of memory while allocating memory for the header");
1114
1115 if (pHdr1)
1116 RTMemFree(pHdr1);
1117 if (pHdr2)
1118 RTMemFree(pHdr2);
1119
1120 LogFlowFunc(("returns rc=%Rrc\n", rc));
1121 return rc;
1122}
1123
1124/**
1125 * Loads the BAT region.
1126 *
1127 * @returns VBox status code.
1128 * @param pImage Image instance data.
1129 * @param offRegion Start offset of the region.
1130 * @param cbRegion Size of the region.
1131 */
1132static int vhdxLoadBatRegion(PVHDXIMAGE pImage, uint64_t offRegion,
1133 size_t cbRegion)
1134{
1135 int rc = VINF_SUCCESS;
1136 uint32_t cDataBlocks;
1137 uint32_t uChunkRatio;
1138 uint32_t cSectorBitmapBlocks;
1139 uint32_t cBatEntries;
1140 uint32_t cbBatEntries;
1141 PVhdxBatEntry paBatEntries = NULL;
1142
1143 LogFlowFunc(("pImage=%#p\n", pImage));
1144
1145 /* Calculate required values first. */
1146 uint64_t uChunkRatio64 = (RT_BIT_64(23) * pImage->cbLogicalSector) / pImage->cbBlock;
1147 uChunkRatio = (uint32_t)uChunkRatio64; Assert(uChunkRatio == uChunkRatio64);
1148 uint64_t cDataBlocks64 = pImage->cbSize / pImage->cbBlock;
1149 cDataBlocks = (uint32_t)cDataBlocks64; Assert(cDataBlocks == cDataBlocks64);
1150
1151 if (pImage->cbSize % pImage->cbBlock)
1152 cDataBlocks++;
1153
1154 cSectorBitmapBlocks = cDataBlocks / uChunkRatio;
1155 if (cDataBlocks % uChunkRatio)
1156 cSectorBitmapBlocks++;
1157
1158 cBatEntries = cDataBlocks + (cDataBlocks - 1)/uChunkRatio;
1159 cbBatEntries = cBatEntries * sizeof(VhdxBatEntry);
1160
1161 if (cbBatEntries <= cbRegion)
1162 {
1163 /*
1164 * Load the complete BAT region first, convert to host endianess and process
1165 * it afterwards. The SB entries can be removed because they are not needed yet.
1166 */
1167 paBatEntries = (PVhdxBatEntry)RTMemAlloc(cbBatEntries);
1168 if (paBatEntries)
1169 {
1170 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offRegion,
1171 paBatEntries, cbBatEntries);
1172 if (RT_SUCCESS(rc))
1173 {
1174 vhdxConvBatTableEndianess(VHDXECONV_F2H, paBatEntries, paBatEntries,
1175 cBatEntries);
1176
1177 /* Go through the table and validate it. */
1178 for (unsigned i = 0; i < cBatEntries; i++)
1179 {
1180 if ( i != 0
1181 && (i % uChunkRatio) == 0)
1182 {
1183/**
1184 * Disabled the verification because there are images out there with the sector bitmap
1185 * marked as present. The entry is never accessed and the image is readonly anyway,
1186 * so no harm done.
1187 */
1188#if 0
1189 /* Sector bitmap block. */
1190 if ( VHDX_BAT_ENTRY_GET_STATE(paBatEntries[i].u64BatEntry)
1191 != VHDX_BAT_ENTRY_SB_BLOCK_NOT_PRESENT)
1192 {
1193 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1194 "VHDX: Sector bitmap block at entry %u of image \'%s\' marked as present, violation of the specification",
1195 i, pImage->pszFilename);
1196 break;
1197 }
1198#endif
1199 }
1200 else
1201 {
1202 /* Payload block. */
1203 if ( VHDX_BAT_ENTRY_GET_STATE(paBatEntries[i].u64BatEntry)
1204 == VHDX_BAT_ENTRY_PAYLOAD_BLOCK_PARTIALLY_PRESENT)
1205 {
1206 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1207 "VHDX: Payload block at entry %u of image \'%s\' marked as partially present, violation of the specification",
1208 i, pImage->pszFilename);
1209 break;
1210 }
1211 }
1212 }
1213
1214 if (RT_SUCCESS(rc))
1215 {
1216 pImage->paBat = paBatEntries;
1217 pImage->uChunkRatio = uChunkRatio;
1218 }
1219 }
1220 else
1221 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1222 "VHDX: Error reading the BAT from image \'%s\'",
1223 pImage->pszFilename);
1224 }
1225 else
1226 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
1227 "VHDX: Out of memory allocating memory for %u BAT entries of image \'%s\'",
1228 cBatEntries);
1229 }
1230 else
1231 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1232 "VHDX: Mismatch between calculated number of BAT entries and region size (expected %u got %u) for image \'%s\'",
1233 cbBatEntries, cbRegion, pImage->pszFilename);
1234
1235 if ( RT_FAILURE(rc)
1236 && paBatEntries)
1237 RTMemFree(paBatEntries);
1238
1239 LogFlowFunc(("returns rc=%Rrc\n", rc));
1240 return rc;
1241}
1242
1243/**
1244 * Load the file parameters metadata item from the file.
1245 *
1246 * @returns VBox status code.
1247 * @param pImage Image instance data.
1248 * @param offItem File offset where the data is stored.
1249 * @param cbItem Size of the item in the file.
1250 */
1251static int vhdxLoadFileParametersMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
1252{
1253 int rc = VINF_SUCCESS;
1254
1255 LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
1256
1257 if (cbItem != sizeof(VhdxFileParameters))
1258 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1259 "VHDX: File parameters item size mismatch (expected %u got %zu) in image \'%s\'",
1260 sizeof(VhdxFileParameters), cbItem, pImage->pszFilename);
1261 else
1262 {
1263 VhdxFileParameters FileParameters;
1264
1265 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
1266 &FileParameters, sizeof(FileParameters));
1267 if (RT_SUCCESS(rc))
1268 {
1269 vhdxConvFileParamsEndianess(VHDXECONV_F2H, &FileParameters, &FileParameters);
1270 pImage->cbBlock = FileParameters.u32BlockSize;
1271
1272 /* @todo: No support for differencing images yet. */
1273 if (FileParameters.u32Flags & VHDX_FILE_PARAMETERS_FLAGS_HAS_PARENT)
1274 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1275 "VHDX: Image \'%s\' is a differencing image which is not supported yet",
1276 pImage->pszFilename);
1277 }
1278 else
1279 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1280 "VHDX: Reading the file parameters metadata item from image \'%s\' failed",
1281 pImage->pszFilename);
1282 }
1283
1284 LogFlowFunc(("returns rc=%Rrc\n", rc));
1285 return rc;
1286}
1287
1288/**
1289 * Load the virtual disk size metadata item from the file.
1290 *
1291 * @returns VBox status code.
1292 * @param pImage Image instance data.
1293 * @param offItem File offset where the data is stored.
1294 * @param cbItem Size of the item in the file.
1295 */
1296static int vhdxLoadVDiskSizeMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
1297{
1298 int rc = VINF_SUCCESS;
1299
1300 LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
1301
1302 if (cbItem != sizeof(VhdxVDiskSize))
1303 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1304 "VHDX: Virtual disk size item size mismatch (expected %u got %zu) in image \'%s\'",
1305 sizeof(VhdxVDiskSize), cbItem, pImage->pszFilename);
1306 else
1307 {
1308 VhdxVDiskSize VDiskSize;
1309
1310 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
1311 &VDiskSize, sizeof(VDiskSize));
1312 if (RT_SUCCESS(rc))
1313 {
1314 vhdxConvVDiskSizeEndianess(VHDXECONV_F2H, &VDiskSize, &VDiskSize);
1315 pImage->cbSize = VDiskSize.u64VDiskSize;
1316 }
1317 else
1318 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1319 "VHDX: Reading the virtual disk size metadata item from image \'%s\' failed",
1320 pImage->pszFilename);
1321 }
1322
1323 LogFlowFunc(("returns rc=%Rrc\n", rc));
1324 return rc;
1325}
1326
1327/**
1328 * Load the logical sector size metadata item from the file.
1329 *
1330 * @returns VBox status code.
1331 * @param pImage Image instance data.
1332 * @param offItem File offset where the data is stored.
1333 * @param cbItem Size of the item in the file.
1334 */
1335static int vhdxLoadVDiskLogSectorSizeMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
1336{
1337 int rc = VINF_SUCCESS;
1338
1339 LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
1340
1341 if (cbItem != sizeof(VhdxVDiskLogicalSectorSize))
1342 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1343 "VHDX: Virtual disk logical sector size item size mismatch (expected %u got %zu) in image \'%s\'",
1344 sizeof(VhdxVDiskLogicalSectorSize), cbItem, pImage->pszFilename);
1345 else
1346 {
1347 VhdxVDiskLogicalSectorSize VDiskLogSectSize;
1348
1349 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
1350 &VDiskLogSectSize, sizeof(VDiskLogSectSize));
1351 if (RT_SUCCESS(rc))
1352 {
1353 vhdxConvVDiskLogSectSizeEndianess(VHDXECONV_F2H, &VDiskLogSectSize,
1354 &VDiskLogSectSize);
1355 pImage->cbLogicalSector = VDiskLogSectSize.u32LogicalSectorSize;
1356 }
1357 else
1358 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1359 "VHDX: Reading the virtual disk logical sector size metadata item from image \'%s\' failed",
1360 pImage->pszFilename);
1361 }
1362
1363 LogFlowFunc(("returns rc=%Rrc\n", rc));
1364 return rc;
1365}
1366
1367/**
1368 * Loads the metadata region.
1369 *
1370 * @returns VBox status code.
1371 * @param pImage Image instance data.
1372 * @param offRegion Start offset of the region.
1373 * @param cbRegion Size of the region.
1374 */
1375static int vhdxLoadMetadataRegion(PVHDXIMAGE pImage, uint64_t offRegion,
1376 size_t cbRegion)
1377{
1378 VhdxMetadataTblHdr MetadataTblHdr;
1379 int rc = VINF_SUCCESS;
1380
1381 LogFlowFunc(("pImage=%#p\n", pImage));
1382
1383 /* Load the header first. */
1384 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offRegion,
1385 &MetadataTblHdr, sizeof(MetadataTblHdr));
1386 if (RT_SUCCESS(rc))
1387 {
1388 vhdxConvMetadataTblHdrEndianess(VHDXECONV_F2H, &MetadataTblHdr, &MetadataTblHdr);
1389
1390 /* Validate structure. */
1391 if (MetadataTblHdr.u64Signature != VHDX_METADATA_TBL_HDR_SIGNATURE)
1392 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1393 "VHDX: Incorrect metadata table header signature for image \'%s\'",
1394 pImage->pszFilename);
1395 else if (MetadataTblHdr.u16EntryCount > VHDX_METADATA_TBL_HDR_ENTRY_COUNT_MAX)
1396 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1397 "VHDX: Incorrect entry count in metadata table header of image \'%s\'",
1398 pImage->pszFilename);
1399 else if (cbRegion < (MetadataTblHdr.u16EntryCount * sizeof(VhdxMetadataTblEntry) + sizeof(VhdxMetadataTblHdr)))
1400 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1401 "VHDX: Metadata table of image \'%s\' exceeds region size",
1402 pImage->pszFilename);
1403
1404 if (RT_SUCCESS(rc))
1405 {
1406 uint64_t offMetadataTblEntry = offRegion + sizeof(VhdxMetadataTblHdr);
1407
1408 for (unsigned i = 0; i < MetadataTblHdr.u16EntryCount; i++)
1409 {
1410 uint64_t offMetadataItem = 0;
1411 VHDXMETADATAITEM enmMetadataItem = VHDXMETADATAITEM_UNKNOWN;
1412 VhdxMetadataTblEntry MetadataTblEntry;
1413
1414 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offMetadataTblEntry,
1415 &MetadataTblEntry, sizeof(MetadataTblEntry));
1416 if (RT_FAILURE(rc))
1417 {
1418 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1419 "VHDX: Reading metadata table entry from image \'%s\' failed",
1420 pImage->pszFilename);
1421 break;
1422 }
1423
1424 vhdxConvMetadataTblEntryEndianess(VHDXECONV_F2H, &MetadataTblEntry, &MetadataTblEntry);
1425
1426 /* Check whether the flags match the expectations. */
1427 for (unsigned idxProp = 0; idxProp < RT_ELEMENTS(s_aVhdxMetadataItemProps); idxProp++)
1428 {
1429 if (!RTUuidCompareStr(&MetadataTblEntry.UuidItem,
1430 s_aVhdxMetadataItemProps[idxProp].pszItemUuid))
1431 {
1432 /*
1433 * Check for specification violations and bail out, except
1434 * for the required flag of the physical sector size metadata item.
1435 * Early images had the required flag not set opposed to the specification.
1436 * We don't want to brerak those images.
1437 */
1438 if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_USER)
1439 != s_aVhdxMetadataItemProps[idxProp].fIsUser)
1440 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1441 "VHDX: User flag of metadata item does not meet expectations \'%s\'",
1442 pImage->pszFilename);
1443 else if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_VDISK)
1444 != s_aVhdxMetadataItemProps[idxProp].fIsVDisk)
1445 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1446 "VHDX: Virtual disk flag of metadata item does not meet expectations \'%s\'",
1447 pImage->pszFilename);
1448 else if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED)
1449 != s_aVhdxMetadataItemProps[idxProp].fIsRequired
1450 && (s_aVhdxMetadataItemProps[idxProp].enmMetadataItem != VHDXMETADATAITEM_PHYSICAL_SECTOR_SIZE))
1451 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1452 "VHDX: Required flag of metadata item does not meet expectations \'%s\'",
1453 pImage->pszFilename);
1454 else
1455 enmMetadataItem = s_aVhdxMetadataItemProps[idxProp].enmMetadataItem;
1456
1457 break;
1458 }
1459 }
1460
1461 if (RT_FAILURE(rc))
1462 break;
1463
1464 offMetadataItem = offRegion + MetadataTblEntry.u32Offset;
1465
1466 switch (enmMetadataItem)
1467 {
1468 case VHDXMETADATAITEM_FILE_PARAMS:
1469 {
1470 rc = vhdxLoadFileParametersMetadata(pImage, offMetadataItem,
1471 MetadataTblEntry.u32Length);
1472 break;
1473 }
1474 case VHDXMETADATAITEM_VDISK_SIZE:
1475 {
1476 rc = vhdxLoadVDiskSizeMetadata(pImage, offMetadataItem,
1477 MetadataTblEntry.u32Length);
1478 break;
1479 }
1480 case VHDXMETADATAITEM_PAGE83_DATA:
1481 {
1482 /*
1483 * Nothing to do here for now (marked as required but
1484 * there is no API to pass this information to the caller)
1485 * so far.
1486 */
1487 break;
1488 }
1489 case VHDXMETADATAITEM_LOGICAL_SECTOR_SIZE:
1490 {
1491 rc = vhdxLoadVDiskLogSectorSizeMetadata(pImage, offMetadataItem,
1492 MetadataTblEntry.u32Length);
1493 break;
1494 }
1495 case VHDXMETADATAITEM_PHYSICAL_SECTOR_SIZE:
1496 {
1497 /*
1498 * Nothing to do here for now (marked as required but
1499 * there is no API to pass this information to the caller)
1500 * so far.
1501 */
1502 break;
1503 }
1504 case VHDXMETADATAITEM_PARENT_LOCATOR:
1505 {
1506 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1507 "VHDX: Image \'%s\' is a differencing image which is not supported yet",
1508 pImage->pszFilename);
1509 break;
1510 }
1511 case VHDXMETADATAITEM_UNKNOWN:
1512 default:
1513 if (MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED)
1514 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1515 "VHDX: Unsupported but required metadata item in image \'%s\'",
1516 pImage->pszFilename);
1517 }
1518
1519 if (RT_FAILURE(rc))
1520 break;
1521
1522 offMetadataTblEntry += sizeof(MetadataTblEntry);
1523 }
1524 }
1525 }
1526 else
1527 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1528 "VHDX: Reading the metadata table header for image \'%s\' failed",
1529 pImage->pszFilename);
1530
1531 LogFlowFunc(("returns rc=%Rrc\n", rc));
1532 return rc;
1533}
1534
1535/**
1536 * Loads the region table and the associated regions.
1537 *
1538 * @returns VBox status code.
1539 * @param pImage Image instance data.
1540 */
1541static int vhdxLoadRegionTable(PVHDXIMAGE pImage)
1542{
1543 uint8_t *pbRegionTbl = NULL;
1544 int rc = VINF_SUCCESS;
1545
1546 LogFlowFunc(("pImage=%#p\n", pImage));
1547
1548 /* Load the complete region table into memory. */
1549 pbRegionTbl = (uint8_t *)RTMemTmpAlloc(VHDX_REGION_TBL_SIZE_MAX);
1550 if (pbRegionTbl)
1551 {
1552 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_REGION_TBL_HDR_OFFSET,
1553 pbRegionTbl, VHDX_REGION_TBL_SIZE_MAX);
1554 if (RT_SUCCESS(rc))
1555 {
1556 PVhdxRegionTblHdr pRegionTblHdr;
1557 VhdxRegionTblHdr RegionTblHdr;
1558 uint32_t u32ChkSumSaved = 0;
1559 uint32_t u32ChkSum = 0;
1560
1561 /*
1562 * Copy the region table header to a dedicated structure where we can
1563 * convert it to host endianess.
1564 */
1565 memcpy(&RegionTblHdr, pbRegionTbl, sizeof(RegionTblHdr));
1566 vhdxConvRegionTblHdrEndianess(VHDXECONV_F2H, &RegionTblHdr, &RegionTblHdr);
1567
1568 /* Set checksum field to 0 during crc computation. */
1569 pRegionTblHdr = (PVhdxRegionTblHdr)pbRegionTbl;
1570 pRegionTblHdr->u32Checksum = 0;
1571
1572 /* Verify the region table integrity. */
1573 //u32ChkSum = RTCrc32C(pbRegionTbl, VHDX_REGION_TBL_SIZE_MAX);
1574
1575 if (RegionTblHdr.u32Signature != VHDX_REGION_TBL_HDR_SIGNATURE)
1576 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1577 "VHDX: Invalid signature for region table header of image \'%s\'",
1578 pImage->pszFilename);
1579#if 0
1580 else if (u32ChkSum != RegionTblHdr.u32Checksum)
1581 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1582 "VHDX: CRC32 checksum mismatch for the region table of image \'%s\' (expected %#x got %#x)",
1583 pImage->pszFilename, RegionTblHdr.u32Checksum, u32ChkSum);
1584#endif
1585 else if (RegionTblHdr.u32EntryCount > VHDX_REGION_TBL_HDR_ENTRY_COUNT_MAX)
1586 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1587 "VHDX: Invalid entry count field in the region table header of image \'%s\'",
1588 pImage->pszFilename);
1589
1590 if (RT_SUCCESS(rc))
1591 {
1592 /* Parse the region table entries. */
1593 PVhdxRegionTblEntry pRegTblEntry = (PVhdxRegionTblEntry)(pbRegionTbl + sizeof(VhdxRegionTblHdr));
1594 VhdxRegionTblEntry RegTblEntryBat; /* BAT region table entry. */
1595 bool fBatRegPresent = false;
1596 RT_ZERO(RegTblEntryBat); /* Maybe uninitialized, gcc. */
1597
1598 for (unsigned i = 0; i < RegionTblHdr.u32EntryCount; i++)
1599 {
1600 vhdxConvRegionTblEntryEndianess(VHDXECONV_F2H, pRegTblEntry, pRegTblEntry);
1601
1602 /* Check the uuid for known regions. */
1603 if (!RTUuidCompareStr(&pRegTblEntry->UuidObject, VHDX_REGION_TBL_ENTRY_UUID_BAT))
1604 {
1605 /*
1606 * Save the BAT region and process it later.
1607 * It may come before the metadata region but needs the block size.
1608 */
1609 if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
1610 {
1611 fBatRegPresent = true;
1612 RegTblEntryBat.u32Length = pRegTblEntry->u32Length;
1613 RegTblEntryBat.u64FileOffset = pRegTblEntry->u64FileOffset;
1614 }
1615 else
1616 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1617 "VHDX: BAT region not marked as required in image \'%s\'",
1618 pImage->pszFilename);
1619 }
1620 else if (!RTUuidCompareStr(&pRegTblEntry->UuidObject, VHDX_REGION_TBL_ENTRY_UUID_METADATA))
1621 {
1622 if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
1623 rc = vhdxLoadMetadataRegion(pImage, pRegTblEntry->u64FileOffset, pRegTblEntry->u32Length);
1624 else
1625 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1626 "VHDX: Metadata region not marked as required in image \'%s\'",
1627 pImage->pszFilename);
1628 }
1629 else if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
1630 {
1631 /* The region is not known but marked as required, fail to load the image. */
1632 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1633 "VHDX: Unknown required region in image \'%s\'",
1634 pImage->pszFilename);
1635 }
1636
1637 if (RT_FAILURE(rc))
1638 break;
1639
1640 pRegTblEntry++;
1641 }
1642
1643 if (fBatRegPresent)
1644 rc = vhdxLoadBatRegion(pImage, RegTblEntryBat.u64FileOffset, RegTblEntryBat.u32Length);
1645 else
1646 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1647 "VHDX: BAT region in image \'%s\' is missing",
1648 pImage->pszFilename);
1649 }
1650 }
1651 else
1652 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1653 "VHDX: Reading the region table for image \'%s\' failed",
1654 pImage->pszFilename);
1655 }
1656 else
1657 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
1658 "VHDX: Out of memory allocating memory for the region table of image \'%s\'",
1659 pImage->pszFilename);
1660
1661 if (pbRegionTbl)
1662 RTMemTmpFree(pbRegionTbl);
1663
1664 LogFlowFunc(("returns rc=%Rrc\n", rc));
1665 return rc;
1666}
1667
1668/**
1669 * Internal: Open an image, constructing all necessary data structures.
1670 */
1671static int vhdxOpenImage(PVHDXIMAGE pImage, unsigned uOpenFlags)
1672{
1673 uint64_t cbFile = 0;
1674 VhdxFileIdentifier FileIdentifier;
1675 int rc = VINF_SUCCESS;
1676
1677 LogFlowFunc(("pImage=%#p uOpenFlags=%#x\n", pImage, uOpenFlags));
1678 pImage->uOpenFlags = uOpenFlags;
1679
1680 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
1681 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
1682 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
1683
1684 /* Refuse write access, it is not implemented so far. */
1685 if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
1686 return VERR_NOT_SUPPORTED;
1687
1688 /*
1689 * Open the image.
1690 */
1691 rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
1692 VDOpenFlagsToFileOpenFlags(uOpenFlags,
1693 false /* fCreate */),
1694 &pImage->pStorage);
1695
1696 /* Do NOT signal an appropriate error here, as the VD layer has the
1697 * choice of retrying the open if it failed. */
1698 if (RT_SUCCESS(rc))
1699 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
1700
1701 if (RT_SUCCESS(rc))
1702 {
1703 if (cbFile > sizeof(FileIdentifier))
1704 {
1705 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_FILE_IDENTIFIER_OFFSET,
1706 &FileIdentifier, sizeof(FileIdentifier));
1707 if (RT_SUCCESS(rc))
1708 {
1709 vhdxConvFileIdentifierEndianess(VHDXECONV_F2H, &FileIdentifier,
1710 &FileIdentifier);
1711 if (FileIdentifier.u64Signature != VHDX_FILE_IDENTIFIER_SIGNATURE)
1712 rc = VERR_VD_GEN_INVALID_HEADER;
1713 else
1714 rc = vhdxFindAndLoadCurrentHeader(pImage);
1715
1716 /* Load the region table. */
1717 if (RT_SUCCESS(rc))
1718 rc = vhdxLoadRegionTable(pImage);
1719 }
1720 }
1721 else
1722 rc = VERR_VD_GEN_INVALID_HEADER;
1723 }
1724
1725 if (RT_FAILURE(rc))
1726 vhdxFreeImage(pImage, false);
1727
1728 LogFlowFunc(("returns rc=%Rrc\n", rc));
1729 return rc;
1730}
1731
1732
1733/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
1734static int vhdxCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
1735 PVDINTERFACE pVDIfsImage, VDTYPE *penmType)
1736{
1737 LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p\n", pszFilename, pVDIfsDisk, pVDIfsImage));
1738 PVDIOSTORAGE pStorage = NULL;
1739 uint64_t cbFile;
1740 int rc = VINF_SUCCESS;
1741 VhdxFileIdentifier FileIdentifier;
1742
1743 PVDINTERFACEIOINT pIfIo = VDIfIoIntGet(pVDIfsImage);
1744 AssertPtrReturn(pIfIo, VERR_INVALID_PARAMETER);
1745
1746 if ( !VALID_PTR(pszFilename)
1747 || !*pszFilename)
1748 rc = VERR_INVALID_PARAMETER;
1749 else
1750 {
1751 /*
1752 * Open the file and read the file identifier.
1753 */
1754 rc = vdIfIoIntFileOpen(pIfIo, pszFilename,
1755 VDOpenFlagsToFileOpenFlags(VD_OPEN_FLAGS_READONLY,
1756 false /* fCreate */),
1757 &pStorage);
1758 if (RT_SUCCESS(rc))
1759 rc = vdIfIoIntFileGetSize(pIfIo, pStorage, &cbFile);
1760
1761 if (RT_SUCCESS(rc))
1762 {
1763 if (cbFile > sizeof(FileIdentifier))
1764 {
1765 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, VHDX_FILE_IDENTIFIER_OFFSET,
1766 &FileIdentifier, sizeof(FileIdentifier));
1767 if (RT_SUCCESS(rc))
1768 {
1769 vhdxConvFileIdentifierEndianess(VHDXECONV_F2H, &FileIdentifier,
1770 &FileIdentifier);
1771 if (FileIdentifier.u64Signature != VHDX_FILE_IDENTIFIER_SIGNATURE)
1772 rc = VERR_VD_GEN_INVALID_HEADER;
1773 else
1774 *penmType = VDTYPE_HDD;
1775 }
1776 }
1777 else
1778 rc = VERR_VD_GEN_INVALID_HEADER;
1779 }
1780
1781 if (pStorage)
1782 vdIfIoIntFileClose(pIfIo, pStorage);
1783 }
1784
1785 LogFlowFunc(("returns %Rrc\n", rc));
1786 return rc;
1787}
1788
1789/** @copydoc VBOXHDDBACKEND::pfnOpen */
1790static int vhdxOpen(const char *pszFilename, unsigned uOpenFlags,
1791 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1792 VDTYPE enmType, void **ppBackendData)
1793{
1794 LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, ppBackendData));
1795 int rc;
1796 PVHDXIMAGE pImage;
1797
1798 /* Check open flags. All valid flags are supported. */
1799 if ( uOpenFlags & ~VD_OPEN_FLAGS_MASK
1800 || !VALID_PTR(pszFilename)
1801 || !*pszFilename)
1802 rc = VERR_INVALID_PARAMETER;
1803 else
1804 {
1805 pImage = (PVHDXIMAGE)RTMemAllocZ(sizeof(VHDXIMAGE));
1806 if (!pImage)
1807 rc = VERR_NO_MEMORY;
1808 else
1809 {
1810 pImage->pszFilename = pszFilename;
1811 pImage->pStorage = NULL;
1812 pImage->pVDIfsDisk = pVDIfsDisk;
1813 pImage->pVDIfsImage = pVDIfsImage;
1814
1815 rc = vhdxOpenImage(pImage, uOpenFlags);
1816 if (RT_SUCCESS(rc))
1817 *ppBackendData = pImage;
1818 else
1819 RTMemFree(pImage);
1820 }
1821 }
1822
1823 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1824 return rc;
1825}
1826
1827/** @copydoc VBOXHDDBACKEND::pfnRename */
1828static int vhdxRename(void *pBackendData, const char *pszFilename)
1829{
1830 LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
1831 int rc = VINF_SUCCESS;
1832 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1833
1834 /* Check arguments. */
1835 if ( !pImage
1836 || !pszFilename
1837 || !*pszFilename)
1838 rc = VERR_INVALID_PARAMETER;
1839 else
1840 {
1841 /* Close the image. */
1842 rc = vhdxFreeImage(pImage, false);
1843 if (RT_SUCCESS(rc))
1844 {
1845 /* Rename the file. */
1846 rc = vdIfIoIntFileMove(pImage->pIfIo, pImage->pszFilename, pszFilename, 0);
1847 if (RT_FAILURE(rc))
1848 {
1849 /* The move failed, try to reopen the original image. */
1850 int rc2 = vhdxOpenImage(pImage, pImage->uOpenFlags);
1851 if (RT_FAILURE(rc2))
1852 rc = rc2;
1853 }
1854 else
1855 {
1856 /* Update pImage with the new information. */
1857 pImage->pszFilename = pszFilename;
1858
1859 /* Open the old image with new name. */
1860 rc = vhdxOpenImage(pImage, pImage->uOpenFlags);
1861 }
1862 }
1863 }
1864
1865 LogFlowFunc(("returns %Rrc\n", rc));
1866 return rc;
1867}
1868
1869/** @copydoc VBOXHDDBACKEND::pfnClose */
1870static int vhdxClose(void *pBackendData, bool fDelete)
1871{
1872 LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
1873 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1874 int rc;
1875
1876 rc = vhdxFreeImage(pImage, fDelete);
1877 RTMemFree(pImage);
1878
1879 LogFlowFunc(("returns %Rrc\n", rc));
1880 return rc;
1881}
1882
1883/** @copydoc VBOXHDDBACKEND::pfnRead */
1884static int vhdxRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
1885 PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
1886{
1887 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
1888 pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
1889 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1890 int rc = VINF_SUCCESS;
1891
1892 AssertPtr(pImage);
1893 Assert(uOffset % 512 == 0);
1894 Assert(cbToRead % 512 == 0);
1895
1896 if ( uOffset + cbToRead > pImage->cbSize
1897 || cbToRead == 0)
1898 rc = VERR_INVALID_PARAMETER;
1899 else
1900 {
1901 uint32_t idxBat = (uint32_t)(uOffset / pImage->cbBlock); Assert(idxBat == uOffset / pImage->cbBlock);
1902 uint32_t offRead = uOffset % pImage->cbBlock;
1903 uint64_t uBatEntry;
1904
1905 idxBat += idxBat / pImage->uChunkRatio; /* Add interleaving sector bitmap entries. */
1906 uBatEntry = pImage->paBat[idxBat].u64BatEntry;
1907
1908 cbToRead = RT_MIN(cbToRead, pImage->cbBlock - offRead);
1909
1910 switch (VHDX_BAT_ENTRY_GET_STATE(uBatEntry))
1911 {
1912 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_NOT_PRESENT:
1913 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_UNDEFINED:
1914 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_ZERO:
1915 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_UNMAPPED:
1916 {
1917 vdIfIoIntIoCtxSet(pImage->pIfIo, pIoCtx, 0, cbToRead);
1918 break;
1919 }
1920 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_FULLY_PRESENT:
1921 {
1922 uint64_t offFile = VHDX_BAT_ENTRY_GET_FILE_OFFSET(uBatEntry) + offRead;
1923 rc = vdIfIoIntFileReadUser(pImage->pIfIo, pImage->pStorage, offFile,
1924 pIoCtx, cbToRead);
1925 break;
1926 }
1927 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_PARTIALLY_PRESENT:
1928 default:
1929 rc = VERR_INVALID_PARAMETER;
1930 break;
1931 }
1932
1933 if (pcbActuallyRead)
1934 *pcbActuallyRead = cbToRead;
1935 }
1936
1937 LogFlowFunc(("returns %Rrc\n", rc));
1938 return rc;
1939}
1940
1941/** @copydoc VBOXHDDBACKEND::pfnWrite */
1942static int vhdxWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
1943 PVDIOCTX pIoCtx, size_t *pcbWriteProcess, size_t *pcbPreRead,
1944 size_t *pcbPostRead, unsigned fWrite)
1945{
1946 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
1947 pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
1948 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1949 int rc;
1950
1951 AssertPtr(pImage);
1952 Assert(uOffset % 512 == 0);
1953 Assert(cbToWrite % 512 == 0);
1954
1955 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1956 rc = VERR_VD_IMAGE_READ_ONLY;
1957 else if ( uOffset + cbToWrite > pImage->cbSize
1958 || cbToWrite == 0)
1959 rc = VERR_INVALID_PARAMETER;
1960 else
1961 rc = VERR_NOT_SUPPORTED;
1962
1963 LogFlowFunc(("returns %Rrc\n", rc));
1964 return rc;
1965}
1966
1967/** @copydoc VBOXHDDBACKEND::pfnFlush */
1968static int vhdxFlush(void *pBackendData, PVDIOCTX pIoCtx)
1969{
1970 LogFlowFunc(("pBackendData=%#p pIoCtx=%#p\n", pBackendData, pIoCtx));
1971 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1972 int rc;
1973
1974 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1975 rc = VERR_VD_IMAGE_READ_ONLY;
1976 else
1977 rc = VERR_NOT_SUPPORTED;
1978
1979 LogFlowFunc(("returns %Rrc\n", rc));
1980 return rc;
1981}
1982
1983/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
1984static unsigned vhdxGetVersion(void *pBackendData)
1985{
1986 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1987 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1988
1989 AssertPtr(pImage);
1990
1991 if (pImage)
1992 return pImage->uVersion;
1993 else
1994 return 0;
1995}
1996
1997/** @copydoc VBOXHDDBACKEND::pfnGetSectorSize */
1998static uint32_t vhdxGetSectorSize(void *pBackendData)
1999{
2000 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2001 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2002 uint32_t cb = 0;
2003
2004 AssertPtr(pImage);
2005
2006 if (pImage && pImage->pStorage)
2007 cb = pImage->cbLogicalSector;
2008
2009 LogFlowFunc(("returns %u\n", cb));
2010 return cb;
2011}
2012
2013/** @copydoc VBOXHDDBACKEND::pfnGetSize */
2014static uint64_t vhdxGetSize(void *pBackendData)
2015{
2016 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2017 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2018 uint64_t cb = 0;
2019
2020 AssertPtr(pImage);
2021
2022 if (pImage && pImage->pStorage)
2023 cb = pImage->cbSize;
2024
2025 LogFlowFunc(("returns %llu\n", cb));
2026 return cb;
2027}
2028
2029/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
2030static uint64_t vhdxGetFileSize(void *pBackendData)
2031{
2032 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2033 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2034 uint64_t cb = 0;
2035
2036 AssertPtr(pImage);
2037
2038 if (pImage)
2039 {
2040 uint64_t cbFile;
2041 if (pImage->pStorage)
2042 {
2043 int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
2044 if (RT_SUCCESS(rc))
2045 cb = cbFile;
2046 }
2047 }
2048
2049 LogFlowFunc(("returns %lld\n", cb));
2050 return cb;
2051}
2052
2053/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
2054static int vhdxGetPCHSGeometry(void *pBackendData,
2055 PVDGEOMETRY pPCHSGeometry)
2056{
2057 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
2058 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2059 int rc;
2060
2061 AssertPtr(pImage);
2062
2063 if (pImage)
2064 {
2065 if (pImage->PCHSGeometry.cCylinders)
2066 {
2067 *pPCHSGeometry = pImage->PCHSGeometry;
2068 rc = VINF_SUCCESS;
2069 }
2070 else
2071 rc = VERR_VD_GEOMETRY_NOT_SET;
2072 }
2073 else
2074 rc = VERR_VD_NOT_OPENED;
2075
2076 LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
2077 return rc;
2078}
2079
2080/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
2081static int vhdxSetPCHSGeometry(void *pBackendData,
2082 PCVDGEOMETRY pPCHSGeometry)
2083{
2084 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
2085 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2086 int rc = VINF_SUCCESS;
2087
2088 AssertPtr(pImage);
2089
2090 if (pImage)
2091 {
2092 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2093 rc = VERR_VD_IMAGE_READ_ONLY;
2094 else
2095 pImage->PCHSGeometry = *pPCHSGeometry;
2096 }
2097 else
2098 rc = VERR_VD_NOT_OPENED;
2099
2100 LogFlowFunc(("returns %Rrc\n", rc));
2101 return rc;
2102}
2103
2104/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
2105static int vhdxGetLCHSGeometry(void *pBackendData,
2106 PVDGEOMETRY pLCHSGeometry)
2107{
2108 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
2109 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2110 int rc = VINF_SUCCESS;
2111
2112 AssertPtr(pImage);
2113
2114 if (pImage)
2115 {
2116 if (pImage->LCHSGeometry.cCylinders)
2117 *pLCHSGeometry = pImage->LCHSGeometry;
2118 else
2119 rc = VERR_VD_GEOMETRY_NOT_SET;
2120 }
2121 else
2122 rc = VERR_VD_NOT_OPENED;
2123
2124 LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2125 return rc;
2126}
2127
2128/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
2129static int vhdxSetLCHSGeometry(void *pBackendData,
2130 PCVDGEOMETRY pLCHSGeometry)
2131{
2132 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2133 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2134 int rc = VINF_SUCCESS;
2135
2136 AssertPtr(pImage);
2137
2138 if (pImage)
2139 {
2140 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2141 rc = VERR_VD_IMAGE_READ_ONLY;
2142 else
2143 pImage->LCHSGeometry = *pLCHSGeometry;
2144 }
2145 else
2146 rc = VERR_VD_NOT_OPENED;
2147
2148 LogFlowFunc(("returns %Rrc\n", rc));
2149 return rc;
2150}
2151
2152/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
2153static unsigned vhdxGetImageFlags(void *pBackendData)
2154{
2155 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2156 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2157 unsigned uImageFlags;
2158
2159 AssertPtr(pImage);
2160
2161 if (pImage)
2162 uImageFlags = pImage->uImageFlags;
2163 else
2164 uImageFlags = 0;
2165
2166 LogFlowFunc(("returns %#x\n", uImageFlags));
2167 return uImageFlags;
2168}
2169
2170/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
2171static unsigned vhdxGetOpenFlags(void *pBackendData)
2172{
2173 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2174 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2175 unsigned uOpenFlags;
2176
2177 AssertPtr(pImage);
2178
2179 if (pImage)
2180 uOpenFlags = pImage->uOpenFlags;
2181 else
2182 uOpenFlags = 0;
2183
2184 LogFlowFunc(("returns %#x\n", uOpenFlags));
2185 return uOpenFlags;
2186}
2187
2188/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
2189static int vhdxSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
2190{
2191 LogFlowFunc(("pBackendData=%#p\n uOpenFlags=%#x", pBackendData, uOpenFlags));
2192 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2193 int rc = VINF_SUCCESS;
2194
2195 /* Image must be opened and the new flags must be valid. */
2196 if (!pImage || (uOpenFlags & ~(VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS)))
2197 rc = VERR_INVALID_PARAMETER;
2198 else
2199 {
2200 /* Implement this operation via reopening the image. */
2201 rc = vhdxFreeImage(pImage, false);
2202 if (RT_SUCCESS(rc))
2203 rc = vhdxOpenImage(pImage, uOpenFlags);
2204 }
2205
2206 LogFlowFunc(("returns %Rrc\n", rc));
2207 return rc;
2208}
2209
2210/** @copydoc VBOXHDDBACKEND::pfnGetComment */
2211static int vhdxGetComment(void *pBackendData, char *pszComment,
2212 size_t cbComment)
2213{
2214 LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
2215 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2216 int rc;
2217
2218 AssertPtr(pImage);
2219
2220 if (pImage)
2221 rc = VERR_NOT_SUPPORTED;
2222 else
2223 rc = VERR_VD_NOT_OPENED;
2224
2225 LogFlowFunc(("returns %Rrc comment='%s'\n", rc, pszComment));
2226 return rc;
2227}
2228
2229/** @copydoc VBOXHDDBACKEND::pfnSetComment */
2230static int vhdxSetComment(void *pBackendData, const char *pszComment)
2231{
2232 LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
2233 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2234 int rc;
2235
2236 AssertPtr(pImage);
2237
2238 if (pImage)
2239 {
2240 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2241 rc = VERR_VD_IMAGE_READ_ONLY;
2242 else
2243 rc = VERR_NOT_SUPPORTED;
2244 }
2245 else
2246 rc = VERR_VD_NOT_OPENED;
2247
2248 LogFlowFunc(("returns %Rrc\n", rc));
2249 return rc;
2250}
2251
2252/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
2253static int vhdxGetUuid(void *pBackendData, PRTUUID pUuid)
2254{
2255 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2256 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2257 int rc;
2258
2259 AssertPtr(pImage);
2260
2261 if (pImage)
2262 rc = VERR_NOT_SUPPORTED;
2263 else
2264 rc = VERR_VD_NOT_OPENED;
2265
2266 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2267 return rc;
2268}
2269
2270/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
2271static int vhdxSetUuid(void *pBackendData, PCRTUUID pUuid)
2272{
2273 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2274 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2275 int rc;
2276
2277 LogFlowFunc(("%RTuuid\n", pUuid));
2278 AssertPtr(pImage);
2279
2280 if (pImage)
2281 {
2282 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2283 rc = VERR_NOT_SUPPORTED;
2284 else
2285 rc = VERR_VD_IMAGE_READ_ONLY;
2286 }
2287 else
2288 rc = VERR_VD_NOT_OPENED;
2289
2290 LogFlowFunc(("returns %Rrc\n", rc));
2291 return rc;
2292}
2293
2294/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
2295static int vhdxGetModificationUuid(void *pBackendData, PRTUUID pUuid)
2296{
2297 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2298 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2299 int rc;
2300
2301 AssertPtr(pImage);
2302
2303 if (pImage)
2304 rc = VERR_NOT_SUPPORTED;
2305 else
2306 rc = VERR_VD_NOT_OPENED;
2307
2308 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2309 return rc;
2310}
2311
2312/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
2313static int vhdxSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
2314{
2315 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2316 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2317 int rc;
2318
2319 AssertPtr(pImage);
2320
2321 if (pImage)
2322 {
2323 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2324 rc = VERR_NOT_SUPPORTED;
2325 else
2326 rc = VERR_VD_IMAGE_READ_ONLY;
2327 }
2328 else
2329 rc = VERR_VD_NOT_OPENED;
2330
2331 LogFlowFunc(("returns %Rrc\n", rc));
2332 return rc;
2333}
2334
2335/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
2336static int vhdxGetParentUuid(void *pBackendData, PRTUUID pUuid)
2337{
2338 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2339 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2340 int rc;
2341
2342 AssertPtr(pImage);
2343
2344 if (pImage)
2345 rc = VERR_NOT_SUPPORTED;
2346 else
2347 rc = VERR_VD_NOT_OPENED;
2348
2349 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2350 return rc;
2351}
2352
2353/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
2354static int vhdxSetParentUuid(void *pBackendData, PCRTUUID pUuid)
2355{
2356 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2357 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2358 int rc;
2359
2360 AssertPtr(pImage);
2361
2362 if (pImage)
2363 {
2364 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2365 rc = VERR_NOT_SUPPORTED;
2366 else
2367 rc = VERR_VD_IMAGE_READ_ONLY;
2368 }
2369 else
2370 rc = VERR_VD_NOT_OPENED;
2371
2372 LogFlowFunc(("returns %Rrc\n", rc));
2373 return rc;
2374}
2375
2376/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
2377static int vhdxGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
2378{
2379 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2380 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2381 int rc;
2382
2383 AssertPtr(pImage);
2384
2385 if (pImage)
2386 rc = VERR_NOT_SUPPORTED;
2387 else
2388 rc = VERR_VD_NOT_OPENED;
2389
2390 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2391 return rc;
2392}
2393
2394/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
2395static int vhdxSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
2396{
2397 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2398 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2399 int rc;
2400
2401 AssertPtr(pImage);
2402
2403 if (pImage)
2404 {
2405 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2406 rc = VERR_NOT_SUPPORTED;
2407 else
2408 rc = VERR_VD_IMAGE_READ_ONLY;
2409 }
2410 else
2411 rc = VERR_VD_NOT_OPENED;
2412
2413 LogFlowFunc(("returns %Rrc\n", rc));
2414 return rc;
2415}
2416
2417/** @copydoc VBOXHDDBACKEND::pfnDump */
2418static void vhdxDump(void *pBackendData)
2419{
2420 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2421
2422 AssertPtr(pImage);
2423 if (pImage)
2424 {
2425 vdIfErrorMessage(pImage->pIfError, "Header: Geometry PCHS=%u/%u/%u LCHS=%u/%u/%u cbSector=%u\n",
2426 pImage->PCHSGeometry.cCylinders, pImage->PCHSGeometry.cHeads, pImage->PCHSGeometry.cSectors,
2427 pImage->LCHSGeometry.cCylinders, pImage->LCHSGeometry.cHeads, pImage->LCHSGeometry.cSectors,
2428 pImage->cbLogicalSector);
2429 }
2430}
2431
2432
2433VBOXHDDBACKEND g_VhdxBackend =
2434{
2435 /* pszBackendName */
2436 "VHDX",
2437 /* cbSize */
2438 sizeof(VBOXHDDBACKEND),
2439 /* uBackendCaps */
2440 VD_CAP_FILE | VD_CAP_VFS,
2441 /* paFileExtensions */
2442 s_aVhdxFileExtensions,
2443 /* paConfigInfo */
2444 NULL,
2445 /* hPlugin */
2446 NIL_RTLDRMOD,
2447 /* pfnCheckIfValid */
2448 vhdxCheckIfValid,
2449 /* pfnOpen */
2450 vhdxOpen,
2451 /* pfnCreate */
2452 NULL,
2453 /* pfnRename */
2454 vhdxRename,
2455 /* pfnClose */
2456 vhdxClose,
2457 /* pfnRead */
2458 vhdxRead,
2459 /* pfnWrite */
2460 vhdxWrite,
2461 /* pfnFlush */
2462 vhdxFlush,
2463 /* pfnDiscard */
2464 NULL,
2465 /* pfnGetVersion */
2466 vhdxGetVersion,
2467 /* pfnGetSectorSize */
2468 vhdxGetSectorSize,
2469 /* pfnGetSize */
2470 vhdxGetSize,
2471 /* pfnGetFileSize */
2472 vhdxGetFileSize,
2473 /* pfnGetPCHSGeometry */
2474 vhdxGetPCHSGeometry,
2475 /* pfnSetPCHSGeometry */
2476 vhdxSetPCHSGeometry,
2477 /* pfnGetLCHSGeometry */
2478 vhdxGetLCHSGeometry,
2479 /* pfnSetLCHSGeometry */
2480 vhdxSetLCHSGeometry,
2481 /* pfnGetImageFlags */
2482 vhdxGetImageFlags,
2483 /* pfnGetOpenFlags */
2484 vhdxGetOpenFlags,
2485 /* pfnSetOpenFlags */
2486 vhdxSetOpenFlags,
2487 /* pfnGetComment */
2488 vhdxGetComment,
2489 /* pfnSetComment */
2490 vhdxSetComment,
2491 /* pfnGetUuid */
2492 vhdxGetUuid,
2493 /* pfnSetUuid */
2494 vhdxSetUuid,
2495 /* pfnGetModificationUuid */
2496 vhdxGetModificationUuid,
2497 /* pfnSetModificationUuid */
2498 vhdxSetModificationUuid,
2499 /* pfnGetParentUuid */
2500 vhdxGetParentUuid,
2501 /* pfnSetParentUuid */
2502 vhdxSetParentUuid,
2503 /* pfnGetParentModificationUuid */
2504 vhdxGetParentModificationUuid,
2505 /* pfnSetParentModificationUuid */
2506 vhdxSetParentModificationUuid,
2507 /* pfnDump */
2508 vhdxDump,
2509 /* pfnGetTimeStamp */
2510 NULL,
2511 /* pfnGetParentTimeStamp */
2512 NULL,
2513 /* pfnSetParentTimeStamp */
2514 NULL,
2515 /* pfnGetParentFilename */
2516 NULL,
2517 /* pfnSetParentFilename */
2518 NULL,
2519 /* pfnComposeLocation */
2520 genericFileComposeLocation,
2521 /* pfnComposeName */
2522 genericFileComposeName,
2523 /* pfnCompact */
2524 NULL,
2525 /* pfnResize */
2526 NULL,
2527 /* pfnRepair */
2528 NULL
2529};
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette