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