VirtualBox

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

Last change on this file since 45898 was 45486, checked in by vboxsync, 12 years ago

Storage: Fix unused label and variable warnings
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 89.0 KB
Line 
1/* $Id: VHDX.cpp 45486 2013-04-11 14:52:10Z 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 size_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, false, 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 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 uChunkRatio = (RT_BIT_64(23) * pImage->cbLogicalSector) / pImage->cbBlock;
1147 cDataBlocks = pImage->cbSize / pImage->cbBlock;
1148 if (pImage->cbSize % pImage->cbBlock)
1149 cDataBlocks++;
1150
1151 cSectorBitmapBlocks = cDataBlocks / uChunkRatio;
1152 if (cDataBlocks % uChunkRatio)
1153 cSectorBitmapBlocks++;
1154
1155 cBatEntries = cDataBlocks + (cDataBlocks - 1)/uChunkRatio;
1156 cbBatEntries = cBatEntries * sizeof(VhdxBatEntry);
1157
1158 if (cbBatEntries <= cbRegion)
1159 {
1160 /*
1161 * Load the complete BAT region first, convert to host endianess and process
1162 * it afterwards. The SB entries can be removed because they are not needed yet.
1163 */
1164 paBatEntries = (PVhdxBatEntry)RTMemAlloc(cbBatEntries);
1165 if (paBatEntries)
1166 {
1167 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offRegion,
1168 paBatEntries, cbBatEntries);
1169 if (RT_SUCCESS(rc))
1170 {
1171 vhdxConvBatTableEndianess(VHDXECONV_F2H, paBatEntries, paBatEntries,
1172 cBatEntries);
1173
1174 /* Go through the table and validate it. */
1175 for (unsigned i = 0; i < cBatEntries; i++)
1176 {
1177 if ( i != 0
1178 && (i % uChunkRatio) == 0)
1179 {
1180 /* Sector bitmap block. */
1181 if ( VHDX_BAT_ENTRY_GET_STATE(paBatEntries[i].u64BatEntry)
1182 != VHDX_BAT_ENTRY_SB_BLOCK_NOT_PRESENT)
1183 {
1184 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1185 "VHDX: Sector bitmap block at entry %u of image \'%s\' marked as present, violation of the specification",
1186 i, pImage->pszFilename);
1187 break;
1188 }
1189 }
1190 else
1191 {
1192 /* Payload block. */
1193 if ( VHDX_BAT_ENTRY_GET_STATE(paBatEntries[i].u64BatEntry)
1194 == VHDX_BAT_ENTRY_PAYLOAD_BLOCK_PARTIALLY_PRESENT)
1195 {
1196 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1197 "VHDX: Payload block at entry %u of image \'%s\' marked as partially present, violation of the specification",
1198 i, pImage->pszFilename);
1199 break;
1200 }
1201 }
1202 }
1203
1204 if (RT_SUCCESS(rc))
1205 {
1206 pImage->paBat = paBatEntries;
1207 pImage->uChunkRatio = uChunkRatio;
1208 }
1209 }
1210 else
1211 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1212 "VHDX: Error reading the BAT from image \'%s\'",
1213 pImage->pszFilename);
1214 }
1215 else
1216 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
1217 "VHDX: Out of memory allocating memory for %u BAT entries of image \'%s\'",
1218 cBatEntries);
1219 }
1220 else
1221 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1222 "VHDX: Mismatch between calculated number of BAT entries and region size (expected %u got %u) for image \'%s\'",
1223 cbBatEntries, cbRegion, pImage->pszFilename);
1224
1225 if ( RT_FAILURE(rc)
1226 && paBatEntries)
1227 RTMemFree(paBatEntries);
1228
1229 LogFlowFunc(("returns rc=%Rrc\n", rc));
1230 return rc;
1231}
1232
1233/**
1234 * Load the file parameters metadata item from the file.
1235 *
1236 * @returns VBox status code.
1237 * @param pImage Image instance data.
1238 * @param offItem File offset where the data is stored.
1239 * @param cbItem Size of the item in the file.
1240 */
1241static int vhdxLoadFileParametersMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
1242{
1243 int rc = VINF_SUCCESS;
1244
1245 LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
1246
1247 if (cbItem != sizeof(VhdxFileParameters))
1248 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1249 "VHDX: File parameters item size mismatch (expected %u got %zu) in image \'%s\'",
1250 sizeof(VhdxFileParameters), cbItem, pImage->pszFilename);
1251 else
1252 {
1253 VhdxFileParameters FileParameters;
1254
1255 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
1256 &FileParameters, sizeof(FileParameters));
1257 if (RT_SUCCESS(rc))
1258 {
1259 vhdxConvFileParamsEndianess(VHDXECONV_F2H, &FileParameters, &FileParameters);
1260 pImage->cbBlock = FileParameters.u32BlockSize;
1261
1262 /* @todo: No support for differencing images yet. */
1263 if (FileParameters.u32Flags & VHDX_FILE_PARAMETERS_FLAGS_HAS_PARENT)
1264 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1265 "VHDX: Image \'%s\' is a differencing image which is not supported yet",
1266 pImage->pszFilename);
1267 }
1268 else
1269 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1270 "VHDX: Reading the file parameters metadata item from image \'%s\' failed",
1271 pImage->pszFilename);
1272 }
1273
1274 LogFlowFunc(("returns rc=%Rrc\n", rc));
1275 return rc;
1276}
1277
1278/**
1279 * Load the virtual disk size metadata item from the file.
1280 *
1281 * @returns VBox status code.
1282 * @param pImage Image instance data.
1283 * @param offItem File offset where the data is stored.
1284 * @param cbItem Size of the item in the file.
1285 */
1286static int vhdxLoadVDiskSizeMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
1287{
1288 int rc = VINF_SUCCESS;
1289
1290 LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
1291
1292 if (cbItem != sizeof(VhdxVDiskSize))
1293 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1294 "VHDX: Virtual disk size item size mismatch (expected %u got %zu) in image \'%s\'",
1295 sizeof(VhdxVDiskSize), cbItem, pImage->pszFilename);
1296 else
1297 {
1298 VhdxVDiskSize VDiskSize;
1299
1300 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
1301 &VDiskSize, sizeof(VDiskSize));
1302 if (RT_SUCCESS(rc))
1303 {
1304 vhdxConvVDiskSizeEndianess(VHDXECONV_F2H, &VDiskSize, &VDiskSize);
1305 pImage->cbSize = VDiskSize.u64VDiskSize;
1306 }
1307 else
1308 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1309 "VHDX: Reading the virtual disk size metadata item from image \'%s\' failed",
1310 pImage->pszFilename);
1311 }
1312
1313 LogFlowFunc(("returns rc=%Rrc\n", rc));
1314 return rc;
1315}
1316
1317/**
1318 * Load the logical sector size metadata item from the file.
1319 *
1320 * @returns VBox status code.
1321 * @param pImage Image instance data.
1322 * @param offItem File offset where the data is stored.
1323 * @param cbItem Size of the item in the file.
1324 */
1325static int vhdxLoadVDiskLogSectorSizeMetadata(PVHDXIMAGE pImage, uint64_t offItem, size_t cbItem)
1326{
1327 int rc = VINF_SUCCESS;
1328
1329 LogFlowFunc(("pImage=%#p offItem=%llu cbItem=%zu\n", pImage, offItem, cbItem));
1330
1331 if (cbItem != sizeof(VhdxVDiskLogicalSectorSize))
1332 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1333 "VHDX: Virtual disk logical sector size item size mismatch (expected %u got %zu) in image \'%s\'",
1334 sizeof(VhdxVDiskLogicalSectorSize), cbItem, pImage->pszFilename);
1335 else
1336 {
1337 VhdxVDiskLogicalSectorSize VDiskLogSectSize;
1338
1339 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offItem,
1340 &VDiskLogSectSize, sizeof(VDiskLogSectSize));
1341 if (RT_SUCCESS(rc))
1342 {
1343 vhdxConvVDiskLogSectSizeEndianess(VHDXECONV_F2H, &VDiskLogSectSize,
1344 &VDiskLogSectSize);
1345 pImage->cbLogicalSector = VDiskLogSectSize.u32LogicalSectorSize;
1346 }
1347 else
1348 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1349 "VHDX: Reading the virtual disk logical sector size metadata item from image \'%s\' failed",
1350 pImage->pszFilename);
1351 }
1352
1353 LogFlowFunc(("returns rc=%Rrc\n", rc));
1354 return rc;
1355}
1356
1357/**
1358 * Loads the metadata region.
1359 *
1360 * @returns VBox status code.
1361 * @param pImage Image instance data.
1362 * @param offRegion Start offset of the region.
1363 * @param cbRegion Size of the region.
1364 */
1365static int vhdxLoadMetadataRegion(PVHDXIMAGE pImage, uint64_t offRegion,
1366 size_t cbRegion)
1367{
1368 VhdxMetadataTblHdr MetadataTblHdr;
1369 int rc = VINF_SUCCESS;
1370
1371 LogFlowFunc(("pImage=%#p\n", pImage));
1372
1373 /* Load the header first. */
1374 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offRegion,
1375 &MetadataTblHdr, sizeof(MetadataTblHdr));
1376 if (RT_SUCCESS(rc))
1377 {
1378 vhdxConvMetadataTblHdrEndianess(VHDXECONV_F2H, &MetadataTblHdr, &MetadataTblHdr);
1379
1380 /* Validate structure. */
1381 if (MetadataTblHdr.u64Signature != VHDX_METADATA_TBL_HDR_SIGNATURE)
1382 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1383 "VHDX: Incorrect metadata table header signature for image \'%s\'",
1384 pImage->pszFilename);
1385 else if (MetadataTblHdr.u16EntryCount > VHDX_METADATA_TBL_HDR_ENTRY_COUNT_MAX)
1386 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1387 "VHDX: Incorrect entry count in metadata table header of image \'%s\'",
1388 pImage->pszFilename);
1389 else if (cbRegion < (MetadataTblHdr.u16EntryCount * sizeof(VhdxMetadataTblEntry) + sizeof(VhdxMetadataTblHdr)))
1390 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1391 "VHDX: Metadata table of image \'%s\' exceeds region size",
1392 pImage->pszFilename);
1393
1394 if (RT_SUCCESS(rc))
1395 {
1396 uint64_t offMetadataTblEntry = offRegion + sizeof(VhdxMetadataTblHdr);
1397
1398 for (unsigned i = 0; i < MetadataTblHdr.u16EntryCount; i++)
1399 {
1400 uint64_t offMetadataItem = 0;
1401 VHDXMETADATAITEM enmMetadataItem = VHDXMETADATAITEM_UNKNOWN;
1402 VhdxMetadataTblEntry MetadataTblEntry;
1403
1404 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, offMetadataTblEntry,
1405 &MetadataTblEntry, sizeof(MetadataTblEntry));
1406 if (RT_FAILURE(rc))
1407 {
1408 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1409 "VHDX: Reading metadata table entry from image \'%s\' failed",
1410 pImage->pszFilename);
1411 break;
1412 }
1413
1414 vhdxConvMetadataTblEntryEndianess(VHDXECONV_F2H, &MetadataTblEntry, &MetadataTblEntry);
1415
1416 /* Check whether the flags match the expectations. */
1417 for (unsigned idxProp = 0; idxProp < RT_ELEMENTS(s_aVhdxMetadataItemProps); idxProp++)
1418 {
1419 if (!RTUuidCompareStr(&MetadataTblEntry.UuidItem,
1420 s_aVhdxMetadataItemProps[idxProp].pszItemUuid))
1421 {
1422 if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_USER)
1423 != s_aVhdxMetadataItemProps[idxProp].fIsUser)
1424 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1425 "VHDX: User flag of metadata item does not meet expectations \'%s\'",
1426 pImage->pszFilename);
1427 else if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_VDISK)
1428 != s_aVhdxMetadataItemProps[idxProp].fIsVDisk)
1429 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1430 "VHDX: Virtual disk flag of metadata item does not meet expectations \'%s\'",
1431 pImage->pszFilename);
1432 else if ( !!(MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED)
1433 != s_aVhdxMetadataItemProps[idxProp].fIsRequired)
1434 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1435 "VHDX: Required flag of metadata item does not meet expectations \'%s\'",
1436 pImage->pszFilename);
1437 else
1438 enmMetadataItem = s_aVhdxMetadataItemProps[idxProp].enmMetadataItem;
1439
1440 break;
1441 }
1442 }
1443
1444 if (RT_FAILURE(rc))
1445 break;
1446
1447 offMetadataItem = offRegion + MetadataTblEntry.u32Offset;
1448
1449 switch (enmMetadataItem)
1450 {
1451 case VHDXMETADATAITEM_FILE_PARAMS:
1452 {
1453 rc = vhdxLoadFileParametersMetadata(pImage, offMetadataItem,
1454 MetadataTblEntry.u32Length);
1455 break;
1456 }
1457 case VHDXMETADATAITEM_VDISK_SIZE:
1458 {
1459 rc = vhdxLoadVDiskSizeMetadata(pImage, offMetadataItem,
1460 MetadataTblEntry.u32Length);
1461 break;
1462 }
1463 case VHDXMETADATAITEM_PAGE83_DATA:
1464 {
1465 /*
1466 * Nothing to do here for now (marked as required but
1467 * there is no API to pass this information to the caller)
1468 * so far.
1469 */
1470 break;
1471 }
1472 case VHDXMETADATAITEM_LOGICAL_SECTOR_SIZE:
1473 {
1474 rc = vhdxLoadVDiskLogSectorSizeMetadata(pImage, offMetadataItem,
1475 MetadataTblEntry.u32Length);
1476 break;
1477 }
1478 case VHDXMETADATAITEM_PHYSICAL_SECTOR_SIZE:
1479 {
1480 /*
1481 * Nothing to do here for now (marked as required but
1482 * there is no API to pass this information to the caller)
1483 * so far.
1484 */
1485 break;
1486 }
1487 case VHDXMETADATAITEM_PARENT_LOCATOR:
1488 {
1489 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1490 "VHDX: Image \'%s\' is a differencing image which is not supported yet",
1491 pImage->pszFilename);
1492 break;
1493 }
1494 case VHDXMETADATAITEM_UNKNOWN:
1495 default:
1496 if (MetadataTblEntry.u32Flags & VHDX_METADATA_TBL_ENTRY_FLAGS_IS_REQUIRED)
1497 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1498 "VHDX: Unsupported but required metadata item in image \'%s\'",
1499 pImage->pszFilename);
1500 }
1501
1502 if (RT_FAILURE(rc))
1503 break;
1504
1505 offMetadataTblEntry += sizeof(MetadataTblEntry);
1506 }
1507 }
1508 }
1509 else
1510 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1511 "VHDX: Reading the metadata table header for image \'%s\' failed",
1512 pImage->pszFilename);
1513
1514 LogFlowFunc(("returns rc=%Rrc\n", rc));
1515 return rc;
1516}
1517
1518/**
1519 * Loads the region table and the associated regions.
1520 *
1521 * @returns VBox status code.
1522 * @param pImage Image instance data.
1523 */
1524static int vhdxLoadRegionTable(PVHDXIMAGE pImage)
1525{
1526 uint8_t *pbRegionTbl = NULL;
1527 int rc = VINF_SUCCESS;
1528
1529 LogFlowFunc(("pImage=%#p\n", pImage));
1530
1531 /* Load the complete region table into memory. */
1532 pbRegionTbl = (uint8_t *)RTMemTmpAlloc(VHDX_REGION_TBL_SIZE_MAX);
1533 if (pbRegionTbl)
1534 {
1535 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_REGION_TBL_HDR_OFFSET,
1536 pbRegionTbl, VHDX_REGION_TBL_SIZE_MAX);
1537 if (RT_SUCCESS(rc))
1538 {
1539 PVhdxRegionTblHdr pRegionTblHdr;
1540 VhdxRegionTblHdr RegionTblHdr;
1541 uint32_t u32ChkSumSaved = 0;
1542 uint32_t u32ChkSum = 0;
1543
1544 /*
1545 * Copy the region table header to a dedicated structure where we can
1546 * convert it to host endianess.
1547 */
1548 memcpy(&RegionTblHdr, pbRegionTbl, sizeof(RegionTblHdr));
1549 vhdxConvRegionTblHdrEndianess(VHDXECONV_F2H, &RegionTblHdr, &RegionTblHdr);
1550
1551 /* Set checksum field to 0 during crc computation. */
1552 pRegionTblHdr = (PVhdxRegionTblHdr)pbRegionTbl;
1553 pRegionTblHdr->u32Checksum = 0;
1554
1555 /* Verify the region table integrity. */
1556 //u32ChkSum = RTCrc32C(pbRegionTbl, VHDX_REGION_TBL_SIZE_MAX);
1557
1558 if (RegionTblHdr.u32Signature != VHDX_REGION_TBL_HDR_SIGNATURE)
1559 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1560 "VHDX: Invalid signature for region table header of image \'%s\'",
1561 pImage->pszFilename);
1562#if 0
1563 else if (u32ChkSum != RegionTblHdr.u32Checksum)
1564 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1565 "VHDX: CRC32 checksum mismatch for the region table of image \'%s\' (expected %#x got %#x)",
1566 pImage->pszFilename, RegionTblHdr.u32Checksum, u32ChkSum);
1567#endif
1568 else if (RegionTblHdr.u32EntryCount > VHDX_REGION_TBL_HDR_ENTRY_COUNT_MAX)
1569 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1570 "VHDX: Invalid entry count field in the region table header of image \'%s\'",
1571 pImage->pszFilename);
1572
1573 if (RT_SUCCESS(rc))
1574 {
1575 /* Parse the region table entries. */
1576 PVhdxRegionTblEntry pRegTblEntry = (PVhdxRegionTblEntry)(pbRegionTbl + sizeof(VhdxRegionTblHdr));
1577 VhdxRegionTblEntry RegTblEntryBat; /**<< BAT region table entry. */
1578 bool fBatRegPresent = false;
1579
1580 for (unsigned i = 0; i < RegionTblHdr.u32EntryCount; i++)
1581 {
1582 vhdxConvRegionTblEntryEndianess(VHDXECONV_F2H, pRegTblEntry, pRegTblEntry);
1583
1584 /* Check the uuid for known regions. */
1585 if (!RTUuidCompareStr(&pRegTblEntry->UuidObject, VHDX_REGION_TBL_ENTRY_UUID_BAT))
1586 {
1587 /*
1588 * Save the BAT region and process it later.
1589 * It may come before the metadata region but needs the block size.
1590 */
1591 if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
1592 {
1593 fBatRegPresent = true;
1594 RegTblEntryBat.u32Length = pRegTblEntry->u32Length;
1595 RegTblEntryBat.u64FileOffset = pRegTblEntry->u64FileOffset;
1596 }
1597 else
1598 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1599 "VHDX: BAT region not marked as required in image \'%s\'",
1600 pImage->pszFilename);
1601 }
1602 else if (!RTUuidCompareStr(&pRegTblEntry->UuidObject, VHDX_REGION_TBL_ENTRY_UUID_METADATA))
1603 {
1604 if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
1605 rc = vhdxLoadMetadataRegion(pImage, pRegTblEntry->u64FileOffset, pRegTblEntry->u32Length);
1606 else
1607 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1608 "VHDX: Metadata region not marked as required in image \'%s\'",
1609 pImage->pszFilename);
1610 }
1611 else if (pRegTblEntry->u32Flags & VHDX_REGION_TBL_ENTRY_FLAGS_IS_REQUIRED)
1612 {
1613 /* The region is not known but marked as required, fail to load the image. */
1614 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1615 "VHDX: Unknown required region in image \'%s\'",
1616 pImage->pszFilename);
1617 }
1618
1619 if (RT_FAILURE(rc))
1620 break;
1621
1622 pRegTblEntry++;
1623 }
1624
1625 if (fBatRegPresent)
1626 rc = vhdxLoadBatRegion(pImage, RegTblEntryBat.u64FileOffset, RegTblEntryBat.u32Length);
1627 else
1628 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1629 "VHDX: BAT region in image \'%s\' is missing",
1630 pImage->pszFilename);
1631 }
1632 }
1633 else
1634 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1635 "VHDX: Reading the region table for image \'%s\' failed",
1636 pImage->pszFilename);
1637 }
1638 else
1639 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
1640 "VHDX: Out of memory allocating memory for the region table of image \'%s\'",
1641 pImage->pszFilename);
1642
1643 if (pbRegionTbl)
1644 RTMemTmpFree(pbRegionTbl);
1645
1646 LogFlowFunc(("returns rc=%Rrc\n", rc));
1647 return rc;
1648}
1649
1650/**
1651 * Internal: Open an image, constructing all necessary data structures.
1652 */
1653static int vhdxOpenImage(PVHDXIMAGE pImage, unsigned uOpenFlags)
1654{
1655 uint64_t cbFile = 0;
1656 VhdxFileIdentifier FileIdentifier;
1657 int rc = VINF_SUCCESS;
1658
1659 LogFlowFunc(("pImage=%#p uOpenFlags=%#x\n", pImage, uOpenFlags));
1660 pImage->uOpenFlags = uOpenFlags;
1661
1662 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
1663 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
1664 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
1665
1666 /* Refuse write access, it is not implemented so far. */
1667 if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
1668 return VERR_NOT_SUPPORTED;
1669
1670 /*
1671 * Open the image.
1672 */
1673 rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
1674 VDOpenFlagsToFileOpenFlags(uOpenFlags,
1675 false /* fCreate */),
1676 &pImage->pStorage);
1677
1678 /* Do NOT signal an appropriate error here, as the VD layer has the
1679 * choice of retrying the open if it failed. */
1680 if (RT_SUCCESS(rc))
1681 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
1682
1683 if (RT_SUCCESS(rc))
1684 {
1685 if (cbFile > sizeof(FileIdentifier))
1686 {
1687 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, VHDX_FILE_IDENTIFIER_OFFSET,
1688 &FileIdentifier, sizeof(FileIdentifier));
1689 if (RT_SUCCESS(rc))
1690 {
1691 vhdxConvFileIdentifierEndianess(VHDXECONV_F2H, &FileIdentifier,
1692 &FileIdentifier);
1693 if (FileIdentifier.u64Signature != VHDX_FILE_IDENTIFIER_SIGNATURE)
1694 rc = VERR_VD_GEN_INVALID_HEADER;
1695 else
1696 rc = vhdxFindAndLoadCurrentHeader(pImage);
1697
1698 /* Load the region table. */
1699 if (RT_SUCCESS(rc))
1700 rc = vhdxLoadRegionTable(pImage);
1701 }
1702 }
1703 else
1704 rc = VERR_VD_GEN_INVALID_HEADER;
1705 }
1706
1707 if (RT_FAILURE(rc))
1708 vhdxFreeImage(pImage, false);
1709
1710 LogFlowFunc(("returns rc=%Rrc\n", rc));
1711 return rc;
1712}
1713
1714
1715/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
1716static int vhdxCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
1717 PVDINTERFACE pVDIfsImage, VDTYPE *penmType)
1718{
1719 LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p\n", pszFilename, pVDIfsDisk, pVDIfsImage));
1720 PVDIOSTORAGE pStorage = NULL;
1721 uint64_t cbFile;
1722 int rc = VINF_SUCCESS;
1723 VhdxFileIdentifier FileIdentifier;
1724
1725 PVDINTERFACEIOINT pIfIo = VDIfIoIntGet(pVDIfsImage);
1726 AssertPtrReturn(pIfIo, VERR_INVALID_PARAMETER);
1727
1728 if ( !VALID_PTR(pszFilename)
1729 || !*pszFilename)
1730 rc = VERR_INVALID_PARAMETER;
1731 else
1732 {
1733 /*
1734 * Open the file and read the file identifier.
1735 */
1736 rc = vdIfIoIntFileOpen(pIfIo, pszFilename,
1737 VDOpenFlagsToFileOpenFlags(VD_OPEN_FLAGS_READONLY,
1738 false /* fCreate */),
1739 &pStorage);
1740 if (RT_SUCCESS(rc))
1741 rc = vdIfIoIntFileGetSize(pIfIo, pStorage, &cbFile);
1742
1743 if (RT_SUCCESS(rc))
1744 {
1745 if (cbFile > sizeof(FileIdentifier))
1746 {
1747 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, VHDX_FILE_IDENTIFIER_OFFSET,
1748 &FileIdentifier, sizeof(FileIdentifier));
1749 if (RT_SUCCESS(rc))
1750 {
1751 vhdxConvFileIdentifierEndianess(VHDXECONV_F2H, &FileIdentifier,
1752 &FileIdentifier);
1753 if (FileIdentifier.u64Signature != VHDX_FILE_IDENTIFIER_SIGNATURE)
1754 rc = VERR_VD_GEN_INVALID_HEADER;
1755 else
1756 *penmType = VDTYPE_HDD;
1757 }
1758 }
1759 else
1760 rc = VERR_VD_GEN_INVALID_HEADER;
1761 }
1762
1763 if (pStorage)
1764 vdIfIoIntFileClose(pIfIo, pStorage);
1765 }
1766
1767 LogFlowFunc(("returns %Rrc\n", rc));
1768 return rc;
1769}
1770
1771/** @copydoc VBOXHDDBACKEND::pfnOpen */
1772static int vhdxOpen(const char *pszFilename, unsigned uOpenFlags,
1773 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1774 VDTYPE enmType, void **ppBackendData)
1775{
1776 LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, ppBackendData));
1777 int rc;
1778 PVHDXIMAGE pImage;
1779
1780 /* Check open flags. All valid flags are supported. */
1781 if ( uOpenFlags & ~VD_OPEN_FLAGS_MASK
1782 || !VALID_PTR(pszFilename)
1783 || !*pszFilename)
1784 rc = VERR_INVALID_PARAMETER;
1785 else
1786 {
1787 pImage = (PVHDXIMAGE)RTMemAllocZ(sizeof(VHDXIMAGE));
1788 if (!pImage)
1789 rc = VERR_NO_MEMORY;
1790 else
1791 {
1792 pImage->pszFilename = pszFilename;
1793 pImage->pStorage = NULL;
1794 pImage->pVDIfsDisk = pVDIfsDisk;
1795 pImage->pVDIfsImage = pVDIfsImage;
1796
1797 rc = vhdxOpenImage(pImage, uOpenFlags);
1798 if (RT_SUCCESS(rc))
1799 *ppBackendData = pImage;
1800 else
1801 RTMemFree(pImage);
1802 }
1803 }
1804
1805 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1806 return rc;
1807}
1808
1809/** @copydoc VBOXHDDBACKEND::pfnRename */
1810static int vhdxRename(void *pBackendData, const char *pszFilename)
1811{
1812 LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
1813 int rc = VINF_SUCCESS;
1814 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1815
1816 /* Check arguments. */
1817 if ( !pImage
1818 || !pszFilename
1819 || !*pszFilename)
1820 rc = VERR_INVALID_PARAMETER;
1821 else
1822 {
1823 /* Close the image. */
1824 rc = vhdxFreeImage(pImage, false);
1825 if (RT_SUCCESS(rc))
1826 {
1827 /* Rename the file. */
1828 rc = vdIfIoIntFileMove(pImage->pIfIo, pImage->pszFilename, pszFilename, 0);
1829 if (RT_FAILURE(rc))
1830 {
1831 /* The move failed, try to reopen the original image. */
1832 int rc2 = vhdxOpenImage(pImage, pImage->uOpenFlags);
1833 if (RT_FAILURE(rc2))
1834 rc = rc2;
1835 }
1836 else
1837 {
1838 /* Update pImage with the new information. */
1839 pImage->pszFilename = pszFilename;
1840
1841 /* Open the old image with new name. */
1842 rc = vhdxOpenImage(pImage, pImage->uOpenFlags);
1843 }
1844 }
1845 }
1846
1847 LogFlowFunc(("returns %Rrc\n", rc));
1848 return rc;
1849}
1850
1851/** @copydoc VBOXHDDBACKEND::pfnClose */
1852static int vhdxClose(void *pBackendData, bool fDelete)
1853{
1854 LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
1855 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1856 int rc;
1857
1858 rc = vhdxFreeImage(pImage, fDelete);
1859 RTMemFree(pImage);
1860
1861 LogFlowFunc(("returns %Rrc\n", rc));
1862 return rc;
1863}
1864
1865/** @copydoc VBOXHDDBACKEND::pfnRead */
1866static int vhdxRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
1867 PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
1868{
1869 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
1870 pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
1871 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1872 int rc = VINF_SUCCESS;
1873
1874 AssertPtr(pImage);
1875 Assert(uOffset % 512 == 0);
1876 Assert(cbToRead % 512 == 0);
1877
1878 if ( uOffset + cbToRead > pImage->cbSize
1879 || cbToRead == 0)
1880 rc = VERR_INVALID_PARAMETER;
1881 else
1882 {
1883 uint32_t idxBat = uOffset / pImage->cbBlock;
1884 uint32_t offRead = uOffset % pImage->cbBlock;
1885 uint64_t uBatEntry;
1886
1887 idxBat += idxBat / pImage->uChunkRatio; /* Add interleaving sector bitmap entries. */
1888 uBatEntry = pImage->paBat[idxBat].u64BatEntry;
1889
1890 cbToRead = RT_MIN(cbToRead, pImage->cbBlock - offRead);
1891
1892 switch (VHDX_BAT_ENTRY_GET_STATE(uBatEntry))
1893 {
1894 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_NOT_PRESENT:
1895 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_UNDEFINED:
1896 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_ZERO:
1897 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_UNMAPPED:
1898 {
1899 vdIfIoIntIoCtxSet(pImage->pIfIo, pIoCtx, 0, cbToRead);
1900 break;
1901 }
1902 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_FULLY_PRESENT:
1903 {
1904 uint64_t offFile = VHDX_BAT_ENTRY_GET_FILE_OFFSET(uBatEntry) + offRead;
1905 rc = vdIfIoIntFileReadUser(pImage->pIfIo, pImage->pStorage, offFile,
1906 pIoCtx, cbToRead);
1907 break;
1908 }
1909 case VHDX_BAT_ENTRY_PAYLOAD_BLOCK_PARTIALLY_PRESENT:
1910 default:
1911 rc = VERR_INVALID_PARAMETER;
1912 break;
1913 }
1914
1915 if (pcbActuallyRead)
1916 *pcbActuallyRead = cbToRead;
1917 }
1918
1919 LogFlowFunc(("returns %Rrc\n", rc));
1920 return rc;
1921}
1922
1923/** @copydoc VBOXHDDBACKEND::pfnWrite */
1924static int vhdxWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
1925 PVDIOCTX pIoCtx, size_t *pcbWriteProcess, size_t *pcbPreRead,
1926 size_t *pcbPostRead, unsigned fWrite)
1927{
1928 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
1929 pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
1930 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1931 int rc;
1932
1933 AssertPtr(pImage);
1934 Assert(uOffset % 512 == 0);
1935 Assert(cbToWrite % 512 == 0);
1936
1937 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1938 rc = VERR_VD_IMAGE_READ_ONLY;
1939 else if ( uOffset + cbToWrite > pImage->cbSize
1940 || cbToWrite == 0)
1941 rc = VERR_INVALID_PARAMETER;
1942 else
1943 rc = VERR_NOT_SUPPORTED;
1944
1945 LogFlowFunc(("returns %Rrc\n", rc));
1946 return rc;
1947}
1948
1949/** @copydoc VBOXHDDBACKEND::pfnFlush */
1950static int vhdxFlush(void *pBackendData, PVDIOCTX pIoCtx)
1951{
1952 LogFlowFunc(("pBackendData=%#p pIoCtx=%#p\n", pBackendData, pIoCtx));
1953 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1954 int rc;
1955
1956 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1957 rc = VERR_VD_IMAGE_READ_ONLY;
1958 else
1959 rc = VERR_NOT_SUPPORTED;
1960
1961 LogFlowFunc(("returns %Rrc\n", rc));
1962 return rc;
1963}
1964
1965/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
1966static unsigned vhdxGetVersion(void *pBackendData)
1967{
1968 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1969 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1970
1971 AssertPtr(pImage);
1972
1973 if (pImage)
1974 return pImage->uVersion;
1975 else
1976 return 0;
1977}
1978
1979/** @copydoc VBOXHDDBACKEND::pfnGetSize */
1980static uint64_t vhdxGetSize(void *pBackendData)
1981{
1982 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1983 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
1984 uint64_t cb = 0;
1985
1986 AssertPtr(pImage);
1987
1988 if (pImage && pImage->pStorage)
1989 cb = pImage->cbSize;
1990
1991 LogFlowFunc(("returns %llu\n", cb));
1992 return cb;
1993}
1994
1995/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
1996static uint64_t vhdxGetFileSize(void *pBackendData)
1997{
1998 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1999 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2000 uint64_t cb = 0;
2001
2002 AssertPtr(pImage);
2003
2004 if (pImage)
2005 {
2006 uint64_t cbFile;
2007 if (pImage->pStorage)
2008 {
2009 int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
2010 if (RT_SUCCESS(rc))
2011 cb = cbFile;
2012 }
2013 }
2014
2015 LogFlowFunc(("returns %lld\n", cb));
2016 return cb;
2017}
2018
2019/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
2020static int vhdxGetPCHSGeometry(void *pBackendData,
2021 PVDGEOMETRY pPCHSGeometry)
2022{
2023 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
2024 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2025 int rc;
2026
2027 AssertPtr(pImage);
2028
2029 if (pImage)
2030 {
2031 if (pImage->PCHSGeometry.cCylinders)
2032 {
2033 *pPCHSGeometry = pImage->PCHSGeometry;
2034 rc = VINF_SUCCESS;
2035 }
2036 else
2037 rc = VERR_VD_GEOMETRY_NOT_SET;
2038 }
2039 else
2040 rc = VERR_VD_NOT_OPENED;
2041
2042 LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
2043 return rc;
2044}
2045
2046/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
2047static int vhdxSetPCHSGeometry(void *pBackendData,
2048 PCVDGEOMETRY pPCHSGeometry)
2049{
2050 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
2051 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2052 int rc = VINF_SUCCESS;
2053
2054 AssertPtr(pImage);
2055
2056 if (pImage)
2057 {
2058 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2059 rc = VERR_VD_IMAGE_READ_ONLY;
2060 else
2061 pImage->PCHSGeometry = *pPCHSGeometry;
2062 }
2063 else
2064 rc = VERR_VD_NOT_OPENED;
2065
2066 LogFlowFunc(("returns %Rrc\n", rc));
2067 return rc;
2068}
2069
2070/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
2071static int vhdxGetLCHSGeometry(void *pBackendData,
2072 PVDGEOMETRY pLCHSGeometry)
2073{
2074 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
2075 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2076 int rc = VINF_SUCCESS;
2077
2078 AssertPtr(pImage);
2079
2080 if (pImage)
2081 {
2082 if (pImage->LCHSGeometry.cCylinders)
2083 *pLCHSGeometry = pImage->LCHSGeometry;
2084 else
2085 rc = VERR_VD_GEOMETRY_NOT_SET;
2086 }
2087 else
2088 rc = VERR_VD_NOT_OPENED;
2089
2090 LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2091 return rc;
2092}
2093
2094/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
2095static int vhdxSetLCHSGeometry(void *pBackendData,
2096 PCVDGEOMETRY pLCHSGeometry)
2097{
2098 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2099 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2100 int rc = VINF_SUCCESS;
2101
2102 AssertPtr(pImage);
2103
2104 if (pImage)
2105 {
2106 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2107 rc = VERR_VD_IMAGE_READ_ONLY;
2108 else
2109 pImage->LCHSGeometry = *pLCHSGeometry;
2110 }
2111 else
2112 rc = VERR_VD_NOT_OPENED;
2113
2114 LogFlowFunc(("returns %Rrc\n", rc));
2115 return rc;
2116}
2117
2118/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
2119static unsigned vhdxGetImageFlags(void *pBackendData)
2120{
2121 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2122 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2123 unsigned uImageFlags;
2124
2125 AssertPtr(pImage);
2126
2127 if (pImage)
2128 uImageFlags = pImage->uImageFlags;
2129 else
2130 uImageFlags = 0;
2131
2132 LogFlowFunc(("returns %#x\n", uImageFlags));
2133 return uImageFlags;
2134}
2135
2136/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
2137static unsigned vhdxGetOpenFlags(void *pBackendData)
2138{
2139 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2140 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2141 unsigned uOpenFlags;
2142
2143 AssertPtr(pImage);
2144
2145 if (pImage)
2146 uOpenFlags = pImage->uOpenFlags;
2147 else
2148 uOpenFlags = 0;
2149
2150 LogFlowFunc(("returns %#x\n", uOpenFlags));
2151 return uOpenFlags;
2152}
2153
2154/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
2155static int vhdxSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
2156{
2157 LogFlowFunc(("pBackendData=%#p\n uOpenFlags=%#x", pBackendData, uOpenFlags));
2158 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2159 int rc = VINF_SUCCESS;
2160
2161 /* Image must be opened and the new flags must be valid. */
2162 if (!pImage || (uOpenFlags & ~(VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS)))
2163 rc = VERR_INVALID_PARAMETER;
2164 else
2165 {
2166 /* Implement this operation via reopening the image. */
2167 rc = vhdxFreeImage(pImage, false);
2168 if (RT_SUCCESS(rc))
2169 rc = vhdxOpenImage(pImage, uOpenFlags);
2170 }
2171
2172 LogFlowFunc(("returns %Rrc\n", rc));
2173 return rc;
2174}
2175
2176/** @copydoc VBOXHDDBACKEND::pfnGetComment */
2177static int vhdxGetComment(void *pBackendData, char *pszComment,
2178 size_t cbComment)
2179{
2180 LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
2181 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2182 int rc;
2183
2184 AssertPtr(pImage);
2185
2186 if (pImage)
2187 rc = VERR_NOT_SUPPORTED;
2188 else
2189 rc = VERR_VD_NOT_OPENED;
2190
2191 LogFlowFunc(("returns %Rrc comment='%s'\n", rc, pszComment));
2192 return rc;
2193}
2194
2195/** @copydoc VBOXHDDBACKEND::pfnSetComment */
2196static int vhdxSetComment(void *pBackendData, const char *pszComment)
2197{
2198 LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
2199 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2200 int rc;
2201
2202 AssertPtr(pImage);
2203
2204 if (pImage)
2205 {
2206 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2207 rc = VERR_VD_IMAGE_READ_ONLY;
2208 else
2209 rc = VERR_NOT_SUPPORTED;
2210 }
2211 else
2212 rc = VERR_VD_NOT_OPENED;
2213
2214 LogFlowFunc(("returns %Rrc\n", rc));
2215 return rc;
2216}
2217
2218/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
2219static int vhdxGetUuid(void *pBackendData, PRTUUID pUuid)
2220{
2221 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2222 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2223 int rc;
2224
2225 AssertPtr(pImage);
2226
2227 if (pImage)
2228 rc = VERR_NOT_SUPPORTED;
2229 else
2230 rc = VERR_VD_NOT_OPENED;
2231
2232 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2233 return rc;
2234}
2235
2236/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
2237static int vhdxSetUuid(void *pBackendData, PCRTUUID pUuid)
2238{
2239 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2240 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2241 int rc;
2242
2243 LogFlowFunc(("%RTuuid\n", pUuid));
2244 AssertPtr(pImage);
2245
2246 if (pImage)
2247 {
2248 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2249 rc = VERR_NOT_SUPPORTED;
2250 else
2251 rc = VERR_VD_IMAGE_READ_ONLY;
2252 }
2253 else
2254 rc = VERR_VD_NOT_OPENED;
2255
2256 LogFlowFunc(("returns %Rrc\n", rc));
2257 return rc;
2258}
2259
2260/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
2261static int vhdxGetModificationUuid(void *pBackendData, PRTUUID pUuid)
2262{
2263 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2264 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2265 int rc;
2266
2267 AssertPtr(pImage);
2268
2269 if (pImage)
2270 rc = VERR_NOT_SUPPORTED;
2271 else
2272 rc = VERR_VD_NOT_OPENED;
2273
2274 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2275 return rc;
2276}
2277
2278/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
2279static int vhdxSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
2280{
2281 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2282 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2283 int rc;
2284
2285 AssertPtr(pImage);
2286
2287 if (pImage)
2288 {
2289 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2290 rc = VERR_NOT_SUPPORTED;
2291 else
2292 rc = VERR_VD_IMAGE_READ_ONLY;
2293 }
2294 else
2295 rc = VERR_VD_NOT_OPENED;
2296
2297 LogFlowFunc(("returns %Rrc\n", rc));
2298 return rc;
2299}
2300
2301/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
2302static int vhdxGetParentUuid(void *pBackendData, PRTUUID pUuid)
2303{
2304 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2305 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2306 int rc;
2307
2308 AssertPtr(pImage);
2309
2310 if (pImage)
2311 rc = VERR_NOT_SUPPORTED;
2312 else
2313 rc = VERR_VD_NOT_OPENED;
2314
2315 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2316 return rc;
2317}
2318
2319/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
2320static int vhdxSetParentUuid(void *pBackendData, PCRTUUID pUuid)
2321{
2322 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2323 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2324 int rc;
2325
2326 AssertPtr(pImage);
2327
2328 if (pImage)
2329 {
2330 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2331 rc = VERR_NOT_SUPPORTED;
2332 else
2333 rc = VERR_VD_IMAGE_READ_ONLY;
2334 }
2335 else
2336 rc = VERR_VD_NOT_OPENED;
2337
2338 LogFlowFunc(("returns %Rrc\n", rc));
2339 return rc;
2340}
2341
2342/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
2343static int vhdxGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
2344{
2345 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2346 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2347 int rc;
2348
2349 AssertPtr(pImage);
2350
2351 if (pImage)
2352 rc = VERR_NOT_SUPPORTED;
2353 else
2354 rc = VERR_VD_NOT_OPENED;
2355
2356 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2357 return rc;
2358}
2359
2360/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
2361static int vhdxSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
2362{
2363 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2364 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2365 int rc;
2366
2367 AssertPtr(pImage);
2368
2369 if (pImage)
2370 {
2371 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2372 rc = VERR_NOT_SUPPORTED;
2373 else
2374 rc = VERR_VD_IMAGE_READ_ONLY;
2375 }
2376 else
2377 rc = VERR_VD_NOT_OPENED;
2378
2379 LogFlowFunc(("returns %Rrc\n", rc));
2380 return rc;
2381}
2382
2383/** @copydoc VBOXHDDBACKEND::pfnDump */
2384static void vhdxDump(void *pBackendData)
2385{
2386 PVHDXIMAGE pImage = (PVHDXIMAGE)pBackendData;
2387
2388 AssertPtr(pImage);
2389 if (pImage)
2390 {
2391 vdIfErrorMessage(pImage->pIfError, "Header: Geometry PCHS=%u/%u/%u LCHS=%u/%u/%u cbSector=%zu\n",
2392 pImage->PCHSGeometry.cCylinders, pImage->PCHSGeometry.cHeads, pImage->PCHSGeometry.cSectors,
2393 pImage->LCHSGeometry.cCylinders, pImage->LCHSGeometry.cHeads, pImage->LCHSGeometry.cSectors,
2394 pImage->cbLogicalSector);
2395 }
2396}
2397
2398
2399VBOXHDDBACKEND g_VhdxBackend =
2400{
2401 /* pszBackendName */
2402 "VHDX",
2403 /* cbSize */
2404 sizeof(VBOXHDDBACKEND),
2405 /* uBackendCaps */
2406 VD_CAP_FILE | VD_CAP_VFS,
2407 /* paFileExtensions */
2408 s_aVhdxFileExtensions,
2409 /* paConfigInfo */
2410 NULL,
2411 /* hPlugin */
2412 NIL_RTLDRMOD,
2413 /* pfnCheckIfValid */
2414 vhdxCheckIfValid,
2415 /* pfnOpen */
2416 vhdxOpen,
2417 /* pfnCreate */
2418 NULL,
2419 /* pfnRename */
2420 vhdxRename,
2421 /* pfnClose */
2422 vhdxClose,
2423 /* pfnRead */
2424 vhdxRead,
2425 /* pfnWrite */
2426 vhdxWrite,
2427 /* pfnFlush */
2428 vhdxFlush,
2429 /* pfnDiscard */
2430 NULL,
2431 /* pfnGetVersion */
2432 vhdxGetVersion,
2433 /* pfnGetSize */
2434 vhdxGetSize,
2435 /* pfnGetFileSize */
2436 vhdxGetFileSize,
2437 /* pfnGetPCHSGeometry */
2438 vhdxGetPCHSGeometry,
2439 /* pfnSetPCHSGeometry */
2440 vhdxSetPCHSGeometry,
2441 /* pfnGetLCHSGeometry */
2442 vhdxGetLCHSGeometry,
2443 /* pfnSetLCHSGeometry */
2444 vhdxSetLCHSGeometry,
2445 /* pfnGetImageFlags */
2446 vhdxGetImageFlags,
2447 /* pfnGetOpenFlags */
2448 vhdxGetOpenFlags,
2449 /* pfnSetOpenFlags */
2450 vhdxSetOpenFlags,
2451 /* pfnGetComment */
2452 vhdxGetComment,
2453 /* pfnSetComment */
2454 vhdxSetComment,
2455 /* pfnGetUuid */
2456 vhdxGetUuid,
2457 /* pfnSetUuid */
2458 vhdxSetUuid,
2459 /* pfnGetModificationUuid */
2460 vhdxGetModificationUuid,
2461 /* pfnSetModificationUuid */
2462 vhdxSetModificationUuid,
2463 /* pfnGetParentUuid */
2464 vhdxGetParentUuid,
2465 /* pfnSetParentUuid */
2466 vhdxSetParentUuid,
2467 /* pfnGetParentModificationUuid */
2468 vhdxGetParentModificationUuid,
2469 /* pfnSetParentModificationUuid */
2470 vhdxSetParentModificationUuid,
2471 /* pfnDump */
2472 vhdxDump,
2473 /* pfnGetTimeStamp */
2474 NULL,
2475 /* pfnGetParentTimeStamp */
2476 NULL,
2477 /* pfnSetParentTimeStamp */
2478 NULL,
2479 /* pfnGetParentFilename */
2480 NULL,
2481 /* pfnSetParentFilename */
2482 NULL,
2483 /* pfnComposeLocation */
2484 genericFileComposeLocation,
2485 /* pfnComposeName */
2486 genericFileComposeName,
2487 /* pfnCompact */
2488 NULL,
2489 /* pfnResize */
2490 NULL,
2491 /* pfnRepair */
2492 NULL
2493};
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