initial-freebsd-port-work-20010414
[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 "../afs/param.h"       /* Should be always first */
22 #include "../afs/sysincludes.h" /* Standard vendor system headers */
23 #include "../afs/afsincludes.h" /* Afs-based standard headers */
24 #include "../afs/afs_stats.h"  /* statistics */
25 /* #include <vm/vm_ubc.h> */
26 #include <limits.h>
27 #include <float.h>
28
29 /* Try to discard pages, in order to recycle a vcache entry.
30  *
31  * We also make some sanity checks:  ref count, open count, held locks.
32  *
33  * We also do some non-VM-related chores, such as releasing the cred pointer
34  * (for AIX and Solaris) and releasing the gnode (for AIX).
35  *
36  * Locking:  afs_xvcache lock is held.  If it is dropped and re-acquired,
37  *   *slept should be set to warn the caller.
38  *
39  * Formerly, afs_xvcache was dropped and re-acquired for Solaris, but now it
40  * is not dropped and re-acquired for any platform.  It may be that *slept is
41  * therefore obsolescent.
42  *
43  * OSF/1 Locking:  VN_LOCK has been called.
44  */
45 int
46 osi_VM_FlushVCache(avc, slept)
47     struct vcache *avc;
48     int *slept;
49 {
50 #ifdef SECRETLY_OSF1
51     if (avc->vrefCount > 1)
52         return EBUSY;
53
54     if (avc->opens)
55         return EBUSY;
56
57     /* if a lock is held, give up */
58     if (CheckLock(&avc->lock) || afs_CheckBozonLock(&avc->pvnLock))
59         return EBUSY;
60
61     AFS_GUNLOCK();
62     ubc_invalidate(((struct vnode *)avc)->v_object, 0, 0, B_INVAL);
63     AFS_GLOCK();
64 #endif /* SECRETLY_OSF1 */
65
66     return 0;
67 }
68
69 /*
70  * osi_ubc_flush_dirty_and_wait -- ensure all dirty pages cleaned
71  *
72  * Alpha OSF/1 doesn't make it easy to wait for all dirty pages to be cleaned.
73  * NFS tries to do this by calling waitforio(), which waits for v_numoutput
74  * to go to zero.  But that isn't good enough, because afs_putpage() doesn't
75  * increment v_numoutput until it has obtained the vcache entry lock.  Suppose
76  * that Process A, trying to flush a page, is waiting for that lock, and
77  * Process B tries to close the file.  Process B calls waitforio() which thinks
78  * that everything is cool because v_numoutput is still zero.  Process B then
79  * proceeds to call afs_StoreAllSegments().  Finally when B is finished, A gets
80  * to proceed and flush its page.  But then it's too late because the file is
81  * already closed.
82  *
83  * (I suspect that waitforio() is not adequate for NFS, just as it isn't
84  * adequate for us.  But that's not my problem.)
85  *
86  * The only way we can be sure that there are no more dirty pages is if there
87  * are no more pages with pg_busy set.  We look for them on the cleanpl.
88  *
89  * For some reason, ubc_flush_dirty() only looks at the dirtypl, not the
90  * dirtywpl.  I don't know why this is good enough, but I assume it is.  By
91  * the same token, I only look for busy pages on the cleanpl, not the cleanwpl.
92  *
93  * Called with the global lock NOT held.
94  */
95 void
96 osi_ubc_flush_dirty_and_wait(vp, flags)
97 struct vnode *vp;
98 int flags; {
99     int retry;
100     vm_page_t pp;
101     int first;
102
103 #ifdef SECRETLY_OSF1
104     do {
105         struct vm_ubc_object* vop;
106         vop = (struct vm_ubc_object*)(vp->v_object);
107         ubc_flush_dirty(vop, flags); 
108
109         vm_object_lock(vop);
110         if (vop->vu_dirtypl)
111             /* shouldn't happen, but who knows */
112             retry = 1;
113         else {
114             retry = 0;
115             if (vop->vu_cleanpl) {
116                 for (first = 1, pp = vop->vu_cleanpl;
117                      first || pp != vop->vu_cleanpl;
118                      first = 0, pp = pp->pg_onext) {
119                     if (pp->pg_busy) {
120                         retry = 1;
121                         pp->pg_wait = 1;
122                         assert_wait_mesg((vm_offset_t)pp, FALSE, "pg_wait");
123                         vm_object_unlock(vop);
124                         thread_block();
125                         break;
126                     }
127                 }
128             }
129             if (retry) continue;
130         }
131         vm_object_unlock(vop);
132     } while (retry);
133 #endif /* SECRETLY_OSF1 */
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(avc)
143     struct vcache *avc;
144 {
145 #ifdef SECRETLY_OSF1
146     ReleaseWriteLock(&avc->lock);
147     AFS_GUNLOCK();
148     osi_ubc_flush_dirty_and_wait((struct vnode *)avc, 0);
149     AFS_GLOCK();
150     ObtainWriteLock(&avc->lock,94);
151 #endif /* SECRETLY_OSF1 */
152 }
153
154 /* Try to invalidate pages, for "fs flush" or "fs flushv"; or
155  * try to free pages, when deleting a file.
156  *
157  * Locking:  the vcache entry's lock is held.  It may be dropped and 
158  * re-obtained.
159  *
160  * Since we drop and re-obtain the lock, we can't guarantee that there won't
161  * be some pages around when we return, newly created by concurrent activity.
162  */
163 void
164 osi_VM_TryToSmush(avc, acred, sync)
165     struct vcache *avc;
166     struct AFS_UCRED *acred;
167     int sync;
168 {
169 #ifdef SECRETLY_OSF1
170     ReleaseWriteLock(&avc->lock);
171     AFS_GUNLOCK();
172     osi_ubc_flush_dirty_and_wait((struct vnode *)avc, 0);
173     ubc_invalidate(((struct vnode *)avc)->v_object, 0, 0, B_INVAL);
174     AFS_GLOCK();
175     ObtainWriteLock(&avc->lock,59);
176 #endif /* SECRETLY_OSF1 */
177 }
178
179 /* Purge VM for a file when its callback is revoked.
180  *
181  * Locking:  No lock is held, not even the global lock.
182  */
183 void
184 osi_VM_FlushPages(avc, credp)
185     struct vcache *avc;
186     struct AFS_UCRED *credp;
187 {
188 #ifdef SECRETLY_OSF1
189     ubc_flush_dirty(((struct vnode *)avc)->v_object, 0);
190     ubc_invalidate(((struct vnode *)avc)->v_object, 0, 0, B_INVAL);
191 #endif /* SECRETLY_OSF1 */
192 }
193
194 /* Purge pages beyond end-of-file, when truncating a file.
195  *
196  * Locking:  no lock is held, not even the global lock.
197  * activeV is raised.  This is supposed to block pageins, but at present
198  * it only works on Solaris.
199  */
200 void
201 osi_VM_Truncate(avc, alen, acred)
202     struct vcache *avc;
203     int alen;
204     struct AFS_UCRED *acred;
205 {
206 #ifdef SECRETLY_OSF1
207     ubc_invalidate(((struct vnode *)avc)->v_object, alen,
208                         MAXINT - alen, B_INVAL);
209 #endif /* SECRETLY_OSF1 */
210 }