ash: fix for read $IFS splitting. Closes bug 235
[oweals/busybox.git] / runit / sv.c
index 2af9f6604feb79211d16dda0be479ab44594feb5..96ebb749d41d2a906a5070cceb77da6e73cfff4b 100644 (file)
-/* Busyboxed by Denis Vlasenko <vda.linux@googlemail.com> */
+/*
+Copyright (c) 2001-2006, Gerrit Pape
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+   3. The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+/* Taken from http://smarden.sunsite.dk/runit/sv.8.html:
+
+sv - control and manage services monitored by runsv
+
+sv [-v] [-w sec] command services
+/etc/init.d/service [-w sec] command
+
+The sv program reports the current status and controls the state of services
+monitored by the runsv(8) supervisor.
+
+services consists of one or more arguments, each argument naming a directory
+service used by runsv(8). If service doesn't start with a dot or slash,
+it is searched in the default services directory /var/service/, otherwise
+relative to the current directory.
+
+command is one of up, down, status, once, pause, cont, hup, alarm, interrupt,
+1, 2, term, kill, or exit, or start, stop, restart, shutdown, force-stop,
+force-reload, force-restart, force-shutdown.
+
+The sv program can be sym-linked to /etc/init.d/ to provide an LSB init
+script interface. The service to be controlled then is specified by the
+base name of the "init script".
+
+status
+    Report the current status of the service, and the appendant log service
+    if available, to standard output.
+up
+    If the service is not running, start it. If the service stops, restart it.
+down
+    If the service is running, send it the TERM signal, and the CONT signal.
+    If ./run exits, start ./finish if it exists. After it stops, do not
+    restart service.
+once
+    If the service is not running, start it. Do not restart it if it stops.
+pause cont hup alarm interrupt quit 1 2 term kill
+    If the service is running, send it the STOP, CONT, HUP, ALRM, INT, QUIT,
+    USR1, USR2, TERM, or KILL signal respectively.
+exit
+    If the service is running, send it the TERM signal, and the CONT signal.
+    Do not restart the service. If the service is down, and no log service
+    exists, runsv(8) exits. If the service is down and a log service exists,
+    send the TERM signal to the log service. If the log service is down,
+    runsv(8) exits. This command is ignored if it is given to an appendant
+    log service.
+
+sv actually looks only at the first character of above commands.
+
+Commands compatible to LSB init script actions:
+
+status
+    Same as status.
+start
+    Same as up, but wait up to 7 seconds for the command to take effect.
+    Then report the status or timeout. If the script ./check exists in
+    the service directory, sv runs this script to check whether the service
+    is up and available; it's considered to be available if ./check exits
+    with 0.
+stop
+    Same as down, but wait up to 7 seconds for the service to become down.
+    Then report the status or timeout.
+restart
+    Send the commands term, cont, and up to the service, and wait up to
+    7 seconds for the service to restart. Then report the status or timeout.
+    If the script ./check exists in the service directory, sv runs this script
+    to check whether the service is up and available again; it's considered
+    to be available if ./check exits with 0.
+shutdown
+    Same as exit, but wait up to 7 seconds for the runsv(8) process
+    to terminate. Then report the status or timeout.
+force-stop
+    Same as down, but wait up to 7 seconds for the service to become down.
+    Then report the status, and on timeout send the service the kill command.
+force-reload
+    Send the service the term and cont commands, and wait up to
+    7 seconds for the service to restart. Then report the status,
+    and on timeout send the service the kill command.
+force-restart
+    Send the service the term, cont and up commands, and wait up to
+    7 seconds for the service to restart. Then report the status, and
+    on timeout send the service the kill command. If the script ./check
+    exists in the service directory, sv runs this script to check whether
+    the service is up and available again; it's considered to be available
+    if ./check exits with 0.
+force-shutdown
+    Same as exit, but wait up to 7 seconds for the runsv(8) process to
+    terminate. Then report the status, and on timeout send the service
+    the kill command.
+
+Additional Commands
+
+check
+    Check for the service to be in the state that's been requested. Wait up to
+    7 seconds for the service to reach the requested state, then report
+    the status or timeout. If the requested state of the service is up,
+    and the script ./check exists in the service directory, sv runs
+    this script to check whether the service is up and running;
+    it's considered to be up if ./check exits with 0.
+
+Options
+
+-v
+    wait up to 7 seconds for the command to take effect.
+    Then report the status or timeout.
+-w sec
+    Override the default timeout of 7 seconds with sec seconds. Implies -v.
+
+Environment
+
+SVDIR
+    The environment variable $SVDIR overrides the default services directory
+    /var/service.
+SVWAIT
+    The environment variable $SVWAIT overrides the default 7 seconds to wait
+    for a command to take effect. It is overridden by the -w option.
+
+Exit Codes
+    sv exits 0, if the command was successfully sent to all services, and,
+    if it was told to wait, the command has taken effect to all services.
+
+    For each service that caused an error (e.g. the directory is not
+    controlled by a runsv(8) process, or sv timed out while waiting),
+    sv increases the exit code by one and exits non zero. The maximum
+    is 99. sv exits 100 on error.
+*/
+
+/* Busyboxed by Denys Vlasenko <vda.linux@googlemail.com> */
 /* TODO: depends on runit_lib.c - review and reduce/eliminate */
 
 #include <sys/poll.h>
 #include <sys/file.h>
