tty_buffer.c 15.3 KB
Newer Older
A
Alan Cox 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * Tty buffer allocation management
 */

#include <linux/types.h>
#include <linux/errno.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/timer.h>
#include <linux/string.h>
#include <linux/slab.h>
#include <linux/sched.h>
#include <linux/wait.h>
#include <linux/bitops.h>
#include <linux/delay.h>
#include <linux/module.h>
18
#include <linux/ratelimit.h>
A
Alan Cox 已提交
19

P
Peter Hurley 已提交
20 21 22 23

#define MIN_TTYB_SIZE	256
#define TTYB_ALIGN_MASK	255

24 25 26 27
/*
 * Byte threshold to limit memory consumption for flip buffers.
 * The actual memory limit is > 2x this amount.
 */
28
#define TTYB_DEFAULT_MEM_LIMIT	65536
29

30 31 32 33 34 35 36 37 38 39
/*
 * We default to dicing tty buffer allocations to this many characters
 * in order to avoid multiple page allocations. We know the size of
 * tty_buffer itself but it must also be taken into account that the
 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation
 * logic this must match
 */

#define TTY_BUFFER_PAGE	(((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)

P
Peter Hurley 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/*
 * If all tty flip buffers have been processed by flush_to_ldisc() or
 * dropped by tty_buffer_flush(), check if the linked pty has been closed.
 * If so, wake the reader/poll to process
 */
static inline void check_other_closed(struct tty_struct *tty)
{
	unsigned long flags, old;

	/* transition from TTY_OTHER_CLOSED => TTY_OTHER_DONE must be atomic */
	for (flags = ACCESS_ONCE(tty->flags);
	     test_bit(TTY_OTHER_CLOSED, &flags);
	     ) {
		old = flags;
		__set_bit(TTY_OTHER_DONE, &flags);
		flags = cmpxchg(&tty->flags, old, flags);
		if (old == flags) {
			wake_up_interruptible(&tty->read_wait);
			break;
		}
	}
}
62

63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
/**
 *	tty_buffer_lock_exclusive	-	gain exclusive access to buffer
 *	tty_buffer_unlock_exclusive	-	release exclusive access
 *
 *	@port - tty_port owning the flip buffer
 *
 *	Guarantees safe use of the line discipline's receive_buf() method by
 *	excluding the buffer work and any pending flush from using the flip
 *	buffer. Data can continue to be added concurrently to the flip buffer
 *	from the driver side.
 *
 *	On release, the buffer work is restarted if there is data in the
 *	flip buffer
 */

void tty_buffer_lock_exclusive(struct tty_port *port)
{
	struct tty_bufhead *buf = &port->buf;

	atomic_inc(&buf->priority);
	mutex_lock(&buf->lock);
}
85
EXPORT_SYMBOL_GPL(tty_buffer_lock_exclusive);
86 87 88 89 90 91 92 93 94 95 96 97 98

void tty_buffer_unlock_exclusive(struct tty_port *port)
{
	struct tty_bufhead *buf = &port->buf;
	int restart;

	restart = buf->head->commit != buf->head->read;

	atomic_dec(&buf->priority);
	mutex_unlock(&buf->lock);
	if (restart)
		queue_work(system_unbound_wq, &buf->work);
}
99
EXPORT_SYMBOL_GPL(tty_buffer_unlock_exclusive);
100

101 102 103 104 105 106 107 108 109 110 111 112 113 114
/**
 *	tty_buffer_space_avail	-	return unused buffer space
 *	@port - tty_port owning the flip buffer
 *
 *	Returns the # of bytes which can be written by the driver without
 *	reaching the buffer limit.
 *
 *	Note: this does not guarantee that memory is available to write
 *	the returned # of bytes (use tty_prepare_flip_string_xxx() to
 *	pre-allocate if memory guarantee is required).
 */

int tty_buffer_space_avail(struct tty_port *port)
{
115
	int space = port->buf.mem_limit - atomic_read(&port->buf.mem_used);
116 117
	return max(space, 0);
}
118
EXPORT_SYMBOL_GPL(tty_buffer_space_avail);
119

