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