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