Linux: cache bypass: warning cleanup in afs_daemons.c
[openafs.git] / src / afs / afs_bypasscache.c
1 /*
2  * COPYRIGHT  ©  2000
3  * THE REGENTS OF THE UNIVERSITY OF MICHIGAN
4  * ALL RIGHTS RESERVED
5  * 
6  * Permission is granted to use, copy, create derivative works
7  * and redistribute this software and such derivative works
8  * for any purpose, so long as the name of The University of
9  * Michigan is not used in any advertising or publicity
10  * pertaining to the use of distribution of this software
11  * without specific, written prior authorization.  If the
12  * above copyright notice or any other identification of the
13  * University of Michigan is included in any copy of any
14  * portion of this software, then the disclaimer below must
15  * also be included.
16  * 
17  * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION
18  * FROM THE UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY
19  * PURPOSE, AND WITHOUT WARRANTY BY THE UNIVERSITY O 
20  * MICHIGAN OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
21  * WITHOUT LIMITATION THE IMPLIED WARRANTIES OF
22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
23  * REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE LIABLE
24  * FOR ANY DAMAGES, INCLUDING SPECIAL, INDIRECT, INCIDENTAL, OR
25  * CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM ARISING
26  * OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
27  * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGES.
29  */
30  
31  /*
32  * Portions Copyright (c) 2008
33  * The Linux Box Corporation
34  * ALL RIGHTS RESERVED
35  *
36  * Permission is granted to use, copy, create derivative works
37  * and redistribute this software and such derivative works
38  * for any purpose, so long as the name of the Linux Box
39  * Corporation is not used in any advertising or publicity
40  * pertaining to the use or distribution of this software
41  * without specific, written prior authorization.  If the
42  * above copyright notice or any other identification of the
43  * Linux Box Corporation is included in any copy of any
44  * portion of this software, then the disclaimer below must
45  * also be included.
46  *
47  * This software is provided as is, without representation
48  * from the Linux Box Corporation as to its fitness for any
49  * purpose, and without warranty by the Linux Box Corporation
50  * of any kind, either express or implied, including
51  * without limitation the implied warranties of
52  * merchantability and fitness for a particular purpose.  The
53  * Linux Box Corporation shall not be liable for any damages, 
54  * including special, indirect, incidental, or consequential 
55  * damages, with respect to any claim arising out of or in 
56  * connection with the use of the software, even if it has been 
57  * or is hereafter advised of the possibility of such damages.
58  */
59
60
61 #include <afsconfig.h>
62 #include "afs/param.h"
63
64 #if defined(AFS_CACHE_BYPASS)
65
66 #include "afs/afs_bypasscache.h"
67
68 /*
69  * afs_bypasscache.c
70  *
71  */
72 #include "afs/sysincludes.h" /* Standard vendor system headers */
73 #include "afs/afsincludes.h" /* Afs-based standard headers */
74 #include "afs/afs_stats.h"   /* statistics */
75 #include "afs/nfsclient.h"  
76 #include "rx/rx_globals.h"
77
78 #if defined(AFS_LINUX26_ENV)
79 #define LockPage(pp) lock_page(pp)
80 #define UnlockPage(pp) unlock_page(pp)
81 #endif
82 #define AFS_KMAP_ATOMIC
83
84 #ifndef afs_min
85 #define afs_min(A,B) ((A)<(B)) ? (A) : (B)
86 #endif
87
88 /* conditional GLOCK macros */
89 #define COND_GLOCK(var) \
90         do { \
91                 var = ISAFS_GLOCK(); \
92                 if(!var) \
93                         RX_AFS_GLOCK(); \
94         } while(0)
95         
96 #define COND_RE_GUNLOCK(var) \
97         do { \
98                 if(var) \
99                         RX_AFS_GUNLOCK(); \
100         } while(0)
101
102
103 /* conditional GUNLOCK macros */
104
105 #define COND_GUNLOCK(var) \
106         do {    \
107                 var = ISAFS_GLOCK(); \
108                 if(var) \
109                         RX_AFS_GUNLOCK(); \
110         } while(0)
111
112 #define COND_RE_GLOCK(var) \
113         do { \
114                 if(var) \
115                         RX_AFS_GLOCK(); \
116         } while(0)
117
118
119 int cache_bypass_strategy   =   NEVER_BYPASS_CACHE;
120 int cache_bypass_threshold  =   AFS_CACHE_BYPASS_DISABLED; /* file size > threshold triggers bypass */
121 int cache_bypass_prefetch = 1;  /* Should we do prefetching ? */
122
123 extern afs_rwlock_t afs_xcbhash;
124
125 /*
126  * This is almost exactly like the PFlush() routine in afs_pioctl.c,
127  * but that routine is static.  We are about to change a file from
128  * normal caching to bypass it's caching.  Therefore, we want to
129  * free up any cache space in use by the file, and throw out any
130  * existing VM pages for the file.  We keep track of the number of
131  * times we go back and forth from caching to bypass.
132  */
133 void
134 afs_TransitionToBypass(register struct vcache *avc,
135                        register afs_ucred_t *acred, int aflags)
136 {
137
138     afs_int32 code;
139     struct vrequest treq;
140     int setDesire = 0;
141     int setManual = 0;
142
143     if (!avc)
144         return;
145                 
146     if (avc->f.states & FCSBypass)
147         osi_Panic("afs_TransitionToBypass: illegal transition to bypass--already FCSBypass\n");         
148                 
149     if (aflags & TRANSChangeDesiredBit)
150         setDesire = 1;
151     if (aflags & TRANSSetManualBit)
152         setManual = 1;
153                 
154 #ifdef AFS_BOZONLOCK_ENV
155     afs_BozonLock(&avc->pvnLock, avc);  /* Since afs_TryToSmush will do a pvn_vptrunc */
156 #else
157     AFS_GLOCK();
158 #endif
159     ObtainWriteLock(&avc->lock, 925);
160         
161     /* If we never cached this, just change state */
162     if (setDesire && (!avc->cachingStates & FCSBypass)) {
163         avc->f.states |= FCSBypass;
164         goto done;
165     }
166
167     /* cg2v, try to store any chunks not written 20071204 */
168     if (avc->execsOrWriters > 0) {
169         code = afs_InitReq(&treq, acred);
170         if (!code)
171             code = afs_StoreAllSegments(avc, &treq, AFS_SYNC | AFS_LASTSTORE);
172     }
173
174 #if 0
175     /* also cg2v, don't dequeue the callback */
176     ObtainWriteLock(&afs_xcbhash, 956); 
177     afs_DequeueCallback(avc);
178     ReleaseWriteLock(&afs_xcbhash);
179 #endif
180     avc->f.states &= ~(CStatd | CDirty);      /* next reference will re-stat */
181     /* now find the disk cache entries */
182     afs_TryToSmush(avc, acred, 1);
183     osi_dnlc_purgedp(avc);
184     if (avc->linkData && !(avc->f.states & CCore)) {
185         afs_osi_Free(avc->linkData, strlen(avc->linkData) + 1);
186         avc->linkData = NULL;
187     }           
188
189     avc->cachingStates |= FCSBypass;    /* Set the bypass flag */
190     if(setDesire)
191         avc->cachingStates |= FCSDesireBypass;
192     if(setManual)
193         avc->cachingStates |= FCSManuallySet;
194     avc->cachingTransitions++;
195
196 done:
197     ReleaseWriteLock(&avc->lock);
198 #ifdef AFS_BOZONLOCK_ENV
199     afs_BozonUnlock(&avc->pvnLock, avc);
200 #else
201     AFS_GUNLOCK();
202 #endif
203 }
204
205 /*
206  * This is almost exactly like the PFlush() routine in afs_pioctl.c,
207  * but that routine is static.  We are about to change a file from
208  * bypassing caching to normal caching.  Therefore, we want to
209  * throw out any existing VM pages for the file.  We keep track of
210  * the number of times we go back and forth from caching to bypass.
211  */
212 void
213 afs_TransitionToCaching(register struct vcache *avc,
214                         register afs_ucred_t *acred,
215                         int aflags)
216 {
217     int resetDesire = 0;
218     int setManual = 0;
219
220     if (!avc)
221         return;
222
223     if (!avc->f.states & FCSBypass)
224         osi_Panic("afs_TransitionToCaching: illegal transition to caching--already caching\n");         
225                 
226     if (aflags & TRANSChangeDesiredBit)
227         resetDesire = 1;
228     if (aflags & TRANSSetManualBit)
229         setManual = 1;
230
231 #ifdef AFS_BOZONLOCK_ENV
232     afs_BozonLock(&avc->pvnLock, avc);  /* Since afs_TryToSmush will do a pvn_vptrunc */
233 #else
234     AFS_GLOCK();
235 #endif
236     ObtainWriteLock(&avc->lock, 926);
237
238     /* Ok, we actually do need to flush */
239     ObtainWriteLock(&afs_xcbhash, 957);
240     afs_DequeueCallback(avc);
241     avc->f.states &= ~(CStatd | CDirty);        /* next reference will re-stat cache entry */
242     ReleaseWriteLock(&afs_xcbhash);
243     /* now find the disk cache entries */
244     afs_TryToSmush(avc, acred, 1);
245     osi_dnlc_purgedp(avc);
246     if (avc->linkData && !(avc->f.states & CCore)) {
247         afs_osi_Free(avc->linkData, strlen(avc->linkData) + 1);
248         avc->linkData = NULL;
249     }
250                 
251     avc->cachingStates &= ~(FCSBypass);    /* Reset the bypass flag */
252     if (resetDesire)
253         avc->cachingStates &= ~(FCSDesireBypass);
254     if (setManual)
255         avc->cachingStates |= FCSManuallySet;
256     avc->cachingTransitions++;
257
258     ReleaseWriteLock(&avc->lock);
259 #ifdef AFS_BOZONLOCK_ENV
260     afs_BozonUnlock(&avc->pvnLock, avc);
261 #else
262     AFS_GUNLOCK();
263 #endif
264 }
265
266 /* In the case where there's an error in afs_NoCacheFetchProc or
267  * afs_PrefetchNoCache, all of the pages they've been passed need
268  * to be unlocked.
269  */
270 #if defined(AFS_LINUX24_ENV)
271 #define unlock_pages(auio) \
272     do { \
273         struct iovec *ciov;     \
274         struct page *pp; \
275         afs_int32 iovmax; \
276         afs_int32 iovno = 0; \
277         ciov = auio->uio_iov; \
278         iovmax = auio->uio_iovcnt - 1;  \
279         pp = (struct page*) ciov->iov_base;     \
280         afs_warn("BYPASS: Unlocking pages..."); \
281         while(1) { \
282             if(pp != NULL && PageLocked(pp)) \
283                 UnlockPage(pp); \
284             iovno++; \
285             if(iovno > iovmax) \
286                 break; \
287             ciov = (auio->uio_iov + iovno);     \
288             pp = (struct page*) ciov->iov_base; \
289         } \
290         afs_warn("Pages Unlocked.\n"); \
291     } while(0)
292 #else
293 #ifdef UKERNEL
294 #define unlock_pages(auio) \
295          do { } while(0)
296 #else
297 #error AFS_CACHE_BYPASS not implemented on this platform
298 #endif
299 #endif
300
301 /* no-cache prefetch routine */
302 static afs_int32
303 afs_NoCacheFetchProc(register struct rx_call *acall, 
304                      register struct vcache *avc, 
305                                          register uio_t *auio, 
306                      afs_int32 release_pages,
307                      afs_int32 size)
308 {
309     afs_int32 length;
310     afs_int32 code;
311     int tlen;
312     int moredata, iovno, iovoff, iovmax, clen, result, locked;
313     struct iovec *ciov;
314     struct page *pp;
315     char *address;
316 #ifdef AFS_KMAP_ATOMIC
317     char *page_buffer = osi_Alloc(PAGE_SIZE);
318 #else
319     char *page_buffer = NULL;
320 #endif
321
322     ciov = auio->uio_iov;
323     pp = (struct page*) ciov->iov_base;
324     iovmax = auio->uio_iovcnt - 1;
325     iovno = iovoff = result = 0;        
326     do {
327
328         COND_GUNLOCK(locked);
329         code = rx_Read(acall, (char *)&length, sizeof(afs_int32));
330         COND_RE_GLOCK(locked);
331
332         if (code != sizeof(afs_int32)) {
333             result = 0;
334             afs_warn("Preread error. code: %d instead of %d\n",
335                 code, sizeof(afs_int32));
336             unlock_pages(auio);
337             goto done;
338         } else
339             length = ntohl(length);             
340
341         if (length > size) {
342             result = EIO;
343             afs_warn("Preread error. Got length %d, which is greater than size %d\n",
344                      length, size);
345             unlock_pages(auio);
346             goto done;
347         }
348                                         
349         /*
350          * The fetch protocol is extended for the AFS/DFS translator
351          * to allow multiple blocks of data, each with its own length,
352          * to be returned. As long as the top bit is set, there are more
353          * blocks expected.
354          *
355          * We do not do this for AFS file servers because they sometimes
356          * return large negative numbers as the transfer size.
357          */
358         if (avc->f.states & CForeign) {
359             moredata = length & 0x80000000;
360             length &= ~0x80000000;
361         } else {
362             moredata = 0;
363         }
364                                 
365         while (length > 0) {
366
367             clen = ciov->iov_len - iovoff; 
368             tlen = afs_min(length, clen);
369 #ifdef AFS_LINUX24_ENV
370 #ifndef AFS_KMAP_ATOMIC
371             if(pp)
372                 address = kmap(pp);
373             else { 
374                 /* rx doesn't provide an interface to simply advance
375                    or consume n bytes.  for now, allocate a PAGE_SIZE 
376                    region of memory to receive bytes in the case that 
377                    there were holes in readpages */
378                 if(page_buffer == NULL)
379                     page_buffer = osi_Alloc(PAGE_SIZE);
380                     address = page_buffer;
381                 }
382 #else
383             address = page_buffer;
384 #endif
385 #else
386 #ifndef UKERNEL
387 #error AFS_CACHE_BYPASS not implemented on this platform
388 #endif
389 #endif /* LINUX24 */
390             COND_GUNLOCK(locked);
391             code = rx_Read(acall, address, tlen);
392             COND_RE_GLOCK(locked);
393                 
394             if (code < 0) {
395                 afs_warn("afs_NoCacheFetchProc: rx_Read error. Return code was %d\n", code);
396                 result = 0;
397                 unlock_pages(auio);
398                 goto done;
399             } else if (code == 0) {
400                 result = 0;
401                 afs_warn("afs_NoCacheFetchProc: rx_Read returned zero. Aborting.\n");
402                 unlock_pages(auio);
403                 goto done;
404             }
405             length -= code;
406             tlen -= code;
407                 
408             if(tlen > 0) {
409                 iovoff += code;
410                 address += code;
411             } else {
412 #ifdef AFS_LINUX24_ENV
413 #ifdef AFS_KMAP_ATOMIC
414                 if(pp) {
415                     address = kmap_atomic(pp, KM_USER0);
416                     memcpy(address, page_buffer, PAGE_SIZE);
417                     kunmap_atomic(address, KM_USER0);
418                 }
419 #endif
420 #else
421 #ifndef UKERNEL
422 #error AFS_CACHE_BYPASS not implemented on this platform
423 #endif
424 #endif /* LINUX 24 */
425                 /* we filled a page, conditionally release it */
426                 if (release_pages && ciov->iov_base) {
427                     /* this is appropriate when no caller intends to unlock
428                      * and release the page */
429 #ifdef AFS_LINUX24_ENV
430                     SetPageUptodate(pp);
431                     if(PageLocked(pp))
432                         UnlockPage(pp);
433                     else
434                         afs_warn("afs_NoCacheFetchProc: page not locked at iovno %d!\n", iovno);
435 #ifndef AFS_KMAP_ATOMIC
436                     kunmap(pp);
437 #endif
438 #else
439 #ifndef UKERNEL
440 #error AFS_CACHE_BYPASS not implemented on this platform
441 #endif
442 #endif /* LINUX24 */
443                 }
444                 /* and carry uio_iov */
445                 iovno++;
446                 if (iovno > iovmax)
447                     goto done;
448                         
449                 ciov = (auio->uio_iov + iovno);
450                 pp = (struct page*) ciov->iov_base;
451                 iovoff = 0;
452             }
453         }
454     } while (moredata);
455         
456 done:
457     if(page_buffer)
458         osi_Free(page_buffer, PAGE_SIZE);
459     return result;
460 }
461
462
463 /* dispatch a no-cache read request */
464 afs_int32
465 afs_ReadNoCache(register struct vcache *avc, 
466                 register struct nocache_read_request *bparms,
467                 afs_ucred_t *acred)
468 {
469     afs_int32 code;
470     afs_int32 bcnt;
471     struct brequest *breq;
472     struct vrequest *areq;
473                 
474     /* the reciever will free this */
475     areq = osi_Alloc(sizeof(struct vrequest));
476         
477     if (avc && avc->vc_error) {
478         code = EIO;
479         afs_warn("afs_ReadNoCache VCache Error!\n");
480         goto cleanup;
481     }
482     if ((code = afs_InitReq(areq, acred))) {
483         afs_warn("afs_ReadNoCache afs_InitReq error!\n");
484         goto cleanup;
485     }
486
487     AFS_GLOCK();                
488     code = afs_VerifyVCache(avc, areq);
489     AFS_GUNLOCK();
490         
491     if (code) {
492         code = afs_CheckCode(code, areq, 11);   /* failed to get it */
493         afs_warn("afs_ReadNoCache Failed to verify VCache!\n");
494         goto cleanup;
495     }
496         
497     bparms->areq = areq;
498         
499     /* and queue this one */
500     bcnt = 1;
501     AFS_GLOCK();
502     while(bcnt < 20) {
503         breq = afs_BQueue(BOP_FETCH_NOCACHE, avc, B_DONTWAIT, 0, acred, 1, 1,
504                           bparms, (void *)0, (void *)0);
505         if(breq != 0) {
506             code = 0;
507             break;
508         }
509         afs_osi_Wait(10 * bcnt, 0, 0);
510     }
511     AFS_GUNLOCK();
512     
513     if(!breq) {
514         code = EBUSY;
515         goto cleanup;
516     }
517
518     return code;
519
520 cleanup:
521     /* If there's a problem before we queue the request, we need to
522      * do everything that would normally happen when the request was
523      * processed, like unlocking the pages and freeing memory.
524      */
525 #ifdef AFS_LINUX24_ENV
526     unlock_pages(bparms->auio);
527 #else
528 #ifndef UKERNEL
529 #error AFS_CACHE_BYPASS not implemented on this platform
530 #endif
531 #endif
532     osi_Free(areq, sizeof(struct vrequest));
533     osi_Free(bparms->auio->uio_iov,
534              bparms->auio->uio_iovcnt * sizeof(struct iovec));
535     osi_Free(bparms->auio, sizeof(uio_t));
536     osi_Free(bparms, sizeof(struct nocache_read_request));
537     return code;
538 }
539
540
541 /* Cannot have static linkage--called from BPrefetch (afs_daemons) */
542 afs_int32
543 afs_PrefetchNoCache(register struct vcache *avc, 
544                     register afs_ucred_t *acred,
545                     register struct nocache_read_request *bparms)
546 {
547     uio_t *auio;
548     struct iovec *iovecp;
549     struct vrequest *areq;
550     afs_int32 code, length_hi, bytes, locked;    
551         
552     register struct afs_conn *tc;
553     afs_int32 i;
554     struct rx_call *tcall;
555     struct tlocal1 {
556         struct AFSVolSync tsync;
557         struct AFSFetchStatus OutStatus;
558         struct AFSCallBack CallBack;
559     };
560     struct tlocal1 *tcallspec;  
561                         
562     auio = bparms->auio;
563     areq = bparms->areq;
564     iovecp = auio->uio_iov;     
565         
566     tcallspec = (struct tlocal1 *) osi_Alloc(sizeof(struct tlocal1));
567     do {
568         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK /* ignored */);
569         if (tc) {
570             avc->callback = tc->srvr->server;
571             i = osi_Time();
572             tcall = rx_NewCall(tc->id);
573 #ifdef AFS_64BIT_CLIENT
574             if (!afs_serverHasNo64Bit(tc)) {
575                 code = StartRXAFS_FetchData64(tcall,
576                                               (struct AFSFid *) &avc->f.fid.Fid,
577                                               auio->uio_offset,
578                                               bparms->length);
579                 if (code == 0) {
580                     COND_GUNLOCK(locked);
581                     bytes = rx_Read(tcall, (char *)&length_hi,
582                                     sizeof(afs_int32));
583                     COND_RE_GLOCK(locked);
584                                         
585                     if (bytes != sizeof(afs_int32)) {
586                         length_hi = 0;
587                         code = rx_Error(tcall);
588                         COND_GUNLOCK(locked);
589                         code = rx_EndCall(tcall, code);
590                         COND_RE_GLOCK(locked);
591                         tcall = NULL;
592                     }
593                 }
594                 if (code == RXGEN_OPCODE || afs_serverHasNo64Bit(tc)) {
595                     if (auio->uio_offset > 0x7FFFFFFF) {
596                         code = EFBIG;
597                     } else {
598                         afs_int32 pos;
599                         pos = auio->uio_offset;
600                         COND_GUNLOCK(locked);
601                         if (!tcall)
602                             tcall = rx_NewCall(tc->id);
603                         code = StartRXAFS_FetchData(tcall,
604                                               (struct AFSFid *) &avc->f.fid.Fid,
605                                               pos, bparms->length);
606                         COND_RE_GLOCK(locked);
607                     }
608                     afs_serverSetNo64Bit(tc);
609                 }
610             } /* afs_serverHasNo64Bit */
611 #else
612             code = StartRXAFS_FetchData(tcall,
613                                         (struct AFSFid *) &avc->f.fid.Fid,
614                                         auio->uio_offset, bparms->length);
615 #endif
616             if (code == 0) {
617                 code = afs_NoCacheFetchProc(tcall, avc, auio,
618                                             1 /* release_pages */,
619                                             bparms->length);
620             } else {
621                 afs_warn("BYPASS: StartRXAFS_FetchData failed: %d\n", code);
622                 unlock_pages(auio);
623                 goto done;
624             }
625             if (code == 0) {
626                 code = EndRXAFS_FetchData(tcall, &tcallspec->OutStatus,
627                                           &tcallspec->CallBack,
628                                           &tcallspec->tsync);
629             } else {
630                 afs_warn("BYPASS: NoCacheFetchProc failed: %d\n", code);
631             }
632             code = rx_EndCall(tcall, code);
633         } else {
634             afs_warn("BYPASS: No connection.\n");
635             code = -1;
636 #ifdef AFS_LINUX24_ENV
637             unlock_pages(auio);
638 #else
639 #ifndef UKERNEL
640 #error AFS_CACHE_BYPASS not implemented on this platform
641 #endif
642 #endif
643             goto done;
644         }
645     } while (afs_Analyze(tc, code, &avc->f.fid, areq,
646                                                  AFS_STATS_FS_RPCIDX_FETCHDATA,
647                                                  SHARED_LOCK,0));
648 done:
649     /*
650      * Copy appropriate fields into vcache
651      */
652
653     afs_ProcessFS(avc, &tcallspec->OutStatus, areq);
654
655     osi_Free(areq, sizeof(struct vrequest));
656     osi_Free(tcallspec, sizeof(struct tlocal1));
657     osi_Free(iovecp, auio->uio_iovcnt * sizeof(struct iovec));  
658     osi_Free(bparms, sizeof(struct nocache_read_request));
659     osi_Free(auio, sizeof(uio_t));
660     return code;
661 }
662
663 #endif /* AFS_CACHE_BYPASS */