1 /* $NetBSD: overlay_vfsops.c,v 1.61 2014/04/16 18:55:19 maxv 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.61 2014/04/16 18:55:19 maxv 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 (args == NULL) 118 return EINVAL; 119 if (*data_len < sizeof *args) 120 return EINVAL; 121 122 if (mp->mnt_flag & MNT_GETARGS) { 123 lmp = MOUNTTOLAYERMOUNT(mp); 124 if (lmp == NULL) 125 return EIO; 126 args->la.target = NULL; 127 *data_len = sizeof *args; 128 return 0; 129 } 130 131 /* 132 * Update is not supported 133 */ 134 if (mp->mnt_flag & MNT_UPDATE) 135 return EOPNOTSUPP; 136 137 /* 138 * Find lower node 139 */ 140 lowerrootvp = mp->mnt_vnodecovered; 141 vref(lowerrootvp); 142 if ((error = vn_lock(lowerrootvp, LK_EXCLUSIVE | LK_RETRY))) { 143 vrele(lowerrootvp); 144 return (error); 145 } 146 147 /* 148 * First cut at fixing up upper mount point 149 */ 150 nmp = kmem_zalloc(sizeof(struct overlay_mount), KM_SLEEP); 151 152 mp->mnt_data = nmp; 153 nmp->ovm_vfs = lowerrootvp->v_mount; 154 if (nmp->ovm_vfs->mnt_flag & MNT_LOCAL) 155 mp->mnt_flag |= MNT_LOCAL; 156 157 /* 158 * Make sure that the mount point is sufficiently initialized 159 * that the node create call will work. 160 */ 161 vfs_getnewfsid(mp); 162 163 nmp->ovm_size = sizeof (struct overlay_node); 164 nmp->ovm_tag = VT_OVERLAY; 165 nmp->ovm_bypass = layer_bypass; 166 nmp->ovm_alloc = layer_node_alloc; /* the default alloc is fine */ 167 nmp->ovm_vnodeop_p = overlay_vnodeop_p; 168 mutex_init(&nmp->ovm_hashlock, MUTEX_DEFAULT, IPL_NONE); 169 nmp->ovm_node_hashtbl = hashinit(NOVERLAYNODECACHE, HASH_LIST, true, 170 &nmp->ovm_node_hash); 171 172 /* 173 * Fix up overlay node for root vnode 174 */ 175 VOP_UNLOCK(lowerrootvp); 176 error = layer_node_create(mp, lowerrootvp, &vp); 177 /* 178 * Make sure the fixup worked 179 */ 180 if (error) { 181 vrele(lowerrootvp); 182 hashdone(nmp->ovm_node_hashtbl, HASH_LIST, nmp->ovm_node_hash); 183 kmem_free(nmp, sizeof(struct overlay_mount)); 184 return error; 185 } 186 187 /* 188 * Keep a held reference to the root vnode. 189 * It is vrele'd in ov_unmount. 190 */ 191 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY); 192 vp->v_vflag |= VV_ROOT; 193 nmp->ovm_rootvp = vp; 194 VOP_UNLOCK(vp); 195 196 error = set_statvfs_info(path, UIO_USERSPACE, args->la.target, 197 UIO_USERSPACE, mp->mnt_op->vfs_name, mp, l); 198 #ifdef OVERLAYFS_DIAGNOSTIC 199 printf("ov_mount: lower %s, alias at %s\n", 200 mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname); 201 #endif 202 return error; 203 } 204 205 /* 206 * Free reference to overlay layer 207 */ 208 int 209 ov_unmount(struct mount *mp, int mntflags) 210 { 211 struct vnode *overlay_rootvp = MOUNTTOOVERLAYMOUNT(mp)->ovm_rootvp; 212 struct overlay_mount *omp; 213 int error; 214 int flags = 0; 215 216 #ifdef OVERLAYFS_DIAGNOSTIC 217 printf("ov_unmount(mp = %p)\n", mp); 218 #endif 219 220 if (mntflags & MNT_FORCE) 221 flags |= FORCECLOSE; 222 223 if (overlay_rootvp->v_usecount > 1 && (mntflags & MNT_FORCE) == 0) 224 return (EBUSY); 225 if ((error = vflush(mp, overlay_rootvp, flags)) != 0) 226 return (error); 227 228 #ifdef OVERLAYFS_DIAGNOSTIC 229 vprint("alias root of lower", overlay_rootvp); 230 #endif 231 /* 232 * Blow it away for future re-use 233 */ 234 vgone(overlay_rootvp); 235 /* 236 * Finally, throw away the overlay_mount structure 237 */ 238 omp = mp->mnt_data; 239 mutex_destroy(&omp->ovm_hashlock); 240 hashdone(omp->ovm_node_hashtbl, HASH_LIST, omp->ovm_node_hash); 241 kmem_free(omp, sizeof(struct overlay_mount)); 242 mp->mnt_data = NULL; 243 return 0; 244 } 245 246 extern const struct vnodeopv_desc overlay_vnodeop_opv_desc; 247 248 const struct vnodeopv_desc * const ov_vnodeopv_descs[] = { 249 &overlay_vnodeop_opv_desc, 250 NULL, 251 }; 252 253 struct vfsops overlay_vfsops = { 254 .vfs_name = MOUNT_OVERLAY, 255 .vfs_min_mount_data = sizeof (struct overlay_args), 256 .vfs_mount = ov_mount, 257 .vfs_start = layerfs_start, 258 .vfs_unmount = ov_unmount, 259 .vfs_root = layerfs_root, 260 .vfs_quotactl = layerfs_quotactl, 261 .vfs_statvfs = layerfs_statvfs, 262 .vfs_sync = layerfs_sync, 263 .vfs_vget = layerfs_vget, 264 .vfs_fhtovp = layerfs_fhtovp, 265 .vfs_vptofh = layerfs_vptofh, 266 .vfs_init = layerfs_init, 267 .vfs_done = layerfs_done, 268 .vfs_snapshot = layerfs_snapshot, 269 .vfs_extattrctl = vfs_stdextattrctl, 270 .vfs_suspendctl = (void *)eopnotsupp, 271 .vfs_renamelock_enter = layerfs_renamelock_enter, 272 .vfs_renamelock_exit = layerfs_renamelock_exit, 273 .vfs_fsync = (void *)eopnotsupp, 274 .vfs_opv_descs = ov_vnodeopv_descs 275 }; 276 277 static int 278 overlay_modcmd(modcmd_t cmd, void *arg) 279 { 280 int error; 281 282 switch (cmd) { 283 case MODULE_CMD_INIT: 284 error = vfs_attach(&overlay_vfsops); 285 if (error != 0) 286 break; 287 sysctl_createv(&overlay_sysctl_log, 0, NULL, NULL, 288 CTLFLAG_PERMANENT, CTLTYPE_NODE, "overlay", 289 SYSCTL_DESCR("Overlay file system"), 290 NULL, 0, NULL, 0, 291 CTL_VFS, CTL_CREATE, CTL_EOL); 292 break; 293 case MODULE_CMD_FINI: 294 error = vfs_detach(&overlay_vfsops); 295 if (error != 0) 296 break; 297 sysctl_teardown(&overlay_sysctl_log); 298 break; 299 default: 300 error = ENOTTY; 301 break; 302 } 303 304 return (error); 305 } 306