Changeset 90918 in vbox

Timestamp:

Aug 26, 2021 3:29:25 PM (3 years ago)

Author:

vboxsync

Message:

Audio/Validation Kit: Simplified ATS init / destruction handling. bugref:10008

Location:

trunk/src/VBox

Files:

• Devices/Audio/AudioTestService.cpp (modified) (6 diffs)
• Devices/Audio/AudioTestService.h (modified) (1 diff)
• Devices/Audio/DrvHostAudioValidationKit.cpp (modified) (3 diffs)
• Devices/Audio/testcase/tstAudioTestService.cpp (modified) (1 diff)
• ValidationKit/utils/audio/vkat.cpp (modified) (5 diffs)
• ValidationKit/utils/audio/vkatCmdSelfTest.cpp (modified) (1 diff)
• ValidationKit/utils/audio/vkatCommon.cpp (modified) (8 diffs)
• ValidationKit/utils/audio/vkatInternal.h (modified) (1 diff)

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

@@ -1037 +1037 @@
 
 /**
- * Creates an ATS instance.
+ * Initializes an ATS instance.
+ *
+ * @note This does *not* start the server!
  *
  * @returns VBox status code.
- * @param   pThis               The ATS instance to create.
- */
-int AudioTestSvcCreate(PATSSERVER pThis)
-{
-    /*
-     * The default transporter is the first one.
-     */
-    pThis->pTransport = g_apTransports[0]; /** @todo Make this dynamic. */
-
-    return pThis->pTransport->pfnCreate(&pThis->pTransportInst);
-}
-
-/**
- * Initializes an ATS instance.
- *
- * @returns VBox status code.
  * @param   pThis               The ATS instance.
  * @param   pCallbacks          The callbacks table to use.
@@ -1061 +1047 @@
 int AudioTestSvcInit(PATSSERVER pThis, PCATSCALLBACKS pCallbacks)
 {
+    RT_BZERO(pThis, sizeof(ATSSERVER));
+
+    pThis->hPipeR = NIL_RTPIPE;
+    pThis->hPipeW = NIL_RTPIPE;
+
+    RTListInit(&pThis->LstClientsNew);
+
+    /* Copy callback table. */
     memcpy(&pThis->Callbacks, pCallbacks, sizeof(ATSCALLBACKS));
 
-    pThis->fStarted   = false;
-    pThis->fTerminate = false;
-
-    pThis->hPipeR     = NIL_RTPIPE;
-    pThis->hPipeW     = NIL_RTPIPE;
-
-    RTListInit(&pThis->LstClientsNew);
-
-    /*
-     * Initialize the transport layer.
-     */
     int rc = RTCritSectInit(&pThis->CritSectClients);
     if (RT_SUCCESS(rc))
@@ -1083 +1066 @@
             if (RT_SUCCESS(rc))
             {
-                /* Spin off the thread serving connections. */
-                rc = RTThreadCreate(&pThis->hThreadServing, atsClientWorker, pThis, 0, RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE,
-                                    "AUDTSTSRVC");
+                /*
+                 * The default transporter is the first one.
+                 */
+                pThis->pTransport = g_apTransports[0]; /** @todo Make this dynamic. */
+
+                rc =  pThis->pTransport->pfnCreate(&pThis->pTransportInst);
                 if (RT_SUCCESS(rc))
                     return VINF_SUCCESS;
-                else
-                    LogRel(("Creating the client worker thread failed with %Rrc\n", rc));
 
                 RTPipeClose(pThis->hPipeR);
@@ -1105 +1089 @@
     }
     else
-        LogRel(("Creating global critical section failed with %Rrc\n", rc));
+        LogRel(("Creating critical section failed with %Rrc\n", rc));
+
+    if (RT_FAILURE(rc))
+        LogRel(("Creating server failed with %Rrc\n", rc));
 
     return rc;