120 121 122 123 124 125 126
static void tty_buffer_reset(struct tty_buffer *p, size_t size)
{
	p->used = 0;
	p->size = size;
	p->next = NULL;
	p->commit = 0;
	p->read = 0;
127
	p->flags = 0;
128 129
}

A
Alan Cox 已提交
130 131 132 133 134 135 136 137
/**
 *	tty_buffer_free_all		-	free buffers used by a tty
 *	@tty: tty to free from
 *
 *	Remove all the buffers pending on a tty whether queued with data
 *	or in the free ring. Must be called when the tty is no longer in use
 */

J
Jiri Slaby 已提交
138
void tty_buffer_free_all(struct tty_port *port)
A
Alan Cox 已提交
139
{
J
Jiri Slaby 已提交
140
	struct tty_bufhead *buf = &port->buf;
141 142
	struct tty_buffer *p, *next;
	struct llist_node *llist;
143

144 145
	while ((p = buf->head) != NULL) {
		buf->head = p->next;
146 147
		if (p->size > 0)
			kfree(p);
A
Alan Cox 已提交
148
	}
149 150
	llist = llist_del_all(&buf->free);
	llist_for_each_entry_safe(p, next, llist, free)
151
		kfree(p);
152

153 154 155
	tty_buffer_reset(&buf->sentinel, 0);
	buf->head = &buf->sentinel;
	buf->tail = &buf->sentinel;
156

157
	atomic_set(&buf->mem_used, 0);
A
Alan Cox 已提交
158 159 160 161 162 163 164 165
}

/**
 *	tty_buffer_alloc	-	allocate a tty buffer
 *	@tty: tty device
 *	@size: desired size (characters)
 *
 *	Allocate a new tty buffer to hold the desired number of characters.
166 167
 *	We round our buffers off in 256 character chunks to get better
 *	allocation behaviour.
A
Alan Cox 已提交
168 169 170 171
 *	Return NULL if out of memory or the allocation would exceed the
 *	per device queue
 */

J
Jiri Slaby 已提交
172
static struct tty_buffer *tty_buffer_alloc(struct tty_port *port, size_t size)
A
Alan Cox 已提交
173
{
174
	struct llist_node *free;
A
Alan Cox 已提交
175 176
	struct tty_buffer *p;

177 178 179 180
	/* Round the buffer size out */
	size = __ALIGN_MASK(size, TTYB_ALIGN_MASK);

	if (size <= MIN_TTYB_SIZE) {
181 182 183
		free = llist_del_first(&port->buf.free);
		if (free) {
			p = llist_entry(free, struct tty_buffer, free);
184 185 186 187 188 189
			goto found;
		}
	}

	/* Should possibly check if this fails for the largest buffer we
	   have queued and recycle that ? */
190
	if (atomic_read(&port->buf.mem_used) > port->buf.mem_limit)
A
Alan Cox 已提交
191 192 193 194
		return NULL;
	p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
	if (p == NULL)
		return NULL;
195

196
found:
197
	tty_buffer_reset(p, size);
198
	atomic_add(size, &port->buf.mem_used);
A
Alan Cox 已提交
199 200 201 202 203 204 205 206 207 208 209 210
	return p;
}

/**
 *	tty_buffer_free		-	free a tty buffer
 *	@tty: tty owning the buffer
 *	@b: the buffer to free
 *
 *	Free a tty buffer, or add it to the free list according to our
 *	internal strategy
 */

J
Jiri Slaby 已提交
211
static void tty_buffer_free(struct tty_port *port, struct tty_buffer *b)
A
Alan Cox 已提交
212
{
J
Jiri Slaby 已提交
213
	struct tty_bufhead *buf = &port->buf;
214

A
Alan Cox 已提交
215
	/* Dumb strategy for now - should keep some stats */
216
	WARN_ON(atomic_sub_return(b->size, &buf->mem_used) < 0);
A
Alan Cox 已提交
217

P
Peter Hurley 已提交
218
	if (b->size > MIN_TTYB_SIZE)
A
Alan Cox 已提交
219
		kfree(b);
220
	else if (b->size > 0)
221
		llist_add(&b->free, &buf->free);
A
Alan Cox 已提交
222 223 224 225 226
}

