Changeset 47620 in vbox for trunk/src

Timestamp:

Aug 8, 2013 8:09:42 PM (11 years ago)

Author:

vboxsync

Message:

GuestCtrl: Fixed per-session command filtering, added command to disable the filter again.

Location:

trunk/src/VBox

Files:

• Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestCtrl.cpp (modified) (7 diffs)
• Additions/common/VBoxService/VBoxServiceControlSession.cpp (modified) (1 diff)
• HostServices/GuestControl/service.cpp (modified) (10 diffs)

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestCtrl.cpp

@@ -50 +50 @@
  *
  * @returns VBox status code
- * @param   puClientId    Where to put the client id on success. The client id
+ * @param   puClientId    Where to put The client ID on success. The client ID
  *                        must be passed to all the other calls to the service.
  */
@@ -77 +77 @@
  *
  * @returns VBox status code.
- * @param   uClientId     The client id returned by VbglR3GuestCtrlConnect().
+ * @param   uClientId     The client ID returned by VbglR3GuestCtrlConnect().
  */
 VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t uClientId)
@@ -97 +97 @@
  *
  * @returns VBox status code.
- * @param   uClientId       The client id returned by VbglR3GuestCtrlConnect().
+ * @param   uClientId       The client ID returned by VbglR3GuestCtrlConnect().
  * @param   puMsg           Where to store the message id.
  * @param   puNumParms      Where to store the number  of parameters which will be received
@@ -134 +134 @@
  * Asks the host guest control service to set a command filter to this
  * client so that it only will receive certain commands in the future.
+ * The filter(s) are a bitmask for the context IDs, served from the host.
  *
  * @return  IPRT status code.
- * @param   uClientId       The client id returned by VbglR3GuestCtrlConnect().
- * @param   uFilterAdd      Filter mask to add.
- * @param   uFilterRemove   Filter mask to remove.
- */
-VBGLR3DECL(int) VbglR3GuestCtrlMsgSetFilter(uint32_t uClientId,
+ * @param   uClientId       The client ID returned by VbglR3GuestCtrlConnect().
+ * @param   uFilterAdd      Context ID filter mask to add.
+ * @param   uFilterRemove   Context ID filter mask to remove.
+ */
+VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId,
                                             uint32_t uFilterAdd, uint32_t uFilterRemove)
 {
-    HGCMMsgCmdSetFilter Msg;
+    HGCMMsgCmdFilterSet Msg;
 
     Msg.hdr.result      = VERR_WRONG_ORDER;
     Msg.hdr.u32ClientID = uClientId;
-    Msg.hdr.u32Function = GUEST_MSG_FILTER; /* Tell the host we want to set a filter. */
-    Msg.hdr.cParms      = 2;
+    Msg.hdr.u32Function = GUEST_MSG_FILTER_SET; /* Tell the host we want to set a filter. */
+    Msg.hdr.cParms      = 3;
 
     VbglHGCMParmUInt32Set(&Msg.add, uFilterAdd);
     VbglHGCMParmUInt32Set(&Msg.remove, uFilterRemove);
+    VbglHGCMParmUInt32Set(&Msg.flags, 0 /* Flags, unused */);
+
+    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
+    if (RT_SUCCESS(rc))
+        rc = Msg.hdr.result;
+    return rc;
+}
+
+
+/**
+ * Disables a previously set message filter.
+ *
+ * @return  IPRT status code.
+ * @param   uClientId       The client ID returned by VbglR3GuestCtrlConnect().
+ */
+VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterUnset(uint32_t uClientId)
+{
+    HGCMMsgCmdFilterUnset Msg;
+
+    Msg.hdr.result      = VERR_WRONG_ORDER;
+    Msg.hdr.u32ClientID = uClientId;
+    Msg.hdr.u32Function = GUEST_MSG_FILTER_UNSET; /* Tell the host we want to unset the filter. */
+    Msg.hdr.cParms      = 1;
+
+    VbglHGCMParmUInt32Set(&Msg.flags, 0 /* Flags, unused */);
 
     int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
@@ -165 +191 @@
  *
  * @return  IPRT status code.
- * @param   uClientId       The client id returned by VbglR3GuestCtrlConnect().
+ * @param   uClientId       The client ID returned by VbglR3GuestCtrlConnect().
  */
 VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t uClientId)
