Changeset 22213 in vbox for trunk/src/VBox/Main

Timestamp:

Aug 12, 2009 5:00:56 PM (15 years ago)

Author:

vboxsync

Message:

Main: make XML settings parser support settings format 1.6 for reading (written by VirtualBox 2.1.4)

Location:

trunk/src/VBox/Main

Files:

• Makefile.kmk (modified) (2 diffs)
• idl/VirtualBox.xidl (modified) (1 diff)
• xml/Settings.cpp (modified) (13 diffs)

trunk/src/VBox/Main/Makefile.kmk

@@ -281 +281 @@
         AutoLock.cpp \
         Matching.cpp \
+        xml/Settings.cpp \
         VirtualBoxBase.cpp \
         VirtualBoxErrorInfoImpl.cpp \
@@ -314 +315 @@
         Version.cpp \
         HostPower.cpp \
-        xml/Settings.cpp \
         $(if $(VBOX_WITH_VRDP),VRDPServerImpl.cpp,) \
         $(if $(VBOX_WITH_XPCOM),xpcom/server.cpp,) \

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -379 +379 @@
       <!-- 2008-09-04: 2.0.0 released
            2008-11-20: settings version 1.5 introduced
-           2008-12-17: 2.1.0 released -->
+           2008-12-17: 2.1.0 released
+      -->
     </const>
     <const name="v1_6"     value="8">
-      <desc>Intermediate settings version "1.6", understood by VirtualBox 2.2 and above.</desc>
+      <desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
       <!-- 2008-12-17: 2.1.0 released
-           2008-12-19: settings version 1.6 introduced (is in 2.2 branch)
-           2009-04-08: 2.2.0 released -->
+           2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
+           2009-04-08: 2.2.0 released
+      -->
     </const>
     <const name="v1_7"     value="9">

trunk/src/VBox/Main/xml/Settings.cpp

@@ -128 +128 @@
             const char *pcsz = m->strSettingsVersionFull.c_str();
             if (    (pcsz[0] == '1')
-                && (pcsz[1] == '.')
-                && (pcsz[3] == '-')
+                 && (pcsz[1] == '.')
+                 && (pcsz[3] == '-')
             )
             {
-                if (pcsz[2] == '7')
+                if (pcsz[2] == '6')
+                    m->sv = SettingsVersion_v1_6;
+                else if (pcsz[2] == '7')
                     m->sv = SettingsVersion_v1_7;
                 else if (pcsz[2] == '8')
@@ -371 +373 @@
     m->pelmRoot->setAttribute("xmlns", VBOX_XML_NAMESPACE);
 
-    const char *pcszVersion = "1.7";
+    // we always write at least version 1.7; we write 1.8
+    // if that was requested thru setRequiredSettingsVersion().
+    // we make no attempt at writing earlier versions.
+    // Writing 1.6 would be messy for machine files because
+    // of the hard disk attachment changes which are not
+    // necessarily backwards compatible and we don't want to
+    // introduce complex logic to see whether they are.
+    const char *pcszVersion = NULL;
     switch (m->sv)
     {
         case SettingsVersion_v1_8:
             pcszVersion = "1.8";
+        break;
+
+        default:
+            pcszVersion = "1.7";
+            m->sv = SettingsVersion_v1_7;
         break;
     }
@@ -1089 +1103 @@
 
 /**
+ * Helper function to read attributes that are common to <SATAController> (pre-1.7)
+ * and <StorageController>.
+ * @param elmStorageController
+ * @param strg
+ */
+void MachineConfigFile::readStorageControllerAttributes(const xml::ElementNode &elmStorageController,
+                                                        StorageController &sctl)
+{
+    elmStorageController.getAttributeValue("PortCount", sctl.ulPortCount);
+    elmStorageController.getAttributeValue("IDE0MasterEmulationPort", sctl.lIDE0MasterEmulationPort);
+    elmStorageController.getAttributeValue("IDE0SlaveEmulationPort", sctl.lIDE0SlaveEmulationPort);
+    elmStorageController.getAttributeValue("IDE1MasterEmulationPort", sctl.lIDE1MasterEmulationPort);
+    elmStorageController.getAttributeValue("IDE1SlaveEmulationPort", sctl.lIDE1SlaveEmulationPort);
+}
+
+/**
  * Reads in a <Hardware> block and stores it in the given structure. Used
  * both directly from readMachine and from readSnapshot, since snapshots
  * have their own hardware sections.
+ *
+ * For legacy pre-1.7 settings we also need a storage structure because
+ * the IDE and SATA controllers used to be defined under <Hardware>.
+ *
  * @param elmHardware
  * @param hw
  */
 void MachineConfigFile::readHardware(const xml::ElementNode &elmHardware,
-                                     Hardware &hw)
+                                     Hardware &hw,
+                                     Storage &strg)
 {
     elmHardware.getAttributeValue("version", hw.strVersion);
@@ -1215 +1250 @@
             if ((pelmBIOSChild = pelmHwChild->findChildElement("TimeOffset")))
                 pelmBIOSChild->getAttributeValue("value", hw.biosSettings.llTimeOffset);
+
+            // legacy BIOS/IDEController (pre 1.7)
+            if (    (m->sv < SettingsVersion_v1_7)
+                 && ((pelmBIOSChild = pelmHwChild->findChildElement("IDEController")))
+               )
+            {
+                StorageController sctl;
+                sctl.strName = "IDE";
+                sctl.storageBus = StorageBus_IDE;
+
+                Utf8Str strType;
+                if (pelmBIOSChild->getAttributeValue("type", strType))
+                {
+                    if (strType == "PIIX3")
+                        sctl.controllerType = StorageControllerType_PIIX3;
+                    else if (strType == "PIIX4")
+                        sctl.controllerType = StorageControllerType_PIIX4;
+                    else if (strType == "ICH6")
+                        sctl.controllerType = StorageControllerType_ICH6;
+                    else
+                        throw ConfigFileError(this, N_("Invalid value %s for IDEController/type attribute"), strType.c_str());
+                }
+                sctl.ulPortCount = 2;
+                strg.llStorageControllers.push_back(sctl);
+            }
         }
         else if (pelmHwChild->nameEquals("DVDDrive"))
