add more convenient defines for [NO]MMU:
[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 spawn_and_wait(char **argv)
104 {
105 #if ENABLE_FEATURE_PREFER_APPLETS
106         int rc;
107         const struct bb_applet *a = find_applet_by_name(argv[0]);
108
109         if (a && (a->nofork
110 #if BB_MMU
111                  || a->noexec /* NOEXEC trick needs fork() */
112 #endif
113         )) {
114                 int argc = 1;
115                 char **pp = argv;
116                 while (*++pp)
117                         argc++;
118 #if BB_MMU
119                 if (a->nofork)
120 #endif
121                 {
122                         int old_sleep = die_sleep;
123                         int old_x = xfunc_error_retval;
124                         uint32_t old_m = option_mask32;
125
126                         xfunc_error_retval = EXIT_FAILURE;
127                         /* special flag for xfunc_die(). If xfunc will "die"
128                          * in NOFORK applet, xfunc_die() sees negative
129                          * die_sleep and longjmp here instead. */
130                         die_sleep = -1;
131
132                         rc = setjmp(die_jmp);
133                         if (!rc) {
134                                 const struct bb_applet *old_a = current_applet;
135                                 current_applet = a;
136                                 applet_name = a->name;
137 // what else should we save/restore?
138 // TODO: what if applet will mangle argv vector?
139 // xargs needs argv untouched because it frees argv[i]!
140 // shouldn't we pass a copy?
141                                 rc = a->main(argc, argv);
142                                 current_applet = old_a;
143                                 applet_name = old_a->name;                                      
144                         } else {
145                                 /* xfunc died in NOFORK applet */
146                                 if (rc == -111)
147                                         rc = 0;
148                         }
149
150                         die_sleep = old_sleep;
151                         xfunc_error_retval = old_x;
152                         option_mask32 = old_m;
153                         return rc;
154                 }
155 #if BB_MMU
156                 /* MMU only */
157                 /* a->noexec is true */
158                 rc = fork();
159                 if (rc) /* parent or error */
160                         return wait4pid(rc);
161                 /* child */
162                 xfunc_error_retval = EXIT_FAILURE;
163                 current_applet = a;
164                 run_current_applet_and_exit(argc, argv);
165 #endif
166         }
167 #endif /* FEATURE_PREFER_APPLETS */
168         rc = spawn(argv);
169         return wait4pid(rc);
170 }
171
172
173 #if !BB_MMU
174 void forkexit_or_rexec(char **argv)
175 {
176         pid_t pid;
177         /* Maybe we are already re-execed and come here again? */
178         if (re_execed)
179                 return;
180
181         pid = vfork();
182         if (pid < 0) /* wtf? */
183                 bb_perror_msg_and_die("vfork");
184         if (pid) /* parent */
185                 exit(0);
186         /* child - re-exec ourself */
187         /* high-order bit of first char in argv[0] is a hidden
188          * "we have (alrealy) re-execed, don't do it again" flag */
189         argv[0][0] |= 0x80;
190         execv(CONFIG_BUSYBOX_EXEC_PATH, argv);
191         bb_perror_msg_and_die("exec %s", CONFIG_BUSYBOX_EXEC_PATH);
192 }
193 #else
194 /* Dance around (void)...*/
195 #undef forkexit_or_rexec
196 void forkexit_or_rexec(void)
197 {
198         pid_t pid;
199         pid = fork();
200         if (pid < 0) /* wtf? */
201                 bb_perror_msg_and_die("fork");
202         if (pid) /* parent */
203                 exit(0);
204         /* child */
205 }
206 #define forkexit_or_rexec(argv) forkexit_or_rexec()
207 #endif
208
209 /* Due to a #define in libbb.h on MMU systems we actually have 1 argument -
210  * char **argv "vanishes" */
211 void bb_daemonize_or_rexec(int flags, char **argv)
212 {
213         int fd;
214
215         fd = xopen(bb_dev_null, O_RDWR);
216
217         if (flags & DAEMON_CHDIR_ROOT)
218                 xchdir("/");
219
220         if (flags & DAEMON_DEVNULL_STDIO) {
221                 close(0);
222                 close(1);
223                 close(2);
224         }
225
226         while ((unsigned)fd < 2)
227                 fd = dup(fd); /* have 0,1,2 open at least to /dev/null */
228
229         if (!(flags & DAEMON_ONLY_SANITIZE)) {
230                 forkexit_or_rexec(argv);
231                 /* if daemonizing, make sure we detach from stdio */
232                 setsid();
233                 dup2(fd, 0);
234                 dup2(fd, 1);
235                 dup2(fd, 2);
236         }
237         if (fd > 2)
238                 close(fd--);
239         if (flags & DAEMON_CLOSE_EXTRA_FDS)
240                 while (fd > 2)
241                         close(fd--); /* close everything after fd#2 */
242 }
243
244 void bb_sanitize_stdio(void)
245 {
246         bb_daemonize_or_rexec(DAEMON_ONLY_SANITIZE, NULL);
247 }