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