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