Windows: AFSVolSync creationDate based readonly volume versioning
[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 /* used when deciding whether to do a prefetch or not */
563 long cm_CheckFetchRange(cm_scache_t *scp, osi_hyper_t *startBasep, osi_hyper_t *length,
564                         cm_user_t *userp, cm_req_t *reqp, osi_hyper_t *realBasep)
565 {
566     osi_hyper_t tbase;
567     osi_hyper_t tlength;
568     osi_hyper_t tblocksize;
569     long code;
570     cm_buf_t *bp;
571     int stop;
572         
573     /* now scan all buffers in the range, looking for any that look like
574      * they need work.
575      */
576     tbase = *startBasep;
577     tlength = *length;
578     tblocksize = ConvertLongToLargeInteger(cm_data.buf_blockSize);
579     stop = 0;
580     lock_ObtainWrite(&scp->rw);
581     while (LargeIntegerGreaterThanZero(tlength)) {
582         /* get callback so we can do a meaningful dataVersion comparison */
583         code = cm_SyncOp(scp, NULL, userp, reqp, 0,
584                          CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
585         if (code) {
586             scp->flags &= ~CM_SCACHEFLAG_PREFETCHING;
587             lock_ReleaseWrite(&scp->rw);
588             return code;
589         }
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)) == 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         scp->flags &= ~CM_SCACHEFLAG_PREFETCHING;
624         code = -1;
625     }   
626     else {
627         /* successfully found a page that will need fetching */
628         *realBasep = tbase;
629         code = 0;
630     }
631     lock_ReleaseWrite(&scp->rw);
632     return code;
633 }
634
635 afs_int32
636 cm_BkgStore(cm_scache_t *scp, afs_uint32 p1, afs_uint32 p2, afs_uint32 p3, afs_uint32 p4,
637             cm_user_t *userp)
638 {
639     osi_hyper_t toffset;
640     long length;
641     cm_req_t req;
642     long code = 0;
643
644     if (scp->flags & CM_SCACHEFLAG_DELETED) {
645         osi_Log4(afsd_logp, "Skipping BKG store - Deleted scp 0x%p, offset 0x%x:%08x, length 0x%x", scp, p2, p1, p3);
646     } else {
647         cm_InitReq(&req);
648
649         /* Retries will be performed by the BkgDaemon thread if appropriate */
650         req.flags |= CM_REQ_NORETRY;
651
652         toffset.LowPart = p1;
653         toffset.HighPart = p2;
654         length = p3;
655
656         osi_Log4(afsd_logp, "Starting BKG store scp 0x%p, offset 0x%x:%08x, length 0x%x", scp, p2, p1, p3);
657
658         code = cm_BufWrite(scp, &toffset, length, /* flags */ 0, userp, &req);
659
660         osi_Log4(afsd_logp, "Finished BKG store scp 0x%p, offset 0x%x:%08x, code 0x%x", scp, p2, p1, code);
661     }
662
663     /* 
664      * Keep the following list synchronized with the
665      * error code list in cm_BkgDaemon 
666      */
667     switch ( code ) {
668     case CM_ERROR_TIMEDOUT: /* or server restarting */
669     case CM_ERROR_RETRY:
670     case CM_ERROR_WOULDBLOCK:
671     case CM_ERROR_ALLBUSY:
672     case CM_ERROR_ALLDOWN:
673     case CM_ERROR_ALLOFFLINE:
674     case CM_ERROR_PARTIALWRITE:
675         break;  /* cm_BkgDaemon will re-insert the request in the queue */
676     case 0:
677     default:
678         lock_ObtainWrite(&scp->rw);
679         cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_ASYNCSTORE);
680         lock_ReleaseWrite(&scp->rw);
681     }
682     return code;
683 }
684
685 /* Called with scp locked */
686 void cm_ClearPrefetchFlag(long code, cm_scache_t *scp, osi_hyper_t *base, osi_hyper_t *length)
687 {
688     osi_hyper_t end;
689
690     if (code == 0) {
691         end =  LargeIntegerAdd(*base, *length);
692         if (LargeIntegerGreaterThan(*base, scp->prefetch.base))
693             scp->prefetch.base = *base;
694         if (LargeIntegerGreaterThan(end, scp->prefetch.end))
695             scp->prefetch.end = end;
696     }
697     scp->flags &= ~CM_SCACHEFLAG_PREFETCHING;
698 }
699
700 /* do the prefetch.  if the prefetch fails, return 0 (success)
701  * because there is no harm done.  */
702 afs_int32
703 cm_BkgPrefetch(cm_scache_t *scp, afs_uint32 p1, afs_uint32 p2, afs_uint32 p3, afs_uint32 p4,
704                cm_user_t *userp)
705 {
706     osi_hyper_t length;
707     osi_hyper_t base;
708     osi_hyper_t offset;
709     osi_hyper_t end;
710     osi_hyper_t fetched;
711     osi_hyper_t tblocksize;
712     long code;
713     int mxheld = 0;
714     cm_buf_t *bp = NULL;
715     cm_req_t req;
716
717     cm_InitReq(&req);
718
719     /* Retries will be performed by the BkgDaemon thread if appropriate */
720     req.flags |= CM_REQ_NORETRY;
721         
722     fetched.LowPart = 0;
723     fetched.HighPart = 0;
724     tblocksize = ConvertLongToLargeInteger(cm_data.buf_blockSize);
725     base.LowPart = p1;
726     base.HighPart = p2;
727     length.LowPart = p3;
728     length.HighPart = p4;
729
730     end = LargeIntegerAdd(base, length);
731         
732     osi_Log3(afsd_logp, "Starting BKG prefetch scp 0x%p, base 0x%x:%x", scp, p2, p1);
733
734     for ( code = 0, offset = base;
735           code == 0 && LargeIntegerLessThan(offset, end); 
736           offset = LargeIntegerAdd(offset, tblocksize) )
737     {
738         if (mxheld) {
739             lock_ReleaseWrite(&scp->rw);
740             mxheld = 0;
741         }
742
743         code = buf_Get(scp, &offset, &req, &bp);
744         if (code)
745             break;
746
747         if (bp->cmFlags & CM_BUF_CMFETCHING) {
748             /* skip this buffer as another thread is already fetching it */
749             buf_Release(bp);
750             bp = NULL;
751             continue;
752         }
753
754         if (!mxheld) {
755             lock_ObtainWrite(&scp->rw);
756             mxheld = 1;
757         }
758
759         code = cm_GetBuffer(scp, bp, NULL, userp, &req);
760         if (code == 0)
761             fetched = LargeIntegerAdd(fetched, tblocksize); 
762         buf_Release(bp);
763     }
764     
765     if (!mxheld) {
766         lock_ObtainWrite(&scp->rw);
767         mxheld = 1;
768     }
769     cm_ClearPrefetchFlag(LargeIntegerGreaterThanZero(fetched) ? 0 : code, 
770                          scp, &base, &fetched);
771     lock_ReleaseWrite(&scp->rw);
772
773     osi_Log4(afsd_logp, "Ending BKG prefetch scp 0x%p, code %d bytes 0x%x:%x", 
774               scp, code, fetched.HighPart, fetched.LowPart);
775     return code;
776 }
777
778 /* a read was issued to offsetp, and we have to determine whether we should
779  * do a prefetch of the next chunk.
780  */
781 void cm_ConsiderPrefetch(cm_scache_t *scp, osi_hyper_t *offsetp, afs_uint32 count,
782                          cm_user_t *userp, cm_req_t *reqp)
783 {
784     long code;
785     osi_hyper_t realBase;
786     osi_hyper_t readBase;
787     osi_hyper_t readLength;
788         
789     readBase = *offsetp;
790     /* round up to chunk boundary */
791     readBase.LowPart += (cm_chunkSize-1);
792     readBase.LowPart &= (-cm_chunkSize);
793
794     readLength = ConvertLongToLargeInteger(count);
795
796     lock_ObtainWrite(&scp->rw);
797     if ((scp->flags & CM_SCACHEFLAG_PREFETCHING)
798          || LargeIntegerLessThanOrEqualTo(readBase, scp->prefetch.base)) {
799         lock_ReleaseWrite(&scp->rw);
800         return;
801     }
802     scp->flags |= CM_SCACHEFLAG_PREFETCHING;
803
804     /* start the scan at the latter of the end of this read or
805      * the end of the last fetched region.
806      */
807     if (LargeIntegerGreaterThan(scp->prefetch.end, readBase))
808         readBase = scp->prefetch.end;
809
810     lock_ReleaseWrite(&scp->rw);
811
812     code = cm_CheckFetchRange(scp, &readBase, &readLength, userp, reqp,
813                               &realBase);
814     if (code) 
815         return; /* can't find something to prefetch */
816
817     osi_Log2(afsd_logp, "BKG Prefetch request scp 0x%p, base 0x%x",
818              scp, realBase.LowPart);
819
820     cm_QueueBKGRequest(scp, cm_BkgPrefetch, 
821                        realBase.LowPart, realBase.HighPart, 
822                        readLength.LowPart, readLength.HighPart, 
823                        userp);
824 }
825
826 /* scp must be locked; temporarily unlocked during processing.
827  * If returns 0, returns buffers held in biop, and with
828  * CM_BUF_CMSTORING set.
829  *
830  * Caller *must* set CM_BUF_WRITING and reset the over.hEvent field if the
831  * buffer is ever unlocked before CM_BUF_DIRTY is cleared.  And if
832  * CM_BUF_WRITING is ever viewed by anyone, then it must be cleared, sleepers
833  * must be woken, and the event must be set when the I/O is done.  All of this
834  * is required so that buf_WaitIO synchronizes properly with the buffer as it
835  * is being written out.
836  */
837 long cm_SetupStoreBIOD(cm_scache_t *scp, osi_hyper_t *inOffsetp, long inSize,
838                        cm_bulkIO_t *biop, cm_user_t *userp, cm_req_t *reqp)
839 {
840     cm_buf_t *bufp;
841     osi_queueData_t *qdp;
842     osi_hyper_t thyper;
843     osi_hyper_t tbase;
844     osi_hyper_t scanStart;              /* where to start scan for dirty pages */
845     osi_hyper_t scanEnd;                /* where to stop scan for dirty pages */
846     osi_hyper_t firstModOffset; /* offset of first modified page in range */
847     long temp;
848     long code;
849     long flags;                 /* flags to cm_SyncOp */
850         
851     /* clear things out */
852     biop->scp = scp;                    /* do not hold; held by caller */
853     biop->offset = *inOffsetp;
854     biop->length = 0;
855     biop->bufListp = NULL;
856     biop->bufListEndp = NULL;
857     biop->reserved = 0;
858
859     /* reserve a chunk's worth of buffers */
860     lock_ReleaseWrite(&scp->rw);
861     buf_ReserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
862     lock_ObtainWrite(&scp->rw);
863
864     bufp = NULL;
865     for (temp = 0; temp < inSize; temp += cm_data.buf_blockSize) {
866         thyper = ConvertLongToLargeInteger(temp);
867         tbase = LargeIntegerAdd(*inOffsetp, thyper);
868
869         bufp = buf_Find(scp, &tbase);
870         if (bufp) {
871             /* get buffer mutex and scp mutex safely */
872             lock_ReleaseWrite(&scp->rw);
873             lock_ObtainMutex(&bufp->mx);
874             lock_ObtainWrite(&scp->rw);
875
876             flags = CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_STOREDATA | CM_SCACHESYNC_BUFLOCKED;
877             code = cm_SyncOp(scp, bufp, userp, reqp, 0, flags); 
878             if (code) {
879                 lock_ReleaseMutex(&bufp->mx);
880                 buf_Release(bufp);
881                 bufp = NULL;
882                 buf_UnreserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
883                 return code;
884             }   
885                         
886             /* if the buffer is dirty, we're done */
887             if (bufp->flags & CM_BUF_DIRTY) {
888                 osi_assertx(!(bufp->flags & CM_BUF_WRITING),
889                             "WRITING w/o CMSTORING in SetupStoreBIOD");
890                 bufp->flags |= CM_BUF_WRITING;
891                 break;
892             }
893
894             /* this buffer is clean, so there's no reason to process it */
895             cm_SyncOpDone(scp, bufp, flags);
896             lock_ReleaseMutex(&bufp->mx);
897             buf_Release(bufp);
898             bufp = NULL;
899         }       
900     }
901
902     biop->reserved = 1;
903         
904     /* if we get here, if bufp is null, we didn't find any dirty buffers
905      * that weren't already being stored back, so we just quit now.
906      */
907     if (!bufp) {
908         return 0;
909     }
910
911     /* don't need buffer mutex any more */
912     lock_ReleaseMutex(&bufp->mx);
913         
914     /* put this element in the list */
915     qdp = osi_QDAlloc();
916     osi_SetQData(qdp, bufp);
917     /* don't have to hold bufp, since held by buf_Find above */
918     osi_QAddH((osi_queue_t **) &biop->bufListp,
919               (osi_queue_t **) &biop->bufListEndp,
920               &qdp->q);
921     biop->length = cm_data.buf_blockSize;
922     firstModOffset = bufp->offset;
923     biop->offset = firstModOffset;
924     bufp = NULL;        /* this buffer and reference added to the queue */
925
926     /* compute the window surrounding *inOffsetp of size cm_chunkSize */
927     scanStart = *inOffsetp;
928     scanStart.LowPart &= (-cm_chunkSize);
929     thyper = ConvertLongToLargeInteger(cm_chunkSize);
930     scanEnd = LargeIntegerAdd(scanStart, thyper);
931
932     flags = CM_SCACHESYNC_GETSTATUS
933         | CM_SCACHESYNC_STOREDATA
934         | CM_SCACHESYNC_BUFLOCKED
935         | CM_SCACHESYNC_NOWAIT;
936
937     /* start by looking backwards until scanStart */
938     /* hyper version of cm_data.buf_blockSize */
939     thyper = ConvertLongToLargeInteger(cm_data.buf_blockSize);
940     tbase = LargeIntegerSubtract(firstModOffset, thyper);
941     while(LargeIntegerGreaterThanOrEqualTo(tbase, scanStart)) {
942         /* see if we can find the buffer */
943         bufp = buf_Find(scp, &tbase);
944         if (!bufp) 
945             break;
946
947         /* try to lock it, and quit if we can't (simplifies locking) */
948         lock_ReleaseWrite(&scp->rw);
949         code = lock_TryMutex(&bufp->mx);
950         lock_ObtainWrite(&scp->rw);
951         if (code == 0) {
952             buf_Release(bufp);
953             bufp = NULL;
954             break;
955         }
956                 
957         code = cm_SyncOp(scp, bufp, userp, reqp, 0, flags);
958         if (code) {
959             lock_ReleaseMutex(&bufp->mx);
960             buf_Release(bufp);
961             bufp = NULL;
962             break;
963         }
964                 
965         if (!(bufp->flags & CM_BUF_DIRTY)) {
966             /* buffer is clean, so we shouldn't add it */
967             cm_SyncOpDone(scp, bufp, flags);
968             lock_ReleaseMutex(&bufp->mx);
969             buf_Release(bufp);
970             bufp = NULL;
971             break;
972         }
973
974         /* don't need buffer mutex any more */
975         lock_ReleaseMutex(&bufp->mx);
976
977         /* we have a dirty buffer ready for storing.  Add it to the tail
978          * of the list, since it immediately precedes all of the disk
979          * addresses we've already collected.
980          */
981         qdp = osi_QDAlloc();
982         osi_SetQData(qdp, bufp);
983         /* no buf_hold necessary, since we have it held from buf_Find */
984         osi_QAddT((osi_queue_t **) &biop->bufListp,
985                   (osi_queue_t **) &biop->bufListEndp,
986                   &qdp->q);
987         bufp = NULL;            /* added to the queue */
988
989         /* update biod info describing the transfer */
990         biop->offset = LargeIntegerSubtract(biop->offset, thyper);
991         biop->length += cm_data.buf_blockSize;
992
993         /* update loop pointer */
994         tbase = LargeIntegerSubtract(tbase, thyper);
995     }   /* while loop looking for pages preceding the one we found */
996
997     /* now, find later dirty, contiguous pages, and add them to the list */
998     /* hyper version of cm_data.buf_blockSize */
999     thyper = ConvertLongToLargeInteger(cm_data.buf_blockSize);
1000     tbase = LargeIntegerAdd(firstModOffset, thyper);
1001     while(LargeIntegerLessThan(tbase, scanEnd)) {
1002         /* see if we can find the buffer */
1003         bufp = buf_Find(scp, &tbase);
1004         if (!bufp) 
1005             break;
1006
1007         /* try to lock it, and quit if we can't (simplifies locking) */
1008         lock_ReleaseWrite(&scp->rw);
1009         code = lock_TryMutex(&bufp->mx);
1010         lock_ObtainWrite(&scp->rw);
1011         if (code == 0) {
1012             buf_Release(bufp);
1013             bufp = NULL;
1014             break;
1015         }
1016
1017         code = cm_SyncOp(scp, bufp, userp, reqp, 0, flags);
1018         if (code) {
1019             lock_ReleaseMutex(&bufp->mx);
1020             buf_Release(bufp);
1021             bufp = NULL;
1022             break;
1023         }
1024                 
1025         if (!(bufp->flags & CM_BUF_DIRTY)) {
1026             /* buffer is clean, so we shouldn't add it */
1027             cm_SyncOpDone(scp, bufp, flags);
1028             lock_ReleaseMutex(&bufp->mx);
1029             buf_Release(bufp);
1030             bufp = NULL;
1031             break;
1032         }
1033
1034         /* don't need buffer mutex any more */
1035         lock_ReleaseMutex(&bufp->mx);
1036
1037         /* we have a dirty buffer ready for storing.  Add it to the head
1038          * of the list, since it immediately follows all of the disk
1039          * addresses we've already collected.
1040          */
1041         qdp = osi_QDAlloc();
1042         osi_SetQData(qdp, bufp);
1043         /* no buf_hold necessary, since we have it held from buf_Find */
1044         osi_QAddH((osi_queue_t **) &biop->bufListp,
1045                   (osi_queue_t **) &biop->bufListEndp,
1046                   &qdp->q);
1047         bufp = NULL;
1048
1049         /* update biod info describing the transfer */
1050         biop->length += cm_data.buf_blockSize;
1051                 
1052         /* update loop pointer */
1053         tbase = LargeIntegerAdd(tbase, thyper);
1054     }   /* while loop looking for pages following the first page we found */
1055         
1056     /* finally, we're done */
1057     return 0;
1058 }
1059
1060 /* scp must be locked; temporarily unlocked during processing.
1061  * If returns 0, returns buffers held in biop, and with
1062  * CM_BUF_CMFETCHING flags set.
1063  * If an error is returned, we don't return any buffers.
1064  */
1065 long cm_SetupFetchBIOD(cm_scache_t *scp, osi_hyper_t *offsetp,
1066                         cm_bulkIO_t *biop, cm_user_t *userp, cm_req_t *reqp)
1067 {
1068     long code;
1069     cm_buf_t *tbp;
1070     osi_hyper_t tblocksize;             /* a long long temp variable */
1071     osi_hyper_t pageBase;               /* base offset we're looking at */
1072     osi_queueData_t *qdp;               /* one temp queue structure */
1073     osi_queueData_t *tqdp;              /* another temp queue structure */
1074     long collected;                     /* how many bytes have been collected */
1075     int isFirst;
1076     long flags;
1077     osi_hyper_t fileSize;               /* the # of bytes in the file */
1078     osi_queueData_t *heldBufListp;      /* we hold all buffers in this list */
1079     osi_queueData_t *heldBufListEndp;   /* first one */
1080     int reserving;
1081
1082     tblocksize = ConvertLongToLargeInteger(cm_data.buf_blockSize);
1083
1084     biop->scp = scp;                    /* do not hold; held by caller */
1085     biop->offset = *offsetp;
1086     /* null out the list of buffers */
1087     biop->bufListp = biop->bufListEndp = NULL;
1088     biop->reserved = 0;
1089
1090     /* first lookup the file's length, so we know when to stop */
1091     code = cm_SyncOp(scp, NULL, userp, reqp, 0, 
1092                      CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
1093     if (code) 
1094         return code;
1095         
1096     /* copy out size, since it may change */
1097     fileSize = scp->serverLength;
1098         
1099     lock_ReleaseWrite(&scp->rw);
1100
1101     pageBase = *offsetp;
1102     collected = pageBase.LowPart & (cm_chunkSize - 1);
1103     heldBufListp = NULL;
1104     heldBufListEndp = NULL;
1105
1106     /*
1107      * Obtaining buffers can cause dirty buffers to be recycled, which
1108      * can cause a storeback, so cannot be done while we have buffers
1109      * reserved.
1110      *
1111      * To get around this, we get buffers twice.  Before reserving buffers,
1112      * we obtain and release each one individually.  After reserving
1113      * buffers, we try to obtain them again, but only by lookup, not by
1114      * recycling.  If a buffer has gone away while we were waiting for
1115      * the others, we just use whatever buffers we already have.
1116      *
1117      * On entry to this function, we are already holding a buffer, so we
1118      * can't wait for reservation.  So we call buf_TryReserveBuffers()
1119      * instead.  Not only that, we can't really even call buf_Get(), for
1120      * the same reason.  We can't avoid that, though.  To avoid deadlock
1121      * we allow only one thread to be executing the buf_Get()-buf_Release()
1122      * sequence at a time.
1123      */
1124
1125     /* first hold all buffers, since we can't hold any locks in buf_Get */
1126     while (1) {
1127         /* stop at chunk boundary */
1128         if (collected >= cm_chunkSize) 
1129             break;
1130                 
1131         /* see if the next page would be past EOF */
1132         if (LargeIntegerGreaterThanOrEqualTo(pageBase, fileSize)) 
1133             break;
1134
1135         code = buf_Get(scp, &pageBase, reqp, &tbp);
1136         if (code) {
1137             lock_ObtainWrite(&scp->rw);
1138             cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
1139             return code;
1140         }
1141                 
1142         buf_Release(tbp);
1143         tbp = NULL;
1144
1145         pageBase = LargeIntegerAdd(tblocksize, pageBase);
1146         collected += cm_data.buf_blockSize;
1147     }
1148
1149     /* reserve a chunk's worth of buffers if possible */
1150     reserving = buf_TryReserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
1151
1152     pageBase = *offsetp;
1153     collected = pageBase.LowPart & (cm_chunkSize - 1);
1154
1155     /* now hold all buffers, if they are still there */
1156     while (1) {
1157         /* stop at chunk boundary */
1158         if (collected >= cm_chunkSize) 
1159             break;
1160                 
1161         /* see if the next page would be past EOF */
1162         if (LargeIntegerGreaterThanOrEqualTo(pageBase, fileSize)) 
1163             break;
1164
1165         tbp = buf_Find(scp, &pageBase);
1166         if (!tbp) 
1167             break;
1168
1169         /* add the buffer to the list */
1170         qdp = osi_QDAlloc();
1171         osi_SetQData(qdp, tbp);
1172         osi_QAddH((osi_queue_t **)&heldBufListp, 
1173                   (osi_queue_t **)&heldBufListEndp, 
1174                   &qdp->q);
1175         /* leave tbp held (from buf_Get) */
1176
1177         if (!reserving) 
1178             break;
1179
1180         collected += cm_data.buf_blockSize;
1181         pageBase = LargeIntegerAdd(tblocksize, pageBase);
1182     }
1183
1184     /* look at each buffer, adding it into the list if it looks idle and
1185      * filled with old data.  One special case: wait for idle if it is the
1186      * first buffer since we really need that one for our caller to make
1187      * any progress.
1188      */
1189     isFirst = 1;
1190     collected = 0;              /* now count how many we'll really use */
1191     for (tqdp = heldBufListEndp;
1192         tqdp;
1193           tqdp = (osi_queueData_t *) osi_QPrev(&tqdp->q)) {
1194         /* get a ptr to the held buffer */
1195         tbp = osi_GetQData(tqdp);
1196         pageBase = tbp->offset;
1197
1198         /* now lock the buffer lock */
1199         lock_ObtainMutex(&tbp->mx);
1200         lock_ObtainWrite(&scp->rw);
1201
1202         /* don't bother fetching over data that is already current */
1203         if (tbp->dataVersion <= scp->dataVersion && tbp->dataVersion >= scp->bufDataVersionLow) {
1204             /* we don't need this buffer, since it is current */
1205             lock_ReleaseWrite(&scp->rw);
1206             lock_ReleaseMutex(&tbp->mx);
1207             break;
1208         }
1209
1210         flags = CM_SCACHESYNC_FETCHDATA | CM_SCACHESYNC_BUFLOCKED;
1211         if (!isFirst) 
1212             flags |= CM_SCACHESYNC_NOWAIT;
1213
1214         /* wait for the buffer to serialize, if required.  Doesn't
1215          * release the scp or buffer lock(s) if NOWAIT is specified.
1216          */
1217         code = cm_SyncOp(scp, tbp, userp, reqp, 0, flags);
1218         if (code) {
1219             lock_ReleaseWrite(&scp->rw);
1220             lock_ReleaseMutex(&tbp->mx);
1221             break;
1222         }
1223                 
1224         /* don't fetch over dirty buffers */
1225         if (tbp->flags & CM_BUF_DIRTY) {
1226             cm_SyncOpDone(scp, tbp, flags);
1227             lock_ReleaseWrite(&scp->rw);
1228             lock_ReleaseMutex(&tbp->mx);
1229             break;
1230         }
1231
1232         /* Release locks */
1233         lock_ReleaseWrite(&scp->rw);
1234         lock_ReleaseMutex(&tbp->mx);
1235
1236         /* add the buffer to the list */
1237         qdp = osi_QDAlloc();
1238         osi_SetQData(qdp, tbp);
1239         osi_QAddH((osi_queue_t **)&biop->bufListp, 
1240                   (osi_queue_t **)&biop->bufListEndp, 
1241                   &qdp->q);
1242         buf_Hold(tbp);
1243
1244         /* from now on, a failure just stops our collection process, but
1245          * we still do the I/O to whatever we've already managed to collect.
1246          */
1247         isFirst = 0;
1248         collected += cm_data.buf_blockSize;
1249     }
1250         
1251     /* now, we've held in biop->bufListp all the buffer's we're really
1252      * interested in.  We also have holds left from heldBufListp, and we
1253      * now release those holds on the buffers.
1254      */
1255     for (qdp = heldBufListp; qdp; qdp = tqdp) {
1256         tqdp = (osi_queueData_t *) osi_QNext(&qdp->q);
1257         tbp = osi_GetQData(qdp);
1258         osi_QRemoveHT((osi_queue_t **) &heldBufListp,
1259                       (osi_queue_t **) &heldBufListEndp,
1260                       &qdp->q);
1261         osi_QDFree(qdp);
1262         buf_Release(tbp);
1263         tbp = NULL;
1264     }
1265
1266     /* Caller expects this */
1267     lock_ObtainWrite(&scp->rw);
1268  
1269     /* if we got a failure setting up the first buffer, then we don't have
1270      * any side effects yet, and we also have failed an operation that the
1271      * caller requires to make any progress.  Give up now.
1272      */
1273     if (code && isFirst) {
1274         buf_UnreserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
1275         return code;
1276     }
1277         
1278     /* otherwise, we're still OK, and should just return the I/O setup we've
1279      * got.
1280      */
1281     biop->length = collected;
1282     biop->reserved = reserving;
1283     return 0;
1284 }
1285
1286 /* release a bulk I/O structure that was setup by cm_SetupFetchBIOD or by
1287  * cm_SetupStoreBIOD
1288  */
1289 void cm_ReleaseBIOD(cm_bulkIO_t *biop, int isStore, long code, int scp_locked)
1290 {
1291     cm_scache_t *scp;           /* do not release; not held in biop */
1292     cm_buf_t *bufp;
1293     osi_queueData_t *qdp;
1294     osi_queueData_t *nqdp;
1295     int flags;
1296
1297     /* Give back reserved buffers */
1298     if (biop->reserved)
1299         buf_UnreserveBuffers(cm_chunkSize / cm_data.buf_blockSize);
1300         
1301     if (isStore)
1302         flags = CM_SCACHESYNC_STOREDATA;
1303     else
1304         flags = CM_SCACHESYNC_FETCHDATA;
1305
1306     scp = biop->scp;
1307     if (biop->bufListp) {
1308         for(qdp = biop->bufListp; qdp; qdp = nqdp) {
1309             /* lookup next guy first, since we're going to free this one */
1310             nqdp = (osi_queueData_t *) osi_QNext(&qdp->q);
1311                 
1312             /* extract buffer and free queue data */
1313             bufp = osi_GetQData(qdp);
1314             osi_QRemoveHT((osi_queue_t **) &biop->bufListp,
1315                            (osi_queue_t **) &biop->bufListEndp,
1316                            &qdp->q);
1317             osi_QDFree(qdp);
1318
1319             /* now, mark I/O as done, unlock the buffer and release it */
1320             if (scp_locked)
1321                 lock_ReleaseWrite(&scp->rw);
1322             lock_ObtainMutex(&bufp->mx);
1323             lock_ObtainWrite(&scp->rw);
1324             cm_SyncOpDone(scp, bufp, flags);
1325                 
1326             /* turn off writing and wakeup users */
1327             if (isStore) {
1328                 if (bufp->flags & CM_BUF_WAITING) {
1329                     osi_Log2(afsd_logp, "cm_ReleaseBIOD Waking [scp 0x%p] bp 0x%p", scp, bufp);
1330                     osi_Wakeup((LONG_PTR) bufp);
1331                 }
1332                 if (code) {
1333                     bufp->flags &= ~CM_BUF_WRITING;
1334                     switch (code) {
1335                     case CM_ERROR_NOSUCHFILE:
1336                     case CM_ERROR_BADFD:
1337                     case CM_ERROR_NOACCESS:
1338                     case CM_ERROR_QUOTA:
1339                     case CM_ERROR_SPACE:
1340                     case CM_ERROR_TOOBIG:
1341                     case CM_ERROR_READONLY:
1342                     case CM_ERROR_NOSUCHPATH:
1343                         /*
1344                          * Apply the fatal error to this buffer.
1345                          */
1346                         bufp->flags &= ~CM_BUF_DIRTY;
1347                         bufp->flags |= CM_BUF_ERROR;
1348                         bufp->dirty_offset = 0;
1349                         bufp->dirty_length = 0;
1350                         bufp->error = code;
1351                         bufp->dataVersion = CM_BUF_VERSION_BAD;
1352                         bufp->dirtyCounter++;
1353                         break;
1354                     case CM_ERROR_TIMEDOUT:
1355                     case CM_ERROR_ALLDOWN:
1356                     case CM_ERROR_ALLBUSY:
1357                     case CM_ERROR_ALLOFFLINE:
1358                     case CM_ERROR_CLOCKSKEW:
1359                     default:
1360                         /* do not mark the buffer in error state but do
1361                         * not attempt to complete the rest either.
1362                         */
1363                         break;
1364                     }
1365                 } else {
1366                     bufp->flags &= ~(CM_BUF_WRITING | CM_BUF_DIRTY);
1367                     bufp->dirty_offset = bufp->dirty_length = 0;
1368                 }
1369             }
1370
1371             if (!scp_locked)
1372                 lock_ReleaseWrite(&scp->rw);
1373             lock_ReleaseMutex(&bufp->mx);
1374             buf_Release(bufp);
1375             bufp = NULL;
1376         }
1377     } else {
1378         if (!scp_locked)
1379             lock_ObtainWrite(&scp->rw);
1380         cm_SyncOpDone(scp, NULL, flags);
1381         if (!scp_locked)
1382             lock_ReleaseWrite(&scp->rw);
1383     }
1384
1385     /* clean things out */
1386     biop->bufListp = NULL;
1387     biop->bufListEndp = NULL;
1388 }   
1389
1390 static int
1391 cm_CloneStatus(cm_scache_t *scp, cm_user_t *userp, int scp_locked,
1392                AFSFetchStatus *afsStatusp, AFSVolSync *volSyncp)
1393 {
1394     // setup the status based upon the scp data
1395     afsStatusp->InterfaceVersion = 0x1;
1396     switch (scp->fileType) {
1397     case CM_SCACHETYPE_FILE:
1398         afsStatusp->FileType = File;
1399         break;
1400     case CM_SCACHETYPE_DIRECTORY:
1401         afsStatusp->FileType = Directory;
1402         break;
1403     case CM_SCACHETYPE_MOUNTPOINT:
1404         afsStatusp->FileType = SymbolicLink;
1405         break;
1406     case CM_SCACHETYPE_SYMLINK:
1407     case CM_SCACHETYPE_DFSLINK:
1408         afsStatusp->FileType = SymbolicLink;
1409         break;
1410     default:
1411         afsStatusp->FileType = -1;    /* an invalid value */
1412     }
1413     afsStatusp->LinkCount = scp->linkCount;
1414     afsStatusp->Length = scp->length.LowPart;
1415     afsStatusp->DataVersion = (afs_uint32)(scp->dataVersion & MAX_AFS_UINT32);
1416     afsStatusp->Author = 0x1;
1417     afsStatusp->Owner = scp->owner;
1418     if (!scp_locked) {
1419         lock_ObtainWrite(&scp->rw);
1420         scp_locked = 1;
1421     }
1422     if (cm_FindACLCache(scp, userp, &afsStatusp->CallerAccess))
1423         afsStatusp->CallerAccess = scp->anyAccess;
1424     afsStatusp->AnonymousAccess = scp->anyAccess;
1425     afsStatusp->UnixModeBits = scp->unixModeBits;
1426     afsStatusp->ParentVnode = scp->parentVnode;
1427     afsStatusp->ParentUnique = scp->parentUnique;
1428     afsStatusp->ResidencyMask = 0;
1429     afsStatusp->ClientModTime = scp->clientModTime;
1430     afsStatusp->ServerModTime = scp->serverModTime;
1431     afsStatusp->Group = scp->group;
1432     afsStatusp->SyncCounter = 0;
1433     afsStatusp->dataVersionHigh = (afs_uint32)(scp->dataVersion >> 32);
1434     afsStatusp->lockCount = 0;
1435     afsStatusp->Length_hi = scp->length.HighPart;
1436     afsStatusp->errorCode = 0;
1437
1438     volSyncp->spare1 = scp->volumeCreationDate;
1439
1440     return scp_locked;
1441 }
1442
1443 /* Fetch a buffer.  Called with scp locked.
1444  * The scp is locked on return.
1445  */
1446 long cm_GetBuffer(cm_scache_t *scp, cm_buf_t *bufp, int *cpffp, cm_user_t *userp,
1447                   cm_req_t *reqp)
1448 {
1449     long code=0, code1=0;
1450     afs_uint32 nbytes;                  /* bytes in transfer */
1451     afs_uint32 nbytes_hi = 0;            /* high-order 32 bits of bytes in transfer */
1452     afs_uint64 length_found = 0;
1453     long rbytes;                        /* bytes in rx_Read call */
1454     long temp;
1455     AFSFetchStatus afsStatus;
1456     AFSCallBack callback;
1457     AFSVolSync volSync;
1458     char *bufferp;
1459     cm_buf_t *tbufp;                    /* buf we're filling */
1460     osi_queueData_t *qdp;               /* q element we're scanning */
1461     AFSFid tfid;
1462     struct rx_call *rxcallp;
1463     struct rx_connection *rxconnp;
1464     cm_bulkIO_t biod;           /* bulk IO descriptor */
1465     cm_conn_t *connp;
1466     int getroot;
1467     afs_int32 t1,t2;
1468     int require_64bit_ops = 0;
1469     int call_was_64bit = 0;
1470     int fs_fetchdata_offset_bug = 0;
1471     int first_read = 1;
1472     int scp_locked = 1;
1473
1474     memset(&volSync, 0, sizeof(volSync));
1475
1476     /* now, the buffer may or may not be filled with good data (buf_GetNew
1477      * drops lots of locks, and may indeed return a properly initialized
1478      * buffer, although more likely it will just return a new, empty, buffer.
1479      */
1480
1481 #ifdef AFS_FREELANCE_CLIENT
1482
1483     // yj: if they're trying to get the /afs directory, we need to
1484     // handle it differently, since it's local rather than on any
1485     // server
1486
1487     getroot = (scp==cm_data.rootSCachep);
1488     if (getroot)
1489         osi_Log1(afsd_logp,"GetBuffer returns cm_data.rootSCachep=%x",cm_data.rootSCachep);
1490 #endif
1491
1492     if (cm_HaveCallback(scp) && bufp->dataVersion <= scp->dataVersion && bufp->dataVersion >= scp->bufDataVersionLow) {
1493         /* We already have this buffer don't do extra work */
1494         return 0;
1495     }
1496
1497     cm_AFSFidFromFid(&tfid, &scp->fid);
1498
1499     code = cm_SetupFetchBIOD(scp, &bufp->offset, &biod, userp, reqp);
1500     if (code) {
1501         /* couldn't even get the first page setup properly */
1502         osi_Log1(afsd_logp, "GetBuffer: SetupFetchBIOD failure code %d", code);
1503         return code;
1504     }
1505
1506     /* once we get here, we have the callback in place, we know that no one
1507      * is fetching the data now.  Check one last time that we still have
1508      * the wrong data, and then fetch it if we're still wrong.
1509      *
1510      * We can lose a race condition and end up with biod.length zero, in
1511      * which case we just retry.
1512      */
1513     if (bufp->dataVersion <= scp->dataVersion && bufp->dataVersion >= scp->bufDataVersionLow || biod.length == 0) {
1514         if ((bufp->dataVersion == CM_BUF_VERSION_BAD || bufp->dataVersion < scp->bufDataVersionLow) && 
1515              LargeIntegerGreaterThanOrEqualTo(bufp->offset, scp->serverLength)) 
1516         {
1517             osi_Log4(afsd_logp, "Bad DVs 0x%x != (0x%x -> 0x%x) or length 0x%x",
1518                      bufp->dataVersion, scp->bufDataVersionLow, scp->dataVersion, biod.length);
1519
1520             if (bufp->dataVersion == CM_BUF_VERSION_BAD)
1521                 memset(bufp->datap, 0, cm_data.buf_blockSize);
1522             bufp->dataVersion = scp->dataVersion;
1523         }
1524         cm_ReleaseBIOD(&biod, 0, 0, 1);
1525         return 0;
1526     } else if ((bufp->dataVersion == CM_BUF_VERSION_BAD || bufp->dataVersion < scp->bufDataVersionLow)
1527                 && (scp->mask & CM_SCACHEMASK_TRUNCPOS) &&
1528                 LargeIntegerGreaterThanOrEqualTo(bufp->offset, scp->truncPos)) {
1529         memset(bufp->datap, 0, cm_data.buf_blockSize);
1530         bufp->dataVersion = scp->dataVersion;
1531         cm_ReleaseBIOD(&biod, 0, 0, 1);
1532         return 0;
1533     }
1534
1535     lock_ReleaseWrite(&scp->rw);
1536     scp_locked = 0;
1537
1538     if (LargeIntegerGreaterThan(LargeIntegerAdd(biod.offset,
1539                                                 ConvertLongToLargeInteger(biod.length)),
1540                                 ConvertLongToLargeInteger(LONG_MAX))) {
1541         require_64bit_ops = 1;
1542     }
1543
1544     osi_Log2(afsd_logp, "cm_GetBuffer: fetching data scp %p bufp %p", scp, bufp);
1545     osi_Log3(afsd_logp, "cm_GetBuffer: fetching data scpDV 0x%x scpDVLow 0x%x bufDV 0x%x",
1546              scp->dataVersion, scp->bufDataVersionLow, bufp->dataVersion);
1547
1548 #ifdef AFS_FREELANCE_CLIENT
1549
1550     // yj code
1551     // if getroot then we don't need to make any calls
1552     // just return fake data
1553         
1554     if (cm_freelanceEnabled && getroot) {
1555         // setup the fake status                        
1556         afsStatus.InterfaceVersion = 0x1;
1557         afsStatus.FileType = 0x2;
1558         afsStatus.LinkCount = scp->linkCount;
1559         afsStatus.Length = cm_fakeDirSize;
1560         afsStatus.DataVersion = (afs_uint32)(cm_data.fakeDirVersion & 0xFFFFFFFF);
1561         afsStatus.Author = 0x1;
1562         afsStatus.Owner = 0x0;
1563         afsStatus.CallerAccess = 0x9;
1564         afsStatus.AnonymousAccess = 0x9;
1565         afsStatus.UnixModeBits = 0x1ff;
1566         afsStatus.ParentVnode = 0x1;
1567         afsStatus.ParentUnique = 0x1;
1568         afsStatus.ResidencyMask = 0;
1569         afsStatus.ClientModTime = (afs_uint32)FakeFreelanceModTime;
1570         afsStatus.ServerModTime = (afs_uint32)FakeFreelanceModTime;
1571         afsStatus.Group = 0;
1572         afsStatus.SyncCounter = 0;
1573         afsStatus.dataVersionHigh = (afs_uint32)(cm_data.fakeDirVersion >> 32);
1574         afsStatus.lockCount = 0;
1575         afsStatus.Length_hi = 0;
1576         afsStatus.errorCode = 0;
1577         memset(&volSync, 0, sizeof(volSync));
1578
1579         // once we're done setting up the status info,
1580         // we just fill the buffer pages with fakedata
1581         // from cm_FakeRootDir. Extra pages are set to
1582         // 0. 
1583                 
1584         lock_ObtainMutex(&cm_Freelance_Lock);
1585         t1 = bufp->offset.LowPart;
1586         qdp = biod.bufListEndp;
1587         while (qdp) {
1588             tbufp = osi_GetQData(qdp);
1589             bufferp=tbufp->datap;
1590             memset(bufferp, 0, cm_data.buf_blockSize);
1591             t2 = cm_fakeDirSize - t1;
1592             if (t2> (afs_int32)cm_data.buf_blockSize) 
1593                 t2=cm_data.buf_blockSize;
1594             if (t2 > 0) {
1595                 memcpy(bufferp, cm_FakeRootDir+t1, t2);
1596             } else {
1597                 t2 = 0;
1598             }
1599             t1+=t2;
1600             qdp = (osi_queueData_t *) osi_QPrev(&qdp->q);
1601
1602         }
1603         lock_ReleaseMutex(&cm_Freelance_Lock);
1604         
1605         // once we're done, we skip over the part of the
1606         // code that does the ACTUAL fetching of data for
1607         // real files
1608
1609         goto fetchingcompleted;
1610     }
1611
1612 #endif /* AFS_FREELANCE_CLIENT */
1613
1614     /*
1615      * if the requested offset is greater than the file length,
1616      * the file server will return zero bytes of data and the
1617      * current status for the file which we already have since
1618      * we have just obtained a callback.  Instead, we can avoid
1619      * the network round trip by allocating zeroed buffers and
1620      * faking the status info.
1621      */
1622     if (biod.offset.QuadPart >= scp->length.QuadPart) {
1623         osi_Log5(afsd_logp, "SKIP FetchData64 scp 0x%p, off 0x%x:%08x > length 0x%x:%08x",
1624                  scp, biod.offset.HighPart, biod.offset.LowPart,
1625                  scp->length.HighPart, scp->length.LowPart);
1626
1627         /* Clone the current status info */
1628         scp_locked = cm_CloneStatus(scp, userp, scp_locked, &afsStatus, &volSync);
1629
1630         /* status info complete, fill pages with zeros */
1631         for (qdp = biod.bufListEndp;
1632              qdp;
1633              qdp = (osi_queueData_t *) osi_QPrev(&qdp->q)) {
1634             tbufp = osi_GetQData(qdp);
1635             bufferp=tbufp->datap;
1636             memset(bufferp, 0, cm_data.buf_blockSize);
1637         }
1638
1639         /* no need to contact the file server */
1640         goto fetchingcompleted;
1641     }
1642
1643     if (scp_locked) {
1644         lock_ReleaseWrite(&scp->rw);
1645         scp_locked = 0;
1646     }
1647
1648     /* now make the call */
1649     do {
1650         code = cm_ConnFromFID(&scp->fid, userp, reqp, &connp);
1651         if (code) 
1652             continue;
1653
1654         rxconnp = cm_GetRxConn(connp);
1655         rxcallp = rx_NewCall(rxconnp);
1656         rx_PutConnection(rxconnp);
1657
1658 #ifdef AFS_LARGEFILES
1659         nbytes = nbytes_hi = 0;
1660
1661         if (SERVERHAS64BIT(connp)) {
1662             call_was_64bit = 1;
1663
1664             osi_Log4(afsd_logp, "CALL FetchData64 scp 0x%p, off 0x%x:%08x, size 0x%x",
1665                      scp, biod.offset.HighPart, biod.offset.LowPart, biod.length);
1666
1667             code = StartRXAFS_FetchData64(rxcallp, &tfid, biod.offset.QuadPart, biod.length);
1668
1669             if (code == 0) {
1670                 temp = rx_Read32(rxcallp, &nbytes_hi);
1671                 if (temp == sizeof(afs_int32)) {
1672                     nbytes_hi = ntohl(nbytes_hi);
1673                 } else {
1674                     nbytes_hi = 0;
1675                     code = rxcallp->error;
1676                     code1 = rx_EndCall(rxcallp, code);
1677                     rxcallp = NULL;
1678                 }
1679             }
1680         } else {
1681             call_was_64bit = 0;
1682         }
1683
1684         if (code == RXGEN_OPCODE || !SERVERHAS64BIT(connp)) {
1685             if (require_64bit_ops) {
1686                 osi_Log0(afsd_logp, "Skipping FetchData.  Operation requires FetchData64");
1687                 code = CM_ERROR_TOOBIG;
1688             } else {
1689                 if (!rxcallp) {
1690                     rxconnp = cm_GetRxConn(connp);
1691                     rxcallp = rx_NewCall(rxconnp);
1692                     rx_PutConnection(rxconnp);
1693                 }
1694
1695                 osi_Log3(afsd_logp, "CALL FetchData scp 0x%p, off 0x%x, size 0x%x",
1696                          scp, biod.offset.LowPart, biod.length);
1697
1698                 code = StartRXAFS_FetchData(rxcallp, &tfid, biod.offset.LowPart,
1699                                             biod.length);
1700
1701                 SET_SERVERHASNO64BIT(connp);
1702             }
1703         }
1704
1705         if (code == 0) {
1706             temp  = rx_Read32(rxcallp, &nbytes);
1707             if (temp == sizeof(afs_int32)) {
1708                 nbytes = ntohl(nbytes);
1709                 FillInt64(length_found, nbytes_hi, nbytes);
1710                 if (length_found > biod.length) {
1711                     /*
1712                      * prior to 1.4.12 and 1.5.65 the file server would return
1713                      * (filesize - offset) if the requested offset was greater than
1714                      * the filesize.  The correct return value would have been zero.
1715                      * Force a retry by returning an RX_PROTOCOL_ERROR.  If the cause
1716                      * is a race between two RPCs issues by this cache manager, the
1717                      * correct thing will happen the second time.
1718                      */
1719                     osi_Log0(afsd_logp, "cm_GetBuffer length_found > biod.length");
1720                     fs_fetchdata_offset_bug = 1;
1721                 }
1722             } else {
1723                 osi_Log1(afsd_logp, "cm_GetBuffer rx_Read32 returns %d != 4", temp);
1724                 code = (rxcallp->error < 0) ? rxcallp->error : RX_PROTOCOL_ERROR;
1725             }
1726         }
1727         /* for the moment, nbytes_hi will always be 0 if code == 0
1728            because biod.length is a 32-bit quantity. */
1729 #else
1730         osi_Log3(afsd_logp, "CALL FetchData scp 0x%p, off 0x%x, size 0x%x",
1731                  scp, biod.offset.LowPart, biod.length);
1732
1733         code = StartRXAFS_FetchData(rxcallp, &tfid, biod.offset.LowPart,
1734                                     biod.length);
1735
1736         /* now copy the data out of the pipe and put it in the buffer */
1737         if (code == 0) {
1738             temp  = rx_Read32(rxcallp, &nbytes);
1739             if (temp == sizeof(afs_int32)) {
1740                 length_found = ntohl(nbytes);
1741                 if (length_found > biod.length) {
1742                     /*
1743                      * prior to 1.4.12 and 1.5.65 the file server would return
1744                      * (filesize - offset) if the requested offset was greater than
1745                      * the filesize.  The correct return value would have been zero.
1746                      * Force a retry by returning an RX_PROTOCOL_ERROR.  If the cause
1747                      * is a race between two RPCs issues by this cache manager, the
1748                      * correct thing will happen the second time.
1749                      */
1750                     osi_Log0(afsd_logp, "cm_GetBuffer length_found > biod.length");
1751                     fs_fetchdata_offset_bug = 1;
1752                 }
1753             }
1754             else {
1755                 osi_Log1(afsd_logp, "cm_GetBuffer rx_Read32 returns %d != 4", temp);
1756                 code = (rxcallp->error < 0) ? rxcallp->error : RX_PROTOCOL_ERROR;
1757             }
1758         }
1759 #endif
1760
1761         if (code == 0) {
1762             qdp = biod.bufListEndp;
1763             if (qdp) {
1764                 tbufp = osi_GetQData(qdp);
1765                 bufferp = tbufp->datap;
1766             }
1767             else 
1768                 bufferp = NULL;
1769             /* fill length_found of data from the pipe into the pages.
1770              * When we stop, qdp will point at the last page we're
1771              * dealing with, and bufferp will tell us where we
1772              * stopped.  We'll need this info below when we clear
1773              * the remainder of the last page out (and potentially
1774              * clear later pages out, if we fetch past EOF).
1775              */
1776             while (length_found > 0) {
1777                 /* assert that there are still more buffers;
1778                  * our check above for length_found being less than
1779                  * biod.length should ensure this.
1780                  */
1781                 osi_assertx(bufferp != NULL, "null cm_buf_t");
1782
1783                 /* read rbytes of data */
1784                 rbytes = (afs_uint32)(length_found > cm_data.buf_blockSize ? cm_data.buf_blockSize : length_found);
1785                 temp = rx_Read(rxcallp, bufferp, rbytes);
1786                 if (temp < rbytes) {
1787                     /*
1788                      * If the file server returned (filesize - offset),
1789                      * then the first rx_Read will return zero octets of data.
1790                      * If it does, do not treat it as an error.  Correct the
1791                      * length_found and continue as if the file server said
1792                      * it was sending us zero octets of data.
1793                      */
1794                     if (fs_fetchdata_offset_bug && first_read)
1795                         length_found = 0;
1796                     else
1797                         code = (rxcallp->error < 0) ? rxcallp->error : RX_PROTOCOL_ERROR;
1798                     break;
1799                 }
1800                 first_read = 0;
1801
1802                 /* allow read-while-fetching.
1803                  * if this is the last buffer, clear the
1804                  * PREFETCHING flag, so the reader waiting for
1805                  * this buffer will start a prefetch.
1806                  */
1807                 tbufp->cmFlags |= CM_BUF_CMFULLYFETCHED;
1808                 lock_ObtainWrite(&scp->rw);
1809                 if (scp->flags & CM_SCACHEFLAG_WAITING) {
1810                     osi_Log1(afsd_logp, "CM GetBuffer Waking scp 0x%p", scp);
1811                     osi_Wakeup((LONG_PTR) &scp->flags);
1812                 }
1813                 if (cpffp && !*cpffp && !osi_QPrev(&qdp->q)) {
1814                     osi_hyper_t tlength = ConvertLongToLargeInteger(biod.length);
1815                     *cpffp = 1;
1816                     cm_ClearPrefetchFlag(0, scp, &biod.offset, &tlength);
1817                 }
1818                 lock_ReleaseWrite(&scp->rw);
1819
1820                 /* and adjust counters */
1821                 length_found -= temp;
1822
1823                 /* and move to the next buffer */
1824                 if (length_found != 0) {
1825                     qdp = (osi_queueData_t *) osi_QPrev(&qdp->q);
1826                     if (qdp) {
1827                         tbufp = osi_GetQData(qdp);
1828                         bufferp = tbufp->datap;
1829                     }
1830                     else 
1831                         bufferp = NULL;
1832                 } else 
1833                     bufferp += temp;
1834             }
1835
1836             /* zero out remainder of last pages, in case we are
1837              * fetching past EOF.  We were fetching an integral #
1838              * of pages, but stopped, potentially in the middle of
1839              * a page.  Zero the remainder of that page, and then
1840              * all of the rest of the pages.
1841              */
1842             /* bytes fetched */
1843             osi_assertx((bufferp - tbufp->datap) < LONG_MAX, "data >= LONG_MAX");
1844             rbytes = (long) (bufferp - tbufp->datap);
1845
1846             /* bytes left to zero */
1847             rbytes = cm_data.buf_blockSize - rbytes;
1848             while(qdp) {
1849                 if (rbytes != 0)
1850                     memset(bufferp, 0, rbytes);
1851                 qdp = (osi_queueData_t *) osi_QPrev(&qdp->q);
1852                 if (qdp == NULL) 
1853                     break;
1854                 tbufp = osi_GetQData(qdp);
1855                 bufferp = tbufp->datap;
1856                 /* bytes to clear in this page */
1857                 rbytes = cm_data.buf_blockSize;
1858             }   
1859         }
1860
1861         if (code == 0) {
1862             if (call_was_64bit)
1863                 code = EndRXAFS_FetchData64(rxcallp, &afsStatus, &callback, &volSync);
1864             else
1865                 code = EndRXAFS_FetchData(rxcallp, &afsStatus, &callback, &volSync);
1866         } else {
1867             if (call_was_64bit)
1868                 osi_Log1(afsd_logp, "CALL EndRXAFS_FetchData64 skipped due to error %d", code);
1869             else
1870                 osi_Log1(afsd_logp, "CALL EndRXAFS_FetchData skipped due to error %d", code);
1871         }
1872
1873         if (rxcallp)
1874             code1 = rx_EndCall(rxcallp, code);
1875
1876         if (code1 == RXKADUNKNOWNKEY)
1877             osi_Log0(afsd_logp, "CALL EndCall returns RXKADUNKNOWNKEY");
1878
1879         /* If we are avoiding a file server bug, ignore the error state */
1880         if (fs_fetchdata_offset_bug && first_read && length_found == 0 && code == -451) {
1881             /* Clone the current status info and clear the error state */
1882             scp_locked = cm_CloneStatus(scp, userp, scp_locked, &afsStatus, &volSync);
1883             if (scp_locked) {
1884                 lock_ReleaseWrite(&scp->rw);
1885                 scp_locked = 0;
1886             }
1887             code = 0;
1888         /* Prefer the error value from FetchData over rx_EndCall */
1889         } else if (code == 0 && code1 != 0)
1890             code = code1;
1891         osi_Log0(afsd_logp, "CALL FetchData DONE");
1892
1893     } while (cm_Analyze(connp, userp, reqp, &scp->fid, &volSync, NULL, NULL, code));
1894
1895   fetchingcompleted:
1896     code = cm_MapRPCError(code, reqp);
1897
1898     if (!scp_locked)
1899         lock_ObtainWrite(&scp->rw);
1900     
1901     /* we know that no one else has changed the buffer, since we still have
1902      * the fetching flag on the buffers, and we have the scp locked again.
1903      * Copy in the version # into the buffer if we got code 0 back from the
1904      * read.
1905      */
1906     if (code == 0) {
1907         for(qdp = biod.bufListp;
1908              qdp;
1909              qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1910             tbufp = osi_GetQData(qdp);
1911             tbufp->dataVersion = afsStatus.dataVersionHigh;
1912             tbufp->dataVersion <<= 32;
1913             tbufp->dataVersion |= afsStatus.DataVersion;
1914
1915 #ifdef DISKCACHE95
1916             /* write buffer out to disk cache */
1917             diskcache_Update(tbufp->dcp, tbufp->datap, cm_data.buf_blockSize,
1918                               tbufp->dataVersion);
1919 #endif /* DISKCACHE95 */
1920         }
1921     }
1922
1923     /* release scatter/gather I/O structure (buffers, locks) */
1924     cm_ReleaseBIOD(&biod, 0, code, 1);
1925
1926     if (code == 0) 
1927         cm_MergeStatus(NULL, scp, &afsStatus, &volSync, userp, reqp, 0);
1928     
1929     return code;
1930 }