overlay_vfsops.c revision 1.39 1 /* $NetBSD: overlay_vfsops.c,v 1.39 2007/07/08 23:58:53 pooka 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.39 2007/07/08 23:58:53 pooka 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 <miscfs/overlay/overlay.h>
89 #include <miscfs/genfs/layer_extern.h>
90
91 int ov_mount(struct mount *, const char *, void *,
92 struct nameidata *, struct lwp *);
93 int ov_unmount(struct mount *, int, struct lwp *);
94
95 #define NOVERLAYNODECACHE 16
96
97 /*
98 * Mount overlay layer
99 */
100 int
101 ov_mount(struct mount *mp, const char *path, void *data,
102 struct nameidata *ndp, struct lwp *l)
103 {
104 int error = 0;
105 struct overlay_args args;
106 struct vnode *lowerrootvp, *vp;
107 struct overlay_mount *nmp;
108 struct layer_mount *lmp;
109
110 #ifdef OVERLAYFS_DIAGNOSTIC
111 printf("ov_mount(mp = %p)\n", mp);
112 #endif
113
114 if (mp->mnt_flag & MNT_GETARGS) {
115 lmp = MOUNTTOLAYERMOUNT(mp);
116 if (lmp == NULL)
117 return EIO;
118 args.la.target = NULL;
119 return copyout(&args, data, sizeof(args));
120 }
121 /*
122 * Get argument
123 */
124 error = copyin(data, &args, sizeof(struct overlay_args));
125 if (error)
126 return (error);
127
128 /*
129 * Update is not supported
130 */
131 if (mp->mnt_flag & MNT_UPDATE)
132 return EOPNOTSUPP;
133
134 /*
135 * Find lower node
136 */
137 lowerrootvp = mp->mnt_vnodecovered;
138 if ((error = vget(lowerrootvp, LK_EXCLUSIVE | LK_RETRY)))
139 return (error);
140
141 /*
142 * First cut at fixing up upper mount point
143 */
144 nmp = (struct overlay_mount *) malloc(sizeof(struct overlay_mount),
145 M_UFSMNT, M_WAITOK); /* XXX */
146 memset(nmp, 0, sizeof(struct overlay_mount));
147
148 mp->mnt_data = nmp;
149 nmp->ovm_vfs = lowerrootvp->v_mount;
150 if (nmp->ovm_vfs->mnt_flag & MNT_LOCAL)
151 mp->mnt_flag |= MNT_LOCAL;
152
153 /*
154 * Make sure that the mount point is sufficiently initialized
155 * that the node create call will work.
156 */
157 vfs_getnewfsid(mp);
158
159 nmp->ovm_size = sizeof (struct overlay_node);
160 nmp->ovm_tag = VT_OVERLAY;
161 nmp->ovm_bypass = layer_bypass;
162 nmp->ovm_alloc = layer_node_alloc; /* the default alloc is fine */
163 nmp->ovm_vnodeop_p = overlay_vnodeop_p;
164 simple_lock_init(&nmp->ovm_hashlock);
165 nmp->ovm_node_hashtbl = hashinit(NOVERLAYNODECACHE, HASH_LIST, M_CACHE,
166 M_WAITOK, &nmp->ovm_node_hash);
167
168 /*
169 * Fix up overlay node for root vnode
170 */
171 error = layer_node_create(mp, lowerrootvp, &vp);
172 /*
173 * Make sure the fixup worked
174 */
175 if (error) {
176 vput(lowerrootvp);
177 free(nmp, M_UFSMNT); /* XXX */
178 return (error);
179 }
180 /*
181 * Unlock the node
182 */
183 VOP_UNLOCK(vp, 0);
184
185 /*
186 * Keep a held reference to the root vnode.
187 * It is vrele'd in ov_unmount.
188 */
189 vp->v_flag |= VROOT;
190 nmp->ovm_rootvp = vp;
191
192 error = set_statvfs_info(path, UIO_USERSPACE, args.la.target,
193 UIO_USERSPACE, mp, l);
194 #ifdef OVERLAYFS_DIAGNOSTIC
195 printf("ov_mount: lower %s, alias at %s\n",
196 mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
197 #endif
198 return error;
199 }
200
201 /*
202 * Free reference to overlay layer
203 */
204 int
205 ov_unmount(struct mount *mp, int mntflags, struct lwp *l)
206 {
207 struct vnode *overlay_rootvp = MOUNTTOOVERLAYMOUNT(mp)->ovm_rootvp;
208 int error;
209 int flags = 0;
210
211 #ifdef OVERLAYFS_DIAGNOSTIC
212 printf("ov_unmount(mp = %p)\n", mp);
213 #endif
214
215 if (mntflags & MNT_FORCE)
216 flags |= FORCECLOSE;
217
218 if (overlay_rootvp->v_usecount > 1 && (mntflags & MNT_FORCE) == 0)
219 return (EBUSY);
220 if ((error = vflush(mp, overlay_rootvp, flags)) != 0)
221 return (error);
222
223 #ifdef OVERLAYFS_DIAGNOSTIC
224 vprint("alias root of lower", overlay_rootvp);
225 #endif
226 /*
227 * Release reference on underlying root vnode
228 */
229 vrele(overlay_rootvp);
230 /*
231 * And blow it away for future re-use
232 */
233 vgone(overlay_rootvp);
234 /*
235 * Finally, throw away the overlay_mount structure
236 */
237 free(mp->mnt_data, M_UFSMNT); /* XXX */
238 mp->mnt_data = 0;
239 return 0;
240 }
241
242 SYSCTL_SETUP(sysctl_vfs_overlay_setup, "sysctl vfs.overlay subtree setup")
243 {
244
245 sysctl_createv(clog, 0, NULL, NULL,
246 CTLFLAG_PERMANENT, CTLTYPE_NODE, "vfs", NULL,
247 NULL, 0, NULL, 0,
248 CTL_VFS, CTL_EOL);
249 sysctl_createv(clog, 0, NULL, NULL,
250 CTLFLAG_PERMANENT, CTLTYPE_NODE, "overlay",
251 SYSCTL_DESCR("Overlay file system"),
252 NULL, 0, NULL, 0,
253 CTL_VFS, CTL_CREATE, CTL_EOL);
254 }
255
256 extern const struct vnodeopv_desc overlay_vnodeop_opv_desc;
257
258 const struct vnodeopv_desc * const ov_vnodeopv_descs[] = {
259 &overlay_vnodeop_opv_desc,
260 NULL,
261 };
262
263 struct vfsops overlay_vfsops = {
264 MOUNT_OVERLAY,
265 ov_mount,
266 layerfs_start,
267 ov_unmount,
268 layerfs_root,
269 layerfs_quotactl,
270 layerfs_statvfs,
271 layerfs_sync,
272 layerfs_vget,
273 layerfs_fhtovp,
274 layerfs_vptofh,
275 layerfs_init,
276 NULL,
277 layerfs_done,
278 NULL, /* vfs_mountroot */
279 layerfs_snapshot,
280 vfs_stdextattrctl,
281 vfs_stdsuspendctl,
282 ov_vnodeopv_descs,
283 0,
284 { NULL, NULL },
285 };
286 VFS_ATTACH(overlay_vfsops);
287