Changeset 75747 in vbox

Timestamp:

Nov 26, 2018 6:54:55 PM (6 years ago)

Author:

vboxsync

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

126948

Message:

HGCM: Continue with getting VERR_CANCELLED to the service when the guest has cancelled (or canceled if you prefer) the command.

Location:

trunk

Files:

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

trunk/include/VBox/hgcmsvc.h

@@ -68 +68 @@
  *          this problem is already solved by service extension callbacks
  * 5.1->6.1 Because pfnCall got a new parameter. Also new helpers. (VBox 6.0)
+ * 6.1->6.2 Because pfnCallComplete starts returning a status code (VBox 6.0).
  */
 #define VBOX_HGCM_SVC_VERSION_MAJOR (0x0006)
-#define VBOX_HGCM_SVC_VERSION_MINOR (0x0001)
+#define VBOX_HGCM_SVC_VERSION_MINOR (0x0002)
 #define VBOX_HGCM_SVC_VERSION ((VBOX_HGCM_SVC_VERSION_MAJOR << 16) + VBOX_HGCM_SVC_VERSION_MINOR)
 
@@ -82 +83 @@
 {
     /** The service has processed the Call request. */
-    DECLR3CALLBACKMEMBER(void, pfnCallComplete, (VBOXHGCMCALLHANDLE callHandle, int32_t rc));
+    DECLR3CALLBACKMEMBER(int, pfnCallComplete, (VBOXHGCMCALLHANDLE callHandle, int32_t rc));
 
     void *pvInstance;

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

@@ -123 +123 @@
 /** Initialize threads.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmThreadInit(void);
@@ -141 +141 @@
  *                          NULL if no stats.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmThreadCreate(HGCMThread **ppThread, const char *pszThreadName, PFNHGCMTHREAD pfnThread, void *pvUser,
@@ -151 +151 @@
  *                      consumed.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmThreadWait(HGCMThread *pThread);
@@ -162 +162 @@
  * @param pfnNewMessage New message allocation callback.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmMsgAlloc(HGCMThread *pThread, HGCMMsgCore **ppHandle, uint32_t u32MsgId, PFNHGCMNEWMSGALLOC pfnNewMessage);
@@ -171 +171 @@
  * @param pfnCallback   Message completion callback.
  *
- * @return VBox error code
+ * @return VBox status code.
  * @retval VINF_HGCM_ASYNC_EXECUTE on success.
  *
@@ -184 +184 @@
  * @param pMsg          The message.  Reference will be consumed!
  *
- * @return VBox error code
+ * @return VBox status code.
  *
  * @thread any
@@ -196 +196 @@
  * @param ppMsg         Where to store returned message pointer.
  *
- * @return VBox error code
+ * @return VBox status code.
  *
  * @thread worker thread
@@ -206 +206 @@
  *
  * @param pMsg          Processed message pointer.
- * @param result        Result code, VBox erro code.
- *
- * @return VBox error code
+ * @param result        Result code, VBox status code.
+ *
+ * @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).
  *
  * @thread worker thread
  */
-void hgcmMsgComplete(HGCMMsgCore *pMsg, int32_t result);
+int hgcmMsgComplete(HGCMMsgCore *pMsg, int32_t result);
 
 

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

@@ -139 +139 @@
         ~HGCMService() {};
 
-        static DECLCALLBACK(void) svcHlpCallComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc);
+        static DECLCALLBACK(int)  svcHlpCallComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc);
         static DECLCALLBACK(void) svcHlpDisconnectClient(void *pvInstance, uint32_t u32ClientId);
         static DECLCALLBACK(bool) svcHlpIsCallRestored(VBOXHGCMCALLHANDLE callHandle);
@@ -796 +796 @@
  * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnCallComplete}
  */
-/* static */ DECLCALLBACK(void) HGCMService::svcHlpCallComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc)
+/* static */ DECLCALLBACK(int) HGCMService::svcHlpCallComplete(VBOXHGCMCALLHANDLE callHandle, int32_t rc)
 {
    HGCMMsgCore *pMsgCore = (HGCMMsgCore *)callHandle;
 
-   if (pMsgCore->MsgId () == SVC_MSG_GUESTCALL)
-   {
-       /* Only call the completion for these messages. The helper
-        * is called by the service, and the service does not get
-        * any other messages.
-        */
-       hgcmMsgComplete(pMsgCore, rc);
-   }
-   else
-   {
-       AssertFailed();
-   }
+   /* Only call the completion for these messages. The helper
+    * is called by the service, and the service does not get
+    * any other messages.
+    */
+   AssertMsgReturn(pMsgCore->MsgId() == SVC_MSG_GUESTCALL, ("%d\n", pMsgCore->MsgId()), VERR_WRONG_TYPE);
+   return hgcmMsgComplete(pMsgCore, rc);
 }
 

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

@@ -147 +147 @@
         int MsgGet(HGCMMsgCore **ppMsg);
         int MsgPost(HGCMMsgCore *pMsg, PHGCMMSGCALLBACK pfnCallback, bool bWait);
-        void MsgComplete(HGCMMsgCore *pMsg, int32_t result);
+        int MsgComplete(HGCMMsgCore *pMsg, int32_t result);
 };
 
@@ -554 +554 @@
 }
 
-void HGCMThread::MsgComplete(HGCMMsgCore *pMsg, int32_t result)
+int HGCMThread::MsgComplete(HGCMMsgCore *pMsg, int32_t result)
 {
     LogFlow(("HGCMThread::MsgComplete: thread = %p, pMsg = %p\n", this, pMsg));
@@ -561 +561 @@
     AssertReleaseMsg((pMsg->m_fu32Flags & HGCM_MSG_F_IN_PROCESS) != 0, ("%p %x\n", pMsg, pMsg->m_fu32Flags));
 
+    int rcRet = VINF_SUCCESS;
     if (pMsg->m_pfnCallback)
     {
         /** @todo call callback with error code in MsgPost in case of errors */
 
-        pMsg->m_pfnCallback(result, pMsg);
-
-        LogFlow(("HGCMThread::MsgComplete: callback executed. pMsg = %p, thread = %p\n", pMsg, this));
+        rcRet = pMsg->m_pfnCallback(result, pMsg);
+
+        LogFlow(("HGCMThread::MsgComplete: callback executed. pMsg = %p, thread = %p, rcRet = %Rrc\n", pMsg, this, rcRet));
     }
 
@@ -616 +617 @@
         }
     }
+
+    return rcRet;
 }
 
@@ -737 +740 @@
 }
 
-void hgcmMsgComplete(HGCMMsgCore *pMsg, int32_t u32Result)
+int hgcmMsgComplete(HGCMMsgCore *pMsg, int32_t u32Result)
 {
     LogFlow(("MAIN::hgcmMsgComplete: pMsg = %p\n", pMsg));
 
+    int rc;
     if (pMsg)
-        pMsg->Thread()->MsgComplete(pMsg, u32Result);
-
-
-    LogFlow(("MAIN::hgcmMsgComplete: pMsg = %p, rc = void\n", pMsg));
+        rc = pMsg->Thread()->MsgComplete(pMsg, u32Result);
+    else
+        rc = VINF_SUCCESS;
+
+    LogFlow(("MAIN::hgcmMsgComplete: pMsg = %p, rc = %Rrc\n", pMsg, rc));
+    return rc;
 }