1 /* $NetBSD: layer_vfsops.c,v 1.55 2022/07/18 04:30:30 thorpej Exp $ */ 2 3 /* 4 * Copyright (c) 1999 National Aeronautics & Space Administration 5 * All rights reserved. 6 * 7 * This software was written by William Studenmund of the 8 * Numerical Aerospace Simulation Facility, NASA Ames Research Center. 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 National Aeronautics & Space Administration 19 * nor the names of its contributors may be used to endorse or promote 20 * products derived from this software without specific prior written 21 * permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE NATIONAL AERONAUTICS & SPACE ADMINISTRATION 24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ADMINISTRATION OR CONTRIB- 27 * UTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 28 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 * POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36 /* 37 * Copyright (c) 1992, 1993, 1995 38 * The Regents of the University of California. All rights reserved. 39 * 40 * This code is derived from software donated to Berkeley by 41 * Jan-Simon Pendry. 42 * 43 * Redistribution and use in source and binary forms, with or without 44 * modification, are permitted provided that the following conditions 45 * are met: 46 * 1. Redistributions of source code must retain the above copyright 47 * notice, this list of conditions and the following disclaimer. 48 * 2. Redistributions in binary form must reproduce the above copyright 49 * notice, this list of conditions and the following disclaimer in the 50 * documentation and/or other materials provided with the distribution. 51 * 3. Neither the name of the University nor the names of its contributors 52 * may be used to endorse or promote products derived from this software 53 * without specific prior written permission. 54 * 55 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 56 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 57 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 58 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 59 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 60 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 61 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 62 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 63 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 64 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 65 * SUCH DAMAGE. 66 * 67 * from: Id: lofs_vfsops.c,v 1.9 1992/05/30 10:26:24 jsp Exp 68 * from: @(#)lofs_vfsops.c 1.2 (Berkeley) 6/18/92 69 * @(#)null_vfsops.c 8.7 (Berkeley) 5/14/95 70 */ 71 72 /* 73 * Generic layer VFS operations. 74 */ 75 76 #include <sys/cdefs.h> 77 __KERNEL_RCSID(0, "$NetBSD: layer_vfsops.c,v 1.55 2022/07/18 04:30:30 thorpej Exp $"); 78 79 #include <sys/param.h> 80 #include <sys/sysctl.h> 81 #include <sys/systm.h> 82 #include <sys/vnode.h> 83 #include <sys/mount.h> 84 #include <sys/namei.h> 85 #include <sys/kauth.h> 86 #include <sys/module.h> 87 88 #include <miscfs/specfs/specdev.h> 89 #include <miscfs/genfs/genfs.h> 90 #include <miscfs/genfs/layer.h> 91 #include <miscfs/genfs/layer_extern.h> 92 93 SYSCTL_SETUP_PROTO(sysctl_vfs_layerfs_setup); 94 95 MODULE(MODULE_CLASS_MISC, layerfs, NULL); 96 97 static int 98 layerfs_modcmd(modcmd_t cmd, void *arg) 99 { 100 101 switch (cmd) { 102 case MODULE_CMD_INIT: 103 return 0; 104 case MODULE_CMD_FINI: 105 return 0; 106 default: 107 return ENOTTY; 108 } 109 return 0; 110 } 111 112 /* 113 * VFS start. Nothing needed here - the start routine on the underlying 114 * filesystem will have been called when that filesystem was mounted. 115 */ 116 int 117 layerfs_start(struct mount *mp, int flags) 118 { 119 120 #ifdef notyet 121 return VFS_START(mp->mnt_lower, flags); 122 #else 123 return 0; 124 #endif 125 } 126 127 int 128 layerfs_root(struct mount *mp, int lktype, struct vnode **vpp) 129 { 130 struct vnode *vp; 131 132 vp = MOUNTTOLAYERMOUNT(mp)->layerm_rootvp; 133 if (vp == NULL) { 134 *vpp = NULL; 135 return EINVAL; 136 } 137 /* 138 * Return root vnode with locked and with a reference held. 139 */ 140 vref(vp); 141 vn_lock(vp, lktype | LK_RETRY); 142 *vpp = vp; 143 return 0; 144 } 145 146 int 147 layerfs_quotactl(struct mount *mp, struct quotactl_args *args) 148 { 149 150 return VFS_QUOTACTL(mp->mnt_lower, args); 151 } 152 153 int 154 layerfs_statvfs(struct mount *mp, struct statvfs *sbp) 155 { 156 struct statvfs *sbuf; 157 int error; 158 159 sbuf = kmem_zalloc(sizeof(*sbuf), KM_SLEEP); 160 error = VFS_STATVFS(mp->mnt_lower, sbuf); 161 if (error) { 162 goto done; 163 } 164 /* Copy across the relevant data and fake the rest. */ 165 sbp->f_flag = sbuf->f_flag; 166 sbp->f_bsize = sbuf->f_bsize; 167 sbp->f_frsize = sbuf->f_frsize; 168 sbp->f_iosize = sbuf->f_iosize; 169 sbp->f_blocks = sbuf->f_blocks; 170 sbp->f_bfree = sbuf->f_bfree; 171 sbp->f_bavail = sbuf->f_bavail; 172 sbp->f_bresvd = sbuf->f_bresvd; 173 sbp->f_files = sbuf->f_files; 174 sbp->f_ffree = sbuf->f_ffree; 175 sbp->f_favail = sbuf->f_favail; 176 sbp->f_fresvd = sbuf->f_fresvd; 177 sbp->f_namemax = sbuf->f_namemax; 178 copy_statvfs_info(sbp, mp); 179 done: 180 kmem_free(sbuf, sizeof(*sbuf)); 181 return error; 182 } 183 184 int 185 layerfs_sync(struct mount *mp, int waitfor, 186 kauth_cred_t cred) 187 { 188 189 /* 190 * XXX - Assumes no data cached at layer. 191 */ 192 return 0; 193 } 194 195 int 196 layerfs_loadvnode(struct mount *mp, struct vnode *vp, 197 const void *key, size_t key_len, const void **new_key) 198 { 199 struct layer_mount *lmp = MOUNTTOLAYERMOUNT(mp); 200 struct vnode *lowervp; 201 struct layer_node *xp; 202 203 KASSERT(key_len == sizeof(struct vnode *)); 204 memcpy(&lowervp, key, key_len); 205 206 xp = kmem_alloc(lmp->layerm_size, KM_SLEEP); 207 208 /* Share the interlock, vmobjlock, and klist with the lower node. */ 209 vshareilock(vp, lowervp); 210 rw_obj_hold(lowervp->v_uobj.vmobjlock); 211 uvm_obj_setlock(&vp->v_uobj, lowervp->v_uobj.vmobjlock); 212 vshareklist(vp, lowervp); 213 214 vp->v_tag = lmp->layerm_tag; 215 vp->v_type = lowervp->v_type; 216 vp->v_op = lmp->layerm_vnodeop_p; 217 if (vp->v_type == VBLK || vp->v_type == VCHR) 218 spec_node_init(vp, lowervp->v_rdev); 219 vp->v_data = xp; 220 xp->layer_vnode = vp; 221 xp->layer_lowervp = lowervp; 222 xp->layer_flags = 0; 223 uvm_vnp_setsize(vp, 0); 224 225 /* Add a reference to the lower node. */ 226 vref(lowervp); 227 *new_key = &xp->layer_lowervp; 228 return 0; 229 } 230 231 int 232 layerfs_vget(struct mount *mp, ino_t ino, int lktype, struct vnode **vpp) 233 { 234 struct vnode *vp; 235 int error; 236 237 error = VFS_VGET(mp->mnt_lower, ino, lktype, &vp); 238 if (error) { 239 *vpp = NULL; 240 return error; 241 } 242 VOP_UNLOCK(vp); 243 error = layer_node_create(mp, vp, vpp); 244 if (error) { 245 vrele(vp); 246 *vpp = NULL; 247 return error; 248 } 249 error = vn_lock(*vpp, lktype); 250 if (error) { 251 vrele(*vpp); 252 *vpp = NULL; 253 return error; 254 } 255 return 0; 256 } 257 258 int 259 layerfs_fhtovp(struct mount *mp, struct fid *fidp, int lktype, 260 struct vnode **vpp) 261 { 262 struct vnode *vp; 263 int error; 264 265 error = VFS_FHTOVP(mp->mnt_lower, fidp, lktype, &vp); 266 if (error) { 267 *vpp = NULL; 268 return error; 269 } 270 VOP_UNLOCK(vp); 271 error = layer_node_create(mp, vp, vpp); 272 if (error) { 273 vput(vp); 274 *vpp = NULL; 275 return (error); 276 } 277 error = vn_lock(*vpp, lktype); 278 if (error) { 279 vrele(*vpp); 280 *vpp = NULL; 281 return error; 282 } 283 return 0; 284 } 285 286 int 287 layerfs_vptofh(struct vnode *vp, struct fid *fhp, size_t *fh_size) 288 { 289 290 return VFS_VPTOFH(LAYERVPTOLOWERVP(vp), fhp, fh_size); 291 } 292 293 /* 294 * layerfs_snapshot - handle a snapshot through a layered file system 295 * 296 * At present, we do NOT support snapshotting through a layered file 297 * system as the ffs implementation changes v_vnlock of the snapshot 298 * vnodes to point to one common lock. As there is no way for us to 299 * absolutely pass this change up the stack, a layered file system 300 * would end up referencing the wrong lock. 301 * 302 * This routine serves as a central resource for this behavior; all 303 * layered file systems don't need to worry about the above. Also, if 304 * things get fixed, all layers get the benefit. 305 */ 306 int 307 layerfs_snapshot(struct mount *mp, struct vnode *vp, 308 struct timespec *ts) 309 { 310 311 return EOPNOTSUPP; 312 } 313 314 /* 315 * layerfs_suspendctl - suspend a layered file system 316 * 317 * Here we should suspend the lower file system(s) too. At present 318 * this will deadlock as we don't know which to suspend first. 319 * 320 * This routine serves as a central resource for this behavior; all 321 * layered file systems don't need to worry about the above. Also, if 322 * things get fixed, all layers get the benefit. 323 */ 324 int 325 layerfs_suspendctl(struct mount *mp, int cmd) 326 { 327 328 return genfs_suspendctl(mp, cmd); 329 } 330 331 SYSCTL_SETUP(sysctl_vfs_layerfs_setup, "sysctl vfs.layerfs subtree setup") 332 { 333 const struct sysctlnode *layerfs_node = NULL; 334 335 sysctl_createv(clog, 0, NULL, &layerfs_node, 336 #ifdef _MODULE 337 0, 338 #else 339 CTLFLAG_PERMANENT, 340 #endif 341 CTLTYPE_NODE, "layerfs", 342 SYSCTL_DESCR("Generic layered file system"), 343 NULL, 0, NULL, 0, 344 CTL_VFS, CTL_CREATE, CTL_EOL); 345 346 #ifdef LAYERFS_DIAGNOSTIC 347 sysctl_createv(clog, 0, &layerfs_node, NULL, 348 #ifndef _MODULE 349 CTLFLAG_PERMANENT | 350 #endif 351 CTLFLAG_READWRITE, 352 CTLTYPE_INT, 353 "debug", 354 SYSCTL_DESCR("Verbose debugging messages"), 355 NULL, 0, &layerfs_debug, 0, 356 CTL_CREATE, CTL_EOL); 357 #endif 358 359 /* 360 * other subtrees should really be aliases to this, but since 361 * they can't tell if layerfs has been instantiated yet, they 362 * can't do that...not easily. not yet. :-) 363 */ 364 } 365 366 int 367 layerfs_renamelock_enter(struct mount *mp) 368 { 369 370 return VFS_RENAMELOCK_ENTER(mp->mnt_lower); 371 } 372 373 void 374 layerfs_renamelock_exit(struct mount *mp) 375 { 376 377 VFS_RENAMELOCK_EXIT(mp->mnt_lower); 378 } 379