*: more portability fixes by Dan Fandrich
[platform/upstream/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 "busybox.h" /* uses applet tables */
19
20 /* This does a fork/exec in one call, using vfork().  Returns PID of new child,
21  * -1 for failure.  Runs argv[0], searching path if that has no / in it. */
22 pid_t FAST_FUNC spawn(char **argv)
23 {
24         /* Compiler should not optimize stores here */
25         volatile int failed;
26         pid_t pid;
27
28 // Ain't it a good place to fflush(NULL)?
29
30         /* Be nice to nommu machines. */
31         failed = 0;
32         pid = vfork();
33         if (pid < 0) /* error */
34                 return pid;
35         if (!pid) { /* child */
36                 /* This macro is ok - it doesn't do NOEXEC/NOFORK tricks */
37                 BB_EXECVP(argv[0], argv);
38
39                 /* We are (maybe) sharing a stack with blocked parent,
40                  * let parent know we failed and then exit to unblock parent
41                  * (but don't run atexit() stuff, which would screw up parent.)
42                  */
43                 failed = errno;
44                 _exit(111);
45         }
46         /* parent */
47         /* Unfortunately, this is not reliable: according to standards
48          * vfork() can be equivalent to fork() and we won't see value
49          * of 'failed'.
50          * Interested party can wait on pid and learn exit code.
51          * If 111 - then it (most probably) failed to exec */
52         if (failed) {
53                 errno = failed;
54                 return -1;
55         }
56         return pid;
57 }
58
59 /* Die with an error message if we can't spawn a child process. */
60 pid_t FAST_FUNC xspawn(char **argv)
61 {
62         pid_t pid = spawn(argv);
63         if (pid < 0)
64                 bb_simple_perror_msg_and_die(*argv);
65         return pid;
66 }
67
68 pid_t FAST_FUNC safe_waitpid(pid_t pid, int *wstat, int options)
69 {
70         pid_t r;
71
72         do
73                 r = waitpid(pid, wstat, options);
74         while ((r == -1) && (errno == EINTR));
75         return r;
76 }
77
78 pid_t FAST_FUNC wait_any_nohang(int *wstat)
79 {
80         return safe_waitpid(-1, wstat, WNOHANG);
81 }
82
83 // Wait for the specified child PID to exit, returning child's error return.
84 int FAST_FUNC wait4pid(pid_t pid)
85 {
86         int status;
87
88         if (pid <= 0) {
89                 /*errno = ECHILD; -- wrong. */
90                 /* we expect errno to be already set from failed [v]fork/exec */
91                 return -1;
92         }
93         if (safe_waitpid(pid, &status, 0) == -1)
94                 return -1;
95         if (WIFEXITED(status))
96                 return WEXITSTATUS(status);
97         if (WIFSIGNALED(status))
98                 return WTERMSIG(status) + 1000;
99         return 0;
100 }
101
102 #if ENABLE_FEATURE_PREFER_APPLETS
103 void FAST_FUNC save_nofork_data(struct nofork_save_area *save)
104 {
105         memcpy(&save->die_jmp, &die_jmp, sizeof(die_jmp));
106         save->applet_name = applet_name;
107         save->xfunc_error_retval = xfunc_error_retval;
108         save->option_mask32 = option_mask32;
109         save->die_sleep = die_sleep;
110         save->saved = 1;
111 }
112
113 void FAST_FUNC restore_nofork_data(struct nofork_save_area *save)
114 {
115         memcpy(&die_jmp, &save->die_jmp, sizeof(die_jmp));
116         applet_name = save->applet_name;
117         xfunc_error_retval = save->xfunc_error_retval;
118         option_mask32 = save->option_mask32;
119         die_sleep = save->die_sleep;
120 }
121
122 int FAST_FUNC run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv)
123 {
124         int rc, argc;
125
126         applet_name = APPLET_NAME(applet_no);
127
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         /* In case getopt() or getopt32() was already called:
136          * reset the libc getopt() function, which keeps internal state.
137          *
138          * BSD-derived getopt() functions require that optind be set to 1 in
139          * order to reset getopt() state.  This used to be generally accepted
140          * way of resetting getopt().  However, glibc's getopt()
141          * has additional getopt() state beyond optind, and requires that
142          * optind be set to zero to reset its state.  So the unfortunate state of
143          * affairs is that BSD-derived versions of getopt() misbehave if
144          * optind is set to 0 in order to reset getopt(), and glibc's getopt()
145          * will core dump if optind is set 1 in order to reset getopt().
146          *
147          * More modern versions of BSD require that optreset be set to 1 in
148          * order to reset getopt().  Sigh.  Standards, anyone?
149          */
150 #ifdef __GLIBC__
151         optind = 0;
152 #else /* BSD style */
153         optind = 1;
154         /* optreset = 1; */
155 #endif
156         /* optarg = NULL; opterr = 1; optopt = 63; - do we need this too? */
157         /* (values above are what they initialized to in glibc and uclibc) */
158         /* option_mask32 = 0; - not needed, no applet depends on it being 0 */
159
160         argc = 1;
161         while (argv[argc])
162                 argc++;
163
164         rc = setjmp(die_jmp);
165         if (!rc) {
166                 /* Some callers (xargs)
167                  * need argv untouched because they free argv[i]! */
168                 char *tmp_argv[argc+1];
169                 memcpy(tmp_argv, argv, (argc+1) * sizeof(tmp_argv[0]));
170                 /* Finally we can call NOFORK applet's main() */
171                 rc = applet_main[applet_no](argc, tmp_argv);
172
173         /* The whole reason behind nofork_save_area is that <applet>_main
174          * may exit non-locally! For example, in hush Ctrl-Z tries
175          * (modulo bugs) to dynamically create a child (backgrounded task)
176          * if it detects that Ctrl-Z was pressed when a NOFORK was running.
177          * Testcase: interactive "rm -i".
178          * Don't fool yourself into thinking "and <applet>_main() returns
179          * quickly here" and removing "useless" nofork_save_area code. */
180
181         } else { /* xfunc died in NOFORK applet */
182                 /* in case they meant to return 0... */
183                 if (rc == -2222)
184                         rc = 0;
185         }
186
187         /* Restoring some globals */
188         restore_nofork_data(old);
189
190         /* Other globals can be simply reset to defaults */
191 #ifdef __GLIBC__
192         optind = 0;
193 #else /* BSD style */
194         optind = 1;
195 #endif
196
197         return rc & 0xff; /* don't confuse people with "exitcodes" >255 */
198 }
199
200 int FAST_FUNC run_nofork_applet(int applet_no, char **argv)
201 {
202         struct nofork_save_area old;
203
204         /* Saving globals */
205         save_nofork_data(&old);
206         return run_nofork_applet_prime(&old, applet_no, argv);
207 }
208 #endif /* FEATURE_PREFER_APPLETS */
209
210 int FAST_FUNC spawn_and_wait(char **argv)
211 {
212         int rc;
213 #if ENABLE_FEATURE_PREFER_APPLETS
214         int a = find_applet_by_name(argv[0]);
215
216         if (a >= 0 && (APPLET_IS_NOFORK(a)
217 #if BB_MMU
218                         || APPLET_IS_NOEXEC(a) /* NOEXEC trick needs fork() */
219 #endif
220         )) {
221 #if BB_MMU
222                 if (APPLET_IS_NOFORK(a))
223 #endif
224                 {
225                         return run_nofork_applet(a, argv);
226                 }
227 #if BB_MMU
228                 /* MMU only */
229                 /* a->noexec is true */
230                 rc = fork();
231                 if (rc) /* parent or error */
232                         return wait4pid(rc);
233                 /* child */
234                 xfunc_error_retval = EXIT_FAILURE;
235                 run_applet_no_and_exit(a, argv);
236 #endif
237         }
238 #endif /* FEATURE_PREFER_APPLETS */
239         rc = spawn(argv);
240         return wait4pid(rc);
241 }
242
243 #if !BB_MMU
244 void FAST_FUNC re_exec(char **argv)
245 {
246         /* high-order bit of first char in argv[0] is a hidden
247          * "we have (already) re-execed, don't do it again" flag */
248         argv[0][0] |= 0x80;
249         execv(bb_busybox_exec_path, argv);
250         bb_perror_msg_and_die("exec %s", bb_busybox_exec_path);
251 }
252
253 pid_t FAST_FUNC fork_or_rexec(char **argv)
254 {
255         pid_t pid;
256         /* Maybe we are already re-execed and come here again? */
257         if (re_execed)
258                 return 0;
259         pid = vfork();
260         if (pid < 0) /* wtf? */
261                 bb_perror_msg_and_die("vfork");
262         if (pid) /* parent */
263                 return pid;
264         /* child - re-exec ourself */
265         re_exec(argv);
266 }
267 #else
268 /* Dance around (void)...*/
269 #undef fork_or_rexec
270 pid_t FAST_FUNC fork_or_rexec(void)
271 {
272         pid_t pid;
273         pid = fork();
274         if (pid < 0) /* wtf? */
275                 bb_perror_msg_and_die("fork");
276         return pid;
277 }
278 #define fork_or_rexec(argv) fork_or_rexec()
279 #endif
280
281 /* Due to a #define in libbb.h on MMU systems we actually have 1 argument -
282  * char **argv "vanishes" */
283 void FAST_FUNC bb_daemonize_or_rexec(int flags, char **argv)
284 {
285         int fd;
286
287         if (flags & DAEMON_CHDIR_ROOT)
288                 xchdir("/");
289
290         if (flags & DAEMON_DEVNULL_STDIO) {
291                 close(0);
292                 close(1);
293                 close(2);
294         }
295
296         fd = open(bb_dev_null, O_RDWR);
297         if (fd < 0) {
298                 /* NB: we can be called as bb_sanitize_stdio() from init
299                  * or mdev, and there /dev/null may legitimately not (yet) exist!
300                  * Do not use xopen above, but obtain _ANY_ open descriptor,
301                  * even bogus one as below. */
302                 fd = xopen("/", O_RDONLY); /* don't believe this can fail */
303         }
304
305         while ((unsigned)fd < 2)
306                 fd = dup(fd); /* have 0,1,2 open at least to /dev/null */
307
308         if (!(flags & DAEMON_ONLY_SANITIZE)) {
309                 if (fork_or_rexec(argv))
310                         exit(EXIT_SUCCESS); /* parent */
311                 /* if daemonizing, make sure we detach from stdio & ctty */
312                 setsid();
313                 dup2(fd, 0);
314                 dup2(fd, 1);
315                 dup2(fd, 2);
316         }
317         while (fd > 2) {
318                 close(fd--);
319                 if (!(flags & DAEMON_CLOSE_EXTRA_FDS))
320                         return;
321                 /* else close everything after fd#2 */
322         }
323 }
324
325 void FAST_FUNC bb_sanitize_stdio(void)
326 {
327         bb_daemonize_or_rexec(DAEMON_ONLY_SANITIZE, NULL);
328 }