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

Timestamp:

Sep 30, 2019 6:55:28 PM (5 years ago)

Author:

vboxsync

Message:

Main/Machine+BIOSSettings: bare bones NVRAM logic, many parts missing (no snapshot handling, no move VM handling, no remove VM handling).
Main/Settings: adaptions to store NVRAM config in the settings file
Frontends/VBoxManage: support enabling and showing state

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (3 diffs)
• include/BIOSSettingsImpl.h (modified) (1 diff)
• include/MachineImpl.h (modified) (1 diff)
• src-client/ConsoleImpl2.cpp (modified) (1 diff)
• src-server/BIOSSettingsImpl.cpp (modified) (12 diffs)
• src-server/MachineImpl.cpp (modified) (1 diff)
• xml/Settings.cpp (modified) (6 diffs)
• xml/VirtualBox-settings.xsd (modified) (1 diff)

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

@@ -599 +599 @@
       <desc>Settings version "1.17", written by VirtualBox 6.0.x.</desc>
       <!--
-          Machine changes: nested hardware virtualization, UART type selection.
+          Machine changes: nested hardware virtualization, hardware
+          virtualization using native APU, shared folder automount point,
+          UART type selection and VM process priority.
       -->
     </const>
@@ -605 +607 @@
       <desc>Settings version "1.18", written by VirtualBox 6.1.x.</desc>
       <!--
-          Machine changes: nested hardware virtualization, UART type selection.
+          Machine changes: virtio-scsi storage controller, NVRAM device.
       -->
     </const>
@@ -5257 +5259 @@
     </attribute>
 
+    <attribute name="nonVolatileStorageEnabled" type="boolean">
+      <desc>
+        Controls the non-volatile memory device presence. If set, VirtualBox
+        will store the content in a file whose path can be queried with the
+        <link to="#nonVolatileStorageFile"/> attribute.
+      </desc>
+    </attribute>
+
     <attribute name="nonVolatileStorageFile" type="wstring" readonly="yes">
       <desc>

trunk/src/VBox/Main/include/BIOSSettingsImpl.h

@@ -81 +81 @@
     HRESULT getPXEDebugEnabled(BOOL *enabled);
     HRESULT setPXEDebugEnabled(BOOL enable);
+    HRESULT getNonVolatileStorageEnabled(BOOL *enabled);
+    HRESULT setNonVolatileStorageEnabled(BOOL enable);
     HRESULT getNonVolatileStorageFile(com::Utf8Str &aNonVolatileStorageFile);
 

trunk/src/VBox/Main/include/MachineImpl.h

@@ -542 +542 @@
     Utf8Str i_getLogFilename(ULONG idx);
     Utf8Str i_getHardeningLogFilename(void);
+    Utf8Str i_getDefaultNVRAMFilename();
 
     void i_composeSavedStateFilename(Utf8Str &strStateFilePath);

trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp

@@ -1831 +1831 @@
             InsertConfigInteger(pCfg,  "PermanentSave", 1);
 #endif
+
+            BOOL fNVRAM = FALSE;
+            hrc = biosSettings->COMGETTER(NonVolatileStorageEnabled)(&fNVRAM);              H();
+            if (fNVRAM)
+            {
+                hrc = biosSettings->COMGETTER(NonVolatileStorageFile)(bstr.asOutParam());   H();
+
+                /*
+                 * NVRAM device subtree.
+                 */
+                InsertConfigNode(pDevices, "flash", &pDev);
+                InsertConfigNode(pDev,     "0", &pInst);
+                InsertConfigNode(pInst,    "Config", &pCfg);
+                InsertConfigString(pCfg,   "FlashFile", bstr);
+            }
         }
 

trunk/src/VBox/Main/src-server/BIOSSettingsImpl.cpp

@@ -224 +224 @@
 }
 
-
 HRESULT BIOSSettings::setLogoFadeOut(BOOL enable)
 {
@@ -256 +255 @@
 }
 
-
 HRESULT BIOSSettings::setLogoDisplayTime(ULONG displayTime)
 {
@@ -284 +282 @@
 }
 
