X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=service.cpp;h=028b035c71281cededbc12b7cca52e18701f31ff;hb=f3d91adc48a7618fd9c94cbc45143f89b47b59e4;hp=1e78c3c9757a239a858958405317bf194d7b7fa6;hpb=c50225935f0143fbe5fb37d906aa7e6e68f81040;p=nssm.git

diff --git a/service.cpp b/service.cpp
index 1e78c3c..028b035 100644
--- a/service.cpp
+++ b/service.cpp
@@ -11,12 +11,21 @@ char exe[EXE_LENGTH];
 char flags[CMD_LENGTH];
 char dir[MAX_PATH];
 bool stopping;
+bool allow_restart;
 unsigned long throttle_delay;
 unsigned long stop_method;
+unsigned long kill_console_delay;
+unsigned long kill_window_delay;
+unsigned long kill_threads_delay;
+CRITICAL_SECTION throttle_section;
+CONDITION_VARIABLE throttle_condition;
 HANDLE throttle_timer;
 LARGE_INTEGER throttle_duetime;
+bool use_critical_section;
 FILETIME creation_time;
 
+extern imports_t imports;
+
 static enum { NSSM_EXIT_RESTART, NSSM_EXIT_IGNORE, NSSM_EXIT_REALLY, NSSM_EXIT_UNCLEAN } exit_actions;
 static const char *exit_action_strings[] = { "Restart", "Ignore", "Exit", "Suicide", 0 };
 
@@ -104,7 +113,7 @@ int install_service(char *name, char *exe, char *flags) {
     print_message(stderr, NSSM_MESSAGE_PATH_TOO_LONG, NSSM);
     return 3;
   }
-  if (_snprintf(command, sizeof(command), "\"%s\"", path) < 0) {
+  if (_snprintf_s(command, sizeof(command), _TRUNCATE, "\"%s\"", path) < 0) {
     print_message(stderr, NSSM_MESSAGE_OUT_OF_MEMORY_FOR_IMAGEPATH);
     return 4;
   }
@@ -178,11 +187,15 @@ int remove_service(char *name) {
 
 /* Service initialisation */
 void WINAPI service_main(unsigned long argc, char **argv) {
-  if (_snprintf(service_name, sizeof(service_name), "%s", argv[0]) < 0) {
+  if (_snprintf_s(service_name, sizeof(service_name), _TRUNCATE, "%s", argv[0]) < 0) {
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service_name", "service_main()", 0);
     return;
   }
 
+  /* We can use a condition variable in a critical section on Vista or later. */
+  if (imports.SleepConditionVariableCS && imports.WakeConditionVariable) use_critical_section = true;
+  else use_critical_section = false;
+
   /* Initialise status */
   ZeroMemory(&service_status, sizeof(service_status));
   service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS | SERVICE_INTERACTIVE_PROCESS;
@@ -217,9 +230,12 @@ void WINAPI service_main(unsigned long argc, char **argv) {
   }
 
   /* Used for signalling a resume if the service pauses when throttled. */
-  throttle_timer = CreateWaitableTimer(0, 1, 0);
-  if (! throttle_timer) {
-    log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_CREATEWAITABLETIMER_FAILED, service_name, error_string(GetLastError()), 0);
+  if (use_critical_section) InitializeCriticalSection(&throttle_section);
+  else {
+    throttle_timer = CreateWaitableTimer(0, 1, 0);
+    if (! throttle_timer) {
+      log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_CREATEWAITABLETIMER_FAILED, service_name, error_string(GetLastError()), 0);
+    }
   }
 
   monitor_service();
@@ -261,13 +277,13 @@ int monitor_service() {
   int ret = start_service();
   if (ret) {
     char code[16];
-    _snprintf(code, sizeof(code), "%d", ret);
+    _snprintf_s(code, sizeof(code), _TRUNCATE, "%d", ret);
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0);
     return ret;
   }
   log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, exe, flags, service_name, dir, 0);
 
-  /* Monitor service service */
+  /* Monitor service */
   if (! RegisterWaitForSingleObject(&wait_handle, process_handle, end_service, (void *) pid, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) {
     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service_name, exe, error_string(GetLastError()), 0);
   }
@@ -296,11 +312,11 @@ void log_service_control(char *service_name, unsigned long control, bool handled
     /* "0x" + 8 x hex + NULL */
     text = (char *) HeapAlloc(GetProcessHeap(), 0, 11);
     if (! text) {
-      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control", 0);
+      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control()", 0);
       return;
     }
-    if (_snprintf(text, 11, "0x%08x", control) < 0) {
-      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control", 0);
+    if (_snprintf_s(text, 11, _TRUNCATE, "0x%08x", control) < 0) {
+      log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control()", 0);
       HeapFree(GetProcessHeap(), 0, text);
       return;
     }
@@ -332,10 +348,13 @@ unsigned long WINAPI service_control_handler(unsigned long control, unsigned lon
 
     case SERVICE_CONTROL_CONTINUE:
       log_service_control(service_name, control, true);
-      if (! throttle_timer) return ERROR_CALL_NOT_IMPLEMENTED;
       throttle = 0;
-      ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));
-      SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);
+      if (use_critical_section) imports.WakeConditionVariable(&throttle_condition);
+      else {
+        if (! throttle_timer) return ERROR_CALL_NOT_IMPLEMENTED;
+        ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));
+        SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);
+      }
       service_status.dwCurrentState = SERVICE_CONTINUE_PENDING;
       service_status.dwWaitHint = throttle_milliseconds() + NSSM_WAITHINT_MARGIN;
       log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_RESET_THROTTLE, service_name, 0);
