Changeset 91748 in vbox for trunk/src/VBox/Main/src-client/HGCM.cpp

Timestamp:

Oct 14, 2021 9:01:31 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

147506

Message:

HGCM: Some updates for bugref:6724.

File:

• trunk/src/VBox/Main/src-client/HGCM.cpp (modified) (14 diffs)

trunk/src/VBox/Main/src-client/HGCM.cpp

@@ -213 +213 @@
             , idxCategory(a_idxCategory)
             , cPendingCalls(0)
+            , m_fGuestAccessible(false)
         {
             Assert(idxCategory < HGCM_CLIENT_CATEGORY_MAX);
@@ -219 +220 @@
 
         int Init(HGCMService *pSvc);
+
+        /** Lookups a client object by its handle. */
+        static HGCMClient *ReferenceByHandle(uint32_t idClient)
+        {
+            return (HGCMClient *)hgcmObjReference(idClient, HGCMOBJ_CLIENT);
+        }
+
+        /** Lookups a client object by its handle and makes sure that it's accessible to the guest. */
+        static HGCMClient *ReferenceByHandleForGuest(uint32_t idClient)
+        {
+            HGCMClient *pClient = (HGCMClient *)hgcmObjReference(idClient, HGCMOBJ_CLIENT);
+            if (pClient)
+            {
+                if (RT_LIKELY(pClient->m_fGuestAccessible))
+                    return pClient;
+                pClient->Dereference();
+            }
+            return NULL;
+        }
+
+        /** Make the client object accessible to the guest. */
+        void makeAccessibleToGuest()
+        {
+            ASMAtomicWriteBool(&m_fGuestAccessible, true);
+        }
 
         /** Service that the client is connected to. */
@@ -235 +261 @@
         /** Number of pending calls. */
         uint32_t volatile cPendingCalls;
+
+    protected:
+        /** Set if the client is accessible to the guest, clear if not. */
+        bool volatile m_fGuestAccessible;
 
     private: /* none of this: */
@@ -675 +705 @@
                 LogFlowFunc(("SVC_MSG_CONNECT u32ClientId = %d\n", pMsg->u32ClientId));
 
-                HGCMClient *pClient = (HGCMClient *)hgcmObjReference(pMsg->u32ClientId, HGCMOBJ_CLIENT);
+                HGCMClient *pClient = HGCMClient::ReferenceByHandle(pMsg->u32ClientId);
 
                 if (pClient)
@@ -719 +749 @@
                              pMsg->u32ClientId, pMsg->u32Function, pMsg->cParms, pMsg->paParms));
 
-                HGCMClient *pClient = (HGCMClient *)hgcmObjReference(pMsg->u32ClientId, HGCMOBJ_CLIENT);
+                HGCMClient *pClient = HGCMClient::ReferenceByHandleForGuest(pMsg->u32ClientId);
 
                 if (pClient)
@@ -741 +771 @@
                 LogFlowFunc(("SVC_MSG_GUESTCANCELLED idClient = %d\n", pMsg->idClient));
 
-                HGCMClient *pClient = (HGCMClient *)hgcmObjReference(pMsg->idClient, HGCMOBJ_CLIENT);
+                HGCMClient *pClient = HGCMClient::ReferenceByHandleForGuest(pMsg->idClient);
 
                 if (pClient)
@@ -771 +801 @@
                 LogFlowFunc(("SVC_MSG_LOADSTATE\n"));
 
-                HGCMClient *pClient = (HGCMClient *)hgcmObjReference(pMsg->u32ClientId, HGCMOBJ_CLIENT);
+                HGCMClient *pClient = HGCMClient::ReferenceByHandle(pMsg->u32ClientId);
 
                 if (pClient)
@@ -804 +834 @@
                 LogFlowFunc(("SVC_MSG_SAVESTATE\n"));
 
-                HGCMClient *pClient = (HGCMClient *)hgcmObjReference(pMsg->u32ClientId, HGCMOBJ_CLIENT);
+                HGCMClient *pClient = HGCMClient::ReferenceByHandle(pMsg->u32ClientId);
 
                 rc = VINF_SUCCESS;
@@ -940 +970 @@
         trying to disconnect it. */
      int rc = VERR_NOT_FOUND;
-     HGCMClient * const pClient = (HGCMClient *)hgcmObjReference(idClient, HGCMOBJ_CLIENT);
+     HGCMClient * const pClient = HGCMClient::ReferenceByHandle(idClient);
      if (pClient)
      {
@@ -1483 +1513 @@
         {
             uint32_t const     idClient = pSvc->m_paClientIds[0];
-            HGCMClient * const pClient  = (HGCMClient *)hgcmObjReference(idClient, HGCMOBJ_CLIENT);
+            HGCMClient * const pClient  = HGCMClient::ReferenceByHandle(idClient);
             Assert(pClient);
             LogFlowFunc(("handle %d/%p\n", pSvc->m_paClientIds[0], pClient));
@@ -1789 +1819 @@
 
         ReferenceService();
+
+        /* The guest may now use this client object. */
+        pClient->makeAccessibleToGuest();
     }
     else
@@ -2316 +2349 @@
                              pMsg->u32ClientId));
 
-                HGCMClient *pClient = (HGCMClient *)hgcmObjReference(pMsg->u32ClientId, HGCMOBJ_CLIENT);
+                HGCMClient *pClient = HGCMClient::ReferenceByHandle(pMsg->u32ClientId);
 
                 if (!pClient)
@@ -2768 +2801 @@
 
     /* Resolve the client handle to the client instance pointer. */
-    HGCMClient *pClient = (HGCMClient *)hgcmObjReference(u32ClientId, HGCMOBJ_CLIENT);
+    HGCMClient *pClient = HGCMClient::ReferenceByHandleForGuest(u32ClientId);
 
     if (pClient)
@@ -2798 +2831 @@
 
     /* Resolve the client handle to the client instance pointer. */
-    HGCMClient *pClient = (HGCMClient *)hgcmObjReference(idClient, HGCMOBJ_CLIENT);
+    HGCMClient *pClient = HGCMClient::ReferenceByHandleForGuest(idClient);
 
     if (pClient)