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