git.oblomov.eu Git - linux-2.6/blob - fs/splice.c

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