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

Timestamp:

Sep 9, 2008 3:51:08 PM (16 years ago)

Author:

vboxsync

Message:

Storage/VMDK: make it understand the really odd vmdk variant used by haiku. Their images are still broken (one byte too short), and I don't want to ignore truncated images.

File:

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

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

@@ -77 +77 @@
 /**
  * Magic number for hosted images created by VMware Workstation 4, VMware
- * Workstation 5, VMware Server or VMware Player.
+ * Workstation 5, VMware Server or VMware Player. Not necessarily sparse.
  */
 #define VMDK_SPARSE_MAGICNUMBER 0x564d444b /* 'V' 'M' 'D' 'K' */
 
-/** VMDK hosted sparse extent header. */
+/**
+ * VMDK hosted binary extent header. The "Sparse" is a total misnomer, as
+ * this header is also used for monolithic flat images.
+ */
 #pragma pack(1)
 typedef struct SparseExtentHeader
@@ -784 +787 @@
     size_t cbGD = pExtent->cGDEntries * sizeof(uint32_t);
 
+    if (pExtent->enmType != VMDKETYPE_HOSTED_SPARSE)
+        goto out;
+
     pGD = (uint32_t *)RTMemAllocZ(cbGD);
     if (!pGD)
@@ -1453 +1459 @@
     pDescriptor->aLines[cLine] = pTmp;
 
