VirtualBox

source: vbox/trunk/src/VBox/Storage/VDI.cpp@ 78296

Last change on this file since 78296 was 77622, checked in by vboxsync, 5 years ago

Bug fix/ syntax cleanup of AllocationBlockSize / createmedium property creation code
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 127.1 KB
Line 
1/* $Id: VDI.cpp 77622 2019-03-08 15:37:25Z vboxsync $ */
2/** @file
3 * Virtual Disk Image (VDI), Core Code.
4 */
5
6/*
7 * Copyright (C) 2006-2019 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_VDI
23#include <VBox/vd-plugin.h>
24#include "VDICore.h"
25#include <VBox/err.h>
26
27#include <VBox/log.h>
28#include <iprt/alloc.h>
29#include <iprt/assert.h>
30#include <iprt/uuid.h>
31#include <iprt/string.h>
32#include <iprt/asm.h>
33
34#include "VDBackends.h"
35
36#define VDI_IMAGE_DEFAULT_BLOCK_SIZE _1M
37
38/** Macros for endianess conversion. */
39#define SET_ENDIAN_U32(conv, u32) (conv == VDIECONV_H2F ? RT_H2LE_U32(u32) : RT_LE2H_U32(u32))
40#define SET_ENDIAN_U64(conv, u64) (conv == VDIECONV_H2F ? RT_H2LE_U64(u64) : RT_LE2H_U64(u64))
41
42static const char *vdiAllocationBlockSize = "1048576";
43
44static const VDCONFIGINFO vdiConfigInfo[] =
45{
46 { "AllocationBlockSize", vdiAllocationBlockSize, VDCFGVALUETYPE_INTEGER, 0 },
47 { NULL, NULL, VDCFGVALUETYPE_INTEGER, 0 }
48};
49
50
51/*********************************************************************************************************************************
52* Static Variables *
53*********************************************************************************************************************************/
54
55/** NULL-terminated array of supported file extensions. */
56static const VDFILEEXTENSION s_aVdiFileExtensions[] =
57{
58 {"vdi", VDTYPE_HDD},
59 {NULL, VDTYPE_INVALID}
60};
61
62
63/*********************************************************************************************************************************
64* Internal Functions *
65*********************************************************************************************************************************/
66static unsigned getPowerOfTwo(unsigned uNumber);
67static void vdiInitPreHeader(PVDIPREHEADER pPreHdr);
68static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr);
69static int vdiValidateHeader(PVDIHEADER pHeader);
70static void vdiSetupImageDesc(PVDIIMAGEDESC pImage);
71static int vdiUpdateHeader(PVDIIMAGEDESC pImage);
72static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock);
73static int vdiUpdateHeaderAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx);
74static int vdiUpdateBlockInfoAsync(PVDIIMAGEDESC pImage, unsigned uBlock, PVDIOCTX pIoCtx,
75 bool fUpdateHdr);
76
77/**
78 * Internal: Convert the PreHeader fields to the appropriate endianess.
79 * @param enmConv Direction of the conversion.
80 * @param pPreHdrConv Where to store the converted pre header.
81 * @param pPreHdr PreHeader pointer.
82 */
83static void vdiConvPreHeaderEndianess(VDIECONV enmConv, PVDIPREHEADER pPreHdrConv,
84 PVDIPREHEADER pPreHdr)
85{
86 memcpy(pPreHdrConv->szFileInfo, pPreHdr->szFileInfo, sizeof(pPreHdr->szFileInfo));
87 pPreHdrConv->u32Signature = SET_ENDIAN_U32(enmConv, pPreHdr->u32Signature);
88 pPreHdrConv->u32Version = SET_ENDIAN_U32(enmConv, pPreHdr->u32Version);
89}
90
91/**
92 * Internal: Convert the VDIDISKGEOMETRY fields to the appropriate endianess.
93 * @param enmConv Direction of the conversion.
94 * @param pDiskGeoConv Where to store the converted geometry.
95 * @param pDiskGeo Pointer to the disk geometry to convert.
96 */
97static void vdiConvGeometryEndianess(VDIECONV enmConv, PVDIDISKGEOMETRY pDiskGeoConv,
98 PVDIDISKGEOMETRY pDiskGeo)
99{
100 pDiskGeoConv->cCylinders = SET_ENDIAN_U32(enmConv, pDiskGeo->cCylinders);
101 pDiskGeoConv->cHeads = SET_ENDIAN_U32(enmConv, pDiskGeo->cHeads);
102 pDiskGeoConv->cSectors = SET_ENDIAN_U32(enmConv, pDiskGeo->cSectors);
103 pDiskGeoConv->cbSector = SET_ENDIAN_U32(enmConv, pDiskGeo->cbSector);
104}
105
106/**
107 * Internal: Convert the Header - version 0 fields to the appropriate endianess.
108 * @param enmConv Direction of the conversion.
109 * @param pHdrConv Where to store the converted header.
110 * @param pHdr Pointer to the version 0 header.
111 */
112static void vdiConvHeaderEndianessV0(VDIECONV enmConv, PVDIHEADER0 pHdrConv,
113 PVDIHEADER0 pHdr)
114{
115 memmove(pHdrConv->szComment, pHdr->szComment, sizeof(pHdr->szComment));
116 pHdrConv->u32Type = SET_ENDIAN_U32(enmConv, pHdr->u32Type);
117 pHdrConv->fFlags = SET_ENDIAN_U32(enmConv, pHdr->fFlags);
118 vdiConvGeometryEndianess(enmConv, &pHdrConv->LegacyGeometry, &pHdr->LegacyGeometry);
119 pHdrConv->cbDisk = SET_ENDIAN_U64(enmConv, pHdr->cbDisk);
120 pHdrConv->cbBlock = SET_ENDIAN_U32(enmConv, pHdr->cbBlock);
121 pHdrConv->cBlocks = SET_ENDIAN_U32(enmConv, pHdr->cBlocks);
122 pHdrConv->cBlocksAllocated = SET_ENDIAN_U32(enmConv, pHdr->cBlocksAllocated);
123 /* Don't convert the RTUUID fields. */
124 pHdrConv->uuidCreate = pHdr->uuidCreate;
125 pHdrConv->uuidModify = pHdr->uuidModify;
126 pHdrConv->uuidLinkage = pHdr->uuidLinkage;
127}
128
129/**
130 * Internal: Set the Header - version 1 fields to the appropriate endianess.
131 * @param enmConv Direction of the conversion.
132 * @param pHdrConv Where to store the converted header.
133 * @param pHdr Version 1 Header pointer.
134 */
135static void vdiConvHeaderEndianessV1(VDIECONV enmConv, PVDIHEADER1 pHdrConv,
136 PVDIHEADER1 pHdr)
137{
138 memmove(pHdrConv->szComment, pHdr->szComment, sizeof(pHdr->szComment));
139 pHdrConv->cbHeader = SET_ENDIAN_U32(enmConv, pHdr->cbHeader);
140 pHdrConv->u32Type = SET_ENDIAN_U32(enmConv, pHdr->u32Type);
141 pHdrConv->fFlags = SET_ENDIAN_U32(enmConv, pHdr->fFlags);
142 pHdrConv->offBlocks = SET_ENDIAN_U32(enmConv, pHdr->offBlocks);
143 pHdrConv->offData = SET_ENDIAN_U32(enmConv, pHdr->offData);
144 vdiConvGeometryEndianess(enmConv, &pHdrConv->LegacyGeometry, &pHdr->LegacyGeometry);
145 pHdrConv->u32Dummy = SET_ENDIAN_U32(enmConv, pHdr->u32Dummy);
146 pHdrConv->cbDisk = SET_ENDIAN_U64(enmConv, pHdr->cbDisk);
147 pHdrConv->cbBlock = SET_ENDIAN_U32(enmConv, pHdr->cbBlock);
148 pHdrConv->cbBlockExtra = SET_ENDIAN_U32(enmConv, pHdr->cbBlockExtra);
149 pHdrConv->cBlocks = SET_ENDIAN_U32(enmConv, pHdr->cBlocks);
150 pHdrConv->cBlocksAllocated = SET_ENDIAN_U32(enmConv, pHdr->cBlocksAllocated);
151 /* Don't convert the RTUUID fields. */
152 pHdrConv->uuidCreate = pHdr->uuidCreate;
153 pHdrConv->uuidModify = pHdr->uuidModify;
154 pHdrConv->uuidLinkage = pHdr->uuidLinkage;
155 pHdrConv->uuidParentModify = pHdr->uuidParentModify;
156}
157
158/**
159 * Internal: Set the Header - version 1plus fields to the appropriate endianess.
160 * @param enmConv Direction of the conversion.
161 * @param pHdrConv Where to store the converted header.
162 * @param pHdr Version 1+ Header pointer.
163 */
164static void vdiConvHeaderEndianessV1p(VDIECONV enmConv, PVDIHEADER1PLUS pHdrConv,
165 PVDIHEADER1PLUS pHdr)
166{
167 memmove(pHdrConv->szComment, pHdr->szComment, sizeof(pHdr->szComment));
168 pHdrConv->cbHeader = SET_ENDIAN_U32(enmConv, pHdr->cbHeader);
169 pHdrConv->u32Type = SET_ENDIAN_U32(enmConv, pHdr->u32Type);
170 pHdrConv->fFlags = SET_ENDIAN_U32(enmConv, pHdr->fFlags);
171 pHdrConv->offBlocks = SET_ENDIAN_U32(enmConv, pHdr->offBlocks);
172 pHdrConv->offData = SET_ENDIAN_U32(enmConv, pHdr->offData);
173 vdiConvGeometryEndianess(enmConv, &pHdrConv->LegacyGeometry, &pHdr->LegacyGeometry);
174 pHdrConv->u32Dummy = SET_ENDIAN_U32(enmConv, pHdr->u32Dummy);
175 pHdrConv->cbDisk = SET_ENDIAN_U64(enmConv, pHdr->cbDisk);
176 pHdrConv->cbBlock = SET_ENDIAN_U32(enmConv, pHdr->cbBlock);
177 pHdrConv->cbBlockExtra = SET_ENDIAN_U32(enmConv, pHdr->cbBlockExtra);
178 pHdrConv->cBlocks = SET_ENDIAN_U32(enmConv, pHdr->cBlocks);
179 pHdrConv->cBlocksAllocated = SET_ENDIAN_U32(enmConv, pHdr->cBlocksAllocated);
180 /* Don't convert the RTUUID fields. */
181 pHdrConv->uuidCreate = pHdr->uuidCreate;
182 pHdrConv->uuidModify = pHdr->uuidModify;
183 pHdrConv->uuidLinkage = pHdr->uuidLinkage;
184 pHdrConv->uuidParentModify = pHdr->uuidParentModify;
185 vdiConvGeometryEndianess(enmConv, &pHdrConv->LCHSGeometry, &pHdr->LCHSGeometry);
186}
187
188
189/**
190 * Internal: Set the appropriate endianess on all the Blocks pointed.
191 * @param enmConv Direction of the conversion.
192 * @param paBlocks Pointer to the block array.
193 * @param cEntries Number of entries in the block array.
194 *
195 * @note Unlike the other conversion functions this method does an in place conversion
196 * to avoid temporary memory allocations when writing the block array.
197 */
198static void vdiConvBlocksEndianess(VDIECONV enmConv, PVDIIMAGEBLOCKPOINTER paBlocks,
199 unsigned cEntries)
200{
201 for (unsigned i = 0; i < cEntries; i++)
202 paBlocks[i] = SET_ENDIAN_U32(enmConv, paBlocks[i]);
203}
204
205/**
206 * Internal: Flush the image file to disk.
207 */
208static void vdiFlushImage(PVDIIMAGEDESC pImage)
209{
210 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
211 {
212 /* Save header. */
213 int rc = vdiUpdateHeader(pImage);
214 AssertMsgRC(rc, ("vdiUpdateHeader() failed, filename=\"%s\", rc=%Rrc\n",
215 pImage->pszFilename, rc));
216 vdIfIoIntFileFlushSync(pImage->pIfIo, pImage->pStorage);
217 }
218}
219
220/**
221 * Internal: Free all allocated space for representing an image, and optionally
222 * delete the image from disk.
223 */
224static int vdiFreeImage(PVDIIMAGEDESC pImage, bool fDelete)
225{
226 int rc = VINF_SUCCESS;
227
228 /* Freeing a never allocated image (e.g. because the open failed) is
229 * not signalled as an error. After all nothing bad happens. */
230 if (pImage)
231 {
232 if (pImage->pStorage)
233 {
234 /* No point updating the file that is deleted anyway. */
235 if (!fDelete)
236 vdiFlushImage(pImage);
237
238 rc = vdIfIoIntFileClose(pImage->pIfIo, pImage->pStorage);
239 pImage->pStorage = NULL;
240 }
241
242 if (pImage->paBlocks)
243 {
244 RTMemFree(pImage->paBlocks);
245 pImage->paBlocks = NULL;
246 }
247
248 if (pImage->paBlocksRev)
249 {
250 RTMemFree(pImage->paBlocksRev);
251 pImage->paBlocksRev = NULL;
252 }
253
254 if (fDelete && pImage->pszFilename)
255 {
256 int rc2 = vdIfIoIntFileDelete(pImage->pIfIo, pImage->pszFilename);
257 if (RT_SUCCESS(rc))
258 rc = rc2;
259 }
260 }
261
262 LogFlowFunc(("returns %Rrc\n", rc));
263 return rc;
264}
265
266/**
267 * internal: return power of 2 or 0 if num error.
268 */
269static unsigned getPowerOfTwo(unsigned uNumber)
270{
271 if (uNumber == 0)
272 return 0;
273 unsigned uPower2 = 0;
274 while ((uNumber & 1) == 0)
275 {
276 uNumber >>= 1;
277 uPower2++;
278 }
279 return uNumber == 1 ? uPower2 : 0;
280}
281
282/**
283 * Internal: Init VDI preheader.
284 */
285static void vdiInitPreHeader(PVDIPREHEADER pPreHdr)
286{
287 pPreHdr->u32Signature = VDI_IMAGE_SIGNATURE;
288 pPreHdr->u32Version = VDI_IMAGE_VERSION;
289 memset(pPreHdr->szFileInfo, 0, sizeof(pPreHdr->szFileInfo));
290 strncat(pPreHdr->szFileInfo, VDI_IMAGE_FILE_INFO, sizeof(pPreHdr->szFileInfo)-1);
291}
292
293/**
294 * Internal: check VDI preheader.
295 */
296static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr)
297{
298 if (pPreHdr->u32Signature != VDI_IMAGE_SIGNATURE)
299 return VERR_VD_VDI_INVALID_HEADER;
300
301 if ( VDI_GET_VERSION_MAJOR(pPreHdr->u32Version) != VDI_IMAGE_VERSION_MAJOR
302 && pPreHdr->u32Version != 0x00000002) /* old version. */
303 return VERR_VD_VDI_UNSUPPORTED_VERSION;
304
305 return VINF_SUCCESS;
306}
307
308/**
309 * Internal: translate VD image flags to VDI image type enum.
310 */
311static VDIIMAGETYPE vdiTranslateImageFlags2VDI(unsigned uImageFlags)
312{
313 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
314 return VDI_IMAGE_TYPE_FIXED;
315 else if (uImageFlags & VD_IMAGE_FLAGS_DIFF)
316 return VDI_IMAGE_TYPE_DIFF;
317 else
318 return VDI_IMAGE_TYPE_NORMAL;
319}
320
321/**
322 * Internal: translate VDI image type enum to VD image type enum.
323 */
324static unsigned vdiTranslateVDI2ImageFlags(VDIIMAGETYPE enmType)
325{
326 switch (enmType)
327 {
328 case VDI_IMAGE_TYPE_NORMAL:
329 return VD_IMAGE_FLAGS_NONE;
330 case VDI_IMAGE_TYPE_FIXED:
331 return VD_IMAGE_FLAGS_FIXED;
332 case VDI_IMAGE_TYPE_DIFF:
333 return VD_IMAGE_FLAGS_DIFF;
334 default:
335 AssertMsgFailed(("invalid VDIIMAGETYPE enmType=%d\n", (int)enmType));
336 return VD_IMAGE_FLAGS_NONE;
337 }
338}
339
340/**
341 * Internal: Init VDI header. Always use latest header version.
342 *
343 * @returns nothing.
344 * @param pHeader Assumes it was initially initialized to all zeros.
345 * @param uImageFlags Flags for this image.
346 * @param pszComment Optional comment to set for the image.
347 * @param cbDisk Size of the disk in bytes.
348 * @param cbBlock Size of one block in the image.
349 * @param cbBlockExtra Extra data for one block private to the image.
350 * @param cbDataAlign The alignment for all data structures.
351 */
352static void vdiInitHeader(PVDIHEADER pHeader, uint32_t uImageFlags,
353 const char *pszComment, uint64_t cbDisk,
354 uint32_t cbBlock, uint32_t cbBlockExtra,
355 uint32_t cbDataAlign)
356{
357 pHeader->uVersion = VDI_IMAGE_VERSION;
358 pHeader->u.v1plus.cbHeader = sizeof(VDIHEADER1PLUS);
359 pHeader->u.v1plus.u32Type = (uint32_t)vdiTranslateImageFlags2VDI(uImageFlags);
360 pHeader->u.v1plus.fFlags = (uImageFlags & VD_VDI_IMAGE_FLAGS_ZERO_EXPAND) ? 1 : 0;
361#ifdef VBOX_STRICT
362 char achZero[VDI_IMAGE_COMMENT_SIZE] = {0};
363 Assert(!memcmp(pHeader->u.v1plus.szComment, achZero, VDI_IMAGE_COMMENT_SIZE));
364#endif
365 pHeader->u.v1plus.szComment[0] = '\0';
366 if (pszComment)
367 {
368 AssertMsg(strlen(pszComment) < sizeof(pHeader->u.v1plus.szComment),
369 ("HDD Comment is too long, cb=%d\n", strlen(pszComment)));
370 strncat(pHeader->u.v1plus.szComment, pszComment, sizeof(pHeader->u.v1plus.szComment)-1);
371 }
372
373 /* Mark the legacy geometry not-calculated. */
374 pHeader->u.v1plus.LegacyGeometry.cCylinders = 0;
375 pHeader->u.v1plus.LegacyGeometry.cHeads = 0;
376 pHeader->u.v1plus.LegacyGeometry.cSectors = 0;
377 pHeader->u.v1plus.LegacyGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
378 pHeader->u.v1plus.u32Dummy = 0; /* used to be the translation value */
379
380 pHeader->u.v1plus.cbDisk = cbDisk;
381 pHeader->u.v1plus.cbBlock = cbBlock;
382 pHeader->u.v1plus.cBlocks = (uint32_t)(cbDisk / cbBlock);
383 if (cbDisk % cbBlock)
384 pHeader->u.v1plus.cBlocks++;
385 pHeader->u.v1plus.cbBlockExtra = cbBlockExtra;
386 pHeader->u.v1plus.cBlocksAllocated = 0;
387
388 /* Init offsets. */
389 pHeader->u.v1plus.offBlocks = RT_ALIGN_32(sizeof(VDIPREHEADER) + sizeof(VDIHEADER1PLUS), cbDataAlign);
390 pHeader->u.v1plus.offData = RT_ALIGN_32(pHeader->u.v1plus.offBlocks + (pHeader->u.v1plus.cBlocks * sizeof(VDIIMAGEBLOCKPOINTER)), cbDataAlign);
391
392 /* Init uuids. */
393#ifdef _MSC_VER
394# pragma warning(disable:4366) /* (harmless "misalignment") */
395#endif
396 RTUuidCreate(&pHeader->u.v1plus.uuidCreate);
397 RTUuidClear(&pHeader->u.v1plus.uuidModify);
398 RTUuidClear(&pHeader->u.v1plus.uuidLinkage);
399 RTUuidClear(&pHeader->u.v1plus.uuidParentModify);
400#ifdef _MSC_VER
401# pragma warning(default:4366)
402#endif
403
404 /* Mark LCHS geometry not-calculated. */
405 pHeader->u.v1plus.LCHSGeometry.cCylinders = 0;
406 pHeader->u.v1plus.LCHSGeometry.cHeads = 0;
407 pHeader->u.v1plus.LCHSGeometry.cSectors = 0;
408 pHeader->u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
409}
410
411/**
412 * Internal: Check VDI header.
413 */
414static int vdiValidateHeader(PVDIHEADER pHeader)
415{
416 /* Check version-dependent header parameters. */
417 switch (GET_MAJOR_HEADER_VERSION(pHeader))
418 {
419 case 0:
420 {
421 /* Old header version. */
422 break;
423 }
424 case 1:
425 {
426 /* Current header version. */
427
428 if (pHeader->u.v1.cbHeader < sizeof(VDIHEADER1))
429 {
430 LogRel(("VDI: v1 header size wrong (%d < %d)\n",
431 pHeader->u.v1.cbHeader, sizeof(VDIHEADER1)));
432 return VERR_VD_VDI_INVALID_HEADER;
433 }
434
435 if (getImageBlocksOffset(pHeader) < (sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)))
436 {
437 LogRel(("VDI: v1 blocks offset wrong (%d < %d)\n",
438 getImageBlocksOffset(pHeader), sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)));
439 return VERR_VD_VDI_INVALID_HEADER;
440 }
441
442 if (getImageDataOffset(pHeader) < (getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)))
443 {
444 LogRel(("VDI: v1 image data offset wrong (%d < %d)\n",
445 getImageDataOffset(pHeader), getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)));
446 return VERR_VD_VDI_INVALID_HEADER;
447 }
448
449 break;
450 }
451 default:
452 /* Unsupported. */
453 return VERR_VD_VDI_UNSUPPORTED_VERSION;
454 }
455
456 /* Check common header parameters. */
457
458 bool fFailed = false;
459
460 if ( getImageType(pHeader) < VDI_IMAGE_TYPE_FIRST
461 || getImageType(pHeader) > VDI_IMAGE_TYPE_LAST)
462 {
463 LogRel(("VDI: bad image type %d\n", getImageType(pHeader)));
464 fFailed = true;
465 }
466
467 if (getImageFlags(pHeader) & ~VD_VDI_IMAGE_FLAGS_MASK)
468 {
469 LogRel(("VDI: bad image flags %08x\n", getImageFlags(pHeader)));
470 fFailed = true;
471 }
472
473 if ( getImageLCHSGeometry(pHeader)
474 && (getImageLCHSGeometry(pHeader))->cbSector != VDI_GEOMETRY_SECTOR_SIZE)
475 {
476 LogRel(("VDI: wrong sector size (%d != %d)\n",
477 (getImageLCHSGeometry(pHeader))->cbSector, VDI_GEOMETRY_SECTOR_SIZE));
478 fFailed = true;
479 }
480
481 if ( getImageDiskSize(pHeader) == 0
482 || getImageBlockSize(pHeader) == 0
483 || getImageBlocks(pHeader) == 0
484 || getPowerOfTwo(getImageBlockSize(pHeader)) == 0)
485 {
486 LogRel(("VDI: wrong size (%lld, %d, %d, %d)\n",
487 getImageDiskSize(pHeader), getImageBlockSize(pHeader),
488 getImageBlocks(pHeader), getPowerOfTwo(getImageBlockSize(pHeader))));
489 fFailed = true;
490 }
491
492 if (getImageBlocksAllocated(pHeader) > getImageBlocks(pHeader))
493 {
494 LogRel(("VDI: too many blocks allocated (%d > %d)\n"
495 " blocksize=%d disksize=%lld\n",
496 getImageBlocksAllocated(pHeader), getImageBlocks(pHeader),
497 getImageBlockSize(pHeader), getImageDiskSize(pHeader)));
498 fFailed = true;
499 }
500
501 if ( getImageExtraBlockSize(pHeader) != 0
502 && getPowerOfTwo(getImageExtraBlockSize(pHeader)) == 0)
503 {
504 LogRel(("VDI: wrong extra size (%d, %d)\n",
505 getImageExtraBlockSize(pHeader), getPowerOfTwo(getImageExtraBlockSize(pHeader))));
506 fFailed = true;
507 }
508
509 if ((uint64_t)getImageBlockSize(pHeader) * getImageBlocks(pHeader) < getImageDiskSize(pHeader))
510 {
511 LogRel(("VDI: wrong disk size (%d, %d, %lld)\n",
512 getImageBlockSize(pHeader), getImageBlocks(pHeader), getImageDiskSize(pHeader)));
513 fFailed = true;
514 }
515
516 if (RTUuidIsNull(getImageCreationUUID(pHeader)))
517 {
518 LogRel(("VDI: uuid of creator is 0\n"));
519 fFailed = true;
520 }
521
522 if (RTUuidIsNull(getImageModificationUUID(pHeader)))
523 {
524 LogRel(("VDI: uuid of modifier is 0\n"));
525 fFailed = true;
526 }
527
528 return fFailed ? VERR_VD_VDI_INVALID_HEADER : VINF_SUCCESS;
529}
530
531/**
532 * Internal: Set up VDIIMAGEDESC structure by image header.
533 */
534static void vdiSetupImageDesc(PVDIIMAGEDESC pImage)
535{
536 pImage->uImageFlags = getImageFlags(&pImage->Header);
537 pImage->uImageFlags |= vdiTranslateVDI2ImageFlags(getImageType(&pImage->Header));
538 pImage->offStartBlocks = getImageBlocksOffset(&pImage->Header);
539 pImage->offStartData = getImageDataOffset(&pImage->Header);
540 pImage->uBlockMask = getImageBlockSize(&pImage->Header) - 1;
541 pImage->uShiftOffset2Index = getPowerOfTwo(getImageBlockSize(&pImage->Header));
542 pImage->offStartBlockData = getImageExtraBlockSize(&pImage->Header);
543 pImage->cbTotalBlockData = pImage->offStartBlockData
544 + getImageBlockSize(&pImage->Header);
545}
546
547/**
548 * Sets up the complete image state from the given parameters.
549 *
550 * @returns VBox status code.
551 * @param pImage The VDI image descriptor.
552 * @param uImageFlags Image flags.
553 * @param pszComment The comment for the image (optional).
554 * @param cbSize Size of the resulting image in bytes.
555 * @param cbAllocationBlock Size of blocks allocated
556 * @param cbDataAlign Data alignment in bytes.
557 * @param pPCHSGeometry Physical CHS geometry for the image.
558 * @param pLCHSGeometry Logical CHS geometry for the image.
559 */
560static int vdiSetupImageState(PVDIIMAGEDESC pImage, unsigned uImageFlags, const char *pszComment,
561 uint64_t cbSize, uint32_t cbAllocationBlock, uint32_t cbDataAlign, PCVDGEOMETRY pPCHSGeometry,
562 PCVDGEOMETRY pLCHSGeometry)
563{
564 int rc = VINF_SUCCESS;
565
566 vdiInitPreHeader(&pImage->PreHeader);
567 vdiInitHeader(&pImage->Header, uImageFlags, pszComment, cbSize, cbAllocationBlock, 0,
568 cbDataAlign);
569 /* Save PCHS geometry. Not much work, and makes the flow of information
570 * quite a bit clearer - relying on the higher level isn't obvious. */
571 pImage->PCHSGeometry = *pPCHSGeometry;
572 /* Set LCHS geometry (legacy geometry is ignored for the current 1.1+). */
573 pImage->Header.u.v1plus.LCHSGeometry.cCylinders = pLCHSGeometry->cCylinders;
574 pImage->Header.u.v1plus.LCHSGeometry.cHeads = pLCHSGeometry->cHeads;
575 pImage->Header.u.v1plus.LCHSGeometry.cSectors = pLCHSGeometry->cSectors;
576 pImage->Header.u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
577
578 pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
579 if (RT_LIKELY(pImage->paBlocks))
580 {
581 if (!(uImageFlags & VD_IMAGE_FLAGS_FIXED))
582 {
583 /* for growing images mark all blocks in paBlocks as free. */
584 for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
585 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
586 }
587 else
588 {
589 /* for fixed images mark all blocks in paBlocks as allocated */
590 for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
591 pImage->paBlocks[i] = i;
592 pImage->Header.u.v1.cBlocksAllocated = pImage->Header.u.v1.cBlocks;
593 }
594
595 /* Setup image parameters. */
596 vdiSetupImageDesc(pImage);
597 }
598 else
599 rc = VERR_NO_MEMORY;
600
601 return rc;
602}
603
604/**
605 * Creates the image file from the given descriptor.
606 *
607 * @returns VBox status code.
608 * @param pImage The VDI image descriptor.
609 * @param uOpenFlags Open flags.
610 * @param pIfProgress The progress interface.
611 * @param uPercentStart Progress starting point.
612 * @param uPercentSpan How many percent for this part of the operation is used.
613 */
614static int vdiImageCreateFile(PVDIIMAGEDESC pImage, unsigned uOpenFlags,
615 PVDINTERFACEPROGRESS pIfProgress, unsigned uPercentStart,
616 unsigned uPercentSpan)
617{
618 int rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
619 VDOpenFlagsToFileOpenFlags(uOpenFlags & ~VD_OPEN_FLAGS_READONLY,
620 true /* fCreate */),
621 &pImage->pStorage);
622 if (RT_SUCCESS(rc))
623 {
624 if (pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED)
625 {
626 uint64_t cbTotal = pImage->offStartData
627 + (uint64_t)getImageBlocks(&pImage->Header) * pImage->cbTotalBlockData;
628
629 /* Check the free space on the disk and leave early if there is not
630 * sufficient space available. */
631 int64_t cbFree = 0;
632 rc = vdIfIoIntFileGetFreeSpace(pImage->pIfIo, pImage->pszFilename, &cbFree);
633 if (RT_SUCCESS(rc) /* ignore errors */ && ((uint64_t)cbFree < cbTotal))
634 rc = vdIfError(pImage->pIfError, VERR_DISK_FULL, RT_SRC_POS,
635 N_("VDI: disk would overflow creating image '%s'"), pImage->pszFilename);
636 else
637 {
638 /*
639 * Allocate & commit whole file if fixed image, it must be more
640 * effective than expanding file by write operations.
641 */
642 rc = vdIfIoIntFileSetAllocationSize(pImage->pIfIo, pImage->pStorage, cbTotal, 0 /* fFlags */,
643 pIfProgress, uPercentStart, uPercentSpan);
644 pImage->cbImage = cbTotal;
645 }
646 }
647 else
648 {
649 /* Set file size to hold header and blocks array. */
650 rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage, pImage->offStartData);
651 pImage->cbImage = pImage->offStartData;
652 }
653 if (RT_SUCCESS(rc))
654 {
655 /* Write pre-header. */
656 VDIPREHEADER PreHeader;
657 vdiConvPreHeaderEndianess(VDIECONV_H2F, &PreHeader, &pImage->PreHeader);
658 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, 0,
659 &PreHeader, sizeof(PreHeader));
660 if (RT_SUCCESS(rc))
661 {
662 /* Write header. */
663 VDIHEADER1PLUS Hdr;
664 vdiConvHeaderEndianessV1p(VDIECONV_H2F, &Hdr, &pImage->Header.u.v1plus);
665 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, sizeof(pImage->PreHeader),
666 &Hdr, sizeof(Hdr));
667 if (RT_SUCCESS(rc))
668 {
669 vdiConvBlocksEndianess(VDIECONV_H2F, pImage->paBlocks, getImageBlocks(&pImage->Header));
670 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, pImage->offStartBlocks, pImage->paBlocks,
671 getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER));
672 vdiConvBlocksEndianess(VDIECONV_F2H, pImage->paBlocks, getImageBlocks(&pImage->Header));
673 if (RT_FAILURE(rc))
674 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: writing block pointers failed for '%s'"),
675 pImage->pszFilename);
676 }
677 else
678 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: writing header failed for '%s'"),
679 pImage->pszFilename);
680 }
681 else
682 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: writing pre-header failed for '%s'"),
683 pImage->pszFilename);
684 }
685 else
686 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: setting image size failed for '%s'"),
687 pImage->pszFilename);
688 }
689 else
690 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: cannot create image '%s'"),
691 pImage->pszFilename);
692
693 return rc;
694}
695
696/**
697 * Internal: Create VDI image file.
698 */
699static int vdiCreateImage(PVDIIMAGEDESC pImage, uint64_t cbSize,
700 unsigned uImageFlags, const char *pszComment,
701 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
702 PCRTUUID pUuid, unsigned uOpenFlags,
703 PVDINTERFACEPROGRESS pIfProgress, unsigned uPercentStart,
704 unsigned uPercentSpan, PVDINTERFACECONFIG pIfCfg)
705{
706 int rc = VINF_SUCCESS;
707 uint32_t cbDataAlign = VDI_DATA_ALIGN;
708 uint32_t cbAllocationBlock = VDI_IMAGE_DEFAULT_BLOCK_SIZE;
709 AssertPtr(pPCHSGeometry);
710 AssertPtr(pLCHSGeometry);
711
712 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
713 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
714 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
715
716 /* Special check for comment length. */
717 if ( VALID_PTR(pszComment)
718 && strlen(pszComment) >= VDI_IMAGE_COMMENT_SIZE)
719 rc = vdIfError(pImage->pIfError, VERR_VD_VDI_COMMENT_TOO_LONG, RT_SRC_POS,
720 N_("VDI: comment is too long for '%s'"), pImage->pszFilename);
721
722 PVDINTERFACECONFIG pImgCfg = VDIfConfigGet(pImage->pVDIfsImage);
723 if (pImgCfg)
724 {
725 rc = VDCFGQueryU32Def(pImgCfg, "AllocationBlockSize", &cbAllocationBlock, VDI_IMAGE_DEFAULT_BLOCK_SIZE);
726 if (RT_FAILURE(rc))
727 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
728 N_("VDI: Getting AllocationBlockSize for '%s' failed (%Rrc)"), pImage->pszFilename, rc);
729 }
730
731 if (pIfCfg)
732 {
733 rc = VDCFGQueryU32Def(pIfCfg, "DataAlignment", &cbDataAlign, VDI_DATA_ALIGN);
734 if (RT_FAILURE(rc))
735 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
736 N_("VDI: Getting data alignment for '%s' failed (%Rrc)"), pImage->pszFilename, rc);
737 }
738
739 if (RT_SUCCESS(rc))
740 {
741
742 rc = vdiSetupImageState(pImage, uImageFlags, pszComment, cbSize,
743 cbAllocationBlock, cbDataAlign, pPCHSGeometry, pLCHSGeometry);
744 if (RT_SUCCESS(rc))
745 {
746 /* Use specified image uuid */
747 *getImageCreationUUID(&pImage->Header) = *pUuid;
748 /* Generate image last-modify uuid */
749 RTUuidCreate(getImageModificationUUID(&pImage->Header));
750
751 rc = vdiImageCreateFile(pImage, uOpenFlags, pIfProgress,
752 uPercentStart, uPercentSpan);
753 }
754 }
755
756 if (RT_SUCCESS(rc))
757 {
758 PVDREGIONDESC pRegion = &pImage->RegionList.aRegions[0];
759 pImage->RegionList.fFlags = 0;
760 pImage->RegionList.cRegions = 1;
761
762 pRegion->offRegion = 0; /* Disk start. */
763 pRegion->cbBlock = 512;
764 pRegion->enmDataForm = VDREGIONDATAFORM_RAW;
765 pRegion->enmMetadataForm = VDREGIONMETADATAFORM_NONE;
766 pRegion->cbData = 512;
767 pRegion->cbMetadata = 0;
768 pRegion->cRegionBlocksOrBytes = getImageDiskSize(&pImage->Header);
769
770 vdIfProgress(pIfProgress, uPercentStart + uPercentSpan);
771 }
772
773 if (RT_FAILURE(rc))
774 vdiFreeImage(pImage, rc != VERR_ALREADY_EXISTS);
775 return rc;
776}
777
778/**
779 * Reads and validates the header for the given image descriptor.
780 *
781 * @returns VBox status code.
782 * @param pImage The VDI image descriptor.
783 */
784static int vdiImageReadHeader(PVDIIMAGEDESC pImage)
785{
786 /* Get file size. */
787 int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage,
788 &pImage->cbImage);
789 if (RT_SUCCESS(rc))
790 {
791 /* Read pre-header. */
792 VDIPREHEADER PreHeader;
793 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, 0,
794 &PreHeader, sizeof(PreHeader));
795 if (RT_SUCCESS(rc))
796 {
797 vdiConvPreHeaderEndianess(VDIECONV_F2H, &pImage->PreHeader, &PreHeader);
798 rc = vdiValidatePreHeader(&pImage->PreHeader);
799 if (RT_SUCCESS(rc))
800 {
801 /* Read header. */
802 pImage->Header.uVersion = pImage->PreHeader.u32Version;
803 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
804 {
805 case 0:
806 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, sizeof(pImage->PreHeader),
807 &pImage->Header.u.v0, sizeof(pImage->Header.u.v0));
808 if (RT_SUCCESS(rc))
809 vdiConvHeaderEndianessV0(VDIECONV_F2H, &pImage->Header.u.v0, &pImage->Header.u.v0);
810 else
811 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: error reading v0 header in '%s'"), pImage->pszFilename);
812 break;
813 case 1:
814 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, sizeof(pImage->PreHeader),
815 &pImage->Header.u.v1, sizeof(pImage->Header.u.v1));
816 if (RT_SUCCESS(rc))
817 {
818 vdiConvHeaderEndianessV1(VDIECONV_F2H, &pImage->Header.u.v1, &pImage->Header.u.v1);
819 /* Convert VDI 1.1 images to VDI 1.1+ on open in read/write mode.
820 * Conversion is harmless, as any VirtualBox version supporting VDI
821 * 1.1 doesn't touch fields it doesn't know about. */
822 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
823 && GET_MINOR_HEADER_VERSION(&pImage->Header) == 1
824 && pImage->Header.u.v1.cbHeader < sizeof(pImage->Header.u.v1plus))
825 {
826 pImage->Header.u.v1plus.cbHeader = sizeof(pImage->Header.u.v1plus);
827 /* Mark LCHS geometry not-calculated. */
828 pImage->Header.u.v1plus.LCHSGeometry.cCylinders = 0;
829 pImage->Header.u.v1plus.LCHSGeometry.cHeads = 0;
830 pImage->Header.u.v1plus.LCHSGeometry.cSectors = 0;
831 pImage->Header.u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
832 }
833 else if (pImage->Header.u.v1.cbHeader >= sizeof(pImage->Header.u.v1plus))
834 {
835 /* Read the actual VDI 1.1+ header completely. */
836 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, sizeof(pImage->PreHeader),
837 &pImage->Header.u.v1plus,
838 sizeof(pImage->Header.u.v1plus));
839 if (RT_SUCCESS(rc))
840 vdiConvHeaderEndianessV1p(VDIECONV_F2H, &pImage->Header.u.v1plus, &pImage->Header.u.v1plus);
841 else
842 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: error reading v1.1+ header in '%s'"), pImage->pszFilename);
843 }
844 }
845 else
846 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: error reading v1 header in '%s'"), pImage->pszFilename);
847 break;
848 default:
849 rc = vdIfError(pImage->pIfError, VERR_VD_VDI_UNSUPPORTED_VERSION, RT_SRC_POS,
850 N_("VDI: unsupported major version %u in '%s'"), GET_MAJOR_HEADER_VERSION(&pImage->Header), pImage->pszFilename);
851 }
852
853 if (RT_SUCCESS(rc))
854 {
855 rc = vdiValidateHeader(&pImage->Header);
856 if (RT_SUCCESS(rc))
857 {
858 /* Setup image parameters by header. */
859 vdiSetupImageDesc(pImage);
860
861 /*
862 * Until revision r111992 there was no check that the size was sector aligned
863 * when creating a new image and a bug in the VirtualBox GUI on OS X resulted
864 * in such images being created which caused issues when writing to the
865 * end of the image.
866 *
867 * Detect such images and repair the small damage by rounding down to the next
868 * aligned size. This is no problem as the guest would see a sector count
869 * only anyway from the device emulations so it already sees only the smaller
870 * size as result of the integer division of the size and sector size.
871 *
872 * This might not be written to the image if it is opened readonly
873 * which is not much of a problem because only writing to the last block
874 * causes trouble.
875 */
876 uint64_t cbDisk = getImageDiskSize(&pImage->Header);
877 if (cbDisk & 0x1ff)
878 setImageDiskSize(&pImage->Header, cbDisk & ~UINT64_C(0x1ff));
879 }
880 else
881 rc = vdIfError(pImage->pIfError, VERR_VD_VDI_INVALID_HEADER, RT_SRC_POS,
882 N_("VDI: invalid header in '%s'"), pImage->pszFilename);
883 }
884 }
885 else
886 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: invalid pre-header in '%s'"), pImage->pszFilename);
887 }
888 else
889 {
890 vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: error reading pre-header in '%s'"), pImage->pszFilename);
891 rc = VERR_VD_VDI_INVALID_HEADER;
892 }
893 }
894 else
895 {
896 vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: error getting the image size in '%s'"), pImage->pszFilename);
897 rc = VERR_VD_VDI_INVALID_HEADER;
898 }
899
900 return rc;
901}
902
903/**
904 * Creates the back resolving table for the image for the discard operation.
905 *
906 * @returns VBox status code.
907 * @param pImage The VDI image descriptor.
908 */
909static int vdiImageBackResolvTblCreate(PVDIIMAGEDESC pImage)
910{
911 int rc = VINF_SUCCESS;
912
913 /*
914 * Any error or inconsistency results in a fail because this might
915 * get us into trouble later on.
916 */
917 pImage->paBlocksRev = (unsigned *)RTMemAllocZ(sizeof(unsigned) * getImageBlocks(&pImage->Header));
918 if (pImage->paBlocksRev)
919 {
920 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
921 unsigned cBlocks = getImageBlocks(&pImage->Header);
922
923 for (unsigned i = 0; i < cBlocks; i++)
924 pImage->paBlocksRev[i] = VDI_IMAGE_BLOCK_FREE;
925
926 for (unsigned i = 0; i < cBlocks; i++)
927 {
928 VDIIMAGEBLOCKPOINTER ptrBlock = pImage->paBlocks[i];
929 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock))
930 {
931 if (ptrBlock < cBlocksAllocated)
932 {
933 if (pImage->paBlocksRev[ptrBlock] == VDI_IMAGE_BLOCK_FREE)
934 pImage->paBlocksRev[ptrBlock] = i;
935 else
936 {
937 rc = VERR_VD_VDI_INVALID_HEADER;
938 break;
939 }
940 }
941 else
942 {
943 rc = VERR_VD_VDI_INVALID_HEADER;
944 break;
945 }
946 }
947 }
948 }
949 else
950 rc = VERR_NO_MEMORY;
951
952 return rc;
953}
954
955/**
956 * Internal: Open a VDI image.
957 */
958static int vdiOpenImage(PVDIIMAGEDESC pImage, unsigned uOpenFlags)
959{
960 pImage->uOpenFlags = uOpenFlags;
961
962 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
963 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
964 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
965
966 /*
967 * Open the image.
968 */
969 int rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
970 VDOpenFlagsToFileOpenFlags(uOpenFlags, false /* fCreate */),
971 &pImage->pStorage);
972 if (RT_SUCCESS(rc))
973 {
974 rc = vdiImageReadHeader(pImage);
975 if (RT_SUCCESS(rc))
976 {
977 /* Allocate memory for blocks array. */
978 pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
979 if (RT_LIKELY(pImage->paBlocks))
980 {
981 /* Read blocks array. */
982 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, pImage->offStartBlocks, pImage->paBlocks,
983 getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER));
984 if (RT_SUCCESS(rc))
985 {
986 vdiConvBlocksEndianess(VDIECONV_F2H, pImage->paBlocks, getImageBlocks(&pImage->Header));
987
988 if (uOpenFlags & VD_OPEN_FLAGS_DISCARD)
989 rc = vdiImageBackResolvTblCreate(pImage);
990 }
991 else
992 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VDI: Error reading the block table in '%s'"), pImage->pszFilename);
993 }
994 else
995 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
996 N_("VDI: Error allocating memory for the block table in '%s'"), pImage->pszFilename);;
997 }
998 }
999 /* else: Do NOT signal an appropriate error here, as the VD layer has the
1000 * choice of retrying the open if it failed. */
1001
1002 if (RT_SUCCESS(rc))
1003 {
1004 PVDREGIONDESC pRegion = &pImage->RegionList.aRegions[0];
1005 pImage->RegionList.fFlags = 0;
1006 pImage->RegionList.cRegions = 1;
1007
1008 pRegion->offRegion = 0; /* Disk start. */
1009 pRegion->cbBlock = 512;
1010 pRegion->enmDataForm = VDREGIONDATAFORM_RAW;
1011 pRegion->enmMetadataForm = VDREGIONMETADATAFORM_NONE;
1012 pRegion->cbData = 512;
1013 pRegion->cbMetadata = 0;
1014 pRegion->cRegionBlocksOrBytes = getImageDiskSize(&pImage->Header);
1015 }
1016 else
1017 vdiFreeImage(pImage, false);
1018 return rc;
1019}
1020
1021/**
1022 * Internal: Save header to file.
1023 */
1024static int vdiUpdateHeader(PVDIIMAGEDESC pImage)
1025{
1026 int rc;
1027 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
1028 {
1029 case 0:
1030 {
1031 VDIHEADER0 Hdr;
1032 vdiConvHeaderEndianessV0(VDIECONV_H2F, &Hdr, &pImage->Header.u.v0);
1033 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, sizeof(VDIPREHEADER),
1034 &Hdr, sizeof(Hdr));
1035 break;
1036 }
1037 case 1:
1038 if (pImage->Header.u.v1plus.cbHeader < sizeof(pImage->Header.u.v1plus))
1039 {
1040 VDIHEADER1 Hdr;
1041 vdiConvHeaderEndianessV1(VDIECONV_H2F, &Hdr, &pImage->Header.u.v1);
1042 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, sizeof(VDIPREHEADER),
1043 &Hdr, sizeof(Hdr));
1044 }
1045 else
1046 {
1047 VDIHEADER1PLUS Hdr;
1048 vdiConvHeaderEndianessV1p(VDIECONV_H2F, &Hdr, &pImage->Header.u.v1plus);
1049 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, sizeof(VDIPREHEADER),
1050 &Hdr, sizeof(Hdr));
1051 }
1052 break;
1053 default:
1054 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1055 break;
1056 }
1057 AssertMsgRC(rc, ("vdiUpdateHeader failed, filename=\"%s\" rc=%Rrc\n", pImage->pszFilename, rc));
1058 return rc;
1059}
1060
1061/**
1062 * Internal: Save header to file - async version.
1063 */
1064static int vdiUpdateHeaderAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx)
1065{
1066 int rc;
1067 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
1068 {
1069 case 0:
1070 {
1071 VDIHEADER0 Hdr;
1072 vdiConvHeaderEndianessV0(VDIECONV_H2F, &Hdr, &pImage->Header.u.v0);
1073 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1074 sizeof(VDIPREHEADER), &Hdr, sizeof(Hdr),
1075 pIoCtx, NULL, NULL);
1076 break;
1077 }
1078 case 1:
1079 if (pImage->Header.u.v1plus.cbHeader < sizeof(pImage->Header.u.v1plus))
1080 {
1081 VDIHEADER1 Hdr;
1082 vdiConvHeaderEndianessV1(VDIECONV_H2F, &Hdr, &pImage->Header.u.v1);
1083 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1084 sizeof(VDIPREHEADER), &Hdr, sizeof(Hdr),
1085 pIoCtx, NULL, NULL);
1086 }
1087 else
1088 {
1089 VDIHEADER1PLUS Hdr;
1090 vdiConvHeaderEndianessV1p(VDIECONV_H2F, &Hdr, &pImage->Header.u.v1plus);
1091 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1092 sizeof(VDIPREHEADER), &Hdr, sizeof(Hdr),
1093 pIoCtx, NULL, NULL);
1094 }
1095 break;
1096 default:
1097 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1098 break;
1099 }
1100 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
1101 ("vdiUpdateHeader failed, filename=\"%s\" rc=%Rrc\n", pImage->pszFilename, rc));
1102 return rc;
1103}
1104
1105/**
1106 * Internal: Save block pointer to file, save header to file.
1107 */
1108static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock)
1109{
1110 /* Update image header. */
1111 int rc = vdiUpdateHeader(pImage);
1112 if (RT_SUCCESS(rc))
1113 {
1114 /* write only one block pointer. */
1115 VDIIMAGEBLOCKPOINTER ptrBlock = RT_H2LE_U32(pImage->paBlocks[uBlock]);
1116 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
1117 pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
1118 &ptrBlock, sizeof(VDIIMAGEBLOCKPOINTER));
1119 AssertMsgRC(rc, ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Rrc\n",
1120 uBlock, pImage->pszFilename, rc));
1121 }
1122 return rc;
1123}
1124
1125/**
1126 * Internal: Save block pointer to file, save header to file - async version.
1127 */
1128static int vdiUpdateBlockInfoAsync(PVDIIMAGEDESC pImage, unsigned uBlock,
1129 PVDIOCTX pIoCtx, bool fUpdateHdr)
1130{
1131 int rc = VINF_SUCCESS;
1132
1133 /* Update image header. */
1134 if (fUpdateHdr)
1135 rc = vdiUpdateHeaderAsync(pImage, pIoCtx);
1136
1137 if (RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1138 {
1139 /* write only one block pointer. */
1140 VDIIMAGEBLOCKPOINTER ptrBlock = RT_H2LE_U32(pImage->paBlocks[uBlock]);
1141 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1142 pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
1143 &ptrBlock, sizeof(VDIIMAGEBLOCKPOINTER),
1144 pIoCtx, NULL, NULL);
1145 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
1146 ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Rrc\n",
1147 uBlock, pImage->pszFilename, rc));
1148 }
1149 return rc;
1150}
1151
1152/**
1153 * Internal: Flush the image file to disk - async version.
1154 */
1155static int vdiFlushImageIoCtx(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx)
1156{
1157 int rc = VINF_SUCCESS;
1158
1159 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1160 {
1161 /* Save header. */
1162 rc = vdiUpdateHeaderAsync(pImage, pIoCtx);
1163 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
1164 ("vdiUpdateHeaderAsync() failed, filename=\"%s\", rc=%Rrc\n",
1165 pImage->pszFilename, rc));
1166 rc = vdIfIoIntFileFlush(pImage->pIfIo, pImage->pStorage, pIoCtx, NULL, NULL);
1167 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
1168 ("Flushing data to disk failed rc=%Rrc\n", rc));
1169 }
1170
1171 return rc;
1172}
1173
1174/**
1175 * Completion callback for meta/userdata reads or writes.
1176 *
1177 * @return VBox status code.
1178 * VINF_SUCCESS if everything was successful and the transfer can continue.
1179 * VERR_VD_ASYNC_IO_IN_PROGRESS if there is another data transfer pending.
1180 * @param pBackendData The opaque backend data.
1181 * @param pIoCtx I/O context associated with this request.
1182 * @param pvUser Opaque user data passed during a read/write request.
1183 * @param rcReq Status code for the completed request.
1184 */
1185static DECLCALLBACK(int) vdiDiscardBlockAsyncUpdate(void *pBackendData, PVDIOCTX pIoCtx, void *pvUser, int rcReq)
1186{
1187 RT_NOREF1(rcReq);
1188 int rc = VINF_SUCCESS;
1189 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1190 PVDIBLOCKDISCARDASYNC pDiscardAsync = (PVDIBLOCKDISCARDASYNC)pvUser;
1191
1192 switch (pDiscardAsync->enmState)
1193 {
1194 case VDIBLOCKDISCARDSTATE_READ_BLOCK:
1195 {
1196 PVDMETAXFER pMetaXfer;
1197 uint64_t u64Offset = (uint64_t)pDiscardAsync->idxLastBlock * pImage->cbTotalBlockData + pImage->offStartData;
1198 rc = vdIfIoIntFileReadMeta(pImage->pIfIo, pImage->pStorage, u64Offset,
1199 pDiscardAsync->pvBlock, pImage->cbTotalBlockData, pIoCtx,
1200 &pMetaXfer, vdiDiscardBlockAsyncUpdate, pDiscardAsync);
1201 if (RT_FAILURE(rc))
1202 break;
1203
1204 /* Release immediately and go to next step. */
1205 vdIfIoIntMetaXferRelease(pImage->pIfIo, pMetaXfer);
1206 pDiscardAsync->enmState = VDIBLOCKDISCARDSTATE_WRITE_BLOCK;
1207 }
1208 RT_FALL_THRU();
1209 case VDIBLOCKDISCARDSTATE_WRITE_BLOCK:
1210 {
1211 /* Block read complete. Write to the new location (discarded block). */
1212 uint64_t u64Offset = (uint64_t)pDiscardAsync->ptrBlockDiscard * pImage->cbTotalBlockData + pImage->offStartData;
1213 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage, u64Offset,
1214 pDiscardAsync->pvBlock, pImage->cbTotalBlockData, pIoCtx,
1215 vdiDiscardBlockAsyncUpdate, pDiscardAsync);
1216
1217 pDiscardAsync->enmState = VDIBLOCKDISCARDSTATE_UPDATE_METADATA;
1218 if (RT_FAILURE(rc))
1219 break;
1220 }
1221 RT_FALL_THRU();
1222 case VDIBLOCKDISCARDSTATE_UPDATE_METADATA:
1223 {
1224 int rc2;
1225
1226 /* Block write complete. Update metadata. */
1227 pImage->paBlocksRev[pDiscardAsync->idxLastBlock] = VDI_IMAGE_BLOCK_FREE;
1228 pImage->paBlocks[pDiscardAsync->uBlock] = VDI_IMAGE_BLOCK_ZERO;
1229
1230 if (pDiscardAsync->idxLastBlock != pDiscardAsync->ptrBlockDiscard)
1231 {
1232 pImage->paBlocks[pDiscardAsync->uBlockLast] = pDiscardAsync->ptrBlockDiscard;
1233 pImage->paBlocksRev[pDiscardAsync->ptrBlockDiscard] = pDiscardAsync->uBlockLast;
1234
1235 rc = vdiUpdateBlockInfoAsync(pImage, pDiscardAsync->uBlockLast, pIoCtx, false /* fUpdateHdr */);
1236 if ( RT_FAILURE(rc)
1237 && rc != VERR_VD_ASYNC_IO_IN_PROGRESS)
1238 break;
1239 }
1240
1241 setImageBlocksAllocated(&pImage->Header, pDiscardAsync->idxLastBlock);
1242 rc = vdiUpdateBlockInfoAsync(pImage, pDiscardAsync->uBlock, pIoCtx, true /* fUpdateHdr */);
1243 if ( RT_FAILURE(rc)
1244 && rc != VERR_VD_ASYNC_IO_IN_PROGRESS)
1245 break;
1246
1247 pImage->cbImage -= pImage->cbTotalBlockData;
1248 LogFlowFunc(("Set new size %llu\n", pImage->cbImage));
1249 rc2 = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage, pImage->cbImage);
1250 if (RT_FAILURE(rc2))
1251 rc = rc2;
1252
1253 /* Free discard state. */
1254 RTMemFree(pDiscardAsync->pvBlock);
1255 RTMemFree(pDiscardAsync);
1256 break;
1257 }
1258 default:
1259 AssertMsgFailed(("Invalid state %d\n", pDiscardAsync->enmState));
1260 }
1261
1262 if (rc == VERR_VD_NOT_ENOUGH_METADATA)
1263 rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
1264
1265 return rc;
1266}
1267
1268/**
1269 * Internal: Discard a whole block from the image filling the created hole with
1270 * data from another block - async I/O version.
1271 *
1272 * @returns VBox status code.
1273 * @param pImage VDI image instance data.
1274 * @param pIoCtx I/O context associated with this request.
1275 * @param uBlock The block to discard.
1276 * @param pvBlock Memory to use for the I/O.
1277 */
1278static int vdiDiscardBlockAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx,
1279 unsigned uBlock, void *pvBlock)
1280{
1281 int rc = VINF_SUCCESS;
1282 PVDIBLOCKDISCARDASYNC pDiscardAsync = NULL;
1283
1284 LogFlowFunc(("pImage=%#p uBlock=%u pvBlock=%#p\n",
1285 pImage, uBlock, pvBlock));
1286
1287 pDiscardAsync = (PVDIBLOCKDISCARDASYNC)RTMemAllocZ(sizeof(VDIBLOCKDISCARDASYNC));
1288 if (RT_UNLIKELY(!pDiscardAsync))
1289 return VERR_NO_MEMORY;
1290
1291 /* Init block discard state. */
1292 pDiscardAsync->uBlock = uBlock;
1293 pDiscardAsync->pvBlock = pvBlock;
1294 pDiscardAsync->ptrBlockDiscard = pImage->paBlocks[uBlock];
1295 pDiscardAsync->idxLastBlock = getImageBlocksAllocated(&pImage->Header) - 1;
1296 pDiscardAsync->uBlockLast = pImage->paBlocksRev[pDiscardAsync->idxLastBlock];
1297
1298 /*
1299 * The block is empty, remove it.
1300 * Read the last block of the image first.
1301 */
1302 if (pDiscardAsync->idxLastBlock != pDiscardAsync->ptrBlockDiscard)
1303 {
1304 LogFlowFunc(("Moving block [%u]=%u into [%u]=%u\n",
1305 pDiscardAsync->uBlockLast, pDiscardAsync->idxLastBlock,
1306 uBlock, pImage->paBlocks[uBlock]));
1307 pDiscardAsync->enmState = VDIBLOCKDISCARDSTATE_READ_BLOCK;
1308 }
1309 else
1310 {
1311 pDiscardAsync->enmState = VDIBLOCKDISCARDSTATE_UPDATE_METADATA; /* Start immediately to shrink the image. */
1312 LogFlowFunc(("Discard last block [%u]=%u\n", uBlock, pImage->paBlocks[uBlock]));
1313 }
1314
1315 /* Call the update callback directly. */
1316 rc = vdiDiscardBlockAsyncUpdate(pImage, pIoCtx, pDiscardAsync, VINF_SUCCESS);
1317
1318 LogFlowFunc(("returns rc=%Rrc\n", rc));
1319 return rc;
1320}
1321
1322/**
1323 * Internal: Creates a allocation bitmap from the given data.
1324 * Sectors which contain only 0 are marked as unallocated and sectors with
1325 * other data as allocated.
1326 *
1327 * @returns Pointer to the allocation bitmap or NULL on failure.
1328 * @param pvData The data to create the allocation bitmap for.
1329 * @param cbData Number of bytes in the buffer.
1330 */
1331static void *vdiAllocationBitmapCreate(void *pvData, size_t cbData)
1332{
1333 Assert(cbData <= UINT32_MAX / 8);
1334 uint32_t cSectors = (uint32_t)(cbData / 512);
1335 uint32_t uSectorCur = 0;
1336 void *pbmAllocationBitmap = NULL;
1337
1338 Assert(!(cbData % 512));
1339 Assert(!(cSectors % 8));
1340
1341 pbmAllocationBitmap = RTMemAllocZ(cSectors / 8);
1342 if (!pbmAllocationBitmap)
1343 return NULL;
1344
1345 while (uSectorCur < cSectors)
1346 {
1347 int idxSet = ASMBitFirstSet((uint8_t *)pvData + uSectorCur * 512, (uint32_t)cbData * 8);
1348
1349 if (idxSet != -1)
1350 {
1351 unsigned idxSectorAlloc = idxSet / 8 / 512;
1352 ASMBitSet(pbmAllocationBitmap, uSectorCur + idxSectorAlloc);
1353
1354 uSectorCur += idxSectorAlloc + 1;
1355 cbData -= (idxSectorAlloc + 1) * 512;
1356 }
1357 else
1358 break;
1359 }
1360
1361 return pbmAllocationBitmap;
1362}
1363
1364
1365/**
1366 * Updates the state of the async cluster allocation.
1367 *
1368 * @returns VBox status code.
1369 * @param pBackendData The opaque backend data.
1370 * @param pIoCtx I/O context associated with this request.
1371 * @param pvUser Opaque user data passed during a read/write request.
1372 * @param rcReq Status code for the completed request.
1373 */
1374static DECLCALLBACK(int) vdiBlockAllocUpdate(void *pBackendData, PVDIOCTX pIoCtx, void *pvUser, int rcReq)
1375{
1376 int rc = VINF_SUCCESS;
1377 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1378 PVDIASYNCBLOCKALLOC pBlockAlloc = (PVDIASYNCBLOCKALLOC)pvUser;
1379
1380 if (RT_SUCCESS(rcReq))
1381 {
1382 pImage->cbImage += pImage->cbTotalBlockData;
1383 pImage->paBlocks[pBlockAlloc->uBlock] = pBlockAlloc->cBlocksAllocated;
1384
1385 if (pImage->paBlocksRev)
1386 pImage->paBlocksRev[pBlockAlloc->cBlocksAllocated] = pBlockAlloc->uBlock;
1387
1388 setImageBlocksAllocated(&pImage->Header, pBlockAlloc->cBlocksAllocated + 1);
1389 rc = vdiUpdateBlockInfoAsync(pImage, pBlockAlloc->uBlock, pIoCtx,
1390 true /* fUpdateHdr */);
1391 }
1392 /* else: I/O error don't update the block table. */
1393
1394 RTMemFree(pBlockAlloc);
1395 return rc;
1396}
1397
1398/** @copydoc VDIMAGEBACKEND::pfnProbe */
1399static DECLCALLBACK(int) vdiProbe(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
1400 PVDINTERFACE pVDIfsImage, VDTYPE *penmType)
1401{
1402 LogFlowFunc(("pszFilename=\"%s\"\n", pszFilename));
1403 int rc = VINF_SUCCESS;
1404
1405 AssertReturn((VALID_PTR(pszFilename) && *pszFilename), VERR_INVALID_PARAMETER);
1406
1407 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)RTMemAllocZ(RT_UOFFSETOF(VDIIMAGEDESC, RegionList.aRegions[1]));
1408 if (RT_LIKELY(pImage))
1409 {
1410 pImage->pszFilename = pszFilename;
1411 pImage->pStorage = NULL;
1412 pImage->paBlocks = NULL;
1413 pImage->pVDIfsDisk = pVDIfsDisk;
1414 pImage->pVDIfsImage = pVDIfsImage;
1415
1416 rc = vdiOpenImage(pImage, VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_READONLY);
1417 vdiFreeImage(pImage, false);
1418 RTMemFree(pImage);
1419
1420 if (RT_SUCCESS(rc))
1421 *penmType = VDTYPE_HDD;
1422 }
1423 else
1424 rc = VERR_NO_MEMORY;
1425
1426 LogFlowFunc(("returns %Rrc\n", rc));
1427 return rc;
1428}
1429
1430/** @copydoc VDIMAGEBACKEND::pfnOpen */
1431static DECLCALLBACK(int) vdiOpen(const char *pszFilename, unsigned uOpenFlags,
1432 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1433 VDTYPE enmType, void **ppBackendData)
1434{
1435 RT_NOREF1(enmType); /**< @todo r=klaus make use of the type info. */
1436
1437 LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p enmType=%u ppBackendData=%#p\n",
1438 pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, enmType, ppBackendData));
1439 int rc;
1440
1441 /* Check open flags. All valid flags are supported. */
1442 AssertReturn(!(uOpenFlags & ~VD_OPEN_FLAGS_MASK), VERR_INVALID_PARAMETER);
1443 AssertReturn((VALID_PTR(pszFilename) && *pszFilename), VERR_INVALID_PARAMETER);
1444
1445 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)RTMemAllocZ(RT_UOFFSETOF(VDIIMAGEDESC, RegionList.aRegions[1]));
1446 if (RT_LIKELY(pImage))
1447 {
1448 pImage->pszFilename = pszFilename;
1449 pImage->pStorage = NULL;
1450 pImage->paBlocks = NULL;
1451 pImage->pVDIfsDisk = pVDIfsDisk;
1452 pImage->pVDIfsImage = pVDIfsImage;
1453
1454 rc = vdiOpenImage(pImage, uOpenFlags);
1455 if (RT_SUCCESS(rc))
1456 *ppBackendData = pImage;
1457 else
1458 RTMemFree(pImage);
1459 }
1460 else
1461 rc = VERR_NO_MEMORY;
1462
1463 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1464 return rc;
1465}
1466
1467/** @copydoc VDIMAGEBACKEND::pfnCreate */
1468static DECLCALLBACK(int) vdiCreate(const char *pszFilename, uint64_t cbSize,
1469 unsigned uImageFlags, const char *pszComment,
1470 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
1471 PCRTUUID pUuid, unsigned uOpenFlags,
1472 unsigned uPercentStart, unsigned uPercentSpan,
1473 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1474 PVDINTERFACE pVDIfsOperation, VDTYPE enmType,
1475 void **ppBackendData)
1476{
1477 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\n",
1478 pszFilename, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, enmType, ppBackendData));
1479 int rc;
1480
1481 /* Check the VD container type and image flags. */
1482 if ( enmType != VDTYPE_HDD
1483 || (uImageFlags & ~VD_VDI_IMAGE_FLAGS_MASK) != 0)
1484 return VERR_VD_INVALID_TYPE;
1485
1486 /* Check size. Maximum 4PB-3M. No tricks with adjusting the 1M block size
1487 * so far, which would extend the size. */
1488 if ( !cbSize
1489 || cbSize >= _1P * 4 - _1M * 3
1490 || cbSize < VDI_IMAGE_DEFAULT_BLOCK_SIZE
1491 || (cbSize % 512))
1492 return VERR_VD_INVALID_SIZE;
1493
1494 /* Check open flags. All valid flags are supported. */
1495 AssertReturn(!(uOpenFlags & ~VD_OPEN_FLAGS_MASK), VERR_INVALID_PARAMETER);
1496 AssertReturn( VALID_PTR(pszFilename)
1497 && *pszFilename
1498 && VALID_PTR(pPCHSGeometry)
1499 && VALID_PTR(pLCHSGeometry), VERR_INVALID_PARAMETER);
1500
1501 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)RTMemAllocZ(RT_UOFFSETOF(VDIIMAGEDESC, RegionList.aRegions[1]));
1502 if (RT_LIKELY(pImage))
1503 {
1504 PVDINTERFACEPROGRESS pIfProgress = VDIfProgressGet(pVDIfsOperation);
1505 PVDINTERFACECONFIG pIfCfg = VDIfConfigGet(pVDIfsOperation);
1506 pImage->pszFilename = pszFilename;
1507 pImage->pStorage = NULL;
1508 pImage->paBlocks = NULL;
1509 pImage->pVDIfsDisk = pVDIfsDisk;
1510 pImage->pVDIfsImage = pVDIfsImage;
1511
1512 rc = vdiCreateImage(pImage, cbSize, uImageFlags, pszComment,
1513 pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags,
1514 pIfProgress, uPercentStart, uPercentSpan, pIfCfg);
1515 if (RT_SUCCESS(rc))
1516 {
1517 /* So far the image is opened in read/write mode. Make sure the
1518 * image is opened in read-only mode if the caller requested that. */
1519 if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
1520 {
1521 vdiFreeImage(pImage, false);
1522 rc = vdiOpenImage(pImage, uOpenFlags);
1523 }
1524
1525 if (RT_SUCCESS(rc))
1526 *ppBackendData = pImage;
1527 }
1528
1529 if (RT_FAILURE(rc))
1530 RTMemFree(pImage);
1531 }
1532 else
1533 rc = VERR_NO_MEMORY;
1534
1535 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1536 return rc;
1537}
1538
1539/** @copydoc VDIMAGEBACKEND::pfnRename */
1540static DECLCALLBACK(int) vdiRename(void *pBackendData, const char *pszFilename)
1541{
1542 LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
1543 int rc = VINF_SUCCESS;
1544 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1545
1546 /* Check arguments. */
1547 AssertReturn((pImage && pszFilename && *pszFilename), VERR_INVALID_PARAMETER);
1548
1549 /* Close the image. */
1550 rc = vdiFreeImage(pImage, false);
1551 if (RT_SUCCESS(rc))
1552 {
1553 /* Rename the file. */
1554 rc = vdIfIoIntFileMove(pImage->pIfIo, pImage->pszFilename, pszFilename, 0);
1555 if (RT_SUCCESS(rc))
1556 {
1557 /* Update pImage with the new information. */
1558 pImage->pszFilename = pszFilename;
1559
1560 /* Open the new image. */
1561 rc = vdiOpenImage(pImage, pImage->uOpenFlags);
1562 }
1563 else
1564 {
1565 /* The move failed, try to reopen the original image. */
1566 int rc2 = vdiOpenImage(pImage, pImage->uOpenFlags);
1567 if (RT_FAILURE(rc2))
1568 rc = rc2;
1569 }
1570 }
1571
1572 LogFlowFunc(("returns %Rrc\n", rc));
1573 return rc;
1574}
1575
1576/** @copydoc VDIMAGEBACKEND::pfnClose */
1577static DECLCALLBACK(int) vdiClose(void *pBackendData, bool fDelete)
1578{
1579 LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
1580 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1581
1582 int rc = vdiFreeImage(pImage, fDelete);
1583 RTMemFree(pImage);
1584
1585 LogFlowFunc(("returns %Rrc\n", rc));
1586 return rc;
1587}
1588
1589static DECLCALLBACK(int) vdiRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
1590 PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
1591{
1592 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
1593 pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
1594 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1595 unsigned uBlock;
1596 unsigned offRead;
1597 int rc = VINF_SUCCESS;
1598
1599 AssertPtr(pImage);
1600 Assert(!(uOffset % 512));
1601 Assert(!(cbToRead % 512));
1602 AssertReturn((VALID_PTR(pIoCtx) && cbToRead), VERR_INVALID_PARAMETER);
1603 AssertReturn(uOffset + cbToRead <= getImageDiskSize(&pImage->Header), VERR_INVALID_PARAMETER);
1604
1605 /* Calculate starting block number and offset inside it. */
1606 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1607 offRead = (unsigned)uOffset & pImage->uBlockMask;
1608
1609 /* Clip read range to at most the rest of the block. */
1610 cbToRead = RT_MIN(cbToRead, getImageBlockSize(&pImage->Header) - offRead);
1611 Assert(!(cbToRead % 512));
1612
1613 if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
1614 rc = VERR_VD_BLOCK_FREE;
1615 else if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
1616 {
1617 size_t cbSet;
1618
1619 cbSet = vdIfIoIntIoCtxSet(pImage->pIfIo, pIoCtx, 0, cbToRead);
1620 Assert(cbSet == cbToRead);
1621 }
1622 else
1623 {
1624 /* Block present in image file, read relevant data. */
1625 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1626 + (pImage->offStartData + pImage->offStartBlockData + offRead);
1627
1628 if (u64Offset + cbToRead <= pImage->cbImage)
1629 rc = vdIfIoIntFileReadUser(pImage->pIfIo, pImage->pStorage, u64Offset,
1630 pIoCtx, cbToRead);
1631 else
1632 {
1633 LogRel(("VDI: Out of range access (%llu) in image %s, image size %llu\n",
1634 u64Offset, pImage->pszFilename, pImage->cbImage));
1635 vdIfIoIntIoCtxSet(pImage->pIfIo, pIoCtx, 0, cbToRead);
1636 rc = VERR_VD_READ_OUT_OF_RANGE;
1637 }
1638 }
1639
1640 if (pcbActuallyRead)
1641 *pcbActuallyRead = cbToRead;
1642
1643 LogFlowFunc(("returns %Rrc\n", rc));
1644 return rc;
1645}
1646
1647static DECLCALLBACK(int) vdiWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
1648 PVDIOCTX pIoCtx, size_t *pcbWriteProcess, size_t *pcbPreRead,
1649 size_t *pcbPostRead, unsigned fWrite)
1650{
1651 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
1652 pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
1653 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1654 unsigned uBlock;
1655 unsigned offWrite;
1656 int rc = VINF_SUCCESS;
1657
1658 AssertPtr(pImage);
1659 Assert(!(uOffset % 512));
1660 Assert(!(cbToWrite % 512));
1661 AssertReturn((VALID_PTR(pIoCtx) && cbToWrite), VERR_INVALID_PARAMETER);
1662
1663 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1664 {
1665 /* No size check here, will do that later. For dynamic images which are
1666 * not multiples of the block size in length, this would prevent writing to
1667 * the last block. */
1668
1669 /* Calculate starting block number and offset inside it. */
1670 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1671 offWrite = (unsigned)uOffset & pImage->uBlockMask;
1672
1673 /* Clip write range to at most the rest of the block. */
1674 cbToWrite = RT_MIN(cbToWrite, getImageBlockSize(&pImage->Header) - offWrite);
1675 Assert(!(cbToWrite % 512));
1676
1677 do
1678 {
1679 if (!IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
1680 {
1681 /* Block is either free or zero. */
1682 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_ZEROES)
1683 && ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
1684 || cbToWrite == getImageBlockSize(&pImage->Header)))
1685 {
1686 /* If the destination block is unallocated at this point, it's
1687 * either a zero block or a block which hasn't been used so far
1688 * (which also means that it's a zero block. Don't need to write
1689 * anything to this block if the data consists of just zeroes. */
1690 if (vdIfIoIntIoCtxIsZero(pImage->pIfIo, pIoCtx, cbToWrite, true))
1691 {
1692 pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1693 *pcbPreRead = 0;
1694 *pcbPostRead = 0;
1695 break;
1696 }
1697 }
1698
1699 if ( cbToWrite == getImageBlockSize(&pImage->Header)
1700 && !(fWrite & VD_WRITE_NO_ALLOC))
1701 {
1702 /* Full block write to previously unallocated block.
1703 * Allocate block and write data. */
1704 Assert(!offWrite);
1705 PVDIASYNCBLOCKALLOC pBlockAlloc = (PVDIASYNCBLOCKALLOC)RTMemAllocZ(sizeof(VDIASYNCBLOCKALLOC));
1706 if (!pBlockAlloc)
1707 {
1708 rc = VERR_NO_MEMORY;
1709 break;
1710 }
1711
1712 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
1713 uint64_t u64Offset = (uint64_t)cBlocksAllocated * pImage->cbTotalBlockData
1714 + (pImage->offStartData + pImage->offStartBlockData);
1715
1716 pBlockAlloc->cBlocksAllocated = cBlocksAllocated;
1717 pBlockAlloc->uBlock = uBlock;
1718
1719 *pcbPreRead = 0;
1720 *pcbPostRead = 0;
1721
1722 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1723 u64Offset, pIoCtx, cbToWrite,
1724 vdiBlockAllocUpdate, pBlockAlloc);
1725 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1726 break;
1727 else if (RT_FAILURE(rc))
1728 {
1729 RTMemFree(pBlockAlloc);
1730 break;
1731 }
1732
1733 rc = vdiBlockAllocUpdate(pImage, pIoCtx, pBlockAlloc, rc);
1734 }
1735 else
1736 {
1737 /* Trying to do a partial write to an unallocated block. Don't do
1738 * anything except letting the upper layer know what to do. */
1739 *pcbPreRead = offWrite % getImageBlockSize(&pImage->Header);
1740 *pcbPostRead = getImageBlockSize(&pImage->Header) - cbToWrite - *pcbPreRead;
1741 rc = VERR_VD_BLOCK_FREE;
1742 }
1743 }
1744 else
1745 {
1746 /* Block present in image file, write relevant data. */
1747 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1748 + (pImage->offStartData + pImage->offStartBlockData + offWrite);
1749 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1750 u64Offset, pIoCtx, cbToWrite, NULL, NULL);
1751 }
1752 } while (0);
1753
1754 if (pcbWriteProcess)
1755 *pcbWriteProcess = cbToWrite;
1756 }
1757 else
1758 rc = VERR_VD_IMAGE_READ_ONLY;
1759
1760 LogFlowFunc(("returns %Rrc\n", rc));
1761 return rc;
1762}
1763
1764static DECLCALLBACK(int) vdiFlush(void *pBackendData, PVDIOCTX pIoCtx)
1765{
1766 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1767 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1768 int rc = VINF_SUCCESS;
1769
1770 Assert(pImage);
1771
1772 rc = vdiFlushImageIoCtx(pImage, pIoCtx);
1773 LogFlowFunc(("returns %Rrc\n", rc));
1774 return rc;
1775}
1776
1777/** @copydoc VDIMAGEBACKEND::pfnGetVersion */
1778static DECLCALLBACK(unsigned) vdiGetVersion(void *pBackendData)
1779{
1780 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1781 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1782
1783 AssertPtrReturn(pImage, 0);
1784
1785 LogFlowFunc(("returns %#x\n", pImage->PreHeader.u32Version));
1786 return pImage->PreHeader.u32Version;
1787}
1788
1789/** @copydoc VDIMAGEBACKEND::pfnGetFileSize */
1790static DECLCALLBACK(uint64_t) vdiGetFileSize(void *pBackendData)
1791{
1792 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1793 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1794 uint64_t cb = 0;
1795
1796 AssertPtrReturn(pImage, 0);
1797
1798 if (pImage->pStorage)
1799 {
1800 uint64_t cbFile;
1801 int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
1802 if (RT_SUCCESS(rc))
1803 cb += cbFile;
1804 }
1805
1806 LogFlowFunc(("returns %lld\n", cb));
1807 return cb;
1808}
1809
1810/** @copydoc VDIMAGEBACKEND::pfnGetPCHSGeometry */
1811static DECLCALLBACK(int) vdiGetPCHSGeometry(void *pBackendData, PVDGEOMETRY pPCHSGeometry)
1812{
1813 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
1814 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1815 int rc = VINF_SUCCESS;
1816
1817 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
1818
1819 if (pImage->PCHSGeometry.cCylinders)
1820 *pPCHSGeometry = pImage->PCHSGeometry;
1821 else
1822 rc = VERR_VD_GEOMETRY_NOT_SET;
1823
1824 LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1825 return rc;
1826}
1827
1828/** @copydoc VDIMAGEBACKEND::pfnSetPCHSGeometry */
1829static DECLCALLBACK(int) vdiSetPCHSGeometry(void *pBackendData, PCVDGEOMETRY pPCHSGeometry)
1830{
1831 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n",
1832 pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1833 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1834 int rc = VINF_SUCCESS;
1835
1836 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
1837
1838 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1839 rc = VERR_VD_IMAGE_READ_ONLY;
1840 else
1841 pImage->PCHSGeometry = *pPCHSGeometry;
1842
1843 LogFlowFunc(("returns %Rrc\n", rc));
1844 return rc;
1845}
1846
1847/** @copydoc VDIMAGEBACKEND::pfnGetLCHSGeometry */
1848static DECLCALLBACK(int) vdiGetLCHSGeometry(void *pBackendData, PVDGEOMETRY pLCHSGeometry)
1849{
1850 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
1851 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1852
1853 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
1854
1855 int rc = VINF_SUCCESS;
1856 VDIDISKGEOMETRY DummyGeo = { 0, 0, 0, VDI_GEOMETRY_SECTOR_SIZE };
1857 PVDIDISKGEOMETRY pGeometry = getImageLCHSGeometry(&pImage->Header);
1858 if (!pGeometry)
1859 pGeometry = &DummyGeo;
1860
1861 if ( pGeometry->cCylinders > 0
1862 && pGeometry->cHeads > 0
1863 && pGeometry->cSectors > 0)
1864 {
1865 pLCHSGeometry->cCylinders = pGeometry->cCylinders;
1866 pLCHSGeometry->cHeads = pGeometry->cHeads;
1867 pLCHSGeometry->cSectors = pGeometry->cSectors;
1868 }
1869 else
1870 rc = VERR_VD_GEOMETRY_NOT_SET;
1871
1872 LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1873 return rc;
1874}
1875
1876/** @copydoc VDIMAGEBACKEND::pfnSetLCHSGeometry */
1877static DECLCALLBACK(int) vdiSetLCHSGeometry(void *pBackendData, PCVDGEOMETRY pLCHSGeometry)
1878{
1879 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n",
1880 pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1881 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1882 PVDIDISKGEOMETRY pGeometry;
1883 int rc = VINF_SUCCESS;
1884
1885 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
1886
1887 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1888 {
1889 pGeometry = getImageLCHSGeometry(&pImage->Header);
1890 if (pGeometry)
1891 {
1892 pGeometry->cCylinders = pLCHSGeometry->cCylinders;
1893 pGeometry->cHeads = pLCHSGeometry->cHeads;
1894 pGeometry->cSectors = pLCHSGeometry->cSectors;
1895 pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
1896
1897 /* Update header information in base image file. */
1898 vdiFlushImage(pImage);
1899 }
1900 }
1901 else
1902 rc = VERR_VD_IMAGE_READ_ONLY;
1903
1904 LogFlowFunc(("returns %Rrc\n", rc));
1905 return rc;
1906}
1907
1908/** @copydoc VDIMAGEBACKEND::pfnQueryRegions */
1909static DECLCALLBACK(int) vdiQueryRegions(void *pBackendData, PCVDREGIONLIST *ppRegionList)
1910{
1911 LogFlowFunc(("pBackendData=%#p ppRegionList=%#p\n", pBackendData, ppRegionList));
1912 PVDIIMAGEDESC pThis = (PVDIIMAGEDESC)pBackendData;
1913
1914 AssertPtrReturn(pThis, VERR_VD_NOT_OPENED);
1915
1916 *ppRegionList = &pThis->RegionList;
1917 LogFlowFunc(("returns %Rrc\n", VINF_SUCCESS));
1918 return VINF_SUCCESS;
1919}
1920
1921/** @copydoc VDIMAGEBACKEND::pfnRegionListRelease */
1922static DECLCALLBACK(void) vdiRegionListRelease(void *pBackendData, PCVDREGIONLIST pRegionList)
1923{
1924 RT_NOREF1(pRegionList);
1925 LogFlowFunc(("pBackendData=%#p pRegionList=%#p\n", pBackendData, pRegionList));
1926 PVDIIMAGEDESC pThis = (PVDIIMAGEDESC)pBackendData;
1927 AssertPtr(pThis); RT_NOREF(pThis);
1928
1929 /* Nothing to do here. */
1930}
1931
1932/** @copydoc VDIMAGEBACKEND::pfnGetImageFlags */
1933static DECLCALLBACK(unsigned) vdiGetImageFlags(void *pBackendData)
1934{
1935 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1936 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1937
1938 AssertPtrReturn(pImage, 0);
1939
1940 LogFlowFunc(("returns %#x\n", pImage->uImageFlags));
1941 return pImage->uImageFlags;
1942}
1943
1944/** @copydoc VDIMAGEBACKEND::pfnGetOpenFlags */
1945static DECLCALLBACK(unsigned) vdiGetOpenFlags(void *pBackendData)
1946{
1947 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1948 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1949
1950 AssertPtrReturn(pImage, 0);
1951
1952 LogFlowFunc(("returns %#x\n", pImage->uOpenFlags));
1953 return pImage->uOpenFlags;
1954}
1955
1956/** @copydoc VDIMAGEBACKEND::pfnSetOpenFlags */
1957static DECLCALLBACK(int) vdiSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
1958{
1959 LogFlowFunc(("pBackendData=%#p uOpenFlags=%#x\n", pBackendData, uOpenFlags));
1960 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1961 int rc;
1962 const char *pszFilename;
1963
1964 /* Image must be opened and the new flags must be valid. */
1965 if (!pImage || (uOpenFlags & ~( VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO
1966 | VD_OPEN_FLAGS_ASYNC_IO | VD_OPEN_FLAGS_SHAREABLE
1967 | VD_OPEN_FLAGS_SEQUENTIAL | VD_OPEN_FLAGS_DISCARD
1968 | VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS)))
1969 rc = VERR_INVALID_PARAMETER;
1970 else
1971 {
1972 /* Implement this operation via reopening the image. */
1973 pszFilename = pImage->pszFilename;
1974 rc = vdiFreeImage(pImage, false);
1975 if (RT_SUCCESS(rc))
1976 rc = vdiOpenImage(pImage, uOpenFlags);
1977 }
1978
1979 LogFlowFunc(("returns %Rrc\n", rc));
1980 return rc;
1981}
1982
1983/** @copydoc VDIMAGEBACKEND::pfnGetComment */
1984static DECLCALLBACK(int) vdiGetComment(void *pBackendData, char *pszComment,
1985 size_t cbComment)
1986{
1987 LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
1988 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1989
1990 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
1991
1992 int rc = VINF_SUCCESS;
1993 char *pszTmp = getImageComment(&pImage->Header);
1994 /* Make this foolproof even if the image doesn't have the zero
1995 * termination. With some luck the repaired header will be saved. */
1996 size_t cb = RTStrNLen(pszTmp, VDI_IMAGE_COMMENT_SIZE);
1997 if (cb == VDI_IMAGE_COMMENT_SIZE)
1998 {
1999 pszTmp[VDI_IMAGE_COMMENT_SIZE-1] = '\0';
2000 cb--;
2001 }
2002 if (cb < cbComment)
2003 {
2004 /* memcpy is much better than strncpy. */
2005 memcpy(pszComment, pszTmp, cb + 1);
2006 }
2007 else
2008 rc = VERR_BUFFER_OVERFLOW;
2009
2010 LogFlowFunc(("returns %Rrc comment=\"%s\"\n", rc, pszComment));
2011 return rc;
2012}
2013
2014/** @copydoc VDIMAGEBACKEND::pfnSetComment */
2015static DECLCALLBACK(int) vdiSetComment(void *pBackendData, const char *pszComment)
2016{
2017 LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
2018 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2019 int rc;
2020
2021 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2022
2023 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2024 {
2025 size_t cchComment = pszComment ? strlen(pszComment) : 0;
2026 if (cchComment < VDI_IMAGE_COMMENT_SIZE)
2027 {
2028 /* we don't support old style images */
2029 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
2030 {
2031 /*
2032 * Update the comment field, making sure to zero out all of the previous comment.
2033 */
2034 memset(pImage->Header.u.v1.szComment, '\0', VDI_IMAGE_COMMENT_SIZE);
2035 memcpy(pImage->Header.u.v1.szComment, pszComment, cchComment);
2036
2037 /* write out new the header */
2038 rc = vdiUpdateHeader(pImage);
2039 }
2040 else
2041 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
2042 }
2043 else
2044 {
2045 LogFunc(("pszComment is too long, %d bytes!\n", cchComment));
2046 rc = VERR_VD_VDI_COMMENT_TOO_LONG;
2047 }
2048 }
2049 else
2050 rc = VERR_VD_IMAGE_READ_ONLY;
2051
2052 LogFlowFunc(("returns %Rrc\n", rc));
2053 return rc;
2054}
2055
2056/** @copydoc VDIMAGEBACKEND::pfnGetUuid */
2057static DECLCALLBACK(int) vdiGetUuid(void *pBackendData, PRTUUID pUuid)
2058{
2059 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2060 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2061
2062 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2063
2064 *pUuid = *getImageCreationUUID(&pImage->Header);
2065
2066 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VINF_SUCCESS, pUuid));
2067 return VINF_SUCCESS;
2068}
2069
2070/** @copydoc VDIMAGEBACKEND::pfnSetUuid */
2071static DECLCALLBACK(int) vdiSetUuid(void *pBackendData, PCRTUUID pUuid)
2072{
2073 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2074 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2075
2076 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2077
2078 int rc = VINF_SUCCESS;
2079 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2080 {
2081 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
2082 pImage->Header.u.v1.uuidCreate = *pUuid;
2083 /* Make it possible to clone old VDIs. */
2084 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
2085 pImage->Header.u.v0.uuidCreate = *pUuid;
2086 else
2087 {
2088 LogFunc(("Version is not supported!\n"));
2089 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
2090 }
2091 }
2092 else
2093 rc = VERR_VD_IMAGE_READ_ONLY;
2094
2095 LogFlowFunc(("returns %Rrc\n", rc));
2096 return rc;
2097}
2098
2099/** @copydoc VDIMAGEBACKEND::pfnGetModificationUuid */
2100static DECLCALLBACK(int) vdiGetModificationUuid(void *pBackendData, PRTUUID pUuid)
2101{
2102 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2103 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2104
2105 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2106
2107 *pUuid = *getImageModificationUUID(&pImage->Header);
2108
2109 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VINF_SUCCESS, pUuid));
2110 return VINF_SUCCESS;
2111}
2112
2113/** @copydoc VDIMAGEBACKEND::pfnSetModificationUuid */
2114static DECLCALLBACK(int) vdiSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
2115{
2116 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2117 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2118
2119 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2120
2121 int rc = VINF_SUCCESS;
2122 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2123 {
2124 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
2125 pImage->Header.u.v1.uuidModify = *pUuid;
2126 /* Make it possible to clone old VDIs. */
2127 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
2128 pImage->Header.u.v0.uuidModify = *pUuid;
2129 else
2130 {
2131 LogFunc(("Version is not supported!\n"));
2132 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
2133 }
2134 }
2135 else
2136 rc = VERR_VD_IMAGE_READ_ONLY;
2137
2138 LogFlowFunc(("returns %Rrc\n", rc));
2139 return rc;
2140}
2141
2142/** @copydoc VDIMAGEBACKEND::pfnGetParentUuid */
2143static DECLCALLBACK(int) vdiGetParentUuid(void *pBackendData, PRTUUID pUuid)
2144{
2145 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2146 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2147
2148 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2149
2150 *pUuid = *getImageParentUUID(&pImage->Header);
2151
2152 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VINF_SUCCESS, pUuid));
2153 return VINF_SUCCESS;
2154}
2155
2156/** @copydoc VDIMAGEBACKEND::pfnSetParentUuid */
2157static DECLCALLBACK(int) vdiSetParentUuid(void *pBackendData, PCRTUUID pUuid)
2158{
2159 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2160 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2161
2162 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2163
2164 int rc = VINF_SUCCESS;
2165 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2166 {
2167 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
2168 pImage->Header.u.v1.uuidLinkage = *pUuid;
2169 /* Make it possible to clone old VDIs. */
2170 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
2171 pImage->Header.u.v0.uuidLinkage = *pUuid;
2172 else
2173 {
2174 LogFunc(("Version is not supported!\n"));
2175 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
2176 }
2177 }
2178 else
2179 rc = VERR_VD_IMAGE_READ_ONLY;
2180
2181 LogFlowFunc(("returns %Rrc\n", rc));
2182 return rc;
2183}
2184
2185/** @copydoc VDIMAGEBACKEND::pfnGetParentModificationUuid */
2186static DECLCALLBACK(int) vdiGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
2187{
2188 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2189 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2190
2191 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2192
2193 *pUuid = *getImageParentModificationUUID(&pImage->Header);
2194
2195 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VINF_SUCCESS, pUuid));
2196 return VINF_SUCCESS;
2197}
2198
2199/** @copydoc VDIMAGEBACKEND::pfnSetParentModificationUuid */
2200static DECLCALLBACK(int) vdiSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
2201{
2202 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2203 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2204
2205 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2206
2207 int rc = VINF_SUCCESS;
2208 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2209 {
2210 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
2211 pImage->Header.u.v1.uuidParentModify = *pUuid;
2212 else
2213 {
2214 LogFunc(("Version is not supported!\n"));
2215 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
2216 }
2217 }
2218 else
2219 rc = VERR_VD_IMAGE_READ_ONLY;
2220
2221 LogFlowFunc(("returns %Rrc\n", rc));
2222 return rc;
2223}
2224
2225/** @copydoc VDIMAGEBACKEND::pfnDump */
2226static DECLCALLBACK(void) vdiDump(void *pBackendData)
2227{
2228 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2229
2230 AssertPtrReturnVoid(pImage);
2231 vdIfErrorMessage(pImage->pIfError, "Dumping VDI image \"%s\" mode=%s uOpenFlags=%X File=%#p\n",
2232 pImage->pszFilename,
2233 (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY) ? "r/o" : "r/w",
2234 pImage->uOpenFlags,
2235 pImage->pStorage);
2236 vdIfErrorMessage(pImage->pIfError, "Header: Version=%08X Type=%X Flags=%X Size=%llu\n",
2237 pImage->PreHeader.u32Version,
2238 getImageType(&pImage->Header),
2239 getImageFlags(&pImage->Header),
2240 getImageDiskSize(&pImage->Header));
2241 vdIfErrorMessage(pImage->pIfError, "Header: cbBlock=%u cbBlockExtra=%u cBlocks=%u cBlocksAllocated=%u\n",
2242 getImageBlockSize(&pImage->Header),
2243 getImageExtraBlockSize(&pImage->Header),
2244 getImageBlocks(&pImage->Header),
2245 getImageBlocksAllocated(&pImage->Header));
2246 vdIfErrorMessage(pImage->pIfError, "Header: offBlocks=%u offData=%u\n",
2247 getImageBlocksOffset(&pImage->Header),
2248 getImageDataOffset(&pImage->Header));
2249 PVDIDISKGEOMETRY pg = getImageLCHSGeometry(&pImage->Header);
2250 if (pg)
2251 vdIfErrorMessage(pImage->pIfError, "Header: Geometry: C/H/S=%u/%u/%u cbSector=%u\n",
2252 pg->cCylinders, pg->cHeads, pg->cSectors, pg->cbSector);
2253 vdIfErrorMessage(pImage->pIfError, "Header: uuidCreation={%RTuuid}\n", getImageCreationUUID(&pImage->Header));
2254 vdIfErrorMessage(pImage->pIfError, "Header: uuidModification={%RTuuid}\n", getImageModificationUUID(&pImage->Header));
2255 vdIfErrorMessage(pImage->pIfError, "Header: uuidParent={%RTuuid}\n", getImageParentUUID(&pImage->Header));
2256 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) >= 1)
2257 vdIfErrorMessage(pImage->pIfError, "Header: uuidParentModification={%RTuuid}\n", getImageParentModificationUUID(&pImage->Header));
2258 vdIfErrorMessage(pImage->pIfError, "Image: fFlags=%08X offStartBlocks=%u offStartData=%u\n",
2259 pImage->uImageFlags, pImage->offStartBlocks, pImage->offStartData);
2260 vdIfErrorMessage(pImage->pIfError, "Image: uBlockMask=%08X cbTotalBlockData=%u uShiftOffset2Index=%u offStartBlockData=%u\n",
2261 pImage->uBlockMask,
2262 pImage->cbTotalBlockData,
2263 pImage->uShiftOffset2Index,
2264 pImage->offStartBlockData);
2265
2266 unsigned uBlock, cBlocksNotFree, cBadBlocks, cBlocks = getImageBlocks(&pImage->Header);
2267 for (uBlock=0, cBlocksNotFree=0, cBadBlocks=0; uBlock<cBlocks; uBlock++)
2268 {
2269 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
2270 {
2271 cBlocksNotFree++;
2272 if (pImage->paBlocks[uBlock] >= cBlocks)
2273 cBadBlocks++;
2274 }
2275 }
2276 if (cBlocksNotFree != getImageBlocksAllocated(&pImage->Header))
2277 {
2278 vdIfErrorMessage(pImage->pIfError, "!! WARNING: %u blocks actually allocated (cBlocksAllocated=%u) !!\n",
2279 cBlocksNotFree, getImageBlocksAllocated(&pImage->Header));
2280 }
2281 if (cBadBlocks)
2282 {
2283 vdIfErrorMessage(pImage->pIfError, "!! WARNING: %u bad blocks found !!\n",
2284 cBadBlocks);
2285 }
2286}
2287
2288/** @copydoc VDIMAGEBACKEND::pfnCompact */
2289static DECLCALLBACK(int) vdiCompact(void *pBackendData, unsigned uPercentStart,
2290 unsigned uPercentSpan, PVDINTERFACE pVDIfsDisk,
2291 PVDINTERFACE pVDIfsImage, PVDINTERFACE pVDIfsOperation)
2292{
2293 RT_NOREF2(pVDIfsDisk, pVDIfsImage);
2294 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2295 int rc = VINF_SUCCESS;
2296 void *pvBuf = NULL, *pvTmp = NULL;
2297 unsigned *paBlocks2 = NULL;
2298
2299 DECLCALLBACKMEMBER(int, pfnParentRead)(void *, uint64_t, void *, size_t) = NULL;
2300 void *pvParent = NULL;
2301 PVDINTERFACEPARENTSTATE pIfParentState = VDIfParentStateGet(pVDIfsOperation);
2302 if (pIfParentState)
2303 {
2304 pfnParentRead = pIfParentState->pfnParentRead;
2305 pvParent = pIfParentState->Core.pvUser;
2306 }
2307
2308 PVDINTERFACEPROGRESS pIfProgress = VDIfProgressGet(pVDIfsOperation);
2309 PVDINTERFACEQUERYRANGEUSE pIfQueryRangeUse = VDIfQueryRangeUseGet(pVDIfsOperation);
2310
2311 do
2312 {
2313 AssertBreakStmt(pImage, rc = VERR_INVALID_PARAMETER);
2314
2315 AssertBreakStmt(!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY),
2316 rc = VERR_VD_IMAGE_READ_ONLY);
2317
2318 unsigned cBlocks;
2319 unsigned cBlocksToMove = 0;
2320 size_t cbBlock;
2321 cBlocks = getImageBlocks(&pImage->Header);
2322 cbBlock = getImageBlockSize(&pImage->Header);
2323 if (pfnParentRead)
2324 {
2325 pvBuf = RTMemTmpAlloc(cbBlock);
2326 AssertBreakStmt(pvBuf, rc = VERR_NO_MEMORY);
2327 }
2328 pvTmp = RTMemTmpAlloc(cbBlock);
2329 AssertBreakStmt(pvTmp, rc = VERR_NO_MEMORY);
2330
2331 uint64_t cbFile;
2332 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
2333 AssertRCBreak(rc);
2334 unsigned cBlocksAllocated = (unsigned)((cbFile - pImage->offStartData - pImage->offStartBlockData) >> pImage->uShiftOffset2Index);
2335 if (cBlocksAllocated == 0)
2336 {
2337 /* No data blocks in this image, no need to compact. */
2338 rc = VINF_SUCCESS;
2339 break;
2340 }
2341
2342 /* Allocate block array for back resolving. */
2343 paBlocks2 = (unsigned *)RTMemAlloc(sizeof(unsigned *) * cBlocksAllocated);
2344 AssertBreakStmt(paBlocks2, rc = VERR_NO_MEMORY);
2345 /* Fill out back resolving, check/fix allocation errors before
2346 * compacting the image, just to be on the safe side. Update the
2347 * image contents straight away, as this enables cancelling. */
2348 for (unsigned i = 0; i < cBlocksAllocated; i++)
2349 paBlocks2[i] = VDI_IMAGE_BLOCK_FREE;
2350 rc = VINF_SUCCESS;
2351 for (unsigned i = 0; i < cBlocks; i++)
2352 {
2353 VDIIMAGEBLOCKPOINTER ptrBlock = pImage->paBlocks[i];
2354 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock))
2355 {
2356 if (ptrBlock < cBlocksAllocated)
2357 {
2358 if (paBlocks2[ptrBlock] == VDI_IMAGE_BLOCK_FREE)
2359 paBlocks2[ptrBlock] = i;
2360 else
2361 {
2362 LogFunc(("Freed cross-linked block %u in file \"%s\"\n",
2363 i, pImage->pszFilename));
2364 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2365 rc = vdiUpdateBlockInfo(pImage, i);
2366 if (RT_FAILURE(rc))
2367 break;
2368 }
2369 }
2370 else
2371 {
2372 LogFunc(("Freed out of bounds reference for block %u in file \"%s\"\n",
2373 i, pImage->pszFilename));
2374 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2375 rc = vdiUpdateBlockInfo(pImage, i);
2376 if (RT_FAILURE(rc))
2377 break;
2378 }
2379 }
2380 }
2381 if (RT_FAILURE(rc))
2382 break;
2383
2384 /* Find redundant information and update the block pointers
2385 * accordingly, creating bubbles. Keep disk up to date, as this
2386 * enables cancelling. */
2387 for (unsigned i = 0; i < cBlocks; i++)
2388 {
2389 VDIIMAGEBLOCKPOINTER ptrBlock = pImage->paBlocks[i];
2390 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock))
2391 {
2392 /* Block present in image file, read relevant data. */
2393 uint64_t u64Offset = (uint64_t)ptrBlock * pImage->cbTotalBlockData
2394 + (pImage->offStartData + pImage->offStartBlockData);
2395 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, u64Offset, pvTmp, cbBlock);
2396 if (RT_FAILURE(rc))
2397 break;
2398
2399 if (ASMBitFirstSet((volatile void *)pvTmp, (uint32_t)cbBlock * 8) == -1)
2400 {
2401 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_ZERO;
2402 rc = vdiUpdateBlockInfo(pImage, i);
2403 if (RT_FAILURE(rc))
2404 break;
2405 paBlocks2[ptrBlock] = VDI_IMAGE_BLOCK_FREE;
2406 /* Adjust progress info, one block to be relocated. */
2407 cBlocksToMove++;
2408 }
2409 else if (pfnParentRead)
2410 {
2411 rc = pfnParentRead(pvParent, (uint64_t)i * cbBlock, pvBuf, cbBlock);
2412 if (RT_FAILURE(rc))
2413 break;
2414 if (!memcmp(pvTmp, pvBuf, cbBlock))
2415 {
2416 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2417 rc = vdiUpdateBlockInfo(pImage, i);
2418 if (RT_FAILURE(rc))
2419 break;
2420 paBlocks2[ptrBlock] = VDI_IMAGE_BLOCK_FREE;
2421 /* Adjust progress info, one block to be relocated. */
2422 cBlocksToMove++;
2423 }
2424 }
2425 }
2426
2427 /* Check if the range is in use if the block is still allocated. */
2428 ptrBlock = pImage->paBlocks[i];
2429 if ( IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock)
2430 && pIfQueryRangeUse)
2431 {
2432 bool fUsed = true;
2433
2434 rc = vdIfQueryRangeUse(pIfQueryRangeUse, (uint64_t)i * cbBlock, cbBlock, &fUsed);
2435 if (RT_FAILURE(rc))
2436 break;
2437 if (!fUsed)
2438 {
2439 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_ZERO;
2440 rc = vdiUpdateBlockInfo(pImage, i);
2441 if (RT_FAILURE(rc))
2442 break;
2443 paBlocks2[ptrBlock] = VDI_IMAGE_BLOCK_FREE;
2444 /* Adjust progress info, one block to be relocated. */
2445 cBlocksToMove++;
2446 }
2447 }
2448
2449 vdIfProgress(pIfProgress, (uint64_t)i * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2450 if (RT_FAILURE(rc))
2451 break;
2452 }
2453 if (RT_FAILURE(rc))
2454 break;
2455
2456 /* Fill bubbles with other data (if available). */
2457 unsigned cBlocksMoved = 0;
2458 unsigned uBlockUsedPos = cBlocksAllocated;
2459 for (unsigned i = 0; i < cBlocksAllocated; i++)
2460 {
2461 unsigned uBlock = paBlocks2[i];
2462 if (uBlock == VDI_IMAGE_BLOCK_FREE)
2463 {
2464 unsigned uBlockData = VDI_IMAGE_BLOCK_FREE;
2465 while (uBlockUsedPos > i && uBlockData == VDI_IMAGE_BLOCK_FREE)
2466 {
2467 uBlockUsedPos--;
2468 uBlockData = paBlocks2[uBlockUsedPos];
2469 }
2470 /* Terminate early if there is no block which needs copying. */
2471 if (uBlockUsedPos == i)
2472 break;
2473 uint64_t u64Offset = (uint64_t)uBlockUsedPos * pImage->cbTotalBlockData
2474 + (pImage->offStartData + pImage->offStartBlockData);
2475 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, u64Offset,
2476 pvTmp, cbBlock);
2477 u64Offset = (uint64_t)i * pImage->cbTotalBlockData
2478 + (pImage->offStartData + pImage->offStartBlockData);
2479 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, u64Offset,
2480 pvTmp, cbBlock);
2481 pImage->paBlocks[uBlockData] = i;
2482 setImageBlocksAllocated(&pImage->Header, cBlocksAllocated - cBlocksMoved);
2483 rc = vdiUpdateBlockInfo(pImage, uBlockData);
2484 if (RT_FAILURE(rc))
2485 break;
2486 paBlocks2[i] = uBlockData;
2487 paBlocks2[uBlockUsedPos] = VDI_IMAGE_BLOCK_FREE;
2488 cBlocksMoved++;
2489 }
2490
2491 rc = vdIfProgress(pIfProgress, (uint64_t)(cBlocks + cBlocksMoved) * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2492 if (RT_FAILURE(rc))
2493 break;
2494 }
2495 if (RT_FAILURE(rc))
2496 break;
2497
2498 /* Update image header. */
2499 setImageBlocksAllocated(&pImage->Header, uBlockUsedPos);
2500 vdiUpdateHeader(pImage);
2501
2502 /* Truncate the image to the proper size to finish compacting. */
2503 rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage,
2504 (uint64_t)uBlockUsedPos * pImage->cbTotalBlockData
2505 + pImage->offStartData + pImage->offStartBlockData);
2506 } while (0);
2507
2508 if (paBlocks2)
2509 RTMemTmpFree(paBlocks2);
2510 if (pvTmp)
2511 RTMemTmpFree(pvTmp);
2512 if (pvBuf)
2513 RTMemTmpFree(pvBuf);
2514
2515 if (RT_SUCCESS(rc))
2516 vdIfProgress(pIfProgress, uPercentStart + uPercentSpan);
2517
2518 LogFlowFunc(("returns %Rrc\n", rc));
2519 return rc;
2520}
2521
2522
2523/** @copydoc VDIMAGEBACKEND::pfnResize */
2524static DECLCALLBACK(int) vdiResize(void *pBackendData, uint64_t cbSize,
2525 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
2526 unsigned uPercentStart, unsigned uPercentSpan,
2527 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
2528 PVDINTERFACE pVDIfsOperation)
2529{
2530 RT_NOREF5(uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation);
2531 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2532 int rc = VINF_SUCCESS;
2533
2534 /* Check size. Maximum 4PB-3M. No tricks with adjusting the 1M block size
2535 * so far, which would extend the size. */
2536 if ( !cbSize
2537 || cbSize >= _1P * 4 - _1M * 3
2538 || cbSize < VDI_IMAGE_DEFAULT_BLOCK_SIZE)
2539 return VERR_VD_INVALID_SIZE;
2540
2541 /*
2542 * Making the image smaller is not supported at the moment.
2543 * Resizing is also not supported for fixed size images and
2544 * very old images.
2545 */
2546 /** @todo implement making the image smaller, it is the responsibility of
2547 * the user to know what he's doing. */
2548 if (cbSize < getImageDiskSize(&pImage->Header))
2549 rc = VERR_VD_SHRINK_NOT_SUPPORTED;
2550 else if ( GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0
2551 || pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED)
2552 rc = VERR_NOT_SUPPORTED;
2553 else if (cbSize > getImageDiskSize(&pImage->Header))
2554 {
2555 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header); /** < Blocks currently allocated, doesn't change during resize */
2556 uint32_t cBlocksNew = cbSize / getImageBlockSize(&pImage->Header); /** < New number of blocks in the image after the resize */
2557 if (cbSize % getImageBlockSize(&pImage->Header))
2558 cBlocksNew++;
2559
2560 uint32_t cBlocksOld = getImageBlocks(&pImage->Header); /** < Number of blocks before the resize. */
2561 uint64_t cbBlockspaceNew = cBlocksNew * sizeof(VDIIMAGEBLOCKPOINTER); /** < Required space for the block array after the resize. */
2562 uint64_t offStartDataNew = RT_ALIGN_32(pImage->offStartBlocks + cbBlockspaceNew, VDI_DATA_ALIGN); /** < New start offset for block data after the resize */
2563
2564 if (pImage->offStartData < offStartDataNew)
2565 {
2566 if (cBlocksAllocated > 0)
2567 {
2568 /* Calculate how many sectors need to be relocated. */
2569 uint64_t cbOverlapping = offStartDataNew - pImage->offStartData;
2570 unsigned cBlocksReloc = cbOverlapping / getImageBlockSize(&pImage->Header);
2571 if (cbOverlapping % getImageBlockSize(&pImage->Header))
2572 cBlocksReloc++;
2573
2574 /* Since only full blocks can be relocated the new data start is
2575 * determined by moving it block by block. */
2576 cBlocksReloc = RT_MIN(cBlocksReloc, cBlocksAllocated);
2577 offStartDataNew = pImage->offStartData;
2578
2579 /* Do the relocation. */
2580 LogFlow(("Relocating %u blocks\n", cBlocksReloc));
2581
2582 /*
2583 * Get the blocks we need to relocate first, they are appended to the end
2584 * of the image.
2585 */
2586 void *pvBuf = NULL, *pvZero = NULL;
2587 do
2588 {
2589 /* Allocate data buffer. */
2590 pvBuf = RTMemAllocZ(pImage->cbTotalBlockData);
2591 if (!pvBuf)
2592 {
2593 rc = VERR_NO_MEMORY;
2594 break;
2595 }
2596
2597 /* Allocate buffer for overwriting with zeroes. */
2598 pvZero = RTMemAllocZ(pImage->cbTotalBlockData);
2599 if (!pvZero)
2600 {
2601 rc = VERR_NO_MEMORY;
2602 break;
2603 }
2604
2605 for (unsigned i = 0; i < cBlocksReloc; i++)
2606 {
2607 /* Search the index in the block table. */
2608 for (unsigned idxBlock = 0; idxBlock < cBlocksOld; idxBlock++)
2609 {
2610 if (!pImage->paBlocks[idxBlock])
2611 {
2612 /* Read data and append to the end of the image. */
2613 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
2614 offStartDataNew, pvBuf,
2615 pImage->cbTotalBlockData);
2616 if (RT_FAILURE(rc))
2617 break;
2618
2619 uint64_t offBlockAppend;
2620 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &offBlockAppend);
2621 if (RT_FAILURE(rc))
2622 break;
2623
2624 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
2625 offBlockAppend, pvBuf,
2626 pImage->cbTotalBlockData);
2627 if (RT_FAILURE(rc))
2628 break;
2629
2630 /* Zero out the old block area. */
2631 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
2632 offStartDataNew, pvZero,
2633 pImage->cbTotalBlockData);
2634 if (RT_FAILURE(rc))
2635 break;
2636
2637 /* Update block counter. */
2638 pImage->paBlocks[idxBlock] = cBlocksAllocated - 1;
2639
2640 /*
2641 * Decrease the block number of all other entries in the array.
2642 * They were moved one block to the front.
2643 * Doing it as a separate step iterating over the array again
2644 * because an error while relocating the block might end up
2645 * in a corrupted image otherwise.
2646 */
2647 for (unsigned idxBlock2 = 0; idxBlock2 < cBlocksOld; idxBlock2++)
2648 {
2649 if ( idxBlock2 != idxBlock
2650 && IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[idxBlock2]))
2651 pImage->paBlocks[idxBlock2]--;
2652 }
2653
2654 /* Continue with the next block. */
2655 break;
2656 }
2657 }
2658
2659 if (RT_FAILURE(rc))
2660 break;
2661
2662 offStartDataNew += pImage->cbTotalBlockData;
2663 }
2664 } while (0);
2665
2666 if (pvBuf)
2667 RTMemFree(pvBuf);
2668 if (pvZero)
2669 RTMemFree(pvZero);
2670 }
2671
2672 /*
2673 * We need to update the new offsets for the image data in the out of memory
2674 * case too because we relocated the blocks already.
2675 */
2676 pImage->offStartData = offStartDataNew;
2677 setImageDataOffset(&pImage->Header, offStartDataNew);
2678 }
2679
2680 /*
2681 * Relocation done, expand the block array and update the header with
2682 * the new data.
2683 */
2684 if (RT_SUCCESS(rc))
2685 {
2686 PVDIIMAGEBLOCKPOINTER paBlocksNew = (PVDIIMAGEBLOCKPOINTER)RTMemRealloc(pImage->paBlocks, cbBlockspaceNew);
2687 if (paBlocksNew)
2688 {
2689 pImage->paBlocks = paBlocksNew;
2690
2691 /* Mark the new blocks as unallocated. */
2692 for (unsigned idxBlock = cBlocksOld; idxBlock < cBlocksNew; idxBlock++)
2693 pImage->paBlocks[idxBlock] = VDI_IMAGE_BLOCK_FREE;
2694 }
2695 else
2696 rc = VERR_NO_MEMORY;
2697
2698 /* Write the block array before updating the rest. */
2699 vdiConvBlocksEndianess(VDIECONV_H2F, pImage->paBlocks, cBlocksNew);
2700 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, pImage->offStartBlocks,
2701 pImage->paBlocks, cbBlockspaceNew);
2702 vdiConvBlocksEndianess(VDIECONV_F2H, pImage->paBlocks, cBlocksNew);
2703
2704 if (RT_SUCCESS(rc))
2705 {
2706 /* Update size and new block count. */
2707 setImageDiskSize(&pImage->Header, cbSize);
2708 setImageBlocks(&pImage->Header, cBlocksNew);
2709 /* Update geometry. */
2710 pImage->PCHSGeometry = *pPCHSGeometry;
2711 pImage->cbImage = cbSize;
2712
2713 PVDIDISKGEOMETRY pGeometry = getImageLCHSGeometry(&pImage->Header);
2714 if (pGeometry)
2715 {
2716 pGeometry->cCylinders = pLCHSGeometry->cCylinders;
2717 pGeometry->cHeads = pLCHSGeometry->cHeads;
2718 pGeometry->cSectors = pLCHSGeometry->cSectors;
2719 pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
2720 }
2721 }
2722 }
2723
2724 /* Update header information in base image file. */
2725 vdiFlushImage(pImage);
2726 }
2727 /* Same size doesn't change the image at all. */
2728
2729 LogFlowFunc(("returns %Rrc\n", rc));
2730 return rc;
2731}
2732
2733/** @copydoc VDIMAGEBACKEND::pfnDiscard */
2734static DECLCALLBACK(int) vdiDiscard(void *pBackendData, PVDIOCTX pIoCtx,
2735 uint64_t uOffset, size_t cbDiscard,
2736 size_t *pcbPreAllocated, size_t *pcbPostAllocated,
2737 size_t *pcbActuallyDiscarded, void **ppbmAllocationBitmap,
2738 unsigned fDiscard)
2739{
2740 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2741 unsigned uBlock;
2742 unsigned offDiscard;
2743 int rc = VINF_SUCCESS;
2744 void *pvBlock = NULL;
2745
2746 LogFlowFunc(("pBackendData=%#p pIoCtx=%#p uOffset=%llu cbDiscard=%zu pcbPreAllocated=%#p pcbPostAllocated=%#p pcbActuallyDiscarded=%#p ppbmAllocationBitmap=%#p fDiscard=%#x\n",
2747 pBackendData, pIoCtx, uOffset, cbDiscard, pcbPreAllocated, pcbPostAllocated, pcbActuallyDiscarded, ppbmAllocationBitmap, fDiscard));
2748
2749 AssertPtr(pImage);
2750 Assert(!(uOffset % 512));
2751 Assert(!(cbDiscard % 512));
2752
2753 AssertMsgReturn(!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY),
2754 ("Image is readonly\n"), VERR_VD_IMAGE_READ_ONLY);
2755 AssertMsgReturn( uOffset + cbDiscard <= getImageDiskSize(&pImage->Header)
2756 && cbDiscard,
2757 ("Invalid parameters uOffset=%llu cbDiscard=%zu\n",
2758 uOffset, cbDiscard),
2759 VERR_INVALID_PARAMETER);
2760
2761 do
2762 {
2763 AssertMsgBreakStmt(!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY),
2764 ("Image is opened readonly\n"),
2765 rc = VERR_VD_IMAGE_READ_ONLY);
2766
2767 AssertMsgBreakStmt(cbDiscard,
2768 ("cbDiscard=%u\n", cbDiscard),
2769 rc = VERR_INVALID_PARAMETER);
2770
2771 /* Calculate starting block number and offset inside it. */
2772 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
2773 offDiscard = (unsigned)uOffset & pImage->uBlockMask;
2774
2775 /* Clip range to at most the rest of the block. */
2776 cbDiscard = RT_MIN(cbDiscard, getImageBlockSize(&pImage->Header) - offDiscard);
2777 Assert(!(cbDiscard % 512));
2778
2779 if (pcbPreAllocated)
2780 *pcbPreAllocated = 0;
2781
2782 if (pcbPostAllocated)
2783 *pcbPostAllocated = 0;
2784
2785 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
2786 {
2787 uint8_t *pbBlockData;
2788 size_t cbPreAllocated, cbPostAllocated;
2789
2790 cbPreAllocated = offDiscard % getImageBlockSize(&pImage->Header);
2791 cbPostAllocated = getImageBlockSize(&pImage->Header) - cbDiscard - cbPreAllocated;
2792
2793 /* Read the block data. */
2794 pvBlock = RTMemAlloc(pImage->cbTotalBlockData);
2795 if (!pvBlock)
2796 {
2797 rc = VERR_NO_MEMORY;
2798 break;
2799 }
2800
2801 if (!cbPreAllocated && !cbPostAllocated)
2802 {
2803 /*
2804 * Discarding a whole block, don't check for allocated sectors.
2805 * It is possible to just remove the whole block which avoids
2806 * one read and checking the whole block for data.
2807 */
2808 rc = vdiDiscardBlockAsync(pImage, pIoCtx, uBlock, pvBlock);
2809 }
2810 else if (fDiscard & VD_DISCARD_MARK_UNUSED)
2811 {
2812 /* Just zero out the given range. */
2813 memset(pvBlock, 0, cbDiscard);
2814
2815 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData + pImage->offStartData + offDiscard;
2816 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
2817 u64Offset, pvBlock, cbDiscard, pIoCtx,
2818 NULL, NULL);
2819 RTMemFree(pvBlock);
2820 }
2821 else
2822 {
2823 /*
2824 * Read complete block as metadata, the I/O context has no memory buffer
2825 * and we need to access the content directly anyway.
2826 */
2827 PVDMETAXFER pMetaXfer;
2828 pbBlockData = (uint8_t *)pvBlock + pImage->offStartBlockData;
2829
2830 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData + pImage->offStartData;
2831 rc = vdIfIoIntFileReadMeta(pImage->pIfIo, pImage->pStorage, u64Offset,
2832 pbBlockData, pImage->cbTotalBlockData,
2833 pIoCtx, &pMetaXfer, NULL, NULL);
2834 if (RT_FAILURE(rc))
2835 {
2836 RTMemFree(pvBlock);
2837 break;
2838 }
2839
2840 vdIfIoIntMetaXferRelease(pImage->pIfIo, pMetaXfer);
2841
2842 /* Clear data. */
2843 memset(pbBlockData + offDiscard , 0, cbDiscard);
2844
2845 Assert(!(cbDiscard % 4));
2846 Assert(getImageBlockSize(&pImage->Header) * 8 <= UINT32_MAX);
2847 if (ASMBitFirstSet((volatile void *)pbBlockData, getImageBlockSize(&pImage->Header) * 8) == -1)
2848 rc = vdiDiscardBlockAsync(pImage, pIoCtx, uBlock, pvBlock);
2849 else
2850 {
2851 /* Block has data, create allocation bitmap. */
2852 *pcbPreAllocated = cbPreAllocated;
2853 *pcbPostAllocated = cbPostAllocated;
2854 *ppbmAllocationBitmap = vdiAllocationBitmapCreate(pbBlockData, getImageBlockSize(&pImage->Header));
2855 if (RT_UNLIKELY(!*ppbmAllocationBitmap))
2856 rc = VERR_NO_MEMORY;
2857 else
2858 rc = VERR_VD_DISCARD_ALIGNMENT_NOT_MET;
2859
2860 RTMemFree(pvBlock);
2861 }
2862 } /* if: no complete block discarded */
2863 } /* if: Block is allocated. */
2864 /* else: nothing to do. */
2865 } while (0);
2866
2867 if (pcbActuallyDiscarded)
2868 *pcbActuallyDiscarded = cbDiscard;
2869
2870 LogFlowFunc(("returns %Rrc\n", rc));
2871 return rc;
2872}
2873
2874/** @copydoc VDIMAGEBACKEND::pfnRepair */
2875static DECLCALLBACK(int) vdiRepair(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
2876 PVDINTERFACE pVDIfsImage, uint32_t fFlags)
2877{
2878 LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p\n", pszFilename, pVDIfsDisk, pVDIfsImage));
2879 int rc;
2880 PVDINTERFACEERROR pIfError;
2881 PVDINTERFACEIOINT pIfIo;
2882 PVDIOSTORAGE pStorage;
2883 uint64_t cbFile;
2884 PVDIIMAGEBLOCKPOINTER paBlocks = NULL;
2885 uint32_t *pu32BlockBitmap = NULL;
2886 VDIPREHEADER PreHdr;
2887 VDIHEADER Hdr;
2888
2889 pIfIo = VDIfIoIntGet(pVDIfsImage);
2890 AssertPtrReturn(pIfIo, VERR_INVALID_PARAMETER);
2891
2892 pIfError = VDIfErrorGet(pVDIfsDisk);
2893
2894 do
2895 {
2896 bool fRepairBlockArray = false;
2897 bool fRepairHdr = false;
2898
2899 rc = vdIfIoIntFileOpen(pIfIo, pszFilename,
2900 VDOpenFlagsToFileOpenFlags( fFlags & VD_REPAIR_DRY_RUN
2901 ? VD_OPEN_FLAGS_READONLY
2902 : 0,
2903 false /* fCreate */),
2904 &pStorage);
2905 if (RT_FAILURE(rc))
2906 {
2907 rc = vdIfError(pIfError, rc, RT_SRC_POS, "VDI: Failed to open image \"%s\"", pszFilename);
2908 break;
2909 }
2910
2911 rc = vdIfIoIntFileGetSize(pIfIo, pStorage, &cbFile);
2912 if (RT_FAILURE(rc))
2913 {
2914 rc = vdIfError(pIfError, rc, RT_SRC_POS, "VDI: Failed to query image size");
2915 break;
2916 }
2917
2918 /* Read pre-header. */
2919 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, 0, &PreHdr, sizeof(PreHdr));
2920 if (RT_FAILURE(rc))
2921 {
2922 rc = vdIfError(pIfError, rc, RT_SRC_POS, N_("VDI: Error reading pre-header in '%s'"), pszFilename);
2923 break;
2924 }
2925 vdiConvPreHeaderEndianess(VDIECONV_F2H, &PreHdr, &PreHdr);
2926 rc = vdiValidatePreHeader(&PreHdr);
2927 if (RT_FAILURE(rc))
2928 {
2929 rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
2930 N_("VDI: invalid pre-header in '%s'"), pszFilename);
2931 break;
2932 }
2933
2934 /* Read header. */
2935 Hdr.uVersion = PreHdr.u32Version;
2936 switch (GET_MAJOR_HEADER_VERSION(&Hdr))
2937 {
2938 case 0:
2939 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, sizeof(PreHdr),
2940 &Hdr.u.v0, sizeof(Hdr.u.v0));
2941 if (RT_FAILURE(rc))
2942 rc = vdIfError(pIfError, rc, RT_SRC_POS, N_("VDI: error reading v0 header in '%s'"),
2943 pszFilename);
2944 vdiConvHeaderEndianessV0(VDIECONV_F2H, &Hdr.u.v0, &Hdr.u.v0);
2945 break;
2946 case 1:
2947 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, sizeof(PreHdr),
2948 &Hdr.u.v1, sizeof(Hdr.u.v1));
2949 if (RT_FAILURE(rc))
2950 {
2951 rc = vdIfError(pIfError, rc, RT_SRC_POS, N_("VDI: error reading v1 header in '%s'"),
2952 pszFilename);
2953 }
2954 vdiConvHeaderEndianessV1(VDIECONV_F2H, &Hdr.u.v1, &Hdr.u.v1);
2955 if (Hdr.u.v1.cbHeader >= sizeof(Hdr.u.v1plus))
2956 {
2957 /* Read the VDI 1.1+ header completely. */
2958 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, sizeof(PreHdr),
2959 &Hdr.u.v1plus, sizeof(Hdr.u.v1plus));
2960 if (RT_FAILURE(rc))
2961 rc = vdIfError(pIfError, rc, RT_SRC_POS, N_("VDI: error reading v1.1+ header in '%s'"),
2962 pszFilename);
2963 vdiConvHeaderEndianessV1p(VDIECONV_F2H, &Hdr.u.v1plus, &Hdr.u.v1plus);
2964 }
2965 break;
2966 default:
2967 rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
2968 N_("VDI: unsupported major version %u in '%s'"),
2969 GET_MAJOR_HEADER_VERSION(&Hdr), pszFilename);
2970 break;
2971 }
2972
2973 if (RT_SUCCESS(rc))
2974 {
2975 rc = vdiValidateHeader(&Hdr);
2976 if (RT_FAILURE(rc))
2977 {
2978 rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
2979 N_("VDI: invalid header in '%s'"), pszFilename);
2980 break;
2981 }
2982 }
2983
2984 /*
2985 * Check that the disk size is correctly aligned,
2986 * see comment above the same check in vdiImageReadHeader().
2987 */
2988 uint64_t cbDisk = getImageDiskSize(&Hdr);
2989 if (cbDisk & 0x1ff)
2990 {
2991 uint64_t cbDiskNew = cbDisk & ~UINT64_C(0x1ff);
2992 vdIfErrorMessage(pIfError, "Disk size in the header is not sector aligned, rounding down (%llu -> %llu)\n",
2993 cbDisk, cbDiskNew);
2994 setImageDiskSize(&Hdr, cbDiskNew);
2995 fRepairHdr = true;
2996 }
2997
2998 /* Setup image parameters by header. */
2999 uint64_t offStartBlocks, offStartData;
3000 size_t cbTotalBlockData;
3001
3002 offStartBlocks = getImageBlocksOffset(&Hdr);
3003 offStartData = getImageDataOffset(&Hdr);
3004 cbTotalBlockData = getImageExtraBlockSize(&Hdr) + getImageBlockSize(&Hdr);
3005
3006 /* Allocate memory for blocks array. */
3007 paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&Hdr));
3008 if (!paBlocks)
3009 {
3010 rc = vdIfError(pIfError, VERR_NO_MEMORY, RT_SRC_POS,
3011 "Failed to allocate memory for block array");
3012 break;
3013 }
3014
3015 /* Read blocks array. */
3016 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, offStartBlocks, paBlocks,
3017 getImageBlocks(&Hdr) * sizeof(VDIIMAGEBLOCKPOINTER));
3018 if (RT_FAILURE(rc))
3019 {
3020 rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3021 "Failed to read block array (at %llu), %Rrc",
3022 offStartBlocks, rc);
3023 break;
3024 }
3025 vdiConvBlocksEndianess(VDIECONV_F2H, paBlocks, getImageBlocks(&Hdr));
3026
3027 pu32BlockBitmap = (uint32_t *)RTMemAllocZ(RT_ALIGN_Z(getImageBlocks(&Hdr) / 8, 4));
3028 if (!pu32BlockBitmap)
3029 {
3030 rc = vdIfError(pIfError, VERR_NO_MEMORY, RT_SRC_POS,
3031 "Failed to allocate memory for block bitmap");
3032 break;
3033 }
3034
3035 for (uint32_t i = 0; i < getImageBlocks(&Hdr); i++)
3036 {
3037 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(paBlocks[i]))
3038 {
3039 uint64_t offBlock = (uint64_t)paBlocks[i] * cbTotalBlockData
3040 + offStartData;
3041
3042 /*
3043 * Check that the offsets are valid (inside of the image) and
3044 * that there are no double references.
3045 */
3046 if (offBlock + cbTotalBlockData > cbFile)
3047 {
3048 vdIfErrorMessage(pIfError, "Entry %u points to invalid offset %llu, clearing\n",
3049 i, offBlock);
3050 paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
3051 fRepairBlockArray = true;
3052 }
3053 else if (ASMBitTestAndSet(pu32BlockBitmap, paBlocks[i]))
3054 {
3055 vdIfErrorMessage(pIfError, "Entry %u points to an already referenced data block, clearing\n",
3056 i);
3057 paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
3058 fRepairBlockArray = true;
3059 }
3060 }
3061 }
3062
3063 /* Write repaired structures now. */
3064 if (!fRepairBlockArray && !fRepairHdr)
3065 vdIfErrorMessage(pIfError, "VDI image is in a consistent state, no repair required\n");
3066 else if (!(fFlags & VD_REPAIR_DRY_RUN))
3067 {
3068 if (fRepairHdr)
3069 {
3070 switch (GET_MAJOR_HEADER_VERSION(&Hdr))
3071 {
3072 case 0:
3073 {
3074 VDIHEADER0 Hdr0;
3075 vdiConvHeaderEndianessV0(VDIECONV_H2F, &Hdr0, &Hdr.u.v0);
3076 rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, sizeof(VDIPREHEADER),
3077 &Hdr0, sizeof(Hdr0));
3078 break;
3079 }
3080 case 1:
3081 if (Hdr.u.v1plus.cbHeader < sizeof(Hdr.u.v1plus))
3082 {
3083 VDIHEADER1 Hdr1;
3084 vdiConvHeaderEndianessV1(VDIECONV_H2F, &Hdr1, &Hdr.u.v1);
3085 rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, sizeof(VDIPREHEADER),
3086 &Hdr1, sizeof(Hdr1));
3087 }
3088 else
3089 {
3090 VDIHEADER1PLUS Hdr1plus;
3091 vdiConvHeaderEndianessV1p(VDIECONV_H2F, &Hdr1plus, &Hdr.u.v1plus);
3092 rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, sizeof(VDIPREHEADER),
3093 &Hdr1plus, sizeof(Hdr1plus));
3094 }
3095 break;
3096 default:
3097 AssertMsgFailed(("Header indicates unsupported version which should not happen here!\n"));
3098 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
3099 break;
3100 }
3101 }
3102
3103 if (fRepairBlockArray)
3104 {
3105 vdIfErrorMessage(pIfError, "Writing repaired block allocation table...\n");
3106
3107 vdiConvBlocksEndianess(VDIECONV_H2F, paBlocks, getImageBlocks(&Hdr));
3108 rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, offStartBlocks, paBlocks,
3109 getImageBlocks(&Hdr) * sizeof(VDIIMAGEBLOCKPOINTER));
3110 if (RT_FAILURE(rc))
3111 {
3112 rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3113 "Could not write repaired block allocation table (at %llu), %Rrc",
3114 offStartBlocks, rc);
3115 break;
3116 }
3117 }
3118 }
3119
3120 vdIfErrorMessage(pIfError, "Corrupted VDI image repaired successfully\n");
3121 } while(0);
3122
3123 if (paBlocks)
3124 RTMemFree(paBlocks);
3125
3126 if (pu32BlockBitmap)
3127 RTMemFree(pu32BlockBitmap);
3128
3129 if (pStorage)
3130 {
3131 int rc2 = vdIfIoIntFileClose(pIfIo, pStorage);
3132 if (RT_SUCCESS(rc))
3133 rc = rc2; /* Propagate error code only if repairing was successful. */
3134 }
3135
3136 LogFlowFunc(("returns %Rrc\n", rc));
3137 return rc;
3138}
3139
3140const VDIMAGEBACKEND g_VDIBackend =
3141{
3142 /* u32Version */
3143 VD_IMGBACKEND_VERSION,
3144 /* pszBackendName */
3145 "VDI",
3146 /* uBackendCaps */
3147 VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
3148 | VD_CAP_DIFF | VD_CAP_FILE | VD_CAP_ASYNC | VD_CAP_VFS | VD_CAP_DISCARD
3149 | VD_CAP_PREFERRED,
3150 /* paFileExtensions */
3151 s_aVdiFileExtensions,
3152 /* paConfigInfo */
3153 vdiConfigInfo,
3154 /* pfnProbe */
3155 vdiProbe,
3156 /* pfnOpen */
3157 vdiOpen,
3158 /* pfnCreate */
3159 vdiCreate,
3160 /* pfnRename */
3161 vdiRename,
3162 /* pfnClose */
3163 vdiClose,
3164 /* pfnRead */
3165 vdiRead,
3166 /* pfnWrite */
3167 vdiWrite,
3168 /* pfnFlush */
3169 vdiFlush,
3170 /* pfnDiscard */
3171 vdiDiscard,
3172 /* pfnGetVersion */
3173 vdiGetVersion,
3174 /* pfnGetFileSize */
3175 vdiGetFileSize,
3176 /* pfnGetPCHSGeometry */
3177 vdiGetPCHSGeometry,
3178 /* pfnSetPCHSGeometry */
3179 vdiSetPCHSGeometry,
3180 /* pfnGetLCHSGeometry */
3181 vdiGetLCHSGeometry,
3182 /* pfnSetLCHSGeometry */
3183 vdiSetLCHSGeometry,
3184 /* pfnQueryRegions */
3185 vdiQueryRegions,
3186 /* pfnRegionListRelease */
3187 vdiRegionListRelease,
3188 /* pfnGetImageFlags */
3189 vdiGetImageFlags,
3190 /* pfnGetOpenFlags */
3191 vdiGetOpenFlags,
3192 /* pfnSetOpenFlags */
3193 vdiSetOpenFlags,
3194 /* pfnGetComment */
3195 vdiGetComment,
3196 /* pfnSetComment */
3197 vdiSetComment,
3198 /* pfnGetUuid */
3199 vdiGetUuid,
3200 /* pfnSetUuid */
3201 vdiSetUuid,
3202 /* pfnGetModificationUuid */
3203 vdiGetModificationUuid,
3204 /* pfnSetModificationUuid */
3205 vdiSetModificationUuid,
3206 /* pfnGetParentUuid */
3207 vdiGetParentUuid,
3208 /* pfnSetParentUuid */
3209 vdiSetParentUuid,
3210 /* pfnGetParentModificationUuid */
3211 vdiGetParentModificationUuid,
3212 /* pfnSetParentModificationUuid */
3213 vdiSetParentModificationUuid,
3214 /* pfnDump */
3215 vdiDump,
3216 /* pfnGetTimestamp */
3217 NULL,
3218 /* pfnGetParentTimestamp */
3219 NULL,
3220 /* pfnSetParentTimestamp */
3221 NULL,
3222 /* pfnGetParentFilename */
3223 NULL,
3224 /* pfnSetParentFilename */
3225 NULL,
3226 /* pfnComposeLocation */
3227 genericFileComposeLocation,
3228 /* pfnComposeName */
3229 genericFileComposeName,
3230 /* pfnCompact */
3231 vdiCompact,
3232 /* pfnResize */
3233 vdiResize,
3234 /* pfnRepair */
3235 vdiRepair,
3236 /* pfnTraverseMetadata */
3237 NULL,
3238 /* u32VersionEnd */
3239 VD_IMGBACKEND_VERSION
3240};
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use