1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1992, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * John Heidemann of the UCLA Ficus project. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)null_vnops.c 8.6 (Berkeley) 5/27/95 35 * 36 * Ancestors: 37 * @(#)lofs_vnops.c 1.2 (Berkeley) 6/18/92 38 * ...and... 39 * @(#)null_vnodeops.c 1.20 92/07/07 UCLA Ficus project 40 * 41 * $FreeBSD$ 42 */ 43 44 /* 45 * Null Layer 46 * 47 * (See mount_nullfs(8) for more information.) 48 * 49 * The null layer duplicates a portion of the filesystem 50 * name space under a new name. In this respect, it is 51 * similar to the loopback filesystem. It differs from 52 * the loopback fs in two respects: it is implemented using 53 * a stackable layers techniques, and its "null-node"s stack above 54 * all lower-layer vnodes, not just over directory vnodes. 55 * 56 * The null layer has two purposes. First, it serves as a demonstration 57 * of layering by proving a layer which does nothing. (It actually 58 * does everything the loopback filesystem does, which is slightly 59 * more than nothing.) Second, the null layer can serve as a prototype 60 * layer. Since it provides all necessary layer framework, 61 * new filesystem layers can be created very easily be starting 62 * with a null layer. 63 * 64 * The remainder of this man page examines the null layer as a basis 65 * for constructing new layers. 66 * 67 * 68 * INSTANTIATING NEW NULL LAYERS 69 * 70 * New null layers are created with mount_nullfs(8). 71 * Mount_nullfs(8) takes two arguments, the pathname 72 * of the lower vfs (target-pn) and the pathname where the null 73 * layer will appear in the namespace (alias-pn). After 74 * the null layer is put into place, the contents 75 * of target-pn subtree will be aliased under alias-pn. 76 * 77 * 78 * OPERATION OF A NULL LAYER 79 * 80 * The null layer is the minimum filesystem layer, 81 * simply bypassing all possible operations to the lower layer 82 * for processing there. The majority of its activity centers 83 * on the bypass routine, through which nearly all vnode operations 84 * pass. 85 * 86 * The bypass routine accepts arbitrary vnode operations for 87 * handling by the lower layer. It begins by examing vnode 88 * operation arguments and replacing any null-nodes by their 89 * lower-layer equivlants. It then invokes the operation 90 * on the lower layer. Finally, it replaces the null-nodes 91 * in the arguments and, if a vnode is return by the operation, 92 * stacks a null-node on top of the returned vnode. 93 * 94 * Although bypass handles most operations, vop_getattr, vop_lock, 95 * vop_unlock, vop_inactive, vop_reclaim, and vop_print are not 96 * bypassed. Vop_getattr must change the fsid being returned. 97 * Vop_lock and vop_unlock must handle any locking for the 98 * current vnode as well as pass the lock request down. 99 * Vop_inactive and vop_reclaim are not bypassed so that 100 * they can handle freeing null-layer specific data. Vop_print 101 * is not bypassed to avoid excessive debugging information. 102 * Also, certain vnode operations change the locking state within 103 * the operation (create, mknod, remove, link, rename, mkdir, rmdir, 104 * and symlink). Ideally these operations should not change the 105 * lock state, but should be changed to let the caller of the 106 * function unlock them. Otherwise all intermediate vnode layers 107 * (such as union, umapfs, etc) must catch these functions to do 108 * the necessary locking at their layer. 109 * 110 * 111 * INSTANTIATING VNODE STACKS 112 * 113 * Mounting associates the null layer with a lower layer, 114 * effect stacking two VFSes. Vnode stacks are instead 115 * created on demand as files are accessed. 116 * 117 * The initial mount creates a single vnode stack for the 118 * root of the new null layer. All other vnode stacks 119 * are created as a result of vnode operations on 120 * this or other null vnode stacks. 121 * 122 * New vnode stacks come into existence as a result of 123 * an operation which returns a vnode. 124 * The bypass routine stacks a null-node above the new 125 * vnode before returning it to the caller. 126 * 127 * For example, imagine mounting a null layer with 128 * "mount_nullfs /usr/include /dev/layer/null". 129 * Changing directory to /dev/layer/null will assign 130 * the root null-node (which was created when the null layer was mounted). 131 * Now consider opening "sys". A vop_lookup would be 132 * done on the root null-node. This operation would bypass through 133 * to the lower layer which would return a vnode representing 134 * the UFS "sys". Null_bypass then builds a null-node 135 * aliasing the UFS "sys" and returns this to the caller. 136 * Later operations on the null-node "sys" will repeat this 137 * process when constructing other vnode stacks. 138 * 139 * 140 * CREATING OTHER FILE SYSTEM LAYERS 141 * 142 * One of the easiest ways to construct new filesystem layers is to make 143 * a copy of the null layer, rename all files and variables, and 144 * then begin modifing the copy. Sed can be used to easily rename 145 * all variables. 146 * 147 * The umap layer is an example of a layer descended from the 148 * null layer. 149 * 150 * 151 * INVOKING OPERATIONS ON LOWER LAYERS 152 * 153 * There are two techniques to invoke operations on a lower layer 154 * when the operation cannot be completely bypassed. Each method 155 * is appropriate in different situations. In both cases, 156 * it is the responsibility of the aliasing layer to make 157 * the operation arguments "correct" for the lower layer 158 * by mapping a vnode arguments to the lower layer. 159 * 160 * The first approach is to call the aliasing layer's bypass routine. 161 * This method is most suitable when you wish to invoke the operation 162 * currently being handled on the lower layer. It has the advantage 163 * that the bypass routine already must do argument mapping. 164 * An example of this is null_getattrs in the null layer. 165 * 166 * A second approach is to directly invoke vnode operations on 167 * the lower layer with the VOP_OPERATIONNAME interface. 168 * The advantage of this method is that it is easy to invoke 169 * arbitrary operations on the lower layer. The disadvantage 170 * is that vnode arguments must be manualy mapped. 171 * 172 */ 173 174 #include <sys/param.h> 175 #include <sys/systm.h> 176 #include <sys/conf.h> 177 #include <sys/kernel.h> 178 #include <sys/lock.h> 179 #include <sys/malloc.h> 180 #include <sys/mount.h> 181 #include <sys/mutex.h> 182 #include <sys/namei.h> 183 #include <sys/sysctl.h> 184 #include <sys/vnode.h> 185 #include <sys/stat.h> 186 187 #include <fs/nullfs/null.h> 188 189 #include <vm/vm.h> 190 #include <vm/vm_extern.h> 191 #include <vm/vm_object.h> 192 #include <vm/vnode_pager.h> 193 194 static int null_bug_bypass = 0; /* for debugging: enables bypass printf'ing */ 195 SYSCTL_INT(_debug, OID_AUTO, nullfs_bug_bypass, CTLFLAG_RW, 196 &null_bug_bypass, 0, ""); 197 198 /* 199 * This is the 10-Apr-92 bypass routine. 200 * This version has been optimized for speed, throwing away some 201 * safety checks. It should still always work, but it's not as 202 * robust to programmer errors. 203 * 204 * In general, we map all vnodes going down and unmap them on the way back. 205 * As an exception to this, vnodes can be marked "unmapped" by setting 206 * the Nth bit in operation's vdesc_flags. 207 * 208 * Also, some BSD vnode operations have the side effect of vrele'ing 209 * their arguments. With stacking, the reference counts are held 210 * by the upper node, not the lower one, so we must handle these 211 * side-effects here. This is not of concern in Sun-derived systems 212 * since there are no such side-effects. 213 * 214 * This makes the following assumptions: 215 * - only one returned vpp 216 * - no INOUT vpp's (Sun's vop_open has one of these) 217 * - the vnode operation vector of the first vnode should be used 218 * to determine what implementation of the op should be invoked 219 * - all mapped vnodes are of our vnode-type (NEEDSWORK: 220 * problems on rmdir'ing mount points and renaming?) 221 */ 222 int 223 null_bypass(struct vop_generic_args *ap) 224 { 225 struct vnode **this_vp_p; 226 int error; 227 struct vnode *old_vps[VDESC_MAX_VPS]; 228 struct vnode **vps_p[VDESC_MAX_VPS]; 229 struct vnode ***vppp; 230 struct vnodeop_desc *descp = ap->a_desc; 231 int reles, i; 232 233 if (null_bug_bypass) 234 printf ("null_bypass: %s\n", descp->vdesc_name); 235 236 #ifdef DIAGNOSTIC 237 /* 238 * We require at least one vp. 239 */ 240 if (descp->vdesc_vp_offsets == NULL || 241 descp->vdesc_vp_offsets[0] == VDESC_NO_OFFSET) 242 panic ("null_bypass: no vp's in map"); 243 #endif 244 245 /* 246 * Map the vnodes going in. 247 * Later, we'll invoke the operation based on 248 * the first mapped vnode's operation vector. 249 */ 250 reles = descp->vdesc_flags; 251 for (i = 0; i < VDESC_MAX_VPS; reles >>= 1, i++) { 252 if (descp->vdesc_vp_offsets[i] == VDESC_NO_OFFSET) 253 break; /* bail out at end of list */ 254 vps_p[i] = this_vp_p = 255 VOPARG_OFFSETTO(struct vnode**,descp->vdesc_vp_offsets[i],ap); 256 /* 257 * We're not guaranteed that any but the first vnode 258 * are of our type. Check for and don't map any 259 * that aren't. (We must always map first vp or vclean fails.) 260 */ 261 if (i && (*this_vp_p == NULLVP || 262 (*this_vp_p)->v_op != &null_vnodeops)) { 263 old_vps[i] = NULLVP; 264 } else { 265 old_vps[i] = *this_vp_p; 266 *(vps_p[i]) = NULLVPTOLOWERVP(*this_vp_p); 267 /* 268 * XXX - Several operations have the side effect 269 * of vrele'ing their vp's. We must account for 270 * that. (This should go away in the future.) 271 */ 272 if (reles & VDESC_VP0_WILLRELE) 273 VREF(*this_vp_p); 274 } 275 } 276 277 /* 278 * Call the operation on the lower layer 279 * with the modified argument structure. 280 */ 281 if (vps_p[0] && *vps_p[0]) 282 error = VCALL(ap); 283 else { 284 printf("null_bypass: no map for %s\n", descp->vdesc_name); 285 error = EINVAL; 286 } 287 288 /* 289 * Maintain the illusion of call-by-value 290 * by restoring vnodes in the argument structure 291 * to their original value. 292 */ 293 reles = descp->vdesc_flags; 294 for (i = 0; i < VDESC_MAX_VPS; reles >>= 1, i++) { 295 if (descp->vdesc_vp_offsets[i] == VDESC_NO_OFFSET) 296 break; /* bail out at end of list */ 297 if (old_vps[i]) { 298 *(vps_p[i]) = old_vps[i]; 299 #if 0 300 if (reles & VDESC_VP0_WILLUNLOCK) 301 VOP_UNLOCK(*(vps_p[i]), 0); 302 #endif 303 if (reles & VDESC_VP0_WILLRELE) 304 vrele(*(vps_p[i])); 305 } 306 } 307 308 /* 309 * Map the possible out-going vpp 310 * (Assumes that the lower layer always returns 311 * a VREF'ed vpp unless it gets an error.) 312 */ 313 if (descp->vdesc_vpp_offset != VDESC_NO_OFFSET && !error) { 314 /* 315 * XXX - even though some ops have vpp returned vp's, 316 * several ops actually vrele this before returning. 317 * We must avoid these ops. 318 * (This should go away when these ops are regularized.) 319 */ 320 vppp = VOPARG_OFFSETTO(struct vnode***, 321 descp->vdesc_vpp_offset,ap); 322 if (*vppp) 323 error = null_nodeget(old_vps[0]->v_mount, **vppp, *vppp); 324 } 325 326 return (error); 327 } 328 329 static int 330 null_add_writecount(struct vop_add_writecount_args *ap) 331 { 332 struct vnode *lvp, *vp; 333 int error; 334 335 vp = ap->a_vp; 336 lvp = NULLVPTOLOWERVP(vp); 337 VI_LOCK(vp); 338 /* text refs are bypassed to lowervp */ 339 VNASSERT(vp->v_writecount >= 0, vp, ("wrong null writecount")); 340 VNASSERT(vp->v_writecount + ap->a_inc >= 0, vp, 341 ("wrong writecount inc %d", ap->a_inc)); 342 error = VOP_ADD_WRITECOUNT(lvp, ap->a_inc); 343 if (error == 0) 344 vp->v_writecount += ap->a_inc; 345 VI_UNLOCK(vp); 346 return (error); 347 } 348 349 /* 350 * We have to carry on the locking protocol on the null layer vnodes 351 * as we progress through the tree. We also have to enforce read-only 352 * if this layer is mounted read-only. 353 */ 354 static int 355 null_lookup(struct vop_lookup_args *ap) 356 { 357 struct componentname *cnp = ap->a_cnp; 358 struct vnode *dvp = ap->a_dvp; 359 int flags = cnp->cn_flags; 360 struct vnode *vp, *ldvp, *lvp; 361 struct mount *mp; 362 int error; 363 364 mp = dvp->v_mount; 365 if ((flags & ISLASTCN) != 0 && (mp->mnt_flag & MNT_RDONLY) != 0 && 366 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) 367 return (EROFS); 368 /* 369 * Although it is possible to call null_bypass(), we'll do 370 * a direct call to reduce overhead 371 */ 372 ldvp = NULLVPTOLOWERVP(dvp); 373 vp = lvp = NULL; 374 KASSERT((ldvp->v_vflag & VV_ROOT) == 0 || 375 ((dvp->v_vflag & VV_ROOT) != 0 && (flags & ISDOTDOT) == 0), 376 ("ldvp %p fl %#x dvp %p fl %#x flags %#x", ldvp, ldvp->v_vflag, 377 dvp, dvp->v_vflag, flags)); 378 379 /* 380 * Hold ldvp. The reference on it, owned by dvp, is lost in 381 * case of dvp reclamation, and we need ldvp to move our lock 382 * from ldvp to dvp. 383 */ 384 vhold(ldvp); 385 386 error = VOP_LOOKUP(ldvp, &lvp, cnp); 387 388 /* 389 * VOP_LOOKUP() on lower vnode may unlock ldvp, which allows 390 * dvp to be reclaimed due to shared v_vnlock. Check for the 391 * doomed state and return error. 392 */ 393 if ((error == 0 || error == EJUSTRETURN) && 394 VN_IS_DOOMED(dvp)) { 395 error = ENOENT; 396 if (lvp != NULL) 397 vput(lvp); 398 399 /* 400 * If vgone() did reclaimed dvp before curthread 401 * relocked ldvp, the locks of dvp and ldpv are no 402 * longer shared. In this case, relock of ldvp in 403 * lower fs VOP_LOOKUP() does not restore the locking 404 * state of dvp. Compensate for this by unlocking 405 * ldvp and locking dvp, which is also correct if the 406 * locks are still shared. 407 */ 408 VOP_UNLOCK(ldvp); 409 vn_lock(dvp, LK_EXCLUSIVE | LK_RETRY); 410 } 411 vdrop(ldvp); 412 413 if (error == EJUSTRETURN && (flags & ISLASTCN) != 0 && 414 (mp->mnt_flag & MNT_RDONLY) != 0 && 415 (cnp->cn_nameiop == CREATE || cnp->cn_nameiop == RENAME)) 416 error = EROFS; 417 418 if ((error == 0 || error == EJUSTRETURN) && lvp != NULL) { 419 if (ldvp == lvp) { 420 *ap->a_vpp = dvp; 421 VREF(dvp); 422 vrele(lvp); 423 } else { 424 error = null_nodeget(mp, lvp, &vp); 425 if (error == 0) 426 *ap->a_vpp = vp; 427 } 428 } 429 return (error); 430 } 431 432 static int 433 null_open(struct vop_open_args *ap) 434 { 435 int retval; 436 struct vnode *vp, *ldvp; 437 438 vp = ap->a_vp; 439 ldvp = NULLVPTOLOWERVP(vp); 440 retval = null_bypass(&ap->a_gen); 441 if (retval == 0) { 442 vp->v_object = ldvp->v_object; 443 if ((ldvp->v_irflag & VIRF_PGREAD) != 0) { 444 MPASS(vp->v_object != NULL); 445 if ((vp->v_irflag & VIRF_PGREAD) == 0) { 446 VI_LOCK(vp); 447 vp->v_irflag |= VIRF_PGREAD; 448 VI_UNLOCK(vp); 449 } 450 } 451 } 452 return (retval); 453 } 454 455 /* 456 * Setattr call. Disallow write attempts if the layer is mounted read-only. 457 */ 458 static int 459 null_setattr(struct vop_setattr_args *ap) 460 { 461 struct vnode *vp = ap->a_vp; 462 struct vattr *vap = ap->a_vap; 463 464 if ((vap->va_flags != VNOVAL || vap->va_uid != (uid_t)VNOVAL || 465 vap->va_gid != (gid_t)VNOVAL || vap->va_atime.tv_sec != VNOVAL || 466 vap->va_mtime.tv_sec != VNOVAL || vap->va_mode != (mode_t)VNOVAL) && 467 (vp->v_mount->mnt_flag & MNT_RDONLY)) 468 return (EROFS); 469 if (vap->va_size != VNOVAL) { 470 switch (vp->v_type) { 471 case VDIR: 472 return (EISDIR); 473 case VCHR: 474 case VBLK: 475 case VSOCK: 476 case VFIFO: 477 if (vap->va_flags != VNOVAL) 478 return (EOPNOTSUPP); 479 return (0); 480 case VREG: 481 case VLNK: 482 default: 483 /* 484 * Disallow write attempts if the filesystem is 485 * mounted read-only. 486 */ 487 if (vp->v_mount->mnt_flag & MNT_RDONLY) 488 return (EROFS); 489 } 490 } 491 492 return (null_bypass((struct vop_generic_args *)ap)); 493 } 494 495 /* 496 * We handle stat and getattr only to change the fsid. 497 */ 498 static int 499 null_stat(struct vop_stat_args *ap) 500 { 501 int error; 502 503 if ((error = null_bypass((struct vop_generic_args *)ap)) != 0) 504 return (error); 505 506 ap->a_sb->st_dev = ap->a_vp->v_mount->mnt_stat.f_fsid.val[0]; 507 return (0); 508 } 509 510 static int 511 null_getattr(struct vop_getattr_args *ap) 512 { 513 int error; 514 515 if ((error = null_bypass((struct vop_generic_args *)ap)) != 0) 516 return (error); 517 518 ap->a_vap->va_fsid = ap->a_vp->v_mount->mnt_stat.f_fsid.val[0]; 519 return (0); 520 } 521 522 /* 523 * Handle to disallow write access if mounted read-only. 524 */ 525 static int 526 null_access(struct vop_access_args *ap) 527 { 528 struct vnode *vp = ap->a_vp; 529 accmode_t accmode = ap->a_accmode; 530 531 /* 532 * Disallow write attempts on read-only layers; 533 * unless the file is a socket, fifo, or a block or 534 * character device resident on the filesystem. 535 */ 536 if (accmode & VWRITE) { 537 switch (vp->v_type) { 538 case VDIR: 539 case VLNK: 540 case VREG: 541 if (vp->v_mount->mnt_flag & MNT_RDONLY) 542 return (EROFS); 543 break; 544 default: 545 break; 546 } 547 } 548 return (null_bypass((struct vop_generic_args *)ap)); 549 } 550 551 static int 552 null_accessx(struct vop_accessx_args *ap) 553 { 554 struct vnode *vp = ap->a_vp; 555 accmode_t accmode = ap->a_accmode; 556 557 /* 558 * Disallow write attempts on read-only layers; 559 * unless the file is a socket, fifo, or a block or 560 * character device resident on the filesystem. 561 */ 562 if (accmode & VWRITE) { 563 switch (vp->v_type) { 564 case VDIR: 565 case VLNK: 566 case VREG: 567 if (vp->v_mount->mnt_flag & MNT_RDONLY) 568 return (EROFS); 569 break; 570 default: 571 break; 572 } 573 } 574 return (null_bypass((struct vop_generic_args *)ap)); 575 } 576 577 /* 578 * Increasing refcount of lower vnode is needed at least for the case 579 * when lower FS is NFS to do sillyrename if the file is in use. 580 * Unfortunately v_usecount is incremented in many places in 581 * the kernel and, as such, there may be races that result in 582 * the NFS client doing an extraneous silly rename, but that seems 583 * preferable to not doing a silly rename when it is needed. 584 */ 585 static int 586 null_remove(struct vop_remove_args *ap) 587 { 588 int retval, vreleit; 589 struct vnode *lvp, *vp; 590 591 vp = ap->a_vp; 592 if (vrefcnt(vp) > 1) { 593 lvp = NULLVPTOLOWERVP(vp); 594 VREF(lvp); 595 vreleit = 1; 596 } else 597 vreleit = 0; 598 VTONULL(vp)->null_flags |= NULLV_DROP; 599 retval = null_bypass(&ap->a_gen); 600 if (vreleit != 0) 601 vrele(lvp); 602 return (retval); 603 } 604 605 /* 606 * We handle this to eliminate null FS to lower FS 607 * file moving. Don't know why we don't allow this, 608 * possibly we should. 609 */ 610 static int 611 null_rename(struct vop_rename_args *ap) 612 { 613 struct vnode *tdvp = ap->a_tdvp; 614 struct vnode *fvp = ap->a_fvp; 615 struct vnode *fdvp = ap->a_fdvp; 616 struct vnode *tvp = ap->a_tvp; 617 struct null_node *tnn; 618 619 /* Check for cross-device rename. */ 620 if ((fvp->v_mount != tdvp->v_mount) || 621 (tvp && (fvp->v_mount != tvp->v_mount))) { 622 if (tdvp == tvp) 623 vrele(tdvp); 624 else 625 vput(tdvp); 626 if (tvp) 627 vput(tvp); 628 vrele(fdvp); 629 vrele(fvp); 630 return (EXDEV); 631 } 632 633 if (tvp != NULL) { 634 tnn = VTONULL(tvp); 635 tnn->null_flags |= NULLV_DROP; 636 } 637 return (null_bypass((struct vop_generic_args *)ap)); 638 } 639 640 static int 641 null_rmdir(struct vop_rmdir_args *ap) 642 { 643 644 VTONULL(ap->a_vp)->null_flags |= NULLV_DROP; 645 return (null_bypass(&ap->a_gen)); 646 } 647 648 /* 649 * We need to process our own vnode lock and then clear the 650 * interlock flag as it applies only to our vnode, not the 651 * vnodes below us on the stack. 652 */ 653 static int 654 null_lock(struct vop_lock1_args *ap) 655 { 656 struct vnode *vp = ap->a_vp; 657 int flags; 658 struct null_node *nn; 659 struct vnode *lvp; 660 int error; 661 662 if ((ap->a_flags & LK_INTERLOCK) == 0) 663 VI_LOCK(vp); 664 else 665 ap->a_flags &= ~LK_INTERLOCK; 666 flags = ap->a_flags; 667 nn = VTONULL(vp); 668 /* 669 * If we're still active we must ask the lower layer to 670 * lock as ffs has special lock considerations in its 671 * vop lock. 672 */ 673 if (nn != NULL && (lvp = NULLVPTOLOWERVP(vp)) != NULL) { 674 /* 675 * We have to hold the vnode here to solve a potential 676 * reclaim race. If we're forcibly vgone'd while we 677 * still have refs, a thread could be sleeping inside 678 * the lowervp's vop_lock routine. When we vgone we will 679 * drop our last ref to the lowervp, which would allow it 680 * to be reclaimed. The lowervp could then be recycled, 681 * in which case it is not legal to be sleeping in its VOP. 682 * We prevent it from being recycled by holding the vnode 683 * here. 684 */ 685 vholdnz(lvp); 686 VI_UNLOCK(vp); 687 error = VOP_LOCK(lvp, flags); 688 689 /* 690 * We might have slept to get the lock and someone might have 691 * clean our vnode already, switching vnode lock from one in 692 * lowervp to v_lock in our own vnode structure. Handle this 693 * case by reacquiring correct lock in requested mode. 694 */ 695 if (VTONULL(vp) == NULL && error == 0) { 696 ap->a_flags &= ~LK_TYPE_MASK; 697 switch (flags & LK_TYPE_MASK) { 698 case LK_SHARED: 699 ap->a_flags |= LK_SHARED; 700 break; 701 case LK_UPGRADE: 702 case LK_EXCLUSIVE: 703 ap->a_flags |= LK_EXCLUSIVE; 704 break; 705 default: 706 panic("Unsupported lock request %d\n", 707 ap->a_flags); 708 } 709 VOP_UNLOCK(lvp); 710 error = vop_stdlock(ap); 711 } 712 vdrop(lvp); 713 } else { 714 VI_UNLOCK(vp); 715 error = vop_stdlock(ap); 716 } 717 718 return (error); 719 } 720 721 /* 722 * We need to process our own vnode unlock and then clear the 723 * interlock flag as it applies only to our vnode, not the 724 * vnodes below us on the stack. 725 */ 726 static int 727 null_unlock(struct vop_unlock_args *ap) 728 { 729 struct vnode *vp = ap->a_vp; 730 struct null_node *nn; 731 struct vnode *lvp; 732 int error; 733 734 nn = VTONULL(vp); 735 if (nn != NULL && (lvp = NULLVPTOLOWERVP(vp)) != NULL) { 736 vholdnz(lvp); 737 error = VOP_UNLOCK(lvp); 738 vdrop(lvp); 739 } else { 740 error = vop_stdunlock(ap); 741 } 742 743 return (error); 744 } 745 746 /* 747 * Do not allow the VOP_INACTIVE to be passed to the lower layer, 748 * since the reference count on the lower vnode is not related to 749 * ours. 750 */ 751 static int 752 null_want_recycle(struct vnode *vp) 753 { 754 struct vnode *lvp; 755 struct null_node *xp; 756 struct mount *mp; 757 struct null_mount *xmp; 758 759 xp = VTONULL(vp); 760 lvp = NULLVPTOLOWERVP(vp); 761 mp = vp->v_mount; 762 xmp = MOUNTTONULLMOUNT(mp); 763 if ((xmp->nullm_flags & NULLM_CACHE) == 0 || 764 (xp->null_flags & NULLV_DROP) != 0 || 765 (lvp->v_vflag & VV_NOSYNC) != 0) { 766 /* 767 * If this is the last reference and caching of the 768 * nullfs vnodes is not enabled, or the lower vnode is 769 * deleted, then free up the vnode so as not to tie up 770 * the lower vnodes. 771 */ 772 return (1); 773 } 774 return (0); 775 } 776 777 static int 778 null_inactive(struct vop_inactive_args *ap) 779 { 780 struct vnode *vp; 781 782 vp = ap->a_vp; 783 if (null_want_recycle(vp)) { 784 vp->v_object = NULL; 785 vrecycle(vp); 786 } 787 return (0); 788 } 789 790 static int 791 null_need_inactive(struct vop_need_inactive_args *ap) 792 { 793 794 return (null_want_recycle(ap->a_vp)); 795 } 796 797 /* 798 * Now, the nullfs vnode and, due to the sharing lock, the lower 799 * vnode, are exclusively locked, and we shall destroy the null vnode. 800 */ 801 static int 802 null_reclaim(struct vop_reclaim_args *ap) 803 { 804 struct vnode *vp; 805 struct null_node *xp; 806 struct vnode *lowervp; 807 808 vp = ap->a_vp; 809 xp = VTONULL(vp); 810 lowervp = xp->null_lowervp; 811 812 KASSERT(lowervp != NULL && vp->v_vnlock != &vp->v_lock, 813 ("Reclaiming incomplete null vnode %p", vp)); 814 815 null_hashrem(xp); 816 /* 817 * Use the interlock to protect the clearing of v_data to 818 * prevent faults in null_lock(). 819 */ 820 lockmgr(&vp->v_lock, LK_EXCLUSIVE, NULL); 821 VI_LOCK(vp); 822 vp->v_data = NULL; 823 vp->v_object = NULL; 824 vp->v_vnlock = &vp->v_lock; 825 826 /* 827 * If we were opened for write, we leased the write reference 828 * to the lower vnode. If this is a reclamation due to the 829 * forced unmount, undo the reference now. 830 */ 831 if (vp->v_writecount > 0) 832 VOP_ADD_WRITECOUNT(lowervp, -vp->v_writecount); 833 else if (vp->v_writecount < 0) 834 vp->v_writecount = 0; 835 836 VI_UNLOCK(vp); 837 838 if ((xp->null_flags & NULLV_NOUNLOCK) != 0) 839 vunref(lowervp); 840 else 841 vput(lowervp); 842 free(xp, M_NULLFSNODE); 843 844 return (0); 845 } 846 847 static int 848 null_print(struct vop_print_args *ap) 849 { 850 struct vnode *vp = ap->a_vp; 851 852 printf("\tvp=%p, lowervp=%p\n", vp, VTONULL(vp)->null_lowervp); 853 return (0); 854 } 855 856 /* ARGSUSED */ 857 static int 858 null_getwritemount(struct vop_getwritemount_args *ap) 859 { 860 struct null_node *xp; 861 struct vnode *lowervp; 862 struct vnode *vp; 863 864 vp = ap->a_vp; 865 VI_LOCK(vp); 866 xp = VTONULL(vp); 867 if (xp && (lowervp = xp->null_lowervp)) { 868 vholdnz(lowervp); 869 VI_UNLOCK(vp); 870 VOP_GETWRITEMOUNT(lowervp, ap->a_mpp); 871 vdrop(lowervp); 872 } else { 873 VI_UNLOCK(vp); 874 *(ap->a_mpp) = NULL; 875 } 876 return (0); 877 } 878 879 static int 880 null_vptofh(struct vop_vptofh_args *ap) 881 { 882 struct vnode *lvp; 883 884 lvp = NULLVPTOLOWERVP(ap->a_vp); 885 return VOP_VPTOFH(lvp, ap->a_fhp); 886 } 887 888 static int 889 null_vptocnp(struct vop_vptocnp_args *ap) 890 { 891 struct vnode *vp = ap->a_vp; 892 struct vnode **dvp = ap->a_vpp; 893 struct vnode *lvp, *ldvp; 894 struct ucred *cred = ap->a_cred; 895 struct mount *mp; 896 int error, locked; 897 898 locked = VOP_ISLOCKED(vp); 899 lvp = NULLVPTOLOWERVP(vp); 900 vhold(lvp); 901 mp = vp->v_mount; 902 vfs_ref(mp); 903 VOP_UNLOCK(vp); /* vp is held by vn_vptocnp_locked that called us */ 904 ldvp = lvp; 905 vref(lvp); 906 error = vn_vptocnp(&ldvp, cred, ap->a_buf, ap->a_buflen); 907 vdrop(lvp); 908 if (error != 0) { 909 vn_lock(vp, locked | LK_RETRY); 910 vfs_rel(mp); 911 return (ENOENT); 912 } 913 914 error = vn_lock(ldvp, LK_SHARED); 915 if (error != 0) { 916 vrele(ldvp); 917 vn_lock(vp, locked | LK_RETRY); 918 vfs_rel(mp); 919 return (ENOENT); 920 } 921 error = null_nodeget(mp, ldvp, dvp); 922 if (error == 0) { 923 #ifdef DIAGNOSTIC 924 NULLVPTOLOWERVP(*dvp); 925 #endif 926 VOP_UNLOCK(*dvp); /* keep reference on *dvp */ 927 } 928 vn_lock(vp, locked | LK_RETRY); 929 vfs_rel(mp); 930 return (error); 931 } 932 933 /* 934 * Global vfs data structures 935 */ 936 struct vop_vector null_vnodeops = { 937 .vop_bypass = null_bypass, 938 .vop_access = null_access, 939 .vop_accessx = null_accessx, 940 .vop_advlockpurge = vop_stdadvlockpurge, 941 .vop_bmap = VOP_EOPNOTSUPP, 942 .vop_stat = null_stat, 943 .vop_getattr = null_getattr, 944 .vop_getwritemount = null_getwritemount, 945 .vop_inactive = null_inactive, 946 .vop_need_inactive = null_need_inactive, 947 .vop_islocked = vop_stdislocked, 948 .vop_lock1 = null_lock, 949 .vop_lookup = null_lookup, 950 .vop_open = null_open, 951 .vop_print = null_print, 952 .vop_reclaim = null_reclaim, 953 .vop_remove = null_remove, 954 .vop_rename = null_rename, 955 .vop_rmdir = null_rmdir, 956 .vop_setattr = null_setattr, 957 .vop_strategy = VOP_EOPNOTSUPP, 958 .vop_unlock = null_unlock, 959 .vop_vptocnp = null_vptocnp, 960 .vop_vptofh = null_vptofh, 961 .vop_add_writecount = null_add_writecount, 962 }; 963 VFS_VOP_VECTOR_REGISTER(null_vnodeops); 964