bsd/kern/tty_pty.c

   1 /*
   2  * Copyright (c) 1997-2013 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1982, 1986, 1989, 1993
  30  *      The Regents of the University of California.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)tty_pty.c   8.4 (Berkeley) 2/20/95
  61  */
  62
  63 /*
  64  * Pseudo-teletype Driver
  65  * (Actually two drivers, requiring two entries in 'cdevsw')
  66  */
  67 #include "pty.h"                /* XXX */
  68
  69 #include <sys/param.h>
  70 #include <sys/systm.h>
  71 #include <sys/ioctl.h>
  72 #include <sys/proc_internal.h>
  73 #include <sys/kauth.h>
  74 #include <sys/tty.h>
  75 #include <sys/conf.h>
  76 #include <sys/file_internal.h>
  77 #include <sys/uio_internal.h>
  78 #include <sys/kernel.h>
  79 #include <sys/vnode.h>
  80 #include <sys/user.h>
  81 #include <sys/signalvar.h>
  82
  83 #if CONFIG_MACF
  84 #include <security/mac_framework.h>
  85 #endif
  86
  87 #include "tty_dev.h"
  88
  89 #if NPTY == 1
  90 #undef NPTY
  91 #define NPTY    32              /* crude XXX */
  92 #warning        You have only one pty defined, redefining to 32.
  93 #endif
  94
  95 /*
  96  * pts == /dev/tty[pqrsPQRS][0-9a-v]
  97  * ptc == /dev/pty[pqrsPQRS][0-9a-v]
  98  */
  99 static struct ptmx_ioctl pt_ioctl[NPTY];
 100
 101 int pty_init(int n_ptys);
 102
 103 #ifndef DEVFS
 104 int
 105 pty_init(__unused int n_ptys)
 106 {
 107         return 0;
 108 }
 109 #else // DEVFS
 110 #include <miscfs/devfs/devfs.h>
 111 #define START_CHAR      'p'
 112 #define HEX_BASE        16
 113
 114 static struct tty_dev_t _pty_driver;
 115
 116 static struct ptmx_ioctl *
 117 pty_get_ioctl(int minor, int open_flag)
 118 {
 119         if (minor >= NPTY) {
 120                 return NULL;
 121         }
 122         struct ptmx_ioctl *pti = &pt_ioctl[minor];
 123         if (open_flag & (PF_OPEN_M | PF_OPEN_S)) {
 124                 if (!pti->pt_tty) {
 125                         pti->pt_tty = ttymalloc();
 126                 }
 127                 if (!pti->pt_tty) {
 128                         return NULL;
 129                 }
 130         }
 131         return pti;
 132 }
 133
 134 static int
 135 pty_get_name(int minor, char *buffer, size_t size)
 136 {
 137         return snprintf(buffer, size, "/dev/tty%c%x",
 138                    START_CHAR + (minor / HEX_BASE),
 139                    minor % HEX_BASE);
 140 }
 141
 142 int
 143 pty_init(int n_ptys)
 144 {
 145         int i;
 146         int j;
 147
 148         n_ptys = min(n_ptys, NPTY); /* clamp to avoid pt_ioctl overflow */
 149
 150         /* create the pseudo tty device nodes */
 151         for (j = 0; j < 10; j++) {
 152                 for (i = 0; i < HEX_BASE; i++) {
 153                         int m = j * HEX_BASE + i;
 154                         if (m >= n_ptys) {
 155                                 goto done;
 156                         }
 157                         pt_ioctl[m].pt_devhandle = devfs_make_node(makedev(PTS_MAJOR, m),
 158                             DEVFS_CHAR, UID_ROOT, GID_WHEEL, 0666,
 159                             "tty%c%x", j + START_CHAR, i);
 160                         (void)devfs_make_node(makedev(PTC_MAJOR, m),
 161                             DEVFS_CHAR, UID_ROOT, GID_WHEEL, 0666,
 162                             "pty%c%x", j + START_CHAR, i);
 163                 }
 164         }
 165
 166 done:
 167         _pty_driver.master = PTC_MAJOR;
 168         _pty_driver.slave = PTS_MAJOR;
 169         _pty_driver.open_reset = 1;
 170         _pty_driver.open = &pty_get_ioctl;
 171         _pty_driver.name = &pty_get_name;
 172         tty_dev_register(&_pty_driver);
 173
 174         if (cdevsw_setkqueueok(PTC_MAJOR, &cdevsw[PTC_MAJOR], CDEVSW_IS_PTC) == -1) {
 175                 panic("Can't mark ptc as kqueue ok");
 176         }
 177         if (cdevsw_setkqueueok(PTS_MAJOR, &cdevsw[PTS_MAJOR], CDEVSW_IS_PTS) == -1) {
 178                 panic("Can't mark pts as kqueue ok");
 179         }
 180         return 0;
 181 }
 182 #endif // DEVFS