sys/kern/vfs_vnops.c

   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 __FBSDID("$FreeBSD$");
  47
  48 #include "opt_hwpmc_hooks.h"
  49
  50 #include <sys/param.h>
  51 #include <sys/systm.h>
  52 #include <sys/disk.h>
  53 #include <sys/fail.h>
  54 #include <sys/fcntl.h>
  55 #include <sys/file.h>
  56 #include <sys/kdb.h>
  57 #include <sys/ktr.h>
  58 #include <sys/stat.h>
  59 #include <sys/priv.h>
  60 #include <sys/proc.h>
  61 #include <sys/limits.h>
  62 #include <sys/lock.h>
  63 #include <sys/mman.h>
  64 #include <sys/mount.h>
  65 #include <sys/mutex.h>
  66 #include <sys/namei.h>
  67 #include <sys/vnode.h>
  68 #include <sys/dirent.h>
  69 #include <sys/bio.h>
  70 #include <sys/buf.h>
  71 #include <sys/filio.h>
  72 #include <sys/resourcevar.h>
  73 #include <sys/rwlock.h>
  74 #include <sys/prng.h>
  75 #include <sys/sx.h>
  76 #include <sys/sleepqueue.h>
  77 #include <sys/sysctl.h>
  78 #include <sys/ttycom.h>
  79 #include <sys/conf.h>
  80 #include <sys/syslog.h>
  81 #include <sys/unistd.h>
  82 #include <sys/user.h>
  83 #include <sys/ktrace.h>
  84
  85 #include <security/audit/audit.h>
  86 #include <security/mac/mac_framework.h>
  87
  88 #include <vm/vm.h>
  89 #include <vm/vm_extern.h>
  90 #include <vm/pmap.h>
  91 #include <vm/vm_map.h>
  92 #include <vm/vm_object.h>
  93 #include <vm/vm_page.h>
  94 #include <vm/vm_pager.h>
  95
  96 #ifdef HWPMC_HOOKS
  97 #include <sys/pmckern.h>
  98 #endif
  99
 100 static fo_rdwr_t        vn_read;
 101 static fo_rdwr_t        vn_write;
 102 static fo_rdwr_t        vn_io_fault;
 103 static fo_truncate_t    vn_truncate;
 104 static fo_ioctl_t       vn_ioctl;
 105 static fo_poll_t        vn_poll;
 106 static fo_kqfilter_t    vn_kqfilter;
 107 static fo_close_t       vn_closefile;
 108 static fo_mmap_t        vn_mmap;
 109 static fo_fallocate_t   vn_fallocate;
 110
 111 struct  fileops vnops = {
 112         .fo_read = vn_io_fault,
 113         .fo_write = vn_io_fault,
 114         .fo_truncate = vn_truncate,
 115         .fo_ioctl = vn_ioctl,
 116         .fo_poll = vn_poll,
 117         .fo_kqfilter = vn_kqfilter,
 118         .fo_stat = vn_statfile,
 119         .fo_close = vn_closefile,
 120         .fo_chmod = vn_chmod,
 121         .fo_chown = vn_chown,
 122         .fo_sendfile = vn_sendfile,
 123         .fo_seek = vn_seek,
 124         .fo_fill_kinfo = vn_fill_kinfo,
 125         .fo_mmap = vn_mmap,
 126         .fo_fallocate = vn_fallocate,
 127         .fo_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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
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
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
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
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
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
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
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
1446         doio = uio->uio_rw == UIO_READ ? vn_read : vn_write;
1447         vp = fp->f_vnode;
1448
1449         /*
1450          * The ability to read(2) on a directory has historically been
1451          * allowed for all users, but this can and has been the source of
1452          * at least one security issue in the past.  As such, it is now hidden
1453          * away behind a sysctl for those that actually need it to use it, and
1454          * restricted to root when it's turned on to make it relatively safe to
1455          * leave on for longer sessions of need.
1456          */
1457         if (vp->v_type == VDIR) {
1458                 KASSERT(uio->uio_rw == UIO_READ,
1459                     ("illegal write attempted on a directory"));
1460                 if (!vfs_allow_read_dir)
1461                         return (EISDIR);
1462                 if ((error = priv_check(td, PRIV_VFS_READ_DIR)) != 0)
1463                         return (EISDIR);
1464         }
1465
1466         foffset_lock_uio(fp, uio, flags);
1467         if (do_vn_io_fault(vp, uio)) {
1468                 args.kind = VN_IO_FAULT_FOP;
1469                 args.args.fop_args.fp = fp;
1470                 args.args.fop_args.doio = doio;
1471                 args.cred = active_cred;
1472                 args.flags = flags | FOF_OFFSET;
1473                 if (uio->uio_rw == UIO_READ) {
1474                         rl_cookie = vn_rangelock_rlock(vp, uio->uio_offset,
1475                             uio->uio_offset + uio->uio_resid);
1476                 } else if ((fp->f_flag & O_APPEND) != 0 ||
1477                     (flags & FOF_OFFSET) == 0) {
1478                         /* For appenders, punt and lock the whole range. */
1479                         rl_cookie = vn_rangelock_wlock(vp, 0, OFF_MAX);
1480                 } else {
1481                         rl_cookie = vn_rangelock_wlock(vp, uio->uio_offset,
1482                             uio->uio_offset + uio->uio_resid);
1483                 }
1484                 error = vn_io_fault1(vp, uio, &args, td);
1485                 vn_rangelock_unlock(vp, rl_cookie);
1486         } else {
1487                 error = doio(fp, uio, active_cred, flags | FOF_OFFSET, td);
1488         }
1489         foffset_unlock_uio(fp, uio, flags);
1490         return (error);
1491 }
1492
1493 /*
1494  * Helper function to perform the requested uiomove operation using
1495  * the held pages for io->uio_iov[0].iov_base buffer instead of
1496  * copyin/copyout.  Access to the pages with uiomove_fromphys()
1497  * instead of iov_base prevents page faults that could occur due to
1498  * pmap_collect() invalidating the mapping created by
1499  * vm_fault_quick_hold_pages(), or pageout daemon, page laundry or
1500  * object cleanup revoking the write access from page mappings.
1501  *
1502  * Filesystems specified MNTK_NO_IOPF shall use vn_io_fault_uiomove()
1503  * instead of plain uiomove().
1504  */
1505 int
1506 vn_io_fault_uiomove(char *data, int xfersize, struct uio *uio)
1507 {
1508         struct uio transp_uio;
1509         struct iovec transp_iov[1];
1510         struct thread *td;
1511         size_t adv;
1512         int error, pgadv;
1513
1514         td = curthread;
1515         if ((td->td_pflags & TDP_UIOHELD) == 0 ||
1516             uio->uio_segflg != UIO_USERSPACE)
1517                 return (uiomove(data, xfersize, uio));
1518
1519         KASSERT(uio->uio_iovcnt == 1, ("uio_iovcnt %d", uio->uio_iovcnt));
1520         transp_iov[0].iov_base = data;
1521         transp_uio.uio_iov = &transp_iov[0];
1522         transp_uio.uio_iovcnt = 1;
1523         if (xfersize > uio->uio_resid)
1524                 xfersize = uio->uio_resid;
1525         transp_uio.uio_resid = transp_iov[0].iov_len = xfersize;
1526         transp_uio.uio_offset = 0;
1527         transp_uio.uio_segflg = UIO_SYSSPACE;
1528         /*
1529          * Since transp_iov points to data, and td_ma page array
1530          * corresponds to original uio->uio_iov, we need to invert the
1531          * direction of the i/o operation as passed to
1532          * uiomove_fromphys().
1533          */
1534         switch (uio->uio_rw) {
1535         case UIO_WRITE:
1536                 transp_uio.uio_rw = UIO_READ;
1537                 break;
1538         case UIO_READ:
1539                 transp_uio.uio_rw = UIO_WRITE;
1540                 break;
1541         }
1542         transp_uio.uio_td = uio->uio_td;
1543         error = uiomove_fromphys(td->td_ma,
1544             ((vm_offset_t)uio->uio_iov->iov_base) & PAGE_MASK,
1545             xfersize, &transp_uio);
1546         adv = xfersize - transp_uio.uio_resid;
1547         pgadv =
1548             (((vm_offset_t)uio->uio_iov->iov_base + adv) >> PAGE_SHIFT) -
1549             (((vm_offset_t)uio->uio_iov->iov_base) >> PAGE_SHIFT);
1550         td->td_ma += pgadv;
1551         KASSERT(td->td_ma_cnt >= pgadv, ("consumed pages %d %d", td->td_ma_cnt,
1552             pgadv));
1553         td->td_ma_cnt -= pgadv;
1554         uio->uio_iov->iov_base = (char *)uio->uio_iov->iov_base + adv;
1555         uio->uio_iov->iov_len -= adv;
1556         uio->uio_resid -= adv;
1557         uio->uio_offset += adv;
1558         return (error);
1559 }
1560
1561 int
1562 vn_io_fault_pgmove(vm_page_t ma[], vm_offset_t offset, int xfersize,
1563     struct uio *uio)
1564 {
1565         struct thread *td;
1566         vm_offset_t iov_base;
1567         int cnt, pgadv;
1568
1569         td = curthread;
1570         if ((td->td_pflags & TDP_UIOHELD) == 0 ||
1571             uio->uio_segflg != UIO_USERSPACE)
1572                 return (uiomove_fromphys(ma, offset, xfersize, uio));
1573
1574         KASSERT(uio->uio_iovcnt == 1, ("uio_iovcnt %d", uio->uio_iovcnt));
1575         cnt = xfersize > uio->uio_resid ? uio->uio_resid : xfersize;
1576         iov_base = (vm_offset_t)uio->uio_iov->iov_base;
1577         switch (uio->uio_rw) {
1578         case UIO_WRITE:
1579                 pmap_copy_pages(td->td_ma, iov_base & PAGE_MASK, ma,
1580                     offset, cnt);
1581                 break;
1582         case UIO_READ:
1583                 pmap_copy_pages(ma, offset, td->td_ma, iov_base & PAGE_MASK,
1584                     cnt);
1585                 break;
1586         }
1587         pgadv = ((iov_base + cnt) >> PAGE_SHIFT) - (iov_base >> PAGE_SHIFT);
1588         td->td_ma += pgadv;
1589         KASSERT(td->td_ma_cnt >= pgadv, ("consumed pages %d %d", td->td_ma_cnt,
1590             pgadv));
1591         td->td_ma_cnt -= pgadv;
1592         uio->uio_iov->iov_base = (char *)(iov_base + cnt);
1593         uio->uio_iov->iov_len -= cnt;
1594         uio->uio_resid -= cnt;
1595         uio->uio_offset += cnt;
1596         return (0);
1597 }
1598
1599 /*
1600  * File table truncate routine.
1601  */
1602 static int
1603 vn_truncate(struct file *fp, off_t length, struct ucred *active_cred,
1604     struct thread *td)
1605 {
1606         struct mount *mp;
1607         struct vnode *vp;
1608         void *rl_cookie;
1609         int error;
1610
1611         vp = fp->f_vnode;
1612
1613 retry:
1614         /*
1615          * Lock the whole range for truncation.  Otherwise split i/o
1616          * might happen partly before and partly after the truncation.
1617          */
1618         rl_cookie = vn_rangelock_wlock(vp, 0, OFF_MAX);
1619         error = vn_start_write(vp, &mp, V_WAIT | PCATCH);
1620         if (error)
1621                 goto out1;
1622         vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
1623         AUDIT_ARG_VNODE1(vp);
1624         if (vp->v_type == VDIR) {
1625                 error = EISDIR;
1626                 goto out;
1627         }
1628 #ifdef MAC
1629         error = mac_vnode_check_write(active_cred, fp->f_cred, vp);
1630         if (error)
1631                 goto out;
1632 #endif
1633         error = vn_truncate_locked(vp, length, (fp->f_flag & O_FSYNC) != 0,
1634             fp->f_cred);
1635 out:
1636         VOP_UNLOCK(vp);
1637         vn_finished_write(mp);
1638 out1:
1639         vn_rangelock_unlock(vp, rl_cookie);
1640         if (error == ERELOOKUP)
1641                 goto retry;
1642         return (error);
1643 }
1644
1645 /*
1646  * Truncate a file that is already locked.
1647  */
1648 int
1649 vn_truncate_locked(struct vnode *vp, off_t length, bool sync,
1650     struct ucred *cred)
1651 {
1652         struct vattr vattr;
1653         int error;
1654
1655         error = VOP_ADD_WRITECOUNT(vp, 1);
1656         if (error == 0) {
1657                 VATTR_NULL(&vattr);
1658                 vattr.va_size = length;
1659                 if (sync)
1660                         vattr.va_vaflags |= VA_SYNC;
1661                 error = VOP_SETATTR(vp, &vattr, cred);
1662                 VOP_ADD_WRITECOUNT_CHECKED(vp, -1);
1663         }
1664         return (error);
1665 }
1666
1667 /*
1668  * File table vnode stat routine.
1669  */
1670 int
1671 vn_statfile(struct file *fp, struct stat *sb, struct ucred *active_cred,
1672     struct thread *td)
1673 {
1674         struct vnode *vp = fp->f_vnode;
1675         int error;
1676
1677         vn_lock(vp, LK_SHARED | LK_RETRY);
1678         error = VOP_STAT(vp, sb, active_cred, fp->f_cred, td);
1679         VOP_UNLOCK(vp);
1680
1681         return (error);
1682 }
1683
1684 /*
1685  * File table vnode ioctl routine.
1686  */
1687 static int
1688 vn_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
1689     struct thread *td)
1690 {
1691         struct vattr vattr;
1692         struct vnode *vp;
1693         struct fiobmap2_arg *bmarg;
1694         int error;
1695
1696         vp = fp->f_vnode;
1697         switch (vp->v_type) {
1698         case VDIR:
1699         case VREG:
1700                 switch (com) {
1701                 case FIONREAD:
1702                         vn_lock(vp, LK_SHARED | LK_RETRY);
1703                         error = VOP_GETATTR(vp, &vattr, active_cred);
1704                         VOP_UNLOCK(vp);
1705                         if (error == 0)
1706                                 *(int *)data = vattr.va_size - fp->f_offset;
1707                         return (error);
1708                 case FIOBMAP2:
1709                         bmarg = (struct fiobmap2_arg *)data;
1710                         vn_lock(vp, LK_SHARED | LK_RETRY);
1711 #ifdef MAC
1712                         error = mac_vnode_check_read(active_cred, fp->f_cred,
1713                             vp);
1714                         if (error == 0)
1715 #endif
1716                                 error = VOP_BMAP(vp, bmarg->bn, NULL,
1717                                     &bmarg->bn, &bmarg->runp, &bmarg->runb);
1718                         VOP_UNLOCK(vp);
1719                         return (error);
1720                 case FIONBIO:
1721                 case FIOASYNC:
1722                         return (0);
1723                 default:
1724                         return (VOP_IOCTL(vp, com, data, fp->f_flag,
1725                             active_cred, td));
1726                 }
1727                 break;
1728         case VCHR:
1729                 return (VOP_IOCTL(vp, com, data, fp->f_flag,
1730                     active_cred, td));
1731         default:
1732                 return (ENOTTY);
1733         }
1734 }
1735
1736 /*
1737  * File table vnode poll routine.
1738  */
1739 static int
1740 vn_poll(struct file *fp, int events, struct ucred *active_cred,
1741     struct thread *td)
1742 {
1743         struct vnode *vp;
1744         int error;
1745
1746         vp = fp->f_vnode;
1747 #if defined(MAC) || defined(AUDIT)
1748         if (AUDITING_TD(td) || mac_vnode_check_poll_enabled()) {
1749                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
1750                 AUDIT_ARG_VNODE1(vp);
1751                 error = mac_vnode_check_poll(active_cred, fp->f_cred, vp);
1752                 VOP_UNLOCK(vp);
1753                 if (error != 0)
1754                         return (error);
1755         }
1756 #endif
1757         error = VOP_POLL(vp, events, fp->f_cred, td);
1758         return (error);
1759 }
1760
1761 /*
1762  * Acquire the requested lock and then check for validity.  LK_RETRY
1763  * permits vn_lock to return doomed vnodes.
1764  */
1765 static int __noinline
1766 _vn_lock_fallback(struct vnode *vp, int flags, const char *file, int line,
1767     int error)
1768 {
1769
1770         KASSERT((flags & LK_RETRY) == 0 || error == 0,
1771             ("vn_lock: error %d incompatible with flags %#x", error, flags));
1772
1773         if (error == 0)
1774                 VNASSERT(VN_IS_DOOMED(vp), vp, ("vnode not doomed"));
1775
1776         if ((flags & LK_RETRY) == 0) {
1777                 if (error == 0) {
1778                         VOP_UNLOCK(vp);
1779                         error = ENOENT;
1780                 }
1781                 return (error);
1782         }
1783
1784         /*
1785          * LK_RETRY case.
1786          *
1787          * Nothing to do if we got the lock.
1788          */
1789         if (error == 0)
1790                 return (0);
1791
1792         /*
1793          * Interlock was dropped by the call in _vn_lock.
1794          */
1795         flags &= ~LK_INTERLOCK;
1796         do {
1797                 error = VOP_LOCK1(vp, flags, file, line);
1798         } while (error != 0);
1799         return (0);
1800 }
1801
1802 int
1803 _vn_lock(struct vnode *vp, int flags, const char *file, int line)
1804 {
1805         int error;
1806
1807         VNASSERT((flags & LK_TYPE_MASK) != 0, vp,
1808             ("vn_lock: no locktype (%d passed)", flags));
1809         VNPASS(vp->v_holdcnt > 0, vp);
1810         error = VOP_LOCK1(vp, flags, file, line);
1811         if (__predict_false(error != 0 || VN_IS_DOOMED(vp)))
1812                 return (_vn_lock_fallback(vp, flags, file, line, error));
1813         return (0);
1814 }
1815
1816 /*
1817  * File table vnode close routine.
1818  */
1819 static int
1820 vn_closefile(struct file *fp, struct thread *td)
1821 {
1822         struct vnode *vp;
1823         struct flock lf;
1824         int error;
1825         bool ref;
1826
1827         vp = fp->f_vnode;
1828         fp->f_ops = &badfileops;
1829         ref = (fp->f_flag & FHASLOCK) != 0;
1830
1831         error = vn_close1(vp, fp->f_flag, fp->f_cred, td, ref);
1832
1833         if (__predict_false(ref)) {
1834                 lf.l_whence = SEEK_SET;
1835                 lf.l_start = 0;
1836                 lf.l_len = 0;
1837                 lf.l_type = F_UNLCK;
1838                 (void) VOP_ADVLOCK(vp, fp, F_UNLCK, &lf, F_FLOCK);
1839                 vrele(vp);
1840         }
1841         return (error);
1842 }
1843
1844 /*
1845  * Preparing to start a filesystem write operation. If the operation is
1846  * permitted, then we bump the count of operations in progress and
1847  * proceed. If a suspend request is in progress, we wait until the
1848  * suspension is over, and then proceed.
1849  */
1850 static int
1851 vn_start_write_refed(struct mount *mp, int flags, bool mplocked)
1852 {
1853         struct mount_pcpu *mpcpu;
1854         int error, mflags;
1855
1856         if (__predict_true(!mplocked) && (flags & V_XSLEEP) == 0 &&
1857             vfs_op_thread_enter(mp, mpcpu)) {
1858                 MPASS((mp->mnt_kern_flag & MNTK_SUSPEND) == 0);
1859                 vfs_mp_count_add_pcpu(mpcpu, writeopcount, 1);
1860                 vfs_op_thread_exit(mp, mpcpu);
1861                 return (0);
1862         }
1863
1864         if (mplocked)
1865                 mtx_assert(MNT_MTX(mp), MA_OWNED);
1866         else
1867                 MNT_ILOCK(mp);
1868
1869         error = 0;
1870
1871         /*
1872          * Check on status of suspension.
1873          */
1874         if ((curthread->td_pflags & TDP_IGNSUSP) == 0 ||
1875             mp->mnt_susp_owner != curthread) {
1876                 mflags = ((mp->mnt_vfc->vfc_flags & VFCF_SBDRY) != 0 ?
1877                     (flags & PCATCH) : 0) | (PUSER - 1);
1878                 while ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0) {
1879                         if (flags & V_NOWAIT) {
1880                                 error = EWOULDBLOCK;
1881                                 goto unlock;
1882                         }
1883                         error = msleep(&mp->mnt_flag, MNT_MTX(mp), mflags,
1884                             "suspfs", 0);
1885                         if (error)
1886                                 goto unlock;
1887                 }
1888         }
1889         if (flags & V_XSLEEP)
1890                 goto unlock;
1891         mp->mnt_writeopcount++;
1892 unlock:
1893         if (error != 0 || (flags & V_XSLEEP) != 0)
1894                 MNT_REL(mp);
1895         MNT_IUNLOCK(mp);
1896         return (error);
1897 }
1898
1899 int
1900 vn_start_write(struct vnode *vp, struct mount **mpp, int flags)
1901 {
1902         struct mount *mp;
1903         int error;
1904
1905         KASSERT((flags & V_MNTREF) == 0 || (*mpp != NULL && vp == NULL),
1906             ("V_MNTREF requires mp"));
1907
1908         error = 0;
1909         /*
1910          * If a vnode is provided, get and return the mount point that
1911          * to which it will write.
1912          */
1913         if (vp != NULL) {
1914                 if ((error = VOP_GETWRITEMOUNT(vp, mpp)) != 0) {
1915                         *mpp = NULL;
1916                         if (error != EOPNOTSUPP)
1917                                 return (error);
1918                         return (0);
1919                 }
1920         }
1921         if ((mp = *mpp) == NULL)
1922                 return (0);
1923
1924         /*
1925          * VOP_GETWRITEMOUNT() returns with the mp refcount held through
1926          * a vfs_ref().
1927          * As long as a vnode is not provided we need to acquire a
1928          * refcount for the provided mountpoint too, in order to
1929          * emulate a vfs_ref().
1930          */
1931         if (vp == NULL && (flags & V_MNTREF) == 0)
1932                 vfs_ref(mp);
1933
1934         return (vn_start_write_refed(mp, flags, false));
1935 }
1936
1937 /*
1938  * Secondary suspension. Used by operations such as vop_inactive
1939  * routines that are needed by the higher level functions. These
1940  * are allowed to proceed until all the higher level functions have
1941  * completed (indicated by mnt_writeopcount dropping to zero). At that
1942  * time, these operations are halted until the suspension is over.
1943  */
1944 int
1945 vn_start_secondary_write(struct vnode *vp, struct mount **mpp, int flags)
1946 {
1947         struct mount *mp;
1948         int error;
1949
1950         KASSERT((flags & V_MNTREF) == 0 || (*mpp != NULL && vp == NULL),
1951             ("V_MNTREF requires mp"));
1952
1953  retry:
1954         if (vp != NULL) {
1955                 if ((error = VOP_GETWRITEMOUNT(vp, mpp)) != 0) {
1956                         *mpp = NULL;
1957                         if (error != EOPNOTSUPP)
1958                                 return (error);
1959                         return (0);
1960                 }
1961         }
1962         /*
1963          * If we are not suspended or have not yet reached suspended
1964          * mode, then let the operation proceed.
1965          */
1966         if ((mp = *mpp) == NULL)
1967                 return (0);
1968
1969         /*
1970          * VOP_GETWRITEMOUNT() returns with the mp refcount held through
1971          * a vfs_ref().
1972          * As long as a vnode is not provided we need to acquire a
1973          * refcount for the provided mountpoint too, in order to
1974          * emulate a vfs_ref().
1975          */
1976         MNT_ILOCK(mp);
1977         if (vp == NULL && (flags & V_MNTREF) == 0)
1978                 MNT_REF(mp);
1979         if ((mp->mnt_kern_flag & (MNTK_SUSPENDED | MNTK_SUSPEND2)) == 0) {
1980                 mp->mnt_secondary_writes++;
1981                 mp->mnt_secondary_accwrites++;
1982                 MNT_IUNLOCK(mp);
1983                 return (0);
1984         }
1985         if (flags & V_NOWAIT) {
1986                 MNT_REL(mp);
1987                 MNT_IUNLOCK(mp);
1988                 return (EWOULDBLOCK);
1989         }
1990         /*
1991          * Wait for the suspension to finish.
1992          */
1993         error = msleep(&mp->mnt_flag, MNT_MTX(mp), (PUSER - 1) | PDROP |
1994             ((mp->mnt_vfc->vfc_flags & VFCF_SBDRY) != 0 ? (flags & PCATCH) : 0),
1995             "suspfs", 0);
1996         vfs_rel(mp);
1997         if (error == 0)
1998                 goto retry;
1999         return (error);
2000 }
2001
2002 /*
2003  * Filesystem write operation has completed. If we are suspending and this
2004  * operation is the last one, notify the suspender that the suspension is
2005  * now in effect.
2006  */
2007 void
2008 vn_finished_write(struct mount *mp)
2009 {
2010         struct mount_pcpu *mpcpu;
2011         int c;
2012
2013         if (mp == NULL)
2014                 return;
2015
2016         if (vfs_op_thread_enter(mp, mpcpu)) {
2017                 vfs_mp_count_sub_pcpu(mpcpu, writeopcount, 1);
2018                 vfs_mp_count_sub_pcpu(mpcpu, ref, 1);
2019                 vfs_op_thread_exit(mp, mpcpu);
2020                 return;
2021         }
2022
2023         MNT_ILOCK(mp);
2024         vfs_assert_mount_counters(mp);
2025         MNT_REL(mp);
2026         c = --mp->mnt_writeopcount;
2027         if (mp->mnt_vfs_ops == 0) {
2028                 MPASS((mp->mnt_kern_flag & MNTK_SUSPEND) == 0);
2029                 MNT_IUNLOCK(mp);
2030                 return;
2031         }
2032         if (c < 0)
2033                 vfs_dump_mount_counters(mp);
2034         if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0 && c == 0)
2035                 wakeup(&mp->mnt_writeopcount);
2036         MNT_IUNLOCK(mp);
2037 }
2038
2039 /*
2040  * Filesystem secondary write operation has completed. If we are
2041  * suspending and this operation is the last one, notify the suspender
2042  * that the suspension is now in effect.
2043  */
2044 void
2045 vn_finished_secondary_write(struct mount *mp)
2046 {
2047         if (mp == NULL)
2048                 return;
2049         MNT_ILOCK(mp);
2050         MNT_REL(mp);
2051         mp->mnt_secondary_writes--;
2052         if (mp->mnt_secondary_writes < 0)
2053                 panic("vn_finished_secondary_write: neg cnt");
2054         if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0 &&
2055             mp->mnt_secondary_writes <= 0)
2056                 wakeup(&mp->mnt_secondary_writes);
2057         MNT_IUNLOCK(mp);
2058 }
2059
2060 /*
2061  * Request a filesystem to suspend write operations.
2062  */
2063 int
2064 vfs_write_suspend(struct mount *mp, int flags)
2065 {
2066         int error;
2067
2068         vfs_op_enter(mp);
2069
2070         MNT_ILOCK(mp);
2071         vfs_assert_mount_counters(mp);
2072         if (mp->mnt_susp_owner == curthread) {
2073                 vfs_op_exit_locked(mp);
2074                 MNT_IUNLOCK(mp);
2075                 return (EALREADY);
2076         }
2077         while (mp->mnt_kern_flag & MNTK_SUSPEND)
2078                 msleep(&mp->mnt_flag, MNT_MTX(mp), PUSER - 1, "wsuspfs", 0);
2079
2080         /*
2081          * Unmount holds a write reference on the mount point.  If we
2082          * own busy reference and drain for writers, we deadlock with
2083          * the reference draining in the unmount path.  Callers of
2084          * vfs_write_suspend() must specify VS_SKIP_UNMOUNT if
2085          * vfs_busy() reference is owned and caller is not in the
2086          * unmount context.
2087          */
2088         if ((flags & VS_SKIP_UNMOUNT) != 0 &&
2089             (mp->mnt_kern_flag & MNTK_UNMOUNT) != 0) {
2090                 vfs_op_exit_locked(mp);
2091                 MNT_IUNLOCK(mp);
2092                 return (EBUSY);
2093         }
2094
2095         mp->mnt_kern_flag |= MNTK_SUSPEND;
2096         mp->mnt_susp_owner = curthread;
2097         if (mp->mnt_writeopcount > 0)
2098                 (void) msleep(&mp->mnt_writeopcount,
2099                     MNT_MTX(mp), (PUSER - 1)|PDROP, "suspwt", 0);
2100         else
2101                 MNT_IUNLOCK(mp);
2102         if ((error = VFS_SYNC(mp, MNT_SUSPEND)) != 0) {
2103                 vfs_write_resume(mp, 0);
2104                 /* vfs_write_resume does vfs_op_exit() for us */
2105         }
2106         return (error);
2107 }
2108
2109 /*
2110  * Request a filesystem to resume write operations.
2111  */
2112 void
2113 vfs_write_resume(struct mount *mp, int flags)
2114 {
2115
2116         MNT_ILOCK(mp);
2117         if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0) {
2118                 KASSERT(mp->mnt_susp_owner == curthread, ("mnt_susp_owner"));
2119                 mp->mnt_kern_flag &= ~(MNTK_SUSPEND | MNTK_SUSPEND2 |
2120                                        MNTK_SUSPENDED);
2121                 mp->mnt_susp_owner = NULL;
2122                 wakeup(&mp->mnt_writeopcount);
2123                 wakeup(&mp->mnt_flag);
2124                 curthread->td_pflags &= ~TDP_IGNSUSP;
2125                 if ((flags & VR_START_WRITE) != 0) {
2126                         MNT_REF(mp);
2127                         mp->mnt_writeopcount++;
2128                 }
2129                 MNT_IUNLOCK(mp);
2130                 if ((flags & VR_NO_SUSPCLR) == 0)
2131                         VFS_SUSP_CLEAN(mp);
2132                 vfs_op_exit(mp);
2133         } else if ((flags & VR_START_WRITE) != 0) {
2134                 MNT_REF(mp);
2135                 vn_start_write_refed(mp, 0, true);
2136         } else {
2137                 MNT_IUNLOCK(mp);
2138         }
2139 }
2140
2141 /*
2142  * Helper loop around vfs_write_suspend() for filesystem unmount VFS
2143  * methods.
2144  */
2145 int
2146 vfs_write_suspend_umnt(struct mount *mp)
2147 {
2148         int error;
2149
2150         KASSERT((curthread->td_pflags & TDP_IGNSUSP) == 0,
2151             ("vfs_write_suspend_umnt: recursed"));
2152
2153         /* dounmount() already called vn_start_write(). */
2154         for (;;) {
2155                 vn_finished_write(mp);
2156                 error = vfs_write_suspend(mp, 0);
2157                 if (error != 0) {
2158                         vn_start_write(NULL, &mp, V_WAIT);
2159                         return (error);
2160                 }
2161                 MNT_ILOCK(mp);
2162                 if ((mp->mnt_kern_flag & MNTK_SUSPENDED) != 0)
2163                         break;
2164                 MNT_IUNLOCK(mp);
2165                 vn_start_write(NULL, &mp, V_WAIT);
2166         }
2167         mp->mnt_kern_flag &= ~(MNTK_SUSPENDED | MNTK_SUSPEND2);
2168         wakeup(&mp->mnt_flag);
2169         MNT_IUNLOCK(mp);
2170         curthread->td_pflags |= TDP_IGNSUSP;
2171         return (0);
2172 }
2173
2174 /*
2175  * Implement kqueues for files by translating it to vnode operation.
2176  */
2177 static int
2178 vn_kqfilter(struct file *fp, struct knote *kn)
2179 {
2180
2181         return (VOP_KQFILTER(fp->f_vnode, kn));
2182 }
2183
2184 int
2185 vn_kqfilter_opath(struct file *fp, struct knote *kn)
2186 {
2187         if ((fp->f_flag & FKQALLOWED) == 0)
2188                 return (EBADF);
2189         return (vn_kqfilter(fp, kn));
2190 }
2191
2192 /*
2193  * Simplified in-kernel wrapper calls for extended attribute access.
2194  * Both calls pass in a NULL credential, authorizing as "kernel" access.
2195  * Set IO_NODELOCKED in ioflg if the vnode is already locked.
2196  */
2197 int
2198 vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
2199     const char *attrname, int *buflen, char *buf, struct thread *td)
2200 {
2201         struct uio      auio;
2202         struct iovec    iov;
2203         int     error;
2204
2205         iov.iov_len = *buflen;
2206         iov.iov_base = buf;
2207
2208         auio.uio_iov = &iov;
2209         auio.uio_iovcnt = 1;
2210         auio.uio_rw = UIO_READ;
2211         auio.uio_segflg = UIO_SYSSPACE;
2212         auio.uio_td = td;
2213         auio.uio_offset = 0;
2214         auio.uio_resid = *buflen;
2215
2216         if ((ioflg & IO_NODELOCKED) == 0)
2217                 vn_lock(vp, LK_SHARED | LK_RETRY);
2218
2219         ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2220
2221         /* authorize attribute retrieval as kernel */
2222         error = VOP_GETEXTATTR(vp, attrnamespace, attrname, &auio, NULL, NULL,
2223             td);
2224
2225         if ((ioflg & IO_NODELOCKED) == 0)
2226                 VOP_UNLOCK(vp);
2227
2228         if (error == 0) {
2229                 *buflen = *buflen - auio.uio_resid;
2230         }
2231
2232         return (error);
2233 }
2234
2235 /*
2236  * XXX failure mode if partially written?
2237  */
2238 int
2239 vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
2240     const char *attrname, int buflen, char *buf, struct thread *td)
2241 {
2242         struct uio      auio;
2243         struct iovec    iov;
2244         struct mount    *mp;
2245         int     error;
2246
2247         iov.iov_len = buflen;
2248         iov.iov_base = buf;
2249
2250         auio.uio_iov = &iov;
2251         auio.uio_iovcnt = 1;
2252         auio.uio_rw = UIO_WRITE;
2253         auio.uio_segflg = UIO_SYSSPACE;
2254         auio.uio_td = td;
2255         auio.uio_offset = 0;
2256         auio.uio_resid = buflen;
2257
2258         if ((ioflg & IO_NODELOCKED) == 0) {
2259                 if ((error = vn_start_write(vp, &mp, V_WAIT)) != 0)
2260                         return (error);
2261                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2262         }
2263
2264         ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2265
2266         /* authorize attribute setting as kernel */
2267         error = VOP_SETEXTATTR(vp, attrnamespace, attrname, &auio, NULL, td);
2268
2269         if ((ioflg & IO_NODELOCKED) == 0) {
2270                 vn_finished_write(mp);
2271                 VOP_UNLOCK(vp);
2272         }
2273
2274         return (error);
2275 }
2276
2277 int
2278 vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
2279     const char *attrname, struct thread *td)
2280 {
2281         struct mount    *mp;
2282         int     error;
2283
2284         if ((ioflg & IO_NODELOCKED) == 0) {
2285                 if ((error = vn_start_write(vp, &mp, V_WAIT)) != 0)
2286                         return (error);
2287                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2288         }
2289
2290         ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2291
2292         /* authorize attribute removal as kernel */
2293         error = VOP_DELETEEXTATTR(vp, attrnamespace, attrname, NULL, td);
2294         if (error == EOPNOTSUPP)
2295                 error = VOP_SETEXTATTR(vp, attrnamespace, attrname, NULL,
2296                     NULL, td);
2297
2298         if ((ioflg & IO_NODELOCKED) == 0) {
2299                 vn_finished_write(mp);
2300                 VOP_UNLOCK(vp);
2301         }
2302
2303         return (error);
2304 }
2305
2306 static int
2307 vn_get_ino_alloc_vget(struct mount *mp, void *arg, int lkflags,
2308     struct vnode **rvp)
2309 {
2310
2311         return (VFS_VGET(mp, *(ino_t *)arg, lkflags, rvp));
2312 }
2313
2314 int
2315 vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags, struct vnode **rvp)
2316 {
2317
2318         return (vn_vget_ino_gen(vp, vn_get_ino_alloc_vget, &ino,
2319             lkflags, rvp));
2320 }
2321
2322 int
2323 vn_vget_ino_gen(struct vnode *vp, vn_get_ino_t alloc, void *alloc_arg,
2324     int lkflags, struct vnode **rvp)
2325 {
2326         struct mount *mp;
2327         int ltype, error;
2328
2329         ASSERT_VOP_LOCKED(vp, "vn_vget_ino_get");
2330         mp = vp->v_mount;
2331         ltype = VOP_ISLOCKED(vp);
2332         KASSERT(ltype == LK_EXCLUSIVE || ltype == LK_SHARED,
2333             ("vn_vget_ino: vp not locked"));
2334         error = vfs_busy(mp, MBF_NOWAIT);
2335         if (error != 0) {
2336                 vfs_ref(mp);
2337                 VOP_UNLOCK(vp);
2338                 error = vfs_busy(mp, 0);
2339                 vn_lock(vp, ltype | LK_RETRY);
2340                 vfs_rel(mp);
2341                 if (error != 0)
2342                         return (ENOENT);
2343                 if (VN_IS_DOOMED(vp)) {
2344                         vfs_unbusy(mp);
2345                         return (ENOENT);
2346                 }
2347         }
2348         VOP_UNLOCK(vp);
2349         error = alloc(mp, alloc_arg, lkflags, rvp);
2350         vfs_unbusy(mp);
2351         if (error != 0 || *rvp != vp)
2352                 vn_lock(vp, ltype | LK_RETRY);
2353         if (VN_IS_DOOMED(vp)) {
2354                 if (error == 0) {
2355                         if (*rvp == vp)
2356                                 vunref(vp);
2357                         else
2358                                 vput(*rvp);
2359                 }
2360                 error = ENOENT;
2361         }
2362         return (error);
2363 }
2364
2365 static void
2366 vn_send_sigxfsz(struct proc *p)
2367 {
2368         PROC_LOCK(p);
2369         kern_psignal(p, SIGXFSZ);
2370         PROC_UNLOCK(p);
2371 }
2372
2373 int
2374 vn_rlimit_trunc(u_quad_t size, struct thread *td)
2375 {
2376         if (size <= lim_cur(td, RLIMIT_FSIZE))
2377                 return (0);
2378         vn_send_sigxfsz(td->td_proc);
2379         return (EFBIG);
2380 }
2381
2382 static int
2383 vn_rlimit_fsizex1(const struct vnode *vp, struct uio *uio, off_t maxfsz,
2384     bool adj, struct thread *td)
2385 {
2386         off_t lim;
2387         bool ktr_write;
2388
2389         if (vp->v_type != VREG)
2390                 return (0);
2391
2392         /*
2393          * Handle file system maximum file size.
2394          */
2395         if (maxfsz != 0 && uio->uio_offset + uio->uio_resid > maxfsz) {
2396                 if (!adj || uio->uio_offset >= maxfsz)
2397                         return (EFBIG);
2398                 uio->uio_resid = maxfsz - uio->uio_offset;
2399         }
2400
2401         /*
2402          * This is kernel write (e.g. vnode_pager) or accounting
2403          * write, ignore limit.
2404          */
2405         if (td == NULL || (td->td_pflags2 & TDP2_ACCT) != 0)
2406                 return (0);
2407
2408         /*
2409          * Calculate file size limit.
2410          */
2411         ktr_write = (td->td_pflags & TDP_INKTRACE) != 0;
2412         lim = __predict_false(ktr_write) ? td->td_ktr_io_lim :
2413             lim_cur(td, RLIMIT_FSIZE);
2414
2415         /*
2416          * Is the limit reached?
2417          */
2418         if (__predict_true((uoff_t)uio->uio_offset + uio->uio_resid <= lim))
2419                 return (0);
2420
2421         /*
2422          * Prepared filesystems can handle writes truncated to the
2423          * file size limit.
2424          */
2425         if (adj && (uoff_t)uio->uio_offset < lim) {
2426                 uio->uio_resid = lim - (uoff_t)uio->uio_offset;
2427                 return (0);
2428         }
2429
2430         if (!ktr_write || ktr_filesize_limit_signal)
2431                 vn_send_sigxfsz(td->td_proc);
2432         return (EFBIG);
2433 }
2434
2435 /*
2436  * Helper for VOP_WRITE() implementations, the common code to
2437  * handle maximum supported file size on the filesystem, and
2438  * RLIMIT_FSIZE, except for special writes from accounting subsystem
2439  * and ktrace.
2440  *
2441  * For maximum file size (maxfsz argument):
2442  * - return EFBIG if uio_offset is beyond it
2443  * - otherwise, clamp uio_resid if write would extend file beyond maxfsz.
2444  *
2445  * For RLIMIT_FSIZE:
2446  * - return EFBIG and send SIGXFSZ if uio_offset is beyond the limit
2447  * - otherwise, clamp uio_resid if write would extend file beyond limit.
2448  *
2449  * If clamping occured, the adjustment for uio_resid is stored in
2450  * *resid_adj, to be re-applied by vn_rlimit_fsizex_res() on return
2451  * from the VOP.
2452  */
2453 int
2454 vn_rlimit_fsizex(const struct vnode *vp, struct uio *uio, off_t maxfsz,
2455     ssize_t *resid_adj, struct thread *td)
2456 {
2457         ssize_t resid_orig;
2458         int error;
2459         bool adj;
2460
2461         resid_orig = uio->uio_resid;
2462         adj = resid_adj != NULL;
2463         error = vn_rlimit_fsizex1(vp, uio, maxfsz, adj, td);
2464         if (adj)
2465                 *resid_adj = resid_orig - uio->uio_resid;
2466         return (error);
2467 }
2468
2469 void
2470 vn_rlimit_fsizex_res(struct uio *uio, ssize_t resid_adj)
2471 {
2472         uio->uio_resid += resid_adj;
2473 }
2474
2475 int
2476 vn_rlimit_fsize(const struct vnode *vp, const struct uio *uio,
2477     struct thread *td)
2478 {
2479         return (vn_rlimit_fsizex(vp, __DECONST(struct uio *, uio), 0, NULL,
2480             td));
2481 }
2482
2483 int
2484 vn_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
2485     struct thread *td)
2486 {
2487         struct vnode *vp;
2488
2489         vp = fp->f_vnode;
2490 #ifdef AUDIT
2491         vn_lock(vp, LK_SHARED | LK_RETRY);
2492         AUDIT_ARG_VNODE1(vp);
2493         VOP_UNLOCK(vp);
2494 #endif
2495         return (setfmode(td, active_cred, vp, mode));
2496 }
2497
2498 int
2499 vn_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
2500     struct thread *td)
2501 {
2502         struct vnode *vp;
2503
2504         vp = fp->f_vnode;
2505 #ifdef AUDIT
2506         vn_lock(vp, LK_SHARED | LK_RETRY);
2507         AUDIT_ARG_VNODE1(vp);
2508         VOP_UNLOCK(vp);
2509 #endif
2510         return (setfown(td, active_cred, vp, uid, gid));
2511 }
2512
2513 /*
2514  * Remove pages in the range ["start", "end") from the vnode's VM object.  If
2515  * "end" is 0, then the range extends to the end of the object.
2516  */
2517 void
2518 vn_pages_remove(struct vnode *vp, vm_pindex_t start, vm_pindex_t end)
2519 {
2520         vm_object_t object;
2521
2522         if ((object = vp->v_object) == NULL)
2523                 return;
2524         VM_OBJECT_WLOCK(object);
2525         vm_object_page_remove(object, start, end, 0);
2526         VM_OBJECT_WUNLOCK(object);
2527 }
2528
2529 /*
2530  * Like vn_pages_remove(), but skips invalid pages, which by definition are not
2531  * mapped into any process' address space.  Filesystems may use this in
2532  * preference to vn_pages_remove() to avoid blocking on pages busied in
2533  * preparation for a VOP_GETPAGES.
2534  */
2535 void
2536 vn_pages_remove_valid(struct vnode *vp, vm_pindex_t start, vm_pindex_t end)
2537 {
2538         vm_object_t object;
2539
2540         if ((object = vp->v_object) == NULL)
2541                 return;
2542         VM_OBJECT_WLOCK(object);
2543         vm_object_page_remove(object, start, end, OBJPR_VALIDONLY);
2544         VM_OBJECT_WUNLOCK(object);
2545 }
2546
2547 int
2548 vn_bmap_seekhole(struct vnode *vp, u_long cmd, off_t *off, struct ucred *cred)
2549 {
2550         vm_object_t obj;
2551         struct vattr va;
2552         daddr_t bn, bnp;
2553         uint64_t bsize;
2554         off_t noff;
2555         int error;
2556
2557         KASSERT(cmd == FIOSEEKHOLE || cmd == FIOSEEKDATA,
2558             ("Wrong command %lu", cmd));
2559
2560         if (vn_lock(vp, LK_EXCLUSIVE) != 0)
2561                 return (EBADF);
2562         if (vp->v_type != VREG) {
2563                 error = ENOTTY;
2564                 goto unlock;
2565         }
2566         error = VOP_GETATTR(vp, &va, cred);
2567         if (error != 0)
2568                 goto unlock;
2569         noff = *off;
2570         if (noff < 0 || noff >= va.va_size) {
2571                 error = ENXIO;
2572                 goto unlock;
2573         }
2574
2575         /* See the comment in ufs_bmap_seekdata(). */
2576         obj = vp->v_object;
2577         if (obj != NULL) {
2578                 VM_OBJECT_WLOCK(obj);
2579                 vm_object_page_clean(obj, 0, 0, OBJPC_SYNC);
2580                 VM_OBJECT_WUNLOCK(obj);
2581         }
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
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
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
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
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
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
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
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
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
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         int error;
3026         size_t len;
3027         uint64_t uval;
3028
3029         len = *lenp;
3030         *lenp = 0;              /* For error returns. */
3031         error = 0;
3032
3033         /* Do some sanity checks on the arguments. */
3034         if (invp->v_type == VDIR || outvp->v_type == VDIR)
3035                 error = EISDIR;
3036         else if (*inoffp < 0 || *outoffp < 0 ||
3037             invp->v_type != VREG || outvp->v_type != VREG)
3038                 error = EINVAL;
3039         if (error != 0)
3040                 goto out;
3041
3042         /* Ensure offset + len does not wrap around. */
3043         uval = *inoffp;
3044         uval += len;
3045         if (uval > INT64_MAX)
3046                 len = INT64_MAX - *inoffp;
3047         uval = *outoffp;
3048         uval += len;
3049         if (uval > INT64_MAX)
3050                 len = INT64_MAX - *outoffp;
3051         if (len == 0)
3052                 goto out;
3053
3054         /*
3055          * If the two vnode are for the same file system, call
3056          * VOP_COPY_FILE_RANGE(), otherwise call vn_generic_copy_file_range()
3057          * which can handle copies across multiple file systems.
3058          */
3059         *lenp = len;
3060         if (invp->v_mount == outvp->v_mount)
3061                 error = VOP_COPY_FILE_RANGE(invp, inoffp, outvp, outoffp,
3062                     lenp, flags, incred, outcred, fsize_td);
3063         else
3064                 error = vn_generic_copy_file_range(invp, inoffp, outvp,
3065                     outoffp, lenp, flags, incred, outcred, fsize_td);
3066 out:
3067         return (error);
3068 }
3069
3070 /*
3071  * Test len bytes of data starting at dat for all bytes == 0.
3072  * Return true if all bytes are zero, false otherwise.
3073  * Expects dat to be well aligned.
3074  */
3075 static bool
3076 mem_iszero(void *dat, int len)
3077 {
3078         int i;
3079         const u_int *p;
3080         const char *cp;
3081
3082         for (p = dat; len > 0; len -= sizeof(*p), p++) {
3083                 if (len >= sizeof(*p)) {
3084                         if (*p != 0)
3085                                 return (false);
3086                 } else {
3087                         cp = (const char *)p;
3088                         for (i = 0; i < len; i++, cp++)
3089                                 if (*cp != '\0')
3090                                         return (false);
3091                 }
3092         }
3093         return (true);
3094 }
3095
3096 /*
3097  * Look for a hole in the output file and, if found, adjust *outoffp
3098  * and *xferp to skip past the hole.
3099  * *xferp is the entire hole length to be written and xfer2 is how many bytes
3100  * to be written as 0's upon return.
3101  */
3102 static off_t
3103 vn_skip_hole(struct vnode *outvp, off_t xfer2, off_t *outoffp, off_t *xferp,
3104     off_t *dataoffp, off_t *holeoffp, struct ucred *cred)
3105 {
3106         int error;
3107         off_t delta;
3108
3109         if (*holeoffp == 0 || *holeoffp <= *outoffp) {
3110                 *dataoffp = *outoffp;
3111                 error = VOP_IOCTL(outvp, FIOSEEKDATA, dataoffp, 0, cred,
3112                     curthread);
3113                 if (error == 0) {
3114                         *holeoffp = *dataoffp;
3115                         error = VOP_IOCTL(outvp, FIOSEEKHOLE, holeoffp, 0, cred,
3116                             curthread);
3117                 }
3118                 if (error != 0 || *holeoffp == *dataoffp) {
3119                         /*
3120                          * Since outvp is unlocked, it may be possible for
3121                          * another thread to do a truncate(), lseek(), write()
3122                          * creating a hole at startoff between the above
3123                          * VOP_IOCTL() calls, if the other thread does not do
3124                          * rangelocking.
3125                          * If that happens, *holeoffp == *dataoffp and finding
3126                          * the hole has failed, so disable vn_skip_hole().
3127                          */
3128                         *holeoffp = -1; /* Disable use of vn_skip_hole(). */
3129                         return (xfer2);
3130                 }
3131                 KASSERT(*dataoffp >= *outoffp,
3132                     ("vn_skip_hole: dataoff=%jd < outoff=%jd",
3133                     (intmax_t)*dataoffp, (intmax_t)*outoffp));
3134                 KASSERT(*holeoffp > *dataoffp,
3135                     ("vn_skip_hole: holeoff=%jd <= dataoff=%jd",
3136                     (intmax_t)*holeoffp, (intmax_t)*dataoffp));
3137         }
3138
3139         /*
3140          * If there is a hole before the data starts, advance *outoffp and
3141          * *xferp past the hole.
3142          */
3143         if (*dataoffp > *outoffp) {
3144                 delta = *dataoffp - *outoffp;
3145                 if (delta >= *xferp) {
3146                         /* Entire *xferp is a hole. */
3147                         *outoffp += *xferp;
3148                         *xferp = 0;
3149                         return (0);
3150                 }
3151                 *xferp -= delta;
3152                 *outoffp += delta;
3153                 xfer2 = MIN(xfer2, *xferp);
3154         }
3155
3156         /*
3157          * If a hole starts before the end of this xfer2, reduce this xfer2 so
3158          * that the write ends at the start of the hole.
3159          * *holeoffp should always be greater than *outoffp, but for the
3160          * non-INVARIANTS case, check this to make sure xfer2 remains a sane
3161          * value.
3162          */
3163         if (*holeoffp > *outoffp && *holeoffp < *outoffp + xfer2)
3164                 xfer2 = *holeoffp - *outoffp;
3165         return (xfer2);
3166 }
3167
3168 /*
3169  * Write an xfer sized chunk to outvp in blksize blocks from dat.
3170  * dat is a maximum of blksize in length and can be written repeatedly in
3171  * the chunk.
3172  * If growfile == true, just grow the file via vn_truncate_locked() instead
3173  * of doing actual writes.
3174  * If checkhole == true, a hole is being punched, so skip over any hole
3175  * already in the output file.
3176  */
3177 static int
3178 vn_write_outvp(struct vnode *outvp, char *dat, off_t outoff, off_t xfer,
3179     u_long blksize, bool growfile, bool checkhole, struct ucred *cred)
3180 {
3181         struct mount *mp;
3182         off_t dataoff, holeoff, xfer2;
3183         int error;
3184
3185         /*
3186          * Loop around doing writes of blksize until write has been completed.
3187          * Lock/unlock on each loop iteration so that a bwillwrite() can be
3188          * done for each iteration, since the xfer argument can be very
3189          * large if there is a large hole to punch in the output file.
3190          */
3191         error = 0;
3192         holeoff = 0;
3193         do {
3194                 xfer2 = MIN(xfer, blksize);
3195                 if (checkhole) {
3196                         /*
3197                          * Punching a hole.  Skip writing if there is
3198                          * already a hole in the output file.
3199                          */
3200                         xfer2 = vn_skip_hole(outvp, xfer2, &outoff, &xfer,
3201                             &dataoff, &holeoff, cred);
3202                         if (xfer == 0)
3203                                 break;
3204                         if (holeoff < 0)
3205                                 checkhole = false;
3206                         KASSERT(xfer2 > 0, ("vn_write_outvp: xfer2=%jd",
3207                             (intmax_t)xfer2));
3208                 }
3209                 bwillwrite();
3210                 mp = NULL;
3211                 error = vn_start_write(outvp, &mp, V_WAIT);
3212                 if (error != 0)
3213                         break;
3214                 if (growfile) {
3215                         error = vn_lock(outvp, LK_EXCLUSIVE);
3216                         if (error == 0) {
3217                                 error = vn_truncate_locked(outvp, outoff + xfer,
3218                                     false, cred);
3219                                 VOP_UNLOCK(outvp);
3220                         }
3221                 } else {
3222                         error = vn_lock(outvp, vn_lktype_write(mp, outvp));
3223                         if (error == 0) {
3224                                 error = vn_rdwr(UIO_WRITE, outvp, dat, xfer2,
3225                                     outoff, UIO_SYSSPACE, IO_NODELOCKED,
3226                                     curthread->td_ucred, cred, NULL, curthread);
3227                                 outoff += xfer2;
3228                                 xfer -= xfer2;
3229                                 VOP_UNLOCK(outvp);
3230                         }
3231                 }
3232                 if (mp != NULL)
3233                         vn_finished_write(mp);
3234         } while (!growfile && xfer > 0 && error == 0);
3235         return (error);
3236 }
3237
3238 /*
3239  * Copy a byte range of one file to another.  This function can handle the
3240  * case where invp and outvp are on different file systems.
3241  * It can also be called by a VOP_COPY_FILE_RANGE() to do the work, if there
3242  * is no better file system specific way to do it.
3243  */
3244 int
3245 vn_generic_copy_file_range(struct vnode *invp, off_t *inoffp,
3246     struct vnode *outvp, off_t *outoffp, size_t *lenp, unsigned int flags,
3247     struct ucred *incred, struct ucred *outcred, struct thread *fsize_td)
3248 {
3249         struct vattr va, inva;
3250         struct mount *mp;
3251         off_t startoff, endoff, xfer, xfer2;
3252         u_long blksize;
3253         int error, interrupted;
3254         bool cantseek, readzeros, eof, lastblock, holetoeof;
3255         ssize_t aresid, r = 0;
3256         size_t copylen, len, savlen;
3257         char *dat;
3258         long holein, holeout;
3259         struct timespec curts, endts;
3260
3261         holein = holeout = 0;
3262         savlen = len = *lenp;
3263         error = 0;
3264         interrupted = 0;
3265         dat = NULL;
3266
3267         error = vn_lock(invp, LK_SHARED);
3268         if (error != 0)
3269                 goto out;
3270         if (VOP_PATHCONF(invp, _PC_MIN_HOLE_SIZE, &holein) != 0)
3271                 holein = 0;
3272         if (holein > 0)
3273                 error = VOP_GETATTR(invp, &inva, incred);
3274         VOP_UNLOCK(invp);
3275         if (error != 0)
3276                 goto out;
3277
3278         mp = NULL;
3279         error = vn_start_write(outvp, &mp, V_WAIT);
3280         if (error == 0)
3281                 error = vn_lock(outvp, LK_EXCLUSIVE);
3282         if (error == 0) {
3283                 /*
3284                  * If fsize_td != NULL, do a vn_rlimit_fsizex() call,
3285                  * now that outvp is locked.
3286                  */
3287                 if (fsize_td != NULL) {
3288                         struct uio io;
3289
3290                         io.uio_offset = *outoffp;
3291                         io.uio_resid = len;
3292                         error = vn_rlimit_fsizex(outvp, &io, 0, &r, fsize_td);
3293                         len = savlen = io.uio_resid;
3294                         /*
3295                          * No need to call vn_rlimit_fsizex_res before return,
3296                          * since the uio is local.
3297                          */
3298                 }
3299                 if (VOP_PATHCONF(outvp, _PC_MIN_HOLE_SIZE, &holeout) != 0)
3300                         holeout = 0;
3301                 /*
3302                  * Holes that are past EOF do not need to be written as a block
3303                  * of zero bytes.  So, truncate the output file as far as
3304                  * possible and then use va.va_size to decide if writing 0
3305                  * bytes is necessary in the loop below.
3306                  */
3307                 if (error == 0)
3308                         error = VOP_GETATTR(outvp, &va, outcred);
3309                 if (error == 0 && va.va_size > *outoffp && va.va_size <=
3310                     *outoffp + len) {
3311 #ifdef MAC
3312                         error = mac_vnode_check_write(curthread->td_ucred,
3313                             outcred, outvp);
3314                         if (error == 0)
3315 #endif
3316                                 error = vn_truncate_locked(outvp, *outoffp,
3317                                     false, outcred);
3318                         if (error == 0)
3319                                 va.va_size = *outoffp;
3320                 }
3321                 VOP_UNLOCK(outvp);
3322         }
3323         if (mp != NULL)
3324                 vn_finished_write(mp);
3325         if (error != 0)
3326                 goto out;
3327
3328         if (holein == 0 && holeout > 0) {
3329                 /*
3330                  * For this special case, the input data will be scanned
3331                  * for blocks of all 0 bytes.  For these blocks, the
3332                  * write can be skipped for the output file to create
3333                  * an unallocated region.
3334                  * Therefore, use the appropriate size for the output file.
3335                  */
3336                 blksize = holeout;
3337                 if (blksize <= 512) {
3338                         /*
3339                          * Use f_iosize, since ZFS reports a _PC_MIN_HOLE_SIZE
3340                          * of 512, although it actually only creates
3341                          * unallocated regions for blocks >= f_iosize.
3342                          */
3343                         blksize = outvp->v_mount->mnt_stat.f_iosize;
3344                 }
3345         } else {
3346                 /*
3347                  * Use the larger of the two f_iosize values.  If they are
3348                  * not the same size, one will normally be an exact multiple of
3349                  * the other, since they are both likely to be a power of 2.
3350                  */
3351                 blksize = MAX(invp->v_mount->mnt_stat.f_iosize,
3352                     outvp->v_mount->mnt_stat.f_iosize);
3353         }
3354
3355         /* Clip to sane limits. */
3356         if (blksize < 4096)
3357                 blksize = 4096;
3358         else if (blksize > maxphys)
3359                 blksize = maxphys;
3360         dat = malloc(blksize, M_TEMP, M_WAITOK);
3361
3362         /*
3363          * If VOP_IOCTL(FIOSEEKHOLE) works for invp, use it and FIOSEEKDATA
3364          * to find holes.  Otherwise, just scan the read block for all 0s
3365          * in the inner loop where the data copying is done.
3366          * Note that some file systems such as NFSv3, NFSv4.0 and NFSv4.1 may
3367          * support holes on the server, but do not support FIOSEEKHOLE.
3368          * The kernel flag COPY_FILE_RANGE_TIMEO1SEC is used to indicate
3369          * that this function should return after 1second with a partial
3370          * completion.
3371          */
3372         if ((flags & COPY_FILE_RANGE_TIMEO1SEC) != 0) {
3373                 getnanouptime(&endts);
3374                 endts.tv_sec++;
3375         } else
3376                 timespecclear(&endts);
3377         holetoeof = eof = false;
3378         while (len > 0 && error == 0 && !eof && interrupted == 0) {
3379                 endoff = 0;                     /* To shut up compilers. */
3380                 cantseek = true;
3381                 startoff = *inoffp;
3382                 copylen = len;
3383
3384                 /*
3385                  * Find the next data area.  If there is just a hole to EOF,
3386                  * FIOSEEKDATA should fail with ENXIO.
3387                  * (I do not know if any file system will report a hole to
3388                  *  EOF via FIOSEEKHOLE, but I am pretty sure FIOSEEKDATA
3389                  *  will fail for those file systems.)
3390                  *
3391                  * For input files that don't support FIOSEEKDATA/FIOSEEKHOLE,
3392                  * the code just falls through to the inner copy loop.
3393                  */
3394                 error = EINVAL;
3395                 if (holein > 0) {
3396                         error = VOP_IOCTL(invp, FIOSEEKDATA, &startoff, 0,
3397                             incred, curthread);
3398                         if (error == ENXIO) {
3399                                 startoff = endoff = inva.va_size;
3400                                 eof = holetoeof = true;
3401                                 error = 0;
3402                         }
3403                 }
3404                 if (error == 0 && !holetoeof) {
3405                         endoff = startoff;
3406                         error = VOP_IOCTL(invp, FIOSEEKHOLE, &endoff, 0,
3407                             incred, curthread);
3408                         /*
3409                          * Since invp is unlocked, it may be possible for
3410                          * another thread to do a truncate(), lseek(), write()
3411                          * creating a hole at startoff between the above
3412                          * VOP_IOCTL() calls, if the other thread does not do
3413                          * rangelocking.
3414                          * If that happens, startoff == endoff and finding
3415                          * the hole has failed, so set an error.
3416                          */
3417                         if (error == 0 && startoff == endoff)
3418                                 error = EINVAL; /* Any error. Reset to 0. */
3419                 }
3420                 if (error == 0) {
3421                         if (startoff > *inoffp) {
3422                                 /* Found hole before data block. */
3423                                 xfer = MIN(startoff - *inoffp, len);
3424                                 if (*outoffp < va.va_size) {
3425                                         /* Must write 0s to punch hole. */
3426                                         xfer2 = MIN(va.va_size - *outoffp,
3427                                             xfer);
3428                                         memset(dat, 0, MIN(xfer2, blksize));
3429                                         error = vn_write_outvp(outvp, dat,
3430                                             *outoffp, xfer2, blksize, false,
3431                                             holeout > 0, outcred);
3432                                 }
3433
3434                                 if (error == 0 && *outoffp + xfer >
3435                                     va.va_size && (xfer == len || holetoeof)) {
3436                                         /* Grow output file (hole at end). */
3437                                         error = vn_write_outvp(outvp, dat,
3438                                             *outoffp, xfer, blksize, true,
3439                                             false, outcred);
3440                                 }
3441                                 if (error == 0) {
3442                                         *inoffp += xfer;
3443                                         *outoffp += xfer;
3444                                         len -= xfer;
3445                                         if (len < savlen) {
3446                                                 interrupted = sig_intr();
3447                                                 if (timespecisset(&endts) &&
3448                                                     interrupted == 0) {
3449                                                         getnanouptime(&curts);
3450                                                         if (timespeccmp(&curts,
3451                                                             &endts, >=))
3452                                                                 interrupted =
3453                                                                     EINTR;
3454                                                 }
3455                                         }
3456                                 }
3457                         }
3458                         copylen = MIN(len, endoff - startoff);
3459                         cantseek = false;
3460                 } else {
3461                         cantseek = true;
3462                         startoff = *inoffp;
3463                         copylen = len;
3464                         error = 0;
3465                 }
3466
3467                 xfer = blksize;
3468                 if (cantseek) {
3469                         /*
3470                          * Set first xfer to end at a block boundary, so that
3471                          * holes are more likely detected in the loop below via
3472                          * the for all bytes 0 method.
3473                          */
3474                         xfer -= (*inoffp % blksize);
3475                 }
3476                 /* Loop copying the data block. */
3477                 while (copylen > 0 && error == 0 && !eof && interrupted == 0) {
3478                         if (copylen < xfer)
3479                                 xfer = copylen;
3480                         error = vn_lock(invp, LK_SHARED);
3481                         if (error != 0)
3482                                 goto out;
3483                         error = vn_rdwr(UIO_READ, invp, dat, xfer,
3484                             startoff, UIO_SYSSPACE, IO_NODELOCKED,
3485                             curthread->td_ucred, incred, &aresid,
3486                             curthread);
3487                         VOP_UNLOCK(invp);
3488                         lastblock = false;
3489                         if (error == 0 && aresid > 0) {
3490                                 /* Stop the copy at EOF on the input file. */
3491                                 xfer -= aresid;
3492                                 eof = true;
3493                                 lastblock = true;
3494                         }
3495                         if (error == 0) {
3496                                 /*
3497                                  * Skip the write for holes past the initial EOF
3498                                  * of the output file, unless this is the last
3499                                  * write of the output file at EOF.
3500                                  */
3501                                 readzeros = cantseek ? mem_iszero(dat, xfer) :
3502                                     false;
3503                                 if (xfer == len)
3504                                         lastblock = true;
3505                                 if (!cantseek || *outoffp < va.va_size ||
3506                                     lastblock || !readzeros)
3507                                         error = vn_write_outvp(outvp, dat,
3508                                             *outoffp, xfer, blksize,
3509                                             readzeros && lastblock &&
3510                                             *outoffp >= va.va_size, false,
3511                                             outcred);
3512                                 if (error == 0) {
3513                                         *inoffp += xfer;
3514                                         startoff += xfer;
3515                                         *outoffp += xfer;
3516                                         copylen -= xfer;
3517                                         len -= xfer;
3518                                         if (len < savlen) {
3519                                                 interrupted = sig_intr();
3520                                                 if (timespecisset(&endts) &&
3521                                                     interrupted == 0) {
3522                                                         getnanouptime(&curts);
3523                                                         if (timespeccmp(&curts,
3524                                                             &endts, >=))
3525                                                                 interrupted =
3526                                                                     EINTR;
3527                                                 }
3528                                         }
3529                                 }
3530                         }
3531                         xfer = blksize;
3532                 }
3533         }
3534 out:
3535         *lenp = savlen - len;
3536         free(dat, M_TEMP);
3537         return (error);
3538 }
3539
3540 static int
3541 vn_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td)
3542 {
3543         struct mount *mp;
3544         struct vnode *vp;
3545         off_t olen, ooffset;
3546         int error;
3547 #ifdef AUDIT
3548         int audited_vnode1 = 0;
3549 #endif
3550
3551         vp = fp->f_vnode;
3552         if (vp->v_type != VREG)
3553                 return (ENODEV);
3554
3555         /* Allocating blocks may take a long time, so iterate. */
3556         for (;;) {
3557                 olen = len;
3558                 ooffset = offset;
3559
3560                 bwillwrite();
3561                 mp = NULL;
3562                 error = vn_start_write(vp, &mp, V_WAIT | PCATCH);
3563                 if (error != 0)
3564                         break;
3565                 error = vn_lock(vp, LK_EXCLUSIVE);
3566                 if (error != 0) {
3567                         vn_finished_write(mp);
3568                         break;
3569                 }
3570 #ifdef AUDIT
3571                 if (!audited_vnode1) {
3572                         AUDIT_ARG_VNODE1(vp);
3573                         audited_vnode1 = 1;
3574                 }
3575 #endif
3576 #ifdef MAC
3577                 error = mac_vnode_check_write(td->td_ucred, fp->f_cred, vp);
3578                 if (error == 0)
3579 #endif
3580                         error = VOP_ALLOCATE(vp, &offset, &len, 0,
3581                             td->td_ucred);
3582                 VOP_UNLOCK(vp);
3583                 vn_finished_write(mp);
3584
3585                 if (olen + ooffset != offset + len) {
3586                         panic("offset + len changed from %jx/%jx to %jx/%jx",
3587                             ooffset, olen, offset, len);
3588                 }
3589                 if (error != 0 || len == 0)
3590                         break;
3591                 KASSERT(olen > len, ("Iteration did not make progress?"));
3592                 maybe_yield();
3593         }
3594
3595         return (error);
3596 }
3597
3598 #define DIRENT_MINSIZE (sizeof(struct dirent) - (MAXNAMLEN+1) + 4)
3599
3600 /*
3601  * Keep this assert as long as sizeof(struct dirent) is used as the maximum
3602  * entry size.
3603  */
3604 _Static_assert(_GENERIC_MAXDIRSIZ == sizeof(struct dirent),
3605     "'struct dirent' size must be a multiple of its alignment "
3606     "(see _GENERIC_DIRLEN())");
3607
3608 /*
3609  * Returns successive directory entries through some caller's provided buffer.
3610  *
3611  * This function automatically refills the provided buffer with calls to
3612  * VOP_READDIR() (after MAC permission checks).
3613  *
3614  * 'td' is used for credentials and passed to uiomove().  'dirbuf' is the
3615  * caller's buffer to fill and 'dirbuflen' its allocated size.  'dirbuf' must
3616  * be properly aligned to access 'struct dirent' structures and 'dirbuflen'
3617  * must be greater than GENERIC_MAXDIRSIZ to avoid VOP_READDIR() returning
3618  * EINVAL (the latter is not a strong guarantee (yet); but EINVAL will always
3619  * be returned if this requirement is not verified).  '*dpp' points to the
3620  * current directory entry in the buffer and '*len' contains the remaining
3621  * valid bytes in 'dirbuf' after 'dpp' (including the pointed entry).
3622  *
3623  * At first call (or when restarting the read), '*len' must have been set to 0,
3624  * '*off' to 0 (or any valid start offset) and '*eofflag' to 0.  There are no
3625  * more entries as soon as '*len' is 0 after a call that returned 0.  Calling
3626  * again this function after such a condition is considered an error and EINVAL
3627  * will be returned.  Other possible error codes are those of VOP_READDIR(),
3628  * EINTEGRITY if the returned entries do not pass coherency tests, or EINVAL
3629  * (bad call).  All errors are unrecoverable, i.e., the state ('*len', '*off'
3630  * and '*eofflag') must be re-initialized before a subsequent call.  On error
3631  * or at end of directory, '*dpp' is reset to NULL.
3632  *
3633  * '*len', '*off' and '*eofflag' are internal state the caller should not
3634  * tamper with except as explained above.  '*off' is the next directory offset
3635  * to read from to refill the buffer.  '*eofflag' is set to 0 or 1 by the last
3636  * internal call to VOP_READDIR() that returned without error, indicating
3637  * whether it reached the end of the directory, and to 2 by this function after
3638  * all entries have been read.
3639  */
3640 int
3641 vn_dir_next_dirent(struct vnode *vp, struct thread *td,
3642     char *dirbuf, size_t dirbuflen,
3643     struct dirent **dpp, size_t *len, off_t *off, int *eofflag)
3644 {
3645         struct dirent *dp = NULL;
3646         int reclen;
3647         int error;
3648         struct uio uio;
3649         struct iovec iov;
3650
3651         ASSERT_VOP_LOCKED(vp, "vnode not locked");
3652         VNASSERT(vp->v_type == VDIR, vp, ("vnode is not a directory"));
3653         MPASS2((uintptr_t)dirbuf < (uintptr_t)dirbuf + dirbuflen,
3654             "Address space overflow");
3655
3656         if (__predict_false(dirbuflen < GENERIC_MAXDIRSIZ)) {
3657                 /* Don't take any chances in this case */
3658                 error = EINVAL;
3659                 goto out;
3660         }
3661
3662         if (*len != 0) {
3663                 dp = *dpp;
3664
3665                 /*
3666                  * The caller continued to call us after an error (we set dp to
3667                  * NULL in a previous iteration).  Bail out right now.
3668                  */
3669                 if (__predict_false(dp == NULL))
3670                         return (EINVAL);
3671
3672                 MPASS(*len <= dirbuflen);
3673                 MPASS2((uintptr_t)dirbuf <= (uintptr_t)dp &&
3674                     (uintptr_t)dp + *len <= (uintptr_t)dirbuf + dirbuflen,
3675                     "Filled range not inside buffer");
3676
3677                 reclen = dp->d_reclen;
3678                 if (reclen >= *len) {
3679                         /* End of buffer reached */
3680                         *len = 0;
3681                 } else {
3682                         dp = (struct dirent *)((char *)dp + reclen);
3683                         *len -= reclen;
3684                 }
3685         }
3686
3687         if (*len == 0) {
3688                 dp = NULL;
3689
3690                 /* Have to refill. */
3691                 switch (*eofflag) {
3692                 case 0:
3693                         break;
3694
3695                 case 1:
3696                         /* Nothing more to read. */
3697                         *eofflag = 2; /* Remember the caller reached EOF. */
3698                         goto success;
3699
3700                 default:
3701                         /* The caller didn't test for EOF. */
3702                         error = EINVAL;
3703                         goto out;
3704                 }
3705
3706                 iov.iov_base = dirbuf;
3707                 iov.iov_len = dirbuflen;
3708
3709                 uio.uio_iov = &iov;
3710                 uio.uio_iovcnt = 1;
3711                 uio.uio_offset = *off;
3712                 uio.uio_resid = dirbuflen;
3713                 uio.uio_segflg = UIO_SYSSPACE;
3714                 uio.uio_rw = UIO_READ;
3715                 uio.uio_td = td;
3716
3717 #ifdef MAC
3718                 error = mac_vnode_check_readdir(td->td_ucred, vp);
3719                 if (error == 0)
3720 #endif
3721                         error = VOP_READDIR(vp, &uio, td->td_ucred, eofflag,
3722                             NULL, NULL);
3723                 if (error != 0)
3724                         goto out;
3725
3726                 *len = dirbuflen - uio.uio_resid;
3727                 *off = uio.uio_offset;
3728
3729                 if (*len == 0) {
3730                         /* Sanity check on INVARIANTS. */
3731                         MPASS(*eofflag != 0);
3732                         *eofflag = 1;
3733                         goto success;
3734                 }
3735
3736                 /*
3737                  * Normalize the flag returned by VOP_READDIR(), since we use 2
3738                  * as a sentinel value.
3739                  */
3740                 if (*eofflag != 0)
3741                         *eofflag = 1;
3742
3743                 dp = (struct dirent *)dirbuf;
3744         }
3745
3746         if (__predict_false(*len < GENERIC_MINDIRSIZ ||
3747             dp->d_reclen < GENERIC_MINDIRSIZ)) {
3748                 error = EINTEGRITY;
3749                 dp = NULL;
3750                 goto out;
3751         }
3752
3753 success:
3754         error = 0;
3755 out:
3756         *dpp = dp;
3757         return (error);
3758 }
3759
3760 /*
3761  * Checks whether a directory is empty or not.
3762  *
3763  * If the directory is empty, returns 0, and if it is not, ENOTEMPTY.  Other
3764  * values are genuine errors preventing the check.
3765  */
3766 int
3767 vn_dir_check_empty(struct vnode *vp)
3768 {
3769         struct thread *const td = curthread;
3770         char *dirbuf;
3771         size_t dirbuflen, len;
3772         off_t off;
3773         int eofflag, error;
3774         struct dirent *dp;
3775         struct vattr va;
3776
3777         ASSERT_VOP_LOCKED(vp, "vfs_emptydir");
3778         VNPASS(vp->v_type == VDIR, vp);
3779
3780         error = VOP_GETATTR(vp, &va, td->td_ucred);
3781         if (error != 0)
3782                 return (error);
3783
3784         dirbuflen = max(DEV_BSIZE, GENERIC_MAXDIRSIZ);
3785         if (dirbuflen < va.va_blocksize)
3786                 dirbuflen = va.va_blocksize;
3787         dirbuf = malloc(dirbuflen, M_TEMP, M_WAITOK);
3788
3789         len = 0;
3790         off = 0;
3791         eofflag = 0;
3792
3793         for (;;) {
3794                 error = vn_dir_next_dirent(vp, td, dirbuf, dirbuflen,
3795                     &dp, &len, &off, &eofflag);
3796                 if (error != 0)
3797                         goto end;
3798
3799                 if (len == 0) {
3800                         /* EOF */
3801                         error = 0;
3802                         goto end;
3803                 }
3804
3805                 /*
3806                  * Skip whiteouts.  Unionfs operates on filesystems only and
3807                  * not on hierarchies, so these whiteouts would be shadowed on
3808                  * the system hierarchy but not for a union using the
3809                  * filesystem of their directories as the upper layer.
3810                  * Additionally, unionfs currently transparently exposes
3811                  * union-specific metadata of its upper layer, meaning that
3812                  * whiteouts can be seen through the union view in empty
3813                  * directories.  Taking into account these whiteouts would then
3814                  * prevent mounting another filesystem on such effectively
3815                  * empty directories.
3816                  */
3817                 if (dp->d_type == DT_WHT)
3818                         continue;
3819
3820                 /*
3821                  * Any file in the directory which is not '.' or '..' indicates
3822                  * the directory is not empty.
3823                  */
3824                 switch (dp->d_namlen) {
3825                 case 2:
3826                         if (dp->d_name[1] != '.') {
3827                                 /* Can't be '..' (nor '.') */
3828                                 error = ENOTEMPTY;
3829                                 goto end;
3830                         }
3831                         /* FALLTHROUGH */
3832                 case 1:
3833                         if (dp->d_name[0] != '.') {
3834                                 /* Can't be '..' nor '.' */
3835                                 error = ENOTEMPTY;
3836                                 goto end;
3837                         }
3838                         break;
3839
3840                 default:
3841                         error = ENOTEMPTY;
3842                         goto end;
3843                 }
3844         }
3845
3846 end:
3847         free(dirbuf, M_TEMP);
3848         return (error);
3849 }
3850
3851
3852 static u_long vn_lock_pair_pause_cnt;
3853 SYSCTL_ULONG(_debug, OID_AUTO, vn_lock_pair_pause, CTLFLAG_RD,
3854     &vn_lock_pair_pause_cnt, 0,
3855     "Count of vn_lock_pair deadlocks");
3856
3857 u_int vn_lock_pair_pause_max;
3858 SYSCTL_UINT(_debug, OID_AUTO, vn_lock_pair_pause_max, CTLFLAG_RW,
3859     &vn_lock_pair_pause_max, 0,
3860     "Max ticks for vn_lock_pair deadlock avoidance sleep");
3861
3862 static void
3863 vn_lock_pair_pause(const char *wmesg)
3864 {
3865         atomic_add_long(&vn_lock_pair_pause_cnt, 1);
3866         pause(wmesg, prng32_bounded(vn_lock_pair_pause_max));
3867 }
3868
3869 /*
3870  * Lock pair of vnodes vp1, vp2, avoiding lock order reversal.
3871  * vp1_locked indicates whether vp1 is exclusively locked; if not, vp1
3872  * must be unlocked.  Same for vp2 and vp2_locked.  One of the vnodes
3873  * can be NULL.
3874  *
3875  * The function returns with both vnodes exclusively locked, and
3876  * guarantees that it does not create lock order reversal with other
3877  * threads during its execution.  Both vnodes could be unlocked
3878  * temporary (and reclaimed).
3879  */
3880 void
3881 vn_lock_pair(struct vnode *vp1, bool vp1_locked, struct vnode *vp2,
3882     bool vp2_locked)
3883 {
3884         int error;
3885
3886         if (vp1 == NULL && vp2 == NULL)
3887                 return;
3888         if (vp1 != NULL) {
3889                 if (vp1_locked)
3890                         ASSERT_VOP_ELOCKED(vp1, "vp1");
3891                 else
3892                         ASSERT_VOP_UNLOCKED(vp1, "vp1");
3893         } else {
3894                 vp1_locked = true;
3895         }
3896         if (vp2 != NULL) {
3897                 if (vp2_locked)
3898                         ASSERT_VOP_ELOCKED(vp2, "vp2");
3899                 else
3900                         ASSERT_VOP_UNLOCKED(vp2, "vp2");
3901         } else {
3902                 vp2_locked = true;
3903         }
3904         if (!vp1_locked && !vp2_locked) {
3905                 vn_lock(vp1, LK_EXCLUSIVE | LK_RETRY);
3906                 vp1_locked = true;
3907         }
3908
3909         for (;;) {
3910                 if (vp1_locked && vp2_locked)
3911                         break;
3912                 if (vp1_locked && vp2 != NULL) {
3913                         if (vp1 != NULL) {
3914                                 error = VOP_LOCK1(vp2, LK_EXCLUSIVE | LK_NOWAIT,
3915                                     __FILE__, __LINE__);
3916                                 if (error == 0)
3917                                         break;
3918                                 VOP_UNLOCK(vp1);
3919                                 vp1_locked = false;
3920                                 vn_lock_pair_pause("vlp1");
3921                         }
3922                         vn_lock(vp2, LK_EXCLUSIVE | LK_RETRY);
3923                         vp2_locked = true;
3924                 }
3925                 if (vp2_locked && vp1 != NULL) {
3926                         if (vp2 != NULL) {
3927                                 error = VOP_LOCK1(vp1, LK_EXCLUSIVE | LK_NOWAIT,
3928                                     __FILE__, __LINE__);
3929                                 if (error == 0)
3930                                         break;
3931                                 VOP_UNLOCK(vp2);
3932                                 vp2_locked = false;
3933                                 vn_lock_pair_pause("vlp2");
3934                         }
3935                         vn_lock(vp1, LK_EXCLUSIVE | LK_RETRY);
3936                         vp1_locked = true;
3937                 }
3938         }
3939         if (vp1 != NULL)
3940                 ASSERT_VOP_ELOCKED(vp1, "vp1 ret");
3941         if (vp2 != NULL)
3942                 ASSERT_VOP_ELOCKED(vp2, "vp2 ret");
3943 }
3944
3945 int
3946 vn_lktype_write(struct mount *mp, struct vnode *vp)
3947 {
3948         if (MNT_SHARED_WRITES(mp) ||
3949             (mp == NULL && MNT_SHARED_WRITES(vp->v_mount)))
3950                 return (LK_SHARED);
3951         return (LK_EXCLUSIVE);
3952 }