2 * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
5 * Portions of this software were developed under sponsorship from Snow
6 * B.V., the Netherlands.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
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 output queue buffering.
47 * The previous design of the TTY layer offered the so-called clists.
48 * These clists were used for both the input queues and the output
49 * queue. We don't use certain features on the output side, like quoting
50 * bits for parity marking and such. This mechanism is similar to the
51 * old clists, but only contains the features we need to buffer the
56 static unsigned long ttyoutq_nfast = 0;
57 SYSCTL_ULONG(_kern, OID_AUTO, tty_outq_nfast, CTLFLAG_RD,
58 &ttyoutq_nfast, 0, "Unbuffered reads to userspace on output");
59 static unsigned long ttyoutq_nslow = 0;
60 SYSCTL_ULONG(_kern, OID_AUTO, tty_outq_nslow, CTLFLAG_RD,
61 &ttyoutq_nslow, 0, "Buffered reads to userspace on output");
63 struct ttyoutq_block {
64 struct ttyoutq_block *tob_next;
65 char tob_data[TTYOUTQ_DATASIZE];
68 static uma_zone_t ttyoutq_zone;
70 #define TTYOUTQ_INSERT_TAIL(to, tob) do { \
71 if (to->to_end == 0) { \
72 tob->tob_next = to->to_firstblock; \
73 to->to_firstblock = tob; \
75 tob->tob_next = to->to_lastblock->tob_next; \
76 to->to_lastblock->tob_next = tob; \
81 #define TTYOUTQ_REMOVE_HEAD(to) do { \
82 to->to_firstblock = to->to_firstblock->tob_next; \
86 #define TTYOUTQ_RECYCLE(to, tob) do { \
87 if (to->to_quota <= to->to_nblocks) \
88 uma_zfree(ttyoutq_zone, tob); \
90 TTYOUTQ_INSERT_TAIL(to, tob); \
94 ttyoutq_flush(struct ttyoutq *to)
102 ttyoutq_setsize(struct ttyoutq *to, struct tty *tp, size_t size)
104 struct ttyoutq_block *tob;
106 to->to_quota = howmany(size, TTYOUTQ_DATASIZE);
108 while (to->to_quota > to->to_nblocks) {
110 * List is getting bigger.
111 * Add new blocks to the tail of the list.
113 * We must unlock the TTY temporarily, because we need
114 * to allocate memory. This won't be a problem, because
115 * in the worst case, another thread ends up here, which
116 * may cause us to allocate too many blocks, but this
117 * will be caught by the loop below.
120 tob = uma_zalloc(ttyoutq_zone, M_WAITOK);
123 TTYOUTQ_INSERT_TAIL(to, tob);
128 ttyoutq_free(struct ttyoutq *to)
130 struct ttyoutq_block *tob;
135 while ((tob = to->to_firstblock) != NULL) {
136 TTYOUTQ_REMOVE_HEAD(to);
137 uma_zfree(ttyoutq_zone, tob);
140 MPASS(to->to_nblocks == 0);
144 ttyoutq_read(struct ttyoutq *to, void *buf, size_t len)
149 struct ttyoutq_block *tob;
150 size_t cbegin, cend, clen;
152 /* See if there still is data. */
153 if (to->to_begin == to->to_end)
155 tob = to->to_firstblock;
160 * The end address should be the lowest of these three:
161 * - The write pointer
162 * - The blocksize - we can't read beyond the block
163 * - The end address if we could perform the full read
165 cbegin = to->to_begin;
166 cend = MIN(MIN(to->to_end, to->to_begin + len),
168 clen = cend - cbegin;
170 /* Copy the data out of the buffers. */
171 memcpy(cbuf, tob->tob_data + cbegin, clen);
175 if (cend == to->to_end) {
176 /* Read the complete queue. */
179 } else if (cend == TTYOUTQ_DATASIZE) {
180 /* Read the block until the end. */
181 TTYOUTQ_REMOVE_HEAD(to);
183 to->to_end -= TTYOUTQ_DATASIZE;
184 TTYOUTQ_RECYCLE(to, tob);
186 /* Read the block partially. */
187 to->to_begin += clen;
191 return (cbuf - (char *)buf);
195 * An optimized version of ttyoutq_read() which can be used in pseudo
196 * TTY drivers to directly copy data from the outq to userspace, instead
199 * We can only copy data directly if we need to read the entire block
200 * back to the user, because we temporarily remove the block from the
201 * queue. Otherwise we need to copy it to a temporary buffer first, to
202 * make sure data remains in the correct order.
205 ttyoutq_read_uio(struct ttyoutq *to, struct tty *tp, struct uio *uio)
208 while (uio->uio_resid > 0) {
210 struct ttyoutq_block *tob;
211 size_t cbegin, cend, clen;
213 /* See if there still is data. */
214 if (to->to_begin == to->to_end)
216 tob = to->to_firstblock;
221 * The end address should be the lowest of these three:
222 * - The write pointer
223 * - The blocksize - we can't read beyond the block
224 * - The end address if we could perform the full read
226 cbegin = to->to_begin;
227 cend = MIN(MIN(to->to_end, to->to_begin + uio->uio_resid),
229 clen = cend - cbegin;
232 * We can prevent buffering in some cases:
233 * - We need to read the block until the end.
234 * - We don't need to read the block until the end, but
235 * there is no data beyond it, which allows us to move
236 * the write pointer to a new block.
238 if (cend == TTYOUTQ_DATASIZE || cend == to->to_end) {
239 atomic_add_long(&ttyoutq_nfast, 1);
242 * Fast path: zero copy. Remove the first block,
243 * so we can unlock the TTY temporarily.
245 TTYOUTQ_REMOVE_HEAD(to);
247 if (to->to_end <= TTYOUTQ_DATASIZE)
250 to->to_end -= TTYOUTQ_DATASIZE;
252 /* Temporary unlock and copy the data to userspace. */
254 error = uiomove(tob->tob_data + cbegin, clen, uio);
257 /* Block can now be readded to the list. */
258 TTYOUTQ_RECYCLE(to, tob);
260 char ob[TTYOUTQ_DATASIZE - 1];
261 atomic_add_long(&ttyoutq_nslow, 1);
264 * Slow path: store data in a temporary buffer.
266 memcpy(ob, tob->tob_data + cbegin, clen);
267 to->to_begin += clen;
268 MPASS(to->to_begin < TTYOUTQ_DATASIZE);
270 /* Temporary unlock and copy the data to userspace. */
272 error = uiomove(ob, clen, uio);
284 ttyoutq_write(struct ttyoutq *to, const void *buf, size_t nbytes)
286 const char *cbuf = buf;
287 struct ttyoutq_block *tob;
292 boff = to->to_end % TTYOUTQ_DATASIZE;
294 if (to->to_end == 0) {
295 /* First time we're being used or drained. */
296 MPASS(to->to_begin == 0);
297 tob = to->to_firstblock;
299 /* Queue has no blocks. */
302 to->to_lastblock = tob;
303 } else if (boff == 0) {
304 /* We reached the end of this block on last write. */
305 tob = to->to_lastblock->tob_next;
307 /* We've reached the watermark. */
310 to->to_lastblock = tob;
312 tob = to->to_lastblock;
315 /* Don't copy more than was requested. */
316 l = MIN(nbytes, TTYOUTQ_DATASIZE - boff);
318 memcpy(tob->tob_data + boff, cbuf, l);
325 return (cbuf - (const char *)buf);
329 ttyoutq_write_nofrag(struct ttyoutq *to, const void *buf, size_t nbytes)
333 if (ttyoutq_bytesleft(to) < nbytes)
336 /* We should always be able to write it back. */
337 ret = ttyoutq_write(to, buf, nbytes);
338 MPASS(ret == nbytes);
344 ttyoutq_startup(void *dummy)
347 ttyoutq_zone = uma_zcreate("ttyoutq", sizeof(struct ttyoutq_block),
348 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
351 SYSINIT(ttyoutq, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyoutq_startup, NULL);