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