VirtualBox

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

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

Devices/Storage: a number of small memory leaks in error paths

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 95.3 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 RTMemTmpFree(pvBuf);
714 goto out;
715 }
716
717 uOff += cbChunk;
718
719 if (pfnProgress)
720 {
721 rc = pfnProgress(pvUser,
722 uPercentStart + uOff * uPercentSpan / cbFill);
723 if (RT_FAILURE(rc))
724 goto out;
725 }
726 }
727 RTMemTmpFree(pvBuf);
728 }
729
730out:
731 if (RT_SUCCESS(rc) && pfnProgress)
732 pfnProgress(pvUser, uPercentStart + uPercentSpan);
733
734 if (RT_FAILURE(rc))
735 vdiFreeImage(pImage, rc != VERR_ALREADY_EXISTS);
736 return rc;
737}
738
739/**
740 * Internal: Open a VDI image.
741 */
742static int vdiOpenImage(PVDIIMAGEDESC pImage, unsigned uOpenFlags)
743{
744 int rc;
745
746 pImage->uOpenFlags = uOpenFlags;
747
748 pImage->pInterfaceError = VDInterfaceGet(pImage->pVDIfsDisk, VDINTERFACETYPE_ERROR);
749 if (pImage->pInterfaceError)
750 pImage->pInterfaceErrorCallbacks = VDGetInterfaceError(pImage->pInterfaceError);
751
752 /* Get I/O interface. */
753 pImage->pInterfaceIO = VDInterfaceGet(pImage->pVDIfsImage, VDINTERFACETYPE_IOINT);
754 AssertPtrReturn(pImage->pInterfaceIO, VERR_INVALID_PARAMETER);
755 pImage->pInterfaceIOCallbacks = VDGetInterfaceIOInt(pImage->pInterfaceIO);
756 AssertPtrReturn(pImage->pInterfaceIOCallbacks, VERR_INVALID_PARAMETER);
757
758 /*
759 * Open the image.
760 */
761 rc = vdiFileOpen(pImage, pImage->pszFilename,
762 VDOpenFlagsToFileOpenFlags(uOpenFlags, false /* fCreate */));
763 if (RT_FAILURE(rc))
764 {
765 /* Do NOT signal an appropriate error here, as the VD layer has the
766 * choice of retrying the open if it failed. */
767 goto out;
768 }
769
770 /* Read pre-header. */
771 rc = vdiFileReadSync(pImage, 0, &pImage->PreHeader, sizeof(pImage->PreHeader), NULL);
772 if (RT_FAILURE(rc))
773 {
774 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading pre-header in '%s'"), pImage->pszFilename);
775 goto out;
776 }
777 rc = vdiValidatePreHeader(&pImage->PreHeader);
778 if (RT_FAILURE(rc))
779 {
780 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: invalid pre-header in '%s'"), pImage->pszFilename);
781 goto out;
782 }
783
784 /* Read header. */
785 pImage->Header.uVersion = pImage->PreHeader.u32Version;
786 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
787 {
788 case 0:
789 rc = vdiFileReadSync(pImage, sizeof(pImage->PreHeader),
790 &pImage->Header.u.v0, sizeof(pImage->Header.u.v0),
791 NULL);
792 if (RT_FAILURE(rc))
793 {
794 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v0 header in '%s'"), pImage->pszFilename);
795 goto out;
796 }
797 break;
798 case 1:
799 rc = vdiFileReadSync(pImage, sizeof(pImage->PreHeader),
800 &pImage->Header.u.v1, sizeof(pImage->Header.u.v1),
801 NULL);
802 if (RT_FAILURE(rc))
803 {
804 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v1 header in '%s'"), pImage->pszFilename);
805 goto out;
806 }
807 /* Convert VDI 1.1 images to VDI 1.1+ on open in read/write mode.
808 * Conversion is harmless, as any VirtualBox version supporting VDI
809 * 1.1 doesn't touch fields it doesn't know about. */
810 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
811 && GET_MINOR_HEADER_VERSION(&pImage->Header) == 1
812 && pImage->Header.u.v1.cbHeader < sizeof(pImage->Header.u.v1plus))
813 {
814 pImage->Header.u.v1plus.cbHeader = sizeof(pImage->Header.u.v1plus);
815 /* Mark LCHS geometry not-calculated. */
816 pImage->Header.u.v1plus.LCHSGeometry.cCylinders = 0;
817 pImage->Header.u.v1plus.LCHSGeometry.cHeads = 0;
818 pImage->Header.u.v1plus.LCHSGeometry.cSectors = 0;
819 pImage->Header.u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
820 }
821 else if (pImage->Header.u.v1.cbHeader >= sizeof(pImage->Header.u.v1plus))
822 {
823 /* Read the actual VDI 1.1+ header completely. */
824 rc = vdiFileReadSync(pImage, sizeof(pImage->PreHeader),
825 &pImage->Header.u.v1plus,
826 sizeof(pImage->Header.u.v1plus), NULL);
827 if (RT_FAILURE(rc))
828 {
829 rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v1.1+ header in '%s'"), pImage->pszFilename);
830 goto out;
831 }
832 }
833 break;
834 default:
835 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);
836 goto out;
837 }
838
839 rc = vdiValidateHeader(&pImage->Header);
840 if (RT_FAILURE(rc))
841 {
842 rc = vdiError(pImage, VERR_VD_VDI_INVALID_HEADER, RT_SRC_POS, N_("VDI: invalid header in '%s'"), pImage->pszFilename);
843 goto out;
844 }
845
846 /* Setup image parameters by header. */
847 vdiSetupImageDesc(pImage);
848
849 /* Allocate memory for blocks array. */
850 pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
851 if (!pImage->paBlocks)
852 {
853 rc = VERR_NO_MEMORY;
854 goto out;
855 }
856
857 /* Read blocks array. */
858 rc = vdiFileReadSync(pImage, pImage->offStartBlocks, pImage->paBlocks,
859 getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER),
860 NULL);
861
862out:
863 if (RT_FAILURE(rc))
864 vdiFreeImage(pImage, false);
865 return rc;
866}
867
868/**
869 * Internal: Save header to file.
870 */
871static int vdiUpdateHeader(PVDIIMAGEDESC pImage)
872{
873 int rc;
874 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
875 {
876 case 0:
877 rc = vdiFileWriteSync(pImage, sizeof(VDIPREHEADER),
878 &pImage->Header.u.v0, sizeof(pImage->Header.u.v0),
879 NULL);
880 break;
881 case 1:
882 if (pImage->Header.u.v1plus.cbHeader < sizeof(pImage->Header.u.v1plus))
883 rc = vdiFileWriteSync(pImage, sizeof(VDIPREHEADER),
884 &pImage->Header.u.v1, sizeof(pImage->Header.u.v1),
885 NULL);
886 else
887 rc = vdiFileWriteSync(pImage, sizeof(VDIPREHEADER),
888 &pImage->Header.u.v1plus, sizeof(pImage->Header.u.v1plus),
889 NULL);
890 break;
891 default:
892 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
893 break;
894 }
895 AssertMsgRC(rc, ("vdiUpdateHeader failed, filename=\"%s\" rc=%Rrc\n", pImage->pszFilename, rc));
896 return rc;
897}
898
899/**
900 * Internal: Save header to file - async version.
901 */
902static int vdiUpdateHeaderAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx)
903{
904 int rc;
905 switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
906 {
907 case 0:
908 rc = vdiFileWriteMetaAsync(pImage, sizeof(VDIPREHEADER),
909 &pImage->Header.u.v0,
910 sizeof(pImage->Header.u.v0),
911 pIoCtx, NULL, NULL);
912 break;
913 case 1:
914 if (pImage->Header.u.v1plus.cbHeader < sizeof(pImage->Header.u.v1plus))
915 rc = vdiFileWriteMetaAsync(pImage, sizeof(VDIPREHEADER),
916 &pImage->Header.u.v1,
917 sizeof(pImage->Header.u.v1),
918 pIoCtx, NULL, NULL);
919 else
920 rc = vdiFileWriteMetaAsync(pImage, sizeof(VDIPREHEADER),
921 &pImage->Header.u.v1plus,
922 sizeof(pImage->Header.u.v1plus),
923 pIoCtx, NULL, NULL);
924 break;
925 default:
926 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
927 break;
928 }
929 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
930 ("vdiUpdateHeader failed, filename=\"%s\" rc=%Rrc\n", pImage->pszFilename, rc));
931 return rc;
932}
933
934/**
935 * Internal: Save block pointer to file, save header to file.
936 */
937static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock)
938{
939 /* Update image header. */
940 int rc = vdiUpdateHeader(pImage);
941 if (RT_SUCCESS(rc))
942 {
943 /* write only one block pointer. */
944 rc = vdiFileWriteSync(pImage, pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
945 &pImage->paBlocks[uBlock], sizeof(VDIIMAGEBLOCKPOINTER),
946 NULL);
947 AssertMsgRC(rc, ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Rrc\n",
948 uBlock, pImage->pszFilename, rc));
949 }
950 return rc;
951}
952
953/**
954 * Internal: Save block pointer to file, save header to file - async version.
955 */
956static int vdiUpdateBlockInfoAsync(PVDIIMAGEDESC pImage, unsigned uBlock,
957 PVDIOCTX pIoCtx)
958{
959 /* Update image header. */
960 int rc = vdiUpdateHeaderAsync(pImage, pIoCtx);
961 if (RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
962 {
963 /* write only one block pointer. */
964 rc = vdiFileWriteMetaAsync(pImage,
965 pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
966 &pImage->paBlocks[uBlock],
967 sizeof(VDIIMAGEBLOCKPOINTER),
968 pIoCtx, NULL, NULL);
969 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
970 ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Rrc\n",
971 uBlock, pImage->pszFilename, rc));
972 }
973 return rc;
974}
975
976/**
977 * Internal: Flush the image file to disk - async version.
978 */
979static int vdiFlushImageAsync(PVDIIMAGEDESC pImage, PVDIOCTX pIoCtx)
980{
981 int rc = VINF_SUCCESS;
982
983 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
984 {
985 /* Save header. */
986 rc = vdiUpdateHeaderAsync(pImage, pIoCtx);
987 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
988 ("vdiUpdateHeaderAsync() failed, filename=\"%s\", rc=%Rrc\n",
989 pImage->pszFilename, rc));
990 rc = vdiFileFlushAsync(pImage, pIoCtx, NULL, NULL);
991 AssertMsg(RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS,
992 ("Flushing data to disk failed rc=%Rrc\n", rc));
993 }
994
995 return rc;
996}
997
998
999/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
1000static int vdiCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
1001 PVDINTERFACE pVDIfsImage)
1002{
1003 LogFlowFunc(("pszFilename=\"%s\"\n", pszFilename));
1004 int rc = VINF_SUCCESS;
1005 PVDIIMAGEDESC pImage;
1006
1007 if ( !VALID_PTR(pszFilename)
1008 || !*pszFilename)
1009 {
1010 rc = VERR_INVALID_PARAMETER;
1011 goto out;
1012 }
1013
1014 pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
1015 if (!pImage)
1016 {
1017 rc = VERR_NO_MEMORY;
1018 goto out;
1019 }
1020 pImage->pszFilename = pszFilename;
1021 pImage->pStorage = NULL;
1022 pImage->paBlocks = NULL;
1023 pImage->pVDIfsDisk = pVDIfsDisk;
1024 pImage->pVDIfsImage = pVDIfsImage;
1025
1026 rc = vdiOpenImage(pImage, VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_READONLY);
1027 vdiFreeImage(pImage, false);
1028 RTMemFree(pImage);
1029
1030out:
1031 LogFlowFunc(("returns %Rrc\n", rc));
1032 return rc;
1033}
1034
1035/** @copydoc VBOXHDDBACKEND::pfnOpen */
1036static int vdiOpen(const char *pszFilename, unsigned uOpenFlags,
1037 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1038 void **ppBackendData)
1039{
1040 LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, ppBackendData));
1041 int rc;
1042 PVDIIMAGEDESC pImage;
1043
1044 /* Check open flags. All valid flags are supported. */
1045 if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
1046 {
1047 rc = VERR_INVALID_PARAMETER;
1048 goto out;
1049 }
1050
1051 /* Check remaining arguments. */
1052 if ( !VALID_PTR(pszFilename)
1053 || !*pszFilename)
1054 {
1055 rc = VERR_INVALID_PARAMETER;
1056 goto out;
1057 }
1058
1059 pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
1060 if (!pImage)
1061 {
1062 rc = VERR_NO_MEMORY;
1063 goto out;
1064 }
1065 pImage->pszFilename = pszFilename;
1066 pImage->pStorage = NULL;
1067 pImage->paBlocks = NULL;
1068 pImage->pVDIfsDisk = pVDIfsDisk;
1069 pImage->pVDIfsImage = pVDIfsImage;
1070
1071 rc = vdiOpenImage(pImage, uOpenFlags);
1072 if (RT_SUCCESS(rc))
1073 *ppBackendData = pImage;
1074
1075out:
1076 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1077 return rc;
1078}
1079
1080/** @copydoc VBOXHDDBACKEND::pfnCreate */
1081static int vdiCreate(const char *pszFilename, uint64_t cbSize,
1082 unsigned uImageFlags, const char *pszComment,
1083 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
1084 PCRTUUID pUuid, unsigned uOpenFlags,
1085 unsigned uPercentStart, unsigned uPercentSpan,
1086 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1087 PVDINTERFACE pVDIfsOperation, void **ppBackendData)
1088{
1089 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));
1090 int rc;
1091 PVDIIMAGEDESC pImage;
1092
1093 PFNVDPROGRESS pfnProgress = NULL;
1094 void *pvUser = NULL;
1095 PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
1096 VDINTERFACETYPE_PROGRESS);
1097 PVDINTERFACEPROGRESS pCbProgress = NULL;
1098 if (pIfProgress)
1099 {
1100 pCbProgress = VDGetInterfaceProgress(pIfProgress);
1101 if (pCbProgress)
1102 pfnProgress = pCbProgress->pfnProgress;
1103 pvUser = pIfProgress->pvUser;
1104 }
1105
1106 /* Check open flags. All valid flags are supported. */
1107 if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
1108 {
1109 rc = VERR_INVALID_PARAMETER;
1110 goto out;
1111 }
1112
1113 /* Check size. Maximum 4PB-3M. No tricks with adjusting the 1M block size
1114 * so far, which would extend the size. */
1115 cbSize = RT_ALIGN_64(cbSize, _1M);
1116 if ( !cbSize
1117 || cbSize >= _1P * 2 - _1M * 3)
1118 {
1119 rc = VERR_VD_INVALID_SIZE;
1120 goto out;
1121 }
1122
1123 /* Check remaining arguments. */
1124 if ( !VALID_PTR(pszFilename)
1125 || !*pszFilename
1126 || cbSize < VDI_IMAGE_DEFAULT_BLOCK_SIZE
1127 || !VALID_PTR(pPCHSGeometry)
1128 || !VALID_PTR(pLCHSGeometry))
1129 {
1130 rc = VERR_INVALID_PARAMETER;
1131 goto out;
1132 }
1133
1134 pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
1135 if (!pImage)
1136 {
1137 rc = VERR_NO_MEMORY;
1138 goto out;
1139 }
1140 pImage->pszFilename = pszFilename;
1141 pImage->pStorage = NULL;
1142 pImage->paBlocks = NULL;
1143 pImage->pVDIfsDisk = pVDIfsDisk;
1144 pImage->pVDIfsImage = pVDIfsImage;
1145
1146 rc = vdiCreateImage(pImage, cbSize, uImageFlags, pszComment,
1147 pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags,
1148 pfnProgress, pvUser, uPercentStart, uPercentSpan);
1149 if (RT_SUCCESS(rc))
1150 {
1151 /* So far the image is opened in read/write mode. Make sure the
1152 * image is opened in read-only mode if the caller requested that. */
1153 if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
1154 {
1155 vdiFreeImage(pImage, false);
1156 rc = vdiOpenImage(pImage, uOpenFlags);
1157 if (RT_FAILURE(rc))
1158 {
1159 RTMemFree(pImage);
1160 goto out;
1161 }
1162 }
1163 *ppBackendData = pImage;
1164 }
1165 else
1166 RTMemFree(pImage);
1167
1168out:
1169 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1170 return rc;
1171}
1172
1173/** @copydoc VBOXHDDBACKEND::pfnRename */
1174static int vdiRename(void *pBackendData, const char *pszFilename)
1175{
1176 LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
1177
1178 int rc = VINF_SUCCESS;
1179 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1180
1181 /* Check arguments. */
1182 if ( !pImage
1183 || !pszFilename
1184 || !*pszFilename)
1185 {
1186 rc = VERR_INVALID_PARAMETER;
1187 goto out;
1188 }
1189
1190 /* Close the image. */
1191 vdiFreeImage(pImage, false);
1192
1193 /* Rename the file. */
1194 rc = vdiFileMove(pImage, pImage->pszFilename, pszFilename, 0);
1195 if (RT_FAILURE(rc))
1196 {
1197 /* The move failed, try to reopen the original image. */
1198 int rc2 = vdiOpenImage(pImage, pImage->uOpenFlags);
1199 if (RT_FAILURE(rc2))
1200 rc = rc2;
1201
1202 goto out;
1203 }
1204
1205 /* Update pImage with the new information. */
1206 pImage->pszFilename = pszFilename;
1207
1208 /* Open the new image. */
1209 rc = vdiOpenImage(pImage, pImage->uOpenFlags);
1210 if (RT_FAILURE(rc))
1211 goto out;
1212
1213out:
1214 LogFlowFunc(("returns %Rrc\n", rc));
1215 return rc;
1216}
1217
1218/** @copydoc VBOXHDDBACKEND::pfnClose */
1219static int vdiClose(void *pBackendData, bool fDelete)
1220{
1221 LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
1222 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1223 int rc;
1224
1225 rc = vdiFreeImage(pImage, fDelete);
1226 RTMemFree(pImage);
1227
1228 LogFlowFunc(("returns %Rrc\n", rc));
1229 return rc;
1230}
1231
1232/** @copydoc VBOXHDDBACKEND::pfnRead */
1233static int vdiRead(void *pBackendData, uint64_t uOffset, void *pvBuf,
1234 size_t cbToRead, size_t *pcbActuallyRead)
1235{
1236 LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToRead=%zu pcbActuallyRead=%#p\n", pBackendData, uOffset, pvBuf, cbToRead, pcbActuallyRead));
1237 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1238 unsigned uBlock;
1239 unsigned offRead;
1240 int rc;
1241
1242 AssertPtr(pImage);
1243 Assert(!(uOffset % 512));
1244 Assert(!(cbToRead % 512));
1245
1246 if ( uOffset + cbToRead > getImageDiskSize(&pImage->Header)
1247 || !VALID_PTR(pvBuf)
1248 || !cbToRead)
1249 {
1250 rc = VERR_INVALID_PARAMETER;
1251 goto out;
1252 }
1253
1254 /* Calculate starting block number and offset inside it. */
1255 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1256 offRead = (unsigned)uOffset & pImage->uBlockMask;
1257
1258 /* Clip read range to at most the rest of the block. */
1259 cbToRead = RT_MIN(cbToRead, getImageBlockSize(&pImage->Header) - offRead);
1260 Assert(!(cbToRead % 512));
1261
1262 if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
1263 rc = VERR_VD_BLOCK_FREE;
1264 else if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
1265 {
1266 memset(pvBuf, 0, cbToRead);
1267 rc = VINF_SUCCESS;
1268 }
1269 else
1270 {
1271 /* Block present in image file, read relevant data. */
1272 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1273 + (pImage->offStartData + pImage->offStartBlockData + offRead);
1274 rc = vdiFileReadSync(pImage, u64Offset, pvBuf, cbToRead, NULL);
1275 }
1276
1277 if (pcbActuallyRead)
1278 *pcbActuallyRead = cbToRead;
1279
1280out:
1281 LogFlowFunc(("returns %Rrc\n", rc));
1282 return rc;
1283}
1284
1285/**@copydoc VBOXHDDBACKEND::pfnWrite */
1286static int vdiWrite(void *pBackendData, uint64_t uOffset, const void *pvBuf,
1287 size_t cbToWrite, size_t *pcbWriteProcess,
1288 size_t *pcbPreRead, size_t *pcbPostRead, unsigned fWrite)
1289{
1290 LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n", pBackendData, uOffset, pvBuf, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
1291 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1292 unsigned uBlock;
1293 unsigned offWrite;
1294 int rc = VINF_SUCCESS;
1295
1296 AssertPtr(pImage);
1297 Assert(!(uOffset % 512));
1298 Assert(!(cbToWrite % 512));
1299
1300 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1301 {
1302 rc = VERR_VD_IMAGE_READ_ONLY;
1303 goto out;
1304 }
1305
1306 if (!VALID_PTR(pvBuf) || !cbToWrite)
1307 {
1308 rc = VERR_INVALID_PARAMETER;
1309 goto out;
1310 }
1311
1312 /* No size check here, will do that later. For dynamic images which are
1313 * not multiples of the block size in length, this would prevent writing to
1314 * the last block. */
1315
1316 /* Calculate starting block number and offset inside it. */
1317 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1318 offWrite = (unsigned)uOffset & pImage->uBlockMask;
1319
1320 /* Clip write range to at most the rest of the block. */
1321 cbToWrite = RT_MIN(cbToWrite, getImageBlockSize(&pImage->Header) - offWrite);
1322 Assert(!(cbToWrite % 512));
1323
1324 do
1325 {
1326 if (!IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
1327 {
1328 /* Block is either free or zero. */
1329 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_ZEROES)
1330 && ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
1331 || cbToWrite == getImageBlockSize(&pImage->Header)))
1332 {
1333 /* If the destination block is unallocated at this point, it's
1334 * either a zero block or a block which hasn't been used so far
1335 * (which also means that it's a zero block. Don't need to write
1336 * anything to this block if the data consists of just zeroes. */
1337 Assert(!(cbToWrite % 4));
1338 Assert(cbToWrite * 8 <= UINT32_MAX);
1339 if (ASMBitFirstSet((volatile void *)pvBuf, (uint32_t)cbToWrite * 8) == -1)
1340 {
1341 pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1342 break;
1343 }
1344 }
1345
1346 if (cbToWrite == getImageBlockSize(&pImage->Header))
1347 {
1348 /* Full block write to previously unallocated block.
1349 * Allocate block and write data. */
1350 Assert(!offWrite);
1351 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
1352 uint64_t u64Offset = (uint64_t)cBlocksAllocated * pImage->cbTotalBlockData
1353 + (pImage->offStartData + pImage->offStartBlockData);
1354 rc = vdiFileWriteSync(pImage, u64Offset, pvBuf, cbToWrite, NULL);
1355 if (RT_FAILURE(rc))
1356 goto out;
1357 pImage->paBlocks[uBlock] = cBlocksAllocated;
1358 setImageBlocksAllocated(&pImage->Header, cBlocksAllocated + 1);
1359
1360 rc = vdiUpdateBlockInfo(pImage, uBlock);
1361 if (RT_FAILURE(rc))
1362 goto out;
1363
1364 *pcbPreRead = 0;
1365 *pcbPostRead = 0;
1366 }
1367 else
1368 {
1369 /* Trying to do a partial write to an unallocated block. Don't do
1370 * anything except letting the upper layer know what to do. */
1371 *pcbPreRead = offWrite % getImageBlockSize(&pImage->Header);
1372 *pcbPostRead = getImageBlockSize(&pImage->Header) - cbToWrite - *pcbPreRead;
1373 rc = VERR_VD_BLOCK_FREE;
1374 }
1375 }
1376 else
1377 {
1378 /* Block present in image file, write relevant data. */
1379 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1380 + (pImage->offStartData + pImage->offStartBlockData + offWrite);
1381 rc = vdiFileWriteSync(pImage, u64Offset, pvBuf, cbToWrite, NULL);
1382 }
1383 } while (0);
1384
1385 if (pcbWriteProcess)
1386 *pcbWriteProcess = cbToWrite;
1387
1388out:
1389 LogFlowFunc(("returns %Rrc\n", rc));
1390 return rc;
1391}
1392
1393/** @copydoc VBOXHDDBACKEND::pfnFlush */
1394static int vdiFlush(void *pBackendData)
1395{
1396 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1397 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1398 int rc = VINF_SUCCESS;
1399
1400 Assert(pImage);
1401
1402 vdiFlushImage(pImage);
1403 LogFlowFunc(("returns %Rrc\n", rc));
1404 return rc;
1405}
1406
1407/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
1408static unsigned vdiGetVersion(void *pBackendData)
1409{
1410 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1411 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1412 unsigned uVersion;
1413
1414 AssertPtr(pImage);
1415
1416 if (pImage)
1417 uVersion = pImage->PreHeader.u32Version;
1418 else
1419 uVersion = 0;
1420
1421 LogFlowFunc(("returns %#x\n", uVersion));
1422 return uVersion;
1423}
1424
1425/** @copydoc VBOXHDDBACKEND::pfnGetSize */
1426static uint64_t vdiGetSize(void *pBackendData)
1427{
1428 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1429 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1430 uint64_t cbSize;
1431
1432 AssertPtr(pImage);
1433
1434 if (pImage)
1435 cbSize = getImageDiskSize(&pImage->Header);
1436 else
1437 cbSize = 0;
1438
1439 LogFlowFunc(("returns %llu\n", cbSize));
1440 return cbSize;
1441}
1442
1443/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
1444static uint64_t vdiGetFileSize(void *pBackendData)
1445{
1446 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1447 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1448 uint64_t cb = 0;
1449
1450 AssertPtr(pImage);
1451
1452 if (pImage)
1453 {
1454 uint64_t cbFile;
1455 if (pImage->pStorage)
1456 {
1457 int rc = vdiFileGetSize(pImage, &cbFile);
1458 if (RT_SUCCESS(rc))
1459 cb += cbFile;
1460 }
1461 }
1462
1463 LogFlowFunc(("returns %lld\n", cb));
1464 return cb;
1465}
1466
1467/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
1468static int vdiGetPCHSGeometry(void *pBackendData, PVDGEOMETRY pPCHSGeometry)
1469{
1470 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
1471 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1472 int rc;
1473
1474 AssertPtr(pImage);
1475
1476 if (pImage)
1477 {
1478 if (pImage->PCHSGeometry.cCylinders)
1479 {
1480 *pPCHSGeometry = pImage->PCHSGeometry;
1481 rc = VINF_SUCCESS;
1482 }
1483 else
1484 rc = VERR_VD_GEOMETRY_NOT_SET;
1485 }
1486 else
1487 rc = VERR_VD_NOT_OPENED;
1488
1489 LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1490 return rc;
1491}
1492
1493/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
1494static int vdiSetPCHSGeometry(void *pBackendData, PCVDGEOMETRY pPCHSGeometry)
1495{
1496 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1497 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1498 int rc;
1499
1500 AssertPtr(pImage);
1501
1502 if (pImage)
1503 {
1504 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1505 {
1506 rc = VERR_VD_IMAGE_READ_ONLY;
1507 goto out;
1508 }
1509
1510 pImage->PCHSGeometry = *pPCHSGeometry;
1511 rc = VINF_SUCCESS;
1512 }
1513 else
1514 rc = VERR_VD_NOT_OPENED;
1515
1516out:
1517 LogFlowFunc(("returns %Rrc\n", rc));
1518 return rc;
1519}
1520
1521/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
1522static int vdiGetLCHSGeometry(void *pBackendData, PVDGEOMETRY pLCHSGeometry)
1523{
1524 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
1525 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1526 int rc;
1527
1528 AssertPtr(pImage);
1529
1530 if (pImage)
1531 {
1532 VDIDISKGEOMETRY DummyGeo = { 0, 0, 0, VDI_GEOMETRY_SECTOR_SIZE };
1533 PVDIDISKGEOMETRY pGeometry = getImageLCHSGeometry(&pImage->Header);
1534 if (!pGeometry)
1535 pGeometry = &DummyGeo;
1536
1537 if ( pGeometry->cCylinders > 0
1538 && pGeometry->cHeads > 0
1539 && pGeometry->cSectors > 0)
1540 {
1541 pLCHSGeometry->cCylinders = pGeometry->cCylinders;
1542 pLCHSGeometry->cHeads = pGeometry->cHeads;
1543 pLCHSGeometry->cSectors = pGeometry->cSectors;
1544 rc = VINF_SUCCESS;
1545 }
1546 else
1547 rc = VERR_VD_GEOMETRY_NOT_SET;
1548 }
1549 else
1550 rc = VERR_VD_NOT_OPENED;
1551
1552 LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1553 return rc;
1554}
1555
1556/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
1557static int vdiSetLCHSGeometry(void *pBackendData, PCVDGEOMETRY pLCHSGeometry)
1558{
1559 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1560 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1561 PVDIDISKGEOMETRY pGeometry;
1562 int rc;
1563
1564 AssertPtr(pImage);
1565
1566 if (pImage)
1567 {
1568 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1569 {
1570 rc = VERR_VD_IMAGE_READ_ONLY;
1571 goto out;
1572 }
1573
1574 pGeometry = getImageLCHSGeometry(&pImage->Header);
1575 if (pGeometry)
1576 {
1577 pGeometry->cCylinders = pLCHSGeometry->cCylinders;
1578 pGeometry->cHeads = pLCHSGeometry->cHeads;
1579 pGeometry->cSectors = pLCHSGeometry->cSectors;
1580 pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
1581
1582 /* Update header information in base image file. */
1583 vdiFlushImage(pImage);
1584 }
1585 rc = VINF_SUCCESS;
1586 }
1587 else
1588 rc = VERR_VD_NOT_OPENED;
1589
1590out:
1591 LogFlowFunc(("returns %Rrc\n", rc));
1592 return rc;
1593}
1594
1595/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
1596static unsigned vdiGetImageFlags(void *pBackendData)
1597{
1598 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1599 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1600 unsigned uImageFlags;
1601
1602 AssertPtr(pImage);
1603
1604 if (pImage)
1605 uImageFlags = pImage->uImageFlags;
1606 else
1607 uImageFlags = 0;
1608
1609 LogFlowFunc(("returns %#x\n", uImageFlags));
1610 return uImageFlags;
1611}
1612
1613/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
1614static unsigned vdiGetOpenFlags(void *pBackendData)
1615{
1616 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1617 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1618 unsigned uOpenFlags;
1619
1620 AssertPtr(pImage);
1621
1622 if (pImage)
1623 uOpenFlags = pImage->uOpenFlags;
1624 else
1625 uOpenFlags = 0;
1626
1627 LogFlowFunc(("returns %#x\n", uOpenFlags));
1628 return uOpenFlags;
1629}
1630
1631/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
1632static int vdiSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
1633{
1634 LogFlowFunc(("pBackendData=%#p uOpenFlags=%#x\n", pBackendData, uOpenFlags));
1635 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1636 int rc;
1637 const char *pszFilename;
1638
1639 /* Image must be opened and the new flags must be valid. */
1640 if (!pImage || (uOpenFlags & ~(VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_ASYNC_IO | VD_OPEN_FLAGS_SHAREABLE | VD_OPEN_FLAGS_SEQUENTIAL)))
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 /* Make this foolproof even if the image doesn't have the zero
1672 * termination. With some luck the repaired header will be saved. */
1673 size_t cb = RTStrNLen(pszTmp, VDI_IMAGE_COMMENT_SIZE);
1674 if (cb == VDI_IMAGE_COMMENT_SIZE)
1675 {
1676 pszTmp[VDI_IMAGE_COMMENT_SIZE-1] = '\0';
1677 cb--;
1678 }
1679 if (cb < cbComment)
1680 {
1681 /* memcpy is much better than strncpy. */
1682 memcpy(pszComment, pszTmp, cb + 1);
1683 }
1684 else
1685 rc = VERR_BUFFER_OVERFLOW;
1686 }
1687 else
1688 rc = VERR_VD_NOT_OPENED;
1689
1690 LogFlowFunc(("returns %Rrc comment=\"%s\"\n", rc, pszComment));
1691 return rc;
1692}
1693
1694/** @copydoc VBOXHDDBACKEND::pfnGetComment */
1695static int vdiSetComment(void *pBackendData, const char *pszComment)
1696{
1697 LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
1698 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1699 int rc;
1700
1701 AssertPtr(pImage);
1702
1703 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1704 {
1705 rc = VERR_VD_IMAGE_READ_ONLY;
1706 goto out;
1707 }
1708
1709 if (pImage)
1710 {
1711 size_t cchComment = pszComment ? strlen(pszComment) : 0;
1712 if (cchComment >= VDI_IMAGE_COMMENT_SIZE)
1713 {
1714 LogFunc(("pszComment is too long, %d bytes!\n", cchComment));
1715 rc = VERR_VD_VDI_COMMENT_TOO_LONG;
1716 goto out;
1717 }
1718
1719 /* we don't support old style images */
1720 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1721 {
1722 /*
1723 * Update the comment field, making sure to zero out all of the previous comment.
1724 */
1725 memset(pImage->Header.u.v1.szComment, '\0', VDI_IMAGE_COMMENT_SIZE);
1726 memcpy(pImage->Header.u.v1.szComment, pszComment, cchComment);
1727
1728 /* write out new the header */
1729 rc = vdiUpdateHeader(pImage);
1730 }
1731 else
1732 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1733 }
1734 else
1735 rc = VERR_VD_NOT_OPENED;
1736
1737out:
1738 LogFlowFunc(("returns %Rrc\n", rc));
1739 return rc;
1740}
1741
1742/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
1743static int vdiGetUuid(void *pBackendData, PRTUUID pUuid)
1744{
1745 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1746 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1747 int rc;
1748
1749 AssertPtr(pImage);
1750
1751 if (pImage)
1752 {
1753 *pUuid = *getImageCreationUUID(&pImage->Header);
1754 rc = VINF_SUCCESS;
1755 }
1756 else
1757 rc = VERR_VD_NOT_OPENED;
1758
1759 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1760 return rc;
1761}
1762
1763/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
1764static int vdiSetUuid(void *pBackendData, PCRTUUID pUuid)
1765{
1766 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1767 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1768 int rc = VINF_SUCCESS;
1769
1770 AssertPtr(pImage);
1771
1772 if (pImage)
1773 {
1774 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1775 {
1776 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1777 pImage->Header.u.v1.uuidCreate = *pUuid;
1778 /* Make it possible to clone old VDIs. */
1779 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1780 pImage->Header.u.v0.uuidCreate = *pUuid;
1781 else
1782 {
1783 LogFunc(("Version is not supported!\n"));
1784 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1785 }
1786 }
1787 else
1788 rc = VERR_VD_IMAGE_READ_ONLY;
1789 }
1790 else
1791 rc = VERR_VD_NOT_OPENED;
1792
1793 LogFlowFunc(("returns %Rrc\n", rc));
1794 return rc;
1795}
1796
1797/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
1798static int vdiGetModificationUuid(void *pBackendData, PRTUUID pUuid)
1799{
1800 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1801 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1802 int rc;
1803
1804 AssertPtr(pImage);
1805
1806 if (pImage)
1807 {
1808 *pUuid = *getImageModificationUUID(&pImage->Header);
1809 rc = VINF_SUCCESS;
1810 }
1811 else
1812 rc = VERR_VD_NOT_OPENED;
1813
1814 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1815 return rc;
1816}
1817
1818/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
1819static int vdiSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
1820{
1821 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1822 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1823 int rc = VINF_SUCCESS;
1824
1825 AssertPtr(pImage);
1826
1827 if (pImage)
1828 {
1829 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1830 {
1831 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1832 pImage->Header.u.v1.uuidModify = *pUuid;
1833 /* Make it possible to clone old VDIs. */
1834 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1835 pImage->Header.u.v0.uuidModify = *pUuid;
1836 else
1837 {
1838 LogFunc(("Version is not supported!\n"));
1839 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1840 }
1841 }
1842 else
1843 rc = VERR_VD_IMAGE_READ_ONLY;
1844 }
1845 else
1846 rc = VERR_VD_NOT_OPENED;
1847
1848 LogFlowFunc(("returns %Rrc\n", rc));
1849 return rc;
1850}
1851
1852/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
1853static int vdiGetParentUuid(void *pBackendData, PRTUUID pUuid)
1854{
1855 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1856 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1857 int rc;
1858
1859 AssertPtr(pImage);
1860
1861 if (pImage)
1862 {
1863 *pUuid = *getImageParentUUID(&pImage->Header);
1864 rc = VINF_SUCCESS;
1865 }
1866 else
1867 rc = VERR_VD_NOT_OPENED;
1868
1869 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1870 return rc;
1871}
1872
1873/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
1874static int vdiSetParentUuid(void *pBackendData, PCRTUUID pUuid)
1875{
1876 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1877 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1878 int rc = VINF_SUCCESS;
1879
1880 AssertPtr(pImage);
1881
1882 if (pImage)
1883 {
1884 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1885 {
1886 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1887 pImage->Header.u.v1.uuidLinkage = *pUuid;
1888 /* Make it possible to clone old VDIs. */
1889 else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1890 pImage->Header.u.v0.uuidLinkage = *pUuid;
1891 else
1892 {
1893 LogFunc(("Version is not supported!\n"));
1894 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1895 }
1896 }
1897 else
1898 rc = VERR_VD_IMAGE_READ_ONLY;
1899 }
1900 else
1901 rc = VERR_VD_NOT_OPENED;
1902
1903 LogFlowFunc(("returns %Rrc\n", rc));
1904 return rc;
1905}
1906
1907/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
1908static int vdiGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
1909{
1910 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1911 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1912 int rc;
1913
1914 AssertPtr(pImage);
1915
1916 if (pImage)
1917 {
1918 *pUuid = *getImageParentModificationUUID(&pImage->Header);
1919 rc = VINF_SUCCESS;
1920 }
1921 else
1922 rc = VERR_VD_NOT_OPENED;
1923
1924 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1925 return rc;
1926}
1927
1928/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
1929static int vdiSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
1930{
1931 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1932 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1933 int rc = VINF_SUCCESS;
1934
1935 AssertPtr(pImage);
1936
1937 if (pImage)
1938 {
1939 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1940 {
1941 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1942 pImage->Header.u.v1.uuidParentModify = *pUuid;
1943 else
1944 {
1945 LogFunc(("Version is not supported!\n"));
1946 rc = VERR_VD_VDI_UNSUPPORTED_VERSION;
1947 }
1948 }
1949 else
1950 rc = VERR_VD_IMAGE_READ_ONLY;
1951 }
1952 else
1953 rc = VERR_VD_NOT_OPENED;
1954
1955 LogFlowFunc(("returns %Rrc\n", rc));
1956 return rc;
1957}
1958
1959/** @copydoc VBOXHDDBACKEND::pfnDump */
1960static void vdiDump(void *pBackendData)
1961{
1962 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1963
1964 vdiMessage(pImage, "Dumping VDI image \"%s\" mode=%s uOpenFlags=%X File=%#p\n",
1965 pImage->pszFilename,
1966 (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY) ? "r/o" : "r/w",
1967 pImage->uOpenFlags,
1968 pImage->pStorage);
1969 vdiMessage(pImage, "Header: Version=%08X Type=%X Flags=%X Size=%llu\n",
1970 pImage->PreHeader.u32Version,
1971 getImageType(&pImage->Header),
1972 getImageFlags(&pImage->Header),
1973 getImageDiskSize(&pImage->Header));
1974 vdiMessage(pImage, "Header: cbBlock=%u cbBlockExtra=%u cBlocks=%u cBlocksAllocated=%u\n",
1975 getImageBlockSize(&pImage->Header),
1976 getImageExtraBlockSize(&pImage->Header),
1977 getImageBlocks(&pImage->Header),
1978 getImageBlocksAllocated(&pImage->Header));
1979 vdiMessage(pImage, "Header: offBlocks=%u offData=%u\n",
1980 getImageBlocksOffset(&pImage->Header),
1981 getImageDataOffset(&pImage->Header));
1982 PVDIDISKGEOMETRY pg = getImageLCHSGeometry(&pImage->Header);
1983 if (pg)
1984 vdiMessage(pImage, "Header: Geometry: C/H/S=%u/%u/%u cbSector=%u\n",
1985 pg->cCylinders, pg->cHeads, pg->cSectors, pg->cbSector);
1986 vdiMessage(pImage, "Header: uuidCreation={%RTuuid}\n", getImageCreationUUID(&pImage->Header));
1987 vdiMessage(pImage, "Header: uuidModification={%RTuuid}\n", getImageModificationUUID(&pImage->Header));
1988 vdiMessage(pImage, "Header: uuidParent={%RTuuid}\n", getImageParentUUID(&pImage->Header));
1989 if (GET_MAJOR_HEADER_VERSION(&pImage->Header) >= 1)
1990 vdiMessage(pImage, "Header: uuidParentModification={%RTuuid}\n", getImageParentModificationUUID(&pImage->Header));
1991 vdiMessage(pImage, "Image: fFlags=%08X offStartBlocks=%u offStartData=%u\n",
1992 pImage->uImageFlags, pImage->offStartBlocks, pImage->offStartData);
1993 vdiMessage(pImage, "Image: uBlockMask=%08X cbTotalBlockData=%u uShiftOffset2Index=%u offStartBlockData=%u\n",
1994 pImage->uBlockMask,
1995 pImage->cbTotalBlockData,
1996 pImage->uShiftOffset2Index,
1997 pImage->offStartBlockData);
1998
1999 unsigned uBlock, cBlocksNotFree, cBadBlocks, cBlocks = getImageBlocks(&pImage->Header);
2000 for (uBlock=0, cBlocksNotFree=0, cBadBlocks=0; uBlock<cBlocks; uBlock++)
2001 {
2002 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
2003 {
2004 cBlocksNotFree++;
2005 if (pImage->paBlocks[uBlock] >= cBlocks)
2006 cBadBlocks++;
2007 }
2008 }
2009 if (cBlocksNotFree != getImageBlocksAllocated(&pImage->Header))
2010 {
2011 vdiMessage(pImage, "!! WARNING: %u blocks actually allocated (cBlocksAllocated=%u) !!\n",
2012 cBlocksNotFree, getImageBlocksAllocated(&pImage->Header));
2013 }
2014 if (cBadBlocks)
2015 {
2016 vdiMessage(pImage, "!! WARNING: %u bad blocks found !!\n",
2017 cBadBlocks);
2018 }
2019}
2020
2021static bool vdiIsAsyncIOSupported(void *pBackendData)
2022{
2023 return true;
2024}
2025
2026static int vdiAsyncRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
2027 PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
2028{
2029 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
2030 pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
2031 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2032 unsigned uBlock;
2033 unsigned offRead;
2034 int rc;
2035
2036 AssertPtr(pImage);
2037 Assert(!(uOffset % 512));
2038 Assert(!(cbToRead % 512));
2039
2040 if ( uOffset + cbToRead > getImageDiskSize(&pImage->Header)
2041 || !VALID_PTR(pIoCtx)
2042 || !cbToRead)
2043 {
2044 rc = VERR_INVALID_PARAMETER;
2045 goto out;
2046 }
2047
2048 /* Calculate starting block number and offset inside it. */
2049 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
2050 offRead = (unsigned)uOffset & pImage->uBlockMask;
2051
2052 /* Clip read range to at most the rest of the block. */
2053 cbToRead = RT_MIN(cbToRead, getImageBlockSize(&pImage->Header) - offRead);
2054 Assert(!(cbToRead % 512));
2055
2056 if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
2057 rc = VERR_VD_BLOCK_FREE;
2058 else if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
2059 {
2060 size_t cbSet;
2061
2062 cbSet = vdiFileIoCtxSet(pImage, pIoCtx, 0, cbToRead);
2063 Assert(cbSet == cbToRead);
2064
2065 rc = VINF_SUCCESS;
2066 }
2067 else
2068 {
2069 /* Block present in image file, read relevant data. */
2070 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
2071 + (pImage->offStartData + pImage->offStartBlockData + offRead);
2072 rc = vdiFileReadUserAsync(pImage, u64Offset, pIoCtx, cbToRead);
2073 }
2074
2075 if (pcbActuallyRead)
2076 *pcbActuallyRead = cbToRead;
2077
2078out:
2079 LogFlowFunc(("returns %Rrc\n", rc));
2080 return rc;
2081}
2082
2083static int vdiAsyncWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
2084 PVDIOCTX pIoCtx,
2085 size_t *pcbWriteProcess, size_t *pcbPreRead,
2086 size_t *pcbPostRead, unsigned fWrite)
2087{
2088 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
2089 pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
2090 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2091 unsigned uBlock;
2092 unsigned offWrite;
2093 int rc = VINF_SUCCESS;
2094
2095 AssertPtr(pImage);
2096 Assert(!(uOffset % 512));
2097 Assert(!(cbToWrite % 512));
2098
2099 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2100 {
2101 rc = VERR_VD_IMAGE_READ_ONLY;
2102 goto out;
2103 }
2104
2105 if (!VALID_PTR(pIoCtx) || !cbToWrite)
2106 {
2107 rc = VERR_INVALID_PARAMETER;
2108 goto out;
2109 }
2110
2111 /* No size check here, will do that later. For dynamic images which are
2112 * not multiples of the block size in length, this would prevent writing to
2113 * the last block. */
2114
2115 /* Calculate starting block number and offset inside it. */
2116 uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
2117 offWrite = (unsigned)uOffset & pImage->uBlockMask;
2118
2119 /* Clip write range to at most the rest of the block. */
2120 cbToWrite = RT_MIN(cbToWrite, getImageBlockSize(&pImage->Header) - offWrite);
2121 Assert(!(cbToWrite % 512));
2122
2123 do
2124 {
2125 if (!IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
2126 {
2127 /* Block is either free or zero. */
2128 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_ZEROES)
2129 && ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
2130 || cbToWrite == getImageBlockSize(&pImage->Header)))
2131 {
2132#if 0 /** @todo Provide interface to check an I/O context for a specific value */
2133 /* If the destination block is unallocated at this point, it's
2134 * either a zero block or a block which hasn't been used so far
2135 * (which also means that it's a zero block. Don't need to write
2136 * anything to this block if the data consists of just zeroes. */
2137 Assert(!(cbToWrite % 4));
2138 Assert(cbToWrite * 8 <= UINT32_MAX);
2139 if (ASMBitFirstSet((volatile void *)pvBuf, (uint32_t)cbToWrite * 8) == -1)
2140 {
2141 pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
2142 break;
2143 }
2144#endif
2145 }
2146
2147 if ( cbToWrite == getImageBlockSize(&pImage->Header)
2148 && !(fWrite & VD_WRITE_NO_ALLOC))
2149 {
2150 /* Full block write to previously unallocated block.
2151 * Allocate block and write data. */
2152 Assert(!offWrite);
2153 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
2154 uint64_t u64Offset = (uint64_t)cBlocksAllocated * pImage->cbTotalBlockData
2155 + (pImage->offStartData + pImage->offStartBlockData);
2156 rc = vdiFileWriteUserAsync(pImage, u64Offset, pIoCtx, cbToWrite, NULL, NULL);
2157 if (RT_UNLIKELY(RT_FAILURE_NP(rc) && (rc != VERR_VD_ASYNC_IO_IN_PROGRESS)))
2158 goto out;
2159 pImage->paBlocks[uBlock] = cBlocksAllocated;
2160 setImageBlocksAllocated(&pImage->Header, cBlocksAllocated + 1);
2161
2162 rc = vdiUpdateBlockInfoAsync(pImage, uBlock, pIoCtx);
2163 if (RT_FAILURE(rc) && (rc != VERR_VD_ASYNC_IO_IN_PROGRESS))
2164 goto out;
2165
2166 *pcbPreRead = 0;
2167 *pcbPostRead = 0;
2168 }
2169 else
2170 {
2171 /* Trying to do a partial write to an unallocated block. Don't do
2172 * anything except letting the upper layer know what to do. */
2173 *pcbPreRead = offWrite % getImageBlockSize(&pImage->Header);
2174 *pcbPostRead = getImageBlockSize(&pImage->Header) - cbToWrite - *pcbPreRead;
2175 rc = VERR_VD_BLOCK_FREE;
2176 }
2177 }
2178 else
2179 {
2180 /* Block present in image file, write relevant data. */
2181 uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
2182 + (pImage->offStartData + pImage->offStartBlockData + offWrite);
2183 rc = vdiFileWriteUserAsync(pImage, u64Offset, pIoCtx, cbToWrite, NULL, NULL);
2184 }
2185 } while (0);
2186
2187 if (pcbWriteProcess)
2188 *pcbWriteProcess = cbToWrite;
2189
2190out:
2191 LogFlowFunc(("returns %Rrc\n", rc));
2192 return rc;
2193}
2194
2195static int vdiAsyncFlush(void *pBackendData, PVDIOCTX pIoCtx)
2196{
2197 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2198 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2199 int rc = VINF_SUCCESS;
2200
2201 Assert(pImage);
2202
2203 rc = vdiFlushImageAsync(pImage, pIoCtx);
2204 LogFlowFunc(("returns %Rrc\n", rc));
2205 return rc;
2206}
2207
2208/** @copydoc VBOXHDDBACKEND::pfnCompact */
2209static int vdiCompact(void *pBackendData, unsigned uPercentStart,
2210 unsigned uPercentSpan, PVDINTERFACE pVDIfsDisk,
2211 PVDINTERFACE pVDIfsImage, PVDINTERFACE pVDIfsOperation)
2212{
2213 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2214 int rc = VINF_SUCCESS;
2215 void *pvBuf = NULL, *pvTmp = NULL;
2216 unsigned *paBlocks2 = NULL;
2217
2218 int (*pfnParentRead)(void *, uint64_t, void *, size_t) = NULL;
2219 void *pvParent = NULL;
2220 PVDINTERFACE pIfParentState = VDInterfaceGet(pVDIfsOperation,
2221 VDINTERFACETYPE_PARENTSTATE);
2222 PVDINTERFACEPARENTSTATE pCbParentState = NULL;
2223 if (pIfParentState)
2224 {
2225 pCbParentState = VDGetInterfaceParentState(pIfParentState);
2226 if (pCbParentState)
2227 pfnParentRead = pCbParentState->pfnParentRead;
2228 pvParent = pIfParentState->pvUser;
2229 }
2230
2231 PFNVDPROGRESS pfnProgress = NULL;
2232 void *pvUser = NULL;
2233 PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
2234 VDINTERFACETYPE_PROGRESS);
2235 PVDINTERFACEPROGRESS pCbProgress = NULL;
2236 if (pIfProgress)
2237 {
2238 pCbProgress = VDGetInterfaceProgress(pIfProgress);
2239 if (pCbProgress)
2240 pfnProgress = pCbProgress->pfnProgress;
2241 pvUser = pIfProgress->pvUser;
2242 }
2243
2244 do {
2245 AssertBreakStmt(pImage, rc = VERR_INVALID_PARAMETER);
2246
2247 AssertBreakStmt(!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY),
2248 rc = VERR_VD_IMAGE_READ_ONLY);
2249
2250 unsigned cBlocks;
2251 unsigned cBlocksToMove = 0;
2252 size_t cbBlock;
2253 cBlocks = getImageBlocks(&pImage->Header);
2254 cbBlock = getImageBlockSize(&pImage->Header);
2255 if (pfnParentRead)
2256 {
2257 pvBuf = RTMemTmpAlloc(cbBlock);
2258 AssertBreakStmt(VALID_PTR(pvBuf), rc = VERR_NO_MEMORY);
2259 }
2260 pvTmp = RTMemTmpAlloc(cbBlock);
2261 AssertBreakStmt(VALID_PTR(pvTmp), rc = VERR_NO_MEMORY);
2262
2263 uint64_t cbFile;
2264 rc = vdiFileGetSize(pImage, &cbFile);
2265 AssertRCBreak(rc);
2266 unsigned cBlocksAllocated = (unsigned)((cbFile - pImage->offStartData - pImage->offStartBlockData) >> pImage->uShiftOffset2Index);
2267 if (cBlocksAllocated == 0)
2268 {
2269 /* No data blocks in this image, no need to compact. */
2270 rc = VINF_SUCCESS;
2271 break;
2272 }
2273
2274 /* Allocate block array for back resolving. */
2275 paBlocks2 = (unsigned *)RTMemAlloc(sizeof(unsigned *) * cBlocksAllocated);
2276 AssertBreakStmt(VALID_PTR(paBlocks2), rc = VERR_NO_MEMORY);
2277 /* Fill out back resolving, check/fix allocation errors before
2278 * compacting the image, just to be on the safe side. Update the
2279 * image contents straight away, as this enables cancelling. */
2280 for (unsigned i = 0; i < cBlocksAllocated; i++)
2281 paBlocks2[i] = VDI_IMAGE_BLOCK_FREE;
2282 rc = VINF_SUCCESS;
2283 for (unsigned i = 0; i < cBlocks; i++)
2284 {
2285 VDIIMAGEBLOCKPOINTER ptrBlock = pImage->paBlocks[i];
2286 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock))
2287 {
2288 if (ptrBlock < cBlocksAllocated)
2289 {
2290 if (paBlocks2[ptrBlock] == VDI_IMAGE_BLOCK_FREE)
2291 paBlocks2[ptrBlock] = i;
2292 else
2293 {
2294 LogFunc(("Freed cross-linked block %u in file \"%s\"\n",
2295 i, pImage->pszFilename));
2296 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2297 rc = vdiUpdateBlockInfo(pImage, i);
2298 if (RT_FAILURE(rc))
2299 break;
2300 }
2301 }
2302 else
2303 {
2304 LogFunc(("Freed out of bounds reference for block %u in file \"%s\"\n",
2305 i, pImage->pszFilename));
2306 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2307 rc = vdiUpdateBlockInfo(pImage, i);
2308 if (RT_FAILURE(rc))
2309 break;
2310 }
2311 }
2312 }
2313 if (RT_FAILURE(rc))
2314 break;
2315
2316 /* Find redundant information and update the block pointers
2317 * accordingly, creating bubbles. Keep disk up to date, as this
2318 * enables cancelling. */
2319 for (unsigned i = 0; i < cBlocks; i++)
2320 {
2321 VDIIMAGEBLOCKPOINTER ptrBlock = pImage->paBlocks[i];
2322 if (IS_VDI_IMAGE_BLOCK_ALLOCATED(ptrBlock))
2323 {
2324 /* Block present in image file, read relevant data. */
2325 uint64_t u64Offset = (uint64_t)ptrBlock * pImage->cbTotalBlockData
2326 + (pImage->offStartData + pImage->offStartBlockData);
2327 rc = vdiFileReadSync(pImage, u64Offset, pvTmp, cbBlock, NULL);
2328 if (RT_FAILURE(rc))
2329 break;
2330
2331 if (ASMBitFirstSet((volatile void *)pvTmp, (uint32_t)cbBlock * 8) == -1)
2332 {
2333 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_ZERO;
2334 rc = vdiUpdateBlockInfo(pImage, i);
2335 if (RT_FAILURE(rc))
2336 break;
2337 paBlocks2[ptrBlock] = VDI_IMAGE_BLOCK_FREE;
2338 /* Adjust progress info, one block to be relocated. */
2339 cBlocksToMove++;
2340 }
2341 else if (pfnParentRead)
2342 {
2343 rc = pfnParentRead(pvParent, i * cbBlock, pvBuf, cbBlock);
2344 if (RT_FAILURE(rc))
2345 break;
2346 if (!memcmp(pvTmp, pvBuf, cbBlock))
2347 {
2348 pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
2349 rc = vdiUpdateBlockInfo(pImage, i);
2350 if (RT_FAILURE(rc))
2351 break;
2352 paBlocks2[ptrBlock] = VDI_IMAGE_BLOCK_FREE;
2353 /* Adjust progress info, one block to be relocated. */
2354 cBlocksToMove++;
2355 }
2356 }
2357 }
2358
2359 if (pCbProgress && pCbProgress->pfnProgress)
2360 {
2361 rc = pCbProgress->pfnProgress(pIfProgress->pvUser,
2362 (uint64_t)i * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2363 if (RT_FAILURE(rc))
2364 break;
2365 }
2366 }
2367 if (RT_FAILURE(rc))
2368 break;
2369
2370 /* Fill bubbles with other data (if available). */
2371 unsigned cBlocksMoved = 0;
2372 unsigned uBlockUsedPos = cBlocksAllocated;
2373 for (unsigned i = 0; i < cBlocksAllocated; i++)
2374 {
2375 unsigned uBlock = paBlocks2[i];
2376 if (uBlock == VDI_IMAGE_BLOCK_FREE)
2377 {
2378 unsigned uBlockData = VDI_IMAGE_BLOCK_FREE;
2379 while (uBlockUsedPos > i && uBlockData == VDI_IMAGE_BLOCK_FREE)
2380 {
2381 uBlockUsedPos--;
2382 uBlockData = paBlocks2[uBlockUsedPos];
2383 }
2384 /* Terminate early if there is no block which needs copying. */
2385 if (uBlockUsedPos == i)
2386 break;
2387 uint64_t u64Offset = (uint64_t)uBlockUsedPos * pImage->cbTotalBlockData
2388 + (pImage->offStartData + pImage->offStartBlockData);
2389 rc = vdiFileReadSync(pImage, u64Offset, pvTmp, cbBlock, NULL);
2390 u64Offset = (uint64_t)i * pImage->cbTotalBlockData
2391 + (pImage->offStartData + pImage->offStartBlockData);
2392 rc = vdiFileWriteSync(pImage, u64Offset, pvTmp, cbBlock, NULL);
2393 pImage->paBlocks[uBlockData] = i;
2394 setImageBlocksAllocated(&pImage->Header, cBlocksAllocated - cBlocksMoved);
2395 rc = vdiUpdateBlockInfo(pImage, uBlockData);
2396 if (RT_FAILURE(rc))
2397 break;
2398 paBlocks2[i] = uBlockData;
2399 paBlocks2[uBlockUsedPos] = VDI_IMAGE_BLOCK_FREE;
2400 cBlocksMoved++;
2401 }
2402
2403 if (pCbProgress && pCbProgress->pfnProgress)
2404 {
2405 rc = pCbProgress->pfnProgress(pIfProgress->pvUser,
2406 (uint64_t)(cBlocks + cBlocksMoved) * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2407
2408 if (RT_FAILURE(rc))
2409 break;
2410 }
2411 }
2412 if (RT_FAILURE(rc))
2413 break;
2414
2415 /* Update image header. */
2416 setImageBlocksAllocated(&pImage->Header, uBlockUsedPos);
2417 vdiUpdateHeader(pImage);
2418
2419 /* Truncate the image to the proper size to finish compacting. */
2420 rc = vdiFileSetSize(pImage,
2421 (uint64_t)uBlockUsedPos * pImage->cbTotalBlockData
2422 + pImage->offStartData + pImage->offStartBlockData);
2423 } while (0);
2424
2425 if (paBlocks2)
2426 RTMemTmpFree(paBlocks2);
2427 if (pvTmp)
2428 RTMemTmpFree(pvTmp);
2429 if (pvBuf)
2430 RTMemTmpFree(pvBuf);
2431
2432 if (RT_SUCCESS(rc) && pCbProgress && pCbProgress->pfnProgress)
2433 {
2434 pCbProgress->pfnProgress(pIfProgress->pvUser,
2435 uPercentStart + uPercentSpan);
2436 }
2437
2438 LogFlowFunc(("returns %Rrc\n", rc));
2439 return rc;
2440}
2441
2442
2443/** @copydoc VBOXHDDBACKEND::pfnResize */
2444static int vdiResize(void *pBackendData, uint64_t cbSize,
2445 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
2446 unsigned uPercentStart, unsigned uPercentSpan,
2447 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
2448 PVDINTERFACE pVDIfsOperation)
2449{
2450 PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
2451 int rc = VINF_SUCCESS;
2452
2453 PFNVDPROGRESS pfnProgress = NULL;
2454 void *pvUser = NULL;
2455 PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
2456 VDINTERFACETYPE_PROGRESS);
2457 PVDINTERFACEPROGRESS pCbProgress = NULL;
2458 if (pIfProgress)
2459 {
2460 pCbProgress = VDGetInterfaceProgress(pIfProgress);
2461 if (pCbProgress)
2462 pfnProgress = pCbProgress->pfnProgress;
2463 pvUser = pIfProgress->pvUser;
2464 }
2465
2466 /*
2467 * Making the image smaller is not supported at the moment.
2468 * Resizing is also not supported for fixed size images and
2469 * very old images.
2470 */
2471 /** @todo implement making the image smaller, it is the responsibility of
2472 * the user to know what he's doing. */
2473 if ( cbSize < getImageDiskSize(&pImage->Header)
2474 || GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0
2475 || pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED)
2476 rc = VERR_NOT_SUPPORTED;
2477 else if (cbSize > getImageDiskSize(&pImage->Header))
2478 {
2479 unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header); /** < Blocks currently allocated, doesn't change during resize */
2480 uint32_t cBlocksNew = cbSize / getImageBlockSize(&pImage->Header); /** < New number of blocks in the image after the resize */
2481 if (cbSize % getImageBlockSize(&pImage->Header))
2482 cBlocksNew++;
2483
2484 uint32_t cBlocksOld = getImageBlocks(&pImage->Header); /** < Number of blocks before the resize. */
2485 uint64_t cbBlockspaceNew = cBlocksNew * sizeof(VDIIMAGEBLOCKPOINTER); /** < Required space for the block array after the resize. */
2486 uint64_t offStartDataNew = RT_ALIGN_32(pImage->offStartBlocks + cbBlockspaceNew, VDI_DATA_ALIGN); /** < New start offset for block data after the resize */
2487
2488 if ( pImage->offStartData != offStartDataNew
2489 && cBlocksAllocated > 0)
2490 {
2491 /* Calculate how many sectors need to be relocated. */
2492 uint64_t cbOverlapping = offStartDataNew - pImage->offStartData;
2493 unsigned cBlocksReloc = cbOverlapping / getImageBlockSize(&pImage->Header);
2494 if (cbOverlapping % getImageBlockSize(&pImage->Header))
2495 cBlocksReloc++;
2496
2497 /* Since only full blocks can be relocated the new data start is
2498 * determined by moving it block by block. */
2499 cBlocksReloc = RT_MIN(cBlocksReloc, cBlocksAllocated);
2500 offStartDataNew = pImage->offStartData;
2501
2502 /* Do the relocation. */
2503 LogFlow(("Relocating %u blocks\n", cBlocksReloc));
2504
2505 /*
2506 * Get the blocks we need to relocate first, they are appended to the end
2507 * of the image.
2508 */
2509 void *pvBuf = NULL, *pvZero = NULL;
2510 do
2511 {
2512 VDIIMAGEBLOCKPOINTER uBlock = 0;
2513
2514 /* Allocate data buffer. */
2515 pvBuf = RTMemAllocZ(pImage->cbTotalBlockData);
2516 if (!pvBuf)
2517 {
2518 rc = VERR_NO_MEMORY;
2519 break;
2520 }
2521
2522 /* Allocate buffer for overwrting with zeroes. */
2523 pvZero = RTMemAllocZ(pImage->cbTotalBlockData);
2524 if (!pvZero)
2525 {
2526 rc = VERR_NO_MEMORY;
2527 break;
2528 }
2529
2530 for (unsigned i = 0; i < cBlocksReloc; i++)
2531 {
2532 /* Search the index in the block table. */
2533 for (unsigned idxBlock = 0; idxBlock < cBlocksOld; idxBlock++)
2534 {
2535 if (pImage->paBlocks[idxBlock] == uBlock)
2536 {
2537 /* Read data and append to the end of the image. */
2538 rc = vdiFileReadSync(pImage, offStartDataNew, pvBuf, pImage->cbTotalBlockData, NULL);
2539 if (RT_FAILURE(rc))
2540 break;
2541
2542 uint64_t offBlockAppend;
2543 rc = vdiFileGetSize(pImage, &offBlockAppend);
2544 if (RT_FAILURE(rc))
2545 break;
2546
2547 rc = vdiFileWriteSync(pImage, offBlockAppend, pvBuf, pImage->cbTotalBlockData, NULL);
2548 if (RT_FAILURE(rc))
2549 break;
2550
2551 /* Zero out the old block area. */
2552 rc = vdiFileWriteSync(pImage, offStartDataNew, pvZero, pImage->cbTotalBlockData, NULL);
2553 if (RT_FAILURE(rc))
2554 break;
2555
2556 /* Update block counter. */
2557 pImage->paBlocks[idxBlock] = cBlocksAllocated - 1;
2558
2559 /*
2560 * Decrease the block number of all other entries in the array.
2561 * They were moved one block to the front.
2562 * Doing it as a separate step iterating over the array again
2563 * because an error while relocating the block might end up
2564 * in a corrupted image otherwise.
2565 */
2566 for (unsigned idxBlock2 = 0; idxBlock2 < cBlocksOld; idxBlock2++)
2567 {
2568 if ( idxBlock2 != idxBlock
2569 && IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[idxBlock2]))
2570 pImage->paBlocks[idxBlock2]--;
2571 }
2572
2573 /* Continue with the next block. */
2574 break;
2575 }
2576 }
2577
2578 if (RT_FAILURE(rc))
2579 break;
2580
2581 uBlock++;
2582 offStartDataNew += pImage->cbTotalBlockData;
2583 }
2584 } while (0);
2585
2586 if (pvBuf)
2587 RTMemFree(pvBuf);
2588 if (pvZero)
2589 RTMemFree(pvZero);
2590 }
2591
2592 /*
2593 * We need to update the new offsets for the image data in the out of memory
2594 * case too because we relocated the blocks already.
2595 */
2596 pImage->offStartData = offStartDataNew;
2597 setImageDataOffset(&pImage->Header, offStartDataNew);
2598
2599 /*
2600 * Relocation done, expand the block array and update the header with
2601 * the new data.
2602 */
2603 if (RT_SUCCESS(rc))
2604 {
2605 PVDIIMAGEBLOCKPOINTER paBlocksNew = (PVDIIMAGEBLOCKPOINTER)RTMemRealloc(pImage->paBlocks, cbBlockspaceNew);
2606 if (paBlocksNew)
2607 {
2608 pImage->paBlocks = paBlocksNew;
2609
2610 /* Mark the new blocks as unallocated. */
2611 for (unsigned idxBlock = cBlocksOld; idxBlock < cBlocksNew; idxBlock++)
2612 pImage->paBlocks[idxBlock] = VDI_IMAGE_BLOCK_FREE;
2613 }
2614 else
2615 rc = VERR_NO_MEMORY;
2616
2617 /* Write the block array before updating the rest. */
2618 rc = vdiFileWriteSync(pImage, pImage->offStartBlocks, pImage->paBlocks,
2619 cbBlockspaceNew, NULL);
2620
2621 if (RT_SUCCESS(rc))
2622 {
2623 /* Update size and new block count. */
2624 setImageDiskSize(&pImage->Header, cbSize);
2625 setImageBlocks(&pImage->Header, cBlocksNew);
2626 /* Update geometry. */
2627 pImage->PCHSGeometry = *pPCHSGeometry;
2628
2629 PVDIDISKGEOMETRY pGeometry = getImageLCHSGeometry(&pImage->Header);
2630 if (pGeometry)
2631 {
2632 pGeometry->cCylinders = pLCHSGeometry->cCylinders;
2633 pGeometry->cHeads = pLCHSGeometry->cHeads;
2634 pGeometry->cSectors = pLCHSGeometry->cSectors;
2635 pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
2636 }
2637 }
2638 }
2639
2640 /* Update header information in base image file. */
2641 vdiFlushImage(pImage);
2642 }
2643 /* Same size doesn't change the image at all. */
2644
2645 LogFlowFunc(("returns %Rrc\n", rc));
2646 return rc;
2647}
2648
2649
2650VBOXHDDBACKEND g_VDIBackend =
2651{
2652 /* pszBackendName */
2653 "VDI",
2654 /* cbSize */
2655 sizeof(VBOXHDDBACKEND),
2656 /* uBackendCaps */
2657 VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
2658 | VD_CAP_DIFF | VD_CAP_FILE | VD_CAP_ASYNC | VD_CAP_VFS,
2659 /* papszFileExtensions */
2660 s_apszVdiFileExtensions,
2661 /* paConfigInfo */
2662 NULL,
2663 /* hPlugin */
2664 NIL_RTLDRMOD,
2665 /* pfnCheckIfValid */
2666 vdiCheckIfValid,
2667 /* pfnOpen */
2668 vdiOpen,
2669 /* pfnCreate */
2670 vdiCreate,
2671 /* pfnRename */
2672 vdiRename,
2673 /* pfnClose */
2674 vdiClose,
2675 /* pfnRead */
2676 vdiRead,
2677 /* pfnWrite */
2678 vdiWrite,
2679 /* pfnFlush */
2680 vdiFlush,
2681 /* pfnGetVersion */
2682 vdiGetVersion,
2683 /* pfnGetSize */
2684 vdiGetSize,
2685 /* pfnGetFileSize */
2686 vdiGetFileSize,
2687 /* pfnGetPCHSGeometry */
2688 vdiGetPCHSGeometry,
2689 /* pfnSetPCHSGeometry */
2690 vdiSetPCHSGeometry,
2691 /* pfnGetLCHSGeometry */
2692 vdiGetLCHSGeometry,
2693 /* pfnSetLCHSGeometry */
2694 vdiSetLCHSGeometry,
2695 /* pfnGetImageFlags */
2696 vdiGetImageFlags,
2697 /* pfnGetOpenFlags */
2698 vdiGetOpenFlags,
2699 /* pfnSetOpenFlags */
2700 vdiSetOpenFlags,
2701 /* pfnGetComment */
2702 vdiGetComment,
2703 /* pfnSetComment */
2704 vdiSetComment,
2705 /* pfnGetUuid */
2706 vdiGetUuid,
2707 /* pfnSetUuid */
2708 vdiSetUuid,
2709 /* pfnGetModificationUuid */
2710 vdiGetModificationUuid,
2711 /* pfnSetModificationUuid */
2712 vdiSetModificationUuid,
2713 /* pfnGetParentUuid */
2714 vdiGetParentUuid,
2715 /* pfnSetParentUuid */
2716 vdiSetParentUuid,
2717 /* pfnGetParentModificationUuid */
2718 vdiGetParentModificationUuid,
2719 /* pfnSetParentModificationUuid */
2720 vdiSetParentModificationUuid,
2721 /* pfnDump */
2722 vdiDump,
2723 /* pfnGetTimeStamp */
2724 NULL,
2725 /* pfnGetParentTimeStamp */
2726 NULL,
2727 /* pfnSetParentTimeStamp */
2728 NULL,
2729 /* pfnGetParentFilename */
2730 NULL,
2731 /* pfnSetParentFilename */
2732 NULL,
2733 /* pfnIsAsyncIOSupported */
2734 vdiIsAsyncIOSupported,
2735 /* pfnAsyncRead */
2736 vdiAsyncRead,
2737 /* pfnAsyncWrite */
2738 vdiAsyncWrite,
2739 /* pfnAsyncFlush */
2740 vdiAsyncFlush,
2741 /* pfnComposeLocation */
2742 genericFileComposeLocation,
2743 /* pfnComposeName */
2744 genericFileComposeName,
2745 /* pfnCompact */
2746 vdiCompact,
2747 /* pfnResize */
2748 vdiResize
2749};
Note: See TracBrowser for help on using the repository browser.

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