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