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