char flags[CMD_LENGTH];\r
char dir[MAX_PATH];\r
bool stopping;\r
+bool allow_restart;\r
unsigned long throttle_delay;\r
+unsigned long stop_method;\r
+unsigned long kill_console_delay;\r
+unsigned long kill_window_delay;\r
+unsigned long kill_threads_delay;\r
+CRITICAL_SECTION throttle_section;\r
+CONDITION_VARIABLE throttle_condition;\r
HANDLE throttle_timer;\r
LARGE_INTEGER throttle_duetime;\r
+bool use_critical_section;\r
+FILETIME creation_time;\r
+\r
+extern imports_t imports;\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
return ret * 1000;\r
}\r
\r
+/*\r
+ Wrapper to be called in a new thread so that we can acknowledge a STOP\r
+ control immediately.\r
+*/\r
+static unsigned long WINAPI shutdown_service(void *arg) {\r
+ return stop_service(0, true, true);\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
print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED);\r
return 2;\r
}\r
- \r
+\r
/* Get path of this program */\r
char path[MAX_PATH];\r
GetModuleFileName(0, path, MAX_PATH);\r
print_message(stderr, NSSM_MESSAGE_PATH_TOO_LONG, NSSM);\r
return 3;\r
}\r
- if (_snprintf(command, sizeof(command), "\"%s\"", path) < 0) {\r
+ if (_snprintf_s(command, sizeof(command), _TRUNCATE, "\"%s\"", path) < 0) {\r
print_message(stderr, NSSM_MESSAGE_OUT_OF_MEMORY_FOR_IMAGEPATH);\r
return 4;\r
}\r
print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED);\r
return 2;\r
}\r
- \r
+\r
/* Try to open the service */\r
SC_HANDLE service = OpenService(services, name, SC_MANAGER_ALL_ACCESS);\r
if (! service) {\r
\r
/* Service initialisation */\r
void WINAPI service_main(unsigned long argc, char **argv) {\r
- if (_snprintf(service_name, sizeof(service_name), "%s", argv[0]) < 0) {\r
+ if (_snprintf_s(service_name, sizeof(service_name), _TRUNCATE, "%s", argv[0]) < 0) {\r
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service_name", "service_main()", 0);\r
return;\r
}\r
\r
+ /* We can use a condition variable in a critical section on Vista or later. */\r
+ if (imports.SleepConditionVariableCS && imports.WakeConditionVariable) use_critical_section = true;\r
+ else use_critical_section = false;\r
+\r
/* Initialise status */\r
ZeroMemory(&service_status, sizeof(service_status));\r
service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS | SERVICE_INTERACTIVE_PROCESS;\r
}\r
\r
/* Used for signalling a resume if the service pauses when throttled. */\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
+ if (use_critical_section) InitializeCriticalSection(&throttle_section);\r
+ else {\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
\r
monitor_service();\r
int ret = start_service();\r
if (ret) {\r
char code[16];\r
- _snprintf(code, sizeof(code), "%d", ret);\r
+ _snprintf_s(code, sizeof(code), _TRUNCATE, "%d", ret);\r
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0);\r
return ret;\r
}\r
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, exe, flags, service_name, dir, 0);\r
\r
- /* Monitor service service */\r
+ /* Monitor 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, error_string(GetLastError()), 0);\r
}\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
+ 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
+ if (_snprintf_s(text, 11, _TRUNCATE, "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
/* 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_INTERROGATE:\r
+ /* We always keep the service status up-to-date so this is a no-op. */\r
+ return NO_ERROR;\r
+\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
+ /*\r
+ We MUST acknowledge the stop request promptly but we're committed to\r
+ waiting for the application to exit. Spawn a new thread to wait\r
+ while we acknowledge the request.\r
+ */\r
+ if (! CreateThread(NULL, 0, shutdown_service, (void *) service_name, 0, NULL)) {\r
+ log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATETHREAD_FAILED, error_string(GetLastError()), 0);\r
+\r
+ /*\r
+ We couldn't create a thread to tidy up so we'll have to force the tidyup\r
+ to complete in time in this thread.\r
+ */\r
+ kill_console_delay = NSSM_KILL_CONSOLE_GRACE_PERIOD;\r
+ kill_window_delay = NSSM_KILL_WINDOW_GRACE_PERIOD;\r
+ kill_threads_delay = NSSM_KILL_THREADS_GRACE_PERIOD;\r
+\r
+ stop_service(0, true, true);\r
+ }\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
- ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));\r
- SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);\r
+ if (use_critical_section) imports.WakeConditionVariable(&throttle_condition);\r
+ else {\r
+ if (! throttle_timer) return ERROR_CALL_NOT_IMPLEMENTED;\r
+ ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));\r
+ SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 0);\r
+ }\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
/* Start the service */\r
int start_service() {\r
stopping = false;\r
+ allow_restart = true;\r
\r
if (process_handle) return 0;\r
\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
+ 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);\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
/* Launch executable with arguments */\r
char cmd[CMD_LENGTH];\r
- if (_snprintf(cmd, sizeof(cmd), "\"%s\" %s", exe, flags) < 0) {\r
+ if (_snprintf_s(cmd, sizeof(cmd), _TRUNCATE, "\"%s\" %s", exe, flags) < 0) {\r
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "start_service", 0);\r
+ close_output_handles(&si);\r
return stop_service(2, true, true);\r
}\r
\r
throttle_restart();\r
\r
- if (! CreateProcess(0, cmd, 0, 0, false, 0, env, dir, &si, &pi)) {\r
+ bool inherit_handles = false;\r
+ if (si.dwFlags & STARTF_USESTDHANDLES) inherit_handles = true;\r
+ if (! CreateProcess(0, cmd, 0, 0, inherit_handles, 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
+ close_output_handles(&si);\r
return stop_service(3, true, true);\r
}\r
process_handle = pi.hProcess;\r
pid = pi.dwProcessId;\r
\r
+ if (get_process_creation_time(process_handle, &creation_time)) ZeroMemory(&creation_time, sizeof(creation_time));\r
+\r
+ close_output_handles(&si);\r
+\r
+ /*\r
+ Wait for a clean startup before changing the service status to RUNNING\r
+ but be mindful of the fact that we are blocking the service control manager\r
+ so abandon the wait before too much time has elapsed.\r
+ */\r
+ unsigned long delay = throttle_delay;\r
+ if (delay > NSSM_SERVICE_STATUS_DEADLINE) {\r
+ char delay_milliseconds[16];\r
+ _snprintf_s(delay_milliseconds, sizeof(delay_milliseconds), _TRUNCATE, "%lu", delay);\r
+ char deadline_milliseconds[16];\r
+ _snprintf_s(deadline_milliseconds, sizeof(deadline_milliseconds), _TRUNCATE, "%lu", NSSM_SERVICE_STATUS_DEADLINE);\r
+ log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_STARTUP_DELAY_TOO_LONG, service_name, delay_milliseconds, NSSM, deadline_milliseconds, 0);\r
+ delay = NSSM_SERVICE_STATUS_DEADLINE;\r
+ }\r
+ unsigned long deadline = WaitForSingleObject(process_handle, delay);\r
+\r
/* Signal successful start */\r
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
+ /* Continue waiting for a clean startup. */\r
+ if (deadline == WAIT_TIMEOUT) {\r
+ if (throttle_delay > delay) {\r
+ if (WaitForSingleObject(process_handle, throttle_delay - delay) == WAIT_TIMEOUT) throttle = 0;\r
+ }\r
+ else throttle = 0;\r
+ }\r
\r
return 0;\r
}\r
\r
/* Stop the service */\r
int stop_service(unsigned long exitcode, bool graceful, bool default_action) {\r
+ allow_restart = false;\r
+ if (wait_handle) UnregisterWait(wait_handle);\r
+\r
if (default_action && ! exitcode && ! graceful) {\r
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);\r
graceful = true;\r
/* 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
+ service_status.dwWaitHint = NSSM_WAITHINT_MARGIN;\r
SetServiceStatus(service_handle, &service_status);\r
}\r
\r
- /* Nothing to do if server isn't running */\r
+ /* Nothing to do if service isn't running */\r
if (pid) {\r
- /* Shut down server */\r
+ /* Shut down service */\r
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service_name, exe, 0);\r
- kill_process(service_name, process_handle, pid, 0);\r
- process_handle = 0;\r
+ kill_process(service_name, service_handle, &service_status, stop_method, process_handle, pid, 0);\r
}\r
else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0);\r
\r
/* Check exit code */\r
unsigned long exitcode = 0;\r
char code[16];\r
+ FILETIME exit_time;\r
GetExitCodeProcess(process_handle, &exitcode);\r
+ if (exitcode == STILL_ACTIVE || get_process_exit_time(process_handle, &exit_time)) GetSystemTimeAsFileTime(&exit_time);\r
+ CloseHandle(process_handle);\r
\r
/*\r
Log that the service ended BEFORE logging about killing the process\r
tree. See below for the possible values of the why argument.\r
*/\r
if (! why) {\r
- _snprintf(code, sizeof(code), "%d", exitcode);\r
+ _snprintf_s(code, sizeof(code), _TRUNCATE, "%lu", exitcode);\r
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0);\r
}\r
\r
/* Clean up. */\r
- kill_process_tree(service_name, pid, exitcode, pid);\r
+ if (exitcode == STILL_ACTIVE) exitcode = 0;\r
+ kill_process_tree(service_name, service_handle, &service_status, stop_method, pid, exitcode, pid, &creation_time, &exit_time);\r
\r
/*\r
The why argument is true if our wait timed out or false otherwise.\r
this is a controlled shutdown, and don't take any restart action.\r
*/\r
if (why) return;\r
+ if (! allow_restart) return;\r
\r
/* What action should we take? */\r
int action = NSSM_EXIT_RESTART;\r
/* Fake a crash so pre-Vista service managers will run recovery actions. */\r
case NSSM_EXIT_UNCLEAN:\r
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_UNCLEAN, service_name, code, exit_action_strings[action], 0);\r
- exit(stop_service(exitcode, false, default_action));\r
+ stop_service(exitcode, false, default_action);\r
+ free_imports();\r
+ exit(exitcode);\r
break;\r
}\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
+ _snprintf_s(threshold, sizeof(threshold), _TRUNCATE, "%lu", throttle_delay);\r
+ _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%lu", ms);\r
log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service_name, threshold, milliseconds, 0);\r
\r
- if (throttle_timer) {\r
+ if (use_critical_section) EnterCriticalSection(&throttle_section);\r
+ else 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
service_status.dwCurrentState = SERVICE_PAUSED;\r
SetServiceStatus(service_handle, &service_status);\r
\r
- if (throttle_timer) WaitForSingleObject(throttle_timer, INFINITE);\r
- else Sleep(ms);\r
+ if (use_critical_section) {\r
+ imports.SleepConditionVariableCS(&throttle_condition, &throttle_section, ms);\r
+ LeaveCriticalSection(&throttle_section);\r
+ }\r
+ else {\r
+ if (throttle_timer) WaitForSingleObject(throttle_timer, INFINITE);\r
+ else Sleep(ms);\r
+ }\r
+}\r
+\r
+/*\r
+ When responding to a stop (or any other) request we need to set dwWaitHint to\r
+ the number of milliseconds we expect the operation to take, and optionally\r
+ increase dwCheckPoint. If dwWaitHint milliseconds elapses without the\r
+ operation completing or dwCheckPoint increasing, the system will consider the\r
+ service to be hung.\r
+\r
+ However the system will consider the service to be hung after 30000\r
+ milliseconds regardless of the value of dwWaitHint if dwCheckPoint has not\r
+ changed. Therefore if we want to wait longer than that we must periodically\r
+ increase dwCheckPoint.\r
+\r
+ Furthermore, it will consider the service to be hung after 60000 milliseconds\r
+ regardless of the value of dwCheckPoint unless dwWaitHint is increased every\r
+ time dwCheckPoint is also increased.\r
+\r
+ Our strategy then is to retrieve the initial dwWaitHint and wait for\r
+ NSSM_SERVICE_STATUS_DEADLINE milliseconds. If the process is still running\r
+ and we haven't finished waiting we increment dwCheckPoint and add whichever is\r
+ smaller of NSSM_SERVICE_STATUS_DEADLINE or the remaining timeout to\r
+ dwWaitHint.\r
+\r
+ Only doing both these things will prevent the system from killing the service.\r
+\r
+ Returns: 1 if the wait timed out.\r
+ 0 if the wait completed.\r
+ -1 on error.\r
+*/\r
+int await_shutdown(char *function_name, char *service_name, SERVICE_STATUS_HANDLE service_handle, SERVICE_STATUS *service_status, HANDLE process_handle, unsigned long timeout) {\r
+ unsigned long interval;\r
+ unsigned long waithint;\r
+ unsigned long ret;\r
+ unsigned long waited;\r
+ char interval_milliseconds[16];\r
+ char timeout_milliseconds[16];\r
+ char waited_milliseconds[16];\r
+ char *function = function_name;\r
+\r
+ /* Add brackets to function name. */\r
+ size_t funclen = strlen(function_name) + 3;\r
+ char *func = (char *) HeapAlloc(GetProcessHeap(), 0, funclen);\r
+ if (func) {\r
+ if (_snprintf_s(func, funclen, _TRUNCATE, "%s()", function_name) > -1) function = func;\r
+ }\r
+\r
+ _snprintf_s(timeout_milliseconds, sizeof(timeout_milliseconds), _TRUNCATE, "%lu", timeout);\r
+\r
+ waithint = service_status->dwWaitHint;\r
+ waited = 0;\r
+ while (waited < timeout) {\r
+ interval = timeout - waited;\r
+ if (interval > NSSM_SERVICE_STATUS_DEADLINE) interval = NSSM_SERVICE_STATUS_DEADLINE;\r
+\r
+ service_status->dwCurrentState = SERVICE_STOP_PENDING;\r
+ service_status->dwWaitHint += interval;\r
+ service_status->dwCheckPoint++;\r
+ SetServiceStatus(service_handle, service_status);\r
+\r
+ if (waited) {\r
+ _snprintf_s(waited_milliseconds, sizeof(waited_milliseconds), _TRUNCATE, "%lu", waited);\r
+ _snprintf_s(interval_milliseconds, sizeof(interval_milliseconds), _TRUNCATE, "%lu", interval);\r
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_AWAITING_SHUTDOWN, function, service_name, waited_milliseconds, interval_milliseconds, timeout_milliseconds, 0);\r
+ }\r
+\r
+ switch (WaitForSingleObject(process_handle, interval)) {\r
+ case WAIT_OBJECT_0:\r
+ ret = 0;\r
+ goto awaited;\r
+\r
+ case WAIT_TIMEOUT:\r
+ ret = 1;\r
+ break;\r
+\r
+ default:\r
+ ret = -1;\r
+ goto awaited;\r
+ }\r
+\r
+ waited += interval;\r
+ }\r
+\r
+awaited:\r
+ if (func) HeapFree(GetProcessHeap(), 0, func);\r
+\r
+ return ret;\r
}\r