@@ -1247 +1307 @@
             readUSBDeviceFilters(*pelmHwChild,
                                  hw.usbController.llDeviceFilters);
+        }
+        else if (    (m->sv < SettingsVersion_v1_7)
+                  && (pelmHwChild->nameEquals("SATAController"))
+                )
+        {
+            bool f;
+            if (    (pelmHwChild->getAttributeValue("enabled", f))
+                 && (f)
+               )
+            {
+                StorageController sctl;
+                sctl.strName = "SATA";
+                sctl.storageBus = StorageBus_SATA;
+                sctl.controllerType = StorageControllerType_IntelAhci;
+
+                readStorageControllerAttributes(*pelmHwChild, sctl);
+
+                strg.llStorageControllers.push_back(sctl);
+            }
         }
         else if (pelmHwChild->nameEquals("Network"))
@@ -1338 +1417 @@
 
 /**
+ * This gets called instead of readStorageControllers() for legacy pre-1.7 settings
+ * files which have a <HardDiskAttachments> node and storage controller settings
+ * hidden in the <Hardware> settings. We set the StorageControllers fields just the
+ * same, just from different sources.
+ * @param elmHardware <Hardware> XML node.
+ * @param elmHardDiskAttachments  <HardDiskAttachments> XML node.
+ * @param strg
+ */
+void MachineConfigFile::readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments,
+                                                       Storage &strg)
+{
+    StorageController *pIDEController = NULL;
+    StorageController *pSATAController = NULL;
+
+    for (StorageControllersList::iterator it = strg.llStorageControllers.begin();
+         it != strg.llStorageControllers.end();
+         ++it)
+    {
+        StorageController &s = *it;
+        if (s.storageBus == StorageBus_IDE)
+            pIDEController = &s;
+        else if (s.storageBus == StorageBus_SATA)
+            pSATAController = &s;
+    }
+
+    xml::NodesLoop nl1(elmHardDiskAttachments, "HardDiskAttachment");
+    const xml::ElementNode *pelmAttachment;
+    while ((pelmAttachment = nl1.forAllNodes()))
+    {
+        AttachedDevice att;
+        Utf8Str strUUID, strBus;
+
+        if (!pelmAttachment->getAttributeValue("hardDisk", strUUID))
+            throw ConfigFileError(this, N_("Required HardDiskAttachment/hardDisk attribute is missing"));
+        parseUUID(att.uuid, strUUID);
+
+        if (!pelmAttachment->getAttributeValue("bus", strBus))
+            throw ConfigFileError(this, N_("Required HardDiskAttachment/bus attribute is missing"));
+        // pre-1.7 'channel' is now port
+        if (!pelmAttachment->getAttributeValue("channel", att.lPort))
+            throw ConfigFileError(this, N_("Required HardDiskAttachment/channel attribute is missing"));
+        // pre-1.7 'device' is still device
+        if (!pelmAttachment->getAttributeValue("device", att.lDevice))
+            throw ConfigFileError(this, N_("Required HardDiskAttachment/device attribute is missing"));
+
+        if (strBus == "IDE")
+        {
+            if (!pIDEController)
+                throw ConfigFileError(this, N_("HardDiskAttachment/bus is 'IDE' but cannot find IDE controller"));
+            pIDEController->llAttachedDevices.push_back(att);
+        }
+        else if (strBus == "SATA")
+        {
+            if (!pSATAController)
+                throw ConfigFileError(this, N_("HardDiskAttachment/bus is 'SATA' but cannot find SATA controller"));
+            pSATAController->llAttachedDevices.push_back(att);
+        }
+        else
+            throw ConfigFileError(this, N_("HardDiskAttachment/bus attribute has illegal value '%s'"), strBus.c_str());
+    }
+}
+
+/**
  * Reads in a <StorageControllers> block and stores it in the given Storage structure.
  * Used both directly from readMachine and from readSnapshot, since snapshots
  * have their own storage controllers sections.
+ *
+ * This is only called for settings version 1.7 and above; see readHardDiskAttachments_pre1_7
+ * for earlier versions.
  *
  * @param elmStorageControllers
@@ -1392 +1537 @@
             throw ConfigFileError(this, N_("Invalid value %s for StorageController/type attribute"), strType.c_str());
 
-        pelmController->getAttributeValue("PortCount", sctl.ulPortCount);
-
-        pelmController->getAttributeValue("IDE0MasterEmulationPort", sctl.lIDE0MasterEmulationPort);
-        pelmController->getAttributeValue("IDE0SlaveEmulationPort", sctl.lIDE0SlaveEmulationPort);
-        pelmController->getAttributeValue("IDE1MasterEmulationPort", sctl.lIDE1MasterEmulationPort);
-        pelmController->getAttributeValue("IDE1SlaveEmulationPort", sctl.lIDE1SlaveEmulationPort);
+        readStorageControllerAttributes(*pelmController, sctl);
 
         xml::NodesLoop nlAttached(*pelmController, "AttachedDevice");
@@ -1461 +1601 @@
     elmSnapshot.getAttributeValue("stateFile", snap.strStateFile);      // online snapshots only
 
+    // parse Hardware before the other elements because other things depend on it
+    const xml::ElementNode *pelmHardware;
+    if (!(pelmHardware = elmSnapshot.findChildElement("Hardware")))
+        throw ConfigFileError(this, N_("Required Snapshot/Hardware element is missing"));
+    readHardware(*pelmHardware, snap.hardware, snap.storage);
+
     xml::NodesLoop nlSnapshotChildren(elmSnapshot);
     const xml::ElementNode *pelmSnapshotChild;
@@ -1467 +1613 @@
         if (pelmSnapshotChild->nameEquals("Description"))
             snap.strDescription = pelmSnapshotChild->getValue();
-        else if (pelmSnapshotChild->nameEquals("Hardware"))
-            readHardware(*pelmSnapshotChild, snap.hardware);
-        else if (pelmSnapshotChild->nameEquals("StorageControllers"))
+        else if (    (m->sv < SettingsVersion_v1_7)
+                  && (pelmSnapshotChild->nameEquals("HardDiskAttachments"))
+                )
+            readHardDiskAttachments_pre1_7(*pelmSnapshotChild, snap.storage);
+        else if (    (m->sv >= SettingsVersion_v1_7)
+                  && (pelmSnapshotChild->nameEquals("StorageControllers"))
+                )
             readStorageControllers(*pelmSnapshotChild, snap.storage);
         else if (pelmSnapshotChild->nameEquals("Snapshots"))
@@ -1487 +1637 @@
             }
         }
+        else if (pelmSnapshotChild->nameEquals("Hardware"))
+            ; // handled above
         else
             throw ConfigFileError(this, N_("Invalid element %s under Snapshot element"), pelmSnapshotChild->getName());
@@ -1522 +1674 @@
             // constructor has called RTTimeNow(&timeLastStateChange) before
 
+        // parse Hardware before the other elements because other things depend on it
+        const xml::ElementNode *pelmHardware;
+        if (!(pelmHardware = elmMachine.findChildElement("Hardware")))
+            throw ConfigFileError(this, N_("Required Machine/Hardware element is missing"));
+        readHardware(*pelmHardware, hardwareMachine, storageMachine);
+
         xml::NodesLoop nlRootChildren(elmMachine);
         const xml::ElementNode *pelmMachineChild;
@@ -1529 +1687 @@
                 readExtraData(*pelmMachineChild,
                               mapExtraDataItems);
-            else if (pelmMachineChild->nameEquals("Hardware"))
-                readHardware(*pelmMachineChild, hardwareMachine);
-            else if (pelmMachineChild->nameEquals("StorageControllers"))
+            else if (    (m->sv < SettingsVersion_v1_7)
+                      && (pelmMachineChild->nameEquals("HardDiskAttachments"))
+                    )
+                readHardDiskAttachments_pre1_7(*pelmMachineChild, storageMachine);
+            else if (    (m->sv >= SettingsVersion_v1_7)
+                      && (pelmMachineChild->nameEquals("StorageControllers"))
+                    )
                 readStorageControllers(*pelmMachineChild, storageMachine);
             else if (pelmMachineChild->nameEquals("Snapshot"))
@@ -1542 +1704 @@
             else if (pelmMachineChild->nameEquals("Description"))
                 strDescription = pelmMachineChild->getValue();
+            else if (pelmMachineChild->nameEquals("Hardware"))
+                ; // read above
             else
                 throw ConfigFileError(this, N_("Invalid element %s under Machine element"), pelmMachineChild->getName());