X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=service.cpp;h=fd25163cdb26bab421998f8a60c2b8d0893b755c;hb=5078d2360f13ed4e122d21202f06d0a97b75b458;hp=ccc8e8968404b1e8a9bac0c924fa1bbf27175711;hpb=37215c1032c46095fe52808ef7c6efa98abf4159;p=nssm.git

diff --git a/service.cpp b/service.cpp
index ccc8e89..fd25163 100644
--- a/service.cpp
+++ b/service.cpp
@@ -2,16 +2,29 @@
 
 SERVICE_STATUS service_status;
 SERVICE_STATUS_HANDLE service_handle;
+HANDLE process_handle;
 HANDLE wait_handle;
-HANDLE pid;
+unsigned long pid;
 static char service_name[SERVICE_NAME_LENGTH];
 char exe[EXE_LENGTH];
 char flags[CMD_LENGTH];
 char dir[MAX_PATH];
+bool stopping;
+unsigned long throttle_delay;
+HANDLE throttle_timer;
+LARGE_INTEGER throttle_duetime;
 
 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 };
 
+static unsigned long throttle;
+
+static inline int throttle_milliseconds() {
+  /* pow() operates on doubles. */
+  int ret = 1; for (unsigned long i = 1; i < throttle; i++) ret *= 2;
+  return ret * 1000;
+}
+
 /* Connect to the service manager */
 SC_HANDLE open_service_manager() {
   SC_HANDLE ret = OpenSCManager(0, SERVICES_ACTIVE_DATABASE, SC_MANAGER_ALL_ACCESS);
@@ -30,8 +43,31 @@ int pre_install_service(int argc, char **argv) {
 
   /* Arguments are optional */
   char *flags;
-  if (argc == 2) flags = "";
-  else flags = argv[2];
+  size_t flagslen = 0;
+  size_t s = 0;
+  int i;
+  for (i = 2; i < argc; i++) flagslen += strlen(argv[i]) + 1;
+  if (! flagslen) flagslen = 1;
+
+  flags = (char *) HeapAlloc(GetProcessHeap(), 0, flagslen);
+  if (! flags) {
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "flags", "pre_install_service()", 0);
+    return 2;
+  }
+  ZeroMemory(flags, flagslen);
+
+  /*
+    This probably isn't UTF8-safe and should use std::string or something
+    but it's been broken for the best part of a decade and due for a rewrite
+    anyway so it'll do as a quick-'n'-dirty fix.  Note that we don't free
+    the flags buffer but as the program exits that isn't a big problem.
+  */
+  for (i = 2; i < argc; i++) {
+    size_t len = strlen(argv[i]);
+    memmove(flags + s, argv[i], len);
+    s += len;
+    if (i < argc - 1) flags[s++] = ' ';
+  }
 
   return install_service(argv[0], argv[1], flags);
 }
@@ -60,13 +96,12 @@ int install_service(char *name, char *exe, char *flags) {
 
   /* Construct command */
   char command[CMD_LENGTH];
-  size_t runlen = strlen(NSSM_RUN);
   size_t pathlen = strlen(path);
-  if (pathlen + runlen + 2 >= VALUE_LENGTH) {
+  if (pathlen + 1 >= VALUE_LENGTH) {
     fprintf(stderr, "The full path to " NSSM " is too long!\n");
     return 3;
   }
-  if (snprintf(command, sizeof(command), "\"%s\" %s", path, NSSM_RUN) < 0) {
+  if (_snprintf(command, sizeof(command), "\"%s\"", path) < 0) {
     fprintf(stderr, "Out of memory for ImagePath!\n");
     return 4;
   }
@@ -146,34 +181,27 @@ void WINAPI service_main(unsigned long argc, char **argv) {
   /* Initialise status */
   ZeroMemory(&service_status, sizeof(service_status));
   service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS | SERVICE_INTERACTIVE_PROCESS;
-  service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP;
+  service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_PAUSE_CONTINUE;
   service_status.dwWin32ExitCode = NO_ERROR;
   service_status.dwServiceSpecificExitCode = 0;
   service_status.dwCheckPoint = 0;
-  service_status.dwWaitHint = 1000;
+  service_status.dwWaitHint = NSSM_WAITHINT_MARGIN;
 
   /* Signal we AREN'T running the server */
+  process_handle = 0;
   pid = 0;
 
   /* Register control handler */
   service_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, 0);
   if (! service_handle) {
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, GetLastError(), 0);
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, error_string(GetLastError()), 0);
     return;
   }
 
-  /* Get startup parameters */
-  int ret = get_parameters(argv[0], exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir));
-  if (ret) {
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, argv[0], 0);
-    service_status.dwCurrentState = SERVICE_STOPPED;
-    /* An accurate, if not particularly helpful, status */
-    service_status.dwWin32ExitCode = ERROR_SERVICE_NOT_ACTIVE;
-    SetServiceStatus(service_handle, &service_status);
-    return;
-  }
+  log_service_control(service_name, 0, true);
 
   service_status.dwCurrentState = SERVICE_START_PENDING;
