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) && defined(AFS_LINUX24_ENV)
  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 #ifndef afs_min
  79 #define afs_min(A,B) ((A)<(B)) ? (A) : (B)
  80 #endif
  81
  82 /* conditional GLOCK macros */
  83 #define COND_GLOCK(var) \
  84         do { \
  85                 var = ISAFS_GLOCK(); \
  86                 if(!var) \
  87                         RX_AFS_GLOCK(); \
  88         } while(0)
  89
  90 #define COND_RE_GUNLOCK(var) \
  91         do { \
  92                 if(var) \
  93                         RX_AFS_GUNLOCK(); \
  94         } while(0)
  95
  96
  97 /* conditional GUNLOCK macros */
  98
  99 #define COND_GUNLOCK(var) \
 100         do {    \
 101                 var = ISAFS_GLOCK(); \
 102                 if(var) \
 103                         RX_AFS_GUNLOCK(); \
 104         } while(0)
 105
 106 #define COND_RE_GLOCK(var) \
 107         do { \
 108                 if(var) \
 109                         RX_AFS_GLOCK(); \
 110         } while(0)
 111
 112
 113 int cache_bypass_strategy   =   NEVER_BYPASS_CACHE;
 114 int cache_bypass_threshold  =   AFS_CACHE_BYPASS_DISABLED; /* file size > threshold triggers bypass */
 115 int cache_bypass_prefetch = 1;  /* Should we do prefetching ? */
 116
 117 extern afs_rwlock_t afs_xcbhash;
 118
 119 /*
 120  * This is almost exactly like the PFlush() routine in afs_pioctl.c,
 121  * but that routine is static.  We are about to change a file from
 122  * normal caching to bypass it's caching.  Therefore, we want to
 123  * free up any cache space in use by the file, and throw out any
 124  * existing VM pages for the file.  We keep track of the number of
 125  * times we go back and forth from caching to bypass.
 126  */
 127 void
 128 afs_TransitionToBypass(struct vcache *avc,
 129                        afs_ucred_t *acred, int aflags)
 130 {
 131
 132     afs_int32 code;
 133     struct vrequest treq;
 134     int setDesire = 0;
 135     int setManual = 0;
 136
 137     if (!avc)
 138         return;
 139
 140     if (aflags & TRANSChangeDesiredBit)
 141         setDesire = 1;
 142     if (aflags & TRANSSetManualBit)
 143         setManual = 1;
 144
 145 #ifdef AFS_BOZONLOCK_ENV
 146     afs_BozonLock(&avc->pvnLock, avc);  /* Since afs_TryToSmush will do a pvn_vptrunc */
 147 #else
 148     AFS_GLOCK();
 149 #endif
 150
 151     ObtainWriteLock(&avc->lock, 925);
 152     /*
 153      * Someone may have beat us to doing the transition - we had no lock
 154      * when we checked the flag earlier.  No cause to panic, just return.
 155      */
 156     if (avc->f.states & FCSBypass)
 157         goto done;
 158
 159     /* If we never cached this, just change state */
 160     if (setDesire && (!(avc->cachingStates & FCSBypass))) {
 161         avc->f.states |= FCSBypass;
 162         goto done;
 163     }
 164
 165     /* cg2v, try to store any chunks not written 20071204 */
 166     if (avc->execsOrWriters > 0) {
 167         code = afs_InitReq(&treq, acred);
 168         if (!code)
 169             code = afs_StoreAllSegments(avc, &treq, AFS_SYNC | AFS_LASTSTORE);
 170     }
 171
 172 #if 0
 173     /* also cg2v, don't dequeue the callback */
 174     ObtainWriteLock(&afs_xcbhash, 956);
 175     afs_DequeueCallback(avc);
 176     ReleaseWriteLock(&afs_xcbhash);
 177 #endif
 178     avc->f.states &= ~(CStatd | CDirty);      /* next reference will re-stat */
 179     /* now find the disk cache entries */
 180     afs_TryToSmush(avc, acred, 1);
 181     osi_dnlc_purgedp(avc);
 182     if (avc->linkData && !(avc->f.states & CCore)) {
 183         afs_osi_Free(avc->linkData, strlen(avc->linkData) + 1);
 184         avc->linkData = NULL;
 185     }
 186
 187     avc->cachingStates |= FCSBypass;    /* Set the bypass flag */
 188     if(setDesire)
 189         avc->cachingStates |= FCSDesireBypass;
 190     if(setManual)
 191         avc->cachingStates |= FCSManuallySet;
 192     avc->cachingTransitions++;
 193
 194 done:
 195     ReleaseWriteLock(&avc->lock);
 196 #ifdef AFS_BOZONLOCK_ENV
 197     afs_BozonUnlock(&avc->pvnLock, avc);
 198 #else
 199     AFS_GUNLOCK();
 200 #endif
 201 }
 202
 203 /*
 204  * This is almost exactly like the PFlush() routine in afs_pioctl.c,
 205  * but that routine is static.  We are about to change a file from
 206  * bypassing caching to normal caching.  Therefore, we want to
 207  * throw out any existing VM pages for the file.  We keep track of
 208  * the number of times we go back and forth from caching to bypass.
 209  */
 210 void
 211 afs_TransitionToCaching(struct vcache *avc,
 212                         afs_ucred_t *acred,
 213                         int aflags)
 214 {
 215     int resetDesire = 0;
 216     int setManual = 0;
 217
 218     if (!avc)
 219         return;
 220
 221     if (aflags & TRANSChangeDesiredBit)
 222         resetDesire = 1;
 223     if (aflags & TRANSSetManualBit)
 224         setManual = 1;
 225
 226 #ifdef AFS_BOZONLOCK_ENV
 227     afs_BozonLock(&avc->pvnLock, avc);  /* Since afs_TryToSmush will do a pvn_vptrunc */
 228 #else
 229     AFS_GLOCK();
 230 #endif
 231     ObtainWriteLock(&avc->lock, 926);
 232     /*
 233      * Someone may have beat us to doing the transition - we had no lock
 234      * when we checked the flag earlier.  No cause to panic, just return.
 235      */
 236     if (!(avc->f.states & FCSBypass))
 237         goto done;
 238
 239     /* Ok, we actually do need to flush */
 240     ObtainWriteLock(&afs_xcbhash, 957);
 241     afs_DequeueCallback(avc);
 242     avc->f.states &= ~(CStatd | CDirty);        /* next reference will re-stat cache entry */
 243     ReleaseWriteLock(&afs_xcbhash);
 244     /* now find the disk cache entries */
 245     afs_TryToSmush(avc, acred, 1);
 246     osi_dnlc_purgedp(avc);
 247     if (avc->linkData && !(avc->f.states & CCore)) {
 248         afs_osi_Free(avc->linkData, strlen(avc->linkData) + 1);
 249         avc->linkData = NULL;
 250     }
 251
 252     avc->cachingStates &= ~(FCSBypass);    /* Reset the bypass flag */
 253     if (resetDesire)
 254         avc->cachingStates &= ~(FCSDesireBypass);
 255     if (setManual)
 256         avc->cachingStates |= FCSManuallySet;
 257     avc->cachingTransitions++;
 258
 259 done:
 260     ReleaseWriteLock(&avc->lock);
 261 #ifdef AFS_BOZONLOCK_ENV
 262     afs_BozonUnlock(&avc->pvnLock, avc);
 263 #else
 264     AFS_GUNLOCK();
 265 #endif
 266 }
 267
 268 /* In the case where there's an error in afs_NoCacheFetchProc or
 269  * afs_PrefetchNoCache, all of the pages they've been passed need
 270  * to be unlocked.
 271  */
 272 #define unlock_and_release_pages(auio) \
 273     do { \
 274         struct iovec *ciov;     \
 275         struct page *pp; \
 276         afs_int32 iovmax; \
 277         afs_int32 iovno = 0; \
 278         ciov = auio->uio_iov; \
 279         iovmax = auio->uio_iovcnt - 1;  \
 280         pp = (struct page*) ciov->iov_base;     \
 281         while(1) { \
 282             if (pp) { \
 283                 if (PageLocked(pp)) \
 284                     unlock_page(pp);    \
 285                 put_page(pp); /* decrement refcount */ \
 286             } \
 287             iovno++; \
 288             if(iovno > iovmax) \
 289                 break; \
 290             ciov = (auio->uio_iov + iovno);     \
 291             pp = (struct page*) ciov->iov_base; \
 292         } \
 293     } while(0)
 294
 295 /* no-cache prefetch routine */
 296 static afs_int32
 297 afs_NoCacheFetchProc(struct rx_call *acall,
 298                      struct vcache *avc,
 299                                          uio_t *auio,
 300                      afs_int32 release_pages,
 301                      afs_int32 size)
 302 {
 303     afs_int32 length;
 304     afs_int32 code;
 305     int tlen;
 306     int moredata, iovno, iovoff, iovmax, clen, result, locked;
 307     struct iovec *ciov;
 308     struct page *pp;
 309     char *address;
 310     char *page_buffer = osi_Alloc(PAGE_SIZE);
 311
 312     ciov = auio->uio_iov;
 313     pp = (struct page*) ciov->iov_base;
 314     iovmax = auio->uio_iovcnt - 1;
 315     iovno = iovoff = result = 0;
 316     do {
 317
 318         COND_GUNLOCK(locked);
 319         code = rx_Read(acall, (char *)&length, sizeof(afs_int32));
 320         COND_RE_GLOCK(locked);
 321
 322         if (code != sizeof(afs_int32)) {
 323             result = 0;
 324             afs_warn("Preread error. code: %d instead of %d\n",
 325                 code, (int)sizeof(afs_int32));
 326             unlock_and_release_pages(auio);
 327             goto done;
 328         } else
 329             length = ntohl(length);
 330
 331         if (length > size) {
 332             result = EIO;
 333             afs_warn("Preread error. Got length %d, which is greater than size %d\n",
 334                      length, size);
 335             unlock_and_release_pages(auio);
 336             goto done;
 337         }
 338
 339         /* If we get a 0 length reply, time to cleanup and return */
 340         if (length == 0) {
 341             unlock_and_release_pages(auio);
 342             result = 0;
 343             goto done;
 344         }
 345
 346         /*
 347          * The fetch protocol is extended for the AFS/DFS translator
 348          * to allow multiple blocks of data, each with its own length,
 349          * to be returned. As long as the top bit is set, there are more
 350          * blocks expected.
 351          *
 352          * We do not do this for AFS file servers because they sometimes
 353          * return large negative numbers as the transfer size.
 354          */
 355         if (avc->f.states & CForeign) {
 356             moredata = length & 0x80000000;
 357             length &= ~0x80000000;
 358         } else {
 359             moredata = 0;
 360         }
 361
 362         while (length > 0) {
 363
 364             clen = ciov->iov_len - iovoff;
 365             tlen = afs_min(length, clen);
 366             address = page_buffer;
 367             COND_GUNLOCK(locked);
 368             code = rx_Read(acall, address, tlen);
 369             COND_RE_GLOCK(locked);
 370
 371             if (code < 0) {
 372                 afs_warn("afs_NoCacheFetchProc: rx_Read error. Return code was %d\n", code);
 373                 result = 0;
 374                 unlock_and_release_pages(auio);
 375                 goto done;
 376             } else if (code == 0) {
 377                 result = 0;
 378                 afs_warn("afs_NoCacheFetchProc: rx_Read returned zero. Aborting.\n");
 379                 unlock_and_release_pages(auio);
 380                 goto done;
 381             }
 382             length -= code;
 383             tlen -= code;
 384
 385             if(tlen > 0) {
 386                 iovoff += code;
 387                 address += code;
 388             } else {
 389                 if(pp) {
 390                     address = kmap_atomic(pp, KM_USER0);
 391                     memcpy(address, page_buffer, PAGE_SIZE);
 392                     kunmap_atomic(address, KM_USER0);
 393                 }
 394                 /* we filled a page, conditionally release it */
 395                 if (release_pages && ciov->iov_base) {
 396                     /* this is appropriate when no caller intends to unlock
 397                      * and release the page */
 398                     SetPageUptodate(pp);
 399                     if(PageLocked(pp))
 400                         unlock_page(pp);
 401                     else
 402                         afs_warn("afs_NoCacheFetchProc: page not locked at iovno %d!\n", iovno);
 403                     put_page(pp); /* decrement refcount */
 404                 }
 405                 /* and carry uio_iov */
 406                 iovno++;
 407                 if (iovno > iovmax)
 408                     goto done;
 409
 410                 ciov = (auio->uio_iov + iovno);
 411                 pp = (struct page*) ciov->iov_base;
 412                 iovoff = 0;
 413             }
 414         }
 415     } while (moredata);
 416
 417 done:
 418     if(page_buffer)
 419         osi_Free(page_buffer, PAGE_SIZE);
 420     return result;
 421 }
 422
 423
 424 /* dispatch a no-cache read request */
 425 afs_int32
 426 afs_ReadNoCache(struct vcache *avc,
 427                 struct nocache_read_request *bparms,
 428                 afs_ucred_t *acred)
 429 {
 430     afs_int32 code;
 431     afs_int32 bcnt;
 432     struct brequest *breq;
 433     struct vrequest *areq;
 434
 435     /* the reciever will free this */
 436     areq = osi_Alloc(sizeof(struct vrequest));
 437
 438     if (avc && avc->vc_error) {
 439         code = EIO;
 440         afs_warn("afs_ReadNoCache VCache Error!\n");
 441         goto cleanup;
 442     }
 443     if ((code = afs_InitReq(areq, acred))) {
 444         afs_warn("afs_ReadNoCache afs_InitReq error!\n");
 445         goto cleanup;
 446     }
 447
 448     AFS_GLOCK();
 449     code = afs_VerifyVCache(avc, areq);
 450     AFS_GUNLOCK();
 451
 452     if (code) {
 453         code = afs_CheckCode(code, areq, 11);   /* failed to get it */
 454         afs_warn("afs_ReadNoCache Failed to verify VCache!\n");
 455         goto cleanup;
 456     }
 457
 458     bparms->areq = areq;
 459
 460     /* and queue this one */
 461     bcnt = 1;
 462     AFS_GLOCK();
 463     while(bcnt < 20) {
 464         breq = afs_BQueue(BOP_FETCH_NOCACHE, avc, B_DONTWAIT, 0, acred, 1, 1,
 465                           bparms, (void *)0, (void *)0);
 466         if(breq != 0) {
 467             code = 0;
 468             break;
 469         }
 470         afs_osi_Wait(10 * bcnt, 0, 0);
 471     }
 472     AFS_GUNLOCK();
 473
 474     if(!breq) {
 475         code = EBUSY;
 476         goto cleanup;
 477     }
 478
 479     return code;
 480
 481 cleanup:
 482     /* If there's a problem before we queue the request, we need to
 483      * do everything that would normally happen when the request was
 484      * processed, like unlocking the pages and freeing memory.
 485      */
 486     unlock_and_release_pages(bparms->auio);
 487     osi_Free(areq, sizeof(struct vrequest));
 488     osi_Free(bparms->auio->uio_iov,
 489              bparms->auio->uio_iovcnt * sizeof(struct iovec));
 490     osi_Free(bparms->auio, sizeof(uio_t));
 491     osi_Free(bparms, sizeof(struct nocache_read_request));
 492     return code;
 493 }
 494
 495
 496 /* Cannot have static linkage--called from BPrefetch (afs_daemons) */
 497 afs_int32
 498 afs_PrefetchNoCache(struct vcache *avc,
 499                     afs_ucred_t *acred,
 500                     struct nocache_read_request *bparms)
 501 {
 502     uio_t *auio;
 503     struct iovec *iovecp;
 504     struct vrequest *areq;
 505     afs_int32 code = 0;
 506 #ifdef AFS_64BIT_CLIENT
 507     afs_int32 length_hi, bytes, locked;
 508 #endif
 509
 510     struct afs_conn *tc;
 511     afs_int32 i;
 512     struct rx_call *tcall;
 513     struct tlocal1 {
 514         struct AFSVolSync tsync;
 515         struct AFSFetchStatus OutStatus;
 516         struct AFSCallBack CallBack;
 517     };
 518     struct tlocal1 *tcallspec;
 519
 520     auio = bparms->auio;
 521     areq = bparms->areq;
 522     iovecp = auio->uio_iov;
 523
 524     tcallspec = (struct tlocal1 *) osi_Alloc(sizeof(struct tlocal1));
 525     do {
 526         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK /* ignored */);
 527         if (tc) {
 528             avc->callback = tc->srvr->server;
 529             i = osi_Time();
 530             tcall = rx_NewCall(tc->id);
 531 #ifdef AFS_64BIT_CLIENT
 532             if (!afs_serverHasNo64Bit(tc)) {
 533                 code = StartRXAFS_FetchData64(tcall,
 534                                               (struct AFSFid *) &avc->f.fid.Fid,
 535                                               auio->uio_offset,
 536                                               bparms->length);
 537                 if (code == 0) {
 538                     COND_GUNLOCK(locked);
 539                     bytes = rx_Read(tcall, (char *)&length_hi,
 540                                     sizeof(afs_int32));
 541                     COND_RE_GLOCK(locked);
 542
 543                     if (bytes != sizeof(afs_int32)) {
 544                         length_hi = 0;
 545                         code = rx_Error(tcall);
 546                         COND_GUNLOCK(locked);
 547                         code = rx_EndCall(tcall, code);
 548                         COND_RE_GLOCK(locked);
 549                         tcall = NULL;
 550                     }
 551                 }
 552             } /* afs_serverHasNo64Bit */
 553             if (code == RXGEN_OPCODE || afs_serverHasNo64Bit(tc)) {
 554                 if (auio->uio_offset > 0x7FFFFFFF) {
 555                     code = EFBIG;
 556                 } else {
 557                     afs_int32 pos;
 558                     pos = auio->uio_offset;
 559                     COND_GUNLOCK(locked);
 560                     if (!tcall)
 561                         tcall = rx_NewCall(tc->id);
 562                     code = StartRXAFS_FetchData(tcall,
 563                                         (struct AFSFid *) &avc->f.fid.Fid,
 564                                         pos, bparms->length);
 565                     COND_RE_GLOCK(locked);
 566                 }
 567                 afs_serverSetNo64Bit(tc);
 568             }
 569 #else
 570             code = StartRXAFS_FetchData(tcall,
 571                                         (struct AFSFid *) &avc->f.fid.Fid,
 572                                         auio->uio_offset, bparms->length);
 573 #endif
 574             if (code == 0) {
 575                 code = afs_NoCacheFetchProc(tcall, avc, auio,
 576                                             1 /* release_pages */,
 577                                             bparms->length);
 578             } else {
 579                 afs_warn("BYPASS: StartRXAFS_FetchData failed: %d\n", code);
 580                 unlock_and_release_pages(auio);
 581                 goto done;
 582             }
 583             if (code == 0) {
 584                 code = EndRXAFS_FetchData(tcall, &tcallspec->OutStatus,
 585                                           &tcallspec->CallBack,
 586                                           &tcallspec->tsync);
 587             } else {
 588                 afs_warn("BYPASS: NoCacheFetchProc failed: %d\n", code);
 589             }
 590             code = rx_EndCall(tcall, code);
 591         } else {
 592             afs_warn("BYPASS: No connection.\n");
 593             code = -1;
 594             unlock_and_release_pages(auio);
 595             goto done;
 596         }
 597     } while (afs_Analyze(tc, code, &avc->f.fid, areq,
 598                                                  AFS_STATS_FS_RPCIDX_FETCHDATA,
 599                                                  SHARED_LOCK,0));
 600 done:
 601     /*
 602      * Copy appropriate fields into vcache
 603      */
 604
 605     afs_ProcessFS(avc, &tcallspec->OutStatus, areq);
 606
 607     osi_Free(areq, sizeof(struct vrequest));
 608     osi_Free(tcallspec, sizeof(struct tlocal1));
 609     osi_Free(iovecp, auio->uio_iovcnt * sizeof(struct iovec));
 610     osi_Free(bparms, sizeof(struct nocache_read_request));
 611     osi_Free(auio, sizeof(uio_t));
 612     return code;
 613 }
 614
 615 #endif /* AFS_CACHE_BYPASS && AFS_LINUX24_ENV */