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 'c50225935f'
${ noResults }
nssm/service.cpp

564 lines
19 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;
NSSM 1.0.
22 years ago
SERVICE_STATUS service_status;
SERVICE_STATUS_HANDLE service_handle;
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
HANDLE process_handle;
NSSM 1.0.
22 years ago
HANDLE wait_handle;
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 pid;
Fix path lengths. Some buffers were being limited to MAX_PATH characters when higher limits were more appropriate. For example the maximum length of a command line is documented as 32768 characters with the application name part limited to MAX_PATH. Long applications paths and arguments could be truncated when written to the registry. Thanks Joel Reingold.
15 years ago
static char service_name[SERVICE_NAME_LENGTH];
char exe[EXE_LENGTH];
char flags[CMD_LENGTH];
NSSM 1.0.
22 years ago
char dir[MAX_PATH];
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
bool stopping;
Allow configuring throttling threshold. Tweak minimum time for which a service must run by setting the threshold number of milliseconds in AppThrottle (REG_DWORD).
14 years ago
unsigned long throttle_delay;
Skip some or all methods of stopping the application. Use the AppStopMethodSkip bit field to specify any method(s) which should not be employed when stopping the application.
11 years ago
unsigned long stop_method;
Fix pre-Vista compatibility. SleepConditionVariableCS() isn't available on Windows versions prior to Vista. Use a waitable timer instead.
14 years ago
HANDLE throttle_timer;
LARGE_INTEGER throttle_duetime;
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
FILETIME creation_time;
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
static enum { NSSM_EXIT_RESTART, NSSM_EXIT_IGNORE, NSSM_EXIT_REALLY, NSSM_EXIT_UNCLEAN } exit_actions;
static const char *exit_action_strings[] = { "Restart", "Ignore", "Exit", "Suicide", 0 };
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
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
static unsigned long throttle;
static inline int throttle_milliseconds() {
/* pow() operates on doubles. */
int ret = 1; for (unsigned long i = 1; i < throttle; i++) ret *= 2;
return ret * 1000;
}
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;
}
NSSM 2.0.
19 years ago
/* About to install the service */
int pre_install_service(int argc, char **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]);
/* Arguments are optional */
char *flags;
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;
int i;
for (i = 2; i < argc; i++) flagslen += strlen(argv[i]) + 1;
if (! flagslen) flagslen = 1;
flags = (char *) HeapAlloc(GetProcessHeap(), 0, flagslen);
if (! flags) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "flags", "pre_install_service()", 0);
return 2;
}
ZeroMemory(flags, flagslen);
/*
This probably isn't UTF8-safe and should use std::string or something
but it's been broken for the best part of a decade and due for a rewrite
anyway so it'll do as a quick-'n'-dirty fix. Note that we don't free
the flags buffer but as the program exits that isn't a big problem.
*/
for (i = 2; i < argc; i++) {
size_t len = strlen(argv[i]);
memmove(flags + s, argv[i], len);
s += len;
if (i < argc - 1) flags[s++] = ' ';
}
NSSM 2.0.
19 years ago
return install_service(argv[0], argv[1], flags);
}
/* About to remove the service */
int pre_remove_service(int argc, char **argv) {
/* Show dialogue box if we didn't pass service name and "confirm" */
if (argc < 2) return nssm_gui(IDD_REMOVE, argv[0]);
if (str_equiv(argv[1], "confirm")) return remove_service(argv[0]);
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 */
NSSM 2.0.
19 years ago
int install_service(char *name, char *exe, char *flags) {
/* 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
/* Get path of this program */
char path[MAX_PATH];
GetModuleFileName(0, path, MAX_PATH);
/* Construct command */
Fix path lengths. Some buffers were being limited to MAX_PATH characters when higher limits were more appropriate. For example the maximum length of a command line is documented as 32768 characters with the application name part limited to MAX_PATH. Long applications paths and arguments could be truncated when written to the registry. Thanks Joel Reingold.
15 years ago
char command[CMD_LENGTH];
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
size_t pathlen = strlen(path);
Removed run hack. Previously we used to attempt to run as a service only when the "run" argument was given, and printed a usage message if no arguments were provided. A more appropriate strategy is to check for StartServiceCtrlDispatcher() returning ERROR_FAILED_SERVICE_CONTROLLER_CONNECT, as that means the application is not running in a service context. As a result we no longer write the undocumented "run" argument to the registry when installing a service. Technically this means that we sacrifice backward compatibility with older versions.
13 years ago
if (pathlen + 1 >= VALUE_LENGTH) {
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_PATH_TOO_LONG, NSSM);
NSSM 2.0.
19 years ago
return 3;
}
Removed run hack. Previously we used to attempt to run as a service only when the "run" argument was given, and printed a usage message if no arguments were provided. A more appropriate strategy is to check for StartServiceCtrlDispatcher() returning ERROR_FAILED_SERVICE_CONTROLLER_CONNECT, as that means the application is not running in a service context. As a result we no longer write the undocumented "run" argument to the registry when installing a service. Technically this means that we sacrifice backward compatibility with older versions.
13 years ago
if (_snprintf(command, sizeof(command), "\"%s\"", path) < 0) {
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_OUT_OF_MEMORY_FOR_IMAGEPATH);
NSSM 2.0.
19 years ago
return 4;
}
/* Work out directory name */
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
size_t len = strlen(exe);
size_t i;
NSSM 2.0.
19 years ago
for (i = len; i && exe[i] != '\\' && exe[i] != '/'; i--);
char dir[MAX_PATH];
memmove(dir, exe, i);
dir[i] = '\0';
/* Create the service */
SC_HANDLE service = CreateService(services, name, name, SC_MANAGER_ALL_ACCESS, SERVICE_WIN32_OWN_PROCESS, SERVICE_AUTO_START, SERVICE_ERROR_NORMAL, command, 0, 0, 0, 0, 0);
if (! service) {
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;
}
/* Now we need to put the parameters into the registry */
if (create_parameters(name, exe, flags, dir)) {
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);
NSSM 2.0.
19 years ago
DeleteService(service);
CloseServiceHandle(services);
return 6;
}
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
set_service_recovery(service, name);
NSSM 2.0.
19 years ago
/* Cleanup */
CloseServiceHandle(service);
CloseServiceHandle(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(stdout, NSSM_MESSAGE_SERVICE_INSTALLED, name);
NSSM 2.0.
19 years ago
return 0;
NSSM 1.0.
22 years ago
}
/* Remove the service */
int remove_service(char *name) {
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 */
SC_HANDLE service = OpenService(services, name, SC_MANAGER_ALL_ACCESS);
if (! 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_OPENSERVICE_FAILED);
NSSM 2.0.
19 years ago
CloseServiceHandle(services);
return 3;
}
/* Try to delete the service */
if (! DeleteService(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_DELETESERVICE_FAILED);
NSSM 2.0.
19 years ago
CloseServiceHandle(service);
CloseServiceHandle(services);
return 4;
}
/* Cleanup */
CloseServiceHandle(service);
CloseServiceHandle(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(stdout, NSSM_MESSAGE_SERVICE_REMOVED, name);
NSSM 2.0.
19 years ago
return 0;
NSSM 1.0.
22 years ago
}
/* Service initialisation */
void WINAPI service_main(unsigned long argc, char **argv) {
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
if (_snprintf(service_name, sizeof(service_name), "%s", argv[0]) < 0) {
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service_name", "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;
}
NSSM 1.0.
22 years ago
/* Initialise status */
ZeroMemory(&service_status, sizeof(service_status));
service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS | SERVICE_INTERACTIVE_PROCESS;
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
service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_PAUSE_CONTINUE;
NSSM 1.0.
22 years ago
service_status.dwWin32ExitCode = NO_ERROR;
service_status.dwServiceSpecificExitCode = 0;
service_status.dwCheckPoint = 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
service_status.dwWaitHint = NSSM_WAITHINT_MARGIN;
NSSM 1.0.
22 years ago
/* Signal we AREN'T running the server */
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
process_handle = 0;
NSSM 1.0.
22 years ago
pid = 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
/* Register control handler */
service_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, 0);
if (! service_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;
}
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
log_service_control(service_name, 0, true);
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
service_status.dwCurrentState = SERVICE_START_PENDING;
Allow configuring throttling threshold. Tweak minimum time for which a service must run by setting the threshold number of milliseconds in AppThrottle (REG_DWORD).
14 years ago
service_status.dwWaitHint = throttle_delay + NSSM_WAITHINT_MARGIN;
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
SetServiceStatus(service_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 */
create_exit_action(argv[0], 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
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
set_service_recovery(0, service_name);
}
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. */
Fix pre-Vista compatibility. SleepConditionVariableCS() isn't available on Windows versions prior to Vista. Use a waitable timer instead.
14 years ago
throttle_timer = CreateWaitableTimer(0, 1, 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
if (! throttle_timer) {
log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_CREATEWAITABLETIMER_FAILED, service_name, error_string(GetLastError()), 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
NSSM 1.0.
22 years ago
monitor_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
/* Make sure service recovery actions are taken where necessary */
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
void set_service_recovery(SC_HANDLE service, char *service_name) {
SC_HANDLE services = 0;
if (! service) {
services = open_service_manager();
if (! services) return;
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
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
service = OpenService(services, service_name, SC_MANAGER_ALL_ACCESS);
if (! service) return;
}
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 */
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
if (! ChangeServiceConfig2(service, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag)) {
unsigned long error = GetLastError();
/* Pre-Vista we expect to fail with ERROR_INVALID_LEVEL */
if (error != ERROR_INVALID_LEVEL) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CHANGESERVICECONFIG2_FAILED, service_name, error_string(error), 0);
}
}
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 (services) {
CloseServiceHandle(service);
CloseServiceHandle(services);
}
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
int monitor_service() {
/* Set service status to started */
int ret = start_service();
if (ret) {
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
char code[16];
Removed some legacy stuff. What was #define GUI even for? Why #define snprintf _snprintf in one file where we're using actual _snprintf everywhere else?
14 years ago
_snprintf(code, sizeof(code), "%d", ret);
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0);
NSSM 1.0.
22 years ago
return ret;
}
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, exe, flags, service_name, dir, 0);
NSSM 1.0.
22 years ago
/* Monitor service service */
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
if (! RegisterWaitForSingleObject(&wait_handle, process_handle, end_service, (void *) pid, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) {
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_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service_name, exe, error_string(GetLastError()), 0);
NSSM 1.0.
22 years ago
}
return 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
char *service_control_text(unsigned long control) {
switch (control) {
/* HACK: there is no SERVICE_CONTROL_START constant */
case 0: return "START";
case SERVICE_CONTROL_STOP: return "STOP";
case SERVICE_CONTROL_SHUTDOWN: return "SHUTDOWN";
case SERVICE_CONTROL_PAUSE: return "PAUSE";
case SERVICE_CONTROL_CONTINUE: return "CONTINUE";
case SERVICE_CONTROL_INTERROGATE: return "INTERROGATE";
default: return 0;
}
}
void log_service_control(char *service_name, unsigned long control, bool handled) {
char *text = service_control_text(control);
unsigned long event;
if (! text) {
/* "0x" + 8 x hex + NULL */
text = (char *) HeapAlloc(GetProcessHeap(), 0, 11);
if (! text) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control", 0);
return;
}
if (_snprintf(text, 11, "0x%08x", control) < 0) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "control code", "log_service_control", 0);
HeapFree(GetProcessHeap(), 0, text);
return;
}
event = NSSM_EVENT_SERVICE_CONTROL_UNKNOWN;
}
else if (handled) event = NSSM_EVENT_SERVICE_CONTROL_HANDLED;
else event = NSSM_EVENT_SERVICE_CONTROL_NOT_HANDLED;
log_event(EVENTLOG_INFORMATION_TYPE, event, service_name, text, 0);
if (event == NSSM_EVENT_SERVICE_CONTROL_UNKNOWN) {
HeapFree(GetProcessHeap(), 0, text);
}
}
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) {
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:
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
log_service_control(service_name, control, true);
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
stop_service(0, true, true);
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:
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
log_service_control(service_name, control, true);
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
if (! throttle_timer) return ERROR_CALL_NOT_IMPLEMENTED;
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
throttle = 0;
Fix pre-Vista compatibility. SleepConditionVariableCS() isn't available on Windows versions prior to Vista. Use a waitable timer instead.
14 years ago
ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));
SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 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
service_status.dwCurrentState = SERVICE_CONTINUE_PENDING;
service_status.dwWaitHint = throttle_milliseconds() + NSSM_WAITHINT_MARGIN;
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_RESET_THROTTLE, service_name, 0);
SetServiceStatus(service_handle, &service_status);
return NO_ERROR;
case SERVICE_CONTROL_PAUSE:
/*
We don't accept pause messages but it isn't possible to register
only for continue messages so we have to handle this case.
*/
Log 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
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 */
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
log_service_control(service_name, control, false);
NSSM 1.0.
22 years ago
return ERROR_CALL_NOT_IMPLEMENTED;
}
/* Start the service */
int start_service() {
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
stopping = false;
if (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 */
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
char *env = 0;
Skip some or all methods of stopping the application. Use the AppStopMethodSkip bit field to specify any method(s) which should not be employed when stopping the application.
11 years ago
int ret = get_parameters(service_name, exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir), &env, &throttle_delay, &stop_method, &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) {
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, service_name, 0);
return stop_service(2, true, true);
}
NSSM 1.0.
22 years ago
/* Launch executable with arguments */
Fix path lengths. Some buffers were being limited to MAX_PATH characters when higher limits were more appropriate. For example the maximum length of a command line is documented as 32768 characters with the application name part limited to MAX_PATH. Long applications paths and arguments could be truncated when written to the registry. Thanks Joel Reingold.
15 years ago
char cmd[CMD_LENGTH];
More CreateProcess() fun. Correctly handle the case where the application executable is under a path which contains space and an executable sharing the initial part of that path (up to a space) exists. A (contrived) example is when Application is C:\stuff\app lications\foo.exe and C:\stuff\app.exe also exists. Thanks Eugene Lifshitz.
14 years ago
if (_snprintf(cmd, sizeof(cmd), "\"%s\" %s", exe, flags) < 0) {
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "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);
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
return stop_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
throttle_restart();
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
bool inherit_handles = (si.dwFlags & STARTF_USESTDHANDLES);
if (! CreateProcess(0, cmd, 0, 0, inherit_handles, 0, env, dir, &si, &pi)) {
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();
if (error == ERROR_INVALID_PARAMETER && env) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED_INVALID_ENVIRONMENT, service_name, exe, NSSM_REG_ENV, 0);
else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, 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);
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
return stop_service(3, true, true);
NSSM 1.0.
22 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
process_handle = pi.hProcess;
pid = pi.dwProcessId;
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
if (get_process_creation_time(process_handle, &creation_time)) ZeroMemory(&creation_time, sizeof(creation_time));
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);
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
/* Wait for a clean startup. */
if (WaitForSingleObject(process_handle, throttle_delay) == WAIT_TIMEOUT) throttle = 0;
NSSM 1.0.
22 years ago
/* Signal successful start */
service_status.dwCurrentState = SERVICE_RUNNING;
SetServiceStatus(service_handle, &service_status);
return 0;
}
/* Stop the service */
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
int stop_service(unsigned long exitcode, bool graceful, bool default_action) {
if (default_action && ! exitcode && ! graceful) {
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_GRACEFUL_SUICIDE, service_name, exe, exit_action_strings[NSSM_EXIT_UNCLEAN], exit_action_strings[NSSM_EXIT_UNCLEAN], exit_action_strings[NSSM_EXIT_UNCLEAN], exit_action_strings[NSSM_EXIT_REALLY] ,0);
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) {
service_status.dwCurrentState = SERVICE_STOP_PENDING;
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
service_status.dwWaitHint = NSSM_KILL_WINDOW_GRACE_PERIOD + NSSM_KILL_THREADS_GRACE_PERIOD + NSSM_WAITHINT_MARGIN;
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
SetServiceStatus(service_handle, &service_status);
}
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 */
NSSM 1.0.
22 years ago
if (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 */
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service_name, exe, 0);
Skip some or all methods of stopping the application. Use the AppStopMethodSkip bit field to specify any method(s) which should not be employed when stopping the application.
11 years ago
kill_process(service_name, stop_method, process_handle, pid, 0);
NSSM 1.0.
22 years ago
}
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0);
NSSM 1.0.
22 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
end_service((void *) pid, true);
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) {
service_status.dwCurrentState = SERVICE_STOPPED;
if (exitcode) {
service_status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR;
service_status.dwServiceSpecificExitCode = exitcode;
}
else {
service_status.dwWin32ExitCode = NO_ERROR;
service_status.dwServiceSpecificExitCode = 0;
}
SetServiceStatus(service_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) {
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
if (stopping) return;
stopping = true;
pid = (unsigned long) arg;
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;
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
char code[16];
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
FILETIME exit_time;
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
GetExitCodeProcess(process_handle, &exitcode);
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
if (exitcode == STILL_ACTIVE || get_process_exit_time(process_handle, &exit_time)) GetSystemTimeAsFileTime(&exit_time);
CloseHandle(process_handle);
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) {
_snprintf(code, sizeof(code), "%d", exitcode);
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 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
/* Clean up. */
Skip some or all methods of stopping the application. Use the AppStopMethodSkip bit field to specify any method(s) which should not be employed when stopping the application.
11 years ago
kill_process_tree(service_name, stop_method, pid, exitcode, pid, &creation_time, &exit_time);
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;
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;
unsigned char 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;
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
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++) {
if (! _strnicmp((const char *) action_string, exit_action_strings[i], ACTION_LEN)) {
action = i;
break;
}
}
NSSM 1.0.
22 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
process_handle = 0;
NSSM 1.0.
22 years ago
pid = 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
switch (action) {
/* Try to restart the service or return failure code to service manager */
case NSSM_EXIT_RESTART:
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_RESTART, service_name, code, exit_action_strings[action], 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
while (monitor_service()) {
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_RESTART_SERVICE_FAILED, 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:
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service_name, code, exit_action_strings[action], 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:
Log messages properly. Format messages from resource. Use NSSM binary as the message source. Note that replacing the binary is prevented if the event viewer is open.
15 years ago
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service_name, code, exit_action_strings[action], 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
stop_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:
log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_UNCLEAN, service_name, code, exit_action_strings[action], 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
exit(stop_service(exitcode, false, 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
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
void throttle_restart() {
/* This can't be a restart if the service is already running. */
if (! throttle++) return;
int ms = throttle_milliseconds();
if (throttle > 7) throttle = 8;
char threshold[8], milliseconds[8];
Allow configuring throttling threshold. Tweak minimum time for which a service must run by setting the threshold number of milliseconds in AppThrottle (REG_DWORD).
14 years ago
_snprintf(threshold, sizeof(threshold), "%d", throttle_delay);
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
_snprintf(milliseconds, sizeof(milliseconds), "%d", ms);
log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_THROTTLED, service_name, threshold, milliseconds, 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
if (throttle_timer) {
ZeroMemory(&throttle_duetime, sizeof(throttle_duetime));
throttle_duetime.QuadPart = 0 - (ms * 10000LL);
SetWaitableTimer(throttle_timer, &throttle_duetime, 0, 0, 0, 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
service_status.dwCurrentState = SERVICE_PAUSED;
SetServiceStatus(service_handle, &service_status);
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
if (throttle_timer) WaitForSingleObject(throttle_timer, INFINITE);
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
}