shell/cttyhack.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Copyright (c) 2007 Denys Vlasenko <vda.linux@googlemail.com>
   4  *
   5  * Licensed under GPLv2, see file LICENSE in this source tree.
   6  */
   7 #include "libbb.h"
   8
   9 //applet:IF_CTTYHACK(APPLET(cttyhack, BB_DIR_BIN, BB_SUID_DROP))
  10
  11 //kbuild:lib-$(CONFIG_CTTYHACK) += cttyhack.o
  12
  13 //config:config CTTYHACK
  14 //config:       bool "cttyhack"
  15 //config:       default y
  16 //config:       help
  17 //config:         One common problem reported on the mailing list is the "can't
  18 //config:         access tty; job control turned off" error message, which typically
  19 //config:         appears when one tries to use a shell with stdin/stdout on
  20 //config:         /dev/console.
  21 //config:         This device is special - it cannot be a controlling tty.
  22 //config:
  23 //config:         The proper solution is to use the correct device instead of
  24 //config:         /dev/console.
  25 //config:
  26 //config:         cttyhack provides a "quick and dirty" solution to this problem.
  27 //config:         It analyzes stdin with various ioctls, trying to determine whether
  28 //config:         it is a /dev/ttyN or /dev/ttySN (virtual terminal or serial line).
  29 //config:         On Linux it also checks sysfs for a pointer to the active console.
  30 //config:         If cttyhack is able to find the real console device, it closes
  31 //config:         stdin/out/err and reopens that device.
  32 //config:         Then it executes the given program. Opening the device will make
  33 //config:         that device a controlling tty. This may require cttyhack
  34 //config:         to be a session leader.
  35 //config:
  36 //config:         Example for /etc/inittab (for busybox init):
  37 //config:
  38 //config:         ::respawn:/bin/cttyhack /bin/sh
  39 //config:
  40 //config:         Starting an interactive shell from boot shell script:
  41 //config:
  42 //config:         setsid cttyhack sh
  43 //config:
  44 //config:         Giving controlling tty to shell running with PID 1:
  45 //config:
  46 //config:         # exec cttyhack sh
  47 //config:
  48 //config:         Without cttyhack, you need to know exact tty name,
  49 //config:         and do something like this:
  50 //config:
  51 //config:         # exec setsid sh -c 'exec sh </dev/tty1 >/dev/tty1 2>&1'
  52 //config:
  53
  54 //usage:#define cttyhack_trivial_usage
  55 //usage:       "PROG ARGS"
  56 //usage:#define cttyhack_full_usage "\n\n"
  57 //usage:       "Give PROG a controlling tty if possible."
  58 //usage:     "\nExample for /etc/inittab (for busybox init):"
  59 //usage:     "\n        ::respawn:/bin/cttyhack /bin/sh"
  60 //usage:     "\nGiving controlling tty to shell running with PID 1:"
  61 //usage:     "\n        $ exec cttyhack sh"
  62 //usage:     "\nStarting interactive shell from boot shell script:"
  63 //usage:     "\n        setsid cttyhack sh"
  64
  65 #if !defined(__linux__) && !defined(TIOCGSERIAL) && !ENABLE_WERROR
  66 # warning cttyhack will not be able to detect a controlling tty on this system
  67 #endif
  68
  69 /* From <linux/vt.h> */
  70 struct vt_stat {
  71         unsigned short v_active;        /* active vt */
  72         unsigned short v_signal;        /* signal to send */
  73         unsigned short v_state;         /* vt bitmask */
  74 };
  75 enum { VT_GETSTATE = 0x5603 }; /* get global vt state info */
  76
  77 /* From <linux/serial.h> */
  78 struct serial_struct {
  79         int     type;
  80         int     line;
  81         unsigned int    port;
  82         int     irq;
  83         int     flags;
  84         int     xmit_fifo_size;
  85         int     custom_divisor;
  86         int     baud_base;
  87         unsigned short  close_delay;
  88         char    io_type;
  89         char    reserved_char[1];
  90         int     hub6;
  91         unsigned short  closing_wait;   /* time to wait before closing */
  92         unsigned short  closing_wait2;  /* no longer used... */
  93         unsigned char   *iomem_base;
  94         unsigned short  iomem_reg_shift;
  95         unsigned int    port_high;
  96         unsigned long   iomap_base;     /* cookie passed into ioremap */
  97         int     reserved[1];
  98 };
  99
 100 int cttyhack_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 101 int cttyhack_main(int argc UNUSED_PARAM, char **argv)
 102 {
 103         int fd;
 104         char console[sizeof(int)*3 + 16];
 105         union {
 106                 struct vt_stat vt;
 107                 struct serial_struct sr;
 108                 char paranoia[sizeof(struct serial_struct) * 3];
 109         } u;
 110
 111         if (!*++argv) {
 112                 bb_show_usage();
 113         }
 114
 115         strcpy(console, "/dev/tty");
 116         fd = open(console, O_RDWR);
 117         if (fd >= 0) {
 118                 /* We already have ctty, nothing to do */
 119                 close(fd);
 120         } else {
 121                 /* We don't have ctty (or don't have "/dev/tty" node...) */
 122                 do {
 123 #ifdef __linux__
 124                         int s = open_read_close("/sys/class/tty/console/active",
 125                                 console + 5, sizeof(console) - 5);
 126                         if (s > 0) {
 127                                 /* found active console via sysfs (Linux 2.6.38+)
 128                                  * sysfs string looks like "ttyS0\n" so zap the newline:
 129                                  */
 130                                 console[4 + s] = '\0';
 131                                 break;
 132                         }
 133
 134                         if (ioctl(0, VT_GETSTATE, &u.vt) == 0) {
 135                                 /* this is linux virtual tty */
 136                                 sprintf(console + 8, "S%d" + 1, u.vt.v_active);
 137                                 break;
 138                         }
 139 #endif
 140 #ifdef TIOCGSERIAL
 141                         if (ioctl(0, TIOCGSERIAL, &u.sr) == 0) {
 142                                 /* this is a serial console, asuming it is named /dev/ttySn */
 143                                 sprintf(console + 8, "S%d", u.sr.line);
 144                                 break;
 145                         }
 146 #endif
 147                         /* nope, could not find it */
 148                         goto ret;
 149                 } while (0);
 150
 151                 fd = open_or_warn(console, O_RDWR);
 152                 if (fd < 0)
 153                         goto ret;
 154                 //bb_error_msg("switching to '%s'", console);
 155                 dup2(fd, 0);
 156                 dup2(fd, 1);
 157                 dup2(fd, 2);
 158                 while (fd > 2)
 159                         close(fd--);
 160                 /* Some other session may have it as ctty,
 161                  * steal it from them:
 162                  */
 163                 ioctl(0, TIOCSCTTY, 1);
 164         }
 165
 166 ret:
 167         BB_EXECVP_or_die(argv);
 168 }