+  service_status.dwWaitHint = throttle_delay + NSSM_WAITHINT_MARGIN;
   SetServiceStatus(service_handle, &service_status);
 
   /* Try to create the exit action parameters; we don't care if it fails */
@@ -181,6 +209,12 @@ void WINAPI service_main(unsigned long argc, char **argv) {
 
   set_service_recovery(service_name);
 
+  /* 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);
+  }
+
   monitor_service();
 }
 
@@ -206,36 +240,102 @@ int monitor_service() {
   int ret = start_service();
   if (ret) {
     char code[16];
-    snprintf(code, sizeof(code), "%d", ret);
+    _snprintf(code, sizeof(code), "%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 */
-  if (! RegisterWaitForSingleObject(&wait_handle, pid, end_service, 0, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) {
-    log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service_name, exe, GetLastError(), 0);
+  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);
   }
 
   return 0;
 }
 
+char *service_control_text(unsigned long control) {
+  switch (control) {
+    /* HACK: there is no SERVICE_CONTROL_START constant */
+    case 0: return "START";
+    case SERVICE_CONTROL_STOP: return "STOP";
+    case SERVICE_CONTROL_SHUTDOWN: return "SHUTDOWN";
+    case SERVICE_CONTROL_PAUSE: return "PAUSE";
+    case SERVICE_CONTROL_CONTINUE: return "CONTINUE";
+    case SERVICE_CONTROL_INTERROGATE: return "INTERROGATE";
+    default: return 0;
+  }
+}
+
+void log_service_control(char *service_name, unsigned long control, bool handled) {
+  char *text = service_control_text(control);
+  unsigned long event;
+
+  if (! text) {
+    /* "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);
+      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);
+      HeapFree(GetProcessHeap(), 0, text);
+      return;
+    }
+
+    event = NSSM_EVENT_SERVICE_CONTROL_UNKNOWN;
+  }
+  else if (handled) event = NSSM_EVENT_SERVICE_CONTROL_HANDLED;
+  else event = NSSM_EVENT_SERVICE_CONTROL_NOT_HANDLED;
+
+  log_event(EVENTLOG_INFORMATION_TYPE, event, service_name, text, 0);
+
+  if (event == NSSM_EVENT_SERVICE_CONTROL_UNKNOWN) {
+    HeapFree(GetProcessHeap(), 0, text);
+  }
+}
+
 /* Service control handler */
 unsigned long WINAPI service_control_handler(unsigned long control, unsigned long event, void *data, void *context) {
   switch (control) {
     case SERVICE_CONTROL_SHUTDOWN:
     case SERVICE_CONTROL_STOP:
-      stop_service(0, true);
+      log_service_control(service_name, control, true);
+      stop_service(0, true, true);
       return NO_ERROR;
+
+    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);
+      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);
+      SetServiceStatus(service_handle, &service_status);
+      return NO_ERROR;
+
+    case SERVICE_CONTROL_PAUSE:
+      /*
+        We don't accept pause messages but it isn't possible to register
+        only for continue messages so we have to handle this case.
+      */
+      log_service_control(service_name, control, false);
+      return ERROR_CALL_NOT_IMPLEMENTED;
   }
 
   /* Unknown control */
+  log_service_control(service_name, control, false);
   return ERROR_CALL_NOT_IMPLEMENTED;
 }
 
 /* Start the service */
 int start_service() {
-  if (pid) return 0;
+  stopping = false;
+
+  if (process_handle) return 0;
 
   /* Allocate a STARTUPINFO structure for a new process */
   STARTUPINFO si;
@@ -246,30 +346,53 @@ int start_service() {
   PROCESS_INFORMATION pi;
   ZeroMemory(&pi, sizeof(pi));
 
+  /* Get startup parameters */
+  char *env = 0;
+  int ret = get_parameters(service_name, exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir), &env, &throttle_delay);
+  if (ret) {
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, service_name, 0);
+    return stop_service(2, true, true);
+  }
+
   /* Launch executable with arguments */
   char cmd[CMD_LENGTH];
-  if (_snprintf(cmd, sizeof(cmd), "%s %s", exe, flags) < 0) {
+  if (_snprintf(cmd, sizeof(cmd), "\"%s\" %s", exe, flags) < 0) {
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "start_service", 0);
-    return stop_service(2, true);
+    return stop_service(2, true, true);
   }
