Changeset 82526 in vbox for trunk/src/VBox/HostServices

Timestamp:

Dec 9, 2019 9:48:53 PM (5 years ago)

Author:

vboxsync

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

135388

Message:

SharedClipboardSvc,Vbgl: Started looking over the host message handling, adding missing locking and fixing docs. bugref:9437

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

• VBoxSharedClipboardSvc-internal.h (modified) (2 diffs)
• VBoxSharedClipboardSvc-transfers.cpp (modified) (1 diff)
• VBoxSharedClipboardSvc-win.cpp (modified) (3 diffs)
• VBoxSharedClipboardSvc-x11.cpp (modified) (10 diffs)
• VBoxSharedClipboardSvc.cpp (modified) (30 diffs)
• testcase/tstClipboardServiceHost.cpp (modified) (8 diffs)

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h

@@ -146 +146 @@
     RTCList<SHCLCLIENTMSG *> queueMsg;
     /** The client's own event source.
-     *  Needed for events which are not bound to a specific transfer.
-     * @todo r=bird: s/Events/EventSrc/ !!  */
-    SHCLEVENTSOURCE          Events;
+     *  Needed for events which are not bound to a specific transfer. */
+    SHCLEVENTSOURCE          EventSrc;
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
     /** Transfer contextdata. */
@@ -221 +220 @@
 void shClSvcMsgSetPeekReturn(PSHCLCLIENTMSG pMsg, PVBOXHGCMSVCPARM paDstParms, uint32_t cDstParms);
 int shClSvcMsgAdd(PSHCLCLIENT pClient, PSHCLCLIENTMSG pMsg, bool fAppend);
-int shClSvcMsgPeek(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool fWait);
-int shClSvcMsgGet(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
 
 int shClSvcClientInit(PSHCLCLIENT pClient, uint32_t uClientID);

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-transfers.cpp

@@ -752 +752 @@
         case VBOX_SHCL_GUEST_FN_REPLY:
             RT_FALL_THROUGH();
-        case VBOX_SHCL_GUEST_FN_CANCEL:
+        case VBOX_SHCL_GUEST_FN_MSG_CANCEL:
             RT_FALL_THROUGH();
         case VBOX_SHCL_GUEST_FN_ERROR:

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-win.cpp

@@ -189 +189 @@
     {
         PSHCLEVENTPAYLOAD pPayload;
-        rc = ShClEventWait(&pCtx->pClient->Events, uEvent, 30 * 1000, &pPayload);
+        rc = ShClEventWait(&pCtx->pClient->EventSrc, uEvent, 30 * 1000, &pPayload);
         if (RT_SUCCESS(rc))
         {
@@ -196 +196 @@
 
             /* Detach the payload, as the caller then will own the data. */
-            ShClEventPayloadDetach(&pCtx->pClient->Events, uEvent);
+            ShClEventPayloadDetach(&pCtx->pClient->EventSrc, uEvent);
             /**
              * @todo r=bird: The payload has already been detached,
@@ -204 +204 @@
         }
 
-        ShClEventUnregister(&pCtx->pClient->Events, uEvent);
+        ShClEventUnregister(&pCtx->pClient->EventSrc, uEvent);
     }
 

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-x11.cpp

@@ -194 +194 @@
     if (pReq)
     {
-        const SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->Events);
+        const SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->EventSrc);
 
         pReq->pv        = pData->pvData;
@@ -201 +201 @@
         pReq->uEvent    = uEvent;
 
-        rc = ShClEventRegister(&pClient->Events, uEvent);
+        rc = ShClEventRegister(&pClient->EventSrc, uEvent);
         if (RT_SUCCESS(rc))
         {
@@ -208 +208 @@
             {
                 PSHCLEVENTPAYLOAD pPayload;
-                rc = ShClEventWait(&pClient->Events, uEvent, 30 * 1000, &pPayload);
+                rc = ShClEventWait(&pClient->EventSrc, uEvent, 30 * 1000, &pPayload);
                 if (RT_SUCCESS(rc))
                 {
@@ -218 +218 @@
             }
 
-            ShClEventUnregister(&pClient->Events, uEvent);
+            ShClEventUnregister(&pClient->EventSrc, uEvent);
         }
     }
@@ -304 +304 @@
         }
 
-        rc2 = ShClEventSignal(&pCtx->pClient->Events, pReq->uEvent, pPayload);
+        rc2 = ShClEventSignal(&pCtx->pClient->EventSrc, pReq->uEvent, pPayload);
         AssertRC(rc2);
     }
@@ -356 +356 @@
         {
             PSHCLEVENTPAYLOAD pPayload;
-            rc = ShClEventWait(&pCtx->pClient->Events, uEvent, 30 * 1000, &pPayload);
+            rc = ShClEventWait(&pCtx->pClient->EventSrc, uEvent, 30 * 1000, &pPayload);
             if (RT_SUCCESS(rc))
             {
@@ -363 +363 @@
 
                 /* Detach the payload, as the caller then will own the data. */
-                ShClEventPayloadDetach(&pCtx->pClient->Events, uEvent);
+                ShClEventPayloadDetach(&pCtx->pClient->EventSrc, uEvent);
             }
 
-            ShClEventUnregister(&pCtx->pClient->Events, uEvent);
+            ShClEventUnregister(&pCtx->pClient->EventSrc, uEvent);
         }
     }
