Changeset 75406 in vbox

Timestamp:

Nov 12, 2018 7:49:08 PM (6 years ago)

Author:

vboxsync

Message:

VMMDev/HGCM: Added PDM interface + HGCM server helper for finding out if a command/call is being resubmitted on restore or not. This is handy for returning returning an async wait call to the guest upon restore. bugref:3544

Location:

trunk

Files:

• include/VBox/hgcmsvc.h (modified) (2 diffs)
• include/VBox/vmm/pdmifs.h (modified) (1 diff)
• src/VBox/Devices/VMMDev/VMMDev.cpp (modified) (1 diff)
• src/VBox/Devices/VMMDev/VMMDevHGCM.cpp (modified) (7 diffs)
• src/VBox/Devices/VMMDev/VMMDevHGCM.h (modified) (1 diff)
• src/VBox/Main/src-client/HGCM.cpp (modified) (5 diffs)

trunk/include/VBox/hgcmsvc.h

@@ -82 +82 @@
     /** The service disconnects the client. */
     DECLR3CALLBACKMEMBER(void, pfnDisconnectClient, (void *pvInstance, uint32_t u32ClientID));
+
+    /**
+     * Check if the @a callHandle is for a call restored and re-submitted from saved state.
+     *
+     * @returns true if restored, false if not.
+     * @param   callHandle      The call we're checking up on.
+     */
+    DECLR3CALLBACKMEMBER(bool, pfnIsCallRestored, (VBOXHGCMCALLHANDLE callHandle));
+
 } VBOXHGCMSVCHELPERS;
 
@@ -392 +401 @@
      *  Return code is passed to pfnCallComplete callback.
      */
-    DECLR3CALLBACKMEMBER(void, pfnCall, (void *pvService, VBOXHGCMCALLHANDLE callHandle, uint32_t u32ClientID, void *pvClient, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]));
+    DECLR3CALLBACKMEMBER(void, pfnCall, (void *pvService, VBOXHGCMCALLHANDLE callHandle, uint32_t u32ClientID, void *pvClient,
+                                         uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]));
 
     /** Host Service entry point meant for privileged features invisible to the guest.

trunk/include/VBox/vmm/pdmifs.h

@@ -2071 +2071 @@
      * @param   rc                  The return code (VBox error code).
      * @param   pCmd                A pointer that identifies the completed command.
-     *
-     * @returns VBox status code
      */
     DECLR3CALLBACKMEMBER(void, pfnCompleted,(PPDMIHGCMPORT pInterface, int32_t rc, PVBOXHGCMCMD pCmd));
+
+    /**
+     * Checks if @a pCmd was restored & resubmitted from saved state.
+     *
+     * @returns true if restored, false if not.
+     * @param   pInterface          Pointer to this interface.
+     * @param   pCmd                The command we're checking on.
+     */
+    DECLR3CALLBACKMEMBER(bool, pfnIsCmdRestored,(PPDMIHGCMPORT pInterface, PVBOXHGCMCMD pCmd));
 
 } PDMIHGCMPORT;
 /** PDMIHGCMPORT interface ID. */
-# define PDMIHGCMPORT_IID                       "e00a0cbf-b75a-45c3-87f4-41cddbc5ae0b"
+# define PDMIHGCMPORT_IID                       "10ca89d3-18ef-44d3-535e-ca46532e3caa"
 
 

trunk/src/VBox/Devices/VMMDev/VMMDev.cpp

@@ -4122 +4122 @@
     /* HGCM port */
     pThis->IHGCMPort.pfnCompleted           = hgcmCompleted;
+    pThis->IHGCMPort.pfnIsCmdRestored       = hgcmIsCmdRestored;
 #endif
 

trunk/src/VBox/Devices/VMMDev/VMMDevHGCM.cpp

@@ -128 +128 @@
     bool                fCancelled;
 
+    /** Whether the command was restored from saved state. */
+    bool                fRestored;
+
     /** GC physical address of the guest request. */
     RTGCPHYS            GCPhys;
@@ -137 +140 @@
     VMMDevRequestType   enmRequestType;
 