/**
 *	tty_buffer_flush		-	flush full tty buffers
 *	@tty: tty to flush
227
 *	@ld:  optional ldisc ptr (must be referenced)
A
Alan Cox 已提交
228
 *
229 230
 *	flush all the buffers containing receive data. If ld != NULL,
 *	flush the ldisc input buffer.
A
Alan Cox 已提交
231
 *
232
 *	Locking: takes buffer lock to ensure single-threaded flip buffer
233
 *		 'consumer'
A
Alan Cox 已提交
234 235
 */

236
void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld)
A
Alan Cox 已提交
237
{
238
	struct tty_port *port = tty->port;
J
Jiri Slaby 已提交
239
	struct tty_bufhead *buf = &port->buf;
240
	struct tty_buffer *next;
A
Alan Cox 已提交
241

242
	atomic_inc(&buf->priority);
243

244
	mutex_lock(&buf->lock);
245 246 247 248
	/* paired w/ release in __tty_buffer_request_room; ensures there are
	 * no pending memory accesses to the freed buffer
	 */
	while ((next = smp_load_acquire(&buf->head->next)) != NULL) {
249 250 251 252
		tty_buffer_free(port, buf->head);
		buf->head = next;
	}
	buf->head->read = buf->head->commit;
253 254 255 256

	if (ld && ld->ops->flush_buffer)
		ld->ops->flush_buffer(tty);

P
Peter Hurley 已提交
257 258
	check_other_closed(tty);

259 260
	atomic_dec(&buf->priority);
	mutex_unlock(&buf->lock);
A
Alan Cox 已提交
261 262 263
}

/**
I
Ilya Zykov 已提交
264
 *	tty_buffer_request_room		-	grow tty buffer if needed
A
Alan Cox 已提交
265 266
 *	@tty: tty structure
 *	@size: size desired
267
 *	@flags: buffer flags if new buffer allocated (default = 0)
A
Alan Cox 已提交
268 269 270
 *
 *	Make at least size bytes of linear space available for the tty
 *	buffer. If we fail return the size we managed to find.
271 272 273 274
 *
 *	Will change over to a new buffer if the current buffer is encoded as
 *	TTY_NORMAL (so has no flags buffer) and the new buffer requires
 *	a flags buffer.
A
Alan Cox 已提交
275
 */
276 277
static int __tty_buffer_request_room(struct tty_port *port, size_t size,
				     int flags)
A
Alan Cox 已提交
278
{
J
Jiri Slaby 已提交
279
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
280
	struct tty_buffer *b, *n;
281
	int left, change;
282

283
	b = buf->tail;
284 285 286 287
	if (b->flags & TTYB_NORMAL)
		left = 2 * b->size - b->used;
	else
		left = b->size - b->used;
A
Alan Cox 已提交
288

289 290
	change = (b->flags & TTYB_NORMAL) && (~flags & TTYB_NORMAL);
	if (change || left < size) {
A
Alan Cox 已提交
291
		/* This is the slow path - looking for new buffers to use */
292 293
		n = tty_buffer_alloc(port, size);
		if (n != NULL) {
294
			n->flags = flags;
295
			buf->tail = n;
296 297 298 299
			/* paired w/ acquire in flush_to_ldisc(); ensures
			 * flush_to_ldisc() sees buffer data.
			 */
			smp_store_release(&b->commit, b->used);
300
			/* paired w/ acquire in flush_to_ldisc(); ensures the
P
Peter Hurley 已提交
301 302 303
			 * latest commit value can be read before the head is
			 * advanced to the next buffer
			 */
304
			smp_store_release(&b->next, n);
305 306 307
		} else if (change)
			size = 0;
		else
A
Alan Cox 已提交
308 309 310 311
			size = left;
	}
	return size;
}
312 313 314 315 316

