Changeset 85999 in vbox for trunk

Timestamp:

Sep 2, 2020 2:38:09 PM (4 years ago)

Author:

vboxsync

Message:

Shared Clipboard/Host Service: Use and check for a context ID (CID) in ShClSvcGuestDataRequest() / shClSvcClientWriteData() for old(er) Guest Additions. Untested. bugref:9437

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

• VBoxSharedClipboardSvc-internal.h (modified) (3 diffs)
• VBoxSharedClipboardSvc.cpp (modified) (5 diffs)

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

@@ -99 +99 @@
 
 /**
+ * Strucutre for keeping legacy state, required for keeping backwards compatibility
+ * to old(er) Guest Additions.
+ */
+typedef struct SHCLCLIENTLEGACYSTATE
+{
+    /** Context ID required for an incoming VBOX_SHCL_GUEST_FN_DATA_WRITE call. Set to UINT64_MAX if not in use.
+     *  Required for:
+     *      - Guest Additions < 6.1. */
+    uint64_t idCtxWriteData;
+} SHCLCLIENTLEGACYSTATE;
+
+/**
  * Structure for keeping generic client state data within the Shared Clipboard host service.
  * This structure needs to be serializable by SSM (must be a POD type).
@@ -123 +135 @@
     /** Client state flags of type SHCLCLIENTSTATE_FLAGS_. */
     uint32_t                fFlags;
+    /** Legacy cruft we have to keep to support old(er) Guest Additions. */
+    SHCLCLIENTLEGACYSTATE   Legacy;
     /** POD (plain old data) state. */
     SHCLCLIENTPODSTATE      POD;
@@ -149 +163 @@
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
     /** Transfer contextdata. */
-    SHCLTRANSFERCTX          TransferCtx;
+    SHCLTRANSFERCTX             TransferCtx;
 #endif
     /** Structure for keeping the client's pending (deferred return) state.

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

@@ -1243 +1243 @@
                 LogFlowFunc(("fFormats=%#x -> fFormat=%#x, idEvent=%#x\n", fFormats, fFormat, idEvent));
 
-                /*
-                 * Format the message.
-                 */
-                if (pMsg->idMsg == VBOX_SHCL_HOST_MSG_READ_DATA_CID)
-                    HGCMSvcSetU64(&pMsg->aParms[0],
-                                  VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID, pClient->EventSrc.uID, idEvent));
-                else
-                    HGCMSvcSetU32(&pMsg->aParms[0], VBOX_SHCL_HOST_MSG_READ_DATA);
-                HGCMSvcSetU32(&pMsg->aParms[1], fFormat);
-
-                shClSvcMsgAdd(pClient, pMsg, true /* fAppend */);
+                const uint64_t uCID = VBOX_SHCL_CONTEXTID_MAKE(pClient->State.uSessionID, pClient->EventSrc.uID, idEvent);
 
                 rc = VINF_SUCCESS;
+
+                /* Save the context ID in our legacy cruft if we have to deal with old(er) Guest Additions (< 6.1.). */
+                if (!(pClient->State.fGuestFeatures0 & VBOX_SHCL_GF_0_CONTEXT_ID))
+                {
+                    /* Only one data request at a time is supported. */
+                    AssertStmt(pClient->State.Legacy.idCtxWriteData == UINT64_MAX, rc = VERR_WRONG_ORDER);
+                    if (RT_SUCCESS(rc))
+                        pClient->State.Legacy.idCtxWriteData = uCID;
+                }
+
+                if (RT_SUCCESS(rc))
+                {
+                    /*
+                     * Format the message.
+                     */
+                    if (pMsg->idMsg == VBOX_SHCL_HOST_MSG_READ_DATA_CID)
+                        HGCMSvcSetU64(&pMsg->aParms[0], uCID);
+                    else
+                        HGCMSvcSetU32(&pMsg->aParms[0], VBOX_SHCL_HOST_MSG_READ_DATA);
+                    HGCMSvcSetU32(&pMsg->aParms[1], fFormat);
+
+                    shClSvcMsgAdd(pClient, pMsg, true /* fAppend */);
+                }
             }
             else
@@ -1261 +1274 @@
 
             RTCritSectLeave(&pClient->CritSect);
+
+            if (RT_FAILURE(rc))
+                shClSvcMsgFree(pClient, pMsg);
         }
         else
@@ -1311 +1327 @@
     LogFlowFuncEnter();
 
-    SHCLEVENTID idEvent;
-    if (!(pClient->State.fGuestFeatures0 & VBOX_SHCL_GF_0_CONTEXT_ID)) /* Legacy, Guest Additions < 6.1. */
-    {
-        /* 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). */
-        idEvent = ShClEventGetLast(&pClient->EventSrc);
-    }
-    else
-        idEvent = VBOX_SHCL_CONTEXTID_GET_EVENT(pCmdCtx->uContextID);
-
-    if (idEvent == NIL_SHCLEVENTID) /* Event not found? Bail out early. */
-        return VERR_NOT_FOUND;
+    const SHCLEVENTID idEvent = VBOX_SHCL_CONTEXTID_GET_EVENT(pCmdCtx->uContextID);
+
+    AssertMsgReturn(idEvent != NIL_SHCLEVENTID,
+                    ("Event %RU64 empty within supplied context ID\n", idEvent), VERR_WRONG_ORDER);
+#ifdef VBOX_STRICT
+    AssertMsgReturn(ShClEventGet(&pClient->EventSrc, idEvent) != NULL,
+                    ("Event %RU64 not found, even if context ID was around\n", idEvent), VERR_NOT_FOUND);
+#endif
 
     int rc = VINF_SUCCESS;
@@ -1670 +1682 @@
         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->EventSrc.uID,
-                                                                VBOX_SHCL_CONTEXTID_GET_EVENT(cmdCtx.uContextID));
-        ASSERT_GUEST_MSG_RETURN(cmdCtx.uContextID == idCtxExpected,
-                                ("Wrong context ID: %#RX64, expected %#RX64\n", cmdCtx.uContextID, idCtxExpected),
-                                VERR_INVALID_CONTEXT);
         iParm++;
     }
-    else
-    {
-        /** @todo supply CID from client state? Setting it in ShClSvcGuestDataRequest? */
-    }
+    else /* Older Guest Additions (< 6.1) did not supply a context ID. Dig it out of our legacy cruft. */
+    {
+        cmdCtx.uContextID = pClient->State.Legacy.idCtxWriteData;
+        pClient->State.Legacy.idCtxWriteData = UINT64_MAX; /* Reset. */
+    }
+
+    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,
+                            ("Wrong context ID: %#RX64, expected %#RX64\n", cmdCtx.uContextID, idCtxExpected),
+                            VERR_INVALID_CONTEXT);
+
     if (cParms == VBOX_SHCL_CPARMS_DATA_WRITE_61B)
     {
@@ -2110 +2125 @@
 #endif
 
-
+    pClientState->Legacy.idCtxWriteData    = UINT64_MAX;
 }