-    union {
+    union
+    {
         struct
         {
@@ -1063 +1067 @@
     if (result == VINF_HGCM_SAVE_STATE)
     {
-        /* If the completion routine was called because HGCM saves its state,
-         * then currently nothing to be done here. The pCmd stays in the list
-         * and will be saved later when the VMMDev state will be saved.
+        /* If the completion routine was called while the HGCM service saves its state,
+         * then currently nothing to be done here.  The pCmd stays in the list and will
+         * be saved later when the VMMDev state will be saved and re-submitted on load.
          *
-         * It it assumed that VMMDev saves state after the HGCM services,
-         * and, therefore, VBOXHGCMCMD structures are not removed by
-         * vmmdevHGCMSaveState from the list, while HGCM uses them.
+         * It it assumed that VMMDev saves state after the HGCM services (VMMDev driver
+         * attached by constructor before it registers its SSM state), and, therefore,
+         * VBOXHGCMCMD structures are not removed by vmmdevHGCMSaveState from the list,
+         * while HGCM uses them.
          */
         LogFlowFunc(("VINF_HGCM_SAVE_STATE for command %p\n", pCmd));
@@ -1216 +1221 @@
                                    (PFNRT)hgcmCompletedWorker, 3, pInterface, result, pCmd);
     AssertRC(rc);
+}
+
+/**
+ * @interface_method_impl{PDMIHGCMPORT, pfnIsCmdRestored}
+ */
+DECLCALLBACK(bool) hgcmIsCmdRestored(PPDMIHGCMPORT pInterface, PVBOXHGCMCMD pCmd)
+{
+    RT_NOREF(pInterface);
+    return pCmd && pCmd->fRestored;
 }
 
@@ -1605 +1619 @@
     else
         pCmd->fCancelled = false;
-
+    pCmd->fRestored      = true;
     pCmd->enmRequestType = enmRequestType;
 
@@ -1649 +1663 @@
     else
         pCmd->fCancelled = false;
-
+    pCmd->fRestored      = true;
     pCmd->enmRequestType = enmRequestType;
 
@@ -1695 +1709 @@
     else
         pCmd->fCancelled = false;
-
+    pCmd->fRestored      = true;
     pCmd->enmRequestType = enmRequestType;
 

trunk/src/VBox/Devices/VMMDev/VMMDevHGCM.h

@@ -29 +29 @@
 
 DECLCALLBACK(void) hgcmCompleted(PPDMIHGCMPORT pInterface, int32_t result, PVBOXHGCMCMD pCmdPtr);
+DECLCALLBACK(bool) hgcmIsCmdRestored(PPDMIHGCMPORT pInterface, PVBOXHGCMCMD pCmd);
 
 int vmmdevHGCMSaveState(VMMDevState *pVMMDevState, PSSMHANDLE pSSM);

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

@@ -132 +132 @@
         static DECLCALLBACK(void) svcHlpCallComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc);
         static DECLCALLBACK(void) svcHlpDisconnectClient(void *pvInstance, uint32_t u32ClientId);
+        static DECLCALLBACK(bool) svcHlpIsCallRestored(VBOXHGCMCALLHANDLE callHandle);
 
     public:
@@ -755 +756 @@
 }
 
+/**
+ * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnCallComplete}
+ */
 /* static */ DECLCALLBACK(void) HGCMService::svcHlpCallComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc)
 {
@@ -773 +777 @@
 }
 
+/**
+ * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnDisconnectClient}
+ */
 /* static */ DECLCALLBACK(void) HGCMService::svcHlpDisconnectClient(void *pvInstance, uint32_t u32ClientId)
 {
@@ -781 +788 @@
          pService->DisconnectClient(u32ClientId, true);
      }
+}
+
+/**
+ * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnIsCallRestored}
+ */
+/* static */ DECLCALLBACK(bool) HGCMService::svcHlpIsCallRestored(VBOXHGCMCALLHANDLE callHandle)
+{
+    HGCMMsgHeader *pMsgHdr = (HGCMMsgHeader *)(callHandle);
+    AssertPtrReturn(pMsgHdr, false);
+
+    PVBOXHGCMCMD pCmd = pMsgHdr->pCmd;
+    AssertPtrReturn(pCmd, false);
+
+    PPDMIHGCMPORT pHgcmPort = pMsgHdr->pHGCMPort;
+    AssertPtrReturn(pHgcmPort, false);
+
+    return pHgcmPort->pfnIsCmdRestored(pHgcmPort, pCmd);
 }
 
@@ -836 +860 @@
             m_svcHelpers.pvInstance          = this;
             m_svcHelpers.pfnDisconnectClient = svcHlpDisconnectClient;
+            m_svcHelpers.pfnIsCallRestored   = svcHlpIsCallRestored;
 
             /* Execute the load request on the service thread. */