X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=service.cpp;h=8e56cf7d4508815aac4819dee71f9a39f7080f60;hb=fdf66ebb177e189479057ebe4e1124251c0116c3;hp=ad5f2c2580726fc3d7400e238039d6755d12164e;hpb=06a62a665e152850d082607eced4fa4654f1bf70;p=nssm.git diff --git a/service.cpp b/service.cpp index ad5f2c2..8e56cf7 100644 --- a/service.cpp +++ b/service.cpp @@ -2,21 +2,23 @@ SERVICE_STATUS service_status; SERVICE_STATUS_HANDLE service_handle; +HANDLE process_handle; HANDLE wait_handle; -HANDLE pid; -static char service_name[MAX_PATH]; -char exe[MAX_PATH]; -char flags[MAX_PATH]; +unsigned long pid; +static char service_name[SERVICE_NAME_LENGTH]; +char exe[EXE_LENGTH]; +char flags[CMD_LENGTH]; char dir[MAX_PATH]; +bool stopping; -static enum { NSSM_EXIT_RESTART, NSSM_EXIT_IGNORE, NSSM_EXIT_REALLY } exit_actions; -static const char *exit_action_strings[] = { "Restart", "Ignore", "Exit", 0 }; +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 }; /* Connect to the service manager */ SC_HANDLE open_service_manager() { SC_HANDLE ret = OpenSCManager(0, SERVICES_ACTIVE_DATABASE, SC_MANAGER_ALL_ACCESS); if (! ret) { - eventprintf(EVENTLOG_ERROR_TYPE, NSSM_MESSAGE_DEFAULT, "Unable to connect to service manager!\nPerhaps you need to be an administrator..."); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENSCMANAGER_FAILED, 0); return 0; } @@ -59,10 +61,10 @@ int install_service(char *name, char *exe, char *flags) { GetModuleFileName(0, path, MAX_PATH); /* Construct command */ - char command[MAX_PATH]; + char command[CMD_LENGTH]; size_t runlen = strlen(NSSM_RUN); size_t pathlen = strlen(path); - if (pathlen + runlen + 2 >= MAX_PATH) { + if (pathlen + runlen + 2 >= VALUE_LENGTH) { fprintf(stderr, "The full path to " NSSM " is too long!\n"); return 3; } @@ -139,14 +141,13 @@ int remove_service(char *name) { /* Service initialisation */ void WINAPI service_main(unsigned long argc, char **argv) { if (_snprintf(service_name, sizeof(service_name), "%s", argv[0]) < 0) { - eventprintf(EVENTLOG_ERROR_TYPE, NSSM_MESSAGE_DEFAULT, "service_main(): Out of memory for service_name!"); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service_name", "service_main()", 0); return; } /* Initialise status */ ZeroMemory(&service_status, sizeof(service_status)); service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS | SERVICE_INTERACTIVE_PROCESS; - service_status.dwCurrentState = SERVICE_RUNNING; service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP; service_status.dwWin32ExitCode = NO_ERROR; service_status.dwServiceSpecificExitCode = 0; @@ -154,40 +155,69 @@ void WINAPI service_main(unsigned long argc, char **argv) { service_status.dwWaitHint = 1000; /* Signal we AREN'T running the server */ + process_handle = 0; pid = 0; + /* Register control handler */ + service_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, 0); + if (! service_handle) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, GetLastError(), 0); + return; + } + /* Get startup parameters */ int ret = get_parameters(argv[0], exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir)); if (ret) { - eventprintf(EVENTLOG_ERROR_TYPE, NSSM_MESSAGE_DEFAULT, "service_main(): Can't get startup parameters: error %d", ret); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, argv[0], 0); + service_status.dwCurrentState = SERVICE_STOPPED; + /* An accurate, if not particularly helpful, status */ + service_status.dwWin32ExitCode = ERROR_SERVICE_NOT_ACTIVE; + SetServiceStatus(service_handle, &service_status); return; } - /* Register control handler */ - service_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, 0); - if (! service_handle) { - eventprintf(EVENTLOG_ERROR_TYPE, NSSM_MESSAGE_DEFAULT, "service_main(): RegisterServiceCtrlHandlerEx() failed: %s", error_string(GetLastError())); - return; - } + service_status.dwCurrentState = SERVICE_START_PENDING; + SetServiceStatus(service_handle, &service_status); /* Try to create the exit action parameters; we don't care if it fails */ create_exit_action(argv[0], exit_action_strings[0]); + set_service_recovery(service_name); + monitor_service(); } +/* Make sure service recovery actions are taken where necessary */ +void set_service_recovery(char *service_name) { + SC_HANDLE services = open_service_manager(); + if (! services) return; + + SC_HANDLE service = OpenService(services, service_name, SC_MANAGER_ALL_ACCESS); + if (! service) return; + return; + + SERVICE_FAILURE_ACTIONS_FLAG flag; + ZeroMemory(&flag, sizeof(flag)); + flag.fFailureActionsOnNonCrashFailures = true; + + /* This functionality was added in Vista so the call may fail */ + ChangeServiceConfig2(service, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag); +} + int monitor_service() { /* Set service status to started */ int ret = start_service(); if (ret) { - eventprintf(EVENTLOG_ERROR_TYPE, NSSM_MESSAGE_DEFAULT, "Can't start service %s: error code %d", service_name, ret); + char code[16]; + snprintf(code, sizeof(code), "%d", ret); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0); return ret; } - eventprintf(EVENTLOG_INFORMATION_TYPE, NSSM_MESSAGE_DEFAULT, "Started process %s %s in %s for service %s", exe, flags, dir, service_name); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, exe, flags, service_name, dir, 0); /* Monitor service service */ - if (! RegisterWaitForSingleObject(&wait_handle, pid, end_service, 0, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) { - eventprintf(EVENTLOG_WARNING_TYPE, NSSM_MESSAGE_DEFAULT, "RegisterWaitForSingleObject() returned %s - service may claim to be still running when %s exits ", error_string(GetLastError()), exe); + if (! RegisterWaitForSingleObject(&wait_handle, process_handle, end_service, (void *) pid, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) { + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service_name, exe, GetLastError(), 0); } return 0; @@ -198,7 +228,7 @@ unsigned long WINAPI service_control_handler(unsigned long control, unsigned lon switch (control) { case SERVICE_CONTROL_SHUTDOWN: case SERVICE_CONTROL_STOP: - stop_service(0); + stop_service(0, true, true); return NO_ERROR; } @@ -208,7 +238,9 @@ unsigned long WINAPI service_control_handler(unsigned long control, unsigned lon /* Start the service */ int start_service() { - if (pid) return 0; + stopping = false; + + if (process_handle) return 0; /* Allocate a STARTUPINFO structure for a new process */ STARTUPINFO si; @@ -220,16 +252,17 @@ int start_service() { ZeroMemory(&pi, sizeof(pi)); /* Launch executable with arguments */ - char cmd[MAX_PATH]; + char cmd[CMD_LENGTH]; if (_snprintf(cmd, sizeof(cmd), "%s %s", exe, flags) < 0) { - eventprintf(EVENTLOG_ERROR_TYPE, NSSM_MESSAGE_DEFAULT, "Error constructing command line"); - return stop_service(2); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "start_service", 0); + return stop_service(2, true, true); } - if (! CreateProcess(0, cmd, 0, 0, 0, 0, 0, dir, &si, &pi)) { - eventprintf(EVENTLOG_ERROR_TYPE, NSSM_MESSAGE_DEFAULT, "Can't launch %s. CreateProcess() returned %s", exe, error_string(GetLastError())); - return stop_service(3); + if (! CreateProcess(0, cmd, 0, 0, false, 0, 0, dir, &si, &pi)) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, exe, GetLastError(), 0); + return stop_service(3, true, true); } - pid = pi.hProcess; + process_handle = pi.hProcess; + pid = pi.dwProcessId; /* Signal successful start */ service_status.dwCurrentState = SERVICE_RUNNING; @@ -239,45 +272,78 @@ int start_service() { } /* Stop the service */ -int stop_service(unsigned long exitcode) { +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; + } + /* Signal we are stopping */ - service_status.dwCurrentState = SERVICE_STOP_PENDING; - SetServiceStatus(service_handle, &service_status); + if (graceful) { + service_status.dwCurrentState = SERVICE_STOP_PENDING; + SetServiceStatus(service_handle, &service_status); + } /* Nothing to do if server isn't running */ if (pid) { /* Shut down server */ - TerminateProcess(pid, 0); - pid = 0; + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service_name, exe, 0); + kill_process(service_name, process_handle, pid, 0); + process_handle = 0; } + else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0); + + end_service((void *) pid, true); /* Signal we stopped */ - 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; + 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); } - SetServiceStatus(service_handle, &service_status); return exitcode; } /* Callback function triggered when the server exits */ void CALLBACK end_service(void *arg, unsigned char why) { + if (stopping) return; + + stopping = true; + + pid = (unsigned long) arg; + /* Check exit code */ - unsigned long ret = 0; - GetExitCodeProcess(pid, &ret); + unsigned long exitcode = 0; + GetExitCodeProcess(process_handle, &exitcode); - eventprintf(EVENTLOG_INFORMATION_TYPE, NSSM_MESSAGE_DEFAULT, "Process %s for service %s exited with return code %u", exe, service_name, ret); + /* Clean up. */ + kill_process_tree(service_name, pid, exitcode, pid); + + /* + 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; + + char code[16]; + _snprintf(code, sizeof(code), "%d", exitcode); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0); /* What action should we take? */ int action = NSSM_EXIT_RESTART; unsigned char action_string[ACTION_LEN]; - if (! get_exit_action(service_name, &ret, action_string)) { + bool default_action; + if (! get_exit_action(service_name, &exitcode, action_string, &default_action)) { for (int i = 0; exit_action_strings[i]; i++) { if (! _strnicmp((const char *) action_string, exit_action_strings[i], ACTION_LEN)) { action = i; @@ -286,27 +352,34 @@ void CALLBACK end_service(void *arg, unsigned char why) { } } + process_handle = 0; pid = 0; switch (action) { /* Try to restart the service or return failure code to service manager */ case NSSM_EXIT_RESTART: - eventprintf(EVENTLOG_INFORMATION_TYPE, NSSM_MESSAGE_DEFAULT, "Action for exit code %lu is %s: Attempting to restart %s for service %s", ret, exit_action_strings[action], exe, service_name); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_RESTART, service_name, code, exit_action_strings[action], exe, 0); while (monitor_service()) { - eventprintf(EVENTLOG_INFORMATION_TYPE, NSSM_MESSAGE_DEFAULT, "Failed to restart %s - sleeping ", exe, ret); + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_RESTART_SERVICE_FAILED, exe, service_name, 0); Sleep(30000); } break; /* Do nothing, just like srvany would */ case NSSM_EXIT_IGNORE: - eventprintf(EVENTLOG_INFORMATION_TYPE, NSSM_MESSAGE_DEFAULT, "Action for exit code %lu is %s: Not attempting to restart %s for service %s", ret, exit_action_strings[action], exe, service_name); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service_name, code, exit_action_strings[action], exe, 0); Sleep(INFINITE); break; /* Tell the service manager we are finished */ case NSSM_EXIT_REALLY: - eventprintf(EVENTLOG_INFORMATION_TYPE, NSSM_MESSAGE_DEFAULT, "Action for exit code %lu is %s: Stopping service %s", ret, exit_action_strings[action], service_name); - stop_service(ret); + log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service_name, code, exit_action_strings[action], 0); + stop_service(exitcode, true, default_action); + 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); + exit(stop_service(exitcode, false, default_action)); break; } }