int tty_buffer_request_room(struct tty_port *port, size_t size)
{
	return __tty_buffer_request_room(port, size, 0);
}
A
Alan Cox 已提交
317 318 319
EXPORT_SYMBOL_GPL(tty_buffer_request_room);

/**
320
 *	tty_insert_flip_string_fixed_flag - Add characters to the tty buffer
321
 *	@port: tty port
A
Alan Cox 已提交
322
 *	@chars: characters
323
 *	@flag: flag value for each character
A
Alan Cox 已提交
324 325 326
 *	@size: size
 *
 *	Queue a series of bytes to the tty buffering. All the characters
327
 *	passed are marked with the supplied flag. Returns the number added.
A
Alan Cox 已提交
328 329
 */

330
int tty_insert_flip_string_fixed_flag(struct tty_port *port,
331
		const unsigned char *chars, char flag, size_t size)
A
Alan Cox 已提交
332 333 334
{
	int copied = 0;
	do {
335
		int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
336 337
		int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0;
		int space = __tty_buffer_request_room(port, goal, flags);
I
Ilya Zykov 已提交
338
		struct tty_buffer *tb = port->buf.tail;
339
		if (unlikely(space == 0))
A
Alan Cox 已提交
340
			break;
P
Peter Hurley 已提交
341
		memcpy(char_buf_ptr(tb, tb->used), chars, space);
342 343
		if (~tb->flags & TTYB_NORMAL)
			memset(flag_buf_ptr(tb, tb->used), flag, space);
A
Alan Cox 已提交
344 345 346 347 348 349 350 351
		tb->used += space;
		copied += space;
		chars += space;
		/* There is a small chance that we need to split the data over
		   several buffers. If this is the case we must loop */
	} while (unlikely(size > copied));
	return copied;
}
352
EXPORT_SYMBOL(tty_insert_flip_string_fixed_flag);
A
Alan Cox 已提交
353 354 355

/**
 *	tty_insert_flip_string_flags	-	Add characters to the tty buffer
356
 *	@port: tty port
A
Alan Cox 已提交
357 358 359 360 361 362 363 364 365
 *	@chars: characters
 *	@flags: flag bytes
 *	@size: size
 *
 *	Queue a series of bytes to the tty buffering. For each character
 *	the flags array indicates the status of the character. Returns the
 *	number added.
 */

366
int tty_insert_flip_string_flags(struct tty_port *port,
A
Alan Cox 已提交
367 368 369 370
		const unsigned char *chars, const char *flags, size_t size)
{
	int copied = 0;
	do {
371
		int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
I
Ilya Zykov 已提交
372 373
		int space = tty_buffer_request_room(port, goal);
		struct tty_buffer *tb = port->buf.tail;
374
		if (unlikely(space == 0))
A
Alan Cox 已提交
375
			break;
P
Peter Hurley 已提交
376 377
		memcpy(char_buf_ptr(tb, tb->used), chars, space);
		memcpy(flag_buf_ptr(tb, tb->used), flags, space);
A
Alan Cox 已提交
378 379 380 381 382 383 384 385 386 387 388 389 390
		tb->used += space;
		copied += space;
		chars += space;
		flags += space;
		/* There is a small chance that we need to split the data over
		   several buffers. If this is the case we must loop */
	} while (unlikely(size > copied));
	return copied;
}
EXPORT_SYMBOL(tty_insert_flip_string_flags);

/**
 *	tty_schedule_flip	-	push characters to ldisc
J
Jiri Slaby 已提交
391
 *	@port: tty port to push from
A
Alan Cox 已提交
392 393 394 395 396 397
 *
 *	Takes any pending buffers and transfers their ownership to the
 *	ldisc side of the queue. It then schedules those characters for
 *	processing by the line discipline.
 */

