Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Tty buffer allocation management |
| 3 | */ |
| 4 | |
| 5 | #include <linux/types.h> |
| 6 | #include <linux/errno.h> |
| 7 | #include <linux/tty.h> |
| 8 | #include <linux/tty_driver.h> |
| 9 | #include <linux/tty_flip.h> |
| 10 | #include <linux/timer.h> |
| 11 | #include <linux/string.h> |
| 12 | #include <linux/slab.h> |
| 13 | #include <linux/sched.h> |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 14 | #include <linux/wait.h> |
| 15 | #include <linux/bitops.h> |
| 16 | #include <linux/delay.h> |
| 17 | #include <linux/module.h> |
George Spelvin | 593fb1ae4 | 2013-02-12 02:00:43 -0500 | [diff] [blame] | 18 | #include <linux/ratelimit.h> |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 19 | |
Peter Hurley | 1cef50e | 2013-06-15 09:36:02 -0400 | [diff] [blame] | 20 | |
| 21 | #define MIN_TTYB_SIZE 256 |
| 22 | #define TTYB_ALIGN_MASK 255 |
| 23 | |
Peter Hurley | 7bfe0b7 | 2013-06-15 09:36:08 -0400 | [diff] [blame] | 24 | /* |
| 25 | * Byte threshold to limit memory consumption for flip buffers. |
| 26 | * The actual memory limit is > 2x this amount. |
| 27 | */ |
Peter Hurley | 4d18e6ef | 2013-11-22 12:09:55 -0500 | [diff] [blame] | 28 | #define TTYB_DEFAULT_MEM_LIMIT 65536 |
Peter Hurley | 7bfe0b7 | 2013-06-15 09:36:08 -0400 | [diff] [blame] | 29 | |
Peter Hurley | 9114fe8 | 2013-06-15 09:36:16 -0400 | [diff] [blame] | 30 | /* |
| 31 | * We default to dicing tty buffer allocations to this many characters |
| 32 | * in order to avoid multiple page allocations. We know the size of |
| 33 | * tty_buffer itself but it must also be taken into account that the |
| 34 | * the buffer is 256 byte aligned. See tty_buffer_find for the allocation |
| 35 | * logic this must match |
| 36 | */ |
| 37 | |
| 38 | #define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF) |
| 39 | |
Peter Hurley | 7bfe0b7 | 2013-06-15 09:36:08 -0400 | [diff] [blame] | 40 | |
| 41 | /** |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 42 | * tty_buffer_lock_exclusive - gain exclusive access to buffer |
| 43 | * tty_buffer_unlock_exclusive - release exclusive access |
| 44 | * |
| 45 | * @port - tty_port owning the flip buffer |
| 46 | * |
| 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. |
| 51 | * |
| 52 | * On release, the buffer work is restarted if there is data in the |
| 53 | * flip buffer |
| 54 | */ |
| 55 | |
| 56 | void tty_buffer_lock_exclusive(struct tty_port *port) |
| 57 | { |
| 58 | struct tty_bufhead *buf = &port->buf; |
| 59 | |
| 60 | atomic_inc(&buf->priority); |
| 61 | mutex_lock(&buf->lock); |
| 62 | } |
| 63 | |
| 64 | void tty_buffer_unlock_exclusive(struct tty_port *port) |
| 65 | { |
| 66 | struct tty_bufhead *buf = &port->buf; |
| 67 | int restart; |
| 68 | |
| 69 | restart = buf->head->commit != buf->head->read; |
| 70 | |
| 71 | atomic_dec(&buf->priority); |
| 72 | mutex_unlock(&buf->lock); |
| 73 | if (restart) |
| 74 | queue_work(system_unbound_wq, &buf->work); |
| 75 | } |
| 76 | |
| 77 | /** |
Peter Hurley | 7bfe0b7 | 2013-06-15 09:36:08 -0400 | [diff] [blame] | 78 | * tty_buffer_space_avail - return unused buffer space |
| 79 | * @port - tty_port owning the flip buffer |
| 80 | * |
| 81 | * Returns the # of bytes which can be written by the driver without |
| 82 | * reaching the buffer limit. |
| 83 | * |
| 84 | * Note: this does not guarantee that memory is available to write |
| 85 | * the returned # of bytes (use tty_prepare_flip_string_xxx() to |
| 86 | * pre-allocate if memory guarantee is required). |
| 87 | */ |
| 88 | |
| 89 | int tty_buffer_space_avail(struct tty_port *port) |
| 90 | { |
Peter Hurley | 5dda4ca | 2013-11-22 12:09:56 -0500 | [diff] [blame] | 91 | int space = port->buf.mem_limit - atomic_read(&port->buf.mem_used); |
Peter Hurley | 7bfe0b7 | 2013-06-15 09:36:08 -0400 | [diff] [blame] | 92 | return max(space, 0); |
| 93 | } |
Peter Hurley | c4a8dab | 2013-11-22 13:06:08 -0500 | [diff] [blame] | 94 | EXPORT_SYMBOL_GPL(tty_buffer_space_avail); |
Peter Hurley | 7bfe0b7 | 2013-06-15 09:36:08 -0400 | [diff] [blame] | 95 | |
Peter Hurley | 9dd5139 | 2013-06-15 09:36:03 -0400 | [diff] [blame] | 96 | static void tty_buffer_reset(struct tty_buffer *p, size_t size) |
| 97 | { |
| 98 | p->used = 0; |
| 99 | p->size = size; |
| 100 | p->next = NULL; |
| 101 | p->commit = 0; |
| 102 | p->read = 0; |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 103 | p->flags = 0; |
Peter Hurley | 9dd5139 | 2013-06-15 09:36:03 -0400 | [diff] [blame] | 104 | } |
| 105 | |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 106 | /** |
| 107 | * tty_buffer_free_all - free buffers used by a tty |
| 108 | * @tty: tty to free from |
| 109 | * |
| 110 | * Remove all the buffers pending on a tty whether queued with data |
| 111 | * or in the free ring. Must be called when the tty is no longer in use |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 112 | */ |
| 113 | |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 114 | void tty_buffer_free_all(struct tty_port *port) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 115 | { |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 116 | struct tty_bufhead *buf = &port->buf; |
Peter Hurley | 809850b | 2013-06-15 09:36:06 -0400 | [diff] [blame] | 117 | struct tty_buffer *p, *next; |
| 118 | struct llist_node *llist; |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 119 | |
Peter Hurley | 2cf7b67 | 2013-06-15 09:36:05 -0400 | [diff] [blame] | 120 | while ((p = buf->head) != NULL) { |
| 121 | buf->head = p->next; |
Peter Hurley | 7391ee1 | 2013-06-15 09:36:07 -0400 | [diff] [blame] | 122 | if (p->size > 0) |
| 123 | kfree(p); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 124 | } |
Peter Hurley | 809850b | 2013-06-15 09:36:06 -0400 | [diff] [blame] | 125 | llist = llist_del_all(&buf->free); |
| 126 | llist_for_each_entry_safe(p, next, llist, free) |
Peter Hurley | 2cf7b67 | 2013-06-15 09:36:05 -0400 | [diff] [blame] | 127 | kfree(p); |
Peter Hurley | 809850b | 2013-06-15 09:36:06 -0400 | [diff] [blame] | 128 | |
Peter Hurley | 7391ee1 | 2013-06-15 09:36:07 -0400 | [diff] [blame] | 129 | tty_buffer_reset(&buf->sentinel, 0); |
| 130 | buf->head = &buf->sentinel; |
| 131 | buf->tail = &buf->sentinel; |
Peter Hurley | 7bfe0b7 | 2013-06-15 09:36:08 -0400 | [diff] [blame] | 132 | |
Peter Hurley | 5dda4ca | 2013-11-22 12:09:56 -0500 | [diff] [blame] | 133 | atomic_set(&buf->mem_used, 0); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 134 | } |
| 135 | |
| 136 | /** |
| 137 | * tty_buffer_alloc - allocate a tty buffer |
| 138 | * @tty: tty device |
| 139 | * @size: desired size (characters) |
| 140 | * |
| 141 | * Allocate a new tty buffer to hold the desired number of characters. |
Peter Hurley | 11b9faa | 2013-06-15 09:36:04 -0400 | [diff] [blame] | 142 | * We round our buffers off in 256 character chunks to get better |
| 143 | * allocation behaviour. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 144 | * Return NULL if out of memory or the allocation would exceed the |
| 145 | * per device queue |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 146 | */ |
| 147 | |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 148 | static struct tty_buffer *tty_buffer_alloc(struct tty_port *port, size_t size) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 149 | { |
Peter Hurley | 809850b | 2013-06-15 09:36:06 -0400 | [diff] [blame] | 150 | struct llist_node *free; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 151 | struct tty_buffer *p; |
| 152 | |
Peter Hurley | 11b9faa | 2013-06-15 09:36:04 -0400 | [diff] [blame] | 153 | /* Round the buffer size out */ |
| 154 | size = __ALIGN_MASK(size, TTYB_ALIGN_MASK); |
| 155 | |
| 156 | if (size <= MIN_TTYB_SIZE) { |
Peter Hurley | 809850b | 2013-06-15 09:36:06 -0400 | [diff] [blame] | 157 | free = llist_del_first(&port->buf.free); |
| 158 | if (free) { |
| 159 | p = llist_entry(free, struct tty_buffer, free); |
Peter Hurley | 11b9faa | 2013-06-15 09:36:04 -0400 | [diff] [blame] | 160 | goto found; |
| 161 | } |
| 162 | } |
| 163 | |
| 164 | /* Should possibly check if this fails for the largest buffer we |
| 165 | have queued and recycle that ? */ |
Peter Hurley | 5dda4ca | 2013-11-22 12:09:56 -0500 | [diff] [blame] | 166 | if (atomic_read(&port->buf.mem_used) > port->buf.mem_limit) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 167 | return NULL; |
| 168 | p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC); |
| 169 | if (p == NULL) |
| 170 | return NULL; |
Peter Hurley | 9dd5139 | 2013-06-15 09:36:03 -0400 | [diff] [blame] | 171 | |
Peter Hurley | 11b9faa | 2013-06-15 09:36:04 -0400 | [diff] [blame] | 172 | found: |
Peter Hurley | 9dd5139 | 2013-06-15 09:36:03 -0400 | [diff] [blame] | 173 | tty_buffer_reset(p, size); |
Peter Hurley | 5dda4ca | 2013-11-22 12:09:56 -0500 | [diff] [blame] | 174 | atomic_add(size, &port->buf.mem_used); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 175 | return p; |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * tty_buffer_free - free a tty buffer |
| 180 | * @tty: tty owning the buffer |
| 181 | * @b: the buffer to free |
| 182 | * |
| 183 | * Free a tty buffer, or add it to the free list according to our |
| 184 | * internal strategy |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 185 | */ |
| 186 | |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 187 | static void tty_buffer_free(struct tty_port *port, struct tty_buffer *b) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 188 | { |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 189 | struct tty_bufhead *buf = &port->buf; |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 190 | |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 191 | /* Dumb strategy for now - should keep some stats */ |
Peter Hurley | 5dda4ca | 2013-11-22 12:09:56 -0500 | [diff] [blame] | 192 | WARN_ON(atomic_sub_return(b->size, &buf->mem_used) < 0); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 193 | |
Peter Hurley | 1cef50e | 2013-06-15 09:36:02 -0400 | [diff] [blame] | 194 | if (b->size > MIN_TTYB_SIZE) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 195 | kfree(b); |
Peter Hurley | 7391ee1 | 2013-06-15 09:36:07 -0400 | [diff] [blame] | 196 | else if (b->size > 0) |
Peter Hurley | 809850b | 2013-06-15 09:36:06 -0400 | [diff] [blame] | 197 | llist_add(&b->free, &buf->free); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | /** |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 201 | * tty_buffer_flush - flush full tty buffers |
| 202 | * @tty: tty to flush |
| 203 | * |
Peter Hurley | 753023d | 2013-12-02 16:12:02 -0500 | [diff] [blame] | 204 | * flush all the buffers containing receive data. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 205 | * |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 206 | * Locking: takes buffer lock to ensure single-threaded flip buffer |
Peter Hurley | e9975fd | 2013-06-15 09:36:10 -0400 | [diff] [blame] | 207 | * 'consumer' |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 208 | */ |
| 209 | |
| 210 | void tty_buffer_flush(struct tty_struct *tty) |
| 211 | { |
Jiri Slaby | 2fc2066 | 2012-10-18 22:26:44 +0200 | [diff] [blame] | 212 | struct tty_port *port = tty->port; |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 213 | struct tty_bufhead *buf = &port->buf; |
Peter Hurley | 47aa658 | 2013-06-15 09:36:14 -0400 | [diff] [blame] | 214 | struct tty_buffer *next; |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 215 | |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 216 | atomic_inc(&buf->priority); |
Peter Hurley | e9975fd | 2013-06-15 09:36:10 -0400 | [diff] [blame] | 217 | |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 218 | mutex_lock(&buf->lock); |
Peter Hurley | 47aa658 | 2013-06-15 09:36:14 -0400 | [diff] [blame] | 219 | while ((next = buf->head->next) != NULL) { |
| 220 | tty_buffer_free(port, buf->head); |
| 221 | buf->head = next; |
| 222 | } |
| 223 | buf->head->read = buf->head->commit; |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 224 | atomic_dec(&buf->priority); |
| 225 | mutex_unlock(&buf->lock); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 226 | } |
| 227 | |
| 228 | /** |
Ilya Zykov | 64325a3 | 2013-01-19 18:16:20 +0400 | [diff] [blame] | 229 | * tty_buffer_request_room - grow tty buffer if needed |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 230 | * @tty: tty structure |
| 231 | * @size: size desired |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 232 | * @flags: buffer flags if new buffer allocated (default = 0) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 233 | * |
| 234 | * Make at least size bytes of linear space available for the tty |
| 235 | * buffer. If we fail return the size we managed to find. |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 236 | * |
| 237 | * Will change over to a new buffer if the current buffer is encoded as |
| 238 | * TTY_NORMAL (so has no flags buffer) and the new buffer requires |
| 239 | * a flags buffer. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 240 | */ |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 241 | static int __tty_buffer_request_room(struct tty_port *port, size_t size, |
| 242 | int flags) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 243 | { |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 244 | struct tty_bufhead *buf = &port->buf; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 245 | struct tty_buffer *b, *n; |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 246 | int left, change; |
Peter Hurley | e8437d7 | 2013-06-15 09:36:09 -0400 | [diff] [blame] | 247 | |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 248 | b = buf->tail; |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 249 | if (b->flags & TTYB_NORMAL) |
| 250 | left = 2 * b->size - b->used; |
| 251 | else |
| 252 | left = b->size - b->used; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 253 | |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 254 | change = (b->flags & TTYB_NORMAL) && (~flags & TTYB_NORMAL); |
| 255 | if (change || left < size) { |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 256 | /* This is the slow path - looking for new buffers to use */ |
Peter Hurley | 11b9faa | 2013-06-15 09:36:04 -0400 | [diff] [blame] | 257 | if ((n = tty_buffer_alloc(port, size)) != NULL) { |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 258 | unsigned long iflags; |
| 259 | |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 260 | n->flags = flags; |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 261 | buf->tail = n; |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 262 | |
| 263 | spin_lock_irqsave(&buf->flush_lock, iflags); |
Peter Hurley | e8437d7 | 2013-06-15 09:36:09 -0400 | [diff] [blame] | 264 | b->commit = b->used; |
Peter Hurley | e8437d7 | 2013-06-15 09:36:09 -0400 | [diff] [blame] | 265 | b->next = n; |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 266 | spin_unlock_irqrestore(&buf->flush_lock, iflags); |
| 267 | |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 268 | } else if (change) |
| 269 | size = 0; |
| 270 | else |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 271 | size = left; |
| 272 | } |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 273 | return size; |
| 274 | } |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 275 | |
| 276 | int tty_buffer_request_room(struct tty_port *port, size_t size) |
| 277 | { |
| 278 | return __tty_buffer_request_room(port, size, 0); |
| 279 | } |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 280 | EXPORT_SYMBOL_GPL(tty_buffer_request_room); |
| 281 | |
| 282 | /** |
Alan Cox | 2832fc1 | 2010-02-18 16:43:54 +0000 | [diff] [blame] | 283 | * tty_insert_flip_string_fixed_flag - Add characters to the tty buffer |
Jiri Slaby | 2f69335 | 2013-01-03 15:53:02 +0100 | [diff] [blame] | 284 | * @port: tty port |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 285 | * @chars: characters |
Alan Cox | 2832fc1 | 2010-02-18 16:43:54 +0000 | [diff] [blame] | 286 | * @flag: flag value for each character |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 287 | * @size: size |
| 288 | * |
| 289 | * Queue a series of bytes to the tty buffering. All the characters |
Johan Hovold | ccc5ca8 | 2010-05-07 19:58:32 +0200 | [diff] [blame] | 290 | * passed are marked with the supplied flag. Returns the number added. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 291 | */ |
| 292 | |
Jiri Slaby | 2f69335 | 2013-01-03 15:53:02 +0100 | [diff] [blame] | 293 | int tty_insert_flip_string_fixed_flag(struct tty_port *port, |
Alan Cox | 2832fc1 | 2010-02-18 16:43:54 +0000 | [diff] [blame] | 294 | const unsigned char *chars, char flag, size_t size) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 295 | { |
| 296 | int copied = 0; |
| 297 | do { |
Fang Wenqi | d4bee0a | 2010-03-09 18:54:28 +0800 | [diff] [blame] | 298 | int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE); |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 299 | int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0; |
| 300 | int space = __tty_buffer_request_room(port, goal, flags); |
Ilya Zykov | 64325a3 | 2013-01-19 18:16:20 +0400 | [diff] [blame] | 301 | struct tty_buffer *tb = port->buf.tail; |
Peter Hurley | 7391ee1 | 2013-06-15 09:36:07 -0400 | [diff] [blame] | 302 | if (unlikely(space == 0)) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 303 | break; |
Peter Hurley | 1fc359f | 2013-06-15 09:36:01 -0400 | [diff] [blame] | 304 | memcpy(char_buf_ptr(tb, tb->used), chars, space); |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 305 | if (~tb->flags & TTYB_NORMAL) |
| 306 | memset(flag_buf_ptr(tb, tb->used), flag, space); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 307 | tb->used += space; |
| 308 | copied += space; |
| 309 | chars += space; |
| 310 | /* There is a small chance that we need to split the data over |
| 311 | several buffers. If this is the case we must loop */ |
| 312 | } while (unlikely(size > copied)); |
| 313 | return copied; |
| 314 | } |
Alan Cox | 2832fc1 | 2010-02-18 16:43:54 +0000 | [diff] [blame] | 315 | EXPORT_SYMBOL(tty_insert_flip_string_fixed_flag); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 316 | |
| 317 | /** |
| 318 | * tty_insert_flip_string_flags - Add characters to the tty buffer |
Jiri Slaby | 2f69335 | 2013-01-03 15:53:02 +0100 | [diff] [blame] | 319 | * @port: tty port |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 320 | * @chars: characters |
| 321 | * @flags: flag bytes |
| 322 | * @size: size |
| 323 | * |
| 324 | * Queue a series of bytes to the tty buffering. For each character |
| 325 | * the flags array indicates the status of the character. Returns the |
| 326 | * number added. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 327 | */ |
| 328 | |
Jiri Slaby | 2f69335 | 2013-01-03 15:53:02 +0100 | [diff] [blame] | 329 | int tty_insert_flip_string_flags(struct tty_port *port, |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 330 | const unsigned char *chars, const char *flags, size_t size) |
| 331 | { |
| 332 | int copied = 0; |
| 333 | do { |
Fang Wenqi | d4bee0a | 2010-03-09 18:54:28 +0800 | [diff] [blame] | 334 | int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE); |
Ilya Zykov | 64325a3 | 2013-01-19 18:16:20 +0400 | [diff] [blame] | 335 | int space = tty_buffer_request_room(port, goal); |
| 336 | struct tty_buffer *tb = port->buf.tail; |
Peter Hurley | 7391ee1 | 2013-06-15 09:36:07 -0400 | [diff] [blame] | 337 | if (unlikely(space == 0)) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 338 | break; |
Peter Hurley | 1fc359f | 2013-06-15 09:36:01 -0400 | [diff] [blame] | 339 | memcpy(char_buf_ptr(tb, tb->used), chars, space); |
| 340 | memcpy(flag_buf_ptr(tb, tb->used), flags, space); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 341 | tb->used += space; |
| 342 | copied += space; |
| 343 | chars += space; |
| 344 | flags += space; |
| 345 | /* There is a small chance that we need to split the data over |
| 346 | several buffers. If this is the case we must loop */ |
| 347 | } while (unlikely(size > copied)); |
| 348 | return copied; |
| 349 | } |
| 350 | EXPORT_SYMBOL(tty_insert_flip_string_flags); |
| 351 | |
| 352 | /** |
| 353 | * tty_schedule_flip - push characters to ldisc |
Jiri Slaby | 6732c8b | 2013-01-03 15:53:07 +0100 | [diff] [blame] | 354 | * @port: tty port to push from |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 355 | * |
| 356 | * Takes any pending buffers and transfers their ownership to the |
| 357 | * ldisc side of the queue. It then schedules those characters for |
| 358 | * processing by the line discipline. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 359 | */ |
| 360 | |
Jiri Slaby | 6732c8b | 2013-01-03 15:53:07 +0100 | [diff] [blame] | 361 | void tty_schedule_flip(struct tty_port *port) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 362 | { |
Jiri Slaby | 6732c8b | 2013-01-03 15:53:07 +0100 | [diff] [blame] | 363 | struct tty_bufhead *buf = &port->buf; |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 364 | |
Peter Hurley | 7391ee1 | 2013-06-15 09:36:07 -0400 | [diff] [blame] | 365 | buf->tail->commit = buf->tail->used; |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 366 | schedule_work(&buf->work); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 367 | } |
| 368 | EXPORT_SYMBOL(tty_schedule_flip); |
| 369 | |
| 370 | /** |
| 371 | * tty_prepare_flip_string - make room for characters |
Jiri Slaby | 2f69335 | 2013-01-03 15:53:02 +0100 | [diff] [blame] | 372 | * @port: tty port |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 373 | * @chars: return pointer for character write area |
| 374 | * @size: desired size |
| 375 | * |
| 376 | * Prepare a block of space in the buffer for data. Returns the length |
| 377 | * available and buffer pointer to the space which is now allocated and |
| 378 | * accounted for as ready for normal characters. This is used for drivers |
| 379 | * that need their own block copy routines into the buffer. There is no |
| 380 | * guarantee the buffer is a DMA target! |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 381 | */ |
| 382 | |
Jiri Slaby | 2f69335 | 2013-01-03 15:53:02 +0100 | [diff] [blame] | 383 | int tty_prepare_flip_string(struct tty_port *port, unsigned char **chars, |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 384 | size_t size) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 385 | { |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 386 | int space = __tty_buffer_request_room(port, size, TTYB_NORMAL); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 387 | if (likely(space)) { |
Ilya Zykov | 64325a3 | 2013-01-19 18:16:20 +0400 | [diff] [blame] | 388 | struct tty_buffer *tb = port->buf.tail; |
Peter Hurley | 1fc359f | 2013-06-15 09:36:01 -0400 | [diff] [blame] | 389 | *chars = char_buf_ptr(tb, tb->used); |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 390 | if (~tb->flags & TTYB_NORMAL) |
| 391 | memset(flag_buf_ptr(tb, tb->used), TTY_NORMAL, space); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 392 | tb->used += space; |
| 393 | } |
| 394 | return space; |
| 395 | } |
| 396 | EXPORT_SYMBOL_GPL(tty_prepare_flip_string); |
| 397 | |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 398 | |
Peter Hurley | da261e7 | 2013-06-15 09:14:14 -0400 | [diff] [blame] | 399 | static int |
| 400 | receive_buf(struct tty_struct *tty, struct tty_buffer *head, int count) |
| 401 | { |
| 402 | struct tty_ldisc *disc = tty->ldisc; |
Peter Hurley | 1fc359f | 2013-06-15 09:36:01 -0400 | [diff] [blame] | 403 | unsigned char *p = char_buf_ptr(head, head->read); |
Peter Hurley | acc0f67 | 2013-12-09 09:23:52 -0500 | [diff] [blame] | 404 | char *f = NULL; |
| 405 | |
| 406 | if (~head->flags & TTYB_NORMAL) |
| 407 | f = flag_buf_ptr(head, head->read); |
Peter Hurley | da261e7 | 2013-06-15 09:14:14 -0400 | [diff] [blame] | 408 | |
Peter Hurley | 24a89d1 | 2013-06-15 09:14:15 -0400 | [diff] [blame] | 409 | if (disc->ops->receive_buf2) |
| 410 | count = disc->ops->receive_buf2(tty, p, f, count); |
| 411 | else { |
| 412 | count = min_t(int, count, tty->receive_room); |
| 413 | if (count) |
| 414 | disc->ops->receive_buf(tty, p, f, count); |
| 415 | } |
Peter Hurley | da261e7 | 2013-06-15 09:14:14 -0400 | [diff] [blame] | 416 | head->read += count; |
| 417 | return count; |
| 418 | } |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 419 | |
| 420 | /** |
| 421 | * flush_to_ldisc |
| 422 | * @work: tty structure passed from work queue. |
| 423 | * |
| 424 | * This routine is called out of the software interrupt to flush data |
| 425 | * from the buffer chain to the line discipline. |
| 426 | * |
Peter Hurley | e9975fd | 2013-06-15 09:36:10 -0400 | [diff] [blame] | 427 | * The receive_buf method is single threaded for each tty instance. |
| 428 | * |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 429 | * Locking: takes buffer lock to ensure single-threaded flip buffer |
Peter Hurley | e9975fd | 2013-06-15 09:36:10 -0400 | [diff] [blame] | 430 | * 'consumer' |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 431 | */ |
| 432 | |
| 433 | static void flush_to_ldisc(struct work_struct *work) |
| 434 | { |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 435 | struct tty_port *port = container_of(work, struct tty_port, buf.work); |
| 436 | struct tty_bufhead *buf = &port->buf; |
| 437 | struct tty_struct *tty; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 438 | struct tty_ldisc *disc; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 439 | |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 440 | tty = port->itty; |
Jiri Slaby | 34dcfb8 | 2013-02-27 22:30:24 +0100 | [diff] [blame] | 441 | if (tty == NULL) |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 442 | return; |
| 443 | |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 444 | disc = tty_ldisc_ref(tty); |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 445 | if (disc == NULL) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 446 | return; |
| 447 | |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 448 | mutex_lock(&buf->lock); |
Linus Torvalds | 4524200 | 2009-10-14 08:59:49 -0700 | [diff] [blame] | 449 | |
Peter Hurley | d7a68be | 2013-06-15 09:36:11 -0400 | [diff] [blame] | 450 | while (1) { |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 451 | unsigned long flags; |
Peter Hurley | d7a68be | 2013-06-15 09:36:11 -0400 | [diff] [blame] | 452 | struct tty_buffer *head = buf->head; |
| 453 | int count; |
Linus Torvalds | 4524200 | 2009-10-14 08:59:49 -0700 | [diff] [blame] | 454 | |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 455 | /* Ldisc or user is trying to gain exclusive access */ |
| 456 | if (atomic_read(&buf->priority)) |
Peter Hurley | d7a68be | 2013-06-15 09:36:11 -0400 | [diff] [blame] | 457 | break; |
Peter Hurley | e9975fd | 2013-06-15 09:36:10 -0400 | [diff] [blame] | 458 | |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 459 | spin_lock_irqsave(&buf->flush_lock, flags); |
Peter Hurley | d7a68be | 2013-06-15 09:36:11 -0400 | [diff] [blame] | 460 | count = head->commit - head->read; |
| 461 | if (!count) { |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 462 | if (head->next == NULL) { |
| 463 | spin_unlock_irqrestore(&buf->flush_lock, flags); |
Peter Hurley | 39f610e | 2013-03-20 13:20:43 -0400 | [diff] [blame] | 464 | break; |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 465 | } |
Peter Hurley | d7a68be | 2013-06-15 09:36:11 -0400 | [diff] [blame] | 466 | buf->head = head->next; |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 467 | spin_unlock_irqrestore(&buf->flush_lock, flags); |
Peter Hurley | d7a68be | 2013-06-15 09:36:11 -0400 | [diff] [blame] | 468 | tty_buffer_free(port, head); |
| 469 | continue; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 470 | } |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 471 | spin_unlock_irqrestore(&buf->flush_lock, flags); |
Peter Hurley | d7a68be | 2013-06-15 09:36:11 -0400 | [diff] [blame] | 472 | |
| 473 | count = receive_buf(tty, head, count); |
| 474 | if (!count) |
| 475 | break; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 476 | } |
Linus Torvalds | 4524200 | 2009-10-14 08:59:49 -0700 | [diff] [blame] | 477 | |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 478 | mutex_unlock(&buf->lock); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 479 | |
| 480 | tty_ldisc_deref(disc); |
| 481 | } |
| 482 | |
| 483 | /** |
OGAWA Hirofumi | e043e42 | 2009-07-29 12:15:56 -0700 | [diff] [blame] | 484 | * tty_flush_to_ldisc |
| 485 | * @tty: tty to push |
| 486 | * |
| 487 | * Push the terminal flip buffers to the line discipline. |
| 488 | * |
| 489 | * Must not be called from IRQ context. |
| 490 | */ |
| 491 | void tty_flush_to_ldisc(struct tty_struct *tty) |
| 492 | { |
Peter Hurley | a9c3f68 | 2014-02-22 07:31:21 -0500 | [diff] [blame] | 493 | flush_work(&tty->port->buf.work); |
OGAWA Hirofumi | e043e42 | 2009-07-29 12:15:56 -0700 | [diff] [blame] | 494 | } |
| 495 | |
| 496 | /** |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 497 | * tty_flip_buffer_push - terminal |
Jiri Slaby | 2e124b4 | 2013-01-03 15:53:06 +0100 | [diff] [blame] | 498 | * @port: tty port to push |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 499 | * |
Peter Hurley | a9c3f68 | 2014-02-22 07:31:21 -0500 | [diff] [blame] | 500 | * Queue a push of the terminal flip buffers to the line discipline. |
| 501 | * Can be called from IRQ/atomic context. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 502 | * |
| 503 | * In the event of the queue being busy for flipping the work will be |
| 504 | * held off and retried later. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 505 | */ |
| 506 | |
Jiri Slaby | 2e124b4 | 2013-01-03 15:53:06 +0100 | [diff] [blame] | 507 | void tty_flip_buffer_push(struct tty_port *port) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 508 | { |
Peter Hurley | a9c3f68 | 2014-02-22 07:31:21 -0500 | [diff] [blame] | 509 | tty_schedule_flip(port); |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 510 | } |
| 511 | EXPORT_SYMBOL(tty_flip_buffer_push); |
| 512 | |
| 513 | /** |
| 514 | * tty_buffer_init - prepare a tty buffer structure |
| 515 | * @tty: tty to initialise |
| 516 | * |
| 517 | * Set up the initial state of the buffer management for a tty device. |
| 518 | * Must be called before the other tty buffer functions are used. |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 519 | */ |
| 520 | |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 521 | void tty_buffer_init(struct tty_port *port) |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 522 | { |
Jiri Slaby | ecbbfd4 | 2012-10-18 22:26:47 +0200 | [diff] [blame] | 523 | struct tty_bufhead *buf = &port->buf; |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 524 | |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 525 | mutex_init(&buf->lock); |
Manfred Schlaegl | 6a20dbd | 2014-04-08 14:42:04 +0200 | [diff] [blame^] | 526 | spin_lock_init(&buf->flush_lock); |
Peter Hurley | 7391ee1 | 2013-06-15 09:36:07 -0400 | [diff] [blame] | 527 | tty_buffer_reset(&buf->sentinel, 0); |
| 528 | buf->head = &buf->sentinel; |
| 529 | buf->tail = &buf->sentinel; |
Peter Hurley | 809850b | 2013-06-15 09:36:06 -0400 | [diff] [blame] | 530 | init_llist_head(&buf->free); |
Peter Hurley | 5dda4ca | 2013-11-22 12:09:56 -0500 | [diff] [blame] | 531 | atomic_set(&buf->mem_used, 0); |
Peter Hurley | a7c8d58 | 2013-06-15 09:36:15 -0400 | [diff] [blame] | 532 | atomic_set(&buf->priority, 0); |
Jiri Slaby | 5cff39c | 2012-10-18 22:26:45 +0200 | [diff] [blame] | 533 | INIT_WORK(&buf->work, flush_to_ldisc); |
Peter Hurley | 4d18e6ef | 2013-11-22 12:09:55 -0500 | [diff] [blame] | 534 | buf->mem_limit = TTYB_DEFAULT_MEM_LIMIT; |
Alan Cox | e049573 | 2008-10-13 10:36:58 +0100 | [diff] [blame] | 535 | } |
Peter Hurley | 4d18e6ef | 2013-11-22 12:09:55 -0500 | [diff] [blame] | 536 | |
| 537 | /** |
| 538 | * tty_buffer_set_limit - change the tty buffer memory limit |
| 539 | * @port: tty port to change |
| 540 | * |
| 541 | * Change the tty buffer memory limit. |
| 542 | * Must be called before the other tty buffer functions are used. |
| 543 | */ |
| 544 | |
| 545 | int tty_buffer_set_limit(struct tty_port *port, int limit) |
| 546 | { |
| 547 | if (limit < MIN_TTYB_SIZE) |
| 548 | return -EINVAL; |
| 549 | port->buf.mem_limit = limit; |
| 550 | return 0; |
| 551 | } |
| 552 | EXPORT_SYMBOL_GPL(tty_buffer_set_limit); |