Changeset 56597 in vbox

Timestamp:

Jun 23, 2015 11:27:49 AM (10 years ago)

Author:

vboxsync

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

101226

Message:

Main/webservice: make an attempt at gracefully handling webservice termination

File:

• trunk/src/VBox/Main/webservice/vboxweb.cpp (modified) (22 diffs)

trunk/src/VBox/Main/webservice/vboxweb.cpp

@@ -51 +51 @@
 #include <iprt/asm.h>
 
+#ifndef RT_OS_WINDOWS
+# include <signal.h>
+#endif
+
 // workaround for compile problems on gcc 4.1
 #ifdef __GNUC__
@@ -143 +147 @@
 
 static bool             g_fDaemonize = false;           // run in background.
+static volatile bool    g_fKeepRunning = true;          // controlling the exit
 
 const WSDLT_ID          g_EmptyWSDLID;                  // for NULL MORs
@@ -366 +371 @@
         int rc = RTThreadCreate(&m_pThread,
                                 fntWrapper,
-                                this,             // pvUser
-                                0,               // cbStack,
+                                this,           // pvUser
+                                0,              // cbStack
                                 RTTHREADTYPE_MAIN_HEAVY_WORKER,
                                 0,
@@ -401 +406 @@
     {
         SoapThread *pst = (SoapThread*)pvThread;
-        pst->process();     // this never returns really
+        pst->process();
         return 0;
     }
@@ -435 +440 @@
     ~SoapQ()
     {
+        /* Tell the threads to terminate. */
+        RTSemEventMultiSignal(m_event);
+        {
+            util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
+            int i = 0;
+            while (m_llAllThreads.size() && i++ <= 30)
+            {
+                qlock.release();
+                RTThreadSleep(1000);
+                RTSemEventMultiSignal(m_event);
+                qlock.acquire();
+            }
+            WebLog("ending queue processing (%d out of %d threads idle)\n", m_cIdleThreads, m_llAllThreads.size());
+        }
+
         RTSemEventMultiDestroy(m_event);
     }
@@ -489 +509 @@
     SOAP_SOCKET get(size_t &cIdleThreads, size_t &cThreads)
     {
-        while (1)
+        while (g_fKeepRunning)
         {
             // wait for something to happen
             RTSemEventMultiWait(m_event, RT_INDEFINITE_WAIT);
+
+            if (!g_fKeepRunning)
+                break;
 
             util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
@@ -515 +538 @@
             // nothing to do: keep looping
         }
+        return SOAP_INVALID_SOCKET;
     }
 
@@ -527 +551 @@
     }
 
+    /**
+     * To be called by a worker thread when signing off, i.e. no longer
+     * willing to process requests.
+     */
+    void signoff(SoapThread *th)
+    {
+        {
+            util::AutoWriteLock thrLock(g_pThreadsLockHandle COMMA_LOCKVAL_SRC_POS);
+            size_t c = g_mapThreads.erase(th->m_pThread);
+            AssertReturnVoid(c == 1);
+        }
+        {
+            util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
+            m_llAllThreads.remove(th);
+            --m_cIdleThreads;
+        }
+    }
+
     const struct soap       *m_soap;            // soap structure created by main(), passed to constructor
 
@@ -550 +592 @@
     WebLog("New SOAP thread started\n");
 
-    while (1)
+    while (g_fKeepRunning)
     {
         // wait for a socket to arrive on the queue
         size_t cIdleThreads = 0, cThreads = 0;
         m_soap->socket = m_pQ->get(cIdleThreads, cThreads);
+
+        if (!soap_valid_socket(m_soap->socket))
+            continue;
 
         WebLog("Processing connection from IP=%lu.%lu.%lu.%lu socket=%d (%d out of %d threads idle)\n",
@@ -587 +632 @@
         m_pQ->done();
     }
+    m_pQ->signoff(this);
 }
 
@@ -631 +677 @@
                     {
                         util::AutoWriteLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
-                        g_pVirtualBox = NULL;
+                        g_pVirtualBox.setNull();
                     }
                     {
@@ -873 +919 @@
 
         for (uint64_t i = 1;
-             ;
+             g_fKeepRunning;
              i++)
         {
             // call gSOAP to handle incoming SOAP connection
+            soap.accept_timeout = 10;
             s = soap_accept(&soap);
-            if (s < 0)
+            if (!soap_valid_socket(s))
             {
-                WebLogSoapError(&soap);
+                if (soap.errnum)
+                    WebLogSoapError(&soap);
                 continue;
             }
@@ -889 +937 @@
             WebLog("Request %llu on socket %d queued for processing (%d items on Q)\n", i, s, cItemsOnQ);
         }
+
+        delete g_pSoapQ;
+        g_pSoapQ = NULL;
+
+        WebLog("ending SOAP request handling\n");
+
+        delete g_pSoapQ;
+        g_pSoapQ = NULL;
+
     }
     soap_done(&soap); // close master socket and detach environment
@@ -912 +969 @@
     doQueuesLoop();
 
+    thrLock.acquire();
+    g_mapThreads.erase(RTThreadSelf());
     return 0;
 }
