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