windows-pcache-20050310
[openafs.git] / src / WINNT / afsd / cm_scache.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #include <afs/param.h>
11 #include <afs/stds.h>
12
13 #ifndef DJGPP
14 #include <windows.h>
15 #include <winsock2.h>
16 #include <nb30.h>
17 #endif /* !DJGPP */
18 #include <malloc.h>
19 #include <string.h>
20 #include <stdlib.h>
21 #include <osi.h>
22
23 #include "afsd.h"
24
25 /*extern void afsi_log(char *pattern, ...);*/
26
27 extern osi_hyper_t hzero;
28
29 /* File locks */
30 osi_queue_t *cm_allFileLocks;
31
32 /* lock for globals */
33 osi_rwlock_t cm_scacheLock;
34
35 /* Dummy scache entry for use with pioctl fids */
36 cm_scache_t cm_fakeSCache;
37
38 #ifdef AFS_FREELANCE_CLIENT
39 extern osi_mutex_t cm_Freelance_Lock;
40 #endif
41
42 /* must be called with cm_scacheLock write-locked! */
43 void cm_AdjustLRU(cm_scache_t *scp)
44 {
45     if (scp == cm_data.scacheLRULastp)
46         cm_data.scacheLRULastp = (cm_scache_t *) osi_QPrev(&scp->q);
47     osi_QRemove((osi_queue_t **) &cm_data.scacheLRUFirstp, &scp->q);
48     osi_QAdd((osi_queue_t **) &cm_data.scacheLRUFirstp, &scp->q);
49     if (!cm_data.scacheLRULastp) 
50         cm_data.scacheLRULastp = scp;
51 }
52
53 /* called with cm_scacheLock write-locked; find a vnode to recycle.
54  * Can allocate a new one if desperate, or if below quota (cm_data.maxSCaches).
55  */
56 cm_scache_t *cm_GetNewSCache(void)
57 {
58     cm_scache_t *scp;
59     int i;
60     cm_scache_t **lscpp;
61     cm_scache_t *tscp;
62
63     if (cm_data.currentSCaches >= cm_data.maxSCaches) {
64         for (scp = cm_data.scacheLRULastp;
65               scp;
66               scp = (cm_scache_t *) osi_QPrev(&scp->q)) {
67             if (scp->refCount == 0) 
68                 break;
69         }
70                 
71         if (scp) {
72             osi_assert(scp >= cm_data.scacheBaseAddress && scp < (cm_scache_t *)cm_data.hashTablep);
73             /* we found an entry, so return it */
74             if (scp->flags & CM_SCACHEFLAG_INHASH) {
75                 /* hash it out first */
76                 i = CM_SCACHE_HASH(&scp->fid);
77                 for (lscpp = &cm_data.hashTablep[i], tscp = cm_data.hashTablep[i];
78                       tscp;
79                       lscpp = &tscp->nextp, tscp = tscp->nextp) {
80                     if (tscp == scp) {
81                         *lscpp = scp->nextp;
82                         scp->flags &= ~CM_SCACHEFLAG_INHASH;
83                         break;
84                     }
85                 }
86                 osi_assertx(tscp, "afsd: scache hash screwup");
87             }
88
89             /* look for things that shouldn't still be set */
90             osi_assert(scp->bufWritesp == NULL);
91             osi_assert(scp->bufReadsp == NULL);
92
93             /* invalidate so next merge works fine;
94             * also initialize some flags */
95             scp->flags &= ~(CM_SCACHEFLAG_STATD
96                              | CM_SCACHEFLAG_RO
97                              | CM_SCACHEFLAG_PURERO
98                              | CM_SCACHEFLAG_OVERQUOTA
99                              | CM_SCACHEFLAG_OUTOFSPACE);
100             scp->serverModTime = 0;
101             scp->dataVersion = 0;
102             scp->bulkStatProgress = hzero;
103
104             /* discard callback */
105             if (scp->cbServerp) {
106                 cm_PutServer(scp->cbServerp);
107                 scp->cbServerp = NULL;
108             }
109             scp->cbExpires = 0;
110
111             /* remove from dnlc */
112             cm_dnlcPurgedp(scp);
113             cm_dnlcPurgevp(scp);
114
115             /* discard cached status; if non-zero, Close
116              * tried to store this to server but failed */
117             scp->mask = 0;
118
119             /* drop held volume ref */
120             if (scp->volp) {
121                 cm_PutVolume(scp->volp);
122                 scp->volp = NULL;
123             }
124
125             /* discard symlink info */
126             scp->mountPointStringp[0] = 0;
127             memset(&scp->mountRootFid, 0, sizeof(cm_fid_t));
128             memset(&scp->dotdotFid, 0, sizeof(cm_fid_t));
129
130             /* not locked, but there can be no references to this guy
131              * while we hold the global refcount lock.
132              */
133             cm_FreeAllACLEnts(scp);
134
135             /* now remove from the LRU queue and put it back at the
136              * head of the LRU queue.
137              */
138             cm_AdjustLRU(scp);
139
140             /* and we're done */
141             return scp;
142         }
143     }
144         
145     /* if we get here, we should allocate a new scache entry.  We either are below
146      * quota or we have a leak and need to allocate a new one to avoid panicing.
147      */
148     scp = cm_data.scacheBaseAddress + cm_data.currentSCaches;
149     osi_assert(scp >= cm_data.scacheBaseAddress && scp < (cm_scache_t *)cm_data.hashTablep);
150     memset(scp, 0, sizeof(cm_scache_t));
151     scp->magic = CM_SCACHE_MAGIC;
152     lock_InitializeMutex(&scp->mx, "cm_scache_t mutex");
153     lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock");
154
155     /* and put it in the LRU queue */
156     osi_QAdd((osi_queue_t **) &cm_data.scacheLRUFirstp, &scp->q);
157     if (!cm_data.scacheLRULastp) 
158         cm_data.scacheLRULastp = scp;
159     cm_data.currentSCaches++;
160     cm_dnlcPurgedp(scp); /* make doubly sure that this is not in dnlc */
161     cm_dnlcPurgevp(scp); 
162     return scp;
163 }       
164
165 /* like strcmp, only for fids */
166 int cm_FidCmp(cm_fid_t *ap, cm_fid_t *bp)
167 {
168     if (ap->vnode != bp->vnode) 
169         return 1;
170     if (ap->volume != bp->volume) 
171         return 1;
172     if (ap->unique != bp->unique) 
173         return 1;
174     if (ap->cell != bp->cell) 
175         return 1;
176     return 0;
177 }
178
179 void cm_fakeSCacheInit(int newFile)
180 {
181     if ( newFile ) {
182         memset(&cm_data.fakeSCache, 0, sizeof(cm_scache_t));
183         cm_data.fakeSCache.cbServerp = (struct cm_server *)(-1);
184         /* can leave clientModTime at 0 */
185         cm_data.fakeSCache.fileType = CM_SCACHETYPE_FILE;
186         cm_data.fakeSCache.unixModeBits = 0777;
187         cm_data.fakeSCache.length.LowPart = 1000;
188         cm_data.fakeSCache.linkCount = 1;
189         cm_data.fakeSCache.refCount = 1;
190     }
191     lock_InitializeMutex(&cm_data.fakeSCache.mx, "cm_scache_t mutex");
192 }       
193
194 long
195 cm_ValidateSCache(void)
196 {
197     cm_scache_t * scp;
198     long i;
199
200     for ( scp = cm_data.scacheLRUFirstp; scp;
201           scp = (cm_scache_t *) osi_QNext(&scp->q) ) {
202         if (scp->magic != CM_SCACHE_MAGIC) {
203             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
204             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
205             return -1;
206         }
207         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
208             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
209             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
210             return -2;
211         }
212         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
213             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
214             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
215             return -3;
216         }
217         if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
218             afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
219             fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
220             return -4;
221         }
222     }
223
224     for ( scp = cm_data.scacheLRULastp; scp;
225           scp = (cm_scache_t *) osi_QPrev(&scp->q) ) {
226         if (scp->magic != CM_SCACHE_MAGIC) {
227             afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
228             fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
229             return -5;
230         }
231         if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
232             afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
233             fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
234             return -6;
235         }
236         if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
237             afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
238             fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
239             return -7;
240         }
241         if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
242             afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
243             fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
244             return -8;
245         }
246     }
247
248     for ( i=0; i < cm_data.hashTableSize; i++ ) {
249         for ( scp = cm_data.hashTablep[i]; scp; scp = scp->nextp ) {
250             if (scp->magic != CM_SCACHE_MAGIC) {
251                 afsi_log("cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC");
252                 fprintf(stderr, "cm_ValidateSCache failure: scp->magic != CM_SCACHE_MAGIC\n");
253                 return -9;
254             }
255             if (scp->nextp && scp->nextp->magic != CM_SCACHE_MAGIC) {
256                 afsi_log("cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC");
257                 fprintf(stderr, "cm_ValidateSCache failure: scp->nextp->magic != CM_SCACHE_MAGIC\n");
258                 return -10;
259             }
260             if (scp->randomACLp && scp->randomACLp->magic != CM_ACLENT_MAGIC) {
261                 afsi_log("cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC");
262                 fprintf(stderr, "cm_ValidateSCache failure: scp->randomACLp->magic != CM_ACLENT_MAGIC\n");
263                 return -11;
264             }
265             if (scp->volp && scp->volp->magic != CM_VOLUME_MAGIC) {
266                 afsi_log("cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC");
267                 fprintf(stderr, "cm_ValidateSCache failure: scp->volp->magic != CM_VOLUME_MAGIC\n");
268                 return -12;
269             }
270         }
271     }
272
273     return cm_dnlcValidate();
274 }
275
276 long
277 cm_ShutdownSCache(void)
278 {
279     cm_scache_t * scp;
280
281     for ( scp = cm_data.scacheLRULastp; scp;
282           scp = (cm_scache_t *) osi_QPrev(&scp->q) ) {
283         if (scp->randomACLp) {
284             lock_ObtainWrite(&scp->mx);
285             cm_FreeAllACLEnts(scp);
286             lock_ReleaseWrite(&scp->mx);
287         }
288         lock_FinalizeMutex(&scp->mx);
289         lock_FinalizeRWLock(&scp->bufCreateLock);
290     }
291
292     return cm_dnlcShutdown();
293 }
294
295 void cm_InitSCache(int newFile, long maxSCaches)
296 {
297     static osi_once_t once;
298         
299     if (osi_Once(&once)) {
300         lock_InitializeRWLock(&cm_scacheLock, "cm_scacheLock");
301         if ( newFile ) {
302             memset(cm_data.hashTablep, 0, sizeof(cm_scache_t *) * cm_data.hashTableSize);
303             cm_data.currentSCaches = 0;
304             cm_data.maxSCaches = maxSCaches;
305             cm_data.scacheLRUFirstp = cm_data.scacheLRULastp = NULL;
306         } else {
307             cm_scache_t * scp;
308
309             for ( scp = cm_data.scacheLRULastp; scp;
310                   scp = (cm_scache_t *) osi_QPrev(&scp->q) ) {
311                 lock_InitializeMutex(&scp->mx, "cm_scache_t mutex");
312                 lock_InitializeRWLock(&scp->bufCreateLock, "cm_scache_t bufCreateLock");
313
314                 scp->cbServerp = NULL;
315                 scp->cbExpires = 0;
316                 scp->fileLocks = NULL;
317                 scp->openReads = 0;
318                 scp->openWrites = 0;
319                 scp->openShares = 0;
320                 scp->openExcls = 0;
321             }
322         }
323         cm_allFileLocks = NULL;
324         cm_fakeSCacheInit(newFile);
325         cm_dnlcInit(newFile);
326         osi_EndOnce(&once);
327     }
328 }
329
330 /* version that doesn't bother creating the entry if we don't find it */
331 cm_scache_t *cm_FindSCache(cm_fid_t *fidp)
332 {
333     long hash;
334     cm_scache_t *scp;
335
336     hash = CM_SCACHE_HASH(fidp);
337         
338     osi_assert(fidp->cell != 0);
339
340     lock_ObtainWrite(&cm_scacheLock);
341     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
342         if (cm_FidCmp(fidp, &scp->fid) == 0) {
343             cm_HoldSCacheNoLock(scp);
344             cm_AdjustLRU(scp);
345             lock_ReleaseWrite(&cm_scacheLock);
346             return scp;
347         }
348     }
349     lock_ReleaseWrite(&cm_scacheLock);
350     return NULL;
351 }
352
353 long cm_GetSCache(cm_fid_t *fidp, cm_scache_t **outScpp, cm_user_t *userp,
354                   cm_req_t *reqp)
355 {
356     long hash;
357     cm_scache_t *scp;
358     long code;
359     cm_volume_t *volp = 0;
360     cm_cell_t *cellp;
361     char* mp = 0;
362     int special; // yj: boolean variable to test if file is on root.afs
363     int isRoot;
364     extern cm_fid_t cm_rootFid;
365         
366     hash = CM_SCACHE_HASH(fidp);
367         
368     osi_assert(fidp->cell != 0);
369
370     if (fidp->cell== cm_data.rootFid.cell && 
371          fidp->volume==cm_data.rootFid.volume &&
372          fidp->vnode==0x0 && fidp->unique==0x0)
373     {
374         osi_Log0(afsd_logp,"cm_getSCache called with root cell/volume and vnode=0 and unique=0");
375     }
376
377     // yj: check if we have the scp, if so, we don't need
378     // to do anything else
379     lock_ObtainWrite(&cm_scacheLock);
380     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
381         if (cm_FidCmp(fidp, &scp->fid) == 0) {
382             cm_HoldSCacheNoLock(scp);
383             *outScpp = scp;
384             cm_AdjustLRU(scp);
385             lock_ReleaseWrite(&cm_scacheLock);
386             return 0;
387         }
388     }
389         
390     // yj: when we get here, it means we don't have an scp
391     // so we need to either load it or fake it, depending
392     // on whether the file is "special", see below.
393
394     // yj: if we're trying to get an scp for a file that's
395     // on root.afs of homecell, we want to handle it specially
396     // because we have to fill in the status stuff 'coz we
397     // don't want trybulkstat to fill it in for us
398 #ifdef AFS_FREELANCE_CLIENT
399     special = (fidp->cell==AFS_FAKE_ROOT_CELL_ID && 
400                fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
401                !(fidp->vnode==0x1 && fidp->unique==0x1));
402     isRoot = (fidp->cell==AFS_FAKE_ROOT_CELL_ID && 
403               fidp->volume==AFS_FAKE_ROOT_VOL_ID &&
404               fidp->vnode==0x1 && fidp->unique==0x1);
405     if (cm_freelanceEnabled && isRoot) {
406         osi_Log0(afsd_logp,"cm_getSCache Freelance and isRoot");
407         /* freelance: if we are trying to get the root scp for the first
408          * time, we will just put in a place holder entry. 
409          */
410         volp = NULL;
411     }
412           
413     if (cm_freelanceEnabled && special) {
414         osi_Log0(afsd_logp,"cm_getSCache Freelance and special");
415         if (fidp->vnode > 1) {
416             lock_ObtainMutex(&cm_Freelance_Lock);
417             mp =(cm_localMountPoints+fidp->vnode-2)->mountPointStringp;
418             lock_ReleaseMutex(&cm_Freelance_Lock);
419         } else {
420             mp = "";
421         }
422         scp = cm_GetNewSCache();
423                 
424         scp->fid = *fidp;
425         scp->volp = cm_data.rootSCachep->volp;
426         scp->dotdotFid.cell=AFS_FAKE_ROOT_CELL_ID;
427         scp->dotdotFid.volume=AFS_FAKE_ROOT_VOL_ID;
428         scp->dotdotFid.unique=1;
429         scp->dotdotFid.vnode=1;
430         scp->flags |= (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO);
431         scp->nextp=cm_data.hashTablep[hash];
432         cm_data.hashTablep[hash]=scp;
433         scp->flags |= CM_SCACHEFLAG_INHASH;
434         scp->refCount = 1;
435         scp->fileType = (cm_localMountPoints+fidp->vnode-2)->fileType;
436
437         lock_ObtainMutex(&cm_Freelance_Lock);
438         scp->length.LowPart = strlen(mp)+4;
439         strncpy(scp->mountPointStringp,mp,MOUNTPOINTLEN);
440         scp->mountPointStringp[MOUNTPOINTLEN-1] = '\0';
441         lock_ReleaseMutex(&cm_Freelance_Lock);
442
443         scp->owner=0x0;
444         scp->unixModeBits=0x1ff;
445         scp->clientModTime=FakeFreelanceModTime;
446         scp->serverModTime=FakeFreelanceModTime;
447         scp->parentUnique = 0x1;
448         scp->parentVnode=0x1;
449         scp->group=0;
450         scp->dataVersion=cm_data.fakeDirVersion;
451         *outScpp = scp;
452         lock_ReleaseWrite(&cm_scacheLock);
453         /*afsi_log("   getscache done");*/
454         return 0;
455     }
456     // end of yj code
457 #endif /* AFS_FREELANCE_CLIENT */
458
459     /* otherwise, we need to find the volume */
460     if (!cm_freelanceEnabled || !isRoot) {
461         lock_ReleaseWrite(&cm_scacheLock);      /* for perf. reasons */
462         cellp = cm_FindCellByID(fidp->cell);
463         if (!cellp) 
464             return CM_ERROR_NOSUCHCELL;
465
466         code = cm_GetVolumeByID(cellp, fidp->volume, userp, reqp, &volp);
467         if (code) 
468             return code;
469         lock_ObtainWrite(&cm_scacheLock);
470     }
471         
472     /* otherwise, we have the volume, now reverify that the scp doesn't
473      * exist, and proceed.
474      */
475     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
476         if (cm_FidCmp(fidp, &scp->fid) == 0) {
477             cm_HoldSCacheNoLock(scp);
478             osi_assert(scp->volp == volp);
479             cm_AdjustLRU(scp);
480             lock_ReleaseWrite(&cm_scacheLock);
481             if (volp)
482                 cm_PutVolume(volp);
483             *outScpp = scp;
484             return 0;
485         }
486     }
487         
488     /* now, if we don't have the fid, recycle something */
489     scp = cm_GetNewSCache();
490     osi_assert(!(scp->flags & CM_SCACHEFLAG_INHASH));
491     scp->fid = *fidp;
492     scp->volp = volp;   /* a held reference */
493
494     if (!cm_freelanceEnabled || !isRoot) {
495         /* if this scache entry represents a volume root then we need 
496          * to copy the dotdotFipd from the volume structure where the 
497          * "master" copy is stored (defect 11489)
498          */
499         if (scp->fid.vnode == 1 && scp->fid.unique == 1) {
500             scp->dotdotFid = volp->dotdotFid;
501         }
502           
503         if (volp->roID == fidp->volume)
504             scp->flags |= (CM_SCACHEFLAG_PURERO | CM_SCACHEFLAG_RO);
505         else if (volp->bkID == fidp->volume)
506             scp->flags |= CM_SCACHEFLAG_RO;
507     }
508     scp->nextp = cm_data.hashTablep[hash];
509     cm_data.hashTablep[hash] = scp;
510     scp->flags |= CM_SCACHEFLAG_INHASH;
511     scp->refCount = 1;
512
513     /* XXX - The following fields in the cm_scache are 
514      * uninitialized:
515      *   fileType
516      *   parentVnode
517      *   parentUnique
518      */
519     lock_ReleaseWrite(&cm_scacheLock);
520         
521     /* now we have a held scache entry; just return it */
522     *outScpp = scp;
523     return 0;
524 }
525
526 /* synchronize a fetch, store, read, write, fetch status or store status.
527  * Called with scache mutex held, and returns with it held, but temporarily
528  * drops it during the fetch.
529  * 
530  * At most one flag can be on in flags, if this is an RPC request.
531  *
532  * Also, if we're fetching or storing data, we must ensure that we have a buffer.
533  *
534  * There are a lot of weird restrictions here; here's an attempt to explain the
535  * rationale for the concurrency restrictions implemented in this function.
536  *
537  * First, although the file server will break callbacks when *another* machine
538  * modifies a file or status block, the client itself is responsible for
539  * concurrency control on its own requests.  Callback breaking events are rare,
540  * and simply invalidate any concurrent new status info.
541  *
542  * In the absence of callback breaking messages, we need to know how to
543  * synchronize incoming responses describing updates to files.  We synchronize
544  * operations that update the data version by comparing the data versions.
545  * However, updates that do not update the data, but only the status, can't be
546  * synchronized with fetches or stores, since there's nothing to compare
547  * to tell which operation executed first at the server.
548  *
549  * Thus, we can allow multiple ops that change file data, or dir data, and
550  * fetches.  However, status storing ops have to be done serially.
551  *
552  * Furthermore, certain data-changing ops are incompatible: we can't read or
553  * write a buffer while doing a truncate.  We can't read and write the same
554  * buffer at the same time, or write while fetching or storing, or read while
555  * fetching a buffer (this may change).  We can't fetch and store at the same
556  * time, either.
557  *
558  * With respect to status, we can't read and write at the same time, read while
559  * fetching, write while fetching or storing, or fetch and store at the same time.
560  *
561  * We can't allow a get callback RPC to run in concurrently with something that
562  * will return updated status, since we could start a call, have the server
563  * return status, have another machine make an update to the status (which
564  * doesn't change serverModTime), have the original machine get a new callback,
565  * and then have the original machine merge in the early, old info from the
566  * first call.  At this point, the easiest way to avoid this problem is to have
567  * getcallback calls conflict with all others for the same vnode.  Other calls
568  * to cm_MergeStatus that aren't associated with calls to cm_SyncOp on the same
569  * vnode must be careful not to merge in their status unless they have obtained
570  * a callback from the start of their call.
571  *
572  * Note added 1/23/96
573  * Concurrent StoreData RPC's can cause trouble if the file is being extended.
574  * Each such RPC passes a FileLength parameter, which the server uses to do
575  * pre-truncation if necessary.  So if two RPC's are processed out of order at
576  * the server, the one with the smaller FileLength will be processed last,
577  * possibly resulting in a bogus truncation.  The simplest way to avoid this
578  * is to serialize all StoreData RPC's.  This is the reason we defined
579  * CM_SCACHESYNC_STOREDATA_EXCL and CM_SCACHEFLAG_DATASTORING.
580  */
581 long cm_SyncOp(cm_scache_t *scp, cm_buf_t *bufp, cm_user_t *up, cm_req_t *reqp,
582                long rights, long flags)
583 {
584     osi_queueData_t *qdp;
585     long code;
586     cm_buf_t *tbufp;
587     long outRights;
588     int bufLocked;
589
590     /* lookup this first */
591     bufLocked = flags & CM_SCACHESYNC_BUFLOCKED;
592
593     /* some minor assertions */
594     if (flags & (CM_SCACHESYNC_STOREDATA | CM_SCACHESYNC_FETCHDATA
595                   | CM_SCACHESYNC_READ | CM_SCACHESYNC_WRITE
596                   | CM_SCACHESYNC_SETSIZE)) {
597         if (bufp) {
598             osi_assert(bufp->refCount > 0);
599             /*
600                osi_assert(cm_FidCmp(&bufp->fid, &scp->fid) == 0);
601              */
602         }
603     }
604     else osi_assert(bufp == NULL);
605
606     /* Do the access check.  Now we don't really do the access check
607      * atomically, since the caller doesn't expect the parent dir to be
608      * returned locked, and that is what we'd have to do to prevent a
609      * callback breaking message on the parent due to a setacl call from
610      * being processed while we're running.  So, instead, we check things
611      * here, and if things look fine with the access, we proceed to finish
612      * the rest of this check.  Sort of a hack, but probably good enough.
613      */
614
615     while (1) {
616         if (flags & CM_SCACHESYNC_FETCHSTATUS) {
617             /* if we're bringing in a new status block, ensure that
618              * we aren't already doing so, and that no one is
619              * changing the status concurrently, either.  We need
620              * to do this, even if the status is of a different
621              * type, since we don't have the ability to figure out,
622              * in the AFS 3 protocols, which status-changing
623              * operation ran first, or even which order a read and
624              * a write occurred in.
625              */
626             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
627                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
628                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING|STORING|SIZESTORING|GETCALLBACK want FETCHSTATUS", scp);
629                 goto sleep;
630             }
631         }
632         if (flags & (CM_SCACHESYNC_STORESIZE | CM_SCACHESYNC_STORESTATUS
633                       | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_GETCALLBACK)) {
634             /* if we're going to make an RPC to change the status, make sure
635              * that no one is bringing in or sending out the status.
636              */
637             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING |
638                               CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
639                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING|STORING|SIZESTORING|GETCALLBACK want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
640                 goto sleep;
641             }
642             if (scp->bufReadsp || scp->bufWritesp) {
643                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is bufRead|bufWrite want STORESIZE|STORESTATUS|SETSIZE|GETCALLBACK", scp);
644                 goto sleep;
645             }
646         }
647         if (flags & CM_SCACHESYNC_FETCHDATA) {
648             /* if we're bringing in a new chunk of data, make sure that
649              * nothing is happening to that chunk, and that we aren't
650              * changing the basic file status info, either.
651              */
652             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
653                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
654                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING|STORING|SIZESTORING|GETCALLBACK want FETCHDATA", scp);
655                 goto sleep;
656             }
657             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING))) {
658                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is BUF_CMFETCHING|BUF_CMSTORING want FETCHDATA", scp);
659                 goto sleep;
660             }
661         }
662         if (flags & CM_SCACHESYNC_STOREDATA) {
663             /* same as fetch data */
664             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
665                                | CM_SCACHEFLAG_SIZESTORING | CM_SCACHEFLAG_GETCALLBACK)) {
666                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING|STORING|SIZESTORING|GETCALLBACK want STOREDATA", scp);
667                 goto sleep;
668             }
669             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING))) {
670                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is BUF_CMFETCHING|BUF_CMSTORING want STOREDATA", scp);
671                 goto sleep;
672             }
673         }
674
675         if (flags & CM_SCACHESYNC_STOREDATA_EXCL) {
676             /* Don't allow concurrent StoreData RPC's */
677             if (scp->flags & CM_SCACHEFLAG_DATASTORING) {
678                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is DATASTORING want STOREDATA_EXCL", scp);
679                 goto sleep;
680             }
681         }
682
683         if (flags & CM_SCACHESYNC_ASYNCSTORE) {
684             /* Don't allow more than one BKG store request */
685             if (scp->flags & CM_SCACHEFLAG_ASYNCSTORING) {
686                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is ASYNCSTORING want ASYNCSTORE", scp);
687                 goto sleep;
688             }
689         }
690
691         if (flags & CM_SCACHESYNC_LOCK) {
692             /* Don't allow concurrent fiddling with lock lists */
693             if (scp->flags & CM_SCACHEFLAG_LOCKING) {
694                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is LOCKING want LOCK", scp);
695                 goto sleep;
696             }
697         }
698
699         /* now the operations that don't correspond to making RPCs */
700         if (flags & CM_SCACHESYNC_GETSTATUS) {
701             /* we can use the status that's here, if we're not
702              * bringing in new status.
703              */
704             if (scp->flags & (CM_SCACHEFLAG_FETCHING)) {
705                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING want GETSTATUS", scp);
706                 goto sleep;
707             }
708         }
709         if (flags & CM_SCACHESYNC_SETSTATUS) {
710             /* we can make a change to the local status, as long as
711              * the status isn't changing now.
712              *
713              * If we're fetching or storing a chunk of data, we can
714              * change the status locally, since the fetch/store
715              * operations don't change any of the data that we're
716              * changing here.
717              */
718             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
719                                | CM_SCACHEFLAG_SIZESTORING)) {
720                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING|STORING|SIZESTORING want SETSTATUS", scp);
721                 goto sleep;
722             }
723         }
724         if (flags & CM_SCACHESYNC_READ) {
725             /* we're going to read the data, make sure that the
726              * status is available, and that the data is here.  It
727              * is OK to read while storing the data back.
728              */
729             if (scp->flags & CM_SCACHEFLAG_FETCHING) {
730                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING want READ", scp);
731                 goto sleep;
732             }
733             if (bufp && ((bufp->cmFlags
734                            & (CM_BUF_CMFETCHING
735                                | CM_BUF_CMFULLYFETCHED))
736                           == CM_BUF_CMFETCHING)) {
737                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is BUF_CMFETCHING want READ", scp);
738                 goto sleep;
739             }
740         }
741         if (flags & CM_SCACHESYNC_WRITE) {
742             /* don't write unless the status is stable and the chunk
743              * is stable.
744              */
745             if (scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING
746                                | CM_SCACHEFLAG_SIZESTORING)) {
747                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is FETCHING|STORING|SIZESTORING want WRITE", scp);
748                 goto sleep;
749             }
750             if (bufp && (bufp->cmFlags & (CM_BUF_CMFETCHING | CM_BUF_CMSTORING))) {
751                 osi_Log1(afsd_logp, "CM SyncOp scp 0x%x is BUF_CMFETCHING|BUF_CMSTORING want WRITE", scp);
752                 goto sleep;
753             }
754         }
755
756         // yj: modified this so that callback only checked if we're
757         // not checking something on /afs
758         /* fix the conditional to match the one in cm_HaveCallback */
759         if (  (flags & CM_SCACHESYNC_NEEDCALLBACK)
760 #ifdef AFS_FREELANCE_CLIENT
761              && (!cm_freelanceEnabled || 
762                   !(scp->fid.vnode==0x1 && scp->fid.unique==0x1) ||
763                   scp->fid.cell!=AFS_FAKE_ROOT_CELL_ID ||
764                   scp->fid.volume!=AFS_FAKE_ROOT_VOL_ID ||
765                   cm_fakeDirCallback < 2)
766 #endif /* AFS_FREELANCE_CLIENT */
767              ) {
768             if (!cm_HaveCallback(scp)) {
769                 osi_Log1(afsd_logp, "CM SyncOp getting callback on scp %x",
770                           (long) scp);
771                 if (bufLocked) lock_ReleaseMutex(&bufp->mx);
772                 code = cm_GetCallback(scp, up, reqp, 0);
773                 if (bufLocked) {
774                     lock_ReleaseMutex(&scp->mx);
775                     lock_ObtainMutex(&bufp->mx);
776                     lock_ObtainMutex(&scp->mx);
777                 }
778                 if (code) 
779                     return code;
780                 continue;
781             }
782         }
783
784         if (rights) {
785             /* can't check access rights without a callback */
786             osi_assert(flags & CM_SCACHESYNC_NEEDCALLBACK);
787
788             if ((rights & PRSFS_WRITE) && (scp->flags & CM_SCACHEFLAG_RO))
789                 return CM_ERROR_READONLY;
790
791             if (cm_HaveAccessRights(scp, up, rights, &outRights)) {
792                 if (~outRights & rights) return CM_ERROR_NOACCESS;
793             }
794             else {
795                 /* we don't know the required access rights */
796                 if (bufLocked) lock_ReleaseMutex(&bufp->mx);
797                 code = cm_GetAccessRights(scp, up, reqp);
798                 if (code) 
799                     return code;
800                 if (bufLocked) {
801                     lock_ReleaseMutex(&scp->mx);
802                     lock_ObtainMutex(&bufp->mx);
803                     lock_ObtainMutex(&scp->mx);
804                 }
805                 continue;
806             }
807         }
808
809         /* if we get here, we're happy */
810         break;
811
812       sleep:
813         /* first check if we're not supposed to wait: fail 
814          * in this case, returning with everything still locked.
815          */
816         if (flags & CM_SCACHESYNC_NOWAIT) 
817             return CM_ERROR_WOULDBLOCK;
818
819         /* wait here, then try again */
820         osi_Log1(afsd_logp, "CM SyncOp sleeping scp 0x%x", scp);
821         if ( scp->flags & CM_SCACHEFLAG_WAITING ) {
822             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING already set for 0x%x", scp);
823         } else {
824             osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING set for 0x%x", scp);
825             scp->flags |= CM_SCACHEFLAG_WAITING;
826         }
827         if (bufLocked) 
828             lock_ReleaseMutex(&bufp->mx);
829         osi_SleepM((long) &scp->flags, &scp->mx);
830         if (bufLocked) 
831             lock_ObtainMutex(&bufp->mx);
832         lock_ObtainMutex(&scp->mx);
833         osi_Log1(afsd_logp, "CM SyncOp woke! scp 0x%x", scp);
834     } /* big while loop */
835         
836     /* now, update the recorded state for RPC-type calls */
837     if (flags & CM_SCACHESYNC_FETCHSTATUS)
838         scp->flags |= CM_SCACHEFLAG_FETCHING;
839     if (flags & CM_SCACHESYNC_STORESTATUS)
840         scp->flags |= CM_SCACHEFLAG_STORING;
841     if (flags & CM_SCACHESYNC_STORESIZE)
842         scp->flags |= CM_SCACHEFLAG_SIZESTORING;
843     if (flags & CM_SCACHESYNC_GETCALLBACK)
844         scp->flags |= CM_SCACHEFLAG_GETCALLBACK;
845     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
846         scp->flags |= CM_SCACHEFLAG_DATASTORING;
847     if (flags & CM_SCACHESYNC_ASYNCSTORE)
848         scp->flags |= CM_SCACHEFLAG_ASYNCSTORING;
849     if (flags & CM_SCACHESYNC_LOCK)
850         scp->flags |= CM_SCACHEFLAG_LOCKING;
851
852     /* now update the buffer pointer */
853     if (flags & CM_SCACHESYNC_FETCHDATA) {
854         /* ensure that the buffer isn't already in the I/O list */
855         if (bufp) {
856             for(qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
857                 tbufp = osi_GetQData(qdp);
858                 osi_assert(tbufp != bufp);
859             }
860         }
861
862         /* queue a held reference to the buffer in the "reading" I/O list */
863         qdp = osi_QDAlloc();
864         osi_SetQData(qdp, bufp);
865         if (bufp) {
866             buf_Hold(bufp);
867             bufp->cmFlags |= CM_BUF_CMFETCHING;
868         }
869         osi_QAdd((osi_queue_t **) &scp->bufReadsp, &qdp->q);
870     }
871
872     if (flags & CM_SCACHESYNC_STOREDATA) {
873         /* ensure that the buffer isn't already in the I/O list */
874         if (bufp) {
875             for(qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
876                 tbufp = osi_GetQData(qdp);
877                 osi_assert(tbufp != bufp);
878             }
879         }
880
881         /* queue a held reference to the buffer in the "writing" I/O list */
882         qdp = osi_QDAlloc();
883         osi_SetQData(qdp, bufp);
884         if (bufp) {
885             buf_Hold(bufp);
886             bufp->cmFlags |= CM_BUF_CMSTORING;
887         }
888         osi_QAdd((osi_queue_t **) &scp->bufWritesp, &qdp->q);
889     }
890
891     return 0;
892 }
893
894 /* for those syncops that setup for RPCs.
895  * Called with scache locked.
896  */
897 void cm_SyncOpDone(cm_scache_t *scp, cm_buf_t *bufp, long flags)
898 {
899     osi_queueData_t *qdp;
900     cm_buf_t *tbufp;
901
902     /* now, update the recorded state for RPC-type calls */
903     if (flags & CM_SCACHESYNC_FETCHSTATUS)
904         scp->flags &= ~CM_SCACHEFLAG_FETCHING;
905     if (flags & CM_SCACHESYNC_STORESTATUS)
906         scp->flags &= ~CM_SCACHEFLAG_STORING;
907     if (flags & CM_SCACHESYNC_STORESIZE)
908         scp->flags &= ~CM_SCACHEFLAG_SIZESTORING;
909     if (flags & CM_SCACHESYNC_GETCALLBACK)
910         scp->flags &= ~CM_SCACHEFLAG_GETCALLBACK;
911     if (flags & CM_SCACHESYNC_STOREDATA_EXCL)
912         scp->flags &= ~CM_SCACHEFLAG_DATASTORING;
913     if (flags & CM_SCACHESYNC_ASYNCSTORE)
914         scp->flags &= ~CM_SCACHEFLAG_ASYNCSTORING;
915     if (flags & CM_SCACHESYNC_LOCK)
916         scp->flags &= ~CM_SCACHEFLAG_LOCKING;
917
918     /* now update the buffer pointer */
919     if (flags & CM_SCACHESYNC_FETCHDATA) {
920         /* ensure that the buffer isn't already in the I/O list */
921         for(qdp = scp->bufReadsp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
922             tbufp = osi_GetQData(qdp);
923             if (tbufp == bufp) break;
924         }
925         osi_assert(qdp != NULL);
926         osi_assert(osi_GetQData(qdp) == bufp);
927         osi_QRemove((osi_queue_t **) &scp->bufReadsp, &qdp->q);
928         osi_QDFree(qdp);
929         if (bufp) {
930             bufp->cmFlags &=
931                 ~(CM_BUF_CMFETCHING | CM_BUF_CMFULLYFETCHED);
932             buf_Release(bufp);
933         }
934     }
935
936     /* now update the buffer pointer */
937     if (flags & CM_SCACHESYNC_STOREDATA) {
938         /* ensure that the buffer isn't already in the I/O list */
939         for(qdp = scp->bufWritesp; qdp; qdp = (osi_queueData_t *) osi_QNext(&qdp->q)) {
940             tbufp = osi_GetQData(qdp);
941             if (tbufp == bufp) break;
942         }
943         osi_assert(qdp != NULL);
944         osi_assert(osi_GetQData(qdp) == bufp);
945         osi_QRemove((osi_queue_t **) &scp->bufWritesp, &qdp->q);
946         osi_QDFree(qdp);
947         if (bufp) {
948             bufp->cmFlags &= ~CM_BUF_CMSTORING;
949             buf_Release(bufp);
950         }
951     }
952
953     /* and wakeup anyone who is waiting */
954     if (scp->flags & CM_SCACHEFLAG_WAITING) {
955         osi_Log1(afsd_logp, "CM SyncOp CM_SCACHEFLAG_WAITING reset for 0x%x", scp);
956         scp->flags &= ~CM_SCACHEFLAG_WAITING;
957         osi_Wakeup((long) &scp->flags);
958     }
959 }       
960
961 /* merge in a response from an RPC.  The scp must be locked, and the callback
962  * is optional.
963  *
964  * Don't overwrite any status info that is dirty, since we could have a store
965  * operation (such as store data) that merges some info in, and we don't want
966  * to lose the local updates.  Typically, there aren't many updates we do
967  * locally, anyway, probably only mtime.
968  *
969  * There is probably a bug in here where a chmod (which doesn't change
970  * serverModTime) that occurs between two fetches, both of whose responses are
971  * handled after the callback breaking is done, but only one of whose calls
972  * started before that, can cause old info to be merged from the first call.
973  */
974 void cm_MergeStatus(cm_scache_t *scp, AFSFetchStatus *statusp, AFSVolSync *volp,
975                     cm_user_t *userp, int flags)
976 {
977     // yj: i want to create some fake status for the /afs directory and the
978     // entries under that directory
979 #ifdef AFS_FREELANCE_CLIENT
980     if (cm_freelanceEnabled && scp == cm_data.rootSCachep) {
981         osi_Log0(afsd_logp,"cm_MergeStatus Freelance cm_data.rootSCachep");
982         statusp->InterfaceVersion = 0x1;
983         statusp->FileType = CM_SCACHETYPE_DIRECTORY;
984         statusp->LinkCount = scp->linkCount;
985         statusp->Length = cm_fakeDirSize;
986         statusp->DataVersion = cm_data.fakeDirVersion;
987         statusp->Author = 0x1;
988         statusp->Owner = 0x0;
989         statusp->CallerAccess = 0x9;
990         statusp->AnonymousAccess = 0x9;
991         statusp->UnixModeBits = 0x1ff;
992         statusp->ParentVnode = 0x1;
993         statusp->ParentUnique = 0x1;
994         statusp->ResidencyMask = 0;
995         statusp->ClientModTime = FakeFreelanceModTime;
996         statusp->ServerModTime = FakeFreelanceModTime;
997         statusp->Group = 0;
998         statusp->SyncCounter = 0;
999         statusp->dataVersionHigh = 0;
1000     }
1001 #endif /* AFS_FREELANCE_CLIENT */
1002
1003     if (!(flags & CM_MERGEFLAG_FORCE)
1004          && statusp->DataVersion < (unsigned long) scp->dataVersion) {
1005         struct cm_cell *cellp;
1006         struct cm_volume *volp;
1007
1008         cellp = cm_FindCellByID(scp->fid.cell);
1009         cm_GetVolumeByID(cellp, scp->fid.volume, userp,
1010                           (cm_req_t *) NULL, &volp);
1011         if (scp->cbServerp)
1012             osi_Log2(afsd_logp, "old data from server %x volume %s",
1013                       scp->cbServerp->addr.sin_addr.s_addr,
1014                       volp->namep);
1015         osi_Log3(afsd_logp, "Bad merge, scp %x, scp dv %d, RPC dv %d",
1016                   scp, scp->dataVersion, statusp->DataVersion);
1017         /* we have a number of data fetch/store operations running
1018          * concurrently, and we can tell which one executed last at the
1019          * server by its mtime.
1020          * Choose the one with the largest mtime, and ignore the rest.
1021          *
1022          * These concurrent calls are incompatible with setting the
1023          * mtime, so we won't have a locally changed mtime here.
1024          *
1025          * We could also have ACL info for a different user than usual,
1026          * in which case we have to do that part of the merge, anyway.
1027          * We won't have to worry about the info being old, since we
1028          * won't have concurrent calls
1029          * that change file status running from this machine.
1030          *
1031          * Added 3/17/98:  if we see data version regression on an RO
1032          * file, it's probably due to a server holding an out-of-date
1033          * replica, rather than to concurrent RPC's.  Failures to
1034          * release replicas are now flagged by the volserver, but only
1035          * since AFS 3.4 5.22, so there are plenty of clients getting
1036          * out-of-date replicas out there.
1037          *
1038          * If we discover an out-of-date replica, by this time it's too
1039          * late to go to another server and retry.  Also, we can't
1040          * reject the merge, because then there is no way for
1041          * GetAccess to do its work, and the caller gets into an
1042          * infinite loop.  So we just grin and bear it.
1043          */
1044         if (!(scp->flags & CM_SCACHEFLAG_RO))
1045             return;
1046     }       
1047     scp->serverModTime = statusp->ServerModTime;
1048
1049     if (!(scp->mask & CM_SCACHEMASK_CLIENTMODTIME)) {
1050         scp->clientModTime = statusp->ClientModTime;
1051     }
1052     if (!(scp->mask & CM_SCACHEMASK_LENGTH)) {
1053         scp->length.LowPart = statusp->Length;
1054         scp->length.HighPart = 0;
1055     }
1056
1057     scp->serverLength.LowPart = statusp->Length;
1058     scp->serverLength.HighPart = 0;
1059
1060     scp->linkCount = statusp->LinkCount;
1061     scp->dataVersion = statusp->DataVersion;
1062     scp->owner = statusp->Owner;
1063     scp->group = statusp->Group;
1064     scp->unixModeBits = statusp->UnixModeBits & 07777;
1065
1066     if (statusp->FileType == File)
1067         scp->fileType = CM_SCACHETYPE_FILE;
1068     else if (statusp->FileType == Directory)
1069         scp->fileType = CM_SCACHETYPE_DIRECTORY;
1070     else if (statusp->FileType == SymbolicLink) {
1071         if ((scp->unixModeBits & 0111) == 0)
1072             scp->fileType = CM_SCACHETYPE_MOUNTPOINT;
1073         else
1074             scp->fileType = CM_SCACHETYPE_SYMLINK;
1075     }       
1076     else {
1077         osi_Log1(afsd_logp, "Merge, Invalid File Type, scp %x", scp);
1078         scp->fileType = 0;      /* invalid */
1079     }
1080     /* and other stuff */
1081     scp->parentVnode = statusp->ParentVnode;
1082     scp->parentUnique = statusp->ParentUnique;
1083         
1084     /* and merge in the private acl cache info, if this is more than the public
1085      * info; merge in the public stuff in any case.
1086      */
1087     scp->anyAccess = statusp->AnonymousAccess;
1088
1089     if (userp != NULL) {
1090         cm_AddACLCache(scp, userp, statusp->CallerAccess);
1091     }
1092 }
1093
1094 /* note that our stat cache info is incorrect, so force us eventually
1095  * to stat the file again.  There may be dirty data associated with
1096  * this vnode, and we want to preserve that information.
1097  *
1098  * This function works by simply simulating a loss of the callback.
1099  *
1100  * This function must be called with the scache locked.
1101  */
1102 void cm_DiscardSCache(cm_scache_t *scp)
1103 {
1104     lock_AssertMutex(&scp->mx);
1105     if (scp->cbServerp) {
1106         cm_PutServer(scp->cbServerp);
1107         scp->cbServerp = NULL;
1108     }
1109     scp->cbExpires = 0;
1110     cm_dnlcPurgedp(scp);
1111     cm_dnlcPurgevp(scp);
1112     cm_FreeAllACLEnts(scp);
1113 }
1114
1115 void cm_AFSFidFromFid(AFSFid *afsFidp, cm_fid_t *fidp)
1116 {
1117     afsFidp->Volume = fidp->volume;
1118     afsFidp->Vnode = fidp->vnode;
1119     afsFidp->Unique = fidp->unique;
1120 }       
1121
1122 void cm_HoldSCacheNoLock(cm_scache_t *scp)
1123 {
1124     osi_assert(scp != 0);
1125     osi_assert(scp->refCount >= 0);
1126     scp->refCount++;
1127 }
1128
1129 void cm_HoldSCache(cm_scache_t *scp)
1130 {
1131     osi_assert(scp != 0);
1132     lock_ObtainWrite(&cm_scacheLock);
1133     osi_assert(scp->refCount >= 0);
1134     scp->refCount++;
1135     lock_ReleaseWrite(&cm_scacheLock);
1136 }
1137
1138 void cm_ReleaseSCacheNoLock(cm_scache_t *scp)
1139 {
1140     osi_assert(scp != 0);
1141     osi_assert(scp->refCount-- >= 0);
1142 }
1143
1144 void cm_ReleaseSCache(cm_scache_t *scp)
1145 {
1146     osi_assert(scp != 0);
1147     lock_ObtainWrite(&cm_scacheLock);
1148     osi_assert(scp->refCount != 0);
1149     scp->refCount--;
1150     lock_ReleaseWrite(&cm_scacheLock);
1151 }
1152
1153 /* just look for the scp entry to get filetype */
1154 /* doesn't need to be perfectly accurate, so locking doesn't matter too much */
1155 int cm_FindFileType(cm_fid_t *fidp)
1156 {
1157     long hash;
1158     cm_scache_t *scp;
1159         
1160     hash = CM_SCACHE_HASH(fidp);
1161         
1162     osi_assert(fidp->cell != 0);
1163
1164     lock_ObtainWrite(&cm_scacheLock);
1165     for (scp=cm_data.hashTablep[hash]; scp; scp=scp->nextp) {
1166         if (cm_FidCmp(fidp, &scp->fid) == 0) {
1167             lock_ReleaseWrite(&cm_scacheLock);
1168             return scp->fileType;
1169         }
1170     }
1171     lock_ReleaseWrite(&cm_scacheLock);
1172     return 0;
1173 }
1174
1175 /* dump all scp's that have reference count > 0 to a file. 
1176  * cookie is used to identify this batch for easy parsing, 
1177  * and it a string provided by a caller 
1178  */
1179 int cm_DumpSCache(FILE *outputFile, char *cookie, int lock)
1180 {
1181     int zilch;
1182     cm_scache_t *scp;
1183     char output[1024];
1184     int i;
1185   
1186     if (lock)
1187         lock_ObtainRead(&cm_scacheLock);
1188   
1189     sprintf(output, "%s - dumping scache - cm_data.currentSCaches=%d, cm_data.maxSCaches=%d\n", cookie, cm_data.currentSCaches, cm_data.maxSCaches);
1190     WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1191   
1192     for (scp = cm_data.scacheLRULastp; scp; scp = (cm_scache_t *) osi_QPrev(&scp->q)) 
1193     {
1194         if (scp->refCount != 0)
1195         {
1196             sprintf(output, "%s fid (cell=%d, volume=%d, vnode=%d, unique=%d) refCount=%u\n", 
1197                     cookie, scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique, 
1198                     scp->refCount);
1199             WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1200         }
1201     }
1202   
1203     sprintf(output, "%s - dumping cm_data.hashTable - cm_data.hashTableSize=%d\n", cookie, cm_data.hashTableSize);
1204     WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1205   
1206     for (i = 0; i < cm_data.hashTableSize; i++)
1207     {
1208         for(scp = cm_data.hashTablep[i]; scp; scp=scp->nextp) 
1209         {
1210             if (scp->refCount != 0)
1211             {
1212                 sprintf(output, "%s scp=0x%08X, hash=%d, fid (cell=%d, volume=%d, vnode=%d, unique=%d) refCount=%u\n", 
1213                          cookie, (void *)scp, i, scp->fid.cell, scp->fid.volume, scp->fid.vnode, 
1214                          scp->fid.unique, scp->refCount);
1215                 WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1216             }
1217         }
1218     }
1219
1220     sprintf(output, "%s - Done dumping scache.\n", cookie);
1221     WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1222   
1223     if (lock)
1224         lock_ReleaseRead(&cm_scacheLock);       
1225     return (0);     
1226 }
1227