2 Copyright (c) 2001-2006, Gerrit Pape
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are met:
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.
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.
28 /* Taken from http://smarden.org/runit/sv.8.html:
30 sv - control and manage services monitored by runsv
32 sv [-v] [-w sec] command services
33 /etc/init.d/service [-w sec] command
35 The sv program reports the current status and controls the state of services
36 monitored by the runsv(8) supervisor.
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 and
40 doesn't end with a slash, it is searched in the default services directory
41 /var/service/, otherwise relative to the current directory.
43 command is one of up, down, status, once, pause, cont, hup, alarm, interrupt,
44 1, 2, term, kill, or exit, or start, stop, reload, restart, shutdown,
45 force-stop, force-reload, force-restart, force-shutdown, try-restart.
48 Report the current status of the service, and the appendant log service
49 if available, to standard output.
51 If the service is not running, start it. If the service stops, restart it.
53 If the service is running, send it the TERM signal, and the CONT signal.
54 If ./run exits, start ./finish if it exists. After it stops, do not
57 If the service is not running, start it. Do not restart it if it stops.
58 pause cont hup alarm interrupt quit 1 2 term kill
59 If the service is running, send it the STOP, CONT, HUP, ALRM, INT, QUIT,
60 USR1, USR2, TERM, or KILL signal respectively.
62 If the service is running, send it the TERM signal, and the CONT signal.
63 Do not restart the service. If the service is down, and no log service
64 exists, runsv(8) exits. If the service is down and a log service exists,
65 runsv(8) closes the standard input of the log service and waits for it to
66 terminate. If the log service is down, runsv(8) exits. This command is
67 ignored if it is given to an appendant log service.
69 sv actually looks only at the first character of above commands.
71 Commands compatible to LSB init script actions:
76 Same as up, but wait up to 7 seconds for the command to take effect.
77 Then report the status or timeout. If the script ./check exists in
78 the service directory, sv runs this script to check whether the service
79 is up and available; it's considered to be available if ./check exits
82 Same as down, but wait up to 7 seconds for the service to become down.
83 Then report the status or timeout.
85 Same as hup, and additionally report the status afterwards.
87 Send the commands term, cont, and up to the service, and wait up to
88 7 seconds for the service to restart. Then report the status or timeout.
89 If the script ./check exists in the service directory, sv runs this script
90 to check whether the service is up and available again; it's considered
91 to be available if ./check exits with 0.
93 Same as exit, but wait up to 7 seconds for the runsv(8) process
94 to terminate. Then report the status or timeout.
96 Same as down, but wait up to 7 seconds for the service to become down.
97 Then report the status, and on timeout send the service the kill command.
99 Send the service the term and cont commands, and wait up to
100 7 seconds for the service to restart. Then report the status,
101 and on timeout send the service the kill command.
103 Send the service the term, cont and up commands, and wait up to
104 7 seconds for the service to restart. Then report the status, and
105 on timeout send the service the kill command. If the script ./check
106 exists in the service directory, sv runs this script to check whether
107 the service is up and available again; it's considered to be available
108 if ./check exits with 0.
110 Same as exit, but wait up to 7 seconds for the runsv(8) process to
111 terminate. Then report the status, and on timeout send the service
114 if the service is running, send it the term and cont commands, and wait up to
115 7 seconds for the service to restart. Then report the status or timeout.
120 Check for the service to be in the state that's been requested. Wait up to
121 7 seconds for the service to reach the requested state, then report
122 the status or timeout. If the requested state of the service is up,
123 and the script ./check exists in the service directory, sv runs
124 this script to check whether the service is up and running;
125 it's considered to be up if ./check exits with 0.
130 If the command is up, down, term, once, cont, or exit, then wait up to 7
131 seconds for the command to take effect. Then report the status or timeout.
133 Override the default timeout of 7 seconds with sec seconds. Implies -v.
138 The environment variable $SVDIR overrides the default services directory
141 The environment variable $SVWAIT overrides the default 7 seconds to wait
142 for a command to take effect. It is overridden by the -w option.
145 sv exits 0, if the command was successfully sent to all services, and,
146 if it was told to wait, the command has taken effect to all services.
148 For each service that caused an error (e.g. the directory is not
149 controlled by a runsv(8) process, or sv timed out while waiting),
150 sv increases the exit code by one and exits non zero. The maximum
151 is 99. sv exits 100 on error.
154 /* Busyboxed by Denys Vlasenko <vda.linux@googlemail.com> */
157 //config: bool "sv (7.8 kb)"
160 //config: sv reports the current status and controls the state of services
161 //config: monitored by the runsv supervisor.
163 //config:config SV_DEFAULT_SERVICE_DIR
164 //config: string "Default directory for services"
165 //config: default "/var/service"
166 //config: depends on SV
168 //config: Default directory for services.
169 //config: Defaults to "/var/service"
172 //config: bool "svc (7.8 kb)"
175 //config: svc controls the state of services monitored by the runsv supervisor.
176 //config: It is comaptible with daemontools command with the same name.
178 //applet:IF_SV(APPLET(sv, BB_DIR_USR_BIN, BB_SUID_DROP))
179 //applet:IF_SVC(APPLET(svc, BB_DIR_USR_BIN, BB_SUID_DROP))
181 //kbuild:lib-$(CONFIG_SV) += sv.o
182 //kbuild:lib-$(CONFIG_SVC) += sv.o
184 #include <sys/file.h>
186 #include "common_bufsiz.h"
187 #include "runit_lib.h"
193 /* "Bernstein" time format: unix + 0x400000000000000aULL */
194 uint64_t tstart, tnow;
198 #define G (*(struct globals*)bb_common_bufsiz1)
199 #define acts (G.acts )
200 #define service (G.service )
202 #define tstart (G.tstart )
203 #define tnow (G.tnow )
204 #define svstatus (G.svstatus )
205 #define islog (G.islog )
206 #define INIT_G() do { setup_common_bufsiz(); } while (0)
209 #define str_equal(s,t) (strcmp((s), (t)) == 0)
212 static void fatal_cannot(const char *m1) NORETURN;
213 static void fatal_cannot(const char *m1)
215 bb_perror_msg("fatal: can't %s", m1);
219 static void out(const char *p, const char *m1)
221 printf("%s%s%s: %s", p, *service, islog ? "/log" : "", m1);
223 printf(": %s", strerror(errno));
225 bb_putchar('\n'); /* will also flush the output */
228 #define WARN "warning: "
231 static void fail(const char *m1)
236 static void failx(const char *m1)
241 static void warn(const char *m1)
244 /* "warning: <service>: <m1>\n" */
245 out("warning: ", m1);
247 static void ok(const char *m1)
253 static int svstatus_get(void)
257 fd = open("supervise/ok", O_WRONLY|O_NDELAY);
259 if (errno == ENODEV) {
260 *acts == 'x' ? ok("runsv not running")
261 : failx("runsv not running");
264 warn("can't open supervise/ok");
268 fd = open("supervise/status", O_RDONLY|O_NDELAY);
270 warn("can't open supervise/status");
273 r = read(fd, &svstatus, 20);
279 warn("can't read supervise/status");
283 warn("can't read supervise/status: bad format");
289 static unsigned svstatus_print(const char *m)
297 if (stat("down", &s) == -1) {
298 if (errno != ENOENT) {
299 bb_perror_msg(WARN"can't stat %s/down", *service);
304 pid = SWAP_LE32(svstatus.pid_le32);
305 timestamp = SWAP_BE64(svstatus.time_be64);
306 switch (svstatus.run_or_finish) {
307 case 0: printf("down: "); break;
308 case 1: printf("run: "); break;
309 case 2: printf("finish: "); break;
312 if (svstatus.run_or_finish)
313 printf("(pid %d) ", pid);
314 diff = tnow - timestamp;
315 printf("%us", (diff < 0 ? 0 : diff));
317 if (!normallyup) printf(", normally down");
318 if (svstatus.paused) printf(", paused");
319 if (svstatus.want == 'd') printf(", want down");
320 if (svstatus.got_term) printf(", got TERM");
322 if (normallyup) printf(", normally up");
323 if (svstatus.want == 'u') printf(", want up");
328 static int status(const char *unused UNUSED_PARAM)
332 if (svstatus_get() <= 0)
335 r = svstatus_print(*service);
337 if (chdir("log") == -1) {
338 if (errno != ENOENT) {
340 warn("can't change directory");
345 if (svstatus_get()) {
346 r = svstatus_print("log");
354 static int checkscript(void)
360 if (stat("check", &s) == -1) {
361 if (errno == ENOENT) return 1;
362 bb_perror_msg(WARN"can't stat %s/check", *service);
365 /* if (!(s.st_mode & S_IXUSR)) return 1; */
366 prog[0] = (char*)"./check";
370 bb_perror_msg(WARN"can't %s child %s/check", "run", *service);
373 while (safe_waitpid(pid, &w, 0) == -1) {
374 bb_perror_msg(WARN"can't %s child %s/check", "wait for", *service);
377 return WEXITSTATUS(w) == 0;
380 static int check(const char *a)
395 pid_le32 = svstatus.pid_le32;
400 if (!pid_le32 || svstatus.run_or_finish != 1)
406 if (pid_le32 || svstatus.run_or_finish != 0)
410 if (pid_le32 && !checkscript())
415 if (!pid_le32 && svstatus.want == 'd')
417 timestamp = SWAP_BE64(svstatus.time_be64);
418 if ((tstart > timestamp) || !pid_le32 || svstatus.got_term || !checkscript())
422 timestamp = SWAP_BE64(svstatus.time_be64);
423 if ((!pid_le32 && tstart > timestamp) || (pid_le32 && svstatus.want != 'd'))
427 if (pid_le32 && !svstatus.paused)
431 if (pid_le32 && svstatus.paused)
438 svstatus_print(*service);
439 bb_putchar('\n'); /* will also flush the output */
443 static int control(const char *a)
447 if (svstatus_get() <= 0)
449 if (svstatus.want == *a && (*a != 'd' || svstatus.got_term == 1))
451 fd = open("supervise/control", O_WRONLY|O_NDELAY);
454 warn("can't open supervise/control");
456 *a == 'x' ? ok("runsv not running") : failx("runsv not running");
463 warn("can't write to supervise/control");
469 //usage:#define sv_trivial_usage
470 //usage: "[-v] [-w SEC] CMD SERVICE_DIR..."
471 //usage:#define sv_full_usage "\n\n"
472 //usage: "Control services monitored by runsv supervisor.\n"
473 //usage: "Commands (only first character is enough):\n"
475 //usage: "status: query service status\n"
476 //usage: "up: if service isn't running, start it. If service stops, restart it\n"
477 //usage: "once: like 'up', but if service stops, don't restart it\n"
478 //usage: "down: send TERM and CONT signals. If ./run exits, start ./finish\n"
479 //usage: " if it exists. After it stops, don't restart service\n"
480 //usage: "exit: send TERM and CONT signals to service and log service. If they exit,\n"
481 //usage: " runsv exits too\n"
482 //usage: "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n"
483 //usage: "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
484 static int sv(char **argv)
488 const char *varservice = CONFIG_SV_DEFAULT_SERVICE_DIR;
489 unsigned waitsec = 7;
492 int (*act)(const char*);
493 int (*cbk)(const char*);
498 xfunc_error_retval = 100;
501 if (x) varservice = x;
502 x = getenv("SVWAIT");
503 if (x) waitsec = xatou(x);
505 opt_complementary = "vv"; /* -w N, -v is a counter */
506 getopt32(argv, "w:+v", &waitsec, &verbose);
509 if (!action || !*argv) bb_show_usage();
511 tnow = time(NULL) + 0x400000000000000aULL;
513 curdir = open(".", O_RDONLY|O_NDELAY);
515 fatal_cannot("open current directory");
525 if (!verbose) cbk = NULL;
541 if (str_equal(action, "try-restart")) {
546 if (str_equal(action, "check")) {
551 case 'u': case 'd': case 'o': case 'p': case 'h':
552 case 'a': case 'i': case 'k': case 'q': case '1': case '2':
559 if (str_equal(action, "shutdown")) {
563 if (str_equal(action, "start")) {
567 if (str_equal(action, "stop")) {
576 if (str_equal(action, "restart")) {
580 if (str_equal(action, "reload")) {
586 if (str_equal(action, "force-reload")) {
591 if (str_equal(action, "force-restart")) {
596 if (str_equal(action, "force-shutdown")) {
601 if (str_equal(action, "force-stop")) {
611 while ((x = *service) != NULL) {
612 if (x[0] != '/' && x[0] != '.'
613 && x[0] != '\0' && x[strlen(x) - 1] != '/'
615 if (chdir(varservice) == -1)
618 if (chdir(x) == -1) {
620 fail("can't change to service directory");
621 goto nullify_service_0;
623 if (act && (act(acts) == -1)) {
625 *service = (char*) -1L; /* "dead" */
627 if (fchdir(curdir) == -1)
628 fatal_cannot("change to original directory");
636 diff = tnow - tstart;
639 while ((x = *service) != NULL) {
640 if (x == (char*) -1L) /* "dead" */
642 if (x[0] != '/' && x[0] != '.') {
643 if (chdir(varservice) == -1)
646 if (chdir(x) == -1) {
648 fail("can't change to service directory");
649 goto nullify_service;
652 goto nullify_service;
654 if (diff >= waitsec) {
655 printf(kll ? "kill: " : "timeout: ");
656 if (svstatus_get() > 0) {
660 bb_putchar('\n'); /* will also flush the output */
664 *service = (char*) -1L; /* "dead" */
666 if (fchdir(curdir) == -1)
667 fatal_cannot("change to original directory");
671 if (want_exit) break;
673 tnow = time(NULL) + 0x400000000000000aULL;
675 return rc > 99 ? 99 : rc;
679 int sv_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
680 int sv_main(int argc UNUSED_PARAM, char **argv)
686 //usage:#define svc_trivial_usage
687 //usage: "[-udopchaitkx] SERVICE_DIR..."
688 //usage:#define svc_full_usage "\n\n"
689 //usage: "Control services monitored by runsv supervisor"
691 //usage: "\n"" -u If service is not running, start it; restart if it stops"
692 //usage: "\n"" -d If service is running, send TERM+CONT signals; do not restart it"
693 //usage: "\n"" -o Once: if service is not running, start it; do not restart it"
694 //usage: "\n"" -pchaitk Send STOP, CONT, HUP, ALRM, INT, TERM, KILL signal to service"
695 //usage: "\n"" -x Exit: runsv will exit as soon as the service is down"
697 int svc_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
698 int svc_main(int argc UNUSED_PARAM, char **argv)
701 const char *optstring;
706 optstring = "udopchaitkx";
707 opts = getopt32(argv, optstring);
709 if (!argv[0] || !opts)
715 argv[2] = (char*)"--";
717 argv[0] = (char*)"sv";
721 /* getopt32() was already called:
722 * reset the libc getopt() function, which keeps internal state.
729 command[0] = *optstring;