#include "nssm.h"\r
\r
-SERVICE_STATUS service_status;\r
-SERVICE_STATUS_HANDLE service_handle;\r
-HANDLE process_handle;\r
-HANDLE wait_handle;\r
-unsigned long pid;\r
-static char service_name[SERVICE_NAME_LENGTH];\r
-char exe[EXE_LENGTH];\r
-char flags[CMD_LENGTH];\r
-char dir[MAX_PATH];\r
-bool stopping;\r
-CRITICAL_SECTION throttle_section;\r
-CONDITION_VARIABLE throttle_condition;\r
+bool is_admin;\r
+bool use_critical_section;\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
\r
-static unsigned long throttle;\r
-\r
-static inline int throttle_milliseconds() {\r
+static inline int throttle_milliseconds(unsigned long throttle) {\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
+/*\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((nssm_service_t *) arg, 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
if (! ret) {\r
- log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENSCMANAGER_FAILED, 0);\r
+ if (is_admin) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENSCMANAGER_FAILED, 0);\r
return 0;\r
}\r
\r
return ret;\r
}\r
\r
+/* Allocate and zero memory for a service. */\r
+nssm_service_t *alloc_nssm_service() {\r
+ nssm_service_t *service = (nssm_service_t *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(nssm_service_t));\r
+ if (! service) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service", "alloc_nssm_service()", 0);\r
+ return service;\r
+}\r
+\r
+/* Free memory for a service. */\r
+void cleanup_nssm_service(nssm_service_t *service) {\r
+ if (! service) return;\r
+ if (service->env) HeapFree(GetProcessHeap(), 0, service->env);\r
+ if (service->handle) CloseServiceHandle(service->handle);\r
+ if (service->process_handle) CloseHandle(service->process_handle);\r
+ if (service->wait_handle) UnregisterWait(service->process_handle);\r
+ if (service->throttle_section_initialised) DeleteCriticalSection(&service->throttle_section);\r
+ if (service->throttle_timer) CloseHandle(service->throttle_timer);\r
+ HeapFree(GetProcessHeap(), 0, service);\r
+}\r
+\r
/* About to install the service */\r
int pre_install_service(int argc, char **argv) {\r
- /* Show the dialogue box if we didn't give the */\r
+ /* Show the dialogue box if we didn't give the service name and path */\r
if (argc < 2) return nssm_gui(IDD_INSTALL, argv[0]);\r
\r
+ nssm_service_t *service = alloc_nssm_service();\r
+ if (! service) {\r
+ print_message(stderr, NSSM_EVENT_OUT_OF_MEMORY, "service", "pre_install_service()");\r
+ return 1;\r
+ }\r
+\r
+ memmove(service->name, argv[0], strlen(argv[0]));\r
+ memmove(service->exe, argv[1], strlen(argv[1]));\r
+\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
+ size_t i;\r
+ for (i = 2; i < argc; i++) flagslen += strlen(argv[i]) + 1;\r
+ if (! flagslen) flagslen = 1;\r
\r
- return install_service(argv[0], argv[1], flags);\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(service->flags + s, argv[i], len);\r
+ s += len;\r
+ if (i < argc - 1) service->flags[s++] = ' ';\r
+ }\r
+\r
+ /* Work out directory name */\r
+ size_t len = strlen(service->exe);\r
+ for (i = len; i && service->exe[i] != '\\' && service->exe[i] != '/'; i--);\r
+ memmove(service->dir, service->exe, i);\r
+ service->dir[i] = '\0';\r
+\r
+ int ret = install_service(service);\r
+ cleanup_nssm_service(service);\r
+ return ret;\r
}\r
\r
/* About to remove the service */\r
int pre_remove_service(int argc, char **argv) {\r
/* Show dialogue box if we didn't pass service name and "confirm" */\r
if (argc < 2) return nssm_gui(IDD_REMOVE, argv[0]);\r
- if (str_equiv(argv[1], "confirm")) return remove_service(argv[0]);\r
- fprintf(stderr, "To remove a service without confirmation: nssm remove <servicename> confirm\n");\r
+ if (str_equiv(argv[1], "confirm")) {\r
+ nssm_service_t *service = alloc_nssm_service();\r
+ memmove(service->name, argv[0], strlen(argv[0]));\r
+ int ret = remove_service(service);\r
+ cleanup_nssm_service(service);\r
+ return ret;\r
+ }\r
+ print_message(stderr, NSSM_MESSAGE_PRE_REMOVE_SERVICE);\r
return 100;\r
}\r
\r
/* Install the service */\r
-int install_service(char *name, char *exe, char *flags) {\r
+int install_service(nssm_service_t *service) {\r
+ if (! service) return 1;\r
+\r
/* Open service manager */\r
SC_HANDLE services = open_service_manager();\r
if (! services) {\r
- fprintf(stderr, "Error opening service manager!\n");\r
+ print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED);\r
+ cleanup_nssm_service(service);\r
return 2;\r
}\r
- \r
+\r
/* Get path of this program */\r
char path[MAX_PATH];\r
GetModuleFileName(0, path, MAX_PATH);\r
\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
- fprintf(stderr, "The full path to " NSSM " is too long!\n");\r
+ if (pathlen + 1 >= VALUE_LENGTH) {\r
+ print_message(stderr, NSSM_MESSAGE_PATH_TOO_LONG, NSSM);\r
return 3;\r
}\r
- if (snprintf(command, sizeof(command), "\"%s\" %s", path, NSSM_RUN) < 0) {\r
- fprintf(stderr, "Out of memory for ImagePath!\n");\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
\r
- /* Work out directory name */\r
- size_t len = strlen(exe);\r
- size_t i;\r
- for (i = len; i && exe[i] != '\\' && exe[i] != '/'; i--);\r
- char dir[MAX_PATH];\r
- memmove(dir, exe, i);\r
- dir[i] = '\0';\r
-\r
/* Create the service */\r
- 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);\r
- if (! service) {\r
- fprintf(stderr, "Error creating service!\n");\r
+ 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);\r
+ if (! service->handle) {\r
+ print_message(stderr, NSSM_MESSAGE_CREATESERVICE_FAILED);\r
CloseServiceHandle(services);\r
return 5;\r
}\r
\r
/* Now we need to put the parameters into the registry */\r
- if (create_parameters(name, exe, flags, dir)) {\r
- fprintf(stderr, "Error setting startup parameters for the service!\n");\r
- DeleteService(service);\r
+ if (create_parameters(service)) {\r
+ print_message(stderr, NSSM_MESSAGE_CREATE_PARAMETERS_FAILED);\r
+ DeleteService(service->handle);\r
CloseServiceHandle(services);\r
return 6;\r
}\r
\r
+ set_service_recovery(service);\r
+\r
+ print_message(stdout, NSSM_MESSAGE_SERVICE_INSTALLED, service->name);\r
+\r
/* Cleanup */\r
- CloseServiceHandle(service);\r
CloseServiceHandle(services);\r
\r
- printf("Service \"%s\" installed successfully!\n", name);\r
return 0;\r
}\r
\r
/* Remove the service */\r
-int remove_service(char *name) {\r
+int remove_service(nssm_service_t *service) {\r
+ if (! service) return 1;\r
+\r
/* Open service manager */\r
SC_HANDLE services = open_service_manager();\r
if (! services) {\r
- fprintf(stderr, "Error opening service manager!\n");\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
- fprintf(stderr, "Can't open service!");\r
+ service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS);\r
+ if (! service->handle) {\r
+ print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED);\r
CloseServiceHandle(services);\r
return 3;\r
}\r
\r
/* Try to delete the service */\r
- if (! DeleteService(service)) {\r
- fprintf(stderr, "Error deleting service!\n");\r
- CloseServiceHandle(service);\r
+ if (! DeleteService(service->handle)) {\r
+ print_message(stderr, NSSM_MESSAGE_DELETESERVICE_FAILED);\r
CloseServiceHandle(services);\r
return 4;\r
}\r
\r
/* Cleanup */\r
- CloseServiceHandle(service);\r
CloseServiceHandle(services);\r
\r
- printf("Service \"%s\" removed successfully!\n", name);\r
+ print_message(stdout, NSSM_MESSAGE_SERVICE_REMOVED, service->name);\r
return 0;\r
}\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
- log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service_name", "service_main()", 0);\r
+ nssm_service_t *service = alloc_nssm_service();\r
+ if (! service) return;\r
+\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
- 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 = NSSM_WAITHINT_MARGIN;\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 | SERVICE_ACCEPT_PAUSE_CONTINUE;\r
+ service->status.dwWin32ExitCode = NO_ERROR;\r
+ service->status.dwServiceSpecificExitCode = 0;\r
+ service->status.dwCheckPoint = 0;\r
+ service->status.dwWaitHint = NSSM_WAITHINT_MARGIN;\r
\r
/* Signal we AREN'T running the server */\r
- process_handle = 0;\r
- pid = 0;\r
+ service->process_handle = 0;\r
+ service->pid = 0;\r
\r
/* 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
+ service->status_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, (void *) service);\r
+ if (! service->status_handle) {\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
- SetServiceStatus(service_handle, &service_status);\r
+ service->status.dwCurrentState = SERVICE_START_PENDING;\r
+ service->status.dwWaitHint = service->throttle_delay + NSSM_WAITHINT_MARGIN;\r
+ SetServiceStatus(service->status_handle, &service->status);\r
\r
- /* Try to create the exit action parameters; we don't care if it fails */\r
- create_exit_action(argv[0], exit_action_strings[0]);\r
+ if (is_admin) {\r
+ /* Try to create the exit action parameters; we don't care if it fails */\r
+ create_exit_action(service->name, exit_action_strings[0]);\r
\r
- set_service_recovery(service_name);\r
+ SC_HANDLE services = open_service_manager();\r
+ if (services) {\r
+ service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS);\r
+ set_service_recovery(service);\r
+ CloseServiceHandle(services);\r
+ }\r
+ }\r
\r
/* Used for signalling a resume if the service pauses when throttled. */\r
- InitializeCriticalSection(&throttle_section);\r
+ if (use_critical_section) {\r
+ InitializeCriticalSection(&service->throttle_section);\r
+ service->throttle_section_initialised = true;\r
+ }\r
+ else {\r
+ service->throttle_timer = CreateWaitableTimer(0, 1, 0);\r
+ if (! service->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
+ monitor_service(service);\r
}\r
\r
/* Make sure service recovery actions are taken where necessary */\r
-void set_service_recovery(char *service_name) {\r
- SC_HANDLE services = open_service_manager();\r
- if (! services) return;\r
-\r
- SC_HANDLE service = OpenService(services, service_name, SC_MANAGER_ALL_ACCESS);\r
- if (! service) return;\r
- return;\r
-\r
+void set_service_recovery(nssm_service_t *service) {\r
SERVICE_FAILURE_ACTIONS_FLAG flag;\r
ZeroMemory(&flag, sizeof(flag));\r
flag.fFailureActionsOnNonCrashFailures = true;\r
\r
/* This functionality was added in Vista so the call may fail */\r
- ChangeServiceConfig2(service, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag);\r
+ if (! ChangeServiceConfig2(service->handle, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag)) {\r
+ unsigned long error = GetLastError();\r
+ /* Pre-Vista we expect to fail with ERROR_INVALID_LEVEL */\r
+ if (error != ERROR_INVALID_LEVEL) {\r
+ log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CHANGESERVICECONFIG2_FAILED, service->name, error_string(error), 0);\r
+ }\r
+ }\r
}\r
\r
-int monitor_service() {\r
+int monitor_service(nssm_service_t *service) {\r
/* Set service status to started */\r
- int ret = start_service();\r
+ int ret = start_service(service);\r
if (ret) {\r
char code[16];\r
- snprintf(code, sizeof(code), "%d", ret);\r
- log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0);\r
+ _snprintf_s(code, sizeof(code), _TRUNCATE, "%d", ret);\r
+ log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, service->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
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, service->exe, service->flags, service->name, service->dir, 0);\r
\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
+ /* Monitor service */\r
+ if (! RegisterWaitForSingleObject(&service->wait_handle, service->process_handle, end_service, (void *) service, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) {\r
+ log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service->name, service->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_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
+\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
+ nssm_service_t *service = (nssm_service_t *) context;\r
+\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
- stop_service(0, true, true);\r
+ log_service_control(service->name, control, 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, context, 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
+ service->kill_console_delay = NSSM_KILL_CONSOLE_GRACE_PERIOD;\r
+ service->kill_window_delay = NSSM_KILL_WINDOW_GRACE_PERIOD;\r
+ service->kill_threads_delay = NSSM_KILL_THREADS_GRACE_PERIOD;\r
+\r
+ stop_service(service, 0, true, true);\r
+ }\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
+ log_service_control(service->name, control, true);\r
+ service->throttle = 0;\r
+ if (use_critical_section) imports.WakeConditionVariable(&service->throttle_condition);\r
+ else {\r
+ if (! service->throttle_timer) return ERROR_CALL_NOT_IMPLEMENTED;\r
+ ZeroMemory(&service->throttle_duetime, sizeof(service->throttle_duetime));\r
+ SetWaitableTimer(service->throttle_timer, &service->throttle_duetime, 0, 0, 0, 0);\r
+ }\r
+ service->status.dwCurrentState = SERVICE_CONTINUE_PENDING;\r
+ service->status.dwWaitHint = throttle_milliseconds(service->throttle) + NSSM_WAITHINT_MARGIN;\r
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_RESET_THROTTLE, service->name, 0);\r
+ SetServiceStatus(service->status_handle, &service->status);\r
return NO_ERROR;\r
\r
case SERVICE_CONTROL_PAUSE:\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
+ 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
/* Start the service */\r
-int start_service() {\r
- stopping = false;\r
+int start_service(nssm_service_t *service) {\r
+ service->stopping = false;\r
+ service->allow_restart = true;\r
\r
- if (process_handle) return 0;\r
+ if (service->process_handle) return 0;\r
\r
/* Allocate a STARTUPINFO structure for a new process */\r
STARTUPINFO si;\r
PROCESS_INFORMATION pi;\r
ZeroMemory(&pi, sizeof(pi));\r
\r
+ /* Get startup parameters */\r
+ int ret = get_parameters(service, &si);\r
+ if (ret) {\r
+ log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, service->name, 0);\r
+ return stop_service(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_s(cmd, sizeof(cmd), _TRUNCATE, "\"%s\" %s", service->exe, service->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
+ close_output_handles(&si);\r
+ return stop_service(service, 2, true, true);\r
+ }\r
+\r
+ throttle_restart(service);\r
+\r
+ bool inherit_handles = false;\r
+ if (si.dwFlags & STARTF_USESTDHANDLES) inherit_handles = true;\r
+ if (! CreateProcess(0, cmd, 0, 0, inherit_handles, 0, service->env, service->dir, &si, &pi)) {\r
+ unsigned long error = GetLastError();\r
+ 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);\r
+ else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service->name, service->exe, error_string(error), 0);\r
+ close_output_handles(&si);\r
+ return stop_service(service, 3, true, true);\r
}\r
+ service->process_handle = pi.hProcess;\r
+ service->pid = pi.dwProcessId;\r
\r
- throttle_restart();\r
+ if (get_process_creation_time(service->process_handle, &service->creation_time)) ZeroMemory(&service->creation_time, sizeof(service->creation_time));\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
- return stop_service(3, true, true);\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 = service->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
- process_handle = pi.hProcess;\r
- pid = pi.dwProcessId;\r
+ unsigned long deadline = WaitForSingleObject(service->process_handle, delay);\r
\r
/* Signal successful start */\r
- service_status.dwCurrentState = SERVICE_RUNNING;\r
- SetServiceStatus(service_handle, &service_status);\r
+ service->status.dwCurrentState = SERVICE_RUNNING;\r
+ SetServiceStatus(service->status_handle, &service->status);\r
\r
- /* Wait for a clean startup. */\r
- if (WaitForSingleObject(process_handle, NSSM_RESET_THROTTLE_RESTART) == WAIT_TIMEOUT) throttle = 0;\r
+ /* Continue waiting for a clean startup. */\r
+ if (deadline == WAIT_TIMEOUT) {\r
+ if (service->throttle_delay > delay) {\r
+ if (WaitForSingleObject(service->process_handle, service->throttle_delay - delay) == WAIT_TIMEOUT) service->throttle = 0;\r
+ }\r
+ else service->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
+int stop_service(nssm_service_t *service, unsigned long exitcode, bool graceful, bool default_action) {\r
+ service->allow_restart = false;\r
+ if (service->wait_handle) {\r
+ UnregisterWait(service->wait_handle);\r
+ service->wait_handle = 0;\r
+ }\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
+ 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);\r
graceful = true;\r
}\r
\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
- SetServiceStatus(service_handle, &service_status);\r
+ service->status.dwCurrentState = SERVICE_STOP_PENDING;\r
+ service->status.dwWaitHint = NSSM_WAITHINT_MARGIN;\r
+ SetServiceStatus(service->status_handle, &service->status);\r
}\r
\r
- /* Nothing to do if server isn't running */\r
- if (pid) {\r
- /* Shut down server */\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
+ /* Nothing to do if service isn't running */\r
+ if (service->pid) {\r
+ /* Shut down service */\r
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service->name, service->exe, 0);\r
+ kill_process(service, service->process_handle, service->pid, 0);\r
}\r
- else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0);\r
+ else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service->name, service->exe, 0);\r
\r
- end_service((void *) pid, true);\r
+ end_service((void *) service, true);\r
\r
/* Signal we stopped */\r
if (graceful) {\r
- service_status.dwCurrentState = SERVICE_STOPPED;\r
+ service->status.dwCurrentState = SERVICE_STOPPED;\r
if (exitcode) {\r
- service_status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR;\r
- service_status.dwServiceSpecificExitCode = exitcode;\r
+ service->status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR;\r
+ service->status.dwServiceSpecificExitCode = exitcode;\r
}\r
else {\r
- service_status.dwWin32ExitCode = NO_ERROR;\r
- service_status.dwServiceSpecificExitCode = 0;\r
+ service->status.dwWin32ExitCode = NO_ERROR;\r
+ service->status.dwServiceSpecificExitCode = 0;\r
}\r
- SetServiceStatus(service_handle, &service_status);\r
+ SetServiceStatus(service->status_handle, &service->status);\r
}\r
\r
return exitcode;\r
\r
/* Callback function triggered when the server exits */\r
void CALLBACK end_service(void *arg, unsigned char why) {\r
- if (stopping) return;\r
+ nssm_service_t *service = (nssm_service_t *) arg;\r
\r
- stopping = true;\r
+ if (service->stopping) return;\r
\r
- pid = (unsigned long) arg;\r
+ service->stopping = true;\r
\r
/* Check exit code */\r
unsigned long exitcode = 0;\r
- GetExitCodeProcess(process_handle, &exitcode);\r
+ char code[16];\r
+ GetExitCodeProcess(service->process_handle, &exitcode);\r
+ if (exitcode == STILL_ACTIVE || get_process_exit_time(service->process_handle, &service->exit_time)) GetSystemTimeAsFileTime(&service->exit_time);\r
+ CloseHandle(service->process_handle);\r
+\r
+ service->process_handle = 0;\r
+ service->pid = 0;\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_s(code, sizeof(code), _TRUNCATE, "%lu", exitcode);\r
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, 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, service->pid, exitcode, service->pid);\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
-\r
- char code[16];\r
- _snprintf(code, sizeof(code), "%d", exitcode);\r
- log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0);\r
+ if (! service->allow_restart) return;\r
\r
/* What action should we take? */\r
int action = NSSM_EXIT_RESTART;\r
unsigned char action_string[ACTION_LEN];\r
bool default_action;\r
- if (! get_exit_action(service_name, &exitcode, action_string, &default_action)) {\r
+ if (! get_exit_action(service->name, &exitcode, action_string, &default_action)) {\r
for (int i = 0; exit_action_strings[i]; i++) {\r
if (! _strnicmp((const char *) action_string, exit_action_strings[i], ACTION_LEN)) {\r
action = i;\r
}\r
}\r
\r
- process_handle = 0;\r
- pid = 0;\r
switch (action) {\r
/* Try to restart the service or return failure code to service manager */\r
case NSSM_EXIT_RESTART:\r
- log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_RESTART, service_name, code, exit_action_strings[action], exe, 0);\r
- while (monitor_service()) {\r
- log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_RESTART_SERVICE_FAILED, exe, service_name, 0);\r
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_RESTART, service->name, code, exit_action_strings[action], service->exe, 0);\r
+ while (monitor_service(service)) {\r
+ log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_RESTART_SERVICE_FAILED, service->exe, service->name, 0);\r
Sleep(30000);\r
}\r
break;\r
\r
/* Do nothing, just like srvany would */\r
case NSSM_EXIT_IGNORE:\r
- log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service_name, code, exit_action_strings[action], exe, 0);\r
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service->name, code, exit_action_strings[action], service->exe, 0);\r
Sleep(INFINITE);\r
break;\r
\r
/* Tell the service manager we are finished */\r
case NSSM_EXIT_REALLY:\r
- log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service_name, code, exit_action_strings[action], 0);\r
- stop_service(exitcode, true, default_action);\r
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service->name, code, exit_action_strings[action], 0);\r
+ stop_service(service, exitcode, true, default_action);\r
break;\r
\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
+ log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_UNCLEAN, service->name, code, exit_action_strings[action], 0);\r
+ stop_service(service, exitcode, false, default_action);\r
+ free_imports();\r
+ exit(exitcode);\r
break;\r
}\r
}\r
\r
-void throttle_restart() {\r
+void throttle_restart(nssm_service_t *service) {\r
/* This can't be a restart if the service is already running. */\r
- if (! throttle++) return;\r
+ if (! service->throttle++) return;\r
\r
- int ms = throttle_milliseconds();\r
+ int ms = throttle_milliseconds(service->throttle);\r
\r
- if (throttle > 7) throttle = 8;\r
+ if (service->throttle > 7) service->throttle = 8;\r
\r
char threshold[8], milliseconds[8];\r
- _snprintf(threshold, sizeof(threshold), "%d", NSSM_RESET_THROTTLE_RESTART);\r
- _snprintf(milliseconds, sizeof(milliseconds), "%d", ms);\r
- log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service_name, threshold, milliseconds, 0);\r
+ _snprintf_s(threshold, sizeof(threshold), _TRUNCATE, "%lu", service->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 (use_critical_section) EnterCriticalSection(&service->throttle_section);\r
+ else if (service->throttle_timer) {\r
+ ZeroMemory(&service->throttle_duetime, sizeof(service->throttle_duetime));\r
+ service->throttle_duetime.QuadPart = 0 - (ms * 10000LL);\r
+ SetWaitableTimer(service->throttle_timer, &service->throttle_duetime, 0, 0, 0, 0);\r
+ }\r
+\r
+ service->status.dwCurrentState = SERVICE_PAUSED;\r
+ SetServiceStatus(service->status_handle, &service->status);\r
+\r
+ if (use_critical_section) {\r
+ imports.SleepConditionVariableCS(&service->throttle_condition, &service->throttle_section, ms);\r
+ LeaveCriticalSection(&service->throttle_section);\r
+ }\r
+ else {\r
+ if (service->throttle_timer) WaitForSingleObject(service->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(nssm_service_t *service, char *function_name, 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->status_handle, &service->status);\r
\r
- EnterCriticalSection(&throttle_section);\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(service->process_handle, interval)) {\r
+ case WAIT_OBJECT_0:\r
+ ret = 0;\r
+ goto awaited;\r
\r
- service_status.dwCurrentState = SERVICE_PAUSED;\r
- SetServiceStatus(service_handle, &service_status);\r
+ case WAIT_TIMEOUT:\r
+ ret = 1;\r
+ break;\r
\r
- SleepConditionVariableCS(&throttle_condition, &throttle_section, ms);\r
+ default:\r
+ ret = -1;\r
+ goto awaited;\r
+ }\r
\r
- LeaveCriticalSection(&throttle_section);\r
+ waited += interval;\r
+ }\r
+\r
+awaited:\r
+ if (func) HeapFree(GetProcessHeap(), 0, func);\r
+\r
+ return ret;\r
}\r
git://git.iain.cx/iain / nssm.git / blobdiff