-
 HRESULT BIOSSettings::setLogoImagePath(const com::Utf8Str &imagePath)
 {
@@ -311 +308 @@
 }
 
-
 HRESULT BIOSSettings::setBootMenuMode(BIOSBootMenuMode_T bootMenuMode)
 {
@@ -340 +336 @@
 }
 
-
 HRESULT BIOSSettings::setACPIEnabled(BOOL enable)
 {
@@ -369 +364 @@
 }
 
-
 HRESULT BIOSSettings::setIOAPICEnabled(BOOL aIOAPICEnabled)
 {
@@ -398 +392 @@
 }
 
-
 HRESULT BIOSSettings::setAPICMode(APICMode_T aAPICMode)
 {
@@ -427 +420 @@
 }
 
-
 HRESULT BIOSSettings::setPXEDebugEnabled(BOOL enable)
 {
@@ -446 +438 @@
 }
 
+
 HRESULT BIOSSettings::getTimeOffset(LONG64 *offset)
 {
@@ -455 +448 @@
 }
 
-
 HRESULT BIOSSettings::setTimeOffset(LONG64 offset)
 {
@@ -474 +466 @@
 }
 
+
+HRESULT BIOSSettings::getNonVolatileStorageEnabled(BOOL *enabled)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    *enabled = m->bd->fNVRAMEnabled;
+
+    return S_OK;
+}
+
+HRESULT BIOSSettings::setNonVolatileStorageEnabled(BOOL enable)
+{
+    /* the machine needs to be mutable */
+    AutoMutableStateDependency adep(m->pMachine);
+    if (FAILED(adep.rc())) return adep.rc();
+
+    AutoCaller autoMachineCaller(m->pMachine);
+    AssertComRCReturnRC(autoMachineCaller.rc());
+
+    {
+        AutoReadLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);
+        AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+        m->bd.backup();
+        m->bd->fNVRAMEnabled = RT_BOOL(enable);
+        if (enable && m->bd->strNVRAMPath.isEmpty())
+            m->bd->strNVRAMPath = m->pMachine->i_getDefaultNVRAMFilename();
+    }
+
+    AutoWriteLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);  // mParent is const, needs no locking
+    m->pMachine->i_setModified(Machine::IsModified_BIOS);
+
+    return S_OK;
+}
+
+
 HRESULT BIOSSettings::getNonVolatileStorageFile(com::Utf8Str &aNonVolatileStorageFile)
 {
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    aNonVolatileStorageFile = "";
+    Utf8Str strTmp;
+    {
+        AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+        strTmp = m->bd->strNVRAMPath;
+    }
+
+    m->pMachine->i_calculateFullPath(strTmp, aNonVolatileStorageFile);
 
     return S_OK;
@@ -504 +536 @@
     AssertComRCReturnRC(autoCaller.rc());
 
+    AutoReadLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
     // simply copy
     m->bd.assignCopy(&data);
+
+    Utf8Str strTmp(m->bd->strNVRAMPath);
+    m->pMachine->i_copyPathRelativeToMachine(strTmp, m->bd->strNVRAMPath);
 
     return S_OK;

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -7309 +7309 @@
     strFilename.append(RTPATH_SLASH_STR "VBoxHardening.log");
     return strFilename;
+}
+
+/**
+ * Returns the default NVRAM filename based on the location of the VM config.
+ * This intentionally works differently than the saved state file naming since
+ * it is part of the current state. Taking a snapshot will use a similar naming
+ * as for saved state, because these are actually read-only, retaining a
+ * a specific state just like saved state.
+ */
+
+Utf8Str Machine::i_getDefaultNVRAMFilename()
+{
+    AutoCaller autoCaller(this);
+    AssertComRCReturn(autoCaller.rc(), Utf8Str::Empty);
+
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+    Utf8Str strNVRAMFilePathAbs = mData->m_strConfigFileFull;
+    strNVRAMFilePathAbs.stripSuffix();
+    strNVRAMFilePathAbs += ".nvram";
+    Utf8Str strNVRAMFilePath;
+    i_copyPathRelativeToMachine(strNVRAMFilePathAbs, strNVRAMFilePath);
+
+    return strNVRAMFilePath;
 }
 

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

