VHD.cpp@ 54405

Last change on this file since 54405 was 54117, checked in by vboxsync, 10 years ago
don't check for VALID_PTR after RTMem*Alloc(), that's overkill
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 115.7 KB

Line
1	/* $Id: VHD.cpp 54117 2015-02-09 17:08:28Z vboxsync $ */
2	/** @file
3	* VHD Disk image, Core Code.
4	*/
5
6	/*
7	* Copyright (C) 2006-2013 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/*******************************************************************************
19	* Header Files *
20	*******************************************************************************/
21	#define LOG_GROUP LOG_GROUP_VD_VHD
22	#include <VBox/vd-plugin.h>
23	#include <VBox/err.h>
24
25	#include <VBox/log.h>
26	#include <VBox/version.h>
27	#include <iprt/asm.h>
28	#include <iprt/assert.h>
29	#include <iprt/mem.h>
30	#include <iprt/uuid.h>
31	#include <iprt/path.h>
32	#include <iprt/string.h>
33
34	#include "VDBackends.h"
35
36	#define VHD_RELATIVE_MAX_PATH 512
37	#define VHD_ABSOLUTE_MAX_PATH 512
38
39	#define VHD_SECTOR_SIZE 512
40	#define VHD_BLOCK_SIZE (2 * _1M)
41
42	/* This is common to all VHD disk types and is located at the end of the image */
43	#pragma pack(1)
44	typedef struct VHDFooter
45	{
46	char Cookie[8];
47	uint32_t Features;
48	uint32_t Version;
49	uint64_t DataOffset;
50	uint32_t TimeStamp;
51	uint8_t CreatorApp[4];
52	uint32_t CreatorVer;
53	uint32_t CreatorOS;
54	uint64_t OrigSize;
55	uint64_t CurSize;
56	uint16_t DiskGeometryCylinder;
57	uint8_t DiskGeometryHeads;
58	uint8_t DiskGeometrySectors;
59	uint32_t DiskType;
60	uint32_t Checksum;
61	char UniqueID[16];
62	uint8_t SavedState;
63	uint8_t Reserved[427];
64	} VHDFooter;
65	#pragma pack()
66
67	/* this really is spelled with only one n */
68	#define VHD_FOOTER_COOKIE "conectix"
69	#define VHD_FOOTER_COOKIE_SIZE 8
70
71	#define VHD_FOOTER_FEATURES_NOT_ENABLED 0
72	#define VHD_FOOTER_FEATURES_TEMPORARY 1
73	#define VHD_FOOTER_FEATURES_RESERVED 2
74
75	#define VHD_FOOTER_FILE_FORMAT_VERSION 0x00010000
76	#define VHD_FOOTER_DATA_OFFSET_FIXED UINT64_C(0xffffffffffffffff)
77	#define VHD_FOOTER_DISK_TYPE_FIXED 2
78	#define VHD_FOOTER_DISK_TYPE_DYNAMIC 3
79	#define VHD_FOOTER_DISK_TYPE_DIFFERENCING 4
80
81	#define VHD_MAX_LOCATOR_ENTRIES 8
82	#define VHD_PLATFORM_CODE_NONE 0
83	#define VHD_PLATFORM_CODE_WI2R 0x57693272
84	#define VHD_PLATFORM_CODE_WI2K 0x5769326B
85	#define VHD_PLATFORM_CODE_W2RU 0x57327275
86	#define VHD_PLATFORM_CODE_W2KU 0x57326B75
87	#define VHD_PLATFORM_CODE_MAC 0x4D163220
88	#define VHD_PLATFORM_CODE_MACX 0x4D163258
89
90	/* Header for expanding disk images. */
91	#pragma pack(1)
92	typedef struct VHDParentLocatorEntry
93	{
94	uint32_t u32Code;
95	uint32_t u32DataSpace;
96	uint32_t u32DataLength;
97	uint32_t u32Reserved;
98	uint64_t u64DataOffset;
99	} VHDPLE, *PVHDPLE;
100
101	typedef struct VHDDynamicDiskHeader
102	{
103	char Cookie[8];
104	uint64_t DataOffset;
105	uint64_t TableOffset;
106	uint32_t HeaderVersion;
107	uint32_t MaxTableEntries;
108	uint32_t BlockSize;
109	uint32_t Checksum;
110	uint8_t ParentUuid[16];
111	uint32_t ParentTimeStamp;
112	uint32_t Reserved0;
113	uint16_t ParentUnicodeName[256];
114	VHDPLE ParentLocatorEntry[VHD_MAX_LOCATOR_ENTRIES];
115	uint8_t Reserved1[256];
116	} VHDDynamicDiskHeader;
117	#pragma pack()
118
119	#define VHD_DYNAMIC_DISK_HEADER_COOKIE "cxsparse"
120	#define VHD_DYNAMIC_DISK_HEADER_COOKIE_SIZE 8
121	#define VHD_DYNAMIC_DISK_HEADER_VERSION 0x00010000
122
123	/**
124	* Complete VHD image data structure.
125	*/
126	typedef struct VHDIMAGE
127	{
128	/** Image file name. */
129	const char *pszFilename;
130	/** Opaque storage handle. */
131	PVDIOSTORAGE pStorage;
132
133	/** Pointer to the per-disk VD interface list. */
134	PVDINTERFACE pVDIfsDisk;
135	/** Pointer to the per-image VD interface list. */
136	PVDINTERFACE pVDIfsImage;
137	/** Error interface. */
138	PVDINTERFACEERROR pIfError;
139	/** I/O interface. */
140	PVDINTERFACEIOINT pIfIo;
141
142	/** Open flags passed by VBoxHDD layer. */
143	unsigned uOpenFlags;
144	/** Image flags defined during creation or determined during open. */
145	unsigned uImageFlags;
146	/** Total size of the image. */
147	uint64_t cbSize;
148
149	/** Physical geometry of this image. */
150	VDGEOMETRY PCHSGeometry;
151	/** Logical geometry of this image. */
152	VDGEOMETRY LCHSGeometry;
153
154	/** Image UUID. */
155	RTUUID ImageUuid;
156	/** Parent image UUID. */
157	RTUUID ParentUuid;
158
159	/** Parent's time stamp at the time of image creation. */
160	uint32_t u32ParentTimeStamp;
161	/** Relative path to the parent image. */
162	char *pszParentFilename;
163
164	/** The Block Allocation Table. */
165	uint32_t *pBlockAllocationTable;
166	/** Number of entries in the table. */
167	uint32_t cBlockAllocationTableEntries;
168
169	/** Size of one data block. */
170	uint32_t cbDataBlock;
171	/** Sectors per data block. */
172	uint32_t cSectorsPerDataBlock;
173	/** Length of the sector bitmap in bytes. */
174	uint32_t cbDataBlockBitmap;
175	/** A copy of the disk footer. */
176	VHDFooter vhdFooterCopy;
177	/** Current end offset of the file (without the disk footer). */
178	uint64_t uCurrentEndOfFile;
179	/** Size of the data block bitmap in sectors. */
180	uint32_t cDataBlockBitmapSectors;
181	/** Start of the block allocation table. */
182	uint64_t uBlockAllocationTableOffset;
183	/** Buffer to hold block's bitmap for bit search operations. */
184	uint8_t *pu8Bitmap;
185	/** Offset to the next data structure (dynamic disk header). */
186	uint64_t u64DataOffset;
187	/** Flag to force dynamic disk header update. */
188	bool fDynHdrNeedsUpdate;
189	} VHDIMAGE, *PVHDIMAGE;
190
191	/**
192	* Structure tracking the expansion process of the image
193	* for async access.
194	*/
195	typedef struct VHDIMAGEEXPAND
196	{
197	/** Flag indicating the status of each step. */
198	volatile uint32_t fFlags;
199	/** The index in the block allocation table which is written. */
200	uint32_t idxBatAllocated;
201	/** Big endian representation of the block index
202	* which is written in the BAT. */
203	uint32_t idxBlockBe;
204	/** Old end of the file - used for rollback in case of an error. */
205	uint64_t cbEofOld;
206	/** Sector bitmap written to the new block - variable in size. */
207	uint8_t au8Bitmap[1];
208	} VHDIMAGEEXPAND, *PVHDIMAGEEXPAND;
209
210	/**
211	* Flag defines
212	*/
213	#define VHDIMAGEEXPAND_STEP_IN_PROGRESS (0x0)
214	#define VHDIMAGEEXPAND_STEP_FAILED (0x2)
215	#define VHDIMAGEEXPAND_STEP_SUCCESS (0x3)
216	/** All steps completed successfully. */
217	#define VHDIMAGEEXPAND_ALL_SUCCESS (0xff)
218	/** All steps completed (no success indicator) */
219	#define VHDIMAGEEXPAND_ALL_COMPLETE (0xaa)
220
221	/** Every status field has 2 bits so we can encode 4 steps in one byte. */
222	#define VHDIMAGEEXPAND_STATUS_MASK 0x03
223	#define VHDIMAGEEXPAND_BLOCKBITMAP_STATUS_SHIFT 0x00
224	#define VHDIMAGEEXPAND_USERBLOCK_STATUS_SHIFT 0x02
225	#define VHDIMAGEEXPAND_FOOTER_STATUS_SHIFT 0x04
226	#define VHDIMAGEEXPAND_BAT_STATUS_SHIFT 0x06
227
228	/**
229	* Helper macros to get and set the status field.
230	*/
231	#define VHDIMAGEEXPAND_STATUS_GET(fFlags, cShift) \
232	(((fFlags) >> (cShift)) & VHDIMAGEEXPAND_STATUS_MASK)
233	#define VHDIMAGEEXPAND_STATUS_SET(fFlags, cShift, uVal) \
234	ASMAtomicOrU32(&(fFlags), ((uVal) & VHDIMAGEEXPAND_STATUS_MASK) << (cShift))
235
236	/*******************************************************************************
237	* Static Variables *
238	*******************************************************************************/
239
240	/** NULL-terminated array of supported file extensions. */
241	static const VDFILEEXTENSION s_aVhdFileExtensions[] =
242	{
243	{"vhd", VDTYPE_HDD},
244	{NULL, VDTYPE_INVALID}
245	};
246
247	/*******************************************************************************
248	* Internal Functions *
249	*******************************************************************************/
250
251
252	/**
253	* Internal: Compute and update header checksum.
254	*/
255	static uint32_t vhdChecksum(void *pHeader, uint32_t cbSize)
256	{
257	uint32_t checksum = 0;
258	for (uint32_t i = 0; i < cbSize; i++)
259	checksum += ((unsigned char *)pHeader)[i];
260	return ~checksum;
261	}
262
263	/**
264	* Internal: Convert filename to UTF16 with appropriate endianness.
265	*/
266	static int vhdFilenameToUtf16(const char pszFilename, uint16_t pu16Buf,
267	uint32_t cbBufSize, uint32_t *pcbActualSize,
268	bool fBigEndian)
269	{
270	int rc;
271	PRTUTF16 tmp16 = NULL;
272	size_t cTmp16Len;
273
274	rc = RTStrToUtf16(pszFilename, &tmp16);
275	if (RT_FAILURE(rc))
276	goto out;
277	cTmp16Len = RTUtf16Len(tmp16);
278	if (cTmp16Len * sizeof(*tmp16) > cbBufSize)
279	{
280	rc = VERR_FILENAME_TOO_LONG;
281	goto out;
282	}
283
284	if (fBigEndian)
285	for (unsigned i = 0; i < cTmp16Len; i++)
286	pu16Buf[i] = RT_H2BE_U16(tmp16[i]);
287	else
288	memcpy(pu16Buf, tmp16, cTmp16Len * sizeof(*tmp16));
289	if (pcbActualSize)
290	pcbActualSize = (uint32_t)(cTmp16Len sizeof(*tmp16));
291
292	out:
293	if (tmp16)
294	RTUtf16Free(tmp16);
295	return rc;
296	}
297
298	/**
299	* Internal: Update one locator entry.
300	*/
301	static int vhdLocatorUpdate(PVHDIMAGE pImage, PVHDPLE pLocator, const char *pszFilename)
302	{
303	int rc = VINF_SUCCESS;
304	uint32_t cb, cbMaxLen = RT_BE2H_U32(pLocator->u32DataSpace);
305	void *pvBuf = RTMemTmpAllocZ(cbMaxLen);
306	char *pszTmp;
307
308	if (!pvBuf)
309	return VERR_NO_MEMORY;
310
311	switch (RT_BE2H_U32(pLocator->u32Code))
312	{
313	case VHD_PLATFORM_CODE_WI2R:
314	{
315	if (RTPathStartsWithRoot(pszFilename))
316	{
317	/* Convert to relative path. */
318	char szPath[RTPATH_MAX];
319	rc = RTPathCalcRelative(szPath, sizeof(szPath), pImage->pszFilename,
320	pszFilename);
321	if (RT_SUCCESS(rc))
322	{
323	/* Update plain relative name. */
324	cb = (uint32_t)strlen(szPath);
325	if (cb > cbMaxLen)
326	{
327	rc = VERR_FILENAME_TOO_LONG;
328	break;
329	}
330	memcpy(pvBuf, szPath, cb);
331	}
332	}
333	else
334	{
335	/* Update plain relative name. */
336	cb = (uint32_t)strlen(pszFilename);
337	if (cb > cbMaxLen)
338	{
339	rc = VERR_FILENAME_TOO_LONG;
340	break;
341	}
342	memcpy(pvBuf, pszFilename, cb);
343	}
344	if (RT_SUCCESS(rc))
345	pLocator->u32DataLength = RT_H2BE_U32(cb);
346	break;
347	}
348	case VHD_PLATFORM_CODE_WI2K:
349	/* Update plain absolute name. */
350	rc = RTPathAbs(pszFilename, (char *)pvBuf, cbMaxLen);
351	if (RT_SUCCESS(rc))
352	pLocator->u32DataLength = RT_H2BE_U32((uint32_t)strlen((const char *)pvBuf));
353	break;
354	case VHD_PLATFORM_CODE_W2RU:
355	if (RTPathStartsWithRoot(pszFilename))
356	{
357	/* Convert to relative path. */
358	char szPath[RTPATH_MAX];
359	rc = RTPathCalcRelative(szPath, sizeof(szPath), pImage->pszFilename,
360	pszFilename);
361	if (RT_SUCCESS(rc))
362	rc = vhdFilenameToUtf16(szPath, (uint16_t *)pvBuf, cbMaxLen, &cb, false);
363	}
364	else
365	{
366	/* Update unicode relative name. */
367	rc = vhdFilenameToUtf16(pszFilename, (uint16_t *)pvBuf, cbMaxLen, &cb, false);
368	}
369
370	if (RT_SUCCESS(rc))
371	pLocator->u32DataLength = RT_H2BE_U32(cb);
372	break;
373	case VHD_PLATFORM_CODE_W2KU:
374	/* Update unicode absolute name. */
375	pszTmp = (char*)RTMemTmpAllocZ(cbMaxLen);
376	if (!pszTmp)
377	{
378	rc = VERR_NO_MEMORY;
379	break;
380	}
381	rc = RTPathAbs(pszFilename, pszTmp, cbMaxLen);
382	if (RT_FAILURE(rc))
383	{
384	RTMemTmpFree(pszTmp);
385	break;
386	}
387	rc = vhdFilenameToUtf16(pszTmp, (uint16_t *)pvBuf, cbMaxLen, &cb, false);
388	RTMemTmpFree(pszTmp);
389	if (RT_SUCCESS(rc))
390	pLocator->u32DataLength = RT_H2BE_U32(cb);
391	break;
392	default:
393	rc = VERR_NOT_IMPLEMENTED;
394	break;
395	}
396
397	if (RT_SUCCESS(rc))
398	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
399	RT_BE2H_U64(pLocator->u64DataOffset),
400	pvBuf, cb);
401
402	if (pvBuf)
403	RTMemTmpFree(pvBuf);
404	return rc;
405	}
406
407	/**
408	* Internal: Update dynamic disk header from VHDIMAGE.
409	*/
410	static int vhdDynamicHeaderUpdate(PVHDIMAGE pImage)
411	{
412	VHDDynamicDiskHeader ddh;
413	int rc, i;
414
415	if (!pImage)
416	return VERR_VD_NOT_OPENED;
417
418	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
419	pImage->u64DataOffset, &ddh, sizeof(ddh));
420	if (RT_FAILURE(rc))
421	return rc;
422	if (memcmp(ddh.Cookie, VHD_DYNAMIC_DISK_HEADER_COOKIE, VHD_DYNAMIC_DISK_HEADER_COOKIE_SIZE) != 0)
423	return VERR_VD_VHD_INVALID_HEADER;
424
425	uint32_t u32Checksum = RT_BE2H_U32(ddh.Checksum);
426	ddh.Checksum = 0;
427	if (u32Checksum != vhdChecksum(&ddh, sizeof(ddh)))
428	return VERR_VD_VHD_INVALID_HEADER;
429
430	/* Update parent's timestamp. */
431	ddh.ParentTimeStamp = RT_H2BE_U32(pImage->u32ParentTimeStamp);
432	/* Update parent's filename. */
433	if (pImage->pszParentFilename)
434	{
435	rc = vhdFilenameToUtf16(RTPathFilename(pImage->pszParentFilename),
436	ddh.ParentUnicodeName, sizeof(ddh.ParentUnicodeName) - 1, NULL, true);
437	if (RT_FAILURE(rc))
438	return rc;
439	}
440
441	/* Update parent's locators. */
442	for (i = 0; i < VHD_MAX_LOCATOR_ENTRIES; i++)
443	{
444	/* Skip empty locators */
445	if ( ddh.ParentLocatorEntry[i].u32Code != RT_H2BE_U32(VHD_PLATFORM_CODE_NONE)
446	&& pImage->pszParentFilename)
447	{
448	rc = vhdLocatorUpdate(pImage, &ddh.ParentLocatorEntry[i], pImage->pszParentFilename);
449	if (RT_FAILURE(rc))
450	return rc;
451	}
452	}
453	/* Update parent's UUID */
454	memcpy(ddh.ParentUuid, pImage->ParentUuid.au8, sizeof(ddh.ParentUuid));
455
456	/* Update data offset and number of table entries. */
457	ddh.MaxTableEntries = RT_H2BE_U32(pImage->cBlockAllocationTableEntries);
458
459	ddh.Checksum = 0;
460	ddh.Checksum = RT_H2BE_U32(vhdChecksum(&ddh, sizeof(ddh)));
461	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
462	pImage->u64DataOffset, &ddh, sizeof(ddh));
463	return rc;
464	}
465
466	/**
467	* Internal: Update the VHD footer.
468	*/
469	static int vhdUpdateFooter(PVHDIMAGE pImage)
470	{
471	int rc = VINF_SUCCESS;
472
473	/* Update fields which can change. */
474	pImage->vhdFooterCopy.CurSize = RT_H2BE_U64(pImage->cbSize);
475	pImage->vhdFooterCopy.DiskGeometryCylinder = RT_H2BE_U16(pImage->PCHSGeometry.cCylinders);
476	pImage->vhdFooterCopy.DiskGeometryHeads = pImage->PCHSGeometry.cHeads;
477	pImage->vhdFooterCopy.DiskGeometrySectors = pImage->PCHSGeometry.cSectors;
478
479	pImage->vhdFooterCopy.Checksum = 0;
480	pImage->vhdFooterCopy.Checksum = RT_H2BE_U32(vhdChecksum(&pImage->vhdFooterCopy, sizeof(VHDFooter)));
481
482	if (pImage->pBlockAllocationTable)
483	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, 0,
484	&pImage->vhdFooterCopy, sizeof(VHDFooter));
485
486	if (RT_SUCCESS(rc))
487	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
488	pImage->uCurrentEndOfFile, &pImage->vhdFooterCopy,
489	sizeof(VHDFooter));
490
491	return rc;
492	}
493
494	/**
495	* Internal. Flush image data to disk.
496	*/
497	static int vhdFlushImage(PVHDIMAGE pImage)
498	{
499	int rc = VINF_SUCCESS;
500
501	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
502	return VINF_SUCCESS;
503
504	if (pImage->pBlockAllocationTable)
505	{
506	/*
507	* This is an expanding image. Write the BAT and copy of the disk footer.
508	*/
509	size_t cbBlockAllocationTableToWrite = pImage->cBlockAllocationTableEntries * sizeof(uint32_t);
510	uint32_t pBlockAllocationTableToWrite = (uint32_t )RTMemAllocZ(cbBlockAllocationTableToWrite);
511
512	if (!pBlockAllocationTableToWrite)
513	return VERR_NO_MEMORY;
514
515	/*
516	* The BAT entries have to be stored in big endian format.
517	*/
518	for (unsigned i = 0; i < pImage->cBlockAllocationTableEntries; i++)
519	pBlockAllocationTableToWrite[i] = RT_H2BE_U32(pImage->pBlockAllocationTable[i]);
520
521	/*
522	* Write the block allocation table after the copy of the disk footer and the dynamic disk header.
523	*/
524	vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, pImage->uBlockAllocationTableOffset,
525	pBlockAllocationTableToWrite, cbBlockAllocationTableToWrite);
526	if (pImage->fDynHdrNeedsUpdate)
527	rc = vhdDynamicHeaderUpdate(pImage);
528	RTMemFree(pBlockAllocationTableToWrite);
529	}
530
531	if (RT_SUCCESS(rc))
532	rc = vhdUpdateFooter(pImage);
533
534	if (RT_SUCCESS(rc))
535	rc = vdIfIoIntFileFlushSync(pImage->pIfIo, pImage->pStorage);
536
537	return rc;
538	}
539
540	/**
541	* Internal. Free all allocated space for representing an image except pImage,
542	* and optionally delete the image from disk.
543	*/
544	static int vhdFreeImage(PVHDIMAGE pImage, bool fDelete)
545	{
546	int rc = VINF_SUCCESS;
547
548	/* Freeing a never allocated image (e.g. because the open failed) is
549	* not signalled as an error. After all nothing bad happens. */
550	if (pImage)
551	{
552	if (pImage->pStorage)
553	{
554	/* No point updating the file that is deleted anyway. */
555	if (!fDelete)
556	vhdFlushImage(pImage);
557
558	rc = vdIfIoIntFileClose(pImage->pIfIo, pImage->pStorage);
559	pImage->pStorage = NULL;
560	}
561
562	if (pImage->pszParentFilename)
563	{
564	RTStrFree(pImage->pszParentFilename);
565	pImage->pszParentFilename = NULL;
566	}
567	if (pImage->pBlockAllocationTable)
568	{
569	RTMemFree(pImage->pBlockAllocationTable);
570	pImage->pBlockAllocationTable = NULL;
571	}
572	if (pImage->pu8Bitmap)
573	{
574	RTMemFree(pImage->pu8Bitmap);
575	pImage->pu8Bitmap = NULL;
576	}
577
578	if (fDelete && pImage->pszFilename)
579	vdIfIoIntFileDelete(pImage->pIfIo, pImage->pszFilename);
580	}
581
582	LogFlowFunc(("returns %Rrc\n", rc));
583	return rc;
584	}
585
586	/* 946684800 is the number of seconds between 1/1/1970 and 1/1/2000 */
587	#define VHD_TO_UNIX_EPOCH_SECONDS UINT64_C(946684800)
588
589	static uint32_t vhdRtTime2VhdTime(PCRTTIMESPEC pRtTimeStamp)
590	{
591	uint64_t u64Seconds = RTTimeSpecGetSeconds(pRtTimeStamp);
592	return (uint32_t)(u64Seconds - VHD_TO_UNIX_EPOCH_SECONDS);
593	}
594
595	static void vhdTime2RtTime(PRTTIMESPEC pRtTimeStamp, uint32_t u32VhdTimeStamp)
596	{
597	RTTimeSpecSetSeconds(pRtTimeStamp, VHD_TO_UNIX_EPOCH_SECONDS + u32VhdTimeStamp);
598	}
599
600	/**
601	* Internal: Allocates the block bitmap rounding up to the next 32bit or 64bit boundary.
602	* Can be freed with RTMemFree. The memory is zeroed.
603	*/
604	DECLINLINE(uint8_t *)vhdBlockBitmapAllocate(PVHDIMAGE pImage)
605	{
606	#ifdef RT_ARCH_AMD64
607	return (uint8_t *)RTMemAllocZ(pImage->cbDataBlockBitmap + 8);
608	#else
609	return (uint8_t *)RTMemAllocZ(pImage->cbDataBlockBitmap + 4);
610	#endif
611	}
612
613	/**
614	* Internal: called when the async expansion process completed (failure or success).
615	* Will do the necessary rollback if an error occurred.
616	*/
617	static int vhdAsyncExpansionComplete(PVHDIMAGE pImage, PVDIOCTX pIoCtx, PVHDIMAGEEXPAND pExpand)
618	{
619	int rc = VINF_SUCCESS;
620	uint32_t fFlags = ASMAtomicReadU32(&pExpand->fFlags);
621	bool fIoInProgress = false;
622
623	/* Quick path, check if everything succeeded. */
624	if (fFlags == VHDIMAGEEXPAND_ALL_SUCCESS)
625	{
626	pImage->pBlockAllocationTable[pExpand->idxBatAllocated] = RT_BE2H_U32(pExpand->idxBlockBe);
627	RTMemFree(pExpand);
628	}
629	else
630	{
631	uint32_t uStatus;
632
633	uStatus = VHDIMAGEEXPAND_STATUS_GET(pExpand->fFlags, VHDIMAGEEXPAND_BAT_STATUS_SHIFT);
634	if ( uStatus == VHDIMAGEEXPAND_STEP_FAILED
635	\|\| uStatus == VHDIMAGEEXPAND_STEP_SUCCESS)
636	{
637	/* Undo and restore the old value. */
638	pImage->pBlockAllocationTable[pExpand->idxBatAllocated] = ~0U;
639
640	/* Restore the old value on the disk.
641	* No need for a completion callback because we can't
642	* do anything if this fails. */
643	if (uStatus == VHDIMAGEEXPAND_STEP_SUCCESS)
644	{
645	rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
646	pImage->uBlockAllocationTableOffset
647	+ pExpand->idxBatAllocated * sizeof(uint32_t),
648	&pImage->pBlockAllocationTable[pExpand->idxBatAllocated],
649	sizeof(uint32_t), pIoCtx, NULL, NULL);
650	fIoInProgress \|= rc == VERR_VD_ASYNC_IO_IN_PROGRESS;
651	}
652	}
653
654	/* Restore old size (including the footer because another application might
655	* fill up the free space making it impossible to add the footer)
656	* and add the footer at the right place again. */
657	rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage,
658	pExpand->cbEofOld + sizeof(VHDFooter));
659	AssertRC(rc);
660
661	pImage->uCurrentEndOfFile = pExpand->cbEofOld;
662	rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
663	pImage->uCurrentEndOfFile,
664	&pImage->vhdFooterCopy, sizeof(VHDFooter),
665	pIoCtx, NULL, NULL);
666	fIoInProgress \|= rc == VERR_VD_ASYNC_IO_IN_PROGRESS;
667	}
668
669	return fIoInProgress ? VERR_VD_ASYNC_IO_IN_PROGRESS : rc;
670	}
671
672	static int vhdAsyncExpansionStepCompleted(void pBackendData, PVDIOCTX pIoCtx, void pvUser, int rcReq, unsigned iStep)
673	{
674	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
675	PVHDIMAGEEXPAND pExpand = (PVHDIMAGEEXPAND)pvUser;
676
677	LogFlowFunc(("pBackendData=%#p pIoCtx=%#p pvUser=%#p rcReq=%Rrc iStep=%u\n",
678	pBackendData, pIoCtx, pvUser, rcReq, iStep));
679
680	if (RT_SUCCESS(rcReq))
681	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, iStep, VHDIMAGEEXPAND_STEP_SUCCESS);
682	else
683	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, iStep, VHDIMAGEEXPAND_STEP_FAILED);
684
685	if ((pExpand->fFlags & VHDIMAGEEXPAND_ALL_COMPLETE) == VHDIMAGEEXPAND_ALL_COMPLETE)
686	return vhdAsyncExpansionComplete(pImage, pIoCtx, pExpand);
687
688	return VERR_VD_ASYNC_IO_IN_PROGRESS;
689	}
690
691	static int vhdAsyncExpansionDataBlockBitmapComplete(void pBackendData, PVDIOCTX pIoCtx, void pvUser, int rcReq)
692	{
693	return vhdAsyncExpansionStepCompleted(pBackendData, pIoCtx, pvUser, rcReq, VHDIMAGEEXPAND_BLOCKBITMAP_STATUS_SHIFT);
694	}
695
696	static int vhdAsyncExpansionDataComplete(void pBackendData, PVDIOCTX pIoCtx, void pvUser, int rcReq)
697	{
698	return vhdAsyncExpansionStepCompleted(pBackendData, pIoCtx, pvUser, rcReq, VHDIMAGEEXPAND_USERBLOCK_STATUS_SHIFT);
699	}
700
701	static int vhdAsyncExpansionBatUpdateComplete(void pBackendData, PVDIOCTX pIoCtx, void pvUser, int rcReq)
702	{
703	return vhdAsyncExpansionStepCompleted(pBackendData, pIoCtx, pvUser, rcReq, VHDIMAGEEXPAND_BAT_STATUS_SHIFT);
704	}
705
706	static int vhdAsyncExpansionFooterUpdateComplete(void pBackendData, PVDIOCTX pIoCtx, void pvUser, int rcReq)
707	{
708	return vhdAsyncExpansionStepCompleted(pBackendData, pIoCtx, pvUser, rcReq, VHDIMAGEEXPAND_FOOTER_STATUS_SHIFT);
709	}
710
711	static int vhdLoadDynamicDisk(PVHDIMAGE pImage, uint64_t uDynamicDiskHeaderOffset)
712	{
713	VHDDynamicDiskHeader vhdDynamicDiskHeader;
714	int rc = VINF_SUCCESS;
715	uint32_t *pBlockAllocationTable;
716	uint64_t uBlockAllocationTableOffset;
717	unsigned i = 0;
718
719	Log(("Open a dynamic disk.\n"));
720
721	/*
722	* Read the dynamic disk header.
723	*/
724	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, uDynamicDiskHeaderOffset,
725	&vhdDynamicDiskHeader, sizeof(VHDDynamicDiskHeader));
726	if (memcmp(vhdDynamicDiskHeader.Cookie, VHD_DYNAMIC_DISK_HEADER_COOKIE, VHD_DYNAMIC_DISK_HEADER_COOKIE_SIZE))
727	return VERR_INVALID_PARAMETER;
728
729	pImage->cbDataBlock = RT_BE2H_U32(vhdDynamicDiskHeader.BlockSize);
730	LogFlowFunc(("BlockSize=%u\n", pImage->cbDataBlock));
731	pImage->cBlockAllocationTableEntries = RT_BE2H_U32(vhdDynamicDiskHeader.MaxTableEntries);
732	LogFlowFunc(("MaxTableEntries=%lu\n", pImage->cBlockAllocationTableEntries));
733	AssertMsg(!(pImage->cbDataBlock % VHD_SECTOR_SIZE), ("%s: Data block size is not a multiple of %!\n", __FUNCTION__, VHD_SECTOR_SIZE));
734
735	pImage->cSectorsPerDataBlock = pImage->cbDataBlock / VHD_SECTOR_SIZE;
736	LogFlowFunc(("SectorsPerDataBlock=%u\n", pImage->cSectorsPerDataBlock));
737
738	/*
739	* Every block starts with a bitmap indicating which sectors are valid and which are not.
740	* We store the size of it to be able to calculate the real offset.
741	*/
742	pImage->cbDataBlockBitmap = pImage->cSectorsPerDataBlock / 8;
743	pImage->cDataBlockBitmapSectors = pImage->cbDataBlockBitmap / VHD_SECTOR_SIZE;
744	/* Round up to full sector size */
745	if (pImage->cbDataBlockBitmap % VHD_SECTOR_SIZE > 0)
746	pImage->cDataBlockBitmapSectors++;
747	LogFlowFunc(("cbDataBlockBitmap=%u\n", pImage->cbDataBlockBitmap));
748	LogFlowFunc(("cDataBlockBitmapSectors=%u\n", pImage->cDataBlockBitmapSectors));
749
750	pImage->pu8Bitmap = vhdBlockBitmapAllocate(pImage);
751	if (!pImage->pu8Bitmap)
752	return VERR_NO_MEMORY;
753
754	pBlockAllocationTable = (uint32_t )RTMemAllocZ(pImage->cBlockAllocationTableEntries sizeof(uint32_t));
755	if (!pBlockAllocationTable)
756	return VERR_NO_MEMORY;
757
758	/*
759	* Read the table.
760	*/
761	uBlockAllocationTableOffset = RT_BE2H_U64(vhdDynamicDiskHeader.TableOffset);
762	LogFlowFunc(("uBlockAllocationTableOffset=%llu\n", uBlockAllocationTableOffset));
763	pImage->uBlockAllocationTableOffset = uBlockAllocationTableOffset;
764	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
765	uBlockAllocationTableOffset, pBlockAllocationTable,
766	pImage->cBlockAllocationTableEntries * sizeof(uint32_t));
767
768	/*
769	* Because the offset entries inside the allocation table are stored big endian
770	* we need to convert them into host endian.
771	*/
772	pImage->pBlockAllocationTable = (uint32_t )RTMemAllocZ(pImage->cBlockAllocationTableEntries sizeof(uint32_t));
773	if (!pImage->pBlockAllocationTable)
774	{
775	RTMemFree(pBlockAllocationTable);
776	return VERR_NO_MEMORY;
777	}
778
779	for (i = 0; i < pImage->cBlockAllocationTableEntries; i++)
780	pImage->pBlockAllocationTable[i] = RT_BE2H_U32(pBlockAllocationTable[i]);
781
782	RTMemFree(pBlockAllocationTable);
783
784	if (pImage->uImageFlags & VD_IMAGE_FLAGS_DIFF)
785	memcpy(pImage->ParentUuid.au8, vhdDynamicDiskHeader.ParentUuid, sizeof(pImage->ParentUuid));
786
787	return rc;
788	}
789
790	static int vhdOpenImage(PVHDIMAGE pImage, unsigned uOpenFlags)
791	{
792	uint64_t FileSize;
793	VHDFooter vhdFooter;
794
795	pImage->uOpenFlags = uOpenFlags;
796
797	pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
798	pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
799	AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
800
801	/*
802	* Open the image.
803	*/
804	int rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
805	VDOpenFlagsToFileOpenFlags(uOpenFlags,
806	false /* fCreate */),
807	&pImage->pStorage);
808	if (RT_FAILURE(rc))
809	{
810	/* Do NOT signal an appropriate error here, as the VD layer has the
811	* choice of retrying the open if it failed. */
812	return rc;
813	}
814
815	rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &FileSize);
816	pImage->uCurrentEndOfFile = FileSize - sizeof(VHDFooter);
817
818	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, pImage->uCurrentEndOfFile,
819	&vhdFooter, sizeof(VHDFooter));
820	if (RT_SUCCESS(rc))
821	{
822	if (memcmp(vhdFooter.Cookie, VHD_FOOTER_COOKIE, VHD_FOOTER_COOKIE_SIZE) != 0)
823	{
824	/*
825	* There is also a backup header at the beginning in case the image got corrupted.
826	* Such corrupted images are detected here to let the open handler repair it later.
827	*/
828	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, 0,
829	&vhdFooter, sizeof(VHDFooter));
830	if (RT_SUCCESS(rc))
831	{
832	if (memcmp(vhdFooter.Cookie, VHD_FOOTER_COOKIE, VHD_FOOTER_COOKIE_SIZE) != 0)
833	rc = VERR_VD_VHD_INVALID_HEADER;
834	else
835	rc = VERR_VD_IMAGE_CORRUPTED;
836	}
837	}
838	}
839
840	if (RT_FAILURE(rc))
841	return rc;
842
843	switch (RT_BE2H_U32(vhdFooter.DiskType))
844	{
845	case VHD_FOOTER_DISK_TYPE_FIXED:
846	pImage->uImageFlags \|= VD_IMAGE_FLAGS_FIXED;
847	break;
848	case VHD_FOOTER_DISK_TYPE_DYNAMIC:
849	pImage->uImageFlags &= ~VD_IMAGE_FLAGS_FIXED;
850	break;
851	case VHD_FOOTER_DISK_TYPE_DIFFERENCING:
852	pImage->uImageFlags \|= VD_IMAGE_FLAGS_DIFF;
853	pImage->uImageFlags &= ~VD_IMAGE_FLAGS_FIXED;
854	break;
855	default:
856	return VERR_NOT_IMPLEMENTED;
857	}
858
859	pImage->cbSize = RT_BE2H_U64(vhdFooter.CurSize);
860	pImage->LCHSGeometry.cCylinders = 0;
861	pImage->LCHSGeometry.cHeads = 0;
862	pImage->LCHSGeometry.cSectors = 0;
863	pImage->PCHSGeometry.cCylinders = RT_BE2H_U16(vhdFooter.DiskGeometryCylinder);
864	pImage->PCHSGeometry.cHeads = vhdFooter.DiskGeometryHeads;
865	pImage->PCHSGeometry.cSectors = vhdFooter.DiskGeometrySectors;
866
867	/*
868	* Copy of the disk footer.
869	* If we allocate new blocks in differencing disks on write access
870	* the footer is overwritten. We need to write it at the end of the file.
871	*/
872	memcpy(&pImage->vhdFooterCopy, &vhdFooter, sizeof(VHDFooter));
873
874	/*
875	* Is there a better way?
876	*/
877	memcpy(&pImage->ImageUuid, &vhdFooter.UniqueID, 16);
878
879	pImage->u64DataOffset = RT_BE2H_U64(vhdFooter.DataOffset);
880	LogFlowFunc(("DataOffset=%llu\n", pImage->u64DataOffset));
881
882	if (!(pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED))
883	rc = vhdLoadDynamicDisk(pImage, pImage->u64DataOffset);
884
885	if (RT_FAILURE(rc))
886	vhdFreeImage(pImage, false);
887	return rc;
888	}
889
890	/**
891	* Internal: Checks if a sector in the block bitmap is set
892	*/
893	DECLINLINE(bool) vhdBlockBitmapSectorContainsData(PVHDIMAGE pImage, uint32_t cBlockBitmapEntry)
894	{
895	uint32_t iBitmap = (cBlockBitmapEntry / 8); /* Byte in the block bitmap. */
896
897	/*
898	* The index of the bit in the byte of the data block bitmap.
899	* The most significant bit stands for a lower sector number.
900	*/
901	uint8_t iBitInByte = (8-1) - (cBlockBitmapEntry % 8);
902	uint8_t *puBitmap = pImage->pu8Bitmap + iBitmap;
903
904	AssertMsg(puBitmap < (pImage->pu8Bitmap + pImage->cbDataBlockBitmap),
905	("VHD: Current bitmap position exceeds maximum size of the bitmap\n"));
906
907	return ((*puBitmap) & RT_BIT(iBitInByte)) != 0;
908	}
909
910	/**
911	* Internal: Sets the given sector in the sector bitmap.
912	*/
913	DECLINLINE(bool) vhdBlockBitmapSectorSet(PVHDIMAGE pImage, uint8_t *pu8Bitmap, uint32_t cBlockBitmapEntry)
914	{
915	uint32_t iBitmap = (cBlockBitmapEntry / 8); /* Byte in the block bitmap. */
916
917	/*
918	* The index of the bit in the byte of the data block bitmap.
919	* The most significant bit stands for a lower sector number.
920	*/
921	uint8_t iBitInByte = (8-1) - (cBlockBitmapEntry % 8);
922	uint8_t *puBitmap = pu8Bitmap + iBitmap;
923
924	AssertMsg(puBitmap < (pu8Bitmap + pImage->cbDataBlockBitmap),
925	("VHD: Current bitmap position exceeds maximum size of the bitmap\n"));
926
927	bool fClear = ((*puBitmap) & RT_BIT(iBitInByte)) == 0;
928	*puBitmap \|= RT_BIT(iBitInByte);
929	return fClear;
930	}
931
932	/**
933	* Internal: Derive drive geometry from its size.
934	*/
935	static void vhdSetDiskGeometry(PVHDIMAGE pImage, uint64_t cbSize)
936	{
937	uint64_t u64TotalSectors = cbSize / VHD_SECTOR_SIZE;
938	uint32_t u32CylinderTimesHeads, u32Heads, u32SectorsPerTrack;
939
940	if (u64TotalSectors > 65535 * 16 * 255)
941	{
942	/* ATA disks limited to 127 GB. */
943	u64TotalSectors = 65535 * 16 * 255;
944	}
945
946	if (u64TotalSectors >= 65535 * 16 * 63)
947	{
948	u32SectorsPerTrack = 255;
949	u32Heads = 16;
950	u32CylinderTimesHeads = u64TotalSectors / u32SectorsPerTrack;
951	}
952	else
953	{
954	u32SectorsPerTrack = 17;
955	u32CylinderTimesHeads = u64TotalSectors / u32SectorsPerTrack;
956
957	u32Heads = (u32CylinderTimesHeads + 1023) / 1024;
958
959	if (u32Heads < 4)
960	{
961	u32Heads = 4;
962	}
963	if (u32CylinderTimesHeads >= (u32Heads * 1024) \|\| u32Heads > 16)
964	{
965	u32SectorsPerTrack = 31;
966	u32Heads = 16;
967	u32CylinderTimesHeads = u64TotalSectors / u32SectorsPerTrack;
968	}
969	if (u32CylinderTimesHeads >= (u32Heads * 1024))
970	{
971	u32SectorsPerTrack = 63;
972	u32Heads = 16;
973	u32CylinderTimesHeads = u64TotalSectors / u32SectorsPerTrack;
974	}
975	}
976	pImage->PCHSGeometry.cCylinders = u32CylinderTimesHeads / u32Heads;
977	pImage->PCHSGeometry.cHeads = u32Heads;
978	pImage->PCHSGeometry.cSectors = u32SectorsPerTrack;
979	pImage->LCHSGeometry.cCylinders = 0;
980	pImage->LCHSGeometry.cHeads = 0;
981	pImage->LCHSGeometry.cSectors = 0;
982	}
983
984
985	static uint32_t vhdAllocateParentLocators(PVHDIMAGE pImage, VHDDynamicDiskHeader *pDDH, uint64_t u64Offset)
986	{
987	PVHDPLE pLocator = pDDH->ParentLocatorEntry;
988
989	/*
990	* The VHD spec states that the DataSpace field holds the number of sectors
991	* required to store the parent locator path.
992	* As it turned out VPC and Hyper-V store the amount of bytes reserved for the
993	* path and not the number of sectors.
994	*/
995
996	/* Unicode absolute Windows path. */
997	pLocator->u32Code = RT_H2BE_U32(VHD_PLATFORM_CODE_W2KU);
998	pLocator->u32DataSpace = RT_H2BE_U32(VHD_ABSOLUTE_MAX_PATH * sizeof(RTUTF16));
999	pLocator->u64DataOffset = RT_H2BE_U64(u64Offset);
1000	pLocator++;
1001	u64Offset += VHD_ABSOLUTE_MAX_PATH * sizeof(RTUTF16);
1002	/* Unicode relative Windows path. */
1003	pLocator->u32Code = RT_H2BE_U32(VHD_PLATFORM_CODE_W2RU);
1004	pLocator->u32DataSpace = RT_H2BE_U32(VHD_RELATIVE_MAX_PATH * sizeof(RTUTF16));
1005	pLocator->u64DataOffset = RT_H2BE_U64(u64Offset);
1006	u64Offset += VHD_RELATIVE_MAX_PATH * sizeof(RTUTF16);
1007	return u64Offset;
1008	}
1009
1010	/**
1011	* Internal: Additional code for dynamic VHD image creation.
1012	*/
1013	static int vhdCreateDynamicImage(PVHDIMAGE pImage, uint64_t cbSize)
1014	{
1015	int rc;
1016	VHDDynamicDiskHeader DynamicDiskHeader;
1017	uint32_t u32BlockAllocationTableSectors;
1018	void *pvTmp = NULL;
1019
1020	memset(&DynamicDiskHeader, 0, sizeof(DynamicDiskHeader));
1021
1022	pImage->u64DataOffset = sizeof(VHDFooter);
1023	pImage->cbDataBlock = VHD_BLOCK_SIZE; /* 2 MB */
1024	pImage->cSectorsPerDataBlock = pImage->cbDataBlock / VHD_SECTOR_SIZE;
1025	pImage->cbDataBlockBitmap = pImage->cSectorsPerDataBlock / 8;
1026	pImage->cDataBlockBitmapSectors = pImage->cbDataBlockBitmap / VHD_SECTOR_SIZE;
1027	/* Align to sector boundary */
1028	if (pImage->cbDataBlockBitmap % VHD_SECTOR_SIZE > 0)
1029	pImage->cDataBlockBitmapSectors++;
1030	pImage->pu8Bitmap = vhdBlockBitmapAllocate(pImage);
1031	if (!pImage->pu8Bitmap)
1032	return vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS, N_("VHD: cannot allocate memory for bitmap storage"));
1033
1034	/* Initialize BAT. */
1035	pImage->uBlockAllocationTableOffset = (uint64_t)sizeof(VHDFooter) + sizeof(VHDDynamicDiskHeader);
1036	pImage->cBlockAllocationTableEntries = (uint32_t)((cbSize + pImage->cbDataBlock - 1) / pImage->cbDataBlock); /* Align table to the block size. */
1037	u32BlockAllocationTableSectors = (pImage->cBlockAllocationTableEntries * sizeof(uint32_t) + VHD_SECTOR_SIZE - 1) / VHD_SECTOR_SIZE;
1038	pImage->pBlockAllocationTable = (uint32_t )RTMemAllocZ(pImage->cBlockAllocationTableEntries sizeof(uint32_t));
1039	if (!pImage->pBlockAllocationTable)
1040	return vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS, N_("VHD: cannot allocate memory for BAT"));
1041
1042	for (unsigned i = 0; i < pImage->cBlockAllocationTableEntries; i++)
1043	{
1044	pImage->pBlockAllocationTable[i] = 0xFFFFFFFF; /* It is actually big endian. */
1045	}
1046
1047	/* Round up to the sector size. */
1048	if (pImage->uImageFlags & VD_IMAGE_FLAGS_DIFF) /* fix hyper-v unreadable error */
1049	pImage->uCurrentEndOfFile = vhdAllocateParentLocators(pImage, &DynamicDiskHeader,
1050	pImage->uBlockAllocationTableOffset + u32BlockAllocationTableSectors * VHD_SECTOR_SIZE);
1051	else
1052	pImage->uCurrentEndOfFile = pImage->uBlockAllocationTableOffset + u32BlockAllocationTableSectors * VHD_SECTOR_SIZE;
1053
1054	/* Set dynamic image size. */
1055	pvTmp = RTMemTmpAllocZ(pImage->uCurrentEndOfFile + sizeof(VHDFooter));
1056	if (!pvTmp)
1057	return vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS, N_("VHD: cannot set the file size for '%s'"), pImage->pszFilename);
1058
1059	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, 0, pvTmp,
1060	pImage->uCurrentEndOfFile + sizeof(VHDFooter));
1061	if (RT_FAILURE(rc))
1062	{
1063	RTMemTmpFree(pvTmp);
1064	return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VHD: cannot set the file size for '%s'"), pImage->pszFilename);
1065	}
1066
1067	RTMemTmpFree(pvTmp);
1068
1069	/* Initialize and write the dynamic disk header. */
1070	memcpy(DynamicDiskHeader.Cookie, VHD_DYNAMIC_DISK_HEADER_COOKIE, sizeof(DynamicDiskHeader.Cookie));
1071	DynamicDiskHeader.DataOffset = UINT64_C(0xFFFFFFFFFFFFFFFF); /* Initially the disk has no data. */
1072	DynamicDiskHeader.TableOffset = RT_H2BE_U64(pImage->uBlockAllocationTableOffset);
1073	DynamicDiskHeader.HeaderVersion = RT_H2BE_U32(VHD_DYNAMIC_DISK_HEADER_VERSION);
1074	DynamicDiskHeader.BlockSize = RT_H2BE_U32(pImage->cbDataBlock);
1075	DynamicDiskHeader.MaxTableEntries = RT_H2BE_U32(pImage->cBlockAllocationTableEntries);
1076	/* Compute and update checksum. */
1077	DynamicDiskHeader.Checksum = 0;
1078	DynamicDiskHeader.Checksum = RT_H2BE_U32(vhdChecksum(&DynamicDiskHeader, sizeof(DynamicDiskHeader)));
1079
1080	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, sizeof(VHDFooter),
1081	&DynamicDiskHeader, sizeof(DynamicDiskHeader));
1082	if (RT_FAILURE(rc))
1083	return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VHD: cannot write dynamic disk header to image '%s'"), pImage->pszFilename);
1084
1085	/* Write BAT. */
1086	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, pImage->uBlockAllocationTableOffset,
1087	pImage->pBlockAllocationTable,
1088	pImage->cBlockAllocationTableEntries * sizeof(uint32_t));
1089	if (RT_FAILURE(rc))
1090	return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VHD: cannot write BAT to image '%s'"), pImage->pszFilename);
1091
1092	return rc;
1093	}
1094
1095	/**
1096	* Internal: The actual code for VHD image creation, both fixed and dynamic.
1097	*/
1098	static int vhdCreateImage(PVHDIMAGE pImage, uint64_t cbSize,
1099	unsigned uImageFlags, const char *pszComment,
1100	PCVDGEOMETRY pPCHSGeometry,
1101	PCVDGEOMETRY pLCHSGeometry, PCRTUUID pUuid,
1102	unsigned uOpenFlags,
1103	PFNVDPROGRESS pfnProgress, void *pvUser,
1104	unsigned uPercentStart, unsigned uPercentSpan)
1105	{
1106	int rc;
1107	VHDFooter Footer;
1108	RTTIMESPEC now;
1109
1110	pImage->uOpenFlags = uOpenFlags;
1111	pImage->uImageFlags = uImageFlags;
1112
1113	pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
1114
1115	rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
1116	VDOpenFlagsToFileOpenFlags(uOpenFlags & ~VD_OPEN_FLAGS_READONLY,
1117	true /* fCreate */),
1118	&pImage->pStorage);
1119	if (RT_FAILURE(rc))
1120	return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VHD: cannot create image '%s'"), pImage->pszFilename);
1121
1122
1123	pImage->cbSize = cbSize;
1124	pImage->ImageUuid = *pUuid;
1125	RTUuidClear(&pImage->ParentUuid);
1126	vhdSetDiskGeometry(pImage, cbSize);
1127
1128	/* Initialize the footer. */
1129	memset(&Footer, 0, sizeof(Footer));
1130	memcpy(Footer.Cookie, VHD_FOOTER_COOKIE, sizeof(Footer.Cookie));
1131	Footer.Features = RT_H2BE_U32(0x2);
1132	Footer.Version = RT_H2BE_U32(VHD_FOOTER_FILE_FORMAT_VERSION);
1133	Footer.TimeStamp = RT_H2BE_U32(vhdRtTime2VhdTime(RTTimeNow(&now)));
1134	memcpy(Footer.CreatorApp, "vbox", sizeof(Footer.CreatorApp));
1135	Footer.CreatorVer = RT_H2BE_U32(VBOX_VERSION);
1136	#ifdef RT_OS_DARWIN
1137	Footer.CreatorOS = RT_H2BE_U32(0x4D616320); /* "Mac " */
1138	#else /* Virtual PC supports only two platforms atm, so everything else will be Wi2k. */
1139	Footer.CreatorOS = RT_H2BE_U32(0x5769326B); /* "Wi2k" */
1140	#endif
1141	Footer.OrigSize = RT_H2BE_U64(cbSize);
1142	Footer.CurSize = Footer.OrigSize;
1143	Footer.DiskGeometryCylinder = RT_H2BE_U16(pImage->PCHSGeometry.cCylinders);
1144	Footer.DiskGeometryHeads = pImage->PCHSGeometry.cHeads;
1145	Footer.DiskGeometrySectors = pImage->PCHSGeometry.cSectors;
1146	memcpy(Footer.UniqueID, pImage->ImageUuid.au8, sizeof(Footer.UniqueID));
1147	Footer.SavedState = 0;
1148
1149	if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
1150	{
1151	Footer.DiskType = RT_H2BE_U32(VHD_FOOTER_DISK_TYPE_FIXED);
1152	/*
1153	* Initialize fixed image.
1154	* "The size of the entire file is the size of the hard disk in
1155	* the guest operating system plus the size of the footer."
1156	*/
1157	pImage->u64DataOffset = VHD_FOOTER_DATA_OFFSET_FIXED;
1158	pImage->uCurrentEndOfFile = cbSize;
1159	/** @todo r=klaus replace this with actual data writes, see the experience
1160	* with VDI files on Windows, can cause long freezes when writing. */
1161	rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage,
1162	pImage->uCurrentEndOfFile + sizeof(VHDFooter));
1163	if (RT_FAILURE(rc))
1164	{
1165	vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VHD: cannot set the file size for '%s'"), pImage->pszFilename);
1166	goto out;
1167	}
1168	}
1169	else
1170	{
1171	/*
1172	* Initialize dynamic image.
1173	*
1174	* The overall structure of dynamic disk is:
1175	*
1176	* [Copy of hard disk footer (512 bytes)]
1177	* [Dynamic disk header (1024 bytes)]
1178	* [BAT (Block Allocation Table)]
1179	* [Parent Locators]
1180	* [Data block 1]
1181	* [Data block 2]
1182	* ...
1183	* [Data block N]
1184	* [Hard disk footer (512 bytes)]
1185	*/
1186	Footer.DiskType = (uImageFlags & VD_IMAGE_FLAGS_DIFF)
1187	? RT_H2BE_U32(VHD_FOOTER_DISK_TYPE_DIFFERENCING)
1188	: RT_H2BE_U32(VHD_FOOTER_DISK_TYPE_DYNAMIC);
1189	/* We are half way thorough with creation of image, let the caller know. */
1190	if (pfnProgress)
1191	pfnProgress(pvUser, (uPercentStart + uPercentSpan) / 2);
1192
1193	rc = vhdCreateDynamicImage(pImage, cbSize);
1194	if (RT_FAILURE(rc))
1195	goto out;
1196	}
1197
1198	Footer.DataOffset = RT_H2BE_U64(pImage->u64DataOffset);
1199
1200	/* Compute and update the footer checksum. */
1201	Footer.Checksum = 0;
1202	Footer.Checksum = RT_H2BE_U32(vhdChecksum(&Footer, sizeof(Footer)));
1203
1204	pImage->vhdFooterCopy = Footer;
1205
1206	/* Store the footer */
1207	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, pImage->uCurrentEndOfFile,
1208	&Footer, sizeof(Footer));
1209	if (RT_FAILURE(rc))
1210	{
1211	vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VHD: cannot write footer to image '%s'"), pImage->pszFilename);
1212	goto out;
1213	}
1214
1215	/* Dynamic images contain a copy of the footer at the very beginning of the file. */
1216	if (!(uImageFlags & VD_IMAGE_FLAGS_FIXED))
1217	{
1218	/* Write the copy of the footer. */
1219	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, 0, &Footer, sizeof(Footer));
1220	if (RT_FAILURE(rc))
1221	{
1222	vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VHD: cannot write a copy of footer to image '%s'"), pImage->pszFilename);
1223	goto out;
1224	}
1225	}
1226
1227	out:
1228	if (RT_SUCCESS(rc) && pfnProgress)
1229	pfnProgress(pvUser, uPercentStart + uPercentSpan);
1230
1231	if (RT_FAILURE(rc))
1232	vhdFreeImage(pImage, rc != VERR_ALREADY_EXISTS);
1233	return rc;
1234	}
1235
1236
1237	/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
1238	static int vhdCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
1239	PVDINTERFACE pVDIfsImage, VDTYPE *penmType)
1240	{
1241	LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p\n", pszFilename, pVDIfsDisk, pVDIfsImage));
1242	int rc;
1243	PVDIOSTORAGE pStorage;
1244	uint64_t cbFile;
1245	VHDFooter vhdFooter;
1246
1247	PVDINTERFACEIOINT pIfIo = VDIfIoIntGet(pVDIfsImage);
1248	AssertPtrReturn(pIfIo, VERR_INVALID_PARAMETER);
1249
1250	rc = vdIfIoIntFileOpen(pIfIo, pszFilename,
1251	VDOpenFlagsToFileOpenFlags(VD_OPEN_FLAGS_READONLY,
1252	false /* fCreate */),
1253	&pStorage);
1254	if (RT_FAILURE(rc))
1255	goto out;
1256
1257	rc = vdIfIoIntFileGetSize(pIfIo, pStorage, &cbFile);
1258	if (RT_FAILURE(rc))
1259	{
1260	vdIfIoIntFileClose(pIfIo, pStorage);
1261	rc = VERR_VD_VHD_INVALID_HEADER;
1262	goto out;
1263	}
1264
1265	rc = vdIfIoIntFileReadSync(pIfIo, pStorage, cbFile - sizeof(VHDFooter),
1266	&vhdFooter, sizeof(VHDFooter));
1267	if (RT_SUCCESS(rc))
1268	{
1269	if (memcmp(vhdFooter.Cookie, VHD_FOOTER_COOKIE, VHD_FOOTER_COOKIE_SIZE) != 0)
1270	{
1271	/*
1272	* There is also a backup header at the beginning in case the image got corrupted.
1273	* Such corrupted images are detected here to let the open handler repair it later.
1274	*/
1275	rc = vdIfIoIntFileReadSync(pIfIo, pStorage, 0, &vhdFooter, sizeof(VHDFooter));
1276	if ( RT_FAILURE(rc)
1277	\|\| (memcmp(vhdFooter.Cookie, VHD_FOOTER_COOKIE, VHD_FOOTER_COOKIE_SIZE) != 0))
1278	rc = VERR_VD_VHD_INVALID_HEADER;
1279	}
1280
1281	if (RT_SUCCESS(rc))
1282	*penmType = VDTYPE_HDD;
1283	}
1284	else
1285	rc = VERR_VD_VHD_INVALID_HEADER;
1286
1287	vdIfIoIntFileClose(pIfIo, pStorage);
1288
1289	out:
1290	LogFlowFunc(("returns %Rrc\n", rc));
1291	return rc;
1292	}
1293
1294	/** @copydoc VBOXHDDBACKEND::pfnOpen */
1295	static int vhdOpen(const char *pszFilename, unsigned uOpenFlags,
1296	PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1297	VDTYPE enmType, void **ppBackendData)
1298	{
1299	LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, ppBackendData));
1300	int rc = VINF_SUCCESS;
1301	PVHDIMAGE pImage;
1302
1303	/* Check open flags. All valid flags are supported. */
1304	if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
1305	{
1306	rc = VERR_INVALID_PARAMETER;
1307	goto out;
1308	}
1309
1310	/* Check remaining arguments. */
1311	if ( !VALID_PTR(pszFilename)
1312	\|\| !*pszFilename)
1313	{
1314	rc = VERR_INVALID_PARAMETER;
1315	goto out;
1316	}
1317
1318	pImage = (PVHDIMAGE)RTMemAllocZ(sizeof(VHDIMAGE));
1319	if (!pImage)
1320	{
1321	rc = VERR_NO_MEMORY;
1322	goto out;
1323	}
1324
1325	pImage->pszFilename = pszFilename;
1326	pImage->pStorage = NULL;
1327	pImage->pVDIfsDisk = pVDIfsDisk;
1328	pImage->pVDIfsImage = pVDIfsImage;
1329
1330	rc = vhdOpenImage(pImage, uOpenFlags);
1331	if (RT_SUCCESS(rc))
1332	*ppBackendData = pImage;
1333	else
1334	RTMemFree(pImage);
1335
1336	out:
1337	LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1338	return rc;
1339	}
1340
1341	/** @copydoc VBOXHDDBACKEND::pfnCreate */
1342	static int vhdCreate(const char *pszFilename, uint64_t cbSize,
1343	unsigned uImageFlags, const char *pszComment,
1344	PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
1345	PCRTUUID pUuid, unsigned uOpenFlags,
1346	unsigned uPercentStart, unsigned uPercentSpan,
1347	PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1348	PVDINTERFACE pVDIfsOperation, void **ppBackendData)
1349	{
1350	LogFlowFunc(("pszFilename=\"%s\" cbSize=%llu uImageFlags=%#x pszComment=\"%s\" pPCHSGeometry=%#p pLCHSGeometry=%#p Uuid=%RTuuid uOpenFlags=%#x uPercentStart=%u uPercentSpan=%u pVDIfsDisk=%#p pVDIfsImage=%#p pVDIfsOperation=%#p ppBackendData=%#p", pszFilename, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, ppBackendData));
1351	int rc = VINF_SUCCESS;
1352	PVHDIMAGE pImage;
1353
1354	PFNVDPROGRESS pfnProgress = NULL;
1355	void *pvUser = NULL;
1356	PVDINTERFACEPROGRESS pIfProgress = VDIfProgressGet(pVDIfsOperation);
1357	if (pIfProgress)
1358	{
1359	pfnProgress = pIfProgress->pfnProgress;
1360	pvUser = pIfProgress->Core.pvUser;
1361	}
1362
1363	/* Check open flags. All valid flags are supported. */
1364	if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
1365	{
1366	rc = VERR_INVALID_PARAMETER;
1367	return rc;
1368	}
1369
1370	/* @todo Check the values of other params */
1371
1372	pImage = (PVHDIMAGE)RTMemAllocZ(sizeof(VHDIMAGE));
1373	if (!pImage)
1374	{
1375	rc = VERR_NO_MEMORY;
1376	return rc;
1377	}
1378	pImage->pszFilename = pszFilename;
1379	pImage->pStorage = NULL;
1380	pImage->pVDIfsDisk = pVDIfsDisk;
1381	pImage->pVDIfsImage = pVDIfsImage;
1382
1383	/* Get I/O interface. */
1384	pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
1385	if (RT_UNLIKELY(!VALID_PTR(pImage->pIfIo)))
1386	{
1387	RTMemFree(pImage);
1388	return VERR_INVALID_PARAMETER;
1389	}
1390
1391	rc = vhdCreateImage(pImage, cbSize, uImageFlags, pszComment,
1392	pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags,
1393	pfnProgress, pvUser, uPercentStart, uPercentSpan);
1394
1395	if (RT_SUCCESS(rc))
1396	{
1397	/* So far the image is opened in read/write mode. Make sure the
1398	* image is opened in read-only mode if the caller requested that. */
1399	if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
1400	{
1401	vhdFreeImage(pImage, false);
1402	rc = vhdOpenImage(pImage, uOpenFlags);
1403	if (RT_FAILURE(rc))
1404	{
1405	RTMemFree(pImage);
1406	goto out;
1407	}
1408	}
1409	*ppBackendData = pImage;
1410	}
1411	else
1412	RTMemFree(pImage);
1413
1414	out:
1415	LogFlowFunc(("returns %Rrc\n", rc));
1416	return rc;
1417	}
1418
1419	/** @copydoc VBOXHDDBACKEND::pfnRename */
1420	static int vhdRename(void pBackendData, const char pszFilename)
1421	{
1422	LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
1423	int rc = VINF_SUCCESS;
1424	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1425
1426	/* Check arguments. */
1427	if ( !pImage
1428	\|\| !pszFilename
1429	\|\| !*pszFilename)
1430	{
1431	rc = VERR_INVALID_PARAMETER;
1432	goto out;
1433	}
1434
1435	/* Close the image. */
1436	rc = vhdFreeImage(pImage, false);
1437	if (RT_FAILURE(rc))
1438	goto out;
1439
1440	/* Rename the file. */
1441	rc = vdIfIoIntFileMove(pImage->pIfIo, pImage->pszFilename, pszFilename, 0);
1442	if (RT_FAILURE(rc))
1443	{
1444	/* The move failed, try to reopen the original image. */
1445	int rc2 = vhdOpenImage(pImage, pImage->uOpenFlags);
1446	if (RT_FAILURE(rc2))
1447	rc = rc2;
1448
1449	goto out;
1450	}
1451
1452	/* Update pImage with the new information. */
1453	pImage->pszFilename = pszFilename;
1454
1455	/* Open the old file with new name. */
1456	rc = vhdOpenImage(pImage, pImage->uOpenFlags);
1457	if (RT_FAILURE(rc))
1458	goto out;
1459
1460	out:
1461	LogFlowFunc(("returns %Rrc\n", rc));
1462	return rc;
1463	}
1464
1465	/** @copydoc VBOXHDDBACKEND::pfnClose */
1466	static int vhdClose(void *pBackendData, bool fDelete)
1467	{
1468	LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
1469	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1470	int rc;
1471
1472	rc = vhdFreeImage(pImage, fDelete);
1473	RTMemFree(pImage);
1474
1475	LogFlowFunc(("returns %Rrc\n", rc));
1476	return rc;
1477	}
1478
1479	/** @copydoc VBOXHDDBACKEND::pfnRead */
1480	static int vhdRead(void *pBackendData, uint64_t uOffset, size_t cbRead,
1481	PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
1482	{
1483	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1484	int rc = VINF_SUCCESS;
1485
1486	LogFlowFunc(("pBackendData=%p uOffset=%#llx pIoCtx=%#p cbRead=%u pcbActuallyRead=%p\n", pBackendData, uOffset, pIoCtx, cbRead, pcbActuallyRead));
1487
1488	if (uOffset + cbRead > pImage->cbSize)
1489	return VERR_INVALID_PARAMETER;
1490
1491	/*
1492	* If we have a dynamic disk image, we need to find the data block and sector to read.
1493	*/
1494	if (pImage->pBlockAllocationTable)
1495	{
1496	/*
1497	* Get the data block first.
1498	*/
1499	uint32_t cBlockAllocationTableEntry = (uOffset / VHD_SECTOR_SIZE) / pImage->cSectorsPerDataBlock;
1500	uint32_t cBATEntryIndex = (uOffset / VHD_SECTOR_SIZE) % pImage->cSectorsPerDataBlock;
1501	uint64_t uVhdOffset;
1502
1503	LogFlowFunc(("cBlockAllocationTableEntry=%u cBatEntryIndex=%u\n", cBlockAllocationTableEntry, cBATEntryIndex));
1504	LogFlowFunc(("BlockAllocationEntry=%u\n", pImage->pBlockAllocationTable[cBlockAllocationTableEntry]));
1505
1506	/*
1507	* Clip read range to remain in this data block.
1508	*/
1509	cbRead = RT_MIN(cbRead, (pImage->cbDataBlock - (cBATEntryIndex * VHD_SECTOR_SIZE)));
1510
1511	/*
1512	* If the block is not allocated the content of the entry is ~0
1513	*/
1514	if (pImage->pBlockAllocationTable[cBlockAllocationTableEntry] == ~0U)
1515	rc = VERR_VD_BLOCK_FREE;
1516	else
1517	{
1518	uVhdOffset = ((uint64_t)pImage->pBlockAllocationTable[cBlockAllocationTableEntry] + pImage->cDataBlockBitmapSectors + cBATEntryIndex) * VHD_SECTOR_SIZE;
1519	LogFlowFunc(("uVhdOffset=%llu cbRead=%u\n", uVhdOffset, cbRead));
1520
1521	/* Read in the block's bitmap. */
1522	PVDMETAXFER pMetaXfer;
1523	rc = vdIfIoIntFileReadMeta(pImage->pIfIo, pImage->pStorage,
1524	((uint64_t)pImage->pBlockAllocationTable[cBlockAllocationTableEntry]) * VHD_SECTOR_SIZE,
1525	pImage->pu8Bitmap, pImage->cbDataBlockBitmap,
1526	pIoCtx, &pMetaXfer, NULL, NULL);
1527
1528	if (RT_SUCCESS(rc))
1529	{
1530	uint32_t cSectors = 0;
1531
1532	vdIfIoIntMetaXferRelease(pImage->pIfIo, pMetaXfer);
1533	if (vhdBlockBitmapSectorContainsData(pImage, cBATEntryIndex))
1534	{
1535	cBATEntryIndex++;
1536	cSectors = 1;
1537
1538	/*
1539	* The first sector being read is marked dirty, read as much as we
1540	* can from child. Note that only sectors that are marked dirty
1541	* must be read from child.
1542	*/
1543	while ( (cSectors < (cbRead / VHD_SECTOR_SIZE))
1544	&& vhdBlockBitmapSectorContainsData(pImage, cBATEntryIndex))
1545	{
1546	cBATEntryIndex++;
1547	cSectors++;
1548	}
1549
1550	cbRead = cSectors * VHD_SECTOR_SIZE;
1551
1552	LogFlowFunc(("uVhdOffset=%llu cbRead=%u\n", uVhdOffset, cbRead));
1553	rc = vdIfIoIntFileReadUser(pImage->pIfIo, pImage->pStorage,
1554	uVhdOffset, pIoCtx, cbRead);
1555	}
1556	else
1557	{
1558	/*
1559	* The first sector being read is marked clean, so we should read from
1560	* our parent instead, but only as much as there are the following
1561	* clean sectors, because the block may still contain dirty sectors
1562	* further on. We just need to compute the number of clean sectors
1563	* and pass it to our caller along with the notification that they
1564	* should be read from the parent.
1565	*/
1566	cBATEntryIndex++;
1567	cSectors = 1;
1568
1569	while ( (cSectors < (cbRead / VHD_SECTOR_SIZE))
1570	&& !vhdBlockBitmapSectorContainsData(pImage, cBATEntryIndex))
1571	{
1572	cBATEntryIndex++;
1573	cSectors++;
1574	}
1575
1576	cbRead = cSectors * VHD_SECTOR_SIZE;
1577	LogFunc(("Sectors free: uVhdOffset=%llu cbRead=%u\n", uVhdOffset, cbRead));
1578	rc = VERR_VD_BLOCK_FREE;
1579	}
1580	}
1581	else
1582	AssertMsg(rc == VERR_VD_NOT_ENOUGH_METADATA, ("Reading block bitmap failed rc=%Rrc\n", rc));
1583	}
1584	}
1585	else
1586	rc = vdIfIoIntFileReadUser(pImage->pIfIo, pImage->pStorage, uOffset, pIoCtx, cbRead);
1587
1588	if (pcbActuallyRead)
1589	*pcbActuallyRead = cbRead;
1590
1591	LogFlowFunc(("returns rc=%Rrc\n", rc));
1592	return rc;
1593	}
1594
1595	/** @copydoc VBOXHDDBACKEND::pfnWrite */
1596	static int vhdWrite(void *pBackendData, uint64_t uOffset, size_t cbWrite,
1597	PVDIOCTX pIoCtx, size_t pcbWriteProcess, size_t pcbPreRead,
1598	size_t *pcbPostRead, unsigned fWrite)
1599	{
1600	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1601	int rc = VINF_SUCCESS;
1602
1603	LogFlowFunc(("pBackendData=%p uOffset=%llu pIoCtx=%#p cbWrite=%u pcbWriteProcess=%p pcbPreRead=%p pcbPostRead=%p fWrite=%u\n",
1604	pBackendData, uOffset, pIoCtx, cbWrite, pcbWriteProcess, pcbPreRead, pcbPostRead, fWrite));
1605
1606	AssertPtr(pImage);
1607	Assert(uOffset % VHD_SECTOR_SIZE == 0);
1608	Assert(cbWrite % VHD_SECTOR_SIZE == 0);
1609
1610	if (pImage->pBlockAllocationTable)
1611	{
1612	/*
1613	* Get the data block first.
1614	*/
1615	uint32_t cSector = uOffset / VHD_SECTOR_SIZE;
1616	uint32_t cBlockAllocationTableEntry = cSector / pImage->cSectorsPerDataBlock;
1617	uint32_t cBATEntryIndex = cSector % pImage->cSectorsPerDataBlock;
1618	uint64_t uVhdOffset;
1619
1620	/*
1621	* Clip write range.
1622	*/
1623	cbWrite = RT_MIN(cbWrite, (pImage->cbDataBlock - (cBATEntryIndex * VHD_SECTOR_SIZE)));
1624
1625	/*
1626	* If the block is not allocated the content of the entry is ~0
1627	* and we need to allocate a new block. Note that while blocks are
1628	* allocated with a relatively big granularity, each sector has its
1629	* own bitmap entry, indicating whether it has been written or not.
1630	* So that means for the purposes of the higher level that the
1631	* granularity is invisible. This means there's no need to return
1632	* VERR_VD_BLOCK_FREE unless the block hasn't been allocated yet.
1633	*/
1634	if (pImage->pBlockAllocationTable[cBlockAllocationTableEntry] == ~0U)
1635	{
1636	/* Check if the block allocation should be suppressed. */
1637	if ( (fWrite & VD_WRITE_NO_ALLOC)
1638	\|\| (cbWrite != pImage->cbDataBlock))
1639	{
1640	pcbPreRead = cBATEntryIndex VHD_SECTOR_SIZE;
1641	pcbPostRead = pImage->cSectorsPerDataBlock VHD_SECTOR_SIZE - cbWrite - *pcbPreRead;
1642
1643	if (pcbWriteProcess)
1644	*pcbWriteProcess = cbWrite;
1645	return VERR_VD_BLOCK_FREE;
1646	}
1647
1648	PVHDIMAGEEXPAND pExpand = (PVHDIMAGEEXPAND)RTMemAllocZ(RT_OFFSETOF(VHDIMAGEEXPAND, au8Bitmap[pImage->cDataBlockBitmapSectors * VHD_SECTOR_SIZE]));
1649	bool fIoInProgress = false;
1650
1651	if (!pExpand)
1652	return VERR_NO_MEMORY;
1653
1654	pExpand->cbEofOld = pImage->uCurrentEndOfFile;
1655	pExpand->idxBatAllocated = cBlockAllocationTableEntry;
1656	pExpand->idxBlockBe = RT_H2BE_U32(pImage->uCurrentEndOfFile / VHD_SECTOR_SIZE);
1657
1658	/* Set the bits for all sectors having been written. */
1659	for (uint32_t iSector = 0; iSector < (cbWrite / VHD_SECTOR_SIZE); iSector++)
1660	{
1661	/* No need to check for a changed value because this is an initial write. */
1662	vhdBlockBitmapSectorSet(pImage, pExpand->au8Bitmap, cBATEntryIndex);
1663	cBATEntryIndex++;
1664	}
1665
1666	do
1667	{
1668	/*
1669	* Start with the sector bitmap.
1670	*/
1671	rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1672	pImage->uCurrentEndOfFile,
1673	pExpand->au8Bitmap,
1674	pImage->cDataBlockBitmapSectors * VHD_SECTOR_SIZE, pIoCtx,
1675	vhdAsyncExpansionDataBlockBitmapComplete,
1676	pExpand);
1677	if (RT_SUCCESS(rc))
1678	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_BLOCKBITMAP_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_SUCCESS);
1679	else if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1680	fIoInProgress = true;
1681	else
1682	{
1683	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_BLOCKBITMAP_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1684	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_USERBLOCK_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1685	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_BAT_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1686	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_FOOTER_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1687	break;
1688	}
1689
1690
1691	/*
1692	* Write the new block at the current end of the file.
1693	*/
1694	rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1695	pImage->uCurrentEndOfFile + (pImage->cDataBlockBitmapSectors + (cSector % pImage->cSectorsPerDataBlock)) * VHD_SECTOR_SIZE,
1696	pIoCtx, cbWrite,
1697	vhdAsyncExpansionDataComplete,
1698	pExpand);
1699	if (RT_SUCCESS(rc))
1700	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_USERBLOCK_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_SUCCESS);
1701	else if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1702	fIoInProgress = true;
1703	else
1704	{
1705	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_USERBLOCK_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1706	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_BAT_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1707	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_FOOTER_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1708	break;
1709	}
1710
1711	/*
1712	* Write entry in the BAT.
1713	*/
1714	rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1715	pImage->uBlockAllocationTableOffset + cBlockAllocationTableEntry * sizeof(uint32_t),
1716	&pExpand->idxBlockBe, sizeof(uint32_t), pIoCtx,
1717	vhdAsyncExpansionBatUpdateComplete,
1718	pExpand);
1719	if (RT_SUCCESS(rc))
1720	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_BAT_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_SUCCESS);
1721	else if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1722	fIoInProgress = true;
1723	else
1724	{
1725	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_BAT_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1726	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_FOOTER_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1727	break;
1728	}
1729
1730	/*
1731	* Set the new end of the file and link the new block into the BAT.
1732	*/
1733	pImage->uCurrentEndOfFile += pImage->cDataBlockBitmapSectors * VHD_SECTOR_SIZE + pImage->cbDataBlock;
1734
1735	/* Update the footer. */
1736	rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1737	pImage->uCurrentEndOfFile,
1738	&pImage->vhdFooterCopy,
1739	sizeof(VHDFooter), pIoCtx,
1740	vhdAsyncExpansionFooterUpdateComplete,
1741	pExpand);
1742	if (RT_SUCCESS(rc))
1743	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_FOOTER_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_SUCCESS);
1744	else if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1745	fIoInProgress = true;
1746	else
1747	{
1748	VHDIMAGEEXPAND_STATUS_SET(pExpand->fFlags, VHDIMAGEEXPAND_FOOTER_STATUS_SHIFT, VHDIMAGEEXPAND_STEP_FAILED);
1749	break;
1750	}
1751
1752	} while (0);
1753
1754	if (!fIoInProgress)
1755	vhdAsyncExpansionComplete(pImage, pIoCtx, pExpand);
1756	else
1757	rc = VERR_VD_ASYNC_IO_IN_PROGRESS;
1758	}
1759	else
1760	{
1761	/*
1762	* Calculate the real offset in the file.
1763	*/
1764	uVhdOffset = ((uint64_t)pImage->pBlockAllocationTable[cBlockAllocationTableEntry] + pImage->cDataBlockBitmapSectors + cBATEntryIndex) * VHD_SECTOR_SIZE;
1765
1766	/* Read in the block's bitmap. */
1767	PVDMETAXFER pMetaXfer;
1768	rc = vdIfIoIntFileReadMeta(pImage->pIfIo, pImage->pStorage,
1769	((uint64_t)pImage->pBlockAllocationTable[cBlockAllocationTableEntry]) * VHD_SECTOR_SIZE,
1770	pImage->pu8Bitmap,
1771	pImage->cbDataBlockBitmap, pIoCtx,
1772	&pMetaXfer, NULL, NULL);
1773	if (RT_SUCCESS(rc))
1774	{
1775	vdIfIoIntMetaXferRelease(pImage->pIfIo, pMetaXfer);
1776
1777	/* Write data. */
1778	rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1779	uVhdOffset, pIoCtx, cbWrite,
1780	NULL, NULL);
1781	if (RT_SUCCESS(rc) \|\| rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1782	{
1783	bool fChanged = false;
1784
1785	/* Set the bits for all sectors having been written. */
1786	for (uint32_t iSector = 0; iSector < (cbWrite / VHD_SECTOR_SIZE); iSector++)
1787	{
1788	fChanged \|= vhdBlockBitmapSectorSet(pImage, pImage->pu8Bitmap, cBATEntryIndex);
1789	cBATEntryIndex++;
1790	}
1791
1792	/* Only write the bitmap if it was changed. */
1793	if (fChanged)
1794	{
1795	/*
1796	* Write the bitmap back.
1797	*
1798	* @note We don't have a completion callback here because we
1799	* can't do anything if the write fails for some reason.
1800	* The error will propagated to the device/guest
1801	* by the generic VD layer already and we don't need
1802	* to rollback anything here.
1803	*/
1804	rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1805	((uint64_t)pImage->pBlockAllocationTable[cBlockAllocationTableEntry]) * VHD_SECTOR_SIZE,
1806	pImage->pu8Bitmap,
1807	pImage->cbDataBlockBitmap,
1808	pIoCtx, NULL, NULL);
1809	}
1810	}
1811	}
1812	}
1813	}
1814	else
1815	rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1816	uOffset, pIoCtx, cbWrite, NULL, NULL);
1817
1818	if (pcbWriteProcess)
1819	*pcbWriteProcess = cbWrite;
1820
1821	/* Stay on the safe side. Do not run the risk of confusing the higher
1822	* level, as that can be pretty lethal to image consistency. */
1823	*pcbPreRead = 0;
1824	*pcbPostRead = 0;
1825
1826	return rc;
1827	}
1828
1829	/** @copydoc VBOXHDDBACKEND::pfnFlush */
1830	static int vhdFlush(void *pBackendData, PVDIOCTX pIoCtx)
1831	{
1832	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1833
1834	/* No need to write anything here. Data is always updated on a write. */
1835	return vdIfIoIntFileFlush(pImage->pIfIo, pImage->pStorage, pIoCtx, NULL, NULL);
1836	}
1837
1838	/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
1839	static unsigned vhdGetVersion(void *pBackendData)
1840	{
1841	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1842	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1843	unsigned ver = 0;
1844
1845	AssertPtr(pImage);
1846
1847	if (pImage)
1848	ver = 1; /*< @todo use correct version /
1849
1850	LogFlowFunc(("returns %u\n", ver));
1851	return ver;
1852	}
1853
1854	/** @copydoc VBOXHDDBACKEND::pfnGetSectorSize */
1855	static uint32_t vhdGetSectorSize(void *pBackendData)
1856	{
1857	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1858	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1859	uint32_t cb = 0;
1860
1861	AssertPtr(pImage);
1862
1863	if (pImage)
1864	cb = 512;
1865
1866	LogFlowFunc(("returns %zu\n", cb));
1867	return cb;
1868	}
1869
1870	/** @copydoc VBOXHDDBACKEND::pfnGetSize */
1871	static uint64_t vhdGetSize(void *pBackendData)
1872	{
1873	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1874	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1875	uint64_t cb = 0;
1876
1877	AssertPtr(pImage);
1878
1879	if (pImage && pImage->pStorage)
1880	cb = pImage->cbSize;
1881
1882	LogFlowFunc(("returns %llu\n", cb));
1883	return cb;
1884	}
1885
1886	/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
1887	static uint64_t vhdGetFileSize(void *pBackendData)
1888	{
1889	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1890	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1891	uint64_t cb = 0;
1892
1893	AssertPtr(pImage);
1894
1895	if (pImage && pImage->pStorage)
1896	cb = pImage->uCurrentEndOfFile + sizeof(VHDFooter);
1897
1898	LogFlowFunc(("returns %lld\n", cb));
1899	return cb;
1900	}
1901
1902	/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
1903	static int vhdGetPCHSGeometry(void *pBackendData, PVDGEOMETRY pPCHSGeometry)
1904	{
1905	LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
1906	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1907	int rc;
1908
1909	AssertPtr(pImage);
1910
1911	if (pImage)
1912	{
1913	if (pImage->PCHSGeometry.cCylinders)
1914	{
1915	*pPCHSGeometry = pImage->PCHSGeometry;
1916	rc = VINF_SUCCESS;
1917	}
1918	else
1919	rc = VERR_VD_GEOMETRY_NOT_SET;
1920	}
1921	else
1922	rc = VERR_VD_NOT_OPENED;
1923
1924	LogFlowFunc(("returns %Rrc (CHS=%u/%u/%u)\n", rc, pImage->PCHSGeometry.cCylinders, pImage->PCHSGeometry.cHeads, pImage->PCHSGeometry.cSectors));
1925	return rc;
1926	}
1927
1928	/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
1929	static int vhdSetPCHSGeometry(void *pBackendData, PCVDGEOMETRY pPCHSGeometry)
1930	{
1931	LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1932	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1933	int rc;
1934
1935	AssertPtr(pImage);
1936
1937	if (pImage)
1938	{
1939	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1940	{
1941	rc = VERR_VD_IMAGE_READ_ONLY;
1942	goto out;
1943	}
1944
1945	pImage->PCHSGeometry = *pPCHSGeometry;
1946	rc = VINF_SUCCESS;
1947	}
1948	else
1949	rc = VERR_VD_NOT_OPENED;
1950
1951	out:
1952	LogFlowFunc(("returns %Rrc\n", rc));
1953	return rc;
1954	}
1955
1956	/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
1957	static int vhdGetLCHSGeometry(void *pBackendData, PVDGEOMETRY pLCHSGeometry)
1958	{
1959	LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
1960	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1961	int rc;
1962
1963	AssertPtr(pImage);
1964
1965	if (pImage)
1966	{
1967	if (pImage->LCHSGeometry.cCylinders)
1968	{
1969	*pLCHSGeometry = pImage->LCHSGeometry;
1970	rc = VINF_SUCCESS;
1971	}
1972	else
1973	rc = VERR_VD_GEOMETRY_NOT_SET;
1974	}
1975	else
1976	rc = VERR_VD_NOT_OPENED;
1977
1978	LogFlowFunc(("returns %Rrc (CHS=%u/%u/%u)\n", rc, pImage->LCHSGeometry.cCylinders, pImage->LCHSGeometry.cHeads, pImage->LCHSGeometry.cSectors));
1979	return rc;
1980	}
1981
1982	/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
1983	static int vhdSetLCHSGeometry(void *pBackendData, PCVDGEOMETRY pLCHSGeometry)
1984	{
1985	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
1986	int rc;
1987
1988	AssertPtr(pImage);
1989
1990	if (pImage)
1991	{
1992	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
1993	{
1994	rc = VERR_VD_IMAGE_READ_ONLY;
1995	goto out;
1996	}
1997
1998	pImage->LCHSGeometry = *pLCHSGeometry;
1999	rc = VINF_SUCCESS;
2000	}
2001	else
2002	rc = VERR_VD_NOT_OPENED;
2003
2004	out:
2005	LogFlowFunc(("returns %Rrc\n", rc));
2006	return rc;
2007	}
2008
2009	/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
2010	static unsigned vhdGetImageFlags(void *pBackendData)
2011	{
2012	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2013	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2014	unsigned uImageFlags;
2015
2016	AssertPtr(pImage);
2017
2018	if (pImage)
2019	uImageFlags = pImage->uImageFlags;
2020	else
2021	uImageFlags = 0;
2022
2023	LogFlowFunc(("returns %#x\n", uImageFlags));
2024	return uImageFlags;
2025	}
2026
2027	/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
2028	static unsigned vhdGetOpenFlags(void *pBackendData)
2029	{
2030	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2031	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2032	unsigned uOpenFlags;
2033
2034	AssertPtr(pImage);
2035
2036	if (pImage)
2037	uOpenFlags = pImage->uOpenFlags;
2038	else
2039	uOpenFlags = 0;
2040
2041	LogFlowFunc(("returns %#x\n", uOpenFlags));
2042	return uOpenFlags;
2043	}
2044
2045	/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
2046	static int vhdSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
2047	{
2048	LogFlowFunc(("pBackendData=%#p\n uOpenFlags=%#x", pBackendData, uOpenFlags));
2049	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2050	int rc;
2051
2052	/* Image must be opened and the new flags must be valid. */
2053	if (!pImage \|\| (uOpenFlags & ~( VD_OPEN_FLAGS_READONLY \| VD_OPEN_FLAGS_INFO
2054	\| VD_OPEN_FLAGS_ASYNC_IO \| VD_OPEN_FLAGS_SHAREABLE
2055	\| VD_OPEN_FLAGS_SEQUENTIAL \| VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS)))
2056	{
2057	rc = VERR_INVALID_PARAMETER;
2058	goto out;
2059	}
2060
2061	/* Implement this operation via reopening the image. */
2062	rc = vhdFreeImage(pImage, false);
2063	if (RT_FAILURE(rc))
2064	goto out;
2065	rc = vhdOpenImage(pImage, uOpenFlags);
2066
2067	out:
2068	LogFlowFunc(("returns %Rrc\n", rc));
2069	return rc;
2070	}
2071
2072	/** @copydoc VBOXHDDBACKEND::pfnGetComment */
2073	static int vhdGetComment(void pBackendData, char pszComment,
2074	size_t cbComment)
2075	{
2076	LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
2077	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2078	int rc;
2079
2080	AssertPtr(pImage);
2081
2082	if (pImage)
2083	rc = VERR_NOT_SUPPORTED;
2084	else
2085	rc = VERR_VD_NOT_OPENED;
2086
2087	LogFlowFunc(("returns %Rrc comment='%s'\n", rc, pszComment));
2088	return rc;
2089	}
2090
2091	/** @copydoc VBOXHDDBACKEND::pfnSetComment */
2092	static int vhdSetComment(void pBackendData, const char pszComment)
2093	{
2094	LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
2095	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2096	int rc;
2097
2098	AssertPtr(pImage);
2099
2100	if (pImage)
2101	{
2102	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2103	rc = VERR_VD_IMAGE_READ_ONLY;
2104	else
2105	rc = VERR_NOT_SUPPORTED;
2106	}
2107	else
2108	rc = VERR_VD_NOT_OPENED;
2109
2110	LogFlowFunc(("returns %Rrc\n", rc));
2111	return rc;
2112	}
2113
2114	/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
2115	static int vhdGetUuid(void *pBackendData, PRTUUID pUuid)
2116	{
2117	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2118	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2119	int rc;
2120
2121	AssertPtr(pImage);
2122
2123	if (pImage)
2124	{
2125	*pUuid = pImage->ImageUuid;
2126	rc = VINF_SUCCESS;
2127	}
2128	else
2129	rc = VERR_VD_NOT_OPENED;
2130
2131	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2132	return rc;
2133	}
2134
2135	/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
2136	static int vhdSetUuid(void *pBackendData, PCRTUUID pUuid)
2137	{
2138	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2139	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2140	int rc;
2141
2142	AssertPtr(pImage);
2143
2144	if (pImage)
2145	{
2146	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2147	{
2148	pImage->ImageUuid = *pUuid;
2149	/* Update the footer copy. It will get written to disk when the image is closed. */
2150	memcpy(&pImage->vhdFooterCopy.UniqueID, pUuid, 16);
2151	/* Update checksum. */
2152	pImage->vhdFooterCopy.Checksum = 0;
2153	pImage->vhdFooterCopy.Checksum = RT_H2BE_U32(vhdChecksum(&pImage->vhdFooterCopy, sizeof(VHDFooter)));
2154
2155	/* Need to update the dynamic disk header to update the disk footer copy at the beginning. */
2156	if (!(pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED))
2157	pImage->fDynHdrNeedsUpdate = true;
2158	rc = VINF_SUCCESS;
2159	}
2160	else
2161	rc = VERR_VD_IMAGE_READ_ONLY;
2162	}
2163	else
2164	rc = VERR_VD_NOT_OPENED;
2165
2166	LogFlowFunc(("returns %Rrc\n", rc));
2167	return rc;
2168	}
2169
2170	/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
2171	static int vhdGetModificationUuid(void *pBackendData, PRTUUID pUuid)
2172	{
2173	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2174	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2175	int rc;
2176
2177	AssertPtr(pImage);
2178
2179	if (pImage)
2180	rc = VERR_NOT_SUPPORTED;
2181	else
2182	rc = VERR_VD_NOT_OPENED;
2183
2184	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2185	return rc;
2186	}
2187
2188	/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
2189	static int vhdSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
2190	{
2191	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2192	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2193	int rc;
2194
2195	AssertPtr(pImage);
2196
2197	if (pImage)
2198	{
2199	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2200	rc = VERR_NOT_SUPPORTED;
2201	else
2202	rc = VERR_VD_IMAGE_READ_ONLY;
2203	}
2204	else
2205	rc = VERR_VD_NOT_OPENED;
2206
2207	LogFlowFunc(("returns %Rrc\n", rc));
2208	return rc;
2209	}
2210
2211	/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
2212	static int vhdGetParentUuid(void *pBackendData, PRTUUID pUuid)
2213	{
2214	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2215	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2216	int rc;
2217
2218	AssertPtr(pImage);
2219
2220	if (pImage)
2221	{
2222	*pUuid = pImage->ParentUuid;
2223	rc = VINF_SUCCESS;
2224	}
2225	else
2226	rc = VERR_VD_NOT_OPENED;
2227
2228	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2229	return rc;
2230	}
2231
2232	/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
2233	static int vhdSetParentUuid(void *pBackendData, PCRTUUID pUuid)
2234	{
2235	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2236	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2237	int rc = VINF_SUCCESS;
2238
2239	AssertPtr(pImage);
2240
2241	if (pImage && pImage->pStorage)
2242	{
2243	if (!(pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED))
2244	{
2245	pImage->ParentUuid = *pUuid;
2246	pImage->fDynHdrNeedsUpdate = true;
2247	}
2248	else
2249	rc = VERR_VD_IMAGE_READ_ONLY;
2250	}
2251	else
2252	rc = VERR_VD_NOT_OPENED;
2253
2254	LogFlowFunc(("returns %Rrc\n", rc));
2255	return rc;
2256	}
2257
2258	/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
2259	static int vhdGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
2260	{
2261	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2262	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2263	int rc;
2264
2265	AssertPtr(pImage);
2266
2267	if (pImage)
2268	rc = VERR_NOT_SUPPORTED;
2269	else
2270	rc = VERR_VD_NOT_OPENED;
2271
2272	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
2273	return rc;
2274	}
2275
2276	/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
2277	static int vhdSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
2278	{
2279	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2280	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2281	int rc;
2282
2283	AssertPtr(pImage);
2284
2285	if (pImage)
2286	{
2287	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2288	rc = VERR_NOT_SUPPORTED;
2289	else
2290	rc = VERR_VD_IMAGE_READ_ONLY;
2291	}
2292	else
2293	rc = VERR_VD_NOT_OPENED;
2294
2295	LogFlowFunc(("returns %Rrc\n", rc));
2296	return rc;
2297	}
2298
2299	/** @copydoc VBOXHDDBACKEND::pfnDump */
2300	static void vhdDump(void *pBackendData)
2301	{
2302	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2303
2304	AssertPtr(pImage);
2305	if (pImage)
2306	{
2307	vdIfErrorMessage(pImage->pIfError, "Header: Geometry PCHS=%u/%u/%u LCHS=%u/%u/%u cbSector=%u\n",
2308	pImage->PCHSGeometry.cCylinders, pImage->PCHSGeometry.cHeads, pImage->PCHSGeometry.cSectors,
2309	pImage->LCHSGeometry.cCylinders, pImage->LCHSGeometry.cHeads, pImage->LCHSGeometry.cSectors,
2310	VHD_SECTOR_SIZE);
2311	vdIfErrorMessage(pImage->pIfError, "Header: uuidCreation={%RTuuid}\n", &pImage->ImageUuid);
2312	vdIfErrorMessage(pImage->pIfError, "Header: uuidParent={%RTuuid}\n", &pImage->ParentUuid);
2313	}
2314	}
2315
2316	/** @copydoc VBOXHDDBACKEND::pfnGetTimestamp */
2317	static int vhdGetTimeStamp(void *pBackendData, PRTTIMESPEC pTimeStamp)
2318	{
2319	int rc = VINF_SUCCESS;
2320	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2321
2322	AssertPtr(pImage);
2323
2324	if (pImage)
2325	rc = vdIfIoIntFileGetModificationTime(pImage->pIfIo, pImage->pszFilename, pTimeStamp);
2326	else
2327	rc = VERR_VD_NOT_OPENED;
2328
2329	LogFlowFunc(("returns %Rrc\n", rc));
2330	return rc;
2331	}
2332
2333	/** @copydoc VBOXHDDBACKEND::pfnGetParentTimeStamp */
2334	static int vhdGetParentTimeStamp(void *pBackendData, PRTTIMESPEC pTimeStamp)
2335	{
2336	int rc = VINF_SUCCESS;
2337	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2338
2339	AssertPtr(pImage);
2340
2341	if (pImage)
2342	vhdTime2RtTime(pTimeStamp, pImage->u32ParentTimeStamp);
2343	else
2344	rc = VERR_VD_NOT_OPENED;
2345
2346	LogFlowFunc(("returns %Rrc\n", rc));
2347	return rc;
2348	}
2349
2350	/** @copydoc VBOXHDDBACKEND::pfnSetParentTimeStamp */
2351	static int vhdSetParentTimeStamp(void *pBackendData, PCRTTIMESPEC pTimeStamp)
2352	{
2353	int rc = VINF_SUCCESS;
2354	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2355
2356	AssertPtr(pImage);
2357	if (pImage)
2358	{
2359	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2360	rc = VERR_VD_IMAGE_READ_ONLY;
2361	else
2362	{
2363	pImage->u32ParentTimeStamp = vhdRtTime2VhdTime(pTimeStamp);
2364	pImage->fDynHdrNeedsUpdate = true;
2365	}
2366	}
2367	else
2368	rc = VERR_VD_NOT_OPENED;
2369
2370	LogFlowFunc(("returns %Rrc\n", rc));
2371	return rc;
2372	}
2373
2374	/** @copydoc VBOXHDDBACKEND::pfnGetParentFilename */
2375	static int vhdGetParentFilename(void pBackendData, char *ppszParentFilename)
2376	{
2377	int rc = VINF_SUCCESS;
2378	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2379
2380	AssertPtr(pImage);
2381	if (pImage)
2382	*ppszParentFilename = RTStrDup(pImage->pszParentFilename);
2383	else
2384	rc = VERR_VD_NOT_OPENED;
2385
2386	LogFlowFunc(("returns %Rrc\n", rc));
2387	return rc;
2388	}
2389
2390	/** @copydoc VBOXHDDBACKEND::pfnSetParentFilename */
2391	static int vhdSetParentFilename(void pBackendData, const char pszParentFilename)
2392	{
2393	int rc = VINF_SUCCESS;
2394	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2395
2396	AssertPtr(pImage);
2397	if (pImage)
2398	{
2399	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2400	rc = VERR_VD_IMAGE_READ_ONLY;
2401	else
2402	{
2403	if (pImage->pszParentFilename)
2404	RTStrFree(pImage->pszParentFilename);
2405	pImage->pszParentFilename = RTStrDup(pszParentFilename);
2406	if (!pImage->pszParentFilename)
2407	rc = VERR_NO_MEMORY;
2408	else
2409	pImage->fDynHdrNeedsUpdate = true;
2410	}
2411	}
2412	else
2413	rc = VERR_VD_NOT_OPENED;
2414
2415	LogFlowFunc(("returns %Rrc\n", rc));
2416	return rc;
2417	}
2418
2419	/** @copydoc VBOXHDDBACKEND::pfnCompact */
2420	static int vhdCompact(void *pBackendData, unsigned uPercentStart,
2421	unsigned uPercentSpan, PVDINTERFACE pVDIfsDisk,
2422	PVDINTERFACE pVDIfsImage, PVDINTERFACE pVDIfsOperation)
2423	{
2424	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2425	int rc = VINF_SUCCESS;
2426	void pvBuf = NULL, pvReplace = NULL;
2427	uint32_t *paBlocks = NULL;
2428
2429	int (pfnParentRead)(void , uint64_t, void *, size_t) = NULL;
2430	void *pvParent = NULL;
2431	PVDINTERFACEPARENTSTATE pIfParentState = VDIfParentStateGet(pVDIfsOperation);
2432	if (pIfParentState)
2433	{
2434	pfnParentRead = pIfParentState->pfnParentRead;
2435	pvParent = pIfParentState->Core.pvUser;
2436	}
2437
2438	PFNVDPROGRESS pfnProgress = NULL;
2439	void *pvUser = NULL;
2440	PVDINTERFACEPROGRESS pIfProgress = VDIfProgressGet(pVDIfsOperation);
2441	if (pIfProgress)
2442	{
2443	pfnProgress = pIfProgress->pfnProgress;
2444	pvUser = pIfProgress->Core.pvUser;
2445	}
2446
2447	do
2448	{
2449	AssertBreakStmt(pImage, rc = VERR_INVALID_PARAMETER);
2450
2451	AssertBreakStmt(!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY),
2452	rc = VERR_VD_IMAGE_READ_ONLY);
2453
2454	/* Reject fixed images as they don't have a BAT. */
2455	if (pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED)
2456	{
2457	rc = VERR_NOT_SUPPORTED;
2458	break;
2459	}
2460
2461	if (pfnParentRead)
2462	{
2463	pvParent = RTMemTmpAlloc(pImage->cbDataBlock);
2464	AssertBreakStmt(pvParent, rc = VERR_NO_MEMORY);
2465	}
2466	pvBuf = RTMemTmpAlloc(pImage->cbDataBlock);
2467	AssertBreakStmt(pvBuf, rc = VERR_NO_MEMORY);
2468
2469	unsigned cBlocksAllocated = 0;
2470	unsigned cBlocksToMove = 0;
2471	unsigned cBlocks = pImage->cBlockAllocationTableEntries;
2472	uint32_t offBlocksStart = ~0U; /* Start offset of data blocks in sectors. */
2473	uint32_t *paBat = pImage->pBlockAllocationTable;
2474
2475	/* Count the number of allocated blocks and find the start offset for the data blocks. */
2476	for (unsigned i = 0; i < cBlocks; i++)
2477	if (paBat[i] != ~0U)
2478	{
2479	cBlocksAllocated++;
2480	if (paBat[i] < offBlocksStart)
2481	offBlocksStart = paBat[i];
2482	}
2483
2484	if (!cBlocksAllocated)
2485	{
2486	/* Nothing to do. */
2487	rc = VINF_SUCCESS;
2488	break;
2489	}
2490
2491	paBlocks = (uint32_t )RTMemTmpAllocZ(cBlocksAllocated sizeof(uint32_t));
2492	AssertBreakStmt(paBlocks, rc = VERR_NO_MEMORY);
2493
2494	/* Invalidate the back resolving array. */
2495	for (unsigned i = 0; i < cBlocksAllocated; i++)
2496	paBlocks[i] = ~0U;
2497
2498	/* Fill the back resolving table. */
2499	for (unsigned i = 0; i < cBlocks; i++)
2500	if (paBat[i] != ~0U)
2501	{
2502	unsigned idxBlock = (paBat[i] - offBlocksStart) / pImage->cSectorsPerDataBlock;
2503	if ( idxBlock < cBlocksAllocated
2504	&& paBlocks[idxBlock] == ~0U)
2505	paBlocks[idxBlock] = i;
2506	else
2507	{
2508	/* The image is in an inconsistent state. Don't go further. */
2509	rc = VERR_INVALID_STATE;
2510	break;
2511	}
2512	}
2513
2514	if (RT_FAILURE(rc))
2515	break;
2516
2517	/* Find redundant information and update the block pointers
2518	* accordingly, creating bubbles. Keep disk up to date, as this
2519	* enables cancelling. */
2520	for (unsigned i = 0; i < cBlocks; i++)
2521	{
2522	if (paBat[i] != ~0U)
2523	{
2524	unsigned idxBlock = (paBat[i] - offBlocksStart) / pImage->cSectorsPerDataBlock;
2525
2526	/* Block present in image file, read relevant data. */
2527	uint64_t u64Offset = ((uint64_t)paBat[i] + pImage->cDataBlockBitmapSectors) * VHD_SECTOR_SIZE;
2528	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
2529	u64Offset, pvBuf, pImage->cbDataBlock);
2530	if (RT_FAILURE(rc))
2531	break;
2532
2533	if (ASMBitFirstSet((volatile void )pvBuf, (uint32_t)pImage->cbDataBlock 8) == -1)
2534	{
2535	paBat[i] = ~0;
2536	paBlocks[idxBlock] = ~0U;
2537	/* Adjust progress info, one block to be relocated. */
2538	cBlocksToMove++;
2539	}
2540	else if (pfnParentRead)
2541	{
2542	rc = pfnParentRead(pvParent, (uint64_t)i * pImage->cbDataBlock, pvParent, pImage->cbDataBlock);
2543	if (RT_FAILURE(rc))
2544	break;
2545	if (!memcmp(pvParent, pvBuf, pImage->cbDataBlock))
2546	{
2547	paBat[i] = ~0U;
2548	paBlocks[idxBlock] = ~0U;
2549	/* Adjust progress info, one block to be relocated. */
2550	cBlocksToMove++;
2551	}
2552	}
2553	}
2554
2555	if (pIfProgress && pIfProgress->pfnProgress)
2556	{
2557	rc = pIfProgress->pfnProgress(pIfProgress->Core.pvUser,
2558	(uint64_t)i * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2559	if (RT_FAILURE(rc))
2560	break;
2561	}
2562	}
2563
2564	if (RT_SUCCESS(rc))
2565	{
2566	/* Fill bubbles with other data (if available). */
2567	unsigned cBlocksMoved = 0;
2568	unsigned uBlockUsedPos = cBlocksAllocated;
2569	size_t cbBlock = pImage->cbDataBlock + pImage->cbDataBlockBitmap; /** < Size of whole block containing the bitmap and the user data. */
2570
2571	/* Allocate data buffer to hold the data block and allocation bitmap in front of the actual data. */
2572	RTMemTmpFree(pvBuf);
2573	pvBuf = RTMemTmpAllocZ(cbBlock);
2574	AssertBreakStmt(pvBuf, rc = VERR_NO_MEMORY);
2575
2576	for (unsigned i = 0; i < cBlocksAllocated; i++)
2577	{
2578	unsigned uBlock = paBlocks[i];
2579	if (uBlock == ~0U)
2580	{
2581	unsigned uBlockData = ~0U;
2582	while (uBlockUsedPos > i && uBlockData == ~0U)
2583	{
2584	uBlockUsedPos--;
2585	uBlockData = paBlocks[uBlockUsedPos];
2586	}
2587	/* Terminate early if there is no block which needs copying. */
2588	if (uBlockUsedPos == i)
2589	break;
2590	uint64_t u64Offset = (uint64_t)uBlockUsedPos * cbBlock
2591	+ (offBlocksStart * VHD_SECTOR_SIZE);
2592	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
2593	u64Offset, pvBuf, cbBlock);
2594	if (RT_FAILURE(rc))
2595	break;
2596
2597	u64Offset = (uint64_t)i * cbBlock
2598	+ (offBlocksStart * VHD_SECTOR_SIZE);
2599	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
2600	u64Offset, pvBuf, cbBlock);
2601	if (RT_FAILURE(rc))
2602	break;
2603
2604	paBat[uBlockData] = i*(pImage->cSectorsPerDataBlock + pImage->cDataBlockBitmapSectors) + offBlocksStart;
2605
2606	/* Truncate the file but leave enough room for the footer to avoid
2607	* races if other processes fill the whole harddisk. */
2608	rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage,
2609	pImage->uCurrentEndOfFile - cbBlock + VHD_SECTOR_SIZE);
2610	if (RT_FAILURE(rc))
2611	break;
2612
2613	/* Update pointers and write footer. */
2614	pImage->uCurrentEndOfFile -= cbBlock;
2615
2616	/* We're kinda screwed if this failes. */
2617	rc = vhdUpdateFooter(pImage);
2618	if (RT_FAILURE(rc))
2619	break;
2620
2621	paBlocks[i] = uBlockData;
2622	paBlocks[uBlockUsedPos] = ~0U;
2623	cBlocksMoved++;
2624	}
2625
2626	if (pIfProgress && pIfProgress->pfnProgress)
2627	{
2628	rc = pIfProgress->pfnProgress(pIfProgress->Core.pvUser,
2629	(uint64_t)(cBlocks + cBlocksMoved) * uPercentSpan / (cBlocks + cBlocksToMove) + uPercentStart);
2630
2631	if (RT_FAILURE(rc))
2632	break;
2633	}
2634	}
2635	}
2636
2637	/* Write the new BAT in any case. */
2638	rc = vhdFlushImage(pImage);
2639	} while (0);
2640
2641	if (paBlocks)
2642	RTMemTmpFree(paBlocks);
2643	if (pvParent)
2644	RTMemTmpFree(pvParent);
2645	if (pvBuf)
2646	RTMemTmpFree(pvBuf);
2647
2648	if (RT_SUCCESS(rc) && pIfProgress && pIfProgress->pfnProgress)
2649	{
2650	pIfProgress->pfnProgress(pIfProgress->Core.pvUser,
2651	uPercentStart + uPercentSpan);
2652	}
2653
2654	LogFlowFunc(("returns %Rrc\n", rc));
2655	return rc;
2656	}
2657
2658	/** @copydoc VBOXHDDBACKEND::pfnResize */
2659	static int vhdResize(void *pBackendData, uint64_t cbSize,
2660	PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
2661	unsigned uPercentStart, unsigned uPercentSpan,
2662	PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
2663	PVDINTERFACE pVDIfsOperation)
2664	{
2665	PVHDIMAGE pImage = (PVHDIMAGE)pBackendData;
2666	int rc = VINF_SUCCESS;
2667
2668	PFNVDPROGRESS pfnProgress = NULL;
2669	void *pvUser = NULL;
2670	PVDINTERFACEPROGRESS pIfProgress = VDIfProgressGet(pVDIfsOperation);
2671	if (pIfProgress)
2672	{
2673	pfnProgress = pIfProgress->pfnProgress;
2674	pvUser = pIfProgress->Core.pvUser;
2675	}
2676
2677	/* Making the image smaller is not supported at the moment. */
2678	if ( cbSize < pImage->cbSize
2679	\|\| pImage->uImageFlags & VD_IMAGE_FLAGS_FIXED)
2680	rc = VERR_NOT_SUPPORTED;
2681	else if (cbSize > pImage->cbSize)
2682	{
2683	unsigned cBlocksAllocated = 0;
2684	size_t cbBlock = pImage->cbDataBlock + pImage->cbDataBlockBitmap; /** < Size of a block including the sector bitmap. */
2685	uint32_t cBlocksNew = cbSize / pImage->cbDataBlock; /** < New number of blocks in the image after the resize */
2686	if (cbSize % pImage->cbDataBlock)
2687	cBlocksNew++;
2688
2689	uint32_t cBlocksOld = pImage->cBlockAllocationTableEntries; /** < Number of blocks before the resize. */
2690	uint64_t cbBlockspaceNew = RT_ALIGN_32(cBlocksNew * sizeof(uint32_t), VHD_SECTOR_SIZE); /** < Required space for the block array after the resize. */
2691	uint64_t offStartDataNew = RT_ALIGN_32(pImage->uBlockAllocationTableOffset + cbBlockspaceNew, VHD_SECTOR_SIZE); /** < New start offset for block data after the resize */
2692	uint64_t offStartDataOld = ~0ULL;
2693
2694	/* Go through the BAT and find the data start offset. */
2695	for (unsigned idxBlock = 0; idxBlock < pImage->cBlockAllocationTableEntries; idxBlock++)
2696	{
2697	if (pImage->pBlockAllocationTable[idxBlock] != ~0U)
2698	{
2699	uint64_t offStartBlock = (uint64_t)pImage->pBlockAllocationTable[idxBlock] * VHD_SECTOR_SIZE;
2700	if (offStartBlock < offStartDataOld)
2701	offStartDataOld = offStartBlock;
2702	cBlocksAllocated++;
2703	}
2704	}
2705
2706	if ( offStartDataOld != offStartDataNew
2707	&& cBlocksAllocated > 0)
2708	{
2709	/* Calculate how many sectors nee to be relocated. */
2710	uint64_t cbOverlapping = offStartDataNew - offStartDataOld;
2711	unsigned cBlocksReloc = (unsigned)(cbOverlapping / cbBlock);
2712	if (cbOverlapping % cbBlock)
2713	cBlocksReloc++;
2714
2715	cBlocksReloc = RT_MIN(cBlocksReloc, cBlocksAllocated);
2716	offStartDataNew = offStartDataOld;
2717
2718	/* Do the relocation. */
2719	LogFlow(("Relocating %u blocks\n", cBlocksReloc));
2720
2721	/*
2722	* Get the blocks we need to relocate first, they are appended to the end
2723	* of the image.
2724	*/
2725	void pvBuf = NULL, pvZero = NULL;
2726	do
2727	{
2728	/* Allocate data buffer. */
2729	pvBuf = RTMemAllocZ(cbBlock);
2730	if (!pvBuf)
2731	{
2732	rc = VERR_NO_MEMORY;
2733	break;
2734	}
2735
2736	/* Allocate buffer for overwriting with zeroes. */
2737	pvZero = RTMemAllocZ(cbBlock);
2738	if (!pvZero)
2739	{
2740	rc = VERR_NO_MEMORY;
2741	break;
2742	}
2743
2744	for (unsigned i = 0; i < cBlocksReloc; i++)
2745	{
2746	uint32_t uBlock = offStartDataNew / VHD_SECTOR_SIZE;
2747
2748	/* Search the index in the block table. */
2749	for (unsigned idxBlock = 0; idxBlock < cBlocksOld; idxBlock++)
2750	{
2751	if (pImage->pBlockAllocationTable[idxBlock] == uBlock)
2752	{
2753	/* Read data and append to the end of the image. */
2754	rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
2755	offStartDataNew, pvBuf, cbBlock);
2756	if (RT_FAILURE(rc))
2757	break;
2758
2759	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
2760	pImage->uCurrentEndOfFile, pvBuf, cbBlock);
2761	if (RT_FAILURE(rc))
2762	break;
2763
2764	/* Zero out the old block area. */
2765	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
2766	offStartDataNew, pvZero, cbBlock);
2767	if (RT_FAILURE(rc))
2768	break;
2769
2770	/* Update block counter. */
2771	pImage->pBlockAllocationTable[idxBlock] = pImage->uCurrentEndOfFile / VHD_SECTOR_SIZE;
2772
2773	pImage->uCurrentEndOfFile += cbBlock;
2774
2775	/* Continue with the next block. */
2776	break;
2777	}
2778	}
2779
2780	if (RT_FAILURE(rc))
2781	break;
2782
2783	offStartDataNew += cbBlock;
2784	}
2785	} while (0);
2786
2787	if (pvBuf)
2788	RTMemFree(pvBuf);
2789	if (pvZero)
2790	RTMemFree(pvZero);
2791	}
2792
2793	/*
2794	* Relocation done, expand the block array and update the header with
2795	* the new data.
2796	*/
2797	if (RT_SUCCESS(rc))
2798	{
2799	uint32_t paBlocksNew = (uint32_t )RTMemRealloc(pImage->pBlockAllocationTable, cBlocksNew * sizeof(uint32_t));
2800	if (paBlocksNew)
2801	{
2802	pImage->pBlockAllocationTable = paBlocksNew;
2803
2804	/* Mark the new blocks as unallocated. */
2805	for (unsigned idxBlock = cBlocksOld; idxBlock < cBlocksNew; idxBlock++)
2806	pImage->pBlockAllocationTable[idxBlock] = ~0U;
2807	}
2808	else
2809	rc = VERR_NO_MEMORY;
2810
2811	if (RT_SUCCESS(rc))
2812	{
2813	/* Write the block array before updating the rest. */
2814	rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
2815	pImage->uBlockAllocationTableOffset,
2816	pImage->pBlockAllocationTable,
2817	cBlocksNew * sizeof(uint32_t));
2818	}
2819
2820	if (RT_SUCCESS(rc))
2821	{
2822	/* Update size and new block count. */
2823	pImage->cBlockAllocationTableEntries = cBlocksNew;
2824	pImage->cbSize = cbSize;
2825
2826	/* Update geometry. */
2827	pImage->PCHSGeometry = *pPCHSGeometry;
2828	pImage->LCHSGeometry = *pLCHSGeometry;
2829	}
2830	}
2831
2832	/* Update header information in base image file. */
2833	pImage->fDynHdrNeedsUpdate = true;
2834	vhdFlushImage(pImage);
2835	}
2836	/* Same size doesn't change the image at all. */
2837
2838	LogFlowFunc(("returns %Rrc\n", rc));
2839	return rc;
2840	}
2841
2842	/** @copydoc VBOXHDDBACKEND::pfnRepair */
2843	static DECLCALLBACK(int) vhdRepair(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
2844	PVDINTERFACE pVDIfsImage, uint32_t fFlags)
2845	{
2846	LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p\n", pszFilename, pVDIfsDisk, pVDIfsImage));
2847	int rc;
2848	PVDINTERFACEERROR pIfError;
2849	PVDINTERFACEIOINT pIfIo;
2850	PVDIOSTORAGE pStorage;
2851	uint64_t cbFile;
2852	VHDFooter vhdFooter;
2853	VHDDynamicDiskHeader dynamicDiskHeader;
2854	uint32_t *paBat = NULL;
2855	uint32_t *pu32BlockBitmap = NULL;
2856
2857	pIfIo = VDIfIoIntGet(pVDIfsImage);
2858	AssertPtrReturn(pIfIo, VERR_INVALID_PARAMETER);
2859
2860	pIfError = VDIfErrorGet(pVDIfsDisk);
2861
2862	do
2863	{
2864	uint64_t offDynamicDiskHeader = 0;
2865	uint64_t offBat = 0;
2866	uint64_t offFooter = 0;
2867	uint32_t cBatEntries = 0;
2868	bool fDynamic = false;
2869	bool fRepairFooter = false;
2870	bool fRepairBat = false;
2871	bool fRepairDynHeader = false;
2872
2873	rc = vdIfIoIntFileOpen(pIfIo, pszFilename,
2874	VDOpenFlagsToFileOpenFlags( fFlags & VD_REPAIR_DRY_RUN
2875	? VD_OPEN_FLAGS_READONLY
2876	: 0,
2877	false /* fCreate */),
2878	&pStorage);
2879	if (RT_FAILURE(rc))
2880	{
2881	rc = vdIfError(pIfError, rc, RT_SRC_POS, "Failed to open image \"%s\"", pszFilename);
2882	break;
2883	}
2884
2885	rc = vdIfIoIntFileGetSize(pIfIo, pStorage, &cbFile);
2886	if (RT_FAILURE(rc))
2887	{
2888	rc = vdIfError(pIfError, rc, RT_SRC_POS, "Failed to query image size");
2889	break;
2890	}
2891
2892	if (cbFile < sizeof(VHDFooter))
2893	{
2894	rc = vdIfError(pIfError, VERR_VD_INVALID_SIZE, RT_SRC_POS,
2895	"Image must be at least %u bytes (got %llu)",
2896	sizeof(VHDFooter), cbFile);
2897	break;
2898	}
2899
2900	rc = vdIfIoIntFileReadSync(pIfIo, pStorage, cbFile - sizeof(VHDFooter),
2901	&vhdFooter, sizeof(VHDFooter));
2902	if (RT_FAILURE(rc))
2903	{
2904	rc = vdIfError(pIfError, rc, RT_SRC_POS, "Failed to read footer of image");
2905	break;
2906	}
2907
2908	if (memcmp(vhdFooter.Cookie, VHD_FOOTER_COOKIE, VHD_FOOTER_COOKIE_SIZE) != 0)
2909	{
2910	/* Dynamic images have a backup at the beginning of the image. */
2911	rc = vdIfIoIntFileReadSync(pIfIo, pStorage, 0,
2912	&vhdFooter, sizeof(VHDFooter));
2913	if (RT_FAILURE(rc))
2914	{
2915	rc = vdIfError(pIfError, rc, RT_SRC_POS, "Failed to read header of image");
2916	break;
2917	}
2918
2919	/*
2920	* Check for the header, if this fails the image is either completely corrupted
2921	* and impossible to repair or in another format.
2922	*/
2923	if (memcmp(vhdFooter.Cookie, VHD_FOOTER_COOKIE, VHD_FOOTER_COOKIE_SIZE) != 0)
2924	{
2925	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
2926	"No valid VHD structures found");
2927	break;
2928	}
2929	else
2930	vdIfErrorMessage(pIfError, "Missing footer structure, using backup\n");
2931
2932	/* Remember to fix the footer structure. */
2933	fRepairFooter = true;
2934	}
2935
2936	offFooter = cbFile - sizeof(VHDFooter);
2937
2938	/* Verify that checksums match. */
2939	uint32_t u32ChkSumOld = RT_BE2H_U32(vhdFooter.Checksum);
2940	vhdFooter.Checksum = 0;
2941	uint32_t u32ChkSum = vhdChecksum(&vhdFooter, sizeof(VHDFooter));
2942
2943	vhdFooter.Checksum = RT_H2BE_U32(u32ChkSum);
2944
2945	if (u32ChkSumOld != u32ChkSum)
2946	{
2947	vdIfErrorMessage(pIfError, "Checksum is invalid (should be %u got %u), repairing\n",
2948	u32ChkSum, u32ChkSumOld);
2949	fRepairFooter = true;
2950	break;
2951	}
2952
2953	switch (RT_BE2H_U32(vhdFooter.DiskType))
2954	{
2955	case VHD_FOOTER_DISK_TYPE_FIXED:
2956	fDynamic = false;
2957	break;
2958	case VHD_FOOTER_DISK_TYPE_DYNAMIC:
2959	fDynamic = true;
2960	break;
2961	case VHD_FOOTER_DISK_TYPE_DIFFERENCING:
2962	fDynamic = true;
2963	break;
2964	default:
2965	{
2966	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
2967	"VHD image type %u is not supported",
2968	RT_BE2H_U32(vhdFooter.DiskType));
2969	break;
2970	}
2971	}
2972
2973	/* Load and check dynamic disk header if required. */
2974	if (fDynamic)
2975	{
2976	size_t cbBlock;
2977
2978	offDynamicDiskHeader = RT_BE2H_U64(vhdFooter.DataOffset);
2979	if (offDynamicDiskHeader + sizeof(VHDDynamicDiskHeader) > cbFile)
2980	{
2981	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
2982	"VHD image type is not supported");
2983	break;
2984	}
2985
2986	rc = vdIfIoIntFileReadSync(pIfIo, pStorage, offDynamicDiskHeader,
2987	&dynamicDiskHeader, sizeof(VHDDynamicDiskHeader));
2988	if (RT_FAILURE(rc))
2989	{
2990	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
2991	"Failed to read dynamic disk header (at %llu), %Rrc",
2992	offDynamicDiskHeader, rc);
2993	break;
2994	}
2995
2996	/* Verify that checksums match. */
2997	u32ChkSumOld = RT_BE2H_U32(dynamicDiskHeader.Checksum);
2998	dynamicDiskHeader.Checksum = 0;
2999	u32ChkSum = vhdChecksum(&dynamicDiskHeader, sizeof(VHDDynamicDiskHeader));
3000
3001	dynamicDiskHeader.Checksum = RT_H2BE_U32(u32ChkSum);
3002
3003	if (u32ChkSumOld != u32ChkSum)
3004	{
3005	vdIfErrorMessage(pIfError, "Checksum of dynamic disk header is invalid (should be %u got %u), repairing\n",
3006	u32ChkSum, u32ChkSumOld);
3007	fRepairDynHeader = true;
3008	break;
3009	}
3010
3011	/* Read the block allocation table and fix any inconsistencies. */
3012	offBat = RT_BE2H_U64(dynamicDiskHeader.TableOffset);
3013	cBatEntries = RT_BE2H_U32(dynamicDiskHeader.MaxTableEntries);
3014	cbBlock = RT_BE2H_U32(dynamicDiskHeader.BlockSize);
3015	cbBlock += cbBlock / VHD_SECTOR_SIZE / 8;
3016
3017	if (offBat + cBatEntries * sizeof(uint32_t) > cbFile)
3018	{
3019	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3020	"Block allocation table is not inside the image");
3021	break;
3022	}
3023
3024	paBat = (uint32_t )RTMemAllocZ(cBatEntries sizeof(uint32_t));
3025	if (!paBat)
3026	{
3027	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3028	"Could not allocate memory for the block allocation table (%u bytes)",
3029	cBatEntries * sizeof(uint32_t));
3030	break;
3031	}
3032
3033	rc = vdIfIoIntFileReadSync(pIfIo, pStorage, offBat, paBat,
3034	cBatEntries * sizeof(uint32_t));
3035	if (RT_FAILURE(rc))
3036	{
3037	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3038	"Could not read block allocation table (at %llu), %Rrc",
3039	offBat, rc);
3040	break;
3041	}
3042
3043	pu32BlockBitmap = (uint32_t *)RTMemAllocZ(RT_ALIGN_Z(cBatEntries / 8, 4));
3044	if (!pu32BlockBitmap)
3045	{
3046	rc = vdIfError(pIfError, VERR_NO_MEMORY, RT_SRC_POS,
3047	"Failed to allocate memory for block bitmap");
3048	break;
3049	}
3050
3051	uint32_t idxMinBlock = UINT32_C(0xffffffff);
3052	for (uint32_t i = 0; i < cBatEntries; i++)
3053	{
3054	paBat[i] = RT_BE2H_U32(paBat[i]);
3055	if (paBat[i] < idxMinBlock)
3056	idxMinBlock = paBat[i];
3057	}
3058
3059	vdIfErrorMessage(pIfError, "First data block at sector %u\n", idxMinBlock);
3060
3061	for (uint32_t i = 0; i < cBatEntries; i++)
3062	{
3063	if (paBat[i] != UINT32_C(0xffffffff))
3064	{
3065	uint64_t offBlock =(uint64_t)paBat[i] * VHD_SECTOR_SIZE;
3066
3067	/*
3068	* Check that the offsets are valid (inside of the image) and
3069	* that there are no double references.
3070	*/
3071	if (offBlock + cbBlock > cbFile)
3072	{
3073	vdIfErrorMessage(pIfError, "Entry %u points to invalid offset %llu, clearing\n",
3074	i, offBlock);
3075	paBat[i] = UINT32_C(0xffffffff);
3076	fRepairBat = true;
3077	}
3078	else if (offBlock + cbBlock > offFooter)
3079	{
3080	vdIfErrorMessage(pIfError, "Entry %u intersects with footer, aligning footer\n",
3081	i);
3082	offFooter = offBlock + cbBlock;
3083	fRepairBat = true;
3084	}
3085
3086	if ( paBat[i] != UINT32_C(0xffffffff)
3087	&& ASMBitTestAndSet(pu32BlockBitmap, (uint32_t)((paBat[i] - idxMinBlock) / (cbBlock / VHD_SECTOR_SIZE))))
3088	{
3089	vdIfErrorMessage(pIfError, "Entry %u points to an already referenced data block, clearing\n",
3090	i);
3091	paBat[i] = UINT32_C(0xffffffff);
3092	fRepairBat = true;
3093	}
3094	}
3095	}
3096	}
3097
3098	/* Write repaired structures now. */
3099	if (!(fRepairBat \|\| fRepairDynHeader \|\| fRepairFooter))
3100	vdIfErrorMessage(pIfError, "VHD image is in a consistent state, no repair required\n");
3101	else if (!(fFlags & VD_REPAIR_DRY_RUN))
3102	{
3103	if (fRepairBat)
3104	{
3105	for (uint32_t i = 0; i < cBatEntries; i++)
3106	paBat[i] = RT_H2BE_U32(paBat[i]);
3107
3108	vdIfErrorMessage(pIfError, "Writing repaired block allocation table...\n");
3109
3110	rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, offBat, paBat,
3111	cBatEntries * sizeof(uint32_t));
3112	if (RT_FAILURE(rc))
3113	{
3114	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3115	"Could not write repaired block allocation table (at %llu), %Rrc",
3116	offBat, rc);
3117	break;
3118	}
3119	}
3120
3121	if (fRepairDynHeader)
3122	{
3123	Assert(fDynamic);
3124
3125	vdIfErrorMessage(pIfError, "Writing repaired dynamic disk header...\n");
3126	rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, offDynamicDiskHeader, &dynamicDiskHeader,
3127	sizeof(VHDDynamicDiskHeader));
3128	if (RT_FAILURE(rc))
3129	{
3130	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3131	"Could not write repaired dynamic disk header (at %llu), %Rrc",
3132	offDynamicDiskHeader, rc);
3133	break;
3134	}
3135	}
3136
3137	if (fRepairFooter)
3138	{
3139	vdIfErrorMessage(pIfError, "Writing repaired Footer...\n");
3140
3141	if (fDynamic)
3142	{
3143	/* Write backup at image beginning. */
3144	rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, 0, &vhdFooter,
3145	sizeof(VHDFooter));
3146	if (RT_FAILURE(rc))
3147	{
3148	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3149	"Could not write repaired backup footer (at %llu), %Rrc",
3150	0, rc);
3151	break;
3152	}
3153	}
3154
3155	rc = vdIfIoIntFileWriteSync(pIfIo, pStorage, offFooter, &vhdFooter,
3156	sizeof(VHDFooter));
3157	if (RT_FAILURE(rc))
3158	{
3159	rc = vdIfError(pIfError, VERR_VD_IMAGE_REPAIR_IMPOSSIBLE, RT_SRC_POS,
3160	"Could not write repaired footer (at %llu), %Rrc",
3161	cbFile - sizeof(VHDFooter), rc);
3162	break;
3163	}
3164	}
3165
3166	vdIfErrorMessage(pIfError, "Corrupted VHD image repaired successfully\n");
3167	}
3168	} while(0);
3169
3170	if (paBat)
3171	RTMemFree(paBat);
3172
3173	if (pu32BlockBitmap)
3174	RTMemFree(pu32BlockBitmap);
3175
3176	if (pStorage)
3177	{
3178	int rc2 = vdIfIoIntFileClose(pIfIo, pStorage);
3179	if (RT_SUCCESS(rc))
3180	rc = rc2; /* Propagate status code only when repairing the image was successful. */
3181	}
3182
3183	LogFlowFunc(("returns %Rrc\n", rc));
3184	return rc;
3185	}
3186
3187
3188	const VBOXHDDBACKEND g_VhdBackend =
3189	{
3190	/* pszBackendName */
3191	"VHD",
3192	/* cbSize */
3193	sizeof(VBOXHDDBACKEND),
3194	/* uBackendCaps */
3195	VD_CAP_UUID \| VD_CAP_DIFF \| VD_CAP_FILE \|
3196	VD_CAP_CREATE_FIXED \| VD_CAP_CREATE_DYNAMIC \|
3197	VD_CAP_ASYNC \| VD_CAP_VFS,
3198	/* paFileExtensions */
3199	s_aVhdFileExtensions,
3200	/* paConfigInfo */
3201	NULL,
3202	/* pfnCheckIfValid */
3203	vhdCheckIfValid,
3204	/* pfnOpen */
3205	vhdOpen,
3206	/* pfnCreate */
3207	vhdCreate,
3208	/* pfnRename */
3209	vhdRename,
3210	/* pfnClose */
3211	vhdClose,
3212	/* pfnRead */
3213	vhdRead,
3214	/* pfnWrite */
3215	vhdWrite,
3216	/* pfnFlush */
3217	vhdFlush,
3218	/* pfnDiscard */
3219	NULL,
3220	/* pfnGetVersion */
3221	vhdGetVersion,
3222	/* pfnGetSectorSize */
3223	vhdGetSectorSize,
3224	/* pfnGetSize */
3225	vhdGetSize,
3226	/* pfnGetFileSize */
3227	vhdGetFileSize,
3228	/* pfnGetPCHSGeometry */
3229	vhdGetPCHSGeometry,
3230	/* pfnSetPCHSGeometry */
3231	vhdSetPCHSGeometry,
3232	/* pfnGetLCHSGeometry */
3233	vhdGetLCHSGeometry,
3234	/* pfnSetLCHSGeometry */
3235	vhdSetLCHSGeometry,
3236	/* pfnGetImageFlags */
3237	vhdGetImageFlags,
3238	/* pfnGetOpenFlags */
3239	vhdGetOpenFlags,
3240	/* pfnSetOpenFlags */
3241	vhdSetOpenFlags,
3242	/* pfnGetComment */
3243	vhdGetComment,
3244	/* pfnSetComment */
3245	vhdSetComment,
3246	/* pfnGetUuid */
3247	vhdGetUuid,
3248	/* pfnSetUuid */
3249	vhdSetUuid,
3250	/* pfnGetModificationUuid */
3251	vhdGetModificationUuid,
3252	/* pfnSetModificationUuid */
3253	vhdSetModificationUuid,
3254	/* pfnGetParentUuid */
3255	vhdGetParentUuid,
3256	/* pfnSetParentUuid */
3257	vhdSetParentUuid,
3258	/* pfnGetParentModificationUuid */
3259	vhdGetParentModificationUuid,
3260	/* pfnSetParentModificationUuid */
3261	vhdSetParentModificationUuid,
3262	/* pfnDump */
3263	vhdDump,
3264	/* pfnGetTimeStamp */
3265	vhdGetTimeStamp,
3266	/* pfnGetParentTimeStamp */
3267	vhdGetParentTimeStamp,
3268	/* pfnSetParentTimeStamp */
3269	vhdSetParentTimeStamp,
3270	/* pfnGetParentFilename */
3271	vhdGetParentFilename,
3272	/* pfnSetParentFilename */
3273	vhdSetParentFilename,
3274	/* pfnComposeLocation */
3275	genericFileComposeLocation,
3276	/* pfnComposeName */
3277	genericFileComposeName,
3278	/* pfnCompact */
3279	vhdCompact,
3280	/* pfnResize */
3281	vhdResize,
3282	/* pfnRepair */
3283	vhdRepair,
3284	/* pfnTraverseMetadata */
3285	NULL
3286	};

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

source: vbox/trunk/src/VBox/Storage/VHD.cpp@ 54405

Download in other formats: