VirtualBox

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

Last change on this file since 40739 was 39519, checked in by vboxsync, 13 years ago

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