Changeset 18067 in vbox for trunk/src/VBox/Devices

Timestamp:

Mar 18, 2009 2:17:49 PM (16 years ago)

Author:

vboxsync

Message:

Storage/VMDK: fix crash when create failed (recent regression), additionally fix dealing with streamOptimized VMDK files having a footer

File:

• trunk/src/VBox/Devices/Storage/VmdkHDDCore.cpp (modified) (16 diffs)

trunk/src/VBox/Devices/Storage/VmdkHDDCore.cpp

@@ -304 +304 @@
     /** Flag whether the metadata in the extent header needs to be updated. */
     bool        fMetaDirty;
+    /** Flag whether there is a footer in this extent. */
+    bool        fFooter;
     /** Compression type for this extent. */
     uint16_t    uCompression;
@@ -2460 +2462 @@
         &&  RT_LE2H_U64(Header.gdOffset) == VMDK_GD_AT_END)
     {
-        /* Extent with markers. Use this as criteria to read the footer, as
-         * the spec is as usual totally fuzzy what the criteria really is. */
+        /* Read the footer, which isn't compressed and comes before the
+         * end-of-stream marker. This is bending the VMDK 1.1 spec, but that's
+         * VMware reality. Theory and practice have very little in common. */
         uint64_t cbSize;
         rc = vmdkFileGetSize(pExtent->pFile, &cbSize);
@@ -2471 +2474 @@
         }
         cbSize = RT_ALIGN_64(cbSize, 512);
-        rc = vmdkFileInflateAt(pExtent->pFile, cbSize - 2 * 512, &Header, sizeof(Header), VMDK_MARKER_FOOTER, NULL, NULL);
+        rc = vmdkFileReadAt(pExtent->pFile, cbSize - 2*512, &Header, sizeof(Header), NULL);
         AssertRC(rc);
         if (RT_FAILURE(rc))
@@ -2481 +2484 @@
         if (RT_FAILURE(rc))
             goto out;
+        pExtent->fFooter = true;
     }
     pExtent->uVersion = RT_LE2H_U32(Header.version);
@@ -2600 +2604 @@
  * Internal: write/update the metadata for a sparse extent.
  */
-static int vmdkWriteMetaSparseExtent(PVMDKEXTENT pExtent)
+static int vmdkWriteMetaSparseExtent(PVMDKEXTENT pExtent, uint64_t uOffset)
 {
     SparseExtentHeader Header;
@@ -2606 +2610 @@
     memset(&Header, '\0', sizeof(Header));
     Header.magicNumber = RT_H2LE_U32(VMDK_SPARSE_MAGICNUMBER);
-    Header.version = RT_H2LE_U32(1);
+    Header.version = RT_H2LE_U32(pExtent->uVersion);
     Header.flags = RT_H2LE_U32(RT_BIT(0));
     if (pExtent->pRGD)
@@ -2617 +2621 @@
     Header.descriptorSize = RT_H2LE_U64(pExtent->cDescriptorSectors);
     Header.numGTEsPerGT = RT_H2LE_U32(pExtent->cGTEntries);
-    if (pExtent->pRGD)
-    {
-        Assert(pExtent->uSectorRGD);
-        Header.rgdOffset = RT_H2LE_U64(pExtent->uSectorRGD);
-        Header.gdOffset = RT_H2LE_U64(pExtent->uSectorGD);
+    if (pExtent->fFooter && uOffset == 0)
+    {
+        if (pExtent->pRGD)
+        {
+            Assert(pExtent->uSectorRGD);
+            Header.rgdOffset = RT_H2LE_U64(VMDK_GD_AT_END);
+            Header.gdOffset = RT_H2LE_U64(VMDK_GD_AT_END);
+        }
+        else
+        {
+            Header.gdOffset = RT_H2LE_U64(VMDK_GD_AT_END);
+        }
     }
     else
     {
-        Header.gdOffset = RT_H2LE_U64(pExtent->uSectorGD);
+        if (pExtent->pRGD)
+        {
+            Assert(pExtent->uSectorRGD);
+            Header.rgdOffset = RT_H2LE_U64(pExtent->uSectorRGD);
+            Header.gdOffset = RT_H2LE_U64(pExtent->uSectorGD);
+        }
+        else
+        {
+            Header.gdOffset = RT_H2LE_U64(pExtent->uSectorGD);
+        }
     }
     Header.overHead = RT_H2LE_U64(pExtent->cOverheadSectors);
@@ -2635 +2655 @@
     Header.compressAlgorithm = RT_H2LE_U16(pExtent->uCompression);
 
-    int rc = vmdkFileWriteAt(pExtent->pFile, 0, &Header, sizeof(Header), NULL);
+    int rc = vmdkFileWriteAt(pExtent->pFile, uOffset, &Header, sizeof(Header), NULL);
     AssertRC(rc);
     if (RT_FAILURE(rc))
@@ -3562 +3582 @@
             cSectorsPerGD = (pExtent->cGDEntries + (512 / sizeof(uint32_t) - 1)) / (512 / sizeof(uint32_t));
             if (pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
+            {
+                /* The spec says version is 1 for all VMDKs, but the vast
+                 * majority of streamOptimized VMDKs actually contain
+                 * version 3 - so go with the majority. Both are acepted. */
+                pExtent->uVersion = 3;
                 pExtent->uCompression = VMDK_COMPRESSION_DEFLATE;
+            }
         }
         else
@@ -3821 +3847 @@
         }
     }
