Log that we received control messages.
[nssm.git] / service.cpp
index 1010666..fd25163 100644 (file)
@@ -10,8 +10,9 @@ char exe[EXE_LENGTH];
 char flags[CMD_LENGTH];\r
 char dir[MAX_PATH];\r
 bool stopping;\r
-CRITICAL_SECTION throttle_section;\r
-CONDITION_VARIABLE throttle_condition;\r
+unsigned long throttle_delay;\r
+HANDLE throttle_timer;\r
+LARGE_INTEGER throttle_duetime;\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
@@ -42,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
@@ -72,13 +96,12 @@ int install_service(char *name, char *exe, char *flags) {
 \r
   /* Construct command */\r
   char command[CMD_LENGTH];\r
-  size_t runlen = strlen(NSSM_RUN);\r
   size_t pathlen = strlen(path);\r
-  if (pathlen + runlen + 2 >= VALUE_LENGTH) {\r
+  if (pathlen + 1 >= VALUE_LENGTH) {\r
     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\"", path) < 0) {\r
     fprintf(stderr, "Out of memory for ImagePath!\n");\r
     return 4;\r
   }\r
@@ -171,23 +194,14 @@ 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
+    log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, error_string(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
-    return;\r
-  }\r
+  log_service_control(service_name, 0, true);\r
 \r
   service_status.dwCurrentState = SERVICE_START_PENDING;\r
-  service_status.dwWaitHint = NSSM_RESET_THROTTLE_RESTART + NSSM_WAITHINT_MARGIN;\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
@@ -196,7 +210,10 @@ void WINAPI service_main(unsigned long argc, char **argv) {
   set_service_recovery(service_name);\r
 \r
   /* Used for signalling a resume if the service pauses when throttled. */\r
-  InitializeCriticalSection(&throttle_section);\r
+  throttle_timer = CreateWaitableTimer(0, 1, 0);\r
+  if (! throttle_timer) {\r
+    log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_CREATEWAITABLETIMER_FAILED, service_name, error_string(GetLastError()), 0);\r
+  }\r
 \r
   monitor_service();\r
 }\r
@@ -223,7 +240,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
@@ -231,23 +248,69 @@ 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
 }\r
 \r
+char *service_control_text(unsigned long control) {\r
+  switch (control) {\r
+    /* HACK: there is no SERVICE_CONTROL_START constant */\r
+    case 0: return "START";\r
+    case SERVICE_CONTROL_STOP: return "STOP";\r
+    case SERVICE_CONTROL_SHUTDOWN: return "SHUTDOWN";\r
+    case SERVICE_CONTROL_PAUSE: return "PAUSE";\r
+    case SERVICE_CONTROL_CONTINUE: return "CONTINUE";\r
+    case SERVICE_CONTROL_INTERROGATE: return "INTERROGATE";\r
+    default: return 0;\r
+  }\r
+}\r
+\r
+void log_service_control(char *service_name, unsigned long control, bool handled) {\r
+  char *text = service_control_text(control);\r
+  unsigned long event;\r
+\r
+  if (! text) {\r
+    /* "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
+      return;\r
+    }\r
+    if (_snprintf(text, 11, "0x%08x", 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
+\r
+    event = NSSM_EVENT_SERVICE_CONTROL_UNKNOWN;\r
+  }\r
+  else if (handled) event = NSSM_EVENT_SERVICE_CONTROL_HANDLED;\r
+  else event = NSSM_EVENT_SERVICE_CONTROL_NOT_HANDLED;\r
+\r
+  log_event(EVENTLOG_INFORMATION_TYPE, event, service_name, text, 0);\r
+\r
+  if (event == NSSM_EVENT_SERVICE_CONTROL_UNKNOWN) {\r
+    HeapFree(GetProcessHeap(), 0, text);\r
+  }\r
+}\r
+\r
 /* Service control handler */\r
 unsigned long WINAPI service_control_handler(unsigned long control, unsigned long event, void *data, void *context) {\r
   switch (control) {\r
     case SERVICE_CONTROL_SHUTDOWN:\r
     case SERVICE_CONTROL_STOP:\r
+      log_service_control(service_name, control, true);\r
       stop_service(0, true, true);\r
       return NO_ERROR;\r
 \r
     case SERVICE_CONTROL_CONTINUE:\r
+      log_service_control(service_name, control, true);\r
+      if (! throttle_timer) return ERROR_CALL_NOT_IMPLEMENTED;\r
       throttle = 0;\r
-      WakeConditionVariable(&throttle_condition);\r
+      ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));\r
+      SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);\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
@@ -259,10 +322,12 @@ unsigned long WINAPI service_control_handler(unsigned long control, unsigned lon
         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
+      log_service_control(service_name, control, false);\r
       return ERROR_CALL_NOT_IMPLEMENTED;\r
   }\r
 \r
   /* Unknown control */\r
+  log_service_control(service_name, control, false);\r
   return ERROR_CALL_NOT_IMPLEMENTED;\r
 }\r
 \r
@@ -281,17 +346,27 @@ int start_service() {
   PROCESS_INFORMATION pi;\r
   ZeroMemory(&pi, sizeof(pi));\r
 \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);\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
+  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
+  if (! CreateProcess(0, cmd, 0, 0, false, 0, env, dir, &si, &pi)) {\r
+    unsigned long error = GetLastError();\r
+    if (error == ERROR_INVALID_PARAMETER && env) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED_INVALID_ENVIRONMENT, service_name, exe, NSSM_REG_ENV, 0);\r
+    else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, exe, error_string(error), 0);\r
     return stop_service(3, true, true);\r
   }\r
   process_handle = pi.hProcess;\r
@@ -302,7 +377,7 @@ int start_service() {
   SetServiceStatus(service_handle, &service_status);\r
 \r
   /* Wait for a clean startup. */\r
-  if (WaitForSingleObject(process_handle, NSSM_RESET_THROTTLE_RESTART) == WAIT_TIMEOUT) throttle = 0;\r
+  if (WaitForSingleObject(process_handle, throttle_delay) == WAIT_TIMEOUT) throttle = 0;\r
 \r
   return 0;\r
 }\r
@@ -430,16 +505,19 @@ void throttle_restart() {
   if (throttle > 7) throttle = 8;\r
 \r
   char threshold[8], milliseconds[8];\r
-  _snprintf(threshold, sizeof(threshold), "%d", NSSM_RESET_THROTTLE_RESTART);\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
+  if (throttle_timer) {\r
+    ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));\r
+    throttle_duetime.QuadPart = 0 - (ms * 10000LL);\r
+    SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);\r
+  }\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
+  if (throttle_timer) WaitForSingleObject(throttle_timer, INFINITE);\r
+  else Sleep(ms);\r
 }\r