runit/sv.c

   1 /*
   2 Copyright (c) 2001-2006, Gerrit Pape
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions are met:
   7
   8    1. Redistributions of source code must retain the above copyright notice,
   9       this list of conditions and the following disclaimer.
  10    2. Redistributions in binary form must reproduce the above copyright
  11       notice, this list of conditions and the following disclaimer in the
  12       documentation and/or other materials provided with the distribution.
  13    3. The name of the author may not be used to endorse or promote products
  14       derived from this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19 EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27
  28 /* Taken from http://smarden.sunsite.dk/runit/sv.8.html:
  29
  30 sv - control and manage services monitored by runsv
  31
  32 sv [-v] [-w sec] command services
  33 /etc/init.d/service [-w sec] command
  34
  35 The sv program reports the current status and controls the state of services
  36 monitored by the runsv(8) supervisor.
  37
  38 services consists of one or more arguments, each argument naming a directory
  39 service used by runsv(8). If service doesn't start with a dot or slash,
  40 it is searched in the default services directory /var/service/, otherwise
  41 relative to the current directory.
  42
  43 command is one of up, down, status, once, pause, cont, hup, alarm, interrupt,
  44 1, 2, term, kill, or exit, or start, stop, restart, shutdown, force-stop,
  45 force-reload, force-restart, force-shutdown.
  46
  47 The sv program can be sym-linked to /etc/init.d/ to provide an LSB init
  48 script interface. The service to be controlled then is specified by the
  49 base name of the "init script".
  50
  51 status
  52     Report the current status of the service, and the appendant log service
  53     if available, to standard output.
  54 up
  55     If the service is not running, start it. If the service stops, restart it.
  56 down
  57     If the service is running, send it the TERM signal, and the CONT signal.
  58     If ./run exits, start ./finish if it exists. After it stops, do not
  59     restart service.
  60 once
  61     If the service is not running, start it. Do not restart it if it stops.
  62 pause cont hup alarm interrupt quit 1 2 term kill
  63     If the service is running, send it the STOP, CONT, HUP, ALRM, INT, QUIT,
  64     USR1, USR2, TERM, or KILL signal respectively.
  65 exit
  66     If the service is running, send it the TERM signal, and the CONT signal.
  67     Do not restart the service. If the service is down, and no log service
  68     exists, runsv(8) exits. If the service is down and a log service exists,
  69     send the TERM signal to the log service. If the log service is down,
  70     runsv(8) exits. This command is ignored if it is given to an appendant
  71     log service.
  72
  73 sv actually looks only at the first character of above commands.
  74
  75 Commands compatible to LSB init script actions:
  76
  77 status
  78     Same as status.
  79 start
  80     Same as up, but wait up to 7 seconds for the command to take effect.
  81     Then report the status or timeout. If the script ./check exists in
  82     the service directory, sv runs this script to check whether the service
  83     is up and available; it's considered to be available if ./check exits
  84     with 0.
  85 stop
  86     Same as down, but wait up to 7 seconds for the service to become down.
  87     Then report the status or timeout.
  88 restart
  89     Send the commands term, cont, and up to the service, and wait up to
  90     7 seconds for the service to restart. Then report the status or timeout.
  91     If the script ./check exists in the service directory, sv runs this script
  92     to check whether the service is up and available again; it's considered
  93     to be available if ./check exits with 0.
  94 shutdown
  95     Same as exit, but wait up to 7 seconds for the runsv(8) process
  96     to terminate. Then report the status or timeout.
  97 force-stop
  98     Same as down, but wait up to 7 seconds for the service to become down.
  99     Then report the status, and on timeout send the service the kill command.
 100 force-reload
 101     Send the service the term and cont commands, and wait up to
 102     7 seconds for the service to restart. Then report the status,
 103     and on timeout send the service the kill command.
 104 force-restart
 105     Send the service the term, cont and up commands, and wait up to
 106     7 seconds for the service to restart. Then report the status, and
 107     on timeout send the service the kill command. If the script ./check
 108     exists in the service directory, sv runs this script to check whether
 109     the service is up and available again; it's considered to be available
 110     if ./check exits with 0.
 111 force-shutdown
 112     Same as exit, but wait up to 7 seconds for the runsv(8) process to
 113     terminate. Then report the status, and on timeout send the service
 114     the kill command.
 115
 116 Additional Commands
 117
 118 check
 119     Check for the service to be in the state that's been requested. Wait up to
 120     7 seconds for the service to reach the requested state, then report
 121     the status or timeout. If the requested state of the service is up,
 122     and the script ./check exists in the service directory, sv runs
 123     this script to check whether the service is up and running;
 124     it's considered to be up if ./check exits with 0.
 125
 126 Options
 127
 128 -v
 129     wait up to 7 seconds for the command to take effect.
 130     Then report the status or timeout.
 131 -w sec
 132     Override the default timeout of 7 seconds with sec seconds. Implies -v.
 133
 134 Environment
 135
 136 SVDIR
 137     The environment variable $SVDIR overrides the default services directory
 138     /var/service.
 139 SVWAIT
 140     The environment variable $SVWAIT overrides the default 7 seconds to wait
 141     for a command to take effect. It is overridden by the -w option.
 142
 143 Exit Codes
 144     sv exits 0, if the command was successfully sent to all services, and,
 145     if it was told to wait, the command has taken effect to all services.
 146
 147     For each service that caused an error (e.g. the directory is not
 148     controlled by a runsv(8) process, or sv timed out while waiting),
 149     sv increases the exit code by one and exits non zero. The maximum
 150     is 99. sv exits 100 on error.
 151 */
 152
 153 /* Busyboxed by Denis Vlasenko <vda.linux@googlemail.com> */
 154 /* TODO: depends on runit_lib.c - review and reduce/eliminate */
 155
 156 #include <sys/poll.h>
 157 #include <sys/file.h>
 158 #include "libbb.h"
 159 #include "runit_lib.h"
 160
 161 struct globals {
 162         const char *acts;
 163         char **service;
 164         unsigned rc;
 165 /* "Bernstein" time format: unix + 0x400000000000000aULL */
 166         uint64_t tstart, tnow;
 167         svstatus_t svstatus;
 168 };
 169 #define G (*(struct globals*)&bb_common_bufsiz1)
 170 #define acts         (G.acts        )
 171 #define service      (G.service     )
 172 #define rc           (G.rc          )
 173 #define tstart       (G.tstart      )
 174 #define tnow         (G.tnow        )
 175 #define svstatus     (G.svstatus    )
 176 #define INIT_G() do { } while (0)
 177
 178
 179 static void fatal_cannot(const char *m1) ATTRIBUTE_NORETURN;
 180 static void fatal_cannot(const char *m1)
 181 {
 182         bb_perror_msg("fatal: cannot %s", m1);
 183         _exit(151);
 184 }
 185
 186 static void out(const char *p, const char *m1)
 187 {
 188         printf("%s%s: %s", p, *service, m1);
 189         if (errno) {
 190                 printf(": %s", strerror(errno));
 191         }
 192         bb_putchar('\n'); /* will also flush the output */
 193 }
 194
 195 #define WARN    "warning: "
 196 #define OK      "ok: "
 197
 198 static void fail(const char *m1)
 199 {
 200         ++rc;
 201         out("fail: ", m1);
 202 }
 203 static void failx(const char *m1)
 204 {
 205         errno = 0;
 206         fail(m1);
 207 }
 208 static void warn(const char *m1)
 209 {
 210         ++rc;
 211         /* "warning: <service>: <m1>\n" */
 212         out("warning: ", m1);
 213 }
 214 static void ok(const char *m1)
 215 {
 216         errno = 0;
 217         out(OK, m1);
 218 }
 219
 220 static int svstatus_get(void)
 221 {
 222         int fd, r;
 223
 224         fd = open_write("supervise/ok");
 225         if (fd == -1) {
 226                 if (errno == ENODEV) {
 227                         *acts == 'x' ? ok("runsv not running")
 228                                      : failx("runsv not running");
 229                         return 0;
 230                 }
 231                 warn("cannot open supervise/ok");
 232                 return -1;
 233         }
 234         close(fd);
 235         fd = open_read("supervise/status");
 236         if (fd == -1) {
 237                 warn("cannot open supervise/status");
 238                 return -1;
 239         }
 240         r = read(fd, &svstatus, 20);
 241         close(fd);
 242         switch (r) {
 243         case 20:
 244                 break;
 245         case -1:
 246                 warn("cannot read supervise/status");
 247                 return -1;
 248         default:
 249                 errno = 0;
 250                 warn("cannot read supervise/status: bad format");
 251                 return -1;
 252         }
 253         return 1;
 254 }
 255
 256 static unsigned svstatus_print(const char *m)
 257 {
 258         int diff;
 259         int pid;
 260         int normallyup = 0;
 261         struct stat s;
 262         uint64_t timestamp;
 263
 264         if (stat("down", &s) == -1) {
 265                 if (errno != ENOENT) {
 266                         bb_perror_msg(WARN"cannot stat %s/down", *service);
 267                         return 0;
 268                 }
 269                 normallyup = 1;
 270         }
 271         pid = SWAP_LE32(svstatus.pid_le32);
 272         timestamp = SWAP_BE64(svstatus.time_be64);
 273         if (pid) {
 274                 switch (svstatus.run_or_finish) {
 275                 case 1: printf("run: "); break;
 276                 case 2: printf("finish: "); break;
 277                 }
 278                 printf("%s: (pid %d) ", m, pid);
 279         } else {
 280                 printf("down: %s: ", m);
 281         }
 282         diff = tnow - timestamp;
 283         printf("%us", (diff < 0 ? 0 : diff));
 284         if (pid) {
 285                 if (!normallyup) printf(", normally down");
 286                 if (svstatus.paused) printf(", paused");
 287                 if (svstatus.want == 'd') printf(", want down");
 288                 if (svstatus.got_term) printf(", got TERM");
 289         } else {
 290                 if (normallyup) printf(", normally up");
 291                 if (svstatus.want == 'u') printf(", want up");
 292         }
 293         return pid ? 1 : 2;
 294 }
 295
 296 static int status(const char *unused)
 297 {
 298         int r;
 299
 300         r = svstatus_get();
 301         switch (r) { case -1: case 0: return 0; }
 302
 303         r = svstatus_print(*service);
 304         if (chdir("log") == -1) {
 305                 if (errno != ENOENT) {
 306                         printf("; log: "WARN"cannot change to log service directory: %s",
 307                                         strerror(errno));
 308                 }
 309         } else if (svstatus_get()) {
 310                 printf("; ");
 311                 svstatus_print("log");
 312         }
 313         bb_putchar('\n'); /* will also flush the output */
 314         return r;
 315 }
 316
 317 static int checkscript(void)
 318 {
 319         char *prog[2];
 320         struct stat s;
 321         int pid, w;
 322
 323         if (stat("check", &s) == -1) {
 324                 if (errno == ENOENT) return 1;
 325                 bb_perror_msg(WARN"cannot stat %s/check", *service);
 326                 return 0;
 327         }
 328         /* if (!(s.st_mode & S_IXUSR)) return 1; */
 329         prog[0] = (char*)"./check";
 330         prog[1] = NULL;
 331         pid = spawn(prog);
 332         if (pid <= 0) {
 333                 bb_perror_msg(WARN"cannot %s child %s/check", "run", *service);
 334                 return 0;
 335         }
 336         while (wait_pid(&w, pid) == -1) {
 337                 if (errno == EINTR) continue;
 338                 bb_perror_msg(WARN"cannot %s child %s/check", "wait for", *service);
 339                 return 0;
 340         }
 341         return !wait_exitcode(w);
 342 }
 343
 344 static int check(const char *a)
 345 {
 346         int r;
 347         unsigned pid;
 348         uint64_t timestamp;
 349
 350         r = svstatus_get();
 351         if (r == -1)
 352                 return -1;
 353         if (r == 0) {
 354                 if (*a == 'x')
 355                         return 1;
 356                 return -1;
 357         }
 358         pid = SWAP_LE32(svstatus.pid_le32);
 359         switch (*a) {
 360         case 'x':
 361                 return 0;
 362         case 'u':
 363                 if (!pid || svstatus.run_or_finish != 1) return 0;
 364                 if (!checkscript()) return 0;
 365                 break;
 366         case 'd':
 367                 if (pid) return 0;
 368                 break;
 369         case 'c':
 370                 if (pid && !checkscript()) return 0;
 371                 break;
 372         case 't':
 373                 if (!pid && svstatus.want == 'd') break;
 374                 timestamp = SWAP_BE64(svstatus.time_be64);
 375                 if ((tstart > timestamp) || !pid || svstatus.got_term || !checkscript())
 376                         return 0;
 377                 break;
 378         case 'o':
 379                 timestamp = SWAP_BE64(svstatus.time_be64);
 380                 if ((!pid && tstart > timestamp) || (pid && svstatus.want != 'd'))
 381                         return 0;
 382         }
 383         printf(OK);
 384         svstatus_print(*service);
 385         bb_putchar('\n'); /* will also flush the output */
 386         return 1;
 387 }
 388
 389 static int control(const char *a)
 390 {
 391         int fd, r;
 392
 393         if (svstatus_get() <= 0)
 394                 return -1;
 395         if (svstatus.want == *a)
 396                 return 0;
 397         fd = open_write("supervise/control");
 398         if (fd == -1) {
 399                 if (errno != ENODEV)
 400                         warn("cannot open supervise/control");
 401                 else
 402                         *a == 'x' ? ok("runsv not running") : failx("runsv not running");
 403                 return -1;
 404         }
 405         r = write(fd, a, strlen(a));
 406         close(fd);
 407         if (r != strlen(a)) {
 408                 warn("cannot write to supervise/control");
 409                 return -1;
 410         }
 411         return 1;
 412 }
 413
 414 int sv_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 415 int sv_main(int argc, char **argv)
 416 {
 417         unsigned opt;
 418         unsigned i, want_exit;
 419         char *x;
 420         char *action;
 421         const char *varservice = "/var/service/";
 422         unsigned services;
 423         char **servicex;
 424         unsigned waitsec = 7;
 425         smallint kll = 0;
 426         smallint verbose = 0;
 427         int (*act)(const char*);
 428         int (*cbk)(const char*);
 429         int curdir;
 430
 431         INIT_G();
 432
 433         xfunc_error_retval = 100;
 434
 435         x = getenv("SVDIR");
 436         if (x) varservice = x;
 437         x = getenv("SVWAIT");
 438         if (x) waitsec = xatou(x);
 439
 440         opt = getopt32(argv, "w:v", &x);
 441         if (opt & 1) waitsec = xatou(x); // -w
 442         if (opt & 2) verbose = 1; // -v
 443         argc -= optind;
 444         argv += optind;
 445         action = *argv++;
 446         if (!action || !*argv) bb_show_usage();
 447         service = argv;
 448         services = argc - 1;
 449
 450         tnow = time(0) + 0x400000000000000aULL;
 451         tstart = tnow;
 452         curdir = open_read(".");
 453         if (curdir == -1)
 454                 fatal_cannot("open current directory");
 455
 456         act = &control;
 457         acts = "s";
 458         cbk = &check;
 459
 460         switch (*action) {
 461         case 'x':
 462         case 'e':
 463                 acts = "x";
 464                 if (!verbose) cbk = NULL;
 465                 break;
 466         case 'X':
 467         case 'E':
 468                 acts = "x";
 469                 kll = 1;
 470                 break;
 471         case 'D':
 472                 acts = "d";
 473                 kll = 1;
 474                 break;
 475         case 'T':
 476                 acts = "tc";
 477                 kll = 1;
 478                 break;
 479         case 'c':
 480                 if (str_equal(action, "check")) {
 481                         act = NULL;
 482                         acts = "c";
 483                         break;
 484                 }
 485         case 'u': case 'd': case 'o': case 't': case 'p': case 'h':
 486         case 'a': case 'i': case 'k': case 'q': case '1': case '2':
 487                 action[1] = '\0';
 488                 acts = action;
 489                 if (!verbose) cbk = NULL;
 490                 break;
 491         case 's':
 492                 if (str_equal(action, "shutdown")) {
 493                         acts = "x";
 494                         break;
 495                 }
 496                 if (str_equal(action, "start")) {
 497                         acts = "u";
 498                         break;
 499                 }
 500                 if (str_equal(action, "stop")) {
 501                         acts = "d";
 502                         break;
 503                 }
 504                 /* "status" */
 505                 act = &status;
 506                 cbk = NULL;
 507                 break;
 508         case 'r':
 509                 if (str_equal(action, "restart")) {
 510                         acts = "tcu";
 511                         break;
 512                 }
 513                 bb_show_usage();
 514         case 'f':
 515                 if (str_equal(action, "force-reload")) {
 516                         acts = "tc";
 517                         kll = 1;
 518                         break;
 519                 }
 520                 if (str_equal(action, "force-restart")) {
 521                         acts = "tcu";
 522                         kll = 1;
 523                         break;
 524                 }
 525                 if (str_equal(action, "force-shutdown")) {
 526                         acts = "x";
 527                         kll = 1;
 528                         break;
 529                 }
 530                 if (str_equal(action, "force-stop")) {
 531                         acts = "d";
 532                         kll = 1;
 533                         break;
 534                 }
 535         default:
 536                 bb_show_usage();
 537         }
 538
 539         servicex = service;
 540         for (i = 0; i < services; ++i) {
 541                 if ((**service != '/') && (**service != '.')) {
 542                         if (chdir(varservice) == -1)
 543                                 goto chdir_failed_0;
 544                 }
 545                 if (chdir(*service) == -1) {
 546  chdir_failed_0:
 547                         fail("cannot change to service directory");
 548                         goto nullify_service_0;
 549                 }
 550                 if (act && (act(acts) == -1)) {
 551  nullify_service_0:
 552                         *service = NULL;
 553                 }
 554                 if (fchdir(curdir) == -1)
 555                         fatal_cannot("change to original directory");
 556                 service++;
 557         }
 558
 559         if (cbk) while (1) {
 560                 int diff;
 561
 562                 diff = tnow - tstart;
 563                 service = servicex;
 564                 want_exit = 1;
 565                 for (i = 0; i < services; ++i, ++service) {
 566                         if (!*service)
 567                                 continue;
 568                         if ((**service != '/') && (**service != '.')) {
 569                                 if (chdir(varservice) == -1)
 570                                         goto chdir_failed;
 571                         }
 572                         if (chdir(*service) == -1) {
 573  chdir_failed:
 574                                 fail("cannot change to service directory");
 575                                 goto nullify_service;
 576                         }
 577                         if (cbk(acts) != 0)
 578                                 goto nullify_service;
 579                         want_exit = 0;
 580                         if (diff >= waitsec) {
 581                                 printf(kll ? "kill: " : "timeout: ");
 582                                 if (svstatus_get() > 0) {
 583                                         svstatus_print(*service);
 584                                         ++rc;
 585                                 }
 586                                 bb_putchar('\n'); /* will also flush the output */
 587                                 if (kll)
 588                                         control("k");
 589  nullify_service:
 590                                 *service = NULL;
 591                         }
 592                         if (fchdir(curdir) == -1)
 593                                 fatal_cannot("change to original directory");
 594                 }
 595                 if (want_exit) break;
 596                 usleep(420000);
 597                 tnow = time(0) + 0x400000000000000aULL;
 598         }
 599         return rc > 99 ? 99 : rc;
 600 }