sys/kern/kern_sendfile.c

   1 /*-
   2  * Copyright (c) 2013-2015 Gleb Smirnoff <glebius@FreeBSD.org>
   3  * Copyright (c) 1998, David Greenman. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/capsicum.h>
  36 #include <sys/kernel.h>
  37 #include <sys/lock.h>
  38 #include <sys/mutex.h>
  39 #include <sys/sysproto.h>
  40 #include <sys/malloc.h>
  41 #include <sys/proc.h>
  42 #include <sys/mman.h>
  43 #include <sys/mount.h>
  44 #include <sys/mbuf.h>
  45 #include <sys/protosw.h>
  46 #include <sys/rwlock.h>
  47 #include <sys/sdt.h>
  48 #include <sys/sf_buf.h>
  49 #include <sys/socket.h>
  50 #include <sys/socketvar.h>
  51 #include <sys/syscallsubr.h>
  52 #include <sys/sysctl.h>
  53 #include <sys/vnode.h>
  54
  55 #include <net/vnet.h>
  56
  57 #include <security/audit/audit.h>
  58 #include <security/mac/mac_framework.h>
  59
  60 #include <vm/vm.h>
  61 #include <vm/vm_object.h>
  62 #include <vm/vm_pager.h>
  63
  64 #define EXT_FLAG_SYNC           EXT_FLAG_VENDOR1
  65 #define EXT_FLAG_NOCACHE        EXT_FLAG_VENDOR2
  66
  67 SDT_PROVIDER_DECLARE(vfs);
  68
  69 /*
  70  * Structure describing a single sendfile(2) I/O, which may consist of
  71  * several underlying pager I/Os.
  72  *
  73  * The syscall context allocates the structure and initializes 'nios'
  74  * to 1.  As sendfile_swapin() runs through pages and starts asynchronous
  75  * paging operations, it increments 'nios'.
  76  *
  77  * Every I/O completion calls sendfile_iodone(), which decrements the 'nios',
  78  * and the syscall also calls sendfile_iodone() after allocating all mbufs,
  79  * linking them and sending to socket.  Whoever reaches zero 'nios' is
  80  * responsible to * call pru_ready on the socket, to notify it of readyness
  81  * of the data.
  82  */
  83 struct sf_io {
  84         volatile u_int  nios;
  85         u_int           error;
  86         int             npages;
  87         struct socket   *so;
  88         struct mbuf     *m;
  89         vm_page_t       pa[];
  90 };
  91
  92 /*
  93  * Structure used to track requests with SF_SYNC flag.
  94  */
  95 struct sendfile_sync {
  96         struct mtx      mtx;
  97         struct cv       cv;
  98         unsigned        count;
  99 };
 100
 101 counter_u64_t sfstat[sizeof(struct sfstat) / sizeof(uint64_t)];
 102
 103 static void
 104 sfstat_init(const void *unused)
 105 {
 106
 107         COUNTER_ARRAY_ALLOC(sfstat, sizeof(struct sfstat) / sizeof(uint64_t),
 108             M_WAITOK);
 109 }
 110 SYSINIT(sfstat, SI_SUB_MBUF, SI_ORDER_FIRST, sfstat_init, NULL);
 111
 112 static int
 113 sfstat_sysctl(SYSCTL_HANDLER_ARGS)
 114 {
 115         struct sfstat s;
 116
 117         COUNTER_ARRAY_COPY(sfstat, &s, sizeof(s) / sizeof(uint64_t));
 118         if (req->newptr)
 119                 COUNTER_ARRAY_ZERO(sfstat, sizeof(s) / sizeof(uint64_t));
 120         return (SYSCTL_OUT(req, &s, sizeof(s)));
 121 }
 122 SYSCTL_PROC(_kern_ipc, OID_AUTO, sfstat, CTLTYPE_OPAQUE | CTLFLAG_RW,
 123     NULL, 0, sfstat_sysctl, "I", "sendfile statistics");
 124
 125 /*
 126  * Detach mapped page and release resources back to the system.  Called
 127  * by mbuf(9) code when last reference to a page is freed.
 128  */
 129 static void
 130 sendfile_free_page(vm_page_t pg, bool nocache)
 131 {
 132         bool freed;
 133
 134         vm_page_lock(pg);
 135         /*
 136          * In either case check for the object going away on us.  This can
 137          * happen since we don't hold a reference to it.  If so, we're
 138          * responsible for freeing the page.  In 'noncache' case try to free
 139          * the page, but only if it is cheap to.
 140          */
 141         if (vm_page_unwire_noq(pg)) {
 142                 vm_object_t obj;
 143
 144                 if ((obj = pg->object) == NULL)
 145                         vm_page_free(pg);
 146                 else {
 147                         freed = false;
 148                         if (nocache && !vm_page_xbusied(pg) &&
 149                             VM_OBJECT_TRYWLOCK(obj)) {
 150                                 /* Only free unmapped pages. */
 151                                 if (obj->ref_count == 0 ||
 152                                     !pmap_page_is_mapped(pg))
 153                                         /*
 154                                          * The busy test before the object is
 155                                          * locked cannot be relied upon.
 156                                          */
 157                                         freed = vm_page_try_to_free(pg);
 158                                 VM_OBJECT_WUNLOCK(obj);
 159                         }
 160                         if (!freed) {
 161                                 /*
 162                                  * If we were asked to not cache the page, place
 163                                  * it near the head of the inactive queue so
 164                                  * that it is reclaimed sooner.  Otherwise,
 165                                  * maintain LRU.
 166                                  */
 167                                 if (nocache)
 168                                         vm_page_deactivate_noreuse(pg);
 169                                 else if (vm_page_active(pg))
 170                                         vm_page_reference(pg);
 171                                 else
 172                                         vm_page_deactivate(pg);
 173                         }
 174                 }
 175         }
 176         vm_page_unlock(pg);
 177 }
 178
 179 static void
 180 sendfile_free_mext(struct mbuf *m)
 181 {
 182         struct sf_buf *sf;
 183         vm_page_t pg;
 184         bool nocache;
 185
 186         KASSERT(m->m_flags & M_EXT && m->m_ext.ext_type == EXT_SFBUF,
 187             ("%s: m %p !M_EXT or !EXT_SFBUF", __func__, m));
 188
 189         sf = m->m_ext.ext_arg1;
 190         pg = sf_buf_page(sf);
 191         nocache = m->m_ext.ext_flags & EXT_FLAG_NOCACHE;
 192
 193         sf_buf_free(sf);
 194         sendfile_free_page(pg, nocache);
 195
 196         if (m->m_ext.ext_flags & EXT_FLAG_SYNC) {
 197                 struct sendfile_sync *sfs = m->m_ext.ext_arg2;
 198
 199                 mtx_lock(&sfs->mtx);
 200                 KASSERT(sfs->count > 0, ("Sendfile sync botchup count == 0"));
 201                 if (--sfs->count == 0)
 202                         cv_signal(&sfs->cv);
 203                 mtx_unlock(&sfs->mtx);
 204         }
 205 }
 206
 207 /*
 208  * Helper function to calculate how much data to put into page i of n.
 209  * Only first and last pages are special.
 210  */
 211 static inline off_t
 212 xfsize(int i, int n, off_t off, off_t len)
 213 {
 214
 215         if (i == 0)
 216                 return (omin(PAGE_SIZE - (off & PAGE_MASK), len));
 217
 218         if (i == n - 1 && ((off + len) & PAGE_MASK) > 0)
 219                 return ((off + len) & PAGE_MASK);
 220
 221         return (PAGE_SIZE);
 222 }
 223
 224 /*
 225  * Helper function to get offset within object for i page.
 226  */
 227 static inline vm_ooffset_t
 228 vmoff(int i, off_t off)
 229 {
 230
 231         if (i == 0)
 232                 return ((vm_ooffset_t)off);
 233
 234         return (trunc_page(off + i * PAGE_SIZE));
 235 }
 236
 237 /*
 238  * Helper function used when allocation of a page or sf_buf failed.
 239  * Pretend as if we don't have enough space, subtract xfsize() of
 240  * all pages that failed.
 241  */
 242 static inline void
 243 fixspace(int old, int new, off_t off, int *space)
 244 {
 245
 246         KASSERT(old > new, ("%s: old %d new %d", __func__, old, new));
 247
 248         /* Subtract last one. */
 249         *space -= xfsize(old - 1, old, off, *space);
 250         old--;
 251
 252         if (new == old)
 253                 /* There was only one page. */
 254                 return;
 255
 256         /* Subtract first one. */
 257         if (new == 0) {
 258                 *space -= xfsize(0, old, off, *space);
 259                 new++;
 260         }
 261
 262         /* Rest of pages are full sized. */
 263         *space -= (old - new) * PAGE_SIZE;
 264
 265         KASSERT(*space >= 0, ("%s: space went backwards", __func__));
 266 }
 267
 268 /*
 269  * I/O completion callback.
 270  */
 271 static void
 272 sendfile_iodone(void *arg, vm_page_t *pg, int count, int error)
 273 {
 274         struct sf_io *sfio = arg;
 275         struct socket *so = sfio->so;
 276
 277         for (int i = 0; i < count; i++)
 278                 if (pg[i] != bogus_page)
 279                         vm_page_xunbusy(pg[i]);
 280
 281         if (error)
 282                 sfio->error = error;
 283
 284         if (!refcount_release(&sfio->nios))
 285                 return;
 286
 287         CURVNET_SET(so->so_vnet);
 288         if (sfio->error) {
 289                 struct mbuf *m;
 290
 291                 /*
 292                  * I/O operation failed.  The state of data in the socket
 293                  * is now inconsistent, and all what we can do is to tear
 294                  * it down. Protocol abort method would tear down protocol
 295                  * state, free all ready mbufs and detach not ready ones.
 296                  * We will free the mbufs corresponding to this I/O manually.
 297                  *
 298                  * The socket would be marked with EIO and made available
 299                  * for read, so that application receives EIO on next
 300                  * syscall and eventually closes the socket.
 301                  */
 302                 so->so_proto->pr_usrreqs->pru_abort(so);
 303                 so->so_error = EIO;
 304
 305                 m = sfio->m;
 306                 for (int i = 0; i < sfio->npages; i++)
 307                         m = m_free(m);
 308         } else
 309                 (void)(so->so_proto->pr_usrreqs->pru_ready)(so, sfio->m,
 310                     sfio->npages);
 311
 312         SOCK_LOCK(so);
 313         sorele(so);
 314         CURVNET_RESTORE();
 315         free(sfio, M_TEMP);
 316 }
 317
 318 SDT_PROBE_DEFINE1(vfs, sendfile, swapin, pager_error, "int");
 319 /*
 320  * Iterate through pages vector and request paging for non-valid pages.
 321  */
 322 static int
 323 sendfile_swapin(vm_object_t obj, struct sf_io *sfio, int *nios, off_t off,
 324     off_t len, int npages, int rhpages, int flags)
 325 {
 326         vm_page_t *pa = sfio->pa;
 327         int grabbed;
 328
 329         *nios = 0;
 330         flags = (flags & SF_NODISKIO) ? VM_ALLOC_NOWAIT : 0;
 331
 332         /*
 333          * First grab all the pages and wire them.  Note that we grab
 334          * only required pages.  Readahead pages are dealt with later.
 335          */
 336         VM_OBJECT_WLOCK(obj);
 337
 338         grabbed = vm_page_grab_pages(obj, OFF_TO_IDX(off),
 339             VM_ALLOC_NORMAL | VM_ALLOC_WIRED | flags, pa, npages);
 340         if (grabbed < npages) {
 341                 for (int i = grabbed; i < npages; i++)
 342                         pa[i] = NULL;
 343                 npages = grabbed;
 344                 rhpages = 0;
 345         }
 346
 347         for (int i = 0; i < npages;) {
 348                 int j, a, count, rv;
 349
 350                 /* Skip valid pages. */
 351                 if (vm_page_is_valid(pa[i], vmoff(i, off) & PAGE_MASK,
 352                     xfsize(i, npages, off, len))) {
 353                         vm_page_xunbusy(pa[i]);
 354                         SFSTAT_INC(sf_pages_valid);
 355                         i++;
 356                         continue;
 357                 }
 358
 359                 /*
 360                  * Next page is invalid.  Check if it belongs to pager.  It
 361                  * may not be there, which is a regular situation for shmem
 362                  * pager.  For vnode pager this happens only in case of
 363                  * a sparse file.
 364                  *
 365                  * Important feature of vm_pager_has_page() is the hint
 366                  * stored in 'a', about how many pages we can pagein after
 367                  * this page in a single I/O.
 368                  */
 369                 if (!vm_pager_has_page(obj, OFF_TO_IDX(vmoff(i, off)), NULL,
 370                     &a)) {
 371                         pmap_zero_page(pa[i]);
 372                         pa[i]->valid = VM_PAGE_BITS_ALL;
 373                         MPASS(pa[i]->dirty == 0);
 374                         vm_page_xunbusy(pa[i]);
 375                         i++;
 376                         continue;
 377                 }
 378
 379                 /*
 380                  * We want to pagein as many pages as possible, limited only
 381                  * by the 'a' hint and actual request.
 382                  */
 383                 count = min(a + 1, npages - i);
 384
 385                 /*
 386                  * We should not pagein into a valid page, thus we first trim
 387                  * any valid pages off the end of request, and substitute
 388                  * to bogus_page those, that are in the middle.
 389                  */
 390                 for (j = i + count - 1; j > i; j--) {
 391                         if (vm_page_is_valid(pa[j], vmoff(j, off) & PAGE_MASK,
 392                             xfsize(j, npages, off, len))) {
 393                                 count--;
 394                                 rhpages = 0;
 395                         } else
 396                                 break;
 397                 }
 398                 for (j = i + 1; j < i + count - 1; j++)
 399                         if (vm_page_is_valid(pa[j], vmoff(j, off) & PAGE_MASK,
 400                             xfsize(j, npages, off, len))) {
 401                                 vm_page_xunbusy(pa[j]);
 402                                 SFSTAT_INC(sf_pages_valid);
 403                                 SFSTAT_INC(sf_pages_bogus);
 404                                 pa[j] = bogus_page;
 405                         }
 406
 407                 refcount_acquire(&sfio->nios);
 408                 rv = vm_pager_get_pages_async(obj, pa + i, count, NULL,
 409                     i + count == npages ? &rhpages : NULL,
 410                     &sendfile_iodone, sfio);
 411                 if (rv != VM_PAGER_OK) {
 412                         SDT_PROBE1(vfs, sendfile, swapin, pager_error, rv);
 413                         for (j = 0; j < count; j++) {
 414                                 vm_page_lock(*(pa + i + j));
 415                                 vm_page_unwire(*(pa + i + j), PQ_INACTIVE);
 416                                 vm_page_unlock(*(pa + i + j));
 417                         }
 418                         VM_OBJECT_WUNLOCK(obj);
 419                         return EIO;
 420                 }
 421                 KASSERT(rv == VM_PAGER_OK, ("%s: pager fail obj %p page %p",
 422                     __func__, obj, pa[i]));
 423
 424                 SFSTAT_INC(sf_iocnt);
 425                 SFSTAT_ADD(sf_pages_read, count);
 426                 if (i + count == npages)
 427                         SFSTAT_ADD(sf_rhpages_read, rhpages);
 428
 429                 /*
 430                  * Restore the valid page pointers.  They are already
 431                  * unbusied, but still wired.
 432                  */
 433                 for (j = i; j < i + count; j++)
 434                         if (pa[j] == bogus_page) {
 435                                 pa[j] = vm_page_lookup(obj,
 436                                     OFF_TO_IDX(vmoff(j, off)));
 437                                 KASSERT(pa[j], ("%s: page %p[%d] disappeared",
 438                                     __func__, pa, j));
 439
 440                         }
 441                 i += count;
 442                 (*nios)++;
 443         }
 444
 445         VM_OBJECT_WUNLOCK(obj);
 446
 447         if (*nios == 0 && npages != 0)
 448                 SFSTAT_INC(sf_noiocnt);
 449
 450         return (0);
 451 }
 452
 453 static int
 454 sendfile_getobj(struct thread *td, struct file *fp, vm_object_t *obj_res,
 455     struct vnode **vp_res, struct shmfd **shmfd_res, off_t *obj_size,
 456     int *bsize)
 457 {
 458         struct vattr va;
 459         vm_object_t obj;
 460         struct vnode *vp;
 461         struct shmfd *shmfd;
 462         int error;
 463
 464         vp = *vp_res = NULL;
 465         obj = NULL;
 466         shmfd = *shmfd_res = NULL;
 467         *bsize = 0;
 468
 469         /*
 470          * The file descriptor must be a regular file and have a
 471          * backing VM object.
 472          */
 473         if (fp->f_type == DTYPE_VNODE) {
 474                 vp = fp->f_vnode;
 475                 vn_lock(vp, LK_SHARED | LK_RETRY);
 476                 if (vp->v_type != VREG) {
 477                         error = EINVAL;
 478                         goto out;
 479                 }
 480                 *bsize = vp->v_mount->mnt_stat.f_iosize;
 481                 error = VOP_GETATTR(vp, &va, td->td_ucred);
 482                 if (error != 0)
 483                         goto out;
 484                 *obj_size = va.va_size;
 485                 obj = vp->v_object;
 486                 if (obj == NULL) {
 487                         error = EINVAL;
 488                         goto out;
 489                 }
 490         } else if (fp->f_type == DTYPE_SHM) {
 491                 error = 0;
 492                 shmfd = fp->f_data;
 493                 obj = shmfd->shm_object;
 494                 *obj_size = shmfd->shm_size;
 495         } else {
 496                 error = EINVAL;
 497                 goto out;
 498         }
 499
 500         VM_OBJECT_WLOCK(obj);
 501         if ((obj->flags & OBJ_DEAD) != 0) {
 502                 VM_OBJECT_WUNLOCK(obj);
 503                 error = EBADF;
 504                 goto out;
 505         }
 506
 507         /*
 508          * Temporarily increase the backing VM object's reference
 509          * count so that a forced reclamation of its vnode does not
 510          * immediately destroy it.
 511          */
 512         vm_object_reference_locked(obj);
 513         VM_OBJECT_WUNLOCK(obj);
 514         *obj_res = obj;
 515         *vp_res = vp;
 516         *shmfd_res = shmfd;
 517
 518 out:
 519         if (vp != NULL)
 520                 VOP_UNLOCK(vp, 0);
 521         return (error);
 522 }
 523
 524 static int
 525 sendfile_getsock(struct thread *td, int s, struct file **sock_fp,
 526     struct socket **so)
 527 {
 528         int error;
 529
 530         *sock_fp = NULL;
 531         *so = NULL;
 532
 533         /*
 534          * The socket must be a stream socket and connected.
 535          */
 536         error = getsock_cap(td, s, &cap_send_rights,
 537             sock_fp, NULL, NULL);
 538         if (error != 0)
 539                 return (error);
 540         *so = (*sock_fp)->f_data;
 541         if ((*so)->so_type != SOCK_STREAM)
 542                 return (EINVAL);
 543         if (SOLISTENING(*so))
 544                 return (ENOTCONN);
 545         return (0);
 546 }
 547
 548 int
 549 vn_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
 550     struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
 551     struct thread *td)
 552 {
 553         struct file *sock_fp;
 554         struct vnode *vp;
 555         struct vm_object *obj;
 556         struct socket *so;
 557         struct mbuf *m, *mh, *mhtail;
 558         struct sf_buf *sf;
 559         struct shmfd *shmfd;
 560         struct sendfile_sync *sfs;
 561         struct vattr va;
 562         off_t off, sbytes, rem, obj_size;
 563         int error, softerr, bsize, hdrlen;
 564
 565         obj = NULL;
 566         so = NULL;
 567         m = mh = NULL;
 568         sfs = NULL;
 569         hdrlen = sbytes = 0;
 570         softerr = 0;
 571
 572         error = sendfile_getobj(td, fp, &obj, &vp, &shmfd, &obj_size, &bsize);
 573         if (error != 0)
 574                 return (error);
 575
 576         error = sendfile_getsock(td, sockfd, &sock_fp, &so);
 577         if (error != 0)
 578                 goto out;
 579
 580 #ifdef MAC
 581         error = mac_socket_check_send(td->td_ucred, so);
 582         if (error != 0)
 583                 goto out;
 584 #endif
 585
 586         SFSTAT_INC(sf_syscalls);
 587         SFSTAT_ADD(sf_rhpages_requested, SF_READAHEAD(flags));
 588
 589         if (flags & SF_SYNC) {
 590                 sfs = malloc(sizeof *sfs, M_TEMP, M_WAITOK | M_ZERO);
 591                 mtx_init(&sfs->mtx, "sendfile", NULL, MTX_DEF);
 592                 cv_init(&sfs->cv, "sendfile");
 593         }
 594
 595         rem = nbytes ? omin(nbytes, obj_size - offset) : obj_size - offset;
 596
 597         /*
 598          * Protect against multiple writers to the socket.
 599          *
 600          * XXXRW: Historically this has assumed non-interruptibility, so now
 601          * we implement that, but possibly shouldn't.
 602          */
 603         (void)sblock(&so->so_snd, SBL_WAIT | SBL_NOINTR);
 604
 605         /*
 606          * Loop through the pages of the file, starting with the requested
 607          * offset. Get a file page (do I/O if necessary), map the file page
 608          * into an sf_buf, attach an mbuf header to the sf_buf, and queue
 609          * it on the socket.
 610          * This is done in two loops.  The inner loop turns as many pages
 611          * as it can, up to available socket buffer space, without blocking
 612          * into mbufs to have it bulk delivered into the socket send buffer.
 613          * The outer loop checks the state and available space of the socket
 614          * and takes care of the overall progress.
 615          */
 616         for (off = offset; rem > 0; ) {
 617                 struct sf_io *sfio;
 618                 vm_page_t *pa;
 619                 struct mbuf *mtail;
 620                 int nios, space, npages, rhpages;
 621
 622                 mtail = NULL;
 623                 /*
 624                  * Check the socket state for ongoing connection,
 625                  * no errors and space in socket buffer.
 626                  * If space is low allow for the remainder of the
 627                  * file to be processed if it fits the socket buffer.
 628                  * Otherwise block in waiting for sufficient space
 629                  * to proceed, or if the socket is nonblocking, return
 630                  * to userland with EAGAIN while reporting how far
 631                  * we've come.
 632                  * We wait until the socket buffer has significant free
 633                  * space to do bulk sends.  This makes good use of file
 634                  * system read ahead and allows packet segmentation
 635                  * offloading hardware to take over lots of work.  If
 636                  * we were not careful here we would send off only one
 637                  * sfbuf at a time.
 638                  */
 639                 SOCKBUF_LOCK(&so->so_snd);
 640                 if (so->so_snd.sb_lowat < so->so_snd.sb_hiwat / 2)
 641                         so->so_snd.sb_lowat = so->so_snd.sb_hiwat / 2;
 642 retry_space:
 643                 if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
 644                         error = EPIPE;
 645                         SOCKBUF_UNLOCK(&so->so_snd);
 646                         goto done;
 647                 } else if (so->so_error) {
 648                         error = so->so_error;
 649                         so->so_error = 0;
 650                         SOCKBUF_UNLOCK(&so->so_snd);
 651                         goto done;
 652                 }
 653                 if ((so->so_state & SS_ISCONNECTED) == 0) {
 654                         SOCKBUF_UNLOCK(&so->so_snd);
 655                         error = ENOTCONN;
 656                         goto done;
 657                 }
 658
 659                 space = sbspace(&so->so_snd);
 660                 if (space < rem &&
 661                     (space <= 0 ||
 662                      space < so->so_snd.sb_lowat)) {
 663                         if (so->so_state & SS_NBIO) {
 664                                 SOCKBUF_UNLOCK(&so->so_snd);
 665                                 error = EAGAIN;
 666                                 goto done;
 667                         }
 668                         /*
 669                          * sbwait drops the lock while sleeping.
 670                          * When we loop back to retry_space the
 671                          * state may have changed and we retest
 672                          * for it.
 673                          */
 674                         error = sbwait(&so->so_snd);
 675                         /*
 676                          * An error from sbwait usually indicates that we've
 677                          * been interrupted by a signal. If we've sent anything
 678                          * then return bytes sent, otherwise return the error.
 679                          */
 680                         if (error != 0) {
 681                                 SOCKBUF_UNLOCK(&so->so_snd);
 682                                 goto done;
 683                         }
 684                         goto retry_space;
 685                 }
 686                 SOCKBUF_UNLOCK(&so->so_snd);
 687
 688                 /*
 689                  * At the beginning of the first loop check if any headers
 690                  * are specified and copy them into mbufs.  Reduce space in
 691                  * the socket buffer by the size of the header mbuf chain.
 692                  * Clear hdr_uio here and hdrlen at the end of the first loop.
 693                  */
 694                 if (hdr_uio != NULL && hdr_uio->uio_resid > 0) {
 695                         hdr_uio->uio_td = td;
 696                         hdr_uio->uio_rw = UIO_WRITE;
 697                         mh = m_uiotombuf(hdr_uio, M_WAITOK, space, 0, 0);
 698                         hdrlen = m_length(mh, &mhtail);
 699                         space -= hdrlen;
 700                         /*
 701                          * If header consumed all the socket buffer space,
 702                          * don't waste CPU cycles and jump to the end.
 703                          */
 704                         if (space == 0) {
 705                                 sfio = NULL;
 706                                 nios = 0;
 707                                 goto prepend_header;
 708                         }
 709                         hdr_uio = NULL;
 710                 }
 711
 712                 if (vp != NULL) {
 713                         error = vn_lock(vp, LK_SHARED);
 714                         if (error != 0)
 715                                 goto done;
 716                         error = VOP_GETATTR(vp, &va, td->td_ucred);
 717                         if (error != 0 || off >= va.va_size) {
 718                                 VOP_UNLOCK(vp, 0);
 719                                 goto done;
 720                         }
 721                         if (va.va_size != obj_size) {
 722                                 obj_size = va.va_size;
 723                                 rem = nbytes ?
 724                                     omin(nbytes + offset, obj_size) : obj_size;
 725                                 rem -= off;
 726                         }
 727                 }
 728
 729                 if (space > rem)
 730                         space = rem;
 731
 732                 npages = howmany(space + (off & PAGE_MASK), PAGE_SIZE);
 733
 734                 /*
 735                  * Calculate maximum allowed number of pages for readahead
 736                  * at this iteration.  If SF_USER_READAHEAD was set, we don't
 737                  * do any heuristics and use exactly the value supplied by
 738                  * application.  Otherwise, we allow readahead up to "rem".
 739                  * If application wants more, let it be, but there is no
 740                  * reason to go above MAXPHYS.  Also check against "obj_size",
 741                  * since vm_pager_has_page() can hint beyond EOF.
 742                  */
 743                 if (flags & SF_USER_READAHEAD) {
 744                         rhpages = SF_READAHEAD(flags);
 745                 } else {
 746                         rhpages = howmany(rem + (off & PAGE_MASK), PAGE_SIZE) -
 747                             npages;
 748                         rhpages += SF_READAHEAD(flags);
 749                 }
 750                 rhpages = min(howmany(MAXPHYS, PAGE_SIZE), rhpages);
 751                 rhpages = min(howmany(obj_size - trunc_page(off), PAGE_SIZE) -
 752                     npages, rhpages);
 753
 754                 sfio = malloc(sizeof(struct sf_io) +
 755                     npages * sizeof(vm_page_t), M_TEMP, M_WAITOK);
 756                 refcount_init(&sfio->nios, 1);
 757                 sfio->so = so;
 758                 sfio->error = 0;
 759
 760                 error = sendfile_swapin(obj, sfio, &nios, off, space, npages,
 761                     rhpages, flags);
 762                 if (error) {
 763                         free(sfio, M_TEMP);
 764                         if (vp != NULL)
 765                                 VOP_UNLOCK(vp, 0);
 766                         goto done;
 767                 }
 768
 769                 /*
 770                  * Loop and construct maximum sized mbuf chain to be bulk
 771                  * dumped into socket buffer.
 772                  */
 773                 pa = sfio->pa;
 774                 for (int i = 0; i < npages; i++) {
 775                         struct mbuf *m0;
 776
 777                         /*
 778                          * If a page wasn't grabbed successfully, then
 779                          * trim the array. Can happen only with SF_NODISKIO.
 780                          */
 781                         if (pa[i] == NULL) {
 782                                 SFSTAT_INC(sf_busy);
 783                                 fixspace(npages, i, off, &space);
 784                                 npages = i;
 785                                 softerr = EBUSY;
 786                                 break;
 787                         }
 788
 789                         /*
 790                          * Get a sendfile buf.  When allocating the
 791                          * first buffer for mbuf chain, we usually
 792                          * wait as long as necessary, but this wait
 793                          * can be interrupted.  For consequent
 794                          * buffers, do not sleep, since several
 795                          * threads might exhaust the buffers and then
 796                          * deadlock.
 797                          */
 798                         sf = sf_buf_alloc(pa[i],
 799                             m != NULL ? SFB_NOWAIT : SFB_CATCH);
 800                         if (sf == NULL) {
 801                                 SFSTAT_INC(sf_allocfail);
 802                                 for (int j = i; j < npages; j++) {
 803                                         vm_page_lock(pa[j]);
 804                                         vm_page_unwire(pa[j], PQ_INACTIVE);
 805                                         vm_page_unlock(pa[j]);
 806                                 }
 807                                 if (m == NULL)
 808                                         softerr = ENOBUFS;
 809                                 fixspace(npages, i, off, &space);
 810                                 npages = i;
 811                                 break;
 812                         }
 813
 814                         m0 = m_get(M_WAITOK, MT_DATA);
 815                         m0->m_ext.ext_buf = (char *)sf_buf_kva(sf);
 816                         m0->m_ext.ext_size = PAGE_SIZE;
 817                         m0->m_ext.ext_arg1 = sf;
 818                         m0->m_ext.ext_type = EXT_SFBUF;
 819                         m0->m_ext.ext_flags = EXT_FLAG_EMBREF;
 820                         m0->m_ext.ext_free = sendfile_free_mext;
 821                         /*
 822                          * SF_NOCACHE sets the page as being freed upon send.
 823                          * However, we ignore it for the last page in 'space',
 824                          * if the page is truncated, and we got more data to
 825                          * send (rem > space), or if we have readahead
 826                          * configured (rhpages > 0).
 827                          */
 828                         if ((flags & SF_NOCACHE) &&
 829                             (i != npages - 1 ||
 830                             !((off + space) & PAGE_MASK) ||
 831                             !(rem > space || rhpages > 0)))
 832                                 m0->m_ext.ext_flags |= EXT_FLAG_NOCACHE;
 833                         if (sfs != NULL) {
 834                                 m0->m_ext.ext_flags |= EXT_FLAG_SYNC;
 835                                 m0->m_ext.ext_arg2 = sfs;
 836                                 mtx_lock(&sfs->mtx);
 837                                 sfs->count++;
 838                                 mtx_unlock(&sfs->mtx);
 839                         }
 840                         m0->m_ext.ext_count = 1;
 841                         m0->m_flags |= (M_EXT | M_RDONLY);
 842                         if (nios)
 843                                 m0->m_flags |= M_NOTREADY;
 844                         m0->m_data = (char *)sf_buf_kva(sf) +
 845                             (vmoff(i, off) & PAGE_MASK);
 846                         m0->m_len = xfsize(i, npages, off, space);
 847
 848                         if (i == 0)
 849                                 sfio->m = m0;
 850
 851                         /* Append to mbuf chain. */
 852                         if (mtail != NULL)
 853                                 mtail->m_next = m0;
 854                         else
 855                                 m = m0;
 856                         mtail = m0;
 857                 }
 858
 859                 if (vp != NULL)
 860                         VOP_UNLOCK(vp, 0);
 861
 862                 /* Keep track of bytes processed. */
 863                 off += space;
 864                 rem -= space;
 865
 866                 /* Prepend header, if any. */
 867                 if (hdrlen) {
 868 prepend_header:
 869                         mhtail->m_next = m;
 870                         m = mh;
 871                         mh = NULL;
 872                 }
 873
 874                 if (m == NULL) {
 875                         KASSERT(softerr, ("%s: m NULL, no error", __func__));
 876                         error = softerr;
 877                         free(sfio, M_TEMP);
 878                         goto done;
 879                 }
 880
 881                 /* Add the buffer chain to the socket buffer. */
 882                 KASSERT(m_length(m, NULL) == space + hdrlen,
 883                     ("%s: mlen %u space %d hdrlen %d",
 884                     __func__, m_length(m, NULL), space, hdrlen));
 885
 886                 CURVNET_SET(so->so_vnet);
 887                 if (nios == 0) {
 888                         /*
 889                          * If sendfile_swapin() didn't initiate any I/Os,
 890                          * which happens if all data is cached in VM, then
 891                          * we can send data right now without the
 892                          * PRUS_NOTREADY flag.
 893                          */
 894                         free(sfio, M_TEMP);
 895                         error = (*so->so_proto->pr_usrreqs->pru_send)
 896                             (so, 0, m, NULL, NULL, td);
 897                 } else {
 898                         sfio->npages = npages;
 899                         soref(so);
 900                         error = (*so->so_proto->pr_usrreqs->pru_send)
 901                             (so, PRUS_NOTREADY, m, NULL, NULL, td);
 902                         sendfile_iodone(sfio, NULL, 0, 0);
 903                 }
 904                 CURVNET_RESTORE();
 905
 906                 m = NULL;       /* pru_send always consumes */
 907                 if (error)
 908                         goto done;
 909                 sbytes += space + hdrlen;
 910                 if (hdrlen)
 911                         hdrlen = 0;
 912                 if (softerr) {
 913                         error = softerr;
 914                         goto done;
 915                 }
 916         }
 917
 918         /*
 919          * Send trailers. Wimp out and use writev(2).
 920          */
 921         if (trl_uio != NULL) {
 922                 sbunlock(&so->so_snd);
 923                 error = kern_writev(td, sockfd, trl_uio);
 924                 if (error == 0)
 925                         sbytes += td->td_retval[0];
 926                 goto out;
 927         }
 928
 929 done:
 930         sbunlock(&so->so_snd);
 931 out:
 932         /*
 933          * If there was no error we have to clear td->td_retval[0]
 934          * because it may have been set by writev.
 935          */
 936         if (error == 0) {
 937                 td->td_retval[0] = 0;
 938         }
 939         if (sent != NULL) {
 940                 (*sent) = sbytes;
 941         }
 942         if (obj != NULL)
 943                 vm_object_deallocate(obj);
 944         if (so)
 945                 fdrop(sock_fp, td);
 946         if (m)
 947                 m_freem(m);
 948         if (mh)
 949                 m_freem(mh);
 950
 951         if (sfs != NULL) {
 952                 mtx_lock(&sfs->mtx);
 953                 if (sfs->count != 0)
 954                         cv_wait(&sfs->cv, &sfs->mtx);
 955                 KASSERT(sfs->count == 0, ("sendfile sync still busy"));
 956                 cv_destroy(&sfs->cv);
 957                 mtx_destroy(&sfs->mtx);
 958                 free(sfs, M_TEMP);
 959         }
 960
 961         if (error == ERESTART)
 962                 error = EINTR;
 963
 964         return (error);
 965 }
 966
 967 static int
 968 sendfile(struct thread *td, struct sendfile_args *uap, int compat)
 969 {
 970         struct sf_hdtr hdtr;
 971         struct uio *hdr_uio, *trl_uio;
 972         struct file *fp;
 973         off_t sbytes;
 974         int error;
 975
 976         /*
 977          * File offset must be positive.  If it goes beyond EOF
 978          * we send only the header/trailer and no payload data.
 979          */
 980         if (uap->offset < 0)
 981                 return (EINVAL);
 982
 983         sbytes = 0;
 984         hdr_uio = trl_uio = NULL;
 985
 986         if (uap->hdtr != NULL) {
 987                 error = copyin(uap->hdtr, &hdtr, sizeof(hdtr));
 988                 if (error != 0)
 989                         goto out;
 990                 if (hdtr.headers != NULL) {
 991                         error = copyinuio(hdtr.headers, hdtr.hdr_cnt,
 992                             &hdr_uio);
 993                         if (error != 0)
 994                                 goto out;
 995 #ifdef COMPAT_FREEBSD4
 996                         /*
 997                          * In FreeBSD < 5.0 the nbytes to send also included
 998                          * the header.  If compat is specified subtract the
 999                          * header size from nbytes.
1000                          */
1001                         if (compat) {
1002                                 if (uap->nbytes > hdr_uio->uio_resid)
1003                                         uap->nbytes -= hdr_uio->uio_resid;
1004                                 else
1005                                         uap->nbytes = 0;
1006                         }
1007 #endif
1008                 }
1009                 if (hdtr.trailers != NULL) {
1010                         error = copyinuio(hdtr.trailers, hdtr.trl_cnt,
1011                             &trl_uio);
1012                         if (error != 0)
1013                                 goto out;
1014                 }
1015         }
1016
1017         AUDIT_ARG_FD(uap->fd);
1018
1019         /*
1020          * sendfile(2) can start at any offset within a file so we require
1021          * CAP_READ+CAP_SEEK = CAP_PREAD.
1022          */
1023         if ((error = fget_read(td, uap->fd, &cap_pread_rights, &fp)) != 0)
1024                 goto out;
1025
1026         error = fo_sendfile(fp, uap->s, hdr_uio, trl_uio, uap->offset,
1027             uap->nbytes, &sbytes, uap->flags, td);
1028         fdrop(fp, td);
1029
1030         if (uap->sbytes != NULL)
1031                 copyout(&sbytes, uap->sbytes, sizeof(off_t));
1032
1033 out:
1034         free(hdr_uio, M_IOV);
1035         free(trl_uio, M_IOV);
1036         return (error);
1037 }
1038
1039 /*
1040  * sendfile(2)
1041  *
1042  * int sendfile(int fd, int s, off_t offset, size_t nbytes,
1043  *       struct sf_hdtr *hdtr, off_t *sbytes, int flags)
1044  *
1045  * Send a file specified by 'fd' and starting at 'offset' to a socket
1046  * specified by 's'. Send only 'nbytes' of the file or until EOF if nbytes ==
1047  * 0.  Optionally add a header and/or trailer to the socket output.  If
1048  * specified, write the total number of bytes sent into *sbytes.
1049  */
1050 int
1051 sys_sendfile(struct thread *td, struct sendfile_args *uap)
1052 {
1053
1054         return (sendfile(td, uap, 0));
1055 }
1056
1057 #ifdef COMPAT_FREEBSD4
1058 int
1059 freebsd4_sendfile(struct thread *td, struct freebsd4_sendfile_args *uap)
1060 {
1061         struct sendfile_args args;
1062
1063         args.fd = uap->fd;
1064         args.s = uap->s;
1065         args.offset = uap->offset;
1066         args.nbytes = uap->nbytes;
1067         args.hdtr = uap->hdtr;
1068         args.sbytes = uap->sbytes;
1069         args.flags = uap->flags;
1070
1071         return (sendfile(td, &args, 1));
1072 }
1073 #endif /* COMPAT_FREEBSD4 */