src/afs/FBSD/osi_vm.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10
  11 /* osi_vm.c implements:
  12  *
  13  * osi_VM_FlushVCache(avc, slept)
  14  * osi_ubc_flush_dirty_and_wait(vp, flags)
  15  * osi_VM_StoreAllSegments(avc)
  16  * osi_VM_TryToSmush(avc, acred, sync)
  17  * osi_VM_FlushPages(avc, credp)
  18  * osi_VM_Truncate(avc, alen, acred)
  19  */
  20
  21 #include <afsconfig.h>
  22 #include "afs/param.h"
  23 #ifdef AFS_FBSD70_ENV
  24 #include <sys/param.h>
  25 #include <sys/vnode.h>
  26      void
  27      vgonel(struct vnode *vp, struct thread *td);
  28 #endif
  29
  30
  31 #include "afs/sysincludes.h"    /* Standard vendor system headers */
  32 #include "afsincludes.h"        /* Afs-based standard headers */
  33 #include "afs/afs_stats.h"      /* statistics */
  34 #include <vm/vm_object.h>
  35 #include <vm/vm_map.h>
  36 #include <limits.h>
  37 #include <float.h>
  38
  39 /*
  40  * FreeBSD implementation notes:
  41  * Most of these operations require us to frob vm_objects.  Most
  42  * functions require that the object be locked (with VM_OBJECT_LOCK)
  43  * on entry and leave it locked on exit.  In order to get the
  44  * vm_object itself we call VOP_GETVOBJECT on the vnode; the
  45  * locking protocol requires that we do so with the heavy vnode lock
  46  * held and the vnode interlock unlocked, and it returns the same
  47  * way.
  48  *
  49  * The locking protocol for vnodes is defined in
  50  * kern/vnode_if.src and sys/vnode.h; the locking is still a work in
  51  * progress, so some fields are (as of 5.1) still protected by Giant
  52  * rather than an explicit lock.
  53  */
  54
  55 #ifdef AFS_FBSD60_ENV
  56 #define VOP_GETVOBJECT(vp, objp) (*(objp) = (vp)->v_object)
  57 #endif
  58
  59 #if defined(AFS_FBSD80_ENV)
  60 #define lock_vnode(v)   vn_lock((v), LK_EXCLUSIVE | LK_RETRY)
  61 #define unlock_vnode(v) VOP_UNLOCK((v), 0)
  62 #elif defined(AFS_FBSD50_ENV)
  63 #define lock_vnode(v)   vn_lock((v), LK_EXCLUSIVE | LK_RETRY, curthread)
  64 #define unlock_vnode(v) VOP_UNLOCK((v), 0, curthread)
  65 #else
  66 #define lock_vnode(v)   vn_lock((v), LK_EXCLUSIVE | LK_RETRY, curproc)
  67 #define unlock_vnode(v) VOP_UNLOCK((v), 0, curproc)
  68 /* need splvm() protection? */
  69 #define VM_OBJECT_LOCK(o)
  70 #define VM_OBJECT_UNLOCK(o)
  71 #endif
  72
  73 /* Try to discard pages, in order to recycle a vcache entry.
  74  *
  75  * We also make some sanity checks:  ref count, open count, held locks.
  76  *
  77  * We also do some non-VM-related chores, such as releasing the cred pointer
  78  * (for AIX and Solaris) and releasing the gnode (for AIX).
  79  *
  80  * Locking:  afs_xvcache lock is held.  If it is dropped and re-acquired,
  81  *   *slept should be set to warn the caller.
  82  *
  83  * Formerly, afs_xvcache was dropped and re-acquired for Solaris, but now it
  84  * is not dropped and re-acquired for any platform.  It may be that *slept is
  85  * therefore obsolescent.
  86  *
  87  * OSF/1 Locking:  VN_LOCK has been called.
  88  * We do not lock the vnode here, but instead require that it be exclusive
  89  * locked by code calling osi_VM_StoreAllSegments directly, or scheduling it
  90  * from the bqueue - Matt
  91  * Maybe better to just call vnode_pager_setsize()?
  92  */
  93 int
  94 osi_VM_FlushVCache(struct vcache *avc, int *slept)
  95 {
  96     struct vm_object *obj;
  97     struct vnode *vp;
  98     if (VREFCOUNT(avc) > 1)
  99         return EBUSY;
 100
 101     if (avc->opens)
 102         return EBUSY;
 103
 104     /* if a lock is held, give up */
 105     if (CheckLock(&avc->lock))
 106         return EBUSY;
 107
 108     return(0);
 109
 110     AFS_GUNLOCK();
 111     vp = AFSTOV(avc);
 112 #ifndef AFS_FBSD70_ENV
 113     lock_vnode(vp);
 114 #endif
 115     if (VOP_GETVOBJECT(vp, &obj) == 0) {
 116         VM_OBJECT_LOCK(obj);
 117         vm_object_page_remove(obj, 0, 0, FALSE);
 118 #if 1
 119         if (obj->ref_count == 0) {
 120             simple_lock(&vp->v_interlock);
 121             vgonel(vp, curthread);
 122             vp->v_tag = VT_AFS;
 123             SetAfsVnode(vp);
 124         }
 125 #endif
 126         VM_OBJECT_UNLOCK(obj);
 127     }
 128 #ifndef AFS_FBSD70_ENV
 129     unlock_vnode(vp);
 130 #endif
 131     AFS_GLOCK();
 132
 133     return 0;
 134 }
 135
 136 /* Try to store pages to cache, in order to store a file back to the server.
 137  *
 138  * Locking:  the vcache entry's lock is held.  It will usually be dropped and
 139  * re-obtained.
 140  */
 141 void
 142 osi_VM_StoreAllSegments(struct vcache *avc)
 143 {
 144     struct vnode *vp;
 145     struct vm_object *obj;
 146     int anyio, tries;
 147
 148     ReleaseWriteLock(&avc->lock);
 149     AFS_GUNLOCK();
 150     tries = 5;
 151     vp = AFSTOV(avc);
 152
 153     /*
 154      * I don't understand this.  Why not just call vm_object_page_clean()
 155      * and be done with it?  I particularly don't understand why we're calling
 156      * vget() here.  Is there some reason to believe that the vnode might
 157      * be being recycled at this point?  I don't think there's any need for
 158      * this loop, either -- if we keep the vnode locked all the time,
 159      * that and the object lock will prevent any new pages from appearing.
 160      * The loop is what causes the race condition.  -GAW
 161      */
 162     do {
 163         anyio = 0;
 164         if (VOP_GETVOBJECT(vp, &obj) == 0 && (obj->flags & OBJ_MIGHTBEDIRTY)) {
 165 #ifdef AFS_FBSD50_ENV
 166             if (!vget(vp, LK_EXCLUSIVE | LK_RETRY, curthread)) {
 167 #else
 168                 if (!vget(vp, LK_EXCLUSIVE | LK_RETRY | LK_NOOBJ, curproc)) {
 169 #endif
 170                     if (VOP_GETVOBJECT(vp, &obj) == 0) {
 171                         VM_OBJECT_LOCK(obj);
 172                         vm_object_page_clean(obj, 0, 0, OBJPC_SYNC);
 173                         VM_OBJECT_UNLOCK(obj);
 174                         anyio = 1;
 175                     }
 176                     vput(vp);
 177                 }
 178             }
 179     } while (anyio && (--tries > 0));
 180     AFS_GLOCK();
 181     ObtainWriteLock(&avc->lock, 94);
 182 }
 183
 184 /* Try to invalidate pages, for "fs flush" or "fs flushv"; or
 185  * try to free pages, when deleting a file.
 186  *
 187  * Locking:  the vcache entry's lock is held.  It may be dropped and
 188  * re-obtained.
 189  *
 190  * Since we drop and re-obtain the lock, we can't guarantee that there won't
 191  * be some pages around when we return, newly created by concurrent activity.
 192  */
 193 void
 194 osi_VM_TryToSmush(struct vcache *avc, afs_ucred_t *acred, int sync)
 195 {
 196     struct vnode *vp;
 197     int tries, code;
 198
 199     SPLVAR;
 200
 201     vp = AFSTOV(avc);
 202
 203     if (vp->v_iflag & VI_DOOMED) {
 204       USERPRI;
 205       return;
 206     }
 207
 208     if (vp->v_bufobj.bo_object != NULL) {
 209       VM_OBJECT_LOCK(vp->v_bufobj.bo_object);
 210       /*
 211        * Do we really want OBJPC_SYNC?  OBJPC_INVAL would be
 212        * faster, if invalidation is really what we are being
 213        * asked to do.  (It would make more sense, too, since
 214        * otherwise this function is practically identical to
 215        * osi_VM_StoreAllSegments().)  -GAW
 216        */
 217
 218       /*
 219        * Dunno.  We no longer resemble osi_VM_StoreAllSegments,
 220        * though maybe that's wrong, now.  And OBJPC_SYNC is the
 221        * common thing in 70 file systems, it seems.  Matt.
 222        */
 223
 224       vm_object_page_clean(vp->v_bufobj.bo_object, 0, 0, OBJPC_SYNC);
 225       VM_OBJECT_UNLOCK(vp->v_bufobj.bo_object);
 226     }
 227
 228     tries = 5;
 229     code = osi_vinvalbuf(vp, V_SAVE, PCATCH, 0);
 230     while (code && (tries > 0)) {
 231       code = osi_vinvalbuf(vp, V_SAVE, PCATCH, 0);
 232       --tries;
 233     }
 234     USERPRI;
 235 }
 236
 237 /* Purge VM for a file when its callback is revoked.
 238  *
 239  * Locking:  No lock is held, not even the global lock.
 240  */
 241 void
 242 osi_VM_FlushPages(struct vcache *avc, afs_ucred_t *credp)
 243 {
 244     struct vnode *vp;
 245     struct vm_object *obj;
 246
 247     vp = AFSTOV(avc);
 248     ASSERT_VOP_LOCKED(vp, __func__);
 249     if (VOP_GETVOBJECT(vp, &obj) == 0) {
 250         VM_OBJECT_LOCK(obj);
 251         vm_object_page_remove(obj, 0, 0, FALSE);
 252         VM_OBJECT_UNLOCK(obj);
 253     }
 254     /*vinvalbuf(AFSTOV(avc),0, NOCRED, curproc, 0,0); */
 255 }
 256
 257 /* Purge pages beyond end-of-file, when truncating a file.
 258  *
 259  * Locking:  no lock is held, not even the global lock.
 260  * activeV is raised.  This is supposed to block pageins, but at present
 261  * it only works on Solaris.
 262  */
 263 void
 264 osi_VM_Truncate(struct vcache *avc, int alen, afs_ucred_t *acred)
 265 {
 266     vnode_pager_setsize(AFSTOV(avc), alen);
 267 }