Changeset 36331 in vbox

Timestamp:

Mar 21, 2011 7:17:12 PM (14 years ago)

Author:

vboxsync

Message:

VBoxService: Attempt to fix pre-init (broken by r70386). End VBoxService in the 'Terminated' or 'Failed' state, don't transition from 'Failed' to 'Terminated'. (untested)

Location:

trunk/src/VBox/Additions/common/VBoxService

Files:

• VBoxService-win.cpp (modified) (1 diff)
• VBoxService.cpp (modified) (23 diffs)
• VBoxServiceInternal.h (modified) (1 diff)
• VBoxServiceToolBox.cpp (modified) (4 diffs)

trunk/src/VBox/Additions/common/VBoxService/VBoxService-win.cpp

@@ -345 +345 @@
         }
         else
+        {
             vboxServiceWinSetStatus(SERVICE_STOPPED, 0);
+#if 0 /** @todo r=bird: Enable this if SERVICE_CONTROL_STOP isn't triggered automatically */
+            VBoxServiceStopServices();
+#endif
+        }
     }
     /**@todo r=bird: else vboxServiceWinSetStatus(SERVICE_STOPPED, 0); ? */

trunk/src/VBox/Additions/common/VBoxService/VBoxService.cpp

@@ -40 +40 @@
 #include <iprt/buildconfig.h>
 #include <iprt/initterm.h>
+#include <iprt/message.h>
 #include <iprt/path.h>
 #include <iprt/semaphore.h>
@@ -77 +78 @@
     /** The worker thread. NIL_RTTHREAD if it's the main thread. */
     RTTHREAD        Thread;
+    /** Whether Pre-init was called. */
+    bool            fPreInited;
     /** Shutdown indicator. */
     bool volatile   fShutdown;
@@ -88 +91 @@
 {
 #ifdef VBOXSERVICE_CONTROL
-    { &g_Control,   NIL_RTTHREAD, false, false, false, true },
+    { &g_Control,       NIL_RTTHREAD, false, false, false, false, true },
 #endif
 #ifdef VBOXSERVICE_TIMESYNC
-    { &g_TimeSync,  NIL_RTTHREAD, false, false, false, true },
+    { &g_TimeSync,      NIL_RTTHREAD, false, false, false, false, true },
 #endif
 #ifdef VBOXSERVICE_CLIPBOARD
-    { &g_Clipboard, NIL_RTTHREAD, false, false, false, true },
+    { &g_Clipboard,     NIL_RTTHREAD, false, false, false, false, true },
 #endif
 #ifdef VBOXSERVICE_VMINFO
-    { &g_VMInfo,    NIL_RTTHREAD, false, false, false, true },
+    { &g_VMInfo,        NIL_RTTHREAD, false, false, false, false, true },
 #endif
 #ifdef VBOXSERVICE_CPUHOTPLUG
-    { &g_CpuHotPlug, NIL_RTTHREAD, false, false, false, true },
+    { &g_CpuHotPlug,    NIL_RTTHREAD, false, false, false, false, true },
 #endif
 #ifdef VBOXSERVICE_MANAGEMENT
 # ifdef VBOX_WITH_MEMBALLOON
-    { &g_MemBalloon, NIL_RTTHREAD, false, false, false, true },
+    { &g_MemBalloon,    NIL_RTTHREAD, false, false, false, false, true },
 # endif
-    { &g_VMStatistics, NIL_RTTHREAD, false, false, false, true },
+    { &g_VMStatistics,  NIL_RTTHREAD, false, false, false, false, true },
 #endif
 #if defined(VBOX_WITH_PAGE_SHARING) && defined(RT_OS_WINDOWS)
-    { &g_PageSharing, NIL_RTTHREAD, false, false, false, true },
+    { &g_PageSharing,   NIL_RTTHREAD, false, false, false, false, true },
 #endif
 #ifdef VBOX_WITH_SHARED_FOLDERS
-    { &g_AutoMount, NIL_RTTHREAD, false, false, false, true },
+    { &g_AutoMount,     NIL_RTTHREAD, false, false, false, false, true },
 #endif
 };
@@ -232 +235 @@
  * Reports the current VBoxService status to the host.
  *
+ * This makes sure that the Failed state is sticky.
+ *
  * @return  IPRT status code.
  * @param   enmStatus               Status to report to the host.
