afs: afs_osi_Read/Write returns negative on error
[openafs.git] / src / afs / SOLARIS / 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
14 #include "afs/sysincludes.h"    /* Standard vendor system headers */
15 #include "afsincludes.h"        /* Afs-based standard headers */
16 #include "afs/afs_stats.h"      /* statistics */
17 #include "afs/nfsclient.h"
18
19 /* This file contains Solaris VM-related code for the cache manager. */
20
21 #include <sys/mman.h>
22 #include <vm/hat.h>
23 #include <vm/as.h>
24 #include <vm/page.h>
25 #include <vm/pvn.h>
26 #include <vm/seg.h>
27 #include <vm/seg_map.h>
28 #include <vm/seg_vn.h>
29 #include <vm/rm.h>
30 #include <sys/modctl.h>
31 #include <sys/syscall.h>
32 #include <sys/debug.h>
33 #include <sys/fs_subr.h>
34
35 /* Try to invalidate pages, in order to recycle a dcache entry.
36  *
37  * This function only exists for Solaris.  For other platforms, it's OK to
38  * recycle a dcache entry without invalidating pages, because the strategy
39  * function can call afs_GetDCache().
40  *
41  * Locking:  only the global lock is held on entry.
42  */
43 int
44 osi_VM_GetDownD(struct vcache *avc, struct dcache *adc)
45 {
46     int code;
47
48     AFS_GUNLOCK();
49     code =
50         afs_putpage(AFSTOV(avc), (offset_t) AFS_CHUNKTOBASE(adc->f.chunk),
51                     AFS_CHUNKTOSIZE(adc->f.chunk), B_INVAL, CRED());
52     AFS_GLOCK();
53
54     return code;
55 }
56
57 /* Does this dcache conflict with a multiPage request for this vcache?
58  *
59  * This function only exists for Solaris. This is used by afs_GetDownD to
60  * calculate if trying to evict the given dcache may deadlock with an
61  * in-progress afs_getpage call that is trying to get more than one page at
62  * once. See afs_getpage for details. We return 0 if we do NOT conflict,
63  * nonzero otherwise. If we return nonzero, we should NOT try to evict the
64  * given dcache entry from the cache.
65  *
66  * Locking: tvc->vlock is write-locked on entry (and GLOCK is held)
67  */
68 int
69 osi_VM_MultiPageConflict(struct vcache *avc, struct dcache *adc)
70 {
71     struct multiPage_range *range;
72     for (range = (struct multiPage_range *)avc->multiPage.next;
73          range != &avc->multiPage;
74          range = (struct multiPage_range *)QNext(&range->q)) {
75
76         if (adc->f.chunk >= AFS_CHUNK(range->off) &&
77             adc->f.chunk <= AFS_CHUNK(range->off + range->len - 1)) {
78             return 1;
79         }
80     }
81
82     return 0;
83 }
84
85 /* Try to discard pages, in order to recycle a vcache entry.
86  *
87  * We also make some sanity checks:  ref count, open count, held locks.
88  *
89  * We also do some non-VM-related chores, such as releasing the cred pointer
90  * (for AIX and Solaris) and releasing the gnode (for AIX).
91  *
92  * Locking:  afs_xvcache lock is held.  If it is dropped and re-acquired,
93  *   *slept should be set to warn the caller.
94  *
95  * Formerly, afs_xvcache was dropped and re-acquired for Solaris, but now it
96  * is not dropped and re-acquired for any platform.  It may be that *slept is
97  * therefore obsolescent.
98  */
99 int
100 osi_VM_FlushVCache(struct vcache *avc, int *slept)
101 {
102     if (avc->vrefCount != 0)
103         return EBUSY;
104
105     if (avc->opens)
106         return EBUSY;
107
108     /* if a lock is held, give up */
109     if (CheckLock(&avc->lock))
110         return EBUSY;
111
112     AFS_GUNLOCK();
113     pvn_vplist_dirty(AFSTOV(avc), 0, NULL, B_TRUNC | B_INVAL, CRED());
114     AFS_GLOCK();
115
116     /* Might as well make the obvious check */
117     if (AFSTOV(avc)->v_pages)
118         return EBUSY;           /* should be all gone still */
119
120     rw_destroy(&avc->rwlock);
121     if (avc->credp) {
122         crfree(avc->credp);
123         avc->credp = NULL;
124     }
125
126
127     return 0;
128 }
129
130 /* Try to store pages to cache, in order to store a file back to the server.
131  *
132  * Locking:  the vcache entry's lock is held.  It will usually be dropped and
133  * re-obtained.
134  */
135 void
136 osi_VM_StoreAllSegments(struct vcache *avc)
137 {
138     AFS_GUNLOCK();
139     (void)pvn_vplist_dirty(AFSTOV(avc), (u_offset_t) 0, afs_putapage, 0,
140                            CRED());
141     AFS_GLOCK();
142 }
143
144 /* Try to invalidate pages, for "fs flush" or "fs flushv"; or
145  * try to free pages, when deleting a file.
146  *
147  * Locking:  the vcache entry's lock is held.  It may be dropped and
148  * re-obtained.
149  */
150 void
151 osi_VM_TryToSmush(struct vcache *avc, afs_ucred_t *acred, int sync)
152 {
153     AFS_GUNLOCK();
154     (void)pvn_vplist_dirty(AFSTOV(avc), (u_offset_t) 0, afs_putapage,
155                            (sync ? B_INVAL : B_FREE), acred);
156     AFS_GLOCK();
157 }
158
159 /* Purge VM for a file when its callback is revoked.
160  *
161  * Locking:  No lock is held, not even the global lock.
162  */
163 void
164 osi_VM_FlushPages(struct vcache *avc, afs_ucred_t *credp)
165 {
166     extern int afs_pvn_vptrunc;
167
168     afs_pvn_vptrunc++;
169     (void)afs_putpage(AFSTOV(avc), (offset_t) 0, 0, B_TRUNC | B_INVAL, credp);
170 }
171
172 /* Zero no-longer-used part of last page, when truncating a file
173  *
174  * This function only exists for Solaris.  Other platforms do not support it.
175  *
176  * Locking:  the vcache entry lock is held.  It is released and re-obtained.
177  * The caller will raise activeV (to prevent pageins), but this function must
178  * be called first, since it causes a pagein.
179  */
180 void
181 osi_VM_PreTruncate(struct vcache *avc, int alen, afs_ucred_t *acred)
182 {
183     page_t *pp;
184     int pageOffset = (alen & PAGEOFFSET);
185
186     if (pageOffset == 0) {
187         return;
188     }
189
190     ReleaseWriteLock(&avc->lock);
191     AFS_GUNLOCK();
192     pp = page_lookup(AFSTOV(avc), alen - pageOffset, SE_EXCL);
193     if (pp) {
194         pagezero(pp, pageOffset, PAGESIZE - pageOffset);
195         page_unlock(pp);
196     }
197     AFS_GLOCK();
198     ObtainWriteLock(&avc->lock, 563);
199 }
200
201 /* Purge pages beyond end-of-file, when truncating a file.
202  *
203  * Locking:  no lock is held, not even the global lock.
204  * Pageins are blocked (activeV is raised).
205  */
206 void
207 osi_VM_Truncate(struct vcache *avc, int alen, afs_ucred_t *acred)
208 {
209     /*
210      * It's OK to specify afs_putapage here, even though we aren't holding
211      * the vcache entry lock, because it isn't going to get called.
212      */
213     pvn_vplist_dirty(AFSTOV(avc), alen, afs_putapage, B_TRUNC | B_INVAL,
214                      acred);
215 }