Changeset 81299 in vbox

Timestamp:

Oct 16, 2019 7:32:48 PM (5 years ago)

Author:

vboxsync

Message:

Main/Machine+BIOSSettings: simplify NVRAM handling, do everything in backwards c
ompatible way
Frontends/VBoxManage: adapt to API change

Location:

trunk

Files:

• include/VBox/settings.h (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp (modified) (3 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
• src/VBox/Main/include/BIOSSettingsImpl.h (modified) (2 diffs)
• src/VBox/Main/include/MachineImpl.h (modified) (1 diff)
• src/VBox/Main/src-client/ConsoleImpl2.cpp (modified) (3 diffs)
• src/VBox/Main/src-server/BIOSSettingsImpl.cpp (modified) (4 diffs)
• src/VBox/Main/src-server/MachineImpl.cpp (modified) (3 diffs)
• src/VBox/Main/xml/Settings.cpp (modified) (6 diffs)

trunk/include/VBox/settings.h

@@ -506 +506 @@
                     fLogoFadeIn,
                     fLogoFadeOut,
-                    fPXEDebugEnabled,
-                    fNVRAMEnabled;
+                    fPXEDebugEnabled;
     uint32_t        ulLogoDisplayTime;
     BIOSBootMenuMode_T biosBootMenuMode;

trunk/src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp

@@ -870 +870 @@
 
     SHOW_LONG64_PROP(biosSettings,  TimeOffset,                 "biossystemtimeoffset", "Time offset:",  "ms");
-    SHOW_BOOLEAN_PROP(biosSettings, NonVolatileStorageEnabled,  "biosnvram",            "BIOS NVRAM:");
     Bstr bstrNVRAMFile;
     CHECK_ERROR2I_RET(biosSettings, COMGETTER(NonVolatileStorageFile)(bstrNVRAMFile.asOutParam()), hrcCheck);

trunk/src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp

@@ -107 +107 @@
     MODIFYVM_BIOSSYSTEMTIMEOFFSET,
     MODIFYVM_BIOSPXEDEBUG,
-    MODIFYVM_BIOSNVRAM,
     MODIFYVM_BOOT,
     MODIFYVM_HDA,                // deprecated
@@ -301 +300 @@
     { "--biosapic",                 MODIFYVM_BIOSAPIC,                  RTGETOPT_REQ_STRING },
     { "--biospxedebug",             MODIFYVM_BIOSPXEDEBUG,              RTGETOPT_REQ_BOOL_ONOFF },
-    { "--biosnvram",                MODIFYVM_BIOSNVRAM,                 RTGETOPT_REQ_BOOL_ONOFF },
     { "--boot",                     MODIFYVM_BOOT,                      RTGETOPT_REQ_STRING | RTGETOPT_FLAG_INDEX },
     { "--hda",                      MODIFYVM_HDA,                       RTGETOPT_REQ_STRING },
@@ -1016 +1014 @@
             }
 
-            case MODIFYVM_BIOSNVRAM:
-            {
-                CHECK_ERROR(biosSettings, COMSETTER(NonVolatileStorageEnabled)(ValueUnion.f));
-                break;
-            }
-
             case MODIFYVM_BOOT:
             {

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

@@ -5197 +5197 @@
   <interface
     name="IBIOSSettings" extends="$unknown"
-    uuid="f13f667d-3624-4ac5-99c1-3d982ebd8d98"
+    uuid="73af4152-7e67-4144-bf34-41c38e8b4cc7"
     wsmap="managed"
     reservedMethods="1" reservedAttributes="8"
@@ -5262 +5262 @@
     </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>
         The location of the file storing the non-volatile memory content when
         the VM is powered off.  The file does not always exist.
-
-        This feature will be realized after VirtualBox v4.3.0.
       </desc>
     </attribute>

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

@@ -58 +58 @@
     void i_applyDefaults(GuestOSType *aOsType);
 
+    void i_updateNonVolatileStorageFile(const com::Utf8Str &aNonVolatileStorageFile);
+
 private:
 
@@ -81 +83 @@
     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

@@ -498 +498 @@
     Utf8Str i_getOSTypeId() const { return mUserData->s.strOsType; }
     ChipsetType_T i_getChipsetType() const { return mHWData->mChipsetType; }
+    FirmwareType_T i_getFirmwareType() const { return mHWData->mFirmwareType; }
     ULONG i_getMonitorCount() const { return mHWData->mMonitorCount; }
     ParavirtProvider_T i_getParavirtProvider() const { return mHWData->mParavirtProvider; }

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

@@ -1750 +1750 @@
             GetExtraDataBoth(virtualBox, pMachine, "VBoxInternal2/EfiDeviceProps", &deviceProps);
 
+            /* Get NVRAM file name */
+            Bstr bstrNVRAM;
+            hrc = biosSettings->COMGETTER(NonVolatileStorageFile)(bstrNVRAM.asOutParam());  H();
+
             /* Get graphics mode settings */
             uint32_t u32GraphicsMode = UINT32_MAX;
@@ -1813 +1817 @@
             InsertConfigBytes(pCfg,    "UUID", &HardwareUuid,sizeof(HardwareUuid));
             InsertConfigInteger(pCfg,  "64BitEntry",  f64BitEntry); /* boolean */
+            InsertConfigString(pCfg,   "NvramFile",   bstrNVRAM);
             if (u32GraphicsMode != UINT32_MAX)
                 InsertConfigInteger(pCfg,  "GraphicsMode",  u32GraphicsMode);
@@ -1831 +1836 @@
             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

@@ -467 +467 @@
 
 
-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)
 {
@@ -510 +475 @@
     }
 
+    AutoReadLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);
+    if (strTmp.isEmpty())
+        strTmp = m->pMachine->i_getDefaultNVRAMFilename();
     if (strTmp.isNotEmpty())
         m->pMachine->i_calculateFullPath(strTmp, aNonVolatileStorageFile);
