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