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

Timestamp:

Oct 28, 2019 10:09:35 AM (5 years ago)

Author:

vboxsync

Message:

Shared Clipboard: Got rid of the protocol version in VBOX_SHCL_GUEST_FN_CONNECT and internals; instead use the get / query features bit field.

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

• VBoxSharedClipboardSvc-internal.h (modified) (2 diffs)
• VBoxSharedClipboardSvc.cpp (modified) (20 diffs)

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

@@ -88 +88 @@
     /** The client's session ID. */
     SHCLSESSIONID           uSessionID;
-    /** Optional protocol version the client uses. Set to 0 by default. */
-    uint32_t                uProtocolVer;
     /** Guest feature flags, VBOX_SHCL_GF_0_XXX. */
     uint64_t                fGuestFeatures0;
@@ -96 +94 @@
     /** Maximum chunk size to use for data transfers. Set to _64K by default. */
     uint32_t                cbChunkSize;
+    /** Where the transfer sources its data from. */
     SHCLSOURCE              enmSource;
     /** The client's transfers state. */

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

@@ -422 +422 @@
  * Sets the VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD return parameters.
  *
- * This function does the necessary translation between the legacy protocol (v0) and the new protocols (>= v1),
+ * This function does the necessary translation between the legacy protocol (<= VBox 6.0) and the new protocols (>= VBox 6.1),
  * as messages are always stored as >= v1 messages in the message queue.
  *
@@ -1113 +1113 @@
 
     SHCLEVENTID uEvent;