@@ -918 +977 @@
 // Required for ATL
 static CComModule _Module;
+
+/**
+ * "Signal" handler for cleanly terminating the event loop.
+ */
+static BOOL WINAPI websrvSignalHandler(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:
+        case CTRL_LOGOFF_EVENT:
+        case CTRL_SHUTDOWN_EVENT:
+            ASMAtomicWriteBool(&g_fGuestCtrlCanceled, true);
+            fEventHandled = TRUE;
+            break;
+        default:
+            break;
+    }
+    return fEventHandled;
+#else
+class ForceQuitEvent : public com::NativeEvent
+{
+    void *handler()
+    {
+        LogFlowFunc(("\n"));
+
+        g_fKeepRunning = false;
+
+        return NULL;
+    }
+};
+
+/**
+ * Signal handler for cleanly terminating the event loop.
+ */
+static void websrvSignalHandler(int iSignal)
+{
+    NOREF(iSignal);
+    com::NativeEventQueue *pQ = com::NativeEventQueue::getMainEventQueue();
+    pQ->postEvent(new ForceQuitEvent());
+}
 #endif
 
@@ -1200 +1304 @@
 
     // SOAP queue pumper thread
-    rc = RTThreadCreate(NULL,
+    RTTHREAD threadQPumper;
+    rc = RTThreadCreate(&threadQPumper,
                         fntQPumper,
                         NULL,        // pvUser
                         0,           // cbStack (default)
                         RTTHREADTYPE_MAIN_WORKER,
-                        0,           // flags
+                        RTTHREADFLAGS_WAITABLE,
                         "SQPmp");
     if (RT_FAILURE(rc))
@@ -1211 +1316 @@
 
     // watchdog thread
+    RTTHREAD threadWatchdog = NIL_RTTHREAD;
     if (g_iWatchdogTimeoutSecs > 0)
     {
         // start our watchdog thread
-        rc = RTThreadCreate(NULL,
+        rc = RTThreadCreate(&threadWatchdog,
                             fntWatchdog,
                             NULL,
                             0,
                             RTTHREADTYPE_MAIN_WORKER,
-                            0,
+                            RTTHREADFLAGS_WAITABLE,
                             "Watchdog");
         if (RT_FAILURE(rc))
@@ -1225 +1331 @@
     }
 
+#ifdef RT_OS_WINDOWS
+    if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)gctlSignalHandler, TRUE /* Add handler */))
+    {
+        rc = RTErrConvertFromWin32(GetLastError());
+        RTMsgError("Unable to install console control handler, rc=%Rrc\n", rc);
+    }
+#else
+    signal(SIGINT,   websrvSignalHandler);
+# ifdef SIGBREAK
+    signal(SIGBREAK, websrvSignalHandler);
+# endif
+#endif
+
     com::NativeEventQueue *pQ = com::NativeEventQueue::getMainEventQueue();
-    for (;;)
+    while (g_fKeepRunning)
     {
         // we have to process main event queue
@@ -1235 +1354 @@
     }
 
+    WebLog("requested termination, cleaning up\n");
+
+#ifdef RT_OS_WINDOWS
+    if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)gctlSignalHandler, FALSE /* Remove handler */))
+    {
+        rc = RTErrConvertFromWin32(GetLastError());
+        RTMsgError("Unable to remove console control handler, rc=%Rrc\n", rc);
+    }
+#else
+    signal(SIGINT,   SIG_DFL);
+# ifdef SIGBREAK
+    signal(SIGBREAK, SIG_DFL);
+# endif
+#endif
+
+    RTThreadWait(threadQPumper, 30000, NULL);
+    if (threadWatchdog != NIL_RTTHREAD)
+        RTThreadWait(threadWatchdog, g_iWatchdogCheckInterval * 1000 + 10000, NULL);
+
     /* VirtualBoxClient events unregistration. */
     if (vboxClientListener)
@@ -1245 +1383 @@
     }
 
+    {
+        util::AutoWriteLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
+        g_pVirtualBox.setNull();
+    }
+    {
+        util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+        WebsessionsMapIterator it = g_mapWebsessions.begin(),
+                               itEnd = g_mapWebsessions.end();
+        while (it != itEnd)
+        {
+            WebServiceSession *pWebsession = it->second;
+            WEBDEBUG(("SVC unavailable: websession %#llx stale, deleting\n", pWebsession->getID()));
+            delete pWebsession;
+            it = g_mapWebsessions.begin();
+        }
+    }
+    g_pVirtualBoxClient.setNull();
+
     com::Shutdown();
 
@@ -1273 +1429 @@
     WEBDEBUG(("Watchdog thread started\n"));
 
-    while (1)
+    while (g_fKeepRunning)
     {
         WEBDEBUG(("Watchdog: sleeping %d seconds\n", g_iWatchdogCheckInterval));
@@ -1311 +1467 @@
     }
 
-    WEBDEBUG(("Watchdog thread ending\n"));
+    thrLock.acquire();
+    g_mapThreads.erase(RTThreadSelf());
+
+    WebLog("ending Watchdog thread\n");
     return 0;
 }