@@ -399 +399 @@
     LogFlowFuncEnter();
 
-    SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->Events);
-
-    int rc = ShClEventRegister(&pClient->Events, uEvent);
+    SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->EventSrc);
+
+    int rc = ShClEventRegister(&pClient->EventSrc, uEvent);
     if (RT_SUCCESS(rc))
     {
@@ -414 +414 @@
                 /* X supplies the data asynchronously, so we need to wait for data to arrive first. */
                 PSHCLEVENTPAYLOAD pPayload;
-                rc = ShClEventWait(&pClient->Events, uEvent, 30 * 1000, &pPayload);
+                rc = ShClEventWait(&pClient->EventSrc, uEvent, 30 * 1000, &pPayload);
                 if (RT_SUCCESS(rc))
                 {
@@ -423 +423 @@
         }
 
-        ShClEventUnregister(&pClient->Events, uEvent);
+        ShClEventUnregister(&pClient->EventSrc, uEvent);
     }
 

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp

@@ -52 +52 @@
  *
  * There are currently four messages defined.  The first is
- * VBOX_SHCL_GUEST_FN_MSG_GET / VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, which waits
+ * VBOX_SHCL_GUEST_FN_MSG_GET / VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, which waits
  * for a message from the host.  If a host message is sent while the guest is
  * not waiting, it will be queued until the guest requests it.  The host code
@@ -78 +78 @@
  * Since VBox 6.1 a newer protocol (v1) has been established to also support
  * file transfers. This protocol uses a (per-client) message queue instead
- * (see VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD vs. VBOX_SHCL_GUEST_FN_GET_HOST_MSG).
+ * (see VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT vs. VBOX_SHCL_GUEST_FN_GET_HOST_MSG).
  *
  * To distinguish the old (legacy) or new(er) protocol, the VBOX_SHCL_GUEST_FN_CONNECT
@@ -295 +295 @@
 /** Host feature mask (VBOX_SHCL_HF_0_XXX) for VBOX_SHCL_GUEST_FN_REPORT_FEATURES
  * and VBOX_SHCL_GUEST_FN_QUERY_FEATURES. */
-static uint64_t const g_fHostFeatures0 = VBOX_SHCL_HF_0_CONTEXT_ID;
+static uint64_t const g_fHostFeatures0 = VBOX_SHCL_HF_0_CONTEXT_ID
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
+                                       | VBOX_SHCL_HF_0_TRANSFERS
+#endif
+                                       ;
 
 
@@ -449 +453 @@
 
 /**
- * Sets the VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD return parameters.
+ * Sets the VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT return parameters.
  *
  * This function does the necessary translation between the legacy protocol (<= VBox 6.0) and the new protocols (>= VBox 6.1),
@@ -587 +591 @@
     {
         /* Create the client's own event source. */
