VDIHDDCore.cpp@ 13223

Last change on this file since 13223 was 13223, checked in by vboxsync, 16 years ago
Device/Storage: Fix incorrect translation between image type enums. Mishandled fixed VDIs.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 62.1 KB

Line
1	/** @file
2	* Virtual Disk Image (VDI), Core Code.
3	*/
4
5	/*
6	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
17	* Clara, CA 95054 USA or visit http://www.sun.com if you need
18	* additional information or have any questions.
19	*/
20
21	/*******************************************************************************
22	* Header Files *
23	*******************************************************************************/
24	#define LOG_GROUP LOG_GROUP_VD_VDI
25	#include "VBoxHDD-newInternal.h"
26	#define VBOX_VDICORE_VD /* Signal that the header is included from here. */
27	#include "VDICore.h"
28	#include <VBox/err.h>
29
30	#include <VBox/log.h>
31	#include <iprt/alloc.h>
32	#include <iprt/assert.h>
33	#include <iprt/uuid.h>
34	#include <iprt/file.h>
35	#include <iprt/string.h>
36	#include <iprt/asm.h>
37
38	#define VDI_IMAGE_DEFAULT_BLOCK_SIZE _1M
39
40	/*******************************************************************************
41	* Static Variables *
42	*******************************************************************************/
43
44	/** NULL-terminated array of supported file extensions. */
45	static const char *const s_apszVdiFileExtensions[] =
46	{
47	"vdi",
48	NULL
49	};
50
51	/*******************************************************************************
52	* Internal Functions *
53	*******************************************************************************/
54	static unsigned getPowerOfTwo(unsigned uNumber);
55	static void vdiInitPreHeader(PVDIPREHEADER pPreHdr);
56	static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr);
57	static void vdiInitHeader(PVDIHEADER pHeader, VDIMAGETYPE enmType,
58	uint32_t uImageFlags, const char *pszComment,
59	uint64_t cbDisk, uint32_t cbBlock,
60	uint32_t cbBlockExtra);
61	static int vdiValidateHeader(PVDIHEADER pHeader);
62	static void vdiSetupImageDesc(PVDIIMAGEDESC pImage);
63	static int vdiUpdateHeader(PVDIIMAGEDESC pImage);
64	static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock);
65	static void vdiFreeImage(PVDIIMAGEDESC pImage, bool fDelete);
66
67
68	/**
69	* Internal: signal an error to the frontend.
70	*/
71	DECLINLINE(int) vdiError(PVDIIMAGEDESC pImage, int rc, RT_SRC_POS_DECL,
72	const char *pszFormat, ...)
73	{
74	va_list va;
75	va_start(va, pszFormat);
76	if (pImage->pInterfaceError && pImage->pInterfaceErrorCallbacks)
77	pImage->pInterfaceErrorCallbacks->pfnError(pImage->pInterfaceError->pvUser,
78	rc, RT_SRC_POS_ARGS,
79	pszFormat, va);
80	va_end(va);
81	return rc;
82	}
83
84
85	/**
86	* internal: return power of 2 or 0 if num error.
87	*/
88	static unsigned getPowerOfTwo(unsigned uNumber)
89	{
90	if (uNumber == 0)
91	return 0;
92	unsigned uPower2 = 0;
93	while ((uNumber & 1) == 0)
94	{
95	uNumber >>= 1;
96	uPower2++;
97	}
98	return uNumber == 1 ? uPower2 : 0;
99	}
100
101
102	/**
103	* Internal: Init VDI preheader.
104	*/
105	static void vdiInitPreHeader(PVDIPREHEADER pPreHdr)
106	{
107	pPreHdr->u32Signature = VDI_IMAGE_SIGNATURE;
108	pPreHdr->u32Version = VDI_IMAGE_VERSION;
109	memset(pPreHdr->szFileInfo, 0, sizeof(pPreHdr->szFileInfo));
110	strncat(pPreHdr->szFileInfo, VDI_IMAGE_FILE_INFO, sizeof(pPreHdr->szFileInfo));
111	}
112
113	/**
114	* Internal: check VDI preheader.
115	*/
116	static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr)
117	{
118	if (pPreHdr->u32Signature != VDI_IMAGE_SIGNATURE)
119	return VERR_VDI_INVALID_SIGNATURE;
120
121	if ( VDI_GET_VERSION_MAJOR(pPreHdr->u32Version) != VDI_IMAGE_VERSION_MAJOR
122	&& pPreHdr->u32Version != 0x00000002) /* old version. */
123	return VERR_VDI_UNSUPPORTED_VERSION;
124
125	return VINF_SUCCESS;
126	}
127
128	/**
129	* Internal: translate VD image type enum to VDI image type enum.
130	*/
131	static VDIIMAGETYPE vdiTranslateTypeVD2VDI(VDIMAGETYPE enmType)
132	{
133	switch (enmType)
134	{
135	case VD_IMAGE_TYPE_NORMAL:
136	return VDI_IMAGE_TYPE_NORMAL;
137	case VD_IMAGE_TYPE_FIXED:
138	return VDI_IMAGE_TYPE_FIXED;
139	case VD_IMAGE_TYPE_UNDO:
140	return VDI_IMAGE_TYPE_UNDO;
141	case VD_IMAGE_TYPE_DIFF:
142	return VDI_IMAGE_TYPE_DIFF;
143	default:
144	AssertMsgFailed(("invalid VDIMAGETYPE enmType=%d\n", (int)enmType));
145	return VDI_IMAGE_TYPE_NORMAL;
146	}
147	}
148
149	/**
150	* Internal: translate VDI image type enum to VD image type enum.
151	*/
152	static VDIMAGETYPE vdiTranslateTypeVDI2VD(VDIIMAGETYPE enmType)
153	{
154	switch (enmType)
155	{
156	case VDI_IMAGE_TYPE_NORMAL:
157	return VD_IMAGE_TYPE_NORMAL;
158	case VDI_IMAGE_TYPE_FIXED:
159	return VD_IMAGE_TYPE_FIXED;
160	case VDI_IMAGE_TYPE_UNDO:
161	return VD_IMAGE_TYPE_UNDO;
162	case VDI_IMAGE_TYPE_DIFF:
163	return VD_IMAGE_TYPE_DIFF;
164	default:
165	AssertMsgFailed(("invalid VDIIMAGETYPE enmType=%d\n", (int)enmType));
166	return VD_IMAGE_TYPE_INVALID;
167	}
168	}
169
170	/**
171	* Internal: Init VDI header. Always use latest header version.
172	* @param pHeader Assumes it was initially initialized to all zeros.
173	*/
174	static void vdiInitHeader(PVDIHEADER pHeader, VDIMAGETYPE enmType,
175	uint32_t uImageFlags, const char *pszComment,
176	uint64_t cbDisk, uint32_t cbBlock,
177	uint32_t cbBlockExtra)
178	{
179	pHeader->uVersion = VDI_IMAGE_VERSION;
180	pHeader->u.v1.cbHeader = sizeof(VDIHEADER1);
181	pHeader->u.v1.u32Type = (uint32_t)vdiTranslateTypeVD2VDI(enmType);
182	pHeader->u.v1.fFlags = (uImageFlags & VD_VDI_IMAGE_FLAGS_ZERO_EXPAND) ? 1 : 0;
183	#ifdef VBOX_STRICT
184	char achZero[VDI_IMAGE_COMMENT_SIZE] = {0};
185	Assert(!memcmp(pHeader->u.v1.szComment, achZero, VDI_IMAGE_COMMENT_SIZE));
186	#endif
187	pHeader->u.v1.szComment[0] = '\0';
188	if (pszComment)
189	{
190	AssertMsg(strlen(pszComment) < sizeof(pHeader->u.v1.szComment),
191	("HDD Comment is too long, cb=%d\n", strlen(pszComment)));
192	strncat(pHeader->u.v1.szComment, pszComment, sizeof(pHeader->u.v1.szComment));
193	}
194
195	/* Mark the legacy geometry not-calculated. */
196	pHeader->u.v1.LegacyGeometry.cCylinders = 0;
197	pHeader->u.v1.LegacyGeometry.cHeads = 0;
198	pHeader->u.v1.LegacyGeometry.cSectors = 0;
199	pHeader->u.v1.LegacyGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
200	pHeader->u.v1.u32Dummy = 0; /* used to be the translation value */
201
202	pHeader->u.v1.cbDisk = cbDisk;
203	pHeader->u.v1.cbBlock = cbBlock;
204	pHeader->u.v1.cBlocks = (uint32_t)(cbDisk / cbBlock);
205	if (cbDisk % cbBlock)
206	pHeader->u.v1.cBlocks++;
207	pHeader->u.v1.cbBlockExtra = cbBlockExtra;
208	pHeader->u.v1.cBlocksAllocated = 0;
209
210	/* Init offsets. */
211	pHeader->u.v1.offBlocks = RT_ALIGN_32(sizeof(VDIPREHEADER) + sizeof(VDIHEADER1), VDI_GEOMETRY_SECTOR_SIZE);
212	pHeader->u.v1.offData = RT_ALIGN_32(pHeader->u.v1.offBlocks + (pHeader->u.v1.cBlocks * sizeof(VDIIMAGEBLOCKPOINTER)), VDI_GEOMETRY_SECTOR_SIZE);
213
214	/* Init uuids. */
215	RTUuidCreate(&pHeader->u.v1.uuidCreate);
216	RTUuidClear(&pHeader->u.v1.uuidModify);
217	RTUuidClear(&pHeader->u.v1.uuidLinkage);
218	RTUuidClear(&pHeader->u.v1.uuidParentModify);
219
220	/* Mark LCHS geometry not-calculated. */
221	pHeader->u.v1plus.LCHSGeometry.cCylinders = 0;
222	pHeader->u.v1plus.LCHSGeometry.cHeads = 0;
223	pHeader->u.v1plus.LCHSGeometry.cSectors = 0;
224	pHeader->u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
225	}
226
227	/**
228	* Internal: Check VDI header.
229	*/
230	static int vdiValidateHeader(PVDIHEADER pHeader)
231	{
232	/* Check version-dependend header parameters. */
233	switch (GET_MAJOR_HEADER_VERSION(pHeader))
234	{
235	case 0:
236	{
237	/* Old header version. */
238	break;
239	}
240	case 1:
241	{
242	/* Current header version. */
243
244	if (pHeader->u.v1.cbHeader < sizeof(VDIHEADER1))
245	{
246	LogRel(("VDI: v1 header size wrong (%d < %d)\n",
247	pHeader->u.v1.cbHeader, sizeof(VDIHEADER1)));
248	return VERR_VDI_INVALID_HEADER;
249	}
250
251	if (getImageBlocksOffset(pHeader) < (sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)))
252	{
253	LogRel(("VDI: v1 blocks offset wrong (%d < %d)\n",
254	getImageBlocksOffset(pHeader), sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)));
255	return VERR_VDI_INVALID_HEADER;
256	}
257
258	if (getImageDataOffset(pHeader) < (getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)))
259	{
260	LogRel(("VDI: v1 image data offset wrong (%d < %d)\n",
261	getImageDataOffset(pHeader), getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)));
262	return VERR_VDI_INVALID_HEADER;
263	}
264
265	break;
266	}
267	default:
268	/* Unsupported. */
269	return VERR_VDI_UNSUPPORTED_VERSION;
270	}
271
272	/* Check common header parameters. */
273
274	bool fFailed = false;
275
276	if ( getImageType(pHeader) < VDI_IMAGE_TYPE_FIRST
277	\|\| getImageType(pHeader) > VDI_IMAGE_TYPE_LAST)
278	{
279	LogRel(("VDI: bad image type %d\n", getImageType(pHeader)));
280	fFailed = true;
281	}
282
283	if (getImageFlags(pHeader) & ~VD_VDI_IMAGE_FLAGS_MASK)
284	{
285	LogRel(("VDI: bad image flags %08x\n", getImageFlags(pHeader)));
286	fFailed = true;
287	}
288
289	if ( getImageLCHSGeometry(pHeader)
290	&& (getImageLCHSGeometry(pHeader))->cbSector != VDI_GEOMETRY_SECTOR_SIZE)
291	{
292	LogRel(("VDI: wrong sector size (%d != %d)\n",
293	(getImageLCHSGeometry(pHeader))->cbSector, VDI_GEOMETRY_SECTOR_SIZE));
294	fFailed = true;
295	}
296
297	if ( getImageDiskSize(pHeader) == 0
298	\|\| getImageBlockSize(pHeader) == 0
299	\|\| getImageBlocks(pHeader) == 0
300	\|\| getPowerOfTwo(getImageBlockSize(pHeader)) == 0)
301	{
302	LogRel(("VDI: wrong size (%lld, %d, %d, %d)\n",
303	getImageDiskSize(pHeader), getImageBlockSize(pHeader),
304	getImageBlocks(pHeader), getPowerOfTwo(getImageBlockSize(pHeader))));
305	fFailed = true;
306	}
307
308	if (getImageBlocksAllocated(pHeader) > getImageBlocks(pHeader))
309	{
310	LogRel(("VDI: too many blocks allocated (%d > %d)\n"
311	" blocksize=%d disksize=%lld\n",
312	getImageBlocksAllocated(pHeader), getImageBlocks(pHeader),
313	getImageBlockSize(pHeader), getImageDiskSize(pHeader)));
314	fFailed = true;
315	}
316
317	if ( getImageExtraBlockSize(pHeader) != 0
318	&& getPowerOfTwo(getImageExtraBlockSize(pHeader)) == 0)
319	{
320	LogRel(("VDI: wrong extra size (%d, %d)\n",
321	getImageExtraBlockSize(pHeader), getPowerOfTwo(getImageExtraBlockSize(pHeader))));
322	fFailed = true;
323	}
324
325	if ((uint64_t)getImageBlockSize(pHeader) * getImageBlocks(pHeader) < getImageDiskSize(pHeader))
326	{
327	LogRel(("VDI: wrong disk size (%d, %d, %lld)\n",
328	getImageBlockSize(pHeader), getImageBlocks(pHeader), getImageDiskSize(pHeader)));
329	fFailed = true;
330	}
331
332	if (RTUuidIsNull(getImageCreationUUID(pHeader)))
333	{
334	LogRel(("VDI: uuid of creator is 0\n"));
335	fFailed = true;
336	}
337
338	if (RTUuidIsNull(getImageModificationUUID(pHeader)))
339	{
340	LogRel(("VDI: uuid of modificator is 0\n"));
341	fFailed = true;
342	}
343
344	return fFailed ? VERR_VDI_INVALID_HEADER : VINF_SUCCESS;
345	}
346
347	/**
348	* Internal: Set up VDIIMAGEDESC structure by image header.
349	*/
350	static void vdiSetupImageDesc(PVDIIMAGEDESC pImage)
351	{
352	pImage->uImageFlags = getImageFlags(&pImage->Header);
353	pImage->offStartBlocks = getImageBlocksOffset(&pImage->Header);
354	pImage->offStartData = getImageDataOffset(&pImage->Header);
355	pImage->uBlockMask = getImageBlockSize(&pImage->Header) - 1;
356	pImage->uShiftOffset2Index = getPowerOfTwo(getImageBlockSize(&pImage->Header));
357	pImage->offStartBlockData = getImageExtraBlockSize(&pImage->Header);
358	pImage->cbTotalBlockData = pImage->offStartBlockData
359	+ getImageBlockSize(&pImage->Header);
360	}
361
362	/**
363	* Internal: Create VDI image file.
364	*/
365	static int vdiCreateImage(PVDIIMAGEDESC pImage, VDIMAGETYPE enmType,
366	uint64_t cbSize, unsigned uImageFlags,
367	const char *pszComment,
368	PCPDMMEDIAGEOMETRY pPCHSGeometry,
369	PCPDMMEDIAGEOMETRY pLCHSGeometry, PCRTUUID pUuid,
370	PFNVMPROGRESS pfnProgress, void *pvUser,
371	unsigned uPercentStart, unsigned uPercentSpan)
372	{
373	int rc;
374	RTFILE File;
375	uint64_t cbTotal;
376	uint64_t cbFill;
377	uint64_t uOff;
378
379	/* Special check for comment length. */
380	if ( VALID_PTR(pszComment)
381	&& strlen(pszComment) >= VDI_IMAGE_COMMENT_SIZE)
382	{
383	rc = vdiError(pImage, VERR_VDI_COMMENT_TOO_LONG, RT_SRC_POS, N_("VDI: comment is too long for '%s'"), pImage->pszFilename);
384	goto out;
385	}
386	Assert(VALID_PTR(pPCHSGeometry));
387	Assert(VALID_PTR(pLCHSGeometry));
388
389	pImage->pInterfaceError = VDInterfaceGet(pImage->pVDIfsDisk, VDINTERFACETYPE_ERROR);
390	if (pImage->pInterfaceError)
391	pImage->pInterfaceErrorCallbacks = VDGetInterfaceError(pImage->pInterfaceError);
392
393	vdiInitPreHeader(&pImage->PreHeader);
394	vdiInitHeader(&pImage->Header, enmType, uImageFlags, pszComment, cbSize, VDI_IMAGE_DEFAULT_BLOCK_SIZE, 0);
395	/* Save PCHS geometry. Not much work, and makes the flow of information
396	* quite a bit clearer - relying on the higher level isn't obvious. */
397	pImage->PCHSGeometry = *pPCHSGeometry;
398	/* Set LCHS geometry (legacy geometry is ignored for the current 1.1+). */
399	pImage->Header.u.v1plus.LCHSGeometry.cCylinders = pLCHSGeometry->cCylinders;
400	pImage->Header.u.v1plus.LCHSGeometry.cHeads = pLCHSGeometry->cHeads;
401	pImage->Header.u.v1plus.LCHSGeometry.cSectors = pLCHSGeometry->cSectors;
402	pImage->Header.u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
403
404	pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
405	if (!pImage->paBlocks)
406	{
407	rc = VERR_NO_MEMORY;
408	goto out;
409	}
410
411	if (enmType != VD_IMAGE_TYPE_FIXED)
412	{
413	/* for growing images mark all blocks in paBlocks as free. */
414	for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
415	pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
416	}
417	else
418	{
419	/* for fixed images mark all blocks in paBlocks as allocated */
420	for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
421	pImage->paBlocks[i] = i;
422	pImage->Header.u.v1.cBlocksAllocated = pImage->Header.u.v1.cBlocks;
423	}
424
425	/* Setup image parameters. */
426	vdiSetupImageDesc(pImage);
427
428	/* Create image file. */
429	rc = RTFileOpen(&File, pImage->pszFilename,
430	RTFILE_O_READWRITE \| RTFILE_O_CREATE \| RTFILE_O_DENY_ALL);
431	if (RT_FAILURE(rc))
432	{
433	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: cannot create image '%s'"), pImage->pszFilename);
434	goto out;
435	}
436	pImage->File = File;
437
438	cbTotal = pImage->offStartData
439	+ (uint64_t)getImageBlocks(&pImage->Header) * pImage->cbTotalBlockData;
440
441	if (enmType == VD_IMAGE_TYPE_FIXED)
442	{
443	/* Check the free space on the disk and leave early if there is not
444	* sufficient space available. */
445	RTFOFF cbFree = 0;
446	rc = RTFsQuerySizes(pImage->pszFilename, NULL, &cbFree, NULL, NULL);
447	if (RT_SUCCESS(rc) /* ignore errors */ && ((uint64_t)cbFree < cbTotal))
448	{
449	rc = vdiError(pImage, VERR_DISK_FULL, RT_SRC_POS, N_("VDI: disk would overflow creating image '%s'"), pImage->pszFilename);
450	goto out;
451	}
452	}
453
454	if (enmType == VD_IMAGE_TYPE_FIXED)
455	{
456	/*
457	* Allocate & commit whole file if fixed image, it must be more
458	* effective than expanding file by write operations.
459	*/
460	rc = RTFileSetSize(File, cbTotal);
461	}
462	else
463	{
464	/* Set file size to hold header and blocks array. */
465	rc = RTFileSetSize(pImage->File, pImage->offStartData);
466	}
467	if (RT_FAILURE(rc))
468	{
469	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: setting image size failed for '%s'"), pImage->pszFilename);
470	goto out;
471	}
472
473	/* Use specified image uuid */
474	getImageCreationUUID(&pImage->Header) = pUuid;
475
476	/* Generate image last-modify uuid */
477	RTUuidCreate(getImageModificationUUID(&pImage->Header));
478
479	/* Write pre-header. */
480	rc = RTFileWriteAt(File, 0, &pImage->PreHeader, sizeof(pImage->PreHeader), NULL);
481	if (RT_FAILURE(rc))
482	{
483	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing pre-header failed for '%s'"), pImage->pszFilename);
484	goto out;
485	}
486
487	/* Write header. */
488	rc = RTFileWriteAt(File, sizeof(pImage->PreHeader), &pImage->Header.u.v1plus, sizeof(pImage->Header.u.v1plus), NULL);
489	if (RT_FAILURE(rc))
490	{
491	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing header failed for '%s'"), pImage->pszFilename);
492	goto out;
493	}
494
495	rc = RTFileWriteAt(File, pImage->offStartBlocks,
496	pImage->paBlocks,
497	getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER),
498	NULL);
499	if (RT_FAILURE(rc))
500	{
501	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing block pointers failed for '%s'"), pImage->pszFilename);
502	goto out;
503	}
504
505	if (enmType == VD_IMAGE_TYPE_FIXED)
506	{
507	/* Fill image with zeroes. We do this for every fixed-size image since on some systems
508	* (for example Windows Vista), it takes ages to write a block near the end of a sparse
509	* file and the guest could complain about an ATA timeout. */
510
511	/** @todo Starting with Linux 2.6.23, there is an fallocate() system call.
512	* Currently supported file systems are ext4 and ocfs2. */
513
514	/* Allocate a temporary zero-filled buffer. Use a bigger block size to optimize writing */
515	const size_t cbBuf = 128 * _1K;
516	void *pvBuf = RTMemTmpAllocZ(cbBuf);
517	if (!pvBuf)
518	{
519	rc = VERR_NO_MEMORY;
520	goto out;
521	}
522
523	cbFill = (uint64_t)getImageBlocks(&pImage->Header) * pImage->cbTotalBlockData;
524	uOff = 0;
525	/* Write data to all image blocks. */
526	while (uOff < cbFill)
527	{
528	unsigned cbChunk = (unsigned)RT_MIN(cbFill, cbBuf);
529
530	rc = RTFileWriteAt(File, pImage->offStartData + uOff,
531	pvBuf, cbChunk, NULL);
532	if (RT_FAILURE(rc))
533	{
534	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: writing block failed for '%s'"), pImage->pszFilename);
535	goto out;
536	}
537
538	uOff += cbChunk;
539
540	if (pfnProgress)
541	{
542	rc = pfnProgress(NULL /* WARNING! pVM=NULL */,
543	uPercentStart + uOff * uPercentSpan / cbFill,
544	pvUser);
545	if (RT_FAILURE(rc))
546	goto out;
547	}
548	}
549	RTMemTmpFree(pvBuf);
550	}
551
552	out:
553	if (RT_SUCCESS(rc) && pfnProgress)
554	pfnProgress(NULL /* WARNING! pVM=NULL */,
555	uPercentStart + uPercentSpan, pvUser);
556
557	if (RT_FAILURE(rc))
558	vdiFreeImage(pImage, rc != VERR_ALREADY_EXISTS);
559	return rc;
560	}
561
562	/**
563	* Internal: Open a VDI image.
564	*/
565	static int vdiOpenImage(PVDIIMAGEDESC pImage, unsigned uOpenFlags)
566	{
567	int rc;
568	RTFILE File;
569
570	if (uOpenFlags & VD_OPEN_FLAGS_ASYNC_IO)
571	return VERR_NOT_SUPPORTED;
572
573	pImage->uOpenFlags = uOpenFlags;
574
575	pImage->pInterfaceError = VDInterfaceGet(pImage->pVDIfsDisk, VDINTERFACETYPE_ERROR);
576	if (pImage->pInterfaceError)
577	pImage->pInterfaceErrorCallbacks = VDGetInterfaceError(pImage->pInterfaceError);
578
579	/*
580	* Open the image.
581	*/
582	rc = RTFileOpen(&File, pImage->pszFilename,
583	uOpenFlags & VD_OPEN_FLAGS_READONLY
584	? RTFILE_O_READ \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE
585	: RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
586	if (RT_FAILURE(rc))
587	{
588	/* Do NOT signal an appropriate error here, as the VD layer has the
589	* choice of retrying the open if it failed. */
590	goto out;
591	}
592	pImage->File = File;
593
594	/* Read pre-header. */
595	rc = RTFileReadAt(File, 0, &pImage->PreHeader, sizeof(pImage->PreHeader),
596	NULL);
597	if (RT_FAILURE(rc))
598	{
599	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading pre-header in '%s'"), pImage->pszFilename);
600	goto out;
601	}
602	rc = vdiValidatePreHeader(&pImage->PreHeader);
603	if (RT_FAILURE(rc))
604	{
605	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: invalid pre-header in '%s'"), pImage->pszFilename);
606	goto out;
607	}
608
609	/* Read header. */
610	pImage->Header.uVersion = pImage->PreHeader.u32Version;
611	switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
612	{
613	case 0:
614	rc = RTFileReadAt(File, sizeof(pImage->PreHeader),
615	&pImage->Header.u.v0, sizeof(pImage->Header.u.v0),
616	NULL);
617	if (RT_FAILURE(rc))
618	{
619	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v0 header in '%s'"), pImage->pszFilename);
620	goto out;
621	}
622	break;
623	case 1:
624	rc = RTFileReadAt(File, sizeof(pImage->PreHeader),
625	&pImage->Header.u.v1, sizeof(pImage->Header.u.v1),
626	NULL);
627	if (RT_FAILURE(rc))
628	{
629	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v1 header in '%s'"), pImage->pszFilename);
630	goto out;
631	}
632	/* Convert VDI 1.1 images to VDI 1.1+ on open in read/write mode.
633	* Conversion is harmless, as any VirtualBox version supporting VDI
634	* 1.1 doesn't touch fields it doesn't know about. */
635	if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
636	&& GET_MINOR_HEADER_VERSION(&pImage->Header) == 1
637	&& pImage->Header.u.v1.cbHeader < sizeof(pImage->Header.u.v1plus))
638	{
639	pImage->Header.u.v1plus.cbHeader = sizeof(pImage->Header.u.v1plus);
640	/* Mark LCHS geometry not-calculated. */
641	pImage->Header.u.v1plus.LCHSGeometry.cCylinders = 0;
642	pImage->Header.u.v1plus.LCHSGeometry.cHeads = 0;
643	pImage->Header.u.v1plus.LCHSGeometry.cSectors = 0;
644	pImage->Header.u.v1plus.LCHSGeometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
645	}
646	else if (pImage->Header.u.v1.cbHeader >= sizeof(pImage->Header.u.v1plus))
647	{
648	/* Read the actual VDI 1.1+ header completely. */
649	rc = RTFileReadAt(File, sizeof(pImage->PreHeader), &pImage->Header.u.v1plus, sizeof(pImage->Header.u.v1plus), NULL);
650	if (RT_FAILURE(rc))
651	{
652	rc = vdiError(pImage, rc, RT_SRC_POS, N_("VDI: error reading v1.1+ header in '%s'"), pImage->pszFilename);
653	goto out;
654	}
655	}
656	break;
657	default:
658	rc = vdiError(pImage, VERR_VDI_UNSUPPORTED_VERSION, RT_SRC_POS, N_("VDI: unsupported major version %u in '%s'"), GET_MAJOR_HEADER_VERSION(&pImage->Header), pImage->pszFilename);
659	goto out;
660	}
661
662	rc = vdiValidateHeader(&pImage->Header);
663	if (RT_FAILURE(rc))
664	{
665	rc = vdiError(pImage, VERR_VDI_UNSUPPORTED_VERSION, RT_SRC_POS, N_("VDI: invalid header in '%s'"), pImage->pszFilename);
666	goto out;
667	}
668
669	/* Setup image parameters by header. */
670	vdiSetupImageDesc(pImage);
671
672	/* Allocate memory for blocks array. */
673	pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
674	if (!pImage->paBlocks)
675	{
676	rc = VERR_NO_MEMORY;
677	goto out;
678	}
679
680	/* Read blocks array. */
681	rc = RTFileReadAt(pImage->File, pImage->offStartBlocks, pImage->paBlocks,
682	getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER),
683	NULL);
684
685	out:
686	if (RT_FAILURE(rc))
687	vdiFreeImage(pImage, false);
688	return rc;
689	}
690
691	/**
692	* Internal: Save header to file.
693	*/
694	static int vdiUpdateHeader(PVDIIMAGEDESC pImage)
695	{
696	int rc;
697	switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
698	{
699	case 0:
700	rc = RTFileWriteAt(pImage->File, sizeof(VDIPREHEADER), &pImage->Header.u.v0, sizeof(pImage->Header.u.v0), NULL);
701	break;
702	case 1:
703	if (pImage->Header.u.v1plus.cbHeader < sizeof(pImage->Header.u.v1plus))
704	rc = RTFileWriteAt(pImage->File, sizeof(VDIPREHEADER), &pImage->Header.u.v1, sizeof(pImage->Header.u.v1), NULL);
705	else
706	rc = RTFileWriteAt(pImage->File, sizeof(VDIPREHEADER), &pImage->Header.u.v1plus, sizeof(pImage->Header.u.v1plus), NULL);
707	break;
708	default:
709	rc = VERR_VDI_UNSUPPORTED_VERSION;
710	break;
711	}
712	AssertMsgRC(rc, ("vdiUpdateHeader failed, filename=\"%s\" rc=%Rrc\n", pImage->pszFilename, rc));
713	return rc;
714	}
715
716	/**
717	* Internal: Save block pointer to file, save header to file.
718	*/
719	static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock)
720	{
721	/* Update image header. */
722	int rc = vdiUpdateHeader(pImage);
723	if (RT_SUCCESS(rc))
724	{
725	/* write only one block pointer. */
726	rc = RTFileWriteAt(pImage->File,
727	pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
728	&pImage->paBlocks[uBlock],
729	sizeof(VDIIMAGEBLOCKPOINTER),
730	NULL);
731	AssertMsgRC(rc, ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Rrc\n",
732	uBlock, pImage->pszFilename, rc));
733	}
734	return rc;
735	}
736
737	/**
738	* Internal: Flush the image file to disk.
739	*/
740	static void vdiFlushImage(PVDIIMAGEDESC pImage)
741	{
742	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
743	{
744	/* Save header. */
745	int rc = vdiUpdateHeader(pImage);
746	AssertMsgRC(rc, ("vdiUpdateHeader() failed, filename=\"%s\", rc=%Rrc\n",
747	pImage->pszFilename, rc));
748	RTFileFlush(pImage->File);
749	}
750	}
751
752	/**
753	* Internal: Free all allocated space for representing an image, and optionally
754	* delete the image from disk.
755	*/
756	static void vdiFreeImage(PVDIIMAGEDESC pImage, bool fDelete)
757	{
758	Assert(VALID_PTR(pImage));
759
760	if (pImage->File != NIL_RTFILE)
761	{
762	vdiFlushImage(pImage);
763	RTFileClose(pImage->File);
764	pImage->File = NIL_RTFILE;
765	}
766	if (pImage->paBlocks)
767	{
768	RTMemFree(pImage->paBlocks);
769	pImage->paBlocks = NULL;
770	}
771	if (fDelete && pImage->pszFilename)
772	RTFileDelete(pImage->pszFilename);
773	}
774
775
776	/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
777	static int vdiCheckIfValid(const char *pszFilename)
778	{
779	LogFlowFunc(("pszFilename=\"%s\"\n", pszFilename));
780	int rc = VINF_SUCCESS;
781	PVDIIMAGEDESC pImage;
782
783	if ( !VALID_PTR(pszFilename)
784	\|\| !*pszFilename)
785	{
786	rc = VERR_INVALID_PARAMETER;
787	goto out;
788	}
789
790	pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
791	if (!pImage)
792	{
793	rc = VERR_NO_MEMORY;
794	goto out;
795	}
796	pImage->pszFilename = pszFilename;
797	pImage->File = NIL_RTFILE;
798	pImage->paBlocks = NULL;
799	pImage->pVDIfsDisk = NULL;
800
801	rc = vdiOpenImage(pImage, VD_OPEN_FLAGS_INFO \| VD_OPEN_FLAGS_READONLY);
802	vdiFreeImage(pImage, false);
803
804	out:
805	LogFlowFunc(("returns %Rrc\n", rc));
806	return rc;
807	}
808
809	/** @copydoc VBOXHDDBACKEND::pfnOpen */
810	static int vdiOpen(const char *pszFilename, unsigned uOpenFlags,
811	PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
812	void **ppBackendData)
813	{
814	LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, ppBackendData));
815	int rc;
816	PVDIIMAGEDESC pImage;
817
818	/* Check open flags. All valid flags are supported. */
819	if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
820	{
821	rc = VERR_INVALID_PARAMETER;
822	goto out;
823	}
824
825	/* Check remaining arguments. */
826	if ( !VALID_PTR(pszFilename)
827	\|\| !*pszFilename)
828	{
829	rc = VERR_INVALID_PARAMETER;
830	goto out;
831	}
832
833	pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
834	if (!pImage)
835	{
836	rc = VERR_NO_MEMORY;
837	goto out;
838	}
839	pImage->pszFilename = pszFilename;
840	pImage->File = NIL_RTFILE;
841	pImage->paBlocks = NULL;
842	pImage->pVDIfsDisk = pVDIfsDisk;
843
844	rc = vdiOpenImage(pImage, uOpenFlags);
845	if (RT_SUCCESS(rc))
846	*ppBackendData = pImage;
847
848	out:
849	LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
850	return rc;
851	}
852
853	/** @copydoc VBOXHDDBACKEND::pfnCreate */
854	static int vdiCreate(const char *pszFilename, VDIMAGETYPE enmType,
855	uint64_t cbSize, unsigned uImageFlags,
856	const char *pszComment,
857	PCPDMMEDIAGEOMETRY pPCHSGeometry,
858	PCPDMMEDIAGEOMETRY pLCHSGeometry, PCRTUUID pUuid,
859	unsigned uOpenFlags, unsigned uPercentStart,
860	unsigned uPercentSpan, PVDINTERFACE pVDIfsDisk,
861	PVDINTERFACE pVDIfsImage, PVDINTERFACE pVDIfsOperation,
862	void **ppBackendData)
863	{
864	LogFlowFunc(("pszFilename=\"%s\" enmType=%d 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, enmType, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, ppBackendData));
865	int rc;
866	PVDIIMAGEDESC pImage;
867
868	PFNVMPROGRESS pfnProgress = NULL;
869	void *pvUser = NULL;
870	PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
871	VDINTERFACETYPE_PROGRESS);
872	PVDINTERFACEPROGRESS pCbProgress = NULL;
873	if (pIfProgress)
874	{
875	pCbProgress = VDGetInterfaceProgress(pIfProgress);
876	if (pCbProgress)
877	pfnProgress = pCbProgress->pfnProgress;
878	pvUser = pIfProgress->pvUser;
879	}
880
881	/* Check open flags. All valid flags are supported. */
882	if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
883	{
884	rc = VERR_INVALID_PARAMETER;
885	goto out;
886	}
887
888	/* Check remaining arguments. */
889	if ( !VALID_PTR(pszFilename)
890	\|\| !*pszFilename
891	\|\| (enmType != VD_IMAGE_TYPE_NORMAL && enmType != VD_IMAGE_TYPE_FIXED
892	&& enmType != VD_IMAGE_TYPE_DIFF)
893	\|\| cbSize < VDI_IMAGE_DEFAULT_BLOCK_SIZE
894	\|\| !VALID_PTR(pPCHSGeometry)
895	\|\| !VALID_PTR(pLCHSGeometry))
896	{
897	rc = VERR_INVALID_PARAMETER;
898	goto out;
899	}
900
901	pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
902	if (!pImage)
903	{
904	rc = VERR_NO_MEMORY;
905	goto out;
906	}
907	pImage->pszFilename = pszFilename;
908	pImage->File = NIL_RTFILE;
909	pImage->paBlocks = NULL;
910	pImage->pVDIfsDisk = pVDIfsDisk;
911
912	rc = vdiCreateImage(pImage, enmType, cbSize, uImageFlags, pszComment,
913	pPCHSGeometry, pLCHSGeometry, pUuid,
914	pfnProgress, pvUser, uPercentStart, uPercentSpan);
915	if (RT_SUCCESS(rc))
916	{
917	/* So far the image is opened in read/write mode. Make sure the
918	* image is opened in read-only mode if the caller requested that. */
919	if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
920	{
921	vdiFreeImage(pImage, false);
922	rc = vdiOpenImage(pImage, uOpenFlags);
923	if (RT_FAILURE(rc))
924	goto out;
925	}
926	*ppBackendData = pImage;
927	}
928
929	out:
930	LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
931	return rc;
932	}
933
934	/** @copydoc VBOXHDDBACKEND::pfnRename */
935	static int vdiRename(void pBackendData, const char pszFilename)
936	{
937	LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
938
939	int rc = VINF_SUCCESS;
940	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
941
942	/* Check arguments. */
943	if ( !pImage
944	\|\| !pszFilename
945	\|\| !*pszFilename)
946	{
947	rc = VERR_INVALID_PARAMETER;
948	goto out;
949	}
950
951	/* Close the image. */
952	vdiFreeImage(pImage, false);
953
954	/* Rename the file. */
955	rc = RTFileMove(pImage->pszFilename, pszFilename, 0);
956	if (RT_FAILURE(rc))
957	{
958	/* The move failed, try to reopen the original image. */
959	int rc2 = vdiOpenImage(pImage, pImage->uOpenFlags);
960	if (RT_FAILURE(rc2))
961	rc = rc2;
962
963	goto out;
964	}
965
966	/* Update pImage with the new information. */
967	pImage->pszFilename = pszFilename;
968
969	/* Open the new image. */
970	rc = vdiOpenImage(pImage, pImage->uOpenFlags);
971	if (RT_FAILURE(rc))
972	goto out;
973
974	out:
975	LogFlowFunc(("returns %Rrc\n", rc));
976	return rc;
977	}
978
979	/** @copydoc VBOXHDDBACKEND::pfnClose */
980	static int vdiClose(void *pBackendData, bool fDelete)
981	{
982	LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
983	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
984	int rc = VINF_SUCCESS;
985
986	/* Freeing a never allocated image (e.g. because the open failed) is
987	* not signalled as an error. After all nothing bad happens. */
988	if (pImage)
989	vdiFreeImage(pImage, fDelete);
990
991	LogFlowFunc(("returns %Rrc\n", rc));
992	return rc;
993	}
994
995	/** @copydoc VBOXHDDBACKEND::pfnRead */
996	static int vdiRead(void pBackendData, uint64_t uOffset, void pvBuf,
997	size_t cbToRead, size_t *pcbActuallyRead)
998	{
999	LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToRead=%zu pcbActuallyRead=%#p\n", pBackendData, uOffset, pvBuf, cbToRead, pcbActuallyRead));
1000	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1001	unsigned uBlock;
1002	unsigned offRead;
1003	int rc;
1004
1005	Assert(VALID_PTR(pImage));
1006	Assert(!(uOffset % 512));
1007	Assert(!(cbToRead % 512));
1008
1009	if ( uOffset + cbToRead > getImageDiskSize(&pImage->Header)
1010	\|\| !VALID_PTR(pvBuf)
1011	\|\| !cbToRead)
1012	{
1013	rc = VERR_INVALID_PARAMETER;
1014	goto out;
1015	}
1016
1017	/* Calculate starting block number and offset inside it. */
1018	uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1019	offRead = (unsigned)uOffset & pImage->uBlockMask;
1020
1021	/* Clip read range to at most the rest of the block. */
1022	cbToRead = RT_MIN(cbToRead, getImageBlockSize(&pImage->Header) - offRead);
1023	Assert(!(cbToRead % 512));
1024
1025	if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
1026	rc = VERR_VDI_BLOCK_FREE;
1027	else if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
1028	{
1029	memset(pvBuf, 0, cbToRead);
1030	rc = VINF_SUCCESS;
1031	}
1032	else
1033	{
1034	/* Block present in image file, read relevant data. */
1035	uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1036	+ (pImage->offStartData + pImage->offStartBlockData + offRead);
1037	rc = RTFileReadAt(pImage->File, u64Offset, pvBuf, cbToRead, NULL);
1038	}
1039
1040	if (RT_SUCCESS(rc))
1041	*pcbActuallyRead = cbToRead;
1042
1043	out:
1044	LogFlowFunc(("returns %Rrc\n", rc));
1045	return rc;
1046	}
1047
1048	/*@copydoc VBOXHDDBACKEND::pfnWrite /
1049	static int vdiWrite(void pBackendData, uint64_t uOffset, const void pvBuf,
1050	size_t cbToWrite, size_t *pcbWriteProcess,
1051	size_t pcbPreRead, size_t pcbPostRead, unsigned fWrite)
1052	{
1053	LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n", pBackendData, uOffset, pvBuf, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
1054	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1055	unsigned uBlock;
1056	unsigned offWrite;
1057	int rc = VINF_SUCCESS;
1058
1059	Assert(VALID_PTR(pImage));
1060	Assert(!(uOffset % 512));
1061	Assert(!(cbToWrite % 512));
1062
1063	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1064	{
1065	rc = VERR_VDI_IMAGE_READ_ONLY;
1066	goto out;
1067	}
1068
1069	if (!VALID_PTR(pvBuf) \|\| !cbToWrite)
1070	{
1071	rc = VERR_INVALID_PARAMETER;
1072	goto out;
1073	}
1074
1075	/* No size check here, will do that later. For dynamic images which are
1076	* not multiples of the block size in length, this would prevent writing to
1077	* the last grain. */
1078
1079	/* Calculate starting block number and offset inside it. */
1080	uBlock = (unsigned)(uOffset >> pImage->uShiftOffset2Index);
1081	offWrite = (unsigned)uOffset & pImage->uBlockMask;
1082
1083	/* Clip write range to at most the rest of the block. */
1084	cbToWrite = RT_MIN(cbToWrite, getImageBlockSize(&pImage->Header) - offWrite);
1085	Assert(!(cbToWrite % 512));
1086
1087	if (!IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
1088	{
1089	/* Block is either free or zero. */
1090	if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_ZEROES)
1091	&& ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
1092	\|\| cbToWrite == getImageBlockSize(&pImage->Header)))
1093	{
1094	/* If the destination block is unallocated at this point, it's
1095	* either a zero block or a block which hasn't been used so far
1096	* (which also means that it's a zero block. Don't need to write
1097	* anything to this block if the data consists of just zeroes. */
1098	Assert(!(cbToWrite % 4));
1099	Assert(cbToWrite * 8 <= UINT32_MAX);
1100	if (ASMBitFirstSet((volatile void )pvBuf, (uint32_t)cbToWrite 8) == -1)
1101	{
1102	pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1103	goto out;
1104	}
1105	}
1106
1107	if (cbToWrite == getImageBlockSize(&pImage->Header))
1108	{
1109	/* Full block write to previously unallocated block.
1110	* Allocate block and write data. */
1111	Assert(!offWrite);
1112	unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
1113	uint64_t u64Offset = (uint64_t)cBlocksAllocated * pImage->cbTotalBlockData
1114	+ (pImage->offStartData + pImage->offStartBlockData);
1115	rc = RTFileWriteAt(pImage->File, u64Offset, pvBuf, cbToWrite, NULL);
1116	if (RT_FAILURE(rc))
1117	goto out;
1118	pImage->paBlocks[uBlock] = cBlocksAllocated;
1119	setImageBlocksAllocated(&pImage->Header, cBlocksAllocated + 1);
1120
1121	rc = vdiUpdateBlockInfo(pImage, uBlock);
1122	if (RT_FAILURE(rc))
1123	goto out;
1124
1125	*pcbPreRead = 0;
1126	*pcbPostRead = 0;
1127	}
1128	else
1129	{
1130	/* Trying to do a partial write to an unallocated block. Don't do
1131	* anything except letting the upper layer know what to do. */
1132	*pcbPreRead = offWrite % getImageBlockSize(&pImage->Header);
1133	pcbPostRead = getImageBlockSize(&pImage->Header) - cbToWrite - pcbPreRead;
1134	rc = VERR_VDI_BLOCK_FREE;
1135	}
1136	}
1137	else
1138	{
1139	/* Block present in image file, write relevant data. */
1140	uint64_t u64Offset = (uint64_t)pImage->paBlocks[uBlock] * pImage->cbTotalBlockData
1141	+ (pImage->offStartData + pImage->offStartBlockData + offWrite);
1142	rc = RTFileWriteAt(pImage->File, u64Offset, pvBuf, cbToWrite, NULL);
1143	}
1144	if (pcbWriteProcess)
1145	*pcbWriteProcess = cbToWrite;
1146
1147	out:
1148	LogFlowFunc(("returns %Rrc\n", rc));
1149	return rc;
1150	}
1151
1152	/** @copydoc VBOXHDDBACKEND::pfnFlush */
1153	static int vdiFlush(void *pBackendData)
1154	{
1155	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1156	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1157	int rc = VINF_SUCCESS;
1158
1159	Assert(pImage);
1160
1161	vdiFlushImage(pImage);
1162	LogFlowFunc(("returns %Rrc\n", rc));
1163	return rc;
1164	}
1165
1166	/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
1167	static unsigned vdiGetVersion(void *pBackendData)
1168	{
1169	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1170	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1171	unsigned uVersion;
1172
1173	Assert(VALID_PTR(pImage));
1174
1175	if (pImage)
1176	uVersion = pImage->PreHeader.u32Version;
1177	else
1178	uVersion = 0;
1179
1180	LogFlowFunc(("returns %#x\n", uVersion));
1181	return uVersion;
1182	}
1183
1184	/** @copydoc VBOXHDDBACKEND::pfnGetImageType */
1185	static int vdiGetImageType(void *pBackendData, PVDIMAGETYPE penmImageType)
1186	{
1187	LogFlowFunc(("pBackendData=%#p penmImageType=%#p\n", pBackendData, penmImageType));
1188	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1189	int rc = VINF_SUCCESS;
1190
1191	Assert(VALID_PTR(pImage));
1192	Assert(VALID_PTR(penmImageType));
1193
1194	if (pImage)
1195	*penmImageType = vdiTranslateTypeVDI2VD(getImageType(&pImage->Header));
1196	else
1197	rc = VERR_VDI_NOT_OPENED;
1198
1199	LogFlowFunc(("returns %Rrc enmImageType=%u\n", rc, *penmImageType));
1200	return rc;
1201	}
1202
1203	/** @copydoc VBOXHDDBACKEND::pfnGetSize */
1204	static uint64_t vdiGetSize(void *pBackendData)
1205	{
1206	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1207	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1208	uint64_t cbSize;
1209
1210	Assert(VALID_PTR(pImage));
1211
1212	if (pImage)
1213	cbSize = getImageDiskSize(&pImage->Header);
1214	else
1215	cbSize = 0;
1216
1217	LogFlowFunc(("returns %llu\n", cbSize));
1218	return cbSize;
1219	}
1220
1221	/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
1222	static uint64_t vdiGetFileSize(void *pBackendData)
1223	{
1224	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1225	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1226	uint64_t cb = 0;
1227
1228	Assert(VALID_PTR(pImage));
1229
1230	if (pImage)
1231	{
1232	uint64_t cbFile;
1233	if (pImage->File != NIL_RTFILE)
1234	{
1235	int rc = RTFileGetSize(pImage->File, &cbFile);
1236	if (RT_SUCCESS(rc))
1237	cb += cbFile;
1238	}
1239	}
1240
1241	LogFlowFunc(("returns %lld\n", cb));
1242	return cb;
1243	}
1244
1245	/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
1246	static int vdiGetPCHSGeometry(void *pBackendData,
1247	PPDMMEDIAGEOMETRY pPCHSGeometry)
1248	{
1249	LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
1250	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1251	int rc;
1252
1253	Assert(VALID_PTR(pImage));
1254
1255	if (pImage)
1256	{
1257	if (pImage->PCHSGeometry.cCylinders)
1258	{
1259	*pPCHSGeometry = pImage->PCHSGeometry;
1260	rc = VINF_SUCCESS;
1261	}
1262	else
1263	rc = VERR_VDI_GEOMETRY_NOT_SET;
1264	}
1265	else
1266	rc = VERR_VDI_NOT_OPENED;
1267
1268	LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1269	return rc;
1270	}
1271
1272	/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
1273	static int vdiSetPCHSGeometry(void *pBackendData,
1274	PCPDMMEDIAGEOMETRY pPCHSGeometry)
1275	{
1276	LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1277	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1278	int rc;
1279
1280	Assert(VALID_PTR(pImage));
1281
1282	if (pImage)
1283	{
1284	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1285	{
1286	rc = VERR_VDI_IMAGE_READ_ONLY;
1287	goto out;
1288	}
1289
1290	pImage->PCHSGeometry = *pPCHSGeometry;
1291	rc = VINF_SUCCESS;
1292	}
1293	else
1294	rc = VERR_VDI_NOT_OPENED;
1295
1296	out:
1297	LogFlowFunc(("returns %Rrc\n", rc));
1298	return rc;
1299	}
1300
1301	/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
1302	static int vdiGetLCHSGeometry(void *pBackendData,
1303	PPDMMEDIAGEOMETRY pLCHSGeometry)
1304	{
1305	LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
1306	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1307	int rc;
1308
1309	Assert(VALID_PTR(pImage));
1310
1311	if (pImage)
1312	{
1313	VDIDISKGEOMETRY DummyGeo = { 0, 0, 0, VDI_GEOMETRY_SECTOR_SIZE };
1314	PVDIDISKGEOMETRY pGeometry = getImageLCHSGeometry(&pImage->Header);
1315	if (!pGeometry)
1316	pGeometry = &DummyGeo;
1317
1318	if ( pGeometry->cCylinders > 0
1319	&& pGeometry->cHeads > 0
1320	&& pGeometry->cSectors > 0)
1321	{
1322	pLCHSGeometry->cCylinders = pGeometry->cCylinders;
1323	pLCHSGeometry->cHeads = pGeometry->cHeads;
1324	pLCHSGeometry->cSectors = pGeometry->cSectors;
1325	rc = VINF_SUCCESS;
1326	}
1327	else
1328	rc = VERR_VDI_GEOMETRY_NOT_SET;
1329	}
1330	else
1331	rc = VERR_VDI_NOT_OPENED;
1332
1333	LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1334	return rc;
1335	}
1336
1337	/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
1338	static int vdiSetLCHSGeometry(void *pBackendData,
1339	PCPDMMEDIAGEOMETRY pLCHSGeometry)
1340	{
1341	LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
1342	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1343	PVDIDISKGEOMETRY pGeometry;
1344	int rc;
1345
1346	Assert(VALID_PTR(pImage));
1347
1348	if (pImage)
1349	{
1350	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1351	{
1352	rc = VERR_VDI_IMAGE_READ_ONLY;
1353	goto out;
1354	}
1355
1356	pGeometry = getImageLCHSGeometry(&pImage->Header);
1357	if (pGeometry)
1358	{
1359	pGeometry->cCylinders = pLCHSGeometry->cCylinders;
1360	pGeometry->cHeads = pLCHSGeometry->cHeads;
1361	pGeometry->cSectors = pLCHSGeometry->cSectors;
1362	pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
1363
1364	/* Update header information in base image file. */
1365	vdiFlushImage(pImage);
1366	}
1367	rc = VINF_SUCCESS;
1368	}
1369	else
1370	rc = VERR_VDI_NOT_OPENED;
1371
1372	out:
1373	LogFlowFunc(("returns %Rrc\n", rc));
1374	return rc;
1375	}
1376
1377	/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
1378	static unsigned vdiGetImageFlags(void *pBackendData)
1379	{
1380	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1381	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1382	unsigned uImageFlags;
1383
1384	Assert(VALID_PTR(pImage));
1385
1386	if (pImage)
1387	uImageFlags = pImage->uImageFlags;
1388	else
1389	uImageFlags = 0;
1390
1391	LogFlowFunc(("returns %#x\n", uImageFlags));
1392	return uImageFlags;
1393	}
1394
1395	/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
1396	static unsigned vdiGetOpenFlags(void *pBackendData)
1397	{
1398	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1399	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1400	unsigned uOpenFlags;
1401
1402	Assert(VALID_PTR(pImage));
1403
1404	if (pImage)
1405	uOpenFlags = pImage->uOpenFlags;
1406	else
1407	uOpenFlags = 0;
1408
1409	LogFlowFunc(("returns %#x\n", uOpenFlags));
1410	return uOpenFlags;
1411	}
1412
1413	/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
1414	static int vdiSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
1415	{
1416	LogFlowFunc(("pBackendData=%#p\n uOpenFlags=%#x", pBackendData, uOpenFlags));
1417	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1418	int rc;
1419	const char *pszFilename;
1420
1421	/* Image must be opened and the new flags must be valid. Just readonly flag
1422	* is supported. */
1423	if (!pImage \|\| uOpenFlags & ~VD_OPEN_FLAGS_READONLY)
1424	{
1425	rc = VERR_INVALID_PARAMETER;
1426	goto out;
1427	}
1428
1429	/* Implement this operation via reopening the image. */
1430	pszFilename = pImage->pszFilename;
1431	vdiFreeImage(pImage, false);
1432	rc = vdiOpenImage(pImage, uOpenFlags);
1433
1434	out:
1435	LogFlowFunc(("returns %Rrc\n", rc));
1436	return rc;
1437	}
1438
1439	/** @copydoc VBOXHDDBACKEND::pfnGetComment */
1440	static int vdiGetComment(void pBackendData, char pszComment,
1441	size_t cbComment)
1442	{
1443	LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
1444	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1445	int rc = VINF_SUCCESS;
1446
1447	Assert(VALID_PTR(pImage));
1448
1449	if (pImage)
1450	{
1451	char *pszTmp = getImageComment(&pImage->Header);
1452	unsigned cb = strlen(pszTmp);
1453	if (cb < cbComment)
1454	{
1455	/* memcpy is much better than strncpy. */
1456	memcpy(pszComment, pszTmp, cb + 1);
1457	}
1458	else
1459	rc = VERR_BUFFER_OVERFLOW;
1460	}
1461	else
1462	rc = VERR_VDI_NOT_OPENED;
1463
1464	LogFlowFunc(("returns %Rrc comment=\"%s\"\n", rc, pszComment));
1465	return rc;
1466	}
1467
1468	/** @copydoc VBOXHDDBACKEND::pfnGetComment */
1469	static int vdiSetComment(void pBackendData, const char pszComment)
1470	{
1471	LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
1472	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1473	int rc;
1474
1475	Assert(VALID_PTR(pImage));
1476
1477	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1478	{
1479	rc = VERR_VDI_IMAGE_READ_ONLY;
1480	goto out;
1481	}
1482
1483	if (pImage)
1484	{
1485	size_t cchComment = pszComment ? strlen(pszComment) : 0;
1486	if (cchComment >= VDI_IMAGE_COMMENT_SIZE)
1487	{
1488	LogFunc(("pszComment is too long, %d bytes!\n", cchComment));
1489	rc = VERR_VDI_COMMENT_TOO_LONG;
1490	goto out;
1491	}
1492
1493	/* we don't support old style images */
1494	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1495	{
1496	/*
1497	* Update the comment field, making sure to zero out all of the previous comment.
1498	*/
1499	memset(pImage->Header.u.v1.szComment, '\0', VDI_IMAGE_COMMENT_SIZE);
1500	memcpy(pImage->Header.u.v1.szComment, pszComment, cchComment);
1501
1502	/* write out new the header */
1503	rc = vdiUpdateHeader(pImage);
1504	}
1505	else
1506	rc = VERR_VDI_UNSUPPORTED_VERSION;
1507	}
1508	else
1509	rc = VERR_VDI_NOT_OPENED;
1510
1511	out:
1512	LogFlowFunc(("returns %Rrc\n", rc));
1513	return rc;
1514	}
1515
1516	/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
1517	static int vdiGetUuid(void *pBackendData, PRTUUID pUuid)
1518	{
1519	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1520	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1521	int rc;
1522
1523	Assert(VALID_PTR(pImage));
1524
1525	if (pImage)
1526	{
1527	pUuid = getImageCreationUUID(&pImage->Header);
1528	rc = VINF_SUCCESS;
1529	}
1530	else
1531	rc = VERR_VDI_NOT_OPENED;
1532
1533	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1534	return rc;
1535	}
1536
1537	/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
1538	static int vdiSetUuid(void *pBackendData, PCRTUUID pUuid)
1539	{
1540	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1541	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1542	int rc = VINF_SUCCESS;
1543
1544	Assert(VALID_PTR(pImage));
1545
1546	if (pImage)
1547	{
1548	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1549	{
1550	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1551	pImage->Header.u.v1.uuidCreate = *pUuid;
1552	/* Make it possible to clone old VDIs. */
1553	else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1554	pImage->Header.u.v0.uuidCreate = *pUuid;
1555	else
1556	{
1557	LogFunc(("Version is not supported!\n"));
1558	rc = VERR_VDI_UNSUPPORTED_VERSION;
1559	}
1560	}
1561	else
1562	rc = VERR_VDI_IMAGE_READ_ONLY;
1563	}
1564	else
1565	rc = VERR_VDI_NOT_OPENED;
1566
1567	LogFlowFunc(("returns %Rrc\n", rc));
1568	return rc;
1569	}
1570
1571	/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
1572	static int vdiGetModificationUuid(void *pBackendData, PRTUUID pUuid)
1573	{
1574	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1575	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1576	int rc;
1577
1578	Assert(VALID_PTR(pImage));
1579
1580	if (pImage)
1581	{
1582	pUuid = getImageModificationUUID(&pImage->Header);
1583	rc = VINF_SUCCESS;
1584	}
1585	else
1586	rc = VERR_VDI_NOT_OPENED;
1587
1588	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1589	return rc;
1590	}
1591
1592	/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
1593	static int vdiSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
1594	{
1595	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1596	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1597	int rc = VINF_SUCCESS;
1598
1599	Assert(VALID_PTR(pImage));
1600
1601	if (pImage)
1602	{
1603	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1604	{
1605	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1606	pImage->Header.u.v1.uuidModify = *pUuid;
1607	/* Make it possible to clone old VDIs. */
1608	else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1609	pImage->Header.u.v0.uuidModify = *pUuid;
1610	else
1611	{
1612	LogFunc(("Version is not supported!\n"));
1613	rc = VERR_VDI_UNSUPPORTED_VERSION;
1614	}
1615	}
1616	else
1617	rc = VERR_VDI_IMAGE_READ_ONLY;
1618	}
1619	else
1620	rc = VERR_VDI_NOT_OPENED;
1621
1622	LogFlowFunc(("returns %Rrc\n", rc));
1623	return rc;
1624	}
1625
1626	/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
1627	static int vdiGetParentUuid(void *pBackendData, PRTUUID pUuid)
1628	{
1629	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1630	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1631	int rc;
1632
1633	Assert(VALID_PTR(pImage));
1634
1635	if (pImage)
1636	{
1637	pUuid = getImageParentUUID(&pImage->Header);
1638	rc = VINF_SUCCESS;
1639	}
1640	else
1641	rc = VERR_VDI_NOT_OPENED;
1642
1643	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1644	return rc;
1645	}
1646
1647	/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
1648	static int vdiSetParentUuid(void *pBackendData, PCRTUUID pUuid)
1649	{
1650	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1651	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1652	int rc = VINF_SUCCESS;
1653
1654	Assert(VALID_PTR(pImage));
1655
1656	if (pImage)
1657	{
1658	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1659	{
1660	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1661	pImage->Header.u.v1.uuidLinkage = *pUuid;
1662	/* Make it possible to clone old VDIs. */
1663	else if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 0)
1664	pImage->Header.u.v0.uuidLinkage = *pUuid;
1665	else
1666	{
1667	LogFunc(("Version is not supported!\n"));
1668	rc = VERR_VDI_UNSUPPORTED_VERSION;
1669	}
1670	}
1671	else
1672	rc = VERR_VDI_IMAGE_READ_ONLY;
1673	}
1674	else
1675	rc = VERR_VDI_NOT_OPENED;
1676
1677	LogFlowFunc(("returns %Rrc\n", rc));
1678	return rc;
1679	}
1680
1681	/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
1682	static int vdiGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
1683	{
1684	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
1685	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1686	int rc;
1687
1688	Assert(VALID_PTR(pImage));
1689
1690	if (pImage)
1691	{
1692	pUuid = getImageParentModificationUUID(&pImage->Header);
1693	rc = VINF_SUCCESS;
1694	}
1695	else
1696	rc = VERR_VDI_NOT_OPENED;
1697
1698	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
1699	return rc;
1700	}
1701
1702	/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
1703	static int vdiSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
1704	{
1705	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
1706	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1707	int rc = VINF_SUCCESS;
1708
1709	Assert(VALID_PTR(pImage));
1710
1711	if (pImage)
1712	{
1713	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1714	{
1715	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1716	pImage->Header.u.v1.uuidParentModify = *pUuid;
1717	else
1718	{
1719	LogFunc(("Version is not supported!\n"));
1720	rc = VERR_VDI_UNSUPPORTED_VERSION;
1721	}
1722	}
1723	else
1724	rc = VERR_VDI_IMAGE_READ_ONLY;
1725	}
1726	else
1727	rc = VERR_VDI_NOT_OPENED;
1728
1729	LogFlowFunc(("returns %Rrc\n", rc));
1730	return rc;
1731	}
1732
1733	/** @copydoc VBOXHDDBACKEND::pfnDump */
1734	static void vdiDump(void *pBackendData)
1735	{
1736	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)pBackendData;
1737
1738	RTLogPrintf("Dumping VDI image \"%s\" mode=%s uOpenFlags=%X File=%08X\n",
1739	pImage->pszFilename,
1740	(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY) ? "r/o" : "r/w",
1741	pImage->uOpenFlags,
1742	pImage->File);
1743	RTLogPrintf("Header: Version=%08X Type=%X Flags=%X Size=%llu\n",
1744	pImage->PreHeader.u32Version,
1745	getImageType(&pImage->Header),
1746	getImageFlags(&pImage->Header),
1747	getImageDiskSize(&pImage->Header));
1748	RTLogPrintf("Header: cbBlock=%u cbBlockExtra=%u cBlocks=%u cBlocksAllocated=%u\n",
1749	getImageBlockSize(&pImage->Header),
1750	getImageExtraBlockSize(&pImage->Header),
1751	getImageBlocks(&pImage->Header),
1752	getImageBlocksAllocated(&pImage->Header));
1753	RTLogPrintf("Header: offBlocks=%u offData=%u\n",
1754	getImageBlocksOffset(&pImage->Header),
1755	getImageDataOffset(&pImage->Header));
1756	PVDIDISKGEOMETRY pg = getImageLCHSGeometry(&pImage->Header);
1757	if (pg)
1758	RTLogPrintf("Header: Geometry: C/H/S=%u/%u/%u cbSector=%u\n",
1759	pg->cCylinders, pg->cHeads, pg->cSectors, pg->cbSector);
1760	RTLogPrintf("Header: uuidCreation={%RTuuid}\n", getImageCreationUUID(&pImage->Header));
1761	RTLogPrintf("Header: uuidModification={%RTuuid}\n", getImageModificationUUID(&pImage->Header));
1762	RTLogPrintf("Header: uuidParent={%RTuuid}\n", getImageParentUUID(&pImage->Header));
1763	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) >= 1)
1764	RTLogPrintf("Header: uuidParentModification={%RTuuid}\n", getImageParentModificationUUID(&pImage->Header));
1765	RTLogPrintf("Image: fFlags=%08X offStartBlocks=%u offStartData=%u\n",
1766	pImage->uImageFlags, pImage->offStartBlocks, pImage->offStartData);
1767	RTLogPrintf("Image: uBlockMask=%08X cbTotalBlockData=%u uShiftOffset2Index=%u offStartBlockData=%u\n",
1768	pImage->uBlockMask,
1769	pImage->cbTotalBlockData,
1770	pImage->uShiftOffset2Index,
1771	pImage->offStartBlockData);
1772
1773	unsigned uBlock, cBlocksNotFree, cBadBlocks, cBlocks = getImageBlocks(&pImage->Header);
1774	for (uBlock=0, cBlocksNotFree=0, cBadBlocks=0; uBlock<cBlocks; uBlock++)
1775	{
1776	if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
1777	{
1778	cBlocksNotFree++;
1779	if (pImage->paBlocks[uBlock] >= cBlocks)
1780	cBadBlocks++;
1781	}
1782	}
1783	if (cBlocksNotFree != getImageBlocksAllocated(&pImage->Header))
1784	{
1785	RTLogPrintf("!! WARNING: %u blocks actually allocated (cBlocksAllocated=%u) !!\n",
1786	cBlocksNotFree, getImageBlocksAllocated(&pImage->Header));
1787	}
1788	if (cBadBlocks)
1789	{
1790	RTLogPrintf("!! WARNING: %u bad blocks found !!\n",
1791	cBadBlocks);
1792	}
1793	}
1794
1795	static int vdiGetTimeStamp(void *pvBackendData, PRTTIMESPEC pTimeStamp)
1796	{
1797	int rc = VERR_NOT_IMPLEMENTED;
1798	LogFlow(("%s: returned %Rrc\n", __FUNCTION__, rc));
1799	return rc;
1800	}
1801
1802	static int vdiGetParentTimeStamp(void *pvBackendData, PRTTIMESPEC pTimeStamp)
1803	{
1804	int rc = VERR_NOT_IMPLEMENTED;
1805	LogFlow(("%s: returned %Rrc\n", __FUNCTION__, rc));
1806	return rc;
1807	}
1808
1809	static int vdiSetParentTimeStamp(void *pvBackendData, PCRTTIMESPEC pTimeStamp)
1810	{
1811	int rc = VERR_NOT_IMPLEMENTED;
1812	LogFlow(("%s: returned %Rrc\n", __FUNCTION__, rc));
1813	return rc;
1814	}
1815
1816	static int vdiGetParentFilename(void pvBackendData, char *ppszParentFilename)
1817	{
1818	int rc = VERR_NOT_IMPLEMENTED;
1819	LogFlow(("%s: returned %Rrc\n", __FUNCTION__, rc));
1820	return rc;
1821	}
1822
1823	static int vdiSetParentFilename(void pvBackendData, const char pszParentFilename)
1824	{
1825	int rc = VERR_NOT_IMPLEMENTED;
1826	LogFlow(("%s: returned %Rrc\n", __FUNCTION__, rc));
1827	return rc;
1828	}
1829
1830	static bool vdiIsAsyncIOSupported(void *pvBackendData)
1831	{
1832	return false;
1833	}
1834
1835	static int vdiAsyncRead(void *pvBackendData, uint64_t uOffset, size_t cbRead,
1836	PPDMDATASEG paSeg, unsigned cSeg, void *pvUser)
1837	{
1838	int rc = VERR_NOT_IMPLEMENTED;
1839	LogFlowFunc(("returns %Rrc\n", rc));
1840	return rc;
1841	}
1842
1843	static int vdiAsyncWrite(void *pvBackendData, uint64_t uOffset, size_t cbWrite,
1844	PPDMDATASEG paSeg, unsigned cSeg, void *pvUser)
1845	{
1846	int rc = VERR_NOT_IMPLEMENTED;
1847	LogFlowFunc(("returns %Rrc\n", rc));
1848	return rc;
1849	}
1850
1851
1852	VBOXHDDBACKEND g_VDIBackend =
1853	{
1854	/* pszBackendName */
1855	"VDI",
1856	/* cbSize */
1857	sizeof(VBOXHDDBACKEND),
1858	/* uBackendCaps */
1859	VD_CAP_UUID \| VD_CAP_CREATE_FIXED \| VD_CAP_CREATE_DYNAMIC
1860	\| VD_CAP_CREATE_SPLIT_2G \| VD_CAP_DIFF \| VD_CAP_FILE,
1861	/* papszFileExtensions */
1862	s_apszVdiFileExtensions,
1863	/* paConfigInfo */
1864	NULL,
1865	/* pfnCheckIfValid */
1866	vdiCheckIfValid,
1867	/* pfnOpen */
1868	vdiOpen,
1869	/* pfnCreate */
1870	vdiCreate,
1871	/* pfnRename */
1872	vdiRename,
1873	/* pfnClose */
1874	vdiClose,
1875	/* pfnRead */
1876	vdiRead,
1877	/* pfnWrite */
1878	vdiWrite,
1879	/* pfnFlush */
1880	vdiFlush,
1881	/* pfnGetVersion */
1882	vdiGetVersion,
1883	/* pfnGetImageType */
1884	vdiGetImageType,
1885	/* pfnGetSize */
1886	vdiGetSize,
1887	/* pfnGetFileSize */
1888	vdiGetFileSize,
1889	/* pfnGetPCHSGeometry */
1890	vdiGetPCHSGeometry,
1891	/* pfnSetPCHSGeometry */
1892	vdiSetPCHSGeometry,
1893	/* pfnGetLCHSGeometry */
1894	vdiGetLCHSGeometry,
1895	/* pfnSetLCHSGeometry */
1896	vdiSetLCHSGeometry,
1897	/* pfnGetImageFlags */
1898	vdiGetImageFlags,
1899	/* pfnGetOpenFlags */
1900	vdiGetOpenFlags,
1901	/* pfnSetOpenFlags */
1902	vdiSetOpenFlags,
1903	/* pfnGetComment */
1904	vdiGetComment,
1905	/* pfnSetComment */
1906	vdiSetComment,
1907	/* pfnGetUuid */
1908	vdiGetUuid,
1909	/* pfnSetUuid */
1910	vdiSetUuid,
1911	/* pfnGetModificationUuid */
1912	vdiGetModificationUuid,
1913	/* pfnSetModificationUuid */
1914	vdiSetModificationUuid,
1915	/* pfnGetParentUuid */
1916	vdiGetParentUuid,
1917	/* pfnSetParentUuid */
1918	vdiSetParentUuid,
1919	/* pfnGetParentModificationUuid */
1920	vdiGetParentModificationUuid,
1921	/* pfnSetParentModificationUuid */
1922	vdiSetParentModificationUuid,
1923	/* pfnDump */
1924	vdiDump,
1925	/* pfnGetTimeStamp */
1926	vdiGetTimeStamp,
1927	/* pfnGetParentTimeStamp */
1928	vdiGetParentTimeStamp,
1929	/* pfnSetParentTimeStamp */
1930	vdiSetParentTimeStamp,
1931	/* pfnGetParentFilename */
1932	vdiGetParentFilename,
1933	/* pfnSetParentFilename */
1934	vdiSetParentFilename,
1935	/* pfnIsAsyncIOSupported */
1936	vdiIsAsyncIOSupported,
1937	/* pfnAsyncRead */
1938	vdiAsyncRead,
1939	/* pfnAsyncWrite */
1940	vdiAsyncWrite
1941	};
1942

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: