sys/fs/umapfs/umap_vfsops.c

   1 /*
   2  * Copyright (c) 1992, 1993, 1995
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software donated to Berkeley by
   6  * the UCLA Ficus project.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)umap_vfsops.c       8.8 (Berkeley) 5/14/95
  37  *
  38  * $FreeBSD$
  39  */
  40
  41 /*
  42  * Umap Layer
  43  * (See mount_umap(8) for a description of this layer.)
  44  */
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/kernel.h>
  49 #include <sys/proc.h>
  50 #include <sys/vnode.h>
  51 #include <sys/mount.h>
  52 #include <sys/namei.h>
  53 #include <sys/malloc.h>
  54 #include <miscfs/umapfs/umap.h>
  55
  56 static MALLOC_DEFINE(M_UMAPFSMNT, "UMAP mount", "UMAP mount structure");
  57
  58 static int      umapfs_fhtovp __P((struct mount *mp, struct fid *fidp,
  59                                    struct sockaddr *nam, struct vnode **vpp,
  60                                    int *exflagsp, struct ucred **credanonp));
  61 static int      umapfs_mount __P((struct mount *mp, char *path, caddr_t data,
  62                                   struct nameidata *ndp, struct proc *p));
  63 static int      umapfs_quotactl __P((struct mount *mp, int cmd, uid_t uid,
  64                                      caddr_t arg, struct proc *p));
  65 static int      umapfs_root __P((struct mount *mp, struct vnode **vpp));
  66 static int      umapfs_start __P((struct mount *mp, int flags, struct proc *p));
  67 static int      umapfs_statfs __P((struct mount *mp, struct statfs *sbp,
  68                                    struct proc *p));
  69 static int      umapfs_sync __P((struct mount *mp, int waitfor,
  70                                  struct ucred *cred, struct proc *p));
  71 static int      umapfs_unmount __P((struct mount *mp, int mntflags,
  72                                     struct proc *p));
  73 static int      umapfs_vget __P((struct mount *mp, ino_t ino,
  74                                  struct vnode **vpp));
  75 static int      umapfs_vptofh __P((struct vnode *vp, struct fid *fhp));
  76
  77 /*
  78  * Mount umap layer
  79  */
  80 static int
  81 umapfs_mount(mp, path, data, ndp, p)
  82         struct mount *mp;
  83         char *path;
  84         caddr_t data;
  85         struct nameidata *ndp;
  86         struct proc *p;
  87 {
  88         struct umap_args args;
  89         struct vnode *lowerrootvp, *vp;
  90         struct vnode *umapm_rootvp;
  91         struct umap_mount *amp;
  92         u_int size;
  93         int error;
  94 #ifdef DEBUG
  95         int     i;
  96 #endif
  97
  98         /*
  99          * Only for root
 100          */
 101         if ((error = suser(p)) != 0)
 102                 return (error);
 103
 104 #ifdef DEBUG
 105         printf("umapfs_mount(mp = %p)\n", (void *)mp);
 106 #endif
 107
 108         /*
 109          * Update is a no-op
 110          */
 111         if (mp->mnt_flag & MNT_UPDATE) {
 112                 return (EOPNOTSUPP);
 113                 /* return (VFS_MOUNT(MOUNTTOUMAPMOUNT(mp)->umapm_vfs, path, data, ndp, p));*/
 114         }
 115
 116         /*
 117          * Get argument
 118          */
 119         error = copyin(data, (caddr_t)&args, sizeof(struct umap_args));
 120         if (error)
 121                 return (error);
 122
 123         /*
 124          * Find lower node
 125          */
 126         NDINIT(ndp, LOOKUP, FOLLOW|WANTPARENT|LOCKLEAF,
 127                 UIO_USERSPACE, args.target, p);
 128         error = namei(ndp);
 129         if (error)
 130                 return (error);
 131
 132         /*
 133          * Sanity check on lower vnode
 134          */
 135         lowerrootvp = ndp->ni_vp;
 136 #ifdef DEBUG
 137         printf("vp = %p, check for VDIR...\n", (void *)lowerrootvp);
 138 #endif
 139         vrele(ndp->ni_dvp);
 140         ndp->ni_dvp = 0;
 141
 142         if (lowerrootvp->v_type != VDIR) {
 143                 vput(lowerrootvp);
 144                 return (EINVAL);
 145         }
 146
 147 #ifdef DEBUG
 148         printf("mp = %p\n", (void *)mp);
 149 #endif
 150
 151         amp = (struct umap_mount *) malloc(sizeof(struct umap_mount),
 152                                 M_UMAPFSMNT, M_WAITOK); /* XXX */
 153
 154         /*
 155          * Save reference to underlying FS
 156          */
 157         amp->umapm_vfs = lowerrootvp->v_mount;
 158
 159         /*
 160          * Now copy in the number of entries and maps for umap mapping.
 161          */
 162         amp->info_nentries = args.nentries;
 163         amp->info_gnentries = args.gnentries;
 164         error = copyin(args.mapdata, (caddr_t)amp->info_mapdata,
 165             2*sizeof(u_long)*args.nentries);
 166         if (error)
 167                 return (error);
 168
 169 #ifdef DEBUG
 170         printf("umap_mount:nentries %d\n",args.nentries);
 171         for (i = 0; i < args.nentries; i++)
 172                 printf("   %lu maps to %lu\n", amp->info_mapdata[i][0],
 173                     amp->info_mapdata[i][1]);
 174 #endif
 175
 176         error = copyin(args.gmapdata, (caddr_t)amp->info_gmapdata,
 177             2*sizeof(u_long)*args.gnentries);
 178         if (error)
 179                 return (error);
 180
 181 #ifdef DEBUG
 182         printf("umap_mount:gnentries %d\n",args.gnentries);
 183         for (i = 0; i < args.gnentries; i++)
 184                 printf("        group %lu maps to %lu\n",
 185                     amp->info_gmapdata[i][0],
 186                     amp->info_gmapdata[i][1]);
 187 #endif
 188
 189
 190         /*
 191          * Save reference.  Each mount also holds
 192          * a reference on the root vnode.
 193          */
 194         error = umap_node_create(mp, lowerrootvp, &vp);
 195         /*
 196          * Unlock the node (either the lower or the alias)
 197          */
 198         VOP_UNLOCK(vp, 0, p);
 199         /*
 200          * Make sure the node alias worked
 201          */
 202         if (error) {
 203                 vrele(lowerrootvp);
 204                 free(amp, M_UMAPFSMNT); /* XXX */
 205                 return (error);
 206         }
 207
 208         /*
 209          * Keep a held reference to the root vnode.
 210          * It is vrele'd in umapfs_unmount.
 211          */
 212         umapm_rootvp = vp;
 213         umapm_rootvp->v_flag |= VROOT;
 214         amp->umapm_rootvp = umapm_rootvp;
 215         if (UMAPVPTOLOWERVP(umapm_rootvp)->v_mount->mnt_flag & MNT_LOCAL)
 216                 mp->mnt_flag |= MNT_LOCAL;
 217         mp->mnt_data = (qaddr_t) amp;
 218         vfs_getnewfsid(mp);
 219
 220         (void) copyinstr(path, mp->mnt_stat.f_mntonname, MNAMELEN - 1, &size);
 221         bzero(mp->mnt_stat.f_mntonname + size, MNAMELEN - size);
 222         (void) copyinstr(args.target, mp->mnt_stat.f_mntfromname, MNAMELEN - 1,
 223             &size);
 224         bzero(mp->mnt_stat.f_mntfromname + size, MNAMELEN - size);
 225         (void)umapfs_statfs(mp, &mp->mnt_stat, p);
 226 #ifdef DEBUG
 227         printf("umapfs_mount: lower %s, alias at %s\n",
 228                 mp->mnt_stat.f_mntfromname, mp->mnt_stat.f_mntonname);
 229 #endif
 230         return (0);
 231 }
 232
 233 /*
 234  * VFS start.  Nothing needed here - the start routine
 235  * on the underlying filesystem will have been called
 236  * when that filesystem was mounted.
 237  */
 238 static int
 239 umapfs_start(mp, flags, p)
 240         struct mount *mp;
 241         int flags;
 242         struct proc *p;
 243 {
 244         return (0);
 245         /* return (VFS_START(MOUNTTOUMAPMOUNT(mp)->umapm_vfs, flags, p)); */
 246 }
 247
 248 /*
 249  * Free reference to umap layer
 250  */
 251 static int
 252 umapfs_unmount(mp, mntflags, p)
 253         struct mount *mp;
 254         int mntflags;
 255         struct proc *p;
 256 {
 257         struct vnode *umapm_rootvp = MOUNTTOUMAPMOUNT(mp)->umapm_rootvp;
 258         int error;
 259         int flags = 0;
 260
 261 #ifdef DEBUG
 262         printf("umapfs_unmount(mp = %p)\n", (void *)mp);
 263 #endif
 264
 265         if (mntflags & MNT_FORCE)
 266                 flags |= FORCECLOSE;
 267
 268         /*
 269          * Clear out buffer cache.  I don't think we
 270          * ever get anything cached at this level at the
 271          * moment, but who knows...
 272          */
 273 #ifdef notyet
 274         mntflushbuf(mp, 0);
 275         if (mntinvalbuf(mp, 1))
 276                 return (EBUSY);
 277 #endif
 278         if (umapm_rootvp->v_usecount > 1)
 279                 return (EBUSY);
 280         error = vflush(mp, umapm_rootvp, flags);
 281         if (error)
 282                 return (error);
 283
 284 #ifdef DEBUG
 285         vprint("alias root of lower", umapm_rootvp);
 286 #endif
 287         /*
 288          * Release reference on underlying root vnode
 289          */
 290         vrele(umapm_rootvp);
 291         /*
 292          * And blow it away for future re-use
 293          */
 294         vgone(umapm_rootvp);
 295         /*
 296          * Finally, throw away the umap_mount structure
 297          */
 298         free(mp->mnt_data, M_UMAPFSMNT);        /* XXX */
 299         mp->mnt_data = 0;
 300         return (0);
 301 }
 302
 303 static int
 304 umapfs_root(mp, vpp)
 305         struct mount *mp;
 306         struct vnode **vpp;
 307 {
 308         struct proc *p = curproc;       /* XXX */
 309         struct vnode *vp;
 310
 311 #ifdef DEBUG
 312         printf("umapfs_root(mp = %p, vp = %p->%p)\n",
 313             (void *)mp, (void *)MOUNTTOUMAPMOUNT(mp)->umapm_rootvp,
 314             (void *)UMAPVPTOLOWERVP(MOUNTTOUMAPMOUNT(mp)->umapm_rootvp));
 315 #endif
 316
 317         /*
 318          * Return locked reference to root.
 319          */
 320         vp = MOUNTTOUMAPMOUNT(mp)->umapm_rootvp;
 321         VREF(vp);
 322         vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, p);
 323         *vpp = vp;
 324         return (0);
 325 }
 326
 327 static int
 328 umapfs_quotactl(mp, cmd, uid, arg, p)
 329         struct mount *mp;
 330         int cmd;
 331         uid_t uid;
 332         caddr_t arg;
 333         struct proc *p;
 334 {
 335         return (VFS_QUOTACTL(MOUNTTOUMAPMOUNT(mp)->umapm_vfs, cmd, uid, arg, p));
 336 }
 337
 338 static int
 339 umapfs_statfs(mp, sbp, p)
 340         struct mount *mp;
 341         struct statfs *sbp;
 342         struct proc *p;
 343 {
 344         int error;
 345         struct statfs mstat;
 346
 347 #ifdef DEBUG
 348         printf("umapfs_statfs(mp = %p, vp = %p->%p)\n",
 349             (void *)mp, (void *)MOUNTTOUMAPMOUNT(mp)->umapm_rootvp,
 350             (void *)UMAPVPTOLOWERVP(MOUNTTOUMAPMOUNT(mp)->umapm_rootvp));
 351 #endif
 352
 353         bzero(&mstat, sizeof(mstat));
 354
 355         error = VFS_STATFS(MOUNTTOUMAPMOUNT(mp)->umapm_vfs, &mstat, p);
 356         if (error)
 357                 return (error);
 358
 359         /* now copy across the "interesting" information and fake the rest */
 360         sbp->f_type = mstat.f_type;
 361         sbp->f_flags = mstat.f_flags;
 362         sbp->f_bsize = mstat.f_bsize;
 363         sbp->f_iosize = mstat.f_iosize;
 364         sbp->f_blocks = mstat.f_blocks;
 365         sbp->f_bfree = mstat.f_bfree;
 366         sbp->f_bavail = mstat.f_bavail;
 367         sbp->f_files = mstat.f_files;
 368         sbp->f_ffree = mstat.f_ffree;
 369         if (sbp != &mp->mnt_stat) {
 370                 bcopy(&mp->mnt_stat.f_fsid, &sbp->f_fsid, sizeof(sbp->f_fsid));
 371                 bcopy(mp->mnt_stat.f_mntonname, sbp->f_mntonname, MNAMELEN);
 372                 bcopy(mp->mnt_stat.f_mntfromname, sbp->f_mntfromname, MNAMELEN);
 373         }
 374         return (0);
 375 }
 376
 377 static int
 378 umapfs_sync(mp, waitfor, cred, p)
 379         struct mount *mp;
 380         int waitfor;
 381         struct ucred *cred;
 382         struct proc *p;
 383 {
 384         /*
 385          * XXX - Assumes no data cached at umap layer.
 386          */
 387         return (0);
 388 }
 389
 390 static int
 391 umapfs_vget(mp, ino, vpp)
 392         struct mount *mp;
 393         ino_t ino;
 394         struct vnode **vpp;
 395 {
 396
 397         return (VFS_VGET(MOUNTTOUMAPMOUNT(mp)->umapm_vfs, ino, vpp));
 398 }
 399
 400 static int
 401 umapfs_fhtovp(mp, fidp, nam, vpp, exflagsp, credanonp)
 402         struct mount *mp;
 403         struct fid *fidp;
 404         struct sockaddr *nam;
 405         struct vnode **vpp;
 406         int *exflagsp;
 407         struct ucred**credanonp;
 408 {
 409
 410         return (VFS_FHTOVP(MOUNTTOUMAPMOUNT(mp)->umapm_vfs, fidp, nam, vpp, exflagsp,credanonp));
 411 }
 412
 413 static int
 414 umapfs_vptofh(vp, fhp)
 415         struct vnode *vp;
 416         struct fid *fhp;
 417 {
 418         return (VFS_VPTOFH(UMAPVPTOLOWERVP(vp), fhp));
 419 }
 420
 421 static struct vfsops umap_vfsops = {
 422         umapfs_mount,
 423         umapfs_start,
 424         umapfs_unmount,
 425         umapfs_root,
 426         umapfs_quotactl,
 427         umapfs_statfs,
 428         umapfs_sync,
 429         umapfs_vget,
 430         umapfs_fhtovp,
 431         umapfs_vptofh,
 432         umapfs_init,
 433 };
 434
 435 VFS_SET(umap_vfsops, umap, VFCF_LOOPBACK);