-#include "busybox.h"
+#include "libbb.h"
 #include "runit_lib.h"
 
-static const char *acts;
-static char **service;
-static unsigned rc;
-static struct taia tstart, tnow;
-static char svstatus[20];
+struct globals {
+       const char *acts;
+       char **service;
+       unsigned rc;
+/* "Bernstein" time format: unix + 0x400000000000000aULL */
+       uint64_t tstart, tnow;
+       svstatus_t svstatus;
+};
+#define G (*(struct globals*)&bb_common_bufsiz1)
+#define acts         (G.acts        )
+#define service      (G.service     )
+#define rc           (G.rc          )
+#define tstart       (G.tstart      )
+#define tnow         (G.tnow        )
+#define svstatus     (G.svstatus    )
+#define INIT_G() do { } while (0)
 
-#define usage() bb_show_usage()
 
-static void fatal_cannot(const char *m1) ATTRIBUTE_NORETURN;
+static void fatal_cannot(const char *m1) NORETURN;
 static void fatal_cannot(const char *m1)
 {
-       bb_perror_msg("fatal: cannot %s", m1);
+       bb_perror_msg("fatal: can't %s", m1);
        _exit(151);
 }
 
@@ -27,29 +189,30 @@ static void out(const char *p, const char *m1)
        if (errno) {
                printf(": %s", strerror(errno));
        }
-       puts(""); /* will also flush the output */
+       bb_putchar('\n'); /* will also flush the output */
 }
 
 #define WARN    "warning: "
 #define OK      "ok: "
 