-    if (pClient->State.uProtocolVer == 0)
-    {
-        /* Protocol v0 did not have any context ID handling, so we ASSUME that the last event registered
+    if (!(pClient->State.fGuestFeatures0 & VBOX_SHCL_GF_0_CONTEXT_ID)) /* Legacy */
+    {
+        /* 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);
@@ -1204 +1204 @@
     RT_ZERO(cmdCtx);
 
-    if (pClient->State.uProtocolVer == 0) /* Legacy protocol */
+    if (!(pClient->State.fGuestFeatures0 & VBOX_SHCL_GF_0_CONTEXT_ID)) /* Legacy */
     {
         if (cParms < 2)
@@ -1431 +1431 @@
     AssertPtr(pClient);
 
-    LogFunc(("u32ClientID=%RU32 (proto %RU32), fn=%RU32 (%s), cParms=%RU32, paParms=%p\n",
-             u32ClientID, pClient->State.uProtocolVer, u32Function, ShClGuestMsgToStr(u32Function), cParms, paParms));
+    LogFunc(("u32ClientID=%RU32, fn=%RU32 (%s), cParms=%RU32, paParms=%p\n",
+             u32ClientID, u32Function, ShClGuestMsgToStr(u32Function), cParms, paParms));
 
 #ifdef DEBUG
@@ -1458 +1458 @@
                 rc = VERR_INVALID_PARAMETER;
             }
-            else if (   paParms[0].type != VBOX_HGCM_SVC_PARM_32BIT  /* uProtocolVer */
-                     || paParms[1].type != VBOX_HGCM_SVC_PARM_32BIT  /* uProtocolFlags */
-                     || paParms[2].type != VBOX_HGCM_SVC_PARM_32BIT  /* cbChunkSize */
-                     || paParms[3].type != VBOX_HGCM_SVC_PARM_32BIT  /* enmCompression */
-                     || paParms[4].type != VBOX_HGCM_SVC_PARM_32BIT) /* enmChecksumType */
+            else if (   paParms[0].type != VBOX_HGCM_SVC_PARM_32BIT  /* cbChunkSize */
+                     || paParms[1].type != VBOX_HGCM_SVC_PARM_32BIT  /* enmCompression */
+                     || paParms[2].type != VBOX_HGCM_SVC_PARM_32BIT) /* enmChecksumType */
             {
                 rc = VERR_INVALID_PARAMETER;
@@ -1472 +1470 @@
             else
             {
-                /* Update the protocol version and tell the guest. */
-                pClient->State.uProtocolVer = 1;
-
-                LogFlowFunc(("Now using protocol v%RU32\n", pClient->State.uProtocolVer));
-
-                HGCMSvcSetU32(&paParms[0], pClient->State.uProtocolVer);
-                HGCMSvcSetU32(&paParms[1], 0 /* Procotol flags, not used yet */);
-                HGCMSvcSetU32(&paParms[2], pClient->State.cbChunkSize);
-                HGCMSvcSetU32(&paParms[3], 0 /* Compression type, not used yet */);
-                HGCMSvcSetU32(&paParms[4], 0 /* Checksum type, not used yet */);
+                /* Report back supported chunk size to the guest. */
+                HGCMSvcSetU32(&paParms[0], _64K); /* Chunk size */ /** @todo Make chunk size dynamic. */
 
                 rc = VINF_SUCCESS;
@@ -1523 +1513 @@
             uint32_t uFormats = 0;
 
-            if (pClient->State.uProtocolVer == 0)
+            if (!(pClient->State.fGuestFeatures0 & VBOX_SHCL_GF_0_CONTEXT_ID)) /* Legacy */
             {
                 if (cParms != 1)
@@ -1799 +1789 @@
     LogFlowFuncEnter();
 
-    pClientState->uProtocolVer    = 0;
     pClientState->fGuestFeatures0 = VBOX_SHCL_GF_NONE;
     pClientState->fGuestFeatures1 = VBOX_SHCL_GF_NONE;
@@ -1900 +1889 @@
 static SSMFIELD const s_aShClSSMClientState[] =
 {
-    SSMFIELD_ENTRY(SHCLCLIENTSTATE, uProtocolVer),
-    SSMFIELD_ENTRY(SHCLCLIENTSTATE, cbChunkSize),
-    SSMFIELD_ENTRY(SHCLCLIENTSTATE, enmSource),
+    /** Note: Saving the session ID not necessary, as they're not persistent across state save/restore. */
+    SSMFIELD_ENTRY    (SHCLCLIENTSTATE, fGuestFeatures0),
+    SSMFIELD_ENTRY    (SHCLCLIENTSTATE, fGuestFeatures1),
+    SSMFIELD_ENTRY    (SHCLCLIENTSTATE, cbChunkSize),
+    SSMFIELD_ENTRY    (SHCLCLIENTSTATE, enmSource),
     SSMFIELD_ENTRY_TERM()
 };
@@ -1909 +1900 @@
  * SSM descriptor table for the SHCLCLIENTURISTATE structure.
  */
-static SSMFIELD const s_aShClSSMClientURIState[] =
+static SSMFIELD const s_aShClSSMClientTransferState[] =
 {
     SSMFIELD_ENTRY(SHCLCLIENTTRANSFERSTATE, enmTransferDir),
@@ -1938 +1929 @@
 static DECLCALLBACK(int) svcSaveState(void *, uint32_t u32ClientID, void *pvClient, PSSMHANDLE pSSM)
 {
-    RT_NOREF(u32ClientID);
+    LogFlowFuncEnter();
 
 #ifndef UNIT_TEST
@@ -1947 +1938 @@
      * Pending requests, if any, will be completed in svcDisconnect.
      */
+    RT_NOREF(u32ClientID);
     LogFunc(("u32ClientID=%RU32\n", u32ClientID));
 
@@ -1958 +1950 @@
     AssertRCReturn(rc, rc);
 
-    rc = SSMR3PutStructEx(pSSM, &pClient->State.Transfers, sizeof(pClient->State.Transfers), 0 /*fFlags*/, &s_aShClSSMClientURIState[0], NULL);
+    rc = SSMR3PutStructEx(pSSM, &pClient->State.Transfers, sizeof(pClient->State.Transfers), 0 /*fFlags*/, &s_aShClSSMClientTransferState[0], NULL);
     AssertRCReturn(rc, rc);
 
@@ -2026 +2018 @@
 static DECLCALLBACK(int) svcLoadState(void *, uint32_t u32ClientID, void *pvClient, PSSMHANDLE pSSM, uint32_t uVersion)
 {
+    LogFlowFuncEnter();
+
 #ifndef UNIT_TEST
+
     RT_NOREF(u32ClientID, uVersion);
-
-    LogFunc(("u32ClientID=%RU32\n", u32ClientID));
 
     PSHCLCLIENT pClient = (PSHCLCLIENT)pvClient;
@@ -2038 +2031 @@
     int rc = SSMR3GetU32(pSSM, &lenOrVer);
     AssertRCReturn(rc, rc);
+
+    LogFunc(("u32ClientID=%RU32, lenOrVer=%#RX64\n", u32ClientID, lenOrVer));
+
     if (lenOrVer == VBOX_SHCL_SSM_VER_0)
     {
@@ -2044 +2040 @@
     else if (lenOrVer == VBOX_SHCL_SSM_VER_1)
     {
-        rc = SSMR3GetStructEx(pSSM, &pClient->State, sizeof(pClient->State), 0 /*fFlags*/, &s_aShClSSMClientState[0], NULL);
+        rc = SSMR3GetStructEx(pSSM, &pClient->State, sizeof(pClient->State), 0 /* fFlags */,
+                              &s_aShClSSMClientState[0], NULL);
         AssertRCReturn(rc, rc);
 
-        rc = SSMR3GetStructEx(pSSM, &pClient->State.Transfers, sizeof(pClient->State.Transfers), 0 /*fFlags*/, &s_aShClSSMClientURIState[0], NULL);
+        rc = SSMR3GetStructEx(pSSM, &pClient->State.Transfers, sizeof(pClient->State.Transfers), 0 /* fFlags */,
+                              &s_aShClSSMClientTransferState[0], NULL);
         AssertRCReturn(rc, rc);
 
@@ -2192 +2190 @@
     int rc = VINF_SUCCESS;
 
-    LogFlowFunc(("ptable=%p\n", pTable));
-
-    if (!pTable)
+    LogFlowFunc(("pTable=%p\n", pTable));
+
+    if (!VALID_PTR(pTable))
     {
         rc = VERR_INVALID_PARAMETER;
@@ -2200 +2198 @@
     else
     {
-        LogFunc(("ptable->cbSize = %d, ptable->u32Version = 0x%08X\n", pTable->cbSize, pTable->u32Version));
+        LogFunc(("pTable->cbSize = %d, ptable->u32Version = 0x%08X\n", pTable->cbSize, pTable->u32Version));
 
         if (   pTable->cbSize     != sizeof (VBOXHGCMSVCFNTABLE)
             || pTable->u32Version != VBOX_HGCM_SVC_VERSION)
         {
-            rc = VERR_INVALID_PARAMETER;
+            rc = VERR_VERSION_MISMATCH;
         }
         else
@@ -2213 +2211 @@
             pTable->cbClient = sizeof(SHCLCLIENT);
 
-            pTable->pfnUnload     = svcUnload;
-            pTable->pfnConnect    = svcConnect;
-            pTable->pfnDisconnect = svcDisconnect;
-            pTable->pfnCall       = svcCall;
-            pTable->pfnHostCall   = svcHostCall;
-            pTable->pfnSaveState  = svcSaveState;
-            pTable->pfnLoadState  = svcLoadState;
-            pTable->pfnRegisterExtension  = svcRegisterExtension;
-            pTable->pfnNotify     = NULL;
-            pTable->pvService     = NULL;
+            pTable->pfnUnload            = svcUnload;
+            pTable->pfnConnect           = svcConnect;
+            pTable->pfnDisconnect        = svcDisconnect;
+            pTable->pfnCall              = svcCall;
+            pTable->pfnHostCall          = svcHostCall;
+            pTable->pfnSaveState         = svcSaveState;
+            pTable->pfnLoadState         = svcLoadState;
+            pTable->pfnRegisterExtension = svcRegisterExtension;
+            pTable->pfnNotify            = NULL;
+            pTable->pvService            = NULL;
 
             /* Service specific initialization. */
@@ -2229 +2227 @@
     }
 
+    LogFlowFunc(("Returning %Rrc\n", rc));
     return rc;
 }