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_NOEXEC(sv, sv, BB_DIR_USR_BIN, BB_SUID_DROP, sv ))
179 //applet:IF_SVC(APPLET_NOEXEC(svc, svc, BB_DIR_USR_BIN, BB_SUID_DROP, svc))
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 { \
207 setup_common_bufsiz(); \
208 /* need to zero out, we are NOEXEC */ \
211 /* other fields need not be zero */ \
215 #define str_equal(s,t) (strcmp((s), (t)) == 0)
218 static void fatal_cannot(const char *m1) NORETURN;
219 static void fatal_cannot(const char *m1)
221 bb_perror_msg("fatal: can't %s", m1);
225 static void out(const char *p, const char *m1)
227 printf("%s%s%s: %s", p, *service, islog ? "/log" : "", m1);
229 printf(": %s", strerror(errno));
231 bb_putchar('\n'); /* will also flush the output */
234 #define WARN "warning: "
237 static void fail(const char *m1)
242 static void failx(const char *m1)
247 static void warn(const char *m1)
250 /* "warning: <service>: <m1>\n" */
251 out("warning: ", m1);
253 static void ok(const char *m1)
259 static int svstatus_get(void)
263 fd = open("supervise/ok", O_WRONLY|O_NDELAY);
265 if (errno == ENODEV) {
266 *acts == 'x' ? ok("runsv not running")
267 : failx("runsv not running");
270 warn("can't open supervise/ok");
274 fd = open("supervise/status", O_RDONLY|O_NDELAY);
276 warn("can't open supervise/status");
279 r = read(fd, &svstatus, 20);
285 warn("can't read supervise/status");
289 warn("can't read supervise/status: bad format");
295 static unsigned svstatus_print(const char *m)
303 if (stat("down", &s) == -1) {
304 if (errno != ENOENT) {
305 bb_perror_msg(WARN"can't stat %s/down", *service);
310 pid = SWAP_LE32(svstatus.pid_le32);
311 timestamp = SWAP_BE64(svstatus.time_be64);
312 switch (svstatus.run_or_finish) {
313 case 0: printf("down: "); break;
314 case 1: printf("run: "); break;
315 case 2: printf("finish: "); break;
318 if (svstatus.run_or_finish)
319 printf("(pid %d) ", pid);
320 diff = tnow - timestamp;
321 printf("%us", (diff < 0 ? 0 : diff));
323 if (!normallyup) printf(", normally down");
324 if (svstatus.paused) printf(", paused");
325 if (svstatus.want == 'd') printf(", want down");
326 if (svstatus.got_term) printf(", got TERM");
328 if (normallyup) printf(", normally up");
329 if (svstatus.want == 'u') printf(", want up");
334 static int status(const char *unused UNUSED_PARAM)
338 if (svstatus_get() <= 0)
341 r = svstatus_print(*service);
343 if (chdir("log") == -1) {
344 if (errno != ENOENT) {
346 warn("can't change directory");
351 if (svstatus_get()) {
352 r = svstatus_print("log");
360 static int checkscript(void)
366 if (stat("check", &s) == -1) {
367 if (errno == ENOENT) return 1;
368 bb_perror_msg(WARN"can't stat %s/check", *service);
371 /* if (!(s.st_mode & S_IXUSR)) return 1; */
372 prog[0] = (char*)"./check";
376 bb_perror_msg(WARN"can't %s child %s/check", "run", *service);
379 while (safe_waitpid(pid, &w, 0) == -1) {
380 bb_perror_msg(WARN"can't %s child %s/check", "wait for", *service);
383 return WEXITSTATUS(w) == 0;
386 static int check(const char *a)
401 pid_le32 = svstatus.pid_le32;
406 if (!pid_le32 || svstatus.run_or_finish != 1)
412 if (pid_le32 || svstatus.run_or_finish != 0)
416 if (pid_le32 && !checkscript())
421 if (!pid_le32 && svstatus.want == 'd')
423 timestamp = SWAP_BE64(svstatus.time_be64);
424 if ((tstart > timestamp) || !pid_le32 || svstatus.got_term || !checkscript())
428 timestamp = SWAP_BE64(svstatus.time_be64);
429 if ((!pid_le32 && tstart > timestamp) || (pid_le32 && svstatus.want != 'd'))
433 if (pid_le32 && !svstatus.paused)
437 if (pid_le32 && svstatus.paused)
444 svstatus_print(*service);
445 bb_putchar('\n'); /* will also flush the output */
449 static int control(const char *a)
453 if (svstatus_get() <= 0)
455 if (svstatus.want == *a && (*a != 'd' || svstatus.got_term == 1))
457 fd = open("supervise/control", O_WRONLY|O_NDELAY);
460 warn("can't open supervise/control");
462 *a == 'x' ? ok("runsv not running") : failx("runsv not running");
469 warn("can't write to supervise/control");
475 //usage:#define sv_trivial_usage
476 //usage: "[-v] [-w SEC] CMD SERVICE_DIR..."
477 //usage:#define sv_full_usage "\n\n"
478 //usage: "Control services monitored by runsv supervisor.\n"
479 //usage: "Commands (only first character is enough):\n"
481 //usage: "status: query service status\n"
482 //usage: "up: if service isn't running, start it. If service stops, restart it\n"
483 //usage: "once: like 'up', but if service stops, don't restart it\n"
484 //usage: "down: send TERM and CONT signals. If ./run exits, start ./finish\n"
485 //usage: " if it exists. After it stops, don't restart service\n"
486 //usage: "exit: send TERM and CONT signals to service and log service. If they exit,\n"
487 //usage: " runsv exits too\n"
488 //usage: "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n"
489 //usage: "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
490 static int sv(char **argv)
494 const char *varservice = CONFIG_SV_DEFAULT_SERVICE_DIR;
495 unsigned waitsec = 7;
498 int (*act)(const char*);
499 int (*cbk)(const char*);
504 xfunc_error_retval = 100;
507 if (x) varservice = x;
508 x = getenv("SVWAIT");
509 if (x) waitsec = xatou(x);
511 opt_complementary = "vv"; /* -w N, -v is a counter */
512 getopt32(argv, "w:+v", &waitsec, &verbose);
515 if (!action || !*argv) bb_show_usage();
517 tnow = time(NULL) + 0x400000000000000aULL;
519 curdir = open(".", O_RDONLY|O_NDELAY);
521 fatal_cannot("open current directory");
531 if (!verbose) cbk = NULL;
547 if (str_equal(action, "try-restart")) {
552 if (str_equal(action, "check")) {
557 case 'u': case 'd': case 'o': case 'p': case 'h':
558 case 'a': case 'i': case 'k': case 'q': case '1': case '2':
565 if (str_equal(action, "shutdown")) {
569 if (str_equal(action, "start")) {
573 if (str_equal(action, "stop")) {
582 if (str_equal(action, "restart")) {
586 if (str_equal(action, "reload")) {
592 if (str_equal(action, "force-reload")) {
597 if (str_equal(action, "force-restart")) {
602 if (str_equal(action, "force-shutdown")) {
607 if (str_equal(action, "force-stop")) {
617 while ((x = *service) != NULL) {
618 if (x[0] != '/' && x[0] != '.'
619 && x[0] != '\0' && x[strlen(x) - 1] != '/'
621 if (chdir(varservice) == -1)
624 if (chdir(x) == -1) {
626 fail("can't change to service directory");
627 goto nullify_service_0;
629 if (act && (act(acts) == -1)) {
631 *service = (char*) -1L; /* "dead" */
633 if (fchdir(curdir) == -1)
634 fatal_cannot("change to original directory");
642 diff = tnow - tstart;
645 while ((x = *service) != NULL) {
646 if (x == (char*) -1L) /* "dead" */
648 if (x[0] != '/' && x[0] != '.') {
649 if (chdir(varservice) == -1)
652 if (chdir(x) == -1) {
654 fail("can't change to service directory");
655 goto nullify_service;
658 goto nullify_service;
660 if (diff >= waitsec) {
661 printf(kll ? "kill: " : "timeout: ");
662 if (svstatus_get() > 0) {
666 bb_putchar('\n'); /* will also flush the output */
670 *service = (char*) -1L; /* "dead" */
672 if (fchdir(curdir) == -1)
673 fatal_cannot("change to original directory");
677 if (want_exit) break;
679 tnow = time(NULL) + 0x400000000000000aULL;
681 return rc > 99 ? 99 : rc;
685 int sv_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
686 int sv_main(int argc UNUSED_PARAM, char **argv)
692 //usage:#define svc_trivial_usage
693 //usage: "[-udopchaitkx] SERVICE_DIR..."
694 //usage:#define svc_full_usage "\n\n"
695 //usage: "Control services monitored by runsv supervisor"
697 //usage: "\n"" -u If service is not running, start it; restart if it stops"
698 //usage: "\n"" -d If service is running, send TERM+CONT signals; do not restart it"
699 //usage: "\n"" -o Once: if service is not running, start it; do not restart it"
700 //usage: "\n"" -pchaitk Send STOP, CONT, HUP, ALRM, INT, TERM, KILL signal to service"
701 //usage: "\n"" -x Exit: runsv will exit as soon as the service is down"
703 int svc_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
704 int svc_main(int argc UNUSED_PARAM, char **argv)
707 const char *optstring;
712 optstring = "udopchaitkx";
713 opts = getopt32(argv, optstring);
715 if (!argv[0] || !opts)
721 argv[2] = (char*)"--";
723 argv[0] = (char*)"sv";
731 command[0] = *optstring;
733 /* getopt() was already called by getopt32():
734 * reset the libc getopt() function's internal state.