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