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