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

142 lines
4.9 KiB
C
Raw Normal View History Unescape Escape

NSSM 1.0.
22 years ago
#ifndef SERVICE_H
#define SERVICE_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
/*
MSDN says the commandline in CreateProcess() is limited to 32768 characters
and the application name to MAX_PATH.
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
A service name and service display name are limited to 256 characters.
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
A registry key is limited to 255 characters.
A registry value is limited to 16383 characters.
Therefore we limit the service name to accommodate the path under HKLM.
*/
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
#define EXE_LENGTH PATH_LENGTH
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
#define CMD_LENGTH 32768
#define KEY_LENGTH 255
#define VALUE_LENGTH 16383
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
#define SERVICE_NAME_LENGTH 256
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
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
#define ACTION_LEN 16
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
#define NSSM_KERNEL_DRIVER _T("SERVICE_KERNEL_DRIVER")
#define NSSM_FILE_SYSTEM_DRIVER _T("SERVICE_FILE_SYSTEM_DRIVER")
#define NSSM_WIN32_OWN_PROCESS _T("SERVICE_WIN32_OWN_PROCESS")
#define NSSM_WIN32_SHARE_PROCESS _T("SERVICE_WIN32_SHARE_PROCESS")
#define NSSM_INTERACTIVE_PROCESS _T("SERVICE_INTERACTIVE_PROCESS")
#define NSSM_SHARE_INTERACTIVE_PROCESS NSSM_WIN32_SHARE_PROCESS _T("|") NSSM_INTERACTIVE_PROCESS
#define NSSM_UNKNOWN _T("?")
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
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_ROTATE_OFFLINE 0
#define NSSM_ROTATE_ONLINE 1
#define NSSM_ROTATE_ONLINE_ASAP 2
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
typedef struct {
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
bool native;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR name[SERVICE_NAME_LENGTH];
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
TCHAR displayname[SERVICE_NAME_LENGTH];
Set service details in the GUI. The GUI can now set the service display name, description and startup type.
11 years ago
TCHAR description[VALUE_LENGTH];
unsigned long startup;
Set log on details in the GUI. The GUI can now set service logon and desktop interactive details.
11 years ago
TCHAR *username;
size_t usernamelen;
TCHAR *password;
size_t passwordlen;
unsigned long type;
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
TCHAR image[PATH_LENGTH];
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR exe[EXE_LENGTH];
TCHAR flags[VALUE_LENGTH];
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
TCHAR dir[DIR_LENGTH];
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR *env;
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
__int64 affinity;
Allow appending to the service environment. The new registry value AppEnvironmentExtra allows defining a list of environment variables which will be appended to the environment, as opposed to those defined by the srvany-compatible AppEnvironment, which replaces the environment. Though it would serve no useful purpose beyond verifying whether or not I went to the effort of writing a code path for it, it is possible to define bother lists and have them behave intuitively.
11 years ago
unsigned long envlen;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
TCHAR *env_extra;
Allow appending to the service environment. The new registry value AppEnvironmentExtra allows defining a list of environment variables which will be appended to the environment, as opposed to those defined by the srvany-compatible AppEnvironment, which replaces the environment. Though it would serve no useful purpose beyond verifying whether or not I went to the effort of writing a code path for it, it is possible to define bother lists and have them behave intuitively.
11 years ago
unsigned long env_extralen;
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
unsigned long priority;
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
unsigned long no_console;
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
TCHAR stdin_path[PATH_LENGTH];
Allow configuring output file truncation. A new checkbox in the GUI allows specifying that stdout and stderr should be truncated rather than appended. The registry must still be used to set different disposition for each or to control the disposition of stdin.
11 years ago
unsigned long stdin_sharing;
unsigned long stdin_disposition;
unsigned long stdin_flags;
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
TCHAR stdout_path[PATH_LENGTH];
Allow configuring output file truncation. A new checkbox in the GUI allows specifying that stdout and stderr should be truncated rather than appended. The registry must still be used to set different disposition for each or to control the disposition of stdin.
11 years ago
unsigned long stdout_sharing;
unsigned long stdout_disposition;
unsigned long stdout_flags;
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
HANDLE stdout_pipe;
HANDLE stdout_thread;
unsigned long stdout_tid;
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
TCHAR stderr_path[PATH_LENGTH];
Allow configuring output file truncation. A new checkbox in the GUI allows specifying that stdout and stderr should be truncated rather than appended. The registry must still be used to set different disposition for each or to control the disposition of stdin.
11 years ago
unsigned long stderr_sharing;
unsigned long stderr_disposition;
unsigned long stderr_flags;
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
HANDLE stderr_pipe;
HANDLE stderr_thread;
unsigned long stderr_tid;
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
bool rotate_files;
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
unsigned long rotate_stdout_online;
unsigned long rotate_stderr_online;
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
unsigned long rotate_seconds;
unsigned long rotate_bytes_low;
unsigned long rotate_bytes_high;
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
unsigned long default_exit_action;
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
unsigned long restart_delay;
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
unsigned long throttle_delay;
unsigned long stop_method;
unsigned long kill_console_delay;
unsigned long kill_window_delay;
unsigned long kill_threads_delay;
SC_HANDLE handle;
SERVICE_STATUS status;
SERVICE_STATUS_HANDLE status_handle;
HANDLE process_handle;
unsigned long pid;
HANDLE wait_handle;
bool stopping;
bool allow_restart;
unsigned long throttle;
CRITICAL_SECTION throttle_section;
bool throttle_section_initialised;
CONDITION_VARIABLE throttle_condition;
HANDLE throttle_timer;
LARGE_INTEGER throttle_duetime;
FILETIME creation_time;
FILETIME exit_time;
Revamped environment variables again. A previous commit changed how environment variables were managed. Initially we were calling SetEnvironmentVariable() on each variable defined in AppEnvironmentExtra prior to starting the service. That behaviour was changed because it was technically incorrect, potentially resulting in NSSM's own environment being harmed. Unfortunately the changed method, creating a new environment block by calling GetEnvironmentStrings() (or using the block from AppEnvironment if that and AppEnvironmentExtra were both defined), failed if users did something like set AppEnvironmentExtra to PATH=C:\bin;%PATH%. That would result in the process being started with a block which included TWO occurrences of the PATH variable; the system-defined one and the appended one. The latter would be ignored, possibly causing the application to fail to start. For this third attempt we now call GetEnvironmentStrings() once at startup, storing the block in a new variable which is only freed at exit. Immediately prior to calling CreateProcess() to start the service we use the new environment functions duplicate_environment() (on AppEnvironment) and set_environment_block() (on AppEnvironmentExtra) to set the variables. Then immediately after calling CreateProcess() we call duplicate_environment() again to restore the original block. Because they are passed to expand_environment_string(), the environment blocks are subject to expansion. That means that setting PATH as described in the example above would work. Trying to append items to the PATH by setting AppEnvironment in a similar way will probably not work. Thanks Bryan Senseman.
11 years ago
TCHAR *initial_env;
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
} nssm_service_t;
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
void WINAPI service_main(unsigned long, TCHAR **);
TCHAR *service_control_text(unsigned long);
Added service_status_text(). Function to get a string representation of a service status, eg SERVICE_RUNNING.
11 years ago
TCHAR *service_status_text(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 log_service_control(TCHAR *, unsigned long, bool);
NSSM 1.0.
22 years ago
unsigned long WINAPI service_control_handler(unsigned long, unsigned long, void *, void *);
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 affinity_mask_to_string(__int64, TCHAR **);
int affinity_string_to_mask(TCHAR *, __int64 *);
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
unsigned long priority_mask();
int priority_constant_to_index(unsigned long);
unsigned long priority_index_to_constant(int);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
nssm_service_t *alloc_nssm_service();
Fixed bug when installing from the command line. We forgot to set default values when installing from the command line. Installing from the GUI worked. Thanks Paul Spause.
11 years ago
void set_nssm_service_defaults(nssm_service_t *);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void cleanup_nssm_service(nssm_service_t *);
Open services with minimal privileges. Ask for the minimal access rights required to manage a service, so users don't need to be administrators to perform operations permitted by the service (manager) ACL.
11 years ago
SC_HANDLE open_service_manager(unsigned long);
SC_HANDLE open_service(SC_HANDLE, TCHAR *, unsigned long, TCHAR *, unsigned long);
Moved QueryServiceConfig() to a separate function. The new function query_service_config() will return a pointer to a QUERY_SERVICE_CONFIG data structure.
11 years ago
QUERY_SERVICE_CONFIG *query_service_config(const TCHAR *, SC_HANDLE);
Added get_service_description(). New function to set or unset a service's description.
11 years ago
int set_service_description(const TCHAR *, SC_HANDLE, TCHAR *);
Added get_service_description(). New function to get the service description.
11 years ago
int get_service_description(const TCHAR *, SC_HANDLE, unsigned long, TCHAR *);
Added get_service_startup(). New function to retrieve the service startup type.
11 years ago
int get_service_startup(const TCHAR *, SC_HANDLE, const QUERY_SERVICE_CONFIG *, unsigned long *);
Added get_service_username(). New function to get the service username.
11 years ago
int get_service_username(const TCHAR *, const QUERY_SERVICE_CONFIG *, TCHAR **, size_t *);
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
int pre_install_service(int, TCHAR **);
int pre_remove_service(int, TCHAR **);
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 pre_edit_service(int, TCHAR **);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
int install_service(nssm_service_t *);
int remove_service(nssm_service_t *);
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 edit_service(nssm_service_t *, bool);
Allow controlling services. Send start/stop/query messages to services is easy so adding the ability to do so is a quick win.
11 years ago
int control_service(unsigned long, int, TCHAR **);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void set_service_recovery(nssm_service_t *);
int monitor_service(nssm_service_t *);
int start_service(nssm_service_t *);
int stop_service(nssm_service_t *, unsigned long, bool, bool);
NSSM 1.0.
22 years ago
void CALLBACK end_service(void *, unsigned char);
Pass parameters around in a data structure. Instead of static variables and functions taking a dozen arguments we now use a single data structure, nssm_service_t, for the service. The code is easier to read and understand, especially when adding more variables through to functions.
11 years ago
void throttle_restart(nssm_service_t *);
Allow compiling as a Unicode application. Overhaul the entire codebase so that it compiles and runs as either a Unicode or ANSI application.
11 years ago
int await_shutdown(nssm_service_t *, TCHAR *, unsigned long);
NSSM 1.0.
22 years ago
#endif