@@ -1134 +1121 @@
 int AudioTestSvcStart(PATSSERVER pThis)
 {
-    int rc = pThis->pTransport->pfnStart(pThis->pTransportInst);
+    /* Spin off the thread serving connections. */
+    int rc = RTThreadCreate(&pThis->hThreadServing, atsClientWorker, pThis, 0, RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE,
+                            "ATSCLWORK");
+    if (RT_FAILURE(rc))
+    {
+        LogRel(("Creating the client worker thread failed with %Rrc\n", rc));
+        return rc;
+    }
+
+    rc = pThis->pTransport->pfnStart(pThis->pTransportInst);
     if (RT_SUCCESS(rc))
     {
         /* Spin off the connection thread. */
         rc = RTThreadCreate(&pThis->hThreadMain, atsMainThread, pThis, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
-                            "AUDTSTSRVM");
+                            "ATSMAIN");
         if (RT_SUCCESS(rc))
         {
@@ -1152 +1148 @@
 
 /**
- * Shuts down a formerly started ATS instance.
+ * Stops (shuts down) a formerly started ATS instance.
  *
  * @returns VBox status code.
  * @param   pThis               The ATS instance.
  */
-int AudioTestSvcShutdown(PATSSERVER pThis)
+int AudioTestSvcStop(PATSSERVER pThis)
 {
     if (!pThis->fStarted)

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

@@ -171 +171 @@
 typedef ATSSERVER *PATSSERVER;
 
-int AudioTestSvcCreate(PATSSERVER pThis);
 int AudioTestSvcInit(PATSSERVER pThis, PCATSCALLBACKS pCallbacks);
 int AudioTestSvcDestroy(PATSSERVER pThis);
 int AudioTestSvcHandleOption(PATSSERVER pThis, int ch, PCRTGETOPTUNION pVal);
 int AudioTestSvcStart(PATSSERVER pThis);
-int AudioTestSvcShutdown(PATSSERVER pThis);
+int AudioTestSvcStop(PATSSERVER pThis);
 
 /**

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

@@ -1108 +1108 @@
     /* Dont' use rc here, as this will be reported back to PDM and will prevent VBox
      * from starting -- not critical but warn the user though. */
-    int rc2 = AudioTestSvcCreate(&pThis->Srv);
+    int rc2 = AudioTestSvcInit(&pThis->Srv, &Callbacks);
     if (RT_SUCCESS(rc2))
     {
@@ -1126 +1126 @@
         AssertRC(rc2);
 
-        rc2 = AudioTestSvcInit(&pThis->Srv, &Callbacks);
-        if (RT_SUCCESS(rc2))
-            rc2 = AudioTestSvcStart(&pThis->Srv);
+        rc2 = AudioTestSvcStart(&pThis->Srv);
     }
 
@@ -1162 +1160 @@
     LogRel(("ValKit: Shutting down Audio Test Service (ATS) ...\n"));
 
-    int rc = AudioTestSvcShutdown(&pThis->Srv);
+    int rc = AudioTestSvcStop(&pThis->Srv);
     if (RT_SUCCESS(rc))
         rc = AudioTestSvcDestroy(&pThis->Srv);

trunk/src/VBox/Devices/Audio/testcase/tstAudioTestService.cpp

@@ -158 +158 @@
     RTTEST_CHECK_RC_OK(hTest, rc);
 
-    rc = AudioTestSvcShutdown(&Srv);
+    rc = AudioTestSvcStop(&Srv);
+    RTTEST_CHECK_RC_OK(hTest, rc);
+
+    rc = AudioTestSvcDestroy(&Srv);
     RTTEST_CHECK_RC_OK(hTest, rc);
 

trunk/src/VBox/ValidationKit/utils/audio/vkat.cpp

@@ -311 +311 @@
         {
             /*
-             * 2. Tell the guest ATS to start playback.
+             * 2. Tell VKAT on guest  to start playback.
              */
-            RTTestPrintf(g_hTest, RTTESTLVL_DEBUG, "Telling guest VKAT to play tone ...\n");
+            RTTestPrintf(g_hTest, RTTESTLVL_DEBUG, "Telling VKAT on guest to play tone ...\n");
             rc = AudioTestSvcClientTonePlay(&pTstEnv->u.Host.AtsClGuest, pToneParms);
             if (RT_FAILURE(rc))
@@ -418 +418 @@
              * 2. Tell the guest ATS to start recording.
              */
-            RTTestPrintf(g_hTest, RTTESTLVL_DEBUG, "Telling guest VKAT to record audio ...\n");
+            RTTestPrintf(g_hTest, RTTESTLVL_DEBUG, "Telling VKAT on guest to record audio ...\n");
             rc = AudioTestSvcClientToneRecord(&pTstEnv->u.Host.AtsClGuest, &pTstParms->TestTone);
             if (RT_FAILURE(rc))
@@ -547 +547 @@
         RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Shutting down guest ATS ...\n");
 
-        int rc2 = AudioTestSvcShutdown(&pTstEnv->Srv);
+        int rc2 = AudioTestSvcStop(pTstEnv->pSrv);
         if (RT_SUCCESS(rc))
             rc = rc2;
@@ -557 +557 @@
         RTTestPrintf(g_hTest, RTTESTLVL_DEBUG, "Using tag '%s'\n", pTstEnv->szTag);
 
+        RTTestPrintf(g_hTest, RTTESTLVL_DEBUG, "Telling ValKit audio driver on host to begin a new test set ...\n");
         rc = AudioTestSvcClientTestSetBegin(&pTstEnv->u.Host.AtsClValKit, pTstEnv->szTag);
         if (RT_SUCCESS(rc))
         {
+            RTTestPrintf(g_hTest, RTTESTLVL_DEBUG, "Telling VKAT on guest to begin a new test set ...\n");
             rc = AudioTestSvcClientTestSetBegin(&pTstEnv->u.Host.AtsClGuest, pTstEnv->szTag);
             if (RT_FAILURE(rc))
@@ -733 +735 @@
     RT_ZERO(TstEnv);
 
-    int rc = AudioTestSvcCreate(&TstEnv.Srv);
-    if (RT_FAILURE(rc))
-        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Creating ATS service instance failed with %Rrc\n", rc);
+    int         rc;
 
     const char *pszTag        = NULL; /* Custom tag to use. Can be NULL if not being used. */

trunk/src/VBox/ValidationKit/utils/audio/vkatCmdSelfTest.cpp

@@ -139 +139 @@
         RTStrCopy(pTstEnvGst->TcpOpts.szConnectAddr, sizeof(pTstEnvGst->TcpOpts.szConnectAddr), "127.0.0.1");
 
-    int rc = AudioTestSvcCreate(&pTstEnvGst->Srv);
-    AssertRCReturn(rc, rc);
-
     /* Generate tag for guest side. */
-    rc = RTStrCopy(pTstEnvGst->szTag, sizeof(pTstEnvGst->szTag), pCtx->szTag);
+    int rc = RTStrCopy(pTstEnvGst->szTag, sizeof(pTstEnvGst->szTag), pCtx->szTag);
     AssertRCReturn(rc, rc);
 

trunk/src/VBox/ValidationKit/utils/audio/vkatCommon.cpp

@@ -492 +492 @@
     pCtx->cClients--;
 
-    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Clients wants to disconnect, %RU8 remaining\n", pCtx->cClients);
+    RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS, "Client wants to disconnect, %RU8 remaining\n", pCtx->cClients);
 
     if (0 == pCtx->cClients) /* All clients disconnected? Tear things down. */
@@ -772 +772 @@
     RT_ZERO(Val);
 
+    int rc = AudioTestSvcInit(pSrv, pCallbacks);
+    if (RT_FAILURE(rc))
+        return rc;
+
     Val.u32 = pTcpOpts->enmConnMode;
-    AudioTestSvcHandleOption(pSrv, ATSTCPOPT_CONN_MODE, &Val);
+    rc = AudioTestSvcHandleOption(pSrv, ATSTCPOPT_CONN_MODE, &Val);
+    AssertRCReturn(rc, rc);
 
     if (   pTcpOpts->enmConnMode == ATSCONNMODE_BOTH
@@ -780 +785 @@
         Assert(pTcpOpts->uBindPort); /* Always set by the caller. */
         Val.u16 = pTcpOpts->uBindPort;
-        AudioTestSvcHandleOption(pSrv, ATSTCPOPT_BIND_PORT, &Val);
+        rc = AudioTestSvcHandleOption(pSrv, ATSTCPOPT_BIND_PORT, &Val);
+        AssertRCReturn(rc, rc);
 
         if (pTcpOpts->szBindAddr[0])
         {
             Val.psz = pTcpOpts->szBindAddr;
-            AudioTestSvcHandleOption(pSrv, ATSTCPOPT_BIND_ADDRESS, &Val);
+            rc = AudioTestSvcHandleOption(pSrv, ATSTCPOPT_BIND_ADDRESS, &Val);
+            AssertRCReturn(rc, rc);
         }
         else
@@ -803 +810 @@
         Assert(pTcpOpts->uConnectPort); /* Always set by the caller. */
         Val.u16 = pTcpOpts->uConnectPort;
-        AudioTestSvcHandleOption(pSrv, ATSTCPOPT_CONNECT_PORT, &Val);
+        rc = AudioTestSvcHandleOption(pSrv, ATSTCPOPT_CONNECT_PORT, &Val);
+        AssertRCReturn(rc, rc);
 
         if (pTcpOpts->szConnectAddr[0])
         {
             Val.psz = pTcpOpts->szConnectAddr;
-            AudioTestSvcHandleOption(pSrv, ATSTCPOPT_CONNECT_ADDRESS, &Val);
+            rc = AudioTestSvcHandleOption(pSrv, ATSTCPOPT_CONNECT_ADDRESS, &Val);
+            AssertRCReturn(rc, rc);
         }
         else
@@ -820 +829 @@
     }
 
-    int rc = AudioTestSvcInit(pSrv, pCallbacks);
     if (RT_SUCCESS(rc))
+    {
         rc = AudioTestSvcStart(pSrv);
-
-    if (RT_FAILURE(rc))
-        RTTestFailed(g_hTest, "Starting server for %s failed with %Rrc\n", pszDesc, rc);
+        if (RT_FAILURE(rc))
+            RTTestFailed(g_hTest, "Starting server for %s failed with %Rrc\n", pszDesc, rc);
+    }
 
     return rc;
@@ -953 +962 @@
             pTstEnv->TcpOpts.uConnectPort = ATS_TCP_DEF_CONNECT_PORT_GUEST;
 
+        pTstEnv->pSrv = (PATSSERVER)RTMemAlloc(sizeof(ATSSERVER));
+        AssertPtrReturn(pTstEnv->pSrv, VERR_NO_MEMORY);
+
         /*
          * Start the ATS (Audio Test Service) on the guest side.
@@ -960 +972 @@
          * Note that we have to bind to "0.0.0.0" by default so that the host can connect to it.
          */
-        rc = audioTestEnvConfigureAndStartTcpServer(&pTstEnv->Srv, &Callbacks, "guest", &pTstEnv->TcpOpts);
+        rc = audioTestEnvConfigureAndStartTcpServer(pTstEnv->pSrv, &Callbacks, "guest", &pTstEnv->TcpOpts);
     }
     else /* Host mode */
@@ -1021 +1033 @@
     }
 
+    if (pTstEnv->pSrv)
+    {
+        int rc2 = AudioTestSvcDestroy(pTstEnv->pSrv);
+        AssertRC(rc2);
+
+        RTMemFree(pTstEnv->pSrv);
+        pTstEnv->pSrv = NULL;
+    }
+
     for (unsigned i = 0; i < RT_ELEMENTS(pTstEnv->aStreams); i++)
     {

trunk/src/VBox/ValidationKit/utils/audio/vkatInternal.h

@@ -253 +253 @@
     /** TCP options to use for ATS. */
     AUDIOTESTENVTCPOPTS     TcpOpts;
-    /** ATS server instance to use. */
-    ATSSERVER               Srv;
+    /** ATS server instance to use.
+     *  NULL if not in use. */
+    PATSSERVER              pSrv;
     /** ATS callback context to use. */
     ATSCALLBACKCTX          CallbackCtx;