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