kernel - Fix pty registration, memory leak
[dragonfly.git] / sys / sys / tty.h
CommitLineData
984263bc
MD
1/*-
2 * Copyright (c) 1982, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
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 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 * @(#)tty.h 8.6 (Berkeley) 1/21/94
39 * $FreeBSD: src/sys/sys/tty.h,v 1.53.2.1 2001/02/26 04:23:21 jlemon Exp $
b13267a5 40 * $DragonFly: src/sys/sys/tty.h,v 1.12 2006/09/10 01:26:40 dillon Exp $
984263bc
MD
41 */
42
43#ifndef _SYS_TTY_H_
44#define _SYS_TTY_H_
45
03d6a592 46#ifndef _SYS_TERMIOS_H_
984263bc 47#include <sys/termios.h>
03d6a592 48#endif
5b22f1a7
SG
49#ifndef _SYS_EVENT_H_
50#include <sys/event.h>
03d6a592 51#endif
fef8985e
MD
52#ifdef _KERNEL
53#include <sys/device.h>
54#endif
984263bc
MD
55
56/*
57 * Clists are character lists, which is a variable length linked list
58 * of cblocks, with a count of the number of characters in the list.
59 */
60struct clist {
61 int c_cc; /* Number of characters in the clist. */
62 int c_cbcount; /* Number of cblocks. */
63 int c_cbmax; /* Max # cblocks allowed for this clist. */
64 int c_cbreserved; /* # cblocks reserved for this clist. */
65 char *c_cf; /* Pointer to the first cblock. */
66 char *c_cl; /* Pointer to the last cblock. */
67};
68
03d6a592
MD
69#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
70
71#ifndef _SYS_QUEUE_H_
72#include <sys/queue.h>
73#endif
74
984263bc
MD
75/*
76 * Per-tty structure.
77 *
78 * Should be split in two, into device and tty drivers.
79 * Glue could be masks of what to echo and circular buffer
80 * (low, high, timeout).
81 */
82struct tty {
83 struct clist t_rawq; /* Device raw input queue. */
84 long t_rawcc; /* Raw input queue statistics. */
85 struct clist t_canq; /* Device canonical queue. */
86 long t_cancc; /* Canonical queue statistics. */
87 struct clist t_outq; /* Device output queue. */
88 long t_outcc; /* Output queue statistics. */
89 int t_line; /* Interface to device drivers. */
b13267a5 90 struct cdev *t_dev; /* Device. */
984263bc
MD
91 int t_state; /* Device and driver (TS*) state. */
92 int t_flags; /* Tty flags. */
93 int t_timeout; /* Timeout for ttywait() */
94 struct pgrp *t_pgrp; /* Foreground process group. */
95 struct session *t_session; /* Enclosing session. */
96 struct sigio *t_sigio; /* Information for async I/O. */
5b22f1a7
SG
97 struct kqinfo t_rkq; /* Tty read/oob kq. */
98 struct kqinfo t_wkq; /* Tty write kq. */
984263bc
MD
99 struct termios t_termios; /* Termios state. */
100 struct winsize t_winsize; /* Window size. */
101 /* Start output. */
b153f746 102 void (*t_oproc) (struct tty *);
984263bc 103 /* Stop output. */
b153f746 104 void (*t_stop) (struct tty *, int);
984263bc 105 /* Set hardware state. */
b153f746 106 int (*t_param) (struct tty *, struct termios *);
984263bc
MD
107 void *t_sc; /* XXX: net/if_sl.c:sl_softc. */
108 int t_column; /* Tty output column. */
109 int t_rocount, t_rocol; /* Tty. */
110 int t_ififosize; /* Total size of upstream fifos. */
111 int t_ihiwat; /* High water mark for input. */
112 int t_ilowat; /* Low water mark for input. */
113 speed_t t_ispeedwat; /* t_ispeed override for watermarks. */
114 int t_ohiwat; /* High water mark for output. */
115 int t_olowat; /* Low water mark for output. */
116 speed_t t_ospeedwat; /* t_ospeed override for watermarks. */
117 int t_gen; /* Generation number. */
ddac2002 118 TAILQ_ENTRY(tty) t_list; /* Global chain of ttys for pstat(8) */
984263bc
MD
119};
120
121#define t_cc t_termios.c_cc
122#define t_cflag t_termios.c_cflag
123#define t_iflag t_termios.c_iflag
124#define t_ispeed t_termios.c_ispeed
125#define t_lflag t_termios.c_lflag
126#define t_min t_termios.c_min
127#define t_oflag t_termios.c_oflag
128#define t_ospeed t_termios.c_ospeed
129#define t_time t_termios.c_time
130
03d6a592
MD
131#endif
132
984263bc
MD
133/*
134 * User data unfortunately has to be copied through buffers on the way to
135 * and from clists. The buffers are on the stack so their sizes must be
136 * fairly small.
137 */
138#define IBUFSIZ 384 /* Should be >= max value of MIN. */
139#define OBUFSIZ 100
140
141#ifndef TTYHOG
142#define TTYHOG 1024
143#endif
144
145#ifdef _KERNEL
146#define TTMAXHIWAT roundup(2048, CBSIZE)
147#define TTMINHIWAT roundup(100, CBSIZE)
148#define TTMAXLOWAT 256
149#define TTMINLOWAT 32
150#endif
151
152/* These flags are kept in t_state. */
153#define TS_SO_OLOWAT 0x00001 /* Wake up when output <= low water. */
154#define TS_ASYNC 0x00002 /* Tty in async I/O mode. */
155#define TS_BUSY 0x00004 /* Draining output. */
156#define TS_CARR_ON 0x00008 /* Carrier is present. */
157#define TS_FLUSH 0x00010 /* Outq has been flushed during DMA. */
158#define TS_ISOPEN 0x00020 /* Open has completed. */
159#define TS_TBLOCK 0x00040 /* Further input blocked. */
160#define TS_TIMEOUT 0x00080 /* Wait for output char processing. */
161#define TS_TTSTOP 0x00100 /* Output paused. */
162#ifdef notyet
163#define TS_WOPEN 0x00200 /* Open in progress. */
164#endif
165#define TS_XCLUDE 0x00400 /* Tty requires exclusivity. */
166
167/* State for intra-line fancy editing work. */
168#define TS_BKSL 0x00800 /* State for lowercase \ work. */
169#define TS_CNTTB 0x01000 /* Counting tab width, ignore FLUSHO. */
170#define TS_ERASE 0x02000 /* Within a \.../ for PRTRUB. */
171#define TS_LNCH 0x04000 /* Next character is literal. */
172#define TS_TYPEN 0x08000 /* Retyping suspended input (PENDIN). */
173#define TS_LOCAL (TS_BKSL | TS_CNTTB | TS_ERASE | TS_LNCH | TS_TYPEN)
174
175/* Extras. */
176#define TS_CAN_BYPASS_L_RINT 0x010000 /* Device in "raw" mode. */
177#define TS_CONNECTED 0x020000 /* Connection open. */
178#define TS_SNOOP 0x040000 /* Device is being snooped on. */
179#define TS_SO_OCOMPLETE 0x080000 /* Wake up when output completes. */
180#define TS_ZOMBIE 0x100000 /* Connection lost. */
181
182/* Hardware flow-control-invoked bits. */
183#define TS_CAR_OFLOW 0x200000 /* For MDMBUF (XXX handle in driver). */
184#ifdef notyet
185#define TS_CTS_OFLOW 0x400000 /* For CCTS_OFLOW. */
186#define TS_DSR_OFLOW 0x800000 /* For CDSR_OFLOW. */
187#endif
ddac2002
MD
188#define TS_REGISTERED 0x1000000 /* ttyregister sanity check */
189#define TS_MARKER 0x2000000 /* sysctl iteration marker */
984263bc
MD
190
191/* Character type information. */
192#define ORDINARY 0
193#define CONTROL 1
194#define BACKSPACE 2
195#define NEWLINE 3
196#define TAB 4
197#define VTAB 5
198#define RETURN 6
199
200struct speedtab {
201 int sp_speed; /* Speed. */
202 int sp_code; /* Code. */
203};
204
205/* Modem control commands (driver). */
206#define DMSET 0
207#define DMBIS 1
208#define DMBIC 2
209#define DMGET 3
210
211/* Flags on a character passed to ttyinput. */
212#define TTY_CHARMASK 0x000000ff /* Character mask */
213#define TTY_QUOTE 0x00000100 /* Character quoted */
214#define TTY_ERRORMASK 0xff000000 /* Error mask */
215#define TTY_FE 0x01000000 /* Framing error */
216#define TTY_PE 0x02000000 /* Parity error */
217#define TTY_OE 0x04000000 /* Overrun error */
218#define TTY_BI 0x08000000 /* Break condition */
219
220/* Is tp controlling terminal for p? */
221#define isctty(p, tp) \
222 ((p)->p_session == (tp)->t_session && (p)->p_flag & P_CONTROLT)
223
224/* Is p in background of tp? */
225#define isbackground(p, tp) \
226 (isctty((p), (tp)) && (p)->p_pgrp != (tp)->t_pgrp)
227
228/* Unique sleep addresses. */
229#define TSA_CARR_ON(tp) ((void *)&(tp)->t_rawq)
230#define TSA_HUP_OR_INPUT(tp) ((void *)&(tp)->t_rawq.c_cf)
231#define TSA_OCOMPLETE(tp) ((void *)&(tp)->t_outq.c_cl)
232#define TSA_OLOWAT(tp) ((void *)&(tp)->t_outq)
233#define TSA_PTC_READ(tp) ((void *)&(tp)->t_outq.c_cf)
234#define TSA_PTC_WRITE(tp) ((void *)&(tp)->t_rawq.c_cl)
235#define TSA_PTS_READ(tp) ((void *)&(tp)->t_canq)
236
237#ifdef _KERNEL
03d6a592
MD
238
239#ifndef _SYS_MALLOC_H_
240#include <sys/malloc.h>
984263bc 241#endif
03d6a592
MD
242
243MALLOC_DECLARE(M_TTYS);
244
984263bc
MD
245extern struct tty *constty; /* Temporary virtual console. */
246
b153f746
RG
247int b_to_q (char *cp, int cc, struct clist *q);
248void catq (struct clist *from, struct clist *to);
249void clist_alloc_cblocks (struct clist *q, int ccmax, int ccres);
250void clist_free_cblocks (struct clist *q);
0ced1954
MD
251int clist_getc (struct clist *q);
252int clist_unputc (struct clist *q);
b153f746
RG
253void ndflush (struct clist *q, int cc);
254char *nextc (struct clist *q, char *cp, int *c);
255void nottystop (struct tty *tp, int rw);
0ced1954 256int clist_putc (int c, struct clist *q);
b153f746
RG
257int q_to_b (struct clist *q, char *cp, int cc);
258void termioschars (struct termios *t);
259int tputchar (int c, struct tty *tp);
260int ttcompat (struct tty *tp, u_long com, caddr_t data, int flag);
261int ttioctl (struct tty *tp, u_long com, void *data, int flag);
262int ttread (struct tty *tp, struct uio *uio, int flag);
263void ttrstrt (void *tp);
264int ttsetcompat (struct tty *tp, u_long *com, caddr_t data,
265 struct termios *term);
266void ttsetwater (struct tty *tp);
267int ttspeedtab (int speed, struct speedtab *table);
268int ttstart (struct tty *tp);
269void ttwakeup (struct tty *tp);
270int ttwrite (struct tty *tp, struct uio *uio, int flag);
271void ttwwakeup (struct tty *tp);
272void ttyblock (struct tty *tp);
273void ttychars (struct tty *tp);
274int ttycheckoutq (struct tty *tp, int wait);
275int ttyclose (struct tty *tp);
8b90699b 276void ttyclearsession (struct tty *tp);
5fd012e0 277void ttyclosesession (struct session *, int);
b153f746 278void ttyflush (struct tty *tp, int rw);
b153f746
RG
279void ttyinfo (struct tty *tp);
280int ttyinput (int c, struct tty *tp);
281int ttylclose (struct tty *tp, int flag);
282struct tty *ttymalloc (struct tty *tp);
283int ttymodem (struct tty *tp, int flag);
b13267a5 284int ttyopen (cdev_t device, struct tty *tp);
fef8985e
MD
285int ttykqfilter (struct dev_kqfilter_args *);
286int ttyread (struct dev_read_args *);
b153f746 287void ttyregister (struct tty *tp);
ddac2002 288void ttyunregister (struct tty *tp);
b153f746
RG
289int ttysleep (struct tty *tp, void *chan, int slpflags, char *wmesg,
290 int timeout);
a32446b7 291int ttyrevoke (struct dev_revoke_args *);
b153f746 292int ttywait (struct tty *tp);
fef8985e 293int ttywrite (struct dev_write_args *);
984263bc
MD
294
295#endif /* _KERNEL */
296
297#endif /* !_SYS_TTY_H_ */