mirror of
https://github.com/opnsense/src.git
synced 2026-03-11 02:31:16 -04:00
f6dd5c15fd
- Change the ddb(4) commands to be more useful (by thompsa@):
- `show ttys' is now called `show all ttys'. This command will now
also display the address where the TTY data structure resides.
- Add `show tty <addr>', which dumps the TTY in a readable form.
- Place an upper bound on the TTY buffer sizes. Some drivers do not want
to care about baud rates. Protect these drivers by preventing the TTY
buffers from getting enormous. Right now we'll just clamp it to 64K,
which is pretty high, taking into account that these buffers are only
used by the built-in discipline.
- Only call ttydev_leave() when needed. Back in April/May the TTY
reference counting mechanism was a little different, which required us
to call ttydev_leave() each time we finished a cdev operation.
Nowadays we only need to call ttydev_leave() when we really mark it as
being closed.
- Improve return codes of read() and write() on TTY device nodes.
- Make sure we really wake up all blocked threads when the driver calls
tty_rel_gone(). There were some possible code paths where we didn't
properly wake up any readers/writers.
- Add extra assertions to prevent sleeping on a TTY that has been
abandoned by the driver.
- Use ttydev_cdevsw as a more reliable method to figure out whether a
device node is a real TTY device node.
Obtained from: //depot/projects/mpsafetty/...
Reviewed by: thompsa
205 lines
7.6 KiB
C
205 lines
7.6 KiB
C
/*-
|
|
* Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
|
|
* All rights reserved.
|
|
*
|
|
* Portions of this software were developed under sponsorship from Snow
|
|
* B.V., the Netherlands.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _SYS_TTY_H_
|
|
#define _SYS_TTY_H_
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/queue.h>
|
|
#include <sys/lock.h>
|
|
#include <sys/mutex.h>
|
|
#include <sys/condvar.h>
|
|
#include <sys/selinfo.h>
|
|
#include <sys/termios.h>
|
|
#include <sys/ttycom.h>
|
|
#include <sys/ttyqueue.h>
|
|
|
|
struct cdev;
|
|
struct file;
|
|
struct pgrp;
|
|
struct session;
|
|
struct ucred;
|
|
|
|
struct ttydevsw;
|
|
|
|
/*
|
|
* Per-TTY structure, containing buffers, etc.
|
|
*
|
|
* List of locks
|
|
* (t) locked by t_mtx
|
|
* (l) locked by tty_list_sx
|
|
* (c) const until freeing
|
|
*/
|
|
struct tty {
|
|
struct mtx *t_mtx; /* TTY lock. */
|
|
struct mtx t_mtxobj; /* Per-TTY lock (when not borrowing). */
|
|
TAILQ_ENTRY(tty) t_list; /* (l) TTY list entry. */
|
|
unsigned int t_flags; /* (t) Terminal option flags. */
|
|
/* Keep flags in sync with db_show_tty and pstat(8). */
|
|
#define TF_NOPREFIX 0x0001 /* Don't prepend "tty" to device name. */
|
|
#define TF_INITLOCK 0x0002 /* Create init/lock state devices. */
|
|
#define TF_CALLOUT 0x0004 /* Create "cua" devices. */
|
|
#define TF_OPENED_IN 0x0008 /* "tty" node is in use. */
|
|
#define TF_OPENED_OUT 0x0010 /* "cua" node is in use. */
|
|
#define TF_OPENED (TF_OPENED_IN|TF_OPENED_OUT)
|
|
#define TF_GONE 0x0020 /* Device node is gone. */
|
|
#define TF_OPENCLOSE 0x0040 /* Device is in open()/close(). */
|
|
#define TF_ASYNC 0x0080 /* Asynchronous I/O enabled. */
|
|
#define TF_LITERAL 0x0100 /* Accept the next character literally. */
|
|
#define TF_HIWAT_IN 0x0200 /* We've reached the input watermark. */
|
|
#define TF_HIWAT_OUT 0x0400 /* We've reached the output watermark. */
|
|
#define TF_HIWAT (TF_HIWAT_IN|TF_HIWAT_OUT)
|
|
#define TF_STOPPED 0x0800 /* Output flow control - stopped. */
|
|
#define TF_EXCLUDE 0x1000 /* Exclusive access. */
|
|
#define TF_BYPASS 0x2000 /* Optimized input path. */
|
|
#define TF_ZOMBIE 0x4000 /* Modem disconnect received. */
|
|
#define TF_HOOK 0x8000 /* TTY has hook attached. */
|
|
unsigned int t_revokecnt; /* (t) revoke() count. */
|
|
|
|
/* Buffering mechanisms. */
|
|
struct ttyinq t_inq; /* (t) Input queue. */
|
|
size_t t_inlow; /* (t) Input low watermark. */
|
|
struct ttyoutq t_outq; /* (t) Output queue. */
|
|
size_t t_outlow; /* (t) Output low watermark. */
|
|
|
|
/* Sleeping mechanisms. */
|
|
struct cv t_inwait; /* (t) Input wait queue. */
|
|
struct cv t_outwait; /* (t) Output wait queue. */
|
|
struct cv t_bgwait; /* (t) Background wait queue. */
|
|
struct cv t_dcdwait; /* (t) Carrier Detect wait queue. */
|
|
|
|
/* Polling mechanisms. */
|
|
struct selinfo t_inpoll; /* (t) Input poll queue. */
|
|
struct selinfo t_outpoll; /* (t) Output poll queue. */
|
|
struct sigio *t_sigio; /* (t) Asynchronous I/O. */
|
|
|
|
struct termios t_termios; /* (t) I/O processing flags. */
|
|
struct winsize t_winsize; /* (t) Window size. */
|
|
unsigned int t_column; /* (t) Current cursor position. */
|
|
unsigned int t_writepos; /* (t) Where input was interrupted. */
|
|
int t_compatflags; /* (t) COMPAT_43TTY flags. */
|
|
|
|
/* Init/lock-state devices. */
|
|
struct termios t_termios_init_in; /* tty%s.init. */
|
|
struct termios t_termios_lock_in; /* tty%s.lock. */
|
|
struct termios t_termios_init_out; /* cua%s.init. */
|
|
struct termios t_termios_lock_out; /* cua%s.lock. */
|
|
|
|
struct ttydevsw *t_devsw; /* (c) Driver hooks. */
|
|
struct ttyhook *t_hook; /* (t) Capture/inject hook. */
|
|
|
|
/* Process signal delivery. */
|
|
struct pgrp *t_pgrp; /* (t) Foreground process group. */
|
|
struct session *t_session; /* (t) Associated session. */
|
|
unsigned int t_sessioncnt; /* (t) Backpointing sessions. */
|
|
|
|
void *t_devswsoftc; /* (c) Soft config, for drivers. */
|
|
void *t_hooksoftc; /* (t) Soft config, for hooks. */
|
|
struct cdev *t_dev; /* (c) Primary character device. */
|
|
};
|
|
|
|
/*
|
|
* Userland version of struct tty, for sysctl kern.ttys
|
|
*/
|
|
struct xtty {
|
|
size_t xt_size; /* Structure size. */
|
|
size_t xt_insize; /* Input queue size. */
|
|
size_t xt_incc; /* Canonicalized characters. */
|
|
size_t xt_inlc; /* Input line charaters. */
|
|
size_t xt_inlow; /* Input low watermark. */
|
|
size_t xt_outsize; /* Output queue size. */
|
|
size_t xt_outcc; /* Output queue usage. */
|
|
size_t xt_outlow; /* Output low watermark. */
|
|
unsigned int xt_column; /* Current column position. */
|
|
pid_t xt_pgid; /* Foreground process group. */
|
|
pid_t xt_sid; /* Session. */
|
|
unsigned int xt_flags; /* Terminal option flags. */
|
|
dev_t xt_dev; /* Userland device. */
|
|
};
|
|
|
|
#ifdef _KERNEL
|
|
|
|
/* Allocation and deallocation. */
|
|
struct tty *tty_alloc(struct ttydevsw *tsw, void *softc, struct mtx *mtx);
|
|
void tty_rel_pgrp(struct tty *tp, struct pgrp *pgrp);
|
|
void tty_rel_sess(struct tty *tp, struct session *sess);
|
|
void tty_rel_gone(struct tty *tp);
|
|
|
|
#define tty_lock(tp) mtx_lock((tp)->t_mtx)
|
|
#define tty_unlock(tp) mtx_unlock((tp)->t_mtx)
|
|
#define tty_lock_assert(tp,ma) mtx_assert((tp)->t_mtx, (ma))
|
|
#define tty_getlock(tp) ((tp)->t_mtx)
|
|
|
|
/* Device node creation. */
|
|
void tty_makedev(struct tty *tp, struct ucred *cred, const char *fmt, ...)
|
|
__printflike(3, 4);
|
|
#define tty_makealias(tp,fmt,...) \
|
|
make_dev_alias((tp)->t_dev, fmt, ## __VA_ARGS__)
|
|
|
|
/* Signalling processes. */
|
|
void tty_signal_sessleader(struct tty *tp, int signal);
|
|
void tty_signal_pgrp(struct tty *tp, int signal);
|
|
/* Waking up readers/writers. */
|
|
int tty_wait(struct tty *tp, struct cv *cv);
|
|
int tty_timedwait(struct tty *tp, struct cv *cv, int timo);
|
|
void tty_wakeup(struct tty *tp, int flags);
|
|
|
|
/* System messages. */
|
|
int tty_checkoutq(struct tty *tp);
|
|
int tty_putchar(struct tty *tp, char c);
|
|
|
|
int tty_ioctl(struct tty *tp, u_long cmd, void *data, struct thread *td);
|
|
int tty_ioctl_compat(struct tty *tp, u_long cmd, caddr_t data,
|
|
struct thread *td);
|
|
void tty_init_console(struct tty *tp, speed_t speed);
|
|
void tty_flush(struct tty *tp, int flags);
|
|
void tty_hiwat_in_block(struct tty *tp);
|
|
void tty_hiwat_in_unblock(struct tty *tp);
|
|
dev_t tty_udev(struct tty *tp);
|
|
#define tty_opened(tp) ((tp)->t_flags & TF_OPENED)
|
|
#define tty_gone(tp) ((tp)->t_flags & TF_GONE)
|
|
#define tty_softc(tp) ((tp)->t_devswsoftc)
|
|
#define tty_devname(tp) devtoname((tp)->t_dev)
|
|
|
|
/* Status line printing. */
|
|
void tty_info(struct tty *tp);
|
|
|
|
/* Pseudo-terminal hooks. */
|
|
int pts_alloc_external(int fd, struct thread *td, struct file *fp,
|
|
struct cdev *dev, const char *name);
|
|
|
|
/* Drivers and line disciplines also need to call these. */
|
|
#include <sys/ttydisc.h>
|
|
#include <sys/ttydevsw.h>
|
|
#include <sys/ttyhook.h>
|
|
#endif /* _KERNEL */
|
|
|
|
#endif /* !_SYS_TTY_H_ */
|