2 * Copyright 2000, International Business Machines Corporation and others.
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
11 /* osi_vm.c implements:
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)
21 #include <afsconfig.h>
22 #include "afs/param.h"
23 #include <sys/param.h>
24 #include <sys/vnode.h>
27 #include "afs/sysincludes.h" /* Standard vendor system headers */
28 #include "afsincludes.h" /* Afs-based standard headers */
29 #include "afs/afs_stats.h" /* statistics */
30 #include <vm/vm_object.h>
31 #include <vm/vm_map.h>
35 * FreeBSD implementation notes:
36 * Most of these operations require us to frob vm_objects. Most
37 * functions require that the object be locked (with VM_OBJECT_LOCK)
38 * on entry and leave it locked on exit. In order to get the
39 * vm_object itself we call VOP_GETVOBJECT on the vnode; the
40 * locking protocol requires that we do so with the heavy vnode lock
41 * held and the vnode interlock unlocked, and it returns the same
44 * The locking protocol for vnodes is defined in
45 * kern/vnode_if.src and sys/vnode.h; unfortunately, it is not *quite*
46 * constant from version to version so to be properly correct we must
47 * check the VCS history of those files.
51 #define VOP_GETVOBJECT(vp, objp) (*(objp) = (vp)->v_object)
54 #if defined(AFS_FBSD80_ENV)
55 #define lock_vnode(v, f) vn_lock((v), (f))
56 #define ilock_vnode(v) vn_lock((v), LK_INTERLOCK|LK_EXCLUSIVE|LK_RETRY);
57 #define unlock_vnode(v) VOP_UNLOCK((v), 0)
58 #define islocked_vnode(v) VOP_ISLOCKED((v))
60 #define lock_vnode(v, f) vn_lock((v), (f), curthread)
61 #define ilock_vnode(v) vn_lock((v), LK_INTERLOCK|LK_EXCLUSIVE|LK_RETRY, curthread);
62 #define unlock_vnode(v) VOP_UNLOCK((v), 0, curthread)
63 #define islocked_vnode(v) VOP_ISLOCKED((v), curthread)
66 /* Try to discard pages, in order to recycle a vcache entry.
68 * We also make some sanity checks: ref count, open count, held locks.
70 * We also do some non-VM-related chores, such as releasing the cred pointer
71 * (for AIX and Solaris) and releasing the gnode (for AIX).
73 * Locking: afs_xvcache lock is held. If it is dropped and re-acquired,
74 * *slept should be set to warn the caller.
76 * Formerly, afs_xvcache was dropped and re-acquired for Solaris, but now it
77 * is not dropped and re-acquired for any platform. It may be that *slept is
78 * therefore obsolescent.
82 osi_VM_FlushVCache(struct vcache *avc, int *slept)
84 struct vnode *vp = AFSTOV(avc);
86 if (!VI_TRYLOCK(vp)) /* need interlock to check usecount */
89 if (vp->v_usecount > 0) {
95 * The value of avc->opens here came to be, at some point,
96 * typically -1. This was caused by incorrectly performing afs_close
97 * processing on vnodes being recycled */
103 /* if a lock is held, give up */
104 if (CheckLock(&avc->lock)) {
109 if ((vp->v_iflag & VI_DOOMED) != 0) {
114 /* must hold the vnode before calling vgone()
115 * This code largely copied from vfs_subr.c:vlrureclaim() */
119 /* use the interlock while locking, so no one else can DOOM this */
129 /* Try to store pages to cache, in order to store a file back to the server.
131 * Locking: the vcache entry's lock is held. It will usually be dropped and
135 osi_VM_StoreAllSegments(struct vcache *avc)
138 struct vm_object *obj;
141 ReleaseWriteLock(&avc->lock);
147 * I don't understand this. Why not just call vm_object_page_clean()
148 * and be done with it? I particularly don't understand why we're calling
149 * vget() here. Is there some reason to believe that the vnode might
150 * be being recycled at this point? I don't think there's any need for
151 * this loop, either -- if we keep the vnode locked all the time,
152 * that and the object lock will prevent any new pages from appearing.
153 * The loop is what causes the race condition. -GAW
157 if (VOP_GETVOBJECT(vp, &obj) == 0 && (obj->flags & OBJ_MIGHTBEDIRTY)) {
158 if (!vget(vp, LK_EXCLUSIVE | LK_RETRY, curthread)) {
159 if (VOP_GETVOBJECT(vp, &obj) == 0) {
161 vm_object_page_clean(obj, 0, 0, OBJPC_SYNC);
162 VM_OBJECT_UNLOCK(obj);
168 } while (anyio && (--tries > 0));
170 ObtainWriteLock(&avc->lock, 94);
173 /* Try to invalidate pages, for "fs flush" or "fs flushv"; or
174 * try to free pages, when deleting a file.
176 * Locking: the vcache entry's lock is held. It may be dropped and
179 * Since we drop and re-obtain the lock, we can't guarantee that there won't
180 * be some pages around when we return, newly created by concurrent activity.
183 osi_VM_TryToSmush(struct vcache *avc, afs_ucred_t *acred, int sync)
192 if (vp->v_iflag & VI_DOOMED) {
198 islocked = islocked_vnode(vp);
199 if (islocked == LK_EXCLOTHER)
200 panic("Trying to Smush over someone else's lock");
201 else if (islocked == LK_SHARED) {
202 afs_warn("Trying to Smush with a shared lock");
203 lock_vnode(vp, LK_UPGRADE);
204 } else if (!islocked)
205 lock_vnode(vp, LK_EXCLUSIVE);
207 if (vp->v_bufobj.bo_object != NULL) {
208 VM_OBJECT_LOCK(vp->v_bufobj.bo_object);
210 * Do we really want OBJPC_SYNC? OBJPC_INVAL would be
211 * faster, if invalidation is really what we are being
212 * asked to do. (It would make more sense, too, since
213 * otherwise this function is practically identical to
214 * osi_VM_StoreAllSegments().) -GAW
218 * Dunno. We no longer resemble osi_VM_StoreAllSegments,
219 * though maybe that's wrong, now. And OBJPC_SYNC is the
220 * common thing in 70 file systems, it seems. Matt.
223 vm_object_page_clean(vp->v_bufobj.bo_object, 0, 0, OBJPC_SYNC);
224 VM_OBJECT_UNLOCK(vp->v_bufobj.bo_object);
228 code = osi_vinvalbuf(vp, V_SAVE, PCATCH, 0);
229 while (code && (tries > 0)) {
230 afs_warn("TryToSmush retrying vinvalbuf");
231 code = osi_vinvalbuf(vp, V_SAVE, PCATCH, 0);
234 if (islocked == LK_SHARED)
235 lock_vnode(vp, LK_DOWNGRADE);
240 /* Purge VM for a file when its callback is revoked.
242 * Locking: No lock is held, not even the global lock.
245 osi_VM_FlushPages(struct vcache *avc, afs_ucred_t *credp)
248 struct vm_object *obj;
251 ASSERT_VOP_LOCKED(vp, __func__);
252 if (VOP_GETVOBJECT(vp, &obj) == 0) {
254 vm_object_page_remove(obj, 0, 0, FALSE);
255 VM_OBJECT_UNLOCK(obj);
257 osi_vinvalbuf(vp, 0, 0, 0);
260 /* Purge pages beyond end-of-file, when truncating a file.
262 * Locking: no lock is held, not even the global lock.
263 * activeV is raised. This is supposed to block pageins, but at present
264 * it only works on Solaris.
267 osi_VM_Truncate(struct vcache *avc, int alen, afs_ucred_t *acred)
269 vnode_pager_setsize(AFSTOV(avc), alen);