VirtualBox

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

Last change on this file since 93115 was 93115, checked in by vboxsync, 3 years ago

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

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