Changeset 107925 in vbox for trunk/src/VBox/Devices

Timestamp:

Jan 23, 2025 5:19:50 PM (4 months ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

167156

Message:

Audio: Added a new, optional config option 'CacheEnabled' (via global/per-VM 'VBoxInternal2/Audio/CacheEnabled') for audio drivers to disable caching code (if any). Currently only supported by DrvHostAudioWasApi, ignored everywhere else. bugref:10844

Location:

trunk/src/VBox/Devices/Audio

Files:

• DrvAudio.cpp (modified) (1 diff)
• DrvHostAudioWasApi.cpp (modified) (19 diffs)

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

@@ -4777 +4777 @@
                                   "InputEnabled|"
                                   "OutputEnabled|"
+                                  "CacheEnabled|"
                                   "DebugEnabled|"
                                   "DebugPathOut|"

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

@@ -266 +266 @@
     RTCRITSECTRW                    CritSectStreamList;
 
+    /** Whether the device cache (\a CacheHead and friends) is being used or not.
+     *  Enabled by default, can be disabled via CFGM. */
+    bool                            fCacheEnabled;
     /** List of cached devices (DRVHOSTAUDIOWASCACHEDEV).
      * Protected by CritSectCache  */
@@ -850 +853 @@
 static void drvHostAudioWasCachePrune(PDRVHOSTAUDIOWAS pThis)
 {
+    AssertReturnVoid(pThis->fCacheEnabled);
+
     /*
      * Prune each direction separately.
@@ -898 +903 @@
 static void drvHostAudioWasCachePurge(PDRVHOSTAUDIOWAS pThis, bool fOnWorker)
 {
+    AssertReturnVoid(pThis->fCacheEnabled);
+
     for (;;)
     {
@@ -1117 +1124 @@
  * If lookup fails, a new entry will be created.
  *
- * @note    Called holding the lock, returning without holding it!
+ * @note    Called holding the cache's lock, returning without holding it!
  */
 static int drvHostAudioWasCacheLookupOrCreateConfig(PDRVHOSTAUDIOWAS pThis, PDRVHOSTAUDIOWASCACHEDEV pDevEntry,
@@ -1123 +1130 @@
                                                     PDRVHOSTAUDIOWASCACHEDEVCFG *ppDevCfg)
 {
+    PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg;
+
     /*
      * Check if we've got a matching config.
      */
-    PDRVHOSTAUDIOWASCACHEDEVCFG pDevCfg = drvHostAudioWasCacheLookupLocked(pDevEntry, &pCfgReq->Props);
-    if (pDevCfg)
-    {
-        *ppDevCfg = pDevCfg;
+    if (pThis->fCacheEnabled)
+    {
+        pDevCfg = drvHostAudioWasCacheLookupLocked(pDevEntry, &pCfgReq->Props);
+        if (pDevCfg)
+        {
+            *ppDevCfg = pDevCfg;
+            RTCritSectLeave(&pThis->CritSectCache);
+            Log8Func(("Config cache hit '%s' on '%ls': %p\n", pDevCfg->szProps, pDevEntry->wszDevId, pDevCfg));
+            return VINF_SUCCESS;
+        }
+
         RTCritSectLeave(&pThis->CritSectCache);
-        Log8Func(("Config cache hit '%s' on '%ls': %p\n", pDevCfg->szProps, pDevEntry->wszDevId, pDevCfg));
-        return VINF_SUCCESS;
-    }
-
-    RTCritSectLeave(&pThis->CritSectCache);
+    }
 
     /*
@@ -1142 +1154 @@
      */
     pDevCfg = (PDRVHOSTAUDIOWASCACHEDEVCFG)RTMemAllocZ(sizeof(*pDevCfg));
-    AssertReturn(pDevCfg, VERR_NO_MEMORY);
+    AssertPtrReturn(pDevCfg, VERR_NO_MEMORY);
     RTListInit(&pDevCfg->ListEntry);
     pDevCfg->pDevEntry         = pDevEntry;
@@ -1152 +1164 @@
     pDevCfg->nsLastUsed        = pDevCfg->nsCreated;
 
-    uint32_t cCacheEntries;
-    if (pDevCfg->pDevEntry->enmDir == PDMAUDIODIR_IN)
-        cCacheEntries = ASMAtomicIncU32(&pThis->cCacheEntriesIn);
-    else
-        cCacheEntries = ASMAtomicIncU32(&pThis->cCacheEntriesOut);
-    if (cCacheEntries > VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES)
-    {
-        LogFlowFunc(("Trigger cache pruning.\n"));
-        int rc2 = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, NULL /*pStream*/,
-                                                              DRVHOSTAUDIOWAS_DO_PRUNE_CACHE, NULL /*pvUser*/);
-        AssertRCStmt(rc2, drvHostAudioWasCachePrune(pThis));
+    if (pThis->fCacheEnabled)
+    {
+        uint32_t cCacheEntries;
+        if (pDevCfg->pDevEntry->enmDir == PDMAUDIODIR_IN)
+            cCacheEntries = ASMAtomicIncU32(&pThis->cCacheEntriesIn);
+        else
+            cCacheEntries = ASMAtomicIncU32(&pThis->cCacheEntriesOut);
+        if (cCacheEntries > VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES)
+        {
+            LogFlowFunc(("Trigger cache pruning.\n"));
+            int rc2 = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, NULL /*pStream*/,
+                                                                  DRVHOSTAUDIOWAS_DO_PRUNE_CACHE, NULL /*pvUser*/);
+            AssertRCStmt(rc2, drvHostAudioWasCachePrune(pThis));
+        }
     }
 
@@ -1221 +1236 @@
     if (SUCCEEDED(hrc))
     {
-        LogRel2(("WasAPI: Checking for cached device '%ls' ...\n", pwszDevId));
-
-        size_t cwcDevId = RTUtf16Len(pwszDevId);
-
-        /*
-         * The cache has two levels, so first the device entry.
-         */
-        PDRVHOSTAUDIOWASCACHEDEV pDevEntry, pDevEntryNext;
-        RTCritSectEnter(&pThis->CritSectCache);
-        RTListForEachSafe(&pThis->CacheHead, pDevEntry, pDevEntryNext, DRVHOSTAUDIOWASCACHEDEV, ListEntry)
-        {
-            if (   pDevEntry->cwcDevId == cwcDevId
-                && pDevEntry->enmDir   == pCfgReq->enmDir
-                && RTUtf16Cmp(pDevEntry->wszDevId, pwszDevId) == 0)
+        PDRVHOSTAUDIOWASCACHEDEV pDevEntry;
+        size_t                   cwcDevId = RTUtf16Len(pwszDevId);
+
+        if (pThis->fCacheEnabled)
+        {
+            LogRel2(("WasAPI: Checking for cached device '%ls' ...\n", pwszDevId));
+
+            /*
+             * The cache has two levels, so first the device entry.
+             */
+            PDRVHOSTAUDIOWASCACHEDEV pDevEntryNext;
+            RTCritSectEnter(&pThis->CritSectCache);
+            RTListForEachSafe(&pThis->CacheHead, pDevEntry, pDevEntryNext, DRVHOSTAUDIOWASCACHEDEV, ListEntry)
             {
-                /*
-                 * Cache hit -- here we now need to also check if the device interface we want to look up
-                 * actually matches the one we have in the cache entry.
-                 *
-                 * If it doesn't, bail out and add a new device entry to the cache with the new interface below then.
-                 *
-                 * This is needed when switching audio interfaces and the device interface becomes invalid via
-                 * AUDCLNT_E_DEVICE_INVALIDATED.  See @bugref{10503}
-                 */
-                if (pDevEntry->pIDevice != pIDevice)
+                if (   pDevEntry->cwcDevId == cwcDevId
+                    && pDevEntry->enmDir   == pCfgReq->enmDir
+                    && RTUtf16Cmp(pDevEntry->wszDevId, pwszDevId) == 0)
                 {
-                    LogRel2(("WasAPI: Cache hit for device '%ls': Stale interface (new: %p, old: %p)\n",
-                              pDevEntry->wszDevId, pIDevice, pDevEntry->pIDevice));
-
-                    LogRel(("WasAPI: Stale audio interface '%ls' detected!\n", pDevEntry->wszDevId));
-                    break;
+                    /*
+                     * Cache hit -- here we now need to also check if the device interface we want to look up
+                     * actually matches the one we have in the cache entry.
+                     *
+                     * If it doesn't, bail out and add a new device entry to the cache with the new interface below then.
+                     *
+                     * This is needed when switching audio interfaces and the device interface becomes invalid via
+                     * AUDCLNT_E_DEVICE_INVALIDATED.  See @bugref{10503}
+                     */
+                    if (pDevEntry->pIDevice != pIDevice)
+                    {
+                        LogRel2(("WasAPI: Cache hit for device '%ls': Stale interface (new: %p, old: %p)\n",
+                                  pDevEntry->wszDevId, pIDevice, pDevEntry->pIDevice));
+
+                        LogRel(("WasAPI: Stale audio interface '%ls' detected!\n", pDevEntry->wszDevId));
+                        break;
+                    }
+
+                    LogRel2(("WasAPI: Cache hit for device '%ls' (%p)\n", pwszDevId, pIDevice));
+
+                    CoTaskMemFree(pwszDevId);
+                    pwszDevId = NULL;
+
+                    return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry, pCfgReq, fOnWorker, ppDevCfg);
                 }
-
-                LogRel2(("WasAPI: Cache hit for device '%ls' (%p)\n", pwszDevId, pIDevice));
-
-                CoTaskMemFree(pwszDevId);
-                pwszDevId = NULL;
-
-                return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry, pCfgReq, fOnWorker, ppDevCfg);
             }
-        }
-        RTCritSectLeave(&pThis->CritSectCache);
-
-        LogRel2(("WasAPI: Cache miss for device '%ls' (%p)\n", pwszDevId, pIDevice));
+            RTCritSectLeave(&pThis->CritSectCache);
+
+            LogRel2(("WasAPI: Cache miss for device '%ls' (%p)\n", pwszDevId, pIDevice));
+        }
+        else
+            LogRel2(("WasAPI: Cache disabled for device '%ls' (%p)\n", pwszDevId, pIDevice));
 
         /*
@@ -1272 +1293 @@
         if (pDevEntry)
         {
-            pIDevice->AddRef();
+            if (pThis->fCacheEnabled)
+                pIDevice->AddRef();
             pDevEntry->pIDevice                   = pIDevice;
             pDevEntry->enmDir                     = pCfgReq->enmDir;
@@ -1287 +1309 @@
             pwszDevId = NULL;
 
-            /*
-             * Before adding the device, check that someone didn't race us adding it.
-             */
-            RTCritSectEnter(&pThis->CritSectCache);
-            PDRVHOSTAUDIOWASCACHEDEV pDevEntry2;
-            RTListForEach(&pThis->CacheHead, pDevEntry2, DRVHOSTAUDIOWASCACHEDEV, ListEntry)
+            if (pThis->fCacheEnabled)
             {
-                if (   pDevEntry2->cwcDevId == cwcDevId
-                    /* Note: We have to compare the device interface here as well, as a cached device entry might
-                     * have a stale audio interface for the same device. In such a case a new device entry will be created below. */
-                    && pDevEntry2->pIDevice == pIDevice
-                    && pDevEntry2->enmDir   == pCfgReq->enmDir
-                    && RTUtf16Cmp(pDevEntry2->wszDevId, pDevEntry->wszDevId) == 0)
+                /*
+                 * Before adding the device to the cache, check that someone didn't race us adding it.
+                 */
+                RTCritSectEnter(&pThis->CritSectCache);
+                PDRVHOSTAUDIOWASCACHEDEV pDevEntry2;
+                RTListForEach(&pThis->CacheHead, pDevEntry2, DRVHOSTAUDIOWASCACHEDEV, ListEntry)
                 {
-                    pIDevice->Release();
-                    RTMemFree(pDevEntry);
-                    pDevEntry = NULL;
-
-                    LogRel2(("WasAPI: Lost race adding device '%ls': %p\n", pDevEntry2->wszDevId, pDevEntry2));
-                    return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry2, pCfgReq, fOnWorker, ppDevCfg);
+                    if (   pDevEntry2->cwcDevId == cwcDevId
+                        /* Note: We have to compare the device interface here as well, as a cached device entry might
+                         * have a stale audio interface for the same device. In such a case a new device entry will be created below. */
+                        && pDevEntry2->pIDevice == pIDevice
+                        && pDevEntry2->enmDir   == pCfgReq->enmDir
+                        && RTUtf16Cmp(pDevEntry2->wszDevId, pDevEntry->wszDevId) == 0)
+                    {
+                        pIDevice->Release();
+                        RTMemFree(pDevEntry);
+                        pDevEntry = NULL;
+
+                        LogRel2(("WasAPI: Lost race adding device '%ls': %p\n", pDevEntry2->wszDevId, pDevEntry2));
+                        return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry2, pCfgReq, fOnWorker, ppDevCfg);
+                    }
                 }
