Changeset 75757 in vbox

Timestamp:

Nov 27, 2018 4:24:13 AM (6 years ago)

Author:

vboxsync

Message:

GuestControlSvc: Defined 4 new commands that will succeed GUEST_MSG_WAIT - completely untested. [corrections]

Location:

trunk

Files:

• include/VBox/HostServices/GuestControlSvc.h (modified) (1 diff)
• src/VBox/HostServices/GuestControl/service.cpp (modified) (6 diffs)

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -304 +304 @@
     /** Gets the next message, returning immediately.
      *
-     * First argument is the message ID returned by the peek and which the caller
-     * expects to retrieve (holds actual message ID when VERR_MISMATCH is returned).
-     * Second argument is the parameter count (output only) and exist for
-     * compatibility with GUEST_MSG_WAIT.  Any subsequent parameters are specific to
-     * the message being retrieved.
+     * All parameters are specific to the message being retrieved, however if the
+     * first one is an integer value it shall be an input parameter holding the
+     * ID of the message being retrieved.  While it would be nice to add a separate
+     * parameter for this purpose, this is difficult without breaking GUEST_MSG_WAIT
+     * compatibility.
      *
      * @retval  VINF_SUCCESS if message retrieved and removed from the pending queue.

trunk/src/VBox/HostServices/GuestControl/service.cpp

@@ -766 +766 @@
                     HGCMSvcSetU32(&mPendingCon.mParms[1], pHostCmd->mParmCount);
                     for (uint32_t i = pHostCmd->mParmCount; i >= 2; i--)
-                        switch (pHostCmd->mpParms[i].type)
+                        switch (pHostCmd->mpParms[i - 2].type)
                         {
                             case VBOX_HGCM_SVC_PARM_32BIT: mPendingCon.mParms[i].u.uint32 = ~(uint32_t)sizeof(uint32_t); break;
                             case VBOX_HGCM_SVC_PARM_64BIT: mPendingCon.mParms[i].u.uint32 = ~(uint32_t)sizeof(uint64_t); break;
-                            case VBOX_HGCM_SVC_PARM_PTR:   mPendingCon.mParms[i].u.uint32 = pHostCmd->mpParms[i].u.pointer.size; break;
+                            case VBOX_HGCM_SVC_PARM_PTR:   mPendingCon.mParms[i].u.uint32 = pHostCmd->mpParms[i - 2].u.pointer.size; break;
                         }
 
@@ -1273 +1273 @@
         paParms[1].u.uint32 = pFirstCmd->mParmCount;
         for (uint32_t i = pFirstCmd->mParmCount; i >= 2; i--)
-            switch (pFirstCmd->mpParms[i].type)
+            switch (pFirstCmd->mpParms[i - 2].type)
             {
                 case VBOX_HGCM_SVC_PARM_32BIT: paParms[i].u.uint32 = ~(uint32_t)sizeof(uint32_t); break;
                 case VBOX_HGCM_SVC_PARM_64BIT: paParms[i].u.uint32 = ~(uint32_t)sizeof(uint64_t); break;
-                case VBOX_HGCM_SVC_PARM_PTR:   paParms[i].u.uint32 = pFirstCmd->mpParms[i].u.pointer.size; break;
+                case VBOX_HGCM_SVC_PARM_PTR:   paParms[i].u.uint32 = pFirstCmd->mpParms[i - 2].u.pointer.size; break;
             }
 
@@ -1330 +1330 @@
      * Validate the request.
      *
-     * Note! The 2nd parameter is basically ignored as it's only purpose is
-     *       compatibility with GUEST_MSG_WAIT
-     */
-    ASSERT_GUEST_MSG_RETURN(cParms >= 2, ("cParms=%u!\n", cParms), VERR_INVALID_PARAMETER);
-    ASSERT_GUEST_MSG_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, ("type=%u\n", paParms[0].type), VERR_WRONG_TYPE);
-    uint32_t const idMsgExpected  = paParms[0].u.uint32;
-    ASSERT_GUEST_MSG_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_32BIT, ("type=%u\n", paParms[0].type), VERR_WRONG_TYPE);
+     * The weird first parameter logic is due to GUEST_MSG_WAIT compatibility
+     * (don't want to rewrite all the message structures).
+     */
+    uint32_t const idMsgExpected = cParms > 0 && paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT ? paParms[0].u.uint32
+                                 : cParms > 0 && paParms[0].type == VBOX_HGCM_SVC_PARM_64BIT ? paParms[0].u.uint64
+                                 : UINT32_MAX;
 
     ClientStateMapIter itClientState = mClientStateMap.find(idClient);
@@ -1351 +1350 @@
         HostCommand *pFirstCmd = *itFirstCmd;
 
-        /* The 'peek' parameters. */
-        paParms[0].u.uint32 = pFirstCmd->mMsgType;
-        paParms[1].u.uint32 = pFirstCmd->mParmCount;
-        ASSERT_GUEST_MSG_RETURN(pFirstCmd->mMsgType == idMsgExpected,
+        ASSERT_GUEST_MSG_RETURN(pFirstCmd->mMsgType == idMsgExpected || idMsgExpected == UINT32_MAX,
                                 ("idMsg=%u cParms=%u, caller expected %u and %u\n",
                                  pFirstCmd->mMsgType, pFirstCmd->mParmCount, idMsgExpected, cParms),
@@ -1364 +1360 @@
 
         /* Check the parameter types. */
-        for (uint32_t i = 2; i < cParms; i++)
+        for (uint32_t i = 0; i < cParms; i++)
             ASSERT_GUEST_MSG_RETURN(pFirstCmd->mpParms[i].type == paParms[i].type,
                                     ("param #%u: type %u, caller expected %u\n", i, pFirstCmd->mpParms[i].type, paParms[i].type),
@@ -1376 +1372 @@
          */
         int rc = VINF_SUCCESS;
-        for (uint32_t i = 2; i < cParms; i++)
+        for (uint32_t i = 0; i < cParms; i++)
             switch (pFirstCmd->mpParms[i].type)
             {