@@ -237 +242 @@
 int VBoxServiceReportStatus(VBoxGuestFacilityStatus enmStatus)
 {
-    /* Report the host that we're up and running! */
-    int rc = VbglR3ReportAdditionsStatus(VBoxGuestFacilityType_VBoxService,
-                                         enmStatus, 0 /* Flags */);
-    if (RT_FAILURE(rc))
-        VBoxServiceError("Could not report VBoxService status (%u), rc=%Rrc\n", enmStatus, rc);
-    return rc;
+    /*
+     * VBoxGuestFacilityStatus_Failed is sticky.
+     */
+    static VBoxGuestFacilityStatus s_enmLastStatus = VBoxGuestFacilityStatus_Inactive;
+    if (s_enmLastStatus != VBoxGuestFacilityStatus_Failed)
+    {
+        int rc = VbglR3ReportAdditionsStatus(VBoxGuestFacilityType_VBoxService,
+                                             enmStatus, 0 /* Flags */);
+        if (RT_FAILURE(rc))
+        {
+            VBoxServiceError("Could not report VBoxService status (%u), rc=%Rrc\n", enmStatus, rc);
+            return rc;
+        }
+        s_enmLastStatus = enmStatus;
+    }
+    return VINF_SUCCESS;
 }
 
@@ -304 +319 @@
     RTThreadUserSignal(ThreadSelf);
     return rc;
+}
+
+
+/**
+ * Lazily calls the pfnPreInit method on each service.
+ *
+ * @returns VBox status code, error message displayed.
+ */
+static RTEXITCODE vboxServiceLazyPreInit(void)
+{
+    for (unsigned j = 0; j < RT_ELEMENTS(g_aServices); j++)
+        if (!g_aServices[j].fPreInited)
+        {
+            int rc = g_aServices[j].pDesc->pfnPreInit();
+            if (RT_FAILURE(rc))
+                return VBoxServiceError("Service '%s' failed pre-init: %Rrc\n", g_aServices[j].pDesc->pszName, rc);
+            g_aServices[j].fPreInited = true;
+        }
+    return RTEXITCODE_SUCCESS;
 }
 
@@ -344 +378 @@
                     VBoxServiceError("Service '%s' failed to initialize: %Rrc\n",
                                      g_aServices[j].pDesc->pszName, rc);
+                    VBoxServiceReportStatus(VBoxGuestFacilityStatus_Failed);
                     return rc;
                 }
@@ -373 +408 @@
         g_aServices[j].fStarted = true;
 
-        /* Wait for the thread to initialize.
-         *
-         * @todo There is a race between waiting and checking
-         *       the fShutdown flag of a thread here and processing
-         *       the thread's actual worker loop. If the thread decides
-         *       to exit the loop before we skipped the fShutdown check
-         *       below the service will fail to start! */
+        /* Wait for the thread to initialize. */
+        /** @todo There is a race between waiting and checking
+         * the fShutdown flag of a thread here and processing
+         * the thread's actual worker loop. If the thread decides
+         * to exit the loop before we skipped the fShutdown check
+         * below the service will fail to start! */
         RTThreadUserWait(g_aServices[j].Thread, 60 * 1000);
         if (g_aServices[j].fShutdown)