-    if (strcmp(pDescriptor->aLines[0], "# Disk DescriptorFile"))
+    if (    strcmp(pDescriptor->aLines[0], "# Disk DescriptorFile")
+        &&  strcmp(pDescriptor->aLines[0], "# Disk Descriptor File"))
     {
         rc = vmdkError(pImage, VERR_VDI_INVALID_HEADER, RT_SRC_POS, N_("VMDK: descriptor does not start as expected in '%s'"), pImage->pszFilename);
@@ -2016 +2023 @@
 
 /**
- * Internal: read metadata belonging to a sparse extent.
+ * Internal: read metadata belonging to an extent with binary header, i.e.
+ * as found in monolithic files.
  */
-static int vmdkReadMetaSparseExtent(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
+static int vmdkReadBinaryMetaExtent(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
 {
     SparseExtentHeader Header;
-    uint64_t cbExtentSize, cSectorsPerGDE;
+    uint64_t cSectorsPerGDE;
 
     int rc = vmdkFileReadAt(pExtent->pFile, 0, &Header, sizeof(Header), NULL);
@@ -2034 +2042 @@
     {
         rc = vmdkError(pExtent->pImage, VERR_VDI_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect magic/version in extent header in '%s'"), pExtent->pszFullname);
-        goto out;
-    }
-    /* The image must be a multiple of a sector in size. If not, it means the
-     * image is at least truncated, or even seriously garbled. */
-    rc = vmdkFileGetSize(pExtent->pFile, &cbExtentSize);
-    if (RT_FAILURE(rc))
-    {
-        rc = vmdkError(pExtent->pImage, rc, RT_SRC_POS, N_("VMDK: error getting size in '%s'"), pExtent->pszFullname);
         goto out;
     }
@@ -2053 +2053 @@
         goto out;
     }
-    pExtent->enmType = VMDKETYPE_HOSTED_SPARSE;
+    pExtent->enmType = VMDKETYPE_HOSTED_SPARSE; /* Just dummy value, changed later. */
     pExtent->cSectors = RT_LE2H_U64(Header.capacity);
     pExtent->cSectorsPerGrain = RT_LE2H_U64(Header.grainSize);
+    pExtent->uDescriptorSector = RT_LE2H_U64(Header.descriptorOffset);
+    pExtent->cDescriptorSectors = RT_LE2H_U64(Header.descriptorSize);
+    if (pExtent->uDescriptorSector && !pExtent->cDescriptorSectors)
+    {
+        rc = vmdkError(pExtent->pImage, VERR_VDI_INVALID_HEADER, RT_SRC_POS, N_("VMDK: inconsistent embedded descriptor config in '%s'"), pExtent->pszFullname);
+        goto out;
+    }
+    pExtent->cGTEntries = RT_LE2H_U32(Header.numGTEsPerGT);
+    if (RT_LE2H_U32(Header.flags) & 2)
+    {
+        pExtent->uSectorRGD = RT_LE2H_U64(Header.rgdOffset);
+        pExtent->uSectorGD = RT_LE2H_U64(Header.gdOffset);
+    }
+    else
+    {
+        /** @todo this is just guesswork, the spec doesn't document this
+         * properly and I don't have a vmdk without RGD. */
+        pExtent->uSectorGD = RT_LE2H_U64(Header.rgdOffset);
+        pExtent->uSectorRGD = 0;
+    }
+    pExtent->cOverheadSectors = RT_LE2H_U64(Header.overHead);
+    pExtent->fUncleanShutdown = !!Header.uncleanShutdown;
+    cSectorsPerGDE = pExtent->cGTEntries * pExtent->cSectorsPerGrain;
+    if (!cSectorsPerGDE || cSectorsPerGDE > UINT32_MAX)
+    {
+        rc = vmdkError(pExtent->pImage, VERR_VDI_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect grain directory size in '%s'"), pExtent->pszFullname);
+        goto out;
+    }
+    pExtent->cSectorsPerGDE = cSectorsPerGDE;
+    pExtent->cGDEntries = (pExtent->cSectors + cSectorsPerGDE - 1) / cSectorsPerGDE;
+
+    /* Fix up the number of descriptor sectors, as some flat images have
+     * really just one, and this causes failures when inserting the UUID
+     * values and other extra information. */
+    if (pExtent->cDescriptorSectors != 0 && pExtent->cDescriptorSectors < 4)
+    {
+        /* Do it the easy way - just fix it for flat images which have no
+         * other complicated metadata which needs space too. */
+        if (    pExtent->uDescriptorSector + 4 < pExtent->cOverheadSectors
+            &&  pExtent->cGTEntries * pExtent->cGDEntries == 0)
+            pExtent->cDescriptorSectors = 4;
+    }
+
+out:
+    if (RT_FAILURE(rc))
+        vmdkFreeExtentData(pImage, pExtent, false);
+
+    return rc;
+}
+
+/**
+ * Internal: read additional metadata belonging to an extent. For those
+ * extents which have no additional metadata just verify the information.
+ */
+static int vmdkReadMetaExtent(PVMDKIMAGE pImage, PVMDKEXTENT pExtent)
+{
+    int rc = VINF_SUCCESS;
+    uint64_t cbExtentSize;
+
+    /* The image must be a multiple of a sector in size and contain the data
+     * area (flat images only). If not, it means the image is at least
+     * truncated, or even seriously garbled. */
+    rc = vmdkFileGetSize(pExtent->pFile, &cbExtentSize);
+    if (RT_FAILURE(rc))
+    {
+        rc = vmdkError(pExtent->pImage, rc, RT_SRC_POS, N_("VMDK: error getting size in '%s'"), pExtent->pszFullname);
+        goto out;
+    }
+    if (    cbExtentSize != RT_ALIGN_64(cbExtentSize, 512)
+        &&  (pExtent->enmType != VMDKETYPE_FLAT || pExtent->cNominalSectors + pExtent->uSectorOffset > VMDK_BYTE2SECTOR(cbExtentSize)))
+    {
+        rc = vmdkError(pExtent->pImage, VERR_VDI_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);
+        goto out;
+    }
+    if (pExtent->enmType == VMDKETYPE_HOSTED_SPARSE)
+        goto out;
+
     /* The spec says that this must be a power of two and greater than 8,
      * but probably they meant not less than 8. */
@@ -2064 +2141 @@
         goto out;
     }
-    pExtent->uDescriptorSector = RT_LE2H_U64(Header.descriptorOffset);
-    pExtent->cDescriptorSectors = RT_LE2H_U64(Header.descriptorSize);
-    if (pExtent->uDescriptorSector && !pExtent->cDescriptorSectors)
-    {
-        rc = vmdkError(pExtent->pImage, VERR_VDI_INVALID_HEADER, RT_SRC_POS, N_("VMDK: inconsistent embedded descriptor config in '%s'"), pExtent->pszFullname);
-        goto out;
-    }
-    pExtent->cGTEntries = RT_LE2H_U32(Header.numGTEsPerGT);
+
     /* This code requires that a grain table must hold a power of two multiple
      * of the number of entries per GT cache entry. */
@@ -2080 +2150 @@
         goto out;
     }
-    if (RT_LE2H_U32(Header.flags) & 2)
-    {
-        pExtent->uSectorRGD = RT_LE2H_U64(Header.rgdOffset);
-        pExtent->uSectorGD = RT_LE2H_U64(Header.gdOffset);
-    }
-    else
-    {
-        /** @todo this is just guesswork, the spec doesn't document this
-         * properly and I don't have a vmdk without RGD. */
-        pExtent->uSectorGD = RT_LE2H_U64(Header.rgdOffset);
-        pExtent->uSectorRGD = 0;
-    }
-    pExtent->cOverheadSectors = RT_LE2H_U64(Header.overHead);
-    pExtent->fUncleanShutdown = !!Header.uncleanShutdown;
-    cSectorsPerGDE = pExtent->cGTEntries * pExtent->cSectorsPerGrain;
-    if (!cSectorsPerGDE || cSectorsPerGDE > UINT32_MAX)
-    {
-        rc = vmdkError(pExtent->pImage, VERR_VDI_INVALID_HEADER, RT_SRC_POS, N_("VMDK: incorrect grain directory size in '%s'"), pExtent->pszFullname);
-        goto out;
-    }
-    pExtent->cSectorsPerGDE = cSectorsPerGDE;
-    pExtent->cGDEntries = (pExtent->cSectors + cSectorsPerGDE - 1) / cSectorsPerGDE;
 
     rc = vmdkReadGrainDirectory(pExtent);
@@ -2368 +2416 @@
     if (RT_LE2H_U32(u32Magic) == VMDK_SPARSE_MAGICNUMBER)
     {
-        /* It's a hosted sparse single-extent image. */
+        /* It's a hosted single-extent image. */
         rc = vmdkCreateExtents(pImage, 1);
         if (RT_FAILURE(rc))
@@ -2383 +2431 @@
             goto out;
         }
-        rc = vmdkReadMetaSparseExtent(pImage, pExtent);
+        rc = vmdkReadBinaryMetaExtent(pImage, pExtent);
         if (RT_FAILURE(rc))
             goto out;
-        /* As we're dealing with a monolithic sparse image here, there must
+        /* As we're dealing with a monolithic image here, there must
          * be a descriptor embedded in the image file. */
         if (!pExtent->uDescriptorSector || !pExtent->cDescriptorSectors)
@@ -2413 +2461 @@
         rc = vmdkParseDescriptor(pImage, pExtent->pDescData,
                                  VMDK_SECTOR2BYTE(pExtent->cDescriptorSectors));
+        if (RT_FAILURE(rc))
+            goto out;
+
+        rc = vmdkReadMetaExtent(pImage, pExtent);
         if (RT_FAILURE(rc))
             goto out;
@@ -2535 +2587 @@
                         goto out;
                     }
-                    rc = vmdkReadMetaSparseExtent(pImage, pExtent);
+                    rc = vmdkReadBinaryMetaExtent(pImage, pExtent);
+                    if (RT_FAILURE(rc))
+                        goto out;
+                    rc = vmdkReadMetaExtent(pImage, pExtent);
                     if (RT_FAILURE(rc))
                         goto out;
@@ -3533 +3588 @@
             return vmdkError(pExtent->pImage, rc, RT_SRC_POS, N_("VMDK: error getting size in '%s'"), pExtent->pszFullname);
         Assert(!(cbExtentSize % 512));
+        cbExtentSize = RT_ALIGN_64(cbExtentSize, 512);
         uGTSector = VMDK_BYTE2SECTOR(cbExtentSize);
         /* Normally the grain table is preallocated for hosted sparse extents