service.cc

   1 #include "service.h"
   2 #include <cstring>
   3 #include <cerrno>
   4 #include <sstream>
   5 #include <iterator>
   6 #include <sys/types.h>
   7 #include <sys/stat.h>
   8 #include <fcntl.h>
   9 #include <unistd.h>
  10
  11 // Tokenize a string, allow quoting
  12 // TODO doesn't yet allow quoting...
  13 static std::vector<std::string> tokenize(std::string arg)
  14 {
  15     // TODO rewrite to be more efficient.
  16     using namespace std;
  17     istringstream iss(arg);
  18     return vector<string>(istream_iterator<string>(iss), istream_iterator<string>());
  19 }
  20
  21 // Find the requested service by name
  22 static ServiceRecord * findService(const std::list<ServiceRecord *> & records,
  23                                     const char *name)
  24 {
  25     using std::list;
  26     list<ServiceRecord *>::const_iterator i = records.begin();
  27     for ( ; i != records.end(); i++ ) {
  28         if (strcmp((*i)->getServiceName(), name) == 0) {
  29             return *i;
  30         }
  31     }
  32     return (ServiceRecord *)0;
  33 }
  34
  35 ServiceRecord * ServiceSet::findService(std::string name)
  36 {
  37     return ::findService(records, name.c_str());
  38 }
  39
  40 void ServiceSet::startService(const char *name)
  41 {
  42     using namespace std;
  43     ServiceRecord *record = loadServiceRecord(name);
  44
  45     record->start();
  46 }
  47
  48 void ServiceSet::stopService(const std::string & name)
  49 {
  50     ServiceRecord *record = findService(name);
  51     if (record != nullptr) {
  52         record->stop();
  53     }
  54 }
  55
  56 // Called when a service has actually stopped.
  57 void ServiceRecord::stopped()
  58 {
  59     service_state = SVC_STOPPED;
  60     force_stop = false;
  61
  62     // Stop any dependencies whose desired state is SVC_STOPPED:
  63     for (sr_iter i = depends_on.begin(); i != depends_on.end(); i++) {
  64         (*i)->dependentStopped();
  65     }
  66
  67     service_set->service_inactive(this);
  68
  69     // TODO inform listeners.
  70     if (desired_state == SVC_STARTED) {
  71         // Desired state is "started".
  72         start();
  73     }
  74 }
  75
  76 void ServiceRecord::process_child_callback(struct ev_loop *loop, ev_child *w, int revents)
  77 {
  78     ServiceRecord *sr = (ServiceRecord *) w->data;
  79
  80     sr->pid = -1;
  81     ev_child_stop(ev_default_loop(EVFLAG_AUTO), &sr->child_listener);
  82
  83     // Ok, for a process service, any process death which we didn't rig
  84     // ourselves is a bit... unexpected. Probably, the child died because
  85     // we asked it to (sr->service_state == SVC_STOPPING). But even if
  86     // we didn't, there's not much we can do.
  87
  88     if (sr->service_type == SVC_PROCESS) {
  89         // TODO log non-zero rstatus?
  90         if (sr->service_state == SVC_STOPPING) {
  91             sr->stopped();
  92         }
  93         else {
  94             sr->forceStop();
  95         }
  96
  97         if (sr->auto_restart && sr->service_set->get_auto_restart()) {
  98             sr->start();
  99         }
 100     }
 101     else {  // SVC_SCRIPTED
 102         if (sr->service_state == SVC_STOPPING) {
 103             if (w->rstatus == 0) {
 104                 sr->stopped();
 105             }
 106             else {
 107                 // TODO
 108                 // ??? failed to stop!
 109                 // For now just pretend we stopped, so that any dependencies
 110                 // can be stopped:
 111                 sr->stopped();
 112             }
 113         }
 114         else { // SVC_STARTING
 115             if (w->rstatus == 0) {
 116                 sr->started();
 117             }
 118             else {
 119                 // failed to start
 120                 sr->failed_to_start();
 121             }
 122         }
 123     }
 124 }
 125
 126 void ServiceRecord::start()
 127 {
 128     if ((service_state == SVC_STARTING || service_state == SVC_STARTED)
 129             && desired_state == SVC_STOPPED) {
 130         // This service was starting, or started, but was set to be stopped.
 131         // Cancel the stop (and continue starting/running).
 132         // TODO any listeners waiting for stop should be notified of
 133         //      its cancellation
 134     }
 135
 136     desired_state = SVC_STARTED;
 137
 138     if (service_state != SVC_STOPPED) {
 139         // Either we need do nothing (service is already started/starting)
 140         // or the service is currently being stopped and we must wait for
 141         // that to complete.
 142         return;
 143     }
 144
 145     // Service state is SVC_STOPPED. Start the service.
 146
 147     // First, start dependencies
 148     bool all_deps_started = true;
 149     for (sr_iter i = depends_on.begin(); i != depends_on.end(); ++i) {
 150         // Note, we cannot treat a dependency as started if its force_stop
 151         // flag is set.
 152         if ((*i)->service_state != SVC_STARTED || (*i)->force_stop) {
 153             all_deps_started = false;
 154             (*i)->start();
 155         }
 156     }
 157
 158     if (! all_deps_started) {
 159         // The dependencies will notify this service once they've started.
 160         return;
 161     }
 162
 163     // Actually start this service.
 164     service_state = SVC_STARTING;
 165     service_set->service_active(this);
 166
 167     if (service_type == SVC_PROCESS) {
 168         bool start_success = start_ps_process();
 169         if (start_success) {
 170             started();
 171         }
 172         else {
 173             failed_to_start();
 174         }
 175     }
 176     else {
 177         // Script-controlled service
 178         bool start_success = start_ps_process(std::vector<std::string>(1, "start"));
 179         if (! start_success) {
 180             failed_to_start();
 181         }
 182     }
 183 }
 184
 185 void ServiceRecord::started()
 186 {
 187     service_state = SVC_STARTED;
 188     // TODO - inform listeners
 189
 190     if (desired_state == SVC_STARTED) {
 191         // Start any dependents whose desired state is SVC_STARTED:
 192         for (sr_iter i = dependents.begin(); i != dependents.end(); i++) {
 193             if ((*i)->desired_state == SVC_STARTED) {
 194                 (*i)->start();
 195             }
 196         }
 197     }
 198     else {
 199         stop();
 200     }
 201 }
 202
 203 void ServiceRecord::failed_to_start()
 204 {
 205     service_state = SVC_STOPPED;
 206     desired_state = SVC_STOPPED;
 207     service_set->service_inactive(this);
 208     // failure to start
 209     // TODO - inform listeners of failure
 210     // Cancel start of dependents:
 211     for (sr_iter i = dependents.begin(); i != dependents.end(); i++) {
 212         if ((*i)->desired_state == SVC_STARTED) {
 213             (*i)->failed_dependency();
 214         }
 215     }
 216 }
 217
 218 bool ServiceRecord::start_ps_process()
 219 {
 220     // BIG FAT NOTE: We rely on linux semantics of vfork() here.
 221     // Specifically:
 222     // * Parent process execution is suspended until the forked child
 223     //   successfully exec's another program, or it exits
 224     // * Memory is shared between the two processes until exec()
 225     //   succeeds.
 226     // Both of the above mean that we can determine in the parent process
 227     // whether or not the exec succeeded. If vfork instead is implemented
 228     // as an alias of fork, it will look like the exec always succeeded.
 229
 230     /*
 231     volatile int exec_status = 0;
 232     pid_t forkpid = vfork();
 233     if (forkpid == 0) {
 234         // Child process
 235         // ev_default_destroy(); // won't need that on this side, free up fds.
 236         // Hmm. causes segfault. Of course. Memory is shared due to vfork.
 237
 238         // Re-set stdin, stdout, stderr
 239         close(0); close(1); close(2);
 240         string logfile = this->logfile;
 241         if (logfile.length() == 0) {
 242             logfile = "/dev/null";
 243         }
 244
 245         if (open("/dev/null", O_RDONLY) == 0) {
 246           // stdin = 0. That's what we should have; proceed with opening
 247           // stdout and stderr.
 248           open(logfile.c_str(), O_WRONLY | O_CREAT | O_APPEND, S_IRUSR | S_IWUSR);
 249           dup2(1, 2);
 250         }
 251
 252         const char * pname = program_name.c_str();
 253         char const * args[2] = { pname, 0 };
 254         execvp(pname, (char ** const) args);
 255         // If we got here, the exec failed
 256         exec_status = errno;
 257         _exit(0);
 258     }
 259     else {
 260         // Parent process - we only reach here once the exec() above
 261         // has succeeded, or _exit() above was called (because vfork()
 262         // suspends the parent until either of those occurs).
 263         if (exec_status == 0) {
 264             // success
 265             pid = forkpid;
 266
 267             // Add a process listener so we can detect when the
 268             // service stops
 269             ev_child_init(&child_listener, process_child_callback, pid, 0);
 270             child_listener.data = this;
 271             ev_child_start(ev_default_loop(EVFLAG_AUTO), &child_listener);
 272
 273             service_state = SVC_STARTED;
 274             return true;
 275         }
 276         else {
 277             return false;
 278         }
 279     }
 280     */
 281
 282     return start_ps_process(std::vector<std::string>());
 283 }
 284
 285
 286 bool ServiceRecord::start_ps_process(const std::vector<std::string> &pargs)
 287 {
 288     // In general, you can't tell whether fork/exec is successful. We use a pipe to communicate
 289     // success/failure from the child to the parent. The pipe is set CLOEXEC so a successful
 290     // exec closes the pipe, and the parent sees EOF. If the exec is unsuccessful, the errno
 291     // is written to the pipe, and the parent can read it.
 292
 293     using std::vector;
 294     using std::string;
 295
 296     int pipefd[2];
 297     if (pipe2(pipefd, O_CLOEXEC)) {
 298         // TODO log error
 299         return false;
 300     }
 301
 302     // TODO make sure pipefd's are not 0/1/2 (STDIN/OUT/ERR) - if they are, dup them
 303     // until they are not.
 304
 305     pid_t forkpid = fork();
 306     if (forkpid == -1) {
 307         // TODO log error
 308         close(pipefd[0]);
 309         close(pipefd[1]);
 310         return false;
 311     }
 312
 313     if (forkpid == 0) {
 314         // Child process
 315         ev_default_destroy(); // won't need that on this side, free up fds.
 316
 317         // Re-set stdin, stdout, stderr
 318         close(0); close(1); close(2);
 319         string logfile = this->logfile;
 320         if (logfile.length() == 0) {
 321             logfile = "/dev/null";
 322         }
 323
 324         // TODO rethink this logic. If we open it at not-0, shouldn't we just dup it to 0?:
 325         if (open("/dev/null", O_RDONLY) == 0) {
 326           // stdin = 0. That's what we should have; proceed with opening
 327           // stdout and stderr.
 328           open(logfile.c_str(), O_WRONLY | O_CREAT | O_APPEND, S_IRUSR | S_IWUSR);
 329           dup2(1, 2);
 330         }
 331
 332         // Tokenize the command, and add additional arguments from pargs:
 333         vector<string> progAndArgs = tokenize(program_name);
 334         progAndArgs.insert(progAndArgs.end(), pargs.begin(), pargs.end());
 335
 336         const char * pname = progAndArgs[0].c_str();
 337         const char ** args = new const char *[progAndArgs.size() + 1];
 338
 339         for (std::vector<std::string>::size_type i = 0; i < progAndArgs.size(); i++) {
 340             args[i] = progAndArgs[i].c_str();
 341         }
 342         args[progAndArgs.size()] = nullptr;
 343
 344         execvp(pname, (char ** const) args);
 345
 346         // If we got here, the exec failed:
 347         int exec_status = errno;
 348         write(pipefd[1], &exec_status, sizeof(int));
 349         exit(0);
 350     }
 351     else {
 352         // Parent process - we only reach here once the exec() above
 353         // has succeeded, or _exit() above was called (because vfork()
 354         // suspends the parent until either of those occurs).
 355
 356         close(pipefd[1]); // close the 'other end' fd
 357
 358         int exec_status;
 359         if (read(pipefd[0], &exec_status, sizeof(int)) == 0) {
 360             // pipe closed; success
 361             pid = forkpid;
 362
 363             // Add a process listener so we can detect when the
 364             // service stops
 365             ev_child_init(&child_listener, process_child_callback, pid, 0);
 366             child_listener.data = this;
 367             ev_child_start(ev_default_loop(EVFLAG_AUTO), &child_listener);
 368
 369             close(pipefd[0]);
 370             return true;
 371         }
 372         else {
 373             // TODO log error
 374             close(pipefd[0]);
 375             return false;
 376         }
 377     }
 378 }
 379
 380
 381
 382
 383 // Mark this and all dependent services as force-stopped.
 384 void ServiceRecord::forceStop()
 385 {
 386     force_stop = true;
 387     stop();
 388     for (sr_iter i = dependents.begin(); i != dependents.end(); i++) {
 389         (*i)->forceStop();
 390     }
 391 }
 392
 393 // A dependency of this service failed to start.
 394 void ServiceRecord::failed_dependency()
 395 {
 396     // TODO notify listeners
 397     desired_state = SVC_STOPPED;
 398
 399     // Presumably, we were starting. So now we're not.
 400     service_state = SVC_STOPPED;
 401
 402     // Notify dependents of this service also
 403     for (sr_iter i = dependents.begin(); i != dependents.end(); i++) {
 404         if ((*i)->desired_state == SVC_STARTED) {
 405             (*i)->failed_dependency();
 406         }
 407     }
 408 }
 409
 410 void ServiceRecord::dependentStopped()
 411 {
 412     if (desired_state == SVC_STOPPED || force_stop) {
 413         bool all_deps_stopped = true;
 414         for (sr_iter i = dependents.begin(); i != dependents.end(); ++i) {
 415             if ((*i)->service_state != SVC_STOPPED) {
 416                 all_deps_stopped = false;
 417                 break;
 418             }
 419         }
 420
 421         if (all_deps_stopped) {
 422             stopping();
 423         }
 424     }
 425 }
 426
 427 void ServiceRecord::stop()
 428 {
 429     if ((service_state == SVC_STOPPING || service_state == SVC_STOPPED)
 430             && desired_state == SVC_STARTED) {
 431         // The service *was* stopped/stopping, but it was going to restart.
 432         // Now, we'll cancel the restart.
 433         // TODO inform listeners waiting for start of cancellation
 434     }
 435
 436     desired_state = SVC_STOPPED;
 437
 438     if (service_state != SVC_STARTED) {
 439         // If we're starting we need to wait for that to complete.
 440         // If we're already stopping/stopped there's nothing to do.
 441         return;
 442     }
 443
 444     // Make sure all dependents have stopped.
 445
 446     bool all_deps_stopped = true;
 447     for (sr_iter i = dependents.begin(); i != dependents.end(); ++i) {
 448         if ((*i)->service_state != SVC_STOPPED) {
 449             all_deps_stopped = false;
 450             (*i)->stop();
 451         }
 452     }
 453
 454     if (! all_deps_stopped) {
 455         // The dependents will notify this service once they've stopped.
 456         return;
 457     }
 458
 459     // Ok, dependents have stopped. We can stop ourselves.
 460     stopping();
 461 }
 462
 463 // Dependency stopped or is stopping; we must stop too.
 464 void ServiceRecord::stopping()
 465 {
 466     service_state = SVC_STOPPING;
 467
 468     if (service_type == SVC_PROCESS) {
 469         if (pid != -1) {
 470           // The process is still kicking on - must actually kill it.
 471           kill(pid, SIGTERM);
 472           // Now we wait; the rest is done in process_child_callback
 473         }
 474         else {
 475             // The process is already dead.
 476             stopped();
 477         }
 478     }
 479     else {
 480         // Scripted service.
 481         start_ps_process(std::vector<string>(1, "stop"));
 482     }
 483 }
 484
 485 void ServiceSet::service_active(ServiceRecord *sr)
 486 {
 487     active_services++;
 488 }
 489
 490 void ServiceSet::service_inactive(ServiceRecord *sr)
 491 {
 492     active_services--;
 493 }