hush: use NOFORK applets as appropriate. Net reduction of code size.
[oweals/busybox.git] / libbb / vfork_daemon_rexec.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Rexec program for system have fork() as vfork() with foreground option
4  *
5  * Copyright (C) Vladimir N. Oleynik <dzo@simtreas.ru>
6  * Copyright (C) 2003 Russ Dill <Russ.Dill@asu.edu>
7  *
8  * daemon() portion taken from uClibc:
9  *
10  * Copyright (c) 1991, 1993
11  *      The Regents of the University of California.  All rights reserved.
12  *
13  * Modified for uClibc by Erik Andersen <andersee@debian.org>
14  *
15  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
16  */
17
18 #include <paths.h>
19 #include "busybox.h" /* for struct bb_applet */
20
21 /* This does a fork/exec in one call, using vfork().  Returns PID of new child,
22  * -1 for failure.  Runs argv[0], searching path if that has no / in it. */
23 pid_t spawn(char **argv)
24 {
25         /* Compiler should not optimize stores here */
26         volatile int failed;
27         pid_t pid;
28
29 // Ain't it a good place to fflush(NULL)?
30
31         /* Be nice to nommu machines. */
32         failed = 0;
33         pid = vfork();
34         if (pid < 0) /* error */
35                 return pid;
36         if (!pid) { /* child */
37                 /* This macro is ok - it doesn't do NOEXEC/NOFORK tricks */
38                 BB_EXECVP(argv[0], argv);
39
40                 /* We are (maybe) sharing a stack with blocked parent,
41                  * let parent know we failed and then exit to unblock parent
42                  * (but don't run atexit() stuff, which would screw up parent.)
43                  */
44                 failed = errno;
45                 _exit(111);
46         }
47         /* parent */
48         /* Unfortunately, this is not reliable: according to standards
49          * vfork() can be equivalent to fork() and we won't see value
50          * of 'failed'.
51          * Interested party can wait on pid and learn exit code.
52          * If 111 - then it (most probably) failed to exec */
53         if (failed) {
54                 errno = failed;
55                 return -1;
56         }
57         return pid;
58 }
59
60 /* Die with an error message if we can't spawn a child process. */
61 pid_t xspawn(char **argv)
62 {
63         pid_t pid = spawn(argv);
64         if (pid < 0)
65                 bb_perror_msg_and_die("%s", *argv);
66         return pid;
67 }
68
69 // Wait for the specified child PID to exit, returning child's error return.
70 int wait4pid(int pid)
71 {
72         int status;
73
74         if (pid <= 0) {
75                 /*errno = ECHILD; -- wrong. */
76                 /* we expect errno to be already set from failed [v]fork/exec */
77                 return -1;
78         }
79         if (waitpid(pid, &status, 0) == -1)
80                 return -1;
81         if (WIFEXITED(status))
82                 return WEXITSTATUS(status);
83         if (WIFSIGNALED(status))
84                 return WTERMSIG(status) + 1000;
85         return 0;
86 }
87
88 int wait_nohang(int *wstat)
89 {
90         return waitpid(-1, wstat, WNOHANG);
91 }
92
93 int wait_pid(int *wstat, int pid)
94 {
95         int r;
96
97         do
98                 r = waitpid(pid, wstat, 0);
99         while ((r == -1) && (errno == EINTR));
100         return r;
101 }
102
103 int run_nofork_applet(const struct bb_applet *a, char **argv)
104 {
105         int rc, argc;
106
107         /* Save some shared globals */
108         const struct bb_applet *old_a = current_applet;
109         int old_x = xfunc_error_retval;
110         uint32_t old_m = option_mask32;
111         int old_sleep = die_sleep;
112
113         current_applet = a;
114         applet_name = a->name;
115         xfunc_error_retval = EXIT_FAILURE;
116         /*option_mask32 = 0; - not needed */
117         /* special flag for xfunc_die(). If xfunc will "die"
118          * in NOFORK applet, xfunc_die() sees negative
119          * die_sleep and longjmp here instead. */
120         die_sleep = -1;
121
122         argc = 1;
123         while (argv[argc])
124                 argc++;
125
126         rc = setjmp(die_jmp);
127         if (!rc) {
128                 /* Some callers (xargs)
129                  * need argv untouched because they free argv[i]! */
130                 char *tmp_argv[argc+1];
131                 memcpy(tmp_argv, argv, (argc+1) * sizeof(tmp_argv[0]));
132                 /* Finally we can call NOFORK applet's main() */
133                 rc = a->main(argc, tmp_argv);
134         } else { /* xfunc died in NOFORK applet */
135                 /* in case they meant to return 0... */
136                 if (rc == -111)
137                         rc = 0;
138         }
139
140         /* Restoring globals */
141         current_applet = old_a;
142         applet_name = old_a->name;
143         xfunc_error_retval = old_x;
144         option_mask32 = old_m;
145         die_sleep = old_sleep;
146         return rc;
147 }
148
149 int spawn_and_wait(char **argv)
150 {
151         int rc;
152 #if ENABLE_FEATURE_PREFER_APPLETS
153         const struct bb_applet *a = find_applet_by_name(argv[0]);
154
155         if (a && (a->nofork
156 #if BB_MMU
157                  || a->noexec /* NOEXEC trick needs fork() */
158 #endif
159         )) {
160 #if BB_MMU
161                 if (a->nofork)
162 #endif
163                 {
164                         return run_nofork_applet(a, argv);
165                 }
166 #if BB_MMU
167                 /* MMU only */
168                 /* a->noexec is true */
169                 rc = fork();
170                 if (rc) /* parent or error */
171                         return wait4pid(rc);
172                 /* child */
173                 xfunc_error_retval = EXIT_FAILURE;
174                 current_applet = a;
175                 run_current_applet_and_exit(argv);
176 #endif
177         }
178 #endif /* FEATURE_PREFER_APPLETS */
179         rc = spawn(argv);
180         return wait4pid(rc);
181 }
182
183
184 #if !BB_MMU
185 void forkexit_or_rexec(char **argv)
186 {
187         pid_t pid;
188         /* Maybe we are already re-execed and come here again? */
189         if (re_execed)
190                 return;
191
192         pid = vfork();
193         if (pid < 0) /* wtf? */
194                 bb_perror_msg_and_die("vfork");
195         if (pid) /* parent */
196                 exit(0);
197         /* child - re-exec ourself */
198         /* high-order bit of first char in argv[0] is a hidden
199          * "we have (alrealy) re-execed, don't do it again" flag */
200         argv[0][0] |= 0x80;
201         execv(CONFIG_BUSYBOX_EXEC_PATH, argv);
202         bb_perror_msg_and_die("exec %s", CONFIG_BUSYBOX_EXEC_PATH);
203 }
204 #else
205 /* Dance around (void)...*/
206 #undef forkexit_or_rexec
207 void forkexit_or_rexec(void)
208 {
209         pid_t pid;
210         pid = fork();
211         if (pid < 0) /* wtf? */
212                 bb_perror_msg_and_die("fork");
213         if (pid) /* parent */
214                 exit(0);
215         /* child */
216 }
217 #define forkexit_or_rexec(argv) forkexit_or_rexec()
218 #endif
219
220 /* Due to a #define in libbb.h on MMU systems we actually have 1 argument -
221  * char **argv "vanishes" */
222 void bb_daemonize_or_rexec(int flags, char **argv)
223 {
224         int fd;
225
226         fd = xopen(bb_dev_null, O_RDWR);
227
228         if (flags & DAEMON_CHDIR_ROOT)
229                 xchdir("/");
230
231         if (flags & DAEMON_DEVNULL_STDIO) {
232                 close(0);
233                 close(1);
234                 close(2);
235         }
236
237         while ((unsigned)fd < 2)
238                 fd = dup(fd); /* have 0,1,2 open at least to /dev/null */
239
240         if (!(flags & DAEMON_ONLY_SANITIZE)) {
241                 forkexit_or_rexec(argv);
242                 /* if daemonizing, make sure we detach from stdio */
243                 setsid();
244                 dup2(fd, 0);
245                 dup2(fd, 1);
246                 dup2(fd, 2);
247         }
248         if (fd > 2)
249                 close(fd--);
250         if (flags & DAEMON_CLOSE_EXTRA_FDS)
251                 while (fd > 2)
252                         close(fd--); /* close everything after fd#2 */
253 }
254
255 void bb_sanitize_stdio(void)
256 {
257         bb_daemonize_or_rexec(DAEMON_ONLY_SANITIZE, NULL);
258 }