Changeset 47620 in vbox for trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestCtrl.cpp

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.

File:

• trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestCtrl.cpp (modified) (7 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)