-        rc = ShClEventSourceCreate(&pClient->Events, 0 /* ID, ignored */);
+        rc = ShClEventSourceCreate(&pClient->EventSrc, 0 /* ID, ignored */);
         if (RT_SUCCESS(rc))
         {
-            LogFlowFunc(("[Client %RU32] Using event source %RU32\n", uClientID, pClient->Events.uID));
+            LogFlowFunc(("[Client %RU32] Using event source %RU32\n", uClientID, pClient->EventSrc.uID));
 
             /* Reset the client state. */
@@ -621 +625 @@
 
     /* Make sure to send a quit message to the guest so that it can terminate gracefully. */
+    RTCritSectEnter(&pClient->CritSect);
     if (pClient->Pending.uType)
     {
-        if (pClient->Pending.cParms >= 2)
-        {
+        if (pClient->Pending.cParms > 1)
             HGCMSvcSetU32(&pClient->Pending.paParms[0], VBOX_SHCL_HOST_MSG_QUIT);
+        if (pClient->Pending.cParms > 2)
             HGCMSvcSetU32(&pClient->Pending.paParms[1], 0);
-        }
         g_pHelpers->pfnCallComplete(pClient->Pending.hHandle, VINF_SUCCESS);
-        pClient->Pending.uType = 0;
-    }
-
-    ShClEventSourceDestroy(&pClient->Events);
+        pClient->Pending.uType   = 0;
+        pClient->Pending.cParms  = 0;
+        pClient->Pending.hHandle = NULL;
+        pClient->Pending.paParms = NULL;
+    }
+    RTCritSectLeave(&pClient->CritSect);
+
+    ShClEventSourceDestroy(&pClient->EventSrc);
 
     shClSvcClientStateDestroy(&pClient->State);
@@ -666 +674 @@
 
     /* Reset event source. */
-    ShClEventSourceReset(&pClient->Events);
+    ShClEventSourceReset(&pClient->EventSrc);
 
     /* Reset pending state. */
@@ -772 +780 @@
  * @param   fWait       Set if we should wait for a message, clear if to return
  *                      immediately.
