e688ea2f35e83da09e7d251f20163bb3ac629ee5
[openafs.git] / src / WINNT / afsd / cm_scache.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #include <afs/param.h>
11 #include <afs/stds.h>
12
13 #include <windows.h>
14 #include <winsock2.h>
15 #include <nb30.h>
16 #include <malloc.h>
17 #include <string.h>
18 #include <stdlib.h>
19 #include <osi.h>
20
21 #include "afsd.h"
22 #include "cm_btree.h"
23
24 /*extern void afsi_log(char *pattern, ...);*/
25
26 extern osi_hyper_t hzero;
27
28 /* File locks */
29 osi_queue_t *cm_allFileLocks;
30 osi_queue_t *cm_freeFileLocks;
31 unsigned long cm_lockRefreshCycle;
32
33 /* lock for globals */
34 osi_rwlock_t cm_scacheLock;
35
36 /* Dummy scache entry for use with pioctl fids */
37 cm_scache_t cm_fakeSCache;
38
39 osi_queue_t * cm_allFreeWaiters;        /* protected by cm_scacheLock */
40
41 #ifdef AFS_FREELANCE_CLIENT
42 extern osi_mutex_t cm_Freelance_Lock;
43 #endif
44
45 /* must be called with cm_scacheLock write-locked! */
46 void cm_AdjustScacheLRU(cm_scache_t *scp)
47 {
48     if (scp == cm_data.scacheLRULastp)
49         cm_data.scacheLRULastp = (cm_scache_t *) osi_QPrev(&scp->q);
50     osi_QRemoveHT((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **) &cm_data.scacheLRULastp, &scp->q);
51     osi_QAdd((osi_queue_t **) &cm_data.scacheLRUFirstp, &scp->q);
52     if (!cm_data.scacheLRULastp) 
53         cm_data.scacheLRULastp = scp;
54 }
55
56 /* call with scache write-locked and mutex held */
57 void cm_RemoveSCacheFromHashTable(cm_scache_t *scp)
58 {
59     cm_scache_t **lscpp;
60     cm_scache_t *tscp;
61     int i;
62         
63     if (scp->flags & CM_SCACHEFLAG_INHASH) {
64         /* hash it out first */
65         i = CM_SCACHE_HASH(&scp->fid);
66         for (lscpp = &cm_data.scacheHashTablep[i], tscp = cm_data.scacheHashTablep[i];
67              tscp;
68              lscpp = &tscp->nextp, tscp = tscp->nextp) {
69             if (tscp == scp) {
70                 *lscpp = scp->nextp;
71                 scp->flags &= ~CM_SCACHEFLAG_INHASH;
72                 break;
73             }
74         }
75     }
76 }
77
78 /* called with cm_scacheLock write-locked; recycles an existing scp. 
79  *
80  * this function ignores all of the locking hierarchy.  
81  */
82 long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags)
83 {
84     if (scp->refCount != 0) {
85         return -1;
86     }
87
88     if (scp->flags & CM_SCACHEFLAG_SMB_FID) {
89         osi_Log1(afsd_logp,"cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected scp 0x%p", scp);
90 #ifdef DEBUG
91         osi_panic("cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected",__FILE__,__LINE__);
92 #endif
93         return -1;
94     }
95
96     cm_RemoveSCacheFromHashTable(scp);
97
98 #if 0
99     if (flags & CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS) {
100         osi_queueData_t *qdp;
101         cm_buf_t *bufp;
102
103         while(qdp = scp->bufWritesp) {
104             bufp = osi_GetQData(qdp);
105             osi_QRemove((osi_queue_t **) &scp->bufWritesp, &qdp->q);
106             osi_QDFree(qdp);
107             if (bufp) {
108                 lock_ObtainMutex(&bufp->mx);
109                 bufp->cmFlags &= ~CM_BUF_CMSTORING;
110                 bufp->flags &= ~CM_BUF_DIRTY;
111                 bufp->dirty_offset = 0;
112                 bufp->dirty_length = 0;
113                 bufp->flags |= CM_BUF_ERROR;
114                 bufp->error = VNOVNODE;
115                 bufp->dataVersion = -1; /* bad */
116                 bufp->dirtyCounter++;
117                 if (bufp->flags & CM_BUF_WAITING) {
118                     osi_Log2(afsd_logp, "CM RecycleSCache Waking [scp 0x%x] bufp 0x%x", scp, bufp);
119                     osi_Wakeup((long) &bufp);
120                 }
121                 lock_ReleaseMutex(&bufp->mx);
122                 buf_Release(bufp);
123             }
124         }
125         while(qdp = scp->bufReadsp) {
126             bufp = osi_GetQData(qdp);
127             osi_QRemove((osi_queue_t **) &scp->bufReadsp, &qdp->q);
128             osi_QDFree(qdp);
129             if (bufp) {
130                 lock_ObtainMutex(&bufp->mx);
131                 bufp->cmFlags &= ~CM_BUF_CMFETCHING;
132                 bufp->flags &= ~CM_BUF_DIRTY;
133                 bufp->dirty_offset = 0;
134                 bufp->dirty_length = 0;
135                 bufp->flags |= CM_BUF_ERROR;
136                 bufp->error = VNOVNODE;
137                 bufp->dataVersion = -1; /* bad */
138                 bufp->dirtyCounter++;
139                 if (bufp->flags & CM_BUF_WAITING) {
140                     osi_Log2(afsd_logp, "CM RecycleSCache Waking [scp 0x%x] bufp 0x%x", scp, bufp);
141                     osi_Wakeup((long) &bufp);
142                 }
143                 lock_ReleaseMutex(&bufp->mx);
144                 buf_Release(bufp);
145             }
146         }
147         buf_CleanDirtyBuffers(scp); 
148     } else {
149         /* look for things that shouldn't still be set */
150         osi_assertx(scp->bufWritesp == NULL, "non-null cm_scache_t bufWritesp");
151         osi_assertx(scp->bufReadsp == NULL, "non-null cm_scache_t bufReadsp");
152     }
153 #endif
154
155     /* invalidate so next merge works fine;
156      * also initialize some flags */
157     scp->fileType = 0;
158     scp->flags &= ~(CM_SCACHEFLAG_STATD
159                      | CM_SCACHEFLAG_DELETED
160                      | CM_SCACHEFLAG_RO
161                      | CM_SCACHEFLAG_PURERO
162                      | CM_SCACHEFLAG_OVERQUOTA
163                      | CM_SCACHEFLAG_OUTOFSPACE
164                      | CM_SCACHEFLAG_EACCESS);
165     scp->serverModTime = 0;
166     scp->dataVersion = 0;
167     scp->bufDataVersionLow = 0;
168     scp->bulkStatProgress = hzero;
169     scp->waitCount = 0;
170     scp->waitQueueT = NULL;
171
172     if (scp->cbServerp) {
173         cm_PutServer(scp->cbServerp);
174         scp->cbServerp = NULL;
175     }
176     scp->cbExpires = 0;
177
178     scp->fid.vnode = 0;
179     scp->fid.volume = 0;
180     scp->fid.unique = 0;
181     scp->fid.cell = 0;
182     scp->fid.hash = 0;
183
184     /* remove from dnlc */
185     cm_dnlcPurgedp(scp);
186     cm_dnlcPurgevp(scp);
187
188     /* discard cached status; if non-zero, Close
189      * tried to store this to server but failed */
190     scp->mask = 0;
191
192     /* drop held volume ref */
193     if (scp->volp) {
194         cm_PutVolume(scp->volp);
195         scp->volp = NULL;
196     }
197
198     /* discard symlink info */
199     scp->mountPointStringp[0] = '\0';
200     memset(&scp->mountRootFid, 0, sizeof(cm_fid_t));
201     memset(&scp->dotdotFid, 0, sizeof(cm_fid_t));
202
203     /* reset locking info */
204     scp->fileLocksH = NULL;
205     scp->fileLocksT = NULL;
206     scp->serverLock = (-1);
207     scp->exclusiveLocks = 0;
208     scp->sharedLocks = 0;
209     scp->lockDataVersion = -1;
210
211     /* not locked, but there can be no references to this guy
212      * while we hold the global refcount lock.
213      */
214     cm_FreeAllACLEnts(scp);
215
216 #ifdef USE_BPLUS
217     /* destroy directory Bplus Tree */
218     if (scp->dirBplus) {
219         LARGE_INTEGER start, end;
220         QueryPerformanceCounter(&start);
221         bplus_free_tree++;
222         freeBtree(scp->dirBplus);
223         scp->dirBplus = NULL;
224         QueryPerformanceCounter(&end);
225
226         bplus_free_time += (end.QuadPart - start.QuadPart);
227     }
228 #endif
229     return 0;
230 }
231
232
233 /* called with cm_scacheLock write-locked; find a vnode to recycle.
234  * Can allocate a new one if desperate, or if below quota (cm_data.maxSCaches).
235  */
236 cm_scache_t *cm_GetNewSCache(void)
237 {
238     cm_scache_t *scp;
239     int retry = 0;
240
241 #if 0
242     /* first pass - look for deleted objects */
243     for ( scp = cm_data.scacheLRULastp;
244           scp;
245           scp = (cm_scache_t *) osi_QPrev(&scp->q)) 
246     {
247         osi_assertx(scp >= cm_data.scacheBaseAddress && scp < (cm_scache_t *)cm_data.scacheHashTablep,
248                     "invalid cm_scache_t address");
249
250         if (scp->refCount == 0) {
251             if (scp->flags & CM_SCACHEFLAG_DELETED) {
252                 osi_Log1(afsd_logp, "GetNewSCache attempting to recycle deleted scp 0x%x", scp);
253                 if (!cm_RecycleSCache(scp, CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS)) {
254
255                     /* we found an entry, so return it */
256                     /* now remove from the LRU queue and put it back at the
257                      * head of the LRU queue.
258                      */
259                     cm_AdjustScacheLRU(scp);
260
261                     /* and we're done */
262                     return scp;
263                 } 
264                 osi_Log1(afsd_logp, "GetNewSCache recycled failed scp 0x%x", scp);
265             } else if (!(scp->flags & CM_SCACHEFLAG_INHASH)) {
266                 /* we found an entry, so return it */
267                 /* now remove from the LRU queue and put it back at the
268                 * head of the LRU queue.
269                 */
270                 cm_AdjustScacheLRU(scp);
271
272                 /* and we're done */
273                 return scp;
274             }
275         }       
276     }   
277     osi_Log0(afsd_logp, "GetNewSCache no deleted or recycled entries available for reuse");
278 #endif 
279
280     if (cm_data.currentSCaches >= cm_data.maxSCaches) {
281         /* There were no deleted scache objects that we could use.  Try to find
282          * one that simply hasn't been used in a while.
283          */
284         for ( scp = cm_data.scacheLRULastp;
285               scp;
286               scp = (cm_scache_t *) osi_QPrev(&scp->q)) 
287         {
288             /* It is possible for the refCount to be zero and for there still
289              * to be outstanding dirty buffers.  If there are dirty buffers,
290              * we must not recycle the scp. */
291             if (scp->refCount == 0 && scp->bufReadsp == NULL && scp->bufWritesp == NULL) {
292                 if (!buf_DirtyBuffersExist(&scp->fid)) {
293                     if (!cm_RecycleSCache(scp, 0)) {
294                         /* we found an entry, so return it */
295                         /* now remove from the LRU queue and put it back at the
296                          * head of the LRU queue.
297                          */
298                         cm_AdjustScacheLRU(scp);
299
300                         /* and we're done */
301                         return scp;
302                     }
303                 } else {
304                     osi_Log1(afsd_logp,"GetNewSCache dirty buffers exist scp 0x%x", scp);
305                 }
306             }   
307         }
308         osi_Log1(afsd_logp, "GetNewSCache all scache entries in use (retry = %d)", retry);
309
310         return NULL;
311     }
312         
313     /* if we get here, we should allocate a new scache entry.  We either are below
314      * quota or we have a leak and need to allocate a new one to avoid panicing.
315      */
316     scp = cm_data.scacheBaseAddress + cm_data.currentSCaches;
317     osi_assertx(scp >= cm_data.scacheBaseAddress && scp < (cm_scache_t *)cm_data.scacheHashTablep,
318                 "invalid cm_scache_t address");
319     memset(scp, 0, sizeof(cm_scache_t));
320     scp->magic = CM_SCACHE_MAGIC;
321     lock_InitializeRWLock(&scp->rw, "cm_scache_t rw");
322     lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock");
323 #ifdef USE_BPLUS
324     lock_InitializeRWLock(&scp->dirlock, "cm_scache_t dirlock");
325 #endif
326     scp->serverLock = -1;
327
328     /* and put it in the LRU queue */
329     osi_QAdd((osi_queue_t **) &cm_data.scacheLRUFirstp, &scp->q);
330     if (!cm_data.scacheLRULastp) 
331         cm_data.scacheLRULastp = scp;
332     cm_data.currentSCaches++;
333     cm_dnlcPurgedp(scp); /* make doubly sure that this is not in dnlc */
334     cm_dnlcPurgevp(scp); 
335     scp->allNextp = cm_data.allSCachesp;
336     cm_data.allSCachesp = scp;
337     return scp;
338 }       
339
340 void cm_SetFid(cm_fid_t *fidp, afs_uint32 cell, afs_uint32 volume, afs_uint32 vnode, afs_uint32 unique)
341 {
342     fidp->cell = cell;
343     fidp->volume = volume;
344     fidp->vnode = vnode;
345     fidp->unique = unique;
346     fidp->hash = ((cell & 0xF) << 28) | ((volume & 0x3F) << 22) | ((vnode & 0x7FF) << 11) | (unique & 0x7FF);
347 }
348
349 /* like strcmp, only for fids */
350 __inline int cm_FidCmp(cm_fid_t *ap, cm_fid_t *bp)
351 {
352     if (ap->hash != bp->hash)
353         return 1;
354     if (ap->vnode != bp->vnode)
355         return 1;
356     if (ap->volume != bp->volume) 
357         return 1;
358     if (ap->unique != bp->unique) 
359         return 1;
360     if (ap->cell != bp->cell) 
361         return 1;
362     return 0;
363 }
364
365 void cm_fakeSCacheInit(int newFile)
366 {
367     if ( newFile ) {
368         memset(&cm_data.fakeSCache, 0, sizeof(cm_scache_t));
369         cm_data.fakeSCache.cbServerp = (struct cm_server *)(-1);
370         /* can leave clientModTime at 0 */
371         cm_data.fakeSCache.fileType = CM_SCACHETYPE_FILE;
372         cm_data.fakeSCache.unixModeBits = 0777;
373         cm_data.fakeSCache.length.LowPart = 1000;
374         cm_data.fakeSCache.linkCount = 1;
375         cm_data.fakeSCache.refCount = 1;
376     }
377     lock_InitializeRWLock(&cm_data.fakeSCache.rw, "cm_scache_t rw");
378 }
379
380 long
381 cm_ValidateSCache(void)
382 {
383     cm_scache_t * scp, *lscp;
384     long i;
385
386     if ( cm_data.scacheLRUFirstp == NULL && cm_data.scacheLRULastp != NULL ||
387          cm_data.scacheLRUFirstp != NULL && cm_data.scacheLRULastp == NULL) {
388         afsi_log("cm_ValidateSCache failure: inconsistent LRU pointers");
389         fprintf(stderr, "cm_ValidateSCache failure: inconsistent LRU pointers\n");
390         return -17;
391     }
392
393     for ( scp = cm_data.scacheLRUFirstp, lscp = NULL, i = 0; 
394           scp;
395           lscp = scp, scp = (cm_scache_t *) osi_QNext(&scp->q), i++ ) {
396         if (scp->magic != CM_SCACHE_MAGIC) {
397             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
398             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
399             return -1;
400         }
401         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
402             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
403             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
404             return -2;
405         }
406         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
407             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
408             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
409             return -3;
410         }
411         if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
412             afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
413             fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
414             return -4;
415         }
416         if (i > cm_data.currentSCaches ) {
417             afsi_log("cm_ValidateSCache failure: LRU First queue loops");
418             fprintf(stderr, "cm_ValidateSCache failure: LUR First queue loops\n");
419             return -13;
420         }
421         if (lscp != (cm_scache_t *) osi_QPrev(&scp->q)) {
422             afsi_log("cm_ValidateSCache failure: QPrev(scp) != previous");
423             fprintf(stderr, "cm_ValidateSCache failure: QPrev(scp) != previous\n");
424             return -15;
425         }
426     }
427
428     for ( scp = cm_data.scacheLRULastp, lscp = NULL, i = 0; scp;
429           lscp = scp, scp = (cm_scache_t *) osi_QPrev(&scp->q), i++ ) {
430         if (scp->magic != CM_SCACHE_MAGIC) {
431             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
432             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
433             return -5;
434         }
435         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
436             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
437             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
438             return -6;
439         }
440         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
441             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
442             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
443             return -7;
444         }
445         if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
446             afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
447             fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
448             return -8;
449         }
450         if (i > cm_data.currentSCaches ) {
451             afsi_log("cm_ValidateSCache failure: LRU Last queue loops");
452             fprintf(stderr, "cm_ValidateSCache failure: LUR Last queue loops\n");
453             return -14;
454         }
455         if (lscp != (cm_scache_t *) osi_QNext(&scp->q)) {
456             afsi_log("cm_ValidateSCache failure: QNext(scp) != next");
457             fprintf(stderr, "cm_ValidateSCache failure: QNext(scp) != next\n");
458             return -16;
459         }
460     }
461
462     for ( i=0; i < cm_data.scacheHashTableSize; i++ ) {
463         for ( scp = cm_data.scacheHashTablep[i]; scp; scp = scp->nextp ) {
464             if (scp->magic != CM_SCACHE_MAGIC) {
465                 afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
466                 fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
467                 return -9;
468             }
469             if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
470                 afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
471                 fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
472                 return -10;
473             }
474             if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
475                 afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
476                 fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
477                 return -11;
478             }
479             if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
480                 afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
481                 fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
482                 return -12;
483             }
484         }
485     }
486
487     return cm_dnlcValidate();
488 }
489
490 void
491 cm_SuspendSCache(void)
492 {
493     cm_scache_t * scp;
494     time_t now;
495
496     cm_GiveUpAllCallbacksAllServers(TRUE);
497
498     /* 
499      * After this call all servers are marked down.
500      * Do not clear the callbacks, instead change the
501      * expiration time so that the callbacks will be expired
502      * when the servers are marked back up.  However, we
503      * want the callbacks to be preserved as long as the 
504      * servers are down.  That way if the machine resumes
505      * without network, the stat cache item will still be
506      * considered valid.
507      */
508     now = time(NULL);
509
510     lock_ObtainWrite(&cm_scacheLock);
511     for ( scp = cm_data.allSCachesp; scp; scp = scp->allNextp ) {
512         if (scp->cbServerp) {
513             if (scp->flags & CM_SCACHEFLAG_PURERO && scp->volp) {
514                 if (scp->volp->cbExpiresRO == scp->cbExpires) {
515                     scp->volp->cbExpiresRO = now+1;
516                 }
517             }
518             scp->cbExpires = now+1;
519         }
520     }
521     lock_ReleaseWrite(&cm_scacheLock);
522 }
523
524 long
525 cm_ShutdownSCache(void)
526 {
527     cm_scache_t * scp;
528
529     lock_ObtainWrite(&cm_scacheLock);
530
531     for ( scp = cm_data.allSCachesp; scp;
532           scp = scp->allNextp ) {
533         if (scp->randomACLp) {
534             lock_ObtainWrite(&scp->rw);
535             cm_FreeAllACLEnts(scp);
536             lock_ReleaseWrite(&scp->rw);
537         }
538
539         if (scp->cbServerp) {
540             cm_PutServer(scp->cbServerp);
541             scp->cbServerp = NULL;
542         }
543         scp->cbExpires = 0;
544         scp->flags &= ~CM_SCACHEFLAG_CALLBACK;
545
546 #ifdef USE_BPLUS
547         if (scp->dirBplus)
548             freeBtree(scp->dirBplus);
549         scp->dirBplus = NULL;
550         scp->dirDataVersion = -1;
551         lock_FinalizeRWLock(&scp->dirlock);
552 #endif
553         lock_FinalizeRWLock(&scp->rw);
554         lock_FinalizeRWLock(&scp->bufCreateLock);
555     }
556     lock_ReleaseWrite(&cm_scacheLock);
557
558     cm_GiveUpAllCallbacksAllServers(FALSE);
559
560     return cm_dnlcShutdown();
561 }
562
563 void cm_InitSCache(int newFile, long maxSCaches)
564 {
565     static osi_once_t once;
566         
567     if (osi_Once(&once)) {
568         lock_InitializeRWLock(&cm_scacheLock, "cm_scacheLock");
569         if ( newFile ) {
570             memset(cm_data.scacheHashTablep, 0, sizeof(cm_scache_t *) * cm_data.scacheHashTableSize);
571             cm_data.allSCachesp = NULL;
572             cm_data.currentSCaches = 0;
573             cm_data.maxSCaches = maxSCaches;
574             cm_data.scacheLRUFirstp = cm_data.scacheLRULastp = NULL;
575         } else {
576             cm_scache_t * scp;
577
578             for ( scp = cm_data.allSCachesp; scp;
579                   scp = scp->allNextp ) {
580                 lock_InitializeRWLock(&scp->rw, "cm_scache_t rw");
581                 lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock");
582 #ifdef USE_BPLUS
583                 lock_InitializeRWLock(&scp->dirlock, "cm_scache_t dirlock");
584 #endif
585                 scp->cbServerp = NULL;
586                 scp->cbExpires = 0;
587                 scp->fileLocksH = NULL;
588                 scp->fileLocksT = NULL;
589                 scp->serverLock = (-1);
590                 scp->lastRefreshCycle = 0;
591                 scp->exclusiveLocks = 0;
592                 scp->sharedLocks = 0;
593                 scp->openReads = 0;
594                 scp->openWrites = 0;
595                 scp->openShares = 0;
596                 scp->openExcls = 0;
597                 scp->waitCount = 0;
598 #ifdef USE_BPLUS
599                 scp->dirBplus = NULL;
600                 scp->dirDataVersion = -1;
601 #endif
602                 scp->waitQueueT = NULL;
603                 scp->flags &= ~CM_SCACHEFLAG_WAITING;
604             }
605         }
606         cm_allFileLocks = NULL;
607         cm_freeFileLocks = NULL;
608         cm_lockRefreshCycle = 0;
609         cm_fakeSCacheInit(newFile);
610         cm_allFreeWaiters = NULL;
611         cm_dnlcInit(newFile);
612         osi_EndOnce(&once);
613     }
614 }
615
616 /* version that doesn't bother creating the entry if we don't find it */
617 cm_scache_t *cm_FindSCache(cm_fid_t *fidp)
618 {
619     long hash;
620     cm_scache_t *scp;
621
622     hash = CM_SCACHE_HASH(fidp);
623
624     if (fidp->cell == 0) {
625         return NULL;
626     }
627
628     lock_ObtainWrite(&cm_scacheLock);
629     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
630         if (cm_FidCmp(fidp, &scp->fid) == 0) {
631             cm_HoldSCacheNoLock(scp);
632             cm_AdjustScacheLRU(scp);
633             lock_ReleaseWrite(&cm_scacheLock);
634             return scp;
635         }
636     }
637     lock_ReleaseWrite(&cm_scacheLock);
638     return NULL;
639 }
640
641 #ifdef DEBUG_REFCOUNT
642 long cm_GetSCacheDbg(cm_fid_t *fidp, cm_scache_t **outScpp, cm_user_t *userp,
643                   cm_req_t *reqp, char * file, long line)
644 #else
645 long cm_GetSCache(cm_fid_t *fidp, cm_scache_t **outScpp, cm_user_t *userp,
646                   cm_req_t *reqp)
647 #endif
648 {
649     long hash;
650     cm_scache_t *scp;
651     long code;
652     cm_volume_t *volp = NULL;
653     cm_cell_t *cellp;
654     int special = 0; // yj: boolean variable to test if file is on root.afs
655     int isRoot = 0;
656     extern cm_fid_t cm_rootFid;
657         
658     hash = CM_SCACHE_HASH(fidp);
659         
660     osi_assertx(fidp->cell != 0, "unassigned cell value");
661
662     if (fidp->cell== cm_data.rootFid.cell && 
663          fidp->volume==cm_data.rootFid.volume &&
664          fidp->vnode==0x0 && fidp->unique==0x0)
665     {
666         osi_Log0(afsd_logp,"cm_GetSCache called with root cell/volume and vnode=0 and unique=0");
667     }
668
669     // yj: check if we have the scp, if so, we don't need
670     // to do anything else
671     lock_ObtainWrite(&cm_scacheLock);
672     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
673         if (cm_FidCmp(fidp, &scp->fid) == 0) {
674 #ifdef DEBUG_REFCOUNT
675             afsi_log("%s:%d cm_GetSCache (1) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
676             osi_Log1(afsd_logp,"cm_GetSCache (1) outScpp 0x%p", scp);
677 #endif
678             cm_HoldSCacheNoLock(scp);
679             *outScpp = scp;
680             cm_AdjustScacheLRU(scp);
681             lock_ReleaseWrite(&cm_scacheLock);
682             return 0;
683         }
684     }
685
686     // yj: when we get here, it means we don't have an scp
687     // so we need to either load it or fake it, depending
688     // on whether the file is "special", see below.
689
690     // yj: if we're trying to get an scp for a file that's
691     // on root.afs of homecell, we want to handle it specially
692     // because we have to fill in the status stuff 'coz we
693     // don't want trybulkstat to fill it in for us
694 #ifdef AFS_FREELANCE_CLIENT
695     special = (fidp->cell==AFS_FAKE_ROOT_CELL_ID && 
696                fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
697                !(fidp->vnode==0x1 && fidp->unique==0x1));
698     isRoot = (fidp->cell==AFS_FAKE_ROOT_CELL_ID && 
699               fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
700               fidp->vnode==0x1 && fidp->unique==0x1);
701     if (cm_freelanceEnabled && isRoot) {
702         osi_Log0(afsd_logp,"cm_GetSCache Freelance and isRoot");
703         /* freelance: if we are trying to get the root scp for the first
704          * time, we will just put in a place holder entry. 
705          */
706         volp = NULL;
707     }
708           
709     if (cm_freelanceEnabled && special) {
710         char mp[MOUNTPOINTLEN] = "";
711         afs_uint32 fileType;
712
713         osi_Log0(afsd_logp,"cm_GetSCache Freelance and special");
714         lock_ObtainMutex(&cm_Freelance_Lock);
715         if (fidp->vnode >= 2 && fidp->vnode - 2 < cm_noLocalMountPoints) {
716             strncpy(mp,(cm_localMountPoints+fidp->vnode-2)->mountPointStringp, MOUNTPOINTLEN);
717             mp[MOUNTPOINTLEN-1] = '\0';
718             if ( !strnicmp(mp, "msdfs:", strlen("msdfs:")) )
719                 fileType = CM_SCACHETYPE_DFSLINK;
720             else
721                 fileType = (cm_localMountPoints+fidp->vnode-2)->fileType;
722         } else {
723             fileType = CM_SCACHETYPE_INVALID;
724
725         }
726         lock_ReleaseMutex(&cm_Freelance_Lock);
727
728         scp = cm_GetNewSCache();
729         if (scp == NULL) {
730             osi_Log0(afsd_logp,"cm_GetSCache unable to obtain *new* scache entry");
731             lock_ReleaseWrite(&cm_scacheLock);
732             return CM_ERROR_WOULDBLOCK;
733         }
734
735 #if not_too_dangerous
736         /* dropping the cm_scacheLock allows more than one thread
737          * to obtain the same cm_scache_t from the LRU list.  Since
738          * the refCount is known to be zero at this point we have to
739          * assume that no one else is using the one this is returned.
740          */
741         lock_ReleaseWrite(&cm_scacheLock);
742         lock_ObtainWrite(&scp->rw);
743         lock_ObtainWrite(&cm_scacheLock);
744 #endif
745         scp->fid = *fidp;
746         scp->volp = cm_data.rootSCachep->volp;
747         if (scp->volp)
748             cm_GetVolume(scp->volp);    /* grab an additional reference */
749         scp->dotdotFid.cell=AFS_FAKE_ROOT_CELL_ID;
750         scp->dotdotFid.volume=AFS_FAKE_ROOT_VOL_ID;
751         scp->dotdotFid.unique=1;
752         scp->dotdotFid.vnode=1;
753         scp->flags |= (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO);
754         scp->nextp=cm_data.scacheHashTablep[hash];
755         cm_data.scacheHashTablep[hash]=scp;
756         scp->flags |= CM_SCACHEFLAG_INHASH;
757         scp->refCount = 1;
758         osi_Log1(afsd_logp,"cm_GetSCache (freelance) sets refCount to 1 scp 0x%x", scp);
759         scp->fileType = fileType;
760         scp->length.LowPart = (DWORD)strlen(mp)+4;
761         scp->length.HighPart = 0;
762         strncpy(scp->mountPointStringp,mp,MOUNTPOINTLEN);
763         scp->owner=0x0;
764         scp->unixModeBits=0777;
765         scp->clientModTime=FakeFreelanceModTime;
766         scp->serverModTime=FakeFreelanceModTime;
767         scp->parentUnique = 0x1;
768         scp->parentVnode=0x1;
769         scp->group=0;
770         scp->dataVersion=cm_data.fakeDirVersion;
771         scp->bufDataVersionLow=cm_data.fakeDirVersion;
772         scp->lockDataVersion=-1; /* no lock yet */
773 #if not_too_dangerous
774         lock_ReleaseWrite(&scp->rw);
775 #endif
776         *outScpp = scp;
777         lock_ReleaseWrite(&cm_scacheLock);
778 #ifdef DEBUG_REFCOUNT
779         afsi_log("%s:%d cm_GetSCache (2) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
780         osi_Log1(afsd_logp,"cm_GetSCache (2) outScpp 0x%p", scp);
781 #endif
782         return 0;
783     }
784     // end of yj code
785 #endif /* AFS_FREELANCE_CLIENT */
786
787     /* otherwise, we need to find the volume */
788     if (!cm_freelanceEnabled || !isRoot) {
789         lock_ReleaseWrite(&cm_scacheLock);      /* for perf. reasons */
790         cellp = cm_FindCellByID(fidp->cell, 0);
791         if (!cellp) 
792             return CM_ERROR_NOSUCHCELL;
793
794         code = cm_GetVolumeByID(cellp, fidp->volume, userp, reqp, CM_GETVOL_FLAG_CREATE, &volp);
795         if (code) 
796             return code;
797         lock_ObtainWrite(&cm_scacheLock);
798     }
799         
800     /* otherwise, we have the volume, now reverify that the scp doesn't
801      * exist, and proceed.
802      */
803     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
804         if (cm_FidCmp(fidp, &scp->fid) == 0) {
805 #ifdef DEBUG_REFCOUNT
806             afsi_log("%s:%d cm_GetSCache (3) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
807             osi_Log1(afsd_logp,"cm_GetSCache (3) outScpp 0x%p", scp);
808 #endif
809             cm_HoldSCacheNoLock(scp);
810             osi_assertx(scp->volp == volp, "cm_scache_t volume has unexpected value");
811             cm_AdjustScacheLRU(scp);
812             lock_ReleaseWrite(&cm_scacheLock);
813             if (volp)
814                 cm_PutVolume(volp);
815             *outScpp = scp;
816             return 0;
817         }
818     }
819         
820     /* now, if we don't have the fid, recycle something */
821     scp = cm_GetNewSCache();
822     if (scp == NULL) {
823         osi_Log0(afsd_logp,"cm_GetNewSCache unable to obtain *new* scache entry");
824         lock_ReleaseWrite(&cm_scacheLock);
825         if (volp)
826             cm_PutVolume(volp);
827         return CM_ERROR_WOULDBLOCK;
828     }
829     osi_Log2(afsd_logp,"cm_GetNewSCache returns scp 0x%x flags 0x%x", scp, scp->flags);
830
831     osi_assertx(!(scp->flags & CM_SCACHEFLAG_INHASH), "CM_SCACHEFLAG_INHASH set");
832
833 #if not_too_dangerous
834     /* dropping the cm_scacheLock allows more than one thread
835      * to obtain the same cm_scache_t from the LRU list.  Since
836      * the refCount is known to be zero at this point we have to
837      * assume that no one else is using the one this is returned.
838      */
839     lock_ReleaseWrite(&cm_scacheLock);
840     lock_ObtainWrite(&scp->rw);
841     lock_ObtainWrite(&cm_scacheLock);
842 #endif
843     scp->fid = *fidp;
844     scp->volp = volp;   /* a held reference */
845
846     if (!cm_freelanceEnabled || !isRoot) {
847         /* if this scache entry represents a volume root then we need 
848          * to copy the dotdotFipd from the volume structure where the 
849          * "master" copy is stored (defect 11489)
850          */
851         if (scp->fid.vnode == 1 && scp->fid.unique == 1) {
852             scp->dotdotFid = volp->dotdotFid;
853         }
854           
855         if (volp->ro.ID == fidp->volume)
856             scp->flags |= (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO);
857         else if (volp->bk.ID == fidp->volume)
858             scp->flags |= CM_SCACHEFLAG_RO;
859     }
860     scp->nextp = cm_data.scacheHashTablep[hash];
861     cm_data.scacheHashTablep[hash] = scp;
862     scp->flags |= CM_SCACHEFLAG_INHASH;
863     scp->refCount = 1;
864     osi_Log1(afsd_logp,"cm_GetSCache sets refCount to 1 scp 0x%x", scp);
865 #if not_too_dangerous
866     lock_ReleaseWrite(&scp->rw);
867 #endif
868
869     /* XXX - The following fields in the cm_scache are 
870      * uninitialized:
871      *   fileType
872      *   parentVnode
873      *   parentUnique
874      */
875     lock_ReleaseWrite(&cm_scacheLock);
876         
877     /* now we have a held scache entry; just return it */
878     *outScpp = scp;
879 #ifdef DEBUG_REFCOUNT
880     afsi_log("%s:%d cm_GetSCache (4) outScpp 0x%p ref %d", file, line, scp, scp->refCount);
881     osi_Log1(afsd_logp,"cm_GetSCache (4) outScpp 0x%p", scp);
882 #endif
883     return 0;
884 }
885
886 /* Returns a held reference to the scache's parent 
887  * if it exists */
888 cm_scache_t * cm_FindSCacheParent(cm_scache_t * scp)
889 {
890     long code = 0;
891     int i;
892     cm_fid_t    parent_fid;
893     cm_scache_t * pscp = NULL;
894
895     lock_ObtainWrite(&cm_scacheLock);
896     cm_SetFid(&parent_fid, scp->fid.cell, scp->fid.volume, scp->parentVnode, scp->parentUnique);
897
898     if (cm_FidCmp(&scp->fid, &parent_fid)) {
899         i = CM_SCACHE_HASH(&parent_fid);
900         for (pscp = cm_data.scacheHashTablep[i]; pscp; pscp = pscp->nextp) {
901             if (!cm_FidCmp(&pscp->fid, &parent_fid)) {
902                 cm_HoldSCacheNoLock(pscp);
903                 break;
904             }
905         }
906     }
907
908     lock_ReleaseWrite(&cm_scacheLock);
909
910     return pscp;
911 }
912
913 void cm_SyncOpAddToWaitQueue(cm_scache_t * scp, afs_int32 flags, cm_buf_t * bufp)
914 {
915     cm_scache_waiter_t * w;
916
917     /* Do not use the queue for asynchronous store operations */
918     if (flags == CM_SCACHESYNC_ASYNCSTORE)
919         return;
920
921     lock_ObtainWrite(&cm_scacheLock);
922     if (cm_allFreeWaiters == NULL) {
923         w = malloc(sizeof(*w));
924         memset(w, 0, sizeof(*w));
925     } else {
926         w = (cm_scache_waiter_t *) cm_allFreeWaiters;
927         osi_QRemove(&cm_allFreeWaiters, (osi_queue_t *) w);
928     }
929
930     w->threadId = thrd_Current();
931     w->scp = scp;
932     cm_HoldSCacheNoLock(scp);
933     w->flags = flags;
934     w->bufp = bufp;
935
936     osi_QAddT(&scp->waitQueueH, &scp->waitQueueT, (osi_queue_t *) w);
937     lock_ReleaseWrite(&cm_scacheLock);
938
939     osi_Log2(afsd_logp, "cm_SyncOpAddToWaitQueue : Adding thread to wait queue scp 0x%p w 0x%p", scp, w);
940 }
941
942 int cm_SyncOpCheckContinue(cm_scache_t * scp, afs_int32 flags, cm_buf_t * bufp)
943 {
944     cm_scache_waiter_t * w;
945     int this_is_me;
946
947     /* Do not use the queue for asynchronous store operations */
948     if (flags == CM_SCACHESYNC_ASYNCSTORE)
949         return 1;
950
951     osi_Log0(afsd_logp, "cm_SyncOpCheckContinue checking for continuation");
952
953     lock_ObtainRead(&cm_scacheLock);
954     for (w = (cm_scache_waiter_t *)scp->waitQueueH;
955          w;
956          w = (cm_scache_waiter_t *)osi_QNext((osi_queue_t *) w)) {
957         if (w->flags == flags && w->bufp == bufp) {
958             break;
959         }
960     }
961
962     osi_assertx(w != NULL, "null cm_scache_waiter_t");
963     this_is_me = (w->threadId == thrd_Current());
964     lock_ReleaseRead(&cm_scacheLock);
965
966     if (!this_is_me) {
967         osi_Log1(afsd_logp, "cm_SyncOpCheckContinue MISS: Waiter 0x%p", w);
968         return 0;
969     }
970
971     osi_Log1(afsd_logp, "cm_SyncOpCheckContinue HIT: Waiter 0x%p", w);
972
973     lock_ObtainWrite(&cm_scacheLock);
974     osi_QRemoveHT(&scp->waitQueueH, &scp->waitQueueT, (osi_queue_t *) w);
975     cm_ReleaseSCacheNoLock(scp);
976     memset(w, 0, sizeof(*w));
977     osi_QAdd(&cm_allFreeWaiters, (osi_queue_t *) w);
978     lock_ReleaseWrite(&cm_scacheLock);
979
980     return 1;
981 }
982
983
984 /* synchronize a fetch, store, read, write, fetch status or store status.
985  * Called with scache mutex held, and returns with it held, but temporarily
986  * drops it during the fetch.
987  * 
988  * At most one flag can be on in flags, if this is an RPC request.
989  *
990  * Also, if we're fetching or storing data, we must ensure that we have a buffer.
991  *
992  * There are a lot of weird restrictions here; here's an attempt to explain the
993  * rationale for the concurrency restrictions implemented in this function.
994  *
995  * First, although the file server will break callbacks when *another* machine
996  * modifies a file or status block, the client itself is responsible for
997  * concurrency control on its own requests.  Callback breaking events are rare,
998  * and simply invalidate any concurrent new status info.
999  *
1000  * In the absence of callback breaking messages, we need to know how to
1001  * synchronize incoming responses describing updates to files.  We synchronize
1002  * operations that update the data version by comparing the data versions.
1003  * However, updates that do not update the data, but only the status, can't be
1004  * synchronized with fetches or stores, since there's nothing to compare
1005  * to tell which operation executed first at the server.
1006  *
1007  * Thus, we can allow multiple ops that change file data, or dir data, and
1008  * fetches.  However, status storing ops have to be done serially.
1009  *
1010  * Furthermore, certain data-changing ops are incompatible: we can't read or
1011  * write a buffer while doing a truncate.  We can't read and write the same
1012  * buffer at the same time, or write while fetching or storing, or read while
1013  * fetching a buffer (this may change).  We can't fetch and store at the same
1014  * time, either.
1015  *
1016  * With respect to status, we can't read and write at the same time, read while
1017  * fetching, write while fetching or storing, or fetch and store at the same time.
1018  *
1019  * We can't allow a get callback RPC to run in concurrently with something that
1020  * will return updated status, since we could start a call, have the server
1021  * return status, have another machine make an update to the status (which
1022  * doesn't change serverModTime), have the original machine get a new callback,
1023  * and then have the original machine merge in the early, old info from the
1024  * first call.  At this point, the easiest way to avoid this problem is to have
1025  * getcallback calls conflict with all others for the same vnode.  Other calls
1026  * to cm_MergeStatus that aren't associated with calls to cm_SyncOp on the same
1027  * vnode must be careful not to merge in their status unless they have obtained
1028  * a callback from the start of their call.
1029  *
1030  * Note added 1/23/96
1031  * Concurrent StoreData RPC's can cause trouble if the file is being extended.
1032  * Each such RPC passes a FileLength parameter, which the server uses to do
1033  * pre-truncation if necessary.  So if two RPC's are processed out of order at
1034  * the server, the one with the smaller FileLength will be processed last,
1035  * possibly resulting in a bogus truncation.  The simplest way to avoid this
1036  * is to serialize all StoreData RPC's.  This is the reason we defined
1037  * CM_SCACHESYNC_STOREDATA_EXCL and CM_SCACHEFLAG_DATASTORING.
1038  */
1039 long cm_SyncOp(cm_scache_t *scp, cm_buf_t *bufp, cm_user_t *userp, cm_req_t *reqp,
1040                afs_uint32 rights, afs_uint32 flags)
1041 {
1042     osi_queueData_t *qdp;
1043     long code;
1044     cm_buf_t *tbufp;
1045     afs_uint32 outRights;
1046     int bufLocked;
1047     afs_uint32 sleep_scp_flags = 0;
1048     afs_uint32 sleep_buf_cmflags = 0;
1049     afs_uint32 sleep_scp_bufs = 0;
1050     int wakeupCycle;
1051
1052     /* lookup this first */
1053     bufLocked = flags & CM_SCACHESYNC_BUFLOCKED;
1054
1055     if (bufp)
1056         osi_assertx(bufp->refCount > 0, "cm_buf_t refCount 0");
1057
1058
1059     /* Do the access check.  Now we don't really do the access check
1060      * atomically, since the caller doesn't expect the parent dir to be
1061      * returned locked, and that is what we'd have to do to prevent a
1062      * callback breaking message on the parent due to a setacl call from
1063      * being processed while we're running.  So, instead, we check things
1064      * here, and if things look fine with the access, we proceed to finish
1065      * the rest of this check.  Sort of a hack, but probably good enough.
1066      */
1067
1068     while (1) {
1069         if (flags & CM_SCACHESYNC_FETCHSTATUS) {
1070             /* if we're bringing in a new status block, ensure that
1071              * we aren't already doing so, and that no one is
1072              * changing the status concurrently, either.  We need
1073              * to do this, even if the status is of a different
1074              * type, since we don't have the ability to figure out,
1075              * in the AFS 3 protocols, which status-changing
1076              * operation ran first, or even which order a read and
1077              * a write occurred in.
1078              */
1079             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
1080                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1081                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want FETCHSTATUS", scp);
1082                 goto sleep;
1083             }
1084         }
1085         if (flags & (CM_SCACHESYNC_STORESIZE | CM_SCACHESYNC_STORESTATUS
1086                       | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_GETCALLBACK)) {
1087             /* if we're going to make an RPC to change the status, make sure
1088              * that no one is bringing in or sending out the status.
1089              */
1090             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING |
1091                               CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1092                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
1093                 goto sleep;
1094             }
1095             if (scp->bufReadsp || scp->bufWritesp) {
1096                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is bufRead|bufWrite want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
1097                 goto sleep;
1098             }
1099         }
1100         if (flags & CM_SCACHESYNC_FETCHDATA) {
1101             /* if we're bringing in a new chunk of data, make sure that
1102              * nothing is happening to that chunk, and that we aren't
1103              * changing the basic file status info, either.
1104              */
1105             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
1106                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1107                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want FETCHDATA", scp);
1108                 goto sleep;
1109             }
1110             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING | CM_BUF_CMWRITING))) {
1111                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING|BUF_CMSTORING|BUF_CMWRITING want FETCHDATA", scp, bufp);
1112                 goto sleep;
1113             }
1114         }
1115         if (flags & CM_SCACHESYNC_STOREDATA) {
1116             /* same as fetch data */
1117             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
1118                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1119                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want STOREDATA", scp);
1120                 goto sleep;
1121             }
1122             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING | CM_BUF_CMWRITING))) {
1123                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING|BUF_CMSTORING|BUF_CMWRITING want STOREDATA", scp, bufp);
1124                 goto sleep;
1125             }
1126         }
1127
1128         if (flags & CM_SCACHESYNC_STOREDATA_EXCL) {
1129             /* Don't allow concurrent StoreData RPC's */
1130             if (scp->flags & CM_SCACHEFLAG_DATASTORING) {
1131                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is DATASTORING want STOREDATA_EXCL", scp);
1132                 goto sleep;
1133             }
1134         }
1135
1136         if (flags & CM_SCACHESYNC_ASYNCSTORE) {
1137             /* Don't allow more than one BKG store request */
1138             if (scp->flags & CM_SCACHEFLAG_ASYNCSTORING) {
1139                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is ASYNCSTORING want ASYNCSTORE", scp);
1140                 goto sleep;
1141             }
1142         }
1143
1144         if (flags & CM_SCACHESYNC_LOCK) {
1145             /* Don't allow concurrent fiddling with lock lists */
1146             if (scp->flags & CM_SCACHEFLAG_LOCKING) {
1147                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is LOCKING want LOCK", scp);
1148                 goto sleep;
1149             }
1150         }
1151
1152         /* now the operations that don't correspond to making RPCs */
1153         if (flags & CM_SCACHESYNC_GETSTATUS) {
1154             /* we can use the status that's here, if we're not
1155              * bringing in new status.
1156              */
1157             if (scp->flags & (CM_SCACHEFLAG_FETCHING)) {
1158                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING want GETSTATUS", scp);
1159                 goto sleep;
1160             }
1161         }
1162         if (flags & CM_SCACHESYNC_SETSTATUS) {
1163             /* we can make a change to the local status, as long as
1164              * the status isn't changing now.
1165              *
1166              * If we're fetching or storing a chunk of data, we can
1167              * change the status locally, since the fetch/store
1168              * operations don't change any of the data that we're
1169              * changing here.
1170              */
1171             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESTORING)) {
1172                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING want SETSTATUS", scp);
1173                 goto sleep;
1174             }
1175         }
1176         if (flags & CM_SCACHESYNC_READ) {
1177             /* we're going to read the data, make sure that the
1178              * status is available, and that the data is here.  It
1179              * is OK to read while storing the data back.
1180              */
1181             if (scp->flags & CM_SCACHEFLAG_FETCHING) {
1182                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING want READ", scp);
1183                 goto sleep;
1184             }
1185             if (bufp && ((bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED)) == CM_BUF_CMFETCHING)) {
1186                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING want READ", scp, bufp);
1187                 goto sleep;
1188             }
1189             if (bufp && (bufp->cmFlags & CM_BUF_CMWRITING)) {
1190                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMWRITING want READ", scp, bufp);
1191                 goto sleep;
1192             }
1193         }
1194         if (flags & CM_SCACHESYNC_WRITE) {
1195             /* don't write unless the status is stable and the chunk
1196              * is stable.
1197              */
1198             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
1199                                | CM_SCACHEFLAG_SIZESTORING)) {
1200                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING want WRITE", scp);
1201                 goto sleep;
1202             }
1203             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING |
1204                                           CM_BUF_CMSTORING |
1205                                           CM_BUF_CMWRITING))) {
1206                 osi_Log3(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is %s want WRITE",
1207                          scp, bufp,
1208                          ((bufp->cmFlags & CM_BUF_CMFETCHING) ? "CM_BUF_CMFETCHING":
1209                           ((bufp->cmFlags & CM_BUF_CMSTORING) ? "CM_BUF_CMSTORING" :
1210                            ((bufp->cmFlags & CM_BUF_CMWRITING) ? "CM_BUF_CMWRITING" :
1211                             "UNKNOWN!!!"))));
1212                 goto sleep;
1213             }
1214         }
1215
1216         // yj: modified this so that callback only checked if we're
1217         // not checking something on /afs
1218         /* fix the conditional to match the one in cm_HaveCallback */
1219         if ((flags & CM_SCACHESYNC_NEEDCALLBACK)
1220 #ifdef AFS_FREELANCE_CLIENT
1221              && (!cm_freelanceEnabled || 
1222                   !(scp->fid.vnode==0x1 && scp->fid.unique==0x1) ||
1223                   scp->fid.cell!=AFS_FAKE_ROOT_CELL_ID ||
1224                   scp->fid.volume!=AFS_FAKE_ROOT_VOL_ID ||
1225                   cm_fakeDirCallback < 2)
1226 #endif /* AFS_FREELANCE_CLIENT */
1227              ) {
1228             if ((flags & CM_SCACHESYNC_FORCECB) || !cm_HaveCallback(scp)) {
1229                 osi_Log1(afsd_logp, "CM SyncOp getting callback on scp 0x%p",
1230                           scp);
1231                 if (bufLocked) 
1232                     lock_ReleaseMutex(&bufp->mx);
1233                 code = cm_GetCallback(scp, userp, reqp, (flags & CM_SCACHESYNC_FORCECB)?1:0);
1234                 if (bufLocked) {
1235                     lock_ReleaseWrite(&scp->rw);
1236                     lock_ObtainMutex(&bufp->mx);
1237                     lock_ObtainWrite(&scp->rw);
1238                 }
1239                 if (code) 
1240                     return code;
1241                 flags &= ~CM_SCACHESYNC_FORCECB;        /* only force once */
1242                 continue;
1243             }
1244         }
1245
1246         if (rights) {
1247             /* can't check access rights without a callback */
1248             osi_assertx(flags & CM_SCACHESYNC_NEEDCALLBACK, "!CM_SCACHESYNC_NEEDCALLBACK");
1249
1250             if ((rights & PRSFS_WRITE) && (scp->flags & CM_SCACHEFLAG_RO))
1251                 return CM_ERROR_READONLY;
1252
1253             if (cm_HaveAccessRights(scp, userp, rights, &outRights)) {
1254                 if (~outRights & rights) 
1255                     return CM_ERROR_NOACCESS;
1256             }
1257             else {
1258                 /* we don't know the required access rights */
1259                 if (bufLocked) lock_ReleaseMutex(&bufp->mx);
1260                 code = cm_GetAccessRights(scp, userp, reqp);
1261                 if (bufLocked) {
1262                     lock_ReleaseWrite(&scp->rw);
1263                     lock_ObtainMutex(&bufp->mx);
1264                     lock_ObtainWrite(&scp->rw);
1265                 }
1266                 if (code) 
1267                     return code;
1268                 continue;
1269             }
1270         }
1271
1272         /* if we get here, we're happy */
1273         break;
1274
1275       sleep:
1276         /* first check if we're not supposed to wait: fail 
1277          * in this case, returning with everything still locked.
1278          */
1279         if (flags & CM_SCACHESYNC_NOWAIT) 
1280             return CM_ERROR_WOULDBLOCK;
1281
1282         /* These are used for minidump debugging */
1283         sleep_scp_flags = scp->flags;           /* so we know why we slept */
1284         sleep_buf_cmflags = bufp ? bufp->cmFlags : 0;
1285         sleep_scp_bufs = (scp->bufReadsp ? 1 : 0) | (scp->bufWritesp ? 2 : 0);
1286
1287         /* wait here, then try again */
1288         osi_Log1(afsd_logp, "CM SyncOp sleeping scp 0x%p", scp);
1289         if ( scp->flags & CM_SCACHEFLAG_WAITING ) {
1290             scp->waitCount++;
1291             scp->waitRequests++;
1292             osi_Log3(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING already set for 0x%p; %d threads; %d requests", 
1293                      scp, scp->waitCount, scp->waitRequests);
1294         } else {
1295             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING set for 0x%p", scp);
1296             scp->flags |= CM_SCACHEFLAG_WAITING;
1297             scp->waitCount = scp->waitRequests = 1;
1298         }
1299
1300         cm_SyncOpAddToWaitQueue(scp, flags, bufp);
1301         wakeupCycle = 0;
1302         do {
1303             if (bufLocked) 
1304                 lock_ReleaseMutex(&bufp->mx);
1305             osi_SleepW((LONG_PTR) &scp->flags, &scp->rw);
1306             if (bufLocked) 
1307                 lock_ObtainMutex(&bufp->mx);
1308             lock_ObtainWrite(&scp->rw);
1309         } while (!cm_SyncOpCheckContinue(scp, flags, bufp));
1310
1311         smb_UpdateServerPriority();
1312
1313         scp->waitCount--;
1314         osi_Log3(afsd_logp, "CM SyncOp woke! scp 0x%p; still waiting %d threads of %d requests", 
1315                  scp, scp->waitCount, scp->waitRequests);
1316         if (scp->waitCount == 0) {
1317             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING reset for 0x%p", scp);
1318             scp->flags &= ~CM_SCACHEFLAG_WAITING;
1319             scp->waitRequests = 0;
1320         }
1321     } /* big while loop */
1322         
1323     /* now, update the recorded state for RPC-type calls */
1324     if (flags & CM_SCACHESYNC_FETCHSTATUS)
1325         scp->flags |= CM_SCACHEFLAG_FETCHING;
1326     if (flags & CM_SCACHESYNC_STORESTATUS)
1327         scp->flags |= CM_SCACHEFLAG_STORING;
1328     if (flags & CM_SCACHESYNC_STORESIZE)
1329         scp->flags |= CM_SCACHEFLAG_SIZESTORING;
1330     if (flags & CM_SCACHESYNC_GETCALLBACK)
1331         scp->flags |= CM_SCACHEFLAG_GETCALLBACK;
1332     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
1333         scp->flags |= CM_SCACHEFLAG_DATASTORING;
1334     if (flags & CM_SCACHESYNC_ASYNCSTORE)
1335         scp->flags |= CM_SCACHEFLAG_ASYNCSTORING;
1336     if (flags & CM_SCACHESYNC_LOCK)
1337         scp->flags |= CM_SCACHEFLAG_LOCKING;
1338
1339     /* now update the buffer pointer */
1340     if (flags & CM_SCACHESYNC_FETCHDATA) {
1341         /* ensure that the buffer isn't already in the I/O list */
1342         if (bufp) {
1343             for(qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1344                 tbufp = osi_GetQData(qdp);
1345                 osi_assertx(tbufp != bufp, "unexpected cm_buf_t value");
1346             }
1347         }
1348
1349         /* queue a held reference to the buffer in the "reading" I/O list */
1350         qdp = osi_QDAlloc();
1351         osi_SetQData(qdp, bufp);
1352         if (bufp) {
1353             buf_Hold(bufp);
1354             bufp->cmFlags |= CM_BUF_CMFETCHING;
1355         }
1356         osi_QAdd((osi_queue_t **) &scp->bufReadsp, &qdp->q);
1357     }
1358
1359     if (flags & CM_SCACHESYNC_STOREDATA) {
1360         /* ensure that the buffer isn't already in the I/O list */
1361         if (bufp) {
1362             for(qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1363                 tbufp = osi_GetQData(qdp);
1364                 osi_assertx(tbufp != bufp, "unexpected cm_buf_t value");
1365             }
1366         }
1367
1368         /* queue a held reference to the buffer in the "writing" I/O list */
1369         qdp = osi_QDAlloc();
1370         osi_SetQData(qdp, bufp);
1371         if (bufp) {
1372             buf_Hold(bufp);
1373             bufp->cmFlags |= CM_BUF_CMSTORING;
1374         }
1375         osi_QAdd((osi_queue_t **) &scp->bufWritesp, &qdp->q);
1376     }
1377
1378     if (flags & CM_SCACHESYNC_WRITE) {
1379         /* mark the buffer as being written to. */
1380         if (bufp) {
1381             bufp->cmFlags |= CM_BUF_CMWRITING;
1382         }
1383     }
1384
1385     return 0;
1386 }
1387
1388 /* for those syncops that setup for RPCs.
1389  * Called with scache locked.
1390  */
1391 void cm_SyncOpDone(cm_scache_t *scp, cm_buf_t *bufp, afs_uint32 flags)
1392 {
1393     osi_queueData_t *qdp;
1394     cm_buf_t *tbufp;
1395
1396     lock_AssertWrite(&scp->rw);
1397
1398     /* now, update the recorded state for RPC-type calls */
1399     if (flags & CM_SCACHESYNC_FETCHSTATUS)
1400         scp->flags &= ~CM_SCACHEFLAG_FETCHING;
1401     if (flags & CM_SCACHESYNC_STORESTATUS)
1402         scp->flags &= ~CM_SCACHEFLAG_STORING;
1403     if (flags & CM_SCACHESYNC_STORESIZE)
1404         scp->flags &= ~CM_SCACHEFLAG_SIZESTORING;
1405     if (flags & CM_SCACHESYNC_GETCALLBACK)
1406         scp->flags &= ~CM_SCACHEFLAG_GETCALLBACK;
1407     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
1408         scp->flags &= ~CM_SCACHEFLAG_DATASTORING;
1409     if (flags & CM_SCACHESYNC_ASYNCSTORE)
1410         scp->flags &= ~CM_SCACHEFLAG_ASYNCSTORING;
1411     if (flags & CM_SCACHESYNC_LOCK)
1412         scp->flags &= ~CM_SCACHEFLAG_LOCKING;
1413
1414     /* now update the buffer pointer */
1415     if (flags & CM_SCACHESYNC_FETCHDATA) {
1416         int release = 0;
1417
1418         /* ensure that the buffer isn't already in the I/O list */
1419         for(qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1420             tbufp = osi_GetQData(qdp);
1421             if (tbufp == bufp) 
1422                 break;
1423         }
1424         if (qdp) {
1425             osi_QRemove((osi_queue_t **) &scp->bufReadsp, &qdp->q);
1426             osi_QDFree(qdp);
1427             release = 1;
1428         }
1429         if (bufp) {
1430             bufp->cmFlags &= ~(CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED);
1431             if (bufp->flags & CM_BUF_WAITING) {
1432                 osi_Log2(afsd_logp, "CM SyncOpDone Waking [scp 0x%p] bufp 0x%p", scp, bufp);
1433                 osi_Wakeup((LONG_PTR) &bufp);
1434             }
1435             if (release)
1436                 buf_Release(bufp);
1437         }
1438     }
1439
1440     /* now update the buffer pointer */
1441     if (flags & CM_SCACHESYNC_STOREDATA) {
1442         int release = 0;
1443         /* ensure that the buffer isn't already in the I/O list */
1444         for(qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1445             tbufp = osi_GetQData(qdp);
1446             if (tbufp == bufp) 
1447                 break;
1448         }
1449         if (qdp) {
1450             osi_QRemove((osi_queue_t **) &scp->bufWritesp, &qdp->q);
1451             osi_QDFree(qdp);
1452             release = 1;
1453         }
1454         if (bufp) {
1455             bufp->cmFlags &= ~CM_BUF_CMSTORING;
1456             if (bufp->flags & CM_BUF_WAITING) {
1457                 osi_Log2(afsd_logp, "CM SyncOpDone Waking [scp 0x%p] bufp 0x%p", scp, bufp);
1458                 osi_Wakeup((LONG_PTR) &bufp);
1459             }
1460             if (release)
1461                 buf_Release(bufp);
1462         }
1463     }
1464
1465     if (flags & CM_SCACHESYNC_WRITE) {
1466         if (bufp) {
1467             osi_assertx(bufp->cmFlags & CM_BUF_CMWRITING, "!CM_BUF_CMWRITING");
1468
1469             bufp->cmFlags &= ~CM_BUF_CMWRITING;
1470         }
1471     }
1472
1473     /* and wakeup anyone who is waiting */
1474     if (scp->flags & CM_SCACHEFLAG_WAITING) {
1475         osi_Log1(afsd_logp, "CM SyncOpDone Waking scp 0x%p", scp);
1476         osi_Wakeup((LONG_PTR) &scp->flags);
1477     }
1478 }       
1479
1480 /* merge in a response from an RPC.  The scp must be locked, and the callback
1481  * is optional.
1482  *
1483  * Don't overwrite any status info that is dirty, since we could have a store
1484  * operation (such as store data) that merges some info in, and we don't want
1485  * to lose the local updates.  Typically, there aren't many updates we do
1486  * locally, anyway, probably only mtime.
1487  *
1488  * There is probably a bug in here where a chmod (which doesn't change
1489  * serverModTime) that occurs between two fetches, both of whose responses are
1490  * handled after the callback breaking is done, but only one of whose calls
1491  * started before that, can cause old info to be merged from the first call.
1492  */
1493 void cm_MergeStatus(cm_scache_t *dscp, 
1494                     cm_scache_t *scp, AFSFetchStatus *statusp, 
1495                     AFSVolSync *volsyncp,
1496                     cm_user_t *userp, afs_uint32 flags)
1497 {
1498     afs_uint64 dataVersion;
1499
1500     // yj: i want to create some fake status for the /afs directory and the
1501     // entries under that directory
1502 #ifdef AFS_FREELANCE_CLIENT
1503     if (cm_freelanceEnabled && scp == cm_data.rootSCachep) {
1504         osi_Log0(afsd_logp,"cm_MergeStatus Freelance cm_data.rootSCachep");
1505         statusp->InterfaceVersion = 0x1;
1506         statusp->FileType = CM_SCACHETYPE_DIRECTORY;
1507         statusp->LinkCount = scp->linkCount;
1508         statusp->Length = cm_fakeDirSize;
1509         statusp->Length_hi = 0;
1510         statusp->DataVersion = (afs_uint32)(cm_data.fakeDirVersion & 0xFFFFFFFF);
1511         statusp->Author = 0x1;
1512         statusp->Owner = 0x0;
1513         statusp->CallerAccess = 0x9;
1514         statusp->AnonymousAccess = 0x9;
1515         statusp->UnixModeBits = 0777;
1516         statusp->ParentVnode = 0x1;
1517         statusp->ParentUnique = 0x1;
1518         statusp->ResidencyMask = 0;
1519         statusp->ClientModTime = FakeFreelanceModTime;
1520         statusp->ServerModTime = FakeFreelanceModTime;
1521         statusp->Group = 0;
1522         statusp->SyncCounter = 0;
1523         statusp->dataVersionHigh = (afs_uint32)(cm_data.fakeDirVersion >> 32);
1524         statusp->errorCode = 0;
1525     }
1526 #endif /* AFS_FREELANCE_CLIENT */
1527
1528     if (statusp->errorCode != 0) {      
1529         scp->flags |= CM_SCACHEFLAG_EACCESS;
1530         osi_Log2(afsd_logp, "Merge, Failure scp %x code 0x%x", scp, statusp->errorCode);
1531
1532         scp->fileType = 0;      /* unknown */
1533
1534         scp->serverModTime = 0;
1535         scp->clientModTime = 0;
1536         scp->length.LowPart = 0;
1537         scp->length.HighPart = 0;
1538         scp->serverLength.LowPart = 0;
1539         scp->serverLength.HighPart = 0;
1540         scp->linkCount = 0;
1541         scp->owner = 0;
1542         scp->group = 0;
1543         scp->unixModeBits = 0;
1544         scp->anyAccess = 0;
1545         scp->dataVersion = 0;
1546         scp->bufDataVersionLow = 0;
1547
1548         if (dscp) {
1549             scp->parentVnode = dscp->fid.vnode;
1550             scp->parentUnique = dscp->fid.unique;
1551         } else {
1552             scp->parentVnode = 0;
1553             scp->parentUnique = 0;
1554         }
1555         return;
1556     } else {
1557         scp->flags &= ~CM_SCACHEFLAG_EACCESS;
1558     }
1559
1560     dataVersion = statusp->dataVersionHigh;
1561     dataVersion <<= 32;
1562     dataVersion |= statusp->DataVersion;
1563
1564     if (!(flags & CM_MERGEFLAG_FORCE) && dataVersion < scp->dataVersion) {
1565         struct cm_cell *cellp;
1566
1567         cellp = cm_FindCellByID(scp->fid.cell, 0);
1568         if (scp->cbServerp) {
1569             struct cm_volume *volp = NULL;
1570
1571             cm_GetVolumeByID(cellp, scp->fid.volume, userp,
1572                               (cm_req_t *) NULL, CM_GETVOL_FLAG_CREATE, &volp);
1573             osi_Log2(afsd_logp, "old data from server %x volume %s",
1574                       scp->cbServerp->addr.sin_addr.s_addr,
1575                       volp ? volp->namep : "(unknown)");
1576             if (volp)
1577                 cm_PutVolume(volp);
1578         }
1579         osi_Log3(afsd_logp, "Bad merge, scp %x, scp dv %d, RPC dv %d",
1580                   scp, scp->dataVersion, dataVersion);
1581         /* we have a number of data fetch/store operations running
1582          * concurrently, and we can tell which one executed last at the
1583          * server by its mtime.
1584          * Choose the one with the largest mtime, and ignore the rest.
1585          *
1586          * These concurrent calls are incompatible with setting the
1587          * mtime, so we won't have a locally changed mtime here.
1588          *
1589          * We could also have ACL info for a different user than usual,
1590          * in which case we have to do that part of the merge, anyway.
1591          * We won't have to worry about the info being old, since we
1592          * won't have concurrent calls
1593          * that change file status running from this machine.
1594          *
1595          * Added 3/17/98:  if we see data version regression on an RO
1596          * file, it's probably due to a server holding an out-of-date
1597          * replica, rather than to concurrent RPC's.  Failures to
1598          * release replicas are now flagged by the volserver, but only
1599          * since AFS 3.4 5.22, so there are plenty of clients getting
1600          * out-of-date replicas out there.
1601          *
1602          * If we discover an out-of-date replica, by this time it's too
1603          * late to go to another server and retry.  Also, we can't
1604          * reject the merge, because then there is no way for
1605          * GetAccess to do its work, and the caller gets into an
1606          * infinite loop.  So we just grin and bear it.
1607          */
1608         if (!(scp->flags & CM_SCACHEFLAG_RO))
1609             return;
1610     }       
1611
1612     scp->serverModTime = statusp->ServerModTime;
1613
1614     if (!(scp->mask & CM_SCACHEMASK_CLIENTMODTIME)) {
1615         scp->clientModTime = statusp->ClientModTime;
1616     }
1617     if (!(scp->mask & CM_SCACHEMASK_LENGTH)) {
1618         scp->length.LowPart = statusp->Length;
1619         scp->length.HighPart = statusp->Length_hi;
1620     }
1621
1622     scp->serverLength.LowPart = statusp->Length;
1623     scp->serverLength.HighPart = statusp->Length_hi;
1624
1625     scp->linkCount = statusp->LinkCount;
1626     scp->owner = statusp->Owner;
1627     scp->group = statusp->Group;
1628     scp->unixModeBits = statusp->UnixModeBits & 07777;
1629
1630     if (statusp->FileType == File)
1631         scp->fileType = CM_SCACHETYPE_FILE;
1632     else if (statusp->FileType == Directory)
1633         scp->fileType = CM_SCACHETYPE_DIRECTORY;
1634     else if (statusp->FileType == SymbolicLink) {
1635         if ((scp->unixModeBits & 0111) == 0)
1636             scp->fileType = CM_SCACHETYPE_MOUNTPOINT;
1637         else
1638             scp->fileType = CM_SCACHETYPE_SYMLINK;
1639     }       
1640     else {
1641         osi_Log2(afsd_logp, "Merge, Invalid File Type (%d), scp %x", statusp->FileType, scp);
1642         scp->fileType = CM_SCACHETYPE_INVALID;  /* invalid */
1643     }
1644     /* and other stuff */
1645     scp->parentVnode = statusp->ParentVnode;
1646     scp->parentUnique = statusp->ParentUnique;
1647         
1648     /* and merge in the private acl cache info, if this is more than the public
1649      * info; merge in the public stuff in any case.
1650      */
1651     scp->anyAccess = statusp->AnonymousAccess;
1652
1653     if (userp != NULL) {
1654         cm_AddACLCache(scp, userp, statusp->CallerAccess);
1655     }
1656
1657     if (scp->dataVersion != 0 &&
1658         (!(flags & CM_MERGEFLAG_DIROP) && dataVersion != scp->dataVersion ||
1659          (flags & CM_MERGEFLAG_DIROP) && dataVersion - scp->dataVersion > 1)) {
1660         /* 
1661          * We now know that all of the data buffers that we have associated
1662          * with this scp are invalid.  Subsequent operations will go faster
1663          * if the buffers are removed from the hash tables.
1664          *
1665          * We do not remove directory buffers if the dataVersion delta is 1 because
1666          * those version numbers will be updated as part of the directory operation.
1667          */
1668         int i, j;
1669         cm_buf_t **lbpp;
1670         cm_buf_t *tbp;
1671         cm_buf_t *bp, *prevBp, *nextBp;
1672
1673         lock_ObtainWrite(&buf_globalLock);
1674         i = BUF_FILEHASH(&scp->fid);
1675         for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=nextBp)
1676         {
1677             nextBp = bp->fileHashp;
1678             /* 
1679              * if the buffer belongs to this stat cache entry
1680              * and the buffer mutex can be obtained, check the
1681              * reference count and if it is zero, remove the buffer
1682              * from the hash tables.  If there are references,
1683              * the buffer might be updated to the current version
1684              * so leave it in place.
1685              */
1686             if (cm_FidCmp(&scp->fid, &bp->fid) == 0 &&
1687                  lock_TryMutex(&bp->mx)) {
1688                 if (bp->refCount == 0 && 
1689                     !(bp->flags & CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)) {
1690                     prevBp = bp->fileHashBackp;
1691                     bp->fileHashBackp = bp->fileHashp = NULL;
1692                     if (prevBp)
1693                         prevBp->fileHashp = nextBp;
1694                     else
1695                         cm_data.buf_fileHashTablepp[i] = nextBp;
1696                     if (nextBp)
1697                         nextBp->fileHashBackp = prevBp;
1698
1699                     j = BUF_HASH(&bp->fid, &bp->offset);
1700                     lbpp = &(cm_data.buf_scacheHashTablepp[j]);
1701                     for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = *lbpp) {
1702                         if (tbp == bp) 
1703                             break;
1704                     }
1705
1706                     *lbpp = bp->hashp;  /* hash out */
1707                     bp->hashp = NULL;
1708
1709                     bp->flags &= ~CM_BUF_INHASH;
1710                 }
1711                 lock_ReleaseMutex(&bp->mx);
1712             }
1713         }
1714         lock_ReleaseWrite(&buf_globalLock);
1715     }
1716
1717     /* We maintain a range of buffer dataVersion values which are considered 
1718      * valid.  This avoids the need to update the dataVersion on each buffer
1719      * object during an uncontested storeData operation.  As a result this 
1720      * merge status no longer has performance characteristics derived from
1721      * the size of the file.
1722      */
1723     if (((flags & CM_MERGEFLAG_STOREDATA) && dataVersion - scp->dataVersion > 1) || 
1724          (!(flags & CM_MERGEFLAG_STOREDATA) && scp->dataVersion != dataVersion) ||
1725          scp->bufDataVersionLow == 0)
1726         scp->bufDataVersionLow = dataVersion;
1727     
1728     scp->dataVersion = dataVersion;
1729 }
1730
1731 /* note that our stat cache info is incorrect, so force us eventually
1732  * to stat the file again.  There may be dirty data associated with
1733  * this vnode, and we want to preserve that information.
1734  *
1735  * This function works by simply simulating a loss of the callback.
1736  *
1737  * This function must be called with the scache locked.
1738  */
1739 void cm_DiscardSCache(cm_scache_t *scp)
1740 {
1741     lock_AssertWrite(&scp->rw);
1742     if (scp->cbServerp) {
1743         cm_PutServer(scp->cbServerp);
1744         scp->cbServerp = NULL;
1745     }
1746     scp->cbExpires = 0;
1747     scp->flags &= ~CM_SCACHEFLAG_CALLBACK;
1748     cm_dnlcPurgedp(scp);
1749     cm_dnlcPurgevp(scp);
1750     cm_FreeAllACLEnts(scp);
1751
1752     if (scp->fileType == CM_SCACHETYPE_DFSLINK)
1753         cm_VolStatus_Invalidate_DFS_Mapping(scp);
1754
1755     /* Force mount points and symlinks to be re-evaluated */
1756     scp->mountPointStringp[0] = '\0';
1757 }
1758
1759 void cm_AFSFidFromFid(AFSFid *afsFidp, cm_fid_t *fidp)
1760 {
1761     afsFidp->Volume = fidp->volume;
1762     afsFidp->Vnode = fidp->vnode;
1763     afsFidp->Unique = fidp->unique;
1764 }       
1765
1766 #ifdef DEBUG_REFCOUNT
1767 void cm_HoldSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
1768 #else
1769 void cm_HoldSCacheNoLock(cm_scache_t *scp)
1770 #endif
1771 {     
1772     afs_int32 refCount;
1773
1774     osi_assertx(scp != NULL, "null cm_scache_t");
1775     lock_AssertAny(&cm_scacheLock);
1776     refCount = InterlockedIncrement(&scp->refCount);
1777 #ifdef DEBUG_REFCOUNT
1778     osi_Log2(afsd_logp,"cm_HoldSCacheNoLock scp 0x%p ref %d",scp, refCount);
1779     afsi_log("%s:%d cm_HoldSCacheNoLock scp 0x%p, ref %d", file, line, scp, refCount);
1780 #endif
1781 }
1782
1783 #ifdef DEBUG_REFCOUNT
1784 void cm_HoldSCacheDbg(cm_scache_t *scp, char * file, long line)
1785 #else
1786 void cm_HoldSCache(cm_scache_t *scp)
1787 #endif
1788 {
1789     afs_int32 refCount;
1790
1791     osi_assertx(scp != NULL, "null cm_scache_t");
1792     lock_ObtainRead(&cm_scacheLock);
1793     refCount = InterlockedIncrement(&scp->refCount);
1794 #ifdef DEBUG_REFCOUNT
1795     osi_Log2(afsd_logp,"cm_HoldSCache scp 0x%p ref %d",scp, refCount);
1796     afsi_log("%s:%d cm_HoldSCache scp 0x%p ref %d", file, line, scp, refCount);
1797 #endif
1798     lock_ReleaseRead(&cm_scacheLock);
1799 }
1800
1801 #ifdef DEBUG_REFCOUNT
1802 void cm_ReleaseSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
1803 #else
1804 void cm_ReleaseSCacheNoLock(cm_scache_t *scp)
1805 #endif
1806 {
1807     afs_int32 refCount;
1808     osi_assertx(scp != NULL, "null cm_scache_t");
1809     lock_AssertAny(&cm_scacheLock);
1810     refCount = InterlockedDecrement(&scp->refCount);
1811 #ifdef DEBUG_REFCOUNT
1812     if (refCount < 0)
1813         osi_Log1(afsd_logp,"cm_ReleaseSCacheNoLock about to panic scp 0x%x",scp);
1814 #endif
1815     osi_assertx(refCount >= 0, "cm_scache_t refCount 0");
1816 #ifdef DEBUG_REFCOUNT
1817     osi_Log2(afsd_logp,"cm_ReleaseSCacheNoLock scp 0x%p ref %d",scp, refCount);
1818     afsi_log("%s:%d cm_ReleaseSCacheNoLock scp 0x%p ref %d", file, line, scp, refCount);
1819 #endif
1820 }
1821
1822 #ifdef DEBUG_REFCOUNT
1823 void cm_ReleaseSCacheDbg(cm_scache_t *scp, char * file, long line)
1824 #else
1825 void cm_ReleaseSCache(cm_scache_t *scp)
1826 #endif
1827 {     
1828     afs_int32 refCount;
1829
1830     osi_assertx(scp != NULL, "null cm_scache_t");
1831     lock_ObtainRead(&cm_scacheLock);
1832     refCount = InterlockedDecrement(&scp->refCount);
1833 #ifdef DEBUG_REFCOUNT
1834     if (refCount < 0)
1835         osi_Log1(afsd_logp,"cm_ReleaseSCache about to panic scp 0x%x",scp);
1836 #endif
1837     osi_assertx(refCount >= 0, "cm_scache_t refCount 0");
1838 #ifdef DEBUG_REFCOUNT
1839     osi_Log2(afsd_logp,"cm_ReleaseSCache scp 0x%p ref %d",scp, refCount);
1840     afsi_log("%s:%d cm_ReleaseSCache scp 0x%p ref %d", file, line, scp, refCount);
1841 #endif
1842     lock_ReleaseRead(&cm_scacheLock);
1843 }
1844
1845 /* just look for the scp entry to get filetype */
1846 /* doesn't need to be perfectly accurate, so locking doesn't matter too much */
1847 int cm_FindFileType(cm_fid_t *fidp)
1848 {
1849     long hash;
1850     cm_scache_t *scp;
1851         
1852     hash = CM_SCACHE_HASH(fidp);
1853         
1854     osi_assertx(fidp->cell != 0, "unassigned cell value");
1855
1856     lock_ObtainWrite(&cm_scacheLock);
1857     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
1858         if (cm_FidCmp(fidp, &scp->fid) == 0) {
1859             lock_ReleaseWrite(&cm_scacheLock);
1860             return scp->fileType;
1861         }
1862     }
1863     lock_ReleaseWrite(&cm_scacheLock);
1864     return 0;
1865 }
1866
1867 /* dump all scp's that have reference count > 0 to a file. 
1868  * cookie is used to identify this batch for easy parsing, 
1869  * and it a string provided by a caller 
1870  */
1871 int cm_DumpSCache(FILE *outputFile, char *cookie, int lock)
1872 {
1873     int zilch;
1874     cm_scache_t *scp;
1875     char output[2048];
1876     int i;
1877   
1878     if (lock)
1879         lock_ObtainRead(&cm_scacheLock);
1880   
1881     sprintf(output, "%s - dumping all scache - cm_data.currentSCaches=%d, cm_data.maxSCaches=%d\r\n", cookie, cm_data.currentSCaches, cm_data.maxSCaches);
1882     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1883   
1884     for (scp = cm_data.allSCachesp; scp; scp = scp->allNextp) 
1885     {
1886         sprintf(output, "%s scp=0x%p, fid (cell=%d, volume=%d, vnode=%d, unique=%d) volp=0x%p type=%d dv=%I64d len=0x%I64x mp='%s' flags=0x%x cb=0x%x refCount=%u\r\n", 
1887                 cookie, scp, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique, 
1888                 scp->volp, scp->fileType, scp->dataVersion, scp->length.QuadPart, scp->mountPointStringp, scp->flags,
1889                 (unsigned long)scp->cbExpires, scp->refCount);
1890         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1891     }
1892   
1893     sprintf(output, "%s - Done dumping all scache.\r\n", cookie);
1894     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1895     sprintf(output, "%s - dumping cm_data.scacheHashTable - cm_data.scacheHashTableSize=%d\r\n", cookie, cm_data.scacheHashTableSize);
1896     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1897   
1898     for (i = 0; i < cm_data.scacheHashTableSize; i++)
1899     {
1900         for(scp = cm_data.scacheHashTablep[i]; scp; scp=scp->nextp) 
1901         {
1902             sprintf(output, "%s scp=0x%p, hash=%d, fid (cell=%d, volume=%d, vnode=%d, unique=%d)\r\n", 
1903                     cookie, scp, i, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
1904             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1905         }
1906     }
1907
1908     sprintf(output, "%s - Done dumping cm_data.scacheHashTable\r\n", cookie);
1909     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1910   
1911     if (lock)
1912         lock_ReleaseRead(&cm_scacheLock);       
1913     return (0);     
1914 }
1915