tty_buffer.c 14.3 KB
Newer Older
A
Alan Cox 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * 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/init.h>
#include <linux/wait.h>
#include <linux/bitops.h>
#include <linux/delay.h>
#include <linux/module.h>

/**
 *	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
 *
 *	Locking: none
 */

J
Jiri Slaby 已提交
30
void tty_buffer_free_all(struct tty_port *port)
A
Alan Cox 已提交
31
{
J
Jiri Slaby 已提交
32
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
33
	struct tty_buffer *thead;
34 35 36

	while ((thead = buf->head) != NULL) {
		buf->head = thead->next;
A
Alan Cox 已提交
37 38
		kfree(thead);
	}
39 40
	while ((thead = buf->free) != NULL) {
		buf->free = thead->next;
A
Alan Cox 已提交
41 42
		kfree(thead);
	}
43 44
	buf->tail = NULL;
	buf->memory_used = 0;
A
Alan Cox 已提交
45 46 47 48 49 50 51 52 53 54 55 56 57 58
}

/**
 *	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.
 *	Return NULL if out of memory or the allocation would exceed the
 *	per device queue
 *
 *	Locking: Caller must hold tty->buf.lock
 */

J
Jiri Slaby 已提交
59
static struct tty_buffer *tty_buffer_alloc(struct tty_port *port, size_t size)
A
Alan Cox 已提交
60 61 62
{
	struct tty_buffer *p;

J
Jiri Slaby 已提交
63
	if (port->buf.memory_used + size > 65536)
A
Alan Cox 已提交
64 65 66 67 68 69 70 71 72 73 74
		return NULL;
	p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
	if (p == NULL)
		return NULL;
	p->used = 0;
	p->size = size;
	p->next = NULL;
	p->commit = 0;
	p->read = 0;
	p->char_buf_ptr = (char *)(p->data);
	p->flag_buf_ptr = (unsigned char *)p->char_buf_ptr + size;
J
Jiri Slaby 已提交
75
	port->buf.memory_used += size;
A
Alan Cox 已提交
76 77 78 79 80 81 82 83 84 85 86 87 88 89
	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
 *
 *	Locking: Caller must hold tty->buf.lock
 */

J
Jiri Slaby 已提交
90
static void tty_buffer_free(struct tty_port *port, struct tty_buffer *b)
A
Alan Cox 已提交
91
{
J
Jiri Slaby 已提交
92
	struct tty_bufhead *buf = &port->buf;
93

A
Alan Cox 已提交
94
	/* Dumb strategy for now - should keep some stats */
95 96
	buf->memory_used -= b->size;
	WARN_ON(buf->memory_used < 0);
A
Alan Cox 已提交
97 98 99 100

	if (b->size >= 512)
		kfree(b);
	else {
101 102
		b->next = buf->free;
		buf->free = b;
A
Alan Cox 已提交
103 104 105 106 107 108 109 110 111 112 113 114 115 116
	}
}

/**
 *	__tty_buffer_flush		-	flush full tty buffers
 *	@tty: tty to flush
 *
 *	flush all the buffers containing receive data. Caller must
 *	hold the buffer lock and must have ensured no parallel flush to
 *	ldisc is running.
 *
 *	Locking: Caller must hold tty->buf.lock
 */

J
Jiri Slaby 已提交
117
static void __tty_buffer_flush(struct tty_port *port)
A
Alan Cox 已提交
118
{
J
Jiri Slaby 已提交
119
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
120 121
	struct tty_buffer *thead;

I
Ilya Zykov 已提交
122 123 124 125 126
	if (unlikely(buf->head == NULL))
		return;
	while ((thead = buf->head->next) != NULL) {
		tty_buffer_free(port, buf->head);
		buf->head = thead;
A
Alan Cox 已提交
127
	}
I
Ilya Zykov 已提交
128 129
	WARN_ON(buf->head != buf->tail);
	buf->head->read = buf->head->commit;
A
Alan Cox 已提交
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
}

/**
 *	tty_buffer_flush		-	flush full tty buffers
 *	@tty: tty to flush
 *
 *	flush all the buffers containing receive data. If the buffer is
 *	being processed by flush_to_ldisc then we defer the processing
 *	to that function
 *
 *	Locking: none
 */

void tty_buffer_flush(struct tty_struct *tty)
{
145
	struct tty_port *port = tty->port;
J
Jiri Slaby 已提交
146
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
147
	unsigned long flags;
148 149

	spin_lock_irqsave(&buf->lock, flags);
A
Alan Cox 已提交
150 151 152 153

	/* If the data is being pushed to the tty layer then we can't
	   process it here. Instead set a flag and the flush_to_ldisc
	   path will process the flush request before it exits */
154 155
	if (test_bit(TTYP_FLUSHING, &port->iflags)) {
		set_bit(TTYP_FLUSHPENDING, &port->iflags);
156
		spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
157
		wait_event(tty->read_wait,
158
				test_bit(TTYP_FLUSHPENDING, &port->iflags) == 0);
A
Alan Cox 已提交
159 160
		return;
	} else
J
Jiri Slaby 已提交
161
		__tty_buffer_flush(port);
162
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
163 164 165 166 167 168 169 170 171 172 173 174 175 176
}

/**
 *	tty_buffer_find		-	find a free tty buffer
 *	@tty: tty owning the buffer
 *	@size: characters wanted
 *
 *	Locate an existing suitable tty buffer or if we are lacking one then
 *	allocate a new one. We round our buffers off in 256 character chunks
 *	to get better allocation behaviour.
 *
 *	Locking: Caller must hold tty->buf.lock
 */

J
Jiri Slaby 已提交
177
static struct tty_buffer *tty_buffer_find(struct tty_port *port, size_t size)
A
Alan Cox 已提交
178
{
J
Jiri Slaby 已提交
179
	struct tty_buffer **tbh = &port->buf.free;
A
Alan Cox 已提交
180 181 182 183 184 185 186 187
	while ((*tbh) != NULL) {
		struct tty_buffer *t = *tbh;
		if (t->size >= size) {
			*tbh = t->next;
			t->next = NULL;
			t->used = 0;
			t->commit = 0;
			t->read = 0;
J
Jiri Slaby 已提交
188
			port->buf.memory_used += t->size;
A
Alan Cox 已提交
189 190 191 192 193 194
			return t;
		}
		tbh = &((*tbh)->next);
	}
	/* Round the buffer size out */
	size = (size + 0xFF) & ~0xFF;
J
Jiri Slaby 已提交
195
	return tty_buffer_alloc(port, size);
A
Alan Cox 已提交
196 197 198 199
	/* Should possibly check if this fails for the largest buffer we
	   have queued and recycle that ? */
}
/**
I
Ilya Zykov 已提交
200
 *	tty_buffer_request_room		-	grow tty buffer if needed
A
Alan Cox 已提交
201 202 203 204 205
 *	@tty: tty structure
 *	@size: size desired
 *
 *	Make at least size bytes of linear space available for the tty
 *	buffer. If we fail return the size we managed to find.
I
Ilya Zykov 已提交
206 207
 *
 *	Locking: Takes port->buf.lock
A
Alan Cox 已提交
208
 */
I
Ilya Zykov 已提交
209
int tty_buffer_request_room(struct tty_port *port, size_t size)
A
Alan Cox 已提交
210
{
J
Jiri Slaby 已提交
211
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
212 213
	struct tty_buffer *b, *n;
	int left;
I
Ilya Zykov 已提交
214 215
	unsigned long flags;
	spin_lock_irqsave(&buf->lock, flags);
A
Alan Cox 已提交
216 217 218
	/* OPTIMISATION: We could keep a per tty "zero" sized buffer to
	   remove this conditional if its worth it. This would be invisible
	   to the callers */
219 220
	b = buf->tail;
	if (b != NULL)
A
Alan Cox 已提交
221 222 223 224 225 226
		left = b->size - b->used;
	else
		left = 0;

	if (left < size) {
		/* This is the slow path - looking for new buffers to use */
J
Jiri Slaby 已提交
227
		if ((n = tty_buffer_find(port, size)) != NULL) {
A
Alan Cox 已提交
228 229 230 231
			if (b != NULL) {
				b->next = n;
				b->commit = b->used;
			} else
232 233
				buf->head = n;
			buf->tail = n;
A
Alan Cox 已提交
234 235 236
		} else
			size = left;
	}
I
Ilya Zykov 已提交
237
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
238 239 240 241 242
	return size;
}
EXPORT_SYMBOL_GPL(tty_buffer_request_room);

/**
243
 *	tty_insert_flip_string_fixed_flag - Add characters to the tty buffer
244
 *	@port: tty port
A
Alan Cox 已提交
245
 *	@chars: characters
246
 *	@flag: flag value for each character
A
Alan Cox 已提交
247 248 249
 *	@size: size
 *
 *	Queue a series of bytes to the tty buffering. All the characters
250
 *	passed are marked with the supplied flag. Returns the number added.
A
Alan Cox 已提交
251
 *
J
Jiri Slaby 已提交
252
 *	Locking: Called functions may take port->buf.lock
A
Alan Cox 已提交
253 254
 */

255
int tty_insert_flip_string_fixed_flag(struct tty_port *port,
256
		const unsigned char *chars, char flag, size_t size)
A
Alan Cox 已提交
257 258 259
{
	int copied = 0;
	do {
260
		int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
I
Ilya Zykov 已提交
261 262
		int space = tty_buffer_request_room(port, goal);
		struct tty_buffer *tb = port->buf.tail;
A
Alan Cox 已提交
263
		/* If there is no space then tb may be NULL */
264
		if (unlikely(space == 0)) {
A
Alan Cox 已提交
265
			break;
266
		}
A
Alan Cox 已提交
267
		memcpy(tb->char_buf_ptr + tb->used, chars, space);
268
		memset(tb->flag_buf_ptr + tb->used, flag, space);
A
Alan Cox 已提交
269 270 271 272 273 274 275 276
		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;
}
277
EXPORT_SYMBOL(tty_insert_flip_string_fixed_flag);
A
Alan Cox 已提交
278 279 280

/**
 *	tty_insert_flip_string_flags	-	Add characters to the tty buffer
281
 *	@port: tty port
A
Alan Cox 已提交
282 283 284 285 286 287 288 289
 *	@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.
 *
J
Jiri Slaby 已提交
290
 *	Locking: Called functions may take port->buf.lock
A
Alan Cox 已提交
291 292
 */

293
int tty_insert_flip_string_flags(struct tty_port *port,
A
Alan Cox 已提交
294 295 296 297
		const unsigned char *chars, const char *flags, size_t size)
{
	int copied = 0;
	do {
298
		int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
I
Ilya Zykov 已提交
299 300
		int space = tty_buffer_request_room(port, goal);
		struct tty_buffer *tb = port->buf.tail;
A
Alan Cox 已提交
301
		/* If there is no space then tb may be NULL */
302
		if (unlikely(space == 0)) {
A
Alan Cox 已提交
303
			break;
304
		}
A
Alan Cox 已提交
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
		memcpy(tb->char_buf_ptr + tb->used, chars, space);
		memcpy(tb->flag_buf_ptr + tb->used, flags, space);
		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 已提交
320
 *	@port: tty port to push from
A
Alan Cox 已提交
321 322 323 324
 *
 *	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.
325 326
 *	Note that this function can only be used when the low_latency flag
 *	is unset. Otherwise the workqueue won't be flushed.
A
Alan Cox 已提交
327
 *
J
Jiri Slaby 已提交
328
 *	Locking: Takes port->buf.lock
A
Alan Cox 已提交
329 330
 */

J
Jiri Slaby 已提交
331
void tty_schedule_flip(struct tty_port *port)
A
Alan Cox 已提交
332
{
J
Jiri Slaby 已提交
333
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
334
	unsigned long flags;
J
Jiri Slaby 已提交
335
	WARN_ON(port->low_latency);
336 337 338 339 340 341

	spin_lock_irqsave(&buf->lock, flags);
	if (buf->tail != NULL)
		buf->tail->commit = buf->tail->used;
	spin_unlock_irqrestore(&buf->lock, flags);
	schedule_work(&buf->work);
A
Alan Cox 已提交
342 343 344 345 346
}
EXPORT_SYMBOL(tty_schedule_flip);

/**
 *	tty_prepare_flip_string		-	make room for characters
347
 *	@port: tty port
A
Alan Cox 已提交
348 349 350 351 352 353 354 355 356
 *	@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!
 *
J
Jiri Slaby 已提交
357
 *	Locking: May call functions taking port->buf.lock
A
Alan Cox 已提交
358 359
 */

360
int tty_prepare_flip_string(struct tty_port *port, unsigned char **chars,
J
Jiri Slaby 已提交
361
		size_t size)
A
Alan Cox 已提交
362
{
I
Ilya Zykov 已提交
363
	int space = tty_buffer_request_room(port, size);
A
Alan Cox 已提交
364
	if (likely(space)) {
I
Ilya Zykov 已提交
365
		struct tty_buffer *tb = port->buf.tail;
A
Alan Cox 已提交
366 367 368 369 370 371 372 373 374 375
		*chars = tb->char_buf_ptr + tb->used;
		memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
		tb->used += space;
	}
	return space;
}
EXPORT_SYMBOL_GPL(tty_prepare_flip_string);

/**
 *	tty_prepare_flip_string_flags	-	make room for characters
376
 *	@port: tty port
A
Alan Cox 已提交
377 378 379 380 381 382 383 384 385 386
 *	@chars: return pointer for character write area
 *	@flags: return pointer for status flag 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 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!
 *
J
Jiri Slaby 已提交
387
 *	Locking: May call functions taking port->buf.lock
A
Alan Cox 已提交
388 389
 */

390
int tty_prepare_flip_string_flags(struct tty_port *port,
A
Alan Cox 已提交
391 392
			unsigned char **chars, char **flags, size_t size)
{
I
Ilya Zykov 已提交
393
	int space = tty_buffer_request_room(port, size);
A
Alan Cox 已提交
394
	if (likely(space)) {
I
Ilya Zykov 已提交
395
		struct tty_buffer *tb = port->buf.tail;
A
Alan Cox 已提交
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
		*chars = tb->char_buf_ptr + tb->used;
		*flags = tb->flag_buf_ptr + tb->used;
		tb->used += space;
	}
	return space;
}
EXPORT_SYMBOL_GPL(tty_prepare_flip_string_flags);



/**
 *	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.
 *
 *	Locking: holds tty->buf.lock to guard buffer list. Drops the lock
 *	while invoking the line discipline receive_buf method. The
 *	receive_buf method is single threaded for each tty instance.
 */

static void flush_to_ldisc(struct work_struct *work)
{
J
Jiri Slaby 已提交
420 421 422
	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 已提交
423 424 425
	unsigned long 	flags;
	struct tty_ldisc *disc;

J
Jiri Slaby 已提交
426
	tty = port->itty;
427
	if (WARN_RATELIMIT(tty == NULL, "tty is NULL\n"))
J
Jiri Slaby 已提交
428 429
		return;

A
Alan Cox 已提交
430 431 432 433
	disc = tty_ldisc_ref(tty);
	if (disc == NULL)	/*  !TTY_LDISC */
		return;

434
	spin_lock_irqsave(&buf->lock, flags);
435

436
	if (!test_and_set_bit(TTYP_FLUSHING, &port->iflags)) {
437
		struct tty_buffer *head;
438
		while ((head = buf->head) != NULL) {
439 440 441 442 443
			int count;
			char *char_buf;
			unsigned char *flag_buf;

			count = head->commit - head->read;
A
Alan Cox 已提交
444 445 446
			if (!count) {
				if (head->next == NULL)
					break;
447
				buf->head = head->next;
J
Jiri Slaby 已提交
448
				tty_buffer_free(port, head);
A
Alan Cox 已提交
449 450 451 452 453
				continue;
			}
			/* Ldisc or user is trying to flush the buffers
			   we are feeding to the ldisc, stop feeding the
			   line discipline as we want to empty the queue */
454
			if (test_bit(TTYP_FLUSHPENDING, &port->iflags))
A
Alan Cox 已提交
455
				break;
456
			if (!tty->receive_room)
457 458 459
				break;
			if (count > tty->receive_room)
				count = tty->receive_room;
A
Alan Cox 已提交
460 461
			char_buf = head->char_buf_ptr + head->read;
			flag_buf = head->flag_buf_ptr + head->read;
462
			head->read += count;
463
			spin_unlock_irqrestore(&buf->lock, flags);
464
			disc->ops->receive_buf(tty, char_buf,
A
Alan Cox 已提交
465
							flag_buf, count);
466
			spin_lock_irqsave(&buf->lock, flags);
A
Alan Cox 已提交
467
		}
468
		clear_bit(TTYP_FLUSHING, &port->iflags);
A
Alan Cox 已提交
469
	}
470

A
Alan Cox 已提交
471 472
	/* We may have a deferred request to flush the input buffer,
	   if so pull the chain under the lock and empty the queue */
473
	if (test_bit(TTYP_FLUSHPENDING, &port->iflags)) {
J
Jiri Slaby 已提交
474
		__tty_buffer_flush(port);
475
		clear_bit(TTYP_FLUSHPENDING, &port->iflags);
A
Alan Cox 已提交
476 477
		wake_up(&tty->read_wait);
	}
478
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
479 480 481 482

	tty_ldisc_deref(disc);
}

483 484 485 486 487 488 489 490 491 492
/**
 *	tty_flush_to_ldisc
 *	@tty: tty to push
 *
 *	Push the terminal flip buffers to the line discipline.
 *
 *	Must not be called from IRQ context.
 */
void tty_flush_to_ldisc(struct tty_struct *tty)
{
J
Jiri Slaby 已提交
493
	if (!tty->port->low_latency)
J
Jiri Slaby 已提交
494
		flush_work(&tty->port->buf.work);
495 496
}

A
Alan Cox 已提交
497 498
/**
 *	tty_flip_buffer_push	-	terminal
J
Jiri Slaby 已提交
499
 *	@port: tty port to push
A
Alan Cox 已提交
500 501
 *
 *	Queue a push of the terminal flip buffers to the line discipline. This
J
Jiri Slaby 已提交
502 503
 *	function must not be called from IRQ context if port->low_latency is
 *	set.
A
Alan Cox 已提交
504 505 506 507 508 509 510
 *
 *	In the event of the queue being busy for flipping the work will be
 *	held off and retried later.
 *
 *	Locking: tty buffer lock. Driver locks in low latency mode.
 */

J
Jiri Slaby 已提交
511
void tty_flip_buffer_push(struct tty_port *port)
A
Alan Cox 已提交
512
{
J
Jiri Slaby 已提交
513
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
514
	unsigned long flags;
515 516 517 518 519

	spin_lock_irqsave(&buf->lock, flags);
	if (buf->tail != NULL)
		buf->tail->commit = buf->tail->used;
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
520

J
Jiri Slaby 已提交
521
	if (port->low_latency)
522
		flush_to_ldisc(&buf->work);
A
Alan Cox 已提交
523
	else
524
		schedule_work(&buf->work);
A
Alan Cox 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537
}
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.
 *
 *	Locking: none
 */

J
Jiri Slaby 已提交
538
void tty_buffer_init(struct tty_port *port)
A
Alan Cox 已提交
539
{
J
Jiri Slaby 已提交
540
	struct tty_bufhead *buf = &port->buf;
541 542 543 544 545 546 547

	spin_lock_init(&buf->lock);
	buf->head = NULL;
	buf->tail = NULL;
	buf->free = NULL;
	buf->memory_used = 0;
	INIT_WORK(&buf->work, flush_to_ldisc);
A
Alan Cox 已提交
548 549
}