31afbb09264daa344240d4c3b8650d5c1ea1b6d0
[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     osi_QRemoveHT((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **) &cm_data.scacheLRULastp, &scp->q);
70     if (scp->flags & CM_SCACHEFLAG_DELETED) {
71         /* Since it has been deleted make it the first to be recycled. */
72         osi_QAddT((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **) &cm_data.scacheLRULastp, &scp->q);
73     } else {
74         osi_QAddH((osi_queue_t **) &cm_data.scacheLRUFirstp, (osi_queue_t **) &cm_data.scacheLRULastp, &scp->q);
75     }
76 }
77
78 /* call with cm_scacheLock write-locked and scp rw held */
79 void cm_RemoveSCacheFromHashTable(cm_scache_t *scp)
80 {
81     cm_scache_t **lscpp;
82     cm_scache_t *tscp;
83     int i;
84
85     lock_AssertWrite(&cm_scacheLock);
86     lock_AssertWrite(&scp->rw);
87     if (scp->flags & CM_SCACHEFLAG_INHASH) {
88         /* hash it out first */
89         i = CM_SCACHE_HASH(&scp->fid);
90         for (lscpp = &cm_data.scacheHashTablep[i], tscp = cm_data.scacheHashTablep[i];
91              tscp;
92              lscpp = &tscp->nextp, tscp = tscp->nextp) {
93             if (tscp == scp) {
94                 *lscpp = scp->nextp;
95                 scp->nextp = NULL;
96                 _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_INHASH);
97                 break;
98             }
99         }
100     }
101 }
102
103 /* called with cm_scacheLock and scp write-locked */
104 void cm_ResetSCacheDirectory(cm_scache_t *scp, afs_int32 dirlock)
105 {
106 #ifdef USE_BPLUS
107     /* destroy directory Bplus Tree */
108     if (scp->dirBplus) {
109         LARGE_INTEGER start, end;
110
111         if (!dirlock && !lock_TryWrite(&scp->dirlock)) {
112             /*
113              * We are not holding the dirlock and obtaining it
114              * requires that we drop the scp->rw.  As a result
115              * we will leave the dirBplus tree intact but
116              * invalidate the version number so that whatever
117              * operation is currently active can safely complete
118              * but the contents will be ignored on the next
119              * directory operation.
120              */
121             scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
122             return;
123         }
124
125         QueryPerformanceCounter(&start);
126         bplus_free_tree++;
127         freeBtree(scp->dirBplus);
128         scp->dirBplus = NULL;
129         scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
130         QueryPerformanceCounter(&end);
131
132         if (!dirlock)
133             lock_ReleaseWrite(&scp->dirlock);
134
135         bplus_free_time += (end.QuadPart - start.QuadPart);
136     }
137 #endif
138 }
139
140 /* called with cm_scacheLock and scp write-locked; recycles an existing scp. */
141 long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags)
142 {
143     cm_fid_t fid;
144     afs_uint32 fileType;
145     int callback;
146
147     lock_AssertWrite(&cm_scacheLock);
148     lock_AssertWrite(&scp->rw);
149
150     if (scp->refCount != 0) {
151         return -1;
152     }
153
154     if (scp->flags & CM_SCACHEFLAG_SMB_FID) {
155         osi_Log1(afsd_logp,"cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected scp 0x%p", scp);
156 #ifdef DEBUG
157         osi_panic("cm_RecycleSCache CM_SCACHEFLAG_SMB_FID detected",__FILE__,__LINE__);
158 #endif
159         return -1;
160     }
161
162     if (scp->redirBufCount != 0) {
163         return -1;
164     }
165
166     fid = scp->fid;
167     fileType = scp->fileType;
168     callback = scp->cbExpires ? 1 : 0;
169
170     cm_RemoveSCacheFromHashTable(scp);
171
172     if (scp->fileType == CM_SCACHETYPE_DIRECTORY &&
173          !cm_accessPerFileCheck) {
174         cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
175
176         if (!(volp && (volp->flags & CM_VOLUMEFLAG_DFS_VOLUME)))
177             cm_EAccesClearParentEntries(&fid);
178         cm_PutVolume(volp);
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_STATD
186                      | CM_SCACHEFLAG_DELETED
187                      | CM_SCACHEFLAG_RO
188                      | CM_SCACHEFLAG_PURERO
189                      | CM_SCACHEFLAG_OVERQUOTA
190                      | CM_SCACHEFLAG_OUTOFSPACE));
191     scp->serverModTime = 0;
192     scp->dataVersion = CM_SCACHE_VERSION_BAD;
193     scp->bufDataVersionLow = CM_SCACHE_VERSION_BAD;
194     scp->bulkStatProgress = hzero;
195     scp->waitCount = 0;
196     scp->waitQueueT = NULL;
197
198     if (scp->cbServerp) {
199         cm_PutServer(scp->cbServerp);
200         scp->cbServerp = NULL;
201     }
202     scp->cbExpires = 0;
203     scp->cbIssued = 0;
204     scp->volumeCreationDate = 0;
205
206     scp->fid.vnode = 0;
207     scp->fid.volume = 0;
208     scp->fid.unique = 0;
209     scp->fid.cell = 0;
210     scp->fid.hash = 0;
211
212     /* remove from dnlc */
213     cm_dnlcPurgedp(scp);
214     cm_dnlcPurgevp(scp);
215
216     /* discard cached status; if non-zero, Close
217      * tried to store this to server but failed */
218     scp->mask = 0;
219
220     /* discard symlink info */
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 + cm_data.currentSCaches;
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_data.currentSCaches++;
410     cm_dnlcPurgedp(scp); /* make doubly sure that this is not in dnlc */
411     cm_dnlcPurgevp(scp);
412     scp->allNextp = cm_data.allSCachesp;
413     cm_data.allSCachesp = scp;
414
415   done:
416     if (!locked)
417         lock_ReleaseWrite(&cm_scacheLock);
418
419     return scp;
420 }
421
422 void cm_SetFid(cm_fid_t *fidp, afs_uint32 cell, afs_uint32 volume, afs_uint32 vnode, afs_uint32 unique)
423 {
424     fidp->cell = cell;
425     fidp->volume = volume;
426     fidp->vnode = vnode;
427     fidp->unique = unique;
428     CM_FID_GEN_HASH(fidp);
429 }
430
431 /* like strcmp, only for fids */
432 __inline int cm_FidCmp(cm_fid_t *ap, cm_fid_t *bp)
433 {
434     if (ap->hash != bp->hash)
435         return 1;
436     if (ap->vnode != bp->vnode)
437         return 1;
438     if (ap->volume != bp->volume)
439         return 1;
440     if (ap->unique != bp->unique)
441         return 1;
442     if (ap->cell != bp->cell)
443         return 1;
444     return 0;
445 }
446
447 void cm_fakeSCacheInit(int newFile)
448 {
449     if ( newFile ) {
450         memset(&cm_data.fakeSCache, 0, sizeof(cm_scache_t));
451         cm_data.fakeSCache.magic = CM_SCACHE_MAGIC;
452         cm_data.fakeSCache.cbServerp = (struct cm_server *)(-1);
453         cm_data.fakeSCache.cbExpires = (time_t)-1;
454         cm_data.fakeSCache.cbExpires = time(NULL);
455         /* can leave clientModTime at 0 */
456         cm_data.fakeSCache.fileType = CM_SCACHETYPE_FILE;
457         cm_data.fakeSCache.unixModeBits = 0777;
458         cm_data.fakeSCache.length.LowPart = 1000;
459         cm_data.fakeSCache.linkCount = 1;
460         cm_data.fakeSCache.refCount = 1;
461         cm_data.fakeSCache.serverLock = -1;
462         cm_data.fakeSCache.dataVersion = CM_SCACHE_VERSION_BAD;
463     }
464     lock_InitializeRWLock(&cm_data.fakeSCache.rw, "cm_scache_t rw", LOCK_HIERARCHY_SCACHE);
465     lock_InitializeRWLock(&cm_data.fakeSCache.bufCreateLock, "cm_scache_t bufCreateLock", LOCK_HIERARCHY_SCACHE_BUFCREATE);
466     lock_InitializeRWLock(&cm_data.fakeSCache.dirlock, "cm_scache_t dirlock", LOCK_HIERARCHY_SCACHE_DIRLOCK);
467     lock_InitializeMutex(&cm_data.fakeSCache.redirMx, "cm_scache_t redirMx", LOCK_HIERARCHY_SCACHE_REDIRMX);
468 }
469
470 long
471 cm_ValidateSCache(void)
472 {
473     cm_scache_t * scp, *lscp;
474     long i;
475
476     if ( cm_data.scacheLRUFirstp == NULL && cm_data.scacheLRULastp != NULL ||
477          cm_data.scacheLRUFirstp != NULL && cm_data.scacheLRULastp == NULL) {
478         afsi_log("cm_ValidateSCache failure: inconsistent LRU pointers");
479         fprintf(stderr, "cm_ValidateSCache failure: inconsistent LRU pointers\n");
480         return -17;
481     }
482
483     for ( scp = cm_data.scacheLRUFirstp, lscp = NULL, i = 0;
484           scp;
485           lscp = scp, scp = (cm_scache_t *) osi_QNext(&scp->q), i++ ) {
486         if (scp->magic != CM_SCACHE_MAGIC) {
487             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
488             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
489             return -1;
490         }
491         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
492             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
493             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
494             return -2;
495         }
496         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
497             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
498             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
499             return -3;
500         }
501         if (i > cm_data.currentSCaches ) {
502             afsi_log("cm_ValidateSCache failure: LRU First queue loops");
503             fprintf(stderr, "cm_ValidateSCache failure: LUR First queue loops\n");
504             return -13;
505         }
506         if (lscp != (cm_scache_t *) osi_QPrev(&scp->q)) {
507             afsi_log("cm_ValidateSCache failure: QPrev(scp) != previous");
508             fprintf(stderr, "cm_ValidateSCache failure: QPrev(scp) != previous\n");
509             return -15;
510         }
511     }
512
513     for ( scp = cm_data.scacheLRULastp, lscp = NULL, i = 0; scp;
514           lscp = scp, scp = (cm_scache_t *) osi_QPrev(&scp->q), i++ ) {
515         if (scp->magic != CM_SCACHE_MAGIC) {
516             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
517             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
518             return -5;
519         }
520         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
521             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
522             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
523             return -6;
524         }
525         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
526             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
527             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
528             return -7;
529         }
530         if (i > cm_data.currentSCaches ) {
531             afsi_log("cm_ValidateSCache failure: LRU Last queue loops");
532             fprintf(stderr, "cm_ValidateSCache failure: LUR Last queue loops\n");
533             return -14;
534         }
535         if (lscp != (cm_scache_t *) osi_QNext(&scp->q)) {
536             afsi_log("cm_ValidateSCache failure: QNext(scp) != next");
537             fprintf(stderr, "cm_ValidateSCache failure: QNext(scp) != next\n");
538             return -16;
539         }
540     }
541
542     for ( i=0; i < cm_data.scacheHashTableSize; i++ ) {
543         for ( scp = cm_data.scacheHashTablep[i]; scp; scp = scp->nextp ) {
544             afs_uint32 hash;
545             hash = CM_SCACHE_HASH(&scp->fid);
546             if (scp->magic != CM_SCACHE_MAGIC) {
547                 afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
548                 fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
549                 return -9;
550             }
551             if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
552                 afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
553                 fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
554                 return -10;
555             }
556             if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
557                 afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
558                 fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
559                 return -11;
560             }
561             if (hash != i) {
562                 afsi_log("cm_ValidateSCache failure: scp hash != hash index");
563                 fprintf(stderr, "cm_ValidateSCache failure: scp hash != hash index\n");
564                 return -13;
565             }
566         }
567     }
568
569     return cm_dnlcValidate();
570 }
571
572 void
573 cm_SuspendSCache(void)
574 {
575     cm_scache_t * scp;
576     time_t now;
577
578     cm_GiveUpAllCallbacksAllServersMulti(TRUE);
579
580     /*
581      * After this call all servers are marked down.
582      * Do not clear the callbacks, instead change the
583      * expiration time so that the callbacks will be expired
584      * when the servers are marked back up.  However, we
585      * want the callbacks to be preserved as long as the
586      * servers are down.  That way if the machine resumes
587      * without network, the stat cache item will still be
588      * considered valid.
589      */
590     now = time(NULL);
591
592     lock_ObtainWrite(&cm_scacheLock);
593     for ( scp = cm_data.allSCachesp; scp; scp = scp->allNextp ) {
594         if (scp->cbServerp) {
595             if (scp->flags & CM_SCACHEFLAG_PURERO) {
596                 cm_volume_t *volp = cm_GetVolumeByFID(&scp->fid);
597                 if (volp) {
598                     if (volp->cbExpiresRO == scp->cbExpires)
599                         volp->cbExpiresRO = now+1;
600                     cm_PutVolume(volp);
601                 }
602             }
603             scp->cbExpires = now+1;
604         }
605     }
606     lock_ReleaseWrite(&cm_scacheLock);
607 }
608
609 long
610 cm_ShutdownSCache(void)
611 {
612     cm_scache_t * scp, * nextp;
613
614     cm_GiveUpAllCallbacksAllServersMulti(FALSE);
615
616     lock_ObtainWrite(&cm_scacheLock);
617
618     for ( scp = cm_data.allSCachesp; scp;
619           scp = nextp ) {
620         nextp = scp->allNextp;
621         lock_ReleaseWrite(&cm_scacheLock);
622 #ifdef USE_BPLUS
623         lock_ObtainWrite(&scp->dirlock);
624 #endif
625         lock_ObtainWrite(&scp->rw);
626         lock_ObtainWrite(&cm_scacheLock);
627
628         if (scp->randomACLp) {
629             cm_FreeAllACLEnts(scp);
630         }
631
632         if (scp->cbServerp) {
633             cm_PutServer(scp->cbServerp);
634             scp->cbServerp = NULL;
635         }
636         scp->cbExpires = 0;
637         scp->cbIssued = 0;
638         _InterlockedAnd(&scp->flags, ~CM_SCACHEFLAG_CALLBACK);
639         lock_ReleaseWrite(&scp->rw);
640
641 #ifdef USE_BPLUS
642         if (scp->dirBplus)
643             freeBtree(scp->dirBplus);
644         scp->dirBplus = NULL;
645         scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
646         lock_ReleaseWrite(&scp->dirlock);
647         lock_FinalizeRWLock(&scp->dirlock);
648 #endif
649         lock_FinalizeRWLock(&scp->rw);
650         lock_FinalizeRWLock(&scp->bufCreateLock);
651         lock_FinalizeMutex(&scp->redirMx);
652     }
653     lock_ReleaseWrite(&cm_scacheLock);
654
655     return cm_dnlcShutdown();
656 }
657
658 void cm_InitSCache(int newFile, long maxSCaches)
659 {
660     static osi_once_t once;
661
662     if (osi_Once(&once)) {
663         lock_InitializeRWLock(&cm_scacheLock, "cm_scacheLock", LOCK_HIERARCHY_SCACHE_GLOBAL);
664         if ( newFile ) {
665             memset(cm_data.scacheHashTablep, 0, sizeof(cm_scache_t *) * cm_data.scacheHashTableSize);
666             cm_data.allSCachesp = NULL;
667             cm_data.currentSCaches = 0;
668             cm_data.maxSCaches = maxSCaches;
669             cm_data.scacheLRUFirstp = cm_data.scacheLRULastp = NULL;
670         } else {
671             cm_scache_t * scp;
672
673             for ( scp = cm_data.allSCachesp; scp;
674                   scp = scp->allNextp ) {
675                 lock_InitializeRWLock(&scp->rw, "cm_scache_t rw", LOCK_HIERARCHY_SCACHE);
676                 lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock", LOCK_HIERARCHY_SCACHE_BUFCREATE);
677 #ifdef USE_BPLUS
678                 lock_InitializeRWLock(&scp->dirlock, "cm_scache_t dirlock", LOCK_HIERARCHY_SCACHE_DIRLOCK);
679 #endif
680                 scp->cbServerp = NULL;
681                 scp->cbExpires = 0;
682                 scp->cbIssued = 0;
683                 scp->volumeCreationDate = 0;
684                 scp->fileLocksH = NULL;
685                 scp->fileLocksT = NULL;
686                 scp->serverLock = (-1);
687                 scp->lastRefreshCycle = 0;
688                 scp->exclusiveLocks = 0;
689                 scp->sharedLocks = 0;
690                 scp->openReads = 0;
691                 scp->openWrites = 0;
692                 scp->openShares = 0;
693                 scp->openExcls = 0;
694                 scp->waitCount = 0;
695                 scp->activeRPCs = 0;
696 #ifdef USE_BPLUS
697                 scp->dirBplus = NULL;
698                 scp->dirDataVersion = CM_SCACHE_VERSION_BAD;
699 #endif
700                 scp->waitQueueT = NULL;
701                 _InterlockedAnd(&scp->flags, ~(CM_SCACHEFLAG_CALLBACK | CM_SCACHEFLAG_WAITING | CM_SCACHEFLAG_RDR_IN_USE));
702
703                 scp->redirBufCount = 0;
704                 scp->redirQueueT = NULL;
705                 scp->redirQueueH = NULL;
706                 lock_InitializeMutex(&scp->redirMx, "cm_scache_t redirMx", LOCK_HIERARCHY_SCACHE_REDIRMX);
707             }
708         }
709         cm_allFileLocks = NULL;
710         cm_freeFileLocks = NULL;
711         cm_lockRefreshCycle = 0;
712         cm_fakeSCacheInit(newFile);
713         cm_allFreeWaiters = NULL;
714         cm_dnlcInit(newFile);
715         osi_EndOnce(&once);
716     }
717 }
718
719 /* version that doesn't bother creating the entry if we don't find it */
720 cm_scache_t *cm_FindSCache(cm_fid_t *fidp)
721 {
722     long hash;
723     cm_scache_t *scp;
724
725     hash = CM_SCACHE_HASH(fidp);
726
727     if (fidp->cell == 0) {
728         return NULL;
729     }
730
731     lock_ObtainRead(&cm_scacheLock);
732     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
733         if (cm_FidCmp(fidp, &scp->fid) == 0) {
734             cm_HoldSCacheNoLock(scp);
735             lock_ConvertRToW(&cm_scacheLock);
736             cm_AdjustScacheLRU(scp);
737             lock_ReleaseWrite(&cm_scacheLock);
738             return scp;
739         }
740     }
741     lock_ReleaseRead(&cm_scacheLock);
742     return NULL;
743 }
744
745 #ifdef DEBUG_REFCOUNT
746 long cm_GetSCacheDbg(cm_fid_t *fidp, cm_fid_t *parentFidp, cm_scache_t **outScpp, cm_user_t *userp,
747                   cm_req_t *reqp, char * file, long line)
748 #else
749 long cm_GetSCache(cm_fid_t *fidp, cm_fid_t *parentFidp, cm_scache_t **outScpp, cm_user_t *userp,
750                   cm_req_t *reqp)
751 #endif
752 {
753     long hash;
754     cm_scache_t *scp = NULL;
755     cm_scache_t *newScp = NULL;
756     long code;
757     cm_volume_t *volp = NULL;
758     cm_cell_t *cellp;
759     int special = 0; // yj: boolean variable to test if file is on root.afs
760     int isRoot = 0;
761     extern cm_fid_t cm_rootFid;
762     afs_int32 refCount;
763
764     hash = CM_SCACHE_HASH(fidp);
765
766     if (fidp->cell == 0)
767         return CM_ERROR_INVAL;
768
769 #ifdef AFS_FREELANCE_CLIENT
770     special = (fidp->cell==AFS_FAKE_ROOT_CELL_ID &&
771                fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
772                !(fidp->vnode==0x1 && fidp->unique==0x1));
773     isRoot = (fidp->cell==AFS_FAKE_ROOT_CELL_ID &&
774               fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
775               fidp->vnode==0x1 && fidp->unique==0x1);
776 #endif
777
778     // yj: check if we have the scp, if so, we don't need
779     // to do anything else
780     lock_ObtainRead(&cm_scacheLock);
781     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
782         if (cm_FidCmp(fidp, &scp->fid) == 0) {
783 #ifdef DEBUG_REFCOUNT
784             afsi_log("%s:%d cm_GetSCache (1) scp 0x%p ref %d", file, line, scp, scp->refCount);
785             osi_Log1(afsd_logp,"cm_GetSCache (1) scp 0x%p", scp);
786 #endif
787 #ifdef AFS_FREELANCE_CLIENT
788             if (cm_freelanceEnabled && special &&
789                 cm_data.fakeDirVersion != scp->dataVersion)
790                 break;
791 #endif
792             if (parentFidp && scp->parentVnode == 0) {
793                 scp->parentVnode = parentFidp->vnode;
794                 scp->parentUnique = parentFidp->unique;
795             }
796             cm_HoldSCacheNoLock(scp);
797             *outScpp = scp;
798             lock_ConvertRToW(&cm_scacheLock);
799             cm_AdjustScacheLRU(scp);
800             lock_ReleaseWrite(&cm_scacheLock);
801             return 0;
802         }
803     }
804     lock_ReleaseRead(&cm_scacheLock);
805
806     // yj: when we get here, it means we don't have an scp
807     // so we need to either load it or fake it, depending
808     // on whether the file is "special", see below.
809
810     // yj: if we're trying to get an scp for a file that's
811     // on root.afs of homecell, we want to handle it specially
812     // because we have to fill in the status stuff 'coz we
813     // don't want trybulkstat to fill it in for us
814 #ifdef AFS_FREELANCE_CLIENT
815     if (cm_freelanceEnabled && isRoot) {
816         osi_Log0(afsd_logp,"cm_GetSCache Freelance and isRoot");
817         /* freelance: if we are trying to get the root scp for the first
818          * time, we will just put in a place holder entry.
819          */
820         volp = NULL;
821     }
822
823     if (cm_freelanceEnabled && special) {
824         osi_Log0(afsd_logp,"cm_GetSCache Freelance and special");
825
826         if (cm_getLocalMountPointChange()) {
827             cm_clearLocalMountPointChange();
828             cm_reInitLocalMountPoints();
829         }
830
831         if (scp == NULL) {
832             scp = cm_GetNewSCache(FALSE);    /* returns scp->rw held */
833             if (scp == NULL) {
834                 osi_Log0(afsd_logp,"cm_GetSCache unable to obtain *new* scache entry");
835                 return CM_ERROR_WOULDBLOCK;
836             }
837         } else {
838             lock_ObtainWrite(&scp->rw);
839         }
840         scp->fid = *fidp;
841         cm_SetFid(&scp->dotdotFid,AFS_FAKE_ROOT_CELL_ID,AFS_FAKE_ROOT_VOL_ID,1,1);
842         if (parentFidp) {
843             scp->parentVnode = parentFidp->vnode;
844             scp->parentUnique = parentFidp->unique;
845         }
846         _InterlockedOr(&scp->flags, (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO));
847         lock_ObtainWrite(&cm_scacheLock);
848         if (!(scp->flags & CM_SCACHEFLAG_INHASH)) {
849             scp->nextp = cm_data.scacheHashTablep[hash];
850             cm_data.scacheHashTablep[hash] = scp;
851             _InterlockedOr(&scp->flags, CM_SCACHEFLAG_INHASH);
852         }
853         refCount = InterlockedIncrement(&scp->refCount);
854         osi_Log2(afsd_logp,"cm_GetSCache (freelance) sets refCount to 1 scp 0x%p refCount %d", scp, refCount);
855         lock_ReleaseWrite(&cm_scacheLock);
856
857         /* must be called after the scp->fid is set */
858         cm_FreelanceFetchMountPointString(scp);
859         cm_FreelanceFetchFileType(scp);
860
861         scp->length.LowPart = (DWORD)strlen(scp->mountPointStringp)+4;
862         scp->length.HighPart = 0;
863         scp->owner=0x0;
864         scp->unixModeBits=0777;
865         scp->clientModTime=FakeFreelanceModTime;
866         scp->serverModTime=FakeFreelanceModTime;
867         scp->parentUnique = 0x1;
868         scp->parentVnode=0x1;
869         scp->group=0;
870         scp->dataVersion=cm_data.fakeDirVersion;
871         scp->bufDataVersionLow=cm_data.fakeDirVersion;
872         scp->lockDataVersion=CM_SCACHE_VERSION_BAD; /* no lock yet */
873         scp->fsLockCount=0;
874         lock_ReleaseWrite(&scp->rw);
875         *outScpp = scp;
876 #ifdef DEBUG_REFCOUNT
877         afsi_log("%s:%d cm_GetSCache (2) scp 0x%p ref %d", file, line, scp, scp->refCount);
878         osi_Log1(afsd_logp,"cm_GetSCache (2) scp 0x%p", scp);
879 #endif
880         return 0;
881     }
882     // end of yj code
883 #endif /* AFS_FREELANCE_CLIENT */
884
885     /* we don't have the fid, recycle something */
886     newScp = cm_GetNewSCache(FALSE);    /* returns scp->rw held */
887     if (newScp == NULL) {
888         osi_Log0(afsd_logp,"cm_GetNewSCache unable to obtain *new* scache entry");
889         return CM_ERROR_WOULDBLOCK;
890     }
891 #ifdef DEBUG_REFCOUNT
892     afsi_log("%s:%d cm_GetNewSCache returns scp 0x%p flags 0x%x", file, line, newScp, newScp->flags);
893 #endif
894     osi_Log2(afsd_logp,"cm_GetNewSCache returns scp 0x%p flags 0x%x", newScp, newScp->flags);
895
896     /* otherwise, we need to find the volume */
897     if (!cm_freelanceEnabled || !isRoot) {
898         cellp = cm_FindCellByID(fidp->cell, 0);
899         if (!cellp) {
900             /* put back newScp so it can be reused */
901             lock_ObtainWrite(&cm_scacheLock);
902             newScp->flags |= CM_SCACHEFLAG_DELETED;
903             cm_AdjustScacheLRU(newScp);
904             lock_ReleaseWrite(&newScp->rw);
905             lock_ReleaseWrite(&cm_scacheLock);
906             return CM_ERROR_NOSUCHCELL;
907         }
908
909         code = cm_FindVolumeByID(cellp, fidp->volume, userp, reqp, CM_GETVOL_FLAG_CREATE, &volp);
910         if (code) {
911             /* put back newScp so it can be reused */
912             lock_ObtainWrite(&cm_scacheLock);
913             newScp->flags |= CM_SCACHEFLAG_DELETED;
914             cm_AdjustScacheLRU(newScp);
915             lock_ReleaseWrite(&newScp->rw);
916             lock_ReleaseWrite(&cm_scacheLock);
917             return code;
918         }
919     }
920
921     /*
922      * otherwise, we have the volume, now reverify that the scp doesn't
923      * exist, and proceed.  make sure that we hold the cm_scacheLock
924      * write-locked until the scp is put into the hash table in order
925      * to avoid a race.
926      */
927     lock_ObtainWrite(&cm_scacheLock);
928     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
929         if (cm_FidCmp(fidp, &scp->fid) == 0) {
930 #ifdef DEBUG_REFCOUNT
931             afsi_log("%s:%d cm_GetSCache (3) scp 0x%p ref %d", file, line, scp, scp->refCount);
932             osi_Log1(afsd_logp,"cm_GetSCache (3) scp 0x%p", scp);
933 #endif
934             if (parentFidp && scp->parentVnode == 0) {
935                 scp->parentVnode = parentFidp->vnode;
936                 scp->parentUnique = parentFidp->unique;
937             }
938             if (volp)
939                 cm_PutVolume(volp);
940             cm_HoldSCacheNoLock(scp);
941             cm_AdjustScacheLRU(scp);
942
943             /* put back newScp so it can be reused */
944             newScp->flags |= CM_SCACHEFLAG_DELETED;
945             cm_AdjustScacheLRU(newScp);
946             lock_ReleaseWrite(&newScp->rw);
947             lock_ReleaseWrite(&cm_scacheLock);
948
949             *outScpp = scp;
950             return 0;
951         }
952     }
953
954     scp = newScp;
955     scp->fid = *fidp;
956     if (!cm_freelanceEnabled || !isRoot) {
957         /* if this scache entry represents a volume root then we need
958          * to copy the dotdotFid from the volume structure where the
959          * "master" copy is stored (defect 11489)
960          */
961         if (volp->vol[ROVOL].ID == fidp->volume) {
962             _InterlockedOr(&scp->flags, (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO));
963             if (scp->fid.vnode == 1 && scp->fid.unique == 1)
964                 scp->dotdotFid = cm_VolumeStateByType(volp, ROVOL)->dotdotFid;
965         } else if (volp->vol[BACKVOL].ID == fidp->volume) {
966             _InterlockedOr(&scp->flags, CM_SCACHEFLAG_RO);
967             if (scp->fid.vnode == 1 && scp->fid.unique == 1)
968                 scp->dotdotFid = cm_VolumeStateByType(volp, BACKVOL)->dotdotFid;
969         } else {
970             if (scp->fid.vnode == 1 && scp->fid.unique == 1)
971                 scp->dotdotFid = cm_VolumeStateByType(volp, RWVOL)->dotdotFid;
972         }
973     }
974     if (parentFidp) {
975         scp->parentVnode = parentFidp->vnode;
976         scp->parentUnique = parentFidp->unique;
977     }
978     if (volp)
979         cm_PutVolume(volp);
980
981     scp->nextp = cm_data.scacheHashTablep[hash];
982     cm_data.scacheHashTablep[hash] = scp;
983     _InterlockedOr(&scp->flags, CM_SCACHEFLAG_INHASH);
984     refCount = InterlockedIncrement(&scp->refCount);
985     lock_ReleaseWrite(&cm_scacheLock);
986     lock_ReleaseWrite(&scp->rw);
987 #ifdef DEBUG_REFCOUNT
988     afsi_log("%s:%d cm_GetSCache sets refCount to 1 scp 0x%p refCount %d", file, line, scp, refCount);
989 #endif
990     osi_Log2(afsd_logp,"cm_GetSCache sets refCount to 1 scp 0x%p refCount %d", scp, refCount);
991
992     /* XXX - The following fields in the cm_scache are
993      * uninitialized:
994      *   fileType
995      *   parentVnode
996      *   parentUnique
997      */
998
999     /* now we have a held scache entry; just return it */
1000     *outScpp = scp;
1001 #ifdef DEBUG_REFCOUNT
1002     afsi_log("%s:%d cm_GetSCache (4) scp 0x%p ref %d", file, line, scp, scp->refCount);
1003     osi_Log1(afsd_logp,"cm_GetSCache (4) scp 0x%p", scp);
1004 #endif
1005     return 0;
1006 }
1007
1008 /* Returns a held reference to the scache's parent
1009  * if it exists */
1010 cm_scache_t * cm_FindSCacheParent(cm_scache_t * scp)
1011 {
1012     long code = 0;
1013     int i;
1014     cm_fid_t    parent_fid;
1015     cm_scache_t * pscp = NULL;
1016
1017     if (scp->parentVnode == 0)
1018         return NULL;
1019
1020     lock_ObtainWrite(&cm_scacheLock);
1021     cm_SetFid(&parent_fid, scp->fid.cell, scp->fid.volume, scp->parentVnode, scp->parentUnique);
1022
1023     if (cm_FidCmp(&scp->fid, &parent_fid)) {
1024         i = CM_SCACHE_HASH(&parent_fid);
1025         for (pscp = cm_data.scacheHashTablep[i]; pscp; pscp = pscp->nextp) {
1026             if (!cm_FidCmp(&pscp->fid, &parent_fid)) {
1027                 cm_HoldSCacheNoLock(pscp);
1028                 break;
1029             }
1030         }
1031     }
1032
1033     lock_ReleaseWrite(&cm_scacheLock);
1034
1035     return pscp;
1036 }
1037
1038 void cm_SyncOpAddToWaitQueue(cm_scache_t * scp, afs_int32 flags, cm_buf_t * bufp)
1039 {
1040     cm_scache_waiter_t * w;
1041
1042     lock_ObtainWrite(&cm_scacheLock);
1043     if (cm_allFreeWaiters == NULL) {
1044         w = malloc(sizeof(*w));
1045         memset(w, 0, sizeof(*w));
1046     } else {
1047         w = (cm_scache_waiter_t *) cm_allFreeWaiters;
1048         osi_QRemove(&cm_allFreeWaiters, (osi_queue_t *) w);
1049     }
1050
1051     w->threadId = thrd_Current();
1052     w->scp = scp;
1053     cm_HoldSCacheNoLock(scp);
1054     w->flags = flags;
1055     w->bufp = bufp;
1056
1057     osi_QAddT(&scp->waitQueueH, &scp->waitQueueT, (osi_queue_t *) w);
1058     lock_ReleaseWrite(&cm_scacheLock);
1059
1060     osi_Log2(afsd_logp, "cm_SyncOpAddToWaitQueue : Adding thread to wait queue scp 0x%p w 0x%p", scp, w);
1061 }
1062
1063 int cm_SyncOpCheckContinue(cm_scache_t * scp, afs_int32 flags, cm_buf_t * bufp)
1064 {
1065     cm_scache_waiter_t * w;
1066     int this_is_me;
1067
1068     osi_Log0(afsd_logp, "cm_SyncOpCheckContinue checking for continuation");
1069
1070     lock_ObtainRead(&cm_scacheLock);
1071     for (w = (cm_scache_waiter_t *)scp->waitQueueH;
1072          w;
1073          w = (cm_scache_waiter_t *)osi_QNext((osi_queue_t *) w)) {
1074         if (w->flags == flags && w->bufp == bufp) {
1075             break;
1076         }
1077     }
1078
1079     osi_assertx(w != NULL, "null cm_scache_waiter_t");
1080     this_is_me = (w->threadId == thrd_Current());
1081     lock_ReleaseRead(&cm_scacheLock);
1082
1083     if (!this_is_me) {
1084         osi_Log1(afsd_logp, "cm_SyncOpCheckContinue MISS: Waiter 0x%p", w);
1085         return 0;
1086     }
1087
1088     osi_Log1(afsd_logp, "cm_SyncOpCheckContinue HIT: Waiter 0x%p", w);
1089
1090     lock_ObtainWrite(&cm_scacheLock);
1091     osi_QRemoveHT(&scp->waitQueueH, &scp->waitQueueT, (osi_queue_t *) w);
1092     cm_ReleaseSCacheNoLock(scp);
1093     memset(w, 0, sizeof(*w));
1094     osi_QAdd(&cm_allFreeWaiters, (osi_queue_t *) w);
1095     lock_ReleaseWrite(&cm_scacheLock);
1096
1097     return 1;
1098 }
1099
1100
1101 /* synchronize a fetch, store, read, write, fetch status or store status.
1102  * Called with scache mutex held, and returns with it held, but temporarily
1103  * drops it during the fetch.
1104  *
1105  * At most one flag can be on in flags, if this is an RPC request.
1106  *
1107  * Also, if we're fetching or storing data, we must ensure that we have a buffer.
1108  *
1109  * There are a lot of weird restrictions here; here's an attempt to explain the
1110  * rationale for the concurrency restrictions implemented in this function.
1111  *
1112  * First, although the file server will break callbacks when *another* machine
1113  * modifies a file or status block, the client itself is responsible for
1114  * concurrency control on its own requests.  Callback breaking events are rare,
1115  * and simply invalidate any concurrent new status info.
1116  *
1117  * In the absence of callback breaking messages, we need to know how to
1118  * synchronize incoming responses describing updates to files.  We synchronize
1119  * operations that update the data version by comparing the data versions.
1120  * However, updates that do not update the data, but only the status, can't be
1121  * synchronized with fetches or stores, since there's nothing to compare
1122  * to tell which operation executed first at the server.
1123  *
1124  * Thus, we can allow multiple ops that change file data, or dir data, and
1125  * fetches.  However, status storing ops have to be done serially.
1126  *
1127  * Furthermore, certain data-changing ops are incompatible: we can't read or
1128  * write a buffer while doing a truncate.  We can't read and write the same
1129  * buffer at the same time, or write while fetching or storing, or read while
1130  * fetching a buffer (this may change).  We can't fetch and store at the same
1131  * time, either.
1132  *
1133  * With respect to status, we can't read and write at the same time, read while
1134  * fetching, write while fetching or storing, or fetch and store at the same time.
1135  *
1136  * We can't allow a get callback RPC to run in concurrently with something that
1137  * will return updated status, since we could start a call, have the server
1138  * return status, have another machine make an update to the status (which
1139  * doesn't change serverModTime), have the original machine get a new callback,
1140  * and then have the original machine merge in the early, old info from the
1141  * first call.  At this point, the easiest way to avoid this problem is to have
1142  * getcallback calls conflict with all others for the same vnode.  Other calls
1143  * to cm_MergeStatus that aren't associated with calls to cm_SyncOp on the same
1144  * vnode must be careful not to merge in their status unless they have obtained
1145  * a callback from the start of their call.
1146  *
1147  * Note added 1/23/96
1148  * Concurrent StoreData RPC's can cause trouble if the file is being extended.
1149  * Each such RPC passes a FileLength parameter, which the server uses to do
1150  * pre-truncation if necessary.  So if two RPC's are processed out of order at
1151  * the server, the one with the smaller FileLength will be processed last,
1152  * possibly resulting in a bogus truncation.  The simplest way to avoid this
1153  * is to serialize all StoreData RPC's.  This is the reason we defined
1154  * CM_SCACHESYNC_STOREDATA_EXCL and CM_SCACHEFLAG_DATASTORING.
1155  *
1156  * CM_SCACHESYNC_BULKREAD is used to permit synchronization of multiple bulk
1157  * readers which may be requesting overlapping ranges.
1158  */
1159 long cm_SyncOp(cm_scache_t *scp, cm_buf_t *bufp, cm_user_t *userp, cm_req_t *reqp,
1160                afs_uint32 rights, afs_uint32 flags)
1161 {
1162     osi_queueData_t *qdp;
1163     long code;
1164     cm_buf_t *tbufp;
1165     afs_uint32 outRights;
1166     int bufLocked;
1167     afs_uint32 sleep_scp_flags = 0;
1168     afs_uint32 sleep_buf_cmflags = 0;
1169     afs_uint32 sleep_scp_bufs = 0;
1170     int wakeupCycle;
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         if ( scp->flags & CM_SCACHEFLAG_WAITING ) {
1415             scp->waitCount++;
1416             scp->waitRequests++;
1417             osi_Log3(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING already set for 0x%p; %d threads; %d requests",
1418                      scp, scp->waitCount, scp->waitRequests);
1419         } else {
1420             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING set for 0x%p", scp);
1421             _InterlockedOr(&scp->flags, CM_SCACHEFLAG_WAITING);
1422             scp->waitCount = scp->waitRequests = 1;
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         scp->waitCount--;
1439         osi_Log3(afsd_logp, "CM SyncOp woke! scp 0x%p; still waiting %d threads of %d requests",
1440                  scp, scp->waitCount, scp->waitRequests);
1441         if (scp->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_Log3(afsd_logp, "CM SyncOpDone 0x%x Waking scp 0x%p bufp 0x%p", flags, scp, bufp);
1596         osi_Wakeup((LONG_PTR) &scp->flags);
1597     }
1598 }
1599
1600 static afs_uint32
1601 dv_diff(afs_uint64 dv1, afs_uint64 dv2)
1602 {
1603     if ( dv1 - dv2 > 0x7FFFFFFF )
1604         return (afs_uint32)(dv2 - dv1);
1605     else
1606         return (afs_uint32)(dv1 - dv2);
1607 }
1608
1609 /* merge in a response from an RPC.  The scp must be locked, and the callback
1610  * is optional.
1611  *
1612  * Don't overwrite any status info that is dirty, since we could have a store
1613  * operation (such as store data) that merges some info in, and we don't want
1614  * to lose the local updates.  Typically, there aren't many updates we do
1615  * locally, anyway, probably only mtime.
1616  *
1617  * There is probably a bug in here where a chmod (which doesn't change
1618  * serverModTime) that occurs between two fetches, both of whose responses are
1619  * handled after the callback breaking is done, but only one of whose calls
1620  * started before that, can cause old info to be merged from the first call.
1621  */
1622 void cm_MergeStatus(cm_scache_t *dscp,
1623                     cm_scache_t *scp, AFSFetchStatus *statusp,
1624                     AFSVolSync *volsyncp,
1625                     cm_user_t *userp, cm_req_t *reqp, afs_uint32 flags)
1626 {
1627     afs_uint64 dataVersion;
1628     struct cm_volume *volp = NULL;
1629     struct cm_cell *cellp = NULL;
1630     int rdr_invalidate = 0;
1631     afs_uint32 activeRPCs;
1632
1633     lock_AssertWrite(&scp->rw);
1634
1635     activeRPCs = 1 + InterlockedDecrement(&scp->activeRPCs);
1636
1637     // yj: i want to create some fake status for the /afs directory and the
1638     // entries under that directory
1639 #ifdef AFS_FREELANCE_CLIENT
1640     if (cm_freelanceEnabled && scp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
1641          scp->fid.volume==AFS_FAKE_ROOT_VOL_ID) {
1642         if (scp == cm_data.rootSCachep) {
1643             osi_Log0(afsd_logp,"cm_MergeStatus Freelance cm_data.rootSCachep");
1644             statusp->FileType = CM_SCACHETYPE_DIRECTORY;
1645             statusp->Length = cm_fakeDirSize;
1646             statusp->Length_hi = 0;
1647         } else {
1648             statusp->FileType = scp->fileType;
1649             statusp->Length = scp->length.LowPart;
1650             statusp->Length_hi = scp->length.HighPart;
1651         }
1652         statusp->InterfaceVersion = 0x1;
1653         statusp->LinkCount = scp->linkCount;
1654         statusp->DataVersion = (afs_uint32)(cm_data.fakeDirVersion & 0xFFFFFFFF);
1655         statusp->Author = 0x1;
1656         statusp->Owner = 0x0;
1657         statusp->CallerAccess = 0x9;
1658         statusp->AnonymousAccess = 0x9;
1659         statusp->UnixModeBits = 0777;
1660         statusp->ParentVnode = 0x1;
1661         statusp->ParentUnique = 0x1;
1662         statusp->ResidencyMask = 0;
1663         statusp->ClientModTime = FakeFreelanceModTime;
1664         statusp->ServerModTime = FakeFreelanceModTime;
1665         statusp->Group = 0;
1666         statusp->SyncCounter = 0;
1667         statusp->dataVersionHigh = (afs_uint32)(cm_data.fakeDirVersion >> 32);
1668         statusp->lockCount = 0;
1669         statusp->errorCode = 0;
1670     }
1671 #endif /* AFS_FREELANCE_CLIENT */
1672
1673     if (statusp->errorCode != 0) {
1674         switch (statusp->errorCode) {
1675         case EACCES:
1676         case UAEACCES:
1677         case EPERM:
1678         case UAEPERM:
1679             cm_EAccesAddEntry(userp, &scp->fid, &dscp->fid);
1680         }
1681         osi_Log2(afsd_logp, "Merge, Failure scp 0x%p code 0x%x", scp, statusp->errorCode);
1682
1683         if (scp->fid.vnode & 0x1)
1684             scp->fileType = CM_SCACHETYPE_DIRECTORY;
1685         else
1686             scp->fileType = 0;  /* unknown */
1687
1688         scp->serverModTime = 0;
1689         scp->clientModTime = 0;
1690         scp->length.LowPart = 0;
1691         scp->length.HighPart = 0;
1692         scp->serverLength.LowPart = 0;
1693         scp->serverLength.HighPart = 0;
1694         scp->linkCount = 0;
1695         scp->owner = 0;
1696         scp->group = 0;
1697         scp->unixModeBits = 0;
1698         scp->anyAccess = 0;
1699         scp->dataVersion = CM_SCACHE_VERSION_BAD;
1700         scp->bufDataVersionLow = CM_SCACHE_VERSION_BAD;
1701         scp->fsLockCount = 0;
1702
1703         if (dscp && dscp != scp) {
1704             scp->parentVnode = dscp->fid.vnode;
1705             scp->parentUnique = dscp->fid.unique;
1706         } else {
1707             scp->parentVnode = 0;
1708             scp->parentUnique = 0;
1709         }
1710
1711         if (RDR_Initialized)
1712             rdr_invalidate = 1;
1713     }
1714
1715     dataVersion = statusp->dataVersionHigh;
1716     dataVersion <<= 32;
1717     dataVersion |= statusp->DataVersion;
1718
1719     if (!(flags & CM_MERGEFLAG_FORCE) &&
1720         dataVersion < scp->dataVersion &&
1721         scp->dataVersion != CM_SCACHE_VERSION_BAD) {
1722
1723         cellp = cm_FindCellByID(scp->fid.cell, 0);
1724         if (scp->cbServerp) {
1725             cm_FindVolumeByID(cellp, scp->fid.volume, userp,
1726                               reqp, CM_GETVOL_FLAG_CREATE, &volp);
1727             osi_Log2(afsd_logp, "old data from server %x volume %s",
1728                       scp->cbServerp->addr.sin_addr.s_addr,
1729                       volp ? volp->namep : "(unknown)");
1730         }
1731
1732         osi_Log3(afsd_logp, "Bad merge, scp 0x%p, scp dv %d, RPC dv %d",
1733                   scp, scp->dataVersion, dataVersion);
1734         /* we have a number of data fetch/store operations running
1735          * concurrently, and we can tell which one executed last at the
1736          * server by its mtime.
1737          * Choose the one with the largest mtime, and ignore the rest.
1738          *
1739          * These concurrent calls are incompatible with setting the
1740          * mtime, so we won't have a locally changed mtime here.
1741          *
1742          * We could also have ACL info for a different user than usual,
1743          * in which case we have to do that part of the merge, anyway.
1744          * We won't have to worry about the info being old, since we
1745          * won't have concurrent calls
1746          * that change file status running from this machine.
1747          *
1748          * Added 3/17/98:  if we see data version regression on an RO
1749          * file, it's probably due to a server holding an out-of-date
1750          * replica, rather than to concurrent RPC's.  Failures to
1751          * release replicas are now flagged by the volserver, but only
1752          * since AFS 3.4 5.22, so there are plenty of clients getting
1753          * out-of-date replicas out there.
1754          *
1755          * If we discover an out-of-date replica, by this time it's too
1756          * late to go to another server and retry.  Also, we can't
1757          * reject the merge, because then there is no way for
1758          * GetAccess to do its work, and the caller gets into an
1759          * infinite loop.  So we just grin and bear it.
1760          */
1761         if (!(scp->flags & CM_SCACHEFLAG_RO))
1762             goto done;
1763     }
1764
1765     if (cm_readonlyVolumeVersioning)
1766         scp->volumeCreationDate = volsyncp->spare1;       /* volume creation date */
1767
1768     scp->serverModTime = statusp->ServerModTime;
1769
1770     if (!(scp->mask & CM_SCACHEMASK_CLIENTMODTIME)) {
1771         scp->clientModTime = statusp->ClientModTime;
1772     }
1773     if (!(scp->mask & CM_SCACHEMASK_LENGTH)) {
1774         scp->length.LowPart = statusp->Length;
1775         scp->length.HighPart = statusp->Length_hi;
1776     }
1777
1778     scp->serverLength.LowPart = statusp->Length;
1779     scp->serverLength.HighPart = statusp->Length_hi;
1780
1781     scp->linkCount = statusp->LinkCount;
1782     scp->owner = statusp->Owner;
1783     scp->group = statusp->Group;
1784     scp->unixModeBits = statusp->UnixModeBits & 07777;
1785
1786     if (statusp->FileType == File)
1787         scp->fileType = CM_SCACHETYPE_FILE;
1788     else if (statusp->FileType == Directory)
1789         scp->fileType = CM_SCACHETYPE_DIRECTORY;
1790     else if (statusp->FileType == SymbolicLink) {
1791         if ((scp->unixModeBits & 0111) == 0)
1792             scp->fileType = CM_SCACHETYPE_MOUNTPOINT;
1793         else
1794             scp->fileType = CM_SCACHETYPE_SYMLINK;
1795     }
1796     else {
1797         osi_Log2(afsd_logp, "Merge, Invalid File Type (%d), scp 0x%p", statusp->FileType, scp);
1798         scp->fileType = CM_SCACHETYPE_INVALID;  /* invalid */
1799     }
1800     /* and other stuff */
1801     scp->parentVnode = statusp->ParentVnode;
1802     scp->parentUnique = statusp->ParentUnique;
1803
1804     /* -1 is a write lock; any positive values are read locks */
1805     scp->fsLockCount = (afs_int32)statusp->lockCount;
1806
1807     /* and merge in the private acl cache info, if this is more than the public
1808      * info; merge in the public stuff in any case.
1809      */
1810     scp->anyAccess = statusp->AnonymousAccess;
1811
1812     if (userp != NULL) {
1813         cm_AddACLCache(scp, userp, statusp->CallerAccess);
1814     }
1815
1816     if (dataVersion != 0 && scp->dataVersion != CM_SCACHE_VERSION_BAD &&
1817         (!(flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) && (dataVersion != scp->dataVersion) ||
1818          (flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) &&
1819          (dv_diff(dataVersion, scp->dataVersion) > activeRPCs))) {
1820         /*
1821          * We now know that all of the data buffers that we have associated
1822          * with this scp are invalid.  Subsequent operations will go faster
1823          * if the buffers are removed from the hash tables.
1824          *
1825          * We do not remove directory buffers if the dataVersion delta is 'activeRPCs' because
1826          * those version numbers will be updated as part of the directory operation.
1827          *
1828          * We do not remove storedata buffers because they will still be valid.
1829          */
1830         int i, j;
1831         cm_buf_t **lbpp;
1832         cm_buf_t *tbp;
1833         cm_buf_t *bp, *prevBp, *nextBp;
1834
1835         lock_ObtainWrite(&buf_globalLock);
1836         i = BUF_FILEHASH(&scp->fid);
1837         for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=nextBp)
1838         {
1839             nextBp = bp->fileHashp;
1840             /*
1841              * if the buffer belongs to this stat cache entry
1842              * and the buffer mutex can be obtained, check the
1843              * reference count and if it is zero, remove the buffer
1844              * from the hash tables.  If there are references,
1845              * the buffer might be updated to the current version
1846              * so leave it in place.
1847              */
1848             if (cm_FidCmp(&scp->fid, &bp->fid) == 0 &&
1849                  lock_TryMutex(&bp->mx)) {
1850                 if (bp->refCount == 0 &&
1851                     !(bp->flags & (CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)) &&
1852                     !(bp->qFlags & CM_BUF_QREDIR)) {
1853                     prevBp = bp->fileHashBackp;
1854                     bp->fileHashBackp = bp->fileHashp = NULL;
1855                     if (prevBp)
1856                         prevBp->fileHashp = nextBp;
1857                     else
1858                         cm_data.buf_fileHashTablepp[i] = nextBp;
1859                     if (nextBp)
1860                         nextBp->fileHashBackp = prevBp;
1861
1862                     j = BUF_HASH(&bp->fid, &bp->offset);
1863                     lbpp = &(cm_data.buf_scacheHashTablepp[j]);
1864                     for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = tbp->hashp) {
1865                         if (tbp == bp)
1866                             break;
1867                     }
1868
1869                     /* we better find it */
1870                     osi_assertx(tbp != NULL, "cm_MergeStatus: buf_scacheHashTablepp table screwup");
1871
1872                     *lbpp = bp->hashp;  /* hash out */
1873                     bp->hashp = NULL;
1874
1875                     _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINHASH);
1876                 }
1877                 lock_ReleaseMutex(&bp->mx);
1878             }
1879         }
1880         lock_ReleaseWrite(&buf_globalLock);
1881     }
1882
1883     /*
1884      * If the dataVersion has changed, the mountPointStringp must be cleared
1885      * in order to force a re-evaluation by cm_HandleLink().  The Windows CM
1886      * does not update a mountpoint or symlink by altering the contents of
1887      * the file data; but the Unix CM does.
1888      */
1889     if (scp->dataVersion != dataVersion && !(flags & CM_MERGEFLAG_FETCHDATA)) {
1890         scp->mountPointStringp[0] = '\0';
1891
1892         osi_Log5(afsd_logp, "cm_MergeStatus data version change scp 0x%p cell %u vol %u vn %u uniq %u",
1893                  scp, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
1894
1895         osi_Log4(afsd_logp, ".... oldDV 0x%x:%x -> newDV 0x%x:%x",
1896                  (afs_uint32)((scp->dataVersion >> 32) & 0xFFFFFFFF),
1897                  (afs_uint32)(scp->dataVersion & 0xFFFFFFFF),
1898                  (afs_uint32)((dataVersion >> 32) & 0xFFFFFFFF),
1899                  (afs_uint32)(dataVersion & 0xFFFFFFFF));
1900     }
1901
1902     /* We maintain a range of buffer dataVersion values which are considered
1903      * valid.  This avoids the need to update the dataVersion on each buffer
1904      * object during an uncontested storeData operation.  As a result this
1905      * merge status no longer has performance characteristics derived from
1906      * the size of the file.
1907      *
1908      * For directory buffers, only current dataVersion values are up to date.
1909      */
1910     if (((flags & (CM_MERGEFLAG_STOREDATA|CM_MERGEFLAG_DIROP)) && (dv_diff(dataVersion, scp->dataVersion) > activeRPCs)) ||
1911          (!(flags & (CM_MERGEFLAG_STOREDATA|CM_MERGEFLAG_DIROP)) && (scp->dataVersion != dataVersion)) ||
1912          scp->bufDataVersionLow == CM_SCACHE_VERSION_BAD ||
1913          scp->fileType == CM_SCACHETYPE_DIRECTORY)
1914         scp->bufDataVersionLow = dataVersion;
1915
1916     if (RDR_Initialized) {
1917         /*
1918          * The redirector maintains its own cached status information which
1919          * must be updated when a DV change occurs that is not the result
1920          * of a redirector initiated data change.
1921          *
1922          * If the current old DV is BAD, send a DV change notification.
1923          *
1924          * If the DV has changed and request was not initiated by the
1925          * redirector, send a DV change notification.
1926          *
1927          * If the request was initiated by the redirector, send a notification
1928          * for store and directory operations that result in a DV change greater
1929          * than the number of active RPCs or any other operation that results
1930          * in an unexpected DV change such as FetchStatus.
1931          */
1932
1933         if (scp->dataVersion == CM_SCACHE_VERSION_BAD && dataVersion != 0) {
1934             rdr_invalidate = 1;
1935         } else if (!(reqp->flags & CM_REQ_SOURCE_REDIR) && scp->dataVersion != dataVersion) {
1936             rdr_invalidate = 1;
1937         } else if (reqp->flags & CM_REQ_SOURCE_REDIR) {
1938             if (!(flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) &&
1939                 (dv_diff(dataVersion, scp->dataVersion) > activeRPCs - 1)) {
1940                 rdr_invalidate = 1;
1941             } else if ((flags & (CM_MERGEFLAG_DIROP|CM_MERGEFLAG_STOREDATA)) &&
1942                        dv_diff(dataVersion, scp->dataVersion) > activeRPCs) {
1943                 rdr_invalidate = 1;
1944             }
1945         }
1946     }
1947     scp->dataVersion = dataVersion;
1948
1949     /*
1950      * If someone is waiting for status information, we can wake them up
1951      * now even though the entity that issued the FetchStatus may not
1952      * have completed yet.
1953      */
1954     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_FETCHSTATUS);
1955
1956     /*
1957      * We just successfully merged status on the stat cache object.
1958      * This means that the associated volume must be online.
1959      */
1960     if (!volp) {
1961         if (!cellp)
1962             cellp = cm_FindCellByID(scp->fid.cell, 0);
1963         cm_FindVolumeByID(cellp, scp->fid.volume, userp, reqp, 0, &volp);
1964     }
1965     if (volp) {
1966         cm_vol_state_t *statep = cm_VolumeStateByID(volp, scp->fid.volume);
1967         if (statep->state != vl_online) {
1968             lock_ObtainWrite(&volp->rw);
1969             cm_VolumeStatusNotification(volp, statep->ID, statep->state, vl_online);
1970             statep->state = vl_online;
1971             lock_ReleaseWrite(&volp->rw);
1972         }
1973     }
1974
1975     /* Remove cached EACCES / EPERM errors if the file is a directory */
1976     if (scp->fileType == CM_SCACHETYPE_DIRECTORY &&
1977         !(volp && (volp->flags & CM_VOLUMEFLAG_DFS_VOLUME)) &&
1978         !cm_accessPerFileCheck)
1979     {
1980         cm_EAccesClearParentEntries(&scp->fid);
1981     }
1982
1983   done:
1984     if (volp)
1985         cm_PutVolume(volp);
1986
1987     /*
1988      * The scache rw lock cannot be held across the invalidation.
1989      * Doing so can result in deadlocks with other threads processing
1990      * requests initiated by the afs redirector.
1991      */
1992     if (rdr_invalidate) {
1993         lock_ReleaseWrite(&scp->rw);
1994         RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
1995                              scp->fid.unique, scp->fid.hash,
1996                              scp->fileType, AFS_INVALIDATE_DATA_VERSION);
1997         lock_ObtainWrite(&scp->rw);
1998     }
1999 }
2000
2001 /* note that our stat cache info is incorrect, so force us eventually
2002  * to stat the file again.  There may be dirty data associated with
2003  * this vnode, and we want to preserve that information.
2004  *
2005  * This function works by simply simulating a loss of the callback.
2006  *
2007  * This function must be called with the scache locked.
2008  */
2009 void cm_DiscardSCache(cm_scache_t *scp)
2010 {
2011     lock_AssertWrite(&scp->rw);
2012     if (scp->cbServerp) {
2013         cm_PutServer(scp->cbServerp);
2014         scp->cbServerp = NULL;
2015     }
2016     scp->cbExpires = 0;
2017     scp->cbIssued = 0;
2018     scp->volumeCreationDate = 0;
2019     _InterlockedAnd(&scp->flags, ~(CM_SCACHEFLAG_CALLBACK | CM_SCACHEFLAG_LOCAL | CM_SCACHEFLAG_RDR_IN_USE));
2020     cm_dnlcPurgedp(scp);
2021     cm_dnlcPurgevp(scp);
2022     cm_FreeAllACLEnts(scp);
2023
2024     if (scp->fileType == CM_SCACHETYPE_DFSLINK)
2025         cm_VolStatus_Invalidate_DFS_Mapping(scp);
2026
2027     /* Force mount points and symlinks to be re-evaluated */
2028     scp->mountPointStringp[0] = '\0';
2029 }
2030
2031 void cm_AFSFidFromFid(AFSFid *afsFidp, cm_fid_t *fidp)
2032 {
2033     afsFidp->Volume = fidp->volume;
2034     afsFidp->Vnode = fidp->vnode;
2035     afsFidp->Unique = fidp->unique;
2036 }
2037
2038 #ifdef DEBUG_REFCOUNT
2039 void cm_HoldSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
2040 #else
2041 void cm_HoldSCacheNoLock(cm_scache_t *scp)
2042 #endif
2043 {
2044     afs_int32 refCount;
2045
2046     osi_assertx(scp != NULL, "null cm_scache_t");
2047     lock_AssertAny(&cm_scacheLock);
2048     refCount = InterlockedIncrement(&scp->refCount);
2049 #ifdef DEBUG_REFCOUNT
2050     osi_Log2(afsd_logp,"cm_HoldSCacheNoLock scp 0x%p ref %d",scp, refCount);
2051     afsi_log("%s:%d cm_HoldSCacheNoLock scp 0x%p, ref %d", file, line, scp, refCount);
2052 #endif
2053 }
2054
2055 #ifdef DEBUG_REFCOUNT
2056 void cm_HoldSCacheDbg(cm_scache_t *scp, char * file, long line)
2057 #else
2058 void cm_HoldSCache(cm_scache_t *scp)
2059 #endif
2060 {
2061     afs_int32 refCount;
2062
2063     osi_assertx(scp != NULL, "null cm_scache_t");
2064     lock_ObtainRead(&cm_scacheLock);
2065     refCount = InterlockedIncrement(&scp->refCount);
2066 #ifdef DEBUG_REFCOUNT
2067     osi_Log2(afsd_logp,"cm_HoldSCache scp 0x%p ref %d",scp, refCount);
2068     afsi_log("%s:%d cm_HoldSCache scp 0x%p ref %d", file, line, scp, refCount);
2069 #endif
2070     lock_ReleaseRead(&cm_scacheLock);
2071 }
2072
2073 #ifdef DEBUG_REFCOUNT
2074 void cm_ReleaseSCacheNoLockDbg(cm_scache_t *scp, char * file, long line)
2075 #else
2076 void cm_ReleaseSCacheNoLock(cm_scache_t *scp)
2077 #endif
2078 {
2079     afs_int32 refCount;
2080
2081     osi_assertx(scp != NULL, "null cm_scache_t");
2082     lock_AssertAny(&cm_scacheLock);
2083
2084     refCount = InterlockedDecrement(&scp->refCount);
2085 #ifdef DEBUG_REFCOUNT
2086     if (refCount < 0)
2087         osi_Log1(afsd_logp,"cm_ReleaseSCacheNoLock about to panic scp 0x%x",scp);
2088 #endif
2089     osi_assertx(refCount >= 0, "cm_scache_t refCount 0");
2090 #ifdef DEBUG_REFCOUNT
2091     osi_Log2(afsd_logp,"cm_ReleaseSCacheNoLock scp 0x%p ref %d",scp, refCount);
2092     afsi_log("%s:%d cm_ReleaseSCacheNoLock scp 0x%p ref %d", file, line, scp, refCount);
2093 #endif
2094
2095     if (refCount == 0 && (scp->flags & CM_SCACHEFLAG_DELETED)) {
2096         int deleted = 0;
2097         long      lockstate;
2098
2099         lockstate = lock_GetRWLockState(&cm_scacheLock);
2100         if (lockstate != OSI_RWLOCK_WRITEHELD)
2101             lock_ReleaseRead(&cm_scacheLock);
2102         else
2103             lock_ReleaseWrite(&cm_scacheLock);
2104
2105         lock_ObtainWrite(&scp->rw);
2106         if (scp->flags & CM_SCACHEFLAG_DELETED)
2107             deleted = 1;
2108
2109         if (refCount == 0 && deleted) {
2110             lock_ObtainWrite(&cm_scacheLock);
2111             cm_RecycleSCache(scp, 0);
2112             if (lockstate != OSI_RWLOCK_WRITEHELD)
2113                 lock_ConvertWToR(&cm_scacheLock);
2114         } else {
2115             if (lockstate != OSI_RWLOCK_WRITEHELD)
2116                 lock_ObtainRead(&cm_scacheLock);
2117             else
2118                 lock_ObtainWrite(&cm_scacheLock);
2119         }
2120         lock_ReleaseWrite(&scp->rw);
2121     }
2122 }
2123
2124 #ifdef DEBUG_REFCOUNT
2125 void cm_ReleaseSCacheDbg(cm_scache_t *scp, char * file, long line)
2126 #else
2127 void cm_ReleaseSCache(cm_scache_t *scp)
2128 #endif
2129 {
2130     afs_int32 refCount;
2131
2132     osi_assertx(scp != NULL, "null cm_scache_t");
2133     lock_ObtainRead(&cm_scacheLock);
2134     refCount = InterlockedDecrement(&scp->refCount);
2135 #ifdef DEBUG_REFCOUNT
2136     if (refCount < 0)
2137         osi_Log1(afsd_logp,"cm_ReleaseSCache about to panic scp 0x%x",scp);
2138 #endif
2139     osi_assertx(refCount >= 0, "cm_scache_t refCount 0");
2140 #ifdef DEBUG_REFCOUNT
2141     osi_Log2(afsd_logp,"cm_ReleaseSCache scp 0x%p ref %d",scp, refCount);
2142     afsi_log("%s:%d cm_ReleaseSCache scp 0x%p ref %d", file, line, scp, refCount);
2143 #endif
2144     lock_ReleaseRead(&cm_scacheLock);
2145
2146     if (scp->flags & CM_SCACHEFLAG_DELETED) {
2147         int deleted = 0;
2148         lock_ObtainWrite(&scp->rw);
2149         if (scp->flags & CM_SCACHEFLAG_DELETED)
2150             deleted = 1;
2151         if (deleted) {
2152             lock_ObtainWrite(&cm_scacheLock);
2153             cm_RecycleSCache(scp, 0);
2154             lock_ReleaseWrite(&cm_scacheLock);
2155         }
2156         lock_ReleaseWrite(&scp->rw);
2157     }
2158 }
2159
2160 /* just look for the scp entry to get filetype */
2161 /* doesn't need to be perfectly accurate, so locking doesn't matter too much */
2162 int cm_FindFileType(cm_fid_t *fidp)
2163 {
2164     long hash;
2165     cm_scache_t *scp;
2166
2167     hash = CM_SCACHE_HASH(fidp);
2168
2169     osi_assertx(fidp->cell != 0, "unassigned cell value");
2170
2171     lock_ObtainWrite(&cm_scacheLock);
2172     for (scp=cm_data.scacheHashTablep[hash]; scp; scp=scp->nextp) {
2173         if (cm_FidCmp(fidp, &scp->fid) == 0) {
2174             lock_ReleaseWrite(&cm_scacheLock);
2175             return scp->fileType;
2176         }
2177     }
2178     lock_ReleaseWrite(&cm_scacheLock);
2179     return 0;
2180 }
2181
2182 /* dump all scp's that have reference count > 0 to a file.
2183  * cookie is used to identify this batch for easy parsing,
2184  * and it a string provided by a caller
2185  */
2186 int cm_DumpSCache(FILE *outputFile, char *cookie, int lock)
2187 {
2188     int zilch;
2189     cm_scache_t *scp;
2190     osi_queue_t *q;
2191     char output[2048];
2192     int i;
2193
2194     if (lock)
2195         lock_ObtainRead(&cm_scacheLock);
2196
2197     sprintf(output, "%s - dumping all scache - cm_data.currentSCaches=%d, cm_data.maxSCaches=%d\r\n", cookie, cm_data.currentSCaches, cm_data.maxSCaches);
2198     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2199
2200     for (scp = cm_data.allSCachesp; scp; scp = scp->allNextp)
2201     {
2202         time_t t;
2203         char *srvStr = NULL;
2204         afs_uint32 srvStrRpc = TRUE;
2205         char *cbt = NULL;
2206         char *cdrot = NULL;
2207
2208         if (scp->cbServerp) {
2209             if (!((scp->cbServerp->flags & CM_SERVERFLAG_UUID) &&
2210                 UuidToString((UUID *)&scp->cbServerp->uuid, &srvStr) == RPC_S_OK)) {
2211                 srvStr = malloc(16); /* enough for 255.255.255.255 */
2212                 if (srvStr != NULL)
2213                     afs_inet_ntoa_r(scp->cbServerp->addr.sin_addr.s_addr, srvStr);
2214                 srvStrRpc = FALSE;
2215             }
2216         }
2217         if (scp->cbExpires) {
2218             t = scp->cbExpires;
2219             cbt = ctime(&t);
2220             if (cbt) {
2221                 cbt = strdup(cbt);
2222                 cbt[strlen(cbt)-1] = '\0';
2223             }
2224         }
2225         if (scp->volumeCreationDate) {
2226             t = scp->volumeCreationDate;
2227             cdrot = ctime(&t);
2228             if (cdrot) {
2229                 cdrot = strdup(cdrot);
2230                 cdrot[strlen(cdrot)-1] = '\0';
2231             }
2232         }
2233         sprintf(output,
2234                 "%s scp=0x%p, fid (cell=%d, volume=%d, vnode=%d, unique=%d) type=%d dv=%I64d len=0x%I64x "
2235                 "mp='%s' Locks (server=0x%x shared=%d excl=%d clnt=%d) fsLockCount=%d linkCount=%d anyAccess=0x%x "
2236                 "flags=0x%x cbServer='%s' cbExpires='%s' volumeCreationDate='%s' refCount=%u\r\n",
2237                 cookie, scp, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique,
2238                 scp->fileType, scp->dataVersion, scp->length.QuadPart, scp->mountPointStringp,
2239                 scp->serverLock, scp->sharedLocks, scp->exclusiveLocks, scp->clientLocks, scp->fsLockCount,
2240                 scp->linkCount, scp->anyAccess, scp->flags, srvStr ? srvStr : "<none>", cbt ? cbt : "<none>",
2241                 cdrot ? cdrot : "<none>", scp->refCount);
2242         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2243
2244         if (scp->fileLocksH) {
2245             sprintf(output, "  %s - begin dumping scp locks\r\n", cookie);
2246             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2247
2248             for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
2249                 cm_file_lock_t * lockp = fileq_to_cm_file_lock_t(q);
2250                 sprintf(output, "  %s lockp=0x%p scp=0x%p, cm_userp=0x%p offset=0x%I64x len=0x%08I64x type=0x%x "
2251                         "key=0x%I64x flags=0x%x update=0x%I64u\r\n",
2252                         cookie, lockp, lockp->scp, lockp->userp, lockp->range.offset, lockp->range.length,
2253                         lockp->lockType, lockp->key, lockp->flags, (afs_uint64)lockp->lastUpdate);
2254                 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2255             }
2256
2257             sprintf(output, "  %s - done dumping scp locks\r\n", cookie);
2258             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2259         }
2260
2261         if (srvStr) {
2262             if (srvStrRpc)
2263                 RpcStringFree(&srvStr);
2264             else
2265                 free(srvStr);
2266         }
2267         if (cbt)
2268             free(cbt);
2269         if (cdrot)
2270             free(cdrot);
2271     }
2272
2273     sprintf(output, "%s - Done dumping all scache.\r\n", cookie);
2274     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2275     sprintf(output, "%s - dumping cm_data.scacheHashTable - cm_data.scacheHashTableSize=%d\r\n",
2276             cookie, cm_data.scacheHashTableSize);
2277     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2278
2279     for (i = 0; i < cm_data.scacheHashTableSize; i++)
2280     {
2281         for(scp = cm_data.scacheHashTablep[i]; scp; scp=scp->nextp)
2282         {
2283             sprintf(output, "%s scp=0x%p, hash=%d, fid (cell=%d, volume=%d, vnode=%d, unique=%d)\r\n",
2284                     cookie, scp, i, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
2285             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2286         }
2287     }
2288
2289     sprintf(output, "%s - Done dumping cm_data.scacheHashTable\r\n", cookie);
2290     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2291
2292     sprintf(output, "%s - begin dumping all file locks\r\n", cookie);
2293     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2294
2295     for (q = cm_allFileLocks; q; q = osi_QNext(q)) {
2296         cm_file_lock_t * lockp = (cm_file_lock_t *)q;
2297         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",
2298                  cookie, lockp, lockp->scp, lockp->userp, lockp->range.offset, lockp->range.length,
2299                  lockp->lockType, lockp->key, lockp->flags, (afs_uint64)lockp->lastUpdate);
2300         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2301     }
2302
2303     sprintf(output, "%s - done dumping all file locks\r\n", cookie);
2304     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2305
2306     if (lock)
2307         lock_ReleaseRead(&cm_scacheLock);
2308     return (0);
2309 }
2310