@@ -175 +201 @@
     Msg.hdr.u32Function = GUEST_MSG_SKIP; /* Tell the host we want to skip
                                              the current assigned command. */
-    Msg.hdr.cParms      = 0;              /* No parameters needed. */
+    Msg.hdr.cParms      = 1;
+
+    VbglHGCMParmUInt32Set(&Msg.flags, 0 /* Flags, unused */);
 
     int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
@@ -189 +217 @@
  *
  * @returns VBox status code.
- * @param   uClientId     The client id returned by VbglR3GuestCtrlConnect().
+ * @param   uClientId     The client ID returned by VbglR3GuestCtrlConnect().
  */
 VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(uint32_t uClientId)

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp

@@ -1080 +1080 @@
     if (RT_SUCCESS(rc))
     {
-        /* Set session filter. */
+        /* Set session filter. This prevents the guest control
+         * host service to send messages which belong to another
+         * session we don't want to handle. */
         uint32_t uFilterAdd =
             VBOX_GUESTCTRL_CONTEXTID_MAKE_SESSION(pSession->StartupInfo.uSessionID);
-
-        rc = VbglR3GuestCtrlMsgSetFilter(uClientID, uFilterAdd, 0 /* Filter remove */);
-        VBoxServiceVerbose(3, "Setting message filterAdd=%RU32 returned %Rrc\n",
+        uFilterAdd |= 0x7FFFFFF; /* We only want to filter for session IDs. */
+
+        rc = VbglR3GuestCtrlMsgFilterSet(uClientID, uFilterAdd, 0 /* Filter remove */);
+        VBoxServiceVerbose(3, "Setting message filterAdd=0x%x returned %Rrc\n",
                            uFilterAdd, rc);
 

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

@@ -563 +563 @@
             return false;
 
-#ifdef DEBUG_andy
-            LogFlowFunc(("[Client %RU32] mFlags=%x, mContextID=%RU32, mContextFilter=%x, filterRes=%x, sessionID=%RU32\n",
-                         mID, mFlags, pHostCmd->mContextID, mContextFilter,
-                         pHostCmd->mContextID & mContextFilter, VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pHostCmd->mContextID)));
+#ifdef DEBUG
+        LogFlowFunc(("[Client %RU32] mFlags=0x%x, mContextID=%RU32 (session %RU32), mContextFilter=0x%x (result=%x -> %RTbool)\n",
+                     mID, mFlags, pHostCmd->mContextID,
+                     VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pHostCmd->mContextID),
+                     mContextFilter,
+                     pHostCmd->mContextID & pHostCmd->mContextID,
+                     (pHostCmd->mContextID & mContextFilter) == pHostCmd->mContextID));
 #endif
         /*
-         * If a sesseion filter is set, only obey those sessions we're interested in.
+         * If a sesseion filter is set, only obey those commands we're interested in
+         * by applying our context ID filter mask and compare the result with the
+         * original context ID.
          */
-        bool fWant = false;
+        bool fWant;
         if (mFlags & CLIENTSTATE_FLAG_CONTEXTFILTER)
         {
-            if ((pHostCmd->mContextID & mContextFilter) == mContextFilter)
-                fWant = true;
+            fWant =
+                (pHostCmd->mContextID & mContextFilter) == pHostCmd->mContextID;
         }
         else /* Client is interested in all commands. */