@@ -407 +441 @@
 int VBoxServiceStopServices(void)
 {
-    int rc = VINF_SUCCESS;
-
     VBoxServiceReportStatus(VBoxGuestFacilityStatus_Terminating);
 
@@ -430 +462 @@
      * Wait for all the service threads to complete.
      */
+    int rc = VINF_SUCCESS;
     for (unsigned j = 0; j < RT_ELEMENTS(g_aServices); j++)
     {
@@ -437 +470 @@
         {
             VBoxServiceVerbose(2, "Waiting for service '%s' to stop ...\n", g_aServices[j].pDesc->pszName);
+            int rc2 = VINF_SUCCESS;
             for (int i = 0; i < 30; i++) /* Wait 30 seconds in total */
             {
-                rc = RTThreadWait(g_aServices[j].Thread, 1000 /* Wait 1 second */, NULL);
-                if (RT_SUCCESS(rc))
+                rc2 = RTThreadWait(g_aServices[j].Thread, 1000 /* Wait 1 second */, NULL);
+                if (RT_SUCCESS(rc2))
                     break;
 #ifdef RT_OS_WINDOWS
@@ -447 +481 @@
 #endif
             }
-            if (RT_FAILURE(rc))
-                VBoxServiceError("Service '%s' failed to stop. (%Rrc)\n", g_aServices[j].pDesc->pszName, rc);
+            if (RT_FAILURE(rc2))
+            {
+                VBoxServiceError("Service '%s' failed to stop. (%Rrc)\n", g_aServices[j].pDesc->pszName, rc2);
+                rc = rc2;
+            }
         }
         VBoxServiceVerbose(3, "Terminating service '%s' (%d) ...\n", g_aServices[j].pDesc->pszName, j);
@@ -459 +496 @@
      * sleeping in VBoxServiceMainWait).
      */
+    ASMAtomicWriteBool(&g_fWindowsServiceShutdown, true);
     if (g_hEvtWindowsService != NIL_RTSEMEVENT)
     {
         VBoxServiceVerbose(3, "Stopping the main thread...\n");
-        ASMAtomicWriteBool(&g_fWindowsServiceShutdown, true);
-        rc = RTSemEventSignal(g_hEvtWindowsService);
-        AssertRC(rc);
-    }
-#endif
-
-    VBoxServiceVerbose(2, "Stopping services returned: rc=%Rrc\n", rc);
-    VBoxServiceReportStatus(RT_SUCCESS(rc)
-                            ? VBoxGuestFacilityStatus_Paused : VBoxGuestFacilityStatus_Failed);
+        int rc2 = RTSemEventSignal(g_hEvtWindowsService);
+        AssertRC(rc2);
+    }
+#endif
+
+    VBoxServiceVerbose(2, "Stopping services returning: %Rrc\n", rc);
+    VBoxServiceReportStatus(RT_SUCCESS(rc) ? VBoxGuestFacilityStatus_Paused : VBoxGuestFacilityStatus_Failed);
     return rc;
 }
