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 '14d5a10605'
${ noResults }
nssm/nssm.h

137 lines
4.1 KiB
C
Raw Normal View History Unescape Escape

NSSM 1.0.
22 years ago
#ifndef NSSM_H
#define NSSM_H
Adjust buffer sizes. Unicode applications can under certain circumstances access paths longer than MAX_PATH characters. Service names are limited to 256 characters. Adjust our buffers to suit.
11 years ago
/*
MSDN says, basically, that the maximum length of a path is 260 characters,
which is represented by the constant MAX_PATH. Except when it isn't.
The maximum length of a directory path is MAX_PATH - 12 because it must be
possible to create a file in 8.3 format under any valid directory.
Unicode versions of filesystem API functions accept paths up to 32767
characters if the first four (wide) characters are L"\\?\" and each component
of the path, separated by L"\", does not exceed the value of
lpMaximumComponentLength returned by GetVolumeInformation(), which is
probably 255. But might not be.
Relative paths are always limited to MAX_PATH because the L"\\?\" prefix
is not valid for a relative path.
Note that we don't care about the last two paragraphs because we're only
concerned with allocating buffers big enough to store valid paths. If the
user tries to store invalid paths they will fit in the buffers but the
application will fail. The reason for the failure will end up in the
event log and the user will realise the mistake.
So that's that cleared up, then.
*/
#ifdef UNICODE
#define PATH_LENGTH 32767
#else
#define PATH_LENGTH MAX_PATH
#endif
#define DIR_LENGTH PATH_LENGTH - 12
NSSM 1.0.
22 years ago
#define _WIN32_WINNT 0x0500
Force UTF-16 output. If we were compiled as a Unicode application, set stdout and stderr output mode to UTF-16 text. Doing so allows French and Italian accented characters to show up correctly on the console. We currently have no analogous method for fixing the output of NSSM when compiled as an ANSI application.
11 years ago
#include <fcntl.h>
#include <io.h>
Strip quotes from directory name. Windows directories aren't allowed to contain quotes so CreateProcess() will fail if the AppDirectory is quoted. Note that it succeeds even if Application itself is quoted as the application plus parameters are interpreted as a command line.
14 years ago
#include <shlwapi.h>
NSSM 1.0.
22 years ago
#include <stdarg.h>
#include <stdio.h>
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
#include <tchar.h>
NSSM 1.0.
22 years ago
#include <windows.h>
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
#include "service.h"
Handle well-known account names. Certain well-known accounts can be used to start a service without entering a password. "LocalSystem" is the default value of ObjectName in the registry. It is not a real account but is an alias for the "NT Authority\System" account. "NT Authority\Local Service" has minimal local and no network privileges. "NT Authority\Network Service" has minimal local and network privileges. NSSM now recognises these well-known accounts and will accept them as ObjectName parameters without complaining that no password was enter. With the exception of LocalSystem, each can be specified without the "NT Authority" pseudo-domain prefix.
11 years ago
#include "account.h"
Moved console functions to a new file. Functions for allocating and setting up a console are moved to console.cpp.
11 years ago
#include "console.h"
Moved environment functions to a new file. Moved format_environment(), unformat_environment() and test_environment() to env.cpp.
11 years ago
#include "env.h"
NSSM 1.0.
22 years ago
#include "event.h"
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
#include "imports.h"
Compile messages. Don't spam the event log with warnings about not finding application messages. Every message currently uses the default event ID 1.
15 years ago
#include "messages.h"
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
#include "process.h"
NSSM 1.0.
22 years ago
#include "registry.h"
Allow service editing on the command line. Individual service parameters can now be queried or edited on the command line. The syntax is designed to be intuitive and is described in some detail in the README. Some examples follow: nssm get Selenium Application nssm get "My Batch Job" AppExit 0 nssm get Jenkins AppEnvironmentExtra CLASSPATH nssm get Netlogon ImagePath nssm set UT2004 Application C:\Games\UT2004\System\UCC.exe nssm set UT2004 AppParameters server nssm set UT2004 AppExit Default Exit nssm set Jenkins ObjectName DOMAIN\ci correct horse battery staple nssm set "My Batch Job" AppExit 0 Exit nssm set WowzaMediaServer362 Start SERVICE_DELAYED_START nssm set UT2004 Type SERVICE_INTERACTIVE_PROCESS nssm reset UT2004 AppEnvironment nssm reset UT2004 ObjectName
11 years ago
#include "settings.h"
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
#include "io.h"
NSSM 1.0.
22 years ago
#include "gui.h"
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 str_equiv(const TCHAR *, const TCHAR *);
void strip_basename(TCHAR *);
Overload str_number(). Allow passing the bogus pointer to str_number() in case we want to inspect it later.
11 years ago
int str_number(const TCHAR *, unsigned long *, TCHAR **);
Added str_number(). Wrapper function around _tcstoul().
11 years ago
int str_number(const TCHAR *, unsigned long *);
Allow setting processor affinity. The REG_SZ AppPriority entry specifies a list of processors which will be converted to a mask and passed to SetProcessAffinityMask(). Processors are numbered from 0, must not exceed 63, and are separated with commas or dashes, to specify a range. Thanks Robert Middleton.
11 years ago
int num_cpus();
Allow editing services. "nssm edit <service>" brings up a GUI to edit an existing service. Services not managed by NSSM can also be edited but only system properties such as the display name will appear in the GUI.
11 years ago
int usage(int);
NSSM 2.0.
19 years ago
Extra product description tags. Call ourselves NSSM not nssm. Add 32/64-bit and release/debug specifiers. Since we are adding them to the resource files as well we need to add the _WIN64 preprocessor definition to the resources definition list explicitly. To ensure that messages sent to the event log remain consistent we define the event source separately and set it to the old lowercase name.
11 years ago
#define NSSM _T("NSSM")
#ifdef _WIN64
#define NSSM_ARCHITECTURE _T("64-bit")
#else
#define NSSM_ARCHITECTURE _T("32-bit")
#endif
#ifdef _DEBUG
#define NSSM_DEBUG _T(" debug")
#else
#define NSSM_DEBUG _T("")
#endif
#define NSSM_CONFIGURATION NSSM_ARCHITECTURE NSSM_DEBUG
Generate version information as part of the build. Use git (if it's available) to create a major and minor version number based on the most recent tag name. If we are not building from a tagged commit, use the commit count since the last tag as the subminor version. If Jenkins is being used for the build, use the build number as the subsubminor version.
11 years ago
#include "version.h"
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 the restart of the service if it stops before this many
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
milliseconds have elapsed since startup. Override in registry.
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
*/
#define NSSM_RESET_THROTTLE_RESTART 1500
Try to send Control-C event to application console. Try to attach to the application's console and send a Control-C event when shutting down. If a console exists, is successfully attached and successfully sent the event, allow a grace period for the application to exit before sending window messages or eventually calling TerminateProcess(). Now console applications which register shutdown handlers, such as java launched from a batch file, have a chance to clean up and shut down gracefully. Thanks Eric Cheldelin.
12 years ago
/*
How many milliseconds to wait for the application to die after sending
Allow overriding time to wait when trying to kill the application. Three new registry entries can be used to specify a wait time in milliseconds after attempting a stop method. AppStopMethodConsole AppStopMethodWindow AppStopMethodThreads The default for each remains the same, 1500ms. Thanks Russ Holmann.
11 years ago
a Control-C event to its console. Override in registry.
Try to send Control-C event to application console. Try to attach to the application's console and send a Control-C event when shutting down. If a console exists, is successfully attached and successfully sent the event, allow a grace period for the application to exit before sending window messages or eventually calling TerminateProcess(). Now console applications which register shutdown handlers, such as java launched from a batch file, have a chance to clean up and shut down gracefully. Thanks Eric Cheldelin.
12 years ago
*/
#define NSSM_KILL_CONSOLE_GRACE_PERIOD 1500
Try to kill the process tree gracefully. Before calling TerminateProcess() on all processes assocatiated with the monitored application, enumerate all windows and threads and post appropriate messages to them. If the application bothers to listen for such messages it has a chance to shut itself down gracefully. If the application ignores this chance to do the right thing it's fair game for termination.
14 years ago
/*
How many milliseconds to wait for the application to die after posting to
Allow overriding time to wait when trying to kill the application. Three new registry entries can be used to specify a wait time in milliseconds after attempting a stop method. AppStopMethodConsole AppStopMethodWindow AppStopMethodThreads The default for each remains the same, 1500ms. Thanks Russ Holmann.
11 years ago
its windows' message queues. Override in registry.
Try to kill the process tree gracefully. Before calling TerminateProcess() on all processes assocatiated with the monitored application, enumerate all windows and threads and post appropriate messages to them. If the application bothers to listen for such messages it has a chance to shut itself down gracefully. If the application ignores this chance to do the right thing it's fair game for termination.
14 years ago
*/
#define NSSM_KILL_WINDOW_GRACE_PERIOD 1500
/*
How many milliseconds to wait for the application to die after posting to
Allow overriding time to wait when trying to kill the application. Three new registry entries can be used to specify a wait time in milliseconds after attempting a stop method. AppStopMethodConsole AppStopMethodWindow AppStopMethodThreads The default for each remains the same, 1500ms. Thanks Russ Holmann.
11 years ago
its threads' message queues. Override in registry.
Try to kill the process tree gracefully. Before calling TerminateProcess() on all processes assocatiated with the monitored application, enumerate all windows and threads and post appropriate messages to them. If the application bothers to listen for such messages it has a chance to shut itself down gracefully. If the application ignores this chance to do the right thing it's fair game for termination.
14 years ago
*/
#define NSSM_KILL_THREADS_GRACE_PERIOD 1500
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
/* Margin of error for service status wait hints in milliseconds. */
#define NSSM_WAITHINT_MARGIN 2000
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
/* Methods used to try to stop the application. */
#define NSSM_STOP_METHOD_CONSOLE (1 << 0)
#define NSSM_STOP_METHOD_WINDOW (1 << 1)
#define NSSM_STOP_METHOD_THREADS (1 << 2)
#define NSSM_STOP_METHOD_TERMINATE (1 << 3)
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
/* Startup types. */
#define NSSM_STARTUP_AUTOMATIC 0
#define NSSM_STARTUP_DELAYED 1
#define NSSM_STARTUP_MANUAL 2
#define NSSM_STARTUP_DISABLED 3
GUI overhaul. We now have a much less sucky GUI with tabs, combo boxes and all sorts of whizzbang stuff. The new GUI allows setting most of the advanced features we support directly from the service installer without having to poke about in the registry.
11 years ago
/* Exit actions. */
#define NSSM_EXIT_RESTART 0
#define NSSM_EXIT_IGNORE 1
#define NSSM_EXIT_REALLY 2
#define NSSM_EXIT_UNCLEAN 3
#define NSSM_NUM_EXIT_ACTIONS 4
Allow setting application priority. The REG_DWORD AppPriority entry corresponds to a priority class as accepted by SetProcessPriorityClass(). If a valid value is set, it will be passed to CreateProcess() and the application will start with the requested priority.
11 years ago
/* Process priority. */
#define NSSM_REALTIME_PRIORITY 0
#define NSSM_HIGH_PRIORITY 1
#define NSSM_ABOVE_NORMAL_PRIORITY 2
#define NSSM_NORMAL_PRIORITY 3
#define NSSM_BELOW_NORMAL_PRIORITY 4
#define NSSM_IDLE_PRIORITY 5
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
/* How many milliseconds to wait before updating service status. */
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
#define NSSM_SERVICE_STATUS_DEADLINE 20000
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
Enable on-demand rotation. Running "nssm rotate <service>" will send user-defined service control 128 to the service, triggering a rotation of output files after the next call to ReadFile(), regardless of the value of AppRotateBytes*. Note that since ReadFile() is synchronous, we have no way to interrupt it, hence there may be a significant delay before the rotation happens.
11 years ago
/* User-defined service controls can be in the range 128-255. */
Added fake NSSM_SERVICE_CONTROL_START constant. There's no SERVICE_CONTROL_START constant so we were explicitly checking for a fake control code of 0 when handling service start. Now that we have defined a custom control code (NSSM_SERVICE_CONTROL_ROTATE) we can add NSSM_SERVICE_CONTROL_START for readability and consistency.
11 years ago
#define NSSM_SERVICE_CONTROL_START 0
Enable on-demand rotation. Running "nssm rotate <service>" will send user-defined service control 128 to the service, triggering a rotation of output files after the next call to ReadFile(), regardless of the value of AppRotateBytes*. Note that since ReadFile() is synchronous, we have no way to interrupt it, hence there may be a significant delay before the rotation happens.
11 years ago
#define NSSM_SERVICE_CONTROL_ROTATE 128
NSSM 1.0.
22 years ago
#endif