VirtualBox

source: vbox/trunk/src/VBox/Storage/VMDK.cpp@ 61590

Last change on this file since 61590 was 60608, checked in by vboxsync, 9 years ago

Main+Storage/VD: add a capability which marks preferred medium format backends

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 243.5 KB
Line 
1/* $Id: VMDK.cpp 60608 2016-04-20 17:16:37Z vboxsync $ */
2/** @file
3 * VMDK disk image, core code.
4 */
5
6/*
7 * Copyright (C) 2006-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_VMDK
23#include <VBox/vd-plugin.h>
24#include <VBox/err.h>
25
26#include <VBox/log.h>
27#include <iprt/assert.h>
28#include <iprt/alloc.h>
29#include <iprt/uuid.h>
30#include <iprt/path.h>
31#include <iprt/string.h>
32#include <iprt/rand.h>
33#include <iprt/zip.h>
34#include <iprt/asm.h>
35
36#include "VDBackends.h"
37
38
39/*********************************************************************************************************************************
40* Constants And Macros, Structures and Typedefs *
41*********************************************************************************************************************************/
42
43/** Maximum encoded string size (including NUL) we allow for VMDK images.
44 * Deliberately not set high to avoid running out of descriptor space. */
45#define VMDK_ENCODED_COMMENT_MAX 1024
46
47/** VMDK descriptor DDB entry for PCHS cylinders. */
48#define VMDK_DDB_GEO_PCHS_CYLINDERS "ddb.geometry.cylinders"
49
50/** VMDK descriptor DDB entry for PCHS heads. */
51#define VMDK_DDB_GEO_PCHS_HEADS "ddb.geometry.heads"
52
53/** VMDK descriptor DDB entry for PCHS sectors. */
54#define VMDK_DDB_GEO_PCHS_SECTORS "ddb.geometry.sectors"
55
56/** VMDK descriptor DDB entry for LCHS cylinders. */
57#define VMDK_DDB_GEO_LCHS_CYLINDERS "ddb.geometry.biosCylinders"
58
59/** VMDK descriptor DDB entry for LCHS heads. */
60#define VMDK_DDB_GEO_LCHS_HEADS "ddb.geometry.biosHeads"
61
62/** VMDK descriptor DDB entry for LCHS sectors. */
63#define VMDK_DDB_GEO_LCHS_SECTORS "ddb.geometry.biosSectors"
64
65/** VMDK descriptor DDB entry for image UUID. */
66#define VMDK_DDB_IMAGE_UUID "ddb.uuid.image"
67
68/** VMDK descriptor DDB entry for image modification UUID. */
69#define VMDK_DDB_MODIFICATION_UUID "ddb.uuid.modification"
70
71/** VMDK descriptor DDB entry for parent image UUID. */
72#define VMDK_DDB_PARENT_UUID "ddb.uuid.parent"
73
74/** VMDK descriptor DDB entry for parent image modification UUID. */
75#define VMDK_DDB_PARENT_MODIFICATION_UUID "ddb.uuid.parentmodification"
76
77/** No compression for streamOptimized files. */
78#define VMDK_COMPRESSION_NONE 0
79
80/** Deflate compression for streamOptimized files. */
81#define VMDK_COMPRESSION_DEFLATE 1
82
83/** Marker that the actual GD value is stored in the footer. */
84#define VMDK_GD_AT_END 0xffffffffffffffffULL
85
86/** Marker for end-of-stream in streamOptimized images. */
87#define VMDK_MARKER_EOS 0
88
89/** Marker for grain table block in streamOptimized images. */
90#define VMDK_MARKER_GT 1
91
92/** Marker for grain directory block in streamOptimized images. */
93#define VMDK_MARKER_GD 2
94
95/** Marker for footer in streamOptimized images. */
96#define VMDK_MARKER_FOOTER 3
97
98/** Marker for unknown purpose in streamOptimized images.
99 * Shows up in very recent images created by vSphere, but only sporadically.
100 * They "forgot" to document that one in the VMDK specification. */
101#define VMDK_MARKER_UNSPECIFIED 4
102
103/** Dummy marker for "don't check the marker value". */
104#define VMDK_MARKER_IGNORE 0xffffffffU
105
106/**
107 * Magic number for hosted images created by VMware Workstation 4, VMware
108 * Workstation 5, VMware Server or VMware Player. Not necessarily sparse.
109 */
110#define VMDK_SPARSE_MAGICNUMBER 0x564d444b /* 'V' 'M' 'D' 'K' */
111
112/**
113 * VMDK hosted binary extent header. The "Sparse" is a total misnomer, as
114 * this header is also used for monolithic flat images.
115 */
116#pragma pack(1)
117typedef struct SparseExtentHeader
118{
119 uint32_t magicNumber;
120 uint32_t version;
121 uint32_t flags;
122 uint64_t capacity;
123 uint64_t grainSize;
124 uint64_t descriptorOffset;
125 uint64_t descriptorSize;
126 uint32_t numGTEsPerGT;
127 uint64_t rgdOffset;
128 uint64_t gdOffset;
129 uint64_t overHead;
130 bool uncleanShutdown;
131 char singleEndLineChar;
132 char nonEndLineChar;
133 char doubleEndLineChar1;
134 char doubleEndLineChar2;
135 uint16_t compressAlgorithm;
136 uint8_t pad[433];
137} SparseExtentHeader;
138#pragma pack()
139
140/** VMDK capacity for a single chunk when 2G splitting is turned on. Should be
141 * divisible by the default grain size (64K) */
142#define VMDK_2G_SPLIT_SIZE (2047 * 1024 * 1024)
143
144/** VMDK streamOptimized file format marker. The type field may or may not
145 * be actually valid, but there's always data to read there. */
146#pragma pack(1)
147typedef struct VMDKMARKER
148{
149 uint64_t uSector;
150 uint32_t cbSize;
151 uint32_t uType;
152} VMDKMARKER, *PVMDKMARKER;
153#pragma pack()
154
155
156#ifdef VBOX_WITH_VMDK_ESX
157
158/** @todo the ESX code is not tested, not used, and lacks error messages. */
159
160/**
161 * Magic number for images created by VMware GSX Server 3 or ESX Server 3.
162 */
163#define VMDK_ESX_SPARSE_MAGICNUMBER 0x44574f43 /* 'C' 'O' 'W' 'D' */
164
165#pragma pack(1)
166typedef struct COWDisk_Header
167{
168 uint32_t magicNumber;
169 uint32_t version;
170 uint32_t flags;
171 uint32_t numSectors;
172 uint32_t grainSize;
173 uint32_t gdOffset;
174 uint32_t numGDEntries;
175 uint32_t freeSector;
176 /* The spec incompletely documents quite a few further fields, but states
177 * that they are unused by the current format. Replace them by padding. */
178 char reserved1[1604];
179 uint32_t savedGeneration;
180 char reserved2[8];
181 uint32_t uncleanShutdown;
182 char padding[396];
183} COWDisk_Header;
184#pragma pack()
185#endif /* VBOX_WITH_VMDK_ESX */
186
187
188/** Convert sector number/size to byte offset/size. */
189#define VMDK_SECTOR2BYTE(u) ((uint64_t)(u) << 9)
190
191/** Convert byte offset/size to sector number/size. */
192#define VMDK_BYTE2SECTOR(u) ((u) >> 9)
193
194/**
195 * VMDK extent type.
196 */
197typedef enum VMDKETYPE
198{
199 /** Hosted sparse extent. */
200 VMDKETYPE_HOSTED_SPARSE = 1,
201 /** Flat extent. */
202 VMDKETYPE_FLAT,
203 /** Zero extent. */
204 VMDKETYPE_ZERO,
205 /** VMFS extent, used by ESX. */
206 VMDKETYPE_VMFS
207#ifdef VBOX_WITH_VMDK_ESX
208 ,
209 /** ESX sparse extent. */
210 VMDKETYPE_ESX_SPARSE
211#endif /* VBOX_WITH_VMDK_ESX */
212} VMDKETYPE, *PVMDKETYPE;
213
214/**
215 * VMDK access type for a extent.
216 */
217typedef enum VMDKACCESS
218{
219 /** No access allowed. */
220 VMDKACCESS_NOACCESS = 0,
221 /** Read-only access. */
222 VMDKACCESS_READONLY,
223 /** Read-write access. */
224 VMDKACCESS_READWRITE
225} VMDKACCESS, *PVMDKACCESS;
226
227/** Forward declaration for PVMDKIMAGE. */
228typedef struct VMDKIMAGE *PVMDKIMAGE;
229
230/**
231 * Extents files entry. Used for opening a particular file only once.
232 */
233typedef struct VMDKFILE
234{
235 /** Pointer to filename. Local copy. */
236 const char *pszFilename;
237 /** File open flags for consistency checking. */
238 unsigned fOpen;
239 /** Handle for sync/async file abstraction.*/
240 PVDIOSTORAGE pStorage;
241 /** Reference counter. */
242 unsigned uReferences;
243 /** Flag whether the file should be deleted on last close. */
244 bool fDelete;
245 /** Pointer to the image we belong to (for debugging purposes). */
246 PVMDKIMAGE pImage;
247 /** Pointer to next file descriptor. */
248 struct VMDKFILE *pNext;
249 /** Pointer to the previous file descriptor. */
250 struct VMDKFILE *pPrev;
251} VMDKFILE, *PVMDKFILE;
252
253/**
254 * VMDK extent data structure.
255 */
256typedef struct VMDKEXTENT
257{
258 /** File handle. */
259 PVMDKFILE pFile;
260 /** Base name of the image extent. */
261 const char *pszBasename;
262 /** Full name of the image extent. */
263 const char *pszFullname;
264 /** Number of sectors in this extent. */
265 uint64_t cSectors;
266 /** Number of sectors per block (grain in VMDK speak). */
267 uint64_t cSectorsPerGrain;
268 /** Starting sector number of descriptor. */
269 uint64_t uDescriptorSector;
270 /** Size of descriptor in sectors. */
271 uint64_t cDescriptorSectors;
272 /** Starting sector number of grain directory. */
273 uint64_t uSectorGD;
274 /** Starting sector number of redundant grain directory. */
275 uint64_t uSectorRGD;
276 /** Total number of metadata sectors. */
277 uint64_t cOverheadSectors;
278 /** Nominal size (i.e. as described by the descriptor) of this extent. */
279 uint64_t cNominalSectors;
280 /** Sector offset (i.e. as described by the descriptor) of this extent. */
281 uint64_t uSectorOffset;
282 /** Number of entries in a grain table. */
283 uint32_t cGTEntries;
284 /** Number of sectors reachable via a grain directory entry. */
285 uint32_t cSectorsPerGDE;
286 /** Number of entries in the grain directory. */
287 uint32_t cGDEntries;
288 /** Pointer to the next free sector. Legacy information. Do not use. */
289 uint32_t uFreeSector;
290 /** Number of this extent in the list of images. */
291 uint32_t uExtent;
292 /** Pointer to the descriptor (NULL if no descriptor in this extent). */
293 char *pDescData;
294 /** Pointer to the grain directory. */
295 uint32_t *pGD;
296 /** Pointer to the redundant grain directory. */
297 uint32_t *pRGD;
298 /** VMDK version of this extent. 1=1.0/1.1 */
299 uint32_t uVersion;
300 /** Type of this extent. */
301 VMDKETYPE enmType;
302 /** Access to this extent. */
303 VMDKACCESS enmAccess;
304 /** Flag whether this extent is marked as unclean. */
305 bool fUncleanShutdown;
306 /** Flag whether the metadata in the extent header needs to be updated. */
307 bool fMetaDirty;
308 /** Flag whether there is a footer in this extent. */
309 bool fFooter;
310 /** Compression type for this extent. */
311 uint16_t uCompression;
312 /** Append position for writing new grain. Only for sparse extents. */
313 uint64_t uAppendPosition;
314 /** Last grain which was accessed. Only for streamOptimized extents. */
315 uint32_t uLastGrainAccess;
316 /** Starting sector corresponding to the grain buffer. */
317 uint32_t uGrainSectorAbs;
318 /** Grain number corresponding to the grain buffer. */
319 uint32_t uGrain;
320 /** Actual size of the compressed data, only valid for reading. */
321 uint32_t cbGrainStreamRead;
322 /** Size of compressed grain buffer for streamOptimized extents. */
323 size_t cbCompGrain;
324 /** Compressed grain buffer for streamOptimized extents, with marker. */
325 void *pvCompGrain;
326 /** Decompressed grain buffer for streamOptimized extents. */
327 void *pvGrain;
328 /** Reference to the image in which this extent is used. Do not use this
329 * on a regular basis to avoid passing pImage references to functions
330 * explicitly. */
331 struct VMDKIMAGE *pImage;
332} VMDKEXTENT, *PVMDKEXTENT;
333
334/**
335 * Grain table cache size. Allocated per image.
336 */
337#define VMDK_GT_CACHE_SIZE 256
338
339/**
340 * Grain table block size. Smaller than an actual grain table block to allow
341 * more grain table blocks to be cached without having to allocate excessive
342 * amounts of memory for the cache.
343 */
344#define VMDK_GT_CACHELINE_SIZE 128
345
346
347/**
348 * Maximum number of lines in a descriptor file. Not worth the effort of
349 * making it variable. Descriptor files are generally very short (~20 lines),
350 * with the exception of sparse files split in 2G chunks, which need for the
351 * maximum size (almost 2T) exactly 1025 lines for the disk database.
352 */
353#define VMDK_DESCRIPTOR_LINES_MAX 1100U
354
355/**
356 * Parsed descriptor information. Allows easy access and update of the
357 * descriptor (whether separate file or not). Free form text files suck.
358 */
359typedef struct VMDKDESCRIPTOR
360{
361 /** Line number of first entry of the disk descriptor. */
362 unsigned uFirstDesc;
363 /** Line number of first entry in the extent description. */
364 unsigned uFirstExtent;
365 /** Line number of first disk database entry. */
366 unsigned uFirstDDB;
367 /** Total number of lines. */
368 unsigned cLines;
369 /** Total amount of memory available for the descriptor. */
370 size_t cbDescAlloc;
371 /** Set if descriptor has been changed and not yet written to disk. */
372 bool fDirty;
373 /** Array of pointers to the data in the descriptor. */
374 char *aLines[VMDK_DESCRIPTOR_LINES_MAX];
375 /** Array of line indices pointing to the next non-comment line. */
376 unsigned aNextLines[VMDK_DESCRIPTOR_LINES_MAX];
377} VMDKDESCRIPTOR, *PVMDKDESCRIPTOR;
378
379
380/**
381 * Cache entry for translating extent/sector to a sector number in that
382 * extent.
383 */
384typedef struct VMDKGTCACHEENTRY
385{
386 /** Extent number for which this entry is valid. */
387 uint32_t uExtent;
388 /** GT data block number. */
389 uint64_t uGTBlock;
390 /** Data part of the cache entry. */
391 uint32_t aGTData[VMDK_GT_CACHELINE_SIZE];
392} VMDKGTCACHEENTRY, *PVMDKGTCACHEENTRY;
393
394/**
395 * Cache data structure for blocks of grain table entries. For now this is a
396 * fixed size direct mapping cache, but this should be adapted to the size of
397 * the sparse image and maybe converted to a set-associative cache. The
398 * implementation below implements a write-through cache with write allocate.
399 */
400typedef struct VMDKGTCACHE
401{
402 /** Cache entries. */
403 VMDKGTCACHEENTRY aGTCache[VMDK_GT_CACHE_SIZE];
404 /** Number of cache entries (currently unused). */
405 unsigned cEntries;
406} VMDKGTCACHE, *PVMDKGTCACHE;
407
408/**
409 * Complete VMDK image data structure. Mainly a collection of extents and a few
410 * extra global data fields.
411 */
412typedef struct VMDKIMAGE
413{
414 /** Image name. */
415 const char *pszFilename;
416 /** Descriptor file if applicable. */
417 PVMDKFILE pFile;
418
419 /** Pointer to the per-disk VD interface list. */
420 PVDINTERFACE pVDIfsDisk;
421 /** Pointer to the per-image VD interface list. */
422 PVDINTERFACE pVDIfsImage;
423
424 /** Error interface. */
425 PVDINTERFACEERROR pIfError;
426 /** I/O interface. */
427 PVDINTERFACEIOINT pIfIo;
428
429
430 /** Pointer to the image extents. */
431 PVMDKEXTENT pExtents;
432 /** Number of image extents. */
433 unsigned cExtents;
434 /** Pointer to the files list, for opening a file referenced multiple
435 * times only once (happens mainly with raw partition access). */
436 PVMDKFILE pFiles;
437
438 /**
439 * Pointer to an array of segment entries for async I/O.
440 * This is an optimization because the task number to submit is not known
441 * and allocating/freeing an array in the read/write functions every time
442 * is too expensive.
443 */
444 PPDMDATASEG paSegments;
445 /** Entries available in the segments array. */
446 unsigned cSegments;
447
448 /** Open flags passed by VBoxHD layer. */
449 unsigned uOpenFlags;
450 /** Image flags defined during creation or determined during open. */
451 unsigned uImageFlags;
452 /** Total size of the image. */
453 uint64_t cbSize;
454 /** Physical geometry of this image. */
455 VDGEOMETRY PCHSGeometry;
456 /** Logical geometry of this image. */
457 VDGEOMETRY LCHSGeometry;
458 /** Image UUID. */
459 RTUUID ImageUuid;
460 /** Image modification UUID. */
461 RTUUID ModificationUuid;
462 /** Parent image UUID. */
463 RTUUID ParentUuid;
464 /** Parent image modification UUID. */
465 RTUUID ParentModificationUuid;
466
467 /** Pointer to grain table cache, if this image contains sparse extents. */
468 PVMDKGTCACHE pGTCache;
469 /** Pointer to the descriptor (NULL if no separate descriptor file). */
470 char *pDescData;
471 /** Allocation size of the descriptor file. */
472 size_t cbDescAlloc;
473 /** Parsed descriptor file content. */
474 VMDKDESCRIPTOR Descriptor;
475} VMDKIMAGE;
476
477
478/** State for the input/output callout of the inflate reader/deflate writer. */
479typedef struct VMDKCOMPRESSIO
480{
481 /* Image this operation relates to. */
482 PVMDKIMAGE pImage;
483 /* Current read position. */
484 ssize_t iOffset;
485 /* Size of the compressed grain buffer (available data). */
486 size_t cbCompGrain;
487 /* Pointer to the compressed grain buffer. */
488 void *pvCompGrain;
489} VMDKCOMPRESSIO;
490
491
492/** Tracks async grain allocation. */
493typedef struct VMDKGRAINALLOCASYNC
494{
495 /** Flag whether the allocation failed. */
496 bool fIoErr;
497 /** Current number of transfers pending.
498 * If reached 0 and there is an error the old state is restored. */
499 unsigned cIoXfersPending;
500 /** Sector number */
501 uint64_t uSector;
502 /** Flag whether the grain table needs to be updated. */
503 bool fGTUpdateNeeded;
504 /** Extent the allocation happens. */
505 PVMDKEXTENT pExtent;
506 /** Position of the new grain, required for the grain table update. */
507 uint64_t uGrainOffset;
508 /** Grain table sector. */
509 uint64_t uGTSector;
510 /** Backup grain table sector. */
511 uint64_t uRGTSector;
512} VMDKGRAINALLOCASYNC, *PVMDKGRAINALLOCASYNC;
513
514
515/*********************************************************************************************************************************
516* Static Variables *
517*********************************************************************************************************************************/
518
519/** NULL-terminated array of supported file extensions. */
520static const VDFILEEXTENSION s_aVmdkFileExtensions[] =
521{
522 {"vmdk", VDTYPE_HDD},
523 {NULL, VDTYPE_INVALID}
524};
525
526
527/*********************************************************************************************************************************
528* Internal Functions *
529*********************************************************************************************************************************/
530
531static void vmdkFreeStreamBuffers(PVMDKEXTENT pExtent);
532static int vmdkFreeExtentData(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
533 bool fDelete);
534
535static int vmdkCreateExtents(PVMDKIMAGE pImage, unsigned cExtents);
536static int vmdkFlushImage(PVMDKIMAGE pImage, PVDIOCTX pIoCtx);
537static int vmdkSetImageComment(PVMDKIMAGE pImage, const char *pszComment);
538static int vmdkFreeImage(PVMDKIMAGE pImage, bool fDelete);
539
540static DECLCALLBACK(int) vmdkAllocGrainComplete(void *pBackendData, PVDIOCTX pIoCtx,
541 void *pvUser, int rcReq);
542
543/**
544 * Internal: open a file (using a file descriptor cache to ensure each file
545 * is only opened once - anything else can cause locking problems).
546 */
547static int vmdkFileOpen(PVMDKIMAGE pImage, PVMDKFILE *ppVmdkFile,
548 const char *pszFilename, uint32_t fOpen)
549{
550 int rc = VINF_SUCCESS;
551 PVMDKFILE pVmdkFile;
552
553 for (pVmdkFile = pImage->pFiles;
554 pVmdkFile != NULL;
555 pVmdkFile = pVmdkFile->pNext)
556 {
557 if (!strcmp(pszFilename, pVmdkFile->pszFilename))
558 {
559 Assert(fOpen == pVmdkFile->fOpen);
560 pVmdkFile->uReferences++;
561
562 *ppVmdkFile = pVmdkFile;
563
564 return rc;
565 }
566 }
567
568 /* If we get here, there's no matching entry in the cache. */
569 pVmdkFile = (PVMDKFILE)RTMemAllocZ(sizeof(VMDKFILE));
570 if (!pVmdkFile)
571 {
572 *ppVmdkFile = NULL;
573 return VERR_NO_MEMORY;
574 }
575
576 pVmdkFile->pszFilename = RTStrDup(pszFilename);
577 if (!pVmdkFile->pszFilename)
578 {
579 RTMemFree(pVmdkFile);
580 *ppVmdkFile = NULL;
581 return VERR_NO_MEMORY;
582 }
583 pVmdkFile->fOpen = fOpen;
584
585 rc = vdIfIoIntFileOpen(pImage->pIfIo, pszFilename, fOpen,
586 &pVmdkFile->pStorage);
587 if (RT_SUCCESS(rc))
588 {
589 pVmdkFile->uReferences = 1;
590 pVmdkFile->pImage = pImage;
591 pVmdkFile->pNext = pImage->pFiles;
592 if (pImage->pFiles)
593 pImage->pFiles->pPrev = pVmdkFile;
594 pImage->pFiles = pVmdkFile;
595 *ppVmdkFile = pVmdkFile;
596 }
597 else
598 {
599 RTStrFree((char *)(void *)pVmdkFile->pszFilename);
600 RTMemFree(pVmdkFile);
601 *ppVmdkFile = NULL;
602 }
603
604 return rc;
605}
606
607/**
608 * Internal: close a file, updating the file descriptor cache.
609 */
610static int vmdkFileClose(PVMDKIMAGE pImage, PVMDKFILE *ppVmdkFile, bool fDelete)
611{
612 int rc = VINF_SUCCESS;
613 PVMDKFILE pVmdkFile = *ppVmdkFile;
614
615 AssertPtr(pVmdkFile);
616
617 pVmdkFile->fDelete |= fDelete;
618 Assert(pVmdkFile->uReferences);
619 pVmdkFile->uReferences--;
620 if (pVmdkFile->uReferences == 0)
621 {
622 PVMDKFILE pPrev;
623 PVMDKFILE pNext;
624
625 /* Unchain the element from the list. */
626 pPrev = pVmdkFile->pPrev;
627 pNext = pVmdkFile->pNext;
628
629 if (pNext)
630 pNext->pPrev = pPrev;
631 if (pPrev)
632 pPrev->pNext = pNext;
633 else
634 pImage->pFiles = pNext;
635
636 rc = vdIfIoIntFileClose(pImage->pIfIo, pVmdkFile->pStorage);
637 if (RT_SUCCESS(rc) && pVmdkFile->fDelete)
638 rc = vdIfIoIntFileDelete(pImage->pIfIo, pVmdkFile->pszFilename);
639 RTStrFree((char *)(void *)pVmdkFile->pszFilename);
640 RTMemFree(pVmdkFile);
641 }
642
643 *ppVmdkFile = NULL;
644 return rc;
645}
646
647/*#define VMDK_USE_BLOCK_DECOMP_API - test and enable */
648#ifndef VMDK_USE_BLOCK_DECOMP_API
649static DECLCALLBACK(int) vmdkFileInflateHelper(void *pvUser, void *pvBuf, size_t cbBuf, size_t *pcbBuf)
650{
651 VMDKCOMPRESSIO *pInflateState = (VMDKCOMPRESSIO *)pvUser;
652 size_t cbInjected = 0;
653
654 Assert(cbBuf);
655 if (pInflateState->iOffset < 0)
656 {
657 *(uint8_t *)pvBuf = RTZIPTYPE_ZLIB;
658 pvBuf = (uint8_t *)pvBuf + 1;
659 cbBuf--;
660 cbInjected = 1;
661 pInflateState->iOffset = RT_OFFSETOF(VMDKMARKER, uType);
662 }
663 if (!cbBuf)
664 {
665 if (pcbBuf)
666 *pcbBuf = cbInjected;
667 return VINF_SUCCESS;
668 }
669 cbBuf = RT_MIN(cbBuf, pInflateState->cbCompGrain - pInflateState->iOffset);
670 memcpy(pvBuf,
671 (uint8_t *)pInflateState->pvCompGrain + pInflateState->iOffset,
672 cbBuf);
673 pInflateState->iOffset += cbBuf;
674 Assert(pcbBuf);
675 *pcbBuf = cbBuf + cbInjected;
676 return VINF_SUCCESS;
677}
678#endif
679
680/**
681 * Internal: read from a file and inflate the compressed data,
682 * distinguishing between async and normal operation
683 */
684DECLINLINE(int) vmdkFileInflateSync(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
685 uint64_t uOffset, void *pvBuf,
686 size_t cbToRead, const void *pcvMarker,
687 uint64_t *puLBA, uint32_t *pcbMarkerData)
688{
689 int rc;
690#ifndef VMDK_USE_BLOCK_DECOMP_API
691 PRTZIPDECOMP pZip = NULL;
692#endif
693 VMDKMARKER *pMarker = (VMDKMARKER *)pExtent->pvCompGrain;
694 size_t cbCompSize, cbActuallyRead;
695
696 if (!pcvMarker)
697 {
698 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
699 uOffset, pMarker, RT_OFFSETOF(VMDKMARKER, uType));
700 if (RT_FAILURE(rc))
701 return rc;
702 }
703 else
704 {
705 memcpy(pMarker, pcvMarker, RT_OFFSETOF(VMDKMARKER, uType));
706 /* pcvMarker endianness has already been partially transformed, fix it */
707 pMarker->uSector = RT_H2LE_U64(pMarker->uSector);
708 pMarker->cbSize = RT_H2LE_U32(pMarker->cbSize);
709 }
710
711 cbCompSize = RT_LE2H_U32(pMarker->cbSize);
712 if (cbCompSize == 0)
713 {
714 AssertMsgFailed(("VMDK: corrupted marker\n"));
715 return VERR_VD_VMDK_INVALID_FORMAT;
716 }
717
718 /* Sanity check - the expansion ratio should be much less than 2. */
719 Assert(cbCompSize < 2 * cbToRead);
720 if (cbCompSize >= 2 * cbToRead)
721 return VERR_VD_VMDK_INVALID_FORMAT;
722
723 /* Compressed grain marker. Data follows immediately. */
724 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
725 uOffset + RT_OFFSETOF(VMDKMARKER, uType),
726 (uint8_t *)pExtent->pvCompGrain
727 + RT_OFFSETOF(VMDKMARKER, uType),
728 RT_ALIGN_Z( cbCompSize
729 + RT_OFFSETOF(VMDKMARKER, uType),
730 512)
731 - RT_OFFSETOF(VMDKMARKER, uType));
732
733 if (puLBA)
734 *puLBA = RT_LE2H_U64(pMarker->uSector);
735 if (pcbMarkerData)
736 *pcbMarkerData = RT_ALIGN( cbCompSize
737 + RT_OFFSETOF(VMDKMARKER, uType),
738 512);
739
740#ifdef VMDK_USE_BLOCK_DECOMP_API
741 rc = RTZipBlockDecompress(RTZIPTYPE_ZLIB, 0 /*fFlags*/,
742 pExtent->pvCompGrain, cbCompSize + RT_OFFSETOF(VMDKMARKER, uType), NULL,
743 pvBuf, cbToRead, &cbActuallyRead);
744#else
745 VMDKCOMPRESSIO InflateState;
746 InflateState.pImage = pImage;
747 InflateState.iOffset = -1;
748 InflateState.cbCompGrain = cbCompSize + RT_OFFSETOF(VMDKMARKER, uType);
749 InflateState.pvCompGrain = pExtent->pvCompGrain;
750
751 rc = RTZipDecompCreate(&pZip, &InflateState, vmdkFileInflateHelper);
752 if (RT_FAILURE(rc))
753 return rc;
754 rc = RTZipDecompress(pZip, pvBuf, cbToRead, &cbActuallyRead);
755 RTZipDecompDestroy(pZip);
756#endif /* !VMDK_USE_BLOCK_DECOMP_API */
757 if (RT_FAILURE(rc))
758 {
759 if (rc == VERR_ZIP_CORRUPTED)
760 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: Compressed image is corrupted '%s'"), pExtent->pszFullname);
761 return rc;
762 }
763 if (cbActuallyRead != cbToRead)
764 rc = VERR_VD_VMDK_INVALID_FORMAT;
765 return rc;
766}
767
768static DECLCALLBACK(int) vmdkFileDeflateHelper(void *pvUser, const void *pvBuf, size_t cbBuf)
769{
770 VMDKCOMPRESSIO *pDeflateState = (VMDKCOMPRESSIO *)pvUser;
771
772 Assert(cbBuf);
773 if (pDeflateState->iOffset < 0)
774 {
775 pvBuf = (const uint8_t *)pvBuf + 1;
776 cbBuf--;
777 pDeflateState->iOffset = RT_OFFSETOF(VMDKMARKER, uType);
778 }
779 if (!cbBuf)
780 return VINF_SUCCESS;
781 if (pDeflateState->iOffset + cbBuf > pDeflateState->cbCompGrain)
782 return VERR_BUFFER_OVERFLOW;
783 memcpy((uint8_t *)pDeflateState->pvCompGrain + pDeflateState->iOffset,
784 pvBuf, cbBuf);
785 pDeflateState->iOffset += cbBuf;
786 return VINF_SUCCESS;
787}
788
789/**
790 * Internal: deflate the uncompressed data and write to a file,
791 * distinguishing between async and normal operation
792 */
793DECLINLINE(int) vmdkFileDeflateSync(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
794 uint64_t uOffset, const void *pvBuf,
795 size_t cbToWrite, uint64_t uLBA,
796 uint32_t *pcbMarkerData)
797{
798 int rc;
799 PRTZIPCOMP pZip = NULL;
800 VMDKCOMPRESSIO DeflateState;
801
802 DeflateState.pImage = pImage;
803 DeflateState.iOffset = -1;
804 DeflateState.cbCompGrain = pExtent->cbCompGrain;
805 DeflateState.pvCompGrain = pExtent->pvCompGrain;
806
807 rc = RTZipCompCreate(&pZip, &DeflateState, vmdkFileDeflateHelper,
808 RTZIPTYPE_ZLIB, RTZIPLEVEL_DEFAULT);
809 if (RT_FAILURE(rc))
810 return rc;
811 rc = RTZipCompress(pZip, pvBuf, cbToWrite);
812 if (RT_SUCCESS(rc))
813 rc = RTZipCompFinish(pZip);
814 RTZipCompDestroy(pZip);
815 if (RT_SUCCESS(rc))
816 {
817 Assert( DeflateState.iOffset > 0
818 && (size_t)DeflateState.iOffset <= DeflateState.cbCompGrain);
819
820 /* pad with zeroes to get to a full sector size */
821 uint32_t uSize = DeflateState.iOffset;
822 if (uSize % 512)
823 {
824 uint32_t uSizeAlign = RT_ALIGN(uSize, 512);
825 memset((uint8_t *)pExtent->pvCompGrain + uSize, '\0',
826 uSizeAlign - uSize);
827 uSize = uSizeAlign;
828 }
829
830 if (pcbMarkerData)
831 *pcbMarkerData = uSize;
832
833 /* Compressed grain marker. Data follows immediately. */
834 VMDKMARKER *pMarker = (VMDKMARKER *)pExtent->pvCompGrain;
835 pMarker->uSector = RT_H2LE_U64(uLBA);
836 pMarker->cbSize = RT_H2LE_U32( DeflateState.iOffset
837 - RT_OFFSETOF(VMDKMARKER, uType));
838 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage,
839 uOffset, pMarker, uSize);
840 if (RT_FAILURE(rc))
841 return rc;
842 }
843 return rc;
844}
845
846
847/**
848 * Internal: check if all files are closed, prevent leaking resources.
849 */
850static int vmdkFileCheckAllClose(PVMDKIMAGE pImage)
851{
852 int rc = VINF_SUCCESS, rc2;
853 PVMDKFILE pVmdkFile;
854
855 Assert(pImage->pFiles == NULL);
856 for (pVmdkFile = pImage->pFiles;
857 pVmdkFile != NULL;
858 pVmdkFile = pVmdkFile->pNext)
859 {
860 LogRel(("VMDK: leaking reference to file \"%s\"\n",
861 pVmdkFile->pszFilename));
862 pImage->pFiles = pVmdkFile->pNext;
863
864 rc2 = vmdkFileClose(pImage, &pVmdkFile, pVmdkFile->fDelete);
865
866 if (RT_SUCCESS(rc))
867 rc = rc2;
868 }
869 return rc;
870}
871
872/**
873 * Internal: truncate a string (at a UTF8 code point boundary) and encode the
874 * critical non-ASCII characters.
875 */
876static char *vmdkEncodeString(const char *psz)
877{
878 char szEnc[VMDK_ENCODED_COMMENT_MAX + 3];
879 char *pszDst = szEnc;
880
881 AssertPtr(psz);
882
883 for (; *psz; psz = RTStrNextCp(psz))
884 {
885 char *pszDstPrev = pszDst;
886 RTUNICP Cp = RTStrGetCp(psz);
887 if (Cp == '\\')
888 {
889 pszDst = RTStrPutCp(pszDst, Cp);
890 pszDst = RTStrPutCp(pszDst, Cp);
891 }
892 else if (Cp == '\n')
893 {
894 pszDst = RTStrPutCp(pszDst, '\\');
895 pszDst = RTStrPutCp(pszDst, 'n');
896 }
897 else if (Cp == '\r')
898 {
899 pszDst = RTStrPutCp(pszDst, '\\');
900 pszDst = RTStrPutCp(pszDst, 'r');
901 }
902 else
903 pszDst = RTStrPutCp(pszDst, Cp);
904 if (pszDst - szEnc >= VMDK_ENCODED_COMMENT_MAX - 1)
905 {
906 pszDst = pszDstPrev;
907 break;
908 }
909 }
910 *pszDst = '\0';
911 return RTStrDup(szEnc);
912}
913
914/**
915 * Internal: decode a string and store it into the specified string.
916 */
917static int vmdkDecodeString(const char *pszEncoded, char *psz, size_t cb)
918{
919 int rc = VINF_SUCCESS;
920 char szBuf[4];
921
922 if (!cb)
923 return VERR_BUFFER_OVERFLOW;
924
925 AssertPtr(psz);
926
927 for (; *pszEncoded; pszEncoded = RTStrNextCp(pszEncoded))
928 {
929 char *pszDst = szBuf;
930 RTUNICP Cp = RTStrGetCp(pszEncoded);
931 if (Cp == '\\')
932 {
933 pszEncoded = RTStrNextCp(pszEncoded);
934 RTUNICP CpQ = RTStrGetCp(pszEncoded);
935 if (CpQ == 'n')
936 RTStrPutCp(pszDst, '\n');
937 else if (CpQ == 'r')
938 RTStrPutCp(pszDst, '\r');
939 else if (CpQ == '\0')
940 {
941 rc = VERR_VD_VMDK_INVALID_HEADER;
942 break;
943 }
944 else
945 RTStrPutCp(pszDst, CpQ);
946 }
947 else
948 pszDst = RTStrPutCp(pszDst, Cp);
949
950 /* Need to leave space for terminating NUL. */
951 if ((size_t)(pszDst - szBuf) + 1 >= cb)
952 {
953 rc = VERR_BUFFER_OVERFLOW;
954 break;
955 }
956 memcpy(psz, szBuf, pszDst - szBuf);
957 psz += pszDst - szBuf;
958 }
959 *psz = '\0';
960 return rc;
961}
962
963/**
964 * Internal: free all buffers associated with grain directories.
965 */
966static void vmdkFreeGrainDirectory(PVMDKEXTENT pExtent)
967{
968 if (pExtent->pGD)
969 {
970 RTMemFree(pExtent->pGD);
971 pExtent->pGD = NULL;
972 }
973 if (pExtent->pRGD)
974 {
975 RTMemFree(pExtent->pRGD);
976 pExtent->pRGD = NULL;
977 }
978}
979
980/**
981 * Internal: allocate the compressed/uncompressed buffers for streamOptimized
982 * images.
983 */
984static int vmdkAllocStreamBuffers(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
985{
986 int rc = VINF_SUCCESS;
987
988 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
989 {
990 /* streamOptimized extents need a compressed grain buffer, which must
991 * be big enough to hold uncompressible data (which needs ~8 bytes
992 * more than the uncompressed data), the marker and padding. */
993 pExtent->cbCompGrain = RT_ALIGN_Z( VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain)
994 + 8 + sizeof(VMDKMARKER), 512);
995 pExtent->pvCompGrain = RTMemAlloc(pExtent->cbCompGrain);
996 if (!pExtent->pvCompGrain)
997 {
998 rc = VERR_NO_MEMORY;
999 goto out;
1000 }
1001
1002 /* streamOptimized extents need a decompressed grain buffer. */
1003 pExtent->pvGrain = RTMemAlloc(VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain));
1004 if (!pExtent->pvGrain)
1005 {
1006 rc = VERR_NO_MEMORY;
1007 goto out;
1008 }
1009 }
1010
1011out:
1012 if (RT_FAILURE(rc))
1013 vmdkFreeStreamBuffers(pExtent);
1014 return rc;
1015}
1016
1017/**
1018 * Internal: allocate all buffers associated with grain directories.
1019 */
1020static int vmdkAllocGrainDirectory(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
1021{
1022 int rc = VINF_SUCCESS;
1023 size_t cbGD = pExtent->cGDEntries * sizeof(uint32_t);
1024 /** @todo r=bird: This code is unnecessarily confusing pointer states with
1025 * (1) unnecessary initialization of locals, (2) unnecesarily wide
1026 * scoping of variables, (3) instance on goto code structure. Also,
1027 * having two initialized variables on one line decreases readability. */
1028 uint32_t *pGD = NULL, *pRGD = NULL;
1029
1030 pGD = (uint32_t *)RTMemAllocZ(cbGD);
1031 if (!pGD)
1032 {
1033 rc = VERR_NO_MEMORY;
1034 goto out;
1035 }
1036 pExtent->pGD = pGD;
1037
1038 if (pExtent->uSectorRGD)
1039 {
1040 pRGD = (uint32_t *)RTMemAllocZ(cbGD);
1041 if (!pRGD)
1042 {
1043 rc = VERR_NO_MEMORY;
1044 goto out;
1045 }
1046 pExtent->pRGD = pRGD;
1047 }
1048
1049out:
1050 if (RT_FAILURE(rc))
1051 vmdkFreeGrainDirectory(pExtent);
1052 return rc;
1053}
1054
1055static int vmdkReadGrainDirectory(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
1056{
1057 int rc = VINF_SUCCESS;
1058 size_t i;
1059 uint32_t *pGDTmp, *pRGDTmp;
1060 size_t cbGD = pExtent->cGDEntries * sizeof(uint32_t);
1061
1062 if (pExtent->enmType != VMDKETYPE_HOSTED_SPARSE)
1063 goto out;
1064
1065 if ( pExtent->uSectorGD == VMDK_GD_AT_END
1066 || pExtent->uSectorRGD == VMDK_GD_AT_END)
1067 {
1068 rc = VERR_INTERNAL_ERROR;
1069 goto out;
1070 }
1071
1072 rc = vmdkAllocGrainDirectory(pImage, pExtent);
1073 if (RT_FAILURE(rc))
1074 goto out;
1075
1076 /* The VMDK 1.1 spec seems to talk about compressed grain directories,
1077 * but in reality they are not compressed. */
1078 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
1079 VMDK_SECTOR2BYTE(pExtent->uSectorGD),
1080 pExtent->pGD, cbGD);
1081 AssertRC(rc);
1082 if (RT_FAILURE(rc))
1083 {
1084 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1085 N_("VMDK: could not read grain directory in '%s': %Rrc"), pExtent->pszFullname, rc);
1086 goto out;
1087 }
1088 for (i = 0, pGDTmp = pExtent->pGD; i < pExtent->cGDEntries; i++, pGDTmp++)
1089 *pGDTmp = RT_LE2H_U32(*pGDTmp);
1090
1091 if ( pExtent->uSectorRGD
1092 && !(pImage->uOpenFlags & VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS))
1093 {
1094 /* The VMDK 1.1 spec seems to talk about compressed grain directories,
1095 * but in reality they are not compressed. */
1096 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
1097 VMDK_SECTOR2BYTE(pExtent->uSectorRGD),
1098 pExtent->pRGD, cbGD);
1099 AssertRC(rc);
1100 if (RT_FAILURE(rc))
1101 {
1102 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1103 N_("VMDK: could not read redundant grain directory in '%s'"), pExtent->pszFullname);
1104 goto out;
1105 }
1106 for (i = 0, pRGDTmp = pExtent->pRGD; i < pExtent->cGDEntries; i++, pRGDTmp++)
1107 *pRGDTmp = RT_LE2H_U32(*pRGDTmp);
1108
1109 /* Check grain table and redundant grain table for consistency. */
1110 size_t cbGT = pExtent->cGTEntries * sizeof(uint32_t);
1111 size_t cbGTBuffers = cbGT; /* Start with space for one GT. */
1112 size_t cbGTBuffersMax = _1M;
1113
1114 uint32_t *pTmpGT1 = (uint32_t *)RTMemAlloc(cbGTBuffers);
1115 uint32_t *pTmpGT2 = (uint32_t *)RTMemAlloc(cbGTBuffers);
1116
1117 if ( !pTmpGT1
1118 || !pTmpGT2)
1119 rc = VERR_NO_MEMORY;
1120
1121 i = 0;
1122 pGDTmp = pExtent->pGD;
1123 pRGDTmp = pExtent->pRGD;
1124
1125 /* Loop through all entries. */
1126 while (i < pExtent->cGDEntries)
1127 {
1128 uint32_t uGTStart = *pGDTmp;
1129 uint32_t uRGTStart = *pRGDTmp;
1130 size_t cbGTRead = cbGT;
1131
1132 /* If no grain table is allocated skip the entry. */
1133 if (*pGDTmp == 0 && *pRGDTmp == 0)
1134 {
1135 i++;
1136 continue;
1137 }
1138
1139 if (*pGDTmp == 0 || *pRGDTmp == 0 || *pGDTmp == *pRGDTmp)
1140 {
1141 /* Just one grain directory entry refers to a not yet allocated
1142 * grain table or both grain directory copies refer to the same
1143 * grain table. Not allowed. */
1144 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: inconsistent references to grain directory in '%s'"), pExtent->pszFullname);
1145 break;
1146 }
1147
1148 i++;
1149 pGDTmp++;
1150 pRGDTmp++;
1151
1152 /*
1153 * Read a few tables at once if adjacent to decrease the number
1154 * of I/O requests. Read at maximum 1MB at once.
1155 */
1156 while ( i < pExtent->cGDEntries
1157 && cbGTRead < cbGTBuffersMax)
1158 {
1159 /* If no grain table is allocated skip the entry. */
1160 if (*pGDTmp == 0 && *pRGDTmp == 0)
1161 continue;
1162
1163 if (*pGDTmp == 0 || *pRGDTmp == 0 || *pGDTmp == *pRGDTmp)
1164 {
1165 /* Just one grain directory entry refers to a not yet allocated
1166 * grain table or both grain directory copies refer to the same
1167 * grain table. Not allowed. */
1168 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: inconsistent references to grain directory in '%s'"), pExtent->pszFullname);
1169 break;
1170 }
1171
1172 /* Check that the start offsets are adjacent.*/
1173 if ( VMDK_SECTOR2BYTE(uGTStart) + cbGTRead != VMDK_SECTOR2BYTE(*pGDTmp)
1174 || VMDK_SECTOR2BYTE(uRGTStart) + cbGTRead != VMDK_SECTOR2BYTE(*pRGDTmp))
1175 break;
1176
1177 i++;
1178 pGDTmp++;
1179 pRGDTmp++;
1180 cbGTRead += cbGT;
1181 }
1182
1183 /* Increase buffers if required. */
1184 if ( RT_SUCCESS(rc)
1185 && cbGTBuffers < cbGTRead)
1186 {
1187 uint32_t *pTmp;
1188 pTmp = (uint32_t *)RTMemRealloc(pTmpGT1, cbGTRead);
1189 if (pTmp)
1190 {
1191 pTmpGT1 = pTmp;
1192 pTmp = (uint32_t *)RTMemRealloc(pTmpGT2, cbGTRead);
1193 if (pTmp)
1194 pTmpGT2 = pTmp;
1195 else
1196 rc = VERR_NO_MEMORY;
1197 }
1198 else
1199 rc = VERR_NO_MEMORY;
1200
1201 if (rc == VERR_NO_MEMORY)
1202 {
1203 /* Reset to the old values. */
1204 rc = VINF_SUCCESS;
1205 i -= cbGTRead / cbGT;
1206 cbGTRead = cbGT;
1207
1208 /* Don't try to increase the buffer again in the next run. */
1209 cbGTBuffersMax = cbGTBuffers;
1210 }
1211 }
1212
1213 if (RT_SUCCESS(rc))
1214 {
1215 /* The VMDK 1.1 spec seems to talk about compressed grain tables,
1216 * but in reality they are not compressed. */
1217 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
1218 VMDK_SECTOR2BYTE(uGTStart),
1219 pTmpGT1, cbGTRead);
1220 if (RT_FAILURE(rc))
1221 {
1222 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1223 N_("VMDK: error reading grain table in '%s'"), pExtent->pszFullname);
1224 break;
1225 }
1226 /* The VMDK 1.1 spec seems to talk about compressed grain tables,
1227 * but in reality they are not compressed. */
1228 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
1229 VMDK_SECTOR2BYTE(uRGTStart),
1230 pTmpGT2, cbGTRead);
1231 if (RT_FAILURE(rc))
1232 {
1233 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS,
1234 N_("VMDK: error reading backup grain table in '%s'"), pExtent->pszFullname);
1235 break;
1236 }
1237 if (memcmp(pTmpGT1, pTmpGT2, cbGTRead))
1238 {
1239 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS,
1240 N_("VMDK: inconsistency between grain table and backup grain table in '%s'"), pExtent->pszFullname);
1241 break;
1242 }
1243 }
1244 } /* while (i < pExtent->cGDEntries) */
1245
1246 /** @todo figure out what to do for unclean VMDKs. */
1247 if (pTmpGT1)
1248 RTMemFree(pTmpGT1);
1249 if (pTmpGT2)
1250 RTMemFree(pTmpGT2);
1251 }
1252
1253out:
1254 if (RT_FAILURE(rc))
1255 vmdkFreeGrainDirectory(pExtent);
1256 return rc;
1257}
1258
1259static int vmdkCreateGrainDirectory(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
1260 uint64_t uStartSector, bool fPreAlloc)
1261{
1262 int rc = VINF_SUCCESS;
1263 unsigned i;
1264 size_t cbGD = pExtent->cGDEntries * sizeof(uint32_t);
1265 size_t cbGDRounded = RT_ALIGN_64(cbGD, 512);
1266 size_t cbGTRounded;
1267 uint64_t cbOverhead;
1268
1269 if (fPreAlloc)
1270 {
1271 cbGTRounded = RT_ALIGN_64(pExtent->cGDEntries * pExtent->cGTEntries * sizeof(uint32_t), 512);
1272 cbOverhead = VMDK_SECTOR2BYTE(uStartSector) + cbGDRounded
1273 + cbGTRounded;
1274 }
1275 else
1276 {
1277 /* Use a dummy start sector for layout computation. */
1278 if (uStartSector == VMDK_GD_AT_END)
1279 uStartSector = 1;
1280 cbGTRounded = 0;
1281 cbOverhead = VMDK_SECTOR2BYTE(uStartSector) + cbGDRounded;
1282 }
1283
1284 /* For streamOptimized extents there is only one grain directory,
1285 * and for all others take redundant grain directory into account. */
1286 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
1287 {
1288 cbOverhead = RT_ALIGN_64(cbOverhead,
1289 VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain));
1290 }
1291 else
1292 {
1293 cbOverhead += cbGDRounded + cbGTRounded;
1294 cbOverhead = RT_ALIGN_64(cbOverhead,
1295 VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain));
1296 rc = vdIfIoIntFileSetSize(pImage->pIfIo, pExtent->pFile->pStorage, cbOverhead);
1297 }
1298 if (RT_FAILURE(rc))
1299 goto out;
1300 pExtent->uAppendPosition = cbOverhead;
1301 pExtent->cOverheadSectors = VMDK_BYTE2SECTOR(cbOverhead);
1302
1303 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
1304 {
1305 pExtent->uSectorRGD = 0;
1306 pExtent->uSectorGD = uStartSector;
1307 }
1308 else
1309 {
1310 pExtent->uSectorRGD = uStartSector;
1311 pExtent->uSectorGD = uStartSector + VMDK_BYTE2SECTOR(cbGDRounded + cbGTRounded);
1312 }
1313
1314 rc = vmdkAllocStreamBuffers(pImage, pExtent);
1315 if (RT_FAILURE(rc))
1316 goto out;
1317
1318 rc = vmdkAllocGrainDirectory(pImage, pExtent);
1319 if (RT_FAILURE(rc))
1320 goto out;
1321
1322 if (fPreAlloc)
1323 {
1324 uint32_t uGTSectorLE;
1325 uint64_t uOffsetSectors;
1326
1327 if (pExtent->pRGD)
1328 {
1329 uOffsetSectors = pExtent->uSectorRGD + VMDK_BYTE2SECTOR(cbGDRounded);
1330 for (i = 0; i < pExtent->cGDEntries; i++)
1331 {
1332 pExtent->pRGD[i] = uOffsetSectors;
1333 uGTSectorLE = RT_H2LE_U64(uOffsetSectors);
1334 /* Write the redundant grain directory entry to disk. */
1335 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage,
1336 VMDK_SECTOR2BYTE(pExtent->uSectorRGD) + i * sizeof(uGTSectorLE),
1337 &uGTSectorLE, sizeof(uGTSectorLE));
1338 if (RT_FAILURE(rc))
1339 {
1340 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write new redundant grain directory entry in '%s'"), pExtent->pszFullname);
1341 goto out;
1342 }
1343 uOffsetSectors += VMDK_BYTE2SECTOR(pExtent->cGTEntries * sizeof(uint32_t));
1344 }
1345 }
1346
1347 uOffsetSectors = pExtent->uSectorGD + VMDK_BYTE2SECTOR(cbGDRounded);
1348 for (i = 0; i < pExtent->cGDEntries; i++)
1349 {
1350 pExtent->pGD[i] = uOffsetSectors;
1351 uGTSectorLE = RT_H2LE_U64(uOffsetSectors);
1352 /* Write the grain directory entry to disk. */
1353 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage,
1354 VMDK_SECTOR2BYTE(pExtent->uSectorGD) + i * sizeof(uGTSectorLE),
1355 &uGTSectorLE, sizeof(uGTSectorLE));
1356 if (RT_FAILURE(rc))
1357 {
1358 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write new grain directory entry in '%s'"), pExtent->pszFullname);
1359 goto out;
1360 }
1361 uOffsetSectors += VMDK_BYTE2SECTOR(pExtent->cGTEntries * sizeof(uint32_t));
1362 }
1363 }
1364
1365out:
1366 if (RT_FAILURE(rc))
1367 vmdkFreeGrainDirectory(pExtent);
1368 return rc;
1369}
1370
1371/**
1372 * @param ppszUnquoted Where to store the return value, use RTMemTmpFree to
1373 * free.
1374 */
1375static int vmdkStringUnquote(PVMDKIMAGE pImage, const char *pszStr,
1376 char **ppszUnquoted, char **ppszNext)
1377{
1378 char *pszQ;
1379 char *pszUnquoted;
1380
1381 /* Skip over whitespace. */
1382 while (*pszStr == ' ' || *pszStr == '\t')
1383 pszStr++;
1384
1385 if (*pszStr != '"')
1386 {
1387 pszQ = (char *)pszStr;
1388 while (*pszQ && *pszQ != ' ' && *pszQ != '\t')
1389 pszQ++;
1390 }
1391 else
1392 {
1393 pszStr++;
1394 pszQ = (char *)strchr(pszStr, '"');
1395 if (pszQ == NULL)
1396 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrectly quoted value in descriptor in '%s'"), pImage->pszFilename);
1397 }
1398
1399 pszUnquoted = (char *)RTMemTmpAlloc(pszQ - pszStr + 1);
1400 if (!pszUnquoted)
1401 return VERR_NO_MEMORY;
1402 memcpy(pszUnquoted, pszStr, pszQ - pszStr);
1403 pszUnquoted[pszQ - pszStr] = '\0';
1404 *ppszUnquoted = pszUnquoted;
1405 if (ppszNext)
1406 *ppszNext = pszQ + 1;
1407 return VINF_SUCCESS;
1408}
1409
1410static int vmdkDescInitStr(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1411 const char *pszLine)
1412{
1413 char *pEnd = pDescriptor->aLines[pDescriptor->cLines];
1414 ssize_t cbDiff = strlen(pszLine) + 1;
1415
1416 if ( pDescriptor->cLines >= VMDK_DESCRIPTOR_LINES_MAX - 1
1417 && pEnd - pDescriptor->aLines[0] > (ptrdiff_t)pDescriptor->cbDescAlloc - cbDiff)
1418 return vdIfError(pImage->pIfError, VERR_BUFFER_OVERFLOW, RT_SRC_POS, N_("VMDK: descriptor too big in '%s'"), pImage->pszFilename);
1419
1420 memcpy(pEnd, pszLine, cbDiff);
1421 pDescriptor->cLines++;
1422 pDescriptor->aLines[pDescriptor->cLines] = pEnd + cbDiff;
1423 pDescriptor->fDirty = true;
1424
1425 return VINF_SUCCESS;
1426}
1427
1428static bool vmdkDescGetStr(PVMDKDESCRIPTOR pDescriptor, unsigned uStart,
1429 const char *pszKey, const char **ppszValue)
1430{
1431 size_t cbKey = strlen(pszKey);
1432 const char *pszValue;
1433
1434 while (uStart != 0)
1435 {
1436 if (!strncmp(pDescriptor->aLines[uStart], pszKey, cbKey))
1437 {
1438 /* Key matches, check for a '=' (preceded by whitespace). */
1439 pszValue = pDescriptor->aLines[uStart] + cbKey;
1440 while (*pszValue == ' ' || *pszValue == '\t')
1441 pszValue++;
1442 if (*pszValue == '=')
1443 {
1444 *ppszValue = pszValue + 1;
1445 break;
1446 }
1447 }
1448 uStart = pDescriptor->aNextLines[uStart];
1449 }
1450 return !!uStart;
1451}
1452
1453static int vmdkDescSetStr(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1454 unsigned uStart,
1455 const char *pszKey, const char *pszValue)
1456{
1457 char *pszTmp;
1458 size_t cbKey = strlen(pszKey);
1459 unsigned uLast = 0;
1460
1461 while (uStart != 0)
1462 {
1463 if (!strncmp(pDescriptor->aLines[uStart], pszKey, cbKey))
1464 {
1465 /* Key matches, check for a '=' (preceded by whitespace). */
1466 pszTmp = pDescriptor->aLines[uStart] + cbKey;
1467 while (*pszTmp == ' ' || *pszTmp == '\t')
1468 pszTmp++;
1469 if (*pszTmp == '=')
1470 {
1471 pszTmp++;
1472 while (*pszTmp == ' ' || *pszTmp == '\t')
1473 pszTmp++;
1474 break;
1475 }
1476 }
1477 if (!pDescriptor->aNextLines[uStart])
1478 uLast = uStart;
1479 uStart = pDescriptor->aNextLines[uStart];
1480 }
1481 if (uStart)
1482 {
1483 if (pszValue)
1484 {
1485 /* Key already exists, replace existing value. */
1486 size_t cbOldVal = strlen(pszTmp);
1487 size_t cbNewVal = strlen(pszValue);
1488 ssize_t cbDiff = cbNewVal - cbOldVal;
1489 /* Check for buffer overflow. */
1490 if ( pDescriptor->aLines[pDescriptor->cLines]
1491 - pDescriptor->aLines[0] > (ptrdiff_t)pDescriptor->cbDescAlloc - cbDiff)
1492 return vdIfError(pImage->pIfError, VERR_BUFFER_OVERFLOW, RT_SRC_POS, N_("VMDK: descriptor too big in '%s'"), pImage->pszFilename);
1493
1494 memmove(pszTmp + cbNewVal, pszTmp + cbOldVal,
1495 pDescriptor->aLines[pDescriptor->cLines] - pszTmp - cbOldVal);
1496 memcpy(pszTmp, pszValue, cbNewVal + 1);
1497 for (unsigned i = uStart + 1; i <= pDescriptor->cLines; i++)
1498 pDescriptor->aLines[i] += cbDiff;
1499 }
1500 else
1501 {
1502 memmove(pDescriptor->aLines[uStart], pDescriptor->aLines[uStart+1],
1503 pDescriptor->aLines[pDescriptor->cLines] - pDescriptor->aLines[uStart+1] + 1);
1504 for (unsigned i = uStart + 1; i <= pDescriptor->cLines; i++)
1505 {
1506 pDescriptor->aLines[i-1] = pDescriptor->aLines[i];
1507 if (pDescriptor->aNextLines[i])
1508 pDescriptor->aNextLines[i-1] = pDescriptor->aNextLines[i] - 1;
1509 else
1510 pDescriptor->aNextLines[i-1] = 0;
1511 }
1512 pDescriptor->cLines--;
1513 /* Adjust starting line numbers of following descriptor sections. */
1514 if (uStart < pDescriptor->uFirstExtent)
1515 pDescriptor->uFirstExtent--;
1516 if (uStart < pDescriptor->uFirstDDB)
1517 pDescriptor->uFirstDDB--;
1518 }
1519 }
1520 else
1521 {
1522 /* Key doesn't exist, append after the last entry in this category. */
1523 if (!pszValue)
1524 {
1525 /* Key doesn't exist, and it should be removed. Simply a no-op. */
1526 return VINF_SUCCESS;
1527 }
1528 cbKey = strlen(pszKey);
1529 size_t cbValue = strlen(pszValue);
1530 ssize_t cbDiff = cbKey + 1 + cbValue + 1;
1531 /* Check for buffer overflow. */
1532 if ( (pDescriptor->cLines >= VMDK_DESCRIPTOR_LINES_MAX - 1)
1533 || ( pDescriptor->aLines[pDescriptor->cLines]
1534 - pDescriptor->aLines[0] > (ptrdiff_t)pDescriptor->cbDescAlloc - cbDiff))
1535 return vdIfError(pImage->pIfError, VERR_BUFFER_OVERFLOW, RT_SRC_POS, N_("VMDK: descriptor too big in '%s'"), pImage->pszFilename);
1536 for (unsigned i = pDescriptor->cLines + 1; i > uLast + 1; i--)
1537 {
1538 pDescriptor->aLines[i] = pDescriptor->aLines[i - 1];
1539 if (pDescriptor->aNextLines[i - 1])
1540 pDescriptor->aNextLines[i] = pDescriptor->aNextLines[i - 1] + 1;
1541 else
1542 pDescriptor->aNextLines[i] = 0;
1543 }
1544 uStart = uLast + 1;
1545 pDescriptor->aNextLines[uLast] = uStart;
1546 pDescriptor->aNextLines[uStart] = 0;
1547 pDescriptor->cLines++;
1548 pszTmp = pDescriptor->aLines[uStart];
1549 memmove(pszTmp + cbDiff, pszTmp,
1550 pDescriptor->aLines[pDescriptor->cLines] - pszTmp);
1551 memcpy(pDescriptor->aLines[uStart], pszKey, cbKey);
1552 pDescriptor->aLines[uStart][cbKey] = '=';
1553 memcpy(pDescriptor->aLines[uStart] + cbKey + 1, pszValue, cbValue + 1);
1554 for (unsigned i = uStart + 1; i <= pDescriptor->cLines; i++)
1555 pDescriptor->aLines[i] += cbDiff;
1556
1557 /* Adjust starting line numbers of following descriptor sections. */
1558 if (uStart <= pDescriptor->uFirstExtent)
1559 pDescriptor->uFirstExtent++;
1560 if (uStart <= pDescriptor->uFirstDDB)
1561 pDescriptor->uFirstDDB++;
1562 }
1563 pDescriptor->fDirty = true;
1564 return VINF_SUCCESS;
1565}
1566
1567static int vmdkDescBaseGetU32(PVMDKDESCRIPTOR pDescriptor, const char *pszKey,
1568 uint32_t *puValue)
1569{
1570 const char *pszValue;
1571
1572 if (!vmdkDescGetStr(pDescriptor, pDescriptor->uFirstDesc, pszKey,
1573 &pszValue))
1574 return VERR_VD_VMDK_VALUE_NOT_FOUND;
1575 return RTStrToUInt32Ex(pszValue, NULL, 10, puValue);
1576}
1577
1578/**
1579 * @param ppszValue Where to store the return value, use RTMemTmpFree to
1580 * free.
1581 */
1582static int vmdkDescBaseGetStr(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1583 const char *pszKey, char **ppszValue)
1584{
1585 const char *pszValue;
1586 char *pszValueUnquoted;
1587
1588 if (!vmdkDescGetStr(pDescriptor, pDescriptor->uFirstDesc, pszKey,
1589 &pszValue))
1590 return VERR_VD_VMDK_VALUE_NOT_FOUND;
1591 int rc = vmdkStringUnquote(pImage, pszValue, &pszValueUnquoted, NULL);
1592 if (RT_FAILURE(rc))
1593 return rc;
1594 *ppszValue = pszValueUnquoted;
1595 return rc;
1596}
1597
1598static int vmdkDescBaseSetStr(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1599 const char *pszKey, const char *pszValue)
1600{
1601 char *pszValueQuoted;
1602
1603 RTStrAPrintf(&pszValueQuoted, "\"%s\"", pszValue);
1604 if (!pszValueQuoted)
1605 return VERR_NO_STR_MEMORY;
1606 int rc = vmdkDescSetStr(pImage, pDescriptor, pDescriptor->uFirstDesc, pszKey,
1607 pszValueQuoted);
1608 RTStrFree(pszValueQuoted);
1609 return rc;
1610}
1611
1612static void vmdkDescExtRemoveDummy(PVMDKIMAGE pImage,
1613 PVMDKDESCRIPTOR pDescriptor)
1614{
1615 unsigned uEntry = pDescriptor->uFirstExtent;
1616 ssize_t cbDiff;
1617
1618 if (!uEntry)
1619 return;
1620
1621 cbDiff = strlen(pDescriptor->aLines[uEntry]) + 1;
1622 /* Move everything including \0 in the entry marking the end of buffer. */
1623 memmove(pDescriptor->aLines[uEntry], pDescriptor->aLines[uEntry + 1],
1624 pDescriptor->aLines[pDescriptor->cLines] - pDescriptor->aLines[uEntry + 1] + 1);
1625 for (unsigned i = uEntry + 1; i <= pDescriptor->cLines; i++)
1626 {
1627 pDescriptor->aLines[i - 1] = pDescriptor->aLines[i] - cbDiff;
1628 if (pDescriptor->aNextLines[i])
1629 pDescriptor->aNextLines[i - 1] = pDescriptor->aNextLines[i] - 1;
1630 else
1631 pDescriptor->aNextLines[i - 1] = 0;
1632 }
1633 pDescriptor->cLines--;
1634 if (pDescriptor->uFirstDDB)
1635 pDescriptor->uFirstDDB--;
1636
1637 return;
1638}
1639
1640static int vmdkDescExtInsert(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1641 VMDKACCESS enmAccess, uint64_t cNominalSectors,
1642 VMDKETYPE enmType, const char *pszBasename,
1643 uint64_t uSectorOffset)
1644{
1645 static const char *apszAccess[] = { "NOACCESS", "RDONLY", "RW" };
1646 static const char *apszType[] = { "", "SPARSE", "FLAT", "ZERO", "VMFS" };
1647 char *pszTmp;
1648 unsigned uStart = pDescriptor->uFirstExtent, uLast = 0;
1649 char szExt[1024];
1650 ssize_t cbDiff;
1651
1652 Assert((unsigned)enmAccess < RT_ELEMENTS(apszAccess));
1653 Assert((unsigned)enmType < RT_ELEMENTS(apszType));
1654
1655 /* Find last entry in extent description. */
1656 while (uStart)
1657 {
1658 if (!pDescriptor->aNextLines[uStart])
1659 uLast = uStart;
1660 uStart = pDescriptor->aNextLines[uStart];
1661 }
1662
1663 if (enmType == VMDKETYPE_ZERO)
1664 {
1665 RTStrPrintf(szExt, sizeof(szExt), "%s %llu %s ", apszAccess[enmAccess],
1666 cNominalSectors, apszType[enmType]);
1667 }
1668 else if (enmType == VMDKETYPE_FLAT)
1669 {
1670 RTStrPrintf(szExt, sizeof(szExt), "%s %llu %s \"%s\" %llu",
1671 apszAccess[enmAccess], cNominalSectors,
1672 apszType[enmType], pszBasename, uSectorOffset);
1673 }
1674 else
1675 {
1676 RTStrPrintf(szExt, sizeof(szExt), "%s %llu %s \"%s\"",
1677 apszAccess[enmAccess], cNominalSectors,
1678 apszType[enmType], pszBasename);
1679 }
1680 cbDiff = strlen(szExt) + 1;
1681
1682 /* Check for buffer overflow. */
1683 if ( (pDescriptor->cLines >= VMDK_DESCRIPTOR_LINES_MAX - 1)
1684 || ( pDescriptor->aLines[pDescriptor->cLines]
1685 - pDescriptor->aLines[0] > (ptrdiff_t)pDescriptor->cbDescAlloc - cbDiff))
1686 return vdIfError(pImage->pIfError, VERR_BUFFER_OVERFLOW, RT_SRC_POS, N_("VMDK: descriptor too big in '%s'"), pImage->pszFilename);
1687
1688 for (unsigned i = pDescriptor->cLines + 1; i > uLast + 1; i--)
1689 {
1690 pDescriptor->aLines[i] = pDescriptor->aLines[i - 1];
1691 if (pDescriptor->aNextLines[i - 1])
1692 pDescriptor->aNextLines[i] = pDescriptor->aNextLines[i - 1] + 1;
1693 else
1694 pDescriptor->aNextLines[i] = 0;
1695 }
1696 uStart = uLast + 1;
1697 pDescriptor->aNextLines[uLast] = uStart;
1698 pDescriptor->aNextLines[uStart] = 0;
1699 pDescriptor->cLines++;
1700 pszTmp = pDescriptor->aLines[uStart];
1701 memmove(pszTmp + cbDiff, pszTmp,
1702 pDescriptor->aLines[pDescriptor->cLines] - pszTmp);
1703 memcpy(pDescriptor->aLines[uStart], szExt, cbDiff);
1704 for (unsigned i = uStart + 1; i <= pDescriptor->cLines; i++)
1705 pDescriptor->aLines[i] += cbDiff;
1706
1707 /* Adjust starting line numbers of following descriptor sections. */
1708 if (uStart <= pDescriptor->uFirstDDB)
1709 pDescriptor->uFirstDDB++;
1710
1711 pDescriptor->fDirty = true;
1712 return VINF_SUCCESS;
1713}
1714
1715/**
1716 * @param ppszValue Where to store the return value, use RTMemTmpFree to
1717 * free.
1718 */
1719static int vmdkDescDDBGetStr(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1720 const char *pszKey, char **ppszValue)
1721{
1722 const char *pszValue;
1723 char *pszValueUnquoted;
1724
1725 if (!vmdkDescGetStr(pDescriptor, pDescriptor->uFirstDDB, pszKey,
1726 &pszValue))
1727 return VERR_VD_VMDK_VALUE_NOT_FOUND;
1728 int rc = vmdkStringUnquote(pImage, pszValue, &pszValueUnquoted, NULL);
1729 if (RT_FAILURE(rc))
1730 return rc;
1731 *ppszValue = pszValueUnquoted;
1732 return rc;
1733}
1734
1735static int vmdkDescDDBGetU32(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1736 const char *pszKey, uint32_t *puValue)
1737{
1738 const char *pszValue;
1739 char *pszValueUnquoted;
1740
1741 if (!vmdkDescGetStr(pDescriptor, pDescriptor->uFirstDDB, pszKey,
1742 &pszValue))
1743 return VERR_VD_VMDK_VALUE_NOT_FOUND;
1744 int rc = vmdkStringUnquote(pImage, pszValue, &pszValueUnquoted, NULL);
1745 if (RT_FAILURE(rc))
1746 return rc;
1747 rc = RTStrToUInt32Ex(pszValueUnquoted, NULL, 10, puValue);
1748 RTMemTmpFree(pszValueUnquoted);
1749 return rc;
1750}
1751
1752static int vmdkDescDDBGetUuid(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1753 const char *pszKey, PRTUUID pUuid)
1754{
1755 const char *pszValue;
1756 char *pszValueUnquoted;
1757
1758 if (!vmdkDescGetStr(pDescriptor, pDescriptor->uFirstDDB, pszKey,
1759 &pszValue))
1760 return VERR_VD_VMDK_VALUE_NOT_FOUND;
1761 int rc = vmdkStringUnquote(pImage, pszValue, &pszValueUnquoted, NULL);
1762 if (RT_FAILURE(rc))
1763 return rc;
1764 rc = RTUuidFromStr(pUuid, pszValueUnquoted);
1765 RTMemTmpFree(pszValueUnquoted);
1766 return rc;
1767}
1768
1769static int vmdkDescDDBSetStr(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1770 const char *pszKey, const char *pszVal)
1771{
1772 int rc;
1773 char *pszValQuoted;
1774
1775 if (pszVal)
1776 {
1777 RTStrAPrintf(&pszValQuoted, "\"%s\"", pszVal);
1778 if (!pszValQuoted)
1779 return VERR_NO_STR_MEMORY;
1780 }
1781 else
1782 pszValQuoted = NULL;
1783 rc = vmdkDescSetStr(pImage, pDescriptor, pDescriptor->uFirstDDB, pszKey,
1784 pszValQuoted);
1785 if (pszValQuoted)
1786 RTStrFree(pszValQuoted);
1787 return rc;
1788}
1789
1790static int vmdkDescDDBSetUuid(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1791 const char *pszKey, PCRTUUID pUuid)
1792{
1793 char *pszUuid;
1794
1795 RTStrAPrintf(&pszUuid, "\"%RTuuid\"", pUuid);
1796 if (!pszUuid)
1797 return VERR_NO_STR_MEMORY;
1798 int rc = vmdkDescSetStr(pImage, pDescriptor, pDescriptor->uFirstDDB, pszKey,
1799 pszUuid);
1800 RTStrFree(pszUuid);
1801 return rc;
1802}
1803
1804static int vmdkDescDDBSetU32(PVMDKIMAGE pImage, PVMDKDESCRIPTOR pDescriptor,
1805 const char *pszKey, uint32_t uValue)
1806{
1807 char *pszValue;
1808
1809 RTStrAPrintf(&pszValue, "\"%d\"", uValue);
1810 if (!pszValue)
1811 return VERR_NO_STR_MEMORY;
1812 int rc = vmdkDescSetStr(pImage, pDescriptor, pDescriptor->uFirstDDB, pszKey,
1813 pszValue);
1814 RTStrFree(pszValue);
1815 return rc;
1816}
1817
1818static int vmdkPreprocessDescriptor(PVMDKIMAGE pImage, char *pDescData,
1819 size_t cbDescData,
1820 PVMDKDESCRIPTOR pDescriptor)
1821{
1822 int rc = VINF_SUCCESS;
1823 unsigned cLine = 0, uLastNonEmptyLine = 0;
1824 char *pTmp = pDescData;
1825
1826 pDescriptor->cbDescAlloc = cbDescData;
1827 while (*pTmp != '\0')
1828 {
1829 pDescriptor->aLines[cLine++] = pTmp;
1830 if (cLine >= VMDK_DESCRIPTOR_LINES_MAX)
1831 {
1832 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: descriptor too big in '%s'"), pImage->pszFilename);
1833 goto out;
1834 }
1835
1836 while (*pTmp != '\0' && *pTmp != '\n')
1837 {
1838 if (*pTmp == '\r')
1839 {
1840 if (*(pTmp + 1) != '\n')
1841 {
1842 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: unsupported end of line in descriptor in '%s'"), pImage->pszFilename);
1843 goto out;
1844 }
1845 else
1846 {
1847 /* Get rid of CR character. */
1848 *pTmp = '\0';
1849 }
1850 }
1851 pTmp++;
1852 }
1853 /* Get rid of LF character. */
1854 if (*pTmp == '\n')
1855 {
1856 *pTmp = '\0';
1857 pTmp++;
1858 }
1859 }
1860 pDescriptor->cLines = cLine;
1861 /* Pointer right after the end of the used part of the buffer. */
1862 pDescriptor->aLines[cLine] = pTmp;
1863
1864 if ( strcmp(pDescriptor->aLines[0], "# Disk DescriptorFile")
1865 && strcmp(pDescriptor->aLines[0], "# Disk Descriptor File"))
1866 {
1867 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: descriptor does not start as expected in '%s'"), pImage->pszFilename);
1868 goto out;
1869 }
1870
1871 /* Initialize those, because we need to be able to reopen an image. */
1872 pDescriptor->uFirstDesc = 0;
1873 pDescriptor->uFirstExtent = 0;
1874 pDescriptor->uFirstDDB = 0;
1875 for (unsigned i = 0; i < cLine; i++)
1876 {
1877 if (*pDescriptor->aLines[i] != '#' && *pDescriptor->aLines[i] != '\0')
1878 {
1879 if ( !strncmp(pDescriptor->aLines[i], "RW", 2)
1880 || !strncmp(pDescriptor->aLines[i], "RDONLY", 6)
1881 || !strncmp(pDescriptor->aLines[i], "NOACCESS", 8) )
1882 {
1883 /* An extent descriptor. */
1884 if (!pDescriptor->uFirstDesc || pDescriptor->uFirstDDB)
1885 {
1886 /* Incorrect ordering of entries. */
1887 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect ordering of entries in descriptor in '%s'"), pImage->pszFilename);
1888 goto out;
1889 }
1890 if (!pDescriptor->uFirstExtent)
1891 {
1892 pDescriptor->uFirstExtent = i;
1893 uLastNonEmptyLine = 0;
1894 }
1895 }
1896 else if (!strncmp(pDescriptor->aLines[i], "ddb.", 4))
1897 {
1898 /* A disk database entry. */
1899 if (!pDescriptor->uFirstDesc || !pDescriptor->uFirstExtent)
1900 {
1901 /* Incorrect ordering of entries. */
1902 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect ordering of entries in descriptor in '%s'"), pImage->pszFilename);
1903 goto out;
1904 }
1905 if (!pDescriptor->uFirstDDB)
1906 {
1907 pDescriptor->uFirstDDB = i;
1908 uLastNonEmptyLine = 0;
1909 }
1910 }
1911 else
1912 {
1913 /* A normal entry. */
1914 if (pDescriptor->uFirstExtent || pDescriptor->uFirstDDB)
1915 {
1916 /* Incorrect ordering of entries. */
1917 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect ordering of entries in descriptor in '%s'"), pImage->pszFilename);
1918 goto out;
1919 }
1920 if (!pDescriptor->uFirstDesc)
1921 {
1922 pDescriptor->uFirstDesc = i;
1923 uLastNonEmptyLine = 0;
1924 }
1925 }
1926 if (uLastNonEmptyLine)
1927 pDescriptor->aNextLines[uLastNonEmptyLine] = i;
1928 uLastNonEmptyLine = i;
1929 }
1930 }
1931
1932out:
1933 return rc;
1934}
1935
1936static int vmdkDescSetPCHSGeometry(PVMDKIMAGE pImage,
1937 PCVDGEOMETRY pPCHSGeometry)
1938{
1939 int rc = vmdkDescDDBSetU32(pImage, &pImage->Descriptor,
1940 VMDK_DDB_GEO_PCHS_CYLINDERS,
1941 pPCHSGeometry->cCylinders);
1942 if (RT_FAILURE(rc))
1943 return rc;
1944 rc = vmdkDescDDBSetU32(pImage, &pImage->Descriptor,
1945 VMDK_DDB_GEO_PCHS_HEADS,
1946 pPCHSGeometry->cHeads);
1947 if (RT_FAILURE(rc))
1948 return rc;
1949 rc = vmdkDescDDBSetU32(pImage, &pImage->Descriptor,
1950 VMDK_DDB_GEO_PCHS_SECTORS,
1951 pPCHSGeometry->cSectors);
1952 return rc;
1953}
1954
1955static int vmdkDescSetLCHSGeometry(PVMDKIMAGE pImage,
1956 PCVDGEOMETRY pLCHSGeometry)
1957{
1958 int rc = vmdkDescDDBSetU32(pImage, &pImage->Descriptor,
1959 VMDK_DDB_GEO_LCHS_CYLINDERS,
1960 pLCHSGeometry->cCylinders);
1961 if (RT_FAILURE(rc))
1962 return rc;
1963 rc = vmdkDescDDBSetU32(pImage, &pImage->Descriptor,
1964 VMDK_DDB_GEO_LCHS_HEADS,
1965
1966 pLCHSGeometry->cHeads);
1967 if (RT_FAILURE(rc))
1968 return rc;
1969 rc = vmdkDescDDBSetU32(pImage, &pImage->Descriptor,
1970 VMDK_DDB_GEO_LCHS_SECTORS,
1971 pLCHSGeometry->cSectors);
1972 return rc;
1973}
1974
1975static int vmdkCreateDescriptor(PVMDKIMAGE pImage, char *pDescData,
1976 size_t cbDescData, PVMDKDESCRIPTOR pDescriptor)
1977{
1978 int rc;
1979
1980 pDescriptor->uFirstDesc = 0;
1981 pDescriptor->uFirstExtent = 0;
1982 pDescriptor->uFirstDDB = 0;
1983 pDescriptor->cLines = 0;
1984 pDescriptor->cbDescAlloc = cbDescData;
1985 pDescriptor->fDirty = false;
1986 pDescriptor->aLines[pDescriptor->cLines] = pDescData;
1987 memset(pDescriptor->aNextLines, '\0', sizeof(pDescriptor->aNextLines));
1988
1989 rc = vmdkDescInitStr(pImage, pDescriptor, "# Disk DescriptorFile");
1990 if (RT_FAILURE(rc))
1991 goto out;
1992 rc = vmdkDescInitStr(pImage, pDescriptor, "version=1");
1993 if (RT_FAILURE(rc))
1994 goto out;
1995 pDescriptor->uFirstDesc = pDescriptor->cLines - 1;
1996 rc = vmdkDescInitStr(pImage, pDescriptor, "");
1997 if (RT_FAILURE(rc))
1998 goto out;
1999 rc = vmdkDescInitStr(pImage, pDescriptor, "# Extent description");
2000 if (RT_FAILURE(rc))
2001 goto out;
2002 rc = vmdkDescInitStr(pImage, pDescriptor, "NOACCESS 0 ZERO ");
2003 if (RT_FAILURE(rc))
2004 goto out;
2005 pDescriptor->uFirstExtent = pDescriptor->cLines - 1;
2006 rc = vmdkDescInitStr(pImage, pDescriptor, "");
2007 if (RT_FAILURE(rc))
2008 goto out;
2009 /* The trailing space is created by VMware, too. */
2010 rc = vmdkDescInitStr(pImage, pDescriptor, "# The disk Data Base ");
2011 if (RT_FAILURE(rc))
2012 goto out;
2013 rc = vmdkDescInitStr(pImage, pDescriptor, "#DDB");
2014 if (RT_FAILURE(rc))
2015 goto out;
2016 rc = vmdkDescInitStr(pImage, pDescriptor, "");
2017 if (RT_FAILURE(rc))
2018 goto out;
2019 rc = vmdkDescInitStr(pImage, pDescriptor, "ddb.virtualHWVersion = \"4\"");
2020 if (RT_FAILURE(rc))
2021 goto out;
2022 pDescriptor->uFirstDDB = pDescriptor->cLines - 1;
2023
2024 /* Now that the framework is in place, use the normal functions to insert
2025 * the remaining keys. */
2026 char szBuf[9];
2027 RTStrPrintf(szBuf, sizeof(szBuf), "%08x", RTRandU32());
2028 rc = vmdkDescSetStr(pImage, pDescriptor, pDescriptor->uFirstDesc,
2029 "CID", szBuf);
2030 if (RT_FAILURE(rc))
2031 goto out;
2032 rc = vmdkDescSetStr(pImage, pDescriptor, pDescriptor->uFirstDesc,
2033 "parentCID", "ffffffff");
2034 if (RT_FAILURE(rc))
2035 goto out;
2036
2037 rc = vmdkDescDDBSetStr(pImage, pDescriptor, "ddb.adapterType", "ide");
2038 if (RT_FAILURE(rc))
2039 goto out;
2040
2041out:
2042 return rc;
2043}
2044
2045static int vmdkParseDescriptor(PVMDKIMAGE pImage, char *pDescData,
2046 size_t cbDescData)
2047{
2048 int rc;
2049 unsigned cExtents;
2050 unsigned uLine;
2051 unsigned i;
2052
2053 rc = vmdkPreprocessDescriptor(pImage, pDescData, cbDescData,
2054 &pImage->Descriptor);
2055 if (RT_FAILURE(rc))
2056 return rc;
2057
2058 /* Check version, must be 1. */
2059 uint32_t uVersion;
2060 rc = vmdkDescBaseGetU32(&pImage->Descriptor, "version", &uVersion);
2061 if (RT_FAILURE(rc))
2062 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error finding key 'version' in descriptor in '%s'"), pImage->pszFilename);
2063 if (uVersion != 1)
2064 return vdIfError(pImage->pIfError, VERR_VD_VMDK_UNSUPPORTED_VERSION, RT_SRC_POS, N_("VMDK: unsupported format version in descriptor in '%s'"), pImage->pszFilename);
2065
2066 /* Get image creation type and determine image flags. */
2067 char *pszCreateType = NULL; /* initialized to make gcc shut up */
2068 rc = vmdkDescBaseGetStr(pImage, &pImage->Descriptor, "createType",
2069 &pszCreateType);
2070 if (RT_FAILURE(rc))
2071 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot get image type from descriptor in '%s'"), pImage->pszFilename);
2072 if ( !strcmp(pszCreateType, "twoGbMaxExtentSparse")
2073 || !strcmp(pszCreateType, "twoGbMaxExtentFlat"))
2074 pImage->uImageFlags |= VD_VMDK_IMAGE_FLAGS_SPLIT_2G;
2075 else if ( !strcmp(pszCreateType, "partitionedDevice")
2076 || !strcmp(pszCreateType, "fullDevice"))
2077 pImage->uImageFlags |= VD_VMDK_IMAGE_FLAGS_RAWDISK;
2078 else if (!strcmp(pszCreateType, "streamOptimized"))
2079 pImage->uImageFlags |= VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED;
2080 else if (!strcmp(pszCreateType, "vmfs"))
2081 pImage->uImageFlags |= VD_IMAGE_FLAGS_FIXED | VD_VMDK_IMAGE_FLAGS_ESX;
2082 RTMemTmpFree(pszCreateType);
2083
2084 /* Count the number of extent config entries. */
2085 for (uLine = pImage->Descriptor.uFirstExtent, cExtents = 0;
2086 uLine != 0;
2087 uLine = pImage->Descriptor.aNextLines[uLine], cExtents++)
2088 /* nothing */;
2089
2090 if (!pImage->pDescData && cExtents != 1)
2091 {
2092 /* Monolithic image, must have only one extent (already opened). */
2093 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: monolithic image may only have one extent in '%s'"), pImage->pszFilename);
2094 }
2095
2096 if (pImage->pDescData)
2097 {
2098 /* Non-monolithic image, extents need to be allocated. */
2099 rc = vmdkCreateExtents(pImage, cExtents);
2100 if (RT_FAILURE(rc))
2101 return rc;
2102 }
2103
2104 for (i = 0, uLine = pImage->Descriptor.uFirstExtent;
2105 i < cExtents; i++, uLine = pImage->Descriptor.aNextLines[uLine])
2106 {
2107 char *pszLine = pImage->Descriptor.aLines[uLine];
2108
2109 /* Access type of the extent. */
2110 if (!strncmp(pszLine, "RW", 2))
2111 {
2112 pImage->pExtents[i].enmAccess = VMDKACCESS_READWRITE;
2113 pszLine += 2;
2114 }
2115 else if (!strncmp(pszLine, "RDONLY", 6))
2116 {
2117 pImage->pExtents[i].enmAccess = VMDKACCESS_READONLY;
2118 pszLine += 6;
2119 }
2120 else if (!strncmp(pszLine, "NOACCESS", 8))
2121 {
2122 pImage->pExtents[i].enmAccess = VMDKACCESS_NOACCESS;
2123 pszLine += 8;
2124 }
2125 else
2126 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2127 if (*pszLine++ != ' ')
2128 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2129
2130 /* Nominal size of the extent. */
2131 rc = RTStrToUInt64Ex(pszLine, &pszLine, 10,
2132 &pImage->pExtents[i].cNominalSectors);
2133 if (RT_FAILURE(rc))
2134 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2135 if (*pszLine++ != ' ')
2136 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2137
2138 /* Type of the extent. */
2139#ifdef VBOX_WITH_VMDK_ESX
2140 /** @todo Add the ESX extent types. Not necessary for now because
2141 * the ESX extent types are only used inside an ESX server. They are
2142 * automatically converted if the VMDK is exported. */
2143#endif /* VBOX_WITH_VMDK_ESX */
2144 if (!strncmp(pszLine, "SPARSE", 6))
2145 {
2146 pImage->pExtents[i].enmType = VMDKETYPE_HOSTED_SPARSE;
2147 pszLine += 6;
2148 }
2149 else if (!strncmp(pszLine, "FLAT", 4))
2150 {
2151 pImage->pExtents[i].enmType = VMDKETYPE_FLAT;
2152 pszLine += 4;
2153 }
2154 else if (!strncmp(pszLine, "ZERO", 4))
2155 {
2156 pImage->pExtents[i].enmType = VMDKETYPE_ZERO;
2157 pszLine += 4;
2158 }
2159 else if (!strncmp(pszLine, "VMFS", 4))
2160 {
2161 pImage->pExtents[i].enmType = VMDKETYPE_VMFS;
2162 pszLine += 4;
2163 }
2164 else
2165 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2166
2167 if (pImage->pExtents[i].enmType == VMDKETYPE_ZERO)
2168 {
2169 /* This one has no basename or offset. */
2170 if (*pszLine == ' ')
2171 pszLine++;
2172 if (*pszLine != '\0')
2173 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2174 pImage->pExtents[i].pszBasename = NULL;
2175 }
2176 else
2177 {
2178 /* All other extent types have basename and optional offset. */
2179 if (*pszLine++ != ' ')
2180 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2181
2182 /* Basename of the image. Surrounded by quotes. */
2183 char *pszBasename;
2184 rc = vmdkStringUnquote(pImage, pszLine, &pszBasename, &pszLine);
2185 if (RT_FAILURE(rc))
2186 return rc;
2187 pImage->pExtents[i].pszBasename = pszBasename;
2188 if (*pszLine == ' ')
2189 {
2190 pszLine++;
2191 if (*pszLine != '\0')
2192 {
2193 /* Optional offset in extent specified. */
2194 rc = RTStrToUInt64Ex(pszLine, &pszLine, 10,
2195 &pImage->pExtents[i].uSectorOffset);
2196 if (RT_FAILURE(rc))
2197 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2198 }
2199 }
2200
2201 if (*pszLine != '\0')
2202 return vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: parse error in extent description in '%s'"), pImage->pszFilename);
2203 }
2204 }
2205
2206 /* Determine PCHS geometry (autogenerate if necessary). */
2207 rc = vmdkDescDDBGetU32(pImage, &pImage->Descriptor,
2208 VMDK_DDB_GEO_PCHS_CYLINDERS,
2209 &pImage->PCHSGeometry.cCylinders);
2210 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2211 pImage->PCHSGeometry.cCylinders = 0;
2212 else if (RT_FAILURE(rc))
2213 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error getting PCHS geometry from extent description in '%s'"), pImage->pszFilename);
2214 rc = vmdkDescDDBGetU32(pImage, &pImage->Descriptor,
2215 VMDK_DDB_GEO_PCHS_HEADS,
2216 &pImage->PCHSGeometry.cHeads);
2217 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2218 pImage->PCHSGeometry.cHeads = 0;
2219 else if (RT_FAILURE(rc))
2220 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error getting PCHS geometry from extent description in '%s'"), pImage->pszFilename);
2221 rc = vmdkDescDDBGetU32(pImage, &pImage->Descriptor,
2222 VMDK_DDB_GEO_PCHS_SECTORS,
2223 &pImage->PCHSGeometry.cSectors);
2224 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2225 pImage->PCHSGeometry.cSectors = 0;
2226 else if (RT_FAILURE(rc))
2227 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error getting PCHS geometry from extent description in '%s'"), pImage->pszFilename);
2228 if ( pImage->PCHSGeometry.cCylinders == 0
2229 || pImage->PCHSGeometry.cHeads == 0
2230 || pImage->PCHSGeometry.cHeads > 16
2231 || pImage->PCHSGeometry.cSectors == 0
2232 || pImage->PCHSGeometry.cSectors > 63)
2233 {
2234 /* Mark PCHS geometry as not yet valid (can't do the calculation here
2235 * as the total image size isn't known yet). */
2236 pImage->PCHSGeometry.cCylinders = 0;
2237 pImage->PCHSGeometry.cHeads = 16;
2238 pImage->PCHSGeometry.cSectors = 63;
2239 }
2240
2241 /* Determine LCHS geometry (set to 0 if not specified). */
2242 rc = vmdkDescDDBGetU32(pImage, &pImage->Descriptor,
2243 VMDK_DDB_GEO_LCHS_CYLINDERS,
2244 &pImage->LCHSGeometry.cCylinders);
2245 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2246 pImage->LCHSGeometry.cCylinders = 0;
2247 else if (RT_FAILURE(rc))
2248 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error getting LCHS geometry from extent description in '%s'"), pImage->pszFilename);
2249 rc = vmdkDescDDBGetU32(pImage, &pImage->Descriptor,
2250 VMDK_DDB_GEO_LCHS_HEADS,
2251 &pImage->LCHSGeometry.cHeads);
2252 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2253 pImage->LCHSGeometry.cHeads = 0;
2254 else if (RT_FAILURE(rc))
2255 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error getting LCHS geometry from extent description in '%s'"), pImage->pszFilename);
2256 rc = vmdkDescDDBGetU32(pImage, &pImage->Descriptor,
2257 VMDK_DDB_GEO_LCHS_SECTORS,
2258 &pImage->LCHSGeometry.cSectors);
2259 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2260 pImage->LCHSGeometry.cSectors = 0;
2261 else if (RT_FAILURE(rc))
2262 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error getting LCHS geometry from extent description in '%s'"), pImage->pszFilename);
2263 if ( pImage->LCHSGeometry.cCylinders == 0
2264 || pImage->LCHSGeometry.cHeads == 0
2265 || pImage->LCHSGeometry.cSectors == 0)
2266 {
2267 pImage->LCHSGeometry.cCylinders = 0;
2268 pImage->LCHSGeometry.cHeads = 0;
2269 pImage->LCHSGeometry.cSectors = 0;
2270 }
2271
2272 /* Get image UUID. */
2273 rc = vmdkDescDDBGetUuid(pImage, &pImage->Descriptor, VMDK_DDB_IMAGE_UUID,
2274 &pImage->ImageUuid);
2275 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2276 {
2277 /* Image without UUID. Probably created by VMware and not yet used
2278 * by VirtualBox. Can only be added for images opened in read/write
2279 * mode, so don't bother producing a sensible UUID otherwise. */
2280 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2281 RTUuidClear(&pImage->ImageUuid);
2282 else
2283 {
2284 rc = RTUuidCreate(&pImage->ImageUuid);
2285 if (RT_FAILURE(rc))
2286 return rc;
2287 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
2288 VMDK_DDB_IMAGE_UUID, &pImage->ImageUuid);
2289 if (RT_FAILURE(rc))
2290 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing image UUID in descriptor in '%s'"), pImage->pszFilename);
2291 }
2292 }
2293 else if (RT_FAILURE(rc))
2294 return rc;
2295
2296 /* Get image modification UUID. */
2297 rc = vmdkDescDDBGetUuid(pImage, &pImage->Descriptor,
2298 VMDK_DDB_MODIFICATION_UUID,
2299 &pImage->ModificationUuid);
2300 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2301 {
2302 /* Image without UUID. Probably created by VMware and not yet used
2303 * by VirtualBox. Can only be added for images opened in read/write
2304 * mode, so don't bother producing a sensible UUID otherwise. */
2305 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2306 RTUuidClear(&pImage->ModificationUuid);
2307 else
2308 {
2309 rc = RTUuidCreate(&pImage->ModificationUuid);
2310 if (RT_FAILURE(rc))
2311 return rc;
2312 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
2313 VMDK_DDB_MODIFICATION_UUID,
2314 &pImage->ModificationUuid);
2315 if (RT_FAILURE(rc))
2316 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing image modification UUID in descriptor in '%s'"), pImage->pszFilename);
2317 }
2318 }
2319 else if (RT_FAILURE(rc))
2320 return rc;
2321
2322 /* Get UUID of parent image. */
2323 rc = vmdkDescDDBGetUuid(pImage, &pImage->Descriptor, VMDK_DDB_PARENT_UUID,
2324 &pImage->ParentUuid);
2325 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2326 {
2327 /* Image without UUID. Probably created by VMware and not yet used
2328 * by VirtualBox. Can only be added for images opened in read/write
2329 * mode, so don't bother producing a sensible UUID otherwise. */
2330 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2331 RTUuidClear(&pImage->ParentUuid);
2332 else
2333 {
2334 rc = RTUuidClear(&pImage->ParentUuid);
2335 if (RT_FAILURE(rc))
2336 return rc;
2337 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
2338 VMDK_DDB_PARENT_UUID, &pImage->ParentUuid);
2339 if (RT_FAILURE(rc))
2340 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing parent UUID in descriptor in '%s'"), pImage->pszFilename);
2341 }
2342 }
2343 else if (RT_FAILURE(rc))
2344 return rc;
2345
2346 /* Get parent image modification UUID. */
2347 rc = vmdkDescDDBGetUuid(pImage, &pImage->Descriptor,
2348 VMDK_DDB_PARENT_MODIFICATION_UUID,
2349 &pImage->ParentModificationUuid);
2350 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
2351 {
2352 /* Image without UUID. Probably created by VMware and not yet used
2353 * by VirtualBox. Can only be added for images opened in read/write
2354 * mode, so don't bother producing a sensible UUID otherwise. */
2355 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2356 RTUuidClear(&pImage->ParentModificationUuid);
2357 else
2358 {
2359 RTUuidClear(&pImage->ParentModificationUuid);
2360 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
2361 VMDK_DDB_PARENT_MODIFICATION_UUID,
2362 &pImage->ParentModificationUuid);
2363 if (RT_FAILURE(rc))
2364 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing parent modification UUID in descriptor in '%s'"), pImage->pszFilename);
2365 }
2366 }
2367 else if (RT_FAILURE(rc))
2368 return rc;
2369
2370 return VINF_SUCCESS;
2371}
2372
2373/**
2374 * Internal : Prepares the descriptor to write to the image.
2375 */
2376static int vmdkDescriptorPrepare(PVMDKIMAGE pImage, uint64_t cbLimit,
2377 void **ppvData, size_t *pcbData)
2378{
2379 int rc = VINF_SUCCESS;
2380
2381 /*
2382 * Allocate temporary descriptor buffer.
2383 * In case there is no limit allocate a default
2384 * and increase if required.
2385 */
2386 size_t cbDescriptor = cbLimit ? cbLimit : 4 * _1K;
2387 char *pszDescriptor = (char *)RTMemAllocZ(cbDescriptor);
2388 size_t offDescriptor = 0;
2389
2390 if (!pszDescriptor)
2391 return VERR_NO_MEMORY;
2392
2393 for (unsigned i = 0; i < pImage->Descriptor.cLines; i++)
2394 {
2395 const char *psz = pImage->Descriptor.aLines[i];
2396 size_t cb = strlen(psz);
2397
2398 /*
2399 * Increase the descriptor if there is no limit and
2400 * there is not enough room left for this line.
2401 */
2402 if (offDescriptor + cb + 1 > cbDescriptor)
2403 {
2404 if (cbLimit)
2405 {
2406 rc = vdIfError(pImage->pIfError, VERR_BUFFER_OVERFLOW, RT_SRC_POS, N_("VMDK: descriptor too long in '%s'"), pImage->pszFilename);
2407 break;
2408 }
2409 else
2410 {
2411 char *pszDescriptorNew = NULL;
2412 LogFlow(("Increasing descriptor cache\n"));
2413
2414 pszDescriptorNew = (char *)RTMemRealloc(pszDescriptor, cbDescriptor + cb + 4 * _1K);
2415 if (!pszDescriptorNew)
2416 {
2417 rc = VERR_NO_MEMORY;
2418 break;
2419 }
2420 pszDescriptor = pszDescriptorNew;
2421 cbDescriptor += cb + 4 * _1K;
2422 }
2423 }
2424
2425 if (cb > 0)
2426 {
2427 memcpy(pszDescriptor + offDescriptor, psz, cb);
2428 offDescriptor += cb;
2429 }
2430
2431 memcpy(pszDescriptor + offDescriptor, "\n", 1);
2432 offDescriptor++;
2433 }
2434
2435 if (RT_SUCCESS(rc))
2436 {
2437 *ppvData = pszDescriptor;
2438 *pcbData = offDescriptor;
2439 }
2440 else if (pszDescriptor)
2441 RTMemFree(pszDescriptor);
2442
2443 return rc;
2444}
2445
2446/**
2447 * Internal: write/update the descriptor part of the image.
2448 */
2449static int vmdkWriteDescriptor(PVMDKIMAGE pImage, PVDIOCTX pIoCtx)
2450{
2451 int rc = VINF_SUCCESS;
2452 uint64_t cbLimit;
2453 uint64_t uOffset;
2454 PVMDKFILE pDescFile;
2455 void *pvDescriptor = NULL;
2456 size_t cbDescriptor;
2457
2458 if (pImage->pDescData)
2459 {
2460 /* Separate descriptor file. */
2461 uOffset = 0;
2462 cbLimit = 0;
2463 pDescFile = pImage->pFile;
2464 }
2465 else
2466 {
2467 /* Embedded descriptor file. */
2468 uOffset = VMDK_SECTOR2BYTE(pImage->pExtents[0].uDescriptorSector);
2469 cbLimit = VMDK_SECTOR2BYTE(pImage->pExtents[0].cDescriptorSectors);
2470 pDescFile = pImage->pExtents[0].pFile;
2471 }
2472 /* Bail out if there is no file to write to. */
2473 if (pDescFile == NULL)
2474 return VERR_INVALID_PARAMETER;
2475
2476 rc = vmdkDescriptorPrepare(pImage, cbLimit, &pvDescriptor, &cbDescriptor);
2477 if (RT_SUCCESS(rc))
2478 {
2479 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pDescFile->pStorage,
2480 uOffset, pvDescriptor,
2481 cbLimit ? cbLimit : cbDescriptor,
2482 pIoCtx, NULL, NULL);
2483 if ( RT_FAILURE(rc)
2484 && rc != VERR_VD_ASYNC_IO_IN_PROGRESS)
2485 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error writing descriptor in '%s'"), pImage->pszFilename);
2486 }
2487
2488 if (RT_SUCCESS(rc) && !cbLimit)
2489 {
2490 rc = vdIfIoIntFileSetSize(pImage->pIfIo, pDescFile->pStorage, cbDescriptor);
2491 if (RT_FAILURE(rc))
2492 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error truncating descriptor in '%s'"), pImage->pszFilename);
2493 }
2494
2495 if (RT_SUCCESS(rc))
2496 pImage->Descriptor.fDirty = false;
2497
2498 if (pvDescriptor)
2499 RTMemFree(pvDescriptor);
2500 return rc;
2501
2502}
2503
2504/**
2505 * Internal: validate the consistency check values in a binary header.
2506 */
2507static int vmdkValidateHeader(PVMDKIMAGE pImage, PVMDKEXTENT pExtent, const SparseExtentHeader *pHeader)
2508{
2509 int rc = VINF_SUCCESS;
2510 if (RT_LE2H_U32(pHeader->magicNumber) != VMDK_SPARSE_MAGICNUMBER)
2511 {
2512 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect magic in sparse extent header in '%s'"), pExtent->pszFullname);
2513 return rc;
2514 }
2515 if (RT_LE2H_U32(pHeader->version) != 1 && RT_LE2H_U32(pHeader->version) != 3)
2516 {
2517 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_UNSUPPORTED_VERSION, RT_SRC_POS, N_("VMDK: incorrect version in sparse extent header in '%s', not a VMDK 1.0/1.1 conforming file"), pExtent->pszFullname);
2518 return rc;
2519 }
2520 if ( (RT_LE2H_U32(pHeader->flags) & 1)
2521 && ( pHeader->singleEndLineChar != '\n'
2522 || pHeader->nonEndLineChar != ' '
2523 || pHeader->doubleEndLineChar1 != '\r'
2524 || pHeader->doubleEndLineChar2 != '\n') )
2525 {
2526 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: corrupted by CR/LF translation in '%s'"), pExtent->pszFullname);
2527 return rc;
2528 }
2529 return rc;
2530}
2531
2532/**
2533 * Internal: read metadata belonging to an extent with binary header, i.e.
2534 * as found in monolithic files.
2535 */
2536static int vmdkReadBinaryMetaExtent(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
2537 bool fMagicAlreadyRead)
2538{
2539 SparseExtentHeader Header;
2540 uint64_t cSectorsPerGDE;
2541 uint64_t cbFile = 0;
2542 int rc;
2543
2544 if (!fMagicAlreadyRead)
2545 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage, 0,
2546 &Header, sizeof(Header));
2547 else
2548 {
2549 Header.magicNumber = RT_H2LE_U32(VMDK_SPARSE_MAGICNUMBER);
2550 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
2551 RT_OFFSETOF(SparseExtentHeader, version),
2552 &Header.version,
2553 sizeof(Header)
2554 - RT_OFFSETOF(SparseExtentHeader, version));
2555 }
2556 AssertRC(rc);
2557 if (RT_FAILURE(rc))
2558 {
2559 vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error reading extent header in '%s'"), pExtent->pszFullname);
2560 rc = VERR_VD_VMDK_INVALID_HEADER;
2561 goto out;
2562 }
2563 rc = vmdkValidateHeader(pImage, pExtent, &Header);
2564 if (RT_FAILURE(rc))
2565 goto out;
2566
2567 if ( (RT_LE2H_U32(Header.flags) & RT_BIT(17))
2568 && RT_LE2H_U64(Header.gdOffset) == VMDK_GD_AT_END)
2569 pExtent->fFooter = true;
2570
2571 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2572 || ( pExtent->fFooter
2573 && !(pImage->uOpenFlags & VD_OPEN_FLAGS_SEQUENTIAL)))
2574 {
2575 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pExtent->pFile->pStorage, &cbFile);
2576 AssertRC(rc);
2577 if (RT_FAILURE(rc))
2578 {
2579 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot get size of '%s'"), pExtent->pszFullname);
2580 goto out;
2581 }
2582 }
2583
2584 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
2585 pExtent->uAppendPosition = RT_ALIGN_64(cbFile, 512);
2586
2587 if ( pExtent->fFooter
2588 && ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2589 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_SEQUENTIAL)))
2590 {
2591 /* Read the footer, which comes before the end-of-stream marker. */
2592 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
2593 cbFile - 2*512, &Header,
2594 sizeof(Header));
2595 AssertRC(rc);
2596 if (RT_FAILURE(rc))
2597 {
2598 vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error reading extent footer in '%s'"), pExtent->pszFullname);
2599 rc = VERR_VD_VMDK_INVALID_HEADER;
2600 goto out;
2601 }
2602 rc = vmdkValidateHeader(pImage, pExtent, &Header);
2603 if (RT_FAILURE(rc))
2604 goto out;
2605 /* Prohibit any writes to this extent. */
2606 pExtent->uAppendPosition = 0;
2607 }
2608
2609 pExtent->uVersion = RT_LE2H_U32(Header.version);
2610 pExtent->enmType = VMDKETYPE_HOSTED_SPARSE; /* Just dummy value, changed later. */
2611 pExtent->cSectors = RT_LE2H_U64(Header.capacity);
2612 pExtent->cSectorsPerGrain = RT_LE2H_U64(Header.grainSize);
2613 pExtent->uDescriptorSector = RT_LE2H_U64(Header.descriptorOffset);
2614 pExtent->cDescriptorSectors = RT_LE2H_U64(Header.descriptorSize);
2615 if (pExtent->uDescriptorSector && !pExtent->cDescriptorSectors)
2616 {
2617 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: inconsistent embedded descriptor config in '%s'"), pExtent->pszFullname);
2618 goto out;
2619 }
2620 pExtent->cGTEntries = RT_LE2H_U32(Header.numGTEsPerGT);
2621 if (RT_LE2H_U32(Header.flags) & RT_BIT(1))
2622 {
2623 pExtent->uSectorRGD = RT_LE2H_U64(Header.rgdOffset);
2624 pExtent->uSectorGD = RT_LE2H_U64(Header.gdOffset);
2625 }
2626 else
2627 {
2628 pExtent->uSectorGD = RT_LE2H_U64(Header.gdOffset);
2629 pExtent->uSectorRGD = 0;
2630 }
2631 if ( ( pExtent->uSectorGD == VMDK_GD_AT_END
2632 || pExtent->uSectorRGD == VMDK_GD_AT_END)
2633 && ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2634 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_SEQUENTIAL)))
2635 {
2636 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: cannot resolve grain directory offset in '%s'"), pExtent->pszFullname);
2637 goto out;
2638 }
2639 pExtent->cOverheadSectors = RT_LE2H_U64(Header.overHead);
2640 pExtent->fUncleanShutdown = !!Header.uncleanShutdown;
2641 pExtent->uCompression = RT_LE2H_U16(Header.compressAlgorithm);
2642 cSectorsPerGDE = pExtent->cGTEntries * pExtent->cSectorsPerGrain;
2643 if (!cSectorsPerGDE || cSectorsPerGDE > UINT32_MAX)
2644 {
2645 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect grain directory size in '%s'"), pExtent->pszFullname);
2646 goto out;
2647 }
2648 pExtent->cSectorsPerGDE = cSectorsPerGDE;
2649 pExtent->cGDEntries = (pExtent->cSectors + cSectorsPerGDE - 1) / cSectorsPerGDE;
2650
2651 /* Fix up the number of descriptor sectors, as some flat images have
2652 * really just one, and this causes failures when inserting the UUID
2653 * values and other extra information. */
2654 if (pExtent->cDescriptorSectors != 0 && pExtent->cDescriptorSectors < 4)
2655 {
2656 /* Do it the easy way - just fix it for flat images which have no
2657 * other complicated metadata which needs space too. */
2658 if ( pExtent->uDescriptorSector + 4 < pExtent->cOverheadSectors
2659 && pExtent->cGTEntries * pExtent->cGDEntries == 0)
2660 pExtent->cDescriptorSectors = 4;
2661 }
2662
2663out:
2664 if (RT_FAILURE(rc))
2665 vmdkFreeExtentData(pImage, pExtent, false);
2666
2667 return rc;
2668}
2669
2670/**
2671 * Internal: read additional metadata belonging to an extent. For those
2672 * extents which have no additional metadata just verify the information.
2673 */
2674static int vmdkReadMetaExtent(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
2675{
2676 int rc = VINF_SUCCESS;
2677
2678/* disabled the check as there are too many truncated vmdk images out there */
2679#ifdef VBOX_WITH_VMDK_STRICT_SIZE_CHECK
2680 uint64_t cbExtentSize;
2681 /* The image must be a multiple of a sector in size and contain the data
2682 * area (flat images only). If not, it means the image is at least
2683 * truncated, or even seriously garbled. */
2684 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pExtent->pFile->pStorage, &cbExtentSize);
2685 if (RT_FAILURE(rc))
2686 {
2687 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error getting size in '%s'"), pExtent->pszFullname);
2688 goto out;
2689 }
2690 if ( cbExtentSize != RT_ALIGN_64(cbExtentSize, 512)
2691 && (pExtent->enmType != VMDKETYPE_FLAT || pExtent->cNominalSectors + pExtent->uSectorOffset > VMDK_BYTE2SECTOR(cbExtentSize)))
2692 {
2693 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: file size is not a multiple of 512 in '%s', file is truncated or otherwise garbled"), pExtent->pszFullname);
2694 goto out;
2695 }
2696#endif /* VBOX_WITH_VMDK_STRICT_SIZE_CHECK */
2697 if (pExtent->enmType != VMDKETYPE_HOSTED_SPARSE)
2698 goto out;
2699
2700 /* The spec says that this must be a power of two and greater than 8,
2701 * but probably they meant not less than 8. */
2702 if ( (pExtent->cSectorsPerGrain & (pExtent->cSectorsPerGrain - 1))
2703 || pExtent->cSectorsPerGrain < 8)
2704 {
2705 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: invalid extent grain size %u in '%s'"), pExtent->cSectorsPerGrain, pExtent->pszFullname);
2706 goto out;
2707 }
2708
2709 /* This code requires that a grain table must hold a power of two multiple
2710 * of the number of entries per GT cache entry. */
2711 if ( (pExtent->cGTEntries & (pExtent->cGTEntries - 1))
2712 || pExtent->cGTEntries < VMDK_GT_CACHELINE_SIZE)
2713 {
2714 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: grain table cache size problem in '%s'"), pExtent->pszFullname);
2715 goto out;
2716 }
2717
2718 rc = vmdkAllocStreamBuffers(pImage, pExtent);
2719 if (RT_FAILURE(rc))
2720 goto out;
2721
2722 /* Prohibit any writes to this streamOptimized extent. */
2723 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
2724 pExtent->uAppendPosition = 0;
2725
2726 if ( !(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
2727 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
2728 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_SEQUENTIAL))
2729 rc = vmdkReadGrainDirectory(pImage, pExtent);
2730 else
2731 {
2732 pExtent->uGrainSectorAbs = pExtent->cOverheadSectors;
2733 pExtent->cbGrainStreamRead = 0;
2734 }
2735
2736out:
2737 if (RT_FAILURE(rc))
2738 vmdkFreeExtentData(pImage, pExtent, false);
2739
2740 return rc;
2741}
2742
2743/**
2744 * Internal: write/update the metadata for a sparse extent.
2745 */
2746static int vmdkWriteMetaSparseExtent(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
2747 uint64_t uOffset, PVDIOCTX pIoCtx)
2748{
2749 SparseExtentHeader Header;
2750
2751 memset(&Header, '\0', sizeof(Header));
2752 Header.magicNumber = RT_H2LE_U32(VMDK_SPARSE_MAGICNUMBER);
2753 Header.version = RT_H2LE_U32(pExtent->uVersion);
2754 Header.flags = RT_H2LE_U32(RT_BIT(0));
2755 if (pExtent->pRGD)
2756 Header.flags |= RT_H2LE_U32(RT_BIT(1));
2757 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
2758 Header.flags |= RT_H2LE_U32(RT_BIT(16) | RT_BIT(17));
2759 Header.capacity = RT_H2LE_U64(pExtent->cSectors);
2760 Header.grainSize = RT_H2LE_U64(pExtent->cSectorsPerGrain);
2761 Header.descriptorOffset = RT_H2LE_U64(pExtent->uDescriptorSector);
2762 Header.descriptorSize = RT_H2LE_U64(pExtent->cDescriptorSectors);
2763 Header.numGTEsPerGT = RT_H2LE_U32(pExtent->cGTEntries);
2764 if (pExtent->fFooter && uOffset == 0)
2765 {
2766 if (pExtent->pRGD)
2767 {
2768 Assert(pExtent->uSectorRGD);
2769 Header.rgdOffset = RT_H2LE_U64(VMDK_GD_AT_END);
2770 Header.gdOffset = RT_H2LE_U64(VMDK_GD_AT_END);
2771 }
2772 else
2773 {
2774 Header.gdOffset = RT_H2LE_U64(VMDK_GD_AT_END);
2775 }
2776 }
2777 else
2778 {
2779 if (pExtent->pRGD)
2780 {
2781 Assert(pExtent->uSectorRGD);
2782 Header.rgdOffset = RT_H2LE_U64(pExtent->uSectorRGD);
2783 Header.gdOffset = RT_H2LE_U64(pExtent->uSectorGD);
2784 }
2785 else
2786 {
2787 Header.gdOffset = RT_H2LE_U64(pExtent->uSectorGD);
2788 }
2789 }
2790 Header.overHead = RT_H2LE_U64(pExtent->cOverheadSectors);
2791 Header.uncleanShutdown = pExtent->fUncleanShutdown;
2792 Header.singleEndLineChar = '\n';
2793 Header.nonEndLineChar = ' ';
2794 Header.doubleEndLineChar1 = '\r';
2795 Header.doubleEndLineChar2 = '\n';
2796 Header.compressAlgorithm = RT_H2LE_U16(pExtent->uCompression);
2797
2798 int rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pExtent->pFile->pStorage,
2799 uOffset, &Header, sizeof(Header),
2800 pIoCtx, NULL, NULL);
2801 if (RT_FAILURE(rc) && (rc != VERR_VD_ASYNC_IO_IN_PROGRESS))
2802 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error writing extent header in '%s'"), pExtent->pszFullname);
2803 return rc;
2804}
2805
2806#ifdef VBOX_WITH_VMDK_ESX
2807/**
2808 * Internal: unused code to read the metadata of a sparse ESX extent.
2809 *
2810 * Such extents never leave ESX server, so this isn't ever used.
2811 */
2812static int vmdkReadMetaESXSparseExtent(PVMDKEXTENT pExtent)
2813{
2814 COWDisk_Header Header;
2815 uint64_t cSectorsPerGDE;
2816
2817 int rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage, 0,
2818 &Header, sizeof(Header));
2819 AssertRC(rc);
2820 if (RT_FAILURE(rc))
2821 {
2822 vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error reading ESX sparse extent header in '%s'"), pExtent->pszFullname);
2823 rc = VERR_VD_VMDK_INVALID_HEADER;
2824 goto out;
2825 }
2826 if ( RT_LE2H_U32(Header.magicNumber) != VMDK_ESX_SPARSE_MAGICNUMBER
2827 || RT_LE2H_U32(Header.version) != 1
2828 || RT_LE2H_U32(Header.flags) != 3)
2829 {
2830 rc = VERR_VD_VMDK_INVALID_HEADER;
2831 goto out;
2832 }
2833 pExtent->enmType = VMDKETYPE_ESX_SPARSE;
2834 pExtent->cSectors = RT_LE2H_U32(Header.numSectors);
2835 pExtent->cSectorsPerGrain = RT_LE2H_U32(Header.grainSize);
2836 /* The spec says that this must be between 1 sector and 1MB. This code
2837 * assumes it's a power of two, so check that requirement, too. */
2838 if ( (pExtent->cSectorsPerGrain & (pExtent->cSectorsPerGrain - 1))
2839 || pExtent->cSectorsPerGrain == 0
2840 || pExtent->cSectorsPerGrain > 2048)
2841 {
2842 rc = VERR_VD_VMDK_INVALID_HEADER;
2843 goto out;
2844 }
2845 pExtent->uDescriptorSector = 0;
2846 pExtent->cDescriptorSectors = 0;
2847 pExtent->uSectorGD = RT_LE2H_U32(Header.gdOffset);
2848 pExtent->uSectorRGD = 0;
2849 pExtent->cOverheadSectors = 0;
2850 pExtent->cGTEntries = 4096;
2851 cSectorsPerGDE = pExtent->cGTEntries * pExtent->cSectorsPerGrain;
2852 if (!cSectorsPerGDE || cSectorsPerGDE > UINT32_MAX)
2853 {
2854 rc = VERR_VD_VMDK_INVALID_HEADER;
2855 goto out;
2856 }
2857 pExtent->cSectorsPerGDE = cSectorsPerGDE;
2858 pExtent->cGDEntries = (pExtent->cSectors + cSectorsPerGDE - 1) / cSectorsPerGDE;
2859 if (pExtent->cGDEntries != RT_LE2H_U32(Header.numGDEntries))
2860 {
2861 /* Inconsistency detected. Computed number of GD entries doesn't match
2862 * stored value. Better be safe than sorry. */
2863 rc = VERR_VD_VMDK_INVALID_HEADER;
2864 goto out;
2865 }
2866 pExtent->uFreeSector = RT_LE2H_U32(Header.freeSector);
2867 pExtent->fUncleanShutdown = !!Header.uncleanShutdown;
2868
2869 rc = vmdkReadGrainDirectory(pImage, pExtent);
2870
2871out:
2872 if (RT_FAILURE(rc))
2873 vmdkFreeExtentData(pImage, pExtent, false);
2874
2875 return rc;
2876}
2877#endif /* VBOX_WITH_VMDK_ESX */
2878
2879/**
2880 * Internal: free the buffers used for streamOptimized images.
2881 */
2882static void vmdkFreeStreamBuffers(PVMDKEXTENT pExtent)
2883{
2884 if (pExtent->pvCompGrain)
2885 {
2886 RTMemFree(pExtent->pvCompGrain);
2887 pExtent->pvCompGrain = NULL;
2888 }
2889 if (pExtent->pvGrain)
2890 {
2891 RTMemFree(pExtent->pvGrain);
2892 pExtent->pvGrain = NULL;
2893 }
2894}
2895
2896/**
2897 * Internal: free the memory used by the extent data structure, optionally
2898 * deleting the referenced files.
2899 *
2900 * @returns VBox status code.
2901 * @param pImage Pointer to the image instance data.
2902 * @param pExtent The extent to free.
2903 * @param fDelete Flag whether to delete the backing storage.
2904 */
2905static int vmdkFreeExtentData(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
2906 bool fDelete)
2907{
2908 int rc = VINF_SUCCESS;
2909
2910 vmdkFreeGrainDirectory(pExtent);
2911 if (pExtent->pDescData)
2912 {
2913 RTMemFree(pExtent->pDescData);
2914 pExtent->pDescData = NULL;
2915 }
2916 if (pExtent->pFile != NULL)
2917 {
2918 /* Do not delete raw extents, these have full and base names equal. */
2919 rc = vmdkFileClose(pImage, &pExtent->pFile,
2920 fDelete
2921 && pExtent->pszFullname
2922 && pExtent->pszBasename
2923 && strcmp(pExtent->pszFullname, pExtent->pszBasename));
2924 }
2925 if (pExtent->pszBasename)
2926 {
2927 RTMemTmpFree((void *)pExtent->pszBasename);
2928 pExtent->pszBasename = NULL;
2929 }
2930 if (pExtent->pszFullname)
2931 {
2932 RTStrFree((char *)(void *)pExtent->pszFullname);
2933 pExtent->pszFullname = NULL;
2934 }
2935 vmdkFreeStreamBuffers(pExtent);
2936
2937 return rc;
2938}
2939
2940/**
2941 * Internal: allocate grain table cache if necessary for this image.
2942 */
2943static int vmdkAllocateGrainTableCache(PVMDKIMAGE pImage)
2944{
2945 PVMDKEXTENT pExtent;
2946
2947 /* Allocate grain table cache if any sparse extent is present. */
2948 for (unsigned i = 0; i < pImage->cExtents; i++)
2949 {
2950 pExtent = &pImage->pExtents[i];
2951 if ( pExtent->enmType == VMDKETYPE_HOSTED_SPARSE
2952#ifdef VBOX_WITH_VMDK_ESX
2953 || pExtent->enmType == VMDKETYPE_ESX_SPARSE
2954#endif /* VBOX_WITH_VMDK_ESX */
2955 )
2956 {
2957 /* Allocate grain table cache. */
2958 pImage->pGTCache = (PVMDKGTCACHE)RTMemAllocZ(sizeof(VMDKGTCACHE));
2959 if (!pImage->pGTCache)
2960 return VERR_NO_MEMORY;
2961 for (unsigned j = 0; j < VMDK_GT_CACHE_SIZE; j++)
2962 {
2963 PVMDKGTCACHEENTRY pGCE = &pImage->pGTCache->aGTCache[j];
2964 pGCE->uExtent = UINT32_MAX;
2965 }
2966 pImage->pGTCache->cEntries = VMDK_GT_CACHE_SIZE;
2967 break;
2968 }
2969 }
2970
2971 return VINF_SUCCESS;
2972}
2973
2974/**
2975 * Internal: allocate the given number of extents.
2976 */
2977static int vmdkCreateExtents(PVMDKIMAGE pImage, unsigned cExtents)
2978{
2979 int rc = VINF_SUCCESS;
2980 PVMDKEXTENT pExtents = (PVMDKEXTENT)RTMemAllocZ(cExtents * sizeof(VMDKEXTENT));
2981 if (pExtents)
2982 {
2983 for (unsigned i = 0; i < cExtents; i++)
2984 {
2985 pExtents[i].pFile = NULL;
2986 pExtents[i].pszBasename = NULL;
2987 pExtents[i].pszFullname = NULL;
2988 pExtents[i].pGD = NULL;
2989 pExtents[i].pRGD = NULL;
2990 pExtents[i].pDescData = NULL;
2991 pExtents[i].uVersion = 1;
2992 pExtents[i].uCompression = VMDK_COMPRESSION_NONE;
2993 pExtents[i].uExtent = i;
2994 pExtents[i].pImage = pImage;
2995 }
2996 pImage->pExtents = pExtents;
2997 pImage->cExtents = cExtents;
2998 }
2999 else
3000 rc = VERR_NO_MEMORY;
3001
3002 return rc;
3003}
3004
3005/**
3006 * Internal: Open an image, constructing all necessary data structures.
3007 */
3008static int vmdkOpenImage(PVMDKIMAGE pImage, unsigned uOpenFlags)
3009{
3010 int rc;
3011 uint32_t u32Magic;
3012 PVMDKFILE pFile;
3013 PVMDKEXTENT pExtent;
3014
3015 pImage->uOpenFlags = uOpenFlags;
3016
3017 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
3018 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
3019 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
3020
3021 /*
3022 * Open the image.
3023 * We don't have to check for asynchronous access because
3024 * we only support raw access and the opened file is a description
3025 * file were no data is stored.
3026 */
3027
3028 rc = vmdkFileOpen(pImage, &pFile, pImage->pszFilename,
3029 VDOpenFlagsToFileOpenFlags(uOpenFlags, false /* fCreate */));
3030 if (RT_FAILURE(rc))
3031 {
3032 /* Do NOT signal an appropriate error here, as the VD layer has the
3033 * choice of retrying the open if it failed. */
3034 goto out;
3035 }
3036 pImage->pFile = pFile;
3037
3038 /* Read magic (if present). */
3039 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pFile->pStorage, 0,
3040 &u32Magic, sizeof(u32Magic));
3041 if (RT_FAILURE(rc))
3042 {
3043 vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error reading the magic number in '%s'"), pImage->pszFilename);
3044 rc = VERR_VD_VMDK_INVALID_HEADER;
3045 goto out;
3046 }
3047
3048 /* Handle the file according to its magic number. */
3049 if (RT_LE2H_U32(u32Magic) == VMDK_SPARSE_MAGICNUMBER)
3050 {
3051 /* It's a hosted single-extent image. */
3052 rc = vmdkCreateExtents(pImage, 1);
3053 if (RT_FAILURE(rc))
3054 goto out;
3055 /* The opened file is passed to the extent. No separate descriptor
3056 * file, so no need to keep anything open for the image. */
3057 pExtent = &pImage->pExtents[0];
3058 pExtent->pFile = pFile;
3059 pImage->pFile = NULL;
3060 pExtent->pszFullname = RTPathAbsDup(pImage->pszFilename);
3061 if (!pExtent->pszFullname)
3062 {
3063 rc = VERR_NO_MEMORY;
3064 goto out;
3065 }
3066 rc = vmdkReadBinaryMetaExtent(pImage, pExtent, true /* fMagicAlreadyRead */);
3067 if (RT_FAILURE(rc))
3068 goto out;
3069
3070 /* As we're dealing with a monolithic image here, there must
3071 * be a descriptor embedded in the image file. */
3072 if (!pExtent->uDescriptorSector || !pExtent->cDescriptorSectors)
3073 {
3074 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: monolithic image without descriptor in '%s'"), pImage->pszFilename);
3075 goto out;
3076 }
3077 /* HACK: extend the descriptor if it is unusually small and it fits in
3078 * the unused space after the image header. Allows opening VMDK files
3079 * with extremely small descriptor in read/write mode. */
3080 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
3081 && pExtent->cDescriptorSectors < 3
3082 && (int64_t)pExtent->uSectorGD - pExtent->uDescriptorSector >= 4
3083 && (!pExtent->uSectorRGD || (int64_t)pExtent->uSectorRGD - pExtent->uDescriptorSector >= 4))
3084 {
3085 pExtent->cDescriptorSectors = 4;
3086 pExtent->fMetaDirty = true;
3087 }
3088 /* Read the descriptor from the extent. */
3089 pExtent->pDescData = (char *)RTMemAllocZ(VMDK_SECTOR2BYTE(pExtent->cDescriptorSectors));
3090 if (!pExtent->pDescData)
3091 {
3092 rc = VERR_NO_MEMORY;
3093 goto out;
3094 }
3095 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
3096 VMDK_SECTOR2BYTE(pExtent->uDescriptorSector),
3097 pExtent->pDescData,
3098 VMDK_SECTOR2BYTE(pExtent->cDescriptorSectors));
3099 AssertRC(rc);
3100 if (RT_FAILURE(rc))
3101 {
3102 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: read error for descriptor in '%s'"), pExtent->pszFullname);
3103 goto out;
3104 }
3105
3106 rc = vmdkParseDescriptor(pImage, pExtent->pDescData,
3107 VMDK_SECTOR2BYTE(pExtent->cDescriptorSectors));
3108 if (RT_FAILURE(rc))
3109 goto out;
3110
3111 if ( pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED
3112 && uOpenFlags & VD_OPEN_FLAGS_ASYNC_IO)
3113 {
3114 rc = VERR_NOT_SUPPORTED;
3115 goto out;
3116 }
3117
3118 rc = vmdkReadMetaExtent(pImage, pExtent);
3119 if (RT_FAILURE(rc))
3120 goto out;
3121
3122 /* Mark the extent as unclean if opened in read-write mode. */
3123 if ( !(uOpenFlags & VD_OPEN_FLAGS_READONLY)
3124 && !(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED))
3125 {
3126 pExtent->fUncleanShutdown = true;
3127 pExtent->fMetaDirty = true;
3128 }
3129 }
3130 else
3131 {
3132 /* Allocate at least 10K, and make sure that there is 5K free space
3133 * in case new entries need to be added to the descriptor. Never
3134 * allocate more than 128K, because that's no valid descriptor file
3135 * and will result in the correct "truncated read" error handling. */
3136 uint64_t cbFileSize;
3137 rc = vdIfIoIntFileGetSize(pImage->pIfIo, pFile->pStorage, &cbFileSize);
3138 if (RT_FAILURE(rc))
3139 goto out;
3140
3141 /* If the descriptor file is shorter than 50 bytes it can't be valid. */
3142 if (cbFileSize < 50)
3143 {
3144 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: descriptor in '%s' is too short"), pImage->pszFilename);
3145 goto out;
3146 }
3147
3148 uint64_t cbSize = cbFileSize;
3149 if (cbSize % VMDK_SECTOR2BYTE(10))
3150 cbSize += VMDK_SECTOR2BYTE(20) - cbSize % VMDK_SECTOR2BYTE(10);
3151 else
3152 cbSize += VMDK_SECTOR2BYTE(10);
3153 cbSize = RT_MIN(cbSize, _128K);
3154 pImage->cbDescAlloc = RT_MAX(VMDK_SECTOR2BYTE(20), cbSize);
3155 pImage->pDescData = (char *)RTMemAllocZ(pImage->cbDescAlloc);
3156 if (!pImage->pDescData)
3157 {
3158 rc = VERR_NO_MEMORY;
3159 goto out;
3160 }
3161
3162 /* Don't reread the place where the magic would live in a sparse
3163 * image if it's a descriptor based one. */
3164 memcpy(pImage->pDescData, &u32Magic, sizeof(u32Magic));
3165 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pFile->pStorage, sizeof(u32Magic),
3166 pImage->pDescData + sizeof(u32Magic),
3167 RT_MIN(pImage->cbDescAlloc - sizeof(u32Magic),
3168 cbFileSize - sizeof(u32Magic)));
3169 if (RT_FAILURE(rc))
3170 {
3171 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: read error for descriptor in '%s'"), pImage->pszFilename);
3172 goto out;
3173 }
3174
3175#if 0 /** @todo: Revisit */
3176 cbRead += sizeof(u32Magic);
3177 if (cbRead == pImage->cbDescAlloc)
3178 {
3179 /* Likely the read is truncated. Better fail a bit too early
3180 * (normally the descriptor is much smaller than our buffer). */
3181 rc = vdIfError(pImage->pIfError, VERR_VD_VMDK_INVALID_HEADER, RT_SRC_POS, N_("VMDK: cannot read descriptor in '%s'"), pImage->pszFilename);
3182 goto out;
3183 }
3184#endif
3185
3186 rc = vmdkParseDescriptor(pImage, pImage->pDescData,
3187 pImage->cbDescAlloc);
3188 if (RT_FAILURE(rc))
3189 goto out;
3190
3191 /*
3192 * We have to check for the asynchronous open flag. The
3193 * extents are parsed and the type of all are known now.
3194 * Check if every extent is either FLAT or ZERO.
3195 */
3196 if (uOpenFlags & VD_OPEN_FLAGS_ASYNC_IO)
3197 {
3198 unsigned cFlatExtents = 0;
3199
3200 for (unsigned i = 0; i < pImage->cExtents; i++)
3201 {
3202 pExtent = &pImage->pExtents[i];
3203
3204 if (( pExtent->enmType != VMDKETYPE_FLAT
3205 && pExtent->enmType != VMDKETYPE_ZERO
3206 && pExtent->enmType != VMDKETYPE_VMFS)
3207 || ((pImage->pExtents[i].enmType == VMDKETYPE_FLAT) && (cFlatExtents > 0)))
3208 {
3209 /*
3210 * Opened image contains at least one none flat or zero extent.
3211 * Return error but don't set error message as the caller
3212 * has the chance to open in non async I/O mode.
3213 */
3214 rc = VERR_NOT_SUPPORTED;
3215 goto out;
3216 }
3217 if (pExtent->enmType == VMDKETYPE_FLAT)
3218 cFlatExtents++;
3219 }
3220 }
3221
3222 for (unsigned i = 0; i < pImage->cExtents; i++)
3223 {
3224 pExtent = &pImage->pExtents[i];
3225
3226 if (pExtent->pszBasename)
3227 {
3228 /* Hack to figure out whether the specified name in the
3229 * extent descriptor is absolute. Doesn't always work, but
3230 * should be good enough for now. */
3231 char *pszFullname;
3232 /** @todo implement proper path absolute check. */
3233 if (pExtent->pszBasename[0] == RTPATH_SLASH)
3234 {
3235 pszFullname = RTStrDup(pExtent->pszBasename);
3236 if (!pszFullname)
3237 {
3238 rc = VERR_NO_MEMORY;
3239 goto out;
3240 }
3241 }
3242 else
3243 {
3244 char *pszDirname = RTStrDup(pImage->pszFilename);
3245 if (!pszDirname)
3246 {
3247 rc = VERR_NO_MEMORY;
3248 goto out;
3249 }
3250 RTPathStripFilename(pszDirname);
3251 pszFullname = RTPathJoinA(pszDirname, pExtent->pszBasename);
3252 RTStrFree(pszDirname);
3253 if (!pszFullname)
3254 {
3255 rc = VERR_NO_STR_MEMORY;
3256 goto out;
3257 }
3258 }
3259 pExtent->pszFullname = pszFullname;
3260 }
3261 else
3262 pExtent->pszFullname = NULL;
3263
3264 switch (pExtent->enmType)
3265 {
3266 case VMDKETYPE_HOSTED_SPARSE:
3267 rc = vmdkFileOpen(pImage, &pExtent->pFile, pExtent->pszFullname,
3268 VDOpenFlagsToFileOpenFlags(uOpenFlags | ((pExtent->enmAccess == VMDKACCESS_READONLY) ? VD_OPEN_FLAGS_READONLY : 0),
3269 false /* fCreate */));
3270 if (RT_FAILURE(rc))
3271 {
3272 /* Do NOT signal an appropriate error here, as the VD
3273 * layer has the choice of retrying the open if it
3274 * failed. */
3275 goto out;
3276 }
3277 rc = vmdkReadBinaryMetaExtent(pImage, pExtent,
3278 false /* fMagicAlreadyRead */);
3279 if (RT_FAILURE(rc))
3280 goto out;
3281 rc = vmdkReadMetaExtent(pImage, pExtent);
3282 if (RT_FAILURE(rc))
3283 goto out;
3284
3285 /* Mark extent as unclean if opened in read-write mode. */
3286 if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
3287 {
3288 pExtent->fUncleanShutdown = true;
3289 pExtent->fMetaDirty = true;
3290 }
3291 break;
3292 case VMDKETYPE_VMFS:
3293 case VMDKETYPE_FLAT:
3294 rc = vmdkFileOpen(pImage, &pExtent->pFile, pExtent->pszFullname,
3295 VDOpenFlagsToFileOpenFlags(uOpenFlags | ((pExtent->enmAccess == VMDKACCESS_READONLY) ? VD_OPEN_FLAGS_READONLY : 0),
3296 false /* fCreate */));
3297 if (RT_FAILURE(rc))
3298 {
3299 /* Do NOT signal an appropriate error here, as the VD
3300 * layer has the choice of retrying the open if it
3301 * failed. */
3302 goto out;
3303 }
3304 break;
3305 case VMDKETYPE_ZERO:
3306 /* Nothing to do. */
3307 break;
3308 default:
3309 AssertMsgFailed(("unknown vmdk extent type %d\n", pExtent->enmType));
3310 }
3311 }
3312 }
3313
3314 /* Make sure this is not reached accidentally with an error status. */
3315 AssertRC(rc);
3316
3317 /* Determine PCHS geometry if not set. */
3318 if (pImage->PCHSGeometry.cCylinders == 0)
3319 {
3320 uint64_t cCylinders = VMDK_BYTE2SECTOR(pImage->cbSize)
3321 / pImage->PCHSGeometry.cHeads
3322 / pImage->PCHSGeometry.cSectors;
3323 pImage->PCHSGeometry.cCylinders = (unsigned)RT_MIN(cCylinders, 16383);
3324 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
3325 && !(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED))
3326 {
3327 rc = vmdkDescSetPCHSGeometry(pImage, &pImage->PCHSGeometry);
3328 AssertRC(rc);
3329 }
3330 }
3331
3332 /* Update the image metadata now in case has changed. */
3333 rc = vmdkFlushImage(pImage, NULL);
3334 if (RT_FAILURE(rc))
3335 goto out;
3336
3337 /* Figure out a few per-image constants from the extents. */
3338 pImage->cbSize = 0;
3339 for (unsigned i = 0; i < pImage->cExtents; i++)
3340 {
3341 pExtent = &pImage->pExtents[i];
3342 if ( pExtent->enmType == VMDKETYPE_HOSTED_SPARSE
3343#ifdef VBOX_WITH_VMDK_ESX
3344 || pExtent->enmType == VMDKETYPE_ESX_SPARSE
3345#endif /* VBOX_WITH_VMDK_ESX */
3346 )
3347 {
3348 /* Here used to be a check whether the nominal size of an extent
3349 * is a multiple of the grain size. The spec says that this is
3350 * always the case, but unfortunately some files out there in the
3351 * wild violate the spec (e.g. ReactOS 0.3.1). */
3352 }
3353 pImage->cbSize += VMDK_SECTOR2BYTE(pExtent->cNominalSectors);
3354 }
3355
3356 for (unsigned i = 0; i < pImage->cExtents; i++)
3357 {
3358 pExtent = &pImage->pExtents[i];
3359 if ( pImage->pExtents[i].enmType == VMDKETYPE_FLAT
3360 || pImage->pExtents[i].enmType == VMDKETYPE_ZERO)
3361 {
3362 pImage->uImageFlags |= VD_IMAGE_FLAGS_FIXED;
3363 break;
3364 }
3365 }
3366
3367 if ( !(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
3368 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
3369 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_SEQUENTIAL))
3370 rc = vmdkAllocateGrainTableCache(pImage);
3371
3372out:
3373 if (RT_FAILURE(rc))
3374 vmdkFreeImage(pImage, false);
3375 return rc;
3376}
3377
3378/**
3379 * Internal: create VMDK images for raw disk/partition access.
3380 */
3381static int vmdkCreateRawImage(PVMDKIMAGE pImage, const PVBOXHDDRAW pRaw,
3382 uint64_t cbSize)
3383{
3384 int rc = VINF_SUCCESS;
3385 PVMDKEXTENT pExtent;
3386
3387 if (pRaw->uFlags & VBOXHDDRAW_DISK)
3388 {
3389 /* Full raw disk access. This requires setting up a descriptor
3390 * file and open the (flat) raw disk. */
3391 rc = vmdkCreateExtents(pImage, 1);
3392 if (RT_FAILURE(rc))
3393 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new extent list in '%s'"), pImage->pszFilename);
3394 pExtent = &pImage->pExtents[0];
3395 /* Create raw disk descriptor file. */
3396 rc = vmdkFileOpen(pImage, &pImage->pFile, pImage->pszFilename,
3397 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags,
3398 true /* fCreate */));
3399 if (RT_FAILURE(rc))
3400 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new file '%s'"), pImage->pszFilename);
3401
3402 /* Set up basename for extent description. Cannot use StrDup. */
3403 size_t cbBasename = strlen(pRaw->pszRawDisk) + 1;
3404 char *pszBasename = (char *)RTMemTmpAlloc(cbBasename);
3405 if (!pszBasename)
3406 return VERR_NO_MEMORY;
3407 memcpy(pszBasename, pRaw->pszRawDisk, cbBasename);
3408 pExtent->pszBasename = pszBasename;
3409 /* For raw disks the full name is identical to the base name. */
3410 pExtent->pszFullname = RTStrDup(pszBasename);
3411 if (!pExtent->pszFullname)
3412 return VERR_NO_MEMORY;
3413 pExtent->enmType = VMDKETYPE_FLAT;
3414 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(cbSize);
3415 pExtent->uSectorOffset = 0;
3416 pExtent->enmAccess = (pRaw->uFlags & VBOXHDDRAW_READONLY) ? VMDKACCESS_READONLY : VMDKACCESS_READWRITE;
3417 pExtent->fMetaDirty = false;
3418
3419 /* Open flat image, the raw disk. */
3420 rc = vmdkFileOpen(pImage, &pExtent->pFile, pExtent->pszFullname,
3421 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags | ((pExtent->enmAccess == VMDKACCESS_READONLY) ? VD_OPEN_FLAGS_READONLY : 0),
3422 false /* fCreate */));
3423 if (RT_FAILURE(rc))
3424 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not open raw disk file '%s'"), pExtent->pszFullname);
3425 }
3426 else
3427 {
3428 /* Raw partition access. This requires setting up a descriptor
3429 * file, write the partition information to a flat extent and
3430 * open all the (flat) raw disk partitions. */
3431
3432 /* First pass over the partition data areas to determine how many
3433 * extents we need. One data area can require up to 2 extents, as
3434 * it might be necessary to skip over unpartitioned space. */
3435 unsigned cExtents = 0;
3436 uint64_t uStart = 0;
3437 for (unsigned i = 0; i < pRaw->cPartDescs; i++)
3438 {
3439 PVBOXHDDRAWPARTDESC pPart = &pRaw->pPartDescs[i];
3440 if (uStart > pPart->uStart)
3441 return vdIfError(pImage->pIfError, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("VMDK: incorrect partition data area ordering set up by the caller in '%s'"), pImage->pszFilename);
3442
3443 if (uStart < pPart->uStart)
3444 cExtents++;
3445 uStart = pPart->uStart + pPart->cbData;
3446 cExtents++;
3447 }
3448 /* Another extent for filling up the rest of the image. */
3449 if (uStart != cbSize)
3450 cExtents++;
3451
3452 rc = vmdkCreateExtents(pImage, cExtents);
3453 if (RT_FAILURE(rc))
3454 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new extent list in '%s'"), pImage->pszFilename);
3455
3456 /* Create raw partition descriptor file. */
3457 rc = vmdkFileOpen(pImage, &pImage->pFile, pImage->pszFilename,
3458 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags,
3459 true /* fCreate */));
3460 if (RT_FAILURE(rc))
3461 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new file '%s'"), pImage->pszFilename);
3462
3463 /* Create base filename for the partition table extent. */
3464 /** @todo remove fixed buffer without creating memory leaks. */
3465 char pszPartition[1024];
3466 const char *pszBase = RTPathFilename(pImage->pszFilename);
3467 const char *pszSuff = RTPathSuffix(pszBase);
3468 if (pszSuff == NULL)
3469 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: invalid filename '%s'"), pImage->pszFilename);
3470 char *pszBaseBase = RTStrDup(pszBase);
3471 if (!pszBaseBase)
3472 return VERR_NO_MEMORY;
3473 RTPathStripSuffix(pszBaseBase);
3474 RTStrPrintf(pszPartition, sizeof(pszPartition), "%s-pt%s",
3475 pszBaseBase, pszSuff);
3476 RTStrFree(pszBaseBase);
3477
3478 /* Second pass over the partitions, now define all extents. */
3479 uint64_t uPartOffset = 0;
3480 cExtents = 0;
3481 uStart = 0;
3482 for (unsigned i = 0; i < pRaw->cPartDescs; i++)
3483 {
3484 PVBOXHDDRAWPARTDESC pPart = &pRaw->pPartDescs[i];
3485 pExtent = &pImage->pExtents[cExtents++];
3486
3487 if (uStart < pPart->uStart)
3488 {
3489 pExtent->pszBasename = NULL;
3490 pExtent->pszFullname = NULL;
3491 pExtent->enmType = VMDKETYPE_ZERO;
3492 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(pPart->uStart - uStart);
3493 pExtent->uSectorOffset = 0;
3494 pExtent->enmAccess = VMDKACCESS_READWRITE;
3495 pExtent->fMetaDirty = false;
3496 /* go to next extent */
3497 pExtent = &pImage->pExtents[cExtents++];
3498 }
3499 uStart = pPart->uStart + pPart->cbData;
3500
3501 if (pPart->pvPartitionData)
3502 {
3503 /* Set up basename for extent description. Can't use StrDup. */
3504 size_t cbBasename = strlen(pszPartition) + 1;
3505 char *pszBasename = (char *)RTMemTmpAlloc(cbBasename);
3506 if (!pszBasename)
3507 return VERR_NO_MEMORY;
3508 memcpy(pszBasename, pszPartition, cbBasename);
3509 pExtent->pszBasename = pszBasename;
3510
3511 /* Set up full name for partition extent. */
3512 char *pszDirname = RTStrDup(pImage->pszFilename);
3513 if (!pszDirname)
3514 return VERR_NO_STR_MEMORY;
3515 RTPathStripFilename(pszDirname);
3516 char *pszFullname = RTPathJoinA(pszDirname, pExtent->pszBasename);
3517 RTStrFree(pszDirname);
3518 if (!pszFullname)
3519 return VERR_NO_STR_MEMORY;
3520 pExtent->pszFullname = pszFullname;
3521 pExtent->enmType = VMDKETYPE_FLAT;
3522 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(pPart->cbData);
3523 pExtent->uSectorOffset = uPartOffset;
3524 pExtent->enmAccess = VMDKACCESS_READWRITE;
3525 pExtent->fMetaDirty = false;
3526
3527 /* Create partition table flat image. */
3528 rc = vmdkFileOpen(pImage, &pExtent->pFile, pExtent->pszFullname,
3529 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags | ((pExtent->enmAccess == VMDKACCESS_READONLY) ? VD_OPEN_FLAGS_READONLY : 0),
3530 true /* fCreate */));
3531 if (RT_FAILURE(rc))
3532 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new partition data file '%s'"), pExtent->pszFullname);
3533 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage,
3534 VMDK_SECTOR2BYTE(uPartOffset),
3535 pPart->pvPartitionData,
3536 pPart->cbData);
3537 if (RT_FAILURE(rc))
3538 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not write partition data to '%s'"), pExtent->pszFullname);
3539 uPartOffset += VMDK_BYTE2SECTOR(pPart->cbData);
3540 }
3541 else
3542 {
3543 if (pPart->pszRawDevice)
3544 {
3545 /* Set up basename for extent descr. Can't use StrDup. */
3546 size_t cbBasename = strlen(pPart->pszRawDevice) + 1;
3547 char *pszBasename = (char *)RTMemTmpAlloc(cbBasename);
3548 if (!pszBasename)
3549 return VERR_NO_MEMORY;
3550 memcpy(pszBasename, pPart->pszRawDevice, cbBasename);
3551 pExtent->pszBasename = pszBasename;
3552 /* For raw disks full name is identical to base name. */
3553 pExtent->pszFullname = RTStrDup(pszBasename);
3554 if (!pExtent->pszFullname)
3555 return VERR_NO_MEMORY;
3556 pExtent->enmType = VMDKETYPE_FLAT;
3557 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(pPart->cbData);
3558 pExtent->uSectorOffset = VMDK_BYTE2SECTOR(pPart->uStartOffset);
3559 pExtent->enmAccess = (pPart->uFlags & VBOXHDDRAW_READONLY) ? VMDKACCESS_READONLY : VMDKACCESS_READWRITE;
3560 pExtent->fMetaDirty = false;
3561
3562 /* Open flat image, the raw partition. */
3563 rc = vmdkFileOpen(pImage, &pExtent->pFile, pExtent->pszFullname,
3564 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags | ((pExtent->enmAccess == VMDKACCESS_READONLY) ? VD_OPEN_FLAGS_READONLY : 0),
3565 false /* fCreate */));
3566 if (RT_FAILURE(rc))
3567 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not open raw partition file '%s'"), pExtent->pszFullname);
3568 }
3569 else
3570 {
3571 pExtent->pszBasename = NULL;
3572 pExtent->pszFullname = NULL;
3573 pExtent->enmType = VMDKETYPE_ZERO;
3574 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(pPart->cbData);
3575 pExtent->uSectorOffset = 0;
3576 pExtent->enmAccess = VMDKACCESS_READWRITE;
3577 pExtent->fMetaDirty = false;
3578 }
3579 }
3580 }
3581 /* Another extent for filling up the rest of the image. */
3582 if (uStart != cbSize)
3583 {
3584 pExtent = &pImage->pExtents[cExtents++];
3585 pExtent->pszBasename = NULL;
3586 pExtent->pszFullname = NULL;
3587 pExtent->enmType = VMDKETYPE_ZERO;
3588 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(cbSize - uStart);
3589 pExtent->uSectorOffset = 0;
3590 pExtent->enmAccess = VMDKACCESS_READWRITE;
3591 pExtent->fMetaDirty = false;
3592 }
3593 }
3594
3595 rc = vmdkDescBaseSetStr(pImage, &pImage->Descriptor, "createType",
3596 (pRaw->uFlags & VBOXHDDRAW_DISK) ?
3597 "fullDevice" : "partitionedDevice");
3598 if (RT_FAILURE(rc))
3599 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not set the image type in '%s'"), pImage->pszFilename);
3600 return rc;
3601}
3602
3603/**
3604 * Internal: create a regular (i.e. file-backed) VMDK image.
3605 */
3606static int vmdkCreateRegularImage(PVMDKIMAGE pImage, uint64_t cbSize,
3607 unsigned uImageFlags,
3608 PFNVDPROGRESS pfnProgress, void *pvUser,
3609 unsigned uPercentStart, unsigned uPercentSpan)
3610{
3611 int rc = VINF_SUCCESS;
3612 unsigned cExtents = 1;
3613 uint64_t cbOffset = 0;
3614 uint64_t cbRemaining = cbSize;
3615
3616 if (uImageFlags & VD_VMDK_IMAGE_FLAGS_SPLIT_2G)
3617 {
3618 cExtents = cbSize / VMDK_2G_SPLIT_SIZE;
3619 /* Do proper extent computation: need one smaller extent if the total
3620 * size isn't evenly divisible by the split size. */
3621 if (cbSize % VMDK_2G_SPLIT_SIZE)
3622 cExtents++;
3623 }
3624 rc = vmdkCreateExtents(pImage, cExtents);
3625 if (RT_FAILURE(rc))
3626 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new extent list in '%s'"), pImage->pszFilename);
3627
3628 /* Basename strings needed for constructing the extent names. */
3629 char *pszBasenameSubstr = RTPathFilename(pImage->pszFilename);
3630 AssertPtr(pszBasenameSubstr);
3631 size_t cbBasenameSubstr = strlen(pszBasenameSubstr) + 1;
3632
3633 /* Create separate descriptor file if necessary. */
3634 if (cExtents != 1 || (uImageFlags & VD_IMAGE_FLAGS_FIXED))
3635 {
3636 rc = vmdkFileOpen(pImage, &pImage->pFile, pImage->pszFilename,
3637 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags,
3638 true /* fCreate */));
3639 if (RT_FAILURE(rc))
3640 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new sparse descriptor file '%s'"), pImage->pszFilename);
3641 }
3642 else
3643 pImage->pFile = NULL;
3644
3645 /* Set up all extents. */
3646 for (unsigned i = 0; i < cExtents; i++)
3647 {
3648 PVMDKEXTENT pExtent = &pImage->pExtents[i];
3649 uint64_t cbExtent = cbRemaining;
3650
3651 /* Set up fullname/basename for extent description. Cannot use StrDup
3652 * for basename, as it is not guaranteed that the memory can be freed
3653 * with RTMemTmpFree, which must be used as in other code paths
3654 * StrDup is not usable. */
3655 if (cExtents == 1 && !(uImageFlags & VD_IMAGE_FLAGS_FIXED))
3656 {
3657 char *pszBasename = (char *)RTMemTmpAlloc(cbBasenameSubstr);
3658 if (!pszBasename)
3659 return VERR_NO_MEMORY;
3660 memcpy(pszBasename, pszBasenameSubstr, cbBasenameSubstr);
3661 pExtent->pszBasename = pszBasename;
3662 }
3663 else
3664 {
3665 char *pszBasenameSuff = RTPathSuffix(pszBasenameSubstr);
3666 char *pszBasenameBase = RTStrDup(pszBasenameSubstr);
3667 RTPathStripSuffix(pszBasenameBase);
3668 char *pszTmp;
3669 size_t cbTmp;
3670 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
3671 {
3672 if (cExtents == 1)
3673 RTStrAPrintf(&pszTmp, "%s-flat%s", pszBasenameBase,
3674 pszBasenameSuff);
3675 else
3676 RTStrAPrintf(&pszTmp, "%s-f%03d%s", pszBasenameBase,
3677 i+1, pszBasenameSuff);
3678 }
3679 else
3680 RTStrAPrintf(&pszTmp, "%s-s%03d%s", pszBasenameBase, i+1,
3681 pszBasenameSuff);
3682 RTStrFree(pszBasenameBase);
3683 if (!pszTmp)
3684 return VERR_NO_STR_MEMORY;
3685 cbTmp = strlen(pszTmp) + 1;
3686 char *pszBasename = (char *)RTMemTmpAlloc(cbTmp);
3687 if (!pszBasename)
3688 {
3689 RTStrFree(pszTmp);
3690 return VERR_NO_MEMORY;
3691 }
3692 memcpy(pszBasename, pszTmp, cbTmp);
3693 RTStrFree(pszTmp);
3694 pExtent->pszBasename = pszBasename;
3695 if (uImageFlags & VD_VMDK_IMAGE_FLAGS_SPLIT_2G)
3696 cbExtent = RT_MIN(cbRemaining, VMDK_2G_SPLIT_SIZE);
3697 }
3698 char *pszBasedirectory = RTStrDup(pImage->pszFilename);
3699 if (!pszBasedirectory)
3700 return VERR_NO_STR_MEMORY;
3701 RTPathStripFilename(pszBasedirectory);
3702 char *pszFullname = RTPathJoinA(pszBasedirectory, pExtent->pszBasename);
3703 RTStrFree(pszBasedirectory);
3704 if (!pszFullname)
3705 return VERR_NO_STR_MEMORY;
3706 pExtent->pszFullname = pszFullname;
3707
3708 /* Create file for extent. */
3709 rc = vmdkFileOpen(pImage, &pExtent->pFile, pExtent->pszFullname,
3710 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags,
3711 true /* fCreate */));
3712 if (RT_FAILURE(rc))
3713 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new file '%s'"), pExtent->pszFullname);
3714 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
3715 {
3716 rc = vdIfIoIntFileSetAllocationSize(pImage->pIfIo, pExtent->pFile->pStorage, cbExtent,
3717 0 /* fFlags */, pfnProgress, pvUser, uPercentStart + cbOffset * uPercentSpan / cbSize, uPercentSpan / cExtents);
3718 if (RT_FAILURE(rc))
3719 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not set size of new file '%s'"), pExtent->pszFullname);
3720 }
3721
3722 /* Place descriptor file information (where integrated). */
3723 if (cExtents == 1 && !(uImageFlags & VD_IMAGE_FLAGS_FIXED))
3724 {
3725 pExtent->uDescriptorSector = 1;
3726 pExtent->cDescriptorSectors = VMDK_BYTE2SECTOR(pImage->cbDescAlloc);
3727 /* The descriptor is part of the (only) extent. */
3728 pExtent->pDescData = pImage->pDescData;
3729 pImage->pDescData = NULL;
3730 }
3731
3732 if (!(uImageFlags & VD_IMAGE_FLAGS_FIXED))
3733 {
3734 uint64_t cSectorsPerGDE, cSectorsPerGD;
3735 pExtent->enmType = VMDKETYPE_HOSTED_SPARSE;
3736 pExtent->cSectors = VMDK_BYTE2SECTOR(RT_ALIGN_64(cbExtent, _64K));
3737 pExtent->cSectorsPerGrain = VMDK_BYTE2SECTOR(_64K);
3738 pExtent->cGTEntries = 512;
3739 cSectorsPerGDE = pExtent->cGTEntries * pExtent->cSectorsPerGrain;
3740 pExtent->cSectorsPerGDE = cSectorsPerGDE;
3741 pExtent->cGDEntries = (pExtent->cSectors + cSectorsPerGDE - 1) / cSectorsPerGDE;
3742 cSectorsPerGD = (pExtent->cGDEntries + (512 / sizeof(uint32_t) - 1)) / (512 / sizeof(uint32_t));
3743 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
3744 {
3745 /* The spec says version is 1 for all VMDKs, but the vast
3746 * majority of streamOptimized VMDKs actually contain
3747 * version 3 - so go with the majority. Both are accepted. */
3748 pExtent->uVersion = 3;
3749 pExtent->uCompression = VMDK_COMPRESSION_DEFLATE;
3750 }
3751 }
3752 else
3753 {
3754 if (uImageFlags & VD_VMDK_IMAGE_FLAGS_ESX)
3755 pExtent->enmType = VMDKETYPE_VMFS;
3756 else
3757 pExtent->enmType = VMDKETYPE_FLAT;
3758 }
3759
3760 pExtent->enmAccess = VMDKACCESS_READWRITE;
3761 pExtent->fUncleanShutdown = true;
3762 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(cbExtent);
3763 pExtent->uSectorOffset = 0;
3764 pExtent->fMetaDirty = true;
3765
3766 if (!(uImageFlags & VD_IMAGE_FLAGS_FIXED))
3767 {
3768 /* fPreAlloc should never be false because VMware can't use such images. */
3769 rc = vmdkCreateGrainDirectory(pImage, pExtent,
3770 RT_MAX( pExtent->uDescriptorSector
3771 + pExtent->cDescriptorSectors,
3772 1),
3773 true /* fPreAlloc */);
3774 if (RT_FAILURE(rc))
3775 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new grain directory in '%s'"), pExtent->pszFullname);
3776 }
3777
3778 cbOffset += cbExtent;
3779
3780 if (RT_SUCCESS(rc) && pfnProgress)
3781 pfnProgress(pvUser, uPercentStart + cbOffset * uPercentSpan / cbSize);
3782
3783 cbRemaining -= cbExtent;
3784 }
3785
3786 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_ESX)
3787 {
3788 /* VirtualBox doesn't care, but VMWare ESX freaks out if the wrong
3789 * controller type is set in an image. */
3790 rc = vmdkDescDDBSetStr(pImage, &pImage->Descriptor, "ddb.adapterType", "lsilogic");
3791 if (RT_FAILURE(rc))
3792 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not set controller type to lsilogic in '%s'"), pImage->pszFilename);
3793 }
3794
3795 const char *pszDescType = NULL;
3796 if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
3797 {
3798 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_ESX)
3799 pszDescType = "vmfs";
3800 else
3801 pszDescType = (cExtents == 1)
3802 ? "monolithicFlat" : "twoGbMaxExtentFlat";
3803 }
3804 else
3805 {
3806 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
3807 pszDescType = "streamOptimized";
3808 else
3809 {
3810 pszDescType = (cExtents == 1)
3811 ? "monolithicSparse" : "twoGbMaxExtentSparse";
3812 }
3813 }
3814 rc = vmdkDescBaseSetStr(pImage, &pImage->Descriptor, "createType",
3815 pszDescType);
3816 if (RT_FAILURE(rc))
3817 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not set the image type in '%s'"), pImage->pszFilename);
3818 return rc;
3819}
3820
3821/**
3822 * Internal: Create a real stream optimized VMDK using only linear writes.
3823 */
3824static int vmdkCreateStreamImage(PVMDKIMAGE pImage, uint64_t cbSize,
3825 unsigned uImageFlags,
3826 PFNVDPROGRESS pfnProgress, void *pvUser,
3827 unsigned uPercentStart, unsigned uPercentSpan)
3828{
3829 int rc;
3830
3831 rc = vmdkCreateExtents(pImage, 1);
3832 if (RT_FAILURE(rc))
3833 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new extent list in '%s'"), pImage->pszFilename);
3834
3835 /* Basename strings needed for constructing the extent names. */
3836 const char *pszBasenameSubstr = RTPathFilename(pImage->pszFilename);
3837 AssertPtr(pszBasenameSubstr);
3838 size_t cbBasenameSubstr = strlen(pszBasenameSubstr) + 1;
3839
3840 /* No separate descriptor file. */
3841 pImage->pFile = NULL;
3842
3843 /* Set up all extents. */
3844 PVMDKEXTENT pExtent = &pImage->pExtents[0];
3845
3846 /* Set up fullname/basename for extent description. Cannot use StrDup
3847 * for basename, as it is not guaranteed that the memory can be freed
3848 * with RTMemTmpFree, which must be used as in other code paths
3849 * StrDup is not usable. */
3850 char *pszBasename = (char *)RTMemTmpAlloc(cbBasenameSubstr);
3851 if (!pszBasename)
3852 return VERR_NO_MEMORY;
3853 memcpy(pszBasename, pszBasenameSubstr, cbBasenameSubstr);
3854 pExtent->pszBasename = pszBasename;
3855
3856 char *pszBasedirectory = RTStrDup(pImage->pszFilename);
3857 RTPathStripFilename(pszBasedirectory);
3858 char *pszFullname = RTPathJoinA(pszBasedirectory, pExtent->pszBasename);
3859 RTStrFree(pszBasedirectory);
3860 if (!pszFullname)
3861 return VERR_NO_STR_MEMORY;
3862 pExtent->pszFullname = pszFullname;
3863
3864 /* Create file for extent. Make it write only, no reading allowed. */
3865 rc = vmdkFileOpen(pImage, &pExtent->pFile, pExtent->pszFullname,
3866 VDOpenFlagsToFileOpenFlags(pImage->uOpenFlags,
3867 true /* fCreate */)
3868 & ~RTFILE_O_READ);
3869 if (RT_FAILURE(rc))
3870 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new file '%s'"), pExtent->pszFullname);
3871
3872 /* Place descriptor file information. */
3873 pExtent->uDescriptorSector = 1;
3874 pExtent->cDescriptorSectors = VMDK_BYTE2SECTOR(pImage->cbDescAlloc);
3875 /* The descriptor is part of the (only) extent. */
3876 pExtent->pDescData = pImage->pDescData;
3877 pImage->pDescData = NULL;
3878
3879 uint64_t cSectorsPerGDE, cSectorsPerGD;
3880 pExtent->enmType = VMDKETYPE_HOSTED_SPARSE;
3881 pExtent->cSectors = VMDK_BYTE2SECTOR(RT_ALIGN_64(cbSize, _64K));
3882 pExtent->cSectorsPerGrain = VMDK_BYTE2SECTOR(_64K);
3883 pExtent->cGTEntries = 512;
3884 cSectorsPerGDE = pExtent->cGTEntries * pExtent->cSectorsPerGrain;
3885 pExtent->cSectorsPerGDE = cSectorsPerGDE;
3886 pExtent->cGDEntries = (pExtent->cSectors + cSectorsPerGDE - 1) / cSectorsPerGDE;
3887 cSectorsPerGD = (pExtent->cGDEntries + (512 / sizeof(uint32_t) - 1)) / (512 / sizeof(uint32_t));
3888
3889 /* The spec says version is 1 for all VMDKs, but the vast
3890 * majority of streamOptimized VMDKs actually contain
3891 * version 3 - so go with the majority. Both are accepted. */
3892 pExtent->uVersion = 3;
3893 pExtent->uCompression = VMDK_COMPRESSION_DEFLATE;
3894 pExtent->fFooter = true;
3895
3896 pExtent->enmAccess = VMDKACCESS_READONLY;
3897 pExtent->fUncleanShutdown = false;
3898 pExtent->cNominalSectors = VMDK_BYTE2SECTOR(cbSize);
3899 pExtent->uSectorOffset = 0;
3900 pExtent->fMetaDirty = true;
3901
3902 /* Create grain directory, without preallocating it straight away. It will
3903 * be constructed on the fly when writing out the data and written when
3904 * closing the image. The end effect is that the full grain directory is
3905 * allocated, which is a requirement of the VMDK specs. */
3906 rc = vmdkCreateGrainDirectory(pImage, pExtent, VMDK_GD_AT_END,
3907 false /* fPreAlloc */);
3908 if (RT_FAILURE(rc))
3909 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new grain directory in '%s'"), pExtent->pszFullname);
3910
3911 rc = vmdkDescBaseSetStr(pImage, &pImage->Descriptor, "createType",
3912 "streamOptimized");
3913 if (RT_FAILURE(rc))
3914 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not set the image type in '%s'"), pImage->pszFilename);
3915
3916 return rc;
3917}
3918
3919/**
3920 * Internal: The actual code for creating any VMDK variant currently in
3921 * existence on hosted environments.
3922 */
3923static int vmdkCreateImage(PVMDKIMAGE pImage, uint64_t cbSize,
3924 unsigned uImageFlags, const char *pszComment,
3925 PCVDGEOMETRY pPCHSGeometry,
3926 PCVDGEOMETRY pLCHSGeometry, PCRTUUID pUuid,
3927 PFNVDPROGRESS pfnProgress, void *pvUser,
3928 unsigned uPercentStart, unsigned uPercentSpan)
3929{
3930 int rc;
3931
3932 pImage->uImageFlags = uImageFlags;
3933
3934 pImage->pIfError = VDIfErrorGet(pImage->pVDIfsDisk);
3935 pImage->pIfIo = VDIfIoIntGet(pImage->pVDIfsImage);
3936 AssertPtrReturn(pImage->pIfIo, VERR_INVALID_PARAMETER);
3937
3938 rc = vmdkCreateDescriptor(pImage, pImage->pDescData, pImage->cbDescAlloc,
3939 &pImage->Descriptor);
3940 if (RT_FAILURE(rc))
3941 {
3942 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not create new descriptor in '%s'"), pImage->pszFilename);
3943 goto out;
3944 }
3945
3946 if ( (uImageFlags & VD_IMAGE_FLAGS_FIXED)
3947 && (uImageFlags & VD_VMDK_IMAGE_FLAGS_RAWDISK))
3948 {
3949 /* Raw disk image (includes raw partition). */
3950 const PVBOXHDDRAW pRaw = (const PVBOXHDDRAW)pszComment;
3951 /* As the comment is misused, zap it so that no garbage comment
3952 * is set below. */
3953 pszComment = NULL;
3954 rc = vmdkCreateRawImage(pImage, pRaw, cbSize);
3955 }
3956 else
3957 {
3958 if (uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
3959 {
3960 /* Stream optimized sparse image (monolithic). */
3961 rc = vmdkCreateStreamImage(pImage, cbSize, uImageFlags,
3962 pfnProgress, pvUser, uPercentStart,
3963 uPercentSpan * 95 / 100);
3964 }
3965 else
3966 {
3967 /* Regular fixed or sparse image (monolithic or split). */
3968 rc = vmdkCreateRegularImage(pImage, cbSize, uImageFlags,
3969 pfnProgress, pvUser, uPercentStart,
3970 uPercentSpan * 95 / 100);
3971 }
3972 }
3973
3974 if (RT_FAILURE(rc))
3975 goto out;
3976
3977 if (RT_SUCCESS(rc) && pfnProgress)
3978 pfnProgress(pvUser, uPercentStart + uPercentSpan * 98 / 100);
3979
3980 pImage->cbSize = cbSize;
3981
3982 for (unsigned i = 0; i < pImage->cExtents; i++)
3983 {
3984 PVMDKEXTENT pExtent = &pImage->pExtents[i];
3985
3986 rc = vmdkDescExtInsert(pImage, &pImage->Descriptor, pExtent->enmAccess,
3987 pExtent->cNominalSectors, pExtent->enmType,
3988 pExtent->pszBasename, pExtent->uSectorOffset);
3989 if (RT_FAILURE(rc))
3990 {
3991 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: could not insert the extent list into descriptor in '%s'"), pImage->pszFilename);
3992 goto out;
3993 }
3994 }
3995 vmdkDescExtRemoveDummy(pImage, &pImage->Descriptor);
3996
3997 if ( pPCHSGeometry->cCylinders != 0
3998 && pPCHSGeometry->cHeads != 0
3999 && pPCHSGeometry->cSectors != 0)
4000 {
4001 rc = vmdkDescSetPCHSGeometry(pImage, pPCHSGeometry);
4002 if (RT_FAILURE(rc))
4003 goto out;
4004 }
4005 if ( pLCHSGeometry->cCylinders != 0
4006 && pLCHSGeometry->cHeads != 0
4007 && pLCHSGeometry->cSectors != 0)
4008 {
4009 rc = vmdkDescSetLCHSGeometry(pImage, pLCHSGeometry);
4010 if (RT_FAILURE(rc))
4011 goto out;
4012 }
4013
4014 pImage->LCHSGeometry = *pLCHSGeometry;
4015 pImage->PCHSGeometry = *pPCHSGeometry;
4016
4017 pImage->ImageUuid = *pUuid;
4018 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
4019 VMDK_DDB_IMAGE_UUID, &pImage->ImageUuid);
4020 if (RT_FAILURE(rc))
4021 {
4022 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing image UUID in new descriptor in '%s'"), pImage->pszFilename);
4023 goto out;
4024 }
4025 RTUuidClear(&pImage->ParentUuid);
4026 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
4027 VMDK_DDB_PARENT_UUID, &pImage->ParentUuid);
4028 if (RT_FAILURE(rc))
4029 {
4030 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing parent image UUID in new descriptor in '%s'"), pImage->pszFilename);
4031 goto out;
4032 }
4033 RTUuidClear(&pImage->ModificationUuid);
4034 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
4035 VMDK_DDB_MODIFICATION_UUID,
4036 &pImage->ModificationUuid);
4037 if (RT_FAILURE(rc))
4038 {
4039 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing modification UUID in new descriptor in '%s'"), pImage->pszFilename);
4040 goto out;
4041 }
4042 RTUuidClear(&pImage->ParentModificationUuid);
4043 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
4044 VMDK_DDB_PARENT_MODIFICATION_UUID,
4045 &pImage->ParentModificationUuid);
4046 if (RT_FAILURE(rc))
4047 {
4048 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing parent modification UUID in new descriptor in '%s'"), pImage->pszFilename);
4049 goto out;
4050 }
4051
4052 rc = vmdkAllocateGrainTableCache(pImage);
4053 if (RT_FAILURE(rc))
4054 goto out;
4055
4056 rc = vmdkSetImageComment(pImage, pszComment);
4057 if (RT_FAILURE(rc))
4058 {
4059 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot set image comment in '%s'"), pImage->pszFilename);
4060 goto out;
4061 }
4062
4063 if (RT_SUCCESS(rc) && pfnProgress)
4064 pfnProgress(pvUser, uPercentStart + uPercentSpan * 99 / 100);
4065
4066 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
4067 {
4068 /* streamOptimized is a bit special, we cannot trigger the flush
4069 * until all data has been written. So we write the necessary
4070 * information explicitly. */
4071 pImage->pExtents[0].cDescriptorSectors = VMDK_BYTE2SECTOR(RT_ALIGN_64( pImage->Descriptor.aLines[pImage->Descriptor.cLines]
4072 - pImage->Descriptor.aLines[0], 512));
4073 rc = vmdkWriteMetaSparseExtent(pImage, &pImage->pExtents[0], 0, NULL);
4074 if (RT_FAILURE(rc))
4075 {
4076 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write VMDK header in '%s'"), pImage->pszFilename);
4077 goto out;
4078 }
4079
4080 rc = vmdkWriteDescriptor(pImage, NULL);
4081 if (RT_FAILURE(rc))
4082 {
4083 rc = vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write VMDK descriptor in '%s'"), pImage->pszFilename);
4084 goto out;
4085 }
4086 }
4087 else
4088 rc = vmdkFlushImage(pImage, NULL);
4089
4090out:
4091 if (RT_SUCCESS(rc) && pfnProgress)
4092 pfnProgress(pvUser, uPercentStart + uPercentSpan);
4093
4094 if (RT_FAILURE(rc))
4095 vmdkFreeImage(pImage, rc != VERR_ALREADY_EXISTS);
4096 return rc;
4097}
4098
4099/**
4100 * Internal: Update image comment.
4101 */
4102static int vmdkSetImageComment(PVMDKIMAGE pImage, const char *pszComment)
4103{
4104 char *pszCommentEncoded;
4105 if (pszComment)
4106 {
4107 pszCommentEncoded = vmdkEncodeString(pszComment);
4108 if (!pszCommentEncoded)
4109 return VERR_NO_MEMORY;
4110 }
4111 else
4112 pszCommentEncoded = NULL;
4113 int rc = vmdkDescDDBSetStr(pImage, &pImage->Descriptor,
4114 "ddb.comment", pszCommentEncoded);
4115 if (pszComment)
4116 RTStrFree(pszCommentEncoded);
4117 if (RT_FAILURE(rc))
4118 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing image comment in descriptor in '%s'"), pImage->pszFilename);
4119 return VINF_SUCCESS;
4120}
4121
4122/**
4123 * Internal. Clear the grain table buffer for real stream optimized writing.
4124 */
4125static void vmdkStreamClearGT(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
4126{
4127 uint32_t cCacheLines = RT_ALIGN(pExtent->cGTEntries, VMDK_GT_CACHELINE_SIZE) / VMDK_GT_CACHELINE_SIZE;
4128 for (uint32_t i = 0; i < cCacheLines; i++)
4129 memset(&pImage->pGTCache->aGTCache[i].aGTData[0], '\0',
4130 VMDK_GT_CACHELINE_SIZE * sizeof(uint32_t));
4131}
4132
4133/**
4134 * Internal. Flush the grain table buffer for real stream optimized writing.
4135 */
4136static int vmdkStreamFlushGT(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
4137 uint32_t uGDEntry)
4138{
4139 int rc = VINF_SUCCESS;
4140 uint32_t cCacheLines = RT_ALIGN(pExtent->cGTEntries, VMDK_GT_CACHELINE_SIZE) / VMDK_GT_CACHELINE_SIZE;
4141
4142 /* VMware does not write out completely empty grain tables in the case
4143 * of streamOptimized images, which according to my interpretation of
4144 * the VMDK 1.1 spec is bending the rules. Since they do it and we can
4145 * handle it without problems do it the same way and save some bytes. */
4146 bool fAllZero = true;
4147 for (uint32_t i = 0; i < cCacheLines; i++)
4148 {
4149 /* Convert the grain table to little endian in place, as it will not
4150 * be used at all after this function has been called. */
4151 uint32_t *pGTTmp = &pImage->pGTCache->aGTCache[i].aGTData[0];
4152 for (uint32_t j = 0; j < VMDK_GT_CACHELINE_SIZE; j++, pGTTmp++)
4153 if (*pGTTmp)
4154 {
4155 fAllZero = false;
4156 break;
4157 }
4158 if (!fAllZero)
4159 break;
4160 }
4161 if (fAllZero)
4162 return VINF_SUCCESS;
4163
4164 uint64_t uFileOffset = pExtent->uAppendPosition;
4165 if (!uFileOffset)
4166 return VERR_INTERNAL_ERROR;
4167 /* Align to sector, as the previous write could have been any size. */
4168 uFileOffset = RT_ALIGN_64(uFileOffset, 512);
4169
4170 /* Grain table marker. */
4171 uint8_t aMarker[512];
4172 PVMDKMARKER pMarker = (PVMDKMARKER)&aMarker[0];
4173 memset(pMarker, '\0', sizeof(aMarker));
4174 pMarker->uSector = RT_H2LE_U64(VMDK_BYTE2SECTOR((uint64_t)pExtent->cGTEntries * sizeof(uint32_t)));
4175 pMarker->uType = RT_H2LE_U32(VMDK_MARKER_GT);
4176 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage, uFileOffset,
4177 aMarker, sizeof(aMarker));
4178 AssertRC(rc);
4179 uFileOffset += 512;
4180
4181 if (!pExtent->pGD || pExtent->pGD[uGDEntry])
4182 return VERR_INTERNAL_ERROR;
4183
4184 pExtent->pGD[uGDEntry] = VMDK_BYTE2SECTOR(uFileOffset);
4185
4186 for (uint32_t i = 0; i < cCacheLines; i++)
4187 {
4188 /* Convert the grain table to little endian in place, as it will not
4189 * be used at all after this function has been called. */
4190 uint32_t *pGTTmp = &pImage->pGTCache->aGTCache[i].aGTData[0];
4191 for (uint32_t j = 0; j < VMDK_GT_CACHELINE_SIZE; j++, pGTTmp++)
4192 *pGTTmp = RT_H2LE_U32(*pGTTmp);
4193
4194 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage, uFileOffset,
4195 &pImage->pGTCache->aGTCache[i].aGTData[0],
4196 VMDK_GT_CACHELINE_SIZE * sizeof(uint32_t));
4197 uFileOffset += VMDK_GT_CACHELINE_SIZE * sizeof(uint32_t);
4198 if (RT_FAILURE(rc))
4199 break;
4200 }
4201 Assert(!(uFileOffset % 512));
4202 pExtent->uAppendPosition = RT_ALIGN_64(uFileOffset, 512);
4203 return rc;
4204}
4205
4206/**
4207 * Internal. Free all allocated space for representing an image, and optionally
4208 * delete the image from disk.
4209 */
4210static int vmdkFreeImage(PVMDKIMAGE pImage, bool fDelete)
4211{
4212 int rc = VINF_SUCCESS;
4213
4214 /* Freeing a never allocated image (e.g. because the open failed) is
4215 * not signalled as an error. After all nothing bad happens. */
4216 if (pImage)
4217 {
4218 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
4219 {
4220 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
4221 {
4222 /* Check if all extents are clean. */
4223 for (unsigned i = 0; i < pImage->cExtents; i++)
4224 {
4225 Assert(!pImage->pExtents[i].fUncleanShutdown);
4226 }
4227 }
4228 else
4229 {
4230 /* Mark all extents as clean. */
4231 for (unsigned i = 0; i < pImage->cExtents; i++)
4232 {
4233 if ( ( pImage->pExtents[i].enmType == VMDKETYPE_HOSTED_SPARSE
4234#ifdef VBOX_WITH_VMDK_ESX
4235 || pImage->pExtents[i].enmType == VMDKETYPE_ESX_SPARSE
4236#endif /* VBOX_WITH_VMDK_ESX */
4237 )
4238 && pImage->pExtents[i].fUncleanShutdown)
4239 {
4240 pImage->pExtents[i].fUncleanShutdown = false;
4241 pImage->pExtents[i].fMetaDirty = true;
4242 }
4243
4244 /* From now on it's not safe to append any more data. */
4245 pImage->pExtents[i].uAppendPosition = 0;
4246 }
4247 }
4248 }
4249
4250 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
4251 {
4252 /* No need to write any pending data if the file will be deleted
4253 * or if the new file wasn't successfully created. */
4254 if ( !fDelete && pImage->pExtents
4255 && pImage->pExtents[0].cGTEntries
4256 && pImage->pExtents[0].uAppendPosition)
4257 {
4258 PVMDKEXTENT pExtent = &pImage->pExtents[0];
4259 uint32_t uLastGDEntry = pExtent->uLastGrainAccess / pExtent->cGTEntries;
4260 rc = vmdkStreamFlushGT(pImage, pExtent, uLastGDEntry);
4261 AssertRC(rc);
4262 vmdkStreamClearGT(pImage, pExtent);
4263 for (uint32_t i = uLastGDEntry + 1; i < pExtent->cGDEntries; i++)
4264 {
4265 rc = vmdkStreamFlushGT(pImage, pExtent, i);
4266 AssertRC(rc);
4267 }
4268
4269 uint64_t uFileOffset = pExtent->uAppendPosition;
4270 if (!uFileOffset)
4271 return VERR_INTERNAL_ERROR;
4272 uFileOffset = RT_ALIGN_64(uFileOffset, 512);
4273
4274 /* From now on it's not safe to append any more data. */
4275 pExtent->uAppendPosition = 0;
4276
4277 /* Grain directory marker. */
4278 uint8_t aMarker[512];
4279 PVMDKMARKER pMarker = (PVMDKMARKER)&aMarker[0];
4280 memset(pMarker, '\0', sizeof(aMarker));
4281 pMarker->uSector = VMDK_BYTE2SECTOR(RT_ALIGN_64(RT_H2LE_U64((uint64_t)pExtent->cGDEntries * sizeof(uint32_t)), 512));
4282 pMarker->uType = RT_H2LE_U32(VMDK_MARKER_GD);
4283 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage, uFileOffset,
4284 aMarker, sizeof(aMarker));
4285 AssertRC(rc);
4286 uFileOffset += 512;
4287
4288 /* Write grain directory in little endian style. The array will
4289 * not be used after this, so convert in place. */
4290 uint32_t *pGDTmp = pExtent->pGD;
4291 for (uint32_t i = 0; i < pExtent->cGDEntries; i++, pGDTmp++)
4292 *pGDTmp = RT_H2LE_U32(*pGDTmp);
4293 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage,
4294 uFileOffset, pExtent->pGD,
4295 pExtent->cGDEntries * sizeof(uint32_t));
4296 AssertRC(rc);
4297
4298 pExtent->uSectorGD = VMDK_BYTE2SECTOR(uFileOffset);
4299 pExtent->uSectorRGD = VMDK_BYTE2SECTOR(uFileOffset);
4300 uFileOffset = RT_ALIGN_64( uFileOffset
4301 + pExtent->cGDEntries * sizeof(uint32_t),
4302 512);
4303
4304 /* Footer marker. */
4305 memset(pMarker, '\0', sizeof(aMarker));
4306 pMarker->uSector = VMDK_BYTE2SECTOR(512);
4307 pMarker->uType = RT_H2LE_U32(VMDK_MARKER_FOOTER);
4308 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage,
4309 uFileOffset, aMarker, sizeof(aMarker));
4310 AssertRC(rc);
4311
4312 uFileOffset += 512;
4313 rc = vmdkWriteMetaSparseExtent(pImage, pExtent, uFileOffset, NULL);
4314 AssertRC(rc);
4315
4316 uFileOffset += 512;
4317 /* End-of-stream marker. */
4318 memset(pMarker, '\0', sizeof(aMarker));
4319 rc = vdIfIoIntFileWriteSync(pImage->pIfIo, pExtent->pFile->pStorage,
4320 uFileOffset, aMarker, sizeof(aMarker));
4321 AssertRC(rc);
4322 }
4323 }
4324 else
4325 vmdkFlushImage(pImage, NULL);
4326
4327 if (pImage->pExtents != NULL)
4328 {
4329 for (unsigned i = 0 ; i < pImage->cExtents; i++)
4330 {
4331 int rc2 = vmdkFreeExtentData(pImage, &pImage->pExtents[i], fDelete);
4332 if (RT_SUCCESS(rc))
4333 rc = rc2; /* Propogate any error when closing the file. */
4334 }
4335 RTMemFree(pImage->pExtents);
4336 pImage->pExtents = NULL;
4337 }
4338 pImage->cExtents = 0;
4339 if (pImage->pFile != NULL)
4340 {
4341 int rc2 = vmdkFileClose(pImage, &pImage->pFile, fDelete);
4342 if (RT_SUCCESS(rc))
4343 rc = rc2; /* Propogate any error when closing the file. */
4344 }
4345 int rc2 = vmdkFileCheckAllClose(pImage);
4346 if (RT_SUCCESS(rc))
4347 rc = rc2; /* Propogate any error when closing the file. */
4348
4349 if (pImage->pGTCache)
4350 {
4351 RTMemFree(pImage->pGTCache);
4352 pImage->pGTCache = NULL;
4353 }
4354 if (pImage->pDescData)
4355 {
4356 RTMemFree(pImage->pDescData);
4357 pImage->pDescData = NULL;
4358 }
4359 }
4360
4361 LogFlowFunc(("returns %Rrc\n", rc));
4362 return rc;
4363}
4364
4365/**
4366 * Internal. Flush image data (and metadata) to disk.
4367 */
4368static int vmdkFlushImage(PVMDKIMAGE pImage, PVDIOCTX pIoCtx)
4369{
4370 PVMDKEXTENT pExtent;
4371 int rc = VINF_SUCCESS;
4372
4373 /* Update descriptor if changed. */
4374 if (pImage->Descriptor.fDirty)
4375 {
4376 rc = vmdkWriteDescriptor(pImage, pIoCtx);
4377 if (RT_FAILURE(rc))
4378 goto out;
4379 }
4380
4381 for (unsigned i = 0; i < pImage->cExtents; i++)
4382 {
4383 pExtent = &pImage->pExtents[i];
4384 if (pExtent->pFile != NULL && pExtent->fMetaDirty)
4385 {
4386 switch (pExtent->enmType)
4387 {
4388 case VMDKETYPE_HOSTED_SPARSE:
4389 if (!pExtent->fFooter)
4390 {
4391 rc = vmdkWriteMetaSparseExtent(pImage, pExtent, 0, pIoCtx);
4392 if (RT_FAILURE(rc))
4393 goto out;
4394 }
4395 else
4396 {
4397 uint64_t uFileOffset = pExtent->uAppendPosition;
4398 /* Simply skip writing anything if the streamOptimized
4399 * image hasn't been just created. */
4400 if (!uFileOffset)
4401 break;
4402 uFileOffset = RT_ALIGN_64(uFileOffset, 512);
4403 rc = vmdkWriteMetaSparseExtent(pImage, pExtent,
4404 uFileOffset, pIoCtx);
4405 if (RT_FAILURE(rc))
4406 goto out;
4407 }
4408 break;
4409#ifdef VBOX_WITH_VMDK_ESX
4410 case VMDKETYPE_ESX_SPARSE:
4411 /** @todo update the header. */
4412 break;
4413#endif /* VBOX_WITH_VMDK_ESX */
4414 case VMDKETYPE_VMFS:
4415 case VMDKETYPE_FLAT:
4416 /* Nothing to do. */
4417 break;
4418 case VMDKETYPE_ZERO:
4419 default:
4420 AssertMsgFailed(("extent with type %d marked as dirty\n",
4421 pExtent->enmType));
4422 break;
4423 }
4424 }
4425 switch (pExtent->enmType)
4426 {
4427 case VMDKETYPE_HOSTED_SPARSE:
4428#ifdef VBOX_WITH_VMDK_ESX
4429 case VMDKETYPE_ESX_SPARSE:
4430#endif /* VBOX_WITH_VMDK_ESX */
4431 case VMDKETYPE_VMFS:
4432 case VMDKETYPE_FLAT:
4433 /** @todo implement proper path absolute check. */
4434 if ( pExtent->pFile != NULL
4435 && !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
4436 && !(pExtent->pszBasename[0] == RTPATH_SLASH))
4437 rc = vdIfIoIntFileFlush(pImage->pIfIo, pExtent->pFile->pStorage, pIoCtx,
4438 NULL, NULL);
4439 break;
4440 case VMDKETYPE_ZERO:
4441 /* No need to do anything for this extent. */
4442 break;
4443 default:
4444 AssertMsgFailed(("unknown extent type %d\n", pExtent->enmType));
4445 break;
4446 }
4447 }
4448
4449out:
4450 return rc;
4451}
4452
4453/**
4454 * Internal. Find extent corresponding to the sector number in the disk.
4455 */
4456static int vmdkFindExtent(PVMDKIMAGE pImage, uint64_t offSector,
4457 PVMDKEXTENT *ppExtent, uint64_t *puSectorInExtent)
4458{
4459 PVMDKEXTENT pExtent = NULL;
4460 int rc = VINF_SUCCESS;
4461
4462 for (unsigned i = 0; i < pImage->cExtents; i++)
4463 {
4464 if (offSector < pImage->pExtents[i].cNominalSectors)
4465 {
4466 pExtent = &pImage->pExtents[i];
4467 *puSectorInExtent = offSector + pImage->pExtents[i].uSectorOffset;
4468 break;
4469 }
4470 offSector -= pImage->pExtents[i].cNominalSectors;
4471 }
4472
4473 if (pExtent)
4474 *ppExtent = pExtent;
4475 else
4476 rc = VERR_IO_SECTOR_NOT_FOUND;
4477
4478 return rc;
4479}
4480
4481/**
4482 * Internal. Hash function for placing the grain table hash entries.
4483 */
4484static uint32_t vmdkGTCacheHash(PVMDKGTCACHE pCache, uint64_t uSector,
4485 unsigned uExtent)
4486{
4487 /** @todo this hash function is quite simple, maybe use a better one which
4488 * scrambles the bits better. */
4489 return (uSector + uExtent) % pCache->cEntries;
4490}
4491
4492/**
4493 * Internal. Get sector number in the extent file from the relative sector
4494 * number in the extent.
4495 */
4496static int vmdkGetSector(PVMDKIMAGE pImage, PVDIOCTX pIoCtx,
4497 PVMDKEXTENT pExtent, uint64_t uSector,
4498 uint64_t *puExtentSector)
4499{
4500 PVMDKGTCACHE pCache = pImage->pGTCache;
4501 uint64_t uGDIndex, uGTSector, uGTBlock;
4502 uint32_t uGTHash, uGTBlockIndex;
4503 PVMDKGTCACHEENTRY pGTCacheEntry;
4504 uint32_t aGTDataTmp[VMDK_GT_CACHELINE_SIZE];
4505 int rc;
4506
4507 /* For newly created and readonly/sequentially opened streamOptimized
4508 * images this must be a no-op, as the grain directory is not there. */
4509 if ( ( pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED
4510 && pExtent->uAppendPosition)
4511 || ( pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED
4512 && pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY
4513 && pImage->uOpenFlags & VD_OPEN_FLAGS_SEQUENTIAL))
4514 {
4515 *puExtentSector = 0;
4516 return VINF_SUCCESS;
4517 }
4518
4519 uGDIndex = uSector / pExtent->cSectorsPerGDE;
4520 if (uGDIndex >= pExtent->cGDEntries)
4521 return VERR_OUT_OF_RANGE;
4522 uGTSector = pExtent->pGD[uGDIndex];
4523 if (!uGTSector)
4524 {
4525 /* There is no grain table referenced by this grain directory
4526 * entry. So there is absolutely no data in this area. */
4527 *puExtentSector = 0;
4528 return VINF_SUCCESS;
4529 }
4530
4531 uGTBlock = uSector / (pExtent->cSectorsPerGrain * VMDK_GT_CACHELINE_SIZE);
4532 uGTHash = vmdkGTCacheHash(pCache, uGTBlock, pExtent->uExtent);
4533 pGTCacheEntry = &pCache->aGTCache[uGTHash];
4534 if ( pGTCacheEntry->uExtent != pExtent->uExtent
4535 || pGTCacheEntry->uGTBlock != uGTBlock)
4536 {
4537 /* Cache miss, fetch data from disk. */
4538 PVDMETAXFER pMetaXfer;
4539 rc = vdIfIoIntFileReadMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4540 VMDK_SECTOR2BYTE(uGTSector) + (uGTBlock % (pExtent->cGTEntries / VMDK_GT_CACHELINE_SIZE)) * sizeof(aGTDataTmp),
4541 aGTDataTmp, sizeof(aGTDataTmp), pIoCtx, &pMetaXfer, NULL, NULL);
4542 if (RT_FAILURE(rc))
4543 return rc;
4544 /* We can release the metadata transfer immediately. */
4545 vdIfIoIntMetaXferRelease(pImage->pIfIo, pMetaXfer);
4546 pGTCacheEntry->uExtent = pExtent->uExtent;
4547 pGTCacheEntry->uGTBlock = uGTBlock;
4548 for (unsigned i = 0; i < VMDK_GT_CACHELINE_SIZE; i++)
4549 pGTCacheEntry->aGTData[i] = RT_LE2H_U32(aGTDataTmp[i]);
4550 }
4551 uGTBlockIndex = (uSector / pExtent->cSectorsPerGrain) % VMDK_GT_CACHELINE_SIZE;
4552 uint32_t uGrainSector = pGTCacheEntry->aGTData[uGTBlockIndex];
4553 if (uGrainSector)
4554 *puExtentSector = uGrainSector + uSector % pExtent->cSectorsPerGrain;
4555 else
4556 *puExtentSector = 0;
4557 return VINF_SUCCESS;
4558}
4559
4560/**
4561 * Internal. Writes the grain and also if necessary the grain tables.
4562 * Uses the grain table cache as a true grain table.
4563 */
4564static int vmdkStreamAllocGrain(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
4565 uint64_t uSector, PVDIOCTX pIoCtx,
4566 uint64_t cbWrite)
4567{
4568 uint32_t uGrain;
4569 uint32_t uGDEntry, uLastGDEntry;
4570 uint32_t cbGrain = 0;
4571 uint32_t uCacheLine, uCacheEntry;
4572 const void *pData;
4573 int rc;
4574
4575 /* Very strict requirements: always write at least one full grain, with
4576 * proper alignment. Everything else would require reading of already
4577 * written data, which we don't support for obvious reasons. The only
4578 * exception is the last grain, and only if the image size specifies
4579 * that only some portion holds data. In any case the write must be
4580 * within the image limits, no "overshoot" allowed. */
4581 if ( cbWrite == 0
4582 || ( cbWrite < VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain)
4583 && pExtent->cNominalSectors - uSector >= pExtent->cSectorsPerGrain)
4584 || uSector % pExtent->cSectorsPerGrain
4585 || uSector + VMDK_BYTE2SECTOR(cbWrite) > pExtent->cNominalSectors)
4586 return VERR_INVALID_PARAMETER;
4587
4588 /* Clip write range to at most the rest of the grain. */
4589 cbWrite = RT_MIN(cbWrite, VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain - uSector % pExtent->cSectorsPerGrain));
4590
4591 /* Do not allow to go back. */
4592 uGrain = uSector / pExtent->cSectorsPerGrain;
4593 uCacheLine = uGrain % pExtent->cGTEntries / VMDK_GT_CACHELINE_SIZE;
4594 uCacheEntry = uGrain % VMDK_GT_CACHELINE_SIZE;
4595 uGDEntry = uGrain / pExtent->cGTEntries;
4596 uLastGDEntry = pExtent->uLastGrainAccess / pExtent->cGTEntries;
4597 if (uGrain < pExtent->uLastGrainAccess)
4598 return VERR_VD_VMDK_INVALID_WRITE;
4599
4600 /* Zero byte write optimization. Since we don't tell VBoxHDD that we need
4601 * to allocate something, we also need to detect the situation ourself. */
4602 if ( !(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_ZEROES)
4603 && vdIfIoIntIoCtxIsZero(pImage->pIfIo, pIoCtx, cbWrite, true /* fAdvance */))
4604 return VINF_SUCCESS;
4605
4606 if (uGDEntry != uLastGDEntry)
4607 {
4608 rc = vmdkStreamFlushGT(pImage, pExtent, uLastGDEntry);
4609 if (RT_FAILURE(rc))
4610 return rc;
4611 vmdkStreamClearGT(pImage, pExtent);
4612 for (uint32_t i = uLastGDEntry + 1; i < uGDEntry; i++)
4613 {
4614 rc = vmdkStreamFlushGT(pImage, pExtent, i);
4615 if (RT_FAILURE(rc))
4616 return rc;
4617 }
4618 }
4619
4620 uint64_t uFileOffset;
4621 uFileOffset = pExtent->uAppendPosition;
4622 if (!uFileOffset)
4623 return VERR_INTERNAL_ERROR;
4624 /* Align to sector, as the previous write could have been any size. */
4625 uFileOffset = RT_ALIGN_64(uFileOffset, 512);
4626
4627 /* Paranoia check: extent type, grain table buffer presence and
4628 * grain table buffer space. Also grain table entry must be clear. */
4629 if ( pExtent->enmType != VMDKETYPE_HOSTED_SPARSE
4630 || !pImage->pGTCache
4631 || pExtent->cGTEntries > VMDK_GT_CACHE_SIZE * VMDK_GT_CACHELINE_SIZE
4632 || pImage->pGTCache->aGTCache[uCacheLine].aGTData[uCacheEntry])
4633 return VERR_INTERNAL_ERROR;
4634
4635 /* Update grain table entry. */
4636 pImage->pGTCache->aGTCache[uCacheLine].aGTData[uCacheEntry] = VMDK_BYTE2SECTOR(uFileOffset);
4637
4638 if (cbWrite != VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain))
4639 {
4640 vdIfIoIntIoCtxCopyFrom(pImage->pIfIo, pIoCtx, pExtent->pvGrain, cbWrite);
4641 memset((char *)pExtent->pvGrain + cbWrite, '\0',
4642 VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain) - cbWrite);
4643 pData = pExtent->pvGrain;
4644 }
4645 else
4646 {
4647 RTSGSEG Segment;
4648 unsigned cSegments = 1;
4649 size_t cbSeg = 0;
4650
4651 cbSeg = vdIfIoIntIoCtxSegArrayCreate(pImage->pIfIo, pIoCtx, &Segment,
4652 &cSegments, VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain));
4653 Assert(cbSeg == VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain));
4654 pData = Segment.pvSeg;
4655 }
4656 rc = vmdkFileDeflateSync(pImage, pExtent, uFileOffset, pData,
4657 VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain),
4658 uSector, &cbGrain);
4659 if (RT_FAILURE(rc))
4660 {
4661 pExtent->uGrainSectorAbs = 0;
4662 AssertRC(rc);
4663 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write compressed data block in '%s'"), pExtent->pszFullname);
4664 }
4665 pExtent->uLastGrainAccess = uGrain;
4666 pExtent->uAppendPosition += cbGrain;
4667
4668 return rc;
4669}
4670
4671/**
4672 * Internal: Updates the grain table during grain allocation.
4673 */
4674static int vmdkAllocGrainGTUpdate(PVMDKIMAGE pImage, PVMDKEXTENT pExtent, PVDIOCTX pIoCtx,
4675 PVMDKGRAINALLOCASYNC pGrainAlloc)
4676{
4677 int rc = VINF_SUCCESS;
4678 PVMDKGTCACHE pCache = pImage->pGTCache;
4679 uint32_t aGTDataTmp[VMDK_GT_CACHELINE_SIZE];
4680 uint32_t uGTHash, uGTBlockIndex;
4681 uint64_t uGTSector, uRGTSector, uGTBlock;
4682 uint64_t uSector = pGrainAlloc->uSector;
4683 PVMDKGTCACHEENTRY pGTCacheEntry;
4684
4685 LogFlowFunc(("pImage=%#p pExtent=%#p pCache=%#p pIoCtx=%#p pGrainAlloc=%#p\n",
4686 pImage, pExtent, pCache, pIoCtx, pGrainAlloc));
4687
4688 uGTSector = pGrainAlloc->uGTSector;
4689 uRGTSector = pGrainAlloc->uRGTSector;
4690 LogFlow(("uGTSector=%llu uRGTSector=%llu\n", uGTSector, uRGTSector));
4691
4692 /* Update the grain table (and the cache). */
4693 uGTBlock = uSector / (pExtent->cSectorsPerGrain * VMDK_GT_CACHELINE_SIZE);
4694 uGTHash = vmdkGTCacheHash(pCache, uGTBlock, pExtent->uExtent);
4695 pGTCacheEntry = &pCache->aGTCache[uGTHash];
4696 if ( pGTCacheEntry->uExtent != pExtent->uExtent
4697 || pGTCacheEntry->uGTBlock != uGTBlock)
4698 {
4699 /* Cache miss, fetch data from disk. */
4700 LogFlow(("Cache miss, fetch data from disk\n"));
4701 PVDMETAXFER pMetaXfer = NULL;
4702 rc = vdIfIoIntFileReadMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4703 VMDK_SECTOR2BYTE(uGTSector) + (uGTBlock % (pExtent->cGTEntries / VMDK_GT_CACHELINE_SIZE)) * sizeof(aGTDataTmp),
4704 aGTDataTmp, sizeof(aGTDataTmp), pIoCtx,
4705 &pMetaXfer, vmdkAllocGrainComplete, pGrainAlloc);
4706 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4707 {
4708 pGrainAlloc->cIoXfersPending++;
4709 pGrainAlloc->fGTUpdateNeeded = true;
4710 /* Leave early, we will be called again after the read completed. */
4711 LogFlowFunc(("Metadata read in progress, leaving\n"));
4712 return rc;
4713 }
4714 else if (RT_FAILURE(rc))
4715 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot read allocated grain table entry in '%s'"), pExtent->pszFullname);
4716 vdIfIoIntMetaXferRelease(pImage->pIfIo, pMetaXfer);
4717 pGTCacheEntry->uExtent = pExtent->uExtent;
4718 pGTCacheEntry->uGTBlock = uGTBlock;
4719 for (unsigned i = 0; i < VMDK_GT_CACHELINE_SIZE; i++)
4720 pGTCacheEntry->aGTData[i] = RT_LE2H_U32(aGTDataTmp[i]);
4721 }
4722 else
4723 {
4724 /* Cache hit. Convert grain table block back to disk format, otherwise
4725 * the code below will write garbage for all but the updated entry. */
4726 for (unsigned i = 0; i < VMDK_GT_CACHELINE_SIZE; i++)
4727 aGTDataTmp[i] = RT_H2LE_U32(pGTCacheEntry->aGTData[i]);
4728 }
4729 pGrainAlloc->fGTUpdateNeeded = false;
4730 uGTBlockIndex = (uSector / pExtent->cSectorsPerGrain) % VMDK_GT_CACHELINE_SIZE;
4731 aGTDataTmp[uGTBlockIndex] = RT_H2LE_U32(VMDK_BYTE2SECTOR(pGrainAlloc->uGrainOffset));
4732 pGTCacheEntry->aGTData[uGTBlockIndex] = VMDK_BYTE2SECTOR(pGrainAlloc->uGrainOffset);
4733 /* Update grain table on disk. */
4734 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4735 VMDK_SECTOR2BYTE(uGTSector) + (uGTBlock % (pExtent->cGTEntries / VMDK_GT_CACHELINE_SIZE)) * sizeof(aGTDataTmp),
4736 aGTDataTmp, sizeof(aGTDataTmp), pIoCtx,
4737 vmdkAllocGrainComplete, pGrainAlloc);
4738 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4739 pGrainAlloc->cIoXfersPending++;
4740 else if (RT_FAILURE(rc))
4741 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write updated grain table in '%s'"), pExtent->pszFullname);
4742 if (pExtent->pRGD)
4743 {
4744 /* Update backup grain table on disk. */
4745 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4746 VMDK_SECTOR2BYTE(uRGTSector) + (uGTBlock % (pExtent->cGTEntries / VMDK_GT_CACHELINE_SIZE)) * sizeof(aGTDataTmp),
4747 aGTDataTmp, sizeof(aGTDataTmp), pIoCtx,
4748 vmdkAllocGrainComplete, pGrainAlloc);
4749 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4750 pGrainAlloc->cIoXfersPending++;
4751 else if (RT_FAILURE(rc))
4752 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write updated backup grain table in '%s'"), pExtent->pszFullname);
4753 }
4754#ifdef VBOX_WITH_VMDK_ESX
4755 if (RT_SUCCESS(rc) && pExtent->enmType == VMDKETYPE_ESX_SPARSE)
4756 {
4757 pExtent->uFreeSector = uGTSector + VMDK_BYTE2SECTOR(cbWrite);
4758 pExtent->fMetaDirty = true;
4759 }
4760#endif /* VBOX_WITH_VMDK_ESX */
4761
4762 LogFlowFunc(("leaving rc=%Rrc\n", rc));
4763
4764 return rc;
4765}
4766
4767/**
4768 * Internal - complete the grain allocation by updating disk grain table if required.
4769 */
4770static int vmdkAllocGrainComplete(void *pBackendData, PVDIOCTX pIoCtx, void *pvUser, int rcReq)
4771{
4772 int rc = VINF_SUCCESS;
4773 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
4774 PVMDKGRAINALLOCASYNC pGrainAlloc = (PVMDKGRAINALLOCASYNC)pvUser;
4775 PVMDKEXTENT pExtent = pGrainAlloc->pExtent;
4776
4777 LogFlowFunc(("pBackendData=%#p pIoCtx=%#p pvUser=%#p rcReq=%Rrc\n",
4778 pBackendData, pIoCtx, pvUser, rcReq));
4779
4780 pGrainAlloc->cIoXfersPending--;
4781 if (!pGrainAlloc->cIoXfersPending && pGrainAlloc->fGTUpdateNeeded)
4782 rc = vmdkAllocGrainGTUpdate(pImage, pGrainAlloc->pExtent, pIoCtx, pGrainAlloc);
4783
4784 if (!pGrainAlloc->cIoXfersPending)
4785 {
4786 /* Grain allocation completed. */
4787 RTMemFree(pGrainAlloc);
4788 }
4789
4790 LogFlowFunc(("Leaving rc=%Rrc\n", rc));
4791 return rc;
4792}
4793
4794/**
4795 * Internal. Allocates a new grain table (if necessary).
4796 */
4797static int vmdkAllocGrain(PVMDKIMAGE pImage, PVMDKEXTENT pExtent, PVDIOCTX pIoCtx,
4798 uint64_t uSector, uint64_t cbWrite)
4799{
4800 PVMDKGTCACHE pCache = pImage->pGTCache;
4801 uint64_t uGDIndex, uGTSector, uRGTSector;
4802 uint64_t uFileOffset;
4803 PVMDKGRAINALLOCASYNC pGrainAlloc = NULL;
4804 int rc;
4805
4806 LogFlowFunc(("pCache=%#p pExtent=%#p pIoCtx=%#p uSector=%llu cbWrite=%llu\n",
4807 pCache, pExtent, pIoCtx, uSector, cbWrite));
4808
4809 pGrainAlloc = (PVMDKGRAINALLOCASYNC)RTMemAllocZ(sizeof(VMDKGRAINALLOCASYNC));
4810 if (!pGrainAlloc)
4811 return VERR_NO_MEMORY;
4812
4813 pGrainAlloc->pExtent = pExtent;
4814 pGrainAlloc->uSector = uSector;
4815
4816 uGDIndex = uSector / pExtent->cSectorsPerGDE;
4817 if (uGDIndex >= pExtent->cGDEntries)
4818 {
4819 RTMemFree(pGrainAlloc);
4820 return VERR_OUT_OF_RANGE;
4821 }
4822 uGTSector = pExtent->pGD[uGDIndex];
4823 if (pExtent->pRGD)
4824 uRGTSector = pExtent->pRGD[uGDIndex];
4825 else
4826 uRGTSector = 0; /**< avoid compiler warning */
4827 if (!uGTSector)
4828 {
4829 LogFlow(("Allocating new grain table\n"));
4830
4831 /* There is no grain table referenced by this grain directory
4832 * entry. So there is absolutely no data in this area. Allocate
4833 * a new grain table and put the reference to it in the GDs. */
4834 uFileOffset = pExtent->uAppendPosition;
4835 if (!uFileOffset)
4836 {
4837 RTMemFree(pGrainAlloc);
4838 return VERR_INTERNAL_ERROR;
4839 }
4840 Assert(!(uFileOffset % 512));
4841
4842 uFileOffset = RT_ALIGN_64(uFileOffset, 512);
4843 uGTSector = VMDK_BYTE2SECTOR(uFileOffset);
4844
4845 /* Normally the grain table is preallocated for hosted sparse extents
4846 * that support more than 32 bit sector numbers. So this shouldn't
4847 * ever happen on a valid extent. */
4848 if (uGTSector > UINT32_MAX)
4849 {
4850 RTMemFree(pGrainAlloc);
4851 return VERR_VD_VMDK_INVALID_HEADER;
4852 }
4853
4854 /* Write grain table by writing the required number of grain table
4855 * cache chunks. Allocate memory dynamically here or we flood the
4856 * metadata cache with very small entries. */
4857 size_t cbGTDataTmp = pExtent->cGTEntries * sizeof(uint32_t);
4858 uint32_t *paGTDataTmp = (uint32_t *)RTMemTmpAllocZ(cbGTDataTmp);
4859
4860 if (!paGTDataTmp)
4861 {
4862 RTMemFree(pGrainAlloc);
4863 return VERR_NO_MEMORY;
4864 }
4865
4866 memset(paGTDataTmp, '\0', cbGTDataTmp);
4867 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4868 VMDK_SECTOR2BYTE(uGTSector),
4869 paGTDataTmp, cbGTDataTmp, pIoCtx,
4870 vmdkAllocGrainComplete, pGrainAlloc);
4871 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4872 pGrainAlloc->cIoXfersPending++;
4873 else if (RT_FAILURE(rc))
4874 {
4875 RTMemTmpFree(paGTDataTmp);
4876 RTMemFree(pGrainAlloc);
4877 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write grain table allocation in '%s'"), pExtent->pszFullname);
4878 }
4879 pExtent->uAppendPosition = RT_ALIGN_64( pExtent->uAppendPosition
4880 + cbGTDataTmp, 512);
4881
4882 if (pExtent->pRGD)
4883 {
4884 AssertReturn(!uRGTSector, VERR_VD_VMDK_INVALID_HEADER);
4885 uFileOffset = pExtent->uAppendPosition;
4886 if (!uFileOffset)
4887 return VERR_INTERNAL_ERROR;
4888 Assert(!(uFileOffset % 512));
4889 uRGTSector = VMDK_BYTE2SECTOR(uFileOffset);
4890
4891 /* Normally the redundant grain table is preallocated for hosted
4892 * sparse extents that support more than 32 bit sector numbers. So
4893 * this shouldn't ever happen on a valid extent. */
4894 if (uRGTSector > UINT32_MAX)
4895 {
4896 RTMemTmpFree(paGTDataTmp);
4897 return VERR_VD_VMDK_INVALID_HEADER;
4898 }
4899
4900 /* Write grain table by writing the required number of grain table
4901 * cache chunks. Allocate memory dynamically here or we flood the
4902 * metadata cache with very small entries. */
4903 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4904 VMDK_SECTOR2BYTE(uRGTSector),
4905 paGTDataTmp, cbGTDataTmp, pIoCtx,
4906 vmdkAllocGrainComplete, pGrainAlloc);
4907 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4908 pGrainAlloc->cIoXfersPending++;
4909 else if (RT_FAILURE(rc))
4910 {
4911 RTMemTmpFree(paGTDataTmp);
4912 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write backup grain table allocation in '%s'"), pExtent->pszFullname);
4913 }
4914
4915 pExtent->uAppendPosition = pExtent->uAppendPosition + cbGTDataTmp;
4916 }
4917
4918 RTMemTmpFree(paGTDataTmp);
4919
4920 /* Update the grain directory on disk (doing it before writing the
4921 * grain table will result in a garbled extent if the operation is
4922 * aborted for some reason. Otherwise the worst that can happen is
4923 * some unused sectors in the extent. */
4924 uint32_t uGTSectorLE = RT_H2LE_U64(uGTSector);
4925 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4926 VMDK_SECTOR2BYTE(pExtent->uSectorGD) + uGDIndex * sizeof(uGTSectorLE),
4927 &uGTSectorLE, sizeof(uGTSectorLE), pIoCtx,
4928 vmdkAllocGrainComplete, pGrainAlloc);
4929 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4930 pGrainAlloc->cIoXfersPending++;
4931 else if (RT_FAILURE(rc))
4932 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write grain directory entry in '%s'"), pExtent->pszFullname);
4933 if (pExtent->pRGD)
4934 {
4935 uint32_t uRGTSectorLE = RT_H2LE_U64(uRGTSector);
4936 rc = vdIfIoIntFileWriteMeta(pImage->pIfIo, pExtent->pFile->pStorage,
4937 VMDK_SECTOR2BYTE(pExtent->uSectorRGD) + uGDIndex * sizeof(uGTSectorLE),
4938 &uRGTSectorLE, sizeof(uRGTSectorLE), pIoCtx,
4939 vmdkAllocGrainComplete, pGrainAlloc);
4940 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
4941 pGrainAlloc->cIoXfersPending++;
4942 else if (RT_FAILURE(rc))
4943 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write backup grain directory entry in '%s'"), pExtent->pszFullname);
4944 }
4945
4946 /* As the final step update the in-memory copy of the GDs. */
4947 pExtent->pGD[uGDIndex] = uGTSector;
4948 if (pExtent->pRGD)
4949 pExtent->pRGD[uGDIndex] = uRGTSector;
4950 }
4951
4952 LogFlow(("uGTSector=%llu uRGTSector=%llu\n", uGTSector, uRGTSector));
4953 pGrainAlloc->uGTSector = uGTSector;
4954 pGrainAlloc->uRGTSector = uRGTSector;
4955
4956 uFileOffset = pExtent->uAppendPosition;
4957 if (!uFileOffset)
4958 return VERR_INTERNAL_ERROR;
4959 Assert(!(uFileOffset % 512));
4960
4961 pGrainAlloc->uGrainOffset = uFileOffset;
4962
4963 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
4964 {
4965 AssertMsgReturn(vdIfIoIntIoCtxIsSynchronous(pImage->pIfIo, pIoCtx),
4966 ("Accesses to stream optimized images must be synchronous\n"),
4967 VERR_INVALID_STATE);
4968
4969 if (cbWrite != VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain))
4970 return vdIfError(pImage->pIfError, VERR_INTERNAL_ERROR, RT_SRC_POS, N_("VMDK: not enough data for a compressed data block in '%s'"), pExtent->pszFullname);
4971
4972 /* Invalidate cache, just in case some code incorrectly allows mixing
4973 * of reads and writes. Normally shouldn't be needed. */
4974 pExtent->uGrainSectorAbs = 0;
4975
4976 /* Write compressed data block and the markers. */
4977 uint32_t cbGrain = 0;
4978 size_t cbSeg = 0;
4979 RTSGSEG Segment;
4980 unsigned cSegments = 1;
4981
4982 cbSeg = vdIfIoIntIoCtxSegArrayCreate(pImage->pIfIo, pIoCtx, &Segment,
4983 &cSegments, cbWrite);
4984 Assert(cbSeg == cbWrite);
4985
4986 rc = vmdkFileDeflateSync(pImage, pExtent, uFileOffset,
4987 Segment.pvSeg, cbWrite, uSector, &cbGrain);
4988 if (RT_FAILURE(rc))
4989 {
4990 AssertRC(rc);
4991 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write allocated compressed data block in '%s'"), pExtent->pszFullname);
4992 }
4993 pExtent->uLastGrainAccess = uSector / pExtent->cSectorsPerGrain;
4994 pExtent->uAppendPosition += cbGrain;
4995 }
4996 else
4997 {
4998 /* Write the data. Always a full grain, or we're in big trouble. */
4999 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pExtent->pFile->pStorage,
5000 uFileOffset, pIoCtx, cbWrite,
5001 vmdkAllocGrainComplete, pGrainAlloc);
5002 if (rc == VERR_VD_ASYNC_IO_IN_PROGRESS)
5003 pGrainAlloc->cIoXfersPending++;
5004 else if (RT_FAILURE(rc))
5005 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: cannot write allocated data block in '%s'"), pExtent->pszFullname);
5006
5007 pExtent->uAppendPosition += cbWrite;
5008 }
5009
5010 rc = vmdkAllocGrainGTUpdate(pImage, pExtent, pIoCtx, pGrainAlloc);
5011
5012 if (!pGrainAlloc->cIoXfersPending)
5013 {
5014 /* Grain allocation completed. */
5015 RTMemFree(pGrainAlloc);
5016 }
5017
5018 LogFlowFunc(("leaving rc=%Rrc\n", rc));
5019
5020 return rc;
5021}
5022
5023/**
5024 * Internal. Reads the contents by sequentially going over the compressed
5025 * grains (hoping that they are in sequence).
5026 */
5027static int vmdkStreamReadSequential(PVMDKIMAGE pImage, PVMDKEXTENT pExtent,
5028 uint64_t uSector, PVDIOCTX pIoCtx,
5029 uint64_t cbRead)
5030{
5031 int rc;
5032
5033 LogFlowFunc(("pImage=%#p pExtent=%#p uSector=%llu pIoCtx=%#p cbRead=%llu\n",
5034 pImage, pExtent, uSector, pIoCtx, cbRead));
5035
5036 AssertMsgReturn(vdIfIoIntIoCtxIsSynchronous(pImage->pIfIo, pIoCtx),
5037 ("Async I/O not supported for sequential stream optimized images\n"),
5038 VERR_INVALID_STATE);
5039
5040 /* Do not allow to go back. */
5041 uint32_t uGrain = uSector / pExtent->cSectorsPerGrain;
5042 if (uGrain < pExtent->uLastGrainAccess)
5043 return VERR_VD_VMDK_INVALID_STATE;
5044 pExtent->uLastGrainAccess = uGrain;
5045
5046 /* After a previous error do not attempt to recover, as it would need
5047 * seeking (in the general case backwards which is forbidden). */
5048 if (!pExtent->uGrainSectorAbs)
5049 return VERR_VD_VMDK_INVALID_STATE;
5050
5051 /* Check if we need to read something from the image or if what we have
5052 * in the buffer is good to fulfill the request. */
5053 if (!pExtent->cbGrainStreamRead || uGrain > pExtent->uGrain)
5054 {
5055 uint32_t uGrainSectorAbs = pExtent->uGrainSectorAbs
5056 + VMDK_BYTE2SECTOR(pExtent->cbGrainStreamRead);
5057
5058 /* Get the marker from the next data block - and skip everything which
5059 * is not a compressed grain. If it's a compressed grain which is for
5060 * the requested sector (or after), read it. */
5061 VMDKMARKER Marker;
5062 do
5063 {
5064 RT_ZERO(Marker);
5065 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
5066 VMDK_SECTOR2BYTE(uGrainSectorAbs),
5067 &Marker, RT_OFFSETOF(VMDKMARKER, uType));
5068 if (RT_FAILURE(rc))
5069 return rc;
5070 Marker.uSector = RT_LE2H_U64(Marker.uSector);
5071 Marker.cbSize = RT_LE2H_U32(Marker.cbSize);
5072
5073 if (Marker.cbSize == 0)
5074 {
5075 /* A marker for something else than a compressed grain. */
5076 rc = vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
5077 VMDK_SECTOR2BYTE(uGrainSectorAbs)
5078 + RT_OFFSETOF(VMDKMARKER, uType),
5079 &Marker.uType, sizeof(Marker.uType));
5080 if (RT_FAILURE(rc))
5081 return rc;
5082 Marker.uType = RT_LE2H_U32(Marker.uType);
5083 switch (Marker.uType)
5084 {
5085 case VMDK_MARKER_EOS:
5086 uGrainSectorAbs++;
5087 /* Read (or mostly skip) to the end of file. Uses the
5088 * Marker (LBA sector) as it is unused anyway. This
5089 * makes sure that really everything is read in the
5090 * success case. If this read fails it means the image
5091 * is truncated, but this is harmless so ignore. */
5092 vdIfIoIntFileReadSync(pImage->pIfIo, pExtent->pFile->pStorage,
5093 VMDK_SECTOR2BYTE(uGrainSectorAbs)
5094 + 511,
5095 &Marker.uSector, 1);
5096 break;
5097 case VMDK_MARKER_GT:
5098 uGrainSectorAbs += 1 + VMDK_BYTE2SECTOR(pExtent->cGTEntries * sizeof(uint32_t));
5099 break;
5100 case VMDK_MARKER_GD:
5101 uGrainSectorAbs += 1 + VMDK_BYTE2SECTOR(RT_ALIGN(pExtent->cGDEntries * sizeof(uint32_t), 512));
5102 break;
5103 case VMDK_MARKER_FOOTER:
5104 uGrainSectorAbs += 2;
5105 break;
5106 case VMDK_MARKER_UNSPECIFIED:
5107 /* Skip over the contents of the unspecified marker
5108 * type 4 which exists in some vSphere created files. */
5109 /** @todo figure out what the payload means. */
5110 uGrainSectorAbs += 1;
5111 break;
5112 default:
5113 AssertMsgFailed(("VMDK: corrupted marker, type=%#x\n", Marker.uType));
5114 pExtent->uGrainSectorAbs = 0;
5115 return VERR_VD_VMDK_INVALID_STATE;
5116 }
5117 pExtent->cbGrainStreamRead = 0;
5118 }
5119 else
5120 {
5121 /* A compressed grain marker. If it is at/after what we're
5122 * interested in read and decompress data. */
5123 if (uSector > Marker.uSector + pExtent->cSectorsPerGrain)
5124 {
5125 uGrainSectorAbs += VMDK_BYTE2SECTOR(RT_ALIGN(Marker.cbSize + RT_OFFSETOF(VMDKMARKER, uType), 512));
5126 continue;
5127 }
5128 uint64_t uLBA = 0;
5129 uint32_t cbGrainStreamRead = 0;
5130 rc = vmdkFileInflateSync(pImage, pExtent,
5131 VMDK_SECTOR2BYTE(uGrainSectorAbs),
5132 pExtent->pvGrain,
5133 VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain),
5134 &Marker, &uLBA, &cbGrainStreamRead);
5135 if (RT_FAILURE(rc))
5136 {
5137 pExtent->uGrainSectorAbs = 0;
5138 return rc;
5139 }
5140 if ( pExtent->uGrain
5141 && uLBA / pExtent->cSectorsPerGrain <= pExtent->uGrain)
5142 {
5143 pExtent->uGrainSectorAbs = 0;
5144 return VERR_VD_VMDK_INVALID_STATE;
5145 }
5146 pExtent->uGrain = uLBA / pExtent->cSectorsPerGrain;
5147 pExtent->cbGrainStreamRead = cbGrainStreamRead;
5148 break;
5149 }
5150 } while (Marker.uType != VMDK_MARKER_EOS);
5151
5152 pExtent->uGrainSectorAbs = uGrainSectorAbs;
5153
5154 if (!pExtent->cbGrainStreamRead && Marker.uType == VMDK_MARKER_EOS)
5155 {
5156 pExtent->uGrain = UINT32_MAX;
5157 /* Must set a non-zero value for pExtent->cbGrainStreamRead or
5158 * the next read would try to get more data, and we're at EOF. */
5159 pExtent->cbGrainStreamRead = 1;
5160 }
5161 }
5162
5163 if (pExtent->uGrain > uSector / pExtent->cSectorsPerGrain)
5164 {
5165 /* The next data block we have is not for this area, so just return
5166 * that there is no data. */
5167 LogFlowFunc(("returns VERR_VD_BLOCK_FREE\n"));
5168 return VERR_VD_BLOCK_FREE;
5169 }
5170
5171 uint32_t uSectorInGrain = uSector % pExtent->cSectorsPerGrain;
5172 vdIfIoIntIoCtxCopyTo(pImage->pIfIo, pIoCtx,
5173 (uint8_t *)pExtent->pvGrain + VMDK_SECTOR2BYTE(uSectorInGrain),
5174 cbRead);
5175 LogFlowFunc(("returns VINF_SUCCESS\n"));
5176 return VINF_SUCCESS;
5177}
5178
5179/**
5180 * Replaces a fragment of a string with the specified string.
5181 *
5182 * @returns Pointer to the allocated UTF-8 string.
5183 * @param pszWhere UTF-8 string to search in.
5184 * @param pszWhat UTF-8 string to search for.
5185 * @param pszByWhat UTF-8 string to replace the found string with.
5186 */
5187static char *vmdkStrReplace(const char *pszWhere, const char *pszWhat,
5188 const char *pszByWhat)
5189{
5190 AssertPtr(pszWhere);
5191 AssertPtr(pszWhat);
5192 AssertPtr(pszByWhat);
5193 const char *pszFoundStr = strstr(pszWhere, pszWhat);
5194 if (!pszFoundStr)
5195 return NULL;
5196 size_t cFinal = strlen(pszWhere) + 1 + strlen(pszByWhat) - strlen(pszWhat);
5197 char *pszNewStr = (char *)RTMemAlloc(cFinal);
5198 if (pszNewStr)
5199 {
5200 char *pszTmp = pszNewStr;
5201 memcpy(pszTmp, pszWhere, pszFoundStr - pszWhere);
5202 pszTmp += pszFoundStr - pszWhere;
5203 memcpy(pszTmp, pszByWhat, strlen(pszByWhat));
5204 pszTmp += strlen(pszByWhat);
5205 strcpy(pszTmp, pszFoundStr + strlen(pszWhat));
5206 }
5207 return pszNewStr;
5208}
5209
5210
5211/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
5212static DECLCALLBACK(int) vmdkCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
5213 PVDINTERFACE pVDIfsImage, VDTYPE *penmType)
5214{
5215 LogFlowFunc(("pszFilename=\"%s\" pVDIfsDisk=%#p pVDIfsImage=%#p penmType=%#p\n",
5216 pszFilename, pVDIfsDisk, pVDIfsImage, penmType));
5217 int rc = VINF_SUCCESS;
5218 PVMDKIMAGE pImage;
5219
5220 if ( !pszFilename
5221 || !*pszFilename
5222 || strchr(pszFilename, '"'))
5223 {
5224 rc = VERR_INVALID_PARAMETER;
5225 goto out;
5226 }
5227
5228 pImage = (PVMDKIMAGE)RTMemAllocZ(sizeof(VMDKIMAGE));
5229 if (!pImage)
5230 {
5231 rc = VERR_NO_MEMORY;
5232 goto out;
5233 }
5234 pImage->pszFilename = pszFilename;
5235 pImage->pFile = NULL;
5236 pImage->pExtents = NULL;
5237 pImage->pFiles = NULL;
5238 pImage->pGTCache = NULL;
5239 pImage->pDescData = NULL;
5240 pImage->pVDIfsDisk = pVDIfsDisk;
5241 pImage->pVDIfsImage = pVDIfsImage;
5242 /** @todo speed up this test open (VD_OPEN_FLAGS_INFO) by skipping as
5243 * much as possible in vmdkOpenImage. */
5244 rc = vmdkOpenImage(pImage, VD_OPEN_FLAGS_INFO | VD_OPEN_FLAGS_READONLY);
5245 vmdkFreeImage(pImage, false);
5246 RTMemFree(pImage);
5247
5248 if (RT_SUCCESS(rc))
5249 *penmType = VDTYPE_HDD;
5250
5251out:
5252 LogFlowFunc(("returns %Rrc\n", rc));
5253 return rc;
5254}
5255
5256/** @copydoc VBOXHDDBACKEND::pfnOpen */
5257static DECLCALLBACK(int) vmdkOpen(const char *pszFilename, unsigned uOpenFlags,
5258 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
5259 VDTYPE enmType, void **ppBackendData)
5260{
5261 LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p enmType=%u ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, enmType, ppBackendData));
5262 int rc;
5263 PVMDKIMAGE pImage;
5264
5265 NOREF(enmType); /**< @todo r=klaus make use of the type info. */
5266
5267 /* Check open flags. All valid flags are supported. */
5268 if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
5269 {
5270 rc = VERR_INVALID_PARAMETER;
5271 goto out;
5272 }
5273
5274 /* Check remaining arguments. */
5275 if ( !VALID_PTR(pszFilename)
5276 || !*pszFilename
5277 || strchr(pszFilename, '"'))
5278 {
5279 rc = VERR_INVALID_PARAMETER;
5280 goto out;
5281 }
5282
5283 pImage = (PVMDKIMAGE)RTMemAllocZ(sizeof(VMDKIMAGE));
5284 if (!pImage)
5285 {
5286 rc = VERR_NO_MEMORY;
5287 goto out;
5288 }
5289 pImage->pszFilename = pszFilename;
5290 pImage->pFile = NULL;
5291 pImage->pExtents = NULL;
5292 pImage->pFiles = NULL;
5293 pImage->pGTCache = NULL;
5294 pImage->pDescData = NULL;
5295 pImage->pVDIfsDisk = pVDIfsDisk;
5296 pImage->pVDIfsImage = pVDIfsImage;
5297
5298 rc = vmdkOpenImage(pImage, uOpenFlags);
5299 if (RT_SUCCESS(rc))
5300 *ppBackendData = pImage;
5301 else
5302 RTMemFree(pImage);
5303
5304out:
5305 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
5306 return rc;
5307}
5308
5309/** @copydoc VBOXHDDBACKEND::pfnCreate */
5310static DECLCALLBACK(int) vmdkCreate(const char *pszFilename, uint64_t cbSize,
5311 unsigned uImageFlags, const char *pszComment,
5312 PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
5313 PCRTUUID pUuid, unsigned uOpenFlags,
5314 unsigned uPercentStart, unsigned uPercentSpan,
5315 PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
5316 PVDINTERFACE pVDIfsOperation, VDTYPE enmType,
5317 void **ppBackendData)
5318{
5319 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\n",
5320 pszFilename, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, enmType, ppBackendData));
5321 int rc;
5322 PVMDKIMAGE pImage;
5323
5324 PFNVDPROGRESS pfnProgress = NULL;
5325 void *pvUser = NULL;
5326 PVDINTERFACEPROGRESS pIfProgress = VDIfProgressGet(pVDIfsOperation);
5327 if (pIfProgress)
5328 {
5329 pfnProgress = pIfProgress->pfnProgress;
5330 pvUser = pIfProgress->Core.pvUser;
5331 }
5332
5333 /* Check the image flags. */
5334 if ((uImageFlags & ~VD_VMDK_IMAGE_FLAGS_MASK) != 0)
5335 {
5336 rc = VERR_VD_INVALID_TYPE;
5337 goto out;
5338 }
5339
5340 /* Check the VD container type. */
5341 if (enmType != VDTYPE_HDD)
5342 {
5343 rc = VERR_VD_INVALID_TYPE;
5344 goto out;
5345 }
5346
5347 /* Check open flags. All valid flags are supported. */
5348 if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
5349 {
5350 rc = VERR_INVALID_PARAMETER;
5351 goto out;
5352 }
5353
5354 /* Check size. Maximum 2TB-64K for sparse images, otherwise unlimited. */
5355 if ( !cbSize
5356 || (!(uImageFlags & VD_IMAGE_FLAGS_FIXED) && cbSize >= _1T * 2 - _64K))
5357 {
5358 rc = VERR_VD_INVALID_SIZE;
5359 goto out;
5360 }
5361
5362 /* Check remaining arguments. */
5363 if ( !VALID_PTR(pszFilename)
5364 || !*pszFilename
5365 || strchr(pszFilename, '"')
5366 || !VALID_PTR(pPCHSGeometry)
5367 || !VALID_PTR(pLCHSGeometry)
5368#ifndef VBOX_WITH_VMDK_ESX
5369 || ( uImageFlags & VD_VMDK_IMAGE_FLAGS_ESX
5370 && !(uImageFlags & VD_IMAGE_FLAGS_FIXED))
5371#endif
5372 || ( (uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
5373 && (uImageFlags & ~(VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED | VD_IMAGE_FLAGS_DIFF))))
5374 {
5375 rc = VERR_INVALID_PARAMETER;
5376 goto out;
5377 }
5378
5379 pImage = (PVMDKIMAGE)RTMemAllocZ(sizeof(VMDKIMAGE));
5380 if (!pImage)
5381 {
5382 rc = VERR_NO_MEMORY;
5383 goto out;
5384 }
5385 pImage->pszFilename = pszFilename;
5386 pImage->pFile = NULL;
5387 pImage->pExtents = NULL;
5388 pImage->pFiles = NULL;
5389 pImage->pGTCache = NULL;
5390 pImage->pDescData = NULL;
5391 pImage->pVDIfsDisk = pVDIfsDisk;
5392 pImage->pVDIfsImage = pVDIfsImage;
5393 /* Descriptors for split images can be pretty large, especially if the
5394 * filename is long. So prepare for the worst, and allocate quite some
5395 * memory for the descriptor in this case. */
5396 if (uImageFlags & VD_VMDK_IMAGE_FLAGS_SPLIT_2G)
5397 pImage->cbDescAlloc = VMDK_SECTOR2BYTE(200);
5398 else
5399 pImage->cbDescAlloc = VMDK_SECTOR2BYTE(20);
5400 pImage->pDescData = (char *)RTMemAllocZ(pImage->cbDescAlloc);
5401 if (!pImage->pDescData)
5402 {
5403 RTMemFree(pImage);
5404 rc = VERR_NO_MEMORY;
5405 goto out;
5406 }
5407
5408 rc = vmdkCreateImage(pImage, cbSize, uImageFlags, pszComment,
5409 pPCHSGeometry, pLCHSGeometry, pUuid,
5410 pfnProgress, pvUser, uPercentStart, uPercentSpan);
5411 if (RT_SUCCESS(rc))
5412 {
5413 /* So far the image is opened in read/write mode. Make sure the
5414 * image is opened in read-only mode if the caller requested that. */
5415 if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
5416 {
5417 vmdkFreeImage(pImage, false);
5418 rc = vmdkOpenImage(pImage, uOpenFlags);
5419 if (RT_FAILURE(rc))
5420 goto out;
5421 }
5422 *ppBackendData = pImage;
5423 }
5424 else
5425 {
5426 RTMemFree(pImage->pDescData);
5427 RTMemFree(pImage);
5428 }
5429
5430out:
5431 LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
5432 return rc;
5433}
5434
5435/** @copydoc VBOXHDDBACKEND::pfnRename */
5436static DECLCALLBACK(int) vmdkRename(void *pBackendData, const char *pszFilename)
5437{
5438 LogFlowFunc(("pBackendData=%#p pszFilename=%#p\n", pBackendData, pszFilename));
5439
5440 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
5441 int rc = VINF_SUCCESS;
5442 char **apszOldName = NULL;
5443 char **apszNewName = NULL;
5444 char **apszNewLines = NULL;
5445 char *pszOldDescName = NULL;
5446 bool fImageFreed = false;
5447 bool fEmbeddedDesc = false;
5448 unsigned cExtents = 0;
5449 char *pszNewBaseName = NULL;
5450 char *pszOldBaseName = NULL;
5451 char *pszNewFullName = NULL;
5452 char *pszOldFullName = NULL;
5453 const char *pszOldImageName;
5454 unsigned i, line;
5455 VMDKDESCRIPTOR DescriptorCopy;
5456 VMDKEXTENT ExtentCopy;
5457
5458 memset(&DescriptorCopy, 0, sizeof(DescriptorCopy));
5459
5460 /* Check arguments. */
5461 if ( !pImage
5462 || (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_RAWDISK)
5463 || !VALID_PTR(pszFilename)
5464 || !*pszFilename)
5465 {
5466 rc = VERR_INVALID_PARAMETER;
5467 goto out;
5468 }
5469
5470 cExtents = pImage->cExtents;
5471
5472 /*
5473 * Allocate an array to store both old and new names of renamed files
5474 * in case we have to roll back the changes. Arrays are initialized
5475 * with zeros. We actually save stuff when and if we change it.
5476 */
5477 apszOldName = (char **)RTMemTmpAllocZ((cExtents + 1) * sizeof(char*));
5478 apszNewName = (char **)RTMemTmpAllocZ((cExtents + 1) * sizeof(char*));
5479 apszNewLines = (char **)RTMemTmpAllocZ((cExtents) * sizeof(char*));
5480 if (!apszOldName || !apszNewName || !apszNewLines)
5481 {
5482 rc = VERR_NO_MEMORY;
5483 goto out;
5484 }
5485
5486 /* Save the descriptor size and position. */
5487 if (pImage->pDescData)
5488 {
5489 /* Separate descriptor file. */
5490 fEmbeddedDesc = false;
5491 }
5492 else
5493 {
5494 /* Embedded descriptor file. */
5495 ExtentCopy = pImage->pExtents[0];
5496 fEmbeddedDesc = true;
5497 }
5498 /* Save the descriptor content. */
5499 DescriptorCopy.cLines = pImage->Descriptor.cLines;
5500 for (i = 0; i < DescriptorCopy.cLines; i++)
5501 {
5502 DescriptorCopy.aLines[i] = RTStrDup(pImage->Descriptor.aLines[i]);
5503 if (!DescriptorCopy.aLines[i])
5504 {
5505 rc = VERR_NO_MEMORY;
5506 goto out;
5507 }
5508 }
5509
5510 /* Prepare both old and new base names used for string replacement. */
5511 pszNewBaseName = RTStrDup(RTPathFilename(pszFilename));
5512 RTPathStripSuffix(pszNewBaseName);
5513 pszOldBaseName = RTStrDup(RTPathFilename(pImage->pszFilename));
5514 RTPathStripSuffix(pszOldBaseName);
5515 /* Prepare both old and new full names used for string replacement. */
5516 pszNewFullName = RTStrDup(pszFilename);
5517 RTPathStripSuffix(pszNewFullName);
5518 pszOldFullName = RTStrDup(pImage->pszFilename);
5519 RTPathStripSuffix(pszOldFullName);
5520
5521 /* --- Up to this point we have not done any damage yet. --- */
5522
5523 /* Save the old name for easy access to the old descriptor file. */
5524 pszOldDescName = RTStrDup(pImage->pszFilename);
5525 /* Save old image name. */
5526 pszOldImageName = pImage->pszFilename;
5527
5528 /* Update the descriptor with modified extent names. */
5529 for (i = 0, line = pImage->Descriptor.uFirstExtent;
5530 i < cExtents;
5531 i++, line = pImage->Descriptor.aNextLines[line])
5532 {
5533 /* Assume that vmdkStrReplace will fail. */
5534 rc = VERR_NO_MEMORY;
5535 /* Update the descriptor. */
5536 apszNewLines[i] = vmdkStrReplace(pImage->Descriptor.aLines[line],
5537 pszOldBaseName, pszNewBaseName);
5538 if (!apszNewLines[i])
5539 goto rollback;
5540 pImage->Descriptor.aLines[line] = apszNewLines[i];
5541 }
5542 /* Make sure the descriptor gets written back. */
5543 pImage->Descriptor.fDirty = true;
5544 /* Flush the descriptor now, in case it is embedded. */
5545 vmdkFlushImage(pImage, NULL);
5546
5547 /* Close and rename/move extents. */
5548 for (i = 0; i < cExtents; i++)
5549 {
5550 PVMDKEXTENT pExtent = &pImage->pExtents[i];
5551 /* Compose new name for the extent. */
5552 apszNewName[i] = vmdkStrReplace(pExtent->pszFullname,
5553 pszOldFullName, pszNewFullName);
5554 if (!apszNewName[i])
5555 goto rollback;
5556 /* Close the extent file. */
5557 rc = vmdkFileClose(pImage, &pExtent->pFile, false);
5558 if (RT_FAILURE(rc))
5559 goto rollback;
5560
5561 /* Rename the extent file. */
5562 rc = vdIfIoIntFileMove(pImage->pIfIo, pExtent->pszFullname, apszNewName[i], 0);
5563 if (RT_FAILURE(rc))
5564 goto rollback;
5565 /* Remember the old name. */
5566 apszOldName[i] = RTStrDup(pExtent->pszFullname);
5567 }
5568 /* Release all old stuff. */
5569 rc = vmdkFreeImage(pImage, false);
5570 if (RT_FAILURE(rc))
5571 goto rollback;
5572
5573 fImageFreed = true;
5574
5575 /* Last elements of new/old name arrays are intended for
5576 * storing descriptor's names.
5577 */
5578 apszNewName[cExtents] = RTStrDup(pszFilename);
5579 /* Rename the descriptor file if it's separate. */
5580 if (!fEmbeddedDesc)
5581 {
5582 rc = vdIfIoIntFileMove(pImage->pIfIo, pImage->pszFilename, apszNewName[cExtents], 0);
5583 if (RT_FAILURE(rc))
5584 goto rollback;
5585 /* Save old name only if we may need to change it back. */
5586 apszOldName[cExtents] = RTStrDup(pszFilename);
5587 }
5588
5589 /* Update pImage with the new information. */
5590 pImage->pszFilename = pszFilename;
5591
5592 /* Open the new image. */
5593 rc = vmdkOpenImage(pImage, pImage->uOpenFlags);
5594 if (RT_SUCCESS(rc))
5595 goto out;
5596
5597rollback:
5598 /* Roll back all changes in case of failure. */
5599 if (RT_FAILURE(rc))
5600 {
5601 int rrc;
5602 if (!fImageFreed)
5603 {
5604 /*
5605 * Some extents may have been closed, close the rest. We will
5606 * re-open the whole thing later.
5607 */
5608 vmdkFreeImage(pImage, false);
5609 }
5610 /* Rename files back. */
5611 for (i = 0; i <= cExtents; i++)
5612 {
5613 if (apszOldName[i])
5614 {
5615 rrc = vdIfIoIntFileMove(pImage->pIfIo, apszNewName[i], apszOldName[i], 0);
5616 AssertRC(rrc);
5617 }
5618 }
5619 /* Restore the old descriptor. */
5620 PVMDKFILE pFile;
5621 rrc = vmdkFileOpen(pImage, &pFile, pszOldDescName,
5622 VDOpenFlagsToFileOpenFlags(VD_OPEN_FLAGS_NORMAL,
5623 false /* fCreate */));
5624 AssertRC(rrc);
5625 if (fEmbeddedDesc)
5626 {
5627 ExtentCopy.pFile = pFile;
5628 pImage->pExtents = &ExtentCopy;
5629 }
5630 else
5631 {
5632 /* Shouldn't be null for separate descriptor.
5633 * There will be no access to the actual content.
5634 */
5635 pImage->pDescData = pszOldDescName;
5636 pImage->pFile = pFile;
5637 }
5638 pImage->Descriptor = DescriptorCopy;
5639 vmdkWriteDescriptor(pImage, NULL);
5640 vmdkFileClose(pImage, &pFile, false);
5641 /* Get rid of the stuff we implanted. */
5642 pImage->pExtents = NULL;
5643 pImage->pFile = NULL;
5644 pImage->pDescData = NULL;
5645 /* Re-open the image back. */
5646 pImage->pszFilename = pszOldImageName;
5647 rrc = vmdkOpenImage(pImage, pImage->uOpenFlags);
5648 AssertRC(rrc);
5649 }
5650
5651out:
5652 for (i = 0; i < DescriptorCopy.cLines; i++)
5653 if (DescriptorCopy.aLines[i])
5654 RTStrFree(DescriptorCopy.aLines[i]);
5655 if (apszOldName)
5656 {
5657 for (i = 0; i <= cExtents; i++)
5658 if (apszOldName[i])
5659 RTStrFree(apszOldName[i]);
5660 RTMemTmpFree(apszOldName);
5661 }
5662 if (apszNewName)
5663 {
5664 for (i = 0; i <= cExtents; i++)
5665 if (apszNewName[i])
5666 RTStrFree(apszNewName[i]);
5667 RTMemTmpFree(apszNewName);
5668 }
5669 if (apszNewLines)
5670 {
5671 for (i = 0; i < cExtents; i++)
5672 if (apszNewLines[i])
5673 RTStrFree(apszNewLines[i]);
5674 RTMemTmpFree(apszNewLines);
5675 }
5676 if (pszOldDescName)
5677 RTStrFree(pszOldDescName);
5678 if (pszOldBaseName)
5679 RTStrFree(pszOldBaseName);
5680 if (pszNewBaseName)
5681 RTStrFree(pszNewBaseName);
5682 if (pszOldFullName)
5683 RTStrFree(pszOldFullName);
5684 if (pszNewFullName)
5685 RTStrFree(pszNewFullName);
5686 LogFlowFunc(("returns %Rrc\n", rc));
5687 return rc;
5688}
5689
5690/** @copydoc VBOXHDDBACKEND::pfnClose */
5691static DECLCALLBACK(int) vmdkClose(void *pBackendData, bool fDelete)
5692{
5693 LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
5694 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
5695 int rc;
5696
5697 rc = vmdkFreeImage(pImage, fDelete);
5698 RTMemFree(pImage);
5699
5700 LogFlowFunc(("returns %Rrc\n", rc));
5701 return rc;
5702}
5703
5704/** @copydoc VBOXHDDBACKEND::pfnRead */
5705static DECLCALLBACK(int) vmdkRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
5706 PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
5707{
5708 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToRead=%zu pcbActuallyRead=%#p\n",
5709 pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
5710 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
5711 PVMDKEXTENT pExtent;
5712 uint64_t uSectorExtentRel;
5713 uint64_t uSectorExtentAbs;
5714 int rc;
5715
5716 AssertPtr(pImage);
5717 Assert(uOffset % 512 == 0);
5718 Assert(cbToRead % 512 == 0);
5719
5720 if ( uOffset + cbToRead > pImage->cbSize
5721 || cbToRead == 0)
5722 {
5723 rc = VERR_INVALID_PARAMETER;
5724 goto out;
5725 }
5726
5727 rc = vmdkFindExtent(pImage, VMDK_BYTE2SECTOR(uOffset),
5728 &pExtent, &uSectorExtentRel);
5729 if (RT_FAILURE(rc))
5730 goto out;
5731
5732 /* Check access permissions as defined in the extent descriptor. */
5733 if (pExtent->enmAccess == VMDKACCESS_NOACCESS)
5734 {
5735 rc = VERR_VD_VMDK_INVALID_STATE;
5736 goto out;
5737 }
5738
5739 /* Clip read range to remain in this extent. */
5740 cbToRead = RT_MIN(cbToRead, VMDK_SECTOR2BYTE(pExtent->uSectorOffset + pExtent->cNominalSectors - uSectorExtentRel));
5741
5742 /* Handle the read according to the current extent type. */
5743 switch (pExtent->enmType)
5744 {
5745 case VMDKETYPE_HOSTED_SPARSE:
5746#ifdef VBOX_WITH_VMDK_ESX
5747 case VMDKETYPE_ESX_SPARSE:
5748#endif /* VBOX_WITH_VMDK_ESX */
5749 rc = vmdkGetSector(pImage, pIoCtx, pExtent, uSectorExtentRel, &uSectorExtentAbs);
5750 if (RT_FAILURE(rc))
5751 goto out;
5752 /* Clip read range to at most the rest of the grain. */
5753 cbToRead = RT_MIN(cbToRead, VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain - uSectorExtentRel % pExtent->cSectorsPerGrain));
5754 Assert(!(cbToRead % 512));
5755 if (uSectorExtentAbs == 0)
5756 {
5757 if ( !(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
5758 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
5759 || !(pImage->uOpenFlags & VD_OPEN_FLAGS_SEQUENTIAL))
5760 rc = VERR_VD_BLOCK_FREE;
5761 else
5762 rc = vmdkStreamReadSequential(pImage, pExtent,
5763 uSectorExtentRel,
5764 pIoCtx, cbToRead);
5765 }
5766 else
5767 {
5768 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
5769 {
5770 AssertMsg(vdIfIoIntIoCtxIsSynchronous(pImage->pIfIo, pIoCtx),
5771 ("Async I/O is not supported for stream optimized VMDK's\n"));
5772
5773 uint32_t uSectorInGrain = uSectorExtentRel % pExtent->cSectorsPerGrain;
5774 uSectorExtentAbs -= uSectorInGrain;
5775 if (pExtent->uGrainSectorAbs != uSectorExtentAbs)
5776 {
5777 uint64_t uLBA = 0; /* gcc maybe uninitialized */
5778 rc = vmdkFileInflateSync(pImage, pExtent,
5779 VMDK_SECTOR2BYTE(uSectorExtentAbs),
5780 pExtent->pvGrain,
5781 VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain),
5782 NULL, &uLBA, NULL);
5783 if (RT_FAILURE(rc))
5784 {
5785 pExtent->uGrainSectorAbs = 0;
5786 AssertRC(rc);
5787 goto out;
5788 }
5789 pExtent->uGrainSectorAbs = uSectorExtentAbs;
5790 pExtent->uGrain = uSectorExtentRel / pExtent->cSectorsPerGrain;
5791 Assert(uLBA == uSectorExtentRel);
5792 }
5793 vdIfIoIntIoCtxCopyTo(pImage->pIfIo, pIoCtx,
5794 (uint8_t *)pExtent->pvGrain
5795 + VMDK_SECTOR2BYTE(uSectorInGrain),
5796 cbToRead);
5797 }
5798 else
5799 rc = vdIfIoIntFileReadUser(pImage->pIfIo, pExtent->pFile->pStorage,
5800 VMDK_SECTOR2BYTE(uSectorExtentAbs),
5801 pIoCtx, cbToRead);
5802 }
5803 break;
5804 case VMDKETYPE_VMFS:
5805 case VMDKETYPE_FLAT:
5806 rc = vdIfIoIntFileReadUser(pImage->pIfIo, pExtent->pFile->pStorage,
5807 VMDK_SECTOR2BYTE(uSectorExtentRel),
5808 pIoCtx, cbToRead);
5809 break;
5810 case VMDKETYPE_ZERO:
5811 size_t cbSet;
5812
5813 cbSet = vdIfIoIntIoCtxSet(pImage->pIfIo, pIoCtx, 0, cbToRead);
5814 Assert(cbSet == cbToRead);
5815
5816 rc = VINF_SUCCESS;
5817 break;
5818 }
5819 if (pcbActuallyRead)
5820 *pcbActuallyRead = cbToRead;
5821
5822out:
5823 LogFlowFunc(("returns %Rrc\n", rc));
5824 return rc;
5825}
5826
5827/** @copydoc VBOXHDDBACKEND::pfnWrite */
5828static DECLCALLBACK(int) vmdkWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
5829 PVDIOCTX pIoCtx, size_t *pcbWriteProcess, size_t *pcbPreRead,
5830 size_t *pcbPostRead, unsigned fWrite)
5831{
5832 LogFlowFunc(("pBackendData=%#p uOffset=%llu pIoCtx=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n",
5833 pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
5834 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
5835 PVMDKEXTENT pExtent;
5836 uint64_t uSectorExtentRel;
5837 uint64_t uSectorExtentAbs;
5838 int rc;
5839
5840 AssertPtr(pImage);
5841 Assert(uOffset % 512 == 0);
5842 Assert(cbToWrite % 512 == 0);
5843
5844 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
5845 {
5846 rc = VERR_VD_IMAGE_READ_ONLY;
5847 goto out;
5848 }
5849
5850 if (cbToWrite == 0)
5851 {
5852 rc = VERR_INVALID_PARAMETER;
5853 goto out;
5854 }
5855
5856 /* No size check here, will do that later when the extent is located.
5857 * There are sparse images out there which according to the spec are
5858 * invalid, because the total size is not a multiple of the grain size.
5859 * Also for sparse images which are stitched together in odd ways (not at
5860 * grain boundaries, and with the nominal size not being a multiple of the
5861 * grain size), this would prevent writing to the last grain. */
5862
5863 rc = vmdkFindExtent(pImage, VMDK_BYTE2SECTOR(uOffset),
5864 &pExtent, &uSectorExtentRel);
5865 if (RT_FAILURE(rc))
5866 goto out;
5867
5868 /* Check access permissions as defined in the extent descriptor. */
5869 if ( pExtent->enmAccess != VMDKACCESS_READWRITE
5870 && ( !(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
5871 && !pImage->pExtents[0].uAppendPosition
5872 && pExtent->enmAccess != VMDKACCESS_READONLY))
5873 {
5874 rc = VERR_VD_VMDK_INVALID_STATE;
5875 goto out;
5876 }
5877
5878 /* Handle the write according to the current extent type. */
5879 switch (pExtent->enmType)
5880 {
5881 case VMDKETYPE_HOSTED_SPARSE:
5882#ifdef VBOX_WITH_VMDK_ESX
5883 case VMDKETYPE_ESX_SPARSE:
5884#endif /* VBOX_WITH_VMDK_ESX */
5885 rc = vmdkGetSector(pImage, pIoCtx, pExtent, uSectorExtentRel, &uSectorExtentAbs);
5886 if (RT_FAILURE(rc))
5887 goto out;
5888 /* Clip write range to at most the rest of the grain. */
5889 cbToWrite = RT_MIN(cbToWrite, VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain - uSectorExtentRel % pExtent->cSectorsPerGrain));
5890 if ( pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED
5891 && uSectorExtentRel < (uint64_t)pExtent->uLastGrainAccess * pExtent->cSectorsPerGrain)
5892 {
5893 rc = VERR_VD_VMDK_INVALID_WRITE;
5894 goto out;
5895 }
5896 if (uSectorExtentAbs == 0)
5897 {
5898 if (!(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED))
5899 {
5900 if (cbToWrite == VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain))
5901 {
5902 /* Full block write to a previously unallocated block.
5903 * Check if the caller wants to avoid the automatic alloc. */
5904 if (!(fWrite & VD_WRITE_NO_ALLOC))
5905 {
5906 /* Allocate GT and find out where to store the grain. */
5907 rc = vmdkAllocGrain(pImage, pExtent, pIoCtx,
5908 uSectorExtentRel, cbToWrite);
5909 }
5910 else
5911 rc = VERR_VD_BLOCK_FREE;
5912 *pcbPreRead = 0;
5913 *pcbPostRead = 0;
5914 }
5915 else
5916 {
5917 /* Clip write range to remain in this extent. */
5918 cbToWrite = RT_MIN(cbToWrite, VMDK_SECTOR2BYTE(pExtent->uSectorOffset + pExtent->cNominalSectors - uSectorExtentRel));
5919 *pcbPreRead = VMDK_SECTOR2BYTE(uSectorExtentRel % pExtent->cSectorsPerGrain);
5920 *pcbPostRead = VMDK_SECTOR2BYTE(pExtent->cSectorsPerGrain) - cbToWrite - *pcbPreRead;
5921 rc = VERR_VD_BLOCK_FREE;
5922 }
5923 }
5924 else
5925 {
5926 rc = vmdkStreamAllocGrain(pImage, pExtent,
5927 uSectorExtentRel,
5928 pIoCtx, cbToWrite);
5929 }
5930 }
5931 else
5932 {
5933 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
5934 {
5935 /* A partial write to a streamOptimized image is simply
5936 * invalid. It requires rewriting already compressed data
5937 * which is somewhere between expensive and impossible. */
5938 rc = VERR_VD_VMDK_INVALID_STATE;
5939 pExtent->uGrainSectorAbs = 0;
5940 AssertRC(rc);
5941 }
5942 else
5943 {
5944 Assert(!(pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED));
5945 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pExtent->pFile->pStorage,
5946 VMDK_SECTOR2BYTE(uSectorExtentAbs),
5947 pIoCtx, cbToWrite, NULL, NULL);
5948 }
5949 }
5950 break;
5951 case VMDKETYPE_VMFS:
5952 case VMDKETYPE_FLAT:
5953 /* Clip write range to remain in this extent. */
5954 cbToWrite = RT_MIN(cbToWrite, VMDK_SECTOR2BYTE(pExtent->uSectorOffset + pExtent->cNominalSectors - uSectorExtentRel));
5955 rc = vdIfIoIntFileWriteUser(pImage->pIfIo, pExtent->pFile->pStorage,
5956 VMDK_SECTOR2BYTE(uSectorExtentRel),
5957 pIoCtx, cbToWrite, NULL, NULL);
5958 break;
5959 case VMDKETYPE_ZERO:
5960 /* Clip write range to remain in this extent. */
5961 cbToWrite = RT_MIN(cbToWrite, VMDK_SECTOR2BYTE(pExtent->uSectorOffset + pExtent->cNominalSectors - uSectorExtentRel));
5962 break;
5963 }
5964
5965 if (pcbWriteProcess)
5966 *pcbWriteProcess = cbToWrite;
5967
5968out:
5969 LogFlowFunc(("returns %Rrc\n", rc));
5970 return rc;
5971}
5972
5973/** @copydoc VBOXHDDBACKEND::pfnFlush */
5974static DECLCALLBACK(int) vmdkFlush(void *pBackendData, PVDIOCTX pIoCtx)
5975{
5976 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
5977
5978 return vmdkFlushImage(pImage, pIoCtx);
5979}
5980
5981/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
5982static DECLCALLBACK(unsigned) vmdkGetVersion(void *pBackendData)
5983{
5984 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
5985 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
5986
5987 AssertPtr(pImage);
5988
5989 if (pImage)
5990 return VMDK_IMAGE_VERSION;
5991 else
5992 return 0;
5993}
5994
5995/** @copydoc VBOXHDDBACKEND::pfnGetSectorSize */
5996static DECLCALLBACK(uint32_t) vmdkGetSectorSize(void *pBackendData)
5997{
5998 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
5999 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6000
6001 AssertPtr(pImage);
6002
6003 if (pImage)
6004 return 512;
6005 else
6006 return 0;
6007}
6008
6009/** @copydoc VBOXHDDBACKEND::pfnGetSize */
6010static DECLCALLBACK(uint64_t) vmdkGetSize(void *pBackendData)
6011{
6012 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
6013 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6014
6015 AssertPtr(pImage);
6016
6017 if (pImage)
6018 return pImage->cbSize;
6019 else
6020 return 0;
6021}
6022
6023/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
6024static DECLCALLBACK(uint64_t) vmdkGetFileSize(void *pBackendData)
6025{
6026 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
6027 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6028 uint64_t cb = 0;
6029
6030 AssertPtr(pImage);
6031
6032 if (pImage)
6033 {
6034 uint64_t cbFile;
6035 if (pImage->pFile != NULL)
6036 {
6037 int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pFile->pStorage, &cbFile);
6038 if (RT_SUCCESS(rc))
6039 cb += cbFile;
6040 }
6041 for (unsigned i = 0; i < pImage->cExtents; i++)
6042 {
6043 if (pImage->pExtents[i].pFile != NULL)
6044 {
6045 int rc = vdIfIoIntFileGetSize(pImage->pIfIo, pImage->pExtents[i].pFile->pStorage, &cbFile);
6046 if (RT_SUCCESS(rc))
6047 cb += cbFile;
6048 }
6049 }
6050 }
6051
6052 LogFlowFunc(("returns %lld\n", cb));
6053 return cb;
6054}
6055
6056/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
6057static DECLCALLBACK(int) vmdkGetPCHSGeometry(void *pBackendData, PVDGEOMETRY pPCHSGeometry)
6058{
6059 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
6060 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6061 int rc;
6062
6063 AssertPtr(pImage);
6064
6065 if (pImage)
6066 {
6067 if (pImage->PCHSGeometry.cCylinders)
6068 {
6069 *pPCHSGeometry = pImage->PCHSGeometry;
6070 rc = VINF_SUCCESS;
6071 }
6072 else
6073 rc = VERR_VD_GEOMETRY_NOT_SET;
6074 }
6075 else
6076 rc = VERR_VD_NOT_OPENED;
6077
6078 LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
6079 return rc;
6080}
6081
6082/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
6083static DECLCALLBACK(int) vmdkSetPCHSGeometry(void *pBackendData, PCVDGEOMETRY pPCHSGeometry)
6084{
6085 LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
6086 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6087 int rc;
6088
6089 AssertPtr(pImage);
6090
6091 if (pImage)
6092 {
6093 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
6094 {
6095 rc = VERR_VD_IMAGE_READ_ONLY;
6096 goto out;
6097 }
6098 if (pImage->uOpenFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
6099 {
6100 rc = VERR_NOT_SUPPORTED;
6101 goto out;
6102 }
6103 rc = vmdkDescSetPCHSGeometry(pImage, pPCHSGeometry);
6104 if (RT_FAILURE(rc))
6105 goto out;
6106
6107 pImage->PCHSGeometry = *pPCHSGeometry;
6108 rc = VINF_SUCCESS;
6109 }
6110 else
6111 rc = VERR_VD_NOT_OPENED;
6112
6113out:
6114 LogFlowFunc(("returns %Rrc\n", rc));
6115 return rc;
6116}
6117
6118/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
6119static DECLCALLBACK(int) vmdkGetLCHSGeometry(void *pBackendData, PVDGEOMETRY pLCHSGeometry)
6120{
6121 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
6122 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6123 int rc;
6124
6125 AssertPtr(pImage);
6126
6127 if (pImage)
6128 {
6129 if (pImage->LCHSGeometry.cCylinders)
6130 {
6131 *pLCHSGeometry = pImage->LCHSGeometry;
6132 rc = VINF_SUCCESS;
6133 }
6134 else
6135 rc = VERR_VD_GEOMETRY_NOT_SET;
6136 }
6137 else
6138 rc = VERR_VD_NOT_OPENED;
6139
6140 LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
6141 return rc;
6142}
6143
6144/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
6145static DECLCALLBACK(int) vmdkSetLCHSGeometry(void *pBackendData, PCVDGEOMETRY pLCHSGeometry)
6146{
6147 LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
6148 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6149 int rc;
6150
6151 AssertPtr(pImage);
6152
6153 if (pImage)
6154 {
6155 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
6156 {
6157 rc = VERR_VD_IMAGE_READ_ONLY;
6158 goto out;
6159 }
6160 if (pImage->uOpenFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
6161 {
6162 rc = VERR_NOT_SUPPORTED;
6163 goto out;
6164 }
6165 rc = vmdkDescSetLCHSGeometry(pImage, pLCHSGeometry);
6166 if (RT_FAILURE(rc))
6167 goto out;
6168
6169 pImage->LCHSGeometry = *pLCHSGeometry;
6170 rc = VINF_SUCCESS;
6171 }
6172 else
6173 rc = VERR_VD_NOT_OPENED;
6174
6175out:
6176 LogFlowFunc(("returns %Rrc\n", rc));
6177 return rc;
6178}
6179
6180/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
6181static DECLCALLBACK(unsigned) vmdkGetImageFlags(void *pBackendData)
6182{
6183 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
6184 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6185 unsigned uImageFlags;
6186
6187 AssertPtr(pImage);
6188
6189 if (pImage)
6190 uImageFlags = pImage->uImageFlags;
6191 else
6192 uImageFlags = 0;
6193
6194 LogFlowFunc(("returns %#x\n", uImageFlags));
6195 return uImageFlags;
6196}
6197
6198/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
6199static DECLCALLBACK(unsigned) vmdkGetOpenFlags(void *pBackendData)
6200{
6201 LogFlowFunc(("pBackendData=%#p\n", pBackendData));
6202 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6203 unsigned uOpenFlags;
6204
6205 AssertPtr(pImage);
6206
6207 if (pImage)
6208 uOpenFlags = pImage->uOpenFlags;
6209 else
6210 uOpenFlags = 0;
6211
6212 LogFlowFunc(("returns %#x\n", uOpenFlags));
6213 return uOpenFlags;
6214}
6215
6216/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
6217static DECLCALLBACK(int) vmdkSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
6218{
6219 LogFlowFunc(("pBackendData=%#p uOpenFlags=%#x\n", pBackendData, uOpenFlags));
6220 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6221 int rc;
6222
6223 /* Image must be opened and the new flags must be valid. */
6224 if (!pImage || (uOpenFlags & ~( VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO
6225 | VD_OPEN_FLAGS_ASYNC_IO | VD_OPEN_FLAGS_SHAREABLE
6226 | VD_OPEN_FLAGS_SEQUENTIAL | VD_OPEN_FLAGS_SKIP_CONSISTENCY_CHECKS)))
6227 {
6228 rc = VERR_INVALID_PARAMETER;
6229 goto out;
6230 }
6231
6232 /* StreamOptimized images need special treatment: reopen is prohibited. */
6233 if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
6234 {
6235 if (pImage->uOpenFlags == uOpenFlags)
6236 rc = VINF_SUCCESS;
6237 else
6238 rc = VERR_INVALID_PARAMETER;
6239 }
6240 else
6241 {
6242 /* Implement this operation via reopening the image. */
6243 vmdkFreeImage(pImage, false);
6244 rc = vmdkOpenImage(pImage, uOpenFlags);
6245 }
6246
6247out:
6248 LogFlowFunc(("returns %Rrc\n", rc));
6249 return rc;
6250}
6251
6252/** @copydoc VBOXHDDBACKEND::pfnGetComment */
6253static DECLCALLBACK(int) vmdkGetComment(void *pBackendData, char *pszComment,
6254 size_t cbComment)
6255{
6256 LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
6257 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6258 int rc;
6259
6260 AssertPtr(pImage);
6261
6262 if (pImage)
6263 {
6264 char *pszCommentEncoded = NULL;
6265 rc = vmdkDescDDBGetStr(pImage, &pImage->Descriptor,
6266 "ddb.comment", &pszCommentEncoded);
6267 if (rc == VERR_VD_VMDK_VALUE_NOT_FOUND)
6268 pszCommentEncoded = NULL;
6269 else if (RT_FAILURE(rc))
6270 goto out;
6271
6272 if (pszComment && pszCommentEncoded)
6273 rc = vmdkDecodeString(pszCommentEncoded, pszComment, cbComment);
6274 else
6275 {
6276 if (pszComment)
6277 *pszComment = '\0';
6278 rc = VINF_SUCCESS;
6279 }
6280 RTMemTmpFree(pszCommentEncoded);
6281 }
6282 else
6283 rc = VERR_VD_NOT_OPENED;
6284
6285out:
6286 LogFlowFunc(("returns %Rrc comment='%s'\n", rc, pszComment));
6287 return rc;
6288}
6289
6290/** @copydoc VBOXHDDBACKEND::pfnSetComment */
6291static DECLCALLBACK(int) vmdkSetComment(void *pBackendData, const char *pszComment)
6292{
6293 LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
6294 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6295 int rc;
6296
6297 AssertPtr(pImage);
6298
6299 if (pImage)
6300 {
6301 if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
6302 {
6303 rc = VERR_VD_IMAGE_READ_ONLY;
6304 goto out;
6305 }
6306 if (pImage->uOpenFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
6307 {
6308 rc = VERR_NOT_SUPPORTED;
6309 goto out;
6310 }
6311
6312 rc = vmdkSetImageComment(pImage, pszComment);
6313 }
6314 else
6315 rc = VERR_VD_NOT_OPENED;
6316
6317out:
6318 LogFlowFunc(("returns %Rrc\n", rc));
6319 return rc;
6320}
6321
6322/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
6323static DECLCALLBACK(int) vmdkGetUuid(void *pBackendData, PRTUUID pUuid)
6324{
6325 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
6326 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6327 int rc;
6328
6329 AssertPtr(pImage);
6330
6331 if (pImage)
6332 {
6333 *pUuid = pImage->ImageUuid;
6334 rc = VINF_SUCCESS;
6335 }
6336 else
6337 rc = VERR_VD_NOT_OPENED;
6338
6339 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
6340 return rc;
6341}
6342
6343/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
6344static DECLCALLBACK(int) vmdkSetUuid(void *pBackendData, PCRTUUID pUuid)
6345{
6346 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
6347 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6348 int rc;
6349
6350 LogFlowFunc(("%RTuuid\n", pUuid));
6351 AssertPtr(pImage);
6352
6353 if (pImage)
6354 {
6355 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
6356 {
6357 if (!(pImage->uOpenFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED))
6358 {
6359 pImage->ImageUuid = *pUuid;
6360 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
6361 VMDK_DDB_IMAGE_UUID, pUuid);
6362 if (RT_FAILURE(rc))
6363 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing image UUID in descriptor in '%s'"), pImage->pszFilename);
6364 rc = VINF_SUCCESS;
6365 }
6366 else
6367 rc = VERR_NOT_SUPPORTED;
6368 }
6369 else
6370 rc = VERR_VD_IMAGE_READ_ONLY;
6371 }
6372 else
6373 rc = VERR_VD_NOT_OPENED;
6374
6375 LogFlowFunc(("returns %Rrc\n", rc));
6376 return rc;
6377}
6378
6379/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
6380static DECLCALLBACK(int) vmdkGetModificationUuid(void *pBackendData, PRTUUID pUuid)
6381{
6382 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
6383 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6384 int rc;
6385
6386 AssertPtr(pImage);
6387
6388 if (pImage)
6389 {
6390 *pUuid = pImage->ModificationUuid;
6391 rc = VINF_SUCCESS;
6392 }
6393 else
6394 rc = VERR_VD_NOT_OPENED;
6395
6396 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
6397 return rc;
6398}
6399
6400/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
6401static DECLCALLBACK(int) vmdkSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
6402{
6403 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
6404 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6405 int rc;
6406
6407 AssertPtr(pImage);
6408
6409 if (pImage)
6410 {
6411 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
6412 {
6413 if (!(pImage->uOpenFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED))
6414 {
6415 /* Only touch the modification uuid if it changed. */
6416 if (RTUuidCompare(&pImage->ModificationUuid, pUuid))
6417 {
6418 pImage->ModificationUuid = *pUuid;
6419 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
6420 VMDK_DDB_MODIFICATION_UUID, pUuid);
6421 if (RT_FAILURE(rc))
6422 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing modification UUID in descriptor in '%s'"), pImage->pszFilename);
6423 }
6424 rc = VINF_SUCCESS;
6425 }
6426 else
6427 rc = VERR_NOT_SUPPORTED;
6428 }
6429 else
6430 rc = VERR_VD_IMAGE_READ_ONLY;
6431 }
6432 else
6433 rc = VERR_VD_NOT_OPENED;
6434
6435 LogFlowFunc(("returns %Rrc\n", rc));
6436 return rc;
6437}
6438
6439/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
6440static DECLCALLBACK(int) vmdkGetParentUuid(void *pBackendData, PRTUUID pUuid)
6441{
6442 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
6443 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6444 int rc;
6445
6446 AssertPtr(pImage);
6447
6448 if (pImage)
6449 {
6450 *pUuid = pImage->ParentUuid;
6451 rc = VINF_SUCCESS;
6452 }
6453 else
6454 rc = VERR_VD_NOT_OPENED;
6455
6456 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
6457 return rc;
6458}
6459
6460/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
6461static DECLCALLBACK(int) vmdkSetParentUuid(void *pBackendData, PCRTUUID pUuid)
6462{
6463 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
6464 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6465 int rc;
6466
6467 AssertPtr(pImage);
6468
6469 if (pImage)
6470 {
6471 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
6472 {
6473 if (!(pImage->uOpenFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED))
6474 {
6475 pImage->ParentUuid = *pUuid;
6476 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
6477 VMDK_DDB_PARENT_UUID, pUuid);
6478 if (RT_FAILURE(rc))
6479 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing parent image UUID in descriptor in '%s'"), pImage->pszFilename);
6480 rc = VINF_SUCCESS;
6481 }
6482 else
6483 rc = VERR_NOT_SUPPORTED;
6484 }
6485 else
6486 rc = VERR_VD_IMAGE_READ_ONLY;
6487 }
6488 else
6489 rc = VERR_VD_NOT_OPENED;
6490
6491 LogFlowFunc(("returns %Rrc\n", rc));
6492 return rc;
6493}
6494
6495/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
6496static DECLCALLBACK(int) vmdkGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
6497{
6498 LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
6499 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6500 int rc;
6501
6502 AssertPtr(pImage);
6503
6504 if (pImage)
6505 {
6506 *pUuid = pImage->ParentModificationUuid;
6507 rc = VINF_SUCCESS;
6508 }
6509 else
6510 rc = VERR_VD_NOT_OPENED;
6511
6512 LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
6513 return rc;
6514}
6515
6516/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
6517static DECLCALLBACK(int) vmdkSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
6518{
6519 LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
6520 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6521 int rc;
6522
6523 AssertPtr(pImage);
6524
6525 if (pImage)
6526 {
6527 if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
6528 {
6529 if (!(pImage->uOpenFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED))
6530 {
6531 pImage->ParentModificationUuid = *pUuid;
6532 rc = vmdkDescDDBSetUuid(pImage, &pImage->Descriptor,
6533 VMDK_DDB_PARENT_MODIFICATION_UUID, pUuid);
6534 if (RT_FAILURE(rc))
6535 return vdIfError(pImage->pIfError, rc, RT_SRC_POS, N_("VMDK: error storing parent image UUID in descriptor in '%s'"), pImage->pszFilename);
6536 rc = VINF_SUCCESS;
6537 }
6538 else
6539 rc = VERR_NOT_SUPPORTED;
6540 }
6541 else
6542 rc = VERR_VD_IMAGE_READ_ONLY;
6543 }
6544 else
6545 rc = VERR_VD_NOT_OPENED;
6546
6547 LogFlowFunc(("returns %Rrc\n", rc));
6548 return rc;
6549}
6550
6551/** @copydoc VBOXHDDBACKEND::pfnDump */
6552static DECLCALLBACK(void) vmdkDump(void *pBackendData)
6553{
6554 PVMDKIMAGE pImage = (PVMDKIMAGE)pBackendData;
6555
6556 AssertPtr(pImage);
6557 if (pImage)
6558 {
6559 vdIfErrorMessage(pImage->pIfError, "Header: Geometry PCHS=%u/%u/%u LCHS=%u/%u/%u cbSector=%llu\n",
6560 pImage->PCHSGeometry.cCylinders, pImage->PCHSGeometry.cHeads, pImage->PCHSGeometry.cSectors,
6561 pImage->LCHSGeometry.cCylinders, pImage->LCHSGeometry.cHeads, pImage->LCHSGeometry.cSectors,
6562 VMDK_BYTE2SECTOR(pImage->cbSize));
6563 vdIfErrorMessage(pImage->pIfError, "Header: uuidCreation={%RTuuid}\n", &pImage->ImageUuid);
6564 vdIfErrorMessage(pImage->pIfError, "Header: uuidModification={%RTuuid}\n", &pImage->ModificationUuid);
6565 vdIfErrorMessage(pImage->pIfError, "Header: uuidParent={%RTuuid}\n", &pImage->ParentUuid);
6566 vdIfErrorMessage(pImage->pIfError, "Header: uuidParentModification={%RTuuid}\n", &pImage->ParentModificationUuid);
6567 }
6568}
6569
6570
6571
6572const VBOXHDDBACKEND g_VmdkBackend =
6573{
6574 /* pszBackendName */
6575 "VMDK",
6576 /* cbSize */
6577 sizeof(VBOXHDDBACKEND),
6578 /* uBackendCaps */
6579 VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
6580 | VD_CAP_CREATE_SPLIT_2G | VD_CAP_DIFF | VD_CAP_FILE | VD_CAP_ASYNC
6581 | VD_CAP_VFS | VD_CAP_PREFERRED,
6582 /* paFileExtensions */
6583 s_aVmdkFileExtensions,
6584 /* paConfigInfo */
6585 NULL,
6586 /* pfnCheckIfValid */
6587 vmdkCheckIfValid,
6588 /* pfnOpen */
6589 vmdkOpen,
6590 /* pfnCreate */
6591 vmdkCreate,
6592 /* pfnRename */
6593 vmdkRename,
6594 /* pfnClose */
6595 vmdkClose,
6596 /* pfnRead */
6597 vmdkRead,
6598 /* pfnWrite */
6599 vmdkWrite,
6600 /* pfnFlush */
6601 vmdkFlush,
6602 /* pfnDiscard */
6603 NULL,
6604 /* pfnGetVersion */
6605 vmdkGetVersion,
6606 /* pfnGetSectorSize */
6607 vmdkGetSectorSize,
6608 /* pfnGetSize */
6609 vmdkGetSize,
6610 /* pfnGetFileSize */
6611 vmdkGetFileSize,
6612 /* pfnGetPCHSGeometry */
6613 vmdkGetPCHSGeometry,
6614 /* pfnSetPCHSGeometry */
6615 vmdkSetPCHSGeometry,
6616 /* pfnGetLCHSGeometry */
6617 vmdkGetLCHSGeometry,
6618 /* pfnSetLCHSGeometry */
6619 vmdkSetLCHSGeometry,
6620 /* pfnGetImageFlags */
6621 vmdkGetImageFlags,
6622 /* pfnGetOpenFlags */
6623 vmdkGetOpenFlags,
6624 /* pfnSetOpenFlags */
6625 vmdkSetOpenFlags,
6626 /* pfnGetComment */
6627 vmdkGetComment,
6628 /* pfnSetComment */
6629 vmdkSetComment,
6630 /* pfnGetUuid */
6631 vmdkGetUuid,
6632 /* pfnSetUuid */
6633 vmdkSetUuid,
6634 /* pfnGetModificationUuid */
6635 vmdkGetModificationUuid,
6636 /* pfnSetModificationUuid */
6637 vmdkSetModificationUuid,
6638 /* pfnGetParentUuid */
6639 vmdkGetParentUuid,
6640 /* pfnSetParentUuid */
6641 vmdkSetParentUuid,
6642 /* pfnGetParentModificationUuid */
6643 vmdkGetParentModificationUuid,
6644 /* pfnSetParentModificationUuid */
6645 vmdkSetParentModificationUuid,
6646 /* pfnDump */
6647 vmdkDump,
6648 /* pfnGetTimestamp */
6649 NULL,
6650 /* pfnGetParentTimestamp */
6651 NULL,
6652 /* pfnSetParentTimestamp */
6653 NULL,
6654 /* pfnGetParentFilename */
6655 NULL,
6656 /* pfnSetParentFilename */
6657 NULL,
6658 /* pfnComposeLocation */
6659 genericFileComposeLocation,
6660 /* pfnComposeName */
6661 genericFileComposeName,
6662 /* pfnCompact */
6663 NULL,
6664 /* pfnResize */
6665 NULL,
6666 /* pfnRepair */
6667 NULL,
6668 /* pfnTraverseMetadata */
6669 NULL
6670};
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