@@ -359,6 +378,7 @@ unsigned long WINAPI service_control_handler(unsigned long control, unsigned lon
 /* Start the service */
 int start_service() {
   stopping = false;
+  allow_restart = true;
 
   if (process_handle) return 0;
 
@@ -373,7 +393,7 @@ int start_service() {
 
   /* Get startup parameters */
   char *env = 0;
-  int ret = get_parameters(service_name, exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir), &env, &throttle_delay, &stop_method, &si);
+  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);
   if (ret) {
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, service_name, 0);
     return stop_service(2, true, true);
@@ -381,7 +401,7 @@ int start_service() {
 
   /* Launch executable with arguments */
   char cmd[CMD_LENGTH];
-  if (_snprintf(cmd, sizeof(cmd), "\"%s\" %s", exe, flags) < 0) {
+  if (_snprintf_s(cmd, sizeof(cmd), _TRUNCATE, "\"%s\" %s", exe, flags) < 0) {
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "start_service", 0);
     close_output_handles(&si);
     return stop_service(2, true, true);
@@ -389,7 +409,8 @@ int start_service() {
 
   throttle_restart();
 
-  bool inherit_handles = (si.dwFlags & STARTF_USESTDHANDLES);
+  bool inherit_handles = false;
+  if (si.dwFlags & STARTF_USESTDHANDLES) inherit_handles = true;
   if (! CreateProcess(0, cmd, 0, 0, inherit_handles, 0, env, dir, &si, &pi)) {
     unsigned long error = GetLastError();
     if (error == ERROR_INVALID_PARAMETER && env) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED_INVALID_ENVIRONMENT, service_name, exe, NSSM_REG_ENV, 0);
@@ -416,6 +437,9 @@ int start_service() {
 
 /* Stop the service */
 int stop_service(unsigned long exitcode, bool graceful, bool default_action) {
+  allow_restart = false;
+  if (wait_handle) UnregisterWait(wait_handle);
+
   if (default_action && ! exitcode && ! graceful) {
     log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_GRACEFUL_SUICIDE, service_name, exe, exit_action_strings[NSSM_EXIT_UNCLEAN], exit_action_strings[NSSM_EXIT_UNCLEAN], exit_action_strings[NSSM_EXIT_UNCLEAN], exit_action_strings[NSSM_EXIT_REALLY] ,0);
     graceful = true;
@@ -424,7 +448,10 @@ int stop_service(unsigned long exitcode, bool graceful, bool default_action) {
   /* Signal we are stopping */
   if (graceful) {
     service_status.dwCurrentState = SERVICE_STOP_PENDING;
-    service_status.dwWaitHint = NSSM_KILL_WINDOW_GRACE_PERIOD + NSSM_KILL_THREADS_GRACE_PERIOD + NSSM_WAITHINT_MARGIN;
+    service_status.dwWaitHint = NSSM_WAITHINT_MARGIN;
+    if (stop_method & NSSM_STOP_METHOD_CONSOLE && imports.AttachConsole) service_status.dwWaitHint += kill_console_delay;
+    if (stop_method & NSSM_STOP_METHOD_WINDOW) service_status.dwWaitHint += kill_window_delay;
+    if (stop_method & NSSM_STOP_METHOD_THREADS) service_status.dwWaitHint += kill_threads_delay;
     SetServiceStatus(service_handle, &service_status);
   }
 
@@ -476,11 +503,12 @@ void CALLBACK end_service(void *arg, unsigned char why) {
     tree.  See below for the possible values of the why argument.
   */
   if (! why) {
-    _snprintf(code, sizeof(code), "%d", exitcode);
+    _snprintf_s(code, sizeof(code), _TRUNCATE, "%lu", exitcode);
     log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0);
   }
 
   /* Clean up. */
+  if (exitcode == STILL_ACTIVE) exitcode = 0;
   kill_process_tree(service_name, stop_method, pid, exitcode, pid, &creation_time, &exit_time);
 
   /*
@@ -490,6 +518,7 @@ void CALLBACK end_service(void *arg, unsigned char why) {
     this is a controlled shutdown, and don't take any restart action.
   */
   if (why) return;
+  if (! allow_restart) return;
 
   /* What action should we take? */
   int action = NSSM_EXIT_RESTART;
@@ -531,7 +560,9 @@ void CALLBACK end_service(void *arg, unsigned char why) {
     /* Fake a crash so pre-Vista service managers will run recovery actions. */
     case NSSM_EXIT_UNCLEAN:
       log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_UNCLEAN, service_name, code, exit_action_strings[action], 0);
-      exit(stop_service(exitcode, false, default_action));
+      stop_service(exitcode, false, default_action);
+      free_imports();
+      exit(exitcode);
     break;
   }
 }
@@ -545,11 +576,12 @@ void throttle_restart() {
   if (throttle > 7) throttle = 8;
 
   char threshold[8], milliseconds[8];
-  _snprintf(threshold, sizeof(threshold), "%d", throttle_delay);
-  _snprintf(milliseconds, sizeof(milliseconds), "%d", ms);
+  _snprintf_s(threshold, sizeof(threshold), _TRUNCATE, "%lu", throttle_delay);
+  _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%lu", ms);
   log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service_name, threshold, milliseconds, 0);
 
-  if (throttle_timer) {
+  if (use_critical_section) EnterCriticalSection(&throttle_section);
+  else if (throttle_timer) {
     ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));
     throttle_duetime.QuadPart = 0 - (ms * 10000LL);
     SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);
@@ -558,6 +590,98 @@ void throttle_restart() {
   service_status.dwCurrentState = SERVICE_PAUSED;
   SetServiceStatus(service_handle, &service_status);
 
-  if (throttle_timer) WaitForSingleObject(throttle_timer, INFINITE);
-  else Sleep(ms);
+  if (use_critical_section) {
+    imports.SleepConditionVariableCS(&throttle_condition, &throttle_section, ms);
+    LeaveCriticalSection(&throttle_section);
+  }
+  else {
+    if (throttle_timer) WaitForSingleObject(throttle_timer, INFINITE);
+    else Sleep(ms);
+  }
+}
+
+/*
+  When responding to a stop (or any other) request we need to set dwWaitHint to
+  the number of milliseconds we expect the operation to take, and optionally
+  increase dwCheckPoint.  If dwWaitHint milliseconds elapses without the
+  operation completing or dwCheckPoint increasing, the system will consider the
+  service to be hung.
+
+  However the system will consider the service to be hung after 30000
+  milliseconds regardless of the value of dwWaitHint if dwCheckPoint has not
+  changed.  Therefore if we want to wait longer than that we must periodically
+  increase dwCheckPoint.
+
+  Furthermore, it will consider the service to be hung after 60000 milliseconds
+  regardless of the value of dwCheckPoint unless dwWaitHint is increased every
+  time dwCheckPoint is also increased.
+
+  Our strategy then is to retrieve the initial dwWaitHint and wait for
+  NSSM_SHUTDOWN_CHECKPOINT milliseconds.  If the process is still running and
+  we haven't finished waiting we increment dwCheckPoint and add whichever is
+  smaller of NSSM_SHUTDOWN_CHECKPOINT or the remaining timeout to dwWaitHint.
+
+  Only doing both these things will prevent the system from killing the service.
+
+  Returns: 1 if the wait timed out.
+           0 if the wait completed.
+          -1 on error.
+*/
+int await_shutdown(char *function_name, char *service_name, SERVICE_STATUS_HANDLE service_handle, SERVICE_STATUS *service_status, HANDLE process_handle, unsigned long timeout) {
+  unsigned long interval;
+  unsigned long waithint;
+  unsigned long ret;
+  unsigned long waited;
+  char interval_milliseconds[16];
+  char timeout_milliseconds[16];
+  char waited_milliseconds[16];
+  char *function = function_name;
+
+  /* Add brackets to function name. */
+  size_t funclen = strlen(function_name) + 3;
+  char *func = (char *) HeapAlloc(GetProcessHeap(), 0, funclen);
+  if (func) {
+    if (_snprintf_s(func, funclen, _TRUNCATE, "%s()", function_name) > -1) function = func;
+  }
+
+  _snprintf_s(timeout_milliseconds, sizeof(timeout_milliseconds), _TRUNCATE, "%lu", timeout);
+
+  waithint = service_status->dwWaitHint;
+  waited = 0;
+  while (waited < timeout) {
+    interval = timeout - waited;
+    if (interval > NSSM_SHUTDOWN_CHECKPOINT) interval = NSSM_SHUTDOWN_CHECKPOINT;
+
+    service_status->dwCurrentState = SERVICE_STOP_PENDING;
+    service_status->dwWaitHint += interval;
+    service_status->dwCheckPoint++;
+    SetServiceStatus(service_handle, service_status);
+
+    if (waited) {
+      _snprintf_s(waited_milliseconds, sizeof(waited_milliseconds), _TRUNCATE, "%lu", waited);
+      _snprintf_s(interval_milliseconds, sizeof(interval_milliseconds), _TRUNCATE, "%lu", interval);
+      log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_AWAITING_SHUTDOWN, function, service_name, waited_milliseconds, interval_milliseconds, timeout_milliseconds, 0);
+    }
+
+    switch (WaitForSingleObject(process_handle, interval)) {
+      case WAIT_OBJECT_0:
+        ret = 0;
+        goto awaited;
+
+      case WAIT_TIMEOUT:
+        ret = 1;
+      break;
+
+      default:
+        ret = -1;
+        goto awaited;
+    }
+
+    waited += interval;
+  }
+
+awaited:
+  if (func) HeapFree(GetProcessHeap(), 0, func);
+
+  return ret;
 }