Changeset 88059 in vbox

Timestamp:

Mar 9, 2021 3:33:52 PM (4 years ago)

Author:

vboxsync

Message:

Audio: Adding a magic to PDMAUDIOSTREAM. bugref:9890

Location:

trunk

Files:

• include/VBox/vmm/pdmaudioifs.h (modified) (5 diffs)
• src/VBox/Devices/Audio/DrvAudio.cpp (modified) (14 diffs)

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -1244 +1244 @@
 typedef struct PDMAUDIOSTREAM *PPDMAUDIOSTREAMCTX;
 
+/** @name PDMAUDIOSTREAM_WARN_FLAGS_XXX
+ * @{ */
 /** No stream warning flags set. */
 #define PDMAUDIOSTREAM_WARN_FLAGS_NONE          0
 /** Warned about a disabled stream. */
 #define PDMAUDIOSTREAM_WARN_FLAGS_DISABLED      RT_BIT(0)
+/** @} */
 
 /**
@@ -1254 +1257 @@
 typedef struct PDMAUDIOSTREAM
 {
-    /** List node.
-     * @todo s/Node/ListEntry/ */
-    RTLISTNODE              Node;
-    /** @todo add magic (some jazz pianist). */
+    /** Magic value (PDMAUDIOSTREAM_MAGIC). */
+    uint32_t                uMagic;
+    /** Size (in bytes) of the backend-specific stream data. */
+    uint32_t                cbBackend;
+    /** List entry (some DrvAudio internal list). */
+    RTLISTNODE              ListEntry;
     /** Number of references to this stream.
      *  Only can be destroyed when the reference count reaches 0. */
@@ -1264 +1269 @@
     uint32_t                cTriesReInit;
     /** Warnings shown already in the release log.
-     *  See PDMAUDIOSTREAM_WARN_FLAGS_XXX defines. */
+     *  See PDMAUDIOSTREAM_WARN_FLAGS_XXX. */
     uint32_t                fWarningsShown;
     /** Stream status flag. */
@@ -1295 +1300 @@
      *  That way the backends do not have access to the audio connector's data. */
     void                   *pvBackend;
-    /** Size (in bytes) of the backend-specific stream data. */
-    size_t                  cbBackend;
 
     /** Name of this stream. */
@@ -1308 +1311 @@
     } RT_UNION_NM(u);
 } PDMAUDIOSTREAM;
+
+/** Magic value for PDMAUDIOSTREAM. (Ahmad Jamal)   */
+#define PDMAUDIOSTREAM_MAGIC    UINT32_C(0x19300702)
 
 

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

@@ -564 +564 @@
      * Init host stream.
      */
+    pStream->uMagic = PDMAUDIOSTREAM_MAGIC;
 
     /* Set the host's default audio data layout. */
@@ -762 +763 @@
 static void drvAudioStreamFree(PPDMAUDIOSTREAM pStream)
 {
-    if (!pStream)
-        return;
-
-    LogFunc(("[%s]\n", pStream->szName));
-
-    if (pStream->pvBackend)
-    {
-        Assert(pStream->cbBackend);
-        RTMemFree(pStream->pvBackend);
-        pStream->pvBackend = NULL;
-    }
-
-    RTMemFree(pStream);
-    pStream = NULL;
+    if (pStream)
+    {
+        LogFunc(("[%s]\n", pStream->szName));
+        Assert(pStream->uMagic == PDMAUDIOSTREAM_MAGIC);
+        pStream->uMagic = ~PDMAUDIOSTREAM_MAGIC;
+
+        if (pStream->pvBackend)
+        {
+            Assert(pStream->cbBackend);
+            RTMemFree(pStream->pvBackend);
+            pStream->pvBackend = NULL;
+        }
+
+        RTMemFree(pStream);
+    }
 }
 
@@ -794 +796 @@
     /* Mark all host streams to re-initialize. */
     PPDMAUDIOSTREAM pStream;
-    RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
+    RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, ListEntry)
     {
         pStream->fStatus |= PDMAUDIOSTREAMSTS_FLAGS_PENDING_REINIT;
@@ -2295 +2297 @@
     {
         PPDMAUDIOSTREAM pStream;
-        RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
+        RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, ListEntry)
             drvAudioStreamControlInternal(pThis, pStream, enmCmd);
     }
@@ -2537 +2539 @@
  * @interface_method_impl{PDMIAUDIOCONNECTOR,pfnStreamCreate}
  */