+                RTListPrepend(&pThis->CacheHead, &pDevEntry->ListEntry);
+
+                LogRel2(("WasAPI: Added device '%ls' to cache: %p\n", pDevEntry->wszDevId, pDevEntry));
             }
-            RTListPrepend(&pThis->CacheHead, &pDevEntry->ListEntry);
-
-            LogRel2(("WasAPI: Added device '%ls' to cache: %p\n", pDevEntry->wszDevId, pDevEntry));
+
             return drvHostAudioWasCacheLookupOrCreateConfig(pThis, pDevEntry, pCfgReq, fOnWorker, ppDevCfg);
         }
@@ -1337 +1363 @@
     if (SUCCEEDED(hrc))
     {
-        Log8Func(("Putting %p/'%s' back\n", pDevCfg, pDevCfg->szProps));
-        RTCritSectEnter(&pThis->CritSectCache);
-        RTListAppend(&pDevCfg->pDevEntry->ConfigList, &pDevCfg->ListEntry);
-        uint32_t const cEntries = pDevCfg->pDevEntry->enmDir == PDMAUDIODIR_IN ? pThis->cCacheEntriesIn : pThis->cCacheEntriesOut;
-        RTCritSectLeave(&pThis->CritSectCache);
-
-        /* Trigger pruning if we're over the threshold. */
-        if (cEntries > VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES)
-        {
-            LogFlowFunc(("Trigger cache pruning.\n"));
-            int rc2 = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, NULL /*pStream*/,
-                                                                  DRVHOSTAUDIOWAS_DO_PRUNE_CACHE, NULL /*pvUser*/);
-            AssertRCStmt(rc2, drvHostAudioWasCachePrune(pThis));
+        if (pThis->fCacheEnabled)
+        {
+            Log8Func(("Putting %p/'%s' back\n", pDevCfg, pDevCfg->szProps));
+            RTCritSectEnter(&pThis->CritSectCache);
+            RTListAppend(&pDevCfg->pDevEntry->ConfigList, &pDevCfg->ListEntry);
+            uint32_t const cEntries = pDevCfg->pDevEntry->enmDir == PDMAUDIODIR_IN ? pThis->cCacheEntriesIn : pThis->cCacheEntriesOut;
+            RTCritSectLeave(&pThis->CritSectCache);
+
+            /* Trigger pruning if we're over the threshold. */
+            if (cEntries > VBOX_WASAPI_MAX_TOTAL_CONFIG_ENTRIES)
+            {
+                LogFlowFunc(("Trigger cache pruning.\n"));
+                int rc2 = pThis->pIHostAudioPort->pfnDoOnWorkerThread(pThis->pIHostAudioPort, NULL /*pStream*/,
+                                                                      DRVHOSTAUDIOWAS_DO_PRUNE_CACHE, NULL /*pvUser*/);
+                AssertRCStmt(rc2, drvHostAudioWasCachePrune(pThis));
+            }
         }
     }
