service.cpp

   1 #include "nssm.h"\r
   2 \r
   3 SERVICE_STATUS service_status;\r
   4 SERVICE_STATUS_HANDLE service_handle;\r
   5 HANDLE wait_handle;\r
   6 HANDLE pid;\r
   7 static char service_name[SERVICE_NAME_LENGTH];\r
   8 char exe[EXE_LENGTH];\r
   9 char flags[CMD_LENGTH];\r
  10 char dir[MAX_PATH];\r
  11 \r
  12 static enum { NSSM_EXIT_RESTART, NSSM_EXIT_IGNORE, NSSM_EXIT_REALLY, NSSM_EXIT_UNCLEAN } exit_actions;\r
  13 static const char *exit_action_strings[] = { "Restart", "Ignore", "Exit", "Suicide", 0 };\r
  14 \r
  15 /* Connect to the service manager */\r
  16 SC_HANDLE open_service_manager() {\r
  17   SC_HANDLE ret = OpenSCManager(0, SERVICES_ACTIVE_DATABASE, SC_MANAGER_ALL_ACCESS);\r
  18   if (! ret) {\r
  19     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENSCMANAGER_FAILED, 0);\r
  20     return 0;\r
  21   }\r
  22 \r
  23   return ret;\r
  24 }\r
  25 \r
  26 /* About to install the service */\r
  27 int pre_install_service(int argc, char **argv) {\r
  28   /* Show the dialogue box if we didn't give the */\r
  29   if (argc < 2) return nssm_gui(IDD_INSTALL, argv[0]);\r
  30 \r
  31   /* Arguments are optional */\r
  32   char *flags;\r
  33   if (argc == 2) flags = "";\r
  34   else flags = argv[2];\r
  35 \r
  36   return install_service(argv[0], argv[1], flags);\r
  37 }\r
  38 \r
  39 /* About to remove the service */\r
  40 int pre_remove_service(int argc, char **argv) {\r
  41   /* Show dialogue box if we didn't pass service name and "confirm" */\r
  42   if (argc < 2) return nssm_gui(IDD_REMOVE, argv[0]);\r
  43   if (str_equiv(argv[1], "confirm")) return remove_service(argv[0]);\r
  44   fprintf(stderr, "To remove a service without confirmation: nssm remove <servicename> confirm\n");\r
  45   return 100;\r
  46 }\r
  47 \r
  48 /* Install the service */\r
  49 int install_service(char *name, char *exe, char *flags) {\r
  50   /* Open service manager */\r
  51   SC_HANDLE services = open_service_manager();\r
  52   if (! services) {\r
  53     fprintf(stderr, "Error opening service manager!\n");\r
  54     return 2;\r
  55   }\r
  56   \r
  57   /* Get path of this program */\r
  58   char path[MAX_PATH];\r
  59   GetModuleFileName(0, path, MAX_PATH);\r
  60 \r
  61   /* Construct command */\r
  62   char command[CMD_LENGTH];\r
  63   size_t runlen = strlen(NSSM_RUN);\r
  64   size_t pathlen = strlen(path);\r
  65   if (pathlen + runlen + 2 >= VALUE_LENGTH) {\r
  66     fprintf(stderr, "The full path to " NSSM " is too long!\n");\r
  67     return 3;\r
  68   }\r
  69   if (snprintf(command, sizeof(command), "\"%s\" %s", path, NSSM_RUN) < 0) {\r
  70     fprintf(stderr, "Out of memory for ImagePath!\n");\r
  71     return 4;\r
  72   }\r
  73 \r
  74   /* Work out directory name */\r
  75   size_t len = strlen(exe);\r
  76   size_t i;\r
  77   for (i = len; i && exe[i] != '\\' && exe[i] != '/'; i--);\r
  78   char dir[MAX_PATH];\r
  79   memmove(dir, exe, i);\r
  80   dir[i] = '\0';\r
  81 \r
  82   /* Create the service */\r
  83   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);\r
  84   if (! service) {\r
  85     fprintf(stderr, "Error creating service!\n");\r
  86     CloseServiceHandle(services);\r
  87     return 5;\r
  88   }\r
  89 \r
  90   /* Now we need to put the parameters into the registry */\r
  91   if (create_parameters(name, exe, flags, dir)) {\r
  92     fprintf(stderr, "Error setting startup parameters for the service!\n");\r
  93     DeleteService(service);\r
  94     CloseServiceHandle(services);\r
  95     return 6;\r
  96   }\r
  97 \r
  98   /* Cleanup */\r
  99   CloseServiceHandle(service);\r
 100   CloseServiceHandle(services);\r
 101 \r
 102   printf("Service \"%s\" installed successfully!\n", name);\r
 103   return 0;\r
 104 }\r
 105 \r
 106 /* Remove the service */\r
 107 int remove_service(char *name) {\r
 108   /* Open service manager */\r
 109   SC_HANDLE services = open_service_manager();\r
 110   if (! services) {\r
 111     fprintf(stderr, "Error opening service manager!\n");\r
 112     return 2;\r
 113   }\r
 114   \r
 115   /* Try to open the service */\r
 116   SC_HANDLE service = OpenService(services, name, SC_MANAGER_ALL_ACCESS);\r
 117   if (! service) {\r
 118     fprintf(stderr, "Can't open service!");\r
 119     CloseServiceHandle(services);\r
 120     return 3;\r
 121   }\r
 122 \r
 123   /* Try to delete the service */\r
 124   if (! DeleteService(service)) {\r
 125     fprintf(stderr, "Error deleting service!\n");\r
 126     CloseServiceHandle(service);\r
 127     CloseServiceHandle(services);\r
 128     return 4;\r
 129   }\r
 130 \r
 131   /* Cleanup */\r
 132   CloseServiceHandle(service);\r
 133   CloseServiceHandle(services);\r
 134 \r
 135   printf("Service \"%s\" removed successfully!\n", name);\r
 136   return 0;\r
 137 }\r
 138 \r
 139 /* Service initialisation */\r
 140 void WINAPI service_main(unsigned long argc, char **argv) {\r
 141   if (_snprintf(service_name, sizeof(service_name), "%s", argv[0]) < 0) {\r
 142     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "service_name", "service_main()", 0);\r
 143     return;\r
 144   }\r
 145 \r
 146   /* Initialise status */\r
 147   ZeroMemory(&service_status, sizeof(service_status));\r
 148   service_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS | SERVICE_INTERACTIVE_PROCESS;\r
 149   service_status.dwCurrentState = SERVICE_RUNNING;\r
 150   service_status.dwControlsAccepted = SERVICE_ACCEPT_SHUTDOWN | SERVICE_ACCEPT_STOP;\r
 151   service_status.dwWin32ExitCode = NO_ERROR;\r
 152   service_status.dwServiceSpecificExitCode = 0;\r
 153   service_status.dwCheckPoint = 0;\r
 154   service_status.dwWaitHint = 1000;\r
 155 \r
 156   /* Signal we AREN'T running the server */\r
 157   pid = 0;\r
 158 \r
 159   /* Get startup parameters */\r
 160   int ret = get_parameters(argv[0], exe, sizeof(exe), flags, sizeof(flags), dir, sizeof(dir));\r
 161   if (ret) {\r
 162     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_PARAMETERS_FAILED, argv[0], 0);\r
 163     return;\r
 164   }\r
 165 \r
 166   /* Register control handler */\r
 167   service_handle = RegisterServiceCtrlHandlerEx(NSSM, service_control_handler, 0);\r
 168   if (! service_handle) {\r
 169     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_REGISTERSERVICECTRLHANDER_FAILED, GetLastError(), 0);\r
 170     return;\r
 171   }\r
 172 \r
 173   /* Try to create the exit action parameters; we don't care if it fails */\r
 174   create_exit_action(argv[0], exit_action_strings[0]);\r
 175 \r
 176   set_service_recovery(service_name);\r
 177 \r
 178   monitor_service();\r
 179 }\r
 180 \r
 181 /* Make sure service recovery actions are taken where necessary */\r
 182 void set_service_recovery(char *service_name) {\r
 183   SC_HANDLE services = open_service_manager();\r
 184   if (! services) return;\r
 185 \r
 186   SC_HANDLE service = OpenService(services, service_name, SC_MANAGER_ALL_ACCESS);\r
 187   if (! service) return;\r
 188   return;\r
 189 \r
 190   SERVICE_FAILURE_ACTIONS_FLAG flag;\r
 191   ZeroMemory(&flag, sizeof(flag));\r
 192   flag.fFailureActionsOnNonCrashFailures = true;\r
 193 \r
 194   /* This functionality was added in Vista so the call may fail */\r
 195   ChangeServiceConfig2(service, SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, &flag);\r
 196 }\r
 197 \r
 198 int monitor_service() {\r
 199   /* Set service status to started */\r
 200   int ret = start_service();\r
 201   if (ret) {\r
 202     char code[16];\r
 203     snprintf(code, sizeof(code), "%d", ret);\r
 204     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_START_SERVICE_FAILED, exe, service_name, ret, 0);\r
 205     return ret;\r
 206   }\r
 207   log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_STARTED_SERVICE, exe, flags, service_name, dir, 0);\r
 208 \r
 209   /* Monitor service service */\r
 210   if (! RegisterWaitForSingleObject(&wait_handle, pid, end_service, 0, INFINITE, WT_EXECUTEONLYONCE | WT_EXECUTELONGFUNCTION)) {\r
 211     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_REGISTERWAITFORSINGLEOBJECT_FAILED, service_name, exe, GetLastError(), 0);\r
 212   }\r
 213 \r
 214   return 0;\r
 215 }\r
 216 \r
 217 /* Service control handler */\r
 218 unsigned long WINAPI service_control_handler(unsigned long control, unsigned long event, void *data, void *context) {\r
 219   switch (control) {\r
 220     case SERVICE_CONTROL_SHUTDOWN:\r
 221     case SERVICE_CONTROL_STOP:\r
 222       stop_service(0, true);\r
 223       return NO_ERROR;\r
 224   }\r
 225 \r
 226   /* Unknown control */\r
 227   return ERROR_CALL_NOT_IMPLEMENTED;\r
 228 }\r
 229 \r
 230 /* Start the service */\r
 231 int start_service() {\r
 232   if (pid) return 0;\r
 233 \r
 234   /* Allocate a STARTUPINFO structure for a new process */\r
 235   STARTUPINFO si;\r
 236   ZeroMemory(&si, sizeof(si));\r
 237   si.cb = sizeof(si);\r
 238 \r
 239   /* Allocate a PROCESSINFO structure for the process */\r
 240   PROCESS_INFORMATION pi;\r
 241   ZeroMemory(&pi, sizeof(pi));\r
 242 \r
 243   /* Launch executable with arguments */\r
 244   char cmd[CMD_LENGTH];\r
 245   if (_snprintf(cmd, sizeof(cmd), "%s %s", exe, flags) < 0) {\r
 246     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "command line", "start_service", 0);\r
 247     return stop_service(2, true);\r
 248   }\r
 249   if (! CreateProcess(0, cmd, 0, 0, 0, 0, 0, dir, &si, &pi)) {\r
 250     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_CREATEPROCESS_FAILED, service_name, exe, GetLastError(), 0);\r
 251     return stop_service(3, true);\r
 252   }\r
 253   pid = pi.hProcess;\r
 254 \r
 255   /* Signal successful start */\r
 256   service_status.dwCurrentState = SERVICE_RUNNING;\r
 257   SetServiceStatus(service_handle, &service_status);\r
 258 \r
 259   return 0;\r
 260 }\r
 261 \r
 262 /* Stop the service */\r
 263 int stop_service(unsigned long exitcode, bool graceful) {\r
 264   /* Signal we are stopping */\r
 265   if (graceful) {\r
 266     service_status.dwCurrentState = SERVICE_STOP_PENDING;\r
 267     SetServiceStatus(service_handle, &service_status);\r
 268   }\r
 269 \r
 270   /* Nothing to do if server isn't running */\r
 271   if (pid) {\r
 272     /* Shut down server */\r
 273     log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_TERMINATEPROCESS, service_name, exe, 0);\r
 274     TerminateProcess(pid, 0);\r
 275     pid = 0;\r
 276   }\r
 277   else log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_PROCESS_ALREADY_STOPPED, service_name, exe, 0);\r
 278 \r
 279   /* Signal we stopped */\r
 280   if (graceful) {\r
 281     service_status.dwCurrentState = SERVICE_STOPPED;\r
 282     if (exitcode) {\r
 283       service_status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR;\r
 284       service_status.dwServiceSpecificExitCode = exitcode;\r
 285     }\r
 286     else {\r
 287       service_status.dwWin32ExitCode = NO_ERROR;\r
 288       service_status.dwServiceSpecificExitCode = 0;\r
 289     }\r
 290     SetServiceStatus(service_handle, &service_status);\r
 291   }\r
 292 \r
 293   return exitcode;\r
 294 }\r
 295 \r
 296 /* Callback function triggered when the server exits */\r
 297 void CALLBACK end_service(void *arg, unsigned char why) {\r
 298   /* Check exit code */\r
 299   unsigned long ret = 0;\r
 300   GetExitCodeProcess(pid, &ret);\r
 301 \r
 302   char code[16];\r
 303   _snprintf(code, sizeof(code), "%d", ret);\r
 304   log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_ENDED_SERVICE, exe, service_name, code, 0);\r
 305 \r
 306   /* What action should we take? */\r
 307   int action = NSSM_EXIT_RESTART;\r
 308   unsigned char action_string[ACTION_LEN];\r
 309   if (! get_exit_action(service_name, &ret, action_string)) {\r
 310     for (int i = 0; exit_action_strings[i]; i++) {\r
 311       if (! _strnicmp((const char *) action_string, exit_action_strings[i], ACTION_LEN)) {\r
 312         action = i;\r
 313         break;\r
 314       }\r
 315     }\r
 316   }\r
 317 \r
 318   pid = 0;\r
 319   switch (action) {\r
 320     /* Try to restart the service or return failure code to service manager */\r
 321     case NSSM_EXIT_RESTART:\r
 322       log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_RESTART, service_name, code, exit_action_strings[action], exe, 0);\r
 323       while (monitor_service()) {\r
 324         log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_RESTART_SERVICE_FAILED, exe, service_name, 0);\r
 325         Sleep(30000);\r
 326       }\r
 327     break;\r
 328 \r
 329     /* Do nothing, just like srvany would */\r
 330     case NSSM_EXIT_IGNORE:\r
 331       log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_IGNORE, service_name, code, exit_action_strings[action], exe, 0);\r
 332       Sleep(INFINITE);\r
 333     break;\r
 334 \r
 335     /* Tell the service manager we are finished */\r
 336     case NSSM_EXIT_REALLY:\r
 337       log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_REALLY, service_name, code, exit_action_strings[action], 0);\r
 338       stop_service(ret, true);\r
 339     break;\r
 340 \r
 341     /* Fake a crash so pre-Vista service managers will run recovery actions. */\r
 342     case NSSM_EXIT_UNCLEAN:\r
 343       log_event(EVENTLOG_INFORMATION_TYPE, NSSM_EVENT_EXIT_UNCLEAN, service_name, code, exit_action_strings[action], 0);\r
 344       exit(stop_service(ret, false));\r
 345     break;\r
 346   }\r
 347 }\r