Added await_shutdown() function.
[nssm.git] / service.cpp
index d0cba9f..028b035 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
@@ -280,7 +283,7 @@ int monitor_service() {
   }\r
   log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, exe, flags, service_name, dir, 0);\r
 \r
-  /* Monitor service service */\r
+  /* Monitor service */\r
   if (! RegisterWaitForSingleObject(&wait_handle, process_handle, end_service, (void *) pid, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) {\r
     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service_name, exe, error_string(GetLastError()), 0);\r
   }\r
@@ -309,11 +312,11 @@ void log_service_control(char *service_name, unsigned long control, bool handled
     /* "0x" + 8 x hex + NULL */\r
     text = (char *) HeapAlloc(GetProcessHeap(), 0, 11);\r
     if (! text) {\r
-      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control", 0);\r
+      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control()", 0);\r
       return;\r
     }\r
     if (_snprintf_s(text, 11, _TRUNCATE, "0x%08x", control) < 0) {\r
-      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control", 0);\r
+      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control()", 0);\r
       HeapFree(GetProcessHeap(), 0, text);\r
       return;\r
     }\r
@@ -390,7 +393,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
@@ -445,7 +448,10 @@ int stop_service(unsigned long exitcode, bool graceful, bool default_action) {
   /* Signal we are stopping */\r
   if (graceful) {\r
     service_status.dwCurrentState = SERVICE_STOP_PENDING;\r
-    service_status.dwWaitHint = NSSM_KILL_WINDOW_GRACE_PERIOD + NSSM_KILL_THREADS_GRACE_PERIOD + NSSM_WAITHINT_MARGIN;\r
+    service_status.dwWaitHint = NSSM_WAITHINT_MARGIN;\r
+    if (stop_method & NSSM_STOP_METHOD_CONSOLE && imports.AttachConsole) service_status.dwWaitHint += kill_console_delay;\r
+    if (stop_method & NSSM_STOP_METHOD_WINDOW) service_status.dwWaitHint += kill_window_delay;\r
+    if (stop_method & NSSM_STOP_METHOD_THREADS) service_status.dwWaitHint += kill_threads_delay;\r
     SetServiceStatus(service_handle, &service_status);\r
   }\r
 \r
@@ -497,11 +503,12 @@ void CALLBACK end_service(void *arg, unsigned char why) {
     tree.  See below for the possible values of the why argument.\r
   */\r
   if (! why) {\r
-    _snprintf_s(code, sizeof(code), _TRUNCATE, "%d", exitcode);\r
+    _snprintf_s(code, sizeof(code), _TRUNCATE, "%lu", exitcode);\r
     log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0);\r
   }\r
 \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
 \r
   /*\r
@@ -569,8 +576,8 @@ void throttle_restart() {
   if (throttle > 7) throttle = 8;\r
 \r
   char threshold[8], milliseconds[8];\r
-  _snprintf_s(threshold, sizeof(threshold), _TRUNCATE, "%d", throttle_delay);\r
-  _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%d", ms);\r
+  _snprintf_s(threshold, sizeof(threshold), _TRUNCATE, "%lu", throttle_delay);\r
+  _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%lu", ms);\r
   log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service_name, threshold, milliseconds, 0);\r
 \r
   if (use_critical_section) EnterCriticalSection(&throttle_section);\r
@@ -592,3 +599,89 @@ 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_SHUTDOWN_CHECKPOINT milliseconds.  If the process is still running and\r
+  we haven't finished waiting we increment dwCheckPoint and add whichever is\r
+  smaller of NSSM_SHUTDOWN_CHECKPOINT or the remaining timeout to 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_SHUTDOWN_CHECKPOINT) interval = NSSM_SHUTDOWN_CHECKPOINT;\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