FBSD: Do not vgone() in osi_VM_FlushVCache
[openafs.git] / 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 #include <sys/param.h>
24 #include <sys/vnode.h>
25
26
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>
32 #include <sys/limits.h>
33 #if __FreeBSD_version >= 1000030
34 #include <sys/rwlock.h>
35 #endif
36
37 /*
38  * FreeBSD implementation notes:
39  * Most of these operations require us to frob vm_objects.  Most
40  * functions require that the object be locked (with VM_OBJECT_*LOCK)
41  * on entry and leave it locked on exit.  The locking protocol
42  * requires that we access vp->v_object with the heavy vnode lock
43  * held and the vnode interlock unlocked.
44  *
45  * The locking protocol for vnodes is defined in
46  * kern/vnode_if.src and sys/vnode.h; unfortunately, it is not *quite*
47  * constant from version to version so to be properly correct we must
48  * check the VCS history of those files.
49  */
50
51 #if defined(AFS_FBSD80_ENV)
52 #define lock_vnode(v, f)        vn_lock((v), (f))
53 #define ilock_vnode(v)  vn_lock((v), LK_INTERLOCK|LK_EXCLUSIVE|LK_RETRY)
54 #define unlock_vnode(v) VOP_UNLOCK((v), 0)
55 #define islocked_vnode(v)       VOP_ISLOCKED((v))
56 #else
57 #define lock_vnode(v, f)        vn_lock((v), (f), curthread)
58 #define ilock_vnode(v)  vn_lock((v), LK_INTERLOCK|LK_EXCLUSIVE|LK_RETRY, curthread)
59 #define unlock_vnode(v) VOP_UNLOCK((v), 0, curthread)
60 #define islocked_vnode(v)       VOP_ISLOCKED((v), curthread)
61 #endif
62
63 #if __FreeBSD_version >= 1000030
64 #define AFS_VM_OBJECT_WLOCK(o)  VM_OBJECT_WLOCK(o)
65 #define AFS_VM_OBJECT_WUNLOCK(o)        VM_OBJECT_WUNLOCK(o)
66 #else
67 #define AFS_VM_OBJECT_WLOCK(o)  VM_OBJECT_LOCK(o)
68 #define AFS_VM_OBJECT_WUNLOCK(o)        VM_OBJECT_UNLOCK(o)
69 #endif
70
71 /* Try to discard pages, in order to recycle a vcache entry.
72  *
73  * We also make some sanity checks:  ref count, open count, held locks.
74  *
75  * We also do some non-VM-related chores, such as releasing the cred pointer
76  * (for AIX and Solaris) and releasing the gnode (for AIX).
77  *
78  * Locking:  afs_xvcache lock is held.  If it is dropped and re-acquired,
79  *   *slept should be set to warn the caller.
80  *
81  * Formerly, afs_xvcache was dropped and re-acquired for Solaris, but now it
82  * is not dropped and re-acquired for any platform.  It may be that *slept is
83  * therefore obsolescent.
84  *
85  */
86 int
87 osi_VM_FlushVCache(struct vcache *avc, int *slept)
88 {
89     struct vnode *vp;
90     int code;
91
92     vp = AFSTOV(avc);
93
94     if (!VI_TRYLOCK(vp))
95         return EBUSY;
96     code = osi_fbsd_checkinuse(avc);
97     if (code) {
98         VI_UNLOCK(vp);
99         return code;
100     }
101
102     /* must hold the vnode before calling cache_purge()
103      * This code largely copied from vfs_subr.c:vlrureclaim() */
104     vholdl(vp);
105     VI_UNLOCK(vp);
106
107     AFS_GUNLOCK();
108     cache_purge(vp);
109     AFS_GLOCK();
110
111     vdrop(vp);
112
113     return 0;
114 }
115
116 /* Try to store pages to cache, in order to store a file back to the server.
117  *
118  * Locking:  the vcache entry's lock is held.  It will usually be dropped and
119  * re-obtained.
120  */
121 void
122 osi_VM_StoreAllSegments(struct vcache *avc)
123 {
124     struct vnode *vp;
125     struct vm_object *obj;
126     int anyio, tries;
127
128     ReleaseWriteLock(&avc->lock);
129     AFS_GUNLOCK();
130     tries = 5;
131     vp = AFSTOV(avc);
132
133     /*
134      * I don't understand this.  Why not just call vm_object_page_clean()
135      * and be done with it?  I particularly don't understand why we're calling
136      * vget() here.  Is there some reason to believe that the vnode might
137      * be being recycled at this point?  I don't think there's any need for
138      * this loop, either -- if we keep the vnode locked all the time,
139      * that and the object lock will prevent any new pages from appearing.
140      * The loop is what causes the race condition.  -GAW
141      */
142     do {
143         anyio = 0;
144         
145         obj = vp->v_object;
146         if (obj != NULL && obj->flags & OBJ_MIGHTBEDIRTY) {
147             if (!vget(vp, LK_EXCLUSIVE | LK_RETRY, curthread)) {
148                     obj = vp->v_object;
149                     if (obj != NULL) {
150                         AFS_VM_OBJECT_WLOCK(obj);
151                         vm_object_page_clean(obj, 0, 0, OBJPC_SYNC);
152                         AFS_VM_OBJECT_WUNLOCK(obj);
153                         anyio = 1;
154                     }
155                     vput(vp);
156                 }
157             }
158     } while (anyio && (--tries > 0));
159     AFS_GLOCK();
160     ObtainWriteLock(&avc->lock, 94);
161 }
162
163 /* Try to invalidate pages, for "fs flush" or "fs flushv"; or
164  * try to free pages, when deleting a file.
165  *
166  * Locking:  the vcache entry's lock is held.  It may be dropped and 
167  * re-obtained.
168  *
169  * Since we drop and re-obtain the lock, we can't guarantee that there won't
170  * be some pages around when we return, newly created by concurrent activity.
171  */
172 void
173 osi_VM_TryToSmush(struct vcache *avc, afs_ucred_t *acred, int sync)
174 {
175     struct vnode *vp;
176     int tries, code;
177     int islocked;
178
179     vp = AFSTOV(avc);
180
181     VI_LOCK(vp);
182     if (vp->v_iflag & VI_DOOMED) {
183         VI_UNLOCK(vp);
184         return;
185     }
186     VI_UNLOCK(vp);
187
188     islocked = islocked_vnode(vp);
189     if (islocked == LK_EXCLOTHER)
190         panic("Trying to Smush over someone else's lock");
191     else if (islocked == LK_SHARED) {
192         afs_warn("Trying to Smush with a shared lock");
193         lock_vnode(vp, LK_UPGRADE);
194     } else if (!islocked)
195         lock_vnode(vp, LK_EXCLUSIVE);
196
197     if (vp->v_bufobj.bo_object != NULL) {
198         AFS_VM_OBJECT_WLOCK(vp->v_bufobj.bo_object);
199         /*
200          * Do we really want OBJPC_SYNC?  OBJPC_INVAL would be
201          * faster, if invalidation is really what we are being
202          * asked to do.  (It would make more sense, too, since
203          * otherwise this function is practically identical to
204          * osi_VM_StoreAllSegments().)  -GAW
205          */
206
207         /*
208          * Dunno.  We no longer resemble osi_VM_StoreAllSegments,
209          * though maybe that's wrong, now.  And OBJPC_SYNC is the
210          * common thing in 70 file systems, it seems.  Matt.
211          */
212
213         vm_object_page_clean(vp->v_bufobj.bo_object, 0, 0, OBJPC_SYNC);
214         AFS_VM_OBJECT_WUNLOCK(vp->v_bufobj.bo_object);
215     }
216
217     tries = 5;
218     code = osi_vinvalbuf(vp, V_SAVE, PCATCH, 0);
219     while (code && (tries > 0)) {
220         afs_warn("TryToSmush retrying vinvalbuf");
221         code = osi_vinvalbuf(vp, V_SAVE, PCATCH, 0);
222         --tries;
223     }
224     if (islocked == LK_SHARED)
225         lock_vnode(vp, LK_DOWNGRADE);
226     else if (!islocked)
227         unlock_vnode(vp);
228 }
229
230 /* Purge VM for a file when its callback is revoked.
231  *
232  * Locking:  No lock is held, not even the global lock.
233  */
234 void
235 osi_VM_FlushPages(struct vcache *avc, afs_ucred_t *credp)
236 {
237     struct vnode *vp;
238     struct vm_object *obj;
239
240     vp = AFSTOV(avc);
241     ASSERT_VOP_LOCKED(vp, __func__);
242     obj = vp->v_object;
243     if (obj != NULL) {
244         AFS_VM_OBJECT_WLOCK(obj);
245         vm_object_page_remove(obj, 0, 0, FALSE);
246         AFS_VM_OBJECT_WUNLOCK(obj);
247     }
248     osi_vinvalbuf(vp, 0, 0, 0);
249 }
250
251 /* Purge pages beyond end-of-file, when truncating a file.
252  *
253  * Locking:  no lock is held, not even the global lock.
254  * activeV is raised.  This is supposed to block pageins, but at present
255  * it only works on Solaris.
256  */
257 void
258 osi_VM_Truncate(struct vcache *avc, int alen, afs_ucred_t *acred)
259 {
260     vnode_pager_setsize(AFSTOV(avc), alen);
261 }