Initial public busybox upstream commit
[busybox4maemo] / 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" /* uses applet tables */
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_simple_perror_msg_and_die(*argv);
66         return pid;
67 }
68
69 int safe_waitpid(int pid, int *wstat, int options)
70 {
71         int r;
72
73         do
74                 r = waitpid(pid, wstat, options);
75         while ((r == -1) && (errno == EINTR));
76         return r;
77 }
78
79 int wait_any_nohang(int *wstat)
80 {
81         return safe_waitpid(-1, wstat, WNOHANG);
82 }
83
84 // Wait for the specified child PID to exit, returning child's error return.
85 int wait4pid(int pid)
86 {
87         int status;
88
89         if (pid <= 0) {
90                 /*errno = ECHILD; -- wrong. */
91                 /* we expect errno to be already set from failed [v]fork/exec */
92                 return -1;
93         }
94         if (safe_waitpid(pid, &status, 0) == -1)
95                 return -1;
96         if (WIFEXITED(status))
97                 return WEXITSTATUS(status);
98         if (WIFSIGNALED(status))
99                 return WTERMSIG(status) + 1000;
100         return 0;
101 }
102
103 #if ENABLE_FEATURE_PREFER_APPLETS
104 void save_nofork_data(struct nofork_save_area *save)
105 {
106         memcpy(&save->die_jmp, &die_jmp, sizeof(die_jmp));
107         save->applet_name = applet_name;
108         save->xfunc_error_retval = xfunc_error_retval;
109         save->option_mask32 = option_mask32;
110         save->die_sleep = die_sleep;
111         save->saved = 1;
112 }
113
114 void restore_nofork_data(struct nofork_save_area *save)
115 {
116         memcpy(&die_jmp, &save->die_jmp, sizeof(die_jmp));
117         applet_name = save->applet_name;
118         xfunc_error_retval = save->xfunc_error_retval;
119         option_mask32 = save->option_mask32;
120         die_sleep = save->die_sleep;
121 }
122
123 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv)
124 {
125         int rc, argc;
126
127         applet_name = APPLET_NAME(applet_no);
128         xfunc_error_retval = EXIT_FAILURE;
129
130         /* Special flag for xfunc_die(). If xfunc will "die"
131          * in NOFORK applet, xfunc_die() sees negative
132          * die_sleep and longjmp here instead. */
133         die_sleep = -1;
134
135         /* option_mask32 = 0; - not needed */
136
137         argc = 1;
138         while (argv[argc])
139                 argc++;
140
141         rc = setjmp(die_jmp);
142         if (!rc) {
143                 /* Some callers (xargs)
144                  * need argv untouched because they free argv[i]! */
145                 char *tmp_argv[argc+1];
146                 memcpy(tmp_argv, argv, (argc+1) * sizeof(tmp_argv[0]));
147                 /* Finally we can call NOFORK applet's main() */
148                 rc = applet_main[applet_no](argc, tmp_argv);
149         } else { /* xfunc died in NOFORK applet */
150                 /* in case they meant to return 0... */
151                 if (rc == -2222)
152                         rc = 0;
153         }
154
155         /* Restoring globals */
156         restore_nofork_data(old);
157         return rc;
158 }
159
160 int run_nofork_applet(int applet_no, char **argv)
161 {
162         struct nofork_save_area old;
163
164         /* Saving globals */
165         save_nofork_data(&old);
166         return run_nofork_applet_prime(&old, applet_no, argv);
167 }
168 #endif /* FEATURE_PREFER_APPLETS */
169
170 int spawn_and_wait(char **argv)
171 {
172         int rc;
173 #if ENABLE_FEATURE_PREFER_APPLETS
174         int a = find_applet_by_name(argv[0]);
175
176         if (a >= 0 && (APPLET_IS_NOFORK(a)
177 #if BB_MMU
178                         || APPLET_IS_NOEXEC(a) /* NOEXEC trick needs fork() */
179 #endif
180         )) {
181 #if BB_MMU
182                 if (APPLET_IS_NOFORK(a))
183 #endif
184                 {
185                         return run_nofork_applet(a, argv);
186                 }
187 #if BB_MMU
188                 /* MMU only */
189                 /* a->noexec is true */
190                 rc = fork();
191                 if (rc) /* parent or error */
192                         return wait4pid(rc);
193                 /* child */
194                 xfunc_error_retval = EXIT_FAILURE;
195                 run_applet_no_and_exit(a, argv);
196 #endif
197         }
198 #endif /* FEATURE_PREFER_APPLETS */
199         rc = spawn(argv);
200         return wait4pid(rc);
201 }
202
203 #if !BB_MMU
204 void re_exec(char **argv)
205 {
206         /* high-order bit of first char in argv[0] is a hidden
207          * "we have (already) re-execed, don't do it again" flag */
208         argv[0][0] |= 0x80;
209         execv(bb_busybox_exec_path, argv);
210         bb_perror_msg_and_die("exec %s", bb_busybox_exec_path);
211 }
212
213 void forkexit_or_rexec(char **argv)
214 {
215         pid_t pid;
216         /* Maybe we are already re-execed and come here again? */
217         if (re_execed)
218                 return;
219
220         pid = vfork();
221         if (pid < 0) /* wtf? */
222                 bb_perror_msg_and_die("vfork");
223         if (pid) /* parent */
224                 exit(0);
225         /* child - re-exec ourself */
226         re_exec(argv);
227 }
228 #else
229 /* Dance around (void)...*/
230 #undef forkexit_or_rexec
231 void forkexit_or_rexec(void)
232 {
233         pid_t pid;
234         pid = fork();
235         if (pid < 0) /* wtf? */
236                 bb_perror_msg_and_die("fork");
237         if (pid) /* parent */
238                 exit(0);
239         /* child */
240 }
241 #define forkexit_or_rexec(argv) forkexit_or_rexec()
242 #endif
243
244 /* Due to a #define in libbb.h on MMU systems we actually have 1 argument -
245  * char **argv "vanishes" */
246 void bb_daemonize_or_rexec(int flags, char **argv)
247 {
248         int fd;
249
250         if (flags & DAEMON_CHDIR_ROOT)
251                 xchdir("/");
252
253         if (flags & DAEMON_DEVNULL_STDIO) {
254                 close(0);
255                 close(1);
256                 close(2);
257         }
258
259         fd = xopen(bb_dev_null, O_RDWR);
260
261         while ((unsigned)fd < 2)
262                 fd = dup(fd); /* have 0,1,2 open at least to /dev/null */
263
264         if (!(flags & DAEMON_ONLY_SANITIZE)) {
265                 forkexit_or_rexec(argv);
266                 /* if daemonizing, make sure we detach from stdio & ctty */
267                 setsid();
268                 dup2(fd, 0);
269                 dup2(fd, 1);
270                 dup2(fd, 2);
271         }
272         while (fd > 2) {
273                 close(fd--);
274                 if (!(flags & DAEMON_CLOSE_EXTRA_FDS))
275                         return;
276                 /* else close everything after fd#2 */
277         }
278 }
279
280 void bb_sanitize_stdio(void)
281 {
282         bb_daemonize_or_rexec(DAEMON_ONLY_SANITIZE, NULL);
283 }