VirtualBox

source: vbox/trunk/src/VBox/Storage/QED.cpp@ 65720

Last change on this file since 65720 was 65644, checked in by vboxsync, 8 years ago

gcc 7: Storage: fall thru
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 88.7 KB
Line 
1/* $Id: QED.cpp 65644 2017-02-07 11:31:47Z vboxsync $ */
2/** @file
3 * QED - QED Disk image.
4 */
5
6/*
7 * Copyright (C) 2011-2016 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/*********************************************************************************************************************************
20* Header Files *
21*********************************************************************************************************************************/
22#define LOG_GROUP LOG_GROUP_VD_QED
23#include <VBox/vd-plugin.h>
24#include <VBox/err.h>
25
26#include <VBox/log.h>
27#include <iprt/asm.h>
28#include <iprt/assert.h>
29#include <iprt/string.h>
30#include <iprt/alloc.h>
31#include <iprt/path.h>
32#include <iprt/list.h>
33
34#include "VDBackends.h"
35
36/**
37 * The QED backend implements support for the qemu enhanced disk format (short QED)
38 * The specification for the format is available under http://wiki.qemu.org/Features/QED/Specification
39 *
40 * Missing things to implement:
41 * - compaction
42 * - resizing which requires block relocation (very rare case)
43 */
44
45
46/*********************************************************************************************************************************
47* Structures in a QED image, little endian *
48*********************************************************************************************************************************/
49
50#pragma pack(1)
51typedef struct QedHeader
52{
53 /** Magic value. */
54 uint32_t u32Magic;
55 /** Cluster size in bytes. */
56 uint32_t u32ClusterSize;
57 /** Size of L1 and L2 tables in clusters. */
58 uint32_t u32TableSize;
59 /** size of this header structure in clusters. */
60 uint32_t u32HeaderSize;
61 /** Features used for the image. */
62 uint64_t u64FeatureFlags;
63 /** Compatibility features used for the image. */
64 uint64_t u64CompatFeatureFlags;
65 /** Self resetting feature bits. */
66 uint64_t u64AutoresetFeatureFlags;
67 /** Offset of the L1 table in bytes. */
68 uint64_t u64OffL1Table;
69 /** Logical image size as seen by the guest. */
70 uint64_t u64Size;
71 /** Offset of the backing filename in bytes. */
72 uint32_t u32OffBackingFilename;
73 /** Size of the backing filename. */
74 uint32_t u32BackingFilenameSize;
75} QedHeader;
76#pragma pack()
77/** Pointer to a on disk QED header. */
78typedef QedHeader *PQedHeader;
79
80/** QED magic value. */
81#define QED_MAGIC UINT32_C(0x00444551) /* QED\0 */
82/** Cluster size minimum. */
83#define QED_CLUSTER_SIZE_MIN RT_BIT(12)
84/** Cluster size maximum. */
85#define QED_CLUSTER_SIZE_MAX RT_BIT(26)
86/** L1 and L2 Table size minimum. */
87#define QED_TABLE_SIZE_MIN 1
88/** L1 and L2 Table size maximum. */
89#define QED_TABLE_SIZE_MAX 16
90
91/** QED default cluster size when creating an image. */
92#define QED_CLUSTER_SIZE_DEFAULT (64 * _1K)
93/** The default table size in clusters. */
94#define QED_TABLE_SIZE_DEFAULT 4
95
96/** Feature flags.
97 * @{
98 */
99/** Image uses a backing file to provide data for unallocated clusters. */
100#define QED_FEATURE_BACKING_FILE RT_BIT_64(0)
101/** Image needs checking before use. */
102#define QED_FEATURE_NEED_CHECK RT_BIT_64(1)
103/** Don't probe for format of the backing file, treat as raw image. */
104#define QED_FEATURE_BACKING_FILE_NO_PROBE RT_BIT_64(2)
105/** Mask of valid features. */
106#define QED_FEATURE_MASK (QED_FEATURE_BACKING_FILE | QED_FEATURE_NEED_CHECK | QED_FEATURE_BACKING_FILE_NO_PROBE)
107/** @} */
108
109/** Compatibility feature flags.
110 * @{
111 */
112/** Mask of valid compatibility features. */
113#define QED_COMPAT_FEATURE_MASK (0)
114/** @} */
115
116/** Autoreset feature flags.
117 * @{
118 */
119/** Mask of valid autoreset features. */
120#define QED_AUTORESET_FEATURE_MASK (0)
121/** @} */
122
123
124/*********************************************************************************************************************************
125* Constants And Macros, Structures and Typedefs *
126*********************************************************************************************************************************/
127
128/**
129 * QED L2 cache entry.
130 */
131typedef struct QEDL2CACHEENTRY
132{
133 /** List node for the search list. */
134 RTLISTNODE NodeSearch;
135 /** List node for the LRU list. */
136 RTLISTNODE NodeLru;
137 /** Reference counter. */
138 uint32_t cRefs;
139 /** The offset of the L2 table, used as search key. */
140 uint64_t offL2Tbl;
141 /** Pointer to the cached L2 table. */
142 uint64_t *paL2Tbl;
143} QEDL2CACHEENTRY, *PQEDL2CACHEENTRY;
144
145/** Maximum amount of memory the cache is allowed to use. */
146#define QED_L2_CACHE_MEMORY_MAX (2*_1M)
147
148/**
149 * QED image data structure.
150 */
151typedef struct QEDIMAGE
152{
153 /** Image name. */
154 const char *pszFilename;
155 /** Storage handle. */
156 PVDIOSTORAGE pStorage;
157
158 /** Pointer to the per-disk VD interface list. */
159 PVDINTERFACE pVDIfsDisk;
160 /** Pointer to the per-image VD interface list. */
161 PVDINTERFACE pVDIfsImage;
162 /** Error interface. */
163 PVDINTERFACEERROR pIfError;
164 /** I/O interface. */
165 PVDINTERFACEIOINT pIfIo;
166
167 /** Open flags passed by VBoxHD layer. */
168 unsigned uOpenFlags;
169 /** Image flags defined during creation or determined during open. */
170 unsigned uImageFlags;
171 /** Total size of the image. */
172 uint64_t cbSize;
173 /** Physical geometry of this image. */
174 VDGEOMETRY PCHSGeometry;
175 /** Logical geometry of this image. */
176 VDGEOMETRY LCHSGeometry;
177
178 /** Filename of the backing file if any. */
179 char *pszBackingFilename;
180 /** Offset of the filename in the image. */
181 uint32_t offBackingFilename;
182 /** Size of the backing filename excluding \0. */
183 uint32_t cbBackingFilename;
184
185 /** Size of the image, multiple of clusters. */
186 uint64_t cbImage;
187 /** Cluster size in bytes. */
188 uint32_t cbCluster;
189 /** Number of entries in the L1 and L2 table. */
190 uint32_t cTableEntries;
191 /** Size of an L1 or L2 table rounded to the next cluster size. */
192 uint32_t cbTable;
193 /** Pointer to the L1 table. */
194 uint64_t *paL1Table;
195 /** Offset of the L1 table. */
196 uint64_t offL1Table;
197
198 /** Offset mask for a cluster. */
199 uint64_t fOffsetMask;
200 /** L1 table mask to get the L1 index. */
201 uint64_t fL1Mask;
202 /** Number of bits to shift to get the L1 index. */
203 uint32_t cL1Shift;
204 /** L2 table mask to get the L2 index. */
205 uint64_t fL2Mask;
206 /** Number of bits to shift to get the L2 index. */
207 uint32_t cL2Shift;
208
209 /** Pointer to the L2 table we are currently allocating
210 * (can be only one at a time). */
211 PQEDL2CACHEENTRY pL2TblAlloc;
212
213 /** Memory occupied by the L2 table cache. */
214 size_t cbL2Cache;
215 /** The sorted L2 entry list used for searching. */
216 RTLISTNODE ListSearch;
217 /** The LRU L2 entry list used for eviction. */
218 RTLISTNODE ListLru;
219
220} QEDIMAGE, *PQEDIMAGE;
221
222/**
223 * State of the async cluster allocation.
224 */
225typedef enum QEDCLUSTERASYNCALLOCSTATE
226{
227 /** Invalid. */
228 QEDCLUSTERASYNCALLOCSTATE_INVALID = 0,
229 /** L2 table allocation. */
230 QEDCLUSTERASYNCALLOCSTATE_L2_ALLOC,
231 /** Link L2 table into L1. */
232 QEDCLUSTERASYNCALLOCSTATE_L2_LINK,
233 /** Allocate user data cluster. */
234 QEDCLUSTERASYNCALLOCSTATE_USER_ALLOC,
235 /** Link user data cluster. */
236 QEDCLUSTERASYNCALLOCSTATE_USER_LINK,
237 /** 32bit blowup. */
238 QEDCLUSTERASYNCALLOCSTATE_32BIT_HACK = 0x7fffffff
239} QEDCLUSTERASYNCALLOCSTATE, *PQEDCLUSTERASYNCALLOCSTATE;
240
241/**
242 * Data needed to track async cluster allocation.
243 */
244typedef struct QEDCLUSTERASYNCALLOC
245{
246 /** The state of the cluster allocation. */
247 QEDCLUSTERASYNCALLOCSTATE enmAllocState;
248 /** Old image size to rollback in case of an error. */
249 uint64_t cbImageOld;
250 /** L1 index to link if any. */
251 uint32_t idxL1;
252 /** L2 index to link, required in any case. */
253 uint32_t idxL2;
254 /** Start offset of the allocated cluster. */
255 uint64_t offClusterNew;
256 /** L2 cache entry if a L2 table is allocated. */
257 PQEDL2CACHEENTRY pL2Entry;
258 /** Number of bytes to write. */
259 size_t cbToWrite;
260} QEDCLUSTERASYNCALLOC, *PQEDCLUSTERASYNCALLOC;
261
262
263/*********************************************************************************************************************************
264* Static Variables *
265*********************************************************************************************************************************/
266
267/** NULL-terminated array of supported file extensions. */
268static const VDFILEEXTENSION s_aQedFileExtensions[] =
269{
270 {"qed", VDTYPE_HDD},
271 {NULL, VDTYPE_INVALID}
272};
273
274
275/*********************************************************************************************************************************
276* Internal Functions *
277*********************************************************************************************************************************/
278
279/**
280 * Converts the image header to the host endianess and performs basic checks.
281 *
282 * @returns Whether the given header is valid or not.
283 * @param pHeader Pointer to the header to convert.
284 */
285static bool qedHdrConvertToHostEndianess(PQedHeader pHeader)
286{
287 pHeader->u32Magic = RT_LE2H_U32(pHeader->u32Magic);
288 pHeader->u32ClusterSize = RT_LE2H_U32(pHeader->u32ClusterSize);
289 pHeader->u32TableSize = RT_LE2H_U32(pHeader->u32TableSize);
290 pHeader->u32HeaderSize = RT_LE2H_U32(pHeader->u32HeaderSize);
291 pHeader->u64FeatureFlags = RT_LE2H_U64(pHeader->u64FeatureFlags);
292 pHeader->u64CompatFeatureFlags = RT_LE2H_U64(pHeader->u64CompatFeatureFlags);
293 pHeader->u64AutoresetFeatureFlags = RT_LE2H_U64(pHeader->u64AutoresetFeatureFlags);
294 pHeader->u64OffL1Table = RT_LE2H_U64(pHeader->u64OffL1Table);
295 pHeader->u64Size = RT_LE2H_U64(pHeader->u64Size);
296 pHeader->u32OffBackingFilename = RT_LE2H_U32(pHeader->u32OffBackingFilename);
297 pHeader->u32BackingFilenameSize = RT_LE2H_U32(pHeader->u32BackingFilenameSize);
298
299 if (RT_UNLIKELY(pHeader->u32Magic != QED_MAGIC))
300 return false;
301 if (RT_UNLIKELY( pHeader->u32ClusterSize < QED_CLUSTER_SIZE_MIN
302 || pHeader->u32ClusterSize > QED_CLUSTER_SIZE_MAX))
303 return false;
304 if (RT_UNLIKELY( pHeader->u32TableSize < QED_TABLE_SIZE_MIN
305 || pHeader->u32TableSize > QED_TABLE_SIZE_MAX))
306 return false;
307 if (RT_UNLIKELY(pHeader->u64Size % 512 != 0))
308 return false;
309 if (RT_UNLIKELY( pHeader->u64FeatureFlags & QED_FEATURE_BACKING_FILE
310 && ( pHeader->u32BackingFilenameSize == 0
311 || pHeader->u32BackingFilenameSize == UINT32_MAX)))
312 return false;
313
314 return true;
315}
316
317/**
318 * Creates a QED header from the given image state.
319 *
320 * @returns nothing.
321 * @param pImage Image instance data.
322 * @param pHeader Pointer to the header to convert.
323 */
324static void qedHdrConvertFromHostEndianess(PQEDIMAGE pImage, PQedHeader pHeader)
325{
326 pHeader->u32Magic = RT_H2LE_U32(QED_MAGIC);
327 pHeader->u32ClusterSize = RT_H2LE_U32(pImage->cbCluster);
328 pHeader->u32TableSize = RT_H2LE_U32(pImage->cbTable / pImage->cbCluster);
329 pHeader->u32HeaderSize = RT_H2LE_U32(1);
330 pHeader->u64FeatureFlags = RT_H2LE_U64(pImage->pszBackingFilename ? QED_FEATURE_BACKING_FILE : UINT64_C(0));
331 pHeader->u64CompatFeatureFlags = RT_H2LE_U64(UINT64_C(0));
332 pHeader->u64AutoresetFeatureFlags = RT_H2LE_U64(UINT64_C(0));
333 pHeader->u64OffL1Table = RT_H2LE_U64(pImage->offL1Table);
334 pHeader->u64Size = RT_H2LE_U64(pImage->cbSize);
335 pHeader->u32OffBackingFilename = RT_H2LE_U32(pImage->offBackingFilename);
336 pHeader->u32BackingFilenameSize = RT_H2LE_U32(pImage->cbBackingFilename);
337}
338
339/**
340 * Convert table entries from little endian to host endianess.
341 *
342 * @returns nothing.
343 * @param paTbl Pointer to the table.
344 * @param cEntries Number of entries in the table.
345 */
346static void qedTableConvertToHostEndianess(uint64_t *paTbl, uint32_t cEntries)
347{
348 while(cEntries-- > 0)
349 {
350 *paTbl = RT_LE2H_U64(*paTbl);
351 paTbl++;
352 }
353}
354
355#if defined(RT_BIG_ENDIAN)
356/**
357 * Convert table entries from host to little endian format.
358 *
359 * @returns nothing.
360 * @param paTblImg Pointer to the table which will store the little endian table.
361 * @param paTbl The source table to convert.
362 * @param cEntries Number of entries in the table.
363 */
364static void qedTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t *paTbl,
365 uint32_t cEntries)
366{
367 while(cEntries-- > 0)
368 {
369 *paTblImg = RT_H2LE_U64(*paTbl);
370 paTbl++;
371 paTblImg++;
372 }
373}
374#endif
375
376/**
377 * Creates the L2 table cache.
378 *
379 * @returns VBox status code.
380 * @param pImage The image instance data.
381 */
382static int qedL2TblCacheCreate(PQEDIMAGE pImage)
383{
384 pImage->cbL2Cache = 0;
385 RTListInit(&pImage->ListSearch);
386 RTListInit(&pImage->ListLru);
387
388 return VINF_SUCCESS;
389}
390
391/**
392 * Destroys the L2 table cache.
393 *
394 * @returns nothing.
395 * @param pImage The image instance data.
396 */
397static void qedL2TblCacheDestroy(PQEDIMAGE pImage)
398{
399 PQEDL2CACHEENTRY pL2Entry;
400 PQEDL2CACHEENTRY pL2Next;
401 RTListForEachSafe(&pImage->ListSearch, pL2Entry, pL2Next, QEDL2CACHEENTRY, NodeSearch)
402 {
403 Assert(!pL2Entry->cRefs);
404
405 RTListNodeRemove(&pL2Entry->NodeSearch);
406 RTMemPageFree(pL2Entry->paL2Tbl, pImage->cbTable);
407 RTMemFree(pL2Entry);
408 }
409
410 pImage->cbL2Cache = 0;
411 RTListInit(&pImage->ListSearch);
412 RTListInit(&pImage->ListLru);
413}
414
415/**
416 * Returns the L2 table matching the given offset or NULL if none could be found.
417 *
418 * @returns Pointer to the L2 table cache entry or NULL.
419 * @param pImage The image instance data.
420 * @param offL2Tbl Offset of the L2 table to search for.
421 */
422static PQEDL2CACHEENTRY qedL2TblCacheRetain(PQEDIMAGE pImage, uint64_t offL2Tbl)
423{
424 if ( pImage->pL2TblAlloc
425 && pImage->pL2TblAlloc->offL2Tbl == offL2Tbl)
426 {
427 pImage->pL2TblAlloc->cRefs++;
428 return pImage->pL2TblAlloc;
429 }
430
431 PQEDL2CACHEENTRY pL2Entry;
432 RTListForEach(&pImage->ListSearch, pL2Entry, QEDL2CACHEENTRY, NodeSearch)
433 {
434 if (pL2Entry->offL2Tbl == offL2Tbl)
435 break;
436 }
437
438 if (!RTListNodeIsDummy(&pImage->ListSearch, pL2Entry, QEDL2CACHEENTRY, NodeSearch))
439 {
440 /* Update LRU list. */
441 RTListNodeRemove(&pL2Entry->NodeLru);
442 RTListPrepend(&pImage->ListLru, &pL2Entry->NodeLru);
443 pL2Entry->cRefs++;
444 return pL2Entry;
445 }
446 else
447 return NULL;
448}
449
450/**
451 * Releases a L2 table cache entry.
452 *
453 * @returns nothing.
454 * @param pL2Entry The L2 cache entry.
455 */
456static void qedL2TblCacheEntryRelease(PQEDL2CACHEENTRY pL2Entry)
457{
458 Assert(pL2Entry->cRefs > 0);
459 pL2Entry->cRefs--;
460}
461
462/**
463 * Allocates a new L2 table from the cache evicting old entries if required.
464 *
465 * @returns Pointer to the L2 cache entry or NULL.
466 * @param pImage The image instance data.
467 */
468static PQEDL2CACHEENTRY qedL2TblCacheEntryAlloc(PQEDIMAGE pImage)
469{
470 PQEDL2CACHEENTRY pL2Entry = NULL;
471
472 if (pImage->cbL2Cache + pImage->cbTable <= QED_L2_CACHE_MEMORY_MAX)
473 {
474 /* Add a new entry. */
475 pL2Entry = (PQEDL2CACHEENTRY)RTMemAllocZ(sizeof(QEDL2CACHEENTRY));
476 if (pL2Entry)
477 {
478 pL2Entry->paL2Tbl = (uint64_t *)RTMemPageAllocZ(pImage->cbTable);
479 if (RT_UNLIKELY(!pL2Entry->paL2Tbl))
480 {
481 RTMemFree(pL2Entry);
482 pL2Entry = NULL;
483 }
484 else
485 {
486 pL2Entry->cRefs = 1;
487 pImage->cbL2Cache += pImage->cbTable;
488 }
489 }
490 }
491 else
492 {
493 /* Evict the last not in use entry and use it */
494 Assert(!RTListIsEmpty(&pImage->ListLru));
495
496 RTListForEachReverse(&pImage->ListLru, pL2Entry, QEDL2CACHEENTRY, NodeLru)
497 {
498 if (!pL2Entry->cRefs)
499 break;
500 }
501
502 if (!RTListNodeIsDummy(&pImage->ListSearch, pL2Entry, QEDL2CACHEENTRY, NodeSearch))
503 {
504 RTListNodeRemove(&pL2Entry->NodeSearch);
505 RTListNodeRemove(&pL2Entry->NodeLru);
506 pL2Entry->offL2Tbl = 0;
507 pL2Entry->cRefs = 1;
508 }
509 else
510 pL2Entry = NULL;
511 }
512
513 return pL2Entry;
514}
515
516/**
517 * Frees a L2 table cache entry.
518 *
519 * @returns nothing.
520 * @param pImage The image instance data.
521 * @param pL2Entry The L2 cache entry to free.
522 */
523static void qedL2TblCacheEntryFree(PQEDIMAGE pImage, PQEDL2CACHEENTRY pL2Entry)
524{
525 Assert(!pL2Entry->cRefs);
526 RTMemPageFree(pL2Entry->paL2Tbl, pImage->cbTable);
527 RTMemFree(pL2Entry);
528
529 pImage->cbL2Cache -= pImage->cbTable;
530}
531
532/**
533 * Inserts an entry in the L2 table cache.
534 *
535 * @returns nothing.
536 * @param pImage The image instance data.
537 * @param pL2Entry The L2 cache entry to insert.
538 */
539static void qedL2TblCacheEntryInsert(PQEDIMAGE pImage, PQEDL2CACHEENTRY pL2Entry)
540{
541 Assert(pL2Entry->offL2Tbl > 0);
542
543 /* Insert at the top of the LRU list. */
544 RTListPrepend(&pImage->ListLru, &pL2Entry->NodeLru);
545
546 if (RTListIsEmpty(&pImage->ListSearch))
547 {
548 RTListAppend(&pImage->ListSearch, &pL2Entry->NodeSearch);
549 }
550 else
551 {
552 /* Insert into search list. */
553 PQEDL2CACHEENTRY pIt;
554 pIt = RTListGetFirst(&pImage->ListSearch, QEDL2CACHEENTRY, NodeSearch);
555 if (pIt->offL2Tbl > pL2Entry->offL2Tbl)
556 RTListPrepend(&pImage->ListSearch, &pL2Entry->NodeSearch);
557 else
558 {
559 bool fInserted = false;
560
561 RTListForEach(&pImage->ListSearch, pIt, QEDL2CACHEENTRY, NodeSearch)
562 {
563 Assert(pIt->offL2Tbl != pL2Entry->offL2Tbl);
564 if (pIt->offL2Tbl < pL2Entry->offL2Tbl)
565 {
566 RTListNodeInsertAfter(&pIt->NodeSearch, &pL2Entry->NodeSearch);
567 fInserted = true;
568 break;
569 }
570 }
571 Assert(fInserted);
572 }
573 }
574}
575
576/**
577 * Fetches the L2 from the given offset trying the LRU cache first and
578 * reading it from the image after a cache miss - version for async I/O.
579 *
580 * @returns VBox status code.
581 * @param pImage Image instance data.
582 * @param pIoCtx The I/O context.
583 * @param offL2Tbl The offset of the L2 table in the image.
584 * @param ppL2Entry Where to store the L2 table on success.
585 */
586static int qedL2TblCacheFetchAsync(PQEDIMAGE pImage, PVDIOCTX pIoCtx,
587 uint64_t offL2Tbl, PQEDL2CACHEENTRY *ppL2Entry)
588{
589 int rc = VINF_SUCCESS;
590
591 /* Try to fetch the L2 table from the cache first. */
592 PQEDL2CACHEENTRY pL2Entry = qedL2TblCacheRetain(pImage, offL2Tbl);
593 if (!pL2Entry)
594 {
595 pL2Entry = qedL2TblCacheEntryAlloc(pImage);
596
597 if (pL2Entry)
598 {
599 /* Read from the image. */
600 PVDMETAXFER pMetaXfer;
601
602 pL2Entry->offL2Tbl = offL2Tbl;
603 rc = vdIfIoIntFileReadMeta(pImage->pIfIo, pImage->pStorage,
604 offL2Tbl, pL2Entry->paL2Tbl,
605 pImage->cbTable, pIoCtx,
606 &pMetaXfer, NULL, NULL);
607 if (RT_SUCCESS(rc))
608 {
609 vdIfIoIntMetaXferRelease(pImage->pIfIo, pMetaXfer);
610#if defined(RT_BIG_ENDIAN)
611 qedTableConvertToHostEndianess(pL2Entry->paL2Tbl, pImage->cTableEntries);
612#endif
613 qedL2TblCacheEntryInsert(pImage, pL2Entry);
614 }
615 else
616 {
617 qedL2TblCacheEntryRelease(pL2Entry);
618 qedL2TblCacheEntryFree(pImage, pL2Entry);
619 }
620 }
621 else
622 rc = VERR_NO_MEMORY;
623 }
624
625 if (RT_SUCCESS(rc))
626 *ppL2Entry = pL2Entry;
627
628 return rc;
629}
630
631/**
632 * Return power of 2 or 0 if num error.
633 *
634 * @returns The power of 2 or 0 if the given number is not a power of 2.
635 * @param u32 The number.
636 */
637static uint32_t qedGetPowerOfTwo(uint32_t u32)
638{
639 if (u32 == 0)
640 return 0;
641 uint32_t uPower2 = 0;
642 while ((u32 & 1) == 0)
643 {
644 u32 >>= 1;
645 uPower2++;
646 }
647 return u32 == 1 ? uPower2 : 0;
648}
649
650/**
651 * Sets the L1, L2 and offset bitmasks and L1 and L2 bit shift members.
652 *
653 * @returns nothing.
654 * @param pImage The image instance data.
655 */
656static void qedTableMasksInit(PQEDIMAGE pImage)
657{
658 uint32_t cClusterBits, cTableBits;
659
660 cClusterBits = qedGetPowerOfTwo(pImage->cbCluster);
661 cTableBits = qedGetPowerOfTwo(pImage->cTableEntries);
662
663 Assert(cClusterBits + 2 * cTableBits <= 64);
664
665 pImage->fOffsetMask = ((uint64_t)pImage->cbCluster - 1);
666 pImage->fL2Mask = ((uint64_t)pImage->cTableEntries - 1) << cClusterBits;
667 pImage->cL2Shift = cClusterBits;
668 pImage->fL1Mask = ((uint64_t)pImage->cTableEntries - 1) << (cClusterBits + cTableBits);
669 pImage->cL1Shift = cClusterBits + cTableBits;
670}
671
672/**
673 * Converts a given logical offset into the
674 *
675 * @returns nothing.
676 * @param pImage The image instance data.
677 * @param off The logical offset to convert.
678 * @param pidxL1 Where to store the index in the L1 table on success.
679 * @param pidxL2 Where to store the index in the L2 table on success.
680 * @param poffCluster Where to store the offset in the cluster on success.
681 */
682DECLINLINE(void) qedConvertLogicalOffset(PQEDIMAGE pImage, uint64_t off, uint32_t *pidxL1,
683 uint32_t *pidxL2, uint32_t *poffCluster)
684{
685 AssertPtr(pidxL1);
686 AssertPtr(pidxL2);
687 AssertPtr(poffCluster);
688
689 *poffCluster = off & pImage->fOffsetMask;
690 *pidxL1 = (off & pImage->fL1Mask) >> pImage->cL1Shift;
691 *pidxL2 = (off & pImage->fL2Mask) >> pImage->cL2Shift;
692}
693
694/**
695 * Converts Cluster size to a byte size.
696 *
697 * @returns Number of bytes derived from the given number of clusters.
698 * @param pImage The image instance data.
699 * @param cClusters The clusters to convert.
700 */
701DECLINLINE(uint64_t) qedCluster2Byte(PQEDIMAGE pImage, uint64_t cClusters)
702{
703 return cClusters * pImage->cbCluster;
704}
705
706/**
707 * Converts number of bytes to cluster size rounding to the next cluster.
708 *
709 * @returns Number of bytes derived from the given number of clusters.
710 * @param pImage The image instance data.
711 * @param cb Number of bytes to convert.
712 */
713DECLINLINE(uint64_t) qedByte2Cluster(PQEDIMAGE pImage, uint64_t cb)
714{
715 return cb / pImage->cbCluster + (cb % pImage->cbCluster ? 1 : 0);
716}
717
718/**
719 * Allocates a new cluster in the image.
720 *
721 * @returns The start offset of the new cluster in the image.
722 * @param pImage The image instance data.
723 * @param cClusters Number of clusters to allocate.
724 */
725DECLINLINE(uint64_t) qedClusterAllocate(PQEDIMAGE pImage, uint32_t cClusters)
726{
727 uint64_t offCluster;
728
729 offCluster = pImage->cbImage;
730 pImage->cbImage += cClusters*pImage->cbCluster;
731
732 return offCluster;
733}
734
735/**
736 * Returns the real image offset for a given cluster or an error if the cluster is not
737 * yet allocated.
738 *
739 * @returns VBox status code.
740 * VERR_VD_BLOCK_FREE if the cluster is not yet allocated.
741 * @param pImage The image instance data.
742 * @param pIoCtx The I/O context.
743 * @param idxL1 The L1 index.
744 * @param idxL2 The L2 index.
745 * @param offCluster Offset inside the cluster.
746 * @param poffImage Where to store the image offset on success;
747 */
748static int qedConvertToImageOffset(PQEDIMAGE pImage, PVDIOCTX pIoCtx,
749 uint32_t idxL1, uint32_t idxL2,
750 uint32_t offCluster, uint64_t *poffImage)
751{
752 int rc = VERR_VD_BLOCK_FREE;
753
754 AssertReturn(idxL1 < pImage->cTableEntries, VERR_INVALID_PARAMETER);
755 AssertReturn(idxL2 < pImage->cTableEntries, VERR_INVALID_PARAMETER);
756
757 if (pImage->paL1Table[idxL1])
758 {
759 PQEDL2CACHEENTRY pL2Entry;
760
761 rc = qedL2TblCacheFetchAsync(pImage, pIoCtx, pImage->paL1Table[idxL1],
762 &pL2Entry);
763 if (RT_SUCCESS(rc))
764 {
765 /* Get real file offset. */
766 if (pL2Entry->paL2Tbl[idxL2])
767 *poffImage = pL2Entry->paL2Tbl[idxL2] + offCluster;
768 else
769 rc = VERR_VD_BLOCK_FREE;
770
771 qedL2TblCacheEntryRelease(pL2Entry);
772 }
773 }
774
775 return rc;
776}
777
778/**
779 * Write the given table to image converting to the image endianess if required.
780 *
781 * @returns VBox status code.
782 * @param pImage The image instance data.
783 * @param pIoCtx The I/O context.
784 * @param offTbl The offset the table should be written to.
785 * @param paTbl The table to write.
786 * @param pfnComplete Callback called when the write completes.
787 * @param pvUser Opaque user data to pass in the completion callback.
788 */
789static int qedTblWrite(PQEDIMAGE pImage, PVDIOCTX pIoCtx, uint64_t offTbl, uint64_t *paTbl,
790 PFNVDXFERCOMPLETED pfnComplete, void *pvUser)
791{
792 int rc = VINF_SUCCESS;
793
794#if defined(RT_BIG_ENDIAN)
795 uint64_t *paTblImg = (uint64_t *)RTMemAllocZ(pImage->cbTable);
796 if (paTblImg)
797 {
798 qedTableConvertFromHostEndianess(paTblImg, paTbl,
799 pImage->cTableEntries);
800 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
801 offTbl, paTblImg, pImage->cbTable,
802 pIoCtx, pfnComplete, pvUser);
803 RTMemFree(paTblImg);
804 }
805 else
806 rc = VERR_NO_MEMORY;
807#else
808 /* Write table directly. */
809 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
810 offTbl, paTbl, pImage->cbTable, pIoCtx,
811 pfnComplete, pvUser);
812#endif
813
814 return rc;
815}
816
817/**
818 * Internal. Flush image data to disk.
819 */
820static int qedFlushImage(PQEDIMAGE pImage)
821{
822 int rc = VINF_SUCCESS;
823
824 if ( pImage->pStorage
825 && !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
826 {
827 QedHeader Header;
828
829 Assert(!(pImage->cbTable % pImage->cbCluster));
830#if defined(RT_BIG_ENDIAN)
831 uint64_t *paL1TblImg = (uint64_t *)RTMemAllocZ(pImage->cbTable);
832 if (paL1TblImg)
833 {
834 qedTableConvertFromHostEndianess(paL1TblImg, pImage->paL1Table,
835 pImage->cTableEntries);
836 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
837 pImage->offL1Table, paL1TblImg,
838 pImage->cbTable);
839 RTMemFree(paL1TblImg);
840 }
841 else
842 rc = VERR_NO_MEMORY;
843#else
844 /* Write L1 table directly. */
845 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, pImage->offL1Table,
846 pImage->paL1Table, pImage->cbTable);
847#endif
848 if (RT_SUCCESS(rc))
849 {
850 /* Write header. */
851 qedHdrConvertFromHostEndianess(pImage, &Header);
852 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage, 0, &Header,
853 sizeof(Header));
854 if (RT_SUCCESS(rc))
855 rc = vdIfIoIntFileFlushSync(pImage->pIfIo, pImage->pStorage);
856 }
857 }
858
859 return rc;
860}
861
862/**
863 * Checks whether the given cluster offset is valid.
864 *
865 * @returns Whether the given cluster offset is valid.
866 * @param offCluster The table offset to check.
867 * @param cbFile The real file size of the image.
868 * @param cbCluster The cluster size in bytes.
869 */
870DECLINLINE(bool) qedIsClusterOffsetValid(uint64_t offCluster, uint64_t cbFile, size_t cbCluster)
871{
872 return (offCluster <= cbFile - cbCluster)
873 && !(offCluster & (cbCluster - 1));
874}
875
876/**
877 * Checks whether the given table offset is valid.
878 *
879 * @returns Whether the given table offset is valid.
880 * @param offTbl The table offset to check.
881 * @param cbFile The real file size of the image.
882 * @param cbTable The table size in bytes.
883 * @param cbCluster The cluster size in bytes.
884 */
885DECLINLINE(bool) qedIsTblOffsetValid(uint64_t offTbl, uint64_t cbFile, size_t cbTable, size_t cbCluster)
886{
887 return (offTbl <= cbFile - cbTable)
888 && !(offTbl & (cbCluster - 1));
889}
890
891/**
892 * Sets the specified range in the cluster bitmap checking whether any of the clusters is already
893 * used before.
894 *
895 * @returns Whether the range was clear and is set now.
896 * @param pvClusterBitmap The cluster bitmap to use.
897 * @param offClusterStart The first cluster to check and set.
898 * @param offClusterEnd The first cluster to not check and set anymore.
899 */
900static bool qedClusterBitmapCheckAndSet(void *pvClusterBitmap, uint32_t offClusterStart, uint32_t offClusterEnd)
901{
902 for (uint32_t offCluster = offClusterStart; offCluster < offClusterEnd; offCluster++)
903 if (ASMBitTest(pvClusterBitmap, offCluster))
904 return false;
905
906 ASMBitSetRange(pvClusterBitmap, offClusterStart, offClusterEnd);
907 return true;
908}
909
910/**
911 * Checks the given image for consistency, usually called when the
912 * QED_FEATURE_NEED_CHECK bit is set.
913 *
914 * @returns VBox status code.
915 * @retval VINF_SUCCESS when the image can be accessed.
916 * @param pImage The image instance data.
917 * @param pHeader The header to use for checking.
918 *
919 * @note It is not required that the image state is fully initialized Only
920 * The I/O interface and storage handle need to be valid.
921 * @note The header must be converted to the host CPU endian format already
922 * and should be validated already.
923 */
924static int qedCheckImage(PQEDIMAGE pImage, PQedHeader pHeader)
925{
926 uint64_t cbFile;
927 uint32_t cbTable;
928 uint32_t cTableEntries;
929 uint64_t *paL1Tbl = NULL;
930 uint64_t *paL2Tbl = NULL;
931 void *pvClusterBitmap = NULL;
932 uint32_t offClusterStart;
933 int rc = VINF_SUCCESS;
934
935 pImage->cbCluster = pHeader->u32ClusterSize;
936 cbTable = pHeader->u32TableSize * pHeader->u32ClusterSize;
937 cTableEntries = cbTable / sizeof(uint64_t);
938
939 do
940 {
941 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
942 if (RT_FAILURE(rc))
943 {
944 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
945 N_("Qed: Querying the file size of image '%s' failed"),
946 pImage->pszFilename);
947 break;
948 }
949
950 /* Allocate L1 table. */
951 paL1Tbl = (uint64_t *)RTMemAllocZ(cbTable);
952 if (!paL1Tbl)
953 {
954 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
955 N_("Qed: Allocating memory for the L1 table for image '%s' failed"),
956 pImage->pszFilename);
957 break;
958 }
959
960 paL2Tbl = (uint64_t *)RTMemAllocZ(cbTable);
961 if (!paL2Tbl)
962 {
963 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
964 N_("Qed: Allocating memory for the L2 table for image '%s' failed"),
965 pImage->pszFilename);
966 break;
967 }
968
969 pvClusterBitmap = RTMemAllocZ(cbFile / pHeader->u32ClusterSize / 8);
970 if (!pvClusterBitmap)
971 {
972 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
973 N_("Qed: Allocating memory for the cluster bitmap for image '%s' failed"),
974 pImage->pszFilename);
975 break;
976 }
977
978 /* Validate L1 table offset. */
979 if (!qedIsTblOffsetValid(pHeader->u64OffL1Table, cbFile, cbTable, pHeader->u32ClusterSize))
980 {
981 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
982 N_("Qed: L1 table offset of image '%s' is corrupt (%llu)"),
983 pImage->pszFilename, pHeader->u64OffL1Table);
984 break;
985 }
986
987 /* Read L1 table. */
988 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
989 pHeader->u64OffL1Table, paL1Tbl, cbTable);
990 if (RT_FAILURE(rc))
991 {
992 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
993 N_("Qed: Reading the L1 table from image '%s' failed"),
994 pImage->pszFilename);
995 break;
996 }
997
998 /* Mark the L1 table in cluster bitmap. */
999 ASMBitSet(pvClusterBitmap, 0); /* Header is always in cluster 0. */
1000 offClusterStart = qedByte2Cluster(pImage, pHeader->u64OffL1Table);
1001 bool fSet = qedClusterBitmapCheckAndSet(pvClusterBitmap, offClusterStart, offClusterStart + pHeader->u32TableSize);
1002 Assert(fSet);
1003
1004 /* Scan the L1 and L2 tables for invalid entries. */
1005 qedTableConvertToHostEndianess(paL1Tbl, cTableEntries);
1006
1007 for (unsigned iL1 = 0; iL1 < cTableEntries; iL1++)
1008 {
1009 if (!paL1Tbl[iL1])
1010 continue; /* Skip unallocated clusters. */
1011
1012 if (!qedIsTblOffsetValid(paL1Tbl[iL1], cbFile, cbTable, pHeader->u32ClusterSize))
1013 {
1014 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1015 N_("Qed: Entry %d of the L1 table from image '%s' is invalid (%llu)"),
1016 iL1, pImage->pszFilename, paL1Tbl[iL1]);
1017 break;
1018 }
1019
1020 /* Now check that the clusters are not allocated already. */
1021 offClusterStart = qedByte2Cluster(pImage, paL1Tbl[iL1]);
1022 fSet = qedClusterBitmapCheckAndSet(pvClusterBitmap, offClusterStart, offClusterStart + pHeader->u32TableSize);
1023 if (!fSet)
1024 {
1025 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1026 N_("Qed: Entry %d of the L1 table from image '%s' points to a already used cluster (%llu)"),
1027 iL1, pImage->pszFilename, paL1Tbl[iL1]);
1028 break;
1029 }
1030
1031 /* Read the linked L2 table and check it. */
1032 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
1033 paL1Tbl[iL1], paL2Tbl, cbTable);
1034 if (RT_FAILURE(rc))
1035 {
1036 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1037 N_("Qed: Reading the L2 table from image '%s' failed"),
1038 pImage->pszFilename);
1039 break;
1040 }
1041
1042 /* Check all L2 entries. */
1043 for (unsigned iL2 = 0; iL2 < cTableEntries; iL2++)
1044 {
1045 if (paL2Tbl[iL2])
1046 continue; /* Skip unallocated clusters. */
1047
1048 if (!qedIsClusterOffsetValid(paL2Tbl[iL2], cbFile, pHeader->u32ClusterSize))
1049 {
1050 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1051 N_("Qed: Entry %d of the L2 table from image '%s' is invalid (%llu)"),
1052 iL2, pImage->pszFilename, paL2Tbl[iL2]);
1053 break;
1054 }
1055
1056 /* Now check that the clusters are not allocated already. */
1057 offClusterStart = qedByte2Cluster(pImage, paL2Tbl[iL2]);
1058 fSet = qedClusterBitmapCheckAndSet(pvClusterBitmap, offClusterStart, offClusterStart + 1);
1059 if (!fSet)
1060 {
1061 rc = vdIfError(pImage->pIfError, VERR_VD_GEN_INVALID_HEADER, RT_SRC_POS,
1062 N_("Qed: Entry %d of the L2 table from image '%s' points to a already used cluster (%llu)"),
1063 iL2, pImage->pszFilename, paL2Tbl[iL2]);
1064 break;
1065 }
1066 }
1067 }
1068 } while(0);
1069
1070 if (paL1Tbl)
1071 RTMemFree(paL1Tbl);
1072 if (paL2Tbl)
1073 RTMemFree(paL2Tbl);
1074 if (pvClusterBitmap)
1075 RTMemFree(pvClusterBitmap);
1076
1077 return rc;
1078}
1079
1080/**
1081 * Internal. Free all allocated space for representing an image except pImage,
1082 * and optionally delete the image from disk.
1083 */
1084static int qedFreeImage(PQEDIMAGE pImage, bool fDelete)
1085{
1086 int rc = VINF_SUCCESS;
1087
1088 /* Freeing a never allocated image (e.g. because the open failed) is
1089 * not signalled as an error. After all nothing bad happens. */
1090 if (pImage)
1091 {
1092 if (pImage->pStorage)
1093 {
1094 /* No point updating the file that is deleted anyway. */
1095 if (!fDelete)
1096 qedFlushImage(pImage);
1097
1098 rc = vdIfIoIntFileClose(pImage->pIfIo, pImage->pStorage);
1099 pImage->pStorage = NULL;
1100 }
1101
1102 if (pImage->paL1Table)
1103 RTMemFree(pImage->paL1Table);
1104
1105 if (pImage->pszBackingFilename)
1106 {
1107 RTMemFree(pImage->pszBackingFilename);
1108 pImage->pszBackingFilename = NULL;
1109 }
1110
1111 qedL2TblCacheDestroy(pImage);
1112
1113 if (fDelete && pImage->pszFilename)
1114 vdIfIoIntFileDelete(pImage->pIfIo, pImage->pszFilename);
1115 }
1116
1117 LogFlowFunc(("returns %Rrc\n", rc));
1118 return rc;
1119}
1120
1121/**
1122 * Internal: Open an image, constructing all necessary data structures.
1123 */
1124static int qedOpenImage(PQEDIMAGE pImage, unsigned uOpenFlags)
1125{
1126 pImage->uOpenFlags = uOpenFlags;
1127
1128 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
1129 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
1130 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
1131
1132 /*
1133 * Create the L2 cache before opening the image so we can call qedFreeImage()
1134 * even if opening the image file fails.
1135 */
1136 int rc = qedL2TblCacheCreate(pImage);
1137 if (RT_SUCCESS(rc))
1138 {
1139 /* Open the image. */
1140 rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename,
1141 VDOpenFlagsToFileOpenFlags(uOpenFlags,
1142 false /* fCreate */),
1143 &pImage->pStorage);
1144 if (RT_SUCCESS(rc))
1145 {
1146 uint64_t cbFile;
1147 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
1148 if ( RT_SUCCESS(rc)
1149 && cbFile > sizeof(QedHeader))
1150 {
1151 QedHeader Header;
1152
1153 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage, 0, &Header, sizeof(Header));
1154 if ( RT_SUCCESS(rc)
1155 && qedHdrConvertToHostEndianess(&Header))
1156 {
1157 if ( !(Header.u64FeatureFlags & ~QED_FEATURE_MASK)
1158 && !(Header.u64FeatureFlags & QED_FEATURE_BACKING_FILE_NO_PROBE))
1159 {
1160 if (Header.u64FeatureFlags & QED_FEATURE_NEED_CHECK)
1161 {
1162 /* Image needs checking. */
1163 if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
1164 rc = qedCheckImage(pImage, &Header);
1165 else
1166 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1167 N_("Qed: Image '%s' needs checking but is opened readonly"),
1168 pImage->pszFilename);
1169 }
1170
1171 if ( RT_SUCCESS(rc)
1172 && (Header.u64FeatureFlags & QED_FEATURE_BACKING_FILE))
1173 {
1174 /* Load backing filename from image. */
1175 pImage->pszBackingFilename = (char *)RTMemAllocZ(Header.u32BackingFilenameSize + 1); /* +1 for \0 terminator. */
1176 if (pImage->pszBackingFilename)
1177 {
1178 pImage->cbBackingFilename = Header.u32BackingFilenameSize;
1179 pImage->offBackingFilename = Header.u32OffBackingFilename;
1180 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
1181 Header.u32OffBackingFilename, pImage->pszBackingFilename,
1182 Header.u32BackingFilenameSize);
1183 }
1184 else
1185 rc = VERR_NO_MEMORY;
1186 }
1187
1188 if (RT_SUCCESS(rc))
1189 {
1190 pImage->cbImage = cbFile;
1191 pImage->cbCluster = Header.u32ClusterSize;
1192 pImage->cbTable = Header.u32TableSize * pImage->cbCluster;
1193 pImage->cTableEntries = pImage->cbTable / sizeof(uint64_t);
1194 pImage->offL1Table = Header.u64OffL1Table;
1195 pImage->cbSize = Header.u64Size;
1196 qedTableMasksInit(pImage);
1197
1198 /* Allocate L1 table. */
1199 pImage->paL1Table = (uint64_t *)RTMemAllocZ(pImage->cbTable);
1200 if (pImage->paL1Table)
1201 {
1202 /* Read from the image. */
1203 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pImage->pStorage,
1204 pImage->offL1Table, pImage->paL1Table,
1205 pImage->cbTable);
1206 if (RT_SUCCESS(rc))
1207 {
1208 qedTableConvertToHostEndianess(pImage->paL1Table, pImage->cTableEntries);
1209
1210 /* If the consistency check succeeded, clear the flag by flushing the image. */
1211 if (Header.u64FeatureFlags & QED_FEATURE_NEED_CHECK)
1212 rc = qedFlushImage(pImage);
1213 }
1214 else
1215 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1216 N_("Qed: Reading the L1 table for image '%s' failed"),
1217 pImage->pszFilename);
1218 }
1219 else
1220 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS,
1221 N_("Qed: Out of memory allocating L1 table for image '%s'"),
1222 pImage->pszFilename);
1223 }
1224 }
1225 else
1226 rc = vdIfError(pImage->pIfError, VERR_NOT_SUPPORTED, RT_SRC_POS,
1227 N_("Qed: The image '%s' makes use of unsupported features"),
1228 pImage->pszFilename);
1229 }
1230 else if (RT_SUCCESS(rc))
1231 rc = VERR_VD_GEN_INVALID_HEADER;
1232 }
1233 else if (RT_SUCCESS(rc))
1234 rc = VERR_VD_GEN_INVALID_HEADER;
1235 }
1236 /* else: Do NOT signal an appropriate error here, as the VD layer has the
1237 * choice of retrying the open if it failed. */
1238 }
1239 else
1240 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1241 N_("Qed: Creating the L2 table cache for image '%s' failed"),
1242 pImage->pszFilename);
1243
1244 if (RT_FAILURE(rc))
1245 qedFreeImage(pImage, false);
1246 return rc;
1247}
1248
1249/**
1250 * Internal: Create a qed image.
1251 */
1252static int qedCreateImage(PQEDIMAGE pImage, uint64_t cbSize,
1253 unsigned uImageFlags, const char *pszComment,
1254 PCVDGEOMETRY pPCHSGeometry,
1255 PCVDGEOMETRY pLCHSGeometry, unsigned uOpenFlags,
1256 PVDINTERFACEPROGRESS pIfProgress,
1257 unsigned uPercentStart, unsigned uPercentSpan)
1258{
1259 RT_NOREF1(pszComment);
1260 int rc;
1261
1262 if (!(uImageFlags & VD_IMAGE_FLAGS_FIXED))
1263 {
1264 rc = qedL2TblCacheCreate(pImage);
1265 if (RT_SUCCESS(rc))
1266 {
1267 pImage->uOpenFlags = uOpenFlags & ~VD_OPEN_FLAGS_READONLY;
1268 pImage->uImageFlags = uImageFlags;
1269 pImage->PCHSGeometry = *pPCHSGeometry;
1270 pImage->LCHSGeometry = *pLCHSGeometry;
1271
1272 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
1273 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
1274 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
1275
1276 /* Create image file. */
1277 uint32_t fOpen = VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags, true /* fCreate */);
1278 rc = vdIfIoIntFileOpen(pImage->pIfIo, pImage->pszFilename, fOpen, &pImage->pStorage);
1279 if (RT_SUCCESS(rc))
1280 {
1281 /* Init image state. */
1282 pImage->cbSize = cbSize;
1283 pImage->cbCluster = QED_CLUSTER_SIZE_DEFAULT;
1284 pImage->cbTable = qedCluster2Byte(pImage, QED_TABLE_SIZE_DEFAULT);
1285 pImage->cTableEntries = pImage->cbTable / sizeof(uint64_t);
1286 pImage->offL1Table = qedCluster2Byte(pImage, 1); /* Cluster 0 is the header. */
1287 pImage->cbImage = (1 * pImage->cbCluster) + pImage->cbTable; /* Header + L1 table size. */
1288 pImage->cbBackingFilename = 0;
1289 pImage->offBackingFilename = 0;
1290 qedTableMasksInit(pImage);
1291
1292 /* Init L1 table. */
1293 pImage->paL1Table = (uint64_t *)RTMemAllocZ(pImage->cbTable);
1294 if (RT_LIKELY(pImage->paL1Table))
1295 {
1296 vdIfProgress(pIfProgress, uPercentStart + uPercentSpan * 98 / 100);
1297 rc = qedFlushImage(pImage);
1298 }
1299 else
1300 rc = vdIfError(pImage->pIfError, VERR_NO_MEMORY, RT_SRC_POS, N_("Qed: cannot allocate memory for L1 table of image '%s'"),
1301 pImage->pszFilename);
1302 }
1303 else
1304 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("Qed: cannot create image '%s'"), pImage->pszFilename);
1305 }
1306 else
1307 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("Qed: Failed to create L2 cache for image '%s'"),
1308 pImage->pszFilename);
1309 }
1310 else
1311 rc = vdIfError(pImage->pIfError, VERR_VD_INVALID_TYPE, RT_SRC_POS, N_("Qed: cannot create fixed image '%s'"), pImage->pszFilename);
1312
1313 if (RT_SUCCESS(rc))
1314 vdIfProgress(pIfProgress, uPercentStart + uPercentSpan);
1315 else
1316 qedFreeImage(pImage, rc != VERR_ALREADY_EXISTS);
1317
1318 return rc;
1319}
1320
1321/**
1322 * Rollback anything done during async cluster allocation.
1323 *
1324 * @returns VBox status code.
1325 * @param pImage The image instance data.
1326 * @param pIoCtx The I/O context.
1327 * @param pClusterAlloc The cluster allocation to rollback.
1328 */
1329static int qedAsyncClusterAllocRollback(PQEDIMAGE pImage, PVDIOCTX pIoCtx, PQEDCLUSTERASYNCALLOC pClusterAlloc)
1330{
1331 RT_NOREF1(pIoCtx);
1332 int rc = VINF_SUCCESS;
1333
1334 switch (pClusterAlloc->enmAllocState)
1335 {
1336 case QEDCLUSTERASYNCALLOCSTATE_L2_ALLOC:
1337 case QEDCLUSTERASYNCALLOCSTATE_L2_LINK:
1338 {
1339 /* Revert the L1 table entry */
1340 pImage->paL1Table[pClusterAlloc->idxL1] = 0;
1341 pImage->pL2TblAlloc = NULL;
1342
1343 /* Assumption right now is that the L1 table is not modified on storage if the link fails. */
1344 rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage, pClusterAlloc->cbImageOld);
1345 qedL2TblCacheEntryRelease(pClusterAlloc->pL2Entry); /* Release L2 cache entry. */
1346 Assert(!pClusterAlloc->pL2Entry->cRefs);
1347 qedL2TblCacheEntryFree(pImage, pClusterAlloc->pL2Entry); /* Free it, it is not in the cache yet. */
1348 break;
1349 }
1350 case QEDCLUSTERASYNCALLOCSTATE_USER_ALLOC:
1351 case QEDCLUSTERASYNCALLOCSTATE_USER_LINK:
1352 {
1353 /* Assumption right now is that the L2 table is not modified if the link fails. */
1354 pClusterAlloc->pL2Entry->paL2Tbl[pClusterAlloc->idxL2] = 0;
1355 rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage, pClusterAlloc->cbImageOld);
1356 qedL2TblCacheEntryRelease(pClusterAlloc->pL2Entry); /* Release L2 cache entry. */
1357 break;
1358 }
1359 default:
1360 AssertMsgFailed(("Invalid cluster allocation state %d\n", pClusterAlloc->enmAllocState));
1361 rc = VERR_INVALID_STATE;
1362 }
1363
1364 RTMemFree(pClusterAlloc);
1365 return rc;
1366}
1367
1368/**
1369 * Updates the state of the async cluster allocation.
1370 *
1371 * @returns VBox status code.
1372 * @param pBackendData The opaque backend data.
1373 * @param pIoCtx I/O context associated with this request.
1374 * @param pvUser Opaque user data passed during a read/write request.
1375 * @param rcReq Status code for the completed request.
1376 */
1377static DECLCALLBACK(int) qedAsyncClusterAllocUpdate(void *pBackendData, PVDIOCTX pIoCtx, void *pvUser, int rcReq)
1378{
1379 int rc = VINF_SUCCESS;
1380 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1381 PQEDCLUSTERASYNCALLOC pClusterAlloc = (PQEDCLUSTERASYNCALLOC)pvUser;
1382
1383 if (RT_FAILURE(rcReq))
1384 return qedAsyncClusterAllocRollback(pImage, pIoCtx, pClusterAlloc);
1385
1386 AssertPtr(pClusterAlloc->pL2Entry);
1387
1388 switch (pClusterAlloc->enmAllocState)
1389 {
1390 case QEDCLUSTERASYNCALLOCSTATE_L2_ALLOC:
1391 {
1392 /* Update the link in the in memory L1 table now. */
1393 pImage->paL1Table[pClusterAlloc->idxL1] = pClusterAlloc->pL2Entry->offL2Tbl;
1394
1395 /* Update the link in the on disk L1 table now. */
1396 pClusterAlloc->enmAllocState = QEDCLUSTERASYNCALLOCSTATE_L2_LINK;
1397 rc = qedTblWrite(pImage, pIoCtx, pImage->offL1Table, pImage->paL1Table,
1398 qedAsyncClusterAllocUpdate, pClusterAlloc);
1399 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1400 break;
1401 else if (RT_FAILURE(rc))
1402 {
1403 /* Rollback. */
1404 qedAsyncClusterAllocRollback(pImage, pIoCtx, pClusterAlloc);
1405 break;
1406 }
1407 }
1408 /* fall thru */
1409 case QEDCLUSTERASYNCALLOCSTATE_L2_LINK:
1410 {
1411 /* L2 link updated in L1 , save L2 entry in cache and allocate new user data cluster. */
1412 uint64_t offData = qedClusterAllocate(pImage, 1);
1413
1414 pImage->pL2TblAlloc = NULL;
1415 qedL2TblCacheEntryInsert(pImage, pClusterAlloc->pL2Entry);
1416
1417 pClusterAlloc->enmAllocState = QEDCLUSTERASYNCALLOCSTATE_USER_ALLOC;
1418 pClusterAlloc->cbImageOld = offData;
1419 pClusterAlloc->offClusterNew = offData;
1420
1421 /* Write data. */
1422 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1423 offData, pIoCtx, pClusterAlloc->cbToWrite,
1424 qedAsyncClusterAllocUpdate, pClusterAlloc);
1425 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1426 break;
1427 else if (RT_FAILURE(rc))
1428 {
1429 qedAsyncClusterAllocRollback(pImage, pIoCtx, pClusterAlloc);
1430 RTMemFree(pClusterAlloc);
1431 break;
1432 }
1433 }
1434 /* fall thru */
1435 case QEDCLUSTERASYNCALLOCSTATE_USER_ALLOC:
1436 {
1437 pClusterAlloc->enmAllocState = QEDCLUSTERASYNCALLOCSTATE_USER_LINK;
1438 pClusterAlloc->pL2Entry->paL2Tbl[pClusterAlloc->idxL2] = pClusterAlloc->offClusterNew;
1439
1440 /* Link L2 table and update it. */
1441 rc = qedTblWrite(pImage, pIoCtx, pImage->paL1Table[pClusterAlloc->idxL1],
1442 pClusterAlloc->pL2Entry->paL2Tbl,
1443 qedAsyncClusterAllocUpdate, pClusterAlloc);
1444 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1445 break;
1446 else if (RT_FAILURE(rc))
1447 {
1448 qedAsyncClusterAllocRollback(pImage, pIoCtx, pClusterAlloc);
1449 RTMemFree(pClusterAlloc);
1450 break;
1451 }
1452 }
1453 /* fall thru */
1454 case QEDCLUSTERASYNCALLOCSTATE_USER_LINK:
1455 {
1456 /* Everything done without errors, signal completion. */
1457 qedL2TblCacheEntryRelease(pClusterAlloc->pL2Entry);
1458 RTMemFree(pClusterAlloc);
1459 rc = VINF_SUCCESS;
1460 break;
1461 }
1462 default:
1463 AssertMsgFailed(("Invalid async cluster allocation state %d\n",
1464 pClusterAlloc->enmAllocState));
1465 }
1466
1467 return rc;
1468}
1469
1470/** @copydoc VDIMAGEBACKEND::pfnProbe */
1471static DECLCALLBACK(int) qedProbe(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
1472 PVDINTERFACE pVDIfsImage, VDTYPE *penmType)
1473{
1474 RT_NOREF1(pVDIfsDisk);
1475 LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p\n", pszFilename, pVDIfsDisk, pVDIfsImage));
1476 PVDIOSTORAGE pStorage = NULL;
1477 int rc = VINF_SUCCESS;
1478
1479 /* Get I/O interface. */
1480 PVDINTERFACEIOINT pIfIo = VDIfIoIntGet(pVDIfsImage);
1481 AssertPtrReturn(pIfIo, VERR_INVALID_PARAMETER);
1482 AssertReturn((VALID_PTR(pszFilename) && *pszFilename), VERR_INVALID_PARAMETER);
1483
1484 /*
1485 * Open the file and read the footer.
1486 */
1487 rc = vdIfIoIntFileOpen(pIfIo, pszFilename,
1488 VDOpenFlagsToFileOpenFlags(VD_OPEN_FLAGS_READONLY,
1489 false /* fCreate */),
1490 &pStorage);
1491 if (RT_SUCCESS(rc))
1492 {
1493 uint64_t cbFile;
1494
1495 rc = vdIfIoIntFileGetSize(pIfIo, pStorage, &cbFile);
1496 if ( RT_SUCCESS(rc)
1497 && cbFile > sizeof(QedHeader))
1498 {
1499 QedHeader Header;
1500
1501 rc = vdIfIoIntFileReadSync(pIfIo, pStorage, 0, &Header, sizeof(Header));
1502 if ( RT_SUCCESS(rc)
1503 && qedHdrConvertToHostEndianess(&Header))
1504 *penmType = VDTYPE_HDD;
1505 else
1506 rc = VERR_VD_GEN_INVALID_HEADER;
1507 }
1508 else
1509 rc = VERR_VD_GEN_INVALID_HEADER;
1510 }
1511
1512 if (pStorage)
1513 vdIfIoIntFileClose(pIfIo, pStorage);
1514
1515 LogFlowFunc(("returns %Rrc\n", rc));
1516 return rc;
1517}
1518
1519/** @copydoc VDIMAGEBACKEND::pfnOpen */
1520static DECLCALLBACK(int) qedOpen(const char *pszFilename, unsigned uOpenFlags,
1521 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1522 VDTYPE enmType, void **ppBackendData)
1523{
1524 RT_NOREF1(enmType); /**< @todo r=klaus make use of the type info. */
1525
1526 LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p enmType=%u ppBackendData=%#p\n",
1527 pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, enmType, ppBackendData));
1528 int rc;
1529
1530 /* Check open flags. All valid flags are supported. */
1531 AssertReturn(!(uOpenFlags & ~VD_OPEN_FLAGS_MASK), VERR_INVALID_PARAMETER);
1532 AssertReturn((VALID_PTR(pszFilename) && *pszFilename), VERR_INVALID_PARAMETER);
1533
1534 PQEDIMAGE pImage = (PQEDIMAGE)RTMemAllocZ(sizeof(QEDIMAGE));
1535 if (RT_LIKELY(pImage))
1536 {
1537 pImage->pszFilename = pszFilename;
1538 pImage->pStorage = NULL;
1539 pImage->pVDIfsDisk = pVDIfsDisk;
1540 pImage->pVDIfsImage = pVDIfsImage;
1541
1542 rc = qedOpenImage(pImage, uOpenFlags);
1543 if (RT_SUCCESS(rc))
1544 *ppBackendData = pImage;
1545 else
1546 RTMemFree(pImage);
1547 }
1548 else
1549 rc = VERR_NO_MEMORY;
1550
1551 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1552 return rc;
1553}
1554
1555/** @copydoc VDIMAGEBACKEND::pfnCreate */
1556static DECLCALLBACK(int) qedCreate(const char *pszFilename, uint64_t cbSize,
1557 unsigned uImageFlags, const char *pszComment,
1558 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
1559 PCRTUUID pUuid, unsigned uOpenFlags,
1560 unsigned uPercentStart, unsigned uPercentSpan,
1561 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
1562 PVDINTERFACE pVDIfsOperation, VDTYPE enmType,
1563 void **ppBackendData)
1564{
1565 RT_NOREF1(pUuid);
1566 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 enmType=%d ppBackendData=%#p",
1567 pszFilename, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, enmType, ppBackendData));
1568 int rc;
1569
1570 /* Check the VD container type. */
1571 if (enmType != VDTYPE_HDD)
1572 return VERR_VD_INVALID_TYPE;
1573
1574 /* Check open flags. All valid flags are supported. */
1575 AssertReturn(!(uOpenFlags & ~VD_OPEN_FLAGS_MASK), VERR_INVALID_PARAMETER);
1576 AssertReturn( VALID_PTR(pszFilename)
1577 && *pszFilename
1578 && VALID_PTR(pPCHSGeometry)
1579 && VALID_PTR(pLCHSGeometry), VERR_INVALID_PARAMETER);
1580
1581 PQEDIMAGE pImage = (PQEDIMAGE)RTMemAllocZ(sizeof(QEDIMAGE));
1582 if (RT_LIKELY(pImage))
1583 {
1584 PVDINTERFACEPROGRESS pIfProgress = VDIfProgressGet(pVDIfsOperation);
1585
1586 pImage->pszFilename = pszFilename;
1587 pImage->pStorage = NULL;
1588 pImage->pVDIfsDisk = pVDIfsDisk;
1589 pImage->pVDIfsImage = pVDIfsImage;
1590
1591 rc = qedCreateImage(pImage, cbSize, uImageFlags, pszComment,
1592 pPCHSGeometry, pLCHSGeometry, uOpenFlags,
1593 pIfProgress, uPercentStart, uPercentSpan);
1594 if (RT_SUCCESS(rc))
1595 {
1596 /* So far the image is opened in read/write mode. Make sure the
1597 * image is opened in read-only mode if the caller requested that. */
1598 if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
1599 {
1600 qedFreeImage(pImage, false);
1601 rc = qedOpenImage(pImage, uOpenFlags);
1602 }
1603
1604 if (RT_SUCCESS(rc))
1605 *ppBackendData = pImage;
1606 }
1607
1608 if (RT_FAILURE(rc))
1609 RTMemFree(pImage);
1610 }
1611 else
1612 rc = VERR_NO_MEMORY;
1613
1614 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
1615 return rc;
1616}
1617
1618/** @copydoc VDIMAGEBACKEND::pfnRename */
1619static DECLCALLBACK(int) qedRename(void *pBackendData, const char *pszFilename)
1620{
1621 LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
1622 int rc = VINF_SUCCESS;
1623 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1624
1625 /* Check arguments. */
1626 AssertReturn((pImage && pszFilename && *pszFilename), VERR_INVALID_PARAMETER);
1627
1628 /* Close the image. */
1629 rc = qedFreeImage(pImage, false);
1630 if (RT_SUCCESS(rc))
1631 {
1632 /* Rename the file. */
1633 rc = vdIfIoIntFileMove(pImage->pIfIo, pImage->pszFilename, pszFilename, 0);
1634 if (RT_SUCCESS(rc))
1635 {
1636 /* Update pImage with the new information. */
1637 pImage->pszFilename = pszFilename;
1638
1639 /* Open the old image with new name. */
1640 rc = qedOpenImage(pImage, pImage->uOpenFlags);
1641 }
1642 else
1643 {
1644 /* The move failed, try to reopen the original image. */
1645 int rc2 = qedOpenImage(pImage, pImage->uOpenFlags);
1646 if (RT_FAILURE(rc2))
1647 rc = rc2;
1648 }
1649 }
1650
1651 LogFlowFunc(("returns %Rrc\n", rc));
1652 return rc;
1653}
1654
1655/** @copydoc VDIMAGEBACKEND::pfnClose */
1656static DECLCALLBACK(int) qedClose(void *pBackendData, bool fDelete)
1657{
1658 LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
1659 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1660
1661 int rc = qedFreeImage(pImage, fDelete);
1662 RTMemFree(pImage);
1663
1664 LogFlowFunc(("returns %Rrc\n", rc));
1665 return rc;
1666}
1667
1668/** @copydoc VDIMAGEBACKEND::pfnRead */
1669static DECLCALLBACK(int) qedRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
1670 PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
1671{
1672 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
1673 pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
1674 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1675 uint32_t offCluster = 0;
1676 uint32_t idxL1 = 0;
1677 uint32_t idxL2 = 0;
1678 uint64_t offFile = 0;
1679
1680 AssertPtr(pImage);
1681 Assert(uOffset % 512 == 0);
1682 Assert(cbToRead % 512 == 0);
1683 AssertReturn((VALID_PTR(pIoCtx) && cbToRead), VERR_INVALID_PARAMETER);
1684 AssertReturn(uOffset + cbToRead <= pImage->cbSize, VERR_INVALID_PARAMETER);
1685
1686 qedConvertLogicalOffset(pImage, uOffset, &idxL1, &idxL2, &offCluster);
1687
1688 /* Clip read size to remain in the cluster. */
1689 cbToRead = RT_MIN(cbToRead, pImage->cbCluster - offCluster);
1690
1691 /* Get offset in image. */
1692 int rc = qedConvertToImageOffset(pImage, pIoCtx, idxL1, idxL2, offCluster, &offFile);
1693 if (RT_SUCCESS(rc))
1694 rc = vdIfIoIntFileReadUser(pImage->pIfIo, pImage->pStorage, offFile,
1695 pIoCtx, cbToRead);
1696
1697 if ( ( RT_SUCCESS(rc)
1698 || rc == VERR_VD_BLOCK_FREE
1699 || rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1700 && pcbActuallyRead)
1701 *pcbActuallyRead = cbToRead;
1702
1703 LogFlowFunc(("returns %Rrc\n", rc));
1704 return rc;
1705}
1706
1707/** @copydoc VDIMAGEBACKEND::pfnWrite */
1708static DECLCALLBACK(int) qedWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
1709 PVDIOCTX pIoCtx, size_t *pcbWriteProcess, size_t *pcbPreRead,
1710 size_t *pcbPostRead, unsigned fWrite)
1711{
1712 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
1713 pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
1714 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1715 uint32_t offCluster = 0;
1716 uint32_t idxL1 = 0;
1717 uint32_t idxL2 = 0;
1718 uint64_t offImage = 0;
1719 int rc = VINF_SUCCESS;
1720
1721 AssertPtr(pImage);
1722 Assert(!(uOffset % 512));
1723 Assert(!(cbToWrite % 512));
1724 AssertReturn((VALID_PTR(pIoCtx) && cbToWrite), VERR_INVALID_PARAMETER);
1725 AssertReturn(uOffset + cbToWrite <= pImage->cbSize, VERR_INVALID_PARAMETER);
1726
1727 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1728 {
1729 /* Convert offset to L1, L2 index and cluster offset. */
1730 qedConvertLogicalOffset(pImage, uOffset, &idxL1, &idxL2, &offCluster);
1731
1732 /* Clip write size to remain in the cluster. */
1733 cbToWrite = RT_MIN(cbToWrite, pImage->cbCluster - offCluster);
1734 Assert(!(cbToWrite % 512));
1735
1736 /* Get offset in image. */
1737 rc = qedConvertToImageOffset(pImage, pIoCtx, idxL1, idxL2, offCluster, &offImage);
1738 if (RT_SUCCESS(rc))
1739 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1740 offImage, pIoCtx, cbToWrite, NULL, NULL);
1741 else if (rc == VERR_VD_BLOCK_FREE)
1742 {
1743 if ( cbToWrite == pImage->cbCluster
1744 && !(fWrite & VD_WRITE_NO_ALLOC))
1745 {
1746 PQEDL2CACHEENTRY pL2Entry = NULL;
1747
1748 /* Full cluster write to previously unallocated cluster.
1749 * Allocate cluster and write data. */
1750 Assert(!offCluster);
1751
1752 do
1753 {
1754 /* Check if we have to allocate a new cluster for L2 tables. */
1755 if (!pImage->paL1Table[idxL1])
1756 {
1757 uint64_t offL2Tbl;
1758 PQEDCLUSTERASYNCALLOC pL2ClusterAlloc = NULL;
1759
1760 /* Allocate new async cluster allocation state. */
1761 pL2ClusterAlloc = (PQEDCLUSTERASYNCALLOC)RTMemAllocZ(sizeof(QEDCLUSTERASYNCALLOC));
1762 if (RT_UNLIKELY(!pL2ClusterAlloc))
1763 {
1764 rc = VERR_NO_MEMORY;
1765 break;
1766 }
1767
1768 pL2Entry = qedL2TblCacheEntryAlloc(pImage);
1769 if (!pL2Entry)
1770 {
1771 rc = VERR_NO_MEMORY;
1772 RTMemFree(pL2ClusterAlloc);
1773 break;
1774 }
1775
1776 offL2Tbl = qedClusterAllocate(pImage, qedByte2Cluster(pImage, pImage->cbTable));
1777 pL2Entry->offL2Tbl = offL2Tbl;
1778 memset(pL2Entry->paL2Tbl, 0, pImage->cbTable);
1779
1780 pL2ClusterAlloc->enmAllocState = QEDCLUSTERASYNCALLOCSTATE_L2_ALLOC;
1781 pL2ClusterAlloc->cbImageOld = offL2Tbl;
1782 pL2ClusterAlloc->offClusterNew = offL2Tbl;
1783 pL2ClusterAlloc->idxL1 = idxL1;
1784 pL2ClusterAlloc->idxL2 = idxL2;
1785 pL2ClusterAlloc->cbToWrite = cbToWrite;
1786 pL2ClusterAlloc->pL2Entry = pL2Entry;
1787
1788 pImage->pL2TblAlloc = pL2Entry;
1789
1790 LogFlowFunc(("Allocating new L2 table at cluster offset %llu\n", offL2Tbl));
1791
1792 /*
1793 * Write the L2 table first and link to the L1 table afterwards.
1794 * If something unexpected happens the worst case which can happen
1795 * is a leak of some clusters.
1796 */
1797 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1798 offL2Tbl, pL2Entry->paL2Tbl, pImage->cbTable, pIoCtx,
1799 qedAsyncClusterAllocUpdate, pL2ClusterAlloc);
1800 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1801 break;
1802 else if (RT_FAILURE(rc))
1803 {
1804 RTMemFree(pL2ClusterAlloc);
1805 qedL2TblCacheEntryFree(pImage, pL2Entry);
1806 break;
1807 }
1808
1809 rc = qedAsyncClusterAllocUpdate(pImage, pIoCtx, pL2ClusterAlloc, rc);
1810 }
1811 else
1812 {
1813 LogFlowFunc(("Fetching L2 table at cluster offset %llu\n", pImage->paL1Table[idxL1]));
1814
1815 rc = qedL2TblCacheFetchAsync(pImage, pIoCtx, pImage->paL1Table[idxL1],
1816 &pL2Entry);
1817
1818 if (RT_SUCCESS(rc))
1819 {
1820 PQEDCLUSTERASYNCALLOC pDataClusterAlloc = NULL;
1821
1822 /* Allocate new async cluster allocation state. */
1823 pDataClusterAlloc = (PQEDCLUSTERASYNCALLOC)RTMemAllocZ(sizeof(QEDCLUSTERASYNCALLOC));
1824 if (RT_UNLIKELY(!pDataClusterAlloc))
1825 {
1826 rc = VERR_NO_MEMORY;
1827 break;
1828 }
1829
1830 /* Allocate new cluster for the data. */
1831 uint64_t offData = qedClusterAllocate(pImage, 1);
1832
1833 pDataClusterAlloc->enmAllocState = QEDCLUSTERASYNCALLOCSTATE_USER_ALLOC;
1834 pDataClusterAlloc->cbImageOld = offData;
1835 pDataClusterAlloc->offClusterNew = offData;
1836 pDataClusterAlloc->idxL1 = idxL1;
1837 pDataClusterAlloc->idxL2 = idxL2;
1838 pDataClusterAlloc->cbToWrite = cbToWrite;
1839 pDataClusterAlloc->pL2Entry = pL2Entry;
1840
1841 /* Write data. */
1842 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pImage->pStorage,
1843 offData, pIoCtx, cbToWrite,
1844 qedAsyncClusterAllocUpdate, pDataClusterAlloc);
1845 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1846 break;
1847 else if (RT_FAILURE(rc))
1848 {
1849 RTMemFree(pDataClusterAlloc);
1850 break;
1851 }
1852
1853 rc = qedAsyncClusterAllocUpdate(pImage, pIoCtx, pDataClusterAlloc, rc);
1854 }
1855 }
1856
1857 } while (0);
1858
1859 *pcbPreRead = 0;
1860 *pcbPostRead = 0;
1861 }
1862 else
1863 {
1864 /* Trying to do a partial write to an unallocated cluster. Don't do
1865 * anything except letting the upper layer know what to do. */
1866 *pcbPreRead = offCluster;
1867 *pcbPostRead = pImage->cbCluster - cbToWrite - *pcbPreRead;
1868 }
1869 }
1870
1871 if (pcbWriteProcess)
1872 *pcbWriteProcess = cbToWrite;
1873 }
1874 else
1875 rc = VERR_VD_IMAGE_READ_ONLY;
1876
1877 LogFlowFunc(("returns %Rrc\n", rc));
1878 return rc;
1879}
1880
1881/** @copydoc VDIMAGEBACKEND::pfnFlush */
1882static DECLCALLBACK(int) qedFlush(void *pBackendData, PVDIOCTX pIoCtx)
1883{
1884 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1885 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1886 int rc = VINF_SUCCESS;
1887
1888 AssertPtr(pImage);
1889 AssertPtrReturn(pIoCtx, VERR_INVALID_PARAMETER);
1890
1891 if ( pImage->pStorage
1892 && !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
1893 {
1894 QedHeader Header;
1895
1896 Assert(!(pImage->cbTable % pImage->cbCluster));
1897 rc = qedTblWrite(pImage, pIoCtx, pImage->offL1Table, pImage->paL1Table,
1898 NULL, NULL);
1899 if (RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1900 {
1901 /* Write header. */
1902 qedHdrConvertFromHostEndianess(pImage, &Header);
1903 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pImage->pStorage,
1904 0, &Header, sizeof(Header),
1905 pIoCtx, NULL, NULL);
1906 if (RT_SUCCESS(rc) || rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
1907 rc = vdIfIoIntFileFlush(pImage->pIfIo, pImage->pStorage,
1908 pIoCtx, NULL, NULL);
1909 }
1910 }
1911
1912 LogFlowFunc(("returns %Rrc\n", rc));
1913 return rc;
1914}
1915
1916/** @copydoc VDIMAGEBACKEND::pfnGetVersion */
1917static DECLCALLBACK(unsigned) qedGetVersion(void *pBackendData)
1918{
1919 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1920 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1921
1922 AssertPtrReturn(pImage, 0);
1923
1924 return 1;
1925}
1926
1927/** @copydoc VDIMAGEBACKEND::pfnGetSectorSize */
1928static DECLCALLBACK(uint32_t) qedGetSectorSize(void *pBackendData)
1929{
1930 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1931 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1932 uint32_t cb = 0;
1933
1934 AssertPtrReturn(pImage, 0);
1935
1936 if (pImage->pStorage)
1937 cb = 512;
1938
1939 LogFlowFunc(("returns %u\n", cb));
1940 return cb;
1941}
1942
1943/** @copydoc VDIMAGEBACKEND::pfnGetSize */
1944static DECLCALLBACK(uint64_t) qedGetSize(void *pBackendData)
1945{
1946 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1947 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1948 uint64_t cb = 0;
1949
1950 AssertPtrReturn(pImage, 0);
1951
1952 if (pImage->pStorage)
1953 cb = pImage->cbSize;
1954
1955 LogFlowFunc(("returns %llu\n", cb));
1956 return cb;
1957}
1958
1959/** @copydoc VDIMAGEBACKEND::pfnGetFileSize */
1960static DECLCALLBACK(uint64_t) qedGetFileSize(void *pBackendData)
1961{
1962 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
1963 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1964 uint64_t cb = 0;
1965
1966 AssertPtrReturn(pImage, 0);
1967
1968 uint64_t cbFile;
1969 if (pImage->pStorage)
1970 {
1971 int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pStorage, &cbFile);
1972 if (RT_SUCCESS(rc))
1973 cb += cbFile;
1974 }
1975
1976 LogFlowFunc(("returns %lld\n", cb));
1977 return cb;
1978}
1979
1980/** @copydoc VDIMAGEBACKEND::pfnGetPCHSGeometry */
1981static DECLCALLBACK(int) qedGetPCHSGeometry(void *pBackendData,
1982 PVDGEOMETRY pPCHSGeometry)
1983{
1984 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
1985 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
1986 int rc = VINF_SUCCESS;
1987
1988 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
1989
1990 if (pImage->PCHSGeometry.cCylinders)
1991 *pPCHSGeometry = pImage->PCHSGeometry;
1992 else
1993 rc = VERR_VD_GEOMETRY_NOT_SET;
1994
1995 LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
1996 return rc;
1997}
1998
1999/** @copydoc VDIMAGEBACKEND::pfnSetPCHSGeometry */
2000static DECLCALLBACK(int) qedSetPCHSGeometry(void *pBackendData,
2001 PCVDGEOMETRY pPCHSGeometry)
2002{
2003 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n",
2004 pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
2005 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2006 int rc = VINF_SUCCESS;
2007
2008 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2009
2010 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2011 rc = VERR_VD_IMAGE_READ_ONLY;
2012 else
2013 pImage->PCHSGeometry = *pPCHSGeometry;
2014
2015 LogFlowFunc(("returns %Rrc\n", rc));
2016 return rc;
2017}
2018
2019/** @copydoc VDIMAGEBACKEND::pfnGetLCHSGeometry */
2020static DECLCALLBACK(int) qedGetLCHSGeometry(void *pBackendData, PVDGEOMETRY pLCHSGeometry)
2021{
2022 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
2023 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2024 int rc = VINF_SUCCESS;
2025
2026 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2027
2028 if (pImage->LCHSGeometry.cCylinders)
2029 *pLCHSGeometry = pImage->LCHSGeometry;
2030 else
2031 rc = VERR_VD_GEOMETRY_NOT_SET;
2032
2033 LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders,
2034 pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2035 return rc;
2036}
2037
2038/** @copydoc VDIMAGEBACKEND::pfnSetLCHSGeometry */
2039static DECLCALLBACK(int) qedSetLCHSGeometry(void *pBackendData, PCVDGEOMETRY pLCHSGeometry)
2040{
2041 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData,
2042 pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
2043 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2044 int rc = VINF_SUCCESS;
2045
2046 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2047
2048 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2049 rc = VERR_VD_IMAGE_READ_ONLY;
2050 else
2051 pImage->LCHSGeometry = *pLCHSGeometry;
2052
2053 LogFlowFunc(("returns %Rrc\n", rc));
2054 return rc;
2055}
2056
2057/** @copydoc VDIMAGEBACKEND::pfnGetImageFlags */
2058static DECLCALLBACK(unsigned) qedGetImageFlags(void *pBackendData)
2059{
2060 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2061 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2062
2063 AssertPtrReturn(pImage, 0);
2064
2065 LogFlowFunc(("returns %#x\n", pImage->uImageFlags));
2066 return pImage->uImageFlags;
2067}
2068
2069/** @copydoc VDIMAGEBACKEND::pfnGetOpenFlags */
2070static DECLCALLBACK(unsigned) qedGetOpenFlags(void *pBackendData)
2071{
2072 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
2073 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2074
2075 AssertPtrReturn(pImage, 0);
2076
2077 LogFlowFunc(("returns %#x\n", pImage->uOpenFlags));
2078 return pImage->uOpenFlags;
2079}
2080
2081/** @copydoc VDIMAGEBACKEND::pfnSetOpenFlags */
2082static DECLCALLBACK(int) qedSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
2083{
2084 LogFlowFunc(("pBackendData=%#p\n uOpenFlags=%#x", pBackendData, uOpenFlags));
2085 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2086 int rc = VINF_SUCCESS;
2087
2088 /* Image must be opened and the new flags must be valid. */
2089 if (!pImage || (uOpenFlags & ~( VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO
2090 | VD_OPEN_FLAGS_ASYNC_IO | VD_OPEN_FLAGS_SHAREABLE
2091 | VD_OPEN_FLAGS_SEQUENTIAL | VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS)))
2092 rc = VERR_INVALID_PARAMETER;
2093 else
2094 {
2095 /* Implement this operation via reopening the image. */
2096 rc = qedFreeImage(pImage, false);
2097 if (RT_SUCCESS(rc))
2098 rc = qedOpenImage(pImage, uOpenFlags);
2099 }
2100
2101 LogFlowFunc(("returns %Rrc\n", rc));
2102 return rc;
2103}
2104
2105/** @copydoc VDIMAGEBACKEND::pfnGetComment */
2106static DECLCALLBACK(int) qedGetComment(void *pBackendData, char *pszComment,
2107 size_t cbComment)
2108{
2109 RT_NOREF2(pszComment, cbComment);
2110 LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
2111 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2112
2113 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2114
2115 LogFlowFunc(("returns %Rrc comment='%s'\n", VERR_NOT_SUPPORTED, pszComment));
2116 return VERR_NOT_SUPPORTED;
2117}
2118
2119/** @copydoc VDIMAGEBACKEND::pfnSetComment */
2120static DECLCALLBACK(int) qedSetComment(void *pBackendData, const char *pszComment)
2121{
2122 RT_NOREF1(pszComment);
2123 LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
2124 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2125
2126 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2127
2128 int rc;
2129 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2130 rc = VERR_VD_IMAGE_READ_ONLY;
2131 else
2132 rc = VERR_NOT_SUPPORTED;
2133
2134 LogFlowFunc(("returns %Rrc\n", rc));
2135 return rc;
2136}
2137
2138/** @copydoc VDIMAGEBACKEND::pfnGetUuid */
2139static DECLCALLBACK(int) qedGetUuid(void *pBackendData, PRTUUID pUuid)
2140{
2141 RT_NOREF1(pUuid);
2142 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2143 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2144
2145 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2146
2147 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VERR_NOT_SUPPORTED, pUuid));
2148 return VERR_NOT_SUPPORTED;
2149}
2150
2151/** @copydoc VDIMAGEBACKEND::pfnSetUuid */
2152static DECLCALLBACK(int) qedSetUuid(void *pBackendData, PCRTUUID pUuid)
2153{
2154 RT_NOREF1(pUuid);
2155 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2156 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2157
2158 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2159
2160 int rc;
2161 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2162 rc = VERR_VD_IMAGE_READ_ONLY;
2163 else
2164 rc = VERR_NOT_SUPPORTED;
2165
2166 LogFlowFunc(("returns %Rrc\n", rc));
2167 return rc;
2168}
2169
2170/** @copydoc VDIMAGEBACKEND::pfnGetModificationUuid */
2171static DECLCALLBACK(int) qedGetModificationUuid(void *pBackendData, PRTUUID pUuid)
2172{
2173 RT_NOREF1(pUuid);
2174 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2175 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2176
2177 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2178
2179 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VERR_NOT_SUPPORTED, pUuid));
2180 return VERR_NOT_SUPPORTED;
2181}
2182
2183/** @copydoc VDIMAGEBACKEND::pfnSetModificationUuid */
2184static DECLCALLBACK(int) qedSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
2185{
2186 RT_NOREF1(pUuid);
2187 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2188 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2189
2190 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2191
2192 int rc;
2193 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2194 rc = VERR_VD_IMAGE_READ_ONLY;
2195 else
2196 rc = VERR_NOT_SUPPORTED;
2197
2198 LogFlowFunc(("returns %Rrc\n", rc));
2199 return rc;
2200}
2201
2202/** @copydoc VDIMAGEBACKEND::pfnGetParentUuid */
2203static DECLCALLBACK(int) qedGetParentUuid(void *pBackendData, PRTUUID pUuid)
2204{
2205 RT_NOREF1(pUuid);
2206 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2207 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2208
2209 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2210
2211 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VERR_NOT_SUPPORTED, pUuid));
2212 return VERR_NOT_SUPPORTED;
2213}
2214
2215/** @copydoc VDIMAGEBACKEND::pfnSetParentUuid */
2216static DECLCALLBACK(int) qedSetParentUuid(void *pBackendData, PCRTUUID pUuid)
2217{
2218 RT_NOREF1(pUuid);
2219 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2220 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2221
2222 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2223
2224 int rc;
2225 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2226 rc = VERR_VD_IMAGE_READ_ONLY;
2227 else
2228 rc = VERR_NOT_SUPPORTED;
2229
2230 LogFlowFunc(("returns %Rrc\n", rc));
2231 return rc;
2232}
2233
2234/** @copydoc VDIMAGEBACKEND::pfnGetParentModificationUuid */
2235static DECLCALLBACK(int) qedGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
2236{
2237 RT_NOREF1(pUuid);
2238 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
2239 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2240
2241 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2242
2243 LogFlowFunc(("returns %Rrc (%RTuuid)\n", VERR_NOT_SUPPORTED, pUuid));
2244 return VERR_NOT_SUPPORTED;
2245}
2246
2247/** @copydoc VDIMAGEBACKEND::pfnSetParentModificationUuid */
2248static DECLCALLBACK(int) qedSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
2249{
2250 RT_NOREF1(pUuid);
2251 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
2252 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2253
2254 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2255
2256 int rc;
2257 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2258 rc = VERR_VD_IMAGE_READ_ONLY;
2259 else
2260 rc = VERR_NOT_SUPPORTED;
2261
2262 LogFlowFunc(("returns %Rrc\n", rc));
2263 return rc;
2264}
2265
2266/** @copydoc VDIMAGEBACKEND::pfnDump */
2267static DECLCALLBACK(void) qedDump(void *pBackendData)
2268{
2269 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2270
2271 AssertPtrReturnVoid(pImage);
2272 vdIfErrorMessage(pImage->pIfError, "Header: Geometry PCHS=%u/%u/%u LCHS=%u/%u/%u cbSector=%llu\n",
2273 pImage->PCHSGeometry.cCylinders, pImage->PCHSGeometry.cHeads, pImage->PCHSGeometry.cSectors,
2274 pImage->LCHSGeometry.cCylinders, pImage->LCHSGeometry.cHeads, pImage->LCHSGeometry.cSectors,
2275 pImage->cbSize / 512);
2276}
2277
2278/** @copydoc VDIMAGEBACKEND::pfnGetParentFilename */
2279static DECLCALLBACK(int) qedGetParentFilename(void *pBackendData, char **ppszParentFilename)
2280{
2281 int rc = VINF_SUCCESS;
2282 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2283
2284 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2285
2286 if (pImage->pszBackingFilename)
2287 *ppszParentFilename = RTStrDup(pImage->pszBackingFilename);
2288 else
2289 rc = VERR_NOT_SUPPORTED;
2290
2291 LogFlowFunc(("returns %Rrc\n", rc));
2292 return rc;
2293}
2294
2295/** @copydoc VDIMAGEBACKEND::pfnSetParentFilename */
2296static DECLCALLBACK(int) qedSetParentFilename(void *pBackendData, const char *pszParentFilename)
2297{
2298 int rc = VINF_SUCCESS;
2299 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2300
2301 AssertPtrReturn(pImage, VERR_VD_NOT_OPENED);
2302
2303 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2304 rc = VERR_VD_IMAGE_READ_ONLY;
2305 else if ( pImage->pszBackingFilename
2306 && (strlen(pszParentFilename) > pImage->cbBackingFilename))
2307 rc = VERR_NOT_SUPPORTED; /* The new filename is longer than the old one. */
2308 else
2309 {
2310 if (pImage->pszBackingFilename)
2311 RTStrFree(pImage->pszBackingFilename);
2312 pImage->pszBackingFilename = RTStrDup(pszParentFilename);
2313 if (!pImage->pszBackingFilename)
2314 rc = VERR_NO_MEMORY;
2315 else
2316 {
2317 if (!pImage->offBackingFilename)
2318 {
2319 /* Allocate new cluster. */
2320 uint64_t offData = qedClusterAllocate(pImage, 1);
2321
2322 Assert((offData & UINT32_MAX) == offData);
2323 pImage->offBackingFilename = (uint32_t)offData;
2324 pImage->cbBackingFilename = (uint32_t)strlen(pszParentFilename);
2325 rc = vdIfIoIntFileSetSize(pImage->pIfIo, pImage->pStorage,
2326 offData + pImage->cbCluster);
2327 }
2328
2329 if (RT_SUCCESS(rc))
2330 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pImage->pStorage,
2331 pImage->offBackingFilename,
2332 pImage->pszBackingFilename,
2333 strlen(pImage->pszBackingFilename));
2334 }
2335 }
2336
2337 LogFlowFunc(("returns %Rrc\n", rc));
2338 return rc;
2339}
2340
2341/** @copydoc VDIMAGEBACKEND::pfnResize */
2342static DECLCALLBACK(int) qedResize(void *pBackendData, uint64_t cbSize,
2343 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
2344 unsigned uPercentStart, unsigned uPercentSpan,
2345 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
2346 PVDINTERFACE pVDIfsOperation)
2347{
2348 RT_NOREF7(pPCHSGeometry, pLCHSGeometry, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation);
2349 PQEDIMAGE pImage = (PQEDIMAGE)pBackendData;
2350 int rc = VINF_SUCCESS;
2351
2352 /* Making the image smaller is not supported at the moment. */
2353 if (cbSize < pImage->cbSize)
2354 rc = VERR_NOT_SUPPORTED;
2355 else if (cbSize > pImage->cbSize)
2356 {
2357 /*
2358 * It is enough to just update the size field in the header to complete
2359 * growing. With the default cluster and table sizes the image can be expanded
2360 * to 64TB without overflowing the L1 and L2 tables making block relocation
2361 * superfluous.
2362 * @todo: The rare case where block relocation is still required (non default
2363 * table and/or cluster size or images with more than 64TB) is not
2364 * implemented yet and resizing such an image will fail with an error.
2365 */
2366 if (qedByte2Cluster(pImage, pImage->cbTable)*pImage->cTableEntries*pImage->cTableEntries*pImage->cbCluster < cbSize)
2367 rc = vdIfError(pImage->pIfError, VERR_BUFFER_OVERFLOW, RT_SRC_POS,
2368 N_("Qed: Resizing the image '%s' is not supported because it would overflow the L1 and L2 table\n"),
2369 pImage->pszFilename);
2370 else
2371 {
2372 uint64_t cbSizeOld = pImage->cbSize;
2373
2374 pImage->cbSize = cbSize;
2375 rc = qedFlushImage(pImage);
2376 if (RT_FAILURE(rc))
2377 {
2378 pImage->cbSize = cbSizeOld; /* Restore */
2379
2380 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("Qed: Resizing the image '%s' failed\n"),
2381 pImage->pszFilename);
2382 }
2383 }
2384 }
2385 /* Same size doesn't change the image at all. */
2386
2387 LogFlowFunc(("returns %Rrc\n", rc));
2388 return rc;
2389}
2390
2391
2392const VDIMAGEBACKEND g_QedBackend =
2393{
2394 /* u32Version */
2395 VD_IMGBACKEND_VERSION,
2396 /* pszBackendName */
2397 "QED",
2398 /* uBackendCaps */
2399 VD_CAP_FILE | VD_CAP_VFS | VD_CAP_CREATE_DYNAMIC | VD_CAP_DIFF | VD_CAP_ASYNC,
2400 /* paFileExtensions */
2401 s_aQedFileExtensions,
2402 /* paConfigInfo */
2403 NULL,
2404 /* pfnProbe */
2405 qedProbe,
2406 /* pfnOpen */
2407 qedOpen,
2408 /* pfnCreate */
2409 qedCreate,
2410 /* pfnRename */
2411 qedRename,
2412 /* pfnClose */
2413 qedClose,
2414 /* pfnRead */
2415 qedRead,
2416 /* pfnWrite */
2417 qedWrite,
2418 /* pfnFlush */
2419 qedFlush,
2420 /* pfnDiscard */
2421 NULL,
2422 /* pfnGetVersion */
2423 qedGetVersion,
2424 /* pfnGetSectorSize */
2425 qedGetSectorSize,
2426 /* pfnGetSize */
2427 qedGetSize,
2428 /* pfnGetFileSize */
2429 qedGetFileSize,
2430 /* pfnGetPCHSGeometry */
2431 qedGetPCHSGeometry,
2432 /* pfnSetPCHSGeometry */
2433 qedSetPCHSGeometry,
2434 /* pfnGetLCHSGeometry */
2435 qedGetLCHSGeometry,
2436 /* pfnSetLCHSGeometry */
2437 qedSetLCHSGeometry,
2438 /* pfnGetImageFlags */
2439 qedGetImageFlags,
2440 /* pfnGetOpenFlags */
2441 qedGetOpenFlags,
2442 /* pfnSetOpenFlags */
2443 qedSetOpenFlags,
2444 /* pfnGetComment */
2445 qedGetComment,
2446 /* pfnSetComment */
2447 qedSetComment,
2448 /* pfnGetUuid */
2449 qedGetUuid,
2450 /* pfnSetUuid */
2451 qedSetUuid,
2452 /* pfnGetModificationUuid */
2453 qedGetModificationUuid,
2454 /* pfnSetModificationUuid */
2455 qedSetModificationUuid,
2456 /* pfnGetParentUuid */
2457 qedGetParentUuid,
2458 /* pfnSetParentUuid */
2459 qedSetParentUuid,
2460 /* pfnGetParentModificationUuid */
2461 qedGetParentModificationUuid,
2462 /* pfnSetParentModificationUuid */
2463 qedSetParentModificationUuid,
2464 /* pfnDump */
2465 qedDump,
2466 /* pfnGetTimestamp */
2467 NULL,
2468 /* pfnGetParentTimestamp */
2469 NULL,
2470 /* pfnSetParentTimestamp */
2471 NULL,
2472 /* pfnGetParentFilename */
2473 qedGetParentFilename,
2474 /* pfnSetParentFilename */
2475 qedSetParentFilename,
2476 /* pfnComposeLocation */
2477 genericFileComposeLocation,
2478 /* pfnComposeName */
2479 genericFileComposeName,
2480 /* pfnCompact */
2481 NULL,
2482 /* pfnResize */
2483 qedResize,
2484 /* pfnRepair */
2485 NULL,
2486 /* pfnTraverseMetadata */
2487 NULL,
2488 /* u32Version */
2489 VD_IMGBACKEND_VERSION
2490};
Note: See TracBrowser for help on using the repository browser.

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