Added strip_basename() function.
[nssm.git] / service.cpp
index 596aa7e..be70501 100644 (file)
@@ -14,6 +14,9 @@ bool stopping;
 bool allow_restart;\r
 unsigned long throttle_delay;\r
 unsigned long stop_method;\r
+unsigned long kill_console_delay;\r
+unsigned long kill_window_delay;\r
+unsigned long kill_threads_delay;\r
 CRITICAL_SECTION throttle_section;\r
 CONDITION_VARIABLE throttle_condition;\r
 HANDLE throttle_timer;\r
@@ -34,6 +37,14 @@ static inline int throttle_milliseconds() {
   return ret * 1000;\r
 }\r
 \r
+/*\r
+  Wrapper to be called in a new thread so that we can acknowledge a STOP\r
+  control immediately.\r
+*/\r
+static unsigned long WINAPI shutdown_service(void *arg) {\r
+  return stop_service(0, true, true);\r
+}\r
+\r
 /* Connect to the service manager */\r
 SC_HANDLE open_service_manager() {\r
   SC_HANDLE ret = OpenSCManager(0, SERVICES_ACTIVE_DATABASE, SC_MANAGER_ALL_ACCESS);\r
@@ -340,7 +351,24 @@ unsigned long WINAPI service_control_handler(unsigned long control, unsigned lon
     case SERVICE_CONTROL_SHUTDOWN:\r
     case SERVICE_CONTROL_STOP:\r
       log_service_control(service_name, control, true);\r
-      stop_service(0, true, true);\r
+      /*\r
+        We MUST acknowledge the stop request promptly but we're committed to\r
+        waiting for the application to exit.  Spawn a new thread to wait\r
+        while we acknowledge the request.\r
+      */\r
+      if (! CreateThread(NULL, 0, shutdown_service, (void *) service_name, 0, NULL)) {\r
+        log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATETHREAD_FAILED, error_string(GetLastError()), 0);\r
+\r
+        /*\r
+          We couldn't create a thread to tidy up so we'll have to force the tidyup\r
+          to complete in time in this thread.\r
+        */\r
+        kill_console_delay = NSSM_KILL_CONSOLE_GRACE_PERIOD;\r
+        kill_window_delay = NSSM_KILL_WINDOW_GRACE_PERIOD;\r
+        kill_threads_delay = NSSM_KILL_THREADS_GRACE_PERIOD;\r
+\r
+        stop_service(0, true, true);\r
+      }\r
       return NO_ERROR;\r
 \r
     case SERVICE_CONTROL_CONTINUE:\r
@@ -390,7 +418,7 @@ int start_service() {
 \r
   /* Get startup parameters */\r
   char *env = 0;\r
-  int ret = get_parameters(service_name, exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir), &env, &throttle_delay, &stop_method, &si);\r
+  int ret = get_parameters(service_name, exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir), &env, &throttle_delay, &stop_method, &kill_console_delay, &kill_window_delay, &kill_threads_delay, &si);\r
   if (ret) {\r
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, service_name, 0);\r
     return stop_service(2, true, true);\r
@@ -422,13 +450,34 @@ int start_service() {
 \r
   close_output_handles(&si);\r
 \r
-  /* Wait for a clean startup. */\r
-  if (WaitForSingleObject(process_handle, throttle_delay) == WAIT_TIMEOUT) throttle = 0;\r
+  /*\r
+    Wait for a clean startup before changing the service status to RUNNING\r
+    but be mindful of the fact that we are blocking the service control manager\r
+    so abandon the wait before too much time has elapsed.\r
+  */\r
+  unsigned long delay = throttle_delay;\r
+  if (delay > NSSM_SERVICE_STATUS_DEADLINE) {\r
+    char delay_milliseconds[16];\r
+    _snprintf_s(delay_milliseconds, sizeof(delay_milliseconds), _TRUNCATE, "%lu", delay);\r
+    char deadline_milliseconds[16];\r
+    _snprintf_s(deadline_milliseconds, sizeof(deadline_milliseconds), _TRUNCATE, "%lu", NSSM_SERVICE_STATUS_DEADLINE);\r
+    log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_STARTUP_DELAY_TOO_LONG, service_name, delay_milliseconds, NSSM, deadline_milliseconds, 0);\r
+    delay = NSSM_SERVICE_STATUS_DEADLINE;\r
+  }\r
+  unsigned long deadline = WaitForSingleObject(process_handle, delay);\r
 \r
   /* Signal successful start */\r
   service_status.dwCurrentState = SERVICE_RUNNING;\r
   SetServiceStatus(service_handle, &service_status);\r
 \r
+  /* Continue waiting for a clean startup. */\r
+  if (deadline == WAIT_TIMEOUT) {\r
+    if (throttle_delay > delay) {\r
+      if (WaitForSingleObject(process_handle, throttle_delay - delay) == WAIT_TIMEOUT) throttle = 0;\r
+    }\r
+    else throttle = 0;\r
+  }\r
+\r
   return 0;\r
 }\r
 \r
