1 /* $NetBSD: overlay_vfsops.c,v 1.57 2012/04/30 22:51:27 rmind Exp $ */ 2 3 /* 4 * Copyright (c) 1999, 2000 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 * Copyright (c) 1992, 1993, 1995 37 * The Regents of the University of California. All rights reserved. 38 * 39 * This code is derived from software donated to Berkeley by 40 * Jan-Simon Pendry. 41 * 42 * Redistribution and use in source and binary forms, with or without 43 * modification, are permitted provided that the following conditions 44 * are met: 45 * 1. Redistributions of source code must retain the above copyright 46 * notice, this list of conditions and the following disclaimer. 47 * 2. Redistributions in binary form must reproduce the above copyright 48 * notice, this list of conditions and the following disclaimer in the 49 * documentation and/or other materials provided with the distribution. 50 * 3. Neither the name of the University nor the names of its contributors 51 * may be used to endorse or promote products derived from this software 52 * without specific prior written permission. 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 64 * SUCH DAMAGE. 65 * 66 * from: Id: lofs_vfsops.c,v 1.9 1992/05/30 10:26:24 jsp Exp 67 * from: @(#)lofs_vfsops.c 1.2 (Berkeley) 6/18/92 68 * @(#)null_vfsops.c 8.7 (Berkeley) 5/14/95 69 */ 70 71 /* 72 * Overlay Layer 73 * (See overlay_vnops.c for a description of what this does.) 74 */ 75 76 #include <sys/cdefs.h> 77 __KERNEL_RCSID(0, "$NetBSD: overlay_vfsops.c,v 1.57 2012/04/30 22:51:27 rmind Exp $"); 78 79 #include <sys/param.h> 80 #include <sys/systm.h> 81 #include <sys/sysctl.h> 82 #include <sys/time.h> 83 #include <sys/proc.h> 84 #include <sys/vnode.h> 85 #include <sys/mount.h> 86 #include <sys/namei.h> 87 #include <sys/malloc.h> 88 #include <sys/module.h> 89 #include <miscfs/overlay/overlay.h> 90 #include <miscfs/genfs/layer_extern.h> 91 92 MODULE(MODULE_CLASS_VFS, overlay, "layerfs"); 93 94 VFS_PROTOS(ov); 95 96 static struct sysctllog *overlay_sysctl_log; 97 98 #define NOVERLAYNODECACHE 16 99 100 /* 101 * Mount overlay layer 102 */ 103 int 104 ov_mount(struct mount *mp, const char *path, void *data, size_t *data_len) 105 { 106 struct lwp *l = curlwp; 107 int error = 0; 108 struct overlay_args *args = data; 109 struct vnode *lowerrootvp, *vp; 110 struct overlay_mount *nmp; 111 struct layer_mount *lmp; 112 113 #ifdef OVERLAYFS_DIAGNOSTIC 114 printf("ov_mount(mp = %p)\n", mp); 115 #endif 116 117 if (*data_len < sizeof *args) 118 return EINVAL; 119 120 if (mp->mnt_flag & MNT_GETARGS) { 121 lmp = MOUNTTOLAYERMOUNT(mp); 122 if (lmp == NULL) 123 return EIO; 124 args->la.target = NULL; 125 *data_len = sizeof *args; 126 return 0; 127 } 128 129 /* 130 * Update is not supported 131 */ 132 if (mp->mnt_flag & MNT_UPDATE) 133 return EOPNOTSUPP; 134 135 /* 136 * Find lower node 137 */ 138 lowerrootvp = mp->mnt_vnodecovered; 139 vref(lowerrootvp); 140 if ((error = vn_lock(lowerrootvp, LK_EXCLUSIVE | LK_RETRY))) { 141 vrele(lowerrootvp); 142 return (error); 143 } 144 145 /* 146 * First cut at fixing up upper mount point 147 */ 148 nmp = kmem_zalloc(sizeof(struct overlay_mount), KM_SLEEP); 149 150 mp->mnt_data = nmp; 151 nmp->ovm_vfs = lowerrootvp->v_mount; 152 if (nmp->ovm_vfs->mnt_flag & MNT_LOCAL) 153 mp->mnt_flag |= MNT_LOCAL; 154 155 /* 156 * Make sure that the mount point is sufficiently initialized 157 * that the node create call will work. 158 */ 159 vfs_getnewfsid(mp); 160 161 nmp->ovm_size = sizeof (struct overlay_node); 162 nmp->ovm_tag = VT_OVERLAY; 163 nmp->ovm_bypass = layer_bypass; 164 nmp->ovm_alloc = layer_node_alloc; /* the default alloc is fine */ 165 nmp->ovm_vnodeop_p = overlay_vnodeop_p; 166 mutex_init(&nmp->ovm_hashlock, MUTEX_DEFAULT, IPL_NONE); 167 nmp->ovm_node_hashtbl = hashinit(NOVERLAYNODECACHE, HASH_LIST, true, 168 &nmp->ovm_node_hash); 169 170 /* 171 * Fix up overlay node for root vnode 172 */ 173 error = layer_node_create(mp, lowerrootvp, &vp); 174 /* 175 * Make sure the fixup worked 176 */ 177 if (error) { 178 vput(lowerrootvp); 179 hashdone(nmp->ovm_node_hashtbl, HASH_LIST, nmp->ovm_node_hash); 180 kmem_free(nmp, sizeof(struct overlay_mount)); 181 return error; 182 } 183 /* 184 * Unlock the node 185 */ 186 VOP_UNLOCK(vp); 187 188 /* 189 * Keep a held reference to the root vnode. 190 * It is vrele'd in ov_unmount. 191 */ 192 vp->v_vflag |= VV_ROOT; 193 nmp->ovm_rootvp = vp; 194 195 error = set_statvfs_info(path, UIO_USERSPACE, args->la.target, 196 UIO_USERSPACE, mp->mnt_op->vfs_name, mp, l); 197 #ifdef OVERLAYFS_DIAGNOSTIC 198 printf("ov_mount: lower %s, alias at %s\n", 199 mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname); 200 #endif 201 return error; 202 } 203 204 /* 205 * Free reference to overlay layer 206 */ 207 int 208 ov_unmount(struct mount *mp, int mntflags) 209 { 210 struct vnode *overlay_rootvp = MOUNTTOOVERLAYMOUNT(mp)->ovm_rootvp; 211 struct overlay_mount *omp; 212 int error; 213 int flags = 0; 214 215 #ifdef OVERLAYFS_DIAGNOSTIC 216 printf("ov_unmount(mp = %p)\n", mp); 217 #endif 218 219 if (mntflags & MNT_FORCE) 220 flags |= FORCECLOSE; 221 222 if (overlay_rootvp->v_usecount > 1 && (mntflags & MNT_FORCE) == 0) 223 return (EBUSY); 224 if ((error = vflush(mp, overlay_rootvp, flags)) != 0) 225 return (error); 226 227 #ifdef OVERLAYFS_DIAGNOSTIC 228 vprint("alias root of lower", overlay_rootvp); 229 #endif 230 /* 231 * Blow it away for future re-use 232 */ 233 vgone(overlay_rootvp); 234 /* 235 * Finally, throw away the overlay_mount structure 236 */ 237 omp = mp->mnt_data; 238 mutex_destroy(&omp->ovm_hashlock); 239 hashdone(omp->ovm_node_hashtbl, HASH_LIST, omp->ovm_node_hash); 240 kmem_free(omp, sizeof(struct overlay_mount)); 241 mp->mnt_data = NULL; 242 return 0; 243 } 244 245 extern const struct vnodeopv_desc overlay_vnodeop_opv_desc; 246 247 const struct vnodeopv_desc * const ov_vnodeopv_descs[] = { 248 &overlay_vnodeop_opv_desc, 249 NULL, 250 }; 251 252 struct vfsops overlay_vfsops = { 253 MOUNT_OVERLAY, 254 sizeof (struct overlay_args), 255 ov_mount, 256 layerfs_start, 257 ov_unmount, 258 layerfs_root, 259 layerfs_quotactl, 260 layerfs_statvfs, 261 layerfs_sync, 262 layerfs_vget, 263 layerfs_fhtovp, 264 layerfs_vptofh, 265 layerfs_init, 266 NULL, 267 layerfs_done, 268 NULL, /* vfs_mountroot */ 269 layerfs_snapshot, 270 vfs_stdextattrctl, 271 (void *)eopnotsupp, /* vfs_suspendctl */ 272 layerfs_renamelock_enter, 273 layerfs_renamelock_exit, 274 (void *)eopnotsupp, 275 ov_vnodeopv_descs, 276 0, 277 { NULL, NULL }, 278 }; 279 280 static int 281 overlay_modcmd(modcmd_t cmd, void *arg) 282 { 283 int error; 284 285 switch (cmd) { 286 case MODULE_CMD_INIT: 287 error = vfs_attach(&overlay_vfsops); 288 if (error != 0) 289 break; 290 sysctl_createv(&overlay_sysctl_log, 0, NULL, NULL, 291 CTLFLAG_PERMANENT, CTLTYPE_NODE, "vfs", NULL, 292 NULL, 0, NULL, 0, 293 CTL_VFS, CTL_EOL); 294 sysctl_createv(&overlay_sysctl_log, 0, NULL, NULL, 295 CTLFLAG_PERMANENT, CTLTYPE_NODE, "overlay", 296 SYSCTL_DESCR("Overlay file system"), 297 NULL, 0, NULL, 0, 298 CTL_VFS, CTL_CREATE, CTL_EOL); 299 break; 300 case MODULE_CMD_FINI: 301 error = vfs_detach(&overlay_vfsops); 302 if (error != 0) 303 break; 304 sysctl_teardown(&overlay_sysctl_log); 305 break; 306 default: 307 error = ENOTTY; 308 break; 309 } 310 311 return (error); 312 } 313