xref: /freebsd/sys/kern/tty_pts.c (revision eb6d21b4ca6d668cf89afd99eef7baeafa712197)
1 /*-
2  * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Portions of this software were developed under sponsorship from Snow
6  * B.V., the Netherlands.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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 the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 /* Add compatibility bits for FreeBSD. */
34 #define PTS_COMPAT
35 /* Add pty(4) compat bits. */
36 #define PTS_EXTERNAL
37 /* Add bits to make Linux binaries work. */
38 #define PTS_LINUX
39 
40 #include <sys/param.h>
41 #include <sys/lock.h>
42 #include <sys/condvar.h>
43 #include <sys/conf.h>
44 #include <sys/fcntl.h>
45 #include <sys/file.h>
46 #include <sys/filedesc.h>
47 #include <sys/filio.h>
48 #include <sys/kernel.h>
49 #include <sys/limits.h>
50 #include <sys/malloc.h>
51 #include <sys/poll.h>
52 #include <sys/proc.h>
53 #include <sys/resourcevar.h>
54 #include <sys/serial.h>
55 #include <sys/stat.h>
56 #include <sys/syscall.h>
57 #include <sys/syscallsubr.h>
58 #include <sys/sysctl.h>
59 #include <sys/sysent.h>
60 #include <sys/sysproto.h>
61 #include <sys/systm.h>
62 #include <sys/tty.h>
63 #include <sys/ttycom.h>
64 
65 #include <machine/stdarg.h>
66 
67 /*
68  * Our utmp(5) format is limited to 8-byte TTY line names.  This means
69  * we can at most allocate 1000 pseudo-terminals ("pts/999").  Allow
70  * users to increase this number, assuming they have manually increased
71  * UT_LINESIZE.
72  */
73 static struct unrhdr *pts_pool;
74 static unsigned int pts_maxdev = 999;
75 SYSCTL_UINT(_kern, OID_AUTO, pts_maxdev, CTLFLAG_RW, &pts_maxdev, 0,
76     "Maximum amount of pts(4) pseudo-terminals");
77 
78 static MALLOC_DEFINE(M_PTS, "pts", "pseudo tty device");
79 
80 /*
81  * Per-PTS structure.
82  *
83  * List of locks
84  * (t)	locked by tty_lock()
85  * (c)	const until freeing
86  */
87 struct pts_softc {
88 	int		pts_unit;	/* (c) Device unit number. */
89 	unsigned int	pts_flags;	/* (t) Device flags. */
90 #define	PTS_PKT		0x1	/* Packet mode. */
91 #define	PTS_FINISHED	0x2	/* Return errors on read()/write(). */
92 	char		pts_pkt;	/* (t) Unread packet mode data. */
93 
94 	struct cv	pts_inwait;	/* (t) Blocking write() on master. */
95 	struct selinfo	pts_inpoll;	/* (t) Select queue for write(). */
96 	struct cv	pts_outwait;	/* (t) Blocking read() on master. */
97 	struct selinfo	pts_outpoll;	/* (t) Select queue for read(). */
98 
99 #ifdef PTS_EXTERNAL
100 	struct cdev	*pts_cdev;	/* (c) Master device node. */
101 #endif /* PTS_EXTERNAL */
102 
103 	struct uidinfo	*pts_uidinfo;	/* (c) Resource limit. */
104 };
105 
106 /*
107  * Controller-side file operations.
108  */
109 
110 static int
111 ptsdev_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
112     int flags, struct thread *td)
113 {
114 	struct tty *tp = fp->f_data;
115 	struct pts_softc *psc = tty_softc(tp);
116 	int error = 0;
117 	char pkt;
118 
119 	if (uio->uio_resid == 0)
120 		return (0);
121 
122 	tty_lock(tp);
123 
124 	for (;;) {
125 		/*
126 		 * Implement packet mode. When packet mode is turned on,
127 		 * the first byte contains a bitmask of events that
128 		 * occured (start, stop, flush, window size, etc).
129 		 */
130 		if (psc->pts_flags & PTS_PKT && psc->pts_pkt) {
131 			pkt = psc->pts_pkt;
132 			psc->pts_pkt = 0;
133 			tty_unlock(tp);
134 
135 			error = ureadc(pkt, uio);
136 			return (error);
137 		}
138 
139 		/*
140 		 * Transmit regular data.
141 		 *
142 		 * XXX: We shouldn't use ttydisc_getc_poll()! Even
143 		 * though in this implementation, there is likely going
144 		 * to be data, we should just call ttydisc_getc_uio()
145 		 * and use its return value to sleep.
146 		 */
147 		if (ttydisc_getc_poll(tp)) {
148 			if (psc->pts_flags & PTS_PKT) {
149 				/*
150 				 * XXX: Small race. Fortunately PTY
151 				 * consumers aren't multithreaded.
152 				 */
153 
154 				tty_unlock(tp);
155 				error = ureadc(TIOCPKT_DATA, uio);
156 				if (error)
157 					return (error);
158 				tty_lock(tp);
159 			}
160 
161 			error = ttydisc_getc_uio(tp, uio);
162 			break;
163 		}
164 
165 		/* Maybe the device isn't used anyway. */
166 		if (psc->pts_flags & PTS_FINISHED)
167 			break;
168 
169 		/* Wait for more data. */
170 		if (fp->f_flag & O_NONBLOCK) {
171 			error = EWOULDBLOCK;
172 			break;
173 		}
174 		error = cv_wait_sig(&psc->pts_outwait, tp->t_mtx);
175 		if (error != 0)
176 			break;
177 	}
178 
179 	tty_unlock(tp);
180 
181 	return (error);
182 }
183 
184 static int
185 ptsdev_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
186     int flags, struct thread *td)
187 {
188 	struct tty *tp = fp->f_data;
189 	struct pts_softc *psc = tty_softc(tp);
190 	char ib[256], *ibstart;
191 	size_t iblen, rintlen;
192 	int error = 0;
193 
194 	if (uio->uio_resid == 0)
195 		return (0);
196 
197 	for (;;) {
198 		ibstart = ib;
199 		iblen = MIN(uio->uio_resid, sizeof ib);
200 		error = uiomove(ib, iblen, uio);
201 
202 		tty_lock(tp);
203 		if (error != 0) {
204 			iblen = 0;
205 			goto done;
206 		}
207 
208 		/*
209 		 * When possible, avoid the slow path. rint_bypass()
210 		 * copies all input to the input queue at once.
211 		 */
212 		MPASS(iblen > 0);
213 		do {
214 			rintlen = ttydisc_rint_simple(tp, ibstart, iblen);
215 			ibstart += rintlen;
216 			iblen -= rintlen;
217 			if (iblen == 0) {
218 				/* All data written. */
219 				break;
220 			}
221 
222 			/* Maybe the device isn't used anyway. */
223 			if (psc->pts_flags & PTS_FINISHED) {
224 				error = EIO;
225 				goto done;
226 			}
227 
228 			/* Wait for more data. */
229 			if (fp->f_flag & O_NONBLOCK) {
230 				error = EWOULDBLOCK;
231 				goto done;
232 			}
233 
234 			/* Wake up users on the slave side. */
235 			ttydisc_rint_done(tp);
236 			error = cv_wait_sig(&psc->pts_inwait, tp->t_mtx);
237 			if (error != 0)
238 				goto done;
239 		} while (iblen > 0);
240 
241 		if (uio->uio_resid == 0)
242 			break;
243 		tty_unlock(tp);
244 	}
245 
246 done:	ttydisc_rint_done(tp);
247 	tty_unlock(tp);
248 
249 	/*
250 	 * Don't account for the part of the buffer that we couldn't
251 	 * pass to the TTY.
252 	 */
253 	uio->uio_resid += iblen;
254 	return (error);
255 }
256 
257 static int
258 ptsdev_truncate(struct file *fp, off_t length, struct ucred *active_cred,
259     struct thread *td)
260 {
261 
262 	return (EINVAL);
263 }
264 
265 static int
266 ptsdev_ioctl(struct file *fp, u_long cmd, void *data,
267     struct ucred *active_cred, struct thread *td)
268 {
269 	struct tty *tp = fp->f_data;
270 	struct pts_softc *psc = tty_softc(tp);
271 	int error = 0, sig;
272 
273 	switch (cmd) {
274 	case FIONBIO:
275 		/* This device supports non-blocking operation. */
276 		return (0);
277 	case FIONREAD:
278 		tty_lock(tp);
279 		if (psc->pts_flags & PTS_FINISHED) {
280 			/* Force read() to be called. */
281 			*(int *)data = 1;
282 		} else {
283 			*(int *)data = ttydisc_getc_poll(tp);
284 		}
285 		tty_unlock(tp);
286 		return (0);
287 	case FIODGNAME: {
288 		struct fiodgname_arg *fgn;
289 		const char *p;
290 		int i;
291 
292 		/* Reverse device name lookups, for ptsname() and ttyname(). */
293 		fgn = data;
294 		p = tty_devname(tp);
295 		i = strlen(p) + 1;
296 		if (i > fgn->len)
297 			return (EINVAL);
298 		return copyout(p, fgn->buf, i);
299 	}
300 
301 	/*
302 	 * We need to implement TIOCGPGRP and TIOCGSID here again. When
303 	 * called on the pseudo-terminal master, it should not check if
304 	 * the terminal is the foreground terminal of the calling
305 	 * process.
306 	 *
307 	 * TIOCGETA is also implemented here. Various Linux PTY routines
308 	 * often call isatty(), which is implemented by tcgetattr().
309 	 */
310 #ifdef PTS_LINUX
311 	case TIOCGETA:
312 		/* Obtain terminal flags through tcgetattr(). */
313 		tty_lock(tp);
314 		*(struct termios*)data = tp->t_termios;
315 		tty_unlock(tp);
316 		return (0);
317 #endif /* PTS_LINUX */
318 	case TIOCSETAF:
319 	case TIOCSETAW:
320 		/*
321 		 * We must make sure we turn tcsetattr() calls of TCSAFLUSH and
322 		 * TCSADRAIN into something different. If an application would
323 		 * call TCSAFLUSH or TCSADRAIN on the master descriptor, it may
324 		 * deadlock waiting for all data to be read.
325 		 */
326 		cmd = TIOCSETA;
327 		break;
328 #if defined(PTS_COMPAT) || defined(PTS_LINUX)
329 	case TIOCGPTN:
330 		/*
331 		 * Get the device unit number.
332 		 */
333 		if (psc->pts_unit < 0)
334 			return (ENOTTY);
335 		*(unsigned int *)data = psc->pts_unit;
336 		return (0);
337 #endif /* PTS_COMPAT || PTS_LINUX */
338 	case TIOCGPGRP:
339 		/* Get the foreground process group ID. */
340 		tty_lock(tp);
341 		if (tp->t_pgrp != NULL)
342 			*(int *)data = tp->t_pgrp->pg_id;
343 		else
344 			*(int *)data = NO_PID;
345 		tty_unlock(tp);
346 		return (0);
347 	case TIOCGSID:
348 		/* Get the session leader process ID. */
349 		tty_lock(tp);
350 		if (tp->t_session == NULL)
351 			error = ENOTTY;
352 		else
353 			*(int *)data = tp->t_session->s_sid;
354 		tty_unlock(tp);
355 		return (error);
356 	case TIOCPTMASTER:
357 		/* Yes, we are a pseudo-terminal master. */
358 		return (0);
359 	case TIOCSIG:
360 		/* Signal the foreground process group. */
361 		sig = *(int *)data;
362 		if (sig < 1 || sig >= NSIG)
363 			return (EINVAL);
364 
365 		tty_lock(tp);
366 		tty_signal_pgrp(tp, sig);
367 		tty_unlock(tp);
368 		return (0);
369 	case TIOCPKT:
370 		/* Enable/disable packet mode. */
371 		tty_lock(tp);
372 		if (*(int *)data)
373 			psc->pts_flags |= PTS_PKT;
374 		else
375 			psc->pts_flags &= ~PTS_PKT;
376 		tty_unlock(tp);
377 		return (0);
378 	}
379 
380 	/* Just redirect this ioctl to the slave device. */
381 	tty_lock(tp);
382 	error = tty_ioctl(tp, cmd, data, td);
383 	tty_unlock(tp);
384 	if (error == ENOIOCTL)
385 		error = ENOTTY;
386 
387 	return (error);
388 }
389 
390 static int
391 ptsdev_poll(struct file *fp, int events, struct ucred *active_cred,
392     struct thread *td)
393 {
394 	struct tty *tp = fp->f_data;
395 	struct pts_softc *psc = tty_softc(tp);
396 	int revents = 0;
397 
398 	tty_lock(tp);
399 
400 	if (psc->pts_flags & PTS_FINISHED) {
401 		/* Slave device is not opened. */
402 		tty_unlock(tp);
403 		return ((events & (POLLIN|POLLRDNORM)) | POLLHUP);
404 	}
405 
406 	if (events & (POLLIN|POLLRDNORM)) {
407 		/* See if we can getc something. */
408 		if (ttydisc_getc_poll(tp) ||
409 		    (psc->pts_flags & PTS_PKT && psc->pts_pkt))
410 			revents |= events & (POLLIN|POLLRDNORM);
411 	}
412 	if (events & (POLLOUT|POLLWRNORM)) {
413 		/* See if we can rint something. */
414 		if (ttydisc_rint_poll(tp))
415 			revents |= events & (POLLOUT|POLLWRNORM);
416 	}
417 
418 	/*
419 	 * No need to check for POLLHUP here. This device cannot be used
420 	 * as a callout device, which means we always have a carrier,
421 	 * because the master is.
422 	 */
423 
424 	if (revents == 0) {
425 		/*
426 		 * This code might look misleading, but the naming of
427 		 * poll events on this side is the opposite of the slave
428 		 * device.
429 		 */
430 		if (events & (POLLIN|POLLRDNORM))
431 			selrecord(td, &psc->pts_outpoll);
432 		if (events & (POLLOUT|POLLWRNORM))
433 			selrecord(td, &psc->pts_inpoll);
434 	}
435 
436 	tty_unlock(tp);
437 
438 	return (revents);
439 }
440 
441 /*
442  * kqueue support.
443  */
444 
445 static void
446 pts_kqops_read_detach(struct knote *kn)
447 {
448 	struct file *fp = kn->kn_fp;
449 	struct tty *tp = fp->f_data;
450 	struct pts_softc *psc = tty_softc(tp);
451 
452 	knlist_remove(&psc->pts_outpoll.si_note, kn, 0);
453 }
454 
455 static int
456 pts_kqops_read_event(struct knote *kn, long hint)
457 {
458 	struct file *fp = kn->kn_fp;
459 	struct tty *tp = fp->f_data;
460 	struct pts_softc *psc = tty_softc(tp);
461 
462 	if (psc->pts_flags & PTS_FINISHED) {
463 		kn->kn_flags |= EV_EOF;
464 		return (1);
465 	} else {
466 		kn->kn_data = ttydisc_getc_poll(tp);
467 		return (kn->kn_data > 0);
468 	}
469 }
470 
471 static void
472 pts_kqops_write_detach(struct knote *kn)
473 {
474 	struct file *fp = kn->kn_fp;
475 	struct tty *tp = fp->f_data;
476 	struct pts_softc *psc = tty_softc(tp);
477 
478 	knlist_remove(&psc->pts_inpoll.si_note, kn, 0);
479 }
480 
481 static int
482 pts_kqops_write_event(struct knote *kn, long hint)
483 {
484 	struct file *fp = kn->kn_fp;
485 	struct tty *tp = fp->f_data;
486 	struct pts_softc *psc = tty_softc(tp);
487 
488 	if (psc->pts_flags & PTS_FINISHED) {
489 		kn->kn_flags |= EV_EOF;
490 		return (1);
491 	} else {
492 		kn->kn_data = ttydisc_rint_poll(tp);
493 		return (kn->kn_data > 0);
494 	}
495 }
496 
497 static struct filterops pts_kqops_read = {
498 	.f_isfd = 1,
499 	.f_detach = pts_kqops_read_detach,
500 	.f_event = pts_kqops_read_event,
501 };
502 static struct filterops pts_kqops_write = {
503 	.f_isfd = 1,
504 	.f_detach = pts_kqops_write_detach,
505 	.f_event = pts_kqops_write_event,
506 };
507 
508 static int
509 ptsdev_kqfilter(struct file *fp, struct knote *kn)
510 {
511 	struct tty *tp = fp->f_data;
512 	struct pts_softc *psc = tty_softc(tp);
513 	int error = 0;
514 
515 	tty_lock(tp);
516 
517 	switch (kn->kn_filter) {
518 	case EVFILT_READ:
519 		kn->kn_fop = &pts_kqops_read;
520 		knlist_add(&psc->pts_outpoll.si_note, kn, 1);
521 		break;
522 	case EVFILT_WRITE:
523 		kn->kn_fop = &pts_kqops_write;
524 		knlist_add(&psc->pts_inpoll.si_note, kn, 1);
525 		break;
526 	default:
527 		error = EINVAL;
528 		break;
529 	}
530 
531 	tty_unlock(tp);
532 	return (error);
533 }
534 
535 static int
536 ptsdev_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
537     struct thread *td)
538 {
539 	struct tty *tp = fp->f_data;
540 #ifdef PTS_EXTERNAL
541 	struct pts_softc *psc = tty_softc(tp);
542 #endif /* PTS_EXTERNAL */
543 	struct cdev *dev = tp->t_dev;
544 
545 	/*
546 	 * According to POSIX, we must implement an fstat(). This also
547 	 * makes this implementation compatible with Linux binaries,
548 	 * because Linux calls fstat() on the pseudo-terminal master to
549 	 * obtain st_rdev.
550 	 *
551 	 * XXX: POSIX also mentions we must fill in st_dev, but how?
552 	 */
553 
554 	bzero(sb, sizeof *sb);
555 #ifdef PTS_EXTERNAL
556 	if (psc->pts_cdev != NULL)
557 		sb->st_ino = sb->st_rdev = dev2udev(psc->pts_cdev);
558 	else
559 #endif /* PTS_EXTERNAL */
560 		sb->st_ino = sb->st_rdev = tty_udev(tp);
561 
562 	sb->st_atimespec = dev->si_atime;
563 	sb->st_ctimespec = dev->si_ctime;
564 	sb->st_mtimespec = dev->si_mtime;
565 	sb->st_uid = dev->si_uid;
566 	sb->st_gid = dev->si_gid;
567 	sb->st_mode = dev->si_mode | S_IFCHR;
568 
569 	return (0);
570 }
571 
572 static int
573 ptsdev_close(struct file *fp, struct thread *td)
574 {
575 	struct tty *tp = fp->f_data;
576 
577 	/* Deallocate TTY device. */
578 	tty_lock(tp);
579 	tty_rel_gone(tp);
580 
581 	return (0);
582 }
583 
584 static struct fileops ptsdev_ops = {
585 	.fo_read	= ptsdev_read,
586 	.fo_write	= ptsdev_write,
587 	.fo_truncate	= ptsdev_truncate,
588 	.fo_ioctl	= ptsdev_ioctl,
589 	.fo_poll	= ptsdev_poll,
590 	.fo_kqfilter	= ptsdev_kqfilter,
591 	.fo_stat	= ptsdev_stat,
592 	.fo_close	= ptsdev_close,
593 	.fo_flags	= DFLAG_PASSABLE,
594 };
595 
596 /*
597  * Driver-side hooks.
598  */
599 
600 static void
601 ptsdrv_outwakeup(struct tty *tp)
602 {
603 	struct pts_softc *psc = tty_softc(tp);
604 
605 	cv_broadcast(&psc->pts_outwait);
606 	selwakeup(&psc->pts_outpoll);
607 	KNOTE_LOCKED(&psc->pts_outpoll.si_note, 0);
608 }
609 
610 static void
611 ptsdrv_inwakeup(struct tty *tp)
612 {
613 	struct pts_softc *psc = tty_softc(tp);
614 
615 	cv_broadcast(&psc->pts_inwait);
616 	selwakeup(&psc->pts_inpoll);
617 	KNOTE_LOCKED(&psc->pts_inpoll.si_note, 0);
618 }
619 
620 static int
621 ptsdrv_open(struct tty *tp)
622 {
623 	struct pts_softc *psc = tty_softc(tp);
624 
625 	psc->pts_flags &= ~PTS_FINISHED;
626 
627 	return (0);
628 }
629 
630 static void
631 ptsdrv_close(struct tty *tp)
632 {
633 	struct pts_softc *psc = tty_softc(tp);
634 
635 	/* Wake up any blocked readers/writers. */
636 	psc->pts_flags |= PTS_FINISHED;
637 	ptsdrv_outwakeup(tp);
638 	ptsdrv_inwakeup(tp);
639 }
640 
641 static void
642 ptsdrv_pktnotify(struct tty *tp, char event)
643 {
644 	struct pts_softc *psc = tty_softc(tp);
645 
646 	/*
647 	 * Clear conflicting flags.
648 	 */
649 
650 	switch (event) {
651 	case TIOCPKT_STOP:
652 		psc->pts_pkt &= ~TIOCPKT_START;
653 		break;
654 	case TIOCPKT_START:
655 		psc->pts_pkt &= ~TIOCPKT_STOP;
656 		break;
657 	case TIOCPKT_NOSTOP:
658 		psc->pts_pkt &= ~TIOCPKT_DOSTOP;
659 		break;
660 	case TIOCPKT_DOSTOP:
661 		psc->pts_pkt &= ~TIOCPKT_NOSTOP;
662 		break;
663 	}
664 
665 	psc->pts_pkt |= event;
666 	ptsdrv_outwakeup(tp);
667 }
668 
669 static void
670 ptsdrv_free(void *softc)
671 {
672 	struct pts_softc *psc = softc;
673 
674 	/* Make device number available again. */
675 	if (psc->pts_unit >= 0)
676 		free_unr(pts_pool, psc->pts_unit);
677 
678 	chgptscnt(psc->pts_uidinfo, -1, 0);
679 	uifree(psc->pts_uidinfo);
680 
681 	knlist_destroy(&psc->pts_inpoll.si_note);
682 	knlist_destroy(&psc->pts_outpoll.si_note);
683 
684 #ifdef PTS_EXTERNAL
685 	/* Destroy master device as well. */
686 	if (psc->pts_cdev != NULL)
687 		destroy_dev_sched(psc->pts_cdev);
688 #endif /* PTS_EXTERNAL */
689 
690 	free(psc, M_PTS);
691 }
692 
693 static struct ttydevsw pts_class = {
694 	.tsw_flags	= TF_NOPREFIX,
695 	.tsw_outwakeup	= ptsdrv_outwakeup,
696 	.tsw_inwakeup	= ptsdrv_inwakeup,
697 	.tsw_open	= ptsdrv_open,
698 	.tsw_close	= ptsdrv_close,
699 	.tsw_pktnotify	= ptsdrv_pktnotify,
700 	.tsw_free	= ptsdrv_free,
701 };
702 
703 #ifndef PTS_EXTERNAL
704 static
705 #endif /* !PTS_EXTERNAL */
706 int
707 pts_alloc(int fflags, struct thread *td, struct file *fp)
708 {
709 	int unit, ok;
710 	struct tty *tp;
711 	struct pts_softc *psc;
712 	struct proc *p = td->td_proc;
713 	struct uidinfo *uid = td->td_ucred->cr_ruidinfo;
714 
715 	/* Resource limiting. */
716 	PROC_LOCK(p);
717 	ok = chgptscnt(uid, 1, lim_cur(p, RLIMIT_NPTS));
718 	PROC_UNLOCK(p);
719 	if (!ok)
720 		return (EAGAIN);
721 
722 	/* Try to allocate a new pts unit number. */
723 	unit = alloc_unr(pts_pool);
724 	if (unit < 0) {
725 		chgptscnt(uid, -1, 0);
726 		return (EAGAIN);
727 	}
728 	if (unit > pts_maxdev) {
729 		free_unr(pts_pool, unit);
730 		chgptscnt(uid, -1, 0);
731 		return (EAGAIN);
732 	}
733 
734 	/* Allocate TTY and softc. */
735 	psc = malloc(sizeof(struct pts_softc), M_PTS, M_WAITOK|M_ZERO);
736 	cv_init(&psc->pts_inwait, "pts inwait");
737 	cv_init(&psc->pts_outwait, "pts outwait");
738 
739 	psc->pts_unit = unit;
740 	psc->pts_uidinfo = uid;
741 	uihold(uid);
742 
743 	tp = tty_alloc(&pts_class, psc);
744 	knlist_init_mtx(&psc->pts_inpoll.si_note, tp->t_mtx);
745 	knlist_init_mtx(&psc->pts_outpoll.si_note, tp->t_mtx);
746 
747 	/* Expose the slave device as well. */
748 	tty_makedev(tp, td->td_ucred, "pts/%u", psc->pts_unit);
749 
750 	finit(fp, fflags, DTYPE_PTS, tp, &ptsdev_ops);
751 
752 	return (0);
753 }
754 
755 #ifdef PTS_EXTERNAL
756 int
757 pts_alloc_external(int fflags, struct thread *td, struct file *fp,
758     struct cdev *dev, const char *name)
759 {
760 	int ok;
761 	struct tty *tp;
762 	struct pts_softc *psc;
763 	struct proc *p = td->td_proc;
764 	struct uidinfo *uid = td->td_ucred->cr_ruidinfo;
765 
766 	/* Resource limiting. */
767 	PROC_LOCK(p);
768 	ok = chgptscnt(uid, 1, lim_cur(p, RLIMIT_NPTS));
769 	PROC_UNLOCK(p);
770 	if (!ok)
771 		return (EAGAIN);
772 
773 	/* Allocate TTY and softc. */
774 	psc = malloc(sizeof(struct pts_softc), M_PTS, M_WAITOK|M_ZERO);
775 	cv_init(&psc->pts_inwait, "pts inwait");
776 	cv_init(&psc->pts_outwait, "pts outwait");
777 
778 	psc->pts_unit = -1;
779 	psc->pts_cdev = dev;
780 	psc->pts_uidinfo = uid;
781 	uihold(uid);
782 
783 	tp = tty_alloc(&pts_class, psc);
784 	knlist_init_mtx(&psc->pts_inpoll.si_note, tp->t_mtx);
785 	knlist_init_mtx(&psc->pts_outpoll.si_note, tp->t_mtx);
786 
787 	/* Expose the slave device as well. */
788 	tty_makedev(tp, td->td_ucred, "%s", name);
789 
790 	finit(fp, fflags, DTYPE_PTS, tp, &ptsdev_ops);
791 
792 	return (0);
793 }
794 #endif /* PTS_EXTERNAL */
795 
796 int
797 posix_openpt(struct thread *td, struct posix_openpt_args *uap)
798 {
799 	int error, fd;
800 	struct file *fp;
801 
802 	/*
803 	 * POSIX states it's unspecified when other flags are passed. We
804 	 * don't allow this.
805 	 */
806 	if (uap->flags & ~(O_RDWR|O_NOCTTY))
807 		return (EINVAL);
808 
809 	error = falloc(td, &fp, &fd);
810 	if (error)
811 		return (error);
812 
813 	/* Allocate the actual pseudo-TTY. */
814 	error = pts_alloc(FFLAGS(uap->flags & O_ACCMODE), td, fp);
815 	if (error != 0) {
816 		fdclose(td->td_proc->p_fd, fp, fd, td);
817 		return (error);
818 	}
819 
820 	/* Pass it back to userspace. */
821 	td->td_retval[0] = fd;
822 	fdrop(fp, td);
823 
824 	return (0);
825 }
826 
827 static void
828 pts_init(void *unused)
829 {
830 
831 	pts_pool = new_unrhdr(0, INT_MAX, NULL);
832 }
833 
834 SYSINIT(pts, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, pts_init, NULL);
835