1 // SPDX-License-Identifier: GPL-2.0
3 * Tty buffer allocation management
6 #include <linux/types.h>
7 #include <linux/errno.h>
9 #include <linux/tty_driver.h>
10 #include <linux/tty_flip.h>
11 #include <linux/timer.h>
12 #include <linux/string.h>
13 #include <linux/slab.h>
14 #include <linux/sched.h>
15 #include <linux/wait.h>
16 #include <linux/bitops.h>
17 #include <linux/delay.h>
18 #include <linux/module.h>
19 #include <linux/ratelimit.h>
22 #define MIN_TTYB_SIZE 256
23 #define TTYB_ALIGN_MASK 255
26 * Byte threshold to limit memory consumption for flip buffers.
27 * The actual memory limit is > 2x this amount.
29 #define TTYB_DEFAULT_MEM_LIMIT (640 * 1024UL)
32 * We default to dicing tty buffer allocations to this many characters
33 * in order to avoid multiple page allocations. We know the size of
34 * tty_buffer itself but it must also be taken into account that the
35 * buffer is 256 byte aligned. See tty_buffer_find for the allocation
36 * logic this must match.
39 #define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
42 * tty_buffer_lock_exclusive - gain exclusive access to buffer
43 * tty_buffer_unlock_exclusive - release exclusive access
45 * @port: tty port owning the flip buffer
47 * Guarantees safe use of the line discipline's receive_buf() method by
48 * excluding the buffer work and any pending flush from using the flip
49 * buffer. Data can continue to be added concurrently to the flip buffer
50 * from the driver side.
52 * On release, the buffer work is restarted if there is data in the
56 void tty_buffer_lock_exclusive(struct tty_port *port)
58 struct tty_bufhead *buf = &port->buf;
60 atomic_inc(&buf->priority);
61 mutex_lock(&buf->lock);
63 EXPORT_SYMBOL_GPL(tty_buffer_lock_exclusive);
65 void tty_buffer_unlock_exclusive(struct tty_port *port)
67 struct tty_bufhead *buf = &port->buf;
70 restart = buf->head->commit != buf->head->read;
72 atomic_dec(&buf->priority);
73 mutex_unlock(&buf->lock);
75 queue_work(system_unbound_wq, &buf->work);
77 EXPORT_SYMBOL_GPL(tty_buffer_unlock_exclusive);
80 * tty_buffer_space_avail - return unused buffer space
81 * @port: tty port owning the flip buffer
83 * Returns the # of bytes which can be written by the driver without
84 * reaching the buffer limit.
86 * Note: this does not guarantee that memory is available to write
87 * the returned # of bytes (use tty_prepare_flip_string_xxx() to
88 * pre-allocate if memory guarantee is required).
91 unsigned int tty_buffer_space_avail(struct tty_port *port)
93 int space = port->buf.mem_limit - atomic_read(&port->buf.mem_used);
97 EXPORT_SYMBOL_GPL(tty_buffer_space_avail);
99 static void tty_buffer_reset(struct tty_buffer *p, size_t size)
110 * tty_buffer_free_all - free buffers used by a tty
111 * @port: tty port to free from
113 * Remove all the buffers pending on a tty whether queued with data
114 * or in the free ring. Must be called when the tty is no longer in use
117 void tty_buffer_free_all(struct tty_port *port)
119 struct tty_bufhead *buf = &port->buf;
120 struct tty_buffer *p, *next;
121 struct llist_node *llist;
122 unsigned int freed = 0;
125 while ((p = buf->head) != NULL) {
131 llist = llist_del_all(&buf->free);
132 llist_for_each_entry_safe(p, next, llist, free)
135 tty_buffer_reset(&buf->sentinel, 0);
136 buf->head = &buf->sentinel;
137 buf->tail = &buf->sentinel;
139 still_used = atomic_xchg(&buf->mem_used, 0);
140 WARN(still_used != freed, "we still have not freed %d bytes!",
145 * tty_buffer_alloc - allocate a tty buffer
147 * @size: desired size (characters)
149 * Allocate a new tty buffer to hold the desired number of characters.
150 * We round our buffers off in 256 character chunks to get better
151 * allocation behaviour.
152 * Return NULL if out of memory or the allocation would exceed the
156 static struct tty_buffer *tty_buffer_alloc(struct tty_port *port, size_t size)
158 struct llist_node *free;
159 struct tty_buffer *p;
161 /* Round the buffer size out */
162 size = __ALIGN_MASK(size, TTYB_ALIGN_MASK);
164 if (size <= MIN_TTYB_SIZE) {
165 free = llist_del_first(&port->buf.free);
167 p = llist_entry(free, struct tty_buffer, free);
172 /* Should possibly check if this fails for the largest buffer we
173 * have queued and recycle that ?
175 if (atomic_read(&port->buf.mem_used) > port->buf.mem_limit)
177 p = kmalloc(sizeof(struct tty_buffer) + 2 * size,
178 GFP_ATOMIC | __GFP_NOWARN);
183 tty_buffer_reset(p, size);
184 atomic_add(size, &port->buf.mem_used);
189 * tty_buffer_free - free a tty buffer
190 * @port: tty port owning the buffer
191 * @b: the buffer to free
193 * Free a tty buffer, or add it to the free list according to our
197 static void tty_buffer_free(struct tty_port *port, struct tty_buffer *b)
199 struct tty_bufhead *buf = &port->buf;
201 /* Dumb strategy for now - should keep some stats */
202 WARN_ON(atomic_sub_return(b->size, &buf->mem_used) < 0);
204 if (b->size > MIN_TTYB_SIZE)
206 else if (b->size > 0)
207 llist_add(&b->free, &buf->free);
211 * tty_buffer_flush - flush full tty buffers
213 * @ld: optional ldisc ptr (must be referenced)
215 * flush all the buffers containing receive data. If ld != NULL,
216 * flush the ldisc input buffer.
218 * Locking: takes buffer lock to ensure single-threaded flip buffer
222 void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld)
224 struct tty_port *port = tty->port;
225 struct tty_bufhead *buf = &port->buf;
226 struct tty_buffer *next;
228 atomic_inc(&buf->priority);
230 mutex_lock(&buf->lock);
231 /* paired w/ release in __tty_buffer_request_room; ensures there are
232 * no pending memory accesses to the freed buffer
234 while ((next = smp_load_acquire(&buf->head->next)) != NULL) {
235 tty_buffer_free(port, buf->head);
238 buf->head->read = buf->head->commit;
240 if (ld && ld->ops->flush_buffer)
241 ld->ops->flush_buffer(tty);
243 atomic_dec(&buf->priority);
244 mutex_unlock(&buf->lock);
248 * __tty_buffer_request_room - grow tty buffer if needed
250 * @size: size desired
251 * @flags: buffer flags if new buffer allocated (default = 0)
253 * Make at least size bytes of linear space available for the tty
254 * buffer. If we fail return the size we managed to find.
256 * Will change over to a new buffer if the current buffer is encoded as
257 * TTY_NORMAL (so has no flags buffer) and the new buffer requires
260 static int __tty_buffer_request_room(struct tty_port *port, size_t size,
263 struct tty_bufhead *buf = &port->buf;
264 struct tty_buffer *b, *n;
268 if (b->flags & TTYB_NORMAL)
269 left = 2 * b->size - b->used;
271 left = b->size - b->used;
273 change = (b->flags & TTYB_NORMAL) && (~flags & TTYB_NORMAL);
274 if (change || left < size) {
275 /* This is the slow path - looking for new buffers to use */
276 n = tty_buffer_alloc(port, size);
280 /* paired w/ acquire in flush_to_ldisc(); ensures
281 * flush_to_ldisc() sees buffer data.
283 smp_store_release(&b->commit, b->used);
284 /* paired w/ acquire in flush_to_ldisc(); ensures the
285 * latest commit value can be read before the head is
286 * advanced to the next buffer
288 smp_store_release(&b->next, n);
297 int tty_buffer_request_room(struct tty_port *port, size_t size)
299 return __tty_buffer_request_room(port, size, 0);
301 EXPORT_SYMBOL_GPL(tty_buffer_request_room);
304 * tty_insert_flip_string_fixed_flag - Add characters to the tty buffer
307 * @flag: flag value for each character
310 * Queue a series of bytes to the tty buffering. All the characters
311 * passed are marked with the supplied flag. Returns the number added.
314 int tty_insert_flip_string_fixed_flag(struct tty_port *port,
315 const unsigned char *chars, char flag, size_t size)
320 int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
321 int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0;
322 int space = __tty_buffer_request_room(port, goal, flags);
323 struct tty_buffer *tb = port->buf.tail;
325 if (unlikely(space == 0))
327 memcpy(char_buf_ptr(tb, tb->used), chars, space);
328 if (~tb->flags & TTYB_NORMAL)
329 memset(flag_buf_ptr(tb, tb->used), flag, space);
333 /* There is a small chance that we need to split the data over
334 * several buffers. If this is the case we must loop.
336 } while (unlikely(size > copied));
339 EXPORT_SYMBOL(tty_insert_flip_string_fixed_flag);
342 * tty_insert_flip_string_flags - Add characters to the tty buffer
348 * Queue a series of bytes to the tty buffering. For each character
349 * the flags array indicates the status of the character. Returns the
353 int tty_insert_flip_string_flags(struct tty_port *port,
354 const unsigned char *chars, const char *flags, size_t size)
359 int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
360 int space = tty_buffer_request_room(port, goal);
361 struct tty_buffer *tb = port->buf.tail;
363 if (unlikely(space == 0))
365 memcpy(char_buf_ptr(tb, tb->used), chars, space);
366 memcpy(flag_buf_ptr(tb, tb->used), flags, space);
371 /* There is a small chance that we need to split the data over
372 * several buffers. If this is the case we must loop.
374 } while (unlikely(size > copied));
377 EXPORT_SYMBOL(tty_insert_flip_string_flags);
380 * __tty_insert_flip_char - Add one character to the tty buffer
385 * Queue a single byte to the tty buffering, with an optional flag.
386 * This is the slow path of tty_insert_flip_char.
388 int __tty_insert_flip_char(struct tty_port *port, unsigned char ch, char flag)
390 struct tty_buffer *tb;
391 int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0;
393 if (!__tty_buffer_request_room(port, 1, flags))
397 if (~tb->flags & TTYB_NORMAL)
398 *flag_buf_ptr(tb, tb->used) = flag;
399 *char_buf_ptr(tb, tb->used++) = ch;
403 EXPORT_SYMBOL(__tty_insert_flip_char);
406 * tty_prepare_flip_string - make room for characters
408 * @chars: return pointer for character write area
409 * @size: desired size
411 * Prepare a block of space in the buffer for data. Returns the length
412 * available and buffer pointer to the space which is now allocated and
413 * accounted for as ready for normal characters. This is used for drivers
414 * that need their own block copy routines into the buffer. There is no
415 * guarantee the buffer is a DMA target!
418 int tty_prepare_flip_string(struct tty_port *port, unsigned char **chars,
421 int space = __tty_buffer_request_room(port, size, TTYB_NORMAL);
424 struct tty_buffer *tb = port->buf.tail;
426 *chars = char_buf_ptr(tb, tb->used);
427 if (~tb->flags & TTYB_NORMAL)
428 memset(flag_buf_ptr(tb, tb->used), TTY_NORMAL, space);
433 EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
436 * tty_ldisc_receive_buf - forward data to line discipline
437 * @ld: line discipline to process input
439 * @f: TTY_* flags buffer
440 * @count: number of bytes to process
442 * Callers other than flush_to_ldisc() need to exclude the kworker
443 * from concurrent use of the line discipline, see paste_selection().
445 * Returns the number of bytes processed
447 int tty_ldisc_receive_buf(struct tty_ldisc *ld, const unsigned char *p,
448 const char *f, int count)
450 if (ld->ops->receive_buf2)
451 count = ld->ops->receive_buf2(ld->tty, p, f, count);
453 count = min_t(int, count, ld->tty->receive_room);
454 if (count && ld->ops->receive_buf)
455 ld->ops->receive_buf(ld->tty, p, f, count);
459 EXPORT_SYMBOL_GPL(tty_ldisc_receive_buf);
462 receive_buf(struct tty_port *port, struct tty_buffer *head, int count)
464 unsigned char *p = char_buf_ptr(head, head->read);
465 const char *f = NULL;
468 if (~head->flags & TTYB_NORMAL)
469 f = flag_buf_ptr(head, head->read);
471 n = port->client_ops->receive_buf(port, p, f, count);
479 * @work: tty structure passed from work queue.
481 * This routine is called out of the software interrupt to flush data
482 * from the buffer chain to the line discipline.
484 * The receive_buf method is single threaded for each tty instance.
486 * Locking: takes buffer lock to ensure single-threaded flip buffer
490 static void flush_to_ldisc(struct work_struct *work)
492 struct tty_port *port = container_of(work, struct tty_port, buf.work);
493 struct tty_bufhead *buf = &port->buf;
495 mutex_lock(&buf->lock);
498 struct tty_buffer *head = buf->head;
499 struct tty_buffer *next;
502 /* Ldisc or user is trying to gain exclusive access */
503 if (atomic_read(&buf->priority))
506 /* paired w/ release in __tty_buffer_request_room();
507 * ensures commit value read is not stale if the head
508 * is advancing to the next buffer
510 next = smp_load_acquire(&head->next);
511 /* paired w/ release in __tty_buffer_request_room() or in
512 * tty_buffer_flush(); ensures we see the committed buffer data
514 count = smp_load_acquire(&head->commit) - head->read;
519 tty_buffer_free(port, head);
523 count = receive_buf(port, head, count);
532 mutex_unlock(&buf->lock);
536 static inline void tty_flip_buffer_commit(struct tty_buffer *tail)
539 * Paired w/ acquire in flush_to_ldisc(); ensures flush_to_ldisc() sees
542 smp_store_release(&tail->commit, tail->used);
546 * tty_flip_buffer_push - terminal
547 * @port: tty port to push
549 * Queue a push of the terminal flip buffers to the line discipline.
550 * Can be called from IRQ/atomic context.
552 * In the event of the queue being busy for flipping the work will be
553 * held off and retried later.
556 void tty_flip_buffer_push(struct tty_port *port)
558 struct tty_bufhead *buf = &port->buf;
560 tty_flip_buffer_commit(buf->tail);
561 queue_work(system_unbound_wq, &buf->work);
563 EXPORT_SYMBOL(tty_flip_buffer_push);
566 * tty_insert_flip_string_and_push_buffer - add characters to the tty buffer and
572 * The function combines tty_insert_flip_string() and tty_flip_buffer_push()
573 * with the exception of properly holding the @port->lock.
575 * To be used only internally (by pty currently).
577 * Returns: the number added.
579 int tty_insert_flip_string_and_push_buffer(struct tty_port *port,
580 const unsigned char *chars, size_t size)
582 struct tty_bufhead *buf = &port->buf;
585 spin_lock_irqsave(&port->lock, flags);
586 size = tty_insert_flip_string(port, chars, size);
588 tty_flip_buffer_commit(buf->tail);
589 spin_unlock_irqrestore(&port->lock, flags);
591 queue_work(system_unbound_wq, &buf->work);
597 * tty_buffer_init - prepare a tty buffer structure
598 * @port: tty port to initialise
600 * Set up the initial state of the buffer management for a tty device.
601 * Must be called before the other tty buffer functions are used.
604 void tty_buffer_init(struct tty_port *port)
606 struct tty_bufhead *buf = &port->buf;
608 mutex_init(&buf->lock);
609 tty_buffer_reset(&buf->sentinel, 0);
610 buf->head = &buf->sentinel;
611 buf->tail = &buf->sentinel;
612 init_llist_head(&buf->free);
613 atomic_set(&buf->mem_used, 0);
614 atomic_set(&buf->priority, 0);
615 INIT_WORK(&buf->work, flush_to_ldisc);
616 buf->mem_limit = TTYB_DEFAULT_MEM_LIMIT;
620 * tty_buffer_set_limit - change the tty buffer memory limit
621 * @port: tty port to change
622 * @limit: memory limit to set
624 * Change the tty buffer memory limit.
625 * Must be called before the other tty buffer functions are used.
628 int tty_buffer_set_limit(struct tty_port *port, int limit)
630 if (limit < MIN_TTYB_SIZE)
632 port->buf.mem_limit = limit;
635 EXPORT_SYMBOL_GPL(tty_buffer_set_limit);
637 /* slave ptys can claim nested buffer lock when handling BRK and INTR */
638 void tty_buffer_set_lock_subclass(struct tty_port *port)
640 lockdep_set_subclass(&port->buf.lock, TTY_LOCK_SLAVE);
643 bool tty_buffer_restart_work(struct tty_port *port)
645 return queue_work(system_unbound_wq, &port->buf.work);
648 bool tty_buffer_cancel_work(struct tty_port *port)
650 return cancel_work_sync(&port->buf.work);
653 void tty_buffer_flush_work(struct tty_port *port)
655 flush_work(&port->buf.work);