@@ -544 +512 @@
 
     Utf8Str strTmp(m->bd->strNVRAMPath);
-    m->pMachine->i_copyPathRelativeToMachine(strTmp, m->bd->strNVRAMPath);
+    if (strTmp.isNotEmpty())
+        m->pMachine->i_copyPathRelativeToMachine(strTmp, m->bd->strNVRAMPath);
+    if (   m->pMachine->i_getFirmwareType() == FirmwareType_BIOS
+        || m->bd->strNVRAMPath == m->pMachine->i_getDefaultNVRAMFilename())
+        m->bd->strNVRAMPath.setNull();
 
     return S_OK;
@@ -636 +608 @@
 }
 
+void BIOSSettings::i_updateNonVolatileStorageFile(const Utf8Str &aNonVolatileStorageFile)
+{
+    /* sanity */
+    AutoCaller autoCaller(this);
+    AssertComRCReturnVoid(autoCaller.rc());
+
+    AutoReadLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    Utf8Str strTmp(aNonVolatileStorageFile);
+    if (strTmp == m->pMachine->i_getDefaultNVRAMFilename())
+        strTmp.setNull();
+
+    if (strTmp == m->bd->strNVRAMPath)
+        return;
+
+    m->bd.backup();
+    m->bd->strNVRAMPath = strTmp;
+}
+
 /* vi: set tabstop=4 shiftwidth=4 expandtab: */

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

@@ -1145 +1145 @@
     mHWData.backup();
     mHWData->mFirmwareType = aFirmwareType;
+    Utf8Str strNVRAM = i_getDefaultNVRAMFilename();
+    alock.release();
+
+    mBIOSSettings->i_updateNonVolatileStorageFile(strNVRAM);
 
     return S_OK;
@@ -7353 +7357 @@
  * 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.
+ * a specific state just like saved state. Note that this is a relative path.
  */
 
@@ -7362 +7366 @@
 
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-    Utf8Str strNVRAMFilePathAbs = mData->m_strConfigFileFull;
-    strNVRAMFilePathAbs.stripSuffix();
-    strNVRAMFilePathAbs += ".nvram";
-    Utf8Str strNVRAMFilePath;
-    i_copyPathRelativeToMachine(strNVRAMFilePathAbs, strNVRAMFilePath);
+
+    if (mHWData->mFirmwareType == FirmwareType_BIOS)
+        return Utf8Str::Empty;
+
+    Utf8Str strNVRAMFilePath = mData->m_strConfigFileFull;
+    strNVRAMFilePath.stripPath();
+    strNVRAMFilePath.stripSuffix();
+    strNVRAMFilePath += ".nvram";
 
     return strNVRAMFilePath;

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

@@ -2464 +2464 @@
     fLogoFadeOut(true),
     fPXEDebugEnabled(false),
-    fNVRAMEnabled(false),
     ulLogoDisplayTime(0),
     biosBootMenuMode(BIOSBootMenuMode_MessageAndMenu),
@@ -2482 +2481 @@
         && fLogoFadeOut
         && !fPXEDebugEnabled
-        && !fNVRAMEnabled
         && ulLogoDisplayTime == 0
         && biosBootMenuMode == BIOSBootMenuMode_MessageAndMenu
@@ -2504 +2502 @@
             && fLogoFadeOut        == d.fLogoFadeOut
             && fPXEDebugEnabled    == d.fPXEDebugEnabled
-            && fNVRAMEnabled       == d.fNVRAMEnabled
             && ulLogoDisplayTime   == d.ulLogoDisplayTime
             && biosBootMenuMode    == d.biosBootMenuMode
@@ -4729 +4726 @@
                 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)
@@ -6203 +6197 @@
         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);
-        }
+            pelmBIOS->createChild("NVRAM")->setAttribute("path", hw.biosSettings.strNVRAMPath);
     }
 
@@ -7479 +7466 @@
     if (m->sv < SettingsVersion_v1_18)
     {
-        if (   hardwareMachine.biosSettings.fNVRAMEnabled
-            || !hardwareMachine.biosSettings.strNVRAMPath.isEmpty())
+        if (!hardwareMachine.biosSettings.strNVRAMPath.isEmpty())
         {
             m->sv = SettingsVersion_v1_18;