Changeset 4185 in vbox for trunk/src/VBox/VMM

Timestamp:

Aug 16, 2007 10:44:44 PM (17 years ago)

Author:

vboxsync

Message:

Fixed x86/amd64 file header difference. Added SSMAFTER_DEBUG_IT for tstAnimate and (later) debugger usage.

File:

• trunk/src/VBox/VMM/SSM.cpp (modified) (25 diffs)

trunk/src/VBox/VMM/SSM.cpp

@@ -91 +91 @@
     /** The VM handle. */
     PVM             pVM;
+    /** The size of the file header. 
+     * Because the file header was incorrectly aligned there we've ended up with 
+     * differences between the 64-bit and 32-bit file header. */
+    size_t          cbFileHdr;
     /** The current operation. */
     SSMSTATE        enmOp;
@@ -139 +143 @@
     /** File checksum. The actual calculation skips past the u32CRC field. */
     uint32_t    u32CRC;
+    /** Padding. */
+    uint32_t    u32Reserved;
     /** The machine UUID. (Ignored if NIL.) */
     RTUUID      MachineUuid;
 } SSMFILEHDR, *PSSMFILEHDR;
+AssertCompileSize(SSMFILEHDR, 64);
+
+
+/**
+ * The x86 edition of the 1.0 header.
+ */
+#pragma pack(1) /* darn, MachineUuid got missaligned! */
+typedef struct SSMFILEHDRV10X86
+{
+    /** Magic string which identifies this file as a version of VBox saved state file format. */
+    char        achMagic[32];
+    /** The size of this file. Used to check
+     * whether the save completed and that things are fine otherwise. */
+    uint64_t    cbFile;
+    /** File checksum. The actual calculation skips past the u32CRC field. */
+    uint32_t    u32CRC;
+    /** The machine UUID. (Ignored if NIL.) */
+    RTUUID      MachineUuid;
+} SSMFILEHDRV10X86, *PSSMFILEHDRV10X86;
+#pragma pack()
+
+/**
+ * The amd64 edition of the 1.0 header.
+ */
+typedef SSMFILEHDR SSMFILEHDRV10AMD64, *PSSMFILEHDRV10AMD64;
 
 /** Saved state file magic base string. */
 #define SSMFILEHDR_MAGIC_BASE   "\177VirtualBox SavedState "
 /** Saved state file v1.0 magic. */
-#define SSMFILEHDR_MAGIC_V1     "\177VirtualBox SavedState V1.0\n"
+#define SSMFILEHDR_MAGIC_V1_0   "\177VirtualBox SavedState V1.0\n"
+/** Saved state file v1.1 magic. */
+#define SSMFILEHDR_MAGIC_V1_1   "\177VirtualBox SavedState V1.1\n"
 
 
@@ -183 +216 @@
 static int ssmr3CalcChecksum(RTFILE File, uint64_t cbFile, uint32_t *pu32CRC);
 static void ssmR3Progress(PSSMHANDLE pSSM, uint64_t cbAdvance);
-static int ssmr3Validate(RTFILE File, PSSMFILEHDR pHdr);
+static int ssmr3Validate(RTFILE File, PSSMFILEHDR pHdr, size_t *pcbFileHdr);
 static PSSMUNIT ssmr3Find(PVM pVM, const char *pszName, uint32_t u32Instance);
 static int ssmr3WriteFinish(PSSMHANDLE pSSM);
@@ -744 +777 @@
      * Validate input.
      */
