Changeset 89230 in vbox

Timestamp:

May 23, 2021 1:21:26 AM (4 years ago)

Author:

vboxsync

Message:

AudioTest: Don't take the RTSystemQueryOSInfo status code dead serious, it's a robust API, overflows can happen whatever buffer size you give it (it was toooo small). Just use the filename buffer, it's a lot bigger. bugref:10008

Location:

trunk/src/VBox/Devices/Audio

Files:

• AudioTest.cpp (modified) (5 diffs)
• AudioTest.h (modified) (1 diff)

trunk/src/VBox/Devices/Audio/AudioTest.cpp

@@ -334 +334 @@
 static int audioTestManifestWriteV(PAUDIOTESTSET pSet, const char *pszFormat, va_list args)
 {
+    /** @todo r=bird: Use RTStrmOpen + RTStrmPrintf instead of this slow
+     *        do-it-all-yourself stuff. */
     char *psz = NULL;
     if (RTStrAPrintfV(&psz, pszFormat, args) == -1)
@@ -396 +398 @@
 
     /** @todo Keep it as simple as possible for now. Improve this later. */
-    int rc = audioTestManifestWrite(pSet, "[");
-    AssertRC(rc);
-
-    rc = audioTestManifestWriteV(pSet, pszSection, va);
-    AssertRC(rc);
-
-    rc = audioTestManifestWrite(pSet, "]\n");
-    AssertRC(rc);
+    int rc = audioTestManifestWrite(pSet, "[%N]", pszSection, &va);
 
     va_end(va);
@@ -604 +599 @@
  * @returns VBox status code.
  * @param   pSet                Test set to create.
- * @param   pszPath             Absolute path to use for the test set's temporary directory.
- *                              If NULL, the OS' temporary directory will be used.
+ * @param   pszPath             Where to store the set set data.  If NULL, the
+ *                              temporary directory will be used.
  * @param   pszTag              Tag name to use for this test set.
  */
@@ -615 +610 @@
     AssertRCReturn(rc, rc);
 
+    /*
+     * Test set directory.
+     */
     if (pszPath)
     {
-        rc = RTStrCopy(pSet->szPathAbs, sizeof(pSet->szPathAbs), pszPath);
+        rc = RTPathAbs(pszPath, pSet->szPathAbs, sizeof(pSet->szPathAbs));
         AssertRCReturn(rc, rc);
 
@@ -626 +624 @@
     AssertRCReturn(rc, rc);
 
-    if (RT_SUCCESS(rc))
-    {
-        char szManifest[RTPATH_MAX];
-        rc = RTStrCopy(szManifest, sizeof(szManifest), pSet->szPathAbs);
-        AssertRCReturn(rc, rc);
-
-        rc = RTPathAppend(szManifest, sizeof(szManifest), AUDIOTEST_MANIFEST_FILE_STR);
-        AssertRCReturn(rc, rc);
-
-        rc = RTFileOpen(&pSet->f.hFile, szManifest,
-                        RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_WRITE);
-        AssertRCReturn(rc, rc);
-
-        rc = audioTestManifestWriteSectionHdr(pSet, "header");
-        AssertRCReturn(rc, rc);
-
-        rc = audioTestManifestWrite(pSet, "magic=vkat_ini\n"); /* VKAT Manifest, .INI-style. */
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWrite(pSet, "ver=%d\n", AUDIOTEST_MANIFEST_VER);
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWrite(pSet, "tag=%s\n", pSet->szTag);
-        AssertRCReturn(rc, rc);
-
-        char szVal[64];
-        RTTIMESPEC time;
-        if (!RTTimeSpecToString(RTTimeNow(&time), szVal, sizeof(szVal)))
-            AssertFailedReturn(VERR_BUFFER_OVERFLOW);
-
-        rc = audioTestManifestWrite(pSet, "date_created=%s\n", szVal);
-        AssertRCReturn(rc, rc);
-
-        rc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szVal, sizeof(szVal));
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWrite(pSet, "os_product=%s\n", szVal);
-        AssertRCReturn(rc, rc);
-        rc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szVal, sizeof(szVal));
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWrite(pSet, "os_rel=%s\n", szVal);
-        AssertRCReturn(rc, rc);
-        rc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szVal, sizeof(szVal));
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWrite(pSet, "os_ver=%s\n", szVal);
-        AssertRCReturn(rc, rc);
-        rc = audioTestManifestWrite(pSet, "vbox_ver=%s r%u %s (%s %s)\n",
-                                      VBOX_VERSION_STRING, RTBldCfgRevision(),
-                                      RTBldCfgTargetDotArch(), __DATE__, __TIME__);
-        AssertRCReturn(rc, rc);
-
-        rc = audioTestManifestWrite(pSet, "test_count=");
-        AssertRCReturn(rc, rc);
-        pSet->offTestCount = audioTestManifestGetOffsetAbs(pSet);
-        rc = audioTestManifestWrite(pSet, "0000\n"); /* A bit messy, but does the trick for now. */
-        AssertRCReturn(rc, rc);
-
-        pSet->enmMode = AUDIOTESTSETMODE_TEST;
-    }
+    /*
+     * Create the manifest file.
+     */
+    char szTmp[RTPATH_MAX];
+    rc = RTPathJoin(szTmp, sizeof(szTmp), pSet->szPathAbs, AUDIOTEST_MANIFEST_FILE_STR);
+    AssertRCReturn(rc, rc);
+
+    rc = RTFileOpen(&pSet->f.hFile, szTmp, RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_WRITE);
+    AssertRCReturn(rc, rc);
+
+    rc = audioTestManifestWriteSectionHdr(pSet, "header");
+    AssertRCReturn(rc, rc);
+
+    rc = audioTestManifestWrite(pSet, "magic=vkat_ini\n"); /* VKAT Manifest, .INI-style. */
+    AssertRCReturn(rc, rc);
+    rc = audioTestManifestWrite(pSet, "ver=%d\n", AUDIOTEST_MANIFEST_VER);
+    AssertRCReturn(rc, rc);
+    rc = audioTestManifestWrite(pSet, "tag=%s\n", pSet->szTag);
+    AssertRCReturn(rc, rc);
+
+    AssertCompile(sizeof(szTmp) > RTTIME_STR_LEN);
+    RTTIMESPEC Now;
+    rc = audioTestManifestWrite(pSet, "date_created=%s\n", RTTimeSpecToString(RTTimeNow(&Now), szTmp, sizeof(szTmp)));
+    AssertRCReturn(rc, rc);
+
+    RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szTmp, sizeof(szTmp)); /* do NOT return on failure. */
+    rc = audioTestManifestWrite(pSet, "os_product=%s\n", szTmp);
+    AssertRCReturn(rc, rc);
+
+    RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szTmp, sizeof(szTmp)); /* do NOT return on failure. */
+    rc = audioTestManifestWrite(pSet, "os_rel=%s\n", szTmp);
+    AssertRCReturn(rc, rc);
+
+    RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szTmp, sizeof(szTmp)); /* do NOT return on failure. */
+    rc = audioTestManifestWrite(pSet, "os_ver=%s\n", szTmp);
+    AssertRCReturn(rc, rc);
+
+    rc = audioTestManifestWrite(pSet, "vbox_ver=%s r%u %s (%s %s)\n",
+                                VBOX_VERSION_STRING, RTBldCfgRevision(), RTBldCfgTargetDotArch(), __DATE__, __TIME__);
+    AssertRCReturn(rc, rc);
+
+    rc = audioTestManifestWrite(pSet, "test_count=");
+    AssertRCReturn(rc, rc);
+    pSet->offTestCount = audioTestManifestGetOffsetAbs(pSet);
+    rc = audioTestManifestWrite(pSet, "0000\n"); /* A bit messy, but does the trick for now. */
+    AssertRCReturn(rc, rc);
+
+    pSet->enmMode = AUDIOTESTSETMODE_TEST;
 
     return rc;

trunk/src/VBox/Devices/Audio/AudioTest.h

@@ -232 +232 @@
     union
     {
+        /** @todo r=bird: RTSTREAM not RTFILE.  That means you don't have to check
+         *        every write status code and it's buffered and thus faster.  Also,
+         *        you don't have to re-invent fprintf-style RTFileWrite wrappers. */
         RTFILE       hFile;
         RTINIFILE    hIniFile;