2 * Copyright (c) 1994, 1995 The Regents of the University of California.
3 * Copyright (c) 1994, 1995 Jan-Simon Pendry.
4 * Copyright (c) 2005, 2006 Masanori Ozawa <ozawa@ongs.co.jp>, ONGS Inc.
5 * Copyright (c) 2006 Daichi Goto <daichi@freebsd.org>
8 * This code is derived from software donated to Berkeley by
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * @(#)union_vfsops.c 8.20 (Berkeley) 5/20/95
39 #include <sys/param.h>
40 #include <sys/systm.h>
42 #include <sys/fcntl.h>
43 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/mount.h>
47 #include <sys/namei.h>
49 #include <sys/vnode.h>
52 #include <fs/unionfs/union.h>
54 static MALLOC_DEFINE(M_UNIONFSMNT, "UNIONFS mount", "UNIONFS mount structure");
56 static vfs_fhtovp_t unionfs_fhtovp;
57 static vfs_checkexp_t unionfs_checkexp;
58 static vfs_mount_t unionfs_domount;
59 static vfs_quotactl_t unionfs_quotactl;
60 static vfs_root_t unionfs_root;
61 static vfs_sync_t unionfs_sync;
62 static vfs_statfs_t unionfs_statfs;
63 static vfs_unmount_t unionfs_unmount;
64 static vfs_vget_t unionfs_vget;
65 static vfs_extattrctl_t unionfs_extattrctl;
67 static struct vfsops unionfs_vfsops;
70 * Exchange from userland file mode to vmode.
73 mode2vmode(mode_t mode)
107 * Mount unionfs layer.
110 unionfs_domount(struct mount *mp, struct thread *td)
113 struct vnode *lowerrootvp;
114 struct vnode *upperrootvp;
115 struct unionfs_mount *ump;
126 unionfs_copymode copymode;
127 unionfs_whitemode whitemode;
128 struct componentname fakecn;
129 struct nameidata nd, *ndp;
132 UNIONFSDEBUG("unionfs_mount(mp = %p)\n", (void *)mp);
140 copymode = UNIONFS_TRANSPARENT; /* default */
141 whitemode = UNIONFS_WHITE_ALWAYS;
144 if (mp->mnt_flag & MNT_ROOTFS) {
145 vfs_mount_error(mp, "Cannot union mount root filesystem");
150 * Update is a no operation.
152 if (mp->mnt_flag & MNT_UPDATE) {
153 vfs_mount_error(mp, "unionfs does not support mount update");
160 error = vfs_getopt(mp->mnt_optnew, "target", (void **)&target, &len);
162 error = vfs_getopt(mp->mnt_optnew, "from", (void **)&target,
164 if (error || target[len - 1] != '\0') {
165 vfs_mount_error(mp, "Invalid target");
168 if (vfs_getopt(mp->mnt_optnew, "below", NULL, NULL) == 0)
170 if (vfs_getopt(mp->mnt_optnew, "udir", (void **)&tmp, NULL) == 0) {
172 udir = (mode_t)strtol(tmp, &ep, 8);
173 if (tmp == NULL || *ep) {
174 vfs_mount_error(mp, "Invalid udir");
177 udir = mode2vmode(udir);
179 if (vfs_getopt(mp->mnt_optnew, "ufile", (void **)&tmp, NULL) == 0) {
181 ufile = (mode_t)strtol(tmp, &ep, 8);
182 if (tmp == NULL || *ep) {
183 vfs_mount_error(mp, "Invalid ufile");
186 ufile = mode2vmode(ufile);
188 /* check umask, uid and gid */
189 if (udir == 0 && ufile != 0)
191 if (ufile == 0 && udir != 0)
194 vn_lock(mp->mnt_vnodecovered, LK_SHARED | LK_RETRY);
195 error = VOP_GETATTR(mp->mnt_vnodecovered, &va, mp->mnt_cred);
204 VOP_UNLOCK(mp->mnt_vnodecovered, 0);
208 if (mp->mnt_cred->cr_ruid == 0) { /* root only */
209 if (vfs_getopt(mp->mnt_optnew, "uid", (void **)&tmp,
212 uid = (uid_t)strtol(tmp, &ep, 10);
213 if (tmp == NULL || *ep) {
214 vfs_mount_error(mp, "Invalid uid");
218 if (vfs_getopt(mp->mnt_optnew, "gid", (void **)&tmp,
221 gid = (gid_t)strtol(tmp, &ep, 10);
222 if (tmp == NULL || *ep) {
223 vfs_mount_error(mp, "Invalid gid");
227 if (vfs_getopt(mp->mnt_optnew, "copymode", (void **)&tmp,
230 vfs_mount_error(mp, "Invalid copymode");
232 } else if (strcasecmp(tmp, "traditional") == 0)
233 copymode = UNIONFS_TRADITIONAL;
234 else if (strcasecmp(tmp, "transparent") == 0)
235 copymode = UNIONFS_TRANSPARENT;
236 else if (strcasecmp(tmp, "masquerade") == 0)
237 copymode = UNIONFS_MASQUERADE;
239 vfs_mount_error(mp, "Invalid copymode");
243 if (vfs_getopt(mp->mnt_optnew, "whiteout", (void **)&tmp,
246 vfs_mount_error(mp, "Invalid whiteout mode");
248 } else if (strcasecmp(tmp, "always") == 0)
249 whitemode = UNIONFS_WHITE_ALWAYS;
250 else if (strcasecmp(tmp, "whenneeded") == 0)
251 whitemode = UNIONFS_WHITE_WHENNEEDED;
253 vfs_mount_error(mp, "Invalid whiteout mode");
258 /* If copymode is UNIONFS_TRADITIONAL, uid/gid is mounted user. */
259 if (copymode == UNIONFS_TRADITIONAL) {
260 uid = mp->mnt_cred->cr_ruid;
261 gid = mp->mnt_cred->cr_rgid;
264 UNIONFSDEBUG("unionfs_mount: uid=%d, gid=%d\n", uid, gid);
265 UNIONFSDEBUG("unionfs_mount: udir=0%03o, ufile=0%03o\n", udir, ufile);
266 UNIONFSDEBUG("unionfs_mount: copymode=%d\n", copymode);
271 NDINIT(ndp, LOOKUP, FOLLOW | WANTPARENT | LOCKLEAF, UIO_SYSSPACE, target, td);
272 if ((error = namei(ndp)))
275 NDFREE(ndp, NDF_ONLY_PNBUF);
277 /* get root vnodes */
278 lowerrootvp = mp->mnt_vnodecovered;
279 upperrootvp = ndp->ni_vp;
282 ndp->ni_dvp = NULLVP;
284 /* create unionfs_mount */
285 ump = (struct unionfs_mount *)malloc(sizeof(struct unionfs_mount),
286 M_UNIONFSMNT, M_WAITOK | M_ZERO);
292 VOP_UNLOCK(upperrootvp, 0);
293 vn_lock(lowerrootvp, LK_EXCLUSIVE | LK_RETRY);
294 ump->um_lowervp = upperrootvp;
295 ump->um_uppervp = lowerrootvp;
297 ump->um_lowervp = lowerrootvp;
298 ump->um_uppervp = upperrootvp;
300 ump->um_rootvp = NULLVP;
304 ump->um_ufile = ufile;
305 ump->um_copymode = copymode;
306 ump->um_whitemode = whitemode;
309 if ((lowerrootvp->v_mount->mnt_kern_flag & MNTK_MPSAFE) &&
310 (upperrootvp->v_mount->mnt_kern_flag & MNTK_MPSAFE))
311 mp->mnt_kern_flag |= MNTK_MPSAFE;
316 * Copy upper layer's RDONLY flag.
318 mp->mnt_flag |= ump->um_uppervp->v_mount->mnt_flag & MNT_RDONLY;
323 if ((mp->mnt_flag & MNT_RDONLY) == 0) {
324 memset(&fakecn, 0, sizeof(fakecn));
325 fakecn.cn_nameiop = LOOKUP;
326 fakecn.cn_thread = td;
327 error = VOP_WHITEOUT(ump->um_uppervp, &fakecn, LOOKUP);
330 VOP_UNLOCK(ump->um_uppervp, 0);
333 vput(ump->um_uppervp);
334 free(ump, M_UNIONFSMNT);
343 VOP_UNLOCK(ump->um_uppervp, 0);
346 * Get the unionfs root vnode.
348 error = unionfs_nodeget(mp, ump->um_uppervp, ump->um_lowervp,
349 NULLVP, &(ump->um_rootvp), NULL, td);
352 free(ump, M_UNIONFSMNT);
360 if ((ump->um_lowervp->v_mount->mnt_flag & MNT_LOCAL) &&
361 (ump->um_uppervp->v_mount->mnt_flag & MNT_LOCAL))
362 mp->mnt_flag |= MNT_LOCAL;
370 tmp = mp->mnt_stat.f_mntfromname;
371 copystr((below ? "<below>:" : "<above>:"), tmp, len, &done);
374 copystr(target, tmp, len, NULL);
376 UNIONFSDEBUG("unionfs_mount: from %s, on %s\n",
377 mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
383 * Free reference to unionfs layer
386 unionfs_unmount(struct mount *mp, int mntflags, struct thread *td)
388 struct unionfs_mount *ump;
394 UNIONFSDEBUG("unionfs_unmount: mp = %p\n", (void *)mp);
396 ump = MOUNTTOUNIONFSMOUNT(mp);
399 if (mntflags & MNT_FORCE)
402 /* vflush (no need to call vrele) */
403 for (freeing = 0; (error = vflush(mp, 1, flags, td)) != 0;) {
404 num = mp->mnt_nvnodelistsize;
413 free(ump, M_UNIONFSMNT);
420 unionfs_root(struct mount *mp, int flags, struct vnode **vpp, struct thread *td)
422 struct unionfs_mount *ump;
425 ump = MOUNTTOUNIONFSMOUNT(mp);
428 UNIONFSDEBUG("unionfs_root: rootvp=%p locked=%x\n",
429 vp, VOP_ISLOCKED(vp));
432 if (flags & LK_TYPE_MASK)
441 unionfs_quotactl(struct mount *mp, int cmd, uid_t uid, void *arg,
444 struct unionfs_mount *ump;
446 ump = MOUNTTOUNIONFSMOUNT(mp);
449 * Writing is always performed to upper vnode.
451 return (VFS_QUOTACTL(ump->um_uppervp->v_mount, cmd, uid, arg, td));
455 unionfs_statfs(struct mount *mp, struct statfs *sbp, struct thread *td)
457 struct unionfs_mount *ump;
462 ump = MOUNTTOUNIONFSMOUNT(mp);
464 UNIONFSDEBUG("unionfs_statfs(mp = %p, lvp = %p, uvp = %p)\n",
465 (void *)mp, (void *)ump->um_lowervp, (void *)ump->um_uppervp);
467 bzero(&mstat, sizeof(mstat));
469 error = VFS_STATFS(ump->um_lowervp->v_mount, &mstat, td);
473 /* now copy across the "interesting" information and fake the rest */
474 sbp->f_blocks = mstat.f_blocks;
475 sbp->f_files = mstat.f_files;
477 lbsize = mstat.f_bsize;
479 error = VFS_STATFS(ump->um_uppervp->v_mount, &mstat, td);
484 * The FS type etc is copy from upper vfs.
485 * (write able vfs have priority)
487 sbp->f_type = mstat.f_type;
488 sbp->f_flags = mstat.f_flags;
489 sbp->f_bsize = mstat.f_bsize;
490 sbp->f_iosize = mstat.f_iosize;
492 if (mstat.f_bsize != lbsize)
493 sbp->f_blocks = ((off_t)sbp->f_blocks * lbsize) / mstat.f_bsize;
495 sbp->f_blocks += mstat.f_blocks;
496 sbp->f_bfree = mstat.f_bfree;
497 sbp->f_bavail = mstat.f_bavail;
498 sbp->f_files += mstat.f_files;
499 sbp->f_ffree = mstat.f_ffree;
504 unionfs_sync(struct mount *mp, int waitfor, struct thread *td)
511 unionfs_vget(struct mount *mp, ino_t ino, int flags, struct vnode **vpp)
517 unionfs_fhtovp(struct mount *mp, struct fid *fidp, struct vnode **vpp)
523 unionfs_checkexp(struct mount *mp, struct sockaddr *nam, int *extflagsp,
524 struct ucred **credanonp)
530 unionfs_extattrctl(struct mount *mp, int cmd, struct vnode *filename_vp,
531 int namespace, const char *attrname, struct thread *td)
533 struct unionfs_mount *ump;
534 struct unionfs_node *unp;
536 ump = MOUNTTOUNIONFSMOUNT(mp);
537 unp = VTOUNIONFS(filename_vp);
539 if (unp->un_uppervp != NULLVP) {
540 return (VFS_EXTATTRCTL(ump->um_uppervp->v_mount, cmd,
541 unp->un_uppervp, namespace, attrname, td));
543 return (VFS_EXTATTRCTL(ump->um_lowervp->v_mount, cmd,
544 unp->un_lowervp, namespace, attrname, td));
548 static struct vfsops unionfs_vfsops = {
549 .vfs_checkexp = unionfs_checkexp,
550 .vfs_extattrctl = unionfs_extattrctl,
551 .vfs_fhtovp = unionfs_fhtovp,
552 .vfs_init = unionfs_init,
553 .vfs_mount = unionfs_domount,
554 .vfs_quotactl = unionfs_quotactl,
555 .vfs_root = unionfs_root,
556 .vfs_statfs = unionfs_statfs,
557 .vfs_sync = unionfs_sync,
558 .vfs_uninit = unionfs_uninit,
559 .vfs_unmount = unionfs_unmount,
560 .vfs_vget = unionfs_vget,
563 VFS_SET(unionfs_vfsops, unionfs, VFCF_LOOPBACK);