Changeset 105627 in vbox

Timestamp:

Aug 8, 2024 3:58:25 PM (6 months ago)

Author:

vboxsync

Message:

Main/NvramStore: Don't (debug) assert when getting the UEFI NVRAM store for non-UEFI VMs; some IPRT APIs being used don't like empty strings (paths) and assert in such cases. Be a bit more information wrt returning errors via the API about what's going on.

Location:

trunk/src/VBox/Main

Files:

• include/NvramStoreImpl.h (modified) (1 diff)
• src-all/NvramStoreImpl.cpp (modified) (14 diffs)

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

@@ -85 +85 @@
 #endif
 
+    int i_getNonVolatileStorageFile(com::Utf8Str &aNonVolatileStorageFile);
     com::Utf8Str i_getNonVolatileStorageFile();
     void i_updateNonVolatileStorageFile(const com::Utf8Str &aNonVolatileStorageFile);

trunk/src/VBox/Main/src-all/NvramStoreImpl.cpp

@@ -354 +354 @@
 }
 
-
 HRESULT NvramStore::getNonVolatileStorageFile(com::Utf8Str &aNonVolatileStorageFile)
 {
-#ifndef VBOX_COM_INPROC
-    Utf8Str strTmp;
-    {
-        AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-        strTmp = m->bd->strNvramPath;
-    }
-
-    AutoReadLock mlock(m->pParent COMMA_LOCKVAL_SRC_POS);
-    if (strTmp.isEmpty())
-        strTmp = m->pParent->i_getDefaultNVRAMFilename();
-    if (strTmp.isNotEmpty())
-        m->pParent->i_calculateFullPath(strTmp, aNonVolatileStorageFile);
-#else
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-    aNonVolatileStorageFile = m->bd->strNvramPath;
-#endif
+    int vrc = i_getNonVolatileStorageFile(aNonVolatileStorageFile);
+    if (RT_FAILURE(vrc))
+        return setError(E_FAIL, tr("This machine does not have an NVRAM store file"));
 
     return S_OK;
@@ -382 +368 @@
 #ifndef VBOX_COM_INPROC
     Utf8Str strPath;
-    NvramStore::getNonVolatileStorageFile(strPath);
+    int vrc = i_getNonVolatileStorageFile(strPath);
+    if (RT_FAILURE(vrc))
+        return setError(E_FAIL, tr("No NVRAM store file found"));
+
+    HRESULT hrc;
 
     /* We need a write lock because of the lazy initialization. */
@@ -388 +378 @@
 
     /* Check if we have to create the UEFI variable store object */
-    HRESULT hrc = S_OK;
     if (!m->pUefiVarStore)
     {
@@ -394 +383 @@
         if (!m->mapNvram.size())
         {
-            int vrc = i_loadStore(strPath.c_str());
+            vrc = i_loadStore(strPath.c_str());
             if (RT_FAILURE(vrc))
                 hrc = setError(E_FAIL, tr("Loading the NVRAM store failed (%Rrc)\n"), vrc);
@@ -408 +397 @@
             }
             else
-                hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("The UEFI NVRAM file is not existing for this machine."));
+                hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("The UEFI NVRAM file is not existing for this machine"));
         }
     }
@@ -464 +453 @@
     if (FAILED(adep.hrc())) return adep.hrc();
 
-    Utf8Str strPath;
-    NvramStore::getNonVolatileStorageFile(strPath);
+    Utf8Str strPath = i_getNonVolatileStorageFile();
 
     /* We need a write lock because of the lazy initialization. */
@@ -526 +514 @@
 
 
+/**
+ * Returns the path of the non-volatile storage file.
+ *
+ * @returns VBox status code.
+ * @retval  VERR_FILE_NOT_FOUND if the storage file was not found.
+ * @param   aNonVolatileStorageFile   Returns path to non-volatile stroage file on success.
+ */
+int NvramStore::i_getNonVolatileStorageFile(com::Utf8Str &aNonVolatileStorageFile)
+{
+#ifndef VBOX_COM_INPROC
+    Utf8Str strTmp;
+    {
+        AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+        strTmp = m->bd->strNvramPath;
+    }
+
+    AutoReadLock mlock(m->pParent COMMA_LOCKVAL_SRC_POS);
+    if (strTmp.isEmpty())
+        strTmp = m->pParent->i_getDefaultNVRAMFilename();
+    if (strTmp.isNotEmpty())
+        m->pParent->i_calculateFullPath(strTmp, aNonVolatileStorageFile);
+#else
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+    aNonVolatileStorageFile = m->bd->strNvramPath;
+#endif
+
+    if (aNonVolatileStorageFile.isEmpty())
+        return VERR_FILE_NOT_FOUND;
+
+    return VINF_SUCCESS;
+}
+
+
+/**
+ * Returns the path of the non-volatile stroage file.
+ *
+ * @returns Path to non-volatile stroage file. Empty if not supported / found.
+ *
+ * @note    Convenience function for machine object or other callers.
+ */
 Utf8Str NvramStore::i_getNonVolatileStorageFile()
 {
@@ -532 +560 @@
 
     Utf8Str strTmp;
-    NvramStore::getNonVolatileStorageFile(strTmp);
+    /* rc ignored */ i_getNonVolatileStorageFile(strTmp);
     return strTmp;
 }
@@ -695 +723 @@
 int NvramStore::i_loadStore(const char *pszPath)
 {
+    AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
+    AssertReturn(*pszPath, VERR_PATH_ZERO_LENGTH); /* IPRT below doesn't like empty strings. */
+
     uint64_t cbStore = 0;
     int vrc = RTFileQuerySizeByPath(pszPath, &cbStore);
@@ -912 +943 @@
     int vrc = VINF_SUCCESS;
 
-    Utf8Str strTmp;
-    NvramStore::getNonVolatileStorageFile(strTmp);
+    Utf8Str strPath = i_getNonVolatileStorageFile();
 
     /*
@@ -920 +950 @@
      * see @bugref{10191}.
      */
-    if (strTmp.isNotEmpty())
+    if (strPath.isNotEmpty())
     {
         /*
@@ -937 +967 @@
 
             RTVFSIOSTREAM hVfsIosDst;
-            vrc = RTVfsIoStrmOpenNormal(strTmp.c_str(), RTFILE_O_CREATE_REPLACE | RTFILE_O_WRITE | RTFILE_O_DENY_NONE,
+            vrc = RTVfsIoStrmOpenNormal(strPath.c_str(), RTFILE_O_CREATE_REPLACE | RTFILE_O_WRITE | RTFILE_O_DENY_NONE,
                                         &hVfsIosDst);
             if (RT_SUCCESS(vrc))
@@ -972 +1002 @@
         }
         else if (m->mapNvram.size())
-            vrc = i_saveStoreAsTar(strTmp.c_str());
+            vrc = i_saveStoreAsTar(strPath.c_str());
         /* else: No NVRAM content to store so we are done here. */
     }
@@ -1084 +1114 @@
         }
         else
-            hrc = setError(E_FAIL, tr("Opening the UEFI variable store failed (%Rrc)."), vrc);
+            hrc = setError(E_FAIL, tr("Opening the UEFI variable store failed (%Rrc)"), vrc);
     }
     else
-        hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("The UEFI NVRAM file is not existing for this machine."));
+        hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("The UEFI NVRAM file is not existing for this machine"));
 
     return hrc;