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