sys/kern/tty_cons.c

   1 /*
   2  * Copyright (c) 1988 University of Utah.
   3  * Copyright (c) 1991 The Regents of the University of California.
   4  * All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * the Systems Programming Group of the University of Utah Computer
   8  * Science Department.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      from: @(#)cons.c        7.2 (Berkeley) 5/9/91
  39  * $FreeBSD: src/sys/kern/tty_cons.c,v 1.81.2.4 2001/12/17 18:44:41 guido Exp $
  40  */
  41
  42 #include "opt_ddb.h"
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/conf.h>
  47 #include <sys/cons.h>
  48 #include <sys/kernel.h>
  49 #include <sys/proc.h>
  50 #include <sys/priv.h>
  51 #include <sys/reboot.h>
  52 #include <sys/sysctl.h>
  53 #include <sys/tty.h>
  54 #include <sys/uio.h>
  55 #include <sys/msgport.h>
  56 #include <sys/msgport2.h>
  57 #include <sys/device.h>
  58
  59 #include <ddb/ddb.h>
  60
  61 #include <machine/cpu.h>
  62
  63 static d_open_t cnopen;
  64 static d_close_t cnclose;
  65 static d_read_t cnread;
  66 static d_write_t cnwrite;
  67 static d_ioctl_t cnioctl;
  68 static d_kqfilter_t cnkqfilter;
  69
  70 static int cnintercept(struct dev_generic_args *ap);
  71
  72 #define CDEV_MAJOR      0
  73 static struct dev_ops cn_ops = {
  74         { "console", 0, D_TTY },
  75         .d_open =       cnopen,
  76         .d_close =      cnclose,
  77         .d_read =       cnread,
  78         .d_write =      cnwrite,
  79         .d_ioctl =      cnioctl,
  80         .d_kqfilter =   cnkqfilter,
  81 };
  82
  83 static struct dev_ops cn_iops = {
  84         { "intercept", 0, D_TTY },
  85         .d_default =    cnintercept
  86 };
  87
  88 static struct dev_ops *cn_fwd_ops;
  89 static cdev_t   cn_dev;
  90
  91 //XXX: get this shit out! (alexh)
  92 #if 0
  93 SYSCTL_OPAQUE(_machdep, CPU_CONSDEV, consdev, CTLFLAG_RD,
  94         &cn_udev, sizeof cn_udev, "T,udev_t", "");
  95 #endif
  96
  97 static int cn_mute;
  98
  99 int     cons_unavail = 0;       /* XXX:
 100                                  * physical console not available for
 101                                  * input (i.e., it is in graphics mode)
 102                                  */
 103 int     sysbeep_enable = 1;
 104
 105 static u_char cn_is_open;               /* nonzero if logical console is open */
 106 static int openmode, openflag;          /* how /dev/console was openned */
 107 static cdev_t cn_devfsdev;              /* represents the device private info */
 108 static u_char cn_phys_is_open;          /* nonzero if physical device is open */
 109 static u_char console_pausing;          /* pause after each line during probe */
 110 static char *console_pausestr=
 111 "<pause; press any key to proceed to next line or '.' to end pause mode>";
 112
 113 struct consdev *cn_tab;         /* physical console device info */
 114 struct consdev *gdb_tab;        /* physical gdb debugger device info */
 115
 116 SYSCTL_INT(_kern, OID_AUTO, sysbeep_enable, CTLFLAG_RW, &sysbeep_enable, 0, "");
 117
 118 CONS_DRIVER(cons, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);
 119 SET_DECLARE(cons_set, struct consdev);
 120
 121 void
 122 cninit(void)
 123 {
 124         struct consdev *best_cp, *cp, **list;
 125
 126         /*
 127          * Workaround for token acquisition and releases during the
 128          * console init.  For some reason if lwkt_gettoken()'s mpcount
 129          * optimization is turned off the console init blows up.  It
 130          * might be trying to kprintf() something in the middle of
 131          * its init.
 132          */
 133         lwkt_gettoken(&tty_token);
 134
 135         /*
 136          * Check if we should mute the console (for security reasons perhaps)
 137          * It can be changes dynamically using sysctl kern.consmute
 138          * once we are up and going.
 139          *
 140          */
 141         cn_mute = ((boothowto & (RB_MUTE
 142                         |RB_SINGLE
 143                         |RB_VERBOSE
 144                         |RB_ASKNAME
 145                         |RB_CONFIG)) == RB_MUTE);
 146
 147         /*
 148          * Find the first console with the highest priority.
 149          */
 150         best_cp = NULL;
 151         SET_FOREACH(list, cons_set) {
 152                 cp = *list;
 153                 if (cp->cn_probe == NULL)
 154                         continue;
 155                 (*cp->cn_probe)(cp);
 156                 if (cp->cn_pri > CN_DEAD && cp->cn_probegood &&
 157                     (best_cp == NULL || cp->cn_pri > best_cp->cn_pri))
 158                         best_cp = cp;
 159         }
 160
 161
 162         /*
 163          * If no console, give up.
 164          */
 165         if (best_cp == NULL) {
 166                 if (cn_tab != NULL && cn_tab->cn_term != NULL)
 167                         (*cn_tab->cn_term)(cn_tab);
 168                 goto done;
 169         }
 170
 171         /*
 172          * Initialize console, then attach to it.  This ordering allows
 173          * debugging using the previous console, if any.
 174          */
 175         (*best_cp->cn_init)(best_cp);
 176         if (cn_tab != NULL && cn_tab != best_cp) {
 177                 /* Turn off the previous console.  */
 178                 if (cn_tab->cn_term != NULL)
 179                         (*cn_tab->cn_term)(cn_tab);
 180         }
 181         if (boothowto & RB_PAUSE)
 182                 console_pausing = 1;
 183 done:
 184         cn_tab = best_cp;
 185
 186         /*
 187          * We can safely release the token after the init is done.
 188          * Also assert that the mpcount is still correct or otherwise
 189          * the SMP/AP boot will blow up on us.
 190          */
 191         lwkt_reltoken(&tty_token);
 192 }
 193
 194
 195 /*
 196  * Hook the open and close functions on the selected device.
 197  */
 198 void
 199 cninit_finish(void)
 200 {
 201         if ((cn_tab == NULL) || cn_mute)
 202                 return;
 203         if (cn_tab->cn_dev == NULL) {
 204                 cn_tab->cn_init_fini(cn_tab);
 205                 if (cn_tab->cn_dev == NULL) {
 206                         kprintf("Unable to hook console! cn_tab %p\n", cn_tab);
 207                         return;
 208                 }
 209         }
 210
 211         cn_fwd_ops = dev_ops_intercept(cn_tab->cn_dev, &cn_iops);
 212         cn_dev = cn_tab->cn_dev;
 213         console_pausing = 0;
 214 }
 215
 216 static void
 217 cnuninit(void)
 218 {
 219         if (cn_tab == NULL)
 220                 return;
 221         if (cn_fwd_ops)
 222                 dev_ops_restore(cn_tab->cn_dev, cn_fwd_ops);
 223         cn_fwd_ops = NULL;
 224         cn_dev = NULL;
 225 }
 226
 227
 228 /*
 229  * User has changed the state of the console muting.
 230  * This may require us to open or close the device in question.
 231  */
 232 static int
 233 sysctl_kern_consmute(SYSCTL_HANDLER_ARGS)
 234 {
 235         int error;
 236         int ocn_mute;
 237
 238         ocn_mute = cn_mute;
 239         error = sysctl_handle_int(oidp, &cn_mute, 0, req);
 240         if((error == 0) && (cn_tab != NULL) && (req->newptr != NULL)) {
 241                 if(ocn_mute && !cn_mute) {
 242                         /*
 243                          * going from muted to unmuted.. open the physical dev
 244                          * if the console has been openned
 245                          */
 246                         cninit_finish();
 247                         if (cn_is_open) {
 248                                 /* XXX curproc is not what we want really */
 249                                 error = dev_dopen(cn_dev, openflag,
 250                                                 openmode, curproc->p_ucred);
 251                         }
 252                         /* if it failed, back it out */
 253                         if ( error != 0) cnuninit();
 254                 } else if (!ocn_mute && cn_mute) {
 255                         /*
 256                          * going from unmuted to muted.. close the physical dev
 257                          * if it's only open via /dev/console
 258                          */
 259                         if (cn_is_open) {
 260                                 error = dev_dclose(cn_dev, openflag,
 261                                                    openmode);
 262                         }
 263                         if (error == 0)
 264                                 cnuninit();
 265                 }
 266                 if (error != 0) {
 267                         /*
 268                          * back out the change if there was an error
 269                          */
 270                         cn_mute = ocn_mute;
 271                 }
 272         }
 273         return (error);
 274 }
 275
 276 SYSCTL_PROC(_kern, OID_AUTO, consmute, CTLTYPE_INT|CTLFLAG_RW,
 277         0, sizeof cn_mute, sysctl_kern_consmute, "I", "");
 278
 279
 280 /*
 281  * We intercept the OPEN and CLOSE calls on the original device, and
 282  * forward the rest through.
 283  */
 284 static int
 285 cnintercept(struct dev_generic_args *ap)
 286 {
 287         int error;
 288
 289         if (ap->a_desc == &dev_open_desc) {
 290                 error = cnopen((struct dev_open_args *)ap);
 291         } else if (ap->a_desc == &dev_close_desc) {
 292                 error = cnclose((struct dev_close_args *)ap);
 293         } else if (cn_fwd_ops) {
 294                 error = dev_doperate_ops(cn_fwd_ops, ap);
 295         } else {
 296                 error = ENXIO;
 297         }
 298         return (error);
 299 }
 300
 301 /*
 302  * cnopen() is called as an intercept function (dev will be that of the
 303  * actual physical device representing our console), and also called from
 304  * the muting code and from the /dev/console switch (dev will have the
 305  * console's cdevsw).
 306  */
 307 static int
 308 cnopen(struct dev_open_args *ap)
 309 {
 310         cdev_t dev = ap->a_head.a_dev;
 311         int flag = ap->a_oflags;
 312         int mode = ap->a_devtype;
 313         cdev_t cndev;
 314         cdev_t physdev;
 315         int retval = 0;
 316
 317         if (cn_tab == NULL || cn_fwd_ops == NULL)
 318                 return (0);
 319
 320         cndev = cn_tab->cn_dev;         /* actual physical device */
 321         physdev = (dev == cn_devfsdev) ? cndev : dev;
 322
 323         /*
 324          * If mute is active, then non console opens don't get here
 325          * so we don't need to check for that. They bypass this and go
 326          * straight to the device.
 327          *
 328          * It is important to note that due to our intercept and the fact
 329          * that we might be called via the original (intercepted) device,
 330          * the original device's ops may point to us, so to avoid an
 331          * infinite recursion we have to forward through cn_fwd_ops.
 332          * This is a severe hack that really needs to be fixed XXX.
 333          *
 334          * XXX at the moment we assume that the port forwarding function
 335          * is synchronous for open.
 336          */
 337         if (!cn_mute) {
 338                 ap->a_head.a_dev = physdev;
 339                 retval = dev_doperate_ops(cn_fwd_ops, &ap->a_head);
 340         }
 341         if (retval == 0) {
 342                 /*
 343                  * check if we openned it via /dev/console or
 344                  * via the physical entry (e.g. /dev/sio0).
 345                  */
 346                 if (dev == cndev) {
 347                         cn_phys_is_open = 1;
 348                 } else if (physdev == cndev) {
 349                         openmode = mode;
 350                         openflag = flag;
 351                         cn_is_open = 1;
 352                 }
 353                 dev->si_tty = cndev->si_tty;
 354         }
 355         return (retval);
 356 }
 357
 358 /*
 359  * cnclose() is called as a port intercept function (dev will be that of the
 360  * actual physical device representing our console), and also called from
 361  * the muting code and from the /dev/console switch (dev will have the
 362  * console's cdevsw).
 363  */
 364 static int
 365 cnclose(struct dev_close_args *ap)
 366 {
 367         struct tty *cn_tp;
 368         cdev_t cndev;
 369         cdev_t physdev;
 370         cdev_t dev = ap->a_head.a_dev;
 371
 372         if (cn_tab == NULL || cn_fwd_ops == NULL)
 373                 return(0);
 374         cndev = cn_tab->cn_dev;
 375         cn_tp = cndev->si_tty;
 376         physdev = (dev == cn_devfsdev) ? cndev : dev;
 377
 378         /*
 379          * act appropriatly depending on whether it's /dev/console
 380          * or the pysical device (e.g. /dev/sio) that's being closed.
 381          * in either case, don't actually close the device unless
 382          * both are closed.
 383          */
 384         if (dev == cndev) {
 385                 /* the physical device is about to be closed */
 386                 cn_phys_is_open = 0;
 387                 if (cn_is_open) {
 388                         if (cn_tp) {
 389                                 /* perform a ttyhalfclose() */
 390                                 /* reset session and proc group */
 391                                 ttyclearsession(cn_tp);
 392                         }
 393                         return(0);
 394                 }
 395         } else if (physdev == cndev) {
 396                 /* the logical console is about to be closed */
 397                 cn_is_open = 0;
 398                 if (cn_phys_is_open)
 399                         return(0);
 400                 dev = cndev;
 401         }
 402         if (cn_fwd_ops) {
 403                 ap->a_head.a_dev = dev;
 404                 return (dev_doperate_ops(cn_fwd_ops, &ap->a_head));
 405         }
 406         return (0);
 407 }
 408
 409 /*
 410  * The following functions are dispatched solely from the /dev/console
 411  * device.  Their job is primarily to forward the request through.
 412  * If the console is not attached to anything then write()'s are sunk
 413  * to null and reads return 0 (mostly).
 414  */
 415 static int
 416 cnread(struct dev_read_args *ap)
 417 {
 418         if (cn_tab == NULL || cn_fwd_ops == NULL)
 419                 return (0);
 420         ap->a_head.a_dev = cn_tab->cn_dev;
 421         return (dev_doperate(&ap->a_head));
 422 }
 423
 424 static int
 425 cnwrite(struct dev_write_args *ap)
 426 {
 427         struct uio *uio = ap->a_uio;
 428         cdev_t dev;
 429
 430         if (cn_tab == NULL || cn_fwd_ops == NULL) {
 431                 uio->uio_resid = 0; /* dump the data */
 432                 return (0);
 433         }
 434         if (constty)
 435                 dev = constty->t_dev;
 436         else
 437                 dev = cn_tab->cn_dev;
 438         log_console(uio);
 439         ap->a_head.a_dev = dev;
 440         return (dev_doperate(&ap->a_head));
 441 }
 442
 443 static int
 444 cnioctl(struct dev_ioctl_args *ap)
 445 {
 446         int error;
 447
 448         if (cn_tab == NULL || cn_fwd_ops == NULL)
 449                 return (0);
 450         KKASSERT(curproc != NULL);
 451         /*
 452          * Superuser can always use this to wrest control of console
 453          * output from the "virtual" console.
 454          */
 455         if (ap->a_cmd == TIOCCONS && constty) {
 456                 if (ap->a_cred) {
 457                         error = priv_check_cred(ap->a_cred, PRIV_ROOT, 0);
 458                         if (error)
 459                                 return (error);
 460                 }
 461                 constty = NULL;
 462                 return (0);
 463         }
 464         ap->a_head.a_dev = cn_tab->cn_dev;
 465         return (dev_doperate(&ap->a_head));
 466 }
 467
 468 static int
 469 cnkqfilter(struct dev_kqfilter_args *ap)
 470 {
 471         if ((cn_tab == NULL) || cn_mute || cn_fwd_ops == NULL)
 472                 return (1);
 473         ap->a_head.a_dev = cn_tab->cn_dev;
 474         return (dev_doperate(&ap->a_head));
 475 }
 476
 477 /*
 478  * These synchronous functions are primarily used the kernel needs to
 479  * access the keyboard (e.g. when running the debugger), or output data
 480  * directly to the console.
 481  */
 482 int
 483 cngetc(void)
 484 {
 485         int c;
 486         if ((cn_tab == NULL) || cn_mute)
 487                 return (-1);
 488         c = (*cn_tab->cn_getc)(cn_tab->cn_dev);
 489         if (c == '\r') c = '\n'; /* console input is always ICRNL */
 490         return (c);
 491 }
 492
 493 int
 494 cncheckc(void)
 495 {
 496         if ((cn_tab == NULL) || cn_mute)
 497                 return (-1);
 498         return ((*cn_tab->cn_checkc)(cn_tab->cn_dev));
 499 }
 500
 501 void
 502 cnputc(int c)
 503 {
 504         char *cp;
 505
 506         if ((cn_tab == NULL) || cn_mute)
 507                 return;
 508         if (c) {
 509                 if (c == '\n')
 510                         (*cn_tab->cn_putc)(cn_tab->cn_dev, '\r');
 511                 (*cn_tab->cn_putc)(cn_tab->cn_dev, c);
 512 #ifdef DDB
 513                 if (console_pausing && !db_active && (c == '\n')) {
 514 #else
 515                 if (console_pausing && (c == '\n')) {
 516 #endif
 517                         for(cp=console_pausestr; *cp != '\0'; cp++)
 518                             (*cn_tab->cn_putc)(cn_tab->cn_dev, *cp);
 519                         if (cngetc() == '.')
 520                                 console_pausing = 0;
 521                         (*cn_tab->cn_putc)(cn_tab->cn_dev, '\r');
 522                         for(cp=console_pausestr; *cp != '\0'; cp++)
 523                             (*cn_tab->cn_putc)(cn_tab->cn_dev, ' ');
 524                         (*cn_tab->cn_putc)(cn_tab->cn_dev, '\r');
 525                 }
 526         }
 527 }
 528
 529 void
 530 cndbctl(int on)
 531 {
 532         static int refcount;
 533
 534         if (cn_tab == NULL)
 535                 return;
 536         if (!on)
 537                 refcount--;
 538         if (refcount == 0 && cn_tab->cn_dbctl != NULL)
 539                 (*cn_tab->cn_dbctl)(cn_tab->cn_dev, on);
 540         if (on)
 541                 refcount++;
 542 }
 543
 544 static void
 545 cn_drvinit(void *unused)
 546 {
 547         cn_devfsdev = make_only_devfs_dev(&cn_ops, 0, UID_ROOT, GID_WHEEL,
 548                                           0600, "console");
 549 }
 550
 551 SYSINIT(cndev,SI_SUB_DRIVERS,SI_ORDER_MIDDLE+CDEV_MAJOR,cn_drvinit,NULL)