cee14f29e1635b344f8b5a5e31ece215944313ba
[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 <afsconfig.h>
11 #include <afs/param.h>
12 #include <afs/stds.h>
13
14 #include <roken.h>
15
16 #include <windows.h>
17 #include <winsock2.h>
18 #include <nb30.h>
19 #include <malloc.h>
20 #include <string.h>
21 #include <stdlib.h>
22 #include <osi.h>
23
24 #include "afsd.h"
25 #include "cm_btree.h"
26 #include <afs/unified_afs.h>
27
28 /*extern void afsi_log(char *pattern, ...);*/
29
30 extern osi_hyper_t hzero;
31
32 /* File locks */
33 osi_queue_t *cm_allFileLocks;
34 osi_queue_t *cm_freeFileLocks;
35 unsigned long cm_lockRefreshCycle;
36
37 /* lock for globals */
38 osi_rwlock_t cm_scacheLock;
39
40 /* Dummy scache entry for use with pioctl fids */
41 cm_scache_t cm_fakeSCache;
42
43 osi_queue_t * cm_allFreeWaiters;        /* protected by cm_scacheLock */
44
45 #ifdef AFS_FREELANCE_CLIENT
46 extern osi_mutex_t cm_Freelance_Lock;
47 #endif
48
49 cm_scache_t *
50 cm_RootSCachep(cm_user_t *userp, cm_req_t *reqp)
51 {
52     afs_int32 code;
53
54     lock_ObtainWrite(&cm_data.rootSCachep->rw);
55     code = cm_SyncOp(cm_data.rootSCachep, NULL, userp, reqp, 0,
56                       CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_NEEDCALLBACK);
57     if (!code)
58         cm_SyncOpDone(cm_data.rootSCachep, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
59     lock_ReleaseWrite(&cm_data.rootSCachep->rw);
60
61     return cm_data.rootSCachep;
62 }
63
64
65 /* must be called with cm_scacheLock write-locked! */
66 void cm_AdjustScacheLRU(cm_scache_t *scp)
67 {
68     lock_AssertWrite(&cm_scacheLock);
69     if (!(scp->flags & CM_SCACHEFLAG_DELETED)) {
70         osi_QRemoveHT((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **) &cm_data.scacheLRULastp, &scp->q);
71         osi_QAddH((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **) &cm_data.scacheLRULastp, &scp->q);
72     }
73 }
74
75 /* call with cm_scacheLock write-locked and scp rw held */
76 void cm_RemoveSCacheFromHashTable(cm_scache_t *scp)
77 {
78     cm_scache_t **lscpp;
79     cm_scache_t *tscp;
80     int i;
81
82     lock_AssertWrite(&cm_scacheLock);
83     lock_AssertWrite(&scp->rw);
84     if (scp->flags & CM_SCACHEFLAG_INHASH) {
85         /* hash it out first */
86         i = CM_SCACHE_HASH(&scp->fid);
87         for (lscpp = &cm_data.scacheHashTablep[i], tscp = cm_data.scacheHashTablep[i];
88              tscp;
89              lscpp = &tscp->nextp, tscp = tscp->nextp) {
90             if (tscp == scp) {
91                 *lscpp = scp->nextp;
92                 scp->nextp = NULL;
93                 _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_INHASH);
94                 break;
95             }
96         }
97     }
98 }
99
100 /* called with cm_scacheLock and scp write-locked */
101 void cm_ResetSCacheDirectory(cm_scache_t *scp, afs_int32 dirlock)
102 {
103 #ifdef USE_BPLUS
104     /* destroy directory Bplus Tree */
105     if (scp->dirBplus) {
106         LARGE_INTEGER start, end;
107
108         if (!dirlock && !lock_TryWrite(&scp->dirlock)) {
109             /*
110              * We are not holding the dirlock and obtaining it
111              * requires that we drop the scp->rw.  As a result
112              * we will leave the dirBplus tree intact but
113              * invalidate the version number so that whatever
114              * operation is currently active can safely complete
115              * but the contents will be ignored on the next
116              * directory operation.
117              */
118             scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
119             return;
120         }
121
122         QueryPerformanceCounter(&start);
123         bplus_free_tree++;
124         freeBtree(scp->dirBplus);
125         scp->dirBplus = NULL;
126         scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
127         QueryPerformanceCounter(&end);
128
129         if (!dirlock)
130             lock_ReleaseWrite(&scp->dirlock);
131
132         bplus_free_time += (end.QuadPart - start.QuadPart);
133     }
134 #endif
135 }
136
137 /* called with cm_scacheLock and scp write-locked; recycles an existing scp. */
138 long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags)
139 {
140     cm_fid_t fid;
141     afs_uint32 fileType;
142     int callback;
143
144     lock_AssertWrite(&cm_scacheLock);
145     lock_AssertWrite(&scp->rw);
146
147     if (scp->refCount != 0) {
148         return -1;
149     }
150
151     if (scp->flags & CM_SCACHEFLAG_SMB_FID) {
152         osi_Log1(afsd_logp,"cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected scp 0x%p", scp);
153 #ifdef DEBUG
154         osi_panic("cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected",__FILE__,__LINE__);
155 #endif
156         return -1;
157     }
158
159     if (scp->redirBufCount != 0) {
160         return -1;
161     }
162
163     fid = scp->fid;
164     fileType = scp->fileType;
165     callback = scp->cbExpires ? 1 : 0;
166
167     cm_RemoveSCacheFromHashTable(scp);
168
169     if (scp->fileType == CM_SCACHETYPE_DIRECTORY &&
170          !cm_accessPerFileCheck) {
171         cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
172
173         if (volp) {
174             if (!(volp->flags & CM_VOLUMEFLAG_DFS_VOLUME))
175                 cm_EAccesClearParentEntries(&fid);
176
177             cm_PutVolume(volp);
178         }
179     }
180
181     /* invalidate so next merge works fine;
182      * also initialize some flags */
183     scp->fileType = 0;
184     _InterlockedAnd(&scp->flags,
185                     ~( CM_SCACHEFLAG_DELETED
186                      | CM_SCACHEFLAG_RO
187                      | CM_SCACHEFLAG_PURERO
188                      | CM_SCACHEFLAG_OVERQUOTA
189                      | CM_SCACHEFLAG_OUTOFSPACE));
190     scp->serverModTime = 0;
191     scp->dataVersion = CM_SCACHE_VERSION_BAD;
192     scp->bufDataVersionLow = CM_SCACHE_VERSION_BAD;
193     scp->bulkStatProgress = hzero;
194     scp->waitCount = 0;
195     scp->waitQueueT = NULL;
196
197     if (scp->cbServerp) {
198         cm_PutServer(scp->cbServerp);
199         scp->cbServerp = NULL;
200     }
201     scp->cbExpires = 0;
202     scp->cbIssued = 0;
203     scp->volumeCreationDate = 0;
204
205     scp->fid.vnode = 0;
206     scp->fid.volume = 0;
207     scp->fid.unique = 0;
208     scp->fid.cell = 0;
209     scp->fid.hash = 0;
210
211     /* remove from dnlc */
212     cm_dnlcPurgedp(scp);
213     cm_dnlcPurgevp(scp);
214
215     /* discard cached status; if non-zero, Close
216      * tried to store this to server but failed */
217     scp->mask = 0;
218
219     /* discard symlink info */
220     scp->mpDataVersion = CM_SCACHE_VERSION_BAD;
221     scp->mountPointStringp[0] = '\0';
222     memset(&scp->mountRootFid, 0, sizeof(cm_fid_t));
223     memset(&scp->dotdotFid, 0, sizeof(cm_fid_t));
224
225     /* reset locking info */
226     scp->fileLocksH = NULL;
227     scp->fileLocksT = NULL;
228     scp->serverLock = (-1);
229     scp->exclusiveLocks = 0;
230     scp->sharedLocks = 0;
231     scp->lockDataVersion = CM_SCACHE_VERSION_BAD;
232     scp->fsLockCount = 0;
233
234     /* not locked, but there can be no references to this guy
235      * while we hold the global refcount lock.
236      */
237     cm_FreeAllACLEnts(scp);
238
239     cm_ResetSCacheDirectory(scp, 0);
240
241     if (RDR_Initialized && callback) {
242         /*
243         * We drop the cm_scacheLock because it may be required to
244         * satisfy an ioctl request from the redirector.  It should
245         * be safe to hold the scp->rw lock here because at this
246         * point (a) the object has just been recycled so the fid
247         * is nul and there are no requests that could possibly
248         * be issued by the redirector that would depend upon it.
249         */
250         lock_ReleaseWrite(&cm_scacheLock);
251         RDR_InvalidateObject( fid.cell, fid.volume, fid.vnode,
252                               fid.unique, fid.hash,
253                               fileType, AFS_INVALIDATE_EXPIRED);
254         lock_ObtainWrite(&cm_scacheLock);
255     }
256
257     return 0;
258 }
259
260
261 /*
262  * called with cm_scacheLock write-locked; find a vnode to recycle.
263  * Can allocate a new one if desperate, or if below quota (cm_data.maxSCaches).
264  * returns scp->rw write-locked.
265  */
266 cm_scache_t *
267 cm_GetNewSCache(afs_uint32 locked)
268 {
269     cm_scache_t *scp = NULL;
270     cm_scache_t *scp_prev = NULL;
271     cm_scache_t *scp_next = NULL;
272     int attempt = 0;
273
274     if (locked)
275         lock_AssertWrite(&cm_scacheLock);
276     else
277         lock_ObtainWrite(&cm_scacheLock);
278
279     if (cm_data.currentSCaches >= cm_data.maxSCaches) {
280         /* There were no deleted scache objects that we could use.  Try to find
281          * one that simply hasn't been used in a while.
282          */
283         for (attempt = 0 ; attempt < 128; attempt++) {
284             afs_uint32 count = 0;
285
286             for ( scp = cm_data.scacheLRULastp;
287                   scp;
288                   scp = (cm_scache_t *) osi_QPrev(&scp->q))
289             {
290                 /*
291                  * We save the prev and next pointers in the
292                  * LRU because we are going to drop the cm_scacheLock and
293                  * the order of the list could change out from beneath us.
294                  * If both changed, it means that this entry has been moved
295                  * within the LRU and it should no longer be recycled.
296                  */
297                 scp_prev = (cm_scache_t *) osi_QPrev(&scp->q);
298                 scp_next = (cm_scache_t *) osi_QNext(&scp->q);
299                 count++;
300
301                 /* It is possible for the refCount to be zero and for there still
302                  * to be outstanding dirty buffers.  If there are dirty buffers,
303                  * we must not recycle the scp.
304                  *
305                  * If the object is in use by the redirector, then avoid recycling
306                  * it unless we have to.
307                  */
308                 if (scp->refCount == 0 && scp->bufReadsp == NULL && scp->bufWritesp == NULL) {
309                     afs_uint32 buf_dirty = 0;
310                     afs_uint32 buf_rdr = 0;
311
312                     lock_ReleaseWrite(&cm_scacheLock);
313                     buf_dirty = buf_DirtyBuffersExist(&scp->fid);
314                     if (!buf_dirty)
315                         buf_rdr = buf_RDRBuffersExist(&scp->fid);
316
317                     if (!buf_dirty && !buf_rdr) {
318                         cm_fid_t   fid;
319                         afs_uint32 fileType;
320                         int        success;
321
322                         success = lock_TryWrite(&scp->rw);
323
324                         lock_ObtainWrite(&cm_scacheLock);
325                         if (scp_prev != (cm_scache_t *) osi_QPrev(&scp->q) &&
326                             scp_next != (cm_scache_t *) osi_QNext(&scp->q))
327                         {
328                             osi_Log1(afsd_logp, "GetNewSCache scp 0x%p; LRU order changed", scp);
329                             if (success)
330                                 lock_ReleaseWrite(&scp->rw);
331                             break;
332                         } else if (!success) {
333                                 osi_Log1(afsd_logp, "GetNewSCache failed to obtain lock scp 0x%p", scp);
334                                 continue;
335                         }
336
337                         /* Found a likely candidate.  Save type and fid in case we succeed */
338                         fid = scp->fid;
339                         fileType = scp->fileType;
340
341                         if (!cm_RecycleSCache(scp, 0)) {
342                             /* we found an entry, so return it.
343                              * remove from the LRU queue and put it back at the
344                              * head of the LRU queue.
345                              */
346                             cm_AdjustScacheLRU(scp);
347
348                             /* and we're done - SUCCESS */
349                             osi_assertx(!(scp->flags & CM_SCACHEFLAG_INHASH), "CM_SCACHEFLAG_INHASH set");
350                             goto done;
351                         }
352                         lock_ReleaseWrite(&scp->rw);
353                     } else {
354                         if (buf_rdr)
355                             osi_Log1(afsd_logp,"GetNewSCache redirector is holding extents scp 0x%p", scp);
356                         else
357                             osi_Log1(afsd_logp, "GetNewSCache dirty buffers scp 0x%p", scp);
358
359                         lock_ObtainWrite(&cm_scacheLock);
360                         if (scp_prev != (cm_scache_t *) osi_QPrev(&scp->q) &&
361                             scp_next != (cm_scache_t *) osi_QNext(&scp->q))
362                         {
363                             osi_Log1(afsd_logp, "GetNewSCache scp 0x%p; LRU order changed", scp);
364                             break;
365                         }
366                     }
367                 }
368             } /* for */
369
370             osi_Log2(afsd_logp, "GetNewSCache all scache entries in use (attempt = %d, count = %u)", attempt, count);
371             if (scp == NULL) {
372                 /*
373                 * The entire LRU queue was walked and no available cm_scache_t was
374                 * found.  Drop the cm_scacheLock and sleep for a moment to give a
375                 * chance for cm_scache_t objects to be released.
376                 */
377                 lock_ReleaseWrite(&cm_scacheLock);
378                 Sleep(50);
379                 lock_ObtainWrite(&cm_scacheLock);
380             }
381         }
382         /* FAILURE */
383         scp = NULL;
384         goto done;
385     }
386
387     /* if we get here, we should allocate a new scache entry.  We either are below
388      * quota or we have a leak and need to allocate a new one to avoid panicing.
389      */
390     scp = cm_data.scacheBaseAddress + InterlockedIncrement(&cm_data.currentSCaches) - 1;
391     osi_assertx(scp >= cm_data.scacheBaseAddress && scp < (cm_scache_t *)cm_data.scacheHashTablep,
392                 "invalid cm_scache_t address");
393     memset(scp, 0, sizeof(cm_scache_t));
394     scp->magic = CM_SCACHE_MAGIC;
395     lock_InitializeRWLock(&scp->rw, "cm_scache_t rw", LOCK_HIERARCHY_SCACHE);
396     osi_assertx(lock_TryWrite(&scp->rw), "cm_scache_t rw held after allocation");
397     lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock", LOCK_HIERARCHY_SCACHE_BUFCREATE);
398 #ifdef USE_BPLUS
399     lock_InitializeRWLock(&scp->dirlock, "cm_scache_t dirlock", LOCK_HIERARCHY_SCACHE_DIRLOCK);
400 #endif
401     lock_InitializeMutex(&scp->redirMx, "cm_scache_t redirMx", LOCK_HIERARCHY_SCACHE_REDIRMX);
402     scp->serverLock = -1;
403     scp->dataVersion = CM_SCACHE_VERSION_BAD;
404     scp->bufDataVersionLow = CM_SCACHE_VERSION_BAD;
405     scp->lockDataVersion = CM_SCACHE_VERSION_BAD;
406
407     /* and put it in the LRU queue */
408     osi_QAddH((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **)&cm_data.scacheLRULastp, &scp->q);
409     cm_dnlcPurgedp(scp); /* make doubly sure that this is not in dnlc */
410     cm_dnlcPurgevp(scp);
411     scp->allNextp = cm_data.allSCachesp;
412     cm_data.allSCachesp = scp;
413
414   done:
415     if (!locked)
416         lock_ReleaseWrite(&cm_scacheLock);
417
418     return scp;
419 }
420
421 void cm_SetFid(cm_fid_t *fidp, afs_uint32 cell, afs_uint32 volume, afs_uint32 vnode, afs_uint32 unique)
422 {
423     fidp->cell = cell;
424     fidp->volume = volume;
425     fidp->vnode = vnode;
426     fidp->unique = unique;
427     CM_FID_GEN_HASH(fidp);
428 }
429
430 /* like strcmp, only for fids */
431 __inline int cm_FidCmp(cm_fid_t *ap, cm_fid_t *bp)
432 {
433     if (ap->hash != bp->hash)
434         return 1;
435     if (ap->vnode != bp->vnode)
436         return 1;
437     if (ap->volume != bp->volume)
438         return 1;
439     if (ap->unique != bp->unique)
440         return 1;
441     if (ap->cell != bp->cell)
442         return 1;
443     return 0;
444 }
445
446 void cm_fakeSCacheInit(int newFile)
447 {
448     if ( newFile ) {
449         memset(&cm_data.fakeSCache, 0, sizeof(cm_scache_t));
450         cm_data.fakeSCache.magic = CM_SCACHE_MAGIC;
451         cm_data.fakeSCache.cbServerp = (struct cm_server *)(-1);
452         cm_data.fakeSCache.cbExpires = (time_t)-1;
453         cm_data.fakeSCache.cbExpires = time(NULL);
454         /* can leave clientModTime at 0 */
455         cm_data.fakeSCache.fileType = CM_SCACHETYPE_FILE;
456         cm_data.fakeSCache.unixModeBits = 0777;
457         cm_data.fakeSCache.length.LowPart = 1000;
458         cm_data.fakeSCache.linkCount = 1;
459         cm_data.fakeSCache.refCount = 1;
460         cm_data.fakeSCache.serverLock = -1;
461         cm_data.fakeSCache.dataVersion = CM_SCACHE_VERSION_BAD;
462     }
463     lock_InitializeRWLock(&cm_data.fakeSCache.rw, "cm_scache_t rw", LOCK_HIERARCHY_SCACHE);
464     lock_InitializeRWLock(&cm_data.fakeSCache.bufCreateLock, "cm_scache_t bufCreateLock", LOCK_HIERARCHY_SCACHE_BUFCREATE);
465     lock_InitializeRWLock(&cm_data.fakeSCache.dirlock, "cm_scache_t dirlock", LOCK_HIERARCHY_SCACHE_DIRLOCK);
466     lock_InitializeMutex(&cm_data.fakeSCache.redirMx, "cm_scache_t redirMx", LOCK_HIERARCHY_SCACHE_REDIRMX);
467 }
468
469 long
470 cm_ValidateSCache(void)
471 {
472     cm_scache_t * scp, *lscp;
473     long i;
474
475     if ( cm_data.scacheLRUFirstp == NULL && cm_data.scacheLRULastp != NULL ||
476          cm_data.scacheLRUFirstp != NULL && cm_data.scacheLRULastp == NULL) {
477         afsi_log("cm_ValidateSCache failure: inconsistent LRU pointers");
478         fprintf(stderr, "cm_ValidateSCache failure: inconsistent LRU pointers\n");
479         return -17;
480     }
481
482     for ( scp = cm_data.scacheLRUFirstp, lscp = NULL, i = 0;
483           scp;
484           lscp = scp, scp = (cm_scache_t *) osi_QNext(&scp->q), i++ ) {
485         if (scp->magic != CM_SCACHE_MAGIC) {
486             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
487             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
488             return -1;
489         }
490         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
491             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
492             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
493             return -2;
494         }
495         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
496             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
497             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
498             return -3;
499         }
500         if (i > cm_data.currentSCaches ) {
501             afsi_log("cm_ValidateSCache failure: LRU First queue loops");
502             fprintf(stderr, "cm_ValidateSCache failure: LUR First queue loops\n");
503             return -13;
504         }
505         if (lscp != (cm_scache_t *) osi_QPrev(&scp->q)) {
506             afsi_log("cm_ValidateSCache failure: QPrev(scp) != previous");
507             fprintf(stderr, "cm_ValidateSCache failure: QPrev(scp) != previous\n");
508             return -15;
509         }
510     }
511
512     for ( scp = cm_data.scacheLRULastp, lscp = NULL, i = 0; scp;
513           lscp = scp, scp = (cm_scache_t *) osi_QPrev(&scp->q), i++ ) {
514         if (scp->magic != CM_SCACHE_MAGIC) {
515             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
516             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
517             return -5;
518         }
519         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
520             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
521             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
522             return -6;
523         }
524         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
525             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
526             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
527             return -7;
528         }
529         if (i > cm_data.currentSCaches ) {
530             afsi_log("cm_ValidateSCache failure: LRU Last queue loops");
531             fprintf(stderr, "cm_ValidateSCache failure: LUR Last queue loops\n");
532             return -14;
533         }
534         if (lscp != (cm_scache_t *) osi_QNext(&scp->q)) {
535             afsi_log("cm_ValidateSCache failure: QNext(scp) != next");
536             fprintf(stderr, "cm_ValidateSCache failure: QNext(scp) != next\n");
537             return -16;
538         }
539     }
540
541     for ( i=0; i < cm_data.scacheHashTableSize; i++ ) {
542         for ( scp = cm_data.scacheHashTablep[i]; scp; scp = scp->nextp ) {
543             afs_uint32 hash;
544             hash = CM_SCACHE_HASH(&scp->fid);
545             if (scp->magic != CM_SCACHE_MAGIC) {
546                 afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
547                 fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
548                 return -9;
549             }
550             if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
551                 afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
552                 fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
553                 return -10;
554             }
555             if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
556                 afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
557                 fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
558                 return -11;
559             }
560             if (hash != i) {
561                 afsi_log("cm_ValidateSCache failure: scp hash != hash index");
562                 fprintf(stderr, "cm_ValidateSCache failure: scp hash != hash index\n");
563                 return -13;
564             }
565         }
566     }
567
568     return cm_dnlcValidate();
569 }
570
571 void
572 cm_SuspendSCache(void)
573 {
574     cm_scache_t * scp;
575     time_t now;
576
577     cm_GiveUpAllCallbacksAllServersMulti(TRUE);
578
579     /*
580      * After this call all servers are marked down.
581      * Do not clear the callbacks, instead change the
582      * expiration time so that the callbacks will be expired
583      * when the servers are marked back up.  However, we
584      * want the callbacks to be preserved as long as the
585      * servers are down.  That way if the machine resumes
586      * without network, the stat cache item will still be
587      * considered valid.
588      */
589     now = time(NULL);
590
591     lock_ObtainWrite(&cm_scacheLock);
592     for ( scp = cm_data.allSCachesp; scp; scp = scp->allNextp ) {
593         if (scp->cbServerp) {
594             if (scp->flags & CM_SCACHEFLAG_PURERO) {
595                 cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
596                 if (volp) {
597                     if (volp->cbExpiresRO == scp->cbExpires)
598                         volp->cbExpiresRO = now+1;
599                     cm_PutVolume(volp);
600                 }
601             }
602             scp->cbExpires = now+1;
603         }
604     }
605     lock_ReleaseWrite(&cm_scacheLock);
606 }
607
608 long
609 cm_ShutdownSCache(void)
610 {
611     cm_scache_t * scp, * nextp;
612
613     cm_GiveUpAllCallbacksAllServersMulti(FALSE);
614
615     lock_ObtainWrite(&cm_scacheLock);
616
617     for ( scp = cm_data.allSCachesp; scp;
618           scp = nextp ) {
619         nextp = scp->allNextp;
620         lock_ReleaseWrite(&cm_scacheLock);
621 #ifdef USE_BPLUS
622         lock_ObtainWrite(&scp->dirlock);
623 #endif
624         lock_ObtainWrite(&scp->rw);
625         lock_ObtainWrite(&cm_scacheLock);
626
627         if (scp->randomACLp) {
628             cm_FreeAllACLEnts(scp);
629         }
630
631         if (scp->cbServerp) {
632             cm_PutServer(scp->cbServerp);
633             scp->cbServerp = NULL;
634         }
635         scp->cbExpires = 0;
636         scp->cbIssued = 0;
637         lock_ReleaseWrite(&scp->rw);
638
639 #ifdef USE_BPLUS
640         if (scp->dirBplus)
641             freeBtree(scp->dirBplus);
642         scp->dirBplus = NULL;
643         scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
644         lock_ReleaseWrite(&scp->dirlock);
645         lock_FinalizeRWLock(&scp->dirlock);
646 #endif
647         lock_FinalizeRWLock(&scp->rw);
648         lock_FinalizeRWLock(&scp->bufCreateLock);
649         lock_FinalizeMutex(&scp->redirMx);
650     }
651     lock_ReleaseWrite(&cm_scacheLock);
652
653     return cm_dnlcShutdown();
654 }
655
656 void cm_InitSCache(int newFile, long maxSCaches)
657 {
658     static osi_once_t once;
659
660     if (osi_Once(&once)) {
661         lock_InitializeRWLock(&cm_scacheLock, "cm_scacheLock", LOCK_HIERARCHY_SCACHE_GLOBAL);
662         if ( newFile ) {
663             memset(cm_data.scacheHashTablep, 0, sizeof(cm_scache_t *) * cm_data.scacheHashTableSize);
664             cm_data.allSCachesp = NULL;
665             cm_data.currentSCaches = 0;
666             cm_data.maxSCaches = maxSCaches;
667             cm_data.scacheLRUFirstp = cm_data.scacheLRULastp = NULL;
668         } else {
669             cm_scache_t * scp;
670
671             for ( scp = cm_data.allSCachesp; scp;
672                   scp = scp->allNextp ) {
673                 lock_InitializeRWLock(&scp->rw, "cm_scache_t rw", LOCK_HIERARCHY_SCACHE);
674                 lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock", LOCK_HIERARCHY_SCACHE_BUFCREATE);
675 #ifdef USE_BPLUS
676                 lock_InitializeRWLock(&scp->dirlock, "cm_scache_t dirlock", LOCK_HIERARCHY_SCACHE_DIRLOCK);
677 #endif
678                 scp->cbServerp = NULL;
679                 scp->cbExpires = 0;
680                 scp->cbIssued = 0;
681                 scp->volumeCreationDate = 0;
682                 scp->fileLocksH = NULL;
683                 scp->fileLocksT = NULL;
684                 scp->serverLock = (-1);
685                 scp->lastRefreshCycle = 0;
686                 scp->exclusiveLocks = 0;
687                 scp->sharedLocks = 0;
688                 scp->openReads = 0;
689                 scp->openWrites = 0;
690                 scp->openShares = 0;
691                 scp->openExcls = 0;
692                 scp->waitCount = 0;
693                 scp->activeRPCs = 0;
694 #ifdef USE_BPLUS
695                 scp->dirBplus = NULL;
696                 scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
697 #endif
698                 scp->waitQueueT = NULL;
699                 _InterlockedAnd(&scp->flags, ~(CM_SCACHEFLAG_WAITING | CM_SCACHEFLAG_RDR_IN_USE));
700
701                 scp->redirBufCount = 0;
702                 scp->redirQueueT = NULL;
703                 scp->redirQueueH = NULL;
704                 lock_InitializeMutex(&scp->redirMx, "cm_scache_t redirMx", LOCK_HIERARCHY_SCACHE_REDIRMX);
705             }
706         }
707         cm_allFileLocks = NULL;
708         cm_freeFileLocks = NULL;
709         cm_lockRefreshCycle = 0;
710         cm_fakeSCacheInit(newFile);
711         cm_allFreeWaiters = NULL;
712         cm_dnlcInit(newFile);
713         osi_EndOnce(&once);
714     }
715 }
716
717 /* version that doesn't bother creating the entry if we don't find it */
718 cm_scache_t *cm_FindSCache(cm_fid_t *fidp)
719 {
720     long hash;
721     cm_scache_t *scp;
722
723     hash = CM_SCACHE_HASH(fidp);
724
725     if (fidp->cell == 0) {
726         return NULL;
727     }
728
729     lock_ObtainRead(&cm_scacheLock);
730     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
731         if (cm_FidCmp(fidp, &scp->fid) == 0) {
732             cm_HoldSCacheNoLock(scp);
733             lock_ConvertRToW(&cm_scacheLock);
734             cm_AdjustScacheLRU(scp);
735             lock_ReleaseWrite(&cm_scacheLock);
736             return scp;
737         }
738     }
739     lock_ReleaseRead(&cm_scacheLock);
740     return NULL;
741 }
742
743 #ifdef DEBUG_REFCOUNT
744 long cm_GetSCacheDbg(cm_fid_t *fidp, cm_fid_t *parentFidp, cm_scache_t **outScpp, cm_user_t *userp,
745                   cm_req_t *reqp, char * file, long line)
746 #else
747 long cm_GetSCache(cm_fid_t *fidp, cm_fid_t *parentFidp, cm_scache_t **outScpp, cm_user_t *userp,
748                   cm_req_t *reqp)
749 #endif
750 {
751     long hash;
752     cm_scache_t *scp = NULL;
753     cm_scache_t *newScp = NULL;
754     long code;
755     cm_volume_t *volp = NULL;
756     cm_cell_t *cellp;
757     int special = 0; // yj: boolean variable to test if file is on root.afs
758     int isRoot = 0;
759     extern cm_fid_t cm_rootFid;
760     afs_int32 refCount;
761
762     hash = CM_SCACHE_HASH(fidp);
763
764     if (fidp->cell == 0)
765         return CM_ERROR_INVAL;
766
767 #ifdef AFS_FREELANCE_CLIENT
768     special = (fidp->cell==AFS_FAKE_ROOT_CELL_ID &&
769                fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
770                !(fidp->vnode==0x1 && fidp->unique==0x1));
771     isRoot = (fidp->cell==AFS_FAKE_ROOT_CELL_ID &&
772               fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
773               fidp->vnode==0x1 && fidp->unique==0x1);
774 #endif
775
776     // yj: check if we have the scp, if so, we don't need
777     // to do anything else
778     lock_ObtainRead(&cm_scacheLock);
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 (1) scp 0x%p ref %d", file, line, scp, scp->refCount);
783             osi_Log1(afsd_logp,"cm_GetSCache (1) scp 0x%p", scp);
784 #endif
785 #ifdef AFS_FREELANCE_CLIENT
786             if (cm_freelanceEnabled && special &&
787                 cm_data.fakeDirVersion != scp->dataVersion)
788                 break;
789 #endif
790             if (parentFidp && scp->parentVnode == 0) {
791                 scp->parentVnode = parentFidp->vnode;
792                 scp->parentUnique = parentFidp->unique;
793             }
794             cm_HoldSCacheNoLock(scp);
795             *outScpp = scp;
796             lock_ConvertRToW(&cm_scacheLock);
797             cm_AdjustScacheLRU(scp);
798             lock_ReleaseWrite(&cm_scacheLock);
799             return 0;
800         }
801     }
802     lock_ReleaseRead(&cm_scacheLock);
803
804     // yj: when we get here, it means we don't have an scp
805     // so we need to either load it or fake it, depending
806     // on whether the file is "special", see below.
807
808     // yj: if we're trying to get an scp for a file that's
809     // on root.afs of homecell, we want to handle it specially
810     // because we have to fill in the status stuff 'coz we
811     // don't want trybulkstat to fill it in for us
812 #ifdef AFS_FREELANCE_CLIENT
813     if (cm_freelanceEnabled && isRoot) {
814         osi_Log0(afsd_logp,"cm_GetSCache Freelance and isRoot");
815         /* freelance: if we are trying to get the root scp for the first
816          * time, we will just put in a place holder entry.
817          */
818         volp = NULL;
819     }
820
821     if (cm_freelanceEnabled && special) {
822         osi_Log0(afsd_logp,"cm_GetSCache Freelance and special");
823
824         if (cm_getLocalMountPointChange()) {
825             cm_clearLocalMountPointChange();
826             cm_reInitLocalMountPoints();
827         }
828
829         if (scp == NULL) {
830             scp = cm_GetNewSCache(FALSE);    /* returns scp->rw held */
831             if (scp == NULL) {
832                 osi_Log0(afsd_logp,"cm_GetSCache unable to obtain *new* scache entry");
833                 return CM_ERROR_WOULDBLOCK;
834             }
835         } else {
836             lock_ObtainWrite(&scp->rw);
837         }
838         scp->fid = *fidp;
839         cm_SetFid(&scp->dotdotFid,AFS_FAKE_ROOT_CELL_ID,AFS_FAKE_ROOT_VOL_ID,1,1);
840         if (parentFidp) {
841             scp->parentVnode = parentFidp->vnode;
842             scp->parentUnique = parentFidp->unique;
843         }
844         _InterlockedOr(&scp->flags, (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO));
845         lock_ObtainWrite(&cm_scacheLock);
846         if (!(scp->flags & CM_SCACHEFLAG_INHASH)) {
847             scp->nextp = cm_data.scacheHashTablep[hash];
848             cm_data.scacheHashTablep[hash] = scp;
849             _InterlockedOr(&scp->flags, CM_SCACHEFLAG_INHASH);
850         }
851         refCount = InterlockedIncrement(&scp->refCount);
852         osi_Log2(afsd_logp,"cm_GetSCache (freelance) sets refCount to 1 scp 0x%p refCount %d", scp, refCount);
853         lock_ReleaseWrite(&cm_scacheLock);
854
855         /* must be called after the scp->fid is set */
856         cm_FreelanceFetchMountPointString(scp);
857         cm_FreelanceFetchFileType(scp);
858
859         scp->length.LowPart = (DWORD)strlen(scp->mountPointStringp)+4;
860         scp->length.HighPart = 0;
861         scp->owner=0x0;
862         scp->unixModeBits=0777;
863         scp->clientModTime=FakeFreelanceModTime;
864         scp->serverModTime=FakeFreelanceModTime;
865         scp->parentUnique = 0x1;
866         scp->parentVnode=0x1;
867         scp->group=0;
868         scp->dataVersion=cm_data.fakeDirVersion;
869         scp->bufDataVersionLow=cm_data.fakeDirVersion;
870         scp->lockDataVersion=CM_SCACHE_VERSION_BAD; /* no lock yet */
871         scp->fsLockCount=0;
872         lock_ReleaseWrite(&scp->rw);
873         *outScpp = scp;
874 #ifdef DEBUG_REFCOUNT
875         afsi_log("%s:%d cm_GetSCache (2) scp 0x%p ref %d", file, line, scp, scp->refCount);
876         osi_Log1(afsd_logp,"cm_GetSCache (2) scp 0x%p", scp);
877 #endif
878         return 0;
879     }
880     // end of yj code
881 #endif /* AFS_FREELANCE_CLIENT */
882
883     /* we don't have the fid, recycle something */
884     newScp = cm_GetNewSCache(FALSE);    /* returns scp->rw held */
885     if (newScp == NULL) {
886         osi_Log0(afsd_logp,"cm_GetNewSCache unable to obtain *new* scache entry");
887         return CM_ERROR_WOULDBLOCK;
888     }
889 #ifdef DEBUG_REFCOUNT
890     afsi_log("%s:%d cm_GetNewSCache returns scp 0x%p flags 0x%x", file, line, newScp, newScp->flags);
891 #endif
892     osi_Log2(afsd_logp,"cm_GetNewSCache returns scp 0x%p flags 0x%x", newScp, newScp->flags);
893
894     /* otherwise, we need to find the volume */
895     if (!cm_freelanceEnabled || !isRoot) {
896         cellp = cm_FindCellByID(fidp->cell, 0);
897         if (!cellp) {
898             /* put back newScp so it can be reused */
899             lock_ObtainWrite(&cm_scacheLock);
900             newScp->flags |= CM_SCACHEFLAG_DELETED;
901             cm_AdjustScacheLRU(newScp);
902             lock_ReleaseWrite(&newScp->rw);
903             lock_ReleaseWrite(&cm_scacheLock);
904             return CM_ERROR_NOSUCHCELL;
905         }
906
907         code = cm_FindVolumeByID(cellp, fidp->volume, userp, reqp, CM_GETVOL_FLAG_CREATE, &volp);
908         if (code) {
909             /* put back newScp so it can be reused */
910             lock_ObtainWrite(&cm_scacheLock);
911             newScp->flags |= CM_SCACHEFLAG_DELETED;
912             cm_AdjustScacheLRU(newScp);
913             lock_ReleaseWrite(&newScp->rw);
914             lock_ReleaseWrite(&cm_scacheLock);
915             return code;
916         }
917     }
918
919     /*
920      * otherwise, we have the volume, now reverify that the scp doesn't
921      * exist, and proceed.  make sure that we hold the cm_scacheLock
922      * write-locked until the scp is put into the hash table in order
923      * to avoid a race.
924      */
925     lock_ObtainWrite(&cm_scacheLock);
926     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
927         if (cm_FidCmp(fidp, &scp->fid) == 0) {
928 #ifdef DEBUG_REFCOUNT
929             afsi_log("%s:%d cm_GetSCache (3) scp 0x%p ref %d", file, line, scp, scp->refCount);
930             osi_Log1(afsd_logp,"cm_GetSCache (3) scp 0x%p", scp);
931 #endif
932             if (parentFidp && scp->parentVnode == 0) {
933                 scp->parentVnode = parentFidp->vnode;
934                 scp->parentUnique = parentFidp->unique;
935             }
936             if (volp)
937                 cm_PutVolume(volp);
938             cm_HoldSCacheNoLock(scp);
939             cm_AdjustScacheLRU(scp);
940
941             /* put back newScp so it can be reused */
942             newScp->flags |= CM_SCACHEFLAG_DELETED;
943             cm_AdjustScacheLRU(newScp);
944             lock_ReleaseWrite(&newScp->rw);
945             lock_ReleaseWrite(&cm_scacheLock);
946
947             *outScpp = scp;
948             return 0;
949         }
950     }
951
952     scp = newScp;
953     scp->fid = *fidp;
954     if (!cm_freelanceEnabled || !isRoot) {
955         /* if this scache entry represents a volume root then we need
956          * to copy the dotdotFid from the volume structure where the
957          * "master" copy is stored (defect 11489)
958          */
959         if (volp->vol[ROVOL].ID == fidp->volume) {
960             _InterlockedOr(&scp->flags, (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO));
961             if (scp->fid.vnode == 1 && scp->fid.unique == 1)
962                 scp->dotdotFid = cm_VolumeStateByType(volp, ROVOL)->dotdotFid;
963         } else if (volp->vol[BACKVOL].ID == fidp->volume) {
964             _InterlockedOr(&scp->flags, CM_SCACHEFLAG_RO);
965             if (scp->fid.vnode == 1 && scp->fid.unique == 1)
966                 scp->dotdotFid = cm_VolumeStateByType(volp, BACKVOL)->dotdotFid;
967         } else {
968             if (scp->fid.vnode == 1 && scp->fid.unique == 1)
969                 scp->dotdotFid = cm_VolumeStateByType(volp, RWVOL)->dotdotFid;
970         }
971     }
972     if (parentFidp) {
973         scp->parentVnode = parentFidp->vnode;
974         scp->parentUnique = parentFidp->unique;
975     }
976     if (volp)
977         cm_PutVolume(volp);
978
979     scp->nextp = cm_data.scacheHashTablep[hash];
980     cm_data.scacheHashTablep[hash] = scp;
981     _InterlockedOr(&scp->flags, CM_SCACHEFLAG_INHASH);
982     refCount = InterlockedIncrement(&scp->refCount);
983     lock_ReleaseWrite(&cm_scacheLock);
984     lock_ReleaseWrite(&scp->rw);
985 #ifdef DEBUG_REFCOUNT
986     afsi_log("%s:%d cm_GetSCache sets refCount to 1 scp 0x%p refCount %d", file, line, scp, refCount);
987 #endif
988     osi_Log2(afsd_logp,"cm_GetSCache sets refCount to 1 scp 0x%p refCount %d", scp, refCount);
989
990     /* XXX - The following fields in the cm_scache are
991      * uninitialized:
992      *   fileType
993      *   parentVnode
994      *   parentUnique
995      */
996
997     /* now we have a held scache entry; just return it */
998     *outScpp = scp;
999 #ifdef DEBUG_REFCOUNT
1000     afsi_log("%s:%d cm_GetSCache (4) scp 0x%p ref %d", file, line, scp, scp->refCount);
1001     osi_Log1(afsd_logp,"cm_GetSCache (4) scp 0x%p", scp);
1002 #endif
1003     return 0;
1004 }
1005
1006 /* Returns a held reference to the scache's parent
1007  * if it exists */
1008 cm_scache_t * cm_FindSCacheParent(cm_scache_t * scp)
1009 {
1010     long code = 0;
1011     int i;
1012     cm_fid_t    parent_fid;
1013     cm_scache_t * pscp = NULL;
1014
1015     if (scp->parentVnode == 0)
1016         return NULL;
1017
1018     lock_ObtainWrite(&cm_scacheLock);
1019     cm_SetFid(&parent_fid, scp->fid.cell, scp->fid.volume, scp->parentVnode, scp->parentUnique);
1020
1021     if (cm_FidCmp(&scp->fid, &parent_fid)) {
1022         i = CM_SCACHE_HASH(&parent_fid);
1023         for (pscp = cm_data.scacheHashTablep[i]; pscp; pscp = pscp->nextp) {
1024             if (!cm_FidCmp(&pscp->fid, &parent_fid)) {
1025                 cm_HoldSCacheNoLock(pscp);
1026                 break;
1027             }
1028         }
1029     }
1030
1031     lock_ReleaseWrite(&cm_scacheLock);
1032
1033     return pscp;
1034 }
1035
1036 void cm_SyncOpAddToWaitQueue(cm_scache_t * scp, afs_int32 flags, cm_buf_t * bufp)
1037 {
1038     cm_scache_waiter_t * w;
1039
1040     lock_ObtainWrite(&cm_scacheLock);
1041     if (cm_allFreeWaiters == NULL) {
1042         w = malloc(sizeof(*w));
1043         memset(w, 0, sizeof(*w));
1044     } else {
1045         w = (cm_scache_waiter_t *) cm_allFreeWaiters;
1046         osi_QRemove(&cm_allFreeWaiters, (osi_queue_t *) w);
1047     }
1048
1049     w->threadId = thrd_Current();
1050     w->scp = scp;
1051     cm_HoldSCacheNoLock(scp);
1052     w->flags = flags;
1053     w->bufp = bufp;
1054
1055     osi_QAddT(&scp->waitQueueH, &scp->waitQueueT, (osi_queue_t *) w);
1056     lock_ReleaseWrite(&cm_scacheLock);
1057
1058     osi_Log2(afsd_logp, "cm_SyncOpAddToWaitQueue : Adding thread to wait queue scp 0x%p w 0x%p", scp, w);
1059 }
1060
1061 int cm_SyncOpCheckContinue(cm_scache_t * scp, afs_int32 flags, cm_buf_t * bufp)
1062 {
1063     cm_scache_waiter_t * w;
1064     int this_is_me;
1065
1066     osi_Log0(afsd_logp, "cm_SyncOpCheckContinue checking for continuation");
1067
1068     lock_ObtainRead(&cm_scacheLock);
1069     for (w = (cm_scache_waiter_t *)scp->waitQueueH;
1070          w;
1071          w = (cm_scache_waiter_t *)osi_QNext((osi_queue_t *) w)) {
1072         if (w->flags == flags && w->bufp == bufp) {
1073             break;
1074         }
1075     }
1076
1077     osi_assertx(w != NULL, "null cm_scache_waiter_t");
1078     this_is_me = (w->threadId == thrd_Current());
1079     lock_ReleaseRead(&cm_scacheLock);
1080
1081     if (!this_is_me) {
1082         osi_Log1(afsd_logp, "cm_SyncOpCheckContinue MISS: Waiter 0x%p", w);
1083         return 0;
1084     }
1085
1086     osi_Log1(afsd_logp, "cm_SyncOpCheckContinue HIT: Waiter 0x%p", w);
1087
1088     lock_ObtainWrite(&cm_scacheLock);
1089     osi_QRemoveHT(&scp->waitQueueH, &scp->waitQueueT, (osi_queue_t *) w);
1090     cm_ReleaseSCacheNoLock(scp);
1091     memset(w, 0, sizeof(*w));
1092     osi_QAdd(&cm_allFreeWaiters, (osi_queue_t *) w);
1093     lock_ReleaseWrite(&cm_scacheLock);
1094
1095     return 1;
1096 }
1097
1098
1099 /* synchronize a fetch, store, read, write, fetch status or store status.
1100  * Called with scache mutex held, and returns with it held, but temporarily
1101  * drops it during the fetch.
1102  *
1103  * At most one flag can be on in flags, if this is an RPC request.
1104  *
1105  * Also, if we're fetching or storing data, we must ensure that we have a buffer.
1106  *
1107  * There are a lot of weird restrictions here; here's an attempt to explain the
1108  * rationale for the concurrency restrictions implemented in this function.
1109  *
1110  * First, although the file server will break callbacks when *another* machine
1111  * modifies a file or status block, the client itself is responsible for
1112  * concurrency control on its own requests.  Callback breaking events are rare,
1113  * and simply invalidate any concurrent new status info.
1114  *
1115  * In the absence of callback breaking messages, we need to know how to
1116  * synchronize incoming responses describing updates to files.  We synchronize
1117  * operations that update the data version by comparing the data versions.
1118  * However, updates that do not update the data, but only the status, can't be
1119  * synchronized with fetches or stores, since there's nothing to compare
1120  * to tell which operation executed first at the server.
1121  *
1122  * Thus, we can allow multiple ops that change file data, or dir data, and
1123  * fetches.  However, status storing ops have to be done serially.
1124  *
1125  * Furthermore, certain data-changing ops are incompatible: we can't read or
1126  * write a buffer while doing a truncate.  We can't read and write the same
1127  * buffer at the same time, or write while fetching or storing, or read while
1128  * fetching a buffer (this may change).  We can't fetch and store at the same
1129  * time, either.
1130  *
1131  * With respect to status, we can't read and write at the same time, read while
1132  * fetching, write while fetching or storing, or fetch and store at the same time.
1133  *
1134  * We can't allow a get callback RPC to run in concurrently with something that
1135  * will return updated status, since we could start a call, have the server
1136  * return status, have another machine make an update to the status (which
1137  * doesn't change serverModTime), have the original machine get a new callback,
1138  * and then have the original machine merge in the early, old info from the
1139  * first call.  At this point, the easiest way to avoid this problem is to have
1140  * getcallback calls conflict with all others for the same vnode.  Other calls
1141  * to cm_MergeStatus that aren't associated with calls to cm_SyncOp on the same
1142  * vnode must be careful not to merge in their status unless they have obtained
1143  * a callback from the start of their call.
1144  *
1145  * Note added 1/23/96
1146  * Concurrent StoreData RPC's can cause trouble if the file is being extended.
1147  * Each such RPC passes a FileLength parameter, which the server uses to do
1148  * pre-truncation if necessary.  So if two RPC's are processed out of order at
1149  * the server, the one with the smaller FileLength will be processed last,
1150  * possibly resulting in a bogus truncation.  The simplest way to avoid this
1151  * is to serialize all StoreData RPC's.  This is the reason we defined
1152  * CM_SCACHESYNC_STOREDATA_EXCL and CM_SCACHEFLAG_DATASTORING.
1153  *
1154  * CM_SCACHESYNC_BULKREAD is used to permit synchronization of multiple bulk
1155  * readers which may be requesting overlapping ranges.
1156  */
1157 long cm_SyncOp(cm_scache_t *scp, cm_buf_t *bufp, cm_user_t *userp, cm_req_t *reqp,
1158                afs_uint32 rights, afs_uint32 flags)
1159 {
1160     osi_queueData_t *qdp;
1161     long code;
1162     cm_buf_t *tbufp;
1163     afs_uint32 outRights;
1164     int bufLocked;
1165     afs_uint32 sleep_scp_flags = 0;
1166     afs_uint32 sleep_buf_cmflags = 0;
1167     afs_uint32 sleep_scp_bufs = 0;
1168     int wakeupCycle;
1169     afs_int32 waitCount;
1170     afs_int32 waitRequests;
1171
1172     lock_AssertWrite(&scp->rw);
1173
1174     /* lookup this first */
1175     bufLocked = flags & CM_SCACHESYNC_BUFLOCKED;
1176
1177     if (bufp)
1178         osi_assertx(bufp->refCount > 0, "cm_buf_t refCount 0");
1179
1180
1181     /* Do the access check.  Now we don't really do the access check
1182      * atomically, since the caller doesn't expect the parent dir to be
1183      * returned locked, and that is what we'd have to do to prevent a
1184      * callback breaking message on the parent due to a setacl call from
1185      * being processed while we're running.  So, instead, we check things
1186      * here, and if things look fine with the access, we proceed to finish
1187      * the rest of this check.  Sort of a hack, but probably good enough.
1188      */
1189
1190     while (1) {
1191         if (flags & CM_SCACHESYNC_FETCHSTATUS) {
1192             /* if we're bringing in a new status block, ensure that
1193              * we aren't already doing so, and that no one is
1194              * changing the status concurrently, either.  We need
1195              * to do this, even if the status is of a different
1196              * type, since we don't have the ability to figure out,
1197              * in the AFS 3 protocols, which status-changing
1198              * operation ran first, or even which order a read and
1199              * a write occurred in.
1200              */
1201             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESETTING |
1202                               CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1203                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESETTING|SIZESTORING|GETCALLBACK want FETCHSTATUS", scp);
1204                 goto sleep;
1205             }
1206         }
1207         if (flags & (CM_SCACHESYNC_STORESIZE | CM_SCACHESYNC_STORESTATUS
1208                       | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_GETCALLBACK)) {
1209             /* if we're going to make an RPC to change the status, make sure
1210              * that no one is bringing in or sending out the status.
1211              */
1212             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESETTING |
1213                               CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1214                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESETTING|SIZESTORING|GETCALLBACK want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
1215                 goto sleep;
1216             }
1217             if ((!bufp || bufp && scp->fileType == CM_SCACHETYPE_FILE) &&
1218                 (scp->bufReadsp || scp->bufWritesp)) {
1219                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is bufRead|bufWrite want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
1220                 goto sleep;
1221             }
1222         }
1223         if (flags & CM_SCACHESYNC_FETCHDATA) {
1224             /* if we're bringing in a new chunk of data, make sure that
1225              * nothing is happening to that chunk, and that we aren't
1226              * changing the basic file status info, either.
1227              */
1228             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESETTING |
1229                               CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1230                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESETTING|SIZESTORING|GETCALLBACK want FETCHDATA", scp);
1231                 goto sleep;
1232             }
1233             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING | CM_BUF_CMWRITING))) {
1234                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING|BUF_CMSTORING|BUF_CMWRITING want FETCHDATA", scp, bufp);
1235                 goto sleep;
1236             }
1237         }
1238         if (flags & CM_SCACHESYNC_STOREDATA) {
1239             /* same as fetch data */
1240             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
1241                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
1242                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESTORING|GETCALLBACK want STOREDATA", scp);
1243                 goto sleep;
1244             }
1245             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING | CM_BUF_CMWRITING))) {
1246                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING|BUF_CMSTORING|BUF_CMWRITING want STOREDATA", scp, bufp);
1247                 goto sleep;
1248             }
1249         }
1250
1251         if (flags & CM_SCACHESYNC_STOREDATA_EXCL) {
1252             /* Don't allow concurrent StoreData RPC's */
1253             if (scp->flags & CM_SCACHEFLAG_DATASTORING) {
1254                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is DATASTORING want STOREDATA_EXCL", scp);
1255                 goto sleep;
1256             }
1257         }
1258
1259         if (flags & CM_SCACHESYNC_ASYNCSTORE) {
1260             /* Don't allow more than one BKG store request */
1261             if (scp->flags & CM_SCACHEFLAG_ASYNCSTORING) {
1262                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is ASYNCSTORING want ASYNCSTORE", scp);
1263                 goto sleep;
1264             }
1265         }
1266
1267         if (flags & CM_SCACHESYNC_LOCK) {
1268             /* Don't allow concurrent fiddling with lock lists */
1269             if (scp->flags & CM_SCACHEFLAG_LOCKING) {
1270                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is LOCKING want LOCK", scp);
1271                 goto sleep;
1272             }
1273         }
1274
1275         /* now the operations that don't correspond to making RPCs */
1276         if (flags & CM_SCACHESYNC_GETSTATUS) {
1277             /* we can use the status that's here, if we're not
1278              * bringing in new status.
1279              */
1280             if (scp->flags & (CM_SCACHEFLAG_FETCHING)) {
1281                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING want GETSTATUS", scp);
1282                 goto sleep;
1283             }
1284         }
1285         if (flags & CM_SCACHESYNC_SETSTATUS) {
1286             /* we can make a change to the local status, as long as
1287              * the status isn't changing now.
1288              *
1289              * If we're fetching or storing a chunk of data, we can
1290              * change the status locally, since the fetch/store
1291              * operations don't change any of the data that we're
1292              * changing here.
1293              */
1294             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING |
1295                               CM_SCACHEFLAG_SIZESETTING | CM_SCACHEFLAG_SIZESTORING)) {
1296                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESETTING|SIZESTORING want SETSTATUS", scp);
1297                 goto sleep;
1298             }
1299         }
1300         if (flags & CM_SCACHESYNC_READ) {
1301             /* we're going to read the data, make sure that the
1302              * status is available, and that the data is here.  It
1303              * is OK to read while storing the data back.
1304              */
1305             if (scp->flags & CM_SCACHEFLAG_FETCHING) {
1306                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING want READ", scp);
1307                 goto sleep;
1308             }
1309             if (bufp && ((bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED)) == CM_BUF_CMFETCHING)) {
1310                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMFETCHING want READ", scp, bufp);
1311                 goto sleep;
1312             }
1313             if (bufp && (bufp->cmFlags & CM_BUF_CMWRITING)) {
1314                 osi_Log2(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is BUF_CMWRITING want READ", scp, bufp);
1315                 goto sleep;
1316             }
1317         }
1318         if (flags & CM_SCACHESYNC_WRITE) {
1319             /* don't write unless the status is stable and the chunk
1320              * is stable.
1321              */
1322             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESETTING |
1323                               CM_SCACHEFLAG_SIZESTORING)) {
1324                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is FETCHING|STORING|SIZESETTING|SIZESTORING want WRITE", scp);
1325                 goto sleep;
1326             }
1327             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING |
1328                                           CM_BUF_CMSTORING |
1329                                           CM_BUF_CMWRITING))) {
1330                 osi_Log3(afsd_logp, "CM SyncOp scp 0x%p bufp 0x%p is %s want WRITE",
1331                          scp, bufp,
1332                          ((bufp->cmFlags & CM_BUF_CMFETCHING) ? "CM_BUF_CMFETCHING":
1333                           ((bufp->cmFlags & CM_BUF_CMSTORING) ? "CM_BUF_CMSTORING" :
1334                            ((bufp->cmFlags & CM_BUF_CMWRITING) ? "CM_BUF_CMWRITING" :
1335                             "UNKNOWN!!!"))));
1336                 goto sleep;
1337             }
1338         }
1339
1340         if ((flags & CM_SCACHESYNC_NEEDCALLBACK)) {
1341             if ((flags & CM_SCACHESYNC_FORCECB) || !cm_HaveCallback(scp)) {
1342                 osi_Log1(afsd_logp, "CM SyncOp getting callback on scp 0x%p",
1343                           scp);
1344
1345                 if (cm_EAccesFindEntry(userp, &scp->fid))
1346                     return CM_ERROR_NOACCESS;
1347
1348                 if (bufLocked)
1349                     lock_ReleaseMutex(&bufp->mx);
1350                 code = cm_GetCallback(scp, userp, reqp, (flags & CM_SCACHESYNC_FORCECB)?1:0);
1351                 if (bufLocked) {
1352                     lock_ReleaseWrite(&scp->rw);
1353                     lock_ObtainMutex(&bufp->mx);
1354                     lock_ObtainWrite(&scp->rw);
1355                 }
1356                 if (code)
1357                     return code;
1358                 flags &= ~CM_SCACHESYNC_FORCECB;        /* only force once */
1359                 continue;
1360             }
1361         }
1362
1363         if (rights) {
1364             /* can't check access rights without a callback */
1365             osi_assertx(flags & CM_SCACHESYNC_NEEDCALLBACK, "!CM_SCACHESYNC_NEEDCALLBACK");
1366
1367             if ((rights & (PRSFS_WRITE|PRSFS_DELETE)) && (scp->flags & CM_SCACHEFLAG_RO))
1368                 return CM_ERROR_READONLY;
1369
1370             if (cm_HaveAccessRights(scp, userp, reqp, rights, &outRights)) {
1371                 if (~outRights & rights)
1372                     return CM_ERROR_NOACCESS;
1373             }
1374             else {
1375                 /* we don't know the required access rights */
1376                 if (bufLocked) lock_ReleaseMutex(&bufp->mx);
1377                 code = cm_GetAccessRights(scp, userp, reqp);
1378                 if (bufLocked) {
1379                     lock_ReleaseWrite(&scp->rw);
1380                     lock_ObtainMutex(&bufp->mx);
1381                     lock_ObtainWrite(&scp->rw);
1382                 }
1383                 if (code)
1384                     return code;
1385                 continue;
1386             }
1387         }
1388
1389         if (flags & CM_SCACHESYNC_BULKREAD) {
1390             /* Don't allow concurrent fiddling with lock lists */
1391             if (scp->flags & CM_SCACHEFLAG_BULKREADING) {
1392                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%p is BULKREADING want BULKREAD", scp);
1393                 goto sleep;
1394             }
1395         }
1396
1397         /* if we get here, we're happy */
1398         break;
1399
1400       sleep:
1401         /* first check if we're not supposed to wait: fail
1402          * in this case, returning with everything still locked.
1403          */
1404         if (flags & CM_SCACHESYNC_NOWAIT)
1405             return CM_ERROR_WOULDBLOCK;
1406
1407         /* These are used for minidump debugging */
1408         sleep_scp_flags = scp->flags;           /* so we know why we slept */
1409         sleep_buf_cmflags = bufp ? bufp->cmFlags : 0;
1410         sleep_scp_bufs = (scp->bufReadsp ? 1 : 0) | (scp->bufWritesp ? 2 : 0);
1411
1412         /* wait here, then try again */
1413         osi_Log1(afsd_logp, "CM SyncOp sleeping scp 0x%p", scp);
1414
1415         waitCount = InterlockedIncrement(&scp->waitCount);
1416         waitRequests = InterlockedIncrement(&scp->waitRequests);
1417         if (waitCount > 1) {
1418             osi_Log3(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING already set for 0x%p; %d threads; %d requests",
1419                      scp, waitCount, waitRequests);
1420         } else {
1421             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING set for 0x%p", scp);
1422             _InterlockedOr(&scp->flags, CM_SCACHEFLAG_WAITING);
1423         }
1424
1425         cm_SyncOpAddToWaitQueue(scp, flags, bufp);
1426         wakeupCycle = 0;
1427         do {
1428             if (bufLocked)
1429                 lock_ReleaseMutex(&bufp->mx);
1430             osi_SleepW((LONG_PTR) &scp->flags, &scp->rw);
1431             if (bufLocked)
1432                 lock_ObtainMutex(&bufp->mx);
1433             lock_ObtainWrite(&scp->rw);
1434         } while (!cm_SyncOpCheckContinue(scp, flags, bufp));
1435
1436         cm_UpdateServerPriority();
1437
1438         waitCount = InterlockedDecrement(&scp->waitCount);
1439         osi_Log3(afsd_logp, "CM SyncOp woke! scp 0x%p; still waiting %d threads of %d requests",
1440                  scp, waitCount, scp->waitRequests);
1441         if (waitCount == 0) {
1442             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING reset for 0x%p", scp);
1443             _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_WAITING);
1444             scp->waitRequests = 0;
1445         }
1446     } /* big while loop */
1447
1448     /* now, update the recorded state for RPC-type calls */
1449     if (flags & CM_SCACHESYNC_FETCHSTATUS)
1450         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_FETCHING);
1451     if (flags & CM_SCACHESYNC_STORESTATUS)
1452         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_STORING);
1453     if (flags & CM_SCACHESYNC_SETSIZE)
1454         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_SIZESETTING);
1455     if (flags & CM_SCACHESYNC_STORESIZE)
1456         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_SIZESTORING);
1457     if (flags & CM_SCACHESYNC_GETCALLBACK)
1458         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_GETCALLBACK);
1459     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
1460         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_DATASTORING);
1461     if (flags & CM_SCACHESYNC_ASYNCSTORE)
1462         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_ASYNCSTORING);
1463     if (flags & CM_SCACHESYNC_LOCK)
1464         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_LOCKING);
1465     if (flags & CM_SCACHESYNC_BULKREAD)
1466         _InterlockedOr(&scp->flags, CM_SCACHEFLAG_BULKREADING);
1467
1468     /* now update the buffer pointer */
1469     if (bufp && (flags & CM_SCACHESYNC_FETCHDATA)) {
1470         /* ensure that the buffer isn't already in the I/O list */
1471         for (qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1472             tbufp = osi_GetQData(qdp);
1473             osi_assertx(tbufp != bufp, "unexpected cm_buf_t value");
1474         }
1475
1476         /* queue a held reference to the buffer in the "reading" I/O list */
1477         qdp = osi_QDAlloc();
1478         osi_SetQData(qdp, bufp);
1479
1480         buf_Hold(bufp);
1481         _InterlockedOr(&bufp->cmFlags, CM_BUF_CMFETCHING);
1482         osi_QAdd((osi_queue_t **) &scp->bufReadsp, &qdp->q);
1483     }
1484
1485     if (bufp && (flags & CM_SCACHESYNC_STOREDATA)) {
1486         osi_assertx(scp->fileType == CM_SCACHETYPE_FILE,
1487             "attempting to store extents on a non-file object");
1488
1489         /* ensure that the buffer isn't already in the I/O list */
1490         for (qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1491             tbufp = osi_GetQData(qdp);
1492             osi_assertx(tbufp != bufp, "unexpected cm_buf_t value");
1493         }
1494
1495         /* queue a held reference to the buffer in the "writing" I/O list */
1496         qdp = osi_QDAlloc();
1497         osi_SetQData(qdp, bufp);
1498         buf_Hold(bufp);
1499         _InterlockedOr(&bufp->cmFlags, CM_BUF_CMSTORING);
1500         osi_QAdd((osi_queue_t **) &scp->bufWritesp, &qdp->q);
1501     }
1502
1503     if (bufp && (flags & CM_SCACHESYNC_WRITE)) {
1504         /* mark the buffer as being written to. */
1505         _InterlockedOr(&bufp->cmFlags, CM_BUF_CMWRITING);
1506     }
1507
1508     return 0;
1509 }
1510
1511 /* for those syncops that setup for RPCs.
1512  * Called with scache locked.
1513  */
1514 void cm_SyncOpDone(cm_scache_t *scp, cm_buf_t *bufp, afs_uint32 flags)
1515 {
1516     osi_queueData_t *qdp;
1517     cm_buf_t *tbufp;
1518
1519     lock_AssertWrite(&scp->rw);
1520
1521     /* now, update the recorded state for RPC-type calls */
1522     if (flags & CM_SCACHESYNC_FETCHSTATUS)
1523         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_FETCHING);
1524     if (flags & CM_SCACHESYNC_STORESTATUS)
1525         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_STORING);
1526     if (flags & CM_SCACHESYNC_SETSIZE)
1527         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_SIZESETTING);
1528     if (flags & CM_SCACHESYNC_STORESIZE)
1529         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_SIZESTORING);
1530     if (flags & CM_SCACHESYNC_GETCALLBACK)
1531         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_GETCALLBACK);
1532     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
1533         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_DATASTORING);
1534     if (flags & CM_SCACHESYNC_ASYNCSTORE)
1535         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_ASYNCSTORING);
1536     if (flags & CM_SCACHESYNC_LOCK)
1537         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_LOCKING);
1538     if (flags & CM_SCACHESYNC_BULKREAD)
1539         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_BULKREADING);
1540
1541     /* now update the buffer pointer */
1542     if (bufp && (flags & CM_SCACHESYNC_FETCHDATA)) {
1543         int release = 0;
1544
1545         /* ensure that the buffer is in the I/O list */
1546         for (qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1547             tbufp = osi_GetQData(qdp);
1548             if (tbufp == bufp)
1549                 break;
1550         }
1551         if (qdp) {
1552             osi_QRemove((osi_queue_t **) &scp->bufReadsp, &qdp->q);
1553             osi_QDFree(qdp);
1554             release = 1;
1555         }
1556         _InterlockedAnd(&bufp->cmFlags, ~(CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED));
1557         if (bufp->flags & CM_BUF_WAITING) {
1558             osi_Log2(afsd_logp, "CM SyncOpDone FetchData Waking [scp 0x%p] bufp 0x%p", scp, bufp);
1559             osi_Wakeup((LONG_PTR) &bufp);
1560         }
1561         if (release)
1562             buf_Release(bufp);
1563     }
1564
1565     /* now update the buffer pointer */
1566     if (bufp && (flags & CM_SCACHESYNC_STOREDATA)) {
1567         int release = 0;
1568         /* ensure that the buffer is in the I/O list */
1569         for (qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
1570             tbufp = osi_GetQData(qdp);
1571             if (tbufp == bufp)
1572                 break;
1573         }
1574         if (qdp) {
1575             osi_QRemove((osi_queue_t **) &scp->bufWritesp, &qdp->q);
1576             osi_QDFree(qdp);
1577             release = 1;
1578         }
1579         _InterlockedAnd(&bufp->cmFlags, ~CM_BUF_CMSTORING);
1580         if (bufp->flags & CM_BUF_WAITING) {
1581             osi_Log2(afsd_logp, "CM SyncOpDone StoreData Waking [scp 0x%p] bufp 0x%p", scp, bufp);
1582             osi_Wakeup((LONG_PTR) &bufp);
1583         }
1584         if (release)
1585             buf_Release(bufp);
1586     }
1587
1588     if (bufp && (flags & CM_SCACHESYNC_WRITE)) {
1589         osi_assertx(bufp->cmFlags & CM_BUF_CMWRITING, "!CM_BUF_CMWRITING");
1590         _InterlockedAnd(&bufp->cmFlags, ~CM_BUF_CMWRITING);
1591     }
1592
1593     /* and wakeup anyone who is waiting */
1594     if ((scp->flags & CM_SCACHEFLAG_WAITING) ||
1595         !osi_QIsEmpty(&scp->waitQueueH)) {
1596         osi_Log3(afsd_logp, "CM SyncOpDone 0x%x Waking scp 0x%p bufp 0x%p", flags, scp, bufp);
1597         osi_Wakeup((LONG_PTR) &scp->flags);
1598     }
1599 }
1600
1601 static afs_uint32
1602 dv_diff(afs_uint64 dv1, afs_uint64 dv2)
1603 {
1604     if ( dv1 - dv2 > 0x7FFFFFFF )
1605         return (afs_uint32)(dv2 - dv1);
1606     else
1607         return (afs_uint32)(dv1 - dv2);
1608 }
1609
1610 long
1611 cm_IsStatusValid(AFSFetchStatus *statusp)
1612 {
1613     if (statusp->InterfaceVersion != 0x1 ||
1614         !(statusp->FileType > 0 && statusp->FileType <= SymbolicLink)) {
1615         return 0;
1616     }
1617
1618     return 1;
1619 }
1620
1621 /* merge in a response from an RPC.  The scp must be locked, and the callback
1622  * is optional.
1623  *
1624  * Don't overwrite any status info that is dirty, since we could have a store
1625  * operation (such as store data) that merges some info in, and we don't want
1626  * to lose the local updates.  Typically, there aren't many updates we do
1627  * locally, anyway, probably only mtime.
1628  *
1629  * There is probably a bug in here where a chmod (which doesn't change
1630  * serverModTime) that occurs between two fetches, both of whose responses are
1631  * handled after the callback breaking is done, but only one of whose calls
1632  * started before that, can cause old info to be merged from the first call.
1633  */
1634 long cm_MergeStatus(cm_scache_t *dscp,
1635                     cm_scache_t *scp, AFSFetchStatus *statusp,
1636                     AFSVolSync *volsyncp,
1637                     cm_user_t *userp, cm_req_t *reqp, afs_uint32 flags)
1638 {
1639     afs_uint64 dataVersion;
1640     struct cm_volume *volp = NULL;
1641     struct cm_cell *cellp = NULL;
1642     int rdr_invalidate = 0;
1643     afs_uint32 activeRPCs;
1644
1645     lock_AssertWrite(&scp->rw);
1646
1647     activeRPCs = 1 + InterlockedDecrement(&scp->activeRPCs);
1648
1649     // yj: i want to create some fake status for the /afs directory and the
1650     // entries under that directory
1651 #ifdef AFS_FREELANCE_CLIENT
1652     if (cm_freelanceEnabled && scp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
1653          scp->fid.volume==AFS_FAKE_ROOT_VOL_ID) {
1654         if (scp == cm_data.rootSCachep) {
1655             osi_Log0(afsd_logp,"cm_MergeStatus Freelance cm_data.rootSCachep");
1656             statusp->FileType = CM_SCACHETYPE_DIRECTORY;
1657             statusp->Length = cm_fakeDirSize;
1658             statusp->Length_hi = 0;
1659         } else {
1660             statusp->FileType = scp->fileType;
1661             statusp->Length = scp->length.LowPart;
1662             statusp->Length_hi = scp->length.HighPart;
1663         }
1664         statusp->InterfaceVersion = 0x1;
1665         statusp->LinkCount = scp->linkCount;
1666         statusp->DataVersion = (afs_uint32)(cm_data.fakeDirVersion & 0xFFFFFFFF);
1667         statusp->Author = 0x1;
1668         statusp->Owner = 0x0;
1669         statusp->CallerAccess = 0x9;
1670         statusp->AnonymousAccess = 0x9;
1671         statusp->UnixModeBits = 0777;
1672         statusp->ParentVnode = 0x1;
1673         statusp->ParentUnique = 0x1;
1674         statusp->ResidencyMask = 0;
1675         statusp->ClientModTime = FakeFreelanceModTime;
1676         statusp->ServerModTime = FakeFreelanceModTime;
1677         statusp->Group = 0;
1678         statusp->SyncCounter = 0;
1679         statusp->dataVersionHigh = (afs_uint32)(cm_data.fakeDirVersion >> 32);
1680         statusp->lockCount = 0;
1681         statusp->errorCode = 0;
1682     }
1683 #endif /* AFS_FREELANCE_CLIENT */
1684
1685     if (!cm_IsStatusValid(statusp)) {
1686         osi_Log3(afsd_logp, "Merge: Bad Status scp 0x%p Invalid InterfaceVersion %d FileType %d",
1687                  scp, statusp->InterfaceVersion, statusp->FileType);
1688         return CM_ERROR_INVAL;
1689     }
1690
1691     if (statusp->errorCode != 0) {
1692         switch (statusp->errorCode) {
1693         case EACCES:
1694         case UAEACCES:
1695         case EPERM:
1696         case UAEPERM:
1697             cm_EAccesAddEntry(userp, &scp->fid, &dscp->fid);
1698         }
1699         osi_Log2(afsd_logp, "Merge, Failure scp 0x%p code 0x%x", scp, statusp->errorCode);
1700
1701         if (scp->fid.vnode & 0x1)
1702             scp->fileType = CM_SCACHETYPE_DIRECTORY;
1703         else
1704             scp->fileType = CM_SCACHETYPE_UNKNOWN;
1705
1706         scp->serverModTime = 0;
1707         scp->clientModTime = 0;
1708         scp->length.LowPart = 0;
1709         scp->length.HighPart = 0;
1710         scp->serverLength.LowPart = 0;
1711         scp->serverLength.HighPart = 0;
1712         scp->linkCount = 0;
1713         scp->owner = 0;
1714         scp->group = 0;
1715         scp->unixModeBits = 0;
1716         scp->anyAccess = 0;
1717         scp->dataVersion = CM_SCACHE_VERSION_BAD;
1718         scp->bufDataVersionLow = CM_SCACHE_VERSION_BAD;
1719         scp->fsLockCount = 0;
1720
1721         if (dscp && dscp != scp) {
1722             scp->parentVnode = dscp->fid.vnode;
1723             scp->parentUnique = dscp->fid.unique;
1724         } else {
1725             scp->parentVnode = 0;
1726             scp->parentUnique = 0;
1727         }
1728
1729         if (RDR_Initialized)
1730             rdr_invalidate = 1;
1731     }
1732
1733     dataVersion = statusp->dataVersionHigh;
1734     dataVersion <<= 32;
1735     dataVersion |= statusp->DataVersion;
1736
1737     if (!(flags & CM_MERGEFLAG_FORCE) &&
1738         dataVersion < scp->dataVersion &&
1739         scp->dataVersion != CM_SCACHE_VERSION_BAD) {
1740
1741         cellp = cm_FindCellByID(scp->fid.cell, 0);
1742         if (scp->cbServerp) {
1743             cm_FindVolumeByID(cellp, scp->fid.volume, userp,
1744                               reqp, CM_GETVOL_FLAG_CREATE, &volp);
1745             osi_Log2(afsd_logp, "old data from server %x volume %s",
1746                       scp->cbServerp->addr.sin_addr.s_addr,
1747                       volp ? volp->namep : "(unknown)");
1748         }
1749
1750         osi_Log3(afsd_logp, "Bad merge, scp 0x%p, scp dv %d, RPC dv %d",
1751                   scp, scp->dataVersion, dataVersion);
1752         /* we have a number of data fetch/store operations running
1753          * concurrently, and we can tell which one executed last at the
1754          * server by its mtime.
1755          * Choose the one with the largest mtime, and ignore the rest.
1756          *
1757          * These concurrent calls are incompatible with setting the
1758          * mtime, so we won't have a locally changed mtime here.
1759          *
1760          * We could also have ACL info for a different user than usual,
1761          * in which case we have to do that part of the merge, anyway.
1762          * We won't have to worry about the info being old, since we
1763          * won't have concurrent calls
1764          * that change file status running from this machine.
1765          *
1766          * Added 3/17/98:  if we see data version regression on an RO
1767          * file, it's probably due to a server holding an out-of-date
1768          * replica, rather than to concurrent RPC's.  Failures to
1769          * release replicas are now flagged by the volserver, but only
1770          * since AFS 3.4 5.22, so there are plenty of clients getting
1771          * out-of-date replicas out there.
1772          *
1773          * If we discover an out-of-date replica, by this time it's too
1774          * late to go to another server and retry.  Also, we can't
1775          * reject the merge, because then there is no way for
1776          * GetAccess to do its work, and the caller gets into an
1777          * infinite loop.  So we just grin and bear it.
1778          */
1779         if (!(scp->flags & CM_SCACHEFLAG_RO))
1780             goto done;
1781     }
1782
1783     /*
1784      * The first field of the volsync parameter is supposed to be the
1785      * volume creation date.  Unfortunately, pre-OpenAFS 1.4.11 and 1.6.0
1786      * file servers do not populate the VolSync structure for BulkStat and
1787      * InlineBulkStat RPCs.  As a result, the volume creation date is not
1788      * trustworthy when status is obtained via [Inline]BulkStatus RPCs.
1789      * If cm_readonlyVolumeVersioning is set, it is assumed that all file
1790      * servers populate the VolSync structure at all times.
1791      */
1792     if (cm_readonlyVolumeVersioning || !(flags & CM_MERGEFLAG_BULKSTAT))
1793         scp->volumeCreationDate = volsyncp->spare1;       /* volume creation date */
1794     else
1795         scp->volumeCreationDate = 0;
1796
1797     scp->serverModTime = statusp->ServerModTime;
1798
1799     if (!(scp->mask & CM_SCACHEMASK_CLIENTMODTIME)) {
1800         scp->clientModTime = statusp->ClientModTime;
1801     }
1802     if (!(scp->mask & CM_SCACHEMASK_LENGTH)) {
1803         scp->length.LowPart = statusp->Length;
1804         scp->length.HighPart = statusp->Length_hi;
1805     }
1806
1807     scp->serverLength.LowPart = statusp->Length;
1808     scp->serverLength.HighPart = statusp->Length_hi;
1809
1810     scp->linkCount = statusp->LinkCount;
1811     scp->owner = statusp->Owner;
1812     scp->group = statusp->Group;
1813     scp->unixModeBits = statusp->UnixModeBits & 07777;
1814
1815     if (statusp->FileType == File)
1816         scp->fileType = CM_SCACHETYPE_FILE;
1817     else if (statusp->FileType == Directory)
1818         scp->fileType = CM_SCACHETYPE_DIRECTORY;
1819     else if (statusp->FileType == SymbolicLink) {
1820         if ((scp->unixModeBits & 0111) == 0)
1821             scp->fileType = CM_SCACHETYPE_MOUNTPOINT;
1822         else
1823             scp->fileType = CM_SCACHETYPE_SYMLINK;
1824     }
1825     else {
1826         osi_Log2(afsd_logp, "Merge, Invalid File Type (%d), scp 0x%p", statusp->FileType, scp);
1827         scp->fileType = CM_SCACHETYPE_INVALID;  /* invalid */
1828     }
1829     /* and other stuff */
1830     scp->parentVnode = statusp->ParentVnode;
1831     scp->parentUnique = statusp->ParentUnique;
1832
1833     /* -1 is a write lock; any positive values are read locks */
1834     scp->fsLockCount = (afs_int32)statusp->lockCount;
1835
1836     /* and merge in the private acl cache info, if this is more than the public
1837      * info; merge in the public stuff in any case.
1838      */
1839     scp->anyAccess = statusp->AnonymousAccess;
1840
1841     if (userp != NULL) {
1842         cm_AddACLCache(scp, userp, statusp->CallerAccess);
1843     }
1844
1845     if (dataVersion != 0 && scp->dataVersion != CM_SCACHE_VERSION_BAD &&
1846         (!(flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) && (dataVersion != scp->dataVersion) ||
1847          (flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) &&
1848          (dv_diff(dataVersion, scp->dataVersion) > activeRPCs))) {
1849         /*
1850          * We now know that all of the data buffers that we have associated
1851          * with this scp are invalid.  Subsequent operations will go faster
1852          * if the buffers are removed from the hash tables.
1853          *
1854          * We do not remove directory buffers if the dataVersion delta is 'activeRPCs' because
1855          * those version numbers will be updated as part of the directory operation.
1856          *
1857          * We do not remove storedata buffers because they will still be valid.
1858          */
1859         int i, j;
1860         cm_buf_t **lbpp;
1861         cm_buf_t *tbp;
1862         cm_buf_t *bp, *prevBp, *nextBp;
1863
1864         lock_ObtainWrite(&buf_globalLock);
1865         i = BUF_FILEHASH(&scp->fid);
1866         for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=nextBp)
1867         {
1868             nextBp = bp->fileHashp;
1869             /*
1870              * if the buffer belongs to this stat cache entry
1871              * and the buffer mutex can be obtained, check the
1872              * reference count and if it is zero, remove the buffer
1873              * from the hash tables.  If there are references,
1874              * the buffer might be updated to the current version
1875              * so leave it in place.
1876              */
1877             if (cm_FidCmp(&scp->fid, &bp->fid) == 0 &&
1878                  lock_TryMutex(&bp->mx)) {
1879                 if (bp->refCount == 0 &&
1880                     !(bp->flags & (CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)) &&
1881                     !(bp->qFlags & CM_BUF_QREDIR)) {
1882                     prevBp = bp->fileHashBackp;
1883                     bp->fileHashBackp = bp->fileHashp = NULL;
1884                     if (prevBp)
1885                         prevBp->fileHashp = nextBp;
1886                     else
1887                         cm_data.buf_fileHashTablepp[i] = nextBp;
1888                     if (nextBp)
1889                         nextBp->fileHashBackp = prevBp;
1890
1891                     j = BUF_HASH(&bp->fid, &bp->offset);
1892                     lbpp = &(cm_data.buf_scacheHashTablepp[j]);
1893                     for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = tbp->hashp) {
1894                         if (tbp == bp)
1895                             break;
1896                     }
1897
1898                     /* we better find it */
1899                     osi_assertx(tbp != NULL, "cm_MergeStatus: buf_scacheHashTablepp table screwup");
1900
1901                     *lbpp = bp->hashp;  /* hash out */
1902                     bp->hashp = NULL;
1903
1904                     _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINHASH);
1905                 }
1906                 lock_ReleaseMutex(&bp->mx);
1907             }
1908         }
1909         lock_ReleaseWrite(&buf_globalLock);
1910     }
1911
1912     if (scp->dataVersion != dataVersion && !(flags & CM_MERGEFLAG_FETCHDATA)) {
1913         osi_Log5(afsd_logp, "cm_MergeStatus data version change scp 0x%p cell %u vol %u vn %u uniq %u",
1914                  scp, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
1915
1916         osi_Log4(afsd_logp, ".... oldDV 0x%x:%x -> newDV 0x%x:%x",
1917                  (afs_uint32)((scp->dataVersion >> 32) & 0xFFFFFFFF),
1918                  (afs_uint32)(scp->dataVersion & 0xFFFFFFFF),
1919                  (afs_uint32)((dataVersion >> 32) & 0xFFFFFFFF),
1920                  (afs_uint32)(dataVersion & 0xFFFFFFFF));
1921     }
1922
1923     /* We maintain a range of buffer dataVersion values which are considered
1924      * valid.  This avoids the need to update the dataVersion on each buffer
1925      * object during an uncontested storeData operation.  As a result this
1926      * merge status no longer has performance characteristics derived from
1927      * the size of the file.
1928      *
1929      * For directory buffers, only current dataVersion values are up to date.
1930      */
1931     if (((flags & (CM_MERGEFLAG_STOREDATA|CM_MERGEFLAG_DIROP)) && (dv_diff(dataVersion, scp->dataVersion) > activeRPCs)) ||
1932          (!(flags & (CM_MERGEFLAG_STOREDATA|CM_MERGEFLAG_DIROP)) && (scp->dataVersion != dataVersion)) ||
1933          scp->bufDataVersionLow == CM_SCACHE_VERSION_BAD ||
1934          scp->fileType == CM_SCACHETYPE_DIRECTORY)
1935         scp->bufDataVersionLow = dataVersion;
1936
1937     if (RDR_Initialized) {
1938         /*
1939          * The redirector maintains its own cached status information which
1940          * must be updated when a DV change occurs that is not the result
1941          * of a redirector initiated data change.
1942          *
1943          * If the current old DV is BAD, send a DV change notification.
1944          *
1945          * If the DV has changed and request was not initiated by the
1946          * redirector, send a DV change notification.
1947          *
1948          * If the request was initiated by the redirector, send a notification
1949          * for store and directory operations that result in a DV change greater
1950          * than the number of active RPCs or any other operation that results
1951          * in an unexpected DV change such as FetchStatus.
1952          */
1953
1954         if (scp->dataVersion == CM_SCACHE_VERSION_BAD && dataVersion != 0) {
1955             rdr_invalidate = 1;
1956         } else if (!(reqp->flags & CM_REQ_SOURCE_REDIR) && scp->dataVersion != dataVersion) {
1957             rdr_invalidate = 1;
1958         } else if (reqp->flags & CM_REQ_SOURCE_REDIR) {
1959             if (!(flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) &&
1960                 (dv_diff(dataVersion, scp->dataVersion) > activeRPCs - 1)) {
1961                 rdr_invalidate = 1;
1962             } else if ((flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) &&
1963                        dv_diff(dataVersion, scp->dataVersion) > activeRPCs) {
1964                 rdr_invalidate = 1;
1965             }
1966         }
1967     }
1968     scp->dataVersion = dataVersion;
1969
1970     /*
1971      * If someone is waiting for status information, we can wake them up
1972      * now even though the entity that issued the FetchStatus may not
1973      * have completed yet.
1974      */
1975     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_FETCHSTATUS);
1976
1977     /*
1978      * We just successfully merged status on the stat cache object.
1979      * This means that the associated volume must be online.
1980      */
1981     if (!volp) {
1982         if (!cellp)
1983             cellp = cm_FindCellByID(scp->fid.cell, 0);
1984         cm_FindVolumeByID(cellp, scp->fid.volume, userp, reqp, 0, &volp);
1985     }
1986     if (volp) {
1987         cm_vol_state_t *statep = cm_VolumeStateByID(volp, scp->fid.volume);
1988         if (statep->state != vl_online) {
1989             lock_ObtainWrite(&volp->rw);
1990             cm_VolumeStatusNotification(volp, statep->ID, statep->state, vl_online);
1991             statep->state = vl_online;
1992             lock_ReleaseWrite(&volp->rw);
1993         }
1994     }
1995
1996     /* Remove cached EACCES / EPERM errors if the file is a directory */
1997     if (scp->fileType == CM_SCACHETYPE_DIRECTORY &&
1998         !(volp && (volp->flags & CM_VOLUMEFLAG_DFS_VOLUME)) &&
1999         !cm_accessPerFileCheck)
2000     {
2001         cm_EAccesClearParentEntries(&scp->fid);
2002     }
2003
2004   done:
2005     if (volp)
2006         cm_PutVolume(volp);
2007
2008     /*
2009      * The scache rw lock cannot be held across the invalidation.
2010      * Doing so can result in deadlocks with other threads processing
2011      * requests initiated by the afs redirector.
2012      */
2013     if (rdr_invalidate) {
2014         lock_ReleaseWrite(&scp->rw);
2015         RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
2016                              scp->fid.unique, scp->fid.hash,
2017                              scp->fileType, AFS_INVALIDATE_DATA_VERSION);
2018         lock_ObtainWrite(&scp->rw);
2019     }
2020
2021     return 0;
2022 }
2023
2024 /* note that our stat cache info is incorrect, so force us eventually
2025  * to stat the file again.  There may be dirty data associated with
2026  * this vnode, and we want to preserve that information.
2027  *
2028  * This function works by simply simulating a loss of the callback.
2029  *
2030  * This function must be called with the scache locked.
2031  */
2032 void cm_DiscardSCache(cm_scache_t *scp)
2033 {
2034     lock_AssertWrite(&scp->rw);
2035     if (scp->cbServerp) {
2036         cm_PutServer(scp->cbServerp);
2037         scp->cbServerp = NULL;
2038     }
2039     scp->cbExpires = 0;
2040     scp->cbIssued = 0;
2041     _InterlockedAnd(&scp->flags, ~(CM_SCACHEFLAG_LOCAL | CM_SCACHEFLAG_RDR_IN_USE));
2042     cm_dnlcPurgedp(scp);
2043     cm_dnlcPurgevp(scp);
2044     cm_FreeAllACLEnts(scp);
2045
2046     if (scp->fileType == CM_SCACHETYPE_DFSLINK)
2047         cm_VolStatus_Invalidate_DFS_Mapping(scp);
2048 }
2049
2050 void cm_AFSFidFromFid(AFSFid *afsFidp, cm_fid_t *fidp)
2051 {
2052     afsFidp->Volume = fidp->volume;
2053     afsFidp->Vnode = fidp->vnode;
2054     afsFidp->Unique = fidp->unique;
2055 }
2056
2057 #ifdef DEBUG_REFCOUNT
2058 void cm_HoldSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
2059 #else
2060 void cm_HoldSCacheNoLock(cm_scache_t *scp)
2061 #endif
2062 {
2063     afs_int32 refCount;
2064
2065     osi_assertx(scp != NULL, "null cm_scache_t");
2066     lock_AssertAny(&cm_scacheLock);
2067     refCount = InterlockedIncrement(&scp->refCount);
2068 #ifdef DEBUG_REFCOUNT
2069     osi_Log2(afsd_logp,"cm_HoldSCacheNoLock scp 0x%p ref %d",scp, refCount);
2070     afsi_log("%s:%d cm_HoldSCacheNoLock scp 0x%p, ref %d", file, line, scp, refCount);
2071 #endif
2072 }
2073
2074 #ifdef DEBUG_REFCOUNT
2075 void cm_HoldSCacheDbg(cm_scache_t *scp, char * file, long line)
2076 #else
2077 void cm_HoldSCache(cm_scache_t *scp)
2078 #endif
2079 {
2080     afs_int32 refCount;
2081
2082     osi_assertx(scp != NULL, "null cm_scache_t");
2083     lock_ObtainRead(&cm_scacheLock);
2084     refCount = InterlockedIncrement(&scp->refCount);
2085 #ifdef DEBUG_REFCOUNT
2086     osi_Log2(afsd_logp,"cm_HoldSCache scp 0x%p ref %d",scp, refCount);
2087     afsi_log("%s:%d cm_HoldSCache scp 0x%p ref %d", file, line, scp, refCount);
2088 #endif
2089     lock_ReleaseRead(&cm_scacheLock);
2090 }
2091
2092 #ifdef DEBUG_REFCOUNT
2093 void cm_ReleaseSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
2094 #else
2095 void cm_ReleaseSCacheNoLock(cm_scache_t *scp)
2096 #endif
2097 {
2098     afs_int32 refCount;
2099
2100     osi_assertx(scp != NULL, "null cm_scache_t");
2101     lock_AssertAny(&cm_scacheLock);
2102
2103     refCount = InterlockedDecrement(&scp->refCount);
2104 #ifdef DEBUG_REFCOUNT
2105     if (refCount < 0)
2106         osi_Log1(afsd_logp,"cm_ReleaseSCacheNoLock about to panic scp 0x%x",scp);
2107 #endif
2108     osi_assertx(refCount >= 0, "cm_scache_t refCount 0");
2109 #ifdef DEBUG_REFCOUNT
2110     osi_Log2(afsd_logp,"cm_ReleaseSCacheNoLock scp 0x%p ref %d",scp, refCount);
2111     afsi_log("%s:%d cm_ReleaseSCacheNoLock scp 0x%p ref %d", file, line, scp, refCount);
2112 #endif
2113
2114     if (refCount == 0 && (scp->flags & CM_SCACHEFLAG_DELETED)) {
2115         int deleted = 0;
2116         long      lockstate;
2117
2118         lockstate = lock_GetRWLockState(&cm_scacheLock);
2119         if (lockstate != OSI_RWLOCK_WRITEHELD)
2120             lock_ReleaseRead(&cm_scacheLock);
2121         else
2122             lock_ReleaseWrite(&cm_scacheLock);
2123
2124         lock_ObtainWrite(&scp->rw);
2125         if (scp->flags & CM_SCACHEFLAG_DELETED)
2126             deleted = 1;
2127
2128         if (refCount == 0 && deleted) {
2129             lock_ObtainWrite(&cm_scacheLock);
2130             cm_RecycleSCache(scp, 0);
2131             if (lockstate != OSI_RWLOCK_WRITEHELD)
2132                 lock_ConvertWToR(&cm_scacheLock);
2133         } else {
2134             if (lockstate != OSI_RWLOCK_WRITEHELD)
2135                 lock_ObtainRead(&cm_scacheLock);
2136             else
2137                 lock_ObtainWrite(&cm_scacheLock);
2138         }
2139         lock_ReleaseWrite(&scp->rw);
2140     }
2141 }
2142
2143 #ifdef DEBUG_REFCOUNT
2144 void cm_ReleaseSCacheDbg(cm_scache_t *scp, char * file, long line)
2145 #else
2146 void cm_ReleaseSCache(cm_scache_t *scp)
2147 #endif
2148 {
2149     afs_int32 refCount;
2150
2151     osi_assertx(scp != NULL, "null cm_scache_t");
2152     lock_ObtainRead(&cm_scacheLock);
2153     refCount = InterlockedDecrement(&scp->refCount);
2154 #ifdef DEBUG_REFCOUNT
2155     if (refCount < 0)
2156         osi_Log1(afsd_logp,"cm_ReleaseSCache about to panic scp 0x%x",scp);
2157 #endif
2158     osi_assertx(refCount >= 0, "cm_scache_t refCount 0");
2159 #ifdef DEBUG_REFCOUNT
2160     osi_Log2(afsd_logp,"cm_ReleaseSCache scp 0x%p ref %d",scp, refCount);
2161     afsi_log("%s:%d cm_ReleaseSCache scp 0x%p ref %d", file, line, scp, refCount);
2162 #endif
2163     lock_ReleaseRead(&cm_scacheLock);
2164
2165     if (scp->flags & CM_SCACHEFLAG_DELETED) {
2166         int deleted = 0;
2167         lock_ObtainWrite(&scp->rw);
2168         if (scp->flags & CM_SCACHEFLAG_DELETED)
2169             deleted = 1;
2170         if (deleted) {
2171             lock_ObtainWrite(&cm_scacheLock);
2172             cm_RecycleSCache(scp, 0);
2173             lock_ReleaseWrite(&cm_scacheLock);
2174         }
2175         lock_ReleaseWrite(&scp->rw);
2176     }
2177 }
2178
2179 /* just look for the scp entry to get filetype */
2180 /* doesn't need to be perfectly accurate, so locking doesn't matter too much */
2181 int cm_FindFileType(cm_fid_t *fidp)
2182 {
2183     long hash;
2184     cm_scache_t *scp;
2185
2186     hash = CM_SCACHE_HASH(fidp);
2187
2188     osi_assertx(fidp->cell != 0, "unassigned cell value");
2189
2190     lock_ObtainWrite(&cm_scacheLock);
2191     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
2192         if (cm_FidCmp(fidp, &scp->fid) == 0) {
2193             lock_ReleaseWrite(&cm_scacheLock);
2194             return scp->fileType;
2195         }
2196     }
2197     lock_ReleaseWrite(&cm_scacheLock);
2198     return 0;
2199 }
2200
2201 /* dump all scp's that have reference count > 0 to a file.
2202  * cookie is used to identify this batch for easy parsing,
2203  * and it a string provided by a caller
2204  */
2205 int cm_DumpSCache(FILE *outputFile, char *cookie, int lock)
2206 {
2207     int zilch;
2208     cm_scache_t *scp;
2209     osi_queue_t *q;
2210     char output[2048];
2211     int i;
2212
2213     if (lock)
2214         lock_ObtainRead(&cm_scacheLock);
2215
2216     sprintf(output, "%s - dumping all scache - cm_data.currentSCaches=%d, cm_data.maxSCaches=%d\r\n", cookie, cm_data.currentSCaches, cm_data.maxSCaches);
2217     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2218
2219     for (scp = cm_data.allSCachesp; scp; scp = scp->allNextp)
2220     {
2221         time_t t;
2222         char *srvStr = NULL;
2223         afs_uint32 srvStrRpc = TRUE;
2224         char *cbt = NULL;
2225         char *cdrot = NULL;
2226
2227         if (scp->cbServerp) {
2228             if (!((scp->cbServerp->flags & CM_SERVERFLAG_UUID) &&
2229                 UuidToString((UUID *)&scp->cbServerp->uuid, &srvStr) == RPC_S_OK)) {
2230                 srvStr = malloc(16); /* enough for 255.255.255.255 */
2231                 if (srvStr != NULL)
2232                     afs_inet_ntoa_r(scp->cbServerp->addr.sin_addr.s_addr, srvStr);
2233                 srvStrRpc = FALSE;
2234             }
2235         }
2236         if (scp->cbExpires) {
2237             t = scp->cbExpires;
2238             cbt = ctime(&t);
2239             if (cbt) {
2240                 cbt = strdup(cbt);
2241                 cbt[strlen(cbt)-1] = '\0';
2242             }
2243         }
2244         if (scp->volumeCreationDate) {
2245             t = scp->volumeCreationDate;
2246             cdrot = ctime(&t);
2247             if (cdrot) {
2248                 cdrot = strdup(cdrot);
2249                 cdrot[strlen(cdrot)-1] = '\0';
2250             }
2251         }
2252         sprintf(output,
2253                 "%s scp=0x%p, fid (cell=%d, volume=%d, vnode=%d, unique=%d) type=%d dv=%I64d len=0x%I64x "
2254                 "mpDV=%I64d mp='%s' Locks (server=0x%x shared=%d excl=%d clnt=%d) fsLockCount=%d linkCount=%d anyAccess=0x%x "
2255                 "flags=0x%x cbServer='%s' cbExpires='%s' volumeCreationDate='%s' refCount=%u\r\n",
2256                 cookie, scp, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique,
2257                 scp->fileType, scp->dataVersion, scp->length.QuadPart, scp->mpDataVersion, scp->mountPointStringp,
2258                 scp->serverLock, scp->sharedLocks, scp->exclusiveLocks, scp->clientLocks, scp->fsLockCount,
2259                 scp->linkCount, scp->anyAccess, scp->flags, srvStr ? srvStr : "<none>", cbt ? cbt : "<none>",
2260                 cdrot ? cdrot : "<none>", scp->refCount);
2261         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2262
2263         if (scp->fileLocksH) {
2264             sprintf(output, "  %s - begin dumping scp locks\r\n", cookie);
2265             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2266
2267             for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
2268                 cm_file_lock_t * lockp = fileq_to_cm_file_lock_t(q);
2269                 sprintf(output, "  %s lockp=0x%p scp=0x%p, cm_userp=0x%p offset=0x%I64x len=0x%08I64x type=0x%x "
2270                         "key=0x%I64x flags=0x%x update=0x%I64u\r\n",
2271                         cookie, lockp, lockp->scp, lockp->userp, lockp->range.offset, lockp->range.length,
2272                         lockp->lockType, lockp->key, lockp->flags, (afs_uint64)lockp->lastUpdate);
2273                 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2274             }
2275
2276             sprintf(output, "  %s - done dumping scp locks\r\n", cookie);
2277             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2278         }
2279
2280         if (srvStr) {
2281             if (srvStrRpc)
2282                 RpcStringFree(&srvStr);
2283             else
2284                 free(srvStr);
2285         }
2286         if (cbt)
2287             free(cbt);
2288         if (cdrot)
2289             free(cdrot);
2290     }
2291
2292     sprintf(output, "%s - Done dumping all scache.\r\n", cookie);
2293     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2294     sprintf(output, "%s - dumping cm_data.scacheHashTable - cm_data.scacheHashTableSize=%d\r\n",
2295             cookie, cm_data.scacheHashTableSize);
2296     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2297
2298     for (i = 0; i < cm_data.scacheHashTableSize; i++)
2299     {
2300         for(scp = cm_data.scacheHashTablep[i]; scp; scp=scp->nextp)
2301         {
2302             sprintf(output, "%s scp=0x%p, hash=%d, fid (cell=%d, volume=%d, vnode=%d, unique=%d)\r\n",
2303                     cookie, scp, i, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
2304             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2305         }
2306     }
2307
2308     sprintf(output, "%s - Done dumping cm_data.scacheHashTable\r\n", cookie);
2309     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2310
2311     sprintf(output, "%s - begin dumping all file locks\r\n", cookie);
2312     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2313
2314     for (q = cm_allFileLocks; q; q = osi_QNext(q)) {
2315         cm_file_lock_t * lockp = (cm_file_lock_t *)q;
2316         sprintf(output, "%s filelockp=0x%p scp=0x%p, cm_userp=0x%p offset=0x%I64x len=0x%08I64x type=0x%x key=0x%I64x flags=0x%x update=0x%I64u\r\n",
2317                  cookie, lockp, lockp->scp, lockp->userp, lockp->range.offset, lockp->range.length,
2318                  lockp->lockType, lockp->key, lockp->flags, (afs_uint64)lockp->lastUpdate);
2319         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2320     }
2321
2322     sprintf(output, "%s - done dumping all file locks\r\n", cookie);
2323     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2324
2325     if (lock)
2326         lock_ReleaseRead(&cm_scacheLock);
2327     return (0);
2328 }
2329