@@ -995 +1000 @@
     int clientDisconnect(uint32_t u32ClientID, void *pvClient);
     int clientGetCommand(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
-    int clientSetMsgFilter(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
+    int clientSetMsgFilterSet(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
+    int clientSetMsgFilterUnset(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     int clientSkipMsg(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     int cancelHostCmd(uint32_t u32ContextID);
@@ -1136 +1142 @@
 }
 
-int Service::clientSetMsgFilter(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle,
-                                uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+int Service::clientSetMsgFilterSet(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle,
+                                   uint32_t cParms, VBOXHGCMSVCPARM paParms[])
 {
     /*
@@ -1149 +1155 @@
         return VERR_NOT_FOUND; /* Should never happen. */
 
-    if (cParms != 2)
+    if (cParms != 3)
         return VERR_INVALID_PARAMETER;
 
@@ -1166 +1172 @@
             clientState.mContextFilter &= ~uMaskRemove;
 
-        LogFlowFunc(("Client ID=%RU32 now has filter=%x enabled (flags=%x, maskAdd=%x, maskRemove=%x)\n",
+        LogFlowFunc(("[Client %RU32] Setting message filter=0x%x set (flags=0x%x, maskAdd=0x%x, maskRemove=0x%x)\n",
                      u32ClientID, clientState.mContextFilter, clientState.mFlags,
                      uMaskAdd, uMaskRemove));
@@ -1172 +1178 @@
 
     return rc;
+}
+
+int Service::clientSetMsgFilterUnset(uint32_t u32ClientID, VBOXHGCMCALLHANDLE callHandle,
+                                     uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+{
+    /*
+     * Lookup client in our list so that we can assign the context ID of
+     * a command to that client.
+     */
+    ClientStateMapIter itClientState = mClientStateMap.find(u32ClientID);
+    AssertMsg(itClientState != mClientStateMap.end(), ("Client with ID=%RU32 not found when it should be present\n",
+                                                       u32ClientID));
+    if (itClientState == mClientStateMap.end())
+        return VERR_NOT_FOUND; /* Should never happen. */
+
+    if (cParms != 1)
+        return VERR_INVALID_PARAMETER;
+
+    ClientState &clientState = itClientState->second;
+
+    clientState.mFlags &= ~CLIENTSTATE_FLAG_CONTEXTFILTER;
+    clientState.mContextFilter = 0;
+
+    LogFlowFunc(("[Client %RU32} Unset message filter\n", u32ClientID));
+    return VINF_SUCCESS;
 }
 
@@ -1187 +1218 @@
         return VERR_NOT_FOUND; /* Should never happen. */
 
-    if (cParms != 0)
+    if (cParms != 1)
         return VERR_INVALID_PARAMETER;
 
@@ -1325 +1356 @@
                     LogFlowFunc(("Waking up client ID=%RU32 failed with rc=%Rrc\n",
                                  itClientState->first, rc2));
-#ifdef DEBUG_andy
+#ifdef DEBUG
                 uClientsWokenUp++;
 #endif
@@ -1333 +1364 @@
         }
 
-#ifdef DEBUG_andy
+#ifdef DEBUG
         LogFlowFunc(("%RU32 clients have been woken up\n", uClientsWokenUp));
 #endif
@@ -1385 +1416 @@
                  * Since VBox 4.3+.
                  */
-                case GUEST_MSG_FILTER:
-                    LogFlowFunc(("[Client %RU32] GUEST_MSG_FILTER\n", u32ClientID));
-                    rc = clientSetMsgFilter(u32ClientID, callHandle, cParms, paParms);
+                case GUEST_MSG_FILTER_SET:
+                    LogFlowFunc(("[Client %RU32] GUEST_MSG_FILTER_SET\n", u32ClientID));
+                    rc = clientSetMsgFilterSet(u32ClientID, callHandle, cParms, paParms);
+                    break;
+
+                /*
+                 * Unsetting the message filter flag.
+                 */
+                case GUEST_MSG_FILTER_UNSET:
+                    LogFlowFunc(("[Client %RU32] GUEST_MSG_FILTER_UNSET\n", u32ClientID));
+                    rc = clientSetMsgFilterUnset(u32ClientID, callHandle, cParms, paParms);
                     break;