@@ -446,9 +495,6 @@ int stop_service(unsigned long exitcode, bool graceful, bool default_action) {
   if (graceful) {\r
     service_status.dwCurrentState = SERVICE_STOP_PENDING;\r
     service_status.dwWaitHint = NSSM_WAITHINT_MARGIN;\r
-    if (stop_method & NSSM_STOP_METHOD_CONSOLE && imports.AttachConsole) service_status.dwWaitHint += NSSM_KILL_CONSOLE_GRACE_PERIOD;\r
-    if (stop_method & NSSM_STOP_METHOD_WINDOW) service_status.dwWaitHint += NSSM_KILL_WINDOW_GRACE_PERIOD;\r
-    if (stop_method & NSSM_STOP_METHOD_THREADS) service_status.dwWaitHint += NSSM_KILL_THREADS_GRACE_PERIOD;\r
     SetServiceStatus(service_handle, &service_status);\r
   }\r
 \r
@@ -456,7 +502,7 @@ int stop_service(unsigned long exitcode, bool graceful, bool default_action) {
   if (pid) {\r
     /* Shut down service */\r
     log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service_name, exe, 0);\r
-    kill_process(service_name, stop_method, process_handle, pid, 0);\r
+    kill_process(service_name, service_handle, &service_status, stop_method, process_handle, pid, 0);\r
   }\r
   else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0);\r
 \r
@@ -506,7 +552,7 @@ void CALLBACK end_service(void *arg, unsigned char why) {
 \r
   /* Clean up. */\r
   if (exitcode == STILL_ACTIVE) exitcode = 0;\r
-  kill_process_tree(service_name, stop_method, pid, exitcode, pid, &creation_time, &exit_time);\r
+  kill_process_tree(service_name, service_handle, &service_status, stop_method, pid, exitcode, pid, &creation_time, &exit_time);\r
 \r
   /*\r
     The why argument is true if our wait timed out or false otherwise.\r
@@ -596,3 +642,90 @@ void throttle_restart() {
     else Sleep(ms);\r
   }\r
 }\r
+\r
+/*\r
+  When responding to a stop (or any other) request we need to set dwWaitHint to\r
+  the number of milliseconds we expect the operation to take, and optionally\r
+  increase dwCheckPoint.  If dwWaitHint milliseconds elapses without the\r
+  operation completing or dwCheckPoint increasing, the system will consider the\r
+  service to be hung.\r
+\r
+  However the system will consider the service to be hung after 30000\r
+  milliseconds regardless of the value of dwWaitHint if dwCheckPoint has not\r
+  changed.  Therefore if we want to wait longer than that we must periodically\r
+  increase dwCheckPoint.\r
+\r
+  Furthermore, it will consider the service to be hung after 60000 milliseconds\r
+  regardless of the value of dwCheckPoint unless dwWaitHint is increased every\r
+  time dwCheckPoint is also increased.\r
+\r
+  Our strategy then is to retrieve the initial dwWaitHint and wait for\r
+  NSSM_SERVICE_STATUS_DEADLINE milliseconds.  If the process is still running\r
+  and we haven't finished waiting we increment dwCheckPoint and add whichever is\r
+  smaller of NSSM_SERVICE_STATUS_DEADLINE or the remaining timeout to\r
+  dwWaitHint.\r
+\r
+  Only doing both these things will prevent the system from killing the service.\r
+\r
+  Returns: 1 if the wait timed out.\r
+           0 if the wait completed.\r
+          -1 on error.\r
+*/\r
+int await_shutdown(char *function_name, char *service_name, SERVICE_STATUS_HANDLE service_handle, SERVICE_STATUS *service_status, HANDLE process_handle, unsigned long timeout) {\r
+  unsigned long interval;\r
+  unsigned long waithint;\r
+  unsigned long ret;\r
+  unsigned long waited;\r
+  char interval_milliseconds[16];\r
+  char timeout_milliseconds[16];\r
+  char waited_milliseconds[16];\r
+  char *function = function_name;\r
+\r
+  /* Add brackets to function name. */\r
+  size_t funclen = strlen(function_name) + 3;\r
+  char *func = (char *) HeapAlloc(GetProcessHeap(), 0, funclen);\r
+  if (func) {\r
+    if (_snprintf_s(func, funclen, _TRUNCATE, "%s()", function_name) > -1) function = func;\r
+  }\r
+\r
+  _snprintf_s(timeout_milliseconds, sizeof(timeout_milliseconds), _TRUNCATE, "%lu", timeout);\r
+\r
+  waithint = service_status->dwWaitHint;\r
+  waited = 0;\r
+  while (waited < timeout) {\r
+    interval = timeout - waited;\r
+    if (interval > NSSM_SERVICE_STATUS_DEADLINE) interval = NSSM_SERVICE_STATUS_DEADLINE;\r
+\r
+    service_status->dwCurrentState = SERVICE_STOP_PENDING;\r
+    service_status->dwWaitHint += interval;\r
+    service_status->dwCheckPoint++;\r
+    SetServiceStatus(service_handle, service_status);\r
+\r
+    if (waited) {\r
+      _snprintf_s(waited_milliseconds, sizeof(waited_milliseconds), _TRUNCATE, "%lu", waited);\r
+      _snprintf_s(interval_milliseconds, sizeof(interval_milliseconds), _TRUNCATE, "%lu", interval);\r
+      log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_AWAITING_SHUTDOWN, function, service_name, waited_milliseconds, interval_milliseconds, timeout_milliseconds, 0);\r
+    }\r
+\r
+    switch (WaitForSingleObject(process_handle, interval)) {\r
+      case WAIT_OBJECT_0:\r
+        ret = 0;\r
+        goto awaited;\r
+\r
+      case WAIT_TIMEOUT:\r
+        ret = 1;\r
+      break;\r
+\r
+      default:\r
+        ret = -1;\r
+        goto awaited;\r
+    }\r
+\r
+    waited += interval;\r
+  }\r
+\r
+awaited:\r
+  if (func) HeapFree(GetProcessHeap(), 0, func);\r
+\r
+  return ret;\r
+}\r