@@ -1915 +1944 @@
             Assert(pStream == NULL);
             Assert(pvUser == NULL);
+            Assert(pThis->fCacheEnabled);
             drvHostAudioWasCachePurge(pThis, true /*fOnWorker*/);
             break;
@@ -1921 +1951 @@
             Assert(pStream == NULL);
             Assert(pvUser == NULL);
+            Assert(pThis->fCacheEnabled);
             drvHostAudioWasCachePrune(pThis);
             break;
@@ -3030 +3061 @@
     }
 #else
-    if (!RTListIsEmpty(&pThis->CacheHead) && pThis->pIHostAudioPort)
+    if (   pThis->fCacheEnabled
+        && !RTListIsEmpty(&pThis->CacheHead) && pThis->pIHostAudioPort)
     {
         int rc = RTSemEventMultiCreate(&pThis->hEvtCachePurge);
@@ -3092 +3124 @@
 #endif
 
-    if (RTCritSectIsInitialized(&pThis->CritSectCache))
-    {
-        drvHostAudioWasCachePurge(pThis, false /*fOnWorker*/);
+    if (pThis->fCacheEnabled)
+    {
+        if (RTCritSectIsInitialized(&pThis->CritSectCache))
+        {
+            drvHostAudioWasCachePurge(pThis, false /*fOnWorker*/);
+            if (pThis->hEvtCachePurge != NIL_RTSEMEVENTMULTI)
+                RTSemEventMultiWait(pThis->hEvtCachePurge, RT_MS_30SEC);
+            RTCritSectDelete(&pThis->CritSectCache);
+        }
+
         if (pThis->hEvtCachePurge != NIL_RTSEMEVENTMULTI)
-            RTSemEventMultiWait(pThis->hEvtCachePurge, RT_MS_30SEC);
-        RTCritSectDelete(&pThis->CritSectCache);
-    }
-
-    if (pThis->hEvtCachePurge != NIL_RTSEMEVENTMULTI)
-    {
-        RTSemEventMultiDestroy(pThis->hEvtCachePurge);
-        pThis->hEvtCachePurge = NIL_RTSEMEVENTMULTI;
+        {
+            RTSemEventMultiDestroy(pThis->hEvtCachePurge);
+            pThis->hEvtCachePurge = NIL_RTSEMEVENTMULTI;
+        }
+    }
+    else
+    {
+        Assert(pThis->cCacheEntriesIn == 0);
+        Assert(pThis->cCacheEntriesOut == 0);
     }
 
@@ -3181 +3221 @@
      * Validate and read the configuration.
      */
-    PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, "VmName|VmUuid|InputDeviceID|OutputDeviceID", "");
+    PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, "VmName|VmUuid|InputDeviceID|OutputDeviceID|CacheEnabled", "");
 
     char szTmp[1024];
