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 * the 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 int tty_buffer_space_avail(struct tty_port *port)
93 int space = port->buf.mem_limit - atomic_read(&port->buf.mem_used);
96 EXPORT_SYMBOL_GPL(tty_buffer_space_avail);
98 static void tty_buffer_reset(struct tty_buffer *p, size_t size)
109 * tty_buffer_free_all - free buffers used by a tty
110 * @port: tty port to free from
112 * Remove all the buffers pending on a tty whether queued with data
113 * or in the free ring. Must be called when the tty is no longer in use
116 void tty_buffer_free_all(struct tty_port *port)
118 struct tty_bufhead *buf = &port->buf;
119 struct tty_buffer *p, *next;
120 struct llist_node *llist;
121 unsigned int freed = 0;
124 while ((p = buf->head) != NULL) {
130 llist = llist_del_all(&buf->free);
131 llist_for_each_entry_safe(p, next, llist, free)
134 tty_buffer_reset(&buf->sentinel, 0);
135 buf->head = &buf->sentinel;
136 buf->tail = &buf->sentinel;
138 still_used = atomic_xchg(&buf->mem_used, 0);
139 WARN(still_used != freed, "we still have not freed %d bytes!",
144 * tty_buffer_alloc - allocate a tty buffer
146 * @size: desired size (characters)
148 * Allocate a new tty buffer to hold the desired number of characters.
149 * We round our buffers off in 256 character chunks to get better
150 * allocation behaviour.
151 * Return NULL if out of memory or the allocation would exceed the
155 static struct tty_buffer *tty_buffer_alloc(struct tty_port *port, size_t size)
157 struct llist_node *free;
158 struct tty_buffer *p;
160 /* Round the buffer size out */
161 size = __ALIGN_MASK(size, TTYB_ALIGN_MASK);
163 if (size <= MIN_TTYB_SIZE) {
164 free = llist_del_first(&port->buf.free);
166 p = llist_entry(free, struct tty_buffer, free);
171 /* Should possibly check if this fails for the largest buffer we
172 have queued and recycle that ? */
173 if (atomic_read(&port->buf.mem_used) > port->buf.mem_limit)
175 p = kmalloc(sizeof(struct tty_buffer) + 2 * size,
176 GFP_ATOMIC | __GFP_NOWARN);
181 tty_buffer_reset(p, size);
182 atomic_add(size, &port->buf.mem_used);
187 * tty_buffer_free - free a tty buffer
188 * @port: tty port owning the buffer
189 * @b: the buffer to free
191 * Free a tty buffer, or add it to the free list according to our
195 static void tty_buffer_free(struct tty_port *port, struct tty_buffer *b)
197 struct tty_bufhead *buf = &port->buf;
199 /* Dumb strategy for now - should keep some stats */
200 WARN_ON(atomic_sub_return(b->size, &buf->mem_used) < 0);
202 if (b->size > MIN_TTYB_SIZE)
204 else if (b->size > 0)
205 llist_add(&b->free, &buf->free);
209 * tty_buffer_flush - flush full tty buffers
211 * @ld: optional ldisc ptr (must be referenced)
213 * flush all the buffers containing receive data. If ld != NULL,
214 * flush the ldisc input buffer.
216 * Locking: takes buffer lock to ensure single-threaded flip buffer
220 void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld)
222 struct tty_port *port = tty->port;
223 struct tty_bufhead *buf = &port->buf;
224 struct tty_buffer *next;
226 atomic_inc(&buf->priority);
228 mutex_lock(&buf->lock);
229 /* paired w/ release in __tty_buffer_request_room; ensures there are
230 * no pending memory accesses to the freed buffer
232 while ((next = smp_load_acquire(&buf->head->next)) != NULL) {
233 tty_buffer_free(port, buf->head);
236 buf->head->read = buf->head->commit;
238 if (ld && ld->ops->flush_buffer)
239 ld->ops->flush_buffer(tty);
241 atomic_dec(&buf->priority);
242 mutex_unlock(&buf->lock);
246 * tty_buffer_request_room - grow tty buffer if needed
248 * @size: size desired
249 * @flags: buffer flags if new buffer allocated (default = 0)
251 * Make at least size bytes of linear space available for the tty
252 * buffer. If we fail return the size we managed to find.
254 * Will change over to a new buffer if the current buffer is encoded as
255 * TTY_NORMAL (so has no flags buffer) and the new buffer requires
258 static int __tty_buffer_request_room(struct tty_port *port, size_t size,
261 struct tty_bufhead *buf = &port->buf;
262 struct tty_buffer *b, *n;
266 if (b->flags & TTYB_NORMAL)
267 left = 2 * b->size - b->used;
269 left = b->size - b->used;
271 change = (b->flags & TTYB_NORMAL) && (~flags & TTYB_NORMAL);
272 if (change || left < size) {
273 /* This is the slow path - looking for new buffers to use */
274 n = tty_buffer_alloc(port, size);
278 /* paired w/ acquire in flush_to_ldisc(); ensures
279 * flush_to_ldisc() sees buffer data.
281 smp_store_release(&b->commit, b->used);
282 /* paired w/ acquire in flush_to_ldisc(); ensures the
283 * latest commit value can be read before the head is
284 * advanced to the next buffer
286 smp_store_release(&b->next, n);
295 int tty_buffer_request_room(struct tty_port *port, size_t size)
297 return __tty_buffer_request_room(port, size, 0);
299 EXPORT_SYMBOL_GPL(tty_buffer_request_room);
302 * tty_insert_flip_string_fixed_flag - Add characters to the tty buffer
305 * @flag: flag value for each character
308 * Queue a series of bytes to the tty buffering. All the characters
309 * passed are marked with the supplied flag. Returns the number added.
312 int tty_insert_flip_string_fixed_flag(struct tty_port *port,
313 const unsigned char *chars, char flag, size_t size)
317 int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
318 int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0;
319 int space = __tty_buffer_request_room(port, goal, flags);
320 struct tty_buffer *tb = port->buf.tail;
321 if (unlikely(space == 0))
323 memcpy(char_buf_ptr(tb, tb->used), chars, space);
324 if (~tb->flags & TTYB_NORMAL)
325 memset(flag_buf_ptr(tb, tb->used), flag, space);
329 /* There is a small chance that we need to split the data over
330 several buffers. If this is the case we must loop */
331 } while (unlikely(size > copied));
334 EXPORT_SYMBOL(tty_insert_flip_string_fixed_flag);
337 * tty_insert_flip_string_flags - Add characters to the tty buffer
343 * Queue a series of bytes to the tty buffering. For each character
344 * the flags array indicates the status of the character. Returns the
348 int tty_insert_flip_string_flags(struct tty_port *port,
349 const unsigned char *chars, const char *flags, size_t size)
353 int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
354 int space = tty_buffer_request_room(port, goal);
355 struct tty_buffer *tb = port->buf.tail;
356 if (unlikely(space == 0))
358 memcpy(char_buf_ptr(tb, tb->used), chars, space);
359 memcpy(flag_buf_ptr(tb, tb->used), flags, space);
364 /* There is a small chance that we need to split the data over
365 several buffers. If this is the case we must loop */
366 } while (unlikely(size > copied));
369 EXPORT_SYMBOL(tty_insert_flip_string_flags);
372 * __tty_insert_flip_char - Add one character to the tty buffer
377 * Queue a single byte to the tty buffering, with an optional flag.
378 * This is the slow path of tty_insert_flip_char.
380 int __tty_insert_flip_char(struct tty_port *port, unsigned char ch, char flag)
382 struct tty_buffer *tb;
383 int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0;
385 if (!__tty_buffer_request_room(port, 1, flags))
389 if (~tb->flags & TTYB_NORMAL)
390 *flag_buf_ptr(tb, tb->used) = flag;
391 *char_buf_ptr(tb, tb->used++) = ch;
395 EXPORT_SYMBOL(__tty_insert_flip_char);
398 * tty_prepare_flip_string - make room for characters
400 * @chars: return pointer for character write area
401 * @size: desired size
403 * Prepare a block of space in the buffer for data. Returns the length
404 * available and buffer pointer to the space which is now allocated and
405 * accounted for as ready for normal characters. This is used for drivers
406 * that need their own block copy routines into the buffer. There is no
407 * guarantee the buffer is a DMA target!
410 int tty_prepare_flip_string(struct tty_port *port, unsigned char **chars,
413 int space = __tty_buffer_request_room(port, size, TTYB_NORMAL);
415 struct tty_buffer *tb = port->buf.tail;
416 *chars = char_buf_ptr(tb, tb->used);
417 if (~tb->flags & TTYB_NORMAL)
418 memset(flag_buf_ptr(tb, tb->used), TTY_NORMAL, space);
423 EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
426 * tty_ldisc_receive_buf - forward data to line discipline
427 * @ld: line discipline to process input
429 * @f: TTY_* flags buffer
430 * @count: number of bytes to process
432 * Callers other than flush_to_ldisc() need to exclude the kworker
433 * from concurrent use of the line discipline, see paste_selection().
435 * Returns the number of bytes processed
437 int tty_ldisc_receive_buf(struct tty_ldisc *ld, const unsigned char *p,
440 if (ld->ops->receive_buf2)
441 count = ld->ops->receive_buf2(ld->tty, p, f, count);
443 count = min_t(int, count, ld->tty->receive_room);
444 if (count && ld->ops->receive_buf)
445 ld->ops->receive_buf(ld->tty, p, f, count);
449 EXPORT_SYMBOL_GPL(tty_ldisc_receive_buf);
452 receive_buf(struct tty_port *port, struct tty_buffer *head, int count)
454 unsigned char *p = char_buf_ptr(head, head->read);
458 if (~head->flags & TTYB_NORMAL)
459 f = flag_buf_ptr(head, head->read);
461 n = port->client_ops->receive_buf(port, p, f, count);
469 * @work: tty structure passed from work queue.
471 * This routine is called out of the software interrupt to flush data
472 * from the buffer chain to the line discipline.
474 * The receive_buf method is single threaded for each tty instance.
476 * Locking: takes buffer lock to ensure single-threaded flip buffer
480 static void flush_to_ldisc(struct work_struct *work)
482 struct tty_port *port = container_of(work, struct tty_port, buf.work);
483 struct tty_bufhead *buf = &port->buf;
485 mutex_lock(&buf->lock);
488 struct tty_buffer *head = buf->head;
489 struct tty_buffer *next;
492 /* Ldisc or user is trying to gain exclusive access */
493 if (atomic_read(&buf->priority))
496 /* paired w/ release in __tty_buffer_request_room();
497 * ensures commit value read is not stale if the head
498 * is advancing to the next buffer
500 next = smp_load_acquire(&head->next);
501 /* paired w/ release in __tty_buffer_request_room() or in
502 * tty_buffer_flush(); ensures we see the committed buffer data
504 count = smp_load_acquire(&head->commit) - head->read;
509 tty_buffer_free(port, head);
513 count = receive_buf(port, head, count);
522 mutex_unlock(&buf->lock);
526 static inline void tty_flip_buffer_commit(struct tty_buffer *tail)
529 * Paired w/ acquire in flush_to_ldisc(); ensures flush_to_ldisc() sees
532 smp_store_release(&tail->commit, tail->used);
536 * tty_flip_buffer_push - terminal
537 * @port: tty port to push
539 * Queue a push of the terminal flip buffers to the line discipline.
540 * Can be called from IRQ/atomic context.
542 * In the event of the queue being busy for flipping the work will be
543 * held off and retried later.
546 void tty_flip_buffer_push(struct tty_port *port)
548 struct tty_bufhead *buf = &port->buf;
550 tty_flip_buffer_commit(buf->tail);
551 queue_work(system_unbound_wq, &buf->work);
553 EXPORT_SYMBOL(tty_flip_buffer_push);
556 * tty_insert_flip_string_and_push_buffer - add characters to the tty buffer and
562 * The function combines tty_insert_flip_string() and tty_flip_buffer_push()
563 * with the exception of properly holding the @port->lock.
565 * To be used only internally (by pty currently).
567 * Returns: the number added.
569 int tty_insert_flip_string_and_push_buffer(struct tty_port *port,
570 const unsigned char *chars, size_t size)
572 struct tty_bufhead *buf = &port->buf;
575 spin_lock_irqsave(&port->lock, flags);
576 size = tty_insert_flip_string(port, chars, size);
578 tty_flip_buffer_commit(buf->tail);
579 spin_unlock_irqrestore(&port->lock, flags);
581 queue_work(system_unbound_wq, &buf->work);
587 * tty_buffer_init - prepare a tty buffer structure
588 * @port: tty port to initialise
590 * Set up the initial state of the buffer management for a tty device.
591 * Must be called before the other tty buffer functions are used.
594 void tty_buffer_init(struct tty_port *port)
596 struct tty_bufhead *buf = &port->buf;
598 mutex_init(&buf->lock);
599 tty_buffer_reset(&buf->sentinel, 0);
600 buf->head = &buf->sentinel;
601 buf->tail = &buf->sentinel;
602 init_llist_head(&buf->free);
603 atomic_set(&buf->mem_used, 0);
604 atomic_set(&buf->priority, 0);
605 INIT_WORK(&buf->work, flush_to_ldisc);
606 buf->mem_limit = TTYB_DEFAULT_MEM_LIMIT;
610 * tty_buffer_set_limit - change the tty buffer memory limit
611 * @port: tty port to change
613 * Change the tty buffer memory limit.
614 * Must be called before the other tty buffer functions are used.
617 int tty_buffer_set_limit(struct tty_port *port, int limit)
619 if (limit < MIN_TTYB_SIZE)
621 port->buf.mem_limit = limit;
624 EXPORT_SYMBOL_GPL(tty_buffer_set_limit);
626 /* slave ptys can claim nested buffer lock when handling BRK and INTR */
627 void tty_buffer_set_lock_subclass(struct tty_port *port)
629 lockdep_set_subclass(&port->buf.lock, TTY_LOCK_SLAVE);
632 bool tty_buffer_restart_work(struct tty_port *port)
634 return queue_work(system_unbound_wq, &port->buf.work);
637 bool tty_buffer_cancel_work(struct tty_port *port)
639 return cancel_work_sync(&port->buf.work);
642 void tty_buffer_flush_work(struct tty_port *port)
644 flush_work(&port->buf.work);