J
Jiri Slaby 已提交
398
void tty_schedule_flip(struct tty_port *port)
A
Alan Cox 已提交
399
{
J
Jiri Slaby 已提交
400
	struct tty_bufhead *buf = &port->buf;
401

402 403 404 405
	/* paired w/ acquire in flush_to_ldisc(); ensures
	 * flush_to_ldisc() sees buffer data.
	 */
	smp_store_release(&buf->tail->commit, buf->tail->used);
406
	schedule_work(&buf->work);
A
Alan Cox 已提交
407 408 409 410 411
}
EXPORT_SYMBOL(tty_schedule_flip);

/**
 *	tty_prepare_flip_string		-	make room for characters
412
 *	@port: tty port
A
Alan Cox 已提交
413 414 415 416 417 418 419 420 421 422
 *	@chars: return pointer for character write area
 *	@size: desired size
 *
 *	Prepare a block of space in the buffer for data. Returns the length
 *	available and buffer pointer to the space which is now allocated and
 *	accounted for as ready for normal characters. This is used for drivers
 *	that need their own block copy routines into the buffer. There is no
 *	guarantee the buffer is a DMA target!
 */

423
int tty_prepare_flip_string(struct tty_port *port, unsigned char **chars,
J
Jiri Slaby 已提交
424
		size_t size)
A
Alan Cox 已提交
425
{
426
	int space = __tty_buffer_request_room(port, size, TTYB_NORMAL);
A
Alan Cox 已提交
427
	if (likely(space)) {
I
Ilya Zykov 已提交
428
		struct tty_buffer *tb = port->buf.tail;
P
Peter Hurley 已提交
429
		*chars = char_buf_ptr(tb, tb->used);
430 431
		if (~tb->flags & TTYB_NORMAL)
			memset(flag_buf_ptr(tb, tb->used), TTY_NORMAL, space);
A
Alan Cox 已提交
432 433 434 435 436 437 438
		tb->used += space;
	}
	return space;
}
EXPORT_SYMBOL_GPL(tty_prepare_flip_string);


439 440 441 442
static int
receive_buf(struct tty_struct *tty, struct tty_buffer *head, int count)
{
	struct tty_ldisc *disc = tty->ldisc;
P
Peter Hurley 已提交
443
	unsigned char *p = char_buf_ptr(head, head->read);
444 445 446 447
	char	      *f = NULL;

	if (~head->flags & TTYB_NORMAL)
		f = flag_buf_ptr(head, head->read);
448

449 450 451 452 453 454 455
	if (disc->ops->receive_buf2)
		count = disc->ops->receive_buf2(tty, p, f, count);
	else {
		count = min_t(int, count, tty->receive_room);
		if (count)
			disc->ops->receive_buf(tty, p, f, count);
	}
456 457
	return count;
}
A
Alan Cox 已提交
458 459 460 461 462 463 464 465

/**
 *	flush_to_ldisc
 *	@work: tty structure passed from work queue.
 *
 *	This routine is called out of the software interrupt to flush data
 *	from the buffer chain to the line discipline.
 *
466 467
 *	The receive_buf method is single threaded for each tty instance.
 *
468
 *	Locking: takes buffer lock to ensure single-threaded flip buffer
469
 *		 'consumer'
A
Alan Cox 已提交
470 471 472 473
 */

