drivers/tty/tty_buffer.c

   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>
  14 #include <linux/wait.h>
  15 #include <linux/bitops.h>
  16 #include <linux/delay.h>
  17 #include <linux/module.h>
  18 #include <linux/ratelimit.h>
  19
  20
  21 #define MIN_TTYB_SIZE   256
  22 #define TTYB_ALIGN_MASK 255
  23
  24 /*
  25  * Byte threshold to limit memory consumption for flip buffers.
  26  * The actual memory limit is > 2x this amount.
  27  */
  28 #define TTYB_DEFAULT_MEM_LIMIT  (640 * 1024UL)
  29
  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
  40 /**
  41  *      tty_buffer_lock_exclusive       -       gain exclusive access to buffer
  42  *      tty_buffer_unlock_exclusive     -       release exclusive access
  43  *
  44  *      @port - tty_port owning the flip buffer
  45  *
  46  *      Guarantees safe use of the line discipline's receive_buf() method by
  47  *      excluding the buffer work and any pending flush from using the flip
  48  *      buffer. Data can continue to be added concurrently to the flip buffer
  49  *      from the driver side.
  50  *
  51  *      On release, the buffer work is restarted if there is data in the
  52  *      flip buffer
  53  */
  54
  55 void tty_buffer_lock_exclusive(struct tty_port *port)
  56 {
  57         struct tty_bufhead *buf = &port->buf;
  58
  59         atomic_inc(&buf->priority);
  60         mutex_lock(&buf->lock);
  61 }
  62 EXPORT_SYMBOL_GPL(tty_buffer_lock_exclusive);
  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 EXPORT_SYMBOL_GPL(tty_buffer_unlock_exclusive);
  77
  78 /**
  79  *      tty_buffer_space_avail  -       return unused buffer space
  80  *      @port - tty_port owning the flip buffer
  81  *
  82  *      Returns the # of bytes which can be written by the driver without
  83  *      reaching the buffer limit.
  84  *
  85  *      Note: this does not guarantee that memory is available to write
  86  *      the returned # of bytes (use tty_prepare_flip_string_xxx() to
  87  *      pre-allocate if memory guarantee is required).
  88  */
  89
  90 int tty_buffer_space_avail(struct tty_port *port)
  91 {
  92         int space = port->buf.mem_limit - atomic_read(&port->buf.mem_used);
  93         return max(space, 0);
  94 }
  95 EXPORT_SYMBOL_GPL(tty_buffer_space_avail);
  96
  97 static void tty_buffer_reset(struct tty_buffer *p, size_t size)
  98 {
  99         p->used = 0;
 100         p->size = size;
 101         p->next = NULL;
 102         p->commit = 0;
 103         p->read = 0;
 104         p->flags = 0;
 105 }
 106
 107 /**
 108  *      tty_buffer_free_all             -       free buffers used by a tty
 109  *      @tty: tty to free from
 110  *
 111  *      Remove all the buffers pending on a tty whether queued with data
 112  *      or in the free ring. Must be called when the tty is no longer in use
 113  */
 114
 115 void tty_buffer_free_all(struct tty_port *port)
 116 {
 117         struct tty_bufhead *buf = &port->buf;
 118         struct tty_buffer *p, *next;
 119         struct llist_node *llist;
 120
 121         while ((p = buf->head) != NULL) {
 122                 buf->head = p->next;
 123                 if (p->size > 0)
 124                         kfree(p);
 125         }
 126         llist = llist_del_all(&buf->free);
 127         llist_for_each_entry_safe(p, next, llist, free)
 128                 kfree(p);
 129
 130         tty_buffer_reset(&buf->sentinel, 0);
 131         buf->head = &buf->sentinel;
 132         buf->tail = &buf->sentinel;
 133
 134         atomic_set(&buf->mem_used, 0);
 135 }
 136
 137 /**
 138  *      tty_buffer_alloc        -       allocate a tty buffer
 139  *      @tty: tty device
 140  *      @size: desired size (characters)
 141  *
 142  *      Allocate a new tty buffer to hold the desired number of characters.
 143  *      We round our buffers off in 256 character chunks to get better
 144  *      allocation behaviour.
 145  *      Return NULL if out of memory or the allocation would exceed the
 146  *      per device queue
 147  */
 148
 149 static struct tty_buffer *tty_buffer_alloc(struct tty_port *port, size_t size)
 150 {
 151         struct llist_node *free;
 152         struct tty_buffer *p;
 153
 154         /* Round the buffer size out */
 155         size = __ALIGN_MASK(size, TTYB_ALIGN_MASK);
 156
 157         if (size <= MIN_TTYB_SIZE) {
 158                 free = llist_del_first(&port->buf.free);
 159                 if (free) {
 160                         p = llist_entry(free, struct tty_buffer, free);
 161                         goto found;
 162                 }
 163         }
 164
 165         /* Should possibly check if this fails for the largest buffer we
 166            have queued and recycle that ? */
 167         if (atomic_read(&port->buf.mem_used) > port->buf.mem_limit)
 168                 return NULL;
 169         p = kmalloc(sizeof(struct tty_buffer) + 2 * size,
 170                     GFP_ATOMIC | __GFP_NOWARN);
 171         if (p == NULL)
 172                 return NULL;
 173
 174 found:
 175         tty_buffer_reset(p, size);
 176         atomic_add(size, &port->buf.mem_used);
 177         return p;
 178 }
 179
 180 /**
 181  *      tty_buffer_free         -       free a tty buffer
 182  *      @tty: tty owning the buffer
 183  *      @b: the buffer to free
 184  *
 185  *      Free a tty buffer, or add it to the free list according to our
 186  *      internal strategy
 187  */
 188
 189 static void tty_buffer_free(struct tty_port *port, struct tty_buffer *b)
 190 {
 191         struct tty_bufhead *buf = &port->buf;
 192
 193         /* Dumb strategy for now - should keep some stats */
 194         WARN_ON(atomic_sub_return(b->size, &buf->mem_used) < 0);
 195
 196         if (b->size > MIN_TTYB_SIZE)
 197                 kfree(b);
 198         else if (b->size > 0)
 199                 llist_add(&b->free, &buf->free);
 200 }
 201
 202 /**
 203  *      tty_buffer_flush                -       flush full tty buffers
 204  *      @tty: tty to flush
 205  *      @ld:  optional ldisc ptr (must be referenced)
 206  *
 207  *      flush all the buffers containing receive data. If ld != NULL,
 208  *      flush the ldisc input buffer.
 209  *
 210  *      Locking: takes buffer lock to ensure single-threaded flip buffer
 211  *               'consumer'
 212  */
 213
 214 void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld)
 215 {
 216         struct tty_port *port = tty->port;
 217         struct tty_bufhead *buf = &port->buf;
 218         struct tty_buffer *next;
 219
 220         atomic_inc(&buf->priority);
 221
 222         mutex_lock(&buf->lock);
 223         /* paired w/ release in __tty_buffer_request_room; ensures there are
 224          * no pending memory accesses to the freed buffer
 225          */
 226         while ((next = smp_load_acquire(&buf->head->next)) != NULL) {
 227                 tty_buffer_free(port, buf->head);
 228                 buf->head = next;
 229         }
 230         buf->head->read = buf->head->commit;
 231
 232         if (ld && ld->ops->flush_buffer)
 233                 ld->ops->flush_buffer(tty);
 234
 235         atomic_dec(&buf->priority);
 236         mutex_unlock(&buf->lock);
 237 }
 238
 239 /**
 240  *      tty_buffer_request_room         -       grow tty buffer if needed
 241  *      @tty: tty structure
 242  *      @size: size desired
 243  *      @flags: buffer flags if new buffer allocated (default = 0)
 244  *
 245  *      Make at least size bytes of linear space available for the tty
 246  *      buffer. If we fail return the size we managed to find.
 247  *
 248  *      Will change over to a new buffer if the current buffer is encoded as
 249  *      TTY_NORMAL (so has no flags buffer) and the new buffer requires
 250  *      a flags buffer.
 251  */
 252 static int __tty_buffer_request_room(struct tty_port *port, size_t size,
 253                                      int flags)
 254 {
 255         struct tty_bufhead *buf = &port->buf;
 256         struct tty_buffer *b, *n;
 257         int left, change;
 258
 259         b = buf->tail;
 260         if (b->flags & TTYB_NORMAL)
 261                 left = 2 * b->size - b->used;
 262         else
 263                 left = b->size - b->used;
 264
 265         change = (b->flags & TTYB_NORMAL) && (~flags & TTYB_NORMAL);
 266         if (change || left < size) {
 267                 /* This is the slow path - looking for new buffers to use */
 268                 n = tty_buffer_alloc(port, size);
 269                 if (n != NULL) {
 270                         n->flags = flags;
 271                         buf->tail = n;
 272                         /* paired w/ acquire in flush_to_ldisc(); ensures
 273                          * flush_to_ldisc() sees buffer data.
 274                          */
 275                         smp_store_release(&b->commit, b->used);
 276                         /* paired w/ acquire in flush_to_ldisc(); ensures the
 277                          * latest commit value can be read before the head is
 278                          * advanced to the next buffer
 279                          */
 280                         smp_store_release(&b->next, n);
 281                 } else if (change)
 282                         size = 0;
 283                 else
 284                         size = left;
 285         }
 286         return size;
 287 }
 288
 289 int tty_buffer_request_room(struct tty_port *port, size_t size)
 290 {
 291         return __tty_buffer_request_room(port, size, 0);
 292 }
 293 EXPORT_SYMBOL_GPL(tty_buffer_request_room);
 294
 295 /**
 296  *      tty_insert_flip_string_fixed_flag - Add characters to the tty buffer
 297  *      @port: tty port
 298  *      @chars: characters
 299  *      @flag: flag value for each character
 300  *      @size: size
 301  *
 302  *      Queue a series of bytes to the tty buffering. All the characters
 303  *      passed are marked with the supplied flag. Returns the number added.
 304  */
 305
 306 int tty_insert_flip_string_fixed_flag(struct tty_port *port,
 307                 const unsigned char *chars, char flag, size_t size)
 308 {
 309         int copied = 0;
 310         do {
 311                 int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
 312                 int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0;
 313                 int space = __tty_buffer_request_room(port, goal, flags);
 314                 struct tty_buffer *tb = port->buf.tail;
 315                 if (unlikely(space == 0))
 316                         break;
 317                 memcpy(char_buf_ptr(tb, tb->used), chars, space);
 318                 if (~tb->flags & TTYB_NORMAL)
 319                         memset(flag_buf_ptr(tb, tb->used), flag, space);
 320                 tb->used += space;
 321                 copied += space;
 322                 chars += space;
 323                 /* There is a small chance that we need to split the data over
 324                    several buffers. If this is the case we must loop */
 325         } while (unlikely(size > copied));
 326         return copied;
 327 }
 328 EXPORT_SYMBOL(tty_insert_flip_string_fixed_flag);
 329
 330 /**
 331  *      tty_insert_flip_string_flags    -       Add characters to the tty buffer
 332  *      @port: tty port
 333  *      @chars: characters
 334  *      @flags: flag bytes
 335  *      @size: size
 336  *
 337  *      Queue a series of bytes to the tty buffering. For each character
 338  *      the flags array indicates the status of the character. Returns the
 339  *      number added.
 340  */
 341
 342 int tty_insert_flip_string_flags(struct tty_port *port,
 343                 const unsigned char *chars, const char *flags, size_t size)
 344 {
 345         int copied = 0;
 346         do {
 347                 int goal = min_t(size_t, size - copied, TTY_BUFFER_PAGE);
 348                 int space = tty_buffer_request_room(port, goal);
 349                 struct tty_buffer *tb = port->buf.tail;
 350                 if (unlikely(space == 0))
 351                         break;
 352                 memcpy(char_buf_ptr(tb, tb->used), chars, space);
 353                 memcpy(flag_buf_ptr(tb, tb->used), flags, space);
 354                 tb->used += space;
 355                 copied += space;
 356                 chars += space;
 357                 flags += space;
 358                 /* There is a small chance that we need to split the data over
 359                    several buffers. If this is the case we must loop */
 360         } while (unlikely(size > copied));
 361         return copied;
 362 }
 363 EXPORT_SYMBOL(tty_insert_flip_string_flags);
 364
 365 /**
 366  *      __tty_insert_flip_char   -      Add one character to the tty buffer
 367  *      @port: tty port
 368  *      @ch: character
 369  *      @flag: flag byte
 370  *
 371  *      Queue a single byte to the tty buffering, with an optional flag.
 372  *      This is the slow path of tty_insert_flip_char.
 373  */
 374 int __tty_insert_flip_char(struct tty_port *port, unsigned char ch, char flag)
 375 {
 376         struct tty_buffer *tb;
 377         int flags = (flag == TTY_NORMAL) ? TTYB_NORMAL : 0;
 378
 379         if (!__tty_buffer_request_room(port, 1, flags))
 380                 return 0;
 381
 382         tb = port->buf.tail;
 383         if (~tb->flags & TTYB_NORMAL)
 384                 *flag_buf_ptr(tb, tb->used) = flag;
 385         *char_buf_ptr(tb, tb->used++) = ch;
 386
 387         return 1;
 388 }
 389 EXPORT_SYMBOL(__tty_insert_flip_char);
 390
 391 /**
 392  *      tty_prepare_flip_string         -       make room for characters
 393  *      @port: tty port
 394  *      @chars: return pointer for character write area
 395  *      @size: desired size
 396  *
 397  *      Prepare a block of space in the buffer for data. Returns the length
 398  *      available and buffer pointer to the space which is now allocated and
 399  *      accounted for as ready for normal characters. This is used for drivers
 400  *      that need their own block copy routines into the buffer. There is no
 401  *      guarantee the buffer is a DMA target!
 402  */
 403
 404 int tty_prepare_flip_string(struct tty_port *port, unsigned char **chars,
 405                 size_t size)
 406 {
 407         int space = __tty_buffer_request_room(port, size, TTYB_NORMAL);
 408         if (likely(space)) {
 409                 struct tty_buffer *tb = port->buf.tail;
 410                 *chars = char_buf_ptr(tb, tb->used);
 411                 if (~tb->flags & TTYB_NORMAL)
 412                         memset(flag_buf_ptr(tb, tb->used), TTY_NORMAL, space);
 413                 tb->used += space;
 414         }
 415         return space;
 416 }
 417 EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
 418
 419 /**
 420  *      tty_ldisc_receive_buf           -       forward data to line discipline
 421  *      @ld:    line discipline to process input
 422  *      @p:     char buffer
 423  *      @f:     TTY_* flags buffer
 424  *      @count: number of bytes to process
 425  *
 426  *      Callers other than flush_to_ldisc() need to exclude the kworker
 427  *      from concurrent use of the line discipline, see paste_selection().
 428  *
 429  *      Returns the number of bytes processed
 430  */
 431 int tty_ldisc_receive_buf(struct tty_ldisc *ld, const unsigned char *p,
 432                           char *f, int count)
 433 {
 434         if (ld->ops->receive_buf2)
 435                 count = ld->ops->receive_buf2(ld->tty, p, f, count);
 436         else {
 437                 count = min_t(int, count, ld->tty->receive_room);
 438                 if (count && ld->ops->receive_buf)
 439                         ld->ops->receive_buf(ld->tty, p, f, count);
 440         }
 441         return count;
 442 }
 443 EXPORT_SYMBOL_GPL(tty_ldisc_receive_buf);
 444
 445 static int
 446 receive_buf(struct tty_port *port, struct tty_buffer *head, int count)
 447 {
 448         unsigned char *p = char_buf_ptr(head, head->read);
 449         char          *f = NULL;
 450         int n;
 451
 452         if (~head->flags & TTYB_NORMAL)
 453                 f = flag_buf_ptr(head, head->read);
 454
 455         n = port->client_ops->receive_buf(port, p, f, count);
 456         if (n > 0)
 457                 memset(p, 0, n);
 458         return n;
 459 }
 460
 461 /**
 462  *      flush_to_ldisc
 463  *      @work: tty structure passed from work queue.
 464  *
 465  *      This routine is called out of the software interrupt to flush data
 466  *      from the buffer chain to the line discipline.
 467  *
 468  *      The receive_buf method is single threaded for each tty instance.
 469  *
 470  *      Locking: takes buffer lock to ensure single-threaded flip buffer
 471  *               'consumer'
 472  */
 473
 474 static void flush_to_ldisc(struct work_struct *work)
 475 {
 476         struct tty_port *port = container_of(work, struct tty_port, buf.work);
 477         struct tty_bufhead *buf = &port->buf;
 478
 479         mutex_lock(&buf->lock);
 480
 481         while (1) {
 482                 struct tty_buffer *head = buf->head;
 483                 struct tty_buffer *next;
 484                 int count;
 485
 486                 /* Ldisc or user is trying to gain exclusive access */
 487                 if (atomic_read(&buf->priority))
 488                         break;
 489
 490                 /* paired w/ release in __tty_buffer_request_room();
 491                  * ensures commit value read is not stale if the head
 492                  * is advancing to the next buffer
 493                  */
 494                 next = smp_load_acquire(&head->next);
 495                 /* paired w/ release in __tty_buffer_request_room() or in
 496                  * tty_buffer_flush(); ensures we see the committed buffer data
 497                  */
 498                 count = smp_load_acquire(&head->commit) - head->read;
 499                 if (!count) {
 500                         if (next == NULL)
 501                                 break;
 502                         buf->head = next;
 503                         tty_buffer_free(port, head);
 504                         continue;
 505                 }
 506
 507                 count = receive_buf(port, head, count);
 508                 if (!count)
 509                         break;
 510                 head->read += count;
 511
 512                 if (need_resched())
 513                         cond_resched();
 514         }
 515
 516         mutex_unlock(&buf->lock);
 517
 518 }
 519
 520 static inline void tty_flip_buffer_commit(struct tty_buffer *tail)
 521 {
 522         /*
 523          * Paired w/ acquire in flush_to_ldisc(); ensures flush_to_ldisc() sees
 524          * buffer data.
 525          */
 526         smp_store_release(&tail->commit, tail->used);
 527 }
 528
 529 /**
 530  *      tty_flip_buffer_push    -       terminal
 531  *      @port: tty port to push
 532  *
 533  *      Queue a push of the terminal flip buffers to the line discipline.
 534  *      Can be called from IRQ/atomic context.
 535  *
 536  *      In the event of the queue being busy for flipping the work will be
 537  *      held off and retried later.
 538  */
 539
 540 void tty_flip_buffer_push(struct tty_port *port)
 541 {
 542         struct tty_bufhead *buf = &port->buf;
 543
 544         tty_flip_buffer_commit(buf->tail);
 545         queue_work(system_unbound_wq, &buf->work);
 546 }
 547 EXPORT_SYMBOL(tty_flip_buffer_push);
 548
 549 /**
 550  * tty_insert_flip_string_and_push_buffer - add characters to the tty buffer and
 551  *      push
 552  * @port: tty port
 553  * @chars: characters
 554  * @size: size
 555  *
 556  * The function combines tty_insert_flip_string() and tty_flip_buffer_push()
 557  * with the exception of properly holding the @port->lock.
 558  *
 559  * To be used only internally (by pty currently).
 560  *
 561  * Returns: the number added.
 562  */
 563 int tty_insert_flip_string_and_push_buffer(struct tty_port *port,
 564                 const unsigned char *chars, size_t size)
 565 {
 566         struct tty_bufhead *buf = &port->buf;
 567         unsigned long flags;
 568
 569         spin_lock_irqsave(&port->lock, flags);
 570         size = tty_insert_flip_string(port, chars, size);
 571         if (size)
 572                 tty_flip_buffer_commit(buf->tail);
 573         spin_unlock_irqrestore(&port->lock, flags);
 574
 575         queue_work(system_unbound_wq, &buf->work);
 576
 577         return size;
 578 }
 579
 580 /**
 581  *      tty_buffer_init         -       prepare a tty buffer structure
 582  *      @tty: tty to initialise
 583  *
 584  *      Set up the initial state of the buffer management for a tty device.
 585  *      Must be called before the other tty buffer functions are used.
 586  */
 587
 588 void tty_buffer_init(struct tty_port *port)
 589 {
 590         struct tty_bufhead *buf = &port->buf;
 591
 592         mutex_init(&buf->lock);
 593         tty_buffer_reset(&buf->sentinel, 0);
 594         buf->head = &buf->sentinel;
 595         buf->tail = &buf->sentinel;
 596         init_llist_head(&buf->free);
 597         atomic_set(&buf->mem_used, 0);
 598         atomic_set(&buf->priority, 0);
 599         INIT_WORK(&buf->work, flush_to_ldisc);
 600         buf->mem_limit = TTYB_DEFAULT_MEM_LIMIT;
 601 }
 602
 603 /**
 604  *      tty_buffer_set_limit    -       change the tty buffer memory limit
 605  *      @port: tty port to change
 606  *
 607  *      Change the tty buffer memory limit.
 608  *      Must be called before the other tty buffer functions are used.
 609  */
 610
 611 int tty_buffer_set_limit(struct tty_port *port, int limit)
 612 {
 613         if (limit < MIN_TTYB_SIZE)
 614                 return -EINVAL;
 615         port->buf.mem_limit = limit;
 616         return 0;
 617 }
 618 EXPORT_SYMBOL_GPL(tty_buffer_set_limit);
 619
 620 /* slave ptys can claim nested buffer lock when handling BRK and INTR */
 621 void tty_buffer_set_lock_subclass(struct tty_port *port)
 622 {
 623         lockdep_set_subclass(&port->buf.lock, TTY_LOCK_SLAVE);
 624 }
 625
 626 bool tty_buffer_restart_work(struct tty_port *port)
 627 {
 628         return queue_work(system_unbound_wq, &port->buf.work);
 629 }
 630
 631 bool tty_buffer_cancel_work(struct tty_port *port)
 632 {
 633         return cancel_work_sync(&port->buf.work);
 634 }
 635
 636 void tty_buffer_flush_work(struct tty_port *port)
 637 {
 638         flush_work(&port->buf.work);
 639 }