xref: /freebsd-14-stable/sys/kern/vfs_vnops.c (revision c1aa97cf79a6fd40eb89bcbd4faebdc5656a6279)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  * (c) UNIX System Laboratories, Inc.
7  * All or some portions of this file are derived from material licensed
8  * to the University of California by American Telephone and Telegraph
9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10  * the permission of UNIX System Laboratories, Inc.
11  *
12  * Copyright (c) 2012 Konstantin Belousov <kib@FreeBSD.org>
13  * Copyright (c) 2013, 2014 The FreeBSD Foundation
14  *
15  * Portions of this software were developed by Konstantin Belousov
16  * under sponsorship from the FreeBSD Foundation.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the above copyright
22  *    notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  *    notice, this list of conditions and the following disclaimer in the
25  *    documentation and/or other materials provided with the distribution.
26  * 3. Neither the name of the University nor the names of its contributors
27  *    may be used to endorse or promote products derived from this software
28  *    without specific prior written permission.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
31  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
34  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40  * SUCH DAMAGE.
41  *
42  *	@(#)vfs_vnops.c	8.2 (Berkeley) 1/21/94
43  */
44 
45 #include <sys/cdefs.h>
46 #include "opt_hwpmc_hooks.h"
47 
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/disk.h>
51 #include <sys/fail.h>
52 #include <sys/fcntl.h>
53 #include <sys/file.h>
54 #include <sys/kdb.h>
55 #include <sys/ktr.h>
56 #include <sys/stat.h>
57 #include <sys/priv.h>
58 #include <sys/proc.h>
59 #include <sys/limits.h>
60 #include <sys/lock.h>
61 #include <sys/mman.h>
62 #include <sys/mount.h>
63 #include <sys/mutex.h>
64 #include <sys/namei.h>
65 #include <sys/vnode.h>
66 #include <sys/dirent.h>
67 #include <sys/bio.h>
68 #include <sys/buf.h>
69 #include <sys/filio.h>
70 #include <sys/resourcevar.h>
71 #include <sys/rwlock.h>
72 #include <sys/prng.h>
73 #include <sys/sx.h>
74 #include <sys/sleepqueue.h>
75 #include <sys/sysctl.h>
76 #include <sys/ttycom.h>
77 #include <sys/conf.h>
78 #include <sys/syslog.h>
79 #include <sys/unistd.h>
80 #include <sys/user.h>
81 #include <sys/ktrace.h>
82 
83 #include <security/audit/audit.h>
84 #include <security/mac/mac_framework.h>
85 
86 #include <vm/vm.h>
87 #include <vm/vm_extern.h>
88 #include <vm/pmap.h>
89 #include <vm/vm_map.h>
90 #include <vm/vm_object.h>
91 #include <vm/vm_page.h>
92 #include <vm/vm_pager.h>
93 #include <vm/vnode_pager.h>
94 
95 #ifdef HWPMC_HOOKS
96 #include <sys/pmckern.h>
97 #endif
98 
99 static fo_rdwr_t	vn_read;
100 static fo_rdwr_t	vn_write;
101 static fo_rdwr_t	vn_io_fault;
102 static fo_truncate_t	vn_truncate;
103 static fo_ioctl_t	vn_ioctl;
104 static fo_poll_t	vn_poll;
105 static fo_kqfilter_t	vn_kqfilter;
106 static fo_close_t	vn_closefile;
107 static fo_mmap_t	vn_mmap;
108 static fo_fallocate_t	vn_fallocate;
109 static fo_fspacectl_t	vn_fspacectl;
110 
111 const struct fileops vnops = {
112 	.fo_read = vn_io_fault,
113 	.fo_write = vn_io_fault,
114 	.fo_truncate = vn_truncate,
115 	.fo_ioctl = vn_ioctl,
116 	.fo_poll = vn_poll,
117 	.fo_kqfilter = vn_kqfilter,
118 	.fo_stat = vn_statfile,
119 	.fo_close = vn_closefile,
120 	.fo_chmod = vn_chmod,
121 	.fo_chown = vn_chown,
122 	.fo_sendfile = vn_sendfile,
123 	.fo_seek = vn_seek,
124 	.fo_fill_kinfo = vn_fill_kinfo,
125 	.fo_mmap = vn_mmap,
126 	.fo_fallocate = vn_fallocate,
127 	.fo_fspacectl = vn_fspacectl,
128 	.fo_cmp = vn_cmp,
129 	.fo_flags = DFLAG_PASSABLE | DFLAG_SEEKABLE
130 };
131 
132 const u_int io_hold_cnt = 16;
133 static int vn_io_fault_enable = 1;
134 SYSCTL_INT(_debug, OID_AUTO, vn_io_fault_enable, CTLFLAG_RWTUN,
135     &vn_io_fault_enable, 0, "Enable vn_io_fault lock avoidance");
136 static int vn_io_fault_prefault = 0;
137 SYSCTL_INT(_debug, OID_AUTO, vn_io_fault_prefault, CTLFLAG_RWTUN,
138     &vn_io_fault_prefault, 0, "Enable vn_io_fault prefaulting");
139 static int vn_io_pgcache_read_enable = 1;
140 SYSCTL_INT(_debug, OID_AUTO, vn_io_pgcache_read_enable, CTLFLAG_RWTUN,
141     &vn_io_pgcache_read_enable, 0,
142     "Enable copying from page cache for reads, avoiding fs");
143 static u_long vn_io_faults_cnt;
144 SYSCTL_ULONG(_debug, OID_AUTO, vn_io_faults, CTLFLAG_RD,
145     &vn_io_faults_cnt, 0, "Count of vn_io_fault lock avoidance triggers");
146 
147 static int vfs_allow_read_dir = 0;
148 SYSCTL_INT(_security_bsd, OID_AUTO, allow_read_dir, CTLFLAG_RW,
149     &vfs_allow_read_dir, 0,
150     "Enable read(2) of directory by root for filesystems that support it");
151 
152 /*
153  * Returns true if vn_io_fault mode of handling the i/o request should
154  * be used.
155  */
156 static bool
do_vn_io_fault(struct vnode * vp,struct uio * uio)157 do_vn_io_fault(struct vnode *vp, struct uio *uio)
158 {
159 	struct mount *mp;
160 
161 	return (uio->uio_segflg == UIO_USERSPACE && vp->v_type == VREG &&
162 	    (mp = vp->v_mount) != NULL &&
163 	    (mp->mnt_kern_flag & MNTK_NO_IOPF) != 0 && vn_io_fault_enable);
164 }
165 
166 /*
167  * Structure used to pass arguments to vn_io_fault1(), to do either
168  * file- or vnode-based I/O calls.
169  */
170 struct vn_io_fault_args {
171 	enum {
172 		VN_IO_FAULT_FOP,
173 		VN_IO_FAULT_VOP
174 	} kind;
175 	struct ucred *cred;
176 	int flags;
177 	union {
178 		struct fop_args_tag {
179 			struct file *fp;
180 			fo_rdwr_t *doio;
181 		} fop_args;
182 		struct vop_args_tag {
183 			struct vnode *vp;
184 		} vop_args;
185 	} args;
186 };
187 
188 static int vn_io_fault1(struct vnode *vp, struct uio *uio,
189     struct vn_io_fault_args *args, struct thread *td);
190 
191 int
vn_open(struct nameidata * ndp,int * flagp,int cmode,struct file * fp)192 vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp)
193 {
194 	struct thread *td = curthread;
195 
196 	return (vn_open_cred(ndp, flagp, cmode, 0, td->td_ucred, fp));
197 }
198 
199 static uint64_t
open2nameif(int fmode,u_int vn_open_flags)200 open2nameif(int fmode, u_int vn_open_flags)
201 {
202 	uint64_t res;
203 
204 	res = ISOPEN | LOCKLEAF;
205 	if ((fmode & O_RESOLVE_BENEATH) != 0)
206 		res |= RBENEATH;
207 	if ((fmode & O_EMPTY_PATH) != 0)
208 		res |= EMPTYPATH;
209 	if ((fmode & FREAD) != 0)
210 		res |= OPENREAD;
211 	if ((fmode & FWRITE) != 0)
212 		res |= OPENWRITE;
213 	if ((vn_open_flags & VN_OPEN_NOAUDIT) == 0)
214 		res |= AUDITVNODE1;
215 	if ((vn_open_flags & VN_OPEN_NOCAPCHECK) != 0)
216 		res |= NOCAPCHECK;
217 	if ((vn_open_flags & VN_OPEN_WANTIOCTLCAPS) != 0)
218 		res |= WANTIOCTLCAPS;
219 	return (res);
220 }
221 
222 /*
223  * Common code for vnode open operations via a name lookup.
224  * Lookup the vnode and invoke VOP_CREATE if needed.
225  * Check permissions, and call the VOP_OPEN or VOP_CREATE routine.
226  *
227  * Note that this does NOT free nameidata for the successful case,
228  * due to the NDINIT being done elsewhere.
229  */
230 int
vn_open_cred(struct nameidata * ndp,int * flagp,int cmode,u_int vn_open_flags,struct ucred * cred,struct file * fp)231 vn_open_cred(struct nameidata *ndp, int *flagp, int cmode, u_int vn_open_flags,
232     struct ucred *cred, struct file *fp)
233 {
234 	struct vnode *vp;
235 	struct mount *mp;
236 	struct vattr vat;
237 	struct vattr *vap = &vat;
238 	int fmode, error;
239 	bool first_open;
240 
241 restart:
242 	first_open = false;
243 	fmode = *flagp;
244 	if ((fmode & (O_CREAT | O_EXCL | O_DIRECTORY)) == (O_CREAT |
245 	    O_EXCL | O_DIRECTORY) ||
246 	    (fmode & (O_CREAT | O_EMPTY_PATH)) == (O_CREAT | O_EMPTY_PATH))
247 		return (EINVAL);
248 	else if ((fmode & (O_CREAT | O_DIRECTORY)) == O_CREAT) {
249 		ndp->ni_cnd.cn_nameiop = CREATE;
250 		ndp->ni_cnd.cn_flags = open2nameif(fmode, vn_open_flags);
251 		/*
252 		 * Set NOCACHE to avoid flushing the cache when
253 		 * rolling in many files at once.
254 		 *
255 		 * Set NC_KEEPPOSENTRY to keep positive entries if they already
256 		 * exist despite NOCACHE.
257 		 */
258 		ndp->ni_cnd.cn_flags |= LOCKPARENT | NOCACHE | NC_KEEPPOSENTRY;
259 		if ((fmode & O_EXCL) == 0 && (fmode & O_NOFOLLOW) == 0)
260 			ndp->ni_cnd.cn_flags |= FOLLOW;
261 		if ((vn_open_flags & VN_OPEN_INVFS) == 0)
262 			bwillwrite();
263 		if ((error = namei(ndp)) != 0)
264 			return (error);
265 		if (ndp->ni_vp == NULL) {
266 			VATTR_NULL(vap);
267 			vap->va_type = VREG;
268 			vap->va_mode = cmode;
269 			if (fmode & O_EXCL)
270 				vap->va_vaflags |= VA_EXCLUSIVE;
271 			if (vn_start_write(ndp->ni_dvp, &mp, V_NOWAIT) != 0) {
272 				NDFREE_PNBUF(ndp);
273 				vput(ndp->ni_dvp);
274 				if ((error = vn_start_write(NULL, &mp,
275 				    V_XSLEEP | V_PCATCH)) != 0)
276 					return (error);
277 				NDREINIT(ndp);
278 				goto restart;
279 			}
280 			if ((vn_open_flags & VN_OPEN_NAMECACHE) != 0)
281 				ndp->ni_cnd.cn_flags |= MAKEENTRY;
282 #ifdef MAC
283 			error = mac_vnode_check_create(cred, ndp->ni_dvp,
284 			    &ndp->ni_cnd, vap);
285 			if (error == 0)
286 #endif
287 				error = VOP_CREATE(ndp->ni_dvp, &ndp->ni_vp,
288 				    &ndp->ni_cnd, vap);
289 			vp = ndp->ni_vp;
290 			if (error == 0 && (fmode & O_EXCL) != 0 &&
291 			    (fmode & (O_EXLOCK | O_SHLOCK)) != 0) {
292 				VI_LOCK(vp);
293 				vp->v_iflag |= VI_FOPENING;
294 				VI_UNLOCK(vp);
295 				first_open = true;
296 			}
297 			VOP_VPUT_PAIR(ndp->ni_dvp, error == 0 ? &vp : NULL,
298 			    false);
299 			vn_finished_write(mp);
300 			if (error) {
301 				NDFREE_PNBUF(ndp);
302 				if (error == ERELOOKUP) {
303 					NDREINIT(ndp);
304 					goto restart;
305 				}
306 				return (error);
307 			}
308 			fmode &= ~O_TRUNC;
309 		} else {
310 			if (ndp->ni_dvp == ndp->ni_vp)
311 				vrele(ndp->ni_dvp);
312 			else
313 				vput(ndp->ni_dvp);
314 			ndp->ni_dvp = NULL;
315 			vp = ndp->ni_vp;
316 			if (fmode & O_EXCL) {
317 				error = EEXIST;
318 				goto bad;
319 			}
320 			if (vp->v_type == VDIR) {
321 				error = EISDIR;
322 				goto bad;
323 			}
324 			fmode &= ~O_CREAT;
325 		}
326 	} else {
327 		ndp->ni_cnd.cn_nameiop = LOOKUP;
328 		ndp->ni_cnd.cn_flags = open2nameif(fmode, vn_open_flags);
329 		ndp->ni_cnd.cn_flags |= (fmode & O_NOFOLLOW) != 0 ? NOFOLLOW :
330 		    FOLLOW;
331 		if ((fmode & FWRITE) == 0)
332 			ndp->ni_cnd.cn_flags |= LOCKSHARED;
333 		if ((error = namei(ndp)) != 0)
334 			return (error);
335 		vp = ndp->ni_vp;
336 	}
337 	error = vn_open_vnode(vp, fmode, cred, curthread, fp);
338 	if (first_open) {
339 		VI_LOCK(vp);
340 		vp->v_iflag &= ~VI_FOPENING;
341 		wakeup(vp);
342 		VI_UNLOCK(vp);
343 	}
344 	if (error)
345 		goto bad;
346 	*flagp = fmode;
347 	return (0);
348 bad:
349 	NDFREE_PNBUF(ndp);
350 	vput(vp);
351 	*flagp = fmode;
352 	ndp->ni_vp = NULL;
353 	return (error);
354 }
355 
356 static int
vn_open_vnode_advlock(struct vnode * vp,int fmode,struct file * fp)357 vn_open_vnode_advlock(struct vnode *vp, int fmode, struct file *fp)
358 {
359 	struct flock lf;
360 	int error, lock_flags, type;
361 
362 	ASSERT_VOP_LOCKED(vp, "vn_open_vnode_advlock");
363 	if ((fmode & (O_EXLOCK | O_SHLOCK)) == 0)
364 		return (0);
365 	KASSERT(fp != NULL, ("open with flock requires fp"));
366 	if (fp->f_type != DTYPE_NONE && fp->f_type != DTYPE_VNODE)
367 		return (EOPNOTSUPP);
368 
369 	lock_flags = VOP_ISLOCKED(vp);
370 	VOP_UNLOCK(vp);
371 
372 	lf.l_whence = SEEK_SET;
373 	lf.l_start = 0;
374 	lf.l_len = 0;
375 	lf.l_type = (fmode & O_EXLOCK) != 0 ? F_WRLCK : F_RDLCK;
376 	type = F_FLOCK;
377 	if ((fmode & FNONBLOCK) == 0)
378 		type |= F_WAIT;
379 	if ((fmode & (O_CREAT | O_EXCL)) == (O_CREAT | O_EXCL))
380 		type |= F_FIRSTOPEN;
381 	error = VOP_ADVLOCK(vp, (caddr_t)fp, F_SETLK, &lf, type);
382 	if (error == 0)
383 		fp->f_flag |= FHASLOCK;
384 
385 	vn_lock(vp, lock_flags | LK_RETRY);
386 	return (error);
387 }
388 
389 /*
390  * Common code for vnode open operations once a vnode is located.
391  * Check permissions, and call the VOP_OPEN routine.
392  */
393 int
vn_open_vnode(struct vnode * vp,int fmode,struct ucred * cred,struct thread * td,struct file * fp)394 vn_open_vnode(struct vnode *vp, int fmode, struct ucred *cred,
395     struct thread *td, struct file *fp)
396 {
397 	accmode_t accmode;
398 	int error;
399 
400 	if (vp->v_type == VLNK) {
401 		if ((fmode & O_PATH) == 0 || (fmode & FEXEC) != 0)
402 			return (EMLINK);
403 	}
404 	if (vp->v_type != VDIR && fmode & O_DIRECTORY)
405 		return (ENOTDIR);
406 
407 	accmode = 0;
408 	if ((fmode & O_PATH) == 0) {
409 		if (vp->v_type == VSOCK)
410 			return (EOPNOTSUPP);
411 		if ((fmode & (FWRITE | O_TRUNC)) != 0) {
412 			if (vp->v_type == VDIR)
413 				return (EISDIR);
414 			accmode |= VWRITE;
415 		}
416 		if ((fmode & FREAD) != 0)
417 			accmode |= VREAD;
418 		if ((fmode & O_APPEND) && (fmode & FWRITE))
419 			accmode |= VAPPEND;
420 #ifdef MAC
421 		if ((fmode & O_CREAT) != 0)
422 			accmode |= VCREAT;
423 #endif
424 	}
425 	if ((fmode & FEXEC) != 0)
426 		accmode |= VEXEC;
427 #ifdef MAC
428 	if ((fmode & O_VERIFY) != 0)
429 		accmode |= VVERIFY;
430 	error = mac_vnode_check_open(cred, vp, accmode);
431 	if (error != 0)
432 		return (error);
433 
434 	accmode &= ~(VCREAT | VVERIFY);
435 #endif
436 	if ((fmode & O_CREAT) == 0 && accmode != 0) {
437 		error = VOP_ACCESS(vp, accmode, cred, td);
438 		if (error != 0)
439 			return (error);
440 	}
441 	if ((fmode & O_PATH) != 0) {
442 		if (vp->v_type != VFIFO && vp->v_type != VSOCK &&
443 		    VOP_ACCESS(vp, VREAD, cred, td) == 0)
444 			fp->f_flag |= FKQALLOWED;
445 		return (0);
446 	}
447 
448 	if (vp->v_type == VFIFO && VOP_ISLOCKED(vp) != LK_EXCLUSIVE)
449 		vn_lock(vp, LK_UPGRADE | LK_RETRY);
450 	error = VOP_OPEN(vp, fmode, cred, td, fp);
451 	if (error != 0)
452 		return (error);
453 
454 	error = vn_open_vnode_advlock(vp, fmode, fp);
455 	if (error == 0 && (fmode & FWRITE) != 0) {
456 		error = VOP_ADD_WRITECOUNT(vp, 1);
457 		if (error == 0) {
458 			CTR3(KTR_VFS, "%s: vp %p v_writecount increased to %d",
459 			     __func__, vp, vp->v_writecount);
460 		}
461 	}
462 
463 	/*
464 	 * Error from advlock or VOP_ADD_WRITECOUNT() still requires
465 	 * calling VOP_CLOSE() to pair with earlier VOP_OPEN().
466 	 */
467 	if (error != 0) {
468 		if (fp != NULL) {
469 			/*
470 			 * Arrange the call by having fdrop() to use
471 			 * vn_closefile().  This is to satisfy
472 			 * filesystems like devfs or tmpfs, which
473 			 * override fo_close().
474 			 */
475 			fp->f_flag |= FOPENFAILED;
476 			fp->f_vnode = vp;
477 			if (fp->f_ops == &badfileops) {
478 				fp->f_type = DTYPE_VNODE;
479 				fp->f_ops = &vnops;
480 			}
481 			vref(vp);
482 		} else {
483 			/*
484 			 * If there is no fp, due to kernel-mode open,
485 			 * we can call VOP_CLOSE() now.
486 			 */
487 			if ((vp->v_type == VFIFO ||
488 			    !MNT_EXTENDED_SHARED(vp->v_mount)) &&
489 			    VOP_ISLOCKED(vp) != LK_EXCLUSIVE)
490 				vn_lock(vp, LK_UPGRADE | LK_RETRY);
491 			(void)VOP_CLOSE(vp, fmode & (FREAD | FWRITE | FEXEC),
492 			    cred, td);
493 		}
494 	}
495 
496 	ASSERT_VOP_LOCKED(vp, "vn_open_vnode");
497 	return (error);
498 
499 }
500 
501 /*
502  * Check for write permissions on the specified vnode.
503  * Prototype text segments cannot be written.
504  * It is racy.
505  */
506 int
vn_writechk(struct vnode * vp)507 vn_writechk(struct vnode *vp)
508 {
509 
510 	ASSERT_VOP_LOCKED(vp, "vn_writechk");
511 	/*
512 	 * If there's shared text associated with
513 	 * the vnode, try to free it up once.  If
514 	 * we fail, we can't allow writing.
515 	 */
516 	if (VOP_IS_TEXT(vp))
517 		return (ETXTBSY);
518 
519 	return (0);
520 }
521 
522 /*
523  * Vnode close call
524  */
525 static int
vn_close1(struct vnode * vp,int flags,struct ucred * file_cred,struct thread * td,bool keep_ref)526 vn_close1(struct vnode *vp, int flags, struct ucred *file_cred,
527     struct thread *td, bool keep_ref)
528 {
529 	struct mount *mp;
530 	int error, lock_flags;
531 
532 	lock_flags = vp->v_type != VFIFO && MNT_EXTENDED_SHARED(vp->v_mount) ?
533 	    LK_SHARED : LK_EXCLUSIVE;
534 
535 	vn_start_write(vp, &mp, V_WAIT);
536 	vn_lock(vp, lock_flags | LK_RETRY);
537 	AUDIT_ARG_VNODE1(vp);
538 	if ((flags & (FWRITE | FOPENFAILED)) == FWRITE) {
539 		VOP_ADD_WRITECOUNT_CHECKED(vp, -1);
540 		CTR3(KTR_VFS, "%s: vp %p v_writecount decreased to %d",
541 		    __func__, vp, vp->v_writecount);
542 	}
543 	error = VOP_CLOSE(vp, flags, file_cred, td);
544 	if (keep_ref)
545 		VOP_UNLOCK(vp);
546 	else
547 		vput(vp);
548 	vn_finished_write(mp);
549 	return (error);
550 }
551 
552 int
vn_close(struct vnode * vp,int flags,struct ucred * file_cred,struct thread * td)553 vn_close(struct vnode *vp, int flags, struct ucred *file_cred,
554     struct thread *td)
555 {
556 
557 	return (vn_close1(vp, flags, file_cred, td, false));
558 }
559 
560 /*
561  * Heuristic to detect sequential operation.
562  */
563 static int
sequential_heuristic(struct uio * uio,struct file * fp)564 sequential_heuristic(struct uio *uio, struct file *fp)
565 {
566 	enum uio_rw rw;
567 
568 	ASSERT_VOP_LOCKED(fp->f_vnode, __func__);
569 
570 	rw = uio->uio_rw;
571 	if (fp->f_flag & FRDAHEAD)
572 		return (fp->f_seqcount[rw] << IO_SEQSHIFT);
573 
574 	/*
575 	 * Offset 0 is handled specially.  open() sets f_seqcount to 1 so
576 	 * that the first I/O is normally considered to be slightly
577 	 * sequential.  Seeking to offset 0 doesn't change sequentiality
578 	 * unless previous seeks have reduced f_seqcount to 0, in which
579 	 * case offset 0 is not special.
580 	 */
581 	if ((uio->uio_offset == 0 && fp->f_seqcount[rw] > 0) ||
582 	    uio->uio_offset == fp->f_nextoff[rw]) {
583 		/*
584 		 * f_seqcount is in units of fixed-size blocks so that it
585 		 * depends mainly on the amount of sequential I/O and not
586 		 * much on the number of sequential I/O's.  The fixed size
587 		 * of 16384 is hard-coded here since it is (not quite) just
588 		 * a magic size that works well here.  This size is more
589 		 * closely related to the best I/O size for real disks than
590 		 * to any block size used by software.
591 		 */
592 		if (uio->uio_resid >= IO_SEQMAX * 16384)
593 			fp->f_seqcount[rw] = IO_SEQMAX;
594 		else {
595 			fp->f_seqcount[rw] += howmany(uio->uio_resid, 16384);
596 			if (fp->f_seqcount[rw] > IO_SEQMAX)
597 				fp->f_seqcount[rw] = IO_SEQMAX;
598 		}
599 		return (fp->f_seqcount[rw] << IO_SEQSHIFT);
600 	}
601 
602 	/* Not sequential.  Quickly draw-down sequentiality. */
603 	if (fp->f_seqcount[rw] > 1)
604 		fp->f_seqcount[rw] = 1;
605 	else
606 		fp->f_seqcount[rw] = 0;
607 	return (0);
608 }
609 
610 /*
611  * Package up an I/O request on a vnode into a uio and do it.
612  */
613 int
vn_rdwr(enum uio_rw rw,struct vnode * vp,void * base,int len,off_t offset,enum uio_seg segflg,int ioflg,struct ucred * active_cred,struct ucred * file_cred,ssize_t * aresid,struct thread * td)614 vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base, int len, off_t offset,
615     enum uio_seg segflg, int ioflg, struct ucred *active_cred,
616     struct ucred *file_cred, ssize_t *aresid, struct thread *td)
617 {
618 	struct uio auio;
619 	struct iovec aiov;
620 	struct mount *mp;
621 	struct ucred *cred;
622 	void *rl_cookie;
623 	struct vn_io_fault_args args;
624 	int error, lock_flags;
625 
626 	if (offset < 0 && vp->v_type != VCHR)
627 		return (EINVAL);
628 	auio.uio_iov = &aiov;
629 	auio.uio_iovcnt = 1;
630 	aiov.iov_base = base;
631 	aiov.iov_len = len;
632 	auio.uio_resid = len;
633 	auio.uio_offset = offset;
634 	auio.uio_segflg = segflg;
635 	auio.uio_rw = rw;
636 	auio.uio_td = td;
637 	error = 0;
638 
639 	if ((ioflg & IO_NODELOCKED) == 0) {
640 		if ((ioflg & IO_RANGELOCKED) == 0) {
641 			if (rw == UIO_READ) {
642 				rl_cookie = vn_rangelock_rlock(vp, offset,
643 				    offset + len);
644 			} else if ((ioflg & IO_APPEND) != 0) {
645 				rl_cookie = vn_rangelock_wlock(vp, 0, OFF_MAX);
646 			} else {
647 				rl_cookie = vn_rangelock_wlock(vp, offset,
648 				    offset + len);
649 			}
650 		} else
651 			rl_cookie = NULL;
652 		mp = NULL;
653 		if (rw == UIO_WRITE) {
654 			if (vp->v_type != VCHR &&
655 			    (error = vn_start_write(vp, &mp, V_WAIT | V_PCATCH))
656 			    != 0)
657 				goto out;
658 			lock_flags = vn_lktype_write(mp, vp);
659 		} else
660 			lock_flags = LK_SHARED;
661 		vn_lock(vp, lock_flags | LK_RETRY);
662 	} else
663 		rl_cookie = NULL;
664 
665 	ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
666 #ifdef MAC
667 	if ((ioflg & IO_NOMACCHECK) == 0) {
668 		if (rw == UIO_READ)
669 			error = mac_vnode_check_read(active_cred, file_cred,
670 			    vp);
671 		else
672 			error = mac_vnode_check_write(active_cred, file_cred,
673 			    vp);
674 	}
675 #endif
676 	if (error == 0) {
677 		if (file_cred != NULL)
678 			cred = file_cred;
679 		else
680 			cred = active_cred;
681 		if (do_vn_io_fault(vp, &auio)) {
682 			args.kind = VN_IO_FAULT_VOP;
683 			args.cred = cred;
684 			args.flags = ioflg;
685 			args.args.vop_args.vp = vp;
686 			error = vn_io_fault1(vp, &auio, &args, td);
687 		} else if (rw == UIO_READ) {
688 			error = VOP_READ(vp, &auio, ioflg, cred);
689 		} else /* if (rw == UIO_WRITE) */ {
690 			error = VOP_WRITE(vp, &auio, ioflg, cred);
691 		}
692 	}
693 	if (aresid)
694 		*aresid = auio.uio_resid;
695 	else
696 		if (auio.uio_resid && error == 0)
697 			error = EIO;
698 	if ((ioflg & IO_NODELOCKED) == 0) {
699 		VOP_UNLOCK(vp);
700 		if (mp != NULL)
701 			vn_finished_write(mp);
702 	}
703  out:
704 	if (rl_cookie != NULL)
705 		vn_rangelock_unlock(vp, rl_cookie);
706 	return (error);
707 }
708 
709 /*
710  * Package up an I/O request on a vnode into a uio and do it.  The I/O
711  * request is split up into smaller chunks and we try to avoid saturating
712  * the buffer cache while potentially holding a vnode locked, so we
713  * check bwillwrite() before calling vn_rdwr().  We also call kern_yield()
714  * to give other processes a chance to lock the vnode (either other processes
715  * core'ing the same binary, or unrelated processes scanning the directory).
716  */
717 int
vn_rdwr_inchunks(enum uio_rw rw,struct vnode * vp,void * base,size_t len,off_t offset,enum uio_seg segflg,int ioflg,struct ucred * active_cred,struct ucred * file_cred,size_t * aresid,struct thread * td)718 vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base, size_t len,
719     off_t offset, enum uio_seg segflg, int ioflg, struct ucred *active_cred,
720     struct ucred *file_cred, size_t *aresid, struct thread *td)
721 {
722 	int error = 0;
723 	ssize_t iaresid;
724 
725 	do {
726 		int chunk;
727 
728 		/*
729 		 * Force `offset' to a multiple of MAXBSIZE except possibly
730 		 * for the first chunk, so that filesystems only need to
731 		 * write full blocks except possibly for the first and last
732 		 * chunks.
733 		 */
734 		chunk = MAXBSIZE - (uoff_t)offset % MAXBSIZE;
735 
736 		if (chunk > len)
737 			chunk = len;
738 		if (rw != UIO_READ && vp->v_type == VREG)
739 			bwillwrite();
740 		iaresid = 0;
741 		error = vn_rdwr(rw, vp, base, chunk, offset, segflg,
742 		    ioflg, active_cred, file_cred, &iaresid, td);
743 		len -= chunk;	/* aresid calc already includes length */
744 		if (error)
745 			break;
746 		offset += chunk;
747 		base = (char *)base + chunk;
748 		kern_yield(PRI_USER);
749 	} while (len);
750 	if (aresid)
751 		*aresid = len + iaresid;
752 	return (error);
753 }
754 
755 #if OFF_MAX <= LONG_MAX
756 off_t
foffset_lock(struct file * fp,int flags)757 foffset_lock(struct file *fp, int flags)
758 {
759 	volatile short *flagsp;
760 	off_t res;
761 	short state;
762 
763 	KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
764 
765 	if ((flags & FOF_NOLOCK) != 0)
766 		return (atomic_load_long(&fp->f_offset));
767 
768 	/*
769 	 * According to McKusick the vn lock was protecting f_offset here.
770 	 * It is now protected by the FOFFSET_LOCKED flag.
771 	 */
772 	flagsp = &fp->f_vnread_flags;
773 	if (atomic_cmpset_acq_16(flagsp, 0, FOFFSET_LOCKED))
774 		return (atomic_load_long(&fp->f_offset));
775 
776 	sleepq_lock(&fp->f_vnread_flags);
777 	state = atomic_load_16(flagsp);
778 	for (;;) {
779 		if ((state & FOFFSET_LOCKED) == 0) {
780 			if (!atomic_fcmpset_acq_16(flagsp, &state,
781 			    FOFFSET_LOCKED))
782 				continue;
783 			break;
784 		}
785 		if ((state & FOFFSET_LOCK_WAITING) == 0) {
786 			if (!atomic_fcmpset_acq_16(flagsp, &state,
787 			    state | FOFFSET_LOCK_WAITING))
788 				continue;
789 		}
790 		DROP_GIANT();
791 		sleepq_add(&fp->f_vnread_flags, NULL, "vofflock", 0, 0);
792 		sleepq_wait(&fp->f_vnread_flags, PUSER -1);
793 		PICKUP_GIANT();
794 		sleepq_lock(&fp->f_vnread_flags);
795 		state = atomic_load_16(flagsp);
796 	}
797 	res = atomic_load_long(&fp->f_offset);
798 	sleepq_release(&fp->f_vnread_flags);
799 	return (res);
800 }
801 
802 void
foffset_unlock(struct file * fp,off_t val,int flags)803 foffset_unlock(struct file *fp, off_t val, int flags)
804 {
805 	volatile short *flagsp;
806 	short state;
807 
808 	KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
809 
810 	if ((flags & FOF_NOUPDATE) == 0)
811 		atomic_store_long(&fp->f_offset, val);
812 	if ((flags & FOF_NEXTOFF_R) != 0)
813 		fp->f_nextoff[UIO_READ] = val;
814 	if ((flags & FOF_NEXTOFF_W) != 0)
815 		fp->f_nextoff[UIO_WRITE] = val;
816 
817 	if ((flags & FOF_NOLOCK) != 0)
818 		return;
819 
820 	flagsp = &fp->f_vnread_flags;
821 	state = atomic_load_16(flagsp);
822 	if ((state & FOFFSET_LOCK_WAITING) == 0 &&
823 	    atomic_cmpset_rel_16(flagsp, state, 0))
824 		return;
825 
826 	sleepq_lock(&fp->f_vnread_flags);
827 	MPASS((fp->f_vnread_flags & FOFFSET_LOCKED) != 0);
828 	MPASS((fp->f_vnread_flags & FOFFSET_LOCK_WAITING) != 0);
829 	fp->f_vnread_flags = 0;
830 	sleepq_broadcast(&fp->f_vnread_flags, SLEEPQ_SLEEP, 0, 0);
831 	sleepq_release(&fp->f_vnread_flags);
832 }
833 
834 static off_t
foffset_read(struct file * fp)835 foffset_read(struct file *fp)
836 {
837 
838 	return (atomic_load_long(&fp->f_offset));
839 }
840 #else
841 off_t
foffset_lock(struct file * fp,int flags)842 foffset_lock(struct file *fp, int flags)
843 {
844 	struct mtx *mtxp;
845 	off_t res;
846 
847 	KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
848 
849 	mtxp = mtx_pool_find(mtxpool_sleep, fp);
850 	mtx_lock(mtxp);
851 	if ((flags & FOF_NOLOCK) == 0) {
852 		while (fp->f_vnread_flags & FOFFSET_LOCKED) {
853 			fp->f_vnread_flags |= FOFFSET_LOCK_WAITING;
854 			msleep(&fp->f_vnread_flags, mtxp, PUSER -1,
855 			    "vofflock", 0);
856 		}
857 		fp->f_vnread_flags |= FOFFSET_LOCKED;
858 	}
859 	res = fp->f_offset;
860 	mtx_unlock(mtxp);
861 	return (res);
862 }
863 
864 void
foffset_unlock(struct file * fp,off_t val,int flags)865 foffset_unlock(struct file *fp, off_t val, int flags)
866 {
867 	struct mtx *mtxp;
868 
869 	KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
870 
871 	mtxp = mtx_pool_find(mtxpool_sleep, fp);
872 	mtx_lock(mtxp);
873 	if ((flags & FOF_NOUPDATE) == 0)
874 		fp->f_offset = val;
875 	if ((flags & FOF_NEXTOFF_R) != 0)
876 		fp->f_nextoff[UIO_READ] = val;
877 	if ((flags & FOF_NEXTOFF_W) != 0)
878 		fp->f_nextoff[UIO_WRITE] = val;
879 	if ((flags & FOF_NOLOCK) == 0) {
880 		KASSERT((fp->f_vnread_flags & FOFFSET_LOCKED) != 0,
881 		    ("Lost FOFFSET_LOCKED"));
882 		if (fp->f_vnread_flags & FOFFSET_LOCK_WAITING)
883 			wakeup(&fp->f_vnread_flags);
884 		fp->f_vnread_flags = 0;
885 	}
886 	mtx_unlock(mtxp);
887 }
888 
889 static off_t
foffset_read(struct file * fp)890 foffset_read(struct file *fp)
891 {
892 
893 	return (foffset_lock(fp, FOF_NOLOCK));
894 }
895 #endif
896 
897 void
foffset_lock_pair(struct file * fp1,off_t * off1p,struct file * fp2,off_t * off2p,int flags)898 foffset_lock_pair(struct file *fp1, off_t *off1p, struct file *fp2, off_t *off2p,
899     int flags)
900 {
901 	KASSERT(fp1 != fp2, ("foffset_lock_pair: fp1 == fp2"));
902 
903 	/* Lock in a consistent order to avoid deadlock. */
904 	if ((uintptr_t)fp1 > (uintptr_t)fp2) {
905 		struct file *tmpfp;
906 		off_t *tmpoffp;
907 
908 		tmpfp = fp1, fp1 = fp2, fp2 = tmpfp;
909 		tmpoffp = off1p, off1p = off2p, off2p = tmpoffp;
910 	}
911 	if (fp1 != NULL)
912 		*off1p = foffset_lock(fp1, flags);
913 	if (fp2 != NULL)
914 		*off2p = foffset_lock(fp2, flags);
915 }
916 
917 void
foffset_lock_uio(struct file * fp,struct uio * uio,int flags)918 foffset_lock_uio(struct file *fp, struct uio *uio, int flags)
919 {
920 
921 	if ((flags & FOF_OFFSET) == 0)
922 		uio->uio_offset = foffset_lock(fp, flags);
923 }
924 
925 void
foffset_unlock_uio(struct file * fp,struct uio * uio,int flags)926 foffset_unlock_uio(struct file *fp, struct uio *uio, int flags)
927 {
928 
929 	if ((flags & FOF_OFFSET) == 0)
930 		foffset_unlock(fp, uio->uio_offset, flags);
931 }
932 
933 static int
get_advice(struct file * fp,struct uio * uio)934 get_advice(struct file *fp, struct uio *uio)
935 {
936 	struct mtx *mtxp;
937 	int ret;
938 
939 	ret = POSIX_FADV_NORMAL;
940 	if (fp->f_advice == NULL || fp->f_vnode->v_type != VREG)
941 		return (ret);
942 
943 	mtxp = mtx_pool_find(mtxpool_sleep, fp);
944 	mtx_lock(mtxp);
945 	if (fp->f_advice != NULL &&
946 	    uio->uio_offset >= fp->f_advice->fa_start &&
947 	    uio->uio_offset + uio->uio_resid <= fp->f_advice->fa_end)
948 		ret = fp->f_advice->fa_advice;
949 	mtx_unlock(mtxp);
950 	return (ret);
951 }
952 
953 static int
get_write_ioflag(struct file * fp)954 get_write_ioflag(struct file *fp)
955 {
956 	int ioflag;
957 	struct mount *mp;
958 	struct vnode *vp;
959 
960 	ioflag = 0;
961 	vp = fp->f_vnode;
962 	mp = atomic_load_ptr(&vp->v_mount);
963 
964 	if ((fp->f_flag & O_DIRECT) != 0)
965 		ioflag |= IO_DIRECT;
966 
967 	if ((fp->f_flag & O_FSYNC) != 0 ||
968 	    (mp != NULL && (mp->mnt_flag & MNT_SYNCHRONOUS) != 0))
969 		ioflag |= IO_SYNC;
970 
971 	/*
972 	 * For O_DSYNC we set both IO_SYNC and IO_DATASYNC, so that VOP_WRITE()
973 	 * or VOP_DEALLOCATE() implementations that don't understand IO_DATASYNC
974 	 * fall back to full O_SYNC behavior.
975 	 */
976 	if ((fp->f_flag & O_DSYNC) != 0)
977 		ioflag |= IO_SYNC | IO_DATASYNC;
978 
979 	return (ioflag);
980 }
981 
982 int
vn_read_from_obj(struct vnode * vp,struct uio * uio)983 vn_read_from_obj(struct vnode *vp, struct uio *uio)
984 {
985 	vm_object_t obj;
986 	vm_page_t ma[io_hold_cnt + 2];
987 	off_t off, vsz;
988 	ssize_t resid;
989 	int error, i, j;
990 
991 	MPASS(uio->uio_resid <= ptoa(io_hold_cnt + 2));
992 	obj = atomic_load_ptr(&vp->v_object);
993 	if (obj == NULL)
994 		return (EJUSTRETURN);
995 
996 	/*
997 	 * Depends on type stability of vm_objects.
998 	 */
999 	vm_object_pip_add(obj, 1);
1000 	if ((obj->flags & OBJ_DEAD) != 0) {
1001 		/*
1002 		 * Note that object might be already reused from the
1003 		 * vnode, and the OBJ_DEAD flag cleared.  This is fine,
1004 		 * we recheck for DOOMED vnode state after all pages
1005 		 * are busied, and retract then.
1006 		 *
1007 		 * But we check for OBJ_DEAD to ensure that we do not
1008 		 * busy pages while vm_object_terminate_pages()
1009 		 * processes the queue.
1010 		 */
1011 		error = EJUSTRETURN;
1012 		goto out_pip;
1013 	}
1014 
1015 	resid = uio->uio_resid;
1016 	off = uio->uio_offset;
1017 	for (i = 0; resid > 0; i++) {
1018 		MPASS(i < io_hold_cnt + 2);
1019 		ma[i] = vm_page_grab_unlocked(obj, atop(off),
1020 		    VM_ALLOC_NOCREAT | VM_ALLOC_SBUSY | VM_ALLOC_IGN_SBUSY |
1021 		    VM_ALLOC_NOWAIT);
1022 		if (ma[i] == NULL)
1023 			break;
1024 
1025 		/*
1026 		 * Skip invalid pages.  Valid mask can be partial only
1027 		 * at EOF, and we clip later.
1028 		 */
1029 		if (vm_page_none_valid(ma[i])) {
1030 			vm_page_sunbusy(ma[i]);
1031 			break;
1032 		}
1033 
1034 		resid -= PAGE_SIZE;
1035 		off += PAGE_SIZE;
1036 	}
1037 	if (i == 0) {
1038 		error = EJUSTRETURN;
1039 		goto out_pip;
1040 	}
1041 
1042 	/*
1043 	 * Check VIRF_DOOMED after we busied our pages.  Since
1044 	 * vgonel() terminates the vnode' vm_object, it cannot
1045 	 * process past pages busied by us.
1046 	 */
1047 	if (VN_IS_DOOMED(vp)) {
1048 		error = EJUSTRETURN;
1049 		goto out;
1050 	}
1051 
1052 	resid = PAGE_SIZE - (uio->uio_offset & PAGE_MASK) + ptoa(i - 1);
1053 	if (resid > uio->uio_resid)
1054 		resid = uio->uio_resid;
1055 
1056 	/*
1057 	 * Unlocked read of vnp_size is safe because truncation cannot
1058 	 * pass busied page.  But we load vnp_size into a local
1059 	 * variable so that possible concurrent extension does not
1060 	 * break calculation.
1061 	 */
1062 #if defined(__powerpc__) && !defined(__powerpc64__)
1063 	vsz = obj->un_pager.vnp.vnp_size;
1064 #else
1065 	vsz = atomic_load_64(&obj->un_pager.vnp.vnp_size);
1066 #endif
1067 	if (uio->uio_offset >= vsz) {
1068 		error = EJUSTRETURN;
1069 		goto out;
1070 	}
1071 	if (uio->uio_offset + resid > vsz)
1072 		resid = vsz - uio->uio_offset;
1073 
1074 	error = vn_io_fault_pgmove(ma, uio->uio_offset & PAGE_MASK, resid, uio);
1075 
1076 out:
1077 	for (j = 0; j < i; j++) {
1078 		if (error == 0)
1079 			vm_page_reference(ma[j]);
1080 		vm_page_sunbusy(ma[j]);
1081 	}
1082 out_pip:
1083 	vm_object_pip_wakeup(obj);
1084 	if (error != 0)
1085 		return (error);
1086 	return (uio->uio_resid == 0 ? 0 : EJUSTRETURN);
1087 }
1088 
1089 /*
1090  * File table vnode read routine.
1091  */
1092 static int
vn_read(struct file * fp,struct uio * uio,struct ucred * active_cred,int flags,struct thread * td)1093 vn_read(struct file *fp, struct uio *uio, struct ucred *active_cred, int flags,
1094     struct thread *td)
1095 {
1096 	struct vnode *vp;
1097 	off_t orig_offset;
1098 	int error, ioflag;
1099 	int advice;
1100 
1101 	KASSERT(uio->uio_td == td, ("uio_td %p is not td %p",
1102 	    uio->uio_td, td));
1103 	KASSERT(flags & FOF_OFFSET, ("No FOF_OFFSET"));
1104 	vp = fp->f_vnode;
1105 	ioflag = 0;
1106 	if (fp->f_flag & FNONBLOCK)
1107 		ioflag |= IO_NDELAY;
1108 	if (fp->f_flag & O_DIRECT)
1109 		ioflag |= IO_DIRECT;
1110 
1111 	/*
1112 	 * Try to read from page cache.  VIRF_DOOMED check is racy but
1113 	 * allows us to avoid unneeded work outright.
1114 	 */
1115 	if (vn_io_pgcache_read_enable && !mac_vnode_check_read_enabled() &&
1116 	    (vn_irflag_read(vp) & (VIRF_DOOMED | VIRF_PGREAD)) == VIRF_PGREAD) {
1117 		error = VOP_READ_PGCACHE(vp, uio, ioflag, fp->f_cred);
1118 		if (error == 0) {
1119 			fp->f_nextoff[UIO_READ] = uio->uio_offset;
1120 			return (0);
1121 		}
1122 		if (error != EJUSTRETURN)
1123 			return (error);
1124 	}
1125 
1126 	advice = get_advice(fp, uio);
1127 	vn_lock(vp, LK_SHARED | LK_RETRY);
1128 
1129 	switch (advice) {
1130 	case POSIX_FADV_NORMAL:
1131 	case POSIX_FADV_SEQUENTIAL:
1132 	case POSIX_FADV_NOREUSE:
1133 		ioflag |= sequential_heuristic(uio, fp);
1134 		break;
1135 	case POSIX_FADV_RANDOM:
1136 		/* Disable read-ahead for random I/O. */
1137 		break;
1138 	}
1139 	orig_offset = uio->uio_offset;
1140 
1141 #ifdef MAC
1142 	error = mac_vnode_check_read(active_cred, fp->f_cred, vp);
1143 	if (error == 0)
1144 #endif
1145 		error = VOP_READ(vp, uio, ioflag, fp->f_cred);
1146 	fp->f_nextoff[UIO_READ] = uio->uio_offset;
1147 	VOP_UNLOCK(vp);
1148 	if (error == 0 && advice == POSIX_FADV_NOREUSE &&
1149 	    orig_offset != uio->uio_offset)
1150 		/*
1151 		 * Use POSIX_FADV_DONTNEED to flush pages and buffers
1152 		 * for the backing file after a POSIX_FADV_NOREUSE
1153 		 * read(2).
1154 		 */
1155 		error = VOP_ADVISE(vp, orig_offset, uio->uio_offset - 1,
1156 		    POSIX_FADV_DONTNEED);
1157 	return (error);
1158 }
1159 
1160 /*
1161  * File table vnode write routine.
1162  */
1163 static int
vn_write(struct file * fp,struct uio * uio,struct ucred * active_cred,int flags,struct thread * td)1164 vn_write(struct file *fp, struct uio *uio, struct ucred *active_cred, int flags,
1165     struct thread *td)
1166 {
1167 	struct vnode *vp;
1168 	struct mount *mp;
1169 	off_t orig_offset;
1170 	int error, ioflag;
1171 	int advice;
1172 	bool need_finished_write;
1173 
1174 	KASSERT(uio->uio_td == td, ("uio_td %p is not td %p",
1175 	    uio->uio_td, td));
1176 	KASSERT(flags & FOF_OFFSET, ("No FOF_OFFSET"));
1177 	vp = fp->f_vnode;
1178 	if (vp->v_type == VREG)
1179 		bwillwrite();
1180 	ioflag = IO_UNIT;
1181 	if (vp->v_type == VREG && (fp->f_flag & O_APPEND) != 0)
1182 		ioflag |= IO_APPEND;
1183 	if ((fp->f_flag & FNONBLOCK) != 0)
1184 		ioflag |= IO_NDELAY;
1185 	ioflag |= get_write_ioflag(fp);
1186 
1187 	mp = NULL;
1188 	need_finished_write = false;
1189 	if (vp->v_type != VCHR) {
1190 		error = vn_start_write(vp, &mp, V_WAIT | V_PCATCH);
1191 		if (error != 0)
1192 			goto unlock;
1193 		need_finished_write = true;
1194 	}
1195 
1196 	advice = get_advice(fp, uio);
1197 
1198 	vn_lock(vp, vn_lktype_write(mp, vp) | LK_RETRY);
1199 	switch (advice) {
1200 	case POSIX_FADV_NORMAL:
1201 	case POSIX_FADV_SEQUENTIAL:
1202 	case POSIX_FADV_NOREUSE:
1203 		ioflag |= sequential_heuristic(uio, fp);
1204 		break;
1205 	case POSIX_FADV_RANDOM:
1206 		/* XXX: Is this correct? */
1207 		break;
1208 	}
1209 	orig_offset = uio->uio_offset;
1210 
1211 #ifdef MAC
1212 	error = mac_vnode_check_write(active_cred, fp->f_cred, vp);
1213 	if (error == 0)
1214 #endif
1215 		error = VOP_WRITE(vp, uio, ioflag, fp->f_cred);
1216 	fp->f_nextoff[UIO_WRITE] = uio->uio_offset;
1217 	VOP_UNLOCK(vp);
1218 	if (need_finished_write)
1219 		vn_finished_write(mp);
1220 	if (error == 0 && advice == POSIX_FADV_NOREUSE &&
1221 	    orig_offset != uio->uio_offset)
1222 		/*
1223 		 * Use POSIX_FADV_DONTNEED to flush pages and buffers
1224 		 * for the backing file after a POSIX_FADV_NOREUSE
1225 		 * write(2).
1226 		 */
1227 		error = VOP_ADVISE(vp, orig_offset, uio->uio_offset - 1,
1228 		    POSIX_FADV_DONTNEED);
1229 unlock:
1230 	return (error);
1231 }
1232 
1233 /*
1234  * The vn_io_fault() is a wrapper around vn_read() and vn_write() to
1235  * prevent the following deadlock:
1236  *
1237  * Assume that the thread A reads from the vnode vp1 into userspace
1238  * buffer buf1 backed by the pages of vnode vp2.  If a page in buf1 is
1239  * currently not resident, then system ends up with the call chain
1240  *   vn_read() -> VOP_READ(vp1) -> uiomove() -> [Page Fault] ->
1241  *     vm_fault(buf1) -> vnode_pager_getpages(vp2) -> VOP_GETPAGES(vp2)
1242  * which establishes lock order vp1->vn_lock, then vp2->vn_lock.
1243  * If, at the same time, thread B reads from vnode vp2 into buffer buf2
1244  * backed by the pages of vnode vp1, and some page in buf2 is not
1245  * resident, we get a reversed order vp2->vn_lock, then vp1->vn_lock.
1246  *
1247  * To prevent the lock order reversal and deadlock, vn_io_fault() does
1248  * not allow page faults to happen during VOP_READ() or VOP_WRITE().
1249  * Instead, it first tries to do the whole range i/o with pagefaults
1250  * disabled. If all pages in the i/o buffer are resident and mapped,
1251  * VOP will succeed (ignoring the genuine filesystem errors).
1252  * Otherwise, we get back EFAULT, and vn_io_fault() falls back to do
1253  * i/o in chunks, with all pages in the chunk prefaulted and held
1254  * using vm_fault_quick_hold_pages().
1255  *
1256  * Filesystems using this deadlock avoidance scheme should use the
1257  * array of the held pages from uio, saved in the curthread->td_ma,
1258  * instead of doing uiomove().  A helper function
1259  * vn_io_fault_uiomove() converts uiomove request into
1260  * uiomove_fromphys() over td_ma array.
1261  *
1262  * Since vnode locks do not cover the whole i/o anymore, rangelocks
1263  * make the current i/o request atomic with respect to other i/os and
1264  * truncations.
1265  */
1266 
1267 /*
1268  * Decode vn_io_fault_args and perform the corresponding i/o.
1269  */
1270 static int
vn_io_fault_doio(struct vn_io_fault_args * args,struct uio * uio,struct thread * td)1271 vn_io_fault_doio(struct vn_io_fault_args *args, struct uio *uio,
1272     struct thread *td)
1273 {
1274 	int error, save;
1275 
1276 	error = 0;
1277 	save = vm_fault_disable_pagefaults();
1278 	switch (args->kind) {
1279 	case VN_IO_FAULT_FOP:
1280 		error = (args->args.fop_args.doio)(args->args.fop_args.fp,
1281 		    uio, args->cred, args->flags, td);
1282 		break;
1283 	case VN_IO_FAULT_VOP:
1284 		switch (uio->uio_rw) {
1285 		case UIO_READ:
1286 			error = VOP_READ(args->args.vop_args.vp, uio,
1287 			    args->flags, args->cred);
1288 			break;
1289 		case UIO_WRITE:
1290 			error = VOP_WRITE(args->args.vop_args.vp, uio,
1291 			    args->flags, args->cred);
1292 			break;
1293 		}
1294 		break;
1295 	default:
1296 		panic("vn_io_fault_doio: unknown kind of io %d %d",
1297 		    args->kind, uio->uio_rw);
1298 	}
1299 	vm_fault_enable_pagefaults(save);
1300 	return (error);
1301 }
1302 
1303 static int
vn_io_fault_touch(char * base,const struct uio * uio)1304 vn_io_fault_touch(char *base, const struct uio *uio)
1305 {
1306 	int r;
1307 
1308 	r = fubyte(base);
1309 	if (r == -1 || (uio->uio_rw == UIO_READ && subyte(base, r) == -1))
1310 		return (EFAULT);
1311 	return (0);
1312 }
1313 
1314 static int
vn_io_fault_prefault_user(const struct uio * uio)1315 vn_io_fault_prefault_user(const struct uio *uio)
1316 {
1317 	char *base;
1318 	const struct iovec *iov;
1319 	size_t len;
1320 	ssize_t resid;
1321 	int error, i;
1322 
1323 	KASSERT(uio->uio_segflg == UIO_USERSPACE,
1324 	    ("vn_io_fault_prefault userspace"));
1325 
1326 	error = i = 0;
1327 	iov = uio->uio_iov;
1328 	resid = uio->uio_resid;
1329 	base = iov->iov_base;
1330 	len = iov->iov_len;
1331 	while (resid > 0) {
1332 		error = vn_io_fault_touch(base, uio);
1333 		if (error != 0)
1334 			break;
1335 		if (len < PAGE_SIZE) {
1336 			if (len != 0) {
1337 				error = vn_io_fault_touch(base + len - 1, uio);
1338 				if (error != 0)
1339 					break;
1340 				resid -= len;
1341 			}
1342 			if (++i >= uio->uio_iovcnt)
1343 				break;
1344 			iov = uio->uio_iov + i;
1345 			base = iov->iov_base;
1346 			len = iov->iov_len;
1347 		} else {
1348 			len -= PAGE_SIZE;
1349 			base += PAGE_SIZE;
1350 			resid -= PAGE_SIZE;
1351 		}
1352 	}
1353 	return (error);
1354 }
1355 
1356 /*
1357  * Common code for vn_io_fault(), agnostic to the kind of i/o request.
1358  * Uses vn_io_fault_doio() to make the call to an actual i/o function.
1359  * Used from vn_rdwr() and vn_io_fault(), which encode the i/o request
1360  * into args and call vn_io_fault1() to handle faults during the user
1361  * mode buffer accesses.
1362  */
1363 static int
vn_io_fault1(struct vnode * vp,struct uio * uio,struct vn_io_fault_args * args,struct thread * td)1364 vn_io_fault1(struct vnode *vp, struct uio *uio, struct vn_io_fault_args *args,
1365     struct thread *td)
1366 {
1367 	vm_page_t ma[io_hold_cnt + 2];
1368 	struct uio *uio_clone, short_uio;
1369 	struct iovec short_iovec[1];
1370 	vm_page_t *prev_td_ma;
1371 	vm_prot_t prot;
1372 	vm_offset_t addr, end;
1373 	size_t len, resid;
1374 	ssize_t adv;
1375 	int error, cnt, saveheld, prev_td_ma_cnt;
1376 
1377 	if (vn_io_fault_prefault) {
1378 		error = vn_io_fault_prefault_user(uio);
1379 		if (error != 0)
1380 			return (error); /* Or ignore ? */
1381 	}
1382 
1383 	prot = uio->uio_rw == UIO_READ ? VM_PROT_WRITE : VM_PROT_READ;
1384 
1385 	/*
1386 	 * The UFS follows IO_UNIT directive and replays back both
1387 	 * uio_offset and uio_resid if an error is encountered during the
1388 	 * operation.  But, since the iovec may be already advanced,
1389 	 * uio is still in an inconsistent state.
1390 	 *
1391 	 * Cache a copy of the original uio, which is advanced to the redo
1392 	 * point using UIO_NOCOPY below.
1393 	 */
1394 	uio_clone = cloneuio(uio);
1395 	resid = uio->uio_resid;
1396 
1397 	short_uio.uio_segflg = UIO_USERSPACE;
1398 	short_uio.uio_rw = uio->uio_rw;
1399 	short_uio.uio_td = uio->uio_td;
1400 
1401 	error = vn_io_fault_doio(args, uio, td);
1402 	if (error != EFAULT)
1403 		goto out;
1404 
1405 	atomic_add_long(&vn_io_faults_cnt, 1);
1406 	uio_clone->uio_segflg = UIO_NOCOPY;
1407 	uiomove(NULL, resid - uio->uio_resid, uio_clone);
1408 	uio_clone->uio_segflg = uio->uio_segflg;
1409 
1410 	saveheld = curthread_pflags_set(TDP_UIOHELD);
1411 	prev_td_ma = td->td_ma;
1412 	prev_td_ma_cnt = td->td_ma_cnt;
1413 
1414 	while (uio_clone->uio_resid != 0) {
1415 		len = uio_clone->uio_iov->iov_len;
1416 		if (len == 0) {
1417 			KASSERT(uio_clone->uio_iovcnt >= 1,
1418 			    ("iovcnt underflow"));
1419 			uio_clone->uio_iov++;
1420 			uio_clone->uio_iovcnt--;
1421 			continue;
1422 		}
1423 		if (len > ptoa(io_hold_cnt))
1424 			len = ptoa(io_hold_cnt);
1425 		addr = (uintptr_t)uio_clone->uio_iov->iov_base;
1426 		end = round_page(addr + len);
1427 		if (end < addr) {
1428 			error = EFAULT;
1429 			break;
1430 		}
1431 		/*
1432 		 * A perfectly misaligned address and length could cause
1433 		 * both the start and the end of the chunk to use partial
1434 		 * page.  +2 accounts for such a situation.
1435 		 */
1436 		cnt = vm_fault_quick_hold_pages(&td->td_proc->p_vmspace->vm_map,
1437 		    addr, len, prot, ma, io_hold_cnt + 2);
1438 		if (cnt == -1) {
1439 			error = EFAULT;
1440 			break;
1441 		}
1442 		short_uio.uio_iov = &short_iovec[0];
1443 		short_iovec[0].iov_base = (void *)addr;
1444 		short_uio.uio_iovcnt = 1;
1445 		short_uio.uio_resid = short_iovec[0].iov_len = len;
1446 		short_uio.uio_offset = uio_clone->uio_offset;
1447 		td->td_ma = ma;
1448 		td->td_ma_cnt = cnt;
1449 
1450 		error = vn_io_fault_doio(args, &short_uio, td);
1451 		vm_page_unhold_pages(ma, cnt);
1452 		adv = len - short_uio.uio_resid;
1453 
1454 		uio_clone->uio_iov->iov_base =
1455 		    (char *)uio_clone->uio_iov->iov_base + adv;
1456 		uio_clone->uio_iov->iov_len -= adv;
1457 		uio_clone->uio_resid -= adv;
1458 		uio_clone->uio_offset += adv;
1459 
1460 		uio->uio_resid -= adv;
1461 		uio->uio_offset += adv;
1462 
1463 		if (error != 0 || adv == 0)
1464 			break;
1465 	}
1466 	td->td_ma = prev_td_ma;
1467 	td->td_ma_cnt = prev_td_ma_cnt;
1468 	curthread_pflags_restore(saveheld);
1469 out:
1470 	freeuio(uio_clone);
1471 	return (error);
1472 }
1473 
1474 static int
vn_io_fault(struct file * fp,struct uio * uio,struct ucred * active_cred,int flags,struct thread * td)1475 vn_io_fault(struct file *fp, struct uio *uio, struct ucred *active_cred,
1476     int flags, struct thread *td)
1477 {
1478 	fo_rdwr_t *doio;
1479 	struct vnode *vp;
1480 	void *rl_cookie;
1481 	struct vn_io_fault_args args;
1482 	int error;
1483 	bool do_io_fault, do_rangelock;
1484 
1485 	doio = uio->uio_rw == UIO_READ ? vn_read : vn_write;
1486 	vp = fp->f_vnode;
1487 
1488 	/*
1489 	 * The ability to read(2) on a directory has historically been
1490 	 * allowed for all users, but this can and has been the source of
1491 	 * at least one security issue in the past.  As such, it is now hidden
1492 	 * away behind a sysctl for those that actually need it to use it, and
1493 	 * restricted to root when it's turned on to make it relatively safe to
1494 	 * leave on for longer sessions of need.
1495 	 */
1496 	if (vp->v_type == VDIR) {
1497 		KASSERT(uio->uio_rw == UIO_READ,
1498 		    ("illegal write attempted on a directory"));
1499 		if (!vfs_allow_read_dir)
1500 			return (EISDIR);
1501 		if ((error = priv_check(td, PRIV_VFS_READ_DIR)) != 0)
1502 			return (EISDIR);
1503 	}
1504 
1505 	do_io_fault = do_vn_io_fault(vp, uio);
1506 	do_rangelock = do_io_fault || (vn_irflag_read(vp) & VIRF_PGREAD) != 0;
1507 	foffset_lock_uio(fp, uio, flags);
1508 	if (do_rangelock) {
1509 		if (uio->uio_rw == UIO_READ) {
1510 			rl_cookie = vn_rangelock_rlock(vp, uio->uio_offset,
1511 			    uio->uio_offset + uio->uio_resid);
1512 		} else if ((fp->f_flag & O_APPEND) != 0 ||
1513 		    (flags & FOF_OFFSET) == 0) {
1514 			/* For appenders, punt and lock the whole range. */
1515 			rl_cookie = vn_rangelock_wlock(vp, 0, OFF_MAX);
1516 		} else {
1517 			rl_cookie = vn_rangelock_wlock(vp, uio->uio_offset,
1518 			    uio->uio_offset + uio->uio_resid);
1519 		}
1520 	}
1521 	if (do_io_fault) {
1522 		args.kind = VN_IO_FAULT_FOP;
1523 		args.args.fop_args.fp = fp;
1524 		args.args.fop_args.doio = doio;
1525 		args.cred = active_cred;
1526 		args.flags = flags | FOF_OFFSET;
1527 		error = vn_io_fault1(vp, uio, &args, td);
1528 	} else {
1529 		error = doio(fp, uio, active_cred, flags | FOF_OFFSET, td);
1530 	}
1531 	if (do_rangelock)
1532 		vn_rangelock_unlock(vp, rl_cookie);
1533 	foffset_unlock_uio(fp, uio, flags);
1534 	return (error);
1535 }
1536 
1537 /*
1538  * Helper function to perform the requested uiomove operation using
1539  * the held pages for io->uio_iov[0].iov_base buffer instead of
1540  * copyin/copyout.  Access to the pages with uiomove_fromphys()
1541  * instead of iov_base prevents page faults that could occur due to
1542  * pmap_collect() invalidating the mapping created by
1543  * vm_fault_quick_hold_pages(), or pageout daemon, page laundry or
1544  * object cleanup revoking the write access from page mappings.
1545  *
1546  * Filesystems specified MNTK_NO_IOPF shall use vn_io_fault_uiomove()
1547  * instead of plain uiomove().
1548  */
1549 int
vn_io_fault_uiomove(char * data,int xfersize,struct uio * uio)1550 vn_io_fault_uiomove(char *data, int xfersize, struct uio *uio)
1551 {
1552 	struct uio transp_uio;
1553 	struct iovec transp_iov[1];
1554 	struct thread *td;
1555 	size_t adv;
1556 	int error, pgadv;
1557 
1558 	td = curthread;
1559 	if ((td->td_pflags & TDP_UIOHELD) == 0 ||
1560 	    uio->uio_segflg != UIO_USERSPACE)
1561 		return (uiomove(data, xfersize, uio));
1562 
1563 	KASSERT(uio->uio_iovcnt == 1, ("uio_iovcnt %d", uio->uio_iovcnt));
1564 	transp_iov[0].iov_base = data;
1565 	transp_uio.uio_iov = &transp_iov[0];
1566 	transp_uio.uio_iovcnt = 1;
1567 	if (xfersize > uio->uio_resid)
1568 		xfersize = uio->uio_resid;
1569 	transp_uio.uio_resid = transp_iov[0].iov_len = xfersize;
1570 	transp_uio.uio_offset = 0;
1571 	transp_uio.uio_segflg = UIO_SYSSPACE;
1572 	/*
1573 	 * Since transp_iov points to data, and td_ma page array
1574 	 * corresponds to original uio->uio_iov, we need to invert the
1575 	 * direction of the i/o operation as passed to
1576 	 * uiomove_fromphys().
1577 	 */
1578 	switch (uio->uio_rw) {
1579 	case UIO_WRITE:
1580 		transp_uio.uio_rw = UIO_READ;
1581 		break;
1582 	case UIO_READ:
1583 		transp_uio.uio_rw = UIO_WRITE;
1584 		break;
1585 	}
1586 	transp_uio.uio_td = uio->uio_td;
1587 	error = uiomove_fromphys(td->td_ma,
1588 	    ((vm_offset_t)uio->uio_iov->iov_base) & PAGE_MASK,
1589 	    xfersize, &transp_uio);
1590 	adv = xfersize - transp_uio.uio_resid;
1591 	pgadv =
1592 	    (((vm_offset_t)uio->uio_iov->iov_base + adv) >> PAGE_SHIFT) -
1593 	    (((vm_offset_t)uio->uio_iov->iov_base) >> PAGE_SHIFT);
1594 	td->td_ma += pgadv;
1595 	KASSERT(td->td_ma_cnt >= pgadv, ("consumed pages %d %d", td->td_ma_cnt,
1596 	    pgadv));
1597 	td->td_ma_cnt -= pgadv;
1598 	uio->uio_iov->iov_base = (char *)uio->uio_iov->iov_base + adv;
1599 	uio->uio_iov->iov_len -= adv;
1600 	uio->uio_resid -= adv;
1601 	uio->uio_offset += adv;
1602 	return (error);
1603 }
1604 
1605 int
vn_io_fault_pgmove(vm_page_t ma[],vm_offset_t offset,int xfersize,struct uio * uio)1606 vn_io_fault_pgmove(vm_page_t ma[], vm_offset_t offset, int xfersize,
1607     struct uio *uio)
1608 {
1609 	struct thread *td;
1610 	vm_offset_t iov_base;
1611 	int cnt, pgadv;
1612 
1613 	td = curthread;
1614 	if ((td->td_pflags & TDP_UIOHELD) == 0 ||
1615 	    uio->uio_segflg != UIO_USERSPACE)
1616 		return (uiomove_fromphys(ma, offset, xfersize, uio));
1617 
1618 	KASSERT(uio->uio_iovcnt == 1, ("uio_iovcnt %d", uio->uio_iovcnt));
1619 	cnt = xfersize > uio->uio_resid ? uio->uio_resid : xfersize;
1620 	iov_base = (vm_offset_t)uio->uio_iov->iov_base;
1621 	switch (uio->uio_rw) {
1622 	case UIO_WRITE:
1623 		pmap_copy_pages(td->td_ma, iov_base & PAGE_MASK, ma,
1624 		    offset, cnt);
1625 		break;
1626 	case UIO_READ:
1627 		pmap_copy_pages(ma, offset, td->td_ma, iov_base & PAGE_MASK,
1628 		    cnt);
1629 		break;
1630 	}
1631 	pgadv = ((iov_base + cnt) >> PAGE_SHIFT) - (iov_base >> PAGE_SHIFT);
1632 	td->td_ma += pgadv;
1633 	KASSERT(td->td_ma_cnt >= pgadv, ("consumed pages %d %d", td->td_ma_cnt,
1634 	    pgadv));
1635 	td->td_ma_cnt -= pgadv;
1636 	uio->uio_iov->iov_base = (char *)(iov_base + cnt);
1637 	uio->uio_iov->iov_len -= cnt;
1638 	uio->uio_resid -= cnt;
1639 	uio->uio_offset += cnt;
1640 	return (0);
1641 }
1642 
1643 /*
1644  * File table truncate routine.
1645  */
1646 static int
vn_truncate(struct file * fp,off_t length,struct ucred * active_cred,struct thread * td)1647 vn_truncate(struct file *fp, off_t length, struct ucred *active_cred,
1648     struct thread *td)
1649 {
1650 	struct mount *mp;
1651 	struct vnode *vp;
1652 	void *rl_cookie;
1653 	int error;
1654 
1655 	vp = fp->f_vnode;
1656 
1657 retry:
1658 	/*
1659 	 * Lock the whole range for truncation.  Otherwise split i/o
1660 	 * might happen partly before and partly after the truncation.
1661 	 */
1662 	rl_cookie = vn_rangelock_wlock(vp, 0, OFF_MAX);
1663 	error = vn_start_write(vp, &mp, V_WAIT | V_PCATCH);
1664 	if (error)
1665 		goto out1;
1666 	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
1667 	AUDIT_ARG_VNODE1(vp);
1668 	if (vp->v_type == VDIR) {
1669 		error = EISDIR;
1670 		goto out;
1671 	}
1672 #ifdef MAC
1673 	error = mac_vnode_check_write(active_cred, fp->f_cred, vp);
1674 	if (error)
1675 		goto out;
1676 #endif
1677 	error = vn_truncate_locked(vp, length, (fp->f_flag & O_FSYNC) != 0,
1678 	    fp->f_cred);
1679 out:
1680 	VOP_UNLOCK(vp);
1681 	vn_finished_write(mp);
1682 out1:
1683 	vn_rangelock_unlock(vp, rl_cookie);
1684 	if (error == ERELOOKUP)
1685 		goto retry;
1686 	return (error);
1687 }
1688 
1689 /*
1690  * Truncate a file that is already locked.
1691  */
1692 int
vn_truncate_locked(struct vnode * vp,off_t length,bool sync,struct ucred * cred)1693 vn_truncate_locked(struct vnode *vp, off_t length, bool sync,
1694     struct ucred *cred)
1695 {
1696 	struct vattr vattr;
1697 	int error;
1698 
1699 	error = VOP_ADD_WRITECOUNT(vp, 1);
1700 	if (error == 0) {
1701 		VATTR_NULL(&vattr);
1702 		vattr.va_size = length;
1703 		if (sync)
1704 			vattr.va_vaflags |= VA_SYNC;
1705 		error = VOP_SETATTR(vp, &vattr, cred);
1706 		VOP_ADD_WRITECOUNT_CHECKED(vp, -1);
1707 	}
1708 	return (error);
1709 }
1710 
1711 /*
1712  * File table vnode stat routine.
1713  */
1714 int
vn_statfile(struct file * fp,struct stat * sb,struct ucred * active_cred)1715 vn_statfile(struct file *fp, struct stat *sb, struct ucred *active_cred)
1716 {
1717 	struct vnode *vp = fp->f_vnode;
1718 	int error;
1719 
1720 	vn_lock(vp, LK_SHARED | LK_RETRY);
1721 	error = VOP_STAT(vp, sb, active_cred, fp->f_cred);
1722 	VOP_UNLOCK(vp);
1723 
1724 	return (error);
1725 }
1726 
1727 /*
1728  * File table vnode ioctl routine.
1729  */
1730 static int
vn_ioctl(struct file * fp,u_long com,void * data,struct ucred * active_cred,struct thread * td)1731 vn_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
1732     struct thread *td)
1733 {
1734 	struct vnode *vp;
1735 	struct fiobmap2_arg *bmarg;
1736 	off_t size;
1737 	int error;
1738 
1739 	vp = fp->f_vnode;
1740 	switch (vp->v_type) {
1741 	case VDIR:
1742 	case VREG:
1743 		switch (com) {
1744 		case FIONREAD:
1745 			error = vn_getsize(vp, &size, active_cred);
1746 			if (error == 0)
1747 				*(int *)data = size - fp->f_offset;
1748 			return (error);
1749 		case FIOBMAP2:
1750 			bmarg = (struct fiobmap2_arg *)data;
1751 			vn_lock(vp, LK_SHARED | LK_RETRY);
1752 #ifdef MAC
1753 			error = mac_vnode_check_read(active_cred, fp->f_cred,
1754 			    vp);
1755 			if (error == 0)
1756 #endif
1757 				error = VOP_BMAP(vp, bmarg->bn, NULL,
1758 				    &bmarg->bn, &bmarg->runp, &bmarg->runb);
1759 			VOP_UNLOCK(vp);
1760 			return (error);
1761 		case FIONBIO:
1762 		case FIOASYNC:
1763 			return (0);
1764 		default:
1765 			return (VOP_IOCTL(vp, com, data, fp->f_flag,
1766 			    active_cred, td));
1767 		}
1768 		break;
1769 	case VCHR:
1770 		return (VOP_IOCTL(vp, com, data, fp->f_flag,
1771 		    active_cred, td));
1772 	default:
1773 		return (ENOTTY);
1774 	}
1775 }
1776 
1777 /*
1778  * File table vnode poll routine.
1779  */
1780 static int
vn_poll(struct file * fp,int events,struct ucred * active_cred,struct thread * td)1781 vn_poll(struct file *fp, int events, struct ucred *active_cred,
1782     struct thread *td)
1783 {
1784 	struct vnode *vp;
1785 	int error;
1786 
1787 	vp = fp->f_vnode;
1788 #if defined(MAC) || defined(AUDIT)
1789 	if (AUDITING_TD(td) || mac_vnode_check_poll_enabled()) {
1790 		vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
1791 		AUDIT_ARG_VNODE1(vp);
1792 		error = mac_vnode_check_poll(active_cred, fp->f_cred, vp);
1793 		VOP_UNLOCK(vp);
1794 		if (error != 0)
1795 			return (error);
1796 	}
1797 #endif
1798 	error = VOP_POLL(vp, events, fp->f_cred, td);
1799 	return (error);
1800 }
1801 
1802 /*
1803  * Acquire the requested lock and then check for validity.  LK_RETRY
1804  * permits vn_lock to return doomed vnodes.
1805  */
1806 static int __noinline
_vn_lock_fallback(struct vnode * vp,int flags,const char * file,int line,int error)1807 _vn_lock_fallback(struct vnode *vp, int flags, const char *file, int line,
1808     int error)
1809 {
1810 
1811 	KASSERT((flags & LK_RETRY) == 0 || error == 0,
1812 	    ("vn_lock: error %d incompatible with flags %#x", error, flags));
1813 
1814 	if (error == 0)
1815 		VNASSERT(VN_IS_DOOMED(vp), vp, ("vnode not doomed"));
1816 
1817 	if ((flags & LK_RETRY) == 0) {
1818 		if (error == 0) {
1819 			VOP_UNLOCK(vp);
1820 			error = ENOENT;
1821 		}
1822 		return (error);
1823 	}
1824 
1825 	/*
1826 	 * LK_RETRY case.
1827 	 *
1828 	 * Nothing to do if we got the lock.
1829 	 */
1830 	if (error == 0)
1831 		return (0);
1832 
1833 	/*
1834 	 * Interlock was dropped by the call in _vn_lock.
1835 	 */
1836 	flags &= ~LK_INTERLOCK;
1837 	do {
1838 		error = VOP_LOCK1(vp, flags, file, line);
1839 	} while (error != 0);
1840 	return (0);
1841 }
1842 
1843 int
_vn_lock(struct vnode * vp,int flags,const char * file,int line)1844 _vn_lock(struct vnode *vp, int flags, const char *file, int line)
1845 {
1846 	int error;
1847 
1848 	VNASSERT((flags & LK_TYPE_MASK) != 0, vp,
1849 	    ("vn_lock: no locktype (%d passed)", flags));
1850 	VNPASS(vp->v_holdcnt > 0, vp);
1851 	error = VOP_LOCK1(vp, flags, file, line);
1852 	if (__predict_false(error != 0 || VN_IS_DOOMED(vp)))
1853 		return (_vn_lock_fallback(vp, flags, file, line, error));
1854 	return (0);
1855 }
1856 
1857 /*
1858  * File table vnode close routine.
1859  */
1860 static int
vn_closefile(struct file * fp,struct thread * td)1861 vn_closefile(struct file *fp, struct thread *td)
1862 {
1863 	struct vnode *vp;
1864 	struct flock lf;
1865 	int error;
1866 	bool ref;
1867 
1868 	vp = fp->f_vnode;
1869 	fp->f_ops = &badfileops;
1870 	ref = (fp->f_flag & FHASLOCK) != 0;
1871 
1872 	error = vn_close1(vp, fp->f_flag, fp->f_cred, td, ref);
1873 
1874 	if (__predict_false(ref)) {
1875 		lf.l_whence = SEEK_SET;
1876 		lf.l_start = 0;
1877 		lf.l_len = 0;
1878 		lf.l_type = F_UNLCK;
1879 		(void) VOP_ADVLOCK(vp, fp, F_UNLCK, &lf, F_FLOCK);
1880 		vrele(vp);
1881 	}
1882 	return (error);
1883 }
1884 
1885 /*
1886  * Preparing to start a filesystem write operation. If the operation is
1887  * permitted, then we bump the count of operations in progress and
1888  * proceed. If a suspend request is in progress, we wait until the
1889  * suspension is over, and then proceed.
1890  */
1891 static int
vn_start_write_refed(struct mount * mp,int flags,bool mplocked)1892 vn_start_write_refed(struct mount *mp, int flags, bool mplocked)
1893 {
1894 	struct mount_pcpu *mpcpu;
1895 	int error, mflags;
1896 
1897 	if (__predict_true(!mplocked) && (flags & V_XSLEEP) == 0 &&
1898 	    vfs_op_thread_enter(mp, mpcpu)) {
1899 		MPASS((mp->mnt_kern_flag & MNTK_SUSPEND) == 0);
1900 		vfs_mp_count_add_pcpu(mpcpu, writeopcount, 1);
1901 		vfs_op_thread_exit(mp, mpcpu);
1902 		return (0);
1903 	}
1904 
1905 	if (mplocked)
1906 		mtx_assert(MNT_MTX(mp), MA_OWNED);
1907 	else
1908 		MNT_ILOCK(mp);
1909 
1910 	error = 0;
1911 
1912 	/*
1913 	 * Check on status of suspension.
1914 	 */
1915 	if ((curthread->td_pflags & TDP_IGNSUSP) == 0 ||
1916 	    mp->mnt_susp_owner != curthread) {
1917 		mflags = 0;
1918 		if ((mp->mnt_vfc->vfc_flags & VFCF_SBDRY) != 0) {
1919 			if (flags & V_PCATCH)
1920 				mflags |= PCATCH;
1921 		}
1922 		mflags |= (PUSER - 1);
1923 		while ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0) {
1924 			if ((flags & V_NOWAIT) != 0) {
1925 				error = EWOULDBLOCK;
1926 				goto unlock;
1927 			}
1928 			error = msleep(&mp->mnt_flag, MNT_MTX(mp), mflags,
1929 			    "suspfs", 0);
1930 			if (error != 0)
1931 				goto unlock;
1932 		}
1933 	}
1934 	if ((flags & V_XSLEEP) != 0)
1935 		goto unlock;
1936 	mp->mnt_writeopcount++;
1937 unlock:
1938 	if (error != 0 || (flags & V_XSLEEP) != 0)
1939 		MNT_REL(mp);
1940 	MNT_IUNLOCK(mp);
1941 	return (error);
1942 }
1943 
1944 int
vn_start_write(struct vnode * vp,struct mount ** mpp,int flags)1945 vn_start_write(struct vnode *vp, struct mount **mpp, int flags)
1946 {
1947 	struct mount *mp;
1948 	int error;
1949 
1950 	KASSERT((flags & ~V_VALID_FLAGS) == 0,
1951 	    ("%s: invalid flags passed %d\n", __func__, flags));
1952 
1953 	error = 0;
1954 	/*
1955 	 * If a vnode is provided, get and return the mount point that
1956 	 * to which it will write.
1957 	 */
1958 	if (vp != NULL) {
1959 		if ((error = VOP_GETWRITEMOUNT(vp, mpp)) != 0) {
1960 			*mpp = NULL;
1961 			if (error != EOPNOTSUPP)
1962 				return (error);
1963 			return (0);
1964 		}
1965 	}
1966 	if ((mp = *mpp) == NULL)
1967 		return (0);
1968 
1969 	/*
1970 	 * VOP_GETWRITEMOUNT() returns with the mp refcount held through
1971 	 * a vfs_ref().
1972 	 * As long as a vnode is not provided we need to acquire a
1973 	 * refcount for the provided mountpoint too, in order to
1974 	 * emulate a vfs_ref().
1975 	 */
1976 	if (vp == NULL)
1977 		vfs_ref(mp);
1978 
1979 	error = vn_start_write_refed(mp, flags, false);
1980 	if (error != 0 && (flags & V_NOWAIT) == 0)
1981 		*mpp = NULL;
1982 	return (error);
1983 }
1984 
1985 /*
1986  * Secondary suspension. Used by operations such as vop_inactive
1987  * routines that are needed by the higher level functions. These
1988  * are allowed to proceed until all the higher level functions have
1989  * completed (indicated by mnt_writeopcount dropping to zero). At that
1990  * time, these operations are halted until the suspension is over.
1991  */
1992 int
vn_start_secondary_write(struct vnode * vp,struct mount ** mpp,int flags)1993 vn_start_secondary_write(struct vnode *vp, struct mount **mpp, int flags)
1994 {
1995 	struct mount *mp;
1996 	int error, mflags;
1997 
1998 	KASSERT((flags & (~V_VALID_FLAGS | V_XSLEEP)) == 0,
1999 	    ("%s: invalid flags passed %d\n", __func__, flags));
2000 
2001  retry:
2002 	if (vp != NULL) {
2003 		if ((error = VOP_GETWRITEMOUNT(vp, mpp)) != 0) {
2004 			*mpp = NULL;
2005 			if (error != EOPNOTSUPP)
2006 				return (error);
2007 			return (0);
2008 		}
2009 	}
2010 	/*
2011 	 * If we are not suspended or have not yet reached suspended
2012 	 * mode, then let the operation proceed.
2013 	 */
2014 	if ((mp = *mpp) == NULL)
2015 		return (0);
2016 
2017 	/*
2018 	 * VOP_GETWRITEMOUNT() returns with the mp refcount held through
2019 	 * a vfs_ref().
2020 	 * As long as a vnode is not provided we need to acquire a
2021 	 * refcount for the provided mountpoint too, in order to
2022 	 * emulate a vfs_ref().
2023 	 */
2024 	MNT_ILOCK(mp);
2025 	if (vp == NULL)
2026 		MNT_REF(mp);
2027 	if ((mp->mnt_kern_flag & (MNTK_SUSPENDED | MNTK_SUSPEND2)) == 0) {
2028 		mp->mnt_secondary_writes++;
2029 		mp->mnt_secondary_accwrites++;
2030 		MNT_IUNLOCK(mp);
2031 		return (0);
2032 	}
2033 	if ((flags & V_NOWAIT) != 0) {
2034 		MNT_REL(mp);
2035 		MNT_IUNLOCK(mp);
2036 		*mpp = NULL;
2037 		return (EWOULDBLOCK);
2038 	}
2039 	/*
2040 	 * Wait for the suspension to finish.
2041 	 */
2042 	mflags = 0;
2043 	if ((mp->mnt_vfc->vfc_flags & VFCF_SBDRY) != 0) {
2044 		if ((flags & V_PCATCH) != 0)
2045 			mflags |= PCATCH;
2046 	}
2047 	mflags |= (PUSER - 1) | PDROP;
2048 	error = msleep(&mp->mnt_flag, MNT_MTX(mp), mflags, "suspfs", 0);
2049 	vfs_rel(mp);
2050 	if (error == 0)
2051 		goto retry;
2052 	*mpp = NULL;
2053 	return (error);
2054 }
2055 
2056 /*
2057  * Filesystem write operation has completed. If we are suspending and this
2058  * operation is the last one, notify the suspender that the suspension is
2059  * now in effect.
2060  */
2061 void
vn_finished_write(struct mount * mp)2062 vn_finished_write(struct mount *mp)
2063 {
2064 	struct mount_pcpu *mpcpu;
2065 	int c;
2066 
2067 	if (mp == NULL)
2068 		return;
2069 
2070 	if (vfs_op_thread_enter(mp, mpcpu)) {
2071 		vfs_mp_count_sub_pcpu(mpcpu, writeopcount, 1);
2072 		vfs_mp_count_sub_pcpu(mpcpu, ref, 1);
2073 		vfs_op_thread_exit(mp, mpcpu);
2074 		return;
2075 	}
2076 
2077 	MNT_ILOCK(mp);
2078 	vfs_assert_mount_counters(mp);
2079 	MNT_REL(mp);
2080 	c = --mp->mnt_writeopcount;
2081 	if (mp->mnt_vfs_ops == 0) {
2082 		MPASS((mp->mnt_kern_flag & MNTK_SUSPEND) == 0);
2083 		MNT_IUNLOCK(mp);
2084 		return;
2085 	}
2086 	if (c < 0)
2087 		vfs_dump_mount_counters(mp);
2088 	if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0 && c == 0)
2089 		wakeup(&mp->mnt_writeopcount);
2090 	MNT_IUNLOCK(mp);
2091 }
2092 
2093 /*
2094  * Filesystem secondary write operation has completed. If we are
2095  * suspending and this operation is the last one, notify the suspender
2096  * that the suspension is now in effect.
2097  */
2098 void
vn_finished_secondary_write(struct mount * mp)2099 vn_finished_secondary_write(struct mount *mp)
2100 {
2101 	if (mp == NULL)
2102 		return;
2103 	MNT_ILOCK(mp);
2104 	MNT_REL(mp);
2105 	mp->mnt_secondary_writes--;
2106 	if (mp->mnt_secondary_writes < 0)
2107 		panic("vn_finished_secondary_write: neg cnt");
2108 	if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0 &&
2109 	    mp->mnt_secondary_writes <= 0)
2110 		wakeup(&mp->mnt_secondary_writes);
2111 	MNT_IUNLOCK(mp);
2112 }
2113 
2114 /*
2115  * Request a filesystem to suspend write operations.
2116  */
2117 int
vfs_write_suspend(struct mount * mp,int flags)2118 vfs_write_suspend(struct mount *mp, int flags)
2119 {
2120 	int error;
2121 
2122 	vfs_op_enter(mp);
2123 
2124 	MNT_ILOCK(mp);
2125 	vfs_assert_mount_counters(mp);
2126 	if (mp->mnt_susp_owner == curthread) {
2127 		vfs_op_exit_locked(mp);
2128 		MNT_IUNLOCK(mp);
2129 		return (EALREADY);
2130 	}
2131 	while (mp->mnt_kern_flag & MNTK_SUSPEND)
2132 		msleep(&mp->mnt_flag, MNT_MTX(mp), PUSER - 1, "wsuspfs", 0);
2133 
2134 	/*
2135 	 * Unmount holds a write reference on the mount point.  If we
2136 	 * own busy reference and drain for writers, we deadlock with
2137 	 * the reference draining in the unmount path.  Callers of
2138 	 * vfs_write_suspend() must specify VS_SKIP_UNMOUNT if
2139 	 * vfs_busy() reference is owned and caller is not in the
2140 	 * unmount context.
2141 	 */
2142 	if ((flags & VS_SKIP_UNMOUNT) != 0 &&
2143 	    (mp->mnt_kern_flag & MNTK_UNMOUNT) != 0) {
2144 		vfs_op_exit_locked(mp);
2145 		MNT_IUNLOCK(mp);
2146 		return (EBUSY);
2147 	}
2148 
2149 	mp->mnt_kern_flag |= MNTK_SUSPEND;
2150 	mp->mnt_susp_owner = curthread;
2151 	if (mp->mnt_writeopcount > 0)
2152 		(void) msleep(&mp->mnt_writeopcount,
2153 		    MNT_MTX(mp), (PUSER - 1)|PDROP, "suspwt", 0);
2154 	else
2155 		MNT_IUNLOCK(mp);
2156 	if ((error = VFS_SYNC(mp, MNT_SUSPEND)) != 0) {
2157 		vfs_write_resume(mp, 0);
2158 		/* vfs_write_resume does vfs_op_exit() for us */
2159 	}
2160 	return (error);
2161 }
2162 
2163 /*
2164  * Request a filesystem to resume write operations.
2165  */
2166 void
vfs_write_resume(struct mount * mp,int flags)2167 vfs_write_resume(struct mount *mp, int flags)
2168 {
2169 
2170 	MNT_ILOCK(mp);
2171 	if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0) {
2172 		KASSERT(mp->mnt_susp_owner == curthread, ("mnt_susp_owner"));
2173 		mp->mnt_kern_flag &= ~(MNTK_SUSPEND | MNTK_SUSPEND2 |
2174 				       MNTK_SUSPENDED);
2175 		mp->mnt_susp_owner = NULL;
2176 		wakeup(&mp->mnt_writeopcount);
2177 		wakeup(&mp->mnt_flag);
2178 		curthread->td_pflags &= ~TDP_IGNSUSP;
2179 		if ((flags & VR_START_WRITE) != 0) {
2180 			MNT_REF(mp);
2181 			mp->mnt_writeopcount++;
2182 		}
2183 		MNT_IUNLOCK(mp);
2184 		if ((flags & VR_NO_SUSPCLR) == 0)
2185 			VFS_SUSP_CLEAN(mp);
2186 		vfs_op_exit(mp);
2187 	} else if ((flags & VR_START_WRITE) != 0) {
2188 		MNT_REF(mp);
2189 		vn_start_write_refed(mp, 0, true);
2190 	} else {
2191 		MNT_IUNLOCK(mp);
2192 	}
2193 }
2194 
2195 /*
2196  * Helper loop around vfs_write_suspend() for filesystem unmount VFS
2197  * methods.
2198  */
2199 int
vfs_write_suspend_umnt(struct mount * mp)2200 vfs_write_suspend_umnt(struct mount *mp)
2201 {
2202 	int error;
2203 
2204 	KASSERT((curthread->td_pflags & TDP_IGNSUSP) == 0,
2205 	    ("vfs_write_suspend_umnt: recursed"));
2206 
2207 	/* dounmount() already called vn_start_write(). */
2208 	for (;;) {
2209 		vn_finished_write(mp);
2210 		error = vfs_write_suspend(mp, 0);
2211 		if (error != 0) {
2212 			vn_start_write(NULL, &mp, V_WAIT);
2213 			return (error);
2214 		}
2215 		MNT_ILOCK(mp);
2216 		if ((mp->mnt_kern_flag & MNTK_SUSPENDED) != 0)
2217 			break;
2218 		MNT_IUNLOCK(mp);
2219 		vn_start_write(NULL, &mp, V_WAIT);
2220 	}
2221 	mp->mnt_kern_flag &= ~(MNTK_SUSPENDED | MNTK_SUSPEND2);
2222 	wakeup(&mp->mnt_flag);
2223 	MNT_IUNLOCK(mp);
2224 	curthread->td_pflags |= TDP_IGNSUSP;
2225 	return (0);
2226 }
2227 
2228 /*
2229  * Implement kqueues for files by translating it to vnode operation.
2230  */
2231 static int
vn_kqfilter(struct file * fp,struct knote * kn)2232 vn_kqfilter(struct file *fp, struct knote *kn)
2233 {
2234 
2235 	return (VOP_KQFILTER(fp->f_vnode, kn));
2236 }
2237 
2238 int
vn_kqfilter_opath(struct file * fp,struct knote * kn)2239 vn_kqfilter_opath(struct file *fp, struct knote *kn)
2240 {
2241 	if ((fp->f_flag & FKQALLOWED) == 0)
2242 		return (EBADF);
2243 	return (vn_kqfilter(fp, kn));
2244 }
2245 
2246 /*
2247  * Simplified in-kernel wrapper calls for extended attribute access.
2248  * Both calls pass in a NULL credential, authorizing as "kernel" access.
2249  * Set IO_NODELOCKED in ioflg if the vnode is already locked.
2250  */
2251 int
vn_extattr_get(struct vnode * vp,int ioflg,int attrnamespace,const char * attrname,int * buflen,char * buf,struct thread * td)2252 vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
2253     const char *attrname, int *buflen, char *buf, struct thread *td)
2254 {
2255 	struct uio	auio;
2256 	struct iovec	iov;
2257 	int	error;
2258 
2259 	iov.iov_len = *buflen;
2260 	iov.iov_base = buf;
2261 
2262 	auio.uio_iov = &iov;
2263 	auio.uio_iovcnt = 1;
2264 	auio.uio_rw = UIO_READ;
2265 	auio.uio_segflg = UIO_SYSSPACE;
2266 	auio.uio_td = td;
2267 	auio.uio_offset = 0;
2268 	auio.uio_resid = *buflen;
2269 
2270 	if ((ioflg & IO_NODELOCKED) == 0)
2271 		vn_lock(vp, LK_SHARED | LK_RETRY);
2272 
2273 	ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2274 
2275 	/* authorize attribute retrieval as kernel */
2276 	error = VOP_GETEXTATTR(vp, attrnamespace, attrname, &auio, NULL, NULL,
2277 	    td);
2278 
2279 	if ((ioflg & IO_NODELOCKED) == 0)
2280 		VOP_UNLOCK(vp);
2281 
2282 	if (error == 0) {
2283 		*buflen = *buflen - auio.uio_resid;
2284 	}
2285 
2286 	return (error);
2287 }
2288 
2289 /*
2290  * XXX failure mode if partially written?
2291  */
2292 int
vn_extattr_set(struct vnode * vp,int ioflg,int attrnamespace,const char * attrname,int buflen,char * buf,struct thread * td)2293 vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
2294     const char *attrname, int buflen, char *buf, struct thread *td)
2295 {
2296 	struct uio	auio;
2297 	struct iovec	iov;
2298 	struct mount	*mp;
2299 	int	error;
2300 
2301 	iov.iov_len = buflen;
2302 	iov.iov_base = buf;
2303 
2304 	auio.uio_iov = &iov;
2305 	auio.uio_iovcnt = 1;
2306 	auio.uio_rw = UIO_WRITE;
2307 	auio.uio_segflg = UIO_SYSSPACE;
2308 	auio.uio_td = td;
2309 	auio.uio_offset = 0;
2310 	auio.uio_resid = buflen;
2311 
2312 	if ((ioflg & IO_NODELOCKED) == 0) {
2313 		if ((error = vn_start_write(vp, &mp, V_WAIT)) != 0)
2314 			return (error);
2315 		vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2316 	}
2317 
2318 	ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2319 
2320 	/* authorize attribute setting as kernel */
2321 	error = VOP_SETEXTATTR(vp, attrnamespace, attrname, &auio, NULL, td);
2322 
2323 	if ((ioflg & IO_NODELOCKED) == 0) {
2324 		vn_finished_write(mp);
2325 		VOP_UNLOCK(vp);
2326 	}
2327 
2328 	return (error);
2329 }
2330 
2331 int
vn_extattr_rm(struct vnode * vp,int ioflg,int attrnamespace,const char * attrname,struct thread * td)2332 vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
2333     const char *attrname, struct thread *td)
2334 {
2335 	struct mount	*mp;
2336 	int	error;
2337 
2338 	if ((ioflg & IO_NODELOCKED) == 0) {
2339 		if ((error = vn_start_write(vp, &mp, V_WAIT)) != 0)
2340 			return (error);
2341 		vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2342 	}
2343 
2344 	ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2345 
2346 	/* authorize attribute removal as kernel */
2347 	error = VOP_DELETEEXTATTR(vp, attrnamespace, attrname, NULL, td);
2348 	if (error == EOPNOTSUPP)
2349 		error = VOP_SETEXTATTR(vp, attrnamespace, attrname, NULL,
2350 		    NULL, td);
2351 
2352 	if ((ioflg & IO_NODELOCKED) == 0) {
2353 		vn_finished_write(mp);
2354 		VOP_UNLOCK(vp);
2355 	}
2356 
2357 	return (error);
2358 }
2359 
2360 static int
vn_get_ino_alloc_vget(struct mount * mp,void * arg,int lkflags,struct vnode ** rvp)2361 vn_get_ino_alloc_vget(struct mount *mp, void *arg, int lkflags,
2362     struct vnode **rvp)
2363 {
2364 
2365 	return (VFS_VGET(mp, *(ino_t *)arg, lkflags, rvp));
2366 }
2367 
2368 int
vn_vget_ino(struct vnode * vp,ino_t ino,int lkflags,struct vnode ** rvp)2369 vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags, struct vnode **rvp)
2370 {
2371 
2372 	return (vn_vget_ino_gen(vp, vn_get_ino_alloc_vget, &ino,
2373 	    lkflags, rvp));
2374 }
2375 
2376 int
vn_vget_ino_gen(struct vnode * vp,vn_get_ino_t alloc,void * alloc_arg,int lkflags,struct vnode ** rvp)2377 vn_vget_ino_gen(struct vnode *vp, vn_get_ino_t alloc, void *alloc_arg,
2378     int lkflags, struct vnode **rvp)
2379 {
2380 	struct mount *mp;
2381 	int ltype, error;
2382 
2383 	ASSERT_VOP_LOCKED(vp, "vn_vget_ino_get");
2384 	mp = vp->v_mount;
2385 	ltype = VOP_ISLOCKED(vp);
2386 	KASSERT(ltype == LK_EXCLUSIVE || ltype == LK_SHARED,
2387 	    ("vn_vget_ino: vp not locked"));
2388 	error = vfs_busy(mp, MBF_NOWAIT);
2389 	if (error != 0) {
2390 		vfs_ref(mp);
2391 		VOP_UNLOCK(vp);
2392 		error = vfs_busy(mp, 0);
2393 		vn_lock(vp, ltype | LK_RETRY);
2394 		vfs_rel(mp);
2395 		if (error != 0)
2396 			return (ENOENT);
2397 		if (VN_IS_DOOMED(vp)) {
2398 			vfs_unbusy(mp);
2399 			return (ENOENT);
2400 		}
2401 	}
2402 	VOP_UNLOCK(vp);
2403 	error = alloc(mp, alloc_arg, lkflags, rvp);
2404 	vfs_unbusy(mp);
2405 	if (error != 0 || *rvp != vp)
2406 		vn_lock(vp, ltype | LK_RETRY);
2407 	if (VN_IS_DOOMED(vp)) {
2408 		if (error == 0) {
2409 			if (*rvp == vp)
2410 				vunref(vp);
2411 			else
2412 				vput(*rvp);
2413 		}
2414 		error = ENOENT;
2415 	}
2416 	return (error);
2417 }
2418 
2419 static void
vn_send_sigxfsz(struct proc * p)2420 vn_send_sigxfsz(struct proc *p)
2421 {
2422 	PROC_LOCK(p);
2423 	kern_psignal(p, SIGXFSZ);
2424 	PROC_UNLOCK(p);
2425 }
2426 
2427 int
vn_rlimit_trunc(u_quad_t size,struct thread * td)2428 vn_rlimit_trunc(u_quad_t size, struct thread *td)
2429 {
2430 	if (size <= lim_cur(td, RLIMIT_FSIZE))
2431 		return (0);
2432 	vn_send_sigxfsz(td->td_proc);
2433 	return (EFBIG);
2434 }
2435 
2436 static int
vn_rlimit_fsizex1(const struct vnode * vp,struct uio * uio,off_t maxfsz,bool adj,struct thread * td)2437 vn_rlimit_fsizex1(const struct vnode *vp, struct uio *uio, off_t maxfsz,
2438     bool adj, struct thread *td)
2439 {
2440 	off_t lim;
2441 	bool ktr_write;
2442 
2443 	if (vp->v_type != VREG)
2444 		return (0);
2445 
2446 	/*
2447 	 * Handle file system maximum file size.
2448 	 */
2449 	if (maxfsz != 0 && uio->uio_offset + uio->uio_resid > maxfsz) {
2450 		if (!adj || uio->uio_offset >= maxfsz)
2451 			return (EFBIG);
2452 		uio->uio_resid = maxfsz - uio->uio_offset;
2453 	}
2454 
2455 	/*
2456 	 * This is kernel write (e.g. vnode_pager) or accounting
2457 	 * write, ignore limit.
2458 	 */
2459 	if (td == NULL || (td->td_pflags2 & TDP2_ACCT) != 0)
2460 		return (0);
2461 
2462 	/*
2463 	 * Calculate file size limit.
2464 	 */
2465 	ktr_write = (td->td_pflags & TDP_INKTRACE) != 0;
2466 	lim = __predict_false(ktr_write) ? td->td_ktr_io_lim :
2467 	    lim_cur(td, RLIMIT_FSIZE);
2468 
2469 	/*
2470 	 * Is the limit reached?
2471 	 */
2472 	if (__predict_true((uoff_t)uio->uio_offset + uio->uio_resid <= lim))
2473 		return (0);
2474 
2475 	/*
2476 	 * Prepared filesystems can handle writes truncated to the
2477 	 * file size limit.
2478 	 */
2479 	if (adj && (uoff_t)uio->uio_offset < lim) {
2480 		uio->uio_resid = lim - (uoff_t)uio->uio_offset;
2481 		return (0);
2482 	}
2483 
2484 	if (!ktr_write || ktr_filesize_limit_signal)
2485 		vn_send_sigxfsz(td->td_proc);
2486 	return (EFBIG);
2487 }
2488 
2489 /*
2490  * Helper for VOP_WRITE() implementations, the common code to
2491  * handle maximum supported file size on the filesystem, and
2492  * RLIMIT_FSIZE, except for special writes from accounting subsystem
2493  * and ktrace.
2494  *
2495  * For maximum file size (maxfsz argument):
2496  * - return EFBIG if uio_offset is beyond it
2497  * - otherwise, clamp uio_resid if write would extend file beyond maxfsz.
2498  *
2499  * For RLIMIT_FSIZE:
2500  * - return EFBIG and send SIGXFSZ if uio_offset is beyond the limit
2501  * - otherwise, clamp uio_resid if write would extend file beyond limit.
2502  *
2503  * If clamping occured, the adjustment for uio_resid is stored in
2504  * *resid_adj, to be re-applied by vn_rlimit_fsizex_res() on return
2505  * from the VOP.
2506  */
2507 int
vn_rlimit_fsizex(const struct vnode * vp,struct uio * uio,off_t maxfsz,ssize_t * resid_adj,struct thread * td)2508 vn_rlimit_fsizex(const struct vnode *vp, struct uio *uio, off_t maxfsz,
2509     ssize_t *resid_adj, struct thread *td)
2510 {
2511 	ssize_t resid_orig;
2512 	int error;
2513 	bool adj;
2514 
2515 	resid_orig = uio->uio_resid;
2516 	adj = resid_adj != NULL;
2517 	error = vn_rlimit_fsizex1(vp, uio, maxfsz, adj, td);
2518 	if (adj)
2519 		*resid_adj = resid_orig - uio->uio_resid;
2520 	return (error);
2521 }
2522 
2523 void
vn_rlimit_fsizex_res(struct uio * uio,ssize_t resid_adj)2524 vn_rlimit_fsizex_res(struct uio *uio, ssize_t resid_adj)
2525 {
2526 	uio->uio_resid += resid_adj;
2527 }
2528 
2529 int
vn_rlimit_fsize(const struct vnode * vp,const struct uio * uio,struct thread * td)2530 vn_rlimit_fsize(const struct vnode *vp, const struct uio *uio,
2531     struct thread *td)
2532 {
2533 	return (vn_rlimit_fsizex(vp, __DECONST(struct uio *, uio), 0, NULL,
2534 	    td));
2535 }
2536 
2537 int
vn_chmod(struct file * fp,mode_t mode,struct ucred * active_cred,struct thread * td)2538 vn_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
2539     struct thread *td)
2540 {
2541 	struct vnode *vp;
2542 
2543 	vp = fp->f_vnode;
2544 #ifdef AUDIT
2545 	vn_lock(vp, LK_SHARED | LK_RETRY);
2546 	AUDIT_ARG_VNODE1(vp);
2547 	VOP_UNLOCK(vp);
2548 #endif
2549 	return (setfmode(td, active_cred, vp, mode));
2550 }
2551 
2552 int
vn_chown(struct file * fp,uid_t uid,gid_t gid,struct ucred * active_cred,struct thread * td)2553 vn_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
2554     struct thread *td)
2555 {
2556 	struct vnode *vp;
2557 
2558 	vp = fp->f_vnode;
2559 #ifdef AUDIT
2560 	vn_lock(vp, LK_SHARED | LK_RETRY);
2561 	AUDIT_ARG_VNODE1(vp);
2562 	VOP_UNLOCK(vp);
2563 #endif
2564 	return (setfown(td, active_cred, vp, uid, gid));
2565 }
2566 
2567 /*
2568  * Remove pages in the range ["start", "end") from the vnode's VM object.  If
2569  * "end" is 0, then the range extends to the end of the object.
2570  */
2571 void
vn_pages_remove(struct vnode * vp,vm_pindex_t start,vm_pindex_t end)2572 vn_pages_remove(struct vnode *vp, vm_pindex_t start, vm_pindex_t end)
2573 {
2574 	vm_object_t object;
2575 
2576 	if ((object = vp->v_object) == NULL)
2577 		return;
2578 	VM_OBJECT_WLOCK(object);
2579 	vm_object_page_remove(object, start, end, 0);
2580 	VM_OBJECT_WUNLOCK(object);
2581 }
2582 
2583 /*
2584  * Like vn_pages_remove(), but skips invalid pages, which by definition are not
2585  * mapped into any process' address space.  Filesystems may use this in
2586  * preference to vn_pages_remove() to avoid blocking on pages busied in
2587  * preparation for a VOP_GETPAGES.
2588  */
2589 void
vn_pages_remove_valid(struct vnode * vp,vm_pindex_t start,vm_pindex_t end)2590 vn_pages_remove_valid(struct vnode *vp, vm_pindex_t start, vm_pindex_t end)
2591 {
2592 	vm_object_t object;
2593 
2594 	if ((object = vp->v_object) == NULL)
2595 		return;
2596 	VM_OBJECT_WLOCK(object);
2597 	vm_object_page_remove(object, start, end, OBJPR_VALIDONLY);
2598 	VM_OBJECT_WUNLOCK(object);
2599 }
2600 
2601 int
vn_bmap_seekhole_locked(struct vnode * vp,u_long cmd,off_t * off,struct ucred * cred)2602 vn_bmap_seekhole_locked(struct vnode *vp, u_long cmd, off_t *off,
2603     struct ucred *cred)
2604 {
2605 	off_t size;
2606 	daddr_t bn, bnp;
2607 	uint64_t bsize;
2608 	off_t noff;
2609 	int error;
2610 
2611 	KASSERT(cmd == FIOSEEKHOLE || cmd == FIOSEEKDATA,
2612 	    ("%s: Wrong command %lu", __func__, cmd));
2613 	ASSERT_VOP_ELOCKED(vp, "vn_bmap_seekhole_locked");
2614 
2615 	if (vp->v_type != VREG) {
2616 		error = ENOTTY;
2617 		goto out;
2618 	}
2619 	error = vn_getsize_locked(vp, &size, cred);
2620 	if (error != 0)
2621 		goto out;
2622 	noff = *off;
2623 	if (noff < 0 || noff >= size) {
2624 		error = ENXIO;
2625 		goto out;
2626 	}
2627 
2628 	/* See the comment in ufs_bmap_seekdata(). */
2629 	vnode_pager_clean_sync(vp);
2630 
2631 	bsize = vp->v_mount->mnt_stat.f_iosize;
2632 	for (bn = noff / bsize; noff < size; bn++, noff += bsize -
2633 	    noff % bsize) {
2634 		error = VOP_BMAP(vp, bn, NULL, &bnp, NULL, NULL);
2635 		if (error == EOPNOTSUPP) {
2636 			error = ENOTTY;
2637 			goto out;
2638 		}
2639 		if ((bnp == -1 && cmd == FIOSEEKHOLE) ||
2640 		    (bnp != -1 && cmd == FIOSEEKDATA)) {
2641 			noff = bn * bsize;
2642 			if (noff < *off)
2643 				noff = *off;
2644 			goto out;
2645 		}
2646 	}
2647 	if (noff > size)
2648 		noff = size;
2649 	/* noff == size. There is an implicit hole at the end of file. */
2650 	if (cmd == FIOSEEKDATA)
2651 		error = ENXIO;
2652 out:
2653 	if (error == 0)
2654 		*off = noff;
2655 	return (error);
2656 }
2657 
2658 int
vn_bmap_seekhole(struct vnode * vp,u_long cmd,off_t * off,struct ucred * cred)2659 vn_bmap_seekhole(struct vnode *vp, u_long cmd, off_t *off, struct ucred *cred)
2660 {
2661 	int error;
2662 
2663 	KASSERT(cmd == FIOSEEKHOLE || cmd == FIOSEEKDATA,
2664 	    ("%s: Wrong command %lu", __func__, cmd));
2665 
2666 	if (vn_lock(vp, LK_EXCLUSIVE) != 0)
2667 		return (EBADF);
2668 	error = vn_bmap_seekhole_locked(vp, cmd, off, cred);
2669 	VOP_UNLOCK(vp);
2670 	return (error);
2671 }
2672 
2673 int
vn_seek(struct file * fp,off_t offset,int whence,struct thread * td)2674 vn_seek(struct file *fp, off_t offset, int whence, struct thread *td)
2675 {
2676 	struct ucred *cred;
2677 	struct vnode *vp;
2678 	off_t foffset, fsize, size;
2679 	int error, noneg;
2680 
2681 	cred = td->td_ucred;
2682 	vp = fp->f_vnode;
2683 	noneg = (vp->v_type != VCHR);
2684 	/*
2685 	 * Try to dodge locking for common case of querying the offset.
2686 	 */
2687 	if (whence == L_INCR && offset == 0) {
2688 		foffset = foffset_read(fp);
2689 		if (__predict_false(foffset < 0 && noneg)) {
2690 			return (EOVERFLOW);
2691 		}
2692 		td->td_uretoff.tdu_off = foffset;
2693 		return (0);
2694 	}
2695 	foffset = foffset_lock(fp, 0);
2696 	error = 0;
2697 	switch (whence) {
2698 	case L_INCR:
2699 		if (noneg &&
2700 		    (foffset < 0 ||
2701 		    (offset > 0 && foffset > OFF_MAX - offset))) {
2702 			error = EOVERFLOW;
2703 			break;
2704 		}
2705 		offset += foffset;
2706 		break;
2707 	case L_XTND:
2708 		error = vn_getsize(vp, &fsize, cred);
2709 		if (error != 0)
2710 			break;
2711 
2712 		/*
2713 		 * If the file references a disk device, then fetch
2714 		 * the media size and use that to determine the ending
2715 		 * offset.
2716 		 */
2717 		if (fsize == 0 && vp->v_type == VCHR &&
2718 		    fo_ioctl(fp, DIOCGMEDIASIZE, &size, cred, td) == 0)
2719 			fsize = size;
2720 		if (noneg && offset > 0 && fsize > OFF_MAX - offset) {
2721 			error = EOVERFLOW;
2722 			break;
2723 		}
2724 		offset += fsize;
2725 		break;
2726 	case L_SET:
2727 		break;
2728 	case SEEK_DATA:
2729 		error = fo_ioctl(fp, FIOSEEKDATA, &offset, cred, td);
2730 		if (error == ENOTTY)
2731 			error = EINVAL;
2732 		break;
2733 	case SEEK_HOLE:
2734 		error = fo_ioctl(fp, FIOSEEKHOLE, &offset, cred, td);
2735 		if (error == ENOTTY)
2736 			error = EINVAL;
2737 		break;
2738 	default:
2739 		error = EINVAL;
2740 	}
2741 	if (error == 0 && noneg && offset < 0)
2742 		error = EINVAL;
2743 	if (error != 0)
2744 		goto drop;
2745 	VFS_KNOTE_UNLOCKED(vp, 0);
2746 	td->td_uretoff.tdu_off = offset;
2747 drop:
2748 	foffset_unlock(fp, offset, error != 0 ? FOF_NOUPDATE : 0);
2749 	return (error);
2750 }
2751 
2752 int
vn_utimes_perm(struct vnode * vp,struct vattr * vap,struct ucred * cred,struct thread * td)2753 vn_utimes_perm(struct vnode *vp, struct vattr *vap, struct ucred *cred,
2754     struct thread *td)
2755 {
2756 	int error;
2757 
2758 	/*
2759 	 * Grant permission if the caller is the owner of the file, or
2760 	 * the super-user, or has ACL_WRITE_ATTRIBUTES permission on
2761 	 * on the file.  If the time pointer is null, then write
2762 	 * permission on the file is also sufficient.
2763 	 *
2764 	 * From NFSv4.1, draft 21, 6.2.1.3.1, Discussion of Mask Attributes:
2765 	 * A user having ACL_WRITE_DATA or ACL_WRITE_ATTRIBUTES
2766 	 * will be allowed to set the times [..] to the current
2767 	 * server time.
2768 	 */
2769 	error = VOP_ACCESSX(vp, VWRITE_ATTRIBUTES, cred, td);
2770 	if (error != 0 && (vap->va_vaflags & VA_UTIMES_NULL) != 0)
2771 		error = VOP_ACCESS(vp, VWRITE, cred, td);
2772 	return (error);
2773 }
2774 
2775 int
vn_fill_kinfo(struct file * fp,struct kinfo_file * kif,struct filedesc * fdp)2776 vn_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
2777 {
2778 	struct vnode *vp;
2779 	int error;
2780 
2781 	if (fp->f_type == DTYPE_FIFO)
2782 		kif->kf_type = KF_TYPE_FIFO;
2783 	else
2784 		kif->kf_type = KF_TYPE_VNODE;
2785 	vp = fp->f_vnode;
2786 	vref(vp);
2787 	FILEDESC_SUNLOCK(fdp);
2788 	error = vn_fill_kinfo_vnode(vp, kif);
2789 	vrele(vp);
2790 	FILEDESC_SLOCK(fdp);
2791 	return (error);
2792 }
2793 
2794 static inline void
vn_fill_junk(struct kinfo_file * kif)2795 vn_fill_junk(struct kinfo_file *kif)
2796 {
2797 	size_t len, olen;
2798 
2799 	/*
2800 	 * Simulate vn_fullpath returning changing values for a given
2801 	 * vp during e.g. coredump.
2802 	 */
2803 	len = (arc4random() % (sizeof(kif->kf_path) - 2)) + 1;
2804 	olen = strlen(kif->kf_path);
2805 	if (len < olen)
2806 		strcpy(&kif->kf_path[len - 1], "$");
2807 	else
2808 		for (; olen < len; olen++)
2809 			strcpy(&kif->kf_path[olen], "A");
2810 }
2811 
2812 int
vn_fill_kinfo_vnode(struct vnode * vp,struct kinfo_file * kif)2813 vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif)
2814 {
2815 	struct vattr va;
2816 	char *fullpath, *freepath;
2817 	int error;
2818 
2819 	kif->kf_un.kf_file.kf_file_type = vntype_to_kinfo(vp->v_type);
2820 	freepath = NULL;
2821 	fullpath = "-";
2822 	error = vn_fullpath(vp, &fullpath, &freepath);
2823 	if (error == 0) {
2824 		strlcpy(kif->kf_path, fullpath, sizeof(kif->kf_path));
2825 	}
2826 	if (freepath != NULL)
2827 		free(freepath, M_TEMP);
2828 
2829 	KFAIL_POINT_CODE(DEBUG_FP, fill_kinfo_vnode__random_path,
2830 		vn_fill_junk(kif);
2831 	);
2832 
2833 	/*
2834 	 * Retrieve vnode attributes.
2835 	 */
2836 	va.va_fsid = VNOVAL;
2837 	va.va_rdev = NODEV;
2838 	vn_lock(vp, LK_SHARED | LK_RETRY);
2839 	error = VOP_GETATTR(vp, &va, curthread->td_ucred);
2840 	VOP_UNLOCK(vp);
2841 	if (error != 0)
2842 		return (error);
2843 	if (va.va_fsid != VNOVAL)
2844 		kif->kf_un.kf_file.kf_file_fsid = va.va_fsid;
2845 	else
2846 		kif->kf_un.kf_file.kf_file_fsid =
2847 		    vp->v_mount->mnt_stat.f_fsid.val[0];
2848 	kif->kf_un.kf_file.kf_file_fsid_freebsd11 =
2849 	    kif->kf_un.kf_file.kf_file_fsid; /* truncate */
2850 	kif->kf_un.kf_file.kf_file_fileid = va.va_fileid;
2851 	kif->kf_un.kf_file.kf_file_mode = MAKEIMODE(va.va_type, va.va_mode);
2852 	kif->kf_un.kf_file.kf_file_size = va.va_size;
2853 	kif->kf_un.kf_file.kf_file_rdev = va.va_rdev;
2854 	kif->kf_un.kf_file.kf_file_rdev_freebsd11 =
2855 	    kif->kf_un.kf_file.kf_file_rdev; /* truncate */
2856 	kif->kf_un.kf_file.kf_file_nlink = va.va_nlink;
2857 	return (0);
2858 }
2859 
2860 int
vn_mmap(struct file * fp,vm_map_t map,vm_offset_t * addr,vm_size_t size,vm_prot_t prot,vm_prot_t cap_maxprot,int flags,vm_ooffset_t foff,struct thread * td)2861 vn_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size,
2862     vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff,
2863     struct thread *td)
2864 {
2865 #ifdef HWPMC_HOOKS
2866 	struct pmckern_map_in pkm;
2867 #endif
2868 	struct mount *mp;
2869 	struct vnode *vp;
2870 	vm_object_t object;
2871 	vm_prot_t maxprot;
2872 	boolean_t writecounted;
2873 	int error;
2874 
2875 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \
2876     defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4)
2877 	/*
2878 	 * POSIX shared-memory objects are defined to have
2879 	 * kernel persistence, and are not defined to support
2880 	 * read(2)/write(2) -- or even open(2).  Thus, we can
2881 	 * use MAP_ASYNC to trade on-disk coherence for speed.
2882 	 * The shm_open(3) library routine turns on the FPOSIXSHM
2883 	 * flag to request this behavior.
2884 	 */
2885 	if ((fp->f_flag & FPOSIXSHM) != 0)
2886 		flags |= MAP_NOSYNC;
2887 #endif
2888 	vp = fp->f_vnode;
2889 
2890 	/*
2891 	 * Ensure that file and memory protections are
2892 	 * compatible.  Note that we only worry about
2893 	 * writability if mapping is shared; in this case,
2894 	 * current and max prot are dictated by the open file.
2895 	 * XXX use the vnode instead?  Problem is: what
2896 	 * credentials do we use for determination? What if
2897 	 * proc does a setuid?
2898 	 */
2899 	mp = vp->v_mount;
2900 	if (mp != NULL && (mp->mnt_flag & MNT_NOEXEC) != 0) {
2901 		maxprot = VM_PROT_NONE;
2902 		if ((prot & VM_PROT_EXECUTE) != 0)
2903 			return (EACCES);
2904 	} else
2905 		maxprot = VM_PROT_EXECUTE;
2906 	if ((fp->f_flag & FREAD) != 0)
2907 		maxprot |= VM_PROT_READ;
2908 	else if ((prot & VM_PROT_READ) != 0)
2909 		return (EACCES);
2910 
2911 	/*
2912 	 * If we are sharing potential changes via MAP_SHARED and we
2913 	 * are trying to get write permission although we opened it
2914 	 * without asking for it, bail out.
2915 	 */
2916 	if ((flags & MAP_SHARED) != 0) {
2917 		if ((fp->f_flag & FWRITE) != 0)
2918 			maxprot |= VM_PROT_WRITE;
2919 		else if ((prot & VM_PROT_WRITE) != 0)
2920 			return (EACCES);
2921 	} else {
2922 		maxprot |= VM_PROT_WRITE;
2923 		cap_maxprot |= VM_PROT_WRITE;
2924 	}
2925 	maxprot &= cap_maxprot;
2926 
2927 	/*
2928 	 * For regular files and shared memory, POSIX requires that
2929 	 * the value of foff be a legitimate offset within the data
2930 	 * object.  In particular, negative offsets are invalid.
2931 	 * Blocking negative offsets and overflows here avoids
2932 	 * possible wraparound or user-level access into reserved
2933 	 * ranges of the data object later.  In contrast, POSIX does
2934 	 * not dictate how offsets are used by device drivers, so in
2935 	 * the case of a device mapping a negative offset is passed
2936 	 * on.
2937 	 */
2938 	if (
2939 #ifdef _LP64
2940 	    size > OFF_MAX ||
2941 #endif
2942 	    foff > OFF_MAX - size)
2943 		return (EINVAL);
2944 
2945 	writecounted = FALSE;
2946 	error = vm_mmap_vnode(td, size, prot, &maxprot, &flags, vp,
2947 	    &foff, &object, &writecounted);
2948 	if (error != 0)
2949 		return (error);
2950 	error = vm_mmap_object(map, addr, size, prot, maxprot, flags, object,
2951 	    foff, writecounted, td);
2952 	if (error != 0) {
2953 		/*
2954 		 * If this mapping was accounted for in the vnode's
2955 		 * writecount, then undo that now.
2956 		 */
2957 		if (writecounted)
2958 			vm_pager_release_writecount(object, 0, size);
2959 		vm_object_deallocate(object);
2960 	}
2961 #ifdef HWPMC_HOOKS
2962 	/* Inform hwpmc(4) if an executable is being mapped. */
2963 	if (PMC_HOOK_INSTALLED(PMC_FN_MMAP)) {
2964 		if ((prot & VM_PROT_EXECUTE) != 0 && error == 0) {
2965 			pkm.pm_file = vp;
2966 			pkm.pm_address = (uintptr_t) *addr;
2967 			PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_MMAP, (void *) &pkm);
2968 		}
2969 	}
2970 #endif
2971 	return (error);
2972 }
2973 
2974 void
vn_fsid(struct vnode * vp,struct vattr * va)2975 vn_fsid(struct vnode *vp, struct vattr *va)
2976 {
2977 	fsid_t *f;
2978 
2979 	f = &vp->v_mount->mnt_stat.f_fsid;
2980 	va->va_fsid = (uint32_t)f->val[1];
2981 	va->va_fsid <<= sizeof(f->val[1]) * NBBY;
2982 	va->va_fsid += (uint32_t)f->val[0];
2983 }
2984 
2985 int
vn_fsync_buf(struct vnode * vp,int waitfor)2986 vn_fsync_buf(struct vnode *vp, int waitfor)
2987 {
2988 	struct buf *bp, *nbp;
2989 	struct bufobj *bo;
2990 	struct mount *mp;
2991 	int error, maxretry;
2992 
2993 	error = 0;
2994 	maxretry = 10000;     /* large, arbitrarily chosen */
2995 	mp = NULL;
2996 	if (vp->v_type == VCHR) {
2997 		VI_LOCK(vp);
2998 		mp = vp->v_rdev->si_mountpt;
2999 		VI_UNLOCK(vp);
3000 	}
3001 	bo = &vp->v_bufobj;
3002 	BO_LOCK(bo);
3003 loop1:
3004 	/*
3005 	 * MARK/SCAN initialization to avoid infinite loops.
3006 	 */
3007         TAILQ_FOREACH(bp, &bo->bo_dirty.bv_hd, b_bobufs) {
3008 		bp->b_vflags &= ~BV_SCANNED;
3009 		bp->b_error = 0;
3010 	}
3011 
3012 	/*
3013 	 * Flush all dirty buffers associated with a vnode.
3014 	 */
3015 loop2:
3016 	TAILQ_FOREACH_SAFE(bp, &bo->bo_dirty.bv_hd, b_bobufs, nbp) {
3017 		if ((bp->b_vflags & BV_SCANNED) != 0)
3018 			continue;
3019 		bp->b_vflags |= BV_SCANNED;
3020 		if (BUF_LOCK(bp, LK_EXCLUSIVE | LK_NOWAIT, NULL)) {
3021 			if (waitfor != MNT_WAIT)
3022 				continue;
3023 			if (BUF_LOCK(bp,
3024 			    LK_EXCLUSIVE | LK_INTERLOCK | LK_SLEEPFAIL,
3025 			    BO_LOCKPTR(bo)) != 0) {
3026 				BO_LOCK(bo);
3027 				goto loop1;
3028 			}
3029 			BO_LOCK(bo);
3030 		}
3031 		BO_UNLOCK(bo);
3032 		KASSERT(bp->b_bufobj == bo,
3033 		    ("bp %p wrong b_bufobj %p should be %p",
3034 		    bp, bp->b_bufobj, bo));
3035 		if ((bp->b_flags & B_DELWRI) == 0)
3036 			panic("fsync: not dirty");
3037 		if ((vp->v_object != NULL) && (bp->b_flags & B_CLUSTEROK)) {
3038 			vfs_bio_awrite(bp);
3039 		} else {
3040 			bremfree(bp);
3041 			bawrite(bp);
3042 		}
3043 		if (maxretry < 1000)
3044 			pause("dirty", hz < 1000 ? 1 : hz / 1000);
3045 		BO_LOCK(bo);
3046 		goto loop2;
3047 	}
3048 
3049 	/*
3050 	 * If synchronous the caller expects us to completely resolve all
3051 	 * dirty buffers in the system.  Wait for in-progress I/O to
3052 	 * complete (which could include background bitmap writes), then
3053 	 * retry if dirty blocks still exist.
3054 	 */
3055 	if (waitfor == MNT_WAIT) {
3056 		bufobj_wwait(bo, 0, 0);
3057 		if (bo->bo_dirty.bv_cnt > 0) {
3058 			/*
3059 			 * If we are unable to write any of these buffers
3060 			 * then we fail now rather than trying endlessly
3061 			 * to write them out.
3062 			 */
3063 			TAILQ_FOREACH(bp, &bo->bo_dirty.bv_hd, b_bobufs)
3064 				if ((error = bp->b_error) != 0)
3065 					break;
3066 			if ((mp != NULL && mp->mnt_secondary_writes > 0) ||
3067 			    (error == 0 && --maxretry >= 0))
3068 				goto loop1;
3069 			if (error == 0)
3070 				error = EAGAIN;
3071 		}
3072 	}
3073 	BO_UNLOCK(bo);
3074 	if (error != 0)
3075 		vn_printf(vp, "fsync: giving up on dirty (error = %d) ", error);
3076 
3077 	return (error);
3078 }
3079 
3080 /*
3081  * Copies a byte range from invp to outvp.  Calls VOP_COPY_FILE_RANGE()
3082  * or vn_generic_copy_file_range() after rangelocking the byte ranges,
3083  * to do the actual copy.
3084  * vn_generic_copy_file_range() is factored out, so it can be called
3085  * from a VOP_COPY_FILE_RANGE() call as well, but handles vnodes from
3086  * different file systems.
3087  */
3088 int
vn_copy_file_range(struct vnode * invp,off_t * inoffp,struct vnode * outvp,off_t * outoffp,size_t * lenp,unsigned int flags,struct ucred * incred,struct ucred * outcred,struct thread * fsize_td)3089 vn_copy_file_range(struct vnode *invp, off_t *inoffp, struct vnode *outvp,
3090     off_t *outoffp, size_t *lenp, unsigned int flags, struct ucred *incred,
3091     struct ucred *outcred, struct thread *fsize_td)
3092 {
3093 	struct mount *inmp, *outmp;
3094 	struct vnode *invpl, *outvpl;
3095 	int error;
3096 	size_t len;
3097 	uint64_t uval;
3098 
3099 	invpl = outvpl = NULL;
3100 	len = *lenp;
3101 	*lenp = 0;		/* For error returns. */
3102 	error = 0;
3103 
3104 	/* Do some sanity checks on the arguments. */
3105 	if (invp->v_type == VDIR || outvp->v_type == VDIR)
3106 		error = EISDIR;
3107 	else if (*inoffp < 0 || *outoffp < 0 ||
3108 	    invp->v_type != VREG || outvp->v_type != VREG)
3109 		error = EINVAL;
3110 	if (error != 0)
3111 		goto out;
3112 
3113 	/* Ensure offset + len does not wrap around. */
3114 	uval = *inoffp;
3115 	uval += len;
3116 	if (uval > INT64_MAX)
3117 		len = INT64_MAX - *inoffp;
3118 	uval = *outoffp;
3119 	uval += len;
3120 	if (uval > INT64_MAX)
3121 		len = INT64_MAX - *outoffp;
3122 	if (len == 0)
3123 		goto out;
3124 
3125 	error = VOP_GETLOWVNODE(invp, &invpl, FREAD);
3126 	if (error != 0)
3127 		goto out;
3128 	error = VOP_GETLOWVNODE(outvp, &outvpl, FWRITE);
3129 	if (error != 0)
3130 		goto out1;
3131 
3132 	inmp = invpl->v_mount;
3133 	outmp = outvpl->v_mount;
3134 	if (inmp == NULL || outmp == NULL)
3135 		goto out2;
3136 
3137 	for (;;) {
3138 		error = vfs_busy(inmp, 0);
3139 		if (error != 0)
3140 			goto out2;
3141 		if (inmp == outmp)
3142 			break;
3143 		error = vfs_busy(outmp, MBF_NOWAIT);
3144 		if (error != 0) {
3145 			vfs_unbusy(inmp);
3146 			error = vfs_busy(outmp, 0);
3147 			if (error == 0) {
3148 				vfs_unbusy(outmp);
3149 				continue;
3150 			}
3151 			goto out2;
3152 		}
3153 		break;
3154 	}
3155 
3156 	/*
3157 	 * If the two vnodes are for the same file system type, call
3158 	 * VOP_COPY_FILE_RANGE(), otherwise call vn_generic_copy_file_range()
3159 	 * which can handle copies across multiple file system types.
3160 	 */
3161 	*lenp = len;
3162 	if (inmp == outmp || inmp->mnt_vfc == outmp->mnt_vfc)
3163 		error = VOP_COPY_FILE_RANGE(invpl, inoffp, outvpl, outoffp,
3164 		    lenp, flags, incred, outcred, fsize_td);
3165 	else
3166 		error = ENOSYS;
3167 	if (error == ENOSYS)
3168 		error = vn_generic_copy_file_range(invpl, inoffp, outvpl,
3169 		    outoffp, lenp, flags, incred, outcred, fsize_td);
3170 	vfs_unbusy(outmp);
3171 	if (inmp != outmp)
3172 		vfs_unbusy(inmp);
3173 out2:
3174 	if (outvpl != NULL)
3175 		vrele(outvpl);
3176 out1:
3177 	if (invpl != NULL)
3178 		vrele(invpl);
3179 out:
3180 	return (error);
3181 }
3182 
3183 /*
3184  * Test len bytes of data starting at dat for all bytes == 0.
3185  * Return true if all bytes are zero, false otherwise.
3186  * Expects dat to be well aligned.
3187  */
3188 static bool
mem_iszero(void * dat,int len)3189 mem_iszero(void *dat, int len)
3190 {
3191 	int i;
3192 	const u_int *p;
3193 	const char *cp;
3194 
3195 	for (p = dat; len > 0; len -= sizeof(*p), p++) {
3196 		if (len >= sizeof(*p)) {
3197 			if (*p != 0)
3198 				return (false);
3199 		} else {
3200 			cp = (const char *)p;
3201 			for (i = 0; i < len; i++, cp++)
3202 				if (*cp != '\0')
3203 					return (false);
3204 		}
3205 	}
3206 	return (true);
3207 }
3208 
3209 /*
3210  * Look for a hole in the output file and, if found, adjust *outoffp
3211  * and *xferp to skip past the hole.
3212  * *xferp is the entire hole length to be written and xfer2 is how many bytes
3213  * to be written as 0's upon return.
3214  */
3215 static off_t
vn_skip_hole(struct vnode * outvp,off_t xfer2,off_t * outoffp,off_t * xferp,off_t * dataoffp,off_t * holeoffp,struct ucred * cred)3216 vn_skip_hole(struct vnode *outvp, off_t xfer2, off_t *outoffp, off_t *xferp,
3217     off_t *dataoffp, off_t *holeoffp, struct ucred *cred)
3218 {
3219 	int error;
3220 	off_t delta;
3221 
3222 	if (*holeoffp == 0 || *holeoffp <= *outoffp) {
3223 		*dataoffp = *outoffp;
3224 		error = VOP_IOCTL(outvp, FIOSEEKDATA, dataoffp, 0, cred,
3225 		    curthread);
3226 		if (error == 0) {
3227 			*holeoffp = *dataoffp;
3228 			error = VOP_IOCTL(outvp, FIOSEEKHOLE, holeoffp, 0, cred,
3229 			    curthread);
3230 		}
3231 		if (error != 0 || *holeoffp == *dataoffp) {
3232 			/*
3233 			 * Since outvp is unlocked, it may be possible for
3234 			 * another thread to do a truncate(), lseek(), write()
3235 			 * creating a hole at startoff between the above
3236 			 * VOP_IOCTL() calls, if the other thread does not do
3237 			 * rangelocking.
3238 			 * If that happens, *holeoffp == *dataoffp and finding
3239 			 * the hole has failed, so disable vn_skip_hole().
3240 			 */
3241 			*holeoffp = -1;	/* Disable use of vn_skip_hole(). */
3242 			return (xfer2);
3243 		}
3244 		KASSERT(*dataoffp >= *outoffp,
3245 		    ("vn_skip_hole: dataoff=%jd < outoff=%jd",
3246 		    (intmax_t)*dataoffp, (intmax_t)*outoffp));
3247 		KASSERT(*holeoffp > *dataoffp,
3248 		    ("vn_skip_hole: holeoff=%jd <= dataoff=%jd",
3249 		    (intmax_t)*holeoffp, (intmax_t)*dataoffp));
3250 	}
3251 
3252 	/*
3253 	 * If there is a hole before the data starts, advance *outoffp and
3254 	 * *xferp past the hole.
3255 	 */
3256 	if (*dataoffp > *outoffp) {
3257 		delta = *dataoffp - *outoffp;
3258 		if (delta >= *xferp) {
3259 			/* Entire *xferp is a hole. */
3260 			*outoffp += *xferp;
3261 			*xferp = 0;
3262 			return (0);
3263 		}
3264 		*xferp -= delta;
3265 		*outoffp += delta;
3266 		xfer2 = MIN(xfer2, *xferp);
3267 	}
3268 
3269 	/*
3270 	 * If a hole starts before the end of this xfer2, reduce this xfer2 so
3271 	 * that the write ends at the start of the hole.
3272 	 * *holeoffp should always be greater than *outoffp, but for the
3273 	 * non-INVARIANTS case, check this to make sure xfer2 remains a sane
3274 	 * value.
3275 	 */
3276 	if (*holeoffp > *outoffp && *holeoffp < *outoffp + xfer2)
3277 		xfer2 = *holeoffp - *outoffp;
3278 	return (xfer2);
3279 }
3280 
3281 /*
3282  * Write an xfer sized chunk to outvp in blksize blocks from dat.
3283  * dat is a maximum of blksize in length and can be written repeatedly in
3284  * the chunk.
3285  * If growfile == true, just grow the file via vn_truncate_locked() instead
3286  * of doing actual writes.
3287  * If checkhole == true, a hole is being punched, so skip over any hole
3288  * already in the output file.
3289  */
3290 static int
vn_write_outvp(struct vnode * outvp,char * dat,off_t outoff,off_t xfer,u_long blksize,bool growfile,bool checkhole,struct ucred * cred)3291 vn_write_outvp(struct vnode *outvp, char *dat, off_t outoff, off_t xfer,
3292     u_long blksize, bool growfile, bool checkhole, struct ucred *cred)
3293 {
3294 	struct mount *mp;
3295 	off_t dataoff, holeoff, xfer2;
3296 	int error;
3297 
3298 	/*
3299 	 * Loop around doing writes of blksize until write has been completed.
3300 	 * Lock/unlock on each loop iteration so that a bwillwrite() can be
3301 	 * done for each iteration, since the xfer argument can be very
3302 	 * large if there is a large hole to punch in the output file.
3303 	 */
3304 	error = 0;
3305 	holeoff = 0;
3306 	do {
3307 		xfer2 = MIN(xfer, blksize);
3308 		if (checkhole) {
3309 			/*
3310 			 * Punching a hole.  Skip writing if there is
3311 			 * already a hole in the output file.
3312 			 */
3313 			xfer2 = vn_skip_hole(outvp, xfer2, &outoff, &xfer,
3314 			    &dataoff, &holeoff, cred);
3315 			if (xfer == 0)
3316 				break;
3317 			if (holeoff < 0)
3318 				checkhole = false;
3319 			KASSERT(xfer2 > 0, ("vn_write_outvp: xfer2=%jd",
3320 			    (intmax_t)xfer2));
3321 		}
3322 		bwillwrite();
3323 		mp = NULL;
3324 		error = vn_start_write(outvp, &mp, V_WAIT);
3325 		if (error != 0)
3326 			break;
3327 		if (growfile) {
3328 			error = vn_lock(outvp, LK_EXCLUSIVE);
3329 			if (error == 0) {
3330 				error = vn_truncate_locked(outvp, outoff + xfer,
3331 				    false, cred);
3332 				VOP_UNLOCK(outvp);
3333 			}
3334 		} else {
3335 			error = vn_lock(outvp, vn_lktype_write(mp, outvp));
3336 			if (error == 0) {
3337 				error = vn_rdwr(UIO_WRITE, outvp, dat, xfer2,
3338 				    outoff, UIO_SYSSPACE, IO_NODELOCKED,
3339 				    curthread->td_ucred, cred, NULL, curthread);
3340 				outoff += xfer2;
3341 				xfer -= xfer2;
3342 				VOP_UNLOCK(outvp);
3343 			}
3344 		}
3345 		if (mp != NULL)
3346 			vn_finished_write(mp);
3347 	} while (!growfile && xfer > 0 && error == 0);
3348 	return (error);
3349 }
3350 
3351 /*
3352  * Copy a byte range of one file to another.  This function can handle the
3353  * case where invp and outvp are on different file systems.
3354  * It can also be called by a VOP_COPY_FILE_RANGE() to do the work, if there
3355  * is no better file system specific way to do it.
3356  */
3357 int
vn_generic_copy_file_range(struct vnode * invp,off_t * inoffp,struct vnode * outvp,off_t * outoffp,size_t * lenp,unsigned int flags,struct ucred * incred,struct ucred * outcred,struct thread * fsize_td)3358 vn_generic_copy_file_range(struct vnode *invp, off_t *inoffp,
3359     struct vnode *outvp, off_t *outoffp, size_t *lenp, unsigned int flags,
3360     struct ucred *incred, struct ucred *outcred, struct thread *fsize_td)
3361 {
3362 	struct vattr inva;
3363 	struct mount *mp;
3364 	off_t startoff, endoff, xfer, xfer2;
3365 	u_long blksize;
3366 	int error, interrupted;
3367 	bool cantseek, readzeros, eof, first, lastblock, holetoeof, sparse;
3368 	ssize_t aresid, r = 0;
3369 	size_t copylen, len, savlen;
3370 	off_t outsize;
3371 	char *dat;
3372 	long holein, holeout;
3373 	struct timespec curts, endts;
3374 
3375 	holein = holeout = 0;
3376 	savlen = len = *lenp;
3377 	error = 0;
3378 	interrupted = 0;
3379 	dat = NULL;
3380 
3381 	error = vn_lock(invp, LK_SHARED);
3382 	if (error != 0)
3383 		goto out;
3384 	if (VOP_PATHCONF(invp, _PC_MIN_HOLE_SIZE, &holein) != 0)
3385 		holein = 0;
3386 	error = VOP_GETATTR(invp, &inva, incred);
3387 	if (error == 0 && inva.va_size > OFF_MAX)
3388 		error = EFBIG;
3389 	VOP_UNLOCK(invp);
3390 	if (error != 0)
3391 		goto out;
3392 
3393 	/*
3394 	 * Use va_bytes >= va_size as a hint that the file does not have
3395 	 * sufficient holes to justify the overhead of doing FIOSEEKHOLE.
3396 	 * This hint does not work well for file systems doing compression
3397 	 * and may fail when allocations for extended attributes increases
3398 	 * the value of va_bytes to >= va_size.
3399 	 */
3400 	sparse = true;
3401 	if (holein != 0 && inva.va_bytes >= inva.va_size) {
3402 		holein = 0;
3403 		sparse = false;
3404 	}
3405 
3406 	mp = NULL;
3407 	error = vn_start_write(outvp, &mp, V_WAIT);
3408 	if (error == 0)
3409 		error = vn_lock(outvp, LK_EXCLUSIVE);
3410 	if (error == 0) {
3411 		/*
3412 		 * If fsize_td != NULL, do a vn_rlimit_fsizex() call,
3413 		 * now that outvp is locked.
3414 		 */
3415 		if (fsize_td != NULL) {
3416 			struct uio io;
3417 
3418 			io.uio_offset = *outoffp;
3419 			io.uio_resid = len;
3420 			error = vn_rlimit_fsizex(outvp, &io, 0, &r, fsize_td);
3421 			len = savlen = io.uio_resid;
3422 			/*
3423 			 * No need to call vn_rlimit_fsizex_res before return,
3424 			 * since the uio is local.
3425 			 */
3426 		}
3427 		if (VOP_PATHCONF(outvp, _PC_MIN_HOLE_SIZE, &holeout) != 0)
3428 			holeout = 0;
3429 		/*
3430 		 * Holes that are past EOF do not need to be written as a block
3431 		 * of zero bytes.  So, truncate the output file as far as
3432 		 * possible and then use size to decide if writing 0
3433 		 * bytes is necessary in the loop below.
3434 		 */
3435 		if (error == 0)
3436 			error = vn_getsize_locked(outvp, &outsize, outcred);
3437 		if (error == 0 && outsize > *outoffp &&
3438 		    *outoffp <= OFF_MAX - len && outsize <= *outoffp + len &&
3439 		    *inoffp < inva.va_size &&
3440 		    *outoffp <= OFF_MAX - (inva.va_size - *inoffp) &&
3441 		    outsize <= *outoffp + (inva.va_size - *inoffp)) {
3442 #ifdef MAC
3443 			error = mac_vnode_check_write(curthread->td_ucred,
3444 			    outcred, outvp);
3445 			if (error == 0)
3446 #endif
3447 				error = vn_truncate_locked(outvp, *outoffp,
3448 				    false, outcred);
3449 			if (error == 0)
3450 				outsize = *outoffp;
3451 		}
3452 		VOP_UNLOCK(outvp);
3453 	}
3454 	if (mp != NULL)
3455 		vn_finished_write(mp);
3456 	if (error != 0)
3457 		goto out;
3458 
3459 	if (sparse && holein == 0 && holeout > 0) {
3460 		/*
3461 		 * For this special case, the input data will be scanned
3462 		 * for blocks of all 0 bytes.  For these blocks, the
3463 		 * write can be skipped for the output file to create
3464 		 * an unallocated region.
3465 		 * Therefore, use the appropriate size for the output file.
3466 		 */
3467 		blksize = holeout;
3468 		if (blksize <= 512) {
3469 			/*
3470 			 * Use f_iosize, since ZFS reports a _PC_MIN_HOLE_SIZE
3471 			 * of 512, although it actually only creates
3472 			 * unallocated regions for blocks >= f_iosize.
3473 			 */
3474 			blksize = outvp->v_mount->mnt_stat.f_iosize;
3475 		}
3476 	} else {
3477 		/*
3478 		 * Use the larger of the two f_iosize values.  If they are
3479 		 * not the same size, one will normally be an exact multiple of
3480 		 * the other, since they are both likely to be a power of 2.
3481 		 */
3482 		blksize = MAX(invp->v_mount->mnt_stat.f_iosize,
3483 		    outvp->v_mount->mnt_stat.f_iosize);
3484 	}
3485 
3486 	/* Clip to sane limits. */
3487 	if (blksize < 4096)
3488 		blksize = 4096;
3489 	else if (blksize > maxphys)
3490 		blksize = maxphys;
3491 	dat = malloc(blksize, M_TEMP, M_WAITOK);
3492 
3493 	/*
3494 	 * If VOP_IOCTL(FIOSEEKHOLE) works for invp, use it and FIOSEEKDATA
3495 	 * to find holes.  Otherwise, just scan the read block for all 0s
3496 	 * in the inner loop where the data copying is done.
3497 	 * Note that some file systems such as NFSv3, NFSv4.0 and NFSv4.1 may
3498 	 * support holes on the server, but do not support FIOSEEKHOLE.
3499 	 * The kernel flag COPY_FILE_RANGE_TIMEO1SEC is used to indicate
3500 	 * that this function should return after 1second with a partial
3501 	 * completion.
3502 	 */
3503 	if ((flags & COPY_FILE_RANGE_TIMEO1SEC) != 0) {
3504 		getnanouptime(&endts);
3505 		endts.tv_sec++;
3506 	} else
3507 		timespecclear(&endts);
3508 	first = true;
3509 	holetoeof = eof = false;
3510 	while (len > 0 && error == 0 && !eof && interrupted == 0) {
3511 		endoff = 0;			/* To shut up compilers. */
3512 		cantseek = true;
3513 		startoff = *inoffp;
3514 		copylen = len;
3515 
3516 		/*
3517 		 * Find the next data area.  If there is just a hole to EOF,
3518 		 * FIOSEEKDATA should fail with ENXIO.
3519 		 * (I do not know if any file system will report a hole to
3520 		 *  EOF via FIOSEEKHOLE, but I am pretty sure FIOSEEKDATA
3521 		 *  will fail for those file systems.)
3522 		 *
3523 		 * For input files that don't support FIOSEEKDATA/FIOSEEKHOLE,
3524 		 * the code just falls through to the inner copy loop.
3525 		 */
3526 		error = EINVAL;
3527 		if (holein > 0) {
3528 			error = VOP_IOCTL(invp, FIOSEEKDATA, &startoff, 0,
3529 			    incred, curthread);
3530 			if (error == ENXIO) {
3531 				startoff = endoff = inva.va_size;
3532 				eof = holetoeof = true;
3533 				error = 0;
3534 			}
3535 		}
3536 		if (error == 0 && !holetoeof) {
3537 			endoff = startoff;
3538 			error = VOP_IOCTL(invp, FIOSEEKHOLE, &endoff, 0,
3539 			    incred, curthread);
3540 			/*
3541 			 * Since invp is unlocked, it may be possible for
3542 			 * another thread to do a truncate(), lseek(), write()
3543 			 * creating a hole at startoff between the above
3544 			 * VOP_IOCTL() calls, if the other thread does not do
3545 			 * rangelocking.
3546 			 * If that happens, startoff == endoff and finding
3547 			 * the hole has failed, so set an error.
3548 			 */
3549 			if (error == 0 && startoff == endoff)
3550 				error = EINVAL; /* Any error. Reset to 0. */
3551 		}
3552 		if (error == 0) {
3553 			if (startoff > *inoffp) {
3554 				/* Found hole before data block. */
3555 				xfer = MIN(startoff - *inoffp, len);
3556 				if (*outoffp < outsize) {
3557 					/* Must write 0s to punch hole. */
3558 					xfer2 = MIN(outsize - *outoffp,
3559 					    xfer);
3560 					memset(dat, 0, MIN(xfer2, blksize));
3561 					error = vn_write_outvp(outvp, dat,
3562 					    *outoffp, xfer2, blksize, false,
3563 					    holeout > 0, outcred);
3564 				}
3565 
3566 				if (error == 0 && *outoffp + xfer >
3567 				    outsize && (xfer == len || holetoeof)) {
3568 					/* Grow output file (hole at end). */
3569 					error = vn_write_outvp(outvp, dat,
3570 					    *outoffp, xfer, blksize, true,
3571 					    false, outcred);
3572 				}
3573 				if (error == 0) {
3574 					*inoffp += xfer;
3575 					*outoffp += xfer;
3576 					len -= xfer;
3577 					if (len < savlen) {
3578 						interrupted = sig_intr();
3579 						if (timespecisset(&endts) &&
3580 						    interrupted == 0) {
3581 							getnanouptime(&curts);
3582 							if (timespeccmp(&curts,
3583 							    &endts, >=))
3584 								interrupted =
3585 								    EINTR;
3586 						}
3587 					}
3588 				}
3589 			}
3590 			copylen = MIN(len, endoff - startoff);
3591 			cantseek = false;
3592 		} else {
3593 			cantseek = true;
3594 			if (!sparse)
3595 				cantseek = false;
3596 			startoff = *inoffp;
3597 			copylen = len;
3598 			error = 0;
3599 		}
3600 
3601 		xfer = blksize;
3602 		if (cantseek) {
3603 			/*
3604 			 * Set first xfer to end at a block boundary, so that
3605 			 * holes are more likely detected in the loop below via
3606 			 * the for all bytes 0 method.
3607 			 */
3608 			xfer -= (*inoffp % blksize);
3609 		}
3610 
3611 		/*
3612 		 * Loop copying the data block.  If this was our first attempt
3613 		 * to copy anything, allow a zero-length block so that the VOPs
3614 		 * get a chance to update metadata, specifically the atime.
3615 		 */
3616 		while (error == 0 && ((copylen > 0 && !eof) || first) &&
3617 		    interrupted == 0) {
3618 			if (copylen < xfer)
3619 				xfer = copylen;
3620 			first = false;
3621 			error = vn_lock(invp, LK_SHARED);
3622 			if (error != 0)
3623 				goto out;
3624 			error = vn_rdwr(UIO_READ, invp, dat, xfer,
3625 			    startoff, UIO_SYSSPACE, IO_NODELOCKED,
3626 			    curthread->td_ucred, incred, &aresid,
3627 			    curthread);
3628 			VOP_UNLOCK(invp);
3629 			lastblock = false;
3630 			if (error == 0 && (xfer == 0 || aresid > 0)) {
3631 				/* Stop the copy at EOF on the input file. */
3632 				xfer -= aresid;
3633 				eof = true;
3634 				lastblock = true;
3635 			}
3636 			if (error == 0) {
3637 				/*
3638 				 * Skip the write for holes past the initial EOF
3639 				 * of the output file, unless this is the last
3640 				 * write of the output file at EOF.
3641 				 */
3642 				readzeros = cantseek ? mem_iszero(dat, xfer) :
3643 				    false;
3644 				if (xfer == len)
3645 					lastblock = true;
3646 				if (!cantseek || *outoffp < outsize ||
3647 				    lastblock || !readzeros)
3648 					error = vn_write_outvp(outvp, dat,
3649 					    *outoffp, xfer, blksize,
3650 					    readzeros && lastblock &&
3651 					    *outoffp >= outsize, false,
3652 					    outcred);
3653 				if (error == 0) {
3654 					*inoffp += xfer;
3655 					startoff += xfer;
3656 					*outoffp += xfer;
3657 					copylen -= xfer;
3658 					len -= xfer;
3659 					if (len < savlen) {
3660 						interrupted = sig_intr();
3661 						if (timespecisset(&endts) &&
3662 						    interrupted == 0) {
3663 							getnanouptime(&curts);
3664 							if (timespeccmp(&curts,
3665 							    &endts, >=))
3666 								interrupted =
3667 								    EINTR;
3668 						}
3669 					}
3670 				}
3671 			}
3672 			xfer = blksize;
3673 		}
3674 	}
3675 out:
3676 	*lenp = savlen - len;
3677 	free(dat, M_TEMP);
3678 	return (error);
3679 }
3680 
3681 static int
vn_fallocate(struct file * fp,off_t offset,off_t len,struct thread * td)3682 vn_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td)
3683 {
3684 	struct mount *mp;
3685 	struct vnode *vp;
3686 	off_t olen, ooffset;
3687 	int error;
3688 #ifdef AUDIT
3689 	int audited_vnode1 = 0;
3690 #endif
3691 
3692 	vp = fp->f_vnode;
3693 	if (vp->v_type != VREG)
3694 		return (ENODEV);
3695 
3696 	/* Allocating blocks may take a long time, so iterate. */
3697 	for (;;) {
3698 		olen = len;
3699 		ooffset = offset;
3700 
3701 		bwillwrite();
3702 		mp = NULL;
3703 		error = vn_start_write(vp, &mp, V_WAIT | V_PCATCH);
3704 		if (error != 0)
3705 			break;
3706 		error = vn_lock(vp, LK_EXCLUSIVE);
3707 		if (error != 0) {
3708 			vn_finished_write(mp);
3709 			break;
3710 		}
3711 #ifdef AUDIT
3712 		if (!audited_vnode1) {
3713 			AUDIT_ARG_VNODE1(vp);
3714 			audited_vnode1 = 1;
3715 		}
3716 #endif
3717 #ifdef MAC
3718 		error = mac_vnode_check_write(td->td_ucred, fp->f_cred, vp);
3719 		if (error == 0)
3720 #endif
3721 			error = VOP_ALLOCATE(vp, &offset, &len, 0,
3722 			    td->td_ucred);
3723 		VOP_UNLOCK(vp);
3724 		vn_finished_write(mp);
3725 
3726 		if (olen + ooffset != offset + len) {
3727 			panic("offset + len changed from %jx/%jx to %jx/%jx",
3728 			    ooffset, olen, offset, len);
3729 		}
3730 		if (error != 0 || len == 0)
3731 			break;
3732 		KASSERT(olen > len, ("Iteration did not make progress?"));
3733 		maybe_yield();
3734 	}
3735 
3736 	return (error);
3737 }
3738 
3739 static int
vn_deallocate_impl(struct vnode * vp,off_t * offset,off_t * length,int flags,int ioflag,struct ucred * cred,struct ucred * active_cred,struct ucred * file_cred)3740 vn_deallocate_impl(struct vnode *vp, off_t *offset, off_t *length, int flags,
3741     int ioflag, struct ucred *cred, struct ucred *active_cred,
3742     struct ucred *file_cred)
3743 {
3744 	struct mount *mp;
3745 	void *rl_cookie;
3746 	off_t off, len;
3747 	int error;
3748 #ifdef AUDIT
3749 	bool audited_vnode1 = false;
3750 #endif
3751 
3752 	rl_cookie = NULL;
3753 	error = 0;
3754 	mp = NULL;
3755 	off = *offset;
3756 	len = *length;
3757 
3758 	if ((ioflag & (IO_NODELOCKED | IO_RANGELOCKED)) == 0)
3759 		rl_cookie = vn_rangelock_wlock(vp, off, off + len);
3760 	while (len > 0 && error == 0) {
3761 		/*
3762 		 * Try to deallocate the longest range in one pass.
3763 		 * In case a pass takes too long to be executed, it returns
3764 		 * partial result. The residue will be proceeded in the next
3765 		 * pass.
3766 		 */
3767 
3768 		if ((ioflag & IO_NODELOCKED) == 0) {
3769 			bwillwrite();
3770 			if ((error = vn_start_write(vp, &mp,
3771 			    V_WAIT | V_PCATCH)) != 0)
3772 				goto out;
3773 			vn_lock(vp, vn_lktype_write(mp, vp) | LK_RETRY);
3774 		}
3775 #ifdef AUDIT
3776 		if (!audited_vnode1) {
3777 			AUDIT_ARG_VNODE1(vp);
3778 			audited_vnode1 = true;
3779 		}
3780 #endif
3781 
3782 #ifdef MAC
3783 		if ((ioflag & IO_NOMACCHECK) == 0)
3784 			error = mac_vnode_check_write(active_cred, file_cred,
3785 			    vp);
3786 #endif
3787 		if (error == 0)
3788 			error = VOP_DEALLOCATE(vp, &off, &len, flags, ioflag,
3789 			    cred);
3790 
3791 		if ((ioflag & IO_NODELOCKED) == 0) {
3792 			VOP_UNLOCK(vp);
3793 			if (mp != NULL) {
3794 				vn_finished_write(mp);
3795 				mp = NULL;
3796 			}
3797 		}
3798 		if (error == 0 && len != 0)
3799 			maybe_yield();
3800 	}
3801 out:
3802 	if (rl_cookie != NULL)
3803 		vn_rangelock_unlock(vp, rl_cookie);
3804 	*offset = off;
3805 	*length = len;
3806 	return (error);
3807 }
3808 
3809 /*
3810  * This function is supposed to be used in the situations where the deallocation
3811  * is not triggered by a user request.
3812  */
3813 int
vn_deallocate(struct vnode * vp,off_t * offset,off_t * length,int flags,int ioflag,struct ucred * active_cred,struct ucred * file_cred)3814 vn_deallocate(struct vnode *vp, off_t *offset, off_t *length, int flags,
3815     int ioflag, struct ucred *active_cred, struct ucred *file_cred)
3816 {
3817 	struct ucred *cred;
3818 
3819 	if (*offset < 0 || *length <= 0 || *length > OFF_MAX - *offset ||
3820 	    flags != 0)
3821 		return (EINVAL);
3822 	if (vp->v_type != VREG)
3823 		return (ENODEV);
3824 
3825 	cred = file_cred != NOCRED ? file_cred : active_cred;
3826 	return (vn_deallocate_impl(vp, offset, length, flags, ioflag, cred,
3827 	    active_cred, file_cred));
3828 }
3829 
3830 static int
vn_fspacectl(struct file * fp,int cmd,off_t * offset,off_t * length,int flags,struct ucred * active_cred,struct thread * td)3831 vn_fspacectl(struct file *fp, int cmd, off_t *offset, off_t *length, int flags,
3832     struct ucred *active_cred, struct thread *td)
3833 {
3834 	int error;
3835 	struct vnode *vp;
3836 	int ioflag;
3837 
3838 	KASSERT(cmd == SPACECTL_DEALLOC, ("vn_fspacectl: Invalid cmd"));
3839 	KASSERT((flags & ~SPACECTL_F_SUPPORTED) == 0,
3840 	    ("vn_fspacectl: non-zero flags"));
3841 	KASSERT(*offset >= 0 && *length > 0 && *length <= OFF_MAX - *offset,
3842 	    ("vn_fspacectl: offset/length overflow or underflow"));
3843 	vp = fp->f_vnode;
3844 
3845 	if (vp->v_type != VREG)
3846 		return (ENODEV);
3847 
3848 	ioflag = get_write_ioflag(fp);
3849 
3850 	switch (cmd) {
3851 	case SPACECTL_DEALLOC:
3852 		error = vn_deallocate_impl(vp, offset, length, flags, ioflag,
3853 		    active_cred, active_cred, fp->f_cred);
3854 		break;
3855 	default:
3856 		panic("vn_fspacectl: unknown cmd %d", cmd);
3857 	}
3858 
3859 	return (error);
3860 }
3861 
3862 /*
3863  * Keep this assert as long as sizeof(struct dirent) is used as the maximum
3864  * entry size.
3865  */
3866 _Static_assert(_GENERIC_MAXDIRSIZ == sizeof(struct dirent),
3867     "'struct dirent' size must be a multiple of its alignment "
3868     "(see _GENERIC_DIRLEN())");
3869 
3870 /*
3871  * Returns successive directory entries through some caller's provided buffer.
3872  *
3873  * This function automatically refills the provided buffer with calls to
3874  * VOP_READDIR() (after MAC permission checks).
3875  *
3876  * 'td' is used for credentials and passed to uiomove().  'dirbuf' is the
3877  * caller's buffer to fill and 'dirbuflen' its allocated size.  'dirbuf' must
3878  * be properly aligned to access 'struct dirent' structures and 'dirbuflen'
3879  * must be greater than GENERIC_MAXDIRSIZ to avoid VOP_READDIR() returning
3880  * EINVAL (the latter is not a strong guarantee (yet); but EINVAL will always
3881  * be returned if this requirement is not verified).  '*dpp' points to the
3882  * current directory entry in the buffer and '*len' contains the remaining
3883  * valid bytes in 'dirbuf' after 'dpp' (including the pointed entry).
3884  *
3885  * At first call (or when restarting the read), '*len' must have been set to 0,
3886  * '*off' to 0 (or any valid start offset) and '*eofflag' to 0.  There are no
3887  * more entries as soon as '*len' is 0 after a call that returned 0.  Calling
3888  * again this function after such a condition is considered an error and EINVAL
3889  * will be returned.  Other possible error codes are those of VOP_READDIR(),
3890  * EINTEGRITY if the returned entries do not pass coherency tests, or EINVAL
3891  * (bad call).  All errors are unrecoverable, i.e., the state ('*len', '*off'
3892  * and '*eofflag') must be re-initialized before a subsequent call.  On error
3893  * or at end of directory, '*dpp' is reset to NULL.
3894  *
3895  * '*len', '*off' and '*eofflag' are internal state the caller should not
3896  * tamper with except as explained above.  '*off' is the next directory offset
3897  * to read from to refill the buffer.  '*eofflag' is set to 0 or 1 by the last
3898  * internal call to VOP_READDIR() that returned without error, indicating
3899  * whether it reached the end of the directory, and to 2 by this function after
3900  * all entries have been read.
3901  */
3902 int
vn_dir_next_dirent(struct vnode * vp,struct thread * td,char * dirbuf,size_t dirbuflen,struct dirent ** dpp,size_t * len,off_t * off,int * eofflag)3903 vn_dir_next_dirent(struct vnode *vp, struct thread *td,
3904     char *dirbuf, size_t dirbuflen,
3905     struct dirent **dpp, size_t *len, off_t *off, int *eofflag)
3906 {
3907 	struct dirent *dp = NULL;
3908 	int reclen;
3909 	int error;
3910 	struct uio uio;
3911 	struct iovec iov;
3912 
3913 	ASSERT_VOP_LOCKED(vp, "vnode not locked");
3914 	VNASSERT(vp->v_type == VDIR, vp, ("vnode is not a directory"));
3915 	MPASS2((uintptr_t)dirbuf < (uintptr_t)dirbuf + dirbuflen,
3916 	    "Address space overflow");
3917 
3918 	if (__predict_false(dirbuflen < GENERIC_MAXDIRSIZ)) {
3919 		/* Don't take any chances in this case */
3920 		error = EINVAL;
3921 		goto out;
3922 	}
3923 
3924 	if (*len != 0) {
3925 		dp = *dpp;
3926 
3927 		/*
3928 		 * The caller continued to call us after an error (we set dp to
3929 		 * NULL in a previous iteration).  Bail out right now.
3930 		 */
3931 		if (__predict_false(dp == NULL))
3932 			return (EINVAL);
3933 
3934 		MPASS(*len <= dirbuflen);
3935 		MPASS2((uintptr_t)dirbuf <= (uintptr_t)dp &&
3936 		    (uintptr_t)dp + *len <= (uintptr_t)dirbuf + dirbuflen,
3937 		    "Filled range not inside buffer");
3938 
3939 		reclen = dp->d_reclen;
3940 		if (reclen >= *len) {
3941 			/* End of buffer reached */
3942 			*len = 0;
3943 		} else {
3944 			dp = (struct dirent *)((char *)dp + reclen);
3945 			*len -= reclen;
3946 		}
3947 	}
3948 
3949 	if (*len == 0) {
3950 		dp = NULL;
3951 
3952 		/* Have to refill. */
3953 		switch (*eofflag) {
3954 		case 0:
3955 			break;
3956 
3957 		case 1:
3958 			/* Nothing more to read. */
3959 			*eofflag = 2; /* Remember the caller reached EOF. */
3960 			goto success;
3961 
3962 		default:
3963 			/* The caller didn't test for EOF. */
3964 			error = EINVAL;
3965 			goto out;
3966 		}
3967 
3968 		iov.iov_base = dirbuf;
3969 		iov.iov_len = dirbuflen;
3970 
3971 		uio.uio_iov = &iov;
3972 		uio.uio_iovcnt = 1;
3973 		uio.uio_offset = *off;
3974 		uio.uio_resid = dirbuflen;
3975 		uio.uio_segflg = UIO_SYSSPACE;
3976 		uio.uio_rw = UIO_READ;
3977 		uio.uio_td = td;
3978 
3979 #ifdef MAC
3980 		error = mac_vnode_check_readdir(td->td_ucred, vp);
3981 		if (error == 0)
3982 #endif
3983 			error = VOP_READDIR(vp, &uio, td->td_ucred, eofflag,
3984 			    NULL, NULL);
3985 		if (error != 0)
3986 			goto out;
3987 
3988 		*len = dirbuflen - uio.uio_resid;
3989 		*off = uio.uio_offset;
3990 
3991 		if (*len == 0) {
3992 			/* Sanity check on INVARIANTS. */
3993 			MPASS(*eofflag != 0);
3994 			*eofflag = 1;
3995 			goto success;
3996 		}
3997 
3998 		/*
3999 		 * Normalize the flag returned by VOP_READDIR(), since we use 2
4000 		 * as a sentinel value.
4001 		 */
4002 		if (*eofflag != 0)
4003 			*eofflag = 1;
4004 
4005 		dp = (struct dirent *)dirbuf;
4006 	}
4007 
4008 	if (__predict_false(*len < GENERIC_MINDIRSIZ ||
4009 	    dp->d_reclen < GENERIC_MINDIRSIZ)) {
4010 		error = EINTEGRITY;
4011 		dp = NULL;
4012 		goto out;
4013 	}
4014 
4015 success:
4016 	error = 0;
4017 out:
4018 	*dpp = dp;
4019 	return (error);
4020 }
4021 
4022 /*
4023  * Checks whether a directory is empty or not.
4024  *
4025  * If the directory is empty, returns 0, and if it is not, ENOTEMPTY.  Other
4026  * values are genuine errors preventing the check.
4027  */
4028 int
vn_dir_check_empty(struct vnode * vp)4029 vn_dir_check_empty(struct vnode *vp)
4030 {
4031 	struct thread *const td = curthread;
4032 	char *dirbuf;
4033 	size_t dirbuflen, len;
4034 	off_t off;
4035 	int eofflag, error;
4036 	struct dirent *dp;
4037 	struct vattr va;
4038 
4039 	ASSERT_VOP_LOCKED(vp, "vfs_emptydir");
4040 	VNPASS(vp->v_type == VDIR, vp);
4041 
4042 	error = VOP_GETATTR(vp, &va, td->td_ucred);
4043 	if (error != 0)
4044 		return (error);
4045 
4046 	dirbuflen = max(DEV_BSIZE, GENERIC_MAXDIRSIZ);
4047 	if (dirbuflen < va.va_blocksize)
4048 		dirbuflen = va.va_blocksize;
4049 	dirbuf = malloc(dirbuflen, M_TEMP, M_WAITOK);
4050 
4051 	len = 0;
4052 	off = 0;
4053 	eofflag = 0;
4054 
4055 	for (;;) {
4056 		error = vn_dir_next_dirent(vp, td, dirbuf, dirbuflen,
4057 		    &dp, &len, &off, &eofflag);
4058 		if (error != 0)
4059 			goto end;
4060 
4061 		if (len == 0) {
4062 			/* EOF */
4063 			error = 0;
4064 			goto end;
4065 		}
4066 
4067 		/*
4068 		 * Skip whiteouts.  Unionfs operates on filesystems only and
4069 		 * not on hierarchies, so these whiteouts would be shadowed on
4070 		 * the system hierarchy but not for a union using the
4071 		 * filesystem of their directories as the upper layer.
4072 		 * Additionally, unionfs currently transparently exposes
4073 		 * union-specific metadata of its upper layer, meaning that
4074 		 * whiteouts can be seen through the union view in empty
4075 		 * directories.  Taking into account these whiteouts would then
4076 		 * prevent mounting another filesystem on such effectively
4077 		 * empty directories.
4078 		 */
4079 		if (dp->d_type == DT_WHT)
4080 			continue;
4081 
4082 		/*
4083 		 * Any file in the directory which is not '.' or '..' indicates
4084 		 * the directory is not empty.
4085 		 */
4086 		switch (dp->d_namlen) {
4087 		case 2:
4088 			if (dp->d_name[1] != '.') {
4089 				/* Can't be '..' (nor '.') */
4090 				error = ENOTEMPTY;
4091 				goto end;
4092 			}
4093 			/* FALLTHROUGH */
4094 		case 1:
4095 			if (dp->d_name[0] != '.') {
4096 				/* Can't be '..' nor '.' */
4097 				error = ENOTEMPTY;
4098 				goto end;
4099 			}
4100 			break;
4101 
4102 		default:
4103 			error = ENOTEMPTY;
4104 			goto end;
4105 		}
4106 	}
4107 
4108 end:
4109 	free(dirbuf, M_TEMP);
4110 	return (error);
4111 }
4112 
4113 
4114 static u_long vn_lock_pair_pause_cnt;
4115 SYSCTL_ULONG(_debug, OID_AUTO, vn_lock_pair_pause, CTLFLAG_RD,
4116     &vn_lock_pair_pause_cnt, 0,
4117     "Count of vn_lock_pair deadlocks");
4118 
4119 u_int vn_lock_pair_pause_max;
4120 SYSCTL_UINT(_debug, OID_AUTO, vn_lock_pair_pause_max, CTLFLAG_RW,
4121     &vn_lock_pair_pause_max, 0,
4122     "Max ticks for vn_lock_pair deadlock avoidance sleep");
4123 
4124 static void
vn_lock_pair_pause(const char * wmesg)4125 vn_lock_pair_pause(const char *wmesg)
4126 {
4127 	atomic_add_long(&vn_lock_pair_pause_cnt, 1);
4128 	pause(wmesg, prng32_bounded(vn_lock_pair_pause_max));
4129 }
4130 
4131 /*
4132  * Lock pair of (possibly same) vnodes vp1, vp2, avoiding lock order
4133  * reversal.  vp1_locked indicates whether vp1 is locked; if not, vp1
4134  * must be unlocked.  Same for vp2 and vp2_locked.  One of the vnodes
4135  * can be NULL.
4136  *
4137  * The function returns with both vnodes exclusively or shared locked,
4138  * according to corresponding lkflags, and guarantees that it does not
4139  * create lock order reversal with other threads during its execution.
4140  * Both vnodes could be unlocked temporary (and reclaimed).
4141  *
4142  * If requesting shared locking, locked vnode lock must not be recursed.
4143  *
4144  * Only one of LK_SHARED and LK_EXCLUSIVE must be specified.
4145  * LK_NODDLKTREAT can be optionally passed.
4146  *
4147  * If vp1 == vp2, only one, most exclusive, lock is obtained on it.
4148  */
4149 void
vn_lock_pair(struct vnode * vp1,bool vp1_locked,int lkflags1,struct vnode * vp2,bool vp2_locked,int lkflags2)4150 vn_lock_pair(struct vnode *vp1, bool vp1_locked, int lkflags1,
4151     struct vnode *vp2, bool vp2_locked, int lkflags2)
4152 {
4153 	int error, locked1;
4154 
4155 	MPASS((((lkflags1 & LK_SHARED) != 0) ^ ((lkflags1 & LK_EXCLUSIVE) != 0)) ||
4156 	    (vp1 == NULL && lkflags1 == 0));
4157 	MPASS((lkflags1 & ~(LK_SHARED | LK_EXCLUSIVE | LK_NODDLKTREAT)) == 0);
4158 	MPASS((((lkflags2 & LK_SHARED) != 0) ^ ((lkflags2 & LK_EXCLUSIVE) != 0)) ||
4159 	    (vp2 == NULL && lkflags2 == 0));
4160 	MPASS((lkflags2 & ~(LK_SHARED | LK_EXCLUSIVE | LK_NODDLKTREAT)) == 0);
4161 
4162 	if (vp1 == NULL && vp2 == NULL)
4163 		return;
4164 
4165 	if (vp1 == vp2) {
4166 		MPASS(vp1_locked == vp2_locked);
4167 
4168 		/* Select the most exclusive mode for lock. */
4169 		if ((lkflags1 & LK_TYPE_MASK) != (lkflags2 & LK_TYPE_MASK))
4170 			lkflags1 = (lkflags1 & ~LK_SHARED) | LK_EXCLUSIVE;
4171 
4172 		if (vp1_locked) {
4173 			ASSERT_VOP_LOCKED(vp1, "vp1");
4174 
4175 			/* No need to relock if any lock is exclusive. */
4176 			if ((vp1->v_vnlock->lock_object.lo_flags &
4177 			    LK_NOSHARE) != 0)
4178 				return;
4179 
4180 			locked1 = VOP_ISLOCKED(vp1);
4181 			if (((lkflags1 & LK_SHARED) != 0 &&
4182 			    locked1 != LK_EXCLUSIVE) ||
4183 			    ((lkflags1 & LK_EXCLUSIVE) != 0 &&
4184 			    locked1 == LK_EXCLUSIVE))
4185 				return;
4186 			VOP_UNLOCK(vp1);
4187 		}
4188 
4189 		ASSERT_VOP_UNLOCKED(vp1, "vp1");
4190 		vn_lock(vp1, lkflags1 | LK_RETRY);
4191 		return;
4192 	}
4193 
4194 	if (vp1 != NULL) {
4195 		if ((lkflags1 & LK_SHARED) != 0 &&
4196 		    (vp1->v_vnlock->lock_object.lo_flags & LK_NOSHARE) != 0)
4197 			lkflags1 = (lkflags1 & ~LK_SHARED) | LK_EXCLUSIVE;
4198 		if (vp1_locked && VOP_ISLOCKED(vp1) != LK_EXCLUSIVE) {
4199 			ASSERT_VOP_LOCKED(vp1, "vp1");
4200 			if ((lkflags1 & LK_EXCLUSIVE) != 0) {
4201 				VOP_UNLOCK(vp1);
4202 				ASSERT_VOP_UNLOCKED(vp1,
4203 				    "vp1 shared recursed");
4204 				vp1_locked = false;
4205 			}
4206 		} else if (!vp1_locked)
4207 			ASSERT_VOP_UNLOCKED(vp1, "vp1");
4208 	} else {
4209 		vp1_locked = true;
4210 	}
4211 
4212 	if (vp2 != NULL) {
4213 		if ((lkflags2 & LK_SHARED) != 0 &&
4214 		    (vp2->v_vnlock->lock_object.lo_flags & LK_NOSHARE) != 0)
4215 			lkflags2 = (lkflags2 & ~LK_SHARED) | LK_EXCLUSIVE;
4216 		if (vp2_locked && VOP_ISLOCKED(vp2) != LK_EXCLUSIVE) {
4217 			ASSERT_VOP_LOCKED(vp2, "vp2");
4218 			if ((lkflags2 & LK_EXCLUSIVE) != 0) {
4219 				VOP_UNLOCK(vp2);
4220 				ASSERT_VOP_UNLOCKED(vp2,
4221 				    "vp2 shared recursed");
4222 				vp2_locked = false;
4223 			}
4224 		} else if (!vp2_locked)
4225 			ASSERT_VOP_UNLOCKED(vp2, "vp2");
4226 	} else {
4227 		vp2_locked = true;
4228 	}
4229 
4230 	if (!vp1_locked && !vp2_locked) {
4231 		vn_lock(vp1, lkflags1 | LK_RETRY);
4232 		vp1_locked = true;
4233 	}
4234 
4235 	while (!vp1_locked || !vp2_locked) {
4236 		if (vp1_locked && vp2 != NULL) {
4237 			if (vp1 != NULL) {
4238 				error = VOP_LOCK1(vp2, lkflags2 | LK_NOWAIT,
4239 				    __FILE__, __LINE__);
4240 				if (error == 0)
4241 					break;
4242 				VOP_UNLOCK(vp1);
4243 				vp1_locked = false;
4244 				vn_lock_pair_pause("vlp1");
4245 			}
4246 			vn_lock(vp2, lkflags2 | LK_RETRY);
4247 			vp2_locked = true;
4248 		}
4249 		if (vp2_locked && vp1 != NULL) {
4250 			if (vp2 != NULL) {
4251 				error = VOP_LOCK1(vp1, lkflags1 | LK_NOWAIT,
4252 				    __FILE__, __LINE__);
4253 				if (error == 0)
4254 					break;
4255 				VOP_UNLOCK(vp2);
4256 				vp2_locked = false;
4257 				vn_lock_pair_pause("vlp2");
4258 			}
4259 			vn_lock(vp1, lkflags1 | LK_RETRY);
4260 			vp1_locked = true;
4261 		}
4262 	}
4263 	if (vp1 != NULL) {
4264 		if (lkflags1 == LK_EXCLUSIVE)
4265 			ASSERT_VOP_ELOCKED(vp1, "vp1 ret");
4266 		else
4267 			ASSERT_VOP_LOCKED(vp1, "vp1 ret");
4268 	}
4269 	if (vp2 != NULL) {
4270 		if (lkflags2 == LK_EXCLUSIVE)
4271 			ASSERT_VOP_ELOCKED(vp2, "vp2 ret");
4272 		else
4273 			ASSERT_VOP_LOCKED(vp2, "vp2 ret");
4274 	}
4275 }
4276 
4277 int
vn_lktype_write(struct mount * mp,struct vnode * vp)4278 vn_lktype_write(struct mount *mp, struct vnode *vp)
4279 {
4280 	if (MNT_SHARED_WRITES(mp) ||
4281 	    (mp == NULL && MNT_SHARED_WRITES(vp->v_mount)))
4282 		return (LK_SHARED);
4283 	return (LK_EXCLUSIVE);
4284 }
4285 
4286 int
vn_cmp(struct file * fp1,struct file * fp2,struct thread * td)4287 vn_cmp(struct file *fp1, struct file *fp2, struct thread *td)
4288 {
4289 	if (fp2->f_type != DTYPE_VNODE)
4290 		return (3);
4291 	return (kcmp_cmp((uintptr_t)fp1->f_vnode, (uintptr_t)fp2->f_vnode));
4292 }
4293