linux-warning-reduction-20090318
[openafs.git] / src / afs / afs_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 #include <afsconfig.h>
11 #include "afs/param.h"
12
13 RCSID
14     ("$Header$");
15
16 #include "afs/sysincludes.h"    /* Standard vendor system headers */
17 #include "afsincludes.h"        /* Afs-based standard headers */
18 #include "afs/afs_stats.h"      /* afs statistics */
19 #ifdef AFS_AIX_ENV
20 #include <sys/adspace.h>        /* for vm_att(), vm_det() */
21 #endif
22
23 int
24 osi_Active(register struct vcache *avc)
25 {
26     AFS_STATCNT(osi_Active);
27 #if defined(AFS_AIX_ENV) || defined(AFS_OSF_ENV) || defined(AFS_SUN5_ENV) || (AFS_LINUX20_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
28     if ((avc->opens > 0) || (avc->f.states & CMAPPED))
29         return 1;               /* XXX: Warning, verify this XXX  */
30 #elif defined(AFS_SGI_ENV)
31     if ((avc->opens > 0) || AFS_VN_MAPPED(AFSTOV(avc)))
32         return 1;
33 #else
34     if (avc->opens > 0 || (AFSTOV(avc)->v_flag & VTEXT))
35         return (1);
36 #endif
37     return 0;
38 }
39
40 /* this call, unlike osi_FlushText, is supposed to discard caches that may
41    contain invalid information if a file is written remotely, but that may
42    contain valid information that needs to be written back if the file is
43    being written locally.  It doesn't subsume osi_FlushText, since the latter
44    function may be needed to flush caches that are invalidated by local writes.
45
46    avc->pvnLock is already held, avc->lock is guaranteed not to be held (by
47    us, of course).
48 */
49 void
50 osi_FlushPages(register struct vcache *avc, struct AFS_UCRED *credp)
51 {
52 #ifdef AFS_FBSD70_ENV
53     int vfslocked;
54 #endif
55     afs_hyper_t origDV;
56 #if defined(AFS_CACHE_BYPASS)
57     /* The optimization to check DV under read lock below is identical a 
58      * change in CITI cache bypass work.  The problem CITI found in 1999 
59      * was that this code and background daemon doing prefetching competed 
60      * for the vcache entry shared lock.  It's not clear to me from the 
61      * tech report, but it looks like CITI fixed the general prefetch code
62      * path as a bonus when experimenting on prefetch for cache bypass, see
63      * citi-tr-01-3.
64      */
65 #endif        
66     ObtainReadLock(&avc->lock);
67     /* If we've already purged this version, or if we're the ones
68      * writing this version, don't flush it (could lose the
69      * data we're writing). */
70     if ((hcmp((avc->f.m.DataVersion), (avc->mapDV)) <= 0)
71         || ((avc->execsOrWriters > 0) && afs_DirtyPages(avc))) {
72         ReleaseReadLock(&avc->lock);
73         return;
74     }
75     ReleaseReadLock(&avc->lock);
76     ObtainWriteLock(&avc->lock, 10);
77     /* Check again */
78     if ((hcmp((avc->f.m.DataVersion), (avc->mapDV)) <= 0)
79         || ((avc->execsOrWriters > 0) && afs_DirtyPages(avc))) {
80         ReleaseWriteLock(&avc->lock);
81         return;
82     }
83     if (hiszero(avc->mapDV)) {
84         hset(avc->mapDV, avc->f.m.DataVersion);
85         ReleaseWriteLock(&avc->lock);
86         return;
87     }
88
89     AFS_STATCNT(osi_FlushPages);
90     hset(origDV, avc->f.m.DataVersion);
91     afs_Trace3(afs_iclSetp, CM_TRACE_FLUSHPAGES, ICL_TYPE_POINTER, avc,
92                ICL_TYPE_INT32, origDV.low, ICL_TYPE_INT32, avc->f.m.Length);
93
94     ReleaseWriteLock(&avc->lock);
95 #ifdef AFS_FBSD70_ENV
96     vfslocked = VFS_LOCK_GIANT(AFSTOV(avc)->v_mount);
97 #endif
98 #ifndef AFS_FBSD70_ENV
99     AFS_GUNLOCK();
100 #endif
101     osi_VM_FlushPages(avc, credp);
102 #ifndef AFS_FBSD70_ENV
103     AFS_GLOCK();
104 #endif
105 #ifdef AFS_FBSD70_ENV
106     VFS_UNLOCK_GIANT(vfslocked);
107 #endif
108     ObtainWriteLock(&avc->lock, 88);
109
110     /* do this last, and to original version, since stores may occur
111      * while executing above PUTPAGE call */
112     hset(avc->mapDV, origDV);
113     ReleaseWriteLock(&avc->lock);
114 }
115
116 #ifdef  AFS_TEXT_ENV
117
118 /* This call is supposed to flush all caches that might be invalidated
119  * by either a local write operation or a write operation done on
120  * another client.  This call may be called repeatedly on the same
121  * version of a file, even while a file is being written, so it
122  * shouldn't do anything that would discard newly written data before
123  * it is written to the file system. */
124
125 void
126 osi_FlushText_really(register struct vcache *vp)
127 {
128     afs_hyper_t fdv;            /* version before which we'll flush */
129
130     AFS_STATCNT(osi_FlushText);
131     /* see if we've already flushed this data version */
132     if (hcmp(vp->f.m.DataVersion, vp->flushDV) <= 0)
133         return;
134
135     MObtainWriteLock(&afs_ftf, 317);
136     hset(fdv, vp->f.m.DataVersion);
137
138     /* why this disgusting code below?
139      *    xuntext, called by xrele, doesn't notice when it is called
140      * with a freed text object.  Sun continually calls xrele or xuntext
141      * without any locking, as long as VTEXT is set on the
142      * corresponding vnode.
143      *    But, if the text object is locked when you check the VTEXT
144      * flag, several processes can wait in xuntext, waiting for the
145      * text lock; when the second one finally enters xuntext's
146      * critical region, the text object is already free, but the check
147      * was already done by xuntext's caller.
148      *    Even worse, it turns out that xalloc locks the text object
149      * before reading or stating a file via the vnode layer.  Thus, we
150      * could end up in getdcache, being asked to bring in a new
151      * version of a file, but the corresponding text object could be
152      * locked.  We can't flush the text object without causing
153      * deadlock, so now we just don't try to lock the text object
154      * unless it is guaranteed to work.  And we try to flush the text
155      * when we need to a bit more often at the vnode layer.  Sun
156      * really blew the vm-cache flushing interface.
157      */
158
159 #if defined (AFS_HPUX_ENV)
160     if (vp->v.v_flag & VTEXT) {
161         xrele(vp);
162
163         if (vp->v.v_flag & VTEXT) {     /* still has a text object? */
164             MReleaseWriteLock(&afs_ftf);
165             return;
166         }
167     }
168 #endif
169
170     /* next do the stuff that need not check for deadlock problems */
171     mpurge(vp);
172
173     /* finally, record that we've done it */
174     hset(vp->flushDV, fdv);
175     MReleaseWriteLock(&afs_ftf);
176
177 }
178 #endif /* AFS_TEXT_ENV */
179
180 /* ? is it moderately likely that there are dirty VM pages associated with
181  * this vnode?
182  *
183  *  Prereqs:  avc must be write-locked
184  *
185  *  System Dependencies:  - *must* support each type of system for which
186  *                          memory mapped files are supported, even if all
187  *                          it does is return TRUE;
188  *
189  * NB:  this routine should err on the side of caution for ProcessFS to work
190  *      correctly (or at least, not to introduce worse bugs than already exist)
191  */
192 #ifdef  notdef
193 int
194 osi_VMDirty_p(struct vcache *avc)
195 {
196     int dirtyPages;
197
198     if (avc->execsOrWriters <= 0)
199         return 0;               /* can't be many dirty pages here, I guess */
200
201 #if defined (AFS_AIX32_ENV)
202 #ifdef  notdef
203     /* because of the level of hardware involvment with VM and all the
204      * warnings about "This routine must be called at VMM interrupt
205      * level", I thought it would be safest to disable interrupts while
206      * looking at the software page fault table.  */
207
208     /* convert vm handle into index into array:  I think that stoinio is
209      * always zero...  Look into this XXX  */
210 #define VMHASH(handle) ( \
211                         ( ((handle) & ~vmker.stoinio)  \
212                          ^ ((((handle) & ~vmker.stoinio) & vmker.stoimask) << vmker.stoihash) \
213                          ) & 0x000fffff)
214
215     if (avc->segid) {
216         unsigned int pagef, pri, index, next;
217
218         index = VMHASH(avc->segid);
219         if (scb_valid(index)) { /* could almost be an ASSERT */
220
221             pri = disable_ints();
222             for (pagef = scb_sidlist(index); pagef >= 0; pagef = next) {
223                 next = pft_sidfwd(pagef);
224                 if (pft_modbit(pagef)) {        /* has page frame been modified? */
225                     enable_ints(pri);
226                     return 1;
227                 }
228             }
229             enable_ints(pri);
230         }
231     }
232 #undef VMHASH
233 #endif
234 #endif /* AFS_AIX32_ENV */
235
236 #if defined (AFS_SUN5_ENV)
237     if (avc->f.states & CMAPPED) {
238         struct page *pg;
239         for (pg = avc->v.v_s.v_Pages; pg; pg = pg->p_vpnext) {
240             if (pg->p_mod) {
241                 return 1;
242             }
243         }
244     }
245 #endif
246     return 0;
247 }
248 #endif /* notdef */
249
250
251 /*
252  * Solaris osi_ReleaseVM should not drop and re-obtain the vcache entry lock.
253  * This leads to bad races when osi_ReleaseVM() is called from
254  * afs_InvalidateAllSegments().
255
256  * We can do this because Solaris osi_VM_Truncate() doesn't care whether the
257  * vcache entry lock is held or not.
258  *
259  * For other platforms, in some cases osi_VM_Truncate() doesn't care, but
260  * there may be cases where it does care.  If so, it would be good to fix
261  * them so they don't care.  Until then, we assume the worst.
262  *
263  * Locking:  the vcache entry lock is held.  It is dropped and re-obtained.
264  */
265 void
266 osi_ReleaseVM(struct vcache *avc, struct AFS_UCRED *acred)
267 {
268 #ifdef  AFS_SUN5_ENV
269     AFS_GUNLOCK();
270     osi_VM_Truncate(avc, 0, acred);
271     AFS_GLOCK();
272 #else
273     ReleaseWriteLock(&avc->lock);
274     AFS_GUNLOCK();
275     osi_VM_Truncate(avc, 0, acred);
276     AFS_GLOCK();
277     ObtainWriteLock(&avc->lock, 80);
278 #endif
279 }