@@ -3200 +3240 @@
     }
 
+    /* Caching is enabled by default. */
+    rc = pHlp->pfnCFGMQueryBoolDef(pCfg, "CacheEnabled", &pThis->fCacheEnabled, true);
+    AssertMsgRCReturn(rc, ("Confguration error: Failed to read \"CacheEnabled\" as boolean: rc=%Rrc\n", rc), rc);
+
     AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
                     ("Configuration error: Not possible to attach anything to this driver!\n"),
                     VERR_PDM_DRVINS_NO_ATTACH);
 
+    LogRel2(("WasAPI: Caching device configuration entries is %s\n", pThis->fCacheEnabled ? "enabled" : "disabled"));
+
     /*
      * Initialize the critical sections early.
@@ -3210 +3256 @@
     AssertRCReturn(rc, rc);
 
-    rc = RTCritSectInit(&pThis->CritSectCache);
-    AssertRCReturn(rc, rc);
+    if (pThis->fCacheEnabled)
+    {
+        rc = RTCritSectInit(&pThis->CritSectCache);
+        AssertRCReturn(rc, rc);
+    }
 
     /*
@@ -3322 +3371 @@
      * Prime the cache.
      */
-    drvHostAudioWasCacheFill(pThis);
+    if (pThis->fCacheEnabled)
+        drvHostAudioWasCacheFill(pThis);
 
     return VINF_SUCCESS;