-static DECLCALLBACK(int) drvAudioStreamCreate(PPDMIAUDIOCONNECTOR pInterface,
-                                              PPDMAUDIOSTREAMCFG pCfgHost, PPDMAUDIOSTREAMCFG pCfgGuest,
-                                              PPDMAUDIOSTREAM *ppStream)
+static DECLCALLBACK(int) drvAudioStreamCreate(PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAMCFG pCfgHost,
+                                              PPDMAUDIOSTREAMCFG pCfgGuest, PPDMAUDIOSTREAM *ppStream)
 {
     AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
@@ -2562 +2563 @@
 #define RC_BREAK(x) { rc = x; break; }
 
-    do
+    do /* this is not a loop, just a construct to make the code more difficult to follow. */
     {
         if (   !DrvAudioHlpStreamCfgIsValid(pCfgHost)
@@ -2599 +2600 @@
             cbHstStrm = pThis->BackendCfg.cbStreamOut;
         }
+        AssertBreakStmt(cbHstStrm < _16M, rc = VERR_OUT_OF_RANGE);
 
         /*
          * Allocate and initialize common state.
          */
-
         pStream = (PPDMAUDIOSTREAM)RTMemAllocZ(sizeof(PDMAUDIOSTREAM));
         AssertPtrBreakStmt(pStream, rc = VERR_NO_MEMORY);
@@ -2623 +2624 @@
          * Allocate and init backend-specific data.
          */
-
         if (cbHstStrm) /* High unlikely that backends do not have an own space for data, but better check. */
         {
             pStream->pvBackend = RTMemAllocZ(cbHstStrm);
-            AssertPtrBreakStmt(pStream->pvBackend, rc = VERR_NO_MEMORY);
-
-            pStream->cbBackend = cbHstStrm;
+            AssertBreakStmt(pStream->pvBackend, rc = VERR_NO_MEMORY);
+
+            pStream->cbBackend = (uint32_t)cbHstStrm;
         }
 
@@ -2635 +2635 @@
          * Try to init the rest.
          */
-
         rc = drvAudioStreamInitInternal(pThis, pStream, pCfgHost, pCfgGuest);
-        if (RT_FAILURE(rc))
-            break;
 
     } while (0);
@@ -2660 +2657 @@
     {
         /* Append the stream to our stream list. */
-        RTListAppend(&pThis->lstStreams, &pStream->Node);
+        RTListAppend(&pThis->lstStreams, &pStream->ListEntry);
 
         /* Set initial reference counts. */
@@ -2777 +2774 @@
 
         PPDMAUDIOSTREAM pStream;
-        RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
+        RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, ListEntry)
         {
             if (pStream->enmDir != enmDir) /* Skip unwanted streams. */
@@ -3085 +3082 @@
 {
     AssertPtrReturn(pInterface, VERR_INVALID_POINTER);
-    AssertPtrReturn(pStream,    VERR_INVALID_POINTER);
-
     PDRVAUDIO pThis = PDMIAUDIOCONNECTOR_2_DRVAUDIO(pInterface);
 
+    if (!pStream)
+        return VINF_SUCCESS;
+    AssertPtrReturn(pStream, VERR_INVALID_POINTER);
+    Assert(pStream->uMagic == PDMAUDIOSTREAM_MAGIC);
+
     int rc = RTCritSectEnter(&pThis->CritSect);
-    AssertRC(rc);
+    AssertRCReturn(rc, rc);
 
     LogRel2(("Audio: Destroying stream '%s'\n", pStream->szName));
 
     LogFlowFunc(("[%s] cRefs=%RU32\n", pStream->szName, pStream->cRefs));
-    if (pStream->cRefs > 1)
+    if (pStream->cRefs < 1)
+    {
+        rc = drvAudioStreamUninitInternal(pThis, pStream);
+        if (RT_SUCCESS(rc))
+        {
+            if (pStream->enmDir == PDMAUDIODIR_IN)
+                pThis->In.cStreamsFree++;
+            else /* Out */
+                pThis->Out.cStreamsFree++;
+
+            RTListNodeRemove(&pStream->ListEntry);
+
+            drvAudioStreamFree(pStream);
+            pStream = NULL;
+        }
+        else
+            LogRel(("Audio: Uninitializing stream '%s' failed with %Rrc\n", pStream->szName, rc));
+    }
+    else
         rc = VERR_WRONG_ORDER;
-
-    if (RT_SUCCESS(rc))
-    {
-        rc = drvAudioStreamUninitInternal(pThis, pStream);
-        if (RT_FAILURE(rc))
-            LogRel(("Audio: Uninitializing stream '%s' failed with %Rrc\n", pStream->szName, rc));
-    }
-
-    if (RT_SUCCESS(rc))
-    {
-        if (pStream->enmDir == PDMAUDIODIR_IN)
-        {
-            pThis->In.cStreamsFree++;
-        }
-        else /* Out */
-        {
-            pThis->Out.cStreamsFree++;
-        }
-
-        RTListNodeRemove(&pStream->Node);
-
-        drvAudioStreamFree(pStream);
-        pStream = NULL;
-    }
 
     int rc2 = RTCritSectLeave(&pThis->CritSect);
@@ -3560 +3554 @@
      * in drvAudioDestruct(). */
     PPDMAUDIOSTREAM pStream;
-    RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, Node)
+    RTListForEach(&pThis->lstStreams, pStream, PDMAUDIOSTREAM, ListEntry)
     {
         drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DISABLE);
@@ -3705 +3699 @@
 
     PPDMAUDIOSTREAM pStream, pStreamNext;
-    RTListForEachSafe(&pThis->lstStreams, pStream, pStreamNext, PDMAUDIOSTREAM, Node)
+    RTListForEachSafe(&pThis->lstStreams, pStream, pStreamNext, PDMAUDIOSTREAM, ListEntry)
     {
         rc2 = drvAudioStreamUninitInternal(pThis, pStream);
         if (RT_SUCCESS(rc2))
         {
-            RTListNodeRemove(&pStream->Node);
+            RTListNodeRemove(&pStream->ListEntry);
 
             drvAudioStreamFree(pStream);