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.sunsite.dk/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,
40 it is searched in the default services directory /var/service/, otherwise
41 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, restart, shutdown, force-stop,
45 force-reload, force-restart, force-shutdown.
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".
52 Report the current status of the service, and the appendant log service
53 if available, to standard output.
55 If the service is not running, start it. If the service stops, restart it.
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
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.
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
73 sv actually looks only at the first character of above commands.
75 Commands compatible to LSB init script actions:
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
86 Same as down, but wait up to 7 seconds for the service to become down.
87 Then report the status or timeout.
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.
95 Same as exit, but wait up to 7 seconds for the runsv(8) process
96 to terminate. Then report the status or timeout.
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.
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.
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.
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
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.
129 wait up to 7 seconds for the command to take effect.
130 Then report the status or timeout.
132 Override the default timeout of 7 seconds with sec seconds. Implies -v.
137 The environment variable $SVDIR overrides the default services directory
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.
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.
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.
153 /* Busyboxed by Denys Vlasenko <vda.linux@googlemail.com> */
154 /* TODO: depends on runit_lib.c - review and reduce/eliminate */
156 #include <sys/poll.h>
157 #include <sys/file.h>
159 #include "runit_lib.h"
165 /* "Bernstein" time format: unix + 0x400000000000000aULL */
166 uint64_t tstart, tnow;
169 #define G (*(struct globals*)&bb_common_bufsiz1)
170 #define acts (G.acts )
171 #define service (G.service )
173 #define tstart (G.tstart )
174 #define tnow (G.tnow )
175 #define svstatus (G.svstatus )
176 #define INIT_G() do { } while (0)
179 #define str_equal(s,t) (!strcmp((s), (t)))
182 static void fatal_cannot(const char *m1) NORETURN;
183 static void fatal_cannot(const char *m1)
185 bb_perror_msg("fatal: can't %s", m1);
189 static void out(const char *p, const char *m1)
191 printf("%s%s: %s", p, *service, m1);
193 printf(": %s", strerror(errno));
195 bb_putchar('\n'); /* will also flush the output */
198 #define WARN "warning: "
201 static void fail(const char *m1)
206 static void failx(const char *m1)
211 static void warn(const char *m1)
214 /* "warning: <service>: <m1>\n" */
215 out("warning: ", m1);
217 static void ok(const char *m1)
223 static int svstatus_get(void)
227 fd = open("supervise/ok", O_WRONLY|O_NDELAY);
229 if (errno == ENODEV) {
230 *acts == 'x' ? ok("runsv not running")
231 : failx("runsv not running");
234 warn("can't open supervise/ok");
238 fd = open("supervise/status", O_RDONLY|O_NDELAY);
240 warn("can't open supervise/status");
243 r = read(fd, &svstatus, 20);
249 warn("can't read supervise/status");
253 warn("can't read supervise/status: bad format");
259 static unsigned svstatus_print(const char *m)
267 if (stat("down", &s) == -1) {
268 if (errno != ENOENT) {
269 bb_perror_msg(WARN"can't stat %s/down", *service);
274 pid = SWAP_LE32(svstatus.pid_le32);
275 timestamp = SWAP_BE64(svstatus.time_be64);
277 switch (svstatus.run_or_finish) {
278 case 1: printf("run: "); break;
279 case 2: printf("finish: "); break;
281 printf("%s: (pid %d) ", m, pid);
283 printf("down: %s: ", m);
285 diff = tnow - timestamp;
286 printf("%us", (diff < 0 ? 0 : diff));
288 if (!normallyup) printf(", normally down");
289 if (svstatus.paused) printf(", paused");
290 if (svstatus.want == 'd') printf(", want down");
291 if (svstatus.got_term) printf(", got TERM");
293 if (normallyup) printf(", normally up");
294 if (svstatus.want == 'u') printf(", want up");
299 static int status(const char *unused UNUSED_PARAM)
303 if (svstatus_get() <= 0)
306 r = svstatus_print(*service);
307 if (chdir("log") == -1) {
308 if (errno != ENOENT) {
309 printf("; log: "WARN"can't change to log service directory: %s",
312 } else if (svstatus_get()) {
314 svstatus_print("log");
316 bb_putchar('\n'); /* will also flush the output */
320 static int checkscript(void)
326 if (stat("check", &s) == -1) {
327 if (errno == ENOENT) return 1;
328 bb_perror_msg(WARN"can't stat %s/check", *service);
331 /* if (!(s.st_mode & S_IXUSR)) return 1; */
332 prog[0] = (char*)"./check";
336 bb_perror_msg(WARN"can't %s child %s/check", "run", *service);
339 while (safe_waitpid(pid, &w, 0) == -1) {
340 bb_perror_msg(WARN"can't %s child %s/check", "wait for", *service);
343 return WEXITSTATUS(w) == 0;
346 static int check(const char *a)
360 pid_le32 = svstatus.pid_le32;
365 if (!pid_le32 || svstatus.run_or_finish != 1) return 0;
366 if (!checkscript()) return 0;
369 if (pid_le32) return 0;
372 if (pid_le32 && !checkscript()) return 0;
375 if (!pid_le32 && svstatus.want == 'd') break;
376 timestamp = SWAP_BE64(svstatus.time_be64);
377 if ((tstart > timestamp) || !pid_le32 || svstatus.got_term || !checkscript())
381 timestamp = SWAP_BE64(svstatus.time_be64);
382 if ((!pid_le32 && tstart > timestamp) || (pid_le32 && svstatus.want != 'd'))
386 svstatus_print(*service);
387 bb_putchar('\n'); /* will also flush the output */
391 static int control(const char *a)
395 /* Is it an optimization?
396 It causes problems with "sv o SRV; ...; sv d SRV"
397 ('d' is not passed to SRV because its .want == 'd'):
398 if (svstatus_get() <= 0)
400 if (svstatus.want == *a)
403 fd = open("supervise/control", O_WRONLY|O_NDELAY);
406 warn("can't open supervise/control");
408 *a == 'x' ? ok("runsv not running") : failx("runsv not running");
415 warn("can't write to supervise/control");
421 int sv_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
422 int sv_main(int argc UNUSED_PARAM, char **argv)
427 const char *varservice = CONFIG_SV_DEFAULT_SERVICE_DIR;
428 unsigned waitsec = 7;
431 int (*act)(const char*);
432 int (*cbk)(const char*);
437 xfunc_error_retval = 100;
440 if (x) varservice = x;
441 x = getenv("SVWAIT");
442 if (x) waitsec = xatou(x);
444 opt_complementary = "w+:vv"; /* -w N, -v is a counter */
445 opt = getopt32(argv, "w:v", &waitsec, &verbose);
448 if (!action || !*argv) bb_show_usage();
450 tnow = time(NULL) + 0x400000000000000aULL;
452 curdir = open(".", O_RDONLY|O_NDELAY);
454 fatal_cannot("open current directory");
464 if (!verbose) cbk = NULL;
480 if (str_equal(action, "check")) {
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':
489 if (!verbose) cbk = NULL;
492 if (str_equal(action, "shutdown")) {
496 if (str_equal(action, "start")) {
500 if (str_equal(action, "stop")) {
509 if (str_equal(action, "restart")) {
515 if (str_equal(action, "force-reload")) {
520 if (str_equal(action, "force-restart")) {
525 if (str_equal(action, "force-shutdown")) {
530 if (str_equal(action, "force-stop")) {
540 while ((x = *service) != NULL) {
541 if (x[0] != '/' && x[0] != '.') {
542 if (chdir(varservice) == -1)
545 if (chdir(x) == -1) {
547 fail("can't change to service directory");
548 goto nullify_service_0;
550 if (act && (act(acts) == -1)) {
552 *service = (char*) -1L; /* "dead" */
554 if (fchdir(curdir) == -1)
555 fatal_cannot("change to original directory");
563 diff = tnow - tstart;
566 while ((x = *service) != NULL) {
567 if (x == (char*) -1L) /* "dead" */
569 if (x[0] != '/' && x[0] != '.') {
570 if (chdir(varservice) == -1)
573 if (chdir(x) == -1) {
575 fail("can't change to service directory");
576 goto nullify_service;
579 goto nullify_service;
581 if (diff >= waitsec) {
582 printf(kll ? "kill: " : "timeout: ");
583 if (svstatus_get() > 0) {
587 bb_putchar('\n'); /* will also flush the output */
591 *service = (char*) -1L; /* "dead" */
593 if (fchdir(curdir) == -1)
594 fatal_cannot("change to original directory");
598 if (want_exit) break;
600 tnow = time(NULL) + 0x400000000000000aULL;
602 return rc > 99 ? 99 : rc;