static void flush_to_ldisc(struct work_struct *work)
{
J
Jiri Slaby 已提交
474 475 476
	struct tty_port *port = container_of(work, struct tty_port, buf.work);
	struct tty_bufhead *buf = &port->buf;
	struct tty_struct *tty;
A
Alan Cox 已提交
477 478
	struct tty_ldisc *disc;

479
	tty = READ_ONCE(port->itty);
J
Jiri Slaby 已提交
480
	if (tty == NULL)
J
Jiri Slaby 已提交
481 482
		return;

A
Alan Cox 已提交
483
	disc = tty_ldisc_ref(tty);
484
	if (disc == NULL)
A
Alan Cox 已提交
485 486
		return;

487
	mutex_lock(&buf->lock);
488

489 490
	while (1) {
		struct tty_buffer *head = buf->head;
P
Peter Hurley 已提交
491
		struct tty_buffer *next;
492 493
		int count;

494 495
		/* Ldisc or user is trying to gain exclusive access */
		if (atomic_read(&buf->priority))
496 497
			break;

498
		/* paired w/ release in __tty_buffer_request_room();
P
Peter Hurley 已提交
499 500 501
		 * ensures commit value read is not stale if the head
		 * is advancing to the next buffer
		 */
502
		next = smp_load_acquire(&head->next);
503 504 505 506
		/* paired w/ release in __tty_buffer_request_room() or in
		 * tty_buffer_flush(); ensures we see the committed buffer data
		 */
		count = smp_load_acquire(&head->commit) - head->read;
507
		if (!count) {
P
Peter Hurley 已提交
508 509
			if (next == NULL) {
				check_other_closed(tty);
510
				break;
P
Peter Hurley 已提交
511
			}
P
Peter Hurley 已提交
512
			buf->head = next;
513 514
			tty_buffer_free(port, head);
			continue;
A
Alan Cox 已提交
515
		}
516 517 518 519

		count = receive_buf(tty, head, count);
		if (!count)
			break;
520
		head->read += count;
A
Alan Cox 已提交
521
	}
522

523
	mutex_unlock(&buf->lock);
A
Alan Cox 已提交
524 525 526 527 528 529

	tty_ldisc_deref(disc);
}

/**
 *	tty_flip_buffer_push	-	terminal
J
Jiri Slaby 已提交
530
 *	@port: tty port to push
A
Alan Cox 已提交
531
 *
P
Peter Hurley 已提交
532 533
 *	Queue a push of the terminal flip buffers to the line discipline.
 *	Can be called from IRQ/atomic context.
A
Alan Cox 已提交
534 535 536 537 538
 *
 *	In the event of the queue being busy for flipping the work will be
 *	held off and retried later.
 */

J
Jiri Slaby 已提交
539
void tty_flip_buffer_push(struct tty_port *port)
A
Alan Cox 已提交
540
{
P
Peter Hurley 已提交
541
	tty_schedule_flip(port);
A
Alan Cox 已提交
542 543 544 545 546 547 548 549 550 551 552
}
EXPORT_SYMBOL(tty_flip_buffer_push);

/**
 *	tty_buffer_init		-	prepare a tty buffer structure
 *	@tty: tty to initialise
 *
 *	Set up the initial state of the buffer management for a tty device.
 *	Must be called before the other tty buffer functions are used.
 */

J
Jiri Slaby 已提交
553
void tty_buffer_init(struct tty_port *port)
A
Alan Cox 已提交
554
{
J
Jiri Slaby 已提交
555
	struct tty_bufhead *buf = &port->buf;
556

557
	mutex_init(&buf->lock);
558 559 560
	tty_buffer_reset(&buf->sentinel, 0);
	buf->head = &buf->sentinel;
	buf->tail = &buf->sentinel;
561
	init_llist_head(&buf->free);
562
	atomic_set(&buf->mem_used, 0);
563
	atomic_set(&buf->priority, 0);
564
	INIT_WORK(&buf->work, flush_to_ldisc);
565
	buf->mem_limit = TTYB_DEFAULT_MEM_LIMIT;
A
Alan Cox 已提交
566
}
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583

/**
 *	tty_buffer_set_limit	-	change the tty buffer memory limit
 *	@port: tty port to change
 *
 *	Change the tty buffer memory limit.
 *	Must be called before the other tty buffer functions are used.
 */

int tty_buffer_set_limit(struct tty_port *port, int limit)
{
	if (limit < MIN_TTYB_SIZE)
		return -EINVAL;
	port->buf.mem_limit = limit;
	return 0;
}
EXPORT_SYMBOL_GPL(tty_buffer_set_limit);
P
Peter Hurley 已提交
584 585 586 587 588 589

/* slave ptys can claim nested buffer lock when handling BRK and INTR */
void tty_buffer_set_lock_subclass(struct tty_port *port)
{
	lockdep_set_subclass(&port->buf.lock, TTY_LOCK_SLAVE);
}