VirtualBox

source: vbox/trunk/src/VBox/Storage/QCOW.cpp@ 63206

Last change on this file since 63206 was 62873, checked in by vboxsync, 8 years ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use