NSSM 2.8.
[nssm.git] / service.cpp
index 8e56cf7..283cbea 100644 (file)
@@ -10,10 +10,21 @@ char exe[EXE_LENGTH];
 char flags[CMD_LENGTH];\r
 char dir[MAX_PATH];\r
 bool stopping;\r
+unsigned long throttle_delay;\r
+CRITICAL_SECTION throttle_section;\r
+CONDITION_VARIABLE throttle_condition;\r
 \r
 static enum { NSSM_EXIT_RESTART, NSSM_EXIT_IGNORE, NSSM_EXIT_REALLY, NSSM_EXIT_UNCLEAN } exit_actions;\r
 static const char *exit_action_strings[] = { "Restart", "Ignore", "Exit", "Suicide", 0 };\r
 \r
+static unsigned long throttle;\r
+\r
+static inline int throttle_milliseconds() {\r
+  /* pow() operates on doubles. */\r
+  int ret = 1; for (unsigned long i = 1; i < throttle; i++) ret *= 2;\r
+  return ret * 1000;\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
@@ -32,8 +43,31 @@ int pre_install_service(int argc, char **argv) {
 \r
   /* Arguments are optional */\r
   char *flags;\r
-  if (argc == 2) flags = "";\r
-  else flags = argv[2];\r
+  size_t flagslen = 0;\r
+  size_t s = 0;\r
+  int i;\r
+  for (i = 2; i < argc; i++) flagslen += strlen(argv[i]) + 1;\r
+  if (! flagslen) flagslen = 1;\r
+\r
+  flags = (char *) HeapAlloc(GetProcessHeap(), 0, flagslen);\r
+  if (! flags) {\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "flags", "pre_install_service()", 0);\r
+    return 2;\r
+  }\r
+  ZeroMemory(flags, flagslen);\r
+\r
+  /*\r
+    This probably isn't UTF8-safe and should use std::string or something\r
+    but it's been broken for the best part of a decade and due for a rewrite\r
+    anyway so it'll do as a quick-'n'-dirty fix.  Note that we don't free\r
+    the flags buffer but as the program exits that isn't a big problem.\r
+  */\r
+  for (i = 2; i < argc; i++) {\r
+    size_t len = strlen(argv[i]);\r
+    memmove(flags + s, argv[i], len);\r
+    s += len;\r
+    if (i < argc - 1) flags[s++] = ' ';\r
+  }\r
 \r
   return install_service(argv[0], argv[1], flags);\r
 }\r
@@ -68,7 +102,7 @@ int install_service(char *name, char *exe, char *flags) {
     fprintf(stderr, "The full path to " NSSM " is too long!\n");\r
     return 3;\r
   }\r
-  if (snprintf(command, sizeof(command), "\"%s\" %s", path, NSSM_RUN) < 0) {\r
+  if (_snprintf(command, sizeof(command), "\"%s\" %s", path, NSSM_RUN) < 0) {\r
     fprintf(stderr, "Out of memory for ImagePath!\n");\r
     return 4;\r
   }\r
@@ -148,11 +182,11 @@ void WINAPI service_main(unsigned long argc, char **argv) {
   /* Initialise status */\r
   ZeroMemory(&service_status, sizeof(service_status));\r
   service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS | SERVICE_INTERACTIVE_PROCESS;\r
-  service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP;\r
+  service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_PAUSE_CONTINUE;\r
   service_status.dwWin32ExitCode = NO_ERROR;\r
   service_status.dwServiceSpecificExitCode = 0;\r
   service_status.dwCheckPoint = 0;\r
-  service_status.dwWaitHint = 1000;\r
+  service_status.dwWaitHint = NSSM_WAITHINT_MARGIN;\r
 \r
   /* Signal we AREN'T running the server */\r
   process_handle = 0;\r
@@ -161,22 +195,12 @@ void WINAPI service_main(unsigned long argc, char **argv) {
   /* Register control handler */\r
   service_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, 0);\r
   if (! service_handle) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, GetLastError(), 0);\r
-    return;\r
-  }\r
-\r
-  /* Get startup parameters */\r
-  int ret = get_parameters(argv[0], exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir));\r
-  if (ret) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, argv[0], 0);\r
-    service_status.dwCurrentState = SERVICE_STOPPED;\r
-    /* An accurate, if not particularly helpful, status */\r
-    service_status.dwWin32ExitCode = ERROR_SERVICE_NOT_ACTIVE;\r
-    SetServiceStatus(service_handle, &service_status);\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, error_string(GetLastError()), 0);\r
     return;\r
   }\r
 \r
   service_status.dwCurrentState = SERVICE_START_PENDING;\r
