VirtualBox

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

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

Storage/VMDK+VDI: fix error handling when pointing to a zero size file

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