-    (void)vmdkFlushImage(pImage);
+    /* Don't attempt to flush the image if there is no file - usually happens
+     * when creating fails for whatever reason. */
+    if (pImage->pFile != NULL)
+        (void)vmdkFlushImage(pImage);
 
     if (pImage->pExtents != NULL)
@@ -3870 +3899 @@
             {
                 case VMDKETYPE_HOSTED_SPARSE:
-                    rc = vmdkWriteMetaSparseExtent(pExtent);
+                    rc = vmdkWriteMetaSparseExtent(pExtent, 0);
                     if (RT_FAILURE(rc))
                         goto out;
+                    if (pExtent->fFooter)
+                    {
+                        uint64_t cbSize;
+                        rc = vmdkFileGetSize(pExtent->pFile, &cbSize);
+                        if (RT_FAILURE(rc))
+                            goto out;
+                        cbSize = RT_ALIGN_64(cbSize, 512);
+                        rc = vmdkWriteMetaSparseExtent(pExtent, cbSize - 2*512);
+                        if (RT_FAILURE(rc))
+                            goto out;
+                    }
                     break;
 #ifdef VBOX_WITH_VMDK_ESX
@@ -4042 +4082 @@
         uGTSector = VMDK_BYTE2SECTOR(cbExtentSize);
         /* For writable streamOptimized extents the final sector is the
-         * end-of-stream marker. Will be re-added after the grain table. */
+         * end-of-stream marker. Will be re-added after the grain table.
+         * If the file has a footer it also will be re-added before EOS. */
         if (pExtent->pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
         {
+            uint64_t uEOSOff = 0;
             uGTSector--;
+            if (pExtent->fFooter)
+            {
+                uGTSector--;
+                uEOSOff = 512;
+                rc = vmdkWriteMetaSparseExtent(pExtent, VMDK_SECTOR2BYTE(uGTSector) + pExtent->cGTEntries * sizeof(uint32_t));
+                if (RT_FAILURE(rc))
+                    return vmdkError(pExtent->pImage, rc, RT_SRC_POS, N_("VMDK: cannot write footer after grain table in '%s'"), pExtent->pszFullname);
+            }
             pExtent->uLastGrainSector = 0;
             uint8_t aEOS[512];
             memset(aEOS, '\0', sizeof(aEOS));
             rc = vmdkFileWriteAt(pExtent->pFile,
-                                 VMDK_SECTOR2BYTE(uGTSector) + pExtent->cGTEntries * sizeof(uint32_t),
+                                 VMDK_SECTOR2BYTE(uGTSector) + pExtent->cGTEntries * sizeof(uint32_t) + uEOSOff,
                                  aEOS, sizeof(aEOS), NULL);
             if (RT_FAILURE(rc))
@@ -4084 +4134 @@
             uRGTSector = VMDK_BYTE2SECTOR(cbExtentSize);
             /* For writable streamOptimized extents the final sector is the
-             * end-of-stream marker. Will be re-added after the grain table. */
+             * end-of-stream marker. Will be re-added after the grain table.
+             * If the file has a footer it also will be re-added before EOS. */
             if (pExtent->pImage->uImageFlags & VD_VMDK_IMAGE_FLAGS_STREAM_OPTIMIZED)
             {
+                uint64_t uEOSOff = 0;
                 uRGTSector--;
+                if (pExtent->fFooter)
+                {
+                    uRGTSector--;
+                    uEOSOff = 512;
+                    rc = vmdkWriteMetaSparseExtent(pExtent, VMDK_SECTOR2BYTE(uRGTSector) + pExtent->cGTEntries * sizeof(uint32_t));
+                    if (RT_FAILURE(rc))
+                        return vmdkError(pExtent->pImage, rc, RT_SRC_POS, N_("VMDK: cannot write footer after redundant grain table in '%s'"), pExtent->pszFullname);
+                }
                 pExtent->uLastGrainSector = 0;
                 uint8_t aEOS[512];
                 memset(aEOS, '\0', sizeof(aEOS));
                 rc = vmdkFileWriteAt(pExtent->pFile,
-                                     VMDK_SECTOR2BYTE(uRGTSector) + pExtent->cGTEntries * sizeof(uint32_t),
+                                     VMDK_SECTOR2BYTE(uRGTSector) + pExtent->cGTEntries * sizeof(uint32_t) + uEOSOff,
                                      aEOS, sizeof(aEOS), NULL);
                 if (RT_FAILURE(rc))
@@ -4157 +4217 @@
          * Additionally the end-of-stream marker needs to be written. */
         if (!pExtent->uLastGrainSector)
+        {
             cbExtentSize -= 512;
+            if (pExtent->fFooter)
+                cbExtentSize -= 512;
+        }
         else
             cbExtentSize = VMDK_SECTOR2BYTE(pExtent->uLastGrainSector) + pExtent->cbLastGrainWritten;
@@ -4178 +4242 @@
         pExtent->uGrainSector = uSector;
 
+        uint64_t uEOSOff = 0;
+        if (pExtent->fFooter)
+        {
+            uEOSOff = 512;
+            rc = vmdkWriteMetaSparseExtent(pExtent, cbExtentSize + RT_ALIGN(cbGrain, 512));
+            if (RT_FAILURE(rc))
+                return vmdkError(pExtent->pImage, rc, RT_SRC_POS, N_("VMDK: cannot write footer after allocated data block in '%s'"), pExtent->pszFullname);
+        }
         uint8_t aEOS[512];
         memset(aEOS, '\0', sizeof(aEOS));
-        rc = vmdkFileWriteAt(pExtent->pFile, cbExtentSize + RT_ALIGN(cbGrain, 512),
+        rc = vmdkFileWriteAt(pExtent->pFile, cbExtentSize + RT_ALIGN(cbGrain, 512) + uEOSOff,
                              aEOS, sizeof(aEOS), NULL);
         if (RT_FAILURE(rc))
@@ -4957 +5029 @@
                     pExtent->cbLastGrainWritten = cbGrain;
 
+                    uint64_t uEOSOff = 0;
+                    if (pExtent->fFooter)
+                    {
+                        uEOSOff = 512;
+                        rc = vmdkWriteMetaSparseExtent(pExtent, VMDK_SECTOR2BYTE(uSectorExtentAbs) + RT_ALIGN(cbGrain, 512));
+                        if (RT_FAILURE(rc))
+                            return vmdkError(pExtent->pImage, rc, RT_SRC_POS, N_("VMDK: cannot write footer after data block in '%s'"), pExtent->pszFullname);
+                    }
                     uint8_t aEOS[512];
                     memset(aEOS, '\0', sizeof(aEOS));
                     rc = vmdkFileWriteAt(pExtent->pFile,
-                                         VMDK_SECTOR2BYTE(uSectorExtentAbs) + RT_ALIGN(cbGrain, 512),
+                                         VMDK_SECTOR2BYTE(uSectorExtentAbs) + RT_ALIGN(cbGrain, 512) + uEOSOff,
                                          aEOS, sizeof(aEOS), NULL);
                     if (RT_FAILURE(rc))