- */
-int shClSvcMsgPeek(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[],
-                   bool fWait)
+ *
+ * @note    Caller takes and leave the client's critical section.
+ */
+static int shClSvcClientMsgPeek(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool fWait)
 {
     /*
@@ -851 +860 @@
 
 /**
- * Implements VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD.
+ * Implements VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT.
  *
  * @returns VBox status code.
@@ -861 +870 @@
  * @param   cParms      Number of parameters.
  * @param   paParms     Array of parameters.
- */
-int shClSvcMsgGetOld(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+ *
+ * @note    Caller takes and leave the client's critical section.
+ */
+static int shClSvcClientMsgOldGet(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
 {
     int rc;
@@ -910 +921 @@
             pClient->Pending.cParms  = cParms;
             pClient->Pending.paParms = paParms;
-            pClient->Pending.uType   = VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD;
+            pClient->Pending.uType   = VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT;
 
             rc = VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
@@ -939 +950 @@
  * @param   cParms       Number of parameters.
  * @param   paParms      Array of parameters.
- */
-int shClSvcMsgGet(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+ *
+ * @note    Called from within pClient->CritSect.
+ */
+static int shClSvcClientMsgGet(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
 {
     /*
@@ -1048 +1061 @@
 
 /**
+ * Implements VBOX_SHCL_GUEST_FN_MSG_GET.
+ *
+ * @returns VBox status code.
+ * @retval  VINF_SUCCESS if message retrieved and removed from the pending queue.
+ * @retval  VERR_TRY_AGAIN if no message pending.
+ * @retval  VERR_MISMATCH if the incoming message ID does not match the pending.
+ * @retval  VINF_HGCM_ASYNC_EXECUTE if message was completed already.
+ *
+ * @param   pClient      The client state.
+ * @param   cParms       Number of parameters.
+ *
+ * @note    Called from within pClient->CritSect.
+ */
+static int shClSvcClientMsgCancel(PSHCLCLIENT pClient, uint32_t cParms)
+{
+    /*
+     * Validate the request.
+     */
+    ASSERT_GUEST_MSG_RETURN(cParms == 0, ("cParms=%u!\n", cParms), VERR_WRONG_PARAMETER_COUNT);
+
+    /*
+     * Execute.
+     */
+    if (pClient->Pending.uType != 0)
+    {
+        LogFlowFunc(("[Client %RU32] Cancelling waiting thread, isPending=%d, pendingNumParms=%RU32, m_idSession=%x\n",
+                     pClient->State.uClientID, pClient->Pending.uType, pClient->Pending.cParms, pClient->State.uSessionID));
+
+        /*
+         * The PEEK call is simple: At least two parameters, all set to zero before sleeping.
+         */
+        int rcComplete;
+        if (pClient->Pending.uType == VBOX_SHCL_GUEST_FN_MSG_PEEK_WAIT)
+        {
+            Assert(pClient->Pending.cParms >= 2);
+            HGCMSvcSetU32(&pClient->Pending.paParms[0], VBOX_SHCL_HOST_MSG_CANCELED);
+            rcComplete = VINF_TRY_AGAIN;
+        }
+        /*
+         * The MSG_OLD call is complicated, though we're
+         * generally here to wake up someone who is peeking and have two parameters.
+         * If there aren't two parameters, fail the call.
+         */
+        else
+        {
+            Assert(pClient->Pending.uType == VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT);
+            if (pClient->Pending.cParms > 0)
+                HGCMSvcSetU32(&pClient->Pending.paParms[0], VBOX_SHCL_HOST_MSG_CANCELED);
+            if (pClient->Pending.cParms > 1)
+                HGCMSvcSetU32(&pClient->Pending.paParms[1], 0);
+            rcComplete = pClient->Pending.cParms == 2 ? VINF_SUCCESS : VERR_TRY_AGAIN;
+        }
+
+        g_pHelpers->pfnCallComplete(pClient->Pending.hHandle, rcComplete);
+
+        pClient->Pending.hHandle    = NULL;
+        pClient->Pending.paParms    = NULL;
+        pClient->Pending.cParms     = 0;
+        pClient->Pending.uType      = 0;
+        return VINF_SUCCESS;
+    }
+    return VWRN_NOT_FOUND;
+}
+
+
+/**
  * Wakes up a pending client (i.e. waiting for new messages).
  *
@@ -1081 +1160 @@
                     fDonePending = true;
                 }
-                else if (pClient->Pending.uType == VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD) /* Legacy, Guest Additions < 6.1. */
+                else if (pClient->Pending.uType == VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT) /* Legacy, Guest Additions < 6.1. */
                 {
                     bool fRemove;
@@ -1132 +1211 @@
  * @param   puEvent             Event ID for waiting for new data. Optional.
  */
-int ShClSvcDataReadRequest(PSHCLCLIENT pClient, PSHCLDATAREQ pDataReq,
-                           PSHCLEVENTID puEvent)
+int ShClSvcDataReadRequest(PSHCLCLIENT pClient, PSHCLDATAREQ pDataReq, PSHCLEVENTID puEvent)
 {
     AssertPtrReturn(pClient,  VERR_INVALID_POINTER);
@@ -1147 +1225 @@
     if (pMsgReadData)
     {
-        const SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->Events);
+        const SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->EventSrc);
 
         LogFlowFunc(("uFmt=0x%x\n", pDataReq->uFmt));
 
         HGCMSvcSetU64(&pMsgReadData->paParms[0], VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID,
-                                                                          pClient->Events.uID, uEvent));
+                                                                          pClient->EventSrc.uID, uEvent));
         HGCMSvcSetU32(&pMsgReadData->paParms[1], 0 /* fFlags */);
         HGCMSvcSetU32(&pMsgReadData->paParms[2], pDataReq->uFmt);
@@ -1160 +1238 @@
         if (RT_SUCCESS(rc))
         {
-            rc = ShClEventRegister(&pClient->Events, uEvent);
+            rc = ShClEventRegister(&pClient->EventSrc, uEvent);
             if (RT_SUCCESS(rc))
             {
@@ -1170 +1248 @@
                 }
                 else
-                    ShClEventUnregister(&pClient->Events, uEvent);
+                    ShClEventUnregister(&pClient->EventSrc, uEvent);
             }
         }
@@ -1195 +1273 @@
         /* Older Guest Additions (<= VBox 6.0) did not have any context ID handling, so we ASSUME that the last event registered
          * is the one we want to handle (as this all was a synchronous protocol anyway). */
-        uEvent = ShClEventGetLast(&pClient->Events);
+        uEvent = ShClEventGetLast(&pClient->EventSrc);
     }
     else
@@ -1208 +1286 @@
     if (RT_SUCCESS(rc))
     {
-        rc = ShClEventSignal(&pClient->Events, uEvent, pPayload);
+        rc = ShClEventSignal(&pClient->EventSrc, uEvent, pPayload);
         if (RT_FAILURE(rc))
             ShClPayloadFree(pPayload);
@@ -1253 +1331 @@
     if (pMsg)
     {
-        const SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->Events);
+        const SHCLEVENTID uEvent = ShClEventIDGenerate(&pClient->EventSrc);
 
         HGCMSvcSetU64(&pMsg->paParms[0], VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID,
-                                                                  pClient->Events.uID, uEvent));
+                                                                  pClient->EventSrc.uID, uEvent));
         HGCMSvcSetU32(&pMsg->paParms[1], fFormats);
         HGCMSvcSetU32(&pMsg->paParms[2], fFlags);
@@ -1295 +1373 @@
  * Handles the VBOX_SHCL_GUEST_FN_REPORT_FORMATS message from the guest.
  */
-static int shClSvcGuestReportFormats(PSHCLCLIENT pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+static int shClSvcClientReportFormats(PSHCLCLIENT pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
 {
     /*
@@ -1390 +1468 @@
  * Handles the VBOX_SHCL_GUEST_FN_DATA_READ message from the guest.
  */
-static int shClSvcGetDataRead(PSHCLCLIENT pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+static int shClSvcClientReadData(PSHCLCLIENT pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
 {
     LogFlowFuncEnter();
@@ -1552 +1630 @@
 }
 
-int shClSvcGetDataWrite(PSHCLCLIENT pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+int shClSvcClientWriteData(PSHCLCLIENT pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
 {
     LogFlowFuncEnter();
@@ -1591 +1669 @@
         ASSERT_GUEST_RETURN(paParms[iParm].type == VBOX_HGCM_SVC_PARM_64BIT, VERR_WRONG_PARAMETER_TYPE);
         cmdCtx.uContextID = paParms[iParm].u.uint64;
-        uint64_t const idCtxExpected = VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID, pClient->Events.uID,
+        uint64_t const idCtxExpected = VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID, pClient->EventSrc.uID,
                                                                 VBOX_SHCL_CONTEXTID_GET_EVENT(cmdCtx.uContextID));
         ASSERT_GUEST_MSG_RETURN(cmdCtx.uContextID == idCtxExpected,
@@ -1676 +1754 @@
  * @param   pRc                 Where to store the received error code.
  */
-static int shClSvcGetError(uint32_t cParms, VBOXHGCMSVCPARM paParms[], int *pRc)
+static int shClSvcClientError(uint32_t cParms, VBOXHGCMSVCPARM paParms[], int *pRc)
 {
     AssertPtrReturn(paParms, VERR_INVALID_PARAMETER);
@@ -1823 +1901 @@
 {
     RT_NOREF(u32ClientID, pvClient, tsArrival);
-
-    int rc = VINF_SUCCESS;
-
     PSHCLCLIENT pClient = (PSHCLCLIENT)pvClient;
     AssertPtr(pClient);
 
+#ifdef LOG_ENABLED
     LogFunc(("u32ClientID=%RU32, fn=%RU32 (%s), cParms=%RU32, paParms=%p\n",
              u32ClientID, u32Function, ShClGuestMsgToStr(u32Function), cParms, paParms));
-
-#ifdef LOG_ENABLED
     for (uint32_t i = 0; i < cParms; i++)
     {
@@ -1838 +1912 @@
         LogFunc(("    paParms[%d]: type %RU32 - value %RU32\n", i, paParms[i].type, paParms[i].u.uint32));
     }
-#endif
-
     LogFunc(("Client state: fFlags=0x%x, fGuestFeatures0=0x%x, fGuestFeatures1=0x%x\n",
              pClient->State.fFlags, pClient->State.fGuestFeatures0, pClient->State.fGuestFeatures1));
-
+#endif
+
+    int rc;
     switch (u32Function)
     {
-        case VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD:
-            rc = shClSvcMsgGetOld(pClient, callHandle, cParms, paParms);
+        case VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT:
+            RTCritSectEnter(&pClient->CritSect);
+            rc = shClSvcClientMsgOldGet(pClient, callHandle, cParms, paParms);
+            RTCritSectLeave(&pClient->CritSect);
             break;
 
@@ -1863 +1939 @@
 
         case VBOX_SHCL_GUEST_FN_MSG_PEEK_NOWAIT:
-            rc = shClSvcMsgPeek(pClient, callHandle, cParms, paParms, false /*fWait*/);
+            RTCritSectEnter(&pClient->CritSect);
+            rc = shClSvcClientMsgPeek(pClient, callHandle, cParms, paParms, false /*fWait*/);
+            RTCritSectLeave(&pClient->CritSect);
             break;
 
         case VBOX_SHCL_GUEST_FN_MSG_PEEK_WAIT:
-            rc = shClSvcMsgPeek(pClient, callHandle, cParms, paParms, true /*fWait*/);
+            RTCritSectEnter(&pClient->CritSect);
+            rc = shClSvcClientMsgPeek(pClient, callHandle, cParms, paParms, true /*fWait*/);
+            RTCritSectLeave(&pClient->CritSect);
             break;
 
         case VBOX_SHCL_GUEST_FN_MSG_GET:
-            rc = shClSvcMsgGet(pClient, callHandle, cParms, paParms);
+            RTCritSectEnter(&pClient->CritSect);
+            rc = shClSvcClientMsgGet(pClient, callHandle, cParms, paParms);
+            RTCritSectLeave(&pClient->CritSect);
             break;
 
+        case VBOX_SHCL_GUEST_FN_MSG_CANCEL:
+            RTCritSectEnter(&pClient->CritSect);
+            rc = shClSvcClientMsgCancel(pClient, cParms);
+            RTCritSectLeave(&pClient->CritSect);
+            break;
+
         case VBOX_SHCL_GUEST_FN_REPORT_FORMATS:
-            rc = shClSvcGuestReportFormats(pClient, cParms, paParms);
+            rc = shClSvcClientReportFormats(pClient, cParms, paParms);
             break;
 
         case VBOX_SHCL_GUEST_FN_DATA_READ:
-            rc = shClSvcGetDataRead(pClient, cParms, paParms);
+            rc = shClSvcClientReadData(pClient, cParms, paParms);
             break;
 
         case VBOX_SHCL_GUEST_FN_DATA_WRITE:
-            rc = shClSvcGetDataWrite(pClient, cParms, paParms);
+            rc = shClSvcClientWriteData(pClient, cParms, paParms);
             break;
 
-        case VBOX_SHCL_GUEST_FN_CANCEL:
-        {
-            LogRel2(("Shared Clipboard: Operation canceled by guest side\n"));
-
-            /** @todo r=bird: What on earth is this?   The only user of this message
-             * (VBOX_SHCL_GUEST_FN_CANCEL) is VbglR3ClipboardMsgPeekWait(), where it was
-             * copied over from guest control.  What happens here is _nothing_ like what it
-             * expects to happen.  See GstCtrlService::clientMsgCancel for a reference.
-             */
-
-            /* Reset client state and start over. */
-            shclSvcClientStateReset(&pClient->State);
-#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
-            shClSvcClientTransfersReset(pClient);
-#endif
-            /** @todo Do we need to do anything else here? */
-            break;
-        }
-
         case VBOX_SHCL_GUEST_FN_ERROR:
         {
             int rcGuest;
-            rc = shClSvcGetError(cParms,paParms, &rcGuest);
+            rc = shClSvcClientError(cParms,paParms, &rcGuest);
             if (RT_SUCCESS(rc))
             {
@@ -1925 +1994 @@
         {
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
-            if (u32Function <= VBOX_SHCL_GUEST_FN_LAST)
+            if (   u32Function <= VBOX_SHCL_GUEST_FN_LAST
+                && (pClient->State.fGuestFeatures0 &  VBOX_SHCL_GF_0_CONTEXT_ID) )
             {
                 if (g_fTransferMode & VBOX_SHCL_TRANSFER_MODE_ENABLED)

trunk/src/VBox/HostServices/SharedClipboard/testcase/tstClipboardServiceHost.cpp

@@ -139 +139 @@
 }
 
-/* Does testing of VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, needed for providing compatibility to older Guest Additions clients. */
+/* Does testing of VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, needed for providing compatibility to older Guest Additions clients. */
 static void testGetHostMsgOld(void)
 {
@@ -147 +147 @@
     int rc;
 
-    RTTestISub("Setting up VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD test");
+    RTTestISub("Setting up VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT test");
     rc = setupTable(&table);
     RTTESTI_CHECK_MSG_RETV(RT_SUCCESS(rc), ("rc=%Rrc\n", rc));
@@ -163 +163 @@
     call.rc = VERR_TRY_AGAIN;
     table.pfnConnect(NULL, 1 /* clientId */, &g_Client, 0, 0);
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK_RC(call.rc, VERR_TRY_AGAIN);  /* This should get updated only when the guest call completes. */
     testMsgAddReadData(&g_Client, VBOX_SHCL_FMT_UNICODETEXT);
@@ -170 +170 @@
     RTTESTI_CHECK_RC_OK(call.rc);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK_RC(call.rc, VERR_TRY_AGAIN);  /* This call should not complete yet. */
 
@@ -179 +179 @@
     HGCMSvcSetU32(&parms[1], 0);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK(parms[0].u.uint32 == VBOX_SHCL_HOST_MSG_READ_DATA);
     RTTESTI_CHECK(parms[1].u.uint32 == VBOX_SHCL_FMT_HTML);
     RTTESTI_CHECK_RC_OK(call.rc);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK_RC(call.rc, VERR_TRY_AGAIN);  /* This call should not complete yet. */
 
@@ -192 +192 @@
     HGCMSvcSetU32(&parms[1], 0);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK_RC(call.rc, VERR_TRY_AGAIN);  /* This should get updated only when the guest call completes. */
     testMsgAddReadData(&g_Client, VBOX_SHCL_FMT_UNICODETEXT | VBOX_SHCL_FMT_HTML);
@@ -199 +199 @@
     RTTESTI_CHECK_RC_OK(call.rc);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK(parms[0].u.uint32 == VBOX_SHCL_HOST_MSG_READ_DATA);
     RTTESTI_CHECK(parms[1].u.uint32 == VBOX_SHCL_FMT_HTML);
     RTTESTI_CHECK_RC_OK(call.rc);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK_RC(call.rc, VERR_TRY_AGAIN);  /* This call should not complete yet. */
 
@@ -213 +213 @@
     HGCMSvcSetU32(&parms[1], 0);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK(parms[0].u.uint32 == VBOX_SHCL_HOST_MSG_READ_DATA);
     RTTESTI_CHECK(parms[1].u.uint32 == VBOX_SHCL_FMT_UNICODETEXT);
     RTTESTI_CHECK_RC_OK(call.rc);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK(parms[0].u.uint32 == VBOX_SHCL_HOST_MSG_READ_DATA);
     RTTESTI_CHECK(parms[1].u.uint32 == VBOX_SHCL_FMT_HTML);
     RTTESTI_CHECK_RC_OK(call.rc);
     call.rc = VERR_TRY_AGAIN;
-    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD, 2, parms, 0);
+    table.pfnCall(NULL, &call, 1 /* clientId */, &g_Client, VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT, 2, parms, 0);
     RTTESTI_CHECK_RC(call.rc, VERR_TRY_AGAIN);  /* This call should not complete yet. */
     table.pfnDisconnect(NULL, 1 /* clientId */, &g_Client);