2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/kernel.h>
38 #include <sys/queue.h>
39 #include <sys/systm.h>
46 * TTY output queue buffering.
48 * The previous design of the TTY layer offered the so-called clists.
49 * These clists were used for both the input queues and the output
50 * queue. We don't use certain features on the output side, like quoting
51 * bits for parity marking and such. This mechanism is similar to the
52 * old clists, but only contains the features we need to buffer the
56 struct ttyoutq_block {
57 struct ttyoutq_block *tob_next;
58 char tob_data[TTYOUTQ_DATASIZE];
61 static uma_zone_t ttyoutq_zone;
63 #define TTYOUTQ_INSERT_TAIL(to, tob) do { \
64 if (to->to_end == 0) { \
65 tob->tob_next = to->to_firstblock; \
66 to->to_firstblock = tob; \
68 tob->tob_next = to->to_lastblock->tob_next; \
69 to->to_lastblock->tob_next = tob; \
74 #define TTYOUTQ_REMOVE_HEAD(to) do { \
75 to->to_firstblock = to->to_firstblock->tob_next; \
79 #define TTYOUTQ_RECYCLE(to, tob) do { \
80 if (to->to_quota <= to->to_nblocks) \
81 uma_zfree(ttyoutq_zone, tob); \
83 TTYOUTQ_INSERT_TAIL(to, tob); \
87 ttyoutq_flush(struct ttyoutq *to)
95 ttyoutq_setsize(struct ttyoutq *to, struct tty *tp, size_t size)
97 struct ttyoutq_block *tob;
99 to->to_quota = howmany(size, TTYOUTQ_DATASIZE);
101 while (to->to_quota > to->to_nblocks) {
103 * List is getting bigger.
104 * Add new blocks to the tail of the list.
106 * We must unlock the TTY temporarily, because we need
107 * to allocate memory. This won't be a problem, because
108 * in the worst case, another thread ends up here, which
109 * may cause us to allocate too many blocks, but this
110 * will be caught by the loop below.
113 tob = uma_zalloc(ttyoutq_zone, M_WAITOK);
117 uma_zfree(ttyoutq_zone, tob);
121 TTYOUTQ_INSERT_TAIL(to, tob);
127 ttyoutq_free(struct ttyoutq *to)
129 struct ttyoutq_block *tob;
134 while ((tob = to->to_firstblock) != NULL) {
135 TTYOUTQ_REMOVE_HEAD(to);
136 uma_zfree(ttyoutq_zone, tob);
139 MPASS(to->to_nblocks == 0);
143 ttyoutq_read(struct ttyoutq *to, void *buf, size_t len)
148 struct ttyoutq_block *tob;
149 size_t cbegin, cend, clen;
151 /* See if there still is data. */
152 if (to->to_begin == to->to_end)
154 tob = to->to_firstblock;
159 * The end address should be the lowest of these three:
160 * - The write pointer
161 * - The blocksize - we can't read beyond the block
162 * - The end address if we could perform the full read
164 cbegin = to->to_begin;
165 cend = MIN(MIN(to->to_end, to->to_begin + len),
167 clen = cend - cbegin;
169 /* Copy the data out of the buffers. */
170 memcpy(cbuf, tob->tob_data + cbegin, clen);
174 if (cend == to->to_end) {
175 /* Read the complete queue. */
178 } else if (cend == TTYOUTQ_DATASIZE) {
179 /* Read the block until the end. */
180 TTYOUTQ_REMOVE_HEAD(to);
182 to->to_end -= TTYOUTQ_DATASIZE;
183 TTYOUTQ_RECYCLE(to, tob);
185 /* Read the block partially. */
186 to->to_begin += clen;
190 return (cbuf - (char *)buf);
194 * An optimized version of ttyoutq_read() which can be used in pseudo
195 * TTY drivers to directly copy data from the outq to userspace, instead
198 * We can only copy data directly if we need to read the entire block
199 * back to the user, because we temporarily remove the block from the
200 * queue. Otherwise we need to copy it to a temporary buffer first, to
201 * make sure data remains in the correct order.
204 ttyoutq_read_uio(struct ttyoutq *to, struct tty *tp, struct uio *uio)
207 while (uio->uio_resid > 0) {
209 struct ttyoutq_block *tob;
210 size_t cbegin, cend, clen;
212 /* See if there still is data. */
213 if (to->to_begin == to->to_end)
215 tob = to->to_firstblock;
220 * The end address should be the lowest of these three:
221 * - The write pointer
222 * - The blocksize - we can't read beyond the block
223 * - The end address if we could perform the full read
225 cbegin = to->to_begin;
226 cend = MIN(MIN(to->to_end, to->to_begin + uio->uio_resid),
228 clen = cend - cbegin;
231 * We can prevent buffering in some cases:
232 * - We need to read the block until the end.
233 * - We don't need to read the block until the end, but
234 * there is no data beyond it, which allows us to move
235 * the write pointer to a new block.
237 if (cend == TTYOUTQ_DATASIZE || cend == to->to_end) {
239 * Fast path: zero copy. Remove the first block,
240 * so we can unlock the TTY temporarily.
242 TTYOUTQ_REMOVE_HEAD(to);
244 if (to->to_end <= TTYOUTQ_DATASIZE)
247 to->to_end -= TTYOUTQ_DATASIZE;
249 /* Temporary unlock and copy the data to userspace. */
251 error = uiomove(tob->tob_data + cbegin, clen, uio);
254 /* Block can now be readded to the list. */
255 TTYOUTQ_RECYCLE(to, tob);
257 char ob[TTYOUTQ_DATASIZE - 1];
260 * Slow path: store data in a temporary buffer.
262 memcpy(ob, tob->tob_data + cbegin, clen);
263 to->to_begin += clen;
264 MPASS(to->to_begin < TTYOUTQ_DATASIZE);
266 /* Temporary unlock and copy the data to userspace. */
268 error = uiomove(ob, clen, uio);
280 ttyoutq_write(struct ttyoutq *to, const void *buf, size_t nbytes)
282 const char *cbuf = buf;
283 struct ttyoutq_block *tob;
288 boff = to->to_end % TTYOUTQ_DATASIZE;
290 if (to->to_end == 0) {
291 /* First time we're being used or drained. */
292 MPASS(to->to_begin == 0);
293 tob = to->to_firstblock;
295 /* Queue has no blocks. */
298 to->to_lastblock = tob;
299 } else if (boff == 0) {
300 /* We reached the end of this block on last write. */
301 tob = to->to_lastblock->tob_next;
303 /* We've reached the watermark. */
306 to->to_lastblock = tob;
308 tob = to->to_lastblock;
311 /* Don't copy more than was requested. */
312 l = MIN(nbytes, TTYOUTQ_DATASIZE - boff);
314 memcpy(tob->tob_data + boff, cbuf, l);
321 return (cbuf - (const char *)buf);
325 ttyoutq_write_nofrag(struct ttyoutq *to, const void *buf, size_t nbytes)
329 if (ttyoutq_bytesleft(to) < nbytes)
332 /* We should always be able to write it back. */
333 ret = ttyoutq_write(to, buf, nbytes);
334 MPASS(ret == nbytes);
340 ttyoutq_startup(void *dummy)
343 ttyoutq_zone = uma_zcreate("ttyoutq", sizeof(struct ttyoutq_block),
344 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
347 SYSINIT(ttyoutq, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyoutq_startup, NULL);