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