@@ -2464 +2464 @@
     fLogoFadeOut(true),
     fPXEDebugEnabled(false),
+    fNVRAMEnabled(false),
     ulLogoDisplayTime(0),
     biosBootMenuMode(BIOSBootMenuMode_MessageAndMenu),
@@ -2481 +2482 @@
         && fLogoFadeOut
         && !fPXEDebugEnabled
+        && !fNVRAMEnabled
         && ulLogoDisplayTime == 0
         && biosBootMenuMode == BIOSBootMenuMode_MessageAndMenu
         && apicMode == APICMode_APIC
         && llTimeOffset == 0
-        && strLogoImagePath.isEmpty();
+        && strLogoImagePath.isEmpty()
+        && strNVRAMPath.isEmpty();
 }
 
@@ -2501 +2504 @@
             && fLogoFadeOut        == d.fLogoFadeOut
             && fPXEDebugEnabled    == d.fPXEDebugEnabled
+            && fNVRAMEnabled       == d.fNVRAMEnabled
             && ulLogoDisplayTime   == d.ulLogoDisplayTime
             && biosBootMenuMode    == d.biosBootMenuMode
             && apicMode            == d.apicMode
             && llTimeOffset        == d.llTimeOffset
-            && strLogoImagePath    == d.strLogoImagePath);
+            && strLogoImagePath    == d.strLogoImagePath
+            && strNVRAMPath        == d.strNVRAMPath);
 }
 
@@ -4721 +4726 @@
             if ((pelmBIOSChild = pelmHwChild->findChildElement("TimeOffset")))
                 pelmBIOSChild->getAttributeValue("value", hw.biosSettings.llTimeOffset);
+            if ((pelmBIOSChild = pelmHwChild->findChildElement("NVRAM")))
+            {
+                pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fNVRAMEnabled);
+                pelmBIOSChild->getAttributeValue("path", hw.biosSettings.strNVRAMPath);
+            }
 
             // legacy BIOS/IDEController (pre 1.7)
@@ -6189 +6199 @@
         if (hw.biosSettings.fPXEDebugEnabled)
             pelmBIOS->createChild("PXEDebug")->setAttribute("enabled", hw.biosSettings.fPXEDebugEnabled);
+        if (   hw.biosSettings.fNVRAMEnabled
+            || !hw.biosSettings.strNVRAMPath.isEmpty())
+        {
+            xml::ElementNode *pelmNVRAM = pelmBIOS->createChild("NVRAM");
+            if (hw.biosSettings.fNVRAMEnabled)
+                pelmNVRAM->setAttribute("enabled", hw.biosSettings.fNVRAMEnabled);
+            if (!hw.biosSettings.strNVRAMPath.isEmpty())
+                pelmNVRAM->setAttribute("path", hw.biosSettings.strNVRAMPath);
+        }
     }
 
@@ -7450 +7469 @@
     if (m->sv < SettingsVersion_v1_18)
     {
+        if (   hardwareMachine.biosSettings.fNVRAMEnabled
+            || !hardwareMachine.biosSettings.strNVRAMPath.isEmpty())
+        {
+            m->sv = SettingsVersion_v1_18;
+            return;
+        }
+
         // VirtualBox 6.1 adds a virtio-scsi storage controller.
         for (StorageControllersList::const_iterator it = hardwareMachine.storage.llStorageControllers.begin();

trunk/src/VBox/Main/xml/VirtualBox-settings.xsd

@@ -715 +715 @@
       <xsd:complexType>
         <xsd:attribute name="enabled" type="xsd:boolean" default="false"/>
+      </xsd:complexType>
+    </xsd:element>
+    <xsd:element name="NVRAM" minOccurs="0">
+      <xsd:complexType>
+        <xsd:attribute name="enabled" type="xsd:boolean" default="false"/>
+        <xsd:attribute name="path" type="xsd:string"/>
       </xsd:complexType>
     </xsd:element>