VirtualBox

source: vbox/trunk/src/VBox/Devices/Storage/VDIHDDCore.cpp@ 33081

Last change on this file since 33081 was 33081, checked in by vboxsync, 14 years ago

Storage/VDI: fix a sneaky bug which led to temporary amnesia what the LCHS geometry is set for a newly created image

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 95.0 KB
Line 
1/** @file
2 * Virtual Disk Image (VDI), Core Code.
3 */
4
5/*
6 * Copyright (C) 2006-2010 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17/*******************************************************************************
18* Header Files *
19*******************************************************************************/
20#define LOG_GROUP LOG_GROUP_VD_VDI
21#include <VBox/VBoxHDD-Plugin.h>
22#define VBOX_VDICORE_VD /* Signal that the header is included from here. */
23#include "VDICore.h"
24#include <VBox/err.h>
25
26#include <VBox/log.h>
27#include <iprt/alloc.h>
28#include <iprt/assert.h>
29#include <iprt/uuid.h>
30#include <iprt/string.h>
31#include <iprt/asm.h>
32
33#define VDI_IMAGE_DEFAULT_BLOCK_SIZE _1M
34
35/*******************************************************************************
36* Static Variables *
37*******************************************************************************/
38
39/** NULL-terminated array of supported file extensions. */
40static const char *const s_apszVdiFileExtensions[] =
41{
42 "vdi",
43 NULL
44};
45
46/*******************************************************************************
47* Internal Functions *
48*******************************************************************************/
49static unsigned getPowerOfTwo(unsigned uNumber);
50static void vdiInitPreHeader(PVDIPREHEADER pPreHdr);
51static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr);
52static void vdiInitHeader(PVDIHEADER pHeader, uint32_t uImageFlags,
53 const char *pszComment, uint64_t cbDisk,
54 uint32_t cbBlock, uint32_t cbBlockExtra);
55static int vdiValidateHeader(PVDIHEADER pHeader);
56static void vdiSetupImageDesc(PVDIIMAGEDESC pImage);
57static int vdiUpdateHeader(PVDIIMAGEDESC pImage);
58static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock);
59static int vdiUpdateHeaderAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx);
60static int vdiUpdateBlockInfoAsync(PVDIIMAGEDESC pImage, unsigned uBlock, PVDIOCTX pIoCtx);
61
62/**
63 * Internal: signal an error to the frontend.
64 */
65DECLINLINE(int) vdiError(PVDIIMAGEDESC pImage, int rc, RT_SRC_POS_DECL,
66 const char *pszFormat, ...)
67{
68 va_list va;
69 va_start(va, pszFormat);
70 if (pImage->pInterfaceError && pImage->pInterfaceErrorCallbacks)
71 pImage->pInterfaceErrorCallbacks->pfnError(pImage->pInterfaceError->pvUser,
72 rc, RT_SRC_POS_ARGS,
73 pszFormat, va);
74 va_end(va);
75 return rc;
76}
77
78/**
79 * Internal: signal an informational message to the frontend.
80 */
81DECLINLINE(int) vdiMessage(PVDIIMAGEDESC pImage, const char *pszFormat, ...)
82{
83 int rc = VINF_SUCCESS;
84 va_list va;
85 va_start(va, pszFormat);
86 if (pImage->pInterfaceError && pImage->pInterfaceErrorCallbacks)
87 rc = pImage->pInterfaceErrorCallbacks->pfnMessage(pImage->pInterfaceError->pvUser,
88 pszFormat, va);
89 va_end(va);
90 return rc;
91}
92
93
94DECLINLINE(int) vdiFileOpen(PVDIIMAGEDESC pImage, const char *pszFilename,
95 uint32_t fOpen)
96{
97 return pImage->pInterfaceIOCallbacks->pfnOpen(pImage->pInterfaceIO->pvUser,
98 pszFilename, fOpen,
99 &pImage->pStorage);
100}
101
102DECLINLINE(int) vdiFileClose(PVDIIMAGEDESC pImage)
103{
104 return pImage->pInterfaceIOCallbacks->pfnClose(pImage->pInterfaceIO->pvUser,
105 pImage->pStorage);
106}
107
108DECLINLINE(int) vdiFileDelete(PVDIIMAGEDESC pImage, const char *pszFilename)
109{
110 return pImage->pInterfaceIOCallbacks->pfnDelete(pImage->pInterfaceIO->pvUser,
111 pszFilename);
112}
113
114DECLINLINE(int) vdiFileMove(PVDIIMAGEDESC pImage, const char *pszSrc,
115 const char *pszDst, unsigned fMove)
116{
117 return pImage->pInterfaceIOCallbacks->pfnMove(pImage->pInterfaceIO->pvUser,
118 pszSrc, pszDst, fMove);
119}
120
121DECLINLINE(int) vdiFileGetFreeSpace(PVDIIMAGEDESC pImage, const char *pszFilename,
122 int64_t *pcbFree)
123{
124 return pImage->pInterfaceIOCallbacks->pfnGetFreeSpace(pImage->pInterfaceIO->pvUser,
125 pszFilename, pcbFree);
126}
127
128DECLINLINE(int) vdiFileGetSize(PVDIIMAGEDESC pImage, uint64_t *pcbSize)
129{
130 return pImage->pInterfaceIOCallbacks->pfnGetSize(pImage->pInterfaceIO->pvUser,
131 pImage->pStorage, pcbSize);
132}
133
134DECLINLINE(int) vdiFileSetSize(PVDIIMAGEDESC pImage, uint64_t cbSize)
135{
136 return pImage->pInterfaceIOCallbacks->pfnSetSize(pImage->pInterfaceIO->pvUser,
137 pImage->pStorage, cbSize);
138}
139
140DECLINLINE(int) vdiFileWriteSync(PVDIIMAGEDESC pImage, uint64_t uOffset,
141 const void *pvBuffer, size_t cbBuffer,
142 size_t *pcbWritten)
143{
144 return pImage->pInterfaceIOCallbacks->pfnWriteSync(pImage->pInterfaceIO->pvUser,
145 pImage->pStorage, uOffset,
146 pvBuffer, cbBuffer, pcbWritten);
147}
148
149DECLINLINE(int) vdiFileReadSync(PVDIIMAGEDESC pImage, uint64_t uOffset,
150 void *pvBuffer, size_t cbBuffer, size_t *pcbRead)
151{
152 return pImage->pInterfaceIOCallbacks->pfnReadSync(pImage->pInterfaceIO->pvUser,
153 pImage->pStorage, uOffset,
154 pvBuffer, cbBuffer, pcbRead);
155}
156
157DECLINLINE(int) vdiFileFlushSync(PVDIIMAGEDESC pImage)
158{
159 return pImage->pInterfaceIOCallbacks->pfnFlushSync(pImage->pInterfaceIO->pvUser,
160 pImage->pStorage);
161}
162
163DECLINLINE(int) vdiFileReadUserAsync(PVDIIMAGEDESC pImage, uint64_t uOffset,
164 PVDIOCTX pIoCtx, size_t cbRead)
165{
166 return pImage->pInterfaceIOCallbacks->pfnReadUserAsync(pImage->pInterfaceIO->pvUser,
167 pImage->pStorage,
168 uOffset, pIoCtx,
169 cbRead);
170}
171
172DECLINLINE(int) vdiFileWriteUserAsync(PVDIIMAGEDESC pImage, uint64_t uOffset,
173 PVDIOCTX pIoCtx, size_t cbWrite,
174 PFNVDXFERCOMPLETED pfnComplete,
175 void *pvCompleteUser)
176{
177 return pImage->pInterfaceIOCallbacks->pfnWriteUserAsync(pImage->pInterfaceIO->pvUser,
178 pImage->pStorage,
179 uOffset, pIoCtx,
180 cbWrite,
181 pfnComplete,
182 pvCompleteUser);
183}
184
185DECLINLINE(int) vdiFileWriteMetaAsync(PVDIIMAGEDESC pImage, uint64_t uOffset,
186 void *pvBuffer, size_t cbBuffer,
187 PVDIOCTX pIoCtx,
188 PFNVDXFERCOMPLETED pfnComplete,
189 void *pvCompleteUser)
190{
191 return pImage->pInterfaceIOCallbacks->pfnWriteMetaAsync(pImage->pInterfaceIO->pvUser,
192 pImage->pStorage,
193 uOffset, pvBuffer,
194 cbBuffer, pIoCtx,
195 pfnComplete,
196 pvCompleteUser);
197}
198
199DECLINLINE(int) vdiFileFlushAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx,
200 PFNVDXFERCOMPLETED pfnComplete,
201 void *pvCompleteUser)
202{
203 return pImage->pInterfaceIOCallbacks->pfnFlushAsync(pImage->pInterfaceIO->pvUser,
204 pImage->pStorage,
205 pIoCtx, pfnComplete,
206 pvCompleteUser);
207}
208
209DECLINLINE(size_t) vdiFileIoCtxSet(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx,
210 int ch, size_t cbSet)
211{
212 return pImage->pInterfaceIOCallbacks->pfnIoCtxSet(pImage->pInterfaceIO->pvUser,
213 pIoCtx, ch, cbSet);
214}
215
216
217/**
218 * Internal: Flush the image file to disk.
219 */
220static void vdiFlushImage(PVDIIMAGEDESC pImage)
221{
222 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
223 {
224 /* Save header. */
225 int rc = vdiUpdateHeader(pImage);
226 AssertMsgRC(rc, ("vdiUpdateHeader() failed, filename=\"%s\", rc=%Rrc\n",
227 pImage->pszFilename, rc));
228 vdiFileFlushSync(pImage);
229 }
230}
231
232/**
233 * Internal: Free all allocated space for representing an image, and optionally
234 * delete the image from disk.
235 */
236static int vdiFreeImage(PVDIIMAGEDESC pImage, bool fDelete)
237{
238 int rc = VINF_SUCCESS;
239
240 /* Freeing a never allocated image (e.g. because the open failed) is
241 * not signalled as an error. After all nothing bad happens. */
242 if (pImage)
243 {
244 if (pImage->pStorage)
245 {
246 /* No point updating the file that is deleted anyway. */
247 if (!fDelete)
248 vdiFlushImage(pImage);
249
250 vdiFileClose(pImage);
251 pImage->pStorage = NULL;
252 }
253
254 if (pImage->paBlocks)
255 {
256 RTMemFree(pImage->paBlocks);
257 pImage->paBlocks = NULL;
258 }
259
260 if (fDelete && pImage->pszFilename)
261 vdiFileDelete(pImage, pImage->pszFilename);
262 }
263
264 LogFlowFunc(("returns %Rrc\n", rc));
265 return rc;
266}
267
268/**
269 * internal: return power of 2 or 0 if num error.
270 */
271static unsigned getPowerOfTwo(unsigned uNumber)
272{
273 if (uNumber == 0)
274 return 0;
275 unsigned uPower2 = 0;
276 while ((uNumber & 1) == 0)
277 {
278 uNumber >>= 1;
279 uPower2++;
280 }
281 return uNumber == 1 ? uPower2 : 0;
282}
283
284/**
285 * Internal: Init VDI preheader.
286 */
287static void vdiInitPreHeader(PVDIPREHEADER pPreHdr)
288{
289 pPreHdr->u32Signature = VDI_IMAGE_SIGNATURE;
290 pPreHdr->u32Version = VDI_IMAGE_VERSION;
291 memset(pPreHdr->szFileInfo, 0, sizeof(pPreHdr->szFileInfo));
292 strncat(pPreHdr->szFileInfo, VDI_IMAGE_FILE_INFO, sizeof(pPreHdr->szFileInfo)-1);
293}
294
295/**
296 * Internal: check VDI preheader.
297 */
298static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr)
299{
300 if (pPreHdr->u32Signature != VDI_IMAGE_SIGNATURE)
301 return VERR_VD_VDI_INVALID_HEADER;
302
303 if ( VDI_GET_VERSION_MAJOR(pPreHdr->u32Version) != VDI_IMAGE_VERSION_MAJOR
304 && pPreHdr->u32Version != 0x00000002) /* old version. */
305 return VERR_VD_VDI_UNSUPPORTED_VERSION;
306
307 return VINF_SUCCESS;
308}
309
310/**
311 * Internal: translate VD image flags to VDI image type enum.
312 */
313static VDIIMAGETYPE vdiTranslateImageFlags2VDI(unsigned uImageFlags)
314{
315 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
316 return VDI_IMAGE_TYPE_FIXED;
317 else if (uImageFlags & VD_IMAGE_FLAGS_DIFF)
318 return VDI_IMAGE_TYPE_DIFF;
319 else
320 return VDI_IMAGE_TYPE_NORMAL;
321}
322
323/**
324 * Internal: translate VDI image type enum to VD image type enum.
325 */
326static unsigned vdiTranslateVDI2ImageFlags(VDIIMAGETYPE enmType)
327{
328 switch (enmType)
329 {
330 case VDI_IMAGE_TYPE_NORMAL:
331 return VD_IMAGE_FLAGS_NONE;
332 case VDI_IMAGE_TYPE_FIXED:
333 return VD_IMAGE_FLAGS_FIXED;
334 case VDI_IMAGE_TYPE_DIFF:
335 return VD_IMAGE_FLAGS_DIFF;
336 default:
337 AssertMsgFailed(("invalid VDIIMAGETYPE enmType=%d\n", (int)enmType));
338 return VD_IMAGE_FLAGS_NONE;
339 }
340}
341
342/**
343 * Internal: Init VDI header. Always use latest header version.
344 * @param pHeader Assumes it was initially initialized to all zeros.
345 */
346static void vdiInitHeader(PVDIHEADER pHeader, uint32_t uImageFlags,
347 const char *pszComment, uint64_t cbDisk,
348 uint32_t cbBlock, uint32_t cbBlockExtra)
349{
350 pHeader->uVersion = VDI_IMAGE_VERSION;
351 pHeader->u.v1plus.cbHeader = sizeof(VDIHEADER1PLUS);
352 pHeader->u.v1plus.u32Type = (uint32_t)vdiTranslateImageFlags2VDI(uImageFlags);
353 pHeader->u.v1plus.fFlags = (uImageFlags & VD_VDI_IMAGE_FLAGS_ZERO_EXPAND) ? 1 : 0;
354#ifdef VBOX_STRICT
355 char achZero[VDI_IMAGE_COMMENT_SIZE] = {0};
356 Assert(!memcmp(pHeader->u.v1plus.szComment, achZero, VDI_IMAGE_COMMENT_SIZE));
357#endif
358 pHeader->u.v1plus.szComment[0] = '\0';
359 if (pszComment)
360 {
361 AssertMsg(strlen(pszComment) < sizeof(pHeader->u.v1plus.szComment),
362 ("HDD Comment is too long, cb=%d\n", strlen(pszComment)));
363 strncat(pHeader->u.v1plus.szComment, pszComment, sizeof(pHeader->u.v1plus.szComment)-1);
364 }
365
366 /* Mark the legacy geometry not-calculated. */
367 pHeader->u.v1plus.LegacyGeometry.cCylinders = 0;
368 pHeader->u.v1plus.LegacyGeometry.cHeads = 0;
369 pHeader->u.v1plus.LegacyGeometry.cSectors = 0;
370 pHeader->u.v1plus.LegacyGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
371 pHeader->u.v1plus.u32Dummy = 0; /* used to be the translation value */
372
373 pHeader->u.v1plus.cbDisk = cbDisk;
374 pHeader->u.v1plus.cbBlock = cbBlock;
375 pHeader->u.v1plus.cBlocks = (uint32_t)(cbDisk / cbBlock);
376 if (cbDisk % cbBlock)
377 pHeader->u.v1plus.cBlocks++;
378 pHeader->u.v1plus.cbBlockExtra = cbBlockExtra;
379 pHeader->u.v1plus.cBlocksAllocated = 0;
380
381 /* Init offsets. */
382 pHeader->u.v1plus.offBlocks = RT_ALIGN_32(sizeof(VDIPREHEADER) + sizeof(VDIHEADER1PLUS), VDI_DATA_ALIGN);
383 pHeader->u.v1plus.offData = RT_ALIGN_32(pHeader->u.v1plus.offBlocks + (pHeader->u.v1plus.cBlocks * sizeof(VDIIMAGEBLOCKPOINTER)), VDI_DATA_ALIGN);
384
385 /* Init uuids. */
386 RTUuidCreate(&pHeader->u.v1plus.uuidCreate);
387 RTUuidClear(&pHeader->u.v1plus.uuidModify);
388 RTUuidClear(&pHeader->u.v1plus.uuidLinkage);
389 RTUuidClear(&pHeader->u.v1plus.uuidParentModify);
390
391 /* Mark LCHS geometry not-calculated. */
392 pHeader->u.v1plus.LCHSGeometry.cCylinders = 0;
393 pHeader->u.v1plus.LCHSGeometry.cHeads = 0;
394 pHeader->u.v1plus.LCHSGeometry.cSectors = 0;
395 pHeader->u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
396}
397
398/**
399 * Internal: Check VDI header.
400 */
401static int vdiValidateHeader(PVDIHEADER pHeader)
402{
403 /* Check version-dependend header parameters. */
404 switch (GET_MAJOR_HEADER_VERSION(pHeader))
405 {
406 case 0:
407 {
408 /* Old header version. */
409 break;
410 }
411 case 1:
412 {
413 /* Current header version. */
414
415 if (pHeader->u.v1.cbHeader < sizeof(VDIHEADER1))
416 {
417 LogRel(("VDI: v1 header size wrong (%d < %d)\n",
418 pHeader->u.v1.cbHeader, sizeof(VDIHEADER1)));
419 return VERR_VD_VDI_INVALID_HEADER;
420 }
421
422 if (getImageBlocksOffset(pHeader) < (sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)))
423 {
424 LogRel(("VDI: v1 blocks offset wrong (%d < %d)\n",
425 getImageBlocksOffset(pHeader), sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)));
426 return VERR_VD_VDI_INVALID_HEADER;
427 }
428
429 if (getImageDataOffset(pHeader) < (getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)))
430 {
431 LogRel(("VDI: v1 image data offset wrong (%d < %d)\n",
432 getImageDataOffset(pHeader), getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)));
433 return VERR_VD_VDI_INVALID_HEADER;
434 }
435
436 break;
437 }
438 default:
439 /* Unsupported. */
440 return VERR_VD_VDI_UNSUPPORTED_VERSION;
441 }
442
443 /* Check common header parameters. */
444
445 bool fFailed = false;
446
447 if ( getImageType(pHeader) < VDI_IMAGE_TYPE_FIRST
448 || getImageType(pHeader) > VDI_IMAGE_TYPE_LAST)
449 {
450 LogRel(("VDI: bad image type %d\n", getImageType(pHeader)));
451 fFailed = true;
452 }
453
454 if (getImageFlags(pHeader) & ~VD_VDI_IMAGE_FLAGS_MASK)
455 {
456 LogRel(("VDI: bad image flags %08x\n", getImageFlags(pHeader)));
457 fFailed = true;
458 }
459
460 if ( getImageLCHSGeometry(pHeader)
461 && (getImageLCHSGeometry(pHeader))->cbSector != VDI_GEOMETRY_SECTOR_SIZE)
462 {
463 LogRel(("VDI: wrong sector size (%d != %d)\n",
464 (getImageLCHSGeometry(pHeader))->cbSector, VDI_GEOMETRY_SECTOR_SIZE));
465 fFailed = true;
466 }
467
468 if ( getImageDiskSize(pHeader) == 0
469 || getImageBlockSize(pHeader) == 0
470 || getImageBlocks(pHeader) == 0
471 || getPowerOfTwo(getImageBlockSize(pHeader)) == 0)
472 {
473 LogRel(("VDI: wrong size (%lld, %d, %d, %d)\n",
474 getImageDiskSize(pHeader), getImageBlockSize(pHeader),
475 getImageBlocks(pHeader), getPowerOfTwo(getImageBlockSize(pHeader))));
476 fFailed = true;
477 }
478
479 if (getImageBlocksAllocated(pHeader) > getImageBlocks(pHeader))
480 {
481 LogRel(("VDI: too many blocks allocated (%d > %d)\n"
482 " blocksize=%d disksize=%lld\n",
483 getImageBlocksAllocated(pHeader), getImageBlocks(pHeader),
484 getImageBlockSize(pHeader), getImageDiskSize(pHeader)));
485 fFailed = true;
486 }
487
488 if ( getImageExtraBlockSize(pHeader) != 0
489 && getPowerOfTwo(getImageExtraBlockSize(pHeader)) == 0)
490 {
491 LogRel(("VDI: wrong extra size (%d, %d)\n",
492 getImageExtraBlockSize(pHeader), getPowerOfTwo(getImageExtraBlockSize(pHeader))));
493 fFailed = true;
494 }
495
496 if ((uint64_t)getImageBlockSize(pHeader) * getImageBlocks(pHeader) < getImageDiskSize(pHeader))
497 {
498 LogRel(("VDI: wrong disk size (%d, %d, %lld)\n",
499 getImageBlockSize(pHeader), getImageBlocks(pHeader), getImageDiskSize(pHeader)));
500 fFailed = true;
501 }
502
503 if (RTUuidIsNull(getImageCreationUUID(pHeader)))
504 {
505 LogRel(("VDI: uuid of creator is 0\n"));
506 fFailed = true;
507 }
508
509 if (RTUuidIsNull(getImageModificationUUID(pHeader)))
510 {
511 LogRel(("VDI: uuid of modificator is 0\n"));
512 fFailed = true;
513 }
514
515 return fFailed ? VERR_VD_VDI_INVALID_HEADER : VINF_SUCCESS;
516}
517
518/**
519 * Internal: Set up VDIIMAGEDESC structure by image header.
520 */
521static void vdiSetupImageDesc(PVDIIMAGEDESC pImage)
522{
523 pImage->uImageFlags = getImageFlags(&pImage->Header);
524 pImage->uImageFlags |= vdiTranslateVDI2ImageFlags(getImageType(&pImage->Header));
525 pImage->offStartBlocks = getImageBlocksOffset(&pImage->Header);
526 pImage->offStartData = getImageDataOffset(&pImage->Header);
527 pImage->uBlockMask = getImageBlockSize(&pImage->Header) - 1;
528 pImage->uShiftOffset2Index = getPowerOfTwo(getImageBlockSize(&pImage->Header));
529 pImage->offStartBlockData = getImageExtraBlockSize(&pImage->Header);
530 pImage->cbTotalBlockData = pImage->offStartBlockData
531 + getImageBlockSize(&pImage->Header);
532}
533
534/**
535 * Internal: Create VDI image file.
536 */
537static int vdiCreateImage(PVDIIMAGEDESC pImage, uint64_t cbSize,
538 unsigned uImageFlags, const char *pszComment,
539 PCVDGEOMETRY pPCHSGeometry,
540 PCVDGEOMETRY pLCHSGeometry, PCRTUUID pUuid,
541 unsigned uOpenFlags, PFNVDPROGRESS pfnProgress,
542 void *pvUser, unsigned uPercentStart,
543 unsigned uPercentSpan)
544{
545 int rc;
546 uint64_t cbTotal;
547 uint64_t cbFill;
548 uint64_t uOff;
549
550 /* Special check for comment length. */
551 if ( VALID_PTR(pszComment)
552 && strlen(pszComment) >= VDI_IMAGE_COMMENT_SIZE)
553 {
554 rc = vdiError(pImage, VERR_VD_VDI_COMMENT_TOO_LONG, RT_SRC_POS, N_("VDI: comment is too long for '%s'"), pImage->pszFilename);
555 goto out;
556 }
557 AssertPtr(pPCHSGeometry);
558 AssertPtr(pLCHSGeometry);
559
560 pImage->pInterfaceError = VDInterfaceGet(pImage->pVDIfsDisk, VDINTERFACETYPE_ERROR);
561 if (pImage->pInterfaceError)
562 pImage->pInterfaceErrorCallbacks = VDGetInterfaceError(pImage->pInterfaceError);
563
564 /* Get I/O interface. */
565 pImage->pInterfaceIO = VDInterfaceGet(pImage->pVDIfsImage, VDINTERFACETYPE_IOINT);
566 AssertPtrReturn(pImage->pInterfaceIO, VERR_INVALID_PARAMETER);
567 pImage->pInterfaceIOCallbacks = VDGetInterfaceIOInt(pImage->pInterfaceIO);
568 AssertPtrReturn(pImage->pInterfaceIOCallbacks, VERR_INVALID_PARAMETER);
569
570 vdiInitPreHeader(&pImage->PreHeader);
571 vdiInitHeader(&pImage->Header, uImageFlags, pszComment, cbSize, VDI_IMAGE_DEFAULT_BLOCK_SIZE, 0);
572 /* Save PCHS geometry. Not much work, and makes the flow of information
573 * quite a bit clearer - relying on the higher level isn't obvious. */
574 pImage->PCHSGeometry = *pPCHSGeometry;
575 /* Set LCHS geometry (legacy geometry is ignored for the current 1.1+). */
576 pImage->Header.u.v1plus.LCHSGeometry.cCylinders = pLCHSGeometry->cCylinders;
577 pImage->Header.u.v1plus.LCHSGeometry.cHeads = pLCHSGeometry->cHeads;
578 pImage->Header.u.v1plus.LCHSGeometry.cSectors = pLCHSGeometry->cSectors;
579 pImage->Header.u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
580
581 pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
582 if (!pImage->paBlocks)
583 {
584 rc = VERR_NO_MEMORY;
585 goto out;
586 }
587
588 if (!(uImageFlags & VD_IMAGE_FLAGS_FIXED))
589 {
590 /* for growing images mark all blocks in paBlocks as free. */
591 for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
592 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
593 }
594 else
595 {
596 /* for fixed images mark all blocks in paBlocks as allocated */
597 for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
598 pImage->paBlocks[i] = i;
599 pImage->Header.u.v1.cBlocksAllocated = pImage->Header.u.v1.cBlocks;
600 }
601
602 /* Setup image parameters. */
603 vdiSetupImageDesc(pImage);
604
605 /* Create image file. */
606 rc = vdiFileOpen(pImage, pImage->pszFilename,
607 VDOpenFlagsToFileOpenFlags(uOpenFlags & ~VD_OPEN_FLAGS_READONLY,
608 true /* fCreate */));
609 if (RT_FAILURE(rc))
610 {
611 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: cannot create image '%s'"), pImage->pszFilename);
612 goto out;
613 }
614
615 cbTotal = pImage->offStartData
616 + (uint64_t)getImageBlocks(&pImage->Header) * pImage->cbTotalBlockData;
617
618 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
619 {
620 /* Check the free space on the disk and leave early if there is not
621 * sufficient space available. */
622 int64_t cbFree = 0;
623 rc = vdiFileGetFreeSpace(pImage, pImage->pszFilename, &cbFree);
624 if (RT_SUCCESS(rc) /* ignore errors */ && ((uint64_t)cbFree < cbTotal))
625 {
626 rc = vdiError(pImage, VERR_DISK_FULL, RT_SRC_POS, N_("VDI: disk would overflow creating image '%s'"), pImage->pszFilename);
627 goto out;
628 }
629 }
630
631 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
632 {
633 /*
634 * Allocate & commit whole file if fixed image, it must be more
635 * effective than expanding file by write operations.
636 */
637 rc = vdiFileSetSize(pImage, cbTotal);
638 }
639 else
640 {
641 /* Set file size to hold header and blocks array. */
642 rc = vdiFileSetSize(pImage, pImage->offStartData);
643 }
644 if (RT_FAILURE(rc))
645 {
646 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: setting image size failed for '%s'"), pImage->pszFilename);
647 goto out;
648 }
649
650 /* Use specified image uuid */
651 *getImageCreationUUID(&pImage->Header) = *pUuid;
652
653 /* Generate image last-modify uuid */
654 RTUuidCreate(getImageModificationUUID(&pImage->Header));
655
656 /* Write pre-header. */
657 rc = vdiFileWriteSync(pImage, 0, &pImage->PreHeader, sizeof(pImage->PreHeader), NULL);
658 if (RT_FAILURE(rc))
659 {
660 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing pre-header failed for '%s'"), pImage->pszFilename);
661 goto out;
662 }
663
664 /* Write header. */
665 rc = vdiFileWriteSync(pImage, sizeof(pImage->PreHeader),
666 &pImage->Header.u.v1plus,
667 sizeof(pImage->Header.u.v1plus), NULL);
668 if (RT_FAILURE(rc))
669 {
670 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing header failed for '%s'"), pImage->pszFilename);
671 goto out;
672 }
673
674 rc = vdiFileWriteSync(pImage, pImage->offStartBlocks, pImage->paBlocks,
675 getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER),
676 NULL);
677 if (RT_FAILURE(rc))
678 {
679 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing block pointers failed for '%s'"), pImage->pszFilename);
680 goto out;
681 }
682
683 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
684 {
685 /* Fill image with zeroes. We do this for every fixed-size image since on some systems
686 * (for example Windows Vista), it takes ages to write a block near the end of a sparse
687 * file and the guest could complain about an ATA timeout. */
688
689 /** @todo Starting with Linux 2.6.23, there is an fallocate() system call.
690 * Currently supported file systems are ext4 and ocfs2. */
691
692 /* Allocate a temporary zero-filled buffer. Use a bigger block size to optimize writing */
693 const size_t cbBuf = 128 * _1K;
694 void *pvBuf = RTMemTmpAllocZ(cbBuf);
695 if (!pvBuf)
696 {
697 rc = VERR_NO_MEMORY;
698 goto out;
699 }
700
701 cbFill = (uint64_t)getImageBlocks(&pImage->Header) * pImage->cbTotalBlockData;
702 uOff = 0;
703 /* Write data to all image blocks. */
704 while (uOff < cbFill)
705 {
706 unsigned cbChunk = (unsigned)RT_MIN(cbFill, cbBuf);
707
708 rc = vdiFileWriteSync(pImage, pImage->offStartData + uOff,
709 pvBuf, cbChunk, NULL);
710 if (RT_FAILURE(rc))
711 {
712 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing block failed for '%s'"), pImage->pszFilename);
713 goto out;
714 }
715
716 uOff += cbChunk;
717
718 if (pfnProgress)
719 {
720 rc = pfnProgress(pvUser,
721 uPercentStart + uOff * uPercentSpan / cbFill);
722 if (RT_FAILURE(rc))
723 goto out;
724 }
725 }
726 RTMemTmpFree(pvBuf);
727 }
728
729out:
730 if (RT_SUCCESS(rc) && pfnProgress)
731 pfnProgress(pvUser, uPercentStart + uPercentSpan);
732
733 if (RT_FAILURE(rc))
734 vdiFreeImage(pImage, rc != VERR_ALREADY_EXISTS);
735 return rc;
736}
737
738/**
739 * Internal: Open a VDI image.
740 */
741static int vdiOpenImage(PVDIIMAGEDESC pImage, unsigned uOpenFlags)
742{
743 int rc;
744
745 pImage->uOpenFlags = uOpenFlags;
746
747 pImage->pInterfaceError = VDInterfaceGet(pImage->pVDIfsDisk, VDINTERFACETYPE_ERROR);
748 if (pImage->pInterfaceError)
749 pImage->pInterfaceErrorCallbacks = VDGetInterfaceError(pImage->pInterfaceError);
750
751 /* Get I/O interface. */
752 pImage->pInterfaceIO = VDInterfaceGet(pImage->pVDIfsImage, VDINTERFACETYPE_IOINT);
753 AssertPtrReturn(pImage->pInterfaceIO, VERR_INVALID_PARAMETER);
754 pImage->pInterfaceIOCallbacks = VDGetInterfaceIOInt(pImage->pInterfaceIO);
755 AssertPtrReturn(pImage->pInterfaceIOCallbacks, VERR_INVALID_PARAMETER);
756
757 /*
758 * Open the image.
759 */
760 rc = vdiFileOpen(pImage, pImage->pszFilename,
761 VDOpenFlagsToFileOpenFlags(uOpenFlags, false /* fCreate */));
762 if (RT_FAILURE(rc))
763 {
764 /* Do NOT signal an appropriate error here, as the VD layer has the
765 * choice of retrying the open if it failed. */
766 goto out;
767 }
768
769 /* Read pre-header. */
770 rc = vdiFileReadSync(pImage, 0, &pImage->PreHeader, sizeof(pImage->PreHeader), NULL);
771 if (RT_FAILURE(rc))
772 {
773 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading pre-header in '%s'"), pImage->pszFilename);
774 goto out;
775 }
776 rc = vdiValidatePreHeader(&pImage->PreHeader);
777 if (RT_FAILURE(rc))
778 {
779 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: invalid pre-header in '%s'"), pImage->pszFilename);
780 goto out;
781 }
782
783 /* Read header. */
784 pImage->Header.uVersion = pImage->PreHeader.u32Version;
785 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
786 {
787 case 0:
788 rc = vdiFileReadSync(pImage, sizeof(pImage->PreHeader),
789 &pImage->Header.u.v0, sizeof(pImage->Header.u.v0),
790 NULL);
791 if (RT_FAILURE(rc))
792 {
793 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v0 header in '%s'"), pImage->pszFilename);
794 goto out;
795 }
796 break;
797 case 1:
798 rc = vdiFileReadSync(pImage, sizeof(pImage->PreHeader),
799 &pImage->Header.u.v1, sizeof(pImage->Header.u.v1),
800 NULL);
801 if (RT_FAILURE(rc))
802 {
803 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v1 header in '%s'"), pImage->pszFilename);
804 goto out;
805 }
806 /* Convert VDI 1.1 images to VDI 1.1+ on open in read/write mode.
807 * Conversion is harmless, as any VirtualBox version supporting VDI
808 * 1.1 doesn't touch fields it doesn't know about. */
809 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
810 && GET_MINOR_HEADER_VERSION(&pImage->Header) == 1
811 && pImage->Header.u.v1.cbHeader < sizeof(pImage->Header.u.v1plus))
812 {
813 pImage->Header.u.v1plus.cbHeader = sizeof(pImage->Header.u.v1plus);
814 /* Mark LCHS geometry not-calculated. */
815 pImage->Header.u.v1plus.LCHSGeometry.cCylinders = 0;
816 pImage->Header.u.v1plus.LCHSGeometry.cHeads = 0;
817 pImage->Header.u.v1plus.LCHSGeometry.cSectors = 0;
818 pImage->Header.u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
819 }
820 else if (pImage->Header.u.v1.cbHeader >= sizeof(pImage->Header.u.v1plus))
821 {
822 /* Read the actual VDI 1.1+ header completely. */
823 rc = vdiFileReadSync(pImage, sizeof(pImage->PreHeader),
824 &pImage->Header.u.v1plus,
825 sizeof(pImage->Header.u.v1plus), NULL);
826 if (RT_FAILURE(rc))
827 {
828 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v1.1+ header in '%s'"), pImage->pszFilename);
829 goto out;
830 }
831 }
832 break;
833 default:
834 rc = vdiError(pImage, VERR_VD_VDI_UNSUPPORTED_VERSION, RT_SRC_POS, N_("VDI: unsupported major version %u in '%s'"), GET_MAJOR_HEADER_VERSION(&pImage->Header), pImage->pszFilename);
835 goto out;
836 }
837
838 rc = vdiValidateHeader(&pImage->Header);
839 if (RT_FAILURE(rc))
840 {
841 rc = vdiError(pImage, VERR_VD_VDI_INVALID_HEADER, RT_SRC_POS, N_("VDI: invalid header in '%s'"), pImage->pszFilename);
842 goto out;
843 }
844
845 /* Setup image parameters by header. */
846 vdiSetupImageDesc(pImage);
847
848 /* Allocate memory for blocks array. */
849 pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
850 if (!pImage->paBlocks)
851 {
852 rc = VERR_NO_MEMORY;
853 goto out;
854 }
855
856 /* Read blocks array. */
857 rc = vdiFileReadSync(pImage, pImage->offStartBlocks, pImage->paBlocks,
858 getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER),
859 NULL);
860
861out:
862 if (RT_FAILURE(rc))
863 vdiFreeImage(pImage, false);
864 return rc;
865}
866
867/**
868 * Internal: Save header to file.
869 */
870static int vdiUpdateHeader(PVDIIMAGEDESC pImage)
871{
872 int rc;
873 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
874 {
875 case 0:
876 rc = vdiFileWriteSync(pImage, sizeof(VDIPREHEADER),
877 &pImage->Header.u.v0, sizeof(pImage->Header.u.v0),
878 NULL);
879 break;
880 case 1:
881 if (pImage->Header.u.v1plus.cbHeader < sizeof(pImage->Header.u.v1plus))
882 rc = vdiFileWriteSync(pImage, sizeof(VDIPREHEADER),
883 &pImage->Header.u.v1, sizeof(pImage->Header.u.v1),
884 NULL);
885 else
886 rc = vdiFileWriteSync(pImage, sizeof(VDIPREHEADER),
887 &pImage->Header.u.v1plus, sizeof(pImage->Header.u.v1plus),
888 NULL);
889 break;
890 default:
891 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
892 break;
893 }
894 AssertMsgRC(rc, ("vdiUpdateHeader failed, filename=\"%s\" rc=%Rrc\n", pImage->pszFilename, rc));
895 return rc;
896}
897
898/**
899 * Internal: Save header to file - async version.
900 */
901static int vdiUpdateHeaderAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx)
902{
903 int rc;
904 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
905 {
906 case 0:
907 rc = vdiFileWriteMetaAsync(pImage, sizeof(VDIPREHEADER),
908 &pImage->Header.u.v0,
909 sizeof(pImage->Header.u.v0),
910 pIoCtx, NULL, NULL);
911 break;
912 case 1:
913 if (pImage->Header.u.v1plus.cbHeader < sizeof(pImage->Header.u.v1plus))
914 rc = vdiFileWriteMetaAsync(pImage, sizeof(VDIPREHEADER),
915 &pImage->Header.u.v1,
916 sizeof(pImage->Header.u.v1),
917 pIoCtx, NULL, NULL);
918 else
919 rc = vdiFileWriteMetaAsync(pImage, sizeof(VDIPREHEADER),
920 &pImage->Header.u.v1plus,
921 sizeof(pImage->Header.u.v1plus),
922 pIoCtx, NULL, NULL);
923 break;
924 default:
925 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
926 break;
927 }
928 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
929 ("vdiUpdateHeader failed, filename=\"%s\" rc=%Rrc\n", pImage->pszFilename, rc));
930 return rc;
931}
932
933/**
934 * Internal: Save block pointer to file, save header to file.
935 */
936static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock)
937{
938 /* Update image header. */
939 int rc = vdiUpdateHeader(pImage);
940 if (RT_SUCCESS(rc))
941 {
942 /* write only one block pointer. */
943 rc = vdiFileWriteSync(pImage, pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
944 &pImage->paBlocks[uBlock], sizeof(VDIIMAGEBLOCKPOINTER),
945 NULL);
946 AssertMsgRC(rc, ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Rrc\n",
947 uBlock, pImage->pszFilename, rc));
948 }
949 return rc;
950}
951
952/**
953 * Internal: Save block pointer to file, save header to file - async version.
954 */
955static int vdiUpdateBlockInfoAsync(PVDIIMAGEDESC pImage, unsigned uBlock,
956 PVDIOCTX pIoCtx)
957{
958 /* Update image header. */
959 int rc = vdiUpdateHeaderAsync(pImage, pIoCtx);
960 if (RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
961 {
962 /* write only one block pointer. */
963 rc = vdiFileWriteMetaAsync(pImage,
964 pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
965 &pImage->paBlocks[uBlock],
966 sizeof(VDIIMAGEBLOCKPOINTER),
967 pIoCtx, NULL, NULL);
968 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
969 ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Rrc\n",
970 uBlock, pImage->pszFilename, rc));
971 }
972 return rc;
973}
974
975/**
976 * Internal: Flush the image file to disk - async version.
977 */
978static int vdiFlushImageAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx)
979{
980 int rc = VINF_SUCCESS;
981
982 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
983 {
984 /* Save header. */
985 rc = vdiUpdateHeaderAsync(pImage, pIoCtx);
986 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
987 ("vdiUpdateHeaderAsync() failed, filename=\"%s\", rc=%Rrc\n",
988 pImage->pszFilename, rc));
989 rc = vdiFileFlushAsync(pImage, pIoCtx, NULL, NULL);
990 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
991 ("Flushing data to disk failed rc=%Rrc\n", rc));
992 }
993
994 return rc;
995}
996
997
998/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
999static int vdiCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
1000 PVDINTERFACE pVDIfsImage)
1001{
1002 LogFlowFunc(("pszFilename=\"%s\"\n", pszFilename));
1003 int rc = VINF_SUCCESS;
1004 PVDIIMAGEDESC pImage;
1005
1006 if ( !VALID_PTR(pszFilename)
1007 || !*pszFilename)
1008 {
1009 rc = VERR_INVALID_PARAMETER;
1010 goto out;
1011 }
1012
1013 pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
1014 if (!pImage)
1015 {
1016 rc = VERR_NO_MEMORY;
1017 goto out;
1018 }
1019 pImage->pszFilename = pszFilename;
1020 pImage->pStorage = NULL;
1021 pImage->paBlocks = NULL;
1022 pImage->pVDIfsDisk = pVDIfsDisk;
1023 pImage->pVDIfsImage = pVDIfsImage;
1024
1025 rc = vdiOpenImage(pImage, VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_READONLY);
1026 vdiFreeImage(pImage, false);
1027 RTMemFree(pImage);
1028
1029out:
1030 LogFlowFunc(("returns %Rrc\n", rc));
1031 return rc;
1032}
1033
1034/** @copydoc VBOXHDDBACKEND::pfnOpen */
1035static int vdiOpen(const char *pszFilename, unsigned uOpenFlags,
1036 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1037 void **ppBackendData)
1038{
1039 LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, ppBackendData));
1040 int rc;
1041 PVDIIMAGEDESC pImage;
1042
1043 /* Check open flags. All valid flags are supported. */
1044 if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
1045 {
1046 rc = VERR_INVALID_PARAMETER;
1047 goto out;
1048 }
1049
1050 /* Check remaining arguments. */
1051 if ( !VALID_PTR(pszFilename)
1052 || !*pszFilename)
1053 {
1054 rc = VERR_INVALID_PARAMETER;
1055 goto out;
1056 }
1057
1058 pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
1059 if (!pImage)
1060 {
1061 rc = VERR_NO_MEMORY;
1062 goto out;
1063 }
1064 pImage->pszFilename = pszFilename;
1065 pImage->pStorage = NULL;
1066 pImage->paBlocks = NULL;
1067 pImage->pVDIfsDisk = pVDIfsDisk;
1068 pImage->pVDIfsImage = pVDIfsImage;
1069
1070 rc = vdiOpenImage(pImage, uOpenFlags);
1071 if (RT_SUCCESS(rc))
1072 *ppBackendData = pImage;
1073
1074out:
1075 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1076 return rc;
1077}
1078
1079/** @copydoc VBOXHDDBACKEND::pfnCreate */
1080static int vdiCreate(const char *pszFilename, uint64_t cbSize,
1081 unsigned uImageFlags, const char *pszComment,
1082 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
1083 PCRTUUID pUuid, unsigned uOpenFlags,
1084 unsigned uPercentStart, unsigned uPercentSpan,
1085 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1086 PVDINTERFACE pVDIfsOperation, void **ppBackendData)
1087{
1088 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 ppBackendData=%#p", pszFilename, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, ppBackendData));
1089 int rc;
1090 PVDIIMAGEDESC pImage;
1091
1092 PFNVDPROGRESS pfnProgress = NULL;
1093 void *pvUser = NULL;
1094 PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
1095 VDINTERFACETYPE_PROGRESS);
1096 PVDINTERFACEPROGRESS pCbProgress = NULL;
1097 if (pIfProgress)
1098 {
1099 pCbProgress = VDGetInterfaceProgress(pIfProgress);
1100 if (pCbProgress)
1101 pfnProgress = pCbProgress->pfnProgress;
1102 pvUser = pIfProgress->pvUser;
1103 }
1104
1105 /* Check open flags. All valid flags are supported. */
1106 if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
1107 {
1108 rc = VERR_INVALID_PARAMETER;
1109 goto out;
1110 }
1111
1112 /* Check size. Maximum 4PB-3M. No tricks with adjusting the 1M block size
1113 * so far, which would extend the size. */
1114 cbSize = RT_ALIGN_64(cbSize, _1M);
1115 if ( !cbSize
1116 || cbSize >= _1P * 2 - _1M * 3)
1117 {
1118 rc = VERR_VD_INVALID_SIZE;
1119 goto out;
1120 }
1121
1122 /* Check remaining arguments. */
1123 if ( !VALID_PTR(pszFilename)
1124 || !*pszFilename
1125 || cbSize < VDI_IMAGE_DEFAULT_BLOCK_SIZE
1126 || !VALID_PTR(pPCHSGeometry)
1127 || !VALID_PTR(pLCHSGeometry))
1128 {
1129 rc = VERR_INVALID_PARAMETER;
1130 goto out;
1131 }
1132
1133 pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
1134 if (!pImage)
1135 {
1136 rc = VERR_NO_MEMORY;
1137 goto out;
1138 }
1139 pImage->pszFilename = pszFilename;
1140 pImage->pStorage = NULL;
1141 pImage->paBlocks = NULL;
1142 pImage->pVDIfsDisk = pVDIfsDisk;
1143 pImage->pVDIfsImage = pVDIfsImage;
1144
1145 rc = vdiCreateImage(pImage, cbSize, uImageFlags, pszComment,
1146 pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags,
1147 pfnProgress, pvUser, uPercentStart, uPercentSpan);
1148 if (RT_SUCCESS(rc))
1149 {
1150 /* So far the image is opened in read/write mode. Make sure the
1151 * image is opened in read-only mode if the caller requested that. */
1152 if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
1153 {
1154 vdiFreeImage(pImage, false);
1155 rc = vdiOpenImage(pImage, uOpenFlags);
1156 if (RT_FAILURE(rc))
1157 {
1158 RTMemFree(pImage);
1159 goto out;
1160 }
1161 }
1162 *ppBackendData = pImage;
1163 }
1164 else
1165 RTMemFree(pImage);
1166
1167out:
1168 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1169 return rc;
1170}
1171
1172/** @copydoc VBOXHDDBACKEND::pfnRename */
1173static int vdiRename(void *pBackendData, const char *pszFilename)
1174{
1175 LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
1176
1177 int rc = VINF_SUCCESS;
1178 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1179
1180 /* Check arguments. */
1181 if ( !pImage
1182 || !pszFilename
1183 || !*pszFilename)
1184 {
1185 rc = VERR_INVALID_PARAMETER;
1186 goto out;
1187 }
1188
1189 /* Close the image. */
1190 vdiFreeImage(pImage, false);
1191
1192 /* Rename the file. */
1193 rc = vdiFileMove(pImage, pImage->pszFilename, pszFilename, 0);
1194 if (RT_FAILURE(rc))
1195 {
1196 /* The move failed, try to reopen the original image. */
1197 int rc2 = vdiOpenImage(pImage, pImage->uOpenFlags);
1198 if (RT_FAILURE(rc2))
1199 rc = rc2;
1200
1201 goto out;
1202 }
1203
1204 /* Update pImage with the new information. */
1205 pImage->pszFilename = pszFilename;
1206
1207 /* Open the new image. */
1208 rc = vdiOpenImage(pImage, pImage->uOpenFlags);
1209 if (RT_FAILURE(rc))
1210 goto out;
1211
1212out:
1213 LogFlowFunc(("returns %Rrc\n", rc));
1214 return rc;
1215}
1216
1217/** @copydoc VBOXHDDBACKEND::pfnClose */
1218static int vdiClose(void *pBackendData, bool fDelete)
1219{
1220 LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
1221 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1222 int rc;
1223
1224 rc = vdiFreeImage(pImage, fDelete);
1225 RTMemFree(pImage);
1226
1227 LogFlowFunc(("returns %Rrc\n", rc));
1228 return rc;
1229}
1230
1231/** @copydoc VBOXHDDBACKEND::pfnRead */
1232static int vdiRead(void *pBackendData, uint64_t uOffset, void *pvBuf,
1233 size_t cbToRead, size_t *pcbActuallyRead)
1234{
1235 LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToRead=%zu pcbActuallyRead=%#p\n", pBackendData, uOffset, pvBuf, cbToRead, pcbActuallyRead));
1236 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1237 unsigned uBlock;
1238 unsigned offRead;
1239 int rc;
1240
1241 AssertPtr(pImage);
1242 Assert(!(uOffset % 512));
1243 Assert(!(cbToRead % 512));
1244
1245 if ( uOffset + cbToRead > getImageDiskSize(&pImage->Header)
1246 || !VALID_PTR(pvBuf)
1247 || !cbToRead)
1248 {
1249 rc = VERR_INVALID_PARAMETER;
1250 goto out;
1251 }
1252
1253 /* Calculate starting block number and offset inside it. */
1254 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1255 offRead = (unsigned)uOffset & pImage->uBlockMask;
1256
1257 /* Clip read range to at most the rest of the block. */
1258 cbToRead = RT_MIN(cbToRead, getImageBlockSize(&pImage->Header) - offRead);
1259 Assert(!(cbToRead % 512));
1260
1261 if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
1262 rc = VERR_VD_BLOCK_FREE;
1263 else if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
1264 {
1265 memset(pvBuf, 0, cbToRead);
1266 rc = VINF_SUCCESS;
1267 }
1268 else
1269 {
1270 /* Block present in image file, read relevant data. */
1271 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1272 + (pImage->offStartData + pImage->offStartBlockData + offRead);
1273 rc = vdiFileReadSync(pImage, u64Offset, pvBuf, cbToRead, NULL);
1274 }
1275
1276 if (pcbActuallyRead)
1277 *pcbActuallyRead = cbToRead;
1278
1279out:
1280 LogFlowFunc(("returns %Rrc\n", rc));
1281 return rc;
1282}
1283
1284/**@copydoc VBOXHDDBACKEND::pfnWrite */
1285static int vdiWrite(void *pBackendData, uint64_t uOffset, const void *pvBuf,
1286 size_t cbToWrite, size_t *pcbWriteProcess,
1287 size_t *pcbPreRead, size_t *pcbPostRead, unsigned fWrite)
1288{
1289 LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n", pBackendData, uOffset, pvBuf, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
1290 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1291 unsigned uBlock;
1292 unsigned offWrite;
1293 int rc = VINF_SUCCESS;
1294
1295 AssertPtr(pImage);
1296 Assert(!(uOffset % 512));
1297 Assert(!(cbToWrite % 512));
1298
1299 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1300 {
1301 rc = VERR_VD_IMAGE_READ_ONLY;
1302 goto out;
1303 }
1304
1305 if (!VALID_PTR(pvBuf) || !cbToWrite)
1306 {
1307 rc = VERR_INVALID_PARAMETER;
1308 goto out;
1309 }
1310
1311 /* No size check here, will do that later. For dynamic images which are
1312 * not multiples of the block size in length, this would prevent writing to
1313 * the last block. */
1314
1315 /* Calculate starting block number and offset inside it. */
1316 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1317 offWrite = (unsigned)uOffset & pImage->uBlockMask;
1318
1319 /* Clip write range to at most the rest of the block. */
1320 cbToWrite = RT_MIN(cbToWrite, getImageBlockSize(&pImage->Header) - offWrite);
1321 Assert(!(cbToWrite % 512));
1322
1323 do
1324 {
1325 if (!IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
1326 {
1327 /* Block is either free or zero. */
1328 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_ZEROES)
1329 && ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
1330 || cbToWrite == getImageBlockSize(&pImage->Header)))
1331 {
1332 /* If the destination block is unallocated at this point, it's
1333 * either a zero block or a block which hasn't been used so far
1334 * (which also means that it's a zero block. Don't need to write
1335 * anything to this block if the data consists of just zeroes. */
1336 Assert(!(cbToWrite % 4));
1337 Assert(cbToWrite * 8 <= UINT32_MAX);
1338 if (ASMBitFirstSet((volatile void *)pvBuf, (uint32_t)cbToWrite * 8) == -1)
1339 {
1340 pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1341 break;
1342 }
1343 }
1344
1345 if (cbToWrite == getImageBlockSize(&pImage->Header))
1346 {
1347 /* Full block write to previously unallocated block.
1348 * Allocate block and write data. */
1349 Assert(!offWrite);
1350 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
1351 uint64_t u64Offset = (uint64_t)cBlocksAllocated * pImage->cbTotalBlockData
1352 + (pImage->offStartData + pImage->offStartBlockData);
1353 rc = vdiFileWriteSync(pImage, u64Offset, pvBuf, cbToWrite, NULL);
1354 if (RT_FAILURE(rc))
1355 goto out;
1356 pImage->paBlocks[uBlock] = cBlocksAllocated;
1357 setImageBlocksAllocated(&pImage->Header, cBlocksAllocated + 1);
1358
1359 rc = vdiUpdateBlockInfo(pImage, uBlock);
1360 if (RT_FAILURE(rc))
1361 goto out;
1362
1363 *pcbPreRead = 0;
1364 *pcbPostRead = 0;
1365 }
1366 else
1367 {
1368 /* Trying to do a partial write to an unallocated block. Don't do
1369 * anything except letting the upper layer know what to do. */
1370 *pcbPreRead = offWrite % getImageBlockSize(&pImage->Header);
1371 *pcbPostRead = getImageBlockSize(&pImage->Header) - cbToWrite - *pcbPreRead;
1372 rc = VERR_VD_BLOCK_FREE;
1373 }
1374 }
1375 else
1376 {
1377 /* Block present in image file, write relevant data. */
1378 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1379 + (pImage->offStartData + pImage->offStartBlockData + offWrite);
1380 rc = vdiFileWriteSync(pImage, u64Offset, pvBuf, cbToWrite, NULL);
1381 }
1382 } while (0);
1383
1384 if (pcbWriteProcess)
1385 *pcbWriteProcess = cbToWrite;
1386
1387out:
1388 LogFlowFunc(("returns %Rrc\n", rc));
1389 return rc;
1390}
1391
1392/** @copydoc VBOXHDDBACKEND::pfnFlush */
1393static int vdiFlush(void *pBackendData)
1394{
1395 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1396 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1397 int rc = VINF_SUCCESS;
1398
1399 Assert(pImage);
1400
1401 vdiFlushImage(pImage);
1402 LogFlowFunc(("returns %Rrc\n", rc));
1403 return rc;
1404}
1405
1406/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
1407static unsigned vdiGetVersion(void *pBackendData)
1408{
1409 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1410 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1411 unsigned uVersion;
1412
1413 AssertPtr(pImage);
1414
1415 if (pImage)
1416 uVersion = pImage->PreHeader.u32Version;
1417 else
1418 uVersion = 0;
1419
1420 LogFlowFunc(("returns %#x\n", uVersion));
1421 return uVersion;
1422}
1423
1424/** @copydoc VBOXHDDBACKEND::pfnGetSize */
1425static uint64_t vdiGetSize(void *pBackendData)
1426{
1427 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1428 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1429 uint64_t cbSize;
1430
1431 AssertPtr(pImage);
1432
1433 if (pImage)
1434 cbSize = getImageDiskSize(&pImage->Header);
1435 else
1436 cbSize = 0;
1437
1438 LogFlowFunc(("returns %llu\n", cbSize));
1439 return cbSize;
1440}
1441
1442/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
1443static uint64_t vdiGetFileSize(void *pBackendData)
1444{
1445 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1446 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1447 uint64_t cb = 0;
1448
1449 AssertPtr(pImage);
1450
1451 if (pImage)
1452 {
1453 uint64_t cbFile;
1454 if (pImage->pStorage)
1455 {
1456 int rc = vdiFileGetSize(pImage, &cbFile);
1457 if (RT_SUCCESS(rc))
1458 cb += cbFile;
1459 }
1460 }
1461
1462 LogFlowFunc(("returns %lld\n", cb));
1463 return cb;
1464}
1465
1466/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
1467static int vdiGetPCHSGeometry(void *pBackendData, PVDGEOMETRY pPCHSGeometry)
1468{
1469 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
1470 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1471 int rc;
1472
1473 AssertPtr(pImage);
1474
1475 if (pImage)
1476 {
1477 if (pImage->PCHSGeometry.cCylinders)
1478 {
1479 *pPCHSGeometry = pImage->PCHSGeometry;
1480 rc = VINF_SUCCESS;
1481 }
1482 else
1483 rc = VERR_VD_GEOMETRY_NOT_SET;
1484 }
1485 else
1486 rc = VERR_VD_NOT_OPENED;
1487
1488 LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1489 return rc;
1490}
1491
1492/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
1493static int vdiSetPCHSGeometry(void *pBackendData, PCVDGEOMETRY pPCHSGeometry)
1494{
1495 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1496 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1497 int rc;
1498
1499 AssertPtr(pImage);
1500
1501 if (pImage)
1502 {
1503 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1504 {
1505 rc = VERR_VD_IMAGE_READ_ONLY;
1506 goto out;
1507 }
1508
1509 pImage->PCHSGeometry = *pPCHSGeometry;
1510 rc = VINF_SUCCESS;
1511 }
1512 else
1513 rc = VERR_VD_NOT_OPENED;
1514
1515out:
1516 LogFlowFunc(("returns %Rrc\n", rc));
1517 return rc;
1518}
1519
1520/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
1521static int vdiGetLCHSGeometry(void *pBackendData, PVDGEOMETRY pLCHSGeometry)
1522{
1523 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
1524 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1525 int rc;
1526
1527 AssertPtr(pImage);
1528
1529 if (pImage)
1530 {
1531 VDIDISKGEOMETRY DummyGeo = { 0, 0, 0, VDI_GEOMETRY_SECTOR_SIZE };
1532 PVDIDISKGEOMETRY pGeometry = getImageLCHSGeometry(&pImage->Header);
1533 if (!pGeometry)
1534 pGeometry = &DummyGeo;
1535
1536 if ( pGeometry->cCylinders > 0
1537 && pGeometry->cHeads > 0
1538 && pGeometry->cSectors > 0)
1539 {
1540 pLCHSGeometry->cCylinders = pGeometry->cCylinders;
1541 pLCHSGeometry->cHeads = pGeometry->cHeads;
1542 pLCHSGeometry->cSectors = pGeometry->cSectors;
1543 rc = VINF_SUCCESS;
1544 }
1545 else
1546 rc = VERR_VD_GEOMETRY_NOT_SET;
1547 }
1548 else
1549 rc = VERR_VD_NOT_OPENED;
1550
1551 LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1552 return rc;
1553}
1554
1555/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
1556static int vdiSetLCHSGeometry(void *pBackendData, PCVDGEOMETRY pLCHSGeometry)
1557{
1558 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1559 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1560 PVDIDISKGEOMETRY pGeometry;
1561 int rc;
1562
1563 AssertPtr(pImage);
1564
1565 if (pImage)
1566 {
1567 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1568 {
1569 rc = VERR_VD_IMAGE_READ_ONLY;
1570 goto out;
1571 }
1572
1573 pGeometry = getImageLCHSGeometry(&pImage->Header);
1574 if (pGeometry)
1575 {
1576 pGeometry->cCylinders = pLCHSGeometry->cCylinders;
1577 pGeometry->cHeads = pLCHSGeometry->cHeads;
1578 pGeometry->cSectors = pLCHSGeometry->cSectors;
1579 pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
1580
1581 /* Update header information in base image file. */
1582 vdiFlushImage(pImage);
1583 }
1584 rc = VINF_SUCCESS;
1585 }
1586 else
1587 rc = VERR_VD_NOT_OPENED;
1588
1589out:
1590 LogFlowFunc(("returns %Rrc\n", rc));
1591 return rc;
1592}
1593
1594/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
1595static unsigned vdiGetImageFlags(void *pBackendData)
1596{
1597 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1598 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1599 unsigned uImageFlags;
1600
1601 AssertPtr(pImage);
1602
1603 if (pImage)
1604 uImageFlags = pImage->uImageFlags;
1605 else
1606 uImageFlags = 0;
1607
1608 LogFlowFunc(("returns %#x\n", uImageFlags));
1609 return uImageFlags;
1610}
1611
1612/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
1613static unsigned vdiGetOpenFlags(void *pBackendData)
1614{
1615 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1616 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1617 unsigned uOpenFlags;
1618
1619 AssertPtr(pImage);
1620
1621 if (pImage)
1622 uOpenFlags = pImage->uOpenFlags;
1623 else
1624 uOpenFlags = 0;
1625
1626 LogFlowFunc(("returns %#x\n", uOpenFlags));
1627 return uOpenFlags;
1628}
1629
1630/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
1631static int vdiSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
1632{
1633 LogFlowFunc(("pBackendData=%#p uOpenFlags=%#x\n", pBackendData, uOpenFlags));
1634 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1635 int rc;
1636 const char *pszFilename;
1637
1638 /* Image must be opened and the new flags must be valid. Just readonly and
1639 * info flags are supported. */
1640 if (!pImage || (uOpenFlags & ~(VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_ASYNC_IO | VD_OPEN_FLAGS_SHAREABLE)))
1641 {
1642 rc = VERR_INVALID_PARAMETER;
1643 goto out;
1644 }
1645
1646 /* Implement this operation via reopening the image. */
1647 pszFilename = pImage->pszFilename;
1648 rc = vdiFreeImage(pImage, false);
1649 if (RT_FAILURE(rc))
1650 goto out;
1651 rc = vdiOpenImage(pImage, uOpenFlags);
1652
1653out:
1654 LogFlowFunc(("returns %Rrc\n", rc));
1655 return rc;
1656}
1657
1658/** @copydoc VBOXHDDBACKEND::pfnGetComment */
1659static int vdiGetComment(void *pBackendData, char *pszComment,
1660 size_t cbComment)
1661{
1662 LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
1663 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1664 int rc = VINF_SUCCESS;
1665
1666 AssertPtr(pImage);
1667
1668 if (pImage)
1669 {
1670 char *pszTmp = getImageComment(&pImage->Header);
1671 size_t cb = strlen(pszTmp);
1672 if (cb < cbComment)
1673 {
1674 /* memcpy is much better than strncpy. */
1675 memcpy(pszComment, pszTmp, cb + 1);
1676 }
1677 else
1678 rc = VERR_BUFFER_OVERFLOW;
1679 }
1680 else
1681 rc = VERR_VD_NOT_OPENED;
1682
1683 LogFlowFunc(("returns %Rrc comment=\"%s\"\n", rc, pszComment));
1684 return rc;
1685}
1686
1687/** @copydoc VBOXHDDBACKEND::pfnGetComment */
1688static int vdiSetComment(void *pBackendData, const char *pszComment)
1689{
1690 LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
1691 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1692 int rc;
1693
1694 AssertPtr(pImage);
1695
1696 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1697 {
1698 rc = VERR_VD_IMAGE_READ_ONLY;
1699 goto out;
1700 }
1701
1702 if (pImage)
1703 {
1704 size_t cchComment = pszComment ? strlen(pszComment) : 0;
1705 if (cchComment >= VDI_IMAGE_COMMENT_SIZE)
1706 {
1707 LogFunc(("pszComment is too long, %d bytes!\n", cchComment));
1708 rc = VERR_VD_VDI_COMMENT_TOO_LONG;
1709 goto out;
1710 }
1711
1712 /* we don't support old style images */
1713 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1714 {
1715 /*
1716 * Update the comment field, making sure to zero out all of the previous comment.
1717 */
1718 memset(pImage->Header.u.v1.szComment, '\0', VDI_IMAGE_COMMENT_SIZE);
1719 memcpy(pImage->Header.u.v1.szComment, pszComment, cchComment);
1720
1721 /* write out new the header */
1722 rc = vdiUpdateHeader(pImage);
1723 }
1724 else
1725 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1726 }
1727 else
1728 rc = VERR_VD_NOT_OPENED;
1729
1730out:
1731 LogFlowFunc(("returns %Rrc\n", rc));
1732 return rc;
1733}
1734
1735/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
1736static int vdiGetUuid(void *pBackendData, PRTUUID pUuid)
1737{
1738 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1739 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1740 int rc;
1741
1742 AssertPtr(pImage);
1743
1744 if (pImage)
1745 {
1746 *pUuid = *getImageCreationUUID(&pImage->Header);
1747 rc = VINF_SUCCESS;
1748 }
1749 else
1750 rc = VERR_VD_NOT_OPENED;
1751
1752 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1753 return rc;
1754}
1755
1756/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
1757static int vdiSetUuid(void *pBackendData, PCRTUUID pUuid)
1758{
1759 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1760 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1761 int rc = VINF_SUCCESS;
1762
1763 AssertPtr(pImage);
1764
1765 if (pImage)
1766 {
1767 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1768 {
1769 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1770 pImage->Header.u.v1.uuidCreate = *pUuid;
1771 /* Make it possible to clone old VDIs. */
1772 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1773 pImage->Header.u.v0.uuidCreate = *pUuid;
1774 else
1775 {
1776 LogFunc(("Version is not supported!\n"));
1777 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1778 }
1779 }
1780 else
1781 rc = VERR_VD_IMAGE_READ_ONLY;
1782 }
1783 else
1784 rc = VERR_VD_NOT_OPENED;
1785
1786 LogFlowFunc(("returns %Rrc\n", rc));
1787 return rc;
1788}
1789
1790/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
1791static int vdiGetModificationUuid(void *pBackendData, PRTUUID pUuid)
1792{
1793 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1794 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1795 int rc;
1796
1797 AssertPtr(pImage);
1798
1799 if (pImage)
1800 {
1801 *pUuid = *getImageModificationUUID(&pImage->Header);
1802 rc = VINF_SUCCESS;
1803 }
1804 else
1805 rc = VERR_VD_NOT_OPENED;
1806
1807 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1808 return rc;
1809}
1810
1811/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
1812static int vdiSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
1813{
1814 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1815 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1816 int rc = VINF_SUCCESS;
1817
1818 AssertPtr(pImage);
1819
1820 if (pImage)
1821 {
1822 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1823 {
1824 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1825 pImage->Header.u.v1.uuidModify = *pUuid;
1826 /* Make it possible to clone old VDIs. */
1827 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1828 pImage->Header.u.v0.uuidModify = *pUuid;
1829 else
1830 {
1831 LogFunc(("Version is not supported!\n"));
1832 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1833 }
1834 }
1835 else
1836 rc = VERR_VD_IMAGE_READ_ONLY;
1837 }
1838 else
1839 rc = VERR_VD_NOT_OPENED;
1840
1841 LogFlowFunc(("returns %Rrc\n", rc));
1842 return rc;
1843}
1844
1845/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
1846static int vdiGetParentUuid(void *pBackendData, PRTUUID pUuid)
1847{
1848 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1849 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1850 int rc;
1851
1852 AssertPtr(pImage);
1853
1854 if (pImage)
1855 {
1856 *pUuid = *getImageParentUUID(&pImage->Header);
1857 rc = VINF_SUCCESS;
1858 }
1859 else
1860 rc = VERR_VD_NOT_OPENED;
1861
1862 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1863 return rc;
1864}
1865
1866/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
1867static int vdiSetParentUuid(void *pBackendData, PCRTUUID pUuid)
1868{
1869 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1870 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1871 int rc = VINF_SUCCESS;
1872
1873 AssertPtr(pImage);
1874
1875 if (pImage)
1876 {
1877 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1878 {
1879 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1880 pImage->Header.u.v1.uuidLinkage = *pUuid;
1881 /* Make it possible to clone old VDIs. */
1882 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1883 pImage->Header.u.v0.uuidLinkage = *pUuid;
1884 else
1885 {
1886 LogFunc(("Version is not supported!\n"));
1887 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1888 }
1889 }
1890 else
1891 rc = VERR_VD_IMAGE_READ_ONLY;
1892 }
1893 else
1894 rc = VERR_VD_NOT_OPENED;
1895
1896 LogFlowFunc(("returns %Rrc\n", rc));
1897 return rc;
1898}
1899
1900/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
1901static int vdiGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
1902{
1903 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1904 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1905 int rc;
1906
1907 AssertPtr(pImage);
1908
1909 if (pImage)
1910 {
1911 *pUuid = *getImageParentModificationUUID(&pImage->Header);
1912 rc = VINF_SUCCESS;
1913 }
1914 else
1915 rc = VERR_VD_NOT_OPENED;
1916
1917 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1918 return rc;
1919}
1920
1921/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
1922static int vdiSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
1923{
1924 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1925 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1926 int rc = VINF_SUCCESS;
1927
1928 AssertPtr(pImage);
1929
1930 if (pImage)
1931 {
1932 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1933 {
1934 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1935 pImage->Header.u.v1.uuidParentModify = *pUuid;
1936 else
1937 {
1938 LogFunc(("Version is not supported!\n"));
1939 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1940 }
1941 }
1942 else
1943 rc = VERR_VD_IMAGE_READ_ONLY;
1944 }
1945 else
1946 rc = VERR_VD_NOT_OPENED;
1947
1948 LogFlowFunc(("returns %Rrc\n", rc));
1949 return rc;
1950}
1951
1952/** @copydoc VBOXHDDBACKEND::pfnDump */
1953static void vdiDump(void *pBackendData)
1954{
1955 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1956
1957 vdiMessage(pImage, "Dumping VDI image \"%s\" mode=%s uOpenFlags=%X File=%#p\n",
1958 pImage->pszFilename,
1959 (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY) ? "r/o" : "r/w",
1960 pImage->uOpenFlags,
1961 pImage->pStorage);
1962 vdiMessage(pImage, "Header: Version=%08X Type=%X Flags=%X Size=%llu\n",
1963 pImage->PreHeader.u32Version,
1964 getImageType(&pImage->Header),
1965 getImageFlags(&pImage->Header),
1966 getImageDiskSize(&pImage->Header));
1967 vdiMessage(pImage, "Header: cbBlock=%u cbBlockExtra=%u cBlocks=%u cBlocksAllocated=%u\n",
1968 getImageBlockSize(&pImage->Header),
1969 getImageExtraBlockSize(&pImage->Header),
1970 getImageBlocks(&pImage->Header),
1971 getImageBlocksAllocated(&pImage->Header));
1972 vdiMessage(pImage, "Header: offBlocks=%u offData=%u\n",
1973 getImageBlocksOffset(&pImage->Header),
1974 getImageDataOffset(&pImage->Header));
1975 PVDIDISKGEOMETRY pg = getImageLCHSGeometry(&pImage->Header);
1976 if (pg)
1977 vdiMessage(pImage, "Header: Geometry: C/H/S=%u/%u/%u cbSector=%u\n",
1978 pg->cCylinders, pg->cHeads, pg->cSectors, pg->cbSector);
1979 vdiMessage(pImage, "Header: uuidCreation={%RTuuid}\n", getImageCreationUUID(&pImage->Header));
1980 vdiMessage(pImage, "Header: uuidModification={%RTuuid}\n", getImageModificationUUID(&pImage->Header));
1981 vdiMessage(pImage, "Header: uuidParent={%RTuuid}\n", getImageParentUUID(&pImage->Header));
1982 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) >= 1)
1983 vdiMessage(pImage, "Header: uuidParentModification={%RTuuid}\n", getImageParentModificationUUID(&pImage->Header));
1984 vdiMessage(pImage, "Image: fFlags=%08X offStartBlocks=%u offStartData=%u\n",
1985 pImage->uImageFlags, pImage->offStartBlocks, pImage->offStartData);
1986 vdiMessage(pImage, "Image: uBlockMask=%08X cbTotalBlockData=%u uShiftOffset2Index=%u offStartBlockData=%u\n",
1987 pImage->uBlockMask,
1988 pImage->cbTotalBlockData,
1989 pImage->uShiftOffset2Index,
1990 pImage->offStartBlockData);
1991
1992 unsigned uBlock, cBlocksNotFree, cBadBlocks, cBlocks = getImageBlocks(&pImage->Header);
1993 for (uBlock=0, cBlocksNotFree=0, cBadBlocks=0; uBlock<cBlocks; uBlock++)
1994 {
1995 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
1996 {
1997 cBlocksNotFree++;
1998 if (pImage->paBlocks[uBlock] >= cBlocks)
1999 cBadBlocks++;
2000 }
2001 }
2002 if (cBlocksNotFree != getImageBlocksAllocated(&pImage->Header))
2003 {
2004 vdiMessage(pImage, "!! WARNING: %u blocks actually allocated (cBlocksAllocated=%u) !!\n",
2005 cBlocksNotFree, getImageBlocksAllocated(&pImage->Header));
2006 }
2007 if (cBadBlocks)
2008 {
2009 vdiMessage(pImage, "!! WARNING: %u bad blocks found !!\n",
2010 cBadBlocks);
2011 }
2012}
2013
2014static bool vdiIsAsyncIOSupported(void *pBackendData)
2015{
2016 return true;
2017}
2018
2019static int vdiAsyncRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
2020 PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
2021{
2022 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
2023 pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
2024 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2025 unsigned uBlock;
2026 unsigned offRead;
2027 int rc;
2028
2029 AssertPtr(pImage);
2030 Assert(!(uOffset % 512));
2031 Assert(!(cbToRead % 512));
2032
2033 if ( uOffset + cbToRead > getImageDiskSize(&pImage->Header)
2034 || !VALID_PTR(pIoCtx)
2035 || !cbToRead)
2036 {
2037 rc = VERR_INVALID_PARAMETER;
2038 goto out;
2039 }
2040
2041 /* Calculate starting block number and offset inside it. */
2042 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
2043 offRead = (unsigned)uOffset & pImage->uBlockMask;
2044
2045 /* Clip read range to at most the rest of the block. */
2046 cbToRead = RT_MIN(cbToRead, getImageBlockSize(&pImage->Header) - offRead);
2047 Assert(!(cbToRead % 512));
2048
2049 if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
2050 rc = VERR_VD_BLOCK_FREE;
2051 else if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
2052 {
2053 size_t cbSet;
2054
2055 cbSet = vdiFileIoCtxSet(pImage, pIoCtx, 0, cbToRead);
2056 Assert(cbSet == cbToRead);
2057
2058 rc = VINF_SUCCESS;
2059 }
2060 else
2061 {
2062 /* Block present in image file, read relevant data. */
2063 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
2064 + (pImage->offStartData + pImage->offStartBlockData + offRead);
2065 rc = vdiFileReadUserAsync(pImage, u64Offset, pIoCtx, cbToRead);
2066 }
2067
2068 if (pcbActuallyRead)
2069 *pcbActuallyRead = cbToRead;
2070
2071out:
2072 LogFlowFunc(("returns %Rrc\n", rc));
2073 return rc;
2074}
2075
2076static int vdiAsyncWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
2077 PVDIOCTX pIoCtx,
2078 size_t *pcbWriteProcess, size_t *pcbPreRead,
2079 size_t *pcbPostRead, unsigned fWrite)
2080{
2081 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
2082 pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
2083 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2084 unsigned uBlock;
2085 unsigned offWrite;
2086 int rc = VINF_SUCCESS;
2087
2088 AssertPtr(pImage);
2089 Assert(!(uOffset % 512));
2090 Assert(!(cbToWrite % 512));
2091
2092 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2093 {
2094 rc = VERR_VD_IMAGE_READ_ONLY;
2095 goto out;
2096 }
2097
2098 if (!VALID_PTR(pIoCtx) || !cbToWrite)
2099 {
2100 rc = VERR_INVALID_PARAMETER;
2101 goto out;
2102 }
2103
2104 /* No size check here, will do that later. For dynamic images which are
2105 * not multiples of the block size in length, this would prevent writing to
2106 * the last block. */
2107
2108 /* Calculate starting block number and offset inside it. */
2109 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
2110 offWrite = (unsigned)uOffset & pImage->uBlockMask;
2111
2112 /* Clip write range to at most the rest of the block. */
2113 cbToWrite = RT_MIN(cbToWrite, getImageBlockSize(&pImage->Header) - offWrite);
2114 Assert(!(cbToWrite % 512));
2115
2116 do
2117 {
2118 if (!IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
2119 {
2120 /* Block is either free or zero. */
2121 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_ZEROES)
2122 && ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
2123 || cbToWrite == getImageBlockSize(&pImage->Header)))
2124 {
2125#if 0 /** @todo Provide interface to check an I/O context for a specific value */
2126 /* If the destination block is unallocated at this point, it's
2127 * either a zero block or a block which hasn't been used so far
2128 * (which also means that it's a zero block. Don't need to write
2129 * anything to this block if the data consists of just zeroes. */
2130 Assert(!(cbToWrite % 4));
2131 Assert(cbToWrite * 8 <= UINT32_MAX);
2132 if (ASMBitFirstSet((volatile void *)pvBuf, (uint32_t)cbToWrite * 8) == -1)
2133 {
2134 pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
2135 break;
2136 }
2137#endif
2138 }
2139
2140 if ( cbToWrite == getImageBlockSize(&pImage->Header)
2141 && !(fWrite & VD_WRITE_NO_ALLOC))
2142 {
2143 /* Full block write to previously unallocated block.
2144 * Allocate block and write data. */
2145 Assert(!offWrite);
2146 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
2147 uint64_t u64Offset = (uint64_t)cBlocksAllocated * pImage->cbTotalBlockData
2148 + (pImage->offStartData + pImage->offStartBlockData);
2149 rc = vdiFileWriteUserAsync(pImage, u64Offset, pIoCtx, cbToWrite, NULL, NULL);
2150 if (RT_UNLIKELY(RT_FAILURE_NP(rc) && (rc != VERR_VD_ASYNC_IO_IN_PROGRESS)))
2151 goto out;
2152 pImage->paBlocks[uBlock] = cBlocksAllocated;
2153 setImageBlocksAllocated(&pImage->Header, cBlocksAllocated + 1);
2154
2155 rc = vdiUpdateBlockInfoAsync(pImage, uBlock, pIoCtx);
2156 if (RT_FAILURE(rc) && (rc != VERR_VD_ASYNC_IO_IN_PROGRESS))
2157 goto out;
2158
2159 *pcbPreRead = 0;
2160 *pcbPostRead = 0;
2161 }
2162 else
2163 {
2164 /* Trying to do a partial write to an unallocated block. Don't do
2165 * anything except letting the upper layer know what to do. */
2166 *pcbPreRead = offWrite % getImageBlockSize(&pImage->Header);
2167 *pcbPostRead = getImageBlockSize(&pImage->Header) - cbToWrite - *pcbPreRead;
2168 rc = VERR_VD_BLOCK_FREE;
2169 }
2170 }
2171 else
2172 {
2173 /* Block present in image file, write relevant data. */
2174 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
2175 + (pImage->offStartData + pImage->offStartBlockData + offWrite);
2176 rc = vdiFileWriteUserAsync(pImage, u64Offset, pIoCtx, cbToWrite, NULL, NULL);
2177 }
2178 } while (0);
2179
2180 if (pcbWriteProcess)
2181 *pcbWriteProcess = cbToWrite;
2182
2183out:
2184 LogFlowFunc(("returns %Rrc\n", rc));
2185 return rc;
2186}
2187
2188static int vdiAsyncFlush(void *pBackendData, PVDIOCTX pIoCtx)
2189{
2190 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2191 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2192 int rc = VINF_SUCCESS;
2193
2194 Assert(pImage);
2195
2196 rc = vdiFlushImageAsync(pImage, pIoCtx);
2197 LogFlowFunc(("returns %Rrc\n", rc));
2198 return rc;
2199}
2200
2201/** @copydoc VBOXHDDBACKEND::pfnCompact */
2202static int vdiCompact(void *pBackendData, unsigned uPercentStart,
2203 unsigned uPercentSpan, PVDINTERFACE pVDIfsDisk,
2204 PVDINTERFACE pVDIfsImage, PVDINTERFACE pVDIfsOperation)
2205{
2206 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2207 int rc = VINF_SUCCESS;
2208 void *pvBuf = NULL, *pvTmp = NULL;
2209 unsigned *paBlocks2 = NULL;
2210
2211 int (*pfnParentRead)(void *, uint64_t, void *, size_t) = NULL;
2212 void *pvParent = NULL;
2213 PVDINTERFACE pIfParentState = VDInterfaceGet(pVDIfsOperation,
2214 VDINTERFACETYPE_PARENTSTATE);
2215 PVDINTERFACEPARENTSTATE pCbParentState = NULL;
2216 if (pIfParentState)
2217 {
2218 pCbParentState = VDGetInterfaceParentState(pIfParentState);
2219 if (pCbParentState)
2220 pfnParentRead = pCbParentState->pfnParentRead;
2221 pvParent = pIfParentState->pvUser;
2222 }
2223
2224 PFNVDPROGRESS pfnProgress = NULL;
2225 void *pvUser = NULL;
2226 PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
2227 VDINTERFACETYPE_PROGRESS);
2228 PVDINTERFACEPROGRESS pCbProgress = NULL;
2229 if (pIfProgress)
2230 {
2231 pCbProgress = VDGetInterfaceProgress(pIfProgress);
2232 if (pCbProgress)
2233 pfnProgress = pCbProgress->pfnProgress;
2234 pvUser = pIfProgress->pvUser;
2235 }
2236
2237 do {
2238 AssertBreakStmt(pImage, rc = VERR_INVALID_PARAMETER);
2239
2240 AssertBreakStmt(!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY),
2241 rc = VERR_VD_IMAGE_READ_ONLY);
2242
2243 unsigned cBlocks;
2244 unsigned cBlocksToMove = 0;
2245 size_t cbBlock;
2246 cBlocks = getImageBlocks(&pImage->Header);
2247 cbBlock = getImageBlockSize(&pImage->Header);
2248 if (pfnParentRead)
2249 {
2250 pvBuf = RTMemTmpAlloc(cbBlock);
2251 AssertBreakStmt(VALID_PTR(pvBuf), rc = VERR_NO_MEMORY);
2252 }
2253 pvTmp = RTMemTmpAlloc(cbBlock);
2254 AssertBreakStmt(VALID_PTR(pvTmp), rc = VERR_NO_MEMORY);
2255
2256 uint64_t cbFile;
2257 rc = vdiFileGetSize(pImage, &cbFile);
2258 AssertRCBreak(rc);
2259 unsigned cBlocksAllocated = (unsigned)((cbFile - pImage->offStartData - pImage->offStartBlockData) >> pImage->uShiftOffset2Index);
2260 if (cBlocksAllocated == 0)
2261 {
2262 /* No data blocks in this image, no need to compact. */
2263 rc = VINF_SUCCESS;
2264 break;
2265 }
2266
2267 /* Allocate block array for back resolving. */
2268 paBlocks2 = (unsigned *)RTMemAlloc(sizeof(unsigned *) * cBlocksAllocated);
2269 AssertBreakStmt(VALID_PTR(paBlocks2), rc = VERR_NO_MEMORY);
2270 /* Fill out back resolving, check/fix allocation errors before
2271 * compacting the image, just to be on the safe side. Update the
2272 * image contents straight away, as this enables cancelling. */
2273 for (unsigned i = 0; i < cBlocksAllocated; i++)
2274 paBlocks2[i] = VDI_IMAGE_BLOCK_FREE;
2275 rc = VINF_SUCCESS;
2276 for (unsigned i = 0; i < cBlocks; i++)
2277 {
2278 VDIIMAGEBLOCKPOINTER ptrBlock = pImage->paBlocks[i];
2279 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock))
2280 {
2281 if (ptrBlock < cBlocksAllocated)
2282 {
2283 if (paBlocks2[ptrBlock] == VDI_IMAGE_BLOCK_FREE)
2284 paBlocks2[ptrBlock] = i;
2285 else
2286 {
2287 LogFunc(("Freed cross-linked block %u in file \"%s\"\n",
2288 i, pImage->pszFilename));
2289 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2290 rc = vdiUpdateBlockInfo(pImage, i);
2291 if (RT_FAILURE(rc))
2292 break;
2293 }
2294 }
2295 else
2296 {
2297 LogFunc(("Freed out of bounds reference for block %u in file \"%s\"\n",
2298 i, pImage->pszFilename));
2299 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2300 rc = vdiUpdateBlockInfo(pImage, i);
2301 if (RT_FAILURE(rc))
2302 break;
2303 }
2304 }
2305 }
2306 if (RT_FAILURE(rc))
2307 break;
2308
2309 /* Find redundant information and update the block pointers
2310 * accordingly, creating bubbles. Keep disk up to date, as this
2311 * enables cancelling. */
2312 for (unsigned i = 0; i < cBlocks; i++)
2313 {
2314 VDIIMAGEBLOCKPOINTER ptrBlock = pImage->paBlocks[i];
2315 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock))
2316 {
2317 /* Block present in image file, read relevant data. */
2318 uint64_t u64Offset = (uint64_t)ptrBlock * pImage->cbTotalBlockData
2319 + (pImage->offStartData + pImage->offStartBlockData);
2320 rc = vdiFileReadSync(pImage, u64Offset, pvTmp, cbBlock, NULL);
2321 if (RT_FAILURE(rc))
2322 break;
2323
2324 if (ASMBitFirstSet((volatile void *)pvTmp, (uint32_t)cbBlock * 8) == -1)
2325 {
2326 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_ZERO;
2327 rc = vdiUpdateBlockInfo(pImage, i);
2328 if (RT_FAILURE(rc))
2329 break;
2330 paBlocks2[ptrBlock] = VDI_IMAGE_BLOCK_FREE;
2331 /* Adjust progress info, one block to be relocated. */
2332 cBlocksToMove++;
2333 }
2334 else if (pfnParentRead)
2335 {
2336 rc = pfnParentRead(pvParent, i * cbBlock, pvBuf, cbBlock);
2337 if (RT_FAILURE(rc))
2338 break;
2339 if (!memcmp(pvTmp, pvBuf, cbBlock))
2340 {
2341 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2342 rc = vdiUpdateBlockInfo(pImage, i);
2343 if (RT_FAILURE(rc))
2344 break;
2345 paBlocks2[ptrBlock] = VDI_IMAGE_BLOCK_FREE;
2346 /* Adjust progress info, one block to be relocated. */
2347 cBlocksToMove++;
2348 }
2349 }
2350 }
2351
2352 if (pCbProgress && pCbProgress->pfnProgress)
2353 {
2354 rc = pCbProgress->pfnProgress(pIfProgress->pvUser,
2355 (uint64_t)i * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2356 if (RT_FAILURE(rc))
2357 break;
2358 }
2359 }
2360 if (RT_FAILURE(rc))
2361 break;
2362
2363 /* Fill bubbles with other data (if available). */
2364 unsigned cBlocksMoved = 0;
2365 unsigned uBlockUsedPos = cBlocksAllocated;
2366 for (unsigned i = 0; i < cBlocksAllocated; i++)
2367 {
2368 unsigned uBlock = paBlocks2[i];
2369 if (uBlock == VDI_IMAGE_BLOCK_FREE)
2370 {
2371 unsigned uBlockData = VDI_IMAGE_BLOCK_FREE;
2372 while (uBlockUsedPos > i && uBlockData == VDI_IMAGE_BLOCK_FREE)
2373 {
2374 uBlockUsedPos--;
2375 uBlockData = paBlocks2[uBlockUsedPos];
2376 }
2377 /* Terminate early if there is no block which needs copying. */
2378 if (uBlockUsedPos == i)
2379 break;
2380 uint64_t u64Offset = (uint64_t)uBlockUsedPos * pImage->cbTotalBlockData
2381 + (pImage->offStartData + pImage->offStartBlockData);
2382 rc = vdiFileReadSync(pImage, u64Offset, pvTmp, cbBlock, NULL);
2383 u64Offset = (uint64_t)i * pImage->cbTotalBlockData
2384 + (pImage->offStartData + pImage->offStartBlockData);
2385 rc = vdiFileWriteSync(pImage, u64Offset, pvTmp, cbBlock, NULL);
2386 pImage->paBlocks[uBlockData] = i;
2387 setImageBlocksAllocated(&pImage->Header, cBlocksAllocated - cBlocksMoved);
2388 rc = vdiUpdateBlockInfo(pImage, uBlockData);
2389 if (RT_FAILURE(rc))
2390 break;
2391 paBlocks2[i] = uBlockData;
2392 paBlocks2[uBlockUsedPos] = VDI_IMAGE_BLOCK_FREE;
2393 cBlocksMoved++;
2394 }
2395
2396 if (pCbProgress && pCbProgress->pfnProgress)
2397 {
2398 rc = pCbProgress->pfnProgress(pIfProgress->pvUser,
2399 (uint64_t)(cBlocks + cBlocksMoved) * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2400
2401 if (RT_FAILURE(rc))
2402 break;
2403 }
2404 }
2405 if (RT_FAILURE(rc))
2406 break;
2407
2408 /* Update image header. */
2409 setImageBlocksAllocated(&pImage->Header, uBlockUsedPos);
2410 vdiUpdateHeader(pImage);
2411
2412 /* Truncate the image to the proper size to finish compacting. */
2413 rc = vdiFileSetSize(pImage,
2414 (uint64_t)uBlockUsedPos * pImage->cbTotalBlockData
2415 + pImage->offStartData + pImage->offStartBlockData);
2416 } while (0);
2417
2418 if (paBlocks2)
2419 RTMemTmpFree(paBlocks2);
2420 if (pvTmp)
2421 RTMemTmpFree(pvTmp);
2422 if (pvBuf)
2423 RTMemTmpFree(pvBuf);
2424
2425 if (RT_SUCCESS(rc) && pCbProgress && pCbProgress->pfnProgress)
2426 {
2427 pCbProgress->pfnProgress(pIfProgress->pvUser,
2428 uPercentStart + uPercentSpan);
2429 }
2430
2431 LogFlowFunc(("returns %Rrc\n", rc));
2432 return rc;
2433}
2434
2435
2436/** @copydoc VBOXHDDBACKEND::pfnResize */
2437static int vdiResize(void *pBackendData, uint64_t cbSize,
2438 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
2439 unsigned uPercentStart, unsigned uPercentSpan,
2440 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
2441 PVDINTERFACE pVDIfsOperation)
2442{
2443 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2444 int rc = VINF_SUCCESS;
2445
2446 PFNVDPROGRESS pfnProgress = NULL;
2447 void *pvUser = NULL;
2448 PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
2449 VDINTERFACETYPE_PROGRESS);
2450 PVDINTERFACEPROGRESS pCbProgress = NULL;
2451 if (pIfProgress)
2452 {
2453 pCbProgress = VDGetInterfaceProgress(pIfProgress);
2454 if (pCbProgress)
2455 pfnProgress = pCbProgress->pfnProgress;
2456 pvUser = pIfProgress->pvUser;
2457 }
2458
2459 /*
2460 * Making the image smaller is not supported at the moment.
2461 * Resizing is also not supported for fixed size images and
2462 * very old images.
2463 */
2464 /** @todo implement making the image smaller, it is the responsibility of
2465 * the user to know what he's doing. */
2466 if ( cbSize < getImageDiskSize(&pImage->Header)
2467 || GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0
2468 || pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED)
2469 rc = VERR_NOT_SUPPORTED;
2470 else if (cbSize > getImageDiskSize(&pImage->Header))
2471 {
2472 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header); /** < Blocks currently allocated, doesn't change during resize */
2473 uint32_t cBlocksNew = cbSize / getImageBlockSize(&pImage->Header); /** < New number of blocks in the image after the resize */
2474 if (cbSize % getImageBlockSize(&pImage->Header))
2475 cBlocksNew++;
2476
2477 uint32_t cBlocksOld = getImageBlocks(&pImage->Header); /** < Number of blocks before the resize. */
2478 uint64_t cbBlockspaceNew = cBlocksNew * sizeof(VDIIMAGEBLOCKPOINTER); /** < Required space for the block array after the resize. */
2479 uint64_t offStartDataNew = RT_ALIGN_32(pImage->offStartBlocks + cbBlockspaceNew, VDI_DATA_ALIGN); /** < New start offset for block data after the resize */
2480
2481 if ( pImage->offStartData != offStartDataNew
2482 && cBlocksAllocated > 0)
2483 {
2484 /* Calculate how many sectors need to be relocated. */
2485 uint64_t cbOverlapping = offStartDataNew - pImage->offStartData;
2486 unsigned cBlocksReloc = cbOverlapping / getImageBlockSize(&pImage->Header);
2487 if (cbOverlapping % getImageBlockSize(&pImage->Header))
2488 cBlocksReloc++;
2489
2490 /* Since only full blocks can be relocated the new data start is
2491 * determined by moving it block by block. */
2492 cBlocksReloc = RT_MIN(cBlocksReloc, cBlocksAllocated);
2493 offStartDataNew = pImage->offStartData;
2494
2495 /* Do the relocation. */
2496 LogFlow(("Relocating %u blocks\n", cBlocksReloc));
2497
2498 /*
2499 * Get the blocks we need to relocate first, they are appended to the end
2500 * of the image.
2501 */
2502 void *pvBuf = NULL, *pvZero = NULL;
2503 do
2504 {
2505 VDIIMAGEBLOCKPOINTER uBlock = 0;
2506
2507 /* Allocate data buffer. */
2508 pvBuf = RTMemAllocZ(pImage->cbTotalBlockData);
2509 if (!pvBuf)
2510 {
2511 rc = VERR_NO_MEMORY;
2512 break;
2513 }
2514
2515 /* Allocate buffer for overwrting with zeroes. */
2516 pvZero = RTMemAllocZ(pImage->cbTotalBlockData);
2517 if (!pvZero)
2518 {
2519 rc = VERR_NO_MEMORY;
2520 break;
2521 }
2522
2523 for (unsigned i = 0; i < cBlocksReloc; i++)
2524 {
2525 /* Search the index in the block table. */
2526 for (unsigned idxBlock = 0; idxBlock < cBlocksOld; idxBlock++)
2527 {
2528 if (pImage->paBlocks[idxBlock] == uBlock)
2529 {
2530 /* Read data and append to the end of the image. */
2531 rc = vdiFileReadSync(pImage, offStartDataNew, pvBuf, pImage->cbTotalBlockData, NULL);
2532 if (RT_FAILURE(rc))
2533 break;
2534
2535 uint64_t offBlockAppend;
2536 rc = vdiFileGetSize(pImage, &offBlockAppend);
2537 if (RT_FAILURE(rc))
2538 break;
2539
2540 rc = vdiFileWriteSync(pImage, offBlockAppend, pvBuf, pImage->cbTotalBlockData, NULL);
2541 if (RT_FAILURE(rc))
2542 break;
2543
2544 /* Zero out the old block area. */
2545 rc = vdiFileWriteSync(pImage, offStartDataNew, pvZero, pImage->cbTotalBlockData, NULL);
2546 if (RT_FAILURE(rc))
2547 break;
2548
2549 /* Update block counter. */
2550 pImage->paBlocks[idxBlock] = cBlocksAllocated - 1;
2551
2552 /*
2553 * Decrease the block number of all other entries in the array.
2554 * They were moved one block to the front.
2555 * Doing it as a separate step iterating over the array again
2556 * because an error while relocating the block might end up
2557 * in a corrupted image otherwise.
2558 */
2559 for (unsigned idxBlock2 = 0; idxBlock2 < cBlocksOld; idxBlock2++)
2560 {
2561 if ( idxBlock2 != idxBlock
2562 && IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[idxBlock2]))
2563 pImage->paBlocks[idxBlock2]--;
2564 }
2565
2566 /* Continue with the next block. */
2567 break;
2568 }
2569 }
2570
2571 if (RT_FAILURE(rc))
2572 break;
2573
2574 uBlock++;
2575 offStartDataNew += pImage->cbTotalBlockData;
2576 }
2577 } while (0);
2578
2579 if (pvBuf)
2580 RTMemFree(pvBuf);
2581 if (pvZero)
2582 RTMemFree(pvZero);
2583 }
2584
2585 /*
2586 * We need to update the new offsets for the image data in the out of memory
2587 * case too because we relocated the blocks already.
2588 */
2589 pImage->offStartData = offStartDataNew;
2590 setImageDataOffset(&pImage->Header, offStartDataNew);
2591
2592 /*
2593 * Relocation done, expand the block array and update the header with
2594 * the new data.
2595 */
2596 if (RT_SUCCESS(rc))
2597 {
2598 PVDIIMAGEBLOCKPOINTER paBlocksNew = (PVDIIMAGEBLOCKPOINTER)RTMemRealloc(pImage->paBlocks, cbBlockspaceNew);
2599 if (paBlocksNew)
2600 {
2601 pImage->paBlocks = paBlocksNew;
2602
2603 /* Mark the new blocks as unallocated. */
2604 for (unsigned idxBlock = cBlocksOld; idxBlock < cBlocksNew; idxBlock++)
2605 pImage->paBlocks[idxBlock] = VDI_IMAGE_BLOCK_FREE;
2606 }
2607 else
2608 rc = VERR_NO_MEMORY;
2609
2610 /* Write the block array before updating the rest. */
2611 rc = vdiFileWriteSync(pImage, pImage->offStartBlocks, pImage->paBlocks,
2612 cbBlockspaceNew, NULL);
2613
2614 if (RT_SUCCESS(rc))
2615 {
2616 /* Update size and new block count. */
2617 setImageDiskSize(&pImage->Header, cbSize);
2618 setImageBlocks(&pImage->Header, cBlocksNew);
2619 /* Update geometry. */
2620 pImage->PCHSGeometry = *pPCHSGeometry;
2621
2622 PVDIDISKGEOMETRY pGeometry = getImageLCHSGeometry(&pImage->Header);
2623 if (pGeometry)
2624 {
2625 pGeometry->cCylinders = pLCHSGeometry->cCylinders;
2626 pGeometry->cHeads = pLCHSGeometry->cHeads;
2627 pGeometry->cSectors = pLCHSGeometry->cSectors;
2628 pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
2629 }
2630 }
2631 }
2632
2633 /* Update header information in base image file. */
2634 vdiFlushImage(pImage);
2635 }
2636 /* Same size doesn't change the image at all. */
2637
2638 LogFlowFunc(("returns %Rrc\n", rc));
2639 return rc;
2640}
2641
2642
2643VBOXHDDBACKEND g_VDIBackend =
2644{
2645 /* pszBackendName */
2646 "VDI",
2647 /* cbSize */
2648 sizeof(VBOXHDDBACKEND),
2649 /* uBackendCaps */
2650 VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
2651 | VD_CAP_DIFF | VD_CAP_FILE | VD_CAP_ASYNC | VD_CAP_VFS,
2652 /* papszFileExtensions */
2653 s_apszVdiFileExtensions,
2654 /* paConfigInfo */
2655 NULL,
2656 /* hPlugin */
2657 NIL_RTLDRMOD,
2658 /* pfnCheckIfValid */
2659 vdiCheckIfValid,
2660 /* pfnOpen */
2661 vdiOpen,
2662 /* pfnCreate */
2663 vdiCreate,
2664 /* pfnRename */
2665 vdiRename,
2666 /* pfnClose */
2667 vdiClose,
2668 /* pfnRead */
2669 vdiRead,
2670 /* pfnWrite */
2671 vdiWrite,
2672 /* pfnFlush */
2673 vdiFlush,
2674 /* pfnGetVersion */
2675 vdiGetVersion,
2676 /* pfnGetSize */
2677 vdiGetSize,
2678 /* pfnGetFileSize */
2679 vdiGetFileSize,
2680 /* pfnGetPCHSGeometry */
2681 vdiGetPCHSGeometry,
2682 /* pfnSetPCHSGeometry */
2683 vdiSetPCHSGeometry,
2684 /* pfnGetLCHSGeometry */
2685 vdiGetLCHSGeometry,
2686 /* pfnSetLCHSGeometry */
2687 vdiSetLCHSGeometry,
2688 /* pfnGetImageFlags */
2689 vdiGetImageFlags,
2690 /* pfnGetOpenFlags */
2691 vdiGetOpenFlags,
2692 /* pfnSetOpenFlags */
2693 vdiSetOpenFlags,
2694 /* pfnGetComment */
2695 vdiGetComment,
2696 /* pfnSetComment */
2697 vdiSetComment,
2698 /* pfnGetUuid */
2699 vdiGetUuid,
2700 /* pfnSetUuid */
2701 vdiSetUuid,
2702 /* pfnGetModificationUuid */
2703 vdiGetModificationUuid,
2704 /* pfnSetModificationUuid */
2705 vdiSetModificationUuid,
2706 /* pfnGetParentUuid */
2707 vdiGetParentUuid,
2708 /* pfnSetParentUuid */
2709 vdiSetParentUuid,
2710 /* pfnGetParentModificationUuid */
2711 vdiGetParentModificationUuid,
2712 /* pfnSetParentModificationUuid */
2713 vdiSetParentModificationUuid,
2714 /* pfnDump */
2715 vdiDump,
2716 /* pfnGetTimeStamp */
2717 NULL,
2718 /* pfnGetParentTimeStamp */
2719 NULL,
2720 /* pfnSetParentTimeStamp */
2721 NULL,
2722 /* pfnGetParentFilename */
2723 NULL,
2724 /* pfnSetParentFilename */
2725 NULL,
2726 /* pfnIsAsyncIOSupported */
2727 vdiIsAsyncIOSupported,
2728 /* pfnAsyncRead */
2729 vdiAsyncRead,
2730 /* pfnAsyncWrite */
2731 vdiAsyncWrite,
2732 /* pfnAsyncFlush */
2733 vdiAsyncFlush,
2734 /* pfnComposeLocation */
2735 genericFileComposeLocation,
2736 /* pfnComposeName */
2737 genericFileComposeName,
2738 /* pfnCompact */
2739 vdiCompact,
2740 /* pfnResize */
2741 vdiResize
2742};
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