fs/splice.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * "splice": joining two ropes together by interweaving their strands.
   4  *
   5  * This is the "extended pipe" functionality, where a pipe is used as
   6  * an arbitrary in-memory buffer. Think of a pipe as a small kernel
   7  * buffer that you can use to transfer data from one end to the other.
   8  *
   9  * The traditional unix read/write is extended with a "splice()" operation
  10  * that transfers data buffers to or from a pipe buffer.
  11  *
  12  * Named by Larry McVoy, original implementation from Linus, extended by
  13  * Jens to support splicing to files, network, direct splicing, etc and
  14  * fixing lots of bugs.
  15  *
  16  * Copyright (C) 2005-2006 Jens Axboe <[email protected]>
  17  * Copyright (C) 2005-2006 Linus Torvalds <[email protected]>
  18  * Copyright (C) 2006 Ingo Molnar <[email protected]>
  19  *
  20  */
  21 #include <linux/bvec.h>
  22 #include <linux/fs.h>
  23 #include <linux/file.h>
  24 #include <linux/pagemap.h>
  25 #include <linux/splice.h>
  26 #include <linux/memcontrol.h>
  27 #include <linux/mm_inline.h>
  28 #include <linux/swap.h>
  29 #include <linux/writeback.h>
  30 #include <linux/export.h>
  31 #include <linux/syscalls.h>
  32 #include <linux/uio.h>
  33 #include <linux/security.h>
  34 #include <linux/gfp.h>
  35 #include <linux/socket.h>
  36 #include <linux/sched/signal.h>
  37
  38 #include "internal.h"
  39
  40 /*
  41  * Attempt to steal a page from a pipe buffer. This should perhaps go into
  42  * a vm helper function, it's already simplified quite a bit by the
  43  * addition of remove_mapping(). If success is returned, the caller may
  44  * attempt to reuse this page for another destination.
  45  */
  46 static bool page_cache_pipe_buf_try_steal(struct pipe_inode_info *pipe,
  47                 struct pipe_buffer *buf)
  48 {
  49         struct page *page = buf->page;
  50         struct address_space *mapping;
  51
  52         lock_page(page);
  53
  54         mapping = page_mapping(page);
  55         if (mapping) {
  56                 WARN_ON(!PageUptodate(page));
  57
  58                 /*
  59                  * At least for ext2 with nobh option, we need to wait on
  60                  * writeback completing on this page, since we'll remove it
  61                  * from the pagecache.  Otherwise truncate wont wait on the
  62                  * page, allowing the disk blocks to be reused by someone else
  63                  * before we actually wrote our data to them. fs corruption
  64                  * ensues.
  65                  */
  66                 wait_on_page_writeback(page);
  67
  68                 if (page_has_private(page) &&
  69                     !try_to_release_page(page, GFP_KERNEL))
  70                         goto out_unlock;
  71
  72                 /*
  73                  * If we succeeded in removing the mapping, set LRU flag
  74                  * and return good.
  75                  */
  76                 if (remove_mapping(mapping, page)) {
  77                         buf->flags |= PIPE_BUF_FLAG_LRU;
  78                         return true;
  79                 }
  80         }
  81
  82         /*
  83          * Raced with truncate or failed to remove page from current
  84          * address space, unlock and return failure.
  85          */
  86 out_unlock:
  87         unlock_page(page);
  88         return false;
  89 }
  90
  91 static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
  92                                         struct pipe_buffer *buf)
  93 {
  94         put_page(buf->page);
  95         buf->flags &= ~PIPE_BUF_FLAG_LRU;
  96 }
  97
  98 /*
  99  * Check whether the contents of buf is OK to access. Since the content
 100  * is a page cache page, IO may be in flight.
 101  */
 102 static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
 103                                        struct pipe_buffer *buf)
 104 {
 105         struct page *page = buf->page;
 106         int err;
 107
 108         if (!PageUptodate(page)) {
 109                 lock_page(page);
 110
 111                 /*
 112                  * Page got truncated/unhashed. This will cause a 0-byte
 113                  * splice, if this is the first page.
 114                  */
 115                 if (!page->mapping) {
 116                         err = -ENODATA;
 117                         goto error;
 118                 }
 119
 120                 /*
 121                  * Uh oh, read-error from disk.
 122                  */
 123                 if (!PageUptodate(page)) {
 124                         err = -EIO;
 125                         goto error;
 126                 }
 127
 128                 /*
 129                  * Page is ok afterall, we are done.
 130                  */
 131                 unlock_page(page);
 132         }
 133
 134         return 0;
 135 error:
 136         unlock_page(page);
 137         return err;
 138 }
 139
 140 const struct pipe_buf_operations page_cache_pipe_buf_ops = {
 141         .confirm        = page_cache_pipe_buf_confirm,
 142         .release        = page_cache_pipe_buf_release,
 143         .try_steal      = page_cache_pipe_buf_try_steal,
 144         .get            = generic_pipe_buf_get,
 145 };
 146
 147 static bool user_page_pipe_buf_try_steal(struct pipe_inode_info *pipe,
 148                 struct pipe_buffer *buf)
 149 {
 150         if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
 151                 return false;
 152
 153         buf->flags |= PIPE_BUF_FLAG_LRU;
 154         return generic_pipe_buf_try_steal(pipe, buf);
 155 }
 156
 157 static const struct pipe_buf_operations user_page_pipe_buf_ops = {
 158         .release        = page_cache_pipe_buf_release,
 159         .try_steal      = user_page_pipe_buf_try_steal,
 160         .get            = generic_pipe_buf_get,
 161 };
 162
 163 static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
 164 {
 165         smp_mb();
 166         if (waitqueue_active(&pipe->rd_wait))
 167                 wake_up_interruptible(&pipe->rd_wait);
 168         kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
 169 }
 170
 171 /**
 172  * splice_to_pipe - fill passed data into a pipe
 173  * @pipe:       pipe to fill
 174  * @spd:        data to fill
 175  *
 176  * Description:
 177  *    @spd contains a map of pages and len/offset tuples, along with
 178  *    the struct pipe_buf_operations associated with these pages. This
 179  *    function will link that data to the pipe.
 180  *
 181  */
 182 ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
 183                        struct splice_pipe_desc *spd)
 184 {
 185         unsigned int spd_pages = spd->nr_pages;
 186         unsigned int tail = pipe->tail;
 187         unsigned int head = pipe->head;
 188         unsigned int mask = pipe->ring_size - 1;
 189         int ret = 0, page_nr = 0;
 190
 191         if (!spd_pages)
 192                 return 0;
 193
 194         if (unlikely(!pipe->readers)) {
 195                 send_sig(SIGPIPE, current, 0);
 196                 ret = -EPIPE;
 197                 goto out;
 198         }
 199
 200         while (!pipe_full(head, tail, pipe->max_usage)) {
 201                 struct pipe_buffer *buf = &pipe->bufs[head & mask];
 202
 203                 buf->page = spd->pages[page_nr];
 204                 buf->offset = spd->partial[page_nr].offset;
 205                 buf->len = spd->partial[page_nr].len;
 206                 buf->private = spd->partial[page_nr].private;
 207                 buf->ops = spd->ops;
 208                 buf->flags = 0;
 209
 210                 head++;
 211                 pipe->head = head;
 212                 page_nr++;
 213                 ret += buf->len;
 214
 215                 if (!--spd->nr_pages)
 216                         break;
 217         }
 218
 219         if (!ret)
 220                 ret = -EAGAIN;
 221
 222 out:
 223         while (page_nr < spd_pages)
 224                 spd->spd_release(spd, page_nr++);
 225
 226         return ret;
 227 }
 228 EXPORT_SYMBOL_GPL(splice_to_pipe);
 229
 230 ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
 231 {
 232         unsigned int head = pipe->head;
 233         unsigned int tail = pipe->tail;
 234         unsigned int mask = pipe->ring_size - 1;
 235         int ret;
 236
 237         if (unlikely(!pipe->readers)) {
 238                 send_sig(SIGPIPE, current, 0);
 239                 ret = -EPIPE;
 240         } else if (pipe_full(head, tail, pipe->max_usage)) {
 241                 ret = -EAGAIN;
 242         } else {
 243                 pipe->bufs[head & mask] = *buf;
 244                 pipe->head = head + 1;
 245                 return buf->len;
 246         }
 247         pipe_buf_release(pipe, buf);
 248         return ret;
 249 }
 250 EXPORT_SYMBOL(add_to_pipe);
 251
 252 /*
 253  * Check if we need to grow the arrays holding pages and partial page
 254  * descriptions.
 255  */
 256 int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
 257 {
 258         unsigned int max_usage = READ_ONCE(pipe->max_usage);
 259
 260         spd->nr_pages_max = max_usage;
 261         if (max_usage <= PIPE_DEF_BUFFERS)
 262                 return 0;
 263
 264         spd->pages = kmalloc_array(max_usage, sizeof(struct page *), GFP_KERNEL);
 265         spd->partial = kmalloc_array(max_usage, sizeof(struct partial_page),
 266                                      GFP_KERNEL);
 267
 268         if (spd->pages && spd->partial)
 269                 return 0;
 270
 271         kfree(spd->pages);
 272         kfree(spd->partial);
 273         return -ENOMEM;
 274 }
 275
 276 void splice_shrink_spd(struct splice_pipe_desc *spd)
 277 {
 278         if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
 279                 return;
 280
 281         kfree(spd->pages);
 282         kfree(spd->partial);
 283 }
 284
 285 /**
 286  * generic_file_splice_read - splice data from file to a pipe
 287  * @in:         file to splice from
 288  * @ppos:       position in @in
 289  * @pipe:       pipe to splice to
 290  * @len:        number of bytes to splice
 291  * @flags:      splice modifier flags
 292  *
 293  * Description:
 294  *    Will read pages from given file and fill them into a pipe. Can be
 295  *    used as long as it has more or less sane ->read_iter().
 296  *
 297  */
 298 ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
 299                                  struct pipe_inode_info *pipe, size_t len,
 300                                  unsigned int flags)
 301 {
 302         struct iov_iter to;
 303         struct kiocb kiocb;
 304         unsigned int i_head;
 305         int ret;
 306
 307         iov_iter_pipe(&to, READ, pipe, len);
 308         i_head = to.head;
 309         init_sync_kiocb(&kiocb, in);
 310         kiocb.ki_pos = *ppos;
 311         ret = call_read_iter(in, &kiocb, &to);
 312         if (ret > 0) {
 313                 *ppos = kiocb.ki_pos;
 314                 file_accessed(in);
 315         } else if (ret < 0) {
 316                 to.head = i_head;
 317                 to.iov_offset = 0;
 318                 iov_iter_advance(&to, 0); /* to free what was emitted */
 319                 /*
 320                  * callers of ->splice_read() expect -EAGAIN on
 321                  * "can't put anything in there", rather than -EFAULT.
 322                  */
 323                 if (ret == -EFAULT)
 324                         ret = -EAGAIN;
 325         }
 326
 327         return ret;
 328 }
 329 EXPORT_SYMBOL(generic_file_splice_read);
 330
 331 const struct pipe_buf_operations default_pipe_buf_ops = {
 332         .release        = generic_pipe_buf_release,
 333         .try_steal      = generic_pipe_buf_try_steal,
 334         .get            = generic_pipe_buf_get,
 335 };
 336
 337 /* Pipe buffer operations for a socket and similar. */
 338 const struct pipe_buf_operations nosteal_pipe_buf_ops = {
 339         .release        = generic_pipe_buf_release,
 340         .get            = generic_pipe_buf_get,
 341 };
 342 EXPORT_SYMBOL(nosteal_pipe_buf_ops);
 343
 344 /*
 345  * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
 346  * using sendpage(). Return the number of bytes sent.
 347  */
 348 static int pipe_to_sendpage(struct pipe_inode_info *pipe,
 349                             struct pipe_buffer *buf, struct splice_desc *sd)
 350 {
 351         struct file *file = sd->u.file;
 352         loff_t pos = sd->pos;
 353         int more;
 354
 355         if (!likely(file->f_op->sendpage))
 356                 return -EINVAL;
 357
 358         more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
 359
 360         if (sd->len < sd->total_len &&
 361             pipe_occupancy(pipe->head, pipe->tail) > 1)
 362                 more |= MSG_SENDPAGE_NOTLAST;
 363
 364         return file->f_op->sendpage(file, buf->page, buf->offset,
 365                                     sd->len, &pos, more);
 366 }
 367
 368 static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
 369 {
 370         smp_mb();
 371         if (waitqueue_active(&pipe->wr_wait))
 372                 wake_up_interruptible(&pipe->wr_wait);
 373         kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
 374 }
 375
 376 /**
 377  * splice_from_pipe_feed - feed available data from a pipe to a file
 378  * @pipe:       pipe to splice from
 379  * @sd:         information to @actor
 380  * @actor:      handler that splices the data
 381  *
 382  * Description:
 383  *    This function loops over the pipe and calls @actor to do the
 384  *    actual moving of a single struct pipe_buffer to the desired
 385  *    destination.  It returns when there's no more buffers left in
 386  *    the pipe or if the requested number of bytes (@sd->total_len)
 387  *    have been copied.  It returns a positive number (one) if the
 388  *    pipe needs to be filled with more data, zero if the required
 389  *    number of bytes have been copied and -errno on error.
 390  *
 391  *    This, together with splice_from_pipe_{begin,end,next}, may be
 392  *    used to implement the functionality of __splice_from_pipe() when
 393  *    locking is required around copying the pipe buffers to the
 394  *    destination.
 395  */
 396 static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
 397                           splice_actor *actor)
 398 {
 399         unsigned int head = pipe->head;
 400         unsigned int tail = pipe->tail;
 401         unsigned int mask = pipe->ring_size - 1;
 402         int ret;
 403
 404         while (!pipe_empty(head, tail)) {
 405                 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
 406
 407                 sd->len = buf->len;
 408                 if (sd->len > sd->total_len)
 409                         sd->len = sd->total_len;
 410
 411                 ret = pipe_buf_confirm(pipe, buf);
 412                 if (unlikely(ret)) {
 413                         if (ret == -ENODATA)
 414                                 ret = 0;
 415                         return ret;
 416                 }
 417
 418                 ret = actor(pipe, buf, sd);
 419                 if (ret <= 0)
 420                         return ret;
 421
 422                 buf->offset += ret;
 423                 buf->len -= ret;
 424
 425                 sd->num_spliced += ret;
 426                 sd->len -= ret;
 427                 sd->pos += ret;
 428                 sd->total_len -= ret;
 429
 430                 if (!buf->len) {
 431                         pipe_buf_release(pipe, buf);
 432                         tail++;
 433                         pipe->tail = tail;
 434                         if (pipe->files)
 435                                 sd->need_wakeup = true;
 436                 }
 437
 438                 if (!sd->total_len)
 439                         return 0;
 440         }
 441
 442         return 1;
 443 }
 444
 445 /* We know we have a pipe buffer, but maybe it's empty? */
 446 static inline bool eat_empty_buffer(struct pipe_inode_info *pipe)
 447 {
 448         unsigned int tail = pipe->tail;
 449         unsigned int mask = pipe->ring_size - 1;
 450         struct pipe_buffer *buf = &pipe->bufs[tail & mask];
 451
 452         if (unlikely(!buf->len)) {
 453                 pipe_buf_release(pipe, buf);
 454                 pipe->tail = tail+1;
 455                 return true;
 456         }
 457
 458         return false;
 459 }
 460
 461 /**
 462  * splice_from_pipe_next - wait for some data to splice from
 463  * @pipe:       pipe to splice from
 464  * @sd:         information about the splice operation
 465  *
 466  * Description:
 467  *    This function will wait for some data and return a positive
 468  *    value (one) if pipe buffers are available.  It will return zero
 469  *    or -errno if no more data needs to be spliced.
 470  */
 471 static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
 472 {
 473         /*
 474          * Check for signal early to make process killable when there are
 475          * always buffers available
 476          */
 477         if (signal_pending(current))
 478                 return -ERESTARTSYS;
 479
 480 repeat:
 481         while (pipe_empty(pipe->head, pipe->tail)) {
 482                 if (!pipe->writers)
 483                         return 0;
 484
 485                 if (sd->num_spliced)
 486                         return 0;
 487
 488                 if (sd->flags & SPLICE_F_NONBLOCK)
 489                         return -EAGAIN;
 490
 491                 if (signal_pending(current))
 492                         return -ERESTARTSYS;
 493
 494                 if (sd->need_wakeup) {
 495                         wakeup_pipe_writers(pipe);
 496                         sd->need_wakeup = false;
 497                 }
 498
 499                 pipe_wait_readable(pipe);
 500         }
 501
 502         if (eat_empty_buffer(pipe))
 503                 goto repeat;
 504
 505         return 1;
 506 }
 507
 508 /**
 509  * splice_from_pipe_begin - start splicing from pipe
 510  * @sd:         information about the splice operation
 511  *
 512  * Description:
 513  *    This function should be called before a loop containing
 514  *    splice_from_pipe_next() and splice_from_pipe_feed() to
 515  *    initialize the necessary fields of @sd.
 516  */
 517 static void splice_from_pipe_begin(struct splice_desc *sd)
 518 {
 519         sd->num_spliced = 0;
 520         sd->need_wakeup = false;
 521 }
 522
 523 /**
 524  * splice_from_pipe_end - finish splicing from pipe
 525  * @pipe:       pipe to splice from
 526  * @sd:         information about the splice operation
 527  *
 528  * Description:
 529  *    This function will wake up pipe writers if necessary.  It should
 530  *    be called after a loop containing splice_from_pipe_next() and
 531  *    splice_from_pipe_feed().
 532  */
 533 static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
 534 {
 535         if (sd->need_wakeup)
 536                 wakeup_pipe_writers(pipe);
 537 }
 538
 539 /**
 540  * __splice_from_pipe - splice data from a pipe to given actor
 541  * @pipe:       pipe to splice from
 542  * @sd:         information to @actor
 543  * @actor:      handler that splices the data
 544  *
 545  * Description:
 546  *    This function does little more than loop over the pipe and call
 547  *    @actor to do the actual moving of a single struct pipe_buffer to
 548  *    the desired destination. See pipe_to_file, pipe_to_sendpage, or
 549  *    pipe_to_user.
 550  *
 551  */
 552 ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
 553                            splice_actor *actor)
 554 {
 555         int ret;
 556
 557         splice_from_pipe_begin(sd);
 558         do {
 559                 cond_resched();
 560                 ret = splice_from_pipe_next(pipe, sd);
 561                 if (ret > 0)
 562                         ret = splice_from_pipe_feed(pipe, sd, actor);
 563         } while (ret > 0);
 564         splice_from_pipe_end(pipe, sd);
 565
 566         return sd->num_spliced ? sd->num_spliced : ret;
 567 }
 568 EXPORT_SYMBOL(__splice_from_pipe);
 569
 570 /**
 571  * splice_from_pipe - splice data from a pipe to a file
 572  * @pipe:       pipe to splice from
 573  * @out:        file to splice to
 574  * @ppos:       position in @out
 575  * @len:        how many bytes to splice
 576  * @flags:      splice modifier flags
 577  * @actor:      handler that splices the data
 578  *
 579  * Description:
 580  *    See __splice_from_pipe. This function locks the pipe inode,
 581  *    otherwise it's identical to __splice_from_pipe().
 582  *
 583  */
 584 ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
 585                          loff_t *ppos, size_t len, unsigned int flags,
 586                          splice_actor *actor)
 587 {
 588         ssize_t ret;
 589         struct splice_desc sd = {
 590                 .total_len = len,
 591                 .flags = flags,
 592                 .pos = *ppos,
 593                 .u.file = out,
 594         };
 595
 596         pipe_lock(pipe);
 597         ret = __splice_from_pipe(pipe, &sd, actor);
 598         pipe_unlock(pipe);
 599
 600         return ret;
 601 }
 602
 603 /**
 604  * iter_file_splice_write - splice data from a pipe to a file
 605  * @pipe:       pipe info
 606  * @out:        file to write to
 607  * @ppos:       position in @out
 608  * @len:        number of bytes to splice
 609  * @flags:      splice modifier flags
 610  *
 611  * Description:
 612  *    Will either move or copy pages (determined by @flags options) from
 613  *    the given pipe inode to the given file.
 614  *    This one is ->write_iter-based.
 615  *
 616  */
 617 ssize_t
 618 iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
 619                           loff_t *ppos, size_t len, unsigned int flags)
 620 {
 621         struct splice_desc sd = {
 622                 .total_len = len,
 623                 .flags = flags,
 624                 .pos = *ppos,
 625                 .u.file = out,
 626         };
 627         int nbufs = pipe->max_usage;
 628         struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
 629                                         GFP_KERNEL);
 630         ssize_t ret;
 631
 632         if (unlikely(!array))
 633                 return -ENOMEM;
 634
 635         pipe_lock(pipe);
 636
 637         splice_from_pipe_begin(&sd);
 638         while (sd.total_len) {
 639                 struct iov_iter from;
 640                 unsigned int head, tail, mask;
 641                 size_t left;
 642                 int n;
 643
 644                 ret = splice_from_pipe_next(pipe, &sd);
 645                 if (ret <= 0)
 646                         break;
 647
 648                 if (unlikely(nbufs < pipe->max_usage)) {
 649                         kfree(array);
 650                         nbufs = pipe->max_usage;
 651                         array = kcalloc(nbufs, sizeof(struct bio_vec),
 652                                         GFP_KERNEL);
 653                         if (!array) {
 654                                 ret = -ENOMEM;
 655                                 break;
 656                         }
 657                 }
 658
 659                 head = pipe->head;
 660                 tail = pipe->tail;
 661                 mask = pipe->ring_size - 1;
 662
 663                 /* build the vector */
 664                 left = sd.total_len;
 665                 for (n = 0; !pipe_empty(head, tail) && left && n < nbufs; tail++) {
 666                         struct pipe_buffer *buf = &pipe->bufs[tail & mask];
 667                         size_t this_len = buf->len;
 668
 669                         /* zero-length bvecs are not supported, skip them */
 670                         if (!this_len)
 671                                 continue;
 672                         this_len = min(this_len, left);
 673
 674                         ret = pipe_buf_confirm(pipe, buf);
 675                         if (unlikely(ret)) {
 676                                 if (ret == -ENODATA)
 677                                         ret = 0;
 678                                 goto done;
 679                         }
 680
 681                         array[n].bv_page = buf->page;
 682                         array[n].bv_len = this_len;
 683                         array[n].bv_offset = buf->offset;
 684                         left -= this_len;
 685                         n++;
 686                 }
 687
 688                 iov_iter_bvec(&from, WRITE, array, n, sd.total_len - left);
 689                 ret = vfs_iter_write(out, &from, &sd.pos, 0);
 690                 if (ret <= 0)
 691                         break;
 692
 693                 sd.num_spliced += ret;
 694                 sd.total_len -= ret;
 695                 *ppos = sd.pos;
 696
 697                 /* dismiss the fully eaten buffers, adjust the partial one */
 698                 tail = pipe->tail;
 699                 while (ret) {
 700                         struct pipe_buffer *buf = &pipe->bufs[tail & mask];
 701                         if (ret >= buf->len) {
 702                                 ret -= buf->len;
 703                                 buf->len = 0;
 704                                 pipe_buf_release(pipe, buf);
 705                                 tail++;
 706                                 pipe->tail = tail;
 707                                 if (pipe->files)
 708                                         sd.need_wakeup = true;
 709                         } else {
 710                                 buf->offset += ret;
 711                                 buf->len -= ret;
 712                                 ret = 0;
 713                         }
 714                 }
 715         }
 716 done:
 717         kfree(array);
 718         splice_from_pipe_end(pipe, &sd);
 719
 720         pipe_unlock(pipe);
 721
 722         if (sd.num_spliced)
 723                 ret = sd.num_spliced;
 724
 725         return ret;
 726 }
 727
 728 EXPORT_SYMBOL(iter_file_splice_write);
 729
 730 /**
 731  * generic_splice_sendpage - splice data from a pipe to a socket
 732  * @pipe:       pipe to splice from
 733  * @out:        socket to write to
 734  * @ppos:       position in @out
 735  * @len:        number of bytes to splice
 736  * @flags:      splice modifier flags
 737  *
 738  * Description:
 739  *    Will send @len bytes from the pipe to a network socket. No data copying
 740  *    is involved.
 741  *
 742  */
 743 ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
 744                                 loff_t *ppos, size_t len, unsigned int flags)
 745 {
 746         return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
 747 }
 748
 749 EXPORT_SYMBOL(generic_splice_sendpage);
 750
 751 static int warn_unsupported(struct file *file, const char *op)
 752 {
 753         pr_debug_ratelimited(
 754                 "splice %s not supported for file %pD4 (pid: %d comm: %.20s)\n",
 755                 op, file, current->pid, current->comm);
 756         return -EINVAL;
 757 }
 758
 759 /*
 760  * Attempt to initiate a splice from pipe to file.
 761  */
 762 static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
 763                            loff_t *ppos, size_t len, unsigned int flags)
 764 {
 765         if (unlikely(!out->f_op->splice_write))
 766                 return warn_unsupported(out, "write");
 767         return out->f_op->splice_write(pipe, out, ppos, len, flags);
 768 }
 769
 770 /*
 771  * Attempt to initiate a splice from a file to a pipe.
 772  */
 773 static long do_splice_to(struct file *in, loff_t *ppos,
 774                          struct pipe_inode_info *pipe, size_t len,
 775                          unsigned int flags)
 776 {
 777         int ret;
 778
 779         if (unlikely(!(in->f_mode & FMODE_READ)))
 780                 return -EBADF;
 781
 782         ret = rw_verify_area(READ, in, ppos, len);
 783         if (unlikely(ret < 0))
 784                 return ret;
 785
 786         if (unlikely(len > MAX_RW_COUNT))
 787                 len = MAX_RW_COUNT;
 788
 789         if (unlikely(!in->f_op->splice_read))
 790                 return warn_unsupported(in, "read");
 791         return in->f_op->splice_read(in, ppos, pipe, len, flags);
 792 }
 793
 794 /**
 795  * splice_direct_to_actor - splices data directly between two non-pipes
 796  * @in:         file to splice from
 797  * @sd:         actor information on where to splice to
 798  * @actor:      handles the data splicing
 799  *
 800  * Description:
 801  *    This is a special case helper to splice directly between two
 802  *    points, without requiring an explicit pipe. Internally an allocated
 803  *    pipe is cached in the process, and reused during the lifetime of
 804  *    that process.
 805  *
 806  */
 807 ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
 808                                splice_direct_actor *actor)
 809 {
 810         struct pipe_inode_info *pipe;
 811         long ret, bytes;
 812         umode_t i_mode;
 813         size_t len;
 814         int i, flags, more;
 815
 816         /*
 817          * We require the input being a regular file, as we don't want to
 818          * randomly drop data for eg socket -> socket splicing. Use the
 819          * piped splicing for that!
 820          */
 821         i_mode = file_inode(in)->i_mode;
 822         if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
 823                 return -EINVAL;
 824
 825         /*
 826          * neither in nor out is a pipe, setup an internal pipe attached to
 827          * 'out' and transfer the wanted data from 'in' to 'out' through that
 828          */
 829         pipe = current->splice_pipe;
 830         if (unlikely(!pipe)) {
 831                 pipe = alloc_pipe_info();
 832                 if (!pipe)
 833                         return -ENOMEM;
 834
 835                 /*
 836                  * We don't have an immediate reader, but we'll read the stuff
 837                  * out of the pipe right after the splice_to_pipe(). So set
 838                  * PIPE_READERS appropriately.
 839                  */
 840                 pipe->readers = 1;
 841
 842                 current->splice_pipe = pipe;
 843         }
 844
 845         /*
 846          * Do the splice.
 847          */
 848         ret = 0;
 849         bytes = 0;
 850         len = sd->total_len;
 851         flags = sd->flags;
 852
 853         /*
 854          * Don't block on output, we have to drain the direct pipe.
 855          */
 856         sd->flags &= ~SPLICE_F_NONBLOCK;
 857         more = sd->flags & SPLICE_F_MORE;
 858
 859         WARN_ON_ONCE(!pipe_empty(pipe->head, pipe->tail));
 860
 861         while (len) {
 862                 unsigned int p_space;
 863                 size_t read_len;
 864                 loff_t pos = sd->pos, prev_pos = pos;
 865
 866                 /* Don't try to read more the pipe has space for. */
 867                 p_space = pipe->max_usage -
 868                         pipe_occupancy(pipe->head, pipe->tail);
 869                 read_len = min_t(size_t, len, p_space << PAGE_SHIFT);
 870                 ret = do_splice_to(in, &pos, pipe, read_len, flags);
 871                 if (unlikely(ret <= 0))
 872                         goto out_release;
 873
 874                 read_len = ret;
 875                 sd->total_len = read_len;
 876
 877                 /*
 878                  * If more data is pending, set SPLICE_F_MORE
 879                  * If this is the last data and SPLICE_F_MORE was not set
 880                  * initially, clears it.
 881                  */
 882                 if (read_len < len)
 883                         sd->flags |= SPLICE_F_MORE;
 884                 else if (!more)
 885                         sd->flags &= ~SPLICE_F_MORE;
 886                 /*
 887                  * NOTE: nonblocking mode only applies to the input. We
 888                  * must not do the output in nonblocking mode as then we
 889                  * could get stuck data in the internal pipe:
 890                  */
 891                 ret = actor(pipe, sd);
 892                 if (unlikely(ret <= 0)) {
 893                         sd->pos = prev_pos;
 894                         goto out_release;
 895                 }
 896
 897                 bytes += ret;
 898                 len -= ret;
 899                 sd->pos = pos;
 900
 901                 if (ret < read_len) {
 902                         sd->pos = prev_pos + ret;
 903                         goto out_release;
 904                 }
 905         }
 906
 907 done:
 908         pipe->tail = pipe->head = 0;
 909         file_accessed(in);
 910         return bytes;
 911
 912 out_release:
 913         /*
 914          * If we did an incomplete transfer we must release
 915          * the pipe buffers in question:
 916          */
 917         for (i = 0; i < pipe->ring_size; i++) {
 918                 struct pipe_buffer *buf = &pipe->bufs[i];
 919
 920                 if (buf->ops)
 921                         pipe_buf_release(pipe, buf);
 922         }
 923
 924         if (!bytes)
 925                 bytes = ret;
 926
 927         goto done;
 928 }
 929 EXPORT_SYMBOL(splice_direct_to_actor);
 930
 931 static int direct_splice_actor(struct pipe_inode_info *pipe,
 932                                struct splice_desc *sd)
 933 {
 934         struct file *file = sd->u.file;
 935
 936         return do_splice_from(pipe, file, sd->opos, sd->total_len,
 937                               sd->flags);
 938 }
 939
 940 /**
 941  * do_splice_direct - splices data directly between two files
 942  * @in:         file to splice from
 943  * @ppos:       input file offset
 944  * @out:        file to splice to
 945  * @opos:       output file offset
 946  * @len:        number of bytes to splice
 947  * @flags:      splice modifier flags
 948  *
 949  * Description:
 950  *    For use by do_sendfile(). splice can easily emulate sendfile, but
 951  *    doing it in the application would incur an extra system call
 952  *    (splice in + splice out, as compared to just sendfile()). So this helper
 953  *    can splice directly through a process-private pipe.
 954  *
 955  */
 956 long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
 957                       loff_t *opos, size_t len, unsigned int flags)
 958 {
 959         struct splice_desc sd = {
 960                 .len            = len,
 961                 .total_len      = len,
 962                 .flags          = flags,
 963                 .pos            = *ppos,
 964                 .u.file         = out,
 965                 .opos           = opos,
 966         };
 967         long ret;
 968
 969         if (unlikely(!(out->f_mode & FMODE_WRITE)))
 970                 return -EBADF;
 971
 972         if (unlikely(out->f_flags & O_APPEND))
 973                 return -EINVAL;
 974
 975         ret = rw_verify_area(WRITE, out, opos, len);
 976         if (unlikely(ret < 0))
 977                 return ret;
 978
 979         ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
 980         if (ret > 0)
 981                 *ppos = sd.pos;
 982
 983         return ret;
 984 }
 985 EXPORT_SYMBOL(do_splice_direct);
 986
 987 static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
 988 {
 989         for (;;) {
 990                 if (unlikely(!pipe->readers)) {
 991                         send_sig(SIGPIPE, current, 0);
 992                         return -EPIPE;
 993                 }
 994                 if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
 995                         return 0;
 996                 if (flags & SPLICE_F_NONBLOCK)
 997                         return -EAGAIN;
 998                 if (signal_pending(current))
 999                         return -ERESTARTSYS;
1000                 pipe_wait_writable(pipe);
1001         }
1002 }
1003
1004 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1005                                struct pipe_inode_info *opipe,
1006                                size_t len, unsigned int flags);
1007
1008 /*
1009  * Determine where to splice to/from.
1010  */
1011 long do_splice(struct file *in, loff_t *off_in, struct file *out,
1012                loff_t *off_out, size_t len, unsigned int flags)
1013 {
1014         struct pipe_inode_info *ipipe;
1015         struct pipe_inode_info *opipe;
1016         loff_t offset;
1017         long ret;
1018
1019         if (unlikely(!(in->f_mode & FMODE_READ) ||
1020                      !(out->f_mode & FMODE_WRITE)))
1021                 return -EBADF;
1022
1023         ipipe = get_pipe_info(in, true);
1024         opipe = get_pipe_info(out, true);
1025
1026         if (ipipe && opipe) {
1027                 if (off_in || off_out)
1028                         return -ESPIPE;
1029
1030                 /* Splicing to self would be fun, but... */
1031                 if (ipipe == opipe)
1032                         return -EINVAL;
1033
1034                 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1035                         flags |= SPLICE_F_NONBLOCK;
1036
1037                 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1038         }
1039
1040         if (ipipe) {
1041                 if (off_in)
1042                         return -ESPIPE;
1043                 if (off_out) {
1044                         if (!(out->f_mode & FMODE_PWRITE))
1045                                 return -EINVAL;
1046                         offset = *off_out;
1047                 } else {
1048                         offset = out->f_pos;
1049                 }
1050
1051                 if (unlikely(out->f_flags & O_APPEND))
1052                         return -EINVAL;
1053
1054                 ret = rw_verify_area(WRITE, out, &offset, len);
1055                 if (unlikely(ret < 0))
1056                         return ret;
1057
1058                 if (in->f_flags & O_NONBLOCK)
1059                         flags |= SPLICE_F_NONBLOCK;
1060
1061                 file_start_write(out);
1062                 ret = do_splice_from(ipipe, out, &offset, len, flags);
1063                 file_end_write(out);
1064
1065                 if (!off_out)
1066                         out->f_pos = offset;
1067                 else
1068                         *off_out = offset;
1069
1070                 return ret;
1071         }
1072
1073         if (opipe) {
1074                 if (off_out)
1075                         return -ESPIPE;
1076                 if (off_in) {
1077                         if (!(in->f_mode & FMODE_PREAD))
1078                                 return -EINVAL;
1079                         offset = *off_in;
1080                 } else {
1081                         offset = in->f_pos;
1082                 }
1083
1084                 if (out->f_flags & O_NONBLOCK)
1085                         flags |= SPLICE_F_NONBLOCK;
1086
1087                 pipe_lock(opipe);
1088                 ret = wait_for_space(opipe, flags);
1089                 if (!ret) {
1090                         unsigned int p_space;
1091
1092                         /* Don't try to read more the pipe has space for. */
1093                         p_space = opipe->max_usage - pipe_occupancy(opipe->head, opipe->tail);
1094                         len = min_t(size_t, len, p_space << PAGE_SHIFT);
1095
1096                         ret = do_splice_to(in, &offset, opipe, len, flags);
1097                 }
1098                 pipe_unlock(opipe);
1099                 if (ret > 0)
1100                         wakeup_pipe_readers(opipe);
1101                 if (!off_in)
1102                         in->f_pos = offset;
1103                 else
1104                         *off_in = offset;
1105
1106                 return ret;
1107         }
1108
1109         return -EINVAL;
1110 }
1111
1112 static long __do_splice(struct file *in, loff_t __user *off_in,
1113                         struct file *out, loff_t __user *off_out,
1114                         size_t len, unsigned int flags)
1115 {
1116         struct pipe_inode_info *ipipe;
1117         struct pipe_inode_info *opipe;
1118         loff_t offset, *__off_in = NULL, *__off_out = NULL;
1119         long ret;
1120
1121         ipipe = get_pipe_info(in, true);
1122         opipe = get_pipe_info(out, true);
1123
1124         if (ipipe && off_in)
1125                 return -ESPIPE;
1126         if (opipe && off_out)
1127                 return -ESPIPE;
1128
1129         if (off_out) {
1130                 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1131                         return -EFAULT;
1132                 __off_out = &offset;
1133         }
1134         if (off_in) {
1135                 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1136                         return -EFAULT;
1137                 __off_in = &offset;
1138         }
1139
1140         ret = do_splice(in, __off_in, out, __off_out, len, flags);
1141         if (ret < 0)
1142                 return ret;
1143
1144         if (__off_out && copy_to_user(off_out, __off_out, sizeof(loff_t)))
1145                 return -EFAULT;
1146         if (__off_in && copy_to_user(off_in, __off_in, sizeof(loff_t)))
1147                 return -EFAULT;
1148
1149         return ret;
1150 }
1151
1152 static int iter_to_pipe(struct iov_iter *from,
1153                         struct pipe_inode_info *pipe,
1154                         unsigned flags)
1155 {
1156         struct pipe_buffer buf = {
1157                 .ops = &user_page_pipe_buf_ops,
1158                 .flags = flags
1159         };
1160         size_t total = 0;
1161         int ret = 0;
1162         bool failed = false;
1163
1164         while (iov_iter_count(from) && !failed) {
1165                 struct page *pages[16];
1166                 ssize_t copied;
1167                 size_t start;
1168                 int n;
1169
1170                 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1171                 if (copied <= 0) {
1172                         ret = copied;
1173                         break;
1174                 }
1175
1176                 for (n = 0; copied; n++, start = 0) {
1177                         int size = min_t(int, copied, PAGE_SIZE - start);
1178                         if (!failed) {
1179                                 buf.page = pages[n];
1180                                 buf.offset = start;
1181                                 buf.len = size;
1182                                 ret = add_to_pipe(pipe, &buf);
1183                                 if (unlikely(ret < 0)) {
1184                                         failed = true;
1185                                 } else {
1186                                         iov_iter_advance(from, ret);
1187                                         total += ret;
1188                                 }
1189                         } else {
1190                                 put_page(pages[n]);
1191                         }
1192                         copied -= size;
1193                 }
1194         }
1195         return total ? total : ret;
1196 }
1197
1198 static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1199                         struct splice_desc *sd)
1200 {
1201         int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1202         return n == sd->len ? n : -EFAULT;
1203 }
1204
1205 /*
1206  * For lack of a better implementation, implement vmsplice() to userspace
1207  * as a simple copy of the pipes pages to the user iov.
1208  */
1209 static long vmsplice_to_user(struct file *file, struct iov_iter *iter,
1210                              unsigned int flags)
1211 {
1212         struct pipe_inode_info *pipe = get_pipe_info(file, true);
1213         struct splice_desc sd = {
1214                 .total_len = iov_iter_count(iter),
1215                 .flags = flags,
1216                 .u.data = iter
1217         };
1218         long ret = 0;
1219
1220         if (!pipe)
1221                 return -EBADF;
1222
1223         if (sd.total_len) {
1224                 pipe_lock(pipe);
1225                 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1226                 pipe_unlock(pipe);
1227         }
1228
1229         return ret;
1230 }
1231
1232 /*
1233  * vmsplice splices a user address range into a pipe. It can be thought of
1234  * as splice-from-memory, where the regular splice is splice-from-file (or
1235  * to file). In both cases the output is a pipe, naturally.
1236  */
1237 static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter,
1238                              unsigned int flags)
1239 {
1240         struct pipe_inode_info *pipe;
1241         long ret = 0;
1242         unsigned buf_flag = 0;
1243
1244         if (flags & SPLICE_F_GIFT)
1245                 buf_flag = PIPE_BUF_FLAG_GIFT;
1246
1247         pipe = get_pipe_info(file, true);
1248         if (!pipe)
1249                 return -EBADF;
1250
1251         pipe_lock(pipe);
1252         ret = wait_for_space(pipe, flags);
1253         if (!ret)
1254                 ret = iter_to_pipe(iter, pipe, buf_flag);
1255         pipe_unlock(pipe);
1256         if (ret > 0)
1257                 wakeup_pipe_readers(pipe);
1258         return ret;
1259 }
1260
1261 static int vmsplice_type(struct fd f, int *type)
1262 {
1263         if (!f.file)
1264                 return -EBADF;
1265         if (f.file->f_mode & FMODE_WRITE) {
1266                 *type = WRITE;
1267         } else if (f.file->f_mode & FMODE_READ) {
1268                 *type = READ;
1269         } else {
1270                 fdput(f);
1271                 return -EBADF;
1272         }
1273         return 0;
1274 }
1275
1276 /*
1277  * Note that vmsplice only really supports true splicing _from_ user memory
1278  * to a pipe, not the other way around. Splicing from user memory is a simple
1279  * operation that can be supported without any funky alignment restrictions
1280  * or nasty vm tricks. We simply map in the user memory and fill them into
1281  * a pipe. The reverse isn't quite as easy, though. There are two possible
1282  * solutions for that:
1283  *
1284  *      - memcpy() the data internally, at which point we might as well just
1285  *        do a regular read() on the buffer anyway.
1286  *      - Lots of nasty vm tricks, that are neither fast nor flexible (it
1287  *        has restriction limitations on both ends of the pipe).
1288  *
1289  * Currently we punt and implement it as a normal copy, see pipe_to_user().
1290  *
1291  */
1292 SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov,
1293                 unsigned long, nr_segs, unsigned int, flags)
1294 {
1295         struct iovec iovstack[UIO_FASTIOV];
1296         struct iovec *iov = iovstack;
1297         struct iov_iter iter;
1298         ssize_t error;
1299         struct fd f;
1300         int type;
1301
1302         if (unlikely(flags & ~SPLICE_F_ALL))
1303                 return -EINVAL;
1304
1305         f = fdget(fd);
1306         error = vmsplice_type(f, &type);
1307         if (error)
1308                 return error;
1309
1310         error = import_iovec(type, uiov, nr_segs,
1311                              ARRAY_SIZE(iovstack), &iov, &iter);
1312         if (error < 0)
1313                 goto out_fdput;
1314
1315         if (!iov_iter_count(&iter))
1316                 error = 0;
1317         else if (iov_iter_rw(&iter) == WRITE)
1318                 error = vmsplice_to_pipe(f.file, &iter, flags);
1319         else
1320                 error = vmsplice_to_user(f.file, &iter, flags);
1321
1322         kfree(iov);
1323 out_fdput:
1324         fdput(f);
1325         return error;
1326 }
1327
1328 SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1329                 int, fd_out, loff_t __user *, off_out,
1330                 size_t, len, unsigned int, flags)
1331 {
1332         struct fd in, out;
1333         long error;
1334
1335         if (unlikely(!len))
1336                 return 0;
1337
1338         if (unlikely(flags & ~SPLICE_F_ALL))
1339                 return -EINVAL;
1340
1341         error = -EBADF;
1342         in = fdget(fd_in);
1343         if (in.file) {
1344                 out = fdget(fd_out);
1345                 if (out.file) {
1346                         error = __do_splice(in.file, off_in, out.file, off_out,
1347                                                 len, flags);
1348                         fdput(out);
1349                 }
1350                 fdput(in);
1351         }
1352         return error;
1353 }
1354
1355 /*
1356  * Make sure there's data to read. Wait for input if we can, otherwise
1357  * return an appropriate error.
1358  */
1359 static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1360 {
1361         int ret;
1362
1363         /*
1364          * Check the pipe occupancy without the inode lock first. This function
1365          * is speculative anyways, so missing one is ok.
1366          */
1367         if (!pipe_empty(pipe->head, pipe->tail))
1368                 return 0;
1369
1370         ret = 0;
1371         pipe_lock(pipe);
1372
1373         while (pipe_empty(pipe->head, pipe->tail)) {
1374                 if (signal_pending(current)) {
1375                         ret = -ERESTARTSYS;
1376                         break;
1377                 }
1378                 if (!pipe->writers)
1379                         break;
1380                 if (flags & SPLICE_F_NONBLOCK) {
1381                         ret = -EAGAIN;
1382                         break;
1383                 }
1384                 pipe_wait_readable(pipe);
1385         }
1386
1387         pipe_unlock(pipe);
1388         return ret;
1389 }
1390
1391 /*
1392  * Make sure there's writeable room. Wait for room if we can, otherwise
1393  * return an appropriate error.
1394  */
1395 static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1396 {
1397         int ret;
1398
1399         /*
1400          * Check pipe occupancy without the inode lock first. This function
1401          * is speculative anyways, so missing one is ok.
1402          */
1403         if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
1404                 return 0;
1405
1406         ret = 0;
1407         pipe_lock(pipe);
1408
1409         while (pipe_full(pipe->head, pipe->tail, pipe->max_usage)) {
1410                 if (!pipe->readers) {
1411                         send_sig(SIGPIPE, current, 0);
1412                         ret = -EPIPE;
1413                         break;
1414                 }
1415                 if (flags & SPLICE_F_NONBLOCK) {
1416                         ret = -EAGAIN;
1417                         break;
1418                 }
1419                 if (signal_pending(current)) {
1420                         ret = -ERESTARTSYS;
1421                         break;
1422                 }
1423                 pipe_wait_writable(pipe);
1424         }
1425
1426         pipe_unlock(pipe);
1427         return ret;
1428 }
1429
1430 /*
1431  * Splice contents of ipipe to opipe.
1432  */
1433 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1434                                struct pipe_inode_info *opipe,
1435                                size_t len, unsigned int flags)
1436 {
1437         struct pipe_buffer *ibuf, *obuf;
1438         unsigned int i_head, o_head;
1439         unsigned int i_tail, o_tail;
1440         unsigned int i_mask, o_mask;
1441         int ret = 0;
1442         bool input_wakeup = false;
1443
1444
1445 retry:
1446         ret = ipipe_prep(ipipe, flags);
1447         if (ret)
1448                 return ret;
1449
1450         ret = opipe_prep(opipe, flags);
1451         if (ret)
1452                 return ret;
1453
1454         /*
1455          * Potential ABBA deadlock, work around it by ordering lock
1456          * grabbing by pipe info address. Otherwise two different processes
1457          * could deadlock (one doing tee from A -> B, the other from B -> A).
1458          */
1459         pipe_double_lock(ipipe, opipe);
1460
1461         i_tail = ipipe->tail;
1462         i_mask = ipipe->ring_size - 1;
1463         o_head = opipe->head;
1464         o_mask = opipe->ring_size - 1;
1465
1466         do {
1467                 size_t o_len;
1468
1469                 if (!opipe->readers) {
1470                         send_sig(SIGPIPE, current, 0);
1471                         if (!ret)
1472                                 ret = -EPIPE;
1473                         break;
1474                 }
1475
1476                 i_head = ipipe->head;
1477                 o_tail = opipe->tail;
1478
1479                 if (pipe_empty(i_head, i_tail) && !ipipe->writers)
1480                         break;
1481
1482                 /*
1483                  * Cannot make any progress, because either the input
1484                  * pipe is empty or the output pipe is full.
1485                  */
1486                 if (pipe_empty(i_head, i_tail) ||
1487                     pipe_full(o_head, o_tail, opipe->max_usage)) {
1488                         /* Already processed some buffers, break */
1489                         if (ret)
1490                                 break;
1491
1492                         if (flags & SPLICE_F_NONBLOCK) {
1493                                 ret = -EAGAIN;
1494                                 break;
1495                         }
1496
1497                         /*
1498                          * We raced with another reader/writer and haven't
1499                          * managed to process any buffers.  A zero return
1500                          * value means EOF, so retry instead.
1501                          */
1502                         pipe_unlock(ipipe);
1503                         pipe_unlock(opipe);
1504                         goto retry;
1505                 }
1506
1507                 ibuf = &ipipe->bufs[i_tail & i_mask];
1508                 obuf = &opipe->bufs[o_head & o_mask];
1509
1510                 if (len >= ibuf->len) {
1511                         /*
1512                          * Simply move the whole buffer from ipipe to opipe
1513                          */
1514                         *obuf = *ibuf;
1515                         ibuf->ops = NULL;
1516                         i_tail++;
1517                         ipipe->tail = i_tail;
1518                         input_wakeup = true;
1519                         o_len = obuf->len;
1520                         o_head++;
1521                         opipe->head = o_head;
1522                 } else {
1523                         /*
1524                          * Get a reference to this pipe buffer,
1525                          * so we can copy the contents over.
1526                          */
1527                         if (!pipe_buf_get(ipipe, ibuf)) {
1528                                 if (ret == 0)
1529                                         ret = -EFAULT;
1530                                 break;
1531                         }
1532                         *obuf = *ibuf;
1533
1534                         /*
1535                          * Don't inherit the gift and merge flags, we need to
1536                          * prevent multiple steals of this page.
1537                          */
1538                         obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1539                         obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
1540
1541                         obuf->len = len;
1542                         ibuf->offset += len;
1543                         ibuf->len -= len;
1544                         o_len = len;
1545                         o_head++;
1546                         opipe->head = o_head;
1547                 }
1548                 ret += o_len;
1549                 len -= o_len;
1550         } while (len);
1551
1552         pipe_unlock(ipipe);
1553         pipe_unlock(opipe);
1554
1555         /*
1556          * If we put data in the output pipe, wakeup any potential readers.
1557          */
1558         if (ret > 0)
1559                 wakeup_pipe_readers(opipe);
1560
1561         if (input_wakeup)
1562                 wakeup_pipe_writers(ipipe);
1563
1564         return ret;
1565 }
1566
1567 /*
1568  * Link contents of ipipe to opipe.
1569  */
1570 static int link_pipe(struct pipe_inode_info *ipipe,
1571                      struct pipe_inode_info *opipe,
1572                      size_t len, unsigned int flags)
1573 {
1574         struct pipe_buffer *ibuf, *obuf;
1575         unsigned int i_head, o_head;
1576         unsigned int i_tail, o_tail;
1577         unsigned int i_mask, o_mask;
1578         int ret = 0;
1579
1580         /*
1581          * Potential ABBA deadlock, work around it by ordering lock
1582          * grabbing by pipe info address. Otherwise two different processes
1583          * could deadlock (one doing tee from A -> B, the other from B -> A).
1584          */
1585         pipe_double_lock(ipipe, opipe);
1586
1587         i_tail = ipipe->tail;
1588         i_mask = ipipe->ring_size - 1;
1589         o_head = opipe->head;
1590         o_mask = opipe->ring_size - 1;
1591
1592         do {
1593                 if (!opipe->readers) {
1594                         send_sig(SIGPIPE, current, 0);
1595                         if (!ret)
1596                                 ret = -EPIPE;
1597                         break;
1598                 }
1599
1600                 i_head = ipipe->head;
1601                 o_tail = opipe->tail;
1602
1603                 /*
1604                  * If we have iterated all input buffers or run out of
1605                  * output room, break.
1606                  */
1607                 if (pipe_empty(i_head, i_tail) ||
1608                     pipe_full(o_head, o_tail, opipe->max_usage))
1609                         break;
1610
1611                 ibuf = &ipipe->bufs[i_tail & i_mask];
1612                 obuf = &opipe->bufs[o_head & o_mask];
1613
1614                 /*
1615                  * Get a reference to this pipe buffer,
1616                  * so we can copy the contents over.
1617                  */
1618                 if (!pipe_buf_get(ipipe, ibuf)) {
1619                         if (ret == 0)
1620                                 ret = -EFAULT;
1621                         break;
1622                 }
1623
1624                 *obuf = *ibuf;
1625
1626                 /*
1627                  * Don't inherit the gift and merge flag, we need to prevent
1628                  * multiple steals of this page.
1629                  */
1630                 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1631                 obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
1632
1633                 if (obuf->len > len)
1634                         obuf->len = len;
1635                 ret += obuf->len;
1636                 len -= obuf->len;
1637
1638                 o_head++;
1639                 opipe->head = o_head;
1640                 i_tail++;
1641         } while (len);
1642
1643         pipe_unlock(ipipe);
1644         pipe_unlock(opipe);
1645
1646         /*
1647          * If we put data in the output pipe, wakeup any potential readers.
1648          */
1649         if (ret > 0)
1650                 wakeup_pipe_readers(opipe);
1651
1652         return ret;
1653 }
1654
1655 /*
1656  * This is a tee(1) implementation that works on pipes. It doesn't copy
1657  * any data, it simply references the 'in' pages on the 'out' pipe.
1658  * The 'flags' used are the SPLICE_F_* variants, currently the only
1659  * applicable one is SPLICE_F_NONBLOCK.
1660  */
1661 long do_tee(struct file *in, struct file *out, size_t len, unsigned int flags)
1662 {
1663         struct pipe_inode_info *ipipe = get_pipe_info(in, true);
1664         struct pipe_inode_info *opipe = get_pipe_info(out, true);
1665         int ret = -EINVAL;
1666
1667         if (unlikely(!(in->f_mode & FMODE_READ) ||
1668                      !(out->f_mode & FMODE_WRITE)))
1669                 return -EBADF;
1670
1671         /*
1672          * Duplicate the contents of ipipe to opipe without actually
1673          * copying the data.
1674          */
1675         if (ipipe && opipe && ipipe != opipe) {
1676                 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1677                         flags |= SPLICE_F_NONBLOCK;
1678
1679                 /*
1680                  * Keep going, unless we encounter an error. The ipipe/opipe
1681                  * ordering doesn't really matter.
1682                  */
1683                 ret = ipipe_prep(ipipe, flags);
1684                 if (!ret) {
1685                         ret = opipe_prep(opipe, flags);
1686                         if (!ret)
1687                                 ret = link_pipe(ipipe, opipe, len, flags);
1688                 }
1689         }
1690
1691         return ret;
1692 }
1693
1694 SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1695 {
1696         struct fd in, out;
1697         int error;
1698
1699         if (unlikely(flags & ~SPLICE_F_ALL))
1700                 return -EINVAL;
1701
1702         if (unlikely(!len))
1703                 return 0;
1704
1705         error = -EBADF;
1706         in = fdget(fdin);
1707         if (in.file) {
1708                 out = fdget(fdout);
1709                 if (out.file) {
1710                         error = do_tee(in.file, out.file, len, flags);
1711                         fdput(out);
1712                 }
1713                 fdput(in);
1714         }
1715
1716         return error;
1717 }