-static void fail(const char *m1) {
+static void fail(const char *m1)
+{
        ++rc;
        out("fail: ", m1);
 }
-static void failx(const char *m1) {
+static void failx(const char *m1)
+{
        errno = 0;
        fail(m1);
 }
-static void warn_cannot(const char *m1) {
+static void warn(const char *m1)
+{
        ++rc;
-       out("warning: cannot ", m1);
+       /* "warning: <service>: <m1>\n" */
+       out("warning: ", m1);
 }
-static void warnx_cannot(const char *m1) {
-       errno = 0;
-       warn_cannot(m1);
-}
-static void ok(const char *m1) {
+static void ok(const char *m1)
+{
        errno = 0;
        out(OK, m1);
 }
@@ -65,47 +228,50 @@ static int svstatus_get(void)
                                     : failx("runsv not running");
                        return 0;
                }
-               warn_cannot("open supervise/ok");
+               warn("can't open supervise/ok");
                return -1;
        }
        close(fd);
        fd = open_read("supervise/status");
        if (fd == -1) {
-               warn_cannot("open supervise/status");
+               warn("can't open supervise/status");
                return -1;
        }
-       r = read(fd, svstatus, 20);
+       r = read(fd, &svstatus, 20);
        close(fd);
        switch (r) {
-       case 20: break;
-       case -1: warn_cannot("read supervise/status"); return -1;
-       default: warnx_cannot("read supervise/status: bad format"); return -1;
+       case 20:
+               break;
+       case -1:
+               warn("can't read supervise/status");
+               return -1;
+       default:
+               errno = 0;
+               warn("can't read supervise/status: bad format");
+               return -1;
        }
        return 1;
 }
 
 static unsigned svstatus_print(const char *m)
 {
-       long diff;
+       int diff;
        int pid;
        int normallyup = 0;
        struct stat s;
-       struct tai tstatus;
+       uint64_t timestamp;
 
        if (stat("down", &s) == -1) {
                if (errno != ENOENT) {
-                       bb_perror_msg(WARN"cannot stat %s/down", *service);
+                       bb_perror_msg(WARN"can't stat %s/down", *service);
                        return 0;
                }
                normallyup = 1;
        }
-       pid = (unsigned char) svstatus[15];
-       pid <<= 8; pid += (unsigned char)svstatus[14];
-       pid <<= 8; pid += (unsigned char)svstatus[13];
-       pid <<= 8; pid += (unsigned char)svstatus[12];
-       tai_unpack(svstatus, &tstatus);
+       pid = SWAP_LE32(svstatus.pid_le32);
+       timestamp = SWAP_BE64(svstatus.time_be64);
        if (pid) {
-               switch (svstatus[19]) {
+               switch (svstatus.run_or_finish) {
                case 1: printf("run: "); break;
                case 2: printf("finish: "); break;
                }
@@ -113,38 +279,38 @@ static unsigned svstatus_print(const char *m)
        } else {
                printf("down: %s: ", m);
        }
-       diff = tnow.sec.x - tstatus.x;
-       printf("%lds", (diff < 0 ? 0L : diff));
+       diff = tnow - timestamp;
+       printf("%us", (diff < 0 ? 0 : diff));
        if (pid) {
                if (!normallyup) printf(", normally down");
+               if (svstatus.paused) printf(", paused");
+               if (svstatus.want == 'd') printf(", want down");
+               if (svstatus.got_term) printf(", got TERM");
        } else {
                if (normallyup) printf(", normally up");
+               if (svstatus.want == 'u') printf(", want up");
        }
-       if (pid && svstatus[16]) printf(", paused");
-       if (!pid && (svstatus[17] == 'u')) printf(", want up");
-       if (pid && (svstatus[17] == 'd')) printf(", want down");
-       if (pid && svstatus[18]) printf(", got TERM");
        return pid ? 1 : 2;
 }
 
-static int status(const char *unused)
+static int status(const char *unused UNUSED_PARAM)
 {
        int r;
 
-       r = svstatus_get();
-       switch (r) { case -1: case 0: return 0; }
+       if (svstatus_get() <= 0)
+               return 0;
 
        r = svstatus_print(*service);
        if (chdir("log") == -1) {
                if (errno != ENOENT) {
-                       printf("; log: "WARN"cannot change to log service directory: %s",
+                       printf("; log: "WARN"can't change to log service directory: %s",
                                        strerror(errno));
                }
        } else if (svstatus_get()) {
                printf("; ");
                svstatus_print("log");
        }
-       puts(""); /* will also flush the output */
+       bb_putchar('\n'); /* will also flush the output */
        return r;
 }
 
@@ -156,35 +322,29 @@ static int checkscript(void)
 
        if (stat("check", &s) == -1) {
                if (errno == ENOENT) return 1;
-               bb_perror_msg(WARN"cannot stat %s/check", *service);
+               bb_perror_msg(WARN"can't stat %s/check", *service);
                return 0;
        }
        /* if (!(s.st_mode & S_IXUSR)) return 1; */
-       if ((pid = fork()) == -1) {
-               bb_perror_msg(WARN"cannot fork for %s/check", *service);
+       prog[0] = (char*)"./check";
+       prog[1] = NULL;
+       pid = spawn(prog);
+       if (pid <= 0) {
+               bb_perror_msg(WARN"can't %s child %s/check", "run", *service);
                return 0;
        }
-       if (!pid) {
-               prog[0] = (char*)"./check";
-               prog[1] = NULL;
-               close(1);
-               execve("check", prog, environ);
-               bb_perror_msg(WARN"cannot run %s/check", *service);
-               _exit(0);
-       }
-       while (wait_pid(&w, pid) == -1) {
-               if (errno == EINTR) continue;
-               bb_perror_msg(WARN"cannot wait for child %s/check", *service);
+       while (safe_waitpid(pid, &w, 0) == -1) {
+               bb_perror_msg(WARN"can't %s child %s/check", "wait for", *service);
                return 0;
        }
-       return !wait_exitcode(w);
+       return WEXITSTATUS(w) == 0;
 }
 
 static int check(const char *a)
 {
        int r;
-       unsigned pid;
-       struct tai tstatus;
+       unsigned pid_le32;
+       uint64_t timestamp;
 
        r = svstatus_get();
        if (r == -1)
@@ -194,97 +354,97 @@ static int check(const char *a)
                        return 1;
                return -1;
        }
-       pid = (unsigned char)svstatus[15];
-       pid <<= 8; pid += (unsigned char)svstatus[14];
-       pid <<= 8; pid += (unsigned char)svstatus[13];
-       pid <<= 8; pid += (unsigned char)svstatus[12];
+       pid_le32 = svstatus.pid_le32;
        switch (*a) {
        case 'x':
                return 0;
        case 'u':
-               if (!pid || svstatus[19] != 1) return 0;
+               if (!pid_le32 || svstatus.run_or_finish != 1) return 0;
                if (!checkscript()) return 0;
                break;
        case 'd':
-               if (pid) return 0;
+               if (pid_le32) return 0;
                break;
        case 'c':
-               if (pid && !checkscript()) return 0;
+               if (pid_le32 && !checkscript()) return 0;
                break;
        case 't':
-               if (!pid && svstatus[17] == 'd') break;
-               tai_unpack(svstatus, &tstatus);
-               if ((tstart.sec.x > tstatus.x) || !pid || svstatus[18] || !checkscript())
+               if (!pid_le32 && svstatus.want == 'd') break;
+               timestamp = SWAP_BE64(svstatus.time_be64);
+               if ((tstart > timestamp) || !pid_le32 || svstatus.got_term || !checkscript())
                        return 0;
                break;
        case 'o':
-               tai_unpack(svstatus, &tstatus);
-               if ((!pid && tstart.sec.x > tstatus.x) || (pid && svstatus[17] != 'd'))
+               timestamp = SWAP_BE64(svstatus.time_be64);
+               if ((!pid_le32 && tstart > timestamp) || (pid_le32 && svstatus.want != 'd'))
                        return 0;
        }
        printf(OK);
        svstatus_print(*service);
-       puts(""); /* will also flush the output */
+       bb_putchar('\n'); /* will also flush the output */
        return 1;
 }
 
 static int control(const char *a)
 {
-       int fd, r;
+       int fd, r, l;
 
-       if (svstatus_get() <= 0) return -1;
-       if (svstatus[17] == *a) return 0;
+/* Is it an optimization?
+   It causes problems with "sv o SRV; ...; sv d SRV"
+   ('d' is not passed to SRV because its .want == 'd'):
+       if (svstatus_get() <= 0)
+               return -1;
+       if (svstatus.want == *a)
+               return 0;
+*/
        fd = open_write("supervise/control");
        if (fd == -1) {
                if (errno != ENODEV)
-                       warn_cannot("open supervise/control");
+                       warn("can't open supervise/control");
                else
                        *a == 'x' ? ok("runsv not running") : failx("runsv not running");
                return -1;
        }
-       r = write(fd, a, strlen(a));
+       l = strlen(a);
+       r = write(fd, a, l);
        close(fd);
-       if (r != strlen(a)) {
-               warn_cannot("write to supervise/control");
+       if (r != l) {
+               warn("can't write to supervise/control");
                return -1;
        }
        return 1;
 }
 
-int sv_main(int argc, char **argv)
+int sv_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
+int sv_main(int argc UNUSED_PARAM, char **argv)
 {
        unsigned opt;
-       unsigned i, want_exit;
        char *x;
        char *action;
-       const char *varservice = "/var/service/";
-       unsigned services;
-       char **servicex;
-       unsigned long waitsec = 7;
+       const char *varservice = CONFIG_SV_DEFAULT_SERVICE_DIR;
+       unsigned waitsec = 7;
        smallint kll = 0;
-       smallint verbose = 0;
+       int verbose = 0;
        int (*act)(const char*);
        int (*cbk)(const char*);
        int curdir;
 
+       INIT_G();
+
        xfunc_error_retval = 100;
 
        x = getenv("SVDIR");
        if (x) varservice = x;
        x = getenv("SVWAIT");
-       if (x) waitsec = xatoul(x);
+       if (x) waitsec = xatou(x);
 
-       opt = getopt32(argc, argv, "w:v", &x);
-       if (opt & 1) waitsec = xatoul(x); // -w
-       if (opt & 2) verbose = 1; // -v
-       argc -= optind;
+       opt_complementary = "w+:vv"; /* -w N, -v is a counter */
+       opt = getopt32(argv, "w:v", &waitsec, &verbose);
        argv += optind;
        action = *argv++;
-       if (!action || !*argv) usage();
-       service = argv;
-       services = argc - 1;
+       if (!action || !*argv) bb_show_usage();
 
-       taia_now(&tnow);
+       tnow = time(NULL) + 0x400000000000000aULL;
        tstart = tnow;
        curdir = open_read(".");
        if (curdir == -1)
@@ -314,7 +474,7 @@ int sv_main(int argc, char **argv)
                kll = 1;
                break;
        case 'c':
-               if (!str_diff(action, "check")) {
+               if (str_equal(action, "check")) {
                        act = NULL;
                        acts = "c";
                        break;
@@ -326,15 +486,15 @@ int sv_main(int argc, char **argv)
                if (!verbose) cbk = NULL;
                break;
        case 's':
-               if (!str_diff(action, "shutdown")) {
+               if (str_equal(action, "shutdown")) {
                        acts = "x";
                        break;
                }
-               if (!str_diff(action, "start")) {
+               if (str_equal(action, "start")) {
                        acts = "u";
                        break;
                }
-               if (!str_diff(action, "stop")) {
+               if (str_equal(action, "stop")) {
                        acts = "d";
                        break;
                }
@@ -343,50 +503,50 @@ int sv_main(int argc, char **argv)
                cbk = NULL;
                break;
        case 'r':
-               if (!str_diff(action, "restart")) {
+               if (str_equal(action, "restart")) {
                        acts = "tcu";
                        break;
                }
-               usage();
+               bb_show_usage();
        case 'f':
-               if (!str_diff(action, "force-reload")) {
+               if (str_equal(action, "force-reload")) {
                        acts = "tc";
                        kll = 1;
                        break;
                }
-               if (!str_diff(action, "force-restart")) {
+               if (str_equal(action, "force-restart")) {
                        acts = "tcu";
                        kll = 1;
                        break;
                }
-               if (!str_diff(action, "force-shutdown")) {
+               if (str_equal(action, "force-shutdown")) {
                        acts = "x";
                        kll = 1;
                        break;
                }
-               if (!str_diff(action, "force-stop")) {
+               if (str_equal(action, "force-stop")) {
                        acts = "d";
                        kll = 1;
                        break;
                }
        default:
-               usage();
+               bb_show_usage();
        }
 
-       servicex = service;
-       for (i = 0; i < services; ++i) {
-               if ((**service != '/') && (**service != '.')) {
+       service = argv;
+       while ((x = *service) != NULL) {
+               if (x[0] != '/' && x[0] != '.') {
                        if (chdir(varservice) == -1)
                                goto chdir_failed_0;
                }
-               if (chdir(*service) == -1) {
+               if (chdir(x) == -1) {
  chdir_failed_0:
-                       fail("cannot change to service directory");
+                       fail("can't change to service directory");
                        goto nullify_service_0;
                }
                if (act && (act(acts) == -1)) {
  nullify_service_0:
-                       *service = NULL;
+                       *service = (char*) -1L; /* "dead" */
                }
                if (fchdir(curdir) == -1)
                        fatal_cannot("change to original directory");
@@ -394,23 +554,22 @@ int sv_main(int argc, char **argv)
        }
 
        if (cbk) while (1) {
-               //struct taia tdiff;
-               long diff;
+               int want_exit;
+               int diff;
 
-               //taia_sub(&tdiff, &tnow, &tstart);
-               diff = tnow.sec.x - tstart.sec.x;
-               service = servicex;
+               diff = tnow - tstart;
+               service = argv;
                want_exit = 1;
-               for (i = 0; i < services; ++i, ++service) {
-                       if (!*service)
-                               continue;
-                       if ((**service != '/') && (**service != '.')) {
+               while ((x = *service) != NULL) {
+                       if (x == (char*) -1L) /* "dead" */
+                               goto next;
+                       if (x[0] != '/' && x[0] != '.') {
                                if (chdir(varservice) == -1)
                                        goto chdir_failed;
                        }
-                       if (chdir(*service) == -1) {
+                       if (chdir(x) == -1) {
  chdir_failed:
-                               fail("cannot change to service directory");
+                               fail("can't change to service directory");
                                goto nullify_service;
                        }
                        if (cbk(acts) != 0)
@@ -419,21 +578,23 @@ int sv_main(int argc, char **argv)
                        if (diff >= waitsec) {
                                printf(kll ? "kill: " : "timeout: ");
                                if (svstatus_get() > 0) {
-                                       svstatus_print(*service);
+                                       svstatus_print(x);
                                        ++rc;
                                }
-                               puts(""); /* will also flush the output */
+                               bb_putchar('\n'); /* will also flush the output */
                                if (kll)
                                        control("k");
  nullify_service:
-                               *service = NULL;
+                               *service = (char*) -1L; /* "dead" */
                        }
                        if (fchdir(curdir) == -1)
                                fatal_cannot("change to original directory");
+ next:
+                       service++;
                }
                if (want_exit) break;
                usleep(420000);
-               taia_now(&tnow);
+               tnow = time(NULL) + 0x400000000000000aULL;
        }
        return rc > 99 ? 99 : rc;
 }