-    if (enmAfter != SSMAFTER_DESTROY && enmAfter != SSMAFTER_CONTINUE)
+    if (    enmAfter != SSMAFTER_DESTROY 
+        &&  enmAfter != SSMAFTER_CONTINUE)
     {
         AssertMsgFailed(("Invalid enmAfter=%d!\n", enmAfter));
@@ -756 +790 @@
     Handle.enmAfter    = enmAfter;
     Handle.pVM         = pVM;
+    Handle.cbFileHdr   = sizeof(SSMFILEHDR);
     Handle.pfnProgress = pfnProgress;
     Handle.pvUser      = pvUser;
@@ -778 +813 @@
      * Write header.
      */
-    SSMFILEHDR Hdr = { SSMFILEHDR_MAGIC_V1, 0, 0 };
+    SSMFILEHDR Hdr = { SSMFILEHDR_MAGIC_V1_1, 0, 0, 0 };
     rc = RTFileWrite(Handle.File, &Hdr, sizeof(Hdr), NULL);
     if (VBOX_SUCCESS(rc))
@@ -1071 +1106 @@
  *
  * @returns VBox status.
- * @param   File    File to validate.
- *                  The file position is undefined on return.
- * @param   pHdr    Where to store the file header.
- */
-static int ssmr3Validate(RTFILE File, PSSMFILEHDR pHdr)
+ * @param   File        File to validate.
+ *                      The file position is undefined on return.
+ * @param   pHdr        Where to store the file header.
+ * @param   pcbFileHdr  Where to store the file header size.
+ */
+static int ssmr3Validate(RTFILE File, PSSMFILEHDR pHdr, size_t *pcbFileHdr)
 {
     /*
@@ -1088 +1124 @@
 
     /*
-     * Verify the magic.
+     * Verify the magic and make adjustments for versions differences.
      */
     if (memcmp(pHdr->achMagic, SSMFILEHDR_MAGIC_BASE, sizeof(SSMFILEHDR_MAGIC_BASE) - 1))
@@ -1095 +1131 @@
         return VERR_SSM_INTEGRITY_MAGIC;
     }
-    if (memcmp(pHdr->achMagic, SSMFILEHDR_MAGIC_V1, sizeof(SSMFILEHDR_MAGIC_V1)))
+
+    size_t offCrc32 = RT_OFFSETOF(SSMFILEHDR, u32CRC) + sizeof(pHdr->u32CRC);
+    *pcbFileHdr = sizeof(*pHdr);
+    if (!memcmp(pHdr->achMagic, SSMFILEHDR_MAGIC_V1_0, sizeof(SSMFILEHDR_MAGIC_V1_0)))
+    {
+        if (pHdr->MachineUuid.au32[3])
+        {
+            SSMFILEHDRV10X86 OldHdr;
+            memcpy(&OldHdr, pHdr, sizeof(OldHdr));
+            pHdr->cbFile = OldHdr.cbFile;
+            pHdr->u32CRC = OldHdr.u32CRC;
+            pHdr->u32Reserved = 0;
+            pHdr->MachineUuid = OldHdr.MachineUuid;
+
+            offCrc32 = RT_OFFSETOF(SSMFILEHDRV10X86, u32CRC) + sizeof(pHdr->u32CRC);
+            *pcbFileHdr = sizeof(OldHdr);
+        }
+        else
+        {
+            /* (It's identical, but this doesn't harm us and will continue working after future changes.) */
+            SSMFILEHDRV10AMD64 OldHdr;
+            memcpy(&OldHdr, pHdr, sizeof(OldHdr));
+            pHdr->cbFile = OldHdr.cbFile;
+            pHdr->u32CRC = OldHdr.u32CRC;
+            pHdr->u32Reserved = 0;
+            pHdr->MachineUuid = OldHdr.MachineUuid;
+
+            offCrc32 = RT_OFFSETOF(SSMFILEHDRV10AMD64, u32CRC) + sizeof(pHdr->u32CRC);
+            *pcbFileHdr = sizeof(OldHdr);
+        }
+    }
+    else if (memcmp(pHdr->achMagic, SSMFILEHDR_MAGIC_V1_1, sizeof(SSMFILEHDR_MAGIC_V1_1)))
     {
         Log(("SSM: Unknown file format version. magic=%.*s\n", sizeof(pHdr->achMagic) - 1, pHdr->achMagic));
@@ -1120 +1187 @@
      * Verify the checksum.
      */
-    rc = RTFileSeek(File, RT_OFFSETOF(SSMFILEHDR, u32CRC) + sizeof(pHdr->u32CRC), RTFILE_SEEK_BEGIN, NULL);
+    rc = RTFileSeek(File, offCrc32, RTFILE_SEEK_BEGIN, NULL);
     if (VBOX_FAILURE(rc))
     {
@@ -1127 +1194 @@
     }
     uint32_t u32CRC;
-    rc = ssmr3CalcChecksum(File, pHdr->cbFile - sizeof(*pHdr), &u32CRC);
+    rc = ssmr3CalcChecksum(File, pHdr->cbFile - *pcbFileHdr, &u32CRC);
     if (VBOX_FAILURE(rc))
         return rc;
@@ -1139 +1206 @@
      * Verify Virtual Machine UUID.
      */
-    RTUUID    Uuid;
+    RTUUID  Uuid;
     memset(&Uuid, 0, sizeof(Uuid));
 /** @todo get machine uuids  CFGGetUuid(, &Uuid); */
@@ -1182 +1249 @@
  * @param   pVM             The VM handle.
  * @param   pszFilename     Name of the file to save the state in.
- * @param   enmAfter        What is planned after a successful save operation.
+ * @param   enmAfter        What is planned after a successful load operation.
+ *                          Only acceptable values are SSMAFTER_RESUME and SSMAFTER_DEBUG_IT.
  * @param   pfnProgress     Progress callback. Optional.
  * @param   pvUser          User argument for the progress callback.
@@ -1193 +1261 @@
      * Validate input.
      */
-    if (enmAfter != SSMAFTER_RESUME)
+    if (    enmAfter != SSMAFTER_RESUME
+        &&  enmAfter != SSMAFTER_DEBUG_IT)
     {
         AssertMsgFailed(("Invalid enmAfter=%d!\n", enmAfter));
@@ -1205 +1274 @@
     Handle.enmAfter        = enmAfter;
     Handle.pVM             = pVM;
+    Handle.cbFileHdr       = sizeof(SSMFILEHDR);
     Handle.pfnProgress     = pfnProgress;
     Handle.pvUser          = pvUser;
@@ -1220 +1290 @@
      */
     SSMFILEHDR Hdr;
-    rc = ssmr3Validate(Handle.File, &Hdr);
+    rc = ssmr3Validate(Handle.File, &Hdr, &Handle.cbFileHdr);
     if (VBOX_SUCCESS(rc))
     {
@@ -1285 +1355 @@
          */
         if (VBOX_SUCCESS(rc))
-            rc = RTFileSeek(Handle.File, sizeof(Hdr), RTFILE_SEEK_BEGIN, NULL);
+            rc = RTFileSeek(Handle.File, Handle.cbFileHdr, RTFILE_SEEK_BEGIN, NULL);
         if (VBOX_SUCCESS(rc))
         {
@@ -1396 +1466 @@
                                         pUnit->fCalled = true;
                                         if (VBOX_SUCCESS(rc))
+                                            rc = Handle.rc;
+                                        if (VBOX_SUCCESS(rc))
                                         {
                                             /*
@@ -1423 +1495 @@
                                         else
                                         {
+                                            /* 
+                                             * We failed, but if loading for the debugger ignore certain failures
+                                             * just to get it all loaded (big hack).
+                                             */
                                             LogRel(("SSM: LoadExec failed with rc=%Vrc for unit '%s'!\n", rc, pszName));
-                                            break;
+                                            if (    Handle.enmAfter != SSMAFTER_DEBUG_IT
+                                                ||  rc != VERR_SSM_LOADED_TOO_MUCH)
+                                                break;
+                                            Handle.rc = rc = VINF_SUCCESS; 
+                                            ssmR3Progress(&Handle, Handle.offEstUnitEnd - Handle.offEst);
                                         }
                                     }
@@ -1436 +1516 @@
                                 else
                                 {
+                                    /* 
+                                     * SSM unit wasn't found - ignore this when loading for the debugger.
+                                     */
                                     LogRel(("SSM: Found no handler for unit '%s'!\n", pszName));
                                     rc = VERR_SSM_INTEGRITY_UNIT_NOT_FOUND;
-                                    break;
+                                    if (Handle.enmAfter != SSMAFTER_DEBUG_IT)
+                                        break;
+                                    rc = RTFileSeek(Handle.File, offUnit + UnitHdr.cbUnit, RTFILE_SEEK_BEGIN, NULL);
                                 }
                             }
@@ -1560 +1645 @@
     if (VBOX_SUCCESS(rc))
     {
+        size_t cbFileHdr;
         SSMFILEHDR Hdr;
-        rc = ssmr3Validate(File, &Hdr);
+        rc = ssmr3Validate(File, &Hdr, &cbFileHdr);
         RTFileClose(File);
     }
@@ -1602 +1688 @@
     {
         SSMFILEHDR Hdr;
-        rc = ssmr3Validate(pSSM->File, &Hdr);
+        size_t cbFileHdr;
+        rc = ssmr3Validate(pSSM->File, &Hdr, &cbFileHdr);
         if (VBOX_SUCCESS(rc))
         {
             //pSSM->pVM           = NULL;
+            pSSM->cbFileHdr       = cbFileHdr;
             pSSM->enmOp           = SSMSTATE_OPEN_READ;
             pSSM->enmAfter        = SSMAFTER_OPENED;
@@ -1709 +1797 @@
     size_t  cchName = 0;
     SSMFILEUNITHDR  UnitHdr;
-    for (RTFOFF off = sizeof(SSMFILEHDR); ; off += UnitHdr.cbUnit)
+    for (RTFOFF off = pSSM->cbFileHdr; ; off += UnitHdr.cbUnit)
     {
         /*
@@ -2388 +2476 @@
     }
 
-    AssertMsgFailed(("SSM: attempted reading more than the unit!\n"));
+    /** @todo weed out lazy saving */
+    if (pSSM->enmAfter != SSMAFTER_DEBUG_IT)
+        AssertMsgFailed(("SSM: attempted reading more than the unit!\n"));
     return VERR_SSM_LOADED_TOO_MUCH;
 }
@@ -2864 +2954 @@
  * @param   pSSM            SSM operation handle.
  */
-SSMR3DECL(int) SSMR3HandleGetAfter(PSSMHANDLE pSSM)
+SSMR3DECL(SSMAFTER) SSMR3HandleGetAfter(PSSMHANDLE pSSM)
 {
     return pSSM->enmAfter;