VDICore.cpp@ 2392

Last change on this file since 2392 was 1566, checked in by vboxsync, 18 years ago
VBOXDDU_DECL & IN_VBOXDDU
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 126.6 KB

Line
1	/** @file
2	* Virtual Disk Image (VDI), Core Code.
3	*/
4
5	/*
6	* Copyright (C) 2006 InnoTek Systemberatung GmbH
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 as published by the Free Software Foundation,
12	* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13	* distribution. VirtualBox OSE is distributed in the hope that it will
14	* be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* If you received this file as part of a commercial VirtualBox
17	* distribution, then only the terms of your commercial VirtualBox
18	* license agreement apply instead of the previous paragraph.
19	*/
20
21	/*******************************************************************************
22	* Header Files *
23	*******************************************************************************/
24	#define LOG_GROUP LOG_GROUP_DRV_VBOXHDD
25	#include <VBox/VBoxHDD.h>
26	#include "VDICore.h"
27	#include <VBox/err.h>
28
29	#include <VBox/log.h>
30	#include <iprt/alloc.h>
31	#include <iprt/assert.h>
32	#include <iprt/uuid.h>
33	#include <iprt/file.h>
34	#include <iprt/string.h>
35	#include <iprt/asm.h>
36
37
38	/*******************************************************************************
39	* Internal Functions *
40	*******************************************************************************/
41	static unsigned getPowerOfTwo(unsigned uNumber);
42	static void vdiInitPreHeader(PVDIPREHEADER pPreHdr);
43	static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr);
44	static void vdiInitHeader(PVDIHEADER pHeader, VDIIMAGETYPE enmType, uint32_t fFlags,
45	const char *pszComment, uint64_t cbDisk, uint32_t cbBlock,
46	uint32_t cbBlockExtra);
47	static int vdiValidateHeader(PVDIHEADER pHeader);
48	static int vdiCreateImage(const char *pszFilename, VDIIMAGETYPE enmType, unsigned fFlags,
49	uint64_t cbSize, const char *pszComment, PVDIIMAGEDESC pParent,
50	PFNVMPROGRESS pfnProgress, void *pvUser);
51	static void vdiInitImageDesc(PVDIIMAGEDESC pImage);
52	static void vdiSetupImageDesc(PVDIIMAGEDESC pImage);
53	static int vdiOpenImage(PVDIIMAGEDESC ppImage, const char pszFilename, unsigned fOpen,
54	PVDIIMAGEDESC pParent);
55	static int vdiUpdateHeader(PVDIIMAGEDESC pImage);
56	static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock);
57	static int vdiUpdateBlocks(PVDIIMAGEDESC pImage);
58	static void vdiSetModifiedFlag(PVDIIMAGEDESC pImage);
59	static void vdiResetModifiedFlag(PVDIIMAGEDESC pImage);
60	static void vdiDisableLastModifiedUpdate(PVDIIMAGEDESC pImage);
61	#if 0 /* unused */
62	static void vdiEnableLastModifiedUpdate(PVDIIMAGEDESC pImage);
63	#endif
64	static void vdiCloseImage(PVDIIMAGEDESC pImage);
65	static int vdiReadInBlock(PVDIIMAGEDESC pImage, unsigned uBlock, unsigned offRead,
66	unsigned cbToRead, void *pvBuf);
67	static int vdiFillBlockByZeroes(PVDIDISK pDisk, PVDIIMAGEDESC pImage, unsigned uBlock);
68	static int vdiWriteInBlock(PVDIDISK pDisk, PVDIIMAGEDESC pImage, unsigned uBlock,
69	unsigned offWrite, unsigned cbToWrite, const void *pvBuf);
70	static int vdiCopyBlock(PVDIDISK pDisk, PVDIIMAGEDESC pImage, unsigned uBlock);
71	static int vdiMergeImages(PVDIIMAGEDESC pImageFrom, PVDIIMAGEDESC pImageTo, bool fParentToChild,
72	PFNVMPROGRESS pfnProgress, void *pvUser);
73	static void vdiAddImageToList(PVDIDISK pDisk, PVDIIMAGEDESC pImage);
74	static void vdiRemoveImageFromList(PVDIDISK pDisk, PVDIIMAGEDESC pImage);
75	static PVDIIMAGEDESC vdiGetImageByNumber(PVDIDISK pDisk, int nImage);
76	static int vdiUpdateReadOnlyHeader(PVDIIMAGEDESC pImage);
77
78	static int vdiCommitToImage(PVDIDISK pDisk, PVDIIMAGEDESC pDstImage,
79	PFNVMPROGRESS pfnProgress, void *pvUser);
80	static void vdiDumpImage(PVDIIMAGEDESC pImage);
81
82
83	/**
84	* internal: return power of 2 or 0 if num error.
85	*/
86	static unsigned getPowerOfTwo(unsigned uNumber)
87	{
88	if (uNumber == 0)
89	return 0;
90	unsigned uPower2 = 0;
91	while ((uNumber & 1) == 0)
92	{
93	uNumber >>= 1;
94	uPower2++;
95	}
96	return uNumber == 1 ? uPower2 : 0;
97	}
98
99	/**
100	* internal: init HDD preheader.
101	*/
102	static void vdiInitPreHeader(PVDIPREHEADER pPreHdr)
103	{
104	pPreHdr->u32Signature = VDI_IMAGE_SIGNATURE;
105	pPreHdr->u32Version = VDI_IMAGE_VERSION;
106	memset(pPreHdr->szFileInfo, 0, sizeof(pPreHdr->szFileInfo));
107	strncat(pPreHdr->szFileInfo, VDI_IMAGE_FILE_INFO, sizeof(pPreHdr->szFileInfo));
108	}
109
110	/**
111	* internal: check HDD preheader.
112	*/
113	static int vdiValidatePreHeader(PVDIPREHEADER pPreHdr)
114	{
115	if (pPreHdr->u32Signature != VDI_IMAGE_SIGNATURE)
116	return VERR_VDI_INVALID_SIGNATURE;
117
118	if ( pPreHdr->u32Version != VDI_IMAGE_VERSION
119	&& pPreHdr->u32Version != 0x00000002) /* old version. */
120	return VERR_VDI_UNSUPPORTED_VERSION;
121
122	return VINF_SUCCESS;
123	}
124
125	/**
126	* internal: init HDD header. Always use latest header version.
127	* @param pHeader Assumes it was initially initialized to all zeros.
128	*/
129	static void vdiInitHeader(PVDIHEADER pHeader, VDIIMAGETYPE enmType, uint32_t fFlags,
130	const char *pszComment, uint64_t cbDisk, uint32_t cbBlock,
131	uint32_t cbBlockExtra)
132	{
133	pHeader->uVersion = VDI_IMAGE_VERSION;
134	pHeader->u.v1.cbHeader = sizeof(VDIHEADER1);
135	pHeader->u.v1.u32Type = (uint32_t)enmType;
136	pHeader->u.v1.fFlags = fFlags;
137	#ifdef VBOX_STRICT
138	char achZero[VDI_IMAGE_COMMENT_SIZE] = {0};
139	Assert(!memcmp(pHeader->u.v1.szComment, achZero, VDI_IMAGE_COMMENT_SIZE));
140	#endif
141	pHeader->u.v1.szComment[0] = '\0';
142	if (pszComment)
143	{
144	AssertMsg(strlen(pszComment) < sizeof(pHeader->u.v1.szComment),
145	("HDD Comment is too long, cb=%d\n", strlen(pszComment)));
146	strncat(pHeader->u.v1.szComment, pszComment, sizeof(pHeader->u.v1.szComment));
147	}
148
149	/* Mark the geometry not-calculated. */
150	pHeader->u.v1.Geometry.cCylinders = 0;
151	pHeader->u.v1.Geometry.cHeads = 0;
152	pHeader->u.v1.Geometry.cSectors = 0;
153	pHeader->u.v1.Geometry.cbSector = VDI_GEOMETRY_SECTOR_SIZE;
154	pHeader->u.v1.u32Translation = PDMBIOSTRANSLATION_AUTO;
155
156	pHeader->u.v1.cbDisk = cbDisk;
157	pHeader->u.v1.cbBlock = cbBlock;
158	pHeader->u.v1.cBlocks = (uint32_t)(cbDisk / cbBlock);
159	if (cbDisk % cbBlock)
160	pHeader->u.v1.cBlocks++;
161	pHeader->u.v1.cbBlockExtra = cbBlockExtra;
162	pHeader->u.v1.cBlocksAllocated = 0;
163
164	/* Init offsets. */
165	pHeader->u.v1.offBlocks = RT_ALIGN_32(sizeof(VDIPREHEADER) + sizeof(VDIHEADER1), VDI_GEOMETRY_SECTOR_SIZE);
166	pHeader->u.v1.offData = RT_ALIGN_32(pHeader->u.v1.offBlocks + (pHeader->u.v1.cBlocks * sizeof(VDIIMAGEBLOCKPOINTER)), VDI_GEOMETRY_SECTOR_SIZE);
167
168	/* Init uuids. */
169	RTUuidCreate(&pHeader->u.v1.uuidCreate);
170	RTUuidClear(&pHeader->u.v1.uuidModify);
171	RTUuidClear(&pHeader->u.v1.uuidLinkage);
172	RTUuidClear(&pHeader->u.v1.uuidParentModify);
173	}
174
175	/**
176	* internal: check HDD header.
177	*/
178	static int vdiValidateHeader(PVDIHEADER pHeader)
179	{
180	/* Check verion-dependend header parameters. */
181	switch (GET_MAJOR_HEADER_VERSION(pHeader))
182	{
183	case 0:
184	{
185	/* Old header version. */
186	break;
187	}
188	case 1:
189	{
190	/* Current header version. */
191
192	if (pHeader->u.v1.cbHeader < sizeof(VDIHEADER1))
193	{
194	LogRel(("VDI: v1 header size wrong (%d < %d)\n",
195	pHeader->u.v1.cbHeader, sizeof(VDIHEADER1)));
196	return VERR_VDI_INVALID_HEADER;
197	}
198
199	if (getImageBlocksOffset(pHeader) < (sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)))
200	{
201	LogRel(("VDI: v1 blocks offset wrong (%d < %d)\n",
202	getImageBlocksOffset(pHeader), sizeof(VDIPREHEADER) + sizeof(VDIHEADER1)));
203	return VERR_VDI_INVALID_HEADER;
204	}
205
206	if (getImageDataOffset(pHeader) < (getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)))
207	{
208	LogRel(("VDI: v1 image data offset wrong (%d < %d)\n",
209	getImageDataOffset(pHeader), getImageBlocksOffset(pHeader) + getImageBlocks(pHeader) * sizeof(VDIIMAGEBLOCKPOINTER)));
210	return VERR_VDI_INVALID_HEADER;
211	}
212
213	if ( getImageType(pHeader) == VDI_IMAGE_TYPE_UNDO
214	\|\| getImageType(pHeader) == VDI_IMAGE_TYPE_DIFF)
215	{
216	if (RTUuidIsNull(getImageParentUUID(pHeader)))
217	{
218	LogRel(("VDI: v1 uuid of parent is 0)\n"));
219	return VERR_VDI_INVALID_HEADER;
220	}
221	if (RTUuidIsNull(getImageParentModificationUUID(pHeader)))
222	{
223	LogRel(("VDI: v1 uuid of parent modification is 0\n"));
224	return VERR_VDI_INVALID_HEADER;
225	}
226	}
227
228	break;
229	}
230	default:
231	/* Unsupported. */
232	return VERR_VDI_UNSUPPORTED_VERSION;
233	}
234
235	/* Check common header parameters. */
236
237	bool fFailed = false;
238
239	if ( getImageType(pHeader) < VDI_IMAGE_TYPE_FIRST
240	\|\| getImageType(pHeader) > VDI_IMAGE_TYPE_LAST)
241	{
242	LogRel(("VDI: bad image type %d\n", getImageType(pHeader)));
243	fFailed = true;
244	}
245
246	if (getImageFlags(pHeader) & ~VDI_IMAGE_FLAGS_MASK)
247	{
248	LogRel(("VDI: bad image flags %08x\n", getImageFlags(pHeader)));
249	fFailed = true;
250	}
251
252	if ((getImageGeometry(pHeader))->cbSector != VDI_GEOMETRY_SECTOR_SIZE)
253	{
254	LogRel(("VDI: wrong sector size (%d != %d)\n",
255	(getImageGeometry(pHeader))->cbSector, VDI_GEOMETRY_SECTOR_SIZE));
256	fFailed = true;
257	}
258
259	if ( getImageDiskSize(pHeader) == 0
260	\|\| getImageBlockSize(pHeader) == 0
261	\|\| getImageBlocks(pHeader) == 0
262	\|\| getPowerOfTwo(getImageBlockSize(pHeader)) == 0)
263	{
264	LogRel(("VDI: wrong size (%lld, %d, %d, %d)\n",
265	getImageDiskSize(pHeader), getImageBlockSize(pHeader),
266	getImageBlocks(pHeader), getPowerOfTwo(getImageBlockSize(pHeader))));
267	fFailed = true;
268	}
269
270	if (getImageBlocksAllocated(pHeader) > getImageBlocks(pHeader))
271	{
272	LogRel(("VDI: too many blocks allocated (%d > %d)\n"
273	" blocksize=%d disksize=%lld\n",
274	getImageBlocksAllocated(pHeader), getImageBlocks(pHeader),
275	getImageBlockSize(pHeader), getImageDiskSize(pHeader)));
276	fFailed = true;
277	}
278
279	if ( getImageExtraBlockSize(pHeader) != 0
280	&& getPowerOfTwo(getImageExtraBlockSize(pHeader)) == 0)
281	{
282	LogRel(("VDI: wrong extra size (%d, %d)\n",
283	getImageExtraBlockSize(pHeader), getPowerOfTwo(getImageExtraBlockSize(pHeader))));
284	fFailed = true;
285	}
286
287	if ((uint64_t)getImageBlockSize(pHeader) * getImageBlocks(pHeader) < getImageDiskSize(pHeader))
288	{
289	LogRel(("VDI: wrong disk size (%d, %d, %lld)\n",
290	getImageBlockSize(pHeader), getImageBlocks(pHeader), getImageDiskSize(pHeader)));
291	fFailed = true;
292	}
293
294	if (RTUuidIsNull(getImageCreationUUID(pHeader)))
295	{
296	LogRel(("VDI: uuid of creator is 0\n"));
297	fFailed = true;
298	}
299
300	if (RTUuidIsNull(getImageModificationUUID(pHeader)))
301	{
302	LogRel(("VDI: uuid of modificator is 0\n"));
303	fFailed = true;
304	}
305
306	return fFailed ? VERR_VDI_INVALID_HEADER : VINF_SUCCESS;
307	}
308
309	/**
310	* internal: init VDIIMAGEDESC structure.
311	*/
312	static void vdiInitImageDesc(PVDIIMAGEDESC pImage)
313	{
314	pImage->pPrev = NULL;
315	pImage->pNext = NULL;
316	pImage->File = NIL_RTFILE;
317	pImage->paBlocks = NULL;
318	}
319
320	/**
321	* internal: setup VDIIMAGEDESC structure by image header.
322	*/
323	static void vdiSetupImageDesc(PVDIIMAGEDESC pImage)
324	{
325	pImage->fFlags = getImageFlags(&pImage->Header);
326	pImage->offStartBlocks = getImageBlocksOffset(&pImage->Header);
327	pImage->offStartData = getImageDataOffset(&pImage->Header);
328	pImage->uBlockMask = getImageBlockSize(&pImage->Header) - 1;
329	pImage->uShiftIndex2Offset =
330	pImage->uShiftOffset2Index = getPowerOfTwo(getImageBlockSize(&pImage->Header));
331	pImage->offStartBlockData = getImageExtraBlockSize(&pImage->Header);
332	if (pImage->offStartBlockData != 0)
333	pImage->uShiftIndex2Offset += getPowerOfTwo(pImage->offStartBlockData);
334	}
335
336	/**
337	* internal: create image.
338	*/
339	static int vdiCreateImage(const char *pszFilename, VDIIMAGETYPE enmType, unsigned fFlags,
340	uint64_t cbSize, const char *pszComment, PVDIIMAGEDESC pParent,
341	PFNVMPROGRESS pfnProgress, void *pvUser)
342	{
343	/* Check args. */
344	Assert(pszFilename);
345	Assert(enmType >= VDI_IMAGE_TYPE_FIRST && enmType <= VDI_IMAGE_TYPE_LAST);
346	Assert(!(fFlags & ~VDI_IMAGE_FLAGS_MASK));
347	Assert(cbSize);
348
349	/* Special check for comment length. */
350	if ( pszComment
351	&& strlen(pszComment) >= VDI_IMAGE_COMMENT_SIZE)
352	{
353	Log(("vdiCreateImage: pszComment is too long, cb=%d\n", strlen(pszComment)));
354	return VERR_VDI_COMMENT_TOO_LONG;
355	}
356
357	if ( enmType == VDI_IMAGE_TYPE_UNDO
358	\|\| enmType == VDI_IMAGE_TYPE_DIFF)
359	{
360	Assert(pParent);
361	if ((pParent->PreHeader.u32Version >> 16) != VDI_IMAGE_VERSION_MAJOR)
362	{
363	/* Invalid parent image version. */
364	Log(("vdiCreateImage: unsupported parent version=%08X\n", pParent->PreHeader.u32Version));
365	return VERR_VDI_UNSUPPORTED_VERSION;
366	}
367
368	/* get image params from the parent image. */
369	fFlags = getImageFlags(&pParent->Header);
370	cbSize = getImageDiskSize(&pParent->Header);
371	}
372
373	PVDIIMAGEDESC pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
374	if (!pImage)
375	return VERR_NO_MEMORY;
376	vdiInitImageDesc(pImage);
377
378	vdiInitPreHeader(&pImage->PreHeader);
379	vdiInitHeader(&pImage->Header, enmType, fFlags, pszComment, cbSize, VDI_IMAGE_DEFAULT_BLOCK_SIZE, 0);
380
381	if ( enmType == VDI_IMAGE_TYPE_UNDO
382	\|\| enmType == VDI_IMAGE_TYPE_DIFF)
383	{
384	/* Set up linkage information. */
385	pImage->Header.u.v1.uuidLinkage = *getImageCreationUUID(&pParent->Header);
386	pImage->Header.u.v1.uuidParentModify = *getImageModificationUUID(&pParent->Header);
387	}
388
389	pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
390	if (!pImage->paBlocks)
391	{
392	RTMemFree(pImage);
393	return VERR_NO_MEMORY;
394	}
395
396	if (enmType != VDI_IMAGE_TYPE_FIXED)
397	{
398	/* for growing images mark all blocks in paBlocks as free. */
399	for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
400	pImage->paBlocks[i] = VDI_IMAGE_BLOCK_FREE;
401	}
402	else
403	{
404	/* for fixed images mark all blocks in paBlocks as allocated */
405	for (unsigned i = 0; i < pImage->Header.u.v1.cBlocks; i++)
406	pImage->paBlocks[i] = i;
407	pImage->Header.u.v1.cBlocksAllocated = pImage->Header.u.v1.cBlocks;
408	}
409
410	/* Setup image parameters. */
411	vdiSetupImageDesc(pImage);
412
413	/* create file */
414	int rc = RTFileOpen(&pImage->File,
415	pszFilename,
416	RTFILE_O_READWRITE \| RTFILE_O_CREATE \| RTFILE_O_DENY_ALL);
417	if (VBOX_SUCCESS(rc))
418	{
419	/* Lock image exclusively to close any wrong access by VDI API calls. */
420	uint64_t cbLock = pImage->offStartData
421	+ ((uint64_t)getImageBlocks(&pImage->Header) << pImage->uShiftIndex2Offset);
422	rc = RTFileLock(pImage->File,
423	RTFILE_LOCK_WRITE \| RTFILE_LOCK_IMMEDIATELY, 0, cbLock);
424	if (VBOX_FAILURE(rc))
425	{
426	cbLock = 0; /* Not locked. */
427	goto l_create_failed;
428	}
429
430	if (enmType == VDI_IMAGE_TYPE_FIXED)
431	{
432	/*
433	* Allocate & commit whole file if fixed image, it must be more
434	* effective than expanding file by write operations.
435	*/
436	rc = RTFileSetSize(pImage->File,
437	pImage->offStartData
438	+ ((uint64_t)getImageBlocks(&pImage->Header) << pImage->uShiftIndex2Offset));
439	}
440	else
441	{
442	/* Set file size to hold header and blocks array. */
443	rc = RTFileSetSize(pImage->File, pImage->offStartData);
444	}
445	if (VBOX_FAILURE(rc))
446	goto l_create_failed;
447
448	/* Generate image last-modify uuid */
449	RTUuidCreate(getImageModificationUUID(&pImage->Header));
450
451	/* Write pre-header. */
452	rc = RTFileWrite(pImage->File, &pImage->PreHeader, sizeof(pImage->PreHeader), NULL);
453	if (VBOX_FAILURE(rc))
454	goto l_create_failed;
455
456	/* Write header. */
457	rc = RTFileWrite(pImage->File, &pImage->Header.u.v1, sizeof(pImage->Header.u.v1), NULL);
458	if (VBOX_FAILURE(rc))
459	goto l_create_failed;
460
461	/* Write blocks array. */
462	rc = RTFileSeek(pImage->File, pImage->offStartBlocks, RTFILE_SEEK_BEGIN, NULL);
463	if (VBOX_FAILURE(rc))
464	goto l_create_failed;
465	rc = RTFileWrite(pImage->File,
466	pImage->paBlocks,
467	getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER),
468	NULL);
469	if (VBOX_FAILURE(rc))
470	goto l_create_failed;
471
472	if ( (enmType == VDI_IMAGE_TYPE_FIXED)
473	&& (fFlags & VDI_IMAGE_FLAGS_ZERO_EXPAND))
474	{
475	/* Fill image with zeroes. */
476
477	rc = RTFileSeek(pImage->File, pImage->offStartData, RTFILE_SEEK_BEGIN, NULL);
478	if (VBOX_FAILURE(rc))
479	goto l_create_failed;
480
481	/* alloc tmp zero-filled buffer */
482	void *pvBuf = RTMemTmpAllocZ(VDIDISK_DEFAULT_BUFFER_SIZE);
483	if (pvBuf)
484	{
485	uint64_t cbFill = (uint64_t)getImageBlocks(&pImage->Header) << pImage->uShiftIndex2Offset;
486	uint64_t cbDisk = cbFill;
487
488	/* do loop to fill all image. */
489	while (cbFill > 0)
490	{
491	unsigned to_fill = (unsigned)RT_MIN(cbFill, VDIDISK_DEFAULT_BUFFER_SIZE);
492
493	rc = RTFileWrite(pImage->File, pvBuf, to_fill, NULL);
494	if (VBOX_FAILURE(rc))
495	break;
496
497	cbFill -= to_fill;
498
499	if (pfnProgress)
500	{
501	rc = pfnProgress(NULL /* WARNING! pVM=NULL */,
502	(unsigned)(((cbDisk - cbFill) * 100) / cbDisk),
503	pvUser);
504	if (VBOX_FAILURE(rc))
505	break;
506	}
507	}
508	RTMemTmpFree(pvBuf);
509	}
510	else
511	{
512	/* alloc error */
513	rc = VERR_NO_MEMORY;
514	}
515	}
516
517	l_create_failed:
518
519	if (cbLock)
520	RTFileUnlock(pImage->File, 0, cbLock);
521
522	RTFileClose(pImage->File);
523
524	/* Delete image file if error occured while creating */
525	if (VBOX_FAILURE(rc))
526	RTFileDelete(pszFilename);
527	}
528
529	RTMemFree(pImage->paBlocks);
530	RTMemFree(pImage);
531
532	if ( VBOX_SUCCESS(rc)
533	&& pfnProgress)
534	pfnProgress(NULL /* WARNING! pVM=NULL */, 100, pvUser);
535
536	Log(("vdiCreateImage: done, filename=\"%s\", rc=%Vrc\n", pszFilename, rc));
537
538	return rc;
539	}
540
541	/**
542	* Open an image.
543	* @internal
544	*/
545	static int vdiOpenImage(PVDIIMAGEDESC ppImage, const char pszFilename,
546	unsigned fOpen, PVDIIMAGEDESC pParent)
547	{
548	/*
549	* Validate input.
550	*/
551	Assert(ppImage);
552	Assert(pszFilename);
553	Assert(!(fOpen & ~VDI_OPEN_FLAGS_MASK));
554
555	PVDIIMAGEDESC pImage;
556	size_t cchFilename = strlen(pszFilename);
557	if (cchFilename >= sizeof(pImage->szFilename))
558	{
559	AssertMsgFailed(("filename=\"%s\" is too long (%d bytes)!\n", pszFilename, cchFilename));
560	return VERR_FILENAME_TOO_LONG;
561	}
562
563	pImage = (PVDIIMAGEDESC)RTMemAllocZ(sizeof(VDIIMAGEDESC));
564	if (!pImage)
565	return VERR_NO_MEMORY;
566	vdiInitImageDesc(pImage);
567
568	memcpy(pImage->szFilename, pszFilename, cchFilename);
569	pImage->fOpen = fOpen;
570
571	/*
572	* Open the image.
573	*/
574	int rc = RTFileOpen(&pImage->File,
575	pImage->szFilename,
576	fOpen & VDI_OPEN_FLAGS_READONLY
577	? RTFILE_O_READ \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE
578	: RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
579	if (VBOX_FAILURE(rc))
580	{
581	if (!(fOpen & VDI_OPEN_FLAGS_READONLY))
582	{
583	/* Try to open image for reading only. */
584	rc = RTFileOpen(&pImage->File,
585	pImage->szFilename,
586	RTFILE_O_READ \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
587	if (VBOX_SUCCESS(rc))
588	pImage->fOpen \|= VDI_OPEN_FLAGS_READONLY;
589	}
590	if (VBOX_FAILURE(rc))
591	{
592	RTMemFree(pImage);
593	return rc;
594	}
595	}
596	/* Set up current image r/w state. */
597	pImage->fReadOnly = !!(pImage->fOpen & VDI_OPEN_FLAGS_READONLY);
598
599	/*
600	* Set initial file lock for reading header only.
601	* Length of lock doesn't matter, it just must include image header.
602	*/
603	uint64_t cbLock = _1M;
604	rc = RTFileLock(pImage->File, RTFILE_LOCK_READ \| RTFILE_LOCK_IMMEDIATELY, 0, cbLock);
605	if (VBOX_FAILURE(rc))
606	{
607	cbLock = 0;
608	goto l_open_failed;
609	}
610
611	/* Read pre-header. */
612	rc = RTFileRead(pImage->File, &pImage->PreHeader, sizeof(pImage->PreHeader), NULL);
613	if (VBOX_FAILURE(rc))
614	goto l_open_failed;
615	rc = vdiValidatePreHeader(&pImage->PreHeader);
616	if (VBOX_FAILURE(rc))
617	goto l_open_failed;
618
619	/* Read header. */
620	pImage->Header.uVersion = pImage->PreHeader.u32Version;
621	switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
622	{
623	case 0:
624	rc = RTFileRead(pImage->File, &pImage->Header.u.v0, sizeof(pImage->Header.u.v0), NULL);
625	break;
626	case 1:
627	rc = RTFileRead(pImage->File, &pImage->Header.u.v1, sizeof(pImage->Header.u.v1), NULL);
628	break;
629	default:
630	rc = VERR_VDI_UNSUPPORTED_VERSION;
631	break;
632	}
633	if (VBOX_FAILURE(rc))
634	goto l_open_failed;
635
636	rc = vdiValidateHeader(&pImage->Header);
637	if (VBOX_FAILURE(rc))
638	goto l_open_failed;
639
640	/* Check diff image correctness. */
641	if (pParent)
642	{
643	if (pImage->PreHeader.u32Version != pParent->PreHeader.u32Version)
644	{
645	rc = VERR_VDI_IMAGES_VERSION_MISMATCH;
646	goto l_open_failed;
647	}
648
649	if ( getImageType(&pImage->Header) != VDI_IMAGE_TYPE_UNDO
650	&& getImageType(&pImage->Header) != VDI_IMAGE_TYPE_DIFF)
651	{
652	rc = VERR_VDI_WRONG_DIFF_IMAGE;
653	goto l_open_failed;
654	}
655
656	if ( getImageDiskSize(&pImage->Header) != getImageDiskSize(&pParent->Header)
657	\|\| getImageBlockSize(&pImage->Header) != getImageBlockSize(&pParent->Header)
658	\|\| getImageBlocks(&pImage->Header) != getImageBlocks(&pParent->Header)
659	\|\| getImageExtraBlockSize(&pImage->Header) != getImageExtraBlockSize(&pParent->Header))
660	{
661	rc = VERR_VDI_WRONG_DIFF_IMAGE;
662	goto l_open_failed;
663	}
664
665	/* Check linkage data. */
666	if ( RTUuidCompare(getImageParentUUID(&pImage->Header),
667	getImageCreationUUID(&pParent->Header))
668	\|\| RTUuidCompare(getImageParentModificationUUID(&pImage->Header),
669	getImageModificationUUID(&pParent->Header)))
670	{
671	rc = VERR_VDI_IMAGES_UUID_MISMATCH;
672	goto l_open_failed;
673	}
674	}
675
676	/* Setup image parameters by header. */
677	vdiSetupImageDesc(pImage);
678
679	/* reset modified flag into first-modified state. */
680	pImage->fModified = VDI_IMAGE_MODIFIED_FIRST;
681
682	/* Image is validated, set working file lock on it. */
683	rc = RTFileUnlock(pImage->File, 0, cbLock);
684	AssertRC(rc);
685	cbLock = pImage->offStartData
686	+ ((uint64_t)getImageBlocks(&pImage->Header) << pImage->uShiftIndex2Offset);
687	rc = RTFileLock(pImage->File,
688	(pImage->fReadOnly) ?
689	RTFILE_LOCK_READ \| RTFILE_LOCK_IMMEDIATELY :
690	RTFILE_LOCK_WRITE \| RTFILE_LOCK_IMMEDIATELY,
691	0,
692	cbLock);
693	if ( VBOX_FAILURE(rc)
694	&& !pImage->fReadOnly)
695	{
696	/* Failed to lock image for writing, try read-only lock. */
697	rc = RTFileLock(pImage->File,
698	RTFILE_LOCK_READ \| RTFILE_LOCK_IMMEDIATELY, 0, cbLock);
699	if (VBOX_SUCCESS(rc))
700	pImage->fReadOnly = true;
701	}
702	if (VBOX_FAILURE(rc))
703	{
704	cbLock = 0; /* Not locked. */
705	goto l_open_failed;
706	}
707
708	/* Allocate memory for blocks array. */
709	pImage->paBlocks = (PVDIIMAGEBLOCKPOINTER)RTMemAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header));
710	if (!pImage->paBlocks)
711	{
712	rc = VERR_NO_MEMORY;
713	goto l_open_failed;
714	}
715
716	/* Read blocks array. */
717	rc = RTFileSeek(pImage->File, pImage->offStartBlocks, RTFILE_SEEK_BEGIN, NULL);
718	if (VBOX_FAILURE(rc))
719	goto l_open_failed;
720	rc = RTFileRead(pImage->File, pImage->paBlocks,
721	getImageBlocks(&pImage->Header) * sizeof(VDIIMAGEBLOCKPOINTER), NULL);
722	if (VBOX_FAILURE(rc))
723	goto l_open_failed;
724
725	/* all done. */
726	*ppImage = pImage;
727	return VINF_SUCCESS;
728
729	l_open_failed:
730	/* Clean up. */
731	if (pImage->paBlocks)
732	RTMemFree(pImage->paBlocks);
733	if (cbLock)
734	RTFileUnlock(pImage->File, 0, cbLock);
735	RTFileClose(pImage->File);
736	RTMemFree(pImage);
737	Log(("vdiOpenImage: failed, filename=\"%s\", rc=%Vrc\n", pszFilename, rc));
738	return rc;
739	}
740
741	/**
742	* internal: save header to file.
743	*/
744	static int vdiUpdateHeader(PVDIIMAGEDESC pImage)
745	{
746	/* Seek to header start. */
747	int rc = RTFileSeek(pImage->File, sizeof(VDIPREHEADER), RTFILE_SEEK_BEGIN, NULL);
748	if (VBOX_SUCCESS(rc))
749	{
750	switch (GET_MAJOR_HEADER_VERSION(&pImage->Header))
751	{
752	case 0:
753	rc = RTFileWrite(pImage->File, &pImage->Header.u.v0, sizeof(pImage->Header.u.v0), NULL);
754	break;
755	case 1:
756	rc = RTFileWrite(pImage->File, &pImage->Header.u.v1, sizeof(pImage->Header.u.v1), NULL);
757	break;
758	default:
759	rc = VERR_VDI_UNSUPPORTED_VERSION;
760	break;
761	}
762	}
763	AssertMsgRC(rc, ("vdiUpdateHeader failed, filename=\"%s\" rc=%Vrc\n", pImage->szFilename, rc));
764	return rc;
765	}
766
767	/**
768	* internal: save block pointer to file, save header to file.
769	*/
770	static int vdiUpdateBlockInfo(PVDIIMAGEDESC pImage, unsigned uBlock)
771	{
772	/* Update image header. */
773	int rc = vdiUpdateHeader(pImage);
774	if (VBOX_SUCCESS(rc))
775	{
776	/* write only one block pointer. */
777	rc = RTFileSeek(pImage->File,
778	pImage->offStartBlocks + uBlock * sizeof(VDIIMAGEBLOCKPOINTER),
779	RTFILE_SEEK_BEGIN,
780	NULL);
781	if (VBOX_SUCCESS(rc))
782	rc = RTFileWrite(pImage->File,
783	&pImage->paBlocks[uBlock],
784	sizeof(VDIIMAGEBLOCKPOINTER),
785	NULL);
786	AssertMsgRC(rc, ("vdiUpdateBlockInfo failed to update block=%u, filename=\"%s\", rc=%Vrc\n",
787	uBlock, pImage->szFilename, rc));
788	}
789	return rc;
790	}
791
792	/**
793	* internal: save blocks array to file, save header to file.
794	*/
795	static int vdiUpdateBlocks(PVDIIMAGEDESC pImage)
796	{
797	/* Update image header. */
798	int rc = vdiUpdateHeader(pImage);
799	if (VBOX_SUCCESS(rc))
800	{
801	/* write the block pointers array. */
802	rc = RTFileSeek(pImage->File, pImage->offStartBlocks, RTFILE_SEEK_BEGIN, NULL);
803	if (VBOX_SUCCESS(rc))
804	rc = RTFileWrite(pImage->File,
805	pImage->paBlocks,
806	sizeof(VDIIMAGEBLOCKPOINTER) * getImageBlocks(&pImage->Header),
807	NULL);
808	AssertMsgRC(rc, ("vdiUpdateBlocks failed, filename=\"%s\", rc=%Vrc\n",
809	pImage->szFilename, rc));
810	}
811	return rc;
812	}
813
814	/**
815	* internal: mark image as modified, if this is the first change - update image header
816	* on disk with a new uuidModify value.
817	*/
818	static void vdiSetModifiedFlag(PVDIIMAGEDESC pImage)
819	{
820	pImage->fModified \|= VDI_IMAGE_MODIFIED_FLAG;
821	if (pImage->fModified & VDI_IMAGE_MODIFIED_FIRST)
822	{
823	pImage->fModified &= ~VDI_IMAGE_MODIFIED_FIRST;
824
825	/* first modify - generate uuidModify and save to file. */
826	vdiResetModifiedFlag(pImage);
827
828	if (!(pImage->fModified \| VDI_IMAGE_MODIFIED_DISABLE_UUID_UPDATE))
829	{
830	/* save header to file,
831	* note: no rc checking.
832	*/
833	vdiUpdateHeader(pImage);
834	}
835	}
836	}
837
838	/**
839	* internal: generate new uuidModify if the image was changed.
840	*/
841	static void vdiResetModifiedFlag(PVDIIMAGEDESC pImage)
842	{
843	if (pImage->fModified & VDI_IMAGE_MODIFIED_FLAG)
844	{
845	/* generate new last-modified uuid */
846	if (!(pImage->fModified \| VDI_IMAGE_MODIFIED_DISABLE_UUID_UPDATE))
847	RTUuidCreate(getImageModificationUUID(&pImage->Header));
848
849	pImage->fModified &= ~VDI_IMAGE_MODIFIED_FLAG;
850	}
851	}
852
853	/**
854	* internal: disables updates of the last-modified UUID
855	* when performing image writes.
856	*/
857	static void vdiDisableLastModifiedUpdate(PVDIIMAGEDESC pImage)
858	{
859	pImage->fModified \|= VDI_IMAGE_MODIFIED_DISABLE_UUID_UPDATE;
860	}
861
862	#if 0 /* unused */
863	/**
864	* internal: enables updates of the last-modified UUID
865	* when performing image writes.
866	*/
867	static void vdiEnableLastModifiedUpdate(PVDIIMAGEDESC pImage)
868	{
869	pImage->fModified &= ~VDI_IMAGE_MODIFIED_DISABLE_UUID_UPDATE;
870	}
871	#endif
872
873	/**
874	* Flush the image file to disk.
875	*/
876	void vdiFlushImage(PVDIIMAGEDESC pImage)
877	{
878	if (!pImage->fReadOnly)
879	{
880	/* Update last-modified uuid if need. */
881	vdiResetModifiedFlag(pImage);
882
883	/* Save header. */
884	int rc = vdiUpdateHeader(pImage);
885	AssertMsgRC(rc, ("vdiUpdateHeader() failed, filename=\"%s\", rc=%Vrc\n",
886	pImage->szFilename, rc));
887	RTFileFlush(pImage->File);
888	}
889	}
890
891	/**
892	* internal: close image file.
893	*/
894	static void vdiCloseImage(PVDIIMAGEDESC pImage)
895	{
896	/* Params checking. */
897	Assert(pImage);
898	Assert(pImage->File != NIL_RTFILE);
899
900	vdiFlushImage(pImage);
901	RTFileUnlock(pImage->File,
902	0,
903	pImage->offStartData
904	+ ((uint64_t)getImageBlocks(&pImage->Header) << pImage->uShiftIndex2Offset));
905	RTFileClose(pImage->File);
906
907	/* free image resources */
908	RTMemFree(pImage->paBlocks);
909	RTMemFree(pImage);
910	}
911
912	/**
913	* internal: read data inside image block.
914	*
915	* note: uBlock must be valid, readed data must not overlap block bounds.
916	*/
917	static int vdiReadInBlock(PVDIIMAGEDESC pImage, unsigned uBlock, unsigned offRead,
918	unsigned cbToRead, void *pvBuf)
919	{
920	if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
921	{
922	/* block present in image file */
923	uint64_t u64Offset = ((uint64_t)pImage->paBlocks[uBlock] << pImage->uShiftIndex2Offset)
924	+ (pImage->offStartData + pImage->offStartBlockData + offRead);
925	int rc = RTFileSeek(pImage->File, u64Offset, RTFILE_SEEK_BEGIN, NULL);
926	if (VBOX_SUCCESS(rc))
927	rc = RTFileRead(pImage->File, pvBuf, cbToRead, NULL);
928	if (VBOX_FAILURE(rc))
929	Log(("vdiReadInBlock: rc=%Vrc filename=\"%s\" uBlock=%u offRead=%u cbToRead=%u u64Offset=%llu\n",
930	rc, pImage->szFilename, uBlock, offRead, cbToRead, u64Offset));
931	return rc;
932	}
933
934	/* Returns zeroes for both free and zero block types. */
935	memset(pvBuf, 0, cbToRead);
936	return VINF_SUCCESS;
937	}
938
939	/**
940	* Read data from virtual HDD.
941	*
942	* @returns VBox status code.
943	* @param pDisk Pointer to VDI HDD container.
944	* @param offStart Offset of first reading byte from start of disk.
945	* @param pvBuf Pointer to buffer for reading data.
946	* @param cbToRead Number of bytes to read.
947	*/
948	VBOXDDU_DECL(int) VDIDiskRead(PVDIDISK pDisk, uint64_t offStart, void *pvBuf, unsigned cbToRead)
949	{
950	/* sanity check */
951	Assert(pDisk);
952	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
953
954	PVDIIMAGEDESC pImage = pDisk->pLast;
955	Assert(pImage);
956
957	/* Check params. */
958	if ( offStart + cbToRead > getImageDiskSize(&pImage->Header)
959	\|\| cbToRead == 0)
960	{
961	AssertMsgFailed(("offStart=%llu cbToRead=%u\n", offStart, cbToRead));
962	return VERR_INVALID_PARAMETER;
963	}
964
965	/* Calculate starting block number and offset inside it. */
966	unsigned uBlock = (unsigned)(offStart >> pImage->uShiftOffset2Index);
967	unsigned offRead = (unsigned)offStart & pImage->uBlockMask;
968
969	/* Save block size here for speed optimization. */
970	unsigned cbBlock = getImageBlockSize(&pImage->Header);
971
972	/* loop through blocks */
973	int rc;
974	for (;;)
975	{
976	unsigned to_read;
977	if ((offRead + cbToRead) <= cbBlock)
978	to_read = cbToRead;
979	else
980	to_read = cbBlock - offRead;
981
982	if (pDisk->cImages > 1)
983	{
984	/* Differencing images are used, handle them. */
985	pImage = pDisk->pLast;
986
987	/* Search for image with allocated block. */
988	while (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
989	{
990	pImage = pImage->pPrev;
991	if (!pImage)
992	{
993	/* Block is not allocated in all images of chain. */
994	pImage = pDisk->pLast;
995	break;
996	}
997	}
998	}
999
1000	rc = vdiReadInBlock(pImage, uBlock, offRead, to_read, pvBuf);
1001
1002	cbToRead -= to_read;
1003	if ( cbToRead == 0
1004	\|\| VBOX_FAILURE(rc))
1005	break;
1006
1007	/* goto next block */
1008	uBlock++;
1009	offRead = 0;
1010	pvBuf = (char *)pvBuf + to_read;
1011	}
1012
1013	return rc;
1014	}
1015
1016	/**
1017	* internal: fill the whole block with zeroes.
1018	*
1019	* note: block id must be valid, block must be already allocated in file.
1020	* note: if pDisk is NULL, the default buffer size is used
1021	*/
1022	static int vdiFillBlockByZeroes(PVDIDISK pDisk, PVDIIMAGEDESC pImage, unsigned uBlock)
1023	{
1024	int rc;
1025
1026	/* seek to start of block in file. */
1027	uint64_t u64Offset = ((uint64_t)pImage->paBlocks[uBlock] << pImage->uShiftIndex2Offset)
1028	+ (pImage->offStartData + pImage->offStartBlockData);
1029	rc = RTFileSeek(pImage->File, u64Offset, RTFILE_SEEK_BEGIN, NULL);
1030	if (VBOX_FAILURE(rc))
1031	{
1032	Log(("vdiFillBlockByZeroes: seek rc=%Vrc filename=\"%s\" uBlock=%u u64Offset=%llu\n",
1033	rc, pImage->szFilename, uBlock, u64Offset));
1034	return rc;
1035	}
1036
1037	/* alloc tmp zero-filled buffer */
1038	void *pvBuf = RTMemTmpAllocZ(pDisk ? pDisk->cbBuf : VDIDISK_DEFAULT_BUFFER_SIZE);
1039	if (!pvBuf)
1040	return VERR_NO_MEMORY;
1041
1042	unsigned cbFill = getImageBlockSize(&pImage->Header);
1043
1044	/* do loop, because buffer size may be less then block size */
1045	while (cbFill > 0)
1046	{
1047	unsigned to_fill = RT_MIN(cbFill, pDisk ? pDisk->cbBuf : VDIDISK_DEFAULT_BUFFER_SIZE);
1048	rc = RTFileWrite(pImage->File, pvBuf, to_fill, NULL);
1049	if (VBOX_FAILURE(rc))
1050	{
1051	Log(("vdiFillBlockByZeroes: write rc=%Vrc filename=\"%s\" uBlock=%u u64Offset=%llu cbFill=%u to_fill=%u\n",
1052	rc, pImage->szFilename, uBlock, u64Offset, cbFill, to_fill));
1053	break;
1054	}
1055
1056	cbFill -= to_fill;
1057	}
1058
1059	RTMemTmpFree(pvBuf);
1060	return rc;
1061	}
1062
1063	/**
1064	* internal: write data inside image block.
1065	*
1066	* note: uBlock must be valid, written data must not overlap block bounds.
1067	*/
1068	static int vdiWriteInBlock(PVDIDISK pDisk, PVDIIMAGEDESC pImage, unsigned uBlock, unsigned offWrite, unsigned cbToWrite, const void *pvBuf)
1069	{
1070	int rc;
1071
1072	/* Check if we can write into file. */
1073	if (pImage->fReadOnly)
1074	{
1075	Log(("vdiWriteInBlock: failed, image \"%s\" is read-only!\n", pImage->szFilename));
1076	return VERR_WRITE_PROTECT;
1077	}
1078
1079	/* This could be optimized a little (not setting it when writing zeroes
1080	* to a zeroed block). Won't buy us much, because it's very unlikely
1081	* that only such zero data block writes occur while the VDI is opened. */
1082	vdiSetModifiedFlag(pImage);
1083
1084	if (!IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
1085	{
1086	if (!pDisk \|\| !pDisk->fHonorZeroWrites)
1087	{
1088	/* If the destination block is unallocated at this point, it's either
1089	* a zero block or a block which hasn't been used so far (which also
1090	* means that it's a zero block. Don't need to write anything to this
1091	* block if the data consists of just zeroes. */
1092	Assert(cbToWrite % 4 == 0);
1093	if (ASMBitFirstSet((volatile void )pvBuf, cbToWrite 8) == -1)
1094	{
1095	pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1096	return VINF_SUCCESS;
1097	}
1098	}
1099
1100	/* need to allocate a new block in image file */
1101
1102	/* expand file by one block */
1103	uint64_t u64Size = (((uint64_t)(getImageBlocksAllocated(&pImage->Header) + 1)) << pImage->uShiftIndex2Offset)
1104	+ pImage->offStartData;
1105	rc = RTFileSetSize(pImage->File, u64Size);
1106	if (VBOX_FAILURE(rc))
1107	{
1108	Log(("vdiWriteInBlock: set size rc=%Vrc filename=\"%s\" uBlock=%u u64Size=%llu\n",
1109	rc, pImage->szFilename, uBlock, u64Size));
1110	return rc;
1111	}
1112
1113	unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
1114	pImage->paBlocks[uBlock] = cBlocksAllocated;
1115	setImageBlocksAllocated(&pImage->Header, cBlocksAllocated + 1);
1116
1117	if ( pImage->fFlags & VDI_IMAGE_FLAGS_ZERO_EXPAND
1118	\|\| pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
1119	{
1120	/* Fill newly allocated block by zeroes. */
1121
1122	if (offWrite \|\| cbToWrite != getImageBlockSize(&pImage->Header))
1123	{
1124	rc = vdiFillBlockByZeroes(pDisk, pImage, uBlock);
1125	if (VBOX_FAILURE(rc))
1126	return rc;
1127	}
1128	}
1129
1130	rc = vdiUpdateBlockInfo(pImage, uBlock);
1131	if (VBOX_FAILURE(rc))
1132	return rc;
1133	}
1134
1135	/* Now block present in image file, write data inside it. */
1136	uint64_t u64Offset = ((uint64_t)pImage->paBlocks[uBlock] << pImage->uShiftIndex2Offset)
1137	+ (pImage->offStartData + pImage->offStartBlockData + offWrite);
1138	rc = RTFileSeek(pImage->File, u64Offset, RTFILE_SEEK_BEGIN, NULL);
1139	if (VBOX_SUCCESS(rc))
1140	{
1141	rc = RTFileWrite(pImage->File, pvBuf, cbToWrite, NULL);
1142	if (VBOX_FAILURE(rc))
1143	Log(("vdiWriteInBlock: write rc=%Vrc filename=\"%s\" uBlock=%u offWrite=%u u64Offset=%llu cbToWrite=%u\n",
1144	rc, pImage->szFilename, uBlock, offWrite, u64Offset, cbToWrite));
1145	}
1146	else
1147	Log(("vdiWriteInBlock: seek rc=%Vrc filename=\"%s\" uBlock=%u offWrite=%u u64Offset=%llu\n",
1148	rc, pImage->szFilename, uBlock, offWrite, u64Offset));
1149
1150	return rc;
1151	}
1152
1153	/**
1154	* internal: copy data block from one (parent) image to last image.
1155	*/
1156	static int vdiCopyBlock(PVDIDISK pDisk, PVDIIMAGEDESC pImage, unsigned uBlock)
1157	{
1158	Assert(pImage != pDisk->pLast);
1159
1160	if (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
1161	{
1162	/*
1163	* if src block is zero, set dst block to zero too.
1164	*/
1165	pDisk->pLast->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1166	return VINF_SUCCESS;
1167	}
1168
1169	/* alloc tmp buffer */
1170	void *pvBuf = RTMemTmpAlloc(pDisk->cbBuf);
1171	if (!pvBuf)
1172	return VERR_NO_MEMORY;
1173
1174	int rc = VINF_SUCCESS;
1175
1176	unsigned cbCopy = getImageBlockSize(&pImage->Header);
1177	unsigned offCopy = 0;
1178
1179	/* do loop, because buffer size may be less then block size */
1180	while (cbCopy > 0)
1181	{
1182	unsigned to_copy = RT_MIN(cbCopy, pDisk->cbBuf);
1183	rc = vdiReadInBlock(pImage, uBlock, offCopy, to_copy, pvBuf);
1184	if (VBOX_FAILURE(rc))
1185	break;
1186
1187	rc = vdiWriteInBlock(pDisk, pDisk->pLast, uBlock, offCopy, to_copy, pvBuf);
1188	if (VBOX_FAILURE(rc))
1189	break;
1190
1191	cbCopy -= to_copy;
1192	offCopy += to_copy;
1193	}
1194
1195	RTMemTmpFree(pvBuf);
1196	return rc;
1197	}
1198
1199	/**
1200	* Write data to virtual HDD.
1201	*
1202	* @returns VBox status code.
1203	* @param pDisk Pointer to VDI HDD container.
1204	* @param offStart Offset of first writing byte from start of HDD.
1205	* @param pvBuf Pointer to buffer of writing data.
1206	* @param cbToWrite Number of bytes to write.
1207	*/
1208	VBOXDDU_DECL(int) VDIDiskWrite(PVDIDISK pDisk, uint64_t offStart, const void *pvBuf, unsigned cbToWrite)
1209	{
1210	/* sanity check */
1211	Assert(pDisk);
1212	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
1213
1214	PVDIIMAGEDESC pImage = pDisk->pLast;
1215	Assert(pImage);
1216
1217	/* Check params. */
1218	if ( offStart + cbToWrite > getImageDiskSize(&pImage->Header)
1219	\|\| cbToWrite == 0)
1220	{
1221	AssertMsgFailed(("offStart=%llu cbToWrite=%u\n", offStart, cbToWrite));
1222	return VERR_INVALID_PARAMETER;
1223	}
1224
1225	/* Calculate starting block number and offset inside it. */
1226	unsigned uBlock = (unsigned)(offStart >> pImage->uShiftOffset2Index);
1227	unsigned offWrite = (unsigned)offStart & pImage->uBlockMask;
1228	unsigned cbBlock = getImageBlockSize(&pImage->Header);
1229
1230	/* loop through blocks */
1231	int rc;
1232	for (;;)
1233	{
1234	unsigned to_write;
1235	if (offWrite + cbToWrite <= cbBlock)
1236	to_write = cbToWrite;
1237	else
1238	to_write = cbBlock - offWrite;
1239
1240	/* All callers write less than a VDI block right now (assuming
1241	* default VDI block size). So not worth optimizing for the case
1242	* where a full block is overwritten (no copying required).
1243	* Checking whether a block is all zeroes after the write is too
1244	* expensive (would require reading the rest of the block). */
1245
1246	if (pDisk->cImages > 1)
1247	{
1248	/* Differencing images are used, handle them. */
1249
1250	/* Search for image with allocated block. */
1251	while (pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
1252	{
1253	pImage = pImage->pPrev;
1254	if (!pImage)
1255	{
1256	/* Block is not allocated in all images of chain. */
1257	pImage = pDisk->pLast;
1258	break;
1259	}
1260	}
1261
1262	if (pImage != pDisk->pLast)
1263	{
1264	/* One of parent image has a block data, copy it into last image. */
1265	rc = vdiCopyBlock(pDisk, pImage, uBlock);
1266	if (VBOX_FAILURE(rc))
1267	break;
1268	pImage = pDisk->pLast;
1269	}
1270	}
1271
1272	/* Actually write the data into block. */
1273	rc = vdiWriteInBlock(pDisk, pImage, uBlock, offWrite, to_write, pvBuf);
1274
1275	cbToWrite -= to_write;
1276	if ( cbToWrite == 0
1277	\|\| VBOX_FAILURE(rc))
1278	break;
1279
1280	/* goto next block */
1281	uBlock++;
1282	offWrite = 0;
1283	pvBuf = (char *)pvBuf + to_write;
1284	}
1285
1286	return rc;
1287	}
1288
1289	/**
1290	* internal: commit one image to another, no changes to header, just
1291	* plain copy operation. Blocks that are not allocated in the source
1292	* image (i.e. inherited by its parent(s)) are not merged.
1293	*
1294	* @param pImageFrom source image
1295	* @param pImageTo target image (will receive all the modifications)
1296	* @param fParentToChild true if the source image is parent of the target one,
1297	* false of the target image is the parent of the source.
1298	* @param pfnProgress progress callback (NULL if not to be used)
1299	* @param pvUser user argument for the progress callback
1300	*
1301	* @note the target image has to be opened read/write
1302	* @note this method does not check whether merging is possible!
1303	*/
1304	static int vdiMergeImages(PVDIIMAGEDESC pImageFrom, PVDIIMAGEDESC pImageTo, bool fParentToChild,
1305	PFNVMPROGRESS pfnProgress, void *pvUser)
1306	{
1307	Assert(pImageFrom);
1308	Assert(pImageTo);
1309
1310	Log(("vdiMergeImages: merging from image \"%s\" to image \"%s\" (fParentToChild=%d)\n",
1311	pImageFrom->szFilename, pImageTo->szFilename, fParentToChild));
1312
1313	/* alloc tmp buffer */
1314	void *pvBuf = RTMemTmpAlloc(VDIDISK_DEFAULT_BUFFER_SIZE);
1315	if (!pvBuf)
1316	return VERR_NO_MEMORY;
1317
1318	int rc = VINF_SUCCESS;
1319
1320	if (!fParentToChild)
1321	{
1322	/*
1323	* Commit the child image to the parent image.
1324	* Child is the source (from), parent is the target (to).
1325	*/
1326
1327	unsigned cBlocks = getImageBlocks(&pImageFrom->Header);
1328
1329	for (unsigned uBlock = 0; uBlock < cBlocks; uBlock++)
1330	{
1331	/* only process blocks that are allocated in the source image */
1332	if (pImageFrom->paBlocks[uBlock] != VDI_IMAGE_BLOCK_FREE)
1333	{
1334	/* Found used block in source image, commit it. */
1335	if ( pImageFrom->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
1336	&& !IS_VDI_IMAGE_BLOCK_ALLOCATED(pImageTo->paBlocks[uBlock]))
1337	{
1338	/* Block is zero in the source image and not allocated in the target image. */
1339	pImageTo->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1340	vdiSetModifiedFlag(pImageTo);
1341	}
1342	else
1343	{
1344	/* Block is not zero / allocated in source image. */
1345	unsigned cbCommit = getImageBlockSize(&pImageFrom->Header);
1346	unsigned offCommit = 0;
1347
1348	/* do loop, because buffer size may be less then block size */
1349	while (cbCommit > 0)
1350	{
1351	unsigned cbToCopy = RT_MIN(cbCommit, VDIDISK_DEFAULT_BUFFER_SIZE);
1352
1353	rc = vdiReadInBlock(pImageFrom, uBlock, offCommit, cbToCopy, pvBuf);
1354	if (VBOX_FAILURE(rc))
1355	break;
1356
1357	rc = vdiWriteInBlock(NULL, pImageTo, uBlock, offCommit, cbToCopy, pvBuf);
1358	if (VBOX_FAILURE(rc))
1359	break;
1360
1361	cbCommit -= cbToCopy;
1362	offCommit += cbToCopy;
1363	}
1364	if (VBOX_FAILURE(rc))
1365	break;
1366	}
1367	}
1368
1369	if (pfnProgress)
1370	{
1371	pfnProgress(NULL /* WARNING! pVM=NULL */,
1372	(uBlock * 100) / cBlocks,
1373	pvUser);
1374	/* Note: commiting is non breakable operation, skipping rc here. */
1375	}
1376	}
1377	}
1378	else
1379	{
1380	/*
1381	* Commit the parent image to the child image.
1382	* Parent is the source (from), child is the target (to).
1383	*/
1384
1385	unsigned cBlocks = getImageBlocks(&pImageFrom->Header);
1386
1387	for (unsigned uBlock = 0; uBlock < cBlocks; uBlock++)
1388	{
1389	/*
1390	* only process blocks that are allocated or zero in the source image
1391	* and NEITHER allocated NOR zero in the target image
1392	*/
1393	if (pImageFrom->paBlocks[uBlock] != VDI_IMAGE_BLOCK_FREE &&
1394	pImageTo->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE)
1395	{
1396	/* Found used block in source image (but unused in target), commit it. */
1397	if ( pImageFrom->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO)
1398	{
1399	/* Block is zero in the source image and not allocated in the target image. */
1400	pImageTo->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1401	vdiSetModifiedFlag(pImageTo);
1402	}
1403	else
1404	{
1405	/* Block is not zero / allocated in source image. */
1406	unsigned cbCommit = getImageBlockSize(&pImageFrom->Header);
1407	unsigned offCommit = 0;
1408
1409	/* do loop, because buffer size may be less then block size */
1410	while (cbCommit > 0)
1411	{
1412	unsigned cbToCopy = RT_MIN(cbCommit, VDIDISK_DEFAULT_BUFFER_SIZE);
1413
1414	rc = vdiReadInBlock(pImageFrom, uBlock, offCommit, cbToCopy, pvBuf);
1415	if (VBOX_FAILURE(rc))
1416	break;
1417
1418	rc = vdiWriteInBlock(NULL, pImageTo, uBlock, offCommit, cbToCopy, pvBuf);
1419	if (VBOX_FAILURE(rc))
1420	break;
1421
1422	cbCommit -= cbToCopy;
1423	offCommit += cbToCopy;
1424	}
1425	if (VBOX_FAILURE(rc))
1426	break;
1427	}
1428	}
1429
1430	if (pfnProgress)
1431	{
1432	pfnProgress(NULL /* WARNING! pVM=NULL */,
1433	(uBlock * 100) / cBlocks,
1434	pvUser);
1435	/* Note: commiting is non breakable operation, skipping rc here. */
1436	}
1437	}
1438	}
1439
1440	RTMemTmpFree(pvBuf);
1441	return rc;
1442	}
1443
1444	/**
1445	* internal: commit last image(s) to selected previous image.
1446	* note: all images accessed across this call must be opened in R/W mode.
1447	* @remark Only used by tstVDI.
1448	*/
1449	static int vdiCommitToImage(PVDIDISK pDisk, PVDIIMAGEDESC pDstImage,
1450	PFNVMPROGRESS pfnProgress, void *pvUser)
1451	{
1452	/* sanity check */
1453	Assert(pDisk);
1454	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
1455	Assert(pDstImage);
1456
1457	PVDIIMAGEDESC pImage = pDisk->pLast;
1458	Assert(pImage);
1459	Log(("vdiCommitToImage: commiting from image \"%s\" to image \"%s\"\n",
1460	pImage->szFilename, pDstImage->szFilename));
1461	if (pDstImage == pImage)
1462	{
1463	Log(("vdiCommitToImage: attempt to commit to the same image!\n"));
1464	return VERR_VDI_NO_DIFF_IMAGES;
1465	}
1466
1467	/* Scan images for pDstImage. */
1468	while (pImage && pImage != pDstImage)
1469	pImage = pImage->pPrev;
1470	if (!pImage)
1471	{
1472	AssertMsgFailed(("Invalid arguments: pDstImage is not in images chain\n"));
1473	return VERR_INVALID_PARAMETER;
1474	}
1475	pImage = pDisk->pLast;
1476
1477	/* alloc tmp buffer */
1478	void *pvBuf = RTMemTmpAlloc(pDisk->cbBuf);
1479	if (!pvBuf)
1480	return VERR_NO_MEMORY;
1481
1482	int rc = VINF_SUCCESS;
1483	unsigned cBlocks = getImageBlocks(&pImage->Header);
1484
1485	for (unsigned uBlock = 0; uBlock < cBlocks; uBlock++)
1486	{
1487	pImage = pDisk->pLast;
1488
1489	/* Find allocated block to commit. */
1490	while ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_FREE
1491	&& pImage != pDstImage)
1492	pImage = pImage->pPrev;
1493
1494	if (pImage != pDstImage)
1495	{
1496	/* Found used block in diff image (pImage), commit it. */
1497	if ( pImage->paBlocks[uBlock] == VDI_IMAGE_BLOCK_ZERO
1498	&& !IS_VDI_IMAGE_BLOCK_ALLOCATED(pDstImage->paBlocks[uBlock]))
1499	{
1500	/* Block is zero in difference image and not allocated in primary image. */
1501	pDstImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_ZERO;
1502	vdiSetModifiedFlag(pDstImage);
1503	}
1504	else
1505	{
1506	/* Block is not zero / allocated in primary image. */
1507	unsigned cbCommit = getImageBlockSize(&pImage->Header);
1508	unsigned offCommit = 0;
1509
1510	/* do loop, because buffer size may be less then block size */
1511	while (cbCommit > 0)
1512	{
1513	unsigned cbToCopy = RT_MIN(cbCommit, pDisk->cbBuf);
1514
1515	rc = vdiReadInBlock(pImage, uBlock, offCommit, cbToCopy, pvBuf);
1516	if (VBOX_FAILURE(rc))
1517	break;
1518
1519	rc = vdiWriteInBlock(pDisk, pDstImage, uBlock, offCommit, cbToCopy, pvBuf);
1520	if (VBOX_FAILURE(rc))
1521	break;
1522
1523	cbCommit -= cbToCopy;
1524	offCommit += cbToCopy;
1525	}
1526	if (VBOX_FAILURE(rc))
1527	break;
1528	}
1529	pImage->paBlocks[uBlock] = VDI_IMAGE_BLOCK_FREE;
1530	}
1531
1532	if (pfnProgress)
1533	{
1534	pfnProgress(NULL /* WARNING! pVM=NULL */,
1535	(uBlock * 100) / cBlocks,
1536	pvUser);
1537	/* Note: commiting is non breakable operation, skipping rc here. */
1538	}
1539	}
1540
1541	RTMemTmpFree(pvBuf);
1542
1543	/* Go forward and update linkage information. */
1544	for (pImage = pDstImage; pImage; pImage = pImage->pNext)
1545	{
1546	/* generate new last-modified uuid. */
1547	RTUuidCreate(getImageModificationUUID(&pImage->Header));
1548
1549	/* fix up linkage. */
1550	if (pImage != pDstImage)
1551	getImageParentModificationUUID(&pImage->Header) = getImageModificationUUID(&pImage->pPrev->Header);
1552
1553	/* reset modified flag. */
1554	pImage->fModified = 0;
1555	}
1556
1557	/* Process committed images - truncate them. */
1558	for (pImage = pDisk->pLast; pImage != pDstImage; pImage = pImage->pPrev)
1559	{
1560	/* note: can't understand how to do error works here? */
1561
1562	setImageBlocksAllocated(&pImage->Header, 0);
1563
1564	/* Truncate file. */
1565	int rc2 = RTFileSetSize(pImage->File, pImage->offStartData);
1566	if (VBOX_FAILURE(rc2))
1567	{
1568	rc = rc2;
1569	Log(("vdiCommitToImage: set size (truncate) rc=%Vrc filename=\"%s\"\n",
1570	rc, pImage->szFilename));
1571	}
1572
1573	/* Save header and blocks array. */
1574	rc2 = vdiUpdateBlocks(pImage);
1575	if (VBOX_FAILURE(rc2))
1576	{
1577	rc = rc2;
1578	Log(("vdiCommitToImage: update blocks and header rc=%Vrc filename=\"%s\"\n",
1579	rc, pImage->szFilename));
1580	}
1581	}
1582
1583	if (pfnProgress)
1584	{
1585	pfnProgress(NULL /* WARNING! pVM=NULL */, 100, pvUser);
1586	/* Note: commiting is non breakable operation, skipping rc here. */
1587	}
1588
1589	Log(("vdiCommitToImage: done, rc=%Vrc\n", rc));
1590
1591	return rc;
1592	}
1593
1594	/**
1595	* Checks if image is available and not broken, returns some useful image parameters if requested.
1596	*
1597	* @returns VBox status code.
1598	* @param pszFilename Name of the image file to check.
1599	* @param puVersion Where to store the version of image. NULL is ok.
1600	* @param penmType Where to store the type of image. NULL is ok.
1601	* @param pcbSize Where to store the size of image in bytes. NULL is ok.
1602	* @param pUuid Where to store the uuid of image creation. NULL is ok.
1603	* @param pParentUuid Where to store the UUID of the parent image. NULL is ok.
1604	* @param pszComment Where to store the comment string of image. NULL is ok.
1605	* @param cbComment The size of pszComment buffer. 0 is ok.
1606	*/
1607	VBOXDDU_DECL(int) VDICheckImage(const char pszFilename, unsigned puVersion, PVDIIMAGETYPE penmType,
1608	uint64_t *pcbSize, PRTUUID pUuid, PRTUUID pParentUuid,
1609	char *pszComment, unsigned cbComment)
1610	{
1611	LogFlow(("VDICheckImage:\n"));
1612
1613	/* Check arguments. */
1614	if ( !pszFilename
1615	\|\| *pszFilename == '\0')
1616	{
1617	AssertMsgFailed(("Invalid arguments: pszFilename=%p\n", pszFilename));
1618	return VERR_INVALID_PARAMETER;
1619	}
1620
1621	PVDIIMAGEDESC pImage;
1622	int rc = vdiOpenImage(&pImage, pszFilename, VDI_OPEN_FLAGS_READONLY, NULL);
1623	if (VBOX_SUCCESS(rc))
1624	{
1625	Log(("VDICheckImage: filename=\"%s\" version=%08X type=%X cbDisk=%llu uuid={%Vuuid}\n",
1626	pszFilename,
1627	pImage->PreHeader.u32Version,
1628	getImageType(&pImage->Header),
1629	getImageDiskSize(&pImage->Header),
1630	getImageCreationUUID(&pImage->Header)));
1631
1632	if ( pszComment
1633	&& cbComment > 0)
1634	{
1635	char *pszTmp = getImageComment(&pImage->Header);
1636	unsigned cb = strlen(pszTmp);
1637	if (cbComment > cb)
1638	memcpy(pszComment, pszTmp, cb + 1);
1639	else
1640	rc = VERR_BUFFER_OVERFLOW;
1641	}
1642	if (VBOX_SUCCESS(rc))
1643	{
1644	if (puVersion)
1645	*puVersion = pImage->PreHeader.u32Version;
1646	if (penmType)
1647	*penmType = getImageType(&pImage->Header);
1648	if (pcbSize)
1649	*pcbSize = getImageDiskSize(&pImage->Header);
1650	if (pUuid)
1651	pUuid = getImageCreationUUID(&pImage->Header);
1652	if (pParentUuid)
1653	pParentUuid = getImageParentUUID(&pImage->Header);
1654	}
1655	vdiCloseImage(pImage);
1656	}
1657
1658	LogFlow(("VDICheckImage: returns %Vrc\n", rc));
1659	return rc;
1660	}
1661
1662	/**
1663	* Changes an image's comment string.
1664	*
1665	* @returns VBox status code.
1666	* @param pszFilename Name of the image file to operate on.
1667	* @param pszComment New comment string (UTF-8). NULL is allowed to reset the comment.
1668	*/
1669	VBOXDDU_DECL(int) VDISetImageComment(const char pszFilename, const char pszComment)
1670	{
1671	LogFlow(("VDISetImageComment:\n"));
1672
1673	/*
1674	* Validate arguments.
1675	*/
1676	if ( !pszFilename
1677	\|\| *pszFilename == '\0')
1678	{
1679	AssertMsgFailed(("Invalid arguments: pszFilename=%p\n", pszFilename));
1680	return VERR_INVALID_PARAMETER;
1681	}
1682
1683	const size_t cchComment = pszComment ? strlen(pszComment) : 0;
1684	if (cchComment >= VDI_IMAGE_COMMENT_SIZE)
1685	{
1686	Log(("VDISetImageComment: pszComment is too long, %d bytes!\n", cchComment));
1687	return VERR_VDI_COMMENT_TOO_LONG;
1688	}
1689
1690	/*
1691	* Open the image for updating.
1692	*/
1693	PVDIIMAGEDESC pImage;
1694	int rc = vdiOpenImage(&pImage, pszFilename, VDI_OPEN_FLAGS_NORMAL, NULL);
1695	if (VBOX_FAILURE(rc))
1696	{
1697	Log(("VDISetImageComment: vdiOpenImage rc=%Vrc filename=\"%s\"!\n", rc, pszFilename));
1698	return rc;
1699	}
1700	if (!pImage->fReadOnly)
1701	{
1702	/* we don't support old style images */
1703	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
1704	{
1705	/*
1706	* Update the comment field, making sure to zero out all of the previous comment.
1707	*/
1708	memset(pImage->Header.u.v1.szComment, '\0', VDI_IMAGE_COMMENT_SIZE);
1709	memcpy(pImage->Header.u.v1.szComment, pszComment, cchComment);
1710
1711	/* write out new the header */
1712	rc = vdiUpdateHeader(pImage);
1713	AssertMsgRC(rc, ("vdiUpdateHeader() failed, filename=\"%s\", rc=%Vrc\n",
1714	pImage->szFilename, rc));
1715	}
1716	else
1717	{
1718	Log(("VDISetImageComment: Unsupported version!\n"));
1719	rc = VERR_VDI_UNSUPPORTED_VERSION;
1720	}
1721	}
1722	else
1723	{
1724	Log(("VDISetImageComment: image \"%s\" is opened as read-only!\n", pszFilename));
1725	rc = VERR_VDI_IMAGE_READ_ONLY;
1726	}
1727
1728	vdiCloseImage(pImage);
1729	return rc;
1730	}
1731
1732	/**
1733	* Creates a new base image file.
1734	*
1735	* @returns VBox status code.
1736	* @param pszFilename Name of the creating image file.
1737	* @param enmType Image type, only base image types are acceptable.
1738	* @param cbSize Image size in bytes.
1739	* @param pszComment Pointer to image comment. NULL is ok.
1740	* @param pfnProgress Progress callback. Optional.
1741	* @param pvUser User argument for the progress callback.
1742	*/
1743	VBOXDDU_DECL(int) VDICreateBaseImage(const char *pszFilename, VDIIMAGETYPE enmType, uint64_t cbSize,
1744	const char pszComment, PFNVMPROGRESS pfnProgress, void pvUser)
1745	{
1746	LogFlow(("VDICreateBaseImage:\n"));
1747
1748	/* Check arguments. */
1749	if ( !pszFilename
1750	\|\| *pszFilename == '\0'
1751	\|\| (enmType != VDI_IMAGE_TYPE_NORMAL && enmType != VDI_IMAGE_TYPE_FIXED)
1752	\|\| cbSize < VDI_IMAGE_DEFAULT_BLOCK_SIZE)
1753	{
1754	AssertMsgFailed(("Invalid arguments: pszFilename=%p enmType=%x cbSize=%llu\n",
1755	pszFilename, enmType, cbSize));
1756	return VERR_INVALID_PARAMETER;
1757	}
1758
1759	int rc = vdiCreateImage(pszFilename, enmType, VDI_IMAGE_FLAGS_DEFAULT, cbSize, pszComment, NULL,
1760	pfnProgress, pvUser);
1761	LogFlow(("VDICreateBaseImage: returns %Vrc for filename=\"%s\"\n", rc, pszFilename));
1762	return rc;
1763	}
1764
1765	/**
1766	* Creates a differencing dynamically growing image file for specified parent image.
1767	*
1768	* @returns VBox status code.
1769	* @param pszFilename Name of the creating differencing image file.
1770	* @param pszParent Name of the parent image file. May be base or diff image type.
1771	* @param pszComment Pointer to image comment. NULL is ok.
1772	* @param pfnProgress Progress callback. Optional.
1773	* @param pvUser User argument for the progress callback.
1774	*/
1775	VBOXDDU_DECL(int) VDICreateDifferenceImage(const char pszFilename, const char pszParent,
1776	const char *pszComment, PFNVMPROGRESS pfnProgress,
1777	void *pvUser)
1778	{
1779	LogFlow(("VDICreateDifferenceImage:\n"));
1780
1781	/* Check arguments. */
1782	if ( !pszFilename
1783	\|\| *pszFilename == '\0'
1784	\|\| !pszParent
1785	\|\| *pszParent == '\0')
1786	{
1787	AssertMsgFailed(("Invalid arguments: pszFilename=%p pszParent=%p\n",
1788	pszFilename, pszParent));
1789	return VERR_INVALID_PARAMETER;
1790	}
1791
1792	PVDIIMAGEDESC pParent;
1793	int rc = vdiOpenImage(&pParent, pszParent, VDI_OPEN_FLAGS_READONLY, NULL);
1794	if (VBOX_SUCCESS(rc))
1795	{
1796	rc = vdiCreateImage(pszFilename, VDI_IMAGE_TYPE_DIFF, VDI_IMAGE_FLAGS_DEFAULT,
1797	getImageDiskSize(&pParent->Header), pszComment, pParent,
1798	pfnProgress, pvUser);
1799	vdiCloseImage(pParent);
1800	}
1801	LogFlow(("VDICreateDifferenceImage: returns %Vrc for filename=\"%s\"\n", rc, pszFilename));
1802	return rc;
1803	}
1804
1805	/**
1806	* Deletes an image. Only valid image files can be deleted by this call.
1807	*
1808	* @returns VBox status code.
1809	* @param pszFilename Name of the image file to check.
1810	*/
1811	VBOXDDU_DECL(int) VDIDeleteImage(const char *pszFilename)
1812	{
1813	LogFlow(("VDIDeleteImage:\n"));
1814	/* Check arguments. */
1815	if ( !pszFilename
1816	\|\| *pszFilename == '\0')
1817	{
1818	AssertMsgFailed(("Invalid arguments: pszFilename=%p\n", pszFilename));
1819	return VERR_INVALID_PARAMETER;
1820	}
1821
1822	int rc = VDICheckImage(pszFilename, NULL, NULL, NULL, NULL, NULL, NULL, 0);
1823	if (VBOX_SUCCESS(rc))
1824	rc = RTFileDelete(pszFilename);
1825
1826	LogFlow(("VDIDeleteImage: returns %Vrc for filename=\"%s\"\n", rc, pszFilename));
1827	return rc;
1828	}
1829
1830	/**
1831	* Makes a copy of image file with a new (other) creation uuid.
1832	*
1833	* @returns VBox status code.
1834	* @param pszDstFilename Name of the image file to create.
1835	* @param pszSrcFilename Name of the image file to copy from.
1836	* @param pszComment Pointer to image comment. If NULL specified comment
1837	* will be copied from source image.
1838	* @param pfnProgress Progress callback. Optional.
1839	* @param pvUser User argument for the progress callback.
1840	*/
1841	VBOXDDU_DECL(int) VDICopyImage(const char pszDstFilename, const char pszSrcFilename,
1842	const char pszComment, PFNVMPROGRESS pfnProgress, void pvUser)
1843	{
1844	LogFlow(("VDICopyImage:\n"));
1845
1846	/* Check arguments. */
1847	if ( !pszDstFilename
1848	\|\| *pszDstFilename == '\0'
1849	\|\| !pszSrcFilename
1850	\|\| *pszSrcFilename == '\0')
1851	{
1852	AssertMsgFailed(("Invalid arguments: pszDstFilename=%p pszSrcFilename=%p\n",
1853	pszDstFilename, pszSrcFilename));
1854	return VERR_INVALID_PARAMETER;
1855	}
1856
1857	/* Special check for comment length. */
1858	if ( pszComment
1859	&& strlen(pszComment) >= VDI_IMAGE_COMMENT_SIZE)
1860	{
1861	Log(("VDICopyImage: pszComment is too long, cb=%d\n", strlen(pszComment)));
1862	return VERR_VDI_COMMENT_TOO_LONG;
1863	}
1864
1865	PVDIIMAGEDESC pImage;
1866	int rc = vdiOpenImage(&pImage, pszSrcFilename, VDI_OPEN_FLAGS_READONLY, NULL);
1867	if (VBOX_FAILURE(rc))
1868	{
1869	Log(("VDICopyImage: src image \"%s\" open failed rc=%Vrc\n", pszSrcFilename, rc));
1870	return rc;
1871	}
1872
1873	uint64_t cbFile = pImage->offStartData
1874	+ ((uint64_t)getImageBlocksAllocated(&pImage->Header) << pImage->uShiftIndex2Offset);
1875
1876	/* create file */
1877	RTFILE File;
1878	rc = RTFileOpen(&File,
1879	pszDstFilename,
1880	RTFILE_O_READWRITE \| RTFILE_O_CREATE \| RTFILE_O_DENY_ALL);
1881	if (VBOX_SUCCESS(rc))
1882	{
1883	/* lock new image exclusively to close any wrong access by VDI API calls. */
1884	rc = RTFileLock(File, RTFILE_LOCK_WRITE \| RTFILE_LOCK_IMMEDIATELY, 0, cbFile);
1885	if (VBOX_SUCCESS(rc))
1886	{
1887	/* Set the size of a new file. */
1888	rc = RTFileSetSize(File, cbFile);
1889	if (VBOX_SUCCESS(rc))
1890	{
1891	/* A dirty trick - use original image data to fill the new image. */
1892	RTFILE oldFileHandle = pImage->File;
1893	pImage->File = File;
1894	pImage->fReadOnly = false;
1895
1896	/* generate a new image creation uuid. */
1897	RTUuidCreate(getImageCreationUUID(&pImage->Header));
1898	/* generate a new image last-modified uuid. */
1899	RTUuidCreate(getImageModificationUUID(&pImage->Header));
1900	/* set image comment, if present. */
1901	if (pszComment)
1902	strncpy(getImageComment(&pImage->Header), pszComment, VDI_IMAGE_COMMENT_SIZE);
1903
1904	/* Write the pre-header to new image. */
1905	rc = RTFileSeek(pImage->File, 0, RTFILE_SEEK_BEGIN, NULL);
1906	if (VBOX_SUCCESS(rc))
1907	rc = RTFileWrite(pImage->File,
1908	&pImage->PreHeader,
1909	sizeof(pImage->PreHeader),
1910	NULL);
1911
1912	/* Write the header and the blocks array to new image. */
1913	if (VBOX_SUCCESS(rc))
1914	rc = vdiUpdateBlocks(pImage);
1915
1916	pImage->File = oldFileHandle;
1917	pImage->fReadOnly = true;
1918
1919	/* Seek to the data start in both images. */
1920	if (VBOX_SUCCESS(rc))
1921	rc = RTFileSeek(pImage->File,
1922	pImage->offStartData,
1923	RTFILE_SEEK_BEGIN,
1924	NULL);
1925	if (VBOX_SUCCESS(rc))
1926	rc = RTFileSeek(File,
1927	pImage->offStartData,
1928	RTFILE_SEEK_BEGIN,
1929	NULL);
1930
1931	if (VBOX_SUCCESS(rc))
1932	{
1933	/* alloc tmp buffer */
1934	void *pvBuf = RTMemTmpAlloc(VDIDISK_DEFAULT_BUFFER_SIZE);
1935	if (pvBuf)
1936	{
1937	/* Main copy loop. */
1938	uint64_t cbData = cbFile - pImage->offStartData;
1939	unsigned cBlocks = (unsigned)(cbData / VDIDISK_DEFAULT_BUFFER_SIZE);
1940	unsigned c = 0;
1941
1942	while (cbData)
1943	{
1944	unsigned cbToCopy = (unsigned)RT_MIN(cbData, VDIDISK_DEFAULT_BUFFER_SIZE);
1945
1946	/* Read. */
1947	rc = RTFileRead(pImage->File, pvBuf, cbToCopy, NULL);
1948	if (VBOX_FAILURE(rc))
1949	break;
1950
1951	/* Write. */
1952	rc = RTFileWrite(File, pvBuf, cbToCopy, NULL);
1953	if (VBOX_FAILURE(rc))
1954	break;
1955
1956	if (pfnProgress)
1957	{
1958	c++;
1959	rc = pfnProgress(NULL /* WARNING! pVM=NULL */,
1960	(c * 100) / cBlocks,
1961	pvUser);
1962	if (VBOX_FAILURE(rc))
1963	break;
1964	}
1965	cbData -= cbToCopy;
1966	}
1967
1968	RTMemTmpFree(pvBuf);
1969	}
1970	else
1971	rc = VERR_NO_MEMORY;
1972	}
1973	}
1974
1975	RTFileUnlock(File, 0, cbFile);
1976	}
1977
1978	RTFileClose(File);
1979
1980	if (VBOX_FAILURE(rc))
1981	RTFileDelete(pszDstFilename);
1982
1983	if (pfnProgress)
1984	pfnProgress(NULL /* WARNING! pVM=NULL */, 100, pvUser);
1985	}
1986
1987	vdiCloseImage(pImage);
1988
1989	LogFlow(("VDICopyImage: returns %Vrc for pszSrcFilename=\"%s\" pszDstFilename=\"%s\"\n",
1990	rc, pszSrcFilename, pszDstFilename));
1991	return rc;
1992	}
1993
1994	/**
1995	* Shrinks growing image file by removing zeroed data blocks.
1996	*
1997	* @returns VBox status code.
1998	* @param pszFilename Name of the image file to shrink.
1999	* @param pfnProgress Progress callback. Optional.
2000	* @param pvUser User argument for the progress callback.
2001	*/
2002	VBOXDDU_DECL(int) VDIShrinkImage(const char pszFilename, PFNVMPROGRESS pfnProgress, void pvUser)
2003	{
2004	LogFlow(("VDIShrinkImage:\n"));
2005
2006	/* Check arguments. */
2007	if ( !pszFilename
2008	\|\| *pszFilename == '\0')
2009	{
2010	AssertMsgFailed(("Invalid arguments: pszFilename=%p\n", pszFilename));
2011	return VERR_INVALID_PARAMETER;
2012	}
2013
2014	PVDIIMAGEDESC pImage;
2015	int rc = vdiOpenImage(&pImage, pszFilename, VDI_OPEN_FLAGS_NORMAL, NULL);
2016	if (VBOX_FAILURE(rc))
2017	{
2018	Log(("VDIShrinkImage: vdiOpenImage rc=%Vrc filename=\"%s\"\n", rc, pszFilename));
2019	return rc;
2020	}
2021	if (pImage->fReadOnly)
2022	{
2023	Log(("VDIShrinkImage: image \"%s\" is opened as read-only!\n", pszFilename));
2024	vdiCloseImage(pImage);
2025	return VERR_VDI_IMAGE_READ_ONLY;
2026	}
2027
2028	/* Do debug dump. */
2029	vdiDumpImage(pImage);
2030
2031	/* Working data. */
2032	unsigned cbBlock = getImageBlockSize(&pImage->Header);
2033	unsigned cBlocks = getImageBlocks(&pImage->Header);
2034	unsigned cBlocksAllocated = getImageBlocksAllocated(&pImage->Header);
2035
2036	uint64_t cbFile;
2037	rc = RTFileGetSize(pImage->File, &cbFile);
2038	if (VBOX_FAILURE(rc))
2039	{
2040	Log(("VDIShrinkImage: RTFileGetSize rc=%Vrc for file=\"%s\"\n", rc, pszFilename));
2041	vdiCloseImage(pImage);
2042	return rc;
2043	}
2044
2045	uint64_t cbData = cbFile - pImage->offStartData;
2046	unsigned cBlocksAllocated2 = (unsigned)(cbData >> pImage->uShiftIndex2Offset);
2047	if (cbData != (uint64_t)cBlocksAllocated << pImage->uShiftIndex2Offset)
2048	Log(("VDIShrinkImage: invalid image file length, cbBlock=%u cBlocks=%u cBlocksAllocated=%u cBlocksAllocated2=%u cbData=%llu\n",
2049	cbBlock, cBlocks, cBlocksAllocated, cBlocksAllocated2, cbData));
2050
2051	/* Allocate second blocks array for back resolving. */
2052	PVDIIMAGEBLOCKPOINTER paBlocks2 =
2053	(PVDIIMAGEBLOCKPOINTER)RTMemTmpAlloc(sizeof(VDIIMAGEBLOCKPOINTER) * cBlocks);
2054	if (!paBlocks2)
2055	{
2056	Log(("VDIShrinkImage: failed to allocate paBlocks2 buffer (%u bytes)\n", sizeof(VDIIMAGEBLOCKPOINTER) * cBlocks));
2057	vdiCloseImage(pImage);
2058	return VERR_NO_MEMORY;
2059	}
2060
2061	/* Init second blocks array. */
2062	for (unsigned n = 0; n < cBlocks; n++)
2063	paBlocks2[n] = VDI_IMAGE_BLOCK_FREE;
2064
2065	/* Fill second blocks array, check for allocational errors. */
2066	for (unsigned n = 0; n < cBlocks; n++)
2067	{
2068	if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[n]))
2069	{
2070	unsigned uBlock = pImage->paBlocks[n];
2071	if (uBlock < cBlocksAllocated2)
2072	{
2073	if (paBlocks2[uBlock] == VDI_IMAGE_BLOCK_FREE)
2074	paBlocks2[uBlock] = n;
2075	else
2076	{
2077	Log(("VDIShrinkImage: block n=%u -> uBlock=%u is already in use!\n", n, uBlock));
2078	/* free second link to block. */
2079	pImage->paBlocks[n] = VDI_IMAGE_BLOCK_FREE;
2080	}
2081	}
2082	else
2083	{
2084	Log(("VDIShrinkImage: block n=%u -> uBlock=%u is out of blocks range! (cbBlock=%u cBlocks=%u cBlocksAllocated=%u cBlocksAllocated2=%u cbData=%llu)\n",
2085	n, uBlock, cbBlock, cBlocks, cBlocksAllocated, cBlocksAllocated2, cbData));
2086	/* free link to invalid block. */
2087	pImage->paBlocks[n] = VDI_IMAGE_BLOCK_FREE;
2088	}
2089	}
2090	}
2091
2092	/* Allocate a working buffer for one block. */
2093	void *pvBuf = RTMemTmpAlloc(cbBlock);
2094	if (pvBuf)
2095	{
2096	/* Main voodoo loop, search holes and fill it. */
2097	unsigned uBlockWrite = 0;
2098	for (unsigned uBlock = 0; uBlock < cBlocksAllocated2; uBlock++)
2099	{
2100	if (paBlocks2[uBlock] != VDI_IMAGE_BLOCK_FREE)
2101	{
2102	/* Read the block from file and check for zeroes. */
2103	uint64_t u64Offset = ((uint64_t)uBlock << pImage->uShiftIndex2Offset)
2104	+ (pImage->offStartData + pImage->offStartBlockData);
2105	rc = RTFileSeek(pImage->File, u64Offset, RTFILE_SEEK_BEGIN, NULL);
2106	if (VBOX_FAILURE(rc))
2107	{
2108	Log(("VDIShrinkImage: seek rc=%Vrc filename=\"%s\" uBlock=%u cBlocks=%u cBlocksAllocated=%u cBlocksAllocated2=%u cbData=%llu\n",
2109	rc, pImage->szFilename, uBlock, cBlocks, cBlocksAllocated, cBlocksAllocated2, cbData));
2110	break;
2111	}
2112	rc = RTFileRead(pImage->File, pvBuf, cbBlock, NULL);
2113	if (VBOX_FAILURE(rc))
2114	{
2115	Log(("VDIShrinkImage: read rc=%Vrc filename=\"%s\" cbBlock=%u uBlock=%u cBlocks=%u cBlocksAllocated=%u cBlocksAllocated2=%u cbData=%llu\n",
2116	rc, pImage->szFilename, cbBlock, uBlock, cBlocks, cBlocksAllocated, cBlocksAllocated2, cbData));
2117	break;
2118	}
2119
2120	/* Check block for data. */
2121	Assert(cbBlock % 4 == 0);
2122	if (ASMBitFirstSet(pvBuf, cbBlock * 8) != -1)
2123	{
2124	/* Block has a data, may be it must be moved. */
2125	if (uBlockWrite < uBlock)
2126	{
2127	/* Move the block. */
2128	u64Offset = ((uint64_t)uBlockWrite << pImage->uShiftIndex2Offset)
2129	+ (pImage->offStartData + pImage->offStartBlockData);
2130	rc = RTFileSeek(pImage->File, u64Offset, RTFILE_SEEK_BEGIN, NULL);
2131	if (VBOX_FAILURE(rc))
2132	{
2133	Log(("VDIShrinkImage: seek(2) rc=%Vrc filename=\"%s\" uBlockWrite=%u cBlocks=%u cBlocksAllocated=%u cBlocksAllocated2=%u cbData=%llu\n",
2134	rc, pImage->szFilename, uBlockWrite, cBlocks, cBlocksAllocated, cBlocksAllocated2, cbData));
2135	break;
2136	}
2137	rc = RTFileWrite(pImage->File, pvBuf, cbBlock, NULL);
2138	if (VBOX_FAILURE(rc))
2139	{
2140	Log(("VDIShrinkImage: write rc=%Vrc filename=\"%s\" cbBlock=%u uBlockWrite=%u cBlocks=%u cBlocksAllocated=%u cBlocksAllocated2=%u cbData=%llu\n",
2141	rc, pImage->szFilename, cbBlock, uBlockWrite, cBlocks, cBlocksAllocated, cBlocksAllocated2, cbData));
2142	break;
2143	}
2144	}
2145	/* Fix the block pointer. */
2146	pImage->paBlocks[paBlocks2[uBlock]] = uBlockWrite;
2147	uBlockWrite++;
2148	}
2149	else
2150	{
2151	Log(("VDIShrinkImage: found a zeroed block, uBlock=%u\n", uBlock));
2152
2153	/* Fix the block pointer. */
2154	pImage->paBlocks[paBlocks2[uBlock]] = VDI_IMAGE_BLOCK_ZERO;
2155	}
2156	}
2157	else
2158	Log(("VDIShrinkImage: found an unused block, uBlock=%u\n", uBlock));
2159
2160	if (pfnProgress)
2161	{
2162	pfnProgress(NULL /* WARNING! pVM=NULL */,
2163	(uBlock * 100) / cBlocksAllocated2,
2164	pvUser);
2165	/* Shrink is unbreakable operation! */
2166	}
2167	}
2168
2169	RTMemTmpFree(pvBuf);
2170
2171	if ( VBOX_SUCCESS(rc)
2172	&& uBlockWrite < cBlocksAllocated2)
2173	{
2174	/* File size must be shrinked. */
2175	Log(("VDIShrinkImage: shrinking file size from %llu to %llu bytes\n",
2176	cbFile,
2177	pImage->offStartData + ((uint64_t)uBlockWrite << pImage->uShiftIndex2Offset)));
2178	rc = RTFileSetSize(pImage->File,
2179	pImage->offStartData + ((uint64_t)uBlockWrite << pImage->uShiftIndex2Offset));
2180	if (VBOX_FAILURE(rc))
2181	Log(("VDIShrinkImage: RTFileSetSize rc=%Vrc\n", rc));
2182	}
2183	cBlocksAllocated2 = uBlockWrite;
2184	}
2185	else
2186	{
2187	Log(("VDIShrinkImage: failed to allocate working buffer (%u bytes)\n", cbBlock));
2188	rc = VERR_NO_MEMORY;
2189	}
2190
2191	/* Save header and blocks array. */
2192	if (VBOX_SUCCESS(rc))
2193	{
2194	setImageBlocksAllocated(&pImage->Header, cBlocksAllocated2);
2195	rc = vdiUpdateBlocks(pImage);
2196	if (pfnProgress)
2197	pfnProgress(NULL /* WARNING! pVM=NULL */, 100, pvUser);
2198	}
2199
2200	/* Do debug dump. */
2201	vdiDumpImage(pImage);
2202
2203	/* Clean up. */
2204	RTMemTmpFree(paBlocks2);
2205	vdiCloseImage(pImage);
2206
2207	LogFlow(("VDIShrinkImage: returns %Vrc for filename=\"%s\"\n", rc, pszFilename));
2208	return rc;
2209	}
2210
2211	/**
2212	* Converts image file from older VDI formats to current one.
2213	*
2214	* @returns VBox status code.
2215	* @param pszFilename Name of the image file to convert.
2216	* @param pfnProgress Progress callback. Optional.
2217	* @param pvUser User argument for the progress callback.
2218	* @remark Only used by vditool
2219	*/
2220	VBOXDDU_DECL(int) VDIConvertImage(const char pszFilename, PFNVMPROGRESS pfnProgress, void pvUser)
2221	{
2222	LogFlow(("VDIConvertImage:\n"));
2223
2224	/* Check arguments. */
2225	if ( !pszFilename
2226	\|\| *pszFilename == '\0')
2227	{
2228	AssertMsgFailed(("Invalid arguments: pszFilename=%p\n", pszFilename));
2229	return VERR_INVALID_PARAMETER;
2230	}
2231
2232	PVDIIMAGEDESC pImage;
2233	int rc = vdiOpenImage(&pImage, pszFilename, VDI_OPEN_FLAGS_NORMAL, NULL);
2234	if (VBOX_FAILURE(rc))
2235	{
2236	Log(("VDIConvertImage: vdiOpenImage rc=%Vrc filename=\"%s\"\n", rc, pszFilename));
2237	return rc;
2238	}
2239
2240	VDIHEADER Header = {0};
2241	int off;
2242	uint64_t cbFile;
2243	uint64_t cbData;
2244
2245	if (pImage->fReadOnly)
2246	{
2247	Log(("VDIConvertImage: image \"%s\" is opened as read-only!\n", pszFilename));
2248	rc = VERR_VDI_IMAGE_READ_ONLY;
2249	goto l_conversion_failed;
2250	}
2251
2252	if (pImage->PreHeader.u32Version != 0x00000002)
2253	{
2254	Log(("VDIConvertImage: unsupported version=%08X filename=\"%s\"\n",
2255	pImage->PreHeader.u32Version, pszFilename));
2256	rc = VERR_VDI_UNSUPPORTED_VERSION;
2257	goto l_conversion_failed;
2258	}
2259
2260	/* Build new version header from old one. */
2261	vdiInitHeader(&Header,
2262	getImageType(&pImage->Header),
2263	VDI_IMAGE_FLAGS_DEFAULT, /* Safety issue: Always use default flags. */
2264	getImageComment(&pImage->Header),
2265	getImageDiskSize(&pImage->Header),
2266	getImageBlockSize(&pImage->Header),
2267	0);
2268	setImageBlocksAllocated(&Header, getImageBlocksAllocated(&pImage->Header));
2269	getImageGeometry(&Header) = getImageGeometry(&pImage->Header);
2270	setImageTranslation(&Header, getImageTranslation(&pImage->Header));
2271	getImageCreationUUID(&Header) = getImageCreationUUID(&pImage->Header);
2272	getImageModificationUUID(&Header) = getImageModificationUUID(&pImage->Header);
2273
2274	/* Calc data offset. */
2275	off = getImageDataOffset(&Header) - getImageDataOffset(&pImage->Header);
2276	if (off <= 0)
2277	{
2278	rc = VERR_VDI_INVALID_HEADER;
2279	goto l_conversion_failed;
2280	}
2281
2282	rc = RTFileGetSize(pImage->File, &cbFile);
2283	if (VBOX_FAILURE(rc))
2284	goto l_conversion_failed;
2285
2286	/* Check file size. */
2287	cbData = cbFile - getImageDataOffset(&pImage->Header);
2288	if (cbData != (uint64_t)getImageBlocksAllocated(&pImage->Header) << pImage->uShiftIndex2Offset)
2289	{
2290	AssertMsgFailed(("Invalid file size, broken image?\n"));
2291	rc = VERR_VDI_INVALID_HEADER;
2292	goto l_conversion_failed;
2293	}
2294
2295	/* Expand file. */
2296	rc = RTFileSetSize(pImage->File, cbFile + off);
2297	if (VBOX_FAILURE(rc))
2298	goto l_conversion_failed;
2299
2300	if (cbData > 0)
2301	{
2302	/* Calc current file position to move data from. */
2303	uint64_t offFile;
2304	if (cbData > VDIDISK_DEFAULT_BUFFER_SIZE)
2305	offFile = cbFile - VDIDISK_DEFAULT_BUFFER_SIZE;
2306	else
2307	offFile = getImageDataOffset(&pImage->Header);
2308
2309	unsigned cMoves = (unsigned)(cbData / VDIDISK_DEFAULT_BUFFER_SIZE);
2310	unsigned c = 0;
2311
2312	/* alloc tmp buffer */
2313	void *pvBuf = RTMemTmpAlloc(VDIDISK_DEFAULT_BUFFER_SIZE);
2314	if (pvBuf)
2315	{
2316	/* Move data. */
2317	for (;;)
2318	{
2319	unsigned cbToMove = (unsigned)RT_MIN(cbData, VDIDISK_DEFAULT_BUFFER_SIZE);
2320
2321	/* Read. */
2322	rc = RTFileSeek(pImage->File, offFile, RTFILE_SEEK_BEGIN, NULL);
2323	if (VBOX_FAILURE(rc))
2324	break;
2325	rc = RTFileRead(pImage->File, pvBuf, cbToMove, NULL);
2326	if (VBOX_FAILURE(rc))
2327	break;
2328
2329	/* Write. */
2330	rc = RTFileSeek(pImage->File, offFile + off, RTFILE_SEEK_BEGIN, NULL);
2331	if (VBOX_FAILURE(rc))
2332	break;
2333	rc = RTFileWrite(pImage->File, pvBuf, cbToMove, NULL);
2334	if (VBOX_FAILURE(rc))
2335	break;
2336
2337	if (pfnProgress)
2338	{
2339	c++;
2340	pfnProgress(NULL /* WARNING! pVM=NULL */,
2341	(c * 100) / cMoves,
2342	pvUser);
2343	/* Note: conversion is non breakable operation, skipping rc here. */
2344	}
2345
2346	cbData -= cbToMove;
2347	if (cbData == 0)
2348	break;
2349
2350	if (cbData > VDIDISK_DEFAULT_BUFFER_SIZE)
2351	offFile -= VDIDISK_DEFAULT_BUFFER_SIZE;
2352	else
2353	offFile = getImageDataOffset(&pImage->Header);
2354	}
2355
2356	/* Fill the beginning of file with zeroes to wipe out old headers etc. */
2357	if (VBOX_SUCCESS(rc))
2358	{
2359	Assert(offFile + off <= VDIDISK_DEFAULT_BUFFER_SIZE);
2360	rc = RTFileSeek(pImage->File, 0, RTFILE_SEEK_BEGIN, NULL);
2361	if (VBOX_SUCCESS(rc))
2362	{
2363	memset(pvBuf, 0, (unsigned)offFile + off);
2364	rc = RTFileWrite(pImage->File, pvBuf, (unsigned)offFile + off, NULL);
2365	}
2366	}
2367
2368	RTMemTmpFree(pvBuf);
2369	}
2370	else
2371	rc = VERR_NO_MEMORY;
2372
2373	if (VBOX_FAILURE(rc))
2374	goto l_conversion_failed;
2375	}
2376
2377	if (pfnProgress)
2378	{
2379	pfnProgress(NULL /* WARNING! pVM=NULL */, 100, pvUser);
2380	/* Note: conversion is non breakable operation, skipping rc here. */
2381	}
2382
2383	/* Data moved, now we need to save new pre header, header and blocks array. */
2384
2385	vdiInitPreHeader(&pImage->PreHeader);
2386	pImage->Header = Header;
2387
2388	/* Setup image parameters by header. */
2389	vdiSetupImageDesc(pImage);
2390
2391	/* Write pre-header. */
2392	rc = RTFileSeek(pImage->File, 0, RTFILE_SEEK_BEGIN, NULL);
2393	if (VBOX_FAILURE(rc))
2394	goto l_conversion_failed;
2395	rc = RTFileWrite(pImage->File, &pImage->PreHeader, sizeof(pImage->PreHeader), NULL);
2396	if (VBOX_FAILURE(rc))
2397	goto l_conversion_failed;
2398
2399	/* Write header and blocks array. */
2400	rc = vdiUpdateBlocks(pImage);
2401
2402	l_conversion_failed:
2403	vdiCloseImage(pImage);
2404
2405	LogFlow(("VDIConvertImage: returns %Vrc for filename=\"%s\"\n", rc, pszFilename));
2406	return rc;
2407	}
2408
2409	/**
2410	* Queries the image's UUID and parent UUIDs.
2411	*
2412	* @returns VBox status code.
2413	* @param pszFilename Name of the image file to operate on.
2414	* @param pUuid Where to store image UUID (can be NULL).
2415	* @param pModificationUuid Where to store modification UUID (can be NULL).
2416	* @param pParentUuuid Where to store parent UUID (can be NULL).
2417	* @param pParentModificationUuid Where to store parent modification UUID (can be NULL).
2418	*/
2419	VBOXDDU_DECL(int) VDIGetImageUUIDs(const char *pszFilename,
2420	PRTUUID pUuid, PRTUUID pModificationUuid,
2421	PRTUUID pParentUuid, PRTUUID pParentModificationUuid)
2422	{
2423	LogFlow(("VDIGetImageUUIDs:\n"));
2424
2425	/* Check arguments. */
2426	if ( !pszFilename
2427	\|\| *pszFilename == '\0')
2428	{
2429	AssertMsgFailed(("Invalid arguments: pszFilename=%p\n", pszFilename));
2430	return VERR_INVALID_PARAMETER;
2431	}
2432
2433	/*
2434	* Try open the specified image.
2435	*/
2436	PVDIIMAGEDESC pImage;
2437	int rc = vdiOpenImage(&pImage, pszFilename, VDI_OPEN_FLAGS_NORMAL, NULL);
2438	if (VBOX_FAILURE(rc))
2439	{
2440	Log(("VDIGetImageUUIDs: vdiOpenImage rc=%Vrc filename=\"%s\"\n", rc, pszFilename));
2441	return rc;
2442	}
2443
2444	/*
2445	* Query data.
2446	*/
2447	if (pUuid)
2448	{
2449	PCRTUUID pTmpUuid = getImageCreationUUID(&pImage->Header);
2450	if (pTmpUuid)
2451	pUuid = pTmpUuid;
2452	else
2453	RTUuidClear(pUuid);
2454	}
2455	if (pModificationUuid)
2456	{
2457	PCRTUUID pTmpUuid = getImageModificationUUID(&pImage->Header);
2458	if (pTmpUuid)
2459	pModificationUuid = pTmpUuid;
2460	else
2461	RTUuidClear(pModificationUuid);
2462	}
2463	if (pParentUuid)
2464	{
2465	PCRTUUID pTmpUuid = getImageParentUUID(&pImage->Header);
2466	if (pTmpUuid)
2467	pParentUuid = pTmpUuid;
2468	else
2469	RTUuidClear(pParentUuid);
2470	}
2471	if (pParentModificationUuid)
2472	{
2473	PCRTUUID pTmpUuid = getImageParentModificationUUID(&pImage->Header);
2474	if (pTmpUuid)
2475	pParentModificationUuid = pTmpUuid;
2476	else
2477	RTUuidClear(pParentModificationUuid);
2478	}
2479
2480	/*
2481	* Close the image.
2482	*/
2483	vdiCloseImage(pImage);
2484
2485	return VINF_SUCCESS;
2486	}
2487
2488	/**
2489	* Changes the image's UUID and parent UUIDs.
2490	*
2491	* @returns VBox status code.
2492	* @param pszFilename Name of the image file to operate on.
2493	* @param pUuid Optional parameter, new UUID of the image.
2494	* @param pModificationUuid Optional parameter, new modification UUID of the image.
2495	* @param pParentUuuid Optional parameter, new parent UUID of the image.
2496	* @param pParentModificationUuid Optional parameter, new parent modification UUID of the image.
2497	*/
2498	VBOXDDU_DECL(int) VDISetImageUUIDs(const char *pszFilename,
2499	PCRTUUID pUuid, PCRTUUID pModificationUuid,
2500	PCRTUUID pParentUuid, PCRTUUID pParentModificationUuid)
2501	{
2502	LogFlow(("VDISetImageUUIDs:\n"));
2503
2504	/* Check arguments. */
2505	if ( !pszFilename
2506	\|\| *pszFilename == '\0')
2507	{
2508	AssertMsgFailed(("Invalid arguments: pszFilename=%p\n", pszFilename));
2509	return VERR_INVALID_PARAMETER;
2510	}
2511
2512	PVDIIMAGEDESC pImage;
2513	int rc = vdiOpenImage(&pImage, pszFilename, VDI_OPEN_FLAGS_NORMAL, NULL);
2514	if (VBOX_FAILURE(rc))
2515	{
2516	Log(("VDISetImageUUIDs: vdiOpenImage rc=%Vrc filename=\"%s\"\n", rc, pszFilename));
2517	return rc;
2518	}
2519	if (!pImage->fReadOnly)
2520	{
2521	/* we only support new images */
2522	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) == 1)
2523	{
2524	if (pUuid)
2525	pImage->Header.u.v1.uuidCreate = *pUuid;
2526
2527	if (pModificationUuid)
2528	pImage->Header.u.v1.uuidModify = *pModificationUuid;
2529
2530	if (pParentUuid)
2531	pImage->Header.u.v1.uuidLinkage = *pParentUuid;
2532
2533	if (pParentModificationUuid)
2534	pImage->Header.u.v1.uuidParentModify = *pParentModificationUuid;
2535
2536	/* write out new header */
2537	rc = vdiUpdateHeader(pImage);
2538	AssertMsgRC(rc, ("vdiUpdateHeader() failed, filename=\"%s\", rc=%Vrc\n",
2539	pImage->szFilename, rc));
2540	}
2541	else
2542	{
2543	Log(("VDISetImageUUIDs: Version is not supported!\n"));
2544	rc = VERR_VDI_UNSUPPORTED_VERSION;
2545	}
2546	}
2547	else
2548	{
2549	Log(("VDISetImageUUIDs: image \"%s\" is opened as read-only!\n", pszFilename));
2550	rc = VERR_VDI_IMAGE_READ_ONLY;
2551	}
2552
2553	vdiCloseImage(pImage);
2554	return rc;
2555	}
2556
2557	/**
2558	* Merges two images having a parent/child relationship (both directions).
2559	*
2560	* @returns VBox status code.
2561	* @param pszFilenameFrom Name of the image file to merge from.
2562	* @param pszFilenameTo Name of the image file to merge into.
2563	* @param pfnProgress Progress callback. Optional. NULL if not to be used.
2564	* @param pvUser User argument for the progress callback.
2565	*/
2566	VBOXDDU_DECL(int) VDIMergeImage(const char pszFilenameFrom, const char pszFilenameTo,
2567	PFNVMPROGRESS pfnProgress, void *pvUser)
2568	{
2569	LogFlow(("VDIMergeImage:\n"));
2570
2571	/* Check arguments. */
2572	if ( !pszFilenameFrom
2573	\|\| *pszFilenameFrom == '\0'
2574	\|\| !pszFilenameTo
2575	\|\| *pszFilenameTo == '\0')
2576	{
2577	AssertMsgFailed(("Invalid arguments: pszFilenameFrom=%p, pszFilenameTo=%p\n", pszFilenameFrom, pszFilenameTo));
2578	return VERR_INVALID_PARAMETER;
2579	}
2580
2581	PVDIIMAGEDESC pImageFrom;
2582	int rc = vdiOpenImage(&pImageFrom, pszFilenameFrom, VDI_OPEN_FLAGS_READONLY, NULL);
2583	if (VBOX_FAILURE(rc))
2584	{
2585	Log(("VDIMergeImage: vdiOpenImage rc=%Vrc pstFilenameFrom=\"%s\"\n", rc, pszFilenameFrom));
2586	return rc;
2587	}
2588
2589	PVDIIMAGEDESC pImageTo;
2590	rc = vdiOpenImage(&pImageTo, pszFilenameTo, VDI_OPEN_FLAGS_NORMAL, NULL);
2591	if (VBOX_FAILURE(rc))
2592	{
2593	Log(("VDIMergeImage: vdiOpenImage rc=%Vrc pszFilenameTo=\"%s\"\n", rc, pszFilenameTo));
2594	vdiCloseImage(pImageFrom);
2595	return rc;
2596	}
2597	if (pImageTo->fReadOnly)
2598	{
2599	Log(("VDIMergeImage: image \"%s\" is opened as read-only!\n", pszFilenameTo));
2600	vdiCloseImage(pImageFrom);
2601	vdiCloseImage(pImageTo);
2602	return VERR_VDI_IMAGE_READ_ONLY;
2603	}
2604
2605	/*
2606	* when merging, we should not update the modification uuid of the target
2607	* image, because from the point of view of its children, it hasn't been
2608	* logically changed after the successful merge.
2609	*/
2610	vdiDisableLastModifiedUpdate(pImageTo);
2611
2612	/*
2613	* Check in which direction we merge
2614	*/
2615
2616	bool bParentToChild = false;
2617	if ( getImageParentUUID(&pImageFrom->Header)
2618	&& !RTUuidCompare(getImageParentUUID(&pImageFrom->Header),
2619	getImageCreationUUID(&pImageTo->Header))
2620	&& !RTUuidCompare(getImageParentModificationUUID(&pImageFrom->Header),
2621	getImageModificationUUID(&pImageTo->Header)))
2622	{
2623	/* we merge from a child to its parent */
2624	}
2625	else
2626	if ( getImageParentUUID(&pImageTo->Header)
2627	&& !RTUuidCompare(getImageParentUUID(&pImageTo->Header),
2628	getImageCreationUUID(&pImageFrom->Header))
2629	&& !RTUuidCompare(getImageParentModificationUUID(&pImageTo->Header),
2630	getImageModificationUUID(&pImageFrom->Header)))
2631	{
2632	/* we merge from a parent to its child */
2633	bParentToChild = true;
2634	}
2635	else
2636	{
2637	/* the images are not related, we can't merge! */
2638	Log(("VDIMergeImages: images do not have a parent/child or child/parent relationship!\n"));
2639	rc = VERR_VDI_IMAGES_UUID_MISMATCH;
2640	}
2641
2642	rc = vdiMergeImages(pImageFrom, pImageTo, bParentToChild, pfnProgress, pvUser);
2643
2644	if (pfnProgress)
2645	{
2646	pfnProgress(NULL /* WARNING! pVM=NULL */, 100, pvUser);
2647	/* Note: commiting is non breakable operation, skipping rc here. */
2648	}
2649
2650	/* cleanup */
2651	vdiCloseImage(pImageFrom);
2652	vdiCloseImage(pImageTo);
2653
2654	Log(("VDIMergeImage: done, returning with rc = %Vrc\n", rc));
2655	return rc;
2656	}
2657
2658
2659	/**
2660	* Initialize the VDIDISK structure.
2661	*/
2662	void vdiInitVDIDisk(PVDIDISK pDisk)
2663	{
2664	Assert(pDisk);
2665	pDisk->u32Signature = VDIDISK_SIGNATURE;
2666	pDisk->cImages = 0;
2667	pDisk->pBase = NULL;
2668	pDisk->pLast = NULL;
2669	pDisk->cbBlock = VDI_IMAGE_DEFAULT_BLOCK_SIZE;
2670	pDisk->cbBuf = VDIDISK_DEFAULT_BUFFER_SIZE;
2671	pDisk->fHonorZeroWrites = false;
2672	}
2673
2674	/**
2675	* internal: add image structure to the end of images list.
2676	*/
2677	static void vdiAddImageToList(PVDIDISK pDisk, PVDIIMAGEDESC pImage)
2678	{
2679	pImage->pPrev = NULL;
2680	pImage->pNext = NULL;
2681
2682	if (pDisk->pBase)
2683	{
2684	Assert(pDisk->cImages > 0);
2685	pImage->pPrev = pDisk->pLast;
2686	pDisk->pLast->pNext = pImage;
2687	pDisk->pLast = pImage;
2688	}
2689	else
2690	{
2691	Assert(pDisk->cImages == 0);
2692	pDisk->pBase = pImage;
2693	pDisk->pLast = pImage;
2694	}
2695
2696	pDisk->cImages++;
2697	}
2698
2699	/**
2700	* internal: remove image structure from the images list.
2701	*/
2702	static void vdiRemoveImageFromList(PVDIDISK pDisk, PVDIIMAGEDESC pImage)
2703	{
2704	Assert(pDisk->cImages > 0);
2705
2706	if (pImage->pPrev)
2707	pImage->pPrev->pNext = pImage->pNext;
2708	else
2709	pDisk->pBase = pImage->pNext;
2710
2711	if (pImage->pNext)
2712	pImage->pNext->pPrev = pImage->pPrev;
2713	else
2714	pDisk->pLast = pImage->pPrev;
2715
2716	pImage->pPrev = NULL;
2717	pImage->pNext = NULL;
2718
2719	pDisk->cImages--;
2720	}
2721
2722	/**
2723	* Allocates and initializes VDI HDD container.
2724	*
2725	* @returns Pointer to newly created HDD container with no one opened image file.
2726	* @returns NULL on failure, typically out of memory.
2727	*/
2728	VBOXDDU_DECL(PVDIDISK) VDIDiskCreate(void)
2729	{
2730	PVDIDISK pDisk = (PVDIDISK)RTMemAllocZ(sizeof(VDIDISK));
2731	if (pDisk)
2732	vdiInitVDIDisk(pDisk);
2733	LogFlow(("VDIDiskCreate: returns pDisk=%X\n", pDisk));
2734	return pDisk;
2735	}
2736
2737	/**
2738	* Destroys VDI HDD container. If container has opened image files they will be closed.
2739	*
2740	* @param pDisk Pointer to VDI HDD container.
2741	*/
2742	VBOXDDU_DECL(void) VDIDiskDestroy(PVDIDISK pDisk)
2743	{
2744	LogFlow(("VDIDiskDestroy: pDisk=%X\n", pDisk));
2745	/* sanity check */
2746	Assert(pDisk);
2747	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2748
2749	if (pDisk)
2750	{
2751	VDIDiskCloseAllImages(pDisk);
2752	RTMemFree(pDisk);
2753	}
2754	}
2755
2756	/**
2757	* Get working buffer size of VDI HDD container.
2758	*
2759	* @returns Working buffer size in bytes.
2760	*/
2761	VBOXDDU_DECL(unsigned) VDIDiskGetBufferSize(PVDIDISK pDisk)
2762	{
2763	/* sanity check */
2764	Assert(pDisk);
2765	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2766
2767	LogFlow(("VDIDiskGetBufferSize: returns %u\n", pDisk->cbBuf));
2768	return pDisk->cbBuf;
2769	}
2770
2771	/**
2772	* Get read/write mode of VDI HDD.
2773	*
2774	* @returns Disk ReadOnly status.
2775	* @returns true if no one VDI image is opened in HDD container.
2776	*/
2777	VBOXDDU_DECL(bool) VDIDiskIsReadOnly(PVDIDISK pDisk)
2778	{
2779	/* sanity check */
2780	Assert(pDisk);
2781	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2782
2783	if (pDisk->pLast)
2784	{
2785	LogFlow(("VDIDiskIsReadOnly: returns %u\n", pDisk->pLast->fReadOnly));
2786	return pDisk->pLast->fReadOnly;
2787	}
2788
2789	AssertMsgFailed(("No one disk image is opened!\n"));
2790	return true;
2791	}
2792
2793	/**
2794	* Get disk size of VDI HDD container.
2795	*
2796	* @returns Virtual disk size in bytes.
2797	* @returns 0 if no one VDI image is opened in HDD container.
2798	*/
2799	VBOXDDU_DECL(uint64_t) VDIDiskGetSize(PVDIDISK pDisk)
2800	{
2801	/* sanity check */
2802	Assert(pDisk);
2803	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2804
2805	if (pDisk->pBase)
2806	{
2807	LogFlow(("VDIDiskGetSize: returns %llu\n", getImageDiskSize(&pDisk->pBase->Header)));
2808	return getImageDiskSize(&pDisk->pBase->Header);
2809	}
2810
2811	AssertMsgFailed(("No one disk image is opened!\n"));
2812	return 0;
2813	}
2814
2815	/**
2816	* Get block size of VDI HDD container.
2817	*
2818	* @returns VDI image block size in bytes.
2819	* @returns 0 if no one VDI image is opened in HDD container.
2820	*/
2821	VBOXDDU_DECL(unsigned) VDIDiskGetBlockSize(PVDIDISK pDisk)
2822	{
2823	/* sanity check */
2824	Assert(pDisk);
2825	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2826
2827	if (pDisk->pBase)
2828	{
2829	LogFlow(("VDIDiskGetBlockSize: returns %u\n", getImageBlockSize(&pDisk->pBase->Header)));
2830	return getImageBlockSize(&pDisk->pBase->Header);
2831	}
2832
2833	AssertMsgFailed(("No one disk image is opened!\n"));
2834	return 0;
2835	}
2836
2837	/**
2838	* Get virtual disk geometry stored in image file.
2839	*
2840	* @returns VBox status code.
2841	* @returns VERR_VDI_NOT_OPENED if no one VDI image is opened in HDD container.
2842	* @returns VERR_VDI_GEOMETRY_NOT_SET if no geometry has been setted.
2843	* @param pDisk Pointer to VDI HDD container.
2844	* @param pcCylinders Where to store the number of cylinders. NULL is ok.
2845	* @param pcHeads Where to store the number of heads. NULL is ok.
2846	* @param pcSectors Where to store the number of sectors. NULL is ok.
2847	*/
2848	VBOXDDU_DECL(int) VDIDiskGetGeometry(PVDIDISK pDisk, unsigned pcCylinders, unsigned pcHeads, unsigned *pcSectors)
2849	{
2850	/* sanity check */
2851	Assert(pDisk);
2852	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2853
2854	if (pDisk->pBase)
2855	{
2856	int rc = VINF_SUCCESS;
2857	PVDIDISKGEOMETRY pGeometry = getImageGeometry(&pDisk->pBase->Header);
2858	LogFlow(("VDIDiskGetGeometry: C/H/S = %u/%u/%u\n",
2859	pGeometry->cCylinders, pGeometry->cHeads, pGeometry->cSectors));
2860	if ( pGeometry->cCylinders > 0
2861	&& pGeometry->cHeads > 0
2862	&& pGeometry->cSectors > 0)
2863	{
2864	if (pcCylinders)
2865	*pcCylinders = pGeometry->cCylinders;
2866	if (pcHeads)
2867	*pcHeads = pGeometry->cHeads;
2868	if (pcSectors)
2869	*pcSectors = pGeometry->cSectors;
2870	}
2871	else
2872	rc = VERR_VDI_GEOMETRY_NOT_SET;
2873
2874	LogFlow(("VDIDiskGetGeometry: returns %Vrc\n", rc));
2875	return rc;
2876	}
2877
2878	AssertMsgFailed(("No one disk image is opened!\n"));
2879	return VERR_VDI_NOT_OPENED;
2880	}
2881
2882	/**
2883	* Store virtual disk geometry into base image file of HDD container.
2884	*
2885	* Note that in case of unrecoverable error all images of HDD container will be closed.
2886	*
2887	* @returns VBox status code.
2888	* @returns VERR_VDI_NOT_OPENED if no one VDI image is opened in HDD container.
2889	* @param pDisk Pointer to VDI HDD container.
2890	* @param cCylinders Number of cylinders.
2891	* @param cHeads Number of heads.
2892	* @param cSectors Number of sectors.
2893	*/
2894	VBOXDDU_DECL(int) VDIDiskSetGeometry(PVDIDISK pDisk, unsigned cCylinders, unsigned cHeads, unsigned cSectors)
2895	{
2896	LogFlow(("VDIDiskSetGeometry: C/H/S = %u/%u/%u\n", cCylinders, cHeads, cSectors));
2897	/* sanity check */
2898	Assert(pDisk);
2899	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2900
2901	if (pDisk->pBase)
2902	{
2903	PVDIDISKGEOMETRY pGeometry = getImageGeometry(&pDisk->pBase->Header);
2904	pGeometry->cCylinders = cCylinders;
2905	pGeometry->cHeads = cHeads;
2906	pGeometry->cSectors = cSectors;
2907	pGeometry->cbSector = VDI_GEOMETRY_SECTOR_SIZE;
2908
2909	/* Update header information in base image file. */
2910	int rc = vdiUpdateReadOnlyHeader(pDisk->pBase);
2911	LogFlow(("VDIDiskSetGeometry: returns %Vrc\n", rc));
2912	return rc;
2913	}
2914
2915	AssertMsgFailed(("No one disk image is opened!\n"));
2916	return VERR_VDI_NOT_OPENED;
2917	}
2918
2919	/**
2920	* Get virtual disk translation mode stored in image file.
2921	*
2922	* @returns VBox status code.
2923	* @returns VERR_VDI_NOT_OPENED if no one VDI image is opened in HDD container.
2924	* @param pDisk Pointer to VDI HDD container.
2925	* @param penmTranslation Where to store the translation mode (see pdm.h).
2926	*/
2927	VBOXDDU_DECL(int) VDIDiskGetTranslation(PVDIDISK pDisk, PPDMBIOSTRANSLATION penmTranslation)
2928	{
2929	/* sanity check */
2930	Assert(pDisk);
2931	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2932	Assert(penmTranslation);
2933
2934	if (pDisk->pBase)
2935	{
2936	*penmTranslation = getImageTranslation(&pDisk->pBase->Header);
2937	LogFlow(("VDIDiskGetTranslation: translation=%d\n", *penmTranslation));
2938	return VINF_SUCCESS;
2939	}
2940
2941	AssertMsgFailed(("No one disk image is opened!\n"));
2942	return VERR_VDI_NOT_OPENED;
2943	}
2944
2945	/**
2946	* Store virtual disk translation mode into base image file of HDD container.
2947	*
2948	* Note that in case of unrecoverable error all images of HDD container will be closed.
2949	*
2950	* @returns VBox status code.
2951	* @returns VERR_VDI_NOT_OPENED if no one VDI image is opened in HDD container.
2952	* @param pDisk Pointer to VDI HDD container.
2953	* @param enmTranslation Translation mode (see pdm.h).
2954	*/
2955	VBOXDDU_DECL(int) VDIDiskSetTranslation(PVDIDISK pDisk, PDMBIOSTRANSLATION enmTranslation)
2956	{
2957	LogFlow(("VDIDiskSetTranslation: enmTranslation=%d\n", enmTranslation));
2958	/* sanity check */
2959	Assert(pDisk);
2960	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2961
2962	if (pDisk->pBase)
2963	{
2964	setImageTranslation(&pDisk->pBase->Header, enmTranslation);
2965
2966	/* Update header information in base image file. */
2967	int rc = vdiUpdateReadOnlyHeader(pDisk->pBase);
2968	LogFlow(("VDIDiskSetTranslation: returns %Vrc\n", rc));
2969	return rc;
2970	}
2971
2972	AssertMsgFailed(("No one disk image is opened!\n"));
2973	return VERR_VDI_NOT_OPENED;
2974	}
2975
2976	/**
2977	* Get number of opened images in HDD container.
2978	*
2979	* @returns Number of opened images for HDD container. 0 if no images is opened.
2980	* @param pDisk Pointer to VDI HDD container.
2981	*/
2982	VBOXDDU_DECL(int) VDIDiskGetImagesCount(PVDIDISK pDisk)
2983	{
2984	/* sanity check */
2985	Assert(pDisk);
2986	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
2987
2988	LogFlow(("VDIDiskGetImagesCount: returns %d\n", pDisk->cImages));
2989	return pDisk->cImages;
2990	}
2991
2992	static PVDIIMAGEDESC vdiGetImageByNumber(PVDIDISK pDisk, int nImage)
2993	{
2994	PVDIIMAGEDESC pImage = pDisk->pBase;
2995	while (pImage && nImage)
2996	{
2997	pImage = pImage->pNext;
2998	nImage--;
2999	}
3000	return pImage;
3001	}
3002
3003	/**
3004	* Get version of opened image of HDD container.
3005	*
3006	* @returns VBox status code.
3007	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3008	* @param pDisk Pointer to VDI HDD container.
3009	* @param nImage Image number, counts from 0. 0 is always base image of container.
3010	* @param puVersion Where to store the image version.
3011	*/
3012	VBOXDDU_DECL(int) VDIDiskGetImageVersion(PVDIDISK pDisk, int nImage, unsigned *puVersion)
3013	{
3014	/* sanity check */
3015	Assert(pDisk);
3016	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3017	Assert(puVersion);
3018
3019	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3020	Assert(pImage);
3021
3022	if (pImage)
3023	{
3024	*puVersion = pImage->PreHeader.u32Version;
3025	LogFlow(("VDIDiskGetImageVersion: returns %08X\n", pImage->PreHeader.u32Version));
3026	return VINF_SUCCESS;
3027	}
3028
3029	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3030	return VERR_VDI_IMAGE_NOT_FOUND;
3031	}
3032
3033	/**
3034	* Get filename of opened image of HDD container.
3035	*
3036	* @returns VBox status code.
3037	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3038	* @returns VERR_BUFFER_OVERFLOW if pszFilename buffer too small to hold filename.
3039	* @param pDisk Pointer to VDI HDD container.
3040	* @param nImage Image number, counts from 0. 0 is always base image of container.
3041	* @param pszFilename Where to store the image file name.
3042	* @param cbFilename Size of buffer pszFilename points to.
3043	*/
3044	VBOXDDU_DECL(int) VDIDiskGetImageFilename(PVDIDISK pDisk, int nImage, char *pszFilename, unsigned cbFilename)
3045	{
3046	/* sanity check */
3047	Assert(pDisk);
3048	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3049	Assert(pszFilename);
3050
3051	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3052	Assert(pImage);
3053
3054	if (pImage)
3055	{
3056	unsigned cb = strlen(pImage->szFilename);
3057	if (cb < cbFilename)
3058	{
3059	/* memcpy is much better than strncpy. */
3060	memcpy(pszFilename, pImage->szFilename, cb + 1);
3061	LogFlow(("VDIDiskGetImageFilename: returns VINF_SUCCESS, filename=\"%s\" nImage=%d\n",
3062	pszFilename, nImage));
3063	return VINF_SUCCESS;
3064	}
3065	else
3066	{
3067	AssertMsgFailed(("Out of buffer space, cbFilename=%d needed=%d\n", cbFilename, cb + 1));
3068	return VERR_BUFFER_OVERFLOW;
3069	}
3070	}
3071
3072	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3073	return VERR_VDI_IMAGE_NOT_FOUND;
3074	}
3075
3076	/**
3077	* Get the comment line of opened image of HDD container.
3078	*
3079	* @returns VBox status code.
3080	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3081	* @returns VERR_BUFFER_OVERFLOW if pszComment buffer too small to hold comment text.
3082	* @param pDisk Pointer to VDI HDD container.
3083	* @param nImage Image number, counts from 0. 0 is always base image of container.
3084	* @param pszComment Where to store the comment string of image. NULL is ok.
3085	* @param cbComment The size of pszComment buffer. 0 is ok.
3086	*/
3087	VBOXDDU_DECL(int) VDIDiskGetImageComment(PVDIDISK pDisk, int nImage, char *pszComment, unsigned cbComment)
3088	{
3089	/* sanity check */
3090	Assert(pDisk);
3091	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3092	Assert(pszComment);
3093
3094	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3095	Assert(pImage);
3096
3097	if (pImage)
3098	{
3099	char *pszTmp = getImageComment(&pImage->Header);
3100	unsigned cb = strlen(pszTmp);
3101	if (cb < cbComment)
3102	{
3103	/* memcpy is much better than strncpy. */
3104	memcpy(pszComment, pszTmp, cb + 1);
3105	LogFlow(("VDIDiskGetImageComment: returns VINF_SUCCESS, comment=\"%s\" nImage=%d\n",
3106	pszTmp, nImage));
3107	return VINF_SUCCESS;
3108	}
3109	else
3110	{
3111	AssertMsgFailed(("Out of buffer space, cbComment=%d needed=%d\n", cbComment, cb + 1));
3112	return VERR_BUFFER_OVERFLOW;
3113	}
3114	}
3115
3116	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3117	return VERR_VDI_IMAGE_NOT_FOUND;
3118	}
3119
3120	/**
3121	* Get type of opened image of HDD container.
3122	*
3123	* @returns VBox status code.
3124	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3125	* @param pDisk Pointer to VDI HDD container.
3126	* @param nImage Image number, counts from 0. 0 is always base image of container.
3127	* @param penmType Where to store the image type.
3128	*/
3129	VBOXDDU_DECL(int) VDIDiskGetImageType(PVDIDISK pDisk, int nImage, PVDIIMAGETYPE penmType)
3130	{
3131	/* sanity check */
3132	Assert(pDisk);
3133	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3134	Assert(penmType);
3135
3136	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3137	Assert(pImage);
3138
3139	if (pImage)
3140	{
3141	*penmType = getImageType(&pImage->Header);
3142	LogFlow(("VDIDiskGetImageType: returns VINF_SUCCESS, type=%X nImage=%d\n",
3143	*penmType, nImage));
3144	return VINF_SUCCESS;
3145	}
3146
3147	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3148	return VERR_VDI_IMAGE_NOT_FOUND;
3149	}
3150
3151	/**
3152	* Get flags of opened image of HDD container.
3153	*
3154	* @returns VBox status code.
3155	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3156	* @param pDisk Pointer to VDI HDD container.
3157	* @param nImage Image number, counts from 0. 0 is always base image of container.
3158	* @param pfFlags Where to store the image flags.
3159	*/
3160	VBOXDDU_DECL(int) VDIDiskGetImageFlags(PVDIDISK pDisk, int nImage, unsigned *pfFlags)
3161	{
3162	/* sanity check */
3163	Assert(pDisk);
3164	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3165	Assert(pfFlags);
3166
3167	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3168	Assert(pImage);
3169
3170	if (pImage)
3171	{
3172	*pfFlags = getImageFlags(&pImage->Header);
3173	LogFlow(("VDIDiskGetImageFlags: returns VINF_SUCCESS, flags=%08X nImage=%d\n",
3174	*pfFlags, nImage));
3175	return VINF_SUCCESS;
3176	}
3177
3178	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3179	return VERR_VDI_IMAGE_NOT_FOUND;
3180	}
3181
3182	/**
3183	* Get Uuid of opened image of HDD container.
3184	*
3185	* @returns VBox status code.
3186	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3187	* @param pDisk Pointer to VDI HDD container.
3188	* @param nImage Image number, counts from 0. 0 is always base image of container.
3189	* @param pUuid Where to store the image creation uuid.
3190	*/
3191	VBOXDDU_DECL(int) VDIDiskGetImageUuid(PVDIDISK pDisk, int nImage, PRTUUID pUuid)
3192	{
3193	/* sanity check */
3194	Assert(pDisk);
3195	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3196	Assert(pUuid);
3197
3198	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3199	Assert(pImage);
3200
3201	if (pImage)
3202	{
3203	pUuid = getImageCreationUUID(&pImage->Header);
3204	LogFlow(("VDIDiskGetImageUuid: returns VINF_SUCCESS, uuid={%Vuuid} nImage=%d\n",
3205	pUuid, nImage));
3206	return VINF_SUCCESS;
3207	}
3208
3209	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3210	return VERR_VDI_IMAGE_NOT_FOUND;
3211	}
3212
3213	/**
3214	* Get last modification Uuid of opened image of HDD container.
3215	*
3216	* @returns VBox status code.
3217	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3218	* @param pDisk Pointer to VDI HDD container.
3219	* @param nImage Image number, counts from 0. 0 is always base image of container.
3220	* @param pUuid Where to store the image modification uuid.
3221	*/
3222	VBOXDDU_DECL(int) VDIDiskGetImageModificationUuid(PVDIDISK pDisk, int nImage, PRTUUID pUuid)
3223	{
3224	/* sanity check */
3225	Assert(pDisk);
3226	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3227	Assert(pUuid);
3228
3229	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3230	Assert(pImage);
3231
3232	if (pImage)
3233	{
3234	pUuid = getImageModificationUUID(&pImage->Header);
3235	LogFlow(("VDIDiskGetImageModificationUuid: returns VINF_SUCCESS, uuid={%Vuuid} nImage=%d\n",
3236	pUuid, nImage));
3237	return VINF_SUCCESS;
3238	}
3239
3240	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3241	return VERR_VDI_IMAGE_NOT_FOUND;
3242	}
3243
3244	/**
3245	* Get Uuid of opened image's parent image.
3246	*
3247	* @returns VBox status code.
3248	* @returns VERR_VDI_IMAGE_NOT_FOUND if image with specified number was not opened.
3249	* @param pDisk Pointer to VDI HDD container.
3250	* @param nImage Image number, counts from 0. 0 is always base image of the container.
3251	* @param pUuid Where to store the image creation uuid.
3252	*/
3253	VBOXDDU_DECL(int) VDIDiskGetParentImageUuid(PVDIDISK pDisk, int nImage, PRTUUID pUuid)
3254	{
3255	/* sanity check */
3256	Assert(pDisk);
3257	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3258	Assert(pUuid);
3259
3260	PVDIIMAGEDESC pImage = vdiGetImageByNumber(pDisk, nImage);
3261	if (pImage)
3262	{
3263	pUuid = getImageParentUUID(&pImage->Header);
3264	LogFlow(("VDIDiskGetParentImageUuid: returns VINF_SUCCESS, *pUuid={%Vuuid} nImage=%d\n",
3265	pUuid, nImage));
3266	return VINF_SUCCESS;
3267	}
3268
3269	AssertMsgFailed(("Image %d was not found (cImages=%d)\n", nImage, pDisk->cImages));
3270	return VERR_VDI_IMAGE_NOT_FOUND;
3271	}
3272
3273	/**
3274	* Relock the image as read/write or read-only.
3275	*/
3276	int vdiChangeImageMode(PVDIIMAGEDESC pImage, bool fReadOnly)
3277	{
3278	Assert(pImage);
3279
3280	if ( !fReadOnly
3281	&& pImage->fOpen & VDI_OPEN_FLAGS_READONLY)
3282	{
3283	/* Can't switch read-only opened image to read-write mode. */
3284	Log(("vdiChangeImageMode: can't switch r/o image to r/w mode, filename=\"%s\" fOpen=%X\n",
3285	pImage->szFilename, pImage->fOpen));
3286	return VERR_VDI_IMAGE_READ_ONLY;
3287	}
3288
3289	/* Flush last image changes if was r/w mode. */
3290	vdiFlushImage(pImage);
3291
3292	/* Change image locking. */
3293	uint64_t cbLock = pImage->offStartData
3294	+ ((uint64_t)getImageBlocks(&pImage->Header) << pImage->uShiftIndex2Offset);
3295	int rc = RTFileChangeLock(pImage->File,
3296	(fReadOnly) ?
3297	RTFILE_LOCK_READ \| RTFILE_LOCK_IMMEDIATELY :
3298	RTFILE_LOCK_WRITE \| RTFILE_LOCK_IMMEDIATELY,
3299	0,
3300	cbLock);
3301	if (VBOX_SUCCESS(rc))
3302	{
3303	pImage->fReadOnly = fReadOnly;
3304	Log(("vdiChangeImageMode: Image \"%s\" mode changed to %s\n",
3305	pImage->szFilename, (pImage->fReadOnly) ? "read-only" : "read/write"));
3306	return VINF_SUCCESS;
3307	}
3308
3309	/* Check for the most bad error in the world. Damn! It must never happens in real life! */
3310	if (rc == VERR_FILE_LOCK_LOST)
3311	{
3312	/* And what we can do now?! */
3313	AssertMsgFailed(("Image lock has been lost for file=\"%s\"", pImage->szFilename));
3314	Log(("vdiChangeImageMode: image lock has been lost for file=\"%s\", blocking on r/o lock wait",
3315	pImage->szFilename));
3316
3317	/* Try to obtain read lock in blocking mode. Maybe it's a very bad method. */
3318	rc = RTFileLock(pImage->File, RTFILE_LOCK_READ \| RTFILE_LOCK_WAIT, 0, cbLock);
3319	AssertReleaseRC(rc);
3320
3321	pImage->fReadOnly = false;
3322	if (pImage->fReadOnly != fReadOnly)
3323	rc = VERR_FILE_LOCK_VIOLATION;
3324	}
3325
3326	Log(("vdiChangeImageMode: Image \"%s\" mode change failed with rc=%Vrc, mode is %s\n",
3327	pImage->szFilename, rc, (pImage->fReadOnly) ? "read-only" : "read/write"));
3328
3329	return rc;
3330	}
3331
3332	/**
3333	* internal: try to save header in image file even if image is in read-only mode.
3334	*/
3335	static int vdiUpdateReadOnlyHeader(PVDIIMAGEDESC pImage)
3336	{
3337	int rc = VINF_SUCCESS;
3338
3339	if (pImage->fReadOnly)
3340	{
3341	rc = vdiChangeImageMode(pImage, false);
3342	if (VBOX_SUCCESS(rc))
3343	{
3344	vdiFlushImage(pImage);
3345	rc = vdiChangeImageMode(pImage, true);
3346	AssertReleaseRC(rc);
3347	}
3348	}
3349	else
3350	vdiFlushImage(pImage);
3351
3352	return rc;
3353	}
3354
3355	/**
3356	* Opens an image file.
3357	*
3358	* The first opened image file in a HDD container must have a base image type,
3359	* others (next opened images) must be a differencing or undo images.
3360	* Linkage is checked for differencing image to be in consistence with the previously opened image.
3361	* When a next differencing image is opened and the last image was opened in read/write access
3362	* mode, then the last image is reopened in read-only with deny write sharing mode. This allows
3363	* other processes to use images in read-only mode too.
3364	*
3365	* Note that the image can be opened in read-only mode if a read/write open is not possible.
3366	* Use VDIDiskIsReadOnly to check open mode.
3367	*
3368	* @returns VBox status code.
3369	* @param pDisk Pointer to VDI HDD container.
3370	* @param pszFilename Name of the image file to open.
3371	* @param fOpen Image file open mode, see VDI_OPEN_FLAGS_* constants.
3372	*/
3373	VBOXDDU_DECL(int) VDIDiskOpenImage(PVDIDISK pDisk, const char *pszFilename, unsigned fOpen)
3374	{
3375	/* sanity check */
3376	Assert(pDisk);
3377	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3378
3379	/* Check arguments. */
3380	if ( !pszFilename
3381	\|\| *pszFilename == '\0'
3382	\|\| (fOpen & ~VDI_OPEN_FLAGS_MASK))
3383	{
3384	AssertMsgFailed(("Invalid arguments: pszFilename=%p fOpen=%x\n", pszFilename, fOpen));
3385	return VERR_INVALID_PARAMETER;
3386	}
3387	LogFlow(("VDIDiskOpenImage: pszFilename=\"%s\" fOpen=%X\n", pszFilename, fOpen));
3388
3389	PVDIIMAGEDESC pImage;
3390	int rc = vdiOpenImage(&pImage, pszFilename, fOpen, pDisk->pLast);
3391	if (VBOX_SUCCESS(rc))
3392	{
3393	if (pDisk->pLast)
3394	{
3395	/* Opening differencing image. */
3396	if (!pDisk->pLast->fReadOnly)
3397	{
3398	/*
3399	* Previous image is opened in read/write mode -> switch it into read-only.
3400	*/
3401	rc = vdiChangeImageMode(pDisk->pLast, true);
3402	}
3403	}
3404	else
3405	{
3406	/* Opening base image, check its type. */
3407	if ( getImageType(&pImage->Header) != VDI_IMAGE_TYPE_NORMAL
3408	&& getImageType(&pImage->Header) != VDI_IMAGE_TYPE_FIXED)
3409	{
3410	rc = VERR_VDI_INVALID_TYPE;
3411	}
3412	}
3413
3414	if (VBOX_SUCCESS(rc))
3415	vdiAddImageToList(pDisk, pImage);
3416	else
3417	vdiCloseImage(pImage);
3418	}
3419
3420	LogFlow(("VDIDiskOpenImage: returns %Vrc\n", rc));
3421	return rc;
3422	}
3423
3424	/**
3425	* Closes the last opened image file in the HDD container. Leaves all changes inside it.
3426	* If previous image file was opened in read-only mode (that is normal) and closing image
3427	* was opened in read-write mode (the whole disk was in read-write mode) - the previous image
3428	* will be reopened in read/write mode.
3429	*
3430	* @param pDisk Pointer to VDI HDD container.
3431	*/
3432	VBOXDDU_DECL(void) VDIDiskCloseImage(PVDIDISK pDisk)
3433	{
3434	/* sanity check */
3435	Assert(pDisk);
3436	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3437
3438	PVDIIMAGEDESC pImage = pDisk->pLast;
3439	if (pImage)
3440	{
3441	LogFlow(("VDIDiskCloseImage: closing image \"%s\"\n", pImage->szFilename));
3442
3443	bool fWasReadOnly = pImage->fReadOnly;
3444	vdiRemoveImageFromList(pDisk, pImage);
3445	vdiCloseImage(pImage);
3446
3447	if ( !fWasReadOnly
3448	&& pDisk->pLast
3449	&& pDisk->pLast->fReadOnly
3450	&& !(pDisk->pLast->fOpen & VDI_OPEN_FLAGS_READONLY))
3451	{
3452	/*
3453	* Closed image was opened in read/write mode, previous image was opened
3454	* in read-only mode, try to switch it into read/write.
3455	*/
3456	int rc = vdiChangeImageMode(pDisk->pLast, false);
3457	NOREF(rc); /* gcc still hates unused variables... */
3458	}
3459
3460	return;
3461	}
3462	AssertMsgFailed(("No images to close\n"));
3463	}
3464
3465	/**
3466	* Closes all opened image files in HDD container.
3467	*
3468	* @param pDisk Pointer to VDI HDD container.
3469	*/
3470	VBOXDDU_DECL(void) VDIDiskCloseAllImages(PVDIDISK pDisk)
3471	{
3472	LogFlow(("VDIDiskCloseAllImages:\n"));
3473	/* sanity check */
3474	Assert(pDisk);
3475	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3476
3477	PVDIIMAGEDESC pImage = pDisk->pLast;
3478	while (pImage)
3479	{
3480	PVDIIMAGEDESC pPrev = pImage->pPrev;
3481	vdiRemoveImageFromList(pDisk, pImage);
3482	vdiCloseImage(pImage);
3483	pImage = pPrev;
3484	}
3485	Assert(pDisk->pLast == NULL);
3486	}
3487
3488	/**
3489	* Commits last opened differencing/undo image file of HDD container to previous one.
3490	* If previous image file was opened in read-only mode (that must be always so) it is reopened
3491	* as read/write to do commit operation.
3492	* After successfull commit the previous image file again reopened in read-only mode, last opened
3493	* image file is cleared of data and remains open and active in HDD container.
3494	* If you want to delete image after commit you must do it manually by VDIDiskCloseImage and
3495	* VDIDeleteImage calls.
3496	*
3497	* Note that in case of unrecoverable error all images of HDD container will be closed.
3498	*
3499	* @returns VBox status code.
3500	* @param pDisk Pointer to VDI HDD container.
3501	* @param pfnProgress Progress callback. Optional.
3502	* @param pvUser User argument for the progress callback.
3503	* @remark Only used by tstVDI.
3504	*/
3505	VBOXDDU_DECL(int) VDIDiskCommitLastDiff(PVDIDISK pDisk, PFNVMPROGRESS pfnProgress, void *pvUser)
3506	{
3507	LogFlow(("VDIDiskCommitLastDiff:\n"));
3508	/* sanity check */
3509	Assert(pDisk);
3510	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3511
3512	int rc = VINF_SUCCESS;
3513	PVDIIMAGEDESC pImage = pDisk->pLast;
3514	if (!pImage)
3515	{
3516	AssertMsgFailed(("No one disk image is opened!\n"));
3517	return VERR_VDI_NOT_OPENED;
3518	}
3519
3520	if (pImage->fReadOnly)
3521	{
3522	AssertMsgFailed(("Image \"%s\" is read-only!\n", pImage->szFilename));
3523	return VERR_VDI_IMAGE_READ_ONLY;
3524	}
3525
3526	if (!pImage->pPrev)
3527	{
3528	AssertMsgFailed(("No images to commit to!\n"));
3529	return VERR_VDI_NO_DIFF_IMAGES;
3530	}
3531
3532	bool fWasReadOnly = pImage->pPrev->fReadOnly;
3533	if (fWasReadOnly)
3534	{
3535	/* Change previous image mode to r/w. */
3536	rc = vdiChangeImageMode(pImage->pPrev, false);
3537	if (VBOX_FAILURE(rc))
3538	{
3539	Log(("VDIDiskCommitLastDiff: can't switch previous image into r/w mode, rc=%Vrc\n", rc));
3540	return rc;
3541	}
3542	}
3543
3544	rc = vdiCommitToImage(pDisk, pImage->pPrev, pfnProgress, pvUser);
3545	if (VBOX_SUCCESS(rc) && fWasReadOnly)
3546	{
3547	/* Change previous image mode back to r/o. */
3548	rc = vdiChangeImageMode(pImage->pPrev, true);
3549	}
3550
3551	if (VBOX_FAILURE(rc))
3552	{
3553	/* Failed! Close all images, can't work with VHDD at all. */
3554	VDIDiskCloseAllImages(pDisk);
3555	AssertMsgFailed(("Fatal: commit failed, rc=%Vrc\n", rc));
3556	}
3557
3558	return rc;
3559	}
3560
3561	/**
3562	* Creates and opens a new differencing image file in HDD container.
3563	* See comments for VDIDiskOpenImage function about differencing images.
3564	*
3565	* @returns VBox status code.
3566	* @param pDisk Pointer to VDI HDD container.
3567	* @param pszFilename Name of the image file to create and open.
3568	* @param pszComment Pointer to image comment. NULL is ok.
3569	* @param pfnProgress Progress callback. Optional.
3570	* @param pvUser User argument for the progress callback.
3571	* @remark Only used by tstVDI.
3572	*/
3573	VBOXDDU_DECL(int) VDIDiskCreateOpenDifferenceImage(PVDIDISK pDisk, const char *pszFilename,
3574	const char *pszComment, PFNVMPROGRESS pfnProgress,
3575	void *pvUser)
3576	{
3577	LogFlow(("VDIDiskCreateOpenDifferenceImage:\n"));
3578	/* sanity check */
3579	Assert(pDisk);
3580	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3581	Assert(pszFilename);
3582
3583	if (!pDisk->pLast)
3584	{
3585	AssertMsgFailed(("No one disk image is opened!\n"));
3586	return VERR_VDI_NOT_OPENED;
3587	}
3588
3589	/* Flush last parent image changes if possible. */
3590	vdiFlushImage(pDisk->pLast);
3591
3592	int rc = vdiCreateImage(pszFilename,
3593	VDI_IMAGE_TYPE_DIFF,
3594	VDI_IMAGE_FLAGS_DEFAULT,
3595	getImageDiskSize(&pDisk->pLast->Header),
3596	pszComment,
3597	pDisk->pLast,
3598	pfnProgress, pvUser);
3599	if (VBOX_SUCCESS(rc))
3600	{
3601	rc = VDIDiskOpenImage(pDisk, pszFilename, VDI_OPEN_FLAGS_NORMAL);
3602	if (VBOX_FAILURE(rc))
3603	VDIDeleteImage(pszFilename);
3604	}
3605	LogFlow(("VDIDiskCreateOpenDifferenceImage: returns %Vrc, filename=\"%s\"\n", rc, pszFilename));
3606	return rc;
3607	}
3608
3609	/**
3610	* internal: debug image dump.
3611	*
3612	* @remark Only used by tstVDI.
3613	*/
3614	static void vdiDumpImage(PVDIIMAGEDESC pImage)
3615	{
3616	RTLogPrintf("Dumping VDI image \"%s\" mode=%s fOpen=%X File=%08X\n",
3617	pImage->szFilename,
3618	(pImage->fReadOnly) ? "r/o" : "r/w",
3619	pImage->fOpen,
3620	pImage->File);
3621	RTLogPrintf("Header: Version=%08X Type=%X Flags=%X Size=%llu\n",
3622	pImage->PreHeader.u32Version,
3623	getImageType(&pImage->Header),
3624	getImageFlags(&pImage->Header),
3625	getImageDiskSize(&pImage->Header));
3626	RTLogPrintf("Header: cbBlock=%u cbBlockExtra=%u cBlocks=%u cBlocksAllocated=%u\n",
3627	getImageBlockSize(&pImage->Header),
3628	getImageExtraBlockSize(&pImage->Header),
3629	getImageBlocks(&pImage->Header),
3630	getImageBlocksAllocated(&pImage->Header));
3631	RTLogPrintf("Header: offBlocks=%u offData=%u\n",
3632	getImageBlocksOffset(&pImage->Header),
3633	getImageDataOffset(&pImage->Header));
3634	PVDIDISKGEOMETRY pg = getImageGeometry(&pImage->Header);
3635	RTLogPrintf("Header: Geometry: C/H/S=%u/%u/%u cbSector=%u Mode=%u\n",
3636	pg->cCylinders, pg->cHeads, pg->cSectors, pg->cbSector,
3637	getImageTranslation(&pImage->Header));
3638	RTLogPrintf("Header: uuidCreation={%Vuuid}\n", getImageCreationUUID(&pImage->Header));
3639	RTLogPrintf("Header: uuidModification={%Vuuid}\n", getImageModificationUUID(&pImage->Header));
3640	RTLogPrintf("Header: uuidParent={%Vuuid}\n", getImageParentUUID(&pImage->Header));
3641	if (GET_MAJOR_HEADER_VERSION(&pImage->Header) >= 1)
3642	RTLogPrintf("Header: uuidParentModification={%Vuuid}\n", getImageParentModificationUUID(&pImage->Header));
3643	RTLogPrintf("Image: fFlags=%08X offStartBlocks=%u offStartData=%u\n",
3644	pImage->fFlags, pImage->offStartBlocks, pImage->offStartData);
3645	RTLogPrintf("Image: uBlockMask=%08X uShiftIndex2Offset=%u uShiftOffset2Index=%u offStartBlockData=%u\n",
3646	pImage->uBlockMask,
3647	pImage->uShiftIndex2Offset,
3648	pImage->uShiftOffset2Index,
3649	pImage->offStartBlockData);
3650
3651	unsigned uBlock, cBlocksNotFree, cBadBlocks, cBlocks = getImageBlocks(&pImage->Header);
3652	for (uBlock=0, cBlocksNotFree=0, cBadBlocks=0; uBlock<cBlocks; uBlock++)
3653	{
3654	if (IS_VDI_IMAGE_BLOCK_ALLOCATED(pImage->paBlocks[uBlock]))
3655	{
3656	cBlocksNotFree++;
3657	if (pImage->paBlocks[uBlock] >= cBlocks)
3658	cBadBlocks++;
3659	}
3660	}
3661	if (cBlocksNotFree != getImageBlocksAllocated(&pImage->Header))
3662	{
3663	RTLogPrintf("!! WARNING: %u blocks actually allocated (cBlocksAllocated=%u) !!\n",
3664	cBlocksNotFree, getImageBlocksAllocated(&pImage->Header));
3665	}
3666	if (cBadBlocks)
3667	{
3668	RTLogPrintf("!! WARNING: %u bad blocks found !!\n",
3669	cBadBlocks);
3670	}
3671	}
3672
3673	/**
3674	* Debug helper - dumps all opened images of HDD container into the log file.
3675	*
3676	* @param pDisk Pointer to VDI HDD container.
3677	* @remark Only used by tstVDI and vditool
3678	*/
3679	VBOXDDU_DECL(void) VDIDiskDumpImages(PVDIDISK pDisk)
3680	{
3681	/* sanity check */
3682	Assert(pDisk);
3683	AssertMsg(pDisk->u32Signature == VDIDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
3684
3685	RTLogPrintf("--- Dumping VDI Disk, Images=%u\n", pDisk->cImages);
3686	for (PVDIIMAGEDESC pImage = pDisk->pBase; pImage; pImage = pImage->pNext)
3687	vdiDumpImage(pImage);
3688	}
3689

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

source: vbox/trunk/src/VBox/Devices/Storage/VDICore.cpp@ 2392

Download in other formats: