tty_buffer.c 13.6 KB
Newer Older
A
Alan Cox 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * 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>
19
#include <linux/ratelimit.h>
A
Alan Cox 已提交
20

P
Peter Hurley 已提交
21 22 23 24

#define MIN_TTYB_SIZE	256
#define TTYB_ALIGN_MASK	255

25 26 27 28 29 30 31 32 33
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;
}

A
Alan Cox 已提交
34 35 36 37 38 39 40 41 42 43
/**
 *	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 已提交
44
void tty_buffer_free_all(struct tty_port *port)
A
Alan Cox 已提交
45
{
J
Jiri Slaby 已提交
46
	struct tty_bufhead *buf = &port->buf;
47 48
	struct tty_buffer *p, *next;
	struct llist_node *llist;
49

50 51
	while ((p = buf->head) != NULL) {
		buf->head = p->next;
52 53
		if (p->size > 0)
			kfree(p);
A
Alan Cox 已提交
54
	}
55 56
	llist = llist_del_all(&buf->free);
	llist_for_each_entry_safe(p, next, llist, free)
57
		kfree(p);
58

59 60 61
	tty_buffer_reset(&buf->sentinel, 0);
	buf->head = &buf->sentinel;
	buf->tail = &buf->sentinel;
62
	buf->memory_used = 0;
A
Alan Cox 已提交
63 64 65 66 67 68 69 70
}

/**
 *	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.
71 72
 *	We round our buffers off in 256 character chunks to get better
 *	allocation behaviour.
A
Alan Cox 已提交
73 74 75 76
 *	Return NULL if out of memory or the allocation would exceed the
 *	per device queue
 */

J
Jiri Slaby 已提交
77
static struct tty_buffer *tty_buffer_alloc(struct tty_port *port, size_t size)
A
Alan Cox 已提交
78
{
79
	struct llist_node *free;
A
Alan Cox 已提交
80 81
	struct tty_buffer *p;

82 83 84 85
	/* Round the buffer size out */
	size = __ALIGN_MASK(size, TTYB_ALIGN_MASK);

	if (size <= MIN_TTYB_SIZE) {
86 87 88
		free = llist_del_first(&port->buf.free);
		if (free) {
			p = llist_entry(free, struct tty_buffer, free);
89 90 91 92 93 94
			goto found;
		}
	}

	/* Should possibly check if this fails for the largest buffer we
	   have queued and recycle that ? */
J
Jiri Slaby 已提交
95
	if (port->buf.memory_used + size > 65536)
A
Alan Cox 已提交
96 97 98 99
		return NULL;
	p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
	if (p == NULL)
		return NULL;
100

101
found:
102
	tty_buffer_reset(p, size);
J
Jiri Slaby 已提交
103
	port->buf.memory_used += size;
A
Alan Cox 已提交
104 105 106 107 108 109 110 111 112 113 114 115
	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 已提交
116
static void tty_buffer_free(struct tty_port *port, struct tty_buffer *b)
A
Alan Cox 已提交
117
{
J
Jiri Slaby 已提交
118
	struct tty_bufhead *buf = &port->buf;
119

A
Alan Cox 已提交
120
	/* Dumb strategy for now - should keep some stats */
121 122
	buf->memory_used -= b->size;
	WARN_ON(buf->memory_used < 0);
A
Alan Cox 已提交
123

P
Peter Hurley 已提交
124
	if (b->size > MIN_TTYB_SIZE)
A
Alan Cox 已提交
125
		kfree(b);
126
	else if (b->size > 0)
127
		llist_add(&b->free, &buf->free);
A
Alan Cox 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140
}

/**
 *	__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 已提交
141
static void __tty_buffer_flush(struct tty_port *port)
A
Alan Cox 已提交
142
{
J
Jiri Slaby 已提交
143
	struct tty_bufhead *buf = &port->buf;
144
	struct tty_buffer *next;
A
Alan Cox 已提交
145

146
	while ((next = buf->head->next) != NULL) {
I
Ilya Zykov 已提交
147
		tty_buffer_free(port, buf->head);
148
		buf->head = next;
A
Alan Cox 已提交
149
	}
I
Ilya Zykov 已提交
150 151
	WARN_ON(buf->head != buf->tail);
	buf->head->read = buf->head->commit;
A
Alan Cox 已提交
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
}

/**
 *	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)
{
167
	struct tty_port *port = tty->port;
J
Jiri Slaby 已提交
168
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
169
	unsigned long flags;
170 171

	spin_lock_irqsave(&buf->lock, flags);
A
Alan Cox 已提交
172 173 174 175

	/* 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 */
176 177
	if (test_bit(TTYP_FLUSHING, &port->iflags)) {
		set_bit(TTYP_FLUSHPENDING, &port->iflags);
178
		spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
179
		wait_event(tty->read_wait,
180
				test_bit(TTYP_FLUSHPENDING, &port->iflags) == 0);
A
Alan Cox 已提交
181 182
		return;
	} else
J
Jiri Slaby 已提交
183
		__tty_buffer_flush(port);
184
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
185 186 187
}

/**
I
Ilya Zykov 已提交
188
 *	tty_buffer_request_room		-	grow tty buffer if needed
A
Alan Cox 已提交
189 190 191 192 193
 *	@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 已提交
194 195
 *
 *	Locking: Takes port->buf.lock
A
Alan Cox 已提交
196
 */
I
Ilya Zykov 已提交
197
int tty_buffer_request_room(struct tty_port *port, size_t size)
A
Alan Cox 已提交
198
{
J
Jiri Slaby 已提交
199
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
200 201
	struct tty_buffer *b, *n;
	int left;
I
Ilya Zykov 已提交
202 203
	unsigned long flags;
	spin_lock_irqsave(&buf->lock, flags);
204
	b = buf->tail;
205
	left = b->size - b->used;
A
Alan Cox 已提交
206 207 208

	if (left < size) {
		/* This is the slow path - looking for new buffers to use */
209
		if ((n = tty_buffer_alloc(port, size)) != NULL) {
210 211
			b->next = n;
			b->commit = b->used;
212
			buf->tail = n;
A
Alan Cox 已提交
213 214 215
		} else
			size = left;
	}
I
Ilya Zykov 已提交
216
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
217 218 219 220 221
	return size;
}
EXPORT_SYMBOL_GPL(tty_buffer_request_room);

/**
222
 *	tty_insert_flip_string_fixed_flag - Add characters to the tty buffer
223
 *	@port: tty port
A
Alan Cox 已提交
224
 *	@chars: characters
225
 *	@flag: flag value for each character
A
Alan Cox 已提交
226 227 228
 *	@size: size
 *
 *	Queue a series of bytes to the tty buffering. All the characters
229
 *	passed are marked with the supplied flag. Returns the number added.
A
Alan Cox 已提交
230
 *
J
Jiri Slaby 已提交
231
 *	Locking: Called functions may take port->buf.lock
A
Alan Cox 已提交
232 233
 */

234
int tty_insert_flip_string_fixed_flag(struct tty_port *port,
235
		const unsigned char *chars, char flag, size_t size)
A
Alan Cox 已提交
236 237 238
{
	int copied = 0;
	do {
239
		int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
I
Ilya Zykov 已提交
240 241
		int space = tty_buffer_request_room(port, goal);
		struct tty_buffer *tb = port->buf.tail;
242
		if (unlikely(space == 0))
A
Alan Cox 已提交
243
			break;
P
Peter Hurley 已提交
244 245
		memcpy(char_buf_ptr(tb, tb->used), chars, space);
		memset(flag_buf_ptr(tb, tb->used), flag, space);
A
Alan Cox 已提交
246 247 248 249 250 251 252 253
		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;
}
254
EXPORT_SYMBOL(tty_insert_flip_string_fixed_flag);
A
Alan Cox 已提交
255 256 257

/**
 *	tty_insert_flip_string_flags	-	Add characters to the tty buffer
258
 *	@port: tty port
A
Alan Cox 已提交
259 260 261 262 263 264 265 266
 *	@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 已提交
267
 *	Locking: Called functions may take port->buf.lock
A
Alan Cox 已提交
268 269
 */

270
int tty_insert_flip_string_flags(struct tty_port *port,
A
Alan Cox 已提交
271 272 273 274
		const unsigned char *chars, const char *flags, size_t size)
{
	int copied = 0;
	do {
275
		int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
I
Ilya Zykov 已提交
276 277
		int space = tty_buffer_request_room(port, goal);
		struct tty_buffer *tb = port->buf.tail;
278
		if (unlikely(space == 0))
A
Alan Cox 已提交
279
			break;
P
Peter Hurley 已提交
280 281
		memcpy(char_buf_ptr(tb, tb->used), chars, space);
		memcpy(flag_buf_ptr(tb, tb->used), flags, space);
A
Alan Cox 已提交
282 283 284 285 286 287 288 289 290 291 292 293 294
		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 已提交
295
 *	@port: tty port to push from
A
Alan Cox 已提交
296 297 298 299
 *
 *	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.
300 301
 *	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 已提交
302
 *
J
Jiri Slaby 已提交
303
 *	Locking: Takes port->buf.lock
A
Alan Cox 已提交
304 305
 */

J
Jiri Slaby 已提交
306
void tty_schedule_flip(struct tty_port *port)
A
Alan Cox 已提交
307
{
J
Jiri Slaby 已提交
308
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
309
	unsigned long flags;
J
Jiri Slaby 已提交
310
	WARN_ON(port->low_latency);
311 312

	spin_lock_irqsave(&buf->lock, flags);
313
	buf->tail->commit = buf->tail->used;
314 315
	spin_unlock_irqrestore(&buf->lock, flags);
	schedule_work(&buf->work);
A
Alan Cox 已提交
316 317 318 319 320
}
EXPORT_SYMBOL(tty_schedule_flip);

/**
 *	tty_prepare_flip_string		-	make room for characters
321
 *	@port: tty port
A
Alan Cox 已提交
322 323 324 325 326 327 328 329 330
 *	@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 已提交
331
 *	Locking: May call functions taking port->buf.lock
A
Alan Cox 已提交
332 333
 */

334
int tty_prepare_flip_string(struct tty_port *port, unsigned char **chars,
J
Jiri Slaby 已提交
335
		size_t size)
A
Alan Cox 已提交
336
{
I
Ilya Zykov 已提交
337
	int space = tty_buffer_request_room(port, size);
A
Alan Cox 已提交
338
	if (likely(space)) {
I
Ilya Zykov 已提交
339
		struct tty_buffer *tb = port->buf.tail;
P
Peter Hurley 已提交
340 341
		*chars = char_buf_ptr(tb, tb->used);
		memset(flag_buf_ptr(tb, tb->used), TTY_NORMAL, space);
A
Alan Cox 已提交
342 343 344 345 346 347 348 349
		tb->used += space;
	}
	return space;
}
EXPORT_SYMBOL_GPL(tty_prepare_flip_string);

/**
 *	tty_prepare_flip_string_flags	-	make room for characters
350
 *	@port: tty port
A
Alan Cox 已提交
351 352 353 354 355 356 357 358 359 360
 *	@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 已提交
361
 *	Locking: May call functions taking port->buf.lock
A
Alan Cox 已提交
362 363
 */

364
int tty_prepare_flip_string_flags(struct tty_port *port,
A
Alan Cox 已提交
365 366
			unsigned char **chars, char **flags, size_t size)
{
I
Ilya Zykov 已提交
367
	int space = tty_buffer_request_room(port, size);
A
Alan Cox 已提交
368
	if (likely(space)) {
I
Ilya Zykov 已提交
369
		struct tty_buffer *tb = port->buf.tail;
P
Peter Hurley 已提交
370 371
		*chars = char_buf_ptr(tb, tb->used);
		*flags = flag_buf_ptr(tb, tb->used);
A
Alan Cox 已提交
372 373 374 375 376 377 378
		tb->used += space;
	}
	return space;
}
EXPORT_SYMBOL_GPL(tty_prepare_flip_string_flags);


379 380 381 382
static int
receive_buf(struct tty_struct *tty, struct tty_buffer *head, int count)
{
	struct tty_ldisc *disc = tty->ldisc;
P
Peter Hurley 已提交
383 384
	unsigned char *p = char_buf_ptr(head, head->read);
	char	      *f = flag_buf_ptr(head, head->read);
385

386 387 388 389 390 391 392
	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);
	}
393 394 395
	head->read += count;
	return count;
}
A
Alan Cox 已提交
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

/**
 *	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 已提交
411 412 413
	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 已提交
414 415 416
	unsigned long 	flags;
	struct tty_ldisc *disc;

J
Jiri Slaby 已提交
417
	tty = port->itty;
J
Jiri Slaby 已提交
418
	if (tty == NULL)
J
Jiri Slaby 已提交
419 420
		return;

A
Alan Cox 已提交
421
	disc = tty_ldisc_ref(tty);
422
	if (disc == NULL)
A
Alan Cox 已提交
423 424
		return;

425
	spin_lock_irqsave(&buf->lock, flags);
426

427
	if (!test_and_set_bit(TTYP_FLUSHING, &port->iflags)) {
428 429
		while (1) {
			struct tty_buffer *head = buf->head;
430 431 432
			int count;

			count = head->commit - head->read;
A
Alan Cox 已提交
433 434 435
			if (!count) {
				if (head->next == NULL)
					break;
436
				buf->head = head->next;
J
Jiri Slaby 已提交
437
				tty_buffer_free(port, head);
A
Alan Cox 已提交
438 439
				continue;
			}
440
			spin_unlock_irqrestore(&buf->lock, flags);
441 442 443

			count = receive_buf(tty, head, count);

444
			spin_lock_irqsave(&buf->lock, flags);
445 446 447 448 449 450 451 452 453
			/* Ldisc or user is trying to flush the buffers.
			   We may have a deferred request to flush the
			   input buffer, if so pull the chain under the lock
			   and empty the queue */
			if (test_bit(TTYP_FLUSHPENDING, &port->iflags)) {
				__tty_buffer_flush(port);
				clear_bit(TTYP_FLUSHPENDING, &port->iflags);
				wake_up(&tty->read_wait);
				break;
454 455
			} else if (!count)
				break;
A
Alan Cox 已提交
456
		}
457
		clear_bit(TTYP_FLUSHING, &port->iflags);
A
Alan Cox 已提交
458
	}
459

460
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
461 462 463 464

	tty_ldisc_deref(disc);
}

465 466 467 468 469 470 471 472 473 474
/**
 *	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 已提交
475
	if (!tty->port->low_latency)
J
Jiri Slaby 已提交
476
		flush_work(&tty->port->buf.work);
477 478
}

A
Alan Cox 已提交
479 480
/**
 *	tty_flip_buffer_push	-	terminal
J
Jiri Slaby 已提交
481
 *	@port: tty port to push
A
Alan Cox 已提交
482 483
 *
 *	Queue a push of the terminal flip buffers to the line discipline. This
J
Jiri Slaby 已提交
484 485
 *	function must not be called from IRQ context if port->low_latency is
 *	set.
A
Alan Cox 已提交
486 487 488 489 490 491 492
 *
 *	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 已提交
493
void tty_flip_buffer_push(struct tty_port *port)
A
Alan Cox 已提交
494
{
J
Jiri Slaby 已提交
495
	struct tty_bufhead *buf = &port->buf;
A
Alan Cox 已提交
496
	unsigned long flags;
497 498

	spin_lock_irqsave(&buf->lock, flags);
499
	buf->tail->commit = buf->tail->used;
500
	spin_unlock_irqrestore(&buf->lock, flags);
A
Alan Cox 已提交
501

J
Jiri Slaby 已提交
502
	if (port->low_latency)
503
		flush_to_ldisc(&buf->work);
A
Alan Cox 已提交
504
	else
505
		schedule_work(&buf->work);
A
Alan Cox 已提交
506 507 508 509 510 511 512 513 514 515 516 517 518
}
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 已提交
519
void tty_buffer_init(struct tty_port *port)
A
Alan Cox 已提交
520
{
J
Jiri Slaby 已提交
521
	struct tty_bufhead *buf = &port->buf;
522 523

	spin_lock_init(&buf->lock);
524 525 526
	tty_buffer_reset(&buf->sentinel, 0);
	buf->head = &buf->sentinel;
	buf->tail = &buf->sentinel;
527
	init_llist_head(&buf->free);
528 529
	buf->memory_used = 0;
	INIT_WORK(&buf->work, flush_to_ldisc);
A
Alan Cox 已提交
530 531
}