+  service_status.dwWaitHint = throttle_delay + NSSM_WAITHINT_MARGIN;\r
   SetServiceStatus(service_handle, &service_status);\r
 \r
   /* Try to create the exit action parameters; we don't care if it fails */\r
@@ -184,6 +208,9 @@ void WINAPI service_main(unsigned long argc, char **argv) {
 \r
   set_service_recovery(service_name);\r
 \r
+  /* Used for signalling a resume if the service pauses when throttled. */\r
+  InitializeCriticalSection(&throttle_section);\r
+\r
   monitor_service();\r
 }\r
 \r
@@ -209,7 +236,7 @@ int monitor_service() {
   int ret = start_service();\r
   if (ret) {\r
     char code[16];\r
-    snprintf(code, sizeof(code), "%d", ret);\r
+    _snprintf(code, sizeof(code), "%d", ret);\r
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0);\r
     return ret;\r
   }\r
@@ -217,7 +244,7 @@ int monitor_service() {
 \r
   /* Monitor service 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, GetLastError(), 0);\r
+    log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service_name, exe, error_string(GetLastError()), 0);\r
   }\r
 \r
   return 0;\r
@@ -230,6 +257,22 @@ unsigned long WINAPI service_control_handler(unsigned long control, unsigned lon
     case SERVICE_CONTROL_STOP:\r
       stop_service(0, true, true);\r
       return NO_ERROR;\r
+\r
+    case SERVICE_CONTROL_CONTINUE:\r
+      throttle = 0;\r
+      WakeConditionVariable(&throttle_condition);\r
+      service_status.dwCurrentState = SERVICE_CONTINUE_PENDING;\r
+      service_status.dwWaitHint = throttle_milliseconds() + NSSM_WAITHINT_MARGIN;\r
+      log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_RESET_THROTTLE, service_name, 0);\r
+      SetServiceStatus(service_handle, &service_status);\r
+      return NO_ERROR;\r
+\r
+    case SERVICE_CONTROL_PAUSE:\r
+      /*\r
+        We don't accept pause messages but it isn't possible to register\r
+        only for continue messages so we have to handle this case.\r
+      */\r
+      return ERROR_CALL_NOT_IMPLEMENTED;\r
   }\r
 \r
   /* Unknown control */\r
@@ -251,14 +294,24 @@ int start_service() {
   PROCESS_INFORMATION pi;\r
   ZeroMemory(&pi, sizeof(pi));\r
 \r
+  /* Get startup parameters */\r
+  int ret = get_parameters(service_name, exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir), &throttle_delay);\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
+  }\r
+\r
   /* Launch executable with arguments */\r
   char cmd[CMD_LENGTH];\r
   if (_snprintf(cmd, sizeof(cmd), "%s %s", exe, flags) < 0) {\r
     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "start_service", 0);\r
     return stop_service(2, true, true);\r
   }\r
+\r
+  throttle_restart();\r
+\r
   if (! CreateProcess(0, cmd, 0, 0, false, 0, 0, dir, &si, &pi)) {\r
-    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, exe, GetLastError(), 0);\r
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, exe, error_string(GetLastError()), 0);\r
     return stop_service(3, true, true);\r
   }\r
   process_handle = pi.hProcess;\r
@@ -268,6 +321,9 @@ int start_service() {
   service_status.dwCurrentState = SERVICE_RUNNING;\r
   SetServiceStatus(service_handle, &service_status);\r
 \r
+  /* Wait for a clean startup. */\r
+  if (WaitForSingleObject(process_handle, throttle_delay) == WAIT_TIMEOUT) throttle = 0;\r
+\r
   return 0;\r
 }\r
 \r
@@ -281,6 +337,7 @@ 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
     SetServiceStatus(service_handle, &service_status);\r
   }\r
 \r
@@ -383,3 +440,26 @@ void CALLBACK end_service(void *arg, unsigned char why) {
     break;\r
   }\r
 }\r
+\r
+void throttle_restart() {\r
+  /* This can't be a restart if the service is already running. */\r
+  if (! throttle++) return;\r
+\r
+  int ms = throttle_milliseconds();\r
+\r
+  if (throttle > 7) throttle = 8;\r
+\r
+  char threshold[8], milliseconds[8];\r
+  _snprintf(threshold, sizeof(threshold), "%d", throttle_delay);\r
+  _snprintf(milliseconds, sizeof(milliseconds), "%d", ms);\r
+  log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service_name, threshold, milliseconds, 0);\r
+\r
+  EnterCriticalSection(&throttle_section);\r
+\r
+  service_status.dwCurrentState = SERVICE_PAUSED;\r
+  SetServiceStatus(service_handle, &service_status);\r
+\r
+  SleepConditionVariableCS(&throttle_condition, &throttle_section, ms);\r
+\r
+  LeaveCriticalSection(&throttle_section);\r
+}\r