X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=service.cpp;h=0a95ccffe35172d6e39b59f6abba82ad2d6b5953;hb=470de9224d9473853d24006d7ae13eba818ecf0f;hp=8c4297271334ad8c1085b5a1802c2e50ebcc2e37;hpb=b465216f3ec97443952f64ba5d068354c1296d3c;p=nssm.git diff --git a/service.cpp b/service.cpp index 8c42972..0a95ccf 100644 --- a/service.cpp +++ b/service.cpp @@ -1,241 +1,434 @@ #include "nssm.h" -SERVICE_STATUS service_status; -SERVICE_STATUS_HANDLE service_handle; -HANDLE wait_handle; -HANDLE pid; -static char service_name[SERVICE_NAME_LENGTH]; -char exe[EXE_LENGTH]; -char flags[CMD_LENGTH]; -char dir[MAX_PATH]; - -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 }; +bool is_admin; +bool use_critical_section; + +extern imports_t imports; + +const char *exit_action_strings[] = { "Restart", "Ignore", "Exit", "Suicide", 0 }; + +static inline int throttle_milliseconds(unsigned long throttle) { + /* pow() operates on doubles. */ + int ret = 1; for (unsigned long i = 1; i < throttle; i++) ret *= 2; + return ret * 1000; +} + +/* + Wrapper to be called in a new thread so that we can acknowledge a STOP + control immediately. +*/ +static unsigned long WINAPI shutdown_service(void *arg) { + return stop_service((nssm_service_t *) arg, 0, true, true); +} /* Connect to the service manager */ SC_HANDLE open_service_manager() { SC_HANDLE ret = OpenSCManager(0, SERVICES_ACTIVE_DATABASE, SC_MANAGER_ALL_ACCESS); if (! ret) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENSCMANAGER_FAILED, 0); + if (is_admin) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENSCMANAGER_FAILED, 0); return 0; } return ret; } +/* Set default values which aren't zero. */ +void set_nssm_service_defaults(nssm_service_t *service) { + if (! service) return; + + service->stdin_sharing = NSSM_STDIN_SHARING; + service->stdin_disposition = NSSM_STDIN_DISPOSITION; + service->stdin_flags = NSSM_STDIN_FLAGS; + service->stdout_sharing = NSSM_STDOUT_SHARING; + service->stdout_disposition = NSSM_STDOUT_DISPOSITION; + service->stdout_flags = NSSM_STDOUT_FLAGS; + service->stderr_sharing = NSSM_STDERR_SHARING; + service->stderr_disposition = NSSM_STDERR_DISPOSITION; + service->stderr_flags = NSSM_STDERR_FLAGS; + service->throttle_delay = NSSM_RESET_THROTTLE_RESTART; + service->stop_method = ~0; + service->kill_console_delay = NSSM_KILL_CONSOLE_GRACE_PERIOD; + service->kill_window_delay = NSSM_KILL_WINDOW_GRACE_PERIOD; + service->kill_threads_delay = NSSM_KILL_THREADS_GRACE_PERIOD; +} + +/* Allocate and zero memory for a service. */ +nssm_service_t *alloc_nssm_service() { + nssm_service_t *service = (nssm_service_t *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(nssm_service_t)); + if (! service) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service", "alloc_nssm_service()", 0); + return service; +} + +/* Free memory for a service. */ +void cleanup_nssm_service(nssm_service_t *service) { + if (! service) return; + if (service->env) HeapFree(GetProcessHeap(), 0, service->env); + if (service->env_extra) HeapFree(GetProcessHeap(), 0, service->env_extra); + if (service->handle) CloseServiceHandle(service->handle); + if (service->process_handle) CloseHandle(service->process_handle); + if (service->wait_handle) UnregisterWait(service->process_handle); + if (service->throttle_section_initialised) DeleteCriticalSection(&service->throttle_section); + if (service->throttle_timer) CloseHandle(service->throttle_timer); + HeapFree(GetProcessHeap(), 0, service); +} + /* About to install the service */ int pre_install_service(int argc, char **argv) { - /* Show the dialogue box if we didn't give the */ + /* Show the dialogue box if we didn't give the service name and path */ if (argc < 2) return nssm_gui(IDD_INSTALL, argv[0]); + nssm_service_t *service = alloc_nssm_service(); + if (! service) { + print_message(stderr, NSSM_EVENT_OUT_OF_MEMORY, "service", "pre_install_service()"); + return 1; + } + + set_nssm_service_defaults(service); + memmove(service->name, argv[0], strlen(argv[0])); + memmove(service->exe, argv[1], strlen(argv[1])); + /* 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; + + /* + 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(service->flags + s, argv[i], len); + s += len; + if (i < argc - 1) service->flags[s++] = ' '; + } - return install_service(argv[0], argv[1], flags); + /* Work out directory name */ + memmove(service->dir, service->exe, sizeof(service->dir)); + strip_basename(service->dir); + + int ret = install_service(service); + cleanup_nssm_service(service); + return ret; } /* About to remove the service */ int pre_remove_service(int argc, char **argv) { /* Show dialogue box if we didn't pass service name and "confirm" */ if (argc < 2) return nssm_gui(IDD_REMOVE, argv[0]); - if (str_equiv(argv[1], "confirm")) return remove_service(argv[0]); - fprintf(stderr, "To remove a service without confirmation: nssm remove confirm\n"); + if (str_equiv(argv[1], "confirm")) { + nssm_service_t *service = alloc_nssm_service(); + memmove(service->name, argv[0], strlen(argv[0])); + int ret = remove_service(service); + cleanup_nssm_service(service); + return ret; + } + print_message(stderr, NSSM_MESSAGE_PRE_REMOVE_SERVICE); return 100; } /* Install the service */ -int install_service(char *name, char *exe, char *flags) { +int install_service(nssm_service_t *service) { + if (! service) return 1; + /* Open service manager */ SC_HANDLE services = open_service_manager(); if (! services) { - fprintf(stderr, "Error opening service manager!\n"); + print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED); + cleanup_nssm_service(service); return 2; } - + /* Get path of this program */ char path[MAX_PATH]; GetModuleFileName(0, path, MAX_PATH); /* Construct command */ char command[CMD_LENGTH]; - size_t runlen = strlen(NSSM_RUN); size_t pathlen = strlen(path); - if (pathlen + runlen + 2 >= VALUE_LENGTH) { - fprintf(stderr, "The full path to " NSSM " is too long!\n"); + if (pathlen + 1 >= VALUE_LENGTH) { + print_message(stderr, NSSM_MESSAGE_PATH_TOO_LONG, NSSM); return 3; } - if (snprintf(command, sizeof(command), "\"%s\" %s", path, NSSM_RUN) < 0) { - fprintf(stderr, "Out of memory for ImagePath!\n"); + if (_snprintf_s(command, sizeof(command), _TRUNCATE, "\"%s\"", path) < 0) { + print_message(stderr, NSSM_MESSAGE_OUT_OF_MEMORY_FOR_IMAGEPATH); return 4; } - /* Work out directory name */ - size_t len = strlen(exe); - size_t i; - for (i = len; i && exe[i] != '\\' && exe[i] != '/'; i--); - char dir[MAX_PATH]; - memmove(dir, exe, i); - dir[i] = '\0'; - /* Create the service */ - SC_HANDLE service = CreateService(services, name, name, SC_MANAGER_ALL_ACCESS, SERVICE_WIN32_OWN_PROCESS, SERVICE_AUTO_START, SERVICE_ERROR_NORMAL, command, 0, 0, 0, 0, 0); - if (! service) { - fprintf(stderr, "Error creating service!\n"); + service->handle = CreateService(services, service->name, service->name, SC_MANAGER_ALL_ACCESS, SERVICE_WIN32_OWN_PROCESS, SERVICE_AUTO_START, SERVICE_ERROR_NORMAL, command, 0, 0, 0, 0, 0); + if (! service->handle) { + print_message(stderr, NSSM_MESSAGE_CREATESERVICE_FAILED); CloseServiceHandle(services); return 5; } /* Now we need to put the parameters into the registry */ - if (create_parameters(name, exe, flags, dir)) { - fprintf(stderr, "Error setting startup parameters for the service!\n"); - DeleteService(service); + if (create_parameters(service)) { + print_message(stderr, NSSM_MESSAGE_CREATE_PARAMETERS_FAILED); + DeleteService(service->handle); CloseServiceHandle(services); return 6; } + set_service_recovery(service); + + print_message(stdout, NSSM_MESSAGE_SERVICE_INSTALLED, service->name); + /* Cleanup */ - CloseServiceHandle(service); CloseServiceHandle(services); - printf("Service \"%s\" installed successfully!\n", name); return 0; } /* Remove the service */ -int remove_service(char *name) { +int remove_service(nssm_service_t *service) { + if (! service) return 1; + /* Open service manager */ SC_HANDLE services = open_service_manager(); if (! services) { - fprintf(stderr, "Error opening service manager!\n"); + print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED); return 2; } - + /* Try to open the service */ - SC_HANDLE service = OpenService(services, name, SC_MANAGER_ALL_ACCESS); - if (! service) { - fprintf(stderr, "Can't open service!"); + service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS); + if (! service->handle) { + print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED); CloseServiceHandle(services); return 3; } /* Try to delete the service */ - if (! DeleteService(service)) { - fprintf(stderr, "Error deleting service!\n"); - CloseServiceHandle(service); + if (! DeleteService(service->handle)) { + print_message(stderr, NSSM_MESSAGE_DELETESERVICE_FAILED); CloseServiceHandle(services); return 4; } /* Cleanup */ - CloseServiceHandle(service); CloseServiceHandle(services); - printf("Service \"%s\" removed successfully!\n", name); + print_message(stdout, NSSM_MESSAGE_SERVICE_REMOVED, service->name); return 0; } /* Service initialisation */ void WINAPI service_main(unsigned long argc, char **argv) { - if (_snprintf(service_name, sizeof(service_name), "%s", argv[0]) < 0) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service_name", "service_main()", 0); + nssm_service_t *service = alloc_nssm_service(); + if (! service) return; + + 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; - service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP; - service_status.dwWin32ExitCode = NO_ERROR; - service_status.dwServiceSpecificExitCode = 0; - service_status.dwCheckPoint = 0; - service_status.dwWaitHint = 1000; + 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_ACCEPT_PAUSE_CONTINUE; + service->status.dwWin32ExitCode = NO_ERROR; + service->status.dwServiceSpecificExitCode = 0; + service->status.dwCheckPoint = 0; + service->status.dwWaitHint = NSSM_WAITHINT_MARGIN; /* Signal we AREN'T running the server */ - pid = 0; + service->process_handle = 0; + service->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); + service->status_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, (void *) service); + if (! service->status_handle) { + 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; - SetServiceStatus(service_handle, &service_status); + service->status.dwCurrentState = SERVICE_START_PENDING; + service->status.dwWaitHint = service->throttle_delay + NSSM_WAITHINT_MARGIN; + SetServiceStatus(service->status_handle, &service->status); - /* Try to create the exit action parameters; we don't care if it fails */ - create_exit_action(argv[0], exit_action_strings[0]); + if (is_admin) { + /* Try to create the exit action parameters; we don't care if it fails */ + create_exit_action(service->name, exit_action_strings[0]); + + SC_HANDLE services = open_service_manager(); + if (services) { + service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS); + set_service_recovery(service); + CloseServiceHandle(services); + } + } - set_service_recovery(service_name); + /* Used for signalling a resume if the service pauses when throttled. */ + if (use_critical_section) { + InitializeCriticalSection(&service->throttle_section); + service->throttle_section_initialised = true; + } + else { + service->throttle_timer = CreateWaitableTimer(0, 1, 0); + if (! service->throttle_timer) { + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_CREATEWAITABLETIMER_FAILED, service->name, error_string(GetLastError()), 0); + } + } - monitor_service(); + monitor_service(service); } /* Make sure service recovery actions are taken where necessary */ -void set_service_recovery(char *service_name) { - SC_HANDLE services = open_service_manager(); - if (! services) return; - - SC_HANDLE service = OpenService(services, service_name, SC_MANAGER_ALL_ACCESS); - if (! service) return; - return; - +void set_service_recovery(nssm_service_t *service) { SERVICE_FAILURE_ACTIONS_FLAG flag; ZeroMemory(&flag, sizeof(flag)); flag.fFailureActionsOnNonCrashFailures = true; /* This functionality was added in Vista so the call may fail */ - ChangeServiceConfig2(service, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag); + if (! ChangeServiceConfig2(service->handle, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag)) { + unsigned long error = GetLastError(); + /* Pre-Vista we expect to fail with ERROR_INVALID_LEVEL */ + if (error != ERROR_INVALID_LEVEL) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CHANGESERVICECONFIG2_FAILED, service->name, error_string(error), 0); + } + } } -int monitor_service() { +int monitor_service(nssm_service_t *service) { /* Set service status to started */ - int ret = start_service(); + int ret = start_service(service); if (ret) { char code[16]; - snprintf(code, sizeof(code), "%d", ret); - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0); + _snprintf_s(code, sizeof(code), _TRUNCATE, "%d", ret); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, service->exe, service->name, ret, 0); return ret; } - log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, exe, flags, service_name, dir, 0); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, service->exe, service->flags, service->name, service->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); + /* Monitor service */ + if (! RegisterWaitForSingleObject(&service->wait_handle, service->process_handle, end_service, (void *) service, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) { + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service->name, service->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_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; + } + + 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) { + nssm_service_t *service = (nssm_service_t *) context; + switch (control) { + case SERVICE_CONTROL_INTERROGATE: + /* We always keep the service status up-to-date so this is a no-op. */ + return NO_ERROR; + case SERVICE_CONTROL_SHUTDOWN: case SERVICE_CONTROL_STOP: - stop_service(0, true, true); + log_service_control(service->name, control, true); + /* + We MUST acknowledge the stop request promptly but we're committed to + waiting for the application to exit. Spawn a new thread to wait + while we acknowledge the request. + */ + if (! CreateThread(NULL, 0, shutdown_service, context, 0, NULL)) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATETHREAD_FAILED, error_string(GetLastError()), 0); + + /* + We couldn't create a thread to tidy up so we'll have to force the tidyup + to complete in time in this thread. + */ + service->kill_console_delay = NSSM_KILL_CONSOLE_GRACE_PERIOD; + service->kill_window_delay = NSSM_KILL_WINDOW_GRACE_PERIOD; + service->kill_threads_delay = NSSM_KILL_THREADS_GRACE_PERIOD; + + stop_service(service, 0, true, true); + } + return NO_ERROR; + + case SERVICE_CONTROL_CONTINUE: + log_service_control(service->name, control, true); + service->throttle = 0; + if (use_critical_section) imports.WakeConditionVariable(&service->throttle_condition); + else { + if (! service->throttle_timer) return ERROR_CALL_NOT_IMPLEMENTED; + ZeroMemory(&service->throttle_duetime, sizeof(service->throttle_duetime)); + SetWaitableTimer(service->throttle_timer, &service->throttle_duetime, 0, 0, 0, 0); + } + service->status.dwCurrentState = SERVICE_CONTINUE_PENDING; + service->status.dwWaitHint = throttle_milliseconds(service->throttle) + NSSM_WAITHINT_MARGIN; + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_RESET_THROTTLE, service->name, 0); + SetServiceStatus(service->status_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; +int start_service(nssm_service_t *service) { + service->stopping = false; + service->allow_restart = true; + + if (service->process_handle) return 0; /* Allocate a STARTUPINFO structure for a new process */ STARTUPINFO si; @@ -246,59 +439,112 @@ int start_service() { PROCESS_INFORMATION pi; ZeroMemory(&pi, sizeof(pi)); + /* Get startup parameters */ + int ret = get_parameters(service, &si); + if (ret) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, service->name, 0); + return stop_service(service, 2, true, true); + } + /* 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", service->exe, service->flags) < 0) { log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "start_service", 0); - return stop_service(2, true, true); + close_output_handles(&si); + return stop_service(service, 2, true, true); + } + + throttle_restart(service); + + bool inherit_handles = false; + if (si.dwFlags & STARTF_USESTDHANDLES) inherit_handles = true; + if (! CreateProcess(0, cmd, 0, 0, inherit_handles, 0, service->env, service->dir, &si, &pi)) { + unsigned long error = GetLastError(); + if (error == ERROR_INVALID_PARAMETER && service->env) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED_INVALID_ENVIRONMENT, service->name, service->exe, NSSM_REG_ENV, 0); + else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service->name, service->exe, error_string(error), 0); + close_output_handles(&si); + return stop_service(service, 3, 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, true); + service->process_handle = pi.hProcess; + service->pid = pi.dwProcessId; + + if (get_process_creation_time(service->process_handle, &service->creation_time)) ZeroMemory(&service->creation_time, sizeof(service->creation_time)); + + close_output_handles(&si); + + /* + Wait for a clean startup before changing the service status to RUNNING + but be mindful of the fact that we are blocking the service control manager + so abandon the wait before too much time has elapsed. + */ + unsigned long delay = service->throttle_delay; + if (delay > NSSM_SERVICE_STATUS_DEADLINE) { + char delay_milliseconds[16]; + _snprintf_s(delay_milliseconds, sizeof(delay_milliseconds), _TRUNCATE, "%lu", delay); + char deadline_milliseconds[16]; + _snprintf_s(deadline_milliseconds, sizeof(deadline_milliseconds), _TRUNCATE, "%lu", NSSM_SERVICE_STATUS_DEADLINE); + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_STARTUP_DELAY_TOO_LONG, service->name, delay_milliseconds, NSSM, deadline_milliseconds, 0); + delay = NSSM_SERVICE_STATUS_DEADLINE; } - pid = pi.hProcess; + unsigned long deadline = WaitForSingleObject(service->process_handle, delay); /* Signal successful start */ - service_status.dwCurrentState = SERVICE_RUNNING; - SetServiceStatus(service_handle, &service_status); + service->status.dwCurrentState = SERVICE_RUNNING; + SetServiceStatus(service->status_handle, &service->status); + + /* Continue waiting for a clean startup. */ + if (deadline == WAIT_TIMEOUT) { + if (service->throttle_delay > delay) { + if (WaitForSingleObject(service->process_handle, service->throttle_delay - delay) == WAIT_TIMEOUT) service->throttle = 0; + } + else service->throttle = 0; + } return 0; } /* Stop the service */ -int stop_service(unsigned long exitcode, bool graceful, bool default_action) { +int stop_service(nssm_service_t *service, unsigned long exitcode, bool graceful, bool default_action) { + service->allow_restart = false; + if (service->wait_handle) { + UnregisterWait(service->wait_handle); + service->wait_handle = 0; + } + 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); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_GRACEFUL_SUICIDE, service->name, service->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; - SetServiceStatus(service_handle, &service_status); + service->status.dwCurrentState = SERVICE_STOP_PENDING; + service->status.dwWaitHint = NSSM_WAITHINT_MARGIN; + SetServiceStatus(service->status_handle, &service->status); } - /* Nothing to do if server isn't running */ - if (pid) { - /* Shut down server */ - log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service_name, exe, 0); - TerminateProcess(pid, 0); - pid = 0; + /* Nothing to do if service isn't running */ + if (service->pid) { + /* Shut down service */ + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service->name, service->exe, 0); + kill_process(service, service->process_handle, service->pid, 0); } - else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0); + else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service->name, service->exe, 0); + + end_service((void *) service, true); /* Signal we stopped */ if (graceful) { - service_status.dwCurrentState = SERVICE_STOPPED; + service->status.dwCurrentState = SERVICE_STOPPED; if (exitcode) { - service_status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR; - service_status.dwServiceSpecificExitCode = exitcode; + service->status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR; + service->status.dwServiceSpecificExitCode = exitcode; } else { - service_status.dwWin32ExitCode = NO_ERROR; - service_status.dwServiceSpecificExitCode = 0; + service->status.dwWin32ExitCode = NO_ERROR; + service->status.dwServiceSpecificExitCode = 0; } - SetServiceStatus(service_handle, &service_status); + SetServiceStatus(service->status_handle, &service->status); } return exitcode; @@ -306,19 +552,49 @@ int stop_service(unsigned long exitcode, bool graceful, bool default_action) { /* Callback function triggered when the server exits */ void CALLBACK end_service(void *arg, unsigned char why) { - /* Check exit code */ - unsigned long ret = 0; - GetExitCodeProcess(pid, &ret); + nssm_service_t *service = (nssm_service_t *) arg; + if (service->stopping) return; + + service->stopping = true; + + /* Check exit code */ + unsigned long exitcode = 0; char code[16]; - _snprintf(code, sizeof(code), "%d", ret); - log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0); + GetExitCodeProcess(service->process_handle, &exitcode); + if (exitcode == STILL_ACTIVE || get_process_exit_time(service->process_handle, &service->exit_time)) GetSystemTimeAsFileTime(&service->exit_time); + CloseHandle(service->process_handle); + + service->process_handle = 0; + service->pid = 0; + + /* + Log that the service ended BEFORE logging about killing the process + tree. See below for the possible values of the why argument. + */ + if (! why) { + _snprintf_s(code, sizeof(code), _TRUNCATE, "%lu", exitcode); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, service->exe, service->name, code, 0); + } + + /* Clean up. */ + if (exitcode == STILL_ACTIVE) exitcode = 0; + kill_process_tree(service, service->pid, exitcode, service->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; + if (! service->allow_restart) return; /* What action should we take? */ int action = NSSM_EXIT_RESTART; unsigned char action_string[ACTION_LEN]; bool default_action; - if (! get_exit_action(service_name, &ret, action_string, &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; @@ -327,33 +603,154 @@ void CALLBACK end_service(void *arg, unsigned char why) { } } - pid = 0; switch (action) { /* Try to restart the service or return failure code to service manager */ case NSSM_EXIT_RESTART: - log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_RESTART, service_name, code, exit_action_strings[action], exe, 0); - while (monitor_service()) { - log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_RESTART_SERVICE_FAILED, exe, service_name, 0); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_RESTART, service->name, code, exit_action_strings[action], service->exe, 0); + while (monitor_service(service)) { + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_RESTART_SERVICE_FAILED, service->exe, service->name, 0); Sleep(30000); } break; /* Do nothing, just like srvany would */ case NSSM_EXIT_IGNORE: - log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service_name, code, exit_action_strings[action], exe, 0); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service->name, code, exit_action_strings[action], service->exe, 0); Sleep(INFINITE); break; /* 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, default_action); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service->name, code, exit_action_strings[action], 0); + stop_service(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, default_action)); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_UNCLEAN, service->name, code, exit_action_strings[action], 0); + stop_service(service, exitcode, false, default_action); + free_imports(); + exit(exitcode); break; } } + +void throttle_restart(nssm_service_t *service) { + /* This can't be a restart if the service is already running. */ + if (! service->throttle++) return; + + int ms = throttle_milliseconds(service->throttle); + + if (service->throttle > 7) service->throttle = 8; + + char threshold[8], milliseconds[8]; + _snprintf_s(threshold, sizeof(threshold), _TRUNCATE, "%lu", service->throttle_delay); + _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%lu", ms); + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service->name, threshold, milliseconds, 0); + + if (use_critical_section) EnterCriticalSection(&service->throttle_section); + else if (service->throttle_timer) { + ZeroMemory(&service->throttle_duetime, sizeof(service->throttle_duetime)); + service->throttle_duetime.QuadPart = 0 - (ms * 10000LL); + SetWaitableTimer(service->throttle_timer, &service->throttle_duetime, 0, 0, 0, 0); + } + + service->status.dwCurrentState = SERVICE_PAUSED; + SetServiceStatus(service->status_handle, &service->status); + + if (use_critical_section) { + imports.SleepConditionVariableCS(&service->throttle_condition, &service->throttle_section, ms); + LeaveCriticalSection(&service->throttle_section); + } + else { + if (service->throttle_timer) WaitForSingleObject(service->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_SERVICE_STATUS_DEADLINE milliseconds. If the process is still running + and we haven't finished waiting we increment dwCheckPoint and add whichever is + smaller of NSSM_SERVICE_STATUS_DEADLINE 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(nssm_service_t *service, char *function_name, 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_SERVICE_STATUS_DEADLINE) interval = NSSM_SERVICE_STATUS_DEADLINE; + + service->status.dwCurrentState = SERVICE_STOP_PENDING; + service->status.dwWaitHint += interval; + service->status.dwCheckPoint++; + SetServiceStatus(service->status_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(service->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; +}