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/bio.h>
  69 #include <sys/buf.h>
  70 #include <sys/filio.h>
  71 #include <sys/resourcevar.h>
  72 #include <sys/rwlock.h>
  73 #include <sys/sx.h>
  74 #include <sys/sleepqueue.h>
  75 #include <sys/sysctl.h>
  76 #include <sys/ttycom.h>
  77 #include <sys/conf.h>
  78 #include <sys/syslog.h>
  79 #include <sys/unistd.h>
  80 #include <sys/user.h>
  81
  82 #include <security/audit/audit.h>
  83 #include <security/mac/mac_framework.h>
  84
  85 #include <vm/vm.h>
  86 #include <vm/vm_extern.h>
  87 #include <vm/pmap.h>
  88 #include <vm/vm_map.h>
  89 #include <vm/vm_object.h>
  90 #include <vm/vm_page.h>
  91 #include <vm/vm_pager.h>
  92
  93 #ifdef HWPMC_HOOKS
  94 #include <sys/pmckern.h>
  95 #endif
  96
  97 static fo_rdwr_t        vn_read;
  98 static fo_rdwr_t        vn_write;
  99 static fo_rdwr_t        vn_io_fault;
 100 static fo_truncate_t    vn_truncate;
 101 static fo_ioctl_t       vn_ioctl;
 102 static fo_poll_t        vn_poll;
 103 static fo_kqfilter_t    vn_kqfilter;
 104 static fo_stat_t        vn_statfile;
 105 static fo_close_t       vn_closefile;
 106 static fo_mmap_t        vn_mmap;
 107 static fo_fallocate_t   vn_fallocate;
 108
 109 struct  fileops vnops = {
 110         .fo_read = vn_io_fault,
 111         .fo_write = vn_io_fault,
 112         .fo_truncate = vn_truncate,
 113         .fo_ioctl = vn_ioctl,
 114         .fo_poll = vn_poll,
 115         .fo_kqfilter = vn_kqfilter,
 116         .fo_stat = vn_statfile,
 117         .fo_close = vn_closefile,
 118         .fo_chmod = vn_chmod,
 119         .fo_chown = vn_chown,
 120         .fo_sendfile = vn_sendfile,
 121         .fo_seek = vn_seek,
 122         .fo_fill_kinfo = vn_fill_kinfo,
 123         .fo_mmap = vn_mmap,
 124         .fo_fallocate = vn_fallocate,
 125         .fo_flags = DFLAG_PASSABLE | DFLAG_SEEKABLE
 126 };
 127
 128 static const int io_hold_cnt = 16;
 129 static int vn_io_fault_enable = 1;
 130 SYSCTL_INT(_debug, OID_AUTO, vn_io_fault_enable, CTLFLAG_RW,
 131     &vn_io_fault_enable, 0, "Enable vn_io_fault lock avoidance");
 132 static int vn_io_fault_prefault = 0;
 133 SYSCTL_INT(_debug, OID_AUTO, vn_io_fault_prefault, CTLFLAG_RW,
 134     &vn_io_fault_prefault, 0, "Enable vn_io_fault prefaulting");
 135 static u_long vn_io_faults_cnt;
 136 SYSCTL_ULONG(_debug, OID_AUTO, vn_io_faults, CTLFLAG_RD,
 137     &vn_io_faults_cnt, 0, "Count of vn_io_fault lock avoidance triggers");
 138
 139 static int vfs_allow_read_dir = 0;
 140 SYSCTL_INT(_security_bsd, OID_AUTO, allow_read_dir, CTLFLAG_RW,
 141     &vfs_allow_read_dir, 0,
 142     "Enable read(2) of directory by root for filesystems that support it");
 143
 144 /*
 145  * Returns true if vn_io_fault mode of handling the i/o request should
 146  * be used.
 147  */
 148 static bool
 149 do_vn_io_fault(struct vnode *vp, struct uio *uio)
 150 {
 151         struct mount *mp;
 152
 153         return (uio->uio_segflg == UIO_USERSPACE && vp->v_type == VREG &&
 154             (mp = vp->v_mount) != NULL &&
 155             (mp->mnt_kern_flag & MNTK_NO_IOPF) != 0 && vn_io_fault_enable);
 156 }
 157
 158 /*
 159  * Structure used to pass arguments to vn_io_fault1(), to do either
 160  * file- or vnode-based I/O calls.
 161  */
 162 struct vn_io_fault_args {
 163         enum {
 164                 VN_IO_FAULT_FOP,
 165                 VN_IO_FAULT_VOP
 166         } kind;
 167         struct ucred *cred;
 168         int flags;
 169         union {
 170                 struct fop_args_tag {
 171                         struct file *fp;
 172                         fo_rdwr_t *doio;
 173                 } fop_args;
 174                 struct vop_args_tag {
 175                         struct vnode *vp;
 176                 } vop_args;
 177         } args;
 178 };
 179
 180 static int vn_io_fault1(struct vnode *vp, struct uio *uio,
 181     struct vn_io_fault_args *args, struct thread *td);
 182
 183 int
 184 vn_open(struct nameidata *ndp, int *flagp, int cmode, struct file *fp)
 185 {
 186         struct thread *td = ndp->ni_cnd.cn_thread;
 187
 188         return (vn_open_cred(ndp, flagp, cmode, 0, td->td_ucred, fp));
 189 }
 190
 191 /*
 192  * Common code for vnode open operations via a name lookup.
 193  * Lookup the vnode and invoke VOP_CREATE if needed.
 194  * Check permissions, and call the VOP_OPEN or VOP_CREATE routine.
 195  *
 196  * Note that this does NOT free nameidata for the successful case,
 197  * due to the NDINIT being done elsewhere.
 198  */
 199 int
 200 vn_open_cred(struct nameidata *ndp, int *flagp, int cmode, u_int vn_open_flags,
 201     struct ucred *cred, struct file *fp)
 202 {
 203         struct vnode *vp;
 204         struct mount *mp;
 205         struct thread *td = ndp->ni_cnd.cn_thread;
 206         struct vattr vat;
 207         struct vattr *vap = &vat;
 208         int fmode, error;
 209
 210 restart:
 211         fmode = *flagp;
 212         if ((fmode & (O_CREAT | O_EXCL | O_DIRECTORY)) == (O_CREAT |
 213             O_EXCL | O_DIRECTORY))
 214                 return (EINVAL);
 215         else if ((fmode & (O_CREAT | O_DIRECTORY)) == O_CREAT) {
 216                 ndp->ni_cnd.cn_nameiop = CREATE;
 217                 /*
 218                  * Set NOCACHE to avoid flushing the cache when
 219                  * rolling in many files at once.
 220                 */
 221                 ndp->ni_cnd.cn_flags = ISOPEN | LOCKPARENT | LOCKLEAF | NOCACHE;
 222                 if ((fmode & O_EXCL) == 0 && (fmode & O_NOFOLLOW) == 0)
 223                         ndp->ni_cnd.cn_flags |= FOLLOW;
 224                 if ((fmode & O_BENEATH) != 0)
 225                         ndp->ni_cnd.cn_flags |= BENEATH;
 226                 if (!(vn_open_flags & VN_OPEN_NOAUDIT))
 227                         ndp->ni_cnd.cn_flags |= AUDITVNODE1;
 228                 if (vn_open_flags & VN_OPEN_NOCAPCHECK)
 229                         ndp->ni_cnd.cn_flags |= NOCAPCHECK;
 230                 if ((vn_open_flags & VN_OPEN_INVFS) == 0)
 231                         bwillwrite();
 232                 if ((error = namei(ndp)) != 0)
 233                         return (error);
 234                 if (ndp->ni_vp == NULL) {
 235                         VATTR_NULL(vap);
 236                         vap->va_type = VREG;
 237                         vap->va_mode = cmode;
 238                         if (fmode & O_EXCL)
 239                                 vap->va_vaflags |= VA_EXCLUSIVE;
 240                         if (vn_start_write(ndp->ni_dvp, &mp, V_NOWAIT) != 0) {
 241                                 NDFREE(ndp, NDF_ONLY_PNBUF);
 242                                 vput(ndp->ni_dvp);
 243                                 if ((error = vn_start_write(NULL, &mp,
 244                                     V_XSLEEP | PCATCH)) != 0)
 245                                         return (error);
 246                                 goto restart;
 247                         }
 248                         if ((vn_open_flags & VN_OPEN_NAMECACHE) != 0)
 249                                 ndp->ni_cnd.cn_flags |= MAKEENTRY;
 250 #ifdef MAC
 251                         error = mac_vnode_check_create(cred, ndp->ni_dvp,
 252                             &ndp->ni_cnd, vap);
 253                         if (error == 0)
 254 #endif
 255                                 error = VOP_CREATE(ndp->ni_dvp, &ndp->ni_vp,
 256                                                    &ndp->ni_cnd, vap);
 257                         vput(ndp->ni_dvp);
 258                         vn_finished_write(mp);
 259                         if (error) {
 260                                 NDFREE(ndp, NDF_ONLY_PNBUF);
 261                                 return (error);
 262                         }
 263                         fmode &= ~O_TRUNC;
 264                         vp = ndp->ni_vp;
 265                 } else {
 266                         if (ndp->ni_dvp == ndp->ni_vp)
 267                                 vrele(ndp->ni_dvp);
 268                         else
 269                                 vput(ndp->ni_dvp);
 270                         ndp->ni_dvp = NULL;
 271                         vp = ndp->ni_vp;
 272                         if (fmode & O_EXCL) {
 273                                 error = EEXIST;
 274                                 goto bad;
 275                         }
 276                         if (vp->v_type == VDIR) {
 277                                 error = EISDIR;
 278                                 goto bad;
 279                         }
 280                         fmode &= ~O_CREAT;
 281                 }
 282         } else {
 283                 ndp->ni_cnd.cn_nameiop = LOOKUP;
 284                 ndp->ni_cnd.cn_flags = ISOPEN |
 285                     ((fmode & O_NOFOLLOW) ? NOFOLLOW : FOLLOW) | LOCKLEAF;
 286                 if (!(fmode & FWRITE))
 287                         ndp->ni_cnd.cn_flags |= LOCKSHARED;
 288                 if ((fmode & O_BENEATH) != 0)
 289                         ndp->ni_cnd.cn_flags |= BENEATH;
 290                 if (!(vn_open_flags & VN_OPEN_NOAUDIT))
 291                         ndp->ni_cnd.cn_flags |= AUDITVNODE1;
 292                 if (vn_open_flags & VN_OPEN_NOCAPCHECK)
 293                         ndp->ni_cnd.cn_flags |= NOCAPCHECK;
 294                 if ((error = namei(ndp)) != 0)
 295                         return (error);
 296                 vp = ndp->ni_vp;
 297         }
 298         error = vn_open_vnode(vp, fmode, cred, td, fp);
 299         if (error)
 300                 goto bad;
 301         *flagp = fmode;
 302         return (0);
 303 bad:
 304         NDFREE(ndp, NDF_ONLY_PNBUF);
 305         vput(vp);
 306         *flagp = fmode;
 307         ndp->ni_vp = NULL;
 308         return (error);
 309 }
 310
 311 static int
 312 vn_open_vnode_advlock(struct vnode *vp, int fmode, struct file *fp)
 313 {
 314         struct flock lf;
 315         int error, lock_flags, type;
 316
 317         ASSERT_VOP_LOCKED(vp, "vn_open_vnode_advlock");
 318         if ((fmode & (O_EXLOCK | O_SHLOCK)) == 0)
 319                 return (0);
 320         KASSERT(fp != NULL, ("open with flock requires fp"));
 321         if (fp->f_type != DTYPE_NONE && fp->f_type != DTYPE_VNODE)
 322                 return (EOPNOTSUPP);
 323
 324         lock_flags = VOP_ISLOCKED(vp);
 325         VOP_UNLOCK(vp);
 326
 327         lf.l_whence = SEEK_SET;
 328         lf.l_start = 0;
 329         lf.l_len = 0;
 330         lf.l_type = (fmode & O_EXLOCK) != 0 ? F_WRLCK : F_RDLCK;
 331         type = F_FLOCK;
 332         if ((fmode & FNONBLOCK) == 0)
 333                 type |= F_WAIT;
 334         error = VOP_ADVLOCK(vp, (caddr_t)fp, F_SETLK, &lf, type);
 335         if (error == 0)
 336                 fp->f_flag |= FHASLOCK;
 337
 338         vn_lock(vp, lock_flags | LK_RETRY);
 339         if (error == 0 && VN_IS_DOOMED(vp))
 340                 error = ENOENT;
 341         return (error);
 342 }
 343
 344 /*
 345  * Common code for vnode open operations once a vnode is located.
 346  * Check permissions, and call the VOP_OPEN routine.
 347  */
 348 int
 349 vn_open_vnode(struct vnode *vp, int fmode, struct ucred *cred,
 350     struct thread *td, struct file *fp)
 351 {
 352         accmode_t accmode;
 353         int error;
 354
 355         if (vp->v_type == VLNK)
 356                 return (EMLINK);
 357         if (vp->v_type == VSOCK)
 358                 return (EOPNOTSUPP);
 359         if (vp->v_type != VDIR && fmode & O_DIRECTORY)
 360                 return (ENOTDIR);
 361         accmode = 0;
 362         if (fmode & (FWRITE | O_TRUNC)) {
 363                 if (vp->v_type == VDIR)
 364                         return (EISDIR);
 365                 accmode |= VWRITE;
 366         }
 367         if (fmode & FREAD)
 368                 accmode |= VREAD;
 369         if (fmode & FEXEC)
 370                 accmode |= VEXEC;
 371         if ((fmode & O_APPEND) && (fmode & FWRITE))
 372                 accmode |= VAPPEND;
 373 #ifdef MAC
 374         if (fmode & O_CREAT)
 375                 accmode |= VCREAT;
 376         if (fmode & O_VERIFY)
 377                 accmode |= VVERIFY;
 378         error = mac_vnode_check_open(cred, vp, accmode);
 379         if (error)
 380                 return (error);
 381
 382         accmode &= ~(VCREAT | VVERIFY);
 383 #endif
 384         if ((fmode & O_CREAT) == 0 && accmode != 0) {
 385                 error = VOP_ACCESS(vp, accmode, cred, td);
 386                 if (error != 0)
 387                         return (error);
 388         }
 389         if (vp->v_type == VFIFO && VOP_ISLOCKED(vp) != LK_EXCLUSIVE)
 390                 vn_lock(vp, LK_UPGRADE | LK_RETRY);
 391         error = VOP_OPEN(vp, fmode, cred, td, fp);
 392         if (error != 0)
 393                 return (error);
 394
 395         error = vn_open_vnode_advlock(vp, fmode, fp);
 396         if (error == 0 && (fmode & FWRITE) != 0) {
 397                 error = VOP_ADD_WRITECOUNT(vp, 1);
 398                 if (error == 0) {
 399                         CTR3(KTR_VFS, "%s: vp %p v_writecount increased to %d",
 400                              __func__, vp, vp->v_writecount);
 401                 }
 402         }
 403
 404         /*
 405          * Error from advlock or VOP_ADD_WRITECOUNT() still requires
 406          * calling VOP_CLOSE() to pair with earlier VOP_OPEN().
 407          * Arrange for that by having fdrop() to use vn_closefile().
 408          */
 409         if (error != 0) {
 410                 fp->f_flag |= FOPENFAILED;
 411                 fp->f_vnode = vp;
 412                 if (fp->f_ops == &badfileops) {
 413                         fp->f_type = DTYPE_VNODE;
 414                         fp->f_ops = &vnops;
 415                 }
 416                 vref(vp);
 417         }
 418
 419         ASSERT_VOP_LOCKED(vp, "vn_open_vnode");
 420         return (error);
 421
 422 }
 423
 424 /*
 425  * Check for write permissions on the specified vnode.
 426  * Prototype text segments cannot be written.
 427  * It is racy.
 428  */
 429 int
 430 vn_writechk(struct vnode *vp)
 431 {
 432
 433         ASSERT_VOP_LOCKED(vp, "vn_writechk");
 434         /*
 435          * If there's shared text associated with
 436          * the vnode, try to free it up once.  If
 437          * we fail, we can't allow writing.
 438          */
 439         if (VOP_IS_TEXT(vp))
 440                 return (ETXTBSY);
 441
 442         return (0);
 443 }
 444
 445 /*
 446  * Vnode close call
 447  */
 448 static int
 449 vn_close1(struct vnode *vp, int flags, struct ucred *file_cred,
 450     struct thread *td, bool keep_ref)
 451 {
 452         struct mount *mp;
 453         int error, lock_flags;
 454
 455         if (vp->v_type != VFIFO && (flags & FWRITE) == 0 &&
 456             MNT_EXTENDED_SHARED(vp->v_mount))
 457                 lock_flags = LK_SHARED;
 458         else
 459                 lock_flags = LK_EXCLUSIVE;
 460
 461         vn_start_write(vp, &mp, V_WAIT);
 462         vn_lock(vp, lock_flags | LK_RETRY);
 463         AUDIT_ARG_VNODE1(vp);
 464         if ((flags & (FWRITE | FOPENFAILED)) == FWRITE) {
 465                 VOP_ADD_WRITECOUNT_CHECKED(vp, -1);
 466                 CTR3(KTR_VFS, "%s: vp %p v_writecount decreased to %d",
 467                     __func__, vp, vp->v_writecount);
 468         }
 469         error = VOP_CLOSE(vp, flags, file_cred, td);
 470         if (keep_ref)
 471                 VOP_UNLOCK(vp);
 472         else
 473                 vput(vp);
 474         vn_finished_write(mp);
 475         return (error);
 476 }
 477
 478 int
 479 vn_close(struct vnode *vp, int flags, struct ucred *file_cred,
 480     struct thread *td)
 481 {
 482
 483         return (vn_close1(vp, flags, file_cred, td, false));
 484 }
 485
 486 /*
 487  * Heuristic to detect sequential operation.
 488  */
 489 static int
 490 sequential_heuristic(struct uio *uio, struct file *fp)
 491 {
 492         enum uio_rw rw;
 493
 494         ASSERT_VOP_LOCKED(fp->f_vnode, __func__);
 495
 496         rw = uio->uio_rw;
 497         if (fp->f_flag & FRDAHEAD)
 498                 return (fp->f_seqcount[rw] << IO_SEQSHIFT);
 499
 500         /*
 501          * Offset 0 is handled specially.  open() sets f_seqcount to 1 so
 502          * that the first I/O is normally considered to be slightly
 503          * sequential.  Seeking to offset 0 doesn't change sequentiality
 504          * unless previous seeks have reduced f_seqcount to 0, in which
 505          * case offset 0 is not special.
 506          */
 507         if ((uio->uio_offset == 0 && fp->f_seqcount[rw] > 0) ||
 508             uio->uio_offset == fp->f_nextoff[rw]) {
 509                 /*
 510                  * f_seqcount is in units of fixed-size blocks so that it
 511                  * depends mainly on the amount of sequential I/O and not
 512                  * much on the number of sequential I/O's.  The fixed size
 513                  * of 16384 is hard-coded here since it is (not quite) just
 514                  * a magic size that works well here.  This size is more
 515                  * closely related to the best I/O size for real disks than
 516                  * to any block size used by software.
 517                  */
 518                 if (uio->uio_resid >= IO_SEQMAX * 16384)
 519                         fp->f_seqcount[rw] = IO_SEQMAX;
 520                 else {
 521                         fp->f_seqcount[rw] += howmany(uio->uio_resid, 16384);
 522                         if (fp->f_seqcount[rw] > IO_SEQMAX)
 523                                 fp->f_seqcount[rw] = IO_SEQMAX;
 524                 }
 525                 return (fp->f_seqcount[rw] << IO_SEQSHIFT);
 526         }
 527
 528         /* Not sequential.  Quickly draw-down sequentiality. */
 529         if (fp->f_seqcount[rw] > 1)
 530                 fp->f_seqcount[rw] = 1;
 531         else
 532                 fp->f_seqcount[rw] = 0;
 533         return (0);
 534 }
 535
 536 /*
 537  * Package up an I/O request on a vnode into a uio and do it.
 538  */
 539 int
 540 vn_rdwr(enum uio_rw rw, struct vnode *vp, void *base, int len, off_t offset,
 541     enum uio_seg segflg, int ioflg, struct ucred *active_cred,
 542     struct ucred *file_cred, ssize_t *aresid, struct thread *td)
 543 {
 544         struct uio auio;
 545         struct iovec aiov;
 546         struct mount *mp;
 547         struct ucred *cred;
 548         void *rl_cookie;
 549         struct vn_io_fault_args args;
 550         int error, lock_flags;
 551
 552         if (offset < 0 && vp->v_type != VCHR)
 553                 return (EINVAL);
 554         auio.uio_iov = &aiov;
 555         auio.uio_iovcnt = 1;
 556         aiov.iov_base = base;
 557         aiov.iov_len = len;
 558         auio.uio_resid = len;
 559         auio.uio_offset = offset;
 560         auio.uio_segflg = segflg;
 561         auio.uio_rw = rw;
 562         auio.uio_td = td;
 563         error = 0;
 564
 565         if ((ioflg & IO_NODELOCKED) == 0) {
 566                 if ((ioflg & IO_RANGELOCKED) == 0) {
 567                         if (rw == UIO_READ) {
 568                                 rl_cookie = vn_rangelock_rlock(vp, offset,
 569                                     offset + len);
 570                         } else {
 571                                 rl_cookie = vn_rangelock_wlock(vp, offset,
 572                                     offset + len);
 573                         }
 574                 } else
 575                         rl_cookie = NULL;
 576                 mp = NULL;
 577                 if (rw == UIO_WRITE) {
 578                         if (vp->v_type != VCHR &&
 579                             (error = vn_start_write(vp, &mp, V_WAIT | PCATCH))
 580                             != 0)
 581                                 goto out;
 582                         if (MNT_SHARED_WRITES(mp) ||
 583                             ((mp == NULL) && MNT_SHARED_WRITES(vp->v_mount)))
 584                                 lock_flags = LK_SHARED;
 585                         else
 586                                 lock_flags = LK_EXCLUSIVE;
 587                 } else
 588                         lock_flags = LK_SHARED;
 589                 vn_lock(vp, lock_flags | LK_RETRY);
 590         } else
 591                 rl_cookie = NULL;
 592
 593         ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
 594 #ifdef MAC
 595         if ((ioflg & IO_NOMACCHECK) == 0) {
 596                 if (rw == UIO_READ)
 597                         error = mac_vnode_check_read(active_cred, file_cred,
 598                             vp);
 599                 else
 600                         error = mac_vnode_check_write(active_cred, file_cred,
 601                             vp);
 602         }
 603 #endif
 604         if (error == 0) {
 605                 if (file_cred != NULL)
 606                         cred = file_cred;
 607                 else
 608                         cred = active_cred;
 609                 if (do_vn_io_fault(vp, &auio)) {
 610                         args.kind = VN_IO_FAULT_VOP;
 611                         args.cred = cred;
 612                         args.flags = ioflg;
 613                         args.args.vop_args.vp = vp;
 614                         error = vn_io_fault1(vp, &auio, &args, td);
 615                 } else if (rw == UIO_READ) {
 616                         error = VOP_READ(vp, &auio, ioflg, cred);
 617                 } else /* if (rw == UIO_WRITE) */ {
 618                         error = VOP_WRITE(vp, &auio, ioflg, cred);
 619                 }
 620         }
 621         if (aresid)
 622                 *aresid = auio.uio_resid;
 623         else
 624                 if (auio.uio_resid && error == 0)
 625                         error = EIO;
 626         if ((ioflg & IO_NODELOCKED) == 0) {
 627                 VOP_UNLOCK(vp);
 628                 if (mp != NULL)
 629                         vn_finished_write(mp);
 630         }
 631  out:
 632         if (rl_cookie != NULL)
 633                 vn_rangelock_unlock(vp, rl_cookie);
 634         return (error);
 635 }
 636
 637 /*
 638  * Package up an I/O request on a vnode into a uio and do it.  The I/O
 639  * request is split up into smaller chunks and we try to avoid saturating
 640  * the buffer cache while potentially holding a vnode locked, so we
 641  * check bwillwrite() before calling vn_rdwr().  We also call kern_yield()
 642  * to give other processes a chance to lock the vnode (either other processes
 643  * core'ing the same binary, or unrelated processes scanning the directory).
 644  */
 645 int
 646 vn_rdwr_inchunks(enum uio_rw rw, struct vnode *vp, void *base, size_t len,
 647     off_t offset, enum uio_seg segflg, int ioflg, struct ucred *active_cred,
 648     struct ucred *file_cred, size_t *aresid, struct thread *td)
 649 {
 650         int error = 0;
 651         ssize_t iaresid;
 652
 653         do {
 654                 int chunk;
 655
 656                 /*
 657                  * Force `offset' to a multiple of MAXBSIZE except possibly
 658                  * for the first chunk, so that filesystems only need to
 659                  * write full blocks except possibly for the first and last
 660                  * chunks.
 661                  */
 662                 chunk = MAXBSIZE - (uoff_t)offset % MAXBSIZE;
 663
 664                 if (chunk > len)
 665                         chunk = len;
 666                 if (rw != UIO_READ && vp->v_type == VREG)
 667                         bwillwrite();
 668                 iaresid = 0;
 669                 error = vn_rdwr(rw, vp, base, chunk, offset, segflg,
 670                     ioflg, active_cred, file_cred, &iaresid, td);
 671                 len -= chunk;   /* aresid calc already includes length */
 672                 if (error)
 673                         break;
 674                 offset += chunk;
 675                 base = (char *)base + chunk;
 676                 kern_yield(PRI_USER);
 677         } while (len);
 678         if (aresid)
 679                 *aresid = len + iaresid;
 680         return (error);
 681 }
 682
 683 #if OFF_MAX <= LONG_MAX
 684 off_t
 685 foffset_lock(struct file *fp, int flags)
 686 {
 687         volatile short *flagsp;
 688         off_t res;
 689         short state;
 690
 691         KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
 692
 693         if ((flags & FOF_NOLOCK) != 0)
 694                 return (atomic_load_long(&fp->f_offset));
 695
 696         /*
 697          * According to McKusick the vn lock was protecting f_offset here.
 698          * It is now protected by the FOFFSET_LOCKED flag.
 699          */
 700         flagsp = &fp->f_vnread_flags;
 701         if (atomic_cmpset_acq_16(flagsp, 0, FOFFSET_LOCKED))
 702                 return (atomic_load_long(&fp->f_offset));
 703
 704         sleepq_lock(&fp->f_vnread_flags);
 705         state = atomic_load_16(flagsp);
 706         for (;;) {
 707                 if ((state & FOFFSET_LOCKED) == 0) {
 708                         if (!atomic_fcmpset_acq_16(flagsp, &state,
 709                             FOFFSET_LOCKED))
 710                                 continue;
 711                         break;
 712                 }
 713                 if ((state & FOFFSET_LOCK_WAITING) == 0) {
 714                         if (!atomic_fcmpset_acq_16(flagsp, &state,
 715                             state | FOFFSET_LOCK_WAITING))
 716                                 continue;
 717                 }
 718                 DROP_GIANT();
 719                 sleepq_add(&fp->f_vnread_flags, NULL, "vofflock", 0, 0);
 720                 sleepq_wait(&fp->f_vnread_flags, PUSER -1);
 721                 PICKUP_GIANT();
 722                 sleepq_lock(&fp->f_vnread_flags);
 723                 state = atomic_load_16(flagsp);
 724         }
 725         res = atomic_load_long(&fp->f_offset);
 726         sleepq_release(&fp->f_vnread_flags);
 727         return (res);
 728 }
 729
 730 void
 731 foffset_unlock(struct file *fp, off_t val, int flags)
 732 {
 733         volatile short *flagsp;
 734         short state;
 735
 736         KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
 737
 738         if ((flags & FOF_NOUPDATE) == 0)
 739                 atomic_store_long(&fp->f_offset, val);
 740         if ((flags & FOF_NEXTOFF_R) != 0)
 741                 fp->f_nextoff[UIO_READ] = val;
 742         if ((flags & FOF_NEXTOFF_W) != 0)
 743                 fp->f_nextoff[UIO_WRITE] = val;
 744
 745         if ((flags & FOF_NOLOCK) != 0)
 746                 return;
 747
 748         flagsp = &fp->f_vnread_flags;
 749         state = atomic_load_16(flagsp);
 750         if ((state & FOFFSET_LOCK_WAITING) == 0 &&
 751             atomic_cmpset_rel_16(flagsp, state, 0))
 752                 return;
 753
 754         sleepq_lock(&fp->f_vnread_flags);
 755         MPASS((fp->f_vnread_flags & FOFFSET_LOCKED) != 0);
 756         MPASS((fp->f_vnread_flags & FOFFSET_LOCK_WAITING) != 0);
 757         fp->f_vnread_flags = 0;
 758         sleepq_broadcast(&fp->f_vnread_flags, SLEEPQ_SLEEP, 0, 0);
 759         sleepq_release(&fp->f_vnread_flags);
 760 }
 761 #else
 762 off_t
 763 foffset_lock(struct file *fp, int flags)
 764 {
 765         struct mtx *mtxp;
 766         off_t res;
 767
 768         KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
 769
 770         mtxp = mtx_pool_find(mtxpool_sleep, fp);
 771         mtx_lock(mtxp);
 772         if ((flags & FOF_NOLOCK) == 0) {
 773                 while (fp->f_vnread_flags & FOFFSET_LOCKED) {
 774                         fp->f_vnread_flags |= FOFFSET_LOCK_WAITING;
 775                         msleep(&fp->f_vnread_flags, mtxp, PUSER -1,
 776                             "vofflock", 0);
 777                 }
 778                 fp->f_vnread_flags |= FOFFSET_LOCKED;
 779         }
 780         res = fp->f_offset;
 781         mtx_unlock(mtxp);
 782         return (res);
 783 }
 784
 785 void
 786 foffset_unlock(struct file *fp, off_t val, int flags)
 787 {
 788         struct mtx *mtxp;
 789
 790         KASSERT((flags & FOF_OFFSET) == 0, ("FOF_OFFSET passed"));
 791
 792         mtxp = mtx_pool_find(mtxpool_sleep, fp);
 793         mtx_lock(mtxp);
 794         if ((flags & FOF_NOUPDATE) == 0)
 795                 fp->f_offset = val;
 796         if ((flags & FOF_NEXTOFF_R) != 0)
 797                 fp->f_nextoff[UIO_READ] = val;
 798         if ((flags & FOF_NEXTOFF_W) != 0)
 799                 fp->f_nextoff[UIO_WRITE] = val;
 800         if ((flags & FOF_NOLOCK) == 0) {
 801                 KASSERT((fp->f_vnread_flags & FOFFSET_LOCKED) != 0,
 802                     ("Lost FOFFSET_LOCKED"));
 803                 if (fp->f_vnread_flags & FOFFSET_LOCK_WAITING)
 804                         wakeup(&fp->f_vnread_flags);
 805                 fp->f_vnread_flags = 0;
 806         }
 807         mtx_unlock(mtxp);
 808 }
 809 #endif
 810
 811 void
 812 foffset_lock_uio(struct file *fp, struct uio *uio, int flags)
 813 {
 814
 815         if ((flags & FOF_OFFSET) == 0)
 816                 uio->uio_offset = foffset_lock(fp, flags);
 817 }
 818
 819 void
 820 foffset_unlock_uio(struct file *fp, struct uio *uio, int flags)
 821 {
 822
 823         if ((flags & FOF_OFFSET) == 0)
 824                 foffset_unlock(fp, uio->uio_offset, flags);
 825 }
 826
 827 static int
 828 get_advice(struct file *fp, struct uio *uio)
 829 {
 830         struct mtx *mtxp;
 831         int ret;
 832
 833         ret = POSIX_FADV_NORMAL;
 834         if (fp->f_advice == NULL || fp->f_vnode->v_type != VREG)
 835                 return (ret);
 836
 837         mtxp = mtx_pool_find(mtxpool_sleep, fp);
 838         mtx_lock(mtxp);
 839         if (fp->f_advice != NULL &&
 840             uio->uio_offset >= fp->f_advice->fa_start &&
 841             uio->uio_offset + uio->uio_resid <= fp->f_advice->fa_end)
 842                 ret = fp->f_advice->fa_advice;
 843         mtx_unlock(mtxp);
 844         return (ret);
 845 }
 846
 847 /*
 848  * File table vnode read routine.
 849  */
 850 static int
 851 vn_read(struct file *fp, struct uio *uio, struct ucred *active_cred, int flags,
 852     struct thread *td)
 853 {
 854         struct vnode *vp;
 855         off_t orig_offset;
 856         int error, ioflag;
 857         int advice;
 858
 859         KASSERT(uio->uio_td == td, ("uio_td %p is not td %p",
 860             uio->uio_td, td));
 861         KASSERT(flags & FOF_OFFSET, ("No FOF_OFFSET"));
 862         vp = fp->f_vnode;
 863         ioflag = 0;
 864         if (fp->f_flag & FNONBLOCK)
 865                 ioflag |= IO_NDELAY;
 866         if (fp->f_flag & O_DIRECT)
 867                 ioflag |= IO_DIRECT;
 868         advice = get_advice(fp, uio);
 869         vn_lock(vp, LK_SHARED | LK_RETRY);
 870
 871         switch (advice) {
 872         case POSIX_FADV_NORMAL:
 873         case POSIX_FADV_SEQUENTIAL:
 874         case POSIX_FADV_NOREUSE:
 875                 ioflag |= sequential_heuristic(uio, fp);
 876                 break;
 877         case POSIX_FADV_RANDOM:
 878                 /* Disable read-ahead for random I/O. */
 879                 break;
 880         }
 881         orig_offset = uio->uio_offset;
 882
 883 #ifdef MAC
 884         error = mac_vnode_check_read(active_cred, fp->f_cred, vp);
 885         if (error == 0)
 886 #endif
 887                 error = VOP_READ(vp, uio, ioflag, fp->f_cred);
 888         fp->f_nextoff[UIO_READ] = uio->uio_offset;
 889         VOP_UNLOCK(vp);
 890         if (error == 0 && advice == POSIX_FADV_NOREUSE &&
 891             orig_offset != uio->uio_offset)
 892                 /*
 893                  * Use POSIX_FADV_DONTNEED to flush pages and buffers
 894                  * for the backing file after a POSIX_FADV_NOREUSE
 895                  * read(2).
 896                  */
 897                 error = VOP_ADVISE(vp, orig_offset, uio->uio_offset - 1,
 898                     POSIX_FADV_DONTNEED);
 899         return (error);
 900 }
 901
 902 /*
 903  * File table vnode write routine.
 904  */
 905 static int
 906 vn_write(struct file *fp, struct uio *uio, struct ucred *active_cred, int flags,
 907     struct thread *td)
 908 {
 909         struct vnode *vp;
 910         struct mount *mp;
 911         off_t orig_offset;
 912         int error, ioflag, lock_flags;
 913         int advice;
 914
 915         KASSERT(uio->uio_td == td, ("uio_td %p is not td %p",
 916             uio->uio_td, td));
 917         KASSERT(flags & FOF_OFFSET, ("No FOF_OFFSET"));
 918         vp = fp->f_vnode;
 919         if (vp->v_type == VREG)
 920                 bwillwrite();
 921         ioflag = IO_UNIT;
 922         if (vp->v_type == VREG && (fp->f_flag & O_APPEND))
 923                 ioflag |= IO_APPEND;
 924         if (fp->f_flag & FNONBLOCK)
 925                 ioflag |= IO_NDELAY;
 926         if (fp->f_flag & O_DIRECT)
 927                 ioflag |= IO_DIRECT;
 928         if ((fp->f_flag & O_FSYNC) ||
 929             (vp->v_mount && (vp->v_mount->mnt_flag & MNT_SYNCHRONOUS)))
 930                 ioflag |= IO_SYNC;
 931         mp = NULL;
 932         if (vp->v_type != VCHR &&
 933             (error = vn_start_write(vp, &mp, V_WAIT | PCATCH)) != 0)
 934                 goto unlock;
 935
 936         advice = get_advice(fp, uio);
 937
 938         if (MNT_SHARED_WRITES(mp) ||
 939             (mp == NULL && MNT_SHARED_WRITES(vp->v_mount))) {
 940                 lock_flags = LK_SHARED;
 941         } else {
 942                 lock_flags = LK_EXCLUSIVE;
 943         }
 944
 945         vn_lock(vp, lock_flags | LK_RETRY);
 946         switch (advice) {
 947         case POSIX_FADV_NORMAL:
 948         case POSIX_FADV_SEQUENTIAL:
 949         case POSIX_FADV_NOREUSE:
 950                 ioflag |= sequential_heuristic(uio, fp);
 951                 break;
 952         case POSIX_FADV_RANDOM:
 953                 /* XXX: Is this correct? */
 954                 break;
 955         }
 956         orig_offset = uio->uio_offset;
 957
 958 #ifdef MAC
 959         error = mac_vnode_check_write(active_cred, fp->f_cred, vp);
 960         if (error == 0)
 961 #endif
 962                 error = VOP_WRITE(vp, uio, ioflag, fp->f_cred);
 963         fp->f_nextoff[UIO_WRITE] = uio->uio_offset;
 964         VOP_UNLOCK(vp);
 965         if (vp->v_type != VCHR)
 966                 vn_finished_write(mp);
 967         if (error == 0 && advice == POSIX_FADV_NOREUSE &&
 968             orig_offset != uio->uio_offset)
 969                 /*
 970                  * Use POSIX_FADV_DONTNEED to flush pages and buffers
 971                  * for the backing file after a POSIX_FADV_NOREUSE
 972                  * write(2).
 973                  */
 974                 error = VOP_ADVISE(vp, orig_offset, uio->uio_offset - 1,
 975                     POSIX_FADV_DONTNEED);
 976 unlock:
 977         return (error);
 978 }
 979
 980 /*
 981  * The vn_io_fault() is a wrapper around vn_read() and vn_write() to
 982  * prevent the following deadlock:
 983  *
 984  * Assume that the thread A reads from the vnode vp1 into userspace
 985  * buffer buf1 backed by the pages of vnode vp2.  If a page in buf1 is
 986  * currently not resident, then system ends up with the call chain
 987  *   vn_read() -> VOP_READ(vp1) -> uiomove() -> [Page Fault] ->
 988  *     vm_fault(buf1) -> vnode_pager_getpages(vp2) -> VOP_GETPAGES(vp2)
 989  * which establishes lock order vp1->vn_lock, then vp2->vn_lock.
 990  * If, at the same time, thread B reads from vnode vp2 into buffer buf2
 991  * backed by the pages of vnode vp1, and some page in buf2 is not
 992  * resident, we get a reversed order vp2->vn_lock, then vp1->vn_lock.
 993  *
 994  * To prevent the lock order reversal and deadlock, vn_io_fault() does
 995  * not allow page faults to happen during VOP_READ() or VOP_WRITE().
 996  * Instead, it first tries to do the whole range i/o with pagefaults
 997  * disabled. If all pages in the i/o buffer are resident and mapped,
 998  * VOP will succeed (ignoring the genuine filesystem errors).
 999  * Otherwise, we get back EFAULT, and vn_io_fault() falls back to do
1000  * i/o in chunks, with all pages in the chunk prefaulted and held
1001  * using vm_fault_quick_hold_pages().
1002  *
1003  * Filesystems using this deadlock avoidance scheme should use the
1004  * array of the held pages from uio, saved in the curthread->td_ma,
1005  * instead of doing uiomove().  A helper function
1006  * vn_io_fault_uiomove() converts uiomove request into
1007  * uiomove_fromphys() over td_ma array.
1008  *
1009  * Since vnode locks do not cover the whole i/o anymore, rangelocks
1010  * make the current i/o request atomic with respect to other i/os and
1011  * truncations.
1012  */
1013
1014 /*
1015  * Decode vn_io_fault_args and perform the corresponding i/o.
1016  */
1017 static int
1018 vn_io_fault_doio(struct vn_io_fault_args *args, struct uio *uio,
1019     struct thread *td)
1020 {
1021         int error, save;
1022
1023         error = 0;
1024         save = vm_fault_disable_pagefaults();
1025         switch (args->kind) {
1026         case VN_IO_FAULT_FOP:
1027                 error = (args->args.fop_args.doio)(args->args.fop_args.fp,
1028                     uio, args->cred, args->flags, td);
1029                 break;
1030         case VN_IO_FAULT_VOP:
1031                 if (uio->uio_rw == UIO_READ) {
1032                         error = VOP_READ(args->args.vop_args.vp, uio,
1033                             args->flags, args->cred);
1034                 } else if (uio->uio_rw == UIO_WRITE) {
1035                         error = VOP_WRITE(args->args.vop_args.vp, uio,
1036                             args->flags, args->cred);
1037                 }
1038                 break;
1039         default:
1040                 panic("vn_io_fault_doio: unknown kind of io %d %d",
1041                     args->kind, uio->uio_rw);
1042         }
1043         vm_fault_enable_pagefaults(save);
1044         return (error);
1045 }
1046
1047 static int
1048 vn_io_fault_touch(char *base, const struct uio *uio)
1049 {
1050         int r;
1051
1052         r = fubyte(base);
1053         if (r == -1 || (uio->uio_rw == UIO_READ && subyte(base, r) == -1))
1054                 return (EFAULT);
1055         return (0);
1056 }
1057
1058 static int
1059 vn_io_fault_prefault_user(const struct uio *uio)
1060 {
1061         char *base;
1062         const struct iovec *iov;
1063         size_t len;
1064         ssize_t resid;
1065         int error, i;
1066
1067         KASSERT(uio->uio_segflg == UIO_USERSPACE,
1068             ("vn_io_fault_prefault userspace"));
1069
1070         error = i = 0;
1071         iov = uio->uio_iov;
1072         resid = uio->uio_resid;
1073         base = iov->iov_base;
1074         len = iov->iov_len;
1075         while (resid > 0) {
1076                 error = vn_io_fault_touch(base, uio);
1077                 if (error != 0)
1078                         break;
1079                 if (len < PAGE_SIZE) {
1080                         if (len != 0) {
1081                                 error = vn_io_fault_touch(base + len - 1, uio);
1082                                 if (error != 0)
1083                                         break;
1084                                 resid -= len;
1085                         }
1086                         if (++i >= uio->uio_iovcnt)
1087                                 break;
1088                         iov = uio->uio_iov + i;
1089                         base = iov->iov_base;
1090                         len = iov->iov_len;
1091                 } else {
1092                         len -= PAGE_SIZE;
1093                         base += PAGE_SIZE;
1094                         resid -= PAGE_SIZE;
1095                 }
1096         }
1097         return (error);
1098 }
1099
1100 /*
1101  * Common code for vn_io_fault(), agnostic to the kind of i/o request.
1102  * Uses vn_io_fault_doio() to make the call to an actual i/o function.
1103  * Used from vn_rdwr() and vn_io_fault(), which encode the i/o request
1104  * into args and call vn_io_fault1() to handle faults during the user
1105  * mode buffer accesses.
1106  */
1107 static int
1108 vn_io_fault1(struct vnode *vp, struct uio *uio, struct vn_io_fault_args *args,
1109     struct thread *td)
1110 {
1111         vm_page_t ma[io_hold_cnt + 2];
1112         struct uio *uio_clone, short_uio;
1113         struct iovec short_iovec[1];
1114         vm_page_t *prev_td_ma;
1115         vm_prot_t prot;
1116         vm_offset_t addr, end;
1117         size_t len, resid;
1118         ssize_t adv;
1119         int error, cnt, saveheld, prev_td_ma_cnt;
1120
1121         if (vn_io_fault_prefault) {
1122                 error = vn_io_fault_prefault_user(uio);
1123                 if (error != 0)
1124                         return (error); /* Or ignore ? */
1125         }
1126
1127         prot = uio->uio_rw == UIO_READ ? VM_PROT_WRITE : VM_PROT_READ;
1128
1129         /*
1130          * The UFS follows IO_UNIT directive and replays back both
1131          * uio_offset and uio_resid if an error is encountered during the
1132          * operation.  But, since the iovec may be already advanced,
1133          * uio is still in an inconsistent state.
1134          *
1135          * Cache a copy of the original uio, which is advanced to the redo
1136          * point using UIO_NOCOPY below.
1137          */
1138         uio_clone = cloneuio(uio);
1139         resid = uio->uio_resid;
1140
1141         short_uio.uio_segflg = UIO_USERSPACE;
1142         short_uio.uio_rw = uio->uio_rw;
1143         short_uio.uio_td = uio->uio_td;
1144
1145         error = vn_io_fault_doio(args, uio, td);
1146         if (error != EFAULT)
1147                 goto out;
1148
1149         atomic_add_long(&vn_io_faults_cnt, 1);
1150         uio_clone->uio_segflg = UIO_NOCOPY;
1151         uiomove(NULL, resid - uio->uio_resid, uio_clone);
1152         uio_clone->uio_segflg = uio->uio_segflg;
1153
1154         saveheld = curthread_pflags_set(TDP_UIOHELD);
1155         prev_td_ma = td->td_ma;
1156         prev_td_ma_cnt = td->td_ma_cnt;
1157
1158         while (uio_clone->uio_resid != 0) {
1159                 len = uio_clone->uio_iov->iov_len;
1160                 if (len == 0) {
1161                         KASSERT(uio_clone->uio_iovcnt >= 1,
1162                             ("iovcnt underflow"));
1163                         uio_clone->uio_iov++;
1164                         uio_clone->uio_iovcnt--;
1165                         continue;
1166                 }
1167                 if (len > io_hold_cnt * PAGE_SIZE)
1168                         len = io_hold_cnt * PAGE_SIZE;
1169                 addr = (uintptr_t)uio_clone->uio_iov->iov_base;
1170                 end = round_page(addr + len);
1171                 if (end < addr) {
1172                         error = EFAULT;
1173                         break;
1174                 }
1175                 cnt = atop(end - trunc_page(addr));
1176                 /*
1177                  * A perfectly misaligned address and length could cause
1178                  * both the start and the end of the chunk to use partial
1179                  * page.  +2 accounts for such a situation.
1180                  */
1181                 cnt = vm_fault_quick_hold_pages(&td->td_proc->p_vmspace->vm_map,
1182                     addr, len, prot, ma, io_hold_cnt + 2);
1183                 if (cnt == -1) {
1184                         error = EFAULT;
1185                         break;
1186                 }
1187                 short_uio.uio_iov = &short_iovec[0];
1188                 short_iovec[0].iov_base = (void *)addr;
1189                 short_uio.uio_iovcnt = 1;
1190                 short_uio.uio_resid = short_iovec[0].iov_len = len;
1191                 short_uio.uio_offset = uio_clone->uio_offset;
1192                 td->td_ma = ma;
1193                 td->td_ma_cnt = cnt;
1194
1195                 error = vn_io_fault_doio(args, &short_uio, td);
1196                 vm_page_unhold_pages(ma, cnt);
1197                 adv = len - short_uio.uio_resid;
1198
1199                 uio_clone->uio_iov->iov_base =
1200                     (char *)uio_clone->uio_iov->iov_base + adv;
1201                 uio_clone->uio_iov->iov_len -= adv;
1202                 uio_clone->uio_resid -= adv;
1203                 uio_clone->uio_offset += adv;
1204
1205                 uio->uio_resid -= adv;
1206                 uio->uio_offset += adv;
1207
1208                 if (error != 0 || adv == 0)
1209                         break;
1210         }
1211         td->td_ma = prev_td_ma;
1212         td->td_ma_cnt = prev_td_ma_cnt;
1213         curthread_pflags_restore(saveheld);
1214 out:
1215         free(uio_clone, M_IOV);
1216         return (error);
1217 }
1218
1219 static int
1220 vn_io_fault(struct file *fp, struct uio *uio, struct ucred *active_cred,
1221     int flags, struct thread *td)
1222 {
1223         fo_rdwr_t *doio;
1224         struct vnode *vp;
1225         void *rl_cookie;
1226         struct vn_io_fault_args args;
1227         int error;
1228
1229         doio = uio->uio_rw == UIO_READ ? vn_read : vn_write;
1230         vp = fp->f_vnode;
1231
1232         /*
1233          * The ability to read(2) on a directory has historically been
1234          * allowed for all users, but this can and has been the source of
1235          * at least one security issue in the past.  As such, it is now hidden
1236          * away behind a sysctl for those that actually need it to use it, and
1237          * restricted to root when it's turned on to make it relatively safe to
1238          * leave on for longer sessions of need.
1239          */
1240         if (vp->v_type == VDIR) {
1241                 KASSERT(uio->uio_rw == UIO_READ,
1242                     ("illegal write attempted on a directory"));
1243                 if (!vfs_allow_read_dir)
1244                         return (EISDIR);
1245                 if ((error = priv_check(td, PRIV_VFS_READ_DIR)) != 0)
1246                         return (EISDIR);
1247         }
1248
1249         foffset_lock_uio(fp, uio, flags);
1250         if (do_vn_io_fault(vp, uio)) {
1251                 args.kind = VN_IO_FAULT_FOP;
1252                 args.args.fop_args.fp = fp;
1253                 args.args.fop_args.doio = doio;
1254                 args.cred = active_cred;
1255                 args.flags = flags | FOF_OFFSET;
1256                 if (uio->uio_rw == UIO_READ) {
1257                         rl_cookie = vn_rangelock_rlock(vp, uio->uio_offset,
1258                             uio->uio_offset + uio->uio_resid);
1259                 } else if ((fp->f_flag & O_APPEND) != 0 ||
1260                     (flags & FOF_OFFSET) == 0) {
1261                         /* For appenders, punt and lock the whole range. */
1262                         rl_cookie = vn_rangelock_wlock(vp, 0, OFF_MAX);
1263                 } else {
1264                         rl_cookie = vn_rangelock_wlock(vp, uio->uio_offset,
1265                             uio->uio_offset + uio->uio_resid);
1266                 }
1267                 error = vn_io_fault1(vp, uio, &args, td);
1268                 vn_rangelock_unlock(vp, rl_cookie);
1269         } else {
1270                 error = doio(fp, uio, active_cred, flags | FOF_OFFSET, td);
1271         }
1272         foffset_unlock_uio(fp, uio, flags);
1273         return (error);
1274 }
1275
1276 /*
1277  * Helper function to perform the requested uiomove operation using
1278  * the held pages for io->uio_iov[0].iov_base buffer instead of
1279  * copyin/copyout.  Access to the pages with uiomove_fromphys()
1280  * instead of iov_base prevents page faults that could occur due to
1281  * pmap_collect() invalidating the mapping created by
1282  * vm_fault_quick_hold_pages(), or pageout daemon, page laundry or
1283  * object cleanup revoking the write access from page mappings.
1284  *
1285  * Filesystems specified MNTK_NO_IOPF shall use vn_io_fault_uiomove()
1286  * instead of plain uiomove().
1287  */
1288 int
1289 vn_io_fault_uiomove(char *data, int xfersize, struct uio *uio)
1290 {
1291         struct uio transp_uio;
1292         struct iovec transp_iov[1];
1293         struct thread *td;
1294         size_t adv;
1295         int error, pgadv;
1296
1297         td = curthread;
1298         if ((td->td_pflags & TDP_UIOHELD) == 0 ||
1299             uio->uio_segflg != UIO_USERSPACE)
1300                 return (uiomove(data, xfersize, uio));
1301
1302         KASSERT(uio->uio_iovcnt == 1, ("uio_iovcnt %d", uio->uio_iovcnt));
1303         transp_iov[0].iov_base = data;
1304         transp_uio.uio_iov = &transp_iov[0];
1305         transp_uio.uio_iovcnt = 1;
1306         if (xfersize > uio->uio_resid)
1307                 xfersize = uio->uio_resid;
1308         transp_uio.uio_resid = transp_iov[0].iov_len = xfersize;
1309         transp_uio.uio_offset = 0;
1310         transp_uio.uio_segflg = UIO_SYSSPACE;
1311         /*
1312          * Since transp_iov points to data, and td_ma page array
1313          * corresponds to original uio->uio_iov, we need to invert the
1314          * direction of the i/o operation as passed to
1315          * uiomove_fromphys().
1316          */
1317         switch (uio->uio_rw) {
1318         case UIO_WRITE:
1319                 transp_uio.uio_rw = UIO_READ;
1320                 break;
1321         case UIO_READ:
1322                 transp_uio.uio_rw = UIO_WRITE;
1323                 break;
1324         }
1325         transp_uio.uio_td = uio->uio_td;
1326         error = uiomove_fromphys(td->td_ma,
1327             ((vm_offset_t)uio->uio_iov->iov_base) & PAGE_MASK,
1328             xfersize, &transp_uio);
1329         adv = xfersize - transp_uio.uio_resid;
1330         pgadv =
1331             (((vm_offset_t)uio->uio_iov->iov_base + adv) >> PAGE_SHIFT) -
1332             (((vm_offset_t)uio->uio_iov->iov_base) >> PAGE_SHIFT);
1333         td->td_ma += pgadv;
1334         KASSERT(td->td_ma_cnt >= pgadv, ("consumed pages %d %d", td->td_ma_cnt,
1335             pgadv));
1336         td->td_ma_cnt -= pgadv;
1337         uio->uio_iov->iov_base = (char *)uio->uio_iov->iov_base + adv;
1338         uio->uio_iov->iov_len -= adv;
1339         uio->uio_resid -= adv;
1340         uio->uio_offset += adv;
1341         return (error);
1342 }
1343
1344 int
1345 vn_io_fault_pgmove(vm_page_t ma[], vm_offset_t offset, int xfersize,
1346     struct uio *uio)
1347 {
1348         struct thread *td;
1349         vm_offset_t iov_base;
1350         int cnt, pgadv;
1351
1352         td = curthread;
1353         if ((td->td_pflags & TDP_UIOHELD) == 0 ||
1354             uio->uio_segflg != UIO_USERSPACE)
1355                 return (uiomove_fromphys(ma, offset, xfersize, uio));
1356
1357         KASSERT(uio->uio_iovcnt == 1, ("uio_iovcnt %d", uio->uio_iovcnt));
1358         cnt = xfersize > uio->uio_resid ? uio->uio_resid : xfersize;
1359         iov_base = (vm_offset_t)uio->uio_iov->iov_base;
1360         switch (uio->uio_rw) {
1361         case UIO_WRITE:
1362                 pmap_copy_pages(td->td_ma, iov_base & PAGE_MASK, ma,
1363                     offset, cnt);
1364                 break;
1365         case UIO_READ:
1366                 pmap_copy_pages(ma, offset, td->td_ma, iov_base & PAGE_MASK,
1367                     cnt);
1368                 break;
1369         }
1370         pgadv = ((iov_base + cnt) >> PAGE_SHIFT) - (iov_base >> PAGE_SHIFT);
1371         td->td_ma += pgadv;
1372         KASSERT(td->td_ma_cnt >= pgadv, ("consumed pages %d %d", td->td_ma_cnt,
1373             pgadv));
1374         td->td_ma_cnt -= pgadv;
1375         uio->uio_iov->iov_base = (char *)(iov_base + cnt);
1376         uio->uio_iov->iov_len -= cnt;
1377         uio->uio_resid -= cnt;
1378         uio->uio_offset += cnt;
1379         return (0);
1380 }
1381
1382 /*
1383  * File table truncate routine.
1384  */
1385 static int
1386 vn_truncate(struct file *fp, off_t length, struct ucred *active_cred,
1387     struct thread *td)
1388 {
1389         struct mount *mp;
1390         struct vnode *vp;
1391         void *rl_cookie;
1392         int error;
1393
1394         vp = fp->f_vnode;
1395
1396         /*
1397          * Lock the whole range for truncation.  Otherwise split i/o
1398          * might happen partly before and partly after the truncation.
1399          */
1400         rl_cookie = vn_rangelock_wlock(vp, 0, OFF_MAX);
1401         error = vn_start_write(vp, &mp, V_WAIT | PCATCH);
1402         if (error)
1403                 goto out1;
1404         vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
1405         AUDIT_ARG_VNODE1(vp);
1406         if (vp->v_type == VDIR) {
1407                 error = EISDIR;
1408                 goto out;
1409         }
1410 #ifdef MAC
1411         error = mac_vnode_check_write(active_cred, fp->f_cred, vp);
1412         if (error)
1413                 goto out;
1414 #endif
1415         error = vn_truncate_locked(vp, length, (fp->f_flag & O_FSYNC) != 0,
1416             fp->f_cred);
1417 out:
1418         VOP_UNLOCK(vp);
1419         vn_finished_write(mp);
1420 out1:
1421         vn_rangelock_unlock(vp, rl_cookie);
1422         return (error);
1423 }
1424
1425 /*
1426  * Truncate a file that is already locked.
1427  */
1428 int
1429 vn_truncate_locked(struct vnode *vp, off_t length, bool sync,
1430     struct ucred *cred)
1431 {
1432         struct vattr vattr;
1433         int error;
1434
1435         error = VOP_ADD_WRITECOUNT(vp, 1);
1436         if (error == 0) {
1437                 VATTR_NULL(&vattr);
1438                 vattr.va_size = length;
1439                 if (sync)
1440                         vattr.va_vaflags |= VA_SYNC;
1441                 error = VOP_SETATTR(vp, &vattr, cred);
1442                 VOP_ADD_WRITECOUNT_CHECKED(vp, -1);
1443         }
1444         return (error);
1445 }
1446
1447 /*
1448  * File table vnode stat routine.
1449  */
1450 static int
1451 vn_statfile(struct file *fp, struct stat *sb, struct ucred *active_cred,
1452     struct thread *td)
1453 {
1454         struct vnode *vp = fp->f_vnode;
1455         int error;
1456
1457         vn_lock(vp, LK_SHARED | LK_RETRY);
1458         error = vn_stat(vp, sb, active_cred, fp->f_cred, td);
1459         VOP_UNLOCK(vp);
1460
1461         return (error);
1462 }
1463
1464 /*
1465  * Stat a vnode; implementation for the stat syscall
1466  */
1467 int
1468 vn_stat(struct vnode *vp, struct stat *sb, struct ucred *active_cred,
1469     struct ucred *file_cred, struct thread *td)
1470 {
1471         struct vattr vattr;
1472         struct vattr *vap;
1473         int error;
1474         u_short mode;
1475
1476         AUDIT_ARG_VNODE1(vp);
1477 #ifdef MAC
1478         error = mac_vnode_check_stat(active_cred, file_cred, vp);
1479         if (error)
1480                 return (error);
1481 #endif
1482
1483         vap = &vattr;
1484
1485         /*
1486          * Initialize defaults for new and unusual fields, so that file
1487          * systems which don't support these fields don't need to know
1488          * about them.
1489          */
1490         vap->va_birthtime.tv_sec = -1;
1491         vap->va_birthtime.tv_nsec = 0;
1492         vap->va_fsid = VNOVAL;
1493         vap->va_rdev = NODEV;
1494
1495         error = VOP_GETATTR(vp, vap, active_cred);
1496         if (error)
1497                 return (error);
1498
1499         /*
1500          * Zero the spare stat fields
1501          */
1502         bzero(sb, sizeof *sb);
1503
1504         /*
1505          * Copy from vattr table
1506          */
1507         if (vap->va_fsid != VNOVAL)
1508                 sb->st_dev = vap->va_fsid;
1509         else
1510                 sb->st_dev = vp->v_mount->mnt_stat.f_fsid.val[0];
1511         sb->st_ino = vap->va_fileid;
1512         mode = vap->va_mode;
1513         switch (vap->va_type) {
1514         case VREG:
1515                 mode |= S_IFREG;
1516                 break;
1517         case VDIR:
1518                 mode |= S_IFDIR;
1519                 break;
1520         case VBLK:
1521                 mode |= S_IFBLK;
1522                 break;
1523         case VCHR:
1524                 mode |= S_IFCHR;
1525                 break;
1526         case VLNK:
1527                 mode |= S_IFLNK;
1528                 break;
1529         case VSOCK:
1530                 mode |= S_IFSOCK;
1531                 break;
1532         case VFIFO:
1533                 mode |= S_IFIFO;
1534                 break;
1535         default:
1536                 return (EBADF);
1537         }
1538         sb->st_mode = mode;
1539         sb->st_nlink = vap->va_nlink;
1540         sb->st_uid = vap->va_uid;
1541         sb->st_gid = vap->va_gid;
1542         sb->st_rdev = vap->va_rdev;
1543         if (vap->va_size > OFF_MAX)
1544                 return (EOVERFLOW);
1545         sb->st_size = vap->va_size;
1546         sb->st_atim.tv_sec = vap->va_atime.tv_sec;
1547         sb->st_atim.tv_nsec = vap->va_atime.tv_nsec;
1548         sb->st_mtim.tv_sec = vap->va_mtime.tv_sec;
1549         sb->st_mtim.tv_nsec = vap->va_mtime.tv_nsec;
1550         sb->st_ctim.tv_sec = vap->va_ctime.tv_sec;
1551         sb->st_ctim.tv_nsec = vap->va_ctime.tv_nsec;
1552         sb->st_birthtim.tv_sec = vap->va_birthtime.tv_sec;
1553         sb->st_birthtim.tv_nsec = vap->va_birthtime.tv_nsec;
1554
1555         /*
1556          * According to www.opengroup.org, the meaning of st_blksize is
1557          *   "a filesystem-specific preferred I/O block size for this
1558          *    object.  In some filesystem types, this may vary from file
1559          *    to file"
1560          * Use minimum/default of PAGE_SIZE (e.g. for VCHR).
1561          */
1562
1563         sb->st_blksize = max(PAGE_SIZE, vap->va_blocksize);
1564
1565         sb->st_flags = vap->va_flags;
1566         if (priv_check_cred_vfs_generation(td->td_ucred))
1567                 sb->st_gen = 0;
1568         else
1569                 sb->st_gen = vap->va_gen;
1570
1571         sb->st_blocks = vap->va_bytes / S_BLKSIZE;
1572         return (0);
1573 }
1574
1575 /*
1576  * File table vnode ioctl routine.
1577  */
1578 static int
1579 vn_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
1580     struct thread *td)
1581 {
1582         struct vattr vattr;
1583         struct vnode *vp;
1584         struct fiobmap2_arg *bmarg;
1585         int error;
1586
1587         vp = fp->f_vnode;
1588         switch (vp->v_type) {
1589         case VDIR:
1590         case VREG:
1591                 switch (com) {
1592                 case FIONREAD:
1593                         vn_lock(vp, LK_SHARED | LK_RETRY);
1594                         error = VOP_GETATTR(vp, &vattr, active_cred);
1595                         VOP_UNLOCK(vp);
1596                         if (error == 0)
1597                                 *(int *)data = vattr.va_size - fp->f_offset;
1598                         return (error);
1599                 case FIOBMAP2:
1600                         bmarg = (struct fiobmap2_arg *)data;
1601                         vn_lock(vp, LK_SHARED | LK_RETRY);
1602 #ifdef MAC
1603                         error = mac_vnode_check_read(active_cred, fp->f_cred,
1604                             vp);
1605                         if (error == 0)
1606 #endif
1607                                 error = VOP_BMAP(vp, bmarg->bn, NULL,
1608                                     &bmarg->bn, &bmarg->runp, &bmarg->runb);
1609                         VOP_UNLOCK(vp);
1610                         return (error);
1611                 case FIONBIO:
1612                 case FIOASYNC:
1613                         return (0);
1614                 default:
1615                         return (VOP_IOCTL(vp, com, data, fp->f_flag,
1616                             active_cred, td));
1617                 }
1618                 break;
1619         case VCHR:
1620                 return (VOP_IOCTL(vp, com, data, fp->f_flag,
1621                     active_cred, td));
1622         default:
1623                 return (ENOTTY);
1624         }
1625 }
1626
1627 /*
1628  * File table vnode poll routine.
1629  */
1630 static int
1631 vn_poll(struct file *fp, int events, struct ucred *active_cred,
1632     struct thread *td)
1633 {
1634         struct vnode *vp;
1635         int error;
1636
1637         vp = fp->f_vnode;
1638 #if defined(MAC) || defined(AUDIT)
1639         if (AUDITING_TD(td) || mac_vnode_check_poll_enabled()) {
1640                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
1641                 AUDIT_ARG_VNODE1(vp);
1642                 error = mac_vnode_check_poll(active_cred, fp->f_cred, vp);
1643                 VOP_UNLOCK(vp);
1644                 if (error != 0)
1645                         return (error);
1646         }
1647 #endif
1648         error = VOP_POLL(vp, events, fp->f_cred, td);
1649         return (error);
1650 }
1651
1652 /*
1653  * Acquire the requested lock and then check for validity.  LK_RETRY
1654  * permits vn_lock to return doomed vnodes.
1655  */
1656 static int __noinline
1657 _vn_lock_fallback(struct vnode *vp, int flags, const char *file, int line,
1658     int error)
1659 {
1660
1661         KASSERT((flags & LK_RETRY) == 0 || error == 0,
1662             ("vn_lock: error %d incompatible with flags %#x", error, flags));
1663
1664         if (error == 0)
1665                 VNASSERT(VN_IS_DOOMED(vp), vp, ("vnode not doomed"));
1666
1667         if ((flags & LK_RETRY) == 0) {
1668                 if (error == 0) {
1669                         VOP_UNLOCK(vp);
1670                         error = ENOENT;
1671                 }
1672                 return (error);
1673         }
1674
1675         /*
1676          * LK_RETRY case.
1677          *
1678          * Nothing to do if we got the lock.
1679          */
1680         if (error == 0)
1681                 return (0);
1682
1683         /*
1684          * Interlock was dropped by the call in _vn_lock.
1685          */
1686         flags &= ~LK_INTERLOCK;
1687         do {
1688                 error = VOP_LOCK1(vp, flags, file, line);
1689         } while (error != 0);
1690         return (0);
1691 }
1692
1693 int
1694 _vn_lock(struct vnode *vp, int flags, const char *file, int line)
1695 {
1696         int error;
1697
1698         VNASSERT((flags & LK_TYPE_MASK) != 0, vp,
1699             ("vn_lock: no locktype (%d passed)", flags));
1700         VNPASS(vp->v_holdcnt > 0, vp);
1701         error = VOP_LOCK1(vp, flags, file, line);
1702         if (__predict_false(error != 0 || VN_IS_DOOMED(vp)))
1703                 return (_vn_lock_fallback(vp, flags, file, line, error));
1704         return (0);
1705 }
1706
1707 /*
1708  * File table vnode close routine.
1709  */
1710 static int
1711 vn_closefile(struct file *fp, struct thread *td)
1712 {
1713         struct vnode *vp;
1714         struct flock lf;
1715         int error;
1716         bool ref;
1717
1718         vp = fp->f_vnode;
1719         fp->f_ops = &badfileops;
1720         ref= (fp->f_flag & FHASLOCK) != 0 && fp->f_type == DTYPE_VNODE;
1721
1722         error = vn_close1(vp, fp->f_flag, fp->f_cred, td, ref);
1723
1724         if (__predict_false(ref)) {
1725                 lf.l_whence = SEEK_SET;
1726                 lf.l_start = 0;
1727                 lf.l_len = 0;
1728                 lf.l_type = F_UNLCK;
1729                 (void) VOP_ADVLOCK(vp, fp, F_UNLCK, &lf, F_FLOCK);
1730                 vrele(vp);
1731         }
1732         return (error);
1733 }
1734
1735 /*
1736  * Preparing to start a filesystem write operation. If the operation is
1737  * permitted, then we bump the count of operations in progress and
1738  * proceed. If a suspend request is in progress, we wait until the
1739  * suspension is over, and then proceed.
1740  */
1741 static int
1742 vn_start_write_refed(struct mount *mp, int flags, bool mplocked)
1743 {
1744         int error, mflags;
1745
1746         if (__predict_true(!mplocked) && (flags & V_XSLEEP) == 0 &&
1747             vfs_op_thread_enter(mp)) {
1748                 MPASS((mp->mnt_kern_flag & MNTK_SUSPEND) == 0);
1749                 vfs_mp_count_add_pcpu(mp, writeopcount, 1);
1750                 vfs_op_thread_exit(mp);
1751                 return (0);
1752         }
1753
1754         if (mplocked)
1755                 mtx_assert(MNT_MTX(mp), MA_OWNED);
1756         else
1757                 MNT_ILOCK(mp);
1758
1759         error = 0;
1760
1761         /*
1762          * Check on status of suspension.
1763          */
1764         if ((curthread->td_pflags & TDP_IGNSUSP) == 0 ||
1765             mp->mnt_susp_owner != curthread) {
1766                 mflags = ((mp->mnt_vfc->vfc_flags & VFCF_SBDRY) != 0 ?
1767                     (flags & PCATCH) : 0) | (PUSER - 1);
1768                 while ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0) {
1769                         if (flags & V_NOWAIT) {
1770                                 error = EWOULDBLOCK;
1771                                 goto unlock;
1772                         }
1773                         error = msleep(&mp->mnt_flag, MNT_MTX(mp), mflags,
1774                             "suspfs", 0);
1775                         if (error)
1776                                 goto unlock;
1777                 }
1778         }
1779         if (flags & V_XSLEEP)
1780                 goto unlock;
1781         mp->mnt_writeopcount++;
1782 unlock:
1783         if (error != 0 || (flags & V_XSLEEP) != 0)
1784                 MNT_REL(mp);
1785         MNT_IUNLOCK(mp);
1786         return (error);
1787 }
1788
1789 int
1790 vn_start_write(struct vnode *vp, struct mount **mpp, int flags)
1791 {
1792         struct mount *mp;
1793         int error;
1794
1795         KASSERT((flags & V_MNTREF) == 0 || (*mpp != NULL && vp == NULL),
1796             ("V_MNTREF requires mp"));
1797
1798         error = 0;
1799         /*
1800          * If a vnode is provided, get and return the mount point that
1801          * to which it will write.
1802          */
1803         if (vp != NULL) {
1804                 if ((error = VOP_GETWRITEMOUNT(vp, mpp)) != 0) {
1805                         *mpp = NULL;
1806                         if (error != EOPNOTSUPP)
1807                                 return (error);
1808                         return (0);
1809                 }
1810         }
1811         if ((mp = *mpp) == NULL)
1812                 return (0);
1813
1814         /*
1815          * VOP_GETWRITEMOUNT() returns with the mp refcount held through
1816          * a vfs_ref().
1817          * As long as a vnode is not provided we need to acquire a
1818          * refcount for the provided mountpoint too, in order to
1819          * emulate a vfs_ref().
1820          */
1821         if (vp == NULL && (flags & V_MNTREF) == 0)
1822                 vfs_ref(mp);
1823
1824         return (vn_start_write_refed(mp, flags, false));
1825 }
1826
1827 /*
1828  * Secondary suspension. Used by operations such as vop_inactive
1829  * routines that are needed by the higher level functions. These
1830  * are allowed to proceed until all the higher level functions have
1831  * completed (indicated by mnt_writeopcount dropping to zero). At that
1832  * time, these operations are halted until the suspension is over.
1833  */
1834 int
1835 vn_start_secondary_write(struct vnode *vp, struct mount **mpp, int flags)
1836 {
1837         struct mount *mp;
1838         int error;
1839
1840         KASSERT((flags & V_MNTREF) == 0 || (*mpp != NULL && vp == NULL),
1841             ("V_MNTREF requires mp"));
1842
1843  retry:
1844         if (vp != NULL) {
1845                 if ((error = VOP_GETWRITEMOUNT(vp, mpp)) != 0) {
1846                         *mpp = NULL;
1847                         if (error != EOPNOTSUPP)
1848                                 return (error);
1849                         return (0);
1850                 }
1851         }
1852         /*
1853          * If we are not suspended or have not yet reached suspended
1854          * mode, then let the operation proceed.
1855          */
1856         if ((mp = *mpp) == NULL)
1857                 return (0);
1858
1859         /*
1860          * VOP_GETWRITEMOUNT() returns with the mp refcount held through
1861          * a vfs_ref().
1862          * As long as a vnode is not provided we need to acquire a
1863          * refcount for the provided mountpoint too, in order to
1864          * emulate a vfs_ref().
1865          */
1866         MNT_ILOCK(mp);
1867         if (vp == NULL && (flags & V_MNTREF) == 0)
1868                 MNT_REF(mp);
1869         if ((mp->mnt_kern_flag & (MNTK_SUSPENDED | MNTK_SUSPEND2)) == 0) {
1870                 mp->mnt_secondary_writes++;
1871                 mp->mnt_secondary_accwrites++;
1872                 MNT_IUNLOCK(mp);
1873                 return (0);
1874         }
1875         if (flags & V_NOWAIT) {
1876                 MNT_REL(mp);
1877                 MNT_IUNLOCK(mp);
1878                 return (EWOULDBLOCK);
1879         }
1880         /*
1881          * Wait for the suspension to finish.
1882          */
1883         error = msleep(&mp->mnt_flag, MNT_MTX(mp), (PUSER - 1) | PDROP |
1884             ((mp->mnt_vfc->vfc_flags & VFCF_SBDRY) != 0 ? (flags & PCATCH) : 0),
1885             "suspfs", 0);
1886         vfs_rel(mp);
1887         if (error == 0)
1888                 goto retry;
1889         return (error);
1890 }
1891
1892 /*
1893  * Filesystem write operation has completed. If we are suspending and this
1894  * operation is the last one, notify the suspender that the suspension is
1895  * now in effect.
1896  */
1897 void
1898 vn_finished_write(struct mount *mp)
1899 {
1900         int c;
1901
1902         if (mp == NULL)
1903                 return;
1904
1905         if (vfs_op_thread_enter(mp)) {
1906                 vfs_mp_count_sub_pcpu(mp, writeopcount, 1);
1907                 vfs_mp_count_sub_pcpu(mp, ref, 1);
1908                 vfs_op_thread_exit(mp);
1909                 return;
1910         }
1911
1912         MNT_ILOCK(mp);
1913         vfs_assert_mount_counters(mp);
1914         MNT_REL(mp);
1915         c = --mp->mnt_writeopcount;
1916         if (mp->mnt_vfs_ops == 0) {
1917                 MPASS((mp->mnt_kern_flag & MNTK_SUSPEND) == 0);
1918                 MNT_IUNLOCK(mp);
1919                 return;
1920         }
1921         if (c < 0)
1922                 vfs_dump_mount_counters(mp);
1923         if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0 && c == 0)
1924                 wakeup(&mp->mnt_writeopcount);
1925         MNT_IUNLOCK(mp);
1926 }
1927
1928 /*
1929  * Filesystem secondary write operation has completed. If we are
1930  * suspending and this operation is the last one, notify the suspender
1931  * that the suspension is now in effect.
1932  */
1933 void
1934 vn_finished_secondary_write(struct mount *mp)
1935 {
1936         if (mp == NULL)
1937                 return;
1938         MNT_ILOCK(mp);
1939         MNT_REL(mp);
1940         mp->mnt_secondary_writes--;
1941         if (mp->mnt_secondary_writes < 0)
1942                 panic("vn_finished_secondary_write: neg cnt");
1943         if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0 &&
1944             mp->mnt_secondary_writes <= 0)
1945                 wakeup(&mp->mnt_secondary_writes);
1946         MNT_IUNLOCK(mp);
1947 }
1948
1949 /*
1950  * Request a filesystem to suspend write operations.
1951  */
1952 int
1953 vfs_write_suspend(struct mount *mp, int flags)
1954 {
1955         int error;
1956
1957         vfs_op_enter(mp);
1958
1959         MNT_ILOCK(mp);
1960         vfs_assert_mount_counters(mp);
1961         if (mp->mnt_susp_owner == curthread) {
1962                 vfs_op_exit_locked(mp);
1963                 MNT_IUNLOCK(mp);
1964                 return (EALREADY);
1965         }
1966         while (mp->mnt_kern_flag & MNTK_SUSPEND)
1967                 msleep(&mp->mnt_flag, MNT_MTX(mp), PUSER - 1, "wsuspfs", 0);
1968
1969         /*
1970          * Unmount holds a write reference on the mount point.  If we
1971          * own busy reference and drain for writers, we deadlock with
1972          * the reference draining in the unmount path.  Callers of
1973          * vfs_write_suspend() must specify VS_SKIP_UNMOUNT if
1974          * vfs_busy() reference is owned and caller is not in the
1975          * unmount context.
1976          */
1977         if ((flags & VS_SKIP_UNMOUNT) != 0 &&
1978             (mp->mnt_kern_flag & MNTK_UNMOUNT) != 0) {
1979                 vfs_op_exit_locked(mp);
1980                 MNT_IUNLOCK(mp);
1981                 return (EBUSY);
1982         }
1983
1984         mp->mnt_kern_flag |= MNTK_SUSPEND;
1985         mp->mnt_susp_owner = curthread;
1986         if (mp->mnt_writeopcount > 0)
1987                 (void) msleep(&mp->mnt_writeopcount,
1988                     MNT_MTX(mp), (PUSER - 1)|PDROP, "suspwt", 0);
1989         else
1990                 MNT_IUNLOCK(mp);
1991         if ((error = VFS_SYNC(mp, MNT_SUSPEND)) != 0) {
1992                 vfs_write_resume(mp, 0);
1993                 /* vfs_write_resume does vfs_op_exit() for us */
1994         }
1995         return (error);
1996 }
1997
1998 /*
1999  * Request a filesystem to resume write operations.
2000  */
2001 void
2002 vfs_write_resume(struct mount *mp, int flags)
2003 {
2004
2005         MNT_ILOCK(mp);
2006         if ((mp->mnt_kern_flag & MNTK_SUSPEND) != 0) {
2007                 KASSERT(mp->mnt_susp_owner == curthread, ("mnt_susp_owner"));
2008                 mp->mnt_kern_flag &= ~(MNTK_SUSPEND | MNTK_SUSPEND2 |
2009                                        MNTK_SUSPENDED);
2010                 mp->mnt_susp_owner = NULL;
2011                 wakeup(&mp->mnt_writeopcount);
2012                 wakeup(&mp->mnt_flag);
2013                 curthread->td_pflags &= ~TDP_IGNSUSP;
2014                 if ((flags & VR_START_WRITE) != 0) {
2015                         MNT_REF(mp);
2016                         mp->mnt_writeopcount++;
2017                 }
2018                 MNT_IUNLOCK(mp);
2019                 if ((flags & VR_NO_SUSPCLR) == 0)
2020                         VFS_SUSP_CLEAN(mp);
2021                 vfs_op_exit(mp);
2022         } else if ((flags & VR_START_WRITE) != 0) {
2023                 MNT_REF(mp);
2024                 vn_start_write_refed(mp, 0, true);
2025         } else {
2026                 MNT_IUNLOCK(mp);
2027         }
2028 }
2029
2030 /*
2031  * Helper loop around vfs_write_suspend() for filesystem unmount VFS
2032  * methods.
2033  */
2034 int
2035 vfs_write_suspend_umnt(struct mount *mp)
2036 {
2037         int error;
2038
2039         KASSERT((curthread->td_pflags & TDP_IGNSUSP) == 0,
2040             ("vfs_write_suspend_umnt: recursed"));
2041
2042         /* dounmount() already called vn_start_write(). */
2043         for (;;) {
2044                 vn_finished_write(mp);
2045                 error = vfs_write_suspend(mp, 0);
2046                 if (error != 0) {
2047                         vn_start_write(NULL, &mp, V_WAIT);
2048                         return (error);
2049                 }
2050                 MNT_ILOCK(mp);
2051                 if ((mp->mnt_kern_flag & MNTK_SUSPENDED) != 0)
2052                         break;
2053                 MNT_IUNLOCK(mp);
2054                 vn_start_write(NULL, &mp, V_WAIT);
2055         }
2056         mp->mnt_kern_flag &= ~(MNTK_SUSPENDED | MNTK_SUSPEND2);
2057         wakeup(&mp->mnt_flag);
2058         MNT_IUNLOCK(mp);
2059         curthread->td_pflags |= TDP_IGNSUSP;
2060         return (0);
2061 }
2062
2063 /*
2064  * Implement kqueues for files by translating it to vnode operation.
2065  */
2066 static int
2067 vn_kqfilter(struct file *fp, struct knote *kn)
2068 {
2069
2070         return (VOP_KQFILTER(fp->f_vnode, kn));
2071 }
2072
2073 /*
2074  * Simplified in-kernel wrapper calls for extended attribute access.
2075  * Both calls pass in a NULL credential, authorizing as "kernel" access.
2076  * Set IO_NODELOCKED in ioflg if the vnode is already locked.
2077  */
2078 int
2079 vn_extattr_get(struct vnode *vp, int ioflg, int attrnamespace,
2080     const char *attrname, int *buflen, char *buf, struct thread *td)
2081 {
2082         struct uio      auio;
2083         struct iovec    iov;
2084         int     error;
2085
2086         iov.iov_len = *buflen;
2087         iov.iov_base = buf;
2088
2089         auio.uio_iov = &iov;
2090         auio.uio_iovcnt = 1;
2091         auio.uio_rw = UIO_READ;
2092         auio.uio_segflg = UIO_SYSSPACE;
2093         auio.uio_td = td;
2094         auio.uio_offset = 0;
2095         auio.uio_resid = *buflen;
2096
2097         if ((ioflg & IO_NODELOCKED) == 0)
2098                 vn_lock(vp, LK_SHARED | LK_RETRY);
2099
2100         ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2101
2102         /* authorize attribute retrieval as kernel */
2103         error = VOP_GETEXTATTR(vp, attrnamespace, attrname, &auio, NULL, NULL,
2104             td);
2105
2106         if ((ioflg & IO_NODELOCKED) == 0)
2107                 VOP_UNLOCK(vp);
2108
2109         if (error == 0) {
2110                 *buflen = *buflen - auio.uio_resid;
2111         }
2112
2113         return (error);
2114 }
2115
2116 /*
2117  * XXX failure mode if partially written?
2118  */
2119 int
2120 vn_extattr_set(struct vnode *vp, int ioflg, int attrnamespace,
2121     const char *attrname, int buflen, char *buf, struct thread *td)
2122 {
2123         struct uio      auio;
2124         struct iovec    iov;
2125         struct mount    *mp;
2126         int     error;
2127
2128         iov.iov_len = buflen;
2129         iov.iov_base = buf;
2130
2131         auio.uio_iov = &iov;
2132         auio.uio_iovcnt = 1;
2133         auio.uio_rw = UIO_WRITE;
2134         auio.uio_segflg = UIO_SYSSPACE;
2135         auio.uio_td = td;
2136         auio.uio_offset = 0;
2137         auio.uio_resid = buflen;
2138
2139         if ((ioflg & IO_NODELOCKED) == 0) {
2140                 if ((error = vn_start_write(vp, &mp, V_WAIT)) != 0)
2141                         return (error);
2142                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2143         }
2144
2145         ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2146
2147         /* authorize attribute setting as kernel */
2148         error = VOP_SETEXTATTR(vp, attrnamespace, attrname, &auio, NULL, td);
2149
2150         if ((ioflg & IO_NODELOCKED) == 0) {
2151                 vn_finished_write(mp);
2152                 VOP_UNLOCK(vp);
2153         }
2154
2155         return (error);
2156 }
2157
2158 int
2159 vn_extattr_rm(struct vnode *vp, int ioflg, int attrnamespace,
2160     const char *attrname, struct thread *td)
2161 {
2162         struct mount    *mp;
2163         int     error;
2164
2165         if ((ioflg & IO_NODELOCKED) == 0) {
2166                 if ((error = vn_start_write(vp, &mp, V_WAIT)) != 0)
2167                         return (error);
2168                 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2169         }
2170
2171         ASSERT_VOP_LOCKED(vp, "IO_NODELOCKED with no vp lock held");
2172
2173         /* authorize attribute removal as kernel */
2174         error = VOP_DELETEEXTATTR(vp, attrnamespace, attrname, NULL, td);
2175         if (error == EOPNOTSUPP)
2176                 error = VOP_SETEXTATTR(vp, attrnamespace, attrname, NULL,
2177                     NULL, td);
2178
2179         if ((ioflg & IO_NODELOCKED) == 0) {
2180                 vn_finished_write(mp);
2181                 VOP_UNLOCK(vp);
2182         }
2183
2184         return (error);
2185 }
2186
2187 static int
2188 vn_get_ino_alloc_vget(struct mount *mp, void *arg, int lkflags,
2189     struct vnode **rvp)
2190 {
2191
2192         return (VFS_VGET(mp, *(ino_t *)arg, lkflags, rvp));
2193 }
2194
2195 int
2196 vn_vget_ino(struct vnode *vp, ino_t ino, int lkflags, struct vnode **rvp)
2197 {
2198
2199         return (vn_vget_ino_gen(vp, vn_get_ino_alloc_vget, &ino,
2200             lkflags, rvp));
2201 }
2202
2203 int
2204 vn_vget_ino_gen(struct vnode *vp, vn_get_ino_t alloc, void *alloc_arg,
2205     int lkflags, struct vnode **rvp)
2206 {
2207         struct mount *mp;
2208         int ltype, error;
2209
2210         ASSERT_VOP_LOCKED(vp, "vn_vget_ino_get");
2211         mp = vp->v_mount;
2212         ltype = VOP_ISLOCKED(vp);
2213         KASSERT(ltype == LK_EXCLUSIVE || ltype == LK_SHARED,
2214             ("vn_vget_ino: vp not locked"));
2215         error = vfs_busy(mp, MBF_NOWAIT);
2216         if (error != 0) {
2217                 vfs_ref(mp);
2218                 VOP_UNLOCK(vp);
2219                 error = vfs_busy(mp, 0);
2220                 vn_lock(vp, ltype | LK_RETRY);
2221                 vfs_rel(mp);
2222                 if (error != 0)
2223                         return (ENOENT);
2224                 if (VN_IS_DOOMED(vp)) {
2225                         vfs_unbusy(mp);
2226                         return (ENOENT);
2227                 }
2228         }
2229         VOP_UNLOCK(vp);
2230         error = alloc(mp, alloc_arg, lkflags, rvp);
2231         vfs_unbusy(mp);
2232         if (error != 0 || *rvp != vp)
2233                 vn_lock(vp, ltype | LK_RETRY);
2234         if (VN_IS_DOOMED(vp)) {
2235                 if (error == 0) {
2236                         if (*rvp == vp)
2237                                 vunref(vp);
2238                         else
2239                                 vput(*rvp);
2240                 }
2241                 error = ENOENT;
2242         }
2243         return (error);
2244 }
2245
2246 int
2247 vn_rlimit_fsize(const struct vnode *vp, const struct uio *uio,
2248     struct thread *td)
2249 {
2250
2251         if (vp->v_type != VREG || td == NULL)
2252                 return (0);
2253         if ((uoff_t)uio->uio_offset + uio->uio_resid >
2254             lim_cur(td, RLIMIT_FSIZE)) {
2255                 PROC_LOCK(td->td_proc);
2256                 kern_psignal(td->td_proc, SIGXFSZ);
2257                 PROC_UNLOCK(td->td_proc);
2258                 return (EFBIG);
2259         }
2260         return (0);
2261 }
2262
2263 int
2264 vn_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
2265     struct thread *td)
2266 {
2267         struct vnode *vp;
2268
2269         vp = fp->f_vnode;
2270 #ifdef AUDIT
2271         vn_lock(vp, LK_SHARED | LK_RETRY);
2272         AUDIT_ARG_VNODE1(vp);
2273         VOP_UNLOCK(vp);
2274 #endif
2275         return (setfmode(td, active_cred, vp, mode));
2276 }
2277
2278 int
2279 vn_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
2280     struct thread *td)
2281 {
2282         struct vnode *vp;
2283
2284         vp = fp->f_vnode;
2285 #ifdef AUDIT
2286         vn_lock(vp, LK_SHARED | LK_RETRY);
2287         AUDIT_ARG_VNODE1(vp);
2288         VOP_UNLOCK(vp);
2289 #endif
2290         return (setfown(td, active_cred, vp, uid, gid));
2291 }
2292
2293 void
2294 vn_pages_remove(struct vnode *vp, vm_pindex_t start, vm_pindex_t end)
2295 {
2296         vm_object_t object;
2297
2298         if ((object = vp->v_object) == NULL)
2299                 return;
2300         VM_OBJECT_WLOCK(object);
2301         vm_object_page_remove(object, start, end, 0);
2302         VM_OBJECT_WUNLOCK(object);
2303 }
2304
2305 int
2306 vn_bmap_seekhole(struct vnode *vp, u_long cmd, off_t *off, struct ucred *cred)
2307 {
2308         struct vattr va;
2309         daddr_t bn, bnp;
2310         uint64_t bsize;
2311         off_t noff;
2312         int error;
2313
2314         KASSERT(cmd == FIOSEEKHOLE || cmd == FIOSEEKDATA,
2315             ("Wrong command %lu", cmd));
2316
2317         if (vn_lock(vp, LK_SHARED) != 0)
2318                 return (EBADF);
2319         if (vp->v_type != VREG) {
2320                 error = ENOTTY;
2321                 goto unlock;
2322         }
2323         error = VOP_GETATTR(vp, &va, cred);
2324         if (error != 0)
2325                 goto unlock;
2326         noff = *off;
2327         if (noff >= va.va_size) {
2328                 error = ENXIO;
2329                 goto unlock;
2330         }
2331         bsize = vp->v_mount->mnt_stat.f_iosize;
2332         for (bn = noff / bsize; noff < va.va_size; bn++, noff += bsize -
2333             noff % bsize) {
2334                 error = VOP_BMAP(vp, bn, NULL, &bnp, NULL, NULL);
2335                 if (error == EOPNOTSUPP) {
2336                         error = ENOTTY;
2337                         goto unlock;
2338                 }
2339                 if ((bnp == -1 && cmd == FIOSEEKHOLE) ||
2340                     (bnp != -1 && cmd == FIOSEEKDATA)) {
2341                         noff = bn * bsize;
2342                         if (noff < *off)
2343                                 noff = *off;
2344                         goto unlock;
2345                 }
2346         }
2347         if (noff > va.va_size)
2348                 noff = va.va_size;
2349         /* noff == va.va_size. There is an implicit hole at the end of file. */
2350         if (cmd == FIOSEEKDATA)
2351                 error = ENXIO;
2352 unlock:
2353         VOP_UNLOCK(vp);
2354         if (error == 0)
2355                 *off = noff;
2356         return (error);
2357 }
2358
2359 int
2360 vn_seek(struct file *fp, off_t offset, int whence, struct thread *td)
2361 {
2362         struct ucred *cred;
2363         struct vnode *vp;
2364         struct vattr vattr;
2365         off_t foffset, size;
2366         int error, noneg;
2367
2368         cred = td->td_ucred;
2369         vp = fp->f_vnode;
2370         foffset = foffset_lock(fp, 0);
2371         noneg = (vp->v_type != VCHR);
2372         error = 0;
2373         switch (whence) {
2374         case L_INCR:
2375                 if (noneg &&
2376                     (foffset < 0 ||
2377                     (offset > 0 && foffset > OFF_MAX - offset))) {
2378                         error = EOVERFLOW;
2379                         break;
2380                 }
2381                 offset += foffset;
2382                 break;
2383         case L_XTND:
2384                 vn_lock(vp, LK_SHARED | LK_RETRY);
2385                 error = VOP_GETATTR(vp, &vattr, cred);
2386                 VOP_UNLOCK(vp);
2387                 if (error)
2388                         break;
2389
2390                 /*
2391                  * If the file references a disk device, then fetch
2392                  * the media size and use that to determine the ending
2393                  * offset.
2394                  */
2395                 if (vattr.va_size == 0 && vp->v_type == VCHR &&
2396                     fo_ioctl(fp, DIOCGMEDIASIZE, &size, cred, td) == 0)
2397                         vattr.va_size = size;
2398                 if (noneg &&
2399                     (vattr.va_size > OFF_MAX ||
2400                     (offset > 0 && vattr.va_size > OFF_MAX - offset))) {
2401                         error = EOVERFLOW;
2402                         break;
2403                 }
2404                 offset += vattr.va_size;
2405                 break;
2406         case L_SET:
2407                 break;
2408         case SEEK_DATA:
2409                 error = fo_ioctl(fp, FIOSEEKDATA, &offset, cred, td);
2410                 if (error == ENOTTY)
2411                         error = EINVAL;
2412                 break;
2413         case SEEK_HOLE:
2414                 error = fo_ioctl(fp, FIOSEEKHOLE, &offset, cred, td);
2415                 if (error == ENOTTY)
2416                         error = EINVAL;
2417                 break;
2418         default:
2419                 error = EINVAL;
2420         }
2421         if (error == 0 && noneg && offset < 0)
2422                 error = EINVAL;
2423         if (error != 0)
2424                 goto drop;
2425         VFS_KNOTE_UNLOCKED(vp, 0);
2426         td->td_uretoff.tdu_off = offset;
2427 drop:
2428         foffset_unlock(fp, offset, error != 0 ? FOF_NOUPDATE : 0);
2429         return (error);
2430 }
2431
2432 int
2433 vn_utimes_perm(struct vnode *vp, struct vattr *vap, struct ucred *cred,
2434     struct thread *td)
2435 {
2436         int error;
2437
2438         /*
2439          * Grant permission if the caller is the owner of the file, or
2440          * the super-user, or has ACL_WRITE_ATTRIBUTES permission on
2441          * on the file.  If the time pointer is null, then write
2442          * permission on the file is also sufficient.
2443          *
2444          * From NFSv4.1, draft 21, 6.2.1.3.1, Discussion of Mask Attributes:
2445          * A user having ACL_WRITE_DATA or ACL_WRITE_ATTRIBUTES
2446          * will be allowed to set the times [..] to the current
2447          * server time.
2448          */
2449         error = VOP_ACCESSX(vp, VWRITE_ATTRIBUTES, cred, td);
2450         if (error != 0 && (vap->va_vaflags & VA_UTIMES_NULL) != 0)
2451                 error = VOP_ACCESS(vp, VWRITE, cred, td);
2452         return (error);
2453 }
2454
2455 int
2456 vn_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
2457 {
2458         struct vnode *vp;
2459         int error;
2460
2461         if (fp->f_type == DTYPE_FIFO)
2462                 kif->kf_type = KF_TYPE_FIFO;
2463         else
2464                 kif->kf_type = KF_TYPE_VNODE;
2465         vp = fp->f_vnode;
2466         vref(vp);
2467         FILEDESC_SUNLOCK(fdp);
2468         error = vn_fill_kinfo_vnode(vp, kif);
2469         vrele(vp);
2470         FILEDESC_SLOCK(fdp);
2471         return (error);
2472 }
2473
2474 static inline void
2475 vn_fill_junk(struct kinfo_file *kif)
2476 {
2477         size_t len, olen;
2478
2479         /*
2480          * Simulate vn_fullpath returning changing values for a given
2481          * vp during e.g. coredump.
2482          */
2483         len = (arc4random() % (sizeof(kif->kf_path) - 2)) + 1;
2484         olen = strlen(kif->kf_path);
2485         if (len < olen)
2486                 strcpy(&kif->kf_path[len - 1], "$");
2487         else
2488                 for (; olen < len; olen++)
2489                         strcpy(&kif->kf_path[olen], "A");
2490 }
2491
2492 int
2493 vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif)
2494 {
2495         struct vattr va;
2496         char *fullpath, *freepath;
2497         int error;
2498
2499         kif->kf_un.kf_file.kf_file_type = vntype_to_kinfo(vp->v_type);
2500         freepath = NULL;
2501         fullpath = "-";
2502         error = vn_fullpath(curthread, vp, &fullpath, &freepath);
2503         if (error == 0) {
2504                 strlcpy(kif->kf_path, fullpath, sizeof(kif->kf_path));
2505         }
2506         if (freepath != NULL)
2507                 free(freepath, M_TEMP);
2508
2509         KFAIL_POINT_CODE(DEBUG_FP, fill_kinfo_vnode__random_path,
2510                 vn_fill_junk(kif);
2511         );
2512
2513         /*
2514          * Retrieve vnode attributes.
2515          */
2516         va.va_fsid = VNOVAL;
2517         va.va_rdev = NODEV;
2518         vn_lock(vp, LK_SHARED | LK_RETRY);
2519         error = VOP_GETATTR(vp, &va, curthread->td_ucred);
2520         VOP_UNLOCK(vp);
2521         if (error != 0)
2522                 return (error);
2523         if (va.va_fsid != VNOVAL)
2524                 kif->kf_un.kf_file.kf_file_fsid = va.va_fsid;
2525         else
2526                 kif->kf_un.kf_file.kf_file_fsid =
2527                     vp->v_mount->mnt_stat.f_fsid.val[0];
2528         kif->kf_un.kf_file.kf_file_fsid_freebsd11 =
2529             kif->kf_un.kf_file.kf_file_fsid; /* truncate */
2530         kif->kf_un.kf_file.kf_file_fileid = va.va_fileid;
2531         kif->kf_un.kf_file.kf_file_mode = MAKEIMODE(va.va_type, va.va_mode);
2532         kif->kf_un.kf_file.kf_file_size = va.va_size;
2533         kif->kf_un.kf_file.kf_file_rdev = va.va_rdev;
2534         kif->kf_un.kf_file.kf_file_rdev_freebsd11 =
2535             kif->kf_un.kf_file.kf_file_rdev; /* truncate */
2536         return (0);
2537 }
2538
2539 int
2540 vn_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size,
2541     vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff,
2542     struct thread *td)
2543 {
2544 #ifdef HWPMC_HOOKS
2545         struct pmckern_map_in pkm;
2546 #endif
2547         struct mount *mp;
2548         struct vnode *vp;
2549         vm_object_t object;
2550         vm_prot_t maxprot;
2551         boolean_t writecounted;
2552         int error;
2553
2554 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \
2555     defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4)
2556         /*
2557          * POSIX shared-memory objects are defined to have
2558          * kernel persistence, and are not defined to support
2559          * read(2)/write(2) -- or even open(2).  Thus, we can
2560          * use MAP_ASYNC to trade on-disk coherence for speed.
2561          * The shm_open(3) library routine turns on the FPOSIXSHM
2562          * flag to request this behavior.
2563          */
2564         if ((fp->f_flag & FPOSIXSHM) != 0)
2565                 flags |= MAP_NOSYNC;
2566 #endif
2567         vp = fp->f_vnode;
2568
2569         /*
2570          * Ensure that file and memory protections are
2571          * compatible.  Note that we only worry about
2572          * writability if mapping is shared; in this case,
2573          * current and max prot are dictated by the open file.
2574          * XXX use the vnode instead?  Problem is: what
2575          * credentials do we use for determination? What if
2576          * proc does a setuid?
2577          */
2578         mp = vp->v_mount;
2579         if (mp != NULL && (mp->mnt_flag & MNT_NOEXEC) != 0) {
2580                 maxprot = VM_PROT_NONE;
2581                 if ((prot & VM_PROT_EXECUTE) != 0)
2582                         return (EACCES);
2583         } else
2584                 maxprot = VM_PROT_EXECUTE;
2585         if ((fp->f_flag & FREAD) != 0)
2586                 maxprot |= VM_PROT_READ;
2587         else if ((prot & VM_PROT_READ) != 0)
2588                 return (EACCES);
2589
2590         /*
2591          * If we are sharing potential changes via MAP_SHARED and we
2592          * are trying to get write permission although we opened it
2593          * without asking for it, bail out.
2594          */
2595         if ((flags & MAP_SHARED) != 0) {
2596                 if ((fp->f_flag & FWRITE) != 0)
2597                         maxprot |= VM_PROT_WRITE;
2598                 else if ((prot & VM_PROT_WRITE) != 0)
2599                         return (EACCES);
2600         } else {
2601                 maxprot |= VM_PROT_WRITE;
2602                 cap_maxprot |= VM_PROT_WRITE;
2603         }
2604         maxprot &= cap_maxprot;
2605
2606         /*
2607          * For regular files and shared memory, POSIX requires that
2608          * the value of foff be a legitimate offset within the data
2609          * object.  In particular, negative offsets are invalid.
2610          * Blocking negative offsets and overflows here avoids
2611          * possible wraparound or user-level access into reserved
2612          * ranges of the data object later.  In contrast, POSIX does
2613          * not dictate how offsets are used by device drivers, so in
2614          * the case of a device mapping a negative offset is passed
2615          * on.
2616          */
2617         if (
2618 #ifdef _LP64
2619             size > OFF_MAX ||
2620 #endif
2621             foff < 0 || foff > OFF_MAX - size)
2622                 return (EINVAL);
2623
2624         writecounted = FALSE;
2625         error = vm_mmap_vnode(td, size, prot, &maxprot, &flags, vp,
2626             &foff, &object, &writecounted);
2627         if (error != 0)
2628                 return (error);
2629         error = vm_mmap_object(map, addr, size, prot, maxprot, flags, object,
2630             foff, writecounted, td);
2631         if (error != 0) {
2632                 /*
2633                  * If this mapping was accounted for in the vnode's
2634                  * writecount, then undo that now.
2635                  */
2636                 if (writecounted)
2637                         vm_pager_release_writecount(object, 0, size);
2638                 vm_object_deallocate(object);
2639         }
2640 #ifdef HWPMC_HOOKS
2641         /* Inform hwpmc(4) if an executable is being mapped. */
2642         if (PMC_HOOK_INSTALLED(PMC_FN_MMAP)) {
2643                 if ((prot & VM_PROT_EXECUTE) != 0 && error == 0) {
2644                         pkm.pm_file = vp;
2645                         pkm.pm_address = (uintptr_t) *addr;
2646                         PMC_CALL_HOOK_UNLOCKED(td, PMC_FN_MMAP, (void *) &pkm);
2647                 }
2648         }
2649 #endif
2650         return (error);
2651 }
2652
2653 void
2654 vn_fsid(struct vnode *vp, struct vattr *va)
2655 {
2656         fsid_t *f;
2657
2658         f = &vp->v_mount->mnt_stat.f_fsid;
2659         va->va_fsid = (uint32_t)f->val[1];
2660         va->va_fsid <<= sizeof(f->val[1]) * NBBY;
2661         va->va_fsid += (uint32_t)f->val[0];
2662 }
2663
2664 int
2665 vn_fsync_buf(struct vnode *vp, int waitfor)
2666 {
2667         struct buf *bp, *nbp;
2668         struct bufobj *bo;
2669         struct mount *mp;
2670         int error, maxretry;
2671
2672         error = 0;
2673         maxretry = 10000;     /* large, arbitrarily chosen */
2674         mp = NULL;
2675         if (vp->v_type == VCHR) {
2676                 VI_LOCK(vp);
2677                 mp = vp->v_rdev->si_mountpt;
2678                 VI_UNLOCK(vp);
2679         }
2680         bo = &vp->v_bufobj;
2681         BO_LOCK(bo);
2682 loop1:
2683         /*
2684          * MARK/SCAN initialization to avoid infinite loops.
2685          */
2686         TAILQ_FOREACH(bp, &bo->bo_dirty.bv_hd, b_bobufs) {
2687                 bp->b_vflags &= ~BV_SCANNED;
2688                 bp->b_error = 0;
2689         }
2690
2691         /*
2692          * Flush all dirty buffers associated with a vnode.
2693          */
2694 loop2:
2695         TAILQ_FOREACH_SAFE(bp, &bo->bo_dirty.bv_hd, b_bobufs, nbp) {
2696                 if ((bp->b_vflags & BV_SCANNED) != 0)
2697                         continue;
2698                 bp->b_vflags |= BV_SCANNED;
2699                 if (BUF_LOCK(bp, LK_EXCLUSIVE | LK_NOWAIT, NULL)) {
2700                         if (waitfor != MNT_WAIT)
2701                                 continue;
2702                         if (BUF_LOCK(bp,
2703                             LK_EXCLUSIVE | LK_INTERLOCK | LK_SLEEPFAIL,
2704                             BO_LOCKPTR(bo)) != 0) {
2705                                 BO_LOCK(bo);
2706                                 goto loop1;
2707                         }
2708                         BO_LOCK(bo);
2709                 }
2710                 BO_UNLOCK(bo);
2711                 KASSERT(bp->b_bufobj == bo,
2712                     ("bp %p wrong b_bufobj %p should be %p",
2713                     bp, bp->b_bufobj, bo));
2714                 if ((bp->b_flags & B_DELWRI) == 0)
2715                         panic("fsync: not dirty");
2716                 if ((vp->v_object != NULL) && (bp->b_flags & B_CLUSTEROK)) {
2717                         vfs_bio_awrite(bp);
2718                 } else {
2719                         bremfree(bp);
2720                         bawrite(bp);
2721                 }
2722                 if (maxretry < 1000)
2723                         pause("dirty", hz < 1000 ? 1 : hz / 1000);
2724                 BO_LOCK(bo);
2725                 goto loop2;
2726         }
2727
2728         /*
2729          * If synchronous the caller expects us to completely resolve all
2730          * dirty buffers in the system.  Wait for in-progress I/O to
2731          * complete (which could include background bitmap writes), then
2732          * retry if dirty blocks still exist.
2733          */
2734         if (waitfor == MNT_WAIT) {
2735                 bufobj_wwait(bo, 0, 0);
2736                 if (bo->bo_dirty.bv_cnt > 0) {
2737                         /*
2738                          * If we are unable to write any of these buffers
2739                          * then we fail now rather than trying endlessly
2740                          * to write them out.
2741                          */
2742                         TAILQ_FOREACH(bp, &bo->bo_dirty.bv_hd, b_bobufs)
2743                                 if ((error = bp->b_error) != 0)
2744                                         break;
2745                         if ((mp != NULL && mp->mnt_secondary_writes > 0) ||
2746                             (error == 0 && --maxretry >= 0))
2747                                 goto loop1;
2748                         if (error == 0)
2749                                 error = EAGAIN;
2750                 }
2751         }
2752         BO_UNLOCK(bo);
2753         if (error != 0)
2754                 vn_printf(vp, "fsync: giving up on dirty (error = %d) ", error);
2755
2756         return (error);
2757 }
2758
2759 /*
2760  * Copies a byte range from invp to outvp.  Calls VOP_COPY_FILE_RANGE()
2761  * or vn_generic_copy_file_range() after rangelocking the byte ranges,
2762  * to do the actual copy.
2763  * vn_generic_copy_file_range() is factored out, so it can be called
2764  * from a VOP_COPY_FILE_RANGE() call as well, but handles vnodes from
2765  * different file systems.
2766  */
2767 int
2768 vn_copy_file_range(struct vnode *invp, off_t *inoffp, struct vnode *outvp,
2769     off_t *outoffp, size_t *lenp, unsigned int flags, struct ucred *incred,
2770     struct ucred *outcred, struct thread *fsize_td)
2771 {
2772         int error;
2773         size_t len;
2774         uint64_t uvalin, uvalout;
2775
2776         len = *lenp;
2777         *lenp = 0;              /* For error returns. */
2778         error = 0;
2779
2780         /* Do some sanity checks on the arguments. */
2781         uvalin = *inoffp;
2782         uvalin += len;
2783         uvalout = *outoffp;
2784         uvalout += len;
2785         if (invp->v_type == VDIR || outvp->v_type == VDIR)
2786                 error = EISDIR;
2787         else if (*inoffp < 0 || uvalin > INT64_MAX || uvalin <
2788             (uint64_t)*inoffp || *outoffp < 0 || uvalout > INT64_MAX ||
2789             uvalout < (uint64_t)*outoffp || invp->v_type != VREG ||
2790             outvp->v_type != VREG)
2791                 error = EINVAL;
2792         if (error != 0)
2793                 goto out;
2794
2795         /*
2796          * If the two vnode are for the same file system, call
2797          * VOP_COPY_FILE_RANGE(), otherwise call vn_generic_copy_file_range()
2798          * which can handle copies across multiple file systems.
2799          */
2800         *lenp = len;
2801         if (invp->v_mount == outvp->v_mount)
2802                 error = VOP_COPY_FILE_RANGE(invp, inoffp, outvp, outoffp,
2803                     lenp, flags, incred, outcred, fsize_td);
2804         else
2805                 error = vn_generic_copy_file_range(invp, inoffp, outvp,
2806                     outoffp, lenp, flags, incred, outcred, fsize_td);
2807 out:
2808         return (error);
2809 }
2810
2811 /*
2812  * Test len bytes of data starting at dat for all bytes == 0.
2813  * Return true if all bytes are zero, false otherwise.
2814  * Expects dat to be well aligned.
2815  */
2816 static bool
2817 mem_iszero(void *dat, int len)
2818 {
2819         int i;
2820         const u_int *p;
2821         const char *cp;
2822
2823         for (p = dat; len > 0; len -= sizeof(*p), p++) {
2824                 if (len >= sizeof(*p)) {
2825                         if (*p != 0)
2826                                 return (false);
2827                 } else {
2828                         cp = (const char *)p;
2829                         for (i = 0; i < len; i++, cp++)
2830                                 if (*cp != '\0')
2831                                         return (false);
2832                 }
2833         }
2834         return (true);
2835 }
2836
2837 /*
2838  * Look for a hole in the output file and, if found, adjust *outoffp
2839  * and *xferp to skip past the hole.
2840  * *xferp is the entire hole length to be written and xfer2 is how many bytes
2841  * to be written as 0's upon return.
2842  */
2843 static off_t
2844 vn_skip_hole(struct vnode *outvp, off_t xfer2, off_t *outoffp, off_t *xferp,
2845     off_t *dataoffp, off_t *holeoffp, struct ucred *cred)
2846 {
2847         int error;
2848         off_t delta;
2849
2850         if (*holeoffp == 0 || *holeoffp <= *outoffp) {
2851                 *dataoffp = *outoffp;
2852                 error = VOP_IOCTL(outvp, FIOSEEKDATA, dataoffp, 0, cred,
2853                     curthread);
2854                 if (error == 0) {
2855                         *holeoffp = *dataoffp;
2856                         error = VOP_IOCTL(outvp, FIOSEEKHOLE, holeoffp, 0, cred,
2857                             curthread);
2858                 }
2859                 if (error != 0 || *holeoffp == *dataoffp) {
2860                         /*
2861                          * Since outvp is unlocked, it may be possible for
2862                          * another thread to do a truncate(), lseek(), write()
2863                          * creating a hole at startoff between the above
2864                          * VOP_IOCTL() calls, if the other thread does not do
2865                          * rangelocking.
2866                          * If that happens, *holeoffp == *dataoffp and finding
2867                          * the hole has failed, so disable vn_skip_hole().
2868                          */
2869                         *holeoffp = -1; /* Disable use of vn_skip_hole(). */
2870                         return (xfer2);
2871                 }
2872                 KASSERT(*dataoffp >= *outoffp,
2873                     ("vn_skip_hole: dataoff=%jd < outoff=%jd",
2874                     (intmax_t)*dataoffp, (intmax_t)*outoffp));
2875                 KASSERT(*holeoffp > *dataoffp,
2876                     ("vn_skip_hole: holeoff=%jd <= dataoff=%jd",
2877                     (intmax_t)*holeoffp, (intmax_t)*dataoffp));
2878         }
2879
2880         /*
2881          * If there is a hole before the data starts, advance *outoffp and
2882          * *xferp past the hole.
2883          */
2884         if (*dataoffp > *outoffp) {
2885                 delta = *dataoffp - *outoffp;
2886                 if (delta >= *xferp) {
2887                         /* Entire *xferp is a hole. */
2888                         *outoffp += *xferp;
2889                         *xferp = 0;
2890                         return (0);
2891                 }
2892                 *xferp -= delta;
2893                 *outoffp += delta;
2894                 xfer2 = MIN(xfer2, *xferp);
2895         }
2896
2897         /*
2898          * If a hole starts before the end of this xfer2, reduce this xfer2 so
2899          * that the write ends at the start of the hole.
2900          * *holeoffp should always be greater than *outoffp, but for the
2901          * non-INVARIANTS case, check this to make sure xfer2 remains a sane
2902          * value.
2903          */
2904         if (*holeoffp > *outoffp && *holeoffp < *outoffp + xfer2)
2905                 xfer2 = *holeoffp - *outoffp;
2906         return (xfer2);
2907 }
2908
2909 /*
2910  * Write an xfer sized chunk to outvp in blksize blocks from dat.
2911  * dat is a maximum of blksize in length and can be written repeatedly in
2912  * the chunk.
2913  * If growfile == true, just grow the file via vn_truncate_locked() instead
2914  * of doing actual writes.
2915  * If checkhole == true, a hole is being punched, so skip over any hole
2916  * already in the output file.
2917  */
2918 static int
2919 vn_write_outvp(struct vnode *outvp, char *dat, off_t outoff, off_t xfer,
2920     u_long blksize, bool growfile, bool checkhole, struct ucred *cred)
2921 {
2922         struct mount *mp;
2923         off_t dataoff, holeoff, xfer2;
2924         int error, lckf;
2925
2926         /*
2927          * Loop around doing writes of blksize until write has been completed.
2928          * Lock/unlock on each loop iteration so that a bwillwrite() can be
2929          * done for each iteration, since the xfer argument can be very
2930          * large if there is a large hole to punch in the output file.
2931          */
2932         error = 0;
2933         holeoff = 0;
2934         do {
2935                 xfer2 = MIN(xfer, blksize);
2936                 if (checkhole) {
2937                         /*
2938                          * Punching a hole.  Skip writing if there is
2939                          * already a hole in the output file.
2940                          */
2941                         xfer2 = vn_skip_hole(outvp, xfer2, &outoff, &xfer,
2942                             &dataoff, &holeoff, cred);
2943                         if (xfer == 0)
2944                                 break;
2945                         if (holeoff < 0)
2946                                 checkhole = false;
2947                         KASSERT(xfer2 > 0, ("vn_write_outvp: xfer2=%jd",
2948                             (intmax_t)xfer2));
2949                 }
2950                 bwillwrite();
2951                 mp = NULL;
2952                 error = vn_start_write(outvp, &mp, V_WAIT);
2953                 if (error == 0) {
2954                         if (MNT_SHARED_WRITES(mp))
2955                                 lckf = LK_SHARED;
2956                         else
2957                                 lckf = LK_EXCLUSIVE;
2958                         error = vn_lock(outvp, lckf);
2959                 }
2960                 if (error == 0) {
2961                         if (growfile)
2962                                 error = vn_truncate_locked(outvp, outoff + xfer,
2963                                     false, cred);
2964                         else {
2965                                 error = vn_rdwr(UIO_WRITE, outvp, dat, xfer2,
2966                                     outoff, UIO_SYSSPACE, IO_NODELOCKED,
2967                                     curthread->td_ucred, cred, NULL, curthread);
2968                                 outoff += xfer2;
2969                                 xfer -= xfer2;
2970                         }
2971                         VOP_UNLOCK(outvp);
2972                 }
2973                 if (mp != NULL)
2974                         vn_finished_write(mp);
2975         } while (!growfile && xfer > 0 && error == 0);
2976         return (error);
2977 }
2978
2979 /*
2980  * Copy a byte range of one file to another.  This function can handle the
2981  * case where invp and outvp are on different file systems.
2982  * It can also be called by a VOP_COPY_FILE_RANGE() to do the work, if there
2983  * is no better file system specific way to do it.
2984  */
2985 int
2986 vn_generic_copy_file_range(struct vnode *invp, off_t *inoffp,
2987     struct vnode *outvp, off_t *outoffp, size_t *lenp, unsigned int flags,
2988     struct ucred *incred, struct ucred *outcred, struct thread *fsize_td)
2989 {
2990         struct vattr va;
2991         struct mount *mp;
2992         struct uio io;
2993         off_t startoff, endoff, xfer, xfer2;
2994         u_long blksize;
2995         int error;
2996         bool cantseek, readzeros, eof, lastblock;
2997         ssize_t aresid;
2998         size_t copylen, len, savlen;
2999         char *dat;
3000         long holein, holeout;
3001
3002         holein = holeout = 0;
3003         savlen = len = *lenp;
3004         error = 0;
3005         dat = NULL;
3006
3007         error = vn_lock(invp, LK_SHARED);
3008         if (error != 0)
3009                 goto out;
3010         if (VOP_PATHCONF(invp, _PC_MIN_HOLE_SIZE, &holein) != 0)
3011                 holein = 0;
3012         VOP_UNLOCK(invp);
3013
3014         mp = NULL;
3015         error = vn_start_write(outvp, &mp, V_WAIT);
3016         if (error == 0)
3017                 error = vn_lock(outvp, LK_EXCLUSIVE);
3018         if (error == 0) {
3019                 /*
3020                  * If fsize_td != NULL, do a vn_rlimit_fsize() call,
3021                  * now that outvp is locked.
3022                  */
3023                 if (fsize_td != NULL) {
3024                         io.uio_offset = *outoffp;
3025                         io.uio_resid = len;
3026                         error = vn_rlimit_fsize(outvp, &io, fsize_td);
3027                         if (error != 0)
3028                                 error = EFBIG;
3029                 }
3030                 if (VOP_PATHCONF(outvp, _PC_MIN_HOLE_SIZE, &holeout) != 0)
3031                         holeout = 0;
3032                 /*
3033                  * Holes that are past EOF do not need to be written as a block
3034                  * of zero bytes.  So, truncate the output file as far as
3035                  * possible and then use va.va_size to decide if writing 0
3036                  * bytes is necessary in the loop below.
3037                  */
3038                 if (error == 0)
3039                         error = VOP_GETATTR(outvp, &va, outcred);
3040                 if (error == 0 && va.va_size > *outoffp && va.va_size <=
3041                     *outoffp + len) {
3042 #ifdef MAC
3043                         error = mac_vnode_check_write(curthread->td_ucred,
3044                             outcred, outvp);
3045                         if (error == 0)
3046 #endif
3047                                 error = vn_truncate_locked(outvp, *outoffp,
3048                                     false, outcred);
3049                         if (error == 0)
3050                                 va.va_size = *outoffp;
3051                 }
3052                 VOP_UNLOCK(outvp);
3053         }
3054         if (mp != NULL)
3055                 vn_finished_write(mp);
3056         if (error != 0)
3057                 goto out;
3058
3059         /*
3060          * Set the blksize to the larger of the hole sizes for invp and outvp.
3061          * If hole sizes aren't available, set the blksize to the larger
3062          * f_iosize of invp and outvp.
3063          * This code expects the hole sizes and f_iosizes to be powers of 2.
3064          * This value is clipped at 4Kbytes and 1Mbyte.
3065          */
3066         blksize = MAX(holein, holeout);
3067         if (blksize == 0)
3068                 blksize = MAX(invp->v_mount->mnt_stat.f_iosize,
3069                     outvp->v_mount->mnt_stat.f_iosize);
3070         if (blksize < 4096)
3071                 blksize = 4096;
3072         else if (blksize > 1024 * 1024)
3073                 blksize = 1024 * 1024;
3074         dat = malloc(blksize, M_TEMP, M_WAITOK);
3075
3076         /*
3077          * If VOP_IOCTL(FIOSEEKHOLE) works for invp, use it and FIOSEEKDATA
3078          * to find holes.  Otherwise, just scan the read block for all 0s
3079          * in the inner loop where the data copying is done.
3080          * Note that some file systems such as NFSv3, NFSv4.0 and NFSv4.1 may
3081          * support holes on the server, but do not support FIOSEEKHOLE.
3082          */
3083         eof = false;
3084         while (len > 0 && error == 0 && !eof) {
3085                 endoff = 0;                     /* To shut up compilers. */
3086                 cantseek = true;
3087                 startoff = *inoffp;
3088                 copylen = len;
3089
3090                 /*
3091                  * Find the next data area.  If there is just a hole to EOF,
3092                  * FIOSEEKDATA should fail and then we drop down into the
3093                  * inner loop and create the hole on the outvp file.
3094                  * (I do not know if any file system will report a hole to
3095                  *  EOF via FIOSEEKHOLE, but I am pretty sure FIOSEEKDATA
3096                  *  will fail for those file systems.)
3097                  *
3098                  * For input files that don't support FIOSEEKDATA/FIOSEEKHOLE,
3099                  * the code just falls through to the inner copy loop.
3100                  */
3101                 error = EINVAL;
3102                 if (holein > 0)
3103                         error = VOP_IOCTL(invp, FIOSEEKDATA, &startoff, 0,
3104                             incred, curthread);
3105                 if (error == 0) {
3106                         endoff = startoff;
3107                         error = VOP_IOCTL(invp, FIOSEEKHOLE, &endoff, 0,
3108                             incred, curthread);
3109                         /*
3110                          * Since invp is unlocked, it may be possible for
3111                          * another thread to do a truncate(), lseek(), write()
3112                          * creating a hole at startoff between the above
3113                          * VOP_IOCTL() calls, if the other thread does not do
3114                          * rangelocking.
3115                          * If that happens, startoff == endoff and finding
3116                          * the hole has failed, so set an error.
3117                          */
3118                         if (error == 0 && startoff == endoff)
3119                                 error = EINVAL; /* Any error. Reset to 0. */
3120                 }
3121                 if (error == 0) {
3122                         if (startoff > *inoffp) {
3123                                 /* Found hole before data block. */
3124                                 xfer = MIN(startoff - *inoffp, len);
3125                                 if (*outoffp < va.va_size) {
3126                                         /* Must write 0s to punch hole. */
3127                                         xfer2 = MIN(va.va_size - *outoffp,
3128                                             xfer);
3129                                         memset(dat, 0, MIN(xfer2, blksize));
3130                                         error = vn_write_outvp(outvp, dat,
3131                                             *outoffp, xfer2, blksize, false,
3132                                             holeout > 0, outcred);
3133                                 }
3134
3135                                 if (error == 0 && *outoffp + xfer >
3136                                     va.va_size && xfer == len)
3137                                         /* Grow last block. */
3138                                         error = vn_write_outvp(outvp, dat,
3139                                             *outoffp, xfer, blksize, true,
3140                                             false, outcred);
3141                                 if (error == 0) {
3142                                         *inoffp += xfer;
3143                                         *outoffp += xfer;
3144                                         len -= xfer;
3145                                 }
3146                         }
3147                         copylen = MIN(len, endoff - startoff);
3148                         cantseek = false;
3149                 } else {
3150                         cantseek = true;
3151                         startoff = *inoffp;
3152                         copylen = len;
3153                         error = 0;
3154                 }
3155
3156                 xfer = blksize;
3157                 if (cantseek) {
3158                         /*
3159                          * Set first xfer to end at a block boundary, so that
3160                          * holes are more likely detected in the loop below via
3161                          * the for all bytes 0 method.
3162                          */
3163                         xfer -= (*inoffp % blksize);
3164                 }
3165                 /* Loop copying the data block. */
3166                 while (copylen > 0 && error == 0 && !eof) {
3167                         if (copylen < xfer)
3168                                 xfer = copylen;
3169                         error = vn_lock(invp, LK_SHARED);
3170                         if (error != 0)
3171                                 goto out;
3172                         error = vn_rdwr(UIO_READ, invp, dat, xfer,
3173                             startoff, UIO_SYSSPACE, IO_NODELOCKED,
3174                             curthread->td_ucred, incred, &aresid,
3175                             curthread);
3176                         VOP_UNLOCK(invp);
3177                         lastblock = false;
3178                         if (error == 0 && aresid > 0) {
3179                                 /* Stop the copy at EOF on the input file. */
3180                                 xfer -= aresid;
3181                                 eof = true;
3182                                 lastblock = true;
3183                         }
3184                         if (error == 0) {
3185                                 /*
3186                                  * Skip the write for holes past the initial EOF
3187                                  * of the output file, unless this is the last
3188                                  * write of the output file at EOF.
3189                                  */
3190                                 readzeros = cantseek ? mem_iszero(dat, xfer) :
3191                                     false;
3192                                 if (xfer == len)
3193                                         lastblock = true;
3194                                 if (!cantseek || *outoffp < va.va_size ||
3195                                     lastblock || !readzeros)
3196                                         error = vn_write_outvp(outvp, dat,
3197                                             *outoffp, xfer, blksize,
3198                                             readzeros && lastblock &&
3199                                             *outoffp >= va.va_size, false,
3200                                             outcred);
3201                                 if (error == 0) {
3202                                         *inoffp += xfer;
3203                                         startoff += xfer;
3204                                         *outoffp += xfer;
3205                                         copylen -= xfer;
3206                                         len -= xfer;
3207                                 }
3208                         }
3209                         xfer = blksize;
3210                 }
3211         }
3212 out:
3213         *lenp = savlen - len;
3214         free(dat, M_TEMP);
3215         return (error);
3216 }
3217
3218 static int
3219 vn_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td)
3220 {
3221         struct mount *mp;
3222         struct vnode *vp;
3223         off_t olen, ooffset;
3224         int error;
3225 #ifdef AUDIT
3226         int audited_vnode1 = 0;
3227 #endif
3228
3229         vp = fp->f_vnode;
3230         if (vp->v_type != VREG)
3231                 return (ENODEV);
3232
3233         /* Allocating blocks may take a long time, so iterate. */
3234         for (;;) {
3235                 olen = len;
3236                 ooffset = offset;
3237
3238                 bwillwrite();
3239                 mp = NULL;
3240                 error = vn_start_write(vp, &mp, V_WAIT | PCATCH);
3241                 if (error != 0)
3242                         break;
3243                 error = vn_lock(vp, LK_EXCLUSIVE);
3244                 if (error != 0) {
3245                         vn_finished_write(mp);
3246                         break;
3247                 }
3248 #ifdef AUDIT
3249                 if (!audited_vnode1) {
3250                         AUDIT_ARG_VNODE1(vp);
3251                         audited_vnode1 = 1;
3252                 }
3253 #endif
3254 #ifdef MAC
3255                 error = mac_vnode_check_write(td->td_ucred, fp->f_cred, vp);
3256                 if (error == 0)
3257 #endif
3258                         error = VOP_ALLOCATE(vp, &offset, &len);
3259                 VOP_UNLOCK(vp);
3260                 vn_finished_write(mp);
3261
3262                 if (olen + ooffset != offset + len) {
3263                         panic("offset + len changed from %jx/%jx to %jx/%jx",
3264                             ooffset, olen, offset, len);
3265                 }
3266                 if (error != 0 || len == 0)
3267                         break;
3268                 KASSERT(olen > len, ("Iteration did not make progress?"));
3269                 maybe_yield();
3270         }
3271
3272         return (error);
3273 }