Changeset 47629 in vbox for trunk/src/VBox/Frontends/VBoxManage

Timestamp:

Aug 9, 2013 9:33:08 AM (12 years ago)

Author:

vboxsync

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

87830

Message:

VBoxManage/VBoxManageGuestCtrl.cpp: Install proper console signal handlers for Windows; close the guest session on all platforms when being interrupted.

File:

• trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (modified) (14 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp

@@ -68 +68 @@
 
 /** Set by the signal handler. */
-static volatile bool    g_fGuestCtrlCanceled = false;
+static volatile bool         g_fGuestCtrlCanceled = false;
+/** Our global session object which is also used in the
+ *  signal handler to abort operations properly. */
+static ComPtr<IGuestSession> g_pGuestSession;
 
 typedef struct COPYCONTEXT
@@ -296 +299 @@
 #ifndef VBOX_ONLY_DOCS
 
+#ifdef RT_OS_WINDOWS
+static BOOL WINAPI guestCtrlSignalHandler(DWORD dwCtrlType)
+{
+    bool fEventHandled = FALSE;
+    switch (dwCtrlType)
+    {
+        /* User pressed CTRL+C or CTRL+BREAK or an external event was sent
+         * via GenerateConsoleCtrlEvent(). */
+        case CTRL_BREAK_EVENT:
+        case CTRL_CLOSE_EVENT:
+        case CTRL_C_EVENT:
+            ASMAtomicWriteBool(&g_fGuestCtrlCanceled, true);
+            if (!g_pGuestSession.isNull())
+                g_pGuestSession->Close();
+            fEventHandled = TRUE;
+            break;
+        default:
+            break;
+        /** @todo Add other events here. */
+    }
+
+    return fEventHandled;
+}
+#else /* !RT_OS_WINDOWS */
 /**
  * Signal handler that sets g_fGuestCtrlCanceled.
@@ -307 +334 @@
     NOREF(iSignal);
     ASMAtomicWriteBool(&g_fGuestCtrlCanceled, true);
-}
+    if (!g_pGuestSession.isNull())
+        g_pGuestSession->Close();
+}
+#endif
 
 /**
  * Installs a custom signal handler to get notified
  * whenever the user wants to intercept the program.
+ *
+ ** @todo Make this handler available for all VBoxManage modules?
  */
-static void ctrlSignalHandlerInstall()
-{
+static int ctrlSignalHandlerInstall(void)
+{
+    int rc = VINF_SUCCESS;
+#ifdef RT_OS_WINDOWS
+    if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)guestCtrlSignalHandler, TRUE /* Add handler */))
+    {
+        rc = RTErrConvertFromWin32(GetLastError());
+        RTMsgError("Unable to install console control handler, rc=%Rrc\n", rc);
+    }
+#else
     signal(SIGINT,   guestCtrlSignalHandler);
-#ifdef SIGBREAK
+# ifdef SIGBREAK
     signal(SIGBREAK, guestCtrlSignalHandler);
+# endif
 #endif
+    return rc;
 }
 
@@ -324 +366 @@
  * Uninstalls a previously installed signal handler.
  */
-static void ctrlSignalHandlerUninstall()
-{
+static int ctrlSignalHandlerUninstall(void)
+{
+    int rc = VINF_SUCCESS;
+#ifdef RT_OS_WINDOWS
+    if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)NULL, FALSE /* Remove handler */))
+    {
+        rc = RTErrConvertFromWin32(GetLastError());
+        RTMsgError("Unable to uninstall console control handler, rc=%Rrc\n", rc);
+    }
+#else
     signal(SIGINT,   SIG_DFL);
-#ifdef SIGBREAK
+# ifdef SIGBREAK
     signal(SIGBREAK, SIG_DFL);
+# endif
 #endif
+    return rc;
 }
 
@@ -835 +887 @@
         return errorSyntax(USAGE_GUESTCONTROL, "Output conversion not implemented yet!");
 
+    ctrlSignalHandlerInstall();
+
     /*
      * Start with the real work.
@@ -848 +902 @@
      *        the session all over the places below again. Later. */
 
-    ComPtr<IGuestSession> pGuestSession;
     try
     {
@@ -860 +913 @@
                                       Bstr(strDomain).raw(),
                                       Bstr(strVBoxManage).raw(),
-                                      pGuestSession.asOutParam()));
+                                      g_pGuestSession.asOutParam()));
 
             /* Adjust process creation flags if we don't want to wait for process termination. */
@@ -883 +936 @@
             aSessionWaitFlags.push_back(GuestSessionWaitForFlag_Start);
             GuestSessionWaitResult_T sessionWaitResult;
-            CHECK_ERROR_BREAK(pGuestSession, WaitForArray(ComSafeArrayAsInParam(aSessionWaitFlags), cMsTimeout, &sessionWaitResult));
+            CHECK_ERROR_BREAK(g_pGuestSession, WaitForArray(ComSafeArrayAsInParam(aSessionWaitFlags), cMsTimeout, &sessionWaitResult));
             ULONG uSessionID;
-            CHECK_ERROR_BREAK(pGuestSession, COMGETTER(Id)(&uSessionID));
+            CHECK_ERROR_BREAK(g_pGuestSession, COMGETTER(Id)(&uSessionID));
 
             if (   sessionWaitResult == GuestSessionWaitResult_Start
@@ -913 +966 @@
              */
             ComPtr<IGuestProcess> pProcess;
-            CHECK_ERROR_BREAK(pGuestSession, ProcessCreate(Bstr(strCmd).raw(),
+            CHECK_ERROR_BREAK(g_pGuestSession, ProcessCreate(Bstr(strCmd).raw(),
                                                            ComSafeArrayAsInParam(aArgs),
                                                            ComSafeArrayAsInParam(aEnv),
@@ -990 +1043 @@
                 }
 
-                if (FAILED(rc))
+                if (g_fGuestCtrlCanceled)
                     break;
 
@@ -1009 +1062 @@
                 }
 
-                if (RT_FAILURE(vrc))
+                if (   RT_FAILURE(vrc)
+                    || g_fGuestCtrlCanceled)
                     break;
 
@@ -1022 +1076 @@
 
             /* Report status back to the user. */
-            if (fCompleted)
+            if (   fCompleted
+                && !g_fGuestCtrlCanceled)
             {
                 ProcessStatus_T procStatus;
@@ -1056 +1111 @@
     }
 
+    ctrlSignalHandlerUninstall();
+
     bool fCloseSession = false;
     if (SUCCEEDED(rc))
@@ -1070 +1127 @@
 
     if (   fCloseSession
-        && !pGuestSession.isNull())
+        && !g_pGuestSession.isNull())
     {
         if (fVerbose)
             RTPrintf("Closing guest session ...\n");
-        rc = pGuestSession->Close();
+        rc = g_pGuestSession->Close();
     }
     else if (!fCloseSession && fVerbose)