Changeset 91100 in vbox

Timestamp:

Sep 2, 2021 9:01:51 PM (3 years ago)

Author:

vboxsync

Message:

HGCM: Fixes to svcHlpDisconnectClient / DisconnectClient. Documentation updates. oem2ticketref:46 bugref:10038

Location:

trunk

Files:

• include/VBox/hgcmsvc.h (modified) (2 diffs)
• src/VBox/Main/src-client/HGCM.cpp (modified) (5 diffs)

trunk/include/VBox/hgcmsvc.h

@@ -107 +107 @@
      * This can only be used during VBOXHGCMSVCFNTABLE::pfnConnect or
      * VBOXHGCMSVCFNTABLE::pfnDisconnect and will fail if called out side that
-     * context.
+     * context.  Using this on the new client during VBOXHGCMSVCFNTABLE::pfnConnect
+     * is not advisable, it would be better to just return a failure status for that
+     * and it will be done automatically.  (It is not possible to call this method
+     * on a client passed to VBOXHGCMSVCFNTABLE::pfnDisconnect.)
      *
      * There will be no VBOXHGCMSVCFNTABLE::pfnDisconnect callback for a client
@@ -119 +122 @@
      *          it ourselves.
      */
-    DECLR3CALLBACKMEMBER(int, pfnDisconnectClient, (void *pvInstance, uint32_t u32ClientID));
+    DECLR3CALLBACKMEMBER(int, pfnDisconnectClient, (void *pvInstance, uint32_t idClient));
 
     /**

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

@@ -149 +149 @@
 
         static DECLCALLBACK(int)  svcHlpCallComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc);
-        static DECLCALLBACK(int)  svcHlpDisconnectClient(void *pvInstance, uint32_t u32ClientId);
+        static DECLCALLBACK(int)  svcHlpDisconnectClient(void *pvInstance, uint32_t idClient);
         static DECLCALLBACK(bool) svcHlpIsCallRestored(VBOXHGCMCALLHANDLE callHandle);
         static DECLCALLBACK(bool) svcHlpIsCallCancelled(VBOXHGCMCALLHANDLE callHandle);
@@ -927 +927 @@
  * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnDisconnectClient}
  */
-/* static */ DECLCALLBACK(int) HGCMService::svcHlpDisconnectClient(void *pvInstance, uint32_t u32ClientId)
+/* static */ DECLCALLBACK(int) HGCMService::svcHlpDisconnectClient(void *pvInstance, uint32_t idClient)
 {
      HGCMService *pService = static_cast <HGCMService *> (pvInstance);
@@ -937 +937 @@
      AssertReturn(pService->m_fInConnectOrDisconnect, VERR_INVALID_CONTEXT);
 
-     return pService->DisconnectClient(u32ClientId, true, NULL);
+     /* Resolve the client ID and verify that it belongs to this service before
+        trying to disconnect it. */
+     int rc = VERR_NOT_FOUND;
+     HGCMClient * const pClient = (HGCMClient *)hgcmObjReference(idClient, HGCMOBJ_CLIENT);
+     if (pClient)
+     {
+         if (pClient->pService == pService)
+             rc = pService->DisconnectClient(idClient, true, pClient);
+         hgcmObjDereference(pClient);
+     }
+     return rc;
 }
 
@@ -1794 +1804 @@
  * @param   u32ClientId     The handle of the client.
  * @param   fFromService    Set if called by the service via
- *                          svcHlpDisconnectClient().  pClient can be NULL when
- *                          this is @c true.
- * @param   pClient         The client disconnecting.  NULL if from service.
+ *                          svcHlpDisconnectClient().
+ * @param   pClient         The client disconnecting.
  * @return  VBox status code.
  */
 int HGCMService::DisconnectClient(uint32_t u32ClientId, bool fFromService, HGCMClient *pClient)
 {
-    Assert(pClient || !fFromService);
-
+    AssertPtr(pClient);
     LogFlowFunc(("client id = %d, fFromService = %d, pClient = %p\n", u32ClientId, fFromService, pClient));
 
@@ -1847 +1855 @@
     }
 
-    if (pClient)
-        LogFunc(("idClient=%u m_cClients=%u m_acClients[%u]=%u %s (cPendingCalls=%u) rc=%Rrc\n", u32ClientId, m_cClients,
-                 pClient->idxCategory, m_acClients[pClient->idxCategory], m_pszSvcName, pClient->cPendingCalls, rc));
+    LogFunc(("idClient=%u m_cClients=%u m_acClients[%u]=%u %s (cPendingCalls=%u) rc=%Rrc\n", u32ClientId, m_cClients,
+             pClient->idxCategory, m_acClients[pClient->idxCategory], m_pszSvcName, pClient->cPendingCalls, rc));
 
     /*