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

71 lines
3.6 KiB
C
Raw Normal View History Unescape Escape

NSSM 1.0.
22 years ago
#ifndef REGISTRY_H
#define REGISTRY_H
Abstracted open_registry(). Added service_registry_path() to construct a registry path for a service which may contain the Parameters subkey and optional sub-subkey. If no Parameters subkey is needed the constructed path references the native service parameters. The open_registry() function is now a wrapper around the new open_registry_key() function which opens an arbitrary key. The new open_service_resgistry() function also wraps open_registry_key() to access native parameters.
10 years ago
#define NSSM_REGISTRY _T("SYSTEM\\CurrentControlSet\\Services\\%s")
#define NSSM_REG_PARAMETERS _T("Parameters")
Allow editing service dependencies. Service dependencies can now be queried or set on the command line via the DependOnService and DependOnGroup parameters, or via the GUI in the new Dependencies tab. Service dependencies can be set using either their key name or display name. For example: nssm set <servicename> DependOnService RpcSs which is equivalent to: nssm set <servicename> DependOnService "Remote Procedure Call (RPC)" Group dependencies can be set with or without the group identifier prefix, which for some reason is not actually described in the documentation; instead readers are invited to consult the header files for the value of SC_GROUP_IDENTIFIER, which it turns out is the + symbol. For example: nssm set <servicename> DependOnGroup +UIGroup which is equivalent to: nssm set <servicename> DependOnGroup UIGroup The prefix is always printed when query group dependencies. The GUI presents a editbox into which either service or group dependencies can be typed. The group prefix is mandatory when editing dependencies via the GUI.
11 years ago
#define NSSM_REGISTRY_GROUPS _T("SYSTEM\\CurrentControlSet\\Control\\ServiceGroupOrder")
#define NSSM_REG_GROUPS _T("List")
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
#define NSSM_REG_EXE _T("Application")
#define NSSM_REG_FLAGS _T("AppParameters")
#define NSSM_REG_DIR _T("AppDirectory")
#define NSSM_REG_ENV _T("AppEnvironment")
#define NSSM_REG_ENV_EXTRA _T("AppEnvironmentExtra")
#define NSSM_REG_EXIT _T("AppExit")
Added mandatory restart delay. The REG_DWORD AppRestartDelay entry specifies a minimum number of milliseconds by which we will delay the restart (not the initial start) of the managed application. If the application exited soon enough to trigger throttling, the actual delay will be whichever is longer of AppRestartDelay and the calculated throttle time. Thanks Andrew RedzMax.
11 years ago
#define NSSM_REG_RESTART_DELAY _T("AppRestartDelay")
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
#define NSSM_REG_THROTTLE _T("AppThrottle")
#define NSSM_REG_STOP_METHOD_SKIP _T("AppStopMethodSkip")
#define NSSM_REG_KILL_CONSOLE_GRACE_PERIOD _T("AppStopMethodConsole")
#define NSSM_REG_KILL_WINDOW_GRACE_PERIOD _T("AppStopMethodWindow")
#define NSSM_REG_KILL_THREADS_GRACE_PERIOD _T("AppStopMethodThreads")
Allow skipping kill_process_tree(). Don't try to kill the application's process tree - just the application itself - if the REG_DWORD value AppKillProcessTree is 0. Thanks Barrett Lewis.
11 years ago
#define NSSM_REG_KILL_PROCESS_TREE _T("AppKillProcessTree")
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
#define NSSM_REG_STDIN _T("AppStdin")
#define NSSM_REG_STDOUT _T("AppStdout")
#define NSSM_REG_STDERR _T("AppStderr")
#define NSSM_REG_STDIO_SHARING _T("ShareMode")
#define NSSM_REG_STDIO_DISPOSITION _T("CreationDisposition")
#define NSSM_REG_STDIO_FLAGS _T("FlagsAndAttributes")
Copy/truncate file rotation. Some processes, notably Logstash, open files for reading without setting the FILE_SHARE_READ share mode. If NSSM is using such a file for I/O redirection and it tries to rotate the file, its MoveFile() call will fail. If the new (REG_DWORD) value(s) AppStdoutCopyAndTruncate and/or AppStderrCopyAndTruncate are non-zero, NSSM will instead try to rotate the file(s) by calling CopyFile() to create a copy of the file then calling SetEndOfFile() to truncate the original file to zero size. Doing so allows the rotation to succeed at the cost of time and disk space to create a full copy of the file. If the new (REG_DWORD) value AppRotateDelay is non-zero, NSSM will sleep for the given number of milliseconds after rotation, regardless of the rotation method used. Testing with Logstash specifically has shown that introducing a delay of 1000ms may be sufficient to avoid an issue whereby the reading application loses the final line of input from the old file due to not noticing that it has been truncated. Thanks Miguel Angel Terrón.
11 years ago
#define NSSM_REG_STDIO_COPY_AND_TRUNCATE _T("CopyAndTruncate")
Redirect hooks' output. If AppRedirectHook is 1 and stdout and/or stderr are being redirected, also redirect the output of hooks. Doing so requires using a logging thread and so implies online rotation if log rotation is used. Thanks Nabil Redmann.
9 years ago
#define NSSM_REG_HOOK_SHARE_OUTPUT_HANDLES _T("AppRedirectHook")
Rotate output files. The files specified by AppStdout and AppStderr can now be rotated prior to launching the application. An existing file will be renamed with a new suffix based on its last write time, to millisecond precision. Rotation is controlled independently of the CreateFile() arguments used when opening the files for writing. It is possible to configure rotation regardless of whether existing files would be appended or replaced. Four new REG_DWORD entries control how rotation happens. If AppRotateFiles is 0 or missing, rotation is disabled. If AppRotateSeconds is non-zero, a file will not be rotated if its last write time is less than the given number of seconds in the past. If AppRotateBytes is non-zero, a file will not be rotated if it is smaller than the given number of bytes. 64-bit file sizes can be handled by specifying a high order part in AppRotateBytesHigh. Thanks Doug Watson.
11 years ago
#define NSSM_REG_ROTATE _T("AppRotateFiles")
Rotate files while the service is running. If AppRotateOnline is set, set up a pipe between the application's stdout/stderr and a new thread which reads all input and writes to the configured output file(s). If a file breaches the configured AppRotateBytes threshold while the service is running, close and rotate the file then resume logging to a new file. This behaviour is not the default due to the potential for things to go wrong. We have to juggle file handles and might hit a read or write error which causes logging to fail thus losing all output until the service is restarted, etc etc. Thanks Doug Watson.
11 years ago
#define NSSM_REG_ROTATE_ONLINE _T("AppRotateOnline")
Rotate output files. The files specified by AppStdout and AppStderr can now be rotated prior to launching the application. An existing file will be renamed with a new suffix based on its last write time, to millisecond precision. Rotation is controlled independently of the CreateFile() arguments used when opening the files for writing. It is possible to configure rotation regardless of whether existing files would be appended or replaced. Four new REG_DWORD entries control how rotation happens. If AppRotateFiles is 0 or missing, rotation is disabled. If AppRotateSeconds is non-zero, a file will not be rotated if its last write time is less than the given number of seconds in the past. If AppRotateBytes is non-zero, a file will not be rotated if it is smaller than the given number of bytes. 64-bit file sizes can be handled by specifying a high order part in AppRotateBytesHigh. Thanks Doug Watson.
11 years ago
#define NSSM_REG_ROTATE_SECONDS _T("AppRotateSeconds")
#define NSSM_REG_ROTATE_BYTES_LOW _T("AppRotateBytes")
#define NSSM_REG_ROTATE_BYTES_HIGH _T("AppRotateBytesHigh")
Copy/truncate file rotation. Some processes, notably Logstash, open files for reading without setting the FILE_SHARE_READ share mode. If NSSM is using such a file for I/O redirection and it tries to rotate the file, its MoveFile() call will fail. If the new (REG_DWORD) value(s) AppStdoutCopyAndTruncate and/or AppStderrCopyAndTruncate are non-zero, NSSM will instead try to rotate the file(s) by calling CopyFile() to create a copy of the file then calling SetEndOfFile() to truncate the original file to zero size. Doing so allows the rotation to succeed at the cost of time and disk space to create a full copy of the file. If the new (REG_DWORD) value AppRotateDelay is non-zero, NSSM will sleep for the given number of milliseconds after rotation, regardless of the rotation method used. Testing with Logstash specifically has shown that introducing a delay of 1000ms may be sufficient to avoid an issue whereby the reading application loses the final line of input from the old file due to not noticing that it has been truncated. Thanks Miguel Angel Terrón.
11 years ago
#define NSSM_REG_ROTATE_DELAY _T("AppRotateDelay")
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
#define NSSM_REG_PRIORITY _T("AppPriority")
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
#define NSSM_REG_AFFINITY _T("AppAffinity")
Allocate new console by default. Since the whole purpose of NSSM is to be able to make services out of applications which expect to have a standard desktop environment, let's simply allocate a new console for each one rather than do so only when we try to redirect I/O. A funky ASCII art banner identifies the console as belonging to the service. NSSM itself will detach from the console as soon as possible, so if the service runs a graphical application the console may never be seen. The console can be suppressed by setting the REG_DWORD value AppNoConsole to 1. Note that services running console applications on Windows 2000 may fail if the console is disabled.
11 years ago
#define NSSM_REG_NO_CONSOLE _T("AppNoConsole")
Run hooks in response to certain events. User-configurable hooks will be run before and/or after certain events, eg after the application starts successfully. Hooks will run with the environment of the application, with additional environment variables providing information about the service status and the hook which has been called.
10 years ago
#define NSSM_REG_HOOK _T("AppEvents")
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
#define NSSM_STDIO_LENGTH 29
NSSM 1.0.
22 years ago
Abstracted open_registry(). Added service_registry_path() to construct a registry path for a service which may contain the Parameters subkey and optional sub-subkey. If no Parameters subkey is needed the constructed path references the native service parameters. The open_registry() function is now a wrapper around the new open_registry_key() function which opens an arbitrary key. The new open_service_resgistry() function also wraps open_registry_key() to access native parameters.
10 years ago
HKEY open_service_registry(const TCHAR *, REGSAM sam, bool);
Alternative open_registry_key() signature. Allow passing a pointer to an HKEY and having the function return the result of RegCreateKeyEx()/RegOpenKeyEx(). Existing functions wrap the new invocation so no code changes are needed. The new function can be used to handle ERROR_FILE_NOT_FOUND as success when must_exist is false.
9 years ago
long open_registry(const TCHAR *, const TCHAR *, REGSAM sam, HKEY *, bool);
Don't create registry keys needlessly. Don't log an error when trying to access a registry key which doesn't exist when it's expected that it might not be present. Don't open a key with RegCreateKeyEx() when we are potentially going to delete a value. Instead try RegOpenKeyEx() and return success if it already isn't present.
10 years ago
HKEY open_registry(const TCHAR *, const TCHAR *, REGSAM sam, bool);
Added open_registry() function. Moved RegOpenKeyEx() and RegCreateKeyEx() to a separate function open_registry().
11 years ago
HKEY open_registry(const TCHAR *, const TCHAR *, REGSAM sam);
HKEY open_registry(const TCHAR *, REGSAM sam);
Added enumerate_registry_values(). New function to retrieve values under a key.
9 years ago
long enumerate_registry_values(HKEY, unsigned long *, TCHAR *, unsigned long);
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
int create_messages();
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 create_parameters(nssm_service_t *, bool);
int create_exit_action(TCHAR *, const TCHAR *, bool);
Renamed set_environment(). The set_environment() function was poorly named. It gets the environment settings from the registry but doesn't actually set any variables. It is more appropriately named get_environment().
11 years ago
int get_environment(TCHAR *, HKEY, TCHAR *, TCHAR **, unsigned long *);
Added get_string() and set_string(). Abstract expand_parameter() and set_expand_string() to allow working with registry values of type REG_SZ as well a REG_EXPAND_SZ.
11 years ago
int get_string(HKEY, TCHAR *, TCHAR *, unsigned long, bool, bool, bool);
int get_string(HKEY, TCHAR *, TCHAR *, unsigned long, bool);
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 expand_parameter(HKEY, TCHAR *, TCHAR *, unsigned long, bool, bool);
int expand_parameter(HKEY, TCHAR *, TCHAR *, unsigned long, bool);
Added get_string() and set_string(). Abstract expand_parameter() and set_expand_string() to allow working with registry values of type REG_SZ as well a REG_EXPAND_SZ.
11 years ago
int set_string(HKEY, TCHAR *, TCHAR *, bool);
int set_string(HKEY, TCHAR *, TCHAR *);
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 set_expand_string(HKEY, TCHAR *, TCHAR *);
int set_number(HKEY, TCHAR *, unsigned long);
int get_number(HKEY, TCHAR *, unsigned long *, bool);
int get_number(HKEY, TCHAR *, unsigned long *);
Renamed un/format_environment(). The format_environment() and unformat_environment() functions could be used to format any double null-terminated string list, and are not specificially tied to formatting environment blocks.
11 years ago
int format_double_null(TCHAR *, unsigned long, TCHAR **, unsigned long *);
int unformat_double_null(TCHAR *, unsigned long, TCHAR **, unsigned long *);
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
void override_milliseconds(TCHAR *, HKEY, TCHAR *, unsigned long *, unsigned long, unsigned long);
Split get_output_handles() into get_io_parameters(). Separate retrieving parameters from the registry and opening output handles. Restart throttling happens after calling get_output_handles(), so if the service was throttled we'd end up with a useless console window appearing during the pause.
11 years ago
int get_io_parameters(nssm_service_t *, HKEY);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int get_parameters(nssm_service_t *, STARTUPINFO *);
Added open_registry() function. Moved RegOpenKeyEx() and RegCreateKeyEx() to a separate function open_registry().
11 years ago
int get_exit_action(const TCHAR *, unsigned long *, TCHAR *, bool *);
Run hooks in response to certain events. User-configurable hooks will be run before and/or after certain events, eg after the application starts successfully. Hooks will run with the environment of the application, with additional environment variables providing information about the service status and the hook which has been called.
10 years ago
int set_hook(const TCHAR *, const TCHAR *, const TCHAR *, TCHAR *);
int get_hook(const TCHAR *, const TCHAR *, const TCHAR *, TCHAR *, unsigned long);
NSSM 1.0.
22 years ago
#endif