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