-  if (! CreateProcess(0, cmd, 0, 0, 0, 0, 0, dir, &si, &pi)) {
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, exe, GetLastError(), 0);
-    return stop_service(3, true);
+
+  throttle_restart();
+
+  if (! CreateProcess(0, cmd, 0, 0, false, 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);
+    else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, exe, error_string(error), 0);
+    return stop_service(3, true, true);
   }
-  pid = pi.hProcess;
+  process_handle = pi.hProcess;
+  pid = pi.dwProcessId;
 
   /* Signal successful start */
   service_status.dwCurrentState = SERVICE_RUNNING;
   SetServiceStatus(service_handle, &service_status);
 
+  /* Wait for a clean startup. */
+  if (WaitForSingleObject(process_handle, throttle_delay) == WAIT_TIMEOUT) throttle = 0;
+
   return 0;
 }
 
 /* Stop the service */
-int stop_service(unsigned long exitcode, bool graceful) {
+int stop_service(unsigned long exitcode, bool graceful, bool default_action) {
+  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;
+  }
+
   /* 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;
     SetServiceStatus(service_handle, &service_status);
   }
 
@@ -277,11 +400,13 @@ int stop_service(unsigned long exitcode, bool graceful) {
   if (pid) {
     /* Shut down server */
     log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service_name, exe, 0);
-    TerminateProcess(pid, 0);
-    pid = 0;
+    kill_process(service_name, process_handle, pid, 0);
+    process_handle = 0;
   }
   else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0);
 
+  end_service((void *) pid, true);
+
   /* Signal we stopped */
   if (graceful) {
     service_status.dwCurrentState = SERVICE_STOPPED;
@@ -301,18 +426,36 @@ int stop_service(unsigned long exitcode, bool graceful) {
 
 /* Callback function triggered when the server exits */
 void CALLBACK end_service(void *arg, unsigned char why) {
+  if (stopping) return;
+
+  stopping = true;
+
+  pid = (unsigned long) arg;
+
   /* Check exit code */
-  unsigned long ret = 0;
-  GetExitCodeProcess(pid, &ret);
+  unsigned long exitcode = 0;
+  GetExitCodeProcess(process_handle, &exitcode);
+
+  /* Clean up. */
+  kill_process_tree(service_name, pid, exitcode, pid);
+
+  /*
+    The why argument is true if our wait timed out or false otherwise.
+    Our wait is infinite so why will never be true when called by the system.
+    If it is indeed true, assume we were called from stop_service() because
+    this is a controlled shutdown, and don't take any restart action.
+  */
+  if (why) return;
 
   char code[16];
-  _snprintf(code, sizeof(code), "%d", ret);
+  _snprintf(code, sizeof(code), "%d", exitcode);
   log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0);
 
   /* What action should we take? */
   int action = NSSM_EXIT_RESTART;
   unsigned char action_string[ACTION_LEN];
-  if (! get_exit_action(service_name, &ret, action_string)) {
+  bool default_action;
+  if (! get_exit_action(service_name, &exitcode, action_string, &default_action)) {
     for (int i = 0; exit_action_strings[i]; i++) {
       if (! _strnicmp((const char *) action_string, exit_action_strings[i], ACTION_LEN)) {
         action = i;
@@ -321,6 +464,7 @@ void CALLBACK end_service(void *arg, unsigned char why) {
     }
   }
 
+  process_handle = 0;
   pid = 0;
   switch (action) {
     /* Try to restart the service or return failure code to service manager */
@@ -341,13 +485,39 @@ void CALLBACK end_service(void *arg, unsigned char why) {
     /* Tell the service manager we are finished */
     case NSSM_EXIT_REALLY:
       log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service_name, code, exit_action_strings[action], 0);
-      stop_service(ret, true);
+      stop_service(exitcode, true, default_action);
     break;
 
     /* 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(ret, false));
+      exit(stop_service(exitcode, false, default_action));
     break;
   }
 }
+
+void throttle_restart() {
+  /* This can't be a restart if the service is already running. */
+  if (! throttle++) return;
+
+  int ms = throttle_milliseconds();
+
+  if (throttle > 7) throttle = 8;
+
+  char threshold[8], milliseconds[8];
+  _snprintf(threshold, sizeof(threshold), "%d", throttle_delay);
+  _snprintf(milliseconds, sizeof(milliseconds), "%d", ms);
+  log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service_name, threshold, milliseconds, 0);
+
+  if (throttle_timer) {
+    ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));
+    throttle_duetime.QuadPart = 0 - (ms * 10000LL);
+    SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);
+  }
+
+  service_status.dwCurrentState = SERVICE_PAUSED;
+  SetServiceStatus(service_handle, &service_status);
+
+  if (throttle_timer) WaitForSingleObject(throttle_timer, INFINITE);
+  else Sleep(ms);
+}