@@ -535 +571 @@
 int main(int argc, char **argv)
 {
+    RTEXITCODE rcExit;
+
     /*
      * Init globals and such.
      */
-    RTR3Init();
-
+    int rc = RTR3Init();
+    if (RT_FAILURE(rc))
+        return RTMsgInitFailure(rc);
     g_pszProgName = RTPathFilename(argv[0]);
 
-    int rc;
 #ifdef VBOXSERVICE_TOOLBOX
+    /*
+     * Run toolbox code before all other stuff since these things are simpler
+     * shell/file/text utility like programs that just happens to be inside
+     * VBoxService and shouldn't be subject to /dev/vboxguest, pid-files and
+     * global mutex restrictions.
+     */
+# if 0 /** @todo r=bird: pending argv[0] bugfixing.  */
+    if (VBoxServiceToolboxMain(argc, argv, &rcExit))
+        return rcExit;
+# else
     if (argc > 1)
-    {
-        /*
-         * Run toolbox code before all other stuff, especially before checking the global
-         * mutex because VBoxService might spawn itself to execute some commands.
-         */
-        int iExitCode;
-        if (VBoxServiceToolboxMain(argc - 1, &argv[1], &iExitCode))
-            return iExitCode;
-    }
+        if (VBoxServiceToolboxMain(argc - 1, &argv[1], &rcExit))
+            return rcExit;
+# endif
 #endif
 
@@ -567 +609 @@
     {
         if (rc == VERR_ACCESS_DENIED)
-            return VBoxServiceError("Not enough rights to start %s! Please start with Administrator/root privileges!\n",
+            return VBoxServiceError("Insufficient privileges to start %s! Please start with Administrator/root privileges!\n",
                                     g_pszProgName);
-        else
-            return VBoxServiceError("VbglR3Init failed with rc=%Rrc.\n", rc);
+        return VBoxServiceError("VbglR3Init failed with rc=%Rrc.\n", rc);
     }
 
@@ -584 +625 @@
 
     /*
-     * Parse the arguments                                       .
-     *                                                           .
+     * Parse the arguments.
+     *
      * Note! This code predates RTGetOpt, thus the manual parsing.
      */
@@ -640 +681 @@
 
                 if (!fFound)
+                {
+                    rcExit = vboxServiceLazyPreInit();
+                    if (rcExit != RTEXITCODE_SUCCESS)
+                        return rcExit;
+
                     for (unsigned j = 0; !fFound && j < RT_ELEMENTS(g_aServices); j++)
                     {
@@ -649 +695 @@
                             return rc;
                     }
+                }
                 if (!fFound)
                     return VBoxServiceSyntax("Unknown option '%s'\n", argv[i]);
@@ -695 +742 @@
                 default:
                 {
+                    rcExit = vboxServiceLazyPreInit();
+                    if (rcExit != RTEXITCODE_SUCCESS)
+                        return rcExit;
+
                     bool fFound = false;
                     for (unsigned j = 0; j < RT_ELEMENTS(g_aServices); j++)
                     {
-                        rc = g_aServices[j].pDesc->pfnPreInit();
-                        if (RT_FAILURE(rc))
-                            return VBoxServiceError("Service '%s' failed pre-init: %Rrc\n", g_aServices[j].pDesc->pszName, rc);
-                        else
-                            rc = g_aServices[j].pDesc->pfnOption(&psz, argc, argv, &i);
+                        rc = g_aServices[j].pDesc->pfnOption(&psz, argc, argv, &i);
                         fFound = rc == VINF_SUCCESS;
                         if (fFound)
@@ -721 +768 @@
         return VBoxServiceSyntax("At least one service must be enabled.\n");
 
+    /* Call pre-init if we didn't do it already. */
+    rcExit = vboxServiceLazyPreInit();
+    if (rcExit != RTEXITCODE_SUCCESS)
+        return rcExit;
+
 #ifdef RT_OS_WINDOWS
     /*
@@ -764 +816 @@
      * Daemonize if requested.
      */
-    RTEXITCODE rcExit;
     if (fDaemonize && !fDaemonized)
     {
@@ -782 +833 @@
 #endif
     {
-        VBoxServiceReportStatus(VBoxGuestFacilityStatus_PreInit);
-
         /*
          * Windows: We're running the service as a console application now. Start the
@@ -797 +846 @@
             VBoxServiceMainWait();
         VBoxServiceStopServices();
-
-        /* Only report the "terminated" status when we really did run the internal services --
-         * otherwise we also wrongly would report "terminated" when a user simply
-         * wants to query the version or the command line help. */
-        VBoxServiceReportStatus(VBoxGuestFacilityStatus_Terminated);
-    }
+    }
+    VBoxServiceReportStatus(VBoxGuestFacilityStatus_Terminated);
 
 #ifdef RT_OS_WINDOWS

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceInternal.h

@@ -286 +286 @@
 
 #ifdef VBOXSERVICE_TOOLBOX
-extern bool         VBoxServiceToolboxMain(int argc, char **argv, int *piExitCode);
+extern bool         VBoxServiceToolboxMain(int argc, char **argv, RTEXITCODE *prcExit);
 #endif
 

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp

@@ -210 +210 @@
  * @param   argv                    Pointer to argument array.
  */
-static int VBoxServiceToolboxMkDir(int argc, char **argv)
+static RTEXITCODE VBoxServiceToolboxMkDir(int argc, char **argv)
 {
      static const RTGETOPTDEF s_aOptions[] =
@@ -332 +332 @@
  * @param   argv                    Pointer to argument array.
  */
-static int VBoxServiceToolboxCat(int argc, char **argv)
+static RTEXITCODE VBoxServiceToolboxCat(int argc, char **argv)
 {
      static const RTGETOPTDEF s_aOptions[] =
@@ -486 +486 @@
  * @param   argc                    Number of arguments.
  * @param   argv                    Pointer to argument array.
- * @param   piExitCode              Pointer to receive exit code when internal command
- *                                  was handled.
- */
-bool VBoxServiceToolboxMain(int argc, char **argv, int *piExitCode)
+ * @param   prcExit                 Where to store the exit code when an
+ *                                  internal toolbox command was handled.
+ */
+bool VBoxServiceToolboxMain(int argc, char **argv, RTEXITCODE *prcExit)
 {
     if (argc > 0) /* Do we have at least a main command? */
@@ -496 +496 @@
             || !strcmp(argv[0], "vbox_cat"))
         {
-            *piExitCode = VBoxServiceToolboxCat(argc, argv);
+            *prcExit = VBoxServiceToolboxCat(argc, argv);
             return true;
         }
-        else if (   !strcmp(argv[0], "mkdir")
-                 || !strcmp(argv[0], "vbox_mkdir"))
+
+        if (   !strcmp(argv[0], "mkdir")
+            || !strcmp(argv[0], "vbox_mkdir"))
         {
-            *piExitCode = VBoxServiceToolboxMkDir(argc, argv);
+            *prcExit = VBoxServiceToolboxMkDir(argc, argv);
             return true;
         }