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.16 2004/10/12 19:20:59 dillon 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 "mfsnode.h"
  52 #include "mfs_extern.h"
  53
  54 static int      mfs_badop (struct vop_generic_args *);
  55 static int      mfs_bmap (struct vop_bmap_args *);
  56 static int      mfs_close (struct vop_close_args *);
  57 static int      mfs_fsync (struct vop_fsync_args *);
  58 static int      mfs_freeblks (struct vop_freeblks_args *);
  59 static int      mfs_inactive (struct vop_inactive_args *); /* XXX */
  60 static int      mfs_open (struct vop_open_args *);
  61 static int      mfs_reclaim (struct vop_reclaim_args *); /* XXX */
  62 static int      mfs_print (struct vop_print_args *); /* XXX */
  63 static int      mfs_strategy (struct vop_strategy_args *); /* XXX */
  64 static int      mfs_getpages (struct vop_getpages_args *); /* XXX */
  65 /*
  66  * mfs vnode operations.  Note: the vops here are used for the MFS block
  67  * device, not for operations on files (MFS calls the ffs mount code for that)
  68  */
  69 struct vop_ops *mfs_vnode_vops;
  70 static struct vnodeopv_entry_desc mfs_vnodeop_entries[] = {
  71         { &vop_default_desc,            (void *) mfs_badop },
  72         { &vop_bmap_desc,               (void *) mfs_bmap },
  73         { &vop_bwrite_desc,             vop_defaultop },
  74         { &vop_close_desc,              (void *) mfs_close },
  75         { &vop_createvobject_desc,      (void *) vop_stdcreatevobject },
  76         { &vop_destroyvobject_desc,     (void *) vop_stddestroyvobject },
  77         { &vop_freeblks_desc,           (void *) mfs_freeblks },
  78         { &vop_fsync_desc,              (void *) mfs_fsync },
  79         { &vop_getpages_desc,           (void *) mfs_getpages },
  80         { &vop_getvobject_desc,         (void *) vop_stdgetvobject },
  81         { &vop_inactive_desc,           (void *) mfs_inactive },
  82         { &vop_ioctl_desc,              vop_enotty },
  83         { &vop_islocked_desc,           vop_defaultop },
  84         { &vop_lock_desc,               vop_defaultop },
  85         { &vop_open_desc,               (void *) mfs_open },
  86         { &vop_print_desc,              (void *) mfs_print },
  87         { &vop_reclaim_desc,            (void *) mfs_reclaim },
  88         { &vop_strategy_desc,           (void *) mfs_strategy },
  89         { &vop_unlock_desc,             vop_defaultop },
  90         { NULL, NULL }
  91 };
  92 static struct vnodeopv_desc mfs_vnodeop_opv_desc =
  93         { &mfs_vnode_vops, mfs_vnodeop_entries };
  94
  95 VNODEOP_SET(mfs_vnodeop_opv_desc);
  96
  97 /*
  98  * Vnode Operations.
  99  *
 100  * Open called to allow memory filesystem to initialize and
 101  * validate before actual IO. Record our process identifier
 102  * so we can tell when we are doing I/O to ourself.
 103  *
 104  * NOTE: new device sequencing.  mounts check the device reference count
 105  * before calling open, so we must associate the device in open and
 106  * disassociate it in close rather then faking it when we created the vnode.
 107  *
 108  * mfs_open(struct vnode *a_vp, int a_mode, struct ucred *a_cred,
 109  *          struct thread *a_td)
 110  */
 111 /* ARGSUSED */
 112 static int
 113 mfs_open(struct vop_open_args *ap)
 114 {
 115         struct vnode *vp = ap->a_vp;
 116
 117         if (vp->v_type != VCHR)
 118                 panic("mfs_open not VCHR");
 119         v_associate_rdev(vp, udev2dev(vp->v_udev, 0));
 120         return (0);
 121 }
 122
 123 static int
 124 mfs_fsync(struct vop_fsync_args *ap)
 125 {
 126         return (VOCALL(spec_vnode_vops, &ap->a_head));
 127 }
 128
 129 /*
 130  * mfs_freeblks() - hook to allow us to free physical memory.
 131  *
 132  *      We implement the B_FREEBUF strategy.  We can't just madvise()
 133  *      here because we have to do it in the correct order vs other bio
 134  *      requests, so we queue it.
 135  *
 136  *      Note: geteblk() sets B_INVAL.  We leave it set to guarentee buffer
 137  *      throw-away on brelse()? XXX
 138  *
 139  * mfs_freeblks(struct vnode *a_vp, daddr_t a_addr, daddr_t a_length)
 140  */
 141 static int
 142 mfs_freeblks(struct vop_freeblks_args *ap)
 143 {
 144         struct buf *bp;
 145         struct vnode *vp = ap->a_vp;
 146
 147         bp = geteblk(ap->a_length);
 148         bp->b_flags |= B_FREEBUF | B_ASYNC;
 149         bp->b_dev = vp->v_rdev;
 150         bp->b_blkno = ap->a_addr;
 151         bp->b_offset = dbtob(ap->a_addr);
 152         bp->b_bcount = ap->a_length;
 153         BUF_KERNPROC(bp);
 154         VOP_STRATEGY(vp, bp);
 155         return(0);
 156 }
 157
 158 /*
 159  * Pass I/O requests to the memory filesystem process.
 160  *
 161  * mfs_strategy(struct vnode *a_vp, struct buf *a_bp)
 162  */
 163 static int
 164 mfs_strategy(struct vop_strategy_args *ap)
 165 {
 166         struct buf *bp = ap->a_bp;
 167         struct mfsnode *mfsp;
 168         struct thread *td = curthread;          /* XXX */
 169         int s;
 170
 171         bp->b_dev = ap->a_vp->v_rdev;
 172         mfsp = bp->b_dev->si_drv1;
 173         if (mfsp == NULL) {
 174                 bp->b_error = ENXIO;
 175                 bp->b_flags |= B_ERROR;
 176                 biodone(bp);
 177                 return(0);
 178         }
 179
 180         /*
 181          * splbio required for queueing/dequeueing, in case of forwarded
 182          * BPs from bio interrupts (?).  It may not be necessary.
 183          */
 184
 185         s = splbio();
 186
 187         if (mfsp->mfs_td == NULL) {
 188                 /*
 189                  * mini-root.  Note: B_FREEBUF not supported at the moment,
 190                  * I'm not sure what kind of dataspace b_data is in.
 191                  */
 192                 caddr_t base;
 193
 194                 base = mfsp->mfs_baseoff + (bp->b_blkno << DEV_BSHIFT);
 195                 if (bp->b_flags & B_FREEBUF)
 196                         ;
 197                 if (bp->b_flags & B_READ)
 198                         bcopy(base, bp->b_data, bp->b_bcount);
 199                 else
 200                         bcopy(bp->b_data, base, bp->b_bcount);
 201                 biodone(bp);
 202         } else if (mfsp->mfs_td == td) {
 203                 /*
 204                  * VOP to self
 205                  */
 206                 splx(s);
 207                 mfs_doio(bp, mfsp);
 208                 s = splbio();
 209         } else {
 210                 /*
 211                  * VOP from some other process, queue to MFS process and
 212                  * wake it up.
 213                  */
 214                 bufq_insert_tail(&mfsp->buf_queue, bp);
 215                 wakeup((caddr_t)mfsp);
 216         }
 217         splx(s);
 218         return (0);
 219 }
 220
 221 /*
 222  * Memory file system I/O.
 223  *
 224  * Trivial on the HP since buffer has already been mapping into KVA space.
 225  *
 226  * Read and Write are handled with a simple copyin and copyout.
 227  *
 228  * We also partially support VOP_FREEBLKS() via B_FREEBUF.  We can't implement
 229  * completely -- for example, on fragments or inode metadata, but we can
 230  * implement it for page-aligned requests.
 231  */
 232 void
 233 mfs_doio(struct buf *bp, struct mfsnode *mfsp)
 234 {
 235         caddr_t base = mfsp->mfs_baseoff + (bp->b_blkno << DEV_BSHIFT);
 236
 237         if (bp->b_flags & B_FREEBUF) {
 238                 /*
 239                  * Implement B_FREEBUF, which allows the filesystem to tell
 240                  * a block device when blocks are no longer needed (like when
 241                  * a file is deleted).  We use the hook to MADV_FREE the VM.
 242                  * This makes an MFS filesystem work as well or better then
 243                  * a sun-style swap-mounted filesystem.
 244                  */
 245                 int bytes = bp->b_bcount;
 246
 247                 if ((vm_offset_t)base & PAGE_MASK) {
 248                         int n = PAGE_SIZE - ((vm_offset_t)base & PAGE_MASK);
 249                         bytes -= n;
 250                         base += n;
 251                 }
 252                 if (bytes > 0) {
 253                         struct madvise_args uap;
 254
 255                         bytes &= ~PAGE_MASK;
 256                         if (bytes != 0) {
 257                                 bzero(&uap, sizeof(uap));
 258                                 uap.addr  = base;
 259                                 uap.len   = bytes;
 260                                 uap.behav = MADV_FREE;
 261                                 madvise(&uap);
 262                         }
 263                 }
 264                 bp->b_error = 0;
 265         } else if (bp->b_flags & B_READ) {
 266                 /*
 267                  * Read data from our 'memory' disk
 268                  */
 269                 bp->b_error = copyin(base, bp->b_data, bp->b_bcount);
 270         } else {
 271                 /*
 272                  * Write data to our 'memory' disk
 273                  */
 274                 bp->b_error = copyout(bp->b_data, base, bp->b_bcount);
 275         }
 276         if (bp->b_error)
 277                 bp->b_flags |= B_ERROR;
 278         biodone(bp);
 279 }
 280
 281 /*
 282  * This is a noop, simply returning what one has been given.
 283  *
 284  * mfs_bmap(struct vnode *a_vp, ufs_daddr_t a_bn, struct vnode **a_vpp,
 285  *          ufs_daddr_t *a_bnp, int *a_runp)
 286  */
 287 static int
 288 mfs_bmap(struct vop_bmap_args *ap)
 289 {
 290         if (ap->a_vpp != NULL)
 291                 *ap->a_vpp = ap->a_vp;
 292         if (ap->a_bnp != NULL)
 293                 *ap->a_bnp = ap->a_bn;
 294         if (ap->a_runp != NULL)
 295                 *ap->a_runp = 0;
 296         return (0);
 297 }
 298
 299 /*
 300  * Memory filesystem close routine
 301  *
 302  * mfs_close(struct vnode *a_vp, int a_fflag, struct ucred *a_cred,
 303  *           struct thread *a_td)
 304  */
 305 /* ARGSUSED */
 306 static int
 307 mfs_close(struct vop_close_args *ap)
 308 {
 309         struct vnode *vp = ap->a_vp;
 310         struct mfsnode *mfsp = VTOMFS(vp);
 311         struct buf *bp;
 312         int error;
 313
 314         /*
 315          * Finish any pending I/O requests.
 316          */
 317         while ((bp = bufq_first(&mfsp->buf_queue)) != NULL) {
 318                 bufq_remove(&mfsp->buf_queue, bp);
 319                 mfs_doio(bp, mfsp);
 320                 wakeup((caddr_t)bp);
 321         }
 322         /*
 323          * On last close of a memory filesystem
 324          * we must invalidate any in core blocks, so that
 325          * we can, free up its vnode.
 326          */
 327         if ((error = vinvalbuf(vp, 1, ap->a_td, 0, 0)) != 0)
 328                 return (error);
 329         /*
 330          * There should be no way to have any more uses of this
 331          * vnode, so if we find any other uses, it is a panic.
 332          */
 333         if (vp->v_usecount > 1)
 334                 printf("mfs_close: ref count %d > 1\n", vp->v_usecount);
 335         if (vp->v_usecount > 1 || (bufq_first(&mfsp->buf_queue) != NULL))
 336                 panic("mfs_close");
 337         /*
 338          * Send a request to the filesystem server to exit.
 339          */
 340         mfsp->mfs_active = 0;
 341         v_release_rdev(vp);
 342         if (mfsp->mfs_dev) {
 343                 destroy_dev(mfsp->mfs_dev);
 344                 mfsp->mfs_dev = NULL;
 345         }
 346         wakeup((caddr_t)mfsp);
 347         return (0);
 348 }
 349
 350 /*
 351  * Memory filesystem inactive routine
 352  *
 353  * mfs_inactive(struct vnode *a_vp, struct thread *a_td)
 354  */
 355 /* ARGSUSED */
 356 static int
 357 mfs_inactive(struct vop_inactive_args *ap)
 358 {
 359         struct vnode *vp = ap->a_vp;
 360         struct mfsnode *mfsp = VTOMFS(vp);
 361
 362         if (bufq_first(&mfsp->buf_queue) != NULL)
 363                 panic("mfs_inactive: not inactive (next buffer %p)",
 364                         bufq_first(&mfsp->buf_queue));
 365         return (0);
 366 }
 367
 368 /*
 369  * Reclaim a memory filesystem devvp so that it can be reused.
 370  *
 371  * mfs_reclaim(struct vnode *a_vp)
 372  */
 373 static int
 374 mfs_reclaim(struct vop_reclaim_args *ap)
 375 {
 376         struct vnode *vp = ap->a_vp;
 377
 378         FREE(vp->v_data, M_MFSNODE);
 379         vp->v_data = NULL;
 380         return (0);
 381 }
 382
 383 /*
 384  * Print out the contents of an mfsnode.
 385  *
 386  * mfs_print(struct vnode *a_vp)
 387  */
 388 static int
 389 mfs_print(struct vop_print_args *ap)
 390 {
 391         struct mfsnode *mfsp = VTOMFS(ap->a_vp);
 392
 393         printf("tag VT_MFS, td %p, base %p, size %ld\n",
 394             mfsp->mfs_td, (void *)mfsp->mfs_baseoff, mfsp->mfs_size);
 395         return (0);
 396 }
 397
 398 /*
 399  * Block device bad operation
 400  */
 401 static int
 402 mfs_badop(struct vop_generic_args *ap)
 403 {
 404         int i;
 405
 406         printf("mfs_badop[%s]\n", ap->a_desc->vdesc_name);
 407         i = vop_defaultop(ap);
 408         printf("mfs_badop[%s] = %d\n", ap->a_desc->vdesc_name, i);
 409         return (i);
 410 }
 411
 412 static int
 413 mfs_getpages(struct vop_getpages_args *ap)
 414 {
 415         return (VOCALL(spec_vnode_vops, &ap->a_head));
 416 }