Changeset 75740 in vbox

Timestamp:

Nov 26, 2018 3:59:11 PM (6 years ago)

Author:

vboxsync

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

126941

Message:

HGCM,VMMDev: Made the HGCM command/message completion callback return a status code so VMMDev can indicate that a guest call was cancelled and the service could implement a way of dealing with that, rather than just dropping information. Ran into this with SIGCHLD delivery interrupting GUEST_MSG_WAIT and dropping crucial HOST_SESSION_CLOSE close messages, causing the host to wait until sometime timed out and probably left stuff/processes behind.

Location:

trunk

Files:

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

trunk/include/VBox/vmm/pdmifs.h

@@ -2068 +2068 @@
      * Notify the guest on a command completion.
      *
+     * @returns VINF_SUCCESS or VERR_CANCELLED if the guest canceled the call.
      * @param   pInterface          Pointer to this interface.
      * @param   rc                  The return code (VBox error code).
      * @param   pCmd                A pointer that identifies the completed command.
      */
-    DECLR3CALLBACKMEMBER(void, pfnCompleted,(PPDMIHGCMPORT pInterface, int32_t rc, PVBOXHGCMCMD pCmd));
+    DECLR3CALLBACKMEMBER(int, pfnCompleted,(PPDMIHGCMPORT pInterface, int32_t rc, PVBOXHGCMCMD pCmd));
 
     /**
@@ -2085 +2086 @@
 } PDMIHGCMPORT;
 /** PDMIHGCMPORT interface ID. */
-# define PDMIHGCMPORT_IID                       "10ca89d3-18ef-44d3-535e-ca46532e3caa"
+# define PDMIHGCMPORT_IID                       "e82b1709-c245-4ccc-1611-0e6d50d93cbc"
 
 

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

@@ -1246 +1246 @@
 /** Update HGCM request in the guest memory and mark it as completed.
  *
+ * @returns VINF_SUCCESS or VERR_CANCELLED.
  * @param   pInterface      Pointer to this PDM interface.
  * @param   result          HGCM completion status code (VBox status code).
@@ -1252 +1253 @@
  * @thread EMT
  */
-DECLCALLBACK(void) hgcmCompletedWorker(PPDMIHGCMPORT pInterface, int32_t result, PVBOXHGCMCMD pCmd)
+static int hgcmCompletedWorker(PPDMIHGCMPORT pInterface, int32_t result, PVBOXHGCMCMD pCmd)
 {
     PVMMDEV pThis = RT_FROM_MEMBER(pInterface, VMMDevState, IHGCMPort);
@@ -1272 +1273 @@
          */
         LogFlowFunc(("VINF_HGCM_SAVE_STATE for command %p\n", pCmd));
-        return;
+        return VINF_SUCCESS;
     }
 
@@ -1448 +1449 @@
             VMMDevNotifyGuest(pThis, VMMDEV_EVENT_HGCM);
         }
+
+        /* Set the status to success for now, though we might consider passing
+           along the vmmdevHGCMCompleteCallRequest errors... */
+        rc = VINF_SUCCESS;
     }
     else
     {
         LogFlowFunc(("Cancelled command %p\n", pCmd));
+        rc = VERR_CANCELLED;
     }
 
@@ -1472 +1478 @@
         STAM_REL_PROFILE_ADD_PERIOD(&pThis->StatHgcmCmdTotal,  tsNow - tsArrival);
 #endif
-}
-
-/** HGCM callback for request completion. Forwards to hgcmCompletedWorker.
- *
+
+    return rc;
+}
+
+/**
+ * HGCM callback for request completion. Forwards to hgcmCompletedWorker.
+ *
+ * @returns VINF_SUCCESS or VERR_CANCELLED.
  * @param   pInterface      Pointer to this PDM interface.
  * @param   result          HGCM completion status code (VBox status code).
  * @param   pCmd            Completed command, which contains updated host parameters.
  */
