sys/vfs/mfs/mfs_vnops.c

   1 /*
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)mfs_vnops.c 8.11 (Berkeley) 5/22/95
  34  * $FreeBSD: src/sys/ufs/mfs/mfs_vnops.c,v 1.47.2.1 2001/05/22 02:06:43 bp Exp $
  35  * $DragonFly: src/sys/vfs/mfs/mfs_vnops.c,v 1.18 2005/06/06 15:09:38 drhodus Exp $
  36  */
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/kernel.h>
  41 #include <sys/proc.h>
  42 #include <sys/buf.h>
  43 #include <sys/vnode.h>
  44 #include <sys/malloc.h>
  45 #include <sys/sysproto.h>
  46 #include <sys/mman.h>
  47 #include <sys/conf.h>
  48
  49 #include <sys/buf2.h>
  50
  51 #include <sys/thread2.h>
  52
  53 #include "mfsnode.h"
  54 #include "mfs_extern.h"
  55
  56 static int      mfs_badop (struct vop_generic_args *);
  57 static int      mfs_bmap (struct vop_bmap_args *);
  58 static int      mfs_close (struct vop_close_args *);
  59 static int      mfs_fsync (struct vop_fsync_args *);
  60 static int      mfs_freeblks (struct vop_freeblks_args *);
  61 static int      mfs_inactive (struct vop_inactive_args *); /* XXX */
  62 static int      mfs_open (struct vop_open_args *);
  63 static int      mfs_reclaim (struct vop_reclaim_args *); /* XXX */
  64 static int      mfs_print (struct vop_print_args *); /* XXX */
  65 static int      mfs_strategy (struct vop_strategy_args *); /* XXX */
  66 static int      mfs_getpages (struct vop_getpages_args *); /* XXX */
  67 /*
  68  * mfs vnode operations.  Note: the vops here are used for the MFS block
  69  * device, not for operations on files (MFS calls the ffs mount code for that)
  70  */
  71 struct vop_ops *mfs_vnode_vops;
  72 static struct vnodeopv_entry_desc mfs_vnodeop_entries[] = {
  73         { &vop_default_desc,            (vnodeopv_entry_t) mfs_badop },
  74         { &vop_bmap_desc,               (vnodeopv_entry_t) mfs_bmap },
  75         { &vop_bwrite_desc,             vop_defaultop },
  76         { &vop_close_desc,              (vnodeopv_entry_t) mfs_close },
  77         { &vop_createvobject_desc,      (vnodeopv_entry_t) vop_stdcreatevobject },
  78         { &vop_destroyvobject_desc,     (vnodeopv_entry_t) vop_stddestroyvobject },
  79         { &vop_freeblks_desc,           (vnodeopv_entry_t) mfs_freeblks },
  80         { &vop_fsync_desc,              (vnodeopv_entry_t) mfs_fsync },
  81         { &vop_getpages_desc,           (vnodeopv_entry_t) mfs_getpages },
  82         { &vop_getvobject_desc,         (vnodeopv_entry_t) vop_stdgetvobject },
  83         { &vop_inactive_desc,           (vnodeopv_entry_t) mfs_inactive },
  84         { &vop_ioctl_desc,              vop_enotty },
  85         { &vop_islocked_desc,           vop_defaultop },
  86         { &vop_lock_desc,               vop_defaultop },
  87         { &vop_open_desc,               (vnodeopv_entry_t) mfs_open },
  88         { &vop_print_desc,              (vnodeopv_entry_t) mfs_print },
  89         { &vop_reclaim_desc,            (vnodeopv_entry_t) mfs_reclaim },
  90         { &vop_strategy_desc,           (vnodeopv_entry_t) mfs_strategy },
  91         { &vop_unlock_desc,             vop_defaultop },
  92         { NULL, NULL }
  93 };
  94 static struct vnodeopv_desc mfs_vnodeop_opv_desc =
  95         { &mfs_vnode_vops, mfs_vnodeop_entries };
  96
  97 VNODEOP_SET(mfs_vnodeop_opv_desc);
  98
  99 /*
 100  * Vnode Operations.
 101  *
 102  * Open called to allow memory filesystem to initialize and
 103  * validate before actual IO. Record our process identifier
 104  * so we can tell when we are doing I/O to ourself.
 105  *
 106  * NOTE: new device sequencing.  mounts check the device reference count
 107  * before calling open, so we must associate the device in open and
 108  * disassociate it in close rather then faking it when we created the vnode.
 109  *
 110  * mfs_open(struct vnode *a_vp, int a_mode, struct ucred *a_cred,
 111  *          struct thread *a_td)
 112  */
 113 /* ARGSUSED */
 114 static int
 115 mfs_open(struct vop_open_args *ap)
 116 {
 117         struct vnode *vp = ap->a_vp;
 118
 119         if (vp->v_type != VCHR)
 120                 panic("mfs_open not VCHR");
 121         v_associate_rdev(vp, udev2dev(vp->v_udev, 0));
 122         return (0);
 123 }
 124
 125 static int
 126 mfs_fsync(struct vop_fsync_args *ap)
 127 {
 128         return (VOCALL(spec_vnode_vops, &ap->a_head));
 129 }
 130
 131 /*
 132  * mfs_freeblks() - hook to allow us to free physical memory.
 133  *
 134  *      We implement the B_FREEBUF strategy.  We can't just madvise()
 135  *      here because we have to do it in the correct order vs other bio
 136  *      requests, so we queue it.
 137  *
 138  *      Note: geteblk() sets B_INVAL.  We leave it set to guarentee buffer
 139  *      throw-away on brelse()? XXX
 140  *
 141  * mfs_freeblks(struct vnode *a_vp, daddr_t a_addr, daddr_t a_length)
 142  */
 143 static int
 144 mfs_freeblks(struct vop_freeblks_args *ap)
 145 {
 146         struct buf *bp;
 147         struct vnode *vp = ap->a_vp;
 148
 149         bp = geteblk(ap->a_length);
 150         bp->b_flags |= B_FREEBUF | B_ASYNC;
 151         bp->b_dev = vp->v_rdev;
 152         bp->b_blkno = ap->a_addr;
 153         bp->b_offset = dbtob(ap->a_addr);
 154         bp->b_bcount = ap->a_length;
 155         BUF_KERNPROC(bp);
 156         VOP_STRATEGY(vp, bp);
 157         return(0);
 158 }
 159
 160 /*
 161  * Pass I/O requests to the memory filesystem process.
 162  *
 163  * mfs_strategy(struct vnode *a_vp, struct buf *a_bp)
 164  */
 165 static int
 166 mfs_strategy(struct vop_strategy_args *ap)
 167 {
 168         struct buf *bp = ap->a_bp;
 169         struct mfsnode *mfsp;
 170         struct thread *td = curthread;          /* XXX */
 171
 172         bp->b_dev = ap->a_vp->v_rdev;
 173         mfsp = bp->b_dev->si_drv1;
 174         if (mfsp == NULL) {
 175                 bp->b_error = ENXIO;
 176                 bp->b_flags |= B_ERROR;
 177                 biodone(bp);
 178                 return(0);
 179         }
 180
 181         /*
 182          * splbio required for queueing/dequeueing, in case of forwarded
 183          * BPs from bio interrupts (?).  It may not be necessary.
 184          */
 185
 186         crit_enter();
 187
 188         if (mfsp->mfs_td == NULL) {
 189                 /*
 190                  * mini-root.  Note: B_FREEBUF not supported at the moment,
 191                  * I'm not sure what kind of dataspace b_data is in.
 192                  */
 193                 caddr_t base;
 194
 195                 base = mfsp->mfs_baseoff + (bp->b_blkno << DEV_BSHIFT);
 196                 if (bp->b_flags & B_FREEBUF)
 197                         ;
 198                 if (bp->b_flags & B_READ)
 199                         bcopy(base, bp->b_data, bp->b_bcount);
 200                 else
 201                         bcopy(bp->b_data, base, bp->b_bcount);
 202                 biodone(bp);
 203         } else if (mfsp->mfs_td == td) {
 204                 /*
 205                  * VOP to self
 206                  */
 207                 crit_exit();
 208                 mfs_doio(bp, mfsp);
 209                 crit_enter();
 210         } else {
 211                 /*
 212                  * VOP from some other process, queue to MFS process and
 213                  * wake it up.
 214                  */
 215                 bufq_insert_tail(&mfsp->buf_queue, bp);
 216                 wakeup((caddr_t)mfsp);
 217         }
 218         crit_exit();
 219         return (0);
 220 }
 221
 222 /*
 223  * Memory file system I/O.
 224  *
 225  * Trivial on the HP since buffer has already been mapping into KVA space.
 226  *
 227  * Read and Write are handled with a simple copyin and copyout.
 228  *
 229  * We also partially support VOP_FREEBLKS() via B_FREEBUF.  We can't implement
 230  * completely -- for example, on fragments or inode metadata, but we can
 231  * implement it for page-aligned requests.
 232  */
 233 void
 234 mfs_doio(struct buf *bp, struct mfsnode *mfsp)
 235 {
 236         caddr_t base = mfsp->mfs_baseoff + (bp->b_blkno << DEV_BSHIFT);
 237
 238         if (bp->b_flags & B_FREEBUF) {
 239                 /*
 240                  * Implement B_FREEBUF, which allows the filesystem to tell
 241                  * a block device when blocks are no longer needed (like when
 242                  * a file is deleted).  We use the hook to MADV_FREE the VM.
 243                  * This makes an MFS filesystem work as well or better then
 244                  * a sun-style swap-mounted filesystem.
 245                  */
 246                 int bytes = bp->b_bcount;
 247
 248                 if ((vm_offset_t)base & PAGE_MASK) {
 249                         int n = PAGE_SIZE - ((vm_offset_t)base & PAGE_MASK);
 250                         bytes -= n;
 251                         base += n;
 252                 }
 253                 if (bytes > 0) {
 254                         struct madvise_args uap;
 255
 256                         bytes &= ~PAGE_MASK;
 257                         if (bytes != 0) {
 258                                 bzero(&uap, sizeof(uap));
 259                                 uap.addr  = base;
 260                                 uap.len   = bytes;
 261                                 uap.behav = MADV_FREE;
 262                                 madvise(&uap);
 263                         }
 264                 }
 265                 bp->b_error = 0;
 266         } else if (bp->b_flags & B_READ) {
 267                 /*
 268                  * Read data from our 'memory' disk
 269                  */
 270                 bp->b_error = copyin(base, bp->b_data, bp->b_bcount);
 271         } else {
 272                 /*
 273                  * Write data to our 'memory' disk
 274                  */
 275                 bp->b_error = copyout(bp->b_data, base, bp->b_bcount);
 276         }
 277         if (bp->b_error)
 278                 bp->b_flags |= B_ERROR;
 279         biodone(bp);
 280 }
 281
 282 /*
 283  * This is a noop, simply returning what one has been given.
 284  *
 285  * mfs_bmap(struct vnode *a_vp, ufs_daddr_t a_bn, struct vnode **a_vpp,
 286  *          ufs_daddr_t *a_bnp, int *a_runp)
 287  */
 288 static int
 289 mfs_bmap(struct vop_bmap_args *ap)
 290 {
 291         if (ap->a_vpp != NULL)
 292                 *ap->a_vpp = ap->a_vp;
 293         if (ap->a_bnp != NULL)
 294                 *ap->a_bnp = ap->a_bn;
 295         if (ap->a_runp != NULL)
 296                 *ap->a_runp = 0;
 297         return (0);
 298 }
 299
 300 /*
 301  * Memory filesystem close routine
 302  *
 303  * mfs_close(struct vnode *a_vp, int a_fflag, struct ucred *a_cred,
 304  *           struct thread *a_td)
 305  */
 306 /* ARGSUSED */
 307 static int
 308 mfs_close(struct vop_close_args *ap)
 309 {
 310         struct vnode *vp = ap->a_vp;
 311         struct mfsnode *mfsp = VTOMFS(vp);
 312         struct buf *bp;
 313         int error;
 314
 315         /*
 316          * Finish any pending I/O requests.
 317          */
 318         while ((bp = bufq_first(&mfsp->buf_queue)) != NULL) {
 319                 bufq_remove(&mfsp->buf_queue, bp);
 320                 mfs_doio(bp, mfsp);
 321                 wakeup((caddr_t)bp);
 322         }
 323         /*
 324          * On last close of a memory filesystem
 325          * we must invalidate any in core blocks, so that
 326          * we can, free up its vnode.
 327          */
 328         if ((error = vinvalbuf(vp, 1, ap->a_td, 0, 0)) != 0)
 329                 return (error);
 330         /*
 331          * There should be no way to have any more uses of this
 332          * vnode, so if we find any other uses, it is a panic.
 333          */
 334         if (vp->v_usecount > 1)
 335                 printf("mfs_close: ref count %d > 1\n", vp->v_usecount);
 336         if (vp->v_usecount > 1 || (bufq_first(&mfsp->buf_queue) != NULL))
 337                 panic("mfs_close");
 338         /*
 339          * Send a request to the filesystem server to exit.
 340          */
 341         mfsp->mfs_active = 0;
 342         v_release_rdev(vp);
 343         if (mfsp->mfs_dev) {
 344                 destroy_dev(mfsp->mfs_dev);
 345                 mfsp->mfs_dev = NULL;
 346         }
 347         wakeup((caddr_t)mfsp);
 348         return (0);
 349 }
 350
 351 /*
 352  * Memory filesystem inactive routine
 353  *
 354  * mfs_inactive(struct vnode *a_vp, struct thread *a_td)
 355  */
 356 /* ARGSUSED */
 357 static int
 358 mfs_inactive(struct vop_inactive_args *ap)
 359 {
 360         struct vnode *vp = ap->a_vp;
 361         struct mfsnode *mfsp = VTOMFS(vp);
 362
 363         if (bufq_first(&mfsp->buf_queue) != NULL)
 364                 panic("mfs_inactive: not inactive (next buffer %p)",
 365                         bufq_first(&mfsp->buf_queue));
 366         return (0);
 367 }
 368
 369 /*
 370  * Reclaim a memory filesystem devvp so that it can be reused.
 371  *
 372  * mfs_reclaim(struct vnode *a_vp)
 373  */
 374 static int
 375 mfs_reclaim(struct vop_reclaim_args *ap)
 376 {
 377         struct vnode *vp = ap->a_vp;
 378
 379         FREE(vp->v_data, M_MFSNODE);
 380         vp->v_data = NULL;
 381         return (0);
 382 }
 383
 384 /*
 385  * Print out the contents of an mfsnode.
 386  *
 387  * mfs_print(struct vnode *a_vp)
 388  */
 389 static int
 390 mfs_print(struct vop_print_args *ap)
 391 {
 392         struct mfsnode *mfsp = VTOMFS(ap->a_vp);
 393
 394         printf("tag VT_MFS, td %p, base %p, size %ld\n",
 395             mfsp->mfs_td, (void *)mfsp->mfs_baseoff, mfsp->mfs_size);
 396         return (0);
 397 }
 398
 399 /*
 400  * Block device bad operation
 401  */
 402 static int
 403 mfs_badop(struct vop_generic_args *ap)
 404 {
 405         int i;
 406
 407         printf("mfs_badop[%s]\n", ap->a_desc->vdesc_name);
 408         i = vop_defaultop(ap);
 409         printf("mfs_badop[%s] = %d\n", ap->a_desc->vdesc_name, i);
 410         return (i);
 411 }
 412
 413 static int
 414 mfs_getpages(struct vop_getpages_args *ap)
 415 {
 416         return (VOCALL(spec_vnode_vops, &ap->a_head));
 417 }