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 #include <sys/prctl.h>
  18 #ifndef PR_SET_NAME
  19 #define PR_SET_NAME 15
  20 #endif
  21 #ifndef PR_GET_NAME
  22 #define PR_GET_NAME 16
  23 #endif
  24
  25 #include "busybox.h" /* uses applet tables */
  26 #include "NUM_APPLETS.h"
  27
  28 #define NOFORK_SUPPORT ((NUM_APPLETS > 1) && (ENABLE_FEATURE_PREFER_APPLETS || ENABLE_FEATURE_SH_NOFORK))
  29 #define NOEXEC_SUPPORT ((NUM_APPLETS > 1) && (ENABLE_FEATURE_PREFER_APPLETS || ENABLE_FEATURE_SH_STANDALONE))
  30
  31 #if defined(__linux__) && (NUM_APPLETS > 1)
  32 void FAST_FUNC set_task_comm(const char *comm)
  33 {
  34         /* okay if too long (truncates) */
  35         prctl(PR_SET_NAME, (long)comm, 0, 0, 0);
  36 }
  37 #endif
  38
  39 /*
  40  * NOFORK/NOEXEC support
  41  */
  42 #if NOFORK_SUPPORT
  43 static jmp_buf die_jmp;
  44 static void jump(void)
  45 {
  46         /* Special case. We arrive here if NOFORK applet
  47          * calls xfunc, which then decides to die.
  48          * We don't die, but instead jump back to caller.
  49          * NOFORK applets still cannot carelessly call xfuncs:
  50          * p = xmalloc(10);
  51          * q = xmalloc(10); // BUG! if this dies, we leak p!
  52          */
  53         /* | 0x100 allows to pass zero exitcode (longjmp can't pass 0).
  54          * This works because exitcodes are bytes,
  55          * run_nofork_applet() ensures that by "& 0xff"
  56          */
  57         longjmp(die_jmp, xfunc_error_retval | 0x100);
  58 }
  59
  60 struct nofork_save_area {
  61         jmp_buf die_jmp;
  62         void (*die_func)(void);
  63         const char *applet_name;
  64         uint32_t option_mask32;
  65         smallint logmode;
  66         uint8_t xfunc_error_retval;
  67 };
  68 static void save_nofork_data(struct nofork_save_area *save)
  69 {
  70         memcpy(&save->die_jmp, &die_jmp, sizeof(die_jmp));
  71         save->die_func = die_func;
  72         save->applet_name = applet_name;
  73         save->option_mask32 = option_mask32;
  74         save->logmode = logmode;
  75         save->xfunc_error_retval = xfunc_error_retval;
  76 }
  77 static void restore_nofork_data(struct nofork_save_area *save)
  78 {
  79         memcpy(&die_jmp, &save->die_jmp, sizeof(die_jmp));
  80         die_func = save->die_func;
  81         applet_name = save->applet_name;
  82         option_mask32 = save->option_mask32;
  83         logmode = save->logmode;
  84         xfunc_error_retval = save->xfunc_error_retval;
  85 }
  86
  87 int FAST_FUNC run_nofork_applet(int applet_no, char **argv)
  88 {
  89         int rc, argc;
  90         struct nofork_save_area old;
  91
  92         save_nofork_data(&old);
  93
  94         logmode = LOGMODE_STDIO;
  95         xfunc_error_retval = EXIT_FAILURE;
  96         /* In case getopt() was already called:
  97          * reset the libc getopt() function, which keeps internal state.
  98          * (getopt32() does it itself, but getopt() doesn't (and can't))
  99          */
 100         GETOPT_RESET();
 101         /* opt_complementary = NULL; - cleared by each getopt32() call anyway */
 102
 103         argc = string_array_len(argv);
 104
 105         /* If xfunc "dies" in NOFORK applet, die_func longjmp's here instead */
 106         die_func = jump;
 107         rc = setjmp(die_jmp);
 108         if (!rc) {
 109                 /* Some callers (xargs)
 110                  * need argv untouched because they free argv[i]! */
 111                 char *tmp_argv[argc+1];
 112                 memcpy(tmp_argv, argv, (argc+1) * sizeof(tmp_argv[0]));
 113                 applet_name = tmp_argv[0];
 114                 /* Finally we can call NOFORK applet's main() */
 115                 rc = applet_main[applet_no](argc, tmp_argv);
 116                 /* Important for shells: `which CMD` was failing */
 117                 fflush_all();
 118         } else {
 119                 /* xfunc died in NOFORK applet */
 120         }
 121
 122         /* Restoring some globals */
 123         restore_nofork_data(&old);
 124         /* Other globals can be simply reset to defaults */
 125         GETOPT_RESET();
 126         /* opt_complementary = NULL; - cleared by each getopt32() call anyway */
 127
 128         return rc & 0xff; /* don't confuse people with "exitcodes" >255 */
 129 }
 130 #endif
 131
 132 #if NOEXEC_SUPPORT
 133 void FAST_FUNC run_noexec_applet_and_exit(int a, const char *name, char **argv)
 134 {
 135         /* reset some state and run without execing */
 136         /* msg_eol = "\n"; - no caller needs this reinited yet */
 137         logmode = LOGMODE_STDIO;
 138         xfunc_error_retval = EXIT_FAILURE;
 139         die_func = NULL;
 140         GETOPT_RESET();
 141         /* opt_complementary = NULL; - cleared by each getopt32() call anyway */
 142
 143 //TODO: think pidof, pgrep, pkill!
 144 //set_task_comm() makes our pidof find NOEXECs (e.g. "yes >/dev/null"),
 145 //but one from procps-ng-3.3.10 needs more!
 146 //Rewrite /proc/PID/cmdline? (need to save argv0 and length at init for this to work!)
 147         set_task_comm(name);
 148         /* applet_name is set by this function: */
 149         run_applet_no_and_exit(a, name, argv);
 150 }
 151 #endif
 152
 153 /*
 154  * Higher-level code, hiding optional NOFORK/NOEXEC trickery.
 155  */
 156
 157 /* This does a fork/exec in one call, using vfork().  Returns PID of new child,
 158  * -1 for failure.  Runs argv[0], searching path if that has no / in it. */
 159 pid_t FAST_FUNC spawn(char **argv)
 160 {
 161         /* Compiler should not optimize stores here */
 162         volatile int failed;
 163         pid_t pid;
 164
 165         fflush_all();
 166
 167         /* Be nice to nommu machines. */
 168         failed = 0;
 169         pid = vfork();
 170         if (pid < 0) /* error */
 171                 return pid;
 172         if (!pid) { /* child */
 173                 /* This macro is ok - it doesn't do NOEXEC/NOFORK tricks */
 174                 BB_EXECVP(argv[0], argv);
 175
 176                 /* We are (maybe) sharing a stack with blocked parent,
 177                  * let parent know we failed and then exit to unblock parent
 178                  * (but don't run atexit() stuff, which would screw up parent.)
 179                  */
 180                 failed = errno;
 181                 /* mount, for example, does not want the message */
 182                 /*bb_perror_msg("can't execute '%s'", argv[0]);*/
 183                 _exit(111);
 184         }
 185         /* parent */
 186         /* Unfortunately, this is not reliable: according to standards
 187          * vfork() can be equivalent to fork() and we won't see value
 188          * of 'failed'.
 189          * Interested party can wait on pid and learn exit code.
 190          * If 111 - then it (most probably) failed to exec */
 191         if (failed) {
 192                 safe_waitpid(pid, NULL, 0); /* prevent zombie */
 193                 errno = failed;
 194                 return -1;
 195         }
 196         return pid;
 197 }
 198
 199 /* Die with an error message if we can't spawn a child process. */
 200 pid_t FAST_FUNC xspawn(char **argv)
 201 {
 202         pid_t pid = spawn(argv);
 203         if (pid < 0)
 204                 bb_simple_perror_msg_and_die(*argv);
 205         return pid;
 206 }
 207
 208 int FAST_FUNC spawn_and_wait(char **argv)
 209 {
 210         int rc;
 211 #if ENABLE_FEATURE_PREFER_APPLETS && (NUM_APPLETS > 1)
 212         int a = find_applet_by_name(argv[0]);
 213
 214         if (a >= 0) {
 215                 if (APPLET_IS_NOFORK(a))
 216                         return run_nofork_applet(a, argv);
 217 # if BB_MMU /* NOEXEC needs fork(), thus this is done only on MMU machines: */
 218                 if (APPLET_IS_NOEXEC(a)) {
 219                         fflush_all();
 220                         rc = fork();
 221                         if (rc) /* parent or error */
 222                                 return wait4pid(rc);
 223
 224                         /* child */
 225                         run_noexec_applet_and_exit(a, argv[0], argv);
 226                 }
 227 # endif
 228         }
 229 #endif
 230         rc = spawn(argv);
 231         return wait4pid(rc);
 232 }
 233
 234 #if !BB_MMU
 235 void FAST_FUNC re_exec(char **argv)
 236 {
 237         /* high-order bit of first char in argv[0] is a hidden
 238          * "we have (already) re-execed, don't do it again" flag */
 239         argv[0][0] |= 0x80;
 240         execv(bb_busybox_exec_path, argv);
 241         bb_perror_msg_and_die("can't execute '%s'", bb_busybox_exec_path);
 242 }
 243
 244 pid_t FAST_FUNC fork_or_rexec(char **argv)
 245 {
 246         pid_t pid;
 247         /* Maybe we are already re-execed and come here again? */
 248         if (re_execed)
 249                 return 0;
 250
 251         /* fflush_all(); ? - so far all callers had no buffered output to flush */
 252
 253         pid = xvfork();
 254         if (pid) /* parent */
 255                 return pid;
 256         /* child - re-exec ourself */
 257         re_exec(argv);
 258 }
 259 #endif
 260
 261 /* Due to a #define in libbb.h on MMU systems we actually have 1 argument -
 262  * char **argv "vanishes" */
 263 void FAST_FUNC bb_daemonize_or_rexec(int flags, char **argv)
 264 {
 265         int fd;
 266
 267         if (flags & DAEMON_CHDIR_ROOT)
 268                 xchdir("/");
 269
 270         if (flags & DAEMON_DEVNULL_STDIO) {
 271                 close(0);
 272                 close(1);
 273                 close(2);
 274         }
 275
 276         fd = open(bb_dev_null, O_RDWR);
 277         if (fd < 0) {
 278                 /* NB: we can be called as bb_sanitize_stdio() from init
 279                  * or mdev, and there /dev/null may legitimately not (yet) exist!
 280                  * Do not use xopen above, but obtain _ANY_ open descriptor,
 281                  * even bogus one as below. */
 282                 fd = xopen("/", O_RDONLY); /* don't believe this can fail */
 283         }
 284
 285         while ((unsigned)fd < 2)
 286                 fd = dup(fd); /* have 0,1,2 open at least to /dev/null */
 287
 288         if (!(flags & DAEMON_ONLY_SANITIZE)) {
 289
 290                 /* fflush_all(); - add it in fork_or_rexec() if necessary */
 291
 292                 if (fork_or_rexec(argv))
 293                         _exit(EXIT_SUCCESS); /* parent */
 294                 /* if daemonizing, detach from stdio & ctty */
 295                 setsid();
 296                 dup2(fd, 0);
 297                 dup2(fd, 1);
 298                 dup2(fd, 2);
 299                 if (flags & DAEMON_DOUBLE_FORK) {
 300                         /* On Linux, session leader can acquire ctty
 301                          * unknowingly, by opening a tty.
 302                          * Prevent this: stop being a session leader.
 303                          */
 304                         if (fork_or_rexec(argv))
 305                                 _exit(EXIT_SUCCESS); /* parent */
 306                 }
 307         }
 308         while (fd > 2) {
 309                 close(fd--);
 310                 if (!(flags & DAEMON_CLOSE_EXTRA_FDS))
 311                         return;
 312                 /* else close everything after fd#2 */
 313         }
 314 }
 315
 316 void FAST_FUNC bb_sanitize_stdio(void)
 317 {
 318         bb_daemonize_or_rexec(DAEMON_ONLY_SANITIZE, NULL);
 319 }