2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
7 * Portions of this software were developed under sponsorship from Snow
8 * B.V., the Netherlands.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
32 #include <sys/cdefs.h>
33 #include <sys/param.h>
34 #include <sys/kernel.h>
36 #include <sys/queue.h>
37 #include <sys/sysctl.h>
38 #include <sys/systm.h>
45 * TTY input queue buffering.
47 * Unlike the output queue, the input queue has more features that are
48 * needed to properly implement various features offered by the TTY
51 * - Data can be removed from the tail of the queue, which is used to
52 * implement backspace.
53 * - Once in a while, input has to be `canonicalized'. When ICANON is
54 * turned on, this will be done after a CR has been inserted.
55 * Otherwise, it should be done after any character has been inserted.
56 * - The input queue can store one bit per byte, called the quoting bit.
57 * This bit is used by TTYDISC to make backspace work on quoted
60 * In most cases, there is probably less input than output, so unlike
61 * the outq, we'll stick to 128 byte blocks here.
64 static int ttyinq_flush_secure = 1;
65 SYSCTL_INT(_kern, OID_AUTO, tty_inq_flush_secure, CTLFLAG_RW,
66 &ttyinq_flush_secure, 0, "Zero buffers while flushing");
68 #define TTYINQ_QUOTESIZE (TTYINQ_DATASIZE / BMSIZE)
70 #define GETBIT(tib,boff) \
71 ((tib)->tib_quotes[(boff) / BMSIZE] & (1 << ((boff) % BMSIZE)))
72 #define SETBIT(tib,boff) \
73 ((tib)->tib_quotes[(boff) / BMSIZE] |= (1 << ((boff) % BMSIZE)))
74 #define CLRBIT(tib,boff) \
75 ((tib)->tib_quotes[(boff) / BMSIZE] &= ~(1 << ((boff) % BMSIZE)))
78 struct ttyinq_block *tib_prev;
79 struct ttyinq_block *tib_next;
80 uint32_t tib_quotes[TTYINQ_QUOTESIZE];
81 char tib_data[TTYINQ_DATASIZE];
84 static uma_zone_t ttyinq_zone;
86 #define TTYINQ_INSERT_TAIL(ti, tib) do { \
87 if (ti->ti_end == 0) { \
88 tib->tib_prev = NULL; \
89 tib->tib_next = ti->ti_firstblock; \
90 ti->ti_firstblock = tib; \
92 tib->tib_prev = ti->ti_lastblock; \
93 tib->tib_next = ti->ti_lastblock->tib_next; \
94 ti->ti_lastblock->tib_next = tib; \
96 if (tib->tib_next != NULL) \
97 tib->tib_next->tib_prev = tib; \
101 #define TTYINQ_REMOVE_HEAD(ti) do { \
102 ti->ti_firstblock = ti->ti_firstblock->tib_next; \
103 if (ti->ti_firstblock != NULL) \
104 ti->ti_firstblock->tib_prev = NULL; \
108 #define TTYINQ_RECYCLE(ti, tib) do { \
109 if (ti->ti_quota <= ti->ti_nblocks) \
110 uma_zfree(ttyinq_zone, tib); \
112 TTYINQ_INSERT_TAIL(ti, tib); \
116 ttyinq_setsize(struct ttyinq *ti, struct tty *tp, size_t size)
118 struct ttyinq_block *tib;
120 ti->ti_quota = howmany(size, TTYINQ_DATASIZE);
122 while (ti->ti_quota > ti->ti_nblocks) {
124 * List is getting bigger.
125 * Add new blocks to the tail of the list.
127 * We must unlock the TTY temporarily, because we need
128 * to allocate memory. This won't be a problem, because
129 * in the worst case, another thread ends up here, which
130 * may cause us to allocate too many blocks, but this
131 * will be caught by the loop below.
134 tib = uma_zalloc(ttyinq_zone, M_WAITOK);
138 uma_zfree(ttyinq_zone, tib);
142 TTYINQ_INSERT_TAIL(ti, tib);
148 ttyinq_free(struct ttyinq *ti)
150 struct ttyinq_block *tib;
155 while ((tib = ti->ti_firstblock) != NULL) {
156 TTYINQ_REMOVE_HEAD(ti);
157 uma_zfree(ttyinq_zone, tib);
160 MPASS(ti->ti_nblocks == 0);
164 ttyinq_read_uio(struct ttyinq *ti, struct tty *tp, struct uio *uio,
165 size_t rlen, size_t flen)
168 MPASS(rlen <= uio->uio_resid);
172 struct ttyinq_block *tib;
173 size_t cbegin, cend, clen;
175 /* See if there still is data. */
176 if (ti->ti_begin == ti->ti_linestart)
178 tib = ti->ti_firstblock;
183 * The end address should be the lowest of these three:
184 * - The write pointer
185 * - The blocksize - we can't read beyond the block
186 * - The end address if we could perform the full read
188 cbegin = ti->ti_begin;
189 cend = MIN(MIN(ti->ti_linestart, ti->ti_begin + rlen),
191 clen = cend - cbegin;
196 * We can prevent buffering in some cases:
197 * - We need to read the block until the end.
198 * - We don't need to read the block until the end, but
199 * there is no data beyond it, which allows us to move
200 * the write pointer to a new block.
202 if (cend == TTYINQ_DATASIZE || cend == ti->ti_end) {
204 * Fast path: zero copy. Remove the first block,
205 * so we can unlock the TTY temporarily.
207 TTYINQ_REMOVE_HEAD(ti);
211 * Because we remove the first block, we must
212 * fix up the block offsets.
214 #define CORRECT_BLOCK(t) do { \
215 if (t <= TTYINQ_DATASIZE) \
218 t -= TTYINQ_DATASIZE; \
220 CORRECT_BLOCK(ti->ti_linestart);
221 CORRECT_BLOCK(ti->ti_reprint);
222 CORRECT_BLOCK(ti->ti_end);
226 * Temporary unlock and copy the data to
227 * userspace. We may need to flush trailing
228 * bytes, like EOF characters.
231 error = uiomove(tib->tib_data + cbegin,
235 /* Block can now be readded to the list. */
236 TTYINQ_RECYCLE(ti, tib);
238 char ob[TTYINQ_DATASIZE - 1];
241 * Slow path: store data in a temporary buffer.
243 memcpy(ob, tib->tib_data + cbegin, clen - flen);
244 ti->ti_begin += clen;
245 MPASS(ti->ti_begin < TTYINQ_DATASIZE);
247 /* Temporary unlock and copy the data to userspace. */
249 error = uiomove(ob, clen - flen, uio);
263 ttyinq_set_quotes(struct ttyinq_block *tib, size_t offset,
264 size_t length, int value)
269 for (; length > 0; length--, offset++)
272 /* Unset the bits. */
273 for (; length > 0; length--, offset++)
279 ttyinq_write(struct ttyinq *ti, const void *buf, size_t nbytes, int quote)
281 const char *cbuf = buf;
282 struct ttyinq_block *tib;
287 boff = ti->ti_end % TTYINQ_DATASIZE;
289 if (ti->ti_end == 0) {
290 /* First time we're being used or drained. */
291 MPASS(ti->ti_begin == 0);
292 tib = ti->ti_firstblock;
294 /* Queue has no blocks. */
297 ti->ti_lastblock = tib;
298 } else if (boff == 0) {
299 /* We reached the end of this block on last write. */
300 tib = ti->ti_lastblock->tib_next;
302 /* We've reached the watermark. */
305 ti->ti_lastblock = tib;
307 tib = ti->ti_lastblock;
310 /* Don't copy more than was requested. */
311 l = MIN(nbytes, TTYINQ_DATASIZE - boff);
313 memcpy(tib->tib_data + boff, cbuf, l);
315 /* Set the quoting bits for the proper region. */
316 ttyinq_set_quotes(tib, boff, l, quote);
323 return (cbuf - (const char *)buf);
327 ttyinq_write_nofrag(struct ttyinq *ti, const void *buf, size_t nbytes, int quote)
331 if (ttyinq_bytesleft(ti) < nbytes)
334 /* We should always be able to write it back. */
335 ret = ttyinq_write(ti, buf, nbytes, quote);
336 MPASS(ret == nbytes);
342 ttyinq_canonicalize(struct ttyinq *ti)
345 ti->ti_linestart = ti->ti_reprint = ti->ti_end;
346 ti->ti_startblock = ti->ti_reprintblock = ti->ti_lastblock;
350 ttyinq_findchar(struct ttyinq *ti, const char *breakc, size_t maxlen,
353 struct ttyinq_block *tib = ti->ti_firstblock;
354 unsigned int boff = ti->ti_begin;
355 unsigned int bend = MIN(MIN(TTYINQ_DATASIZE, ti->ti_linestart),
356 ti->ti_begin + maxlen);
363 while (boff < bend) {
364 if (strchr(breakc, tib->tib_data[boff]) && !GETBIT(tib, boff)) {
365 *lastc = tib->tib_data[boff];
366 return (boff - ti->ti_begin + 1);
371 /* Not found - just process the entire block. */
372 return (bend - ti->ti_begin);
376 ttyinq_flush(struct ttyinq *ti)
378 struct ttyinq_block *tib;
381 ti->ti_linestart = 0;
385 /* Zero all data in the input queue to get rid of passwords. */
386 if (ttyinq_flush_secure) {
387 for (tib = ti->ti_firstblock; tib != NULL; tib = tib->tib_next)
388 bzero(&tib->tib_data, sizeof tib->tib_data);
393 ttyinq_peekchar(struct ttyinq *ti, char *c, int *quote)
396 struct ttyinq_block *tib = ti->ti_lastblock;
398 if (ti->ti_linestart == ti->ti_end)
401 MPASS(ti->ti_end > 0);
402 boff = (ti->ti_end - 1) % TTYINQ_DATASIZE;
404 *c = tib->tib_data[boff];
405 *quote = GETBIT(tib, boff);
411 ttyinq_unputchar(struct ttyinq *ti)
414 MPASS(ti->ti_linestart < ti->ti_end);
416 if (--ti->ti_end % TTYINQ_DATASIZE == 0) {
417 /* Roll back to the previous block. */
418 ti->ti_lastblock = ti->ti_lastblock->tib_prev;
420 * This can only fail if we are unputchar()'ing the
421 * first character in the queue.
423 MPASS((ti->ti_lastblock == NULL) == (ti->ti_end == 0));
428 ttyinq_reprintpos_set(struct ttyinq *ti)
431 ti->ti_reprint = ti->ti_end;
432 ti->ti_reprintblock = ti->ti_lastblock;
436 ttyinq_reprintpos_reset(struct ttyinq *ti)
439 ti->ti_reprint = ti->ti_linestart;
440 ti->ti_reprintblock = ti->ti_startblock;
444 ttyinq_line_iterate(struct ttyinq *ti,
445 ttyinq_line_iterator_t *iterator, void *data,
446 unsigned int offset, struct ttyinq_block *tib)
450 /* Use the proper block when we're at the queue head. */
452 tib = ti->ti_firstblock;
454 /* Iterate all characters and call the iterator function. */
455 for (; offset < ti->ti_end; offset++) {
456 boff = offset % TTYINQ_DATASIZE;
459 /* Call back the iterator function. */
460 iterator(data, tib->tib_data[boff], GETBIT(tib, boff));
462 /* Last byte iterated - go to the next block. */
463 if (boff == TTYINQ_DATASIZE - 1)
469 ttyinq_line_iterate_from_linestart(struct ttyinq *ti,
470 ttyinq_line_iterator_t *iterator, void *data)
473 ttyinq_line_iterate(ti, iterator, data,
474 ti->ti_linestart, ti->ti_startblock);
478 ttyinq_line_iterate_from_reprintpos(struct ttyinq *ti,
479 ttyinq_line_iterator_t *iterator, void *data)
482 ttyinq_line_iterate(ti, iterator, data,
483 ti->ti_reprint, ti->ti_reprintblock);
487 ttyinq_startup(void *dummy)
490 ttyinq_zone = uma_zcreate("ttyinq", sizeof(struct ttyinq_block),
491 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
494 SYSINIT(ttyinq, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyinq_startup, NULL);