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