Changeset 91040 in vbox for trunk/src

Timestamp:

Aug 31, 2021 5:40:36 PM (3 years ago)

Author:

vboxsync

Message:

Audio/Validation Kit: Got rid of the embedded (and probably wrong) failure reply struct and replaced it with ATSPKTREPFAIL so that clients also can interpret it more easily. ​bugref:10008

Location:

trunk/src/VBox/Devices/Audio

Files:

• AudioTestService.cpp (modified) (1 diff)
• AudioTestServiceClient.cpp (modified) (1 diff)
• AudioTestServiceProtocol.h (modified) (1 diff)

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

@@ -356 +356 @@
 {
     RT_NOREF(pPktHdr);
-    union
-    {
-        ATSPKTHDR   Hdr;
-        int         rc;
-        char        ach[256];
-    } uPkt;
-    RT_ZERO(uPkt);
-
-    size_t cchDetail = RTStrPrintfV(&uPkt.ach[sizeof(ATSPKTHDR)],
-                                    sizeof(uPkt) - sizeof(ATSPKTHDR),
-                                    pszDetailFmt, va);
-
-    uPkt.rc = rcReq;
-
-    return atsReplyInternal(pThis, pInst, &uPkt.Hdr, pszOpcode, sizeof(int) + cchDetail + 1);
+
+    ATSPKTREPFAIL Rep;
+    RT_ZERO(Rep);
+
+    size_t cchDetail = RTStrPrintfV(Rep.ach, sizeof(Rep.ach), pszDetailFmt, va);
+
+    Rep.rc = rcReq;
+
+    return atsReplyInternal(pThis, pInst, &Rep.Hdr, pszOpcode, sizeof(Rep.rc) + cchDetail + 1);
 }
 

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

@@ -158 +158 @@
     if (RT_SUCCESS(rc))
     {
-        if (RTStrNCmp(Reply.szOp, "ACK     ", ATSPKT_OPCODE_MAX_LEN) != 0)
-        {
-            LogRelFunc(("Received invalid ACK opcode ('%.8s')\n", Reply.szOp));
+        /* Most likely cases first. */
+        if (     RTStrNCmp(Reply.szOp, "ACK     ", ATSPKT_OPCODE_MAX_LEN) == 0)
+        {
+            /* Nothing to do here. */
+        }
+        else if (RTStrNCmp(Reply.szOp, "FAILED  ", ATSPKT_OPCODE_MAX_LEN) == 0)
+        {
+            if (Reply.cbPayload)
+            {
+                if (Reply.cbPayload == sizeof(ATSPKTREPFAIL))
+                {
+                    PATSPKTREPFAIL pRep = (PATSPKTREPFAIL)Reply.pvPayload;
+                    /** @todo Check NULL termination of pcszMsg? */
+
+                    LogRelFunc(("Received error: %s (%Rrc)\n", pRep->ach, pRep->rc));
+
+                    rc = pRep->rc; /* Reach error code back to caller. */
+                }
+                else
+                {
+                    LogRelFunc(("Received invalid failure payload (cb=%zu)\n", Reply.cbPayload));
+                    rc = VERR_NET_PROTOCOL_ERROR;
+                }
+            }
+        }
+        else
+        {
+            LogRelFunc(("Received invalid opcode ('%.8s')\n", Reply.szOp));
             rc = VERR_NET_PROTOCOL_ERROR;
         }

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

@@ -189 +189 @@
 
 /**
+ * The failure reply structure.
+ */
+typedef struct ATSPKTREPFAIL
+{
+    /** Embedded packet header. */
+    ATSPKTHDR   Hdr;
+    /** Error code (IPRT-style). */
+    int         rc;
+    /** Error description. */
+    char        ach[256];
+} ATSPKTREPFAIL;
+/** Pointer to a ATSPKTREPFAIL structure. */
+typedef ATSPKTREPFAIL *PATSPKTREPFAIL;
+
+/**
  * Checks if the two opcodes match.
  *