src/WINNT/afsd/cm_dcache.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 <afs/param.h>
  11 #include <afs/stds.h>
  12
  13 #include <windows.h>
  14 #include <winsock2.h>
  15 #include <nb30.h>
  16 #ifdef COMMENT
  17 #include <malloc.h>
  18 #endif
  19 #include <string.h>
  20 #include <stdlib.h>
  21 #include <osi.h>
  22
  23 #include "afsd.h"
  24
  25 #ifdef DEBUG
  26 extern void afsi_log(char *pattern, ...);
  27 #endif
  28
  29 osi_mutex_t cm_bufGetMutex;
  30 #ifdef AFS_FREELANCE_CLIENT
  31 extern osi_mutex_t cm_Freelance_Lock;
  32 #endif
  33
  34 #ifdef AFS_LARGEFILES
  35 /* we can access connp->serverp without holding a lock because that
  36    never changes since the connection is made. */
  37 #define SERVERHAS64BIT(connp) (!((connp)->serverp->flags & CM_SERVERFLAG_NO64BIT))
  38 #define SET_SERVERHASNO64BIT(connp) (cm_SetServerNo64Bit((connp)->serverp, TRUE))
  39 #else
  40 #define SERVERHAS64BIT(connp) (FALSE)
  41 #define SET_SERVERHASNO64BIT(connp) (FALSE)
  42 #endif
  43
  44 /* functions called back from the buffer package when reading or writing data,
  45  * or when holding or releasing a vnode pointer.
  46  */
  47 long cm_BufWrite(void *vscp, osi_hyper_t *offsetp, long length, long flags,
  48                  cm_user_t *userp, cm_req_t *reqp)
  49 {
  50     /* store the data back from this buffer; the buffer is locked and held,
  51      * but the vnode involved isn't locked, yet.  It is held by its
  52      * reference from the buffer, which won't change until the buffer is
  53      * released by our caller.  Thus, we don't have to worry about holding
  54      * bufp->scp.
  55      */
  56     long code;
  57     cm_scache_t *scp = vscp;
  58     afs_int32 nbytes;
  59     long temp;
  60     AFSFetchStatus outStatus;
  61     AFSStoreStatus inStatus;
  62     osi_hyper_t thyper;
  63     AFSVolSync volSync;
  64     AFSFid tfid;
  65     struct rx_call *callp;
  66     struct rx_connection *rxconnp;
  67     osi_queueData_t *qdp;
  68     cm_buf_t *bufp;
  69     afs_uint32 wbytes;
  70     char *bufferp;
  71     cm_conn_t *connp;
  72     osi_hyper_t truncPos;
  73     cm_bulkIO_t biod;           /* bulk IO descriptor */
  74     int require_64bit_ops = 0;
  75
  76     osi_assertx(userp != NULL, "null cm_user_t");
  77     osi_assertx(scp != NULL, "null cm_scache_t");
  78
  79     /* now, the buffer may or may not be filled with good data (buf_GetNew
  80      * drops lots of locks, and may indeed return a properly initialized
  81      * buffer, although more likely it will just return a new, empty, buffer.
  82      */
  83
  84     lock_ObtainMutex(&scp->mx);
  85     if (scp->flags & CM_SCACHEFLAG_DELETED) {
  86         lock_ReleaseMutex(&scp->mx);
  87         return CM_ERROR_NOSUCHFILE;
  88     }
  89
  90     cm_AFSFidFromFid(&tfid, &scp->fid);
  91
  92     code = cm_SetupStoreBIOD(scp, offsetp, length, &biod, userp, reqp);
  93     if (code) {
  94         osi_Log1(afsd_logp, "cm_SetupStoreBIOD code %x", code);
  95         lock_ReleaseMutex(&scp->mx);
  96         return code;
  97     }
  98
  99     if (biod.length == 0) {
 100         osi_Log0(afsd_logp, "cm_SetupStoreBIOD length 0");
 101         lock_ReleaseMutex(&scp->mx);
 102         cm_ReleaseBIOD(&biod, 1, 0);    /* should be a NOOP */
 103         return 0;
 104     }
 105
 106     /* Serialize StoreData RPC's; for rationale see cm_scache.c */
 107     (void) cm_SyncOp(scp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA_EXCL);
 108
 109     /* prepare the output status for the store */
 110     scp->mask |= CM_SCACHEMASK_CLIENTMODTIME;
 111     cm_StatusFromAttr(&inStatus, scp, NULL);
 112     truncPos = scp->length;
 113     if ((scp->mask & CM_SCACHEMASK_TRUNCPOS)
 114         && LargeIntegerLessThan(scp->truncPos, truncPos))
 115         truncPos = scp->truncPos;
 116         scp->mask &= ~CM_SCACHEMASK_TRUNCPOS;
 117
 118     /* compute how many bytes to write from this buffer */
 119     thyper = LargeIntegerSubtract(scp->length, biod.offset);
 120     if (LargeIntegerLessThanZero(thyper)) {
 121         /* entire buffer is past EOF */
 122         nbytes = 0;
 123     }
 124     else {
 125         /* otherwise write out part of buffer before EOF, but not
 126          * more than bufferSize bytes.
 127          */
 128         if (LargeIntegerGreaterThan(thyper,
 129                                     ConvertLongToLargeInteger(biod.length))) {
 130             nbytes = biod.length;
 131         } else {
 132             /* if thyper is less than or equal to biod.length, then we
 133                can safely assume that the value fits in a long. */
 134             nbytes = thyper.LowPart;
 135         }
 136     }
 137
 138     if (LargeIntegerGreaterThan(LargeIntegerAdd(biod.offset,
 139                                                  ConvertLongToLargeInteger(nbytes)),
 140                                  ConvertLongToLargeInteger(LONG_MAX)) ||
 141          LargeIntegerGreaterThan(truncPos,
 142                                  ConvertLongToLargeInteger(LONG_MAX))) {
 143         require_64bit_ops = 1;
 144     }
 145
 146     lock_ReleaseMutex(&scp->mx);
 147
 148     /* now we're ready to do the store operation */
 149     do {
 150         code = cm_ConnFromFID(&scp->fid, userp, reqp, &connp);
 151         if (code)
 152             continue;
 153
 154     retry:
 155         rxconnp = cm_GetRxConn(connp);
 156         callp = rx_NewCall(rxconnp);
 157         rx_PutConnection(rxconnp);
 158
 159 #ifdef AFS_LARGEFILES
 160         if (SERVERHAS64BIT(connp)) {
 161             osi_Log4(afsd_logp, "CALL StartRXAFS_StoreData64 scp 0x%p, offset 0x%x:%08x, length 0x%x",
 162                      scp, biod.offset.HighPart, biod.offset.LowPart, nbytes);
 163
 164             code = StartRXAFS_StoreData64(callp, &tfid, &inStatus,
 165                                           biod.offset.QuadPart,
 166                                           nbytes,
 167                                           truncPos.QuadPart);
 168             if (code)
 169                 osi_Log1(afsd_logp, "CALL StartRXAFS_StoreData64 FAILURE, code 0x%x", code);
 170             else
 171                 osi_Log0(afsd_logp, "CALL StartRXAFS_StoreData64 SUCCESS");
 172         } else {
 173             if (require_64bit_ops) {
 174                 osi_Log0(afsd_logp, "Skipping StartRXAFS_StoreData.  The operation requires large file support in the server.");
 175                 code = CM_ERROR_TOOBIG;
 176             } else {
 177                 osi_Log4(afsd_logp, "CALL StartRXAFS_StoreData scp 0x%p, offset 0x%x:%08x, length 0x%x",
 178                          scp, biod.offset.HighPart, biod.offset.LowPart, nbytes);
 179
 180                 code = StartRXAFS_StoreData(callp, &tfid, &inStatus,
 181                                             biod.offset.LowPart, nbytes, truncPos.LowPart);
 182                 if (code)
 183                     osi_Log1(afsd_logp, "CALL StartRXAFS_StoreData FAILURE, code 0x%x", code);
 184                 else
 185                     osi_Log0(afsd_logp, "CALL StartRXAFS_StoreData SUCCESS");
 186             }
 187         }
 188 #else
 189         osi_Log4(afsd_logp, "CALL StartRXAFS_StoreData scp 0x%p, offset 0x%x:%08x, length 0x%x",
 190                  scp, biod.offset.HighPart, biod.offset.LowPart, nbytes);
 191
 192         code = StartRXAFS_StoreData(callp, &tfid, &inStatus,
 193                                     biod.offset.LowPart, nbytes, truncPos.LowPart);
 194         if (code)
 195             osi_Log1(afsd_logp, "CALL StartRXAFS_StoreData FAILURE, code 0x%x", code);
 196         else
 197             osi_Log0(afsd_logp, "CALL StartRXAFS_StoreData SUCCESS");
 198 #endif
 199
 200         if (code == 0) {
 201             /* write the data from the the list of buffers */
 202             qdp = NULL;
 203             while(nbytes > 0) {
 204                 if (qdp == NULL)
 205                     qdp = biod.bufListEndp;
 206                 else
 207                     qdp = (osi_queueData_t *) osi_QPrev(&qdp->q);
 208                 osi_assertx(qdp != NULL, "null osi_queueData_t");
 209                 bufp = osi_GetQData(qdp);
 210                 bufferp = bufp->datap;
 211                 wbytes = nbytes;
 212                 if (wbytes > cm_data.buf_blockSize)
 213                     wbytes = cm_data.buf_blockSize;
 214
 215                 /* write out wbytes of data from bufferp */
 216                 temp = rx_Write(callp, bufferp, wbytes);
 217                 if (temp != wbytes) {
 218                     osi_Log3(afsd_logp, "rx_Write failed bp 0x%p, %d != %d",bufp,temp,wbytes);
 219                     code = -1;
 220                     break;
 221                 } else {
 222                     osi_Log2(afsd_logp, "rx_Write succeeded bp 0x%p, %d",bufp,temp);
 223                 }
 224                 nbytes -= wbytes;
 225             }   /* while more bytes to write */
 226         }       /* if RPC started successfully */
 227
 228         if (code == 0) {
 229             if (SERVERHAS64BIT(connp)) {
 230                 code = EndRXAFS_StoreData64(callp, &outStatus, &volSync);
 231                 if (code)
 232                     osi_Log2(afsd_logp, "EndRXAFS_StoreData64 FAILURE scp 0x%p code %lX", scp, code);
 233                 else
 234                     osi_Log0(afsd_logp, "EndRXAFS_StoreData64 SUCCESS");
 235             } else {
 236                 code = EndRXAFS_StoreData(callp, &outStatus, &volSync);
 237                 if (code)
 238                     osi_Log2(afsd_logp, "EndRXAFS_StoreData FAILURE scp 0x%p code %lX",scp,code);
 239                 else
 240                     osi_Log0(afsd_logp, "EndRXAFS_StoreData SUCCESS");
 241             }
 242         }
 243
 244         code = rx_EndCall(callp, code);
 245
 246 #ifdef AFS_LARGEFILES
 247         if (code == RXGEN_OPCODE && SERVERHAS64BIT(connp)) {
 248             SET_SERVERHASNO64BIT(connp);
 249             goto retry;
 250         }
 251 #endif
 252
 253     } while (cm_Analyze(connp, userp, reqp, &scp->fid, &volSync, NULL, NULL, code));
 254
 255     code = cm_MapRPCError(code, reqp);
 256
 257     if (code)
 258         osi_Log2(afsd_logp, "CALL StoreData FAILURE scp 0x%p, code 0x%x", scp, code);
 259     else
 260         osi_Log1(afsd_logp, "CALL StoreData SUCCESS scp 0x%p", scp);
 261
 262     /* now, clean up our state */
 263     lock_ObtainMutex(&scp->mx);
 264
 265     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_STOREDATA_EXCL);
 266
 267     if (code == 0) {
 268         osi_hyper_t t;
 269         /* now, here's something a little tricky: in AFS 3, a dirty
 270          * length can't be directly stored, instead, a dirty chunk is
 271          * stored that sets the file's size (by writing and by using
 272          * the truncate-first option in the store call).
 273          *
 274          * At this point, we've just finished a store, and so the trunc
 275          * pos field is clean.  If the file's size at the server is at
 276          * least as big as we think it should be, then we turn off the
 277          * length dirty bit, since all the other dirty buffers must
 278          * precede this one in the file.
 279          *
 280          * The file's desired size shouldn't be smaller than what's
 281          * stored at the server now, since we just did the trunc pos
 282          * store.
 283          *
 284          * We have to turn off the length dirty bit as soon as we can,
 285          * so that we see updates made by other machines.
 286          */
 287
 288         if (SERVERHAS64BIT(connp)) {
 289             t.LowPart = outStatus.Length;
 290             t.HighPart = outStatus.Length_hi;
 291         } else {
 292             t = ConvertLongToLargeInteger(outStatus.Length);
 293         }
 294
 295         if (LargeIntegerGreaterThanOrEqualTo(t, scp->length))
 296             scp->mask &= ~CM_SCACHEMASK_LENGTH;
 297
 298         cm_MergeStatus(NULL, scp, &outStatus, &volSync, userp, CM_MERGEFLAG_STOREDATA);
 299     } else {
 300         if (code == CM_ERROR_SPACE)
 301             scp->flags |= CM_SCACHEFLAG_OUTOFSPACE;
 302         else if (code == CM_ERROR_QUOTA)
 303             scp->flags |= CM_SCACHEFLAG_OVERQUOTA;
 304     }
 305     lock_ReleaseMutex(&scp->mx);
 306     cm_ReleaseBIOD(&biod, 1, code);
 307
 308     return code;
 309 }
 310
 311 /*
 312  * Truncate the file, by sending a StoreData RPC with zero length.
 313  *
 314  * Called with scp locked.  Releases and re-obtains the lock.
 315  */
 316 long cm_StoreMini(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
 317 {
 318     AFSFetchStatus outStatus;
 319     AFSStoreStatus inStatus;
 320     AFSVolSync volSync;
 321     AFSFid tfid;
 322     long code;
 323     osi_hyper_t truncPos;
 324     cm_conn_t *connp;
 325     struct rx_call *callp;
 326     struct rx_connection *rxconnp;
 327     int require_64bit_ops = 0;
 328
 329     /* Serialize StoreData RPC's; for rationale see cm_scache.c */
 330     (void) cm_SyncOp(scp, NULL, userp, reqp, 0,
 331                      CM_SCACHESYNC_STOREDATA_EXCL);
 332
 333     /* prepare the output status for the store */
 334     inStatus.Mask = AFS_SETMODTIME;
 335     inStatus.ClientModTime = scp->clientModTime;
 336     scp->mask &= ~CM_SCACHEMASK_CLIENTMODTIME;
 337
 338     /* calculate truncation position */
 339     truncPos = scp->length;
 340     if ((scp->mask & CM_SCACHEMASK_TRUNCPOS)
 341         && LargeIntegerLessThan(scp->truncPos, truncPos))
 342         truncPos = scp->truncPos;
 343     scp->mask &= ~CM_SCACHEMASK_TRUNCPOS;
 344
 345     if (LargeIntegerGreaterThan(truncPos,
 346                                 ConvertLongToLargeInteger(LONG_MAX))) {
 347
 348         require_64bit_ops = 1;
 349     }
 350
 351     lock_ReleaseMutex(&scp->mx);
 352
 353     cm_AFSFidFromFid(&tfid, &scp->fid);
 354
 355     /* now we're ready to do the store operation */
 356     do {
 357         code = cm_ConnFromFID(&scp->fid, userp, reqp, &connp);
 358         if (code)
 359             continue;
 360
 361     retry:
 362         rxconnp = cm_GetRxConn(connp);
 363         callp = rx_NewCall(rxconnp);
 364         rx_PutConnection(rxconnp);
 365
 366 #ifdef AFS_LARGEFILES
 367         if (SERVERHAS64BIT(connp)) {
 368             code = StartRXAFS_StoreData64(callp, &tfid, &inStatus,
 369                                           0, 0, truncPos.QuadPart);
 370         } else {
 371             if (require_64bit_ops) {
 372                 code = CM_ERROR_TOOBIG;
 373             } else {
 374                 code = StartRXAFS_StoreData(callp, &tfid, &inStatus,
 375                                             0, 0, truncPos.LowPart);
 376             }
 377         }
 378 #else
 379         code = StartRXAFS_StoreData(callp, &tfid, &inStatus,
 380                                     0, 0, truncPos.LowPart);
 381 #endif
 382
 383         if (code == 0) {
 384             if (SERVERHAS64BIT(connp))
 385                 code = EndRXAFS_StoreData64(callp, &outStatus, &volSync);
 386             else
 387                 code = EndRXAFS_StoreData(callp, &outStatus, &volSync);
 388         }
 389         code = rx_EndCall(callp, code);
 390
 391 #ifdef AFS_LARGEFILES
 392         if (code == RXGEN_OPCODE && SERVERHAS64BIT(connp)) {
 393             SET_SERVERHASNO64BIT(connp);
 394             goto retry;
 395         }
 396 #endif
 397
 398     } while (cm_Analyze(connp, userp, reqp, &scp->fid, &volSync, NULL, NULL, code));
 399     code = cm_MapRPCError(code, reqp);
 400
 401     /* now, clean up our state */
 402     lock_ObtainMutex(&scp->mx);
 403
 404     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_STOREDATA_EXCL);
 405
 406     if (code == 0) {
 407         osi_hyper_t t;
 408         /*
 409          * For explanation of handling of CM_SCACHEMASK_LENGTH,
 410          * see cm_BufWrite().
 411          */
 412         if (SERVERHAS64BIT(connp)) {
 413             t.HighPart = outStatus.Length_hi;
 414             t.LowPart = outStatus.Length;
 415         } else {
 416             t = ConvertLongToLargeInteger(outStatus.Length);
 417         }
 418
 419         if (LargeIntegerGreaterThanOrEqualTo(t, scp->length))
 420             scp->mask &= ~CM_SCACHEMASK_LENGTH;
 421         cm_MergeStatus(NULL, scp, &outStatus, &volSync, userp, CM_MERGEFLAG_STOREDATA);
 422     }
 423
 424     return code;
 425 }
 426
 427 long cm_BufRead(cm_buf_t *bufp, long nbytes, long *bytesReadp, cm_user_t *userp)
 428 {
 429     *bytesReadp = cm_data.buf_blockSize;
 430
 431     /* now return a code that means that I/O is done */
 432     return 0;
 433 }
 434
 435 /* stabilize scache entry, and return with it locked so
 436  * it stays stable.
 437  */
 438 long cm_BufStabilize(void *vscp, cm_user_t *userp, cm_req_t *reqp)
 439 {
 440     cm_scache_t *scp = vscp;
 441     long code;
 442
 443     lock_ObtainMutex(&scp->mx);
 444     code = cm_SyncOp(scp, NULL, userp, reqp, 0,
 445                      CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_SETSIZE);
 446     if (code) {
 447         lock_ReleaseMutex(&scp->mx);
 448         return code;
 449     }
 450
 451     return 0;
 452 }
 453
 454 /* undoes the work that cm_BufStabilize does: releases lock so things can change again */
 455 long cm_BufUnstabilize(void *vscp, cm_user_t *userp)
 456 {
 457     cm_scache_t *scp = vscp;
 458
 459     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_SETSIZE);
 460
 461     lock_ReleaseMutex(&scp->mx);
 462
 463     /* always succeeds */
 464     return 0;
 465 }
 466
 467 cm_buf_ops_t cm_bufOps = {
 468     cm_BufWrite,
 469     cm_BufRead,
 470     cm_BufStabilize,
 471     cm_BufUnstabilize
 472 };
 473
 474 long cm_ValidateDCache(void)
 475 {
 476     return buf_ValidateBuffers();
 477 }
 478
 479 long cm_ShutdownDCache(void)
 480 {
 481     return 0;
 482 }
 483
 484 int cm_InitDCache(int newFile, long chunkSize, afs_uint64 nbuffers)
 485 {
 486     lock_InitializeMutex(&cm_bufGetMutex, "buf_Get mutex");
 487     return buf_Init(newFile, &cm_bufOps, nbuffers);
 488 }
 489
 490 /* check to see if we have an up-to-date buffer.  The buffer must have
 491  * previously been obtained by calling buf_Get.
 492  *
 493  * Make sure we have a callback, and that the dataversion matches.
 494  *
 495  * Scp must be locked.
 496  *
 497  * Bufp *may* be locked.
 498  */
 499 int cm_HaveBuffer(cm_scache_t *scp, cm_buf_t *bufp, int isBufLocked)
 500 {
 501     int code;
 502     if (!cm_HaveCallback(scp))
 503         return 0;
 504     if ((bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED)) == (CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED))
 505         return 1;
 506     if (bufp->dataVersion == scp->dataVersion)
 507         return 1;
 508     if (!isBufLocked) {
 509         code = lock_TryMutex(&bufp->mx);
 510         if (code == 0) {
 511             /* don't have the lock, and can't lock it, then
 512              * return failure.
 513              */
 514             return 0;
 515         }
 516     }
 517
 518     /* remember dirty flag for later */
 519     code = bufp->flags & CM_BUF_DIRTY;
 520
 521     /* release lock if we obtained it here */
 522     if (!isBufLocked)
 523         lock_ReleaseMutex(&bufp->mx);
 524
 525     /* if buffer was dirty, buffer is acceptable for use */
 526     if (code)
 527         return 1;
 528     else
 529         return 0;
 530 }
 531
 532 /* used when deciding whether to do a prefetch or not */
 533 long cm_CheckFetchRange(cm_scache_t *scp, osi_hyper_t *startBasep, osi_hyper_t *length,
 534                         cm_user_t *userp, cm_req_t *reqp, osi_hyper_t *realBasep)
 535 {
 536     osi_hyper_t tbase;
 537     osi_hyper_t tlength;
 538     osi_hyper_t tblocksize;
 539     long code;
 540     cm_buf_t *bp;
 541     int stop;
 542
 543     /* now scan all buffers in the range, looking for any that look like
 544      * they need work.
 545      */
 546     tbase = *startBasep;
 547     tlength = *length;
 548     tblocksize = ConvertLongToLargeInteger(cm_data.buf_blockSize);
 549     stop = 0;
 550     lock_ObtainMutex(&scp->mx);
 551     while (LargeIntegerGreaterThanZero(tlength)) {
 552         /* get callback so we can do a meaningful dataVersion comparison */
 553         code = cm_SyncOp(scp, NULL, userp, reqp, 0,
 554                          CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
 555         if (code) {
 556             scp->flags &= ~CM_SCACHEFLAG_PREFETCHING;
 557             lock_ReleaseMutex(&scp->mx);
 558             return code;
 559         }
 560
 561         if (LargeIntegerGreaterThanOrEqualTo(tbase, scp->length)) {
 562             /* we're past the end of file */
 563             break;
 564         }
 565
 566         bp = buf_Find(scp, &tbase);
 567         /* We cheat slightly by not locking the bp mutex. */
 568         if (bp) {
 569             if ((bp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING)) == 0
 570                  && bp->dataVersion != scp->dataVersion)
 571                 stop = 1;
 572             buf_Release(bp);
 573             bp = NULL;
 574         }
 575         else
 576             stop = 1;
 577
 578         /* if this buffer is essentially guaranteed to require a fetch,
 579          * break out here and return this position.
 580          */
 581         if (stop)
 582             break;
 583
 584         tbase = LargeIntegerAdd(tbase, tblocksize);
 585         tlength = LargeIntegerSubtract(tlength,  tblocksize);
 586     }
 587
 588     /* if we get here, either everything is fine or 'stop' stopped us at a
 589      * particular buffer in the range that definitely needs to be fetched.
 590      */
 591     if (stop == 0) {
 592         /* return non-zero code since realBasep won't be valid */
 593         scp->flags &= ~CM_SCACHEFLAG_PREFETCHING;
 594         code = -1;
 595     }
 596     else {
 597         /* successfully found a page that will need fetching */
 598         *realBasep = tbase;
 599         code = 0;
 600     }
 601     lock_ReleaseMutex(&scp->mx);
 602     return code;
 603 }
 604
 605 afs_int32
 606 cm_BkgStore(cm_scache_t *scp, afs_uint32 p1, afs_uint32 p2, afs_uint32 p3, afs_uint32 p4,
 607             cm_user_t *userp)
 608 {
 609     osi_hyper_t toffset;
 610     long length;
 611     cm_req_t req;
 612     long code = 0;
 613
 614     if (scp->flags & CM_SCACHEFLAG_DELETED) {
 615         osi_Log4(afsd_logp, "Skipping BKG store - Deleted scp 0x%p, offset 0x%x:%08x, length 0x%x", scp, p2, p1, p3);
 616     } else {
 617         cm_InitReq(&req);
 618
 619         /* Retries will be performed by the BkgDaemon thread if appropriate */
 620         req.flags |= CM_REQ_NORETRY;
 621
 622         toffset.LowPart = p1;
 623         toffset.HighPart = p2;
 624         length = p3;
 625
 626         osi_Log4(afsd_logp, "Starting BKG store scp 0x%p, offset 0x%x:%08x, length 0x%x", scp, p2, p1, p3);
 627
 628         code = cm_BufWrite(scp, &toffset, length, /* flags */ 0, userp, &req);
 629
 630         osi_Log4(afsd_logp, "Finished BKG store scp 0x%p, offset 0x%x:%08x, code 0x%x", scp, p2, p1, code);
 631     }
 632
 633     lock_ObtainMutex(&scp->mx);
 634     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_ASYNCSTORE);
 635     lock_ReleaseMutex(&scp->mx);
 636
 637     return code;
 638 }
 639
 640 /* Called with scp locked */
 641 void cm_ClearPrefetchFlag(long code, cm_scache_t *scp, osi_hyper_t *base, osi_hyper_t *length)
 642 {
 643     osi_hyper_t end;
 644
 645     if (code == 0) {
 646         end =  LargeIntegerAdd(*base, *length);
 647         if (LargeIntegerGreaterThan(*base, scp->prefetch.base))
 648             scp->prefetch.base = *base;
 649         if (LargeIntegerGreaterThan(end, scp->prefetch.end))
 650             scp->prefetch.end = end;
 651     }
 652     scp->flags &= ~CM_SCACHEFLAG_PREFETCHING;
 653 }
 654
 655 /* do the prefetch.  if the prefetch fails, return 0 (success)
 656  * because there is no harm done.  */
 657 afs_int32
 658 cm_BkgPrefetch(cm_scache_t *scp, afs_uint32 p1, afs_uint32 p2, afs_uint32 p3, afs_uint32 p4,
 659                cm_user_t *userp)
 660 {
 661     osi_hyper_t length;
 662     osi_hyper_t base;
 663     osi_hyper_t offset;
 664     osi_hyper_t end;
 665     osi_hyper_t fetched;
 666     osi_hyper_t tblocksize;
 667     long code;
 668     int mxheld = 0;
 669     cm_buf_t *bp = NULL;
 670     cm_req_t req;
 671
 672     cm_InitReq(&req);
 673
 674     /* Retries will be performed by the BkgDaemon thread if appropriate */
 675     req.flags |= CM_REQ_NORETRY;
 676
 677     fetched.LowPart = 0;
 678     fetched.HighPart = 0;
 679     tblocksize = ConvertLongToLargeInteger(cm_data.buf_blockSize);
 680     base.LowPart = p1;
 681     base.HighPart = p2;
 682     length.LowPart = p3;
 683     length.HighPart = p4;
 684
 685     end = LargeIntegerAdd(base, length);
 686
 687     osi_Log3(afsd_logp, "Starting BKG prefetch scp 0x%p, base 0x%x:%x", scp, p2, p1);
 688
 689     for ( code = 0, offset = base;
 690           code == 0 && LargeIntegerLessThan(offset, end);
 691           offset = LargeIntegerAdd(offset, tblocksize) )
 692     {
 693         if (mxheld) {
 694             lock_ReleaseMutex(&scp->mx);
 695             mxheld = 0;
 696         }
 697
 698         lock_ObtainRead(&scp->bufCreateLock);
 699         code = buf_Get(scp, &offset, &bp);
 700         lock_ReleaseRead(&scp->bufCreateLock);
 701         if (code)
 702             break;
 703
 704         if (bp->cmFlags & CM_BUF_CMFETCHING) {
 705             /* skip this buffer as another thread is already fetching it */
 706             buf_Release(bp);
 707             bp = NULL;
 708             continue;
 709         }
 710
 711         if (!mxheld) {
 712             lock_ObtainMutex(&scp->mx);
 713             mxheld = 1;
 714         }
 715
 716         code = cm_GetBuffer(scp, bp, NULL, userp, &req);
 717         if (code == 0)
 718             fetched = LargeIntegerAdd(fetched, tblocksize);
 719         buf_Release(bp);
 720     }
 721
 722     if (!mxheld) {
 723         lock_ObtainMutex(&scp->mx);
 724         mxheld = 1;
 725     }
 726     cm_ClearPrefetchFlag(LargeIntegerGreaterThanZero(fetched) ? 0 : code,
 727                          scp, &base, &fetched);
 728     lock_ReleaseMutex(&scp->mx);
 729
 730     osi_Log4(afsd_logp, "Ending BKG prefetch scp 0x%p, code %d bytes 0x%x:%x",
 731               scp, code, fetched.HighPart, fetched.LowPart);
 732     return code;
 733 }
 734
 735 /* a read was issued to offsetp, and we have to determine whether we should
 736  * do a prefetch of the next chunk.
 737  */
 738 void cm_ConsiderPrefetch(cm_scache_t *scp, osi_hyper_t *offsetp,
 739                          cm_user_t *userp, cm_req_t *reqp)
 740 {
 741     long code;
 742     osi_hyper_t realBase;
 743     osi_hyper_t readBase;
 744     osi_hyper_t readLength;
 745
 746     readBase = *offsetp;
 747     /* round up to chunk boundary */
 748     readBase.LowPart += (cm_chunkSize-1);
 749     readBase.LowPart &= (-cm_chunkSize);
 750
 751     readLength = ConvertLongToLargeInteger(cm_chunkSize);
 752
 753     lock_ObtainMutex(&scp->mx);
 754     if ((scp->flags & CM_SCACHEFLAG_PREFETCHING)
 755          || LargeIntegerLessThanOrEqualTo(readBase, scp->prefetch.base)) {
 756         lock_ReleaseMutex(&scp->mx);
 757         return;
 758     }
 759     scp->flags |= CM_SCACHEFLAG_PREFETCHING;
 760
 761     /* start the scan at the latter of the end of this read or
 762      * the end of the last fetched region.
 763      */
 764     if (LargeIntegerGreaterThan(scp->prefetch.end, readBase))
 765         readBase = scp->prefetch.end;
 766
 767     lock_ReleaseMutex(&scp->mx);
 768
 769     code = cm_CheckFetchRange(scp, &readBase, &readLength, userp, reqp,
 770                               &realBase);
 771     if (code)
 772         return; /* can't find something to prefetch */
 773
 774     osi_Log2(afsd_logp, "BKG Prefetch request scp 0x%p, base 0x%x",
 775              scp, realBase.LowPart);
 776
 777     cm_QueueBKGRequest(scp, cm_BkgPrefetch,
 778                        realBase.LowPart, realBase.HighPart,
 779                        readLength.LowPart, readLength.HighPart,
 780                        userp);
 781 }
 782
 783 /* scp must be locked; temporarily unlocked during processing.
 784  * If returns 0, returns buffers held in biop, and with
 785  * CM_BUF_CMSTORING set.
 786  *
 787  * Caller *must* set CM_BUF_WRITING and reset the over.hEvent field if the
 788  * buffer is ever unlocked before CM_BUF_DIRTY is cleared.  And if
 789  * CM_BUF_WRITING is ever viewed by anyone, then it must be cleared, sleepers
 790  * must be woken, and the event must be set when the I/O is done.  All of this
 791  * is required so that buf_WaitIO synchronizes properly with the buffer as it
 792  * is being written out.
 793  */
 794 long cm_SetupStoreBIOD(cm_scache_t *scp, osi_hyper_t *inOffsetp, long inSize,
 795                        cm_bulkIO_t *biop, cm_user_t *userp, cm_req_t *reqp)
 796 {
 797     cm_buf_t *bufp;
 798     osi_queueData_t *qdp;
 799     osi_hyper_t thyper;
 800     osi_hyper_t tbase;
 801     osi_hyper_t scanStart;              /* where to start scan for dirty pages */
 802     osi_hyper_t scanEnd;                /* where to stop scan for dirty pages */
 803     osi_hyper_t firstModOffset; /* offset of first modified page in range */
 804     long temp;
 805     long code;
 806     long flags;                 /* flags to cm_SyncOp */
 807
 808     /* clear things out */
 809     biop->scp = scp;                    /* do not hold; held by caller */
 810     biop->offset = *inOffsetp;
 811     biop->length = 0;
 812     biop->bufListp = NULL;
 813     biop->bufListEndp = NULL;
 814     biop->reserved = 0;
 815
 816     /* reserve a chunk's worth of buffers */
 817     lock_ReleaseMutex(&scp->mx);
 818     buf_ReserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
 819     lock_ObtainMutex(&scp->mx);
 820
 821     bufp = NULL;
 822     for (temp = 0; temp < inSize; temp += cm_data.buf_blockSize) {
 823         thyper = ConvertLongToLargeInteger(temp);
 824         tbase = LargeIntegerAdd(*inOffsetp, thyper);
 825
 826         bufp = buf_Find(scp, &tbase);
 827         if (bufp) {
 828             /* get buffer mutex and scp mutex safely */
 829             lock_ReleaseMutex(&scp->mx);
 830             lock_ObtainMutex(&bufp->mx);
 831             lock_ObtainMutex(&scp->mx);
 832
 833             flags = CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_STOREDATA | CM_SCACHESYNC_BUFLOCKED;
 834             code = cm_SyncOp(scp, bufp, userp, reqp, 0, flags);
 835             if (code) {
 836                 lock_ReleaseMutex(&bufp->mx);
 837                 buf_Release(bufp);
 838                 bufp = NULL;
 839                 buf_UnreserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
 840                 return code;
 841             }
 842
 843             /* if the buffer is dirty, we're done */
 844             if (bufp->flags & CM_BUF_DIRTY) {
 845                 osi_assertx(!(bufp->flags & CM_BUF_WRITING),
 846                             "WRITING w/o CMSTORING in SetupStoreBIOD");
 847                 bufp->flags |= CM_BUF_WRITING;
 848                 break;
 849             }
 850
 851             /* this buffer is clean, so there's no reason to process it */
 852             cm_SyncOpDone(scp, bufp, flags);
 853             lock_ReleaseMutex(&bufp->mx);
 854             buf_Release(bufp);
 855             bufp = NULL;
 856         }
 857     }
 858
 859     biop->reserved = 1;
 860
 861     /* if we get here, if bufp is null, we didn't find any dirty buffers
 862      * that weren't already being stored back, so we just quit now.
 863      */
 864     if (!bufp) {
 865         return 0;
 866     }
 867
 868     /* don't need buffer mutex any more */
 869     lock_ReleaseMutex(&bufp->mx);
 870
 871     /* put this element in the list */
 872     qdp = osi_QDAlloc();
 873     osi_SetQData(qdp, bufp);
 874     /* don't have to hold bufp, since held by buf_Find above */
 875     osi_QAddH((osi_queue_t **) &biop->bufListp,
 876               (osi_queue_t **) &biop->bufListEndp,
 877               &qdp->q);
 878     biop->length = cm_data.buf_blockSize;
 879     firstModOffset = bufp->offset;
 880     biop->offset = firstModOffset;
 881     bufp = NULL;        /* this buffer and reference added to the queue */
 882
 883     /* compute the window surrounding *inOffsetp of size cm_chunkSize */
 884     scanStart = *inOffsetp;
 885     scanStart.LowPart &= (-cm_chunkSize);
 886     thyper = ConvertLongToLargeInteger(cm_chunkSize);
 887     scanEnd = LargeIntegerAdd(scanStart, thyper);
 888
 889     flags = CM_SCACHESYNC_GETSTATUS
 890         | CM_SCACHESYNC_STOREDATA
 891         | CM_SCACHESYNC_BUFLOCKED
 892         | CM_SCACHESYNC_NOWAIT;
 893
 894     /* start by looking backwards until scanStart */
 895     /* hyper version of cm_data.buf_blockSize */
 896     thyper = ConvertLongToLargeInteger(cm_data.buf_blockSize);
 897     tbase = LargeIntegerSubtract(firstModOffset, thyper);
 898     while(LargeIntegerGreaterThanOrEqualTo(tbase, scanStart)) {
 899         /* see if we can find the buffer */
 900         bufp = buf_Find(scp, &tbase);
 901         if (!bufp)
 902             break;
 903
 904         /* try to lock it, and quit if we can't (simplifies locking) */
 905         lock_ReleaseMutex(&scp->mx);
 906         code = lock_TryMutex(&bufp->mx);
 907         lock_ObtainMutex(&scp->mx);
 908         if (code == 0) {
 909             buf_Release(bufp);
 910             bufp = NULL;
 911             break;
 912         }
 913
 914         code = cm_SyncOp(scp, bufp, userp, reqp, 0, flags);
 915         if (code) {
 916             lock_ReleaseMutex(&bufp->mx);
 917             buf_Release(bufp);
 918             bufp = NULL;
 919             break;
 920         }
 921
 922         if (!(bufp->flags & CM_BUF_DIRTY)) {
 923             /* buffer is clean, so we shouldn't add it */
 924             cm_SyncOpDone(scp, bufp, flags);
 925             lock_ReleaseMutex(&bufp->mx);
 926             buf_Release(bufp);
 927             bufp = NULL;
 928             break;
 929         }
 930
 931         /* don't need buffer mutex any more */
 932         lock_ReleaseMutex(&bufp->mx);
 933
 934         /* we have a dirty buffer ready for storing.  Add it to the tail
 935          * of the list, since it immediately precedes all of the disk
 936          * addresses we've already collected.
 937          */
 938         qdp = osi_QDAlloc();
 939         osi_SetQData(qdp, bufp);
 940         /* no buf_hold necessary, since we have it held from buf_Find */
 941         osi_QAddT((osi_queue_t **) &biop->bufListp,
 942                   (osi_queue_t **) &biop->bufListEndp,
 943                   &qdp->q);
 944         bufp = NULL;            /* added to the queue */
 945
 946         /* update biod info describing the transfer */
 947         biop->offset = LargeIntegerSubtract(biop->offset, thyper);
 948         biop->length += cm_data.buf_blockSize;
 949
 950         /* update loop pointer */
 951         tbase = LargeIntegerSubtract(tbase, thyper);
 952     }   /* while loop looking for pages preceding the one we found */
 953
 954     /* now, find later dirty, contiguous pages, and add them to the list */
 955     /* hyper version of cm_data.buf_blockSize */
 956     thyper = ConvertLongToLargeInteger(cm_data.buf_blockSize);
 957     tbase = LargeIntegerAdd(firstModOffset, thyper);
 958     while(LargeIntegerLessThan(tbase, scanEnd)) {
 959         /* see if we can find the buffer */
 960         bufp = buf_Find(scp, &tbase);
 961         if (!bufp)
 962             break;
 963
 964         /* try to lock it, and quit if we can't (simplifies locking) */
 965         lock_ReleaseMutex(&scp->mx);
 966         code = lock_TryMutex(&bufp->mx);
 967         lock_ObtainMutex(&scp->mx);
 968         if (code == 0) {
 969             buf_Release(bufp);
 970             bufp = NULL;
 971             break;
 972         }
 973
 974         code = cm_SyncOp(scp, bufp, userp, reqp, 0, flags);
 975         if (code) {
 976             lock_ReleaseMutex(&bufp->mx);
 977             buf_Release(bufp);
 978             bufp = NULL;
 979             break;
 980         }
 981
 982         if (!(bufp->flags & CM_BUF_DIRTY)) {
 983             /* buffer is clean, so we shouldn't add it */
 984             cm_SyncOpDone(scp, bufp, flags);
 985             lock_ReleaseMutex(&bufp->mx);
 986             buf_Release(bufp);
 987             bufp = NULL;
 988             break;
 989         }
 990
 991         /* don't need buffer mutex any more */
 992         lock_ReleaseMutex(&bufp->mx);
 993
 994         /* we have a dirty buffer ready for storing.  Add it to the head
 995          * of the list, since it immediately follows all of the disk
 996          * addresses we've already collected.
 997          */
 998         qdp = osi_QDAlloc();
 999         osi_SetQData(qdp, bufp);
1000         /* no buf_hold necessary, since we have it held from buf_Find */
1001         osi_QAddH((osi_queue_t **) &biop->bufListp,
1002                   (osi_queue_t **) &biop->bufListEndp,
1003                   &qdp->q);
1004         bufp = NULL;
1005
1006         /* update biod info describing the transfer */
1007         biop->length += cm_data.buf_blockSize;
1008
1009         /* update loop pointer */
1010         tbase = LargeIntegerAdd(tbase, thyper);
1011     }   /* while loop looking for pages following the first page we found */
1012
1013     /* finally, we're done */
1014     return 0;
1015 }
1016
1017 /* scp must be locked; temporarily unlocked during processing.
1018  * If returns 0, returns buffers held in biop, and with
1019  * CM_BUF_CMFETCHING flags set.
1020  * If an error is returned, we don't return any buffers.
1021  */
1022 long cm_SetupFetchBIOD(cm_scache_t *scp, osi_hyper_t *offsetp,
1023                         cm_bulkIO_t *biop, cm_user_t *userp, cm_req_t *reqp)
1024 {
1025     long code;
1026     cm_buf_t *tbp;
1027     osi_hyper_t tblocksize;             /* a long long temp variable */
1028     osi_hyper_t pageBase;               /* base offset we're looking at */
1029     osi_queueData_t *qdp;               /* one temp queue structure */
1030     osi_queueData_t *tqdp;              /* another temp queue structure */
1031     long collected;                     /* how many bytes have been collected */
1032     int isFirst;
1033     long flags;
1034     osi_hyper_t fileSize;               /* the # of bytes in the file */
1035     osi_queueData_t *heldBufListp;      /* we hold all buffers in this list */
1036     osi_queueData_t *heldBufListEndp;   /* first one */
1037     int reserving;
1038
1039     tblocksize = ConvertLongToLargeInteger(cm_data.buf_blockSize);
1040
1041     biop->scp = scp;                    /* do not hold; held by caller */
1042     biop->offset = *offsetp;
1043     /* null out the list of buffers */
1044     biop->bufListp = biop->bufListEndp = NULL;
1045     biop->reserved = 0;
1046
1047     /* first lookup the file's length, so we know when to stop */
1048     code = cm_SyncOp(scp, NULL, userp, reqp, 0,
1049                      CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
1050     if (code)
1051         return code;
1052
1053     /* copy out size, since it may change */
1054     fileSize = scp->serverLength;
1055
1056     lock_ReleaseMutex(&scp->mx);
1057
1058     pageBase = *offsetp;
1059     collected = pageBase.LowPart & (cm_chunkSize - 1);
1060     heldBufListp = NULL;
1061     heldBufListEndp = NULL;
1062
1063     /*
1064      * Obtaining buffers can cause dirty buffers to be recycled, which
1065      * can cause a storeback, so cannot be done while we have buffers
1066      * reserved.
1067      *
1068      * To get around this, we get buffers twice.  Before reserving buffers,
1069      * we obtain and release each one individually.  After reserving
1070      * buffers, we try to obtain them again, but only by lookup, not by
1071      * recycling.  If a buffer has gone away while we were waiting for
1072      * the others, we just use whatever buffers we already have.
1073      *
1074      * On entry to this function, we are already holding a buffer, so we
1075      * can't wait for reservation.  So we call buf_TryReserveBuffers()
1076      * instead.  Not only that, we can't really even call buf_Get(), for
1077      * the same reason.  We can't avoid that, though.  To avoid deadlock
1078      * we allow only one thread to be executing the buf_Get()-buf_Release()
1079      * sequence at a time.
1080      */
1081
1082     // lock_ObtainMutex(&cm_bufGetMutex);
1083     /* first hold all buffers, since we can't hold any locks in buf_Get */
1084     while (1) {
1085         /* stop at chunk boundary */
1086         if (collected >= cm_chunkSize)
1087             break;
1088
1089         /* see if the next page would be past EOF */
1090         if (LargeIntegerGreaterThanOrEqualTo(pageBase, fileSize))
1091             break;
1092
1093         lock_ObtainRead(&scp->bufCreateLock);
1094         code = buf_Get(scp, &pageBase, &tbp);
1095         lock_ReleaseRead(&scp->bufCreateLock);
1096         if (code) {
1097             //lock_ReleaseMutex(&cm_bufGetMutex);
1098             lock_ObtainMutex(&scp->mx);
1099             cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
1100             return code;
1101         }
1102
1103         buf_Release(tbp);
1104         tbp = NULL;
1105
1106         pageBase = LargeIntegerAdd(tblocksize, pageBase);
1107         collected += cm_data.buf_blockSize;
1108     }
1109
1110     /* reserve a chunk's worth of buffers if possible */
1111     reserving = buf_TryReserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
1112
1113     // lock_ReleaseMutex(&cm_bufGetMutex);
1114
1115     pageBase = *offsetp;
1116     collected = pageBase.LowPart & (cm_chunkSize - 1);
1117
1118     /* now hold all buffers, if they are still there */
1119     while (1) {
1120         /* stop at chunk boundary */
1121         if (collected >= cm_chunkSize)
1122             break;
1123
1124         /* see if the next page would be past EOF */
1125         if (LargeIntegerGreaterThanOrEqualTo(pageBase, fileSize))
1126             break;
1127
1128         tbp = buf_Find(scp, &pageBase);
1129         if (!tbp)
1130             break;
1131
1132         /* add the buffer to the list */
1133         qdp = osi_QDAlloc();
1134         osi_SetQData(qdp, tbp);
1135         osi_QAddH((osi_queue_t **)&heldBufListp,
1136                   (osi_queue_t **)&heldBufListEndp,
1137                   &qdp->q);
1138         /* leave tbp held (from buf_Get) */
1139
1140         if (!reserving)
1141             break;
1142
1143         collected += cm_data.buf_blockSize;
1144         pageBase = LargeIntegerAdd(tblocksize, pageBase);
1145     }
1146
1147     /* look at each buffer, adding it into the list if it looks idle and
1148      * filled with old data.  One special case: wait for idle if it is the
1149      * first buffer since we really need that one for our caller to make
1150      * any progress.
1151      */
1152     isFirst = 1;
1153     collected = 0;              /* now count how many we'll really use */
1154     for (tqdp = heldBufListEndp;
1155         tqdp;
1156           tqdp = (osi_queueData_t *) osi_QPrev(&tqdp->q)) {
1157         /* get a ptr to the held buffer */
1158         tbp = osi_GetQData(tqdp);
1159         pageBase = tbp->offset;
1160
1161         /* now lock the buffer lock */
1162         lock_ObtainMutex(&tbp->mx);
1163         lock_ObtainMutex(&scp->mx);
1164
1165         /* don't bother fetching over data that is already current */
1166         if (tbp->dataVersion == scp->dataVersion) {
1167             /* we don't need this buffer, since it is current */
1168             lock_ReleaseMutex(&scp->mx);
1169             lock_ReleaseMutex(&tbp->mx);
1170             break;
1171         }
1172
1173         flags = CM_SCACHESYNC_FETCHDATA | CM_SCACHESYNC_BUFLOCKED;
1174         if (!isFirst)
1175             flags |= CM_SCACHESYNC_NOWAIT;
1176
1177         /* wait for the buffer to serialize, if required.  Doesn't
1178          * release the scp or buffer lock(s) if NOWAIT is specified.
1179          */
1180         code = cm_SyncOp(scp, tbp, userp, reqp, 0, flags);
1181         if (code) {
1182             lock_ReleaseMutex(&scp->mx);
1183             lock_ReleaseMutex(&tbp->mx);
1184             break;
1185         }
1186
1187         /* don't fetch over dirty buffers */
1188         if (tbp->flags & CM_BUF_DIRTY) {
1189             cm_SyncOpDone(scp, tbp, flags);
1190             lock_ReleaseMutex(&scp->mx);
1191             lock_ReleaseMutex(&tbp->mx);
1192             break;
1193         }
1194
1195         /* Release locks */
1196         lock_ReleaseMutex(&scp->mx);
1197         lock_ReleaseMutex(&tbp->mx);
1198
1199         /* add the buffer to the list */
1200         qdp = osi_QDAlloc();
1201         osi_SetQData(qdp, tbp);
1202         osi_QAddH((osi_queue_t **)&biop->bufListp,
1203                   (osi_queue_t **)&biop->bufListEndp,
1204                   &qdp->q);
1205         buf_Hold(tbp);
1206
1207         /* from now on, a failure just stops our collection process, but
1208          * we still do the I/O to whatever we've already managed to collect.
1209          */
1210         isFirst = 0;
1211         collected += cm_data.buf_blockSize;
1212     }
1213
1214     /* now, we've held in biop->bufListp all the buffer's we're really
1215      * interested in.  We also have holds left from heldBufListp, and we
1216      * now release those holds on the buffers.
1217      */
1218     for (qdp = heldBufListp; qdp; qdp = tqdp) {
1219         tqdp = (osi_queueData_t *) osi_QNext(&qdp->q);
1220         tbp = osi_GetQData(qdp);
1221         osi_QRemoveHT((osi_queue_t **) &heldBufListp,
1222                       (osi_queue_t **) &heldBufListEndp,
1223                       &qdp->q);
1224         osi_QDFree(qdp);
1225         buf_Release(tbp);
1226         tbp = NULL;
1227     }
1228
1229     /* Caller expects this */
1230     lock_ObtainMutex(&scp->mx);
1231
1232     /* if we got a failure setting up the first buffer, then we don't have
1233      * any side effects yet, and we also have failed an operation that the
1234      * caller requires to make any progress.  Give up now.
1235      */
1236     if (code && isFirst) {
1237         buf_UnreserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
1238         return code;
1239     }
1240
1241     /* otherwise, we're still OK, and should just return the I/O setup we've
1242      * got.
1243      */
1244     biop->length = collected;
1245     biop->reserved = reserving;
1246     return 0;
1247 }
1248
1249 /* release a bulk I/O structure that was setup by cm_SetupFetchBIOD or by
1250  * cm_SetupStoreBIOD
1251  */
1252 void cm_ReleaseBIOD(cm_bulkIO_t *biop, int isStore, int failed)
1253 {
1254     cm_scache_t *scp;           /* do not release; not held in biop */
1255     cm_buf_t *bufp;
1256     osi_queueData_t *qdp;
1257     osi_queueData_t *nqdp;
1258     int flags;
1259
1260     /* Give back reserved buffers */
1261     if (biop->reserved)
1262         buf_UnreserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
1263
1264     if (isStore)
1265         flags = CM_SCACHESYNC_STOREDATA;
1266     else
1267         flags = CM_SCACHESYNC_FETCHDATA;
1268
1269     scp = biop->scp;
1270     if (biop->bufListp) {
1271         for(qdp = biop->bufListp; qdp; qdp = nqdp) {
1272             /* lookup next guy first, since we're going to free this one */
1273             nqdp = (osi_queueData_t *) osi_QNext(&qdp->q);
1274
1275             /* extract buffer and free queue data */
1276             bufp = osi_GetQData(qdp);
1277             osi_QRemoveHT((osi_queue_t **) &biop->bufListp,
1278                            (osi_queue_t **) &biop->bufListEndp,
1279                            &qdp->q);
1280             osi_QDFree(qdp);
1281
1282             /* now, mark I/O as done, unlock the buffer and release it */
1283             lock_ObtainMutex(&bufp->mx);
1284             lock_ObtainMutex(&scp->mx);
1285             cm_SyncOpDone(scp, bufp, flags);
1286
1287             /* turn off writing and wakeup users */
1288             if (isStore) {
1289                 if (bufp->flags & CM_BUF_WAITING) {
1290                     osi_Log2(afsd_logp, "cm_ReleaseBIOD Waking [scp 0x%p] bp 0x%p", scp, bufp);
1291                     osi_Wakeup((LONG_PTR) bufp);
1292                 }
1293                 if (failed)
1294                     bufp->flags &= ~CM_BUF_WRITING;
1295                 else {
1296                     bufp->flags &= ~(CM_BUF_WRITING | CM_BUF_DIRTY);
1297                     bufp->dirty_offset = bufp->dirty_length = 0;
1298                 }
1299             }
1300
1301             lock_ReleaseMutex(&scp->mx);
1302             lock_ReleaseMutex(&bufp->mx);
1303             buf_Release(bufp);
1304             bufp = NULL;
1305         }
1306     } else {
1307         lock_ObtainMutex(&scp->mx);
1308         cm_SyncOpDone(scp, NULL, flags);
1309         lock_ReleaseMutex(&scp->mx);
1310     }
1311
1312     /* clean things out */
1313     biop->bufListp = NULL;
1314     biop->bufListEndp = NULL;
1315 }
1316
1317 /* Fetch a buffer.  Called with scp locked.
1318  * The scp is locked on return.
1319  */
1320 long cm_GetBuffer(cm_scache_t *scp, cm_buf_t *bufp, int *cpffp, cm_user_t *userp,
1321                   cm_req_t *reqp)
1322 {
1323     long code;
1324     afs_int32 nbytes;                   /* bytes in transfer */
1325     afs_int32 nbytes_hi = 0;            /* high-order 32 bits of bytes in transfer */
1326     afs_int64 length_found = 0;
1327     long rbytes;                        /* bytes in rx_Read call */
1328     long temp;
1329     AFSFetchStatus afsStatus;
1330     AFSCallBack callback;
1331     AFSVolSync volSync;
1332     char *bufferp;
1333     cm_buf_t *tbufp;                    /* buf we're filling */
1334     osi_queueData_t *qdp;               /* q element we're scanning */
1335     AFSFid tfid;
1336     struct rx_call *callp;
1337     struct rx_connection *rxconnp;
1338     cm_bulkIO_t biod;           /* bulk IO descriptor */
1339     cm_conn_t *connp;
1340     int getroot;
1341     afs_int32 t1,t2;
1342     int require_64bit_ops = 0;
1343
1344     /* now, the buffer may or may not be filled with good data (buf_GetNew
1345      * drops lots of locks, and may indeed return a properly initialized
1346      * buffer, although more likely it will just return a new, empty, buffer.
1347      */
1348
1349 #ifdef AFS_FREELANCE_CLIENT
1350
1351     // yj: if they're trying to get the /afs directory, we need to
1352     // handle it differently, since it's local rather than on any
1353     // server
1354
1355     getroot = (scp==cm_data.rootSCachep);
1356     if (getroot)
1357         osi_Log1(afsd_logp,"GetBuffer returns cm_data.rootSCachep=%x",cm_data.rootSCachep);
1358 #endif
1359
1360     if (cm_HaveCallback(scp) && bufp->dataVersion == scp->dataVersion) {
1361         /* We already have this buffer don't do extra work */
1362         return 0;
1363     }
1364
1365     cm_AFSFidFromFid(&tfid, &scp->fid);
1366
1367     code = cm_SetupFetchBIOD(scp, &bufp->offset, &biod, userp, reqp);
1368     if (code) {
1369         /* couldn't even get the first page setup properly */
1370         osi_Log1(afsd_logp, "GetBuffer: SetupFetchBIOD failure code %d", code);
1371         return code;
1372     }
1373
1374     /* once we get here, we have the callback in place, we know that no one
1375      * is fetching the data now.  Check one last time that we still have
1376      * the wrong data, and then fetch it if we're still wrong.
1377      *
1378      * We can lose a race condition and end up with biod.length zero, in
1379      * which case we just retry.
1380      */
1381     if (bufp->dataVersion == scp->dataVersion || biod.length == 0) {
1382         if ((bufp->dataVersion == -1 || bufp->dataVersion < scp->dataVersion) &&
1383              LargeIntegerGreaterThanOrEqualTo(bufp->offset, scp->serverLength))
1384         {
1385             osi_Log3(afsd_logp, "Bad DVs %I64d, %I64d or length 0x%x",
1386                       bufp->dataVersion, scp->dataVersion, biod.length);
1387
1388             if (bufp->dataVersion == -1)
1389                 memset(bufp->datap, 0, cm_data.buf_blockSize);
1390             bufp->dataVersion = scp->dataVersion;
1391         }
1392         lock_ReleaseMutex(&scp->mx);
1393         cm_ReleaseBIOD(&biod, 0, 0);
1394         lock_ObtainMutex(&scp->mx);
1395         return 0;
1396     }
1397
1398     lock_ReleaseMutex(&scp->mx);
1399
1400     if (LargeIntegerGreaterThan(LargeIntegerAdd(biod.offset,
1401                                                 ConvertLongToLargeInteger(biod.length)),
1402                                 ConvertLongToLargeInteger(LONG_MAX))) {
1403         require_64bit_ops = 1;
1404     }
1405
1406 #ifdef DISKCACHE95
1407     DPRINTF("cm_GetBuffer: fetching data scpDV=%I64d bufDV=%I64d scp=%x bp=%x dcp=%x\n",
1408             scp->dataVersion, bufp->dataVersion, scp, bufp, bufp->dcp);
1409 #endif /* DISKCACHE95 */
1410
1411 #ifdef AFS_FREELANCE_CLIENT
1412
1413     // yj code
1414     // if getroot then we don't need to make any calls
1415     // just return fake data
1416
1417     if (cm_freelanceEnabled && getroot) {
1418         // setup the fake status
1419         afsStatus.InterfaceVersion = 0x1;
1420         afsStatus.FileType = 0x2;
1421         afsStatus.LinkCount = scp->linkCount;
1422         afsStatus.Length = cm_fakeDirSize;
1423         afsStatus.DataVersion = (afs_uint32)(cm_data.fakeDirVersion & 0xFFFFFFFF);
1424         afsStatus.Author = 0x1;
1425         afsStatus.Owner = 0x0;
1426         afsStatus.CallerAccess = 0x9;
1427         afsStatus.AnonymousAccess = 0x9;
1428         afsStatus.UnixModeBits = 0x1ff;
1429         afsStatus.ParentVnode = 0x1;
1430         afsStatus.ParentUnique = 0x1;
1431         afsStatus.ResidencyMask = 0;
1432         afsStatus.ClientModTime = (afs_uint32)FakeFreelanceModTime;
1433         afsStatus.ServerModTime = (afs_uint32)FakeFreelanceModTime;
1434         afsStatus.Group = 0;
1435         afsStatus.SyncCounter = 0;
1436         afsStatus.dataVersionHigh = (afs_uint32)(cm_data.fakeDirVersion >> 32);
1437         afsStatus.lockCount = 0;
1438         afsStatus.Length_hi = 0;
1439         afsStatus.errorCode = 0;
1440
1441         // once we're done setting up the status info,
1442         // we just fill the buffer pages with fakedata
1443         // from cm_FakeRootDir. Extra pages are set to
1444         // 0.
1445
1446         lock_ObtainMutex(&cm_Freelance_Lock);
1447         t1 = bufp->offset.LowPart;
1448         qdp = biod.bufListEndp;
1449         while (qdp) {
1450             tbufp = osi_GetQData(qdp);
1451             bufferp=tbufp->datap;
1452             memset(bufferp, 0, cm_data.buf_blockSize);
1453             t2 = cm_fakeDirSize - t1;
1454             if (t2> (afs_int32)cm_data.buf_blockSize)
1455                 t2=cm_data.buf_blockSize;
1456             if (t2 > 0) {
1457                 memcpy(bufferp, cm_FakeRootDir+t1, t2);
1458             } else {
1459                 t2 = 0;
1460             }
1461             t1+=t2;
1462             qdp = (osi_queueData_t *) osi_QPrev(&qdp->q);
1463
1464         }
1465         lock_ReleaseMutex(&cm_Freelance_Lock);
1466
1467         // once we're done, we skip over the part of the
1468         // code that does the ACTUAL fetching of data for
1469         // real files
1470
1471         goto fetchingcompleted;
1472     }
1473
1474 #endif /* AFS_FREELANCE_CLIENT */
1475
1476         /* now make the call */
1477     do {
1478         code = cm_ConnFromFID(&scp->fid, userp, reqp, &connp);
1479         if (code)
1480             continue;
1481
1482         rxconnp = cm_GetRxConn(connp);
1483         callp = rx_NewCall(rxconnp);
1484         rx_PutConnection(rxconnp);
1485
1486 #ifdef AFS_LARGEFILES
1487         nbytes = nbytes_hi = 0;
1488
1489         if (SERVERHAS64BIT(connp)) {
1490             osi_Log4(afsd_logp, "CALL FetchData64 scp 0x%p, off 0x%x:%08x, size 0x%x",
1491                      scp, biod.offset.HighPart, biod.offset.LowPart, biod.length);
1492
1493             code = StartRXAFS_FetchData64(callp, &tfid, biod.offset.QuadPart, biod.length);
1494
1495             if (code == 0) {
1496                 temp = rx_Read(callp, (char *) &nbytes_hi, sizeof(afs_int32));
1497                 if (temp == sizeof(afs_int32)) {
1498                     nbytes_hi = ntohl(nbytes_hi);
1499                 } else {
1500                     nbytes_hi = 0;
1501                     code = callp->error;
1502                     rx_EndCall(callp, code);
1503                     callp = NULL;
1504                 }
1505             }
1506         }
1507
1508         if (code == RXGEN_OPCODE || !SERVERHAS64BIT(connp)) {
1509             if (require_64bit_ops) {
1510                 osi_Log0(afsd_logp, "Skipping FetchData.  Operation requires FetchData64");
1511                 code = CM_ERROR_TOOBIG;
1512             } else {
1513                 if (!callp) {
1514                     rxconnp = cm_GetRxConn(connp);
1515                     callp = rx_NewCall(rxconnp);
1516                     rx_PutConnection(rxconnp);
1517                 }
1518
1519                 osi_Log3(afsd_logp, "CALL FetchData scp 0x%p, off 0x%x, size 0x%x",
1520                          scp, biod.offset.LowPart, biod.length);
1521
1522                 code = StartRXAFS_FetchData(callp, &tfid, biod.offset.LowPart,
1523                                             biod.length);
1524
1525                 SET_SERVERHASNO64BIT(connp);
1526             }
1527         }
1528
1529         if (code == 0) {
1530             temp  = rx_Read(callp, (char *)&nbytes, sizeof(afs_int32));
1531             if (temp == sizeof(afs_int32)) {
1532                 nbytes = ntohl(nbytes);
1533                 FillInt64(length_found, nbytes_hi, nbytes);
1534                 if (length_found > biod.length)
1535                     code = (callp->error < 0) ? callp->error : -1;
1536             } else {
1537                 code = (callp->error < 0) ? callp->error : -1;
1538             }
1539         }
1540         /* for the moment, nbytes_hi will always be 0 if code == 0
1541            because biod.length is a 32-bit quantity. */
1542 #else
1543         osi_Log3(afsd_logp, "CALL FetchData scp 0x%p, off 0x%x, size 0x%x",
1544                  scp, biod.offset.LowPart, biod.length);
1545
1546         code = StartRXAFS_FetchData(callp, &tfid, biod.offset.LowPart,
1547                                     biod.length);
1548
1549         /* now copy the data out of the pipe and put it in the buffer */
1550         if (code == 0) {
1551             temp  = rx_Read(callp, (char *)&nbytes, sizeof(afs_int32));
1552             if (temp == sizeof(afs_int32)) {
1553                 nbytes = ntohl(nbytes);
1554                 if (nbytes > biod.length)
1555                     code = (callp->error < 0) ? callp->error : -1;
1556             }
1557             else
1558                 code = (callp->error < 0) ? callp->error : -1;
1559         }
1560 #endif
1561
1562         if (code == 0) {
1563             qdp = biod.bufListEndp;
1564             if (qdp) {
1565                 tbufp = osi_GetQData(qdp);
1566                 bufferp = tbufp->datap;
1567             }
1568             else
1569                 bufferp = NULL;
1570             /* fill nbytes of data from the pipe into the pages.
1571              * When we stop, qdp will point at the last page we're
1572              * dealing with, and bufferp will tell us where we
1573              * stopped.  We'll need this info below when we clear
1574              * the remainder of the last page out (and potentially
1575              * clear later pages out, if we fetch past EOF).
1576              */
1577             while (nbytes > 0) {
1578                 /* assert that there are still more buffers;
1579                  * our check above for nbytes being less than
1580                  * biod.length should ensure this.
1581                  */
1582                 osi_assertx(bufferp != NULL, "null cm_buf_t");
1583
1584                 /* read rbytes of data */
1585                 rbytes = (nbytes > cm_data.buf_blockSize? cm_data.buf_blockSize : nbytes);
1586                 temp = rx_Read(callp, bufferp, rbytes);
1587                 if (temp < rbytes) {
1588                     code = (callp->error < 0) ? callp->error : -1;
1589                     break;
1590                 }
1591
1592                 /* allow read-while-fetching.
1593                  * if this is the last buffer, clear the
1594                  * PREFETCHING flag, so the reader waiting for
1595                  * this buffer will start a prefetch.
1596                  */
1597                 tbufp->cmFlags |= CM_BUF_CMFULLYFETCHED;
1598                 lock_ObtainMutex(&scp->mx);
1599                 if (scp->flags & CM_SCACHEFLAG_WAITING) {
1600                     osi_Log1(afsd_logp, "CM GetBuffer Waking scp 0x%p", scp);
1601                     osi_Wakeup((LONG_PTR) &scp->flags);
1602                 }
1603                 if (cpffp && !*cpffp && !osi_QPrev(&qdp->q)) {
1604                     osi_hyper_t tlength = ConvertLongToLargeInteger(biod.length);
1605                     *cpffp = 1;
1606                     cm_ClearPrefetchFlag(0, scp, &biod.offset, &tlength);
1607                 }
1608                 lock_ReleaseMutex(&scp->mx);
1609
1610                 /* and adjust counters */
1611                 nbytes -= temp;
1612
1613                 /* and move to the next buffer */
1614                 if (nbytes != 0) {
1615                     qdp = (osi_queueData_t *) osi_QPrev(&qdp->q);
1616                     if (qdp) {
1617                         tbufp = osi_GetQData(qdp);
1618                         bufferp = tbufp->datap;
1619                     }
1620                     else
1621                         bufferp = NULL;
1622                 } else
1623                     bufferp += temp;
1624             }
1625
1626             /* zero out remainder of last pages, in case we are
1627              * fetching past EOF.  We were fetching an integral #
1628              * of pages, but stopped, potentially in the middle of
1629              * a page.  Zero the remainder of that page, and then
1630              * all of the rest of the pages.
1631              */
1632             /* bytes fetched */
1633             osi_assertx((bufferp - tbufp->datap) < LONG_MAX, "data >= LONG_MAX");
1634             rbytes = (long) (bufferp - tbufp->datap);
1635
1636             /* bytes left to zero */
1637             rbytes = cm_data.buf_blockSize - rbytes;
1638             while(qdp) {
1639                 if (rbytes != 0)
1640                     memset(bufferp, 0, rbytes);
1641                 qdp = (osi_queueData_t *) osi_QPrev(&qdp->q);
1642                 if (qdp == NULL)
1643                     break;
1644                 tbufp = osi_GetQData(qdp);
1645                 bufferp = tbufp->datap;
1646                 /* bytes to clear in this page */
1647                 rbytes = cm_data.buf_blockSize;
1648             }
1649         }
1650
1651         if (code == 0) {
1652             if (SERVERHAS64BIT(connp))
1653                 code = EndRXAFS_FetchData64(callp, &afsStatus, &callback, &volSync);
1654             else
1655                 code = EndRXAFS_FetchData(callp, &afsStatus, &callback, &volSync);
1656         } else {
1657             if (SERVERHAS64BIT(connp))
1658                 osi_Log1(afsd_logp, "CALL EndRXAFS_FetchData64 skipped due to error %d", code);
1659             else
1660                 osi_Log1(afsd_logp, "CALL EndRXAFS_FetchData skipped due to error %d", code);
1661         }
1662
1663         if (callp)
1664             code = rx_EndCall(callp, code);
1665
1666         if (code == RXKADUNKNOWNKEY)
1667             osi_Log0(afsd_logp, "CALL EndCall returns RXKADUNKNOWNKEY");
1668
1669         osi_Log0(afsd_logp, "CALL FetchData DONE");
1670
1671     } while (cm_Analyze(connp, userp, reqp, &scp->fid, &volSync, NULL, NULL, code));
1672
1673   fetchingcompleted:
1674     code = cm_MapRPCError(code, reqp);
1675
1676     lock_ObtainMutex(&scp->mx);
1677
1678     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_FETCHSTATUS);
1679
1680     /* we know that no one else has changed the buffer, since we still have
1681      * the fetching flag on the buffers, and we have the scp locked again.
1682      * Copy in the version # into the buffer if we got code 0 back from the
1683      * read.
1684      */
1685     if (code == 0) {
1686         for(qdp = biod.bufListp;
1687              qdp;
1688              qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1689             tbufp = osi_GetQData(qdp);
1690             tbufp->dataVersion = afsStatus.dataVersionHigh;
1691             tbufp->dataVersion <<= 32;
1692             tbufp->dataVersion |= afsStatus.DataVersion;
1693
1694 #ifdef DISKCACHE95
1695             /* write buffer out to disk cache */
1696             diskcache_Update(tbufp->dcp, tbufp->datap, cm_data.buf_blockSize,
1697                               tbufp->dataVersion);
1698 #endif /* DISKCACHE95 */
1699         }
1700     }
1701
1702     /* release scatter/gather I/O structure (buffers, locks) */
1703     lock_ReleaseMutex(&scp->mx);
1704     cm_ReleaseBIOD(&biod, 0, code);
1705     lock_ObtainMutex(&scp->mx);
1706
1707     if (code == 0)
1708         cm_MergeStatus(NULL, scp, &afsStatus, &volSync, userp, 0);
1709
1710     return code;
1711 }