Mirrors
/
nssm
mirror of http://git.nssm.cc/nssm/nssm.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a02019297d'
${ noResults }
nssm/service.cpp

788 lines
30 KiB
C++
Raw Normal View History Unescape Escape

NSSM 1.0.
22 years ago
#include "nssm.h"
Handle running without administrator privileges. If the service is configured to run as an unprivileged user NSSM will not be able to perform certain tasks which are not critical and will therefore log some errors which can be ignored. It will not be able to register itself as an event log source. It will not be able to create a default AppExit key. It will not be able to configure service failure handling. Try to perform these tasks where first installing the service (which we are guaranteed to do with administrator rights) as well as at runtime, and don't log the errors if the runtime actions can't be performed.
13 years ago
bool is_admin;
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
bool use_critical_section;
NSSM 1.0.
22 years ago
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
extern imports_t imports;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
const TCHAR *exit_action_strings[] = { _T("Restart"), _T("Ignore"), _T("Exit"), _T("Suicide"), 0 };
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
static inline int throttle_milliseconds(unsigned long throttle) {
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
/* pow() operates on doubles. */
int ret = 1; for (unsigned long i = 1; i < throttle; i++) ret *= 2;
return ret * 1000;
}
Spawn a separate thread for stop_service(). We must acknowledge a STOP or SHUTDOWN control promptly but the termination of the application may take a significant amount of time if one of the AppStopMethod* registry values is set. We now spawn a separate thread to try to stop the process and to call await_shutdown() while the main thread immediately acknowledges receipt of the STOP request. Once the worker thread has updated the service status to say that application is really stopped we will be automatically cleaned up by the system. If for some reason we can't spawn a new thread we log an error and ignore user-supplied timeouts so as to ensure we tidy up promptly.
11 years ago
/*
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) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
return stop_service((nssm_service_t *) arg, 0, true, true);
Spawn a separate thread for stop_service(). We must acknowledge a STOP or SHUTDOWN control promptly but the termination of the application may take a significant amount of time if one of the AppStopMethod* registry values is set. We now spawn a separate thread to try to stop the process and to call await_shutdown() while the main thread immediately acknowledges receipt of the STOP request. Once the worker thread has updated the service status to say that application is really stopped we will be automatically cleaned up by the system. If for some reason we can't spawn a new thread we log an error and ignore user-supplied timeouts so as to ensure we tidy up promptly.
11 years ago
}
NSSM 1.0.
22 years ago
/* Connect to the service manager */
SC_HANDLE open_service_manager() {
SC_HANDLE ret = OpenSCManager(0, SERVICES_ACTIVE_DATABASE, SC_MANAGER_ALL_ACCESS);
if (! ret) {
Handle running without administrator privileges. If the service is configured to run as an unprivileged user NSSM will not be able to perform certain tasks which are not critical and will therefore log some errors which can be ignored. It will not be able to register itself as an event log source. It will not be able to create a default AppExit key. It will not be able to configure service failure handling. Try to perform these tasks where first installing the service (which we are guaranteed to do with administrator rights) as well as at runtime, and don't log the errors if the runtime actions can't be performed.
13 years ago
if (is_admin) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENSCMANAGER_FAILED, 0);
NSSM 1.0.
22 years ago
return 0;
}
return ret;
}
Fixed bug when installing from the command line. We forgot to set default values when installing from the command line. Installing from the GUI worked. Thanks Paul Spause.
11 years ago
/* 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;
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
/* 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));
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (! service) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("service"), _T("alloc_nssm_service()"), 0);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
Allow appending to the service environment. The new registry value AppEnvironmentExtra allows defining a list of environment variables which will be appended to the environment, as opposed to those defined by the srvany-compatible AppEnvironment, which replaces the environment. Though it would serve no useful purpose beyond verifying whether or not I went to the effort of writing a code path for it, it is possible to define bother lists and have them behave intuitively.
11 years ago
if (service->env_extra) HeapFree(GetProcessHeap(), 0, service->env_extra);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
}
NSSM 2.0.
19 years ago
/* About to install the service */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
int pre_install_service(int argc, TCHAR **argv) {
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
/* Show the dialogue box if we didn't give the service name and path */
NSSM 2.0.
19 years ago
if (argc < 2) return nssm_gui(IDD_INSTALL, argv[0]);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
nssm_service_t *service = alloc_nssm_service();
if (! service) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
print_message(stderr, NSSM_EVENT_OUT_OF_MEMORY, _T("service"), _T("pre_install_service()"));
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
return 1;
}
Fixed bug when installing from the command line. We forgot to set default values when installing from the command line. Installing from the GUI worked. Thanks Paul Spause.
11 years ago
set_nssm_service_defaults(service);
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
_sntprintf_s(service->name, _countof(service->name), _TRUNCATE, _T("%s"), argv[0]);
_sntprintf_s(service->exe, _countof(service->exe), _TRUNCATE, _T("%s"), argv[1]);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
NSSM 2.0.
19 years ago
/* Arguments are optional */
Fixed arguments when installing a service. Only the first flag supplied on the command line was being added to the registry.
14 years ago
size_t flagslen = 0;
size_t s = 0;
Compiler food. Make strip_basename() non-static so it can be used elsewhere, particularly in cases where int and size_t are different sizes, ie on 32-bit builds.
11 years ago
int i;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
for (i = 2; i < argc; i++) flagslen += _tcslen(argv[i]) + 1;
Fixed arguments when installing a service. Only the first flag supplied on the command line was being added to the registry.
14 years ago
if (! flagslen) flagslen = 1;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (flagslen > _countof(service->flags)) {
print_message(stderr, NSSM_MESSAGE_FLAGS_TOO_LONG);
return 2;
}
Fixed arguments when installing a service. Only the first flag supplied on the command line was being added to the registry.
14 years ago
for (i = 2; i < argc; i++) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
size_t len = _tcslen(argv[i]);
memmove(service->flags + s, argv[i], len * sizeof(TCHAR));
Fixed arguments when installing a service. Only the first flag supplied on the command line was being added to the registry.
14 years ago
s += len;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (i < argc - 1) service->flags[s++] = _T(' ');
Fixed arguments when installing a service. Only the first flag supplied on the command line was being added to the registry.
14 years ago
}
NSSM 2.0.
19 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
/* Work out directory name */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
_sntprintf_s(service->dir, _countof(service->dir), _TRUNCATE, _T("%s"), service->exe);
Compiler food. Make strip_basename() non-static so it can be used elsewhere, particularly in cases where int and size_t are different sizes, ie on 32-bit builds.
11 years ago
strip_basename(service->dir);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int ret = install_service(service);
cleanup_nssm_service(service);
return ret;
NSSM 2.0.
19 years ago
}
/* About to remove the service */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
int pre_remove_service(int argc, TCHAR **argv) {
NSSM 2.0.
19 years ago
/* Show dialogue box if we didn't pass service name and "confirm" */
if (argc < 2) return nssm_gui(IDD_REMOVE, argv[0]);
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (str_equiv(argv[1], _T("confirm"))) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
nssm_service_t *service = alloc_nssm_service();
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
_sntprintf_s(service->name, _countof(service->name), _TRUNCATE, _T("%s"), argv[0]);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int ret = remove_service(service);
cleanup_nssm_service(service);
return ret;
}
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
print_message(stderr, NSSM_MESSAGE_PRE_REMOVE_SERVICE);
NSSM 2.0.
19 years ago
return 100;
}
NSSM 1.0.
22 years ago
/* Install the service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int install_service(nssm_service_t *service) {
if (! service) return 1;
NSSM 2.0.
19 years ago
/* Open service manager */
SC_HANDLE services = open_service_manager();
if (! services) {
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
cleanup_nssm_service(service);
NSSM 2.0.
19 years ago
return 2;
}
Fixed crash when stopping the service. NSSM tidies up by looking for processes whose parent PID matches the PID of the monitored application. Because process IDs are reused, however, it's possible for NSSM to kill a process which was not a child of the monitored application if that process had a now-exited parent process whose PID was reused. On UNIX the PPID would show as 1 for an orphaned process but under Windows, at least when querying a process with the Toolhelp32 toolkit, we see the original PPID of the process even if the parent is no longer running. Thus it is not sufficient to compare parent PIDs when checking if a process was launched by our application. In the worst case scenario NSSM could even terminate itself and trigger a bluescreen. When we find process with matching PPID we now also check that it was created after our application was created and before our application exited.
12 years ago
NSSM 2.0.
19 years ago
/* Get path of this program */
Be less paranoid. We were checking that the path to our executable was within MAX_PATH but it must be by definition and we have been safely skipping the check elsewhere.
11 years ago
TCHAR command[MAX_PATH];
GetModuleFileName(0, command, _countof(command));
NSSM 2.0.
19 years ago
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
/* Startup type. */
unsigned long startup;
switch (service->startup) {
case NSSM_STARTUP_MANUAL: startup = SERVICE_DEMAND_START; break;
case NSSM_STARTUP_DISABLED: startup = SERVICE_DISABLED; break;
default: startup = SERVICE_AUTO_START;
}
/* Display name. */
if (! service->displayname[0]) _sntprintf_s(service->displayname, _countof(service->displayname), _TRUNCATE, _T("%s"), service->name);
NSSM 2.0.
19 years ago
/* Create the service */
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
service->handle = CreateService(services, service->name, service->displayname, SC_MANAGER_ALL_ACCESS, SERVICE_WIN32_OWN_PROCESS, startup, SERVICE_ERROR_NORMAL, command, 0, 0, 0, 0, 0);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (! service->handle) {
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
print_message(stderr, NSSM_MESSAGE_CREATESERVICE_FAILED);
NSSM 2.0.
19 years ago
CloseServiceHandle(services);
return 5;
}
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
if (service->description[0]) {
SERVICE_DESCRIPTION description;
ZeroMemory(&description, sizeof(description));
description.lpDescription = service->description;
if (! ChangeServiceConfig2(service->handle, SERVICE_CONFIG_DESCRIPTION, &description)) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SERVICE_CONFIG_DESCRIPTION_FAILED, service->name, error_string(GetLastError()), 0);
}
}
if (service->startup == NSSM_STARTUP_DELAYED) {
SERVICE_DELAYED_AUTO_START_INFO delayed;
ZeroMemory(&delayed, sizeof(delayed));
delayed.fDelayedAutostart = 1;
/* Delayed startup isn't supported until Vista. */
if (! ChangeServiceConfig2(service->handle, SERVICE_CONFIG_DELAYED_AUTO_START_INFO, &delayed)) {
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_SERVICE_CONFIG_DELAYED_AUTO_START_INFO_FAILED, service->name, error_string(error), 0);
}
}
}
NSSM 2.0.
19 years ago
/* Now we need to put the parameters into the registry */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (create_parameters(service)) {
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
print_message(stderr, NSSM_MESSAGE_CREATE_PARAMETERS_FAILED);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
DeleteService(service->handle);
NSSM 2.0.
19 years ago
CloseServiceHandle(services);
return 6;
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
set_service_recovery(service);
print_message(stdout, NSSM_MESSAGE_SERVICE_INSTALLED, service->name);
Handle running without administrator privileges. If the service is configured to run as an unprivileged user NSSM will not be able to perform certain tasks which are not critical and will therefore log some errors which can be ignored. It will not be able to register itself as an event log source. It will not be able to create a default AppExit key. It will not be able to configure service failure handling. Try to perform these tasks where first installing the service (which we are guaranteed to do with administrator rights) as well as at runtime, and don't log the errors if the runtime actions can't be performed.
13 years ago
NSSM 2.0.
19 years ago
/* Cleanup */
CloseServiceHandle(services);
return 0;
NSSM 1.0.
22 years ago
}
/* Remove the service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int remove_service(nssm_service_t *service) {
if (! service) return 1;
NSSM 2.0.
19 years ago
/* Open service manager */
SC_HANDLE services = open_service_manager();
if (! services) {
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
print_message(stderr, NSSM_MESSAGE_OPEN_SERVICE_MANAGER_FAILED);
NSSM 2.0.
19 years ago
return 2;
}
Fixed crash when stopping the service. NSSM tidies up by looking for processes whose parent PID matches the PID of the monitored application. Because process IDs are reused, however, it's possible for NSSM to kill a process which was not a child of the monitored application if that process had a now-exited parent process whose PID was reused. On UNIX the PPID would show as 1 for an orphaned process but under Windows, at least when querying a process with the Toolhelp32 toolkit, we see the original PPID of the process even if the parent is no longer running. Thus it is not sufficient to compare parent PIDs when checking if a process was launched by our application. In the worst case scenario NSSM could even terminate itself and trigger a bluescreen. When we find process with matching PPID we now also check that it was created after our application was created and before our application exited.
12 years ago
NSSM 2.0.
19 years ago
/* Try to open the service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS);
if (! service->handle) {
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
print_message(stderr, NSSM_MESSAGE_OPENSERVICE_FAILED);
NSSM 2.0.
19 years ago
CloseServiceHandle(services);
return 3;
}
/* Try to delete the service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (! DeleteService(service->handle)) {
Localised (almost) all messages. Use FormatMessage() to localise messages printed to the console or shown in MessageBoxes. The new messages are allocated IDs starting at 501 so as not to clash with event log messages starting at 1001. Once again French translations were provided by François-Régis Tardy.
13 years ago
print_message(stderr, NSSM_MESSAGE_DELETESERVICE_FAILED);
NSSM 2.0.
19 years ago
CloseServiceHandle(services);
return 4;
}
/* Cleanup */
CloseServiceHandle(services);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
print_message(stdout, NSSM_MESSAGE_SERVICE_REMOVED, service->name);
NSSM 2.0.
19 years ago
return 0;
NSSM 1.0.
22 years ago
}
/* Service initialisation */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
void WINAPI service_main(unsigned long argc, TCHAR **argv) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
nssm_service_t *service = alloc_nssm_service();
if (! service) return;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (_sntprintf_s(service->name, _countof(service->name), _TRUNCATE, _T("%s"), argv[0]) < 0) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("service->name"), _T("service_main()"), 0);
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
return;
}
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
/* 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;
NSSM 1.0.
22 years ago
/* Initialise status */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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;
NSSM 1.0.
22 years ago
/* Signal we AREN'T running the server */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->process_handle = 0;
service->pid = 0;
NSSM 1.0.
22 years ago
Handle startup failure. Don't hang if startup parameters couldn't be determined. Instead, signal that the service entered the STOPPED state. Set START_PENDING state prior to actual startup.
15 years ago
/* Register control handler */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, (void *) service);
if (! service->status_handle) {
Fix event logging. Some messages weren't being logged properly. One common reason was that one or more arguments to log_event() were longs but were interpreted as strings. Create a temporary buffer and sprintf the numbers to fix that. The other reason was that GetLastError() returns a long where a string was expected. Restore the previously removed error_string() function to convert it into an error message.
14 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, error_string(GetLastError()), 0);
Handle startup failure. Don't hang if startup parameters couldn't be determined. Instead, signal that the service entered the STOPPED state. Set START_PENDING state prior to actual startup.
15 years ago
return;
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_service_control(service->name, 0, true);
Log that we received control messages. Send a message to the event log when we receive a service control. Use a fake message for starting a service so we can reuse code. No SERVICE_CONTROL_START control is defined or used by the Windows API. French translations by François-Régis Tardy.
13 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwCurrentState = SERVICE_START_PENDING;
service->status.dwWaitHint = service->throttle_delay + NSSM_WAITHINT_MARGIN;
SetServiceStatus(service->status_handle, &service->status);
NSSM 1.0.
22 years ago
Handle running without administrator privileges. If the service is configured to run as an unprivileged user NSSM will not be able to perform certain tasks which are not critical and will therefore log some errors which can be ignored. It will not be able to register itself as an event log source. It will not be able to create a default AppExit key. It will not be able to configure service failure handling. Try to perform these tasks where first installing the service (which we are guaranteed to do with administrator rights) as well as at runtime, and don't log the errors if the runtime actions can't be performed.
13 years ago
if (is_admin) {
/* Try to create the exit action parameters; we don't care if it fails */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
create_exit_action(service->name, exit_action_strings[0]);
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
SC_HANDLE services = open_service_manager();
if (services) {
service->handle = OpenService(services, service->name, SC_MANAGER_ALL_ACCESS);
set_service_recovery(service);
CloseServiceHandle(services);
}
Handle running without administrator privileges. If the service is configured to run as an unprivileged user NSSM will not be able to perform certain tasks which are not critical and will therefore log some errors which can be ignored. It will not be able to register itself as an event log source. It will not be able to create a default AppExit key. It will not be able to configure service failure handling. Try to perform these tasks where first installing the service (which we are guaranteed to do with administrator rights) as well as at runtime, and don't log the errors if the runtime actions can't be performed.
13 years ago
}
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
/* Used for signalling a resume if the service pauses when throttled. */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (use_critical_section) {
InitializeCriticalSection(&service->throttle_section);
service->throttle_section_initialised = true;
}
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
else {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
}
Timer safety. Check we actually have a waitable timer before trying to use it. Use the correct compiler food to ensure that 256000 milliseconds is converted to a LARGE_INTEGER correctly.
14 years ago
}
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
monitor_service(service);
NSSM 1.0.
22 years ago
}
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
/* Make sure service recovery actions are taken where necessary */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void set_service_recovery(nssm_service_t *service) {
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
SERVICE_FAILURE_ACTIONS_FLAG flag;
ZeroMemory(&flag, sizeof(flag));
flag.fFailureActionsOnNonCrashFailures = true;
/* This functionality was added in Vista so the call may fail */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (! ChangeServiceConfig2(service->handle, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag)) {
Fixed incomplete set_service_recovery(). A rogue return prevented set_service_recovery() from actually doing anything. Also we weren't checking for failure in ChangeServiceConfig2(). We expect ERROR_INVALID_LEVEL on pre-Vista Windows but other errors were not detected. French translation by François-Régis Tardy.
13 years ago
unsigned long error = GetLastError();
/* Pre-Vista we expect to fail with ERROR_INVALID_LEVEL */
if (error != ERROR_INVALID_LEVEL) {
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SERVICE_CONFIG_FAILURE_ACTIONS_FAILED, service->name, error_string(error), 0);
Fixed incomplete set_service_recovery(). A rogue return prevented set_service_recovery() from actually doing anything. Also we weren't checking for failure in ChangeServiceConfig2(). We expect ERROR_INVALID_LEVEL on pre-Vista Windows but other errors were not detected. French translation by François-Régis Tardy.
13 years ago
}
}
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int monitor_service(nssm_service_t *service) {
NSSM 1.0.
22 years ago
/* Set service status to started */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int ret = start_service(service);
NSSM 1.0.
22 years ago
if (ret) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR code[16];
_sntprintf_s(code, _countof(code), _TRUNCATE, _T("%d"), ret);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, service->exe, service->name, ret, 0);
NSSM 1.0.
22 years ago
return ret;
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, service->exe, service->flags, service->name, service->dir, 0);
NSSM 1.0.
22 years ago
Typos and formatting etc.
11 years ago
/* Monitor service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
NSSM 1.0.
22 years ago
}
return 0;
}
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR *service_control_text(unsigned long control) {
Log that we received control messages. Send a message to the event log when we receive a service control. Use a fake message for starting a service so we can reuse code. No SERVICE_CONTROL_START control is defined or used by the Windows API. French translations by François-Régis Tardy.
13 years ago
switch (control) {
/* HACK: there is no SERVICE_CONTROL_START constant */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
case 0: return _T("START");
case SERVICE_CONTROL_STOP: return _T("STOP");
case SERVICE_CONTROL_SHUTDOWN: return _T("SHUTDOWN");
case SERVICE_CONTROL_PAUSE: return _T("PAUSE");
case SERVICE_CONTROL_CONTINUE: return _T("CONTINUE");
case SERVICE_CONTROL_INTERROGATE: return _T("INTERROGATE");
Log that we received control messages. Send a message to the event log when we receive a service control. Use a fake message for starting a service so we can reuse code. No SERVICE_CONTROL_START control is defined or used by the Windows API. French translations by François-Régis Tardy.
13 years ago
default: return 0;
}
}
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
void log_service_control(TCHAR *service_name, unsigned long control, bool handled) {
TCHAR *text = service_control_text(control);
Log that we received control messages. Send a message to the event log when we receive a service control. Use a fake message for starting a service so we can reuse code. No SERVICE_CONTROL_START control is defined or used by the Windows API. French translations by François-Régis Tardy.
13 years ago
unsigned long event;
if (! text) {
/* "0x" + 8 x hex + NULL */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
text = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, 11 * sizeof(TCHAR));
Log that we received control messages. Send a message to the event log when we receive a service control. Use a fake message for starting a service so we can reuse code. No SERVICE_CONTROL_START control is defined or used by the Windows API. French translations by François-Régis Tardy.
13 years ago
if (! text) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("control code"), _T("log_service_control()"), 0);
Log that we received control messages. Send a message to the event log when we receive a service control. Use a fake message for starting a service so we can reuse code. No SERVICE_CONTROL_START control is defined or used by the Windows API. French translations by François-Régis Tardy.
13 years ago
return;
}
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (_sntprintf_s(text, 11, _TRUNCATE, _T("0x%08x"), control) < 0) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("control code"), _T("log_service_control()"), 0);
Log that we received control messages. Send a message to the event log when we receive a service control. Use a fake message for starting a service so we can reuse code. No SERVICE_CONTROL_START control is defined or used by the Windows API. French translations by François-Régis Tardy.
13 years ago
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);
}
}
NSSM 1.0.
22 years ago
/* Service control handler */
unsigned long WINAPI service_control_handler(unsigned long control, unsigned long event, void *data, void *context) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
nssm_service_t *service = (nssm_service_t *) context;
NSSM 1.0.
22 years ago
switch (control) {
Ignore INTERROGATE control. NSSM periodically logs that it received an unhandled INTERROGATE control. The control is sent by the system to request an update of the service's status but NSSM always keeps the status up-to-date so no action is needed on receipt of the control. Rather than fill the logs with instances of such a message, NSSM will now simply ignore the INTERROGATE control silently.
12 years ago
case SERVICE_CONTROL_INTERROGATE:
/* We always keep the service status up-to-date so this is a no-op. */
return NO_ERROR;
NSSM 1.0.
22 years ago
case SERVICE_CONTROL_SHUTDOWN:
case SERVICE_CONTROL_STOP:
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_service_control(service->name, control, true);
Spawn a separate thread for stop_service(). We must acknowledge a STOP or SHUTDOWN control promptly but the termination of the application may take a significant amount of time if one of the AppStopMethod* registry values is set. We now spawn a separate thread to try to stop the process and to call await_shutdown() while the main thread immediately acknowledges receipt of the STOP request. Once the worker thread has updated the service status to say that application is really stopped we will be automatically cleaned up by the system. If for some reason we can't spawn a new thread we log an error and ignore user-supplied timeouts so as to ensure we tidy up promptly.
11 years ago
/*
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.
*/
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (! CreateThread(NULL, 0, shutdown_service, context, 0, NULL)) {
Spawn a separate thread for stop_service(). We must acknowledge a STOP or SHUTDOWN control promptly but the termination of the application may take a significant amount of time if one of the AppStopMethod* registry values is set. We now spawn a separate thread to try to stop the process and to call await_shutdown() while the main thread immediately acknowledges receipt of the STOP request. Once the worker thread has updated the service status to say that application is really stopped we will be automatically cleaned up by the system. If for some reason we can't spawn a new thread we log an error and ignore user-supplied timeouts so as to ensure we tidy up promptly.
11 years ago
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.
*/
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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;
Spawn a separate thread for stop_service(). We must acknowledge a STOP or SHUTDOWN control promptly but the termination of the application may take a significant amount of time if one of the AppStopMethod* registry values is set. We now spawn a separate thread to try to stop the process and to call await_shutdown() while the main thread immediately acknowledges receipt of the STOP request. Once the worker thread has updated the service status to say that application is really stopped we will be automatically cleaned up by the system. If for some reason we can't spawn a new thread we log an error and ignore user-supplied timeouts so as to ensure we tidy up promptly.
11 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
stop_service(service, 0, true, true);
Spawn a separate thread for stop_service(). We must acknowledge a STOP or SHUTDOWN control promptly but the termination of the application may take a significant amount of time if one of the AppStopMethod* registry values is set. We now spawn a separate thread to try to stop the process and to call await_shutdown() while the main thread immediately acknowledges receipt of the STOP request. Once the worker thread has updated the service status to say that application is really stopped we will be automatically cleaned up by the system. If for some reason we can't spawn a new thread we log an error and ignore user-supplied timeouts so as to ensure we tidy up promptly.
11 years ago
}
NSSM 1.0.
22 years ago
return NO_ERROR;
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
case SERVICE_CONTROL_CONTINUE:
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_service_control(service->name, control, true);
service->throttle = 0;
if (use_critical_section) imports.WakeConditionVariable(&service->throttle_condition);
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
else {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
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.
*/
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_service_control(service->name, control, false);
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
return ERROR_CALL_NOT_IMPLEMENTED;
NSSM 1.0.
22 years ago
}
/* Unknown control */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_service_control(service->name, control, false);
NSSM 1.0.
22 years ago
return ERROR_CALL_NOT_IMPLEMENTED;
}
/* Start the service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int start_service(nssm_service_t *service) {
service->stopping = false;
service->allow_restart = true;
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (service->process_handle) return 0;
NSSM 1.0.
22 years ago
/* Allocate a STARTUPINFO structure for a new process */
STARTUPINFO si;
ZeroMemory(&si, sizeof(si));
si.cb = sizeof(si);
/* Allocate a PROCESSINFO structure for the process */
PROCESS_INFORMATION pi;
ZeroMemory(&pi, sizeof(pi));
Read registry before each restart. Read Application, AppDirectory and AppParameters before each restart so a change to any one doesn't require restarting NSSM itself.
14 years ago
/* Get startup parameters */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int ret = get_parameters(service, &si);
Read registry before each restart. Read Application, AppDirectory and AppParameters before each restart so a change to any one doesn't require restarting NSSM itself.
14 years ago
if (ret) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, service->name, 0);
return stop_service(service, 2, true, true);
Read registry before each restart. Read Application, AppDirectory and AppParameters before each restart so a change to any one doesn't require restarting NSSM itself.
14 years ago
}
NSSM 1.0.
22 years ago
/* Launch executable with arguments */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR cmd[CMD_LENGTH];
if (_sntprintf_s(cmd, _countof(cmd), _TRUNCATE, _T("\"%s\" %s"), service->exe, service->flags) < 0) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("command line"), _T("start_service"), 0);
Allow specifying output streams. Allow starting the monitor application with one or more of stdin, stdout and stderr redirected to a file or anything which can be opened with CreateFile(). New registry values corresponding to CreateFile() arguments for stdin (and analogously for stdout and stderr): AppStdin: Path to open. AppStdinShareMode: Sharing mode. AppStdinCreationDisposition: Creation disposition. AppStdinFlagsAndAtrributes: Flags and attributes. All are optional. If no path is given for a particular stream it will not be redirected. If a path is given but any of the other values are omitted they will receive sensible defaults.
12 years ago
close_output_handles(&si);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
return stop_service(service, 2, true, true);
NSSM 1.0.
22 years ago
}
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
throttle_restart(service);
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Compiler food. Silence any compiler warnings relating to the use of _(v)snprintf() - not _(v)snprintf_s() - and type conversions.
11 years ago
bool inherit_handles = false;
if (si.dwFlags & STARTF_USESTDHANDLES) inherit_handles = true;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
unsigned long flags = 0;
#ifdef UNICODE
flags |= CREATE_UNICODE_ENVIRONMENT;
#endif
if (! CreateProcess(0, cmd, 0, 0, inherit_handles, flags, service->env, service->dir, &si, &pi)) {
Use test_environment(). Use the new test_environment() function when validating the environment in the GUI and when launching the monitored application fails with ERROR_INVALID_PARAMETER. In the latter case we set service-specific error code 4 to help identify the reason for the failure.
11 years ago
unsigned long exitcode = 3;
Support srvany's AppEnvironment registry value. Allow setting one or more environment variables for the application by creating the AppEnvironment value of type REG_MULTI_SZ. Each string should be of the form KEY=VALUE. VALUE may be omitted to set an empty environment variable but the equals sign must be present. This support is for compatibility with srvany. In accordance with the documented behaviour of srvany, only environment variables specified in AppEnvironment will be passed to the service. Any other variables, even system variables such as %PATH%, will be ignored if they are not explicitly listed. Note that Windows supports adding environment variables to the service's existing environment by creating the Environment value (also of type REG_MULTI_SZ) under HKLM\SYSTEM\CurrentControlSet\Services\<service> instead. It is recommended that new services use this standard functionality rather than AppEnvironment. Thanks Rob Sharp.
13 years ago
unsigned long error = GetLastError();
Use test_environment(). Use the new test_environment() function when validating the environment in the GUI and when launching the monitored application fails with ERROR_INVALID_PARAMETER. In the latter case we set service-specific error code 4 to help identify the reason for the failure.
11 years ago
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);
if (test_environment(service->env)) exitcode = 4;
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service->name, service->exe, error_string(error), 0);
Allow specifying output streams. Allow starting the monitor application with one or more of stdin, stdout and stderr redirected to a file or anything which can be opened with CreateFile(). New registry values corresponding to CreateFile() arguments for stdin (and analogously for stdout and stderr): AppStdin: Path to open. AppStdinShareMode: Sharing mode. AppStdinCreationDisposition: Creation disposition. AppStdinFlagsAndAtrributes: Flags and attributes. All are optional. If no path is given for a particular stream it will not be redirected. If a path is given but any of the other values are omitted they will receive sensible defaults.
12 years ago
close_output_handles(&si);
Use test_environment(). Use the new test_environment() function when validating the environment in the GUI and when launching the monitored application fails with ERROR_INVALID_PARAMETER. In the latter case we set service-specific error code 4 to help identify the reason for the failure.
11 years ago
return stop_service(service, exitcode, true, true);
NSSM 1.0.
22 years ago
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->process_handle = pi.hProcess;
service->pid = pi.dwProcessId;
NSSM 1.0.
22 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (get_process_creation_time(service->process_handle, &service->creation_time)) ZeroMemory(&service->creation_time, sizeof(service->creation_time));
Fixed crash when stopping the service. NSSM tidies up by looking for processes whose parent PID matches the PID of the monitored application. Because process IDs are reused, however, it's possible for NSSM to kill a process which was not a child of the monitored application if that process had a now-exited parent process whose PID was reused. On UNIX the PPID would show as 1 for an orphaned process but under Windows, at least when querying a process with the Toolhelp32 toolkit, we see the original PPID of the process even if the parent is no longer running. Thus it is not sufficient to compare parent PIDs when checking if a process was launched by our application. In the worst case scenario NSSM could even terminate itself and trigger a bluescreen. When we find process with matching PPID we now also check that it was created after our application was created and before our application exited.
12 years ago
Allow specifying output streams. Allow starting the monitor application with one or more of stdin, stdout and stderr redirected to a file or anything which can be opened with CreateFile(). New registry values corresponding to CreateFile() arguments for stdin (and analogously for stdout and stderr): AppStdin: Path to open. AppStdinShareMode: Sharing mode. AppStdinCreationDisposition: Creation disposition. AppStdinFlagsAndAtrributes: Flags and attributes. All are optional. If no path is given for a particular stream it will not be redirected. If a path is given but any of the other values are omitted they will receive sensible defaults.
12 years ago
close_output_handles(&si);
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
/*
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.
*/
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
unsigned long delay = service->throttle_delay;
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
if (delay > NSSM_SERVICE_STATUS_DEADLINE) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR delay_milliseconds[16];
_sntprintf_s(delay_milliseconds, _countof(delay_milliseconds), _TRUNCATE, _T("%lu"), delay);
TCHAR deadline_milliseconds[16];
_sntprintf_s(deadline_milliseconds, _countof(deadline_milliseconds), _TRUNCATE, _T("%lu"), NSSM_SERVICE_STATUS_DEADLINE);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_STARTUP_DELAY_TOO_LONG, service->name, delay_milliseconds, NSSM, deadline_milliseconds, 0);
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
delay = NSSM_SERVICE_STATUS_DEADLINE;
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
unsigned long deadline = WaitForSingleObject(service->process_handle, delay);
Delay report that the service is running. Wait until the application has been running for long enough to be exempt from restart throttling before reporting a status of SERVICE_RUNNING to the operating system. Thanks Tom Saul.
11 years ago
NSSM 1.0.
22 years ago
/* Signal successful start */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwCurrentState = SERVICE_RUNNING;
SetServiceStatus(service->status_handle, &service->status);
NSSM 1.0.
22 years ago
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
/* Continue waiting for a clean startup. */
if (deadline == WAIT_TIMEOUT) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (service->throttle_delay > delay) {
if (WaitForSingleObject(service->process_handle, service->throttle_delay - delay) == WAIT_TIMEOUT) service->throttle = 0;
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
else service->throttle = 0;
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
}
NSSM 1.0.
22 years ago
return 0;
}
/* Stop the service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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;
}
Try harder not to restart the application when stopping. Try even harder to avoid race conditions whereby one thread reacts to an application exit and performs a restart even after another thread has committed to handling a stop control. Thanks Runner Mei.
11 years ago
Don't suicide on exit status 0. Suiciding when the application exits 0 will cause recovery actions to be taken. Usually this is inappropriate. Only suicide if there is an explicit AppExit value for 0 in the registry. Technically such behaviour could be abused to do something like run a script after successful completion of a service but in most cases a suicide is undesirable when no actual failure occurred.
15 years ago
if (default_action && ! exitcode && ! graceful) {
Fixed missing NULLs in log_event(). The last argument to log_event must be NULL or messages with too many parameters may not be logged.
11 years ago
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);
Don't suicide on exit status 0. Suiciding when the application exits 0 will cause recovery actions to be taken. Usually this is inappropriate. Only suicide if there is an explicit AppExit value for 0 in the registry. Technically such behaviour could be abused to do something like run a script after successful completion of a service but in most cases a suicide is undesirable when no actual failure occurred.
15 years ago
graceful = true;
}
NSSM 1.0.
22 years ago
/* Signal we are stopping */
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
if (graceful) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwCurrentState = SERVICE_STOP_PENDING;
service->status.dwWaitHint = NSSM_WAITHINT_MARGIN;
SetServiceStatus(service->status_handle, &service->status);
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
}
NSSM 1.0.
22 years ago
Fixed crash when stopping the service. NSSM tidies up by looking for processes whose parent PID matches the PID of the monitored application. Because process IDs are reused, however, it's possible for NSSM to kill a process which was not a child of the monitored application if that process had a now-exited parent process whose PID was reused. On UNIX the PPID would show as 1 for an orphaned process but under Windows, at least when querying a process with the Toolhelp32 toolkit, we see the original PPID of the process even if the parent is no longer running. Thus it is not sufficient to compare parent PIDs when checking if a process was launched by our application. In the worst case scenario NSSM could even terminate itself and trigger a bluescreen. When we find process with matching PPID we now also check that it was created after our application was created and before our application exited.
12 years ago
/* Nothing to do if service isn't running */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (service->pid) {
Fixed crash when stopping the service. NSSM tidies up by looking for processes whose parent PID matches the PID of the monitored application. Because process IDs are reused, however, it's possible for NSSM to kill a process which was not a child of the monitored application if that process had a now-exited parent process whose PID was reused. On UNIX the PPID would show as 1 for an orphaned process but under Windows, at least when querying a process with the Toolhelp32 toolkit, we see the original PPID of the process even if the parent is no longer running. Thus it is not sufficient to compare parent PIDs when checking if a process was launched by our application. In the worst case scenario NSSM could even terminate itself and trigger a bluescreen. When we find process with matching PPID we now also check that it was created after our application was created and before our application exited.
12 years ago
/* Shut down service */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service->name, service->exe, 0);
kill_process(service, service->process_handle, service->pid, 0);
NSSM 1.0.
22 years ago
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service->name, service->exe, 0);
NSSM 1.0.
22 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
end_service((void *) service, true);
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
NSSM 1.0.
22 years ago
/* Signal we stopped */
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
if (graceful) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwCurrentState = SERVICE_STOPPED;
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
if (exitcode) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR;
service->status.dwServiceSpecificExitCode = exitcode;
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
}
else {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwWin32ExitCode = NO_ERROR;
service->status.dwServiceSpecificExitCode = 0;
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
SetServiceStatus(service->status_handle, &service->status);
NSSM 1.0.
22 years ago
}
return exitcode;
}
/* Callback function triggered when the server exits */
void CALLBACK end_service(void *arg, unsigned char why) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
nssm_service_t *service = (nssm_service_t *) arg;
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (service->stopping) return;
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->stopping = true;
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
NSSM 1.0.
22 years ago
/* Check exit code */
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
unsigned long exitcode = 0;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR code[16];
Don't try to kill a process which didn't start. If CreateProcess() failed there's no sense trying to call GetExitCodeProcess() or kill_process_tree().
11 years ago
if (service->process_handle) {
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);
}
else GetSystemTimeAsFileTime(&service->exit_time);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->process_handle = 0;
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
Log exit messages more intuitively. In the case where the application crashed and NSSM then cleaned up its child processes the events logged were confusing. First we'd log that we were going to kill the process tree with exit code X then we'd log that the service had ended with exit code X. Logging that the application exited before doing the process tree kill makes it clearer that the cleanup is in response to the application exit.
13 years ago
/*
Log that the service ended BEFORE logging about killing the process
tree. See below for the possible values of the why argument.
*/
if (! why) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
_sntprintf_s(code, _countof(code), _TRUNCATE, _T("%lu"), exitcode);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, service->exe, service->name, code, 0);
Log exit messages more intuitively. In the case where the application crashed and NSSM then cleaned up its child processes the events logged were confusing. First we'd log that we were going to kill the process tree with exit code X then we'd log that the service had ended with exit code X. Logging that the application exited before doing the process tree kill makes it clearer that the cleanup is in response to the application exit.
13 years ago
}
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
/* Clean up. */
Typos and formatting etc.
11 years ago
if (exitcode == STILL_ACTIVE) exitcode = 0;
Don't try to kill a process which didn't start. If CreateProcess() failed there's no sense trying to call GetExitCodeProcess() or kill_process_tree().
11 years ago
if (service->pid) kill_process_tree(service, service->pid, exitcode, service->pid);
service->pid = 0;
Kill process tree when stopping service. Ensure that all child processes of the monitored application are killed when the service stops by recursing through all running processes and terminating those whose parent is the application or one of its descendents.
14 years ago
/*
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;
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (! service->allow_restart) return;
NSSM 1.0.
22 years ago
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
/* What action should we take? */
int action = NSSM_EXIT_RESTART;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR action_string[ACTION_LEN];
Don't suicide on exit status 0. Suiciding when the application exits 0 will cause recovery actions to be taken. Usually this is inappropriate. Only suicide if there is an explicit AppExit value for 0 in the registry. Technically such behaviour could be abused to do something like run a script after successful completion of a service but in most cases a suicide is undesirable when no actual failure occurred.
15 years ago
bool default_action;
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (! get_exit_action(service->name, &exitcode, action_string, &default_action)) {
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
for (int i = 0; exit_action_strings[i]; i++) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (! _tcsnicmp((const TCHAR *) action_string, exit_action_strings[i], ACTION_LEN)) {
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
action = i;
break;
}
}
NSSM 1.0.
22 years ago
}
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
switch (action) {
/* Try to restart the service or return failure code to service manager */
case NSSM_EXIT_RESTART:
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
Sleep(30000);
}
break;
/* Do nothing, just like srvany would */
case NSSM_EXIT_IGNORE:
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service->name, code, exit_action_strings[action], service->exe, 0);
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
Sleep(INFINITE);
break;
/* Tell the service manager we are finished */
case NSSM_EXIT_REALLY:
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service->name, code, exit_action_strings[action], 0);
stop_service(service, exitcode, true, default_action);
Ensure systems recovery actions can happen. In Windows versions earlier than Vista the service manager would only consider a service failed (and hence eligible for recovery action) if the service exited without setting its state to SERVICE_STOPPED, even if it signalled an error exit code. In Vista and later the service manager can be configured to treat a graceful shutdown with error code as a failure but this is not the default behaviour. Try to configure the service manager to use the new behaviour when starting the service so users who set AppExit to Exit can use recovery actions as expected. Also recognise the new AppExit option Suicide for use on pre-Vista systems. When AppExit is Suicide don't stop the service but exit inelegantly, which should be seen as a failure.
15 years ago
break;
/* Fake a crash so pre-Vista service managers will run recovery actions. */
case NSSM_EXIT_UNCLEAN:
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_UNCLEAN, service->name, code, exit_action_strings[action], 0);
stop_service(service, exitcode, false, default_action);
AttachConsole() isn't available in Windows 2000. Instead of calling AttachConsole() directory use a function pointer in the new global imports struct. It's safe to skip any attempt to attach to the console when the function isn't available.
11 years ago
free_imports();
exit(exitcode);
Decide how to handle application exit. When the service exits with exit code n look in HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>, falling back to the unnamed value if no such code is listed. Parse the (string) value of this entry as follows: Restart: Start the application again (NSSM default). Ignore: Do nothing (srvany default). Exit: Stop the service.
15 years ago
break;
NSSM 1.0.
22 years ago
}
}
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void throttle_restart(nssm_service_t *service) {
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
/* This can't be a restart if the service is already running. */
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (! service->throttle++) return;
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int ms = throttle_milliseconds(service->throttle);
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (service->throttle > 7) service->throttle = 8;
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR threshold[8], milliseconds[8];
_sntprintf_s(threshold, _countof(threshold), _TRUNCATE, _T("%lu"), service->throttle_delay);
_sntprintf_s(milliseconds, _countof(milliseconds), _TRUNCATE, _T("%lu"), ms);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service->name, threshold, milliseconds, 0);
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
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);
Timer safety. Check we actually have a waitable timer before trying to use it. Use the correct compiler food to ensure that 256000 milliseconds is converted to a LARGE_INTEGER correctly.
14 years ago
}
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwCurrentState = SERVICE_PAUSED;
SetServiceStatus(service->status_handle, &service->status);
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
if (use_critical_section) {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
imports.SleepConditionVariableCS(&service->throttle_condition, &service->throttle_section, ms);
LeaveCriticalSection(&service->throttle_section);
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
}
else {
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
if (service->throttle_timer) WaitForSingleObject(service->throttle_timer, INFINITE);
Try to throttle using a critical section. The first implementation of service restart throttling used a condition variable in a critical section to sleep for the required amount of time. The implementation was changed to use a waitable timer because Windows 2000 does not support SleepConditionVariableCS() or WakeConditionVariable(). Since we are now using LoadLibrary() and GetProcAddress() to use newer functions dynamically without having to build OS-specific binaries, we can now use a critical section where it's supported and fall back to a waitable timer when running on Windows 2000.
11 years ago
else Sleep(ms);
}
Throttle restarts. Back off from restarting the application immediately if it starts successfully but exits too soon. Handle resume messages from the service console to restart the application immediately even if it is throttled. Use service status wait hints to tell the operating system how long start, stop and resume actions are likely to take.
14 years ago
}
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
/*
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
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
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.
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
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.
*/
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
int await_shutdown(nssm_service_t *service, TCHAR *function_name, unsigned long timeout) {
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
unsigned long interval;
unsigned long waithint;
unsigned long ret;
unsigned long waited;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR interval_milliseconds[16];
TCHAR timeout_milliseconds[16];
TCHAR waited_milliseconds[16];
TCHAR *function = function_name;
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
/* Add brackets to function name. */
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
size_t funclen = _tcslen(function_name) + 3;
TCHAR *func = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, funclen * sizeof(TCHAR));
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
if (func) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
if (_sntprintf_s(func, funclen, _TRUNCATE, _T("%s()"), function_name) > -1) function = func;
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
}
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
_sntprintf_s(timeout_milliseconds, _countof(timeout_milliseconds), _TRUNCATE, _T("%lu"), timeout);
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
waithint = service->status.dwWaitHint;
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
waited = 0;
while (waited < timeout) {
interval = timeout - waited;
Enforce maximum report delay when starting service. We were not changing the service's state to running until the restart throttling threshold had passed. However best practice is to change the status to running or stopped as quickly as possible. Therefore we we now report the status after no more than 20000 milliseconds regardless of the throttle setting.
11 years ago
if (interval > NSSM_SERVICE_STATUS_DEADLINE) interval = NSSM_SERVICE_STATUS_DEADLINE;
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
service->status.dwCurrentState = SERVICE_STOP_PENDING;
service->status.dwWaitHint += interval;
service->status.dwCheckPoint++;
SetServiceStatus(service->status_handle, &service->status);
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
if (waited) {
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
_sntprintf_s(waited_milliseconds, _countof(waited_milliseconds), _TRUNCATE, _T("%lu"), waited);
_sntprintf_s(interval_milliseconds, _countof(interval_milliseconds), _TRUNCATE, _T("%lu"), interval);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_AWAITING_SHUTDOWN, function, service->name, waited_milliseconds, interval_milliseconds, timeout_milliseconds, 0);
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
}
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
switch (WaitForSingleObject(service->process_handle, interval)) {
Added await_shutdown() function. The system expects service STOP requests to be honoured promptly. If service shutdown will take longer than 30 seconds we must update the service status checkpoint variable before then. We also need to ensure that the service status wait hint time is strictly increasing every time we update the checkpoint, otherwise the service will be considered to be hung after 60 seconds.
11 years ago
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;
}