sys/platform/vkernel/platform/console.c

   1 /*
   2  * Copyright (c) 2006 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/platform/vkernel/platform/console.c,v 1.17 2007/07/02 04:19:14 dillon Exp $
  35  */
  36
  37 #include <sys/systm.h>
  38 #include <sys/kernel.h>
  39 #include <sys/conf.h>
  40 #include <sys/cons.h>
  41 #include <sys/tty.h>
  42 #include <sys/termios.h>
  43 #include <sys/fcntl.h>
  44 #include <sys/signalvar.h>
  45 #include <sys/eventhandler.h>
  46 #include <sys/interrupt.h>
  47 #include <machine/md_var.h>
  48 #include <unistd.h>
  49 #include <termios.h>
  50 #include <stdlib.h>
  51
  52 static int console_stolen_by_kernel;
  53 static struct kqueue_info *kqueue_console_info;
  54
  55 /*
  56  * Global console locking functions
  57  */
  58 void
  59 cons_lock(void)
  60 {
  61 }
  62
  63 void
  64 cons_unlock(void)
  65 {
  66 }
  67
  68 /************************************************************************
  69  *                          CONSOLE DEVICE                              *
  70  ************************************************************************
  71  *
  72  */
  73
  74 #define CDEV_MAJOR      12      /* steal the same major as /dev/ttyv* */
  75
  76 static int vcons_tty_param(struct tty *tp, struct termios *tio);
  77 static void vcons_tty_start(struct tty *tp);
  78 static void vcons_intr(void *tpx, struct intrframe *frame __unused);
  79
  80 static d_open_t         vcons_open;
  81 static d_close_t        vcons_close;
  82 static d_ioctl_t        vcons_ioctl;
  83
  84 static struct dev_ops vcons_ops = {
  85         { "vcons", CDEV_MAJOR, D_TTY },
  86         .d_open =       vcons_open,
  87         .d_close =      vcons_close,
  88         .d_read =       ttyread,
  89         .d_write =      ttywrite,
  90         .d_ioctl =      vcons_ioctl,
  91         .d_poll =       ttypoll,
  92 };
  93
  94 static int
  95 vcons_open(struct dev_open_args *ap)
  96 {
  97         cdev_t dev = ap->a_head.a_dev;
  98         struct tty *tp;
  99         int error;
 100
 101         tp = dev->si_tty = ttymalloc(dev->si_tty);
 102         if ((tp->t_state & TS_ISOPEN) == 0) {
 103                 tp->t_oproc = vcons_tty_start;
 104                 tp->t_param = vcons_tty_param;
 105                 tp->t_stop = nottystop;
 106                 tp->t_dev = dev;
 107
 108                 tp->t_state |= TS_CARR_ON | TS_CONNECTED;
 109                 ttychars(tp);
 110                 tp->t_iflag = TTYDEF_IFLAG;
 111                 tp->t_oflag = TTYDEF_OFLAG;
 112                 tp->t_cflag = TTYDEF_CFLAG;
 113                 tp->t_lflag = TTYDEF_LFLAG;
 114                 tp->t_ispeed = TTYDEF_SPEED;
 115                 tp->t_ospeed = TTYDEF_SPEED;
 116                 ttsetwater(tp);
 117         }
 118         if (minor(dev) == 0) {
 119                 error = (*linesw[tp->t_line].l_open)(dev, tp);
 120                 ioctl(0, TIOCGWINSZ, &tp->t_winsize);
 121
 122                 if (kqueue_console_info == NULL)
 123                         kqueue_console_info = kqueue_add(0, vcons_intr, tp);
 124         } else {
 125                 /* dummy up other minors so the installer will run */
 126                 error = 0;
 127         }
 128         return(error);
 129 }
 130
 131 static int
 132 vcons_close(struct dev_close_args *ap)
 133 {
 134         cdev_t dev = ap->a_head.a_dev;
 135         struct tty *tp;
 136
 137         tp = dev->si_tty;
 138         (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
 139         ttyclose(tp);
 140         return(0);
 141 }
 142
 143 static int
 144 vcons_ioctl(struct dev_ioctl_args *ap)
 145 {
 146         cdev_t dev = ap->a_head.a_dev;
 147         struct tty *tp;
 148         int error;
 149
 150         tp = dev->si_tty;
 151         error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data,
 152                                               ap->a_fflag, ap->a_cred);
 153         if (error != ENOIOCTL)
 154                 return (error);
 155         error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
 156         if (error != ENOIOCTL)
 157                 return (error);
 158         return (ENOTTY);
 159 }
 160
 161 static int
 162 vcons_tty_param(struct tty *tp, struct termios *tio)
 163 {
 164         tp->t_ispeed = tio->c_ispeed;
 165         tp->t_ospeed = tio->c_ospeed;
 166         tp->t_cflag = tio->c_cflag;
 167         return(0);
 168 }
 169
 170 static void
 171 vcons_tty_start(struct tty *tp)
 172 {
 173         int n;
 174         char buf[64];
 175
 176         if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
 177                 ttwwakeup(tp);
 178                 return;
 179         }
 180         tp->t_state |= TS_BUSY;
 181         while ((n = q_to_b(&tp->t_outq, buf, sizeof(buf))) > 0) {
 182                 /*
 183                  * Dummy up ttyv1, etc.
 184                  */
 185                 if (minor(tp->t_dev) == 0) {
 186                         crit_enter();
 187                         write(1, buf, n);
 188                         crit_exit();
 189                 }
 190         }
 191         tp->t_state &= ~TS_BUSY;
 192         ttwwakeup(tp);
 193 }
 194
 195 static
 196 void
 197 vcons_intr(void *tpx, struct intrframe *frame __unused)
 198 {
 199         struct tty *tp = tpx;
 200         unsigned char buf[32];
 201         int i;
 202         int n;
 203
 204         /*
 205          * If we aren't open we only have synchronous traffic via the
 206          * debugger and do not need to poll.
 207          */
 208         if ((tp->t_state & TS_ISOPEN) == 0)
 209                 return;
 210
 211         /*
 212          * Only poll if we are open and haven't been stolen by the debugger.
 213          */
 214         if (console_stolen_by_kernel == 0 && (tp->t_state & TS_ISOPEN)) {
 215                 do {
 216                         n = extpread(0, buf, sizeof(buf), O_FNONBLOCKING, -1LL);
 217                         for (i = 0; i < n; ++i)
 218                                 (*linesw[tp->t_line].l_rint)(buf[i], tp);
 219                 } while (n > 0);
 220         }
 221 }
 222
 223 /************************************************************************
 224  *                      KERNEL CONSOLE INTERFACE                        *
 225  ************************************************************************
 226  *
 227  * Kernel direct-call interface console driver
 228  */
 229 static cn_probe_t       vconsprobe;
 230 static cn_init_t        vconsinit;
 231 static cn_init_fini_t   vconsinit_fini;
 232 static cn_term_t        vconsterm;
 233 static cn_getc_t        vconsgetc;
 234 static cn_checkc_t      vconscheckc;
 235 static cn_putc_t        vconsputc;
 236
 237 CONS_DRIVER(vcons, vconsprobe, vconsinit, vconsinit_fini, vconsterm, vconsgetc,
 238                 vconscheckc, vconsputc, NULL);
 239
 240 static struct termios init_tio;
 241 static struct consdev *vconsole;
 242
 243 static void
 244 vconsprobe(struct consdev *cp)
 245 {
 246         cp->cn_pri = CN_NORMAL;
 247         cp->cn_probegood = 1;
 248 }
 249
 250 /*
 251  * This is a little bulky handler to set proper terminal
 252  * settings in the case of a signal which might lead to
 253  * termination or suspension.
 254  */
 255 static void
 256 vconssignal(int sig)
 257 {
 258         struct termios curtio;
 259         struct sigaction sa, osa;
 260         sigset_t ss, oss;
 261
 262         tcgetattr(0, &curtio);
 263         tcsetattr(0, TCSAFLUSH, &init_tio);
 264         bzero(&sa, sizeof(sa));
 265         sigemptyset(&sa.sa_mask);
 266         sa.sa_handler = SIG_DFL;
 267         sigaction(sig, &sa, &osa);
 268         sigemptyset(&ss);
 269         sigaddset(&ss, sig);
 270         sigprocmask(SIG_UNBLOCK, &ss, &oss);
 271         raise(sig);     /* now hand down the sig */
 272         sigprocmask(SIG_SETMASK, &oss, NULL);
 273         sigaction(sig, &osa, NULL);
 274         tcsetattr(0, TCSAFLUSH, &curtio);
 275 }
 276
 277 static void
 278 vconswinchsig(int __unused sig)
 279 {
 280         signalintr(3);
 281 }
 282
 283 static void
 284 vconswinch_intr(void *arg __unused, void *frame __unused)
 285 {
 286         struct winsize newsize;
 287
 288         if (vconsole != NULL && vconsole->cn_dev->si_tty != NULL) {
 289                 ioctl(0, TIOCGWINSZ, &newsize);
 290                 /*
 291                  * ttioctl(vconsole->cn_dev->si_tty, TIOCSWINSZ, &newsize, 0);
 292                  * I wished.  Unfortunately this needs a curproc, so do it
 293                  * manually.
 294                  */
 295                 if (bcmp(&newsize, &vconsole->cn_dev->si_tty->t_winsize,
 296                          sizeof(newsize)) != 0) {
 297                         vconsole->cn_dev->si_tty->t_winsize = newsize;
 298                         pgsignal(vconsole->cn_dev->si_tty->t_pgrp, SIGWINCH, 1);
 299                 }
 300         }
 301 }
 302
 303 static void
 304 vconscleanup(void)
 305 {
 306         /*
 307          * We might catch stray SIGIOs, so try hard.
 308          */
 309         while (tcsetattr(0, TCSAFLUSH, &init_tio) != 0 && errno == EINTR)
 310                 /* NOTHING */;
 311 }
 312
 313 static void
 314 vconsinit(struct consdev *cp)
 315 {
 316         struct sigaction sa;
 317
 318         vconsole = cp;
 319
 320         tcgetattr(0, &init_tio);
 321         bzero(&sa, sizeof(sa));
 322         sigemptyset(&sa.sa_mask);
 323         sa.sa_handler = vconssignal;
 324         sigaction(SIGTSTP, &sa, NULL);
 325         sigaction(SIGINT, &sa, NULL);
 326         sigaction(SIGTERM, &sa, NULL);
 327         atexit(vconscleanup);
 328         vcons_set_mode(0);
 329 }
 330
 331 static void
 332 vconsinit_fini(struct consdev *cp)
 333 {
 334         struct sigaction sa;
 335         cdev_t dev;
 336         int i;
 337
 338         /*
 339          * We have to do this here rather then in early boot to be able
 340          * to use the interrupt subsystem.
 341          */
 342         register_int(3, vconswinch_intr, NULL, "swinch", NULL, 0);
 343         bzero(&sa, sizeof(sa));
 344         sigemptyset(&sa.sa_mask);
 345         sa.sa_handler = vconswinchsig;
 346         sigaction(SIGWINCH, &sa, NULL);
 347
 348         /*
 349          * Implement ttyv0-ttyv7.  At the moment ttyv1-7 are sink nulls.
 350          */
 351         dev_ops_add(&vcons_ops, -1 & ~7, 0);
 352         for (i = 0; i < 8; ++i) {
 353                 dev = make_dev(&vcons_ops, i,
 354                                UID_ROOT, GID_WHEEL, 0600, "ttyv%d", i);
 355                 if (i == 0)
 356                         cp->cn_dev = dev;
 357         }
 358         EVENTHANDLER_REGISTER(shutdown_final, vconscleanup, NULL, SHUTDOWN_PRI_LAST);
 359 }
 360
 361 static void
 362 vconsterm(struct consdev *vp)
 363 {
 364         vconsole = NULL;
 365         vconscleanup();
 366 }
 367
 368 static int
 369 vconsgetc(void *private)
 370 {
 371         unsigned char c;
 372         ssize_t n;
 373
 374         console_stolen_by_kernel = 1;
 375         for (;;) {
 376                 crit_enter();
 377                 n = read(0, &c, 1);
 378                 crit_exit();
 379                 if (n == 1)
 380                         break;
 381                 if (n < 0 && errno == EINTR)
 382                         continue;
 383                 panic("vconsgetc: EOF on console %d %d", n ,errno);
 384         }
 385         console_stolen_by_kernel = 0;
 386         return((int)c);
 387 }
 388
 389 static int
 390 vconscheckc(void *private)
 391 {
 392         unsigned char c;
 393
 394         if (extpread(0, &c, 1, O_FNONBLOCKING, -1LL) == 1)
 395                 return((int)c);
 396         return(-1);
 397 }
 398
 399 static void
 400 vconsputc(void *private, int c)
 401 {
 402         char cc = c;
 403
 404         crit_enter();
 405         write(1, &cc, 1);
 406         crit_exit();
 407 }
 408
 409 void
 410 vcons_set_mode(int in_debugger)
 411 {
 412         struct termios tio;
 413
 414         if (tcgetattr(0, &tio) < 0)
 415                 return;
 416         cfmakeraw(&tio);
 417         tio.c_oflag |= OPOST | ONLCR;
 418         tio.c_lflag |= ISIG;
 419         if (in_debugger) {
 420                 tio.c_cc[VINTR] = init_tio.c_cc[VINTR];
 421                 tio.c_cc[VSUSP] = init_tio.c_cc[VSUSP];
 422                 tio.c_cc[VSTATUS] = init_tio.c_cc[VSTATUS];
 423         } else {
 424                 tio.c_cc[VINTR] = _POSIX_VDISABLE;
 425                 tio.c_cc[VSUSP] = _POSIX_VDISABLE;
 426                 tio.c_cc[VSTATUS] = _POSIX_VDISABLE;
 427         }
 428         tcsetattr(0, TCSAFLUSH, &tio);
 429 }