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