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 || SVC || SVOK
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 compatible with daemontools command with the same name.
179 //config: bool "svok"
182 //config: svok checks whether runsv supervisor is running.
183 //config: It is compatible with daemontools command with the same name.
185 //applet:IF_SV( APPLET_NOEXEC(sv, sv, BB_DIR_USR_BIN, BB_SUID_DROP, sv ))
186 //applet:IF_SVC( APPLET_NOEXEC(svc, svc, BB_DIR_USR_BIN, BB_SUID_DROP, svc ))
187 //applet:IF_SVOK(APPLET_NOEXEC(svok, svok, BB_DIR_USR_BIN, BB_SUID_DROP, svok))
189 //kbuild:lib-$(CONFIG_SV) += sv.o
190 //kbuild:lib-$(CONFIG_SVC) += sv.o
191 //kbuild:lib-$(CONFIG_SVOK) += sv.o
193 #include <sys/file.h>
195 #include "common_bufsiz.h"
196 #include "runit_lib.h"
202 /* "Bernstein" time format: unix + 0x400000000000000aULL */
203 uint64_t tstart, tnow;
207 #define G (*(struct globals*)bb_common_bufsiz1)
208 #define acts (G.acts )
209 #define service (G.service )
211 #define tstart (G.tstart )
212 #define tnow (G.tnow )
213 #define svstatus (G.svstatus )
214 #define islog (G.islog )
215 #define INIT_G() do { \
216 setup_common_bufsiz(); \
217 /* need to zero out, svc calls sv() repeatedly */ \
218 memset(&G, 0, sizeof(G)); \
222 #define str_equal(s,t) (strcmp((s), (t)) == 0)
225 static void fatal_cannot(const char *m1) NORETURN;
226 static void fatal_cannot(const char *m1)
228 bb_perror_msg("fatal: can't %s", m1);
232 static void out(const char *p, const char *m1)
234 printf("%s%s%s: %s", p, *service, islog ? "/log" : "", m1);
236 printf(": "STRERROR_FMT STRERROR_ERRNO);
238 bb_putchar('\n'); /* will also flush the output */
241 #define WARN "warning: "
244 static void fail(const char *m1)
249 static void failx(const char *m1)
254 static void warn(const char *m1)
257 /* "warning: <service>: <m1>\n" */
258 out("warning: ", m1);
260 static void ok(const char *m1)
266 static int svstatus_get(void)
270 fd = open("supervise/ok", O_WRONLY|O_NDELAY);
272 if (errno == ENODEV) {
273 *acts == 'x' ? ok("runsv not running")
274 : failx("runsv not running");
277 warn("can't open supervise/ok");
281 fd = open("supervise/status", O_RDONLY|O_NDELAY);
283 warn("can't open supervise/status");
286 r = read(fd, &svstatus, 20);
292 warn("can't read supervise/status");
296 warn("can't read supervise/status: bad format");
302 static unsigned svstatus_print(const char *m)
310 if (stat("down", &s) == -1) {
311 if (errno != ENOENT) {
312 bb_perror_msg(WARN"can't stat %s/down", *service);
317 pid = SWAP_LE32(svstatus.pid_le32);
318 timestamp = SWAP_BE64(svstatus.time_be64);
319 switch (svstatus.run_or_finish) {
320 case 0: printf("down: "); break;
321 case 1: printf("run: "); break;
322 case 2: printf("finish: "); break;
325 if (svstatus.run_or_finish)
326 printf("(pid %d) ", pid);
327 diff = tnow - timestamp;
328 printf("%us", (diff < 0 ? 0 : diff));
330 if (!normallyup) printf(", normally down");
331 if (svstatus.paused) printf(", paused");
332 if (svstatus.want == 'd') printf(", want down");
333 if (svstatus.got_term) printf(", got TERM");
335 if (normallyup) printf(", normally up");
336 if (svstatus.want == 'u') printf(", want up");
341 static int status(const char *unused UNUSED_PARAM)
345 if (svstatus_get() <= 0)
348 r = svstatus_print(*service);
350 if (chdir("log") == -1) {
351 if (errno != ENOENT) {
353 warn("can't change directory");
358 if (svstatus_get()) {
359 r = svstatus_print("log");
367 static int checkscript(void)
373 if (stat("check", &s) == -1) {
374 if (errno == ENOENT) return 1;
375 bb_perror_msg(WARN"can't stat %s/check", *service);
378 /* if (!(s.st_mode & S_IXUSR)) return 1; */
379 prog[0] = (char*)"./check";
383 bb_perror_msg(WARN"can't %s child %s/check", "run", *service);
386 while (safe_waitpid(pid, &w, 0) == -1) {
387 bb_perror_msg(WARN"can't %s child %s/check", "wait for", *service);
390 return WEXITSTATUS(w) == 0;
393 static int check(const char *a)
408 pid_le32 = svstatus.pid_le32;
413 if (!pid_le32 || svstatus.run_or_finish != 1)
419 if (pid_le32 || svstatus.run_or_finish != 0)
423 if (pid_le32 && !checkscript())
428 if (!pid_le32 && svstatus.want == 'd')
430 timestamp = SWAP_BE64(svstatus.time_be64);
431 if ((tstart > timestamp) || !pid_le32 || svstatus.got_term || !checkscript())
435 timestamp = SWAP_BE64(svstatus.time_be64);
436 if ((!pid_le32 && tstart > timestamp) || (pid_le32 && svstatus.want != 'd'))
440 if (pid_le32 && !svstatus.paused)
444 if (pid_le32 && svstatus.paused)
451 svstatus_print(*service);
452 bb_putchar('\n'); /* will also flush the output */
456 static int control(const char *a)
460 if (svstatus_get() <= 0)
462 if (svstatus.want == *a && (*a != 'd' || svstatus.got_term == 1))
464 fd = open("supervise/control", O_WRONLY|O_NDELAY);
467 warn("can't open supervise/control");
469 *a == 'x' ? ok("runsv not running") : failx("runsv not running");
476 warn("can't write to supervise/control");
482 //usage:#define sv_trivial_usage
483 //usage: "[-v] [-w SEC] CMD SERVICE_DIR..."
484 //usage:#define sv_full_usage "\n\n"
485 //usage: "Control services monitored by runsv supervisor.\n"
486 //usage: "Commands (only first character is enough):\n"
488 //usage: "status: query service status\n"
489 //usage: "up: if service isn't running, start it. If service stops, restart it\n"
490 //usage: "once: like 'up', but if service stops, don't restart it\n"
491 //usage: "down: send TERM and CONT signals. If ./run exits, start ./finish\n"
492 //usage: " if it exists. After it stops, don't restart service\n"
493 //usage: "exit: send TERM and CONT signals to service and log service. If they exit,\n"
494 //usage: " runsv exits too\n"
495 //usage: "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n"
496 //usage: "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
497 static int sv(char **argv)
501 const char *varservice = CONFIG_SV_DEFAULT_SERVICE_DIR;
502 unsigned waitsec = 7;
505 int (*act)(const char*);
506 int (*cbk)(const char*);
511 xfunc_error_retval = 100;
514 if (x) varservice = x;
515 x = getenv("SVWAIT");
516 if (x) waitsec = xatou(x);
518 getopt32(argv, "^" "w:+v" "\0" "vv" /* -w N, -v is a counter */,
523 if (!action || !*argv) bb_show_usage();
525 tnow = time(NULL) + 0x400000000000000aULL;
527 curdir = open(".", O_RDONLY|O_NDELAY);
529 fatal_cannot("open current directory");
539 if (!verbose) cbk = NULL;
555 if (str_equal(action, "try-restart")) {
560 if (str_equal(action, "check")) {
565 case 'u': case 'd': case 'o': case 'p': case 'h':
566 case 'a': case 'i': case 'k': case 'q': case '1': case '2':
573 if (str_equal(action, "shutdown")) {
577 if (str_equal(action, "start")) {
581 if (str_equal(action, "stop")) {
590 if (str_equal(action, "restart")) {
594 if (str_equal(action, "reload")) {
600 if (str_equal(action, "force-reload")) {
605 if (str_equal(action, "force-restart")) {
610 if (str_equal(action, "force-shutdown")) {
615 if (str_equal(action, "force-stop")) {
625 while ((x = *service) != NULL) {
626 if (x[0] != '/' && x[0] != '.'
627 && !last_char_is(x, '/')
629 if (chdir(varservice) == -1)
632 if (chdir(x) == -1) {
634 fail("can't change to service directory");
635 goto nullify_service_0;
637 if (act && (act(acts) == -1)) {
639 *service = (char*) -1L; /* "dead" */
641 if (fchdir(curdir) == -1)
642 fatal_cannot("change to original directory");
650 diff = tnow - tstart;
653 while ((x = *service) != NULL) {
654 if (x == (char*) -1L) /* "dead" */
656 if (x[0] != '/' && x[0] != '.') {
657 if (chdir(varservice) == -1)
660 if (chdir(x) == -1) {
662 fail("can't change to service directory");
663 goto nullify_service;
666 goto nullify_service;
668 if (diff >= waitsec) {
669 printf(kll ? "kill: " : "timeout: ");
670 if (svstatus_get() > 0) {
674 bb_putchar('\n'); /* will also flush the output */
678 *service = (char*) -1L; /* "dead" */
680 if (fchdir(curdir) == -1)
681 fatal_cannot("change to original directory");
685 if (want_exit) break;
687 tnow = time(NULL) + 0x400000000000000aULL;
689 return rc > 99 ? 99 : rc;
693 int sv_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
694 int sv_main(int argc UNUSED_PARAM, char **argv)
700 //usage:#define svc_trivial_usage
701 //usage: "[-udopchaitkx] SERVICE_DIR..."
702 //usage:#define svc_full_usage "\n\n"
703 //usage: "Control services monitored by runsv supervisor"
705 //usage: "\n"" -u If service is not running, start it; restart if it stops"
706 //usage: "\n"" -d If service is running, send TERM+CONT signals; do not restart it"
707 //usage: "\n"" -o Once: if service is not running, start it; do not restart it"
708 //usage: "\n"" -pchaitk Send STOP, CONT, HUP, ALRM, INT, TERM, KILL signal to service"
709 //usage: "\n"" -x Exit: runsv will exit as soon as the service is down"
711 int svc_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
712 int svc_main(int argc UNUSED_PARAM, char **argv)
715 const char *optstring;
718 optstring = "udopchaitkx";
719 opts = getopt32(argv, optstring);
721 if (!argv[0] || !opts)
727 argv[2] = (char*)"--";
729 argv[0] = (char*)"sv";
737 command[0] = *optstring;
739 /* getopt() was already called by getopt32():
740 * reset the libc getopt() function's internal state.
755 //usage:#define svok_trivial_usage
756 //usage: "SERVICE_DIR"
757 //usage:#define svok_full_usage "\n\n"
758 //usage: "Check whether runsv supervisor is running.\n"
759 //usage: "Exit code is 0 if it does, 100 if it does not,\n"
760 //usage: "111 (with error message) if SERVICE_DIR does not exist."
762 int svok_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
763 int svok_main(int argc UNUSED_PARAM, char **argv)
765 const char *dir = argv[1];
770 xfunc_error_retval = 111;
773 * daemontools has no concept of "default service dir", runit does.
774 * Let's act as runit.
776 if (dir[0] != '/' && dir[0] != '.'
777 && !last_char_is(dir, '/')
779 xchdir(CONFIG_SV_DEFAULT_SERVICE_DIR);
783 if (open("supervise/ok", O_WRONLY) < 0) {
784 if (errno == ENOENT || errno == ENXIO)
786 bb_perror_msg_and_die("can't open '%s'", "supervise/ok");