-DECLCALLBACK(void) hgcmCompleted(PPDMIHGCMPORT pInterface, int32_t result, PVBOXHGCMCMD pCmd)
+DECLCALLBACK(int) hgcmCompleted(PPDMIHGCMPORT pInterface, int32_t result, PVBOXHGCMCMD pCmd)
 {
 #if 0 /* This seems to be significantly slower.  Half of MsgTotal time seems to be spend here. */
@@ -1494 +1504 @@
                                    (PFNRT)hgcmCompletedWorker, 3, pInterface, result, pCmd);
     AssertRC(rc);
+    return VINF_SUCCESS; /* cannot tell if canceled or not... */
 #else
     STAM_GET_TS(pCmd->tsComplete);
     VBOXDD_HGCMCALL_COMPLETED_REQ(pCmd, result);
-    hgcmCompletedWorker(pInterface, result, pCmd);
+    return hgcmCompletedWorker(pInterface, result, pCmd);
 #endif
 }

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

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

trunk/src/VBox/Main/include/HGCMThread.h

@@ -44 +44 @@
  *                  or from HGCM.
  * @param pMsgCore  Pointer to just processed message.
- */
-typedef DECLCALLBACK(void) HGCMMSGCALLBACK(int32_t result, HGCMMsgCore *pMsgCore);
+ *
+ * @return Restricted set of VBox status codes when guest call message:
+ * @retval VINF_SUCCESS on success
+ * @retval VERR_CANCELLED if the request was cancelled.
+ * @retval VERR_ALREADY_RESET if the VM is resetting.
+ * @retval VERR_NOT_AVAILABLE if HGCM has been disconnected from the VMMDev
+ *         (shouldn't happen).
+ */
+typedef DECLCALLBACK(int) HGCMMSGCALLBACK(int32_t result, HGCMMsgCore *pMsgCore);
+/** Pointer to a message completeion callback function. */
 typedef HGCMMSGCALLBACK *PHGCMMSGCALLBACK;
 

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

@@ -895 +895 @@
 
 
-static DECLCALLBACK(void) hgcmMsgCompletionCallback(int32_t result, HGCMMsgCore *pMsgCore)
+static DECLCALLBACK(int) hgcmMsgCompletionCallback(int32_t result, HGCMMsgCore *pMsgCore)
 {
     /* Call the VMMDev port interface to issue IRQ notification. */
@@ -902 +902 @@
     LogFlow(("MAIN::hgcmMsgCompletionCallback: message %p\n", pMsgCore));
 
-    if (pMsgHdr->pHGCMPort && !g_fResetting)
-    {
-        pMsgHdr->pHGCMPort->pfnCompleted(pMsgHdr->pHGCMPort, g_fSaveState? VINF_HGCM_SAVE_STATE: result, pMsgHdr->pCmd);
-    }
+    if (pMsgHdr->pHGCMPort)
+    {
+        if (!g_fResetting)
+            return pMsgHdr->pHGCMPort->pfnCompleted(pMsgHdr->pHGCMPort,
+                                                    g_fSaveState ? VINF_HGCM_SAVE_STATE : result, pMsgHdr->pCmd);
+        return VERR_ALREADY_RESET; /* best I could find. */
+    }
+    return VERR_NOT_AVAILABLE;
 }
 
@@ -1723 +1727 @@
 #ifdef VBOX_WITH_CRHGSMI
 
-static DECLCALLBACK(void) hgcmMsgFastCallCompletionCallback(int32_t result, HGCMMsgCore *pMsgCore)
+static DECLCALLBACK(int) hgcmMsgFastCallCompletionCallback(int32_t result, HGCMMsgCore *pMsgCore)
 {
     /* Call the VMMDev port interface to issue IRQ notification. */
@@ -1731 +1735 @@
     if (pMsg->pfnCompletion)
         pMsg->pfnCompletion(result, pMsg->u32Function, &pMsg->Param, pMsg->pvCompletion);
+    return VINF_SUCCESS;
 }