tty_ptm.c revision 1.2.2.5 1 1.2.2.5 christos /* $NetBSD: tty_ptm.c,v 1.2.2.5 2005/12/11 10:29:12 christos Exp $ */
2 1.2.2.2 skrll
3 1.2.2.2 skrll /*-
4 1.2.2.2 skrll * Copyright (c) 2004 The NetBSD Foundation, Inc.
5 1.2.2.2 skrll * All rights reserved.
6 1.2.2.2 skrll *
7 1.2.2.2 skrll * Redistribution and use in source and binary forms, with or without
8 1.2.2.2 skrll * modification, are permitted provided that the following conditions
9 1.2.2.2 skrll * are met:
10 1.2.2.2 skrll * 1. Redistributions of source code must retain the above copyright
11 1.2.2.2 skrll * notice, this list of conditions and the following disclaimer.
12 1.2.2.2 skrll * 2. Redistributions in binary form must reproduce the above copyright
13 1.2.2.2 skrll * notice, this list of conditions and the following disclaimer in the
14 1.2.2.2 skrll * documentation and/or other materials provided with the distribution.
15 1.2.2.2 skrll * 3. All advertising materials mentioning features or use of this software
16 1.2.2.2 skrll * must display the following acknowledgement:
17 1.2.2.2 skrll * This product includes software developed by the NetBSD
18 1.2.2.2 skrll * Foundation, Inc. and its contributors.
19 1.2.2.2 skrll * 4. Neither the name of The NetBSD Foundation nor the names of its
20 1.2.2.2 skrll * contributors may be used to endorse or promote products derived
21 1.2.2.2 skrll * from this software without specific prior written permission.
22 1.2.2.2 skrll *
23 1.2.2.2 skrll * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24 1.2.2.2 skrll * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 1.2.2.2 skrll * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 1.2.2.2 skrll * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27 1.2.2.2 skrll * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 1.2.2.2 skrll * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 1.2.2.2 skrll * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 1.2.2.2 skrll * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 1.2.2.2 skrll * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 1.2.2.2 skrll * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 1.2.2.2 skrll * POSSIBILITY OF SUCH DAMAGE.
34 1.2.2.2 skrll */
35 1.2.2.2 skrll
36 1.2.2.2 skrll #include <sys/cdefs.h>
37 1.2.2.5 christos __KERNEL_RCSID(0, "$NetBSD: tty_ptm.c,v 1.2.2.5 2005/12/11 10:29:12 christos Exp $");
38 1.2.2.2 skrll
39 1.2.2.2 skrll #include "opt_ptm.h"
40 1.2.2.2 skrll
41 1.2.2.2 skrll /* pty multiplexor driver /dev/ptm{,x} */
42 1.2.2.2 skrll
43 1.2.2.2 skrll #include <sys/param.h>
44 1.2.2.2 skrll #include <sys/systm.h>
45 1.2.2.2 skrll #include <sys/ioctl.h>
46 1.2.2.2 skrll #include <sys/proc.h>
47 1.2.2.2 skrll #include <sys/tty.h>
48 1.2.2.2 skrll #include <sys/stat.h>
49 1.2.2.2 skrll #include <sys/file.h>
50 1.2.2.2 skrll #include <sys/uio.h>
51 1.2.2.2 skrll #include <sys/kernel.h>
52 1.2.2.2 skrll #include <sys/vnode.h>
53 1.2.2.2 skrll #include <sys/namei.h>
54 1.2.2.2 skrll #include <sys/signalvar.h>
55 1.2.2.2 skrll #include <sys/uio.h>
56 1.2.2.2 skrll #include <sys/filedesc.h>
57 1.2.2.2 skrll #include <sys/conf.h>
58 1.2.2.2 skrll #include <sys/poll.h>
59 1.2.2.2 skrll #include <sys/malloc.h>
60 1.2.2.2 skrll #include <sys/pty.h>
61 1.2.2.2 skrll
62 1.2.2.2 skrll #ifdef DEBUG_PTM
63 1.2.2.2 skrll #define DPRINTF(a) printf a
64 1.2.2.2 skrll #else
65 1.2.2.2 skrll #define DPRINTF(a)
66 1.2.2.2 skrll #endif
67 1.2.2.2 skrll
68 1.2.2.2 skrll #ifdef NO_DEV_PTM
69 1.2.2.2 skrll const struct cdevsw ptm_cdevsw = {
70 1.2.2.2 skrll noopen, noclose, noread, nowrite, noioctl,
71 1.2.2.2 skrll nostop, notty, nopoll, nommap, nokqfilter, D_TTY
72 1.2.2.2 skrll };
73 1.2.2.2 skrll #else
74 1.2.2.2 skrll
75 1.2.2.2 skrll static struct ptm_pty *ptm;
76 1.2.2.2 skrll int pts_major, ptc_major;
77 1.2.2.2 skrll
78 1.2.2.2 skrll static dev_t pty_getfree(void);
79 1.2.2.2 skrll static int pty_alloc_master(struct lwp *, int *, dev_t *);
80 1.2.2.2 skrll static int pty_alloc_slave(struct lwp *, int *, dev_t);
81 1.2.2.2 skrll
82 1.2.2.2 skrll void ptmattach(int);
83 1.2.2.2 skrll
84 1.2.2.2 skrll dev_t
85 1.2.2.2 skrll pty_makedev(char ms, int minor)
86 1.2.2.2 skrll {
87 1.2.2.2 skrll return makedev(ms == 't' ? pts_major : ptc_major, minor);
88 1.2.2.2 skrll }
89 1.2.2.2 skrll
90 1.2.2.5 christos
91 1.2.2.2 skrll static dev_t
92 1.2.2.2 skrll pty_getfree(void)
93 1.2.2.2 skrll {
94 1.2.2.2 skrll extern struct simplelock pt_softc_mutex;
95 1.2.2.2 skrll int i;
96 1.2.2.2 skrll
97 1.2.2.2 skrll simple_lock(&pt_softc_mutex);
98 1.2.2.2 skrll for (i = 0; i < npty; i++) {
99 1.2.2.2 skrll if (pty_isfree(i, 0))
100 1.2.2.2 skrll break;
101 1.2.2.2 skrll }
102 1.2.2.2 skrll simple_unlock(&pt_softc_mutex);
103 1.2.2.2 skrll return pty_makedev('t', i);
104 1.2.2.2 skrll }
105 1.2.2.2 skrll
106 1.2.2.2 skrll /*
107 1.2.2.2 skrll * Hacked up version of vn_open. We _only_ handle ptys and only open
108 1.2.2.2 skrll * them with FREAD|FWRITE and never deal with creat or stuff like that.
109 1.2.2.2 skrll *
110 1.2.2.2 skrll * We need it because we have to fake up root credentials to open the pty.
111 1.2.2.2 skrll */
112 1.2.2.2 skrll int
113 1.2.2.2 skrll pty_vn_open(struct vnode *vp, struct lwp *l)
114 1.2.2.2 skrll {
115 1.2.2.2 skrll struct ucred *cred;
116 1.2.2.2 skrll int error;
117 1.2.2.2 skrll
118 1.2.2.2 skrll if (vp->v_type != VCHR) {
119 1.2.2.2 skrll vput(vp);
120 1.2.2.2 skrll return EINVAL;
121 1.2.2.2 skrll }
122 1.2.2.2 skrll
123 1.2.2.2 skrll /*
124 1.2.2.2 skrll * Get us a fresh cred with root privileges.
125 1.2.2.2 skrll */
126 1.2.2.2 skrll cred = crget();
127 1.2.2.2 skrll error = VOP_OPEN(vp, FREAD|FWRITE, cred, l);
128 1.2.2.2 skrll crfree(cred);
129 1.2.2.2 skrll
130 1.2.2.2 skrll if (error) {
131 1.2.2.2 skrll vput(vp);
132 1.2.2.2 skrll return error;
133 1.2.2.2 skrll }
134 1.2.2.2 skrll
135 1.2.2.2 skrll vp->v_writecount++;
136 1.2.2.2 skrll
137 1.2.2.2 skrll return 0;
138 1.2.2.2 skrll }
139 1.2.2.2 skrll
140 1.2.2.2 skrll static int
141 1.2.2.2 skrll pty_alloc_master(struct lwp *l, int *fd, dev_t *dev)
142 1.2.2.2 skrll {
143 1.2.2.2 skrll int error;
144 1.2.2.2 skrll struct file *fp;
145 1.2.2.2 skrll struct vnode *vp;
146 1.2.2.2 skrll struct proc *p = l->l_proc;
147 1.2.2.2 skrll int md;
148 1.2.2.2 skrll
149 1.2.2.2 skrll if ((error = falloc(p, &fp, fd)) != 0) {
150 1.2.2.2 skrll DPRINTF(("falloc %d\n", error));
151 1.2.2.2 skrll return error;
152 1.2.2.2 skrll }
153 1.2.2.2 skrll retry:
154 1.2.2.2 skrll /* Find and open a free master pty. */
155 1.2.2.2 skrll *dev = pty_getfree();
156 1.2.2.2 skrll md = minor(*dev);
157 1.2.2.2 skrll if ((error = pty_check(md)) != 0) {
158 1.2.2.2 skrll DPRINTF(("pty_check %d\n", error));
159 1.2.2.2 skrll goto bad;
160 1.2.2.2 skrll }
161 1.2.2.2 skrll if (ptm == NULL) {
162 1.2.2.2 skrll error = EOPNOTSUPP;
163 1.2.2.2 skrll goto bad;
164 1.2.2.2 skrll }
165 1.2.2.2 skrll if ((error = (*ptm->allocvp)(ptm, l, &vp, *dev, 'p')) != 0)
166 1.2.2.2 skrll goto bad;
167 1.2.2.2 skrll
168 1.2.2.2 skrll if ((error = pty_vn_open(vp, l)) != 0) {
169 1.2.2.2 skrll /*
170 1.2.2.2 skrll * Check if the master open failed because we lost
171 1.2.2.2 skrll * the race to grab it.
172 1.2.2.2 skrll */
173 1.2.2.2 skrll if (error != EIO)
174 1.2.2.2 skrll goto bad;
175 1.2.2.2 skrll error = !pty_isfree(md, 1);
176 1.2.2.2 skrll if (error)
177 1.2.2.2 skrll goto retry;
178 1.2.2.2 skrll else
179 1.2.2.2 skrll goto bad;
180 1.2.2.2 skrll }
181 1.2.2.2 skrll fp->f_flag = FREAD|FWRITE;
182 1.2.2.2 skrll fp->f_type = DTYPE_VNODE;
183 1.2.2.2 skrll fp->f_ops = &vnops;
184 1.2.2.2 skrll fp->f_data = vp;
185 1.2.2.2 skrll VOP_UNLOCK(vp, 0);
186 1.2.2.2 skrll FILE_SET_MATURE(fp);
187 1.2.2.2 skrll FILE_UNUSE(fp, l);
188 1.2.2.2 skrll return 0;
189 1.2.2.2 skrll bad:
190 1.2.2.2 skrll FILE_UNUSE(fp, l);
191 1.2.2.2 skrll fdremove(p->p_fd, *fd);
192 1.2.2.2 skrll ffree(fp);
193 1.2.2.2 skrll return error;
194 1.2.2.2 skrll }
195 1.2.2.2 skrll
196 1.2.2.2 skrll int
197 1.2.2.2 skrll pty_grant_slave(struct lwp *l, dev_t dev)
198 1.2.2.2 skrll {
199 1.2.2.2 skrll int error;
200 1.2.2.2 skrll struct vnode *vp;
201 1.2.2.2 skrll
202 1.2.2.2 skrll /*
203 1.2.2.2 skrll * Open the slave.
204 1.2.2.2 skrll * namei -> setattr -> unlock -> revoke -> vrele ->
205 1.2.2.2 skrll * namei -> open -> unlock
206 1.2.2.2 skrll * Three stage rocket:
207 1.2.2.2 skrll * 1. Change the owner and permissions on the slave.
208 1.2.2.2 skrll * 2. Revoke all the users of the slave.
209 1.2.2.2 skrll * 3. open the slave.
210 1.2.2.2 skrll */
211 1.2.2.2 skrll if (ptm == NULL)
212 1.2.2.2 skrll return EOPNOTSUPP;
213 1.2.2.2 skrll
214 1.2.2.2 skrll if ((error = (*ptm->allocvp)(ptm, l, &vp, dev, 't')) != 0)
215 1.2.2.2 skrll return error;
216 1.2.2.2 skrll
217 1.2.2.2 skrll if ((vp->v_mount->mnt_flag & MNT_RDONLY) == 0) {
218 1.2.2.2 skrll struct vattr vattr;
219 1.2.2.2 skrll struct ucred *cred;
220 1.2.2.3 skrll (*ptm->getvattr)(ptm, l->l_proc, &vattr);
221 1.2.2.2 skrll /* Get a fake cred to pretend we're root. */
222 1.2.2.2 skrll cred = crget();
223 1.2.2.2 skrll error = VOP_SETATTR(vp, &vattr, cred, l);
224 1.2.2.2 skrll crfree(cred);
225 1.2.2.2 skrll if (error) {
226 1.2.2.2 skrll DPRINTF(("setattr %d\n", error));
227 1.2.2.2 skrll VOP_UNLOCK(vp, 0);
228 1.2.2.2 skrll vrele(vp);
229 1.2.2.2 skrll return error;
230 1.2.2.2 skrll }
231 1.2.2.2 skrll }
232 1.2.2.2 skrll VOP_UNLOCK(vp, 0);
233 1.2.2.2 skrll if (vp->v_usecount > 1 ||
234 1.2.2.2 skrll (vp->v_flag & (VALIASED | VLAYER)))
235 1.2.2.2 skrll VOP_REVOKE(vp, REVOKEALL);
236 1.2.2.2 skrll
237 1.2.2.2 skrll /*
238 1.2.2.2 skrll * The vnode is useless after the revoke, we need to get it again.
239 1.2.2.2 skrll */
240 1.2.2.2 skrll vrele(vp);
241 1.2.2.2 skrll return 0;
242 1.2.2.2 skrll }
243 1.2.2.2 skrll
244 1.2.2.2 skrll static int
245 1.2.2.2 skrll pty_alloc_slave(struct lwp *l, int *fd, dev_t dev)
246 1.2.2.2 skrll {
247 1.2.2.2 skrll int error;
248 1.2.2.2 skrll struct file *fp;
249 1.2.2.2 skrll struct vnode *vp;
250 1.2.2.2 skrll struct proc *p = l->l_proc;
251 1.2.2.2 skrll
252 1.2.2.2 skrll /* Grab a filedescriptor for the slave */
253 1.2.2.2 skrll if ((error = falloc(p, &fp, fd)) != 0) {
254 1.2.2.2 skrll DPRINTF(("falloc %d\n", error));
255 1.2.2.2 skrll return error;
256 1.2.2.2 skrll }
257 1.2.2.2 skrll
258 1.2.2.2 skrll if (ptm == NULL) {
259 1.2.2.2 skrll error = EOPNOTSUPP;
260 1.2.2.2 skrll goto bad;
261 1.2.2.2 skrll }
262 1.2.2.2 skrll
263 1.2.2.2 skrll if ((error = (*ptm->allocvp)(ptm, l, &vp, dev, 't')) != 0)
264 1.2.2.2 skrll goto bad;
265 1.2.2.2 skrll if ((error = pty_vn_open(vp, l)) != 0)
266 1.2.2.2 skrll goto bad;
267 1.2.2.2 skrll
268 1.2.2.2 skrll fp->f_flag = FREAD|FWRITE;
269 1.2.2.2 skrll fp->f_type = DTYPE_VNODE;
270 1.2.2.2 skrll fp->f_ops = &vnops;
271 1.2.2.2 skrll fp->f_data = vp;
272 1.2.2.2 skrll VOP_UNLOCK(vp, 0);
273 1.2.2.2 skrll FILE_SET_MATURE(fp);
274 1.2.2.2 skrll FILE_UNUSE(fp, l);
275 1.2.2.2 skrll return 0;
276 1.2.2.2 skrll bad:
277 1.2.2.2 skrll FILE_UNUSE(fp, l);
278 1.2.2.2 skrll fdremove(p->p_fd, *fd);
279 1.2.2.2 skrll ffree(fp);
280 1.2.2.2 skrll return error;
281 1.2.2.2 skrll }
282 1.2.2.2 skrll
283 1.2.2.2 skrll struct ptm_pty *
284 1.2.2.2 skrll pty_sethandler(struct ptm_pty *nptm)
285 1.2.2.2 skrll {
286 1.2.2.2 skrll struct ptm_pty *optm = ptm;
287 1.2.2.2 skrll ptm = nptm;
288 1.2.2.2 skrll return optm;
289 1.2.2.2 skrll }
290 1.2.2.2 skrll
291 1.2.2.2 skrll int
292 1.2.2.2 skrll pty_fill_ptmget(dev_t dev, int cfd, int sfd, void *data)
293 1.2.2.2 skrll {
294 1.2.2.2 skrll struct ptmget *ptmg = data;
295 1.2.2.2 skrll int error;
296 1.2.2.2 skrll
297 1.2.2.2 skrll if (ptm == NULL)
298 1.2.2.2 skrll return EOPNOTSUPP;
299 1.2.2.2 skrll
300 1.2.2.2 skrll ptmg->cfd = cfd == -1 ? minor(dev) : cfd;
301 1.2.2.2 skrll ptmg->sfd = sfd == -1 ? minor(dev) : sfd;
302 1.2.2.2 skrll
303 1.2.2.2 skrll error = (*ptm->makename)(ptm, ptmg->cn, sizeof(ptmg->cn), dev, 'p');
304 1.2.2.2 skrll if (error)
305 1.2.2.2 skrll return error;
306 1.2.2.2 skrll
307 1.2.2.2 skrll return (*ptm->makename)(ptm, ptmg->sn, sizeof(ptmg->sn), dev, 't');
308 1.2.2.2 skrll }
309 1.2.2.2 skrll
310 1.2.2.2 skrll void
311 1.2.2.2 skrll /*ARGSUSED*/
312 1.2.2.2 skrll ptmattach(int n)
313 1.2.2.2 skrll {
314 1.2.2.2 skrll extern const struct cdevsw pts_cdevsw, ptc_cdevsw;
315 1.2.2.2 skrll /* find the major and minor of the pty devices */
316 1.2.2.2 skrll if ((pts_major = cdevsw_lookup_major(&pts_cdevsw)) == -1)
317 1.2.2.2 skrll panic("ptmattach: Can't find pty slave in cdevsw");
318 1.2.2.2 skrll if ((ptc_major = cdevsw_lookup_major(&ptc_cdevsw)) == -1)
319 1.2.2.2 skrll panic("ptmattach: Can't find pty master in cdevsw");
320 1.2.2.2 skrll #ifdef COMPAT_BSDPTY
321 1.2.2.2 skrll ptm = &ptm_bsdpty;
322 1.2.2.2 skrll #endif
323 1.2.2.2 skrll }
324 1.2.2.2 skrll
325 1.2.2.5 christos static int
326 1.2.2.2 skrll /*ARGSUSED*/
327 1.2.2.2 skrll ptmopen(dev_t dev, int flag, int mode, struct lwp *l)
328 1.2.2.2 skrll {
329 1.2.2.2 skrll int error;
330 1.2.2.2 skrll int fd;
331 1.2.2.2 skrll
332 1.2.2.2 skrll switch(minor(dev)) {
333 1.2.2.2 skrll case 0: /* /dev/ptmx */
334 1.2.2.2 skrll if ((error = pty_alloc_master(l, &fd, &dev)) != 0)
335 1.2.2.2 skrll return error;
336 1.2.2.2 skrll curlwp->l_dupfd = fd;
337 1.2.2.4 skrll return EMOVEFD;
338 1.2.2.2 skrll case 1: /* /dev/ptm */
339 1.2.2.2 skrll return 0;
340 1.2.2.2 skrll default:
341 1.2.2.2 skrll return ENODEV;
342 1.2.2.2 skrll }
343 1.2.2.2 skrll }
344 1.2.2.2 skrll
345 1.2.2.5 christos static int
346 1.2.2.2 skrll /*ARGSUSED*/
347 1.2.2.2 skrll ptmclose(dev_t dev, int flag, int mode, struct lwp *l)
348 1.2.2.2 skrll {
349 1.2.2.2 skrll return (0);
350 1.2.2.2 skrll }
351 1.2.2.2 skrll
352 1.2.2.5 christos static int
353 1.2.2.2 skrll /*ARGSUSED*/
354 1.2.2.2 skrll ptmioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct lwp *l)
355 1.2.2.2 skrll {
356 1.2.2.2 skrll int error;
357 1.2.2.2 skrll dev_t newdev;
358 1.2.2.2 skrll int cfd, sfd;
359 1.2.2.2 skrll struct file *fp;
360 1.2.2.2 skrll struct proc *p = l->l_proc;
361 1.2.2.2 skrll
362 1.2.2.2 skrll error = 0;
363 1.2.2.2 skrll switch (cmd) {
364 1.2.2.2 skrll case TIOCPTMGET:
365 1.2.2.2 skrll if ((error = pty_alloc_master(l, &cfd, &newdev)) != 0)
366 1.2.2.2 skrll return error;
367 1.2.2.2 skrll
368 1.2.2.2 skrll if ((error = pty_grant_slave(l, newdev)) != 0)
369 1.2.2.2 skrll goto bad;
370 1.2.2.2 skrll
371 1.2.2.2 skrll if ((error = pty_alloc_slave(l, &sfd, newdev)) != 0)
372 1.2.2.2 skrll goto bad;
373 1.2.2.2 skrll
374 1.2.2.2 skrll /* now, put the indices and names into struct ptmget */
375 1.2.2.2 skrll return pty_fill_ptmget(newdev, cfd, sfd, data);
376 1.2.2.2 skrll default:
377 1.2.2.2 skrll DPRINTF(("ptmioctl EINVAL\n"));
378 1.2.2.2 skrll return EINVAL;
379 1.2.2.2 skrll }
380 1.2.2.2 skrll bad:
381 1.2.2.2 skrll fp = fd_getfile(p->p_fd, cfd);
382 1.2.2.2 skrll fdremove(p->p_fd, cfd);
383 1.2.2.2 skrll ffree(fp);
384 1.2.2.2 skrll return error;
385 1.2.2.2 skrll }
386 1.2.2.5 christos
387 1.2.2.5 christos const struct cdevsw ptm_cdevsw = {
388 1.2.2.5 christos ptmopen, ptmclose, noread, nowrite, ptmioctl,
389 1.2.2.5 christos nullstop, notty, nopoll, nommap, nokqfilter, D_TTY
390 1.2.2.5 christos };
391 1.2.2.2 skrll #endif
392