*: make GNU licensing statement forms more regular
[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 source tree.
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         fflush_all();
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                 /* mount, for example, does not want the message */
45                 /*bb_perror_msg("can't execute '%s'", argv[0]);*/
46                 _exit(111);
47         }
48         /* parent */
49         /* Unfortunately, this is not reliable: according to standards
50          * vfork() can be equivalent to fork() and we won't see value
51          * of 'failed'.
52          * Interested party can wait on pid and learn exit code.
53          * If 111 - then it (most probably) failed to exec */
54         if (failed) {
55                 errno = failed;
56                 return -1;
57         }
58         return pid;
59 }
60
61 /* Die with an error message if we can't spawn a child process. */
62 pid_t FAST_FUNC xspawn(char **argv)
63 {
64         pid_t pid = spawn(argv);
65         if (pid < 0)
66                 bb_simple_perror_msg_and_die(*argv);
67         return pid;
68 }
69
70 #if ENABLE_FEATURE_PREFER_APPLETS
71 void FAST_FUNC save_nofork_data(struct nofork_save_area *save)
72 {
73         memcpy(&save->die_jmp, &die_jmp, sizeof(die_jmp));
74         save->applet_name = applet_name;
75         save->xfunc_error_retval = xfunc_error_retval;
76         save->option_mask32 = option_mask32;
77         save->die_sleep = die_sleep;
78         save->saved = 1;
79 }
80
81 void FAST_FUNC restore_nofork_data(struct nofork_save_area *save)
82 {
83         memcpy(&die_jmp, &save->die_jmp, sizeof(die_jmp));
84         applet_name = save->applet_name;
85         xfunc_error_retval = save->xfunc_error_retval;
86         option_mask32 = save->option_mask32;
87         die_sleep = save->die_sleep;
88 }
89
90 int FAST_FUNC run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv)
91 {
92         int rc, argc;
93
94         applet_name = APPLET_NAME(applet_no);
95
96         xfunc_error_retval = EXIT_FAILURE;
97
98         /* Special flag for xfunc_die(). If xfunc will "die"
99          * in NOFORK applet, xfunc_die() sees negative
100          * die_sleep and longjmp here instead. */
101         die_sleep = -1;
102
103         /* In case getopt() or getopt32() was already called:
104          * reset the libc getopt() function, which keeps internal state.
105          *
106          * BSD-derived getopt() functions require that optind be set to 1 in
107          * order to reset getopt() state.  This used to be generally accepted
108          * way of resetting getopt().  However, glibc's getopt()
109          * has additional getopt() state beyond optind, and requires that
110          * optind be set to zero to reset its state.  So the unfortunate state of
111          * affairs is that BSD-derived versions of getopt() misbehave if
112          * optind is set to 0 in order to reset getopt(), and glibc's getopt()
113          * will core dump if optind is set 1 in order to reset getopt().
114          *
115          * More modern versions of BSD require that optreset be set to 1 in
116          * order to reset getopt().  Sigh.  Standards, anyone?
117          */
118 #ifdef __GLIBC__
119         optind = 0;
120 #else /* BSD style */
121         optind = 1;
122         /* optreset = 1; */
123 #endif
124         /* optarg = NULL; opterr = 1; optopt = 63; - do we need this too? */
125         /* (values above are what they initialized to in glibc and uclibc) */
126         /* option_mask32 = 0; - not needed, no applet depends on it being 0 */
127
128         argc = 1;
129         while (argv[argc])
130                 argc++;
131
132         rc = setjmp(die_jmp);
133         if (!rc) {
134                 /* Some callers (xargs)
135                  * need argv untouched because they free argv[i]! */
136                 char *tmp_argv[argc+1];
137                 memcpy(tmp_argv, argv, (argc+1) * sizeof(tmp_argv[0]));
138                 /* Finally we can call NOFORK applet's main() */
139                 rc = applet_main[applet_no](argc, tmp_argv);
140
141         /* The whole reason behind nofork_save_area is that <applet>_main
142          * may exit non-locally! For example, in hush Ctrl-Z tries
143          * (modulo bugs) to dynamically create a child (backgrounded task)
144          * if it detects that Ctrl-Z was pressed when a NOFORK was running.
145          * Testcase: interactive "rm -i".
146          * Don't fool yourself into thinking "and <applet>_main() returns
147          * quickly here" and removing "useless" nofork_save_area code. */
148
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 some globals */
156         restore_nofork_data(old);
157
158         /* Other globals can be simply reset to defaults */
159 #ifdef __GLIBC__
160         optind = 0;
161 #else /* BSD style */
162         optind = 1;
163 #endif
164
165         return rc & 0xff; /* don't confuse people with "exitcodes" >255 */
166 }
167
168 int FAST_FUNC run_nofork_applet(int applet_no, char **argv)
169 {
170         struct nofork_save_area old;
171
172         /* Saving globals */
173         save_nofork_data(&old);
174         return run_nofork_applet_prime(&old, applet_no, argv);
175 }
176 #endif /* FEATURE_PREFER_APPLETS */
177
178 int FAST_FUNC spawn_and_wait(char **argv)
179 {
180         int rc;
181 #if ENABLE_FEATURE_PREFER_APPLETS
182         int a = find_applet_by_name(argv[0]);
183
184         if (a >= 0 && (APPLET_IS_NOFORK(a)
185 #if BB_MMU
186                         || APPLET_IS_NOEXEC(a) /* NOEXEC trick needs fork() */
187 #endif
188         )) {
189 #if BB_MMU
190                 if (APPLET_IS_NOFORK(a))
191 #endif
192                 {
193                         return run_nofork_applet(a, argv);
194                 }
195 #if BB_MMU
196                 /* MMU only */
197                 /* a->noexec is true */
198                 rc = fork();
199                 if (rc) /* parent or error */
200                         return wait4pid(rc);
201                 /* child */
202                 xfunc_error_retval = EXIT_FAILURE;
203                 run_applet_no_and_exit(a, argv);
204 #endif
205         }
206 #endif /* FEATURE_PREFER_APPLETS */
207         rc = spawn(argv);
208         return wait4pid(rc);
209 }
210
211 #if !BB_MMU
212 void FAST_FUNC re_exec(char **argv)
213 {
214         /* high-order bit of first char in argv[0] is a hidden
215          * "we have (already) re-execed, don't do it again" flag */
216         argv[0][0] |= 0x80;
217         execv(bb_busybox_exec_path, argv);
218         bb_perror_msg_and_die("can't execute '%s'", bb_busybox_exec_path);
219 }
220
221 pid_t FAST_FUNC fork_or_rexec(char **argv)
222 {
223         pid_t pid;
224         /* Maybe we are already re-execed and come here again? */
225         if (re_execed)
226                 return 0;
227         pid = xvfork();
228         if (pid) /* parent */
229                 return pid;
230         /* child - re-exec ourself */
231         re_exec(argv);
232 }
233 #endif
234
235 /* Due to a #define in libbb.h on MMU systems we actually have 1 argument -
236  * char **argv "vanishes" */
237 void FAST_FUNC bb_daemonize_or_rexec(int flags, char **argv)
238 {
239         int fd;
240
241         if (flags & DAEMON_CHDIR_ROOT)
242                 xchdir("/");
243
244         if (flags & DAEMON_DEVNULL_STDIO) {
245                 close(0);
246                 close(1);
247                 close(2);
248         }
249
250         fd = open(bb_dev_null, O_RDWR);
251         if (fd < 0) {
252                 /* NB: we can be called as bb_sanitize_stdio() from init
253                  * or mdev, and there /dev/null may legitimately not (yet) exist!
254                  * Do not use xopen above, but obtain _ANY_ open descriptor,
255                  * even bogus one as below. */
256                 fd = xopen("/", O_RDONLY); /* don't believe this can fail */
257         }
258
259         while ((unsigned)fd < 2)
260                 fd = dup(fd); /* have 0,1,2 open at least to /dev/null */
261
262         if (!(flags & DAEMON_ONLY_SANITIZE)) {
263                 if (fork_or_rexec(argv))
264                         exit(EXIT_SUCCESS); /* parent */
265                 /* if daemonizing, make sure we detach from stdio & ctty */
266                 setsid();
267                 dup2(fd, 0);
268                 dup2(fd, 1);
269                 dup2(fd, 2);
270         }
271         while (fd > 2) {
272                 close(fd--);
273                 if (!(flags & DAEMON_CLOSE_EXTRA_FDS))
274                         return;
275                 /* else close everything after fd#2 */
276         }
277 }
278
279 void FAST_FUNC bb_sanitize_stdio(void)
280 {
281         bb_daemonize_or_rexec(DAEMON_ONLY_SANITIZE, NULL);
282 }