Changeset 75853 in vbox for trunk/include/VBox

Timestamp:

Nov 30, 2018 7:26:42 PM (6 years ago)

Author:

vboxsync

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

127057

Message:

GuestControl,HGCM,VBoxService: Save/restore related optimizations and changes. bugref:9313

Location:

trunk/include/VBox

Files:

• HostServices/GuestControlSvc.h (modified) (2 diffs)
• VBoxGuestLib.h (modified) (1 diff)
• err.h (modified) (1 diff)
• hgcmsvc.h (modified) (5 diffs)
• vmm/pdmifs.h (modified) (1 diff)

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -322 +322 @@
      * uint64_t is ~8U).
      *
+     * Does also support the VM restore checking as in GUEST_MSG_PEEK_WAIT (64-bit
+     * param \# 0), see documentation there.
+     *
      * @retval  VINF_SUCCESS if a message was pending and is being returned.
      * @retval  VERR_TRY_AGAIN if no message pending.
+     * @retval  VERR_VM_RESTORED if first parameter is a non-zero 64-bit value that
+     *          does not match VbglR3GetSessionId() any more.  The new value is
+     *          returned.
      * @retval  VERR_INVALID_CLIENT_ID
      * @retval  VERR_WRONG_PARAMETER_COUNT
@@ -338 +344 @@
      * uint64_t is ~8U).
      *
+     * To facilitate VM restore checking, the first parameter can be a 64-bit
+     * integer holding the VbglR3GetSessionId() value the guest knowns.  The
+     * function will then check this before going to sleep and return
+     * VERR_VM_RESTORED if it doesn't match, same thing happens when the VM is
+     * restored.
+     *
      * @retval  VINF_SUCCESS if info about an pending message is being returned.
      * @retval  VINF_TRY_AGAIN and message set to HOST_CANCEL_PENDING_WAITS if
      *          cancelled by GUEST_MSG_CANCEL.
      * @retval  VERR_RESOURCE_BUSY if another thread already made a waiting call.
+     * @retval  VERR_VM_RESTORED if first parameter is a non-zero 64-bit value that
+     *          does not match VbglR3GetSessionId() any more.  The new value is
+     *          returned.
      * @retval  VERR_INVALID_CLIENT_ID
      * @retval  VERR_WRONG_PARAMETER_COUNT

trunk/include/VBox/VBoxGuestLib.h

@@ -773 +773 @@
 VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t idClient, int rcSkip, uint32_t idMsg);
 VBGLR3DECL(int) VbglR3GuestCtrlMsgSkipOld(uint32_t uClientId);
-VBGLR3DECL(int) VbglR3GuestCtrlMsgPeekWait(uint32_t idClient, uint32_t *pidMsg, uint32_t *pcParameters);
+VBGLR3DECL(int) VbglR3GuestCtrlMsgPeekWait(uint32_t idClient, uint32_t *pidMsg, uint32_t *pcParameters, uint64_t *pidRestoreCheck);
 VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(HGCMCLIENTID idClient);
 /* Guest session handling. */

trunk/include/VBox/err.h

@@ -93 +93 @@
 /** Essential fields in the shared VM structure doesn't match the global one. */
 #define VERR_INCONSISTENT_VM_HANDLE         (-1024)
+/** The VM has been restored. */
+#define VERR_VM_RESTORED                    (-1025)
 /** @} */
 

trunk/include/VBox/hgcmsvc.h

@@ -71 +71 @@
  * 6.2->6.3 Because pfnGetRequestor was added (VBox 6.0).
  * 6.3->6.4 Bacause pfnConnect got an additional parameter (VBox 6.0).
+ * 6.4->6.5 Bacause pfnGetVMMDevSessionId was added pfnLoadState got the version
+ *          parameter (VBox 6.0).
  */
 #define VBOX_HGCM_SVC_VERSION_MAJOR (0x0006)
@@ -121 +123 @@
      */
     DECLR3CALLBACKMEMBER(uint32_t, pfnGetRequestor, (VBOXHGCMCALLHANDLE hCall));
+
+    /**
+     * Retrieves VMMDevState::idSession.
+     *
+     * @returns current VMMDev session ID value.
+     */
+    DECLR3CALLBACKMEMBER(uint64_t, pfnGetVMMDevSessionId, (void *pvInstance));
 
 } VBOXHGCMSVCHELPERS;
@@ -495 +504 @@
 
     /** Inform the service about a VM load operation. */
-    DECLR3CALLBACKMEMBER(int, pfnLoadState, (void *pvService, uint32_t u32ClientID, void *pvClient, PSSMHANDLE pSSM));
+    DECLR3CALLBACKMEMBER(int, pfnLoadState, (void *pvService, uint32_t u32ClientID, void *pvClient, PSSMHANDLE pSSM,
+                                             uint32_t uVersion));
 
     /** Register a service extension callback. */
@@ -505 +515 @@
     /** @} */
 } VBOXHGCMSVCFNTABLE;
+
+
+/** @name HGCM saved state
+ * @note Need to be here so we can add saved to service which doesn't have it.
+ * @{ */
+/** HGCM saved state version. */
+#define HGCM_SAVED_STATE_VERSION        3
+/** HGCM saved state version w/o client state indicators. */
+#define HGCM_SAVED_STATE_VERSION_V2     2
+/** @} */
 
 
@@ -512 +532 @@
 #define VBOX_HGCM_SVCLOAD_NAME "VBoxHGCMSvcLoad"
 
+
 #endif

trunk/include/VBox/vmm/pdmifs.h

@@ -2094 +2094 @@
     DECLR3CALLBACKMEMBER(uint32_t, pfnGetRequestor,(PPDMIHGCMPORT pInterface, PVBOXHGCMCMD pCmd));
 
+    /**
+     * Gets the VMMDevState::idSession value.
+     *
+     * @returns VMMDevState::idSession.
+     * @param   pInterface          Pointer to this interface.
+     */
+    DECLR3CALLBACKMEMBER(uint64_t, pfnGetVMMDevSessionId,(PPDMIHGCMPORT pInterface));
+
 } PDMIHGCMPORT;
 /** PDMIHGCMPORT interface ID. */
-# define PDMIHGCMPORT_IID                       "0864e1c5-659b-40c8-2c97-994e2983038e"
+# define PDMIHGCMPORT_IID                       "c9180235-8102-4642-0aa7-f0422124d9b5"